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['raw'];
 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-?[Rr]eply[\]\)]/', $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                 # XXX: localise
 228                 $p=explode(' ',$body);
 229                 if(count($p)>2)
 230                         return false;
 231                 switch($p[0]) {
 232                  case 'help':
 233                         if(count($p)!=1)
 234                                 return false;
 235                         $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\n d - direct message to user\n");
 236                         return true;
 237                  case 'on':
 238                         if(count($p)!=1)
 239                                 return false;
 240                         $this->set_notify($user, true);
 241                         $this->from_site($user->jabber, 'notifications on');
 242                         return true;
 243                  case 'off':
 244                         if(count($p)!=1)
 245                                 return false;
 246                         $this->set_notify($user, false);
 247                         $this->from_site($user->jabber, 'notifications off');
 248                         return true;
 249                  case 'sub':
 250                         if(count($p)==1) {
 251                                 $this->from_site($user->jabber, 'Specify the name of the user to subscribe to');
 252                                 return true;
 253                         }
 254                         $result=subs_subscribe_user($user, $p[1]);
 255                         if($result=='true')
 256                                 $this->from_site($user->jabber, 'Subscribed to ' . $p[1]);
 257                         else
 258                                 $this->from_site($user->jabber, $result);
 259                         return true;
 260                  case 'unsub':
 261                         if(count($p)==1) {
 262                                 $this->from_site($user->jabber, 'Specify the name of the user to unsubscribe from');
 263                                 return true;
 264                         }
 265                         $result=subs_unsubscribe_user($user, $p[1]);
 266                         if($result=='true')
 267                                 $this->from_site($user->jabber, 'Unsubscribed from ' . $p[1]);
 268                         else
 269                                 $this->from_site($user->jabber, $result);
 270                         return true;
 271                  case 'last':
 272                         if(count($p)==1) {
 273                                 # I think this might be AWFUL english
 274                                 $this->from_site($user->jabber, 'Specify the name of the user to get the last notice of');
 275                                 return true;
 276                         }
 277                         $this->get_last($user, $p[1], $user->jabber);
 278                         return true;
 279                  default:
 280                         return false;
 281                 }
 282         }
 283
 284         function set_notify(&$user, $notify) {
 285                 $orig = clone($user);
 286                 $user->jabbernotify = $notify;
 287                 $result = $user->update($orig);
 288                 if (!$result) {
 289                         $last_error = &PEAR::getStaticProperty('DB_DataObject','lastError');
 290                         $this->log(LOG_ERR,
 291                                            'Could not set notify flag to ' . $notify .
 292                                            ' for user ' . common_log_objstring($user) .
 293                                            ': ' . $last_error->message);
 294                 } else {
 295                         $this->log(LOG_INFO,
 296                                            'User ' . $user->nickname . ' set notify flag to ' . $notify);
 297                 }
 298         }
 299
 300         function add_notice(&$user, &$pl) {
 301                 $notice = Notice::saveNew($user->id, trim(mb_substr($pl['body'], 0, 140)), 'xmpp');
 302                 if (is_string($notice)) {
 303                         $this->log(LOG_ERR, $notice);
 304                         return;
 305                 }
 306                 common_broadcast_notice($notice);
 307                 $this->log(LOG_INFO,
 308                                    'Added notice ' . $notice->id . ' from user ' . $user->nickname);
 309                 $notice->free();
 310                 unset($notice);
 311         }
 312
 313         function get_last(&$user, $target_nickname, $from) {
 314                 $target = User::staticGet('nickname', $target_nickname);
 315                 if (!$target) {
 316                         $this->from_site($from,_('No such user.'));
 317                         return;
 318                 }
 319
 320                 $notice = $target->getCurrentNotice();
 321                 if (!$notice) {
 322                         $this->from_site($from, "User has no last notice");
 323                         return;
 324                 }
 325
 326                 $notice_content = $notice->content;
 327                 $this->from_site($from, $target_nickname . ": " . $notice_content);
 328
 329
 330
 331         }
 332
 333
 334         function add_direct(&$user, $body, $to, $from) {
 335
 336                 $other = User::staticGet('nickname', $to);
 337
 338                 $this->log(LOG_INFO, 'Direct message to' . $to);
 339                 $len = mb_strlen($body);
 340                 if ($len == 0) {
 341                         $this->from_site($from, _('No content!'));
 342                         return;
 343                 } else if ($len > 140) {
 344                         $this->from_site($from, 'Message too long - maximum is 140 characters, you sent ' . $len);
 345                         return;
 346                 } else if (!$other) {
 347                         $this->from_site($from,_('No such user.'));
 348                         return;
 349                 } else if (!$user->mutuallySubscribed($other)) {
 350                         $this->from_site($from, _('You can\'t send a message to this user.'));
 351                         return;
 352                 } else if ($user->id == $other->id) {
 353                         $this->from_site($from, _('Don\'t send a message to yourself; just say it to yourself quietly instead.'));
 354                         return;
 355                 }
 356                 $this->from_site($from, "Direct message to " . $to . " sent");
 357                 $message = Message::saveNew($user->id, $other->id, $body, 'xmpp');
 358
 359                 # XXX : Need to notify the other person
 360         }
 361
 362         function handle_presence(&$pl) {
 363                 $from = jabber_normalize_jid($pl['from']);
 364                 switch ($pl['type']) {
 365                  case 'subscribe':
 366                         # We let anyone subscribe
 367                         $this->subscribed($from);
 368                         $this->log(LOG_INFO,
 369                                            'Accepted subscription from ' . $from);
 370                         break;
 371                  case 'subscribed':
 372                  case 'unsubscribed':
 373                  case 'unsubscribe':
 374                         $this->log(LOG_INFO,
 375                                            'Ignoring  "' . $pl['type'] . '" from ' . $from);
 376                         break;
 377                  default:
 378                         if (!$pl['type']) {
 379                                 $user = User::staticGet('jabber', $from);
 380                                 if (!$user) {
 381                                         $this->log(LOG_WARNING, 'Presence from unknown user ' . $from);
 382                                         return;
 383                                 }
 384                                 if ($user->updatefrompresence) {
 385                                         $this->log(LOG_INFO, 'Updating ' . $user->nickname .
 386                                                            ' status from presence.');
 387                                         $this->add_notice($user, $pl);
 388                                 }
 389                                 $user->free();
 390                                 unset($user);
 391                         }
 392                         break;
 393                 }
 394         }
 395
 396         function log($level, $msg) {
 397                 common_log($level, 'XMPPDaemon('.$this->resource.'): '.$msg);
 398         }
 399
 400         function subscribed($to) {
 401                 jabber_special_presence('subscribed', $to);
 402         }
 403 }
 404
 405 ini_set("max_execution_time", "0");
 406 ini_set("max_input_time", "0");
 407 set_time_limit(0);
 408 mb_internal_encoding('UTF-8');
 409
 410 $resource = ($argc > 1) ? $argv[1] : (common_config('xmpp','resource') . '-listen');
 411
 412 $daemon = new XMPPDaemon($resource);
 413
 414 $daemon->runOnce();