2 /************************************************************************
3 * Mailer v0.2.1-FINAL Start: 08/31/2008 *
4 * =================== Last change: 08/31/2008 *
6 * -------------------------------------------------------------------- *
7 * File : surfbar_functions.php *
8 * -------------------------------------------------------------------- *
9 * Short description : Functions for surfbar *
10 * -------------------------------------------------------------------- *
11 * Kurzbeschreibung : Funktionen fuer die Surfbar *
12 * -------------------------------------------------------------------- *
15 * $Tag:: 0.2.1-FINAL $ *
17 * Needs to be in all Files and every File needs "svn propset *
18 * svn:keywords Date Revision" (autoprobset!) at least!!!!!! *
19 * -------------------------------------------------------------------- *
20 * Copyright (c) 2003 - 2009 by Roland Haeder *
21 * Copyright (c) 2009, 2010 by Mailer Developer Team *
22 * For more information visit: http://www.mxchange.org *
24 * This program is free software; you can redistribute it and/or modify *
25 * it under the terms of the GNU General Public License as published by *
26 * the Free Software Foundation; either version 2 of the License, or *
27 * (at your option) any later version. *
29 * This program is distributed in the hope that it will be useful, *
30 * but WITHOUT ANY WARRANTY; without even the implied warranty of *
31 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the *
32 * GNU General Public License for more details. *
34 * You should have received a copy of the GNU General Public License *
35 * along with this program; if not, write to the Free Software *
36 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, *
38 ************************************************************************/
40 // Some security stuff...
41 if (!defined('__SECURITY')) {
45 // -----------------------------------------------------------------------------
47 // -----------------------------------------------------------------------------
49 // Admin has added an URL with given user id and so on
50 function SURFBAR_ADMIN_ADD_URL ($url, $limit, $reload) {
54 logDebugMessage(__FUNCTION__, __LINE__, sprintf("Cannot add URL=%s,limit=%s,reload=%s : Not admin.", $url, $limit, $reload));
56 } elseif (!isUrlValid($url)) {
58 logDebugMessage(__FUNCTION__, __LINE__, sprintf("Cannot add URL=%s,limit=%s,reload=%s : Invalid URL.", $url, $limit, $reload));
60 } elseif (SURFBAR_LOOKUP_BY_URL($url, 0)) {
61 // URL already found in surfbar!
62 logDebugMessage(__FUNCTION__, __LINE__, sprintf("Cannot add URL=%s,limit=%s,reload=%s : Already added.", $url, $limit, $reload));
64 } elseif (!SURFBAR_IF_USER_BOOK_MORE_URLS()) {
66 logDebugMessage(__FUNCTION__, __LINE__, sprintf("Cannot add URL=%s,limit=%s,reload=%s : No more URLs allowed.", $url, $limit, $reload));
68 } elseif ('' . ($limit + 0) . '' != '' . $limit . '') {
69 // Invalid limit entered
70 logDebugMessage(__FUNCTION__, __LINE__, sprintf("Cannot add URL=%s,limit=%s,reload=%s : Invalid limit entered.", $url, $limit, $reload));
72 } elseif ('' . ($reload + 0) . '' != '' . $reload . '') {
73 // Invalid amount entered
74 logDebugMessage(__FUNCTION__, __LINE__, sprintf("Cannot add URL=%s,limit=%s,reload=%s : Invalid reload entered.", $url, $limit, $reload));
78 // Register the new URL
79 return SURFBAR_REGISTER_URL($url, 0, 'ACTIVE', 'unlock', array('limit' => $limit, 'reload' => $reload));
82 // Admin unlocked an email so we can migrate the URL
83 function SURFBAR_ADMIN_MIGRATE_URL ($url, $userid) {
88 } elseif (!isUrlValid($url)) {
91 } elseif (SURFBAR_LOOKUP_BY_URL($url, $userid)) {
92 // URL already found in surfbar!
94 } elseif (!SURFBAR_IF_USER_BOOK_MORE_URLS($userid)) {
99 // Register the new URL
100 return SURFBAR_REGISTER_URL($url, $userid, 'MIGRATED', 'migrate');
103 // Admin function for unlocking URLs
104 function SURFBAR_ADMIN_UNLOCK_URL_IDS ($IDs) {
105 // Is this an admin or invalid array?
107 // Not admin or invalid ids array
109 } elseif (!is_array($IDs)) {
112 } elseif (count($IDs) == 0) {
117 // Set to true to make AND expression valid if first URL got unlocked
120 // Update the status for all ids
121 foreach ($IDs as $id => $dummy) {
122 // Test all ids through (ignores failed)
123 $done = (($done) && (SURFBAR_CHANGE_STATUS($id, 'PENDING', 'ACTIVE')));
126 // Return total status
130 // Admin function for rejecting URLs
131 function SURFBAR_ADMIN_REJECT_URL_IDS ($IDs) {
132 // Is this an admin or invalid array?
134 // Not admin or invalid ids array
136 } elseif (!is_array($IDs)) {
139 } elseif (count($IDs) == 0) {
144 // Set to true to make AND expression valid if first URL got unlocked
147 // Update the status for all ids
148 foreach ($IDs as $id => $dummy) {
149 // Test all ids through (ignores failed)
150 $done = (($done) && (SURFBAR_CHANGE_STATUS($id, 'PENDING', 'REJECTED')));
153 // Return total status
158 // -----------------------------------------------------------------------------
160 // -----------------------------------------------------------------------------
162 // Member has added an URL
163 function SURFBAR_MEMBER_ADD_URL ($url, $limit) {
164 // Do some pre-checks
168 } elseif ((!isUrlValid($url)) && (!isAdmin())) {
171 } elseif (SURFBAR_LOOKUP_BY_URL($url, getMemberId())) {
172 // URL already found in surfbar!
174 } elseif (!SURFBAR_IF_USER_BOOK_MORE_URLS(getMemberId())) {
177 } elseif (''.($limit + 0).'' != ''.$limit.'') {
178 // Invalid amount entered
182 // Register the new URL
183 return SURFBAR_REGISTER_URL($url, getMemberId(), 'PENDING', 'reg', array('limit' => $limit));
186 // Create list of actions depending on status for the user
187 function SURFBAR_MEMBER_ACTIONS ($urlId, $status) {
188 // Load all actions in an array for given status
189 $actionArray = SURFBAR_GET_ARRAY_FROM_STATUS($status);
192 $OUT = "<table border=\"0\" cellspacing=\"0\" cellpadding=\"1\" width=\"100%\">
196 $width = round(100 / count($actionArray));
198 // "Walk" through all actions and create forms
199 foreach ($actionArray as $actionId => $action) {
200 // Add form for this action
201 $OUT .= loadTemplate('member_surfbar_list_form', true, array(
203 'id' => bigintval($urlId),
204 'action' => strtolower($action),
205 'title' => '{--MEMBER_SURFBAR_ACTION_' . strtoupper($action) . '_TITLE--}',
206 'submit' => '{--MEMBER_SURFBAR_ACTION_' . strtoupper($action) . '_SUBMIT--}',
218 // Do the member form request
219 function SURFBAR_MEMBER_DO_FORM ($formData, $urlArray) {
220 // By default no action is performed
227 } elseif ((!isset($formData['id'])) || (!isset($formData['action']))) {
228 // Important form elements are missing!
230 } elseif (!isset($urlArray[$formData['id']])) {
231 // id not found in cache
233 } elseif (!SURFBAR_VALIDATE_MEMBER_ACTION_STATUS($formData['action'], $urlArray[$formData['id']]['url_status'])) {
234 // Action not allowed for current URL status
239 $action = secureString($formData['action']);
242 if ($action != $formData['action']) {
243 // Invalid data in action found
247 // Create the function name for selected action
248 $functionName = sprintf("SURFBAR_MEMBER_%s_ACTION", strtoupper($action));
250 // Is the function there?
251 if (function_exists($functionName)) {
253 $urlArray[$formData['id']]['new_status'] = SURFBAR_GET_NEW_STATUS('new_status');
255 // Extract URL data for call-back
256 $urlData = array(merge_array($urlArray[$formData['id']], array($action => $formData)));
258 // Action found so execute it
259 $performed = call_user_func_array($functionName, $urlData);
261 // Log invalid request
262 logDebugMessage(__FUNCTION__, __LINE__, "action={$formData['action']},id={$formData['id']},function={$functionName}");
263 addFatalMessage(__FUNCTION__, __LINE__, "Invalid member action! action=%s,id=%s,function=%s", array($formData['action'], $formData['id'], $functionName));
270 // Validate if the requested action can be performed on current URL status
271 function SURFBAR_VALIDATE_MEMBER_ACTION_STATUS ($action, $status) {
272 // Search for the requested action/status combination in database
273 $result = SQL_QUERY_ESC("SELECT new_status FROM `{?_MYSQL_PREFIX?}_surfbar_actions` WHERE `action`='%s' AND `status`='%s' LIMIT 1",
274 array($action, $status), __FUNCTION__, __LINE__);
276 // Is the entry there?
277 $isValid = (SQL_NUMROWS($result) == 1);
279 // Fetch the new status if found
282 list($GLOBALS['surfbar_cache']['new_status']) = SQL_FETCHROW($result);
286 SQL_FREERESULT($result);
293 // -----------------------------------------------------------------------------
295 // -----------------------------------------------------------------------------
297 // Retreat a booked URL
298 function SURFBAR_MEMBER_RETREAT_ACTION ($urlData) {
299 // Create the data array for next function call
301 $urlData['id'] => $urlData
304 // Simply change the status here
305 return SURFBAR_CHANGE_STATUS ($urlData['id'], $urlData['url_status'], $urlData['new_status'], $data);
308 // Book an URL now (from migration)
309 function SURFBAR_MEMBER_BOOKNOW_ACTION ($urlData) {
310 // Create the data array for next function call
312 $urlData['id'] => $urlData
315 // Simply change the status here
316 return SURFBAR_CHANGE_STATUS ($urlData['id'], $urlData['url_status'], $urlData['new_status'], $data);
319 // Show edit form or do the changes
320 function SURFBAR_MEMBER_EDIT_ACTION ($urlData) {
321 // Is the "execute" flag there?
322 if (isset($urlData['edit']['execute'])) {
323 // Execute the changes
324 return SURFBAR_MEMBER_EXECUTE_ACTION('edit', $urlData);
328 return SURFBAR_MEMBER_DISPLAY_ACTION_FORM('edit', $urlData);
331 // Show delete form or do the changes
332 function SURFBAR_MEMBER_DELETE_ACTION ($urlData) {
333 // Is the "execute" flag there?
334 if (isset($urlData['delete']['execute'])) {
335 // Execute the changes
336 return SURFBAR_MEMBER_EXECUTE_ACTION('delete', $urlData);
340 return SURFBAR_MEMBER_DISPLAY_ACTION_FORM('delete', $urlData);
343 // Pause active banner
344 function SURFBAR_MEMBER_PAUSE_ACTION ($urlData) {
345 return SURFBAR_CHANGE_STATUS($urlData['id'], $urlData['url_status'], $urlData['new_status'], array($urlData['id'] => $urlData));
348 // Unpause stopped banner
349 function SURFBAR_MEMBER_UNPAUSE_ACTION ($urlData) {
350 // Fix missing entry for template
351 $urlData['edit'] = $urlData['unpause'];
352 $urlData['edit']['url'] = $urlData['url'];
353 $urlData['edit']['limit'] = SURFBAR_GET_VIEWS_MAX();
355 // Return status change
356 return SURFBAR_CHANGE_STATUS($urlData['id'], $urlData['url_status'], $urlData['new_status'], array($urlData['id'] => $urlData));
359 // Resubmit locked URL
360 function SURFBAR_MEMBER_RESUBMIT_ACTION ($urlData) {
361 return SURFBAR_CHANGE_STATUS($urlData['id'], $urlData['url_status'], $urlData['new_status'], array($urlData['id'] => $urlData));
364 // Display selected "action form"
365 function SURFBAR_MEMBER_DISPLAY_ACTION_FORM ($action, $urlData) {
366 // Translate some data if present
367 $content = SURFBAR_PREPARE_CONTENT_FOR_TEMPLATE($content);
369 // Is the lock reason empty?
370 if (empty($urlData['url_lock_reason'])) {
371 // Fix it to three dashes
372 $urlData['url_lock_reason'] = '---';
375 // Include fields only for action 'edit'
376 if ($action == 'edit') {
377 // Default is not limited
378 $urlData['limited_y'] = '';
379 $urlData['limited_n'] = ' checked="checked"';
380 $urlData['limited'] = 'false';
382 // Is this URL limited?
383 if (SURFBAR_GET_VIEWS_MAX() > 0) {
384 // Then rewrite form data
385 $urlData['limited_y'] = ' checked="checked"';
386 $urlData['limited_n'] = '';
387 $urlData['limited'] = 'true';
391 // Load the form and display it
392 loadTemplate(sprintf("member_surfbar_%s_action_form", $action), false, $urlData);
394 // All fine by default ... ;-)
398 // Execute choosen action
399 function SURFBAR_MEMBER_EXECUTE_ACTION ($action, $urlData) {
400 // By default nothing is executed
403 // Is limitation "no" and "limit" is > 0?
404 if ((isset($urlData[$action]['limited'])) && ($urlData[$action]['limited'] != 'Y') && ((isset($urlData[$action]['limit'])) && ($urlData[$action]['limit'] > 0)) || (!isset($urlData[$action]['limit']))) {
405 // Set it to unlimited
406 $urlData[$action]['limit'] = '0';
409 // Construct function name
410 $functionName = sprintf("SURFBAR_MEMBER_EXECUTE_%s_ACTION", strtoupper($action));
412 // Is that function there?
413 if (function_exists($functionName)) {
414 // Execute the function
415 if (call_user_func_array($functionName, array($urlData)) == true) {
416 // Update status as well
417 $executed = SURFBAR_CHANGE_STATUS($urlData['id'], $urlData['url_status'], $urlData['new_status'], array($urlData['id'] => $urlData));
421 addFatalMessage(__FUNCTION__, __LINE__, getMessage('MEMBER_SURFBAR_EXECUTE_ACTION_404'), $functionName);
427 // "Execute edit" function: Update changed data
428 function SURFBAR_MEMBER_EXECUTE_EDIT_ACTION ($urlData) {
429 // Default is nothing done
432 // Has the URL or limit changed?
434 //if (($urlData['url_views_allowed'] != $urlData['edit']['limit']) || ($url1 != $url2)) {
436 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",
437 array($urlData['url'], $urlData['edit']['limit'], $urlData['edit']['limit'], $urlData['id'], $urlData['url_status']), __FUNCTION__, __LINE__);
446 // "Execute delete" function: Does nothing...
447 function SURFBAR_MEMBER_EXECUTE_DELETE_ACTION ($urlData) {
448 // Nothing special to do (see above function for such "special actions" to perform)
452 // -----------------------------------------------------------------------------
453 // Self-maintenance functions
454 // -----------------------------------------------------------------------------
457 function SURFBAR_HANDLE_SELF_MAINTENANCE () {
458 // Handle URLs which limit has depleted so we can stop them
459 SURFBAR_HANDLE_DEPLETED_VIEWS();
461 // Handle low-points amounts
462 SURFBAR_HANDLE_LOW_POINTS();
464 // Handle URLs which limit has depleted
465 function SURFBAR_HANDLE_DEPLETED_VIEWS () {
467 $urlArray = SURFBAR_GET_URL_DATA(0, 'url_views_max', 'url_id', 'ASC', 'url_id', " AND `url_views_allowed` > 0 AND `url_status`='ACTIVE'");
469 // Do we have some entries?
470 if (count($urlArray) > 0) {
472 foreach ($urlArray as $id => $urlData) {
476 // Rewrite array for next call
477 $urlData[$id] = $data;
480 SURFBAR_CHANGE_STATUS($id, 'ACTIVE', 'DEPLETED', $urlData);
485 // Alert users which have URLs booked and are low on points amount
486 function SURFBAR_HANDLE_LOW_POINTS () {
488 $userids = SURFBAR_DETERMINE_DEPLETED_USERIDS(getConfig('surfbar_warn_low_points'));
490 // "Walk" through all URLs
491 foreach ($userids['url_userid'] as $userid => $dummy) {
492 // Is the last notification far enougth away to notify again?
493 if ((time() - $userids['notified'][$userid]) >= getConfig('surfbar_low_interval')) {
496 'url_userid' => $userid,
497 'points' => $userids['points'][$userid],
498 'notified' => $userids['notified'][$userid]
502 SURFBAR_NOTIFY_USER('low_points', $content);
504 // Update last notified
505 SQL_QUERY_ESC("UPDATE `{?_MYSQL_PREFIX?}_user_data` SET `surfbar_low_notified`=NOW() WHERE `userid`=%s LIMIT 1",
506 array($userid), __FUNCTION__, __LINE__);
512 // -----------------------------------------------------------------------------
514 // -----------------------------------------------------------------------------
517 // Looks up by an URL
518 function SURFBAR_LOOKUP_BY_URL ($url, $userid) {
519 // Now lookup that given URL by itself
520 $urlArray = SURFBAR_GET_URL_DATA($url, 'url', 'url_id', 'ASC', 'url_id', sprintf(" AND `url_userid`=%s", bigintval($userid)));
523 return (count($urlArray) > 0);
526 // Load URL data by given search term and column
527 function SURFBAR_GET_URL_DATA ($searchTerm, $column = 'url_id', $order = 'url_id', $sort = 'ASC', $group = 'url_id', $add = '') {
528 // By default nothing is found
529 $GLOBALS['last_url_data'] = array();
531 // Is the column an id number?
532 if (($column == 'url_id') || ($column == 'url_userid')) {
533 // Extra secure input
534 $searchTerm = bigintval($searchTerm);
537 // If the column is 'id' there can be only one entry
539 if ($column == 'id') {
543 // Look up the record
544 $result = SQL_QUERY_ESC("SELECT
552 UNIX_TIMESTAMP(`url_registered`) AS `url_registered`,
553 UNIX_TIMESTAMP(`url_last_locked`) AS `url_last_locked`,
559 `{?_MYSQL_PREFIX?}_surfbar_urls`
561 `%s`='%s'" . $add . "
571 ), __FUNCTION__, __LINE__);
573 // Is there at least one record?
574 if (SQL_NUMROWS($result) > 0) {
576 while ($dataRow = SQL_FETCHARRAY($result)) {
577 // Shall we group these results?
578 if ($group == 'url_id') {
579 // Add the row by id as index
580 $GLOBALS['last_url_data'][$dataRow['url_id']] = $dataRow;
583 $GLOBALS['last_url_data'][$dataRow[$group]][$dataRow['url_id']] = $dataRow;
589 SQL_FREERESULT($result);
592 return $GLOBALS['last_url_data'];
595 // Registers an URL with the surfbar. You should have called SURFBAR_LOOKUP_BY_URL() first!
596 function SURFBAR_REGISTER_URL ($url, $userid, $status = 'PENDING', $addMode = 'reg', $extraFields = array()) {
597 // Make sure by the user registered URLs are always pending
598 if ($addMode == 'reg') {
603 $content = merge_array($extraFields, array(
605 'frametester' => generateFrametesterUrl($url),
606 'url_userid' => $userid,
607 'url_status' => $status,
610 // Is limit/reload set?
611 if (!isset($config['limit'])) {
612 $content['limit'] = '0';
614 if (!isset($config['reload'])) {
615 $content['reload'] = '0';
618 // Insert the URL into database
619 $content['insert_id'] = SURFBAR_INSERT_URL_BY_ARRAY($content);
622 if ($content['insert_id'] == '0') {
623 // INSERT did not insert any data!
627 // If in reg-mode we notify admin
628 if (($addMode == 'reg') || (getConfig('surfbar_notify_admin_unlock') == 'Y')) {
629 // Notify admin even when he as unlocked an email
630 SURFBAR_NOTIFY_ADMIN('url_' . $addMode, $content);
634 SURFBAR_NOTIFY_USER('url_' . $addMode, $content);
636 // Return the insert id
637 return $content['insert_id'];
640 // Inserts an url by given data array and return the insert id
641 function SURFBAR_INSERT_URL_BY_ARRAY ($urlData) {
643 $userid = bigintval($urlData['url_userid']);
646 if (empty($userid)) $userid = '0';
648 // Just run the insert query for now
649 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)",
653 $urlData['url_status'],
657 ), __FUNCTION__, __LINE__
661 return SQL_INSERTID();
664 // Notify admin(s) with a selected message and content
665 function SURFBAR_NOTIFY_ADMIN ($messageType, $content) {
666 // Prepare template name
667 $templateName = sprintf("admin_surfbar_%s", $messageType);
670 $subject = getMessage(sprintf("ADMIN_SURFBAR_NOTIFY_%s_SUBJECT",
671 strtoupper($messageType)
674 // Is the subject line there?
675 if ((substr($subject, 0, 1) == '!') && (substr($subject, -1, 1) == '!')) {
676 // Set default subject if following eval() wents wrong
677 $subject = getMaskedMessage('ADMIN_SURFBAR_NOTIFY_DEFAULT_SUBJECT', strtoupper($messageType));
680 // Translate some data if present
681 $content = SURFBAR_PREPARE_CONTENT_FOR_TEMPLATE($content);
683 // Send the notification out
684 return sendAdminNotification($subject, $templateName, $content, $content['url_userid']);
687 // Notify the user about the performed action
688 function SURFBAR_NOTIFY_USER ($messageType, $content) {
689 // Skip notification if userid is zero
690 if ($content['url_userid'] == '0') {
694 // Prepare template name
695 $templateName = sprintf("member_surfbar_%s", $messageType);
698 $subject = getMessage(sprintf("MEMBER_SURFBAR_NOTIFY_%s_SUBJECT",
699 strtoupper($messageType)
702 // Is the subject line there?
703 if ((substr($subject, 0, 1) == '!') && (substr($subject, -1, 1) == '!')) {
704 // Set default subject if following eval() wents wrong
705 $subject = getMessage('MEMBER_SURFBAR_NOTIFY_DEFAULT_SUBJECT');
708 // Translate some data if present
709 $content = SURFBAR_PREPARE_CONTENT_FOR_TEMPLATE($content);
712 $mailText = loadEmailTemplate($templateName, $content, $content['url_userid']);
715 return sendEmail($content['url_userid'], $subject, $mailText);
718 // Translates some data for template usage
719 // @TODO Can't we use our new expression language instead of this ugly code?
720 function SURFBAR_PREPARE_CONTENT_FOR_TEMPLATE ($content) {
722 if (isset($content['url_registered'])) $content['url_registered'] = generateDateTime($content['url_registered'], 2);
723 if (isset($content['url_last_locked'])) $content['url_last_locked'] = generateDateTime($content['url_last_locked'], 2);
725 // Return translated content
729 // Translates the limit
730 function translateSurfbarLimit ($limit) {
734 $return = getMessage('MEMBER_SURFBAR_UNLIMITED_VIEWS');
737 $return = translateComma($limit);
744 // Translate the URL status
745 function translateSurfbarUrlStatus ($status) {
746 // Create constant name
747 $constantName = sprintf("SURFBAR_URL_STATUS_%s", strtoupper($status));
750 $statusTranslated = getMessage($constantName);
753 return $statusTranslated;
757 function SURFBAR_DETERMINE_REWARD ($onlyMin=false) {
758 // Static values are default
759 $reward = getConfig('surfbar_static_reward');
761 // Do we have static or dynamic?
762 if (getConfig('surfbar_pay_model') == 'DYNAMIC') {
763 // "Calculate" dynamic reward
765 $reward += SURFBAR_CALCULATE_DYNAMIC_MIN_VALUE();
767 $reward += SURFBAR_CALCULATE_DYNAMIC_ADD();
776 function SURFBAR_DETERMINE_COSTS ($onlyMin=false) {
777 // Static costs is default
778 $costs = getConfig('surfbar_static_costs');
780 // Do we have static or dynamic?
781 if (getConfig('surfbar_pay_model') == 'DYNAMIC') {
782 // "Calculate" dynamic costs
784 $costs += SURFBAR_CALCULATE_DYNAMIC_MIN_VALUE();
786 $costs += SURFBAR_CALCULATE_DYNAMIC_ADD();
794 // "Calculate" dynamic add
795 function SURFBAR_CALCULATE_DYNAMIC_ADD () {
796 // Get min/max values
797 $min = SURFBAR_CALCULATE_DYNAMIC_MIN_VALUE();
798 $max = SURFBAR_CALCULATE_DYNAMIC_MAX_VALUE();
800 // "Calculate" dynamic part and return it
801 return mt_rand($min, $max);
804 // Determine right template name
805 function SURFBAR_DETERMINE_TEMPLATE_NAME() {
806 // Default is the frameset
807 $templateName = "surfbar_frameset";
809 // Any frame set? ;-)
810 if (isGetRequestParameterSet('frame')) {
811 // Use the frame as a template name part... ;-)
812 $templateName = sprintf("surfbar_frame_%s",
813 getRequestParameter('frame')
818 return $templateName;
821 // Check if the "reload lock" of the current user is full, call this function
822 // before you call SURFBAR_CHECK_RELOAD_LOCK().
823 function SURFBAR_CHECK_RELOAD_FULL() {
827 // Cache static reload lock
828 $GLOBALS['surfbar_cache']['surf_lock'] = getConfig('surfbar_static_lock');
829 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'Fixed surf lock is '.getConfig('surfbar_static_lock') . '', false);
831 // Do we have dynamic model?
832 if (getConfig('surfbar_pay_model') == 'DYNAMIC') {
833 // "Calculate" dynamic lock
834 $GLOBALS['surfbar_cache']['surf_lock'] += SURFBAR_CALCULATE_DYNAMIC_ADD();
838 $result = SQL_QUERY_ESC("SELECT
839 COUNT(l.locks_id) AS cnt
841 `{?_MYSQL_PREFIX?}_surfbar_locks` AS l
843 `{?_MYSQL_PREFIX?}_surfbar_urls` AS u
845 u.url_id=l.locks_url_id
847 l.locks_userid=%s AND
848 (UNIX_TIMESTAMP() - ".SURFBAR_GET_SURF_LOCK().") < UNIX_TIMESTAMP(l.locks_last_surfed) AND
850 ((UNIX_TIMESTAMP(l.locks_last_surfed) - u.url_fixed_reload) < 0 AND u.url_fixed_reload > 0) OR
851 u.url_fixed_reload = '0'
854 array(getMemberId()), __FUNCTION__, __LINE__
858 list($GLOBALS['surfbar_cache']['user_locks']) = SQL_FETCHROW($result);
861 if (is_null($GLOBALS['surfbar_cache']['user_locks'])) {
862 // Then fix it to zero!
863 $GLOBALS['surfbar_cache']['user_locks'] = '0';
867 SQL_FREERESULT($result);
870 $total = SURFBAR_GET_TOTAL_URLS();
872 // Do we have some URLs in lock? Admins can always surf on own URLs!
873 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, "userLocks=".SURFBAR_GET_USER_LOCKS().",total={$total}", false);
874 $isFull = ((SURFBAR_GET_USER_LOCKS() == $total) && ($total > 0));
880 // Get total amount of URLs of given status for current user or of ACTIVE URLs by default
881 function SURFBAR_GET_TOTAL_URLS ($status = 'ACTIVE', $excludeUserId = '0') {
882 // Determine depleted user account
883 $userids = SURFBAR_DETERMINE_DEPLETED_USERIDS();
885 // If we dont get any user ids back, there are no URLs
886 if (count($userids['url_userid']) == 0) {
887 // No user ids found, no URLs!
891 // Is the exlude userid set?
892 if ($excludeUserId > 0) {
894 $userids['url_userid'][$excludeUserId] = $excludeUserId;
897 // Get amount from database
898 $result = SQL_QUERY_ESC("SELECT
899 COUNT(`url_id`) AS cnt
901 `{?_MYSQL_PREFIX?}_surfbar_urls`
903 `url_userid` NOT IN (".implode(', ', $userids['url_userid']).") AND
906 array($status), __FUNCTION__, __LINE__
910 list($cnt) = SQL_FETCHROW($result);
913 SQL_FREERESULT($result);
919 // Check wether the user is allowed to book more URLs
920 function SURFBAR_IF_USER_BOOK_MORE_URLS ($userid = '0') {
921 // Is this admin and userid is zero or does the user has some URLs left to book?
922 return ((($userid == '0') && (isAdmin())) || (SURFBAR_GET_TOTAL_USER_URLS($userid, '', array('REJECTED')) < getConfig('surfbar_max_order')));
925 // Get total amount of URLs of given status for current user
926 function SURFBAR_GET_TOTAL_USER_URLS ($userid = '0', $status = '', $exclude = '') {
927 // Is the user 0 and user is logged in?
928 if (($userid == '0') && (isMember())) {
929 // Then use this userid
930 $userid = getMemberId();
931 } elseif ($userid == '0') {
933 return (getConfig('surfbar_max_order') + 1);
936 // Default is all URLs
939 // Is the status set?
940 if (is_array($status)) {
941 // Only URLs with these status
942 $add = sprintf(" AND `url_status` IN('%s')", implode("','", $status));
943 } elseif (!empty($status)) {
944 // Only URLs with this status
945 $add = sprintf(" AND `url_status`='%s'", $status);
946 } elseif (is_array($exclude)) {
947 // Exclude URLs with these status
948 $add = sprintf(" AND `url_status` NOT IN('%s')", implode("','", $exclude));
949 } elseif (!empty($exclude)) {
950 // Exclude URLs with this status
951 $add = sprintf(" AND `url_status` != '%s'", $exclude);
954 // Get amount from database
955 $cnt = countSumTotalData($userid, 'surfbar_urls', 'url_id', 'url_userid', true, $add);
961 // Generate a validation code for the given id number
962 function SURFBAR_GENERATE_VALIDATION_CODE ($urlId, $salt = '') {
963 // @TODO Invalid salt should be refused
964 $GLOBALS['surfbar_cache']['salt'] = 'INVALID';
966 // Get code length from config
967 $length = getConfig('code_length');
970 if ($length == '0') $length = 10;
972 // Generate a code until the length matches
974 while (strlen($valCode) != $length) {
977 // Generate random hashed string
978 $GLOBALS['surfbar_cache']['salt'] = sha1(generatePassword(mt_rand(200, 255)));
979 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'newSalt='.SURFBAR_GET_SALT().'', false);
982 $GLOBALS['surfbar_cache']['salt'] = $salt;
983 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'oldSalt='.SURFBAR_GET_SALT().'', false);
986 // ... and now the validation code
987 $valCode = generateRandomCode($length, sha1(SURFBAR_GET_SALT().':'.$urlId), getMemberId());
988 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'valCode='.valCode.'', false);
991 // Hash it with md5() and salt it with the random string
992 $hashedCode = generateHash(md5($valCode), SURFBAR_GET_SALT());
994 // Finally encrypt it PGP-like and return it
995 $valHashedCode = encodeHashForCookie($hashedCode);
997 // Return hashed value
998 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'finalValCode='.$valHashedCode.'', false);
999 return $valHashedCode;
1002 // Check validation code
1003 function SURFBAR_CHECK_VALIDATION_CODE ($urlId, $check, $salt) {
1005 $urlId = bigintval($urlId);
1007 // Now generate the code again
1008 $code = SURFBAR_GENERATE_VALIDATION_CODE($urlId, $salt);
1010 // Return result of checking hashes and salts
1011 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, '---'.$code.'|'.$check.'---', false);
1012 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, '+++'.$salt.'|'.SURFBAR_GET_DATA('salts_last_salt').'+++', false);
1013 return (($code == $check) && ($salt == SURFBAR_GET_DATA('salts_last_salt')));
1016 // Lockdown the userid/id combination (reload lock)
1017 function SURFBAR_LOCKDOWN_ID ($urlId) {
1018 //* DEBUG: */ outputHtml('LOCK!');
1019 ///* DEBUG: */ return;
1020 // Just add it to the database
1021 SQL_QUERY_ESC("INSERT INTO `{?_MYSQL_PREFIX?}_surfbar_locks` (`locks_userid`, `locks_url_id`) VALUES (%s, %s)",
1022 array(getMemberId(), bigintval($urlId)), __FUNCTION__, __LINE__);
1024 // Remove the salt from database
1025 SQL_QUERY_ESC("DELETE LOW_PRIORITY FROM `{?_MYSQL_PREFIX?}_surfbar_salts` WHERE `salts_url_id`=%s AND `salts_userid`=%s LIMIT 1",
1026 array(bigintval($urlId), getMemberId()), __FUNCTION__, __LINE__);
1029 // Pay points to the user and remove it from the sender if userid is given else it is a "sponsored surf"
1030 function SURFBAR_PAY_POINTS () {
1031 // Remove it from the URL owner
1032 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'userid='.SURFBAR_GET_USERID().',costs='.SURFBAR_GET_COSTS().'', false);
1033 if (SURFBAR_GET_USERID() > 0) {
1034 subtractPoints(sprintf("surfbar_%s", getConfig('surfbar_pay_model')), SURFBAR_GET_USERID(), SURFBAR_GET_COSTS());
1037 // Book it to the user
1038 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'userid='.getMemberId().',reward='.SURFBAR_GET_REWARD().'', false);
1039 addPointsThroughReferalSystem(sprintf("surfbar_%s", getConfig('surfbar_pay_model')), getMemberId(), SURFBAR_GET_DATA('reward'));
1042 // Updates the statistics of current URL/userid
1043 function SURFBAR_UPDATE_INSERT_STATS_RECORD () {
1047 // Get allowed views
1048 $allowed = SURFBAR_GET_VIEWS_ALLOWED();
1050 // Do we have a limit?
1052 // Then count views_max down!
1053 $add .= ", `views_max`=`views_max`-1";
1057 SQL_QUERY_ESC("UPDATE `{?_MYSQL_PREFIX?}_surfbar_urls` SET `url_views_total`=`url_views_total`+1".$add." WHERE `url_id`=%s LIMIT 1",
1058 array(SURFBAR_GET_ID()), __FUNCTION__, __LINE__);
1060 // Update the stats entry
1061 SQL_QUERY_ESC("UPDATE `{?_MYSQL_PREFIX?}_surfbar_stats` SET `stats_count`=`stats_count`+1 WHERE `stats_userid`=%s AND `stats_url_id`=%s LIMIT 1",
1065 ), __FUNCTION__, __LINE__);
1067 // Was that update okay?
1068 if (SQL_AFFECTEDROWS() < 1) {
1069 // No, then insert entry
1070 SQL_QUERY_ESC("INSERT INTO `{?_MYSQL_PREFIX?}_surfbar_stats` (`stats_userid`, `stats_url_id`, `stats_count`) VALUES (%s,%s,1)",
1074 ), __FUNCTION__, __LINE__);
1077 // Update total/daily/weekly/monthly counter
1078 incrementConfigEntry('surfbar_total_counter');
1079 incrementConfigEntry('surfbar_daily_counter');
1080 incrementConfigEntry('surfbar_weekly_counter');
1081 incrementConfigEntry('surfbar_monthly_counter');
1083 // Update config as well
1084 updateConfiguration(array('surfbar_total_counter', 'surfbar_daily_counter', 'surfbar_weekly_counter', 'surfbar_monthly_counter'), array(1,1,1,1), '+');
1087 // Update the salt for validation and statistics
1088 function SURFBAR_UPDATE_SALT_STATS () {
1089 // Update statistics record
1090 SURFBAR_UPDATE_INSERT_STATS_RECORD();
1092 // Simply store the salt from cache away in database...
1093 SQL_QUERY_ESC("UPDATE `{?_MYSQL_PREFIX?}_surfbar_salts` SET `salts_last_salt`='%s' WHERE `salts_url_id`=%s AND `salts_userid`=%s LIMIT 1",
1098 ), __FUNCTION__, __LINE__);
1101 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'salt='.SURFBAR_GET_SALT().',id='.SURFBAR_GET_ID().',userid='.getMemberId().'', false);
1104 if (SQL_AFFECTEDROWS() < 1) {
1105 // Insert missing entry!
1106 SQL_QUERY_ESC("INSERT INTO `{?_MYSQL_PREFIX?}_surfbar_salts` (`salts_url_id`, `salts_userid`, `salts_last_salt`) VALUES (%s, %s, '%s')",
1107 array(SURFBAR_GET_ID(), getMemberId(), SURFBAR_GET_SALT()), __FUNCTION__, __LINE__);
1111 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'affectedRows='.SQL_AFFECTEDROWS().'', false);
1113 // Return if the update was okay
1114 return (SQL_AFFECTEDROWS() == 1);
1117 // Check if the reload lock is active for given id
1118 function SURFBAR_CHECK_RELOAD_LOCK ($urlId) {
1119 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'id=' . $urlId . '', false);
1121 $result = SQL_QUERY_ESC("SELECT COUNT(`locks_id`) AS cnt
1123 `{?_MYSQL_PREFIX?}_surfbar_locks`
1125 `locks_userid`=%s AND
1126 `locks_url_id`=%s AND
1127 (UNIX_TIMESTAMP() - ".SURFBAR_GET_SURF_LOCK().") < UNIX_TIMESTAMP(`locks_last_surfed`)
1129 `locks_last_surfed` ASC
1131 array(getMemberId(), bigintval($urlId)), __FUNCTION__, __LINE__
1135 list($cnt) = SQL_FETCHROW($result);
1138 SQL_FREERESULT($result);
1141 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'cnt=' . $cnt . ',' . SURFBAR_GET_SURF_LOCK() . '', false);
1145 // Determine which user hash no more points left
1146 function SURFBAR_DETERMINE_DEPLETED_USERIDS ($limit=0) {
1149 'url_userid' => array(),
1150 'points' => array(),
1151 'notified' => array(),
1154 // Do we have a current user id?
1155 if ((isMember()) && ($limit == '0')) {
1156 // Then add this as well
1157 $userids['url_userid'][getMemberId()] = getMemberId();
1158 $userids['points'][getMemberId()] = countSumTotalData(getMemberId(), 'user_points', 'points') - countSumTotalData(getMemberId(), 'user_data', 'used_points');
1159 $userids['notified'][getMemberId()] = '0';
1161 // Get all userid except logged in one
1162 $result = SQL_QUERY_ESC("SELECT
1163 u.url_userid, UNIX_TIMESTAMP(d.surfbar_low_notified) AS notified
1165 `{?_MYSQL_PREFIX?}_surfbar_urls` AS u
1167 `{?_MYSQL_PREFIX?}_user_data` AS d
1169 u.url_userid=d.userid
1171 u.url_userid NOT IN (%s,0) AND u.url_status='ACTIVE'
1176 array(getMemberId()), __FUNCTION__, __LINE__);
1179 $result = SQL_QUERY("SELECT
1180 u.url_userid, UNIX_TIMESTAMP(d.surfbar_low_notified) AS notified
1182 `{?_MYSQL_PREFIX?}_surfbar_urls` AS u
1184 `{?_MYSQL_PREFIX?}_user_data` AS d
1186 u.url_userid=d.userid
1188 u.url_status='ACTIVE'
1192 u.url_userid ASC", __FUNCTION__, __LINE__);
1196 while ($content = SQL_FETCHARRAY($result)) {
1198 $points = countSumTotalData($content['url_userid'], 'user_points', 'points') - countSumTotalData($content['url_userid'], 'user_data', 'used_points');
1199 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, "userid={$content['url_userid']},points={$points}", false);
1201 // Shall we add this to ignore?
1202 if ($points <= $limit) {
1204 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, "userid={$content['url_userid']} has depleted points amount!", false);
1205 $userids['url_userid'][$content['url_userid']] = $content['url_userid'];
1206 $userids['points'][$content['url_userid']] = $points;
1207 $userids['notified'][$content['url_userid']] = $content['notified'];
1212 SQL_FREERESULT($result);
1215 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, "UIDs::count=".count($userids)." (with own userid=".getMemberId().')', false);
1221 // Determine how many users are Online in surfbar
1222 function SURFBAR_DETERMINE_TOTAL_ONLINE () {
1223 // Count all users in surfbar modue and return the value
1224 $result = SQL_QUERY("SELECT
1227 `{?_MYSQL_PREFIX?}_surfbar_stats`
1229 (UNIX_TIMESTAMP() - UNIX_TIMESTAMP(`stats_last_surfed`)) <= {?online_timeout?}
1231 `stats_userid` ASC", __FUNCTION__, __LINE__);
1234 $cnt = SQL_NUMROWS($result);
1237 SQL_FREERESULT($result);
1243 // Determine waiting time for one URL
1244 function SURFBAR_DETERMINE_WAIT_TIME () {
1245 // Get fixed reload lock
1246 $fixed = SURFBAR_GET_FIXED_RELOAD();
1248 // Is the fixed reload time set?
1254 // Static time is default
1255 $time = getConfig('surfbar_static_time');
1257 // Which payment model do we have?
1258 if (getConfig('surfbar_pay_model') == 'DYNAMIC') {
1259 // "Calculate" dynamic time
1260 $time += SURFBAR_CALCULATE_DYNAMIC_ADD();
1267 // Changes the status of an URL from given to other
1268 function SURFBAR_CHANGE_STATUS ($urlId, $prevStatus, $newStatus, $data=array()) {
1269 // Make new status always lower-case
1270 $newStatus = strtolower($newStatus);
1272 // Get URL data for status comparison if missing
1273 if ((!is_array($data)) || (count($data) == 0)) {
1274 // Fetch missing URL data
1275 $data = SURFBAR_GET_URL_DATA($urlId);
1278 // Is the new status set?
1279 if ((!is_string($newStatus)) || (empty($newStatus))) {
1280 // Abort here, but fine!
1284 // Is the status like prevStatus is saying?
1285 if ($data[$urlId]['url_status'] != $prevStatus) {
1286 // No, then abort here
1291 // Update the status now
1292 // ---------- Comment out for debugging/developing member actions! ---------
1293 //SQL_QUERY_ESC("UPDATE `{?_MYSQL_PREFIX?}_surfbar_urls` SET `status`='%s' WHERE `url_id`=%s LIMIT 1",
1294 // array($newStatus, bigintval($urlId)), __FUNCTION__, __LINE__);
1295 // ---------- Comment out for debugging/developing member actions! ---------
1298 // ---------- Comment out for debugging/developing member actions! ---------
1299 //if (SQL_AFFECTEDROWS() != 1) {
1300 // // No, something went wrong
1303 // ---------- Comment out for debugging/developing member actions! ---------
1305 // Prepare content for notification routines
1306 $data[$urlId]['url_userid'] = $data[$urlId]['url_userid'];
1307 $data[$urlId]['frametester'] = generateFrametesterUrl($data[$urlId]['url']);
1308 $data[$urlId]['reward'] = translateComma(getConfig('surfbar_static_reward'));
1309 $data[$urlId]['costs'] = translateComma(getConfig('surfbar_static_costs'));
1311 // Do some dirty fixing here:
1312 if (($data[$urlId]['url_status'] == 'STOPPED') && ($newStatus == 'pending')) {
1313 // Fix for template change
1314 $newStatus = 'continued';
1317 // Send admin notification
1318 SURFBAR_NOTIFY_ADMIN('url_' . $data[$urlId]['url_status'] . '_' . $newStatus, $data[$urlId]);
1320 // Send user notification
1321 SURFBAR_NOTIFY_USER('url_' . $data[$urlId]['url_status'] . '_' . $newStatus, $data[$urlId]);
1327 // Calculate minimum value for dynamic payment model
1328 function SURFBAR_CALCULATE_DYNAMIC_MIN_VALUE () {
1329 // Addon is zero by default
1333 $percent = abs(log(getConfig('surfbar_dynamic_percent') / 100 + 1));
1336 $totalUsers = getTotalConfirmedUser();
1339 $onlineUsers = SURFBAR_DETERMINE_TOTAL_ONLINE();
1342 $addon += abs(log($onlineUsers / $totalUsers + 1) * $percent * $totalUsers);
1345 $totalUrls = SURFBAR_GET_TOTAL_URLS('ACTIVE', 0);
1347 // Get user's total URLs
1348 $userUrls = SURFBAR_GET_TOTAL_USER_URLS(0, 'ACTIVE');
1351 if ($totalUrls > 0) {
1352 $addon += abs(log($userUrls / $totalUrls + 1) * $percent * $totalUrls);
1354 $addon += abs(log($userUrls / 1 + 1) * $percent * $totalUrls);
1361 // Calculate maximum value for dynamic payment model
1362 function SURFBAR_CALCULATE_DYNAMIC_MAX_VALUE () {
1363 // Addon is zero by default
1370 $percent = abs(log(getConfig('surfbar_dynamic_percent') / 100 + 1));
1373 $totalUsers = getTotalConfirmedUser();
1376 $addon += abs($max * $percent * $totalUsers);
1379 $totalUrls = SURFBAR_GET_TOTAL_URLS('ACTIVE', 0);
1382 $addon += abs($max * $percent * $totalUrls);
1388 // Calculate dynamic lock
1389 function SURFBAR_CALCULATE_DYNAMIC_LOCK () {
1390 // Default lock is 30 seconds
1394 $onlineUsers = SURFBAR_DETERMINE_TOTAL_ONLINE();
1397 $addon = abs(log($onlineUsers / $addon + 1));
1403 // "Getter" for lock ids array
1404 function SURFBAR_GET_LOCK_IDS () {
1405 // Prepare some arrays
1410 // Get all id from locks within the timestamp
1411 $result = SQL_QUERY_ESC("SELECT `locks_id`, `locks_url_id`, UNIX_TIMESTAMP(`locks_last_surfed`) AS last_surfed
1413 `{?_MYSQL_PREFIX?}_surfbar_locks`
1417 `locks_id` ASC", array(getMemberId()),
1418 __FUNCTION__, __LINE__);
1421 while ($content = SQL_FETCHARRAY($result)) {
1423 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'next - lid='.$content['id'].',url='.$content['url_id'].',rest='.(time() - $content['last_surfed']).'/'.SURFBAR_GET_SURF_LOCK().'', false);
1425 // Skip entries that are too old
1426 if (($content['last_surfed'] > (time() - SURFBAR_GET_SURF_LOCK())) && (!in_array($content['url_id'], $ignored))) {
1428 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'okay - lid='.$content['id'].',url='.$content['url_id'].',last='.$content['last_surfed'].'', false);
1430 // Add only if missing or bigger
1431 if ((!isset($IDs[$content['url_id']])) || ($IDs[$content['url_id']] > $content['last_surfed'])) {
1433 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'ADD - lid='.$content['id'].',url='.$content['url_id'].',last='.$content['last_surfed'].'', false);
1436 $IDs[$content['url_id']] = $content['last_surfed'];
1437 $USE[$content['url_id']] = $content['id'];
1441 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'ignore - lid='.$content['id'].',url='.$content['url_id'].',last='.$content['last_surfed'].'', false);
1443 // Ignore these old entries!
1444 $ignored[] = $content['url_id'];
1445 unset($IDs[$content['url_id']]);
1446 unset($USE[$content['url_id']]);
1451 SQL_FREERESULT($result);
1457 // "Getter" for maximum random number
1458 function SURFBAR_GET_MAX_RANDOM ($userids, $add) {
1459 // Count max availabe entries
1460 $result = SQL_QUERY("SELECT
1463 `{?_MYSQL_PREFIX?}_surfbar_urls` AS sbu
1465 `{?_MYSQL_PREFIX?}_surfbar_salts` AS sbs
1467 sbu.url_id=sbs.salts_url_id
1469 `{?_MYSQL_PREFIX?}_surfbar_locks` AS l
1471 sbu.url_id=l.locks_url_id
1473 sbu.url_userid NOT IN (".implode(',', $userids).") AND
1474 (sbu.url_views_allowed=0 OR (sbu.url_views_allowed > 0 AND sbu.url_views_max > 0)) AND
1475 sbu.url_status='ACTIVE'
1478 sbu.url_id ASC", __FUNCTION__, __LINE__);
1481 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'lastQuery='.getConfig('db_last_query').'|numRows='.SQL_NUMROWS($result).'|Affected='.SQL_AFFECTEDROWS().'', false);
1484 $maxRand = SQL_NUMROWS($result);
1487 SQL_FREERESULT($result);
1493 // Load all URLs of the current user and return it as an array
1494 function SURFBAR_GET_USER_URLS () {
1496 $urlArray = array();
1499 $result = SQL_QUERY_ESC("SELECT
1506 u.url_views_allowed,
1507 UNIX_TIMESTAMP(u.url_registered) AS `url_registered`,
1508 UNIX_TIMESTAMP(u.url_last_locked) AS `url_last_locked`,
1511 `{?_MYSQL_PREFIX?}_surfbar_urls` AS u
1514 u.url_status != 'DELETED'
1517 array(getMemberId()), __FUNCTION__, __LINE__);
1519 // Are there entries?
1520 if (SQL_NUMROWS($result) > 0) {
1522 while ($row = SQL_FETCHARRAY($result)) {
1524 $urlArray[$row['id']] = $row;
1529 SQL_FREERESULT($result);
1535 // "Getter" for member action array for given status
1536 function SURFBAR_GET_ARRAY_FROM_STATUS ($status) {
1538 $returnArray = array();
1540 // Get all assigned actions
1541 $result = SQL_QUERY_ESC("SELECT `action` FROM `{?_MYSQL_PREFIX?}_surfbar_actions` WHERE `actions_status`='%s' ORDER BY `actions_id` ASC",
1542 array($status), __FUNCTION__, __LINE__);
1544 // Some entries there?
1545 if (SQL_NUMROWS($result) > 0) {
1547 // @TODO This can be somehow rewritten
1548 while ($content = SQL_FETCHARRAY($result)) {
1549 $returnArray[] = $content['action'];
1554 SQL_FREERESULT($result);
1557 return $returnArray;
1560 // Reload to configured stop page
1561 function SURFBAR_RELOAD_TO_STOP_PAGE ($page = 'stop') {
1562 // Internal or external?
1563 if ((getConfig('surfbar_pause_mode') == 'INTERNAL') || (getConfig('surfbar_pause_url') == '')) {
1564 // Reload to internal page
1565 redirectToUrl('surfbar.php?frame=' . $page);
1567 // Reload to external page
1568 redirectToConfiguredUrl('surfbar_pause_url');
1572 // Determine next id for surfbar or get data for given id, always call this before you call other
1573 // getters below this function!!!
1574 function SURFBAR_DETERMINE_NEXT_ID ($urlId = '0') {
1575 // Default is no id and no random number
1580 if ($urlId == '0') {
1581 // Get array with lock ids
1582 $USE = SURFBAR_GET_LOCK_IDS();
1584 // Shall we add some URL ids to ignore?
1586 if (count($USE) > 0) {
1588 $add = " AND sbu.url_id NOT IN (";
1589 foreach ($USE as $url_id => $lid) {
1591 $add .= $url_id.',';
1594 // Add closing bracket
1595 $add = substr($add, 0, -1) . ')';
1598 // Determine depleted user account
1599 $userids = SURFBAR_DETERMINE_DEPLETED_USERIDS();
1601 // Get maximum randomness factor
1602 $maxRand = SURFBAR_GET_MAX_RANDOM($userids['url_userid'], $add);
1604 // If more than one URL can be called generate the random number!
1606 // Generate random number
1607 $randNum = mt_rand(0, ($maxRand - 1));
1610 // And query the database
1611 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'randNum='.$randNum.',maxRand='.$maxRand.',surfLock='.SURFBAR_GET_SURF_LOCK().'', false);
1612 $result = SQL_QUERY_ESC("SELECT
1616 sbs.salts_last_salt,
1617 sbu.url_views_total,
1619 sbu.url_views_allowed,
1620 UNIX_TIMESTAMP(l.locks_last_surfed) AS last_surfed,
1621 sbu.url_fixed_reload
1623 `{?_MYSQL_PREFIX?}_surfbar_urls` AS sbu
1625 `{?_MYSQL_PREFIX?}_surfbar_salts` AS sbs
1627 sbu.url_id=sbs.salts_url_id
1629 `{?_MYSQL_PREFIX?}_surfbar_locks` AS l
1631 sbu.url_id=l.locks_url_id
1633 sbu.url_userid NOT IN (".implode(',', $userids['url_userid']).") AND
1634 sbu.url_status='ACTIVE' AND
1635 (sbu.url_views_allowed=0 OR (sbu.url_views_allowed > 0 AND sbu.url_views_max > 0))
1640 l.locks_last_surfed ASC,
1643 array($randNum), __FUNCTION__, __LINE__
1646 // Get data from specified id number
1647 $result = SQL_QUERY_ESC("SELECT
1651 sbs.salts_last_salt,
1652 sbu.url_views_total,
1654 sbu.url_views_allowed,
1655 UNIX_TIMESTAMP(l.locks_last_surfed) AS last_surfed,
1656 sbu.url_fixed_reload
1658 `{?_MYSQL_PREFIX?}_surfbar_urls` AS sbu
1660 `{?_MYSQL_PREFIX?}_surfbar_salts` AS sbs
1662 sbu.url_id=sbs.salts_url_id
1664 `{?_MYSQL_PREFIX?}_surfbar_locks` AS l
1666 sbu.url_id=l.locks_url_id
1668 sbu.url_userid != %s AND
1669 sbu.url_status='ACTIVE' AND
1671 (sbu.url_views_allowed=0 OR (sbu.url_views_allowed > 0 AND sbu.url_views_max > 0))
1673 array(getMemberId(), bigintval($urlId)), __FUNCTION__, __LINE__
1677 // Is there an id number?
1678 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'lastQuery='.getConfig('db_last_query').'|numRows='.SQL_NUMROWS($result).'|Affected='.SQL_AFFECTEDROWS().'', false);
1679 if (SQL_NUMROWS($result) == 1) {
1681 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'count('.count($GLOBALS['surfbar_cache']).') - BEFORE', false);
1682 $GLOBALS['surfbar_cache'] = merge_array($GLOBALS['surfbar_cache'], SQL_FETCHARRAY($result));
1683 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'count('.count($GLOBALS['surfbar_cache']).') - AFTER', false);
1685 // Determine waiting time
1686 $GLOBALS['surfbar_cache']['time'] = SURFBAR_DETERMINE_WAIT_TIME();
1688 // Is the last salt there?
1689 if (is_null($GLOBALS['surfbar_cache']['salts_last_salt'])) {
1690 // Then repair it wit the static!
1691 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'last_salt - FIXED!', false);
1692 $GLOBALS['surfbar_cache']['salts_last_salt'] = '';
1695 // Fix missing last_surfed
1696 if ((!isset($GLOBALS['surfbar_cache']['last_surfed'])) || (is_null($GLOBALS['surfbar_cache']['last_surfed']))) {
1698 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'last_surfed - FIXED!', false);
1699 $GLOBALS['surfbar_cache']['last_surfed'] = '0';
1702 // Get base/fixed reward and costs
1703 $GLOBALS['surfbar_cache']['reward'] = SURFBAR_DETERMINE_REWARD();
1704 $GLOBALS['surfbar_cache']['costs'] = SURFBAR_DETERMINE_COSTS();
1705 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'BASE/STATIC - reward='.SURFBAR_GET_REWARD().'|costs='.SURFBAR_GET_COSTS().'', false);
1707 // Only in dynamic model add the dynamic bonus!
1708 if (getConfig('surfbar_pay_model') == 'DYNAMIC') {
1709 // Calculate dynamic reward/costs and add it
1710 $GLOBALS['surfbar_cache']['reward'] += SURFBAR_CALCULATE_DYNAMIC_ADD();
1711 $GLOBALS['surfbar_cache']['costs'] += SURFBAR_CALCULATE_DYNAMIC_ADD();
1712 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'DYNAMIC+ - reward='.SURFBAR_GET_REWARD().'|costs='.SURFBAR_GET_COSTS().'', false);
1716 $nextId = SURFBAR_GET_ID();
1720 SQL_FREERESULT($result);
1723 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'nextId='.$nextId.'', false);
1727 // -----------------------------------------------------------------------------
1728 // PLEASE DO NOT ADD ANY OTHER FUNCTIONS BELOW THIS LINE IF THEY DON'T "WRAP"
1729 // THE $GLOBALS['surfbar_cache'] ARRAY!
1730 // -----------------------------------------------------------------------------
1732 // Initializes the surfbar
1733 function SURFBAR_INIT () {
1735 $GLOBALS['surfbar_cache'] = array();
1738 // Private getter for data elements
1739 function SURFBAR_GET_DATA ($element) {
1740 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, "element={$element}", false);
1745 // Is the entry there?
1746 if (isset($GLOBALS['surfbar_cache'][$element])) {
1748 $data = $GLOBALS['surfbar_cache'][$element];
1749 } else { // END - if
1751 print_r($GLOBALS['surfbar_cache']);
1753 debug_report_bug(__FUNCTION__, __LINE__, 'Element ' . $element . ' not found.');
1757 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'element[' . $element . ']=[' . gettype($data) . ']' . $data, false);
1761 // Getter for reward from cache
1762 function SURFBAR_GET_REWARD () {
1763 // Get data element and return its contents
1764 return SURFBAR_GET_DATA('reward');
1767 // Getter for costs from cache
1768 function SURFBAR_GET_COSTS () {
1769 // Get data element and return its contents
1770 return SURFBAR_GET_DATA('costs');
1773 // Getter for URL from cache
1774 function SURFBAR_GET_URL () {
1775 // Get data element and return its contents
1776 return SURFBAR_GET_DATA('url');
1779 // Getter for salt from cache
1780 function SURFBAR_GET_SALT () {
1781 // Get data element and return its contents
1782 return SURFBAR_GET_DATA('salt');
1785 // Getter for id from cache
1786 function SURFBAR_GET_ID () {
1787 // Get data element and return its contents
1788 return SURFBAR_GET_DATA('url_id');
1791 // Getter for userid from cache
1792 function SURFBAR_GET_USERID () {
1793 // Get data element and return its contents
1794 return SURFBAR_GET_DATA('url_userid');
1797 // Getter for user reload locks
1798 function SURFBAR_GET_USER_LOCKS () {
1799 // Get data element and return its contents
1800 return SURFBAR_GET_DATA('user_locks');
1803 // Getter for reload time
1804 function SURFBAR_GET_RELOAD_TIME () {
1805 // Get data element and return its contents
1806 return SURFBAR_GET_DATA('time');
1809 // Getter for allowed views
1810 function SURFBAR_GET_VIEWS_ALLOWED () {
1811 // Get data element and return its contents
1812 return SURFBAR_GET_DATA('url_views_allowed');
1815 // Getter for maximum views
1816 function SURFBAR_GET_VIEWS_MAX () {
1817 // Get data element and return its contents
1818 return SURFBAR_GET_DATA('url_views_max');
1821 // Getter for fixed reload
1822 function SURFBAR_GET_FIXED_RELOAD () {
1823 // Get data element and return its contents
1824 return SURFBAR_GET_DATA('url_fixed_reload');
1827 // Getter for surf lock
1828 function SURFBAR_GET_SURF_LOCK () {
1829 // Get data element and return its contents
1830 return SURFBAR_GET_DATA('surf_lock');
1833 // Getter for new status
1834 function SURFBAR_GET_NEW_STATUS () {
1835 // Get data element and return its contents
1836 return SURFBAR_GET_DATA('new_status');