diogo/xmpphp
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Modern version of XMPPHP extlib

Browse Source 
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-06-18 19:02:40 +01:00
parent fd9cac3c17
commit c7cdcc588a
20 changed files with 2659 additions and 2265 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
.gitignore vendored Normal file
View File

@ -0,0 +1,6 @@
composer.phar
/vendor/
# Commit your application's lock file https://getcomposer.org/doc/01-basic-usage.md#commit-your-composer-lock-file-to-version-control
# You may choose to ignore a library lock file http://getcomposer.org/doc/02-libraries.md#lock-file
# composer.lock

59
README
View File

@ -1,59 +0,0 @@
About
================================================================================
XMPPHP is an elegant PHP library for XMPP (aka Jabber, Google Talk, etc).
Homepage: http://code.google.com/p/xmpphp
This fork: http://github.com/cweiske/xmpphp/
Chatroom: xmpphp@conference.psi-im.org (XMPP MUC)
PEAR package: http://pearhub.org/projects/cwXMPPHP/
Author: Nathan Fritz, jabber id: fritzy [at] netflint.net
Co-Author: Stephan Wentz, jabber id: stephan [at] wentz.it
Maintainer of this fork: Christian Weiske <cweiske@cweiske.de>
If you have any questions (no matter how dumb), please send me an IM. I enjoy
helping people with my code.
Requirements
================================================================================
* PHP 5.x
* SSL Support Compiled
History
================================================================================
Carlo Zottmann handed me maintenance of Class.Jabber.PHP years and years ago
(2003?). While I did fix some bugs, I never did much with it. I promised many
people that it would return as a PHP5 rewrite. That day has finally come.
This code is based on my experience with Class.Jabber.PHP, but more closely
related to my Python library, SleekXMPP (http://code.google.com/p/sleekxmpp).
Documentation
================================================================================
For now, look at the examples. In the near future, I'll have better
documentation on the website.
Installation
================================================================================
Either get the code from github, the last release from google code
or install the PEAR package from pearhub.org:
$ pear channel-discover pearhub.org
$ pear install pearhub/cwXMPPHP
The code on google code is not being actively maintained anymore, so
don't expect current releases there.
TODO
================================================================================
* Documentation
* MUC Support
License Exception
===============================================================================
Please contact Nathan Fritz for library exceptions if you would like to
distribute XMPPHP with a non-GPL compatible license.
Also, if you would like to distribute XMPPHP as part of a commercial package,
I sell commercial licenses.

20
README.md Normal file
View File

@ -0,0 +1,20 @@
README
======
About XMPPHP
------------
XMPPHP is an elegant PHP library for XMPP (aka Jabber, Google Talk, etc).
* Homepage: [http://code.google.com/p/xmpphp]
* Chatroom: [xmpphp@conference.psi-im.org] (XMPP MUC)
* Author: Nathan Fritz, jabber id: fritzy [at] netflint.net
* Co-Author: Stephan Wentz, jabber id: stephan [at] wentz.it
* This fork: https://github.com/diogogithub/xmpphp
* Maintainer of this fork: Diogo Cordeiro <diogo@fc.up.pt>
Requirements
------------
* PHP 7.0
* SSL Support Compiled

345
XMPPHP/BOSH.php
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
@ -23,16 +24,23 @@
* @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 'XMPPHP/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>
@ -40,149 +48,362 @@ require_once 'XMPPHP/XMPP.php';
* @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;
/**
* @var string
*/
protected $sid; protected $sid;
/**
* @var string
*/
protected $http_server; protected $http_server;
protected $http_buffer = Array();
/**
* @var array
*/
protected $http_buffer = array();
/**
* @var string
*/
protected $session = false; protected $session = false;
public function connect($server, $wait='1', $session=false) { /**
* @var integer
*/
protected $inactivity;
/**
* Connect
*
* @param $server
* @param $wait
* @param $session
* @throws Exception
* @throws Exception
*/
public function connect($server = null, $wait = '1', $session = false)
{
if (is_null($server)) {
// If we aren't given the server http url, try and guess it
$port_string = ($this->port AND $this->port != 80) ? ':' . $this->port : '';
$this->http_server = 'http://' . $this->host . $port_string . '/http-bind/';
} else {
$this->http_server = $server; $this->http_server = $server;
}
$this->use_encryption = false; $this->use_encryption = false;
$this->session = $session; $this->session = $session;
$this->rid = 3001; $this->rid = 3001;
$this->sid = null; $this->sid = null;
if($session) $this->inactivity = 0;
{
if ($session) {
$this->loadSession(); $this->loadSession();
} }
if (!$this->sid) { if (!$this->sid) {
$body = $this->__buildBody(); $body = $this->__buildBody();
$body->addAttribute('hold', '1'); $body->addAttribute('hold', '1');
$body->addAttribute('to', $this->host); $body->addAttribute('to', $this->server);
$body->addAttribute('route', "xmpp:{$this->host}:{$this->port}"); $body->addAttribute('route', 'xmpp:' . $this->host . ':' . $this->port);
$body->addAttribute('secure', 'true'); $body->addAttribute('secure', 'true');
$body->addAttribute('xmpp:version','1.6', 'urn:xmpp:xbosh'); $body->addAttribute('xmpp:version', '1.0', 'urn:xmpp:xbosh');
$body->addAttribute('wait', strval($wait)); $body->addAttribute('wait', strval($wait));
$body->addAttribute('ack', '1'); $body->addAttribute('ack', '1');
$body->addAttribute('xmlns:xmpp', 'urn:xmpp:xbosh'); $body->addAttribute('xmlns:xmpp', 'urn:xmpp:xbosh');
$buff = "<stream:stream xmlns='jabber:client' xmlns:stream='http://etherx.jabber.org/streams'>"; $buff = '<stream:stream xmlns="jabber:client" xmlns:stream="http://etherx.jabber.org/streams">';
xml_parse($this->parser, $buff, false); xml_parse($this->parser, $buff, false);
$response = $this->__sendBody($body); $response = $this->__sendBody($body);
$rxml = new SimpleXMLElement($response); $rxml = new SimpleXMLElement($response);
$this->sid = $rxml['sid']; $this->sid = $rxml['sid'];
$this->inactivity = $rxml['inactivity'];
} else { } else {
$buff = "<stream:stream xmlns='jabber:client' xmlns:stream='http://etherx.jabber.org/streams'>"; $buff = '<stream:stream xmlns="jabber:client" xmlns:stream="http://etherx.jabber.org/streams">';
xml_parse($this->parser, $buff, false); xml_parse($this->parser, $buff, false);
} }
} }
public function __sendBody($body=null, $recv=true) { /**
* 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) { if (!$body) {
$body = $this->__buildBody(); $body = $this->__buildBody();
} }
$ch = curl_init($this->http_server);
$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_HEADER, 0);
curl_setopt($ch, CURLOPT_POST, 1); curl_setopt($ch, CURLOPT_POST, 1);
curl_setopt($ch, CURLOPT_POSTFIELDS, $body->asXML()); curl_setopt($ch, CURLOPT_POSTFIELDS, $body->asXML());
curl_setopt($ch, CURLOPT_FOLLOWLOCATION, true); 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_HTTPHEADER, $header);
curl_setopt($ch, CURLOPT_VERBOSE, 0); curl_setopt($ch, CURLOPT_VERBOSE, 0);
$output = '';
if ($recv) { if ($recv) {
curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1); curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);
$output = curl_exec($ch); $output = curl_exec($ch);
if (curl_getinfo($ch, CURLINFO_HTTP_CODE) != '200') {
throw new Exception('Wrong response from server!');
}
$this->http_buffer[] = $output; $this->http_buffer[] = $output;
} }
curl_close($ch); curl_close($ch);
return $output; return $output;
} }
public function __buildBody($sub=null) { /**
$xml = new SimpleXMLElement("<body xmlns='http://jabber.org/protocol/httpbind' xmlns:xmpp='urn:xmpp:xbosh' />"); * Process
$xml->addAttribute('content', 'text/xml; charset=utf-8'); *
$xml->addAttribute('rid', $this->rid); * @param $null1
$this->rid += 1; * @param $null2
if($this->sid) $xml->addAttribute('sid', $this->sid); *
#if($this->sid) $xml->addAttribute('xmlns', 'http://jabber.org/protocol/httpbind'); * null params are not used and just to statify Strict Function Declaration
$xml->addAttribute('xml:lang', 'en'); * @return bool
if($sub) { // ok, so simplexml is lame * @throws Exception
$p = dom_import_simplexml($xml); * @throws Exception
$c = dom_import_simplexml($sub); */
$cn = $p->ownerDocument->importNode($c, true); public function __process($null1 = null, $null2 = null)
$p->appendChild($cn); {
$xml = simplexml_import_dom($p);
}
return $xml;
}
public function __process() {
if ($this->http_buffer) { if ($this->http_buffer) {
$this->__parseBuffer(); $this->__parseBuffer();
} else { } else {
$this->__sendBody(); $this->__sendBody();
$this->__parseBuffer(); $this->__parseBuffer();
} }
$this->saveSession();
return true;
} }
public function __parseBuffer() { public function __parseBuffer()
{
while ($this->http_buffer) { while ($this->http_buffer) {
$idx = key($this->http_buffer); $idx = key($this->http_buffer);
$buffer = $this->http_buffer[$idx]; $buffer = $this->http_buffer[$idx];
unset($this->http_buffer[$idx]); unset($this->http_buffer[$idx]);
if ($buffer) { if ($buffer) {
$xml = new SimpleXMLElement($buffer); $xml = new SimpleXMLElement($buffer);
$children = $xml->xpath('child::node()'); $children = $xml->xpath('child::node()');
foreach ($children as $child) { foreach ($children as $child) {
$buff = $child->asXML(); $buff = $child->asXML();
$this->log->log("RECV: $buff", XMPPHP_Log::LEVEL_VERBOSE); $this->log->log('RECV: ' . $buff, Log::LEVEL_VERBOSE);
xml_parse($this->parser, $buff, false); xml_parse($this->parser, $buff, false);
} }
} }
} }
} }
public function send($msg) { /**
$this->log->log("SEND: $msg", XMPPHP_Log::LEVEL_VERBOSE); * Save session
$msg = new SimpleXMLElement($msg); *
#$msg->addAttribute('xmlns', 'jabber:client'); */
$this->__sendBody($this->__buildBody($msg), true); public function saveSession()
#$this->__parseBuffer(); {
$_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);
}
} }
public function reset() { /**
* 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; $this->xml_depth = 0;
unset($this->xmlobj); unset($this->xmlobj);
$this->xmlobj = array(); $this->xmlobj = array();
$this->setupParser(); $this->setupParser();
#$this->send($this->stream_start);
$body = $this->__buildBody(); $body = $this->__buildBody();
$body->addAttribute('to', $this->host); $body->addAttribute('to', $this->host);
$body->addAttribute('xmpp:restart', 'true', 'urn:xmpp:xbosh'); $body->addAttribute('xmpp:restart', 'true', 'urn:xmpp:xbosh');
$buff = "<stream:stream xmlns='jabber:client' xmlns:stream='http://etherx.jabber.org/streams'>"; $buff = '<stream:stream xmlns="jabber:client" xmlns:stream="http://etherx.jabber.org/streams">';
$response = $this->__sendBody($body); $response = $this->__sendBody($body);
$this->been_reset = true; $this->been_reset = true;
xml_parse($this->parser, $buff, false); xml_parse($this->parser, $buff, false);
} }
public function loadSession() { /**
if(isset($_SESSION['XMPPHP_BOSH_RID'])) $this->rid = $_SESSION['XMPPHP_BOSH_RID']; * Disconnect
if(isset($_SESSION['XMPPHP_BOSH_SID'])) $this->sid = $_SESSION['XMPPHP_BOSH_SID']; *
if(isset($_SESSION['XMPPHP_BOSH_authed'])) $this->authed = $_SESSION['XMPPHP_BOSH_authed']; * @throws Exception
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 disconnect()
} {
public function saveSession() { parent::disconnect();
$_SESSION['XMPPHP_BOSH_RID'] = (string) $this->rid;
$_SESSION['XMPPHP_BOSH_SID'] = (string) $this->sid; if ($this->session == 'ON_FILE') {
$_SESSION['XMPPHP_BOSH_authed'] = (boolean) $this->authed; unlink($this->getSessionFile());
$_SESSION['XMPPHP_BOSH_jid'] = (string) $this->jid; } else {
$_SESSION['XMPPHP_BOSH_fulljid'] = (string) $this->fulljid; $keys = array('RID', 'SID', 'authed', 'basejid', 'fulljid', 'inactivity', 'lat');
foreach ($keys as $key) {
unset($_SESSION['XMPPHP_BOSH'][$key]);
}
}
} }
} }

12
XMPPHP/Exception.php Executable file → Normal file
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
@ -23,13 +24,19 @@
* @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>
@ -37,5 +44,6 @@
* @copyright 2008 Nathanael C. Fritz * @copyright 2008 Nathanael C. Fritz
* @version $Id$ * @version $Id$
*/ */
class XMPPHP_Exception extends Exception { class Exception extends ObjectException
{
} }

34
XMPPHP/Log.php
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
@ -23,9 +24,14 @@
* @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
* *
@ -36,8 +42,8 @@
* @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_ERROR = 0;
const LEVEL_WARNING = 1; const LEVEL_WARNING = 1;
const LEVEL_INFO = 2; const LEVEL_INFO = 2;
@ -68,9 +74,10 @@ class XMPPHP_Log {
* Constructor * Constructor
* *
* @param boolean $printout * @param boolean $printout
* @param string $runlevel * @param int $runlevel
*/ */
public function __construct($printout = false, $runlevel = self::LEVEL_INFO) { public function __construct($printout = false, $runlevel = self::LEVEL_INFO)
{
$this->printout = (boolean)$printout; $this->printout = (boolean)$printout;
$this->runlevel = (int)$runlevel; $this->runlevel = (int)$runlevel;
} }
@ -82,7 +89,8 @@ class XMPPHP_Log {
* @param string $msg * @param string $msg
* @param integer $runlevel * @param integer $runlevel
*/ */
public function log($msg, $runlevel = self::LEVEL_INFO) { public function log($msg, $runlevel = self::LEVEL_INFO)
{
$time = time(); $time = time();
#$this->data[] = array($this->runlevel, $msg, $time); #$this->data[] = array($this->runlevel, $msg, $time);
if ($this->printout and $runlevel <= $this->runlevel) { if ($this->printout and $runlevel <= $this->runlevel) {
@ -90,6 +98,13 @@ class XMPPHP_Log {
} }
} }
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();
}
/** /**
* Output the complete log. * Output the complete log.
* Log will be cleared if $clear = true * Log will be cleared if $clear = true
@ -97,7 +112,8 @@ class XMPPHP_Log {
* @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) { if ($runlevel === null) {
$runlevel = $this->runlevel; $runlevel = $this->runlevel;
} }
@ -110,10 +126,4 @@ class XMPPHP_Log {
$this->data = array(); $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();
}
} }

84
XMPPHP/Roster.php
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
@ -23,13 +24,17 @@
* @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>
@ -37,21 +42,23 @@
* @copyright 2008 Nathanael C. Fritz * @copyright 2008 Nathanael C. Fritz
* @version $Id$ * @version $Id$
*/ */
class Roster
class Roster { {
/** /**
* Roster array, handles contacts and presence. Indexed by jid. * Roster array, handles contacts and presence. Indexed by jid.
* Contains array with potentially two indexes 'contact' and 'presence' * Contains array with potentially two indexes 'contact' and 'presence'
* @var array * @var array
*/ */
protected $roster_array = array(); protected $roster_array = array();
/** /**
* Constructor * Constructor
* * @param array $roster_array
*/ */
public function __construct($roster_array = array()) { public function __construct($roster_array = array())
{
if ($this->verifyRoster($roster_array)) { if ($this->verifyRoster($roster_array)) {
$this->roster_array = $roster_array; //Allow for prepopulation with existing roster $this->roster_array = $roster_array; //Allow for pre-population with existing roster
} else { } else {
$this->roster_array = array(); $this->roster_array = array();
} }
@ -62,28 +69,12 @@ class Roster {
* 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) { protected function verifyRoster($roster_array)
{
#TODO once we know *what* a valid roster array looks like #TODO once we know *what* a valid roster array looks like
return True; return true;
}
/**
*
* Add given contact to roster
*
* @param string $jid
* @param string $subscription
* @param string $name
* @param array $groups
*/
public function addContact($jid, $subscription, $name='', $groups=array()) {
$contact = array('jid' => $jid, 'subscription' => $subscription, 'name' => $name, 'groups' => $groups);
if ($this->isContact($jid)) {
$this->roster_array[$jid]['contact'] = $contact;
} else {
$this->roster_array[$jid] = array('contact' => $contact);
}
} }
/** /**
@ -91,8 +82,10 @@ class Roster {
* Retrieve contact via jid * Retrieve contact via jid
* *
* @param string $jid * @param string $jid
* @return mixed
*/ */
public function getContact($jid) { public function getContact($jid)
{
if ($this->isContact($jid)) { if ($this->isContact($jid)) {
return $this->roster_array[$jid]['contact']; return $this->roster_array[$jid]['contact'];
} }
@ -103,8 +96,10 @@ class Roster {
* Discover if a contact exists in the roster via jid * Discover if a contact exists in the roster via jid
* *
* @param string $jid * @param string $jid
* @return bool
*/ */
public function isContact($jid) { public function isContact($jid)
{
return (array_key_exists($jid, $this->roster_array)); return (array_key_exists($jid, $this->roster_array));
} }
@ -117,7 +112,8 @@ class Roster {
* @param string $show * @param string $show
* @param string $status * @param string $status
*/ */
public function setPresence($presence, $priority, $show, $status) { public function setPresence($presence, $priority, $show, $status)
{
$presence = explode('/', $presence, 2); $presence = explode('/', $presence, 2);
$jid = $presence[0]; $jid = $presence[0];
$resource = isset($presence[1]) ? $presence[1] : ''; $resource = isset($presence[1]) ? $presence[1] : '';
@ -132,13 +128,34 @@ class Roster {
} }
} }
/**
*
* Add given contact to roster
*
* @param string $jid
* @param string $subscription
* @param string $name
* @param array $groups
*/
public function addContact($jid, $subscription, $name = '', $groups = array())
{
$contact = array('jid' => $jid, 'subscription' => $subscription, 'name' => $name, 'groups' => $groups);
if ($this->isContact($jid)) {
$this->roster_array[$jid]['contact'] = $contact;
} else {
$this->roster_array[$jid] = array('contact' => $contact);
}
}
/* /*
* *
* Return best presence for jid * Return best presence for jid
* *
* @param string $jid * @param string $jid
*/ */
public function getPresence($jid) {
public function getPresence($jid)
{
$split = explode('/', $jid, 2); $split = explode('/', $jid, 2);
$jid = $split[0]; $jid = $split[0];
if ($this->isContact($jid)) { if ($this->isContact($jid)) {
@ -153,13 +170,14 @@ class Roster {
return $current; return $current;
} }
} }
/** /**
* *
* Get roster * Get roster
* *
*/ */
public function getRoster() { public function getRoster()
{
return $this->roster_array; return $this->roster_array;
} }
} }
?>

34
XMPPHP/XMLObj.php
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
@ -23,13 +24,17 @@
* @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 XMLObject * 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>
@ -37,7 +42,8 @@
* @copyright 2008 Nathanael C. Fritz * @copyright 2008 Nathanael C. Fritz
* @version $Id$ * @version $Id$
*/ */
class XMPPHP_XMLObj { class XMLObj
{
/** /**
* Tag name * Tag name
* *
@ -81,7 +87,8 @@ class XMPPHP_XMLObj {
* @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->name = strtolower($name);
$this->ns = $ns; $this->ns = $ns;
if (is_array($attrs) && count($attrs)) { if (is_array($attrs) && count($attrs)) {
@ -97,7 +104,8 @@ class XMPPHP_XMLObj {
* *
* @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 str_repeat("\t", $depth) . $this->name . " " . $this->ns . ' ' . $this->data;
print "\n"; print "\n";
foreach ($this->subs as $sub) { foreach ($this->subs as $sub) {
@ -109,13 +117,15 @@ class XMPPHP_XMLObj {
* 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 = '') { public function toString($str = '')
{
$str .= "<{$this->name} xmlns='{$this->ns}' "; $str .= "<{$this->name} xmlns='{$this->ns}' ";
foreach ($this->attrs as $key => $value) { foreach ($this->attrs as $key => $value) {
if ($key != 'xmlns') { if ($key != 'xmlns') {
$value = htmlspecialchars($value); $value = htmlspecialchars($value);
$str .= "$key=\"$value\" "; $str .= "$key='$value' ";
} }
} }
$str .= ">"; $str .= ">";
@ -131,11 +141,15 @@ class XMPPHP_XMLObj {
* Has this XML Object the given sub? * Has this XML Object the given sub?
* *
* @param string $name * @param string $name
* @param null $ns
* @return boolean * @return boolean
*/ */
public function hasSub($name, $ns = null) { public function hasSub($name, $ns = null)
{
foreach ($this->subs as $sub) { foreach ($this->subs as $sub) {
if(($name == "*" or $sub->name == $name) and ($ns == null or $sub->ns == $ns)) return true; if (($name == "*" or $sub->name == $name) and ($ns == null or $sub->ns == $ns)) {
return true;
}
} }
return false; return false;
} }
@ -146,8 +160,10 @@ class XMPPHP_XMLObj {
* @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) { public function sub($name, $attrs = null, $ns = null)
{
#TODO attrs is ignored #TODO attrs is ignored
foreach ($this->subs as $sub) { foreach ($this->subs as $sub) {
if ($sub->name == $name and ($ns == null or $sub->ns == $ns)) { if ($sub->name == $name and ($ns == null or $sub->ns == $ns)) {

1125
XMPPHP/XMLStream.php
View File

File diff suppressed because it is too large Load Diff

344
XMPPHP/XMPP.php
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
@ -23,17 +24,22 @@
* @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 'XMPPHP/XMLStream.php'; require_once __DIR__ . DIRECTORY_SEPARATOR . 'XMLStream.php';
require_once 'XMPPHP/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>
@ -41,7 +47,8 @@ require_once 'XMPPHP/Roster.php';
* @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
*/ */
@ -51,68 +58,44 @@ class XMPPHP_XMPP extends XMPPHP_XMLStream {
* @var string * @var string
*/ */
public $user; public $user;
/**
* @var boolean
*/
public $track_presence = true;
/**
* @var object
*/
public $roster;
/** /**
* @var string * @var string
*/ */
protected $password; protected $password;
/** /**
* @var string * @var string
*/ */
protected $resource; protected $resource;
/** /**
* @var string * @var string
*/ */
protected $fulljid; protected $fulljid;
/** /**
* @var string * @var string
*/ */
protected $basejid; protected $basejid;
/** /**
* @var boolean * @var boolean
*/ */
protected $authed = false; protected $authed = false;
protected $session_started = false; protected $session_started = false;
/** /**
* @var boolean * @var boolean
*/ */
protected $auto_subscribe = false; protected $auto_subscribe = false;
/** /**
* @var boolean * @var boolean
*/ */
protected $use_encryption = true; protected $use_encryption = true;
/**
* @var boolean
*/
public $track_presence = true;
/**
* @var object
*/
public $roster;
/**
* @var array supported auth mechanisms
*/
protected $auth_mechanism_supported = array('PLAIN', 'DIGEST-MD5');
/**
* @var string default auth mechanism
*/
protected $auth_mechanism_default = 'PLAIN';
/**
* @var string prefered auth mechanism
*/
protected $auth_mechanism_preferred = 'DIGEST-MD5';
/** /**
* Constructor * Constructor
* *
@ -125,13 +108,16 @@ class XMPPHP_XMPP extends XMPPHP_XMLStream {
* @param boolean $printlog * @param boolean $printlog
* @param string $loglevel * @param string $loglevel
*/ */
public function __construct($host, $port, $user, $password, $resource, $server = null, $printlog = false, $loglevel = null) { public function __construct($host, $port, $user, $password, $resource, $server = null, $printlog = false, $loglevel = null)
{
parent::__construct($host, $port, $printlog, $loglevel); parent::__construct($host, $port, $printlog, $loglevel);
$this->user = $user; $this->user = $user;
$this->password = $password; $this->password = $password;
$this->resource = $resource; $this->resource = $resource;
if(!$server) $server = $host; if (!$server) {
$server = $host;
}
$this->server = $server; $this->server = $server;
$this->basejid = $this->user . '@' . $this->host; $this->basejid = $this->user . '@' . $this->host;
@ -149,8 +135,6 @@ class XMPPHP_XMPP extends XMPPHP_XMLStream {
$this->addXPathHandler('{jabber:client}message', 'message_handler'); $this->addXPathHandler('{jabber:client}message', 'message_handler');
$this->addXPathHandler('{jabber:client}presence', 'presence_handler'); $this->addXPathHandler('{jabber:client}presence', 'presence_handler');
$this->addXPathHandler('iq/{jabber:iq:roster}query', 'roster_iq_handler'); $this->addXPathHandler('iq/{jabber:iq:roster}query', 'roster_iq_handler');
// For DIGEST-MD5 auth :
$this->addXPathHandler('{urn:ietf:params:xml:ns:xmpp-sasl}challenge', 'sasl_challenge_handler');
} }
/** /**
@ -158,7 +142,8 @@ class XMPPHP_XMPP extends XMPPHP_XMLStream {
* *
* @param boolean $useEncryption * @param boolean $useEncryption
*/ */
public function useEncryption($useEncryption = true) { public function useEncryption($useEncryption = true)
{
$this->use_encryption = $useEncryption; $this->use_encryption = $useEncryption;
} }
@ -167,7 +152,8 @@ class XMPPHP_XMPP extends XMPPHP_XMLStream {
* *
* @param boolean $autoSubscribe * @param boolean $autoSubscribe
*/ */
public function autoSubscribe($autoSubscribe = true) { public function autoSubscribe($autoSubscribe = true)
{
$this->auto_subscribe = $autoSubscribe; $this->auto_subscribe = $autoSubscribe;
} }
@ -178,24 +164,27 @@ class XMPPHP_XMPP extends XMPPHP_XMLStream {
* @param string $body * @param string $body
* @param string $type * @param string $type
* @param string $subject * @param string $subject
* @param null $payload
* @throws Exception
*/ */
public function message($to, $body, $type = 'chat', $subject = null, $payload = null) { public function message($to, $body, $type = 'chat', $subject = null, $payload = null)
if(is_null($type))
{ {
if ($this->disconnected) {
throw new Exception('You need to connect first');
}
if (empty($type)) {
$type = 'chat'; $type = 'chat';
} }
$to = htmlspecialchars($to); $to = htmlspecialchars($to);
$body = htmlspecialchars($body); $body = htmlspecialchars($body);
$subject = htmlspecialchars($subject); $subject = htmlspecialchars($subject);
$subject = ($subject) ? '<subject>' . $subject . '</subject>' : '';
$out = "<message from=\"{$this->fulljid}\" to=\"$to\" type='$type'>"; $payload = ($payload) ? $payload : '';
if($subject) $out .= "<subject>$subject</subject>"; $sprintf = '<message from="%s" to="%s" type="%s">%s<body>%s</body>%s</message>';
$out .= "<body>$body</body>"; $output = sprintf($sprintf, $this->fulljid, $to, $type, $subject, $body, $payload);
if($payload) $out .= $payload; $this->send($output);
$out .= "</message>";
$this->send($out);
} }
/** /**
@ -204,80 +193,69 @@ class XMPPHP_XMPP extends XMPPHP_XMLStream {
* @param string $status * @param string $status
* @param string $show * @param string $show
* @param string $to * @param string $to
* @param string $type
* @param null $priority
* @throws Exception
*/ */
public function presence($status = null, $show = 'available', $to = null, $type='available', $priority=null) { public function presence($status = null, $show = 'available', $to = null, $type = 'available', $priority = null)
if($type == 'available') $type = ''; {
if ($this->disconnected) {
throw new Exception('You need to connect first');
}
if ($type == 'available') {
$type = '';
}
$to = htmlspecialchars($to); $to = htmlspecialchars($to);
$status = htmlspecialchars($status); $status = htmlspecialchars($status);
if($show == 'unavailable') $type = 'unavailable'; if ($show == 'unavailable') {
$type = 'unavailable';
}
$out = "<presence"; $out = "<presence";
if($to) $out .= " to=\"$to\""; if ($to) {
if($type) $out .= " type='$type'"; $out .= " to=\"$to\"";
}
if ($type) {
$out .= " type='$type'";
}
if ($show == 'available' and !$status and $priority !== null) { if ($show == 'available' and !$status and $priority !== null) {
$out .= "/>"; $out .= "/>";
} else { } else {
$out .= ">"; $out .= ">";
if($show != 'available') $out .= "<show>$show</show>"; if ($show != 'available') {
if($status) $out .= "<status>$status</status>"; $out .= "<show>$show</show>";
if($priority !== null) $out .= "<priority>$priority</priority>"; }
if ($status) {
$out .= "<status>$status</status>";
}
if ($priority !== null) {
$out .= "<priority>$priority</priority>";
}
$out .= "</presence>"; $out .= "</presence>";
} }
$this->send($out); $this->send($out);
} }
/** /**
* Send Auth request * Send Auth request
* *
* @param string $jid * @param string $jid
*/ */
public function subscribe($jid) { public function subscribe($jid)
{
$this->send("<presence type='subscribe' to='{$jid}' from='{$this->fulljid}' />"); $this->send("<presence type='subscribe' to='{$jid}' from='{$this->fulljid}' />");
#$this->send("<presence type='subscribed' to='{$jid}' from='{$this->fulljid}' />"); #$this->send("<presence type='subscribed' to='{$jid}' from='{$this->fulljid}' />");
} }
/**
* Add user to Roster
*
* @param string $jid user jid
* @param string $name user nickname
* @param string $group group to add
*/
public function RosterAddUser($jid, $name=null, $group=null) {
$payload = "<item jid='$jid'".($name ? " name='" . htmlspecialchars($name) . "'" : '')."/>\n".
($group?'<group>'.htmlspecialchars($group, ENT_QUOTES, 'UTF-8').'</group>':'');
$this->SendIq(NULL, 'set', "jabber:iq:roster", $payload);
}
/**
* Send ID action
*
* @param string $to to jid
* @param string $type type of ID
* @param string $xmlns xmlns name
* @param string $payload payload string
* @param string $from from jid
*/
private function sendIq($to = NULL, $type = 'get', $xmlns = NULL, $payload = NULL, $from = NULL)
{
$id = $this->getID();
$xml = "<iq type='$type' id='$id'".
($to ? " to='$to'" : '').
($from ? " from='$from'" : '').
">
<query xmlns='$xmlns'>
$payload
</query>
</iq>";
return $this->send($xml);
}
/** /**
* Message handler * Message handler
* *
* @param string $xml * @param string $xml
*/ */
public function message_handler($xml) { public function message_handler($xml)
{
if (isset($xml->attrs['type'])) { if (isset($xml->attrs['type'])) {
$payload['type'] = $xml->attrs['type']; $payload['type'] = $xml->attrs['type'];
} else { } else {
@ -285,9 +263,9 @@ class XMPPHP_XMPP extends XMPPHP_XMLStream {
} }
$body = $xml->sub('body'); $body = $xml->sub('body');
$payload['from'] = $xml->attrs['from']; $payload['from'] = $xml->attrs['from'];
$payload['body'] = is_object($body) ? $body->data : FALSE; // $xml->sub('body')->data; $payload['body'] = is_object($body) ? $body->data : false; // $xml->sub('body')->data;
$payload['xml'] = $xml; $payload['xml'] = $xml;
$this->log->log("Message: {$payload['body']}", XMPPHP_Log::LEVEL_DEBUG); $this->log->log("Message: {$payload['body']}", Log::LEVEL_DEBUG);
$this->event('message', $payload); $this->event('message', $payload);
} }
@ -296,7 +274,8 @@ class XMPPHP_XMPP extends XMPPHP_XMLStream {
* *
* @param string $xml * @param string $xml
*/ */
public function presence_handler($xml) { public function presence_handler($xml)
{
$payload['type'] = (isset($xml->attrs['type'])) ? $xml->attrs['type'] : 'available'; $payload['type'] = (isset($xml->attrs['type'])) ? $xml->attrs['type'] : 'available';
$payload['show'] = (isset($xml->sub('show')->data)) ? $xml->sub('show')->data : $payload['type']; $payload['show'] = (isset($xml->sub('show')->data)) ? $xml->sub('show')->data : $payload['type'];
$payload['from'] = $xml->attrs['from']; $payload['from'] = $xml->attrs['from'];
@ -306,7 +285,7 @@ class XMPPHP_XMPP extends XMPPHP_XMLStream {
if ($this->track_presence) { if ($this->track_presence) {
$this->roster->setPresence($payload['from'], $payload['priority'], $payload['show'], $payload['status']); $this->roster->setPresence($payload['from'], $payload['priority'], $payload['show'], $payload['status']);
} }
$this->log->log("Presence: {$payload['from']} [{$payload['show']}] {$payload['status']}", XMPPHP_Log::LEVEL_DEBUG); $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 (array_key_exists('type', $xml->attrs) and $xml->attrs['type'] == 'subscribe') {
if ($this->auto_subscribe) { if ($this->auto_subscribe) {
$this->send("<presence type='subscribed' to='{$xml->attrs['from']}' from='{$this->fulljid}' />"); $this->send("<presence type='subscribed' to='{$xml->attrs['from']}' from='{$this->fulljid}' />");
@ -320,12 +299,38 @@ class XMPPHP_XMPP extends XMPPHP_XMLStream {
} }
} }
/**
* 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>");
}
/**
* Retrieves the vcard
* @param null $jid
*/
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>");
}
}
/** /**
* Features handler * Features handler
* *
* @param string $xml * @param string $xml
*/ */
protected function features_handler($xml) { protected function features_handler($xml)
{
if ($xml->hasSub('starttls') and $this->use_encryption) { if ($xml->hasSub('starttls') and $this->use_encryption) {
$this->send("<starttls xmlns='urn:ietf:params:xml:ns:xmpp-tls'><required /></starttls>"); $this->send("<starttls xmlns='urn:ietf:params:xml:ns:xmpp-tls'><required /></starttls>");
} elseif ($xml->hasSub('bind') and $this->authed) { } elseif ($xml->hasSub('bind') and $this->authed) {
@ -335,33 +340,7 @@ class XMPPHP_XMPP extends XMPPHP_XMLStream {
} else { } else {
$this->log->log("Attempting Auth..."); $this->log->log("Attempting Auth...");
if ($this->password) { if ($this->password) {
$mechanism = 'PLAIN'; // default;
if ($xml->hasSub('mechanisms') && $xml->sub('mechanisms')->hasSub('mechanism')) {
// Get the list of all available auth mechanism that we can use
$available = array();
foreach ($xml->sub('mechanisms')->subs as $sub) {
if ($sub->name == 'mechanism') {
if (in_array($sub->data, $this->auth_mechanism_supported)) {
$available[$sub->data] = $sub->data;
}
}
}
if (isset($available[$this->auth_mechanism_preferred])) {
$mechanism = $this->auth_mechanism_preferred;
} else {
// use the first available
$mechanism = reset($available);
}
$this->log->log("Trying $mechanism (available : " . implode(',', $available) . ')');
}
switch ($mechanism) {
case 'PLAIN':
$this->send("<auth xmlns='urn:ietf:params:xml:ns:xmpp-sasl' mechanism='PLAIN'>" . base64_encode("\x00" . $this->user . "\x00" . $this->password) . "</auth>"); $this->send("<auth xmlns='urn:ietf:params:xml:ns:xmpp-sasl' mechanism='PLAIN'>" . base64_encode("\x00" . $this->user . "\x00" . $this->password) . "</auth>");
break;
case 'DIGEST-MD5':
$this->send("<auth xmlns='urn:ietf:params:xml:ns:xmpp-sasl' mechanism='DIGEST-MD5' />");
break;
}
} else { } else {
$this->send("<auth xmlns='urn:ietf:params:xml:ns:xmpp-sasl' mechanism='ANONYMOUS'/>"); $this->send("<auth xmlns='urn:ietf:params:xml:ns:xmpp-sasl' mechanism='ANONYMOUS'/>");
} }
@ -373,7 +352,8 @@ class XMPPHP_XMPP extends XMPPHP_XMLStream {
* *
* @param string $xml * @param string $xml
*/ */
protected function sasl_success_handler($xml) { protected function sasl_success_handler($xml)
{
$this->log->log("Auth success!"); $this->log->log("Auth success!");
$this->authed = true; $this->authed = true;
$this->reset(); $this->reset();
@ -383,62 +363,14 @@ class XMPPHP_XMPP extends XMPPHP_XMLStream {
* SASL feature handler * SASL feature handler
* *
* @param string $xml * @param string $xml
* @throws Exception
*/ */
protected function sasl_failure_handler($xml) { protected function sasl_failure_handler($xml)
$this->log->log("Auth failed!", XMPPHP_Log::LEVEL_ERROR); {
$this->log->log("Auth failed!", Log::LEVEL_ERROR);
$this->disconnect(); $this->disconnect();
throw new XMPPHP_Exception('Auth failed!'); throw new Exception('Auth failed!');
}
/**
* Handle challenges for DIGEST-MD5 auth
*
* @param string $xml
*/
protected function sasl_challenge_handler($xml) {
// Decode and parse the challenge string
// (may be something like foo="bar",foo2="bar2,bar3,bar4",foo3=bar5 )
$challenge = base64_decode($xml->data);
$vars = array();
$matches = array();
preg_match_all('/(\w+)=(?:"([^"]*)|([^,]*))/', $challenge, $matches);
$res = array();
foreach ($matches[1] as $k => $v) {
$vars[$v] = (empty($matches[2][$k])?$matches[3][$k]:$matches[2][$k]);
}
if (isset($vars['nonce'])) {
// First step
$vars['cnonce'] = uniqid(mt_rand(), false);
$vars['nc'] = '00000001';
$vars['qop'] = 'auth'; // Force qop to auth
if (!isset($vars['digest-uri'])) $vars['digest-uri'] = 'xmpp/' . $this->server;
if (!isset($vars['realm'])) $vars['realm'] = '';
// now, the magic...
$a1 = sprintf('%s:%s:%s', $this->user, $vars['realm'], $this->password);
if ($vars['algorithm'] == 'md5-sess') {
$a1 = pack('H32',md5($a1)) . ':' . $vars['nonce'] . ':' . $vars['cnonce'];
}
$a2 = "AUTHENTICATE:" . $vars['digest-uri'];
$password = md5($a1) . ':' . $vars['nonce'] . ':' . $vars['nc'] . ':' . $vars['cnonce'] . ':' . $vars['qop'] . ':' .md5($a2);
$password = md5($password);
$response = sprintf('username="%s",realm="%s",nonce="%s",cnonce="%s",nc=%s,qop=%s,digest-uri="%s",response=%s,charset=utf-8',
$this->user, $vars['realm'], $vars['nonce'], $vars['cnonce'], $vars['nc'], $vars['qop'], $vars['digest-uri'], $password);
// Send the response
$response = base64_encode($response);
$this->send("<response xmlns='urn:ietf:params:xml:ns:xmpp-sasl'>$response</response>");
} else {
if (isset($vars['rspauth'])) {
// Second step
$this->send("<response xmlns='urn:ietf:params:xml:ns:xmpp-sasl'/>");
} else {
$this->log->log("ERROR receiving challenge : " . $challenge, XMPPHP_Log::LEVEL_ERROR);
}
}
} }
/** /**
@ -446,7 +378,8 @@ class XMPPHP_XMPP extends XMPPHP_XMLStream {
* *
* @param string $xml * @param string $xml
*/ */
protected function resource_bind_handler($xml) { protected function resource_bind_handler($xml)
{
if ($xml->attrs['type'] == 'result') { if ($xml->attrs['type'] == 'result') {
$this->log->log("Bound to " . $xml->sub('bind')->sub('jid')->data); $this->log->log("Bound to " . $xml->sub('bind')->sub('jid')->data);
$this->fulljid = $xml->sub('bind')->sub('jid')->data; $this->fulljid = $xml->sub('bind')->sub('jid')->data;
@ -458,24 +391,14 @@ class XMPPHP_XMPP extends XMPPHP_XMLStream {
$this->send("<iq xmlns='jabber:client' type='set' id='$id'><session xmlns='urn:ietf:params:xml:ns:xmpp-session' /></iq>"); $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 * Roster iq handler
* Gets all packets matching XPath "iq/{jabber:iq:roster}query' * Gets all packets matching XPath "iq/{jabber:iq:roster}query'
* *
* Implements RFC3921, 7.4. "Adding a Roster Item"
*
* @param string $xml * @param string $xml
*/ */
protected function roster_iq_handler($xml) { protected function roster_iq_handler($xml)
{
$status = "result"; $status = "result";
$xmlroster = $xml->sub('query'); $xmlroster = $xml->sub('query');
foreach ($xmlroster->subs as $item) { foreach ($xmlroster->subs as $item) {
@ -500,7 +423,7 @@ class XMPPHP_XMPP extends XMPPHP_XMLStream {
} }
} }
if ($xml->attrs['type'] == 'set') { if ($xml->attrs['type'] == 'set') {
$this->send("<iq type=\"result\" id=\"{$xml->attrs['id']}\" to=\"{$xml->attrs['from']}\" />"); $this->send("<iq type=\"reply\" id=\"{$xml->attrs['id']}\" to=\"{$xml->attrs['from']}\" />");
} }
} }
@ -509,7 +432,8 @@ class XMPPHP_XMPP extends XMPPHP_XMLStream {
* *
* @param string $xml * @param string $xml
*/ */
protected function session_start_handler($xml) { protected function session_start_handler($xml)
{
$this->log->log("Session started"); $this->log->log("Session started");
$this->session_started = true; $this->session_started = true;
$this->event('session_start'); $this->event('session_start');
@ -520,32 +444,20 @@ class XMPPHP_XMPP extends XMPPHP_XMLStream {
* *
* @param string $xml * @param string $xml
*/ */
protected function tls_proceed_handler($xml) { protected function tls_proceed_handler($xml)
{
$this->log->log("Starting TLS encryption"); $this->log->log("Starting TLS encryption");
stream_socket_enable_crypto($this->socket, true, STREAM_CRYPTO_METHOD_SSLv23_CLIENT); stream_socket_enable_crypto($this->socket, true, STREAM_CRYPTO_METHOD_SSLv23_CLIENT);
$this->reset(); $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 * VCard retrieval handler
* *
* @param XML Object $xml * @param XMLObj $xml
*/ */
protected function vcard_get_handler($xml) { protected function vcard_get_handler($xml)
{
$vcard_array = array(); $vcard_array = array();
$vcard = $xml->sub('vcard'); $vcard = $xml->sub('vcard');
// go through all of the sub elements and add them to the vcard array // go through all of the sub elements and add them to the vcard array

114
XMPPHP/XMPP_Old.php
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');
}
}
}
?>

49
composer.json Normal file
View File

@ -0,0 +1,49 @@
{
"name": "diogocomposer/xmpphp",
"description": "XMPP PHP Library",
"type": "library",
"keywords": ["jabber", "xmpphp", "xmpp"],
"license": "GPL-2.0+",
"authors": [
{
"name": "Nathan Fritz",
"email": "fritzy@netflint.net"
},
{
"name": "Stephan Wentz",
"email": "stephan@wentz.it"
},
{
"name": "Christian Weiske",
"email": "cweiske@cweiske.de"
},
{
"name": "Vito Tafuni",
"email": "vitotafuni@gmail.com"
},
{
"name": "Ivan Borzenkov",
"email": "ivan.borzenkov@gmail.com"
},
{
"name": "bandroidx",
"email": "bandroidx@gmail.com"
},
{
"name": "BirknerAlex",
"email": "alex.birkner@gmail.com"
},
{
"name": "Diogo Cordeiro",
"email": "diogo@fc.up.pt"
}
],
"autoload": {
"psr-4": { "XMPPHP\\": "XMPPHP" }
},
"require": {
"php": ">=7.0.0",
"ext-mbstring": "*",
"ext-xml": "*"
}
}

138
examples/cli_longrun_example.php
View File

@ -1,70 +1,134 @@
<?php <?php
// activate full error reporting /**
//error_reporting(E_ALL & E_STRICT); * @file: XMPPHP Cli example
*
* @info: If this script doesn't work, are you running 64-bit PHP with < 5.2.6?
*/
include 'XMPPHP/XMPP.php'; /**
* Activate full error reporting
* error_reporting(E_ALL & E_STRICT);
*
* XMPPHP Log levels:
*
* LEVEL_ERROR = 0;
* LEVEL_WARNING = 1;
* LEVEL_INFO = 2;
* LEVEL_DEBUG = 3;
* LEVEL_VERBOSE = 4;
*/
#Use XMPPHP_Log::LEVEL_VERBOSE to get more logging for error reports require '../vendor/autoload.php';
#If this doesn't work, are you running 64-bit PHP with < 5.2.6?
$conn = new XMPPHP_XMPP('talk.google.com', 5222, 'username', 'password', 'xmpphp', 'gmail.com', $printlog=true, $loglevel=XMPPHP_Log::LEVEL_INFO); $conf = array(
'server' => 'talk.google.com',
'port' => 5222,
'username' => 'username',
'password' => 'password',
'proto' => 'xmpphp',
'domain' => 'gmail.com',
'printlog' => true,
'loglevel' => XMPPHP\Log::LEVEL_VERBOSE,
);
// Easy and simple for access to variables with their names
extract($conf);
$conn = new XMPPHP\XMPP($server, $port, $username, $password, $proto, $domain, $printlog, $loglevel);
$conn->autoSubscribe(); $conn->autoSubscribe();
$vcard_request = array(); $vcard_request = array();
try { try {
$conn->connect(); $conn->connect();
while (!$conn->isDisconnected()) { while (!$conn->isDisconnected()) {
$payloads = $conn->processUntil(array('message', 'presence', 'end_stream', 'session_start', 'vcard')); $events = array('message', 'presence', 'end_stream', 'session_start', 'vcard');
foreach($payloads as $event) { $payloads = $conn->processUntil($events);
$pl = $event[1];
switch($event[0]) { foreach ($payloads as $result) {
list($event, $data) = $result;
if (isset($data)) {
extract($data);
}
switch ($event) {
case 'message': case 'message':
print "---------------------------------------------------------------------------------\n";
print "Message from: {$pl['from']}\n"; if (!$body) {
if($pl['subject']) print "Subject: {$pl['subject']}\n"; break;
print $pl['body'] . "\n"; }
print "---------------------------------------------------------------------------------\n";
$conn->message($pl['from'], $body="Thanks for sending me \"{$pl['body']}\".", $type=$pl['type']); echo str_repeat('-', 80);
$cmd = explode(' ', $pl['body']); echo "Message from: $from";
if($cmd[0] == 'quit') $conn->disconnect();
if($cmd[0] == 'break') $conn->send("</end>"); if (isset($subject)) {
echo "Subject: $subject";
}
echo $body;
echo str_repeat('-', 80);
$cmd = explode(' ', $body);
$body = "Mi no entender! '$body'";
$conn->message($from, $body, $type);
if (isset($cmd[0])) {
if ($cmd[0] == 'quit') {
$conn->disconnect();
}
if ($cmd[0] == 'break') {
$conn->send('</end>');
}
if ($cmd[0] == 'vcard') { if ($cmd[0] == 'vcard') {
if(!($cmd[1])) $cmd[1] = $conn->user . '@' . $conn->server; if (!isset($cmd[1])) {
// take a note which user requested which vcard $cmd[1] = $conn->user;
$vcard_request[$pl['from']] = $cmd[1]; }
// request the vcard
// Take a note which user requested which vcard
$vcard_request[$from] = $cmd[1];
// Request the vcard
$conn->getVCard($cmd[1]); $conn->getVCard($cmd[1]);
} }
}
break; break;
case 'presence': case 'presence':
print "Presence: {$pl['from']} [{$pl['show']}] {$pl['status']}\n";
echo "Presence: $from [$show] $status\n";
break; break;
case 'session_start': case 'session_start':
print "Session Start\n";
echo "Session start\n";
$conn->getRoster(); $conn->getRoster();
$conn->presence($status="Cheese!"); $conn->presence('Quasar!');
break; break;
case 'vcard': case 'vcard':
// check to see who requested this vcard
$deliver = array_keys($vcard_request, $pl['from']); $deliver = array_keys($vcard_request, $from);
// work through the array to generate a message
print_r($pl);
$msg = ''; $msg = '';
foreach($pl as $key => $item) {
$msg .= "$key: "; foreach ($data as $key => $item) {
$msg .= $key . ': ';
if (is_array($item)) { if (is_array($item)) {
$msg .= "\n"; $msg .= "\n";
foreach ($item as $subkey => $subitem) { foreach ($item as $subkey => $subitem) {
$msg .= " $subkey: $subitem\n"; $msg .= ' ' . $subkey . ':' . $subitem . "\n";
} }
} else { } else {
$msg .= "$item\n"; $msg .= $item . "\n";
} }
} }
// deliver the vcard msg to everyone that requested that vcard
foreach ($deliver as $sendjid) { foreach ($deliver as $sendjid) {
// remove the note on requests as we send out the message
unset($vcard_request[$sendjid]); unset($vcard_request[$sendjid]);
$conn->message($sendjid, $msg, 'chat'); $conn->message($sendjid, $msg, 'chat');
} }
@ -72,6 +136,6 @@ try {
} }
} }
} }
} catch(XMPPHP_Exception $e) { } catch (XMPPHP\Exception $e) {
die($e->getMessage()); die($e->getMessage());
} }

105
examples/cli_longrun_example_bosh.php
View File

@ -1,43 +1,104 @@
<?php <?php
// activate full error reporting /**
//error_reporting(E_ALL & E_STRICT); * @file: XMPPHP Cli example BOSH
*
* @info: If this script doesn't work, are you running 64-bit PHP with < 5.2.6?
*/
include 'XMPPHP/BOSH.php'; /**
* Activate full error reporting
* error_reporting(E_ALL & E_STRICT);
*
* XMPPHP Log levels:
*
* LEVEL_ERROR = 0;
* LEVEL_WARNING = 1;
* LEVEL_INFO = 2;
* LEVEL_DEBUG = 3;
* LEVEL_VERBOSE = 4;
*/
#Use XMPPHP_Log::LEVEL_VERBOSE to get more logging for error reports require '../vendor/autoload.php';
#If this doesn't work, are you running 64-bit PHP with < 5.2.6?
$conn = new XMPPHP_BOSH('server.tld', 5280, 'username', 'password', 'xmpphp', 'server.tld', $printlog=true, $loglevel=XMPPHP_Log::LEVEL_VERBOSE); $conf = array(
'server' => 'server.tld',
'port' => 5280,
'username' => 'username',
'password' => 'password',
'proto' => 'xmpphp',
'domain' => 'server.tld',
'printlog' => true,
'loglevel' => XMPPHP\Log::LEVEL_VERBOSE,
);
// Easy and simple for access to variables with their names
extract($conf);
$conn = new XMPPHP\BOSH($server, $port, $username, $password, $proto, $domain, $printlog, $loglevel);
$conn->autoSubscribe(); $conn->autoSubscribe();
try { try {
$conn->connect('http://server.tld:5280/xmpp-httpbind'); $conn->connect('http://server.tld:5280/xmpp-httpbind');
while (!$conn->isDisconnected()) { while (!$conn->isDisconnected()) {
$payloads = $conn->processUntil(array('message', 'presence', 'end_stream', 'session_start')); $events = array('message', 'presence', 'end_stream', 'session_start');
foreach($payloads as $event) { $payloads = $conn->processUntil($events);
$pl = $event[1];
switch($event[0]) { foreach ($payloads as $result) {
list($event, $data) = $result;
if (isset($data)) {
extract($data);
}
switch ($event) {
case 'message': case 'message':
print "---------------------------------------------------------------------------------\n";
print "Message from: {$pl['from']}\n"; if (!$body) {
if($pl['subject']) print "Subject: {$pl['subject']}\n";
print $pl['body'] . "\n";
print "---------------------------------------------------------------------------------\n";
$conn->message($pl['from'], $body="Thanks for sending me \"{$pl['body']}\".", $type=$pl['type']);
if($pl['body'] == 'quit') $conn->disconnect();
if($pl['body'] == 'break') $conn->send("</end>");
break; break;
}
echo str_repeat('-', 80);
echo "Message from: $from";
if (isset($subject)) {
echo "Subject: $subject";
}
echo $body;
echo str_repeat('-', 80);
$cmd = explode(' ', $body);
$body = "Mi no entender! '$body'";
$conn->message($from, $body, $type);
if (isset($cmd[0])) {
if ($cmd[0] == 'quit') {
$conn->disconnect();
}
if ($cmd[0] == 'break') {
$conn->send('</end>');
}
}
break;
case 'presence': case 'presence':
print "Presence: {$pl['from']} [{$pl['show']}] {$pl['status']}\n";
echo "Presence: $from [$show] $status\n";
break; break;
case 'session_start': case 'session_start':
print "Session Start\n";
echo "Session start\n";
$conn->getRoster(); $conn->getRoster();
$conn->presence($status="Cheese!"); $conn->presence('Quasar!');
break; break;
} }
} }
} }
} catch(XMPPHP_Exception $e) { } catch (XMPPHP\Exception $e) {
die($e->getMessage()); die($e->getMessage());
} }

51
examples/sendmessage_example.php
View File

@ -1,20 +1,47 @@
<?php <?php
// activate full error reporting /**
//error_reporting(E_ALL & E_STRICT); * @file: XMPPHP Send message example
*
* @info: If this script doesn't work, are you running 64-bit PHP with < 5.2.6?
*/
/**
* Activate full error reporting
* error_reporting(E_ALL & E_STRICT);
*
* XMPPHP Log levels:
*
* LEVEL_ERROR = 0;
* LEVEL_WARNING = 1;
* LEVEL_INFO = 2;
* LEVEL_DEBUG = 3;
* LEVEL_VERBOSE = 4;
*/
include 'XMPPHP/XMPP.php'; require_once __DIR__.'/../vendor/autoload.php';
#Use XMPPHP_Log::LEVEL_VERBOSE to get more logging for error reports $conf = array(
#If this doesn't work, are you running 64-bit PHP with < 5.2.6? 'server' => 'talk.google.com',
$conn = new XMPPHP_XMPP('talk.google.com', 5222, 'username', 'password', 'xmpphp', 'gmail.com', $printlog=false, $loglevel=XMPPHP_Log::LEVEL_INFO); 'port' => 5222,
'username' => 'username',
'password' => 'password',
'proto' => 'xmpphp',
'domain' => 'gmail.com',
'printlog' => true,
'loglevel' => XMPPHP\Log::LEVEL_VERBOSE,
);
// Easy and simple for access to variables with their names
extract($conf);
$XMPP = new XMPPHP\XMPP($server, $port, $username, $password, $proto, $domain, $printlog, $loglevel);
try { try {
$conn->connect(); $XMPP->connect();
$conn->processUntil('session_start'); $XMPP->processUntil('session_start', 10);
$conn->presence(); $XMPP->presence();
$conn->message('someguy@someserver.net', 'This is a test message!'); $XMPP->message('target.user@jabber.domain.com', 'Hello, how are you?', 'chat');
$conn->disconnect(); $XMPP->disconnect();
} catch(XMPPHP_Exception $e) { } catch (XMPPHP\Exception $e) {
die($e->getMessage()); die($e->getMessage());
} }

117
examples/webclient_example.php
View File

@ -1,56 +1,117 @@
<?php <?php
/**
* @file: XMPPHP Cli example
*
* @info: If this script doesn't work, are you running 64-bit PHP with < 5.2.6?
*/
/**
* Activate full error reporting
* error_reporting(E_ALL & E_STRICT);
*
* XMPPHP Log levels:
*
* LEVEL_ERROR = 0;
* LEVEL_WARNING = 1;
* LEVEL_INFO = 2;
* LEVEL_DEBUG = 3;
* LEVEL_VERBOSE = 4;
*/
session_start(); session_start();
header('content-type', 'plain/text'); header('content-type', 'plain/text');
// activate full error reporting
//error_reporting(E_ALL & E_STRICT);
include 'XMPPHP/BOSH.php'; require '../vendor/autoload.php';
print "<pre>";
#Use XMPPHP_Log::LEVEL_VERBOSE to get more logging for error reports $conf = array(
#If this doesn't work, are you running 64-bit PHP with < 5.2.6? 'server' => 'talk.google.com',
$conn = new XMPPHP_BOSH('server.tld', 5280, 'user', 'password', 'xmpphp', 'server.tld', $printlog=true, $loglevel=XMPPHP_Log::LEVEL_INFO); 'port' => 5222,
'username' => 'username',
'password' => 'password',
'proto' => 'xmpphp',
'domain' => 'gmail.com',
'printlog' => true,
'loglevel' => XMPPHP\Log::LEVEL_VERBOSE,
);
// Easy and simple for access to variables with their names
extract($conf);
$conn = new XMPPHP\XMPP($server, $port, $username, $password, $proto, $domain, $printlog, $loglevel);
$conn->autoSubscribe(); $conn->autoSubscribe();
try { try {
if (isset($_SESSION['messages'])) { if (isset($_SESSION['messages'])) {
foreach($_SESSION['messages'] as $msg) { foreach ($_SESSION['messages'] as $message) {
print $msg; echo $message;
flush(); flush();
} }
} else {
$_SESSION['messages'] = array();
} }
$conn->connect('http://server.tld:5280/xmpp-httpbind', 1, true); $conn->connect('http://server.tld:5280/xmpp-httpbind', 1, true);
#while(true) { $events = array('message', 'presence', 'end_stream', 'session_start', 'vcard');
$payloads = $conn->processUntil(array('message', 'presence', 'end_stream', 'session_start')); $payloads = $conn->processUntil($events);
foreach($payloads as $event) {
$pl = $event[1]; foreach ($payloads as $result) {
switch($event[0]) { list($event, $data) = $result;
if (isset($data)) {
extract($data);
}
switch ($event) {
case 'message': case 'message':
if(!isset($_SESSION['messages'])) $_SESSION['message'] = Array();
$msg = "---------------------------------------------------------------------------------\n{$pl['from']}: {$pl['body']}\n"; if (!$body) {
print $msg; break;
}
$cmd = explode(' ', $body);
$msg = str_repeat('-', 80);
$msg .= "\nMessage from: $from\n";
if (isset($subject)) {
$msg .= "Subject: $subject\n";
}
$msg .= $body . "\n";
$msg .= str_repeat('-', 80);
echo "<pre>$msg</pre>";
if (isset($cmd[0])) {
if ($cmd[0] == 'quit') {
$conn->disconnect();
}
if ($cmd[0] == 'break') {
$conn->send('</end>');
}
}
$_SESSION['messages'][] = $msg; $_SESSION['messages'][] = $msg;
flush(); flush();
$conn->message($pl['from'], $body="Thanks for sending me \"{$pl['body']}\".", $type=$pl['type']);
if($pl['body'] == 'quit') $conn->disconnect();
if($pl['body'] == 'break') $conn->send("</end>");
break; break;
case 'presence': case 'presence':
print "Presence: {$pl['from']} [{$pl['show']}] {$pl['status']}\n";
echo "Presence: $from [$show] $status\n";
break; break;
case 'session_start': case 'session_start':
print "Session Start\n";
echo "Session start\n";
$conn->getRoster(); $conn->getRoster();
$conn->presence($status="Cheese!"); $conn->presence('Quasar!');
break; break;
} }
} }
#} } catch (XMPPHP\Exception $e) {
} catch(XMPPHP_Exception $e) {
die($e->getMessage()); die($e->getMessage());
} }
$conn->saveSession(); $conn->saveSession();
print "</pre>"; echo '<img src="http://xmpp.org/images/xmpp.png" onload="window.location.reload()" />';
print "<img src='http://xmpp.org/images/xmpp.png' onload='window.location.reload()' />";
?>

58
tests/AllTests.php
View File

@ -1,12 +1,61 @@
<?php <?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
*/
// Get current working directory with trailing slash
define('TESTS_DIR', dirname(__FILE__) . DIRECTORY_SEPARATOR);
// Get class directory with trailing slash
define('CLASS_DIR', dirname(TESTS_DIR) . DIRECTORY_SEPARATOR);
/** XMPPHP_LogTest */
require_once TESTS_DIR . 'XMPPHP' . DIRECTORY_SEPARATOR . 'LogTest.php';
/** XMPPHP_XMLObjTest */
require_once TESTS_DIR . 'XMPPHP' . DIRECTORY_SEPARATOR . 'XMLObjTest.php';
/** XMPPHP_XMPPTest */
require_once TESTS_DIR . 'XMPPHP' . DIRECTORY_SEPARATOR . 'XMPPTest.php';
if (!defined('PHPUnit_MAIN_METHOD')) { if (!defined('PHPUnit_MAIN_METHOD')) {
define('PHPUnit_MAIN_METHOD', 'AllTests::main'); define('PHPUnit_MAIN_METHOD', 'AllTests::main');
} }
require_once 'XMPPHP/LogTest.php'; /**
require_once 'XMPPHP/XMLObjTest.php'; * XMPPHP AllTests
require_once 'XMPPHP/XMPPTest.php'; *
* @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
* @version $Id$
*/
class AllTests class AllTests
{ {
public static function main() public static function main()
@ -17,7 +66,6 @@ class AllTests
public static function suite() public static function suite()
{ {
$suite = new PHPUnit_Framework_TestSuite(); $suite = new PHPUnit_Framework_TestSuite();
$suite->addTestSuite('XMPPHP_LogTest'); $suite->addTestSuite('XMPPHP_LogTest');
$suite->addTestSuite('XMPPHP_XMLObjTest'); $suite->addTestSuite('XMPPHP_XMLObjTest');
$suite->addTestSuite('XMPPHP_XMPPTest'); $suite->addTestSuite('XMPPHP_XMPPTest');

52
tests/XMPPHP/LogTest.php
View File

@ -1,13 +1,50 @@
<?php <?php
require_once dirname(dirname(dirname(__FILE__))) . '/XMPPHP/Log.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_Log */
require_once CLASS_DIR . 'XMPPHP' . DIRECTORY_SEPARATOR . 'Log.php';
/**
* XMPPHP LogTest
*
* @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
* @version $Id$
*/
class XMPPHP_LogTest extends PHPUnit_Framework_TestCase class XMPPHP_LogTest extends PHPUnit_Framework_TestCase
{ {
public function testPrintoutNoOutput() public function testPrintoutNoOutput()
{ {
$log = new XMPPHP_Log(); $log = new XMPPHP_Log();
$msg = 'I am a test log message'; $msg = 'I am a test log message';
ob_start(); ob_start();
@ -20,7 +57,6 @@ class XMPPHP_LogTest extends PHPUnit_Framework_TestCase
public function testPrintoutOutput() public function testPrintoutOutput()
{ {
$log = new XMPPHP_Log(true); $log = new XMPPHP_Log(true);
$msg = 'I am a test log message'; $msg = 'I am a test log message';
ob_start(); ob_start();
@ -33,7 +69,6 @@ class XMPPHP_LogTest extends PHPUnit_Framework_TestCase
public function testPrintoutNoOutputWithDefaultLevel() public function testPrintoutNoOutputWithDefaultLevel()
{ {
$log = new XMPPHP_Log(true, XMPPHP_Log::LEVEL_ERROR); $log = new XMPPHP_Log(true, XMPPHP_Log::LEVEL_ERROR);
$msg = 'I am a test log message'; $msg = 'I am a test log message';
ob_start(); ob_start();
@ -46,7 +81,6 @@ class XMPPHP_LogTest extends PHPUnit_Framework_TestCase
public function testPrintoutOutputWithDefaultLevel() public function testPrintoutOutputWithDefaultLevel()
{ {
$log = new XMPPHP_Log(true, XMPPHP_Log::LEVEL_INFO); $log = new XMPPHP_Log(true, XMPPHP_Log::LEVEL_INFO);
$msg = 'I am a test log message'; $msg = 'I am a test log message';
ob_start(); ob_start();
@ -59,7 +93,6 @@ class XMPPHP_LogTest extends PHPUnit_Framework_TestCase
public function testPrintoutNoOutputWithCustomLevel() public function testPrintoutNoOutputWithCustomLevel()
{ {
$log = new XMPPHP_Log(true, XMPPHP_Log::LEVEL_INFO); $log = new XMPPHP_Log(true, XMPPHP_Log::LEVEL_INFO);
$msg = 'I am a test log message'; $msg = 'I am a test log message';
ob_start(); ob_start();
@ -72,7 +105,6 @@ class XMPPHP_LogTest extends PHPUnit_Framework_TestCase
public function testPrintoutOutputWithCustomLevel() public function testPrintoutOutputWithCustomLevel()
{ {
$log = new XMPPHP_Log(true, XMPPHP_Log::LEVEL_INFO); $log = new XMPPHP_Log(true, XMPPHP_Log::LEVEL_INFO);
$msg = 'I am a test log message'; $msg = 'I am a test log message';
ob_start(); ob_start();
@ -85,7 +117,6 @@ class XMPPHP_LogTest extends PHPUnit_Framework_TestCase
public function testExplicitPrintout() public function testExplicitPrintout()
{ {
$log = new XMPPHP_Log(false); $log = new XMPPHP_Log(false);
$msg = 'I am a test log message'; $msg = 'I am a test log message';
ob_start(); ob_start();
@ -98,7 +129,6 @@ class XMPPHP_LogTest extends PHPUnit_Framework_TestCase
public function testExplicitPrintoutResult() public function testExplicitPrintoutResult()
{ {
$log = new XMPPHP_Log(false); $log = new XMPPHP_Log(false);
$msg = 'I am a test log message'; $msg = 'I am a test log message';
ob_start(); ob_start();
@ -117,7 +147,6 @@ class XMPPHP_LogTest extends PHPUnit_Framework_TestCase
public function testExplicitPrintoutClear() public function testExplicitPrintoutClear()
{ {
$log = new XMPPHP_Log(false); $log = new XMPPHP_Log(false);
$msg = 'I am a test log message'; $msg = 'I am a test log message';
ob_start(); ob_start();
@ -142,7 +171,6 @@ class XMPPHP_LogTest extends PHPUnit_Framework_TestCase
public function testExplicitPrintoutLevel() public function testExplicitPrintoutLevel()
{ {
$log = new XMPPHP_Log(false, XMPPHP_Log::LEVEL_ERROR); $log = new XMPPHP_Log(false, XMPPHP_Log::LEVEL_ERROR);
$msg = 'I am a test log message'; $msg = 'I am a test log message';
ob_start(); ob_start();
@ -157,6 +185,4 @@ class XMPPHP_LogTest extends PHPUnit_Framework_TestCase
$this->assertSame('', $result); $this->assertSame('', $result);
} }
} }

61
tests/XMPPHP/XMLObjTest.php
View File

@ -1,39 +1,68 @@
<?php <?php
require_once dirname(dirname(dirname(__FILE__))) . '/XMPPHP/XMLObj.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_XMLObj */
require_once CLASS_DIR . 'XMPPHP' . DIRECTORY_SEPARATOR . 'XMLObj.php';
/**
* XMPPHP XMLObjectTest
*
* @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
* @version $Id$
*/
class XMPPHP_XMLObjTest extends PHPUnit_Framework_TestCase class XMPPHP_XMLObjTest extends PHPUnit_Framework_TestCase
{ {
public function testToStringNameNamespace() public function testToStringNameNamespace()
{ {
$xmlobj = new XMPPHP_XMLObj('testname', 'testNameSpace'); $xmlobj = new XMPPHP_XMLObj('testname', 'testNameSpace');
$expected = '<testname xmlns="testNameSpace"></testname>';
$expected = "<testname xmlns='testNameSpace' ></testname>";
$result = $xmlobj->toString(); $result = $xmlobj->toString();
$this->assertSame($expected, $result); $this->assertSame($expected, $result);
} }
public function testToStringNameNamespaceAttr() public function testToStringNameNamespaceAttr()
{ {
$xmlobj = new XMPPHP_XMLObj('testName', 'testNameSpace', array('attr1' => 'valA', 'attr2' => 'valB')); $xmlobj = new XMPPHP_XMLObj('testName', 'testNameSpace', array('attr1' => 'valA', 'attr2' => 'valB'));
$expected = '<testname xmlns="testNameSpace" attr1="valA" attr2="valB"></testname>';
$expected = "<testname xmlns='testNameSpace' attr1='valA' attr2='valB' ></testname>";
$result = $xmlobj->toString(); $result = $xmlobj->toString();
$this->assertSame($expected, $result); $this->assertSame($expected, $result);
} }
public function testToStringNameNamespaceData() public function testToStringNameNamespaceData()
{ {
$xmlobj = new XMPPHP_XMLObj('testName', 'testNameSpace', array(), 'I am test data'); $xmlobj = new XMPPHP_XMLObj('testName', 'testNameSpace', array(), 'I am test data');
$expected = '<testname xmlns="testNameSpace">I am test data</testname>';
$expected = "<testname xmlns='testNameSpace' >I am test data</testname>";
$result = $xmlobj->toString(); $result = $xmlobj->toString();
$this->assertSame($expected, $result); $this->assertSame($expected, $result);
} }
@ -42,12 +71,8 @@ class XMPPHP_XMLObjTest extends PHPUnit_Framework_TestCase
$xmlobj = new XMPPHP_XMLObj('testName', 'testNameSpace'); $xmlobj = new XMPPHP_XMLObj('testName', 'testNameSpace');
$sub1 = new XMPPHP_XMLObj('subName', 'subNameSpace'); $sub1 = new XMPPHP_XMLObj('subName', 'subNameSpace');
$xmlobj->subs = array($sub1); $xmlobj->subs = array($sub1);
$expected = '<testname xmlns="testNameSpace"><subname xmlns="subNameSpace"></subname></testname>';
$expected = "<testname xmlns='testNameSpace' ><subname xmlns='subNameSpace' ></subname></testname>";
$result = $xmlobj->toString(); $result = $xmlobj->toString();
$this->assertSame($expected, $result); $this->assertSame($expected, $result);
} }
} }

40
tests/XMPPHP/XMPPTest.php
View File

@ -1,7 +1,45 @@
<?php <?php
require_once dirname(dirname(dirname(__FILE__))) . '/XMPPHP/XMPP.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 */
require_once CLASS_DIR . 'XMPPHP' . DIRECTORY_SEPARATOR . 'XMPP.php';
/**
* XMPPHP XMPPTest
*
* @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
* @version $Id$
*/
class XMPPHP_XMPPTest extends PHPUnit_Framework_TestCase class XMPPHP_XMPPTest extends PHPUnit_Framework_TestCase
{ {
public function testConnectException() public function testConnectException()