3 * StatusNet, the distributed open-source microblogging tool
5 * Abstract class for i/o 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@status.net>
25 * @author Sarven Capadisli <csarven@status.net>
26 * @author Brion Vibber <brion@status.net>
27 * @copyright 2009-2010 StatusNet, Inc.
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/
33 * Completed child classes must implement the enqueue() method.
35 * For background processing, classes should implement either socket-based
36 * input (handleInput(), getSockets()) or idle-loop polling (idle()).
38 abstract class QueueManager extends IoManager
43 * Factory function to pull the appropriate QueueManager object
44 * for this site's configuration. It can then be used to queue
45 * events for later processing or to spawn a processing loop.
47 * Plugins can add to the built-in types by hooking StartNewQueueManager.
49 * @return QueueManager
51 public static function get()
53 if (empty(self::$qm)) {
55 if (Event::handle('StartNewQueueManager', array(&self::$qm))) {
57 $enabled = common_config('queue', 'enabled');
58 $type = common_config('queue', 'subsystem');
61 // does everything immediately
62 self::$qm = new UnQueueManager();
66 self::$qm = new DBQueueManager();
69 self::$qm = new StompQueueManager();
72 throw new ServerException("No queue manager class for type '$type'");
82 * @fixme wouldn't necessarily work with other class types.
83 * Better to change the interface...?
85 public static function multiSite()
87 if (common_config('queue', 'subsystem') == 'stomp') {
88 return IoManager::INSTANCE_PER_PROCESS;
90 return IoManager::SINGLE_ONLY;
94 function __construct()
100 * Store an object (usually/always a Notice) into the given queue
101 * for later processing. No guarantee is made on when it will be
102 * processed; it could be immediately or at some unspecified point
105 * Must be implemented by any queue manager.
107 * @param Notice $object
108 * @param string $queue
110 abstract function enqueue($object, $queue);
113 * Instantiate the appropriate QueueHandler class for the given queue.
115 * @param string $queue
116 * @return mixed QueueHandler or null
118 function getHandler($queue)
120 if (isset($this->handlers[$queue])) {
121 $class = $this->handlers[$queue];
122 if(is_object($class)) {
124 } else if (class_exists($class)) {
127 common_log(LOG_ERR, "Nonexistent handler class '$class' for queue '$queue'");
130 common_log(LOG_ERR, "Requested handler for unkown queue '$queue'");
136 * Get a list of all registered queue transport names.
138 * @return array of strings
142 return array_keys($this->handlers);
146 * Initialize the list of queue handlers
148 * @event StartInitializeQueueManager
149 * @event EndInitializeQueueManager
151 function initialize()
153 if (Event::handle('StartInitializeQueueManager', array($this))) {
154 if (!defined('XMPP_ONLY_FLAG')) { // hack!
155 $this->connect('plugin', 'PluginQueueHandler');
156 $this->connect('omb', 'OmbQueueHandler');
157 $this->connect('ping', 'PingQueueHandler');
158 if (common_config('sms', 'enabled')) {
159 $this->connect('sms', 'SmsQueueHandler');
163 // XMPP output handlers...
164 if (common_config('xmpp', 'enabled') && !defined('XMPP_EMERGENCY_FLAG')) {
165 $this->connect('jabber', 'JabberQueueHandler');
166 $this->connect('public', 'PublicQueueHandler');
168 // @fixme this should move up a level or should get an actual queue
169 $this->connect('confirm', 'XmppConfirmHandler');
172 if (!defined('XMPP_ONLY_FLAG')) { // hack!
173 // For compat with old plugins not registering their own handlers.
174 $this->connect('plugin', 'PluginQueueHandler');
177 if (!defined('XMPP_ONLY_FLAG')) { // hack!
178 Event::handle('EndInitializeQueueManager', array($this));
183 * Register a queue transport name and handler class for your plugin.
184 * Only registered transports will be reliably picked up!
186 * @param string $transport
187 * @param string $class class name or object instance
189 public function connect($transport, $class)
191 $this->handlers[$transport] = $class;
195 * Send a statistic ping to the queue monitoring system,
196 * optionally with a per-queue id.
199 * @param string $queue
201 function stats($key, $queue=false)
205 $owners[] = "queue:$queue";
206 $owners[] = "site:" . common_config('site', 'server');
208 if (isset($this->master)) {
209 $this->master->stats($key, $owners);
211 $monitor = new QueueMonitor();
212 $monitor->stats($key, $owners);