]> git.mxchange.org Git - quix0rs-gnu-social.git/blobdiff - scripts/xmppconfirmhandler.php
Fix help text for getvaliddaemons.php
[quix0rs-gnu-social.git] / scripts / xmppconfirmhandler.php
index 3c31c5d8b0e5c7f2c406a474d456e9ceab6c801a..d6821ddefae03affd7595396f14489f6a74f8571 100755 (executable)
@@ -2,7 +2,7 @@
 <?php
 /*
  * Laconica - a distributed open-source microblogging tool
- * Copyright (C) 2008, Controlez-Vous, Inc.
+ * Copyright (C) 2008, 2009, Control Yourself, 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/>.
  */
 
-# 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');
+$shortoptions = 'i::';
+$longoptions = array('id::');
+
+$helptext = <<<END_OF_JABBER_HELP
+Daemon script for pushing new confirmations to Jabber users.
+
+    -i --id           Identity (default none)
 
-set_error_handler('common_error_handler');
+END_OF_JABBER_HELP;
+
+require_once INSTALLDIR.'/scripts/commandline.inc';
+require_once INSTALLDIR . '/lib/jabber.php';
+require_once INSTALLDIR . '/lib/xmppqueuehandler.php';
 
 define('CLAIM_TIMEOUT', 1200);
 
-class XmppConfirmHandler {
-
-       var $_id = 'confirm';
-       
-       function XmppConfirmHandler($id=NULL) {
-               if ($id) {
-                       $this->_id = $id;
-               }
-       }
-
-       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 run() {
-               if (!$this->start()) {
-                       return false;
-               }
-               $this->log(LOG_INFO, 'checking for queued confirmations');
-               do {
-                       $confirm = $this->next_confirm();
-                       if ($confirm) {
-                               $this->log(LOG_INFO, 'Sending confirmation for ' . $confirm->address);
-                               $user = User::staticGet($confirm->user_id);
-                               if (!$user) {
-                                       $this->log(LOG_WARNING, 'Confirmation for unknown user ' . $confirm->user_id);
-                                       continue;
-                               }
-                               $success = jabber_confirm_address($confirm->code,
-                                                                                                 $user->nickname,
-                                                                                                 $confirm->address);
-                               if (!$success) {
-                                       $this->log(LOG_ERR, 'Confirmation failed for ' . $confirm->address);
-                                       # Just let the claim age out; hopefully things work then
-                                       continue;
-                               } else {
-                                       $this->log(LOG_INFO, 'Confirmation sent for ' . $confirm->address);
-                                       # Mark confirmation sent
-                                       $original = clone($confirm);
-                                       $confirm->sent = $confirm->claimed;
-                                       $result = $confirm->update($original);
-                                       if (!$result) {
-                                               $this->log(LOG_ERR, 'Cannot mark sent for ' . $confirm->address);
-                                               # Just let the claim age out; hopefully things work then
-                                               continue;
-                                       }
-                               }
-                               $this->idle(0);
-                       } else {
-#                              $this->clear_old_confirm_claims();
-                               $this->idle(10);
-                       }
-               } while (true);
-               if (!$this->finish()) {
-                       return false;
-               }
-               return true;
-       }
-
-       function next_confirm() {
-               $confirm = new Confirm_address();
-               $confirm->whereAdd('claimed IS NULL');
-               $confirm->whereAdd('sent IS NULL');
-               # XXX: eventually we could do other confirmations in the queue, too
-               $confirm->address_type = 'jabber';
-               $confirm->orderBy('modified DESC');
-               $confirm->limit(1);
-               if ($confirm->find(TRUE)) {
-                       $this->log(LOG_INFO, 'Claiming confirmation for ' . $confirm->address);
-                       # working around some weird DB_DataObject behaviour
-                       $confirm->whereAdd(''); # clears where stuff
-                       $original = clone($confirm);
-                       $confirm->claimed = common_sql_now();
-                       $result = $confirm->update($original);
-                       if ($result) {
-                               $this->log(LOG_INFO, 'Succeeded in claim! '. $result);
-                               return $confirm;
-                       } else {
-                               $this->log(LOG_INFO, 'Failed in claim!');
-                               return false;
-                       }
-               }
-               return NULL;
-       }
-
-       function clear_old_confirm_claims() {
-               $confirm = new Confirm();
-               $confirm->claimed = NULL;
-               $confirm->whereAdd('now() - claimed > '.CLAIM_TIMEOUT);
-               $confirm->update(DB_DATAOBJECT_WHEREADD_ONLY);
-       }
-       
-       function log($level, $msg) {
-               common_log($level, 'XmppConfirmHandler ('. $this->_id .'): '.$msg);
-       }
-       
-       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';
-               }
-       }
+class XmppConfirmHandler extends XmppQueueHandler
+{
+    var $_id = 'confirm';
+
+    function class_name()
+    {
+        return 'XmppConfirmHandler';
+    }
+
+    function run()
+    {
+        if (!$this->start()) {
+            return false;
+        }
+        $this->log(LOG_INFO, 'checking for queued confirmations');
+        do {
+            $confirm = $this->next_confirm();
+            if ($confirm) {
+                $this->log(LOG_INFO, 'Sending confirmation for ' . $confirm->address);
+                $user = User::staticGet($confirm->user_id);
+                if (!$user) {
+                    $this->log(LOG_WARNING, 'Confirmation for unknown user ' . $confirm->user_id);
+                    continue;
+                }
+                $success = jabber_confirm_address($confirm->code,
+                                                  $user->nickname,
+                                                  $confirm->address);
+                if (!$success) {
+                    $this->log(LOG_ERR, 'Confirmation failed for ' . $confirm->address);
+                    # Just let the claim age out; hopefully things work then
+                    continue;
+                } else {
+                    $this->log(LOG_INFO, 'Confirmation sent for ' . $confirm->address);
+                    # Mark confirmation sent; need a dupe so we don't have the WHERE clause
+                    $dupe = Confirm_address::staticGet('code', $confirm->code);
+                    if (!$dupe) {
+                        common_log(LOG_WARNING, 'Could not refetch confirm', __FILE__);
+                        continue;
+                    }
+                    $orig = clone($dupe);
+                    $dupe->sent = $dupe->claimed;
+                    $result = $dupe->update($orig);
+                    if (!$result) {
+                        common_log_db_error($dupe, 'UPDATE', __FILE__);
+                        # Just let the claim age out; hopefully things work then
+                        continue;
+                    }
+                    $dupe->free();
+                    unset($dupe);
+                }
+                $user->free();
+                unset($user);
+                $confirm->free();
+                unset($confirm);
+                $this->idle(0);
+            } else {
+#                $this->clear_old_confirm_claims();
+                $this->idle(10);
+            }
+        } while (true);
+        if (!$this->finish()) {
+            return false;
+        }
+        return true;
+    }
+
+    function next_confirm()
+    {
+        $confirm = new Confirm_address();
+        $confirm->whereAdd('claimed IS null');
+        $confirm->whereAdd('sent IS null');
+        # XXX: eventually we could do other confirmations in the queue, too
+        $confirm->address_type = 'jabber';
+        $confirm->orderBy('modified DESC');
+        $confirm->limit(1);
+        if ($confirm->find(true)) {
+            $this->log(LOG_INFO, 'Claiming confirmation for ' . $confirm->address);
+                # working around some weird DB_DataObject behaviour
+            $confirm->whereAdd(''); # clears where stuff
+            $original = clone($confirm);
+            $confirm->claimed = common_sql_now();
+            $result = $confirm->update($original);
+            if ($result) {
+                $this->log(LOG_INFO, 'Succeeded in claim! '. $result);
+                return $confirm;
+            } else {
+                $this->log(LOG_INFO, 'Failed in claim!');
+                return false;
+            }
+        }
+        return null;
+    }
+
+    function clear_old_confirm_claims()
+    {
+        $confirm = new Confirm();
+        $confirm->claimed = null;
+        $confirm->whereAdd('now() - claimed > '.CLAIM_TIMEOUT);
+        $confirm->update(DB_DATAOBJECT_WHEREADD_ONLY);
+        $confirm->free();
+        unset($confirm);
+    }
 }
 
-ini_set("max_execution_time", "0");
-ini_set("max_input_time", "0");
-set_time_limit(0);
-mb_internal_encoding('UTF-8');
+// Abort immediately if xmpp is not enabled, otherwise the daemon chews up
+// lots of CPU trying to connect to unconfigured servers
+if (common_config('xmpp','enabled')==false) {
+    print "Aborting daemon - xmpp is disabled\n";
+    exit();
+}
 
-$resource = ($argc > 1) ? $argv[1] : (common_config('xmpp', 'resource').'-confirm');
+if (have_option('i')) {
+    $id = get_option_value('i');
+} else if (have_option('--id')) {
+    $id = get_option_value('--id');
+} else if (count($args) > 0) {
+    $id = $args[0];
+} else {
+    $id = null;
+}
 
-$handler = new XmppConfirmHandler($resource);
+$handler = new XmppConfirmHandler($id);
 
 $handler->runOnce();