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://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 /* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, sprintf("Cannot add URL=%s,limit=%s,reload=%s: Not admin.", $url, $limit, $reload));
54 } elseif (!isUrlValid($url)) {
56 /* DEBUG: */ 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 /* DEBUG: */ 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 /* DEBUG: */ 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 /* DEBUG: */ 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 /* DEBUG: */ 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) {
85 /* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'Cannot migrate URL: Not admin, url=' . $url . ',userid=' . $userid);
87 } elseif (!isUrlValid($url)) {
89 /* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'Cannot migrate URL: Invalid URL, url=' . $url . ',userid=' . $userid);
91 } elseif (SURFBAR_LOOKUP_BY_URL($url, $userid)) {
92 // URL already found in surfbar!
93 /* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'Cannot migrate URL: Already added, url=' . $url . ',userid=' . $userid);
95 } elseif (!SURFBAR_IF_USER_BOOK_MORE_URLS($userid)) {
97 /* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'Cannot migrate URL: Maximum exceeded, url=' . $url . ',userid=' . $userid);
101 // Register the new URL
102 return SURFBAR_REGISTER_URL($url, $userid, 'MIGRATED', 'migrate');
105 // Admin function for unlocking URLs
106 function SURFBAR_ADMIN_UNLOCK_URL_IDS ($IDs) {
107 // Is this an admin or invalid array?
109 // Not admin or invalid ids array
110 /* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'Cannot add URL: Not admin');
112 } elseif (!is_array($IDs)) {
114 /* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'Cannot add URL: IDs type ' . gettype($IDs) . '!=array');
116 } elseif (count($IDs) == 0) {
118 /* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'Cannot add URL: IDs is empty');
122 // Set to true to make AND expression valid if first URL got unlocked
125 // Update the status for all ids
126 foreach ($IDs as $id => $dummy) {
127 // Test all ids through (ignores failed)
128 $done = (($done) && (SURFBAR_CHANGE_STATUS($id, 'PENDING', 'ACTIVE')));
131 // Return total status
135 // Admin function for rejecting URLs
136 function SURFBAR_ADMIN_REJECT_URL_IDS ($IDs) {
137 // Is this an admin or invalid array?
139 // Not admin or invalid ids array
140 /* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'Cannot add URL: Not admin');
142 } elseif (!is_array($IDs)) {
144 /* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'Cannot add URL: IDs type ' . gettype($IDs) . '!=array');
146 } elseif (count($IDs) == 0) {
148 /* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'Cannot add URL: IDs is empty');
152 // Set to true to make AND expression valid if first URL got unlocked
155 // Update the status for all ids
156 foreach ($IDs as $id => $dummy) {
157 // Test all ids through (ignores failed)
158 $done = (($done) && (SURFBAR_CHANGE_STATUS($id, 'PENDING', 'REJECTED')));
161 // Return total status
166 //------------------------------------------------------------------------------
168 //------------------------------------------------------------------------------
170 // Member has added an URL
171 function SURFBAR_MEMBER_ADD_URL ($url, $limit) {
172 // Do some pre-checks
175 /* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'Cannot add URL: Not member');
177 } elseif ((!isUrlValid($url)) && (!isAdmin())) {
179 /* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'Cannot add URL: Invalid, url=' . $url . ',limit=' . $limit);
181 } elseif (SURFBAR_LOOKUP_BY_URL($url, getMemberId())) {
182 // URL already found in surfbar!
183 /* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'Cannot add URL: Already found, url=' . $url . ',limit=' . $limit);
185 } elseif (!SURFBAR_IF_USER_BOOK_MORE_URLS(getMemberId())) {
187 /* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'Cannot add URL: Maximum exceeded, url=' . $url . ',limit=' . $limit);
189 } elseif (''.($limit + 0).'' != ''.$limit.'') {
190 // Invalid amount entered
191 /* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'Cannot add URL: Invalid limit, url=' . $url . ',limit=' . $limit);
195 // Register the new URL
196 return SURFBAR_REGISTER_URL($url, getMemberId(), 'PENDING', 'reg', array('limit' => $limit));
199 // Create list of actions depending on status for the user
200 function SURFBAR_MEMBER_ACTIONS ($urlId, $status) {
201 // Load all actions in an array for given status
202 $actionArray = SURFBAR_GET_ARRAY_FROM_STATUS($status);
205 $OUT = '<table border="0" cellspacing="0" cellpadding="1" width="100%">
209 $width = round(100 / count($actionArray));
211 // "Walk" through all actions and create forms
212 foreach ($actionArray as $actionId => $action) {
213 // Add form for this action
214 $OUT .= loadTemplate('member_list_surfbar_form', true, array(
216 'url_id' => bigintval($urlId),
217 'action' => strtolower($action)
229 // Do the member form request
230 function SURFBAR_MEMBER_DO_FORM ($formData, $urlArray) {
231 // By default no action is performed
237 /* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'Cannot add URL: Not member');
239 } elseif ((!isset($formData['id'])) || (!isset($formData['action']))) {
240 // Important form elements are missing!
241 /* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'Cannot add URL: Invalid form data, required field id/action not found');
243 } elseif (!isset($urlArray[$formData['id']])) {
244 // Id not found in cache
245 /* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'Cannot add URL: Field id not found in cache');
247 } elseif (!SURFBAR_VALIDATE_MEMBER_ACTION_STATUS($formData['action'], $urlArray[$formData['id']]['url_status'])) {
248 // Action not allowed for current URL status
249 /* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'Cannot add URL: Action not allowed to perform. action=' . $formData['action'] . ',url_status=' . $urlArray[$formData['id']]['url_status'] . 'id=' . $formData['id']);
254 $action = secureString($formData['action']);
257 if ($action != $formData['action']) {
258 // Invalid data in action found
262 // Create the function name for selected action
263 $functionName = sprintf("SURFBAR_MEMBER_%s_ACTION", strtoupper($action));
265 // Is the function there?
266 if (function_exists($functionName)) {
268 $urlArray[$formData['id']]['new_status'] = SURFBAR_GET_NEW_STATUS('new_status');
270 // Extract URL data for call-back
271 $urlData = array(merge_array($urlArray[$formData['id']], array($action => $formData)));
273 // Action found so execute it
274 $performed = call_user_func_array($functionName, $urlData);
276 // Log invalid request
277 debug_report_bug(__FUNCTION__, __LINE__, 'Invalid member action! action=' . $formData['action'] . ',id=' . $formData['id'] . ',function=' . $functionName);
284 // Validate if the requested action can be performed on current URL status
285 function SURFBAR_VALIDATE_MEMBER_ACTION_STATUS ($action, $status) {
286 // Search for the requested action/status combination in database
287 $result = SQL_QUERY_ESC("SELECT `actions_new_status` FROM `{?_MYSQL_PREFIX?}_surfbar_actions` WHERE `actions_action`='%s' AND `actions_status`='%s' LIMIT 1",
288 array($action, $status), __FUNCTION__, __LINE__);
290 // Is the entry there?
291 $isValid = (SQL_NUMROWS($result) == 1);
293 // Fetch the new status if found
296 list($GLOBALS['surfbar_cache']['new_status']) = SQL_FETCHROW($result);
300 SQL_FREERESULT($result);
307 //------------------------------------------------------------------------------
309 //------------------------------------------------------------------------------
311 // Retreat a booked URL
312 function SURFBAR_MEMBER_RETREAT_ACTION ($urlData) {
313 // Create the data array for next function call
315 $urlData['id'] => $urlData
318 // Simply change the status here
319 return SURFBAR_CHANGE_STATUS ($urlData['id'], $urlData['url_status'], $urlData['new_status'], $data);
322 // Book an URL now (from migration)
323 function SURFBAR_MEMBER_BOOKNOW_ACTION ($urlData) {
324 // Create the data array for next function call
326 $urlData['id'] => $urlData
329 // Simply change the status here
330 return SURFBAR_CHANGE_STATUS ($urlData['id'], $urlData['url_status'], $urlData['new_status'], $data);
333 // Show edit form or do the changes
334 function SURFBAR_MEMBER_EDIT_ACTION ($urlData) {
335 // Is the "execute" flag there?
336 if (isset($urlData['edit']['execute'])) {
337 // Execute the changes
338 return SURFBAR_MEMBER_EXECUTE_ACTION('edit', $urlData);
342 return SURFBAR_MEMBER_DISPLAY_ACTION_FORM('edit', $urlData);
345 // Show delete form or do the changes
346 function SURFBAR_MEMBER_DELETE_ACTION ($urlData) {
347 // Is the "execute" flag there?
348 if (isset($urlData['delete']['execute'])) {
349 // Execute the changes
350 return SURFBAR_MEMBER_EXECUTE_ACTION('delete', $urlData);
354 return SURFBAR_MEMBER_DISPLAY_ACTION_FORM('delete', $urlData);
357 // Pause active banner
358 function SURFBAR_MEMBER_PAUSE_ACTION ($urlData) {
359 return SURFBAR_CHANGE_STATUS($urlData['id'], $urlData['url_status'], $urlData['new_status'], array($urlData['id'] => $urlData));
362 // Unpause stopped banner
363 function SURFBAR_MEMBER_UNPAUSE_ACTION ($urlData) {
364 // Fix missing entry for template
365 $urlData['edit'] = $urlData['unpause'];
366 $urlData['edit']['url'] = $urlData['url'];
367 $urlData['edit']['limit'] = SURFBAR_GET_VIEWS_MAX();
369 // Return status change
370 return SURFBAR_CHANGE_STATUS($urlData['id'], $urlData['url_status'], $urlData['new_status'], array($urlData['id'] => $urlData));
373 // Resubmit locked URL
374 function SURFBAR_MEMBER_RESUBMIT_ACTION ($urlData) {
375 return SURFBAR_CHANGE_STATUS($urlData['id'], $urlData['url_status'], $urlData['new_status'], array($urlData['id'] => $urlData));
378 // Display selected "action form"
379 function SURFBAR_MEMBER_DISPLAY_ACTION_FORM ($action, $urlData) {
380 // Translate some data if present
381 $content = SURFBAR_PREPARE_CONTENT_FOR_TEMPLATE($content);
383 // Include fields only for action 'edit'
384 if ($action == 'edit') {
385 // Default is not limited
386 $urlData['limited_yes'] = '';
387 $urlData['limited_no'] = ' checked="checked"';
388 $urlData['limited'] = 'false';
390 // Is this URL limited?
391 if (SURFBAR_GET_VIEWS_MAX() > 0) {
392 // Then rewrite form data
393 $urlData['limited_yes'] = ' checked="checked"';
394 $urlData['limited_no'] = '';
395 $urlData['limited'] = 'true';
399 // Load the form and display it
400 loadTemplate(sprintf("member_surfbar_%s_action_form", $action), false, $urlData);
402 // All fine by default ... ;-)
406 // Execute choosen action
407 function SURFBAR_MEMBER_EXECUTE_ACTION ($action, $urlData) {
408 // By default nothing is executed
411 // Is limitation "no" and "limit" is > 0?
412 if ((isset($urlData[$action]['limited'])) && ($urlData[$action]['limited'] != 'Y') && ((isset($urlData[$action]['limit'])) && ($urlData[$action]['limit'] > 0)) || (!isset($urlData[$action]['limit']))) {
413 // Set it to unlimited
414 $urlData[$action]['limit'] = '0';
417 // Construct function name
418 $functionName = sprintf("SURFBAR_MEMBER_EXECUTE_%s_ACTION", strtoupper($action));
420 // Is that function there?
421 if (function_exists($functionName)) {
422 // Execute the function
423 if (call_user_func_array($functionName, array($urlData)) == true) {
424 // Update status as well
425 $executed = SURFBAR_CHANGE_STATUS($urlData['id'], $urlData['url_status'], $urlData['new_status'], array($urlData['id'] => $urlData));
429 debug_report_bug(__FUNCTION__, __LINE__, 'Callback function ' . $functionName . ' not found.');
435 // "Execute edit" function: Update changed data
436 function SURFBAR_MEMBER_EXECUTE_EDIT_ACTION ($urlData) {
437 // Default is nothing done
440 // Has the URL or limit changed?
442 //if (($urlData['url_views_allowed'] != $urlData['edit']['limit']) || ($url1 != $url2)) {
444 SQL_QUERY_ESC("UPDATE
445 `{?_MYSQL_PREFIX?}_surfbar_urls`
448 `url_views_allowed`=%s,
456 $urlData['edit']['limit'],
457 $urlData['edit']['limit'],
459 $urlData['url_status']
460 ), __FUNCTION__, __LINE__);
469 // "Execute delete" function: Does nothing...
470 function SURFBAR_MEMBER_EXECUTE_DELETE_ACTION ($urlData) {
471 // Nothing special to do (see above function for such "special actions" to perform)
475 //------------------------------------------------------------------------------
476 // Self-maintenance functions
477 //------------------------------------------------------------------------------
480 function SURFBAR_HANDLE_SELF_MAINTENANCE () {
481 // Handle URLs which limit has depleted so we can stop them
482 SURFBAR_HANDLE_DEPLETED_VIEWS();
484 // Handle low-points amounts
485 SURFBAR_HANDLE_LOW_POINTS();
488 // Handle URLs which limit has depleted
489 function SURFBAR_HANDLE_DEPLETED_VIEWS () {
491 $urlArray = SURFBAR_GET_URL_DATA(0, 'url_views_max', 'url_id', 'ASC', 'url_id', " AND `url_views_allowed` > 0 AND `url_status`='ACTIVE'");
493 // Do we have some entries?
494 if (count($urlArray) > 0) {
496 foreach ($urlArray as $id => $urlData) {
500 // Rewrite array for next call
506 SURFBAR_CHANGE_STATUS($id, 'ACTIVE', 'DEPLETED', $urlData);
511 // Alert users which have URLs booked and are low on points amount
512 function SURFBAR_HANDLE_LOW_POINTS () {
514 $userids = SURFBAR_DETERMINE_DEPLETED_USERIDS(getConfig('surfbar_warn_low_points'));
516 // "Walk" through all URLs
517 foreach ($userids['url_userid'] as $userid => $dummy) {
518 // Is the last notification far enougth away to notify again?
519 if ((time() - $userids['notified'][$userid]) >= getConfig('surfbar_low_interval')) {
522 'url_userid' => $userid,
523 'points' => $userids['points'][$userid],
524 'notified' => $userids['notified'][$userid]
528 SURFBAR_NOTIFY_USER('low_points', $content);
530 // Update last notified
531 SQL_QUERY_ESC("UPDATE `{?_MYSQL_PREFIX?}_user_data` SET `surfbar_low_notified`=NOW() WHERE `userid`=%s LIMIT 1",
532 array($userid), __FUNCTION__, __LINE__);
538 //------------------------------------------------------------------------------
540 //------------------------------------------------------------------------------
543 // Looks up by an URL
544 function SURFBAR_LOOKUP_BY_URL ($url, $userid) {
545 // Now lookup that given URL by itself
546 $urlArray = SURFBAR_GET_URL_DATA($url, 'url', 'url_id', 'ASC', 'url_id', sprintf(" AND `url_userid`=%s", bigintval($userid)));
549 return (count($urlArray) > 0);
552 // Load URL data by given search term and column
553 function SURFBAR_GET_URL_DATA ($searchTerm, $column = 'url_id', $order = 'url_id', $sort = 'ASC', $group = 'url_id', $add = '') {
554 // By default nothing is found
555 $GLOBALS['last_url_data'] = array();
557 // Is the column an id number?
558 if (($column == 'url_id') || ($column == 'url_userid')) {
559 // Extra secure input
560 $searchTerm = bigintval($searchTerm);
563 // If the column is 'id' there can be only one entry
565 if ($column == 'id') {
569 // Look up the record
570 $result = SQL_QUERY_ESC("SELECT
578 UNIX_TIMESTAMP(`url_registered`) AS `url_registered`,
579 UNIX_TIMESTAMP(`url_last_locked`) AS `url_last_locked`,
585 `{?_MYSQL_PREFIX?}_surfbar_urls`
587 `%s`='%s'" . $add . "
597 ), __FUNCTION__, __LINE__);
599 // Is there at least one record?
600 if (!SQL_HASZERONUMS($result)) {
602 while ($dataRow = SQL_FETCHARRAY($result)) {
603 // Shall we group these results?
604 if ($group == 'url_id') {
605 // Add the row by id as index
606 $GLOBALS['last_url_data'][$dataRow['url_id']] = $dataRow;
609 $GLOBALS['last_url_data'][$dataRow[$group]][$dataRow['url_id']] = $dataRow;
615 SQL_FREERESULT($result);
618 return $GLOBALS['last_url_data'];
621 // Registers an URL with the surfbar. You should have called SURFBAR_LOOKUP_BY_URL() first!
622 function SURFBAR_REGISTER_URL ($url, $userid, $status = 'PENDING', $addMode = 'reg', $extraFields = array()) {
623 // Make sure by the user registered URLs are always pending
624 if ($addMode == 'reg') {
629 $content = merge_array($extraFields, array(
631 'url_userid' => $userid,
632 'url_status' => $status,
635 // Is limit/reload set?
636 if (!isset($content['limit'])) {
637 $content['limit'] = '0';
639 if (!isset($content['reload'])) {
640 $content['reload'] = '0';
643 // Insert the URL into database
644 $content['insert_id'] = SURFBAR_INSERT_URL_BY_ARRAY($content);
647 if ($content['insert_id'] == '0') {
648 // INSERT did not insert any data!
652 // If in reg-mode we notify admin
653 if (($addMode == 'reg') || (getConfig('surfbar_notify_admin_unlock') == 'Y')) {
654 // Notify admin even when he as unlocked an email
655 SURFBAR_NOTIFY_ADMIN('url_' . $addMode, $content);
659 SURFBAR_NOTIFY_USER('url_' . $addMode, $content);
661 // Return the insert id
662 return $content['insert_id'];
665 // Inserts an url by given data array and return the insert id
666 function SURFBAR_INSERT_URL_BY_ARRAY ($urlData) {
668 $userid = bigintval($urlData['url_userid']);
671 if (empty($userid)) {
675 // Just run the insert query for now
676 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)",
680 $urlData['url_status'],
684 ), __FUNCTION__, __LINE__
688 return SQL_INSERTID();
691 // Notify admin(s) with a selected message and content
692 function SURFBAR_NOTIFY_ADMIN ($messageType, $content) {
693 // Prepare template name
694 $templateName = sprintf("admin_surfbar_%s", $messageType);
697 $subject = sprintf("{--ADMIN_SURFBAR_NOTIFY_%s_SUBJECT--}",
698 strtoupper($messageType)
701 // Is the subject line there?
702 if ((substr($subject, 0, 1) == '!') && (substr($subject, -1, 1) == '!')) {
703 // Set default subject if following eval() wents wrong
704 $subject = '{%message,ADMIN_SURFBAR_NOTIFY_DEFAULT_SUBJECT=' . strtoupper($messageType) . '%}';
707 // Translate some data if present
708 $content = SURFBAR_PREPARE_CONTENT_FOR_TEMPLATE($content);
710 // Send the notification out
711 return sendAdminNotification($subject, $templateName, $content, $content['url_userid']);
714 // Notify the user about the performed action
715 function SURFBAR_NOTIFY_USER ($messageType, $content) {
716 // Skip notification if userid is zero
717 if ($content['url_userid'] == '0') {
721 // Prepare template name
722 $templateName = sprintf("member_surfbar_%s", $messageType);
725 $subject = sprintf("{--MEMBER_SURFBAR_NOTIFY_%s_SUBJECT--}",
726 strtoupper($messageType)
729 // Is the subject line there?
730 if ((substr($subject, 0, 1) == '!') && (substr($subject, -1, 1) == '!')) {
731 // Set default subject if following eval() wents wrong
732 $subject = '{--MEMBER_SURFBAR_NOTIFY_DEFAULT_SUBJECT--}';
735 // Translate some data if present
736 $content = SURFBAR_PREPARE_CONTENT_FOR_TEMPLATE($content);
739 $mailText = loadEmailTemplate($templateName, $content, $content['url_userid']);
742 return sendEmail($content['url_userid'], $subject, $mailText);
745 // Translates some data for template usage
746 // @TODO Can't we use our new expression language instead of this ugly code?
747 function SURFBAR_PREPARE_CONTENT_FOR_TEMPLATE ($content) {
749 if (isset($content['url_registered'])) $content['url_registered'] = generateDateTime($content['url_registered'], 2);
750 if (isset($content['url_last_locked'])) $content['url_last_locked'] = generateDateTime($content['url_last_locked'], 2);
752 // Return translated content
756 // Translates the limit
757 function translateSurfbarLimit ($limit) {
761 $return = '{--MEMBER_SURFBAR_UNLIMITED_VIEWS--}';
764 $return = '{%pipe,translateComma=' . $limit . '%}';
771 // Translate the URL status
772 function translateSurfbarUrlStatus ($status) {
773 // NULL must be handled carfefully
774 if ((is_null($status)) || (trim($status) == '')) {
775 // Is NULL, so return other language string
776 return '{--SURFBAR_URL_STATUS_NONE--}';
778 // Return regular result
779 return sprintf("{--SURFBAR_URL_STATUS_%s--}", strtoupper($status));
783 // Translates the given action into a link title for members
784 function translateMemberSurfbarActionToTitle ($action) {
786 if (!isset($GLOBALS[__FUNCTION__][$action])) {
787 // Construct default return string (unknown
788 $GLOBALS[__FUNCTION__][$action] = '{%message,MEMBER_SURFBAR_ACTION_UNKNOWN_TITLE=' . $action . '%}';
790 // ... and the id's name
791 $messageId = 'MEMBER_SURFBAR_ACTION_' . strtoupper($action) . '_TITLE';
794 if (isMessageIdValid($messageId)) {
796 $GLOBALS[__FUNCTION__][$action] = '{--' . $messageId . '--}';
801 return $GLOBALS[__FUNCTION__][$action];
804 // Translates the given action into a submit button for members
805 function translateMemberSurfbarActionToSubmit ($action) {
807 if (!isset($GLOBALS[__FUNCTION__][$action])) {
808 // Construct default return string (unknown
809 $GLOBALS[__FUNCTION__][$action] = '{%message,MEMBER_SURFBAR_ACTION_UNKNOWN_SUBMIT=' . $action . '%}';
811 // ... and the id's name
812 $messageId = 'MEMBER_SURFBAR_ACTION_' . strtoupper($action) . '_SUBMIT';
815 if (isMessageIdValid($messageId)) {
817 $GLOBALS[__FUNCTION__][$action] = '{--' . $messageId . '--}';
822 return $GLOBALS[__FUNCTION__][$action];
826 function SURFBAR_DETERMINE_REWARD ($onlyMin = false) {
827 // Static values are default
828 $reward = getConfig('surfbar_static_reward');
830 // Do we have static or dynamic?
831 if (getSurfbarPaymentModel() == 'DYNAMIC') {
832 // "Calculate" dynamic reward
833 if ($onlyMin === true) {
834 $reward += SURFBAR_CALCULATE_DYNAMIC_MIN_VALUE();
836 $reward += SURFBAR_CALCULATE_DYNAMIC_ADD();
845 function SURFBAR_DETERMINE_COSTS ($onlyMin=false) {
846 // Static costs is default
847 $costs = getConfig('surfbar_static_costs');
849 // Do we have static or dynamic?
850 if (getSurfbarPaymentModel() == 'DYNAMIC') {
851 // "Calculate" dynamic costs
853 $costs += SURFBAR_CALCULATE_DYNAMIC_MIN_VALUE();
855 $costs += SURFBAR_CALCULATE_DYNAMIC_ADD();
863 // "Calculate" dynamic add
864 function SURFBAR_CALCULATE_DYNAMIC_ADD () {
865 // Get min/max values
866 $min = SURFBAR_CALCULATE_DYNAMIC_MIN_VALUE();
867 $max = SURFBAR_CALCULATE_DYNAMIC_MAX_VALUE();
869 // "Calculate" dynamic part and return it
870 return mt_rand($min, $max);
873 // Determine right template name
874 function SURFBAR_DETERMINE_TEMPLATE_NAME() {
875 // Default is the frameset
876 $templateName = 'surfbar_frameset';
878 // Any frame set? ;-)
879 if (isGetRequestElementSet('frame')) {
880 // Use the frame as a template name part... ;-)
881 $templateName = sprintf("surfbar_frame_%s",
882 getRequestElement('frame')
887 return $templateName;
890 // Check if the "reload lock" of the current user is full, call this function
891 // before you call SURFBAR_CHECK_RELOAD_LOCK().
892 function SURFBAR_CHECK_RELOAD_FULL () {
893 /* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'Fixed surf lock is ' . getConfig('surfbar_static_lock') . ' - ENTERED!');
897 // Cache static reload lock
898 $GLOBALS['surfbar_cache']['surf_lock'] = getConfig('surfbar_static_lock');
900 // Do we have dynamic model?
901 /* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'surf_lock=' . $GLOBALS['surfbar_cache']['surf_lock'] . ' - BEFORE');
902 if (getSurfbarPaymentModel() == 'DYNAMIC') {
903 // "Calculate" dynamic lock
904 $GLOBALS['surfbar_cache']['surf_lock'] += SURFBAR_CALCULATE_DYNAMIC_ADD();
906 /* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'surf_lock=' . $GLOBALS['surfbar_cache']['surf_lock'] . ' - AFTER');
909 $result = SQL_QUERY_ESC("SELECT
910 COUNT(l.`locks_id`) AS `cnt`
912 `{?_MYSQL_PREFIX?}_surfbar_locks` AS l
914 `{?_MYSQL_PREFIX?}_surfbar_urls` AS u
916 u.`url_id`=l.`locks_url_id`
918 l.`locks_userid`=%s AND
919 (UNIX_TIMESTAMP() - {%%pipe,SURFBAR_GET_SURF_LOCK%%}) < UNIX_TIMESTAMP(l.`locks_last_surfed`) AND
921 ((UNIX_TIMESTAMP(l.`locks_last_surfed`) - u.`url_fixed_reload`) < 0 AND u.`url_fixed_reload` > 0) OR
922 u.`url_fixed_reload` = 0
925 array(getMemberId()), __FUNCTION__, __LINE__
929 list($GLOBALS['surfbar_cache']['user_locks']) = SQL_FETCHROW($result);
932 if (is_null($GLOBALS['surfbar_cache']['user_locks'])) {
933 // Then fix it to zero!
934 $GLOBALS['surfbar_cache']['user_locks'] = '0';
938 SQL_FREERESULT($result);
941 $total = SURFBAR_GET_TOTAL_URLS();
943 // Do we have some URLs in lock? Admins can always surf on own URLs!
944 $isFull = ((SURFBAR_GET_USER_LOCKS() == $total) && ($total > 0));
947 /* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'userLocks=' . SURFBAR_GET_USER_LOCKS() . ',total=' . $total . 'isFull=' . intval($isFull) . ' - EXIT!');
951 // Get total amount of URLs of given status for current user or of ACTIVE URLs by default
952 function SURFBAR_GET_TOTAL_URLS ($status = 'ACTIVE', $excludeUserId = NULL) {
953 // Determine depleted user account
954 $userids = SURFBAR_DETERMINE_DEPLETED_USERIDS();
956 // If we dont get any user ids back, there are no URLs
957 if (count($userids['url_userid']) == 0) {
958 // No user ids found, no URLs!
962 // Is the exlude userid set?
963 if (isValidUserId($excludeUserId)) {
965 $userids['url_userid'][$excludeUserId] = $excludeUserId;
968 // Get amount from database
969 $result = SQL_QUERY_ESC("SELECT
970 COUNT(`url_id`) AS cnt
972 `{?_MYSQL_PREFIX?}_surfbar_urls`
974 `url_userid` NOT IN (".implode(', ', $userids['url_userid']).") AND
977 array($status), __FUNCTION__, __LINE__
981 list($count) = SQL_FETCHROW($result);
984 SQL_FREERESULT($result);
987 /* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'cnt=' . $count);
993 // Check wether the user is allowed to book more URLs
994 function SURFBAR_IF_USER_BOOK_MORE_URLS ($userid = NULL) {
995 // Is this admin and userid is zero or does the user has some URLs left to book?
996 return (((is_null($userid)) && (isAdmin())) || (SURFBAR_GET_TOTAL_USER_URLS($userid, '', array('REJECTED')) < getSurfbarMaxOrder()));
999 // Get total amount of URLs of given status for current user
1000 function SURFBAR_GET_TOTAL_USER_URLS ($userid = NULL, $status = '', $exclude = '') {
1001 // Is the user 0 and user is logged in?
1002 if ((is_null($userid)) && (isMember())) {
1003 // Then use this userid
1004 $userid = getMemberId();
1005 } elseif (is_null($userid)) {
1007 return (getSurfbarMaxOrder() + 1);
1010 // Default is all URLs
1013 // Is the status set?
1014 if (is_array($status)) {
1015 // Only URLs with these status
1016 $add = sprintf(" WHERE `url_status` IN('%s')", implode("','", $status));
1017 } elseif (!empty($status)) {
1018 // Only URLs with this status
1019 $add = sprintf(" WHERE `url_status`='%s'", $status);
1020 } elseif (is_array($exclude)) {
1021 // Exclude URLs with these status
1022 $add = sprintf(" WHERE `url_status` NOT IN('%s')", implode("','", $exclude));
1023 } elseif (!empty($exclude)) {
1024 // Exclude URLs with this status
1025 $add = sprintf(" WHERE `url_status` != '%s'", $exclude);
1028 // Get amount from database
1029 $count = countSumTotalData($userid, 'surfbar_urls', 'url_id', 'url_userid', true, $add);
1035 // Generate a validation code for the given id number
1036 function SURFBAR_GENERATE_VALIDATION_CODE ($urlId, $salt = '') {
1037 /* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'urlId=' . $urlId . ',salt=' . $salt . ' - ENTERED!');
1038 // Init hash with invalid value
1040 // Generate random hashed string
1041 $GLOBALS['surfbar_cache']['salt'] = sha1(generatePassword(mt_rand(200, 255)));
1042 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'newSalt='.SURFBAR_GET_SALT().'', false);
1044 // Use this as salt!
1045 $GLOBALS['surfbar_cache']['salt'] = $salt;
1046 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'oldSalt='.SURFBAR_GET_SALT().'', false);
1049 // Hash it with md5() and salt it with the random string
1050 $hashedCode = generateHash(md5($urlId . getEncryptSeparator() . getMemberId()), SURFBAR_GET_SALT());
1052 // Finally encrypt it PGP-like and return it
1053 $valHashedCode = encodeHashForCookie($hashedCode);
1055 // Return hashed value
1056 /* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'urlId=' . $urlId . ',salt=' . $salt . ',urlId=' . $urlId . ',salt=' . $salt . ',valHashedCode=' . $valHashedCode . ' - EXIT!');
1057 return $valHashedCode;
1060 // Check validation code
1061 function SURFBAR_CHECK_VALIDATION_CODE ($urlId, $check, $salt) {
1062 /* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'urlId=' . $urlId . ',check=' . $check . ',salt=' . $salt . ' - ENTERED!');
1064 $urlId = bigintval($urlId);
1066 // Now generate the code again
1067 $code = SURFBAR_GENERATE_VALIDATION_CODE($urlId, $salt);
1069 // Return result of checking hashes and salts
1070 /* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'urlId=' . $urlId . ',(code==check)=' . intval($code == $check) . ',(salt==salts_last_salt)=' . intval($salt == SURFBAR_GET_DATA('salts_last_salt')) . ' - EXIT!');
1071 return (($code == $check) && ($salt == SURFBAR_GET_DATA('salts_last_salt')));
1074 // Lockdown the userid/id combination (reload lock)
1075 function SURFBAR_LOCKDOWN_ID ($urlId) {
1076 /* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'urlId=' . $urlId . ',getMemberId()=' . getMemberId() . ' - ENTERED!');
1077 // Search for an entry
1078 $countLock = countSumTotalData(getMemberId(), 'surfbar_locks', 'locks_id', 'locks_userid', true, ' AND `locks_url_id`=' . bigintval($urlId));
1080 // Do we have no record?
1081 if ($countLock == 0) {
1082 // Just add it to the database
1083 SQL_QUERY_ESC('INSERT INTO `{?_MYSQL_PREFIX?}_surfbar_locks` (`locks_userid`,`locks_url_id`) VALUES (%s, %s)',
1087 ), __FUNCTION__, __LINE__);
1090 // Remove the salt from database
1091 SQL_QUERY_ESC('DELETE LOW_PRIORITY FROM `{?_MYSQL_PREFIX?}_surfbar_salts` WHERE `salts_url_id`=%s AND `salts_userid`=%s LIMIT 1',
1095 ), __FUNCTION__, __LINE__);
1097 /* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'urlId=' . $urlId . ',getMemberId()=' . getMemberId() . ',SQL_AFFECTEDROWS()=' . SQL_AFFECTEDROWS() . ' - EXIT!');
1100 // Pay points to the user and remove it from the sender if userid is given else it is a "sponsored surf"
1101 function SURFBAR_PAY_POINTS () {
1102 // Remove it from the URL owner
1103 /* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'userid='.SURFBAR_GET_USERID().',costs='.SURFBAR_GET_COSTS() . ' - ENTERED!');
1104 if (isValidUserId(SURFBAR_GET_USERID())) {
1105 // Subtract points and ignore return status
1106 subtractPoints(sprintf("surfbar_%s", getSurfbarPaymentModel()), SURFBAR_GET_USERID(), SURFBAR_GET_COSTS());
1109 /* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'userid='.getMemberId().',reward='.SURFBAR_GET_REWARD());
1110 // Init referral system here
1111 initReferralSystem();
1113 // Book it to the user and ignore return status
1114 addPointsThroughReferralSystem(sprintf("surfbar:%s", getSurfbarPaymentModel()), getMemberId(), SURFBAR_GET_REWARD());
1115 /* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'userid='.SURFBAR_GET_USERID().',costs='.SURFBAR_GET_COSTS() . ' - EXIT!');
1118 // Updates the statistics of current URL/userid
1119 function SURFBAR_UPDATE_INSERT_STATS_RECORD () {
1123 // Get allowed views
1124 $allowed = SURFBAR_GET_VIEWS_ALLOWED();
1126 // Do we have a limit?
1128 // Then count views_max down!
1129 $add .= ',`url_views_max`=`url_views_max`-1';
1133 SQL_QUERY_ESC('UPDATE `{?_MYSQL_PREFIX?}_surfbar_urls` SET `url_views_total`=`url_views_total`+1' . $add . ' WHERE `url_id`=%s LIMIT 1',
1134 array(SURFBAR_GET_ID()), __FUNCTION__, __LINE__);
1136 // Update the stats entry
1137 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',
1141 ), __FUNCTION__, __LINE__);
1143 // Was that update okay?
1144 if (SQL_HASZEROAFFECTED()) {
1145 // No, then insert entry
1146 SQL_QUERY_ESC('INSERT INTO `{?_MYSQL_PREFIX?}_surfbar_stats` (`stats_userid`,`stats_url_id`,`stats_count`) VALUES (%s,%s,1)',
1150 ), __FUNCTION__, __LINE__);
1153 // Update total/daily/weekly/monthly counter
1154 incrementConfigEntry('surfbar_total_counter');
1155 incrementConfigEntry('surfbar_daily_counter');
1156 incrementConfigEntry('surfbar_weekly_counter');
1157 incrementConfigEntry('surfbar_monthly_counter');
1159 // Update config as well
1160 updateConfiguration(array('surfbar_total_counter', 'surfbar_daily_counter', 'surfbar_weekly_counter', 'surfbar_monthly_counter'), array(1,1,1,1), '+');
1163 // Update the salt for validation and statistics
1164 function SURFBAR_UPDATE_SALT_STATS () {
1166 SURFBAR_GENERATE_VALIDATION_CODE(SURFBAR_GET_ID());
1168 // Make sure only valid salts can pass
1169 if (SURFBAR_GET_SALT() == 'INVALID') {
1171 debug_report_bug(__FUNCTION__, __LINE__, 'Invalid salt provided, id=' . SURFBAR_GET_ID() . ',getMemberId()=' . getMemberId());
1174 // Update statistics record
1175 SURFBAR_UPDATE_INSERT_STATS_RECORD();
1177 // Simply store the salt from cache away in database...
1178 SQL_QUERY_ESC("UPDATE `{?_MYSQL_PREFIX?}_surfbar_salts` SET `salts_last_salt`='%s' WHERE `salts_url_id`=%s AND `salts_userid`=%s LIMIT 1",
1183 ), __FUNCTION__, __LINE__);
1186 /* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'salt=' . SURFBAR_GET_SALT() . ',id=' . SURFBAR_GET_ID() . ',userid=' . getMemberId() . ',SQL_AFFECTEDROWS()=' . SQL_AFFECTEDROWS() . ' - UPDATE!');
1189 if (SQL_HASZEROAFFECTED()) {
1190 // Insert missing entry!
1191 SQL_QUERY_ESC("INSERT INTO `{?_MYSQL_PREFIX?}_surfbar_salts` (`salts_url_id`,`salts_userid`,`salts_last_salt`) VALUES (%s, %s, '%s')",
1196 ), __FUNCTION__, __LINE__);
1200 /* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'affectedRows=' . SQL_AFFECTEDROWS() . ' - EXIT!');
1202 // Return if the update was okay
1203 return (!SQL_HASZEROAFFECTED());
1206 // Check if the reload lock is active for given id
1207 function SURFBAR_CHECK_RELOAD_LOCK ($urlId) {
1208 /* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'id=' . $urlId . ' - ENTERED!');
1210 $result = SQL_QUERY_ESC("SELECT COUNT(`locks_id`) AS cnt
1212 `{?_MYSQL_PREFIX?}_surfbar_locks`
1214 `locks_userid`=%s AND
1215 `locks_url_id`=%s AND
1216 (UNIX_TIMESTAMP() - ".SURFBAR_GET_SURF_LOCK().") < UNIX_TIMESTAMP(`locks_last_surfed`)
1218 `locks_last_surfed` ASC
1220 array(getMemberId(), bigintval($urlId)), __FUNCTION__, __LINE__
1224 list($count) = SQL_FETCHROW($result);
1227 SQL_FREERESULT($result);
1230 /* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'urlId=' . $urlId . ',count=' . $count . ',SURFBAR_GET_SURF_LOCK()=' . SURFBAR_GET_SURF_LOCK() . ' - EXIT!');
1231 return ($count == 1);
1234 // Determine which user hash no more points left
1235 function SURFBAR_DETERMINE_DEPLETED_USERIDS ($limit=0) {
1238 'url_userid' => array(),
1239 'points' => array(),
1240 'notified' => array(),
1243 // Do we have a current user id?
1244 if ((isMember()) && ($limit == '0')) {
1245 // Then add this as well
1246 $userids['url_userid'][getMemberId()] = getMemberId();
1247 $userids['points'][getMemberId()] = getTotalPoints(getMemberId());
1248 $userids['notified'][getMemberId()] = '0';
1250 // Get all userid except logged in one
1251 $result = SQL_QUERY_ESC("SELECT
1252 u.url_userid, UNIX_TIMESTAMP(d.surfbar_low_notified) AS notified
1254 `{?_MYSQL_PREFIX?}_surfbar_urls` AS u
1256 `{?_MYSQL_PREFIX?}_user_data` AS d
1258 u.`url_userid`=d.`userid`
1260 u.`url_userid` NOT IN (%s,0) AND
1261 u.`url_status`='ACTIVE'
1265 u.`url_userid` ASC",
1266 array(getMemberId()), __FUNCTION__, __LINE__);
1269 $result = SQL_QUERY("SELECT
1270 u.url_userid, UNIX_TIMESTAMP(d.surfbar_low_notified) AS notified
1272 `{?_MYSQL_PREFIX?}_surfbar_urls` AS u
1274 `{?_MYSQL_PREFIX?}_user_data` AS d
1276 u.`url_userid`=d.`userid`
1278 u.`url_userid` > 0 AND
1279 u.`url_status`='ACTIVE'
1283 u.`url_userid` ASC", __FUNCTION__, __LINE__);
1287 while ($content = SQL_FETCHARRAY($result)) {
1289 $points = getTotalPoints($content['url_userid']);
1290 /* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'userid=' . $content['url_userid'] . ',points=' . $points);
1292 // Shall we add this to ignore?
1293 if ($points <= $limit) {
1295 /* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'userid=' . $content['url_userid'] . ' has depleted points amount!');
1296 $userids['url_userid'][$content['url_userid']] = $content['url_userid'];
1297 $userids['points'][$content['url_userid']] = $points;
1298 $userids['notified'][$content['url_userid']] = $content['notified'];
1303 SQL_FREERESULT($result);
1306 /* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'UIDs::count=' . count($userids) . ' (with own userid=' . getMemberId() . ')');
1312 // Determine how many users are Online in surfbar
1313 function SURFBAR_DETERMINE_TOTAL_ONLINE () {
1314 // Count all users in surfbar modue and return the value
1315 $result = SQL_QUERY('SELECT
1318 `{?_MYSQL_PREFIX?}_surfbar_stats`
1320 (UNIX_TIMESTAMP() - UNIX_TIMESTAMP(`stats_last_surfed`)) <= {?online_timeout?}
1322 `stats_userid` ASC', __FUNCTION__, __LINE__);
1325 $count = SQL_NUMROWS($result);
1328 SQL_FREERESULT($result);
1334 // Determine waiting time for one URL
1335 function SURFBAR_DETERMINE_WAIT_TIME () {
1336 // Get fixed reload lock
1337 $fixed = SURFBAR_GET_FIXED_RELOAD();
1339 // Is the fixed reload time set?
1345 // Static time is default
1346 $time = getConfig('surfbar_static_time');
1348 // Which payment model do we have?
1349 if (getSurfbarPaymentModel() == 'DYNAMIC') {
1350 // "Calculate" dynamic time
1351 $time += SURFBAR_CALCULATE_DYNAMIC_ADD();
1358 // Changes the status of an URL from given to other
1359 function SURFBAR_CHANGE_STATUS ($urlId, $prevStatus, $newStatus, $data = array()) {
1360 /* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'urlId=' . $urlId . ',prevStatus=' . $prevStatus . ',newStatus=' . $newStatus . ' - ENTERED!');
1361 // Make new status always lower-case
1362 $newStatus = strtolower($newStatus);
1364 // Get URL data for status comparison if missing
1365 if ((!is_array($data)) || (count($data) == 0)) {
1366 // Fetch missing URL data
1367 $data = SURFBAR_GET_URL_DATA($urlId);
1371 $filterData = array(
1373 'prev_status' => $prevStatus,
1374 'new_status' => $newStatus,
1379 // Run pre filter chain
1380 $filterData = runFilterChain('pre_change_surfbar_url_status', $filterData);
1383 if (!is_null($filterData['abort'])) {
1385 return $filterData['abort'];
1388 // Update the status now
1389 // ---------- Comment out for debugging/developing member actions! ---------
1390 SQL_QUERY_ESC("UPDATE `{?_MYSQL_PREFIX?}_surfbar_urls` SET `url_status`='%s' WHERE `url_id`=%s LIMIT 1",
1394 ), __FUNCTION__, __LINE__);
1395 // ---------- Comment out for debugging/developing member actions! ---------
1398 // ---------- Comment out for debugging/developing member actions! ---------
1399 if (SQL_AFFECTEDROWS() != 1) {
1400 // No, something went wrong
1403 // ---------- Comment out for debugging/developing member actions! ---------
1405 // Run post filter chain
1406 $filterData = runFilterChain('post_change_surfbar_url_status', $filterData);
1408 // Extract data from it again
1409 $data = $filterData['data'];
1412 /* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'urlId=' . $urlId . ',prevStatus=' . $prevStatus . ',newStatus=' . $newStatus . ' - EXIT!');
1416 // Calculate minimum value for dynamic payment model
1417 function SURFBAR_CALCULATE_DYNAMIC_MIN_VALUE () {
1418 // Addon is zero by default
1422 $percent = abs(log(getConfig('surfbar_dynamic_percent') / 100 + 1));
1425 $totalUsers = getTotalConfirmedUser();
1428 $onlineUsers = SURFBAR_DETERMINE_TOTAL_ONLINE();
1431 $addon += abs(log($onlineUsers / $totalUsers + 1) * $percent * $totalUsers);
1434 $totalUrls = SURFBAR_GET_TOTAL_URLS('ACTIVE', 0);
1436 // Get user's total URLs
1437 $userUrls = SURFBAR_GET_TOTAL_USER_URLS(0, 'ACTIVE');
1440 if ($totalUrls > 0) {
1441 $addon += abs(log($userUrls / $totalUrls + 1) * $percent * $totalUrls);
1443 $addon += abs(log($userUrls / 1 + 1) * $percent * $totalUrls);
1450 // Calculate maximum value for dynamic payment model
1451 function SURFBAR_CALCULATE_DYNAMIC_MAX_VALUE () {
1452 // Addon is zero by default
1459 $percent = abs(log(getConfig('surfbar_dynamic_percent') / 100 + 1));
1462 $totalUsers = getTotalConfirmedUser();
1465 $addon += abs($max * $percent * $totalUsers);
1468 $totalUrls = SURFBAR_GET_TOTAL_URLS('ACTIVE', 0);
1471 $addon += abs($max * $percent * $totalUrls);
1477 // Calculate dynamic lock
1478 function SURFBAR_CALCULATE_DYNAMIC_LOCK () {
1479 // Default lock is 30 seconds
1483 $onlineUsers = SURFBAR_DETERMINE_TOTAL_ONLINE();
1486 $addon = abs(log($onlineUsers / $addon + 1));
1492 // "Getter" for lock ids array
1493 function SURFBAR_GET_LOCK_IDS () {
1494 // Prepare some arrays
1499 // Get all id from locks within the timestamp
1500 $result = SQL_QUERY_ESC("SELECT
1503 UNIX_TIMESTAMP(`locks_last_surfed`) AS `last_surfed`
1505 `{?_MYSQL_PREFIX?}_surfbar_locks`
1509 `locks_id` ASC", array(getMemberId()),
1510 __FUNCTION__, __LINE__);
1513 while ($content = SQL_FETCHARRAY($result)) {
1515 /* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'next - lid='.$content['locks_id'].',url='.$content['locks_url_id'].',rest='.(time() - $content['last_surfed']).'/'.SURFBAR_GET_SURF_LOCK());
1517 // Skip entries that are too old
1518 if (($content['last_surfed'] > (time() - SURFBAR_GET_SURF_LOCK())) && (!in_array($content['locks_url_id'], $ignored))) {
1520 /* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'okay - lid='.$content['locks_id'].',url='.$content['locks_url_id'].',last='.$content['last_surfed']);
1522 // Add only if missing or bigger
1523 if ((!isset($IDs[$content['locks_url_id']])) || ($IDs[$content['locks_url_id']] > $content['last_surfed'])) {
1525 /* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'ADD - lid='.$content['locks_id'].',url='.$content['locks_url_id'].',last='.$content['last_surfed']);
1528 $IDs[$content['locks_url_id']] = $content['last_surfed'];
1529 $USE[$content['locks_url_id']] = $content['locks_id'];
1533 /* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'ignore - lid='.$content['locks_id'].',url='.$content['locks_url_id'].',last='.$content['last_surfed']);
1535 // Ignore these old entries!
1536 $ignored[] = $content['locks_url_id'];
1537 unset($IDs[$content['locks_url_id']]);
1538 unset($USE[$content['locks_url_id']]);
1543 SQL_FREERESULT($result);
1549 // "Getter" for maximum random number
1550 function SURFBAR_GET_MAX_RANDOM ($userids, $add) {
1551 // Count max availabe entries
1552 $result = SQL_QUERY("SELECT
1555 `{?_MYSQL_PREFIX?}_surfbar_urls` AS sbu
1557 `{?_MYSQL_PREFIX?}_surfbar_salts` AS sbs
1559 sbu.url_id=sbs.salts_url_id
1561 `{?_MYSQL_PREFIX?}_surfbar_locks` AS l
1563 sbu.url_id=l.locks_url_id
1565 sbu.url_userid NOT IN (" . implode(',', $userids) . ") AND
1566 (sbu.url_views_allowed=0 OR (sbu.url_views_allowed > 0 AND sbu.url_views_max > 0)) AND
1567 sbu.url_status='ACTIVE'
1570 sbu.url_id ASC", __FUNCTION__, __LINE__);
1573 /* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'lastQuery='.getConfig('db_last_query').'|numRows='.SQL_NUMROWS($result).'|Affected='.SQL_AFFECTEDROWS());
1576 $maxRand = SQL_NUMROWS($result);
1579 SQL_FREERESULT($result);
1585 // Load all URLs of the current user and return it as an array
1586 function SURFBAR_GET_USER_URLS () {
1588 $urlArray = array();
1591 $result = SQL_QUERY_ESC("SELECT
1598 u.url_views_allowed,
1599 UNIX_TIMESTAMP(u.url_registered) AS `url_registered`,
1600 UNIX_TIMESTAMP(u.`url_last_locked`) AS `url_last_locked`,
1603 `{?_MYSQL_PREFIX?}_surfbar_urls` AS u
1605 u.`url_userid`=%s AND
1606 u.`url_status` != 'DELETED'
1609 array(getMemberId()), __FUNCTION__, __LINE__);
1611 // Are there entries?
1612 if (!SQL_HASZERONUMS($result)) {
1614 while ($row = SQL_FETCHARRAY($result)) {
1616 $urlArray[$row['url_id']] = $row;
1621 SQL_FREERESULT($result);
1627 // "Getter" for member action array for given status
1628 function SURFBAR_GET_ARRAY_FROM_STATUS ($status) {
1630 $returnArray = array();
1632 // Get all assigned actions
1633 $result = SQL_QUERY_ESC("SELECT `actions_action` FROM `{?_MYSQL_PREFIX?}_surfbar_actions` WHERE `actions_status`='%s' ORDER BY `actions_id` ASC",
1634 array($status), __FUNCTION__, __LINE__);
1636 // Some entries there?
1637 if (!SQL_HASZERONUMS($result)) {
1639 // @TODO This can be somehow rewritten
1640 while ($content = SQL_FETCHARRAY($result)) {
1641 $returnArray[] = $content['actions_action'];
1646 SQL_FREERESULT($result);
1649 return $returnArray;
1652 // Reload to configured stop page
1653 function SURFBAR_RELOAD_TO_STOP_PAGE ($page = 'stop') {
1654 // Internal or external?
1655 /* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'page=' . $page . ' - ENTERED!');
1656 if ((getConfig('surfbar_pause_mode') == 'INTERNAL') || (getConfig('surfbar_pause_url') == '')) {
1657 // Reload to internal page
1658 redirectToUrl('surfbar.php?frame=' . $page);
1660 // Reload to external page
1661 redirectToConfiguredUrl('surfbar_pause_url');
1665 // Determine next id for surfbar or get data for given id, always call this before you call other
1666 // getters below this function!
1667 function SURFBAR_DETERMINE_NEXT_ID ($urlId = NULL) {
1668 /* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'urlId=' . $urlId . ' - ENTERED!');
1669 // Default is no id and no random number
1674 if (is_null($urlId)) {
1675 // Get array with lock ids
1676 $USE = SURFBAR_GET_LOCK_IDS();
1678 // Shall we add some URL ids to ignore?
1680 if (count($USE) > 0) {
1682 $add = " AND sbu.`url_id` NOT IN (";
1683 foreach ($USE as $url_id => $lid) {
1685 $add .= $url_id.',';
1688 // Add closing bracket
1689 $add = substr($add, 0, -1) . ')';
1692 // Determine depleted user account
1693 $userids = SURFBAR_DETERMINE_DEPLETED_USERIDS();
1695 // Get maximum randomness factor
1696 $maxRand = SURFBAR_GET_MAX_RANDOM($userids['url_userid'], $add);
1698 // If more than one URL can be called generate the random number!
1700 // Generate random number
1701 $randNum = mt_rand(0, ($maxRand - 1));
1704 // And query the database
1705 /* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'randNum='.$randNum.',maxRand='.$maxRand.',surfLock='.SURFBAR_GET_SURF_LOCK());
1706 $result = SQL_QUERY_ESC("SELECT
1710 sbs.salts_last_salt,
1711 sbu.url_views_total,
1713 sbu.url_views_allowed,
1714 UNIX_TIMESTAMP(l.locks_last_surfed) AS last_surfed,
1715 sbu.url_fixed_reload
1717 `{?_MYSQL_PREFIX?}_surfbar_urls` AS sbu
1719 `{?_MYSQL_PREFIX?}_surfbar_salts` AS sbs
1721 sbu.url_id=sbs.salts_url_id
1723 `{?_MYSQL_PREFIX?}_surfbar_locks` AS l
1725 sbu.url_id=l.locks_url_id
1727 sbu.`url_userid` NOT IN (".implode(',', $userids['url_userid']).") AND
1728 sbu.url_status='ACTIVE' AND
1729 (sbu.url_views_allowed=0 OR (sbu.url_views_allowed > 0 AND sbu.url_views_max > 0))
1734 l.locks_last_surfed ASC,
1737 array($randNum), __FUNCTION__, __LINE__
1740 // Get data from specified id number
1741 $result = SQL_QUERY_ESC("SELECT
1745 sbs.salts_last_salt,
1746 sbu.url_views_total,
1748 sbu.url_views_allowed,
1749 UNIX_TIMESTAMP(l.locks_last_surfed) AS last_surfed,
1750 sbu.url_fixed_reload
1752 `{?_MYSQL_PREFIX?}_surfbar_urls` AS sbu
1754 `{?_MYSQL_PREFIX?}_surfbar_salts` AS sbs
1756 sbu.url_id=sbs.salts_url_id
1758 `{?_MYSQL_PREFIX?}_surfbar_locks` AS l
1760 sbu.url_id=l.locks_url_id
1762 sbu.url_userid != %s AND
1763 sbu.url_status='ACTIVE' AND
1765 (sbu.url_views_allowed=0 OR (sbu.url_views_allowed > 0 AND sbu.url_views_max > 0))
1767 array(getMemberId(), bigintval($urlId)), __FUNCTION__, __LINE__
1771 // Is there an id number?
1772 /* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'lastQuery='.getConfig('db_last_query').'|numRows='.SQL_NUMROWS($result).'|Affected='.SQL_AFFECTEDROWS());
1773 if (SQL_NUMROWS($result) == 1) {
1775 /* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'count('.count($GLOBALS['surfbar_cache']).') - BEFORE', false);
1776 $GLOBALS['surfbar_cache'] = merge_array($GLOBALS['surfbar_cache'], SQL_FETCHARRAY($result));
1777 /* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'count('.count($GLOBALS['surfbar_cache']).') - AFTER', false);
1779 // Determine waiting time
1780 $GLOBALS['surfbar_cache']['time'] = SURFBAR_DETERMINE_WAIT_TIME();
1782 // Is the last salt there?
1783 if (is_null($GLOBALS['surfbar_cache']['salts_last_salt'])) {
1784 // Then repair it wit the static!
1785 /* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'last_salt - FIXED!', false);
1786 $GLOBALS['surfbar_cache']['salts_last_salt'] = '';
1789 // Fix missing last_surfed
1790 if ((!isset($GLOBALS['surfbar_cache']['last_surfed'])) || (is_null($GLOBALS['surfbar_cache']['last_surfed']))) {
1792 /* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'last_surfed - FIXED!', false);
1793 $GLOBALS['surfbar_cache']['last_surfed'] = '0';
1796 // Get base/fixed reward and costs
1797 $GLOBALS['surfbar_cache']['reward'] = SURFBAR_DETERMINE_REWARD();
1798 $GLOBALS['surfbar_cache']['costs'] = SURFBAR_DETERMINE_COSTS();
1799 /* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'BASE/STATIC - reward='.SURFBAR_GET_REWARD().'|costs='.SURFBAR_GET_COSTS());
1801 // Only in dynamic model add the dynamic bonus!
1802 if (getSurfbarPaymentModel() == 'DYNAMIC') {
1803 // Calculate dynamic reward/costs and add it
1804 $GLOBALS['surfbar_cache']['reward'] += SURFBAR_CALCULATE_DYNAMIC_ADD();
1805 $GLOBALS['surfbar_cache']['costs'] += SURFBAR_CALCULATE_DYNAMIC_ADD();
1806 /* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'DYNAMIC+ - reward='.SURFBAR_GET_REWARD().'|costs='.SURFBAR_GET_COSTS());
1810 $nextId = SURFBAR_GET_ID();
1814 SQL_FREERESULT($result);
1817 /* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'urlId=' . $urlId . ',nextId=' . $nextId . ' - EXIT!');
1821 //-----------------------------------------------------------------------------
1823 //-----------------------------------------------------------------------------
1825 // "Getter" for surfbar_dynamic_percent
1826 function getSurfbarDynamicPercent () {
1827 // Do we have cache?
1828 if (!isset($GLOBALS[__FUNCTION__])) {
1830 $GLOBALS[__FUNCTION__] = getConfig('surfbar_dynamic_percent');
1834 return $GLOBALS[__FUNCTION__];
1837 // "Getter" for surfbar_static_reward
1838 function getSurfbarStaticReward () {
1839 // Do we have cache?
1840 if (!isset($GLOBALS[__FUNCTION__])) {
1842 $GLOBALS[__FUNCTION__] = getConfig('surfbar_static_reward');
1846 return $GLOBALS[__FUNCTION__];
1849 // "Getter" for surfbar_static_time
1850 function getSurfbarStaticTime () {
1851 // Do we have cache?
1852 if (!isset($GLOBALS[__FUNCTION__])) {
1854 $GLOBALS[__FUNCTION__] = getConfig('surfbar_static_time');
1858 return $GLOBALS[__FUNCTION__];
1861 // "Getter" for surfbar_max_order
1862 function getSurfbarMaxOrder () {
1863 // Do we have cache?
1864 if (!isset($GLOBALS[__FUNCTION__])) {
1866 $GLOBALS[__FUNCTION__] = getConfig('surfbar_max_order');
1870 return $GLOBALS[__FUNCTION__];
1873 // "Getter" for surfbar_payment_model
1874 function getSurfbarPaymentModel () {
1875 // Do we have cache?
1876 if (!isset($GLOBALS[__FUNCTION__])) {
1878 $GLOBALS[__FUNCTION__] = getConfig('surfbar_payment_model');
1882 return $GLOBALS[__FUNCTION__];
1885 //------------------------------------------------------------------------------
1886 // PLEASE DO NOT ADD ANY OTHER FUNCTIONS BELOW THIS LINE IF THEY DON'T "WRAP"
1887 // THE $GLOBALS['surfbar_cache'] ARRAY!
1888 //------------------------------------------------------------------------------
1890 // Initializes the surfbar
1891 function SURFBAR_INIT () {
1893 $GLOBALS['surfbar_cache'] = array();
1896 // Private getter for data elements
1897 function SURFBAR_GET_DATA ($element) {
1898 /* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'element=' . $element . ' - ENTERED!');
1903 // Is the entry there?
1904 if (isset($GLOBALS['surfbar_cache'][$element])) {
1906 $data = $GLOBALS['surfbar_cache'][$element];
1907 } else { // END - if
1909 print_r($GLOBALS['surfbar_cache']);
1911 debug_report_bug(__FUNCTION__, __LINE__, 'Element ' . $element . ' not found.');
1915 /* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'element[' . $element . ']=[' . gettype($data) . ']' . $data . ' - EXIT!');
1919 // Getter for reward from cache
1920 function SURFBAR_GET_REWARD () {
1921 // Get data element and return its contents
1922 return SURFBAR_GET_DATA('reward');
1925 // Getter for costs from cache
1926 function SURFBAR_GET_COSTS () {
1927 // Get data element and return its contents
1928 return SURFBAR_GET_DATA('costs');
1931 // Getter for URL from cache
1932 function SURFBAR_GET_URL () {
1933 // Get data element and return its contents
1934 return SURFBAR_GET_DATA('url');
1937 // Getter for salt from cache
1938 function SURFBAR_GET_SALT () {
1939 // Get data element and return its contents
1940 return SURFBAR_GET_DATA('salt');
1943 // Getter for id from cache
1944 function SURFBAR_GET_ID () {
1945 // Get data element and return its contents
1946 return SURFBAR_GET_DATA('url_id');
1949 // Getter for userid from cache
1950 function SURFBAR_GET_USERID () {
1951 // Get data element and return its contents
1952 return SURFBAR_GET_DATA('url_userid');
1955 // Getter for user reload locks
1956 function SURFBAR_GET_USER_LOCKS () {
1957 // Get data element and return its contents
1958 return SURFBAR_GET_DATA('user_locks');
1961 // Getter for reload time
1962 function SURFBAR_GET_RELOAD_TIME () {
1963 // Get data element and return its contents
1964 return SURFBAR_GET_DATA('time');
1967 // Getter for allowed views
1968 function SURFBAR_GET_VIEWS_ALLOWED () {
1969 // Get data element and return its contents
1970 return SURFBAR_GET_DATA('url_views_allowed');
1973 // Getter for maximum views
1974 function SURFBAR_GET_VIEWS_MAX () {
1975 // Get data element and return its contents
1976 return SURFBAR_GET_DATA('url_views_max');
1979 // Getter for fixed reload
1980 function SURFBAR_GET_FIXED_RELOAD () {
1981 // Get data element and return its contents
1982 return SURFBAR_GET_DATA('url_fixed_reload');
1985 // Getter for surf lock
1986 function SURFBAR_GET_SURF_LOCK () {
1987 // Get data element and return its contents
1988 return SURFBAR_GET_DATA('surf_lock');
1991 // Getter for new status
1992 function SURFBAR_GET_NEW_STATUS () {
1993 // Get data element and return its contents
1994 return SURFBAR_GET_DATA('new_status');
1997 // Getter for last salt
1998 function SURFBAR_GET_LAST_SALT () {
1999 // Get data element and return its contents
2000 return SURFBAR_GET_DATA('salts_last_salt');