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