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