Added a events for the settings menu items

[quix0rs-gnu-social.git] / lib / queuehandler.php

diff --git a/lib/queuehandler.php b/lib/queuehandler.php
index f11e5bd90d99de662a63e9808d81bd2f9e5b8def..cd43b1e09a77916a80452adf101349c65fbabeec 100644 (file)
--- 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,7 +17,7 @@
  * 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');
@@ -27,6 +27,22 @@ define('CLAIM_TIMEOUT', 1200);
 define('QUEUE_HANDLER_MISS_IDLE', 10);
 define('QUEUE_HANDLER_HIT_IDLE', 0);
 
+/**
+ * Base class for queue handlers.
+ *
+ * As extensions of the Daemon class, each queue handler has the ability
+ * to launch itself in the background, at which point it'll pass control
+ * to the configured QueueManager class to poll for updates.
+ *
+ * Subclasses must override at least the following methods:
+ * - transport
+ * - start
+ * - finish
+ * - handle_notice
+ *
+ * Some subclasses will also want to override the idle handler:
+ * - idle
+ */
 class QueueHandler extends Daemon
 {
 
@@ -39,6 +55,14 @@ class QueueHandler extends Daemon
         }
     }
 
+    /**
+     * How many seconds a polling-based queue manager should wait between
+     * checks for new items to handle.
+     *
+     * Defaults to 60 seconds; override to speed up or slow down.
+     *
+     * @return int timeout in seconds
+     */
     function timeout()
     {
         return 60;
@@ -54,27 +78,73 @@ class QueueHandler extends Daemon
         return strtolower($this->class_name().'.'.$this->get_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;
     }
 
+    /**
+     * Initialization, run when the queue handler starts.
+     * If this function indicates failure, the handler run will be aborted.
+     *
+     * @fixme run() will abort if this doesn't return true,
+     *        but some subclasses don't bother.
+     * @return boolean true on success, false on failure
+     */
     function start()
     {
     }
 
+    /**
+     * Cleanup, run when the queue handler ends.
+     * If this function indicates failure, a warning will be logged.
+     *
+     * @fixme run() will throw warnings if this doesn't return true,
+     *        but many subclasses don't bother.
+     * @return boolean true on success, false on failure
+     */
     function finish()
     {
     }
 
+    /**
+     * Here's the meat of your queue handler -- you're handed a Notice
+     * 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 Notice $notice
+     * @return boolean true on success, false on failure
+     */
     function handle_notice($notice)
     {
         return true;
     }
 
+    /**
+     * Setup and start of run loop for this queue handler as a daemon.
+     * Most of the heavy lifting is passed on to the QueueManager's service()
+     * method, which passes control back to our handle_notice() method for
+     * each notice that comes in on the queue.
+     *
+     * Most of the time this won't need to be overridden in a subclass.
+     *
+     * @return boolean true on success, false on failure
+     */
     function run()
     {
         if (!$this->start()) {
+            $this->log(LOG_WARNING, 'failed to start');
             return false;
         }
 
@@ -87,12 +157,26 @@ class QueueHandler extends Daemon
 
         $qm->service($queue, $this);
 
+        $this->log(LOG_INFO, 'finished servicing the queue');
+
         if (!$this->finish()) {
+            $this->log(LOG_WARNING, 'failed to clean up');
             return false;
         }
+
+        $this->log(LOG_INFO, 'terminating normally');
+
         return true;
     }
 
+    /**
+     * Called by QueueHandler after each handled item or empty polling cycle.
+     * This is a good time to e.g. service your XMPP connection.
+     *
+     * Doesn't need to be overridden if there's no maintenance to do.
+     *
+     * @param int $timeout seconds to sleep if there's nothing to do
+     */
     function idle($timeout=0)
     {
         if ($timeout > 0) {