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