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     function XMPPDaemon($resource=null)
  43     {
  44         static $attrs = array('server', 'port', 'user', 'password', 'host');
  45
  46         foreach ($attrs as $attr)
  47         {
  48             $this->$attr = common_config('xmpp', $attr);
  49         }
  50
  51         if ($resource) {
  52             $this->resource = $resource;
  53         } else {
  54             $this->resource = common_config('xmpp', 'resource') . 'daemon';
  55         }
  56
  57         $this->log(LOG_INFO, "INITIALIZE XMPPDaemon {$this->user}@{$this->server}/{$this->resource}");
  58     }
  59
  60     function connect()
  61     {
  62
  63         $connect_to = ($this->host) ? $this->host : $this->server;
  64
  65         $this->log(LOG_INFO, "Connecting to $connect_to on port $this->port");
  66
  67         $this->conn = jabber_connect($this->resource);
  68
  69         if (!$this->conn) {
  70             return false;
  71         }
  72
  73         $this->conn->setReconnectTimeout(600);
  74
  75         jabber_send_presence("Send me a message to post a notice", 'available',
  76                              null, 'available', 100);
  77         return !$this->conn->isDisconnected();
  78     }
  79
  80     function name()
  81     {
  82         return strtolower('xmppdaemon.'.$this->resource);
  83     }
  84
  85     function run()
  86     {
  87         if ($this->connect()) {
  88
  89             $this->conn->addEventHandler('message', 'handle_message', $this);
  90             $this->conn->addEventHandler('presence', 'handle_presence', $this);
  91             $this->conn->addEventHandler('reconnect', 'handle_reconnect', $this);
  92
  93             $this->conn->process();
  94         }
  95     }
  96
  97     function handle_reconnect(&$pl)
  98     {
  99         $this->conn->processUntil('session_start');
 100         $this->conn->presence('Send me a message to post a notice', 'available', null, 'available', 100);
 101     }
 102
 103     function get_user($from)
 104     {
 105         $user = User::staticGet('jabber', jabber_normalize_jid($from));
 106         return $user;
 107     }
 108
 109     function handle_message(&$pl)
 110     {
 111         if ($pl['type'] != 'chat') {
 112             return;
 113         }
 114         if (mb_strlen($pl['body']) == 0) {
 115             return;
 116         }
 117
 118         $from = jabber_normalize_jid($pl['from']);
 119
 120         # Forwarded from another daemon (probably a broadcaster) for
 121         # us to handle
 122
 123         if ($this->is_self($from)) {
 124             $from = $this->get_ofrom($pl);
 125             if (is_null($from) || $this->is_self($from)) {
 126                 return;
 127             }
 128         }
 129
 130         $user = $this->get_user($from);
 131
 132         if (!$user) {
 133             $this->from_site($from, 'Unknown user; go to ' .
 134                              common_local_url('imsettings') .
 135                              ' to add your address to your account');
 136             $this->log(LOG_WARNING, 'Message from unknown user ' . $from);
 137             return;
 138         }
 139         if ($this->handle_command($user, $pl['body'])) {
 140             return;
 141         } else if ($this->is_autoreply($pl['body'])) {
 142             $this->log(LOG_INFO, 'Ignoring auto reply from ' . $from);
 143             return;
 144         } else if ($this->is_otr($pl['body'])) {
 145             $this->log(LOG_INFO, 'Ignoring OTR from ' . $from);
 146             return;
 147         } else if ($this->is_direct($pl['body'])) {
 148             preg_match_all('/d[\ ]*([a-z0-9]{1,64})/', $pl['body'], $to);
 149
 150             $to = preg_replace('/^d([\ ])*/', '', $to[0][0]);
 151             $body = preg_replace('/d[\ ]*('. $to .')[\ ]*/', '', $pl['body']);
 152             $this->add_direct($user, $body, $to, $from);
 153         } else {
 154             $len = mb_strlen($pl['body']);
 155             if($len > 140) {
 156                 $this->from_site($from, 'Message too long - maximum is 140 characters, you sent ' . $len);
 157                 return;
 158             }
 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 {
 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_link($body);
 256         if (mb_strlen($content_shortened) > 140) {
 257             $content = trim(mb_substr($body, 0, 140));
 258             $content_shortened = common_shorten_link($content);
 259         }
 260         else {
 261             $content = $body;
 262         }
 263         $notice = Notice::saveNew($user->id, $content, '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 ini_set("max_execution_time", "0");
 322 ini_set("max_input_time", "0");
 323 set_time_limit(0);
 324 mb_internal_encoding('UTF-8');
 325
 326 $resource = ($argc > 1) ? $argv[1] : (common_config('xmpp','resource') . '-listen');
 327
 328 $daemon = new XMPPDaemon($resource);
 329
 330 $daemon->runOnce();