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  * $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 - 2008 by Roland Haeder                           *
  21  * For more information visit: http://www.mxchange.org                  *
  22  *                                                                      *
  23  * This program is free software; you can redistribute it and/or modify *
  24  * it under the terms of the GNU General Public License as published by *
  25  * the Free Software Foundation; either version 2 of the License, or    *
  26  * (at your option) any later version.                                  *
  27  *                                                                      *
  28  * This program is distributed in the hope that it will be useful,      *
  29  * but WITHOUT ANY WARRANTY; without even the implied warranty of       *
  30  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the        *
  31  * GNU General Public License for more details.                         *
  32  *                                                                      *
  33  * You should have received a copy of the GNU General Public License    *
  34  * along with this program; if not, write to the Free Software          *
  35  * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston,               *
  36  * MA  02110-1301  USA                                                  *
  37  ************************************************************************/
  38
  39 // Some security stuff...
  40 if (!defined('__SECURITY')) {
  41         $INC = substr(dirname(__FILE__), 0, strpos(dirname(__FILE__), '/inc') + 4) . '/security.php';
  42         require($INC);
  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 (!IS_ADMIN()) {
  53                 // Not an admin
  54                 DEBUG_LOG(__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                 DEBUG_LOG(__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                 DEBUG_LOG(__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                 DEBUG_LOG(__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                 DEBUG_LOG(__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                 DEBUG_LOG(__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, $uid) {
  84         // Do some pre-checks
  85         if (!IS_ADMIN()) {
  86                 // Not an admin
  87                 return false;
  88         } elseif (!isUrlValid($url)) {
  89                 // URL invalid
  90                 return false;
  91         } elseif (SURFBAR_LOOKUP_BY_URL($url, $uid)) {
  92                 // URL already found in surfbar!
  93                 return false;
  94         } elseif (!SURFBAR_IF_USER_BOOK_MORE_URLS($uid)) {
  95                 // No more allowed!
  96                 return false;
  97         }
  98
  99         // Register the new URL
 100         return SURFBAR_REGISTER_URL($url, $uid, '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 (!IS_ADMIN()) {
 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 (!IS_ADMIN()) {
 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 (!IS_MEMBER()) {
 166                 // Not a member
 167                 return false;
 168         } elseif ((!isUrlValid($url)) && (!IS_ADMIN())) {
 169                 // URL invalid
 170                 return false;
 171         } elseif (SURFBAR_LOOKUP_BY_URL($url, getUserId())) {
 172                 // URL already found in surfbar!
 173                 return false;
 174         } elseif (!SURFBAR_IF_USER_BOOK_MORE_URLS(getUserId())) {
 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, getUserId(), '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_getModeAction_ARRAY($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 .= sprintf(LOAD_TEMPLATE('member_surfbar_list_form', true),
 202                 $width,
 203                 bigintval($urlId),
 204                 strtolower($action),
 205                 strtoupper($action),
 206                 strtoupper($action)
 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, $URLs) {
 220         // By default no action is performed
 221         $performed = false;
 222
 223         // Is this a member?
 224         if (!IS_MEMBER()) {
 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($URLs[$formData['id']])) {
 231                 // ID not found in cache
 232                 return false;
 233         } elseif (!SURFBAR_VALIDATE_MEMBER_ACTION_STATUS($formData['action'], $URLs[$formData['id']]['status'])) {
 234                 // Action not allowed for current URL status
 235                 return false;
 236         }
 237
 238         // Secure action
 239         $action = SQL_ESCAPE(htmlentities(strip_tags($formData['action']), ENT_QUOTES));
 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                 $URLs[$formData['id']]['new_status'] = $GLOBALS['cache_array']['surfbar']['new_status'];
 254
 255                 // Extract URL data for call-back
 256                 $urlData = array(merge_array($URLs[$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                 DEBUG_LOG(__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['cache_array']['surfbar']['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['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['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['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'] = $urlData['views_max'];
 354
 355         // Return status change
 356         return SURFBAR_CHANGE_STATUS($urlData['id'], $urlData['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['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
 367         $urlData['registered']    = generateDateTime($urlData['registered'], '2');
 368         $urlData['views_total']   = translateComma($urlData['views_total']);
 369         $urlData['views_max']     = translateComma($urlData['views_max']);
 370         $urlData['views_allowed'] = translateComma($urlData['views_allowed']);
 371         $urlData['last_locked']   = generateDateTime($urlData['last_locked'], '2');
 372
 373         // Is the lock reason empty?
 374         if (empty($urlData['lock_reason'])) {
 375                 // Fix it to three dashes
 376                 $urlData['lock_reason'] = '---';
 377         } // END - if
 378
 379         // Include fields only for action 'edit'
 380         if ($action == 'edit') {
 381                 // Default is not limited
 382                 $urlData['limited_yes'] = '';
 383                 $urlData['limited_no']  = ' checked="checked"';
 384                 $urlData['limited']     = 'false';
 385
 386                 // Is this URL limited?
 387                 if ($urlData['views_max'] > 0) {
 388                         // Then rewrite form data
 389                         $urlData['limited_yes'] = ' checked="checked"';
 390                         $urlData['limited_no']  = '';
 391                         $urlData['limited']     = 'true';
 392                 } // END - if
 393         } // END - if
 394
 395         // Load the form and display it
 396         LOAD_TEMPLATE(sprintf("member_surfbar_%s_action_form", $action), false, $urlData);
 397
 398         // All fine by default ... ;-)
 399         return true;
 400 }
 401
 402 // Execute choosen action
 403 function SURFBAR_MEMBER_EXECUTE_ACTION ($action, $urlData) {
 404         // By default nothing is executed
 405         $executed = false;
 406
 407         // Is limitation "no" and "limit" is > 0?
 408         if ((isset($urlData[$action]['limited'])) && ($urlData[$action]['limited'] == 'N') && ((isset($urlData[$action]['limit'])) && ($urlData[$action]['limit'] > 0)) || (!isset($urlData[$action]['limit']))) {
 409                 // Set it to unlimited
 410                 $urlData[$action]['limit'] = 0;
 411         } // END - if
 412
 413         // Construct function name
 414         $functionName = sprintf("SURFBAR_MEMBER_EXECUTE_%s_ACTION", strtoupper($action));
 415
 416         // Is 'userid' set and not 'uid' ?
 417         if ((!isset($urlData['uid'])) && (isset($urlData['userid']))) {
 418                 // Auto-fix this
 419                 $urlData['uid'] = $urlData['userid'];
 420         } // END - if
 421
 422         // Is that function there?
 423         if (function_exists($functionName)) {
 424                 // Execute the function
 425                 if (call_user_func_array($functionName, array($urlData)) == true) {
 426                         // Update status as well
 427                         $executed = SURFBAR_CHANGE_STATUS($urlData['id'], $urlData['status'], $urlData['new_status'], array($urlData['id'] => $urlData));
 428                 } // END - if
 429         } else {
 430                 // Not found!
 431                 addFatalMessage(__FUNCTION__, __LINE__, getMessage('MEMBER_SURFBAR_EXECUTE_ACTION_404'), $functionName);
 432         }
 433
 434         // Return status
 435         return $executed;
 436 }
 437 // "Execute edit" function: Update changed data
 438 function SURFBAR_MEMBER_EXECUTE_EDIT_ACTION ($urlData) {
 439         // Default is nothing done
 440         $status = false;
 441
 442         // Translate URLs for testing
 443         $url1 = COMPILE_CODE($urlData['url']);
 444         $url2 = COMPILE_CODE($urlData['edit']['url']);
 445
 446         // Has the URL or limit changed?
 447         if (true) {
 448                 //if (($urlData['views_allowed'] != $urlData['edit']['limit']) || ($url1 != $url2)) {
 449                 // Run the query
 450                 SQL_QUERY_ESC("UPDATE `{!_MYSQL_PREFIX!}_surfbar_urls` SET url='%s', views_allowed=%s, views_max=%s WHERE `id`=%s AND `status`='%s' LIMIT 1",
 451                 array($urlData['url'], $urlData['edit']['limit'], $urlData['edit']['limit'], $urlData['id'], $urlData['status']), __FUNCTION__, __LINE__);
 452
 453                 // All fine
 454                 $status = true;
 455         }
 456
 457         // Return status
 458         return $status;
 459 }
 460 // "Execute delete" function: Does nothing...
 461 function SURFBAR_MEMBER_EXECUTE_DELETE_ACTION ($urlData) {
 462         // Nothing special to do (see above function for such "special actions" to perform)
 463         return true;
 464 }
 465 //
 466 // -----------------------------------------------------------------------------
 467 //                           Self-maintenance functions
 468 // -----------------------------------------------------------------------------
 469 //
 470 // Main function
 471 function SURFBAR_HANDLE_SELF_MAINTENANCE () {
 472         // Handle URLs which limit has depleted so we can stop them
 473         SURFBAR_HANDLE_DEPLETED_VIEWS();
 474
 475         // Handle low-points amounts
 476         SURFBAR_HANDLE_LOW_POINTS();
 477 }
 478 // Handle URLs which limit has depleted
 479 function SURFBAR_HANDLE_DEPLETED_VIEWS () {
 480         // Get all URLs
 481         $urlArray = SURFBAR_GET_URL_DATA('0', 'views_max', 'id', 'ASC', 'id', " AND views_allowed>0 AND `status`='ACTIVE'");
 482
 483         // Do we have some entries?
 484         if (count($urlArray) > 0) {
 485                 // Then handle all!
 486                 foreach ($urlArray as $id => $urlData) {
 487                         // Backup data
 488                         $data = $urlData;
 489
 490                         // Rewrite array for next call
 491                         $urlData[$id] = $data;
 492
 493                         // Handle the status
 494                         SURFBAR_CHANGE_STATUS($id, 'ACTIVE', 'DEPLETED', $urlData);
 495                 } // END - foreach
 496         } // END - if
 497 }
 498
 499 // Alert users which have URLs booked and are low on points amount
 500 function SURFBAR_HANDLE_LOW_POINTS () {
 501         // Get all userids
 502         $UIDs = SURFBAR_DETERMINE_DEPLETED_USERIDS(getConfig('surfbar_warn_low_points'));
 503
 504         // "Walk" through all URLs
 505         foreach ($UIDs['uid'] as $uid => $dummy) {
 506                 // Is the last notification far enougth away to notify again?
 507                 if ((time() - $UIDs['notified'][$uid]) >= getConfig('surfbar_low_interval')) {
 508                         // Prepare content
 509                         $content = array(
 510                                 'uid'      => $uid,
 511                                 'low'      => translateComma(getConfig('surfbar_warn_low_points')),
 512                                 'points'   => translateComma($UIDs['points'][$uid]),
 513                                 'notified' => generateDateTime($UIDs['notified'][$uid]),
 514                                 'interval' => createFancyTime(getConfig('surfbar_low_interval'))
 515                         );
 516
 517                         // Notify this user
 518                         SURFBAR_NOTIFY_USER('low_points', $content);
 519
 520                         // Update last notified
 521                         SQL_QUERY_ESC("UPDATE `{!_MYSQL_PREFIX!}_user_data` SET surfbar_low_notified=NOW() WHERE userid=%s LIMIT 1",
 522                         array($uid), __FUNCTION__, __LINE__);
 523                 } // END - if
 524         } // END - foreach
 525 }
 526
 527 //
 528 // -----------------------------------------------------------------------------
 529 //                               Generic functions
 530 // -----------------------------------------------------------------------------
 531 //
 532
 533 // Looks up by an URL
 534 function SURFBAR_LOOKUP_BY_URL ($url, $uid) {
 535         // Now lookup that given URL by itself
 536         $urlArray = SURFBAR_GET_URL_DATA($url, 'url', 'id', 'ASC', 'id', sprintf(" AND `userid`=%s", bigintval($uid)));
 537
 538         // Was it found?
 539         return (count($urlArray) > 0);
 540 }
 541
 542 // Load URL data by given search term and column
 543 function SURFBAR_GET_URL_DATA ($searchTerm, $column='id', $order='id', $sort="ASC", $group='id', $add = '') {
 544         // By default nothing is found
 545         $GLOBALS['last_url_data'] = array();
 546
 547         // Is the column an id number?
 548         if (($column == 'id') || ($column == 'userid')) {
 549                 // Extra secure input
 550                 $searchTerm = bigintval($searchTerm);
 551         } // END - if
 552
 553         // If the column is 'id' there can be only one entry
 554         $limit = '';
 555         if ($column == 'id') {
 556                 $limit = "LIMIT 1";
 557         } // END - if
 558
 559         // Look up the record
 560         $result = SQL_QUERY_ESC("SELECT id, userid, url, views_total, views_max, views_allowed, status, registered, last_locked, lock_reason, views_max, views_allowed, fixed_reload
 561 FROM `{!_MYSQL_PREFIX!}_surfbar_urls`
 562 WHERE %s='%s'".$add."
 563 ORDER BY %s %s
 564 %s",
 565         array($column, $searchTerm, $order, $sort, $limit), __FUNCTION__, __LINE__);
 566
 567         // Is there at least one record?
 568         if (SQL_NUMROWS($result) > 0) {
 569                 // Then load all!
 570                 while ($dataRow = SQL_FETCHARRAY($result)) {
 571                         // Shall we group these results?
 572                         if ($group == 'id') {
 573                                 // Add the row by id as index
 574                                 $GLOBALS['last_url_data'][$dataRow['id']] = $dataRow;
 575                         } else {
 576                                 // Group entries
 577                                 $GLOBALS['last_url_data'][$dataRow[$group]][$dataRow['id']] = $dataRow;
 578                         }
 579                 } // END - while
 580         } // END - if
 581
 582         // Free the result
 583         SQL_FREERESULT($result);
 584
 585         // Return the result
 586         return $GLOBALS['last_url_data'];
 587 }
 588
 589 // Registers an URL with the surfbar. You should have called SURFBAR_LOOKUP_BY_URL() first!
 590 function SURFBAR_REGISTER_URL ($url, $uid, $status = 'PENDING', $addMode = 'reg', $extraFields = array()) {
 591         // Make sure by the user registered URLs are always pending
 592         if ($addMode == 'reg') {
 593                 $status = 'PENDING';
 594         } // END - if
 595
 596         // Prepare content
 597         $content = merge_array($extraFields, array(
 598                 'url'         => $url,
 599                 'frametester' => FRAMETESTER($url),
 600                 'uid'         => $uid,
 601                 'status'      => $status,
 602         ));
 603
 604         // Is limit/reload set?
 605         if (!isset($config['limit'])) {
 606                 $content['limit']  = 0;
 607         } // END - if
 608         if (!isset($config['reload'])) {
 609                 $content['reload'] = 0;
 610         } // END - if
 611
 612         // Insert the URL into database
 613         $content['insert_id'] = SURFBAR_INSERT_URL_BY_ARRAY($content);
 614
 615         // Is this ID valid?
 616         if ($content['insert_id'] == 0) {
 617                 // INSERT did not insert any data!
 618                 return false;
 619         } // END - if
 620
 621         // Translate status and limit
 622         $content['limit'] = surfbarTranslateLimit($content['limit']);
 623
 624         // If in reg-mode we notify admin
 625         if (($addMode == 'reg') || (getConfig('surfbar_notify_admin_unlock') == 'Y')) {
 626                 // Notify admin even when he as unlocked an email
 627                 SURFBAR_NOTIFY_ADMIN("url_{$addMode}", $content);
 628         } // END - if
 629
 630         // Send mail to user
 631         SURFBAR_NOTIFY_USER("url_{$addMode}", $content);
 632
 633         // Return the insert id
 634         return $content['insert_id'];
 635 }
 636
 637 // Inserts an url by given data array and return the insert id
 638 function SURFBAR_INSERT_URL_BY_ARRAY ($urlData) {
 639         // Get userid
 640         $uid = bigintval($urlData['uid']);
 641
 642         // Is the id set?
 643         if (empty($uid)) $uid = 0;
 644
 645         // Just run the insert query for now
 646         SQL_QUERY_ESC("INSERT INTO `{!_MYSQL_PREFIX!}_surfbar_urls` (userid,url,status,views_max,views_allowed,fixed_reload) VALUES (%s,'%s','%s',%s,%s,%s)",
 647         array(
 648         $uid,
 649         $urlData['url'],
 650         $urlData['status'],
 651         $urlData['limit'],
 652         $urlData['limit'],
 653         $urlData['reload']
 654         ), __FUNCTION__, __LINE__
 655         );
 656
 657         // Return insert id
 658         return SQL_INSERTID();
 659 }
 660
 661 // Notify admin(s) with a selected message and content
 662 function SURFBAR_NOTIFY_ADMIN ($messageType, $content) {
 663         // Prepare template name
 664         $templateName = sprintf("admin_surfbar_%s", $messageType);
 665
 666         // Prepare subject
 667         $subject = getMessage(sprintf("ADMIN_SURFBAR_NOTIFY_%s_SUBJECT",
 668         strtoupper($messageType)
 669         ));
 670
 671         // Is the subject line there?
 672         if ((substr($subject, 0, 1) == '!') && (substr($subject, -1, 1) == '!')) {
 673                 // Set default subject if following eval() wents wrong
 674                 $subject = getMessage('ADMIN_SURFBAR_NOTIFY_DEFAULT_SUBJECT');
 675         } // END - if
 676
 677         // Translate some data if present
 678         if (isset($content['status']))        $content['status']        = surfbarTranslateUserStatus($content['status']);
 679         if (isset($content['registered']))    $content['registered']    = generateDateTime($content['registered'], '2');
 680         if (isset($content['last_locked']))   $content['last_locked']   = generateDateTime($content['last_locked'], '2');
 681         if (isset($content['views_total']))   $content['views_total']   = translateComma($content['views_total']);
 682         if (isset($content['views_allowed'])) $content['views_allowed'] = translateComma($content['views_allowed']);
 683         if (isset($content['views_max']))     $content['views_max']     = translateComma($content['views_max']);
 684
 685         // Send the notification out
 686         return sendAdminNotification($subject, $templateName, $content, $content['uid']);
 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['uid'] == 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         if (isset($content['status']))        $content['status']        = surfbarTranslateUserStatus($content['status']);
 712         if (isset($content['registered']))    $content['registered']    = generateDateTime($content['registered'], '2');
 713         if (isset($content['last_locked']))   $content['last_locked']   = generateDateTime($content['last_locked'], '2');
 714         if (isset($content['views_total']))   $content['views_total']   = translateComma($content['views_total']);
 715         if (isset($content['views_allowed'])) $content['views_allowed'] = translateComma($content['views_allowed']);
 716         if (isset($content['views_max']))     $content['views_max']     = translateComma($content['views_max']);
 717
 718         // Load template
 719         $mailText = LOAD_EMAIL_TEMPLATE($templateName, $content, $content['uid']);
 720
 721         // Send the email
 722         return sendEmail($content['uid'], $subject, $mailText);
 723 }
 724
 725 // Translates the limit
 726 function surfbarTranslateLimit ($limit) {
 727         // Is this zero?
 728         if ($limit == 0) {
 729                 // Unlimited!
 730                 $return = getMessage('MEMBER_SURFBAR_UNLIMITED_VIEWS');
 731         } else {
 732                 // Translate comma
 733                 $return = translateComma($limit);
 734         }
 735
 736         // Return value
 737         return $return;
 738 }
 739
 740 // Translate the URL status
 741 function surfbarTranslateUserStatus ($status) {
 742         // Create constant name
 743         $constantName = sprintf("SURFBAR_URL_STATUS_%s", strtoupper($status));
 744
 745         // Set default translated status
 746         $statusTranslated = '!'.$constantName.'!';
 747
 748         // Is the constant there?
 749         if (defined($constantName)) {
 750                 // Then get it's value
 751                 $statusTranslated = constant($constantName);
 752         } // END - if
 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 (REQUEST_ISSET_GET('frame')) {
 813                 // Use the frame as a template name part... ;-)
 814                 $templateName = sprintf("surfbar_frame_%s",
 815                 REQUEST_GET('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['cache_array']['surfbar']['surf_lock'] = getConfig('surfbar_static_lock');
 831         //* DEBUG: */ DEBUG_LOG(__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['cache_array']['surfbar']['surf_lock'] += SURFBAR_CALCULATE_DYNAMIC_ADD();
 837         } // END - if
 838
 839         // Ask the database
 840         $result = SQL_QUERY_ESC("SELECT COUNT(l.id) AS cnt FROM `{!_MYSQL_PREFIX!}_surfbar_locks` AS l
 841 INNER JOIN `{!_MYSQL_PREFIX!}_surfbar_urls` AS u
 842 ON u.id=l.url_id
 843 WHERE l.userid=%s AND (UNIX_TIMESTAMP() - ".SURFBAR_GET_SURF_LOCK().") < UNIX_TIMESTAMP(l.last_surfed) AND (((UNIX_TIMESTAMP(l.last_surfed) - u.fixed_reload) < 0 AND u.fixed_reload > 0) OR u.fixed_reload = 0)
 844 LIMIT 1",
 845         array(getUserId()), __FUNCTION__, __LINE__
 846         );
 847
 848         // Fetch row
 849         list($GLOBALS['cache_array']['surfbar']['user_locks']) = SQL_FETCHROW($result);
 850
 851         // Is it null?
 852         if (is_null($GLOBALS['cache_array']['surfbar']['user_locks'])) {
 853                 // Then fix it to zero!
 854                 $GLOBALS['cache_array']['surfbar']['user_locks'] = 0;
 855         } // END - if
 856
 857         // Free result
 858         SQL_FREERESULT($result);
 859
 860         // Get total URLs
 861         $total = SURFBAR_GET_TOTAL_URLS();
 862
 863         // Do we have some URLs in lock? Admins can always surf on own URLs!
 864         //* DEBUG: */ DEBUG_LOG(__FUNCTION__, __LINE__, "userLocks=".SURFBAR_GET_USER_LOCKS().",total={$total}", false);
 865         $isFull = ((SURFBAR_GET_USER_LOCKS() == $total) && ($total > 0));
 866
 867         // Return result
 868         return $isFull;
 869 }
 870
 871 // Get total amount of URLs of given status for current user or of ACTIVE URLs by default
 872 function SURFBAR_GET_TOTAL_URLS ($status = 'ACTIVE', $excludeUserId = 0) {
 873         // Determine depleted user account
 874         $UIDs = SURFBAR_DETERMINE_DEPLETED_USERIDS();
 875
 876         // Is the exlude userid set?
 877         if ($excludeUserId > 0) {
 878                 // Then add it
 879                 $UIDs['uid'][$excludeUserId] = $excludeUserId;
 880         } // END - if
 881
 882         // Get amount from database
 883         $result = SQL_QUERY_ESC("SELECT COUNT(id) AS cnt
 884 FROM `{!_MYSQL_PREFIX!}_surfbar_urls`
 885 WHERE userid NOT IN (".implode(',', $UIDs['uid']).") AND `status`='%s'",
 886         array($status), __FUNCTION__, __LINE__
 887         );
 888
 889         // Fetch row
 890         list($cnt) = SQL_FETCHROW($result);
 891
 892         // Free result
 893         SQL_FREERESULT($result);
 894
 895         // Return result
 896         return $cnt;
 897 }
 898
 899 // Check wether the user is allowed to book more URLs
 900 function SURFBAR_IF_USER_BOOK_MORE_URLS ($uid=0) {
 901         // Is this admin and userid is zero or does the user has some URLs left to book?
 902         return ((($uid == 0) && (IS_ADMIN())) || (SURFBAR_GET_TOTAL_USER_URLS($uid, '', array("REJECTED")) < getConfig('surfbar_max_order')));
 903 }
 904
 905 // Get total amount of URLs of given status for current user
 906 function SURFBAR_GET_TOTAL_USER_URLS ($uid=0, $status = '',$exclude = '') {
 907         // Is the user 0 and user is logged in?
 908         if (($uid == 0) && (IS_MEMBER())) {
 909                 // Then use this userid
 910                 $uid = getUserId();
 911         } elseif ($uid == 0) {
 912                 // Error!
 913                 return (getConfig('surfbar_max_order') + 1);
 914         }
 915
 916         // Default is all URLs
 917         $add = '';
 918
 919         // Is the status set?
 920         if (is_array($status)) {
 921                 // Only URLs with these status
 922                 $add = sprintf(" AND status IN('%s')", implode("','", $status));
 923         } elseif (!empty($status)) {
 924                 // Only URLs with this status
 925                 $add = sprintf(" AND `status`='%s'", $status);
 926         } elseif (is_array($exclude)) {
 927                 // Exclude URLs with these status
 928                 $add = sprintf(" AND status NOT IN('%s')", implode("','", $exclude));
 929         } elseif (!empty($exclude)) {
 930                 // Exclude URLs with this status
 931                 $add = sprintf(" AND status != '%s'", $exclude);
 932         }
 933
 934         // Get amount from database
 935         $result = SQL_QUERY_ESC("SELECT COUNT(id) AS cnt
 936 FROM `{!_MYSQL_PREFIX!}_surfbar_urls`
 937 WHERE userid=%s".$add."
 938 LIMIT %s",
 939         array($uid, getConfig('surfbar_max_order')), __FUNCTION__, __LINE__
 940         );
 941
 942         // Fetch row
 943         list($cnt) = SQL_FETCHROW($result);
 944
 945         // Free result
 946         SQL_FREERESULT($result);
 947
 948         // Return result
 949         return $cnt;
 950 }
 951
 952 // Generate a validation code for the given id number
 953 function SURFBAR_GENERATE_VALIDATION_CODE ($urlId, $salt = '') {
 954         // @TODO Invalid salt should be refused
 955         $GLOBALS['cache_array']['surfbar']['salt'] = "INVALID";
 956
 957         // Get code length from config
 958         $length = getConfig('code_length');
 959
 960         // Fix length to 10
 961         if ($length == 0) $length = 10;
 962
 963         // Generate a code until the length matches
 964         $valCode = '';
 965         while (strlen($valCode) != $length) {
 966                 // Is the salt set?
 967                 if (empty($salt)) {
 968                         // Generate random hashed string
 969                         $GLOBALS['cache_array']['surfbar']['salt'] = sha1(generatePassword(255));
 970                         //* DEBUG: */ DEBUG_LOG(__FUNCTION__, __LINE__, "newSalt=".SURFBAR_GET_SALT()."", false);
 971                 } else {
 972                         // Use this as salt!
 973                         $GLOBALS['cache_array']['surfbar']['salt'] = $salt;
 974                         //* DEBUG: */ DEBUG_LOG(__FUNCTION__, __LINE__, "oldSalt=".SURFBAR_GET_SALT()."", false);
 975                 }
 976
 977                 // ... and now the validation code
 978                 $valCode = generateRandomCode($length, sha1(SURFBAR_GET_SALT().':'.$urlId), getUserId());
 979                 //* DEBUG: */ DEBUG_LOG(__FUNCTION__, __LINE__, "valCode={$valCode}", false);
 980         } // END - while
 981
 982         // Hash it with md5() and salt it with the random string
 983         $hashedCode = generateHash(md5($valCode), SURFBAR_GET_SALT());
 984
 985         // Finally encrypt it PGP-like and return it
 986         $valHashedCode = generatePassString($hashedCode);
 987
 988         // Return hashed value
 989         //* DEBUG: */ DEBUG_LOG(__FUNCTION__, __LINE__, "finalValCode={$valHashedCode}", false);
 990         return $valHashedCode;
 991 }
 992
 993 // Check validation code
 994 function SURFBAR_CHECK_VALIDATION_CODE ($urlId, $check, $salt) {
 995         // Secure id number
 996         $urlId = bigintval($urlId);
 997
 998         // Now generate the code again
 999         $code = SURFBAR_GENERATE_VALIDATION_CODE($urlId, $salt);
1000
1001         // Return result of checking hashes and salts
1002         //* DEBUG: */ DEBUG_LOG(__FUNCTION__, __LINE__, '---'.$code."|".$check.'---', false);
1003         //* DEBUG: */ DEBUG_LOG(__FUNCTION__, __LINE__, "+++".$salt."|".SURFBAR_GET_DATA('last_salt')."+++", false);
1004         return (($code == $check) && ($salt == SURFBAR_GET_DATA('last_salt')));
1005 }
1006
1007 // Lockdown the userid/id combination (reload lock)
1008 function SURFBAR_LOCKDOWN_ID ($urlId) {
1009         //* DEBUG: */ print "LOCK!");
1010         ///* DEBUG: */ return;
1011         // Just add it to the database
1012         SQL_QUERY_ESC("INSERT INTO `{!_MYSQL_PREFIX!}_surfbar_locks` (userid, url_id) VALUES (%s, %s)",
1013         array(getUserId(), bigintval($urlId)), __FUNCTION__, __LINE__);
1014
1015         // Remove the salt from database
1016         SQL_QUERY_ESC("DELETE LOW_PRIORITY FROM `{!_MYSQL_PREFIX!}_surfbar_salts` WHERE url_id=%s AND `userid`=%s LIMIT 1",
1017         array(bigintval($urlId), getUserId()), __FUNCTION__, __LINE__);
1018 }
1019
1020 // Pay points to the user and remove it from the sender if userid is given else it is a "sponsored surf"
1021 function SURFBAR_PAY_POINTS () {
1022         // Remove it from the URL owner
1023         //* DEBUG: */ DEBUG_LOG(__FUNCTION__, __LINE__, "uid=".SURFBAR_GET_USERID().",costs=".SURFBAR_GET_COSTS()."", false);
1024         if (SURFBAR_GET_USERID() > 0) {
1025                 SUB_POINTS(sprintf("surfbar_%s", getConfig('surfbar_pay_model')), SURFBAR_GET_USERID(), SURFBAR_GET_COSTS());
1026         } // END - if
1027
1028         // Book it to the user
1029         //* DEBUG: */ DEBUG_LOG(__FUNCTION__, __LINE__, "uid=".getUserId().",reward=".SURFBAR_GET_REWARD()."", false);
1030         ADD_POINTS_REFSYSTEM(sprintf("surfbar_%s", getConfig('surfbar_pay_model')), getUserId(), SURFBAR_GET_DATA('reward'));
1031 }
1032
1033 // Updates the statistics of current URL/userid
1034 function SURFBAR_UPDATE_INSERT_STATS_RECORD () {
1035         // Init add
1036         $add = '';
1037
1038         // Get allowed views
1039         $allowed = SURFBAR_GET_VIEWS_ALLOWED();
1040
1041         // Do we have a limit?
1042         if ($allowed > 0) {
1043                 // Then count views_max down!
1044                 $add .= ",views_max=views_max-1";
1045         } // END - if
1046
1047         // Update URL stats
1048         SQL_QUERY_ESC("UPDATE `{!_MYSQL_PREFIX!}_surfbar_urls` SET views_total=views_total+1".$add." WHERE `id`=%s LIMIT 1",
1049         array(SURFBAR_GET_ID()), __FUNCTION__, __LINE__);
1050
1051         // Update the stats entry
1052         SQL_QUERY_ESC("UPDATE `{!_MYSQL_PREFIX!}_surfbar_stats` SET count=count+1 WHERE userid=%s AND url_id=%s LIMIT 1",
1053         array(getUserId(), SURFBAR_GET_ID()), __FUNCTION__, __LINE__);
1054
1055         // Was that update okay?
1056         if (SQL_AFFECTEDROWS() < 1) {
1057                 // No, then insert entry
1058                 SQL_QUERY_ESC("INSERT INTO `{!_MYSQL_PREFIX!}_surfbar_stats` (userid,url_id,count) VALUES (%s,%s,1)",
1059                 array(getUserId(), SURFBAR_GET_ID()), __FUNCTION__, __LINE__);
1060         } // END - if
1061
1062         // Update total/daily/weekly/monthly counter
1063         incrementConfigEntry('surfbar_total_counter');
1064         incrementConfigEntry('surfbar_daily_counter');
1065         incrementConfigEntry('surfbar_weekly_counter');
1066         incrementConfigEntry('surfbar_monthly_counter');
1067
1068         // Update config as well
1069         updateConfiguration(array('surfbar_total_counter', 'surfbar_daily_counter', 'surfbar_weekly_counter', 'surfbar_monthly_counter'), array(1,1,1,1), '+');
1070 }
1071
1072 // Update the salt for validation and statistics
1073 function SURFBAR_UPDATE_SALT_STATS () {
1074         // Update statistics record
1075         SURFBAR_UPDATE_INSERT_STATS_RECORD();
1076
1077         // Simply store the salt from cache away in database...
1078         SQL_QUERY_ESC("UPDATE `{!_MYSQL_PREFIX!}_surfbar_salts` SET last_salt='%s' WHERE url_id=%s AND `userid`=%s LIMIT 1",
1079         array(SURFBAR_GET_SALT(), SURFBAR_GET_ID(), getUserId()), __FUNCTION__, __LINE__);
1080
1081         // Debug message
1082         //* DEBUG: */ DEBUG_LOG(__FUNCTION__, __LINE__, "salt=".SURFBAR_GET_SALT().",id=".SURFBAR_GET_ID().",uid=".getUserId()."", false);
1083
1084         // Was that okay?
1085         if (SQL_AFFECTEDROWS() < 1) {
1086                 // Insert missing entry!
1087                 SQL_QUERY_ESC("INSERT INTO `{!_MYSQL_PREFIX!}_surfbar_salts` (url_id,userid,last_salt) VALUES (%s, %s, '%s')",
1088                 array(SURFBAR_GET_ID(), getUserId(), SURFBAR_GET_SALT()), __FUNCTION__, __LINE__);
1089         } // END - if
1090
1091         // Debug message
1092         //* DEBUG: */ DEBUG_LOG(__FUNCTION__, __LINE__, "affectedRows=".SQL_AFFECTEDROWS()."", false);
1093
1094         // Return if the update was okay
1095         return (SQL_AFFECTEDROWS() == 1);
1096 }
1097
1098 // Check if the reload lock is active for given id
1099 function SURFBAR_CHECK_RELOAD_LOCK ($urlId) {
1100         //* DEBUG: */ DEBUG_LOG(__FUNCTION__, __LINE__, "id={$urlId}", false);
1101         // Ask the database
1102         $result = SQL_QUERY_ESC("SELECT COUNT(id) AS cnt
1103 FROM `{!_MYSQL_PREFIX!}_surfbar_locks`
1104 WHERE userid=%s AND url_id=%s AND (UNIX_TIMESTAMP() - ".SURFBAR_GET_SURF_LOCK().") < UNIX_TIMESTAMP(last_surfed)
1105 ORDER BY last_surfed ASC
1106 LIMIT 1",
1107         array(getUserId(), bigintval($urlId)), __FUNCTION__, __LINE__
1108         );
1109
1110         // Fetch counter
1111         list($cnt) = SQL_FETCHROW($result);
1112
1113         // Free result
1114         SQL_FREERESULT($result);
1115
1116         // Return check
1117         //* DEBUG: */ DEBUG_LOG(__FUNCTION__, __LINE__, "cnt={$cnt},".SURFBAR_GET_SURF_LOCK()."", false);
1118         return ($cnt == 1);
1119 }
1120
1121 // Determine which user hash no more points left
1122 function SURFBAR_DETERMINE_DEPLETED_USERIDS ($limit=0) {
1123         // Init array
1124         $UIDs = array(
1125                 'uid'      => array(),
1126                 'points'   => array(),
1127                 'notified' => array(),
1128         );
1129
1130         // Do we have a current user id?
1131         if ((IS_MEMBER()) && ($limit == 0)) {
1132                 // Then add this as well
1133                 $UIDs['uid'][getUserId()]      = getUserId();
1134                 $UIDs['points'][getUserId()]   = GET_TOTAL_DATA(getUserId(), "user_points", "points") - GET_TOTAL_DATA(getUserId(), "user_data", "used_points");
1135                 $UIDs['notified'][getUserId()] = 0;
1136
1137                 // Get all userid except logged in one
1138                 $result = SQL_QUERY_ESC("SELECT u.userid, UNIX_TIMESTAMP(d.surfbar_low_notified) AS notified
1139 FROM `{!_MYSQL_PREFIX!}_surfbar_urls` AS u
1140 INNER JOIN `{!_MYSQL_PREFIX!}_user_data` AS d
1141 ON u.userid=d.userid
1142 WHERE u.userid NOT IN (%s,0) AND u.`status`='ACTIVE'
1143 GROUP BY u.userid
1144 ORDER BY u.userid ASC",
1145                 array(getUserId()), __FUNCTION__, __LINE__);
1146         } else {
1147                 // Get all userid
1148                 $result = SQL_QUERY("SELECT u.userid, UNIX_TIMESTAMP(d.surfbar_low_notified) AS notified
1149 FROM `{!_MYSQL_PREFIX!}_surfbar_urls` AS u
1150 INNER JOIN `{!_MYSQL_PREFIX!}_user_data` AS d
1151 ON u.userid=d.userid
1152 WHERE u.`status`='ACTIVE'
1153 GROUP BY u.userid
1154 ORDER BY u.userid ASC", __FUNCTION__, __LINE__);
1155         }
1156
1157         // Load all userid
1158         while ($content = SQL_FETCHARRAY($result)) {
1159                 // Get total points
1160                 $points = GET_TOTAL_DATA($content['userid'], "user_points", "points") - GET_TOTAL_DATA($content['userid'], "user_data", "used_points");
1161                 //* DEBUG: */ DEBUG_LOG(__FUNCTION__, __LINE__, "uid={$content['userid']},points={$points}", false);
1162
1163                 // Shall we add this to ignore?
1164                 if ($points <= $limit) {
1165                         // Ignore this one!
1166                         //* DEBUG: */ DEBUG_LOG(__FUNCTION__, __LINE__, "uid={$content['userid']} has depleted points amount!", false);
1167                         $UIDs['uid'][$content['userid']]      = $content['userid'];
1168                         $UIDs['points'][$content['userid']]   = $points;
1169                         $UIDs['notified'][$content['userid']] = $content['notified'];
1170                 } // END - if
1171         } // END - while
1172
1173         // Free result
1174         SQL_FREERESULT($result);
1175
1176         // Debug message
1177         //* DEBUG: */ DEBUG_LOG(__FUNCTION__, __LINE__, "UIDs::count=".count($UIDs)." (with own userid=".getUserId().')', false);
1178
1179         // Return result
1180         return $UIDs;
1181 }
1182
1183 // Determine how many users are Online in surfbar
1184 function SURFBAR_DETERMINE_TOTAL_ONLINE () {
1185         // Count all users in surfbar modue and return the value
1186         $result = SQL_QUERY_ESC("SELECT id
1187 FROM `{!_MYSQL_PREFIX!}_surfbar_stats`
1188 WHERE (UNIX_TIMESTAMP() - UNIX_TIMESTAMP(last_online)) <= %s
1189 GROUP BY userid",
1190         array(getConfig('online_timeout')), __FUNCTION__, __LINE__);
1191
1192         // Fetch count
1193         $cnt = SQL_NUMROWS($result);
1194
1195         // Free result
1196         SQL_FREERESULT($result);
1197
1198         // Return result
1199         return $cnt;
1200 }
1201
1202 // Determine waiting time for one URL
1203 function SURFBAR_DETERMINE_WAIT_TIME () {
1204         // Get fixed reload lock
1205         $fixed = SURFBAR_GET_FIXED_RELOAD();
1206
1207         // Is the fixed reload time set?
1208         if ($fixed > 0) {
1209                 // Return it
1210                 return $fixed;
1211         } // END - if
1212
1213         // Static time is default
1214         $time = getConfig('surfbar_static_time');
1215
1216         // Which payment model do we have?
1217         if (getConfig('surfbar_pay_model') == 'DYNAMIC') {
1218                 // "Calculate" dynamic time
1219                 $time += SURFBAR_CALCULATE_DYNAMIC_ADD();
1220         } // END - if
1221
1222         // Return value
1223         return $time;
1224 }
1225
1226 // Changes the status of an URL from given to other
1227 function SURFBAR_CHANGE_STATUS ($urlId, $prevStatus, $newStatus, $data=array()) {
1228         // Make new status always lower-case
1229         $newStatus = strtolower($newStatus);
1230
1231         // Get URL data for status comparison if missing
1232         if ((!is_array($data)) || (count($data) == 0)) {
1233                 // Fetch missing URL data
1234                 $data = SURFBAR_GET_URL_DATA($urlId);
1235         } // END - if
1236
1237         // Is the new status set?
1238         if ((!is_string($newStatus)) || (empty($newStatus))) {
1239                 // Abort here, but fine!
1240                 return true;
1241         } // END - if
1242
1243         // Is the status like prevStatus is saying?
1244         if ($data[$urlId]['status'] != $prevStatus) {
1245                 // No, then abort here
1246                 return false;
1247         } // END - if
1248
1249
1250         // Update the status now
1251         // ---------- Comment out for debugging/developing member actions! ---------
1252         //SQL_QUERY_ESC("UPDATE `{!_MYSQL_PREFIX!}_surfbar_urls` SET `status`='%s' WHERE `id`=%s LIMIT 1",
1253         //      array($newStatus, bigintval($urlId)), __FUNCTION__, __LINE__);
1254         // ---------- Comment out for debugging/developing member actions! ---------
1255
1256         // Was that fine?
1257         // ---------- Comment out for debugging/developing member actions! ---------
1258         //if (SQL_AFFECTEDROWS() != 1) {
1259         //      // No, something went wrong
1260         //      return false;
1261         //} // END - if
1262         // ---------- Comment out for debugging/developing member actions! ---------
1263
1264         // Prepare content for notification routines
1265         $data[$urlId]['uid']         = $data[$urlId]['userid'];
1266         $data[$urlId]['frametester'] = FRAMETESTER($data[$urlId]['url']);
1267         $data[$urlId]['reward']      = translateComma(getConfig('surfbar_static_reward'));
1268         $data[$urlId]['costs']       = translateComma(getConfig('surfbar_static_costs'));
1269
1270         // Do some dirty fixing here:
1271         if (($data[$urlId]['status'] == 'STOPPED') && ($newStatus == 'pending')) {
1272                 // Fix for template change
1273                 $newStatus = 'continued';
1274         } // END - if
1275
1276         // Send admin notification
1277         SURFBAR_NOTIFY_ADMIN("url_{$data[$urlId]['status']}_{$newStatus}", $data[$urlId]);
1278
1279         // Send user notification
1280         SURFBAR_NOTIFY_USER("url_{$data[$urlId]['status']}_{$newStatus}", $data[$urlId]);
1281
1282         // All done!
1283         return true;
1284 }
1285
1286 // Calculate minimum value for dynamic payment model
1287 function SURFBAR_CALCULATE_DYNAMIC_MIN_VALUE () {
1288         // Addon is zero by default
1289         $addon = 0;
1290
1291         // Percentage part
1292         $percent = abs(log(getConfig('surfbar_dynamic_percent') / 100 + 1));
1293
1294         // Get total users
1295         $totalUsers = GET_TOTAL_DATA('CONFIRMED', 'user_data', 'userid', 'status', true);
1296
1297         // Get online users
1298         $onlineUsers = SURFBAR_DETERMINE_TOTAL_ONLINE();
1299
1300         // Calculate addon
1301         $addon += abs(log($onlineUsers / $totalUsers + 1) * $percent * $totalUsers);
1302
1303         // Get total URLs
1304         $totalUrls = SURFBAR_GET_TOTAL_URLS('ACTIVE', '0');
1305
1306         // Get user's total URLs
1307         $userUrls = SURFBAR_GET_TOTAL_USER_URLS(0, 'ACTIVE');
1308
1309         // Calculate addon
1310         if ($totalUrls > 0) {
1311                 $addon += abs(log($userUrls / $totalUrls + 1) * $percent * $totalUrls);
1312         } else {
1313                 $addon += abs(log($userUrls / 1 + 1) * $percent * $totalUrls);
1314         }
1315
1316         // Return addon
1317         return $addon;
1318 }
1319
1320 // Calculate maximum value for dynamic payment model
1321 function SURFBAR_CALCULATE_DYNAMIC_MAX_VALUE () {
1322         // Addon is zero by default
1323         $addon = 0;
1324
1325         // Maximum value
1326         $max = log(2);
1327
1328         // Percentage part
1329         $percent = abs(log(getConfig('surfbar_dynamic_percent') / 100 + 1));
1330
1331         // Get total users
1332         $totalUsers = GET_TOTAL_DATA('CONFIRMED', 'user_data', 'userid', 'status', true);
1333
1334         // Calculate addon
1335         $addon += abs($max * $percent * $totalUsers);
1336
1337         // Get total URLs
1338         $totalUrls = SURFBAR_GET_TOTAL_URLS('ACTIVE', '0');
1339
1340         // Calculate addon
1341         $addon += abs($max * $percent * $totalUrls);
1342
1343         // Return addon
1344         return $addon;
1345 }
1346
1347 // Calculate dynamic lock
1348 function SURFBAR_CALCULATE_DYNAMIC_LOCK () {
1349         // Default lock is 30 seconds
1350         $addon = 30;
1351
1352         // Get online users
1353         $onlineUsers = SURFBAR_DETERMINE_TOTAL_ONLINE();
1354
1355         // Calculate lock
1356         $addon = abs(log($onlineUsers / $addon + 1));
1357
1358         // Return value
1359         return $addon;
1360 }
1361
1362 // "Getter" for lock ids array
1363 function SURFBAR_GET_LOCK_IDS () {
1364         // Prepare some arrays
1365         $IDs = array();
1366         $USE = array();
1367         $ignored = array();
1368
1369         // Get all id from locks within the timestamp
1370         $result = SQL_QUERY_ESC("SELECT id, url_id, UNIX_TIMESTAMP(last_surfed) AS last
1371 FROM
1372         {!_MYSQL_PREFIX!}_surfbar_locks
1373 WHERE
1374         userid=%s
1375 ORDER BY
1376         id ASC", array(getUserId()),
1377         __FUNCTION__, __LINE__);
1378
1379         // Load all entries
1380         while ($content = SQL_FETCHARRAY($result)) {
1381                 // Debug message
1382                 //* DEBUG: */ DEBUG_LOG(__FUNCTION__, __LINE__, "next - lid={$content['id']},url={$content['url_id']},rest=".(time() - $last).'/'.SURFBAR_GET_SURF_LOCK()."", false);
1383
1384                 // Skip entries that are too old
1385                 if (($last > (time() - SURFBAR_GET_SURF_LOCK())) && (!in_array($content['url_id'], $ignored))) {
1386                         // Debug message
1387                         //* DEBUG: */ DEBUG_LOG(__FUNCTION__, __LINE__, "okay - lid={$content['id']},url={$content['url_id']},last={$last}", false);
1388
1389                         // Add only if missing or bigger
1390                         if ((!isset($IDs[$content['url_id']])) || ($IDs[$content['url_id']] > $last)) {
1391                                 // Debug message
1392                                 //* DEBUG: */ DEBUG_LOG(__FUNCTION__, __LINE__, "ADD - lid={$content['id']},url={$content['url_id']},last={$last}", false);
1393
1394                                 // Add this ID
1395                                 $IDs[$content['url_id']] = $last;
1396                                 $USE[$content['url_id']] = $content['id'];
1397                         } // END - if
1398                 } else {
1399                         // Debug message
1400                         //* DEBUG: */ DEBUG_LOG(__FUNCTION__, __LINE__, "ignore - lid={$content['id']},url={$content['url_id']},last={$last}", false);
1401
1402                         // Ignore these old entries!
1403                         $ignored[] = $content['url_id'];
1404                         unset($IDs[$content['url_id']]);
1405                         unset($USE[$content['url_id']]);
1406                 }
1407         } // END - while
1408
1409         // Free result
1410         SQL_FREERESULT($result);
1411
1412         // Return array
1413         return $USE;
1414 }
1415
1416 // "Getter" for maximum random number
1417 function SURFBAR_GET_MAX_RANDOM ($UIDs, $add) {
1418         // Count max availabe entries
1419         $result = SQL_QUERY("SELECT sbu.id AS cnt
1420 FROM `{!_MYSQL_PREFIX!}_surfbar_urls` AS sbu
1421 LEFT JOIN `{!_MYSQL_PREFIX!}_surfbar_salts` AS sbs
1422 ON sbu.id=sbs.url_id
1423 LEFT JOIN `{!_MYSQL_PREFIX!}_surfbar_locks` AS l
1424 ON sbu.id=l.url_id
1425 WHERE sbu.userid NOT IN (".implode(',', $UIDs).") AND (sbu.views_allowed=0 OR (sbu.views_allowed > 0 AND sbu.views_max > 0)) AND sbu.`status`='ACTIVE'".$add."
1426 GROUP BY sbu.id", __FUNCTION__, __LINE__);
1427
1428         // Log last query
1429         //* DEBUG: */ DEBUG_LOG(__FUNCTION__, __LINE__, "lastQuery=".getConfig('db_last_query')."|numRows=".SQL_NUMROWS($result)."|Affected=".SQL_AFFECTEDROWS()."", false);
1430
1431         // Fetch max rand
1432         $maxRand = SQL_NUMROWS($result);
1433
1434         // Free result
1435         SQL_FREERESULT($result);
1436
1437         // Return value
1438         return $maxRand;
1439 }
1440
1441 // Load all URLs of the current user and return it as an array
1442 function SURFBAR_GET_USER_URLS () {
1443         // Init array
1444         $URLs = array();
1445
1446         // Begin the query
1447         $result = SQL_QUERY_ESC("SELECT u.id, u.userid, u.url, u.views_total, u.views_max, u.views_allowed, u.status, UNIX_TIMESTAMP(u.registered) AS registered, UNIX_TIMESTAMP(u.last_locked) AS last_locked, u.lock_reason AS lock_reason
1448 FROM `{!_MYSQL_PREFIX!}_surfbar_urls` AS u
1449 WHERE u.userid=%s AND u.status != 'DELETED'
1450 ORDER BY u.id ASC",
1451         array(getUserId()), __FUNCTION__, __LINE__);
1452
1453         // Are there entries?
1454         if (SQL_NUMROWS($result) > 0) {
1455                 // Load all rows
1456                 while ($row = SQL_FETCHARRAY($result)) {
1457                         // Add the row
1458                         $URLs[$row['id']] = $row;
1459                 } // END - while
1460         } // END - if
1461
1462         // Free result
1463         SQL_FREERESULT($result);
1464
1465         // Return the array
1466         return $URLs;
1467 }
1468
1469 // "Getter" for member action array for given status
1470 function SURFBAR_getModeAction_ARRAY ($status) {
1471         // Init array
1472         $returnArray = array();
1473
1474         // Get all assigned actions
1475         $result = SQL_QUERY_ESC("SELECT action FROM `{!_MYSQL_PREFIX!}_surfbar_actions` WHERE `status`='%s' ORDER BY `id` ASC",
1476         array($status), __FUNCTION__, __LINE__);
1477
1478         // Some entries there?
1479         if (SQL_NUMROWS($result) > 0) {
1480                 // Load all actions
1481                 // @TODO This can be somehow rewritten
1482                 while ($content = SQL_FETCHARRAY($result)) {
1483                         $returnArray[] = $content['action'];
1484                 } // END - if
1485         } // END - if
1486
1487         // Free result
1488         SQL_FREERESULT($result);
1489
1490         // Return result
1491         return $returnArray;
1492 }
1493
1494 // Reload to configured stop page
1495 function SURFBAR_RELOAD_TO_STOP_PAGE ($page="stop") {
1496         // Internal or external?
1497         if ((getConfig('surfbar_pause_mode') == 'INTERNAL') || (getConfig('surfbar_pause_url') == '')) {
1498                 // Reload to internal page
1499                 redirectToUrl('surfbar.php?frame=' . $page);
1500         } else {
1501                 // Reload to external page
1502                 redirectToConfiguredUrl('surfbar_pause_url');
1503         }
1504 }
1505
1506 // Determine next id for surfbar or get data for given id, always call this before you call other
1507 // getters below this function!!!
1508 function SURFBAR_DETERMINE_NEXT_ID ($urlId = 0) {
1509         // Default is no id and no random number
1510         $nextId = 0;
1511         $randNum = 0;
1512
1513         // Is the ID set?
1514         if ($urlId == 0) {
1515                 // Get array with lock ids
1516                 $USE = SURFBAR_GET_LOCK_IDS();
1517
1518                 // Shall we add some URL ids to ignore?
1519                 $add = '';
1520                 if (count($USE) > 0) {
1521                         // Ignore some!
1522                         $add = " AND sbu.id NOT IN (";
1523                         foreach ($USE as $url_id => $lid) {
1524                                 // Add URL id
1525                                 $add .= $url_id.',';
1526                         } // END - foreach
1527
1528                         // Add closing bracket
1529                         $add = substr($add, 0, -1) . ')';
1530                 } // END - if
1531
1532                 // Determine depleted user account
1533                 $UIDs = SURFBAR_DETERMINE_DEPLETED_USERIDS();
1534
1535                 // Get maximum randomness factor
1536                 $maxRand = SURFBAR_GET_MAX_RANDOM($UIDs['uid'], $add);
1537
1538                 // If more than one URL can be called generate the random number!
1539                 if ($maxRand > 1) {
1540                         // Generate random number
1541                         $randNum = mt_rand(0, ($maxRand - 1));
1542                 } // END - if
1543
1544                 // And query the database
1545                 //* DEBUG: */ DEBUG_LOG(__FUNCTION__, __LINE__, "randNum={$randNum},maxRand={$maxRand},surfLock=".SURFBAR_GET_SURF_LOCK()."", false);
1546                 $result = SQL_QUERY_ESC("SELECT sbu.id, sbu.userid, sbu.url, sbs.last_salt, sbu.views_total, sbu.views_max, sbu.views_allowed, UNIX_TIMESTAMP(l.last_surfed) AS last_surfed, sbu.fixed_reload
1547 FROM `{!_MYSQL_PREFIX!}_surfbar_urls` AS sbu
1548 LEFT JOIN `{!_MYSQL_PREFIX!}_surfbar_salts` AS sbs
1549 ON sbu.id=sbs.url_id
1550 LEFT JOIN `{!_MYSQL_PREFIX!}_surfbar_locks` AS l
1551 ON sbu.id=l.url_id
1552 WHERE sbu.userid NOT IN (".implode(',', $UIDs['uid']).") AND sbu.`status`='ACTIVE' AND (sbu.views_allowed=0 OR (sbu.views_allowed > 0 AND sbu.views_max > 0))".$add."
1553 GROUP BY sbu.id
1554 ORDER BY l.last_surfed ASC, sbu.id ASC
1555 LIMIT %s,1",
1556                 array($randNum), __FUNCTION__, __LINE__
1557                 );
1558         } else {
1559                 // Get data from specified id number
1560                 $result = SQL_QUERY_ESC("SELECT sbu.id, sbu.userid, sbu.url, sbs.last_salt, sbu.views_total, sbu.views_max, sbu.views_allowed, UNIX_TIMESTAMP(l.last_surfed) AS last_surfed, sbu.fixed_reload
1561 FROM `{!_MYSQL_PREFIX!}_surfbar_urls` AS sbu
1562 LEFT JOIN `{!_MYSQL_PREFIX!}_surfbar_salts` AS sbs
1563 ON sbu.id=sbs.url_id
1564 LEFT JOIN `{!_MYSQL_PREFIX!}_surfbar_locks` AS l
1565 ON sbu.id=l.url_id
1566 WHERE sbu.userid != %s AND sbu.`status`='ACTIVE' AND sbu.id=%s AND (sbu.views_allowed=0 OR (sbu.views_allowed > 0 AND sbu.views_max > 0))
1567 LIMIT 1",
1568                 array(getUserId(), bigintval($urlId)), __FUNCTION__, __LINE__
1569                 );
1570         }
1571
1572         // Is there an id number?
1573         //* DEBUG: */ DEBUG_LOG(__FUNCTION__, __LINE__, "lastQuery=".getConfig('db_last_query')."|numRows=".SQL_NUMROWS($result)."|Affected=".SQL_AFFECTEDROWS()."", false);
1574         if (SQL_NUMROWS($result) == 1) {
1575                 // Load/cache data
1576                 //* DEBUG: */ DEBUG_LOG(__FUNCTION__, __LINE__, "count(".count($GLOBALS['cache_array']['surfbar']).") - BEFORE", false);
1577                 $GLOBALS['cache_array']['surfbar'] = merge_array($GLOBALS['cache_array']['surfbar'], SQL_FETCHARRAY($result));
1578                 //* DEBUG: */ DEBUG_LOG(__FUNCTION__, __LINE__, "count(".count($GLOBALS['cache_array']['surfbar']).") - AFTER", false);
1579
1580                 // Determine waiting time
1581                 $GLOBALS['cache_array']['surfbar']['time'] = SURFBAR_DETERMINE_WAIT_TIME();
1582
1583                 // Is the last salt there?
1584                 if (is_null($GLOBALS['cache_array']['surfbar']['last_salt'])) {
1585                         // Then repair it wit the static!
1586                         //* DEBUG: */ DEBUG_LOG(__FUNCTION__, __LINE__, "last_salt - FIXED!", false);
1587                         $GLOBALS['cache_array']['surfbar']['last_salt'] = '';
1588                 } // END - if
1589
1590                 // Fix missing last_surfed
1591                 if ((!isset($GLOBALS['cache_array']['surfbar']['last_surfed'])) || (is_null($GLOBALS['cache_array']['surfbar']['last_surfed']))) {
1592                         // Fix it here
1593                         //* DEBUG: */ DEBUG_LOG(__FUNCTION__, __LINE__, "last_surfed - FIXED!", false);
1594                         $GLOBALS['cache_array']['surfbar']['last_surfed'] = 0;
1595                 } // END - if
1596
1597                 // Get base/fixed reward and costs
1598                 $GLOBALS['cache_array']['surfbar']['reward'] = SURFBAR_DETERMINE_REWARD();
1599                 $GLOBALS['cache_array']['surfbar']['costs']  = SURFBAR_DETERMINE_COSTS();
1600                 //* DEBUG: */ DEBUG_LOG(__FUNCTION__, __LINE__, "BASE/STATIC - reward=".SURFBAR_GET_REWARD()."|costs=".SURFBAR_GET_COSTS()."", false);
1601
1602                 // Only in dynamic model add the dynamic bonus!
1603                 if (getConfig('surfbar_pay_model') == 'DYNAMIC') {
1604                         // Calculate dynamic reward/costs and add it
1605                         $GLOBALS['cache_array']['surfbar']['reward'] += SURFBAR_CALCULATE_DYNAMIC_ADD();
1606                         $GLOBALS['cache_array']['surfbar']['costs']  += SURFBAR_CALCULATE_DYNAMIC_ADD();
1607                         //* DEBUG: */ DEBUG_LOG(__FUNCTION__, __LINE__, "DYNAMIC+ - reward=".SURFBAR_GET_REWARD()."|costs=".SURFBAR_GET_COSTS()."", false);
1608                 } // END - if
1609
1610                 // Now get the id
1611                 $nextId = SURFBAR_GET_ID();
1612         } // END - if
1613
1614         // Free result
1615         SQL_FREERESULT($result);
1616
1617         // Return result
1618         //* DEBUG: */ DEBUG_LOG(__FUNCTION__, __LINE__, "nextId={$nextId}", false);
1619         return $nextId;
1620 }
1621
1622 // -----------------------------------------------------------------------------
1623 // PLEASE DO NOT ADD ANY OTHER FUNCTIONS BELOW THIS LINE IF THEY DON'T "WRAP"
1624 // THE $GLOBALS['cache_array']['surfbar'] ARRAY!
1625 // -----------------------------------------------------------------------------
1626 // Private getter for data elements
1627 function SURFBAR_GET_DATA ($element) {
1628         //* DEBUG: */ DEBUG_LOG(__FUNCTION__, __LINE__, "element={$element}", false);
1629
1630         // Default is null
1631         $data = null;
1632
1633         // Is the entry there?
1634         if (isset($GLOBALS['cache_array']['surfbar'][$element])) {
1635                 // Then take it
1636                 $data = $GLOBALS['cache_array']['surfbar'][$element];
1637         } else { // END - if
1638                 print("<pre>");
1639                 print_r($GLOBALS['cache_array']['surfbar']);
1640                 print("</pre>");
1641                 debug_report_bug();
1642         }
1643
1644         // Return result
1645         //* DEBUG: */ DEBUG_LOG(__FUNCTION__, __LINE__, "element[$element]={$data}", false);
1646         return $data;
1647 }
1648
1649 // Getter for reward from cache
1650 function SURFBAR_GET_REWARD () {
1651         // Get data element and return its contents
1652         return SURFBAR_GET_DATA('reward');
1653 }
1654
1655 // Getter for costs from cache
1656 function SURFBAR_GET_COSTS () {
1657         // Get data element and return its contents
1658         return SURFBAR_GET_DATA('costs');
1659 }
1660
1661 // Getter for URL from cache
1662 function SURFBAR_GET_URL () {
1663         // Get data element and return its contents
1664         return SURFBAR_GET_DATA('url');
1665 }
1666
1667 // Getter for salt from cache
1668 function SURFBAR_GET_SALT () {
1669         // Get data element and return its contents
1670         return SURFBAR_GET_DATA('salt');
1671 }
1672
1673 // Getter for id from cache
1674 function SURFBAR_GET_ID () {
1675         // Get data element and return its contents
1676         return SURFBAR_GET_DATA('id');
1677 }
1678
1679 // Getter for userid from cache
1680 function SURFBAR_GET_USERID () {
1681         // Get data element and return its contents
1682         return SURFBAR_GET_DATA('userid');
1683 }
1684
1685 // Getter for user reload locks
1686 function SURFBAR_GET_USER_LOCKS () {
1687         // Get data element and return its contents
1688         return SURFBAR_GET_DATA('user_locks');
1689 }
1690
1691 // Getter for reload time
1692 function SURFBAR_GET_RELOAD_TIME () {
1693         // Get data element and return its contents
1694         return SURFBAR_GET_DATA('time');
1695 }
1696
1697 // Getter for allowed views
1698 function SURFBAR_GET_VIEWS_ALLOWED () {
1699         // Get data element and return its contents
1700         return SURFBAR_GET_DATA('views_allowed');
1701 }
1702
1703 // Getter for fixed reload
1704 function SURFBAR_GET_FIXED_RELOAD () {
1705         // Get data element and return its contents
1706         return SURFBAR_GET_DATA('fixed_reload');
1707 }
1708
1709 // Getter for surf lock
1710 function SURFBAR_GET_SURF_LOCK () {
1711         // Get data element and return its contents
1712         return SURFBAR_GET_DATA('surf_lock');
1713 }
1714
1715 // [EOF]
1716 ?>