Modern version of XMPPHP extlib

Original XMPPHP is no longer maintained
Therefore I've done some optimizations and imported some commits from birkner and zorn-v forks.
None of the forks really looked ready to be adopted...
This commit is contained in:
Diogo Cordeiro 2019-04-21 01:23:50 +01:00
parent a59c439b46
commit 3290227b50
13 changed files with 2262 additions and 2024 deletions

View File

@ -525,7 +525,7 @@ abstract class ImPlugin extends Plugin
{ {
// If we don't require CLI mode, or if we do and GNUSOCIAL_CLI _is_ set, then connect the transports // If we don't require CLI mode, or if we do and GNUSOCIAL_CLI _is_ set, then connect the transports
// This check is made mostly because some IM plugins can't deliver to transports unless they // This check is made mostly because some IM plugins can't deliver to transports unless they
// have continously running daemons (such as XMPP) and we can't have that over HTTP requests. // have continuously running daemons (such as XMPP) and we can't have that over HTTP requests.
if (!$this->requires_cli || defined('GNUSOCIAL_CLI')) { if (!$this->requires_cli || defined('GNUSOCIAL_CLI')) {
$manager->connect($this->transport . '-in', new ImReceiverQueueHandler($this), 'im'); $manager->connect($this->transport . '-in', new ImReceiverQueueHandler($this), 'im');
$manager->connect($this->transport, new ImQueueHandler($this)); $manager->connect($this->transport, new ImQueueHandler($this));

View File

@ -5,7 +5,7 @@
* *
* Send and receive notices using the XMPP network * Send and receive notices using the XMPP network
* *
* PHP version 5 * PHP version 7
* *
* This program is free software: you can redistribute it and/or modify * 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
@ -48,7 +48,7 @@ class XmppPlugin extends ImPlugin
{ {
public $server = null; public $server = null;
public $port = 5222; public $port = 5222;
public $user = 'update'; public $user = 'update';
public $resource = 'gnusocial'; public $resource = 'gnusocial';
public $encryption = true; public $encryption = true;
public $password = null; public $password = null;
@ -57,22 +57,66 @@ class XmppPlugin extends ImPlugin
public $transport = 'xmpp'; public $transport = 'xmpp';
function getDisplayName(){ function getDisplayName()
{
// TRANS: Plugin display name. // TRANS: Plugin display name.
return _m('XMPP/Jabber'); return _m('XMPP/Jabber');
} }
function daemonScreenname()
{
$ret = $this->user . '@' . $this->server;
if ($this->resource) {
return $ret . '/' . $this->resource;
} else {
return $ret;
}
}
function validate($screenname)
{
return $this->validateBaseJid($screenname, common_config('email', 'check_domain'));
}
/**
* 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;
}
}
/** /**
* Splits a Jabber ID (JID) into node, domain, and resource portions. * Splits a Jabber ID (JID) into node, domain, and resource portions.
* *
* Based on validation routine submitted by: * 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 * @param string $jid string to check
* *
* @return array with "node", "domain", and "resource" indices * @return array with "node", "domain", and "resource" indices
* @throws Exception if input is not valid * @throws Exception if input is not valid
* @license Licensed under ISC-L, which is compatible with everything else that keeps the copyright notice intact.
*
* @copyright 2009 Patrick Georgi <patrick@georgi-clan.de>
*/ */
protected function splitJid($jid) protected function splitJid($jid)
{ {
@ -109,10 +153,9 @@ class XmppPlugin extends ImPlugin
$parts = explode("/", $jid, 2); $parts = explode("/", $jid, 2);
if (count($parts) > 1) { if (count($parts) > 1) {
$resource = $parts[1]; $resource = $parts[1];
if ($resource == '') { // if ($resource == '') then
// Warning: empty resource isn't legit. // Warning: empty resource isn't legit.
// But if we're normalizing, we may as well take it... // But if we're normalizing, we may as well take it...
}
} else { } else {
$resource = null; $resource = null;
} }
@ -128,7 +171,7 @@ class XmppPlugin extends ImPlugin
$domain = $node[1]; $domain = $node[1];
$node = $node[0]; $node = $node[0];
if ($node == '') { if ($node == '') {
// TRANS: Exception thrown when using @ sign not followed by a Jabber ID. // TRANS: Exception thrown when using @ sign not followed by a Jabber ID.
throw new Exception(_m('Invalid JID: @ but no node')); throw new Exception(_m('Invalid JID: @ but no node'));
} }
} }
@ -139,10 +182,10 @@ class XmppPlugin extends ImPlugin
// TRANS: Exception thrown when using too long a Jabber ID (>1023). // TRANS: Exception thrown when using too long a Jabber ID (>1023).
throw new Exception(_m('Invalid JID: node too long.')); throw new Exception(_m('Invalid JID: node too long.'));
} }
if (preg_match("/[".$nodeprepchars."]/u", $node)) { if (preg_match("/[" . $nodeprepchars . "]/u", $node)) {
// TRANS: Exception thrown when using an invalid Jabber ID. // TRANS: Exception thrown when using an invalid Jabber ID.
// TRANS: %s is the invalid Jabber ID. // TRANS: %s is the invalid Jabber ID.
throw new Exception(sprintf(_m('Invalid JID node "%s".'),$node)); throw new Exception(sprintf(_m('Invalid JID node "%s".'), $node));
} }
} }
@ -153,7 +196,7 @@ class XmppPlugin extends ImPlugin
if (!common_valid_domain($domain)) { if (!common_valid_domain($domain)) {
// TRANS: Exception thrown when using an invalid Jabber domain name. // TRANS: Exception thrown when using an invalid Jabber domain name.
// TRANS: %s is the invalid domain name. // TRANS: %s is the invalid domain name.
throw new Exception(sprintf(_m('Invalid JID domain name "%s".'),$domain)); throw new Exception(sprintf(_m('Invalid JID domain name "%s".'), $domain));
} }
if ($resource !== null) { if ($resource !== null) {
@ -161,96 +204,22 @@ class XmppPlugin extends ImPlugin
// TRANS: Exception thrown when using too long a resource (>1023). // TRANS: Exception thrown when using too long a resource (>1023).
throw new Exception("Invalid JID: resource too long."); throw new Exception("Invalid JID: resource too long.");
} }
if (preg_match("/[".$chars."]/u", $resource)) { if (preg_match("/[" . $chars . "]/u", $resource)) {
// TRANS: Exception thrown when using an invalid Jabber resource. // TRANS: Exception thrown when using an invalid Jabber resource.
// TRANS: %s is the invalid resource. // TRANS: %s is the invalid resource.
throw new Exception(sprintf(_m('Invalid JID resource "%s".'),$resource)); throw new Exception(sprintf(_m('Invalid JID resource "%s".'), $resource));
} }
} }
return array('node' => is_null($node) ? null : mb_strtolower($node), return array('node' => is_null($node) ? null : mb_strtolower($node),
'domain' => is_null($domain) ? null : mb_strtolower($domain), 'domain' => is_null($domain) ? null : mb_strtolower($domain),
'resource' => $resource); '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;
}
} }
/** /**
* Check if this domain's got some legit DNS record * Check if this domain's got some legit DNS record
* @param $domain
* @return bool
*/ */
protected function checkDomain($domain) protected function checkDomain($domain)
{ {
@ -263,22 +232,6 @@ class XmppPlugin extends ImPlugin
return false; return false;
} }
function daemonScreenname()
{
$ret = $this->user . '@' . $this->server;
if($this->resource)
{
return $ret . '/' . $this->resource;
}else{
return $ret;
}
}
function validate($screenname)
{
return $this->validateBaseJid($screenname, common_config('email', 'check_domain'));
}
/** /**
* Load related modules when needed * Load related modules when needed
* *
@ -289,13 +242,10 @@ class XmppPlugin extends ImPlugin
function onAutoload($cls) function onAutoload($cls)
{ {
$dir = dirname(__FILE__); switch ($cls) {
case 'XMPPHP_XMPP':
switch ($cls) require_once __DIR__ . '/extlib/XMPPHP/XMPP.php';
{ return false;
case 'XMPPHP_XMPP':
require_once $dir . '/extlib/XMPPHP/XMPP.php';
return false;
} }
return parent::onAutoload($cls); return parent::onAutoload($cls);
@ -313,10 +263,51 @@ class XmppPlugin extends ImPlugin
$this->queuedConnection()->message($screenname, $body, 'chat'); $this->queuedConnection()->message($screenname, $body, 'chat');
} }
/**
* 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)) {
// 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)) {
// 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)) {
// 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)) {
// TRANS: Exception thrown when the plugin configuration is incorrect.
throw new Exception(_m('You must specify a password in the configuration.'));
}
return new QueuedXMPP($this, $this->host ?
$this->host :
$this->server,
$this->port,
$this->user,
$this->password,
$this->resource,
$this->server,
$this->debug ?
true : false,
$this->debug ?
\XMPPHP\Log::LEVEL_VERBOSE : null
);
}
function sendNotice($screenname, Notice $notice) function sendNotice($screenname, Notice $notice)
{ {
try { try {
$msg = $this->formatNotice($notice); $msg = $this->formatNotice($notice);
$entry = $this->format_entry($notice); $entry = $this->format_entry($notice);
} catch (Exception $e) { } catch (Exception $e) {
common_log(LOG_ERR, __METHOD__ . ": Discarding outgoing stanza because of exception: {$e->getMessage()}"); common_log(LOG_ERR, __METHOD__ . ": Discarding outgoing stanza because of exception: {$e->getMessage()}");
@ -329,8 +320,7 @@ class XmppPlugin extends ImPlugin
/** /**
* extra information for XMPP messages, as defined by Twitter * extra information for XMPP messages, as defined by Twitter
* *
* @param Profile $profile Profile of the sending user * @param Notice $notice Notice being sent
* @param Notice $notice Notice being sent
* *
* @return string Extra information (Atom, HTML, addresses) in string format * @return string Extra information (Atom, HTML, addresses) in string format
*/ */
@ -351,23 +341,18 @@ class XmppPlugin extends ImPlugin
$xs->text(" => "); $xs->text(" => ");
$xs->element('a', array('href' => $orig_profurl), $orig_profile->nickname); $xs->element('a', array('href' => $orig_profurl), $orig_profile->nickname);
$xs->text(": "); $xs->text(": ");
} catch (InvalidUrlException $e) {
$xs->text(sprintf(' => %s', $orig_profile->nickname));
} catch (NoParentNoticeException $e) { } catch (NoParentNoticeException $e) {
$xs->text(": "); $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...? // 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->raw(str_replace("\t", "", $notice->getRendered()));
$xs->text(" "); $xs->text(" ");
$xs->element('a', array( $xs->element('a', array(
'href'=>common_local_url('conversation', 'href' => common_local_url('conversation',
array('id' => $notice->conversation)).'#notice-'.$notice->id), array('id' => $notice->conversation)) . '#notice-' . $notice->id),
// TRANS: Link description to notice in conversation. // TRANS: Link description to notice in conversation.
// TRANS: %s is a notice ID. // TRANS: %s is a notice ID.
sprintf(_m('[%u]'),$notice->id)); sprintf(_m('[%u]'), $notice->id));
$xs->elementEnd('body'); $xs->elementEnd('body');
$xs->elementEnd('html'); $xs->elementEnd('html');
@ -381,12 +366,12 @@ class XmppPlugin extends ImPlugin
$from = $this->normalize($pl['from']); $from = $this->normalize($pl['from']);
if ($pl['type'] != 'chat') { if ($pl['type'] != 'chat') {
$this->log(LOG_WARNING, "Ignoring message of type ".$pl['type']." from $from: " . $pl['xml']->toString()); $this->log(LOG_WARNING, "Ignoring message of type " . $pl['type'] . " from $from: " . $pl['xml']->toString());
return true; return true;
} }
if (mb_strlen($pl['body']) == 0) { if (mb_strlen($pl['body']) == 0) {
$this->log(LOG_WARNING, "Ignoring message with empty body from $from: " . $pl['xml']->toString()); $this->log(LOG_WARNING, "Ignoring message with empty body from $from: " . $pl['xml']->toString());
return true; return true;
} }
@ -396,43 +381,23 @@ class XmppPlugin extends ImPlugin
} }
/** /**
* Build a queue-proxied XMPP interface object. Any outgoing messages * Normalizes a Jabber ID for comparison, dropping the resource component if any.
* will be run back through us for enqueing rather than sent directly.
* *
* @return QueuedXMPP * @param string $jid JID to check
* @throws Exception if server settings are invalid. * @return string an equivalent JID in normalized (lowercase) form
*/ */
function queuedConnection(){ function normalize($jid)
if(!isset($this->server)){ {
// TRANS: Exception thrown when the plugin configuration is incorrect. try {
throw new Exception(_m('You must specify a server in the configuration.')); $parts = $this->splitJid($jid);
if ($parts['node'] !== null) {
return $parts['node'] . '@' . $parts['domain'];
} else {
return $parts['domain'];
}
} catch (Exception $e) {
return null;
} }
if(!isset($this->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)){
// 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)){
// TRANS: Exception thrown when the plugin configuration is incorrect.
throw new Exception(_m('You must specify a password in the configuration.'));
}
return new QueuedXMPP($this, $this->host ?
$this->host :
$this->server,
$this->port,
$this->user,
$this->password,
$this->resource,
$this->server,
$this->debug ?
true : false,
$this->debug ?
XMPPHP_Log::LEVEL_VERBOSE : null
);
} }
/** /**
@ -444,10 +409,10 @@ class XmppPlugin extends ImPlugin
*/ */
function onGetValidDaemons(&$daemons) function onGetValidDaemons(&$daemons)
{ {
if( isset($this->server) && if (isset($this->server) &&
isset($this->port) && isset($this->port) &&
isset($this->user) && isset($this->user) &&
isset($this->password) ){ isset($this->password)) {
array_push( array_push(
$daemons, $daemons,
@ -459,17 +424,42 @@ class XmppPlugin extends ImPlugin
return true; return true;
} }
function onPluginVersion(array &$versions) function onPluginVersion(array &$versions)
{ {
$versions[] = array('name' => 'XMPP', $versions[] = array('name' => 'XMPP',
'version' => GNUSOCIAL_VERSION, 'version' => GNUSOCIAL_VERSION,
'author' => 'Craig Andrews, Evan Prodromou', 'author' => 'Craig Andrews, Evan Prodromou',
'homepage' => 'https://git.gnu.io/gnu/gnu-social/tree/master/plugins/XMPP', 'homepage' => 'https://git.gnu.io/gnu/gnu-social/tree/master/plugins/XMPP',
'rawdescription' => 'rawdescription' =>
// TRANS: Plugin description. // TRANS: Plugin description.
_m('The XMPP plugin allows users to send and receive notices over the XMPP/Jabber network.')); _m('The XMPP plugin allows users to send and receive notices over the XMPP/Jabber network.'));
return true; return true;
} }
/**
* 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;
}
}
} }

View File

@ -1,4 +1,5 @@
<?php <?php
/** /**
* XMPPHP: The PHP XMPP Library * XMPPHP: The PHP XMPP Library
* Copyright (C) 2008 Nathanael C. Fritz * Copyright (C) 2008 Nathanael C. Fritz
@ -19,170 +20,390 @@
* Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
* *
* @category xmpphp * @category xmpphp
* @package XMPPHP * @package XMPPHP
* @author Nathanael C. Fritz <JID: fritzy@netflint.net> * @author Nathanael C. Fritz <JID: fritzy@netflint.net>
* @author Stephan Wentz <JID: stephan@jabber.wentz.it> * @author Stephan Wentz <JID: stephan@jabber.wentz.it>
* @author Michael Garvin <JID: gar@netflint.net> * @author Michael Garvin <JID: gar@netflint.net>
* @author Alexander Birkner (https://github.com/BirknerAlex)
* @author zorn-v (https://github.com/zorn-v/xmpphp/)
* @author GNU social
* @copyright 2008 Nathanael C. Fritz * @copyright 2008 Nathanael C. Fritz
*/ */
namespace XMPPHP;
use SimpleXMLElement;
/** XMPPHP_XMLStream */ /** XMPPHP_XMLStream */
require_once dirname(__FILE__) . "/XMPP.php"; require_once __DIR__ . "/XMPP.php";
/** /**
* XMPPHP Main Class * XMPPHP BOSH
* *
* @category xmpphp * @property int lat
* @package XMPPHP * @package XMPPHP
* @author Nathanael C. Fritz <JID: fritzy@netflint.net> * @author Nathanael C. Fritz <JID: fritzy@netflint.net>
* @author Stephan Wentz <JID: stephan@jabber.wentz.it> * @author Stephan Wentz <JID: stephan@jabber.wentz.it>
* @author Michael Garvin <JID: gar@netflint.net> * @author Michael Garvin <JID: gar@netflint.net>
* @copyright 2008 Nathanael C. Fritz * @copyright 2008 Nathanael C. Fritz
* @version $Id$ * @version $Id$
*/ */
class XMPPHP_BOSH extends XMPPHP_XMPP { class BOSH extends XMPP
{
/**
* @var integer
*/
protected $rid;
protected $rid; /**
protected $sid; * @var string
protected $http_server; */
protected $http_buffer = Array(); protected $sid;
protected $session = false;
public function connect($server, $wait='1', $session=false) { /**
$this->http_server = $server; * @var string
$this->use_encryption = false; */
$this->session = $session; protected $http_server;
$this->rid = 3001; /**
$this->sid = null; * @var array
if($session) */
{ protected $http_buffer = array();
$this->loadSession();
}
if(!$this->sid) {
$body = $this->__buildBody();
$body->addAttribute('hold','1');
$body->addAttribute('to', $this->host);
$body->addAttribute('route', "xmpp:{$this->host}:{$this->port}");
$body->addAttribute('secure','true');
$body->addAttribute('xmpp:version','1.6', 'urn:xmpp:xbosh');
$body->addAttribute('wait', strval($wait));
$body->addAttribute('ack','1');
$body->addAttribute('xmlns:xmpp','urn:xmpp:xbosh');
$buff = "<stream:stream xmlns='jabber:client' xmlns:stream='http://etherx.jabber.org/streams'>";
xml_parse($this->parser, $buff, false);
$response = $this->__sendBody($body);
$rxml = new SimpleXMLElement($response);
$this->sid = $rxml['sid'];
} else { /**
$buff = "<stream:stream xmlns='jabber:client' xmlns:stream='http://etherx.jabber.org/streams'>"; * @var string
xml_parse($this->parser, $buff, false); */
} protected $session = false;
}
public function __sendBody($body=null, $recv=true) { /**
if(!$body) { * @var integer
$body = $this->__buildBody(); */
} protected $inactivity;
$ch = curl_init($this->http_server);
curl_setopt($ch, CURLOPT_HEADER, 0);
curl_setopt($ch, CURLOPT_POST, 1);
curl_setopt($ch, CURLOPT_POSTFIELDS, $body->asXML());
curl_setopt($ch, CURLOPT_FOLLOWLOCATION, true);
$header = array('Accept-Encoding: gzip, deflate','Content-Type: text/xml; charset=utf-8');
curl_setopt($ch, CURLOPT_HTTPHEADER, $header );
curl_setopt($ch, CURLOPT_VERBOSE, 0);
$output = '';
if($recv) {
curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);
$output = curl_exec($ch);
$this->http_buffer[] = $output;
}
curl_close($ch);
return $output;
}
public function __buildBody($sub=null) { /**
$xml = new SimpleXMLElement("<body xmlns='http://jabber.org/protocol/httpbind' xmlns:xmpp='urn:xmpp:xbosh' />"); * Connect
$xml->addAttribute('content', 'text/xml; charset=utf-8'); *
$xml->addAttribute('rid', $this->rid); * @param $server
$this->rid += 1; * @param $wait
if($this->sid) $xml->addAttribute('sid', $this->sid); * @param $session
#if($this->sid) $xml->addAttribute('xmlns', 'http://jabber.org/protocol/httpbind'); * @throws Exception
$xml->addAttribute('xml:lang', 'en'); * @throws Exception
if($sub) { // ok, so simplexml is lame */
$p = dom_import_simplexml($xml); public function connect($server = null, $wait = '1', $session = false)
$c = dom_import_simplexml($sub); {
$cn = $p->ownerDocument->importNode($c, true);
$p->appendChild($cn);
$xml = simplexml_import_dom($p);
}
return $xml;
}
public function __process() { if (is_null($server)) {
if($this->http_buffer) {
$this->__parseBuffer();
} else {
$this->__sendBody();
$this->__parseBuffer();
}
}
public function __parseBuffer() { // If we aren't given the server http url, try and guess it
while ($this->http_buffer) { $port_string = ($this->port AND $this->port != 80) ? ':' . $this->port : '';
$idx = key($this->http_buffer); $this->http_server = 'http://' . $this->host . $port_string . '/http-bind/';
$buffer = $this->http_buffer[$idx]; } else {
unset($this->http_buffer[$idx]); $this->http_server = $server;
if($buffer) { }
$xml = new SimpleXMLElement($buffer);
$children = $xml->xpath('child::node()');
foreach ($children as $child) {
$buff = $child->asXML();
$this->log->log("RECV: $buff", XMPPHP_Log::LEVEL_VERBOSE);
xml_parse($this->parser, $buff, false);
}
}
}
}
public function send($msg) { $this->use_encryption = false;
$this->log->log("SEND: $msg", XMPPHP_Log::LEVEL_VERBOSE); $this->session = $session;
$msg = new SimpleXMLElement($msg); $this->rid = 3001;
#$msg->addAttribute('xmlns', 'jabber:client'); $this->sid = null;
$this->__sendBody($this->__buildBody($msg), true); $this->inactivity = 0;
#$this->__parseBuffer();
}
public function reset() { if ($session) {
$this->xml_depth = 0; $this->loadSession();
unset($this->xmlobj); }
$this->xmlobj = array();
$this->setupParser();
#$this->send($this->stream_start);
$body = $this->__buildBody();
$body->addAttribute('to', $this->host);
$body->addAttribute('xmpp:restart', 'true', 'urn:xmpp:xbosh');
$buff = "<stream:stream xmlns='jabber:client' xmlns:stream='http://etherx.jabber.org/streams'>";
$response = $this->__sendBody($body);
$this->been_reset = true;
xml_parse($this->parser, $buff, false);
}
public function loadSession() { if (!$this->sid) {
if(isset($_SESSION['XMPPHP_BOSH_RID'])) $this->rid = $_SESSION['XMPPHP_BOSH_RID'];
if(isset($_SESSION['XMPPHP_BOSH_SID'])) $this->sid = $_SESSION['XMPPHP_BOSH_SID'];
if(isset($_SESSION['XMPPHP_BOSH_authed'])) $this->authed = $_SESSION['XMPPHP_BOSH_authed'];
if(isset($_SESSION['XMPPHP_BOSH_jid'])) $this->jid = $_SESSION['XMPPHP_BOSH_jid'];
if(isset($_SESSION['XMPPHP_BOSH_fulljid'])) $this->fulljid = $_SESSION['XMPPHP_BOSH_fulljid'];
}
public function saveSession() { $body = $this->__buildBody();
$_SESSION['XMPPHP_BOSH_RID'] = (string) $this->rid; $body->addAttribute('hold', '1');
$_SESSION['XMPPHP_BOSH_SID'] = (string) $this->sid; $body->addAttribute('to', $this->server);
$_SESSION['XMPPHP_BOSH_authed'] = (boolean) $this->authed; $body->addAttribute('route', 'xmpp:' . $this->host . ':' . $this->port);
$_SESSION['XMPPHP_BOSH_jid'] = (string) $this->jid; $body->addAttribute('secure', 'true');
$_SESSION['XMPPHP_BOSH_fulljid'] = (string) $this->fulljid; $body->addAttribute('xmpp:version', '1.0', 'urn:xmpp:xbosh');
} $body->addAttribute('wait', strval($wait));
$body->addAttribute('ack', '1');
$body->addAttribute('xmlns:xmpp', 'urn:xmpp:xbosh');
$buff = '<stream:stream xmlns="jabber:client" xmlns:stream="http://etherx.jabber.org/streams">';
xml_parse($this->parser, $buff, false);
$response = $this->__sendBody($body);
$rxml = new SimpleXMLElement($response);
$this->sid = $rxml['sid'];
$this->inactivity = $rxml['inactivity'];
} else {
$buff = '<stream:stream xmlns="jabber:client" xmlns:stream="http://etherx.jabber.org/streams">';
xml_parse($this->parser, $buff, false);
}
}
/**
* Load session
*
*/
public function loadSession()
{
if ($this->session == 'ON_FILE') {
// Session not started so use session_file
$session_file = $this->getSessionFile();
// manage multiple accesses
if (!file_exists($session_file)) {
file_put_contents($session_file, '');
}
$session_file_fp = fopen($session_file, 'r');
flock($session_file_fp, LOCK_EX);
$session_serialized = file_get_contents($session_file, null, null, 6);
flock($session_file_fp, LOCK_UN);
fclose($session_file_fp);
$this->log->log('SESSION: reading ' . $session_serialized . ' from ' . $session_file, Log::LEVEL_VERBOSE);
if ($session_serialized != '') {
$_SESSION['XMPPHP_BOSH'] = unserialize($session_serialized);
}
}
if (isset($_SESSION['XMPPHP_BOSH']['inactivity'])) {
$this->inactivity = $_SESSION['XMPPHP_BOSH']['inactivity'];
}
$this->lat = (time() - (isset($_SESSION['XMPPHP_BOSH']['lat']))) ? $_SESSION['XMPPHP_BOSH']['lat'] : 0;
if ($this->lat < $this->inactivity) {
if (isset($_SESSION['XMPPHP_BOSH']['RID'])) {
$this->rid = $_SESSION['XMPPHP_BOSH']['RID'];
}
if (isset($_SESSION['XMPPHP_BOSH']['SID'])) {
$this->sid = $_SESSION['XMPPHP_BOSH']['SID'];
}
if (isset($_SESSION['XMPPHP_BOSH']['authed'])) {
$this->authed = $_SESSION['XMPPHP_BOSH']['authed'];
}
if (isset($_SESSION['XMPPHP_BOSH']['basejid'])) {
$this->basejid = $_SESSION['XMPPHP_BOSH']['basejid'];
}
if (isset($_SESSION['XMPPHP_BOSH']['fulljid'])) {
$this->fulljid = $_SESSION['XMPPHP_BOSH']['fulljid'];
}
}
}
/**
* Get the session file
*
*/
public function getSessionFile()
{
return sys_get_temp_dir() . '/' . $this->user . '_' . $this->server . '_session';
}
/**
* Build body
*
* @param $sub
* @return SimpleXMLElement|string
*/
public function __buildBody($sub = null)
{
$xml = '<body xmlns="http://jabber.org/protocol/httpbind" xmlns:xmpp="urn:xmpp:xbosh" />';
$xml = new SimpleXMLElement($xml);
$xml->addAttribute('content', 'text/xml; charset=utf-8');
$xml->addAttribute('rid', $this->rid);
$this->rid++;
if ($this->sid) {
$xml->addAttribute('sid', $this->sid);
}
$xml->addAttribute('xml:lang', 'en');
if ($sub !== null) {
// Ok, so simplexml is lame
$parent = dom_import_simplexml($xml);
$content = dom_import_simplexml($sub);
$child = $parent->ownerDocument->importNode($content, true);
$parent->appendChild($child);
$xml = simplexml_import_dom($parent);
}
return $xml;
}
/**
* Send body
*
* @param $body
* @param $recv
* @return bool|string
* @throws Exception
* @throws Exception
*/
public function __sendBody($body = null, $recv = true)
{
if (!$body) {
$body = $this->__buildBody();
}
$output = '';
$header = array('Accept-Encoding: gzip, deflate', 'Content-Type: text/xml; charset=utf-8');
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, $this->http_server);
curl_setopt($ch, CURLOPT_HEADER, 0);
curl_setopt($ch, CURLOPT_POST, 1);
curl_setopt($ch, CURLOPT_POSTFIELDS, $body->asXML());
curl_setopt($ch, CURLOPT_FOLLOWLOCATION, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, $header);
curl_setopt($ch, CURLOPT_VERBOSE, 0);
if ($recv) {
curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);
$output = curl_exec($ch);
if (curl_getinfo($ch, CURLINFO_HTTP_CODE) != '200') {
throw new Exception('Wrong response from server!');
}
$this->http_buffer[] = $output;
}
curl_close($ch);
return $output;
}
/**
* Process
*
* @param $null1
* @param $null2
*
* null params are not used and just to statify Strict Function Declaration
* @return bool
* @throws Exception
* @throws Exception
*/
public function __process($null1 = null, $null2 = null)
{
if ($this->http_buffer) {
$this->__parseBuffer();
} else {
$this->__sendBody();
$this->__parseBuffer();
}
$this->saveSession();
return true;
}
public function __parseBuffer()
{
while ($this->http_buffer) {
$idx = key($this->http_buffer);
$buffer = $this->http_buffer[$idx];
unset($this->http_buffer[$idx]);
if ($buffer) {
$xml = new SimpleXMLElement($buffer);
$children = $xml->xpath('child::node()');
foreach ($children as $child) {
$buff = $child->asXML();
$this->log->log('RECV: ' . $buff, Log::LEVEL_VERBOSE);
xml_parse($this->parser, $buff, false);
}
}
}
}
/**
* Save session
*
*/
public function saveSession()
{
$_SESSION['XMPPHP_BOSH']['RID'] = (string)$this->rid;
$_SESSION['XMPPHP_BOSH']['SID'] = (string)$this->sid;
$_SESSION['XMPPHP_BOSH']['authed'] = (boolean)$this->authed;
$_SESSION['XMPPHP_BOSH']['basejid'] = (string)$this->basejid;
$_SESSION['XMPPHP_BOSH']['fulljid'] = (string)$this->fulljid;
$_SESSION['XMPPHP_BOSH']['inactivity'] = (string)$this->inactivity;
$_SESSION['XMPPHP_BOSH']['lat'] = (string)time();
if ($this->session == 'ON_FILE') {
$session_file = $this->getSessionFile();
$session_file_fp = fopen($session_file, 'r');
flock($session_file_fp, LOCK_EX);
// <?php prefix used to mask the content of the session file
$session_serialized = '<?php ' . serialize($_SESSION);
file_put_contents($session_file, $session_serialized);
flock($session_file_fp, LOCK_UN);
fclose($session_file_fp);
}
}
/**
* Process
*
* @param $msg
* @param $null
*
* null param are not used and just to statify Strict Function Declaration
* @throws Exception
* @throws Exception
*/
public function send($msg, $null = null)
{
$this->log->log('SEND: ' . $msg, Log::LEVEL_VERBOSE);
$msg = new SimpleXMLElement($msg);
$this->__sendBody($this->__buildBody($msg), true);
}
/**
* Reset
*
* @throws Exception
*/
public function reset()
{
$this->xml_depth = 0;
unset($this->xmlobj);
$this->xmlobj = array();
$this->setupParser();
$body = $this->__buildBody();
$body->addAttribute('to', $this->host);
$body->addAttribute('xmpp:restart', 'true', 'urn:xmpp:xbosh');
$buff = '<stream:stream xmlns="jabber:client" xmlns:stream="http://etherx.jabber.org/streams">';
$response = $this->__sendBody($body);
$this->been_reset = true;
xml_parse($this->parser, $buff, false);
}
/**
* Disconnect
*
* @throws Exception
*/
public function disconnect()
{
parent::disconnect();
if ($this->session == 'ON_FILE') {
unlink($this->getSessionFile());
} else {
$keys = array('RID', 'SID', 'authed', 'basejid', 'fulljid', 'inactivity', 'lat');
foreach ($keys as $key) {
unset($_SESSION['XMPPHP_BOSH'][$key]);
}
}
}
} }

View File

@ -1,4 +1,5 @@
<?php <?php
/** /**
* XMPPHP: The PHP XMPP Library * XMPPHP: The PHP XMPP Library
* Copyright (C) 2008 Nathanael C. Fritz * Copyright (C) 2008 Nathanael C. Fritz
@ -22,20 +23,27 @@
* @package XMPPHP * @package XMPPHP
* @author Nathanael C. Fritz <JID: fritzy@netflint.net> * @author Nathanael C. Fritz <JID: fritzy@netflint.net>
* @author Stephan Wentz <JID: stephan@jabber.wentz.it> * @author Stephan Wentz <JID: stephan@jabber.wentz.it>
* @author Michael Garvin <JID: gar@netflint.net> * @author Michael Garvin <JID: gar@netflint.net>
* @author Alexander Birkner (https://github.com/BirknerAlex)
* @author zorn-v (https://github.com/zorn-v/xmpphp/)
* @author GNU social
* @copyright 2008 Nathanael C. Fritz * @copyright 2008 Nathanael C. Fritz
*/ */
namespace XMPPHP;
use Exception as ObjectException;
/** /**
* XMPPHP Exception * XMPPHP Exception
* *
* @category xmpphp * @package XMPPHP
* @package XMPPHP * @author Nathanael C. Fritz <JID: fritzy@netflint.net>
* @author Nathanael C. Fritz <JID: fritzy@netflint.net> * @author Stephan Wentz <JID: stephan@jabber.wentz.it>
* @author Stephan Wentz <JID: stephan@jabber.wentz.it> * @author Michael Garvin <JID: gar@netflint.net>
* @author Michael Garvin <JID: gar@netflint.net> * @copyright 2008 Nathanael C. Fritz
* @copyright 2008 Nathanael C. Fritz * @version $Id$
* @version $Id$
*/ */
class XMPPHP_Exception extends Exception { class Exception extends ObjectException
{
} }

View File

@ -1,4 +1,5 @@
<?php <?php
/** /**
* XMPPHP: The PHP XMPP Library * XMPPHP: The PHP XMPP Library
* Copyright (C) 2008 Nathanael C. Fritz * Copyright (C) 2008 Nathanael C. Fritz
@ -19,101 +20,110 @@
* Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
* *
* @category xmpphp * @category xmpphp
* @package XMPPHP * @package XMPPHP
* @author Nathanael C. Fritz <JID: fritzy@netflint.net> * @author Nathanael C. Fritz <JID: fritzy@netflint.net>
* @author Stephan Wentz <JID: stephan@jabber.wentz.it> * @author Stephan Wentz <JID: stephan@jabber.wentz.it>
* @author Michael Garvin <JID: gar@netflint.net> * @author Michael Garvin <JID: gar@netflint.net>
* @author Alexander Birkner (https://github.com/BirknerAlex)
* @author zorn-v (https://github.com/zorn-v/xmpphp/)
* @author GNU social
* @copyright 2008 Nathanael C. Fritz * @copyright 2008 Nathanael C. Fritz
*/ */
namespace XMPPHP;
/** /**
* XMPPHP Log * XMPPHP Log
* *
* @package XMPPHP * @package XMPPHP
* @author Nathanael C. Fritz <JID: fritzy@netflint.net> * @author Nathanael C. Fritz <JID: fritzy@netflint.net>
* @author Stephan Wentz <JID: stephan@jabber.wentz.it> * @author Stephan Wentz <JID: stephan@jabber.wentz.it>
* @author Michael Garvin <JID: gar@netflint.net> * @author Michael Garvin <JID: gar@netflint.net>
* @copyright 2008 Nathanael C. Fritz * @copyright 2008 Nathanael C. Fritz
* @version $Id$ * @version $Id$
*/ */
class XMPPHP_Log { class Log
{
const LEVEL_ERROR = 0;
const LEVEL_WARNING = 1;
const LEVEL_INFO = 2;
const LEVEL_DEBUG = 3;
const LEVEL_VERBOSE = 4;
const LEVEL_ERROR = 0; /**
const LEVEL_WARNING = 1; * @var array
const LEVEL_INFO = 2; */
const LEVEL_DEBUG = 3; protected $data = array();
const LEVEL_VERBOSE = 4;
/** /**
* @var array * @var array
*/ */
protected $data = array(); protected $names = array('ERROR', 'WARNING', 'INFO', 'DEBUG', 'VERBOSE');
/** /**
* @var array * @var integer
*/ */
protected $names = array('ERROR', 'WARNING', 'INFO', 'DEBUG', 'VERBOSE'); protected $runlevel;
/** /**
* @var integer * @var boolean
*/ */
protected $runlevel; protected $printout;
/** /**
* @var boolean * Constructor
*/ *
protected $printout; * @param boolean $printout
* @param int $runlevel
*/
public function __construct($printout = false, $runlevel = self::LEVEL_INFO)
{
$this->printout = (boolean)$printout;
$this->runlevel = (int)$runlevel;
}
/** /**
* Constructor * Add a message to the log data array
* * If printout in this instance is set to true, directly output the message
* @param boolean $printout *
* @param string $runlevel * @param string $msg
*/ * @param integer $runlevel
public function __construct($printout = false, $runlevel = self::LEVEL_INFO) { */
$this->printout = (boolean)$printout; public function log($msg, $runlevel = self::LEVEL_INFO)
$this->runlevel = (int)$runlevel; {
} $time = time();
#$this->data[] = array($this->runlevel, $msg, $time);
if ($this->printout and $runlevel <= $this->runlevel) {
$this->writeLine($msg, $runlevel, $time);
}
}
/** protected function writeLine($msg, $runlevel, $time)
* Add a message to the log data array {
* If printout in this instance is set to true, directly output the message //echo date('Y-m-d H:i:s', $time)." [".$this->names[$runlevel]."]: ".$msg."\n";
* echo $time . " [" . $this->names[$runlevel] . "]: " . $msg . "\n";
* @param string $msg flush();
* @param integer $runlevel }
*/
public function log($msg, $runlevel = self::LEVEL_INFO) {
$time = time();
#$this->data[] = array($this->runlevel, $msg, $time);
if($this->printout and $runlevel <= $this->runlevel) {
$this->writeLine($msg, $runlevel, $time);
}
}
/** /**
* Output the complete log. * Output the complete log.
* Log will be cleared if $clear = true * Log will be cleared if $clear = true
* *
* @param boolean $clear * @param boolean $clear
* @param integer $runlevel * @param integer $runlevel
*/ */
public function printout($clear = true, $runlevel = null) { public function printout($clear = true, $runlevel = null)
if($runlevel === null) { {
$runlevel = $this->runlevel; if ($runlevel === null) {
} $runlevel = $this->runlevel;
foreach($this->data as $data) { }
if($runlevel <= $data[0]) { foreach ($this->data as $data) {
$this->writeLine($data[1], $runlevel, $data[2]); if ($runlevel <= $data[0]) {
} $this->writeLine($data[1], $runlevel, $data[2]);
} }
if($clear) { }
$this->data = array(); if ($clear) {
} $this->data = array();
} }
}
protected function writeLine($msg, $runlevel, $time) {
//echo date('Y-m-d H:i:s', $time)." [".$this->names[$runlevel]."]: ".$msg."\n";
echo $time." [".$this->names[$runlevel]."]: ".$msg."\n";
flush();
}
} }

View File

@ -1,4 +1,5 @@
<?php <?php
/** /**
* XMPPHP: The PHP XMPP Library * XMPPHP: The PHP XMPP Library
* Copyright (C) 2008 Nathanael C. Fritz * Copyright (C) 2008 Nathanael C. Fritz
@ -19,146 +20,164 @@
* Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
* *
* @category xmpphp * @category xmpphp
* @package XMPPHP * @package XMPPHP
* @author Nathanael C. Fritz <JID: fritzy@netflint.net> * @author Nathanael C. Fritz <JID: fritzy@netflint.net>
* @author Stephan Wentz <JID: stephan@jabber.wentz.it> * @author Stephan Wentz <JID: stephan@jabber.wentz.it>
* @author Michael Garvin <JID: gar@netflint.net> * @author Michael Garvin <JID: gar@netflint.net>
* @author Alexander Birkner (https://github.com/BirknerAlex)
* @author zorn-v (https://github.com/zorn-v/xmpphp/)
* @author GNU social
* @copyright 2008 Nathanael C. Fritz * @copyright 2008 Nathanael C. Fritz
*/ */
namespace XMPPHP;
/** /**
* XMPPHP Roster Object * XMPPHP Roster
* *
* @category xmpphp * @package XMPPHP
* @package XMPPHP * @author Nathanael C. Fritz <JID: fritzy@netflint.net>
* @author Nathanael C. Fritz <JID: fritzy@netflint.net> * @author Stephan Wentz <JID: stephan@jabber.wentz.it>
* @author Stephan Wentz <JID: stephan@jabber.wentz.it> * @author Michael Garvin <JID: gar@netflint.net>
* @author Michael Garvin <JID: gar@netflint.net> * @copyright 2008 Nathanael C. Fritz
* @copyright 2008 Nathanael C. Fritz * @version $Id$
* @version $Id$
*/ */
class Roster
{
/**
* Roster array, handles contacts and presence. Indexed by jid.
* Contains array with potentially two indexes 'contact' and 'presence'
* @var array
*/
protected $roster_array = array();
class Roster { /**
/** * Constructor
* Roster array, handles contacts and presence. Indexed by jid. * @param array $roster_array
* Contains array with potentially two indexes 'contact' and 'presence' */
* @var array public function __construct($roster_array = array())
*/ {
protected $roster_array = array(); if ($this->verifyRoster($roster_array)) {
/** $this->roster_array = $roster_array; //Allow for pre-population with existing roster
* Constructor } else {
* $this->roster_array = array();
*/ }
public function __construct($roster_array = array()) { }
if ($this->verifyRoster($roster_array)) {
$this->roster_array = $roster_array; //Allow for prepopulation with existing roster
} else {
$this->roster_array = array();
}
}
/** /**
* *
* Check that a given roster array is of a valid structure (empty is still valid) * Check that a given roster array is of a valid structure (empty is still valid)
* *
* @param array $roster_array * @param array $roster_array
*/ * @return bool
protected function verifyRoster($roster_array) { */
#TODO once we know *what* a valid roster array looks like protected function verifyRoster($roster_array)
return True; {
} #TODO once we know *what* a valid roster array looks like
return true;
}
/** /**
* *
* Add given contact to roster * Retrieve contact via jid
* *
* @param string $jid * @param string $jid
* @param string $subscription * @return mixed
* @param string $name */
* @param array $groups public function getContact($jid)
*/ {
public function addContact($jid, $subscription, $name='', $groups=array()) { if ($this->isContact($jid)) {
$contact = array('jid' => $jid, 'subscription' => $subscription, 'name' => $name, 'groups' => $groups); return $this->roster_array[$jid]['contact'];
if ($this->isContact($jid)) { }
$this->roster_array[$jid]['contact'] = $contact; }
} else {
$this->roster_array[$jid] = array('contact' => $contact);
}
}
/** /**
* *
* Retrieve contact via jid * Discover if a contact exists in the roster via jid
* *
* @param string $jid * @param string $jid
*/ * @return bool
public function getContact($jid) { */
if ($this->isContact($jid)) { public function isContact($jid)
return $this->roster_array[$jid]['contact']; {
} return (array_key_exists($jid, $this->roster_array));
} }
/** /**
* *
* Discover if a contact exists in the roster via jid * Set presence
* *
* @param string $jid * @param string $presence
*/ * @param integer $priority
public function isContact($jid) { * @param string $show
return (array_key_exists($jid, $this->roster_array)); * @param string $status
} */
public function setPresence($presence, $priority, $show, $status)
{
$presence = explode('/', $presence, 2);
$jid = $presence[0];
$resource = isset($presence[1]) ? $presence[1] : '';
if ($show != 'unavailable') {
if (!$this->isContact($jid)) {
$this->addContact($jid, 'not-in-roster');
}
$this->roster_array[$jid]['presence'][$resource] = array('priority' => $priority, 'show' => $show, 'status' => $status);
} else { //Nuke unavailable resources to save memory
unset($this->roster_array[$jid]['resource'][$resource]);
unset($this->roster_array[$jid]['presence'][$resource]);
}
}
/** /**
* *
* Set presence * Add given contact to roster
* *
* @param string $presence * @param string $jid
* @param integer $priority * @param string $subscription
* @param string $show * @param string $name
* @param string $status * @param array $groups
*/ */
public function setPresence($presence, $priority, $show, $status) { public function addContact($jid, $subscription, $name = '', $groups = array())
$parts = explode('/', $presence); {
$jid = $parts[0]; $contact = array('jid' => $jid, 'subscription' => $subscription, 'name' => $name, 'groups' => $groups);
$resource = isset($parts[1]) ? $parts[1] : ''; // apparently we can do '' as an associative array index if ($this->isContact($jid)) {
if ($show != 'unavailable') { $this->roster_array[$jid]['contact'] = $contact;
if (!$this->isContact($jid)) { } else {
$this->addContact($jid, 'not-in-roster'); $this->roster_array[$jid] = array('contact' => $contact);
} }
$this->roster_array[$jid]['presence'][$resource] = array('priority' => $priority, 'show' => $show, 'status' => $status); }
} else { //Nuke unavailable resources to save memory
unset($this->roster_array[$jid]['resource'][$resource]);
}
}
/* /*
* *
* Return best presence for jid * Return best presence for jid
* *
* @param string $jid * @param string $jid
*/ */
public function getPresence($jid) {
$split = explode("/", $jid); public function getPresence($jid)
$jid = $split[0]; {
if($this->isContact($jid)) { $split = explode('/', $jid, 2);
$current = array('resource' => '', 'active' => '', 'priority' => -129, 'show' => '', 'status' => ''); //Priorities can only be -128 = 127 $jid = $split[0];
foreach($this->roster_array[$jid]['presence'] as $resource => $presence) { if ($this->isContact($jid)) {
//Highest available priority or just highest priority $current = array('resource' => '', 'active' => '', 'priority' => -129, 'show' => '', 'status' => ''); //Priorities can only be -128 = 127
if ($presence['priority'] > $current['priority'] and (($presence['show'] == "chat" or $presence['show'] == "available") or ($current['show'] != "chat" or $current['show'] != "available"))) { foreach ($this->roster_array[$jid]['presence'] as $resource => $presence) {
$current = $presence; //Highest available priority or just highest priority
$current['resource'] = $resource; if ($presence['priority'] > $current['priority'] and (($presence['show'] == "chat" or $presence['show'] == "available") or ($current['show'] != "chat" or $current['show'] != "available"))) {
} $current = $presence;
} $current['resource'] = $resource;
return $current; }
} }
} return $current;
/** }
* }
* Get roster
* /**
*/ *
public function getRoster() { * Get roster
return $this->roster_array; *
} */
public function getRoster()
{
return $this->roster_array;
}
} }
?>

View File

@ -1,4 +1,5 @@
<?php <?php
/** /**
* XMPPHP: The PHP XMPP Library * XMPPHP: The PHP XMPP Library
* Copyright (C) 2008 Nathanael C. Fritz * Copyright (C) 2008 Nathanael C. Fritz
@ -19,140 +20,155 @@
* Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
* *
* @category xmpphp * @category xmpphp
* @package XMPPHP * @package XMPPHP
* @author Nathanael C. Fritz <JID: fritzy@netflint.net> * @author Nathanael C. Fritz <JID: fritzy@netflint.net>
* @author Stephan Wentz <JID: stephan@jabber.wentz.it> * @author Stephan Wentz <JID: stephan@jabber.wentz.it>
* @author Michael Garvin <JID: gar@netflint.net> * @author Michael Garvin <JID: gar@netflint.net>
* @author Alexander Birkner (https://github.com/BirknerAlex)
* @author zorn-v (https://github.com/zorn-v/xmpphp/)
* @author GNU social
* @copyright 2008 Nathanael C. Fritz * @copyright 2008 Nathanael C. Fritz
*/ */
namespace XMPPHP;
/** /**
* XMPPHP XML Object * XMPPHP XMLObject
* *
* @category xmpphp * @package XMPPHP
* @package XMPPHP * @author Nathanael C. Fritz <JID: fritzy@netflint.net>
* @author Nathanael C. Fritz <JID: fritzy@netflint.net> * @author Stephan Wentz <JID: stephan@jabber.wentz.it>
* @author Stephan Wentz <JID: stephan@jabber.wentz.it> * @author Michael Garvin <JID: gar@netflint.net>
* @author Michael Garvin <JID: gar@netflint.net> * @copyright 2008 Nathanael C. Fritz
* @copyright 2008 Nathanael C. Fritz * @version $Id$
* @version $Id$
*/ */
class XMPPHP_XMLObj { class XMLObj
/** {
* Tag name /**
* * Tag name
* @var string *
*/ * @var string
public $name; */
public $name;
/** /**
* Namespace * Namespace
* *
* @var string * @var string
*/ */
public $ns; public $ns;
/** /**
* Attributes * Attributes
* *
* @var array * @var array
*/ */
public $attrs = array(); public $attrs = array();
/** /**
* Subs? * Subs?
* *
* @var array * @var array
*/ */
public $subs = array(); public $subs = array();
/** /**
* Node data * Node data
* *
* @var string * @var string
*/ */
public $data = ''; public $data = '';
/** /**
* Constructor * Constructor
* *
* @param string $name * @param string $name
* @param string $ns * @param string $ns
* @param array $attrs * @param array $attrs
* @param string $data * @param string $data
*/ */
public function __construct($name, $ns = '', $attrs = array(), $data = '') { public function __construct($name, $ns = '', $attrs = array(), $data = '')
$this->name = strtolower($name); {
$this->ns = $ns; $this->name = strtolower($name);
if(is_array($attrs) && count($attrs)) { $this->ns = $ns;
foreach($attrs as $key => $value) { if (is_array($attrs) && count($attrs)) {
$this->attrs[strtolower($key)] = $value; foreach ($attrs as $key => $value) {
} $this->attrs[strtolower($key)] = $value;
} }
$this->data = $data; }
} $this->data = $data;
}
/** /**
* Dump this XML Object to output. * Dump this XML Object to output.
* *
* @param integer $depth * @param integer $depth
*/ */
public function printObj($depth = 0) { public function printObj($depth = 0)
print str_repeat("\t", $depth) . $this->name . " " . $this->ns . ' ' . $this->data; {
print "\n"; print str_repeat("\t", $depth) . $this->name . " " . $this->ns . ' ' . $this->data;
foreach($this->subs as $sub) { print "\n";
$sub->printObj($depth + 1); foreach ($this->subs as $sub) {
} $sub->printObj($depth + 1);
} }
}
/** /**
* Return this XML Object in xml notation * Return this XML Object in xml notation
* *
* @param string $str * @param string $str
*/ * @return string
public function toString($str = '') { */
$str .= "<{$this->name} xmlns='{$this->ns}' "; public function toString($str = '')
foreach($this->attrs as $key => $value) { {
if($key != 'xmlns') { $str .= "<{$this->name} xmlns='{$this->ns}' ";
$value = htmlspecialchars($value); foreach ($this->attrs as $key => $value) {
$str .= "$key='$value' "; if ($key != 'xmlns') {
} $value = htmlspecialchars($value);
} $str .= "$key='$value' ";
$str .= ">"; }
foreach($this->subs as $sub) { }
$str .= $sub->toString(); $str .= ">";
} foreach ($this->subs as $sub) {
$body = htmlspecialchars($this->data); $str .= $sub->toString();
$str .= "$body</{$this->name}>"; }
return $str; $body = htmlspecialchars($this->data);
} $str .= "$body</{$this->name}>";
return $str;
}
/** /**
* Has this XML Object the given sub? * Has this XML Object the given sub?
* *
* @param string $name * @param string $name
* @return boolean * @param null $ns
*/ * @return boolean
public function hasSub($name, $ns = null) { */
foreach($this->subs as $sub) { public function hasSub($name, $ns = null)
if(($name == "*" or $sub->name == $name) and ($ns == null or $sub->ns == $ns)) return true; {
} foreach ($this->subs as $sub) {
return false; if (($name == "*" or $sub->name == $name) and ($ns == null or $sub->ns == $ns)) {
} return true;
}
}
return false;
}
/** /**
* Return a sub * Return a sub
* *
* @param string $name * @param string $name
* @param string $attrs * @param string $attrs
* @param string $ns * @param string $ns
*/ * @return mixed
public function sub($name, $attrs = null, $ns = null) { */
#TODO attrs is ignored public function sub($name, $attrs = null, $ns = null)
foreach($this->subs as $sub) { {
if($sub->name == $name and ($ns == null or $sub->ns == $ns)) { #TODO attrs is ignored
return $sub; foreach ($this->subs as $sub) {
} if ($sub->name == $name and ($ns == null or $sub->ns == $ns)) {
} return $sub;
} }
}
}
} }

File diff suppressed because it is too large Load Diff

View File

@ -1,4 +1,5 @@
<?php <?php
/** /**
* XMPPHP: The PHP XMPP Library * XMPPHP: The PHP XMPP Library
* Copyright (C) 2008 Nathanael C. Fritz * Copyright (C) 2008 Nathanael C. Fritz
@ -19,414 +20,458 @@
* Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
* *
* @category xmpphp * @category xmpphp
* @package XMPPHP * @package XMPPHP
* @author Nathanael C. Fritz <JID: fritzy@netflint.net> * @author Nathanael C. Fritz <JID: fritzy@netflint.net>
* @author Stephan Wentz <JID: stephan@jabber.wentz.it> * @author Stephan Wentz <JID: stephan@jabber.wentz.it>
* @author Michael Garvin <JID: gar@netflint.net> * @author Michael Garvin <JID: gar@netflint.net>
* @author Alexander Birkner (https://github.com/BirknerAlex)
* @author zorn-v (https://github.com/zorn-v/xmpphp/)
* @author GNU social
* @copyright 2008 Nathanael C. Fritz * @copyright 2008 Nathanael C. Fritz
*/ */
namespace XMPPHP;
/** XMPPHP_XMLStream */ /** XMPPHP_XMLStream */
require_once dirname(__FILE__) . "/XMLStream.php"; require_once __DIR__ . DIRECTORY_SEPARATOR . 'XMLStream.php';
require_once dirname(__FILE__) . "/Roster.php"; require_once __DIR__ . DIRECTORY_SEPARATOR . 'Roster.php';
/** /**
* XMPPHP Main Class * XMPPHP XMPP
* *
* @category xmpphp * @package XMPPHP
* @package XMPPHP * @author Nathanael C. Fritz <JID: fritzy@netflint.net>
* @author Nathanael C. Fritz <JID: fritzy@netflint.net> * @author Stephan Wentz <JID: stephan@jabber.wentz.it>
* @author Stephan Wentz <JID: stephan@jabber.wentz.it> * @author Michael Garvin <JID: gar@netflint.net>
* @author Michael Garvin <JID: gar@netflint.net> * @copyright 2008 Nathanael C. Fritz
* @copyright 2008 Nathanael C. Fritz * @version $Id$
* @version $Id$
*/ */
class XMPPHP_XMPP extends XMPPHP_XMLStream { class XMPP extends XMLStream
/** {
* @var string /**
*/ * @var string
public $server; */
public $server;
/** /**
* @var string * @var string
*/ */
public $user; public $user;
/**
* @var boolean
*/
public $track_presence = true;
/**
* @var object
*/
public $roster;
/**
* @var string
*/
protected $password;
/**
* @var string
*/
protected $resource;
/**
* @var string
*/
protected $fulljid;
/**
* @var string
*/
protected $basejid;
/**
* @var boolean
*/
protected $authed = false;
protected $session_started = false;
/**
* @var boolean
*/
protected $auto_subscribe = false;
/**
* @var boolean
*/
protected $use_encryption = true;
/** /**
* @var string * Constructor
*/ *
protected $password; * @param string $host
* @param integer $port
* @param string $user
* @param string $password
* @param string $resource
* @param string $server
* @param boolean $printlog
* @param string $loglevel
*/
public function __construct($host, $port, $user, $password, $resource, $server = null, $printlog = false, $loglevel = null)
{
parent::__construct($host, $port, $printlog, $loglevel);
/** $this->user = $user;
* @var string $this->password = $password;
*/ $this->resource = $resource;
protected $resource; if (!$server) {
$server = $host;
}
$this->server = $server;
$this->basejid = $this->user . '@' . $this->host;
/** $this->roster = new Roster();
* @var string $this->track_presence = true;
*/
protected $fulljid;
/** $this->stream_start = '<stream:stream to="' . $server . '" xmlns:stream="http://etherx.jabber.org/streams" xmlns="jabber:client" version="1.0">';
* @var string $this->stream_end = '</stream:stream>';
*/ $this->default_ns = 'jabber:client';
protected $basejid;
/** $this->addXPathHandler('{http://etherx.jabber.org/streams}features', 'features_handler');
* @var boolean $this->addXPathHandler('{urn:ietf:params:xml:ns:xmpp-sasl}success', 'sasl_success_handler');
*/ $this->addXPathHandler('{urn:ietf:params:xml:ns:xmpp-sasl}failure', 'sasl_failure_handler');
protected $authed = false; $this->addXPathHandler('{urn:ietf:params:xml:ns:xmpp-tls}proceed', 'tls_proceed_handler');
protected $session_started = false; $this->addXPathHandler('{jabber:client}message', 'message_handler');
$this->addXPathHandler('{jabber:client}presence', 'presence_handler');
$this->addXPathHandler('iq/{jabber:iq:roster}query', 'roster_iq_handler');
}
/** /**
* @var boolean * Turn encryption on/ff
*/ *
protected $auto_subscribe = false; * @param boolean $useEncryption
*/
public function useEncryption($useEncryption = true)
{
$this->use_encryption = $useEncryption;
}
/** /**
* @var boolean * Turn on auto-authorization of subscription requests.
*/ *
protected $use_encryption = true; * @param boolean $autoSubscribe
*/
public function autoSubscribe($autoSubscribe = true)
{
$this->auto_subscribe = $autoSubscribe;
}
/** /**
* @var boolean * Send XMPP Message
*/ *
public $track_presence = true; * @param string $to
* @param string $body
* @param string $type
* @param string $subject
* @param null $payload
* @throws Exception
*/
public function message($to, $body, $type = 'chat', $subject = null, $payload = null)
{
if ($this->disconnected) {
throw new Exception('You need to connect first');
}
/** if (empty($type)) {
* @var object $type = 'chat';
*/ }
public $roster;
/** $to = htmlspecialchars($to);
* Constructor $body = htmlspecialchars($body);
* $subject = htmlspecialchars($subject);
* @param string $host $subject = ($subject) ? '<subject>' . $subject . '</subject>' : '';
* @param integer $port $payload = ($payload) ? $payload : '';
* @param string $user $sprintf = '<message from="%s" to="%s" type="%s">%s<body>%s</body>%s</message>';
* @param string $password $output = sprintf($sprintf, $this->fulljid, $to, $type, $subject, $body, $payload);
* @param string $resource $this->send($output);
* @param string $server }
* @param boolean $printlog
* @param string $loglevel
*/
public function __construct($host, $port, $user, $password, $resource, $server = null, $printlog = false, $loglevel = null) {
parent::__construct($host, $port, $printlog, $loglevel);
$this->user = $user; /**
$this->password = $password; * Set Presence
$this->resource = $resource; *
if(!$server) $server = $host; * @param string $status
$this->basejid = $this->user . '@' . $this->host; * @param string $show
* @param string $to
* @param string $type
* @param null $priority
* @throws Exception
*/
public function presence($status = null, $show = 'available', $to = null, $type = 'available', $priority = null)
{
if ($this->disconnected) {
throw new Exception('You need to connect first');
}
$this->roster = new Roster(); if ($type == 'available') {
$this->track_presence = true; $type = '';
}
$to = htmlspecialchars($to);
$status = htmlspecialchars($status);
if ($show == 'unavailable') {
$type = 'unavailable';
}
$this->stream_start = '<stream:stream to="' . $server . '" xmlns:stream="http://etherx.jabber.org/streams" xmlns="jabber:client" version="1.0">'; $out = "<presence";
$this->stream_end = '</stream:stream>'; if ($to) {
$this->default_ns = 'jabber:client'; $out .= " to=\"$to\"";
}
if ($type) {
$out .= " type='$type'";
}
if ($show == 'available' and !$status and $priority !== null) {
$out .= "/>";
} else {
$out .= ">";
if ($show != 'available') {
$out .= "<show>$show</show>";
}
if ($status) {
$out .= "<status>$status</status>";
}
if ($priority !== null) {
$out .= "<priority>$priority</priority>";
}
$out .= "</presence>";
}
$this->addXPathHandler('{http://etherx.jabber.org/streams}features', 'features_handler'); $this->send($out);
$this->addXPathHandler('{urn:ietf:params:xml:ns:xmpp-sasl}success', 'sasl_success_handler'); }
$this->addXPathHandler('{urn:ietf:params:xml:ns:xmpp-sasl}failure', 'sasl_failure_handler');
$this->addXPathHandler('{urn:ietf:params:xml:ns:xmpp-tls}proceed', 'tls_proceed_handler');
$this->addXPathHandler('{jabber:client}message', 'message_handler');
$this->addXPathHandler('{jabber:client}presence', 'presence_handler');
$this->addXPathHandler('iq/{jabber:iq:roster}query', 'roster_iq_handler');
}
/** /**
* Turn encryption on/ff * Send Auth request
* *
* @param boolean $useEncryption * @param string $jid
*/ */
public function useEncryption($useEncryption = true) { public function subscribe($jid)
$this->use_encryption = $useEncryption; {
} $this->send("<presence type='subscribe' to='{$jid}' from='{$this->fulljid}' />");
#$this->send("<presence type='subscribed' to='{$jid}' from='{$this->fulljid}' />");
}
/** /**
* Turn on auto-authorization of subscription requests. * Message handler
* *
* @param boolean $autoSubscribe * @param string $xml
*/ */
public function autoSubscribe($autoSubscribe = true) { public function message_handler($xml)
$this->auto_subscribe = $autoSubscribe; {
} if (isset($xml->attrs['type'])) {
$payload['type'] = $xml->attrs['type'];
} else {
$payload['type'] = 'chat';
}
$body = $xml->sub('body');
$payload['from'] = $xml->attrs['from'];
$payload['body'] = is_object($body) ? $body->data : false; // $xml->sub('body')->data;
$payload['xml'] = $xml;
$this->log->log("Message: {$payload['body']}", Log::LEVEL_DEBUG);
$this->event('message', $payload);
}
/** /**
* Send XMPP Message * Presence handler
* *
* @param string $to * @param string $xml
* @param string $body */
* @param string $type public function presence_handler($xml)
* @param string $subject {
*/ $payload['type'] = (isset($xml->attrs['type'])) ? $xml->attrs['type'] : 'available';
public function message($to, $body, $type = 'chat', $subject = null, $payload = null) { $payload['show'] = (isset($xml->sub('show')->data)) ? $xml->sub('show')->data : $payload['type'];
if(is_null($type)) $payload['from'] = $xml->attrs['from'];
{ $payload['status'] = (isset($xml->sub('status')->data)) ? $xml->sub('status')->data : '';
$type = 'chat'; $payload['priority'] = (isset($xml->sub('priority')->data)) ? intval($xml->sub('priority')->data) : 0;
} $payload['xml'] = $xml;
if ($this->track_presence) {
$this->roster->setPresence($payload['from'], $payload['priority'], $payload['show'], $payload['status']);
}
$this->log->log("Presence: {$payload['from']} [{$payload['show']}] {$payload['status']}", Log::LEVEL_DEBUG);
if (array_key_exists('type', $xml->attrs) and $xml->attrs['type'] == 'subscribe') {
if ($this->auto_subscribe) {
$this->send("<presence type='subscribed' to='{$xml->attrs['from']}' from='{$this->fulljid}' />");
$this->send("<presence type='subscribe' to='{$xml->attrs['from']}' from='{$this->fulljid}' />");
}
$this->event('subscription_requested', $payload);
} elseif (array_key_exists('type', $xml->attrs) and $xml->attrs['type'] == 'subscribed') {
$this->event('subscription_accepted', $payload);
} else {
$this->event('presence', $payload);
}
}
$to = htmlspecialchars($to); /**
$body = htmlspecialchars($body); * Retrieves the roster
$subject = htmlspecialchars($subject); *
*/
public function getRoster()
{
$id = $this->getID();
$this->send("<iq xmlns='jabber:client' type='get' id='$id'><query xmlns='jabber:iq:roster' /></iq>");
}
$out = "<message from=\"{$this->fulljid}\" to=\"$to\" type='$type'>"; /**
if($subject) $out .= "<subject>$subject</subject>"; * Retrieves the vcard
$out .= "<body>$body</body>"; * @param null $jid
if($payload) $out .= $payload; */
$out .= "</message>"; public function getVCard($jid = null)
{
$id = $this->getID();
$this->addIdHandler($id, 'vcard_get_handler');
if ($jid) {
$this->send("<iq type='get' id='$id' to='$jid'><vCard xmlns='vcard-temp' /></iq>");
} else {
$this->send("<iq type='get' id='$id'><vCard xmlns='vcard-temp' /></iq>");
}
}
$this->send($out); /**
} * Features handler
*
* @param string $xml
*/
protected function features_handler($xml)
{
if ($xml->hasSub('starttls') and $this->use_encryption) {
$this->send("<starttls xmlns='urn:ietf:params:xml:ns:xmpp-tls'><required /></starttls>");
} elseif ($xml->hasSub('bind') and $this->authed) {
$id = $this->getId();
$this->addIdHandler($id, 'resource_bind_handler');
$this->send("<iq xmlns=\"jabber:client\" type=\"set\" id=\"$id\"><bind xmlns=\"urn:ietf:params:xml:ns:xmpp-bind\"><resource>{$this->resource}</resource></bind></iq>");
} else {
$this->log->log("Attempting Auth...");
if ($this->password) {
$this->send("<auth xmlns='urn:ietf:params:xml:ns:xmpp-sasl' mechanism='PLAIN'>" . base64_encode("\x00" . $this->user . "\x00" . $this->password) . "</auth>");
} else {
$this->send("<auth xmlns='urn:ietf:params:xml:ns:xmpp-sasl' mechanism='ANONYMOUS'/>");
}
}
}
/** /**
* Set Presence * SASL success handler
* *
* @param string $status * @param string $xml
* @param string $show */
* @param string $to protected function sasl_success_handler($xml)
*/ {
public function presence($status = null, $show = 'available', $to = null, $type='available', $priority=0) { $this->log->log("Auth success!");
if($type == 'available') $type = ''; $this->authed = true;
$to = htmlspecialchars($to); $this->reset();
$status = htmlspecialchars($status); }
if($show == 'unavailable') $type = 'unavailable';
$out = "<presence"; /**
if($to) $out .= " to=\"$to\""; * SASL feature handler
if($type) $out .= " type='$type'"; *
if($show == 'available' and !$status) { * @param string $xml
$out .= "/>"; * @throws Exception
} else { */
$out .= ">"; protected function sasl_failure_handler($xml)
if($show != 'available') $out .= "<show>$show</show>"; {
if($status) $out .= "<status>$status</status>"; $this->log->log("Auth failed!", Log::LEVEL_ERROR);
if($priority) $out .= "<priority>$priority</priority>"; $this->disconnect();
$out .= "</presence>";
}
$this->send($out); throw new Exception('Auth failed!');
} }
/**
* Send Auth request
*
* @param string $jid
*/
public function subscribe($jid) {
$this->send("<presence type='subscribe' to='{$jid}' from='{$this->fulljid}' />");
#$this->send("<presence type='subscribed' to='{$jid}' from='{$this->fulljid}' />");
}
/** /**
* Message handler * Resource bind handler
* *
* @param string $xml * @param string $xml
*/ */
public function message_handler($xml) { protected function resource_bind_handler($xml)
if(isset($xml->attrs['type'])) { {
$payload['type'] = $xml->attrs['type']; if ($xml->attrs['type'] == 'result') {
} else { $this->log->log("Bound to " . $xml->sub('bind')->sub('jid')->data);
$payload['type'] = 'chat'; $this->fulljid = $xml->sub('bind')->sub('jid')->data;
} $jidarray = explode('/', $this->fulljid);
$payload['from'] = $xml->attrs['from']; $this->jid = $jidarray[0];
$payload['body'] = $xml->sub('body')->data; }
$payload['xml'] = $xml; $id = $this->getId();
$this->log->log("Message: {$xml->sub('body')->data}", XMPPHP_Log::LEVEL_DEBUG); $this->addIdHandler($id, 'session_start_handler');
$this->event('message', $payload); $this->send("<iq xmlns='jabber:client' type='set' id='$id'><session xmlns='urn:ietf:params:xml:ns:xmpp-session' /></iq>");
} }
/** /**
* Presence handler * Roster iq handler
* * Gets all packets matching XPath "iq/{jabber:iq:roster}query'
* @param string $xml *
*/ * @param string $xml
public function presence_handler($xml) { */
$payload['type'] = (isset($xml->attrs['type'])) ? $xml->attrs['type'] : 'available'; protected function roster_iq_handler($xml)
$payload['show'] = (isset($xml->sub('show')->data)) ? $xml->sub('show')->data : $payload['type']; {
$payload['from'] = $xml->attrs['from']; $status = "result";
$payload['status'] = (isset($xml->sub('status')->data)) ? $xml->sub('status')->data : ''; $xmlroster = $xml->sub('query');
$payload['priority'] = (isset($xml->sub('priority')->data)) ? intval($xml->sub('priority')->data) : 0; foreach ($xmlroster->subs as $item) {
$payload['xml'] = $xml; $groups = array();
if($this->track_presence) { if ($item->name == 'item') {
$this->roster->setPresence($payload['from'], $payload['priority'], $payload['show'], $payload['status']); $jid = $item->attrs['jid']; //REQUIRED
} $name = $item->attrs['name']; //MAY
$this->log->log("Presence: {$payload['from']} [{$payload['show']}] {$payload['status']}", XMPPHP_Log::LEVEL_DEBUG); $subscription = $item->attrs['subscription'];
if(array_key_exists('type', $xml->attrs) and $xml->attrs['type'] == 'subscribe') { foreach ($item->subs as $subitem) {
if($this->auto_subscribe) { if ($subitem->name == 'group') {
$this->send("<presence type='subscribed' to='{$xml->attrs['from']}' from='{$this->fulljid}' />"); $groups[] = $subitem->data;
$this->send("<presence type='subscribe' to='{$xml->attrs['from']}' from='{$this->fulljid}' />"); }
} }
$this->event('subscription_requested', $payload); $contacts[] = array($jid, $subscription, $name, $groups); //Store for action if no errors happen
} elseif(array_key_exists('type', $xml->attrs) and $xml->attrs['type'] == 'subscribed') { } else {
$this->event('subscription_accepted', $payload); $status = "error";
} else { }
$this->event('presence', $payload); }
} if ($status == "result") { //No errors, add contacts
} foreach ($contacts as $contact) {
$this->roster->addContact($contact[0], $contact[1], $contact[2], $contact[3]);
}
}
if ($xml->attrs['type'] == 'set') {
$this->send("<iq type=\"reply\" id=\"{$xml->attrs['id']}\" to=\"{$xml->attrs['from']}\" />");
}
}
/** /**
* Features handler * Session start handler
* *
* @param string $xml * @param string $xml
*/ */
protected function features_handler($xml) { protected function session_start_handler($xml)
if($xml->hasSub('starttls') and $this->use_encryption) { {
$this->send("<starttls xmlns='urn:ietf:params:xml:ns:xmpp-tls'><required /></starttls>"); $this->log->log("Session started");
} elseif($xml->hasSub('bind') and $this->authed) { $this->session_started = true;
$id = $this->getId(); $this->event('session_start');
$this->addIdHandler($id, 'resource_bind_handler'); }
$this->send("<iq xmlns=\"jabber:client\" type=\"set\" id=\"$id\"><bind xmlns=\"urn:ietf:params:xml:ns:xmpp-bind\"><resource>{$this->resource}</resource></bind></iq>");
} else {
$this->log->log("Attempting Auth...");
if ($this->password) {
$this->send("<auth xmlns='urn:ietf:params:xml:ns:xmpp-sasl' mechanism='PLAIN'>" . base64_encode("\x00" . $this->user . "\x00" . $this->password) . "</auth>");
} else {
$this->send("<auth xmlns='urn:ietf:params:xml:ns:xmpp-sasl' mechanism='ANONYMOUS'/>");
}
}
}
/** /**
* SASL success handler * TLS proceed handler
* *
* @param string $xml * @param string $xml
*/ */
protected function sasl_success_handler($xml) { protected function tls_proceed_handler($xml)
$this->log->log("Auth success!"); {
$this->authed = true; $this->log->log("Starting TLS encryption");
$this->reset(); stream_socket_enable_crypto($this->socket, true, STREAM_CRYPTO_METHOD_SSLv23_CLIENT);
} $this->reset();
}
/** /**
* SASL feature handler * VCard retrieval handler
* *
* @param string $xml * @param XMLObj $xml
*/ */
protected function sasl_failure_handler($xml) { protected function vcard_get_handler($xml)
$this->log->log("Auth failed!", XMPPHP_Log::LEVEL_ERROR); {
$this->disconnect(); $vcard_array = array();
$vcard = $xml->sub('vcard');
throw new XMPPHP_Exception('Auth failed!'); // go through all of the sub elements and add them to the vcard array
} foreach ($vcard->subs as $sub) {
if ($sub->subs) {
/** $vcard_array[$sub->name] = array();
* Resource bind handler foreach ($sub->subs as $sub_child) {
* $vcard_array[$sub->name][$sub_child->name] = $sub_child->data;
* @param string $xml }
*/ } else {
protected function resource_bind_handler($xml) { $vcard_array[$sub->name] = $sub->data;
if($xml->attrs['type'] == 'result') { }
$this->log->log("Bound to " . $xml->sub('bind')->sub('jid')->data); }
$this->fulljid = $xml->sub('bind')->sub('jid')->data; $vcard_array['from'] = $xml->attrs['from'];
$jidarray = explode('/',$this->fulljid); $this->event('vcard', $vcard_array);
$this->jid = $jidarray[0]; }
}
$id = $this->getId();
$this->addIdHandler($id, 'session_start_handler');
$this->send("<iq xmlns='jabber:client' type='set' id='$id'><session xmlns='urn:ietf:params:xml:ns:xmpp-session' /></iq>");
}
/**
* Retrieves the roster
*
*/
public function getRoster() {
$id = $this->getID();
$this->send("<iq xmlns='jabber:client' type='get' id='$id'><query xmlns='jabber:iq:roster' /></iq>");
}
/**
* Roster iq handler
* Gets all packets matching XPath "iq/{jabber:iq:roster}query'
*
* @param string $xml
*/
protected function roster_iq_handler($xml) {
$status = "result";
$xmlroster = $xml->sub('query');
foreach($xmlroster->subs as $item) {
$groups = array();
if ($item->name == 'item') {
$jid = $item->attrs['jid']; //REQUIRED
$name = $item->attrs['name']; //MAY
$subscription = $item->attrs['subscription'];
foreach($item->subs as $subitem) {
if ($subitem->name == 'group') {
$groups[] = $subitem->data;
}
}
$contacts[] = array($jid, $subscription, $name, $groups); //Store for action if no errors happen
} else {
$status = "error";
}
}
if ($status == "result") { //No errors, add contacts
foreach($contacts as $contact) {
$this->roster->addContact($contact[0], $contact[1], $contact[2], $contact[3]);
}
}
if ($xml->attrs['type'] == 'set') {
$this->send("<iq type=\"reply\" id=\"{$xml->attrs['id']}\" to=\"{$xml->attrs['from']}\" />");
}
}
/**
* Session start handler
*
* @param string $xml
*/
protected function session_start_handler($xml) {
$this->log->log("Session started");
$this->session_started = true;
$this->event('session_start');
}
/**
* TLS proceed handler
*
* @param string $xml
*/
protected function tls_proceed_handler($xml) {
$this->log->log("Starting TLS encryption");
stream_socket_enable_crypto($this->socket, true, STREAM_CRYPTO_METHOD_SSLv23_CLIENT);
$this->reset();
}
/**
* Retrieves the vcard
*
*/
public function getVCard($jid = Null) {
$id = $this->getID();
$this->addIdHandler($id, 'vcard_get_handler');
if($jid) {
$this->send("<iq type='get' id='$id' to='$jid'><vCard xmlns='vcard-temp' /></iq>");
} else {
$this->send("<iq type='get' id='$id'><vCard xmlns='vcard-temp' /></iq>");
}
}
/**
* VCard retrieval handler
*
* @param XML Object $xml
*/
protected function vcard_get_handler($xml) {
$vcard_array = array();
$vcard = $xml->sub('vcard');
// go through all of the sub elements and add them to the vcard array
foreach ($vcard->subs as $sub) {
if ($sub->subs) {
$vcard_array[$sub->name] = array();
foreach ($sub->subs as $sub_child) {
$vcard_array[$sub->name][$sub_child->name] = $sub_child->data;
}
} else {
$vcard_array[$sub->name] = $sub->data;
}
}
$vcard_array['from'] = $xml->attrs['from'];
$this->event('vcard', $vcard_array);
}
} }

View File

@ -1,114 +0,0 @@
<?php
/**
* XMPPHP: The PHP XMPP Library
* Copyright (C) 2008 Nathanael C. Fritz
* This file is part of SleekXMPP.
*
* XMPPHP is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation; either version 2 of the License, or
* (at your option) any later version.
*
* XMPPHP 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 General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with XMPPHP; if not, write to the Free Software
* Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
*
* @category xmpphp
* @package XMPPHP
* @author Nathanael C. Fritz <JID: fritzy@netflint.net>
* @author Stephan Wentz <JID: stephan@jabber.wentz.it>
* @author Michael Garvin <JID: gar@netflint.net>
* @copyright 2008 Nathanael C. Fritz
*/
/** XMPPHP_XMPP
*
* This file is unnecessary unless you need to connect to older, non-XMPP-compliant servers like Dreamhost's.
* In this case, use instead of XMPPHP_XMPP, otherwise feel free to delete it.
* The old Jabber protocol wasn't standardized, so use at your own risk.
*
*/
require_once "XMPP.php";
class XMPPHP_XMPPOld extends XMPPHP_XMPP {
/**
*
* @var string
*/
protected $session_id;
public function __construct($host, $port, $user, $password, $resource, $server = null, $printlog = false, $loglevel = null) {
parent::__construct($host, $port, $user, $password, $resource, $server, $printlog, $loglevel);
if(!$server) $server = $host;
$this->stream_start = '<stream:stream to="' . $server . '" xmlns:stream="http://etherx.jabber.org/streams" xmlns="jabber:client">';
$this->fulljid = "{$user}@{$server}/{$resource}";
}
/**
* Override XMLStream's startXML
*
* @param parser $parser
* @param string $name
* @param array $attr
*/
public function startXML($parser, $name, $attr) {
if($this->xml_depth == 0) {
$this->session_id = $attr['ID'];
$this->authenticate();
}
parent::startXML($parser, $name, $attr);
}
/**
* Send Authenticate Info Request
*
*/
public function authenticate() {
$id = $this->getId();
$this->addidhandler($id, 'authfieldshandler');
$this->send("<iq type='get' id='$id'><query xmlns='jabber:iq:auth'><username>{$this->user}</username></query></iq>");
}
/**
* Retrieve auth fields and send auth attempt
*
* @param XMLObj $xml
*/
public function authFieldsHandler($xml) {
$id = $this->getId();
$this->addidhandler($id, 'oldAuthResultHandler');
if($xml->sub('query')->hasSub('digest')) {
$hash = sha1($this->session_id . $this->password);
print "{$this->session_id} {$this->password}\n";
$out = "<iq type='set' id='$id'><query xmlns='jabber:iq:auth'><username>{$this->user}</username><digest>{$hash}</digest><resource>{$this->resource}</resource></query></iq>";
} else {
$out = "<iq type='set' id='$id'><query xmlns='jabber:iq:auth'><username>{$this->user}</username><password>{$this->password}</password><resource>{$this->resource}</resource></query></iq>";
}
$this->send($out);
}
/**
* Determine authenticated or failure
*
* @param XMLObj $xml
*/
public function oldAuthResultHandler($xml) {
if($xml->attrs['type'] != 'result') {
$this->log->log("Auth failed!", XMPPHP_Log::LEVEL_ERROR);
$this->disconnect();
throw new XMPPHP_Exception('Auth failed!');
} else {
$this->log->log("Session started");
$this->event('session_start');
}
}
}
?>

View File

@ -4,7 +4,7 @@
* *
* Queue-mediated proxy class for outgoing XMPP messages. * Queue-mediated proxy class for outgoing XMPP messages.
* *
* PHP version 5 * PHP version 7
* *
* LICENCE: This program is free software: you can redistribute it and/or modify * 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
@ -31,28 +31,32 @@ if (!defined('STATUSNET') && !defined('LACONICA')) {
exit(1); exit(1);
} }
class QueuedXMPP extends XMPPHP_XMPP require_once dirname(__DIR__) . '/extlib/XMPPHP/XMPP.php';
use XMPPHP\XMPP;
class QueuedXMPP extends XMPP
{ {
/** /**
* Reference to the XmppPlugin object we're hooked up to. * Reference to the XmppPlugin object we're hooked up to.
*/ */
public $plugin; public $plugin;
/** /**
* Constructor * Constructor
* *
* @param XmppPlugin $plugin * @param XmppPlugin $plugin
* @param string $host * @param string $host
* @param integer $port * @param integer $port
* @param string $user * @param string $user
* @param string $password * @param string $password
* @param string $resource * @param string $resource
* @param string $server * @param string $server
* @param boolean $printlog * @param boolean $printlog
* @param string $loglevel * @param string $loglevel
*/ */
public function __construct($plugin, $host, $port, $user, $password, $resource, $server = null, $printlog = false, $loglevel = null) public function __construct($plugin, $host, $port, $user, $password, $resource, $server = null, $printlog = false, $loglevel = null)
{ {
$this->plugin = $plugin; $this->plugin = $plugin;
parent::__construct($host, $port, $user, $password, $resource, $server, $printlog, $loglevel); parent::__construct($host, $port, $user, $password, $resource, $server, $printlog, $loglevel);
@ -76,15 +80,21 @@ class QueuedXMPP extends XMPPHP_XMPP
* to a real XMPP connection. * to a real XMPP connection.
* *
* @param string $msg * @param string $msg
* @param null $timeout
*/ */
public function send($msg, $timeout=NULL) public function send($msg, $timeout = NULL)
{ {
$this->plugin->enqueueOutgoingRaw($msg); @$this->plugin->enqueueOutgoingRaw($msg);
} }
//@{ //@{
/** /**
* Stream i/o functions disabled; only do output * Stream i/o functions disabled; only do output
* @param int $timeout
* @param bool $persistent
* @param bool $sendinit
* @throws Exception
*/ */
public function connect($timeout = 30, $persistent = false, $sendinit = true) public function connect($timeout = 30, $persistent = false, $sendinit = true)
{ {
@ -104,7 +114,7 @@ class QueuedXMPP extends XMPPHP_XMPP
throw new Exception('Cannot read stream from fake XMPP.'); throw new Exception('Cannot read stream from fake XMPP.');
} }
public function processUntil($event, $timeout=-1) public function processUntil($event, $timeout = -1)
{ {
// No i18n needed. Test message. // No i18n needed. Test message.
throw new Exception('Cannot read stream from fake XMPP.'); throw new Exception('Cannot read stream from fake XMPP.');

View File

@ -5,7 +5,7 @@
* *
* Send and receive notices using the Jabber network * Send and receive notices using the Jabber network
* *
* PHP version 5 * PHP version 7
* *
* This program is free software: you can redistribute it and/or modify * 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
@ -34,7 +34,11 @@ if (!defined('STATUSNET')) {
exit(1); exit(1);
} }
class SharingXMPP extends XMPPHP_XMPP require_once dirname(__DIR__) . '/extlib/XMPPHP/XMPP.php';
use XMPPHP\XMPP;
class SharingXMPP extends XMPP
{ {
function getSocket() function getSocket()
{ {

View File

@ -17,7 +17,11 @@
* along with this program. If not, see <http://www.gnu.org/licenses/>. * along with this program. If not, see <http://www.gnu.org/licenses/>.
*/ */
if (!defined('STATUSNET') && !defined('LACONICA')) { exit(1); } if (!defined('STATUSNET') && !defined('LACONICA')) {
exit(1);
}
use XMPPHP\Log;
/** /**
* XMPP background connection manager for XMPP-using queue handlers, * XMPP background connection manager for XMPP-using queue handlers,
@ -31,28 +35,86 @@ if (!defined('STATUSNET') && !defined('LACONICA')) { exit(1); }
*/ */
class XmppManager extends ImManager class XmppManager extends ImManager
{ {
const PING_INTERVAL = 120;
public $conn = null;
protected $lastping = null; protected $lastping = null;
protected $pingid = null; protected $pingid = null;
public $conn = null;
const PING_INTERVAL = 120;
/** /**
* Initialize connection to server. * Initialize connection to server.
* @param $master
* @return boolean true on success * @return boolean true on success
*/ */
public function start($master) public function start($master)
{ {
if(parent::start($master)) if (parent::start($master)) {
{
$this->connect(); $this->connect();
return true; return true;
}else{ } else {
return false; return false;
} }
} }
function connect()
{
if (!$this->conn || $this->conn->isDisconnected()) {
$resource = 'queue' . posix_getpid();
$this->conn = new SharingXMPP($this->plugin->host ?
$this->plugin->host :
$this->plugin->server,
$this->plugin->port,
$this->plugin->user,
$this->plugin->password,
$this->plugin->resource,
$this->plugin->server,
$this->plugin->debug ?
true : false,
$this->plugin->debug ?
Log::LEVEL_VERBOSE : null
);
if (!$this->conn) {
return false;
}
$this->conn->addEventHandler('message', 'handle_xmpp_message', $this);
$this->conn->addEventHandler('reconnect', 'handle_xmpp_reconnect', $this);
$this->conn->setReconnectTimeout(600);
$this->conn->autoSubscribe();
$this->conn->useEncryption($this->plugin->encryption);
$this->conn->connect(true);
$this->conn->processUntil('session_start');
// TRANS: Presence announcement for XMPP.
$this->send_presence(_m('Send me a message to post a notice'), 'available', null, 'available', 100);
}
return $this->conn;
}
/**
* sends a presence stanza on the XMPP 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 send_presence($status, $show = 'available', $to = null,
$type = 'available', $priority = null)
{
$this->connect();
if (!$this->conn || $this->conn->isDisconnected()) {
return false;
}
$this->conn->presence($status, $show, $to, $type, $priority);
return true;
}
function send_raw_message($data) function send_raw_message($data)
{ {
$this->connect(); $this->connect();
@ -80,14 +142,9 @@ class XmppManager extends ImManager
public function handleInput($socket) public function handleInput($socket)
{ {
// Process the queue for as long as needed // Process the queue for as long as needed
try { common_log(LOG_DEBUG, "Servicing the XMPP queue.");
common_log(LOG_DEBUG, "Servicing the XMPP queue."); $this->stats('xmpp_process');
$this->stats('xmpp_process'); $this->conn->processTime(0);
$this->conn->processTime(0);
} catch (XMPPHP_Exception $e) {
common_log(LOG_ERR, "Got an XMPPHP_Exception: " . $e->getMessage());
die($e->getMessage());
}
} }
/** /**
@ -99,9 +156,9 @@ class XmppManager extends ImManager
public function getSockets() public function getSockets()
{ {
$this->connect(); $this->connect();
if($this->conn){ if ($this->conn) {
return array($this->conn->getSocket()); return array($this->conn->getSocket());
}else{ } else {
return array(); return array();
} }
} }
@ -112,63 +169,17 @@ class XmppManager extends ImManager
* *
* Side effect: kills process on exception from XMPP library. * Side effect: kills process on exception from XMPP library.
* *
* @param int $timeout
* @todo FIXME: non-dying error handling * @todo FIXME: non-dying error handling
*/ */
public function idle($timeout=0) public function idle($timeout = 0)
{ {
$now = time(); $now = time();
if (empty($this->lastping) || $now - $this->lastping > self::PING_INTERVAL) { if (empty($this->lastping) || $now - $this->lastping > self::PING_INTERVAL) {
try { $this->send_ping();
$this->send_ping();
} catch (XMPPHP_Exception $e) {
common_log(LOG_ERR, "Got an XMPPHP_Exception: " . $e->getMessage());
die($e->getMessage());
}
} }
} }
function connect()
{
if (!$this->conn || $this->conn->isDisconnected()) {
$resource = 'queue' . posix_getpid();
$this->conn = new SharingXMPP($this->plugin->host ?
$this->plugin->host :
$this->plugin->server,
$this->plugin->port,
$this->plugin->user,
$this->plugin->password,
$this->plugin->resource,
$this->plugin->server,
$this->plugin->debug ?
true : false,
$this->plugin->debug ?
XMPPHP_Log::LEVEL_VERBOSE : null
);
if (!$this->conn) {
return false;
}
$this->conn->addEventHandler('message', 'handle_xmpp_message', $this);
$this->conn->addEventHandler('reconnect', 'handle_xmpp_reconnect', $this);
$this->conn->setReconnectTimeout(600);
$this->conn->autoSubscribe();
$this->conn->useEncryption($this->plugin->encryption);
try {
$this->conn->connect(true); // true = persistent connection
} catch (XMPPHP_Exception $e) {
common_log(LOG_ERR, $e->getMessage());
return false;
}
$this->conn->processUntil('session_start');
// TRANS: Presence announcement for XMPP.
$this->send_presence(_m('Send me a message to post a notice'), 'available', null, 'available', 100);
}
return $this->conn;
}
function send_ping() function send_ping()
{ {
$this->connect(); $this->connect();
@ -183,7 +194,7 @@ class XmppManager extends ImManager
} }
common_log(LOG_DEBUG, "Sending ping #{$this->pingid}"); common_log(LOG_DEBUG, "Sending ping #{$this->pingid}");
$this->conn->send("<iq from='{$this->plugin->daemonScreenname()}' to='{$this->plugin->server}' id='ping_{$this->pingid}' type='get'><ping xmlns='urn:xmpp:ping'/></iq>"); $this->conn->send("<iq from='{$this->plugin->daemonScreenname()}' to='{$this->plugin->server}' id='ping_{$this->pingid}' type='get'><ping xmlns='urn:xmpp:ping'/></iq>");
$this->lastping = $now; $this->lastping = $now;
return true; return true;
} }
@ -207,35 +218,12 @@ class XmppManager extends ImManager
$this->send_presence(_m('Send me a message to post a notice'), 'available', null, 'available', 100); $this->send_presence(_m('Send me a message to post a notice'), 'available', null, 'available', 100);
} }
/**
* sends a presence stanza on the XMPP 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 send_presence($status, $show='available', $to=null,
$type = 'available', $priority=null)
{
$this->connect();
if (!$this->conn || $this->conn->isDisconnected()) {
return false;
}
$this->conn->presence($status, $show, $to, $type, $priority);
return true;
}
/** /**
* sends a "special" presence stanza on the XMPP network * sends a "special" presence stanza on the XMPP network
* *
* @param string $type Type of presence * @param string $type Type of presence
* @param string $to JID to send presence to * @param string $to JID to send presence to
* @param string $show show value for presence * @param string $show show value for presence
* @param string $status status value for presence * @param string $status status value for presence
* *
* @return boolean success flag * @return boolean success flag
@ -243,7 +231,7 @@ class XmppManager extends ImManager
* @see send_presence() * @see send_presence()
*/ */
function special_presence($type, $to=null, $show=null, $status=null) function special_presence($type, $to = null, $show = null, $status = null)
{ {
// @todo FIXME: why use this instead of send_presence()? // @todo FIXME: why use this instead of send_presence()?
$this->connect(); $this->connect();
@ -251,7 +239,7 @@ class XmppManager extends ImManager
return false; return false;
} }
$to = htmlspecialchars($to); $to = htmlspecialchars($to);
$status = htmlspecialchars($status); $status = htmlspecialchars($status);
$out = "<presence"; $out = "<presence";