4 * Laconica - a distributed open-source microblogging tool
5 * Copyright (C) 2008, 2009, Control Yourself, Inc.
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.
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.
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/>.
21 define('INSTALLDIR', realpath(dirname(__FILE__) . '/..'));
23 $shortoptions = 'fi::';
24 $longoptions = array('id::', 'foreground');
26 $helptext = <<<END_OF_XMPP_HELP
27 Daemon script for receiving new notices from Jabber users.
29 -i --id Identity (default none)
30 -f --foreground Stay in the foreground (default background)
34 require_once INSTALLDIR.'/scripts/commandline.inc';
36 require_once INSTALLDIR . '/lib/common.php';
37 require_once INSTALLDIR . '/lib/jabber.php';
38 require_once INSTALLDIR . '/lib/daemon.php';
40 # This is kind of clunky; we create a class to call the global functions
41 # in jabber.php, which create a new XMPP class. A more elegant (?) solution
42 # might be to use make this a subclass of XMPP.
44 class XMPPDaemon extends Daemon
46 function __construct($resource=null, $daemonize=true)
48 parent::__construct($daemonize);
50 static $attrs = array('server', 'port', 'user', 'password', 'host');
52 foreach ($attrs as $attr)
54 $this->$attr = common_config('xmpp', $attr);
58 $this->resource = $resource . 'daemon';
60 $this->resource = common_config('xmpp', 'resource') . 'daemon';
63 $this->jid = $this->user.'@'.$this->server.'/'.$this->resource;
65 $this->log(LOG_INFO, "INITIALIZE XMPPDaemon {$this->jid}");
70 $connect_to = ($this->host) ? $this->host : $this->server;
72 $this->log(LOG_INFO, "Connecting to $connect_to on port $this->port");
74 $this->conn = jabber_connect($this->resource);
80 $this->log(LOG_INFO, "Connected");
82 $this->conn->setReconnectTimeout(600);
84 $this->log(LOG_INFO, "Sending initial presence.");
86 jabber_send_presence("Send me a message to post a notice", 'available',
87 null, 'available', 100);
89 $this->log(LOG_INFO, "Done connecting.");
91 return !$this->conn->isDisconnected();
96 return strtolower('xmppdaemon.'.$this->resource);
101 if ($this->connect()) {
103 $this->log(LOG_DEBUG, "Initializing stanza handlers.");
105 $this->conn->addEventHandler('message', 'handle_message', $this);
106 $this->conn->addEventHandler('presence', 'handle_presence', $this);
107 $this->conn->addEventHandler('reconnect', 'handle_reconnect', $this);
109 $this->log(LOG_DEBUG, "Beginning processing loop.");
111 while ($this->conn->processTime(60)) {
119 if (!isset($this->pingid)) {
125 $this->log(LOG_DEBUG, "Sending ping #{$this->pingid}");
127 $this->conn->send("<iq from='{$this->jid}' to='{$this->server}' id='ping_{$this->pingid}' type='get'><ping xmlns='urn:xmpp:ping'/></iq>");
130 function handle_reconnect(&$pl)
132 $this->log(LOG_DEBUG, "Got reconnection callback.");
133 $this->conn->processUntil('session_start');
134 $this->log(LOG_DEBUG, "Sending reconnection presence.");
135 $this->conn->presence('Send me a message to post a notice', 'available', null, 'available', 100);
143 function get_user($from)
145 $user = User::staticGet('jabber', jabber_normalize_jid($from));
149 function handle_message(&$pl)
151 $from = jabber_normalize_jid($pl['from']);
153 if ($pl['type'] != 'chat') {
154 $this->log(LOG_WARNING, "Ignoring message of type ".$pl['type']." from $from.");
158 if (mb_strlen($pl['body']) == 0) {
159 $this->log(LOG_WARNING, "Ignoring message with empty body from $from.");
163 # Forwarded from another daemon (probably a broadcaster) for
166 if ($this->is_self($from)) {
167 $this->log(LOG_INFO, "Got forwarded notice from self ($from).");
168 $from = $this->get_ofrom($pl);
169 $this->log(LOG_INFO, "Originally sent by $from.");
170 if (is_null($from) || $this->is_self($from)) {
171 $this->log(LOG_INFO, "Ignoring notice originally sent by $from.");
176 $user = $this->get_user($from);
179 $this->from_site($from, 'Unknown user; go to ' .
180 common_local_url('imsettings') .
181 ' to add your address to your account');
182 $this->log(LOG_WARNING, 'Message from unknown user ' . $from);
185 if ($this->handle_command($user, $pl['body'])) {
186 $this->log(LOG_INFO, "Command messag by $from handled.");
188 } else if ($this->is_autoreply($pl['body'])) {
189 $this->log(LOG_INFO, 'Ignoring auto reply from ' . $from);
191 } else if ($this->is_otr($pl['body'])) {
192 $this->log(LOG_INFO, 'Ignoring OTR from ' . $from);
194 } else if ($this->is_direct($pl['body'])) {
195 $this->log(LOG_INFO, 'Got a direct message ' . $from);
197 preg_match_all('/d[\ ]*([a-z0-9]{1,64})/', $pl['body'], $to);
199 $to = preg_replace('/^d([\ ])*/', '', $to[0][0]);
200 $body = preg_replace('/d[\ ]*('. $to .')[\ ]*/', '', $pl['body']);
202 $this->log(LOG_INFO, 'Direct message from '. $user->nickname . ' to ' . $to);
204 $this->add_direct($user, $body, $to, $from);
207 $this->log(LOG_INFO, 'Posting a notice from ' . $user->nickname);
209 $this->add_notice($user, $pl);
222 function is_self($from)
224 return preg_match('/^'.strtolower(jabber_daemon_address()).'/', strtolower($from));
227 function get_ofrom($pl)
230 $addresses = $xml->sub('addresses');
232 $this->log(LOG_WARNING, 'Forwarded message without addresses');
235 $address = $addresses->sub('address');
237 $this->log(LOG_WARNING, 'Forwarded message without address');
240 if (!array_key_exists('type', $address->attrs)) {
241 $this->log(LOG_WARNING, 'No type for forwarded message');
244 $type = $address->attrs['type'];
245 if ($type != 'ofrom') {
246 $this->log(LOG_WARNING, 'Type of forwarded message is not ofrom');
249 if (!array_key_exists('jid', $address->attrs)) {
250 $this->log(LOG_WARNING, 'No jid for forwarded message');
253 $jid = $address->attrs['jid'];
255 $this->log(LOG_WARNING, 'Could not get jid from address');
258 $this->log(LOG_DEBUG, 'Got message forwarded from jid ' . $jid);
262 function is_autoreply($txt)
264 if (preg_match('/[\[\(]?[Aa]uto[-\s]?[Rr]e(ply|sponse)[\]\)]/', $txt)) {
266 } else if (preg_match('/^System: Message wasn\'t delivered. Offline storage size was exceeded.$/', $txt)) {
273 function is_otr($txt)
275 if (preg_match('/^\?OTR/', $txt)) {
282 function is_direct($txt)
284 if (strtolower(substr($txt, 0, 2))=='d ') {
291 function from_site($address, $msg)
293 $text = '['.common_config('site', 'name') . '] ' . $msg;
294 jabber_send_message($address, $text);
297 function handle_command($user, $body)
299 $inter = new CommandInterpreter();
300 $cmd = $inter->handle_command($user, $body);
302 $chan = new XMPPChannel($this->conn);
303 $cmd->execute($chan);
310 function add_notice(&$user, &$pl)
312 $body = trim($pl['body']);
313 $content_shortened = common_shorten_links($body);
314 if (mb_strlen($content_shortened) > 140) {
315 $from = jabber_normalize_jid($pl['from']);
316 $this->from_site($from, "Message too long - maximum is 140 characters, you sent ".mb_strlen($content_shortened));
319 $notice = Notice::saveNew($user->id, $content_shortened, 'xmpp');
320 if (is_string($notice)) {
321 $this->log(LOG_ERR, $notice);
322 $this->from_site($user->jabber, $notice);
325 common_broadcast_notice($notice);
327 'Added notice ' . $notice->id . ' from user ' . $user->nickname);
332 function handle_presence(&$pl)
334 $from = jabber_normalize_jid($pl['from']);
335 switch ($pl['type']) {
337 # We let anyone subscribe
338 $this->subscribed($from);
340 'Accepted subscription from ' . $from);
346 'Ignoring "' . $pl['type'] . '" from ' . $from);
350 $user = User::staticGet('jabber', $from);
352 $this->log(LOG_WARNING, 'Presence from unknown user ' . $from);
355 if ($user->updatefrompresence) {
356 $this->log(LOG_INFO, 'Updating ' . $user->nickname .
357 ' status from presence.');
358 $this->add_notice($user, $pl);
372 function log($level, $msg)
374 $text = 'XMPPDaemon('.$this->resource.'): '.$msg;
375 common_log($level, $text);
376 if (!$this->daemonize)
378 $line = common_log_line($level, $text);
384 function subscribed($to)
386 jabber_special_presence('subscribed', $to);
390 // Abort immediately if xmpp is not enabled, otherwise the daemon chews up
391 // lots of CPU trying to connect to unconfigured servers
392 if (common_config('xmpp','enabled')==false) {
393 print "Aborting daemon - xmpp is disabled\n";
397 if (have_option('i', 'id')) {
398 $id = get_option_value('i', 'id');
399 } else if (count($args) > 0) {
405 $foreground = have_option('f', 'foreground');
407 $daemon = new XMPPDaemon($id, !$foreground);