lib/queuemanager.php

   1 <?php
   2 /**
   3  * StatusNet, the distributed open-source microblogging tool
   4  *
   5  * Abstract class for i/o managers
   6  *
   7  * PHP version 5
   8  *
   9  * LICENCE: This program is free software: you can redistribute it and/or modify
  10  * it under the terms of the GNU Affero General Public License as published by
  11  * the Free Software Foundation, either version 3 of the License, or
  12  * (at your option) any later version.
  13  *
  14  * This program is distributed in the hope that it will be useful,
  15  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  16  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  17  * GNU Affero General Public License for more details.
  18  *
  19  * You should have received a copy of the GNU Affero General Public License
  20  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  21  *
  22  * @category  QueueManager
  23  * @package   StatusNet
  24  * @author    Evan Prodromou <evan@status.net>
  25  * @author    Sarven Capadisli <csarven@status.net>
  26  * @author    Brion Vibber <brion@status.net>
  27  * @copyright 2009-2010 StatusNet, Inc.
  28  * @license   http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
  29  * @link      http://status.net/
  30  */
  31
  32 /**
  33  * Completed child classes must implement the enqueue() method.
  34  *
  35  * For background processing, classes should implement either socket-based
  36  * input (handleInput(), getSockets()) or idle-loop polling (idle()).
  37  */
  38 abstract class QueueManager extends IoManager
  39 {
  40     static $qm = null;
  41
  42     protected $master = null;
  43     protected $handlers = array();
  44     protected $groups = array();
  45     protected $activeGroups = array();
  46
  47     /**
  48      * Factory function to pull the appropriate QueueManager object
  49      * for this site's configuration. It can then be used to queue
  50      * events for later processing or to spawn a processing loop.
  51      *
  52      * Plugins can add to the built-in types by hooking StartNewQueueManager.
  53      *
  54      * @return QueueManager
  55      */
  56     public static function get()
  57     {
  58         if (empty(self::$qm)) {
  59
  60             if (Event::handle('StartNewQueueManager', array(&self::$qm))) {
  61
  62                 $enabled = common_config('queue', 'enabled');
  63                 $type = common_config('queue', 'subsystem');
  64
  65                 if (!$enabled) {
  66                     // does everything immediately
  67                     self::$qm = new UnQueueManager();
  68                 } else {
  69                     switch ($type) {
  70                      case 'db':
  71                         self::$qm = new DBQueueManager();
  72                         break;
  73                      case 'stomp':
  74                         self::$qm = new StompQueueManager();
  75                         break;
  76                      default:
  77                         throw new ServerException("No queue manager class for type '$type'");
  78                     }
  79                 }
  80             }
  81         }
  82
  83         return self::$qm;
  84     }
  85
  86     /**
  87      * @fixme wouldn't necessarily work with other class types.
  88      * Better to change the interface...?
  89      */
  90     public static function multiSite()
  91     {
  92         if (common_config('queue', 'subsystem') == 'stomp') {
  93             return IoManager::INSTANCE_PER_PROCESS;
  94         } else {
  95             return IoManager::SINGLE_ONLY;
  96         }
  97     }
  98
  99     function __construct()
 100     {
 101         $this->initialize();
 102     }
 103
 104     /**
 105      * Optional; ping any running queue handler daemons with a notification
 106      * such as announcing a new site to handle or requesting clean shutdown.
 107      * This avoids having to restart all the daemons manually to update configs
 108      * and such.
 109      *
 110      * Called from scripts/queuectl.php controller utility.
 111      *
 112      * @param string $event event key
 113      * @param string $param optional parameter to append to key
 114      * @return boolean success
 115      */
 116     public function sendControlSignal($event, $param='')
 117     {
 118         throw new Exception(get_class($this) . " does not support control signals.");
 119     }
 120
 121     /**
 122      * Store an object (usually/always a Notice) into the given queue
 123      * for later processing. No guarantee is made on when it will be
 124      * processed; it could be immediately or at some unspecified point
 125      * in the future.
 126      *
 127      * Must be implemented by any queue manager.
 128      *
 129      * @param Notice $object
 130      * @param string $queue
 131      */
 132     abstract function enqueue($object, $queue);
 133
 134     /**
 135      * Build a representation for an object for logging
 136      * @param mixed
 137      * @return string
 138      */
 139     function logrep($object) {
 140         if (is_object($object)) {
 141             $class = get_class($object);
 142             if (isset($object->id)) {
 143                 return "$class $object->id";
 144             }
 145             return $class;
 146         } elseif (is_string($object)) {
 147             $len = strlen($object);
 148             $fragment = mb_substr($object, 0, 32);
 149             if (mb_strlen($object) > 32) {
 150                 $fragment .= '...';
 151             }
 152             return "string '$fragment' ($len bytes)";
 153         } elseif (is_array($object)) {
 154             return 'array with ' . count($object) .
 155                    ' elements (keys:[' .  implode(',', array_keys($object)) . '])';
 156         }
 157         return strval($object);
 158     }
 159
 160     /**
 161      * Encode an object for queued storage.
 162      *
 163      * @param mixed $item
 164      * @return string
 165      */
 166     protected function encode($item)
 167     {
 168         return serialize($item);
 169     }
 170
 171     /**
 172      * Decode an object from queued storage.
 173      * Accepts notice reference entries and serialized items.
 174      *
 175      * @param string
 176      * @return mixed
 177      */
 178     protected function decode($frame)
 179     {
 180         $object = unserialize($frame);
 181
 182         // If it is a string, we really store a JSON object in there
 183         // except if it begins with '<', because then it is XML.
 184         if (is_string($object) &&
 185             substr($object, 0, 1) != '<' &&
 186             !is_numeric($object))
 187         {
 188             $json = json_decode($object);
 189             if ($json === null) {
 190                 throw new Exception('Bad frame in queue item');
 191             }
 192
 193             // The JSON object has a type parameter which contains the class
 194             if (empty($json->type)) {
 195                 throw new Exception('Type not specified for queue item');
 196             }
 197             if (!is_a($json->type, 'Managed_DataObject', true)) {
 198                 throw new Exception('Managed_DataObject class does not exist for queue item');
 199             }
 200
 201             // And each of these types should have a unique id (or uri)
 202             if (isset($json->id) && !empty($json->id)) {
 203                 $object = call_user_func(array($json->type, 'getKV'), 'id', $json->id);
 204             } elseif (isset($json->uri) && !empty($json->uri)) {
 205                 $object = call_user_func(array($json->type, 'getKV'), 'uri', $json->uri);
 206             }
 207
 208             // But if no object was found, there's nothing we can handle
 209             if (!$object instanceof Managed_DataObject) {
 210                 throw new Exception('Queue item frame referenced a non-existant object');
 211             }
 212         }
 213
 214         // If the frame was not a string, it's either an array or an object.
 215
 216         return $object;
 217     }
 218
 219     /**
 220      * Instantiate the appropriate QueueHandler class for the given queue.
 221      *
 222      * @param string $queue
 223      * @return mixed QueueHandler or null
 224      */
 225     function getHandler($queue)
 226     {
 227         if (isset($this->handlers[$queue])) {
 228             $class = $this->handlers[$queue];
 229             if(is_object($class)) {
 230                 return $class;
 231             } else if (class_exists($class)) {
 232                 return new $class();
 233             } else {
 234                 $this->_log(LOG_ERR, "Nonexistent handler class '$class' for queue '$queue'");
 235             }
 236         }
 237         return null;
 238     }
 239
 240     /**
 241      * Get a list of registered queue transport names to be used
 242      * for listening in this daemon.
 243      *
 244      * @return array of strings
 245      */
 246     function activeQueues()
 247     {
 248         $queues = array();
 249         foreach ($this->activeGroups as $group) {
 250             if (isset($this->groups[$group])) {
 251                 $queues = array_merge($queues, $this->groups[$group]);
 252             }
 253         }
 254
 255         return array_keys($queues);
 256     }
 257
 258     /**
 259      * Initialize the list of queue handlers for the current site.
 260      *
 261      * @event StartInitializeQueueManager
 262      * @event EndInitializeQueueManager
 263      */
 264     function initialize()
 265     {
 266         $this->handlers = array();
 267         $this->groups = array();
 268         $this->groupsByTransport = array();
 269
 270         if (Event::handle('StartInitializeQueueManager', array($this))) {
 271             $this->connect('distrib', 'DistribQueueHandler');
 272             $this->connect('ping', 'PingQueueHandler');
 273             if (common_config('sms', 'enabled')) {
 274                 $this->connect('sms', 'SmsQueueHandler');
 275             }
 276
 277             // Background user management tasks...
 278             $this->connect('deluser', 'DelUserQueueHandler');
 279             $this->connect('feedimp', 'FeedImporter');
 280             $this->connect('actimp', 'ActivityImporter');
 281             $this->connect('acctmove', 'AccountMover');
 282             $this->connect('actmove', 'ActivityMover');
 283
 284             // For compat with old plugins not registering their own handlers.
 285             $this->connect('plugin', 'PluginQueueHandler');
 286         }
 287         Event::handle('EndInitializeQueueManager', array($this));
 288     }
 289
 290     /**
 291      * Register a queue transport name and handler class for your plugin.
 292      * Only registered transports will be reliably picked up!
 293      *
 294      * @param string $transport
 295      * @param string $class class name or object instance
 296      * @param string $group
 297      */
 298     public function connect($transport, $class, $group='main')
 299     {
 300         $this->handlers[$transport] = $class;
 301         $this->groups[$group][$transport] = $class;
 302         $this->groupsByTransport[$transport] = $group;
 303     }
 304
 305     /**
 306      * Set the active group which will be used for listening.
 307      * @param string $group
 308      */
 309     function setActiveGroup($group)
 310     {
 311         $this->activeGroups = array($group);
 312     }
 313
 314     /**
 315      * Set the active group(s) which will be used for listening.
 316      * @param array $groups
 317      */
 318     function setActiveGroups($groups)
 319     {
 320         $this->activeGroups = $groups;
 321     }
 322
 323     /**
 324      * @return string queue group for this queue
 325      */
 326     function queueGroup($queue)
 327     {
 328         if (isset($this->groupsByTransport[$queue])) {
 329             return $this->groupsByTransport[$queue];
 330         } else {
 331             throw new Exception("Requested group for unregistered transport $queue");
 332         }
 333     }
 334
 335     /**
 336      * Send a statistic ping to the queue monitoring system,
 337      * optionally with a per-queue id.
 338      *
 339      * @param string $key
 340      * @param string $queue
 341      */
 342     function stats($key, $queue=false)
 343     {
 344         $owners = array();
 345         if ($queue) {
 346             $owners[] = "queue:$queue";
 347             $owners[] = "site:" . common_config('site', 'server');
 348         }
 349         if (isset($this->master)) {
 350             $this->master->stats($key, $owners);
 351         } else {
 352             $monitor = new QueueMonitor();
 353             $monitor->stats($key, $owners);
 354         }
 355     }
 356
 357     protected function _log($level, $msg)
 358     {
 359         $class = get_class($this);
 360         if ($this->activeGroups) {
 361             $groups = ' (' . implode(',', $this->activeGroups) . ')';
 362         } else {
 363             $groups = '';
 364         }
 365         common_log($level, "$class$groups: $msg");
 366     }
 367 }