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 `{?_MYSQL_PREFIX?}_surfbar_urls` SET `url`='%s', `url_views_allowed`=%s, `url_views_max`=%s WHERE `url_id`=%s AND `status`='%s' LIMIT 1",
445 array($urlData['url'], $urlData['edit']['limit'], $urlData['edit']['limit'], $urlData['id'], $urlData['url_status']), __FUNCTION__, __LINE__);
454 // "Execute delete" function: Does nothing...
455 function SURFBAR_MEMBER_EXECUTE_DELETE_ACTION ($urlData) {
456 // Nothing special to do (see above function for such "special actions" to perform)
460 //------------------------------------------------------------------------------
461 // Self-maintenance functions
462 //------------------------------------------------------------------------------
465 function SURFBAR_HANDLE_SELF_MAINTENANCE () {
466 // Handle URLs which limit has depleted so we can stop them
467 SURFBAR_HANDLE_DEPLETED_VIEWS();
469 // Handle low-points amounts
470 SURFBAR_HANDLE_LOW_POINTS();
473 // Handle URLs which limit has depleted
474 function SURFBAR_HANDLE_DEPLETED_VIEWS () {
476 $urlArray = SURFBAR_GET_URL_DATA(0, 'url_views_max', 'url_id', 'ASC', 'url_id', " AND `url_views_allowed` > 0 AND `url_status`='ACTIVE'");
478 // Do we have some entries?
479 if (count($urlArray) > 0) {
481 foreach ($urlArray as $id => $urlData) {
485 // Rewrite array for next call
491 SURFBAR_CHANGE_STATUS($id, 'ACTIVE', 'DEPLETED', $urlData);
496 // Alert users which have URLs booked and are low on points amount
497 function SURFBAR_HANDLE_LOW_POINTS () {
499 $userids = SURFBAR_DETERMINE_DEPLETED_USERIDS(getConfig('surfbar_warn_low_points'));
501 // "Walk" through all URLs
502 foreach ($userids['url_userid'] as $userid => $dummy) {
503 // Is the last notification far enougth away to notify again?
504 if ((time() - $userids['notified'][$userid]) >= getConfig('surfbar_low_interval')) {
507 'url_userid' => $userid,
508 'points' => $userids['points'][$userid],
509 'notified' => $userids['notified'][$userid]
513 SURFBAR_NOTIFY_USER('low_points', $content);
515 // Update last notified
516 SQL_QUERY_ESC("UPDATE `{?_MYSQL_PREFIX?}_user_data` SET `surfbar_low_notified`=NOW() WHERE `userid`=%s LIMIT 1",
517 array($userid), __FUNCTION__, __LINE__);
523 //------------------------------------------------------------------------------
525 //------------------------------------------------------------------------------
528 // Looks up by an URL
529 function SURFBAR_LOOKUP_BY_URL ($url, $userid) {
530 // Now lookup that given URL by itself
531 $urlArray = SURFBAR_GET_URL_DATA($url, 'url', 'url_id', 'ASC', 'url_id', sprintf(" AND `url_userid`=%s", bigintval($userid)));
534 return (count($urlArray) > 0);
537 // Load URL data by given search term and column
538 function SURFBAR_GET_URL_DATA ($searchTerm, $column = 'url_id', $order = 'url_id', $sort = 'ASC', $group = 'url_id', $add = '') {
539 // By default nothing is found
540 $GLOBALS['last_url_data'] = array();
542 // Is the column an id number?
543 if (($column == 'url_id') || ($column == 'url_userid')) {
544 // Extra secure input
545 $searchTerm = bigintval($searchTerm);
548 // If the column is 'id' there can be only one entry
550 if ($column == 'id') {
554 // Look up the record
555 $result = SQL_QUERY_ESC("SELECT
563 UNIX_TIMESTAMP(`url_registered`) AS `url_registered`,
564 UNIX_TIMESTAMP(`url_last_locked`) AS `url_last_locked`,
570 `{?_MYSQL_PREFIX?}_surfbar_urls`
572 `%s`='%s'" . $add . "
582 ), __FUNCTION__, __LINE__);
584 // Is there at least one record?
585 if (!SQL_HASZERONUMS($result)) {
587 while ($dataRow = SQL_FETCHARRAY($result)) {
588 // Shall we group these results?
589 if ($group == 'url_id') {
590 // Add the row by id as index
591 $GLOBALS['last_url_data'][$dataRow['url_id']] = $dataRow;
594 $GLOBALS['last_url_data'][$dataRow[$group]][$dataRow['url_id']] = $dataRow;
600 SQL_FREERESULT($result);
603 return $GLOBALS['last_url_data'];
606 // Registers an URL with the surfbar. You should have called SURFBAR_LOOKUP_BY_URL() first!
607 function SURFBAR_REGISTER_URL ($url, $userid, $status = 'PENDING', $addMode = 'reg', $extraFields = array()) {
608 // Make sure by the user registered URLs are always pending
609 if ($addMode == 'reg') {
614 $content = merge_array($extraFields, array(
616 'url_userid' => $userid,
617 'url_status' => $status,
620 // Is limit/reload set?
621 if (!isset($content['limit'])) {
622 $content['limit'] = '0';
624 if (!isset($content['reload'])) {
625 $content['reload'] = '0';
628 // Insert the URL into database
629 $content['insert_id'] = SURFBAR_INSERT_URL_BY_ARRAY($content);
632 if ($content['insert_id'] == '0') {
633 // INSERT did not insert any data!
637 // If in reg-mode we notify admin
638 if (($addMode == 'reg') || (getConfig('surfbar_notify_admin_unlock') == 'Y')) {
639 // Notify admin even when he as unlocked an email
640 SURFBAR_NOTIFY_ADMIN('url_' . $addMode, $content);
644 SURFBAR_NOTIFY_USER('url_' . $addMode, $content);
646 // Return the insert id
647 return $content['insert_id'];
650 // Inserts an url by given data array and return the insert id
651 function SURFBAR_INSERT_URL_BY_ARRAY ($urlData) {
653 $userid = bigintval($urlData['url_userid']);
656 if (empty($userid)) {
660 // Just run the insert query for now
661 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)",
665 $urlData['url_status'],
669 ), __FUNCTION__, __LINE__
673 return SQL_INSERTID();
676 // Notify admin(s) with a selected message and content
677 function SURFBAR_NOTIFY_ADMIN ($messageType, $content) {
678 // Prepare template name
679 $templateName = sprintf("admin_surfbar_%s", $messageType);
682 $subject = sprintf("{--ADMIN_SURFBAR_NOTIFY_%s_SUBJECT--}",
683 strtoupper($messageType)
686 // Is the subject line there?
687 if ((substr($subject, 0, 1) == '!') && (substr($subject, -1, 1) == '!')) {
688 // Set default subject if following eval() wents wrong
689 $subject = '{%message,ADMIN_SURFBAR_NOTIFY_DEFAULT_SUBJECT=' . strtoupper($messageType) . '%}';
692 // Translate some data if present
693 $content = SURFBAR_PREPARE_CONTENT_FOR_TEMPLATE($content);
695 // Send the notification out
696 return sendAdminNotification($subject, $templateName, $content, $content['url_userid']);
699 // Notify the user about the performed action
700 function SURFBAR_NOTIFY_USER ($messageType, $content) {
701 // Skip notification if userid is zero
702 if ($content['url_userid'] == '0') {
706 // Prepare template name
707 $templateName = sprintf("member_surfbar_%s", $messageType);
710 $subject = sprintf("{--MEMBER_SURFBAR_NOTIFY_%s_SUBJECT--}",
711 strtoupper($messageType)
714 // Is the subject line there?
715 if ((substr($subject, 0, 1) == '!') && (substr($subject, -1, 1) == '!')) {
716 // Set default subject if following eval() wents wrong
717 $subject = '{--MEMBER_SURFBAR_NOTIFY_DEFAULT_SUBJECT--}';
720 // Translate some data if present
721 $content = SURFBAR_PREPARE_CONTENT_FOR_TEMPLATE($content);
724 $mailText = loadEmailTemplate($templateName, $content, $content['url_userid']);
727 return sendEmail($content['url_userid'], $subject, $mailText);
730 // Translates some data for template usage
731 // @TODO Can't we use our new expression language instead of this ugly code?
732 function SURFBAR_PREPARE_CONTENT_FOR_TEMPLATE ($content) {
734 if (isset($content['url_registered'])) $content['url_registered'] = generateDateTime($content['url_registered'], 2);
735 if (isset($content['url_last_locked'])) $content['url_last_locked'] = generateDateTime($content['url_last_locked'], 2);
737 // Return translated content
741 // Translates the limit
742 function translateSurfbarLimit ($limit) {
746 $return = '{--MEMBER_SURFBAR_UNLIMITED_VIEWS--}';
749 $return = '{%pipe,translateComma=' . $limit . '%}';
756 // Translate the URL status
757 function translateSurfbarUrlStatus ($status) {
758 // NULL must be handled carfefully
759 if ((is_null($status)) || (trim($status) == '')) {
760 // Is NULL, so return other language string
761 return '{--SURFBAR_URL_STATUS_NONE--}';
763 // Return regular result
764 return sprintf("{--SURFBAR_URL_STATUS_%s--}", strtoupper($status));
768 // Translates the given action into a link title for members
769 function translateMemberSurfbarActionToTitle ($action) {
771 if (!isset($GLOBALS[__FUNCTION__][$action])) {
772 // Construct default return string (unknown
773 $GLOBALS[__FUNCTION__][$action] = '{%message,MEMBER_SURFBAR_ACTION_UNKNOWN_TITLE=' . $action . '%}';
775 // ... and the id's name
776 $messageId = 'MEMBER_SURFBAR_ACTION_' . strtoupper($action) . '_TITLE';
779 if (isMessageIdValid($messageId)) {
781 $GLOBALS[__FUNCTION__][$action] = '{--' . $messageId . '--}';
786 return $GLOBALS[__FUNCTION__][$action];
789 // Translates the given action into a submit button for members
790 function translateMemberSurfbarActionToSubmit ($action) {
792 if (!isset($GLOBALS[__FUNCTION__][$action])) {
793 // Construct default return string (unknown
794 $GLOBALS[__FUNCTION__][$action] = '{%message,MEMBER_SURFBAR_ACTION_UNKNOWN_SUBMIT=' . $action . '%}';
796 // ... and the id's name
797 $messageId = 'MEMBER_SURFBAR_ACTION_' . strtoupper($action) . '_SUBMIT';
800 if (isMessageIdValid($messageId)) {
802 $GLOBALS[__FUNCTION__][$action] = '{--' . $messageId . '--}';
807 return $GLOBALS[__FUNCTION__][$action];
811 function SURFBAR_DETERMINE_REWARD ($onlyMin = false) {
812 // Static values are default
813 $reward = getConfig('surfbar_static_reward');
815 // Do we have static or dynamic?
816 if (getSurfbarPaymentModel() == 'DYNAMIC') {
817 // "Calculate" dynamic reward
818 if ($onlyMin === true) {
819 $reward += SURFBAR_CALCULATE_DYNAMIC_MIN_VALUE();
821 $reward += SURFBAR_CALCULATE_DYNAMIC_ADD();
830 function SURFBAR_DETERMINE_COSTS ($onlyMin=false) {
831 // Static costs is default
832 $costs = getConfig('surfbar_static_costs');
834 // Do we have static or dynamic?
835 if (getSurfbarPaymentModel() == 'DYNAMIC') {
836 // "Calculate" dynamic costs
838 $costs += SURFBAR_CALCULATE_DYNAMIC_MIN_VALUE();
840 $costs += SURFBAR_CALCULATE_DYNAMIC_ADD();
848 // "Calculate" dynamic add
849 function SURFBAR_CALCULATE_DYNAMIC_ADD () {
850 // Get min/max values
851 $min = SURFBAR_CALCULATE_DYNAMIC_MIN_VALUE();
852 $max = SURFBAR_CALCULATE_DYNAMIC_MAX_VALUE();
854 // "Calculate" dynamic part and return it
855 return mt_rand($min, $max);
858 // Determine right template name
859 function SURFBAR_DETERMINE_TEMPLATE_NAME() {
860 // Default is the frameset
861 $templateName = 'surfbar_frameset';
863 // Any frame set? ;-)
864 if (isGetRequestElementSet('frame')) {
865 // Use the frame as a template name part... ;-)
866 $templateName = sprintf("surfbar_frame_%s",
867 getRequestElement('frame')
872 return $templateName;
875 // Check if the "reload lock" of the current user is full, call this function
876 // before you call SURFBAR_CHECK_RELOAD_LOCK().
877 function SURFBAR_CHECK_RELOAD_FULL () {
878 /* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'Fixed surf lock is ' . getConfig('surfbar_static_lock') . ' - ENTERED!');
882 // Cache static reload lock
883 $GLOBALS['surfbar_cache']['surf_lock'] = getConfig('surfbar_static_lock');
885 // Do we have dynamic model?
886 /* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'surf_lock=' . $GLOBALS['surfbar_cache']['surf_lock'] . ' - BEFORE');
887 if (getSurfbarPaymentModel() == 'DYNAMIC') {
888 // "Calculate" dynamic lock
889 $GLOBALS['surfbar_cache']['surf_lock'] += SURFBAR_CALCULATE_DYNAMIC_ADD();
891 /* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'surf_lock=' . $GLOBALS['surfbar_cache']['surf_lock'] . ' - AFTER');
894 $result = SQL_QUERY_ESC("SELECT
895 COUNT(l.`locks_id`) AS `cnt`
897 `{?_MYSQL_PREFIX?}_surfbar_locks` AS l
899 `{?_MYSQL_PREFIX?}_surfbar_urls` AS u
901 u.`url_id`=l.`locks_url_id`
903 l.`locks_userid`=%s AND
904 (UNIX_TIMESTAMP() - {%%pipe,SURFBAR_GET_SURF_LOCK%%}) < UNIX_TIMESTAMP(l.`locks_last_surfed`) AND
906 ((UNIX_TIMESTAMP(l.`locks_last_surfed`) - u.`url_fixed_reload`) < 0 AND u.`url_fixed_reload` > 0) OR
907 u.`url_fixed_reload` = 0
910 array(getMemberId()), __FUNCTION__, __LINE__
914 list($GLOBALS['surfbar_cache']['user_locks']) = SQL_FETCHROW($result);
917 if (is_null($GLOBALS['surfbar_cache']['user_locks'])) {
918 // Then fix it to zero!
919 $GLOBALS['surfbar_cache']['user_locks'] = '0';
923 SQL_FREERESULT($result);
926 $total = SURFBAR_GET_TOTAL_URLS();
928 // Do we have some URLs in lock? Admins can always surf on own URLs!
929 $isFull = ((SURFBAR_GET_USER_LOCKS() == $total) && ($total > 0));
932 /* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'userLocks=' . SURFBAR_GET_USER_LOCKS() . ',total=' . $total . 'isFull=' . intval($isFull) . ' - EXIT!');
936 // Get total amount of URLs of given status for current user or of ACTIVE URLs by default
937 function SURFBAR_GET_TOTAL_URLS ($status = 'ACTIVE', $excludeUserId = '0') {
938 // Determine depleted user account
939 $userids = SURFBAR_DETERMINE_DEPLETED_USERIDS();
941 // If we dont get any user ids back, there are no URLs
942 if (count($userids['url_userid']) == 0) {
943 // No user ids found, no URLs!
947 // Is the exlude userid set?
948 if (isValidUserId($excludeUserId)) {
950 $userids['url_userid'][$excludeUserId] = $excludeUserId;
953 // Get amount from database
954 $result = SQL_QUERY_ESC("SELECT
955 COUNT(`url_id`) AS cnt
957 `{?_MYSQL_PREFIX?}_surfbar_urls`
959 `url_userid` NOT IN (".implode(', ', $userids['url_userid']).") AND
962 array($status), __FUNCTION__, __LINE__
966 list($count) = SQL_FETCHROW($result);
969 SQL_FREERESULT($result);
972 /* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'cnt=' . $count);
978 // Check wether the user is allowed to book more URLs
979 function SURFBAR_IF_USER_BOOK_MORE_URLS ($userid = NULL) {
980 // Is this admin and userid is zero or does the user has some URLs left to book?
981 return (((is_null($userid)) && (isAdmin())) || (SURFBAR_GET_TOTAL_USER_URLS($userid, '', array('REJECTED')) < getSurfbarMaxOrder()));
984 // Get total amount of URLs of given status for current user
985 function SURFBAR_GET_TOTAL_USER_URLS ($userid = NULL, $status = '', $exclude = '') {
986 // Is the user 0 and user is logged in?
987 if ((is_null($userid)) && (isMember())) {
988 // Then use this userid
989 $userid = getMemberId();
990 } elseif (is_null($userid)) {
992 return (getSurfbarMaxOrder() + 1);
995 // Default is all URLs
998 // Is the status set?
999 if (is_array($status)) {
1000 // Only URLs with these status
1001 $add = sprintf(" WHERE `url_status` IN('%s')", implode("','", $status));
1002 } elseif (!empty($status)) {
1003 // Only URLs with this status
1004 $add = sprintf(" WHERE `url_status`='%s'", $status);
1005 } elseif (is_array($exclude)) {
1006 // Exclude URLs with these status
1007 $add = sprintf(" WHERE `url_status` NOT IN('%s')", implode("','", $exclude));
1008 } elseif (!empty($exclude)) {
1009 // Exclude URLs with this status
1010 $add = sprintf(" WHERE `url_status` != '%s'", $exclude);
1013 // Get amount from database
1014 $count = countSumTotalData($userid, 'surfbar_urls', 'url_id', 'url_userid', true, $add);
1020 // Generate a validation code for the given id number
1021 function SURFBAR_GENERATE_VALIDATION_CODE ($urlId, $salt = '') {
1022 /* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'urlId=' . $urlId . ',salt=' . $salt . ' - ENTERED!');
1023 // Init hash with invalid value
1025 // Generate random hashed string
1026 $GLOBALS['surfbar_cache']['salt'] = sha1(generatePassword(mt_rand(200, 255)));
1027 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'newSalt='.SURFBAR_GET_SALT().'', false);
1029 // Use this as salt!
1030 $GLOBALS['surfbar_cache']['salt'] = $salt;
1031 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'oldSalt='.SURFBAR_GET_SALT().'', false);
1034 // Hash it with md5() and salt it with the random string
1035 $hashedCode = generateHash(md5($urlId . getEncryptSeperator() . getMemberId()), 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__, 'urlId=' . $urlId . ',salt=' . $salt . ',urlId=' . $urlId . ',salt=' . $salt . ',valHashedCode=' . $valHashedCode . ' - EXIT!');
1042 return $valHashedCode;
1045 // Check validation code
1046 function SURFBAR_CHECK_VALIDATION_CODE ($urlId, $check, $salt) {
1047 /* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'urlId=' . $urlId . ',check=' . $check . ',salt=' . $salt . ' - ENTERED!');
1049 $urlId = bigintval($urlId);
1051 // Now generate the code again
1052 $code = SURFBAR_GENERATE_VALIDATION_CODE($urlId, $salt);
1054 // Return result of checking hashes and salts
1055 /* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'urlId=' . $urlId . ',(code==check)=' . intval($code == $check) . ',(salt==salts_last_salt)=' . intval($salt == SURFBAR_GET_DATA('salts_last_salt')) . ' - EXIT!');
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: */ logDebugMessage(__FUNCTION__, __LINE__, 'urlId=' . $urlId . ',getMemberId()=' . getMemberId() . ' - ENTERED!');
1062 // Search for an entry
1063 $countLock = countSumTotalData(getMemberId(), 'surfbar_locks', 'locks_id', 'locks_userid', true, ' AND `locks_url_id`=' . bigintval($urlId));
1065 // Do we have no record?
1066 if ($countLock == 0) {
1067 // Just add it to the database
1068 SQL_QUERY_ESC('INSERT INTO `{?_MYSQL_PREFIX?}_surfbar_locks` (`locks_userid`,`locks_url_id`) VALUES (%s, %s)',
1072 ), __FUNCTION__, __LINE__);
1075 // Remove the salt from database
1076 SQL_QUERY_ESC('DELETE LOW_PRIORITY FROM `{?_MYSQL_PREFIX?}_surfbar_salts` WHERE `salts_url_id`=%s AND `salts_userid`=%s LIMIT 1',
1080 ), __FUNCTION__, __LINE__);
1082 /* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'urlId=' . $urlId . ',getMemberId()=' . getMemberId() . ',SQL_AFFECTEDROWS()=' . SQL_AFFECTEDROWS() . ' - EXIT!');
1085 // Pay points to the user and remove it from the sender if userid is given else it is a "sponsored surf"
1086 function SURFBAR_PAY_POINTS () {
1087 // Remove it from the URL owner
1088 /* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'userid='.SURFBAR_GET_USERID().',costs='.SURFBAR_GET_COSTS() . ' - ENTERED!');
1089 if (isValidUserId(SURFBAR_GET_USERID())) {
1090 // Subtract points and ignore return status
1091 subtractPoints(sprintf("surfbar_%s", getSurfbarPaymentModel()), SURFBAR_GET_USERID(), SURFBAR_GET_COSTS());
1094 /* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'userid='.getMemberId().',reward='.SURFBAR_GET_REWARD());
1095 // Init referal system here
1096 initReferalSystem();
1098 // Book it to the user and ignore return status
1099 addPointsThroughReferalSystem(sprintf("surfbar:%s", getSurfbarPaymentModel()), getMemberId(), SURFBAR_GET_REWARD());
1100 /* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'userid='.SURFBAR_GET_USERID().',costs='.SURFBAR_GET_COSTS() . ' - EXIT!');
1103 // Updates the statistics of current URL/userid
1104 function SURFBAR_UPDATE_INSERT_STATS_RECORD () {
1108 // Get allowed views
1109 $allowed = SURFBAR_GET_VIEWS_ALLOWED();
1111 // Do we have a limit?
1113 // Then count views_max down!
1114 $add .= ', `url_views_max`=`url_views_max`-1';
1118 SQL_QUERY_ESC('UPDATE `{?_MYSQL_PREFIX?}_surfbar_urls` SET `url_views_total`=`url_views_total`+1' . $add . ' WHERE `url_id`=%s LIMIT 1',
1119 array(SURFBAR_GET_ID()), __FUNCTION__, __LINE__);
1121 // Update the stats entry
1122 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',
1126 ), __FUNCTION__, __LINE__);
1128 // Was that update okay?
1129 if (SQL_HASZEROAFFECTED()) {
1130 // No, then insert entry
1131 SQL_QUERY_ESC('INSERT INTO `{?_MYSQL_PREFIX?}_surfbar_stats` (`stats_userid`,`stats_url_id`,`stats_count`) VALUES (%s,%s,1)',
1135 ), __FUNCTION__, __LINE__);
1138 // Update total/daily/weekly/monthly counter
1139 incrementConfigEntry('surfbar_total_counter');
1140 incrementConfigEntry('surfbar_daily_counter');
1141 incrementConfigEntry('surfbar_weekly_counter');
1142 incrementConfigEntry('surfbar_monthly_counter');
1144 // Update config as well
1145 updateConfiguration(array('surfbar_total_counter', 'surfbar_daily_counter', 'surfbar_weekly_counter', 'surfbar_monthly_counter'), array(1,1,1,1), '+');
1148 // Update the salt for validation and statistics
1149 function SURFBAR_UPDATE_SALT_STATS () {
1151 SURFBAR_GENERATE_VALIDATION_CODE(SURFBAR_GET_ID());
1153 // Make sure only valid salts can pass
1154 if (SURFBAR_GET_SALT() == 'INVALID') {
1156 debug_report_bug(__FUNCTION__, __LINE__, 'Invalid salt provided, id=' . SURFBAR_GET_ID() . ',getMemberId()=' . getMemberId());
1159 // Update statistics record
1160 SURFBAR_UPDATE_INSERT_STATS_RECORD();
1162 // Simply store the salt from cache away in database...
1163 SQL_QUERY_ESC("UPDATE `{?_MYSQL_PREFIX?}_surfbar_salts` SET `salts_last_salt`='%s' WHERE `salts_url_id`=%s AND `salts_userid`=%s LIMIT 1",
1168 ), __FUNCTION__, __LINE__);
1171 /* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'salt=' . SURFBAR_GET_SALT() . ',id=' . SURFBAR_GET_ID() . ',userid=' . getMemberId() . ',SQL_AFFECTEDROWS()=' . SQL_AFFECTEDROWS() . ' - UPDATE!');
1174 if (SQL_HASZEROAFFECTED()) {
1175 // Insert missing entry!
1176 SQL_QUERY_ESC("INSERT INTO `{?_MYSQL_PREFIX?}_surfbar_salts` (`salts_url_id`,`salts_userid`,`salts_last_salt`) VALUES (%s, %s, '%s')",
1181 ), __FUNCTION__, __LINE__);
1185 /* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'affectedRows=' . SQL_AFFECTEDROWS() . ' - EXIT!');
1187 // Return if the update was okay
1188 return (!SQL_HASZEROAFFECTED());
1191 // Check if the reload lock is active for given id
1192 function SURFBAR_CHECK_RELOAD_LOCK ($urlId) {
1193 /* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'id=' . $urlId . ' - ENTERED!');
1195 $result = SQL_QUERY_ESC("SELECT COUNT(`locks_id`) AS cnt
1197 `{?_MYSQL_PREFIX?}_surfbar_locks`
1199 `locks_userid`=%s AND
1200 `locks_url_id`=%s AND
1201 (UNIX_TIMESTAMP() - ".SURFBAR_GET_SURF_LOCK().") < UNIX_TIMESTAMP(`locks_last_surfed`)
1203 `locks_last_surfed` ASC
1205 array(getMemberId(), bigintval($urlId)), __FUNCTION__, __LINE__
1209 list($count) = SQL_FETCHROW($result);
1212 SQL_FREERESULT($result);
1215 /* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'urlId=' . $urlId . ',count=' . $count . ',SURFBAR_GET_SURF_LOCK()=' . SURFBAR_GET_SURF_LOCK() . ' - EXIT!');
1216 return ($count == 1);
1219 // Determine which user hash no more points left
1220 function SURFBAR_DETERMINE_DEPLETED_USERIDS ($limit=0) {
1223 'url_userid' => array(),
1224 'points' => array(),
1225 'notified' => array(),
1228 // Do we have a current user id?
1229 if ((isMember()) && ($limit == '0')) {
1230 // Then add this as well
1231 $userids['url_userid'][getMemberId()] = getMemberId();
1232 $userids['points'][getMemberId()] = getTotalPoints(getMemberId());
1233 $userids['notified'][getMemberId()] = '0';
1235 // Get all userid except logged in one
1236 $result = SQL_QUERY_ESC("SELECT
1237 u.url_userid, UNIX_TIMESTAMP(d.surfbar_low_notified) AS notified
1239 `{?_MYSQL_PREFIX?}_surfbar_urls` AS u
1241 `{?_MYSQL_PREFIX?}_user_data` AS d
1243 u.`url_userid`=d.`userid`
1245 u.`url_userid` NOT IN (%s,0) AND
1246 u.`url_status`='ACTIVE'
1250 u.`url_userid` ASC",
1251 array(getMemberId()), __FUNCTION__, __LINE__);
1254 $result = SQL_QUERY("SELECT
1255 u.url_userid, UNIX_TIMESTAMP(d.surfbar_low_notified) AS notified
1257 `{?_MYSQL_PREFIX?}_surfbar_urls` AS u
1259 `{?_MYSQL_PREFIX?}_user_data` AS d
1261 u.`url_userid`=d.`userid`
1263 u.`url_userid` > 0 AND
1264 u.`url_status`='ACTIVE'
1268 u.`url_userid` ASC", __FUNCTION__, __LINE__);
1272 while ($content = SQL_FETCHARRAY($result)) {
1274 $points = getTotalPoints($content['url_userid']);
1275 /* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'userid=' . $content['url_userid'] . ',points=' . $points);
1277 // Shall we add this to ignore?
1278 if ($points <= $limit) {
1280 /* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'userid=' . $content['url_userid'] . ' has depleted points amount!');
1281 $userids['url_userid'][$content['url_userid']] = $content['url_userid'];
1282 $userids['points'][$content['url_userid']] = $points;
1283 $userids['notified'][$content['url_userid']] = $content['notified'];
1288 SQL_FREERESULT($result);
1291 /* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'UIDs::count=' . count($userids) . ' (with own userid=' . getMemberId() . ')');
1297 // Determine how many users are Online in surfbar
1298 function SURFBAR_DETERMINE_TOTAL_ONLINE () {
1299 // Count all users in surfbar modue and return the value
1300 $result = SQL_QUERY('SELECT
1303 `{?_MYSQL_PREFIX?}_surfbar_stats`
1305 (UNIX_TIMESTAMP() - UNIX_TIMESTAMP(`stats_last_surfed`)) <= {?online_timeout?}
1307 `stats_userid` ASC', __FUNCTION__, __LINE__);
1310 $count = SQL_NUMROWS($result);
1313 SQL_FREERESULT($result);
1319 // Determine waiting time for one URL
1320 function SURFBAR_DETERMINE_WAIT_TIME () {
1321 // Get fixed reload lock
1322 $fixed = SURFBAR_GET_FIXED_RELOAD();
1324 // Is the fixed reload time set?
1330 // Static time is default
1331 $time = getConfig('surfbar_static_time');
1333 // Which payment model do we have?
1334 if (getSurfbarPaymentModel() == 'DYNAMIC') {
1335 // "Calculate" dynamic time
1336 $time += SURFBAR_CALCULATE_DYNAMIC_ADD();
1343 // Changes the status of an URL from given to other
1344 function SURFBAR_CHANGE_STATUS ($urlId, $prevStatus, $newStatus, $data = array()) {
1345 /* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'urlId=' . $urlId . ',prevStatus=' . $prevStatus . ',newStatus=' . $newStatus . ' - ENTERED!');
1346 // Make new status always lower-case
1347 $newStatus = strtolower($newStatus);
1349 // Get URL data for status comparison if missing
1350 if ((!is_array($data)) || (count($data) == 0)) {
1351 // Fetch missing URL data
1352 $data = SURFBAR_GET_URL_DATA($urlId);
1356 $filterData = array(
1358 'prev_status' => $prevStatus,
1359 'new_status' => $newStatus,
1364 // Run pre filter chain
1365 $filterData = runFilterChain('pre_change_surfbar_url_status', $filterData);
1368 if (!is_null($filterData['abort'])) {
1370 return $filterData['abort'];
1373 // Update the status now
1374 // ---------- Comment out for debugging/developing member actions! ---------
1375 SQL_QUERY_ESC("UPDATE `{?_MYSQL_PREFIX?}_surfbar_urls` SET `url_status`='%s' WHERE `url_id`=%s LIMIT 1",
1379 ), __FUNCTION__, __LINE__);
1380 // ---------- Comment out for debugging/developing member actions! ---------
1383 // ---------- Comment out for debugging/developing member actions! ---------
1384 if (SQL_AFFECTEDROWS() != 1) {
1385 // No, something went wrong
1388 // ---------- Comment out for debugging/developing member actions! ---------
1390 // Run post filter chain
1391 $filterData = runFilterChain('post_change_surfbar_url_status', $filterData);
1393 // Extract data from it again
1394 $data = $filterData['data'];
1397 /* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'urlId=' . $urlId . ',prevStatus=' . $prevStatus . ',newStatus=' . $newStatus . ' - EXIT!');
1401 // Calculate minimum value for dynamic payment model
1402 function SURFBAR_CALCULATE_DYNAMIC_MIN_VALUE () {
1403 // Addon is zero by default
1407 $percent = abs(log(getConfig('surfbar_dynamic_percent') / 100 + 1));
1410 $totalUsers = getTotalConfirmedUser();
1413 $onlineUsers = SURFBAR_DETERMINE_TOTAL_ONLINE();
1416 $addon += abs(log($onlineUsers / $totalUsers + 1) * $percent * $totalUsers);
1419 $totalUrls = SURFBAR_GET_TOTAL_URLS('ACTIVE', 0);
1421 // Get user's total URLs
1422 $userUrls = SURFBAR_GET_TOTAL_USER_URLS(0, 'ACTIVE');
1425 if ($totalUrls > 0) {
1426 $addon += abs(log($userUrls / $totalUrls + 1) * $percent * $totalUrls);
1428 $addon += abs(log($userUrls / 1 + 1) * $percent * $totalUrls);
1435 // Calculate maximum value for dynamic payment model
1436 function SURFBAR_CALCULATE_DYNAMIC_MAX_VALUE () {
1437 // Addon is zero by default
1444 $percent = abs(log(getConfig('surfbar_dynamic_percent') / 100 + 1));
1447 $totalUsers = getTotalConfirmedUser();
1450 $addon += abs($max * $percent * $totalUsers);
1453 $totalUrls = SURFBAR_GET_TOTAL_URLS('ACTIVE', 0);
1456 $addon += abs($max * $percent * $totalUrls);
1462 // Calculate dynamic lock
1463 function SURFBAR_CALCULATE_DYNAMIC_LOCK () {
1464 // Default lock is 30 seconds
1468 $onlineUsers = SURFBAR_DETERMINE_TOTAL_ONLINE();
1471 $addon = abs(log($onlineUsers / $addon + 1));
1477 // "Getter" for lock ids array
1478 function SURFBAR_GET_LOCK_IDS () {
1479 // Prepare some arrays
1484 // Get all id from locks within the timestamp
1485 $result = SQL_QUERY_ESC("SELECT
1488 UNIX_TIMESTAMP(`locks_last_surfed`) AS `last_surfed`
1490 `{?_MYSQL_PREFIX?}_surfbar_locks`
1494 `locks_id` ASC", array(getMemberId()),
1495 __FUNCTION__, __LINE__);
1498 while ($content = SQL_FETCHARRAY($result)) {
1500 /* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'next - lid='.$content['locks_id'].',url='.$content['locks_url_id'].',rest='.(time() - $content['last_surfed']).'/'.SURFBAR_GET_SURF_LOCK());
1502 // Skip entries that are too old
1503 if (($content['last_surfed'] > (time() - SURFBAR_GET_SURF_LOCK())) && (!in_array($content['locks_url_id'], $ignored))) {
1505 /* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'okay - lid='.$content['locks_id'].',url='.$content['locks_url_id'].',last='.$content['last_surfed']);
1507 // Add only if missing or bigger
1508 if ((!isset($IDs[$content['locks_url_id']])) || ($IDs[$content['locks_url_id']] > $content['last_surfed'])) {
1510 /* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'ADD - lid='.$content['locks_id'].',url='.$content['locks_url_id'].',last='.$content['last_surfed']);
1513 $IDs[$content['locks_url_id']] = $content['last_surfed'];
1514 $USE[$content['locks_url_id']] = $content['locks_id'];
1518 /* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'ignore - lid='.$content['locks_id'].',url='.$content['locks_url_id'].',last='.$content['last_surfed']);
1520 // Ignore these old entries!
1521 $ignored[] = $content['locks_url_id'];
1522 unset($IDs[$content['locks_url_id']]);
1523 unset($USE[$content['locks_url_id']]);
1528 SQL_FREERESULT($result);
1534 // "Getter" for maximum random number
1535 function SURFBAR_GET_MAX_RANDOM ($userids, $add) {
1536 // Count max availabe entries
1537 $result = SQL_QUERY("SELECT
1540 `{?_MYSQL_PREFIX?}_surfbar_urls` AS sbu
1542 `{?_MYSQL_PREFIX?}_surfbar_salts` AS sbs
1544 sbu.url_id=sbs.salts_url_id
1546 `{?_MYSQL_PREFIX?}_surfbar_locks` AS l
1548 sbu.url_id=l.locks_url_id
1550 sbu.url_userid NOT IN (" . implode(',', $userids) . ") AND
1551 (sbu.url_views_allowed=0 OR (sbu.url_views_allowed > 0 AND sbu.url_views_max > 0)) AND
1552 sbu.url_status='ACTIVE'
1555 sbu.url_id ASC", __FUNCTION__, __LINE__);
1558 /* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'lastQuery='.getConfig('db_last_query').'|numRows='.SQL_NUMROWS($result).'|Affected='.SQL_AFFECTEDROWS());
1561 $maxRand = SQL_NUMROWS($result);
1564 SQL_FREERESULT($result);
1570 // Load all URLs of the current user and return it as an array
1571 function SURFBAR_GET_USER_URLS () {
1573 $urlArray = array();
1576 $result = SQL_QUERY_ESC("SELECT
1583 u.url_views_allowed,
1584 UNIX_TIMESTAMP(u.url_registered) AS `url_registered`,
1585 UNIX_TIMESTAMP(u.`url_last_locked`) AS `url_last_locked`,
1588 `{?_MYSQL_PREFIX?}_surfbar_urls` AS u
1590 u.`url_userid`=%s AND
1591 u.`url_status` != 'DELETED'
1594 array(getMemberId()), __FUNCTION__, __LINE__);
1596 // Are there entries?
1597 if (!SQL_HASZERONUMS($result)) {
1599 while ($row = SQL_FETCHARRAY($result)) {
1601 $urlArray[$row['url_id']] = $row;
1606 SQL_FREERESULT($result);
1612 // "Getter" for member action array for given status
1613 function SURFBAR_GET_ARRAY_FROM_STATUS ($status) {
1615 $returnArray = array();
1617 // Get all assigned actions
1618 $result = SQL_QUERY_ESC("SELECT `actions_action` FROM `{?_MYSQL_PREFIX?}_surfbar_actions` WHERE `actions_status`='%s' ORDER BY `actions_id` ASC",
1619 array($status), __FUNCTION__, __LINE__);
1621 // Some entries there?
1622 if (!SQL_HASZERONUMS($result)) {
1624 // @TODO This can be somehow rewritten
1625 while ($content = SQL_FETCHARRAY($result)) {
1626 $returnArray[] = $content['actions_action'];
1631 SQL_FREERESULT($result);
1634 return $returnArray;
1637 // Reload to configured stop page
1638 function SURFBAR_RELOAD_TO_STOP_PAGE ($page = 'stop') {
1639 // Internal or external?
1640 /* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'page=' . $page . ' - ENTERED!');
1641 if ((getConfig('surfbar_pause_mode') == 'INTERNAL') || (getConfig('surfbar_pause_url') == '')) {
1642 // Reload to internal page
1643 redirectToUrl('surfbar.php?frame=' . $page);
1645 // Reload to external page
1646 redirectToConfiguredUrl('surfbar_pause_url');
1650 // Determine next id for surfbar or get data for given id, always call this before you call other
1651 // getters below this function!
1652 function SURFBAR_DETERMINE_NEXT_ID ($urlId = '0') {
1653 /* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'urlId=' . $urlId . ' - ENTERED!');
1654 // Default is no id and no random number
1659 if ($urlId == '0') {
1660 // Get array with lock ids
1661 $USE = SURFBAR_GET_LOCK_IDS();
1663 // Shall we add some URL ids to ignore?
1665 if (count($USE) > 0) {
1667 $add = " AND sbu.`url_id` NOT IN (";
1668 foreach ($USE as $url_id => $lid) {
1670 $add .= $url_id.',';
1673 // Add closing bracket
1674 $add = substr($add, 0, -1) . ')';
1677 // Determine depleted user account
1678 $userids = SURFBAR_DETERMINE_DEPLETED_USERIDS();
1680 // Get maximum randomness factor
1681 $maxRand = SURFBAR_GET_MAX_RANDOM($userids['url_userid'], $add);
1683 // If more than one URL can be called generate the random number!
1685 // Generate random number
1686 $randNum = mt_rand(0, ($maxRand - 1));
1689 // And query the database
1690 /* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'randNum='.$randNum.',maxRand='.$maxRand.',surfLock='.SURFBAR_GET_SURF_LOCK());
1691 $result = SQL_QUERY_ESC("SELECT
1695 sbs.salts_last_salt,
1696 sbu.url_views_total,
1698 sbu.url_views_allowed,
1699 UNIX_TIMESTAMP(l.locks_last_surfed) AS last_surfed,
1700 sbu.url_fixed_reload
1702 `{?_MYSQL_PREFIX?}_surfbar_urls` AS sbu
1704 `{?_MYSQL_PREFIX?}_surfbar_salts` AS sbs
1706 sbu.url_id=sbs.salts_url_id
1708 `{?_MYSQL_PREFIX?}_surfbar_locks` AS l
1710 sbu.url_id=l.locks_url_id
1712 sbu.`url_userid` NOT IN (".implode(',', $userids['url_userid']).") AND
1713 sbu.url_status='ACTIVE' AND
1714 (sbu.url_views_allowed=0 OR (sbu.url_views_allowed > 0 AND sbu.url_views_max > 0))
1719 l.locks_last_surfed ASC,
1722 array($randNum), __FUNCTION__, __LINE__
1725 // Get data from specified id number
1726 $result = SQL_QUERY_ESC("SELECT
1730 sbs.salts_last_salt,
1731 sbu.url_views_total,
1733 sbu.url_views_allowed,
1734 UNIX_TIMESTAMP(l.locks_last_surfed) AS last_surfed,
1735 sbu.url_fixed_reload
1737 `{?_MYSQL_PREFIX?}_surfbar_urls` AS sbu
1739 `{?_MYSQL_PREFIX?}_surfbar_salts` AS sbs
1741 sbu.url_id=sbs.salts_url_id
1743 `{?_MYSQL_PREFIX?}_surfbar_locks` AS l
1745 sbu.url_id=l.locks_url_id
1747 sbu.url_userid != %s AND
1748 sbu.url_status='ACTIVE' AND
1750 (sbu.url_views_allowed=0 OR (sbu.url_views_allowed > 0 AND sbu.url_views_max > 0))
1752 array(getMemberId(), bigintval($urlId)), __FUNCTION__, __LINE__
1756 // Is there an id number?
1757 /* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'lastQuery='.getConfig('db_last_query').'|numRows='.SQL_NUMROWS($result).'|Affected='.SQL_AFFECTEDROWS());
1758 if (SQL_NUMROWS($result) == 1) {
1760 /* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'count('.count($GLOBALS['surfbar_cache']).') - BEFORE', false);
1761 $GLOBALS['surfbar_cache'] = merge_array($GLOBALS['surfbar_cache'], SQL_FETCHARRAY($result));
1762 /* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'count('.count($GLOBALS['surfbar_cache']).') - AFTER', false);
1764 // Determine waiting time
1765 $GLOBALS['surfbar_cache']['time'] = SURFBAR_DETERMINE_WAIT_TIME();
1767 // Is the last salt there?
1768 if (is_null($GLOBALS['surfbar_cache']['salts_last_salt'])) {
1769 // Then repair it wit the static!
1770 /* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'last_salt - FIXED!', false);
1771 $GLOBALS['surfbar_cache']['salts_last_salt'] = '';
1774 // Fix missing last_surfed
1775 if ((!isset($GLOBALS['surfbar_cache']['last_surfed'])) || (is_null($GLOBALS['surfbar_cache']['last_surfed']))) {
1777 /* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'last_surfed - FIXED!', false);
1778 $GLOBALS['surfbar_cache']['last_surfed'] = '0';
1781 // Get base/fixed reward and costs
1782 $GLOBALS['surfbar_cache']['reward'] = SURFBAR_DETERMINE_REWARD();
1783 $GLOBALS['surfbar_cache']['costs'] = SURFBAR_DETERMINE_COSTS();
1784 /* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'BASE/STATIC - reward='.SURFBAR_GET_REWARD().'|costs='.SURFBAR_GET_COSTS());
1786 // Only in dynamic model add the dynamic bonus!
1787 if (getSurfbarPaymentModel() == 'DYNAMIC') {
1788 // Calculate dynamic reward/costs and add it
1789 $GLOBALS['surfbar_cache']['reward'] += SURFBAR_CALCULATE_DYNAMIC_ADD();
1790 $GLOBALS['surfbar_cache']['costs'] += SURFBAR_CALCULATE_DYNAMIC_ADD();
1791 /* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'DYNAMIC+ - reward='.SURFBAR_GET_REWARD().'|costs='.SURFBAR_GET_COSTS());
1795 $nextId = SURFBAR_GET_ID();
1799 SQL_FREERESULT($result);
1802 /* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'urlId=' . $urlId . ',nextId=' . $nextId . ' - EXIT!');
1806 //-----------------------------------------------------------------------------
1808 //-----------------------------------------------------------------------------
1810 // "Getter" for surfbar_dynamic_percent
1811 function getSurfbarDynamicPercent () {
1812 // Do we have cache?
1813 if (!isset($GLOBALS[__FUNCTION__])) {
1815 $GLOBALS[__FUNCTION__] = getConfig('surfbar_dynamic_percent');
1819 return $GLOBALS[__FUNCTION__];
1822 // "Getter" for surfbar_static_reward
1823 function getSurfbarStaticReward () {
1824 // Do we have cache?
1825 if (!isset($GLOBALS[__FUNCTION__])) {
1827 $GLOBALS[__FUNCTION__] = getConfig('surfbar_static_reward');
1831 return $GLOBALS[__FUNCTION__];
1834 // "Getter" for surfbar_static_time
1835 function getSurfbarStaticTime () {
1836 // Do we have cache?
1837 if (!isset($GLOBALS[__FUNCTION__])) {
1839 $GLOBALS[__FUNCTION__] = getConfig('surfbar_static_time');
1843 return $GLOBALS[__FUNCTION__];
1846 // "Getter" for surfbar_max_order
1847 function getSurfbarMaxOrder () {
1848 // Do we have cache?
1849 if (!isset($GLOBALS[__FUNCTION__])) {
1851 $GLOBALS[__FUNCTION__] = getConfig('surfbar_max_order');
1855 return $GLOBALS[__FUNCTION__];
1858 // "Getter" for surfbar_payment_model
1859 function getSurfbarPaymentModel () {
1860 // Do we have cache?
1861 if (!isset($GLOBALS[__FUNCTION__])) {
1863 $GLOBALS[__FUNCTION__] = getConfig('surfbar_payment_model');
1867 return $GLOBALS[__FUNCTION__];
1870 //------------------------------------------------------------------------------
1871 // PLEASE DO NOT ADD ANY OTHER FUNCTIONS BELOW THIS LINE IF THEY DON'T "WRAP"
1872 // THE $GLOBALS['surfbar_cache'] ARRAY!
1873 //------------------------------------------------------------------------------
1875 // Initializes the surfbar
1876 function SURFBAR_INIT () {
1878 $GLOBALS['surfbar_cache'] = array();
1881 // Private getter for data elements
1882 function SURFBAR_GET_DATA ($element) {
1883 /* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'element=' . $element . ' - ENTERED!');
1888 // Is the entry there?
1889 if (isset($GLOBALS['surfbar_cache'][$element])) {
1891 $data = $GLOBALS['surfbar_cache'][$element];
1892 } else { // END - if
1894 print_r($GLOBALS['surfbar_cache']);
1896 debug_report_bug(__FUNCTION__, __LINE__, 'Element ' . $element . ' not found.');
1900 /* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'element[' . $element . ']=[' . gettype($data) . ']' . $data . ' - EXIT!');
1904 // Getter for reward from cache
1905 function SURFBAR_GET_REWARD () {
1906 // Get data element and return its contents
1907 return SURFBAR_GET_DATA('reward');
1910 // Getter for costs from cache
1911 function SURFBAR_GET_COSTS () {
1912 // Get data element and return its contents
1913 return SURFBAR_GET_DATA('costs');
1916 // Getter for URL from cache
1917 function SURFBAR_GET_URL () {
1918 // Get data element and return its contents
1919 return SURFBAR_GET_DATA('url');
1922 // Getter for salt from cache
1923 function SURFBAR_GET_SALT () {
1924 // Get data element and return its contents
1925 return SURFBAR_GET_DATA('salt');
1928 // Getter for id from cache
1929 function SURFBAR_GET_ID () {
1930 // Get data element and return its contents
1931 return SURFBAR_GET_DATA('url_id');
1934 // Getter for userid from cache
1935 function SURFBAR_GET_USERID () {
1936 // Get data element and return its contents
1937 return SURFBAR_GET_DATA('url_userid');
1940 // Getter for user reload locks
1941 function SURFBAR_GET_USER_LOCKS () {
1942 // Get data element and return its contents
1943 return SURFBAR_GET_DATA('user_locks');
1946 // Getter for reload time
1947 function SURFBAR_GET_RELOAD_TIME () {
1948 // Get data element and return its contents
1949 return SURFBAR_GET_DATA('time');
1952 // Getter for allowed views
1953 function SURFBAR_GET_VIEWS_ALLOWED () {
1954 // Get data element and return its contents
1955 return SURFBAR_GET_DATA('url_views_allowed');
1958 // Getter for maximum views
1959 function SURFBAR_GET_VIEWS_MAX () {
1960 // Get data element and return its contents
1961 return SURFBAR_GET_DATA('url_views_max');
1964 // Getter for fixed reload
1965 function SURFBAR_GET_FIXED_RELOAD () {
1966 // Get data element and return its contents
1967 return SURFBAR_GET_DATA('url_fixed_reload');
1970 // Getter for surf lock
1971 function SURFBAR_GET_SURF_LOCK () {
1972 // Get data element and return its contents
1973 return SURFBAR_GET_DATA('surf_lock');
1976 // Getter for new status
1977 function SURFBAR_GET_NEW_STATUS () {
1978 // Get data element and return its contents
1979 return SURFBAR_GET_DATA('new_status');
1982 // Getter for last salt
1983 function SURFBAR_GET_LAST_SALT () {
1984 // Get data element and return its contents
1985 return SURFBAR_GET_DATA('salts_last_salt');