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