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}");
57 $connect_to = ($this->host) ? $this->host : $this->server;
59 $this->log(LOG_INFO, "Connecting to $connect_to on port $this->port");
61 $this->conn = jabber_connect($this->resource);
66 return !$this->conn->isDisconnected();
71 static $parts = array('message', 'presence',
72 'end_stream', 'session_start');
74 while(!$this->conn->disconnected) {
76 $payloads = $this->conn->processUntil($parts, 10);
79 foreach($payloads as $event) {
83 $this->handle_message($pl);
86 $this->handle_presence($pl);
89 $this->handle_session($pl);
95 $this->broadcast_queue();
96 $this->confirmation_queue();
100 function get_user($from) {
101 $user = User::staticGet('jabber', jabber_normalize_jid($from));
105 function get_confirmation($from) {
106 $confirm = new Confirm_address();
107 $confirm->address = $from;
108 $confirm->address_type = 'jabber';
109 if ($confirm->find(TRUE)) {
116 function handle_message(&$pl) {
117 if ($pl['type'] != 'chat') {
120 if (strlen($pl['body']) == 0) {
124 $from = jabber_normalize_jid($pl['from']);
125 $user = $this->get_user($from);
128 $this->from_site($from, 'Unknown user; go to ' .
129 common_local_url('imsettings') .
130 ' to add your address to your account');
131 $this->log(LOG_WARNING, 'Message from unknown user ' . $from);
134 if ($this->handle_command($user, $pl['body'])) {
137 $this->add_notice($user, $pl);
141 function from_site($address, $msg) {
142 $text = '['.common_config('site', 'name') . '] ' . $msg;
143 jabber_send_message($address, $text);
146 function handle_command($user, $body) {
148 switch(trim($body)) {
150 $this->set_notify($user, true);
151 $this->from_site($user->jabber, 'notifications on');
154 $this->set_notify($user, false);
155 $this->from_site($user->jabber, 'notifications off');
162 function set_notify(&$user, $notify) {
163 $orig = clone($user);
164 $user->jabbernotify = $notify;
165 $result = $user->update($orig);
167 $last_error = &PEAR::getStaticProperty('DB_DataObject','lastError');
168 $this->log(LOG_ERROR,
169 'Could not set notify flag to ' . $notify .
170 ' for user ' . common_log_objstring($user) .
171 ': ' . $last_error->message);
174 'User ' . $user->nickname . ' set notify flag to ' . $notify);
178 function add_notice(&$user, &$pl) {
179 $notice = new Notice();
180 $notice->profile_id = $user->id;
181 $notice->content = trim(substr($pl['body'], 0, 140));
182 $notice->created = DB_DataObject_Cast::dateTime();
183 $notice->query('BEGIN');
184 $id = $notice->insert();
186 $last_error = &PEAR::getStaticProperty('DB_DataObject','lastError');
187 $this->log(LOG_ERROR,
188 'Could not insert ' . common_log_objstring($notice) .
189 ' for user ' . common_log_objstring($user) .
190 ': ' . $last_error->message);
193 $orig = clone($notice);
194 $notice->uri = common_notice_uri($notice);
195 $result = $notice->update($orig);
197 $last_error = &PEAR::getStaticProperty('DB_DataObject','lastError');
198 $this->log(LOG_ERROR,
199 'Could not add URI to ' . common_log_objstring($notice) .
200 ' for user ' . common_log_objstring($user) .
201 ': ' . $last_error->message);
204 $notice->query('COMMIT');
205 common_broadcast_notice($notice);
207 'Added notice ' . $notice->id . ' from user ' . $user->nickname);
210 function handle_presence(&$pl) {
211 $from = jabber_normalize_jid($pl['from']);
212 switch ($pl['type']) {
214 # We let anyone subscribe
215 $this->subscribed($from);
217 'Accepted subscription from ' . $from);
223 'Ignoring "' . $pl['type'] . '" from ' . $from);
227 $user = User::staticGet('jabber', $from);
229 $this->log(LOG_WARNING, 'Message from unknown user ' . $from);
232 if ($user->updatefrompresence) {
233 $this->log(LOG_INFO, 'Updating ' . $user->nickname .
234 ' status from presence.');
235 $this->add_notice($user, $pl);
242 function log($level, $msg) {
243 common_log($level, 'XMPPDaemon('.$this->resource.'): '.$msg);
246 function subscribed($to) {
247 jabber_special_presence('subscribed', $to);
250 function set_status($status) {
251 $this->log(LOG_INFO, 'Setting status to "' . $status . '"');
252 jabber_send_presence($status);
255 function top_queue_item() {
257 $qi = new Queue_item();
258 $qi->orderBy('created');
259 $qi->whereAdd('claimed is NULL');
263 $cnt = $qi->find(TRUE);
266 # XXX: potential race condition
267 # can we force it to only update if claimed is still NULL
269 $this->log(LOG_INFO, 'claiming queue item = ' . $qi->notice_id);
271 $qi->claimed = DB_DataObject_Cast::dateTime();
272 $result = $qi->update($orig);
274 $this->log(LOG_INFO, 'claim succeeded.');
277 $this->log(LOG_INFO, 'claim failed.');
284 function broadcast_queue() {
285 $this->clear_old_claims();
286 $this->log(LOG_INFO, 'checking for queued notices');
288 $qi = $this->top_queue_item();
290 $this->log(LOG_INFO, 'Got item enqueued '.common_exact_date($qi->created));
291 $notice = Notice::staticGet($qi->notice_id);
293 $this->log(LOG_INFO, 'broadcasting notice ID = ' . $notice->id);
294 # XXX: what to do if broadcast fails?
295 $result = common_real_broadcast($notice, $this->is_remote($notice));
297 $this->log(LOG_WARNING, 'Failed broadcast for notice ID = ' . $notice->id);
301 $this->log(LOG_WARNING, 'Abandoned claim for notice ID = ' . $notice->id);
304 $this->log(LOG_INFO, 'finished broadcasting notice ID = ' . $notice->id);
307 $this->log(LOG_WARNING, 'queue item for notice that does not exist');
314 function clear_old_claims() {
315 $qi = new Queue_item();
316 $qi->whereAdd('now() - claimed > '.CLAIM_TIMEOUT);
317 $qi->update(DB_DATAOBJECT_WHEREADD_ONLY);
320 function is_remote($notice) {
321 $user = User::staticGet($notice->profile_id);
325 function confirmation_queue() {
326 $this->clear_old_confirm_claims();
327 $this->log(LOG_INFO, 'checking for queued confirmations');
329 $confirm = $this->next_confirm();
331 $this->log(LOG_INFO, 'Sending confirmation for ' . $confirm->address);
332 $user = User::staticGet($confirm->user_id);
334 $this->log(LOG_WARNING, 'Confirmation for unknown user ' . $confirm->user_id);
338 $success = jabber_confirm_address($confirm->code,
342 $this->log(LOG_ERROR, 'Confirmation failed for ' . $confirm->address);
343 # Just let the claim age out; hopefully things work then
346 $this->log(LOG_INFO, 'Confirmation sent for ' . $confirm->address);
347 # Mark confirmation sent
348 $original = clone($confirm);
349 $confirm->sent = DB_DataObject_Cast::dateTime();
350 $result = $confirm->update($original);
352 $this->log(LOG_ERROR, 'Cannot mark sent for ' . $confirm->address);
353 # Just let the claim age out; hopefully things work then
361 function next_confirm() {
362 $confirm = new Confirm_address();
363 $confirm->sent = NULL;
364 $confirm->claimed = NULL;
365 $confirm->orderBy('modified DESC');
367 if ($confirm->find(TRUE)) {
368 $this->log(LOG_INFO, 'Claiming confirmation for ' . $confirm->address);
369 $original = clone($confirm);
370 $confirm->claimed = DB_DataObject_Cast::dateTime();
371 $result = $confirm->update($original);
373 $this->log(LOG_INFO, 'Succeeded in claim!');
376 $this->log(LOG_INFO, 'Failed in claim!');
383 function clear_old_confirm_claims() {
384 $confirm = new Confirm();
385 $confirm->whereAdd('now() - claimed > '.CLAIM_TIMEOUT);
386 $confirm->update(DB_DATAOBJECT_WHEREADD_ONLY);
391 $resource = ($argc > 1) ? $argv[1] : NULL;
393 $daemon = new XMPPDaemon($resource);
395 if ($daemon->connect()) {
396 $daemon->set_status("Send me a message to post a notice");