inc/libs/surfbar_functions.php

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