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 = 'r::';
24 $longoptions = array('resource::');
26 $helptext = <<<END_OF_XMPP_HELP
27 Daemon script for receiving new notices from Jabber users.
29 -r --resource Jabber Resource ID (default to config)
33 require_once INSTALLDIR.'/scripts/commandline.inc';
35 require_once INSTALLDIR . '/lib/common.php';
36 require_once INSTALLDIR . '/lib/jabber.php';
37 require_once INSTALLDIR . '/lib/daemon.php';
39 # This is kind of clunky; we create a class to call the global functions
40 # in jabber.php, which create a new XMPP class. A more elegant (?) solution
41 # might be to use make this a subclass of XMPP.
43 class XMPPDaemon extends Daemon
45 function XMPPDaemon($resource=null)
47 static $attrs = array('server', 'port', 'user', 'password', 'host');
49 foreach ($attrs as $attr)
51 $this->$attr = common_config('xmpp', $attr);
55 $this->resource = $resource;
57 $this->resource = common_config('xmpp', 'resource') . 'daemon';
60 $this->log(LOG_INFO, "INITIALIZE XMPPDaemon {$this->user}@{$this->server}/{$this->resource}");
66 $connect_to = ($this->host) ? $this->host : $this->server;
68 $this->log(LOG_INFO, "Connecting to $connect_to on port $this->port");
70 $this->conn = jabber_connect($this->resource);
76 $this->conn->setReconnectTimeout(600);
78 jabber_send_presence("Send me a message to post a notice", 'available',
79 null, 'available', 100);
80 return !$this->conn->isDisconnected();
85 return strtolower('xmppdaemon.'.$this->resource);
90 if ($this->connect()) {
92 $this->conn->addEventHandler('message', 'handle_message', $this);
93 $this->conn->addEventHandler('presence', 'handle_presence', $this);
94 $this->conn->addEventHandler('reconnect', 'handle_reconnect', $this);
96 $this->conn->process();
100 function handle_reconnect(&$pl)
102 $this->conn->processUntil('session_start');
103 $this->conn->presence('Send me a message to post a notice', 'available', null, 'available', 100);
106 function get_user($from)
108 $user = User::staticGet('jabber', jabber_normalize_jid($from));
112 function handle_message(&$pl)
114 if ($pl['type'] != 'chat') {
117 if (mb_strlen($pl['body']) == 0) {
121 $from = jabber_normalize_jid($pl['from']);
123 # Forwarded from another daemon (probably a broadcaster) for
126 if ($this->is_self($from)) {
127 $from = $this->get_ofrom($pl);
128 if (is_null($from) || $this->is_self($from)) {
133 $user = $this->get_user($from);
136 $this->from_site($from, 'Unknown user; go to ' .
137 common_local_url('imsettings') .
138 ' to add your address to your account');
139 $this->log(LOG_WARNING, 'Message from unknown user ' . $from);
142 if ($this->handle_command($user, $pl['body'])) {
144 } else if ($this->is_autoreply($pl['body'])) {
145 $this->log(LOG_INFO, 'Ignoring auto reply from ' . $from);
147 } else if ($this->is_otr($pl['body'])) {
148 $this->log(LOG_INFO, 'Ignoring OTR from ' . $from);
150 } else if ($this->is_direct($pl['body'])) {
151 preg_match_all('/d[\ ]*([a-z0-9]{1,64})/', $pl['body'], $to);
153 $to = preg_replace('/^d([\ ])*/', '', $to[0][0]);
154 $body = preg_replace('/d[\ ]*('. $to .')[\ ]*/', '', $pl['body']);
155 $this->add_direct($user, $body, $to, $from);
157 $this->add_notice($user, $pl);
164 function is_self($from)
166 return preg_match('/^'.strtolower(jabber_daemon_address()).'/', strtolower($from));
169 function get_ofrom($pl)
172 $addresses = $xml->sub('addresses');
174 $this->log(LOG_WARNING, 'Forwarded message without addresses');
177 $address = $addresses->sub('address');
179 $this->log(LOG_WARNING, 'Forwarded message without address');
182 if (!array_key_exists('type', $address->attrs)) {
183 $this->log(LOG_WARNING, 'No type for forwarded message');
186 $type = $address->attrs['type'];
187 if ($type != 'ofrom') {
188 $this->log(LOG_WARNING, 'Type of forwarded message is not ofrom');
191 if (!array_key_exists('jid', $address->attrs)) {
192 $this->log(LOG_WARNING, 'No jid for forwarded message');
195 $jid = $address->attrs['jid'];
197 $this->log(LOG_WARNING, 'Could not get jid from address');
200 $this->log(LOG_DEBUG, 'Got message forwarded from jid ' . $jid);
204 function is_autoreply($txt)
206 if (preg_match('/[\[\(]?[Aa]uto[-\s]?[Rr]e(ply|sponse)[\]\)]/', $txt)) {
208 } else if (preg_match('/^System: Message wasn\'t delivered. Offline storage size was exceeded.$/', $txt)) {
215 function is_otr($txt)
217 if (preg_match('/^\?OTR/', $txt)) {
224 function is_direct($txt)
226 if (strtolower(substr($txt, 0, 2))=='d ') {
233 function from_site($address, $msg)
235 $text = '['.common_config('site', 'name') . '] ' . $msg;
236 jabber_send_message($address, $text);
239 function handle_command($user, $body)
241 $inter = new CommandInterpreter();
242 $cmd = $inter->handle_command($user, $body);
244 $chan = new XMPPChannel($this->conn);
245 $cmd->execute($chan);
252 function add_notice(&$user, &$pl)
254 $body = trim($pl['body']);
255 $content_shortened = common_shorten_links($body);
256 if (mb_strlen($content_shortened) > 140) {
257 $from = jabber_normalize_jid($pl['from']);
258 $this->from_site($from, "Message too long - maximum is 140 characters, you sent ".mb_strlen($content_shortened));
261 $notice = Notice::saveNew($user->id, $content_shortened, 'xmpp');
262 if (is_string($notice)) {
263 $this->log(LOG_ERR, $notice);
266 common_broadcast_notice($notice);
268 'Added notice ' . $notice->id . ' from user ' . $user->nickname);
273 function handle_presence(&$pl)
275 $from = jabber_normalize_jid($pl['from']);
276 switch ($pl['type']) {
278 # We let anyone subscribe
279 $this->subscribed($from);
281 'Accepted subscription from ' . $from);
287 'Ignoring "' . $pl['type'] . '" from ' . $from);
291 $user = User::staticGet('jabber', $from);
293 $this->log(LOG_WARNING, 'Presence from unknown user ' . $from);
296 if ($user->updatefrompresence) {
297 $this->log(LOG_INFO, 'Updating ' . $user->nickname .
298 ' status from presence.');
299 $this->add_notice($user, $pl);
308 function log($level, $msg)
310 common_log($level, 'XMPPDaemon('.$this->resource.'): '.$msg);
313 function subscribed($to)
315 jabber_special_presence('subscribed', $to);
319 // Abort immediately if xmpp is not enabled, otherwise the daemon chews up
320 // lots of CPU trying to connect to unconfigured servers
321 if (common_config('xmpp','enabled')==false) {
322 print "Aborting daemon - xmpp is disabled\n";
326 if (have_option('r')) {
327 $resource = get_option_value('r');
328 } else if (have_option('--resource')) {
329 $resource = get_option_value('--resource');
330 } else if (count($args) > 0) {
331 $resource = $args[0];
336 $daemon = new XMPPDaemon($resource);