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