4 * Laconica - a distributed open-source microblogging tool
5 * Copyright (C) 2008, Controlez-Vous, 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 function xmppdaemon_error_handler($errno, $errstr, $errfile, $errline, $errcontext) {
24 echo "ERROR: [$errno] $errstr ($errfile:$errline)\n";
25 echo " Fatal error on line $errline in file $errfile";
26 echo ", PHP " . PHP_VERSION . " (" . PHP_OS . ")\n";
32 echo "WARNING [$errno] $errstr ($errfile:$errline)\n";
36 echo "NOTICE [$errno] $errstr ($errfile:$errline)\n";
40 /* Don't execute PHP internal error handler */
44 set_error_handler('xmppdaemon_error_handler');
46 # Abort if called from a web server
47 if (isset($_SERVER) && array_key_exists('REQUEST_METHOD', $_SERVER)) {
48 print "This script must be run from the command line\n";
52 define('INSTALLDIR', realpath(dirname(__FILE__) . '/..'));
53 define('LACONICA', true);
54 define('CLAIM_TIMEOUT', 100000);
56 require_once(INSTALLDIR . '/lib/common.php');
57 require_once(INSTALLDIR . '/lib/jabber.php');
59 # This is kind of clunky; we create a class to call the global functions
60 # in jabber.php, which create a new XMPP class. A more elegant (?) solution
61 # might be to use make this a subclass of XMPP.
65 function XMPPDaemon($resource=NULL) {
66 static $attrs = array('server', 'port', 'user', 'password', 'host');
68 foreach ($attrs as $attr)
70 $this->$attr = common_config('xmpp', $attr);
74 $this->resource = $resource;
76 $this->resource = common_config('xmpp', 'resource') . 'daemon';
79 $this->log(LOG_INFO, "{$this->user}@{$this->server}/{$this->resource}");
84 $connect_to = ($this->host) ? $this->host : $this->server;
86 $this->log(LOG_INFO, "Connecting to $connect_to on port $this->port");
88 $this->conn = jabber_connect($this->resource);
94 return !$this->conn->isDisconnected();
99 $this->conn->addEventHandler('message','handle_message',$this);
100 $this->conn->addEventHandler('presence','handle_presence',$this);
101 while(!$this->conn->isDisconnected()) {
103 $this->conn->processTime(10);
104 $this->broadcast_queue();
105 $this->confirmation_queue();
110 function get_user($from) {
111 $user = User::staticGet('jabber', jabber_normalize_jid($from));
115 function get_confirmation($from) {
116 $confirm = new Confirm_address();
117 $confirm->address = $from;
118 $confirm->address_type = 'jabber';
119 if ($confirm->find(TRUE)) {
126 function handle_message(&$pl) {
127 if ($pl['type'] != 'chat') {
130 if (mb_strlen($pl['body']) == 0) {
134 $from = jabber_normalize_jid($pl['from']);
135 $user = $this->get_user($from);
138 $this->from_site($from, 'Unknown user; go to ' .
139 common_local_url('imsettings') .
140 ' to add your address to your account');
141 $this->log(LOG_WARNING, 'Message from unknown user ' . $from);
144 if ($this->handle_command($user, $pl['body'])) {
146 } else if ($this->is_autoreply($pl['body'])) {
147 $this->log(LOG_INFO, 'Ignoring auto reply from ' . $from);
149 } else if ($this->is_otr($pl['body'])) {
150 $this->log(LOG_INFO, 'Ignoring OTR from ' . $from);
153 $len = mb_strlen($pl['body']);
155 $this->from_site($from, 'Message too long - maximum is 140 characters, you sent ' . $len);
158 $this->add_notice($user, $pl);
162 function is_autoreply($txt) {
163 if (preg_match('/[\[\(]?[Aa]uto-?[Rr]eply[\]\)]/', $txt)) {
170 function is_otr($txt) {
171 if (preg_match('/^\?OTR/', $txt)) {
178 function from_site($address, $msg) {
179 $text = '['.common_config('site', 'name') . '] ' . $msg;
180 jabber_send_message($address, $text);
183 function handle_command($user, $body) {
185 $p=explode(' ',$body);
192 $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");
197 $this->set_notify($user, true);
198 $this->from_site($user->jabber, 'notifications on');
203 $this->set_notify($user, false);
204 $this->from_site($user->jabber, 'notifications off');
208 $this->from_site($user->jabber, 'Specify the name of the user to subscribe to');
211 $result=subs_subscribe_user($user, $p[1]);
213 $this->from_site($user->jabber, 'Subscribed to ' . $p[1]);
215 $this->from_site($user->jabber, $result);
219 $this->from_site($user->jabber, 'Specify the name of the user to unsubscribe from');
222 $result=subs_unsubscribe_user($user, $p[1]);
224 $this->from_site($user->jabber, 'Unsubscribed from ' . $p[1]);
226 $this->from_site($user->jabber, $result);
233 function set_notify(&$user, $notify) {
234 $orig = clone($user);
235 $user->jabbernotify = $notify;
236 $result = $user->update($orig);
238 $last_error = &PEAR::getStaticProperty('DB_DataObject','lastError');
240 'Could not set notify flag to ' . $notify .
241 ' for user ' . common_log_objstring($user) .
242 ': ' . $last_error->message);
245 'User ' . $user->nickname . ' set notify flag to ' . $notify);
249 function add_notice(&$user, &$pl) {
250 $notice = Notice::saveNew($user->id, trim(mb_substr($pl['body'], 0, 140)), 'xmpp');
251 if (is_string($notice)) {
252 $this->log(LOG_ERR, $notice);
255 common_real_broadcast($notice);
257 'Added notice ' . $notice->id . ' from user ' . $user->nickname);
260 function handle_presence(&$pl) {
261 $from = jabber_normalize_jid($pl['from']);
262 switch ($pl['type']) {
264 # We let anyone subscribe
265 $this->subscribed($from);
267 'Accepted subscription from ' . $from);
273 'Ignoring "' . $pl['type'] . '" from ' . $from);
277 $user = User::staticGet('jabber', $from);
279 $this->log(LOG_WARNING, 'Presence from unknown user ' . $from);
282 if ($user->updatefrompresence) {
283 $this->log(LOG_INFO, 'Updating ' . $user->nickname .
284 ' status from presence.');
285 $this->add_notice($user, $pl);
292 function log($level, $msg) {
293 common_log($level, 'XMPPDaemon('.$this->resource.'): '.$msg);
296 function subscribed($to) {
297 jabber_special_presence('subscribed', $to);
300 function set_status($status) {
301 $this->log(LOG_INFO, 'Setting status to "' . $status . '"');
302 jabber_send_presence($status);
305 function top_queue_item() {
307 $qi = new Queue_item();
308 $qi->orderBy('created');
309 $qi->whereAdd('claimed is NULL');
313 $cnt = $qi->find(TRUE);
316 # XXX: potential race condition
317 # can we force it to only update if claimed is still NULL
319 $this->log(LOG_INFO, 'claiming queue item = ' . $qi->notice_id);
321 $qi->claimed = common_sql_now();
322 $result = $qi->update($orig);
324 $this->log(LOG_INFO, 'claim succeeded.');
327 $this->log(LOG_INFO, 'claim failed.');
334 function broadcast_queue() {
335 $this->clear_old_claims();
336 $this->log(LOG_INFO, 'checking for queued notices');
338 $qi = $this->top_queue_item();
340 $this->log(LOG_INFO, 'Got item enqueued '.common_exact_date($qi->created));
341 $notice = Notice::staticGet($qi->notice_id);
343 $this->log(LOG_INFO, 'broadcasting notice ID = ' . $notice->id);
344 # XXX: what to do if broadcast fails?
345 $result = common_real_broadcast($notice, $this->is_remote($notice));
347 $this->log(LOG_WARNING, 'Failed broadcast for notice ID = ' . $notice->id);
351 $this->log(LOG_WARNING, 'Abandoned claim for notice ID = ' . $notice->id);
354 $this->log(LOG_INFO, 'finished broadcasting notice ID = ' . $notice->id);
357 $this->log(LOG_WARNING, 'queue item for notice that does not exist');
364 function clear_old_claims() {
365 $qi = new Queue_item();
367 $qi->whereAdd('now() - claimed > '.CLAIM_TIMEOUT);
368 $qi->update(DB_DATAOBJECT_WHEREADD_ONLY);
371 function is_remote($notice) {
372 $user = User::staticGet($notice->profile_id);
376 function confirmation_queue() {
377 # $this->clear_old_confirm_claims();
378 $this->log(LOG_INFO, 'checking for queued confirmations');
380 $confirm = $this->next_confirm();
382 $this->log(LOG_INFO, 'Sending confirmation for ' . $confirm->address);
383 $user = User::staticGet($confirm->user_id);
385 $this->log(LOG_WARNING, 'Confirmation for unknown user ' . $confirm->user_id);
388 $success = jabber_confirm_address($confirm->code,
392 $this->log(LOG_ERR, 'Confirmation failed for ' . $confirm->address);
393 # Just let the claim age out; hopefully things work then
396 $this->log(LOG_INFO, 'Confirmation sent for ' . $confirm->address);
397 # Mark confirmation sent
398 $original = clone($confirm);
399 $confirm->sent = $confirm->claimed;
400 $result = $confirm->update($original);
402 $this->log(LOG_ERR, 'Cannot mark sent for ' . $confirm->address);
403 # Just let the claim age out; hopefully things work then
411 function next_confirm() {
412 $confirm = new Confirm_address();
413 $confirm->whereAdd('claimed IS NULL');
414 $confirm->whereAdd('sent IS NULL');
415 # XXX: eventually we could do other confirmations in the queue, too
416 $confirm->address_type = 'jabber';
417 $confirm->orderBy('modified DESC');
419 if ($confirm->find(TRUE)) {
420 $this->log(LOG_INFO, 'Claiming confirmation for ' . $confirm->address);
421 # working around some weird DB_DataObject behaviour
422 $confirm->whereAdd(''); # clears where stuff
423 $original = clone($confirm);
424 $confirm->claimed = common_sql_now();
425 $result = $confirm->update($original);
427 $this->log(LOG_INFO, 'Succeeded in claim! '. $result);
430 $this->log(LOG_INFO, 'Failed in claim!');
437 function clear_old_confirm_claims() {
438 $confirm = new Confirm();
439 $confirm->claimed = NULL;
440 $confirm->whereAdd('now() - claimed > '.CLAIM_TIMEOUT);
441 $confirm->update(DB_DATAOBJECT_WHEREADD_ONLY);
446 mb_internal_encoding('UTF-8');
448 $resource = ($argc > 1) ? $argv[1] : NULL;
450 $daemon = new XMPPDaemon($resource);
452 if ($daemon->connect()) {
453 $daemon->set_status("Send me a message to post a notice");