extlib/XMPPHP/XMPP.php

   1 <?php
   2 /**
   3  * XMPPHP: The PHP XMPP Library
   4  * Copyright (C) 2008  Nathanael C. Fritz
   5  * This file is part of SleekXMPP.
   6  *
   7  * XMPPHP is free software; you can redistribute it and/or modify
   8  * it under the terms of the GNU General Public License as published by
   9  * the Free Software Foundation; either version 2 of the License, or
  10  * (at your option) any later version.
  11  *
  12  * XMPPHP is distributed in the hope that it will be useful,
  13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  15  * GNU General Public License for more details.
  16  *
  17  * You should have received a copy of the GNU General Public License
  18  * along with XMPPHP; if not, write to the Free Software
  19  * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
  20  *
  21  * @category   xmpphp
  22  * @package     XMPPHP
  23  * @author       Nathanael C. Fritz <JID: fritzy@netflint.net>
  24  * @author       Stephan Wentz <JID: stephan@jabber.wentz.it>
  25  * @copyright  2008 Nathanael C. Fritz
  26  */
  27
  28 /** XMPPHP_XMLStream */
  29 require_once "XMLStream.php";
  30
  31 /**
  32  * XMPPHP Main Class
  33  *
  34  * @category   xmpphp
  35  * @package     XMPPHP
  36  * @author       Nathanael C. Fritz <JID: fritzy@netflint.net>
  37  * @author       Stephan Wentz <JID: stephan@jabber.wentz.it>
  38  * @copyright  2008 Nathanael C. Fritz
  39  * @version     $Id$
  40  */
  41 class XMPPHP_XMPP extends XMPPHP_XMLStream {
  42         /**
  43          * @var string
  44          */
  45         protected $server;
  46
  47         /**
  48          * @var string
  49          */
  50         protected $user;
  51
  52         /**
  53          * @var string
  54          */
  55         protected $password;
  56
  57         /**
  58          * @var string
  59          */
  60         protected $resource;
  61
  62         /**
  63          * @var string
  64          */
  65         protected $fulljid;
  66
  67         /**
  68          * @var string
  69          */
  70         protected $basejid;
  71
  72         /**
  73          * @var boolean
  74          */
  75         protected $authed = false;
  76
  77         /**
  78          * @var boolean
  79          */
  80         protected $auto_subscribe = false;
  81
  82         /**
  83          * @var boolean
  84          */
  85         protected $use_encryption = true;
  86
  87         /**
  88          * Constructor
  89          *
  90          * @param string  $host
  91          * @param integer $port
  92          * @param string  $user
  93          * @param string  $password
  94          * @param string  $resource
  95          * @param string  $server
  96          * @param boolean $printlog
  97          * @param string  $loglevel
  98          */
  99         public function __construct($host, $port, $user, $password, $resource, $server = null, $printlog = false, $loglevel = null) {
 100                 parent::__construct($host, $port, $printlog, $loglevel);
 101
 102                 $this->user      = $user;
 103                 $this->password = $password;
 104                 $this->resource = $resource;
 105                 if(!$server) $server = $host;
 106                 $this->basejid = $this->user . '@' . $this->host;
 107
 108                 $this->stream_start = '<stream:stream to="' . $server . '" xmlns:stream="http://etherx.jabber.org/streams" xmlns="jabber:client" version="1.0">';
 109                 $this->stream_end   = '</stream:stream>';
 110                 $this->default_ns   = 'jabber:client';
 111
 112                 $this->addHandler('features', 'http://etherx.jabber.org/streams', 'features_handler');
 113                 $this->addHandler('success', 'urn:ietf:params:xml:ns:xmpp-sasl', 'sasl_success_handler');
 114                 $this->addHandler('failure', 'urn:ietf:params:xml:ns:xmpp-sasl', 'sasl_failure_handler');
 115                 $this->addHandler('proceed', 'urn:ietf:params:xml:ns:xmpp-tls', 'tls_proceed_handler');
 116                 $this->addHandler('message', 'jabber:client', 'message_handler');
 117                 $this->addHandler('presence', 'jabber:client', 'presence_handler');
 118         }
 119
 120         /**
 121          * Turn encryption on/ff
 122          *
 123          * @param boolean $useEncryption
 124          */
 125         public function useEncryption($useEncryption = true) {
 126                 $this->use_encryption = $useEncryption;
 127         }
 128
 129         /**
 130          * Turn on auto-authorization of subscription requests.
 131          *
 132          * @param boolean $autoSubscribe
 133          */
 134         public function autoSubscribe($autoSubscribe = true) {
 135                 $this->auto_subscribe = $autoSubscribe;
 136         }
 137
 138         /**
 139          * Send XMPP Message
 140          *
 141          * @param string $to
 142          * @param string $body
 143          * @param string $type
 144          * @param string $subject
 145          */
 146         public function message($to, $body, $type = 'chat', $subject = null, $payload = null) {
 147
 148                 if(is_null($type))
 149                 {
 150                         $type = 'chat';
 151                 }
 152
 153                 $to       = htmlspecialchars($to);
 154                 $body   = htmlspecialchars($body);
 155                 $subject = htmlspecialchars($subject);
 156
 157                 $out = "<message from='{$this->fulljid}' to='$to' type='$type'>";
 158                 if($subject) $out .= "<subject>$subject</subject>";
 159                 $out .= "<body>$body</body>";
 160                 if($payload) $out .= $payload;
 161                 $out .= "</message>";
 162
 163                 return $this->send($out);
 164         }
 165
 166         /**
 167          * Set Presence
 168          *
 169          * @param string $status
 170          * @param string $show
 171          * @param string $to
 172          */
 173         public function presence($status = null, $show = 'available', $to = null, $type='available', $priority=NULL) {
 174                 if($type == 'available') $type = '';
 175                 $to      = htmlspecialchars($to);
 176                 $status = htmlspecialchars($status);
 177                 if($show == 'unavailable') $type = 'unavailable';
 178
 179                 $out = "<presence";
 180                 if($to) $out .= " to='$to'";
 181                 if($type) $out .= " type='$type'";
 182                 if($show == 'available' and !$status and is_null($priority)) {
 183                         $out .= "/>";
 184                 } else {
 185                         $out .= ">";
 186                         if($show != 'available') $out .= "<show>$show</show>";
 187                         if($status) $out .= "<status>$status</status>";
 188                         if(!is_null($priority)) $out .= "<priority>$priority</priority>";
 189                         $out .= "</presence>";
 190                 }
 191
 192                 return $this->send($out);
 193         }
 194
 195         /**
 196          * Message handler
 197          *
 198          * @param string $xml
 199          */
 200         public function message_handler($xml) {
 201                 if(isset($xml->attrs['type'])) {
 202                         $payload['type'] = $xml->attrs['type'];
 203                 } else {
 204                         $payload['type'] = 'chat';
 205                 }
 206                 $payload['from'] = $xml->attrs['from'];
 207                 $payload['body'] = $xml->sub('body')->data;
 208                 $payload['raw'] = $xml;
 209                 $this->log->log("Message: {$xml->sub('body')->data}", XMPPHP_Log::LEVEL_DEBUG);
 210                 $this->event('message', $payload);
 211         }
 212
 213         /**
 214          * Presence handler
 215          *
 216          * @param string $xml
 217          */
 218         public function presence_handler($xml) {
 219                 $payload['type'] = (isset($xml->attrs['type'])) ? $xml->attrs['type'] : 'available';
 220                 $payload['show'] = (isset($xml->sub('show')->data)) ? $xml->sub('show')->data : $payload['type'];
 221                 $payload['from'] = $xml->attrs['from'];
 222                 $payload['status'] = (isset($xml->sub('status')->data)) ? $xml->sub('status')->data : '';
 223                 $payload['raw'] = $xml;
 224                 $this->log->log("Presence: {$payload['from']} [{$payload['show']}] {$payload['status']}",  XMPPHP_Log::LEVEL_DEBUG);
 225                 if(array_key_exists('type', $xml->attrs) and $xml->attrs['type'] == 'subscribe') {
 226                         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}' />");
 227                         $this->event('subscription_requested', $payload);
 228                 } elseif(array_key_exists('type', $xml->attrs) and $xml->attrs['type'] == 'subscribed') {
 229                         $this->event('subscription_accepted', $payload);
 230                 } else {
 231                         $this->event('presence', $payload);
 232                 }
 233         }
 234
 235         /**
 236          * Features handler
 237          *
 238          * @param string $xml
 239          */
 240         protected function features_handler($xml) {
 241                 if($xml->hasSub('starttls') and $this->use_encryption) {
 242                         $this->send("<starttls xmlns='urn:ietf:params:xml:ns:xmpp-tls'><required /></starttls>");
 243                 } elseif($xml->hasSub('bind')) {
 244                         $id = $this->getId();
 245                         $this->addIdHandler($id, 'resource_bind_handler');
 246                         $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>");
 247                 } else {
 248                         $this->log->log("Attempting Auth...");
 249                         $this->send("<auth xmlns='urn:ietf:params:xml:ns:xmpp-sasl' mechanism='PLAIN'>" . base64_encode("\x00" . $this->user . "\x00" . $this->password) . "</auth>");
 250                 }
 251         }
 252
 253         /**
 254          * SASL success handler
 255          *
 256          * @param string $xml
 257          */
 258         protected function sasl_success_handler($xml) {
 259                 $this->log->log("Auth success!");
 260                 $this->authed = true;
 261                 $this->reset();
 262         }
 263
 264         /**
 265          * SASL feature handler
 266          *
 267          * @param string $xml
 268          */
 269         protected function sasl_failure_handler($xml) {
 270                 $this->log->log("Auth failed!",  XMPPHP_Log::LEVEL_ERROR);
 271                 $this->disconnect();
 272
 273                 throw new XMPPHP_Exception('Auth failed!');
 274         }
 275
 276         /**
 277          * Resource bind handler
 278          *
 279          * @param string $xml
 280          */
 281         protected function resource_bind_handler($xml) {
 282                 if($xml->attrs['type'] == 'result') {
 283                         $this->log->log("Bound to " . $xml->sub('bind')->sub('jid')->data);
 284                         $this->fulljid = $xml->sub('bind')->sub('jid')->data;
 285                 }
 286                 $id = $this->getId();
 287                 $this->addIdHandler($id, 'session_start_handler');
 288                 $this->send("<iq xmlns='jabber:client' type='set' id='$id'><session xmlns='urn:ietf:params:xml:ns:xmpp-session' /></iq>");
 289         }
 290
 291         /**
 292         * Retrieves the roster
 293         *
 294         */
 295         public function getRoster() {
 296                 $id = $this->getID();
 297                 $this->addIdHandler($id, 'roster_get_handler');
 298                 $this->send("<iq xmlns='jabber:client' type='get' id='$id'><query xmlns='jabber:iq:roster' /></iq>");
 299         }
 300
 301         /**
 302         * Roster retrieval handler
 303         *
 304         * @param string $xml
 305         */
 306         protected function roster_get_handler($xml) {
 307                 // TODO: make this work
 308         }
 309
 310         /**
 311          * Session start handler
 312          *
 313          * @param string $xml
 314          */
 315         protected function session_start_handler($xml) {
 316                 $this->log->log("Session started");
 317                 $this->event('session_start');
 318         }
 319
 320         /**
 321          * TLS proceed handler
 322          *
 323          * @param string $xml
 324          */
 325         protected function tls_proceed_handler($xml) {
 326                 $this->log->log("Starting TLS encryption");
 327                 stream_socket_enable_crypto($this->socket, true, STREAM_CRYPTO_METHOD_SSLv23_CLIENT);
 328                 $this->reset();
 329         }
 330 }