_darcs/pristine/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             $len = mb_strlen($pl['body']);
 156             if($len > 140) {
 157                 $this->from_site($from, 'Message too long - maximum is 140 characters, you sent ' . $len);
 158                 return;
 159             }
 160             $this->add_notice($user, $pl);
 161         }
 162
 163         $user->free();
 164         unset($user);
 165     }
 166
 167     function is_self($from)
 168     {
 169         return preg_match('/^'.strtolower(jabber_daemon_address()).'/', strtolower($from));
 170     }
 171
 172     function get_ofrom($pl)
 173     {
 174         $xml = $pl['xml'];
 175         $addresses = $xml->sub('addresses');
 176         if (!$addresses) {
 177             $this->log(LOG_WARNING, 'Forwarded message without addresses');
 178             return null;
 179         }
 180         $address = $addresses->sub('address');
 181         if (!$address) {
 182             $this->log(LOG_WARNING, 'Forwarded message without address');
 183             return null;
 184         }
 185         if (!array_key_exists('type', $address->attrs)) {
 186             $this->log(LOG_WARNING, 'No type for forwarded message');
 187             return null;
 188         }
 189         $type = $address->attrs['type'];
 190         if ($type != 'ofrom') {
 191             $this->log(LOG_WARNING, 'Type of forwarded message is not ofrom');
 192             return null;
 193         }
 194         if (!array_key_exists('jid', $address->attrs)) {
 195             $this->log(LOG_WARNING, 'No jid for forwarded message');
 196             return null;
 197         }
 198         $jid = $address->attrs['jid'];
 199         if (!$jid) {
 200             $this->log(LOG_WARNING, 'Could not get jid from address');
 201             return null;
 202         }
 203         $this->log(LOG_DEBUG, 'Got message forwarded from jid ' . $jid);
 204         return $jid;
 205     }
 206
 207     function is_autoreply($txt)
 208     {
 209         if (preg_match('/[\[\(]?[Aa]uto[-\s]?[Rr]e(ply|sponse)[\]\)]/', $txt)) {
 210             return true;
 211         } else {
 212             return false;
 213         }
 214     }
 215
 216     function is_otr($txt)
 217     {
 218         if (preg_match('/^\?OTR/', $txt)) {
 219             return true;
 220         } else {
 221             return false;
 222         }
 223     }
 224
 225     function is_direct($txt)
 226     {
 227         if (strtolower(substr($txt, 0, 2))=='d ') {
 228             return true;
 229         } else {
 230             return false;
 231         }
 232     }
 233
 234     function from_site($address, $msg)
 235     {
 236         $text = '['.common_config('site', 'name') . '] ' . $msg;
 237         jabber_send_message($address, $text);
 238     }
 239
 240     function handle_command($user, $body)
 241     {
 242         $inter = new CommandInterpreter();
 243         $cmd = $inter->handle_command($user, $body);
 244         if ($cmd) {
 245             $chan = new XMPPChannel($this->conn);
 246             $cmd->execute($chan);
 247             return true;
 248         } else {
 249             return false;
 250         }
 251     }
 252
 253     function add_notice(&$user, &$pl)
 254     {
 255         $body = trim($pl['body']);
 256         $content_shortened = common_shorten_link($body);
 257         if (mb_strlen($content_shortened) > 140) {
 258             $content = trim(mb_substr($body, 0, 140));
 259             $content_shortened = common_shorten_link($content);
 260         }
 261         else {
 262             $content = $body;
 263         }
 264         $notice = Notice::saveNew($user->id, $content, 'xmpp');
 265         if (is_string($notice)) {
 266             $this->log(LOG_ERR, $notice);
 267             return;
 268         }
 269         common_broadcast_notice($notice);
 270         $this->log(LOG_INFO,
 271                    'Added notice ' . $notice->id . ' from user ' . $user->nickname);
 272         $notice->free();
 273         unset($notice);
 274     }
 275
 276     function handle_presence(&$pl)
 277     {
 278         $from = jabber_normalize_jid($pl['from']);
 279         switch ($pl['type']) {
 280          case 'subscribe':
 281             # We let anyone subscribe
 282             $this->subscribed($from);
 283             $this->log(LOG_INFO,
 284                        'Accepted subscription from ' . $from);
 285             break;
 286          case 'subscribed':
 287          case 'unsubscribed':
 288          case 'unsubscribe':
 289             $this->log(LOG_INFO,
 290                        'Ignoring  "' . $pl['type'] . '" from ' . $from);
 291             break;
 292          default:
 293             if (!$pl['type']) {
 294                 $user = User::staticGet('jabber', $from);
 295                 if (!$user) {
 296                     $this->log(LOG_WARNING, 'Presence from unknown user ' . $from);
 297                     return;
 298                 }
 299                 if ($user->updatefrompresence) {
 300                     $this->log(LOG_INFO, 'Updating ' . $user->nickname .
 301                                ' status from presence.');
 302                     $this->add_notice($user, $pl);
 303                 }
 304                 $user->free();
 305                 unset($user);
 306             }
 307             break;
 308         }
 309     }
 310
 311     function log($level, $msg)
 312     {
 313         common_log($level, 'XMPPDaemon('.$this->resource.'): '.$msg);
 314     }
 315
 316     function subscribed($to)
 317     {
 318         jabber_special_presence('subscribed', $to);
 319     }
 320 }
 321
 322 ini_set("max_execution_time", "0");
 323 ini_set("max_input_time", "0");
 324 set_time_limit(0);
 325 mb_internal_encoding('UTF-8');
 326
 327 $resource = ($argc > 1) ? $argv[1] : (common_config('xmpp','resource') . '-listen');
 328
 329 $daemon = new XMPPDaemon($resource);
 330
 331 $daemon->runOnce();