We are no longer offering accounts on this server. Consider https://gitlab.freedesktop.org/ as a place to host projects.

xmppdaemon.php 12.1 KB
Newer Older
1
#!/usr/bin/env php
2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20
<?php
/*
 * Laconica - a distributed open-source microblogging tool
 * Copyright (C) 2008, Controlez-Vous, Inc.
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Affero General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU Affero General Public License for more details.
 *
 * You should have received a copy of the GNU Affero General Public License
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
 */

Evan Prodromou's avatar
Evan Prodromou committed
21
function xmppdaemon_error_handler($errno, $errstr, $errfile, $errline, $errcontext) {
22 23
    switch ($errno) {
     case E_USER_ERROR:
24
	echo "ERROR: [$errno] $errstr\n";
25
	echo "  Fatal error on line $errline in file $errfile";
26 27
	echo ", PHP " . PHP_VERSION . " (" . PHP_OS . ")\n";
	echo "Aborting...\n";
28 29 30 31
	exit(1);
	break;
	
     case E_USER_WARNING:
32
	echo "WARNING [$errno] $errstr\n";
33 34 35
	break;
	
     case E_USER_NOTICE:
36
	echo "My NOTICE [$errno] $errstr\n";
37 38 39
	break;
	
     default:
40
	echo "Unknown error type: [$errno] $errstr\n";
41 42 43 44 45
	break;
    }
    
    /* Don't execute PHP internal error handler */
    return true;
Evan Prodromou's avatar
Evan Prodromou committed
46 47 48 49
}

set_error_handler('xmppdaemon_error_handler');

50 51 52 53 54 55
# Abort if called from a web server
if (isset($_SERVER) && array_key_exists('REQUEST_METHOD', $_SERVER)) {
	print "This script must be run from the command line\n";
	exit();
}

56 57 58 59
define('INSTALLDIR', dirname(__FILE__));
define('LACONICA', true);

require_once(INSTALLDIR . '/lib/common.php');
60
require_once(INSTALLDIR . '/lib/jabber.php');
61

Evan Prodromou's avatar
Evan Prodromou committed
62 63 64 65
# This is kind of clunky; we create a class to call the global functions
# in jabber.php, which create a new XMPP class. A more elegant (?) solution
# might be to use make this a subclass of XMPP.

66
class XMPPDaemon {
67

Evan Prodromou's avatar
Evan Prodromou committed
68
	function XMPPDaemon($resource=NULL) {
69
		static $attrs = array('server', 'port', 'user', 'password', 'host');
Evan Prodromou's avatar
Evan Prodromou committed
70 71 72

		foreach ($attrs as $attr)
		{
73 74
			$this->$attr = common_config('xmpp', $attr);
		}
Evan Prodromou's avatar
Evan Prodromou committed
75 76 77

		if ($resource) {
			$this->resource = $resource;
78 79
		} else {
			$this->resource = common_config('xmpp', 'resource') . 'daemon';
Evan Prodromou's avatar
Evan Prodromou committed
80
		}
81 82

		$this->log(LOG_INFO, "{$this->user}@{$this->server}/{$this->resource}");
83 84 85
	}

	function connect() {
86

87 88 89 90 91 92
		$connect_to = ($this->host) ? $this->host : $this->server;

		$this->log(LOG_INFO, "Connecting to $connect_to on port $this->port");

		$this->conn = jabber_connect($this->resource);

93 94 95
		if (!$this->conn) {
			return false;
		}
96
	    
97
		return !$this->conn->isDisconnected();
98
	}
99

100
	function handle() {
101 102 103 104

		static $parts = array('message', 'presence',
							  'end_stream', 'session_start');

105
		while(!$this->conn->isDisconnected()) {
106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122

			$payloads = $this->conn->processUntil($parts, 10);

			if ($payloads) {
				foreach($payloads as $event) {
					$pl = $event[1];
					switch($event[0]) {
					 case 'message':
						$this->handle_message($pl);
						break;
					 case 'presence':
						$this->handle_presence($pl);
						break;
					 case 'session_start':
						$this->handle_session($pl);
						break;
					}
123 124
				}
			}
125 126

			$this->broadcast_queue();
Evan Prodromou's avatar
Evan Prodromou committed
127
			$this->confirmation_queue();
128 129
		}
	}
Evan Prodromou's avatar
Evan Prodromou committed
130 131 132 133 134 135
	
	function handle_session($pl) {
		# XXX what to do here?
		return true;
	}
	
136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151
	function get_user($from) {
		$user = User::staticGet('jabber', jabber_normalize_jid($from));
		return $user;
	}

	function get_confirmation($from) {
		$confirm = new Confirm_address();
		$confirm->address = $from;
		$confirm->address_type = 'jabber';
		if ($confirm->find(TRUE)) {
			return $confirm;
		} else {
			return NULL;
		}
	}

152
	function handle_message(&$pl) {
Evan Prodromou's avatar
Evan Prodromou committed
153 154 155 156 157 158
		if ($pl['type'] != 'chat') {
			return;
		}
		if (strlen($pl['body']) == 0) {
			return;
		}
Evan Prodromou's avatar
Evan Prodromou committed
159 160 161 162

		$from = jabber_normalize_jid($pl['from']);
		$user = $this->get_user($from);

163
		if (!$user) {
164
			$this->from_site($from, 'Unknown user; go to ' .
165 166
							 common_local_url('imsettings') .
							 ' to add your address to your account');
167
			$this->log(LOG_WARNING, 'Message from unknown user ' . $from);
168 169 170 171
			return;
		}
		if ($this->handle_command($user, $pl['body'])) {
			return;
Evan Prodromou's avatar
Evan Prodromou committed
172 173 174
		} else if ($this->is_autoreply($pl['body'])) {
			$this->log(LOG_INFO, 'Ignoring auto reply from ' . $from);
			return;
175 176 177 178 179
		} else {
			$this->add_notice($user, $pl);
		}
	}

Evan Prodromou's avatar
Evan Prodromou committed
180 181 182 183 184 185 186 187
	function is_autoreply($txt) {
		if (preg_match('/[\[\(]?[Aa]uto-?[Rr]eply[\]\)]/', $txt)) {
			return true;
		} else {
			return false;
		}
	}
	
188 189 190 191
	function from_site($address, $msg) {
		$text = '['.common_config('site', 'name') . '] ' . $msg;
		jabber_send_message($address, $text);
	}
192

193 194 195 196 197
	function handle_command($user, $body) {
		# XXX: localise
		switch(trim($body)) {
		 case 'on':
			$this->set_notify($user, true);
198
			$this->from_site($user->jabber, 'notifications on');
199 200 201
			return true;
		 case 'off':
			$this->set_notify($user, false);
202
			$this->from_site($user->jabber, 'notifications off');
203 204 205 206 207
			return true;
		 default:
			return false;
		}
	}
208 209 210 211 212 213 214

	function set_notify(&$user, $notify) {
		$orig = clone($user);
		$user->jabbernotify = $notify;
		$result = $user->update($orig);
		if (!$id) {
			$last_error = &PEAR::getStaticProperty('DB_DataObject','lastError');
Evan Prodromou's avatar
Evan Prodromou committed
215
			$this->log(LOG_ERR,
216
					   'Could not set notify flag to ' . $notify .
217
					   ' for user ' . common_log_objstring($user) .
218 219 220 221 222 223
					   ': ' . $last_error->message);
		} else {
			$this->log(LOG_INFO,
					   'User ' . $user->nickname . ' set notify flag to ' . $notify);
		}
	}
224

225 226
	function add_notice(&$user, &$pl) {
		$notice = new Notice();
227
		$notice->is_local = 1;
228 229
		$notice->profile_id = $user->id;
		$notice->content = trim(substr($pl['body'], 0, 140));
230
		$notice->rendered = common_render_content($notice->content, $notice);
231 232 233 234 235
		$notice->created = DB_DataObject_Cast::dateTime();
		$notice->query('BEGIN');
		$id = $notice->insert();
		if (!$id) {
			$last_error = &PEAR::getStaticProperty('DB_DataObject','lastError');
Evan Prodromou's avatar
Evan Prodromou committed
236
			$this->log(LOG_ERR,
237 238
					   'Could not insert ' . common_log_objstring($notice) .
					   ' for user ' . common_log_objstring($user) .
239 240 241 242 243 244 245 246
					   ': ' . $last_error->message);
			return;
		}
		$orig = clone($notice);
		$notice->uri = common_notice_uri($notice);
		$result = $notice->update($orig);
		if (!$result) {
			$last_error = &PEAR::getStaticProperty('DB_DataObject','lastError');
Evan Prodromou's avatar
Evan Prodromou committed
247
			$this->log(LOG_ERR,
248 249
					   'Could not add URI to ' . common_log_objstring($notice) .
					   ' for user ' . common_log_objstring($user) .
250 251 252
					   ': ' . $last_error->message);
			return;
		}
253
		$notice->query('COMMIT');
254
        common_save_replies($notice);	
255
		common_real_broadcast($notice);
256 257
		$this->log(LOG_INFO,
				   'Added notice ' . $notice->id . ' from user ' . $user->nickname);
258
	}
259

260
	function handle_presence(&$pl) {
Evan Prodromou's avatar
Evan Prodromou committed
261
		$from = jabber_normalize_jid($pl['from']);
262
		switch ($pl['type']) {
263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278
		 case 'subscribe':
			# We let anyone subscribe
			$this->subscribed($from);
			$this->log(LOG_INFO,
					   'Accepted subscription from ' . $from);
			break;
		 case 'subscribed':
		 case 'unsubscribed':
		 case 'unsubscribe':
			$this->log(LOG_INFO,
					   'Ignoring  "' . $pl['type'] . '" from ' . $from);
			break;
		 default:
			if (!$pl['type']) {
				$user = User::staticGet('jabber', $from);
				if (!$user) {
279
					$this->log(LOG_WARNING, 'Presence from unknown user ' . $from);
280
					return;
281
				}
282 283 284 285 286 287 288
				if ($user->updatefrompresence) {
					$this->log(LOG_INFO, 'Updating ' . $user->nickname .
							   ' status from presence.');
					$this->add_notice($user, $pl);
				}
			}
			break;
289 290
		}
	}
291

292 293 294
	function log($level, $msg) {
		common_log($level, 'XMPPDaemon('.$this->resource.'): '.$msg);
	}
295 296

	function subscribed($to) {
297
		jabber_special_presence('subscribed', $to);
298 299
	}

300
	function set_status($status) {
Evan Prodromou's avatar
Evan Prodromou committed
301
		$this->log(LOG_INFO, 'Setting status to "' . $status . '"');
302
		jabber_send_presence($status);
303
	}
304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339

	function top_queue_item() {

		$qi = new Queue_item();
		$qi->orderBy('created');
		$qi->whereAdd('claimed is NULL');

		$qi->limit(1);

		$cnt = $qi->find(TRUE);

		if ($cnt) {
			# XXX: potential race condition
			# can we force it to only update if claimed is still NULL
			# (or old)?
			$this->log(LOG_INFO, 'claiming queue item = ' . $qi->notice_id);
			$orig = clone($qi);
			$qi->claimed = DB_DataObject_Cast::dateTime();
			$result = $qi->update($orig);
			if ($result) {
				$this->log(LOG_INFO, 'claim succeeded.');
				return $qi;
			} else {
				$this->log(LOG_INFO, 'claim failed.');
			}
		}
		$qi = NULL;
		return NULL;
	}

	function broadcast_queue() {
		$this->clear_old_claims();
		$this->log(LOG_INFO, 'checking for queued notices');
		do {
			$qi = $this->top_queue_item();
			if ($qi) {
Evan Prodromou's avatar
Evan Prodromou committed
340
				$this->log(LOG_INFO, 'Got item enqueued '.common_exact_date($qi->created));
341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365
				$notice = Notice::staticGet($qi->notice_id);
				if ($notice) {
					$this->log(LOG_INFO, 'broadcasting notice ID = ' . $notice->id);
					# XXX: what to do if broadcast fails?
					$result = common_real_broadcast($notice, $this->is_remote($notice));
					if (!$result) {
						$this->log(LOG_WARNING, 'Failed broadcast for notice ID = ' . $notice->id);
						$orig = $qi;
						$qi->claimed = NULL;
						$qi->update($orig);
						$this->log(LOG_WARNING, 'Abandoned claim for notice ID = ' . $notice->id);
						continue;
					}
					$this->log(LOG_INFO, 'finished broadcasting notice ID = ' . $notice->id);
					$notice = NULL;
				} else {
					$this->log(LOG_WARNING, 'queue item for notice that does not exist');
				}
				$qi->delete();
			}
		} while ($qi);
	}

	function clear_old_claims() {
		$qi = new Queue_item();
366
	        $qi->claimed = NULL;
367 368 369 370 371 372 373 374
		$qi->whereAdd('now() - claimed > '.CLAIM_TIMEOUT);
		$qi->update(DB_DATAOBJECT_WHEREADD_ONLY);
	}

	function is_remote($notice) {
		$user = User::staticGet($notice->profile_id);
		return !$user;
	}
375 376
	
	function confirmation_queue() {
Evan Prodromou's avatar
Evan Prodromou committed
377
	    # $this->clear_old_confirm_claims();
378 379 380 381 382 383 384 385 386 387 388
		$this->log(LOG_INFO, 'checking for queued confirmations');
		do {
			$confirm = $this->next_confirm();
			if ($confirm) {
				$this->log(LOG_INFO, 'Sending confirmation for ' . $confirm->address);
				$user = User::staticGet($confirm->user_id);
				if (!$user) {
					$this->log(LOG_WARNING, 'Confirmation for unknown user ' . $confirm->user_id);
					continue;
				}
				$success = jabber_confirm_address($confirm->code,
Evan Prodromou's avatar
Evan Prodromou committed
389 390
								  $user->nickname,
								  $confirm->address);
391
				if (!$success) {
Evan Prodromou's avatar
Evan Prodromou committed
392
					$this->log(LOG_ERR, 'Confirmation failed for ' . $confirm->address);
393 394 395 396 397 398
					# Just let the claim age out; hopefully things work then
					continue;
				} else {
					$this->log(LOG_INFO, 'Confirmation sent for ' . $confirm->address);
					# Mark confirmation sent
					$original = clone($confirm);
399
					$confirm->sent = $confirm->claimed;
400 401
					$result = $confirm->update($original);
					if (!$result) {
Evan Prodromou's avatar
Evan Prodromou committed
402
						$this->log(LOG_ERR, 'Cannot mark sent for ' . $confirm->address);
403 404 405 406 407 408 409 410 411 412
						# Just let the claim age out; hopefully things work then
						continue;
					}
				}
			}
		} while ($confirm);
	}
	
	function next_confirm() {
		$confirm = new Confirm_address();
Evan Prodromou's avatar
Evan Prodromou committed
413
		$confirm->whereAdd('claimed IS NULL');
414
		$confirm->whereAdd('sent IS NULL');
415 416
		# XXX: eventually we could do other confirmations in the queue, too
		$confirm->address_type = 'jabber';
417 418 419 420
		$confirm->orderBy('modified DESC');
		$confirm->limit(1);
		if ($confirm->find(TRUE)) {
			$this->log(LOG_INFO, 'Claiming confirmation for ' . $confirm->address);
421 422 423
		        # working around some weird DB_DataObject behaviour
			$confirm->whereAdd(''); # clears where stuff
		        $original = clone($confirm);
424 425 426
			$confirm->claimed = DB_DataObject_Cast::dateTime();
			$result = $confirm->update($original);
			if ($result) {
427
				$this->log(LOG_INFO, 'Succeeded in claim! '. $result);
428 429 430 431 432 433 434 435 436 437 438
				return $confirm;
			} else {
				$this->log(LOG_INFO, 'Failed in claim!');
				return false;
			}
		}
		return NULL;
	}
	
	function clear_old_confirm_claims() {
		$confirm = new Confirm();
439
	        $confirm->claimed = NULL;
440 441 442 443
		$confirm->whereAdd('now() - claimed > '.CLAIM_TIMEOUT);
		$confirm->update(DB_DATAOBJECT_WHEREADD_ONLY);
	}
	
444 445
}

446 447 448
$resource = ($argc > 1) ? $argv[1] : NULL;

$daemon = new XMPPDaemon($resource);
449

Evan Prodromou's avatar
Evan Prodromou committed
450
if ($daemon->connect()) {
451
	$daemon->set_status("Send me a message to post a notice");
Evan Prodromou's avatar
Evan Prodromou committed
452 453
	$daemon->handle();
}
Evan Prodromou's avatar
Evan Prodromou committed
454

455
?>