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         $this->_log(LOG_DEBUG, "Connecting to $this->server...");
  53         if (empty($this->con)) {
  54             $this->_log(LOG_INFO, "Connecting to '$this->server' as '$this->username'...");
  55             $this->con = new Stomp($this->server);
  56
  57             if ($this->con->connect($this->username, $this->password)) {
  58                 $this->_log(LOG_INFO, "Connected.");
  59             } else {
  60                 $this->_log(LOG_ERR, 'Failed to connect to queue server');
  61                 throw new ServerException('Failed to connect to queue server');
  62             }
  63         }
  64     }
  65
  66     function enqueue($object, $queue)
  67     {
  68         $notice = $object;
  69
  70         $this->_connect();
  71
  72         // XXX: serialize and send entire notice
  73
  74         $result = $this->con->send($this->_queueName($queue),
  75                                    $notice->id,                 // BODY of the message
  76                                    array ('created' => $notice->created));
  77
  78         if (!$result) {
  79             common_log(LOG_ERR, 'Error sending to '.$transport.' queue');
  80             return false;
  81         }
  82
  83         common_log(LOG_DEBUG, 'complete remote queueing notice ID = '
  84                    . $notice->id . ' for ' . $transport);
  85     }
  86
  87     function nextItem($queue, $timeout=null)
  88     {
  89         $result = null;
  90
  91         $this->_connect();
  92
  93         $frame = $this->con->readFrame();
  94
  95         if ($frame) {
  96             $this->log(LOG_INFO, 'Got item enqueued '.common_exact_date($frame->headers['created']));
  97
  98             // XXX: Now the queue handler receives only the ID of the
  99             // notice, and it has to get it from the DB
 100             // A massive improvement would be avoid DB query by transmitting
 101             // all the notice details via queue server...
 102
 103             $notice = Notice::staticGet($frame->body);
 104
 105             if ($notice) {
 106                 $this->_saveFrame($notice, $queue, $frame);
 107             } else {
 108                 $this->log(LOG_WARNING, 'queue item for notice that does not exist');
 109             }
 110         }
 111     }
 112
 113     function done($object, $queue)
 114     {
 115         $notice = $object;
 116
 117         $this->_connect();
 118
 119         $frame = $this->_getFrame($notice, $queue);
 120
 121         if (empty($frame)) {
 122             $this->log(LOG_ERR, 'Cannot find frame for notice '.$notice->id.' in queue '.$queue);
 123         } else {
 124             // if the msg has been handled positively, ack it
 125             // and the queue server will remove it from the queue
 126             $this->con->ack($frame);
 127             $this->_clearFrame($notice, $queue);
 128
 129             $this->log(LOG_INFO, 'finished broadcasting notice ID = ' . $notice->id);
 130         }
 131     }
 132
 133     function fail($object, $queue)
 134     {
 135         $notice = $object;
 136
 137         // STOMP server will requeue it after a while anyways,
 138         // so no need to notify. Just get it out of our little
 139         // array
 140
 141         $this->_clearFrame($notice, $queue);
 142     }
 143
 144     function _frameKey($notice, $queue)
 145     {
 146         return ((string)$notice->id) . '-' . $queue;
 147     }
 148
 149     function _saveFrame($notice, $queue, $frame)
 150     {
 151         $k = $this->_frameKey($notice, $queue);
 152         $this->_frames[$k] = $frame;
 153         return true;
 154     }
 155
 156     function _getFrame($notice, $queue)
 157     {
 158         $k = $this->_frameKey($notice, $queue);
 159         return $this->_frames[$k];
 160     }
 161
 162     function _clearFrame($notice, $queue)
 163     {
 164         $k = $this->_frameKey($notice, $queue);
 165         unset($this->_frames[$k]);
 166     }
 167
 168     function _log($level, $msg)
 169     {
 170         common_log($level, 'StompQueueManager: '.$msg);
 171     }
 172 }