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