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