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