summaryrefslogtreecommitdiff
path: root/lib/stompqueuemanager.php
blob: 08a5790d418e47e7e2b716f8e734e79f097ab102 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
<?php
/**
 * Laconica, the distributed open-source microblogging tool
 *
 * Abstract class for queue managers
 *
 * PHP version 5
 *
 * LICENCE: This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Affero General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU Affero General Public License for more details.
 *
 * You should have received a copy of the GNU Affero General Public License
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
 *
 * @category  QueueManager
 * @package   Laconica
 * @author    Evan Prodromou <evan@controlyourself.ca>
 * @author    Sarven Capadisli <csarven@controlyourself.ca>
 * @copyright 2009 Control Yourself, Inc.
 * @license   http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
 * @link      http://laconi.ca/
 */

require_once 'Stomp.php';

class StompQueueManager
{
    var $server = null;
    var $username = null;
    var $password = null;
    var $base = null;
    var $con = null;
    var $frames = array();

    function __construct()
    {
        $this->server   = common_config('queue', 'stomp_server');
        $this->username = common_config('queue', 'stomp_username');
        $this->password = common_config('queue', 'stomp_password');
        $this->base     = common_config('queue', 'queue_basename');
    }

    function _connect()
    {
        $this->_log(LOG_DEBUG, "Connecting to $this->server...");
        if (empty($this->con)) {
            $this->_log(LOG_INFO, "Connecting to '$this->server' as '$this->username'...");
            $this->con = new Stomp($this->server);

            if ($this->con->connect($this->username, $this->password)) {
                $this->_log(LOG_INFO, "Connected.");
            } else {
                $this->_log(LOG_ERR, 'Failed to connect to queue server');
                throw new ServerException('Failed to connect to queue server');
            }
        }
    }

    function enqueue($object, $queue)
    {
        $notice = $object;

        $this->_connect();

        // XXX: serialize and send entire notice

        $result = $this->con->send($this->_queueName($queue),
                                   $notice->id, 		// BODY of the message
                                   array ('created' => $notice->created));

        if (!$result) {
            common_log(LOG_ERR, 'Error sending to '.$transport.' queue');
            return false;
        }

        common_log(LOG_DEBUG, 'complete remote queueing notice ID = '
                   . $notice->id . ' for ' . $transport);
    }

    function nextItem($queue, $timeout=null)
    {
        $result = null;

        $this->_connect();

        $frame = $this->con->readFrame();

        if ($frame) {
            $this->log(LOG_INFO, 'Got item enqueued '.common_exact_date($frame->headers['created']));

            // XXX: Now the queue handler receives only the ID of the
            // notice, and it has to get it from the DB
            // A massive improvement would be avoid DB query by transmitting
            // all the notice details via queue server...

            $notice = Notice::staticGet($frame->body);

            if ($notice) {
                $this->_saveFrame($notice, $queue, $frame);
            } else {
                $this->log(LOG_WARNING, 'queue item for notice that does not exist');
            }
        }
    }

    function done($object, $queue)
    {
        $notice = $object;

        $this->_connect();

        $frame = $this->_getFrame($notice, $queue);

        if (empty($frame)) {
            $this->log(LOG_ERR, 'Cannot find frame for notice '.$notice->id.' in queue '.$queue);
        } else {
            // if the msg has been handled positively, ack it
            // and the queue server will remove it from the queue
            $this->con->ack($frame);
            $this->_clearFrame($notice, $queue);

            $this->log(LOG_INFO, 'finished broadcasting notice ID = ' . $notice->id);
        }
    }

    function fail($object, $queue)
    {
        $notice = $object;

        // STOMP server will requeue it after a while anyways,
        // so no need to notify. Just get it out of our little
        // array

        $this->_clearFrame($notice, $queue);
    }

    function _frameKey($notice, $queue)
    {
        return ((string)$notice->id) . '-' . $queue;
    }

    function _saveFrame($notice, $queue, $frame)
    {
        $k = $this->_frameKey($notice, $queue);
        $this->_frames[$k] = $frame;
        return true;
    }

    function _getFrame($notice, $queue)
    {
        $k = $this->_frameKey($notice, $queue);
        return $this->_frames[$k];
    }

    function _clearFrame($notice, $queue)
    {
        $k = $this->_frameKey($notice, $queue);
        unset($this->_frames[$k]);
    }

    function _log($level, $msg)
    {
        common_log($level, 'StompQueueManager: '.$msg);
    }
}