X-Git-Url: https://git.mxchange.org/?a=blobdiff_plain;f=scripts%2Fxmppdaemon.php;h=b79fa1b3ba0145101e167ddafea80fdd67ca3fc8;hb=b6dee88e5d0a0ed58391ccb8868f4afbf631342a;hp=76bd413f98b5544126b979151cb98d25410a3eab;hpb=cba4b50e44c501b5f73ba91179a6c8424b81caa8;p=quix0rs-gnu-social.git

diff --git a/scripts/xmppdaemon.php b/scripts/xmppdaemon.php
index 76bd413f98..b79fa1b3ba 100755
--- a/scripts/xmppdaemon.php
+++ b/scripts/xmppdaemon.php
@@ -18,467 +18,316 @@
  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  */
 
-function xmppdaemon_error_handler($errno, $errstr, $errfile, $errline, $errcontext) {
-    switch ($errno) {
-     case E_USER_ERROR:
-	echo "ERROR: [$errno] $errstr ($errfile:$errline)\n";
-	echo "  Fatal error on line $errline in file $errfile";
-	echo ", PHP " . PHP_VERSION . " (" . PHP_OS . ")\n";
-	echo "Aborting...\n";
-	exit(1);
-	break;
-
-    case E_USER_WARNING:
-	echo "WARNING [$errno] $errstr ($errfile:$errline)\n";
-	break;
-
-     case E_USER_NOTICE:
-	echo "My NOTICE [$errno] $errstr ($errfile:$errline)\n";
-	break;
-
-     default:
-	echo "Unknown error type: [$errno] $errstr ($errfile:$errline)\n";
-	break;
-    }
-
-    /* Don't execute PHP internal error handler */
-    return true;
-}
-
-set_error_handler('xmppdaemon_error_handler');
-
 # 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();
+    print "This script must be run from the command line\n";
+    exit();
 }
 
 define('INSTALLDIR', realpath(dirname(__FILE__) . '/..'));
 define('LACONICA', true);
-define('CLAIM_TIMEOUT', 100000);
 
 require_once(INSTALLDIR . '/lib/common.php');
 require_once(INSTALLDIR . '/lib/jabber.php');
+require_once(INSTALLDIR . '/lib/daemon.php');
+
+set_error_handler('common_error_handler');
 
 # This is kind of clunky; we create a class to call the global functions
 # in jabber.php, which create a new XMPP class. A more elegant (?) solution
 # might be to use make this a subclass of XMPP.
 
-class XMPPDaemon {
-
-	function XMPPDaemon($resource=NULL) {
-		static $attrs = array('server', 'port', 'user', 'password', 'host');
-
-		foreach ($attrs as $attr)
-		{
-			$this->$attr = common_config('xmpp', $attr);
-		}
-
-		if ($resource) {
-			$this->resource = $resource;
-		} else {
-			$this->resource = common_config('xmpp', 'resource') . 'daemon';
-		}
-
-		$this->log(LOG_INFO, "{$this->user}@{$this->server}/{$this->resource}");
-	}
-
-	function connect() {
-
-		$connect_to = ($this->host) ? $this->host : $this->server;
-
-		$this->log(LOG_INFO, "Connecting to $connect_to on port $this->port");
-
-		$this->conn = jabber_connect($this->resource);
-
-		if (!$this->conn) {
-			return false;
-		}
-
-		return !$this->conn->isDisconnected();
-	}
-
-	function handle() {
-
-		static $parts = array('message', 'presence',
-							  'end_stream', 'session_start');
-
-		while(!$this->conn->isDisconnected()) {
-
-			$payloads = $this->conn->processUntil($parts, 10);
-
-			if ($payloads) {
-				foreach($payloads as $event) {
-					$pl = $event[1];
-					switch($event[0]) {
-					 case 'message':
-						$this->handle_message($pl);
-						break;
-					 case 'presence':
-						$this->handle_presence($pl);
-						break;
-					 case 'session_start':
-						$this->handle_session($pl);
-						break;
-					}
-				}
-			}
-
-			$this->broadcast_queue();
-			$this->confirmation_queue();
-		}
-	}
-
-	function handle_session($pl) {
-		# XXX what to do here?
-		return true;
-	}
-
-	function get_user($from) {
-		$user = User::staticGet('jabber', jabber_normalize_jid($from));
-		return $user;
-	}
-
-	function get_confirmation($from) {
-		$confirm = new Confirm_address();
-		$confirm->address = $from;
-		$confirm->address_type = 'jabber';
-		if ($confirm->find(TRUE)) {
-			return $confirm;
-		} else {
-			return NULL;
-		}
-	}
-
-	function handle_message(&$pl) {
-		if ($pl['type'] != 'chat') {
-			return;
-		}
-		if (mb_strlen($pl['body']) == 0) {
-			return;
-		}
-
-		$from = jabber_normalize_jid($pl['from']);
-		$user = $this->get_user($from);
-
-		if (!$user) {
-			$this->from_site($from, 'Unknown user; go to ' .
-							 common_local_url('imsettings') .
-							 ' to add your address to your account');
-			$this->log(LOG_WARNING, 'Message from unknown user ' . $from);
-			return;
-		}
-		if ($this->handle_command($user, $pl['body'])) {
-			return;
-		} else if ($this->is_autoreply($pl['body'])) {
-			$this->log(LOG_INFO, 'Ignoring auto reply from ' . $from);
-			return;
-		} else if ($this->is_otr($pl['body'])) {
-			$this->log(LOG_INFO, 'Ignoring OTR from ' . $from);
-			return;
-		} else {
-			$len = mb_strlen($pl['body']);
-			if($len > 140) {
-				$this->from_site($from, 'Message too long - maximum is 140 characters, you sent ' . $len);
-				return;
-			}
-			$this->add_notice($user, $pl);
-		}
-	}
-
-	function is_autoreply($txt) {
-		if (preg_match('/[\[\(]?[Aa]uto-?[Rr]eply[\]\)]/', $txt)) {
-			return true;
-		} else {
-			return false;
-		}
-	}
-
-	function is_otr($txt) {
-		if (preg_match('/^\?OTR/', $txt)) {
-			return true;
-		} else {
-			return false;
-		}
-	}
-	
-	function from_site($address, $msg) {
-		$text = '['.common_config('site', 'name') . '] ' . $msg;
-		jabber_send_message($address, $text);
-	}
-
-	function handle_command($user, $body) {
-		# XXX: localise
-		$p=explode(' ',$body);
-		if(count($p)>2)
-			return false;
-		switch($p[0]) {
-		 case 'help':
-		 	if(count($p)!=1)
-		 		return false;
-		 	$this->from_site($user->jabber, "Commands:\n on     - turn on notifications\n off    - turn off notifications\n help   - show this help \n sub - subscribe to user\n unsub - unsubscribe from user");
-		 	return true;
-		 case 'on':
-		 	if(count($p)!=1)
-		 		return false;
-			$this->set_notify($user, true);
-			$this->from_site($user->jabber, 'notifications on');
-			return true;
-		 case 'off':
-		 	if(count($p)!=1)
-		 		return false;
-			$this->set_notify($user, false);
-			$this->from_site($user->jabber, 'notifications off');
-			return true;
-		 case 'sub':
-		 	if(count($p)==1) {
-		 		$this->from_site($user->jabber, 'Specify the name of the user to subscribe to');
-		 		return true;
-		 	}
-		 	$result=subs_subscribe_user($user, $p[1]);
-		 	if($result=='true')
-		 		$this->from_site($user->jabber, 'Subscribed to ' . $p[1]);
-		 	else
-		 		$this->from_site($user->jabber, $result);
-		 	return true;
-		 case 'unsub':
-		 	if(count($p)==1) {
-		 		$this->from_site($user->jabber, 'Specify the name of the user to unsubscribe from');
-		 		return true;
-		 	}
-		 	$result=subs_unsubscribe_user($user, $p[1]);
-		 	if($result=='true')
-		 		$this->from_site($user->jabber, 'Unsubscribed from ' . $p[1]);
-		 	else
-		 		$this->from_site($user->jabber, $result);
-		 	return true;
-		 default:
-			return false;
-		}
-	}
-
-	function set_notify(&$user, $notify) {
-		$orig = clone($user);
-		$user->jabbernotify = $notify;
-		$result = $user->update($orig);
-		if (!$result) {
-			$last_error = &PEAR::getStaticProperty('DB_DataObject','lastError');
-			$this->log(LOG_ERR,
-					   'Could not set notify flag to ' . $notify .
-					   ' for user ' . common_log_objstring($user) .
-					   ': ' . $last_error->message);
-		} else {
-			$this->log(LOG_INFO,
-					   'User ' . $user->nickname . ' set notify flag to ' . $notify);
-		}
-	}
-
-	function add_notice(&$user, &$pl) {
-		$notice = Notice::saveNew($user->id, trim(mb_substr($pl['body'], 0, 140)), 'xmpp');
-		if (is_string($notice)) {
-			$this->log(LOG_ERR, $notice);
-			return;
-		}
-		common_real_broadcast($notice);
-		$this->log(LOG_INFO,
-				   'Added notice ' . $notice->id . ' from user ' . $user->nickname);
-	}
-
-	function handle_presence(&$pl) {
-		$from = jabber_normalize_jid($pl['from']);
-		switch ($pl['type']) {
-		 case 'subscribe':
-			# We let anyone subscribe
-			$this->subscribed($from);
-			$this->log(LOG_INFO,
-					   'Accepted subscription from ' . $from);
-			break;
-		 case 'subscribed':
-		 case 'unsubscribed':
-		 case 'unsubscribe':
-			$this->log(LOG_INFO,
-					   'Ignoring  "' . $pl['type'] . '" from ' . $from);
-			break;
-		 default:
-			if (!$pl['type']) {
-				$user = User::staticGet('jabber', $from);
-				if (!$user) {
-					$this->log(LOG_WARNING, 'Presence from unknown user ' . $from);
-					return;
-				}
-				if ($user->updatefrompresence) {
-					$this->log(LOG_INFO, 'Updating ' . $user->nickname .
-							   ' status from presence.');
-					$this->add_notice($user, $pl);
-				}
-			}
-			break;
-		}
-	}
-
-	function log($level, $msg) {
-		common_log($level, 'XMPPDaemon('.$this->resource.'): '.$msg);
-	}
-
-	function subscribed($to) {
-		jabber_special_presence('subscribed', $to);
-	}
-
-	function set_status($status) {
-		$this->log(LOG_INFO, 'Setting status to "' . $status . '"');
-		jabber_send_presence($status);
-	}
-
-	function top_queue_item() {
-
-		$qi = new Queue_item();
-		$qi->orderBy('created');
-		$qi->whereAdd('claimed is NULL');
-
-		$qi->limit(1);
-
-		$cnt = $qi->find(TRUE);
-
-		if ($cnt) {
-			# XXX: potential race condition
-			# can we force it to only update if claimed is still NULL
-			# (or old)?
-			$this->log(LOG_INFO, 'claiming queue item = ' . $qi->notice_id);
-			$orig = clone($qi);
-			$qi->claimed = common_sql_now();
-			$result = $qi->update($orig);
-			if ($result) {
-				$this->log(LOG_INFO, 'claim succeeded.');
-				return $qi;
-			} else {
-				$this->log(LOG_INFO, 'claim failed.');
-			}
-		}
-		$qi = NULL;
-		return NULL;
-	}
-
-	function broadcast_queue() {
-		$this->clear_old_claims();
-		$this->log(LOG_INFO, 'checking for queued notices');
-		do {
-			$qi = $this->top_queue_item();
-			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 = common_real_broadcast($notice, $this->is_remote($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();
-			}
-		} while ($qi);
-	}
-
-	function clear_old_claims() {
-		$qi = new Queue_item();
-	        $qi->claimed = NULL;
-		$qi->whereAdd('now() - claimed > '.CLAIM_TIMEOUT);
-		$qi->update(DB_DATAOBJECT_WHEREADD_ONLY);
-	}
-
-	function is_remote($notice) {
-		$user = User::staticGet($notice->profile_id);
-		return !$user;
-	}
-
-	function confirmation_queue() {
-	    # $this->clear_old_confirm_claims();
-		$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;
-					}
-				}
-			}
-		} while ($confirm);
-	}
-
-	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);
-	}
+class XMPPDaemon extends Daemon
+{
+
+    function XMPPDaemon($resource=null)
+    {
+        static $attrs = array('server', 'port', 'user', 'password', 'host');
+
+        foreach ($attrs as $attr)
+        {
+            $this->$attr = common_config('xmpp', $attr);
+        }
+
+        if ($resource) {
+            $this->resource = $resource;
+        } else {
+            $this->resource = common_config('xmpp', 'resource') . 'daemon';
+        }
+
+        $this->log(LOG_INFO, "INITIALIZE XMPPDaemon {$this->user}@{$this->server}/{$this->resource}");
+    }
+
+    function connect()
+    {
+
+        $connect_to = ($this->host) ? $this->host : $this->server;
+
+        $this->log(LOG_INFO, "Connecting to $connect_to on port $this->port");
+
+        $this->conn = jabber_connect($this->resource);
+
+        if (!$this->conn) {
+            return false;
+        }
+
+        $this->conn->setReconnectTimeout(600);
+
+        jabber_send_presence("Send me a message to post a notice", 'available',
+                             null, 'available', 100);
+        return !$this->conn->isDisconnected();
+    }
+
+    function name()
+    {
+        return strtolower('xmppdaemon.'.$this->resource);
+    }
+
+    function run()
+    {
+        if ($this->connect()) {
+
+            $this->conn->addEventHandler('message', 'handle_message', $this);
+            $this->conn->addEventHandler('presence', 'handle_presence', $this);
+            $this->conn->addEventHandler('reconnect', 'handle_reconnect', $this);
+
+            $this->conn->process();
+        }
+    }
+
+    function handle_reconnect(&$pl)
+    {
+        $this->conn->processUntil('session_start');
+        $this->conn->presence('Send me a message to post a notice', 'available', null, 'available', 100);
+    }
+
+    function get_user($from)
+    {
+        $user = User::staticGet('jabber', jabber_normalize_jid($from));
+        return $user;
+    }
+
+    function handle_message(&$pl)
+    {
+        if ($pl['type'] != 'chat') {
+            return;
+        }
+        if (mb_strlen($pl['body']) == 0) {
+            return;
+        }
+
+        $from = jabber_normalize_jid($pl['from']);
+
+        # Forwarded from another daemon (probably a broadcaster) for
+        # us to handle
+
+        if ($this->is_self($from)) {
+            $from = $this->get_ofrom($pl);
+            if (is_null($from) || $this->is_self($from)) {
+                return;
+            }
+        }
+
+        $user = $this->get_user($from);
+
+        if (!$user) {
+            $this->from_site($from, 'Unknown user; go to ' .
+                             common_local_url('imsettings') .
+                             ' to add your address to your account');
+            $this->log(LOG_WARNING, 'Message from unknown user ' . $from);
+            return;
+        }
+        if ($this->handle_command($user, $pl['body'])) {
+            return;
+        } else if ($this->is_autoreply($pl['body'])) {
+            $this->log(LOG_INFO, 'Ignoring auto reply from ' . $from);
+            return;
+        } else if ($this->is_otr($pl['body'])) {
+            $this->log(LOG_INFO, 'Ignoring OTR from ' . $from);
+            return;
+        } else if ($this->is_direct($pl['body'])) {
+            preg_match_all('/d[\ ]*([a-z0-9]{1,64})/', $pl['body'], $to);
+
+            $to = preg_replace('/^d([\ ])*/', '', $to[0][0]);
+            $body = preg_replace('/d[\ ]*('. $to .')[\ ]*/', '', $pl['body']);
+            $this->add_direct($user, $body, $to, $from);
+        } else {
+            $this->add_notice($user, $pl);
+        }
+
+        $user->free();
+        unset($user);
+    }
+
+    function is_self($from)
+    {
+        return preg_match('/^'.strtolower(jabber_daemon_address()).'/', strtolower($from));
+    }
+
+    function get_ofrom($pl)
+    {
+        $xml = $pl['xml'];
+        $addresses = $xml->sub('addresses');
+        if (!$addresses) {
+            $this->log(LOG_WARNING, 'Forwarded message without addresses');
+            return null;
+        }
+        $address = $addresses->sub('address');
+        if (!$address) {
+            $this->log(LOG_WARNING, 'Forwarded message without address');
+            return null;
+        }
+        if (!array_key_exists('type', $address->attrs)) {
+            $this->log(LOG_WARNING, 'No type for forwarded message');
+            return null;
+        }
+        $type = $address->attrs['type'];
+        if ($type != 'ofrom') {
+            $this->log(LOG_WARNING, 'Type of forwarded message is not ofrom');
+            return null;
+        }
+        if (!array_key_exists('jid', $address->attrs)) {
+            $this->log(LOG_WARNING, 'No jid for forwarded message');
+            return null;
+        }
+        $jid = $address->attrs['jid'];
+        if (!$jid) {
+            $this->log(LOG_WARNING, 'Could not get jid from address');
+            return null;
+        }
+        $this->log(LOG_DEBUG, 'Got message forwarded from jid ' . $jid);
+        return $jid;
+    }
+
+    function is_autoreply($txt)
+    {
+        if (preg_match('/[\[\(]?[Aa]uto[-\s]?[Rr]e(ply|sponse)[\]\)]/', $txt)) {
+            return true;
+        } else if (preg_match('/^System: Message wasn\'t delivered. Offline storage size was exceeded.$/', $txt)) {
+            return true;
+        } else {
+            return false;
+        }
+    }
+
+    function is_otr($txt)
+    {
+        if (preg_match('/^\?OTR/', $txt)) {
+            return true;
+        } else {
+            return false;
+        }
+    }
+
+    function is_direct($txt)
+    {
+        if (strtolower(substr($txt, 0, 2))=='d ') {
+            return true;
+        } else {
+            return false;
+        }
+    }
+
+    function from_site($address, $msg)
+    {
+        $text = '['.common_config('site', 'name') . '] ' . $msg;
+        jabber_send_message($address, $text);
+    }
+
+    function handle_command($user, $body)
+    {
+        $inter = new CommandInterpreter();
+        $cmd = $inter->handle_command($user, $body);
+        if ($cmd) {
+            $chan = new XMPPChannel($this->conn);
+            $cmd->execute($chan);
+            return true;
+        } else {
+            return false;
+        }
+    }
+
+    function add_notice(&$user, &$pl)
+    {
+        $body = trim($pl['body']);
+        $content_shortened = common_shorten_links($body);
+        if (mb_strlen($content_shortened) > 140) {
+          $from = jabber_normalize_jid($pl['from']);
+          $this->from_site($from, "Message too long - maximum is 140 characters, you sent ".mb_strlen($content_shortened));
+          return;
+        }
+        $notice = Notice::saveNew($user->id, $content_shortened, 'xmpp');
+        if (is_string($notice)) {
+            $this->log(LOG_ERR, $notice);
+            return;
+        }
+        common_broadcast_notice($notice);
+        $this->log(LOG_INFO,
+                   'Added notice ' . $notice->id . ' from user ' . $user->nickname);
+        $notice->free();
+        unset($notice);
+    }
+
+    function handle_presence(&$pl)
+    {
+        $from = jabber_normalize_jid($pl['from']);
+        switch ($pl['type']) {
+         case 'subscribe':
+            # We let anyone subscribe
+            $this->subscribed($from);
+            $this->log(LOG_INFO,
+                       'Accepted subscription from ' . $from);
+            break;
+         case 'subscribed':
+         case 'unsubscribed':
+         case 'unsubscribe':
+            $this->log(LOG_INFO,
+                       'Ignoring  "' . $pl['type'] . '" from ' . $from);
+            break;
+         default:
+            if (!$pl['type']) {
+                $user = User::staticGet('jabber', $from);
+                if (!$user) {
+                    $this->log(LOG_WARNING, 'Presence from unknown user ' . $from);
+                    return;
+                }
+                if ($user->updatefrompresence) {
+                    $this->log(LOG_INFO, 'Updating ' . $user->nickname .
+                               ' status from presence.');
+                    $this->add_notice($user, $pl);
+                }
+                $user->free();
+                unset($user);
+            }
+            break;
+        }
+    }
 
+    function log($level, $msg)
+    {
+        common_log($level, 'XMPPDaemon('.$this->resource.'): '.$msg);
+    }
+
+    function subscribed($to)
+    {
+        jabber_special_presence('subscribed', $to);
+    }
 }
 
+// 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();
+}
+
+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] : NULL;
+$resource = ($argc > 1) ? $argv[1] : (common_config('xmpp','resource') . '-listen');
 
 $daemon = new XMPPDaemon($resource);
 
-if ($daemon->connect()) {
-	$daemon->set_status("Send me a message to post a notice");
-	$daemon->handle();
-}
-
-?>
+$daemon->runOnce();