2 /************************************************************************
3 * Mailer v0.2.1-FINAL Start: 08/31/2008 *
4 * =================== Last change: 08/31/2008 *
6 * -------------------------------------------------------------------- *
7 * File : surfbar_functions.php *
8 * -------------------------------------------------------------------- *
9 * Short description : Functions for surfbar *
10 * -------------------------------------------------------------------- *
11 * Kurzbeschreibung : Funktionen fuer die Surfbar *
12 * -------------------------------------------------------------------- *
15 * $Tag:: 0.2.1-FINAL $ *
17 * Needs to be in all Files and every File needs "svn propset *
18 * svn:keywords Date Revision" (autoprobset!) at least!!!!!! *
19 * -------------------------------------------------------------------- *
20 * Copyright (c) 2003 - 2009 by Roland Haeder *
21 * Copyright (c) 2009, 2010 by Mailer Developer Team *
22 * For more information visit: http://www.mxchange.org *
24 * This program is free software; you can redistribute it and/or modify *
25 * it under the terms of the GNU General Public License as published by *
26 * the Free Software Foundation; either version 2 of the License, or *
27 * (at your option) any later version. *
29 * This program is distributed in the hope that it will be useful, *
30 * but WITHOUT ANY WARRANTY; without even the implied warranty of *
31 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the *
32 * GNU General Public License for more details. *
34 * You should have received a copy of the GNU General Public License *
35 * along with this program; if not, write to the Free Software *
36 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, *
38 ************************************************************************/
40 // Some security stuff...
41 if (!defined('__SECURITY')) {
45 // -----------------------------------------------------------------------------
47 // -----------------------------------------------------------------------------
49 // Admin has added an URL with given user id and so on
50 function SURFBAR_ADMIN_ADD_URL ($url, $limit, $reload) {
54 logDebugMessage(__FUNCTION__, __LINE__, sprintf("Cannot add URL=%s,limit=%s,reload=%s : Not admin.", $url, $limit, $reload));
56 } elseif (!isUrlValid($url)) {
58 logDebugMessage(__FUNCTION__, __LINE__, sprintf("Cannot add URL=%s,limit=%s,reload=%s : Invalid URL.", $url, $limit, $reload));
60 } elseif (SURFBAR_LOOKUP_BY_URL($url, 0)) {
61 // URL already found in surfbar!
62 logDebugMessage(__FUNCTION__, __LINE__, sprintf("Cannot add URL=%s,limit=%s,reload=%s : Already added.", $url, $limit, $reload));
64 } elseif (!SURFBAR_IF_USER_BOOK_MORE_URLS()) {
66 logDebugMessage(__FUNCTION__, __LINE__, sprintf("Cannot add URL=%s,limit=%s,reload=%s : No more URLs allowed.", $url, $limit, $reload));
68 } elseif ('' . ($limit + 0) . '' != '' . $limit . '') {
69 // Invalid limit entered
70 logDebugMessage(__FUNCTION__, __LINE__, sprintf("Cannot add URL=%s,limit=%s,reload=%s : Invalid limit entered.", $url, $limit, $reload));
72 } elseif ('' . ($reload + 0) . '' != '' . $reload . '') {
73 // Invalid amount entered
74 logDebugMessage(__FUNCTION__, __LINE__, sprintf("Cannot add URL=%s,limit=%s,reload=%s : Invalid reload entered.", $url, $limit, $reload));
78 // Register the new URL
79 return SURFBAR_REGISTER_URL($url, 0, 'ACTIVE', 'unlock', array('limit' => $limit, 'reload' => $reload));
82 // Admin unlocked an email so we can migrate the URL
83 function SURFBAR_ADMIN_MIGRATE_URL ($url, $userid) {
88 } elseif (!isUrlValid($url)) {
91 } elseif (SURFBAR_LOOKUP_BY_URL($url, $userid)) {
92 // URL already found in surfbar!
94 } elseif (!SURFBAR_IF_USER_BOOK_MORE_URLS($userid)) {
99 // Register the new URL
100 return SURFBAR_REGISTER_URL($url, $userid, 'MIGRATED', 'migrate');
103 // Admin function for unlocking URLs
104 function SURFBAR_ADMIN_UNLOCK_URL_IDS ($IDs) {
105 // Is this an admin or invalid array?
107 // Not admin or invalid ids array
109 } elseif (!is_array($IDs)) {
112 } elseif (count($IDs) == 0) {
117 // Set to true to make AND expression valid if first URL got unlocked
120 // Update the status for all ids
121 foreach ($IDs as $id => $dummy) {
122 // Test all ids through (ignores failed)
123 $done = (($done) && (SURFBAR_CHANGE_STATUS($id, 'PENDING', 'ACTIVE')));
126 // Return total status
130 // Admin function for rejecting URLs
131 function SURFBAR_ADMIN_REJECT_URL_IDS ($IDs) {
132 // Is this an admin or invalid array?
134 // Not admin or invalid ids array
136 } elseif (!is_array($IDs)) {
139 } elseif (count($IDs) == 0) {
144 // Set to true to make AND expression valid if first URL got unlocked
147 // Update the status for all ids
148 foreach ($IDs as $id => $dummy) {
149 // Test all ids through (ignores failed)
150 $done = (($done) && (SURFBAR_CHANGE_STATUS($id, 'PENDING', 'REJECTED')));
153 // Return total status
158 // -----------------------------------------------------------------------------
160 // -----------------------------------------------------------------------------
162 // Member has added an URL
163 function SURFBAR_MEMBER_ADD_URL ($url, $limit) {
164 // Do some pre-checks
168 } elseif ((!isUrlValid($url)) && (!isAdmin())) {
171 } elseif (SURFBAR_LOOKUP_BY_URL($url, getMemberId())) {
172 // URL already found in surfbar!
174 } elseif (!SURFBAR_IF_USER_BOOK_MORE_URLS(getMemberId())) {
177 } elseif (''.($limit + 0).'' != ''.$limit.'') {
178 // Invalid amount entered
182 // Register the new URL
183 return SURFBAR_REGISTER_URL($url, getMemberId(), 'PENDING', 'reg', array('limit' => $limit));
186 // Create list of actions depending on status for the user
187 function SURFBAR_MEMBER_ACTIONS ($urlId, $status) {
188 // Load all actions in an array for given status
189 $actionArray = SURFBAR_GET_ARRAY_FROM_STATUS($status);
192 $OUT = "<table border=\"0\" cellspacing=\"0\" cellpadding=\"1\" width=\"100%\">
196 $width = round(100 / count($actionArray));
198 // "Walk" through all actions and create forms
199 foreach ($actionArray as $actionId => $action) {
200 // Add form for this action
201 $OUT .= loadTemplate('member_surfbar_list_form', true, array(
203 'id' => bigintval($urlId),
204 'action' => strtolower($action),
205 'title' => '{--MEMBER_SURFBAR_ACTION_' . strtoupper($action) . '_TITLE--}',
206 'submit' => '{--MEMBER_SURFBAR_ACTION_' . strtoupper($action) . '_SUBMIT--}',
218 // Do the member form request
219 function SURFBAR_MEMBER_DO_FORM ($formData, $URLs) {
220 // By default no action is performed
227 } elseif ((!isset($formData['id'])) || (!isset($formData['action']))) {
228 // Important form elements are missing!
230 } elseif (!isset($URLs[$formData['id']])) {
231 // id not found in cache
233 } elseif (!SURFBAR_VALIDATE_MEMBER_ACTION_STATUS($formData['action'], $URLs[$formData['id']]['url_status'])) {
234 // Action not allowed for current URL status
239 $action = secureString($formData['action']);
242 if ($action != $formData['action']) {
243 // Invalid data in action found
247 // Create the function name for selected action
248 $functionName = sprintf("SURFBAR_MEMBER_%s_ACTION", strtoupper($action));
250 // Is the function there?
251 if (function_exists($functionName)) {
253 $URLs[$formData['id']]['new_status'] = SURFBAR_GET_NEW_STATUS('new_status');
255 // Extract URL data for call-back
256 $urlData = array(merge_array($URLs[$formData['id']], array($action => $formData)));
258 // Action found so execute it
259 $performed = call_user_func_array($functionName, $urlData);
261 // Log invalid request
262 logDebugMessage(__FUNCTION__, __LINE__, "action={$formData['action']},id={$formData['id']},function={$functionName}");
263 addFatalMessage(__FUNCTION__, __LINE__, "Invalid member action! action=%s,id=%s,function=%s", array($formData['action'], $formData['id'], $functionName));
270 // Validate if the requested action can be performed on current URL status
271 function SURFBAR_VALIDATE_MEMBER_ACTION_STATUS ($action, $status) {
272 // Search for the requested action/status combination in database
273 $result = SQL_QUERY_ESC("SELECT new_status FROM `{?_MYSQL_PREFIX?}_surfbar_actions` WHERE `action`='%s' AND `status`='%s' LIMIT 1",
274 array($action, $status), __FUNCTION__, __LINE__);
276 // Is the entry there?
277 $isValid = (SQL_NUMROWS($result) == 1);
279 // Fetch the new status if found
282 list($GLOBALS['surfbar_cache']['new_status']) = SQL_FETCHROW($result);
286 SQL_FREERESULT($result);
293 // -----------------------------------------------------------------------------
295 // -----------------------------------------------------------------------------
297 // Retreat a booked URL
298 function SURFBAR_MEMBER_RETREAT_ACTION ($urlData) {
299 // Create the data array for next function call
301 $urlData['id'] => $urlData
304 // Simply change the status here
305 return SURFBAR_CHANGE_STATUS ($urlData['id'], $urlData['url_status'], $urlData['new_status'], $data);
308 // Book an URL now (from migration)
309 function SURFBAR_MEMBER_BOOKNOW_ACTION ($urlData) {
310 // Create the data array for next function call
312 $urlData['id'] => $urlData
315 // Simply change the status here
316 return SURFBAR_CHANGE_STATUS ($urlData['id'], $urlData['url_status'], $urlData['new_status'], $data);
319 // Show edit form or do the changes
320 function SURFBAR_MEMBER_EDIT_ACTION ($urlData) {
321 // Is the "execute" flag there?
322 if (isset($urlData['edit']['execute'])) {
323 // Execute the changes
324 return SURFBAR_MEMBER_EXECUTE_ACTION('edit', $urlData);
328 return SURFBAR_MEMBER_DISPLAY_ACTION_FORM('edit', $urlData);
331 // Show delete form or do the changes
332 function SURFBAR_MEMBER_DELETE_ACTION ($urlData) {
333 // Is the "execute" flag there?
334 if (isset($urlData['delete']['execute'])) {
335 // Execute the changes
336 return SURFBAR_MEMBER_EXECUTE_ACTION('delete', $urlData);
340 return SURFBAR_MEMBER_DISPLAY_ACTION_FORM('delete', $urlData);
343 // Pause active banner
344 function SURFBAR_MEMBER_PAUSE_ACTION ($urlData) {
345 return SURFBAR_CHANGE_STATUS($urlData['id'], $urlData['url_status'], $urlData['new_status'], array($urlData['id'] => $urlData));
348 // Unpause stopped banner
349 function SURFBAR_MEMBER_UNPAUSE_ACTION ($urlData) {
350 // Fix missing entry for template
351 $urlData['edit'] = $urlData['unpause'];
352 $urlData['edit']['url'] = $urlData['url'];
353 $urlData['edit']['limit'] = SURFBAR_GET_VIEWS_MAX();
355 // Return status change
356 return SURFBAR_CHANGE_STATUS($urlData['id'], $urlData['url_status'], $urlData['new_status'], array($urlData['id'] => $urlData));
359 // Resubmit locked URL
360 function SURFBAR_MEMBER_RESUBMIT_ACTION ($urlData) {
361 return SURFBAR_CHANGE_STATUS($urlData['id'], $urlData['url_status'], $urlData['new_status'], array($urlData['id'] => $urlData));
364 // Display selected "action form"
365 function SURFBAR_MEMBER_DISPLAY_ACTION_FORM ($action, $urlData) {
366 // Translate some data if present
367 $content = SURFBAR_PREPARE_CONTENT_FOR_TEMPLATE($content);
369 // Is the lock reason empty?
370 if (empty($urlData['lock_reason'])) {
371 // Fix it to three dashes
372 $urlData['lock_reason'] = '---';
375 // Include fields only for action 'edit'
376 if ($action == 'edit') {
377 // Default is not limited
378 $urlData['limited_y'] = '';
379 $urlData['limited_n'] = ' checked="checked"';
380 $urlData['limited'] = 'false';
382 // Is this URL limited?
383 if (SURFBAR_GET_VIEWS_MAX() > 0) {
384 // Then rewrite form data
385 $urlData['limited_y'] = ' checked="checked"';
386 $urlData['limited_n'] = '';
387 $urlData['limited'] = 'true';
391 // Load the form and display it
392 loadTemplate(sprintf("member_surfbar_%s_action_form", $action), false, $urlData);
394 // All fine by default ... ;-)
398 // Execute choosen action
399 function SURFBAR_MEMBER_EXECUTE_ACTION ($action, $urlData) {
400 // By default nothing is executed
403 // Is limitation "no" and "limit" is > 0?
404 if ((isset($urlData[$action]['limited'])) && ($urlData[$action]['limited'] != 'Y') && ((isset($urlData[$action]['limit'])) && ($urlData[$action]['limit'] > 0)) || (!isset($urlData[$action]['limit']))) {
405 // Set it to unlimited
406 $urlData[$action]['limit'] = '0';
409 // Construct function name
410 $functionName = sprintf("SURFBAR_MEMBER_EXECUTE_%s_ACTION", strtoupper($action));
412 // Is that function there?
413 if (function_exists($functionName)) {
414 // Execute the function
415 if (call_user_func_array($functionName, array($urlData)) == true) {
416 // Update status as well
417 $executed = SURFBAR_CHANGE_STATUS($urlData['id'], $urlData['url_status'], $urlData['new_status'], array($urlData['id'] => $urlData));
421 addFatalMessage(__FUNCTION__, __LINE__, getMessage('MEMBER_SURFBAR_EXECUTE_ACTION_404'), $functionName);
427 // "Execute edit" function: Update changed data
428 function SURFBAR_MEMBER_EXECUTE_EDIT_ACTION ($urlData) {
429 // Default is nothing done
432 // Has the URL or limit changed?
434 //if (($urlData['url_views_allowed'] != $urlData['edit']['limit']) || ($url1 != $url2)) {
436 SQL_QUERY_ESC("UPDATE `{?_MYSQL_PREFIX?}_surfbar_urls` SET `url`='%s', `url_views_allowed`=%s, `url_views_max`=%s WHERE `url_id`=%s AND `status`='%s' LIMIT 1",
437 array($urlData['url'], $urlData['edit']['limit'], $urlData['edit']['limit'], $urlData['id'], $urlData['url_status']), __FUNCTION__, __LINE__);
446 // "Execute delete" function: Does nothing...
447 function SURFBAR_MEMBER_EXECUTE_DELETE_ACTION ($urlData) {
448 // Nothing special to do (see above function for such "special actions" to perform)
452 // -----------------------------------------------------------------------------
453 // Self-maintenance functions
454 // -----------------------------------------------------------------------------
457 function SURFBAR_HANDLE_SELF_MAINTENANCE () {
458 // Handle URLs which limit has depleted so we can stop them
459 SURFBAR_HANDLE_DEPLETED_VIEWS();
461 // Handle low-points amounts
462 SURFBAR_HANDLE_LOW_POINTS();
464 // Handle URLs which limit has depleted
465 function SURFBAR_HANDLE_DEPLETED_VIEWS () {
467 $urlArray = SURFBAR_GET_URL_DATA(0, 'url_views_max', 'url_id', 'ASC', 'url_id', " AND `url_views_allowed` > 0 AND `url_status`='ACTIVE'");
469 // Do we have some entries?
470 if (count($urlArray) > 0) {
472 foreach ($urlArray as $id => $urlData) {
476 // Rewrite array for next call
477 $urlData[$id] = $data;
480 SURFBAR_CHANGE_STATUS($id, 'ACTIVE', 'DEPLETED', $urlData);
485 // Alert users which have URLs booked and are low on points amount
486 function SURFBAR_HANDLE_LOW_POINTS () {
488 $userids = SURFBAR_DETERMINE_DEPLETED_USERIDS(getConfig('surfbar_warn_low_points'));
490 // "Walk" through all URLs
491 foreach ($userids['userid'] as $userid => $dummy) {
492 // Is the last notification far enougth away to notify again?
493 if ((time() - $userids['notified'][$userid]) >= getConfig('surfbar_low_interval')) {
497 'low' => translateComma(getConfig('surfbar_warn_low_points')),
498 'points' => translateComma($userids['points'][$userid]),
499 'notified' => generateDateTime($userids['notified'][$userid]),
500 'interval' => createFancyTime(getConfig('surfbar_low_interval'))
504 SURFBAR_NOTIFY_USER('low_points', $content);
506 // Update last notified
507 SQL_QUERY_ESC("UPDATE `{?_MYSQL_PREFIX?}_user_data` SET `surfbar_low_notified`=NOW() WHERE `userid`=%s LIMIT 1",
508 array($userid), __FUNCTION__, __LINE__);
514 // -----------------------------------------------------------------------------
516 // -----------------------------------------------------------------------------
519 // Looks up by an URL
520 function SURFBAR_LOOKUP_BY_URL ($url, $userid) {
521 // Now lookup that given URL by itself
522 $urlArray = SURFBAR_GET_URL_DATA($url, 'url', 'url_id', 'ASC', 'url_id', sprintf(" AND `url_userid`=%s", bigintval($userid)));
525 return (count($urlArray) > 0);
528 // Load URL data by given search term and column
529 function SURFBAR_GET_URL_DATA ($searchTerm, $column = 'url_id', $order = 'url_id', $sort = 'ASC', $group = 'url_id', $add = '') {
530 // By default nothing is found
531 $GLOBALS['last_url_data'] = array();
533 // Is the column an id number?
534 if (($column == 'url_id') || ($column == 'url_userid')) {
535 // Extra secure input
536 $searchTerm = bigintval($searchTerm);
539 // If the column is 'id' there can be only one entry
541 if ($column == 'id') {
545 // Look up the record
546 $result = SQL_QUERY_ESC("SELECT
554 UNIX_TIMESTAMP(`url_registered`) AS `url_registered`,
555 UNIX_TIMESTAMP(`url_last_locked`) AS `url_last_locked`,
561 `{?_MYSQL_PREFIX?}_surfbar_urls`
573 ), __FUNCTION__, __LINE__);
575 // Is there at least one record?
576 if (SQL_NUMROWS($result) > 0) {
578 while ($dataRow = SQL_FETCHARRAY($result)) {
579 // Shall we group these results?
580 if ($group == 'url_id') {
581 // Add the row by id as index
582 $GLOBALS['last_url_data'][$dataRow['url_id']] = $dataRow;
585 $GLOBALS['last_url_data'][$dataRow[$group]][$dataRow['url_id']] = $dataRow;
591 SQL_FREERESULT($result);
594 return $GLOBALS['last_url_data'];
597 // Registers an URL with the surfbar. You should have called SURFBAR_LOOKUP_BY_URL() first!
598 function SURFBAR_REGISTER_URL ($url, $userid, $status = 'PENDING', $addMode = 'reg', $extraFields = array()) {
599 // Make sure by the user registered URLs are always pending
600 if ($addMode == 'reg') {
605 $content = merge_array($extraFields, array(
607 'frametester' => generateFrametesterUrl($url),
608 'url_userid' => $userid,
609 'url_status' => $status,
612 // Is limit/reload set?
613 if (!isset($config['limit'])) {
614 $content['limit'] = '0';
616 if (!isset($config['reload'])) {
617 $content['reload'] = '0';
620 // Insert the URL into database
621 $content['insert_id'] = SURFBAR_INSERT_URL_BY_ARRAY($content);
624 if ($content['insert_id'] == '0') {
625 // INSERT did not insert any data!
629 // Translate status and limit
630 $content['limit'] = translateSurfbarLimit($content['limit']);
632 // If in reg-mode we notify admin
633 if (($addMode == 'reg') || (getConfig('surfbar_notify_admin_unlock') == 'Y')) {
634 // Notify admin even when he as unlocked an email
635 SURFBAR_NOTIFY_ADMIN('url_' . $addMode, $content);
639 SURFBAR_NOTIFY_USER('url_' . $addMode, $content);
641 // Return the insert id
642 return $content['insert_id'];
645 // Inserts an url by given data array and return the insert id
646 function SURFBAR_INSERT_URL_BY_ARRAY ($urlData) {
648 $userid = bigintval($urlData['url_userid']);
651 if (empty($userid)) $userid = '0';
653 // Just run the insert query for now
654 SQL_QUERY_ESC("INSERT INTO `{?_MYSQL_PREFIX?}_surfbar_urls` (`url_userid`,`url`,`url_status`,`url_views_max`,`url_views_allowed`,`url_fixed_reload`) VALUES (%s,'%s','%s',%s,%s,%s)",
658 $urlData['url_status'],
662 ), __FUNCTION__, __LINE__
666 return SQL_INSERTID();
669 // Notify admin(s) with a selected message and content
670 function SURFBAR_NOTIFY_ADMIN ($messageType, $content) {
671 // Prepare template name
672 $templateName = sprintf("admin_surfbar_%s", $messageType);
675 $subject = getMessage(sprintf("ADMIN_SURFBAR_NOTIFY_%s_SUBJECT",
676 strtoupper($messageType)
679 // Is the subject line there?
680 if ((substr($subject, 0, 1) == '!') && (substr($subject, -1, 1) == '!')) {
681 // Set default subject if following eval() wents wrong
682 $subject = getMaskedMessage('ADMIN_SURFBAR_NOTIFY_DEFAULT_SUBJECT', strtoupper($messageType));
685 // Translate some data if present
686 $content = SURFBAR_PREPARE_CONTENT_FOR_TEMPLATE($content);
688 // Send the notification out
689 return sendAdminNotification($subject, $templateName, $content, $content['userid']);
692 // Notify the user about the performed action
693 function SURFBAR_NOTIFY_USER ($messageType, $content) {
694 // Skip notification if userid is zero
695 if ($content['userid'] == '0') {
699 // Prepare template name
700 $templateName = sprintf("member_surfbar_%s", $messageType);
703 $subject = getMessage(sprintf("MEMBER_SURFBAR_NOTIFY_%s_SUBJECT",
704 strtoupper($messageType)
707 // Is the subject line there?
708 if ((substr($subject, 0, 1) == '!') && (substr($subject, -1, 1) == '!')) {
709 // Set default subject if following eval() wents wrong
710 $subject = getMessage('MEMBER_SURFBAR_NOTIFY_DEFAULT_SUBJECT');
713 // Translate some data if present
714 $content = SURFBAR_PREPARE_CONTENT_FOR_TEMPLATE($content);
717 $mailText = loadEmailTemplate($templateName, $content, $content['userid']);
720 return sendEmail($content['userid'], $subject, $mailText);
723 // Translates some data for template usage
724 // @TODO Can't we use our new expression language instead of this ugly code?
725 function SURFBAR_PREPARE_CONTENT_FOR_TEMPLATE ($content) {
727 if (isset($content['url_status'])) $content['url_status'] = translateSurfbarUrlStatus($content['url_status']);
728 if (isset($content['url_registered'])) $content['url_registered'] = generateDateTime($content['url_registered'], 2);
729 if (isset($content['url_last_locked'])) $content['url_last_locked'] = generateDateTime($content['url_last_locked'], 2);
730 if (isset($content['url_views_total'])) $content['url_views_total'] = translateComma($content['url_views_total']);
731 if (isset($content['url_views_allowed'])) $content['url_views_allowed'] = translateComma($content['url_views_allowed']);
732 if (isset($content['views_max'])) $content['views_max'] = translateComma($content['views_max']);
734 // Return translated content
738 // Translates the limit
739 function translateSurfbarLimit ($limit) {
743 $return = getMessage('MEMBER_SURFBAR_UNLIMITED_VIEWS');
746 $return = translateComma($limit);
753 // Translate the URL status
754 function translateSurfbarUrlStatus ($status) {
755 // Create constant name
756 $constantName = sprintf("SURFBAR_URL_STATUS_%s", strtoupper($status));
759 $statusTranslated = getMessage($constantName);
762 return $statusTranslated;
766 function SURFBAR_DETERMINE_REWARD ($onlyMin=false) {
767 // Static values are default
768 $reward = getConfig('surfbar_static_reward');
770 // Do we have static or dynamic?
771 if (getConfig('surfbar_pay_model') == 'DYNAMIC') {
772 // "Calculate" dynamic reward
774 $reward += SURFBAR_CALCULATE_DYNAMIC_MIN_VALUE();
776 $reward += SURFBAR_CALCULATE_DYNAMIC_ADD();
785 function SURFBAR_DETERMINE_COSTS ($onlyMin=false) {
786 // Static costs is default
787 $costs = getConfig('surfbar_static_costs');
789 // Do we have static or dynamic?
790 if (getConfig('surfbar_pay_model') == 'DYNAMIC') {
791 // "Calculate" dynamic costs
793 $costs += SURFBAR_CALCULATE_DYNAMIC_MIN_VALUE();
795 $costs += SURFBAR_CALCULATE_DYNAMIC_ADD();
803 // "Calculate" dynamic add
804 function SURFBAR_CALCULATE_DYNAMIC_ADD () {
805 // Get min/max values
806 $min = SURFBAR_CALCULATE_DYNAMIC_MIN_VALUE();
807 $max = SURFBAR_CALCULATE_DYNAMIC_MAX_VALUE();
809 // "Calculate" dynamic part and return it
810 return mt_rand($min, $max);
813 // Determine right template name
814 function SURFBAR_DETERMINE_TEMPLATE_NAME() {
815 // Default is the frameset
816 $templateName = "surfbar_frameset";
818 // Any frame set? ;-)
819 if (isGetRequestParameterSet('frame')) {
820 // Use the frame as a template name part... ;-)
821 $templateName = sprintf("surfbar_frame_%s",
822 getRequestParameter('frame')
827 return $templateName;
830 // Check if the "reload lock" of the current user is full, call this function
831 // before you call SURFBAR_CHECK_RELOAD_LOCK().
832 function SURFBAR_CHECK_RELOAD_FULL() {
836 // Cache static reload lock
837 $GLOBALS['surfbar_cache']['surf_lock'] = getConfig('surfbar_static_lock');
838 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'Fixed surf lock is '.getConfig('surfbar_static_lock') . '', false);
840 // Do we have dynamic model?
841 if (getConfig('surfbar_pay_model') == 'DYNAMIC') {
842 // "Calculate" dynamic lock
843 $GLOBALS['surfbar_cache']['surf_lock'] += SURFBAR_CALCULATE_DYNAMIC_ADD();
847 $result = SQL_QUERY_ESC("SELECT
848 COUNT(l.locks_id) AS cnt
850 `{?_MYSQL_PREFIX?}_surfbar_locks` AS l
852 `{?_MYSQL_PREFIX?}_surfbar_urls` AS u
854 u.url_id=l.locks_url_id
856 l.locks_userid=%s AND
857 (UNIX_TIMESTAMP() - ".SURFBAR_GET_SURF_LOCK().") < UNIX_TIMESTAMP(l.locks_last_surfed) AND
859 ((UNIX_TIMESTAMP(l.locks_last_surfed) - u.url_fixed_reload) < 0 AND u.url_fixed_reload > 0) OR
860 u.url_fixed_reload = '0'
863 array(getMemberId()), __FUNCTION__, __LINE__
867 list($GLOBALS['surfbar_cache']['user_locks']) = SQL_FETCHROW($result);
870 if (is_null($GLOBALS['surfbar_cache']['user_locks'])) {
871 // Then fix it to zero!
872 $GLOBALS['surfbar_cache']['user_locks'] = '0';
876 SQL_FREERESULT($result);
879 $total = SURFBAR_GET_TOTAL_URLS();
881 // Do we have some URLs in lock? Admins can always surf on own URLs!
882 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, "userLocks=".SURFBAR_GET_USER_LOCKS().",total={$total}", false);
883 $isFull = ((SURFBAR_GET_USER_LOCKS() == $total) && ($total > 0));
889 // Get total amount of URLs of given status for current user or of ACTIVE URLs by default
890 function SURFBAR_GET_TOTAL_URLS ($status = 'ACTIVE', $excludeUserId = '0') {
891 // Determine depleted user account
892 $userids = SURFBAR_DETERMINE_DEPLETED_USERIDS();
894 // If we dont get any user ids back, there are no URLs
895 if (count($userids['userid']) == 0) {
896 // No user ids found, no URLs!
900 // Is the exlude userid set?
901 if ($excludeUserId > 0) {
903 $userids['userid'][$excludeUserId] = $excludeUserId;
906 // Get amount from database
907 $result = SQL_QUERY_ESC("SELECT
908 COUNT(`url_id`) AS cnt
910 `{?_MYSQL_PREFIX?}_surfbar_urls`
912 `url_userid` NOT IN (".implode(', ', $userids['userid']).") AND
915 array($status), __FUNCTION__, __LINE__
919 list($cnt) = SQL_FETCHROW($result);
922 SQL_FREERESULT($result);
928 // Check wether the user is allowed to book more URLs
929 function SURFBAR_IF_USER_BOOK_MORE_URLS ($userid = '0') {
930 // Is this admin and userid is zero or does the user has some URLs left to book?
931 return ((($userid == '0') && (isAdmin())) || (SURFBAR_GET_TOTAL_USER_URLS($userid, '', array('REJECTED')) < getConfig('surfbar_max_order')));
934 // Get total amount of URLs of given status for current user
935 function SURFBAR_GET_TOTAL_USER_URLS ($userid = '0', $status = '', $exclude = '') {
936 // Is the user 0 and user is logged in?
937 if (($userid == '0') && (isMember())) {
938 // Then use this userid
939 $userid = getMemberId();
940 } elseif ($userid == '0') {
942 return (getConfig('surfbar_max_order') + 1);
945 // Default is all URLs
948 // Is the status set?
949 if (is_array($status)) {
950 // Only URLs with these status
951 $add = sprintf(" AND `url_status` IN('%s')", implode("','", $status));
952 } elseif (!empty($status)) {
953 // Only URLs with this status
954 $add = sprintf(" AND `url_status`='%s'", $status);
955 } elseif (is_array($exclude)) {
956 // Exclude URLs with these status
957 $add = sprintf(" AND `url_status` NOT IN('%s')", implode("','", $exclude));
958 } elseif (!empty($exclude)) {
959 // Exclude URLs with this status
960 $add = sprintf(" AND `url_status` != '%s'", $exclude);
963 // Get amount from database
964 $cnt = countSumTotalData($userid, 'surfbar_urls', 'url_id', 'url_userid', true, $add);
970 // Generate a validation code for the given id number
971 function SURFBAR_GENERATE_VALIDATION_CODE ($urlId, $salt = '') {
972 // @TODO Invalid salt should be refused
973 $GLOBALS['surfbar_cache']['salt'] = 'INVALID';
975 // Get code length from config
976 $length = getConfig('code_length');
979 if ($length == '0') $length = 10;
981 // Generate a code until the length matches
983 while (strlen($valCode) != $length) {
986 // Generate random hashed string
987 $GLOBALS['surfbar_cache']['salt'] = sha1(generatePassword(mt_rand(200, 255)));
988 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'newSalt='.SURFBAR_GET_SALT().'', false);
991 $GLOBALS['surfbar_cache']['salt'] = $salt;
992 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'oldSalt='.SURFBAR_GET_SALT().'', false);
995 // ... and now the validation code
996 $valCode = generateRandomCode($length, sha1(SURFBAR_GET_SALT().':'.$urlId), getMemberId());
997 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'valCode='.valCode.'', false);
1000 // Hash it with md5() and salt it with the random string
1001 $hashedCode = generateHash(md5($valCode), SURFBAR_GET_SALT());
1003 // Finally encrypt it PGP-like and return it
1004 $valHashedCode = encodeHashForCookie($hashedCode);
1006 // Return hashed value
1007 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'finalValCode='.$valHashedCode.'', false);
1008 return $valHashedCode;
1011 // Check validation code
1012 function SURFBAR_CHECK_VALIDATION_CODE ($urlId, $check, $salt) {
1014 $urlId = bigintval($urlId);
1016 // Now generate the code again
1017 $code = SURFBAR_GENERATE_VALIDATION_CODE($urlId, $salt);
1019 // Return result of checking hashes and salts
1020 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, '---'.$code.'|'.$check.'---', false);
1021 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, '+++'.$salt.'|'.SURFBAR_GET_DATA('salts_last_salt').'+++', false);
1022 return (($code == $check) && ($salt == SURFBAR_GET_DATA('salts_last_salt')));
1025 // Lockdown the userid/id combination (reload lock)
1026 function SURFBAR_LOCKDOWN_ID ($urlId) {
1027 //* DEBUG: */ outputHtml('LOCK!');
1028 ///* DEBUG: */ return;
1029 // Just add it to the database
1030 SQL_QUERY_ESC("INSERT INTO `{?_MYSQL_PREFIX?}_surfbar_locks` (`locks_userid`, `locks_url_id`) VALUES (%s, %s)",
1031 array(getMemberId(), bigintval($urlId)), __FUNCTION__, __LINE__);
1033 // Remove the salt from database
1034 SQL_QUERY_ESC("DELETE LOW_PRIORITY FROM `{?_MYSQL_PREFIX?}_surfbar_salts` WHERE `salts_url_id`=%s AND `salts_userid`=%s LIMIT 1",
1035 array(bigintval($urlId), getMemberId()), __FUNCTION__, __LINE__);
1038 // Pay points to the user and remove it from the sender if userid is given else it is a "sponsored surf"
1039 function SURFBAR_PAY_POINTS () {
1040 // Remove it from the URL owner
1041 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'userid='.SURFBAR_GET_USERID().',costs='.SURFBAR_GET_COSTS().'', false);
1042 if (SURFBAR_GET_USERID() > 0) {
1043 subtractPoints(sprintf("surfbar_%s", getConfig('surfbar_pay_model')), SURFBAR_GET_USERID(), SURFBAR_GET_COSTS());
1046 // Book it to the user
1047 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'userid='.getMemberId().',reward='.SURFBAR_GET_REWARD().'', false);
1048 addPointsThroughReferalSystem(sprintf("surfbar_%s", getConfig('surfbar_pay_model')), getMemberId(), SURFBAR_GET_DATA('reward'));
1051 // Updates the statistics of current URL/userid
1052 function SURFBAR_UPDATE_INSERT_STATS_RECORD () {
1056 // Get allowed views
1057 $allowed = SURFBAR_GET_VIEWS_ALLOWED();
1059 // Do we have a limit?
1061 // Then count views_max down!
1062 $add .= ", `views_max`=`views_max`-1";
1066 SQL_QUERY_ESC("UPDATE `{?_MYSQL_PREFIX?}_surfbar_urls` SET `url_views_total`=`url_views_total`+1".$add." WHERE `url_id`=%s LIMIT 1",
1067 array(SURFBAR_GET_ID()), __FUNCTION__, __LINE__);
1069 // Update the stats entry
1070 SQL_QUERY_ESC("UPDATE `{?_MYSQL_PREFIX?}_surfbar_stats` SET `stats_count`=`stats_count`+1 WHERE `stats_userid`=%s AND `stats_url_id`=%s LIMIT 1",
1074 ), __FUNCTION__, __LINE__);
1076 // Was that update okay?
1077 if (SQL_AFFECTEDROWS() < 1) {
1078 // No, then insert entry
1079 SQL_QUERY_ESC("INSERT INTO `{?_MYSQL_PREFIX?}_surfbar_stats` (`stats_userid`, `stats_url_id`, `stats_count`) VALUES (%s,%s,1)",
1083 ), __FUNCTION__, __LINE__);
1086 // Update total/daily/weekly/monthly counter
1087 incrementConfigEntry('surfbar_total_counter');
1088 incrementConfigEntry('surfbar_daily_counter');
1089 incrementConfigEntry('surfbar_weekly_counter');
1090 incrementConfigEntry('surfbar_monthly_counter');
1092 // Update config as well
1093 updateConfiguration(array('surfbar_total_counter', 'surfbar_daily_counter', 'surfbar_weekly_counter', 'surfbar_monthly_counter'), array(1,1,1,1), '+');
1096 // Update the salt for validation and statistics
1097 function SURFBAR_UPDATE_SALT_STATS () {
1098 // Update statistics record
1099 SURFBAR_UPDATE_INSERT_STATS_RECORD();
1101 // Simply store the salt from cache away in database...
1102 SQL_QUERY_ESC("UPDATE `{?_MYSQL_PREFIX?}_surfbar_salts` SET `salts_last_salt`='%s' WHERE `salts_url_id`=%s AND `salts_userid`=%s LIMIT 1",
1107 ), __FUNCTION__, __LINE__);
1110 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'salt='.SURFBAR_GET_SALT().',id='.SURFBAR_GET_ID().',userid='.getMemberId().'', false);
1113 if (SQL_AFFECTEDROWS() < 1) {
1114 // Insert missing entry!
1115 SQL_QUERY_ESC("INSERT INTO `{?_MYSQL_PREFIX?}_surfbar_salts` (`salts_url_id`, `salts_userid`, `salts_last_salt`) VALUES (%s, %s, '%s')",
1116 array(SURFBAR_GET_ID(), getMemberId(), SURFBAR_GET_SALT()), __FUNCTION__, __LINE__);
1120 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'affectedRows='.SQL_AFFECTEDROWS().'', false);
1122 // Return if the update was okay
1123 return (SQL_AFFECTEDROWS() == 1);
1126 // Check if the reload lock is active for given id
1127 function SURFBAR_CHECK_RELOAD_LOCK ($urlId) {
1128 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'id=' . $urlId . '', false);
1130 $result = SQL_QUERY_ESC("SELECT COUNT(`locks_id`) AS cnt
1132 `{?_MYSQL_PREFIX?}_surfbar_locks`
1134 `locks_userid`=%s AND
1135 `locks_url_id`=%s AND
1136 (UNIX_TIMESTAMP() - ".SURFBAR_GET_SURF_LOCK().") < UNIX_TIMESTAMP(`locks_last_surfed`)
1138 `locks_last_surfed` ASC
1140 array(getMemberId(), bigintval($urlId)), __FUNCTION__, __LINE__
1144 list($cnt) = SQL_FETCHROW($result);
1147 SQL_FREERESULT($result);
1150 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'cnt=' . $cnt . ',' . SURFBAR_GET_SURF_LOCK() . '', false);
1154 // Determine which user hash no more points left
1155 function SURFBAR_DETERMINE_DEPLETED_USERIDS ($limit=0) {
1158 'userid' => array(),
1159 'points' => array(),
1160 'notified' => array(),
1163 // Do we have a current user id?
1164 if ((isMember()) && ($limit == '0')) {
1165 // Then add this as well
1166 $userids['userid'][getMemberId()] = getMemberId();
1167 $userids['points'][getMemberId()] = countSumTotalData(getMemberId(), 'user_points', 'points') - countSumTotalData(getMemberId(), 'user_data', 'used_points');
1168 $userids['notified'][getMemberId()] = '0';
1170 // Get all userid except logged in one
1171 $result = SQL_QUERY_ESC("SELECT
1172 u.url_userid, UNIX_TIMESTAMP(d.surfbar_low_notified) AS notified
1174 `{?_MYSQL_PREFIX?}_surfbar_urls` AS u
1176 `{?_MYSQL_PREFIX?}_user_data` AS d
1178 u.url_userid=d.userid
1180 u.url_userid NOT IN (%s,0) AND u.url_status='ACTIVE'
1185 array(getMemberId()), __FUNCTION__, __LINE__);
1188 $result = SQL_QUERY("SELECT
1189 u.url_userid, UNIX_TIMESTAMP(d.surfbar_low_notified) AS notified
1191 `{?_MYSQL_PREFIX?}_surfbar_urls` AS u
1193 `{?_MYSQL_PREFIX?}_user_data` AS d
1195 u.url_userid=d.userid
1197 u.url_status='ACTIVE'
1201 u.url_userid ASC", __FUNCTION__, __LINE__);
1205 while ($content = SQL_FETCHARRAY($result)) {
1207 $points = countSumTotalData($content['userid'], 'user_points', 'points') - countSumTotalData($content['userid'], 'user_data', 'used_points');
1208 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, "userid={$content['userid']},points={$points}", false);
1210 // Shall we add this to ignore?
1211 if ($points <= $limit) {
1213 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, "userid={$content['userid']} has depleted points amount!", false);
1214 $userids['userid'][$content['userid']] = $content['userid'];
1215 $userids['points'][$content['userid']] = $points;
1216 $userids['notified'][$content['userid']] = $content['notified'];
1221 SQL_FREERESULT($result);
1224 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, "UIDs::count=".count($userids)." (with own userid=".getMemberId().')', false);
1230 // Determine how many users are Online in surfbar
1231 function SURFBAR_DETERMINE_TOTAL_ONLINE () {
1232 // Count all users in surfbar modue and return the value
1233 $result = SQL_QUERY("SELECT
1236 `{?_MYSQL_PREFIX?}_surfbar_stats`
1238 (UNIX_TIMESTAMP() - UNIX_TIMESTAMP(`stats_last_surfed`)) <= {?online_timeout?}
1240 `stats_userid` ASC", __FUNCTION__, __LINE__);
1243 $cnt = SQL_NUMROWS($result);
1246 SQL_FREERESULT($result);
1252 // Determine waiting time for one URL
1253 function SURFBAR_DETERMINE_WAIT_TIME () {
1254 // Get fixed reload lock
1255 $fixed = SURFBAR_GET_FIXED_RELOAD();
1257 // Is the fixed reload time set?
1263 // Static time is default
1264 $time = getConfig('surfbar_static_time');
1266 // Which payment model do we have?
1267 if (getConfig('surfbar_pay_model') == 'DYNAMIC') {
1268 // "Calculate" dynamic time
1269 $time += SURFBAR_CALCULATE_DYNAMIC_ADD();
1276 // Changes the status of an URL from given to other
1277 function SURFBAR_CHANGE_STATUS ($urlId, $prevStatus, $newStatus, $data=array()) {
1278 // Make new status always lower-case
1279 $newStatus = strtolower($newStatus);
1281 // Get URL data for status comparison if missing
1282 if ((!is_array($data)) || (count($data) == 0)) {
1283 // Fetch missing URL data
1284 $data = SURFBAR_GET_URL_DATA($urlId);
1287 // Is the new status set?
1288 if ((!is_string($newStatus)) || (empty($newStatus))) {
1289 // Abort here, but fine!
1293 // Is the status like prevStatus is saying?
1294 if ($data[$urlId]['url_status'] != $prevStatus) {
1295 // No, then abort here
1300 // Update the status now
1301 // ---------- Comment out for debugging/developing member actions! ---------
1302 //SQL_QUERY_ESC("UPDATE `{?_MYSQL_PREFIX?}_surfbar_urls` SET `status`='%s' WHERE `id`=%s LIMIT 1",
1303 // array($newStatus, bigintval($urlId)), __FUNCTION__, __LINE__);
1304 // ---------- Comment out for debugging/developing member actions! ---------
1307 // ---------- Comment out for debugging/developing member actions! ---------
1308 //if (SQL_AFFECTEDROWS() != 1) {
1309 // // No, something went wrong
1312 // ---------- Comment out for debugging/developing member actions! ---------
1314 // Prepare content for notification routines
1315 $data[$urlId]['userid'] = $data[$urlId]['userid'];
1316 $data[$urlId]['frametester'] = generateFrametesterUrl($data[$urlId]['url']);
1317 $data[$urlId]['reward'] = translateComma(getConfig('surfbar_static_reward'));
1318 $data[$urlId]['costs'] = translateComma(getConfig('surfbar_static_costs'));
1320 // Do some dirty fixing here:
1321 if (($data[$urlId]['url_status'] == 'STOPPED') && ($newStatus == 'pending')) {
1322 // Fix for template change
1323 $newStatus = 'continued';
1326 // Send admin notification
1327 SURFBAR_NOTIFY_ADMIN('url_' . $data[$urlId]['url_status'] . '_' . $newStatus, $data[$urlId]);
1329 // Send user notification
1330 SURFBAR_NOTIFY_USER('url_' . $data[$urlId]['url_status'] . '_' . $newStatus, $data[$urlId]);
1336 // Calculate minimum value for dynamic payment model
1337 function SURFBAR_CALCULATE_DYNAMIC_MIN_VALUE () {
1338 // Addon is zero by default
1342 $percent = abs(log(getConfig('surfbar_dynamic_percent') / 100 + 1));
1345 $totalUsers = countSumTotalData('CONFIRMED', 'user_data', 'userid', 'status', true);
1348 $onlineUsers = SURFBAR_DETERMINE_TOTAL_ONLINE();
1351 $addon += abs(log($onlineUsers / $totalUsers + 1) * $percent * $totalUsers);
1354 $totalUrls = SURFBAR_GET_TOTAL_URLS('ACTIVE', 0);
1356 // Get user's total URLs
1357 $userUrls = SURFBAR_GET_TOTAL_USER_URLS(0, 'ACTIVE');
1360 if ($totalUrls > 0) {
1361 $addon += abs(log($userUrls / $totalUrls + 1) * $percent * $totalUrls);
1363 $addon += abs(log($userUrls / 1 + 1) * $percent * $totalUrls);
1370 // Calculate maximum value for dynamic payment model
1371 function SURFBAR_CALCULATE_DYNAMIC_MAX_VALUE () {
1372 // Addon is zero by default
1379 $percent = abs(log(getConfig('surfbar_dynamic_percent') / 100 + 1));
1382 $totalUsers = countSumTotalData('CONFIRMED', 'user_data', 'userid', 'status', true);
1385 $addon += abs($max * $percent * $totalUsers);
1388 $totalUrls = SURFBAR_GET_TOTAL_URLS('ACTIVE', 0);
1391 $addon += abs($max * $percent * $totalUrls);
1397 // Calculate dynamic lock
1398 function SURFBAR_CALCULATE_DYNAMIC_LOCK () {
1399 // Default lock is 30 seconds
1403 $onlineUsers = SURFBAR_DETERMINE_TOTAL_ONLINE();
1406 $addon = abs(log($onlineUsers / $addon + 1));
1412 // "Getter" for lock ids array
1413 function SURFBAR_GET_LOCK_IDS () {
1414 // Prepare some arrays
1419 // Get all id from locks within the timestamp
1420 $result = SQL_QUERY_ESC("SELECT `locks_id`, `locks_url_id`, UNIX_TIMESTAMP(`locks_last_surfed`) AS last_surfed
1422 `{?_MYSQL_PREFIX?}_surfbar_locks`
1426 `locks_id` ASC", array(getMemberId()),
1427 __FUNCTION__, __LINE__);
1430 while ($content = SQL_FETCHARRAY($result)) {
1432 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'next - lid='.$content['id'].',url='.$content['url_id'].',rest='.(time() - $content['last_surfed']).'/'.SURFBAR_GET_SURF_LOCK().'', false);
1434 // Skip entries that are too old
1435 if (($content['last_surfed'] > (time() - SURFBAR_GET_SURF_LOCK())) && (!in_array($content['url_id'], $ignored))) {
1437 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'okay - lid='.$content['id'].',url='.$content['url_id'].',last='.$content['last_surfed'].'', false);
1439 // Add only if missing or bigger
1440 if ((!isset($IDs[$content['url_id']])) || ($IDs[$content['url_id']] > $content['last_surfed'])) {
1442 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'ADD - lid='.$content['id'].',url='.$content['url_id'].',last='.$content['last_surfed'].'', false);
1445 $IDs[$content['url_id']] = $content['last_surfed'];
1446 $USE[$content['url_id']] = $content['id'];
1450 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'ignore - lid='.$content['id'].',url='.$content['url_id'].',last='.$content['last_surfed'].'', false);
1452 // Ignore these old entries!
1453 $ignored[] = $content['url_id'];
1454 unset($IDs[$content['url_id']]);
1455 unset($USE[$content['url_id']]);
1460 SQL_FREERESULT($result);
1466 // "Getter" for maximum random number
1467 function SURFBAR_GET_MAX_RANDOM ($userids, $add) {
1468 // Count max availabe entries
1469 $result = SQL_QUERY("SELECT
1472 `{?_MYSQL_PREFIX?}_surfbar_urls` AS sbu
1474 `{?_MYSQL_PREFIX?}_surfbar_salts` AS sbs
1476 sbu.url_id=sbs.salts_url_id
1478 `{?_MYSQL_PREFIX?}_surfbar_locks` AS l
1480 sbu.url_id=l.locks_url_id
1482 sbu.url_userid NOT IN (".implode(',', $userids).") AND
1483 (sbu.url_views_allowed=0 OR (sbu.url_views_allowed > 0 AND sbu.url_views_max > 0)) AND
1484 sbu.url_status='ACTIVE'
1487 sbu.url_id ASC", __FUNCTION__, __LINE__);
1490 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'lastQuery='.getConfig('db_last_query').'|numRows='.SQL_NUMROWS($result).'|Affected='.SQL_AFFECTEDROWS().'', false);
1493 $maxRand = SQL_NUMROWS($result);
1496 SQL_FREERESULT($result);
1502 // Load all URLs of the current user and return it as an array
1503 function SURFBAR_GET_USER_URLS () {
1508 $result = SQL_QUERY_ESC("SELECT
1515 u.url_views_allowed,
1516 UNIX_TIMESTAMP(u.url_registered) AS `url_registered`,
1517 UNIX_TIMESTAMP(u.url_last_locked) AS `url_last_locked`,
1520 `{?_MYSQL_PREFIX?}_surfbar_urls` AS u
1523 u.url_status != 'DELETED'
1526 array(getMemberId()), __FUNCTION__, __LINE__);
1528 // Are there entries?
1529 if (SQL_NUMROWS($result) > 0) {
1531 while ($row = SQL_FETCHARRAY($result)) {
1533 $URLs[$row['id']] = $row;
1538 SQL_FREERESULT($result);
1544 // "Getter" for member action array for given status
1545 function SURFBAR_GET_ARRAY_FROM_STATUS ($status) {
1547 $returnArray = array();
1549 // Get all assigned actions
1550 $result = SQL_QUERY_ESC("SELECT `action` FROM `{?_MYSQL_PREFIX?}_surfbar_actions` WHERE `actions_status`='%s' ORDER BY `actions_id` ASC",
1551 array($status), __FUNCTION__, __LINE__);
1553 // Some entries there?
1554 if (SQL_NUMROWS($result) > 0) {
1556 // @TODO This can be somehow rewritten
1557 while ($content = SQL_FETCHARRAY($result)) {
1558 $returnArray[] = $content['action'];
1563 SQL_FREERESULT($result);
1566 return $returnArray;
1569 // Reload to configured stop page
1570 function SURFBAR_RELOAD_TO_STOP_PAGE ($page = 'stop') {
1571 // Internal or external?
1572 if ((getConfig('surfbar_pause_mode') == 'INTERNAL') || (getConfig('surfbar_pause_url') == '')) {
1573 // Reload to internal page
1574 redirectToUrl('surfbar.php?frame=' . $page);
1576 // Reload to external page
1577 redirectToConfiguredUrl('surfbar_pause_url');
1581 // Determine next id for surfbar or get data for given id, always call this before you call other
1582 // getters below this function!!!
1583 function SURFBAR_DETERMINE_NEXT_ID ($urlId = '0') {
1584 // Default is no id and no random number
1589 if ($urlId == '0') {
1590 // Get array with lock ids
1591 $USE = SURFBAR_GET_LOCK_IDS();
1593 // Shall we add some URL ids to ignore?
1595 if (count($USE) > 0) {
1597 $add = " AND sbu.url_id NOT IN (";
1598 foreach ($USE as $url_id => $lid) {
1600 $add .= $url_id.',';
1603 // Add closing bracket
1604 $add = substr($add, 0, -1) . ')';
1607 // Determine depleted user account
1608 $userids = SURFBAR_DETERMINE_DEPLETED_USERIDS();
1610 // Get maximum randomness factor
1611 $maxRand = SURFBAR_GET_MAX_RANDOM($userids['userid'], $add);
1613 // If more than one URL can be called generate the random number!
1615 // Generate random number
1616 $randNum = mt_rand(0, ($maxRand - 1));
1619 // And query the database
1620 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'randNum='.$randNum.',maxRand='.$maxRand.',surfLock='.SURFBAR_GET_SURF_LOCK().'', false);
1621 $result = SQL_QUERY_ESC("SELECT
1625 sbs.salts_last_salt,
1626 sbu.url_views_total,
1628 sbu.url_views_allowed,
1629 UNIX_TIMESTAMP(l.locks_last_surfed) AS last_surfed,
1630 sbu.url_fixed_reload
1632 `{?_MYSQL_PREFIX?}_surfbar_urls` AS sbu
1634 `{?_MYSQL_PREFIX?}_surfbar_salts` AS sbs
1636 sbu.url_id=sbs.salts_url_id
1638 `{?_MYSQL_PREFIX?}_surfbar_locks` AS l
1640 sbu.url_id=l.locks_url_id
1642 sbu.url_userid NOT IN (".implode(',', $userids['userid']).") AND
1643 sbu.url_status='ACTIVE' AND
1644 (sbu.url_views_allowed=0 OR (sbu.url_views_allowed > 0 AND sbu.url_views_max > 0))
1649 l.locks_last_surfed ASC,
1652 array($randNum), __FUNCTION__, __LINE__
1655 // Get data from specified id number
1656 $result = SQL_QUERY_ESC("SELECT
1660 sbs.salts_last_salt,
1661 sbu.url_views_total,
1663 sbu.url_views_allowed,
1664 UNIX_TIMESTAMP(l.locks_last_surfed) AS last_surfed,
1665 sbu.url_fixed_reload
1667 `{?_MYSQL_PREFIX?}_surfbar_urls` AS sbu
1669 `{?_MYSQL_PREFIX?}_surfbar_salts` AS sbs
1671 sbu.url_id=sbs.salts_url_id
1673 `{?_MYSQL_PREFIX?}_surfbar_locks` AS l
1675 sbu.url_id=l.locks_url_id
1677 sbu.url_userid != %s AND
1678 sbu.url_status='ACTIVE' AND
1680 (sbu.url_views_allowed=0 OR (sbu.url_views_allowed > 0 AND sbu.url_views_max > 0))
1682 array(getMemberId(), bigintval($urlId)), __FUNCTION__, __LINE__
1686 // Is there an id number?
1687 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'lastQuery='.getConfig('db_last_query').'|numRows='.SQL_NUMROWS($result).'|Affected='.SQL_AFFECTEDROWS().'', false);
1688 if (SQL_NUMROWS($result) == 1) {
1690 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'count('.count($GLOBALS['surfbar_cache']).') - BEFORE', false);
1691 $GLOBALS['surfbar_cache'] = merge_array($GLOBALS['surfbar_cache'], SQL_FETCHARRAY($result));
1692 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'count('.count($GLOBALS['surfbar_cache']).') - AFTER', false);
1694 // Determine waiting time
1695 $GLOBALS['surfbar_cache']['time'] = SURFBAR_DETERMINE_WAIT_TIME();
1697 // Is the last salt there?
1698 if (is_null($GLOBALS['surfbar_cache']['salts_last_salt'])) {
1699 // Then repair it wit the static!
1700 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'last_salt - FIXED!', false);
1701 $GLOBALS['surfbar_cache']['salts_last_salt'] = '';
1704 // Fix missing last_surfed
1705 if ((!isset($GLOBALS['surfbar_cache']['last_surfed'])) || (is_null($GLOBALS['surfbar_cache']['last_surfed']))) {
1707 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'last_surfed - FIXED!', false);
1708 $GLOBALS['surfbar_cache']['last_surfed'] = '0';
1711 // Get base/fixed reward and costs
1712 $GLOBALS['surfbar_cache']['reward'] = SURFBAR_DETERMINE_REWARD();
1713 $GLOBALS['surfbar_cache']['costs'] = SURFBAR_DETERMINE_COSTS();
1714 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'BASE/STATIC - reward='.SURFBAR_GET_REWARD().'|costs='.SURFBAR_GET_COSTS().'', false);
1716 // Only in dynamic model add the dynamic bonus!
1717 if (getConfig('surfbar_pay_model') == 'DYNAMIC') {
1718 // Calculate dynamic reward/costs and add it
1719 $GLOBALS['surfbar_cache']['reward'] += SURFBAR_CALCULATE_DYNAMIC_ADD();
1720 $GLOBALS['surfbar_cache']['costs'] += SURFBAR_CALCULATE_DYNAMIC_ADD();
1721 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'DYNAMIC+ - reward='.SURFBAR_GET_REWARD().'|costs='.SURFBAR_GET_COSTS().'', false);
1725 $nextId = SURFBAR_GET_ID();
1729 SQL_FREERESULT($result);
1732 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'nextId='.$nextId.'', false);
1736 // -----------------------------------------------------------------------------
1737 // PLEASE DO NOT ADD ANY OTHER FUNCTIONS BELOW THIS LINE IF THEY DON'T "WRAP"
1738 // THE $GLOBALS['surfbar_cache'] ARRAY!
1739 // -----------------------------------------------------------------------------
1741 // Initializes the surfbar
1742 function SURFBAR_INIT () {
1744 $GLOBALS['surfbar_cache'] = array();
1747 // Private getter for data elements
1748 function SURFBAR_GET_DATA ($element) {
1749 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, "element={$element}", false);
1754 // Is the entry there?
1755 if (isset($GLOBALS['surfbar_cache'][$element])) {
1757 $data = $GLOBALS['surfbar_cache'][$element];
1758 } else { // END - if
1760 print_r($GLOBALS['surfbar_cache']);
1766 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, "element[$element]={$data}", false);
1770 // Getter for reward from cache
1771 function SURFBAR_GET_REWARD () {
1772 // Get data element and return its contents
1773 return SURFBAR_GET_DATA('reward');
1776 // Getter for costs from cache
1777 function SURFBAR_GET_COSTS () {
1778 // Get data element and return its contents
1779 return SURFBAR_GET_DATA('costs');
1782 // Getter for URL from cache
1783 function SURFBAR_GET_URL () {
1784 // Get data element and return its contents
1785 return SURFBAR_GET_DATA('url');
1788 // Getter for salt from cache
1789 function SURFBAR_GET_SALT () {
1790 // Get data element and return its contents
1791 return SURFBAR_GET_DATA('salt');
1794 // Getter for id from cache
1795 function SURFBAR_GET_ID () {
1796 // Get data element and return its contents
1797 return SURFBAR_GET_DATA('url_id');
1800 // Getter for userid from cache
1801 function SURFBAR_GET_USERID () {
1802 // Get data element and return its contents
1803 return SURFBAR_GET_DATA('url_userid');
1806 // Getter for user reload locks
1807 function SURFBAR_GET_USER_LOCKS () {
1808 // Get data element and return its contents
1809 return SURFBAR_GET_DATA('user_locks');
1812 // Getter for reload time
1813 function SURFBAR_GET_RELOAD_TIME () {
1814 // Get data element and return its contents
1815 return SURFBAR_GET_DATA('time');
1818 // Getter for allowed views
1819 function SURFBAR_GET_VIEWS_ALLOWED () {
1820 // Get data element and return its contents
1821 return SURFBAR_GET_DATA('url_views_allowed');
1824 // Getter for maximum views
1825 function SURFBAR_GET_VIEWS_MAX () {
1826 // Get data element and return its contents
1827 return SURFBAR_GET_DATA('url_views_max');
1830 // Getter for fixed reload
1831 function SURFBAR_GET_FIXED_RELOAD () {
1832 // Get data element and return its contents
1833 return SURFBAR_GET_DATA('url_fixed_reload');
1836 // Getter for surf lock
1837 function SURFBAR_GET_SURF_LOCK () {
1838 // Get data element and return its contents
1839 return SURFBAR_GET_DATA('surf_lock');
1842 // Getter for new status
1843 function SURFBAR_GET_NEW_STATUS () {
1844 // Get data element and return its contents
1845 return SURFBAR_GET_DATA('new_status');