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