inc/libs/surfbar_functions.php

   1 <?php
   2 /************************************************************************
   3  * MXChange v0.2.1                                    Start: 08/31/2008 *
   4  * ===============                              Last change: 08/31/2008 *
   5  *                                                                      *
   6  * -------------------------------------------------------------------- *
   7  * File              : surfbar_functions.php                            *
   8  * -------------------------------------------------------------------- *
   9  * Short description : Functions for surfbar                            *
  10  * -------------------------------------------------------------------- *
  11  * Kurzbeschreibung  : Funktionen fuer die Surfbar                      *
  12  * -------------------------------------------------------------------- *
  13  *                                                                      *
  14  * -------------------------------------------------------------------- *
  15  * Copyright (c) 2003 - 2008 by Roland Haeder                           *
  16  * For more information visit: http://www.mxchange.org                  *
  17  *                                                                      *
  18  * This program is free software; you can redistribute it and/or modify *
  19  * it under the terms of the GNU General Public License as published by *
  20  * the Free Software Foundation; either version 2 of the License, or    *
  21  * (at your option) any later version.                                  *
  22  *                                                                      *
  23  * This program is distributed in the hope that it will be useful,      *
  24  * but WITHOUT ANY WARRANTY; without even the implied warranty of       *
  25  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the        *
  26  * GNU General Public License for more details.                         *
  27  *                                                                      *
  28  * You should have received a copy of the GNU General Public License    *
  29  * along with this program; if not, write to the Free Software          *
  30  * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston,               *
  31  * MA  02110-1301  USA                                                  *
  32  ************************************************************************/
  33
  34 // Some security stuff...
  35 if (!defined('__SECURITY')) {
  36         $INC = substr(dirname(__FILE__), 0, strpos(dirname(__FILE__), "/inc") + 4) . "/security.php";
  37         require($INC);
  38 }
  39
  40 // -----------------------------------------------------------------------------
  41 //                               Admin functions
  42 // -----------------------------------------------------------------------------
  43 //
  44 // Admin has added an URL with given user id and so on
  45 function SURFBAR_ADMIN_ADD_URL ($url, $limit) {
  46         // Do some pre-checks
  47         if (!IS_ADMIN()) {
  48                 // Not an admin
  49                 return false;
  50         } elseif (!VALIDATE_URL($url)) {
  51                 // URL invalid
  52                 return false;
  53         } elseif (SURFBAR_LOOKUP_BY_URL($url, "0")) {
  54                 // URL already found in surfbar!
  55                 return false;
  56         } elseif (!SURFBAR_IF_USER_BOOK_MORE_URLS()) {
  57                 // No more allowed!
  58                 return false;
  59         } elseif ("".($limit + 0)."" != "".$limit."") {
  60                 // Invalid amount entered
  61                 return false;
  62         }
  63
  64         // Register the new URL
  65         return SURFBAR_REGISTER_URL($url, "0", "ACTIVE", "unlock", $limit);
  66 }
  67 // Admin unlocked an email so we can migrate the URL
  68 function SURFBAR_ADMIN_MIGRATE_URL ($url, $uid) {
  69         // Do some pre-checks
  70         if (!IS_ADMIN()) {
  71                 // Not an admin
  72                 return false;
  73         } elseif (!VALIDATE_URL($url)) {
  74                 // URL invalid
  75                 return false;
  76         } elseif (SURFBAR_LOOKUP_BY_URL($url, $uid)) {
  77                 // URL already found in surfbar!
  78                 return false;
  79         } elseif (!SURFBAR_IF_USER_BOOK_MORE_URLS($uid)) {
  80                 // No more allowed!
  81                 return false;
  82         }
  83
  84         // Register the new URL
  85         return SURFBAR_REGISTER_URL($url, $uid, "MIGRATED", "migrate");
  86 }
  87 // Admin function for unlocking URLs
  88 function SURFBAR_ADMIN_UNLOCK_URL_IDS ($IDs) {
  89         // Is this an admin or invalid array?
  90         if (!IS_ADMIN()) {
  91                 // Not admin or invalid IDs array
  92                 return false;
  93         } elseif (!is_array($IDs)) {
  94                 // No array
  95                 return false;
  96         } elseif (count($IDs) == 0) {
  97                 // Empty array
  98                 return false;
  99         }
 100
 101         // Set to true to make AND expression valid if first URL got unlocked
 102         $done = true;
 103
 104         // Update the status for all ids
 105         foreach ($IDs as $id => $dummy) {
 106                 // Test all ids through (ignores failed)
 107                 $done = (($done) && (SURFBAR_CHANGE_STATUS($id, "PENDING", "ACTIVE")));
 108         } // END - if
 109
 110         // Return total status
 111         return $done;
 112 }
 113 // Admin function for rejecting URLs
 114 function SURFBAR_ADMIN_REJECT_URL_IDS ($IDs) {
 115         // Is this an admin or invalid array?
 116         if (!IS_ADMIN()) {
 117                 // Not admin or invalid IDs array
 118                 return false;
 119         } elseif (!is_array($IDs)) {
 120                 // No array
 121                 return false;
 122         } elseif (count($IDs) == 0) {
 123                 // Empty array
 124                 return false;
 125         }
 126
 127         // Set to true to make AND expression valid if first URL got unlocked
 128         $done = true;
 129
 130         // Update the status for all ids
 131         foreach ($IDs as $id => $dummy) {
 132                 // Test all ids through (ignores failed)
 133                 $done = (($done) && (SURFBAR_CHANGE_STATUS($id, "PENDING", "REJECTED")));
 134         } // END - if
 135
 136         // Return total status
 137         return $done;
 138 }
 139 //
 140 // -----------------------------------------------------------------------------
 141 //                               Member functions
 142 // -----------------------------------------------------------------------------
 143 //
 144 // Member has added an URL
 145 function SURFBAR_MEMBER_ADD_URL ($url, $limit) {
 146         global $_CONFIG;
 147
 148         // Do some pre-checks
 149         if (!IS_MEMBER()) {
 150                 // Not a member
 151                 return false;
 152         } elseif (!VALIDATE_URL($url)) {
 153                 // URL invalid
 154                 return false;
 155         } elseif (SURFBAR_LOOKUP_BY_URL($url, $GLOBALS['userid'])) {
 156                 // URL already found in surfbar!
 157                 return false;
 158         } elseif (!SURFBAR_IF_USER_BOOK_MORE_URLS($GLOBALS['userid'])) {
 159                 // No more allowed!
 160                 return false;
 161         } elseif ("".($limit + 0)."" != "".$limit."") {
 162                 // Invalid amount entered
 163                 return false;
 164         }
 165
 166         // Register the new URL
 167         return SURFBAR_REGISTER_URL($url, $GLOBALS['userid'], "PENDING", "reg", $limit);
 168 }
 169 // Create list of actions depending on status for the user
 170 function SURFBAR_MEMBER_ACTIONS ($urlId, $status) {
 171         // Load all actions in an array for given status
 172         $actionArray = SURFBAR_GET_ACTION_ARRAY($status);
 173
 174         // Init HTML code
 175         $OUT = "<table border=\"0\" cellspacing=\"0\" cellpadding=\"1\" width=\"100%\">
 176 <tr>\n";
 177
 178         // Calculate width
 179         $width = round(100 / count($actionArray));
 180
 181         // "Walk" through all actions and create forms
 182         foreach ($actionArray as $actionId=>$action) {
 183                 // Add form for this action
 184                 $OUT .= sprintf("       <td align=\"center\" width=\"%d%%\">
 185                 <form action=\"".URL."/modules.php?module=login&amp;what=surfbar_list\" method=\"post\" style=\"padding-bottom:0px\">
 186                         <input type=\"hidden\" name=\"id\" value=\"%s\" />
 187                         <input type=\"hidden\" name=\"action\" value=\"%s\" />
 188                         <input type=\"submit\" class=\"member_submit\" name=\"ok\" title=\"{--MEMBER_SURFBAR_ACTION_%s_TITLE--}\" value=\"{--MEMBER_SURFBAR_ACTION_%s_SUBMIT--}\" />
 189                 </form>
 190         </td>\n",
 191                         $width,
 192                         bigintval($urlId),
 193                         strtolower($action),
 194                         strtoupper($action),
 195                         strtoupper($action)
 196                 );
 197         } // END - foreach
 198
 199         // Close table
 200         $OUT .= "</tr>
 201 </table>\n";
 202
 203         // Return code
 204         return $OUT;
 205 }
 206 // Do the member form request
 207 function SURFBAR_MEMBER_DO_FORM ($formData, $URLs) {
 208         global $SURFBAR_CACHE;
 209
 210         // By default no action is performed
 211         $performed = false;
 212
 213         // Is this a member?
 214         if (!IS_MEMBER()) {
 215                 // No member!
 216                 return false;
 217         } elseif ((!isset($formData['id'])) || (!isset($formData['action']))) {
 218                 // Important form elements are missing!
 219                 return false;
 220         } elseif (!isset($URLs[$formData['id']])) {
 221                 // ID not found in cache
 222                 return false;
 223         } elseif (!SURFBAR_VALIDATE_MEMBER_ACTION_STATUS($formData['action'], $URLs[$formData['id']]['status'])) {
 224                 // Action not allowed for current URL status
 225                 return false;
 226         }
 227
 228         // Secure action
 229         $action = SQL_ESCAPE(htmlentities(strip_tags($formData['action']), ENT_QUOTES));
 230
 231         // Has it changed?
 232         if ($action != $formData['action']) {
 233                 // Invalid data in action found
 234                 return false;
 235         } // END - if
 236
 237         // Create the function name for selected action
 238         $functionName = sprintf("SURFBAR_MEMBER_%s_ACTION", strtoupper($action));
 239
 240         // Is the function there?
 241         if (function_exists($functionName)) {
 242                 // Add new status
 243                 $URLs[$formData['id']]['new_status'] = $SURFBAR_CACHE['new_status'];
 244
 245                 // Extract URL data for call-back
 246                 $urlData = array(array_merge($URLs[$formData['id']], array($action => $formData)));
 247
 248                 // Action found so execute it
 249                 $performed = call_user_func_array($functionName, $urlData);
 250         } else {
 251                 // Log invalid request
 252                 DEBUG_LOG(__FUNCTION__, __LINE__, " action={$formData['action']},id={$formData['id']},function={$functionName}");
 253                 ADD_FATAL(sprintf("Invalid member action! action=%s,id=%s,function=%s", $formData['action'], $formData['id'], $functionName));
 254         }
 255
 256         // Return status
 257         return $performed;
 258 }
 259 // Validate if the requested action can be performed on current URL status
 260 function SURFBAR_VALIDATE_MEMBER_ACTION_STATUS ($action, $status) {
 261         global $SURFBAR_CACHE;
 262
 263         // Search for the requested action/status combination in database
 264         $result = SQL_QUERY_ESC("SELECT new_status FROM "._MYSQL_PREFIX."_surfbar_actions WHERE action='%s' AND status='%s' LIMIT 1",
 265                 array($action, $status), __FILE__, __LINE__);
 266
 267         // Is the entry there?
 268         $isValid = (SQL_NUMROWS($result) == 1);
 269
 270         // Fetch the new status if found
 271         if ($isValid) {
 272                 // Load new status
 273                 list($SURFBAR_CACHE['new_status']) = SQL_FETCHROW($result);
 274         } // END - if
 275
 276         // Free result
 277         SQL_FREERESULT($result);
 278
 279         // Return status
 280         return $isValid;
 281 }
 282 //
 283 // -----------------------------------------------------------------------------
 284 //                               Member actions
 285 // -----------------------------------------------------------------------------
 286 //
 287 // Retreat a booked URL
 288 function SURFBAR_MEMBER_RETREAT_ACTION ($urlData) {
 289         // Create the data array for next function call
 290         $data = array(
 291                 $urlData['id'] => $urlData
 292         );
 293
 294         // Simply change the status here
 295         return SURFBAR_CHANGE_STATUS ($urlData['id'], $urlData['status'], $urlData['new_status'], $data);
 296 }
 297 // Book an URL now (from migration)
 298 function SURFBAR_MEMBER_BOOKNOW_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 // Show edit form or do the changes
 308 function SURFBAR_MEMBER_EDIT_ACTION ($urlData) {
 309         // Is the "execute" flag there?
 310         if (isset($urlData['edit']['execute'])) {
 311                 // Execute the changes
 312                 return SURFBAR_MEMBER_EXECUTE_ACTION("edit", $urlData);
 313         } // END - if
 314
 315         // Display form
 316         return SURFBAR_MEMBER_DISPLAY_ACTION_FORM("edit", $urlData);
 317 }
 318 // Show delete form or do the changes
 319 function SURFBAR_MEMBER_DELETE_ACTION ($urlData) {
 320         // Is the "execute" flag there?
 321         if (isset($urlData['delete']['execute'])) {
 322                 // Execute the changes
 323                 return SURFBAR_MEMBER_EXECUTE_ACTION("delete", $urlData);
 324         } // END - if
 325
 326         // Display form
 327         return SURFBAR_MEMBER_DISPLAY_ACTION_FORM("delete", $urlData);
 328 }
 329 // Display selected "action form"
 330 function SURFBAR_MEMBER_DISPLAY_ACTION_FORM ($action, $urlData) {
 331         // Translate some data
 332         $urlData['registered']    = MAKE_DATETIME($urlData['registered'], "2");
 333         $urlData['views_total']   = TRANSLATE_COMMA($urlData['views_total']);
 334         $urlData['views_max']     = TRANSLATE_COMMA($urlData['views_max']);
 335         $urlData['views_allowed'] = TRANSLATE_COMMA($urlData['views_allowed']);
 336         $urlData['last_locked']   = MAKE_DATETIME($urlData['last_locked'], "2");
 337
 338         // Is the lock reason empty?
 339         if (empty($urlData['lock_reason'])) {
 340                 // Fix it to three dashes
 341                 $urlData['lock_reason'] = "---";
 342         } // END - if
 343
 344         // Default is not limited
 345         $urlData['limited_yes'] = "";
 346         $urlData['limited_no']  = " checked=\"checked\"";
 347         $urlData['limited']     = "false";
 348
 349         // Is this URL limited?
 350         if ($urlData['views_max'] > 0) {
 351                 // Then rewrite form data
 352                 $urlData['limited_yes'] = " checked=\"checked\"";
 353                 $urlData['limited_no']  = "";
 354                 $urlData['limited']     = "true";
 355         } // END - if
 356
 357         // Load the form and display it
 358         LOAD_TEMPLATE(sprintf("member_surfbar_%s_action_form", $action), false, $urlData);
 359
 360         // All fine by default ... ;-)
 361         return true;
 362 }
 363 // Execute choosen action
 364 function SURFBAR_MEMBER_EXECUTE_ACTION ($action, $urlData) {
 365         // By default nothing is executed
 366         $executed = false;
 367
 368         // Is limitation "no" and "limit" is > 0?
 369         if ((isset($urlData[$action]['limited'])) && ($urlData[$action]['limited'] == "N") && ((isset($urlData[$action]['limit'])) && ($urlData[$action]['limit'] > 0)) || (!isset($urlData[$action]['limit']))) {
 370                 // Set it to unlimited
 371                 $urlData[$action]['limit'] = 0;
 372         } // END - if
 373
 374         // Construct function name
 375         $functionName = sprintf("SURFBAR_MEMBER_EXECUTE_%s_ACTION", strtoupper($action));
 376
 377         // Is 'userid' set and not 'uid' ?
 378         if ((!isset($urlData['uid'])) && (isset($urlData['userid']))) {
 379                 // Auto-fix this
 380                 $urlData['uid'] = $urlData['userid'];
 381         } // END - if
 382
 383         // Is that function there?
 384         if (function_exists($functionName)) {
 385                 // Execute the function
 386                 if (call_user_func_array($functionName, array($urlData)) == true) {
 387                         // Update status as well
 388                         $executed = SURFBAR_CHANGE_STATUS($urlData['id'], $urlData['status'], $urlData['new_status'], array($urlData['id'] => $urlData));
 389                 } // END - if
 390         } else {
 391                 // Not found!
 392                 ADD_FATAL(sprintf(MEMBER_SURFBAR_EXECUTE_ACTION_404, $functionName));
 393         }
 394
 395         // Return status
 396         return $executed;
 397 }
 398 // "Execute edit" function: Update changed data
 399 function SURFBAR_MEMBER_EXECUTE_EDIT_ACTION ($urlData) {
 400         // Translate URLs for testing
 401         $url1 = COMPILE_CODE($urlData['url']);
 402         $url2 = COMPILE_CODE($urlData['edit']['url']);
 403
 404         // Has the URL or limit changed?
 405         if (($urlData['views_allowed'] != $urlData['edit']['limit']) || ($url1 != $url2)) {
 406                 // Run the query
 407                 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",
 408                         array($urlData['url'], $urlData['edit']['limit'], $urlData['edit']['limit'], $urlData['id'], $urlData['status']), __FILE__, __LINE__);
 409
 410                 // Prepare new data
 411                 $urlData['new_url']   = $urlData['edit']['url'];
 412                 $urlData['new_limit'] = $urlData['edit']['limit'];
 413                 unset($urlData['edit']);
 414
 415                 // Send admin notification
 416                 SURFBAR_NOTIFY_ADMIN("url_edited", $urlData);
 417
 418                 // Send user notification
 419                 SURFBAR_NOTIFY_USER("url_edited", $urlData);
 420
 421                 // All fine
 422                 return true;
 423         }
 424
 425         // Not updated
 426         return false;
 427 }
 428 //
 429 // -----------------------------------------------------------------------------
 430 //                           Self-maintenance functions
 431 // -----------------------------------------------------------------------------
 432 //
 433 // Main function
 434 function SURFBAR_HANDLE_SELF_MAINTENANCE () {
 435         // Handle URLs which limit has depleted so we can stop them
 436         SURFBAR_HANDLE_DEPLETED_VIEWS();
 437
 438         // Handle low-points amounts
 439         SURFBAR_HANDLE_LOW_POINTS();
 440 }
 441 // Handle URLs which limit has depleted
 442 function SURFBAR_HANDLE_DEPLETED_VIEWS () {
 443         // Get all URLs
 444         $urlArray = SURFBAR_GET_URL_DATA("0", "views_max", "id", "ASC", "id", " AND views_allowed>0 AND status='ACTIVE'");
 445
 446         // Do we have some entries?
 447         if (count($urlArray) > 0) {
 448                 // Then handle all!
 449                 foreach ($urlArray as $id => $urlData) {
 450                         // Backup data
 451                         $data = $urlData;
 452
 453                         // Rewrite array for next call
 454                         $urlData[$id] = $data;
 455
 456                         // Handle the status
 457                         SURFBAR_CHANGE_STATUS($id, "ACTIVE", "DEPLETED", $urlData);
 458                 } // END - foreach
 459         } // END - if
 460 }
 461 // Alert users which have URLs booked and are low on points amount
 462 function SURFBAR_HANDLE_LOW_POINTS () {
 463         global $_CONFIG;
 464
 465         // Get all userids
 466         $UIDs = SURFBAR_DETERMINE_DEPLETED_USERIDS($_CONFIG['surfbar_warn_low_points']);
 467
 468         // "Walk" through all URLs
 469         foreach ($UIDs['uid'] as $uid => $dummy) {
 470                 // Is the last notification far enougth away to notify again?
 471                 if ((time() - $UIDs['notified'][$uid]) >= $_CONFIG['surfbar_low_interval']) {
 472                         // Prepare content
 473                         $content = array(
 474                                 'uid'      => $uid,
 475                                 'low'      => TRANSLATE_COMMA($_CONFIG['surfbar_warn_low_points']),
 476                                 'points'   => TRANSLATE_COMMA($UIDs['points'][$uid]),
 477                                 'notified' => MAKE_DATETIME($UIDs['notified'][$uid]),
 478                                 'interval' => CREATE_FANCY_TIME($_CONFIG['surfbar_low_interval'])
 479                         );
 480
 481                         // Notify this user
 482                         SURFBAR_NOTIFY_USER("low_points", $content);
 483
 484                         // Update last notified
 485                         SQL_QUERY_ESC("UPDATE "._MYSQL_PREFIX."_user_data SET surfbar_low_notified=NOW() WHERE userid=%s LIMIT 1",
 486                                 array($uid), __FILE__, __LINE__);
 487                 } // END - if
 488         } // END - foreach
 489 }
 490 //
 491 // -----------------------------------------------------------------------------
 492 //                               Generic functions
 493 // -----------------------------------------------------------------------------
 494 //
 495 // Looks up by an URL
 496 function SURFBAR_LOOKUP_BY_URL ($url, $uid) {
 497         // Now lookup that given URL by itself
 498         $urlArray = SURFBAR_GET_URL_DATA($url, "url", "id", "ASC", "id", sprintf(" AND userid=%s", bigintval($uid)));
 499
 500         // Was it found?
 501         return (count($urlArray) > 0);
 502 }
 503 // Load URL data by given search term and column
 504 function SURFBAR_GET_URL_DATA ($searchTerm, $column="id", $order="id", $sort="ASC", $group="id", $add="") {
 505         global $lastUrlData;
 506
 507         // By default nothing is found
 508         $lastUrlData = array();
 509
 510         // Is the column an id number?
 511         if (($column == "id") || ($column == "userid")) {
 512                 // Extra secure input
 513                 $searchTerm = bigintval($searchTerm);
 514         } // END - if
 515
 516         // If the column is "id" there can be only one entry
 517         $limit = "";
 518         if ($column == "id") {
 519                 $limit = "LIMIT 1";
 520         } // END - if
 521
 522         // Look up the record
 523         $result = SQL_QUERY_ESC("SELECT id, userid, url, views_total, views_max, views_allowed, status, registered, last_locked, lock_reason, views_max, views_allowed
 524 FROM "._MYSQL_PREFIX."_surfbar_urls
 525 WHERE %s='%s'".$add."
 526 ORDER BY %s %s
 527 %s",
 528                 array($column, $searchTerm, $order, $sort, $limit), __FILE__, __LINE__);
 529
 530         // Is there at least one record?
 531         if (SQL_NUMROWS($result) > 0) {
 532                 // Then load all!
 533                 while ($dataRow = SQL_FETCHARRAY($result)) {
 534                         // Shall we group these results?
 535                         if ($group == "id") {
 536                                 // Add the row by id as index
 537                                 $lastUrlData[$dataRow['id']] = $dataRow;
 538                         } else {
 539                                 // Group entries
 540                                 $lastUrlData[$dataRow[$group]][$dataRow['id']] = $dataRow;
 541                         }
 542                 } // END - while
 543         } // END - if
 544
 545         // Free the result
 546         SQL_FREERESULT($result);
 547
 548         // Return the result
 549         return $lastUrlData;
 550 }
 551 // Registers an URL with the surfbar. You should have called SURFBAR_LOOKUP_BY_URL() first!
 552 function SURFBAR_REGISTER_URL ($url, $uid, $status="PENDING", $addMode="reg", $limit=0) {
 553         global $_CONFIG;
 554
 555         // Make sure by the user registered URLs are always pending
 556         if ($addMode == "reg") $status = "PENDING";
 557
 558         // Prepare content
 559         $content = array(
 560                 'url'         => $url,
 561                 'frametester' => FRAMETESTER($url),
 562                 'uid'         => $uid,
 563                 'status'      => $status,
 564                 'limit'       => $limit
 565         );
 566
 567         // Insert the URL into database
 568         $content['insert_id'] = SURFBAR_INSERT_URL_BY_ARRAY($content);
 569
 570         // Is this ID valid?
 571         if ($content['insert_id'] == 0) {
 572                 // INSERT did not insert any data!
 573                 return false;
 574         } // END - if
 575
 576         // Translate status and limit
 577         $content['limit'] = SURFBAR_TRANSLATE_LIMIT($content['limit']);
 578
 579         // If in reg-mode we notify admin
 580         if (($addMode == "reg") || ($_CONFIG['surfbar_notify_admin_unlock'] == "Y")) {
 581                 // Notify admin even when he as unlocked an email
 582                 SURFBAR_NOTIFY_ADMIN("url_{$addMode}", $content);
 583         } // END - if
 584
 585         // Send mail to user
 586         SURFBAR_NOTIFY_USER("url_{$addMode}", $content);
 587
 588         // Return the insert id
 589         return $content['insert_id'];
 590 }
 591 // Inserts an url by given data array and return the insert id
 592 function SURFBAR_INSERT_URL_BY_ARRAY ($urlData) {
 593         // Get userid
 594         $uid = bigintval($urlData['uid']);
 595
 596         // Is the id set?
 597         if (empty($uid)) $uid = 0;
 598
 599         // Just run the insert query for now
 600         SQL_QUERY_ESC("INSERT INTO "._MYSQL_PREFIX."_surfbar_urls (userid,url,status,views_max,views_allowed) VALUES (%s,'%s','%s',%s,%s)",
 601                 array(
 602                         $uid,
 603                         $urlData['url'],
 604                         $urlData['status'],
 605                         $urlData['limit'],
 606                         $urlData['limit']
 607                 ), __FILE__, __LINE__
 608         );
 609
 610         // Return insert id
 611         return SQL_INSERTID();
 612 }
 613 // Notify admin(s) with a selected message and content
 614 function SURFBAR_NOTIFY_ADMIN ($messageType, $content) {
 615         // Prepare template name
 616         $templateName = sprintf("admin_surfbar_%s", $messageType);
 617
 618         // Set default subject if following eval() wents wrong
 619         $subject = ADMIN_SURFBAR_NOTIFY_DEFAULT_SUBJECT;
 620
 621         // Create constant name
 622         $constantName = sprintf("ADMIN_SURFBAR_NOTIFY_%s_SUBJECT",
 623                 strtoupper($messageType)
 624         );
 625
 626         // Prepare subject
 627         if (defined($constantName)) {
 628                 $subject = constant($constantName);
 629         } else {
 630                 ADD_FATAL(ADMIN_SURFBAR_NOTIFY_SUBJECT_404, $constantName);
 631         }
 632
 633         // Translate some data if present
 634         if (isset($content['status']))        $content['status']        = SURFBAR_TRANSLATE_STATUS($content['status']);
 635         if (isset($content['registered']))    $content['registered']    = MAKE_DATETIME($content['registered'], "2");
 636         if (isset($content['last_locked']))   $content['last_locked']   = MAKE_DATETIME($content['last_locked'], "2");
 637         if (isset($content['views_total']))   $content['views_total']   = TRANSLATE_COMMA($content['views_total']);
 638         if (isset($content['views_allowed'])) $content['views_allowed'] = TRANSLATE_COMMA($content['views_allowed']);
 639         if (isset($content['views_max']))     $content['views_max']     = TRANSLATE_COMMA($content['views_max']);
 640
 641         // Send the notification out
 642         return SEND_ADMIN_NOTIFICATION($subject, $templateName, $content, $content['uid']);
 643 }
 644 // Notify the user about the performed action
 645 function SURFBAR_NOTIFY_USER ($messageType, $content) {
 646         // Skip notification if userid is zero
 647         if ($content['uid'] == 0) {
 648                 return false;
 649         } // END - if
 650
 651         // Prepare template name
 652         $templateName = sprintf("member_surfbar_%s", $messageType);
 653
 654         // Set default subject if following eval() wents wrong
 655         $subject = MEMBER_SURFBAR_NOTIFY_DEFAULT_SUBJECT;
 656
 657         // Create constant name
 658         $constantName = sprintf("MEMBER_SURFBAR_NOTIFY_%s_SUBJECT",
 659                 strtoupper($messageType)
 660         );
 661
 662         // Prepare subject
 663         if (defined($constantName)) {
 664                 $subject = constant($constantName);
 665         } else {
 666                 ADD_FATAL(MEMBER_SURFBAR_NOTIFY_SUBJECT_404, $constantName);
 667         }
 668
 669         // Load template
 670         $mailText = LOAD_EMAIL_TEMPLATE($templateName, $content, $content['uid']);
 671
 672         // Send the email
 673         return SEND_EMAIL($content['uid'], $subject, $mailText);
 674 }
 675 // Translates the limit
 676 function SURFBAR_TRANSLATE_LIMIT ($limit) {
 677         // Is this zero?
 678         if ($limit == 0) {
 679                 // Unlimited!
 680                 $return = MEMBER_SURFBAR_UNLIMITED_VIEWS;
 681         } else {
 682                 // Translate comma
 683                 $return = TRANSLATE_COMMA($limit);
 684         }
 685
 686         // Return value
 687         return $return;
 688 }
 689 // Translate the URL status
 690 function SURFBAR_TRANSLATE_STATUS ($status) {
 691         // Create constant name
 692         $constantName = sprintf("SURFBAR_URL_STATUS_%s", strtoupper($status));
 693
 694         // Set default translated status
 695         $statusTranslated = "!".$constantName."!";
 696
 697         // Is the constant there?
 698         if (defined($constantName)) {
 699                 // Then get it's value
 700                 $statusTranslated = constant($constantName);
 701         } // END - if
 702
 703         // Return result
 704         return $statusTranslated;
 705 }
 706 // Determine reward
 707 function SURFBAR_DETERMINE_REWARD ($onlyMin=false) {
 708         global $_CONFIG;
 709
 710         // Static values are default
 711         $reward = $_CONFIG['surfbar_static_reward'];
 712
 713         // Do we have static or dynamic?
 714         if ($_CONFIG['surfbar_pay_model'] == "DYNAMIC") {
 715                 // "Calculate" dynamic reward
 716                 if ($onlyMin) {
 717                         $reward += SURFBAR_CALCULATE_DYNAMIC_MIN_VALUE();
 718                 } else {
 719                         $reward += SURFBAR_CALCULATE_DYNAMIC_ADD();
 720                 }
 721         } // END - if
 722
 723         // Return reward
 724         return $reward;
 725 }
 726 // Determine costs
 727 function SURFBAR_DETERMINE_COSTS ($onlyMin=false) {
 728         global $_CONFIG;
 729
 730         // Static costs is default
 731         $costs  = $_CONFIG['surfbar_static_costs'];
 732
 733         // Do we have static or dynamic?
 734         if ($_CONFIG['surfbar_pay_model'] == "DYNAMIC") {
 735                 // "Calculate" dynamic costs
 736                 if ($onlyMin) {
 737                         $costs += SURFBAR_CALCULATE_DYNAMIC_MIN_VALUE();
 738                 } else {
 739                         $costs += SURFBAR_CALCULATE_DYNAMIC_ADD();
 740                 }
 741         } // END - if
 742
 743         // Return costs
 744         return $costs;
 745 }
 746 // "Calculate" dynamic add
 747 function SURFBAR_CALCULATE_DYNAMIC_ADD () {
 748         // Get min/max values
 749         $min = SURFBAR_CALCULATE_DYNAMIC_MIN_VALUE();
 750         $max = SURFBAR_CALCULATE_DYNAMIC_MAX_VALUE();
 751
 752         // "Calculate" dynamic part and return it
 753         return mt_rand($min, $max);
 754 }
 755 // Determine right template name
 756 function SURFBAR_DETERMINE_TEMPLATE_NAME() {
 757         // Default is the frameset
 758         $templateName = "surfbar_frameset";
 759
 760         // Any frame set? ;-)
 761         if (isset($_GET['frame'])) {
 762                 // Use the frame as a template name part... ;-)
 763                 $templateName = sprintf("surfbar_frame_%s",
 764                         SQL_ESCAPE($_GET['frame'])
 765                 );
 766         } // END - if
 767
 768         // Return result
 769         return $templateName;
 770 }
 771 // Check if the "reload lock" of the current user is full, call this function
 772 // before you call SURFBAR_CHECK_RELOAD_LOCK().
 773 function SURFBAR_CHECK_RELOAD_FULL() {
 774         global $SURFBAR_CACHE, $_CONFIG;
 775
 776         // Default is full!
 777         $isFull = true;
 778
 779         // Cache static reload lock
 780         $SURFBAR_CACHE['surf_lock'] = $_CONFIG['surfbar_static_lock'];
 781         //DEBUG_LOG(__FUNCTION__, __LINE__, "Fixed surf lock is ".$_CONFIG['surfbar_static_lock']."", false);
 782
 783         // Do we have dynamic model?
 784         if ($_CONFIG['surfbar_pay_model'] == "DYNAMIC") {
 785                 // "Calculate" dynamic lock
 786                 $SURFBAR_CACHE['surf_lock'] += SURFBAR_CALCULATE_DYNAMIC_ADD();
 787         } // END - if
 788
 789         // Ask the database
 790         $result = SQL_QUERY_ESC("SELECT COUNT(id) AS cnt FROM "._MYSQL_PREFIX."_surfbar_locks
 791 WHERE userid=%s AND (UNIX_TIMESTAMP() - ".SURFBAR_GET_DATA('surf_lock').") < UNIX_TIMESTAMP(last_surfed)
 792 LIMIT 1",
 793                 array($GLOBALS['userid']), __FILE__, __LINE__
 794         );
 795
 796         // Fetch row
 797         list($SURFBAR_CACHE['user_locks']) = SQL_FETCHROW($result);
 798
 799         // Is it null?
 800         if (is_null($SURFBAR_CACHE['user_locks'])) {
 801                 // Then fix it to zero!
 802                 $SURFBAR_CACHE['user_locks'] = 0;
 803         } // END - if
 804
 805         // Free result
 806         SQL_FREERESULT($result);
 807
 808         // Get total URLs
 809         $total = SURFBAR_GET_TOTAL_URLS();
 810
 811         // Do we have some URLs in lock? Admins can always surf on own URLs!
 812         //DEBUG_LOG(__FUNCTION__, __LINE__, "userLocks=".SURFBAR_GET_DATA('user_locks').",total={$total}", false);
 813         $isFull = ((SURFBAR_GET_DATA('user_locks') == $total) && ($total > 0));
 814
 815         // Return result
 816         return $isFull;
 817 }
 818 // Get total amount of URLs of given status for current user or of ACTIVE URLs by default
 819 function SURFBAR_GET_TOTAL_URLS ($status="ACTIVE", $excludeUserId=0) {
 820         // Determine depleted user account
 821         $UIDs = SURFBAR_DETERMINE_DEPLETED_USERIDS();
 822
 823         // Is the exlude userid set?
 824         if ($excludeUserId > 0) {
 825                 // Then add it
 826                 $UIDs['uid'][$excludeUserId] = $excludeUserId;
 827         } // END - if
 828
 829         // Get amount from database
 830         $result = SQL_QUERY_ESC("SELECT COUNT(id) AS cnt
 831 FROM "._MYSQL_PREFIX."_surfbar_urls
 832 WHERE userid NOT IN (".implode(",", $UIDs['uid']).") AND status='%s'",
 833                 array($status), __FILE__, __LINE__
 834         );
 835
 836         // Fetch row
 837         list($cnt) = SQL_FETCHROW($result);
 838
 839         // Free result
 840         SQL_FREERESULT($result);
 841
 842         // Return result
 843         return $cnt;
 844 }
 845 // Check wether the user is allowed to book more URLs
 846 function SURFBAR_IF_USER_BOOK_MORE_URLS ($uid=0) {
 847         global $_CONFIG;
 848
 849         // Is this admin and userid is zero or does the user has some URLs left to book?
 850         return ((($uid == 0) && (IS_ADMIN())) || (SURFBAR_GET_TOTAL_USER_URLS($uid, "", array("REJECTED")) < $_CONFIG['surfbar_max_order']));
 851 }
 852 // Get total amount of URLs of given status for current user
 853 function SURFBAR_GET_TOTAL_USER_URLS ($uid=0, $status="",$exclude="") {
 854         global $_CONFIG;
 855
 856         // Is the user 0 and user is logged in?
 857         if (($uid == 0) && (IS_MEMBER())) {
 858                 // Then use this userid
 859                 $uid = $GLOBALS['userid'];
 860         } elseif ($uid == 0) {
 861                 // Error!
 862                 return ($_CONFIG['surfbar_max_order'] + 1);
 863         }
 864
 865         // Default is all URLs
 866         $ADD = "";
 867
 868         // Is the status set?
 869         if (is_array($status)) {
 870                 // Only URLs with these status
 871                 $ADD = sprintf(" AND status IN('%s')", implode("','", $status));
 872         } elseif (!empty($status)) {
 873                 // Only URLs with this status
 874                 $ADD = sprintf(" AND status='%s'", $status);
 875         } elseif (is_array($exclude)) {
 876                 // Exclude URLs with these status
 877                 $ADD = sprintf(" AND status NOT IN('%s')", implode("','", $exclude));
 878         } elseif (!empty($exclude)) {
 879                 // Exclude URLs with this status
 880                 $ADD = sprintf(" AND status != '%s'", $exclude);
 881         }
 882
 883         // Get amount from database
 884         $result = SQL_QUERY_ESC("SELECT COUNT(id) AS cnt
 885 FROM "._MYSQL_PREFIX."_surfbar_urls
 886 WHERE userid=%s".$ADD."
 887 LIMIT %s",
 888                 array($uid, $_CONFIG['surfbar_max_order']), __FILE__, __LINE__
 889         );
 890
 891         // Fetch row
 892         list($cnt) = SQL_FETCHROW($result);
 893
 894         // Free result
 895         SQL_FREERESULT($result);
 896
 897         // Return result
 898         return $cnt;
 899 }
 900 // Generate a validation code for the given id number
 901 function SURFBAR_GENERATE_VALIDATION_CODE ($urlId, $salt="") {
 902         global $_CONFIG, $SURFBAR_CACHE;
 903
 904         // @TODO Invalid salt should be refused
 905         $SURFBAR_CACHE['salt'] = "INVALID";
 906
 907         // Get code length from config
 908         $length = $_CONFIG['code_length'];
 909
 910         // Fix length to 10
 911         if ($length == 0) $length = 10;
 912
 913         // Generate a code until the length matches
 914         $valCode = "";
 915         while (strlen($valCode) != $length) {
 916                 // Is the salt set?
 917                 if (empty($salt)) {
 918                         // Generate random hashed string
 919                         $SURFBAR_CACHE['salt'] = sha1(GEN_PASS(255));
 920                         //DEBUG_LOG(__FUNCTION__, __LINE__, "newSalt=".SURFBAR_GET_SALT()."", false);
 921                 } else {
 922                         // Use this as salt!
 923                         $SURFBAR_CACHE['salt'] = $salt;
 924                         //DEBUG_LOG(__FUNCTION__, __LINE__, "oldSalt=".SURFBAR_GET_SALT()."", false);
 925                 }
 926
 927                 // ... and now the validation code
 928                 $valCode = GEN_RANDOM_CODE($length, sha1(SURFBAR_GET_SALT().":".$urlId), $GLOBALS['userid']);
 929                 //DEBUG_LOG(__FUNCTION__, __LINE__, "valCode={$valCode}", false);
 930         } // END - while
 931
 932         // Hash it with md5() and salt it with the random string
 933         $hashedCode = generateHash(md5($valCode), SURFBAR_GET_SALT());
 934
 935         // Finally encrypt it PGP-like and return it
 936         $valHashedCode = generatePassString($hashedCode);
 937
 938         // Return hashed value
 939         //DEBUG_LOG(__FUNCTION__, __LINE__, "finalValCode={$valHashedCode}", false);
 940         return $valHashedCode;
 941 }
 942 // Check validation code
 943 function SURFBAR_CHECK_VALIDATION_CODE ($urlId, $check, $salt) {
 944         global $SURFBAR_CACHE;
 945
 946         // Secure id number
 947         $urlId = bigintval($urlId);
 948
 949         // Now generate the code again
 950         $code = SURFBAR_GENERATE_VALIDATION_CODE($urlId, $salt);
 951
 952         // Return result of checking hashes and salts
 953         //DEBUG_LOG(__FUNCTION__, __LINE__, "---".$code."|".$check."---", false);
 954         //DEBUG_LOG(__FUNCTION__, __LINE__, "+++".$salt."|".SURFBAR_GET_DATA('last_salt')."+++", false);
 955         return (($code == $check) && ($salt == SURFBAR_GET_DATA('last_salt')));
 956 }
 957 // Lockdown the userid/id combination (reload lock)
 958 function SURFBAR_LOCKDOWN_ID ($urlId) {
 959         //* DEBUG: */ print "LOCK!");
 960         ///* DEBUG: */ return;
 961         // Just add it to the database
 962         SQL_QUERY_ESC("INSERT INTO "._MYSQL_PREFIX."_surfbar_locks (userid, url_id) VALUES (%s, %s)",
 963                 array($GLOBALS['userid'], bigintval($urlId)), __FILE__, __LINE__);
 964
 965         // Remove the salt from database
 966         SQL_QUERY_ESC("DELETE LOW_PRIORITY FROM "._MYSQL_PREFIX."_surfbar_salts WHERE url_id=%s AND userid=%s LIMIT 1",
 967                 array(bigintval($urlId), $GLOBALS['userid']), __FILE__, __LINE__);
 968 }
 969 // Pay points to the user and remove it from the sender
 970 function SURFBAR_PAY_POINTS ($urlId) {
 971         // Remove it from the URL owner
 972         //DEBUG_LOG(__FUNCTION__, __LINE__, "uid=".SURFBAR_GET_USERID().",costs=".SURFBAR_GET_COSTS()."", false);
 973         if (SURFBAR_GET_USERID() > 0) {
 974                 SUB_POINTS("surfbar", SURFBAR_GET_USERID(), SURFBAR_GET_COSTS());
 975         } // END - if
 976
 977         // Book it to the user
 978         //DEBUG_LOG(__FUNCTION__, __LINE__, "uid=".$GLOBALS['userid'].",reward=".SURFBAR_GET_REWARD()."", false);
 979         ADD_POINTS_REFSYSTEM("surfbar", $GLOBALS['userid'], SURFBAR_GET_DATA('reward'));
 980 }
 981 // Updates the statistics of current URL/userid
 982 function SURFBAR_UPDATE_INSERT_STATS_RECORD () {
 983         global $_CONFIG;
 984
 985         // Init add
 986         $ADD = "";
 987
 988         // Get allowed views
 989         $allowed = SURFBAR_GET_ALLOWED_VIEWS();
 990
 991         // Do we have a limit?
 992         if ($allowed > 0) {
 993                 // Then count views_max down!
 994                 $ADD .= ",views_max=views_max-1";
 995         } // END - if
 996
 997         // Update URL stats
 998         SQL_QUERY_ESC("UPDATE "._MYSQL_PREFIX."_surfbar_urls SET views_total=views_total+1".$ADD." WHERE id=%s LIMIT 1",
 999                 array(SURFBAR_GET_ID()), __FILE__, __LINE__);
1000
1001         // Update the stats entry
1002         SQL_QUERY_ESC("UPDATE "._MYSQL_PREFIX."_surfbar_stats SET count=count+1 WHERE userid=%s AND url_id=%s LIMIT 1",
1003                 array($GLOBALS['userid'], SURFBAR_GET_ID()), __FILE__, __LINE__);
1004
1005         // Was that update okay?
1006         if (SQL_AFFECTEDROWS() < 1) {
1007                 // No, then insert entry
1008                 SQL_QUERY_ESC("INSERT INTO "._MYSQL_PREFIX."_surfbar_stats (userid,url_id,count) VALUES (%s,%s,1)",
1009                         array($GLOBALS['userid'], SURFBAR_GET_ID()), __FILE__, __LINE__);
1010         } // END - if
1011
1012         // Update total/daily/weekly/monthly counter
1013         $_CONFIG['surfbar_total_counter']++;
1014         $_CONFIG['surfbar_daily_counter']++;
1015         $_CONFIG['surfbar_weekly_counter']++;
1016         $_CONFIG['surfbar_monthly_counter']++;
1017
1018         // Update config as well
1019         UPDATE_CONFIG(array("surfbar_total_counter", "surfbar_daily_counter", "surfbar_weekly_counter", "surfbar_monthly_counter"), array(1,1,1,1), "+");
1020 }
1021 // Update the salt for validation and statistics
1022 function SURFBAR_UPDATE_SALT_STATS () {
1023         // Update statistics record
1024         SURFBAR_UPDATE_INSERT_STATS_RECORD();
1025
1026         // Simply store the salt from cache away in database...
1027         SQL_QUERY_ESC("UPDATE "._MYSQL_PREFIX."_surfbar_salts SET last_salt='%s' WHERE url_id=%s AND userid=%s LIMIT 1",
1028                 array(SURFBAR_GET_SALT(), SURFBAR_GET_ID(), $GLOBALS['userid']), __FILE__, __LINE__);
1029
1030         // Debug message
1031         //DEBUG_LOG(__FUNCTION__, __LINE__, "salt=".SURFBAR_GET_SALT().",id=".SURFBAR_GET_ID().",uid=".$GLOBALS['userid']."", false);
1032
1033         // Was that okay?
1034         if (SQL_AFFECTEDROWS() < 1) {
1035                 // Insert missing entry!
1036                 SQL_QUERY_ESC("INSERT INTO "._MYSQL_PREFIX."_surfbar_salts (url_id,userid,last_salt) VALUES (%s, %s, '%s')",
1037                         array(SURFBAR_GET_ID(), $GLOBALS['userid'], SURFBAR_GET_SALT()), __FILE__, __LINE__);
1038         } // END - if
1039
1040         // Debug message
1041         //DEBUG_LOG(__FUNCTION__, __LINE__, "affectedRows=".SQL_AFFECTEDROWS()."", false);
1042
1043         // Return if the update was okay
1044         return (SQL_AFFECTEDROWS() == 1);
1045 }
1046 // Check if the reload lock is active for given id
1047 function SURFBAR_CHECK_RELOAD_LOCK ($urlId) {
1048         //DEBUG_LOG(__FUNCTION__, __LINE__, "id={$urlId}", false);
1049         // Ask the database
1050         $result = SQL_QUERY_ESC("SELECT COUNT(id) AS cnt
1051 FROM "._MYSQL_PREFIX."_surfbar_locks
1052 WHERE userid=%s AND url_id=%s AND (UNIX_TIMESTAMP() - ".SURFBAR_GET_DATA('surf_lock').") < UNIX_TIMESTAMP(last_surfed)
1053 ORDER BY last_surfed ASC
1054 LIMIT 1",
1055                 array($GLOBALS['userid'], bigintval($urlId)), __FILE__, __LINE__
1056         );
1057
1058         // Fetch counter
1059         list($cnt) = SQL_FETCHROW($result);
1060
1061         // Free result
1062         SQL_FREERESULT($result);
1063
1064         // Return check
1065         //DEBUG_LOG(__FUNCTION__, __LINE__, "cnt={$cnt},".SURFBAR_GET_DATA('surf_lock')."", false);
1066         return ($cnt == 1);
1067 }
1068 // Determine which user hash no more points left
1069 function SURFBAR_DETERMINE_DEPLETED_USERIDS ($limit=0) {
1070         // Init array
1071         $UIDs = array(
1072                 'uid'      => array(),
1073                 'points'   => array(),
1074                 'notified' => array(),
1075         );
1076
1077         // Do we have a current user id?
1078         if ((IS_MEMBER()) && ($limit == 0)) {
1079                 // Then add this as well
1080                 $UIDs['uid'][$GLOBALS['userid']]      = $GLOBALS['userid'];
1081                 $UIDs['points'][$GLOBALS['userid']]   = GET_TOTAL_DATA($GLOBALS['userid'], "user_points", "points") - GET_TOTAL_DATA($GLOBALS['userid'], "user_data", "used_points");
1082                 $UIDs['notified'][$GLOBALS['userid']] = 0;
1083
1084                 // Get all userid except logged in one
1085                 $result = SQL_QUERY_ESC("SELECT u.userid, UNIX_TIMESTAMP(d.surfbar_low_notified) AS notified
1086 FROM "._MYSQL_PREFIX."_surfbar_urls AS u
1087 INNER JOIN "._MYSQL_PREFIX."_user_data AS d
1088 ON u.userid=d.userid
1089 WHERE u.userid NOT IN (%s,0) AND u.status='ACTIVE'
1090 GROUP BY u.userid
1091 ORDER BY u.userid ASC",
1092                         array($GLOBALS['userid']), __FILE__, __LINE__);
1093         } else {
1094                 // Get all userid
1095                 $result = SQL_QUERY("SELECT u.userid, UNIX_TIMESTAMP(d.surfbar_low_notified) AS notified
1096 FROM "._MYSQL_PREFIX."_surfbar_urls AS u
1097 INNER JOIN "._MYSQL_PREFIX."_user_data AS d
1098 ON u.userid=d.userid
1099 WHERE u.status='ACTIVE'
1100 GROUP BY u.userid
1101 ORDER BY u.userid ASC", __FILE__, __LINE__);
1102         }
1103
1104         // Load all userid
1105         while (list($uid, $notified) = SQL_FETCHROW($result)) {
1106                 // Get total points
1107                 $points = GET_TOTAL_DATA($uid, "user_points", "points") - GET_TOTAL_DATA($uid, "user_data", "used_points");
1108                 //DEBUG_LOG(__FUNCTION__, __LINE__, "uid={$uid},points={$points}", false);
1109
1110                 // Shall we add this to ignore?
1111                 if ($points <= $limit) {
1112                         // Ignore this one!
1113                         //DEBUG_LOG(__FUNCTION__, __LINE__, "uid={$uid} has depleted points amount!", false);
1114                         $UIDs['uid'][$uid] = $uid;
1115                         $UIDs['points'][$uid] = $points;
1116                         $UIDs['notified'][$uid] = $notified;
1117                 } // END - if
1118         } // END - while
1119
1120         // Free result
1121         SQL_FREERESULT($result);
1122
1123         // Debug message
1124         //DEBUG_LOG(__FUNCTION__, __LINE__, "UIDs::count=".count($UIDs)." (with own userid=".$GLOBALS['userid'].")", false);
1125
1126         // Return result
1127         return $UIDs;
1128 }
1129 // Determine how many users are Online in surfbar
1130 function SURFBAR_DETERMINE_TOTAL_ONLINE () {
1131         global $_CONFIG;
1132
1133         // Count all users in surfbar modue and return the value
1134         $result = SQL_QUERY_ESC("SELECT id
1135 FROM "._MYSQL_PREFIX."_surfbar_stats
1136 WHERE (UNIX_TIMESTAMP() - UNIX_TIMESTAMP(last_online)) <= %s
1137 GROUP BY userid",
1138                 array($_CONFIG['online_timeout']), __FILE__, __LINE__);
1139
1140         // Fetch count
1141         $cnt = SQL_NUMROWS($result);
1142
1143         // Free result
1144         SQL_FREERESULT($result);
1145
1146         // Return result
1147         return $cnt;
1148 }
1149 // Determine waiting time for one URL
1150 function SURFBAR_DETERMINE_WAIT_TIME () {
1151         global $_CONFIG;
1152
1153         // Static time is default
1154         $time = $_CONFIG['surfbar_static_time'];
1155
1156         // Which payment model do we have?
1157         if ($_CONFIG['surfbar_pay_model'] == "DYNAMIC") {
1158                 // "Calculate" dynamic time
1159                 $time += SURFBAR_CALCULATE_DYNAMIC_ADD();
1160         } // END - if
1161
1162         // Return value
1163         return $time;
1164 }
1165 // Changes the status of an URL from given to other
1166 function SURFBAR_CHANGE_STATUS ($urlId, $prevStatus, $newStatus, $data=array()) {
1167         global $_CONFIG;
1168
1169         // Make new status always lower-case
1170         $newStatus = strtolower($newStatus);
1171
1172         // Get URL data for status comparison if missing
1173         if ((!is_array($data)) || (count($data) == 0)) {
1174                 // Fetch missing URL data
1175                 $data = SURFBAR_GET_URL_DATA($urlId);
1176         } // END - if
1177
1178         // Is the new status set?
1179         if ((!is_string($newStatus)) || (empty($newStatus))) {
1180                 // Abort here, but fine!
1181                 return true;
1182         } // END - if
1183
1184         // Is the status like prevStatus is saying?
1185         if ($data[$urlId]['status'] != $prevStatus) {
1186                 // No, then abort here
1187                 return false;
1188         } // END - if
1189
1190
1191         // Update the status now
1192         // ---------- Comment out for debugging/developing member actions! ---------
1193         //SQL_QUERY_ESC("UPDATE "._MYSQL_PREFIX."_surfbar_urls SET status='%s' WHERE id=%s LIMIT 1",
1194         //      array($newStatus, bigintval($urlId)), __FILE__, __LINE__);
1195         // ---------- Comment out for debugging/developing member actions! ---------
1196
1197         // Was that fine?
1198         if (SQL_AFFECTEDROWS() != 1) {
1199                 // No, something went wrong
1200                 return false;
1201         } // END - if
1202
1203         // Prepare content for notification routines
1204         $data[$urlId]['uid']         = $data[$urlId]['userid'];
1205         $data[$urlId]['frametester'] = FRAMETESTER($data[$urlId]['url']);
1206         $data[$urlId]['reward']      = TRANSLATE_COMMA($_CONFIG['surfbar_static_reward']);
1207         $data[$urlId]['costs']       = TRANSLATE_COMMA($_CONFIG['surfbar_static_costs']);
1208
1209         // Send admin notification
1210         SURFBAR_NOTIFY_ADMIN("url_{$newStatus}", $data[$urlId]);
1211
1212         // Send user notification
1213         SURFBAR_NOTIFY_USER("url_{$newStatus}", $data[$urlId]);
1214
1215         // All done!
1216         return true;
1217 }
1218 // Calculate minimum value for dynamic payment model
1219 function SURFBAR_CALCULATE_DYNAMIC_MIN_VALUE () {
1220         global $_CONFIG;
1221
1222         // Addon is zero by default
1223         $addon = 0;
1224
1225         // Percentage part
1226         $percent = abs(log($_CONFIG['surfbar_dynamic_percent'] / 100 + 1));
1227
1228         // Get total users
1229         $totalUsers = GET_TOTAL_DATA("CONFIRMED", "user_data", "userid", "status", true);
1230
1231         // Get online users
1232         $onlineUsers = SURFBAR_DETERMINE_TOTAL_ONLINE();
1233
1234         // Calculate addon
1235         $addon += abs(log($onlineUsers / $totalUsers + 1) * $percent * $totalUsers);
1236
1237         // Get total URLs
1238         $totalUrls = SURFBAR_GET_TOTAL_URLS("ACTIVE", "0");
1239
1240         // Get user's total URLs
1241         $userUrls = SURFBAR_GET_TOTAL_USER_URLS(0, "ACTIVE");
1242
1243         // Calculate addon
1244         if ($totalUrls > 0) {
1245                 $addon += abs(log($userUrls / $totalUrls + 1) * $percent * $totalUrls);
1246         } else {
1247                 $addon += abs(log($userUrls / 1 + 1) * $percent * $totalUrls);
1248         }
1249
1250         // Return addon
1251         return $addon;
1252 }
1253 // Calculate maximum value for dynamic payment model
1254 function SURFBAR_CALCULATE_DYNAMIC_MAX_VALUE () {
1255         global $_CONFIG;
1256
1257         // Addon is zero by default
1258         $addon = 0;
1259
1260         // Maximum value
1261         $max = log(2);
1262
1263         // Percentage part
1264         $percent = abs(log($_CONFIG['surfbar_dynamic_percent'] / 100 + 1));
1265
1266         // Get total users
1267         $totalUsers = GET_TOTAL_DATA("CONFIRMED", "user_data", "userid", "status", true);
1268
1269         // Calculate addon
1270         $addon += abs($max * $percent * $totalUsers);
1271
1272         // Get total URLs
1273         $totalUrls = SURFBAR_GET_TOTAL_URLS("ACTIVE", "0");
1274
1275         // Calculate addon
1276         $addon += abs($max * $percent * $totalUrls);
1277
1278         // Return addon
1279         return $addon;
1280 }
1281 // Calculate dynamic lock
1282 function SURFBAR_CALCULATE_DYNAMIC_LOCK () {
1283         global $_CONFIG;
1284
1285         // Default lock is 30 seconds
1286         $addon = 30;
1287
1288         // Get online users
1289         $onlineUsers = SURFBAR_DETERMINE_TOTAL_ONLINE();
1290
1291         // Calculate lock
1292         $addon = abs(log($onlineUsers / $addon + 1));
1293
1294         // Return value
1295         return $addon;
1296 }
1297 // "Getter" for lock ids array
1298 function SURFBAR_GET_LOCK_IDS () {
1299         // Prepare some arrays
1300         $IDs = array();
1301         $USE = array();
1302         $ignored = array();
1303
1304         // Get all id from locks within the timestamp
1305         $result = SQL_QUERY_ESC("SELECT id, url_id, UNIX_TIMESTAMP(last_surfed) AS last
1306 FROM
1307         "._MYSQL_PREFIX."_surfbar_locks
1308 WHERE
1309         userid=%s
1310 ORDER BY
1311         id ASC", array($GLOBALS['userid']),
1312                 __FILE__, __LINE__);
1313
1314         // Load all entries
1315         while (list($lid, $url, $last) = SQL_FETCHROW($result)) {
1316                 // Debug message
1317                 //DEBUG_LOG(__FUNCTION__, __LINE__, "next - lid={$lid},url={$url},rest=".(time() - $last)."/".SURFBAR_GET_DATA('surf_lock')."", false);
1318
1319                 // Skip entries that are too old
1320                 if (($last > (time() - SURFBAR_GET_DATA('surf_lock'))) && (!in_array($url, $ignored))) {
1321                         // Debug message
1322                         //DEBUG_LOG(__FUNCTION__, __LINE__, "okay - lid={$lid},url={$url},last={$last}", false);
1323
1324                         // Add only if missing or bigger
1325                         if ((!isset($IDs[$url])) || ($IDs[$url] > $last)) {
1326                                 // Debug message
1327                                 //DEBUG_LOG(__FUNCTION__, __LINE__, "ADD - lid={$lid},url={$url},last={$last}", false);
1328
1329                                 // Add this ID
1330                                 $IDs[$url] = $last;
1331                                 $USE[$url] = $lid;
1332                         } // END - if
1333                 } else {
1334                         // Debug message
1335                         //DEBUG_LOG(__FUNCTION__, __LINE__, "ignore - lid={$lid},url={$url},last={$last}", false);
1336
1337                         // Ignore these old entries!
1338                         $ignored[] = $url;
1339                         unset($IDs[$url]);
1340                         unset($USE[$url]);
1341                 }
1342         } // END - while
1343
1344         // Free result
1345         SQL_FREERESULT($result);
1346
1347         // Return array
1348         return $USE;
1349 }
1350 // "Getter" for maximum random number
1351 function SURFBAR_GET_MAX_RANDOM ($UIDs, $ADD) {
1352         global $_CONFIG;
1353         // Count max availabe entries
1354         $result = SQL_QUERY("SELECT sbu.id AS cnt
1355 FROM "._MYSQL_PREFIX."_surfbar_urls AS sbu
1356 LEFT JOIN "._MYSQL_PREFIX."_surfbar_salts AS sbs
1357 ON sbu.id=sbs.url_id
1358 LEFT JOIN "._MYSQL_PREFIX."_surfbar_locks AS l
1359 ON sbu.id=l.url_id
1360 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."
1361 GROUP BY sbu.id", __FILE__, __LINE__);
1362
1363         // Log last query
1364         //DEBUG_LOG(__FUNCTION__, __LINE__, "lastQuery=".$_CONFIG['db_last_query']."|numRows=".SQL_NUMROWS($result)."|Affected=".SQL_AFFECTEDROWS()."", false);
1365
1366         // Fetch max rand
1367         $maxRand = SQL_NUMROWS($result);
1368
1369         // Free result
1370         SQL_FREERESULT($result);
1371
1372         // Return value
1373         return $maxRand;
1374 }
1375 // Load all URLs of the current user and return it as an array
1376 function SURFBAR_GET_USER_URLS () {
1377         // Init array
1378         $URLs = array();
1379
1380         // Begin the query
1381         $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
1382 FROM "._MYSQL_PREFIX."_surfbar_urls AS u
1383 WHERE u.userid=%s AND u.status != 'DELETED'
1384 ORDER BY u.id ASC",
1385                 array($GLOBALS['userid']), __FILE__, __LINE__);
1386
1387         // Are there entries?
1388         if (SQL_NUMROWS($result) > 0) {
1389                 // Load all rows
1390                 while ($row = SQL_FETCHARRAY($result)) {
1391                         // Add the row
1392                         $URLs[$row['id']] = $row;
1393                 } // END - while
1394         } // END - if
1395
1396         // Free result
1397         SQL_FREERESULT($result);
1398
1399         // Return the array
1400         return $URLs;
1401 }
1402 // "Getter" for member action array for given status
1403 function SURFBAR_GET_ACTION_ARRAY ($status) {
1404         // Init array
1405         $returnArray = array();
1406
1407         // Get all assigned actions
1408         $result = SQL_QUERY_ESC("SELECT action FROM "._MYSQL_PREFIX."_surfbar_actions WHERE status='%s' ORDER BY id ASC",
1409                 array($status), __FILE__, __LINE__);
1410
1411         // Some entries there?
1412         if (SQL_NUMROWS($result) > 0) {
1413                 // Load all actions
1414                 while (list($action) = SQL_FETCHROW($result)) {
1415                         $returnArray[] = $action;
1416                 } // END - if
1417         } // END - if
1418
1419         // Free result
1420         SQL_FREERESULT($result);
1421
1422         // Return result
1423         return $returnArray;
1424 }
1425 // Reload to configured stop page
1426 function SURFBAR_RELOAD_TO_STOP_PAGE($page="stop") {
1427         global $_CONFIG;
1428
1429         // Internal or external?
1430         if (($_CONFIG['surfbar_pause_mode'] == "INTERNAL") || (empty($_CONFIG['surfbar_pause_url']))) {
1431                 // Reload to internal page
1432                 LOAD_URL("surfbar.php?frame=".$page);
1433         } else {
1434                 // Reload to external page
1435                 LOAD_URL($_CONFIG['surfbar_pause_url']);
1436         }
1437 }
1438
1439 // Determine next id for surfbar or get data for given id, always call this before you call other
1440 // getters below this function!!!
1441 function SURFBAR_DETERMINE_NEXT_ID ($urlId = 0) {
1442         global $SURFBAR_CACHE, $_CONFIG;
1443
1444         // Default is no id and no random number
1445         $nextId = 0;
1446         $randNum = 0;
1447
1448         // Is the ID set?
1449         if ($urlId == 0) {
1450                 // Get array with lock ids
1451                 $USE = SURFBAR_GET_LOCK_IDS();
1452
1453                 // Shall we add some URL ids to ignore?
1454                 $ADD = "";
1455                 if (count($USE) > 0) {
1456                         // Ignore some!
1457                         $ADD = " AND sbu.id NOT IN (";
1458                         foreach ($USE as $url_id => $lid) {
1459                                 // Add URL id
1460                                 $ADD .= $url_id.",";
1461                         } // END - foreach
1462
1463                         // Add closing bracket
1464                         $ADD = substr($ADD, 0, -1) . ")";
1465                 } // END - if
1466
1467                 // Determine depleted user account
1468                 $UIDs = SURFBAR_DETERMINE_DEPLETED_USERIDS();
1469
1470                 // Get maximum randomness factor
1471                 $maxRand = SURFBAR_GET_MAX_RANDOM($UIDs['uid'], $ADD);
1472
1473                 // If more than one URL can be called generate the random number!
1474                 if ($maxRand > 1) {
1475                         // Generate random number
1476                         $randNum = mt_rand(0, ($maxRand - 1));
1477                 } // END - if
1478
1479                 // And query the database
1480                 //DEBUG_LOG(__FUNCTION__, __LINE__, "randNum={$randNum},maxRand={$maxRand},surfLock=".SURFBAR_GET_DATA('surf_lock')."", false);
1481                 $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
1482 FROM "._MYSQL_PREFIX."_surfbar_urls AS sbu
1483 LEFT JOIN "._MYSQL_PREFIX."_surfbar_salts AS sbs
1484 ON sbu.id=sbs.url_id
1485 LEFT JOIN "._MYSQL_PREFIX."_surfbar_locks AS l
1486 ON sbu.id=l.url_id
1487 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."
1488 GROUP BY sbu.id
1489 ORDER BY l.last_surfed ASC, sbu.id ASC
1490 LIMIT %s,1",
1491                         array($randNum), __FILE__, __LINE__
1492                 );
1493         } else {
1494                 // Get data from specified id number
1495                 $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
1496 FROM "._MYSQL_PREFIX."_surfbar_urls AS sbu
1497 LEFT JOIN "._MYSQL_PREFIX."_surfbar_salts AS sbs
1498 ON sbu.id=sbs.url_id
1499 LEFT JOIN "._MYSQL_PREFIX."_surfbar_locks AS l
1500 ON sbu.id=l.url_id
1501 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))
1502 LIMIT 1",
1503                         array($GLOBALS['userid'], bigintval($urlId)), __FILE__, __LINE__
1504                 );
1505         }
1506
1507         // Is there an id number?
1508         //DEBUG_LOG(__FUNCTION__, __LINE__, "lastQuery=".$_CONFIG['db_last_query']."|numRows=".SQL_NUMROWS($result)."|Affected=".SQL_AFFECTEDROWS()."", false);
1509         if (SQL_NUMROWS($result) == 1) {
1510                 // Load/cache data
1511                 //DEBUG_LOG(__FUNCTION__, __LINE__, "count(".count($SURFBAR_CACHE).") - BEFORE", false);
1512                 $SURFBAR_CACHE = merge_array($SURFBAR_CACHE, SQL_FETCHARRAY($result));
1513                 //DEBUG_LOG(__FUNCTION__, __LINE__, "count(".count($SURFBAR_CACHE).") - AFTER", false);
1514
1515                 // Determine waiting time
1516                 $SURFBAR_CACHE['time'] = SURFBAR_DETERMINE_WAIT_TIME();
1517
1518                 // Is the last salt there?
1519                 if (is_null($SURFBAR_CACHE['last_salt'])) {
1520                         // Then repair it wit the static!
1521                         //DEBUG_LOG(__FUNCTION__, __LINE__, "last_salt - FIXED!", false);
1522                         $SURFBAR_CACHE['last_salt'] = "";
1523                 } // END - if
1524
1525                 // Fix missing last_surfed
1526                 if ((!isset($SURFBAR_CACHE['last_surfed'])) || (is_null($SURFBAR_CACHE['last_surfed']))) {
1527                         // Fix it here
1528                         //DEBUG_LOG(__FUNCTION__, __LINE__, "last_surfed - FIXED!", false);
1529                         $SURFBAR_CACHE['last_surfed'] = 0;
1530                 } // END - if
1531
1532                 // Get base/fixed reward and costs
1533                 $SURFBAR_CACHE['reward'] = SURFBAR_DETERMINE_REWARD();
1534                 $SURFBAR_CACHE['costs']  = SURFBAR_DETERMINE_COSTS();
1535                 //DEBUG_LOG(__FUNCTION__, __LINE__, "BASE/STATIC - reward=".SURFBAR_GET_REWARD()."|costs=".SURFBAR_GET_COSTS()."", false);
1536
1537                 // Only in dynamic model add the dynamic bonus!
1538                 if ($_CONFIG['surfbar_pay_model'] == "DYNAMIC") {
1539                         // Calculate dynamic reward/costs and add it
1540                         $SURFBAR_CACHE['reward'] += SURFBAR_CALCULATE_DYNAMIC_ADD();
1541                         $SURFBAR_CACHE['costs']  += SURFBAR_CALCULATE_DYNAMIC_ADD();
1542                         //DEBUG_LOG(__FUNCTION__, __LINE__, "DYNAMIC+ - reward=".SURFBAR_GET_REWARD()."|costs=".SURFBAR_GET_COSTS()."", false);
1543                 } // END - if
1544
1545                 // Now get the id
1546                 $nextId = SURFBAR_GET_ID();
1547         } // END - if
1548
1549         // Free result
1550         SQL_FREERESULT($result);
1551
1552         // Return result
1553         //DEBUG_LOG(__FUNCTION__, __LINE__, "nextId={$nextId}", false);
1554         return $nextId;
1555 }
1556 // -----------------------------------------------------------------------------
1557 // PLEASE DO NOT ADD ANY OTHER FUNCTIONS BELOW THIS LINE ELSE THEY "WRAP" THE
1558 // $SURFBAR_CACHE ARRAY!
1559 // -----------------------------------------------------------------------------
1560 // Private getter for data elements
1561 function SURFBAR_GET_DATA ($element) {
1562         global $SURFBAR_CACHE;
1563         //DEBUG_LOG(__FUNCTION__, __LINE__, "element={$element}", false);
1564
1565         // Default is null
1566         $data = null;
1567
1568         // Is the entry there?
1569         if (isset($SURFBAR_CACHE[$element])) {
1570                 // Then take it
1571                 $data = $SURFBAR_CACHE[$element];
1572         } else { // END - if
1573                 print("<pre>");
1574                 print_r($SURFBAR_CACHE);
1575                 debug_print_backtrace();
1576                 die("</pre>");
1577         }
1578
1579         // Return result
1580         //DEBUG_LOG(__FUNCTION__, __LINE__, "element[$element]={$data}", false);
1581         return $data;
1582 }
1583 // Getter for reward from cache
1584 function SURFBAR_GET_REWARD () {
1585         // Get data element and return its contents
1586         return SURFBAR_GET_DATA('reward');
1587 }
1588 // Getter for costs from cache
1589 function SURFBAR_GET_COSTS () {
1590         // Get data element and return its contents
1591         return SURFBAR_GET_DATA('costs');
1592 }
1593 // Getter for URL from cache
1594 function SURFBAR_GET_URL () {
1595         // Get data element and return its contents
1596         return SURFBAR_GET_DATA('url');
1597 }
1598 // Getter for salt from cache
1599 function SURFBAR_GET_SALT () {
1600         // Get data element and return its contents
1601         return SURFBAR_GET_DATA('salt');
1602 }
1603 // Getter for id from cache
1604 function SURFBAR_GET_ID () {
1605         // Get data element and return its contents
1606         return SURFBAR_GET_DATA('id');
1607 }
1608 // Getter for userid from cache
1609 function SURFBAR_GET_USERID () {
1610         // Get data element and return its contents
1611         return SURFBAR_GET_DATA('userid');
1612 }
1613 // Getter for user reload locks
1614 function SURFBAR_GET_USER_RELOAD_LOCK () {
1615         // Get data element and return its contents
1616         return SURFBAR_GET_DATA('user_locks');
1617 }
1618 // Getter for reload time
1619 function SURFBAR_GET_RELOAD_TIME () {
1620         // Get data element and return its contents
1621         return SURFBAR_GET_DATA('time');
1622 }
1623 // Getter for allowed views
1624 function SURFBAR_GET_ALLOWED_VIEWS () {
1625         // Get data element and return its contents
1626         return SURFBAR_GET_DATA('views_allowed');
1627 }
1628 //
1629 ?>