]> git.mxchange.org Git - quix0rs-gnu-social.git/blobdiff - lib/queuemanager.php
Merge branch 'master' into testing
[quix0rs-gnu-social.git] / lib / queuemanager.php
index 0063ed5f3955e6609e17363f7ded30db5f91dab4..1fa3417829a30edbd73aefff9b6b885c9e364e36 100644 (file)
@@ -39,9 +39,10 @@ abstract class QueueManager extends IoManager
 {
     static $qm = null;
 
-    public $master = null;
-    public $handlers = array();
-    public $groups = array();
+    protected $master = null;
+    protected $handlers = array();
+    protected $groups = array();
+    protected $activeGroups = array();
 
     /**
      * Factory function to pull the appropriate QueueManager object
@@ -100,6 +101,23 @@ abstract class QueueManager extends IoManager
         $this->initialize();
     }
 
+    /**
+     * Optional; ping any running queue handler daemons with a notification
+     * such as announcing a new site to handle or requesting clean shutdown.
+     * This avoids having to restart all the daemons manually to update configs
+     * and such.
+     *
+     * Called from scripts/queuectl.php controller utility.
+     *
+     * @param string $event event key
+     * @param string $param optional parameter to append to key
+     * @return boolean success
+     */
+    public function sendControlSignal($event, $param='')
+    {
+        throw new Exception(get_class($this) . " does not support control signals.");
+    }
+
     /**
      * Store an object (usually/always a Notice) into the given queue
      * for later processing. No guarantee is made on when it will be
@@ -139,36 +157,25 @@ abstract class QueueManager extends IoManager
 
     /**
      * Encode an object for queued storage.
-     * Next gen may use serialization.
      *
-     * @param mixed $object
+     * @param mixed $item
      * @return string
      */
-    protected function encode($object)
+    protected function encode($item)
     {
-        if ($object instanceof Notice) {
-            return $object->id;
-        } else if (is_string($object)) {
-            return $object;
-        } else {
-            throw new ServerException("Can't queue this type", 500);
-        }
+        return serialize($item);
     }
 
     /**
      * Decode an object from queued storage.
-     * Accepts back-compat notice reference entries and strings for now.
+     * Accepts notice reference entries and serialized items.
      *
      * @param string
      * @return mixed
      */
     protected function decode($frame)
     {
-        if (is_numeric($frame)) {
-            return Notice::staticGet(intval($frame));
-        } else {
-            return $frame;
-        }
+        return unserialize($frame);
     }
 
     /**
@@ -186,56 +193,64 @@ abstract class QueueManager extends IoManager
             } else if (class_exists($class)) {
                 return new $class();
             } else {
-                common_log(LOG_ERR, "Nonexistent handler class '$class' for queue '$queue'");
+                $this->_log(LOG_ERR, "Nonexistent handler class '$class' for queue '$queue'");
             }
         } else {
-            common_log(LOG_ERR, "Requested handler for unkown queue '$queue'");
+            $this->_log(LOG_ERR, "Requested handler for unkown queue '$queue'");
         }
         return null;
     }
 
     /**
      * Get a list of registered queue transport names to be used
-     * for this daemon.
+     * for listening in this daemon.
      *
      * @return array of strings
      */
-    function getQueues()
+    function activeQueues()
     {
-        $group = $this->activeGroup();
-        return array_keys($this->groups[$group]);
+        $queues = array();
+        foreach ($this->activeGroups as $group) {
+            if (isset($this->groups[$group])) {
+                $queues = array_merge($queues, $this->groups[$group]);
+            }
+        }
+
+        return array_keys($queues);
     }
 
     /**
-     * Initialize the list of queue handlers
+     * Initialize the list of queue handlers for the current site.
      *
      * @event StartInitializeQueueManager
      * @event EndInitializeQueueManager
      */
     function initialize()
     {
-        // @fixme we'll want to be able to listen to particular queues...
+        $this->handlers = array();
+        $this->groups = array();
+        $this->groupsByTransport = array();
+
         if (Event::handle('StartInitializeQueueManager', array($this))) {
-            $this->connect('plugin', 'PluginQueueHandler');
+            $this->connect('distrib', 'DistribQueueHandler');
             $this->connect('omb', 'OmbQueueHandler');
             $this->connect('ping', 'PingQueueHandler');
-            $this->connect('distrib', 'DistribQueueHandler');
             if (common_config('sms', 'enabled')) {
                 $this->connect('sms', 'SmsQueueHandler');
             }
 
-            // XMPP output handlers...
-            $this->connect('jabber', 'JabberQueueHandler');
-            $this->connect('public', 'PublicQueueHandler');
+            // Background user management tasks...
+            $this->connect('deluser', 'DelUserQueueHandler');
+            $this->connect('feedimp', 'FeedImporter');
+            $this->connect('actimp', 'ActivityImporter');
+            $this->connect('acctmove', 'AccountMover');
+            $this->connect('actmove', 'ActivityMover');
 
-            // @fixme this should get an actual queue
-            //$this->connect('confirm', 'XmppConfirmHandler');
+            // Broadcasting profile updates to OMB remote subscribers
+            $this->connect('profile', 'ProfileQueueHandler');
 
             // For compat with old plugins not registering their own handlers.
             $this->connect('plugin', 'PluginQueueHandler');
-
-            $this->connect('xmppout', 'XmppOutQueueHandler', 'xmppdaemon');
-
         }
         Event::handle('EndInitializeQueueManager', array($this));
     }
@@ -248,25 +263,41 @@ abstract class QueueManager extends IoManager
      * @param string $class class name or object instance
      * @param string $group
      */
-    public function connect($transport, $class, $group='queuedaemon')
+    public function connect($transport, $class, $group='main')
     {
         $this->handlers[$transport] = $class;
         $this->groups[$group][$transport] = $class;
+        $this->groupsByTransport[$transport] = $group;
     }
 
     /**
-     * @return string queue group to use for this request
+     * Set the active group which will be used for listening.
+     * @param string $group
      */
-    function activeGroup()
+    function setActiveGroup($group)
     {
-        $group = 'queuedaemon';
-        if ($this->master) {
-            // hack hack
-            if ($this->master instanceof XmppMaster) {
-                return 'xmppdaemon';
-            }
+        $this->activeGroups = array($group);
+    }
+
+    /**
+     * Set the active group(s) which will be used for listening.
+     * @param array $groups
+     */
+    function setActiveGroups($groups)
+    {
+        $this->activeGroups = $groups;
+    }
+
+    /**
+     * @return string queue group for this queue
+     */
+    function queueGroup($queue)
+    {
+        if (isset($this->groupsByTransport[$queue])) {
+            return $this->groupsByTransport[$queue];
+        } else {
+            throw new Exception("Requested group for unregistered transport $queue");
         }
-        return $group;
     }
 
     /**
@@ -290,4 +321,15 @@ abstract class QueueManager extends IoManager
             $monitor->stats($key, $owners);
         }
     }
+
+    protected function _log($level, $msg)
+    {
+        $class = get_class($this);
+        if ($this->activeGroups) {
+            $groups = ' (' . implode(',', $this->activeGroups) . ')';
+        } else {
+            $groups = '';
+        }
+        common_log($level, "$class$groups: $msg");
+    }
 }