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 - 2011 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 'url_id' => bigintval($urlId),
202 'action' => strtolower($action)
214 // Do the member form request
215 function SURFBAR_MEMBER_DO_FORM ($formData, $urlArray) {
216 // By default no action is performed
223 } elseif ((!isset($formData['id'])) || (!isset($formData['action']))) {
224 // Important form elements are missing!
226 } elseif (!isset($urlArray[$formData['id']])) {
227 // id not found in cache
229 } elseif (!SURFBAR_VALIDATE_MEMBER_ACTION_STATUS($formData['action'], $urlArray[$formData['id']]['url_status'])) {
230 // Action not allowed for current URL status
235 $action = secureString($formData['action']);
238 if ($action != $formData['action']) {
239 // Invalid data in action found
243 // Create the function name for selected action
244 $functionName = sprintf("SURFBAR_MEMBER_%s_ACTION", strtoupper($action));
246 // Is the function there?
247 if (function_exists($functionName)) {
249 $urlArray[$formData['id']]['new_status'] = SURFBAR_GET_NEW_STATUS('new_status');
251 // Extract URL data for call-back
252 $urlData = array(merge_array($urlArray[$formData['id']], array($action => $formData)));
254 // Action found so execute it
255 $performed = call_user_func_array($functionName, $urlData);
257 // Log invalid request
258 logDebugMessage(__FUNCTION__, __LINE__, "action={$formData['action']},id={$formData['id']},function={$functionName}");
259 addFatalMessage(__FUNCTION__, __LINE__, "Invalid member action! action=%s,id=%s,function=%s", array($formData['action'], $formData['id'], $functionName));
266 // Validate if the requested action can be performed on current URL status
267 function SURFBAR_VALIDATE_MEMBER_ACTION_STATUS ($action, $status) {
268 // Search for the requested action/status combination in database
269 $result = SQL_QUERY_ESC("SELECT `actions_new_status` FROM `{?_MYSQL_PREFIX?}_surfbar_actions` WHERE `actions_action`='%s' AND `actions_status`='%s' LIMIT 1",
270 array($action, $status), __FUNCTION__, __LINE__);
272 // Is the entry there?
273 $isValid = (SQL_NUMROWS($result) == 1);
275 // Fetch the new status if found
278 list($GLOBALS['surfbar_cache']['new_status']) = SQL_FETCHROW($result);
282 SQL_FREERESULT($result);
289 //------------------------------------------------------------------------------
291 //------------------------------------------------------------------------------
293 // Retreat a booked URL
294 function SURFBAR_MEMBER_RETREAT_ACTION ($urlData) {
295 // Create the data array for next function call
297 $urlData['id'] => $urlData
300 // Simply change the status here
301 return SURFBAR_CHANGE_STATUS ($urlData['id'], $urlData['url_status'], $urlData['new_status'], $data);
304 // Book an URL now (from migration)
305 function SURFBAR_MEMBER_BOOKNOW_ACTION ($urlData) {
306 // Create the data array for next function call
308 $urlData['id'] => $urlData
311 // Simply change the status here
312 return SURFBAR_CHANGE_STATUS ($urlData['id'], $urlData['url_status'], $urlData['new_status'], $data);
315 // Show edit form or do the changes
316 function SURFBAR_MEMBER_EDIT_ACTION ($urlData) {
317 // Is the "execute" flag there?
318 if (isset($urlData['edit']['execute'])) {
319 // Execute the changes
320 return SURFBAR_MEMBER_EXECUTE_ACTION('edit', $urlData);
324 return SURFBAR_MEMBER_DISPLAY_ACTION_FORM('edit', $urlData);
327 // Show delete form or do the changes
328 function SURFBAR_MEMBER_DELETE_ACTION ($urlData) {
329 // Is the "execute" flag there?
330 if (isset($urlData['delete']['execute'])) {
331 // Execute the changes
332 return SURFBAR_MEMBER_EXECUTE_ACTION('delete', $urlData);
336 return SURFBAR_MEMBER_DISPLAY_ACTION_FORM('delete', $urlData);
339 // Pause active banner
340 function SURFBAR_MEMBER_PAUSE_ACTION ($urlData) {
341 return SURFBAR_CHANGE_STATUS($urlData['id'], $urlData['url_status'], $urlData['new_status'], array($urlData['id'] => $urlData));
344 // Unpause stopped banner
345 function SURFBAR_MEMBER_UNPAUSE_ACTION ($urlData) {
346 // Fix missing entry for template
347 $urlData['edit'] = $urlData['unpause'];
348 $urlData['edit']['url'] = $urlData['url'];
349 $urlData['edit']['limit'] = SURFBAR_GET_VIEWS_MAX();
351 // Return status change
352 return SURFBAR_CHANGE_STATUS($urlData['id'], $urlData['url_status'], $urlData['new_status'], array($urlData['id'] => $urlData));
355 // Resubmit locked URL
356 function SURFBAR_MEMBER_RESUBMIT_ACTION ($urlData) {
357 return SURFBAR_CHANGE_STATUS($urlData['id'], $urlData['url_status'], $urlData['new_status'], array($urlData['id'] => $urlData));
360 // Display selected "action form"
361 function SURFBAR_MEMBER_DISPLAY_ACTION_FORM ($action, $urlData) {
362 // Translate some data if present
363 $content = SURFBAR_PREPARE_CONTENT_FOR_TEMPLATE($content);
365 // Include fields only for action 'edit'
366 if ($action == 'edit') {
367 // Default is not limited
368 $urlData['limited_yes'] = '';
369 $urlData['limited_no'] = ' checked="checked"';
370 $urlData['limited'] = 'false';
372 // Is this URL limited?
373 if (SURFBAR_GET_VIEWS_MAX() > 0) {
374 // Then rewrite form data
375 $urlData['limited_yes'] = ' checked="checked"';
376 $urlData['limited_no'] = '';
377 $urlData['limited'] = 'true';
381 // Load the form and display it
382 loadTemplate(sprintf("member_surfbar_%s_action_form", $action), false, $urlData);
384 // All fine by default ... ;-)
388 // Execute choosen action
389 function SURFBAR_MEMBER_EXECUTE_ACTION ($action, $urlData) {
390 // By default nothing is executed
393 // Is limitation "no" and "limit" is > 0?
394 if ((isset($urlData[$action]['limited'])) && ($urlData[$action]['limited'] != 'Y') && ((isset($urlData[$action]['limit'])) && ($urlData[$action]['limit'] > 0)) || (!isset($urlData[$action]['limit']))) {
395 // Set it to unlimited
396 $urlData[$action]['limit'] = '0';
399 // Construct function name
400 $functionName = sprintf("SURFBAR_MEMBER_EXECUTE_%s_ACTION", strtoupper($action));
402 // Is that function there?
403 if (function_exists($functionName)) {
404 // Execute the function
405 if (call_user_func_array($functionName, array($urlData)) == true) {
406 // Update status as well
407 $executed = SURFBAR_CHANGE_STATUS($urlData['id'], $urlData['url_status'], $urlData['new_status'], array($urlData['id'] => $urlData));
411 addFatalMessage(__FUNCTION__, __LINE__, '{--MEMBER_SURFBAR_EXECUTE_ACTION_404--}', $functionName);
417 // "Execute edit" function: Update changed data
418 function SURFBAR_MEMBER_EXECUTE_EDIT_ACTION ($urlData) {
419 // Default is nothing done
422 // Has the URL or limit changed?
424 //if (($urlData['url_views_allowed'] != $urlData['edit']['limit']) || ($url1 != $url2)) {
426 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",
427 array($urlData['url'], $urlData['edit']['limit'], $urlData['edit']['limit'], $urlData['id'], $urlData['url_status']), __FUNCTION__, __LINE__);
436 // "Execute delete" function: Does nothing...
437 function SURFBAR_MEMBER_EXECUTE_DELETE_ACTION ($urlData) {
438 // Nothing special to do (see above function for such "special actions" to perform)
442 //------------------------------------------------------------------------------
443 // Self-maintenance functions
444 //------------------------------------------------------------------------------
447 function SURFBAR_HANDLE_SELF_MAINTENANCE () {
448 // Handle URLs which limit has depleted so we can stop them
449 SURFBAR_HANDLE_DEPLETED_VIEWS();
451 // Handle low-points amounts
452 SURFBAR_HANDLE_LOW_POINTS();
455 // Handle URLs which limit has depleted
456 function SURFBAR_HANDLE_DEPLETED_VIEWS () {
458 $urlArray = SURFBAR_GET_URL_DATA(0, 'url_views_max', 'url_id', 'ASC', 'url_id', " AND `url_views_allowed` > 0 AND `url_status`='ACTIVE'");
460 // Do we have some entries?
461 if (count($urlArray) > 0) {
463 foreach ($urlArray as $id => $urlData) {
467 // Rewrite array for next call
473 SURFBAR_CHANGE_STATUS($id, 'ACTIVE', 'DEPLETED', $urlData);
478 // Alert users which have URLs booked and are low on points amount
479 function SURFBAR_HANDLE_LOW_POINTS () {
481 $userids = SURFBAR_DETERMINE_DEPLETED_USERIDS(getConfig('surfbar_warn_low_points'));
483 // "Walk" through all URLs
484 foreach ($userids['url_userid'] as $userid => $dummy) {
485 // Is the last notification far enougth away to notify again?
486 if ((time() - $userids['notified'][$userid]) >= getConfig('surfbar_low_interval')) {
489 'url_userid' => $userid,
490 'points' => $userids['points'][$userid],
491 'notified' => $userids['notified'][$userid]
495 SURFBAR_NOTIFY_USER('low_points', $content);
497 // Update last notified
498 SQL_QUERY_ESC("UPDATE `{?_MYSQL_PREFIX?}_user_data` SET `surfbar_low_notified`=NOW() WHERE `userid`=%s LIMIT 1",
499 array($userid), __FUNCTION__, __LINE__);
505 //------------------------------------------------------------------------------
507 //------------------------------------------------------------------------------
510 // Looks up by an URL
511 function SURFBAR_LOOKUP_BY_URL ($url, $userid) {
512 // Now lookup that given URL by itself
513 $urlArray = SURFBAR_GET_URL_DATA($url, 'url', 'url_id', 'ASC', 'url_id', sprintf(" AND `url_userid`=%s", bigintval($userid)));
516 return (count($urlArray) > 0);
519 // Load URL data by given search term and column
520 function SURFBAR_GET_URL_DATA ($searchTerm, $column = 'url_id', $order = 'url_id', $sort = 'ASC', $group = 'url_id', $add = '') {
521 // By default nothing is found
522 $GLOBALS['last_url_data'] = array();
524 // Is the column an id number?
525 if (($column == 'url_id') || ($column == 'url_userid')) {
526 // Extra secure input
527 $searchTerm = bigintval($searchTerm);
530 // If the column is 'id' there can be only one entry
532 if ($column == 'id') {
536 // Look up the record
537 $result = SQL_QUERY_ESC("SELECT
545 UNIX_TIMESTAMP(`url_registered`) AS `url_registered`,
546 UNIX_TIMESTAMP(`url_last_locked`) AS `url_last_locked`,
552 `{?_MYSQL_PREFIX?}_surfbar_urls`
554 `%s`='%s'" . $add . "
564 ), __FUNCTION__, __LINE__);
566 // Is there at least one record?
567 if (!SQL_HASZERONUMS($result)) {
569 while ($dataRow = SQL_FETCHARRAY($result)) {
570 // Shall we group these results?
571 if ($group == 'url_id') {
572 // Add the row by id as index
573 $GLOBALS['last_url_data'][$dataRow['url_id']] = $dataRow;
576 $GLOBALS['last_url_data'][$dataRow[$group]][$dataRow['url_id']] = $dataRow;
582 SQL_FREERESULT($result);
585 return $GLOBALS['last_url_data'];
588 // Registers an URL with the surfbar. You should have called SURFBAR_LOOKUP_BY_URL() first!
589 function SURFBAR_REGISTER_URL ($url, $userid, $status = 'PENDING', $addMode = 'reg', $extraFields = array()) {
590 // Make sure by the user registered URLs are always pending
591 if ($addMode == 'reg') {
596 $content = merge_array($extraFields, array(
598 'url_userid' => $userid,
599 'url_status' => $status,
602 // Is limit/reload set?
603 if (!isset($content['limit'])) {
604 $content['limit'] = '0';
606 if (!isset($content['reload'])) {
607 $content['reload'] = '0';
610 // Insert the URL into database
611 $content['insert_id'] = SURFBAR_INSERT_URL_BY_ARRAY($content);
614 if ($content['insert_id'] == '0') {
615 // INSERT did not insert any data!
619 // If in reg-mode we notify admin
620 if (($addMode == 'reg') || (getConfig('surfbar_notify_admin_unlock') == 'Y')) {
621 // Notify admin even when he as unlocked an email
622 SURFBAR_NOTIFY_ADMIN('url_' . $addMode, $content);
626 SURFBAR_NOTIFY_USER('url_' . $addMode, $content);
628 // Return the insert id
629 return $content['insert_id'];
632 // Inserts an url by given data array and return the insert id
633 function SURFBAR_INSERT_URL_BY_ARRAY ($urlData) {
635 $userid = bigintval($urlData['url_userid']);
638 if (empty($userid)) $userid = '0';
640 // Just run the insert query for now
641 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)",
645 $urlData['url_status'],
649 ), __FUNCTION__, __LINE__
653 return SQL_INSERTID();
656 // Notify admin(s) with a selected message and content
657 function SURFBAR_NOTIFY_ADMIN ($messageType, $content) {
658 // Prepare template name
659 $templateName = sprintf("admin_surfbar_%s", $messageType);
662 $subject = sprintf("{--ADMIN_SURFBAR_NOTIFY_%s_SUBJECT--}",
663 strtoupper($messageType)
666 // Is the subject line there?
667 if ((substr($subject, 0, 1) == '!') && (substr($subject, -1, 1) == '!')) {
668 // Set default subject if following eval() wents wrong
669 $subject = '{%message,ADMIN_SURFBAR_NOTIFY_DEFAULT_SUBJECT=' . strtoupper($messageType) . '%}';
672 // Translate some data if present
673 $content = SURFBAR_PREPARE_CONTENT_FOR_TEMPLATE($content);
675 // Send the notification out
676 return sendAdminNotification($subject, $templateName, $content, $content['url_userid']);
679 // Notify the user about the performed action
680 function SURFBAR_NOTIFY_USER ($messageType, $content) {
681 // Skip notification if userid is zero
682 if ($content['url_userid'] == '0') {
686 // Prepare template name
687 $templateName = sprintf("member_surfbar_%s", $messageType);
690 $subject = sprintf("{--MEMBER_SURFBAR_NOTIFY_%s_SUBJECT--}",
691 strtoupper($messageType)
694 // Is the subject line there?
695 if ((substr($subject, 0, 1) == '!') && (substr($subject, -1, 1) == '!')) {
696 // Set default subject if following eval() wents wrong
697 $subject = '{--MEMBER_SURFBAR_NOTIFY_DEFAULT_SUBJECT--}';
700 // Translate some data if present
701 $content = SURFBAR_PREPARE_CONTENT_FOR_TEMPLATE($content);
704 $mailText = loadEmailTemplate($templateName, $content, $content['url_userid']);
707 return sendEmail($content['url_userid'], $subject, $mailText);
710 // Translates some data for template usage
711 // @TODO Can't we use our new expression language instead of this ugly code?
712 function SURFBAR_PREPARE_CONTENT_FOR_TEMPLATE ($content) {
714 if (isset($content['url_registered'])) $content['url_registered'] = generateDateTime($content['url_registered'], 2);
715 if (isset($content['url_last_locked'])) $content['url_last_locked'] = generateDateTime($content['url_last_locked'], 2);
717 // Return translated content
721 // Translates the limit
722 function translateSurfbarLimit ($limit) {
726 $return = '{--MEMBER_SURFBAR_UNLIMITED_VIEWS--}';
729 $return = '{%pipe,translateComma=' . $limit . '%}';
736 // Translate the URL status
737 function translateSurfbarUrlStatus ($status) {
738 // NULL must be handled carfefully
739 if ((is_null($status)) || (trim($status) == '')) {
740 // Is NULL, so return other language string
741 return '{--SURFBAR_URL_STATUS_NONE--}';
743 // Return regular result
744 return sprintf("{--SURFBAR_URL_STATUS_%s--}", strtoupper($status));
748 // Translates the given action into a link title for members
749 function translateMemberSurfbarActionToTitle ($action) {
751 if (!isset($GLOBALS[__FUNCTION__][$action])) {
752 // Construct default return string (unknown
753 $GLOBALS[__FUNCTION__][$action] = '{%message,MEMBER_SURFBAR_ACTION_UNKNOWN_TITLE=' . $action . '%}';
755 // ... and the id's name
756 $messageId = 'MEMBER_SURFBAR_ACTION_' . strtoupper($action) . '_TITLE';
759 if (isMessageIdValid($messageId)) {
761 $GLOBALS[__FUNCTION__][$action] = '{--' . $messageId . '--}';
766 return $GLOBALS[__FUNCTION__][$action];
769 // Translates the given action into a submit button for members
770 function translateMemberSurfbarActionToSubmit ($action) {
772 if (!isset($GLOBALS[__FUNCTION__][$action])) {
773 // Construct default return string (unknown
774 $GLOBALS[__FUNCTION__][$action] = '{%message,MEMBER_SURFBAR_ACTION_UNKNOWN_SUBMIT=' . $action . '%}';
776 // ... and the id's name
777 $messageId = 'MEMBER_SURFBAR_ACTION_' . strtoupper($action) . '_SUBMIT';
780 if (isMessageIdValid($messageId)) {
782 $GLOBALS[__FUNCTION__][$action] = '{--' . $messageId . '--}';
787 return $GLOBALS[__FUNCTION__][$action];
791 function SURFBAR_DETERMINE_REWARD ($onlyMin = false) {
792 // Static values are default
793 $reward = getConfig('surfbar_static_reward');
795 // Do we have static or dynamic?
796 if (getSurfbarPaymentModel() == 'DYNAMIC') {
797 // "Calculate" dynamic reward
798 if ($onlyMin === true) {
799 $reward += SURFBAR_CALCULATE_DYNAMIC_MIN_VALUE();
801 $reward += SURFBAR_CALCULATE_DYNAMIC_ADD();
810 function SURFBAR_DETERMINE_COSTS ($onlyMin=false) {
811 // Static costs is default
812 $costs = getConfig('surfbar_static_costs');
814 // Do we have static or dynamic?
815 if (getSurfbarPaymentModel() == 'DYNAMIC') {
816 // "Calculate" dynamic costs
818 $costs += SURFBAR_CALCULATE_DYNAMIC_MIN_VALUE();
820 $costs += SURFBAR_CALCULATE_DYNAMIC_ADD();
828 // "Calculate" dynamic add
829 function SURFBAR_CALCULATE_DYNAMIC_ADD () {
830 // Get min/max values
831 $min = SURFBAR_CALCULATE_DYNAMIC_MIN_VALUE();
832 $max = SURFBAR_CALCULATE_DYNAMIC_MAX_VALUE();
834 // "Calculate" dynamic part and return it
835 return mt_rand($min, $max);
838 // Determine right template name
839 function SURFBAR_DETERMINE_TEMPLATE_NAME() {
840 // Default is the frameset
841 $templateName = 'surfbar_frameset';
843 // Any frame set? ;-)
844 if (isGetRequestParameterSet('frame')) {
845 // Use the frame as a template name part... ;-)
846 $templateName = sprintf("surfbar_frame_%s",
847 getRequestParameter('frame')
852 return $templateName;
855 // Check if the "reload lock" of the current user is full, call this function
856 // before you call SURFBAR_CHECK_RELOAD_LOCK().
857 function SURFBAR_CHECK_RELOAD_FULL () {
861 // Cache static reload lock
862 $GLOBALS['surfbar_cache']['surf_lock'] = getConfig('surfbar_static_lock');
863 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'Fixed surf lock is '.getConfig('surfbar_static_lock') . '', false);
865 // Do we have dynamic model?
866 if (getSurfbarPaymentModel() == 'DYNAMIC') {
867 // "Calculate" dynamic lock
868 $GLOBALS['surfbar_cache']['surf_lock'] += SURFBAR_CALCULATE_DYNAMIC_ADD();
872 $result = SQL_QUERY_ESC("SELECT
873 COUNT(l.`locks_id`) AS `cnt`
875 `{?_MYSQL_PREFIX?}_surfbar_locks` AS l
877 `{?_MYSQL_PREFIX?}_surfbar_urls` AS u
879 u.`url_id`=l.`locks_url_id`
881 l.`locks_userid`=%s AND
882 (UNIX_TIMESTAMP() - {%%pipe,SURFBAR_GET_SURF_LOCK%%}) < UNIX_TIMESTAMP(l.`locks_last_surfed`) AND
884 ((UNIX_TIMESTAMP(l.`locks_last_surfed`) - u.`url_fixed_reload`) < 0 AND u.`url_fixed_reload` > 0) OR
885 u.`url_fixed_reload` = 0
888 array(getMemberId()), __FUNCTION__, __LINE__
892 list($GLOBALS['surfbar_cache']['user_locks']) = SQL_FETCHROW($result);
895 if (is_null($GLOBALS['surfbar_cache']['user_locks'])) {
896 // Then fix it to zero!
897 $GLOBALS['surfbar_cache']['user_locks'] = '0';
901 SQL_FREERESULT($result);
904 $total = SURFBAR_GET_TOTAL_URLS();
906 // Do we have some URLs in lock? Admins can always surf on own URLs!
907 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, "userLocks=".SURFBAR_GET_USER_LOCKS().",total={$total}", false);
908 $isFull = ((SURFBAR_GET_USER_LOCKS() == $total) && ($total > 0));
914 // Get total amount of URLs of given status for current user or of ACTIVE URLs by default
915 function SURFBAR_GET_TOTAL_URLS ($status = 'ACTIVE', $excludeUserId = '0') {
916 // Determine depleted user account
917 $userids = SURFBAR_DETERMINE_DEPLETED_USERIDS();
919 // If we dont get any user ids back, there are no URLs
920 if (count($userids['url_userid']) == 0) {
921 // No user ids found, no URLs!
925 // Is the exlude userid set?
926 if (isValidUserId($excludeUserId)) {
928 $userids['url_userid'][$excludeUserId] = $excludeUserId;
931 // Get amount from database
932 $result = SQL_QUERY_ESC("SELECT
933 COUNT(`url_id`) AS cnt
935 `{?_MYSQL_PREFIX?}_surfbar_urls`
937 `url_userid` NOT IN (".implode(', ', $userids['url_userid']).") AND
940 array($status), __FUNCTION__, __LINE__
944 list($count) = SQL_FETCHROW($result);
947 SQL_FREERESULT($result);
950 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'cnt=' . $count);
956 // Check wether the user is allowed to book more URLs
957 function SURFBAR_IF_USER_BOOK_MORE_URLS ($userid = '0') {
958 // Is this admin and userid is zero or does the user has some URLs left to book?
959 return ((($userid == '0') && (isAdmin())) || (SURFBAR_GET_TOTAL_USER_URLS($userid, '', array('REJECTED')) < getSurfbarMaxOrder()));
962 // Get total amount of URLs of given status for current user
963 function SURFBAR_GET_TOTAL_USER_URLS ($userid = '0', $status = '', $exclude = '') {
964 // Is the user 0 and user is logged in?
965 if (($userid == '0') && (isMember())) {
966 // Then use this userid
967 $userid = getMemberId();
968 } elseif ($userid == '0') {
970 return (getSurfbarMaxOrder() + 1);
973 // Default is all URLs
976 // Is the status set?
977 if (is_array($status)) {
978 // Only URLs with these status
979 $add = sprintf(" AND `url_status` IN('%s')", implode("','", $status));
980 } elseif (!empty($status)) {
981 // Only URLs with this status
982 $add = sprintf(" AND `url_status`='%s'", $status);
983 } elseif (is_array($exclude)) {
984 // Exclude URLs with these status
985 $add = sprintf(" AND `url_status` NOT IN('%s')", implode("','", $exclude));
986 } elseif (!empty($exclude)) {
987 // Exclude URLs with this status
988 $add = sprintf(" AND `url_status` != '%s'", $exclude);
991 // Get amount from database
992 $count = countSumTotalData($userid, 'surfbar_urls', 'url_id', 'url_userid', true, $add);
998 // Generate a validation code for the given id number
999 function SURFBAR_GENERATE_VALIDATION_CODE ($urlId, $salt = '') {
1000 // @TODO Invalid salt should be refused
1002 $GLOBALS['surfbar_cache']['salt'] = 'INVALID';
1004 // Is extension ext-other there?
1005 if (isExtensionActive('other')) {
1006 // Get code length from config
1007 $length = getCodeLength();
1011 if ($length == '0') {
1015 // Generate a code until the length matches
1017 while (strlen($valCode) != $length) {
1020 // Generate random hashed string
1021 $GLOBALS['surfbar_cache']['salt'] = sha1(generatePassword(mt_rand(200, 255)));
1022 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'newSalt='.SURFBAR_GET_SALT().'', false);
1024 // Use this as salt!
1025 $GLOBALS['surfbar_cache']['salt'] = $salt;
1026 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'oldSalt='.SURFBAR_GET_SALT().'', false);
1029 // ... and now the validation code
1030 $valCode = generateRandomCode($length, sha1(SURFBAR_GET_SALT() . getEncryptSeperator() . $urlId), getMemberId());
1031 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'valCode='.valCode.'', false);
1034 // Hash it with md5() and salt it with the random string
1035 $hashedCode = generateHash(md5($valCode), SURFBAR_GET_SALT());
1037 // Finally encrypt it PGP-like and return it
1038 $valHashedCode = encodeHashForCookie($hashedCode);
1040 // Return hashed value
1041 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'finalValCode='.$valHashedCode.'', false);
1042 return $valHashedCode;
1045 // Check validation code
1046 function SURFBAR_CHECK_VALIDATION_CODE ($urlId, $check, $salt) {
1048 $urlId = bigintval($urlId);
1050 // Now generate the code again
1051 $code = SURFBAR_GENERATE_VALIDATION_CODE($urlId, $salt);
1053 // Return result of checking hashes and salts
1054 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, '---'.$code.'|'.$check.'---', false);
1055 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, '+++'.$salt.'|'.SURFBAR_GET_DATA('salts_last_salt').'+++', false);
1056 return (($code == $check) && ($salt == SURFBAR_GET_DATA('salts_last_salt')));
1059 // Lockdown the userid/id combination (reload lock)
1060 function SURFBAR_LOCKDOWN_ID ($urlId) {
1061 //* DEBUG: */ debugOutput('LOCK!');
1062 ///* DEBUG: */ return;
1063 // Just add it to the database
1064 SQL_QUERY_ESC('INSERT INTO `{?_MYSQL_PREFIX?}_surfbar_locks` (`locks_userid`, `locks_url_id`) VALUES (%s, %s)',
1065 array(getMemberId(), bigintval($urlId)), __FUNCTION__, __LINE__);
1067 // Remove the salt from database
1068 SQL_QUERY_ESC('DELETE LOW_PRIORITY FROM `{?_MYSQL_PREFIX?}_surfbar_salts` WHERE `salts_url_id`=%s AND `salts_userid`=%s LIMIT 1',
1069 array(bigintval($urlId), getMemberId()), __FUNCTION__, __LINE__);
1072 // Pay points to the user and remove it from the sender if userid is given else it is a "sponsored surf"
1073 function SURFBAR_PAY_POINTS () {
1074 // Remove it from the URL owner
1075 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'userid='.SURFBAR_GET_USERID().',costs='.SURFBAR_GET_COSTS().'', false);
1076 if (isValidUserId(SURFBAR_GET_USERID())) {
1077 subtractPoints(sprintf("surfbar_%s", getSurfbarPaymentModel()), SURFBAR_GET_USERID(), SURFBAR_GET_COSTS());
1080 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'userid='.getMemberId().',reward='.SURFBAR_GET_REWARD().'', false);
1081 // @TODO Try to rewrite the following unset()
1082 unset($GLOBALS['ref_level']);
1084 // Book it to the user
1085 addPointsThroughReferalSystem(sprintf("surfbar_%s", getSurfbarPaymentModel()), getMemberId(), SURFBAR_GET_REWARD());
1088 // Updates the statistics of current URL/userid
1089 function SURFBAR_UPDATE_INSERT_STATS_RECORD () {
1093 // Get allowed views
1094 $allowed = SURFBAR_GET_VIEWS_ALLOWED();
1096 // Do we have a limit?
1098 // Then count views_max down!
1099 $add .= ', `url_views_max`=`url_views_max`-1';
1103 SQL_QUERY_ESC('UPDATE `{?_MYSQL_PREFIX?}_surfbar_urls` SET `url_views_total`=`url_views_total`+1' . $add . ' WHERE `url_id`=%s LIMIT 1',
1104 array(SURFBAR_GET_ID()), __FUNCTION__, __LINE__);
1106 // Update the stats entry
1107 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',
1111 ), __FUNCTION__, __LINE__);
1113 // Was that update okay?
1114 if (SQL_HASZEROAFFECTED()) {
1115 // No, then insert entry
1116 SQL_QUERY_ESC('INSERT INTO `{?_MYSQL_PREFIX?}_surfbar_stats` (`stats_userid`, `stats_url_id`, `stats_count`) VALUES (%s,%s,1)',
1120 ), __FUNCTION__, __LINE__);
1123 // Update total/daily/weekly/monthly counter
1124 incrementConfigEntry('surfbar_total_counter');
1125 incrementConfigEntry('surfbar_daily_counter');
1126 incrementConfigEntry('surfbar_weekly_counter');
1127 incrementConfigEntry('surfbar_monthly_counter');
1129 // Update config as well
1130 updateConfiguration(array('surfbar_total_counter', 'surfbar_daily_counter', 'surfbar_weekly_counter', 'surfbar_monthly_counter'), array(1,1,1,1), '+');
1133 // Update the salt for validation and statistics
1134 function SURFBAR_UPDATE_SALT_STATS () {
1135 // Update statistics record
1136 SURFBAR_UPDATE_INSERT_STATS_RECORD();
1139 SURFBAR_GENERATE_VALIDATION_CODE(SURFBAR_GET_ID());
1141 // Simply store the salt from cache away in database...
1142 SQL_QUERY_ESC("UPDATE `{?_MYSQL_PREFIX?}_surfbar_salts` SET `salts_last_salt`='%s' WHERE `salts_url_id`=%s AND `salts_userid`=%s LIMIT 1",
1147 ), __FUNCTION__, __LINE__);
1150 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'salt='.SURFBAR_GET_SALT().',id='.SURFBAR_GET_ID().',userid='.getMemberId().'', false);
1153 if (SQL_HASZEROAFFECTED()) {
1154 // Insert missing entry!
1155 SQL_QUERY_ESC("INSERT INTO `{?_MYSQL_PREFIX?}_surfbar_salts` (`salts_url_id`, `salts_userid`, `salts_last_salt`) VALUES (%s, %s, '%s')",
1156 array(SURFBAR_GET_ID(), getMemberId(), SURFBAR_GET_SALT()), __FUNCTION__, __LINE__);
1160 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'affectedRows='.SQL_AFFECTEDROWS().'', false);
1162 // Return if the update was okay
1163 return (!SQL_HASZEROAFFECTED());
1166 // Check if the reload lock is active for given id
1167 function SURFBAR_CHECK_RELOAD_LOCK ($urlId) {
1168 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'id=' . $urlId . '', false);
1170 $result = SQL_QUERY_ESC("SELECT COUNT(`locks_id`) AS cnt
1172 `{?_MYSQL_PREFIX?}_surfbar_locks`
1174 `locks_userid`=%s AND
1175 `locks_url_id`=%s AND
1176 (UNIX_TIMESTAMP() - ".SURFBAR_GET_SURF_LOCK().") < UNIX_TIMESTAMP(`locks_last_surfed`)
1178 `locks_last_surfed` ASC
1180 array(getMemberId(), bigintval($urlId)), __FUNCTION__, __LINE__
1184 list($count) = SQL_FETCHROW($result);
1187 SQL_FREERESULT($result);
1190 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'cnt=' . $count . ',' . SURFBAR_GET_SURF_LOCK() . '', false);
1191 return ($count == 1);
1194 // Determine which user hash no more points left
1195 function SURFBAR_DETERMINE_DEPLETED_USERIDS ($limit=0) {
1198 'url_userid' => array(),
1199 'points' => array(),
1200 'notified' => array(),
1203 // Do we have a current user id?
1204 if ((isMember()) && ($limit == '0')) {
1205 // Then add this as well
1206 $userids['url_userid'][getMemberId()] = getMemberId();
1207 $userids['points'][getMemberId()] = getTotalPoints(getMemberId());
1208 $userids['notified'][getMemberId()] = '0';
1210 // Get all userid except logged in one
1211 $result = SQL_QUERY_ESC("SELECT
1212 u.url_userid, UNIX_TIMESTAMP(d.surfbar_low_notified) AS notified
1214 `{?_MYSQL_PREFIX?}_surfbar_urls` AS u
1216 `{?_MYSQL_PREFIX?}_user_data` AS d
1218 u.`url_userid`=d.`userid`
1220 u.`url_userid` NOT IN (%s,0) AND
1221 u.`url_status`='ACTIVE'
1225 u.`url_userid` ASC",
1226 array(getMemberId()), __FUNCTION__, __LINE__);
1229 $result = SQL_QUERY("SELECT
1230 u.url_userid, UNIX_TIMESTAMP(d.surfbar_low_notified) AS notified
1232 `{?_MYSQL_PREFIX?}_surfbar_urls` AS u
1234 `{?_MYSQL_PREFIX?}_user_data` AS d
1236 u.`url_userid`=d.`userid`
1238 u.`url_userid` > 0 AND
1239 u.`url_status`='ACTIVE'
1243 u.`url_userid` ASC", __FUNCTION__, __LINE__);
1247 while ($content = SQL_FETCHARRAY($result)) {
1249 $points = getTotalPoints($content['url_userid']);
1250 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, "userid={$content['url_userid']},points={$points}", false);
1252 // Shall we add this to ignore?
1253 if ($points <= $limit) {
1255 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, "userid={$content['url_userid']} has depleted points amount!", false);
1256 $userids['url_userid'][$content['url_userid']] = $content['url_userid'];
1257 $userids['points'][$content['url_userid']] = $points;
1258 $userids['notified'][$content['url_userid']] = $content['notified'];
1263 SQL_FREERESULT($result);
1266 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, "UIDs::count=".count($userids)." (with own userid=".getMemberId().')', false);
1272 // Determine how many users are Online in surfbar
1273 function SURFBAR_DETERMINE_TOTAL_ONLINE () {
1274 // Count all users in surfbar modue and return the value
1275 $result = SQL_QUERY('SELECT
1278 `{?_MYSQL_PREFIX?}_surfbar_stats`
1280 (UNIX_TIMESTAMP() - UNIX_TIMESTAMP(`stats_last_surfed`)) <= {?online_timeout?}
1282 `stats_userid` ASC', __FUNCTION__, __LINE__);
1285 $count = SQL_NUMROWS($result);
1288 SQL_FREERESULT($result);
1294 // Determine waiting time for one URL
1295 function SURFBAR_DETERMINE_WAIT_TIME () {
1296 // Get fixed reload lock
1297 $fixed = SURFBAR_GET_FIXED_RELOAD();
1299 // Is the fixed reload time set?
1305 // Static time is default
1306 $time = getConfig('surfbar_static_time');
1308 // Which payment model do we have?
1309 if (getSurfbarPaymentModel() == 'DYNAMIC') {
1310 // "Calculate" dynamic time
1311 $time += SURFBAR_CALCULATE_DYNAMIC_ADD();
1318 // Changes the status of an URL from given to other
1319 function SURFBAR_CHANGE_STATUS ($urlId, $prevStatus, $newStatus, $data=array()) {
1320 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'urlId=' . $urlId . ',prevStatus=' . $prevStatus . ',newStatus=' . $newStatus . ' - ENTERED!');
1321 // Make new status always lower-case
1322 $newStatus = strtolower($newStatus);
1324 // Get URL data for status comparison if missing
1325 if ((!is_array($data)) || (count($data) == 0)) {
1326 // Fetch missing URL data
1327 $data = SURFBAR_GET_URL_DATA($urlId);
1331 $filterData = array(
1333 'prev_status' => $prevStatus,
1334 'new_status' => $newStatus,
1339 // Run pre filter chain
1340 $filterData = runFilterChain('pre_change_surfbar_url_status', $filterData);
1343 if (!is_null($filterData['abort'])) {
1345 return $filterData['abort'];
1348 // Update the status now
1349 // ---------- Comment out for debugging/developing member actions! ---------
1350 SQL_QUERY_ESC("UPDATE `{?_MYSQL_PREFIX?}_surfbar_urls` SET `url_status`='%s' WHERE `url_id`=%s LIMIT 1",
1354 ), __FUNCTION__, __LINE__);
1355 // ---------- Comment out for debugging/developing member actions! ---------
1358 // ---------- Comment out for debugging/developing member actions! ---------
1359 if (SQL_AFFECTEDROWS() != 1) {
1360 // No, something went wrong
1363 // ---------- Comment out for debugging/developing member actions! ---------
1365 // Run post filter chain
1366 $filterData = runFilterChain('post_change_surfbar_url_status', $filterData);
1368 // Extract data from it again
1369 $data = $filterData['data'];
1372 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'urlId=' . $urlId . ',prevStatus=' . $prevStatus . ',newStatus=' . $newStatus . ' - EXIT!');
1376 // Calculate minimum value for dynamic payment model
1377 function SURFBAR_CALCULATE_DYNAMIC_MIN_VALUE () {
1378 // Addon is zero by default
1382 $percent = abs(log(getConfig('surfbar_dynamic_percent') / 100 + 1));
1385 $totalUsers = getTotalConfirmedUser();
1388 $onlineUsers = SURFBAR_DETERMINE_TOTAL_ONLINE();
1391 $addon += abs(log($onlineUsers / $totalUsers + 1) * $percent * $totalUsers);
1394 $totalUrls = SURFBAR_GET_TOTAL_URLS('ACTIVE', 0);
1396 // Get user's total URLs
1397 $userUrls = SURFBAR_GET_TOTAL_USER_URLS(0, 'ACTIVE');
1400 if ($totalUrls > 0) {
1401 $addon += abs(log($userUrls / $totalUrls + 1) * $percent * $totalUrls);
1403 $addon += abs(log($userUrls / 1 + 1) * $percent * $totalUrls);
1410 // Calculate maximum value for dynamic payment model
1411 function SURFBAR_CALCULATE_DYNAMIC_MAX_VALUE () {
1412 // Addon is zero by default
1419 $percent = abs(log(getConfig('surfbar_dynamic_percent') / 100 + 1));
1422 $totalUsers = getTotalConfirmedUser();
1425 $addon += abs($max * $percent * $totalUsers);
1428 $totalUrls = SURFBAR_GET_TOTAL_URLS('ACTIVE', 0);
1431 $addon += abs($max * $percent * $totalUrls);
1437 // Calculate dynamic lock
1438 function SURFBAR_CALCULATE_DYNAMIC_LOCK () {
1439 // Default lock is 30 seconds
1443 $onlineUsers = SURFBAR_DETERMINE_TOTAL_ONLINE();
1446 $addon = abs(log($onlineUsers / $addon + 1));
1452 // "Getter" for lock ids array
1453 function SURFBAR_GET_LOCK_IDS () {
1454 // Prepare some arrays
1459 // Get all id from locks within the timestamp
1460 $result = SQL_QUERY_ESC("SELECT `locks_id`, `locks_url_id`, UNIX_TIMESTAMP(`locks_last_surfed`) AS last_surfed
1462 `{?_MYSQL_PREFIX?}_surfbar_locks`
1466 `locks_id` ASC", array(getMemberId()),
1467 __FUNCTION__, __LINE__);
1470 while ($content = SQL_FETCHARRAY($result)) {
1472 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'next - lid='.$content['id'].',url='.$content['url_id'].',rest='.(time() - $content['last_surfed']).'/'.SURFBAR_GET_SURF_LOCK().'', false);
1474 // Skip entries that are too old
1475 if (($content['last_surfed'] > (time() - SURFBAR_GET_SURF_LOCK())) && (!in_array($content['url_id'], $ignored))) {
1477 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'okay - lid='.$content['id'].',url='.$content['url_id'].',last='.$content['last_surfed'].'', false);
1479 // Add only if missing or bigger
1480 if ((!isset($IDs[$content['url_id']])) || ($IDs[$content['url_id']] > $content['last_surfed'])) {
1482 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'ADD - lid='.$content['id'].',url='.$content['url_id'].',last='.$content['last_surfed'].'', false);
1485 $IDs[$content['url_id']] = $content['last_surfed'];
1486 $USE[$content['url_id']] = $content['id'];
1490 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'ignore - lid='.$content['id'].',url='.$content['url_id'].',last='.$content['last_surfed'].'', false);
1492 // Ignore these old entries!
1493 $ignored[] = $content['url_id'];
1494 unset($IDs[$content['url_id']]);
1495 unset($USE[$content['url_id']]);
1500 SQL_FREERESULT($result);
1506 // "Getter" for maximum random number
1507 function SURFBAR_GET_MAX_RANDOM ($userids, $add) {
1508 // Count max availabe entries
1509 $result = SQL_QUERY("SELECT
1512 `{?_MYSQL_PREFIX?}_surfbar_urls` AS sbu
1514 `{?_MYSQL_PREFIX?}_surfbar_salts` AS sbs
1516 sbu.url_id=sbs.salts_url_id
1518 `{?_MYSQL_PREFIX?}_surfbar_locks` AS l
1520 sbu.url_id=l.locks_url_id
1522 sbu.url_userid NOT IN (" . implode(',', $userids) . ") AND
1523 (sbu.url_views_allowed=0 OR (sbu.url_views_allowed > 0 AND sbu.url_views_max > 0)) AND
1524 sbu.url_status='ACTIVE'
1527 sbu.url_id ASC", __FUNCTION__, __LINE__);
1530 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'lastQuery='.getConfig('db_last_query').'|numRows='.SQL_NUMROWS($result).'|Affected='.SQL_AFFECTEDROWS().'', false);
1533 $maxRand = SQL_NUMROWS($result);
1536 SQL_FREERESULT($result);
1542 // Load all URLs of the current user and return it as an array
1543 function SURFBAR_GET_USER_URLS () {
1545 $urlArray = array();
1548 $result = SQL_QUERY_ESC("SELECT
1555 u.url_views_allowed,
1556 UNIX_TIMESTAMP(u.url_registered) AS `url_registered`,
1557 UNIX_TIMESTAMP(u.`url_last_locked`) AS `url_last_locked`,
1560 `{?_MYSQL_PREFIX?}_surfbar_urls` AS u
1562 u.`url_userid`=%s AND
1563 u.`url_status` != 'DELETED'
1566 array(getMemberId()), __FUNCTION__, __LINE__);
1568 // Are there entries?
1569 if (!SQL_HASZERONUMS($result)) {
1571 while ($row = SQL_FETCHARRAY($result)) {
1573 $urlArray[$row['url_id']] = $row;
1578 SQL_FREERESULT($result);
1584 // "Getter" for member action array for given status
1585 function SURFBAR_GET_ARRAY_FROM_STATUS ($status) {
1587 $returnArray = array();
1589 // Get all assigned actions
1590 $result = SQL_QUERY_ESC("SELECT `actions_action` FROM `{?_MYSQL_PREFIX?}_surfbar_actions` WHERE `actions_status`='%s' ORDER BY `actions_id` ASC",
1591 array($status), __FUNCTION__, __LINE__);
1593 // Some entries there?
1594 if (!SQL_HASZERONUMS($result)) {
1596 // @TODO This can be somehow rewritten
1597 while ($content = SQL_FETCHARRAY($result)) {
1598 $returnArray[] = $content['actions_action'];
1603 SQL_FREERESULT($result);
1606 return $returnArray;
1609 // Reload to configured stop page
1610 function SURFBAR_RELOAD_TO_STOP_PAGE ($page = 'stop') {
1611 // Internal or external?
1612 if ((getConfig('surfbar_pause_mode') == 'INTERNAL') || (getConfig('surfbar_pause_url') == '')) {
1613 // Reload to internal page
1614 redirectToUrl('surfbar.php?frame=' . $page);
1616 // Reload to external page
1617 redirectToConfiguredUrl('surfbar_pause_url');
1621 // Determine next id for surfbar or get data for given id, always call this before you call other
1622 // getters below this function!
1623 function SURFBAR_DETERMINE_NEXT_ID ($urlId = '0') {
1624 // Default is no id and no random number
1629 if ($urlId == '0') {
1630 // Get array with lock ids
1631 $USE = SURFBAR_GET_LOCK_IDS();
1633 // Shall we add some URL ids to ignore?
1635 if (count($USE) > 0) {
1637 $add = " AND sbu.`url_id` NOT IN (";
1638 foreach ($USE as $url_id => $lid) {
1640 $add .= $url_id.',';
1643 // Add closing bracket
1644 $add = substr($add, 0, -1) . ')';
1647 // Determine depleted user account
1648 $userids = SURFBAR_DETERMINE_DEPLETED_USERIDS();
1650 // Get maximum randomness factor
1651 $maxRand = SURFBAR_GET_MAX_RANDOM($userids['url_userid'], $add);
1653 // If more than one URL can be called generate the random number!
1655 // Generate random number
1656 $randNum = mt_rand(0, ($maxRand - 1));
1659 // And query the database
1660 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'randNum='.$randNum.',maxRand='.$maxRand.',surfLock='.SURFBAR_GET_SURF_LOCK().'', false);
1661 $result = SQL_QUERY_ESC("SELECT
1665 sbs.salts_last_salt,
1666 sbu.url_views_total,
1668 sbu.url_views_allowed,
1669 UNIX_TIMESTAMP(l.locks_last_surfed) AS last_surfed,
1670 sbu.url_fixed_reload
1672 `{?_MYSQL_PREFIX?}_surfbar_urls` AS sbu
1674 `{?_MYSQL_PREFIX?}_surfbar_salts` AS sbs
1676 sbu.url_id=sbs.salts_url_id
1678 `{?_MYSQL_PREFIX?}_surfbar_locks` AS l
1680 sbu.url_id=l.locks_url_id
1682 sbu.`url_userid` NOT IN (".implode(',', $userids['url_userid']).") AND
1683 sbu.url_status='ACTIVE' AND
1684 (sbu.url_views_allowed=0 OR (sbu.url_views_allowed > 0 AND sbu.url_views_max > 0))
1689 l.locks_last_surfed ASC,
1692 array($randNum), __FUNCTION__, __LINE__
1695 // Get data from specified id number
1696 $result = SQL_QUERY_ESC("SELECT
1700 sbs.salts_last_salt,
1701 sbu.url_views_total,
1703 sbu.url_views_allowed,
1704 UNIX_TIMESTAMP(l.locks_last_surfed) AS last_surfed,
1705 sbu.url_fixed_reload
1707 `{?_MYSQL_PREFIX?}_surfbar_urls` AS sbu
1709 `{?_MYSQL_PREFIX?}_surfbar_salts` AS sbs
1711 sbu.url_id=sbs.salts_url_id
1713 `{?_MYSQL_PREFIX?}_surfbar_locks` AS l
1715 sbu.url_id=l.locks_url_id
1717 sbu.url_userid != %s AND
1718 sbu.url_status='ACTIVE' AND
1720 (sbu.url_views_allowed=0 OR (sbu.url_views_allowed > 0 AND sbu.url_views_max > 0))
1722 array(getMemberId(), bigintval($urlId)), __FUNCTION__, __LINE__
1726 // Is there an id number?
1727 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'lastQuery='.getConfig('db_last_query').'|numRows='.SQL_NUMROWS($result).'|Affected='.SQL_AFFECTEDROWS().'', false);
1728 if (SQL_NUMROWS($result) == 1) {
1730 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'count('.count($GLOBALS['surfbar_cache']).') - BEFORE', false);
1731 $GLOBALS['surfbar_cache'] = merge_array($GLOBALS['surfbar_cache'], SQL_FETCHARRAY($result));
1732 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'count('.count($GLOBALS['surfbar_cache']).') - AFTER', false);
1734 // Determine waiting time
1735 $GLOBALS['surfbar_cache']['time'] = SURFBAR_DETERMINE_WAIT_TIME();
1737 // Is the last salt there?
1738 if (is_null($GLOBALS['surfbar_cache']['salts_last_salt'])) {
1739 // Then repair it wit the static!
1740 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'last_salt - FIXED!', false);
1741 $GLOBALS['surfbar_cache']['salts_last_salt'] = '';
1744 // Fix missing last_surfed
1745 if ((!isset($GLOBALS['surfbar_cache']['last_surfed'])) || (is_null($GLOBALS['surfbar_cache']['last_surfed']))) {
1747 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'last_surfed - FIXED!', false);
1748 $GLOBALS['surfbar_cache']['last_surfed'] = '0';
1751 // Get base/fixed reward and costs
1752 $GLOBALS['surfbar_cache']['reward'] = SURFBAR_DETERMINE_REWARD();
1753 $GLOBALS['surfbar_cache']['costs'] = SURFBAR_DETERMINE_COSTS();
1754 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'BASE/STATIC - reward='.SURFBAR_GET_REWARD().'|costs='.SURFBAR_GET_COSTS().'', false);
1756 // Only in dynamic model add the dynamic bonus!
1757 if (getSurfbarPaymentModel() == 'DYNAMIC') {
1758 // Calculate dynamic reward/costs and add it
1759 $GLOBALS['surfbar_cache']['reward'] += SURFBAR_CALCULATE_DYNAMIC_ADD();
1760 $GLOBALS['surfbar_cache']['costs'] += SURFBAR_CALCULATE_DYNAMIC_ADD();
1761 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'DYNAMIC+ - reward='.SURFBAR_GET_REWARD().'|costs='.SURFBAR_GET_COSTS().'', false);
1765 $nextId = SURFBAR_GET_ID();
1769 SQL_FREERESULT($result);
1772 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'nextId='.$nextId.'', false);
1776 //-----------------------------------------------------------------------------
1778 //-----------------------------------------------------------------------------
1780 // "Getter" for surfbar_dynamic_percent
1781 function getSurfbarDynamicPercent () {
1782 // Do we have cache?
1783 if (!isset($GLOBALS[__FUNCTION__])) {
1785 $GLOBALS[__FUNCTION__] = getConfig('surfbar_dynamic_percent');
1789 return $GLOBALS[__FUNCTION__];
1792 // "Getter" for surfbar_static_reward
1793 function getSurfbarStaticReward () {
1794 // Do we have cache?
1795 if (!isset($GLOBALS[__FUNCTION__])) {
1797 $GLOBALS[__FUNCTION__] = getConfig('surfbar_static_reward');
1801 return $GLOBALS[__FUNCTION__];
1804 // "Getter" for surfbar_static_time
1805 function getSurfbarStaticTime () {
1806 // Do we have cache?
1807 if (!isset($GLOBALS[__FUNCTION__])) {
1809 $GLOBALS[__FUNCTION__] = getConfig('surfbar_static_time');
1813 return $GLOBALS[__FUNCTION__];
1816 // "Getter" for surfbar_max_order
1817 function getSurfbarMaxOrder () {
1818 // Do we have cache?
1819 if (!isset($GLOBALS[__FUNCTION__])) {
1821 $GLOBALS[__FUNCTION__] = getConfig('surfbar_max_order');
1825 return $GLOBALS[__FUNCTION__];
1828 // "Getter" for surfbar_payment_model
1829 function getSurfbarPaymentModel () {
1830 // Do we have cache?
1831 if (!isset($GLOBALS[__FUNCTION__])) {
1833 $GLOBALS[__FUNCTION__] = getConfig('surfbar_payment_model');
1837 return $GLOBALS[__FUNCTION__];
1840 //------------------------------------------------------------------------------
1841 // PLEASE DO NOT ADD ANY OTHER FUNCTIONS BELOW THIS LINE IF THEY DON'T "WRAP"
1842 // THE $GLOBALS['surfbar_cache'] ARRAY!
1843 //------------------------------------------------------------------------------
1845 // Initializes the surfbar
1846 function SURFBAR_INIT () {
1848 $GLOBALS['surfbar_cache'] = array();
1851 // Private getter for data elements
1852 function SURFBAR_GET_DATA ($element) {
1853 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, "element={$element}", false);
1858 // Is the entry there?
1859 if (isset($GLOBALS['surfbar_cache'][$element])) {
1861 $data = $GLOBALS['surfbar_cache'][$element];
1862 } else { // END - if
1864 print_r($GLOBALS['surfbar_cache']);
1866 debug_report_bug(__FUNCTION__, __LINE__, 'Element ' . $element . ' not found.');
1870 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'element[' . $element . ']=[' . gettype($data) . ']' . $data, false);
1874 // Getter for reward from cache
1875 function SURFBAR_GET_REWARD () {
1876 // Get data element and return its contents
1877 return SURFBAR_GET_DATA('reward');
1880 // Getter for costs from cache
1881 function SURFBAR_GET_COSTS () {
1882 // Get data element and return its contents
1883 return SURFBAR_GET_DATA('costs');
1886 // Getter for URL from cache
1887 function SURFBAR_GET_URL () {
1888 // Get data element and return its contents
1889 return SURFBAR_GET_DATA('url');
1892 // Getter for salt from cache
1893 function SURFBAR_GET_SALT () {
1894 // Get data element and return its contents
1895 return SURFBAR_GET_DATA('salt');
1898 // Getter for id from cache
1899 function SURFBAR_GET_ID () {
1900 // Get data element and return its contents
1901 return SURFBAR_GET_DATA('url_id');
1904 // Getter for userid from cache
1905 function SURFBAR_GET_USERID () {
1906 // Get data element and return its contents
1907 return SURFBAR_GET_DATA('url_userid');
1910 // Getter for user reload locks
1911 function SURFBAR_GET_USER_LOCKS () {
1912 // Get data element and return its contents
1913 return SURFBAR_GET_DATA('user_locks');
1916 // Getter for reload time
1917 function SURFBAR_GET_RELOAD_TIME () {
1918 // Get data element and return its contents
1919 return SURFBAR_GET_DATA('time');
1922 // Getter for allowed views
1923 function SURFBAR_GET_VIEWS_ALLOWED () {
1924 // Get data element and return its contents
1925 return SURFBAR_GET_DATA('url_views_allowed');
1928 // Getter for maximum views
1929 function SURFBAR_GET_VIEWS_MAX () {
1930 // Get data element and return its contents
1931 return SURFBAR_GET_DATA('url_views_max');
1934 // Getter for fixed reload
1935 function SURFBAR_GET_FIXED_RELOAD () {
1936 // Get data element and return its contents
1937 return SURFBAR_GET_DATA('url_fixed_reload');
1940 // Getter for surf lock
1941 function SURFBAR_GET_SURF_LOCK () {
1942 // Get data element and return its contents
1943 return SURFBAR_GET_DATA('surf_lock');
1946 // Getter for new status
1947 function SURFBAR_GET_NEW_STATUS () {
1948 // Get data element and return its contents
1949 return SURFBAR_GET_DATA('new_status');