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