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 "My 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 define('CLAIM_TIMEOUT', 100000);
  59
  60 require_once(INSTALLDIR . '/lib/common.php');
  61 require_once(INSTALLDIR . '/lib/jabber.php');
  62
  63 # This is kind of clunky; we create a class to call the global functions
  64 # in jabber.php, which create a new XMPP class. A more elegant (?) solution
  65 # might be to use make this a subclass of XMPP.
  66
  67 class XMPPDaemon {
  68
  69         function XMPPDaemon($resource=NULL) {
  70                 static $attrs = array('server', 'port', 'user', 'password', 'host');
  71
  72                 foreach ($attrs as $attr)
  73                 {
  74                         $this->$attr = common_config('xmpp', $attr);
  75                 }
  76
  77                 if ($resource) {
  78                         $this->resource = $resource;
  79                 } else {
  80                         $this->resource = common_config('xmpp', 'resource') . 'daemon';
  81                 }
  82
  83                 $this->log(LOG_INFO, "{$this->user}@{$this->server}/{$this->resource}");
  84         }
  85
  86         function connect() {
  87
  88                 $connect_to = ($this->host) ? $this->host : $this->server;
  89
  90                 $this->log(LOG_INFO, "Connecting to $connect_to on port $this->port");
  91
  92                 $this->conn = jabber_connect($this->resource);
  93
  94                 if (!$this->conn) {
  95                         return false;
  96                 }
  97
  98                 return !$this->conn->isDisconnected();
  99         }
 100
 101         function handle() {
 102
 103                 static $parts = array('message', 'presence',
 104                                                           'end_stream', 'session_start');
 105
 106                 while(!$this->conn->isDisconnected()) {
 107
 108                         $payloads = $this->conn->processUntil($parts, 10);
 109
 110                         if ($payloads) {
 111                                 foreach($payloads as $event) {
 112                                         $pl = $event[1];
 113                                         switch($event[0]) {
 114                                          case 'message':
 115                                                 $this->handle_message($pl);
 116                                                 break;
 117                                          case 'presence':
 118                                                 $this->handle_presence($pl);
 119                                                 break;
 120                                          case 'session_start':
 121                                                 $this->handle_session($pl);
 122                                                 break;
 123                                         }
 124                                 }
 125                         }
 126
 127                         $this->broadcast_queue();
 128                         $this->confirmation_queue();
 129                 }
 130         }
 131
 132         function handle_session($pl) {
 133                 # XXX what to do here?
 134                 return true;
 135         }
 136
 137         function get_user($from) {
 138                 $user = User::staticGet('jabber', jabber_normalize_jid($from));
 139                 return $user;
 140         }
 141
 142         function get_confirmation($from) {
 143                 $confirm = new Confirm_address();
 144                 $confirm->address = $from;
 145                 $confirm->address_type = 'jabber';
 146                 if ($confirm->find(TRUE)) {
 147                         return $confirm;
 148                 } else {
 149                         return NULL;
 150                 }
 151         }
 152
 153         function handle_message(&$pl) {
 154                 if ($pl['type'] != 'chat') {
 155                         return;
 156                 }
 157                 if (strlen($pl['body']) == 0) {
 158                         return;
 159                 }
 160
 161                 $from = jabber_normalize_jid($pl['from']);
 162                 $user = $this->get_user($from);
 163
 164                 if (!$user) {
 165                         $this->from_site($from, 'Unknown user; go to ' .
 166                                                          common_local_url('imsettings') .
 167                                                          ' to add your address to your account');
 168                         $this->log(LOG_WARNING, 'Message from unknown user ' . $from);
 169                         return;
 170                 }
 171                 if ($this->handle_command($user, $pl['body'])) {
 172                         return;
 173                 } else if ($this->is_autoreply($pl['body'])) {
 174                         $this->log(LOG_INFO, 'Ignoring auto reply from ' . $from);
 175                         return;
 176                 } else if ($this->is_otr($pl['body'])) {
 177                         $this->log(LOG_INFO, 'Ignoring OTR from ' . $from);
 178                         return;
 179                 } else {
 180                         if(strlen($pl['body'])>140) {
 181                                 $this->from_site($from, 'Message too long - maximum is 140 characters, you sent ' . strlen($pl['body']));
 182                                 return;
 183                         }
 184                         $this->add_notice($user, $pl);
 185                 }
 186         }
 187
 188         function is_autoreply($txt) {
 189                 if (preg_match('/[\[\(]?[Aa]uto-?[Rr]eply[\]\)]/', $txt)) {
 190                         return true;
 191                 } else {
 192                         return false;
 193                 }
 194         }
 195
 196         function is_otr($txt) {
 197                 if (preg_match('/^\?OTR/', $txt)) {
 198                         return true;
 199                 } else {
 200                         return false;
 201                 }
 202         }
 203
 204         function from_site($address, $msg) {
 205                 $text = '['.common_config('site', 'name') . '] ' . $msg;
 206                 jabber_send_message($address, $text);
 207         }
 208
 209         function handle_command($user, $body) {
 210                 # XXX: localise
 211                 $p=explode(' ',$body);
 212                 if(count($p)>2)
 213                         return false;
 214                 switch($p[0]) {
 215                  case 'help':
 216                         if(count($p)!=1)
 217                                 return false;
 218                         $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");
 219                         return true;
 220                  case 'on':
 221                         if(count($p)!=1)
 222                                 return false;
 223                         $this->set_notify($user, true);
 224                         $this->from_site($user->jabber, 'notifications on');
 225                         return true;
 226                  case 'off':
 227                         if(count($p)!=1)
 228                                 return false;
 229                         $this->set_notify($user, false);
 230                         $this->from_site($user->jabber, 'notifications off');
 231                         return true;
 232                  case 'sub':
 233                         if(count($p)==1) {
 234                                 $this->from_site($user->jabber, 'Specify the name of the user to subscribe to');
 235                                 return true;
 236                         }
 237                         $result=subs_subscribe_user($user, $p[1]);
 238                         if($result=='true')
 239                                 $this->from_site($user->jabber, 'Subscribed to ' . $p[1]);
 240                         else
 241                                 $this->from_site($user->jabber, $result);
 242                         return true;
 243                  case 'unsub':
 244                         if(count($p)==1) {
 245                                 $this->from_site($user->jabber, 'Specify the name of the user to unsubscribe from');
 246                                 return true;
 247                         }
 248                         $result=subs_unsubscribe_user($user, $p[1]);
 249                         if($result=='true')
 250                                 $this->from_site($user->jabber, 'Unsubscribed from ' . $p[1]);
 251                         else
 252                                 $this->from_site($user->jabber, $result);
 253                         return true;
 254                  default:
 255                         return false;
 256                 }
 257         }
 258
 259         function set_notify(&$user, $notify) {
 260                 $orig = clone($user);
 261                 $user->jabbernotify = $notify;
 262                 $result = $user->update($orig);
 263                 if (!$result) {
 264                         $last_error = &PEAR::getStaticProperty('DB_DataObject','lastError');
 265                         $this->log(LOG_ERR,
 266                                            'Could not set notify flag to ' . $notify .
 267                                            ' for user ' . common_log_objstring($user) .
 268                                            ': ' . $last_error->message);
 269                 } else {
 270                         $this->log(LOG_INFO,
 271                                            'User ' . $user->nickname . ' set notify flag to ' . $notify);
 272                 }
 273         }
 274
 275         function add_notice(&$user, &$pl) {
 276                 $notice = Notice::saveNew($user->id, trim(mb_substr($pl['body'], 0, 140)), 'xmpp');
 277                 if (is_string($notice)) {
 278                         $this->log(LOG_ERR, $notice);
 279                         return;
 280                 }
 281                 common_real_broadcast($notice);
 282                 $this->log(LOG_INFO,
 283                                    'Added notice ' . $notice->id . ' from user ' . $user->nickname);
 284         }
 285
 286         function handle_presence(&$pl) {
 287                 $from = jabber_normalize_jid($pl['from']);
 288                 switch ($pl['type']) {
 289                  case 'subscribe':
 290                         # We let anyone subscribe
 291                         $this->subscribed($from);
 292                         $this->log(LOG_INFO,
 293                                            'Accepted subscription from ' . $from);
 294                         break;
 295                  case 'subscribed':
 296                  case 'unsubscribed':
 297                  case 'unsubscribe':
 298                         $this->log(LOG_INFO,
 299                                            'Ignoring  "' . $pl['type'] . '" from ' . $from);
 300                         break;
 301                  default:
 302                         if (!$pl['type']) {
 303                                 $user = User::staticGet('jabber', $from);
 304                                 if (!$user) {
 305                                         $this->log(LOG_WARNING, 'Presence from unknown user ' . $from);
 306                                         return;
 307                                 }
 308                                 if ($user->updatefrompresence) {
 309                                         $this->log(LOG_INFO, 'Updating ' . $user->nickname .
 310                                                            ' status from presence.');
 311                                         $this->add_notice($user, $pl);
 312                                 }
 313                         }
 314                         break;
 315                 }
 316         }
 317
 318         function log($level, $msg) {
 319                 common_log($level, 'XMPPDaemon('.$this->resource.'): '.$msg);
 320         }
 321
 322         function subscribed($to) {
 323                 jabber_special_presence('subscribed', $to);
 324         }
 325
 326         function set_status($status) {
 327                 $this->log(LOG_INFO, 'Setting status to "' . $status . '"');
 328                 jabber_send_presence($status);
 329         }
 330
 331         function top_queue_item() {
 332
 333                 $qi = new Queue_item();
 334                 $qi->orderBy('created');
 335                 $qi->whereAdd('claimed is NULL');
 336
 337                 $qi->limit(1);
 338
 339                 $cnt = $qi->find(TRUE);
 340
 341                 if ($cnt) {
 342                         # XXX: potential race condition
 343                         # can we force it to only update if claimed is still NULL
 344                         # (or old)?
 345                         $this->log(LOG_INFO, 'claiming queue item = ' . $qi->notice_id);
 346                         $orig = clone($qi);
 347                         $qi->claimed = DB_DataObject_Cast::dateTime();
 348                         $result = $qi->update($orig);
 349                         if ($result) {
 350                                 $this->log(LOG_INFO, 'claim succeeded.');
 351                                 return $qi;
 352                         } else {
 353                                 $this->log(LOG_INFO, 'claim failed.');
 354                         }
 355                 }
 356                 $qi = NULL;
 357                 return NULL;
 358         }
 359
 360         function broadcast_queue() {
 361                 $this->clear_old_claims();
 362                 $this->log(LOG_INFO, 'checking for queued notices');
 363                 do {
 364                         $qi = $this->top_queue_item();
 365                         if ($qi) {
 366                                 $this->log(LOG_INFO, 'Got item enqueued '.common_exact_date($qi->created));
 367                                 $notice = Notice::staticGet($qi->notice_id);
 368                                 if ($notice) {
 369                                         $this->log(LOG_INFO, 'broadcasting notice ID = ' . $notice->id);
 370                                         # XXX: what to do if broadcast fails?
 371                                         $result = common_real_broadcast($notice, $this->is_remote($notice));
 372                                         if (!$result) {
 373                                                 $this->log(LOG_WARNING, 'Failed broadcast for notice ID = ' . $notice->id);
 374                                                 $orig = $qi;
 375                                                 $qi->claimed = NULL;
 376                                                 $qi->update($orig);
 377                                                 $this->log(LOG_WARNING, 'Abandoned claim for notice ID = ' . $notice->id);
 378                                                 continue;
 379                                         }
 380                                         $this->log(LOG_INFO, 'finished broadcasting notice ID = ' . $notice->id);
 381                                         $notice = NULL;
 382                                 } else {
 383                                         $this->log(LOG_WARNING, 'queue item for notice that does not exist');
 384                                 }
 385                                 $qi->delete();
 386                         }
 387                 } while ($qi);
 388         }
 389
 390         function clear_old_claims() {
 391                 $qi = new Queue_item();
 392                 $qi->claimed = NULL;
 393                 $qi->whereAdd('now() - claimed > '.CLAIM_TIMEOUT);
 394                 $qi->update(DB_DATAOBJECT_WHEREADD_ONLY);
 395         }
 396
 397         function is_remote($notice) {
 398                 $user = User::staticGet($notice->profile_id);
 399                 return !$user;
 400         }
 401
 402         function confirmation_queue() {
 403             # $this->clear_old_confirm_claims();
 404                 $this->log(LOG_INFO, 'checking for queued confirmations');
 405                 do {
 406                         $confirm = $this->next_confirm();
 407                         if ($confirm) {
 408                                 $this->log(LOG_INFO, 'Sending confirmation for ' . $confirm->address);
 409                                 $user = User::staticGet($confirm->user_id);
 410                                 if (!$user) {
 411                                         $this->log(LOG_WARNING, 'Confirmation for unknown user ' . $confirm->user_id);
 412                                         continue;
 413                                 }
 414                                 $success = jabber_confirm_address($confirm->code,
 415                                                                   $user->nickname,
 416                                                                   $confirm->address);
 417                                 if (!$success) {
 418                                         $this->log(LOG_ERR, 'Confirmation failed for ' . $confirm->address);
 419                                         # Just let the claim age out; hopefully things work then
 420                                         continue;
 421                                 } else {
 422                                         $this->log(LOG_INFO, 'Confirmation sent for ' . $confirm->address);
 423                                         # Mark confirmation sent
 424                                         $original = clone($confirm);
 425                                         $confirm->sent = $confirm->claimed;
 426                                         $result = $confirm->update($original);
 427                                         if (!$result) {
 428                                                 $this->log(LOG_ERR, 'Cannot mark sent for ' . $confirm->address);
 429                                                 # Just let the claim age out; hopefully things work then
 430                                                 continue;
 431                                         }
 432                                 }
 433                         }
 434                 } while ($confirm);
 435         }
 436
 437         function next_confirm() {
 438                 $confirm = new Confirm_address();
 439                 $confirm->whereAdd('claimed IS NULL');
 440                 $confirm->whereAdd('sent IS NULL');
 441                 # XXX: eventually we could do other confirmations in the queue, too
 442                 $confirm->address_type = 'jabber';
 443                 $confirm->orderBy('modified DESC');
 444                 $confirm->limit(1);
 445                 if ($confirm->find(TRUE)) {
 446                         $this->log(LOG_INFO, 'Claiming confirmation for ' . $confirm->address);
 447                         # working around some weird DB_DataObject behaviour
 448                         $confirm->whereAdd(''); # clears where stuff
 449                         $original = clone($confirm);
 450                         $confirm->claimed = DB_DataObject_Cast::dateTime();
 451                         $result = $confirm->update($original);
 452                         if ($result) {
 453                                 $this->log(LOG_INFO, 'Succeeded in claim! '. $result);
 454                                 return $confirm;
 455                         } else {
 456                                 $this->log(LOG_INFO, 'Failed in claim!');
 457                                 return false;
 458                         }
 459                 }
 460                 return NULL;
 461         }
 462
 463         function clear_old_confirm_claims() {
 464                 $confirm = new Confirm();
 465                 $confirm->claimed = NULL;
 466                 $confirm->whereAdd('now() - claimed > '.CLAIM_TIMEOUT);
 467                 $confirm->update(DB_DATAOBJECT_WHEREADD_ONLY);
 468         }
 469
 470 }
 471
 472 mb_internal_encoding('UTF-8');
 473
 474 $resource = ($argc > 1) ? $argv[1] : NULL;
 475
 476 $daemon = new XMPPDaemon($resource);
 477
 478 if ($daemon->connect()) {
 479         $daemon->set_status("Send me a message to post a notice");
 480         $daemon->handle();
 481 }
 482
 483 ?>