nucleus/libs/MANAGER.php

   1 <?php\r
   2 /*\r
   3  * Nucleus: PHP/MySQL Weblog CMS (http://nucleuscms.org/)\r
   4  * Copyright (C) 2002-2009 The Nucleus Group\r
   5  *\r
   6  * This program is free software; you can redistribute it and/or\r
   7  * modify it under the terms of the GNU General Public License\r
   8  * as published by the Free Software Foundation; either version 2\r
   9  * of the License, or (at your option) any later version.\r
  10  * (see nucleus/documentation/index.html#license for more info)\r
  11  */\r
  12 /**\r
  13  * This class makes sure each item/weblog/comment object gets requested from\r
  14  * the database only once, by keeping them in a cache. The class also acts as\r
  15  * a dynamic classloader, loading classes _only_ when they are first needed,\r
  16  * hoping to diminish execution time\r
  17  *\r
  18  * The class is a singleton, meaning that there will be only one object of it\r
  19  * active at all times. The object can be requested using Manager::instance()\r
  20  *\r
  21  * @license http://nucleuscms.org/license.txt GNU General Public License\r
  22  * @copyright Copyright (C) 2002-2009 The Nucleus Group\r
  23  * @version $Id: MANAGER.php 1731 2012-04-08 15:10:35Z sakamocchi $\r
  24  */\r
  25 class Manager\r
  26 {\r
  27         /**\r
  28          * Cached ITEM, BLOG, PLUGIN, KARMA and MEMBER objects. When these objects are requested\r
  29          * through the global $manager object (getItem, getBlog, ...), only the first call\r
  30          * will create an object. Subsequent calls will return the same object.\r
  31          *\r
  32          * The $items, $blogs, ... arrays map an id to an object (for plugins, the name is used\r
  33          * rather than an ID)\r
  34          */\r
  35         private $items;\r
  36         private $blogs;\r
  37         private $plugins;\r
  38         private $karma;\r
  39         private $templates;\r
  40         private $members;\r
  41         \r
  42         /**\r
  43          * cachedInfo to avoid repeated SQL queries (see pidInstalled/pluginInstalled/getPidFromName)\r
  44          * e.g. which plugins exists?\r
  45          *\r
  46          * $cachedInfo['installedPlugins'] = array($pid -> $name)\r
  47          */\r
  48         private $cachedInfo;\r
  49         \r
  50         /**\r
  51          * The plugin subscriptionlist\r
  52          *\r
  53          * The subcription array has the following structure\r
  54          *              $subscriptions[$EventName] = array containing names of plugin classes to be\r
  55          *                                                                       notified when that event happens\r
  56          * \r
  57          * NOTE: this is referred by Comments::addComment() for spamcheck API\r
  58          * TODO: we should add new methods to get this\r
  59          */\r
  60         public $subscriptions;\r
  61         \r
  62         /**\r
  63          * Ticket functions. These are uses by the admin area to make it impossible to simulate certain GET/POST\r
  64          * requests. tickets are user specific\r
  65          */\r
  66         private $currentRequestTicket = '';\r
  67         \r
  68         /**\r
  69          * Returns the only instance of this class. Creates the instance if it\r
  70          * does not yet exists. Users should use this function as\r
  71          * $manager =& Manager::instance(); to get a reference to the object\r
  72          * instead of a copy\r
  73          */\r
  74         public function &instance()\r
  75         {\r
  76                 static $instance = array();\r
  77                 if ( empty($instance) )\r
  78                 {\r
  79                         $instance[0] = new Manager();\r
  80                 }\r
  81                 return $instance[0];\r
  82         }\r
  83         \r
  84         /**\r
  85          * The constructor of this class initializes the object caches\r
  86          */\r
  87         public function __construct()\r
  88         {\r
  89                 $this->items = array();\r
  90                 $this->blogs = array();\r
  91                 $this->plugins = array();\r
  92                 $this->karma = array();\r
  93                 $this->parserPrefs = array();\r
  94                 $this->cachedInfo = array();\r
  95                 return;\r
  96         }\r
  97         \r
  98         /**\r
  99          * Returns the requested item object. If it is not in the cache, it will\r
 100          * first be loaded and then placed in the cache.\r
 101          * Intended use: $item =& $manager->getItem(1234, 0, 0)\r
 102          */\r
 103         public function &getItem($itemid, $allowdraft, $allowfuture)\r
 104         {\r
 105                 $item =& $this->items[$itemid];\r
 106                 \r
 107                 /* confirm to cached */\r
 108                 if ( !array_key_exists($itemid, $this->items) )\r
 109                 {\r
 110                         $this->loadClass('ITEM');\r
 111                         $item = Item::getitem($itemid, $allowdraft, $allowfuture);\r
 112                         $this->items[$itemid] = $item;\r
 113                 }\r
 114                 \r
 115                 $item =& $this->items[$itemid];\r
 116                 if ( !$allowdraft && ($item['draft']) )\r
 117                 {\r
 118                         return 0;\r
 119                 }\r
 120                 \r
 121                 $blog =& $this->getBlog($item['blogid']);\r
 122                 if ( !$allowfuture && ($item['timestamp'] > $blog->getCorrectTime()) )\r
 123                 {\r
 124                         return 0;\r
 125                 }\r
 126                 \r
 127                 return $item;\r
 128         }\r
 129         \r
 130         /**\r
 131          * Loads a class if it has not yet been loaded\r
 132          */\r
 133         public function loadClass($name)\r
 134         {\r
 135                 $this->_loadClass($name, $name . '.php');\r
 136                 return;\r
 137         }\r
 138         \r
 139         /**\r
 140          * Checks if an item exists\r
 141          */\r
 142         public function existsItem($id,$future,$draft)\r
 143         {\r
 144                 $this->_loadClass('ITEM','ITEM.php');\r
 145                 return Item::exists($id,$future,$draft);\r
 146         }\r
 147         \r
 148         /**\r
 149          * Checks if a category exists\r
 150          */\r
 151         public function existsCategory($id)\r
 152         {\r
 153                 return (DB::getValue('SELECT COUNT(*) as result FROM '.sql_table('category').' WHERE catid='.intval($id)) > 0);\r
 154         }\r
 155         \r
 156         /**\r
 157          * Returns the blog object for a given blogid\r
 158          */\r
 159         public function &getBlog($blogid)\r
 160         {\r
 161                 $blog =& $this->blogs[$blogid];\r
 162                 \r
 163                 if ( !$blog )\r
 164                 {\r
 165                         // load class if needed\r
 166                         $this->_loadClass('BLOG','BLOG.php');\r
 167                         // load blog object\r
 168                         $blog = new Blog($blogid);\r
 169                         $this->blogs[$blogid] =& $blog;\r
 170                 }\r
 171                 return $blog;\r
 172         }\r
 173         \r
 174         /**\r
 175          * Checks if a blog exists\r
 176          */\r
 177         public function existsBlog($name)\r
 178         {\r
 179                 $this->_loadClass('BLOG','BLOG.php');\r
 180                 return Blog::exists($name);\r
 181         }\r
 182         \r
 183         /**\r
 184          * Checks if a blog id exists\r
 185          */\r
 186         public function existsBlogID($id)\r
 187         {\r
 188                 $this->_loadClass('BLOG','BLOG.php');\r
 189                 return Blog::existsID($id);\r
 190         }\r
 191         \r
 192         /**\r
 193          * Returns a previously read template\r
 194          */\r
 195         public function &getTemplate($templateName)\r
 196         {\r
 197                 $template =& $this->templates[$templateName];\r
 198                 \r
 199                 if ( !$template )\r
 200                 {\r
 201                         $template = Template::read($templateName);\r
 202                         $this->templates[$templateName] =& $template;\r
 203                 }\r
 204                 return $template;\r
 205         }\r
 206         \r
 207         /**\r
 208          * Returns a KARMA object (karma votes)\r
 209          */\r
 210         public function &getKarma($itemid)\r
 211         {\r
 212                 $karma =& $this->karma[$itemid];\r
 213                 \r
 214                 if ( !$karma )\r
 215                 {\r
 216                         // load class if needed\r
 217                         $this->_loadClass('KARMA','KARMA.php');\r
 218                         // create KARMA object\r
 219                         $karma = new Karma($itemid);\r
 220                         $this->karma[$itemid] =& $karma;\r
 221                 }\r
 222                 return $karma;\r
 223         }\r
 224         \r
 225         /**\r
 226          * Returns a MEMBER object\r
 227          */\r
 228         public function &getMember($memberid)\r
 229         {\r
 230                 $mem =& $this->members[$memberid];\r
 231                 \r
 232                 if ( !$mem )\r
 233                 {\r
 234                         // load class if needed\r
 235                         $this->_loadClass('MEMBER','MEMBER.php');\r
 236                         // create MEMBER object\r
 237                         $mem =& Member::createFromID($memberid);\r
 238                         $this->members[$memberid] =& $mem;\r
 239                 }\r
 240                 return $mem;\r
 241         }\r
 242         \r
 243         /**\r
 244          * Set the global parser preferences\r
 245          */\r
 246         public function setParserProperty($name, $value)\r
 247         {\r
 248                 $this->parserPrefs[$name] = $value;\r
 249                 return;\r
 250         }\r
 251         \r
 252         /**\r
 253          * Get the global parser preferences\r
 254          */\r
 255         public function getParserProperty($name)\r
 256         {\r
 257                 return $this->parserPrefs[$name];\r
 258         }\r
 259         \r
 260         /**\r
 261          * A helper function to load a class\r
 262          * \r
 263          *      private\r
 264          */\r
 265         private function _loadClass($name, $filename)\r
 266         {\r
 267                 if ( !class_exists($name) )\r
 268                 {\r
 269                                 global $DIR_LIBS;\r
 270                                 include($DIR_LIBS . $filename);\r
 271                 }\r
 272                 return;\r
 273         }\r
 274         \r
 275         /**\r
 276          * Manager::_loadPlugin()\r
 277          * loading a certain plugin\r
 278          * \r
 279          * @param       string $name plugin name\r
 280          * @return      void\r
 281          */\r
 282         private function _loadPlugin($name)\r
 283         {\r
 284                 global $DIR_PLUGINS, $MYSQL_HANDLER, $MYSQL_PREFIX;\r
 285                 \r
 286                 if ( class_exists($name) )\r
 287                 {\r
 288                         return;\r
 289                 }\r
 290                 \r
 291                 $fileName = "{$DIR_PLUGINS}{$name}.php";\r
 292                 \r
 293                 if ( !file_exists($fileName) )\r
 294                 {\r
 295                         if ( !defined('_MANAGER_PLUGINFILE_NOTFOUND') )\r
 296                         {\r
 297                                 define('_MANAGER_PLUGINFILE_NOTFOUND', 'Plugin %s was not loaded (File not found)');\r
 298                         }\r
 299                         ActionLog::add(WARNING, sprintf(_MANAGER_PLUGINFILE_NOTFOUND, $name)); \r
 300                         return 0;\r
 301                 }\r
 302                 \r
 303                 // load plugin\r
 304                 include($fileName);\r
 305                 \r
 306                 // check if class exists (avoid errors in eval'd code)\r
 307                 if ( !class_exists($name) )\r
 308                 {\r
 309                         ActionLog::add(WARNING, sprintf(_MANAGER_PLUGINFILE_NOCLASS, $name));\r
 310                         return 0;\r
 311                 }\r
 312                 \r
 313                 // add to plugin array\r
 314                 $this->plugins[$name] = new $name();\r
 315                 \r
 316                 // get plugid\r
 317                 $this->plugins[$name]->setID($this->getPidFromName($name));\r
 318                 \r
 319                 // unload plugin if a prefix is used and the plugin cannot handle this\r
 320                 if ( ($MYSQL_PREFIX != '')\r
 321                   && !$this->plugins[$name]->supportsFeature('SqlTablePrefix') )\r
 322                 {\r
 323                         unset($this->plugins[$name]);\r
 324                         ActionLog::add(WARNING, sprintf(_MANAGER_PLUGINTABLEPREFIX_NOTSUPPORT, $name));\r
 325                         return 0;\r
 326                 }\r
 327                 \r
 328                 // unload plugin if using non-mysql handler and plugin does not support it \r
 329                 if ( (!in_array('mysql',$MYSQL_HANDLER))\r
 330                   && !$this->plugins[$name]->supportsFeature('SqlApi') )\r
 331                 {\r
 332                         unset($this->plugins[$name]);\r
 333                         ActionLog::add(WARNING, sprintf(_MANAGER_PLUGINSQLAPI_NOTSUPPORT, $name));\r
 334                         return 0;\r
 335                 }\r
 336                 \r
 337                 // call init method\r
 338                 $this->plugins[$name]->init();\r
 339                 \r
 340                 return;\r
 341         }\r
 342 \r
 343         /**\r
 344          * Manager:getPlugin()\r
 345          * Returns a PLUGIN object\r
 346          * \r
 347          * @param       string  $name   name of plugin\r
 348          * @return      object  plugin object\r
 349          */\r
 350         public function &getPlugin($name)\r
 351         {\r
 352                 // retrieve the name of the plugin in the right capitalisation\r
 353                 $name = $this->getUpperCaseName ($name);\r
 354                 \r
 355                 // get the plugin       \r
 356                 $plugin =& $this->plugins[$name]; \r
 357                 \r
 358                 if ( !$plugin )\r
 359                 {\r
 360                         // load class if needed\r
 361                         $this->_loadPlugin($name);\r
 362                         $plugin =& $this->plugins[$name];\r
 363                 }\r
 364                 return $plugin;\r
 365         }\r
 366         \r
 367         /**\r
 368          * Manager::pluginLoaded()\r
 369          * Checks if the given plugin IS loaded or not\r
 370          * \r
 371          * @param       string  $name   name of plugin\r
 372          * @return      object  plugin object\r
 373          */\r
 374         public function &pluginLoaded($name)\r
 375         {\r
 376                 $plugin =& $this->plugins[$name];\r
 377                 return $plugin;\r
 378         }\r
 379         \r
 380         /**\r
 381          * Manager::pidLoaded()\r
 382          * \r
 383          * @param       integer $pid    id for plugin\r
 384          * @return      object  plugin object\r
 385          */\r
 386         public function &pidLoaded($pid)\r
 387         {\r
 388                 $plugin=false;\r
 389                 reset($this->plugins);\r
 390                 while ( list($name) = each($this->plugins) )\r
 391                 {\r
 392                         if ( $pid!=$this->plugins[$name]->getId() )\r
 393                         {\r
 394                                 continue;\r
 395                         }\r
 396                         $plugin= & $this->plugins[$name];\r
 397                         break;\r
 398                 }\r
 399                 return $plugin;\r
 400         }\r
 401         \r
 402         /**\r
 403          * Manager::pluginInstalled()\r
 404          * checks if the given plugin IS installed or not\r
 405          * \r
 406          * @param       string  $name   name of plugin\r
 407          * @return      boolean exists or not\r
 408          */\r
 409         public function pluginInstalled($name)\r
 410         {\r
 411                 $this->_initCacheInfo('installedPlugins');\r
 412                 return ($this->getPidFromName($name) != -1);\r
 413         }\r
 414 \r
 415         /**\r
 416          * Manager::pidInstalled()\r
 417          * checks if the given plugin IS installed or not\r
 418          * \r
 419          * @param       integer $pid    id of plugin\r
 420          * @return      boolean exists or not\r
 421          */\r
 422         public function pidInstalled($pid)\r
 423         {\r
 424                 $this->_initCacheInfo('installedPlugins');\r
 425                 return ($this->cachedInfo['installedPlugins'][$pid] != '');\r
 426         }\r
 427         \r
 428         /**\r
 429          * Manager::getPidFromName()\r
 430          * \r
 431          * @param       string  $name   name of plugin\r
 432          * @return      mixed   id for plugin or -1 if not exists\r
 433          */\r
 434         public function getPidFromName($name)\r
 435         {\r
 436                 $this->_initCacheInfo('installedPlugins');\r
 437                 foreach ( $this->cachedInfo['installedPlugins'] as $pid => $pfile )\r
 438                 {\r
 439                         if (strtolower($pfile) == strtolower($name))\r
 440                         {\r
 441                                 return $pid;\r
 442                         }\r
 443                 }\r
 444                 return -1;\r
 445         }\r
 446         \r
 447         /**\r
 448          * Manager::getPluginNameFromPid()\r
 449          * \r
 450          * @param       string  $pid    ID for plugin\r
 451          * @return      string  name of plugin\r
 452          */\r
 453         public function getPluginNameFromPid($pid)\r
 454         {\r
 455                 if ( !array_key_exists($pid, $this->cachedInfo['installedPlugins']) )\r
 456                 {\r
 457                         $query = 'SELECT pfile FROM %s WHERE pid=%d;';\r
 458                         $query = sprintf($query, sql_table('plugin'), (integer) $pid);\r
 459                         return DB::getValue($query);\r
 460                 }\r
 461                 return $this->cachedInfo['installedPlugins'][$pid];\r
 462         }\r
 463         \r
 464         /**\r
 465          * Manager::getUpperCaseName()\r
 466          * Retrieve the name of a plugin in the right capitalisation\r
 467          * \r
 468          * @param       string  $name   name of plugin\r
 469          * @return      string  name according to UpperCamelCase\r
 470          */\r
 471         public function getUpperCaseName ($name)\r
 472         {\r
 473                 $this->_initCacheInfo('installedPlugins');\r
 474                 foreach ( $this->cachedInfo['installedPlugins'] as $pid => $pfile )\r
 475                 {\r
 476                         if ( strtolower($pfile) == strtolower($name) )\r
 477                         {\r
 478                                 return $pfile;\r
 479                         }\r
 480                 }\r
 481                 return -1;\r
 482         }\r
 483         \r
 484         /**\r
 485          * Manager::clearCachedInfo()\r
 486          * \r
 487          * @param       string  $what\r
 488          * @return      void\r
 489          */\r
 490         public function clearCachedInfo($what)\r
 491         {\r
 492                 unset($this->cachedInfo[$what]);\r
 493                 return;\r
 494         }\r
 495         \r
 496         /**\r
 497          * Manager::_initCacheInfo()\r
 498          * Loads some info on the first call only\r
 499          * \r
 500          * @param       string  $what   'installedPlugins'\r
 501          * @return      void\r
 502          */\r
 503         private function _initCacheInfo($what)\r
 504         {\r
 505                 if ( array_key_exists($what, $this->cachedInfo)\r
 506                   && is_array($this->cachedInfo[$what]) )\r
 507                 {\r
 508                         return;\r
 509                 }\r
 510                 \r
 511                 switch ($what)\r
 512                 {\r
 513                         // 'installedPlugins' = array ($pid => $name)\r
 514                         case 'installedPlugins':\r
 515                                 $this->cachedInfo['installedPlugins'] = array();\r
 516                                 $res = DB::getResult('SELECT pid, pfile FROM ' . sql_table('plugin'));\r
 517                                 foreach ( $res as $row )\r
 518                                 {\r
 519                                         $this->cachedInfo['installedPlugins'][$row['pid']] = $row['pfile'];\r
 520                                 }\r
 521                                 break;\r
 522                 }\r
 523                 return;\r
 524         }\r
 525         \r
 526         /**\r
 527          * Manager::notify()\r
 528          * A function to notify plugins that something has happened. Only the plugins\r
 529          * that are subscribed to the event will get notified.\r
 530          * Upon the first call, the list of subscriptions will be fetched from the\r
 531          * database. The plugins itsself will only get loaded when they are first needed\r
 532          *\r
 533          * @param       string  $eventName      Name of the event (method to be called on plugins)\r
 534          * @param       string  $data           Can contain any type of data,\r
 535          *                                                              depending on the event type. Usually this is an itemid, blogid, ...\r
 536          *                                                              but it can also be an array containing multiple values\r
 537          * @return      void\r
 538          */\r
 539         public function notify($eventName, $data)\r
 540         {\r
 541                 // load subscription list if needed\r
 542                 if ( !is_array($this->subscriptions) )\r
 543                 {\r
 544                         $this->_loadSubscriptions();\r
 545                 }\r
 546                 \r
 547                 // get listening objects\r
 548                 $listeners = false;\r
 549                 if ( array_key_exists($eventName, $this->subscriptions)\r
 550                   && !empty($this->subscriptions[$eventName]) )\r
 551                 {\r
 552                         $listeners = $this->subscriptions[$eventName];\r
 553                 }\r
 554                 \r
 555                 // notify all of them\r
 556                 if ( is_array($listeners) )\r
 557                 {\r
 558                         foreach( $listeners as $listener )\r
 559                         {\r
 560                                 // load class if needed\r
 561                                 $this->_loadPlugin($listener);\r
 562                                 \r
 563                                 // do notify (if method exists)\r
 564                                 if ( array_key_exists($listener, $this->plugins)\r
 565                                   && !empty($this->plugins[$listener])\r
 566                                   && method_exists($this->plugins[$listener], 'event_' . $eventName) )\r
 567                                 {\r
 568                                         call_user_func(array(&$this->plugins[$listener],'event_' . $eventName), $data);\r
 569                                 }\r
 570                         }\r
 571                 }\r
 572                 return;\r
 573         }\r
 574         \r
 575         /**\r
 576          * Manager::_loadSubscriptions()\r
 577          * Loads plugin subscriptions\r
 578          * \r
 579          * @param       void\r
 580          * @return      void\r
 581          */\r
 582         private function _loadSubscriptions()\r
 583         {\r
 584                 // initialize as array\r
 585                 $this->subscriptions = array();\r
 586                 \r
 587                 $query = "SELECT p.pfile as pfile, e.event as event"\r
 588                        . " FROM %s as e, %s as p"\r
 589                        . " WHERE e.pid=p.pid ORDER BY p.porder ASC";\r
 590                 $query = sprintf($query, sql_table('plugin_event'), sql_table('plugin'));\r
 591                 $res = DB::getResult($query);\r
 592                 \r
 593                 foreach ( $res as $row )\r
 594                 {\r
 595                         $pluginName = $row['pfile'];\r
 596                         $eventName = $row['event'];\r
 597                         $this->subscriptions[$eventName][] = $pluginName;\r
 598                 }\r
 599                 return;\r
 600         }\r
 601         \r
 602         /**\r
 603          * Manager::getNumberOfSubscribers()\r
 604          * \r
 605          * @param       string  $event  name of events\r
 606          * @return      integer number of event subscriber\r
 607          */\r
 608         public function getNumberOfSubscribers($event)\r
 609         {\r
 610                 $query = 'SELECT COUNT(*) as count FROM %s WHERE event=%s;';\r
 611                 $query = sprintf($query, sql_table('plugin_event'), DB::quoteValue($event));\r
 612                 return (integer) DB::getValue($query);\r
 613         }\r
 614         \r
 615         /**\r
 616          * Manager::addTicketToUrl()\r
 617          * GET requests: Adds ticket to URL (URL should NOT be html-encoded!, ticket is added at the end)\r
 618          * \r
 619          * @param       string  url     string for URI\r
 620          * @return      void\r
 621          */\r
 622         public function addTicketToUrl($url)\r
 623         {\r
 624                 $ticketCode = 'ticket=' . $this->_generateTicket();\r
 625                 if ( i18n::strpos($url, '?') === FALSE )\r
 626                 {\r
 627                         $ticketCode = "{$url}?{$ticketCode}";\r
 628                 }\r
 629                 else\r
 630                 {\r
 631                         $ticketCode = "{$url}&{$ticketCode}";\r
 632                 }\r
 633                 return $ticketCode;\r
 634         }\r
 635         \r
 636         /**\r
 637          * Manager::addTicketHidden()\r
 638          * POST requests: Adds ticket as hidden formvar\r
 639          * \r
 640          * @param       void\r
 641          * @return      void\r
 642          */\r
 643         public function addTicketHidden()\r
 644         {\r
 645                 $ticket = $this->_generateTicket();\r
 646                 echo '<input type="hidden" name="ticket" value="', Entity::hsc($ticket), '" />';\r
 647                 return;\r
 648         }\r
 649         \r
 650         /**\r
 651          * Manager::getNewTicket()\r
 652          * Get a new ticket\r
 653          * (xmlHTTPRequest AutoSaveDraft uses this to refresh the ticket)\r
 654          * \r
 655          * @param       void\r
 656          * @return      string  string of ticket\r
 657          */\r
 658         public function getNewTicket()\r
 659         {\r
 660                 $this->currentRequestTicket = '';\r
 661                 return $this->_generateTicket();\r
 662         }\r
 663         \r
 664         /**\r
 665          * Manager::checkTicket()\r
 666          * Checks the ticket that was passed along with the current request\r
 667          * \r
 668          * @param       void\r
 669          * @return      boolean correct or not\r
 670          */\r
 671         public function checkTicket()\r
 672         {\r
 673                 global $member;\r
 674                 \r
 675                 // get ticket from request\r
 676                 $ticket = requestVar('ticket');\r
 677                 \r
 678                 // no ticket -> don't allow\r
 679                 if ( $ticket == '' )\r
 680                 {\r
 681                         return FALSE;\r
 682                 }\r
 683                 \r
 684                 // remove expired tickets first\r
 685                 $this->_cleanUpExpiredTickets();\r
 686                 \r
 687                 // get member id\r
 688                 if (!$member->isLoggedIn())\r
 689                 {\r
 690                         $memberId = -1;\r
 691                 }\r
 692                 else\r
 693                 {\r
 694                         $memberId = $member->getID();\r
 695                 }\r
 696                 \r
 697                 // check if ticket is a valid one\r
 698                 $query = sprintf('SELECT COUNT(*) as result FROM %s WHERE member=%d and ticket=%s',\r
 699                         sql_table('tickets'),\r
 700                         intval($memberId),\r
 701                         DB::quoteValue($ticket)\r
 702                 );\r
 703                 \r
 704                 /*\r
 705                  * NOTE:\r
 706                  * [in the original implementation, the checked ticket was deleted. This would lead to invalid\r
 707                  * tickets when using the browsers back button and clicking another link/form\r
 708                  * leaving the keys in the database is not a real problem, since they're member-specific and\r
 709                  * only valid for a period of one hour]\r
 710                  */\r
 711                 if ( DB::getValue($query) != 1 )\r
 712                 {\r
 713                         return FALSE;\r
 714                 }\r
 715                 \r
 716                 return TRUE;\r
 717         }\r
 718 \r
 719         /**\r
 720          * Manager::_cleanUpExpiredTickets()\r
 721          * Removes the expired tickets\r
 722          * \r
 723          * @param       void\r
 724          * @return      void\r
 725          */\r
 726         private function _cleanUpExpiredTickets()\r
 727         {\r
 728                 // remove tickets older than 1 hour\r
 729                 $oldTime = time() - 60 * 60;\r
 730                 $query = 'DELETE FROM %s WHERE ctime < %s';\r
 731                 $query = sprintf($query, sql_table('tickets'), DB::formatDateTime($oldTime));\r
 732                 DB::execute($query);\r
 733                 return;\r
 734         }\r
 735         \r
 736         /**\r
 737          * Manager::_generateTicket()\r
 738          * Generates/returns a ticket (one ticket per page request)\r
 739          * \r
 740          * @param       void\r
 741          * @return      void\r
 742          */\r
 743         private function _generateTicket()\r
 744         {\r
 745                 if ( $this->currentRequestTicket == '' )\r
 746                 {\r
 747                         // generate new ticket (only one ticket will be generated per page request)\r
 748                         // and store in database\r
 749                         global $member;\r
 750                         // get member id\r
 751                         if ( !$member->isLoggedIn() )\r
 752                         {\r
 753                                 $memberId = -1;\r
 754                         }\r
 755                         else\r
 756                         {\r
 757                                 $memberId = $member->getID();\r
 758                         }\r
 759                         \r
 760                         $ok = false;\r
 761                         while ( !$ok )\r
 762                         {\r
 763                                 // generate a random token\r
 764                                 srand((double)microtime()*1000000);\r
 765                                 $ticket = md5(uniqid(rand(), true));\r
 766                                 \r
 767                                 // add in database as non-active\r
 768                                 $query = 'INSERT INTO %s (ticket, member, ctime) VALUES (%s, %d, %s)';\r
 769                                 $query = sprintf($query, sql_table('tickets'), DB::quoteValue($ticket), (integer) $memberId, DB::formatDateTime());\r
 770                                 \r
 771                                 if ( DB::execute($query) !== FALSE )\r
 772                                 {\r
 773                                         $ok = true;\r
 774                                 }\r
 775                         }\r
 776                         $this->currentRequestTicket = $ticket;\r
 777                 }\r
 778                 return $this->currentRequestTicket;\r
 779         }\r
 780 }\r
 781 \r