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 $this->conn->addEventHandler('session_start', 'handle_session_start', $this);
103 while(!$this->conn->isDisconnected()) {
104 $this->conn->processTime(10);
105 $this->broadcast_queue();
106 $this->confirmation_queue();
110 function handle_session_start(&$pl) {
111 $this->conn->getRoster();
112 $this->set_status("Send me a message to post a notice");
115 function get_user($from) {
116 $user = User::staticGet('jabber', jabber_normalize_jid($from));
120 function get_confirmation($from) {
121 $confirm = new Confirm_address();
122 $confirm->address = $from;
123 $confirm->address_type = 'jabber';
124 if ($confirm->find(TRUE)) {
131 function handle_message(&$pl) {
132 if ($pl['type'] != 'chat') {
135 if (mb_strlen($pl['body']) == 0) {
139 $from = jabber_normalize_jid($pl['from']);
140 $user = $this->get_user($from);
143 $this->from_site($from, 'Unknown user; go to ' .
144 common_local_url('imsettings') .
145 ' to add your address to your account');
146 $this->log(LOG_WARNING, 'Message from unknown user ' . $from);
149 if ($this->handle_command($user, $pl['body'])) {
151 } else if ($this->is_autoreply($pl['body'])) {
152 $this->log(LOG_INFO, 'Ignoring auto reply from ' . $from);
154 } else if ($this->is_otr($pl['body'])) {
155 $this->log(LOG_INFO, 'Ignoring OTR from ' . $from);
158 $len = mb_strlen($pl['body']);
160 $this->from_site($from, 'Message too long - maximum is 140 characters, you sent ' . $len);
163 $this->add_notice($user, $pl);
167 function is_autoreply($txt) {
168 if (preg_match('/[\[\(]?[Aa]uto-?[Rr]eply[\]\)]/', $txt)) {
175 function is_otr($txt) {
176 if (preg_match('/^\?OTR/', $txt)) {
183 function from_site($address, $msg) {
184 $text = '['.common_config('site', 'name') . '] ' . $msg;
185 jabber_send_message($address, $text);
188 function handle_command($user, $body) {
190 $p=explode(' ',$body);
197 $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");
202 $this->set_notify($user, true);
203 $this->from_site($user->jabber, 'notifications on');
208 $this->set_notify($user, false);
209 $this->from_site($user->jabber, 'notifications off');
213 $this->from_site($user->jabber, 'Specify the name of the user to subscribe to');
216 $result=subs_subscribe_user($user, $p[1]);
218 $this->from_site($user->jabber, 'Subscribed to ' . $p[1]);
220 $this->from_site($user->jabber, $result);
224 $this->from_site($user->jabber, 'Specify the name of the user to unsubscribe from');
227 $result=subs_unsubscribe_user($user, $p[1]);
229 $this->from_site($user->jabber, 'Unsubscribed from ' . $p[1]);
231 $this->from_site($user->jabber, $result);
238 function set_notify(&$user, $notify) {
239 $orig = clone($user);
240 $user->jabbernotify = $notify;
241 $result = $user->update($orig);
243 $last_error = &PEAR::getStaticProperty('DB_DataObject','lastError');
245 'Could not set notify flag to ' . $notify .
246 ' for user ' . common_log_objstring($user) .
247 ': ' . $last_error->message);
250 'User ' . $user->nickname . ' set notify flag to ' . $notify);
254 function add_notice(&$user, &$pl) {
255 $notice = Notice::saveNew($user->id, trim(mb_substr($pl['body'], 0, 140)), 'xmpp');
256 if (is_string($notice)) {
257 $this->log(LOG_ERR, $notice);
260 common_real_broadcast($notice);
262 'Added notice ' . $notice->id . ' from user ' . $user->nickname);
265 function handle_presence(&$pl) {
266 $from = jabber_normalize_jid($pl['from']);
267 switch ($pl['type']) {
269 # We let anyone subscribe
270 $this->subscribed($from);
272 'Accepted subscription from ' . $from);
278 'Ignoring "' . $pl['type'] . '" from ' . $from);
282 $user = User::staticGet('jabber', $from);
284 $this->log(LOG_WARNING, 'Presence from unknown user ' . $from);
287 if ($user->updatefrompresence) {
288 $this->log(LOG_INFO, 'Updating ' . $user->nickname .
289 ' status from presence.');
290 $this->add_notice($user, $pl);
297 function log($level, $msg) {
298 common_log($level, 'XMPPDaemon('.$this->resource.'): '.$msg);
301 function subscribed($to) {
302 jabber_special_presence('subscribed', $to);
305 function set_status($status) {
306 $this->log(LOG_INFO, 'Setting status to "' . $status . '"');
307 jabber_send_presence($status);
310 function top_queue_item() {
312 $qi = new Queue_item();
313 $qi->orderBy('created');
314 $qi->whereAdd('claimed is NULL');
318 $cnt = $qi->find(TRUE);
321 # XXX: potential race condition
322 # can we force it to only update if claimed is still NULL
324 $this->log(LOG_INFO, 'claiming queue item = ' . $qi->notice_id);
326 $qi->claimed = common_sql_now();
327 $result = $qi->update($orig);
329 $this->log(LOG_INFO, 'claim succeeded.');
332 $this->log(LOG_INFO, 'claim failed.');
339 function broadcast_queue() {
340 $this->clear_old_claims();
341 $this->log(LOG_INFO, 'checking for queued notices');
343 $qi = $this->top_queue_item();
345 $this->log(LOG_INFO, 'Got item enqueued '.common_exact_date($qi->created));
346 $notice = Notice::staticGet($qi->notice_id);
348 $this->log(LOG_INFO, 'broadcasting notice ID = ' . $notice->id);
349 # XXX: what to do if broadcast fails?
350 $result = common_real_broadcast($notice, $this->is_remote($notice));
352 $this->log(LOG_WARNING, 'Failed broadcast for notice ID = ' . $notice->id);
356 $this->log(LOG_WARNING, 'Abandoned claim for notice ID = ' . $notice->id);
359 $this->log(LOG_INFO, 'finished broadcasting notice ID = ' . $notice->id);
362 $this->log(LOG_WARNING, 'queue item for notice that does not exist');
369 function clear_old_claims() {
370 $qi = new Queue_item();
372 $qi->whereAdd('now() - claimed > '.CLAIM_TIMEOUT);
373 $qi->update(DB_DATAOBJECT_WHEREADD_ONLY);
376 function is_remote($notice) {
377 $user = User::staticGet($notice->profile_id);
381 function confirmation_queue() {
382 # $this->clear_old_confirm_claims();
383 $this->log(LOG_INFO, 'checking for queued confirmations');
385 $confirm = $this->next_confirm();
387 $this->log(LOG_INFO, 'Sending confirmation for ' . $confirm->address);
388 $user = User::staticGet($confirm->user_id);
390 $this->log(LOG_WARNING, 'Confirmation for unknown user ' . $confirm->user_id);
393 $success = jabber_confirm_address($confirm->code,
397 $this->log(LOG_ERR, 'Confirmation failed for ' . $confirm->address);
398 # Just let the claim age out; hopefully things work then
401 $this->log(LOG_INFO, 'Confirmation sent for ' . $confirm->address);
402 # Mark confirmation sent
403 $original = clone($confirm);
404 $confirm->sent = $confirm->claimed;
405 $result = $confirm->update($original);
407 $this->log(LOG_ERR, 'Cannot mark sent for ' . $confirm->address);
408 # Just let the claim age out; hopefully things work then
416 function next_confirm() {
417 $confirm = new Confirm_address();
418 $confirm->whereAdd('claimed IS NULL');
419 $confirm->whereAdd('sent IS NULL');
420 # XXX: eventually we could do other confirmations in the queue, too
421 $confirm->address_type = 'jabber';
422 $confirm->orderBy('modified DESC');
424 if ($confirm->find(TRUE)) {
425 $this->log(LOG_INFO, 'Claiming confirmation for ' . $confirm->address);
426 # working around some weird DB_DataObject behaviour
427 $confirm->whereAdd(''); # clears where stuff
428 $original = clone($confirm);
429 $confirm->claimed = common_sql_now();
430 $result = $confirm->update($original);
432 $this->log(LOG_INFO, 'Succeeded in claim! '. $result);
435 $this->log(LOG_INFO, 'Failed in claim!');
442 function clear_old_confirm_claims() {
443 $confirm = new Confirm();
444 $confirm->claimed = NULL;
445 $confirm->whereAdd('now() - claimed > '.CLAIM_TIMEOUT);
446 $confirm->update(DB_DATAOBJECT_WHEREADD_ONLY);
451 mb_internal_encoding('UTF-8');
453 $resource = ($argc > 1) ? $argv[1] : NULL;
455 $daemon = new XMPPDaemon($resource);
457 if ($daemon->connect()) {
458 $daemon->set_status("Send me a message to post a notice");