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->disconnected;
  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                 }
  97         }
  98
  99         function get_user($from) {
 100                 $user = User::staticGet('jabber', jabber_normalize_jid($from));
 101                 return $user;
 102         }
 103
 104         function get_confirmation($from) {
 105                 $confirm = new Confirm_address();
 106                 $confirm->address = $from;
 107                 $confirm->address_type = 'jabber';
 108                 if ($confirm->find(TRUE)) {
 109                         return $confirm;
 110                 } else {
 111                         return NULL;
 112                 }
 113         }
 114
 115         function handle_message(&$pl) {
 116                 if ($pl['type'] != 'chat') {
 117                         return;
 118                 }
 119                 if (strlen($pl['body']) == 0) {
 120                         return;
 121                 }
 122
 123                 $from = jabber_normalize_jid($pl['from']);
 124                 $user = $this->get_user($from);
 125
 126                 if (!$user) {
 127                         $this->from_site($from, 'Unknown user; go to ' .
 128                                                          common_local_url('imsettings') .
 129                                                          ' to add your address to your account');
 130                         $this->log(LOG_WARNING, 'Message from unknown user ' . $from);
 131                         return;
 132                 }
 133                 if ($this->handle_command($user, $pl['body'])) {
 134                         return;
 135                 } else {
 136                         $this->add_notice($user, $pl);
 137                 }
 138         }
 139
 140         function from_site($address, $msg) {
 141                 $text = '['.common_config('site', 'name') . '] ' . $msg;
 142                 jabber_send_message($address, $text);
 143         }
 144
 145         function handle_command($user, $body) {
 146                 # XXX: localise
 147                 switch(trim($body)) {
 148                  case 'on':
 149                         $this->set_notify($user, true);
 150                         $this->from_site($user->jabber, 'notifications on');
 151                         return true;
 152                  case 'off':
 153                         $this->set_notify($user, false);
 154                         $this->from_site($user->jabber, 'notifications off');
 155                         return true;
 156                  default:
 157                         return false;
 158                 }
 159         }
 160
 161         function set_notify(&$user, $notify) {
 162                 $orig = clone($user);
 163                 $user->jabbernotify = $notify;
 164                 $result = $user->update($orig);
 165                 if (!$id) {
 166                         $last_error = &PEAR::getStaticProperty('DB_DataObject','lastError');
 167                         $this->log(LOG_ERROR,
 168                                            'Could not set notify flag to ' . $notify .
 169                                            ' for user ' . common_log_objstring($user) .
 170                                            ': ' . $last_error->message);
 171                 } else {
 172                         $this->log(LOG_INFO,
 173                                            'User ' . $user->nickname . ' set notify flag to ' . $notify);
 174                 }
 175         }
 176
 177         function add_notice(&$user, &$pl) {
 178                 $notice = new Notice();
 179                 $notice->profile_id = $user->id;
 180                 $notice->content = trim(substr($pl['body'], 0, 140));
 181                 $notice->created = DB_DataObject_Cast::dateTime();
 182                 $notice->query('BEGIN');
 183                 $id = $notice->insert();
 184                 if (!$id) {
 185                         $last_error = &PEAR::getStaticProperty('DB_DataObject','lastError');
 186                         $this->log(LOG_ERROR,
 187                                            'Could not insert ' . common_log_objstring($notice) .
 188                                            ' for user ' . common_log_objstring($user) .
 189                                            ': ' . $last_error->message);
 190                         return;
 191                 }
 192                 $orig = clone($notice);
 193                 $notice->uri = common_notice_uri($notice);
 194                 $result = $notice->update($orig);
 195                 if (!$result) {
 196                         $last_error = &PEAR::getStaticProperty('DB_DataObject','lastError');
 197                         $this->log(LOG_ERROR,
 198                                            'Could not add URI to ' . common_log_objstring($notice) .
 199                                            ' for user ' . common_log_objstring($user) .
 200                                            ': ' . $last_error->message);
 201                         return;
 202                 }
 203                 $notice->query('COMMIT');
 204                 common_broadcast_notice($notice);
 205                 $this->log(LOG_INFO,
 206                                    'Added notice ' . $notice->id . ' from user ' . $user->nickname);
 207         }
 208
 209         function handle_presence(&$pl) {
 210                 $from = jabber_normalize_jid($pl['from']);
 211                 switch ($pl['type']) {
 212                  case 'subscribe':
 213                         # We let anyone subscribe
 214                         $this->subscribed($from);
 215                         $this->log(LOG_INFO,
 216                                            'Accepted subscription from ' . $from);
 217                         break;
 218                  case 'subscribed':
 219                  case 'unsubscribed':
 220                  case 'unsubscribe':
 221                         $this->log(LOG_INFO,
 222                                            'Ignoring  "' . $pl['type'] . '" from ' . $from);
 223                         break;
 224                  default:
 225                         if (!$pl['type']) {
 226                                 $user = User::staticGet('jabber', $from);
 227                                 if (!$user) {
 228                                         $this->log(LOG_WARNING, 'Message from unknown user ' . $from);
 229                                         return;
 230                                 }
 231                                 if ($user->updatefrompresence) {
 232                                         $this->log(LOG_INFO, 'Updating ' . $user->nickname .
 233                                                            ' status from presence.');
 234                                         $this->add_notice($user, $pl);
 235                                 }
 236                         }
 237                         break;
 238                 }
 239         }
 240
 241         function log($level, $msg) {
 242                 common_log($level, 'XMPPDaemon('.$this->resource.'): '.$msg);
 243         }
 244
 245         function subscribed($to) {
 246                 jabber_special_presence('subscribed', $to);
 247         }
 248
 249         function set_status($status) {
 250                 $this->log(LOG_INFO, 'Setting status to "' . $status . '"');
 251                 jabber_send_presence($status);
 252         }
 253
 254         function top_queue_item() {
 255
 256                 $qi = new Queue_item();
 257                 $qi->orderBy('created');
 258                 $qi->whereAdd('claimed is NULL');
 259
 260                 $qi->limit(1);
 261
 262                 $cnt = $qi->find(TRUE);
 263
 264                 if ($cnt) {
 265                         # XXX: potential race condition
 266                         # can we force it to only update if claimed is still NULL
 267                         # (or old)?
 268                         $this->log(LOG_INFO, 'claiming queue item = ' . $qi->notice_id);
 269                         $orig = clone($qi);
 270                         $qi->claimed = DB_DataObject_Cast::dateTime();
 271                         $result = $qi->update($orig);
 272                         if ($result) {
 273                                 $this->log(LOG_INFO, 'claim succeeded.');
 274                                 return $qi;
 275                         } else {
 276                                 $this->log(LOG_INFO, 'claim failed.');
 277                         }
 278                 }
 279                 $qi = NULL;
 280                 return NULL;
 281         }
 282
 283         function broadcast_queue() {
 284                 $this->clear_old_claims();
 285                 $this->log(LOG_INFO, 'checking for queued notices');
 286                 do {
 287                         $qi = $this->top_queue_item();
 288                         if ($qi) {
 289                                 $this->log(LOG_INFO, 'Got queue item #'.$in_a_row.' enqueued '.common_exact_date($qi->created));
 290                                 $notice = Notice::staticGet($qi->notice_id);
 291                                 if ($notice) {
 292                                         $this->log(LOG_INFO, 'broadcasting notice ID = ' . $notice->id);
 293                                         # XXX: what to do if broadcast fails?
 294                                         $result = common_real_broadcast($notice, $this->is_remote($notice));
 295                                         if (!$result) {
 296                                                 $this->log(LOG_WARNING, 'Failed broadcast for notice ID = ' . $notice->id);
 297                                                 $orig = $qi;
 298                                                 $qi->claimed = NULL;
 299                                                 $qi->update($orig);
 300                                                 $this->log(LOG_WARNING, 'Abandoned claim for notice ID = ' . $notice->id);
 301                                                 continue;
 302                                         }
 303                                         $this->log(LOG_INFO, 'finished broadcasting notice ID = ' . $notice->id);
 304                                         $notice = NULL;
 305                                 } else {
 306                                         $this->log(LOG_WARNING, 'queue item for notice that does not exist');
 307                                 }
 308                                 $qi->delete();
 309                         }
 310                 } while ($qi);
 311         }
 312
 313         function clear_old_claims() {
 314                 $qi = new Queue_item();
 315                 $qi->claimed = NULL;
 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
 326 $resource = ($argc > 1) ? $argv[1] : NULL;
 327
 328 $daemon = new XMPPDaemon($resource);
 329
 330 if ($daemon->connect()) {
 331         $daemon->set_status("Send me a message to post a notice");
 332         $daemon->handle();
 333 }
 334
 335 ?>