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']]['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['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['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['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'] = $urlData['views_max'];
355 // Return status change
356 return SURFBAR_CHANGE_STATUS($urlData['id'], $urlData['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['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
367 $urlData['url_registered'] = generateDateTime($urlData['url_registered'], 2);
368 $urlData['views_total'] = translateComma($urlData['views_total']);
369 $urlData['views_max'] = translateComma($urlData['views_max']);
370 $urlData['views_allowed'] = translateComma($urlData['views_allowed']);
371 $urlData['url_last_locked'] = generateDateTime($urlData['url_last_locked'], 2);
373 // Is the lock reason empty?
374 if (empty($urlData['lock_reason'])) {
375 // Fix it to three dashes
376 $urlData['lock_reason'] = '---';
379 // Include fields only for action 'edit'
380 if ($action == 'edit') {
381 // Default is not limited
382 $urlData['limited_y'] = '';
383 $urlData['limited_n'] = ' checked="checked"';
384 $urlData['limited'] = 'false';
386 // Is this URL limited?
387 if ($urlData['views_max'] > 0) {
388 // Then rewrite form data
389 $urlData['limited_y'] = ' checked="checked"';
390 $urlData['limited_n'] = '';
391 $urlData['limited'] = 'true';
395 // Load the form and display it
396 loadTemplate(sprintf("member_surfbar_%s_action_form", $action), false, $urlData);
398 // All fine by default ... ;-)
402 // Execute choosen action
403 function SURFBAR_MEMBER_EXECUTE_ACTION ($action, $urlData) {
404 // By default nothing is executed
407 // Is limitation "no" and "limit" is > 0?
408 if ((isset($urlData[$action]['limited'])) && ($urlData[$action]['limited'] != 'Y') && ((isset($urlData[$action]['limit'])) && ($urlData[$action]['limit'] > 0)) || (!isset($urlData[$action]['limit']))) {
409 // Set it to unlimited
410 $urlData[$action]['limit'] = '0';
413 // Construct function name
414 $functionName = sprintf("SURFBAR_MEMBER_EXECUTE_%s_ACTION", strtoupper($action));
416 // Is 'userid' set and not 'userid' ?
417 if ((!isset($urlData['userid'])) && (isset($urlData['userid']))) {
419 $urlData['userid'] = $urlData['userid'];
422 // Is that function there?
423 if (function_exists($functionName)) {
424 // Execute the function
425 if (call_user_func_array($functionName, array($urlData)) == true) {
426 // Update status as well
427 $executed = SURFBAR_CHANGE_STATUS($urlData['id'], $urlData['status'], $urlData['new_status'], array($urlData['id'] => $urlData));
431 addFatalMessage(__FUNCTION__, __LINE__, getMessage('MEMBER_SURFBAR_EXECUTE_ACTION_404'), $functionName);
437 // "Execute edit" function: Update changed data
438 function SURFBAR_MEMBER_EXECUTE_EDIT_ACTION ($urlData) {
439 // Default is nothing done
442 // Has the URL or limit changed?
444 //if (($urlData['views_allowed'] != $urlData['edit']['limit']) || ($url1 != $url2)) {
446 SQL_QUERY_ESC("UPDATE `{?_MYSQL_PREFIX?}_surfbar_urls` SET url='%s', views_allowed=%s, views_max=%s WHERE `id`=%s AND `status`='%s' LIMIT 1",
447 array($urlData['url'], $urlData['edit']['limit'], $urlData['edit']['limit'], $urlData['id'], $urlData['status']), __FUNCTION__, __LINE__);
456 // "Execute delete" function: Does nothing...
457 function SURFBAR_MEMBER_EXECUTE_DELETE_ACTION ($urlData) {
458 // Nothing special to do (see above function for such "special actions" to perform)
462 // -----------------------------------------------------------------------------
463 // Self-maintenance functions
464 // -----------------------------------------------------------------------------
467 function SURFBAR_HANDLE_SELF_MAINTENANCE () {
468 // Handle URLs which limit has depleted so we can stop them
469 SURFBAR_HANDLE_DEPLETED_VIEWS();
471 // Handle low-points amounts
472 SURFBAR_HANDLE_LOW_POINTS();
474 // Handle URLs which limit has depleted
475 function SURFBAR_HANDLE_DEPLETED_VIEWS () {
477 $urlArray = SURFBAR_GET_URL_DATA(0, 'views_max', 'id', 'ASC', 'id', " AND views_allowed>0 AND `status`='ACTIVE'");
479 // Do we have some entries?
480 if (count($urlArray) > 0) {
482 foreach ($urlArray as $id => $urlData) {
486 // Rewrite array for next call
487 $urlData[$id] = $data;
490 SURFBAR_CHANGE_STATUS($id, 'ACTIVE', 'DEPLETED', $urlData);
495 // Alert users which have URLs booked and are low on points amount
496 function SURFBAR_HANDLE_LOW_POINTS () {
498 $userids = SURFBAR_DETERMINE_DEPLETED_USERIDS(getConfig('surfbar_warn_low_points'));
500 // "Walk" through all URLs
501 foreach ($userids['userid'] as $userid => $dummy) {
502 // Is the last notification far enougth away to notify again?
503 if ((time() - $userids['notified'][$userid]) >= getConfig('surfbar_low_interval')) {
507 'low' => translateComma(getConfig('surfbar_warn_low_points')),
508 'points' => translateComma($userids['points'][$userid]),
509 'notified' => generateDateTime($userids['notified'][$userid]),
510 'interval' => createFancyTime(getConfig('surfbar_low_interval'))
514 SURFBAR_NOTIFY_USER('low_points', $content);
516 // Update last notified
517 SQL_QUERY_ESC("UPDATE `{?_MYSQL_PREFIX?}_user_data` SET surfbar_low_notified=NOW() WHERE `userid`=%s LIMIT 1",
518 array($userid), __FUNCTION__, __LINE__);
524 // -----------------------------------------------------------------------------
526 // -----------------------------------------------------------------------------
529 // Looks up by an URL
530 function SURFBAR_LOOKUP_BY_URL ($url, $userid) {
531 // Now lookup that given URL by itself
532 $urlArray = SURFBAR_GET_URL_DATA($url, 'url', 'id', 'ASC', 'id', sprintf(" AND `userid`=%s", bigintval($userid)));
535 return (count($urlArray) > 0);
538 // Load URL data by given search term and column
539 function SURFBAR_GET_URL_DATA ($searchTerm, $column = 'id', $order = 'id', $sort = 'ASC', $group = 'id', $add = '') {
540 // By default nothing is found
541 $GLOBALS['last_url_data'] = array();
543 // Is the column an id number?
544 if (($column == 'id') || ($column == 'userid')) {
545 // Extra secure input
546 $searchTerm = bigintval($searchTerm);
549 // If the column is 'id' there can be only one entry
551 if ($column == 'id') {
555 // Look up the record
556 $result = SQL_QUERY_ESC("SELECT
557 `id`, `userid`, `url`,
558 `views_total`, `views_max`, `views_allowed`, `status`,
559 UNIX_TIMESTAMP(`registered`) AS `url_registered`, UNIX_TIMESTAMP(`last_locked`) AS `url_last_locked`, `lock_reason`,
560 `views_max`, `views_allowed`, `fixed_reload`
562 `{?_MYSQL_PREFIX?}_surfbar_urls`
574 ), __FUNCTION__, __LINE__);
576 // Is there at least one record?
577 if (SQL_NUMROWS($result) > 0) {
579 while ($dataRow = SQL_FETCHARRAY($result)) {
580 // Shall we group these results?
581 if ($group == 'id') {
582 // Add the row by id as index
583 $GLOBALS['last_url_data'][$dataRow['id']] = $dataRow;
586 $GLOBALS['last_url_data'][$dataRow[$group]][$dataRow['id']] = $dataRow;
592 SQL_FREERESULT($result);
595 return $GLOBALS['last_url_data'];
598 // Registers an URL with the surfbar. You should have called SURFBAR_LOOKUP_BY_URL() first!
599 function SURFBAR_REGISTER_URL ($url, $userid, $status = 'PENDING', $addMode = 'reg', $extraFields = array()) {
600 // Make sure by the user registered URLs are always pending
601 if ($addMode == 'reg') {
606 $content = merge_array($extraFields, array(
608 'frametester' => generateFrametesterUrl($url),
613 // Is limit/reload set?
614 if (!isset($config['limit'])) {
615 $content['limit'] = '0';
617 if (!isset($config['reload'])) {
618 $content['reload'] = '0';
621 // Insert the URL into database
622 $content['insert_id'] = SURFBAR_INSERT_URL_BY_ARRAY($content);
625 if ($content['insert_id'] == '0') {
626 // INSERT did not insert any data!
630 // Translate status and limit
631 $content['limit'] = translateSurfbarLimit($content['limit']);
633 // If in reg-mode we notify admin
634 if (($addMode == 'reg') || (getConfig('surfbar_notify_admin_unlock') == 'Y')) {
635 // Notify admin even when he as unlocked an email
636 SURFBAR_NOTIFY_ADMIN("url_{$addMode}", $content);
640 SURFBAR_NOTIFY_USER("url_{$addMode}", $content);
642 // Return the insert id
643 return $content['insert_id'];
646 // Inserts an url by given data array and return the insert id
647 function SURFBAR_INSERT_URL_BY_ARRAY ($urlData) {
649 $userid = bigintval($urlData['userid']);
652 if (empty($userid)) $userid = '0';
654 // Just run the insert query for now
655 SQL_QUERY_ESC("INSERT INTO `{?_MYSQL_PREFIX?}_surfbar_urls` (userid,url,status,views_max,views_allowed,fixed_reload) VALUES (%s,'%s','%s',%s,%s,%s)",
663 ), __FUNCTION__, __LINE__
667 return SQL_INSERTID();
670 // Notify admin(s) with a selected message and content
671 function SURFBAR_NOTIFY_ADMIN ($messageType, $content) {
672 // Prepare template name
673 $templateName = sprintf("admin_surfbar_%s", $messageType);
676 $subject = getMessage(sprintf("ADMIN_SURFBAR_NOTIFY_%s_SUBJECT",
677 strtoupper($messageType)
680 // Is the subject line there?
681 if ((substr($subject, 0, 1) == '!') && (substr($subject, -1, 1) == '!')) {
682 // Set default subject if following eval() wents wrong
683 $subject = getMessage('ADMIN_SURFBAR_NOTIFY_DEFAULT_SUBJECT');
686 // Translate some data if present
687 if (isset($content['status'])) $content['status'] = translateSurfbarUrlStatus($content['status']);
688 if (isset($content['url_registered'])) $content['url_registered'] = generateDateTime($content['url_registered'], 2);
689 if (isset($content['url_last_locked'])) $content['url_last_locked'] = generateDateTime($content['url_last_locked'], 2);
690 if (isset($content['views_total'])) $content['views_total'] = translateComma($content['views_total']);
691 if (isset($content['views_allowed'])) $content['views_allowed'] = translateComma($content['views_allowed']);
692 if (isset($content['views_max'])) $content['views_max'] = translateComma($content['views_max']);
694 // Send the notification out
695 return sendAdminNotification($subject, $templateName, $content, $content['userid']);
698 // Notify the user about the performed action
699 function SURFBAR_NOTIFY_USER ($messageType, $content) {
700 // Skip notification if userid is zero
701 if ($content['userid'] == '0') {
705 // Prepare template name
706 $templateName = sprintf("member_surfbar_%s", $messageType);
709 $subject = getMessage(sprintf("MEMBER_SURFBAR_NOTIFY_%s_SUBJECT",
710 strtoupper($messageType)
713 // Is the subject line there?
714 if ((substr($subject, 0, 1) == '!') && (substr($subject, -1, 1) == '!')) {
715 // Set default subject if following eval() wents wrong
716 $subject = getMessage('MEMBER_SURFBAR_NOTIFY_DEFAULT_SUBJECT');
719 // Translate some data if present
720 if (isset($content['status'])) $content['status'] = translateSurfbarUrlStatus($content['status']);
721 if (isset($content['url_registered'])) $content['url_registered'] = generateDateTime($content['url_registered'], 2);
722 if (isset($content['url_last_locked'])) $content['url_last_locked'] = generateDateTime($content['url_last_locked'], 2);
723 if (isset($content['views_total'])) $content['views_total'] = translateComma($content['views_total']);
724 if (isset($content['views_allowed'])) $content['views_allowed'] = translateComma($content['views_allowed']);
725 if (isset($content['views_max'])) $content['views_max'] = translateComma($content['views_max']);
728 $mailText = loadEmailTemplate($templateName, $content, $content['userid']);
731 return sendEmail($content['userid'], $subject, $mailText);
734 // Translates the limit
735 function translateSurfbarLimit ($limit) {
739 $return = getMessage('MEMBER_SURFBAR_UNLIMITED_VIEWS');
742 $return = translateComma($limit);
749 // Translate the URL status
750 function translateSurfbarUrlStatus ($status) {
751 // Create constant name
752 $constantName = sprintf("SURFBAR_URL_STATUS_%s", strtoupper($status));
755 $statusTranslated = getMessage($constantName);
758 return $statusTranslated;
762 function SURFBAR_DETERMINE_REWARD ($onlyMin=false) {
763 // Static values are default
764 $reward = getConfig('surfbar_static_reward');
766 // Do we have static or dynamic?
767 if (getConfig('surfbar_pay_model') == 'DYNAMIC') {
768 // "Calculate" dynamic reward
770 $reward += SURFBAR_CALCULATE_DYNAMIC_MIN_VALUE();
772 $reward += SURFBAR_CALCULATE_DYNAMIC_ADD();
781 function SURFBAR_DETERMINE_COSTS ($onlyMin=false) {
782 // Static costs is default
783 $costs = getConfig('surfbar_static_costs');
785 // Do we have static or dynamic?
786 if (getConfig('surfbar_pay_model') == 'DYNAMIC') {
787 // "Calculate" dynamic costs
789 $costs += SURFBAR_CALCULATE_DYNAMIC_MIN_VALUE();
791 $costs += SURFBAR_CALCULATE_DYNAMIC_ADD();
799 // "Calculate" dynamic add
800 function SURFBAR_CALCULATE_DYNAMIC_ADD () {
801 // Get min/max values
802 $min = SURFBAR_CALCULATE_DYNAMIC_MIN_VALUE();
803 $max = SURFBAR_CALCULATE_DYNAMIC_MAX_VALUE();
805 // "Calculate" dynamic part and return it
806 return mt_rand($min, $max);
809 // Determine right template name
810 function SURFBAR_DETERMINE_TEMPLATE_NAME() {
811 // Default is the frameset
812 $templateName = "surfbar_frameset";
814 // Any frame set? ;-)
815 if (isGetRequestParameterSet('frame')) {
816 // Use the frame as a template name part... ;-)
817 $templateName = sprintf("surfbar_frame_%s",
818 getRequestParameter('frame')
823 return $templateName;
826 // Check if the "reload lock" of the current user is full, call this function
827 // before you call SURFBAR_CHECK_RELOAD_LOCK().
828 function SURFBAR_CHECK_RELOAD_FULL() {
832 // Cache static reload lock
833 $GLOBALS['surfbar_cache']['surf_lock'] = getConfig('surfbar_static_lock');
834 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'Fixed surf lock is '.getConfig('surfbar_static_lock') . '', false);
836 // Do we have dynamic model?
837 if (getConfig('surfbar_pay_model') == 'DYNAMIC') {
838 // "Calculate" dynamic lock
839 $GLOBALS['surfbar_cache']['surf_lock'] += SURFBAR_CALCULATE_DYNAMIC_ADD();
843 $result = SQL_QUERY_ESC("SELECT
846 `{?_MYSQL_PREFIX?}_surfbar_locks` AS l
848 `{?_MYSQL_PREFIX?}_surfbar_urls` AS u
853 (UNIX_TIMESTAMP() - ".SURFBAR_GET_SURF_LOCK().") < UNIX_TIMESTAMP(l.last_surfed) AND
855 ((UNIX_TIMESTAMP(l.last_surfed) - u.fixed_reload) < 0 AND u.fixed_reload > 0) OR
859 array(getMemberId()), __FUNCTION__, __LINE__
863 list($GLOBALS['surfbar_cache']['user_locks']) = SQL_FETCHROW($result);
866 if (is_null($GLOBALS['surfbar_cache']['user_locks'])) {
867 // Then fix it to zero!
868 $GLOBALS['surfbar_cache']['user_locks'] = '0';
872 SQL_FREERESULT($result);
875 $total = SURFBAR_GET_TOTAL_URLS();
877 // Do we have some URLs in lock? Admins can always surf on own URLs!
878 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, "userLocks=".SURFBAR_GET_USER_LOCKS().",total={$total}", false);
879 $isFull = ((SURFBAR_GET_USER_LOCKS() == $total) && ($total > 0));
885 // Get total amount of URLs of given status for current user or of ACTIVE URLs by default
886 function SURFBAR_GET_TOTAL_URLS ($status = 'ACTIVE', $excludeUserId = '0') {
887 // Determine depleted user account
888 $userids = SURFBAR_DETERMINE_DEPLETED_USERIDS();
890 // If we dont get any user ids back, there are no URLs
891 if (count($userids['userid']) == 0) {
892 // No user ids found, no URLs!
896 // Is the exlude userid set?
897 if ($excludeUserId > 0) {
899 $userids['userid'][$excludeUserId] = $excludeUserId;
902 // Get amount from database
903 $result = SQL_QUERY_ESC("SELECT COUNT(`id`) AS cnt
904 FROM `{?_MYSQL_PREFIX?}_surfbar_urls`
905 WHERE `userid` NOT IN (".implode(', ', $userids['userid']).") AND `status`='%s'",
906 array($status), __FUNCTION__, __LINE__
910 list($cnt) = SQL_FETCHROW($result);
913 SQL_FREERESULT($result);
919 // Check wether the user is allowed to book more URLs
920 function SURFBAR_IF_USER_BOOK_MORE_URLS ($userid = '0') {
921 // Is this admin and userid is zero or does the user has some URLs left to book?
922 return ((($userid == '0') && (isAdmin())) || (SURFBAR_GET_TOTAL_USER_URLS($userid, '', array('REJECTED')) < getConfig('surfbar_max_order')));
925 // Get total amount of URLs of given status for current user
926 function SURFBAR_GET_TOTAL_USER_URLS ($userid = '0', $status = '',$exclude = '') {
927 // Is the user 0 and user is logged in?
928 if (($userid == '0') && (isMember())) {
929 // Then use this userid
930 $userid = getMemberId();
931 } elseif ($userid == '0') {
933 return (getConfig('surfbar_max_order') + 1);
936 // Default is all URLs
939 // Is the status set?
940 if (is_array($status)) {
941 // Only URLs with these status
942 $add = sprintf(" AND `status` IN('%s')", implode("','", $status));
943 } elseif (!empty($status)) {
944 // Only URLs with this status
945 $add = sprintf(" AND `status`='%s'", $status);
946 } elseif (is_array($exclude)) {
947 // Exclude URLs with these status
948 $add = sprintf(" AND `status` NOT IN('%s')", implode("','", $exclude));
949 } elseif (!empty($exclude)) {
950 // Exclude URLs with this status
951 $add = sprintf(" AND `status` != '%s'", $exclude);
954 // Get amount from database
955 $cnt = countSumTotalData($userid, 'surfbar_urls', 'id', 'userid', true, $add);
961 // Generate a validation code for the given id number
962 function SURFBAR_GENERATE_VALIDATION_CODE ($urlId, $salt = '') {
963 // @TODO Invalid salt should be refused
964 $GLOBALS['surfbar_cache']['salt'] = 'INVALID';
966 // Get code length from config
967 $length = getConfig('code_length');
970 if ($length == '0') $length = 10;
972 // Generate a code until the length matches
974 while (strlen($valCode) != $length) {
977 // Generate random hashed string
978 $GLOBALS['surfbar_cache']['salt'] = sha1(generatePassword(mt_rand(200, 255)));
979 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'newSalt='.SURFBAR_GET_SALT().'', false);
982 $GLOBALS['surfbar_cache']['salt'] = $salt;
983 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'oldSalt='.SURFBAR_GET_SALT().'', false);
986 // ... and now the validation code
987 $valCode = generateRandomCode($length, sha1(SURFBAR_GET_SALT().':'.$urlId), getMemberId());
988 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'valCode='.valCode.'', false);
991 // Hash it with md5() and salt it with the random string
992 $hashedCode = generateHash(md5($valCode), SURFBAR_GET_SALT());
994 // Finally encrypt it PGP-like and return it
995 $valHashedCode = encodeHashForCookie($hashedCode);
997 // Return hashed value
998 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'finalValCode='.$valHashedCode.'', false);
999 return $valHashedCode;
1002 // Check validation code
1003 function SURFBAR_CHECK_VALIDATION_CODE ($urlId, $check, $salt) {
1005 $urlId = bigintval($urlId);
1007 // Now generate the code again
1008 $code = SURFBAR_GENERATE_VALIDATION_CODE($urlId, $salt);
1010 // Return result of checking hashes and salts
1011 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, '---'.$code.'|'.$check.'---', false);
1012 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, '+++'.$salt.'|'.SURFBAR_GET_DATA('last_salt').'+++', false);
1013 return (($code == $check) && ($salt == SURFBAR_GET_DATA('last_salt')));
1016 // Lockdown the userid/id combination (reload lock)
1017 function SURFBAR_LOCKDOWN_ID ($urlId) {
1018 //* DEBUG: */ outputHtml('LOCK!');
1019 ///* DEBUG: */ return;
1020 // Just add it to the database
1021 SQL_QUERY_ESC("INSERT INTO `{?_MYSQL_PREFIX?}_surfbar_locks` (`userid`, `url_id`) VALUES (%s, %s)",
1022 array(getMemberId(), bigintval($urlId)), __FUNCTION__, __LINE__);
1024 // Remove the salt from database
1025 SQL_QUERY_ESC("DELETE LOW_PRIORITY FROM `{?_MYSQL_PREFIX?}_surfbar_salts` WHERE `url_id`=%s AND `userid`=%s LIMIT 1",
1026 array(bigintval($urlId), getMemberId()), __FUNCTION__, __LINE__);
1029 // Pay points to the user and remove it from the sender if userid is given else it is a "sponsored surf"
1030 function SURFBAR_PAY_POINTS () {
1031 // Remove it from the URL owner
1032 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'userid='.SURFBAR_GET_USERID().',costs='.SURFBAR_GET_COSTS().'', false);
1033 if (SURFBAR_GET_USERID() > 0) {
1034 subtractPoints(sprintf("surfbar_%s", getConfig('surfbar_pay_model')), SURFBAR_GET_USERID(), SURFBAR_GET_COSTS());
1037 // Book it to the user
1038 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'userid='.getMemberId().',reward='.SURFBAR_GET_REWARD().'', false);
1039 addPointsThroughReferalSystem(sprintf("surfbar_%s", getConfig('surfbar_pay_model')), getMemberId(), SURFBAR_GET_DATA('reward'));
1042 // Updates the statistics of current URL/userid
1043 function SURFBAR_UPDATE_INSERT_STATS_RECORD () {
1047 // Get allowed views
1048 $allowed = SURFBAR_GET_VIEWS_ALLOWED();
1050 // Do we have a limit?
1052 // Then count views_max down!
1053 $add .= ", `views_max`=`views_max`-1";
1057 SQL_QUERY_ESC("UPDATE `{?_MYSQL_PREFIX?}_surfbar_urls` SET `views_total`=`views_total`+1".$add." WHERE `id`=%s LIMIT 1",
1058 array(SURFBAR_GET_ID()), __FUNCTION__, __LINE__);
1060 // Update the stats entry
1061 SQL_QUERY_ESC("UPDATE `{?_MYSQL_PREFIX?}_surfbar_stats` SET `count`=`count`+1 WHERE `userid`=%s AND `url_id`=%s LIMIT 1",
1062 array(getMemberId(), SURFBAR_GET_ID()), __FUNCTION__, __LINE__);
1064 // Was that update okay?
1065 if (SQL_AFFECTEDROWS() < 1) {
1066 // No, then insert entry
1067 SQL_QUERY_ESC("INSERT INTO `{?_MYSQL_PREFIX?}_surfbar_stats` (userid,url_id,count) VALUES (%s,%s,1)",
1068 array(getMemberId(), SURFBAR_GET_ID()), __FUNCTION__, __LINE__);
1071 // Update total/daily/weekly/monthly counter
1072 incrementConfigEntry('surfbar_total_counter');
1073 incrementConfigEntry('surfbar_daily_counter');
1074 incrementConfigEntry('surfbar_weekly_counter');
1075 incrementConfigEntry('surfbar_monthly_counter');
1077 // Update config as well
1078 updateConfiguration(array('surfbar_total_counter', 'surfbar_daily_counter', 'surfbar_weekly_counter', 'surfbar_monthly_counter'), array(1,1,1,1), '+');
1081 // Update the salt for validation and statistics
1082 function SURFBAR_UPDATE_SALT_STATS () {
1083 // Update statistics record
1084 SURFBAR_UPDATE_INSERT_STATS_RECORD();
1086 // Simply store the salt from cache away in database...
1087 SQL_QUERY_ESC("UPDATE `{?_MYSQL_PREFIX?}_surfbar_salts` SET `last_salt`='%s' WHERE `url_id`=%s AND `userid`=%s LIMIT 1",
1088 array(SURFBAR_GET_SALT(), SURFBAR_GET_ID(), getMemberId()), __FUNCTION__, __LINE__);
1091 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'salt='.SURFBAR_GET_SALT().',id='.SURFBAR_GET_ID().',userid='.getMemberId().'', false);
1094 if (SQL_AFFECTEDROWS() < 1) {
1095 // Insert missing entry!
1096 SQL_QUERY_ESC("INSERT INTO `{?_MYSQL_PREFIX?}_surfbar_salts` (`url_id`, `userid`, `last_salt`) VALUES (%s, %s, '%s')",
1097 array(SURFBAR_GET_ID(), getMemberId(), SURFBAR_GET_SALT()), __FUNCTION__, __LINE__);
1101 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'affectedRows='.SQL_AFFECTEDROWS().'', false);
1103 // Return if the update was okay
1104 return (SQL_AFFECTEDROWS() == 1);
1107 // Check if the reload lock is active for given id
1108 function SURFBAR_CHECK_RELOAD_LOCK ($urlId) {
1109 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'id=' . $urlId . '', false);
1111 $result = SQL_QUERY_ESC("SELECT COUNT(`id`) AS cnt
1113 `{?_MYSQL_PREFIX?}_surfbar_locks`
1115 `userid`=%s AND `url_id`=%s AND (UNIX_TIMESTAMP() - ".SURFBAR_GET_SURF_LOCK().") < UNIX_TIMESTAMP(`last_surfed`)
1119 array(getMemberId(), bigintval($urlId)), __FUNCTION__, __LINE__
1123 list($cnt) = SQL_FETCHROW($result);
1126 SQL_FREERESULT($result);
1129 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'cnt=' . $cnt . ',' . SURFBAR_GET_SURF_LOCK() . '', false);
1133 // Determine which user hash no more points left
1134 function SURFBAR_DETERMINE_DEPLETED_USERIDS ($limit=0) {
1137 'userid' => array(),
1138 'points' => array(),
1139 'notified' => array(),
1142 // Do we have a current user id?
1143 if ((isMember()) && ($limit == '0')) {
1144 // Then add this as well
1145 $userids['userid'][getMemberId()] = getMemberId();
1146 $userids['points'][getMemberId()] = countSumTotalData(getMemberId(), 'user_points', 'points') - countSumTotalData(getMemberId(), 'user_data', 'used_points');
1147 $userids['notified'][getMemberId()] = '0';
1149 // Get all userid except logged in one
1150 $result = SQL_QUERY_ESC("SELECT
1151 u.userid, UNIX_TIMESTAMP(d.surfbar_low_notified) AS notified
1153 `{?_MYSQL_PREFIX?}_surfbar_urls` AS u
1155 `{?_MYSQL_PREFIX?}_user_data` AS d
1159 u.userid NOT IN (%s,0) AND u.`status`='ACTIVE'
1164 array(getMemberId()), __FUNCTION__, __LINE__);
1167 $result = SQL_QUERY("SELECT
1168 u.userid, UNIX_TIMESTAMP(d.surfbar_low_notified) AS notified
1170 `{?_MYSQL_PREFIX?}_surfbar_urls` AS u
1172 `{?_MYSQL_PREFIX?}_user_data` AS d
1180 u.userid ASC", __FUNCTION__, __LINE__);
1184 while ($content = SQL_FETCHARRAY($result)) {
1186 $points = countSumTotalData($content['userid'], 'user_points', 'points') - countSumTotalData($content['userid'], 'user_data', 'used_points');
1187 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, "userid={$content['userid']},points={$points}", false);
1189 // Shall we add this to ignore?
1190 if ($points <= $limit) {
1192 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, "userid={$content['userid']} has depleted points amount!", false);
1193 $userids['userid'][$content['userid']] = $content['userid'];
1194 $userids['points'][$content['userid']] = $points;
1195 $userids['notified'][$content['userid']] = $content['notified'];
1200 SQL_FREERESULT($result);
1203 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, "UIDs::count=".count($userids)." (with own userid=".getMemberId().')', false);
1209 // Determine how many users are Online in surfbar
1210 function SURFBAR_DETERMINE_TOTAL_ONLINE () {
1211 // Count all users in surfbar modue and return the value
1212 $result = SQL_QUERY("SELECT
1215 `{?_MYSQL_PREFIX?}_surfbar_stats`
1217 (UNIX_TIMESTAMP() - UNIX_TIMESTAMP(`last_surfed`)) <= {?online_timeout?}
1219 `userid` ASC", __FUNCTION__, __LINE__);
1222 $cnt = SQL_NUMROWS($result);
1225 SQL_FREERESULT($result);
1231 // Determine waiting time for one URL
1232 function SURFBAR_DETERMINE_WAIT_TIME () {
1233 // Get fixed reload lock
1234 $fixed = SURFBAR_GET_FIXED_RELOAD();
1236 // Is the fixed reload time set?
1242 // Static time is default
1243 $time = getConfig('surfbar_static_time');
1245 // Which payment model do we have?
1246 if (getConfig('surfbar_pay_model') == 'DYNAMIC') {
1247 // "Calculate" dynamic time
1248 $time += SURFBAR_CALCULATE_DYNAMIC_ADD();
1255 // Changes the status of an URL from given to other
1256 function SURFBAR_CHANGE_STATUS ($urlId, $prevStatus, $newStatus, $data=array()) {
1257 // Make new status always lower-case
1258 $newStatus = strtolower($newStatus);
1260 // Get URL data for status comparison if missing
1261 if ((!is_array($data)) || (count($data) == 0)) {
1262 // Fetch missing URL data
1263 $data = SURFBAR_GET_URL_DATA($urlId);
1266 // Is the new status set?
1267 if ((!is_string($newStatus)) || (empty($newStatus))) {
1268 // Abort here, but fine!
1272 // Is the status like prevStatus is saying?
1273 if ($data[$urlId]['status'] != $prevStatus) {
1274 // No, then abort here
1279 // Update the status now
1280 // ---------- Comment out for debugging/developing member actions! ---------
1281 //SQL_QUERY_ESC("UPDATE `{?_MYSQL_PREFIX?}_surfbar_urls` SET `status`='%s' WHERE `id`=%s LIMIT 1",
1282 // array($newStatus, bigintval($urlId)), __FUNCTION__, __LINE__);
1283 // ---------- Comment out for debugging/developing member actions! ---------
1286 // ---------- Comment out for debugging/developing member actions! ---------
1287 //if (SQL_AFFECTEDROWS() != 1) {
1288 // // No, something went wrong
1291 // ---------- Comment out for debugging/developing member actions! ---------
1293 // Prepare content for notification routines
1294 $data[$urlId]['userid'] = $data[$urlId]['userid'];
1295 $data[$urlId]['frametester'] = generateFrametesterUrl($data[$urlId]['url']);
1296 $data[$urlId]['reward'] = translateComma(getConfig('surfbar_static_reward'));
1297 $data[$urlId]['costs'] = translateComma(getConfig('surfbar_static_costs'));
1299 // Do some dirty fixing here:
1300 if (($data[$urlId]['status'] == 'STOPPED') && ($newStatus == 'pending')) {
1301 // Fix for template change
1302 $newStatus = 'continued';
1305 // Send admin notification
1306 SURFBAR_NOTIFY_ADMIN("url_{$data[$urlId]['status']}_{$newStatus}", $data[$urlId]);
1308 // Send user notification
1309 SURFBAR_NOTIFY_USER("url_{$data[$urlId]['status']}_{$newStatus}", $data[$urlId]);
1315 // Calculate minimum value for dynamic payment model
1316 function SURFBAR_CALCULATE_DYNAMIC_MIN_VALUE () {
1317 // Addon is zero by default
1321 $percent = abs(log(getConfig('surfbar_dynamic_percent') / 100 + 1));
1324 $totalUsers = countSumTotalData('CONFIRMED', 'user_data', 'userid', 'status', true);
1327 $onlineUsers = SURFBAR_DETERMINE_TOTAL_ONLINE();
1330 $addon += abs(log($onlineUsers / $totalUsers + 1) * $percent * $totalUsers);
1333 $totalUrls = SURFBAR_GET_TOTAL_URLS('ACTIVE', 0);
1335 // Get user's total URLs
1336 $userUrls = SURFBAR_GET_TOTAL_USER_URLS(0, 'ACTIVE');
1339 if ($totalUrls > 0) {
1340 $addon += abs(log($userUrls / $totalUrls + 1) * $percent * $totalUrls);
1342 $addon += abs(log($userUrls / 1 + 1) * $percent * $totalUrls);
1349 // Calculate maximum value for dynamic payment model
1350 function SURFBAR_CALCULATE_DYNAMIC_MAX_VALUE () {
1351 // Addon is zero by default
1358 $percent = abs(log(getConfig('surfbar_dynamic_percent') / 100 + 1));
1361 $totalUsers = countSumTotalData('CONFIRMED', 'user_data', 'userid', 'status', true);
1364 $addon += abs($max * $percent * $totalUsers);
1367 $totalUrls = SURFBAR_GET_TOTAL_URLS('ACTIVE', 0);
1370 $addon += abs($max * $percent * $totalUrls);
1376 // Calculate dynamic lock
1377 function SURFBAR_CALCULATE_DYNAMIC_LOCK () {
1378 // Default lock is 30 seconds
1382 $onlineUsers = SURFBAR_DETERMINE_TOTAL_ONLINE();
1385 $addon = abs(log($onlineUsers / $addon + 1));
1391 // "Getter" for lock ids array
1392 function SURFBAR_GET_LOCK_IDS () {
1393 // Prepare some arrays
1398 // Get all id from locks within the timestamp
1399 $result = SQL_QUERY_ESC("SELECT `id`, `url_id`, UNIX_TIMESTAMP(`last_surfed`) AS last_surfed
1401 `{?_MYSQL_PREFIX?}_surfbar_locks`
1405 `id` ASC", array(getMemberId()),
1406 __FUNCTION__, __LINE__);
1409 while ($content = SQL_FETCHARRAY($result)) {
1411 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'next - lid='.$content['id'].',url='.$content['url_id'].',rest='.(time() - $content['last_surfed']).'/'.SURFBAR_GET_SURF_LOCK().'', false);
1413 // Skip entries that are too old
1414 if (($content['last_surfed'] > (time() - SURFBAR_GET_SURF_LOCK())) && (!in_array($content['url_id'], $ignored))) {
1416 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'okay - lid='.$content['id'].',url='.$content['url_id'].',last='.$content['last_surfed'].'', false);
1418 // Add only if missing or bigger
1419 if ((!isset($IDs[$content['url_id']])) || ($IDs[$content['url_id']] > $content['last_surfed'])) {
1421 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'ADD - lid='.$content['id'].',url='.$content['url_id'].',last='.$content['last_surfed'].'', false);
1424 $IDs[$content['url_id']] = $content['last_surfed'];
1425 $USE[$content['url_id']] = $content['id'];
1429 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'ignore - lid='.$content['id'].',url='.$content['url_id'].',last='.$content['last_surfed'].'', false);
1431 // Ignore these old entries!
1432 $ignored[] = $content['url_id'];
1433 unset($IDs[$content['url_id']]);
1434 unset($USE[$content['url_id']]);
1439 SQL_FREERESULT($result);
1445 // "Getter" for maximum random number
1446 function SURFBAR_GET_MAX_RANDOM ($userids, $add) {
1447 // Count max availabe entries
1448 $result = SQL_QUERY("SELECT
1451 `{?_MYSQL_PREFIX?}_surfbar_urls` AS sbu
1453 `{?_MYSQL_PREFIX?}_surfbar_salts` AS sbs
1457 `{?_MYSQL_PREFIX?}_surfbar_locks` AS l
1461 sbu.userid NOT IN (".implode(',', $userids).") AND
1462 (sbu.views_allowed=0 OR (sbu.views_allowed > 0 AND sbu.views_max > 0)) AND
1463 sbu.`status`='ACTIVE'
1466 sbu.id ASC", __FUNCTION__, __LINE__);
1469 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'lastQuery='.getConfig('db_last_query').'|numRows='.SQL_NUMROWS($result).'|Affected='.SQL_AFFECTEDROWS().'', false);
1472 $maxRand = SQL_NUMROWS($result);
1475 SQL_FREERESULT($result);
1481 // Load all URLs of the current user and return it as an array
1482 function SURFBAR_GET_USER_URLS () {
1487 $result = SQL_QUERY_ESC("SELECT
1488 u.id, u.userid, u.url, u.status,
1489 u.views_total, u.views_max, u.views_allowed,
1490 UNIX_TIMESTAMP(u.registered) AS url_registered,
1491 UNIX_TIMESTAMP(u.last_locked) AS url_last_locked,
1492 u.lock_reason AS lock_reason
1494 `{?_MYSQL_PREFIX?}_surfbar_urls` AS u
1497 u.status != 'DELETED'
1500 array(getMemberId()), __FUNCTION__, __LINE__);
1502 // Are there entries?
1503 if (SQL_NUMROWS($result) > 0) {
1505 while ($row = SQL_FETCHARRAY($result)) {
1507 $URLs[$row['id']] = $row;
1512 SQL_FREERESULT($result);
1518 // "Getter" for member action array for given status
1519 function SURFBAR_GET_ARRAY_FROM_STATUS ($status) {
1521 $returnArray = array();
1523 // Get all assigned actions
1524 $result = SQL_QUERY_ESC("SELECT action FROM `{?_MYSQL_PREFIX?}_surfbar_actions` WHERE `status`='%s' ORDER BY `id` ASC",
1525 array($status), __FUNCTION__, __LINE__);
1527 // Some entries there?
1528 if (SQL_NUMROWS($result) > 0) {
1530 // @TODO This can be somehow rewritten
1531 while ($content = SQL_FETCHARRAY($result)) {
1532 $returnArray[] = $content['action'];
1537 SQL_FREERESULT($result);
1540 return $returnArray;
1543 // Reload to configured stop page
1544 function SURFBAR_RELOAD_TO_STOP_PAGE ($page = 'stop') {
1545 // Internal or external?
1546 if ((getConfig('surfbar_pause_mode') == 'INTERNAL') || (getConfig('surfbar_pause_url') == '')) {
1547 // Reload to internal page
1548 redirectToUrl('surfbar.php?frame=' . $page);
1550 // Reload to external page
1551 redirectToConfiguredUrl('surfbar_pause_url');
1555 // Determine next id for surfbar or get data for given id, always call this before you call other
1556 // getters below this function!!!
1557 function SURFBAR_DETERMINE_NEXT_ID ($urlId = '0') {
1558 // Default is no id and no random number
1563 if ($urlId == '0') {
1564 // Get array with lock ids
1565 $USE = SURFBAR_GET_LOCK_IDS();
1567 // Shall we add some URL ids to ignore?
1569 if (count($USE) > 0) {
1571 $add = " AND sbu.id NOT IN (";
1572 foreach ($USE as $url_id => $lid) {
1574 $add .= $url_id.',';
1577 // Add closing bracket
1578 $add = substr($add, 0, -1) . ')';
1581 // Determine depleted user account
1582 $userids = SURFBAR_DETERMINE_DEPLETED_USERIDS();
1584 // Get maximum randomness factor
1585 $maxRand = SURFBAR_GET_MAX_RANDOM($userids['userid'], $add);
1587 // If more than one URL can be called generate the random number!
1589 // Generate random number
1590 $randNum = mt_rand(0, ($maxRand - 1));
1593 // And query the database
1594 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'randNum='.$randNum.',maxRand='.$maxRand.',surfLock='.SURFBAR_GET_SURF_LOCK().'', false);
1595 $result = SQL_QUERY_ESC("SELECT sbu.id, sbu.userid, sbu.url, sbs.last_salt, sbu.views_total, sbu.views_max, sbu.views_allowed, UNIX_TIMESTAMP(l.last_surfed) AS last_surfed, sbu.fixed_reload
1596 FROM `{?_MYSQL_PREFIX?}_surfbar_urls` AS sbu
1597 LEFT JOIN `{?_MYSQL_PREFIX?}_surfbar_salts` AS sbs
1598 ON sbu.id=sbs.url_id
1599 LEFT JOIN `{?_MYSQL_PREFIX?}_surfbar_locks` AS l
1601 WHERE sbu.userid NOT IN (".implode(',', $userids['userid']).") AND sbu.`status`='ACTIVE' AND (sbu.views_allowed=0 OR (sbu.views_allowed > 0 AND sbu.views_max > 0))".$add."
1603 ORDER BY l.last_surfed ASC, sbu.id ASC
1605 array($randNum), __FUNCTION__, __LINE__
1608 // Get data from specified id number
1609 $result = SQL_QUERY_ESC("SELECT sbu.id, sbu.userid, sbu.url, sbs.last_salt, sbu.views_total, sbu.views_max, sbu.views_allowed, UNIX_TIMESTAMP(l.last_surfed) AS last_surfed, sbu.fixed_reload
1610 FROM `{?_MYSQL_PREFIX?}_surfbar_urls` AS sbu
1611 LEFT JOIN `{?_MYSQL_PREFIX?}_surfbar_salts` AS sbs
1612 ON sbu.id=sbs.url_id
1613 LEFT JOIN `{?_MYSQL_PREFIX?}_surfbar_locks` AS l
1615 WHERE sbu.userid != %s AND sbu.`status`='ACTIVE' AND sbu.id=%s AND (sbu.views_allowed=0 OR (sbu.views_allowed > 0 AND sbu.views_max > 0))
1617 array(getMemberId(), bigintval($urlId)), __FUNCTION__, __LINE__
1621 // Is there an id number?
1622 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'lastQuery='.getConfig('db_last_query').'|numRows='.SQL_NUMROWS($result).'|Affected='.SQL_AFFECTEDROWS().'', false);
1623 if (SQL_NUMROWS($result) == 1) {
1625 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'count('.count($GLOBALS['surfbar_cache']).') - BEFORE', false);
1626 $GLOBALS['surfbar_cache'] = merge_array($GLOBALS['surfbar_cache'], SQL_FETCHARRAY($result));
1627 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'count('.count($GLOBALS['surfbar_cache']).') - AFTER', false);
1629 // Determine waiting time
1630 $GLOBALS['surfbar_cache']['time'] = SURFBAR_DETERMINE_WAIT_TIME();
1632 // Is the last salt there?
1633 if (is_null($GLOBALS['surfbar_cache']['last_salt'])) {
1634 // Then repair it wit the static!
1635 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'last_salt - FIXED!', false);
1636 $GLOBALS['surfbar_cache']['last_salt'] = '';
1639 // Fix missing last_surfed
1640 if ((!isset($GLOBALS['surfbar_cache']['last_surfed'])) || (is_null($GLOBALS['surfbar_cache']['last_surfed']))) {
1642 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'last_surfed - FIXED!', false);
1643 $GLOBALS['surfbar_cache']['last_surfed'] = '0';
1646 // Get base/fixed reward and costs
1647 $GLOBALS['surfbar_cache']['reward'] = SURFBAR_DETERMINE_REWARD();
1648 $GLOBALS['surfbar_cache']['costs'] = SURFBAR_DETERMINE_COSTS();
1649 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'BASE/STATIC - reward='.SURFBAR_GET_REWARD().'|costs='.SURFBAR_GET_COSTS().'', false);
1651 // Only in dynamic model add the dynamic bonus!
1652 if (getConfig('surfbar_pay_model') == 'DYNAMIC') {
1653 // Calculate dynamic reward/costs and add it
1654 $GLOBALS['surfbar_cache']['reward'] += SURFBAR_CALCULATE_DYNAMIC_ADD();
1655 $GLOBALS['surfbar_cache']['costs'] += SURFBAR_CALCULATE_DYNAMIC_ADD();
1656 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'DYNAMIC+ - reward='.SURFBAR_GET_REWARD().'|costs='.SURFBAR_GET_COSTS().'', false);
1660 $nextId = SURFBAR_GET_ID();
1664 SQL_FREERESULT($result);
1667 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'nextId='.$nextId.'', false);
1671 // -----------------------------------------------------------------------------
1672 // PLEASE DO NOT ADD ANY OTHER FUNCTIONS BELOW THIS LINE IF THEY DON'T "WRAP"
1673 // THE $GLOBALS['surfbar_cache'] ARRAY!
1674 // -----------------------------------------------------------------------------
1676 // Initializes the surfbar
1677 function SURFBAR_INIT () {
1679 $GLOBALS['surfbar_cache'] = array();
1682 // Private getter for data elements
1683 function SURFBAR_GET_DATA ($element) {
1684 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, "element={$element}", false);
1689 // Is the entry there?
1690 if (isset($GLOBALS['surfbar_cache'][$element])) {
1692 $data = $GLOBALS['surfbar_cache'][$element];
1693 } else { // END - if
1695 print_r($GLOBALS['surfbar_cache']);
1701 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, "element[$element]={$data}", false);
1705 // Getter for reward from cache
1706 function SURFBAR_GET_REWARD () {
1707 // Get data element and return its contents
1708 return SURFBAR_GET_DATA('reward');
1711 // Getter for costs from cache
1712 function SURFBAR_GET_COSTS () {
1713 // Get data element and return its contents
1714 return SURFBAR_GET_DATA('costs');
1717 // Getter for URL from cache
1718 function SURFBAR_GET_URL () {
1719 // Get data element and return its contents
1720 return SURFBAR_GET_DATA('url');
1723 // Getter for salt from cache
1724 function SURFBAR_GET_SALT () {
1725 // Get data element and return its contents
1726 return SURFBAR_GET_DATA('salt');
1729 // Getter for id from cache
1730 function SURFBAR_GET_ID () {
1731 // Get data element and return its contents
1732 return SURFBAR_GET_DATA('id');
1735 // Getter for userid from cache
1736 function SURFBAR_GET_USERID () {
1737 // Get data element and return its contents
1738 return SURFBAR_GET_DATA('userid');
1741 // Getter for user reload locks
1742 function SURFBAR_GET_USER_LOCKS () {
1743 // Get data element and return its contents
1744 return SURFBAR_GET_DATA('user_locks');
1747 // Getter for reload time
1748 function SURFBAR_GET_RELOAD_TIME () {
1749 // Get data element and return its contents
1750 return SURFBAR_GET_DATA('time');
1753 // Getter for allowed views
1754 function SURFBAR_GET_VIEWS_ALLOWED () {
1755 // Get data element and return its contents
1756 return SURFBAR_GET_DATA('views_allowed');
1759 // Getter for fixed reload
1760 function SURFBAR_GET_FIXED_RELOAD () {
1761 // Get data element and return its contents
1762 return SURFBAR_GET_DATA('fixed_reload');
1765 // Getter for surf lock
1766 function SURFBAR_GET_SURF_LOCK () {
1767 // Get data element and return its contents
1768 return SURFBAR_GET_DATA('surf_lock');
1771 // Getter for new status
1772 function SURFBAR_GET_NEW_STATUS () {
1773 // Get data element and return its contents
1774 return SURFBAR_GET_DATA('new_status');