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 # Abort if called from a web server
22 if (isset($_SERVER) && array_key_exists('REQUEST_METHOD', $_SERVER)) {
23 print "This script must be run from the command line\n";
27 define('INSTALLDIR', dirname(__FILE__));
28 define('LACONICA', true);
30 require_once(INSTALLDIR . '/lib/common.php');
31 require_once(INSTALLDIR . '/lib/jabber.php');
33 # This is kind of clunky; we create a class to call the global functions
34 # in jabber.php, which create a new XMPP class. A more elegant (?) solution
35 # might be to use make this a subclass of XMPP.
39 function XMPPDaemon($resource=NULL) {
40 static $attrs = array('server', 'port', 'user', 'password', 'host');
42 foreach ($attrs as $attr)
44 $this->$attr = common_config('xmpp', $attr);
48 $this->resource = $resource;
50 $this->resource = common_config('xmpp', 'resource') . 'daemon';
53 $this->log(LOG_INFO, "{$this->user}@{$this->server}/{$this->resource}");
58 $connect_to = ($this->host) ? $this->host : $this->server;
60 $this->log(LOG_INFO, "Connecting to $connect_to on port $this->port");
62 $this->conn = jabber_connect($this->resource);
68 return !$this->conn->isDisconnected();
73 static $parts = array('message', 'presence',
74 'end_stream', 'session_start');
76 while(!$this->conn->isDisconnected()) {
78 $payloads = $this->conn->processUntil($parts, 10);
81 foreach($payloads as $event) {
85 $this->handle_message($pl);
88 $this->handle_presence($pl);
91 $this->handle_session($pl);
97 $this->broadcast_queue();
98 $this->confirmation_queue();
102 function get_user($from) {
103 $user = User::staticGet('jabber', jabber_normalize_jid($from));
107 function get_confirmation($from) {
108 $confirm = new Confirm_address();
109 $confirm->address = $from;
110 $confirm->address_type = 'jabber';
111 if ($confirm->find(TRUE)) {
118 function handle_message(&$pl) {
119 if ($pl['type'] != 'chat') {
122 if (strlen($pl['body']) == 0) {
126 $from = jabber_normalize_jid($pl['from']);
127 $user = $this->get_user($from);
130 $this->from_site($from, 'Unknown user; go to ' .
131 common_local_url('imsettings') .
132 ' to add your address to your account');
133 $this->log(LOG_WARNING, 'Message from unknown user ' . $from);
136 if ($this->handle_command($user, $pl['body'])) {
139 $this->add_notice($user, $pl);
143 function from_site($address, $msg) {
144 $text = '['.common_config('site', 'name') . '] ' . $msg;
145 jabber_send_message($address, $text);
148 function handle_command($user, $body) {
150 switch(trim($body)) {
152 $this->set_notify($user, true);
153 $this->from_site($user->jabber, 'notifications on');
156 $this->set_notify($user, false);
157 $this->from_site($user->jabber, 'notifications off');
164 function set_notify(&$user, $notify) {
165 $orig = clone($user);
166 $user->jabbernotify = $notify;
167 $result = $user->update($orig);
169 $last_error = &PEAR::getStaticProperty('DB_DataObject','lastError');
170 $this->log(LOG_ERROR,
171 'Could not set notify flag to ' . $notify .
172 ' for user ' . common_log_objstring($user) .
173 ': ' . $last_error->message);
176 'User ' . $user->nickname . ' set notify flag to ' . $notify);
180 function add_notice(&$user, &$pl) {
181 $notice = new Notice();
182 $notice->profile_id = $user->id;
183 $notice->content = trim(substr($pl['body'], 0, 140));
184 $notice->created = DB_DataObject_Cast::dateTime();
185 $notice->query('BEGIN');
186 $id = $notice->insert();
188 $last_error = &PEAR::getStaticProperty('DB_DataObject','lastError');
189 $this->log(LOG_ERROR,
190 'Could not insert ' . common_log_objstring($notice) .
191 ' for user ' . common_log_objstring($user) .
192 ': ' . $last_error->message);
195 $orig = clone($notice);
196 $notice->uri = common_notice_uri($notice);
197 $result = $notice->update($orig);
199 $last_error = &PEAR::getStaticProperty('DB_DataObject','lastError');
200 $this->log(LOG_ERROR,
201 'Could not add URI to ' . common_log_objstring($notice) .
202 ' for user ' . common_log_objstring($user) .
203 ': ' . $last_error->message);
206 $notice->query('COMMIT');
207 common_real_broadcast($notice);
209 'Added notice ' . $notice->id . ' from user ' . $user->nickname);
212 function handle_presence(&$pl) {
213 $from = jabber_normalize_jid($pl['from']);
214 switch ($pl['type']) {
216 # We let anyone subscribe
217 $this->subscribed($from);
219 'Accepted subscription from ' . $from);
225 'Ignoring "' . $pl['type'] . '" from ' . $from);
229 $user = User::staticGet('jabber', $from);
231 $this->log(LOG_WARNING, 'Message from unknown user ' . $from);
234 if ($user->updatefrompresence) {
235 $this->log(LOG_INFO, 'Updating ' . $user->nickname .
236 ' status from presence.');
237 $this->add_notice($user, $pl);
244 function log($level, $msg) {
245 common_log($level, 'XMPPDaemon('.$this->resource.'): '.$msg);
248 function subscribed($to) {
249 jabber_special_presence('subscribed', $to);
252 function set_status($status) {
253 $this->log(LOG_INFO, 'Setting status to "' . $status . '"');
254 jabber_send_presence($status);
257 function top_queue_item() {
259 $qi = new Queue_item();
260 $qi->orderBy('created');
261 $qi->whereAdd('claimed is NULL');
265 $cnt = $qi->find(TRUE);
268 # XXX: potential race condition
269 # can we force it to only update if claimed is still NULL
271 $this->log(LOG_INFO, 'claiming queue item = ' . $qi->notice_id);
273 $qi->claimed = DB_DataObject_Cast::dateTime();
274 $result = $qi->update($orig);
276 $this->log(LOG_INFO, 'claim succeeded.');
279 $this->log(LOG_INFO, 'claim failed.');
286 function broadcast_queue() {
287 $this->clear_old_claims();
288 $this->log(LOG_INFO, 'checking for queued notices');
290 $qi = $this->top_queue_item();
292 $this->log(LOG_INFO, 'Got item enqueued '.common_exact_date($qi->created));
293 $notice = Notice::staticGet($qi->notice_id);
295 $this->log(LOG_INFO, 'broadcasting notice ID = ' . $notice->id);
296 # XXX: what to do if broadcast fails?
297 $result = common_real_broadcast($notice, $this->is_remote($notice));
299 $this->log(LOG_WARNING, 'Failed broadcast for notice ID = ' . $notice->id);
303 $this->log(LOG_WARNING, 'Abandoned claim for notice ID = ' . $notice->id);
306 $this->log(LOG_INFO, 'finished broadcasting notice ID = ' . $notice->id);
309 $this->log(LOG_WARNING, 'queue item for notice that does not exist');
316 function clear_old_claims() {
317 $qi = new Queue_item();
318 $qi->whereAdd('now() - claimed > '.CLAIM_TIMEOUT);
319 $qi->update(DB_DATAOBJECT_WHEREADD_ONLY);
322 function is_remote($notice) {
323 $user = User::staticGet($notice->profile_id);
327 function confirmation_queue() {
328 # $this->clear_old_confirm_claims();
329 $this->log(LOG_INFO, 'checking for queued confirmations');
331 $confirm = $this->next_confirm();
333 $this->log(LOG_INFO, 'Sending confirmation for ' . $confirm->address);
334 $user = User::staticGet($confirm->user_id);
336 $this->log(LOG_WARNING, 'Confirmation for unknown user ' . $confirm->user_id);
339 $success = jabber_confirm_address($confirm->code,
343 $this->log(LOG_ERROR, 'Confirmation failed for ' . $confirm->address);
344 # Just let the claim age out; hopefully things work then
347 $this->log(LOG_INFO, 'Confirmation sent for ' . $confirm->address);
348 # Mark confirmation sent
349 $original = clone($confirm);
350 $confirm->sent = DB_DataObject_Cast::dateTime();
351 $result = $confirm->update($original);
353 $this->log(LOG_ERROR, 'Cannot mark sent for ' . $confirm->address);
354 # Just let the claim age out; hopefully things work then
362 function next_confirm() {
363 $confirm = new Confirm_address();
364 $confirm->whereAdd('claimed IS NULL');
365 # XXX: eventually we could do other confirmations in the queue, too
366 $confirm->address_type = 'jabber';
367 $confirm->orderBy('modified DESC');
369 if ($confirm->find(TRUE)) {
370 $this->log(LOG_INFO, 'Claiming confirmation for ' . $confirm->address);
371 $original = clone($confirm);
372 $confirm->claimed = DB_DataObject_Cast::dateTime();
373 $result = $confirm->update($original);
375 $this->log(LOG_INFO, 'Succeeded in claim!');
378 $this->log(LOG_INFO, 'Failed in claim!');
385 function clear_old_confirm_claims() {
386 $confirm = new Confirm();
387 $confirm->whereAdd('now() - claimed > '.CLAIM_TIMEOUT);
388 $confirm->update(DB_DATAOBJECT_WHEREADD_ONLY);
393 $resource = ($argc > 1) ? $argv[1] : NULL;
395 $daemon = new XMPPDaemon($resource);
397 if ($daemon->connect()) {
398 $daemon->set_status("Send me a message to post a notice");