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, "{$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                 $user = $this->get_user($from);
  95
  96                 if (!$user) {
  97                         $this->from_site($from, 'Unknown user; go to ' .
  98                                                          common_local_url('imsettings') .
  99                                                          ' to add your address to your account');
 100                         $this->log(LOG_WARNING, 'Message from unknown user ' . $from);
 101                         return;
 102                 }
 103                 if ($this->handle_command($user, $pl['body'])) {
 104                         return;
 105                 } else if ($this->is_autoreply($pl['body'])) {
 106                         $this->log(LOG_INFO, 'Ignoring auto reply from ' . $from);
 107                         return;
 108                 } else if ($this->is_otr($pl['body'])) {
 109                         $this->log(LOG_INFO, 'Ignoring OTR from ' . $from);
 110                         return;
 111                 } else {
 112                         $len = mb_strlen($pl['body']);
 113                         if($len > 140) {
 114                                 $this->from_site($from, 'Message too long - maximum is 140 characters, you sent ' . $len);
 115                                 return;
 116                         }
 117                         $this->add_notice($user, $pl);
 118                 }
 119         }
 120
 121         function is_autoreply($txt) {
 122                 if (preg_match('/[\[\(]?[Aa]uto-?[Rr]eply[\]\)]/', $txt)) {
 123                         return true;
 124                 } else {
 125                         return false;
 126                 }
 127         }
 128
 129         function is_otr($txt) {
 130                 if (preg_match('/^\?OTR/', $txt)) {
 131                         return true;
 132                 } else {
 133                         return false;
 134                 }
 135         }
 136
 137         function from_site($address, $msg) {
 138                 $text = '['.common_config('site', 'name') . '] ' . $msg;
 139                 jabber_send_message($address, $text);
 140         }
 141
 142         function handle_command($user, $body) {
 143                 # XXX: localise
 144                 $p=explode(' ',$body);
 145                 if(count($p)>2)
 146                         return false;
 147                 switch($p[0]) {
 148                  case 'help':
 149                         if(count($p)!=1)
 150                                 return false;
 151                         $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");
 152                         return true;
 153                  case 'on':
 154                         if(count($p)!=1)
 155                                 return false;
 156                         $this->set_notify($user, true);
 157                         $this->from_site($user->jabber, 'notifications on');
 158                         return true;
 159                  case 'off':
 160                         if(count($p)!=1)
 161                                 return false;
 162                         $this->set_notify($user, false);
 163                         $this->from_site($user->jabber, 'notifications off');
 164                         return true;
 165                  case 'sub':
 166                         if(count($p)==1) {
 167                                 $this->from_site($user->jabber, 'Specify the name of the user to subscribe to');
 168                                 return true;
 169                         }
 170                         $result=subs_subscribe_user($user, $p[1]);
 171                         if($result=='true')
 172                                 $this->from_site($user->jabber, 'Subscribed to ' . $p[1]);
 173                         else
 174                                 $this->from_site($user->jabber, $result);
 175                         return true;
 176                  case 'unsub':
 177                         if(count($p)==1) {
 178                                 $this->from_site($user->jabber, 'Specify the name of the user to unsubscribe from');
 179                                 return true;
 180                         }
 181                         $result=subs_unsubscribe_user($user, $p[1]);
 182                         if($result=='true')
 183                                 $this->from_site($user->jabber, 'Unsubscribed from ' . $p[1]);
 184                         else
 185                                 $this->from_site($user->jabber, $result);
 186                         return true;
 187                  default:
 188                         return false;
 189                 }
 190         }
 191
 192         function set_notify(&$user, $notify) {
 193                 $orig = clone($user);
 194                 $user->jabbernotify = $notify;
 195                 $result = $user->update($orig);
 196                 if (!$result) {
 197                         $last_error = &PEAR::getStaticProperty('DB_DataObject','lastError');
 198                         $this->log(LOG_ERR,
 199                                            'Could not set notify flag to ' . $notify .
 200                                            ' for user ' . common_log_objstring($user) .
 201                                            ': ' . $last_error->message);
 202                 } else {
 203                         $this->log(LOG_INFO,
 204                                            'User ' . $user->nickname . ' set notify flag to ' . $notify);
 205                 }
 206         }
 207
 208         function add_notice(&$user, &$pl) {
 209                 $notice = Notice::saveNew($user->id, trim(mb_substr($pl['body'], 0, 140)), 'xmpp');
 210                 if (is_string($notice)) {
 211                         $this->log(LOG_ERR, $notice);
 212                         return;
 213                 }
 214                 common_broadcast_notice($notice);
 215                 $this->log(LOG_INFO,
 216                                    'Added notice ' . $notice->id . ' from user ' . $user->nickname);
 217         }
 218
 219         function handle_presence(&$pl) {
 220                 $from = jabber_normalize_jid($pl['from']);
 221                 switch ($pl['type']) {
 222                  case 'subscribe':
 223                         # We let anyone subscribe
 224                         $this->subscribed($from);
 225                         $this->log(LOG_INFO,
 226                                            'Accepted subscription from ' . $from);
 227                         break;
 228                  case 'subscribed':
 229                  case 'unsubscribed':
 230                  case 'unsubscribe':
 231                         $this->log(LOG_INFO,
 232                                            'Ignoring  "' . $pl['type'] . '" from ' . $from);
 233                         break;
 234                  default:
 235                         if (!$pl['type']) {
 236                                 $user = User::staticGet('jabber', $from);
 237                                 if (!$user) {
 238                                         $this->log(LOG_WARNING, 'Presence from unknown user ' . $from);
 239                                         return;
 240                                 }
 241                                 if ($user->updatefrompresence) {
 242                                         $this->log(LOG_INFO, 'Updating ' . $user->nickname .
 243                                                            ' status from presence.');
 244                                         $this->add_notice($user, $pl);
 245                                 }
 246                         }
 247                         break;
 248                 }
 249         }
 250
 251         function log($level, $msg) {
 252                 common_log($level, 'XMPPDaemon('.$this->resource.'): '.$msg);
 253         }
 254
 255         function subscribed($to) {
 256                 jabber_special_presence('subscribed', $to);
 257         }
 258 }
 259
 260 mb_internal_encoding('UTF-8');
 261
 262 $resource = ($argc > 1) ? $argv[1] : (common_config('xmpp','resource') . '-listen');
 263
 264 $daemon = new XMPPDaemon($resource);
 265
 266 if ($daemon->connect()) {
 267         $daemon->handle();
 268 }
 269
 270 ?>