moodle/moodle
3
0
Fork 0
mirror of https://github.com/moodle/moodle.git synced 2025-08-03 16:13:28 +02:00
Code Issues Projects Releases Packages Wiki Activity Actions

MDL-16500 Removed the old Jabber class from the module and moved to a new one called xmpphp in core libraries

Browse source 
Also cleaned up some notices in message/edit.php
This commit is contained in:
moodler 2008-09-15 05:55:58 +00:00
parent fa7bec7bef
commit 838a8eb146
17 changed files with 1378 additions and 3391 deletions
Download patch file Download diff file Expand all files Collapse all files

39
lib/jabber/XMPP/Exception.php Executable file
View file

@ -0,0 +1,39 @@
<?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>
* @copyright 2008 Nathanael C. Fritz
*/
/**
* XMPPHP Exception
*
* @category xmpphp
* @package XMPPHP
* @author Nathanael C. Fritz <JID: fritzy@netflint.net>
* @author Stephan Wentz <JID: stephan@jabber.wentz.it>
* @copyright 2008 Nathanael C. Fritz
* @version $Id$
*/
class XMPPHP_Exception extends Exception {
}

116
lib/jabber/XMPP/Log.php Normal file
View file

@ -0,0 +1,116 @@
<?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>
* @copyright 2008 Nathanael C. Fritz
*/
/**
* XMPPHP Log
*
* @package XMPPHP
* @author Nathanael C. Fritz <JID: fritzy@netflint.net>
* @author Stephan Wentz <JID: stephan@jabber.wentz.it>
* @copyright 2008 Nathanael C. Fritz
* @version $Id$
*/
class XMPPHP_Log {
const LEVEL_ERROR = 0;
const LEVEL_WARNING = 1;
const LEVEL_INFO = 2;
const LEVEL_DEBUG = 3;
const LEVEL_VERBOSE = 4;
/**
* @var array
*/
protected $data = array();
/**
* @var array
*/
protected $names = array('ERROR', 'WARNING', 'INFO', 'DEBUG', 'VERBOSE');
/**
* @var integer
*/
protected $runlevel;
/**
* @var boolean
*/
protected $printout;
/**
* Constructor
*
* @param boolean $printout
* @param string $runlevel
*/
public function __construct($printout = false, $runlevel = self::LEVEL_INFO) {
$this->printout = (boolean)$printout;
$this->runlevel = (int)$runlevel;
}
/**
* Add a message to the log data array
* If printout in this instance is set to true, directly output the message
*
* @param string $msg
* @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.
* Log will be cleared if $clear = true
*
* @param boolean $clear
* @param integer $runlevel
*/
public function printout($clear = true, $runlevel = null) {
if($runlevel === null) {
$runlevel = $this->runlevel;
}
foreach($this->data as $data) {
if($runlevel <= $data[0]) {
$this->writeLine($data[1], $runlevel, $data[2]);
}
}
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";
}
}

155
lib/jabber/XMPP/XMLObj.php Normal file
View file

@ -0,0 +1,155 @@
<?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>
* @copyright 2008 Nathanael C. Fritz
*/
/**
* XMPPHP XML Object
*
* @category xmpphp
* @package XMPPHP
* @author Nathanael C. Fritz <JID: fritzy@netflint.net>
* @author Stephan Wentz <JID: stephan@jabber.wentz.it>
* @copyright 2008 Nathanael C. Fritz
* @version $Id$
*/
class XMPPHP_XMLObj {
/**
* Tag name
*
* @var string
*/
public $name;
/**
* Namespace
*
* @var string
*/
public $ns;
/**
* Attributes
*
* @var array
*/
public $attrs = array();
/**
* Subs?
*
* @var array
*/
public $subs = array();
/**
* Node data
*
* @var string
*/
public $data = '';
/**
* Constructor
*
* @param string $name
* @param string $ns
* @param array $attrs
* @param string $data
*/
public function __construct($name, $ns = '', $attrs = array(), $data = '') {
$this->name = strtolower($name);
$this->ns = $ns;
if(is_array($attrs) && count($attrs)) {
foreach($attrs as $key => $value) {
$this->attrs[strtolower($key)] = $value;
}
}
$this->data = $data;
}
/**
* Dump this XML Object to output.
*
* @param integer $depth
*/
public function printObj($depth = 0) {
print str_repeat("\t", $depth) . $this->name . " " . $this->ns . ' ' . $this->data;
print "\n";
foreach($this->subs as $sub) {
$sub->printObj($depth + 1);
}
}
/**
* Return this XML Object in xml notation
*
* @param string $str
*/
public function toString($str = '') {
$str .= "<{$this->name} xmlns='{$this->ns}' ";
foreach($this->attrs as $key => $value) {
if($key != 'xmlns') {
$value = htmlspecialchars($value);
$str .= "$key='$value' ";
}
}
$str .= ">";
foreach($this->subs as $sub) {
$str .= $sub->toString();
}
$body = htmlspecialchars($this->data);
$str .= "$body</{$this->name}>";
return $str;
}
/**
* Has this XML Object the given sub?
*
* @param string $name
* @return boolean
*/
public function hasSub($name) {
foreach($this->subs as $sub) {
if($sub->name == $name) return true;
}
return false;
}
/**
* Return a sub
*
* @param string $name
* @param string $attrs
* @param string $ns
*/
public function sub($name, $attrs = null, $ns = null) {
foreach($this->subs as $sub) {
if($sub->name == $name) {
return $sub;
}
}
}
}

604
lib/jabber/XMPP/XMLStream.php Normal file
View file

@ -0,0 +1,604 @@
<?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>
* @copyright 2008 Nathanael C. Fritz
*/
/** XMPPHP_Exception */
require_once 'Exception.php';
/** XMPPHP_XMLObj */
require_once 'XMLObj.php';
/** XMPPHP_Log */
require_once 'Log.php';
/**
* XMPPHP XML Stream
*
* @category xmpphp
* @package XMPPHP
* @author Nathanael C. Fritz <JID: fritzy@netflint.net>
* @author Stephan Wentz <JID: stephan@jabber.wentz.it>
* @copyright 2008 Nathanael C. Fritz
* @version $Id$
*/
class XMPPHP_XMLStream {
/**
* @var resource
*/
protected $socket;
/**
* @var resource
*/
protected $parser;
/**
* @var string
*/
protected $buffer;
/**
* @var integer
*/
protected $xml_depth = 0;
/**
* @var string
*/
protected $host;
/**
* @var integer
*/
protected $port;
/**
* @var string
*/
protected $stream_start = '<stream>';
/**
* @var string
*/
protected $stream_end = '</stream>';
/**
* @var boolean
*/
protected $disconnected = false;
/**
* @var boolean
*/
protected $sent_disconnect = false;
/**
* @var array
*/
protected $ns_map = array();
/**
* @var array
*/
protected $current_ns = array();
/**
* @var array
*/
protected $xmlobj = null;
/**
* @var array
*/
protected $nshandlers = array();
/**
* @var array
*/
protected $idhandlers = array();
/**
* @var array
*/
protected $eventhandlers = array();
/**
* @var integer
*/
protected $lastid = 0;
/**
* @var string
*/
protected $default_ns;
/**
* @var string
*/
protected $until = '';
/**
* @var array
*/
protected $until_happened = false;
/**
* @var array
*/
protected $until_payload = array();
/**
* @var XMPPHP_Log
*/
protected $log;
/**
* @var boolean
*/
protected $reconnect = true;
/**
* @var boolean
*/
protected $been_reset = false;
/**
* @var boolean
*/
protected $is_server;
/**
* @var float
*/
protected $last_send = 0;
/**
* Constructor
*
* @param string $host
* @param string $port
* @param boolean $printlog
* @param string $loglevel
* @param boolean $is_server
*/
public function __construct($host = null, $port = null, $printlog = false, $loglevel = null, $is_server = false) {
$this->reconnect = !$is_server;
$this->is_server = $is_server;
$this->host = $host;
$this->port = $port;
$this->setupParser();
$this->log = new XMPPHP_Log($printlog, $loglevel);
}
/**
* Destructor
* Cleanup connection
*/
public function __destruct() {
if(!$this->disconnected && $this->socket) {
$this->disconnect();
}
}
/**
* Return the log instance
*
* @return XMPPHP_Log
*/
public function getLog() {
return $this->log;
}
/**
* Get next ID
*
* @return integer
*/
public function getId() {
$this->lastid++;
return $this->lastid;
}
/**
* Add ID Handler
*
* @param integer $id
* @param string $pointer
* @param string $obj
*/
public function addIdHandler($id, $pointer, $obj = null) {
$this->idhandlers[$id] = array($pointer, $obj);
}
/**
* Add Handler
*
* @param integer $id
* @param string $ns
* @param string $pointer
* @param string $obj
* @param integer $depth
*/
public function addHandler($name, $ns, $pointer, $obj = null, $depth = 1) {
$this->nshandlers[] = array($name,$ns,$pointer,$obj, $depth);
}
/**
* Add Evemt Handler
*
* @param integer $id
* @param string $pointer
* @param string $obj
*/
public function addEventHandler($name, $pointer, $obj) {
$this->eventhanders[] = array($name, $pointer, $obj);
}
/**
* Connect to XMPP Host
*
* @param integer $timeout
* @param boolean $persistent
* @param boolean $sendinit
*/
public function connect($timeout = 30, $persistent = false, $sendinit = true) {
$this->disconnected = false;
$this->sent_disconnect = false;
if($persistent) {
$conflag = STREAM_CLIENT_CONNECT | STREAM_CLIENT_PERSISTENT;
} else {
$conflag = STREAM_CLIENT_CONNECT;
}
$this->log->log("Connecting to tcp://{$this->host}:{$this->port}");
try {
$this->socket = @stream_socket_client("tcp://{$this->host}:{$this->port}", $errno, $errstr, $timeout, $conflag);
} catch (Exception $e) {
throw new XMPPHP_Exception($e->getMessage());
}
if(!$this->socket) {
$this->log->log("Could not connect.", XMPPHP_Log::LEVEL_ERROR);
$this->disconnected = true;
throw new XMPPHP_Exception('Could not connect.');
}
stream_set_blocking($this->socket, 1);
if($sendinit) $this->send($this->stream_start);
}
/**
* Reconnect XMPP Host
*/
public function doReconnect() {
if(!$this->is_server) {
$this->log->log("Reconnecting...", XMPPHP_Log::LEVEL_WARNING);
$this->connect(30, false, false);
$this->reset();
}
}
/**
* Disconnect from XMPP Host
*/
public function disconnect() {
$this->log->log("Disconnecting...", XMPPHP_Log::LEVEL_VERBOSE);
$this->reconnect = false;
$this->send($this->stream_end);
$this->sent_disconnect = true;
$this->processUntil('end_stream', 5);
$this->disconnected = true;
}
/**
* Are we are disconnected?
*
* @return boolean
*/
public function isDisconnected() {
return $this->disconnected;
}
private function __process() {
$read = array($this->socket);
$write = null;
$except = null;
$updated = @stream_select($read, $write, $except, 1);
if ($updated > 0) {
$buff = @fread($this->socket, 1024);
if(!$buff) {
if($this->reconnect) {
$this->doReconnect();
} else {
fclose($this->socket);
return false;
}
}
$this->log->log("RECV: $buff", XMPPHP_Log::LEVEL_VERBOSE);
xml_parse($this->parser, $buff, false);
}
}
/**
* Process
*
* @return string
*/
public function process() {
$updated = '';
while(!$this->disconnect) {
$this->__process();
}
}
/**
* Process until a timeout occurs
*
* @param integer $timeout
* @return string
*/
public function processTime($timeout = -1) {
$start = time();
$updated = '';
while(!$this->disconnected and ($timeout == -1 or time() - $start < $timeout)) {
$this->__process();
}
}
/**
* Process until a specified event or a timeout occurs
*
* @param string|array $event
* @param integer $timeout
* @return string
*/
public function processUntil($event, $timeout=-1) {
$start = time();
if(!is_array($event)) $event = array($event);
$this->until[] = $event;
end($this->until);
$event_key = key($this->until);
reset($this->until);
$updated = '';
while(!$this->disconnected and $this->until[$event_key] and (time() - $start < $timeout or $timeout == -1)) {
$this->__process();
}
if(array_key_exists($event_key, $this->until_payload)) {
$payload = $this->until_payload[$event_key];
} else {
$payload = array();
}
unset($this->until_payload[$event_key]);
return $payload;
}
/**
* Obsolete?
*/
public function Xapply_socket($socket) {
$this->socket = $socket;
}
/**
* XML start callback
*
* @see xml_set_element_handler
*
* @param resource $parser
* @param string $name
*/
public function startXML($parser, $name, $attr) {
if($this->been_reset) {
$this->been_reset = false;
$this->xml_depth = 0;
}
$this->xml_depth++;
if(array_key_exists('XMLNS', $attr)) {
$this->current_ns[$this->xml_depth] = $attr['XMLNS'];
} else {
$this->current_ns[$this->xml_depth] = $this->current_ns[$this->xml_depth - 1];
if(!$this->current_ns[$this->xml_depth]) $this->current_ns[$this->xml_depth] = $this->default_ns;
}
$ns = $this->current_ns[$this->xml_depth];
foreach($attr as $key => $value) {
if(strstr($key, ":")) {
$key = explode(':', $key);
$key = $key[1];
$this->ns_map[$key] = $value;
}
}
if(!strstr($name, ":") === false)
{
$name = explode(':', $name);
$ns = $this->ns_map[$name[0]];
$name = $name[1];
}
$obj = new XMPPHP_XMLObj($name, $ns, $attr);
if($this->xml_depth > 1) {
$this->xmlobj[$this->xml_depth - 1]->subs[] = $obj;
}
$this->xmlobj[$this->xml_depth] = $obj;
}
/**
* XML end callback
*
* @see xml_set_element_handler
*
* @param resource $parser
* @param string $name
*/
public function endXML($parser, $name) {
#$this->log->log("Ending $name", XMPPHP_Log::LEVEL_DEBUG);
#print "$name\n";
if($this->been_reset) {
$this->been_reset = false;
$this->xml_depth = 0;
}
$this->xml_depth--;
if($this->xml_depth == 1) {
#clean-up old objects
$found = false;
foreach($this->nshandlers as $handler) {
if($handler[4] != 1 and $this->xmlobj[2]->hasSub($handler[0])) {
$searchxml = $this->xmlobj[2]->sub($handler[0]);
} elseif(is_array($this->xmlobj) and array_key_exists(2, $this->xmlobj)) {
$searchxml = $this->xmlobj[2];
}
if($searchxml !== null and $searchxml->name == $handler[0] and ($searchxml->ns == $handler[1] or (!$handler[1] and $searchxml->ns == $this->default_ns))) {
if($handler[3] === null) $handler[3] = $this;
$this->log->log("Calling {$handler[2]}", XMPPHP_Log::LEVEL_DEBUG);
$handler[3]->$handler[2]($this->xmlobj[2]);
}
}
foreach($this->idhandlers as $id => $handler) {
if(array_key_exists('id', $this->xmlobj[2]->attrs) and $this->xmlobj[2]->attrs['id'] == $id) {
if($handler[1] === null) $handler[1] = $this;
$handler[1]->$handler[0]($this->xmlobj[2]);
#id handlers are only used once
unset($this->idhandlers[$id]);
break;
}
}
if(is_array($this->xmlobj)) {
$this->xmlobj = array_slice($this->xmlobj, 0, 1);
if(isset($this->xmlobj[0]) && $this->xmlobj[0] instanceof XMPPHP_XMLObj) {
$this->xmlobj[0]->subs = null;
}
}
unset($this->xmlobj[2]);
}
if($this->xml_depth == 0 and !$this->been_reset) {
if(!$this->disconnected) {
if(!$this->sent_disconnect) {
$this->send($this->stream_end);
}
$this->disconnected = true;
$this->sent_disconnect = true;
fclose($this->socket);
if($this->reconnect) {
$this->doReconnect();
}
}
$this->event('end_stream');
}
}
/**
* XML character callback
* @see xml_set_character_data_handler
*
* @param resource $parser
* @param string $data
*/
public function charXML($parser, $data) {
if(array_key_exists($this->xml_depth, $this->xmlobj)) {
$this->xmlobj[$this->xml_depth]->data .= $data;
}
}
/**
* Event?
*
* @param string $name
* @param string $payload
*/
public function event($name, $payload = null) {
$this->log->log("EVENT: $name", XMPPHP_Log::LEVEL_DEBUG);
foreach($this->eventhandlers as $handler) {
if($name == $handler[0]) {
if($handler[2] === null) {
$handler[2] = $this;
}
$handler[2]->$handler[1]($payload);
}
}
foreach($this->until as $key => $until) {
if(is_array($until)) {
if(in_array($name, $until)) {
$this->until_payload[$key][] = array($name, $payload);
$this->until[$key] = false;
}
}
}
}
/**
* Read from socket
*/
public function read() {
$buff = @fread($this->socket, 1024);
if(!$buff) {
if($this->reconnect) {
$this->doReconnect();
} else {
fclose($this->socket);
return false;
}
}
$this->log->log("RECV: $buff", XMPPHP_Log::LEVEL_VERBOSE);
xml_parse($this->parser, $buff, false);
}
/**
* Send to socket
*
* @param string $msg
*/
public function send($msg, $rec=false) {
if($this->time() - $this->last_send < .1) {
usleep(100000);
}
$wait = true;
while($wait) {
$read = null;
$write = array($this->socket);
$except = null;
$select = @stream_select($read, $write, $except, 0, 0);
if($select === False) {
$this->doReconnect();
return false;
} elseif ($select > 0) {
$wait = false;
} else {
usleep(100000);
//$this->processTime(.25);
}
}
$sentbytes = @fwrite($this->socket, $msg, 1024);
$this->last_send = $this->time();
$this->log->log("SENT: " . mb_substr($msg, 0, $sentbytes, '8bit'), XMPPHP_Log::LEVEL_VERBOSE);
if($sentbytes === FALSE) {
$this->doReconnect();
} elseif ($sentbytes != mb_strlen($msg, '8bit')) {
$this->send(mb_substr($msg, $sentbytes, mb_strlen($msg, '8bit'), '8bit'), true);
}
}
public function time() {
list($usec, $sec) = explode(" ", microtime());
return (float)$sec + (float)$usec;
}
/**
* Reset connection
*/
public function reset() {
$this->xml_depth = 0;
unset($this->xmlobj);
$this->xmlobj = array();
$this->setupParser();
if(!$this->is_server) {
$this->send($this->stream_start);
}
$this->been_reset = true;
}
/**
* Setup the XML parser
*/
public function setupParser() {
$this->parser = xml_parser_create('UTF-8');
xml_parser_set_option($this->parser, XML_OPTION_SKIP_WHITE, 1);
xml_parser_set_option($this->parser, XML_OPTION_TARGET_ENCODING, 'UTF-8');
xml_set_object($this->parser, $this);
xml_set_element_handler($this->parser, 'startXML', 'endXML');
xml_set_character_data_handler($this->parser, 'charXML');
}
}

321
lib/jabber/XMPP/XMPP.php Normal file
View file

@ -0,0 +1,321 @@
<?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>
* @copyright 2008 Nathanael C. Fritz
*/
/** XMPPHP_XMLStream */
require_once "XMLStream.php";
/**
* XMPPHP Main Class
*
* @category xmpphp
* @package XMPPHP
* @author Nathanael C. Fritz <JID: fritzy@netflint.net>
* @author Stephan Wentz <JID: stephan@jabber.wentz.it>
* @copyright 2008 Nathanael C. Fritz
* @version $Id$
*/
class XMPPHP_XMPP extends XMPPHP_XMLStream {
/**
* @var string
*/
protected $server;
/**
* @var string
*/
protected $user;
/**
* @var string
*/
protected $password;
/**
* @var string
*/
protected $resource;
/**
* @var string
*/
protected $fulljid;
/**
* @var string
*/
protected $basejid;
/**
* @var boolean
*/
protected $authed = false;
/**
* @var boolean
*/
protected $auto_subscribe = false;
/**
* @var boolean
*/
protected $use_encryption = true;
/**
* Constructor
*
* @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;
$this->password = $password;
$this->resource = $resource;
if(!$server) $server = $host;
$this->basejid = $this->user . '@' . $this->host;
$this->stream_start = '<stream:stream to="' . $server . '" xmlns:stream="http://etherx.jabber.org/streams" xmlns="jabber:client" version="1.0">';
$this->stream_end = '</stream:stream>';
$this->default_ns = 'jabber:client';
$this->addHandler('features', 'http://etherx.jabber.org/streams', 'features_handler');
$this->addHandler('success', 'urn:ietf:params:xml:ns:xmpp-sasl', 'sasl_success_handler');
$this->addHandler('failure', 'urn:ietf:params:xml:ns:xmpp-sasl', 'sasl_failure_handler');
$this->addHandler('proceed', 'urn:ietf:params:xml:ns:xmpp-tls', 'tls_proceed_handler');
$this->addHandler('message', 'jabber:client', 'message_handler');
$this->addHandler('presence', 'jabber:client', 'presence_handler');
}
/**
* Turn encryption on/ff
*
* @param boolean $useEncryption
*/
public function useEncryption($useEncryption = true) {
$this->use_encryption = $useEncryption;
}
/**
* Turn on auto-authorization of subscription requests.
*
* @param boolean $autoSubscribe
*/
public function autoSubscribe($autoSubscribe = true) {
$this->auto_subscribe = $autoSubscribe;
}
/**
* Send XMPP Message
*
* @param string $to
* @param string $body
* @param string $type
* @param string $subject
*/
public function message($to, $body, $type = 'chat', $subject = null, $payload = null) {
$to = htmlspecialchars($to);
$body = htmlspecialchars($body);
$subject = htmlspecialchars($subject);
$out = "<message from='{$this->fulljid}' to='$to' type='$type'>";
if($subject) $out .= "<subject>$subject</subject>";
$out .= "<body>$body</body>";
if($payload) $out .= $payload;
$out .= "</message>";
$this->send($out);
}
/**
* Set Presence
*
* @param string $status
* @param string $show
* @param string $to
*/
public function presence($status = null, $show = 'available', $to = null, $type='available') {
if($type == 'available') $type = '';
$to = htmlspecialchars($to);
$status = htmlspecialchars($status);
if($show == 'unavailable') $type = 'unavailable';
$out = "<presence";
if($to) $out .= " to='$to'";
if($type) $out .= " type='$type'";
if($show == 'available' and !$status) {
$out .= "/>";
} else {
$out .= ">";
if($show != 'available') $out .= "<show>$show</show>";
if($status) $out .= "<status>$status</status>";
$out .= "</presence>";
}
$this->send($out);
}
/**
* Message handler
*
* @param string $xml
*/
public function message_handler($xml) {
if(isset($xml->attrs['type'])) {
$payload['type'] = $xml->attrs['type'];
} else {
$payload['type'] = 'chat';
}
$payload['from'] = $xml->attrs['from'];
$payload['body'] = $xml->sub('body')->data;
$this->log->log("Message: {$xml->sub('body')->data}", XMPPHP_Log::LEVEL_DEBUG);
$this->event('message', $payload);
}
/**
* Presence handler
*
* @param string $xml
*/
public function presence_handler($xml) {
$payload['type'] = (isset($xml->attrs['type'])) ? $xml->attrs['type'] : 'available';
$payload['show'] = (isset($xml->sub('show')->data)) ? $xml->sub('show')->data : $payload['type'];
$payload['from'] = $xml->attrs['from'];
$payload['status'] = (isset($xml->sub('status')->data)) ? $xml->sub('status')->data : '';
$this->log->log("Presence: {$payload['from']} [{$payload['show']}] {$payload['status']}", XMPPHP_Log::LEVEL_DEBUG);
if($xml->attrs['type'] == 'subscribe') {
if($this->auto_subscribe) $this->send("<presence type='subscribed' to='{$xml->attrs['from']}' from='{$this->fulljid}' /><presence type='subscribe' to='{$xml->attrs['from']}' from='{$this->fulljid}' />");
$this->event('subscription_requested', $payload);
} elseif($xml->attrs['type'] == 'subscribed') {
$this->event('subscription_accepted', $payload);
} else {
$this->event('presence', $payload);
}
}
/**
* 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')) {
$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...");
$this->send("<auth xmlns='urn:ietf:params:xml:ns:xmpp-sasl' mechanism='PLAIN'>" . base64_encode("\x00" . $this->user . "\x00" . $this->password) . "</auth>");
}
}
/**
* SASL success handler
*
* @param string $xml
*/
protected function sasl_success_handler($xml) {
$this->log->log("Auth success!");
$this->authed = true;
$this->reset();
}
/**
* SASL feature handler
*
* @param string $xml
*/
protected function sasl_failure_handler($xml) {
$this->log->log("Auth failed!", XMPPHP_Log::LEVEL_ERROR);
$this->disconnect();
throw new XMPPHP_Exception('Auth failed!');
}
/**
* Resource bind handler
*
* @param string $xml
*/
protected function resource_bind_handler($xml) {
if($xml->attrs['type'] == 'result') {
$this->log->log("Bound to " . $xml->sub('bind')->sub('jid')->data);
$this->fulljid = $xml->sub('bind')->sub('jid')->data;
}
$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->addIdHandler($id, 'roster_get_handler');
$this->send("<iq xmlns='jabber:client' type='get' id='$id'><query xmlns='jabber:iq:roster' /></iq>");
}
/**
* Roster retrieval handler
*
* @param string $xml
*/
protected function roster_get_handler($xml) {
// TODO: make this work
}
/**
* Session start handler
*
* @param string $xml
*/
protected function session_start_handler($xml) {
$this->log->log("Session started");
$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();
}
}

111
lib/jabber/XMPP/XMPP_Old.php Normal file
View file

@ -0,0 +1,111 @@
<?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>
* @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);
}
/**
* Override XMLStream's startXML
*
* @param parser $parser
* @param string $name
* @param array $attr
*/
protected function startXML($parser, $name, $attr) {
if($this->xml_depth == 0 and $attr['version'] != '1.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><digest>{$this->password}</digest><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');
}
}
}
?>