lib/stompqueuemanager.php

   1 <?php
   2 /**
   3  * StatusNet, the distributed open-source microblogging tool
   4  *
   5  * Abstract class for queue 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  * @copyright 2009 StatusNet, Inc.
  27  * @license   http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
  28  * @link      http://status.net/
  29  */
  30
  31 require_once 'Stomp.php';
  32
  33
  34 class StompQueueManager extends QueueManager
  35 {
  36     var $server = null;
  37     var $username = null;
  38     var $password = null;
  39     var $base = null;
  40     var $con = null;
  41     protected $control;
  42
  43     protected $sites = array();
  44     protected $subscriptions = array();
  45
  46     protected $useTransactions = true;
  47     protected $transaction = null;
  48     protected $transactionCount = 0;
  49
  50     function __construct()
  51     {
  52         parent::__construct();
  53         $this->server   = common_config('queue', 'stomp_server');
  54         $this->username = common_config('queue', 'stomp_username');
  55         $this->password = common_config('queue', 'stomp_password');
  56         $this->base     = common_config('queue', 'queue_basename');
  57         $this->control  = common_config('queue', 'control_channel');
  58     }
  59
  60     /**
  61      * Tell the i/o master we only need a single instance to cover
  62      * all sites running in this process.
  63      */
  64     public static function multiSite()
  65     {
  66         return IoManager::INSTANCE_PER_PROCESS;
  67     }
  68
  69     /**
  70      * Record each site we'll be handling input for in this process,
  71      * so we can listen to the necessary queues for it.
  72      *
  73      * @fixme possibly actually do subscription here to save another
  74      *        loop over all sites later?
  75      * @fixme possibly don't assume it's the current site
  76      */
  77     public function addSite($server)
  78     {
  79         $this->sites[] = $server;
  80         $this->initialize();
  81     }
  82
  83     /**
  84      * Optional; ping any running queue handler daemons with a notification
  85      * such as announcing a new site to handle or requesting clean shutdown.
  86      * This avoids having to restart all the daemons manually to update configs
  87      * and such.
  88      *
  89      * Currently only relevant for multi-site queue managers such as Stomp.
  90      *
  91      * @param string $event event key
  92      * @param string $param optional parameter to append to key
  93      * @return boolean success
  94      */
  95     public function sendControlSignal($event, $param='')
  96     {
  97         $message = $event;
  98         if ($param != '') {
  99             $message .= ':' . $param;
 100         }
 101         $this->_connect();
 102         $result = $this->con->send($this->control,
 103                                    $message,
 104                                    array ('created' => common_sql_now()));
 105         if ($result) {
 106             $this->_log(LOG_INFO, "Sent control ping to queue daemons: $message");
 107             return true;
 108         } else {
 109             $this->_log(LOG_ERR, "Failed sending control ping to queue daemons: $message");
 110             return false;
 111         }
 112     }
 113
 114     /**
 115      * Instantiate the appropriate QueueHandler class for the given queue.
 116      *
 117      * @param string $queue
 118      * @return mixed QueueHandler or null
 119      */
 120     function getHandler($queue)
 121     {
 122         $handlers = $this->handlers[$this->currentSite()];
 123         if (isset($handlers[$queue])) {
 124             $class = $handlers[$queue];
 125             if (class_exists($class)) {
 126                 return new $class();
 127             } else {
 128                 common_log(LOG_ERR, "Nonexistent handler class '$class' for queue '$queue'");
 129             }
 130         } else {
 131             common_log(LOG_ERR, "Requested handler for unkown queue '$queue'");
 132         }
 133         return null;
 134     }
 135
 136     /**
 137      * Get a list of all registered queue transport names.
 138      *
 139      * @return array of strings
 140      */
 141     function getQueues()
 142     {
 143         $group = $this->activeGroup();
 144         $site = $this->currentSite();
 145         if (empty($this->groups[$site][$group])) {
 146             return array();
 147         } else {
 148             return array_keys($this->groups[$site][$group]);
 149         }
 150     }
 151
 152     /**
 153      * Register a queue transport name and handler class for your plugin.
 154      * Only registered transports will be reliably picked up!
 155      *
 156      * @param string $transport
 157      * @param string $class
 158      * @param string $group
 159      */
 160     public function connect($transport, $class, $group='queuedaemon')
 161     {
 162         $this->handlers[$this->currentSite()][$transport] = $class;
 163         $this->groups[$this->currentSite()][$group][$transport] = $class;
 164     }
 165
 166     /**
 167      * Saves a notice object reference into the queue item table.
 168      * @return boolean true on success
 169      */
 170     public function enqueue($object, $queue)
 171     {
 172         $msg = $this->encode($object);
 173         $rep = $this->logrep($object);
 174
 175         $this->_connect();
 176
 177         // XXX: serialize and send entire notice
 178
 179         $result = $this->con->send($this->queueName($queue),
 180                                    $msg,                // BODY of the message
 181                                    array ('created' => common_sql_now()));
 182
 183         if (!$result) {
 184             common_log(LOG_ERR, "Error sending $rep to $queue queue");
 185             return false;
 186         }
 187
 188         common_log(LOG_DEBUG, "complete remote queueing $rep for $queue");
 189         $this->stats('enqueued', $queue);
 190     }
 191
 192     /**
 193      * Send any sockets we're listening on to the IO manager
 194      * to wait for input.
 195      *
 196      * @return array of resources
 197      */
 198     public function getSockets()
 199     {
 200         return array($this->con->getSocket());
 201     }
 202
 203     /**
 204      * We've got input to handle on our socket!
 205      * Read any waiting Stomp frame(s) and process them.
 206      *
 207      * @param resource $socket
 208      * @return boolean ok on success
 209      */
 210     public function handleInput($socket)
 211     {
 212         assert($socket === $this->con->getSocket());
 213         $ok = true;
 214         $frames = $this->con->readFrames();
 215         foreach ($frames as $frame) {
 216             $dest = $frame->headers['destination'];
 217             if ($dest == $this->control) {
 218                 if (!$this->handleControlSignal($frame)) {
 219                     // We got a control event that requests a shutdown;
 220                     // close out and stop handling anything else!
 221                     break;
 222                 }
 223             } else {
 224                 $ok = $ok && $this->handleItem($frame);
 225             }
 226         }
 227         return $ok;
 228     }
 229
 230     /**
 231      * Initialize our connection and subscribe to all the queues
 232      * we're going to need to handle...
 233      *
 234      * Side effects: in multi-site mode, may reset site configuration.
 235      *
 236      * @param IoMaster $master process/event controller
 237      * @return bool return false on failure
 238      */
 239     public function start($master)
 240     {
 241         parent::start($master);
 242         $this->_connect();
 243
 244         $this->con->subscribe($this->control);
 245         if ($this->sites) {
 246             foreach ($this->sites as $server) {
 247                 StatusNet::init($server);
 248                 $this->doSubscribe();
 249             }
 250         } else {
 251             $this->doSubscribe();
 252         }
 253         $this->begin();
 254         return true;
 255     }
 256
 257     /**
 258      * Subscribe to all the queues we're going to need to handle...
 259      *
 260      * Side effects: in multi-site mode, may reset site configuration.
 261      *
 262      * @return bool return false on failure
 263      */
 264     public function finish()
 265     {
 266         // If there are any outstanding delivered messages we haven't processed,
 267         // free them for another thread to take.
 268         $this->rollback();
 269         $this->con->unsubscribe($this->control);
 270         if ($this->sites) {
 271             foreach ($this->sites as $server) {
 272                 StatusNet::init($server);
 273                 $this->doUnsubscribe();
 274             }
 275         } else {
 276             $this->doUnsubscribe();
 277         }
 278         return true;
 279     }
 280
 281     /**
 282      * Get identifier of the currently active site configuration
 283      * @return string
 284      */
 285     protected function currentSite()
 286     {
 287         return common_config('site', 'server'); // @fixme switch to nickname
 288     }
 289
 290     /**
 291      * Lazy open connection to Stomp queue server.
 292      */
 293     protected function _connect()
 294     {
 295         if (empty($this->con)) {
 296             $this->_log(LOG_INFO, "Connecting to '$this->server' as '$this->username'...");
 297             $this->con = new LiberalStomp($this->server);
 298
 299             if ($this->con->connect($this->username, $this->password)) {
 300                 $this->_log(LOG_INFO, "Connected.");
 301             } else {
 302                 $this->_log(LOG_ERR, 'Failed to connect to queue server');
 303                 throw new ServerException('Failed to connect to queue server');
 304             }
 305         }
 306     }
 307
 308     /**
 309      * Subscribe to all enabled notice queues for the current site.
 310      */
 311     protected function doSubscribe()
 312     {
 313         $site = $this->currentSite();
 314         $this->_connect();
 315         foreach ($this->getQueues() as $queue) {
 316             $rawqueue = $this->queueName($queue);
 317             $this->subscriptions[$site][$queue] = $rawqueue;
 318             $this->_log(LOG_INFO, "Subscribing to $rawqueue");
 319             $this->con->subscribe($rawqueue);
 320         }
 321     }
 322
 323     /**
 324      * Subscribe from all enabled notice queues for the current site.
 325      */
 326     protected function doUnsubscribe()
 327     {
 328         $site = $this->currentSite();
 329         $this->_connect();
 330         if (!empty($this->subscriptions[$site])) {
 331             foreach ($this->subscriptions[$site] as $queue => $rawqueue) {
 332                 $this->_log(LOG_INFO, "Unsubscribing from $rawqueue");
 333                 $this->con->unsubscribe($rawqueue);
 334                 unset($this->subscriptions[$site][$queue]);
 335             }
 336         }
 337     }
 338
 339     /**
 340      * Handle and acknowledge an event that's come in through a queue.
 341      *
 342      * If the queue handler reports failure, the message is requeued for later.
 343      * Missing notices or handler classes will drop the message.
 344      *
 345      * Side effects: in multi-site mode, may reset site configuration to
 346      * match the site that queued the event.
 347      *
 348      * @param StompFrame $frame
 349      * @return bool
 350      */
 351     protected function handleItem($frame)
 352     {
 353         list($site, $queue) = $this->parseDestination($frame->headers['destination']);
 354         if ($site != $this->currentSite()) {
 355             $this->stats('switch');
 356             StatusNet::init($site);
 357         }
 358
 359         if (is_numeric($frame->body)) {
 360             $id = intval($frame->body);
 361             $info = "notice $id posted at {$frame->headers['created']} in queue $queue";
 362
 363             $notice = Notice::staticGet('id', $id);
 364             if (empty($notice)) {
 365                 $this->_log(LOG_WARNING, "Skipping missing $info");
 366                 $this->ack($frame);
 367                 $this->commit();
 368                 $this->begin();
 369                 $this->stats('badnotice', $queue);
 370                 return false;
 371             }
 372
 373             $item = $notice;
 374         } else {
 375             // @fixme should we serialize, or json, or what here?
 376             $info = "string posted at {$frame->headers['created']} in queue $queue";
 377             $item = $frame->body;
 378         }
 379
 380         $handler = $this->getHandler($queue);
 381         if (!$handler) {
 382             $this->_log(LOG_ERR, "Missing handler class; skipping $info");
 383             $this->ack($frame);
 384             $this->commit();
 385             $this->begin();
 386             $this->stats('badhandler', $queue);
 387             return false;
 388         }
 389
 390         $ok = $handler->handle($item);
 391
 392         if (!$ok) {
 393             $this->_log(LOG_WARNING, "Failed handling $info");
 394             // FIXME we probably shouldn't have to do
 395             // this kind of queue management ourselves;
 396             // if we don't ack, it should resend...
 397             $this->ack($frame);
 398             $this->enqueue($item, $queue);
 399             $this->commit();
 400             $this->begin();
 401             $this->stats('requeued', $queue);
 402             return false;
 403         }
 404
 405         $this->_log(LOG_INFO, "Successfully handled $info");
 406         $this->ack($frame);
 407         $this->commit();
 408         $this->begin();
 409         $this->stats('handled', $queue);
 410         return true;
 411     }
 412
 413     /**
 414      * Process a control signal broadcast.
 415      *
 416      * @param array $frame Stomp frame
 417      * @return bool true to continue; false to stop further processing.
 418      */
 419     protected function handleControlSignal($frame)
 420     {
 421         $message = trim($frame->body);
 422         if (strpos($message, ':') !== false) {
 423             list($event, $param) = explode(':', $message, 2);
 424         } else {
 425             $event = $message;
 426             $param = '';
 427         }
 428
 429         $shutdown = false;
 430
 431         if ($event == 'shutdown') {
 432             $this->master->requestShutdown();
 433             $shutdown = true;
 434         } else if ($event == 'restart') {
 435             $this->master->requestRestart();
 436             $shutdown = true;
 437         } else if ($event == 'update') {
 438             $this->updateSiteConfig($param);
 439         } else {
 440             $this->_log(LOG_ERR, "Ignoring unrecognized control message: $message");
 441         }
 442
 443         $this->ack($frame);
 444         $this->commit();
 445         $this->begin();
 446         return $shutdown;
 447     }
 448
 449     /**
 450      * Set us up with queue subscriptions for a new site added at runtime,
 451      * triggered by a broadcast to the 'statusnet-control' topic.
 452      *
 453      * @param array $frame Stomp frame
 454      * @return bool true to continue; false to stop further processing.
 455      */
 456     protected function updateSiteConfig($nickname)
 457     {
 458         if (empty($this->sites)) {
 459             if ($nickname == common_config('site', 'nickname')) {
 460                 StatusNet::init(common_config('site', 'server'));
 461                 $this->doUnsubscribe();
 462                 $this->doSubscribe();
 463             } else {
 464                 $this->_log(LOG_INFO, "Ignoring update ping for other site $nickname");
 465             }
 466         } else {
 467             $sn = Status_network::staticGet($nickname);
 468             if ($sn) {
 469                 $server = $sn->getServerName(); // @fixme do config-by-nick
 470                 StatusNet::init($server);
 471                 if (empty($this->sites[$server])) {
 472                     $this->addSite($server);
 473                 }
 474                 $this->_log(LOG_INFO, "(Re)subscribing to queues for site $nickname / $server");
 475                 $this->doUnsubscribe();
 476                 $this->doSubscribe();
 477                 $this->stats('siteupdate');
 478             } else {
 479                 $this->_log(LOG_ERR, "Ignoring ping for unrecognized new site $nickname");
 480             }
 481         }
 482     }
 483
 484     /**
 485      * Combines the queue_basename from configuration with the
 486      * site server name and queue name to give eg:
 487      *
 488      * /queue/statusnet/identi.ca/sms
 489      *
 490      * @param string $queue
 491      * @return string
 492      */
 493     protected function queueName($queue)
 494     {
 495         return common_config('queue', 'queue_basename') .
 496             $this->currentSite() . '/' . $queue;
 497     }
 498
 499     /**
 500      * Returns the site and queue name from the server-side queue.
 501      *
 502      * @param string queue destination (eg '/queue/statusnet/identi.ca/sms')
 503      * @return array of site and queue: ('identi.ca','sms') or false if unrecognized
 504      */
 505     protected function parseDestination($dest)
 506     {
 507         $prefix = common_config('queue', 'queue_basename');
 508         if (substr($dest, 0, strlen($prefix)) == $prefix) {
 509             $rest = substr($dest, strlen($prefix));
 510             return explode("/", $rest, 2);
 511         } else {
 512             common_log(LOG_ERR, "Got a message from unrecognized stomp queue: $dest");
 513             return array(false, false);
 514         }
 515     }
 516
 517     function _log($level, $msg)
 518     {
 519         common_log($level, 'StompQueueManager: '.$msg);
 520     }
 521
 522     protected function begin()
 523     {
 524         if ($this->useTransactions) {
 525             if ($this->transaction) {
 526                 throw new Exception("Tried to start transaction in the middle of a transaction");
 527             }
 528             $this->transactionCount++;
 529             $this->transaction = $this->master->id . '-' . $this->transactionCount . '-' . time();
 530             $this->con->begin($this->transaction);
 531         }
 532     }
 533
 534     protected function ack($frame)
 535     {
 536         if ($this->useTransactions) {
 537             if (!$this->transaction) {
 538                 throw new Exception("Tried to ack but not in a transaction");
 539             }
 540         }
 541         $this->con->ack($frame, $this->transaction);
 542     }
 543
 544     protected function commit()
 545     {
 546         if ($this->useTransactions) {
 547             if (!$this->transaction) {
 548                 throw new Exception("Tried to commit but not in a transaction");
 549             }
 550             $this->con->commit($this->transaction);
 551             $this->transaction = null;
 552         }
 553     }
 554
 555     protected function rollback()
 556     {
 557         if ($this->useTransactions) {
 558             if (!$this->transaction) {
 559                 throw new Exception("Tried to rollback but not in a transaction");
 560             }
 561             $this->con->commit($this->transaction);
 562             $this->transaction = null;
 563         }
 564     }
 565 }
 566