3 * Laconica, 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@controlyourself.ca>
25 * @author Sarven Capadisli <csarven@controlyourself.ca>
26 * @copyright 2009 Control Yourself, Inc.
27 * @license http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
28 * @link http://laconi.ca/
31 require_once 'Stomp.php';
33 class LiberalStomp extends Stomp
37 return $this->_socket;
41 class StompQueueManager
49 function __construct()
51 $this->server = common_config('queue', 'stomp_server');
52 $this->username = common_config('queue', 'stomp_username');
53 $this->password = common_config('queue', 'stomp_password');
54 $this->base = common_config('queue', 'queue_basename');
59 if (empty($this->con)) {
60 $this->_log(LOG_INFO, "Connecting to '$this->server' as '$this->username'...");
61 $this->con = new LiberalStomp($this->server);
63 if ($this->con->connect($this->username, $this->password)) {
64 $this->_log(LOG_INFO, "Connected.");
66 $this->_log(LOG_ERR, 'Failed to connect to queue server');
67 throw new ServerException('Failed to connect to queue server');
72 function enqueue($object, $queue)
78 // XXX: serialize and send entire notice
80 $result = $this->con->send($this->_queueName($queue),
81 $notice->id, // BODY of the message
82 array ('created' => $notice->created));
85 common_log(LOG_ERR, 'Error sending to '.$queue.' queue');
89 common_log(LOG_DEBUG, 'complete remote queueing notice ID = '
90 . $notice->id . ' for ' . $queue);
93 function service($queue, $handler)
99 $this->con->setReadTimeout($handler->timeout());
101 $this->con->subscribe($this->_queueName($queue));
105 // Wait for something on one of our sockets
107 $stompsock = $this->con->getSocket();
109 $handsocks = $handler->getSockets();
111 $this->_log(LOG_DEBUG, "Got ".count($handsocks)." sockets from handler.");
112 $this->_log(LOG_DEBUG, print_r($handsocks, true));
114 $socks = array_merge(array($stompsock), $handsocks);
120 $this->_log(LOG_DEBUG, "Starting select");
121 $ready = stream_select($read, $write, $except, $handler->timeout(), 0);
122 $this->_log(LOG_DEBUG, "Finished select with value '$ready'");
124 if (!$ready || $read[0] !== $stompsock) {
125 $handler->idle(QUEUE_HANDLER_MISS_IDLE);
127 $frame = $this->con->readFrame();
129 if (!empty($frame)) {
130 $notice = Notice::staticGet('id', $frame->body);
132 if (empty($notice)) {
133 $this->_log(LOG_WARNING, 'Got ID '. $frame->body .' for non-existent notice in queue '. $queue);
134 $this->con->ack($frame);
136 if ($handler->handle_notice($notice)) {
137 $this->_log(LOG_INFO, 'Successfully handled notice '. $notice->id .' posted at ' . $frame->headers['created'] . ' in queue '. $queue);
138 $this->con->ack($frame);
140 $this->_log(LOG_WARNING, 'Failed handling notice '. $notice->id .' posted at ' . $frame->headers['created'] . ' in queue '. $queue);
141 // FIXME we probably shouldn't have to do
142 // this kind of queue management ourselves
143 $this->con->ack($frame);
144 $this->enqueue($notice, $queue);
151 $handler->idle(QUEUE_HANDLER_HIT_IDLE);
154 $handler->idle(QUEUE_HANDLER_MISS_IDLE);
159 $this->con->unsubscribe($this->_queueName($queue));
162 function _queueName($queue)
164 return common_config('queue', 'queue_basename') . $queue;
167 function _log($level, $msg)
169 common_log($level, 'StompQueueManager: '.$msg);