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