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