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                 switch(trim($body)) {
 212                  case 'on':
 213                         $this->set_notify($user, true);
 214                         $this->from_site($user->jabber, 'notifications on');
 215                         return true;
 216                  case 'off':
 217                         $this->set_notify($user, false);
 218                         $this->from_site($user->jabber, 'notifications off');
 219                         return true;
 220                  default:
 221                         return false;
 222                 }
 223         }
 224
 225         function set_notify(&$user, $notify) {
 226                 $orig = clone($user);
 227                 $user->jabbernotify = $notify;
 228                 $result = $user->update($orig);
 229                 if (!$result) {
 230                         $last_error = &PEAR::getStaticProperty('DB_DataObject','lastError');
 231                         $this->log(LOG_ERR,
 232                                            'Could not set notify flag to ' . $notify .
 233                                            ' for user ' . common_log_objstring($user) .
 234                                            ': ' . $last_error->message);
 235                 } else {
 236                         $this->log(LOG_INFO,
 237                                            'User ' . $user->nickname . ' set notify flag to ' . $notify);
 238                 }
 239         }
 240
 241         function add_notice(&$user, &$pl) {
 242                 $notice = Notice::saveNew($user->id, trim(mb_substr($pl['body'], 0, 140)), 'xmpp');
 243                 if (is_string($notice)) {
 244                         $this->log(LOG_ERR, $notice);
 245                         return;
 246                 }
 247                 common_real_broadcast($notice);
 248                 $this->log(LOG_INFO,
 249                                    'Added notice ' . $notice->id . ' from user ' . $user->nickname);
 250         }
 251
 252         function handle_presence(&$pl) {
 253                 $from = jabber_normalize_jid($pl['from']);
 254                 switch ($pl['type']) {
 255                  case 'subscribe':
 256                         # We let anyone subscribe
 257                         $this->subscribed($from);
 258                         $this->log(LOG_INFO,
 259                                            'Accepted subscription from ' . $from);
 260                         break;
 261                  case 'subscribed':
 262                  case 'unsubscribed':
 263                  case 'unsubscribe':
 264                         $this->log(LOG_INFO,
 265                                            'Ignoring  "' . $pl['type'] . '" from ' . $from);
 266                         break;
 267                  default:
 268                         if (!$pl['type']) {
 269                                 $user = User::staticGet('jabber', $from);
 270                                 if (!$user) {
 271                                         $this->log(LOG_WARNING, 'Presence from unknown user ' . $from);
 272                                         return;
 273                                 }
 274                                 if ($user->updatefrompresence) {
 275                                         $this->log(LOG_INFO, 'Updating ' . $user->nickname .
 276                                                            ' status from presence.');
 277                                         $this->add_notice($user, $pl);
 278                                 }
 279                         }
 280                         break;
 281                 }
 282         }
 283
 284         function log($level, $msg) {
 285                 common_log($level, 'XMPPDaemon('.$this->resource.'): '.$msg);
 286         }
 287
 288         function subscribed($to) {
 289                 jabber_special_presence('subscribed', $to);
 290         }
 291
 292         function set_status($status) {
 293                 $this->log(LOG_INFO, 'Setting status to "' . $status . '"');
 294                 jabber_send_presence($status);
 295         }
 296
 297         function top_queue_item() {
 298
 299                 $qi = new Queue_item();
 300                 $qi->orderBy('created');
 301                 $qi->whereAdd('claimed is NULL');
 302
 303                 $qi->limit(1);
 304
 305                 $cnt = $qi->find(TRUE);
 306
 307                 if ($cnt) {
 308                         # XXX: potential race condition
 309                         # can we force it to only update if claimed is still NULL
 310                         # (or old)?
 311                         $this->log(LOG_INFO, 'claiming queue item = ' . $qi->notice_id);
 312                         $orig = clone($qi);
 313                         $qi->claimed = DB_DataObject_Cast::dateTime();
 314                         $result = $qi->update($orig);
 315                         if ($result) {
 316                                 $this->log(LOG_INFO, 'claim succeeded.');
 317                                 return $qi;
 318                         } else {
 319                                 $this->log(LOG_INFO, 'claim failed.');
 320                         }
 321                 }
 322                 $qi = NULL;
 323                 return NULL;
 324         }
 325
 326         function broadcast_queue() {
 327                 $this->clear_old_claims();
 328                 $this->log(LOG_INFO, 'checking for queued notices');
 329                 do {
 330                         $qi = $this->top_queue_item();
 331                         if ($qi) {
 332                                 $this->log(LOG_INFO, 'Got item enqueued '.common_exact_date($qi->created));
 333                                 $notice = Notice::staticGet($qi->notice_id);
 334                                 if ($notice) {
 335                                         $this->log(LOG_INFO, 'broadcasting notice ID = ' . $notice->id);
 336                                         # XXX: what to do if broadcast fails?
 337                                         $result = common_real_broadcast($notice, $this->is_remote($notice));
 338                                         if (!$result) {
 339                                                 $this->log(LOG_WARNING, 'Failed broadcast for notice ID = ' . $notice->id);
 340                                                 $orig = $qi;
 341                                                 $qi->claimed = NULL;
 342                                                 $qi->update($orig);
 343                                                 $this->log(LOG_WARNING, 'Abandoned claim for notice ID = ' . $notice->id);
 344                                                 continue;
 345                                         }
 346                                         $this->log(LOG_INFO, 'finished broadcasting notice ID = ' . $notice->id);
 347                                         $notice = NULL;
 348                                 } else {
 349                                         $this->log(LOG_WARNING, 'queue item for notice that does not exist');
 350                                 }
 351                                 $qi->delete();
 352                         }
 353                 } while ($qi);
 354         }
 355
 356         function clear_old_claims() {
 357                 $qi = new Queue_item();
 358                 $qi->claimed = NULL;
 359                 $qi->whereAdd('now() - claimed > '.CLAIM_TIMEOUT);
 360                 $qi->update(DB_DATAOBJECT_WHEREADD_ONLY);
 361         }
 362
 363         function is_remote($notice) {
 364                 $user = User::staticGet($notice->profile_id);
 365                 return !$user;
 366         }
 367
 368         function confirmation_queue() {
 369             # $this->clear_old_confirm_claims();
 370                 $this->log(LOG_INFO, 'checking for queued confirmations');
 371                 do {
 372                         $confirm = $this->next_confirm();
 373                         if ($confirm) {
 374                                 $this->log(LOG_INFO, 'Sending confirmation for ' . $confirm->address);
 375                                 $user = User::staticGet($confirm->user_id);
 376                                 if (!$user) {
 377                                         $this->log(LOG_WARNING, 'Confirmation for unknown user ' . $confirm->user_id);
 378                                         continue;
 379                                 }
 380                                 $success = jabber_confirm_address($confirm->code,
 381                                                                   $user->nickname,
 382                                                                   $confirm->address);
 383                                 if (!$success) {
 384                                         $this->log(LOG_ERR, 'Confirmation failed for ' . $confirm->address);
 385                                         # Just let the claim age out; hopefully things work then
 386                                         continue;
 387                                 } else {
 388                                         $this->log(LOG_INFO, 'Confirmation sent for ' . $confirm->address);
 389                                         # Mark confirmation sent
 390                                         $original = clone($confirm);
 391                                         $confirm->sent = $confirm->claimed;
 392                                         $result = $confirm->update($original);
 393                                         if (!$result) {
 394                                                 $this->log(LOG_ERR, 'Cannot mark sent for ' . $confirm->address);
 395                                                 # Just let the claim age out; hopefully things work then
 396                                                 continue;
 397                                         }
 398                                 }
 399                         }
 400                 } while ($confirm);
 401         }
 402
 403         function next_confirm() {
 404                 $confirm = new Confirm_address();
 405                 $confirm->whereAdd('claimed IS NULL');
 406                 $confirm->whereAdd('sent IS NULL');
 407                 # XXX: eventually we could do other confirmations in the queue, too
 408                 $confirm->address_type = 'jabber';
 409                 $confirm->orderBy('modified DESC');
 410                 $confirm->limit(1);
 411                 if ($confirm->find(TRUE)) {
 412                         $this->log(LOG_INFO, 'Claiming confirmation for ' . $confirm->address);
 413                         # working around some weird DB_DataObject behaviour
 414                         $confirm->whereAdd(''); # clears where stuff
 415                         $original = clone($confirm);
 416                         $confirm->claimed = DB_DataObject_Cast::dateTime();
 417                         $result = $confirm->update($original);
 418                         if ($result) {
 419                                 $this->log(LOG_INFO, 'Succeeded in claim! '. $result);
 420                                 return $confirm;
 421                         } else {
 422                                 $this->log(LOG_INFO, 'Failed in claim!');
 423                                 return false;
 424                         }
 425                 }
 426                 return NULL;
 427         }
 428
 429         function clear_old_confirm_claims() {
 430                 $confirm = new Confirm();
 431                 $confirm->claimed = NULL;
 432                 $confirm->whereAdd('now() - claimed > '.CLAIM_TIMEOUT);
 433                 $confirm->update(DB_DATAOBJECT_WHEREADD_ONLY);
 434         }
 435
 436 }
 437
 438 mb_internal_encoding('UTF-8');
 439
 440 $resource = ($argc > 1) ? $argv[1] : NULL;
 441
 442 $daemon = new XMPPDaemon($resource);
 443
 444 if ($daemon->connect()) {
 445         $daemon->set_status("Send me a message to post a notice");
 446         $daemon->handle();
 447 }
 448
 449 ?>