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