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 function xmppdaemon_error_handler($errno, $errstr, $errfile, $errline, $errcontext) {
  22     switch ($errno) {
  23      case E_USER_ERROR:
  24                 echo "ERROR: [$errno] $errstr ($errfile:$errline)\n";
  25                 echo "  Fatal error on line $errline in file $errfile";
  26                 echo ", PHP " . PHP_VERSION . " (" . PHP_OS . ")\n";
  27                 echo "Aborting...\n";
  28                 exit(1);
  29                 break;
  30
  31          case E_USER_WARNING:
  32                 echo "WARNING [$errno] $errstr ($errfile:$errline)\n";
  33                 break;
  34
  35      case E_USER_NOTICE:
  36                 echo "NOTICE [$errno] $errstr ($errfile:$errline)\n";
  37                 break;
  38
  39      default:
  40                 echo "Unknown error type: [$errno] $errstr ($errfile:$errline)\n";
  41                 break;
  42     }
  43
  44     /* Don't execute PHP internal error handler */
  45     return true;
  46 }
  47
  48 set_error_handler('xmppdaemon_error_handler');
  49
  50 # Abort if called from a web server
  51 if (isset($_SERVER) && array_key_exists('REQUEST_METHOD', $_SERVER)) {
  52         print "This script must be run from the command line\n";
  53         exit();
  54 }
  55
  56 define('INSTALLDIR', realpath(dirname(__FILE__) . '/..'));
  57 define('LACONICA', true);
  58
  59 require_once(INSTALLDIR . '/lib/common.php');
  60 require_once(INSTALLDIR . '/lib/jabber.php');
  61 require_once(INSTALLDIR . '/lib/daemon.php');
  62
  63 set_error_handler('common_error_handler');
  64
  65 # This is kind of clunky; we create a class to call the global functions
  66 # in jabber.php, which create a new XMPP class. A more elegant (?) solution
  67 # might be to use make this a subclass of XMPP.
  68
  69 class XMPPDaemon extends Daemon {
  70
  71         function XMPPDaemon($resource=NULL) {
  72                 static $attrs = array('server', 'port', 'user', 'password', 'host');
  73
  74                 foreach ($attrs as $attr)
  75                 {
  76                         $this->$attr = common_config('xmpp', $attr);
  77                 }
  78
  79                 if ($resource) {
  80                         $this->resource = $resource;
  81                 } else {
  82                         $this->resource = common_config('xmpp', 'resource') . 'daemon';
  83                 }
  84
  85                 $this->log(LOG_INFO, "INITIALIZE XMPPDaemon {$this->user}@{$this->server}/{$this->resource}");
  86         }
  87
  88         function connect() {
  89
  90                 $connect_to = ($this->host) ? $this->host : $this->server;
  91
  92                 $this->log(LOG_INFO, "Connecting to $connect_to on port $this->port");
  93
  94                 $this->conn = jabber_connect($this->resource);
  95
  96                 if (!$this->conn) {
  97                         return false;
  98                 }
  99
 100                 $this->conn->setReconnectTimeout(600);
 101
 102                 jabber_send_presence("Send me a message to post a notice", 'available',
 103                                                          NULL, 'available', 100);
 104                 return !$this->conn->isDisconnected();
 105         }
 106
 107         function name() {
 108                 return strtolower('xmppdaemon.'.$this->resource);
 109         }
 110
 111         function run() {
 112                 if ($this->connect()) {
 113
 114                         $this->conn->addEventHandler('message', 'handle_message', $this);
 115                         $this->conn->addEventHandler('presence', 'handle_presence', $this);
 116                         $this->conn->addEventHandler('reconnect', 'handle_reconnect', $this);
 117
 118                         $this->conn->process();
 119                 }
 120         }
 121
 122         function handle_reconnect(&$pl) {
 123                 $this->conn->processUntil('session_start');
 124                 $this->conn->presence('Send me a message to post a notice', 'available', NULL, 'available', 100);
 125         }
 126
 127         function get_user($from) {
 128                 $user = User::staticGet('jabber', jabber_normalize_jid($from));
 129                 return $user;
 130         }
 131
 132         function handle_message(&$pl) {
 133                 if ($pl['type'] != 'chat') {
 134                         return;
 135                 }
 136                 if (mb_strlen($pl['body']) == 0) {
 137                         return;
 138                 }
 139
 140                 $from = jabber_normalize_jid($pl['from']);
 141
 142                 # Forwarded from another daemon (probably a broadcaster) for
 143                 # us to handle
 144
 145                 if ($this->is_self($from)) {
 146                         $from = $this->get_ofrom($pl);
 147                         if (is_null($from) || $this->is_self($from)) {
 148                                 return;
 149                         }
 150                 }
 151
 152                 $user = $this->get_user($from);
 153
 154                 if (!$user) {
 155                         $this->from_site($from, 'Unknown user; go to ' .
 156                                                          common_local_url('imsettings') .
 157                                                          ' to add your address to your account');
 158                         $this->log(LOG_WARNING, 'Message from unknown user ' . $from);
 159                         return;
 160                 }
 161                 if ($this->handle_command($user, $pl['body'])) {
 162                         return;
 163                 } else if ($this->is_autoreply($pl['body'])) {
 164                         $this->log(LOG_INFO, 'Ignoring auto reply from ' . $from);
 165                         return;
 166                 } else if ($this->is_otr($pl['body'])) {
 167                         $this->log(LOG_INFO, 'Ignoring OTR from ' . $from);
 168                         return;
 169                 } else {
 170                         $this->add_notice($user, $pl);
 171                 }
 172
 173                 $user->free();
 174                 unset($user);
 175         }
 176
 177         function is_self($from) {
 178                 return preg_match('/^'.strtolower(jabber_daemon_address()).'/', strtolower($from));
 179         }
 180
 181         function get_ofrom($pl) {
 182                 $xml = $pl['raw'];
 183                 $addresses = $xml->sub('addresses');
 184                 if (!$addresses) {
 185                         $this->log(LOG_WARNING, 'Forwarded message without addresses');
 186                         return NULL;
 187                 }
 188                 $address = $addresses->sub('address');
 189                 if (!$address) {
 190                         $this->log(LOG_WARNING, 'Forwarded message without address');
 191                         return NULL;
 192                 }
 193                 if (!array_key_exists('type', $address->attrs)) {
 194                         $this->log(LOG_WARNING, 'No type for forwarded message');
 195                         return NULL;
 196                 }
 197                 $type = $address->attrs['type'];
 198                 if ($type != 'ofrom') {
 199                         $this->log(LOG_WARNING, 'Type of forwarded message is not ofrom');
 200                         return NULL;
 201                 }
 202                 if (!array_key_exists('jid', $address->attrs)) {
 203                         $this->log(LOG_WARNING, 'No jid for forwarded message');
 204                         return NULL;
 205                 }
 206                 $jid = $address->attrs['jid'];
 207                 if (!$jid) {
 208                         $this->log(LOG_WARNING, 'Could not get jid from address');
 209                         return NULL;
 210                 }
 211                 $this->log(LOG_DEBUG, 'Got message forwarded from jid ' . $jid);
 212                 return $jid;
 213         }
 214
 215         function is_autoreply($txt) {
 216                 if (preg_match('/[\[\(]?[Aa]uto-?[Rr]eply[\]\)]/', $txt)) {
 217                         return true;
 218                 } else {
 219                         return false;
 220                 }
 221         }
 222
 223         function is_otr($txt) {
 224                 if (preg_match('/^\?OTR/', $txt)) {
 225                         return true;
 226                 } else {
 227                         return false;
 228                 }
 229         }
 230
 231         function from_site($address, $msg) {
 232                 $text = '['.common_config('site', 'name') . '] ' . $msg;
 233                 jabber_send_message($address, $text);
 234         }
 235
 236         function handle_command($user, $body) {
 237                 # XXX: localise
 238                 switch(trim($body)) {
 239                  case 'on':
 240                         $this->set_notify($user, true);
 241                         $this->from_site($user->jabber, 'notifications on');
 242                         return true;
 243                  case 'off':
 244                         $this->set_notify($user, false);
 245                         $this->from_site($user->jabber, 'notifications off');
 246                         return true;
 247                  default:
 248                         return false;
 249                 }
 250         }
 251
 252         function set_notify(&$user, $notify) {
 253                 $orig = clone($user);
 254                 $user->jabbernotify = $notify;
 255                 $result = $user->update($orig);
 256                 if (!$id) {
 257                         $last_error = &PEAR::getStaticProperty('DB_DataObject','lastError');
 258                         $this->log(LOG_ERR,
 259                                            'Could not set notify flag to ' . $notify .
 260                                            ' for user ' . common_log_objstring($user) .
 261                                            ': ' . $last_error->message);
 262                 } else {
 263                         $this->log(LOG_INFO,
 264                                            'User ' . $user->nickname . ' set notify flag to ' . $notify);
 265                 }
 266         }
 267
 268         function add_notice(&$user, &$pl) {
 269                 $notice = Notice::saveNew($user->id, trim(mb_substr($pl['body'], 0, 140)), 'xmpp');
 270                 if (is_string($notice)) {
 271                         $this->log(LOG_ERR, $notice);
 272                         return;
 273                 }
 274                 common_broadcast_notice($notice);
 275                 $this->log(LOG_INFO,
 276                                    'Added notice ' . $notice->id . ' from user ' . $user->nickname);
 277                 $notice->free();
 278                 unset($notice);
 279         }
 280
 281         function handle_presence(&$pl) {
 282                 $from = jabber_normalize_jid($pl['from']);
 283                 switch ($pl['type']) {
 284                  case 'subscribe':
 285                         # We let anyone subscribe
 286                         $this->subscribed($from);
 287                         $this->log(LOG_INFO,
 288                                            'Accepted subscription from ' . $from);
 289                         break;
 290                  case 'subscribed':
 291                  case 'unsubscribed':
 292                  case 'unsubscribe':
 293                         $this->log(LOG_INFO,
 294                                            'Ignoring  "' . $pl['type'] . '" from ' . $from);
 295                         break;
 296                  default:
 297                         if (!$pl['type']) {
 298                                 $user = User::staticGet('jabber', $from);
 299                                 if (!$user) {
 300                                         $this->log(LOG_WARNING, 'Presence from unknown user ' . $from);
 301                                         return;
 302                                 }
 303                                 if ($user->updatefrompresence) {
 304                                         $this->log(LOG_INFO, 'Updating ' . $user->nickname .
 305                                                            ' status from presence.');
 306                                         $this->add_notice($user, $pl);
 307                                 }
 308                                 $user->free();
 309                                 unset($user);
 310                         }
 311                         break;
 312                 }
 313         }
 314
 315         function log($level, $msg) {
 316                 common_log($level, 'XMPPDaemon('.$this->resource.'): '.$msg);
 317         }
 318
 319         function subscribed($to) {
 320                 jabber_special_presence('subscribed', $to);
 321         }
 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();