scripts/xmppdaemon.php

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