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                 while(!$this->conn->disconnected) {
  71                         $payloads = $this->conn->processUntil(array('message', 'presence',
  72                                                                                                                 'end_stream', 'session_start'));
  73                         foreach($payloads as $event) {
  74                                 $pl = $event[1];
  75                                 $this->log(LOG_DEBUG, "Received '$event[0]': " . print_r($pl, TRUE));
  76                                 switch($event[0]) {
  77                                  case 'message':
  78                                         $this->handle_message($pl);
  79                                         break;
  80                                  case 'presence':
  81                                         $this->handle_presence($pl);
  82                                         break;
  83                                  case 'session_start':
  84                                         $this->handle_session($pl);
  85                                         break;
  86                                 }
  87                         }
  88                 }
  89         }
  90
  91         function get_user($from) {
  92                 $user = User::staticGet('jabber', jabber_normalize_jid($from));
  93                 return $user;
  94         }
  95
  96         function get_confirmation($from) {
  97                 $confirm = new Confirm_address();
  98                 $confirm->address = $from;
  99                 $confirm->address_type = 'jabber';
 100                 if ($confirm->find(TRUE)) {
 101                         return $confirm;
 102                 } else {
 103                         return NULL;
 104                 }
 105         }
 106
 107         function handle_message(&$pl) {
 108                 if ($pl['type'] != 'chat') {
 109                         return;
 110                 }
 111                 if (strlen($pl['body']) == 0) {
 112                         return;
 113                 }
 114
 115                 $from = jabber_normalize_jid($pl['from']);
 116                 $user = $this->get_user($from);
 117
 118                 if (!$user) {
 119                         $this->from_site($from, 'Unknown user; go to ' .
 120                                                          common_local_url('imsettings') .
 121                                                          ' to add your address to your account');
 122                         $this->log(LOG_WARNING, 'Message from unknown user ' . $from);
 123                         return;
 124                 }
 125                 if ($this->handle_command($user, $pl['body'])) {
 126                         return;
 127                 } else {
 128                         $this->add_notice($user, $pl);
 129                 }
 130         }
 131
 132         function from_site($address, $msg) {
 133                 $text = '['.common_config('site', 'name') . '] ' . $msg;
 134                 jabber_send_message($address, $text);
 135         }
 136
 137         function handle_command($user, $body) {
 138                 # XXX: localise
 139                 switch(trim($body)) {
 140                  case 'on':
 141                         $this->set_notify($user, true);
 142                         $this->from_site($user->jabber, 'notifications on');
 143                         return true;
 144                  case 'off':
 145                         $this->set_notify($user, false);
 146                         $this->from_site($user->jabber, 'notifications off');
 147                         return true;
 148                  default:
 149                         return false;
 150                 }
 151         }
 152
 153         function set_notify(&$user, $notify) {
 154                 $orig = clone($user);
 155                 $user->jabbernotify = $notify;
 156                 $result = $user->update($orig);
 157                 if (!$id) {
 158                         $last_error = &PEAR::getStaticProperty('DB_DataObject','lastError');
 159                         $this->log(LOG_ERROR,
 160                                            'Could not set notify flag to ' . $notify .
 161                                            ' for user ' . common_log_objstring($user) .
 162                                            ': ' . $last_error->message);
 163                 } else {
 164                         $this->log(LOG_INFO,
 165                                            'User ' . $user->nickname . ' set notify flag to ' . $notify);
 166                 }
 167         }
 168
 169         function add_notice(&$user, &$pl) {
 170                 $notice = new Notice();
 171                 $notice->profile_id = $user->id;
 172                 $notice->content = trim(substr($pl['body'], 0, 140));
 173                 $notice->created = DB_DataObject_Cast::dateTime();
 174                 $notice->query('BEGIN');
 175                 $id = $notice->insert();
 176                 if (!$id) {
 177                         $last_error = &PEAR::getStaticProperty('DB_DataObject','lastError');
 178                         $this->log(LOG_ERROR,
 179                                            'Could not insert ' . common_log_objstring($notice) .
 180                                            ' for user ' . common_log_objstring($user) .
 181                                            ': ' . $last_error->message);
 182                         return;
 183                 }
 184                 $orig = clone($notice);
 185                 $notice->uri = common_notice_uri($notice);
 186                 $result = $notice->update($orig);
 187                 if (!$result) {
 188                         $last_error = &PEAR::getStaticProperty('DB_DataObject','lastError');
 189                         $this->log(LOG_ERROR,
 190                                            'Could not add URI to ' . common_log_objstring($notice) .
 191                                            ' for user ' . common_log_objstring($user) .
 192                                            ': ' . $last_error->message);
 193                         return;
 194                 }
 195                 $notice->query('COMMIT');
 196                 common_broadcast_notice($notice);
 197                 $this->log(LOG_INFO,
 198                                    'Added notice ' . $notice->id . ' from user ' . $user->nickname);
 199         }
 200
 201         function handle_presence(&$pl) {
 202                 $from = jabber_normalize_jid($pl['from']);
 203                 switch ($pl['type']) {
 204                         case 'subscribe':
 205                             # We let anyone subscribe
 206                                 $this->subscribed($from);
 207                                 $this->log(LOG_INFO,
 208                                    'Accepted subscription from ' . $from);
 209                                 break;
 210                         case 'subscribed':
 211                         case 'unsubscribed':
 212                         case 'unsubscribe':
 213                                 $this->log(LOG_INFO,
 214                                    'Ignoring  "' . $pl['type'] . '" from ' . $from);
 215                                 break;
 216                         default:
 217                                 if (!$pl['type']) {
 218                                         $user = User::staticGet('jabber', $from);
 219                                         if (!$user) {
 220                                                 $this->log(LOG_WARNING, 'Message from unknown user ' . $from);
 221                                                 return;
 222                                         }
 223                                         if ($user->updatefrompresence) {
 224                                                 $this->log(LOG_INFO, 'Updating ' . $user->nickname .
 225                                                                                          ' status from presence.');
 226                                                 $this->add_notice($user, $pl);
 227                                         }
 228                                 }
 229                                 break;
 230                 }
 231         }
 232
 233         function log($level, $msg) {
 234                 common_log($level, 'XMPPDaemon('.$this->resource.'): '.$msg);
 235         }
 236
 237         function subscribed($to) {
 238                 jabber_special_presence('subscribed', $to);
 239         }
 240
 241         function set_status($status) {
 242                 $this->log(LOG_INFO, 'Setting status to "' . $status . '"');
 243                 jabber_send_presence($status);
 244         }
 245 }
 246
 247 $resource = ($argc > 1) ? $argv[1] : NULL;
 248
 249 $daemon = new XMPPDaemon($resource);
 250
 251 if ($daemon->connect()) {
 252         $daemon->set_status("Send me a message to post a notice");
 253         $daemon->handle();
 254 }
 255
 256 ?>