scripts/xmppdaemon.php

   1 #!/usr/bin/env php
   2 <?php
   3 /*
   4  * StatusNet - the distributed open-source microblogging tool
   5  * Copyright (C) 2008, 2009, StatusNet, 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 define('INSTALLDIR', realpath(dirname(__FILE__) . '/..'));
  22
  23 $shortoptions = 'fi::';
  24 $longoptions = array('id::', 'foreground');
  25
  26 $helptext = <<<END_OF_XMPP_HELP
  27 Daemon script for receiving new notices from Jabber users.
  28
  29     -i --id           Identity (default none)
  30     -f --foreground   Stay in the foreground (default background)
  31
  32 END_OF_XMPP_HELP;
  33
  34 require_once INSTALLDIR.'/scripts/commandline.inc';
  35
  36 require_once INSTALLDIR . '/lib/common.php';
  37 require_once INSTALLDIR . '/lib/jabber.php';
  38 require_once INSTALLDIR . '/lib/daemon.php';
  39
  40 # This is kind of clunky; we create a class to call the global functions
  41 # in jabber.php, which create a new XMPP class. A more elegant (?) solution
  42 # might be to use make this a subclass of XMPP.
  43
  44 class XMPPDaemon extends Daemon
  45 {
  46     function __construct($resource=null, $daemonize=true)
  47     {
  48         parent::__construct($daemonize);
  49
  50         static $attrs = array('server', 'port', 'user', 'password', 'host');
  51
  52         foreach ($attrs as $attr)
  53         {
  54             $this->$attr = common_config('xmpp', $attr);
  55         }
  56
  57         if ($resource) {
  58             $this->resource = $resource . 'daemon';
  59         } else {
  60             $this->resource = common_config('xmpp', 'resource') . 'daemon';
  61         }
  62
  63         $this->jid = $this->user.'@'.$this->server.'/'.$this->resource;
  64
  65         $this->log(LOG_INFO, "INITIALIZE XMPPDaemon {$this->jid}");
  66     }
  67
  68     function connect()
  69     {
  70         $connect_to = ($this->host) ? $this->host : $this->server;
  71
  72         $this->log(LOG_INFO, "Connecting to $connect_to on port $this->port");
  73
  74         $this->conn = jabber_connect($this->resource);
  75
  76         if (!$this->conn) {
  77             return false;
  78         }
  79
  80         $this->log(LOG_INFO, "Connected");
  81
  82         $this->conn->setReconnectTimeout(600);
  83
  84         $this->log(LOG_INFO, "Sending initial presence.");
  85
  86         jabber_send_presence("Send me a message to post a notice", 'available',
  87                              null, 'available', 100);
  88
  89         $this->log(LOG_INFO, "Done connecting.");
  90
  91         return !$this->conn->isDisconnected();
  92     }
  93
  94     function name()
  95     {
  96         return strtolower('xmppdaemon.'.$this->resource);
  97     }
  98
  99     function run()
 100     {
 101         if ($this->connect()) {
 102
 103             $this->log(LOG_DEBUG, "Initializing stanza handlers.");
 104
 105             $this->conn->addEventHandler('message', 'handle_message', $this);
 106             $this->conn->addEventHandler('presence', 'handle_presence', $this);
 107             $this->conn->addEventHandler('reconnect', 'handle_reconnect', $this);
 108
 109             $this->log(LOG_DEBUG, "Beginning processing loop.");
 110
 111             while ($this->conn->processTime(60)) {
 112                 $this->sendPing();
 113             }
 114         }
 115     }
 116
 117     function sendPing()
 118     {
 119         if (!isset($this->pingid)) {
 120             $this->pingid = 0;
 121         } else {
 122             $this->pingid++;
 123         }
 124
 125         $this->log(LOG_DEBUG, "Sending ping #{$this->pingid}");
 126
 127                 $this->conn->send("<iq from='{$this->jid}' to='{$this->server}' id='ping_{$this->pingid}' type='get'><ping xmlns='urn:xmpp:ping'/></iq>");
 128     }
 129
 130     function handle_reconnect(&$pl)
 131     {
 132         $this->log(LOG_DEBUG, "Got reconnection callback.");
 133         $this->conn->processUntil('session_start');
 134         $this->log(LOG_DEBUG, "Sending reconnection presence.");
 135         $this->conn->presence('Send me a message to post a notice', 'available', null, 'available', 100);
 136         unset($pl['xml']);
 137         $pl['xml'] = null;
 138
 139         $pl = null;
 140         unset($pl);
 141     }
 142
 143     function get_user($from)
 144     {
 145         $user = User::staticGet('jabber', jabber_normalize_jid($from));
 146         return $user;
 147     }
 148
 149     function handle_message(&$pl)
 150     {
 151         $this->log(LOG_DEBUG, "Received message: " . str_replace("\n", " ", var_export($pl, true)));
 152         $from = jabber_normalize_jid($pl['from']);
 153
 154         if ($pl['type'] != 'chat') {
 155             $this->log(LOG_WARNING, "Ignoring message of type ".$pl['type']." from $from.");
 156             return;
 157         }
 158
 159         if (mb_strlen($pl['body']) == 0) {
 160             $this->log(LOG_WARNING, "Ignoring message with empty body from $from.");
 161             return;
 162         }
 163
 164         # Forwarded from another daemon (probably a broadcaster) for
 165         # us to handle
 166
 167         if ($this->is_self($from)) {
 168             $this->log(LOG_INFO, "Got forwarded notice from self ($from).");
 169             $from = $this->get_ofrom($pl);
 170             $this->log(LOG_INFO, "Originally sent by $from.");
 171             if (is_null($from) || $this->is_self($from)) {
 172                 $this->log(LOG_INFO, "Ignoring notice originally sent by $from.");
 173                 return;
 174             }
 175         }
 176
 177         $user = $this->get_user($from);
 178
 179         // For common_current_user to work
 180         global $_cur;
 181         $_cur = $user;
 182
 183         if (!$user) {
 184             $this->from_site($from, 'Unknown user; go to ' .
 185                              common_local_url('imsettings') .
 186                              ' to add your address to your account');
 187             $this->log(LOG_WARNING, 'Message from unknown user ' . $from);
 188             return;
 189         }
 190         if ($this->handle_command($user, $pl['body'])) {
 191             $this->log(LOG_INFO, "Command message by $from handled.");
 192             return;
 193         } else if ($this->is_autoreply($pl['body'])) {
 194             $this->log(LOG_INFO, 'Ignoring auto reply from ' . $from);
 195             return;
 196         } else if ($this->is_otr($pl['body'])) {
 197             $this->log(LOG_INFO, 'Ignoring OTR from ' . $from);
 198             return;
 199         } else {
 200
 201             $this->log(LOG_INFO, 'Posting a notice from ' . $user->nickname);
 202
 203             $this->add_notice($user, $pl);
 204         }
 205
 206         $user->free();
 207         unset($user);
 208         unset($_cur);
 209
 210         unset($pl['xml']);
 211         $pl['xml'] = null;
 212
 213         $pl = null;
 214         unset($pl);
 215     }
 216
 217     function is_self($from)
 218     {
 219         return preg_match('/^'.strtolower(jabber_daemon_address()).'/', strtolower($from));
 220     }
 221
 222     function get_ofrom($pl)
 223     {
 224         $xml = $pl['xml'];
 225         $addresses = $xml->sub('addresses');
 226         if (!$addresses) {
 227             $this->log(LOG_WARNING, 'Forwarded message without addresses');
 228             return null;
 229         }
 230         $address = $addresses->sub('address');
 231         if (!$address) {
 232             $this->log(LOG_WARNING, 'Forwarded message without address');
 233             return null;
 234         }
 235         if (!array_key_exists('type', $address->attrs)) {
 236             $this->log(LOG_WARNING, 'No type for forwarded message');
 237             return null;
 238         }
 239         $type = $address->attrs['type'];
 240         if ($type != 'ofrom') {
 241             $this->log(LOG_WARNING, 'Type of forwarded message is not ofrom');
 242             return null;
 243         }
 244         if (!array_key_exists('jid', $address->attrs)) {
 245             $this->log(LOG_WARNING, 'No jid for forwarded message');
 246             return null;
 247         }
 248         $jid = $address->attrs['jid'];
 249         if (!$jid) {
 250             $this->log(LOG_WARNING, 'Could not get jid from address');
 251             return null;
 252         }
 253         $this->log(LOG_DEBUG, 'Got message forwarded from jid ' . $jid);
 254         return $jid;
 255     }
 256
 257     function is_autoreply($txt)
 258     {
 259         if (preg_match('/[\[\(]?[Aa]uto[-\s]?[Rr]e(ply|sponse)[\]\)]/', $txt)) {
 260             return true;
 261         } else if (preg_match('/^System: Message wasn\'t delivered. Offline storage size was exceeded.$/', $txt)) {
 262             return true;
 263         } else {
 264             return false;
 265         }
 266     }
 267
 268     function is_otr($txt)
 269     {
 270         if (preg_match('/^\?OTR/', $txt)) {
 271             return true;
 272         } else {
 273             return false;
 274         }
 275     }
 276
 277     function from_site($address, $msg)
 278     {
 279         $text = '['.common_config('site', 'name') . '] ' . $msg;
 280         jabber_send_message($address, $text);
 281     }
 282
 283     function handle_command($user, $body)
 284     {
 285         $inter = new CommandInterpreter();
 286         $cmd = $inter->handle_command($user, $body);
 287         if ($cmd) {
 288             $chan = new XMPPChannel($this->conn);
 289             $cmd->execute($chan);
 290             return true;
 291         } else {
 292             return false;
 293         }
 294     }
 295
 296     function add_notice(&$user, &$pl)
 297     {
 298         $body = trim($pl['body']);
 299         $content_shortened = common_shorten_links($body);
 300         if (Notice::contentTooLong($content_shortened)) {
 301           $from = jabber_normalize_jid($pl['from']);
 302           $this->from_site($from, sprintf(_('Message too long - maximum is %1$d characters, you sent %2$d.'),
 303                                           Notice::maxContent(),
 304                                           mb_strlen($content_shortened)));
 305           return;
 306         }
 307
 308         try {
 309             $notice = Notice::saveNew($user->id, $content_shortened, 'xmpp');
 310         } catch (Exception $e) {
 311             $this->log(LOG_ERR, $e->getMessage());
 312             $this->from_site($user->jabber, $e->getMessage());
 313             return;
 314         }
 315
 316         common_broadcast_notice($notice);
 317         $this->log(LOG_INFO,
 318                    'Added notice ' . $notice->id . ' from user ' . $user->nickname);
 319         $notice->free();
 320         unset($notice);
 321     }
 322
 323     function handle_presence(&$pl)
 324     {
 325         $from = jabber_normalize_jid($pl['from']);
 326         switch ($pl['type']) {
 327          case 'subscribe':
 328             # We let anyone subscribe
 329             $this->subscribed($from);
 330             $this->log(LOG_INFO,
 331                        'Accepted subscription from ' . $from);
 332             break;
 333          case 'subscribed':
 334          case 'unsubscribed':
 335          case 'unsubscribe':
 336             $this->log(LOG_INFO,
 337                        'Ignoring  "' . $pl['type'] . '" from ' . $from);
 338             break;
 339          default:
 340             if (!$pl['type']) {
 341                 $user = User::staticGet('jabber', $from);
 342                 if (!$user) {
 343                     $this->log(LOG_WARNING, 'Presence from unknown user ' . $from);
 344                     return;
 345                 }
 346                 if ($user->updatefrompresence) {
 347                     $this->log(LOG_INFO, 'Updating ' . $user->nickname .
 348                                ' status from presence.');
 349                     $this->add_notice($user, $pl);
 350                 }
 351                 $user->free();
 352                 unset($user);
 353             }
 354             break;
 355         }
 356         unset($pl['xml']);
 357         $pl['xml'] = null;
 358
 359         $pl = null;
 360         unset($pl);
 361     }
 362
 363     function log($level, $msg)
 364     {
 365         $text = 'XMPPDaemon('.$this->resource.'): '.$msg;
 366         common_log($level, $text);
 367         if (!$this->daemonize)
 368         {
 369             $line = common_log_line($level, $text);
 370             echo $line;
 371             echo "\n";
 372         }
 373     }
 374
 375     function subscribed($to)
 376     {
 377         jabber_special_presence('subscribed', $to);
 378     }
 379 }
 380
 381 // Abort immediately if xmpp is not enabled, otherwise the daemon chews up
 382 // lots of CPU trying to connect to unconfigured servers
 383 if (common_config('xmpp','enabled')==false) {
 384     print "Aborting daemon - xmpp is disabled\n";
 385     exit();
 386 }
 387
 388 if (have_option('i', 'id')) {
 389     $id = get_option_value('i', 'id');
 390 } else if (count($args) > 0) {
 391     $id = $args[0];
 392 } else {
 393     $id = null;
 394 }
 395
 396 $foreground = have_option('f', 'foreground');
 397
 398 $daemon = new XMPPDaemon($id, !$foreground);
 399
 400 $daemon->runOnce();