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 {
 141                         $len = mb_strlen($pl['body']);
 142                         if($len > 140) {
 143                                 $this->from_site($from, 'Message too long - maximum is 140 characters, you sent ' . $len);
 144                                 return;
 145                         }
 146                         $this->add_notice($user, $pl);
 147                 }
 148
 149                 $user->free();
 150                 unset($user);
 151         }
 152
 153         function is_self($from) {
 154                 return preg_match('/^'.strtolower(jabber_daemon_address()).'/', strtolower($from));
 155         }
 156
 157         function get_ofrom($pl) {
 158                 $xml = $pl['raw'];
 159                 $addresses = $xml->sub('addresses');
 160                 if (!$addresses) {
 161                         $this->log(LOG_WARNING, 'Forwarded message without addresses');
 162                         return NULL;
 163                 }
 164                 $address = $addresses->sub('address');
 165                 if (!$address) {
 166                         $this->log(LOG_WARNING, 'Forwarded message without address');
 167                         return NULL;
 168                 }
 169                 if (!array_key_exists('type', $address->attrs)) {
 170                         $this->log(LOG_WARNING, 'No type for forwarded message');
 171                         return NULL;
 172                 }
 173                 $type = $address->attrs['type'];
 174                 if ($type != 'ofrom') {
 175                         $this->log(LOG_WARNING, 'Type of forwarded message is not ofrom');
 176                         return NULL;
 177                 }
 178                 if (!array_key_exists('jid', $address->attrs)) {
 179                         $this->log(LOG_WARNING, 'No jid for forwarded message');
 180                         return NULL;
 181                 }
 182                 $jid = $address->attrs['jid'];
 183                 if (!$jid) {
 184                         $this->log(LOG_WARNING, 'Could not get jid from address');
 185                         return NULL;
 186                 }
 187                 $this->log(LOG_DEBUG, 'Got message forwarded from jid ' . $jid);
 188                 return $jid;
 189         }
 190
 191         function is_autoreply($txt) {
 192                 if (preg_match('/[\[\(]?[Aa]uto-?[Rr]eply[\]\)]/', $txt)) {
 193                         return true;
 194                 } else {
 195                         return false;
 196                 }
 197         }
 198
 199         function is_otr($txt) {
 200                 if (preg_match('/^\?OTR/', $txt)) {
 201                         return true;
 202                 } else {
 203                         return false;
 204                 }
 205         }
 206
 207         function from_site($address, $msg) {
 208                 $text = '['.common_config('site', 'name') . '] ' . $msg;
 209                 jabber_send_message($address, $text);
 210         }
 211
 212         function handle_command($user, $body) {
 213                 # XXX: localise
 214                 $p=explode(' ',$body);
 215                 if(count($p)>2)
 216                         return false;
 217                 switch($p[0]) {
 218                  case 'help':
 219                         if(count($p)!=1)
 220                                 return false;
 221                         $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 unsubscribe - unsub from user");
 222                         return true;
 223                  case 'on':
 224                         if(count($p)!=1)
 225                                 return false;
 226                         $this->set_notify($user, true);
 227                         $this->from_site($user->jabber, 'notifications on');
 228                         return true;
 229                  case 'off':
 230                         if(count($p)!=1)
 231                                 return false;
 232                         $this->set_notify($user, false);
 233                         $this->from_site($user->jabber, 'notifications off');
 234                         return true;
 235                  case 'sub':
 236                         if(count($p)==1) {
 237                                 $this->from_site($user->jabber, 'Specify the name of the user to subscribe to');
 238                                 return true;
 239                         }
 240                         $result=subs_subscribe_user($user, $p[1]);
 241                         if($result=='true')
 242                                 $this->from_site($user->jabber, 'Subscribed to ' . $p[1]);
 243                         else
 244                                 $this->from_site($user->jabber, $result);
 245                         return true;
 246                  case 'unsub':
 247                         if(count($p)==1) {
 248                                 $this->from_site($user->jabber, 'Specify the name of the user to unsubscribe from');
 249                                 return true;
 250                         }
 251                         $result=subs_unsubscribe_user($user, $p[1]);
 252                         if($result=='true')
 253                                 $this->from_site($user->jabber, 'Unsubscribed from ' . $p[1]);
 254                         else
 255                                 $this->from_site($user->jabber, $result);
 256                         return true;
 257                  default:
 258                         return false;
 259                 }
 260         }
 261
 262         function set_notify(&$user, $notify) {
 263                 $orig = clone($user);
 264                 $user->jabbernotify = $notify;
 265                 $result = $user->update($orig);
 266                 if (!$result) {
 267                         $last_error = &PEAR::getStaticProperty('DB_DataObject','lastError');
 268                         $this->log(LOG_ERR,
 269                                            'Could not set notify flag to ' . $notify .
 270                                            ' for user ' . common_log_objstring($user) .
 271                                            ': ' . $last_error->message);
 272                 } else {
 273                         $this->log(LOG_INFO,
 274                                            'User ' . $user->nickname . ' set notify flag to ' . $notify);
 275                 }
 276         }
 277
 278         function add_notice(&$user, &$pl) {
 279                 $notice = Notice::saveNew($user->id, trim(mb_substr($pl['body'], 0, 140)), 'xmpp');
 280                 if (is_string($notice)) {
 281                         $this->log(LOG_ERR, $notice);
 282                         return;
 283                 }
 284                 common_broadcast_notice($notice);
 285                 $this->log(LOG_INFO,
 286                                    'Added notice ' . $notice->id . ' from user ' . $user->nickname);
 287                 $notice->free();
 288                 unset($notice);
 289         }
 290
 291         function handle_presence(&$pl) {
 292                 $from = jabber_normalize_jid($pl['from']);
 293                 switch ($pl['type']) {
 294                  case 'subscribe':
 295                         # We let anyone subscribe
 296                         $this->subscribed($from);
 297                         $this->log(LOG_INFO,
 298                                            'Accepted subscription from ' . $from);
 299                         break;
 300                  case 'subscribed':
 301                  case 'unsubscribed':
 302                  case 'unsubscribe':
 303                         $this->log(LOG_INFO,
 304                                            'Ignoring  "' . $pl['type'] . '" from ' . $from);
 305                         break;
 306                  default:
 307                         if (!$pl['type']) {
 308                                 $user = User::staticGet('jabber', $from);
 309                                 if (!$user) {
 310                                         $this->log(LOG_WARNING, 'Presence from unknown user ' . $from);
 311                                         return;
 312                                 }
 313                                 if ($user->updatefrompresence) {
 314                                         $this->log(LOG_INFO, 'Updating ' . $user->nickname .
 315                                                            ' status from presence.');
 316                                         $this->add_notice($user, $pl);
 317                                 }
 318                                 $user->free();
 319                                 unset($user);
 320                         }
 321                         break;
 322                 }
 323         }
 324
 325         function log($level, $msg) {
 326                 common_log($level, 'XMPPDaemon('.$this->resource.'): '.$msg);
 327         }
 328
 329         function subscribed($to) {
 330                 jabber_special_presence('subscribed', $to);
 331         }
 332 }
 333
 334 ini_set("max_execution_time", "0");
 335 ini_set("max_input_time", "0");
 336 set_time_limit(0);
 337 mb_internal_encoding('UTF-8');
 338
 339 $resource = ($argc > 1) ? $argv[1] : (common_config('xmpp','resource') . '-listen');
 340
 341 $daemon = new XMPPDaemon($resource);
 342
 343 $daemon->runOnce();