lib/stompqueuemanager.php

   1 <?php
   2 /**
   3  * Laconica, 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   Laconica
  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/
  29  */
  30
  31 require_once 'Stomp.php';
  32
  33 class StompQueueManager
  34 {
  35     var $server = null;
  36     var $username = null;
  37     var $password = null;
  38     var $base = null;
  39     var $con = null;
  40     var $frames = array();
  41
  42     function __construct()
  43     {
  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');
  48     }
  49
  50     function _connect()
  51     {
  52         if (empty($this->con)) {
  53             $this->con = new Stomp($this->server);
  54
  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');
  58             }
  59         }
  60     }
  61
  62     function enqueue($object, $queue)
  63     {
  64         $notice = $object;
  65
  66         $this->_connect();
  67
  68         // XXX: serialize and send entire notice
  69
  70         $result = $this->con->send($this->_queueName($queue),
  71                                    $notice->id,                 // BODY of the message
  72                                    array ('created' => $notice->created));
  73
  74         if (!$result) {
  75             common_log(LOG_ERR, 'Error sending to '.$transport.' queue');
  76             return false;
  77         }
  78
  79         common_log(LOG_DEBUG, 'complete remote queueing notice ID = '
  80                    . $notice->id . ' for ' . $transport);
  81     }
  82
  83     function nextItem($queue, $timeout=null)
  84     {
  85         $result = null;
  86
  87         $this->_connect();
  88
  89         $frame = $this->con->readFrame();
  90
  91         if ($frame) {
  92             $this->log(LOG_INFO, 'Got item enqueued '.common_exact_date($frame->headers['created']));
  93
  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...
  98
  99             $notice = Notice::staticGet($frame->body);
 100
 101             if ($notice) {
 102                 $this->_saveFrame($notice, $queue, $frame);
 103             } else {
 104                 $this->log(LOG_WARNING, 'queue item for notice that does not exist');
 105             }
 106         }
 107     }
 108
 109     function done($object, $queue)
 110     {
 111         $notice = $object;
 112
 113         $this->_connect();
 114
 115         $frame = $this->_getFrame($notice, $queue);
 116
 117         if (empty($frame)) {
 118             $this->log(LOG_ERR, 'Cannot find frame for notice '.$notice->id.' in queue '.$queue);
 119         } else {
 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);
 124
 125             $this->log(LOG_INFO, 'finished broadcasting notice ID = ' . $notice->id);
 126         }
 127     }
 128
 129     function _frameKey($notice, $queue)
 130     {
 131         return ((string)$notice->id) . '-' . $queue;
 132     }
 133
 134     function _saveFrame($notice, $queue, $frame)
 135     {
 136         $k = $this->_frameKey($notice, $queue);
 137         $this->_frames[$k] = $frame;
 138         return true;
 139     }
 140
 141     function _getFrame($notice, $queue)
 142     {
 143         $k = $this->_frameKey($notice, $queue);
 144         return $this->_frames[$k];
 145     }
 146
 147     function _clearFrame($notice, $queue)
 148     {
 149         $k = $this->_frameKey($notice, $queue);
 150         unset($this->_frames[$k]);
 151     }
 152 }