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 // Include fields only for action 'edit'
370 if ($action == 'edit') {
371 // Default is not limited
372 $urlData['limited_y'] = '';
373 $urlData['limited_n'] = ' checked="checked"';
374 $urlData['limited'] = 'false';
376 // Is this URL limited?
377 if (SURFBAR_GET_VIEWS_MAX() > 0) {
378 // Then rewrite form data
379 $urlData['limited_y'] = ' checked="checked"';
380 $urlData['limited_n'] = '';
381 $urlData['limited'] = 'true';
385 // Load the form and display it
386 loadTemplate(sprintf("member_surfbar_%s_action_form", $action), false, $urlData);
388 // All fine by default ... ;-)
392 // Execute choosen action
393 function SURFBAR_MEMBER_EXECUTE_ACTION ($action, $urlData) {
394 // By default nothing is executed
397 // Is limitation "no" and "limit" is > 0?
398 if ((isset($urlData[$action]['limited'])) && ($urlData[$action]['limited'] != 'Y') && ((isset($urlData[$action]['limit'])) && ($urlData[$action]['limit'] > 0)) || (!isset($urlData[$action]['limit']))) {
399 // Set it to unlimited
400 $urlData[$action]['limit'] = '0';
403 // Construct function name
404 $functionName = sprintf("SURFBAR_MEMBER_EXECUTE_%s_ACTION", strtoupper($action));
406 // Is that function there?
407 if (function_exists($functionName)) {
408 // Execute the function
409 if (call_user_func_array($functionName, array($urlData)) == true) {
410 // Update status as well
411 $executed = SURFBAR_CHANGE_STATUS($urlData['id'], $urlData['url_status'], $urlData['new_status'], array($urlData['id'] => $urlData));
415 addFatalMessage(__FUNCTION__, __LINE__, '{--MEMBER_SURFBAR_EXECUTE_ACTION_404--}', $functionName);
421 // "Execute edit" function: Update changed data
422 function SURFBAR_MEMBER_EXECUTE_EDIT_ACTION ($urlData) {
423 // Default is nothing done
426 // Has the URL or limit changed?
428 //if (($urlData['url_views_allowed'] != $urlData['edit']['limit']) || ($url1 != $url2)) {
430 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",
431 array($urlData['url'], $urlData['edit']['limit'], $urlData['edit']['limit'], $urlData['id'], $urlData['url_status']), __FUNCTION__, __LINE__);
440 // "Execute delete" function: Does nothing...
441 function SURFBAR_MEMBER_EXECUTE_DELETE_ACTION ($urlData) {
442 // Nothing special to do (see above function for such "special actions" to perform)
446 // -----------------------------------------------------------------------------
447 // Self-maintenance functions
448 // -----------------------------------------------------------------------------
451 function SURFBAR_HANDLE_SELF_MAINTENANCE () {
452 // Handle URLs which limit has depleted so we can stop them
453 SURFBAR_HANDLE_DEPLETED_VIEWS();
455 // Handle low-points amounts
456 SURFBAR_HANDLE_LOW_POINTS();
458 // Handle URLs which limit has depleted
459 function SURFBAR_HANDLE_DEPLETED_VIEWS () {
461 $urlArray = SURFBAR_GET_URL_DATA(0, 'url_views_max', 'url_id', 'ASC', 'url_id', " AND `url_views_allowed` > 0 AND `url_status`='ACTIVE'");
463 // Do we have some entries?
464 if (count($urlArray) > 0) {
466 foreach ($urlArray as $id => $urlData) {
470 // Rewrite array for next call
471 $urlData[$id] = $data;
474 SURFBAR_CHANGE_STATUS($id, 'ACTIVE', 'DEPLETED', $urlData);
479 // Alert users which have URLs booked and are low on points amount
480 function SURFBAR_HANDLE_LOW_POINTS () {
482 $userids = SURFBAR_DETERMINE_DEPLETED_USERIDS(getConfig('surfbar_warn_low_points'));
484 // "Walk" through all URLs
485 foreach ($userids['url_userid'] as $userid => $dummy) {
486 // Is the last notification far enougth away to notify again?
487 if ((time() - $userids['notified'][$userid]) >= getConfig('surfbar_low_interval')) {
490 'url_userid' => $userid,
491 'points' => $userids['points'][$userid],
492 'notified' => $userids['notified'][$userid]
496 SURFBAR_NOTIFY_USER('low_points', $content);
498 // Update last notified
499 SQL_QUERY_ESC("UPDATE `{?_MYSQL_PREFIX?}_user_data` SET `surfbar_low_notified`=NOW() WHERE `userid`=%s LIMIT 1",
500 array($userid), __FUNCTION__, __LINE__);
506 // -----------------------------------------------------------------------------
508 // -----------------------------------------------------------------------------
511 // Looks up by an URL
512 function SURFBAR_LOOKUP_BY_URL ($url, $userid) {
513 // Now lookup that given URL by itself
514 $urlArray = SURFBAR_GET_URL_DATA($url, 'url', 'url_id', 'ASC', 'url_id', sprintf(" AND `url_userid`=%s", bigintval($userid)));
517 return (count($urlArray) > 0);
520 // Load URL data by given search term and column
521 function SURFBAR_GET_URL_DATA ($searchTerm, $column = 'url_id', $order = 'url_id', $sort = 'ASC', $group = 'url_id', $add = '') {
522 // By default nothing is found
523 $GLOBALS['last_url_data'] = array();
525 // Is the column an id number?
526 if (($column == 'url_id') || ($column == 'url_userid')) {
527 // Extra secure input
528 $searchTerm = bigintval($searchTerm);
531 // If the column is 'id' there can be only one entry
533 if ($column == 'id') {
537 // Look up the record
538 $result = SQL_QUERY_ESC("SELECT
546 UNIX_TIMESTAMP(`url_registered`) AS `url_registered`,
547 UNIX_TIMESTAMP(`url_last_locked`) AS `url_last_locked`,
553 `{?_MYSQL_PREFIX?}_surfbar_urls`
555 `%s`='%s'" . $add . "
565 ), __FUNCTION__, __LINE__);
567 // Is there at least one record?
568 if (SQL_NUMROWS($result) > 0) {
570 while ($dataRow = SQL_FETCHARRAY($result)) {
571 // Shall we group these results?
572 if ($group == 'url_id') {
573 // Add the row by id as index
574 $GLOBALS['last_url_data'][$dataRow['url_id']] = $dataRow;
577 $GLOBALS['last_url_data'][$dataRow[$group]][$dataRow['url_id']] = $dataRow;
583 SQL_FREERESULT($result);
586 return $GLOBALS['last_url_data'];
589 // Registers an URL with the surfbar. You should have called SURFBAR_LOOKUP_BY_URL() first!
590 function SURFBAR_REGISTER_URL ($url, $userid, $status = 'PENDING', $addMode = 'reg', $extraFields = array()) {
591 // Make sure by the user registered URLs are always pending
592 if ($addMode == 'reg') {
597 $content = merge_array($extraFields, array(
599 'frametester' => generateFrametesterUrl($url),
600 'url_userid' => $userid,
601 'url_status' => $status,
604 // Is limit/reload set?
605 if (!isset($config['limit'])) {
606 $content['limit'] = '0';
608 if (!isset($config['reload'])) {
609 $content['reload'] = '0';
612 // Insert the URL into database
613 $content['insert_id'] = SURFBAR_INSERT_URL_BY_ARRAY($content);
616 if ($content['insert_id'] == '0') {
617 // INSERT did not insert any data!
621 // If in reg-mode we notify admin
622 if (($addMode == 'reg') || (getConfig('surfbar_notify_admin_unlock') == 'Y')) {
623 // Notify admin even when he as unlocked an email
624 SURFBAR_NOTIFY_ADMIN('url_' . $addMode, $content);
628 SURFBAR_NOTIFY_USER('url_' . $addMode, $content);
630 // Return the insert id
631 return $content['insert_id'];
634 // Inserts an url by given data array and return the insert id
635 function SURFBAR_INSERT_URL_BY_ARRAY ($urlData) {
637 $userid = bigintval($urlData['url_userid']);
640 if (empty($userid)) $userid = '0';
642 // Just run the insert query for now
643 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)",
647 $urlData['url_status'],
651 ), __FUNCTION__, __LINE__
655 return SQL_INSERTID();
658 // Notify admin(s) with a selected message and content
659 function SURFBAR_NOTIFY_ADMIN ($messageType, $content) {
660 // Prepare template name
661 $templateName = sprintf("admin_surfbar_%s", $messageType);
664 $subject = getMessage(sprintf("ADMIN_SURFBAR_NOTIFY_%s_SUBJECT",
665 strtoupper($messageType)
668 // Is the subject line there?
669 if ((substr($subject, 0, 1) == '!') && (substr($subject, -1, 1) == '!')) {
670 // Set default subject if following eval() wents wrong
671 $subject = getMaskedMessage('ADMIN_SURFBAR_NOTIFY_DEFAULT_SUBJECT', strtoupper($messageType));
674 // Translate some data if present
675 $content = SURFBAR_PREPARE_CONTENT_FOR_TEMPLATE($content);
677 // Send the notification out
678 return sendAdminNotification($subject, $templateName, $content, $content['url_userid']);
681 // Notify the user about the performed action
682 function SURFBAR_NOTIFY_USER ($messageType, $content) {
683 // Skip notification if userid is zero
684 if ($content['url_userid'] == '0') {
688 // Prepare template name
689 $templateName = sprintf("member_surfbar_%s", $messageType);
692 $subject = getMessage(sprintf("MEMBER_SURFBAR_NOTIFY_%s_SUBJECT",
693 strtoupper($messageType)
696 // Is the subject line there?
697 if ((substr($subject, 0, 1) == '!') && (substr($subject, -1, 1) == '!')) {
698 // Set default subject if following eval() wents wrong
699 $subject = '{--MEMBER_SURFBAR_NOTIFY_DEFAULT_SUBJECT--}';
702 // Translate some data if present
703 $content = SURFBAR_PREPARE_CONTENT_FOR_TEMPLATE($content);
706 $mailText = loadEmailTemplate($templateName, $content, $content['url_userid']);
709 return sendEmail($content['url_userid'], $subject, $mailText);
712 // Translates some data for template usage
713 // @TODO Can't we use our new expression language instead of this ugly code?
714 function SURFBAR_PREPARE_CONTENT_FOR_TEMPLATE ($content) {
716 if (isset($content['url_registered'])) $content['url_registered'] = generateDateTime($content['url_registered'], 2);
717 if (isset($content['url_last_locked'])) $content['url_last_locked'] = generateDateTime($content['url_last_locked'], 2);
719 // Return translated content
723 // Translates the limit
724 function translateSurfbarLimit ($limit) {
728 $return = '{--MEMBER_SURFBAR_UNLIMITED_VIEWS--}';
731 $return = translateComma($limit);
738 // Translate the URL status
739 function translateSurfbarUrlStatus ($status) {
740 // Create constant name
741 $constantName = sprintf("SURFBAR_URL_STATUS_%s", strtoupper($status));
744 $statusTranslated = getMessage($constantName);
747 return $statusTranslated;
751 function SURFBAR_DETERMINE_REWARD ($onlyMin=false) {
752 // Static values are default
753 $reward = getConfig('surfbar_static_reward');
755 // Do we have static or dynamic?
756 if (getConfig('surfbar_pay_model') == 'DYNAMIC') {
757 // "Calculate" dynamic reward
759 $reward += SURFBAR_CALCULATE_DYNAMIC_MIN_VALUE();
761 $reward += SURFBAR_CALCULATE_DYNAMIC_ADD();
770 function SURFBAR_DETERMINE_COSTS ($onlyMin=false) {
771 // Static costs is default
772 $costs = getConfig('surfbar_static_costs');
774 // Do we have static or dynamic?
775 if (getConfig('surfbar_pay_model') == 'DYNAMIC') {
776 // "Calculate" dynamic costs
778 $costs += SURFBAR_CALCULATE_DYNAMIC_MIN_VALUE();
780 $costs += SURFBAR_CALCULATE_DYNAMIC_ADD();
788 // "Calculate" dynamic add
789 function SURFBAR_CALCULATE_DYNAMIC_ADD () {
790 // Get min/max values
791 $min = SURFBAR_CALCULATE_DYNAMIC_MIN_VALUE();
792 $max = SURFBAR_CALCULATE_DYNAMIC_MAX_VALUE();
794 // "Calculate" dynamic part and return it
795 return mt_rand($min, $max);
798 // Determine right template name
799 function SURFBAR_DETERMINE_TEMPLATE_NAME() {
800 // Default is the frameset
801 $templateName = "surfbar_frameset";
803 // Any frame set? ;-)
804 if (isGetRequestParameterSet('frame')) {
805 // Use the frame as a template name part... ;-)
806 $templateName = sprintf("surfbar_frame_%s",
807 getRequestParameter('frame')
812 return $templateName;
815 // Check if the "reload lock" of the current user is full, call this function
816 // before you call SURFBAR_CHECK_RELOAD_LOCK().
817 function SURFBAR_CHECK_RELOAD_FULL() {
821 // Cache static reload lock
822 $GLOBALS['surfbar_cache']['surf_lock'] = getConfig('surfbar_static_lock');
823 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'Fixed surf lock is '.getConfig('surfbar_static_lock') . '', false);
825 // Do we have dynamic model?
826 if (getConfig('surfbar_pay_model') == 'DYNAMIC') {
827 // "Calculate" dynamic lock
828 $GLOBALS['surfbar_cache']['surf_lock'] += SURFBAR_CALCULATE_DYNAMIC_ADD();
832 $result = SQL_QUERY_ESC("SELECT
833 COUNT(l.locks_id) AS cnt
835 `{?_MYSQL_PREFIX?}_surfbar_locks` AS l
837 `{?_MYSQL_PREFIX?}_surfbar_urls` AS u
839 u.url_id=l.locks_url_id
841 l.locks_userid=%s AND
842 (UNIX_TIMESTAMP() - ".SURFBAR_GET_SURF_LOCK().") < UNIX_TIMESTAMP(l.locks_last_surfed) AND
844 ((UNIX_TIMESTAMP(l.locks_last_surfed) - u.url_fixed_reload) < 0 AND u.url_fixed_reload > 0) OR
845 u.url_fixed_reload = '0'
848 array(getMemberId()), __FUNCTION__, __LINE__
852 list($GLOBALS['surfbar_cache']['user_locks']) = SQL_FETCHROW($result);
855 if (is_null($GLOBALS['surfbar_cache']['user_locks'])) {
856 // Then fix it to zero!
857 $GLOBALS['surfbar_cache']['user_locks'] = '0';
861 SQL_FREERESULT($result);
864 $total = SURFBAR_GET_TOTAL_URLS();
866 // Do we have some URLs in lock? Admins can always surf on own URLs!
867 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, "userLocks=".SURFBAR_GET_USER_LOCKS().",total={$total}", false);
868 $isFull = ((SURFBAR_GET_USER_LOCKS() == $total) && ($total > 0));
874 // Get total amount of URLs of given status for current user or of ACTIVE URLs by default
875 function SURFBAR_GET_TOTAL_URLS ($status = 'ACTIVE', $excludeUserId = '0') {
876 // Determine depleted user account
877 $userids = SURFBAR_DETERMINE_DEPLETED_USERIDS();
879 // If we dont get any user ids back, there are no URLs
880 if (count($userids['url_userid']) == 0) {
881 // No user ids found, no URLs!
885 // Is the exlude userid set?
886 if ($excludeUserId > 0) {
888 $userids['url_userid'][$excludeUserId] = $excludeUserId;
891 // Get amount from database
892 $result = SQL_QUERY_ESC("SELECT
893 COUNT(`url_id`) AS cnt
895 `{?_MYSQL_PREFIX?}_surfbar_urls`
897 `url_userid` NOT IN (".implode(', ', $userids['url_userid']).") AND
900 array($status), __FUNCTION__, __LINE__
904 list($cnt) = SQL_FETCHROW($result);
907 SQL_FREERESULT($result);
913 // Check wether the user is allowed to book more URLs
914 function SURFBAR_IF_USER_BOOK_MORE_URLS ($userid = '0') {
915 // Is this admin and userid is zero or does the user has some URLs left to book?
916 return ((($userid == '0') && (isAdmin())) || (SURFBAR_GET_TOTAL_USER_URLS($userid, '', array('REJECTED')) < getConfig('surfbar_max_order')));
919 // Get total amount of URLs of given status for current user
920 function SURFBAR_GET_TOTAL_USER_URLS ($userid = '0', $status = '', $exclude = '') {
921 // Is the user 0 and user is logged in?
922 if (($userid == '0') && (isMember())) {
923 // Then use this userid
924 $userid = getMemberId();
925 } elseif ($userid == '0') {
927 return (getConfig('surfbar_max_order') + 1);
930 // Default is all URLs
933 // Is the status set?
934 if (is_array($status)) {
935 // Only URLs with these status
936 $add = sprintf(" AND `url_status` IN('%s')", implode("','", $status));
937 } elseif (!empty($status)) {
938 // Only URLs with this status
939 $add = sprintf(" AND `url_status`='%s'", $status);
940 } elseif (is_array($exclude)) {
941 // Exclude URLs with these status
942 $add = sprintf(" AND `url_status` NOT IN('%s')", implode("','", $exclude));
943 } elseif (!empty($exclude)) {
944 // Exclude URLs with this status
945 $add = sprintf(" AND `url_status` != '%s'", $exclude);
948 // Get amount from database
949 $cnt = countSumTotalData($userid, 'surfbar_urls', 'url_id', 'url_userid', true, $add);
955 // Generate a validation code for the given id number
956 function SURFBAR_GENERATE_VALIDATION_CODE ($urlId, $salt = '') {
957 // @TODO Invalid salt should be refused
958 $GLOBALS['surfbar_cache']['salt'] = 'INVALID';
960 // Get code length from config
961 $length = getConfig('code_length');
964 if ($length == '0') $length = 10;
966 // Generate a code until the length matches
968 while (strlen($valCode) != $length) {
971 // Generate random hashed string
972 $GLOBALS['surfbar_cache']['salt'] = sha1(generatePassword(mt_rand(200, 255)));
973 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'newSalt='.SURFBAR_GET_SALT().'', false);
976 $GLOBALS['surfbar_cache']['salt'] = $salt;
977 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'oldSalt='.SURFBAR_GET_SALT().'', false);
980 // ... and now the validation code
981 $valCode = generateRandomCode($length, sha1(SURFBAR_GET_SALT().':'.$urlId), getMemberId());
982 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'valCode='.valCode.'', false);
985 // Hash it with md5() and salt it with the random string
986 $hashedCode = generateHash(md5($valCode), SURFBAR_GET_SALT());
988 // Finally encrypt it PGP-like and return it
989 $valHashedCode = encodeHashForCookie($hashedCode);
991 // Return hashed value
992 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'finalValCode='.$valHashedCode.'', false);
993 return $valHashedCode;
996 // Check validation code
997 function SURFBAR_CHECK_VALIDATION_CODE ($urlId, $check, $salt) {
999 $urlId = bigintval($urlId);
1001 // Now generate the code again
1002 $code = SURFBAR_GENERATE_VALIDATION_CODE($urlId, $salt);
1004 // Return result of checking hashes and salts
1005 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, '---'.$code.'|'.$check.'---', false);
1006 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, '+++'.$salt.'|'.SURFBAR_GET_DATA('salts_last_salt').'+++', false);
1007 return (($code == $check) && ($salt == SURFBAR_GET_DATA('salts_last_salt')));
1010 // Lockdown the userid/id combination (reload lock)
1011 function SURFBAR_LOCKDOWN_ID ($urlId) {
1012 //* DEBUG: */ debugOutput('LOCK!');
1013 ///* DEBUG: */ return;
1014 // Just add it to the database
1015 SQL_QUERY_ESC("INSERT INTO `{?_MYSQL_PREFIX?}_surfbar_locks` (`locks_userid`, `locks_url_id`) VALUES (%s, %s)",
1016 array(getMemberId(), bigintval($urlId)), __FUNCTION__, __LINE__);
1018 // Remove the salt from database
1019 SQL_QUERY_ESC("DELETE LOW_PRIORITY FROM `{?_MYSQL_PREFIX?}_surfbar_salts` WHERE `salts_url_id`=%s AND `salts_userid`=%s LIMIT 1",
1020 array(bigintval($urlId), getMemberId()), __FUNCTION__, __LINE__);
1023 // Pay points to the user and remove it from the sender if userid is given else it is a "sponsored surf"
1024 function SURFBAR_PAY_POINTS () {
1025 // Remove it from the URL owner
1026 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'userid='.SURFBAR_GET_USERID().',costs='.SURFBAR_GET_COSTS().'', false);
1027 if (SURFBAR_GET_USERID() > 0) {
1028 subtractPoints(sprintf("surfbar_%s", getConfig('surfbar_pay_model')), SURFBAR_GET_USERID(), SURFBAR_GET_COSTS());
1031 // Book it to the user
1032 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'userid='.getMemberId().',reward='.SURFBAR_GET_REWARD().'', false);
1033 addPointsThroughReferalSystem(sprintf("surfbar_%s", getConfig('surfbar_pay_model')), getMemberId(), SURFBAR_GET_DATA('reward'));
1036 // Updates the statistics of current URL/userid
1037 function SURFBAR_UPDATE_INSERT_STATS_RECORD () {
1041 // Get allowed views
1042 $allowed = SURFBAR_GET_VIEWS_ALLOWED();
1044 // Do we have a limit?
1046 // Then count views_max down!
1047 $add .= ", `views_max`=`views_max`-1";
1051 SQL_QUERY_ESC("UPDATE `{?_MYSQL_PREFIX?}_surfbar_urls` SET `url_views_total`=`url_views_total`+1".$add." WHERE `url_id`=%s LIMIT 1",
1052 array(SURFBAR_GET_ID()), __FUNCTION__, __LINE__);
1054 // Update the stats entry
1055 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",
1059 ), __FUNCTION__, __LINE__);
1061 // Was that update okay?
1062 if (SQL_AFFECTEDROWS() < 1) {
1063 // No, then insert entry
1064 SQL_QUERY_ESC("INSERT INTO `{?_MYSQL_PREFIX?}_surfbar_stats` (`stats_userid`, `stats_url_id`, `stats_count`) VALUES (%s,%s,1)",
1068 ), __FUNCTION__, __LINE__);
1071 // Update total/daily/weekly/monthly counter
1072 incrementConfigEntry('surfbar_total_counter');
1073 incrementConfigEntry('surfbar_daily_counter');
1074 incrementConfigEntry('surfbar_weekly_counter');
1075 incrementConfigEntry('surfbar_monthly_counter');
1077 // Update config as well
1078 updateConfiguration(array('surfbar_total_counter', 'surfbar_daily_counter', 'surfbar_weekly_counter', 'surfbar_monthly_counter'), array(1,1,1,1), '+');
1081 // Update the salt for validation and statistics
1082 function SURFBAR_UPDATE_SALT_STATS () {
1083 // Update statistics record
1084 SURFBAR_UPDATE_INSERT_STATS_RECORD();
1086 // Simply store the salt from cache away in database...
1087 SQL_QUERY_ESC("UPDATE `{?_MYSQL_PREFIX?}_surfbar_salts` SET `salts_last_salt`='%s' WHERE `salts_url_id`=%s AND `salts_userid`=%s LIMIT 1",
1092 ), __FUNCTION__, __LINE__);
1095 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'salt='.SURFBAR_GET_SALT().',id='.SURFBAR_GET_ID().',userid='.getMemberId().'', false);
1098 if (SQL_AFFECTEDROWS() < 1) {
1099 // Insert missing entry!
1100 SQL_QUERY_ESC("INSERT INTO `{?_MYSQL_PREFIX?}_surfbar_salts` (`salts_url_id`, `salts_userid`, `salts_last_salt`) VALUES (%s, %s, '%s')",
1101 array(SURFBAR_GET_ID(), getMemberId(), SURFBAR_GET_SALT()), __FUNCTION__, __LINE__);
1105 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'affectedRows='.SQL_AFFECTEDROWS().'', false);
1107 // Return if the update was okay
1108 return (SQL_AFFECTEDROWS() == 1);
1111 // Check if the reload lock is active for given id
1112 function SURFBAR_CHECK_RELOAD_LOCK ($urlId) {
1113 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'id=' . $urlId . '', false);
1115 $result = SQL_QUERY_ESC("SELECT COUNT(`locks_id`) AS cnt
1117 `{?_MYSQL_PREFIX?}_surfbar_locks`
1119 `locks_userid`=%s AND
1120 `locks_url_id`=%s AND
1121 (UNIX_TIMESTAMP() - ".SURFBAR_GET_SURF_LOCK().") < UNIX_TIMESTAMP(`locks_last_surfed`)
1123 `locks_last_surfed` ASC
1125 array(getMemberId(), bigintval($urlId)), __FUNCTION__, __LINE__
1129 list($cnt) = SQL_FETCHROW($result);
1132 SQL_FREERESULT($result);
1135 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'cnt=' . $cnt . ',' . SURFBAR_GET_SURF_LOCK() . '', false);
1139 // Determine which user hash no more points left
1140 function SURFBAR_DETERMINE_DEPLETED_USERIDS ($limit=0) {
1143 'url_userid' => array(),
1144 'points' => array(),
1145 'notified' => array(),
1148 // Do we have a current user id?
1149 if ((isMember()) && ($limit == '0')) {
1150 // Then add this as well
1151 $userids['url_userid'][getMemberId()] = getMemberId();
1152 $userids['points'][getMemberId()] = countSumTotalData(getMemberId(), 'user_points', 'points') - countSumTotalData(getMemberId(), 'user_data', 'used_points');
1153 $userids['notified'][getMemberId()] = '0';
1155 // Get all userid except logged in one
1156 $result = SQL_QUERY_ESC("SELECT
1157 u.url_userid, UNIX_TIMESTAMP(d.surfbar_low_notified) AS notified
1159 `{?_MYSQL_PREFIX?}_surfbar_urls` AS u
1161 `{?_MYSQL_PREFIX?}_user_data` AS d
1163 u.url_userid=d.userid
1165 u.url_userid NOT IN (%s,0) AND u.url_status='ACTIVE'
1170 array(getMemberId()), __FUNCTION__, __LINE__);
1173 $result = SQL_QUERY("SELECT
1174 u.url_userid, UNIX_TIMESTAMP(d.surfbar_low_notified) AS notified
1176 `{?_MYSQL_PREFIX?}_surfbar_urls` AS u
1178 `{?_MYSQL_PREFIX?}_user_data` AS d
1180 u.url_userid=d.userid
1182 u.url_status='ACTIVE'
1186 u.url_userid ASC", __FUNCTION__, __LINE__);
1190 while ($content = SQL_FETCHARRAY($result)) {
1192 $points = countSumTotalData($content['url_userid'], 'user_points', 'points') - countSumTotalData($content['url_userid'], 'user_data', 'used_points');
1193 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, "userid={$content['url_userid']},points={$points}", false);
1195 // Shall we add this to ignore?
1196 if ($points <= $limit) {
1198 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, "userid={$content['url_userid']} has depleted points amount!", false);
1199 $userids['url_userid'][$content['url_userid']] = $content['url_userid'];
1200 $userids['points'][$content['url_userid']] = $points;
1201 $userids['notified'][$content['url_userid']] = $content['notified'];
1206 SQL_FREERESULT($result);
1209 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, "UIDs::count=".count($userids)." (with own userid=".getMemberId().')', false);
1215 // Determine how many users are Online in surfbar
1216 function SURFBAR_DETERMINE_TOTAL_ONLINE () {
1217 // Count all users in surfbar modue and return the value
1218 $result = SQL_QUERY("SELECT
1221 `{?_MYSQL_PREFIX?}_surfbar_stats`
1223 (UNIX_TIMESTAMP() - UNIX_TIMESTAMP(`stats_last_surfed`)) <= {?online_timeout?}
1225 `stats_userid` ASC", __FUNCTION__, __LINE__);
1228 $cnt = SQL_NUMROWS($result);
1231 SQL_FREERESULT($result);
1237 // Determine waiting time for one URL
1238 function SURFBAR_DETERMINE_WAIT_TIME () {
1239 // Get fixed reload lock
1240 $fixed = SURFBAR_GET_FIXED_RELOAD();
1242 // Is the fixed reload time set?
1248 // Static time is default
1249 $time = getConfig('surfbar_static_time');
1251 // Which payment model do we have?
1252 if (getConfig('surfbar_pay_model') == 'DYNAMIC') {
1253 // "Calculate" dynamic time
1254 $time += SURFBAR_CALCULATE_DYNAMIC_ADD();
1261 // Changes the status of an URL from given to other
1262 function SURFBAR_CHANGE_STATUS ($urlId, $prevStatus, $newStatus, $data=array()) {
1263 // Make new status always lower-case
1264 $newStatus = strtolower($newStatus);
1266 // Get URL data for status comparison if missing
1267 if ((!is_array($data)) || (count($data) == 0)) {
1268 // Fetch missing URL data
1269 $data = SURFBAR_GET_URL_DATA($urlId);
1272 // Is the new status set?
1273 if ((!is_string($newStatus)) || (empty($newStatus))) {
1274 // Abort here, but fine!
1278 // Is the status like prevStatus is saying?
1279 if ($data[$urlId]['url_status'] != $prevStatus) {
1280 // No, then abort here
1285 // Update the status now
1286 // ---------- Comment out for debugging/developing member actions! ---------
1287 //SQL_QUERY_ESC("UPDATE `{?_MYSQL_PREFIX?}_surfbar_urls` SET `status`='%s' WHERE `url_id`=%s LIMIT 1",
1288 // array($newStatus, bigintval($urlId)), __FUNCTION__, __LINE__);
1289 // ---------- Comment out for debugging/developing member actions! ---------
1292 // ---------- Comment out for debugging/developing member actions! ---------
1293 //if (SQL_AFFECTEDROWS() != 1) {
1294 // // No, something went wrong
1297 // ---------- Comment out for debugging/developing member actions! ---------
1299 // Prepare content for notification routines
1300 $data[$urlId]['url_userid'] = $data[$urlId]['url_userid'];
1301 $data[$urlId]['frametester'] = generateFrametesterUrl($data[$urlId]['url']);
1302 $data[$urlId]['reward'] = translateComma(getConfig('surfbar_static_reward'));
1303 $data[$urlId]['costs'] = translateComma(getConfig('surfbar_static_costs'));
1305 // Do some dirty fixing here:
1306 if (($data[$urlId]['url_status'] == 'STOPPED') && ($newStatus == 'pending')) {
1307 // Fix for template change
1308 $newStatus = 'continued';
1311 // Send admin notification
1312 SURFBAR_NOTIFY_ADMIN('url_' . $data[$urlId]['url_status'] . '_' . $newStatus, $data[$urlId]);
1314 // Send user notification
1315 SURFBAR_NOTIFY_USER('url_' . $data[$urlId]['url_status'] . '_' . $newStatus, $data[$urlId]);
1321 // Calculate minimum value for dynamic payment model
1322 function SURFBAR_CALCULATE_DYNAMIC_MIN_VALUE () {
1323 // Addon is zero by default
1327 $percent = abs(log(getConfig('surfbar_dynamic_percent') / 100 + 1));
1330 $totalUsers = getTotalConfirmedUser();
1333 $onlineUsers = SURFBAR_DETERMINE_TOTAL_ONLINE();
1336 $addon += abs(log($onlineUsers / $totalUsers + 1) * $percent * $totalUsers);
1339 $totalUrls = SURFBAR_GET_TOTAL_URLS('ACTIVE', 0);
1341 // Get user's total URLs
1342 $userUrls = SURFBAR_GET_TOTAL_USER_URLS(0, 'ACTIVE');
1345 if ($totalUrls > 0) {
1346 $addon += abs(log($userUrls / $totalUrls + 1) * $percent * $totalUrls);
1348 $addon += abs(log($userUrls / 1 + 1) * $percent * $totalUrls);
1355 // Calculate maximum value for dynamic payment model
1356 function SURFBAR_CALCULATE_DYNAMIC_MAX_VALUE () {
1357 // Addon is zero by default
1364 $percent = abs(log(getConfig('surfbar_dynamic_percent') / 100 + 1));
1367 $totalUsers = getTotalConfirmedUser();
1370 $addon += abs($max * $percent * $totalUsers);
1373 $totalUrls = SURFBAR_GET_TOTAL_URLS('ACTIVE', 0);
1376 $addon += abs($max * $percent * $totalUrls);
1382 // Calculate dynamic lock
1383 function SURFBAR_CALCULATE_DYNAMIC_LOCK () {
1384 // Default lock is 30 seconds
1388 $onlineUsers = SURFBAR_DETERMINE_TOTAL_ONLINE();
1391 $addon = abs(log($onlineUsers / $addon + 1));
1397 // "Getter" for lock ids array
1398 function SURFBAR_GET_LOCK_IDS () {
1399 // Prepare some arrays
1404 // Get all id from locks within the timestamp
1405 $result = SQL_QUERY_ESC("SELECT `locks_id`, `locks_url_id`, UNIX_TIMESTAMP(`locks_last_surfed`) AS last_surfed
1407 `{?_MYSQL_PREFIX?}_surfbar_locks`
1411 `locks_id` ASC", array(getMemberId()),
1412 __FUNCTION__, __LINE__);
1415 while ($content = SQL_FETCHARRAY($result)) {
1417 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'next - lid='.$content['id'].',url='.$content['url_id'].',rest='.(time() - $content['last_surfed']).'/'.SURFBAR_GET_SURF_LOCK().'', false);
1419 // Skip entries that are too old
1420 if (($content['last_surfed'] > (time() - SURFBAR_GET_SURF_LOCK())) && (!in_array($content['url_id'], $ignored))) {
1422 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'okay - lid='.$content['id'].',url='.$content['url_id'].',last='.$content['last_surfed'].'', false);
1424 // Add only if missing or bigger
1425 if ((!isset($IDs[$content['url_id']])) || ($IDs[$content['url_id']] > $content['last_surfed'])) {
1427 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'ADD - lid='.$content['id'].',url='.$content['url_id'].',last='.$content['last_surfed'].'', false);
1430 $IDs[$content['url_id']] = $content['last_surfed'];
1431 $USE[$content['url_id']] = $content['id'];
1435 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'ignore - lid='.$content['id'].',url='.$content['url_id'].',last='.$content['last_surfed'].'', false);
1437 // Ignore these old entries!
1438 $ignored[] = $content['url_id'];
1439 unset($IDs[$content['url_id']]);
1440 unset($USE[$content['url_id']]);
1445 SQL_FREERESULT($result);
1451 // "Getter" for maximum random number
1452 function SURFBAR_GET_MAX_RANDOM ($userids, $add) {
1453 // Count max availabe entries
1454 $result = SQL_QUERY("SELECT
1457 `{?_MYSQL_PREFIX?}_surfbar_urls` AS sbu
1459 `{?_MYSQL_PREFIX?}_surfbar_salts` AS sbs
1461 sbu.url_id=sbs.salts_url_id
1463 `{?_MYSQL_PREFIX?}_surfbar_locks` AS l
1465 sbu.url_id=l.locks_url_id
1467 sbu.url_userid NOT IN (".implode(',', $userids).") AND
1468 (sbu.url_views_allowed=0 OR (sbu.url_views_allowed > 0 AND sbu.url_views_max > 0)) AND
1469 sbu.url_status='ACTIVE'
1472 sbu.url_id ASC", __FUNCTION__, __LINE__);
1475 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'lastQuery='.getConfig('db_last_query').'|numRows='.SQL_NUMROWS($result).'|Affected='.SQL_AFFECTEDROWS().'', false);
1478 $maxRand = SQL_NUMROWS($result);
1481 SQL_FREERESULT($result);
1487 // Load all URLs of the current user and return it as an array
1488 function SURFBAR_GET_USER_URLS () {
1490 $urlArray = array();
1493 $result = SQL_QUERY_ESC("SELECT
1500 u.url_views_allowed,
1501 UNIX_TIMESTAMP(u.url_registered) AS `url_registered`,
1502 UNIX_TIMESTAMP(u.url_last_locked) AS `url_last_locked`,
1505 `{?_MYSQL_PREFIX?}_surfbar_urls` AS u
1508 u.url_status != 'DELETED'
1511 array(getMemberId()), __FUNCTION__, __LINE__);
1513 // Are there entries?
1514 if (SQL_NUMROWS($result) > 0) {
1516 while ($row = SQL_FETCHARRAY($result)) {
1518 $urlArray[$row['id']] = $row;
1523 SQL_FREERESULT($result);
1529 // "Getter" for member action array for given status
1530 function SURFBAR_GET_ARRAY_FROM_STATUS ($status) {
1532 $returnArray = array();
1534 // Get all assigned actions
1535 $result = SQL_QUERY_ESC("SELECT `action` FROM `{?_MYSQL_PREFIX?}_surfbar_actions` WHERE `actions_status`='%s' ORDER BY `actions_id` ASC",
1536 array($status), __FUNCTION__, __LINE__);
1538 // Some entries there?
1539 if (SQL_NUMROWS($result) > 0) {
1541 // @TODO This can be somehow rewritten
1542 while ($content = SQL_FETCHARRAY($result)) {
1543 $returnArray[] = $content['action'];
1548 SQL_FREERESULT($result);
1551 return $returnArray;
1554 // Reload to configured stop page
1555 function SURFBAR_RELOAD_TO_STOP_PAGE ($page = 'stop') {
1556 // Internal or external?
1557 if ((getConfig('surfbar_pause_mode') == 'INTERNAL') || (getConfig('surfbar_pause_url') == '')) {
1558 // Reload to internal page
1559 redirectToUrl('surfbar.php?frame=' . $page);
1561 // Reload to external page
1562 redirectToConfiguredUrl('surfbar_pause_url');
1566 // Determine next id for surfbar or get data for given id, always call this before you call other
1567 // getters below this function!!!
1568 function SURFBAR_DETERMINE_NEXT_ID ($urlId = '0') {
1569 // Default is no id and no random number
1574 if ($urlId == '0') {
1575 // Get array with lock ids
1576 $USE = SURFBAR_GET_LOCK_IDS();
1578 // Shall we add some URL ids to ignore?
1580 if (count($USE) > 0) {
1582 $add = " AND sbu.url_id NOT IN (";
1583 foreach ($USE as $url_id => $lid) {
1585 $add .= $url_id.',';
1588 // Add closing bracket
1589 $add = substr($add, 0, -1) . ')';
1592 // Determine depleted user account
1593 $userids = SURFBAR_DETERMINE_DEPLETED_USERIDS();
1595 // Get maximum randomness factor
1596 $maxRand = SURFBAR_GET_MAX_RANDOM($userids['url_userid'], $add);
1598 // If more than one URL can be called generate the random number!
1600 // Generate random number
1601 $randNum = mt_rand(0, ($maxRand - 1));
1604 // And query the database
1605 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'randNum='.$randNum.',maxRand='.$maxRand.',surfLock='.SURFBAR_GET_SURF_LOCK().'', false);
1606 $result = SQL_QUERY_ESC("SELECT
1610 sbs.salts_last_salt,
1611 sbu.url_views_total,
1613 sbu.url_views_allowed,
1614 UNIX_TIMESTAMP(l.locks_last_surfed) AS last_surfed,
1615 sbu.url_fixed_reload
1617 `{?_MYSQL_PREFIX?}_surfbar_urls` AS sbu
1619 `{?_MYSQL_PREFIX?}_surfbar_salts` AS sbs
1621 sbu.url_id=sbs.salts_url_id
1623 `{?_MYSQL_PREFIX?}_surfbar_locks` AS l
1625 sbu.url_id=l.locks_url_id
1627 sbu.url_userid NOT IN (".implode(',', $userids['url_userid']).") AND
1628 sbu.url_status='ACTIVE' AND
1629 (sbu.url_views_allowed=0 OR (sbu.url_views_allowed > 0 AND sbu.url_views_max > 0))
1634 l.locks_last_surfed ASC,
1637 array($randNum), __FUNCTION__, __LINE__
1640 // Get data from specified id number
1641 $result = SQL_QUERY_ESC("SELECT
1645 sbs.salts_last_salt,
1646 sbu.url_views_total,
1648 sbu.url_views_allowed,
1649 UNIX_TIMESTAMP(l.locks_last_surfed) AS last_surfed,
1650 sbu.url_fixed_reload
1652 `{?_MYSQL_PREFIX?}_surfbar_urls` AS sbu
1654 `{?_MYSQL_PREFIX?}_surfbar_salts` AS sbs
1656 sbu.url_id=sbs.salts_url_id
1658 `{?_MYSQL_PREFIX?}_surfbar_locks` AS l
1660 sbu.url_id=l.locks_url_id
1662 sbu.url_userid != %s AND
1663 sbu.url_status='ACTIVE' AND
1665 (sbu.url_views_allowed=0 OR (sbu.url_views_allowed > 0 AND sbu.url_views_max > 0))
1667 array(getMemberId(), bigintval($urlId)), __FUNCTION__, __LINE__
1671 // Is there an id number?
1672 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'lastQuery='.getConfig('db_last_query').'|numRows='.SQL_NUMROWS($result).'|Affected='.SQL_AFFECTEDROWS().'', false);
1673 if (SQL_NUMROWS($result) == 1) {
1675 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'count('.count($GLOBALS['surfbar_cache']).') - BEFORE', false);
1676 $GLOBALS['surfbar_cache'] = merge_array($GLOBALS['surfbar_cache'], SQL_FETCHARRAY($result));
1677 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'count('.count($GLOBALS['surfbar_cache']).') - AFTER', false);
1679 // Determine waiting time
1680 $GLOBALS['surfbar_cache']['time'] = SURFBAR_DETERMINE_WAIT_TIME();
1682 // Is the last salt there?
1683 if (is_null($GLOBALS['surfbar_cache']['salts_last_salt'])) {
1684 // Then repair it wit the static!
1685 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'last_salt - FIXED!', false);
1686 $GLOBALS['surfbar_cache']['salts_last_salt'] = '';
1689 // Fix missing last_surfed
1690 if ((!isset($GLOBALS['surfbar_cache']['last_surfed'])) || (is_null($GLOBALS['surfbar_cache']['last_surfed']))) {
1692 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'last_surfed - FIXED!', false);
1693 $GLOBALS['surfbar_cache']['last_surfed'] = '0';
1696 // Get base/fixed reward and costs
1697 $GLOBALS['surfbar_cache']['reward'] = SURFBAR_DETERMINE_REWARD();
1698 $GLOBALS['surfbar_cache']['costs'] = SURFBAR_DETERMINE_COSTS();
1699 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'BASE/STATIC - reward='.SURFBAR_GET_REWARD().'|costs='.SURFBAR_GET_COSTS().'', false);
1701 // Only in dynamic model add the dynamic bonus!
1702 if (getConfig('surfbar_pay_model') == 'DYNAMIC') {
1703 // Calculate dynamic reward/costs and add it
1704 $GLOBALS['surfbar_cache']['reward'] += SURFBAR_CALCULATE_DYNAMIC_ADD();
1705 $GLOBALS['surfbar_cache']['costs'] += SURFBAR_CALCULATE_DYNAMIC_ADD();
1706 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'DYNAMIC+ - reward='.SURFBAR_GET_REWARD().'|costs='.SURFBAR_GET_COSTS().'', false);
1710 $nextId = SURFBAR_GET_ID();
1714 SQL_FREERESULT($result);
1717 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'nextId='.$nextId.'', false);
1721 // -----------------------------------------------------------------------------
1722 // PLEASE DO NOT ADD ANY OTHER FUNCTIONS BELOW THIS LINE IF THEY DON'T "WRAP"
1723 // THE $GLOBALS['surfbar_cache'] ARRAY!
1724 // -----------------------------------------------------------------------------
1726 // Initializes the surfbar
1727 function SURFBAR_INIT () {
1729 $GLOBALS['surfbar_cache'] = array();
1732 // Private getter for data elements
1733 function SURFBAR_GET_DATA ($element) {
1734 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, "element={$element}", false);
1739 // Is the entry there?
1740 if (isset($GLOBALS['surfbar_cache'][$element])) {
1742 $data = $GLOBALS['surfbar_cache'][$element];
1743 } else { // END - if
1745 print_r($GLOBALS['surfbar_cache']);
1747 debug_report_bug(__FUNCTION__, __LINE__, 'Element ' . $element . ' not found.');
1751 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'element[' . $element . ']=[' . gettype($data) . ']' . $data, false);
1755 // Getter for reward from cache
1756 function SURFBAR_GET_REWARD () {
1757 // Get data element and return its contents
1758 return SURFBAR_GET_DATA('reward');
1761 // Getter for costs from cache
1762 function SURFBAR_GET_COSTS () {
1763 // Get data element and return its contents
1764 return SURFBAR_GET_DATA('costs');
1767 // Getter for URL from cache
1768 function SURFBAR_GET_URL () {
1769 // Get data element and return its contents
1770 return SURFBAR_GET_DATA('url');
1773 // Getter for salt from cache
1774 function SURFBAR_GET_SALT () {
1775 // Get data element and return its contents
1776 return SURFBAR_GET_DATA('salt');
1779 // Getter for id from cache
1780 function SURFBAR_GET_ID () {
1781 // Get data element and return its contents
1782 return SURFBAR_GET_DATA('url_id');
1785 // Getter for userid from cache
1786 function SURFBAR_GET_USERID () {
1787 // Get data element and return its contents
1788 return SURFBAR_GET_DATA('url_userid');
1791 // Getter for user reload locks
1792 function SURFBAR_GET_USER_LOCKS () {
1793 // Get data element and return its contents
1794 return SURFBAR_GET_DATA('user_locks');
1797 // Getter for reload time
1798 function SURFBAR_GET_RELOAD_TIME () {
1799 // Get data element and return its contents
1800 return SURFBAR_GET_DATA('time');
1803 // Getter for allowed views
1804 function SURFBAR_GET_VIEWS_ALLOWED () {
1805 // Get data element and return its contents
1806 return SURFBAR_GET_DATA('url_views_allowed');
1809 // Getter for maximum views
1810 function SURFBAR_GET_VIEWS_MAX () {
1811 // Get data element and return its contents
1812 return SURFBAR_GET_DATA('url_views_max');
1815 // Getter for fixed reload
1816 function SURFBAR_GET_FIXED_RELOAD () {
1817 // Get data element and return its contents
1818 return SURFBAR_GET_DATA('url_fixed_reload');
1821 // Getter for surf lock
1822 function SURFBAR_GET_SURF_LOCK () {
1823 // Get data element and return its contents
1824 return SURFBAR_GET_DATA('surf_lock');
1827 // Getter for new status
1828 function SURFBAR_GET_NEW_STATUS () {
1829 // Get data element and return its contents
1830 return SURFBAR_GET_DATA('new_status');