X-Git-Url: https://git.mxchange.org/?a=blobdiff_plain;f=lib%2Fqueuehandler.php;h=2909cd83b100656efd354063323610590191d152;hb=c95daacfdb6d89098716b8eeccfdd82124019d7a;hp=c2ff10f32f07f4858e933b67fba8d8987c1b9e18;hpb=c981f5bcec02295482153e45b0d57f37260706c0;p=quix0rs-gnu-social.git

diff --git a/lib/queuehandler.php b/lib/queuehandler.php
index c2ff10f32f..2909cd83b1 100644
--- a/lib/queuehandler.php
+++ b/lib/queuehandler.php
@@ -1,7 +1,7 @@
 <?php
 /*
- * Laconica - a distributed open-source microblogging tool
- * Copyright (C) 2008, 2009, Control Yourself, Inc.
+ * StatusNet - the distributed open-source microblogging tool
+ * Copyright (C) 2008, 2009, StatusNet, Inc.
  *
  * 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
@@ -17,108 +17,52 @@
  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  */
 
-if (!defined('LACONICA')) { exit(1); }
+if (!defined('STATUSNET') && !defined('LACONICA')) { exit(1); }
 
-require_once(INSTALLDIR.'/lib/daemon.php');
-require_once(INSTALLDIR.'/classes/Queue_item.php');
-require_once(INSTALLDIR.'/classes/Notice.php');
-
-define('CLAIM_TIMEOUT', 1200);
-define('QUEUE_HANDLER_MISS_IDLE', 10);
-define('QUEUE_HANDLER_HIT_IDLE', 0);
-
-class QueueHandler extends Daemon
+/**
+ * Base class for queue handlers.
+ *
+ * As of 0.9, queue handlers are short-lived for items as they are
+ * dequeued by a QueueManager running in an IoMaster in a daemon
+ * such as queuedaemon.php.
+ *
+ * Extensions requiring long-running maintenance or polling should
+ * register an IoManager.
+ *
+ * Subclasses must override at least the following methods:
+ * - transport
+ * - handle
+ */
+class QueueHandler
 {
-    var $_id = 'generic';
-
-    function __construct($id=null, $daemonize=true)
-    {
-        parent::__construct($daemonize);
-
-        if ($id) {
-            $this->set_id($id);
-        }
-    }
-
-    function timeout()
-    {
-        return 60;
-    }
-
-    function class_name()
-    {
-        return ucfirst($this->transport()) . 'Handler';
-    }
-
-    function name()
-    {
-        return strtolower($this->class_name().'.'.$this->get_id());
-    }
-
-    function get_id()
-    {
-        return $this->_id;
-    }
-
-    function set_id($id)
-    {
-        $this->_id = $id;
-    }
 
+    /**
+     * Return transport keyword which identifies items this queue handler
+     * services; must be defined for all subclasses.
+     *
+     * Must be 8 characters or less to fit in the queue_item database.
+     * ex "email", "jabber", "sms", "irc", ...
+     *
+     * @return string
+     */
     function transport()
     {
         return null;
     }
 
-    function start()
+    /**
+     * Here's the meat of your queue handler -- you're handed a Notice
+     * or other object, which you may do as you will with.
+     *
+     * If this function indicates failure, a warning will be logged
+     * and the item is placed back in the queue to be re-run.
+     *
+     * @param mixed $object
+     * @return boolean true on success, false on failure
+     */
+    function handle($object)
     {
-    }
-
-    function finish()
-    {
-    }
-
-    function handle_notice($notice)
-    {
-        return true;
-    }
-
-    function run()
-    {
-        if (!$this->start()) {
-            return false;
-        }
-
-        $this->log(LOG_INFO, 'checking for queued notices');
-
-        $queue   = $this->transport();
-        $timeout = $this->timeout();
-
-        $qm = QueueManager::get();
-
-        $qm->service($queue, $this);
-
-        if (!$this->finish()) {
-            return false;
-        }
         return true;
     }
-
-    function idle($timeout=0)
-    {
-        if ($timeout > 0) {
-            sleep($timeout);
-        }
-    }
-
-    function log($level, $msg)
-    {
-        common_log($level, $this->class_name() . ' ('. $this->get_id() .'): '.$msg);
-    }
-
-    function getSockets()
-    {
-        return array();
-    }
 }