Problem with one URL not in reload lock fixed
[mailer.git] / inc / libs / surfbar_functions.php
1 <?php
2 /************************************************************************
3  * MXChange v0.2.1                                    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  *                                                                      *
14  * -------------------------------------------------------------------- *
15  * Copyright (c) 2003 - 2008 by Roland Haeder                           *
16  * For more information visit: http://www.mxchange.org                  *
17  *                                                                      *
18  * This program is free software; you can redistribute it and/or modify *
19  * it under the terms of the GNU General Public License as published by *
20  * the Free Software Foundation; either version 2 of the License, or    *
21  * (at your option) any later version.                                  *
22  *                                                                      *
23  * This program is distributed in the hope that it will be useful,      *
24  * but WITHOUT ANY WARRANTY; without even the implied warranty of       *
25  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the        *
26  * GNU General Public License for more details.                         *
27  *                                                                      *
28  * You should have received a copy of the GNU General Public License    *
29  * along with this program; if not, write to the Free Software          *
30  * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston,               *
31  * MA  02110-1301  USA                                                  *
32  ************************************************************************/
33
34 // Some security stuff...
35 if (ereg(basename(__FILE__), $_SERVER['PHP_SELF'])) {
36         $INC = substr(dirname(__FILE__), 0, strpos(dirname(__FILE__), "/inc") + 4) . "/security.php";
37         require($INC);
38 }
39
40 // Admin has added an URL with given user id
41 function SURFBAR_ADMIN_ADD_URL ($url, $uid, $reward, $costs, $paymentId) {
42         // Is this really an admin?
43         if (!IS_ADMIN()) {
44                 // Then leave here
45                 return false;
46         } // END - if
47
48         // Check if that URL does not exist
49         if (SURFBAR_LOOKUP_BY_URL($url, $uid)) {
50                 // Already found!
51                 return false;
52         } // END - if
53
54         // Register the new URL
55         return SURFBAR_REGISTER_URL($url, $uid, $reward, $costs, $paymentId, "CONFIRMED", "unlock");
56 }
57 // Looks up by an URL
58 function SURFBAR_LOOKUP_BY_URL ($url) {
59         // Now lookup that given URL by itself
60         $urlArray = SURFBAR_GET_URL_DATA($url, "url");
61
62         // Was it found?
63         return (count($urlArray) > 0);
64 }
65 // Load URL data by given search term and column
66 function SURFBAR_GET_URL_DATA ($searchTerm, $column="id", $order="id", $sort="ASC", $group="id") {
67         global $lastUrlData;
68
69         // By default nothing is found
70         $lastUrlData = array();
71
72         // Is the column an id number?
73         if (($column == "id") || ($column == "userid")) {
74                 // Extra secure input
75                 $searchTerm = bigintval($searchTerm);
76         } // END - if
77
78         // Look up the record
79         $result = SQL_QUERY_ESC("SELECT id, userid, url, reward, costs, views_total, status, registered, last_locked, lock_reason
80 FROM "._MYSQL_PREFIX."_surfbar_urls
81 WHERE %s='%s'
82 ORDER BY %s %s",
83                 array($column, $searchTerm, $order, $sort), __FILE__, __LINE__);
84
85         // Is there at least one record?
86         if (SQL_NUMROWS($result) > 0) {
87                 // Then load all!
88                 while ($dataRow = SQL_FETCHARRAY($result)) {
89                         // Shall we group these results?
90                         if ($group == "id") {
91                                 // Add the row by id as index
92                                 $lastUrlData[$dataRow['id']] = $dataRow;
93                         } else {
94                                 // Group entries
95                                 $lastUrlData[$dataRow[$group]][$dataRow['id']] = $dataRow;
96                         }
97                 } // END - while
98         } // END - if
99
100         // Free the result
101         SQL_FREERESULT($result);
102
103         // Return the result
104         return $lastUrlData;
105 }
106 // Registers an URL with the surfbar. You should have called SURFBAR_LOOKUP_BY_URL() first!
107 function SURFBAR_REGISTER_URL ($url, $uid, $reward, $paymentId, $costs, $status="PENDING", $addMode="reg") {
108         global $_CONFIG;
109
110         // Make sure by the user registered URLs are always pending
111         if ($addMode == "reg") $status = "PENDING";
112
113         // Prepare content
114         $content = array(
115                 'url'         => $url,
116                 'frametester' => FRAMETESTER($url),
117                 'uid'         => $uid,
118                 'reward'      => $reward,
119                 'costs'       => $costs,
120                 'payment_id'  => $paymentId,
121                 'status'      => $status
122         );
123
124         // Insert the URL into database
125         $content['insert_id'] = SURFBAR_INSERT_URL_BY_ARRAY($content);
126
127         // Translate status, reward and costs
128         $content['status'] = SURFBAR_TRANSLATE_STATUS($content['status']);
129         $content['reward'] = TRANSLATE_COMMA($content['reward']);
130         $content['costs']  = TRANSLATE_COMMA($content['costs']);
131
132         // If in reg-mode we notify admin
133         if (($addMode == "reg") || ($_CONFIG['surfbar_notify_admin_unlock'] == "Y")) {
134                 // Notify admin even when he as unlocked an email
135                 SURFBAR_NOTIFY_ADMIN("url_{$addMode}", $content);
136         } // END - if
137
138         // Send mail to user
139         SURFBAR_NOTIFY_USER("url_{$addMode}", $content);
140
141         // Return the insert id
142         return $content['insert_id'];
143 }
144 // Inserts an url by given data array and return the insert id
145 function SURFBAR_INSERT_URL_BY_ARRAY ($urlData) {
146         // Just run the insert query for now
147         SQL_QUERY_ESC("INSERT INTO "._MYSQL_PREFIX."_surfbar_urls (userid, url, reward, costs, payment_id, status) VALUES(%s, '%s', %s, %s, %s, '%s')",
148                 array(
149                         bigintval($urlData['uid']),
150                         $urlData['url'],
151                         (float)$urlData['reward'],
152                         (float)$urlData['costs'],
153                         bigintval($urlData['payment_id']),
154                         $urlData['status']
155                 ), __FILE__, __LINE__
156         );
157
158         // Return insert id
159         return SQL_INSERTID();
160 }
161 // Notify admin(s) with a selected message and content
162 function SURFBAR_NOTIFY_ADMIN ($messageType, $content) {
163         // Prepare template name
164         $templateName = sprintf("admin_surfbar_%s", $messageType);
165
166         // Prepare subject
167         $eval = sprintf("\$subject = ADMIN_SURFBAR_NOTIFY_%s_SUBJECT;",
168                 strtoupper($messageType)
169         );
170         eval($eval);
171
172         // Send the notification out
173         SEND_ADMIN_NOTIFICATION($subject, $templateName, $content, $content['uid']);
174 }
175 // Notify the user about the performed action
176 function SURFBAR_NOTIFY_USER ($messageType, $content) {
177         // Prepare template name
178         $templateName = sprintf("member_surfbar_%s", $messageType);
179
180         // Prepare subject
181         $eval = sprintf("\$subject = MEMBER_SURFBAR_NOTIFY_%s_SUBJECT;",
182                 strtoupper($messageType)
183         );
184         eval($eval);
185
186         // Load template
187         $mailText = LOAD_EMAIL_TEMPLATE($templateName, $content);
188
189         // Send the email
190         SEND_EMAIL($content['uid'], $subject, $mailText);
191 }
192 // Translate the URL status
193 function SURFBAR_TRANSLATE_STATUS ($status) {
194         // Create constant name
195         $constantName = sprintf("SURFBAR_URL_STATUS_%s", strtoupper($status));
196
197         // Set default translated status
198         $statusTranslated = "!".$constantName."!";
199
200         // Generate eval() command
201         if (defined($constantName)) {
202                 $eval = "\$statusTranslated = ".$constantName.";";
203                 eval($eval);
204         } // END - if
205
206         // Return result
207         return $statusTranslated;
208 }
209 // Determine right template name
210 function SURFBAR_DETERMINE_TEMPLATE_NAME() {
211         // Default is the frameset
212         $templateName = "surfbar_frameset";
213
214         // Any frame set? ;-)
215         if (isset($_GET['frame'])) {
216                 // Use the frame as a template name part... ;-)
217                 $templateName = sprintf("surfbar_frame_%s",
218                         SQL_ESCAPE($_GET['frame'])
219                 );
220         } // END - if
221
222         // Return result
223         return $templateName;
224 }
225 // Check if the "reload lock" of the current user is full, call this function
226 // before you call SURFBAR_CHECK_RELOAD_LOCK().
227 function SURFBAR_CHECK_RELOAD_FULL() {
228         global $SURFBAR_CACHE, $_CONFIG;
229
230         // Default is full!
231         $isFull = true;
232
233         // Do we have static or dynamic mode?
234         if ($_CONFIG['surfbar_pay_model'] == "STATIC") {
235                 // Cache static reload lock
236                 $SURFBAR_CACHE['surf_lock'] = $_CONFIG['surfbar_static_lock'];
237
238                 // Ask the database
239                 $result = SQL_QUERY_ESC("SELECT COUNT(id) AS cnt FROM "._MYSQL_PREFIX."_surfbar_locks
240 WHERE userid=%s AND (UNIX_TIMESTAMP() - ".SURFBAR_GET_DATA('surf_lock').") < UNIX_TIMESTAMP(last_surfed)
241 LIMIT 1",
242                         array($GLOBALS['userid']), __FILE__, __LINE__
243                 );
244
245                 // Fetch row
246                 list($SURFBAR_CACHE['user_locks']) = SQL_FETCHROW($result);
247
248                 // Is it null?
249                 if (is_null($SURFBAR_CACHE['user_locks'])) {
250                         // Then fix it to zero!
251                         $SURFBAR_CACHE['user_locks'] = 0;
252                 } // END - if
253
254                 // Free result
255                 SQL_FREERESULT($result);
256
257                 // Get total URLs
258                 $total = SURFBAR_GET_TOTAL_URLS();
259
260                 // Do we have some URLs in lock?¬†Admins can always surf on own URLs!
261                 //* DEBUG: */ echo __FUNCTION__.":userLocks=".SURFBAR_GET_DATA('user_locks').",total={$total}<br />\n";
262                 $isFull = ((SURFBAR_GET_DATA('user_locks') == $total) && ($total > 0));
263         } else {
264                 // Dynamic model...
265                 die("DYNAMIC not yet implemented!");
266         }
267
268         // Return result
269         return $isFull;
270 }
271 // Get total amount of URLs of given status for current user or of CONFIRMED URLs by default
272 function SURFBAR_GET_TOTAL_URLS ($status="CONFIRMED") {
273         // Get amount from database
274         $result = SQL_QUERY_ESC("SELECT COUNT(id) AS cnt
275 FROM "._MYSQL_PREFIX."_surfbar_urls
276 WHERE userid != %d AND status='%s'",
277                 array($GLOBALS['userid'], $status), __FILE__, __LINE__
278         );
279
280         // Fetch row
281         list($cnt) = SQL_FETCHROW($result);
282
283         // Free result
284         SQL_FREERESULT($result);
285
286         // Return result
287         return $cnt;
288 }
289 // Generate a validation code for the given id number
290 function SURFBAR_GENERATE_VALIDATION_CODE ($id, $salt="") {
291         global $_CONFIG, $SURFBAR_CACHE;
292
293         // Generate a code until the length matches
294         $valCode = "";
295         while (strlen($valCode) != $_CONFIG['code_length']) {
296                 // Is the salt set?
297                 if (empty($salt)) {
298                         // Generate random hashed string
299                         $SURFBAR_CACHE['salt'] = sha1(GEN_PASS(255));
300                 } else {
301                         // Use this as salt!
302                         $SURFBAR_CACHE['salt'] = $salt;
303                 }
304                 //* DEBUG: */ echo __FUNCTION__.":".SURFBAR_GET_SALT()."*<br />\n";
305
306                 // ... and now the validation code
307                 $valCode = GEN_RANDOM_CODE($_CONFIG['code_length'], sha1(SURFBAR_GET_SALT().":".$id), $GLOBALS['userid']);
308                 //* DEBUG: */ echo __FUNCTION__.":valCode={$valCode}<br />\n";
309         } // END - while
310
311         // Hash it with md5() and salt it with the random string
312         $hashedCode = generateHash(md5($valCode), SURFBAR_GET_SALT());
313
314         // Finally encrypt it PGP-like and return it
315         return generatePassString($hashedCode);
316 }
317 // Check validation code
318 function SURFBAR_CHECK_VALIDATION_CODE ($id, $check, $salt) {
319         global $SURFBAR_CACHE;
320
321         // Secure id number
322         $id = bigintval($id);
323
324         // Now generate the code again
325         $code = SURFBAR_GENERATE_VALIDATION_CODE($id, $salt);
326
327         // Return result of checking hashes and salts
328         //* DEBUG: */ echo __FUNCTION__.":---".$code."---<br />\n---".$check."---<br />\n";
329         //* DEBUG: */ echo __FUNCTION__.":+++".$salt."+++<br />\n+++".SURFBAR_GET_DATA('last_salt')."+++<br />\n";
330         return (($code == $check) && ($salt == SURFBAR_GET_DATA('last_salt')));
331 }
332 // Lockdown the userid/id combination (reload lock)
333 function SURFBAR_LOCKDOWN_ID ($id) {
334         //* DEBUG: */ print "LOCK!<br />\n";
335         //* DEBUG: */ return;
336         // Just add it to the database
337         SQL_QUERY_ESC("INSERT INTO "._MYSQL_PREFIX."_surfbar_locks (userid, url_id) VALUES(%s, %s)",
338                 array($GLOBALS['userid'], bigintval($id)), __FILE__, __LINE__);
339
340         // Remove the salt from database
341         SQL_QUERY_ESC("DELETE LOW_PRIORITY FROM "._MYSQL_PREFIX."_surfbar_salts WHERE url_id=%s AND userid=%s LIMIT 1",
342                 array(bigintval($id), $GLOBALS['userid']), __FILE__, __LINE__);
343 }
344 // Pay points to the user and remove it from the sender
345 function SURFBAR_PAY_POINTS ($id) {
346         global $SURFBAR_CACHE, $_CONFIG;
347
348         // Re-configure ref-system to surfbar levels
349         $_CONFIG['db_percents'] = "percent";
350         $_CONFIG['db_table']    = "surfbar_reflevels";
351
352         // Book it to the user
353         ADD_POINTS_REFSYSTEM($GLOBALS['userid'], SURFBAR_GET_DATA('reward'));
354
355         // Remove it from the URL owner
356         SUB_POINTS($SURFBAR_CACHE['userid'], SURFBAR_GET_DATA('costs'));
357 }
358 // Update the salt for validation
359 function SURFBAR_UPDATE_SALT() {
360         // Update views_total
361         SQL_QUERY_ESC("UPDATE "._MYSQL_PREFIX."_surfbar_urls SET views_total=views_total+1 WHERE id=%s LIMIT 1",
362                 array(SURFBAR_GET_ID()), __FILE__, __LINE__);
363
364         // Simply store the salt from cache away in database...
365         SQL_QUERY_ESC("UPDATE "._MYSQL_PREFIX."_surfbar_salts SET last_salt='%s' WHERE url_id=%s AND userid=%s LIMIT 1",
366                 array(SURFBAR_GET_SALT(), SURFBAR_GET_ID(), $GLOBALS['userid']), __FILE__, __LINE__);
367
368         // Was that okay?
369         if (SQL_AFFECTEDROWS() == 0) {
370                 // Insert missing entry!
371                 SQL_QUERY_ESC("INSERT INTO "._MYSQL_PREFIX."_surfbar_salts (url_id,userid,last_salt) VALUES(%s, %s, '%s')",
372                         array(SURFBAR_GET_ID(), $GLOBALS['userid'], SURFBAR_GET_SALT()), __FILE__, __LINE__);
373         } // END - if
374
375         // Return if the update was okay
376         return (SQL_AFFECTEDROWS() == 1);
377 }
378 // Check if the reload lock is active for given id
379 function SURFBAR_CHECK_RELOAD_LOCK ($id) {
380         //* DEBUG: */ echo __FUNCTION__.":id={$id}<br />\n";
381         // Ask the database
382         $result = SQL_QUERY_ESC("SELECT COUNT(id) AS cnt
383 FROM "._MYSQL_PREFIX."_surfbar_locks
384 WHERE userid=%s AND url_id=%s AND (UNIX_TIMESTAMP() - ".SURFBAR_GET_DATA('surf_lock').") < UNIX_TIMESTAMP(last_surfed)
385 ORDER BY last_surfed ASC
386 LIMIT 1",
387                 array($GLOBALS['userid'], bigintval($id)), __FILE__, __LINE__
388         );
389
390         // Fetch counter
391         list($cnt) = SQL_FETCHROW($result);
392
393         // Free result
394         SQL_FREERESULT($result);
395
396         // Return check
397         //* DEBUG: */ echo __FUNCTION__.":cnt={$cnt},".SURFBAR_GET_DATA('surf_lock')."<br />\n";
398         return ($cnt == 1);
399 }
400 // Determine next id for surfbar view, always call this before you call other
401 // getters below this function!!!
402 function SURFBAR_GET_NEXT_ID ($id = 0) {
403         global $SURFBAR_CACHE, $_CONFIG;
404
405         // Default is no id!
406         $nextId = 0; $randNum = 0;
407
408         // Is the ID set?
409         if ($id == 0) {
410                 // Set max random factor to total URLs minus 1
411                 $maxRand = SURFBAR_GET_TOTAL_URLS() - 1;
412
413                 // If more than one URL can be called generate the random number!
414                 if ($maxRand > 1) {
415                         // Generate random number
416                         $randNum = mt_rand(0, $maxRand);
417                 } // END - if
418
419                 // Get all id from locks within the timestamp
420                 $result = SQL_QUERY_ESC("SELECT id, url_id, UNIX_TIMESTAMP(last_surfed)
421 FROM
422         "._MYSQL_PREFIX."_surfbar_locks
423 WHERE
424         userid=%s
425 ORDER BY
426         id ASC", array($GLOBALS['userid']),
427                         __FILE__, __LINE__);
428
429                 // Load all entries
430                 $IDs = array(); $USE = array();
431                 $ignored = array();
432                 while (list($id, $url, $last) = SQL_FETCHROW($result)) {
433                         //* DEBUG: */ echo __FUNCTION__.": next - id={$id},url={$url},last={$last}<br />\n";
434                         // Skip entries that are too old
435                         if (($last < (time() - SURFBAR_GET_DATA('surf_lock'))) && (!in_array($url, $ignored))) {
436                                 //* DEBUG: */ echo __FUNCTION__.": okay - id={$id},url={$url},last={$last}<br />\n";
437                                 // Add only if missing or bigger
438                                 if ((!isset($IDs[$url])) || ($IDs[$url] <= $last)) {
439                                         // Add this ID
440                                         //* DEBUG: */ echo __FUNCTION__.": ADD - id={$id},url={$url},last={$last}<br />\n";
441                                         $IDs[$url] = $last;
442                                         $USE[$url] = $id;
443                                 } // END - if
444                         } else {
445                                 // Ignore these old entries!
446                                 //* DEBUG: */ echo __FUNCTION__.": ignore - id={$id},url={$url},last={$last}<br />\n";
447                                 $ignored[] = $url;
448                                 unset($IDs[$url]);
449                                 unset($USE[$url]);
450                         }
451                 } // END - if
452
453                 // Free result
454                 SQL_FREERESULT($result);
455
456                 // And query the database
457                 //* DEBUG: */ echo __FUNCTION__.":randNum={$randNum},maxRand={$maxRand},surfLock=".SURFBAR_GET_DATA('surf_lock')."<br />\n";
458                 $result = SQL_QUERY_ESC("SELECT sbu.id, sbu.userid, sbu.url, sbs.last_salt, sbu.reward, sbu.costs, sbu.views_total, p.time, UNIX_TIMESTAMP(l.last_surfed) AS last_surfed
459 FROM "._MYSQL_PREFIX."_surfbar_urls AS sbu
460 LEFT JOIN "._MYSQL_PREFIX."_payments AS p
461 ON sbu.payment_id=p.id
462 LEFT JOIN "._MYSQL_PREFIX."_surfbar_salts AS sbs
463 ON sbu.id=sbs.url_id
464 LEFT JOIN "._MYSQL_PREFIX."_surfbar_locks AS l
465 ON sbu.id=l.url_id
466 WHERE sbu.userid != %s AND sbu.status='CONFIRMED' AND l.id IN (".implode(",", $USE).")
467 GROUP BY sbu.id
468 ORDER BY l.last_surfed ASC, sbu.id ASC
469 LIMIT %s,1",
470                         array($GLOBALS['userid'], $randNum), __FILE__, __LINE__
471                 );
472                 /*
473                 while($content = SQL_FETCHARRAY($result)) {
474                         echo "<pre>".print_r($content, true)."</pre>";
475                 }
476                 die();
477                 */
478         } else {
479                 // Get data from specified id number
480                 $result = SQL_QUERY_ESC("SELECT sbu.id, sbu.userid, sbu.url, sbs.last_salt, sbu.reward, sbu.costs, sbu.views_total, p.time, UNIX_TIMESTAMP(l.last_surfed) AS last_surfed
481 FROM "._MYSQL_PREFIX."_surfbar_urls AS sbu
482 LEFT JOIN "._MYSQL_PREFIX."_payments AS p
483 ON sbu.payment_id=p.id
484 LEFT JOIN "._MYSQL_PREFIX."_surfbar_salts AS sbs
485 ON sbu.id=sbs.url_id
486 LEFT JOIN "._MYSQL_PREFIX."_surfbar_locks AS l
487 ON sbu.id=l.url_id
488 WHERE sbu.userid != %s AND sbu.status='CONFIRMED' AND sbu.id=%s
489 LIMIT 1",
490                         array($GLOBALS['userid'], bigintval($id)), __FILE__, __LINE__
491                 );
492         }
493
494         // Is there an id number?
495         if (SQL_NUMROWS($result) == 1) {
496                 // Load/cache data
497                 //* DEBUG: */ echo __FUNCTION__.":count(".count($SURFBAR_CACHE).") - BEFORE<br />\n";
498                 $SURFBAR_CACHE = merge_array($SURFBAR_CACHE, SQL_FETCHARRAY($result));
499                 //* DEBUG: */ echo __FUNCTION__.":count(".count($SURFBAR_CACHE).") - AFTER<br />\n";
500
501                 // Is the time there?
502                 if (is_null($SURFBAR_CACHE['time'])) {
503                         // Then repair it wit the static!
504                         //* DEBUG: */ echo __FUNCTION__.": time - STATIC!<br />\n";
505                         $SURFBAR_CACHE['time'] = $_CONFIG['surfbar_static_time'];
506                 } // END - if
507
508                 // Is the last salt there?
509                 if (is_null($SURFBAR_CACHE['last_salt'])) {
510                         // Then repair it wit the static!
511                         //* DEBUG: */ echo __FUNCTION__.": last_salt - FIXED!<br />\n";
512                         $SURFBAR_CACHE['last_salt'] = "";
513                 } // END - if
514
515                 // Fix missing last_surfed
516                 if ((!isset($SURFBAR_CACHE['last_surfed'])) || (is_null($SURFBAR_CACHE['last_surfed']))) {
517                         // Fix it here
518                         //* DEBUG: */ echo __FUNCTION__.": last_surfed - FIXED!<br />\n";
519                         $SURFBAR_CACHE['last_surfed'] = "0";
520                 } // END - if
521
522                 // Are we in static mode?
523                 if ($_CONFIG['surfbar_pay_model'] == "STATIC") {
524                         // Then use static reward/costs!
525                         $SURFBAR_CACHE['reward'] = $_CONFIG['surfbar_static_reward'];
526                         $SURFBAR_CACHE['costs']  = $_CONFIG['surfbar_static_costs'];
527                 } else {
528                         // Calculate dynamic reward/costs and add it
529                         $SURFBAR_CACHE['reward'] += SURFBAR_CALCULATE_DYNAMIC_REWARD_ADD();
530                         $SURFBAR_CACHE['costs']  += SURFBAR_CALCULATE_DYNAMIC_COSTS_ADD();
531                 }
532
533                 // Now get the id
534                 $nextId = SURFBAR_GET_ID();
535         } // END - if
536
537         // Free result
538         SQL_FREERESULT($result);
539
540         // Return result
541         //* DEBUG: */ echo __FUNCTION__.":nextId={$nextId}<br />\n";
542         return $nextId;
543 }
544 // ----------------------------------------------------------------------------
545 // PLEASE DO NOT ADD ANY OTHER FUNCTIONS BELOW THIS LINE ELSE THEY "WRAP" THE
546 // $SURFBAR_CACHE ARRAY!
547 // ----------------------------------------------------------------------------
548 // Private getter for data elements
549 function SURFBAR_GET_DATA ($element) {
550         global $SURFBAR_CACHE;
551
552         // Default is null
553         $data = null;
554
555         // Is the entry there?
556         if (isset($SURFBAR_CACHE[$element])) {
557                 // Then take it
558                 $data = $SURFBAR_CACHE[$element];
559         } else { // END - if
560                 print("<pre>");
561                 print_r($SURFBAR_CACHE);
562                 debug_print_backtrace();
563                 die("</pre>");
564         }
565
566         // Return result
567         return $data;
568 }
569 // Getter for reward from cache
570 function SURFBAR_GET_REWARD () {
571         // Get data element and return its contents
572         return SURFBAR_GET_DATA('reward');
573 }
574 // Getter for costs from cache
575 function SURFBAR_GET_COSTS () {
576         // Get data element and return its contents
577         return SURFBAR_GET_DATA('costs');
578 }
579 // Getter for URL from cache
580 function SURFBAR_GET_URL () {
581         // Get data element and return its contents
582         return SURFBAR_GET_DATA('url');
583 }
584 // Getter for salt from cache
585 function SURFBAR_GET_SALT () {
586         // Get data element and return its contents
587         return SURFBAR_GET_DATA('salt');
588 }
589 // Getter for id from cache
590 function SURFBAR_GET_ID () {
591         // Get data element and return its contents
592         return SURFBAR_GET_DATA('id');
593 }
594 // Getter for user reload locks
595 function SURFBAR_GET_USER_RELOAD_LOCK () {
596         // Get data element and return its contents
597         return SURFBAR_GET_DATA('user_locks');
598 }
599 // Getter for reload time
600 function SURFBAR_GET_RELOAD_TIME () {
601         // Get data element and return its contents
602         return SURFBAR_GET_DATA('time');
603 }
604 //
605 ?>