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