We are no longer offering accounts on this server. Consider https://gitlab.freedesktop.org/ as a place to host projects.

queuemanager.php 8.58 KB
Newer Older
Evan Prodromou's avatar
Evan Prodromou committed
1 2
<?php
/**
3
 * StatusNet, the distributed open-source microblogging tool
Evan Prodromou's avatar
Evan Prodromou committed
4
 *
5
 * Abstract class for i/o managers
Evan Prodromou's avatar
Evan Prodromou committed
6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22
 *
 * 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
23
 * @package   StatusNet
24 25
 * @author    Evan Prodromou <evan@status.net>
 * @author    Sarven Capadisli <csarven@status.net>
26 27
 * @author    Brion Vibber <brion@status.net>
 * @copyright 2009-2010 StatusNet, Inc.
Evan Prodromou's avatar
Evan Prodromou committed
28
 * @license   http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
29
 * @link      http://status.net/
Evan Prodromou's avatar
Evan Prodromou committed
30 31
 */

32 33 34 35 36 37 38
/**
 * Completed child classes must implement the enqueue() method.
 *
 * For background processing, classes should implement either socket-based
 * input (handleInput(), getSockets()) or idle-loop polling (idle()).
 */
abstract class QueueManager extends IoManager
Evan Prodromou's avatar
Evan Prodromou committed
39 40 41
{
    static $qm = null;

42 43 44 45
    public $master = null;
    public $handlers = array();
    public $groups = array();

46 47 48 49 50 51 52 53 54 55
    /**
     * Factory function to pull the appropriate QueueManager object
     * for this site's configuration. It can then be used to queue
     * events for later processing or to spawn a processing loop.
     *
     * Plugins can add to the built-in types by hooking StartNewQueueManager.
     *
     * @return QueueManager
     */
    public static function get()
Evan Prodromou's avatar
Evan Prodromou committed
56 57 58
    {
        if (empty(self::$qm)) {

59
            if (Event::handle('StartNewQueueManager', array(&self::$qm))) {
Evan Prodromou's avatar
Evan Prodromou committed
60

61
                $enabled = common_config('queue', 'enabled');
62
                $type = common_config('queue', 'subsystem');
63 64 65

                if (!$enabled) {
                    // does everything immediately
66 67 68 69 70 71 72 73 74 75 76 77
                    self::$qm = new UnQueueManager();
                } else {
                    switch ($type) {
                     case 'db':
                        self::$qm = new DBQueueManager();
                        break;
                     case 'stomp':
                        self::$qm = new StompQueueManager();
                        break;
                     default:
                        throw new ServerException("No queue manager class for type '$type'");
                    }
Evan Prodromou's avatar
Evan Prodromou committed
78 79 80
                }
            }
        }
81 82

        return self::$qm;
Evan Prodromou's avatar
Evan Prodromou committed
83 84
    }

85 86 87 88 89 90 91 92 93 94 95 96 97 98
    /**
     * @fixme wouldn't necessarily work with other class types.
     * Better to change the interface...?
     */
    public static function multiSite()
    {
        if (common_config('queue', 'subsystem') == 'stomp') {
            return IoManager::INSTANCE_PER_PROCESS;
        } else {
            return IoManager::SINGLE_ONLY;
        }
    }

    function __construct()
Evan Prodromou's avatar
Evan Prodromou committed
99
    {
100
        $this->initialize();
Evan Prodromou's avatar
Evan Prodromou committed
101 102
    }

103 104 105 106 107 108 109 110 111 112 113 114 115
    /**
     * Store an object (usually/always a Notice) into the given queue
     * for later processing. No guarantee is made on when it will be
     * processed; it could be immediately or at some unspecified point
     * in the future.
     *
     * Must be implemented by any queue manager.
     *
     * @param Notice $object
     * @param string $queue
     */
    abstract function enqueue($object, $queue);

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 173
    /**
     * Build a representation for an object for logging
     * @param mixed
     * @return string
     */
    function logrep($object) {
        if (is_object($object)) {
            $class = get_class($object);
            if (isset($object->id)) {
                return "$class $object->id";
            }
            return $class;
        }
        if (is_string($object)) {
            $len = strlen($object);
            $fragment = mb_substr($object, 0, 32);
            if (mb_strlen($object) > 32) {
                $fragment .= '...';
            }
            return "string '$fragment' ($len bytes)";
        }
        return strval($object);
    }

    /**
     * Encode an object for queued storage.
     * Next gen may use serialization.
     *
     * @param mixed $object
     * @return string
     */
    protected function encode($object)
    {
        if ($object instanceof Notice) {
            return $object->id;
        } else if (is_string($object)) {
            return $object;
        } else {
            throw new ServerException("Can't queue this type", 500);
        }
    }

    /**
     * Decode an object from queued storage.
     * Accepts back-compat notice reference entries and strings for now.
     *
     * @param string
     * @return mixed
     */
    protected function decode($frame)
    {
        if (is_numeric($frame)) {
            return Notice::staticGet(intval($frame));
        } else {
            return $frame;
        }
    }

174 175 176 177 178 179 180
    /**
     * Instantiate the appropriate QueueHandler class for the given queue.
     *
     * @param string $queue
     * @return mixed QueueHandler or null
     */
    function getHandler($queue)
Evan Prodromou's avatar
Evan Prodromou committed
181
    {
182 183
        if (isset($this->handlers[$queue])) {
            $class = $this->handlers[$queue];
184 185 186
            if(is_object($class)) {
                return $class;
            } else if (class_exists($class)) {
187 188 189 190 191 192 193 194 195 196 197
                return new $class();
            } else {
                common_log(LOG_ERR, "Nonexistent handler class '$class' for queue '$queue'");
            }
        } else {
            common_log(LOG_ERR, "Requested handler for unkown queue '$queue'");
        }
        return null;
    }

    /**
198 199
     * Get a list of registered queue transport names to be used
     * for this daemon.
200 201 202 203 204
     *
     * @return array of strings
     */
    function getQueues()
    {
205 206
        $group = $this->activeGroup();
        return array_keys($this->groups[$group]);
207 208 209 210 211 212 213 214 215 216
    }

    /**
     * Initialize the list of queue handlers
     *
     * @event StartInitializeQueueManager
     * @event EndInitializeQueueManager
     */
    function initialize()
    {
217
        // @fixme we'll want to be able to listen to particular queues...
218
        if (Event::handle('StartInitializeQueueManager', array($this))) {
219 220 221 222 223
            $this->connect('plugin', 'PluginQueueHandler');
            $this->connect('omb', 'OmbQueueHandler');
            $this->connect('ping', 'PingQueueHandler');
            if (common_config('sms', 'enabled')) {
                $this->connect('sms', 'SmsQueueHandler');
224 225 226
            }

            // XMPP output handlers...
227 228 229 230 231 232 233 234 235 236
            $this->connect('jabber', 'JabberQueueHandler');
            $this->connect('public', 'PublicQueueHandler');
            
            // @fixme this should get an actual queue
            //$this->connect('confirm', 'XmppConfirmHandler');

            // For compat with old plugins not registering their own handlers.
            $this->connect('plugin', 'PluginQueueHandler');

            $this->connect('xmppout', 'XmppOutQueueHandler', 'xmppdaemon');
237 238

        }
239
        Event::handle('EndInitializeQueueManager', array($this));
240 241 242 243 244 245 246
    }

    /**
     * Register a queue transport name and handler class for your plugin.
     * Only registered transports will be reliably picked up!
     *
     * @param string $transport
247
     * @param string $class class name or object instance
248
     * @param string $group
249
     */
250
    public function connect($transport, $class, $group='queuedaemon')
251 252
    {
        $this->handlers[$transport] = $class;
253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268
        $this->groups[$group][$transport] = $class;
    }

    /**
     * @return string queue group to use for this request
     */
    function activeGroup()
    {
        $group = 'queuedaemon';
        if ($this->master) {
            // hack hack
            if ($this->master instanceof XmppMaster) {
                return 'xmppdaemon';
            }
        }
        return $group;
269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290
    }

    /**
     * Send a statistic ping to the queue monitoring system,
     * optionally with a per-queue id.
     *
     * @param string $key
     * @param string $queue
     */
    function stats($key, $queue=false)
    {
        $owners = array();
        if ($queue) {
            $owners[] = "queue:$queue";
            $owners[] = "site:" . common_config('site', 'server');
        }
        if (isset($this->master)) {
            $this->master->stats($key, $owners);
        } else {
            $monitor = new QueueMonitor();
            $monitor->stats($key, $owners);
        }
291
    }
Evan Prodromou's avatar
Evan Prodromou committed
292
}