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 "My NOTICE [$errno] $errstr ($errfile:$errline)\n";
40 echo "Unknown error type: [$errno] $errstr ($errfile:$errline)\n";
44 /* Don't execute PHP internal error handler */
48 set_error_handler('xmppdaemon_error_handler');
50 # Abort if called from a web server
51 if (isset($_SERVER) && array_key_exists('REQUEST_METHOD', $_SERVER)) {
52 print "This script must be run from the command line\n";
56 define('INSTALLDIR', realpath(dirname(__FILE__) . '/..'));
57 define('LACONICA', true);
58 define('CLAIM_TIMEOUT', 100000);
60 require_once(INSTALLDIR . '/lib/common.php');
61 require_once(INSTALLDIR . '/lib/jabber.php');
63 # This is kind of clunky; we create a class to call the global functions
64 # in jabber.php, which create a new XMPP class. A more elegant (?) solution
65 # might be to use make this a subclass of XMPP.
69 function XMPPDaemon($resource=NULL) {
70 static $attrs = array('server', 'port', 'user', 'password', 'host');
72 foreach ($attrs as $attr)
74 $this->$attr = common_config('xmpp', $attr);
78 $this->resource = $resource;
80 $this->resource = common_config('xmpp', 'resource') . 'daemon';
83 $this->log(LOG_INFO, "{$this->user}@{$this->server}/{$this->resource}");
88 $connect_to = ($this->host) ? $this->host : $this->server;
90 $this->log(LOG_INFO, "Connecting to $connect_to on port $this->port");
92 $this->conn = jabber_connect($this->resource);
98 return !$this->conn->isDisconnected();
103 static $parts = array('message', 'presence',
104 'end_stream', 'session_start');
106 while(!$this->conn->isDisconnected()) {
108 $payloads = $this->conn->processUntil($parts, 10);
111 foreach($payloads as $event) {
115 $this->handle_message($pl);
118 $this->handle_presence($pl);
120 case 'session_start':
121 $this->handle_session($pl);
127 $this->broadcast_queue();
128 $this->confirmation_queue();
132 function handle_session($pl) {
133 # XXX what to do here?
137 function get_user($from) {
138 $user = User::staticGet('jabber', jabber_normalize_jid($from));
142 function get_confirmation($from) {
143 $confirm = new Confirm_address();
144 $confirm->address = $from;
145 $confirm->address_type = 'jabber';
146 if ($confirm->find(TRUE)) {
153 function handle_message(&$pl) {
154 if ($pl['type'] != 'chat') {
157 if (strlen($pl['body']) == 0) {
161 $from = jabber_normalize_jid($pl['from']);
162 $user = $this->get_user($from);
165 $this->from_site($from, 'Unknown user; go to ' .
166 common_local_url('imsettings') .
167 ' to add your address to your account');
168 $this->log(LOG_WARNING, 'Message from unknown user ' . $from);
171 if ($this->handle_command($user, $pl['body'])) {
173 } else if ($this->is_autoreply($pl['body'])) {
174 $this->log(LOG_INFO, 'Ignoring auto reply from ' . $from);
176 } else if ($this->is_otr($pl['body'])) {
177 $this->log(LOG_INFO, 'Ignoring OTR from ' . $from);
180 if(strlen($pl['body'])>140) {
181 $this->from_site($from, 'Message too long - maximum is 140 characters, you sent ' . strlen($pl['body']));
184 $this->add_notice($user, $pl);
188 function is_autoreply($txt) {
189 if (preg_match('/[\[\(]?[Aa]uto-?[Rr]eply[\]\)]/', $txt)) {
196 function is_otr($txt) {
197 if (preg_match('/^\?OTR/', $txt)) {
204 function from_site($address, $msg) {
205 $text = '['.common_config('site', 'name') . '] ' . $msg;
206 jabber_send_message($address, $text);
209 function handle_command($user, $body) {
211 $p=explode(' ',$body);
218 $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");
223 $this->set_notify($user, true);
224 $this->from_site($user->jabber, 'notifications on');
229 $this->set_notify($user, false);
230 $this->from_site($user->jabber, 'notifications off');
234 $this->from_site($user->jabber, 'Specify the name of the user to subscribe to');
237 $result=subs_subscribe_user($user, $p[1]);
239 $this->from_site($user->jabber, 'Subscribed to ' . $p[1]);
241 $this->from_site($user->jabber, $result);
245 $this->from_site($user->jabber, 'Specify the name of the user to unsubscribe from');
248 $result=subs_unsubscribe_user($user, $p[1]);
250 $this->from_site($user->jabber, 'Unsubscribed from ' . $p[1]);
252 $this->from_site($user->jabber, $result);
259 function set_notify(&$user, $notify) {
260 $orig = clone($user);
261 $user->jabbernotify = $notify;
262 $result = $user->update($orig);
264 $last_error = &PEAR::getStaticProperty('DB_DataObject','lastError');
266 'Could not set notify flag to ' . $notify .
267 ' for user ' . common_log_objstring($user) .
268 ': ' . $last_error->message);
271 'User ' . $user->nickname . ' set notify flag to ' . $notify);
275 function add_notice(&$user, &$pl) {
276 $notice = Notice::saveNew($user->id, trim(mb_substr($pl['body'], 0, 140)), 'xmpp');
277 if (is_string($notice)) {
278 $this->log(LOG_ERR, $notice);
281 common_real_broadcast($notice);
283 'Added notice ' . $notice->id . ' from user ' . $user->nickname);
286 function handle_presence(&$pl) {
287 $from = jabber_normalize_jid($pl['from']);
288 switch ($pl['type']) {
290 # We let anyone subscribe
291 $this->subscribed($from);
293 'Accepted subscription from ' . $from);
299 'Ignoring "' . $pl['type'] . '" from ' . $from);
303 $user = User::staticGet('jabber', $from);
305 $this->log(LOG_WARNING, 'Presence from unknown user ' . $from);
308 if ($user->updatefrompresence) {
309 $this->log(LOG_INFO, 'Updating ' . $user->nickname .
310 ' status from presence.');
311 $this->add_notice($user, $pl);
318 function log($level, $msg) {
319 common_log($level, 'XMPPDaemon('.$this->resource.'): '.$msg);
322 function subscribed($to) {
323 jabber_special_presence('subscribed', $to);
326 function set_status($status) {
327 $this->log(LOG_INFO, 'Setting status to "' . $status . '"');
328 jabber_send_presence($status);
331 function top_queue_item() {
333 $qi = new Queue_item();
334 $qi->orderBy('created');
335 $qi->whereAdd('claimed is NULL');
339 $cnt = $qi->find(TRUE);
342 # XXX: potential race condition
343 # can we force it to only update if claimed is still NULL
345 $this->log(LOG_INFO, 'claiming queue item = ' . $qi->notice_id);
347 $qi->claimed = DB_DataObject_Cast::dateTime();
348 $result = $qi->update($orig);
350 $this->log(LOG_INFO, 'claim succeeded.');
353 $this->log(LOG_INFO, 'claim failed.');
360 function broadcast_queue() {
361 $this->clear_old_claims();
362 $this->log(LOG_INFO, 'checking for queued notices');
364 $qi = $this->top_queue_item();
366 $this->log(LOG_INFO, 'Got item enqueued '.common_exact_date($qi->created));
367 $notice = Notice::staticGet($qi->notice_id);
369 $this->log(LOG_INFO, 'broadcasting notice ID = ' . $notice->id);
370 # XXX: what to do if broadcast fails?
371 $result = common_real_broadcast($notice, $this->is_remote($notice));
373 $this->log(LOG_WARNING, 'Failed broadcast for notice ID = ' . $notice->id);
377 $this->log(LOG_WARNING, 'Abandoned claim for notice ID = ' . $notice->id);
380 $this->log(LOG_INFO, 'finished broadcasting notice ID = ' . $notice->id);
383 $this->log(LOG_WARNING, 'queue item for notice that does not exist');
390 function clear_old_claims() {
391 $qi = new Queue_item();
393 $qi->whereAdd('now() - claimed > '.CLAIM_TIMEOUT);
394 $qi->update(DB_DATAOBJECT_WHEREADD_ONLY);
397 function is_remote($notice) {
398 $user = User::staticGet($notice->profile_id);
402 function confirmation_queue() {
403 # $this->clear_old_confirm_claims();
404 $this->log(LOG_INFO, 'checking for queued confirmations');
406 $confirm = $this->next_confirm();
408 $this->log(LOG_INFO, 'Sending confirmation for ' . $confirm->address);
409 $user = User::staticGet($confirm->user_id);
411 $this->log(LOG_WARNING, 'Confirmation for unknown user ' . $confirm->user_id);
414 $success = jabber_confirm_address($confirm->code,
418 $this->log(LOG_ERR, 'Confirmation failed for ' . $confirm->address);
419 # Just let the claim age out; hopefully things work then
422 $this->log(LOG_INFO, 'Confirmation sent for ' . $confirm->address);
423 # Mark confirmation sent
424 $original = clone($confirm);
425 $confirm->sent = $confirm->claimed;
426 $result = $confirm->update($original);
428 $this->log(LOG_ERR, 'Cannot mark sent for ' . $confirm->address);
429 # Just let the claim age out; hopefully things work then
437 function next_confirm() {
438 $confirm = new Confirm_address();
439 $confirm->whereAdd('claimed IS NULL');
440 $confirm->whereAdd('sent IS NULL');
441 # XXX: eventually we could do other confirmations in the queue, too
442 $confirm->address_type = 'jabber';
443 $confirm->orderBy('modified DESC');
445 if ($confirm->find(TRUE)) {
446 $this->log(LOG_INFO, 'Claiming confirmation for ' . $confirm->address);
447 # working around some weird DB_DataObject behaviour
448 $confirm->whereAdd(''); # clears where stuff
449 $original = clone($confirm);
450 $confirm->claimed = DB_DataObject_Cast::dateTime();
451 $result = $confirm->update($original);
453 $this->log(LOG_INFO, 'Succeeded in claim! '. $result);
456 $this->log(LOG_INFO, 'Failed in claim!');
463 function clear_old_confirm_claims() {
464 $confirm = new Confirm();
465 $confirm->claimed = NULL;
466 $confirm->whereAdd('now() - claimed > '.CLAIM_TIMEOUT);
467 $confirm->update(DB_DATAOBJECT_WHEREADD_ONLY);
472 mb_internal_encoding('UTF-8');
474 $resource = ($argc > 1) ? $argv[1] : NULL;
476 $daemon = new XMPPDaemon($resource);
478 if ($daemon->connect()) {
479 $daemon->set_status("Send me a message to post a notice");