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                 jabber_send_presence("Send me a message to post a notice", 'available',
  71                                                          NULL, 'available', 100);
  72                 return !$this->conn->isDisconnected();
  73         }
  74
  75         function handle() {
  76                 $this->conn->addEventHandler('message', 'handle_message', $this);
  77                 $this->conn->addEventHandler('presence', 'handle_presence', $this);
  78                 $this->conn->addEventHandler('reconnect', 'handle_reconnect', $this);
  79
  80                 $this->conn->process();
  81         }
  82
  83         function handle_reconnect(&$pl) {
  84                 $this->conn->processUntil('session_start');
  85                 $this->conn->presence('Send me a message to post a notice', 'available', NULL, 'available', 100);
  86         }
  87
  88         function get_user($from) {
  89                 $user = User::staticGet('jabber', jabber_normalize_jid($from));
  90                 return $user;
  91         }
  92
  93         function handle_message(&$pl) {
  94                 if ($pl['type'] != 'chat') {
  95                         return;
  96                 }
  97                 if (mb_strlen($pl['body']) == 0) {
  98                         return;
  99                 }
 100
 101                 $from = jabber_normalize_jid($pl['from']);
 102
 103                 # Forwarded from another daemon (probably a broadcaster) for
 104                 # us to handle
 105
 106                 if ($this->is_self($from)) {
 107                         $from = $this->get_ofrom($pl);
 108                         if (is_null($from) || $this->is_self($from)) {
 109                                 return;
 110                         }
 111                 }
 112
 113                 $user = $this->get_user($from);
 114
 115                 if (!$user) {
 116                         $this->from_site($from, 'Unknown user; go to ' .
 117                                                          common_local_url('imsettings') .
 118                                                          ' to add your address to your account');
 119                         $this->log(LOG_WARNING, 'Message from unknown user ' . $from);
 120                         return;
 121                 }
 122                 if ($this->handle_command($user, $pl['body'])) {
 123                         return;
 124                 } else if ($this->is_autoreply($pl['body'])) {
 125                         $this->log(LOG_INFO, 'Ignoring auto reply from ' . $from);
 126                         return;
 127                 } else if ($this->is_otr($pl['body'])) {
 128                         $this->log(LOG_INFO, 'Ignoring OTR from ' . $from);
 129                         return;
 130                 } else {
 131                         $len = mb_strlen($pl['body']);
 132                         if($len > 140) {
 133                                 $this->from_site($from, 'Message too long - maximum is 140 characters, you sent ' . $len);
 134                                 return;
 135                         }
 136                         $this->add_notice($user, $pl);
 137                 }
 138         }
 139
 140         function is_self($from) {
 141                 return preg_match('/^'.strtolower(jabber_daemon_address()).'/', strtolower($from));
 142         }
 143
 144         function get_ofrom($pl) {
 145                 $xml = $pl['raw'];
 146                 $addresses = $xml->sub('addresses');
 147                 if (!$addresses) {
 148                         $this->log(LOG_WARNING, 'Forwarded message without addresses');
 149                         return NULL;
 150                 }
 151                 $address = $addresses->sub('address');
 152                 if (!$address) {
 153                         $this->log(LOG_WARNING, 'Forwarded message without address');
 154                         return NULL;
 155                 }
 156                 if (!array_key_exists('type', $address->attrs)) {
 157                         $this->log(LOG_WARNING, 'No type for forwarded message');
 158                         return NULL;
 159                 }
 160                 $type = $address->attrs['type'];
 161                 if ($type != 'ofrom') {
 162                         $this->log(LOG_WARNING, 'Type of forwarded message is not ofrom');
 163                         return NULL;
 164                 }
 165                 if (!array_key_exists('jid', $address->attrs)) {
 166                         $this->log(LOG_WARNING, 'No jid for forwarded message');
 167                         return NULL;
 168                 }
 169                 $jid = $address->attrs['jid'];
 170                 if (!$jid) {
 171                         $this->log(LOG_WARNING, 'Could not get jid from address');
 172                         return NULL;
 173                 }
 174                 $this->log(LOG_DEBUG, 'Got message forwarded from jid ' . $jid);
 175                 return $jid;
 176         }
 177
 178         function is_autoreply($txt) {
 179                 if (preg_match('/[\[\(]?[Aa]uto-?[Rr]eply[\]\)]/', $txt)) {
 180                         return true;
 181                 } else {
 182                         return false;
 183                 }
 184         }
 185
 186         function is_otr($txt) {
 187                 if (preg_match('/^\?OTR/', $txt)) {
 188                         return true;
 189                 } else {
 190                         return false;
 191                 }
 192         }
 193
 194         function from_site($address, $msg) {
 195                 $text = '['.common_config('site', 'name') . '] ' . $msg;
 196                 jabber_send_message($address, $text);
 197         }
 198
 199         function handle_command($user, $body) {
 200                 # XXX: localise
 201                 $p=explode(' ',$body);
 202                 if(count($p)>2)
 203                         return false;
 204                 switch($p[0]) {
 205                  case 'help':
 206                         if(count($p)!=1)
 207                                 return false;
 208                         $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");
 209                         return true;
 210                  case 'on':
 211                         if(count($p)!=1)
 212                                 return false;
 213                         $this->set_notify($user, true);
 214                         $this->from_site($user->jabber, 'notifications on');
 215                         return true;
 216                  case 'off':
 217                         if(count($p)!=1)
 218                                 return false;
 219                         $this->set_notify($user, false);
 220                         $this->from_site($user->jabber, 'notifications off');
 221                         return true;
 222                  case 'sub':
 223                         if(count($p)==1) {
 224                                 $this->from_site($user->jabber, 'Specify the name of the user to subscribe to');
 225                                 return true;
 226                         }
 227                         $result=subs_subscribe_user($user, $p[1]);
 228                         if($result=='true')
 229                                 $this->from_site($user->jabber, 'Subscribed to ' . $p[1]);
 230                         else
 231                                 $this->from_site($user->jabber, $result);
 232                         return true;
 233                  case 'unsub':
 234                         if(count($p)==1) {
 235                                 $this->from_site($user->jabber, 'Specify the name of the user to unsubscribe from');
 236                                 return true;
 237                         }
 238                         $result=subs_unsubscribe_user($user, $p[1]);
 239                         if($result=='true')
 240                                 $this->from_site($user->jabber, 'Unsubscribed from ' . $p[1]);
 241                         else
 242                                 $this->from_site($user->jabber, $result);
 243                         return true;
 244                  default:
 245                         return false;
 246                 }
 247         }
 248
 249         function set_notify(&$user, $notify) {
 250                 $orig = clone($user);
 251                 $user->jabbernotify = $notify;
 252                 $result = $user->update($orig);
 253                 if (!$result) {
 254                         $last_error = &PEAR::getStaticProperty('DB_DataObject','lastError');
 255                         $this->log(LOG_ERR,
 256                                            'Could not set notify flag to ' . $notify .
 257                                            ' for user ' . common_log_objstring($user) .
 258                                            ': ' . $last_error->message);
 259                 } else {
 260                         $this->log(LOG_INFO,
 261                                            'User ' . $user->nickname . ' set notify flag to ' . $notify);
 262                 }
 263         }
 264
 265         function add_notice(&$user, &$pl) {
 266                 $notice = Notice::saveNew($user->id, trim(mb_substr($pl['body'], 0, 140)), 'xmpp');
 267                 if (is_string($notice)) {
 268                         $this->log(LOG_ERR, $notice);
 269                         return;
 270                 }
 271                 common_broadcast_notice($notice);
 272                 $this->log(LOG_INFO,
 273                                    'Added notice ' . $notice->id . ' from user ' . $user->nickname);
 274         }
 275
 276         function handle_presence(&$pl) {
 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                         }
 304                         break;
 305                 }
 306         }
 307
 308         function log($level, $msg) {
 309                 common_log($level, 'XMPPDaemon('.$this->resource.'): '.$msg);
 310         }
 311
 312         function subscribed($to) {
 313                 jabber_special_presence('subscribed', $to);
 314         }
 315 }
 316
 317 ini_set("max_execution_time", "0");
 318 ini_set("max_input_time", "0");
 319 set_time_limit(0);
 320 mb_internal_encoding('UTF-8');
 321
 322 $resource = ($argc > 1) ? $argv[1] : (common_config('xmpp','resource') . '-listen');
 323
 324 $daemon = new XMPPDaemon($resource);
 325
 326 if ($daemon->connect()) {
 327         $daemon->handle();
 328 }