<?php
/*
- * Laconica - a distributed open-source microblogging tool
- * Copyright (C) 2008, Controlez-Vous, 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
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*/
-define('CLAIM_TIMEOUT', 1200);
+if (!defined('STATUSNET') && !defined('LACONICA')) { exit(1); }
-if (!defined('LACONICA')) { exit(1); }
-
-require_once(INSTALLDIR.'/lib/daemon.php');
-
-class QueueHandler extends Daemon {
-
- var $_id = 'generic';
-
- function QueueHandler($id=NULL) {
- if ($id) {
- $this->set_id($id);
- }
- }
-
- 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;
- }
-
- function transport() {
- return NULL;
- }
-
- function start() {
- }
-
- function finish() {
- }
+/**
+ * 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
+{
- function handle_notice($notice) {
- return true;
- }
-
- function run() {
- if (!$this->start()) {
- return false;
- }
- $this->log(LOG_INFO, 'checking for queued notices');
- $transport = $this->transport();
- do {
- $qi = Queue_item::top($transport);
- if ($qi) {
- $this->log(LOG_INFO, 'Got item enqueued '.common_exact_date($qi->created));
- $notice = Notice::staticGet($qi->notice_id);
- if ($notice) {
- $this->log(LOG_INFO, 'broadcasting notice ID = ' . $notice->id);
- # XXX: what to do if broadcast fails?
- $result = $this->handle_notice($notice);
- if (!$result) {
- $this->log(LOG_WARNING, 'Failed broadcast for notice ID = ' . $notice->id);
- $orig = $qi;
- $qi->claimed = NULL;
- $qi->update($orig);
- $this->log(LOG_WARNING, 'Abandoned claim for notice ID = ' . $notice->id);
- continue;
- }
- $this->log(LOG_INFO, 'finished broadcasting notice ID = ' . $notice->id);
- $notice = NULL;
- } else {
- $this->log(LOG_WARNING, 'queue item for notice that does not exist');
- }
- $qi->delete();
- $this->idle(0);
- } else {
- $this->clear_old_claims();
- $this->idle(5);
- }
- } while (true);
- if (!$this->finish()) {
- return false;
- }
- return true;
- }
+ /**
+ * 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 idle($timeout=0) {
- if ($timeout>0) {
- sleep($timeout);
- }
- }
-
- function clear_old_claims() {
- $qi = new Queue_item();
- $qi->transport = $this->transport();
- $qi->whereAdd('now() - claimed > '.CLAIM_TIMEOUT);
- $qi->update(DB_DATAOBJECT_WHEREADD_ONLY);
- }
-
- function log($level, $msg) {
- common_log($level, $this->class_name() . ' ('. $this->get_id() .'): '.$msg);
- }
+ /**
+ * 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)
+ {
+ return true;
+ }
}
-
\ No newline at end of file
+