#!/usr/bin/env php <?php /* * 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 * 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/>. */ define('INSTALLDIR', realpath(dirname(__FILE__) . '/..')); $shortoptions = 'fi::'; $longoptions = array('id::', 'foreground'); $helptext = <<<END_OF_XMPP_HELP Daemon script for receiving new notices from Jabber users. -i --id Identity (default none) -f --foreground Stay in the foreground (default background) END_OF_XMPP_HELP; require_once INSTALLDIR.'/scripts/commandline.inc'; require_once INSTALLDIR . '/lib/common.php'; require_once INSTALLDIR . '/lib/jabber.php'; require_once INSTALLDIR . '/lib/daemon.php'; # 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 extends Daemon { function __construct($resource=null, $daemonize=true) { parent::__construct($daemonize); static $attrs = array('server', 'port', 'user', 'password', 'host'); foreach ($attrs as $attr) { $this->$attr = common_config('xmpp', $attr); } if ($resource) { $this->resource = $resource . 'daemon'; } else { $this->resource = common_config('xmpp', 'resource') . 'daemon'; } $this->jid = $this->user.'@'.$this->server.'/'.$this->resource; $this->log(LOG_INFO, "INITIALIZE XMPPDaemon {$this->jid}"); } 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->log(LOG_INFO, "Connected"); $this->conn->setReconnectTimeout(600); $this->log(LOG_INFO, "Sending initial presence."); jabber_send_presence("Send me a message to post a notice", 'available', null, 'available', 100); $this->log(LOG_INFO, "Done connecting."); return !$this->conn->isDisconnected(); } function name() { return strtolower('xmppdaemon.'.$this->resource); } function run() { if ($this->connect()) { $this->log(LOG_DEBUG, "Initializing stanza handlers."); $this->conn->addEventHandler('message', 'handle_message', $this); $this->conn->addEventHandler('presence', 'handle_presence', $this); $this->conn->addEventHandler('reconnect', 'handle_reconnect', $this); $this->log(LOG_DEBUG, "Beginning processing loop."); while ($this->conn->processTime(60)) { $this->sendPing(); } } } function sendPing() { if (!isset($this->pingid)) { $this->pingid = 0; } else { $this->pingid++; } $this->log(LOG_DEBUG, "Sending ping #{$this->pingid}"); $this->conn->send("<iq from='{$this->jid}' to='{$this->server}' id='ping_{$this->pingid}' type='get'><ping xmlns='urn:xmpp:ping'/></iq>"); } function handle_reconnect(&$pl) { $this->log(LOG_DEBUG, "Got reconnection callback."); $this->conn->processUntil('session_start'); $this->log(LOG_DEBUG, "Sending reconnection presence."); $this->conn->presence('Send me a message to post a notice', 'available', null, 'available', 100); unset($pl['xml']); $pl['xml'] = null; $pl = null; unset($pl); } function get_user($from) { $user = User::staticGet('jabber', jabber_normalize_jid($from)); return $user; } function handle_message(&$pl) { $from = jabber_normalize_jid($pl['from']); if ($pl['type'] != 'chat') { $this->log(LOG_WARNING, "Ignoring message of type ".$pl['type']." from $from."); return; } if (mb_strlen($pl['body']) == 0) { $this->log(LOG_WARNING, "Ignoring message with empty body from $from."); return; } # Forwarded from another daemon (probably a broadcaster) for # us to handle if ($this->is_self($from)) { $this->log(LOG_INFO, "Got forwarded notice from self ($from)."); $from = $this->get_ofrom($pl); $this->log(LOG_INFO, "Originally sent by $from."); if (is_null($from) || $this->is_self($from)) { $this->log(LOG_INFO, "Ignoring notice originally sent by $from."); return; } } $user = $this->get_user($from); // For common_current_user to work global $_cur; $_cur = $user; 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'])) { $this->log(LOG_INFO, "Command messag by $from handled."); 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'])) { $this->log(LOG_INFO, 'Got a direct message ' . $from); 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->log(LOG_INFO, 'Direct message from '. $user->nickname . ' to ' . $to); $this->add_direct($user, $body, $to, $from); } else { $this->log(LOG_INFO, 'Posting a notice from ' . $user->nickname); $this->add_notice($user, $pl); } $user->free(); unset($user); unset($_cur); unset($pl['xml']); $pl['xml'] = null; $pl = null; unset($pl); } 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 (Notice::contentTooLong($content_shortened)) { $from = jabber_normalize_jid($pl['from']); $this->from_site($from, sprintf(_("Message too long - maximum is %d characters, you sent %d"), Notice::maxContent(), mb_strlen($content_shortened))); return; } try { $notice = Notice::saveNew($user->id, $content_shortened, 'xmpp'); } catch (Exception $e) { $this->log(LOG_ERR, $e->getMessage()); $this->from_site($user->jabber, $e->getMessage()); 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; } unset($pl['xml']); $pl['xml'] = null; $pl = null; unset($pl); } function log($level, $msg) { $text = 'XMPPDaemon('.$this->resource.'): '.$msg; common_log($level, $text); if (!$this->daemonize) { $line = common_log_line($level, $text); echo $line; echo "\n"; } } 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(); } if (have_option('i', 'id')) { $id = get_option_value('i', 'id'); } else if (count($args) > 0) { $id = $args[0]; } else { $id = null; } $foreground = have_option('f', 'foreground'); $daemon = new XMPPDaemon($id, !$foreground); $daemon->runOnce();