abstract XMPP-related queue handling to a common superclass

darcs-hash:20080904194035-84dde-480b3605862d26eff6a2cac6eec02775628287e4.gz

4 files changed, 94 insertions, 149 deletions

diff --git a/scripts/xmppqueuehandler.php b/lib/xmppqueuehandler.php
index 1c594f210..ce82c9a46 100755..100644
--- a/scripts/xmppqueuehandler.php
+++ b/lib/xmppqueuehandler.php
@@ -1,4 +1,3 @@
-#!/usr/bin/env php
 <?php
 /*
  * Laconica - a distributed open-source microblogging tool
@@ -18,59 +17,47 @@
  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  */
 
-# Abort if called from a web server
-if (isset($_SERVER) && array_key_exists('REQUEST_METHOD', $_SERVER)) {
-	print "This script must be run from the command line\n";
-	exit();
-}
-
-define('INSTALLDIR', realpath(dirname(__FILE__) . '/..'));
-define('LACONICA', true);
+if (!defined('LACONICA')) { exit(1); }
 
-require_once(INSTALLDIR . '/lib/common.php');
-require_once(INSTALLDIR . '/lib/jabber.php');
-require_once(INSTALLDIR . '/lib/queuehandler.php');
+require_once(INSTALLDIR.'/lib/queuehandler.php');
 
-set_error_handler('common_error_handler');
+/**
+ * Common superclass for all XMPP-using queue handlers. They all need to 
+ * service their message queues on idle, and forward any incoming messages
+ * to the XMPP listener connection. So, we abstract out common code to a
+ * superclass.
+ */
 
 class XmppQueueHandler extends QueueHandler {
-
-	var $conn = NULL;
-
-	function transport() {
-		return 'jabber';
-	}
-
+	
 	function start() {
-		$this->log(LOG_INFO, "INITIALIZE");
 		# Low priority; we don't want to receive messages
+		$this->log(LOG_INFO, "INITIALIZE");
 		$this->conn = jabber_connect($this->_id);
 		if ($this->conn) {
-			$this->conn->setReconnectTimeout(600);
 			$this->conn->addEventHandler('message', 'forward_message', $this);
 			$this->conn->addEventHandler('reconnect', 'handle_reconnect', $this);
+			$this->conn->setReconnectTimeout(600);
 			jabber_send_presence("Send me a message to post a notice", 'available', NULL, 'available', -1);
 		}
 		return !is_null($this->conn);
 	}
-
+	
 	function handle_reconnect(&$pl) {
 		$this->conn->processUntil('session_start');
 		$this->conn->presence(NULL, 'available', NULL, 'available', -1);
 	}
-	
-	function handle_notice($notice) {
-		return jabber_broadcast_notice($notice);
-	}
 
 	function idle($timeout=0) {
-		# Process the queue for a second
-		$this->conn->processTime($timeout);
-	}
-
-	function finish() {
+		# Process the queue for as long as needed
+		try {
+			$this->conn->processTime($timeout);
+		} catch (XMPPHP_Exception $e) {
+			$this->log(LOG_ERROR, "Got an XMPPHP_Exception: " . $e->getMessage());
+			exit(1);
+		}
 	}
-
+	
 	function forward_message(&$pl) {
 		if ($pl['type'] != 'chat') {
 		    $this->log(LOG_DEBUG, 'Ignoring message of type ' . $pl['type'] . ' from ' . $pl['from']);
@@ -100,14 +87,3 @@ class XmppQueueHandler extends QueueHandler {
 		}
 	}
 }
-
-ini_set("max_execution_time", "0");
-ini_set("max_input_time", "0");
-set_time_limit(0);
-mb_internal_encoding('UTF-8');
-
-$resource = ($argc > 1) ? $argv[1] : (common_config('xmpp','resource') . '-queuehandler');
-
-$handler = new XmppQueueHandler($resource);
-
-$handler->runOnce();
\ No newline at end of file
diff --git a/scripts/jabberqueuehandler.php b/scripts/jabberqueuehandler.php
new file mode 100755
index 000000000..196b3bf6b
--- /dev/null
+++ b/scripts/jabberqueuehandler.php
@@ -0,0 +1,63 @@
+#!/usr/bin/env php
+<?php
+/*
+ * Laconica - a distributed open-source microblogging tool
+ * Copyright (C) 2008, Controlez-Vous, 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
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * This program 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 this program.  If not, see <http://www.gnu.org/licenses/>.
+ */
+
+# Abort if called from a web server
+if (isset($_SERVER) && array_key_exists('REQUEST_METHOD', $_SERVER)) {
+	print "This script must be run from the command line\n";
+	exit();
+}
+
+define('INSTALLDIR', realpath(dirname(__FILE__) . '/..'));
+define('LACONICA', true);
+
+require_once(INSTALLDIR . '/lib/common.php');
+require_once(INSTALLDIR . '/lib/jabber.php');
+require_once(INSTALLDIR . '/lib/queuehandler.php');
+
+set_error_handler('common_error_handler');
+
+class JabberQueueHandler extends XmppQueueHandler {
+
+	var $conn = NULL;
+
+	function transport() {
+		return 'jabber';
+	}
+
+	function handle_notice($notice) {
+		try {
+			return jabber_broadcast_notice($notice);
+		} catch (XMPPHP_Exception $e) {
+			$this->log(LOG_ERROR, "Got an XMPPHP_Exception: " . $e->getMessage());
+			exit(1);
+		}
+	}
+}
+
+ini_set("max_execution_time", "0");
+ini_set("max_input_time", "0");
+set_time_limit(0);
+mb_internal_encoding('UTF-8');
+
+$resource = ($argc > 1) ? $argv[1] : (common_config('xmpp','resource') . '-queuehandler');
+
+$handler = new JabberQueueHandler($resource);
+
+$handler->runOnce();
\ No newline at end of file
diff --git a/scripts/publicqueuehandler.php b/scripts/publicqueuehandler.php
index 62e60b858..dde6a3427 100755
--- a/scripts/publicqueuehandler.php
+++ b/scripts/publicqueuehandler.php
@@ -29,69 +29,22 @@ define('LACONICA', true);
 
 require_once(INSTALLDIR . '/lib/common.php');
 require_once(INSTALLDIR . '/lib/jabber.php');
-require_once(INSTALLDIR . '/lib/queuehandler.php');
+require_once(INSTALLDIR . '/lib/xmppqueuehandler.php');
 
 set_error_handler('common_error_handler');
 
-class PublicQueueHandler extends QueueHandler {
+class PublicQueueHandler extends XmppQueueHandler {
 	
 	function transport() {
 		return 'public';
 	}
 	
-	function start() {
-		$this->log(LOG_INFO, "INITIALIZE");
-		# Low priority; we don't want to receive messages
-
-		$this->conn = jabber_connect($this->_id);
-		if ($this->conn) {
-			$this->conn->addEventHandler('message', 'forward_message', $this);
-			$this->conn->addEventHandler('reconnect', 'handle_reconnect', $this);
-			$this->conn->setReconnectTimeout(600);
-			jabber_send_presence("Send me a message to post a notice", 'available', NULL, 'available', -1);
-		}
-		return !is_null($this->conn);
-	}
-
-	function handle_reconnect(&$pl) {
-		$this->conn->processUntil('session_start');
-		$this->conn->presence(NULL, 'available', NULL, 'available', -1);
-	}
-
 	function handle_notice($notice) {
-		return jabber_public_notice($notice);
-	}
-	
-	function idle($timeout=0) {
-		$this->conn->processTime($timeout);
-	}
-
-	function forward_message(&$pl) {
-		if ($pl['type'] != 'chat') {
-		    $this->log(LOG_DEBUG, 'Ignoring message of type ' . $pl['type'] . ' from ' . $pl['from']);
-			return;
-		}
-		$listener = $this->listener();
-		if (strtolower($listener) == strtolower($pl['from'])) {
-			$this->log(LOG_WARNING, 'Ignoring loop message.');
-			return;
-		}
-		$this->log(LOG_INFO, 'Forwarding message from ' . $pl['from'] . ' to ' . $listener);
-		$this->conn->message($this->listener(), $pl['body'], 'chat', NULL, $this->ofrom($pl['from']));
-	}
-
-	function ofrom($from) {
-		$address = "<addresses xmlns='http://jabber.org/protocol/address'>\n";
-		$address .= "<address type='ofrom' jid='$from' />\n";
-		$address .= "</addresses>\n";
-		return $address;
-	}
-
-	function listener() {
-		if (common_config('xmpp', 'listener')) {
-			return common_config('xmpp', 'listener');
-		} else {
-			return jabber_daemon_address() . '/' . common_config('xmpp','resource') . '-listener';
+		try {
+			return jabber_public_notice($notice);
+		} catch (XMPPHP_Exception $e) {
+			$this->log(LOG_ERROR, "Got an XMPPHP_Exception: " . $e->getMessage());
+			exit(1);
 		}
 	}
 }
diff --git a/scripts/xmppconfirmhandler.php b/scripts/xmppconfirmhandler.php
index a97b61a7f..3906ac5eb 100755
--- a/scripts/xmppconfirmhandler.php
+++ b/scripts/xmppconfirmhandler.php
@@ -29,32 +29,18 @@ define('LACONICA', true);
 
 require_once(INSTALLDIR . '/lib/common.php');
 require_once(INSTALLDIR . '/lib/jabber.php');
-require_once(INSTALLDIR . '/lib/queuehandler.php');
+require_once(INSTALLDIR . '/lib/xmppqueuehandler.php');
 
 set_error_handler('common_error_handler');
 
 define('CLAIM_TIMEOUT', 1200);
 
-class XmppConfirmHandler extends QueueHandler {
+class XmppConfirmHandler extends XmppQueueHandler {
 
 	var $_id = 'confirm';
 	
-	function start() {
-		# Low priority; we don't want to receive messages
-		$this->log(LOG_INFO, "INITIALIZE");
-		$this->conn = jabber_connect($this->_id);
-		if ($this->conn) {
-			$this->conn->addEventHandler('message', 'forward_message', $this);
-			$this->conn->addEventHandler('reconnect', 'handle_reconnect', $this);
-			$this->conn->setReconnectTimeout(600);
-			jabber_send_presence("Send me a message to post a notice", 'available', NULL, 'available', -1);
-		}
-		return !is_null($this->conn);
-	}
-	
-	function handle_reconnect(&$pl) {
-		$this->conn->processUntil('session_start');
-		$this->conn->presence(NULL, 'available', NULL, 'available', -1);
+	function class_name() {
+		return 'XmppConfirmHandler';
 	}
 	
 	function run() {
@@ -134,39 +120,6 @@ class XmppConfirmHandler extends QueueHandler {
 		$confirm->whereAdd('now() - claimed > '.CLAIM_TIMEOUT);
 		$confirm->update(DB_DATAOBJECT_WHEREADD_ONLY);
 	}
-	
-	function idle($timeout=0) {
-		$this->conn->processTime($timeout);
-	}
-
-	function forward_message(&$pl) {
-		if ($pl['type'] != 'chat') {
-		    $this->log(LOG_DEBUG, 'Ignoring message of type ' . $pl['type'] . ' from ' . $pl['from']);
-			return;
-		}
-		$listener = $this->listener();
-		if (strtolower($listener) == strtolower($pl['from'])) {
-			$this->log(LOG_WARNING, 'Ignoring loop message.');
-			return;
-		}
-		$this->log(LOG_INFO, 'Forwarding message from ' . $pl['from'] . ' to ' . $listener);
-		$this->conn->message($this->listener(), $pl['body'], 'chat', NULL, $this->ofrom($pl['from']));
-	}
-
-	function ofrom($from) {
-		$address = "<addresses xmlns='http://jabber.org/protocol/address'>\n";
-		$address .= "<address type='ofrom' jid='$from' />\n";
-		$address .= "</addresses>\n";
-		return $address;
-	}
-
-	function listener() {
-		if (common_config('xmpp', 'listener')) {
-			return common_config('xmpp', 'listener');
-		} else {
-			return jabber_daemon_address() . '/' . common_config('xmpp','resource') . '-listener';
-		}
-	}
 }
 
 ini_set("max_execution_time", "0");