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 StompQueueManager
40 var $frames = array();
42 function __construct()
44 $this->server = common_config('queue', 'stomp_server');
45 $this->username = common_config('queue', 'stomp_username');
46 $this->password = common_config('queue', 'stomp_password');
47 $this->base = common_config('queue', 'queue_basename');
52 if (empty($this->con)) {
53 $this->con = new Stomp($this->server);
55 if (!$this->con->connect($this->username, $this->password)) {
56 $this->_log(LOG_ERR, 'Failed to connect to queue server');
57 throw new ServerException('Failed to connect to queue server');
62 function enqueue($object, $queue)
68 // XXX: serialize and send entire notice
70 $result = $this->con->send($this->_queueName($queue),
71 $notice->id, // BODY of the message
72 array ('created' => $notice->created));
75 common_log(LOG_ERR, 'Error sending to '.$transport.' queue');
79 common_log(LOG_DEBUG, 'complete remote queueing notice ID = '
80 . $notice->id . ' for ' . $transport);
83 function nextItem($queue, $timeout=null)
89 $frame = $this->con->readFrame();
92 $this->log(LOG_INFO, 'Got item enqueued '.common_exact_date($frame->headers['created']));
94 // XXX: Now the queue handler receives only the ID of the
95 // notice, and it has to get it from the DB
96 // A massive improvement would be avoid DB query by transmitting
97 // all the notice details via queue server...
99 $notice = Notice::staticGet($frame->body);
102 $this->_saveFrame($notice, $queue, $frame);
104 $this->log(LOG_WARNING, 'queue item for notice that does not exist');
109 function done($object, $queue)
115 $frame = $this->_getFrame($notice, $queue);
118 $this->log(LOG_ERR, 'Cannot find frame for notice '.$notice->id.' in queue '.$queue);
120 // if the msg has been handled positively, ack it
121 // and the queue server will remove it from the queue
122 $this->con->ack($frame);
123 $this->_clearFrame($notice, $queue);
125 $this->log(LOG_INFO, 'finished broadcasting notice ID = ' . $notice->id);
129 function fail($object, $queue)
133 // STOMP server will requeue it after a while anyways,
134 // so no need to notify. Just get it out of our little
137 $this->_clearFrame($notice, $queue);
140 function _frameKey($notice, $queue)
142 return ((string)$notice->id) . '-' . $queue;
145 function _saveFrame($notice, $queue, $frame)
147 $k = $this->_frameKey($notice, $queue);
148 $this->_frames[$k] = $frame;
152 function _getFrame($notice, $queue)
154 $k = $this->_frameKey($notice, $queue);
155 return $this->_frames[$k];
158 function _clearFrame($notice, $queue)
160 $k = $this->_frameKey($notice, $queue);
161 unset($this->_frames[$k]);