scripts/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', realpath(dirname(__FILE__) . '/..'));
  28 define('LACONICA', true);
  29
  30 require_once(INSTALLDIR . '/lib/common.php');
  31 require_once(INSTALLDIR . '/lib/jabber.php');
  32 require_once(INSTALLDIR . '/lib/daemon.php');
  33
  34 set_error_handler('common_error_handler');
  35
  36 # This is kind of clunky; we create a class to call the global functions
  37 # in jabber.php, which create a new XMPP class. A more elegant (?) solution
  38 # might be to use make this a subclass of XMPP.
  39
  40 class XMPPDaemon extends Daemon {
  41
  42         function XMPPDaemon($resource=NULL) {
  43                 static $attrs = array('server', 'port', 'user', 'password', 'host');
  44
  45                 foreach ($attrs as $attr)
  46                 {
  47                         $this->$attr = common_config('xmpp', $attr);
  48                 }
  49
  50                 if ($resource) {
  51                         $this->resource = $resource;
  52                 } else {
  53                         $this->resource = common_config('xmpp', 'resource') . 'daemon';
  54                 }
  55
  56                 $this->log(LOG_INFO, "INITIALIZE XMPPDaemon {$this->user}@{$this->server}/{$this->resource}");
  57         }
  58
  59         function connect() {
  60
  61                 $connect_to = ($this->host) ? $this->host : $this->server;
  62
  63                 $this->log(LOG_INFO, "Connecting to $connect_to on port $this->port");
  64
  65                 $this->conn = jabber_connect($this->resource);
  66
  67                 if (!$this->conn) {
  68                         return false;
  69                 }
  70
  71                 $this->conn->setReconnectTimeout(600);
  72
  73                 jabber_send_presence("Send me a message to post a notice", 'available',
  74                                                          NULL, 'available', 100);
  75                 return !$this->conn->isDisconnected();
  76         }
  77
  78         function name() {
  79                 return strtolower('xmppdaemon.'.$this->resource);
  80         }
  81
  82         function run() {
  83                 if ($this->connect()) {
  84
  85                         $this->conn->addEventHandler('message', 'handle_message', $this);
  86                         $this->conn->addEventHandler('presence', 'handle_presence', $this);
  87                         $this->conn->addEventHandler('reconnect', 'handle_reconnect', $this);
  88
  89                         $this->conn->process();
  90                 }
  91         }
  92
  93         function handle_reconnect(&$pl) {
  94                 $this->conn->processUntil('session_start');
  95                 $this->conn->presence('Send me a message to post a notice', 'available', NULL, 'available', 100);
  96         }
  97
  98         function get_user($from) {
  99                 $user = User::staticGet('jabber', jabber_normalize_jid($from));
 100                 return $user;
 101         }
 102
 103         function handle_message(&$pl) {
 104                 if ($pl['type'] != 'chat') {
 105                         return;
 106                 }
 107                 if (mb_strlen($pl['body']) == 0) {
 108                         return;
 109                 }
 110
 111                 $from = jabber_normalize_jid($pl['from']);
 112
 113                 # Forwarded from another daemon (probably a broadcaster) for
 114                 # us to handle
 115
 116                 if ($this->is_self($from)) {
 117                         $from = $this->get_ofrom($pl);
 118                         if (is_null($from) || $this->is_self($from)) {
 119                                 return;
 120                         }
 121                 }
 122
 123                 $user = $this->get_user($from);
 124
 125                 if (!$user) {
 126                         $this->from_site($from, 'Unknown user; go to ' .
 127                                                          common_local_url('imsettings') .
 128                                                          ' to add your address to your account');
 129                         $this->log(LOG_WARNING, 'Message from unknown user ' . $from);
 130                         return;
 131                 }
 132                 if ($this->handle_command($user, $pl['body'])) {
 133                         return;
 134                 } else if ($this->is_autoreply($pl['body'])) {
 135                         $this->log(LOG_INFO, 'Ignoring auto reply from ' . $from);
 136                         return;
 137                 } else if ($this->is_otr($pl['body'])) {
 138                         $this->log(LOG_INFO, 'Ignoring OTR from ' . $from);
 139                         return;
 140                 } else {
 141                         $this->add_notice($user, $pl);
 142                 }
 143
 144                 $user->free();
 145                 unset($user);
 146         }
 147
 148         function is_self($from) {
 149                 return preg_match('/^'.strtolower(jabber_daemon_address()).'/', strtolower($from));
 150         }
 151
 152         function get_ofrom($pl) {
 153                 $xml = $pl['raw'];
 154                 $addresses = $xml->sub('addresses');
 155                 if (!$addresses) {
 156                         $this->log(LOG_WARNING, 'Forwarded message without addresses');
 157                         return NULL;
 158                 }
 159                 $address = $addresses->sub('address');
 160                 if (!$address) {
 161                         $this->log(LOG_WARNING, 'Forwarded message without address');
 162                         return NULL;
 163                 }
 164                 if (!array_key_exists('type', $address->attrs)) {
 165                         $this->log(LOG_WARNING, 'No type for forwarded message');
 166                         return NULL;
 167                 }
 168                 $type = $address->attrs['type'];
 169                 if ($type != 'ofrom') {
 170                         $this->log(LOG_WARNING, 'Type of forwarded message is not ofrom');
 171                         return NULL;
 172                 }
 173                 if (!array_key_exists('jid', $address->attrs)) {
 174                         $this->log(LOG_WARNING, 'No jid for forwarded message');
 175                         return NULL;
 176                 }
 177                 $jid = $address->attrs['jid'];
 178                 if (!$jid) {
 179                         $this->log(LOG_WARNING, 'Could not get jid from address');
 180                         return NULL;
 181                 }
 182                 $this->log(LOG_DEBUG, 'Got message forwarded from jid ' . $jid);
 183                 return $jid;
 184         }
 185
 186         function is_autoreply($txt) {
 187                 if (preg_match('/[\[\(]?[Aa]uto-?[Rr]eply[\]\)]/', $txt)) {
 188                         return true;
 189                 } else {
 190                         return false;
 191                 }
 192         }
 193
 194         function is_otr($txt) {
 195                 if (preg_match('/^\?OTR/', $txt)) {
 196                         return true;
 197                 } else {
 198                         return false;
 199                 }
 200         }
 201
 202         function from_site($address, $msg) {
 203                 $text = '['.common_config('site', 'name') . '] ' . $msg;
 204                 jabber_send_message($address, $text);
 205         }
 206
 207         function handle_command($user, $body) {
 208                 # XXX: localise
 209                 switch(trim($body)) {
 210                  case 'on':
 211                         $this->set_notify($user, true);
 212                         $this->from_site($user->jabber, 'notifications on');
 213                         return true;
 214                  case 'off':
 215                         $this->set_notify($user, false);
 216                         $this->from_site($user->jabber, 'notifications off');
 217                         return true;
 218                  default:
 219                         return false;
 220                 }
 221         }
 222
 223         function set_notify(&$user, $notify) {
 224                 $orig = clone($user);
 225                 $user->jabbernotify = $notify;
 226                 $result = $user->update($orig);
 227                 if (!$id) {
 228                         $last_error = &PEAR::getStaticProperty('DB_DataObject','lastError');
 229                         $this->log(LOG_ERR,
 230                                            'Could not set notify flag to ' . $notify .
 231                                            ' for user ' . common_log_objstring($user) .
 232                                            ': ' . $last_error->message);
 233                 } else {
 234                         $this->log(LOG_INFO,
 235                                            'User ' . $user->nickname . ' set notify flag to ' . $notify);
 236                 }
 237         }
 238
 239         function add_notice(&$user, &$pl) {
 240                 $notice = Notice::saveNew($user->id, trim(mb_substr($pl['body'], 0, 140)), 'xmpp');
 241                 if (is_string($notice)) {
 242                         $this->log(LOG_ERR, $notice);
 243                         return;
 244                 }
 245                 common_broadcast_notice($notice);
 246                 $this->log(LOG_INFO,
 247                                    'Added notice ' . $notice->id . ' from user ' . $user->nickname);
 248                 $notice->free();
 249                 unset($notice);
 250         }
 251
 252         function handle_presence(&$pl) {
 253                 $from = jabber_normalize_jid($pl['from']);
 254                 switch ($pl['type']) {
 255                  case 'subscribe':
 256                         # We let anyone subscribe
 257                         $this->subscribed($from);
 258                         $this->log(LOG_INFO,
 259                                            'Accepted subscription from ' . $from);
 260                         break;
 261                  case 'subscribed':
 262                  case 'unsubscribed':
 263                  case 'unsubscribe':
 264                         $this->log(LOG_INFO,
 265                                            'Ignoring  "' . $pl['type'] . '" from ' . $from);
 266                         break;
 267                  default:
 268                         if (!$pl['type']) {
 269                                 $user = User::staticGet('jabber', $from);
 270                                 if (!$user) {
 271                                         $this->log(LOG_WARNING, 'Presence from unknown user ' . $from);
 272                                         return;
 273                                 }
 274                                 if ($user->updatefrompresence) {
 275                                         $this->log(LOG_INFO, 'Updating ' . $user->nickname .
 276                                                            ' status from presence.');
 277                                         $this->add_notice($user, $pl);
 278                                 }
 279                                 $user->free();
 280                                 unset($user);
 281                         }
 282                         break;
 283                 }
 284         }
 285
 286         function log($level, $msg) {
 287                 common_log($level, 'XMPPDaemon('.$this->resource.'): '.$msg);
 288         }
 289
 290         function subscribed($to) {
 291                 jabber_special_presence('subscribed', $to);
 292         }
 293 }
 294
 295 ini_set("max_execution_time", "0");
 296 ini_set("max_input_time", "0");
 297 set_time_limit(0);
 298 mb_internal_encoding('UTF-8');
 299
 300 $resource = ($argc > 1) ? $argv[1] : (common_config('xmpp','resource') . '-listen');
 301
 302 $daemon = new XMPPDaemon($resource);
 303
 304 if ($daemon->connect()) {
 305         $daemon->set_status("Send me a message to post a notice");
 306         $daemon->handle();
 307 }