[PLUGINS] Added DBQueue plugin

lib/queue/queuemanager.php

@@ -59,7 +59,6 @@ abstract class QueueManager extends IoManager
         if (empty(self::$qm)) {
 
             if (Event::handle('StartNewQueueManager', array(&self::$qm))) {
-
                 $enabled = common_config('queue', 'enabled');
                 $type = common_config('queue', 'subsystem');
 
@@ -68,9 +67,6 @@ abstract class QueueManager extends IoManager
                     self::$qm = new UnQueueManager();
                 } else {
                     switch ($type) {
-                     case 'db':
-                        self::$qm = new DBQueueManager();
-                        break;
                      default:
                         throw new ServerException("No queue manager class for type '$type'");
                     }

plugins/DBQueue/DBQueuePlugin.php

@@ -0,0 +1,49 @@
+<?php
+// This file is part of GNU social - https://www.gnu.org/software/social
+//
+// GNU social 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.
+//
+// GNU social 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 GNU social.  If not, see <http://www.gnu.org/licenses/>.
+
+/**
+ * DB interface for GNU social queues
+ *
+ * @package   GNUsocial
+ * @author    Miguel Dantas <biodantasgs@gmail.com>
+ * @copyright 2019 Free Software Foundation, Inc http://www.fsf.org
+ * @license   https://www.gnu.org/licenses/agpl.html GNU AGPL v3 or later
+ */
+
+defined('GNUSOCIAL') || die();
+
+class DBQueuePlugin extends Plugin
+{
+    const PLUGIN_VERSION = '0.0.1';
+
+    public function onStartNewQueueManager(?QueueManager &$qm)
+    {
+        common_debug("Starting DB queue manager.");
+        $qm = new DBQueueManager();
+        return false;
+    }
+
+    public function onPluginVersion(array &$versions): bool
+    {
+        $versions[] = array('name' => 'DBQueue',
+                            'version' => self::PLUGIN_VERSION,
+                            'author' => 'Miguel Dantas',
+                            'description' =>
+                            // TRANS: Plugin description.
+                            _m('Plugin using the database as a backend for GNU social queues'));
+        return true;
+    }
+};

plugins/DBQueue/README

@@ -0,0 +1,18 @@
+DBQueuePlugin wraps the DBQueueManager class which is a queue manager
+that uses the database as it's backing storage.
+
+Installation
+============
+
+This plugin is replaces other queue manager plugins, such as UnQueue,
+which enabled by default and which should, but is not required to be
+disabled.
+
+addPlugin('DBQueue');
+
+Example
+=======
+
+In config.php
+
+addPlugin('DBQueue');

plugins/DBQueue/classes/DBQueueManager.php

@@ -50,13 +50,13 @@ class DBQueueManager extends QueueManager
         }
 
         $this->stats('enqueued', $queue);
-
         return true;
     }
 
     /**
      * Poll every 10 seconds for new events during idle periods.
      * We'll look in more often when there's data available.
+     * Must be greater than 0 for the poll method to be called
      *
      * @return int seconds
      */
@@ -69,9 +69,9 @@ class DBQueueManager extends QueueManager
      * Run a polling cycle during idle processing in the input loop.
      * @return boolean true if we should poll again for more data immediately
      */
-    public function poll()
+    public function poll(): bool
     {
-        //$this->_log(LOG_DEBUG, 'Checking for notices...');
+        $this->_log(LOG_DEBUG, 'Checking for notices...');
         $qi = Queue_item::top($this->activeQueues(), $this->getIgnoredTransports());
         if (!$qi instanceof Queue_item) {
             //$this->_log(LOG_DEBUG, 'No notices waiting; idling.');
@@ -88,7 +88,7 @@ class DBQueueManager extends QueueManager
 
         $rep = $this->logrep($item);
         $this->_log(LOG_DEBUG, 'Got '._ve($rep).' for transport '._ve($qi->transport));
-        
+
         try {
             $handler = $this->getHandler($qi->transport);
             $result = $handler->handle($item);
@@ -96,13 +96,16 @@ class DBQueueManager extends QueueManager
             $this->noHandlerFound($qi, $rep);
             return true;
         } catch (NoResultException $e) {
-            $this->_log(LOG_ERR, "[{$qi->transport}:$rep] ".get_class($e).' thrown ('._ve($e->getMessage()).'), ignoring queue_item '._ve($qi->getID()));
+            $this->_log(LOG_ERR, "[{$qi->transport}:$rep] ".get_class($e).' thrown ('.
+                        _ve($e->getMessage()).'), ignoring queue_item '._ve($qi->getID()));
             $result = true;
         } catch (AlreadyFulfilledException $e) {
-            $this->_log(LOG_ERR, "[{$qi->transport}:$rep] ".get_class($e).' thrown ('._ve($e->getMessage()).'), ignoring queue_item '._ve($qi->getID()));
+            $this->_log(LOG_ERR, "[{$qi->transport}:$rep] ".get_class($e).' thrown ('.
+                        _ve($e->getMessage()).'), ignoring queue_item '._ve($qi->getID()));
             $result = true;
         } catch (Exception $e) {
-            $this->_log(LOG_ERR, "[{$qi->transport}:$rep] Exception (".get_class($e).') thrown: '._ve($e->getMessage()));
+            $this->_log(LOG_ERR, "[{$qi->transport}:$rep] Exception (".
+                        get_class($e).') thrown: '._ve($e->getMessage()));
             $result = false;
         }
 

plugins/RedisQueue/classes/RedisQueueManager.php

@@ -10,6 +10,7 @@ class RedisQueueManager extends QueueManager
 
     public function __construct(string $server)
     {
+        parent::__construct();
         $this->server = $server;
         $this->queue = 'gnusocial:' . common_config('site', 'name');
     }
@@ -39,7 +40,6 @@ class RedisQueueManager extends QueueManager
 
     public function poll()
     {
-        common_debug("STARTING POLL");
         try {
             $this->_ensureConn();
             $ret = $this->client->lpop($this->queue);