gnu-social/scripts/xmppdaemon.php
nick 491af90fa7 XMPP Direct Messaging / Last notice
Direct messaging now works under XMPP, the command syntax is 'd $nick
$message'. Also, a command to fetch a users last notice is in there
('last $nick'). Notification of the recipient of a message is not yet
supported.

darcs-hash:20081003011145-29929-9fce5057066d0d223a0d01c1708df072d91b0e63.gz
2008-10-02 21:11:45 -04:00

415 lines
11 KiB
PHP
Executable File

#!/usr/bin/env php
<?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/>.
*/
# 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();
}
define('INSTALLDIR', realpath(dirname(__FILE__) . '/..'));
define('LACONICA', true);
require_once(INSTALLDIR . '/lib/common.php');
require_once(INSTALLDIR . '/lib/jabber.php');
require_once(INSTALLDIR . '/lib/daemon.php');
set_error_handler('common_error_handler');
# 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.
class XMPPDaemon extends Daemon {
function XMPPDaemon($resource=NULL) {
static $attrs = array('server', 'port', 'user', 'password', 'host');
foreach ($attrs as $attr)
{
$this->$attr = common_config('xmpp', $attr);
}
if ($resource) {
$this->resource = $resource;
} else {
$this->resource = common_config('xmpp', 'resource') . 'daemon';
}
$this->log(LOG_INFO, "INITIALIZE XMPPDaemon {$this->user}@{$this->server}/{$this->resource}");
}
function connect() {
$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);
if (!$this->conn) {
return false;
}
$this->conn->setReconnectTimeout(600);
jabber_send_presence("Send me a message to post a notice", 'available',
NULL, 'available', 100);
return !$this->conn->isDisconnected();
}
function name() {
return strtolower('xmppdaemon.'.$this->resource);
}
function run() {
if ($this->connect()) {
$this->conn->addEventHandler('message', 'handle_message', $this);
$this->conn->addEventHandler('presence', 'handle_presence', $this);
$this->conn->addEventHandler('reconnect', 'handle_reconnect', $this);
$this->conn->process();
}
}
function handle_reconnect(&$pl) {
$this->conn->processUntil('session_start');
$this->conn->presence('Send me a message to post a notice', 'available', NULL, 'available', 100);
}
function get_user($from) {
$user = User::staticGet('jabber', jabber_normalize_jid($from));
return $user;
}
function handle_message(&$pl) {
if ($pl['type'] != 'chat') {
return;
}
if (mb_strlen($pl['body']) == 0) {
return;
}
$from = jabber_normalize_jid($pl['from']);
# Forwarded from another daemon (probably a broadcaster) for
# us to handle
if ($this->is_self($from)) {
$from = $this->get_ofrom($pl);
if (is_null($from) || $this->is_self($from)) {
return;
}
}
$user = $this->get_user($from);
if (!$user) {
$this->from_site($from, 'Unknown user; go to ' .
common_local_url('imsettings') .
' to add your address to your account');
$this->log(LOG_WARNING, 'Message from unknown user ' . $from);
return;
}
if ($this->handle_command($user, $pl['body'])) {
return;
} else if ($this->is_autoreply($pl['body'])) {
$this->log(LOG_INFO, 'Ignoring auto reply from ' . $from);
return;
} else if ($this->is_otr($pl['body'])) {
$this->log(LOG_INFO, 'Ignoring OTR from ' . $from);
return;
} else if ($this->is_direct($pl['body'])) {
preg_match_all('/d[\ ]*([a-z0-9]{1,64})/', $pl['body'], $to);
$to = preg_replace('/^d([\ ])*/', '', $to[0][0]);
$body = preg_replace('/d[\ ]*('. $to .')[\ ]*/', '', $pl['body']);
$this->add_direct($user, $body, $to, $from);
} else {
$len = mb_strlen($pl['body']);
if($len > 140) {
$this->from_site($from, 'Message too long - maximum is 140 characters, you sent ' . $len);
return;
}
$this->add_notice($user, $pl);
}
$user->free();
unset($user);
}
function is_self($from) {
return preg_match('/^'.strtolower(jabber_daemon_address()).'/', strtolower($from));
}
function get_ofrom($pl) {
$xml = $pl['raw'];
$addresses = $xml->sub('addresses');
if (!$addresses) {
$this->log(LOG_WARNING, 'Forwarded message without addresses');
return NULL;
}
$address = $addresses->sub('address');
if (!$address) {
$this->log(LOG_WARNING, 'Forwarded message without address');
return NULL;
}
if (!array_key_exists('type', $address->attrs)) {
$this->log(LOG_WARNING, 'No type for forwarded message');
return NULL;
}
$type = $address->attrs['type'];
if ($type != 'ofrom') {
$this->log(LOG_WARNING, 'Type of forwarded message is not ofrom');
return NULL;
}
if (!array_key_exists('jid', $address->attrs)) {
$this->log(LOG_WARNING, 'No jid for forwarded message');
return NULL;
}
$jid = $address->attrs['jid'];
if (!$jid) {
$this->log(LOG_WARNING, 'Could not get jid from address');
return NULL;
}
$this->log(LOG_DEBUG, 'Got message forwarded from jid ' . $jid);
return $jid;
}
function is_autoreply($txt) {
if (preg_match('/[\[\(]?[Aa]uto-?[Rr]eply[\]\)]/', $txt)) {
return true;
} else {
return false;
}
}
function is_otr($txt) {
if (preg_match('/^\?OTR/', $txt)) {
return true;
} else {
return false;
}
}
function is_direct($txt) {
if (strtolower(substr($txt, 0, 2))=='d ') {
return true;
} else {
return false;
}
}
function from_site($address, $msg) {
$text = '['.common_config('site', 'name') . '] ' . $msg;
jabber_send_message($address, $text);
}
function handle_command($user, $body) {
# XXX: localise
$p=explode(' ',$body);
if(count($p)>2)
return false;
switch($p[0]) {
case 'help':
if(count($p)!=1)
return false;
$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\n d - direct message to user\n");
return true;
case 'on':
if(count($p)!=1)
return false;
$this->set_notify($user, true);
$this->from_site($user->jabber, 'notifications on');
return true;
case 'off':
if(count($p)!=1)
return false;
$this->set_notify($user, false);
$this->from_site($user->jabber, 'notifications off');
return true;
case 'sub':
if(count($p)==1) {
$this->from_site($user->jabber, 'Specify the name of the user to subscribe to');
return true;
}
$result=subs_subscribe_user($user, $p[1]);
if($result=='true')
$this->from_site($user->jabber, 'Subscribed to ' . $p[1]);
else
$this->from_site($user->jabber, $result);
return true;
case 'unsub':
if(count($p)==1) {
$this->from_site($user->jabber, 'Specify the name of the user to unsubscribe from');
return true;
}
$result=subs_unsubscribe_user($user, $p[1]);
if($result=='true')
$this->from_site($user->jabber, 'Unsubscribed from ' . $p[1]);
else
$this->from_site($user->jabber, $result);
return true;
case 'last':
if(count($p)==1) {
# I think this might be AWFUL english
$this->from_site($user->jabber, 'Specify the name of the user to get the last notice of');
return true;
}
$this->get_last($user, $p[1], $user->jabber);
return true;
default:
return false;
}
}
function set_notify(&$user, $notify) {
$orig = clone($user);
$user->jabbernotify = $notify;
$result = $user->update($orig);
if (!$result) {
$last_error = &PEAR::getStaticProperty('DB_DataObject','lastError');
$this->log(LOG_ERR,
'Could not set notify flag to ' . $notify .
' for user ' . common_log_objstring($user) .
': ' . $last_error->message);
} else {
$this->log(LOG_INFO,
'User ' . $user->nickname . ' set notify flag to ' . $notify);
}
}
function add_notice(&$user, &$pl) {
$notice = Notice::saveNew($user->id, trim(mb_substr($pl['body'], 0, 140)), 'xmpp');
if (is_string($notice)) {
$this->log(LOG_ERR, $notice);
return;
}
common_broadcast_notice($notice);
$this->log(LOG_INFO,
'Added notice ' . $notice->id . ' from user ' . $user->nickname);
$notice->free();
unset($notice);
}
function get_last(&$user, $target_nickname, $from) {
$target = User::staticGet('nickname', $target_nickname);
if (!$target) {
$this->from_site($from,_('No such user.'));
return;
}
$notice = $target->getCurrentNotice();
if (!$notice) {
$this->from_site($from, "User has no last notice");
return;
}
$notice_content = $notice->content;
$this->from_site($from, $target_nickname . ": " . $notice_content);
}
function add_direct(&$user, $body, $to, $from) {
$other = User::staticGet('nickname', $to);
$this->log(LOG_INFO, 'Direct message to' . $to);
$len = mb_strlen($body);
if ($len == 0) {
$this->from_site($from, _('No content!'));
return;
} else if ($len > 140) {
$this->from_site($from, 'Message too long - maximum is 140 characters, you sent ' . $len);
return;
} else if (!$other) {
$this->from_site($from,_('No such user.'));
return;
} else if (!$user->mutuallySubscribed($other)) {
$this->from_site($from, _('You can\'t send a message to this user.'));
return;
} else if ($user->id == $other->id) {
$this->from_site($from, _('Don\'t send a message to yourself; just say it to yourself quietly instead.'));
return;
}
$this->from_site($from, "Direct message to " . $to . " sent");
$message = Message::saveNew($user->id, $other->id, $body, 'xmpp');
# XXX : Need to notify the other person
}
function handle_presence(&$pl) {
$from = jabber_normalize_jid($pl['from']);
switch ($pl['type']) {
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) {
$this->log(LOG_WARNING, 'Presence from unknown user ' . $from);
return;
}
if ($user->updatefrompresence) {
$this->log(LOG_INFO, 'Updating ' . $user->nickname .
' status from presence.');
$this->add_notice($user, $pl);
}
$user->free();
unset($user);
}
break;
}
}
function log($level, $msg) {
common_log($level, 'XMPPDaemon('.$this->resource.'): '.$msg);
}
function subscribed($to) {
jabber_special_presence('subscribed', $to);
}
}
ini_set("max_execution_time", "0");
ini_set("max_input_time", "0");
set_time_limit(0);
mb_internal_encoding('UTF-8');
$resource = ($argc > 1) ? $argv[1] : (common_config('xmpp','resource') . '-listen');
$daemon = new XMPPDaemon($resource);
$daemon->runOnce();