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