3 * StatusNet, the distributed open-source microblogging tool
5 * Abstract class for queue managers
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.
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.
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/>.
22 * @category QueueManager
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/
31 require_once 'Stomp.php';
34 class StompQueueManager extends QueueManager
43 protected $sites = array();
44 protected $subscriptions = array();
46 protected $useTransactions = true;
47 protected $transaction = null;
48 protected $transactionCount = 0;
50 function __construct()
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');
61 * Tell the i/o master we only need a single instance to cover
62 * all sites running in this process.
64 public static function multiSite()
66 return IoManager::INSTANCE_PER_PROCESS;
70 * Record each site we'll be handling input for in this process,
71 * so we can listen to the necessary queues for it.
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
77 public function addSite($server)
79 $this->sites[] = $server;
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
89 * Currently only relevant for multi-site queue managers such as Stomp.
91 * @param string $event event key
92 * @param string $param optional parameter to append to key
93 * @return boolean success
95 public function sendControlSignal($event, $param='')
99 $message .= ':' . $param;
102 $result = $this->con->send($this->control,
104 array ('created' => common_sql_now()));
106 $this->_log(LOG_INFO, "Sent control ping to queue daemons: $message");
109 $this->_log(LOG_ERR, "Failed sending control ping to queue daemons: $message");
115 * Instantiate the appropriate QueueHandler class for the given queue.
117 * @param string $queue
118 * @return mixed QueueHandler or null
120 function getHandler($queue)
122 $handlers = $this->handlers[$this->currentSite()];
123 if (isset($handlers[$queue])) {
124 $class = $handlers[$queue];
125 if (class_exists($class)) {
128 common_log(LOG_ERR, "Nonexistent handler class '$class' for queue '$queue'");
131 common_log(LOG_ERR, "Requested handler for unkown queue '$queue'");
137 * Get a list of all registered queue transport names.
139 * @return array of strings
143 $group = $this->activeGroup();
144 $site = $this->currentSite();
145 if (empty($this->groups[$site][$group])) {
148 return array_keys($this->groups[$site][$group]);
153 * Register a queue transport name and handler class for your plugin.
154 * Only registered transports will be reliably picked up!
156 * @param string $transport
157 * @param string $class
158 * @param string $group
160 public function connect($transport, $class, $group='queuedaemon')
162 $this->handlers[$this->currentSite()][$transport] = $class;
163 $this->groups[$this->currentSite()][$group][$transport] = $class;
167 * Saves a notice object reference into the queue item table.
168 * @return boolean true on success
170 public function enqueue($object, $queue)
172 $msg = $this->encode($object);
173 $rep = $this->logrep($object);
177 // XXX: serialize and send entire notice
179 $result = $this->con->send($this->queueName($queue),
180 $msg, // BODY of the message
181 array ('created' => common_sql_now(),
182 'persistent' => 'true'));
185 common_log(LOG_ERR, "Error sending $rep to $queue queue");
189 common_log(LOG_DEBUG, "complete remote queueing $rep for $queue");
190 $this->stats('enqueued', $queue);
194 * Send any sockets we're listening on to the IO manager
197 * @return array of resources
199 public function getSockets()
201 return array($this->con->getSocket());
205 * We've got input to handle on our socket!
206 * Read any waiting Stomp frame(s) and process them.
208 * @param resource $socket
209 * @return boolean ok on success
211 public function handleInput($socket)
213 assert($socket === $this->con->getSocket());
215 $frames = $this->con->readFrames();
216 foreach ($frames as $frame) {
217 $dest = $frame->headers['destination'];
218 if ($dest == $this->control) {
219 if (!$this->handleControlSignal($frame)) {
220 // We got a control event that requests a shutdown;
221 // close out and stop handling anything else!
225 $ok = $ok && $this->handleItem($frame);
232 * Initialize our connection and subscribe to all the queues
233 * we're going to need to handle...
235 * Side effects: in multi-site mode, may reset site configuration.
237 * @param IoMaster $master process/event controller
238 * @return bool return false on failure
240 public function start($master)
242 parent::start($master);
245 $this->con->subscribe($this->control);
247 foreach ($this->sites as $server) {
248 StatusNet::init($server);
249 $this->doSubscribe();
252 $this->doSubscribe();
259 * Subscribe to all the queues we're going to need to handle...
261 * Side effects: in multi-site mode, may reset site configuration.
263 * @return bool return false on failure
265 public function finish()
267 // If there are any outstanding delivered messages we haven't processed,
268 // free them for another thread to take.
270 $this->con->unsubscribe($this->control);
272 foreach ($this->sites as $server) {
273 StatusNet::init($server);
274 $this->doUnsubscribe();
277 $this->doUnsubscribe();
283 * Get identifier of the currently active site configuration
286 protected function currentSite()
288 return common_config('site', 'server'); // @fixme switch to nickname
292 * Lazy open connection to Stomp queue server.
294 protected function _connect()
296 if (empty($this->con)) {
297 $this->_log(LOG_INFO, "Connecting to '$this->server' as '$this->username'...");
298 $this->con = new LiberalStomp($this->server);
300 if ($this->con->connect($this->username, $this->password)) {
301 $this->_log(LOG_INFO, "Connected.");
303 $this->_log(LOG_ERR, 'Failed to connect to queue server');
304 throw new ServerException('Failed to connect to queue server');
310 * Subscribe to all enabled notice queues for the current site.
312 protected function doSubscribe()
314 $site = $this->currentSite();
316 foreach ($this->getQueues() as $queue) {
317 $rawqueue = $this->queueName($queue);
318 $this->subscriptions[$site][$queue] = $rawqueue;
319 $this->_log(LOG_INFO, "Subscribing to $rawqueue");
320 $this->con->subscribe($rawqueue);
325 * Subscribe from all enabled notice queues for the current site.
327 protected function doUnsubscribe()
329 $site = $this->currentSite();
331 if (!empty($this->subscriptions[$site])) {
332 foreach ($this->subscriptions[$site] as $queue => $rawqueue) {
333 $this->_log(LOG_INFO, "Unsubscribing from $rawqueue");
334 $this->con->unsubscribe($rawqueue);
335 unset($this->subscriptions[$site][$queue]);
341 * Handle and acknowledge an event that's come in through a queue.
343 * If the queue handler reports failure, the message is requeued for later.
344 * Missing notices or handler classes will drop the message.
346 * Side effects: in multi-site mode, may reset site configuration to
347 * match the site that queued the event.
349 * @param StompFrame $frame
352 protected function handleItem($frame)
354 list($site, $queue) = $this->parseDestination($frame->headers['destination']);
355 if ($site != $this->currentSite()) {
356 $this->stats('switch');
357 StatusNet::init($site);
360 if (is_numeric($frame->body)) {
361 $id = intval($frame->body);
362 $info = "notice $id posted at {$frame->headers['created']} in queue $queue";
364 $notice = Notice::staticGet('id', $id);
365 if (empty($notice)) {
366 $this->_log(LOG_WARNING, "Skipping missing $info");
370 $this->stats('badnotice', $queue);
376 // @fixme should we serialize, or json, or what here?
377 $info = "string posted at {$frame->headers['created']} in queue $queue";
378 $item = $frame->body;
381 $handler = $this->getHandler($queue);
383 $this->_log(LOG_ERR, "Missing handler class; skipping $info");
387 $this->stats('badhandler', $queue);
391 $ok = $handler->handle($item);
394 $this->_log(LOG_WARNING, "Failed handling $info");
395 // FIXME we probably shouldn't have to do
396 // this kind of queue management ourselves;
397 // if we don't ack, it should resend...
399 $this->enqueue($item, $queue);
402 $this->stats('requeued', $queue);
406 $this->_log(LOG_INFO, "Successfully handled $info");
410 $this->stats('handled', $queue);
415 * Process a control signal broadcast.
417 * @param array $frame Stomp frame
418 * @return bool true to continue; false to stop further processing.
420 protected function handleControlSignal($frame)
422 $message = trim($frame->body);
423 if (strpos($message, ':') !== false) {
424 list($event, $param) = explode(':', $message, 2);
432 if ($event == 'shutdown') {
433 $this->master->requestShutdown();
435 } else if ($event == 'restart') {
436 $this->master->requestRestart();
438 } else if ($event == 'update') {
439 $this->updateSiteConfig($param);
441 $this->_log(LOG_ERR, "Ignoring unrecognized control message: $message");
451 * Set us up with queue subscriptions for a new site added at runtime,
452 * triggered by a broadcast to the 'statusnet-control' topic.
454 * @param array $frame Stomp frame
455 * @return bool true to continue; false to stop further processing.
457 protected function updateSiteConfig($nickname)
459 if (empty($this->sites)) {
460 if ($nickname == common_config('site', 'nickname')) {
461 StatusNet::init(common_config('site', 'server'));
462 $this->doUnsubscribe();
463 $this->doSubscribe();
465 $this->_log(LOG_INFO, "Ignoring update ping for other site $nickname");
468 $sn = Status_network::staticGet($nickname);
470 $server = $sn->getServerName(); // @fixme do config-by-nick
471 StatusNet::init($server);
472 if (empty($this->sites[$server])) {
473 $this->addSite($server);
475 $this->_log(LOG_INFO, "(Re)subscribing to queues for site $nickname / $server");
476 $this->doUnsubscribe();
477 $this->doSubscribe();
478 $this->stats('siteupdate');
480 $this->_log(LOG_ERR, "Ignoring ping for unrecognized new site $nickname");
486 * Combines the queue_basename from configuration with the
487 * site server name and queue name to give eg:
489 * /queue/statusnet/identi.ca/sms
491 * @param string $queue
494 protected function queueName($queue)
496 return common_config('queue', 'queue_basename') .
497 $this->currentSite() . '/' . $queue;
501 * Returns the site and queue name from the server-side queue.
503 * @param string queue destination (eg '/queue/statusnet/identi.ca/sms')
504 * @return array of site and queue: ('identi.ca','sms') or false if unrecognized
506 protected function parseDestination($dest)
508 $prefix = common_config('queue', 'queue_basename');
509 if (substr($dest, 0, strlen($prefix)) == $prefix) {
510 $rest = substr($dest, strlen($prefix));
511 return explode("/", $rest, 2);
513 common_log(LOG_ERR, "Got a message from unrecognized stomp queue: $dest");
514 return array(false, false);
518 function _log($level, $msg)
520 common_log($level, 'StompQueueManager: '.$msg);
523 protected function begin()
525 if ($this->useTransactions) {
526 if ($this->transaction) {
527 throw new Exception("Tried to start transaction in the middle of a transaction");
529 $this->transactionCount++;
530 $this->transaction = $this->master->id . '-' . $this->transactionCount . '-' . time();
531 $this->con->begin($this->transaction);
535 protected function ack($frame)
537 if ($this->useTransactions) {
538 if (!$this->transaction) {
539 throw new Exception("Tried to ack but not in a transaction");
542 $this->con->ack($frame, $this->transaction);
545 protected function commit()
547 if ($this->useTransactions) {
548 if (!$this->transaction) {
549 throw new Exception("Tried to commit but not in a transaction");
551 $this->con->commit($this->transaction);
552 $this->transaction = null;
556 protected function rollback()
558 if ($this->useTransactions) {
559 if (!$this->transaction) {
560 throw new Exception("Tried to rollback but not in a transaction");
562 $this->con->commit($this->transaction);
563 $this->transaction = null;