Even more rewrites/fixes from EL branch (please report any broken part after you...
[mailer.git] / inc / libs / surfbar_functions.php
1 <?php
2 /************************************************************************
3  * Mailer v0.2.1-FINAL                                Start: 08/31/2008 *
4  * ===================                          Last change: 08/31/2008 *
5  *                                                                      *
6  * -------------------------------------------------------------------- *
7  * File              : surfbar_functions.php                            *
8  * -------------------------------------------------------------------- *
9  * Short description : Functions for surfbar                            *
10  * -------------------------------------------------------------------- *
11  * Kurzbeschreibung  : Funktionen fuer die Surfbar                      *
12  * -------------------------------------------------------------------- *
13  * $Revision::                                                        $ *
14  * $Date::                                                            $ *
15  * $Tag:: 0.2.1-FINAL                                                 $ *
16  * $Author::                                                          $ *
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                  *
23  *                                                                      *
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.                                  *
28  *                                                                      *
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.                         *
33  *                                                                      *
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,               *
37  * MA  02110-1301  USA                                                  *
38  ************************************************************************/
39
40 // Some security stuff...
41 if (!defined('__SECURITY')) {
42         die();
43 }
44
45 // -----------------------------------------------------------------------------
46 //                               Admin functions
47 // -----------------------------------------------------------------------------
48 //
49 // Admin has added an URL with given user id and so on
50 function SURFBAR_ADMIN_ADD_URL ($url, $limit, $reload) {
51         // Do some pre-checks
52         if (!isAdmin()) {
53                 // Not an admin
54                 logDebugMessage(__FUNCTION__, __LINE__, sprintf("Cannot add URL=%s,limit=%s,reload=%s : Not admin.", $url, $limit, $reload));
55                 return false;
56         } elseif (!isUrlValid($url)) {
57                 // URL invalid
58                 logDebugMessage(__FUNCTION__, __LINE__, sprintf("Cannot add URL=%s,limit=%s,reload=%s : Invalid URL.", $url, $limit, $reload));
59                 return false;
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));
63                 return false;
64         } elseif (!SURFBAR_IF_USER_BOOK_MORE_URLS()) {
65                 // No more allowed!
66                 logDebugMessage(__FUNCTION__, __LINE__, sprintf("Cannot add URL=%s,limit=%s,reload=%s : No more URLs allowed.", $url, $limit, $reload));
67                 return false;
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));
71                 return false;
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));
75                 return false;
76         }
77
78         // Register the new URL
79         return SURFBAR_REGISTER_URL($url, 0, 'ACTIVE', 'unlock', array('limit' => $limit, 'reload' => $reload));
80 }
81
82 // Admin unlocked an email so we can migrate the URL
83 function SURFBAR_ADMIN_MIGRATE_URL ($url, $userid) {
84         // Do some pre-checks
85         if (!isAdmin()) {
86                 // Not an admin
87                 return false;
88         } elseif (!isUrlValid($url)) {
89                 // URL invalid
90                 return false;
91         } elseif (SURFBAR_LOOKUP_BY_URL($url, $userid)) {
92                 // URL already found in surfbar!
93                 return false;
94         } elseif (!SURFBAR_IF_USER_BOOK_MORE_URLS($userid)) {
95                 // No more allowed!
96                 return false;
97         }
98
99         // Register the new URL
100         return SURFBAR_REGISTER_URL($url, $userid, 'MIGRATED', 'migrate');
101 }
102
103 // Admin function for unlocking URLs
104 function SURFBAR_ADMIN_UNLOCK_URL_IDS ($IDs) {
105         // Is this an admin or invalid array?
106         if (!isAdmin()) {
107                 // Not admin or invalid ids array
108                 return false;
109         } elseif (!is_array($IDs)) {
110                 // No array
111                 return false;
112         } elseif (count($IDs) == 0) {
113                 // Empty array
114                 return false;
115         }
116
117         // Set to true to make AND expression valid if first URL got unlocked
118         $done = true;
119
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')));
124         } // END - if
125
126         // Return total status
127         return $done;
128 }
129
130 // Admin function for rejecting URLs
131 function SURFBAR_ADMIN_REJECT_URL_IDS ($IDs) {
132         // Is this an admin or invalid array?
133         if (!isAdmin()) {
134                 // Not admin or invalid ids array
135                 return false;
136         } elseif (!is_array($IDs)) {
137                 // No array
138                 return false;
139         } elseif (count($IDs) == 0) {
140                 // Empty array
141                 return false;
142         }
143
144         // Set to true to make AND expression valid if first URL got unlocked
145         $done = true;
146
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')));
151         } // END - if
152
153         // Return total status
154         return $done;
155 }
156
157 //
158 // -----------------------------------------------------------------------------
159 //                               Member functions
160 // -----------------------------------------------------------------------------
161 //
162 // Member has added an URL
163 function SURFBAR_MEMBER_ADD_URL ($url, $limit) {
164         // Do some pre-checks
165         if (!isMember()) {
166                 // Not a member
167                 return false;
168         } elseif ((!isUrlValid($url)) && (!isAdmin())) {
169                 // URL invalid
170                 return false;
171         } elseif (SURFBAR_LOOKUP_BY_URL($url, getMemberId())) {
172                 // URL already found in surfbar!
173                 return false;
174         } elseif (!SURFBAR_IF_USER_BOOK_MORE_URLS(getMemberId())) {
175                 // No more allowed!
176                 return false;
177         } elseif (''.($limit + 0).'' != ''.$limit.'') {
178                 // Invalid amount entered
179                 return false;
180         }
181
182         // Register the new URL
183         return SURFBAR_REGISTER_URL($url, getMemberId(), 'PENDING', 'reg', array('limit' => $limit));
184 }
185
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);
190
191         // Init HTML code
192         $OUT = "<table border=\"0\" cellspacing=\"0\" cellpadding=\"1\" width=\"100%\">
193 <tr>\n";
194
195         // Calculate width
196         $width = round(100 / count($actionArray));
197
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(
202                         'width'    => $width,
203                         'id'       => bigintval($urlId),
204                         'action'   => strtolower($action),
205                         'title'    => '{--MEMBER_SURFBAR_ACTION_' . strtoupper($action) . '_TITLE--}',
206                         'submit'   => '{--MEMBER_SURFBAR_ACTION_' . strtoupper($action) . '_SUBMIT--}',
207                 ));
208         } // END - foreach
209
210         // Close table
211         $OUT .= "</tr>
212 </table>\n";
213
214         // Return code
215         return $OUT;
216 }
217
218 // Do the member form request
219 function SURFBAR_MEMBER_DO_FORM ($formData, $urlArray) {
220         // By default no action is performed
221         $performed = false;
222
223         // Is this a member?
224         if (!isMember()) {
225                 // No member!
226                 return false;
227         } elseif ((!isset($formData['id'])) || (!isset($formData['action']))) {
228                 // Important form elements are missing!
229                 return false;
230         } elseif (!isset($urlArray[$formData['id']])) {
231                 // id not found in cache
232                 return false;
233         } elseif (!SURFBAR_VALIDATE_MEMBER_ACTION_STATUS($formData['action'], $urlArray[$formData['id']]['url_status'])) {
234                 // Action not allowed for current URL status
235                 return false;
236         }
237
238         // Secure action
239         $action = secureString($formData['action']);
240
241         // Has it changed?
242         if ($action != $formData['action']) {
243                 // Invalid data in action found
244                 return false;
245         } // END - if
246
247         // Create the function name for selected action
248         $functionName = sprintf("SURFBAR_MEMBER_%s_ACTION", strtoupper($action));
249
250         // Is the function there?
251         if (function_exists($functionName)) {
252                 // Add new status
253                 $urlArray[$formData['id']]['new_status'] = SURFBAR_GET_NEW_STATUS('new_status');
254
255                 // Extract URL data for call-back
256                 $urlData = array(merge_array($urlArray[$formData['id']], array($action => $formData)));
257
258                 // Action found so execute it
259                 $performed = call_user_func_array($functionName, $urlData);
260         } else {
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));
264         }
265
266         // Return status
267         return $performed;
268 }
269
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__);
275
276         // Is the entry there?
277         $isValid = (SQL_NUMROWS($result) == 1);
278
279         // Fetch the new status if found
280         if ($isValid) {
281                 // Load new status
282                 list($GLOBALS['surfbar_cache']['new_status']) = SQL_FETCHROW($result);
283         } // END - if
284
285         // Free result
286         SQL_FREERESULT($result);
287
288         // Return status
289         return $isValid;
290 }
291
292 //
293 // -----------------------------------------------------------------------------
294 //                               Member actions
295 // -----------------------------------------------------------------------------
296 //
297 // Retreat a booked URL
298 function SURFBAR_MEMBER_RETREAT_ACTION ($urlData) {
299         // Create the data array for next function call
300         $data = array(
301                 $urlData['id'] => $urlData
302         );
303
304         // Simply change the status here
305         return SURFBAR_CHANGE_STATUS ($urlData['id'], $urlData['url_status'], $urlData['new_status'], $data);
306 }
307
308 // Book an URL now (from migration)
309 function SURFBAR_MEMBER_BOOKNOW_ACTION ($urlData) {
310         // Create the data array for next function call
311         $data = array(
312         $urlData['id'] => $urlData
313         );
314
315         // Simply change the status here
316         return SURFBAR_CHANGE_STATUS ($urlData['id'], $urlData['url_status'], $urlData['new_status'], $data);
317 }
318
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);
325         } // END - if
326
327         // Display form
328         return SURFBAR_MEMBER_DISPLAY_ACTION_FORM('edit', $urlData);
329 }
330
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);
337         } // END - if
338
339         // Display form
340         return SURFBAR_MEMBER_DISPLAY_ACTION_FORM('delete', $urlData);
341 }
342
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));
346 }
347
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();
354
355         // Return status change
356         return SURFBAR_CHANGE_STATUS($urlData['id'], $urlData['url_status'], $urlData['new_status'], array($urlData['id'] => $urlData));
357 }
358
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));
362 }
363
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);
368
369         // Is the lock reason empty?
370         if (empty($urlData['lock_reason'])) {
371                 // Fix it to three dashes
372                 $urlData['lock_reason'] = '---';
373         } // END - if
374
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';
381
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';
388                 } // END - if
389         } // END - if
390
391         // Load the form and display it
392         loadTemplate(sprintf("member_surfbar_%s_action_form", $action), false, $urlData);
393
394         // All fine by default ... ;-)
395         return true;
396 }
397
398 // Execute choosen action
399 function SURFBAR_MEMBER_EXECUTE_ACTION ($action, $urlData) {
400         // By default nothing is executed
401         $executed = false;
402
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';
407         } // END - if
408
409         // Construct function name
410         $functionName = sprintf("SURFBAR_MEMBER_EXECUTE_%s_ACTION", strtoupper($action));
411
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));
418                 } // END - if
419         } else {
420                 // Not found!
421                 addFatalMessage(__FUNCTION__, __LINE__, getMessage('MEMBER_SURFBAR_EXECUTE_ACTION_404'), $functionName);
422         }
423
424         // Return status
425         return $executed;
426 }
427 // "Execute edit" function: Update changed data
428 function SURFBAR_MEMBER_EXECUTE_EDIT_ACTION ($urlData) {
429         // Default is nothing done
430         $status = false;
431
432         // Has the URL or limit changed?
433         if (true) {
434                 //if (($urlData['url_views_allowed'] != $urlData['edit']['limit']) || ($url1 != $url2)) {
435                 // Run the query
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__);
438
439                 // All fine
440                 $status = true;
441         } // END - if
442
443         // Return status
444         return $status;
445 }
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)
449         return true;
450 }
451 //
452 // -----------------------------------------------------------------------------
453 //                           Self-maintenance functions
454 // -----------------------------------------------------------------------------
455 //
456 // Main function
457 function SURFBAR_HANDLE_SELF_MAINTENANCE () {
458         // Handle URLs which limit has depleted so we can stop them
459         SURFBAR_HANDLE_DEPLETED_VIEWS();
460
461         // Handle low-points amounts
462         SURFBAR_HANDLE_LOW_POINTS();
463 }
464 // Handle URLs which limit has depleted
465 function SURFBAR_HANDLE_DEPLETED_VIEWS () {
466         // Get all URLs
467         $urlArray = SURFBAR_GET_URL_DATA(0, 'url_views_max', 'url_id', 'ASC', 'url_id', " AND `url_views_allowed` > 0 AND `url_status`='ACTIVE'");
468
469         // Do we have some entries?
470         if (count($urlArray) > 0) {
471                 // Then handle all!
472                 foreach ($urlArray as $id => $urlData) {
473                         // Backup data
474                         $data = $urlData;
475
476                         // Rewrite array for next call
477                         $urlData[$id] = $data;
478
479                         // Handle the status
480                         SURFBAR_CHANGE_STATUS($id, 'ACTIVE', 'DEPLETED', $urlData);
481                 } // END - foreach
482         } // END - if
483 }
484
485 // Alert users which have URLs booked and are low on points amount
486 function SURFBAR_HANDLE_LOW_POINTS () {
487         // Get all userids
488         $userids = SURFBAR_DETERMINE_DEPLETED_USERIDS(getConfig('surfbar_warn_low_points'));
489
490         // "Walk" through all URLs
491         foreach ($userids['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')) {
494                         // Prepare content
495                         $content = array(
496                                 'userid'   => $userid,
497                                 'low'      => translateComma(getConfig('surfbar_warn_low_points')),
498                                 'points'   => translateComma($userids['points'][$userid]),
499                                 'notified' => generateDateTime($userids['notified'][$userid]),
500                                 'interval' => createFancyTime(getConfig('surfbar_low_interval'))
501                         );
502
503                         // Notify this user
504                         SURFBAR_NOTIFY_USER('low_points', $content);
505
506                         // Update last notified
507                         SQL_QUERY_ESC("UPDATE `{?_MYSQL_PREFIX?}_user_data` SET `surfbar_low_notified`=NOW() WHERE `userid`=%s LIMIT 1",
508                                 array($userid), __FUNCTION__, __LINE__);
509                 } // END - if
510         } // END - foreach
511 }
512
513 //
514 // -----------------------------------------------------------------------------
515 //                               Generic functions
516 // -----------------------------------------------------------------------------
517 //
518
519 // Looks up by an URL
520 function SURFBAR_LOOKUP_BY_URL ($url, $userid) {
521         // Now lookup that given URL by itself
522         $urlArray = SURFBAR_GET_URL_DATA($url, 'url', 'url_id', 'ASC', 'url_id', sprintf(" AND `url_userid`=%s", bigintval($userid)));
523
524         // Was it found?
525         return (count($urlArray) > 0);
526 }
527
528 // Load URL data by given search term and column
529 function SURFBAR_GET_URL_DATA ($searchTerm, $column = 'url_id', $order = 'url_id', $sort = 'ASC', $group = 'url_id', $add = '') {
530         // By default nothing is found
531         $GLOBALS['last_url_data'] = array();
532
533         // Is the column an id number?
534         if (($column == 'url_id') || ($column == 'url_userid')) {
535                 // Extra secure input
536                 $searchTerm = bigintval($searchTerm);
537         } // END - if
538
539         // If the column is 'id' there can be only one entry
540         $limit = '';
541         if ($column == 'id') {
542                 $limit = "LIMIT 1";
543         } // END - if
544
545         // Look up the record
546         $result = SQL_QUERY_ESC("SELECT
547         `url_id`,
548         `url_userid`,
549         `url`,
550         `url_views_total`,
551         `url_views_max`,
552         `url_views_allowed`,
553         `url_status`,
554         UNIX_TIMESTAMP(`url_registered`) AS `url_registered`,
555         UNIX_TIMESTAMP(`url_last_locked`) AS `url_last_locked`,
556         `url_lock_reason`,
557         `url_views_max`,
558         `url_views_allowed`,
559         `url_fixed_reload`
560 FROM
561         `{?_MYSQL_PREFIX?}_surfbar_urls`
562 WHERE
563         `%s`='%s'" . $add . "
564 ORDER BY
565         `%s` %s
566 %s",
567                 array(
568                         $column,
569                         $searchTerm,
570                         $order,
571                         $sort,
572                         $limit
573                 ), __FUNCTION__, __LINE__);
574
575         // Is there at least one record?
576         if (SQL_NUMROWS($result) > 0) {
577                 // Then load all!
578                 while ($dataRow = SQL_FETCHARRAY($result)) {
579                         // Shall we group these results?
580                         if ($group == 'url_id') {
581                                 // Add the row by id as index
582                                 $GLOBALS['last_url_data'][$dataRow['url_id']] = $dataRow;
583                         } else {
584                                 // Group entries
585                                 $GLOBALS['last_url_data'][$dataRow[$group]][$dataRow['url_id']] = $dataRow;
586                         }
587                 } // END - while
588         } // END - if
589
590         // Free the result
591         SQL_FREERESULT($result);
592
593         // Return the result
594         return $GLOBALS['last_url_data'];
595 }
596
597 // Registers an URL with the surfbar. You should have called SURFBAR_LOOKUP_BY_URL() first!
598 function SURFBAR_REGISTER_URL ($url, $userid, $status = 'PENDING', $addMode = 'reg', $extraFields = array()) {
599         // Make sure by the user registered URLs are always pending
600         if ($addMode == 'reg') {
601                 $status = 'PENDING';
602         } // END - if
603
604         // Prepare content
605         $content = merge_array($extraFields, array(
606                 'url'         => $url,
607                 'frametester' => generateFrametesterUrl($url),
608                 'url_userid'  => $userid,
609                 'url_status'  => $status,
610         ));
611
612         // Is limit/reload set?
613         if (!isset($config['limit'])) {
614                 $content['limit']  = '0';
615         } // END - if
616         if (!isset($config['reload'])) {
617                 $content['reload'] = '0';
618         } // END - if
619
620         // Insert the URL into database
621         $content['insert_id'] = SURFBAR_INSERT_URL_BY_ARRAY($content);
622
623         // Is this id valid?
624         if ($content['insert_id'] == '0') {
625                 // INSERT did not insert any data!
626                 return false;
627         } // END - if
628
629         // If in reg-mode we notify admin
630         if (($addMode == 'reg') || (getConfig('surfbar_notify_admin_unlock') == 'Y')) {
631                 // Notify admin even when he as unlocked an email
632                 SURFBAR_NOTIFY_ADMIN('url_' . $addMode, $content);
633         } // END - if
634
635         // Send mail to user
636         SURFBAR_NOTIFY_USER('url_' . $addMode, $content);
637
638         // Return the insert id
639         return $content['insert_id'];
640 }
641
642 // Inserts an url by given data array and return the insert id
643 function SURFBAR_INSERT_URL_BY_ARRAY ($urlData) {
644         // Get userid
645         $userid = bigintval($urlData['url_userid']);
646
647         // Is the id set?
648         if (empty($userid)) $userid = '0';
649
650         // Just run the insert query for now
651         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)",
652                 array(
653                         $userid,
654                         $urlData['url'],
655                         $urlData['url_status'],
656                         $urlData['limit'],
657                         $urlData['limit'],
658                         $urlData['reload']
659                 ), __FUNCTION__, __LINE__
660         );
661
662         // Return insert id
663         return SQL_INSERTID();
664 }
665
666 // Notify admin(s) with a selected message and content
667 function SURFBAR_NOTIFY_ADMIN ($messageType, $content) {
668         // Prepare template name
669         $templateName = sprintf("admin_surfbar_%s", $messageType);
670
671         // Prepare subject
672         $subject = getMessage(sprintf("ADMIN_SURFBAR_NOTIFY_%s_SUBJECT",
673                 strtoupper($messageType)
674         ));
675
676         // Is the subject line there?
677         if ((substr($subject, 0, 1) == '!') && (substr($subject, -1, 1) == '!')) {
678                 // Set default subject if following eval() wents wrong
679                 $subject = getMaskedMessage('ADMIN_SURFBAR_NOTIFY_DEFAULT_SUBJECT', strtoupper($messageType));
680         } // END - if
681
682         // Translate some data if present
683         $content = SURFBAR_PREPARE_CONTENT_FOR_TEMPLATE($content);
684
685         // Send the notification out
686         return sendAdminNotification($subject, $templateName, $content, $content['userid']);
687 }
688
689 // Notify the user about the performed action
690 function SURFBAR_NOTIFY_USER ($messageType, $content) {
691         // Skip notification if userid is zero
692         if ($content['userid'] == '0') {
693                 return false;
694         } // END - if
695
696         // Prepare template name
697         $templateName = sprintf("member_surfbar_%s", $messageType);
698
699         // Prepare subject
700         $subject = getMessage(sprintf("MEMBER_SURFBAR_NOTIFY_%s_SUBJECT",
701                 strtoupper($messageType)
702         ));
703
704         // Is the subject line there?
705         if ((substr($subject, 0, 1) == '!') && (substr($subject, -1, 1) == '!')) {
706                 // Set default subject if following eval() wents wrong
707                 $subject = getMessage('MEMBER_SURFBAR_NOTIFY_DEFAULT_SUBJECT');
708         } // END - if
709
710         // Translate some data if present
711         $content = SURFBAR_PREPARE_CONTENT_FOR_TEMPLATE($content);
712
713         // Load template
714         $mailText = loadEmailTemplate($templateName, $content, $content['userid']);
715
716         // Send the email
717         return sendEmail($content['userid'], $subject, $mailText);
718 }
719
720 // Translates some data for template usage
721 // @TODO Can't we use our new expression language instead of this ugly code?
722 function SURFBAR_PREPARE_CONTENT_FOR_TEMPLATE ($content) {
723         // Prepare some code
724         if (isset($content['url_registered']))  $content['url_registered']  = generateDateTime($content['url_registered'], 2);
725         if (isset($content['url_last_locked'])) $content['url_last_locked'] = generateDateTime($content['url_last_locked'], 2);
726
727         // Return translated content
728         return $content;
729 }
730
731 // Translates the limit
732 function translateSurfbarLimit ($limit) {
733         // Is this zero?
734         if ($limit == '0') {
735                 // Unlimited!
736                 $return = getMessage('MEMBER_SURFBAR_UNLIMITED_VIEWS');
737         } else {
738                 // Translate comma
739                 $return = translateComma($limit);
740         }
741
742         // Return value
743         return $return;
744 }
745
746 // Translate the URL status
747 function translateSurfbarUrlStatus ($status) {
748         // Create constant name
749         $constantName = sprintf("SURFBAR_URL_STATUS_%s", strtoupper($status));
750
751         // Get message
752         $statusTranslated = getMessage($constantName);
753
754         // Return result
755         return $statusTranslated;
756 }
757
758 // Determine reward
759 function SURFBAR_DETERMINE_REWARD ($onlyMin=false) {
760         // Static values are default
761         $reward = getConfig('surfbar_static_reward');
762
763         // Do we have static or dynamic?
764         if (getConfig('surfbar_pay_model') == 'DYNAMIC') {
765                 // "Calculate" dynamic reward
766                 if ($onlyMin) {
767                         $reward += SURFBAR_CALCULATE_DYNAMIC_MIN_VALUE();
768                 } else {
769                         $reward += SURFBAR_CALCULATE_DYNAMIC_ADD();
770                 }
771         } // END - if
772
773         // Return reward
774         return $reward;
775 }
776
777 // Determine costs
778 function SURFBAR_DETERMINE_COSTS ($onlyMin=false) {
779         // Static costs is default
780         $costs  = getConfig('surfbar_static_costs');
781
782         // Do we have static or dynamic?
783         if (getConfig('surfbar_pay_model') == 'DYNAMIC') {
784                 // "Calculate" dynamic costs
785                 if ($onlyMin) {
786                         $costs += SURFBAR_CALCULATE_DYNAMIC_MIN_VALUE();
787                 } else {
788                         $costs += SURFBAR_CALCULATE_DYNAMIC_ADD();
789                 }
790         } // END - if
791
792         // Return costs
793         return $costs;
794 }
795
796 // "Calculate" dynamic add
797 function SURFBAR_CALCULATE_DYNAMIC_ADD () {
798         // Get min/max values
799         $min = SURFBAR_CALCULATE_DYNAMIC_MIN_VALUE();
800         $max = SURFBAR_CALCULATE_DYNAMIC_MAX_VALUE();
801
802         // "Calculate" dynamic part and return it
803         return mt_rand($min, $max);
804 }
805
806 // Determine right template name
807 function SURFBAR_DETERMINE_TEMPLATE_NAME() {
808         // Default is the frameset
809         $templateName = "surfbar_frameset";
810
811         // Any frame set? ;-)
812         if (isGetRequestParameterSet('frame')) {
813                 // Use the frame as a template name part... ;-)
814                 $templateName = sprintf("surfbar_frame_%s",
815                         getRequestParameter('frame')
816                 );
817         } // END - if
818
819         // Return result
820         return $templateName;
821 }
822
823 // Check if the "reload lock" of the current user is full, call this function
824 // before you call SURFBAR_CHECK_RELOAD_LOCK().
825 function SURFBAR_CHECK_RELOAD_FULL() {
826         // Default is full!
827         $isFull = true;
828
829         // Cache static reload lock
830         $GLOBALS['surfbar_cache']['surf_lock'] = getConfig('surfbar_static_lock');
831         //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'Fixed surf lock is '.getConfig('surfbar_static_lock') . '', false);
832
833         // Do we have dynamic model?
834         if (getConfig('surfbar_pay_model') == 'DYNAMIC') {
835                 // "Calculate" dynamic lock
836                 $GLOBALS['surfbar_cache']['surf_lock'] += SURFBAR_CALCULATE_DYNAMIC_ADD();
837         } // END - if
838
839         // Ask the database
840         $result = SQL_QUERY_ESC("SELECT
841         COUNT(l.locks_id) AS cnt
842 FROM
843         `{?_MYSQL_PREFIX?}_surfbar_locks` AS l
844 INNER JOIN
845         `{?_MYSQL_PREFIX?}_surfbar_urls` AS u
846 ON
847         u.url_id=l.locks_url_id
848 WHERE
849         l.locks_userid=%s AND
850         (UNIX_TIMESTAMP() - ".SURFBAR_GET_SURF_LOCK().") < UNIX_TIMESTAMP(l.locks_last_surfed) AND
851         (
852                 ((UNIX_TIMESTAMP(l.locks_last_surfed) - u.url_fixed_reload) < 0 AND u.url_fixed_reload > 0) OR
853                 u.url_fixed_reload = '0'
854         )
855 LIMIT 1",
856                 array(getMemberId()), __FUNCTION__, __LINE__
857         );
858
859         // Fetch row
860         list($GLOBALS['surfbar_cache']['user_locks']) = SQL_FETCHROW($result);
861
862         // Is it null?
863         if (is_null($GLOBALS['surfbar_cache']['user_locks'])) {
864                 // Then fix it to zero!
865                 $GLOBALS['surfbar_cache']['user_locks'] = '0';
866         } // END - if
867
868         // Free result
869         SQL_FREERESULT($result);
870
871         // Get total URLs
872         $total = SURFBAR_GET_TOTAL_URLS();
873
874         // Do we have some URLs in lock?¬†Admins can always surf on own URLs!
875         //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, "userLocks=".SURFBAR_GET_USER_LOCKS().",total={$total}", false);
876         $isFull = ((SURFBAR_GET_USER_LOCKS() == $total) && ($total > 0));
877
878         // Return result
879         return $isFull;
880 }
881
882 // Get total amount of URLs of given status for current user or of ACTIVE URLs by default
883 function SURFBAR_GET_TOTAL_URLS ($status = 'ACTIVE', $excludeUserId = '0') {
884         // Determine depleted user account
885         $userids = SURFBAR_DETERMINE_DEPLETED_USERIDS();
886
887         // If we dont get any user ids back, there are no URLs
888         if (count($userids['userid']) == 0) {
889                 // No user ids found, no URLs!
890                 return 0;
891         } // END - if
892
893         // Is the exlude userid set?
894         if ($excludeUserId > 0) {
895                 // Then add it
896                 $userids['userid'][$excludeUserId] = $excludeUserId;
897         } // END - if
898
899         // Get amount from database
900         $result = SQL_QUERY_ESC("SELECT
901         COUNT(`url_id`) AS cnt
902 FROM
903         `{?_MYSQL_PREFIX?}_surfbar_urls`
904 WHERE
905         `url_userid` NOT IN (".implode(', ', $userids['userid']).") AND
906         `url_status`='%s'
907 LIMIT 1",
908                 array($status), __FUNCTION__, __LINE__
909         );
910
911         // Fetch row
912         list($cnt) = SQL_FETCHROW($result);
913
914         // Free result
915         SQL_FREERESULT($result);
916
917         // Return result
918         return $cnt;
919 }
920
921 // Check wether the user is allowed to book more URLs
922 function SURFBAR_IF_USER_BOOK_MORE_URLS ($userid = '0') {
923         // Is this admin and userid is zero or does the user has some URLs left to book?
924         return ((($userid == '0') && (isAdmin())) || (SURFBAR_GET_TOTAL_USER_URLS($userid, '', array('REJECTED')) < getConfig('surfbar_max_order')));
925 }
926
927 // Get total amount of URLs of given status for current user
928 function SURFBAR_GET_TOTAL_USER_URLS ($userid = '0', $status = '', $exclude = '') {
929         // Is the user 0 and user is logged in?
930         if (($userid == '0') && (isMember())) {
931                 // Then use this userid
932                 $userid = getMemberId();
933         } elseif ($userid == '0') {
934                 // Error!
935                 return (getConfig('surfbar_max_order') + 1);
936         }
937
938         // Default is all URLs
939         $add = '';
940
941         // Is the status set?
942         if (is_array($status)) {
943                 // Only URLs with these status
944                 $add = sprintf(" AND `url_status` IN('%s')", implode("','", $status));
945         } elseif (!empty($status)) {
946                 // Only URLs with this status
947                 $add = sprintf(" AND `url_status`='%s'", $status);
948         } elseif (is_array($exclude)) {
949                 // Exclude URLs with these status
950                 $add = sprintf(" AND `url_status` NOT IN('%s')", implode("','", $exclude));
951         } elseif (!empty($exclude)) {
952                 // Exclude URLs with this status
953                 $add = sprintf(" AND `url_status` != '%s'", $exclude);
954         }
955
956         // Get amount from database
957         $cnt = countSumTotalData($userid, 'surfbar_urls', 'url_id', 'url_userid', true, $add);
958
959         // Return result
960         return $cnt;
961 }
962
963 // Generate a validation code for the given id number
964 function SURFBAR_GENERATE_VALIDATION_CODE ($urlId, $salt = '') {
965         // @TODO Invalid salt should be refused
966         $GLOBALS['surfbar_cache']['salt'] = 'INVALID';
967
968         // Get code length from config
969         $length = getConfig('code_length');
970
971         // Fix length to 10
972         if ($length == '0') $length = 10;
973
974         // Generate a code until the length matches
975         $valCode = '';
976         while (strlen($valCode) != $length) {
977                 // Is the salt set?
978                 if (empty($salt)) {
979                         // Generate random hashed string
980                         $GLOBALS['surfbar_cache']['salt'] = sha1(generatePassword(mt_rand(200, 255)));
981                         //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'newSalt='.SURFBAR_GET_SALT().'', false);
982                 } else {
983                         // Use this as salt!
984                         $GLOBALS['surfbar_cache']['salt'] = $salt;
985                         //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'oldSalt='.SURFBAR_GET_SALT().'', false);
986                 }
987
988                 // ... and now the validation code
989                 $valCode = generateRandomCode($length, sha1(SURFBAR_GET_SALT().':'.$urlId), getMemberId());
990                 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'valCode='.valCode.'', false);
991         } // END - while
992
993         // Hash it with md5() and salt it with the random string
994         $hashedCode = generateHash(md5($valCode), SURFBAR_GET_SALT());
995
996         // Finally encrypt it PGP-like and return it
997         $valHashedCode = encodeHashForCookie($hashedCode);
998
999         // Return hashed value
1000         //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'finalValCode='.$valHashedCode.'', false);
1001         return $valHashedCode;
1002 }
1003
1004 // Check validation code
1005 function SURFBAR_CHECK_VALIDATION_CODE ($urlId, $check, $salt) {
1006         // Secure id number
1007         $urlId = bigintval($urlId);
1008
1009         // Now generate the code again
1010         $code = SURFBAR_GENERATE_VALIDATION_CODE($urlId, $salt);
1011
1012         // Return result of checking hashes and salts
1013         //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, '---'.$code.'|'.$check.'---', false);
1014         //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, '+++'.$salt.'|'.SURFBAR_GET_DATA('salts_last_salt').'+++', false);
1015         return (($code == $check) && ($salt == SURFBAR_GET_DATA('salts_last_salt')));
1016 }
1017
1018 // Lockdown the userid/id combination (reload lock)
1019 function SURFBAR_LOCKDOWN_ID ($urlId) {
1020         //* DEBUG: */ outputHtml('LOCK!');
1021         ///* DEBUG: */ return;
1022         // Just add it to the database
1023         SQL_QUERY_ESC("INSERT INTO `{?_MYSQL_PREFIX?}_surfbar_locks` (`locks_userid`, `locks_url_id`) VALUES (%s, %s)",
1024                 array(getMemberId(), bigintval($urlId)), __FUNCTION__, __LINE__);
1025
1026         // Remove the salt from database
1027         SQL_QUERY_ESC("DELETE LOW_PRIORITY FROM `{?_MYSQL_PREFIX?}_surfbar_salts` WHERE `salts_url_id`=%s AND `salts_userid`=%s LIMIT 1",
1028                 array(bigintval($urlId), getMemberId()), __FUNCTION__, __LINE__);
1029 }
1030
1031 // Pay points to the user and remove it from the sender if userid is given else it is a "sponsored surf"
1032 function SURFBAR_PAY_POINTS () {
1033         // Remove it from the URL owner
1034         //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'userid='.SURFBAR_GET_USERID().',costs='.SURFBAR_GET_COSTS().'', false);
1035         if (SURFBAR_GET_USERID() > 0) {
1036                 subtractPoints(sprintf("surfbar_%s", getConfig('surfbar_pay_model')), SURFBAR_GET_USERID(), SURFBAR_GET_COSTS());
1037         } // END - if
1038
1039         // Book it to the user
1040         //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'userid='.getMemberId().',reward='.SURFBAR_GET_REWARD().'', false);
1041         addPointsThroughReferalSystem(sprintf("surfbar_%s", getConfig('surfbar_pay_model')), getMemberId(), SURFBAR_GET_DATA('reward'));
1042 }
1043
1044 // Updates the statistics of current URL/userid
1045 function SURFBAR_UPDATE_INSERT_STATS_RECORD () {
1046         // Init add
1047         $add = '';
1048
1049         // Get allowed views
1050         $allowed = SURFBAR_GET_VIEWS_ALLOWED();
1051
1052         // Do we have a limit?
1053         if ($allowed > 0) {
1054                 // Then count views_max down!
1055                 $add .= ", `views_max`=`views_max`-1";
1056         } // END - if
1057
1058         // Update URL stats
1059         SQL_QUERY_ESC("UPDATE `{?_MYSQL_PREFIX?}_surfbar_urls` SET `url_views_total`=`url_views_total`+1".$add." WHERE `url_id`=%s LIMIT 1",
1060                 array(SURFBAR_GET_ID()), __FUNCTION__, __LINE__);
1061
1062         // Update the stats entry
1063         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",
1064                 array(
1065                         getMemberId(),
1066                         SURFBAR_GET_ID()
1067                 ), __FUNCTION__, __LINE__);
1068
1069         // Was that update okay?
1070         if (SQL_AFFECTEDROWS() < 1) {
1071                 // No, then insert entry
1072                 SQL_QUERY_ESC("INSERT INTO `{?_MYSQL_PREFIX?}_surfbar_stats` (`stats_userid`, `stats_url_id`, `stats_count`) VALUES (%s,%s,1)",
1073                         array(
1074                                 getMemberId(),
1075                                 SURFBAR_GET_ID()
1076                         ), __FUNCTION__, __LINE__);
1077         } // END - if
1078
1079         // Update total/daily/weekly/monthly counter
1080         incrementConfigEntry('surfbar_total_counter');
1081         incrementConfigEntry('surfbar_daily_counter');
1082         incrementConfigEntry('surfbar_weekly_counter');
1083         incrementConfigEntry('surfbar_monthly_counter');
1084
1085         // Update config as well
1086         updateConfiguration(array('surfbar_total_counter', 'surfbar_daily_counter', 'surfbar_weekly_counter', 'surfbar_monthly_counter'), array(1,1,1,1), '+');
1087 }
1088
1089 // Update the salt for validation and statistics
1090 function SURFBAR_UPDATE_SALT_STATS () {
1091         // Update statistics record
1092         SURFBAR_UPDATE_INSERT_STATS_RECORD();
1093
1094         // Simply store the salt from cache away in database...
1095         SQL_QUERY_ESC("UPDATE `{?_MYSQL_PREFIX?}_surfbar_salts` SET `salts_last_salt`='%s' WHERE `salts_url_id`=%s AND `salts_userid`=%s LIMIT 1",
1096                 array(
1097                         SURFBAR_GET_SALT(),
1098                         SURFBAR_GET_ID(),
1099                         getMemberId()
1100                 ), __FUNCTION__, __LINE__);
1101
1102         // Debug message
1103         //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'salt='.SURFBAR_GET_SALT().',id='.SURFBAR_GET_ID().',userid='.getMemberId().'', false);
1104
1105         // Was that okay?
1106         if (SQL_AFFECTEDROWS() < 1) {
1107                 // Insert missing entry!
1108                 SQL_QUERY_ESC("INSERT INTO `{?_MYSQL_PREFIX?}_surfbar_salts` (`salts_url_id`, `salts_userid`, `salts_last_salt`) VALUES (%s, %s, '%s')",
1109                         array(SURFBAR_GET_ID(), getMemberId(), SURFBAR_GET_SALT()), __FUNCTION__, __LINE__);
1110         } // END - if
1111
1112         // Debug message
1113         //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'affectedRows='.SQL_AFFECTEDROWS().'', false);
1114
1115         // Return if the update was okay
1116         return (SQL_AFFECTEDROWS() == 1);
1117 }
1118
1119 // Check if the reload lock is active for given id
1120 function SURFBAR_CHECK_RELOAD_LOCK ($urlId) {
1121         //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'id=' . $urlId . '', false);
1122         // Ask the database
1123         $result = SQL_QUERY_ESC("SELECT COUNT(`locks_id`) AS cnt
1124 FROM
1125         `{?_MYSQL_PREFIX?}_surfbar_locks`
1126 WHERE
1127         `locks_userid`=%s AND
1128         `locks_url_id`=%s AND
1129         (UNIX_TIMESTAMP() - ".SURFBAR_GET_SURF_LOCK().") < UNIX_TIMESTAMP(`locks_last_surfed`)
1130 ORDER BY
1131         `locks_last_surfed` ASC
1132 LIMIT 1",
1133                 array(getMemberId(), bigintval($urlId)), __FUNCTION__, __LINE__
1134         );
1135
1136         // Fetch counter
1137         list($cnt) = SQL_FETCHROW($result);
1138
1139         // Free result
1140         SQL_FREERESULT($result);
1141
1142         // Return check
1143         //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'cnt=' . $cnt . ',' . SURFBAR_GET_SURF_LOCK() . '', false);
1144         return ($cnt == 1);
1145 }
1146
1147 // Determine which user hash no more points left
1148 function SURFBAR_DETERMINE_DEPLETED_USERIDS ($limit=0) {
1149         // Init array
1150         $userids = array(
1151                 'userid'      => array(),
1152                 'points'   => array(),
1153                 'notified' => array(),
1154         );
1155
1156         // Do we have a current user id?
1157         if ((isMember()) && ($limit == '0')) {
1158                 // Then add this as well
1159                 $userids['userid'][getMemberId()]      = getMemberId();
1160                 $userids['points'][getMemberId()]   = countSumTotalData(getMemberId(), 'user_points', 'points') - countSumTotalData(getMemberId(), 'user_data', 'used_points');
1161                 $userids['notified'][getMemberId()] = '0';
1162
1163                 // Get all userid except logged in one
1164                 $result = SQL_QUERY_ESC("SELECT
1165         u.url_userid, UNIX_TIMESTAMP(d.surfbar_low_notified) AS notified
1166 FROM
1167         `{?_MYSQL_PREFIX?}_surfbar_urls` AS u
1168 INNER JOIN
1169         `{?_MYSQL_PREFIX?}_user_data` AS d
1170 ON
1171         u.url_userid=d.userid
1172 WHERE
1173         u.url_userid NOT IN (%s,0) AND u.url_status='ACTIVE'
1174 GROUP BY
1175         u.url_userid
1176 ORDER BY
1177         u.url_userid ASC",
1178                         array(getMemberId()), __FUNCTION__, __LINE__);
1179         } else {
1180                 // Get all userid
1181                 $result = SQL_QUERY("SELECT
1182         u.url_userid, UNIX_TIMESTAMP(d.surfbar_low_notified) AS notified
1183 FROM
1184         `{?_MYSQL_PREFIX?}_surfbar_urls` AS u
1185 INNER JOIN
1186         `{?_MYSQL_PREFIX?}_user_data` AS d
1187 ON
1188         u.url_userid=d.userid
1189 WHERE
1190         u.url_status='ACTIVE'
1191 GROUP BY
1192         u.url_userid
1193 ORDER BY
1194         u.url_userid ASC", __FUNCTION__, __LINE__);
1195         }
1196
1197         // Load all userid
1198         while ($content = SQL_FETCHARRAY($result)) {
1199                 // Get total points
1200                 $points = countSumTotalData($content['userid'], 'user_points', 'points') - countSumTotalData($content['userid'], 'user_data', 'used_points');
1201                 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, "userid={$content['userid']},points={$points}", false);
1202
1203                 // Shall we add this to ignore?
1204                 if ($points <= $limit) {
1205                         // Ignore this one!
1206                         //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, "userid={$content['userid']} has depleted points amount!", false);
1207                         $userids['userid'][$content['userid']]      = $content['userid'];
1208                         $userids['points'][$content['userid']]   = $points;
1209                         $userids['notified'][$content['userid']] = $content['notified'];
1210                 } // END - if
1211         } // END - while
1212
1213         // Free result
1214         SQL_FREERESULT($result);
1215
1216         // Debug message
1217         //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, "UIDs::count=".count($userids)." (with own userid=".getMemberId().')', false);
1218
1219         // Return result
1220         return $userids;
1221 }
1222
1223 // Determine how many users are Online in surfbar
1224 function SURFBAR_DETERMINE_TOTAL_ONLINE () {
1225         // Count all users in surfbar modue and return the value
1226         $result = SQL_QUERY("SELECT
1227         `stats_id`
1228 FROM
1229         `{?_MYSQL_PREFIX?}_surfbar_stats`
1230 WHERE
1231         (UNIX_TIMESTAMP() - UNIX_TIMESTAMP(`stats_last_surfed`)) <= {?online_timeout?}
1232 GROUP BY
1233         `stats_userid` ASC", __FUNCTION__, __LINE__);
1234
1235         // Fetch count
1236         $cnt = SQL_NUMROWS($result);
1237
1238         // Free result
1239         SQL_FREERESULT($result);
1240
1241         // Return result
1242         return $cnt;
1243 }
1244
1245 // Determine waiting time for one URL
1246 function SURFBAR_DETERMINE_WAIT_TIME () {
1247         // Get fixed reload lock
1248         $fixed = SURFBAR_GET_FIXED_RELOAD();
1249
1250         // Is the fixed reload time set?
1251         if ($fixed > 0) {
1252                 // Return it
1253                 return $fixed;
1254         } // END - if
1255
1256         // Static time is default
1257         $time = getConfig('surfbar_static_time');
1258
1259         // Which payment model do we have?
1260         if (getConfig('surfbar_pay_model') == 'DYNAMIC') {
1261                 // "Calculate" dynamic time
1262                 $time += SURFBAR_CALCULATE_DYNAMIC_ADD();
1263         } // END - if
1264
1265         // Return value
1266         return $time;
1267 }
1268
1269 // Changes the status of an URL from given to other
1270 function SURFBAR_CHANGE_STATUS ($urlId, $prevStatus, $newStatus, $data=array()) {
1271         // Make new status always lower-case
1272         $newStatus = strtolower($newStatus);
1273
1274         // Get URL data for status comparison if missing
1275         if ((!is_array($data)) || (count($data) == 0)) {
1276                 // Fetch missing URL data
1277                 $data = SURFBAR_GET_URL_DATA($urlId);
1278         } // END - if
1279
1280         // Is the new status set?
1281         if ((!is_string($newStatus)) || (empty($newStatus))) {
1282                 // Abort here, but fine!
1283                 return true;
1284         } // END - if
1285
1286         // Is the status like prevStatus is saying?
1287         if ($data[$urlId]['url_status'] != $prevStatus) {
1288                 // No, then abort here
1289                 return false;
1290         } // END - if
1291
1292
1293         // Update the status now
1294         // ---------- Comment out for debugging/developing member actions! ---------
1295         //SQL_QUERY_ESC("UPDATE `{?_MYSQL_PREFIX?}_surfbar_urls` SET `status`='%s' WHERE `id`=%s LIMIT 1",
1296         //      array($newStatus, bigintval($urlId)), __FUNCTION__, __LINE__);
1297         // ---------- Comment out for debugging/developing member actions! ---------
1298
1299         // Was that fine?
1300         // ---------- Comment out for debugging/developing member actions! ---------
1301         //if (SQL_AFFECTEDROWS() != 1) {
1302         //      // No, something went wrong
1303         //      return false;
1304         //} // END - if
1305         // ---------- Comment out for debugging/developing member actions! ---------
1306
1307         // Prepare content for notification routines
1308         $data[$urlId]['userid']         = $data[$urlId]['userid'];
1309         $data[$urlId]['frametester'] = generateFrametesterUrl($data[$urlId]['url']);
1310         $data[$urlId]['reward']      = translateComma(getConfig('surfbar_static_reward'));
1311         $data[$urlId]['costs']       = translateComma(getConfig('surfbar_static_costs'));
1312
1313         // Do some dirty fixing here:
1314         if (($data[$urlId]['url_status'] == 'STOPPED') && ($newStatus == 'pending')) {
1315                 // Fix for template change
1316                 $newStatus = 'continued';
1317         } // END - if
1318
1319         // Send admin notification
1320         SURFBAR_NOTIFY_ADMIN('url_' . $data[$urlId]['url_status'] . '_' . $newStatus, $data[$urlId]);
1321
1322         // Send user notification
1323         SURFBAR_NOTIFY_USER('url_' . $data[$urlId]['url_status'] . '_' . $newStatus, $data[$urlId]);
1324
1325         // All done!
1326         return true;
1327 }
1328
1329 // Calculate minimum value for dynamic payment model
1330 function SURFBAR_CALCULATE_DYNAMIC_MIN_VALUE () {
1331         // Addon is zero by default
1332         $addon = '0';
1333
1334         // Percentage part
1335         $percent = abs(log(getConfig('surfbar_dynamic_percent') / 100 + 1));
1336
1337         // Get total users
1338         $totalUsers = countSumTotalData('CONFIRMED', 'user_data', 'userid', 'status', true);
1339
1340         // Get online users
1341         $onlineUsers = SURFBAR_DETERMINE_TOTAL_ONLINE();
1342
1343         // Calculate addon
1344         $addon += abs(log($onlineUsers / $totalUsers + 1) * $percent * $totalUsers);
1345
1346         // Get total URLs
1347         $totalUrls = SURFBAR_GET_TOTAL_URLS('ACTIVE', 0);
1348
1349         // Get user's total URLs
1350         $userUrls = SURFBAR_GET_TOTAL_USER_URLS(0, 'ACTIVE');
1351
1352         // Calculate addon
1353         if ($totalUrls > 0) {
1354                 $addon += abs(log($userUrls / $totalUrls + 1) * $percent * $totalUrls);
1355         } else {
1356                 $addon += abs(log($userUrls / 1 + 1) * $percent * $totalUrls);
1357         }
1358
1359         // Return addon
1360         return $addon;
1361 }
1362
1363 // Calculate maximum value for dynamic payment model
1364 function SURFBAR_CALCULATE_DYNAMIC_MAX_VALUE () {
1365         // Addon is zero by default
1366         $addon = '0';
1367
1368         // Maximum value
1369         $max = log(2);
1370
1371         // Percentage part
1372         $percent = abs(log(getConfig('surfbar_dynamic_percent') / 100 + 1));
1373
1374         // Get total users
1375         $totalUsers = countSumTotalData('CONFIRMED', 'user_data', 'userid', 'status', true);
1376
1377         // Calculate addon
1378         $addon += abs($max * $percent * $totalUsers);
1379
1380         // Get total URLs
1381         $totalUrls = SURFBAR_GET_TOTAL_URLS('ACTIVE', 0);
1382
1383         // Calculate addon
1384         $addon += abs($max * $percent * $totalUrls);
1385
1386         // Return addon
1387         return $addon;
1388 }
1389
1390 // Calculate dynamic lock
1391 function SURFBAR_CALCULATE_DYNAMIC_LOCK () {
1392         // Default lock is 30 seconds
1393         $addon = 30;
1394
1395         // Get online users
1396         $onlineUsers = SURFBAR_DETERMINE_TOTAL_ONLINE();
1397
1398         // Calculate lock
1399         $addon = abs(log($onlineUsers / $addon + 1));
1400
1401         // Return value
1402         return $addon;
1403 }
1404
1405 // "Getter" for lock ids array
1406 function SURFBAR_GET_LOCK_IDS () {
1407         // Prepare some arrays
1408         $IDs = array();
1409         $USE = array();
1410         $ignored = array();
1411
1412         // Get all id from locks within the timestamp
1413         $result = SQL_QUERY_ESC("SELECT `locks_id`, `locks_url_id`, UNIX_TIMESTAMP(`locks_last_surfed`) AS last_surfed
1414 FROM
1415         `{?_MYSQL_PREFIX?}_surfbar_locks`
1416 WHERE
1417         `locks_userid`=%s
1418 ORDER BY
1419         `locks_id` ASC", array(getMemberId()),
1420         __FUNCTION__, __LINE__);
1421
1422         // Load all entries
1423         while ($content = SQL_FETCHARRAY($result)) {
1424                 // Debug message
1425                 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'next - lid='.$content['id'].',url='.$content['url_id'].',rest='.(time() - $content['last_surfed']).'/'.SURFBAR_GET_SURF_LOCK().'', false);
1426
1427                 // Skip entries that are too old
1428                 if (($content['last_surfed'] > (time() - SURFBAR_GET_SURF_LOCK())) && (!in_array($content['url_id'], $ignored))) {
1429                         // Debug message
1430                         //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'okay - lid='.$content['id'].',url='.$content['url_id'].',last='.$content['last_surfed'].'', false);
1431
1432                         // Add only if missing or bigger
1433                         if ((!isset($IDs[$content['url_id']])) || ($IDs[$content['url_id']] > $content['last_surfed'])) {
1434                                 // Debug message
1435                                 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'ADD - lid='.$content['id'].',url='.$content['url_id'].',last='.$content['last_surfed'].'', false);
1436
1437                                 // Add this id
1438                                 $IDs[$content['url_id']] = $content['last_surfed'];
1439                                 $USE[$content['url_id']] = $content['id'];
1440                         } // END - if
1441                 } else {
1442                         // Debug message
1443                         //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'ignore - lid='.$content['id'].',url='.$content['url_id'].',last='.$content['last_surfed'].'', false);
1444
1445                         // Ignore these old entries!
1446                         $ignored[] = $content['url_id'];
1447                         unset($IDs[$content['url_id']]);
1448                         unset($USE[$content['url_id']]);
1449                 }
1450         } // END - while
1451
1452         // Free result
1453         SQL_FREERESULT($result);
1454
1455         // Return array
1456         return $USE;
1457 }
1458
1459 // "Getter" for maximum random number
1460 function SURFBAR_GET_MAX_RANDOM ($userids, $add) {
1461         // Count max availabe entries
1462         $result = SQL_QUERY("SELECT
1463         sbu.url_id AS cnt
1464 FROM
1465         `{?_MYSQL_PREFIX?}_surfbar_urls` AS sbu
1466 LEFT JOIN
1467         `{?_MYSQL_PREFIX?}_surfbar_salts` AS sbs
1468 ON
1469         sbu.url_id=sbs.salts_url_id
1470 LEFT JOIN
1471         `{?_MYSQL_PREFIX?}_surfbar_locks` AS l
1472 ON
1473         sbu.url_id=l.locks_url_id
1474 WHERE
1475         sbu.url_userid NOT IN (".implode(',', $userids).") AND
1476         (sbu.url_views_allowed=0 OR (sbu.url_views_allowed > 0 AND sbu.url_views_max > 0)) AND
1477         sbu.url_status='ACTIVE'
1478         ".$add."
1479 GROUP BY
1480         sbu.url_id ASC", __FUNCTION__, __LINE__);
1481
1482         // Log last query
1483         //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'lastQuery='.getConfig('db_last_query').'|numRows='.SQL_NUMROWS($result).'|Affected='.SQL_AFFECTEDROWS().'', false);
1484
1485         // Fetch max rand
1486         $maxRand = SQL_NUMROWS($result);
1487
1488         // Free result
1489         SQL_FREERESULT($result);
1490
1491         // Return value
1492         return $maxRand;
1493 }
1494
1495 // Load all URLs of the current user and return it as an array
1496 function SURFBAR_GET_USER_URLS () {
1497         // Init array
1498         $urlArray = array();
1499
1500         // Begin the query
1501         $result = SQL_QUERY_ESC("SELECT
1502         u.url_id,
1503         u.url_userid,
1504         u.url,
1505         u.url_status,
1506         u.url_views_total,
1507         u.url_views_max,
1508         u.url_views_allowed,
1509         UNIX_TIMESTAMP(u.url_registered) AS `url_registered`,
1510         UNIX_TIMESTAMP(u.url_last_locked) AS `url_last_locked`,
1511         u.url_lock_reason
1512 FROM
1513         `{?_MYSQL_PREFIX?}_surfbar_urls` AS u
1514 WHERE
1515         u.url_userid=%s AND
1516         u.url_status != 'DELETED'
1517 ORDER BY
1518         u.url_id ASC",
1519         array(getMemberId()), __FUNCTION__, __LINE__);
1520
1521         // Are there entries?
1522         if (SQL_NUMROWS($result) > 0) {
1523                 // Load all rows
1524                 while ($row = SQL_FETCHARRAY($result)) {
1525                         // Add the row
1526                         $urlArray[$row['id']] = $row;
1527                 } // END - while
1528         } // END - if
1529
1530         // Free result
1531         SQL_FREERESULT($result);
1532
1533         // Return the array
1534         return $urlArray;
1535 }
1536
1537 // "Getter" for member action array for given status
1538 function SURFBAR_GET_ARRAY_FROM_STATUS ($status) {
1539         // Init array
1540         $returnArray = array();
1541
1542         // Get all assigned actions
1543         $result = SQL_QUERY_ESC("SELECT `action` FROM `{?_MYSQL_PREFIX?}_surfbar_actions` WHERE `actions_status`='%s' ORDER BY `actions_id` ASC",
1544                 array($status), __FUNCTION__, __LINE__);
1545
1546         // Some entries there?
1547         if (SQL_NUMROWS($result) > 0) {
1548                 // Load all actions
1549                 // @TODO This can be somehow rewritten
1550                 while ($content = SQL_FETCHARRAY($result)) {
1551                         $returnArray[] = $content['action'];
1552                 } // END - if
1553         } // END - if
1554
1555         // Free result
1556         SQL_FREERESULT($result);
1557
1558         // Return result
1559         return $returnArray;
1560 }
1561
1562 // Reload to configured stop page
1563 function SURFBAR_RELOAD_TO_STOP_PAGE ($page = 'stop') {
1564         // Internal or external?
1565         if ((getConfig('surfbar_pause_mode') == 'INTERNAL') || (getConfig('surfbar_pause_url') == '')) {
1566                 // Reload to internal page
1567                 redirectToUrl('surfbar.php?frame=' . $page);
1568         } else {
1569                 // Reload to external page
1570                 redirectToConfiguredUrl('surfbar_pause_url');
1571         }
1572 }
1573
1574 // Determine next id for surfbar or get data for given id, always call this before you call other
1575 // getters below this function!!!
1576 function SURFBAR_DETERMINE_NEXT_ID ($urlId = '0') {
1577         // Default is no id and no random number
1578         $nextId = '0';
1579         $randNum = '0';
1580
1581         // Is the id set?
1582         if ($urlId == '0') {
1583                 // Get array with lock ids
1584                 $USE = SURFBAR_GET_LOCK_IDS();
1585
1586                 // Shall we add some URL ids to ignore?
1587                 $add = '';
1588                 if (count($USE) > 0) {
1589                         // Ignore some!
1590                         $add = " AND sbu.url_id NOT IN (";
1591                         foreach ($USE as $url_id => $lid) {
1592                                 // Add URL id
1593                                 $add .= $url_id.',';
1594                         } // END - foreach
1595
1596                         // Add closing bracket
1597                         $add = substr($add, 0, -1) . ')';
1598                 } // END - if
1599
1600                 // Determine depleted user account
1601                 $userids = SURFBAR_DETERMINE_DEPLETED_USERIDS();
1602
1603                 // Get maximum randomness factor
1604                 $maxRand = SURFBAR_GET_MAX_RANDOM($userids['userid'], $add);
1605
1606                 // If more than one URL can be called generate the random number!
1607                 if ($maxRand > 1) {
1608                         // Generate random number
1609                         $randNum = mt_rand(0, ($maxRand - 1));
1610                 } // END - if
1611
1612                 // And query the database
1613                 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'randNum='.$randNum.',maxRand='.$maxRand.',surfLock='.SURFBAR_GET_SURF_LOCK().'', false);
1614                 $result = SQL_QUERY_ESC("SELECT
1615         sbu.url_id,
1616         sbu.url_userid,
1617         sbu.url,
1618         sbs.salts_last_salt,
1619         sbu.url_views_total,
1620         sbu.url_views_max,
1621         sbu.url_views_allowed,
1622         UNIX_TIMESTAMP(l.locks_last_surfed) AS last_surfed,
1623         sbu.url_fixed_reload
1624 FROM
1625         `{?_MYSQL_PREFIX?}_surfbar_urls` AS sbu
1626 LEFT JOIN
1627         `{?_MYSQL_PREFIX?}_surfbar_salts` AS sbs
1628 ON
1629         sbu.url_id=sbs.salts_url_id
1630 LEFT JOIN
1631         `{?_MYSQL_PREFIX?}_surfbar_locks` AS l
1632 ON
1633         sbu.url_id=l.locks_url_id
1634 WHERE
1635         sbu.url_userid NOT IN (".implode(',', $userids['userid']).") AND
1636         sbu.url_status='ACTIVE' AND
1637         (sbu.url_views_allowed=0 OR (sbu.url_views_allowed > 0 AND sbu.url_views_max > 0))
1638         ".$add."
1639 GROUP BY
1640         sbu.url_id
1641 ORDER BY
1642         l.locks_last_surfed ASC,
1643         sbu.url_id ASC
1644 LIMIT %s,1",
1645                         array($randNum), __FUNCTION__, __LINE__
1646                 );
1647         } else {
1648                 // Get data from specified id number
1649                 $result = SQL_QUERY_ESC("SELECT
1650         sbu.url_id,
1651         sbu.url_userid,
1652         sbu.url,
1653         sbs.salts_last_salt,
1654         sbu.url_views_total,
1655         sbu.url_views_max,
1656         sbu.url_views_allowed,
1657         UNIX_TIMESTAMP(l.locks_last_surfed) AS last_surfed,
1658         sbu.url_fixed_reload
1659 FROM
1660         `{?_MYSQL_PREFIX?}_surfbar_urls` AS sbu
1661 LEFT JOIN
1662         `{?_MYSQL_PREFIX?}_surfbar_salts` AS sbs
1663 ON
1664         sbu.url_id=sbs.salts_url_id
1665 LEFT JOIN
1666         `{?_MYSQL_PREFIX?}_surfbar_locks` AS l
1667 ON
1668         sbu.url_id=l.locks_url_id
1669 WHERE
1670         sbu.url_userid != %s AND
1671         sbu.url_status='ACTIVE' AND
1672         sbu.url_id=%s AND
1673         (sbu.url_views_allowed=0 OR (sbu.url_views_allowed > 0 AND sbu.url_views_max > 0))
1674 LIMIT 1",
1675                         array(getMemberId(), bigintval($urlId)), __FUNCTION__, __LINE__
1676                 );
1677         }
1678
1679         // Is there an id number?
1680         //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'lastQuery='.getConfig('db_last_query').'|numRows='.SQL_NUMROWS($result).'|Affected='.SQL_AFFECTEDROWS().'', false);
1681         if (SQL_NUMROWS($result) == 1) {
1682                 // Load/cache data
1683                 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'count('.count($GLOBALS['surfbar_cache']).') - BEFORE', false);
1684                 $GLOBALS['surfbar_cache'] = merge_array($GLOBALS['surfbar_cache'], SQL_FETCHARRAY($result));
1685                 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'count('.count($GLOBALS['surfbar_cache']).') - AFTER', false);
1686
1687                 // Determine waiting time
1688                 $GLOBALS['surfbar_cache']['time'] = SURFBAR_DETERMINE_WAIT_TIME();
1689
1690                 // Is the last salt there?
1691                 if (is_null($GLOBALS['surfbar_cache']['salts_last_salt'])) {
1692                         // Then repair it wit the static!
1693                         //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'last_salt - FIXED!', false);
1694                         $GLOBALS['surfbar_cache']['salts_last_salt'] = '';
1695                 } // END - if
1696
1697                 // Fix missing last_surfed
1698                 if ((!isset($GLOBALS['surfbar_cache']['last_surfed'])) || (is_null($GLOBALS['surfbar_cache']['last_surfed']))) {
1699                         // Fix it here
1700                         //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'last_surfed - FIXED!', false);
1701                         $GLOBALS['surfbar_cache']['last_surfed'] = '0';
1702                 } // END - if
1703
1704                 // Get base/fixed reward and costs
1705                 $GLOBALS['surfbar_cache']['reward'] = SURFBAR_DETERMINE_REWARD();
1706                 $GLOBALS['surfbar_cache']['costs']  = SURFBAR_DETERMINE_COSTS();
1707                 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'BASE/STATIC - reward='.SURFBAR_GET_REWARD().'|costs='.SURFBAR_GET_COSTS().'', false);
1708
1709                 // Only in dynamic model add the dynamic bonus!
1710                 if (getConfig('surfbar_pay_model') == 'DYNAMIC') {
1711                         // Calculate dynamic reward/costs and add it
1712                         $GLOBALS['surfbar_cache']['reward'] += SURFBAR_CALCULATE_DYNAMIC_ADD();
1713                         $GLOBALS['surfbar_cache']['costs']  += SURFBAR_CALCULATE_DYNAMIC_ADD();
1714                         //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'DYNAMIC+ - reward='.SURFBAR_GET_REWARD().'|costs='.SURFBAR_GET_COSTS().'', false);
1715                 } // END - if
1716
1717                 // Now get the id
1718                 $nextId = SURFBAR_GET_ID();
1719         } // END - if
1720
1721         // Free result
1722         SQL_FREERESULT($result);
1723
1724         // Return result
1725         //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'nextId='.$nextId.'', false);
1726         return $nextId;
1727 }
1728
1729 // -----------------------------------------------------------------------------
1730 // PLEASE DO NOT ADD ANY OTHER FUNCTIONS BELOW THIS LINE IF THEY DON'T "WRAP"
1731 // THE $GLOBALS['surfbar_cache'] ARRAY!
1732 // -----------------------------------------------------------------------------
1733
1734 // Initializes the surfbar
1735 function SURFBAR_INIT () {
1736         // Init cache array
1737         $GLOBALS['surfbar_cache'] = array();
1738 }
1739
1740 // Private getter for data elements
1741 function SURFBAR_GET_DATA ($element) {
1742         //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, "element={$element}", false);
1743
1744         // Default is null
1745         $data = null;
1746
1747         // Is the entry there?
1748         if (isset($GLOBALS['surfbar_cache'][$element])) {
1749                 // Then take it
1750                 $data = $GLOBALS['surfbar_cache'][$element];
1751         } else { // END - if
1752                 print('<pre>');
1753                 print_r($GLOBALS['surfbar_cache']);
1754                 print('</pre>');
1755                 debug_report_bug('Element ' . $element . ' not found.');
1756         }
1757
1758         // Return result
1759         //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'element[' . $element . ']=[' . gettype($data) . ']' . $data, false);
1760         return $data;
1761 }
1762
1763 // Getter for reward from cache
1764 function SURFBAR_GET_REWARD () {
1765         // Get data element and return its contents
1766         return SURFBAR_GET_DATA('reward');
1767 }
1768
1769 // Getter for costs from cache
1770 function SURFBAR_GET_COSTS () {
1771         // Get data element and return its contents
1772         return SURFBAR_GET_DATA('costs');
1773 }
1774
1775 // Getter for URL from cache
1776 function SURFBAR_GET_URL () {
1777         // Get data element and return its contents
1778         return SURFBAR_GET_DATA('url');
1779 }
1780
1781 // Getter for salt from cache
1782 function SURFBAR_GET_SALT () {
1783         // Get data element and return its contents
1784         return SURFBAR_GET_DATA('salt');
1785 }
1786
1787 // Getter for id from cache
1788 function SURFBAR_GET_ID () {
1789         // Get data element and return its contents
1790         return SURFBAR_GET_DATA('url_id');
1791 }
1792
1793 // Getter for userid from cache
1794 function SURFBAR_GET_USERID () {
1795         // Get data element and return its contents
1796         return SURFBAR_GET_DATA('url_userid');
1797 }
1798
1799 // Getter for user reload locks
1800 function SURFBAR_GET_USER_LOCKS () {
1801         // Get data element and return its contents
1802         return SURFBAR_GET_DATA('user_locks');
1803 }
1804
1805 // Getter for reload time
1806 function SURFBAR_GET_RELOAD_TIME () {
1807         // Get data element and return its contents
1808         return SURFBAR_GET_DATA('time');
1809 }
1810
1811 // Getter for allowed views
1812 function SURFBAR_GET_VIEWS_ALLOWED () {
1813         // Get data element and return its contents
1814         return SURFBAR_GET_DATA('url_views_allowed');
1815 }
1816
1817 // Getter for maximum views
1818 function SURFBAR_GET_VIEWS_MAX () {
1819         // Get data element and return its contents
1820         return SURFBAR_GET_DATA('url_views_max');
1821 }
1822
1823 // Getter for fixed reload
1824 function SURFBAR_GET_FIXED_RELOAD () {
1825         // Get data element and return its contents
1826         return SURFBAR_GET_DATA('url_fixed_reload');
1827 }
1828
1829 // Getter for surf lock
1830 function SURFBAR_GET_SURF_LOCK () {
1831         // Get data element and return its contents
1832         return SURFBAR_GET_DATA('surf_lock');
1833 }
1834
1835 // Getter for new status
1836 function SURFBAR_GET_NEW_STATUS () {
1837         // Get data element and return its contents
1838         return SURFBAR_GET_DATA('new_status');
1839 }
1840
1841 // [EOF]
1842 ?>