scripts/xmppdaemon.php

   1 #!/usr/bin/env php
   2 <?php
   3 /*
   4  * Laconica - a distributed open-source microblogging tool
   5  * Copyright (C) 2008, 2009, Control Yourself, Inc.
   6  *
   7  * This program is free software: you can redistribute it and/or modify
   8  * it under the terms of the GNU Affero General Public License as published by
   9  * the Free Software Foundation, either version 3 of the License, or
  10  * (at your option) any later version.
  11  *
  12  * This program is distributed in the hope that it will be useful,
  13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  15  * GNU Affero General Public License for more details.
  16  *
  17  * You should have received a copy of the GNU Affero General Public License
  18  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  19  */
  20
  21 # Abort if called from a web server
  22 if (isset($_SERVER) && array_key_exists('REQUEST_METHOD', $_SERVER)) {
  23     print "This script must be run from the command line\n";
  24     exit();
  25 }
  26
  27 define('INSTALLDIR', realpath(dirname(__FILE__) . '/..'));
  28 define('LACONICA', true);
  29
  30 // Preset the server at the command line
  31
  32 $server = ($argc > 2) ? $argv[2] : null;
  33 $path   = ($argc > 3) ? $argv[3] : null;
  34
  35 require_once(INSTALLDIR . '/lib/common.php');
  36 require_once(INSTALLDIR . '/lib/jabber.php');
  37 require_once(INSTALLDIR . '/lib/daemon.php');
  38
  39 set_error_handler('common_error_handler');
  40
  41 # This is kind of clunky; we create a class to call the global functions
  42 # in jabber.php, which create a new XMPP class. A more elegant (?) solution
  43 # might be to use make this a subclass of XMPP.
  44
  45 class XMPPDaemon extends Daemon
  46 {
  47     function XMPPDaemon($resource=null)
  48     {
  49         static $attrs = array('server', 'port', 'user', 'password', 'host');
  50
  51         foreach ($attrs as $attr)
  52         {
  53             $this->$attr = common_config('xmpp', $attr);
  54         }
  55
  56         if ($resource) {
  57             $this->resource = $resource;
  58         } else {
  59             $this->resource = common_config('xmpp', 'resource') . 'daemon';
  60         }
  61
  62         $this->log(LOG_INFO, "INITIALIZE XMPPDaemon {$this->user}@{$this->server}/{$this->resource}");
  63     }
  64
  65     function connect()
  66     {
  67
  68         $connect_to = ($this->host) ? $this->host : $this->server;
  69
  70         $this->log(LOG_INFO, "Connecting to $connect_to on port $this->port");
  71
  72         $this->conn = jabber_connect($this->resource);
  73
  74         if (!$this->conn) {
  75             return false;
  76         }
  77
  78         $this->conn->setReconnectTimeout(600);
  79
  80         jabber_send_presence("Send me a message to post a notice", 'available',
  81                              null, 'available', 100);
  82         return !$this->conn->isDisconnected();
  83     }
  84
  85     function name()
  86     {
  87         return strtolower('xmppdaemon.'.$this->resource);
  88     }
  89
  90     function run()
  91     {
  92         if ($this->connect()) {
  93
  94             $this->conn->addEventHandler('message', 'handle_message', $this);
  95             $this->conn->addEventHandler('presence', 'handle_presence', $this);
  96             $this->conn->addEventHandler('reconnect', 'handle_reconnect', $this);
  97
  98             $this->conn->process();
  99         }
 100     }
 101
 102     function handle_reconnect(&$pl)
 103     {
 104         $this->conn->processUntil('session_start');
 105         $this->conn->presence('Send me a message to post a notice', 'available', null, 'available', 100);
 106     }
 107
 108     function get_user($from)
 109     {
 110         $user = User::staticGet('jabber', jabber_normalize_jid($from));
 111         return $user;
 112     }
 113
 114     function handle_message(&$pl)
 115     {
 116         if ($pl['type'] != 'chat') {
 117             return;
 118         }
 119         if (mb_strlen($pl['body']) == 0) {
 120             return;
 121         }
 122
 123         $from = jabber_normalize_jid($pl['from']);
 124
 125         # Forwarded from another daemon (probably a broadcaster) for
 126         # us to handle
 127
 128         if ($this->is_self($from)) {
 129             $from = $this->get_ofrom($pl);
 130             if (is_null($from) || $this->is_self($from)) {
 131                 return;
 132             }
 133         }
 134
 135         $user = $this->get_user($from);
 136
 137         if (!$user) {
 138             $this->from_site($from, 'Unknown user; go to ' .
 139                              common_local_url('imsettings') .
 140                              ' to add your address to your account');
 141             $this->log(LOG_WARNING, 'Message from unknown user ' . $from);
 142             return;
 143         }
 144         if ($this->handle_command($user, $pl['body'])) {
 145             return;
 146         } else if ($this->is_autoreply($pl['body'])) {
 147             $this->log(LOG_INFO, 'Ignoring auto reply from ' . $from);
 148             return;
 149         } else if ($this->is_otr($pl['body'])) {
 150             $this->log(LOG_INFO, 'Ignoring OTR from ' . $from);
 151             return;
 152         } else if ($this->is_direct($pl['body'])) {
 153             preg_match_all('/d[\ ]*([a-z0-9]{1,64})/', $pl['body'], $to);
 154
 155             $to = preg_replace('/^d([\ ])*/', '', $to[0][0]);
 156             $body = preg_replace('/d[\ ]*('. $to .')[\ ]*/', '', $pl['body']);
 157             $this->add_direct($user, $body, $to, $from);
 158         } else {
 159             $this->add_notice($user, $pl);
 160         }
 161
 162         $user->free();
 163         unset($user);
 164     }
 165
 166     function is_self($from)
 167     {
 168         return preg_match('/^'.strtolower(jabber_daemon_address()).'/', strtolower($from));
 169     }
 170
 171     function get_ofrom($pl)
 172     {
 173         $xml = $pl['xml'];
 174         $addresses = $xml->sub('addresses');
 175         if (!$addresses) {
 176             $this->log(LOG_WARNING, 'Forwarded message without addresses');
 177             return null;
 178         }
 179         $address = $addresses->sub('address');
 180         if (!$address) {
 181             $this->log(LOG_WARNING, 'Forwarded message without address');
 182             return null;
 183         }
 184         if (!array_key_exists('type', $address->attrs)) {
 185             $this->log(LOG_WARNING, 'No type for forwarded message');
 186             return null;
 187         }
 188         $type = $address->attrs['type'];
 189         if ($type != 'ofrom') {
 190             $this->log(LOG_WARNING, 'Type of forwarded message is not ofrom');
 191             return null;
 192         }
 193         if (!array_key_exists('jid', $address->attrs)) {
 194             $this->log(LOG_WARNING, 'No jid for forwarded message');
 195             return null;
 196         }
 197         $jid = $address->attrs['jid'];
 198         if (!$jid) {
 199             $this->log(LOG_WARNING, 'Could not get jid from address');
 200             return null;
 201         }
 202         $this->log(LOG_DEBUG, 'Got message forwarded from jid ' . $jid);
 203         return $jid;
 204     }
 205
 206     function is_autoreply($txt)
 207     {
 208         if (preg_match('/[\[\(]?[Aa]uto[-\s]?[Rr]e(ply|sponse)[\]\)]/', $txt)) {
 209             return true;
 210         } else if (preg_match('/^System: Message wasn\'t delivered. Offline storage size was exceeded.$/', $txt)) {
 211             return true;
 212         } else {
 213             return false;
 214         }
 215     }
 216
 217     function is_otr($txt)
 218     {
 219         if (preg_match('/^\?OTR/', $txt)) {
 220             return true;
 221         } else {
 222             return false;
 223         }
 224     }
 225
 226     function is_direct($txt)
 227     {
 228         if (strtolower(substr($txt, 0, 2))=='d ') {
 229             return true;
 230         } else {
 231             return false;
 232         }
 233     }
 234
 235     function from_site($address, $msg)
 236     {
 237         $text = '['.common_config('site', 'name') . '] ' . $msg;
 238         jabber_send_message($address, $text);
 239     }
 240
 241     function handle_command($user, $body)
 242     {
 243         $inter = new CommandInterpreter();
 244         $cmd = $inter->handle_command($user, $body);
 245         if ($cmd) {
 246             $chan = new XMPPChannel($this->conn);
 247             $cmd->execute($chan);
 248             return true;
 249         } else {
 250             return false;
 251         }
 252     }
 253
 254     function add_notice(&$user, &$pl)
 255     {
 256         $body = trim($pl['body']);
 257         $content_shortened = common_shorten_links($body);
 258         if (mb_strlen($content_shortened) > 140) {
 259           $from = jabber_normalize_jid($pl['from']);
 260           $this->from_site($from, "Message too long - maximum is 140 characters, you sent ".mb_strlen($content_shortened));
 261           return;
 262         }
 263         $notice = Notice::saveNew($user->id, $content_shortened, 'xmpp');
 264         if (is_string($notice)) {
 265             $this->log(LOG_ERR, $notice);
 266             return;
 267         }
 268         common_broadcast_notice($notice);
 269         $this->log(LOG_INFO,
 270                    'Added notice ' . $notice->id . ' from user ' . $user->nickname);
 271         $notice->free();
 272         unset($notice);
 273     }
 274
 275     function handle_presence(&$pl)
 276     {
 277         $from = jabber_normalize_jid($pl['from']);
 278         switch ($pl['type']) {
 279          case 'subscribe':
 280             # We let anyone subscribe
 281             $this->subscribed($from);
 282             $this->log(LOG_INFO,
 283                        'Accepted subscription from ' . $from);
 284             break;
 285          case 'subscribed':
 286          case 'unsubscribed':
 287          case 'unsubscribe':
 288             $this->log(LOG_INFO,
 289                        'Ignoring  "' . $pl['type'] . '" from ' . $from);
 290             break;
 291          default:
 292             if (!$pl['type']) {
 293                 $user = User::staticGet('jabber', $from);
 294                 if (!$user) {
 295                     $this->log(LOG_WARNING, 'Presence from unknown user ' . $from);
 296                     return;
 297                 }
 298                 if ($user->updatefrompresence) {
 299                     $this->log(LOG_INFO, 'Updating ' . $user->nickname .
 300                                ' status from presence.');
 301                     $this->add_notice($user, $pl);
 302                 }
 303                 $user->free();
 304                 unset($user);
 305             }
 306             break;
 307         }
 308     }
 309
 310     function log($level, $msg)
 311     {
 312         common_log($level, 'XMPPDaemon('.$this->resource.'): '.$msg);
 313     }
 314
 315     function subscribed($to)
 316     {
 317         jabber_special_presence('subscribed', $to);
 318     }
 319 }
 320
 321 // Abort immediately if xmpp is not enabled, otherwise the daemon chews up
 322 // lots of CPU trying to connect to unconfigured servers
 323 if (common_config('xmpp','enabled')==false) {
 324     print "Aborting daemon - xmpp is disabled\n";
 325     exit();
 326 }
 327
 328 ini_set("max_execution_time", "0");
 329 ini_set("max_input_time", "0");
 330 set_time_limit(0);
 331 mb_internal_encoding('UTF-8');
 332
 333 $resource = ($argc > 1) ? $argv[1] : (common_config('xmpp','resource') . '-listen');
 334
 335 $daemon = new XMPPDaemon($resource);
 336
 337 $daemon->runOnce();