reformat lib/jabber.php for phpcs, including doc comments
darcs-hash:20081222173249-84dde-202ba409e32e2b27089a1bc5431507c9d8a2782e.gz
This commit is contained in:
Evan Prodromou
parent
5d76234a60
commit
8cd89d80f1
@ -29,4 +29,6 @@ Evan Prodromou <evan@prodromou.name>**20081221003955]
|
|||||||
[reformat lib/daemon.php for phpcs
|
[reformat lib/daemon.php for phpcs
|
||||||
Evan Prodromou <evan@prodromou.name>**20081221004607]
|
Evan Prodromou <evan@prodromou.name>**20081221004607]
|
||||||
[reformat for phpcs
|
[reformat for phpcs
|
||||||
Evan Prodromou <evan@prodromou.name>**20081221005837]
|
Evan Prodromou <evan@prodromou.name>**20081221005837]
|
||||||
|
[reformat lib/jabber.php for phpcs, including doc comments
|
||||||
|
Evan Prodromou <evan@prodromou.name>**20081222173249]
|
||||||
Binary file not shown.
@ -1,9 +1,12 @@
|
|||||||
<?php
|
<?php
|
||||||
/*
|
/**
|
||||||
* Laconica - a distributed open-source microblogging tool
|
* Laconica, the distributed open-source microblogging tool
|
||||||
* Copyright (C) 2008, Controlez-Vous, Inc.
|
|
||||||
*
|
*
|
||||||
* This program is free software: you can redistribute it and/or modify
|
* utility functions for Jabber/GTalk/XMPP messages
|
||||||
|
*
|
||||||
|
* PHP version 5
|
||||||
|
*
|
||||||
|
* LICENCE: 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
|
* 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
|
* the Free Software Foundation, either version 3 of the License, or
|
||||||
* (at your option) any later version.
|
* (at your option) any later version.
|
||||||
@ -15,286 +18,448 @@
|
|||||||
*
|
*
|
||||||
* You should have received a copy of the GNU Affero General Public License
|
* 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/>.
|
* along with this program. If not, see <http://www.gnu.org/licenses/>.
|
||||||
|
*
|
||||||
|
* @category Network
|
||||||
|
* @package Laconica
|
||||||
|
* @author Evan Prodromou <evan@controlyourself.ca>
|
||||||
|
* @copyright 2008 Control Yourself, Inc.
|
||||||
|
* @license http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
|
||||||
|
* @link http://laconi.ca/
|
||||||
*/
|
*/
|
||||||
|
|
||||||
if (!defined('LACONICA')) { exit(1); }
|
if (!defined('LACONICA')) {
|
||||||
|
exit(1);
|
||||||
require_once('XMPPHP/XMPP.php');
|
|
||||||
|
|
||||||
function jabber_valid_base_jid($jid) {
|
|
||||||
# Cheap but effective
|
|
||||||
return Validate::email($jid);
|
|
||||||
}
|
}
|
||||||
|
|
||||||
function jabber_normalize_jid($jid) {
|
require_once 'XMPPHP/XMPP.php';
|
||||||
if (preg_match("/(?:([^\@]+)\@)?([^\/]+)(?:\/(.*))?$/", $jid, $matches)) {
|
|
||||||
$node = $matches[1];
|
|
||||||
$server = $matches[2];
|
|
||||||
return strtolower($node.'@'.$server);
|
|
||||||
} else {
|
|
||||||
return NULL;
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
function jabber_daemon_address() {
|
/**
|
||||||
return common_config('xmpp', 'user') . '@' . common_config('xmpp', 'server');
|
* checks whether a string is a syntactically valid Jabber ID (JID)
|
||||||
}
|
*
|
||||||
|
* @param string $jid string to check
|
||||||
|
*
|
||||||
|
* @return boolean whether the string is a valid JID
|
||||||
|
*/
|
||||||
|
|
||||||
function jabber_connect($resource=NULL) {
|
function jabber_valid_base_jid($jid)
|
||||||
static $conn = NULL;
|
|
||||||
if (!$conn) {
|
|
||||||
$conn = new XMPPHP_XMPP(common_config('xmpp', 'host') ?
|
|
||||||
common_config('xmpp', 'host') :
|
|
||||||
common_config('xmpp', 'server'),
|
|
||||||
common_config('xmpp', 'port'),
|
|
||||||
common_config('xmpp', 'user'),
|
|
||||||
common_config('xmpp', 'password'),
|
|
||||||
($resource) ? $resource :
|
|
||||||
common_config('xmpp', 'resource'),
|
|
||||||
common_config('xmpp', 'server'),
|
|
||||||
common_config('xmpp', 'debug') ?
|
|
||||||
true : false,
|
|
||||||
common_config('xmpp', 'debug') ?
|
|
||||||
XMPPHP_Log::LEVEL_VERBOSE : NULL
|
|
||||||
);
|
|
||||||
|
|
||||||
if (!$conn) {
|
|
||||||
return false;
|
|
||||||
}
|
|
||||||
|
|
||||||
$conn->autoSubscribe();
|
|
||||||
$conn->useEncryption(common_config('xmpp', 'encryption'));
|
|
||||||
|
|
||||||
try {
|
|
||||||
$conn->connect(true); # true = persistent connection
|
|
||||||
} catch (XMPPHP_Exception $e) {
|
|
||||||
common_log(LOG_ERROR, $e->getMessage());
|
|
||||||
return false;
|
|
||||||
}
|
|
||||||
|
|
||||||
$conn->processUntil('session_start');
|
|
||||||
}
|
|
||||||
return $conn;
|
|
||||||
}
|
|
||||||
|
|
||||||
function jabber_send_notice($to, $notice) {
|
|
||||||
$conn = jabber_connect();
|
|
||||||
if (!$conn) {
|
|
||||||
return false;
|
|
||||||
}
|
|
||||||
$profile = Profile::staticGet($notice->profile_id);
|
|
||||||
if (!$profile) {
|
|
||||||
common_log(LOG_WARNING, 'Refusing to send notice with ' .
|
|
||||||
'unknown profile ' . common_log_objstring($notice),
|
|
||||||
__FILE__);
|
|
||||||
return false;
|
|
||||||
}
|
|
||||||
$msg = jabber_format_notice($profile, $notice);
|
|
||||||
$entry = jabber_format_entry($profile, $notice);
|
|
||||||
$conn->message($to, $msg, 'chat', NULL, $entry);
|
|
||||||
$profile->free();
|
|
||||||
return true;
|
|
||||||
}
|
|
||||||
|
|
||||||
# Extra stuff defined by Twitter, needed by twitter clients
|
|
||||||
|
|
||||||
function jabber_format_entry($profile, $notice) {
|
|
||||||
|
|
||||||
# FIXME: notice url might be remote
|
|
||||||
|
|
||||||
$noticeurl = common_local_url('shownotice',
|
|
||||||
array('notice' => $notice->id));
|
|
||||||
$msg = jabber_format_notice($profile, $notice);
|
|
||||||
$entry = "\n<entry xmlns='http://www.w3.org/2005/Atom'>\n";
|
|
||||||
$entry .= "<source>\n";
|
|
||||||
$entry .= "<title>" . $profile->nickname . " - " . common_config('site', 'name') . "</title>\n";
|
|
||||||
$entry .= "<link href='" . htmlspecialchars($profile->profileurl) . "'/>\n";
|
|
||||||
$entry .= "<link rel='self' type='application/rss+xml' href='" . common_local_url('userrss', array('nickname' => $profile->nickname)) . "'/>\n";
|
|
||||||
$entry .= "<author><name>" . $profile->nickname . "</name></author>\n";
|
|
||||||
$entry .= "<icon>" . common_profile_avatar_url($profile, AVATAR_PROFILE_SIZE) . "</icon>\n";
|
|
||||||
$entry .= "</source>\n";
|
|
||||||
$entry .= "<title>" . htmlspecialchars($msg) . "</title>\n";
|
|
||||||
$entry .= "<summary>" . htmlspecialchars($msg) . "</summary>\n";
|
|
||||||
$entry .= "<link rel='alternate' href='" . $noticeurl . "' />\n";
|
|
||||||
$entry .= "<id>". $notice->uri . "</id>\n";
|
|
||||||
$entry .= "<published>".common_date_w3dtf($notice->created)."</published>\n";
|
|
||||||
$entry .= "<updated>".common_date_w3dtf($notice->modified)."</updated>\n";
|
|
||||||
$entry .= "</entry>\n";
|
|
||||||
|
|
||||||
$html = "\n<html xmlns='http://jabber.org/protocol/xhtml-im'>\n";
|
|
||||||
$html .= "<body xmlns='http://www.w3.org/1999/xhtml'>\n";
|
|
||||||
$html .= "<a href='".htmlspecialchars($profile->profileurl)."'>".$profile->nickname."</a>: ";
|
|
||||||
$html .= ($notice->rendered) ? $notice->rendered : common_render_content($notice->content, $notice);
|
|
||||||
$html .= "\n</body>\n";
|
|
||||||
$html .= "\n</html>\n";
|
|
||||||
|
|
||||||
$address = "<addresses xmlns='http://jabber.org/protocol/address'>\n";
|
|
||||||
$address .= "<address type='replyto' jid='" . jabber_daemon_address() . "' />\n";
|
|
||||||
$address .= "</addresses>\n";
|
|
||||||
|
|
||||||
# FIXME: include a pubsub event, too.
|
|
||||||
|
|
||||||
return $html . $entry . $address;
|
|
||||||
}
|
|
||||||
|
|
||||||
function jabber_send_message($to, $body, $type='chat', $subject=NULL) {
|
|
||||||
$conn = jabber_connect();
|
|
||||||
if (!$conn) {
|
|
||||||
return false;
|
|
||||||
}
|
|
||||||
$conn->message($to, $body, $type, $subject);
|
|
||||||
return true;
|
|
||||||
}
|
|
||||||
|
|
||||||
function jabber_send_presence($status, $show='available', $to=NULL,
|
|
||||||
$type = 'available', $priority=NULL)
|
|
||||||
{
|
{
|
||||||
$conn = jabber_connect();
|
// Cheap but effective
|
||||||
if (!$conn) {
|
return Validate::email($jid);
|
||||||
return false;
|
|
||||||
}
|
|
||||||
$conn->presence($status, $show, $to, $type, $priority);
|
|
||||||
return true;
|
|
||||||
}
|
}
|
||||||
|
|
||||||
function jabber_confirm_address($code, $nickname, $address) {
|
/**
|
||||||
$body = 'User "' . $nickname . '" on ' . common_config('site', 'name') . ' ' .
|
* normalizes a Jabber ID for comparison
|
||||||
'has said that your Jabber ID belongs to them. ' .
|
*
|
||||||
'If that\'s true, you can confirm by clicking on this URL: ' .
|
* @param string $jid JID to check
|
||||||
common_local_url('confirmaddress', array('code' => $code)) .
|
*
|
||||||
' . (If you cannot click it, copy-and-paste it into the ' .
|
* @return string an equivalent JID in normalized (lowercase) form
|
||||||
'address bar of your browser). If that user isn\'t you, ' .
|
*/
|
||||||
'or if you didn\'t request this confirmation, just ignore this message.';
|
|
||||||
|
|
||||||
return jabber_send_message($address, $body);
|
function jabber_normalize_jid($jid)
|
||||||
|
{
|
||||||
|
if (preg_match("/(?:([^\@]+)\@)?([^\/]+)(?:\/(.*))?$/", $jid, $matches)) {
|
||||||
|
$node = $matches[1];
|
||||||
|
$server = $matches[2];
|
||||||
|
return strtolower($node.'@'.$server);
|
||||||
|
} else {
|
||||||
|
return null;
|
||||||
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
function jabber_special_presence($type, $to=NULL, $show=NULL, $status=NULL) {
|
/**
|
||||||
$conn = jabber_connect();
|
* the JID of the Jabber daemon for this Laconica instance
|
||||||
|
*
|
||||||
|
* @return string JID of the Jabber daemon
|
||||||
|
*/
|
||||||
|
|
||||||
$to = htmlspecialchars($to);
|
function jabber_daemon_address()
|
||||||
$status = htmlspecialchars($status);
|
{
|
||||||
$out = "<presence";
|
return common_config('xmpp', 'user') . '@' . common_config('xmpp', 'server');
|
||||||
if($to) $out .= " to='$to'";
|
|
||||||
if($type) $out .= " type='$type'";
|
|
||||||
if($show == 'available' and !$status) {
|
|
||||||
$out .= "/>";
|
|
||||||
} else {
|
|
||||||
$out .= ">";
|
|
||||||
if($show && ($show != 'available')) $out .= "<show>$show</show>";
|
|
||||||
if($status) $out .= "<status>$status</status>";
|
|
||||||
$out .= "</presence>";
|
|
||||||
}
|
|
||||||
$conn->send($out);
|
|
||||||
}
|
}
|
||||||
|
|
||||||
function jabber_broadcast_notice($notice) {
|
/**
|
||||||
|
* connect the configured Jabber account to the configured server
|
||||||
|
*
|
||||||
|
* @param string $resource Resource to connect (defaults to configured resource)
|
||||||
|
*
|
||||||
|
* @return XMPPHP connection to the configured server
|
||||||
|
*/
|
||||||
|
|
||||||
if (!common_config('xmpp', 'enabled')) {
|
function jabber_connect($resource=null)
|
||||||
return true;
|
{
|
||||||
}
|
static $conn = null;
|
||||||
$profile = Profile::staticGet($notice->profile_id);
|
if (!$conn) {
|
||||||
|
$conn = new XMPPHP_XMPP(common_config('xmpp', 'host') ?
|
||||||
|
common_config('xmpp', 'host') :
|
||||||
|
common_config('xmpp', 'server'),
|
||||||
|
common_config('xmpp', 'port'),
|
||||||
|
common_config('xmpp', 'user'),
|
||||||
|
common_config('xmpp', 'password'),
|
||||||
|
($resource) ? $resource :
|
||||||
|
common_config('xmpp', 'resource'),
|
||||||
|
common_config('xmpp', 'server'),
|
||||||
|
common_config('xmpp', 'debug') ?
|
||||||
|
true : false,
|
||||||
|
common_config('xmpp', 'debug') ?
|
||||||
|
XMPPHP_Log::LEVEL_VERBOSE : null
|
||||||
|
);
|
||||||
|
|
||||||
if (!$profile) {
|
if (!$conn) {
|
||||||
common_log(LOG_WARNING, 'Refusing to broadcast notice with ' .
|
return false;
|
||||||
'unknown profile ' . common_log_objstring($notice),
|
}
|
||||||
__FILE__);
|
|
||||||
return false;
|
|
||||||
}
|
|
||||||
|
|
||||||
$msg = jabber_format_notice($profile, $notice);
|
$conn->autoSubscribe();
|
||||||
$entry = jabber_format_entry($profile, $notice);
|
$conn->useEncryption(common_config('xmpp', 'encryption'));
|
||||||
|
|
||||||
$profile->free();
|
try {
|
||||||
unset($profile);
|
$conn->connect(true); // true = persistent connection
|
||||||
|
} catch (XMPPHP_Exception $e) {
|
||||||
|
common_log(LOG_ERROR, $e->getMessage());
|
||||||
|
return false;
|
||||||
|
}
|
||||||
|
|
||||||
$sent_to = array();
|
$conn->processUntil('session_start');
|
||||||
$conn = jabber_connect();
|
}
|
||||||
|
return $conn;
|
||||||
|
}
|
||||||
|
|
||||||
# First, get users to whom this is a direct reply
|
/**
|
||||||
$user = new User();
|
* send a single notice to a given Jabber address
|
||||||
$user->query('SELECT user.id, user.jabber ' .
|
*
|
||||||
'FROM user JOIN reply ON user.id = reply.profile_id ' .
|
* @param string $to JID to send the notice to
|
||||||
'WHERE reply.notice_id = ' . $notice->id . ' ' .
|
* @param Notice $notice notice to send
|
||||||
'AND user.jabber is not null ' .
|
*
|
||||||
'AND user.jabbernotify = 1 ' .
|
* @return boolean success value
|
||||||
'AND user.jabberreplies = 1 ');
|
*/
|
||||||
|
|
||||||
while ($user->fetch()) {
|
function jabber_send_notice($to, $notice)
|
||||||
common_log(LOG_INFO,
|
{
|
||||||
'Sending reply notice ' . $notice->id . ' to ' . $user->jabber,
|
$conn = jabber_connect();
|
||||||
__FILE__);
|
if (!$conn) {
|
||||||
$conn->message($user->jabber, $msg, 'chat', NULL, $entry);
|
return false;
|
||||||
$conn->processTime(0);
|
}
|
||||||
$sent_to[$user->id] = 1;
|
$profile = Profile::staticGet($notice->profile_id);
|
||||||
}
|
if (!$profile) {
|
||||||
|
common_log(LOG_WARNING, 'Refusing to send notice with ' .
|
||||||
|
'unknown profile ' . common_log_objstring($notice),
|
||||||
|
__FILE__);
|
||||||
|
return false;
|
||||||
|
}
|
||||||
|
$msg = jabber_format_notice($profile, $notice);
|
||||||
|
$entry = jabber_format_entry($profile, $notice);
|
||||||
|
$conn->message($to, $msg, 'chat', null, $entry);
|
||||||
|
$profile->free();
|
||||||
|
return true;
|
||||||
|
}
|
||||||
|
|
||||||
$user->free();
|
/**
|
||||||
|
* extra information for XMPP messages, as defined by Twitter
|
||||||
|
*
|
||||||
|
* @param Profile $profile Profile of the sending user
|
||||||
|
* @param Notice $notice Notice being sent
|
||||||
|
*
|
||||||
|
* @return string Extra information (Atom, HTML, addresses) in string format
|
||||||
|
*/
|
||||||
|
|
||||||
# Now, get users subscribed to this profile
|
function jabber_format_entry($profile, $notice)
|
||||||
|
{
|
||||||
|
// FIXME: notice url might be remote
|
||||||
|
|
||||||
$user = new User();
|
$noticeurl = common_local_url('shownotice',
|
||||||
$user->query('SELECT user.id, user.jabber ' .
|
array('notice' => $notice->id));
|
||||||
'FROM user JOIN subscription ON user.id = subscription.subscriber ' .
|
|
||||||
'WHERE subscription.subscribed = ' . $notice->profile_id . ' ' .
|
$msg = jabber_format_notice($profile, $notice);
|
||||||
'AND user.jabber is not null ' .
|
|
||||||
'AND user.jabbernotify = 1 ' .
|
$self_url = common_local_url('userrss', array('nickname' => $profile->nickname));
|
||||||
|
|
||||||
|
$entry = "\n<entry xmlns='http://www.w3.org/2005/Atom'>\n";
|
||||||
|
$entry .= "<source>\n";
|
||||||
|
$entry .= "<title>" . $profile->nickname . " - " . common_config('site', 'name') . "</title>\n";
|
||||||
|
$entry .= "<link href='" . htmlspecialchars($profile->profileurl) . "'/>\n";
|
||||||
|
$entry .= "<link rel='self' type='application/rss+xml' href='" . $self_url . "'/>\n";
|
||||||
|
$entry .= "<author><name>" . $profile->nickname . "</name></author>\n";
|
||||||
|
$entry .= "<icon>" . common_profile_avatar_url($profile, AVATAR_PROFILE_SIZE) . "</icon>\n";
|
||||||
|
$entry .= "</source>\n";
|
||||||
|
$entry .= "<title>" . htmlspecialchars($msg) . "</title>\n";
|
||||||
|
$entry .= "<summary>" . htmlspecialchars($msg) . "</summary>\n";
|
||||||
|
$entry .= "<link rel='alternate' href='" . $noticeurl . "' />\n";
|
||||||
|
$entry .= "<id>". $notice->uri . "</id>\n";
|
||||||
|
$entry .= "<published>".common_date_w3dtf($notice->created)."</published>\n";
|
||||||
|
$entry .= "<updated>".common_date_w3dtf($notice->modified)."</updated>\n";
|
||||||
|
$entry .= "</entry>\n";
|
||||||
|
|
||||||
|
$html = "\n<html xmlns='http://jabber.org/protocol/xhtml-im'>\n";
|
||||||
|
$html .= "<body xmlns='http://www.w3.org/1999/xhtml'>\n";
|
||||||
|
$html .= "<a href='".htmlspecialchars($profile->profileurl)."'>".$profile->nickname."</a>: ";
|
||||||
|
$html .= ($notice->rendered) ? $notice->rendered : common_render_content($notice->content, $notice);
|
||||||
|
$html .= "\n</body>\n";
|
||||||
|
$html .= "\n</html>\n";
|
||||||
|
|
||||||
|
$address = "<addresses xmlns='http://jabber.org/protocol/address'>\n";
|
||||||
|
$address .= "<address type='replyto' jid='" . jabber_daemon_address() . "' />\n";
|
||||||
|
$address .= "</addresses>\n";
|
||||||
|
|
||||||
|
// FIXME: include a pubsub event, too.
|
||||||
|
|
||||||
|
return $html . $entry . $address;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* sends a single text message to a given JID
|
||||||
|
*
|
||||||
|
* @param string $to JID to send the message to
|
||||||
|
* @param string $body body of the message
|
||||||
|
* @param string $type type of the message
|
||||||
|
* @param string $subject subject of the message
|
||||||
|
*
|
||||||
|
* @return boolean success flag
|
||||||
|
*/
|
||||||
|
|
||||||
|
function jabber_send_message($to, $body, $type='chat', $subject=null)
|
||||||
|
{
|
||||||
|
$conn = jabber_connect();
|
||||||
|
if (!$conn) {
|
||||||
|
return false;
|
||||||
|
}
|
||||||
|
$conn->message($to, $body, $type, $subject);
|
||||||
|
return true;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* sends a presence stanza on the Jabber network
|
||||||
|
*
|
||||||
|
* @param string $status current status, free-form string
|
||||||
|
* @param string $show structured status value
|
||||||
|
* @param string $to recipient of presence, null for general
|
||||||
|
* @param string $type type of status message, related to $show
|
||||||
|
* @param int $priority priority of the presence
|
||||||
|
*
|
||||||
|
* @return boolean success value
|
||||||
|
*/
|
||||||
|
|
||||||
|
function jabber_send_presence($status, $show='available', $to=null,
|
||||||
|
$type = 'available', $priority=null)
|
||||||
|
{
|
||||||
|
$conn = jabber_connect();
|
||||||
|
if (!$conn) {
|
||||||
|
return false;
|
||||||
|
}
|
||||||
|
$conn->presence($status, $show, $to, $type, $priority);
|
||||||
|
return true;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* sends a confirmation request to a JID
|
||||||
|
*
|
||||||
|
* @param string $code confirmation code for confirmation URL
|
||||||
|
* @param string $nickname nickname of confirming user
|
||||||
|
* @param string $address JID to send confirmation to
|
||||||
|
*
|
||||||
|
* @return boolean success flag
|
||||||
|
*/
|
||||||
|
|
||||||
|
function jabber_confirm_address($code, $nickname, $address)
|
||||||
|
{
|
||||||
|
$body = 'User "' . $nickname . '" on ' . common_config('site', 'name') . ' ' .
|
||||||
|
'has said that your Jabber ID belongs to them. ' .
|
||||||
|
'If that\'s true, you can confirm by clicking on this URL: ' .
|
||||||
|
common_local_url('confirmaddress', array('code' => $code)) .
|
||||||
|
' . (If you cannot click it, copy-and-paste it into the ' .
|
||||||
|
'address bar of your browser). If that user isn\'t you, ' .
|
||||||
|
'or if you didn\'t request this confirmation, just ignore this message.';
|
||||||
|
|
||||||
|
return jabber_send_message($address, $body);
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* sends a "special" presence stanza on the Jabber network
|
||||||
|
*
|
||||||
|
* @param string $type Type of presence
|
||||||
|
* @param string $to JID to send presence to
|
||||||
|
* @param string $show show value for presence
|
||||||
|
* @param string $status status value for presence
|
||||||
|
*
|
||||||
|
* @return boolean success flag
|
||||||
|
*
|
||||||
|
* @see jabber_send_presence()
|
||||||
|
*/
|
||||||
|
|
||||||
|
function jabber_special_presence($type, $to=null, $show=null, $status=null)
|
||||||
|
{
|
||||||
|
// FIXME: why use this instead of jabber_send_presence()?
|
||||||
|
$conn = jabber_connect();
|
||||||
|
|
||||||
|
$to = htmlspecialchars($to);
|
||||||
|
$status = htmlspecialchars($status);
|
||||||
|
|
||||||
|
$out = "<presence";
|
||||||
|
if ($to) {
|
||||||
|
$out .= " to='$to'";
|
||||||
|
}
|
||||||
|
if ($type) {
|
||||||
|
$out .= " type='$type'";
|
||||||
|
}
|
||||||
|
if ($show == 'available' and !$status) {
|
||||||
|
$out .= "/>";
|
||||||
|
} else {
|
||||||
|
$out .= ">";
|
||||||
|
if ($show && ($show != 'available')) {
|
||||||
|
$out .= "<show>$show</show>";
|
||||||
|
}
|
||||||
|
if ($status) {
|
||||||
|
$out .= "<status>$status</status>";
|
||||||
|
}
|
||||||
|
$out .= "</presence>";
|
||||||
|
}
|
||||||
|
$conn->send($out);
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* broadcast a notice to all subscribers and reply recipients
|
||||||
|
*
|
||||||
|
* This function will send a notice to all subscribers on the local server
|
||||||
|
* who have Jabber addresses, and have Jabber notification enabled, and
|
||||||
|
* have this subscription enabled for Jabber. It also sends the notice to
|
||||||
|
* all recipients of @-replies who have Jabber addresses and Jabber notification
|
||||||
|
* enabled. This is really the heart of Jabber distribution in Laconica.
|
||||||
|
*
|
||||||
|
* @param Notice $notice The notice to broadcast
|
||||||
|
*
|
||||||
|
* @return boolean success flag
|
||||||
|
*/
|
||||||
|
|
||||||
|
function jabber_broadcast_notice($notice)
|
||||||
|
{
|
||||||
|
if (!common_config('xmpp', 'enabled')) {
|
||||||
|
return true;
|
||||||
|
}
|
||||||
|
$profile = Profile::staticGet($notice->profile_id);
|
||||||
|
|
||||||
|
if (!$profile) {
|
||||||
|
common_log(LOG_WARNING, 'Refusing to broadcast notice with ' .
|
||||||
|
'unknown profile ' . common_log_objstring($notice),
|
||||||
|
__FILE__);
|
||||||
|
return false;
|
||||||
|
}
|
||||||
|
|
||||||
|
$msg = jabber_format_notice($profile, $notice);
|
||||||
|
$entry = jabber_format_entry($profile, $notice);
|
||||||
|
|
||||||
|
$profile->free();
|
||||||
|
unset($profile);
|
||||||
|
|
||||||
|
$sent_to = array();
|
||||||
|
|
||||||
|
$conn = jabber_connect();
|
||||||
|
|
||||||
|
// First, get users to whom this is a direct reply
|
||||||
|
$user = new User();
|
||||||
|
$user->query('SELECT user.id, user.jabber ' .
|
||||||
|
'FROM user JOIN reply ON user.id = reply.profile_id ' .
|
||||||
|
'WHERE reply.notice_id = ' . $notice->id . ' ' .
|
||||||
|
'AND user.jabber is not null ' .
|
||||||
|
'AND user.jabbernotify = 1 ' .
|
||||||
|
'AND user.jabberreplies = 1 ');
|
||||||
|
|
||||||
|
while ($user->fetch()) {
|
||||||
|
common_log(LOG_INFO,
|
||||||
|
'Sending reply notice ' . $notice->id . ' to ' . $user->jabber,
|
||||||
|
__FILE__);
|
||||||
|
$conn->message($user->jabber, $msg, 'chat', null, $entry);
|
||||||
|
$conn->processTime(0);
|
||||||
|
$sent_to[$user->id] = 1;
|
||||||
|
}
|
||||||
|
|
||||||
|
$user->free();
|
||||||
|
|
||||||
|
// Now, get users subscribed to this profile
|
||||||
|
|
||||||
|
$user = new User();
|
||||||
|
$user->query('SELECT user.id, user.jabber ' .
|
||||||
|
'FROM user JOIN subscription ' .
|
||||||
|
'ON user.id = subscription.subscriber ' .
|
||||||
|
'WHERE subscription.subscribed = ' . $notice->profile_id . ' ' .
|
||||||
|
'AND user.jabber is not null ' .
|
||||||
|
'AND user.jabbernotify = 1 ' .
|
||||||
'AND subscription.jabber = 1 ');
|
'AND subscription.jabber = 1 ');
|
||||||
|
|
||||||
while ($user->fetch()) {
|
while ($user->fetch()) {
|
||||||
if (!array_key_exists($user->id, $sent_to)) {
|
if (!array_key_exists($user->id, $sent_to)) {
|
||||||
common_log(LOG_INFO,
|
common_log(LOG_INFO,
|
||||||
'Sending notice ' . $notice->id . ' to ' . $user->jabber,
|
'Sending notice ' . $notice->id . ' to ' . $user->jabber,
|
||||||
__FILE__);
|
__FILE__);
|
||||||
$conn->message($user->jabber, $msg, 'chat', NULL, $entry);
|
$conn->message($user->jabber, $msg, 'chat', null, $entry);
|
||||||
# To keep the incoming queue from filling up, we service it after each send.
|
// To keep the incoming queue from filling up,
|
||||||
$conn->processTime(0);
|
// we service it after each send.
|
||||||
}
|
$conn->processTime(0);
|
||||||
}
|
}
|
||||||
|
}
|
||||||
|
|
||||||
$user->free();
|
$user->free();
|
||||||
|
|
||||||
return true;
|
return true;
|
||||||
}
|
}
|
||||||
|
|
||||||
function jabber_public_notice($notice) {
|
/**
|
||||||
|
* send a notice to all public listeners
|
||||||
|
*
|
||||||
|
* For notices that are generated on the local system (by users), we can optionally
|
||||||
|
* forward them to remote listeners by XMPP.
|
||||||
|
*
|
||||||
|
* @param Notice $notice notice to broadcast
|
||||||
|
*
|
||||||
|
* @return boolean success flag
|
||||||
|
*/
|
||||||
|
|
||||||
# Now, users who want everything
|
function jabber_public_notice($notice)
|
||||||
|
{
|
||||||
|
// Now, users who want everything
|
||||||
|
|
||||||
$public = common_config('xmpp', 'public');
|
$public = common_config('xmpp', 'public');
|
||||||
|
|
||||||
# FIXME PRIV don't send out private messages here
|
// FIXME PRIV don't send out private messages here
|
||||||
# XXX: should we send out non-local messages if public,localonly
|
// XXX: should we send out non-local messages if public,localonly
|
||||||
# = false? I think not
|
// = false? I think not
|
||||||
|
|
||||||
if ($public && $notice->is_local) {
|
if ($public && $notice->is_local) {
|
||||||
$profile = Profile::staticGet($notice->profile_id);
|
$profile = Profile::staticGet($notice->profile_id);
|
||||||
|
|
||||||
if (!$profile) {
|
if (!$profile) {
|
||||||
common_log(LOG_WARNING, 'Refusing to broadcast notice with ' .
|
common_log(LOG_WARNING, 'Refusing to broadcast notice with ' .
|
||||||
'unknown profile ' . common_log_objstring($notice),
|
'unknown profile ' . common_log_objstring($notice),
|
||||||
__FILE__);
|
__FILE__);
|
||||||
return false;
|
return false;
|
||||||
}
|
}
|
||||||
|
|
||||||
$msg = jabber_format_notice($profile, $notice);
|
$msg = jabber_format_notice($profile, $notice);
|
||||||
$entry = jabber_format_entry($profile, $notice);
|
$entry = jabber_format_entry($profile, $notice);
|
||||||
|
|
||||||
$conn = jabber_connect();
|
$conn = jabber_connect();
|
||||||
|
|
||||||
foreach ($public as $address) {
|
foreach ($public as $address) {
|
||||||
common_log(LOG_INFO,
|
common_log(LOG_INFO,
|
||||||
'Sending notice ' . $notice->id . ' to public listener ' . $address,
|
'Sending notice ' . $notice->id .
|
||||||
__FILE__);
|
' to public listener ' . $address,
|
||||||
$conn->message($address, $msg, 'chat', NULL, $entry);
|
__FILE__);
|
||||||
$conn->processTime(0);
|
$conn->message($address, $msg, 'chat', null, $entry);
|
||||||
}
|
$conn->processTime(0);
|
||||||
$profile->free();
|
}
|
||||||
}
|
$profile->free();
|
||||||
|
}
|
||||||
|
|
||||||
return true;
|
return true;
|
||||||
}
|
}
|
||||||
|
|
||||||
function jabber_format_notice(&$profile, &$notice) {
|
/**
|
||||||
return $profile->nickname . ': ' . $notice->content;
|
* makes a plain-text formatted version of a notice, suitable for Jabber distribution
|
||||||
|
*
|
||||||
|
* @param Profile &$profile profile of the sending user
|
||||||
|
* @param Notice &$notice notice being sent
|
||||||
|
*
|
||||||
|
* @return string plain-text version of the notice, with user nickname prefixed
|
||||||
|
*/
|
||||||
|
|
||||||
|
function jabber_format_notice(&$profile, &$notice)
|
||||||
|
{
|
||||||
|
return $profile->nickname . ': ' . $notice->content;
|
||||||
}
|
}
|
||||||
|
|||||||
File diff suppressed because it is too large
Load Diff
653
lib/jabber.php
653
lib/jabber.php
@ -1,9 +1,12 @@
|
|||||||
<?php
|
<?php
|
||||||
/*
|
/**
|
||||||
* Laconica - a distributed open-source microblogging tool
|
* Laconica, the distributed open-source microblogging tool
|
||||||
* Copyright (C) 2008, Controlez-Vous, Inc.
|
|
||||||
*
|
*
|
||||||
* This program is free software: you can redistribute it and/or modify
|
* utility functions for Jabber/GTalk/XMPP messages
|
||||||
|
*
|
||||||
|
* PHP version 5
|
||||||
|
*
|
||||||
|
* LICENCE: 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
|
* 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
|
* the Free Software Foundation, either version 3 of the License, or
|
||||||
* (at your option) any later version.
|
* (at your option) any later version.
|
||||||
@ -15,286 +18,448 @@
|
|||||||
*
|
*
|
||||||
* You should have received a copy of the GNU Affero General Public License
|
* 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/>.
|
* along with this program. If not, see <http://www.gnu.org/licenses/>.
|
||||||
|
*
|
||||||
|
* @category Network
|
||||||
|
* @package Laconica
|
||||||
|
* @author Evan Prodromou <evan@controlyourself.ca>
|
||||||
|
* @copyright 2008 Control Yourself, Inc.
|
||||||
|
* @license http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
|
||||||
|
* @link http://laconi.ca/
|
||||||
*/
|
*/
|
||||||
|
|
||||||
if (!defined('LACONICA')) { exit(1); }
|
if (!defined('LACONICA')) {
|
||||||
|
exit(1);
|
||||||
require_once('XMPPHP/XMPP.php');
|
|
||||||
|
|
||||||
function jabber_valid_base_jid($jid) {
|
|
||||||
# Cheap but effective
|
|
||||||
return Validate::email($jid);
|
|
||||||
}
|
}
|
||||||
|
|
||||||
function jabber_normalize_jid($jid) {
|
require_once 'XMPPHP/XMPP.php';
|
||||||
if (preg_match("/(?:([^\@]+)\@)?([^\/]+)(?:\/(.*))?$/", $jid, $matches)) {
|
|
||||||
$node = $matches[1];
|
|
||||||
$server = $matches[2];
|
|
||||||
return strtolower($node.'@'.$server);
|
|
||||||
} else {
|
|
||||||
return NULL;
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
function jabber_daemon_address() {
|
/**
|
||||||
return common_config('xmpp', 'user') . '@' . common_config('xmpp', 'server');
|
* checks whether a string is a syntactically valid Jabber ID (JID)
|
||||||
}
|
*
|
||||||
|
* @param string $jid string to check
|
||||||
|
*
|
||||||
|
* @return boolean whether the string is a valid JID
|
||||||
|
*/
|
||||||
|
|
||||||
function jabber_connect($resource=NULL) {
|
function jabber_valid_base_jid($jid)
|
||||||
static $conn = NULL;
|
|
||||||
if (!$conn) {
|
|
||||||
$conn = new XMPPHP_XMPP(common_config('xmpp', 'host') ?
|
|
||||||
common_config('xmpp', 'host') :
|
|
||||||
common_config('xmpp', 'server'),
|
|
||||||
common_config('xmpp', 'port'),
|
|
||||||
common_config('xmpp', 'user'),
|
|
||||||
common_config('xmpp', 'password'),
|
|
||||||
($resource) ? $resource :
|
|
||||||
common_config('xmpp', 'resource'),
|
|
||||||
common_config('xmpp', 'server'),
|
|
||||||
common_config('xmpp', 'debug') ?
|
|
||||||
true : false,
|
|
||||||
common_config('xmpp', 'debug') ?
|
|
||||||
XMPPHP_Log::LEVEL_VERBOSE : NULL
|
|
||||||
);
|
|
||||||
|
|
||||||
if (!$conn) {
|
|
||||||
return false;
|
|
||||||
}
|
|
||||||
|
|
||||||
$conn->autoSubscribe();
|
|
||||||
$conn->useEncryption(common_config('xmpp', 'encryption'));
|
|
||||||
|
|
||||||
try {
|
|
||||||
$conn->connect(true); # true = persistent connection
|
|
||||||
} catch (XMPPHP_Exception $e) {
|
|
||||||
common_log(LOG_ERROR, $e->getMessage());
|
|
||||||
return false;
|
|
||||||
}
|
|
||||||
|
|
||||||
$conn->processUntil('session_start');
|
|
||||||
}
|
|
||||||
return $conn;
|
|
||||||
}
|
|
||||||
|
|
||||||
function jabber_send_notice($to, $notice) {
|
|
||||||
$conn = jabber_connect();
|
|
||||||
if (!$conn) {
|
|
||||||
return false;
|
|
||||||
}
|
|
||||||
$profile = Profile::staticGet($notice->profile_id);
|
|
||||||
if (!$profile) {
|
|
||||||
common_log(LOG_WARNING, 'Refusing to send notice with ' .
|
|
||||||
'unknown profile ' . common_log_objstring($notice),
|
|
||||||
__FILE__);
|
|
||||||
return false;
|
|
||||||
}
|
|
||||||
$msg = jabber_format_notice($profile, $notice);
|
|
||||||
$entry = jabber_format_entry($profile, $notice);
|
|
||||||
$conn->message($to, $msg, 'chat', NULL, $entry);
|
|
||||||
$profile->free();
|
|
||||||
return true;
|
|
||||||
}
|
|
||||||
|
|
||||||
# Extra stuff defined by Twitter, needed by twitter clients
|
|
||||||
|
|
||||||
function jabber_format_entry($profile, $notice) {
|
|
||||||
|
|
||||||
# FIXME: notice url might be remote
|
|
||||||
|
|
||||||
$noticeurl = common_local_url('shownotice',
|
|
||||||
array('notice' => $notice->id));
|
|
||||||
$msg = jabber_format_notice($profile, $notice);
|
|
||||||
$entry = "\n<entry xmlns='http://www.w3.org/2005/Atom'>\n";
|
|
||||||
$entry .= "<source>\n";
|
|
||||||
$entry .= "<title>" . $profile->nickname . " - " . common_config('site', 'name') . "</title>\n";
|
|
||||||
$entry .= "<link href='" . htmlspecialchars($profile->profileurl) . "'/>\n";
|
|
||||||
$entry .= "<link rel='self' type='application/rss+xml' href='" . common_local_url('userrss', array('nickname' => $profile->nickname)) . "'/>\n";
|
|
||||||
$entry .= "<author><name>" . $profile->nickname . "</name></author>\n";
|
|
||||||
$entry .= "<icon>" . common_profile_avatar_url($profile, AVATAR_PROFILE_SIZE) . "</icon>\n";
|
|
||||||
$entry .= "</source>\n";
|
|
||||||
$entry .= "<title>" . htmlspecialchars($msg) . "</title>\n";
|
|
||||||
$entry .= "<summary>" . htmlspecialchars($msg) . "</summary>\n";
|
|
||||||
$entry .= "<link rel='alternate' href='" . $noticeurl . "' />\n";
|
|
||||||
$entry .= "<id>". $notice->uri . "</id>\n";
|
|
||||||
$entry .= "<published>".common_date_w3dtf($notice->created)."</published>\n";
|
|
||||||
$entry .= "<updated>".common_date_w3dtf($notice->modified)."</updated>\n";
|
|
||||||
$entry .= "</entry>\n";
|
|
||||||
|
|
||||||
$html = "\n<html xmlns='http://jabber.org/protocol/xhtml-im'>\n";
|
|
||||||
$html .= "<body xmlns='http://www.w3.org/1999/xhtml'>\n";
|
|
||||||
$html .= "<a href='".htmlspecialchars($profile->profileurl)."'>".$profile->nickname."</a>: ";
|
|
||||||
$html .= ($notice->rendered) ? $notice->rendered : common_render_content($notice->content, $notice);
|
|
||||||
$html .= "\n</body>\n";
|
|
||||||
$html .= "\n</html>\n";
|
|
||||||
|
|
||||||
$address = "<addresses xmlns='http://jabber.org/protocol/address'>\n";
|
|
||||||
$address .= "<address type='replyto' jid='" . jabber_daemon_address() . "' />\n";
|
|
||||||
$address .= "</addresses>\n";
|
|
||||||
|
|
||||||
# FIXME: include a pubsub event, too.
|
|
||||||
|
|
||||||
return $html . $entry . $address;
|
|
||||||
}
|
|
||||||
|
|
||||||
function jabber_send_message($to, $body, $type='chat', $subject=NULL) {
|
|
||||||
$conn = jabber_connect();
|
|
||||||
if (!$conn) {
|
|
||||||
return false;
|
|
||||||
}
|
|
||||||
$conn->message($to, $body, $type, $subject);
|
|
||||||
return true;
|
|
||||||
}
|
|
||||||
|
|
||||||
function jabber_send_presence($status, $show='available', $to=NULL,
|
|
||||||
$type = 'available', $priority=NULL)
|
|
||||||
{
|
{
|
||||||
$conn = jabber_connect();
|
// Cheap but effective
|
||||||
if (!$conn) {
|
return Validate::email($jid);
|
||||||
return false;
|
|
||||||
}
|
|
||||||
$conn->presence($status, $show, $to, $type, $priority);
|
|
||||||
return true;
|
|
||||||
}
|
}
|
||||||
|
|
||||||
function jabber_confirm_address($code, $nickname, $address) {
|
/**
|
||||||
$body = 'User "' . $nickname . '" on ' . common_config('site', 'name') . ' ' .
|
* normalizes a Jabber ID for comparison
|
||||||
'has said that your Jabber ID belongs to them. ' .
|
*
|
||||||
'If that\'s true, you can confirm by clicking on this URL: ' .
|
* @param string $jid JID to check
|
||||||
common_local_url('confirmaddress', array('code' => $code)) .
|
*
|
||||||
' . (If you cannot click it, copy-and-paste it into the ' .
|
* @return string an equivalent JID in normalized (lowercase) form
|
||||||
'address bar of your browser). If that user isn\'t you, ' .
|
*/
|
||||||
'or if you didn\'t request this confirmation, just ignore this message.';
|
|
||||||
|
|
||||||
return jabber_send_message($address, $body);
|
function jabber_normalize_jid($jid)
|
||||||
|
{
|
||||||
|
if (preg_match("/(?:([^\@]+)\@)?([^\/]+)(?:\/(.*))?$/", $jid, $matches)) {
|
||||||
|
$node = $matches[1];
|
||||||
|
$server = $matches[2];
|
||||||
|
return strtolower($node.'@'.$server);
|
||||||
|
} else {
|
||||||
|
return null;
|
||||||
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
function jabber_special_presence($type, $to=NULL, $show=NULL, $status=NULL) {
|
/**
|
||||||
$conn = jabber_connect();
|
* the JID of the Jabber daemon for this Laconica instance
|
||||||
|
*
|
||||||
|
* @return string JID of the Jabber daemon
|
||||||
|
*/
|
||||||
|
|
||||||
$to = htmlspecialchars($to);
|
function jabber_daemon_address()
|
||||||
$status = htmlspecialchars($status);
|
{
|
||||||
$out = "<presence";
|
return common_config('xmpp', 'user') . '@' . common_config('xmpp', 'server');
|
||||||
if($to) $out .= " to='$to'";
|
|
||||||
if($type) $out .= " type='$type'";
|
|
||||||
if($show == 'available' and !$status) {
|
|
||||||
$out .= "/>";
|
|
||||||
} else {
|
|
||||||
$out .= ">";
|
|
||||||
if($show && ($show != 'available')) $out .= "<show>$show</show>";
|
|
||||||
if($status) $out .= "<status>$status</status>";
|
|
||||||
$out .= "</presence>";
|
|
||||||
}
|
|
||||||
$conn->send($out);
|
|
||||||
}
|
}
|
||||||
|
|
||||||
function jabber_broadcast_notice($notice) {
|
/**
|
||||||
|
* connect the configured Jabber account to the configured server
|
||||||
|
*
|
||||||
|
* @param string $resource Resource to connect (defaults to configured resource)
|
||||||
|
*
|
||||||
|
* @return XMPPHP connection to the configured server
|
||||||
|
*/
|
||||||
|
|
||||||
if (!common_config('xmpp', 'enabled')) {
|
function jabber_connect($resource=null)
|
||||||
return true;
|
{
|
||||||
}
|
static $conn = null;
|
||||||
$profile = Profile::staticGet($notice->profile_id);
|
if (!$conn) {
|
||||||
|
$conn = new XMPPHP_XMPP(common_config('xmpp', 'host') ?
|
||||||
|
common_config('xmpp', 'host') :
|
||||||
|
common_config('xmpp', 'server'),
|
||||||
|
common_config('xmpp', 'port'),
|
||||||
|
common_config('xmpp', 'user'),
|
||||||
|
common_config('xmpp', 'password'),
|
||||||
|
($resource) ? $resource :
|
||||||
|
common_config('xmpp', 'resource'),
|
||||||
|
common_config('xmpp', 'server'),
|
||||||
|
common_config('xmpp', 'debug') ?
|
||||||
|
true : false,
|
||||||
|
common_config('xmpp', 'debug') ?
|
||||||
|
XMPPHP_Log::LEVEL_VERBOSE : null
|
||||||
|
);
|
||||||
|
|
||||||
if (!$profile) {
|
if (!$conn) {
|
||||||
common_log(LOG_WARNING, 'Refusing to broadcast notice with ' .
|
return false;
|
||||||
'unknown profile ' . common_log_objstring($notice),
|
}
|
||||||
__FILE__);
|
|
||||||
return false;
|
|
||||||
}
|
|
||||||
|
|
||||||
$msg = jabber_format_notice($profile, $notice);
|
$conn->autoSubscribe();
|
||||||
$entry = jabber_format_entry($profile, $notice);
|
$conn->useEncryption(common_config('xmpp', 'encryption'));
|
||||||
|
|
||||||
$profile->free();
|
try {
|
||||||
unset($profile);
|
$conn->connect(true); // true = persistent connection
|
||||||
|
} catch (XMPPHP_Exception $e) {
|
||||||
|
common_log(LOG_ERROR, $e->getMessage());
|
||||||
|
return false;
|
||||||
|
}
|
||||||
|
|
||||||
$sent_to = array();
|
$conn->processUntil('session_start');
|
||||||
$conn = jabber_connect();
|
}
|
||||||
|
return $conn;
|
||||||
|
}
|
||||||
|
|
||||||
# First, get users to whom this is a direct reply
|
/**
|
||||||
$user = new User();
|
* send a single notice to a given Jabber address
|
||||||
$user->query('SELECT user.id, user.jabber ' .
|
*
|
||||||
'FROM user JOIN reply ON user.id = reply.profile_id ' .
|
* @param string $to JID to send the notice to
|
||||||
'WHERE reply.notice_id = ' . $notice->id . ' ' .
|
* @param Notice $notice notice to send
|
||||||
'AND user.jabber is not null ' .
|
*
|
||||||
'AND user.jabbernotify = 1 ' .
|
* @return boolean success value
|
||||||
'AND user.jabberreplies = 1 ');
|
*/
|
||||||
|
|
||||||
while ($user->fetch()) {
|
function jabber_send_notice($to, $notice)
|
||||||
common_log(LOG_INFO,
|
{
|
||||||
'Sending reply notice ' . $notice->id . ' to ' . $user->jabber,
|
$conn = jabber_connect();
|
||||||
__FILE__);
|
if (!$conn) {
|
||||||
$conn->message($user->jabber, $msg, 'chat', NULL, $entry);
|
return false;
|
||||||
$conn->processTime(0);
|
}
|
||||||
$sent_to[$user->id] = 1;
|
$profile = Profile::staticGet($notice->profile_id);
|
||||||
}
|
if (!$profile) {
|
||||||
|
common_log(LOG_WARNING, 'Refusing to send notice with ' .
|
||||||
|
'unknown profile ' . common_log_objstring($notice),
|
||||||
|
__FILE__);
|
||||||
|
return false;
|
||||||
|
}
|
||||||
|
$msg = jabber_format_notice($profile, $notice);
|
||||||
|
$entry = jabber_format_entry($profile, $notice);
|
||||||
|
$conn->message($to, $msg, 'chat', null, $entry);
|
||||||
|
$profile->free();
|
||||||
|
return true;
|
||||||
|
}
|
||||||
|
|
||||||
$user->free();
|
/**
|
||||||
|
* extra information for XMPP messages, as defined by Twitter
|
||||||
|
*
|
||||||
|
* @param Profile $profile Profile of the sending user
|
||||||
|
* @param Notice $notice Notice being sent
|
||||||
|
*
|
||||||
|
* @return string Extra information (Atom, HTML, addresses) in string format
|
||||||
|
*/
|
||||||
|
|
||||||
# Now, get users subscribed to this profile
|
function jabber_format_entry($profile, $notice)
|
||||||
|
{
|
||||||
|
// FIXME: notice url might be remote
|
||||||
|
|
||||||
$user = new User();
|
$noticeurl = common_local_url('shownotice',
|
||||||
$user->query('SELECT user.id, user.jabber ' .
|
array('notice' => $notice->id));
|
||||||
'FROM user JOIN subscription ON user.id = subscription.subscriber ' .
|
|
||||||
'WHERE subscription.subscribed = ' . $notice->profile_id . ' ' .
|
$msg = jabber_format_notice($profile, $notice);
|
||||||
'AND user.jabber is not null ' .
|
|
||||||
'AND user.jabbernotify = 1 ' .
|
$self_url = common_local_url('userrss', array('nickname' => $profile->nickname));
|
||||||
|
|
||||||
|
$entry = "\n<entry xmlns='http://www.w3.org/2005/Atom'>\n";
|
||||||
|
$entry .= "<source>\n";
|
||||||
|
$entry .= "<title>" . $profile->nickname . " - " . common_config('site', 'name') . "</title>\n";
|
||||||
|
$entry .= "<link href='" . htmlspecialchars($profile->profileurl) . "'/>\n";
|
||||||
|
$entry .= "<link rel='self' type='application/rss+xml' href='" . $self_url . "'/>\n";
|
||||||
|
$entry .= "<author><name>" . $profile->nickname . "</name></author>\n";
|
||||||
|
$entry .= "<icon>" . common_profile_avatar_url($profile, AVATAR_PROFILE_SIZE) . "</icon>\n";
|
||||||
|
$entry .= "</source>\n";
|
||||||
|
$entry .= "<title>" . htmlspecialchars($msg) . "</title>\n";
|
||||||
|
$entry .= "<summary>" . htmlspecialchars($msg) . "</summary>\n";
|
||||||
|
$entry .= "<link rel='alternate' href='" . $noticeurl . "' />\n";
|
||||||
|
$entry .= "<id>". $notice->uri . "</id>\n";
|
||||||
|
$entry .= "<published>".common_date_w3dtf($notice->created)."</published>\n";
|
||||||
|
$entry .= "<updated>".common_date_w3dtf($notice->modified)."</updated>\n";
|
||||||
|
$entry .= "</entry>\n";
|
||||||
|
|
||||||
|
$html = "\n<html xmlns='http://jabber.org/protocol/xhtml-im'>\n";
|
||||||
|
$html .= "<body xmlns='http://www.w3.org/1999/xhtml'>\n";
|
||||||
|
$html .= "<a href='".htmlspecialchars($profile->profileurl)."'>".$profile->nickname."</a>: ";
|
||||||
|
$html .= ($notice->rendered) ? $notice->rendered : common_render_content($notice->content, $notice);
|
||||||
|
$html .= "\n</body>\n";
|
||||||
|
$html .= "\n</html>\n";
|
||||||
|
|
||||||
|
$address = "<addresses xmlns='http://jabber.org/protocol/address'>\n";
|
||||||
|
$address .= "<address type='replyto' jid='" . jabber_daemon_address() . "' />\n";
|
||||||
|
$address .= "</addresses>\n";
|
||||||
|
|
||||||
|
// FIXME: include a pubsub event, too.
|
||||||
|
|
||||||
|
return $html . $entry . $address;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* sends a single text message to a given JID
|
||||||
|
*
|
||||||
|
* @param string $to JID to send the message to
|
||||||
|
* @param string $body body of the message
|
||||||
|
* @param string $type type of the message
|
||||||
|
* @param string $subject subject of the message
|
||||||
|
*
|
||||||
|
* @return boolean success flag
|
||||||
|
*/
|
||||||
|
|
||||||
|
function jabber_send_message($to, $body, $type='chat', $subject=null)
|
||||||
|
{
|
||||||
|
$conn = jabber_connect();
|
||||||
|
if (!$conn) {
|
||||||
|
return false;
|
||||||
|
}
|
||||||
|
$conn->message($to, $body, $type, $subject);
|
||||||
|
return true;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* sends a presence stanza on the Jabber network
|
||||||
|
*
|
||||||
|
* @param string $status current status, free-form string
|
||||||
|
* @param string $show structured status value
|
||||||
|
* @param string $to recipient of presence, null for general
|
||||||
|
* @param string $type type of status message, related to $show
|
||||||
|
* @param int $priority priority of the presence
|
||||||
|
*
|
||||||
|
* @return boolean success value
|
||||||
|
*/
|
||||||
|
|
||||||
|
function jabber_send_presence($status, $show='available', $to=null,
|
||||||
|
$type = 'available', $priority=null)
|
||||||
|
{
|
||||||
|
$conn = jabber_connect();
|
||||||
|
if (!$conn) {
|
||||||
|
return false;
|
||||||
|
}
|
||||||
|
$conn->presence($status, $show, $to, $type, $priority);
|
||||||
|
return true;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* sends a confirmation request to a JID
|
||||||
|
*
|
||||||
|
* @param string $code confirmation code for confirmation URL
|
||||||
|
* @param string $nickname nickname of confirming user
|
||||||
|
* @param string $address JID to send confirmation to
|
||||||
|
*
|
||||||
|
* @return boolean success flag
|
||||||
|
*/
|
||||||
|
|
||||||
|
function jabber_confirm_address($code, $nickname, $address)
|
||||||
|
{
|
||||||
|
$body = 'User "' . $nickname . '" on ' . common_config('site', 'name') . ' ' .
|
||||||
|
'has said that your Jabber ID belongs to them. ' .
|
||||||
|
'If that\'s true, you can confirm by clicking on this URL: ' .
|
||||||
|
common_local_url('confirmaddress', array('code' => $code)) .
|
||||||
|
' . (If you cannot click it, copy-and-paste it into the ' .
|
||||||
|
'address bar of your browser). If that user isn\'t you, ' .
|
||||||
|
'or if you didn\'t request this confirmation, just ignore this message.';
|
||||||
|
|
||||||
|
return jabber_send_message($address, $body);
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* sends a "special" presence stanza on the Jabber network
|
||||||
|
*
|
||||||
|
* @param string $type Type of presence
|
||||||
|
* @param string $to JID to send presence to
|
||||||
|
* @param string $show show value for presence
|
||||||
|
* @param string $status status value for presence
|
||||||
|
*
|
||||||
|
* @return boolean success flag
|
||||||
|
*
|
||||||
|
* @see jabber_send_presence()
|
||||||
|
*/
|
||||||
|
|
||||||
|
function jabber_special_presence($type, $to=null, $show=null, $status=null)
|
||||||
|
{
|
||||||
|
// FIXME: why use this instead of jabber_send_presence()?
|
||||||
|
$conn = jabber_connect();
|
||||||
|
|
||||||
|
$to = htmlspecialchars($to);
|
||||||
|
$status = htmlspecialchars($status);
|
||||||
|
|
||||||
|
$out = "<presence";
|
||||||
|
if ($to) {
|
||||||
|
$out .= " to='$to'";
|
||||||
|
}
|
||||||
|
if ($type) {
|
||||||
|
$out .= " type='$type'";
|
||||||
|
}
|
||||||
|
if ($show == 'available' and !$status) {
|
||||||
|
$out .= "/>";
|
||||||
|
} else {
|
||||||
|
$out .= ">";
|
||||||
|
if ($show && ($show != 'available')) {
|
||||||
|
$out .= "<show>$show</show>";
|
||||||
|
}
|
||||||
|
if ($status) {
|
||||||
|
$out .= "<status>$status</status>";
|
||||||
|
}
|
||||||
|
$out .= "</presence>";
|
||||||
|
}
|
||||||
|
$conn->send($out);
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* broadcast a notice to all subscribers and reply recipients
|
||||||
|
*
|
||||||
|
* This function will send a notice to all subscribers on the local server
|
||||||
|
* who have Jabber addresses, and have Jabber notification enabled, and
|
||||||
|
* have this subscription enabled for Jabber. It also sends the notice to
|
||||||
|
* all recipients of @-replies who have Jabber addresses and Jabber notification
|
||||||
|
* enabled. This is really the heart of Jabber distribution in Laconica.
|
||||||
|
*
|
||||||
|
* @param Notice $notice The notice to broadcast
|
||||||
|
*
|
||||||
|
* @return boolean success flag
|
||||||
|
*/
|
||||||
|
|
||||||
|
function jabber_broadcast_notice($notice)
|
||||||
|
{
|
||||||
|
if (!common_config('xmpp', 'enabled')) {
|
||||||
|
return true;
|
||||||
|
}
|
||||||
|
$profile = Profile::staticGet($notice->profile_id);
|
||||||
|
|
||||||
|
if (!$profile) {
|
||||||
|
common_log(LOG_WARNING, 'Refusing to broadcast notice with ' .
|
||||||
|
'unknown profile ' . common_log_objstring($notice),
|
||||||
|
__FILE__);
|
||||||
|
return false;
|
||||||
|
}
|
||||||
|
|
||||||
|
$msg = jabber_format_notice($profile, $notice);
|
||||||
|
$entry = jabber_format_entry($profile, $notice);
|
||||||
|
|
||||||
|
$profile->free();
|
||||||
|
unset($profile);
|
||||||
|
|
||||||
|
$sent_to = array();
|
||||||
|
|
||||||
|
$conn = jabber_connect();
|
||||||
|
|
||||||
|
// First, get users to whom this is a direct reply
|
||||||
|
$user = new User();
|
||||||
|
$user->query('SELECT user.id, user.jabber ' .
|
||||||
|
'FROM user JOIN reply ON user.id = reply.profile_id ' .
|
||||||
|
'WHERE reply.notice_id = ' . $notice->id . ' ' .
|
||||||
|
'AND user.jabber is not null ' .
|
||||||
|
'AND user.jabbernotify = 1 ' .
|
||||||
|
'AND user.jabberreplies = 1 ');
|
||||||
|
|
||||||
|
while ($user->fetch()) {
|
||||||
|
common_log(LOG_INFO,
|
||||||
|
'Sending reply notice ' . $notice->id . ' to ' . $user->jabber,
|
||||||
|
__FILE__);
|
||||||
|
$conn->message($user->jabber, $msg, 'chat', null, $entry);
|
||||||
|
$conn->processTime(0);
|
||||||
|
$sent_to[$user->id] = 1;
|
||||||
|
}
|
||||||
|
|
||||||
|
$user->free();
|
||||||
|
|
||||||
|
// Now, get users subscribed to this profile
|
||||||
|
|
||||||
|
$user = new User();
|
||||||
|
$user->query('SELECT user.id, user.jabber ' .
|
||||||
|
'FROM user JOIN subscription ' .
|
||||||
|
'ON user.id = subscription.subscriber ' .
|
||||||
|
'WHERE subscription.subscribed = ' . $notice->profile_id . ' ' .
|
||||||
|
'AND user.jabber is not null ' .
|
||||||
|
'AND user.jabbernotify = 1 ' .
|
||||||
'AND subscription.jabber = 1 ');
|
'AND subscription.jabber = 1 ');
|
||||||
|
|
||||||
while ($user->fetch()) {
|
while ($user->fetch()) {
|
||||||
if (!array_key_exists($user->id, $sent_to)) {
|
if (!array_key_exists($user->id, $sent_to)) {
|
||||||
common_log(LOG_INFO,
|
common_log(LOG_INFO,
|
||||||
'Sending notice ' . $notice->id . ' to ' . $user->jabber,
|
'Sending notice ' . $notice->id . ' to ' . $user->jabber,
|
||||||
__FILE__);
|
__FILE__);
|
||||||
$conn->message($user->jabber, $msg, 'chat', NULL, $entry);
|
$conn->message($user->jabber, $msg, 'chat', null, $entry);
|
||||||
# To keep the incoming queue from filling up, we service it after each send.
|
// To keep the incoming queue from filling up,
|
||||||
$conn->processTime(0);
|
// we service it after each send.
|
||||||
}
|
$conn->processTime(0);
|
||||||
}
|
}
|
||||||
|
}
|
||||||
|
|
||||||
$user->free();
|
$user->free();
|
||||||
|
|
||||||
return true;
|
return true;
|
||||||
}
|
}
|
||||||
|
|
||||||
function jabber_public_notice($notice) {
|
/**
|
||||||
|
* send a notice to all public listeners
|
||||||
|
*
|
||||||
|
* For notices that are generated on the local system (by users), we can optionally
|
||||||
|
* forward them to remote listeners by XMPP.
|
||||||
|
*
|
||||||
|
* @param Notice $notice notice to broadcast
|
||||||
|
*
|
||||||
|
* @return boolean success flag
|
||||||
|
*/
|
||||||
|
|
||||||
# Now, users who want everything
|
function jabber_public_notice($notice)
|
||||||
|
{
|
||||||
|
// Now, users who want everything
|
||||||
|
|
||||||
$public = common_config('xmpp', 'public');
|
$public = common_config('xmpp', 'public');
|
||||||
|
|
||||||
# FIXME PRIV don't send out private messages here
|
// FIXME PRIV don't send out private messages here
|
||||||
# XXX: should we send out non-local messages if public,localonly
|
// XXX: should we send out non-local messages if public,localonly
|
||||||
# = false? I think not
|
// = false? I think not
|
||||||
|
|
||||||
if ($public && $notice->is_local) {
|
if ($public && $notice->is_local) {
|
||||||
$profile = Profile::staticGet($notice->profile_id);
|
$profile = Profile::staticGet($notice->profile_id);
|
||||||
|
|
||||||
if (!$profile) {
|
if (!$profile) {
|
||||||
common_log(LOG_WARNING, 'Refusing to broadcast notice with ' .
|
common_log(LOG_WARNING, 'Refusing to broadcast notice with ' .
|
||||||
'unknown profile ' . common_log_objstring($notice),
|
'unknown profile ' . common_log_objstring($notice),
|
||||||
__FILE__);
|
__FILE__);
|
||||||
return false;
|
return false;
|
||||||
}
|
}
|
||||||
|
|
||||||
$msg = jabber_format_notice($profile, $notice);
|
$msg = jabber_format_notice($profile, $notice);
|
||||||
$entry = jabber_format_entry($profile, $notice);
|
$entry = jabber_format_entry($profile, $notice);
|
||||||
|
|
||||||
$conn = jabber_connect();
|
$conn = jabber_connect();
|
||||||
|
|
||||||
foreach ($public as $address) {
|
foreach ($public as $address) {
|
||||||
common_log(LOG_INFO,
|
common_log(LOG_INFO,
|
||||||
'Sending notice ' . $notice->id . ' to public listener ' . $address,
|
'Sending notice ' . $notice->id .
|
||||||
__FILE__);
|
' to public listener ' . $address,
|
||||||
$conn->message($address, $msg, 'chat', NULL, $entry);
|
__FILE__);
|
||||||
$conn->processTime(0);
|
$conn->message($address, $msg, 'chat', null, $entry);
|
||||||
}
|
$conn->processTime(0);
|
||||||
$profile->free();
|
}
|
||||||
}
|
$profile->free();
|
||||||
|
}
|
||||||
|
|
||||||
return true;
|
return true;
|
||||||
}
|
}
|
||||||
|
|
||||||
function jabber_format_notice(&$profile, &$notice) {
|
/**
|
||||||
return $profile->nickname . ': ' . $notice->content;
|
* makes a plain-text formatted version of a notice, suitable for Jabber distribution
|
||||||
|
*
|
||||||
|
* @param Profile &$profile profile of the sending user
|
||||||
|
* @param Notice &$notice notice being sent
|
||||||
|
*
|
||||||
|
* @return string plain-text version of the notice, with user nickname prefixed
|
||||||
|
*/
|
||||||
|
|
||||||
|
function jabber_format_notice(&$profile, &$notice)
|
||||||
|
{
|
||||||
|
return $profile->nickname . ': ' . $notice->content;
|
||||||
}
|
}
|
||||||
|
|||||||
Loading…
Reference in New Issue
Block a user