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 * -------------------------------------------------------------------- *
18 * Copyright (c) 2003 - 2009 by Roland Haeder *
19 * Copyright (c) 2009, 2010 by Mailer Developer Team *
20 * For more information visit: http://www.mxchange.org *
22 * This program is free software; you can redistribute it and/or modify *
23 * it under the terms of the GNU General Public License as published by *
24 * the Free Software Foundation; either version 2 of the License, or *
25 * (at your option) any later version. *
27 * This program is distributed in the hope that it will be useful, *
28 * but WITHOUT ANY WARRANTY; without even the implied warranty of *
29 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the *
30 * GNU General Public License for more details. *
32 * You should have received a copy of the GNU General Public License *
33 * along with this program; if not, write to the Free Software *
34 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, *
36 ************************************************************************/
38 // Some security stuff...
39 if (!defined('__SECURITY')) {
43 // -----------------------------------------------------------------------------
45 // -----------------------------------------------------------------------------
47 // Admin has added an URL with given user id and so on
48 function SURFBAR_ADMIN_ADD_URL ($url, $limit, $reload) {
52 logDebugMessage(__FUNCTION__, __LINE__, sprintf("Cannot add URL=%s,limit=%s,reload=%s : Not admin.", $url, $limit, $reload));
54 } elseif (!isUrlValid($url)) {
56 logDebugMessage(__FUNCTION__, __LINE__, sprintf("Cannot add URL=%s,limit=%s,reload=%s : Invalid URL.", $url, $limit, $reload));
58 } elseif (SURFBAR_LOOKUP_BY_URL($url, 0)) {
59 // URL already found in surfbar!
60 logDebugMessage(__FUNCTION__, __LINE__, sprintf("Cannot add URL=%s,limit=%s,reload=%s : Already added.", $url, $limit, $reload));
62 } elseif (!SURFBAR_IF_USER_BOOK_MORE_URLS()) {
64 logDebugMessage(__FUNCTION__, __LINE__, sprintf("Cannot add URL=%s,limit=%s,reload=%s : No more URLs allowed.", $url, $limit, $reload));
66 } elseif ('' . ($limit + 0) . '' != '' . $limit . '') {
67 // Invalid limit entered
68 logDebugMessage(__FUNCTION__, __LINE__, sprintf("Cannot add URL=%s,limit=%s,reload=%s : Invalid limit entered.", $url, $limit, $reload));
70 } elseif ('' . ($reload + 0) . '' != '' . $reload . '') {
71 // Invalid amount entered
72 logDebugMessage(__FUNCTION__, __LINE__, sprintf("Cannot add URL=%s,limit=%s,reload=%s : Invalid reload entered.", $url, $limit, $reload));
76 // Register the new URL
77 return SURFBAR_REGISTER_URL($url, 0, 'ACTIVE', 'unlock', array('limit' => $limit, 'reload' => $reload));
80 // Admin unlocked an email so we can migrate the URL
81 function SURFBAR_ADMIN_MIGRATE_URL ($url, $userid) {
86 } elseif (!isUrlValid($url)) {
89 } elseif (SURFBAR_LOOKUP_BY_URL($url, $userid)) {
90 // URL already found in surfbar!
92 } elseif (!SURFBAR_IF_USER_BOOK_MORE_URLS($userid)) {
97 // Register the new URL
98 return SURFBAR_REGISTER_URL($url, $userid, 'MIGRATED', 'migrate');
101 // Admin function for unlocking URLs
102 function SURFBAR_ADMIN_UNLOCK_URL_IDS ($IDs) {
103 // Is this an admin or invalid array?
105 // Not admin or invalid ids array
107 } elseif (!is_array($IDs)) {
110 } elseif (count($IDs) == 0) {
115 // Set to true to make AND expression valid if first URL got unlocked
118 // Update the status for all ids
119 foreach ($IDs as $id => $dummy) {
120 // Test all ids through (ignores failed)
121 $done = (($done) && (SURFBAR_CHANGE_STATUS($id, 'PENDING', 'ACTIVE')));
124 // Return total status
128 // Admin function for rejecting URLs
129 function SURFBAR_ADMIN_REJECT_URL_IDS ($IDs) {
130 // Is this an admin or invalid array?
132 // Not admin or invalid ids array
134 } elseif (!is_array($IDs)) {
137 } elseif (count($IDs) == 0) {
142 // Set to true to make AND expression valid if first URL got unlocked
145 // Update the status for all ids
146 foreach ($IDs as $id => $dummy) {
147 // Test all ids through (ignores failed)
148 $done = (($done) && (SURFBAR_CHANGE_STATUS($id, 'PENDING', 'REJECTED')));
151 // Return total status
156 // -----------------------------------------------------------------------------
158 // -----------------------------------------------------------------------------
160 // Member has added an URL
161 function SURFBAR_MEMBER_ADD_URL ($url, $limit) {
162 // Do some pre-checks
166 } elseif ((!isUrlValid($url)) && (!isAdmin())) {
169 } elseif (SURFBAR_LOOKUP_BY_URL($url, getMemberId())) {
170 // URL already found in surfbar!
172 } elseif (!SURFBAR_IF_USER_BOOK_MORE_URLS(getMemberId())) {
175 } elseif (''.($limit + 0).'' != ''.$limit.'') {
176 // Invalid amount entered
180 // Register the new URL
181 return SURFBAR_REGISTER_URL($url, getMemberId(), 'PENDING', 'reg', array('limit' => $limit));
184 // Create list of actions depending on status for the user
185 function SURFBAR_MEMBER_ACTIONS ($urlId, $status) {
186 // Load all actions in an array for given status
187 $actionArray = SURFBAR_GET_ARRAY_FROM_STATUS($status);
190 $OUT = '<table border="0" cellspacing="0" cellpadding="1" width="100%">
194 $width = round(100 / count($actionArray));
196 // "Walk" through all actions and create forms
197 foreach ($actionArray as $actionId => $action) {
198 // Add form for this action
199 $OUT .= loadTemplate('member_surfbar_list_form', true, array(
201 'id' => bigintval($urlId),
202 'action' => strtolower($action),
203 'title' => '{--MEMBER_SURFBAR_ACTION_' . strtoupper($action) . '_TITLE--}',
204 'submit' => '{--MEMBER_SURFBAR_ACTION_' . strtoupper($action) . '_SUBMIT--}',
216 // Do the member form request
217 function SURFBAR_MEMBER_DO_FORM ($formData, $urlArray) {
218 // By default no action is performed
225 } elseif ((!isset($formData['id'])) || (!isset($formData['action']))) {
226 // Important form elements are missing!
228 } elseif (!isset($urlArray[$formData['id']])) {
229 // id not found in cache
231 } elseif (!SURFBAR_VALIDATE_MEMBER_ACTION_STATUS($formData['action'], $urlArray[$formData['id']]['url_status'])) {
232 // Action not allowed for current URL status
237 $action = secureString($formData['action']);
240 if ($action != $formData['action']) {
241 // Invalid data in action found
245 // Create the function name for selected action
246 $functionName = sprintf("SURFBAR_MEMBER_%s_ACTION", strtoupper($action));
248 // Is the function there?
249 if (function_exists($functionName)) {
251 $urlArray[$formData['id']]['new_status'] = SURFBAR_GET_NEW_STATUS('new_status');
253 // Extract URL data for call-back
254 $urlData = array(merge_array($urlArray[$formData['id']], array($action => $formData)));
256 // Action found so execute it
257 $performed = call_user_func_array($functionName, $urlData);
259 // Log invalid request
260 logDebugMessage(__FUNCTION__, __LINE__, "action={$formData['action']},id={$formData['id']},function={$functionName}");
261 addFatalMessage(__FUNCTION__, __LINE__, "Invalid member action! action=%s,id=%s,function=%s", array($formData['action'], $formData['id'], $functionName));
268 // Validate if the requested action can be performed on current URL status
269 function SURFBAR_VALIDATE_MEMBER_ACTION_STATUS ($action, $status) {
270 // Search for the requested action/status combination in database
271 $result = SQL_QUERY_ESC("SELECT new_status FROM `{?_MYSQL_PREFIX?}_surfbar_actions` WHERE `action`='%s' AND `status`='%s' LIMIT 1",
272 array($action, $status), __FUNCTION__, __LINE__);
274 // Is the entry there?
275 $isValid = (SQL_NUMROWS($result) == 1);
277 // Fetch the new status if found
280 list($GLOBALS['surfbar_cache']['new_status']) = SQL_FETCHROW($result);
284 SQL_FREERESULT($result);
291 // -----------------------------------------------------------------------------
293 // -----------------------------------------------------------------------------
295 // Retreat a booked URL
296 function SURFBAR_MEMBER_RETREAT_ACTION ($urlData) {
297 // Create the data array for next function call
299 $urlData['id'] => $urlData
302 // Simply change the status here
303 return SURFBAR_CHANGE_STATUS ($urlData['id'], $urlData['url_status'], $urlData['new_status'], $data);
306 // Book an URL now (from migration)
307 function SURFBAR_MEMBER_BOOKNOW_ACTION ($urlData) {
308 // Create the data array for next function call
310 $urlData['id'] => $urlData
313 // Simply change the status here
314 return SURFBAR_CHANGE_STATUS ($urlData['id'], $urlData['url_status'], $urlData['new_status'], $data);
317 // Show edit form or do the changes
318 function SURFBAR_MEMBER_EDIT_ACTION ($urlData) {
319 // Is the "execute" flag there?
320 if (isset($urlData['edit']['execute'])) {
321 // Execute the changes
322 return SURFBAR_MEMBER_EXECUTE_ACTION('edit', $urlData);
326 return SURFBAR_MEMBER_DISPLAY_ACTION_FORM('edit', $urlData);
329 // Show delete form or do the changes
330 function SURFBAR_MEMBER_DELETE_ACTION ($urlData) {
331 // Is the "execute" flag there?
332 if (isset($urlData['delete']['execute'])) {
333 // Execute the changes
334 return SURFBAR_MEMBER_EXECUTE_ACTION('delete', $urlData);
338 return SURFBAR_MEMBER_DISPLAY_ACTION_FORM('delete', $urlData);
341 // Pause active banner
342 function SURFBAR_MEMBER_PAUSE_ACTION ($urlData) {
343 return SURFBAR_CHANGE_STATUS($urlData['id'], $urlData['url_status'], $urlData['new_status'], array($urlData['id'] => $urlData));
346 // Unpause stopped banner
347 function SURFBAR_MEMBER_UNPAUSE_ACTION ($urlData) {
348 // Fix missing entry for template
349 $urlData['edit'] = $urlData['unpause'];
350 $urlData['edit']['url'] = $urlData['url'];
351 $urlData['edit']['limit'] = SURFBAR_GET_VIEWS_MAX();
353 // Return status change
354 return SURFBAR_CHANGE_STATUS($urlData['id'], $urlData['url_status'], $urlData['new_status'], array($urlData['id'] => $urlData));
357 // Resubmit locked URL
358 function SURFBAR_MEMBER_RESUBMIT_ACTION ($urlData) {
359 return SURFBAR_CHANGE_STATUS($urlData['id'], $urlData['url_status'], $urlData['new_status'], array($urlData['id'] => $urlData));
362 // Display selected "action form"
363 function SURFBAR_MEMBER_DISPLAY_ACTION_FORM ($action, $urlData) {
364 // Translate some data if present
365 $content = SURFBAR_PREPARE_CONTENT_FOR_TEMPLATE($content);
367 // Include fields only for action 'edit'
368 if ($action == 'edit') {
369 // Default is not limited
370 $urlData['limited_yes'] = '';
371 $urlData['limited_no'] = ' checked="checked"';
372 $urlData['limited'] = 'false';
374 // Is this URL limited?
375 if (SURFBAR_GET_VIEWS_MAX() > 0) {
376 // Then rewrite form data
377 $urlData['limited_yes'] = ' checked="checked"';
378 $urlData['limited_no'] = '';
379 $urlData['limited'] = 'true';
383 // Load the form and display it
384 loadTemplate(sprintf("member_surfbar_%s_action_form", $action), false, $urlData);
386 // All fine by default ... ;-)
390 // Execute choosen action
391 function SURFBAR_MEMBER_EXECUTE_ACTION ($action, $urlData) {
392 // By default nothing is executed
395 // Is limitation "no" and "limit" is > 0?
396 if ((isset($urlData[$action]['limited'])) && ($urlData[$action]['limited'] != 'Y') && ((isset($urlData[$action]['limit'])) && ($urlData[$action]['limit'] > 0)) || (!isset($urlData[$action]['limit']))) {
397 // Set it to unlimited
398 $urlData[$action]['limit'] = '0';
401 // Construct function name
402 $functionName = sprintf("SURFBAR_MEMBER_EXECUTE_%s_ACTION", strtoupper($action));
404 // Is that function there?
405 if (function_exists($functionName)) {
406 // Execute the function
407 if (call_user_func_array($functionName, array($urlData)) == true) {
408 // Update status as well
409 $executed = SURFBAR_CHANGE_STATUS($urlData['id'], $urlData['url_status'], $urlData['new_status'], array($urlData['id'] => $urlData));
413 addFatalMessage(__FUNCTION__, __LINE__, '{--MEMBER_SURFBAR_EXECUTE_ACTION_404--}', $functionName);
419 // "Execute edit" function: Update changed data
420 function SURFBAR_MEMBER_EXECUTE_EDIT_ACTION ($urlData) {
421 // Default is nothing done
424 // Has the URL or limit changed?
426 //if (($urlData['url_views_allowed'] != $urlData['edit']['limit']) || ($url1 != $url2)) {
428 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",
429 array($urlData['url'], $urlData['edit']['limit'], $urlData['edit']['limit'], $urlData['id'], $urlData['url_status']), __FUNCTION__, __LINE__);
438 // "Execute delete" function: Does nothing...
439 function SURFBAR_MEMBER_EXECUTE_DELETE_ACTION ($urlData) {
440 // Nothing special to do (see above function for such "special actions" to perform)
444 // -----------------------------------------------------------------------------
445 // Self-maintenance functions
446 // -----------------------------------------------------------------------------
449 function SURFBAR_HANDLE_SELF_MAINTENANCE () {
450 // Handle URLs which limit has depleted so we can stop them
451 SURFBAR_HANDLE_DEPLETED_VIEWS();
453 // Handle low-points amounts
454 SURFBAR_HANDLE_LOW_POINTS();
456 // Handle URLs which limit has depleted
457 function SURFBAR_HANDLE_DEPLETED_VIEWS () {
459 $urlArray = SURFBAR_GET_URL_DATA(0, 'url_views_max', 'url_id', 'ASC', 'url_id', " AND `url_views_allowed` > 0 AND `url_status`='ACTIVE'");
461 // Do we have some entries?
462 if (count($urlArray) > 0) {
464 foreach ($urlArray as $id => $urlData) {
468 // Rewrite array for next call
469 $urlData[$id] = $data;
472 SURFBAR_CHANGE_STATUS($id, 'ACTIVE', 'DEPLETED', $urlData);
477 // Alert users which have URLs booked and are low on points amount
478 function SURFBAR_HANDLE_LOW_POINTS () {
480 $userids = SURFBAR_DETERMINE_DEPLETED_USERIDS(getConfig('surfbar_warn_low_points'));
482 // "Walk" through all URLs
483 foreach ($userids['url_userid'] as $userid => $dummy) {
484 // Is the last notification far enougth away to notify again?
485 if ((time() - $userids['notified'][$userid]) >= getConfig('surfbar_low_interval')) {
488 'url_userid' => $userid,
489 'points' => $userids['points'][$userid],
490 'notified' => $userids['notified'][$userid]
494 SURFBAR_NOTIFY_USER('low_points', $content);
496 // Update last notified
497 SQL_QUERY_ESC("UPDATE `{?_MYSQL_PREFIX?}_user_data` SET `surfbar_low_notified`=NOW() WHERE `userid`=%s LIMIT 1",
498 array($userid), __FUNCTION__, __LINE__);
504 // -----------------------------------------------------------------------------
506 // -----------------------------------------------------------------------------
509 // Looks up by an URL
510 function SURFBAR_LOOKUP_BY_URL ($url, $userid) {
511 // Now lookup that given URL by itself
512 $urlArray = SURFBAR_GET_URL_DATA($url, 'url', 'url_id', 'ASC', 'url_id', sprintf(" AND `url_userid`=%s", bigintval($userid)));
515 return (count($urlArray) > 0);
518 // Load URL data by given search term and column
519 function SURFBAR_GET_URL_DATA ($searchTerm, $column = 'url_id', $order = 'url_id', $sort = 'ASC', $group = 'url_id', $add = '') {
520 // By default nothing is found
521 $GLOBALS['last_url_data'] = array();
523 // Is the column an id number?
524 if (($column == 'url_id') || ($column == 'url_userid')) {
525 // Extra secure input
526 $searchTerm = bigintval($searchTerm);
529 // If the column is 'id' there can be only one entry
531 if ($column == 'id') {
535 // Look up the record
536 $result = SQL_QUERY_ESC("SELECT
544 UNIX_TIMESTAMP(`url_registered`) AS `url_registered`,
545 UNIX_TIMESTAMP(`url_last_locked`) AS `url_last_locked`,
551 `{?_MYSQL_PREFIX?}_surfbar_urls`
553 `%s`='%s'" . $add . "
563 ), __FUNCTION__, __LINE__);
565 // Is there at least one record?
566 if (!SQL_HASZERONUMS($result)) {
568 while ($dataRow = SQL_FETCHARRAY($result)) {
569 // Shall we group these results?
570 if ($group == 'url_id') {
571 // Add the row by id as index
572 $GLOBALS['last_url_data'][$dataRow['url_id']] = $dataRow;
575 $GLOBALS['last_url_data'][$dataRow[$group]][$dataRow['url_id']] = $dataRow;
581 SQL_FREERESULT($result);
584 return $GLOBALS['last_url_data'];
587 // Registers an URL with the surfbar. You should have called SURFBAR_LOOKUP_BY_URL() first!
588 function SURFBAR_REGISTER_URL ($url, $userid, $status = 'PENDING', $addMode = 'reg', $extraFields = array()) {
589 // Make sure by the user registered URLs are always pending
590 if ($addMode == 'reg') {
595 $content = merge_array($extraFields, array(
597 'url_userid' => $userid,
598 'url_status' => $status,
601 // Is limit/reload set?
602 if (!isset($config['limit'])) {
603 $content['limit'] = '0';
605 if (!isset($config['reload'])) {
606 $content['reload'] = '0';
609 // Insert the URL into database
610 $content['insert_id'] = SURFBAR_INSERT_URL_BY_ARRAY($content);
613 if ($content['insert_id'] == '0') {
614 // INSERT did not insert any data!
618 // If in reg-mode we notify admin
619 if (($addMode == 'reg') || (getConfig('surfbar_notify_admin_unlock') == 'Y')) {
620 // Notify admin even when he as unlocked an email
621 SURFBAR_NOTIFY_ADMIN('url_' . $addMode, $content);
625 SURFBAR_NOTIFY_USER('url_' . $addMode, $content);
627 // Return the insert id
628 return $content['insert_id'];
631 // Inserts an url by given data array and return the insert id
632 function SURFBAR_INSERT_URL_BY_ARRAY ($urlData) {
634 $userid = bigintval($urlData['url_userid']);
637 if (empty($userid)) $userid = '0';
639 // Just run the insert query for now
640 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)",
644 $urlData['url_status'],
648 ), __FUNCTION__, __LINE__
652 return SQL_INSERTID();
655 // Notify admin(s) with a selected message and content
656 function SURFBAR_NOTIFY_ADMIN ($messageType, $content) {
657 // Prepare template name
658 $templateName = sprintf("admin_surfbar_%s", $messageType);
661 $subject = sprintf("{--ADMIN_SURFBAR_NOTIFY_%s_SUBJECT--}",
662 strtoupper($messageType)
665 // Is the subject line there?
666 if ((substr($subject, 0, 1) == '!') && (substr($subject, -1, 1) == '!')) {
667 // Set default subject if following eval() wents wrong
668 $subject = getMaskedMessage('ADMIN_SURFBAR_NOTIFY_DEFAULT_SUBJECT', strtoupper($messageType));
671 // Translate some data if present
672 $content = SURFBAR_PREPARE_CONTENT_FOR_TEMPLATE($content);
674 // Send the notification out
675 return sendAdminNotification($subject, $templateName, $content, $content['url_userid']);
678 // Notify the user about the performed action
679 function SURFBAR_NOTIFY_USER ($messageType, $content) {
680 // Skip notification if userid is zero
681 if ($content['url_userid'] == '0') {
685 // Prepare template name
686 $templateName = sprintf("member_surfbar_%s", $messageType);
689 $subject = sprintf("{--MEMBER_SURFBAR_NOTIFY_%s_SUBJECT--}",
690 strtoupper($messageType)
693 // Is the subject line there?
694 if ((substr($subject, 0, 1) == '!') && (substr($subject, -1, 1) == '!')) {
695 // Set default subject if following eval() wents wrong
696 $subject = '{--MEMBER_SURFBAR_NOTIFY_DEFAULT_SUBJECT--}';
699 // Translate some data if present
700 $content = SURFBAR_PREPARE_CONTENT_FOR_TEMPLATE($content);
703 $mailText = loadEmailTemplate($templateName, $content, $content['url_userid']);
706 return sendEmail($content['url_userid'], $subject, $mailText);
709 // Translates some data for template usage
710 // @TODO Can't we use our new expression language instead of this ugly code?
711 function SURFBAR_PREPARE_CONTENT_FOR_TEMPLATE ($content) {
713 if (isset($content['url_registered'])) $content['url_registered'] = generateDateTime($content['url_registered'], 2);
714 if (isset($content['url_last_locked'])) $content['url_last_locked'] = generateDateTime($content['url_last_locked'], 2);
716 // Return translated content
720 // Translates the limit
721 function translateSurfbarLimit ($limit) {
725 $return = '{--MEMBER_SURFBAR_UNLIMITED_VIEWS--}';
728 $return = '{%pipe,translateComma=' . $limit . '%}';
735 // Translate the URL status
736 function translateSurfbarUrlStatus ($status) {
738 return sprintf("{--SURFBAR_URL_STATUS_%s--}", strtoupper($status));
742 function SURFBAR_DETERMINE_REWARD ($onlyMin=false) {
743 // Static values are default
744 $reward = getConfig('surfbar_static_reward');
746 // Do we have static or dynamic?
747 if (getConfig('surfbar_pay_model') == 'DYNAMIC') {
748 // "Calculate" dynamic reward
750 $reward += SURFBAR_CALCULATE_DYNAMIC_MIN_VALUE();
752 $reward += SURFBAR_CALCULATE_DYNAMIC_ADD();
761 function SURFBAR_DETERMINE_COSTS ($onlyMin=false) {
762 // Static costs is default
763 $costs = getConfig('surfbar_static_costs');
765 // Do we have static or dynamic?
766 if (getConfig('surfbar_pay_model') == 'DYNAMIC') {
767 // "Calculate" dynamic costs
769 $costs += SURFBAR_CALCULATE_DYNAMIC_MIN_VALUE();
771 $costs += SURFBAR_CALCULATE_DYNAMIC_ADD();
779 // "Calculate" dynamic add
780 function SURFBAR_CALCULATE_DYNAMIC_ADD () {
781 // Get min/max values
782 $min = SURFBAR_CALCULATE_DYNAMIC_MIN_VALUE();
783 $max = SURFBAR_CALCULATE_DYNAMIC_MAX_VALUE();
785 // "Calculate" dynamic part and return it
786 return mt_rand($min, $max);
789 // Determine right template name
790 function SURFBAR_DETERMINE_TEMPLATE_NAME() {
791 // Default is the frameset
792 $templateName = "surfbar_frameset";
794 // Any frame set? ;-)
795 if (isGetRequestParameterSet('frame')) {
796 // Use the frame as a template name part... ;-)
797 $templateName = sprintf("surfbar_frame_%s",
798 getRequestParameter('frame')
803 return $templateName;
806 // Check if the "reload lock" of the current user is full, call this function
807 // before you call SURFBAR_CHECK_RELOAD_LOCK().
808 function SURFBAR_CHECK_RELOAD_FULL () {
812 // Cache static reload lock
813 $GLOBALS['surfbar_cache']['surf_lock'] = getConfig('surfbar_static_lock');
814 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'Fixed surf lock is '.getConfig('surfbar_static_lock') . '', false);
816 // Do we have dynamic model?
817 if (getConfig('surfbar_pay_model') == 'DYNAMIC') {
818 // "Calculate" dynamic lock
819 $GLOBALS['surfbar_cache']['surf_lock'] += SURFBAR_CALCULATE_DYNAMIC_ADD();
823 $result = SQL_QUERY_ESC("SELECT
824 COUNT(l.locks_id) AS cnt
826 `{?_MYSQL_PREFIX?}_surfbar_locks` AS l
828 `{?_MYSQL_PREFIX?}_surfbar_urls` AS u
830 u.url_id=l.locks_url_id
832 l.locks_userid=%s AND
833 (UNIX_TIMESTAMP() - ".SURFBAR_GET_SURF_LOCK().") < UNIX_TIMESTAMP(l.locks_last_surfed) AND
835 ((UNIX_TIMESTAMP(l.locks_last_surfed) - u.url_fixed_reload) < 0 AND u.url_fixed_reload > 0) OR
836 u.url_fixed_reload = '0'
839 array(getMemberId()), __FUNCTION__, __LINE__
843 list($GLOBALS['surfbar_cache']['user_locks']) = SQL_FETCHROW($result);
846 if (is_null($GLOBALS['surfbar_cache']['user_locks'])) {
847 // Then fix it to zero!
848 $GLOBALS['surfbar_cache']['user_locks'] = '0';
852 SQL_FREERESULT($result);
855 $total = SURFBAR_GET_TOTAL_URLS();
857 // Do we have some URLs in lock? Admins can always surf on own URLs!
858 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, "userLocks=".SURFBAR_GET_USER_LOCKS().",total={$total}", false);
859 $isFull = ((SURFBAR_GET_USER_LOCKS() == $total) && ($total > 0));
865 // Get total amount of URLs of given status for current user or of ACTIVE URLs by default
866 function SURFBAR_GET_TOTAL_URLS ($status = 'ACTIVE', $excludeUserId = '0') {
867 // Determine depleted user account
868 $userids = SURFBAR_DETERMINE_DEPLETED_USERIDS();
870 // If we dont get any user ids back, there are no URLs
871 if (count($userids['url_userid']) == 0) {
872 // No user ids found, no URLs!
876 // Is the exlude userid set?
877 if (isValidUserId($excludeUserId)) {
879 $userids['url_userid'][$excludeUserId] = $excludeUserId;
882 // Get amount from database
883 $result = SQL_QUERY_ESC("SELECT
884 COUNT(`url_id`) AS cnt
886 `{?_MYSQL_PREFIX?}_surfbar_urls`
888 `url_userid` NOT IN (".implode(', ', $userids['url_userid']).") AND
891 array($status), __FUNCTION__, __LINE__
895 list($count) = SQL_FETCHROW($result);
898 SQL_FREERESULT($result);
901 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'cnt=' . $count);
907 // Check wether the user is allowed to book more URLs
908 function SURFBAR_IF_USER_BOOK_MORE_URLS ($userid = '0') {
909 // Is this admin and userid is zero or does the user has some URLs left to book?
910 return ((($userid == '0') && (isAdmin())) || (SURFBAR_GET_TOTAL_USER_URLS($userid, '', array('REJECTED')) < getConfig('surfbar_max_order')));
913 // Get total amount of URLs of given status for current user
914 function SURFBAR_GET_TOTAL_USER_URLS ($userid = '0', $status = '', $exclude = '') {
915 // Is the user 0 and user is logged in?
916 if (($userid == '0') && (isMember())) {
917 // Then use this userid
918 $userid = getMemberId();
919 } elseif ($userid == '0') {
921 return (getConfig('surfbar_max_order') + 1);
924 // Default is all URLs
927 // Is the status set?
928 if (is_array($status)) {
929 // Only URLs with these status
930 $add = sprintf(" AND `url_status` IN('%s')", implode("','", $status));
931 } elseif (!empty($status)) {
932 // Only URLs with this status
933 $add = sprintf(" AND `url_status`='%s'", $status);
934 } elseif (is_array($exclude)) {
935 // Exclude URLs with these status
936 $add = sprintf(" AND `url_status` NOT IN('%s')", implode("','", $exclude));
937 } elseif (!empty($exclude)) {
938 // Exclude URLs with this status
939 $add = sprintf(" AND `url_status` != '%s'", $exclude);
942 // Get amount from database
943 $count = countSumTotalData($userid, 'surfbar_urls', 'url_id', 'url_userid', true, $add);
949 // Generate a validation code for the given id number
950 function SURFBAR_GENERATE_VALIDATION_CODE ($urlId, $salt = '') {
951 // @TODO Invalid salt should be refused
952 $GLOBALS['surfbar_cache']['salt'] = 'INVALID';
954 // Get code length from config
955 $length = getCodeLength();
958 if ($length == '0') $length = 10;
960 // Generate a code until the length matches
962 while (strlen($valCode) != $length) {
965 // Generate random hashed string
966 $GLOBALS['surfbar_cache']['salt'] = sha1(generatePassword(mt_rand(200, 255)));
967 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'newSalt='.SURFBAR_GET_SALT().'', false);
970 $GLOBALS['surfbar_cache']['salt'] = $salt;
971 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'oldSalt='.SURFBAR_GET_SALT().'', false);
974 // ... and now the validation code
975 $valCode = generateRandomCode($length, sha1(SURFBAR_GET_SALT().':'.$urlId), getMemberId());
976 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'valCode='.valCode.'', false);
979 // Hash it with md5() and salt it with the random string
980 $hashedCode = generateHash(md5($valCode), SURFBAR_GET_SALT());
982 // Finally encrypt it PGP-like and return it
983 $valHashedCode = encodeHashForCookie($hashedCode);
985 // Return hashed value
986 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'finalValCode='.$valHashedCode.'', false);
987 return $valHashedCode;
990 // Check validation code
991 function SURFBAR_CHECK_VALIDATION_CODE ($urlId, $check, $salt) {
993 $urlId = bigintval($urlId);
995 // Now generate the code again
996 $code = SURFBAR_GENERATE_VALIDATION_CODE($urlId, $salt);
998 // Return result of checking hashes and salts
999 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, '---'.$code.'|'.$check.'---', false);
1000 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, '+++'.$salt.'|'.SURFBAR_GET_DATA('salts_last_salt').'+++', false);
1001 return (($code == $check) && ($salt == SURFBAR_GET_DATA('salts_last_salt')));
1004 // Lockdown the userid/id combination (reload lock)
1005 function SURFBAR_LOCKDOWN_ID ($urlId) {
1006 //* DEBUG: */ debugOutput('LOCK!');
1007 ///* DEBUG: */ return;
1008 // Just add it to the database
1009 SQL_QUERY_ESC("INSERT INTO `{?_MYSQL_PREFIX?}_surfbar_locks` (`locks_userid`, `locks_url_id`) VALUES (%s, %s)",
1010 array(getMemberId(), bigintval($urlId)), __FUNCTION__, __LINE__);
1012 // Remove the salt from database
1013 SQL_QUERY_ESC("DELETE LOW_PRIORITY FROM `{?_MYSQL_PREFIX?}_surfbar_salts` WHERE `salts_url_id`=%s AND `salts_userid`=%s LIMIT 1",
1014 array(bigintval($urlId), getMemberId()), __FUNCTION__, __LINE__);
1017 // Pay points to the user and remove it from the sender if userid is given else it is a "sponsored surf"
1018 function SURFBAR_PAY_POINTS () {
1019 // Remove it from the URL owner
1020 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'userid='.SURFBAR_GET_USERID().',costs='.SURFBAR_GET_COSTS().'', false);
1021 if (isValidUserId(SURFBAR_GET_USERID())) {
1022 subtractPoints(sprintf("surfbar_%s", getConfig('surfbar_pay_model')), SURFBAR_GET_USERID(), SURFBAR_GET_COSTS());
1025 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'userid='.getMemberId().',reward='.SURFBAR_GET_REWARD().'', false);
1026 // @TODO Try to rewrite the following unset()
1027 unset($GLOBALS['ref_level']);
1029 // Book it to the user
1030 addPointsThroughReferalSystem(sprintf("surfbar_%s", getConfig('surfbar_pay_model')), getMemberId(), SURFBAR_GET_REWARD());
1033 // Updates the statistics of current URL/userid
1034 function SURFBAR_UPDATE_INSERT_STATS_RECORD () {
1038 // Get allowed views
1039 $allowed = SURFBAR_GET_VIEWS_ALLOWED();
1041 // Do we have a limit?
1043 // Then count views_max down!
1044 $add .= ", `views_max`=`views_max`-1";
1048 SQL_QUERY_ESC("UPDATE `{?_MYSQL_PREFIX?}_surfbar_urls` SET `url_views_total`=`url_views_total`+1".$add." WHERE `url_id`=%s LIMIT 1",
1049 array(SURFBAR_GET_ID()), __FUNCTION__, __LINE__);
1051 // Update the stats entry
1052 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",
1056 ), __FUNCTION__, __LINE__);
1058 // Was that update okay?
1059 if (SQL_HASZEROAFFECTED()) {
1060 // No, then insert entry
1061 SQL_QUERY_ESC("INSERT INTO `{?_MYSQL_PREFIX?}_surfbar_stats` (`stats_userid`, `stats_url_id`, `stats_count`) VALUES (%s,%s,1)",
1065 ), __FUNCTION__, __LINE__);
1068 // Update total/daily/weekly/monthly counter
1069 incrementConfigEntry('surfbar_total_counter');
1070 incrementConfigEntry('surfbar_daily_counter');
1071 incrementConfigEntry('surfbar_weekly_counter');
1072 incrementConfigEntry('surfbar_monthly_counter');
1074 // Update config as well
1075 updateConfiguration(array('surfbar_total_counter', 'surfbar_daily_counter', 'surfbar_weekly_counter', 'surfbar_monthly_counter'), array(1,1,1,1), '+');
1078 // Update the salt for validation and statistics
1079 function SURFBAR_UPDATE_SALT_STATS () {
1080 // Update statistics record
1081 SURFBAR_UPDATE_INSERT_STATS_RECORD();
1084 SURFBAR_GENERATE_VALIDATION_CODE(SURFBAR_GET_ID());
1086 // Simply store the salt from cache away in database...
1087 SQL_QUERY_ESC("UPDATE `{?_MYSQL_PREFIX?}_surfbar_salts` SET `salts_last_salt`='%s' WHERE `salts_url_id`=%s AND `salts_userid`=%s LIMIT 1",
1092 ), __FUNCTION__, __LINE__);
1095 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'salt='.SURFBAR_GET_SALT().',id='.SURFBAR_GET_ID().',userid='.getMemberId().'', false);
1098 if (SQL_HASZEROAFFECTED()) {
1099 // Insert missing entry!
1100 SQL_QUERY_ESC("INSERT INTO `{?_MYSQL_PREFIX?}_surfbar_salts` (`salts_url_id`, `salts_userid`, `salts_last_salt`) VALUES (%s, %s, '%s')",
1101 array(SURFBAR_GET_ID(), getMemberId(), SURFBAR_GET_SALT()), __FUNCTION__, __LINE__);
1105 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'affectedRows='.SQL_AFFECTEDROWS().'', false);
1107 // Return if the update was okay
1108 return (!SQL_HASZEROAFFECTED());
1111 // Check if the reload lock is active for given id
1112 function SURFBAR_CHECK_RELOAD_LOCK ($urlId) {
1113 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'id=' . $urlId . '', false);
1115 $result = SQL_QUERY_ESC("SELECT COUNT(`locks_id`) AS cnt
1117 `{?_MYSQL_PREFIX?}_surfbar_locks`
1119 `locks_userid`=%s AND
1120 `locks_url_id`=%s AND
1121 (UNIX_TIMESTAMP() - ".SURFBAR_GET_SURF_LOCK().") < UNIX_TIMESTAMP(`locks_last_surfed`)
1123 `locks_last_surfed` ASC
1125 array(getMemberId(), bigintval($urlId)), __FUNCTION__, __LINE__
1129 list($count) = SQL_FETCHROW($result);
1132 SQL_FREERESULT($result);
1135 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'cnt=' . $count . ',' . SURFBAR_GET_SURF_LOCK() . '', false);
1136 return ($count == 1);
1139 // Determine which user hash no more points left
1140 function SURFBAR_DETERMINE_DEPLETED_USERIDS ($limit=0) {
1143 'url_userid' => array(),
1144 'points' => array(),
1145 'notified' => array(),
1148 // Do we have a current user id?
1149 if ((isMember()) && ($limit == '0')) {
1150 // Then add this as well
1151 $userids['url_userid'][getMemberId()] = getMemberId();
1152 $userids['points'][getMemberId()] = getTotalPoints(getMemberId());
1153 $userids['notified'][getMemberId()] = '0';
1155 // Get all userid except logged in one
1156 $result = SQL_QUERY_ESC("SELECT
1157 u.url_userid, UNIX_TIMESTAMP(d.surfbar_low_notified) AS notified
1159 `{?_MYSQL_PREFIX?}_surfbar_urls` AS u
1161 `{?_MYSQL_PREFIX?}_user_data` AS d
1163 u.url_userid=d.userid
1165 u.url_userid NOT IN (%s,0) AND u.url_status='ACTIVE'
1170 array(getMemberId()), __FUNCTION__, __LINE__);
1173 $result = SQL_QUERY("SELECT
1174 u.url_userid, UNIX_TIMESTAMP(d.surfbar_low_notified) AS notified
1176 `{?_MYSQL_PREFIX?}_surfbar_urls` AS u
1178 `{?_MYSQL_PREFIX?}_user_data` AS d
1180 u.url_userid=d.userid
1182 u.url_status='ACTIVE'
1186 u.url_userid ASC", __FUNCTION__, __LINE__);
1190 while ($content = SQL_FETCHARRAY($result)) {
1192 $points = getTotalPoints($content['url_userid']);
1193 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, "userid={$content['url_userid']},points={$points}", false);
1195 // Shall we add this to ignore?
1196 if ($points <= $limit) {
1198 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, "userid={$content['url_userid']} has depleted points amount!", false);
1199 $userids['url_userid'][$content['url_userid']] = $content['url_userid'];
1200 $userids['points'][$content['url_userid']] = $points;
1201 $userids['notified'][$content['url_userid']] = $content['notified'];
1206 SQL_FREERESULT($result);
1209 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, "UIDs::count=".count($userids)." (with own userid=".getMemberId().')', false);
1215 // Determine how many users are Online in surfbar
1216 function SURFBAR_DETERMINE_TOTAL_ONLINE () {
1217 // Count all users in surfbar modue and return the value
1218 $result = SQL_QUERY('SELECT
1221 `{?_MYSQL_PREFIX?}_surfbar_stats`
1223 (UNIX_TIMESTAMP() - UNIX_TIMESTAMP(`stats_last_surfed`)) <= {?online_timeout?}
1225 `stats_userid` ASC', __FUNCTION__, __LINE__);
1228 $count = SQL_NUMROWS($result);
1231 SQL_FREERESULT($result);
1237 // Determine waiting time for one URL
1238 function SURFBAR_DETERMINE_WAIT_TIME () {
1239 // Get fixed reload lock
1240 $fixed = SURFBAR_GET_FIXED_RELOAD();
1242 // Is the fixed reload time set?
1248 // Static time is default
1249 $time = getConfig('surfbar_static_time');
1251 // Which payment model do we have?
1252 if (getConfig('surfbar_pay_model') == 'DYNAMIC') {
1253 // "Calculate" dynamic time
1254 $time += SURFBAR_CALCULATE_DYNAMIC_ADD();
1261 // Changes the status of an URL from given to other
1262 function SURFBAR_CHANGE_STATUS ($urlId, $prevStatus, $newStatus, $data=array()) {
1263 // Make new status always lower-case
1264 $newStatus = strtolower($newStatus);
1266 // Get URL data for status comparison if missing
1267 if ((!is_array($data)) || (count($data) == 0)) {
1268 // Fetch missing URL data
1269 $data = SURFBAR_GET_URL_DATA($urlId);
1272 // Is the new status set?
1273 if ((!is_string($newStatus)) || (empty($newStatus))) {
1274 // Abort here, but fine!
1278 // Is the status like prevStatus is saying?
1279 if ($data[$urlId]['url_status'] != $prevStatus) {
1280 // No, then abort here
1285 // Update the status now
1286 // ---------- Comment out for debugging/developing member actions! ---------
1287 //SQL_QUERY_ESC("UPDATE `{?_MYSQL_PREFIX?}_surfbar_urls` SET `status`='%s' WHERE `url_id`=%s LIMIT 1",
1288 // array($newStatus, bigintval($urlId)), __FUNCTION__, __LINE__);
1289 // ---------- Comment out for debugging/developing member actions! ---------
1292 // ---------- Comment out for debugging/developing member actions! ---------
1293 //if (SQL_AFFECTEDROWS() != 1) {
1294 // // No, something went wrong
1297 // ---------- Comment out for debugging/developing member actions! ---------
1299 // Prepare content for notification routines
1300 $data[$urlId]['url_userid'] = $data[$urlId]['url_userid'];
1301 $data[$urlId]['frametester'] = '{%pipe,generateFrametesterUrl=' . $data[$urlId]['url'] . '%}';
1302 $data[$urlId]['reward'] = '{%config,translateComma=surfbar_static_reward%}';
1303 $data[$urlId]['costs'] = '{%config,translateComma=surfbar_static_costs%}';
1305 // Do some dirty fixing here:
1306 if (($data[$urlId]['url_status'] == 'STOPPED') && ($newStatus == 'pending')) {
1307 // Fix for template change
1308 $newStatus = 'continued';
1311 // Send admin notification
1312 SURFBAR_NOTIFY_ADMIN('url_' . $data[$urlId]['url_status'] . '_' . $newStatus, $data[$urlId]);
1314 // Send user notification
1315 SURFBAR_NOTIFY_USER('url_' . $data[$urlId]['url_status'] . '_' . $newStatus, $data[$urlId]);
1321 // Calculate minimum value for dynamic payment model
1322 function SURFBAR_CALCULATE_DYNAMIC_MIN_VALUE () {
1323 // Addon is zero by default
1327 $percent = abs(log(getConfig('surfbar_dynamic_percent') / 100 + 1));
1330 $totalUsers = getTotalConfirmedUser();
1333 $onlineUsers = SURFBAR_DETERMINE_TOTAL_ONLINE();
1336 $addon += abs(log($onlineUsers / $totalUsers + 1) * $percent * $totalUsers);
1339 $totalUrls = SURFBAR_GET_TOTAL_URLS('ACTIVE', 0);
1341 // Get user's total URLs
1342 $userUrls = SURFBAR_GET_TOTAL_USER_URLS(0, 'ACTIVE');
1345 if ($totalUrls > 0) {
1346 $addon += abs(log($userUrls / $totalUrls + 1) * $percent * $totalUrls);
1348 $addon += abs(log($userUrls / 1 + 1) * $percent * $totalUrls);
1355 // Calculate maximum value for dynamic payment model
1356 function SURFBAR_CALCULATE_DYNAMIC_MAX_VALUE () {
1357 // Addon is zero by default
1364 $percent = abs(log(getConfig('surfbar_dynamic_percent') / 100 + 1));
1367 $totalUsers = getTotalConfirmedUser();
1370 $addon += abs($max * $percent * $totalUsers);
1373 $totalUrls = SURFBAR_GET_TOTAL_URLS('ACTIVE', 0);
1376 $addon += abs($max * $percent * $totalUrls);
1382 // Calculate dynamic lock
1383 function SURFBAR_CALCULATE_DYNAMIC_LOCK () {
1384 // Default lock is 30 seconds
1388 $onlineUsers = SURFBAR_DETERMINE_TOTAL_ONLINE();
1391 $addon = abs(log($onlineUsers / $addon + 1));
1397 // "Getter" for lock ids array
1398 function SURFBAR_GET_LOCK_IDS () {
1399 // Prepare some arrays
1404 // Get all id from locks within the timestamp
1405 $result = SQL_QUERY_ESC("SELECT `locks_id`, `locks_url_id`, UNIX_TIMESTAMP(`locks_last_surfed`) AS last_surfed
1407 `{?_MYSQL_PREFIX?}_surfbar_locks`
1411 `locks_id` ASC", array(getMemberId()),
1412 __FUNCTION__, __LINE__);
1415 while ($content = SQL_FETCHARRAY($result)) {
1417 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'next - lid='.$content['id'].',url='.$content['url_id'].',rest='.(time() - $content['last_surfed']).'/'.SURFBAR_GET_SURF_LOCK().'', false);
1419 // Skip entries that are too old
1420 if (($content['last_surfed'] > (time() - SURFBAR_GET_SURF_LOCK())) && (!in_array($content['url_id'], $ignored))) {
1422 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'okay - lid='.$content['id'].',url='.$content['url_id'].',last='.$content['last_surfed'].'', false);
1424 // Add only if missing or bigger
1425 if ((!isset($IDs[$content['url_id']])) || ($IDs[$content['url_id']] > $content['last_surfed'])) {
1427 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'ADD - lid='.$content['id'].',url='.$content['url_id'].',last='.$content['last_surfed'].'', false);
1430 $IDs[$content['url_id']] = $content['last_surfed'];
1431 $USE[$content['url_id']] = $content['id'];
1435 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'ignore - lid='.$content['id'].',url='.$content['url_id'].',last='.$content['last_surfed'].'', false);
1437 // Ignore these old entries!
1438 $ignored[] = $content['url_id'];
1439 unset($IDs[$content['url_id']]);
1440 unset($USE[$content['url_id']]);
1445 SQL_FREERESULT($result);
1451 // "Getter" for maximum random number
1452 function SURFBAR_GET_MAX_RANDOM ($userids, $add) {
1453 // Count max availabe entries
1454 $result = SQL_QUERY("SELECT
1457 `{?_MYSQL_PREFIX?}_surfbar_urls` AS sbu
1459 `{?_MYSQL_PREFIX?}_surfbar_salts` AS sbs
1461 sbu.url_id=sbs.salts_url_id
1463 `{?_MYSQL_PREFIX?}_surfbar_locks` AS l
1465 sbu.url_id=l.locks_url_id
1467 sbu.url_userid NOT IN (" . implode(',', $userids) . ") AND
1468 (sbu.url_views_allowed=0 OR (sbu.url_views_allowed > 0 AND sbu.url_views_max > 0)) AND
1469 sbu.url_status='ACTIVE'
1472 sbu.url_id ASC", __FUNCTION__, __LINE__);
1475 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'lastQuery='.getConfig('db_last_query').'|numRows='.SQL_NUMROWS($result).'|Affected='.SQL_AFFECTEDROWS().'', false);
1478 $maxRand = SQL_NUMROWS($result);
1481 SQL_FREERESULT($result);
1487 // Load all URLs of the current user and return it as an array
1488 function SURFBAR_GET_USER_URLS () {
1490 $urlArray = array();
1493 $result = SQL_QUERY_ESC("SELECT
1500 u.url_views_allowed,
1501 UNIX_TIMESTAMP(u.url_registered) AS `url_registered`,
1502 UNIX_TIMESTAMP(u.url_last_locked) AS `url_last_locked`,
1505 `{?_MYSQL_PREFIX?}_surfbar_urls` AS u
1508 u.url_status != 'DELETED'
1511 array(getMemberId()), __FUNCTION__, __LINE__);
1513 // Are there entries?
1514 if (!SQL_HASZERONUMS($result)) {
1516 while ($row = SQL_FETCHARRAY($result)) {
1518 $urlArray[$row['id']] = $row;
1523 SQL_FREERESULT($result);
1529 // "Getter" for member action array for given status
1530 function SURFBAR_GET_ARRAY_FROM_STATUS ($status) {
1532 $returnArray = array();
1534 // Get all assigned actions
1535 $result = SQL_QUERY_ESC("SELECT `action` FROM `{?_MYSQL_PREFIX?}_surfbar_actions` WHERE `actions_status`='%s' ORDER BY `actions_id` ASC",
1536 array($status), __FUNCTION__, __LINE__);
1538 // Some entries there?
1539 if (!SQL_HASZERONUMS($result)) {
1541 // @TODO This can be somehow rewritten
1542 while ($content = SQL_FETCHARRAY($result)) {
1543 $returnArray[] = $content['action'];
1548 SQL_FREERESULT($result);
1551 return $returnArray;
1554 // Reload to configured stop page
1555 function SURFBAR_RELOAD_TO_STOP_PAGE ($page = 'stop') {
1556 // Internal or external?
1557 if ((getConfig('surfbar_pause_mode') == 'INTERNAL') || (getConfig('surfbar_pause_url') == '')) {
1558 // Reload to internal page
1559 redirectToUrl('surfbar.php?frame=' . $page);
1561 // Reload to external page
1562 redirectToConfiguredUrl('surfbar_pause_url');
1566 // Determine next id for surfbar or get data for given id, always call this before you call other
1567 // getters below this function!
1568 function SURFBAR_DETERMINE_NEXT_ID ($urlId = '0') {
1569 // Default is no id and no random number
1574 if ($urlId == '0') {
1575 // Get array with lock ids
1576 $USE = SURFBAR_GET_LOCK_IDS();
1578 // Shall we add some URL ids to ignore?
1580 if (count($USE) > 0) {
1582 $add = " AND sbu.url_id NOT IN (";
1583 foreach ($USE as $url_id => $lid) {
1585 $add .= $url_id.',';
1588 // Add closing bracket
1589 $add = substr($add, 0, -1) . ')';
1592 // Determine depleted user account
1593 $userids = SURFBAR_DETERMINE_DEPLETED_USERIDS();
1595 // Get maximum randomness factor
1596 $maxRand = SURFBAR_GET_MAX_RANDOM($userids['url_userid'], $add);
1598 // If more than one URL can be called generate the random number!
1600 // Generate random number
1601 $randNum = mt_rand(0, ($maxRand - 1));
1604 // And query the database
1605 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'randNum='.$randNum.',maxRand='.$maxRand.',surfLock='.SURFBAR_GET_SURF_LOCK().'', false);
1606 $result = SQL_QUERY_ESC("SELECT
1610 sbs.salts_last_salt,
1611 sbu.url_views_total,
1613 sbu.url_views_allowed,
1614 UNIX_TIMESTAMP(l.locks_last_surfed) AS last_surfed,
1615 sbu.url_fixed_reload
1617 `{?_MYSQL_PREFIX?}_surfbar_urls` AS sbu
1619 `{?_MYSQL_PREFIX?}_surfbar_salts` AS sbs
1621 sbu.url_id=sbs.salts_url_id
1623 `{?_MYSQL_PREFIX?}_surfbar_locks` AS l
1625 sbu.url_id=l.locks_url_id
1627 sbu.url_userid NOT IN (".implode(',', $userids['url_userid']).") AND
1628 sbu.url_status='ACTIVE' AND
1629 (sbu.url_views_allowed=0 OR (sbu.url_views_allowed > 0 AND sbu.url_views_max > 0))
1634 l.locks_last_surfed ASC,
1637 array($randNum), __FUNCTION__, __LINE__
1640 // Get data from specified id number
1641 $result = SQL_QUERY_ESC("SELECT
1645 sbs.salts_last_salt,
1646 sbu.url_views_total,
1648 sbu.url_views_allowed,
1649 UNIX_TIMESTAMP(l.locks_last_surfed) AS last_surfed,
1650 sbu.url_fixed_reload
1652 `{?_MYSQL_PREFIX?}_surfbar_urls` AS sbu
1654 `{?_MYSQL_PREFIX?}_surfbar_salts` AS sbs
1656 sbu.url_id=sbs.salts_url_id
1658 `{?_MYSQL_PREFIX?}_surfbar_locks` AS l
1660 sbu.url_id=l.locks_url_id
1662 sbu.url_userid != %s AND
1663 sbu.url_status='ACTIVE' AND
1665 (sbu.url_views_allowed=0 OR (sbu.url_views_allowed > 0 AND sbu.url_views_max > 0))
1667 array(getMemberId(), bigintval($urlId)), __FUNCTION__, __LINE__
1671 // Is there an id number?
1672 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'lastQuery='.getConfig('db_last_query').'|numRows='.SQL_NUMROWS($result).'|Affected='.SQL_AFFECTEDROWS().'', false);
1673 if (SQL_NUMROWS($result) == 1) {
1675 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'count('.count($GLOBALS['surfbar_cache']).') - BEFORE', false);
1676 $GLOBALS['surfbar_cache'] = merge_array($GLOBALS['surfbar_cache'], SQL_FETCHARRAY($result));
1677 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'count('.count($GLOBALS['surfbar_cache']).') - AFTER', false);
1679 // Determine waiting time
1680 $GLOBALS['surfbar_cache']['time'] = SURFBAR_DETERMINE_WAIT_TIME();
1682 // Is the last salt there?
1683 if (is_null($GLOBALS['surfbar_cache']['salts_last_salt'])) {
1684 // Then repair it wit the static!
1685 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'last_salt - FIXED!', false);
1686 $GLOBALS['surfbar_cache']['salts_last_salt'] = '';
1689 // Fix missing last_surfed
1690 if ((!isset($GLOBALS['surfbar_cache']['last_surfed'])) || (is_null($GLOBALS['surfbar_cache']['last_surfed']))) {
1692 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'last_surfed - FIXED!', false);
1693 $GLOBALS['surfbar_cache']['last_surfed'] = '0';
1696 // Get base/fixed reward and costs
1697 $GLOBALS['surfbar_cache']['reward'] = SURFBAR_DETERMINE_REWARD();
1698 $GLOBALS['surfbar_cache']['costs'] = SURFBAR_DETERMINE_COSTS();
1699 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'BASE/STATIC - reward='.SURFBAR_GET_REWARD().'|costs='.SURFBAR_GET_COSTS().'', false);
1701 // Only in dynamic model add the dynamic bonus!
1702 if (getConfig('surfbar_pay_model') == 'DYNAMIC') {
1703 // Calculate dynamic reward/costs and add it
1704 $GLOBALS['surfbar_cache']['reward'] += SURFBAR_CALCULATE_DYNAMIC_ADD();
1705 $GLOBALS['surfbar_cache']['costs'] += SURFBAR_CALCULATE_DYNAMIC_ADD();
1706 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'DYNAMIC+ - reward='.SURFBAR_GET_REWARD().'|costs='.SURFBAR_GET_COSTS().'', false);
1710 $nextId = SURFBAR_GET_ID();
1714 SQL_FREERESULT($result);
1717 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'nextId='.$nextId.'', false);
1721 // ----------------------------------------------------------------------------
1723 // ----------------------------------------------------------------------------
1725 // "Getter" for surfbar_dynamic_percent
1726 function getSurfbarDynamicPercent () {
1727 // Do we have cache?
1728 if (!isset($GLOBALS['surfbar_dynamic_percent'])) {
1730 $GLOBALS['surfbar_dynamic_percent'] = getConfig('surfbar_dynamic_percent');
1734 return $GLOBALS['surfbar_dynamic_percent'];
1737 // "Getter" for surfbar_static_reward
1738 function getSurfbarStaticReward () {
1739 // Do we have cache?
1740 if (!isset($GLOBALS['surfbar_static_reward'])) {
1742 $GLOBALS['surfbar_static_reward'] = getConfig('surfbar_static_reward');
1746 return $GLOBALS['surfbar_static_reward'];
1749 // "Getter" for surfbar_static_time
1750 function getSurfbarStaticTime () {
1751 // Do we have cache?
1752 if (!isset($GLOBALS['surfbar_static_time'])) {
1754 $GLOBALS['surfbar_static_time'] = getConfig('surfbar_static_time');
1758 return $GLOBALS['surfbar_static_time'];
1761 // "Getter" for surfbar_max_order
1762 function getSurfbarMaxOrder () {
1763 // Do we have cache?
1764 if (!isset($GLOBALS['surfbar_max_order'])) {
1766 $GLOBALS['surfbar_max_order'] = getConfig('surfbar_max_order');
1770 return $GLOBALS['surfbar_max_order'];
1773 // -----------------------------------------------------------------------------
1774 // PLEASE DO NOT ADD ANY OTHER FUNCTIONS BELOW THIS LINE IF THEY DON'T "WRAP"
1775 // THE $GLOBALS['surfbar_cache'] ARRAY!
1776 // -----------------------------------------------------------------------------
1778 // Initializes the surfbar
1779 function SURFBAR_INIT () {
1781 $GLOBALS['surfbar_cache'] = array();
1784 // Private getter for data elements
1785 function SURFBAR_GET_DATA ($element) {
1786 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, "element={$element}", false);
1791 // Is the entry there?
1792 if (isset($GLOBALS['surfbar_cache'][$element])) {
1794 $data = $GLOBALS['surfbar_cache'][$element];
1795 } else { // END - if
1797 print_r($GLOBALS['surfbar_cache']);
1799 debug_report_bug(__FUNCTION__, __LINE__, 'Element ' . $element . ' not found.');
1803 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'element[' . $element . ']=[' . gettype($data) . ']' . $data, false);
1807 // Getter for reward from cache
1808 function SURFBAR_GET_REWARD () {
1809 // Get data element and return its contents
1810 return SURFBAR_GET_DATA('reward');
1813 // Getter for costs from cache
1814 function SURFBAR_GET_COSTS () {
1815 // Get data element and return its contents
1816 return SURFBAR_GET_DATA('costs');
1819 // Getter for URL from cache
1820 function SURFBAR_GET_URL () {
1821 // Get data element and return its contents
1822 return SURFBAR_GET_DATA('url');
1825 // Getter for salt from cache
1826 function SURFBAR_GET_SALT () {
1827 // Get data element and return its contents
1828 return SURFBAR_GET_DATA('salt');
1831 // Getter for id from cache
1832 function SURFBAR_GET_ID () {
1833 // Get data element and return its contents
1834 return SURFBAR_GET_DATA('url_id');
1837 // Getter for userid from cache
1838 function SURFBAR_GET_USERID () {
1839 // Get data element and return its contents
1840 return SURFBAR_GET_DATA('url_userid');
1843 // Getter for user reload locks
1844 function SURFBAR_GET_USER_LOCKS () {
1845 // Get data element and return its contents
1846 return SURFBAR_GET_DATA('user_locks');
1849 // Getter for reload time
1850 function SURFBAR_GET_RELOAD_TIME () {
1851 // Get data element and return its contents
1852 return SURFBAR_GET_DATA('time');
1855 // Getter for allowed views
1856 function SURFBAR_GET_VIEWS_ALLOWED () {
1857 // Get data element and return its contents
1858 return SURFBAR_GET_DATA('url_views_allowed');
1861 // Getter for maximum views
1862 function SURFBAR_GET_VIEWS_MAX () {
1863 // Get data element and return its contents
1864 return SURFBAR_GET_DATA('url_views_max');
1867 // Getter for fixed reload
1868 function SURFBAR_GET_FIXED_RELOAD () {
1869 // Get data element and return its contents
1870 return SURFBAR_GET_DATA('url_fixed_reload');
1873 // Getter for surf lock
1874 function SURFBAR_GET_SURF_LOCK () {
1875 // Get data element and return its contents
1876 return SURFBAR_GET_DATA('surf_lock');
1879 // Getter for new status
1880 function SURFBAR_GET_NEW_STATUS () {
1881 // Get data element and return its contents
1882 return SURFBAR_GET_DATA('new_status');