exit(1);
}
-set_include_path(get_include_path() . PATH_SEPARATOR . INSTALLDIR . '/extlib/XMPPHP');
-
/**
* Plugin for XMPP
*
* @license http://www.fsf.org/licensing/licenses/agpl-3.0.html AGPL 3.0
* @link http://status.net/
*/
-
class XmppPlugin extends ImPlugin
{
public $server = null;
public $port = 5222;
public $user = 'update';
- public $resource = null;
+ public $resource = 'gnusocial';
public $encryption = true;
public $password = null;
public $host = null; // only set if != server
public $transport = 'xmpp';
- protected $fake_xmpp;
-
function getDisplayName(){
- return _m('XMPP/Jabber/GTalk');
+ // TRANS: Plugin display name.
+ return _m('XMPP/Jabber');
}
- function normalize($screenname)
+ /**
+ * Splits a Jabber ID (JID) into node, domain, and resource portions.
+ *
+ * Based on validation routine submitted by:
+ * @copyright 2009 Patrick Georgi <patrick@georgi-clan.de>
+ * @license Licensed under ISC-L, which is compatible with everything else that keeps the copyright notice intact.
+ *
+ * @param string $jid string to check
+ *
+ * @return array with "node", "domain", and "resource" indices
+ * @throws Exception if input is not valid
+ */
+ protected function splitJid($jid)
{
- if (preg_match("/(?:([^\@]+)\@)?([^\/]+)(?:\/(.*))?$/", $screenname, $matches)) {
- $node = $matches[1];
- $server = $matches[2];
- return strtolower($node.'@'.$server);
+ $chars = '';
+ /* the following definitions come from stringprep, Appendix C,
+ which is used in its entirety by nodeprop, Chapter 5, "Prohibited Output" */
+ /* C1.1 ASCII space characters */
+ $chars .= "\x{20}";
+ /* C1.2 Non-ASCII space characters */
+ $chars .= "\x{a0}\x{1680}\x{2000}-\x{200b}\x{202f}\x{205f}\x{3000a}";
+ /* C2.1 ASCII control characters */
+ $chars .= "\x{00}-\x{1f}\x{7f}";
+ /* C2.2 Non-ASCII control characters */
+ $chars .= "\x{80}-\x{9f}\x{6dd}\x{70f}\x{180e}\x{200c}\x{200d}\x{2028}\x{2029}\x{2060}-\x{2063}\x{206a}-\x{206f}\x{feff}\x{fff9}-\x{fffc}\x{1d173}-\x{1d17a}";
+ /* C3 - Private Use */
+ $chars .= "\x{e000}-\x{f8ff}\x{f0000}-\x{ffffd}\x{100000}-\x{10fffd}";
+ /* C4 - Non-character code points */
+ $chars .= "\x{fdd0}-\x{fdef}\x{fffe}\x{ffff}\x{1fffe}\x{1ffff}\x{2fffe}\x{2ffff}\x{3fffe}\x{3ffff}\x{4fffe}\x{4ffff}\x{5fffe}\x{5ffff}\x{6fffe}\x{6ffff}\x{7fffe}\x{7ffff}\x{8fffe}\x{8ffff}\x{9fffe}\x{9ffff}\x{afffe}\x{affff}\x{bfffe}\x{bffff}\x{cfffe}\x{cffff}\x{dfffe}\x{dffff}\x{efffe}\x{effff}\x{ffffe}\x{fffff}\x{10fffe}\x{10ffff}";
+ /* C5 - Surrogate codes */
+ $chars .= "\x{d800}-\x{dfff}";
+ /* C6 - Inappropriate for plain text */
+ $chars .= "\x{fff9}-\x{fffd}";
+ /* C7 - Inappropriate for canonical representation */
+ $chars .= "\x{2ff0}-\x{2ffb}";
+ /* C8 - Change display properties or are deprecated */
+ $chars .= "\x{340}\x{341}\x{200e}\x{200f}\x{202a}-\x{202e}\x{206a}-\x{206f}";
+ /* C9 - Tagging characters */
+ $chars .= "\x{e0001}\x{e0020}-\x{e007f}";
+
+ /* Nodeprep forbids some more characters */
+ $nodeprepchars = $chars;
+ $nodeprepchars .= "\x{22}\x{26}\x{27}\x{2f}\x{3a}\x{3c}\x{3e}\x{40}";
+
+ $parts = explode("/", $jid, 2);
+ if (count($parts) > 1) {
+ $resource = $parts[1];
+ if ($resource == '') {
+ // Warning: empty resource isn't legit.
+ // But if we're normalizing, we may as well take it...
+ }
+ } else {
+ $resource = null;
+ }
+
+ $node = explode("@", $parts[0]);
+ if ((count($node) > 2) || (count($node) == 0)) {
+ // TRANS: Exception thrown when using too many @ signs in a Jabber ID.
+ throw new Exception(_m('Invalid JID: too many @s.'));
+ } else if (count($node) == 1) {
+ $domain = $node[0];
+ $node = null;
} else {
+ $domain = $node[1];
+ $node = $node[0];
+ if ($node == '') {
+ // TRANS: Exception thrown when using @ sign not followed by a Jabber ID.
+ throw new Exception(_m('Invalid JID: @ but no node'));
+ }
+ }
+
+ // Length limits per http://xmpp.org/rfcs/rfc3920.html#addressing
+ if ($node !== null) {
+ if (strlen($node) > 1023) {
+ // TRANS: Exception thrown when using too long a Jabber ID (>1023).
+ throw new Exception(_m('Invalid JID: node too long.'));
+ }
+ if (preg_match("/[".$nodeprepchars."]/u", $node)) {
+ // TRANS: Exception thrown when using an invalid Jabber ID.
+ // TRANS: %s is the invalid Jabber ID.
+ throw new Exception(sprintf(_m('Invalid JID node "%s".'),$node));
+ }
+ }
+
+ if (strlen($domain) > 1023) {
+ // TRANS: Exception thrown when using too long a Jabber domain (>1023).
+ throw new Exception(_m('Invalid JID: domain too long.'));
+ }
+ if (!common_valid_domain($domain)) {
+ // TRANS: Exception thrown when using an invalid Jabber domain name.
+ // TRANS: %s is the invalid domain name.
+ throw new Exception(sprintf(_m('Invalid JID domain name "%s".'),$domain));
+ }
+
+ if ($resource !== null) {
+ if (strlen($resource) > 1023) {
+ // TRANS: Exception thrown when using too long a resource (>1023).
+ throw new Exception("Invalid JID: resource too long.");
+ }
+ if (preg_match("/[".$chars."]/u", $resource)) {
+ // TRANS: Exception thrown when using an invalid Jabber resource.
+ // TRANS: %s is the invalid resource.
+ throw new Exception(sprintf(_m('Invalid JID resource "%s".'),$resource));
+ }
+ }
+
+ return array('node' => is_null($node) ? null : mb_strtolower($node),
+ 'domain' => is_null($domain) ? null : mb_strtolower($domain),
+ 'resource' => $resource);
+ }
+
+ /**
+ * Checks whether a string is a syntactically valid Jabber ID (JID),
+ * either with or without a resource.
+ *
+ * Note that a bare domain can be a valid JID.
+ *
+ * @param string $jid string to check
+ * @param bool $check_domain whether we should validate that domain...
+ *
+ * @return boolean whether the string is a valid JID
+ */
+ protected function validateFullJid($jid, $check_domain=false)
+ {
+ try {
+ $parts = $this->splitJid($jid);
+ if ($check_domain) {
+ if (!$this->checkDomain($parts['domain'])) {
+ return false;
+ }
+ }
+ return $parts['resource'] !== ''; // missing or present; empty ain't kosher
+ } catch (Exception $e) {
+ return false;
+ }
+ }
+
+ /**
+ * Checks whether a string is a syntactically valid base Jabber ID (JID).
+ * A base JID won't include a resource specifier on the end; since we
+ * take it off when reading input we can't really use them reliably
+ * to direct outgoing messages yet (sorry guys!)
+ *
+ * Note that a bare domain can be a valid JID.
+ *
+ * @param string $jid string to check
+ * @param bool $check_domain whether we should validate that domain...
+ *
+ * @return boolean whether the string is a valid JID
+ */
+ protected function validateBaseJid($jid, $check_domain=false)
+ {
+ try {
+ $parts = $this->splitJid($jid);
+ if ($check_domain) {
+ if (!$this->checkDomain($parts['domain'])) {
+ return false;
+ }
+ }
+ return ($parts['resource'] === null); // missing; empty ain't kosher
+ } catch (Exception $e) {
+ return false;
+ }
+ }
+
+ /**
+ * Normalizes a Jabber ID for comparison, dropping the resource component if any.
+ *
+ * @param string $jid JID to check
+ * @param bool $check_domain if true, reject if the domain isn't findable
+ *
+ * @return string an equivalent JID in normalized (lowercase) form
+ */
+ function normalize($jid)
+ {
+ try {
+ $parts = $this->splitJid($jid);
+ if ($parts['node'] !== null) {
+ return $parts['node'] . '@' . $parts['domain'];
+ } else {
+ return $parts['domain'];
+ }
+ } catch (Exception $e) {
return null;
}
}
- function daemon_screenname()
+ /**
+ * Check if this domain's got some legit DNS record
+ */
+ protected function checkDomain($domain)
+ {
+ if (checkdnsrr("_xmpp-server._tcp." . $domain, "SRV")) {
+ return true;
+ }
+ if (checkdnsrr($domain, "ANY")) {
+ return true;
+ }
+ return false;
+ }
+
+ function daemonScreenname()
{
$ret = $this->user . '@' . $this->server;
if($this->resource)
function validate($screenname)
{
- // Cheap but effective
- return Validate::email($screenname);
+ return $this->validateBaseJid($screenname, common_config('email', 'check_domain'));
}
/**
switch ($cls)
{
case 'XMPPHP_XMPP':
- require_once 'XMPP.php';
- return false;
- case 'Sharing_XMPP':
- case 'Fake_XMPP':
- require_once $dir . '/'.$cls.'.php';
+ require_once $dir . '/extlib/XMPPHP/XMPP.php';
return false;
- case 'XmppManager':
- require_once $dir . '/'.strtolower($cls).'.php';
- return false;
- default:
- return true;
}
+
+ return parent::onAutoload($cls);
}
function onStartImDaemonIoManagers(&$classes)
{
- parent::onStartImDaemonIoManagers(&$classes);
+ parent::onStartImDaemonIoManagers($classes);
$classes[] = new XmppManager($this); // handles pings/reconnects
return true;
}
- function microiduri($screenname)
- {
- return 'xmpp:' . $screenname;
- }
-
- function send_message($screenname, $body)
+ function sendMessage($screenname, $body)
{
- $this->fake_xmpp->message($screenname, $body, 'chat');
- $this->enqueue_outgoing_raw($this->fake_xmpp->would_be_sent);
- return true;
+ $this->queuedConnection()->message($screenname, $body, 'chat');
}
- function send_notice($screenname, $notice)
+ function sendNotice($screenname, Notice $notice)
{
- $msg = $this->format_notice($notice);
+ $msg = $this->formatNotice($notice);
$entry = $this->format_entry($notice);
-
- $this->fake_xmpp->message($screenname, $msg, 'chat', null, $entry);
- $this->enqueue_outgoing_raw($this->fake_xmpp->would_be_sent);
+
+ $this->queuedConnection()->message($screenname, $msg, 'chat', null, $entry);
return true;
}
*
* @return string Extra information (Atom, HTML, addresses) in string format
*/
-
- function format_entry($notice)
+ protected function format_entry(Notice $notice)
{
$profile = $notice->getProfile();
$xs = new XMLStringer();
$xs->elementStart('html', array('xmlns' => 'http://jabber.org/protocol/xhtml-im'));
$xs->elementStart('body', array('xmlns' => 'http://www.w3.org/1999/xhtml'));
- $xs->element('a', array('href' => $profile->profileurl),
- $profile->nickname);
- $xs->text(": ");
- if (!empty($notice->rendered)) {
- $xs->raw($notice->rendered);
- } else {
- $xs->raw(common_render_content($notice->content, $notice));
+ $xs->element('a', array('href' => $profile->profileurl), $profile->nickname);
+ try {
+ $parent = $notice->getParent();
+ $orig_profile = $parent->getProfile();
+ $orig_profurl = $orig_profile->getUrl();
+ $xs->text(" => ");
+ $xs->element('a', array('href' => $orig_profurl), $orig_profile->nickname);
+ $xs->text(": ");
+ } catch (InvalidUrlException $e) {
+ $xs->text(sprintf(' => %s', $orig_profile->nickname));
+ } catch (NoParentNoticeException $e) {
+ $xs->text(": ");
+ } catch (NoResultException $e) {
+ // Parent notice was probably deleted.
+ $xs->text(": ");
}
+ // FIXME: Why do we replace \t with ''? is it just to make it pretty? shouldn't whitespace be handled well...?
+ $xs->raw(str_replace("\t", "", $notice->getRendered()));
$xs->text(" ");
$xs->element('a', array(
'href'=>common_local_url('conversation',
- array('id' => $notice->conversation)).'#notice-'.$notice->id
- ),sprintf(_('[%s]'),$notice->id));
+ array('id' => $notice->conversation)).'#notice-'.$notice->id),
+ // TRANS: Link description to notice in conversation.
+ // TRANS: %s is a notice ID.
+ sprintf(_m('[%u]'),$notice->id));
$xs->elementEnd('body');
$xs->elementEnd('html');
return $html . ' ' . $entry;
}
- function receive_raw_message($pl)
+ function receiveRawMessage($pl)
{
$from = $this->normalize($pl['from']);
if ($pl['type'] != 'chat') {
- common_log(LOG_WARNING, "Ignoring message of type ".$pl['type']." from $from.");
+ $this->log(LOG_WARNING, "Ignoring message of type ".$pl['type']." from $from: " . $pl['xml']->toString());
return true;
}
if (mb_strlen($pl['body']) == 0) {
- common_log(LOG_WARNING, "Ignoring message with empty body from $from.");
+ $this->log(LOG_WARNING, "Ignoring message with empty body from $from: " . $pl['xml']->toString());
return true;
}
- return $this->handle_incoming($from, $pl['body']);
+ $this->handleIncoming($from, $pl['body']);
+
+ return true;
}
- function initialize(){
+ /**
+ * Build a queue-proxied XMPP interface object. Any outgoing messages
+ * will be run back through us for enqueing rather than sent directly.
+ *
+ * @return QueuedXMPP
+ * @throws Exception if server settings are invalid.
+ */
+ function queuedConnection(){
if(!isset($this->server)){
- throw new Exception("must specify a server");
+ // TRANS: Exception thrown when the plugin configuration is incorrect.
+ throw new Exception(_m('You must specify a server in the configuration.'));
}
if(!isset($this->port)){
- throw new Exception("must specify a port");
+ // TRANS: Exception thrown when the plugin configuration is incorrect.
+ throw new Exception(_m('You must specify a port in the configuration.'));
}
if(!isset($this->user)){
- throw new Exception("must specify a user");
+ // TRANS: Exception thrown when the plugin configuration is incorrect.
+ throw new Exception(_m('You must specify a user in the configuration.'));
}
if(!isset($this->password)){
- throw new Exception("must specify a password");
+ // TRANS: Exception thrown when the plugin configuration is incorrect.
+ throw new Exception(_m('You must specify a password in the configuration.'));
}
- $this->fake_xmpp = new Fake_XMPP($this->host ?
+ return new QueuedXMPP($this, $this->host ?
$this->host :
$this->server,
$this->port,
$this->debug ?
XMPPHP_Log::LEVEL_VERBOSE : null
);
+ }
+
+ /**
+ * Add XMPP plugin daemon to the list of daemon to start
+ *
+ * @param array $daemons the list of daemons to run
+ *
+ * @return boolean hook return
+ */
+ function onGetValidDaemons(array &$daemons)
+ {
+ if( isset($this->server) &&
+ isset($this->port) &&
+ isset($this->user) &&
+ isset($this->password) ){
+
+ array_push(
+ $daemons,
+ INSTALLDIR
+ . '/scripts/imdaemon.php'
+ );
+ }
+
return true;
}
- function onPluginVersion(&$versions)
+
+ function onPluginVersion(array &$versions)
{
$versions[] = array('name' => 'XMPP',
- 'version' => STATUSNET_VERSION,
+ 'version' => GNUSOCIAL_VERSION,
'author' => 'Craig Andrews, Evan Prodromou',
'homepage' => 'http://status.net/wiki/Plugin:XMPP',
'rawdescription' =>
+ // TRANS: Plugin description.
_m('The XMPP plugin allows users to send and receive notices over the XMPP/Jabber network.'));
return true;
}
projects / quix0rs-gnu-social.git / blobdiff