MDL-20700 coding style cleanup - cvs keywords removed, closign php tag removed, trail...
[moodle.git] / lib / jabber / XMPP / XMPP.php
CommitLineData
838a8eb1 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 */
29require_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 */
41class 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 $to = htmlspecialchars($to);
148 $body = htmlspecialchars($body);
149 $subject = htmlspecialchars($subject);
150
151 $out = "<message from='{$this->fulljid}' to='$to' type='$type'>";
152 if($subject) $out .= "<subject>$subject</subject>";
153 $out .= "<body>$body</body>";
154 if($payload) $out .= $payload;
155 $out .= "</message>";
156
157 $this->send($out);
158 }
159
160 /**
161 * Set Presence
162 *
163 * @param string $status
164 * @param string $show
165 * @param string $to
166 */
167 public function presence($status = null, $show = 'available', $to = null, $type='available') {
168 if($type == 'available') $type = '';
169 $to = htmlspecialchars($to);
170 $status = htmlspecialchars($status);
171 if($show == 'unavailable') $type = 'unavailable';
172
173 $out = "<presence";
174 if($to) $out .= " to='$to'";
175 if($type) $out .= " type='$type'";
176 if($show == 'available' and !$status) {
177 $out .= "/>";
178 } else {
179 $out .= ">";
180 if($show != 'available') $out .= "<show>$show</show>";
181 if($status) $out .= "<status>$status</status>";
182 $out .= "</presence>";
183 }
184
185 $this->send($out);
186 }
187
188 /**
189 * Message handler
190 *
191 * @param string $xml
192 */
193 public function message_handler($xml) {
194 if(isset($xml->attrs['type'])) {
195 $payload['type'] = $xml->attrs['type'];
196 } else {
197 $payload['type'] = 'chat';
198 }
199 $payload['from'] = $xml->attrs['from'];
200 $payload['body'] = $xml->sub('body')->data;
201 $this->log->log("Message: {$xml->sub('body')->data}", XMPPHP_Log::LEVEL_DEBUG);
202 $this->event('message', $payload);
203 }
204
205 /**
206 * Presence handler
207 *
208 * @param string $xml
209 */
210 public function presence_handler($xml) {
211 $payload['type'] = (isset($xml->attrs['type'])) ? $xml->attrs['type'] : 'available';
212 $payload['show'] = (isset($xml->sub('show')->data)) ? $xml->sub('show')->data : $payload['type'];
213 $payload['from'] = $xml->attrs['from'];
214 $payload['status'] = (isset($xml->sub('status')->data)) ? $xml->sub('status')->data : '';
215 $this->log->log("Presence: {$payload['from']} [{$payload['show']}] {$payload['status']}", XMPPHP_Log::LEVEL_DEBUG);
216 if($xml->attrs['type'] == 'subscribe') {
217 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}' />");
218 $this->event('subscription_requested', $payload);
219 } elseif($xml->attrs['type'] == 'subscribed') {
220 $this->event('subscription_accepted', $payload);
221 } else {
222 $this->event('presence', $payload);
223 }
224 }
225
226 /**
227 * Features handler
228 *
229 * @param string $xml
230 */
231 protected function features_handler($xml) {
232 if($xml->hasSub('starttls') and $this->use_encryption) {
233 $this->send("<starttls xmlns='urn:ietf:params:xml:ns:xmpp-tls'><required /></starttls>");
234 } elseif($xml->hasSub('bind')) {
235 $id = $this->getId();
236 $this->addIdHandler($id, 'resource_bind_handler');
237 $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>");
238 } else {
239 $this->log->log("Attempting Auth...");
240 $this->send("<auth xmlns='urn:ietf:params:xml:ns:xmpp-sasl' mechanism='PLAIN'>" . base64_encode("\x00" . $this->user . "\x00" . $this->password) . "</auth>");
241 }
242 }
243
244 /**
245 * SASL success handler
246 *
247 * @param string $xml
248 */
249 protected function sasl_success_handler($xml) {
250 $this->log->log("Auth success!");
251 $this->authed = true;
252 $this->reset();
253 }
254
255 /**
256 * SASL feature handler
257 *
258 * @param string $xml
259 */
260 protected function sasl_failure_handler($xml) {
261 $this->log->log("Auth failed!", XMPPHP_Log::LEVEL_ERROR);
262 $this->disconnect();
263
264 throw new XMPPHP_Exception('Auth failed!');
265 }
266
267 /**
268 * Resource bind handler
269 *
270 * @param string $xml
271 */
272 protected function resource_bind_handler($xml) {
273 if($xml->attrs['type'] == 'result') {
274 $this->log->log("Bound to " . $xml->sub('bind')->sub('jid')->data);
275 $this->fulljid = $xml->sub('bind')->sub('jid')->data;
276 }
277 $id = $this->getId();
278 $this->addIdHandler($id, 'session_start_handler');
279 $this->send("<iq xmlns='jabber:client' type='set' id='$id'><session xmlns='urn:ietf:params:xml:ns:xmpp-session' /></iq>");
280 }
281
282 /**
283 * Retrieves the roster
284 *
285 */
286 public function getRoster() {
287 $id = $this->getID();
288 $this->addIdHandler($id, 'roster_get_handler');
289 $this->send("<iq xmlns='jabber:client' type='get' id='$id'><query xmlns='jabber:iq:roster' /></iq>");
290 }
291
292 /**
293 * Roster retrieval handler
294 *
295 * @param string $xml
296 */
297 protected function roster_get_handler($xml) {
298 // TODO: make this work
299 }
300
301 /**
302 * Session start handler
303 *
304 * @param string $xml
305 */
306 protected function session_start_handler($xml) {
307 $this->log->log("Session started");
308 $this->event('session_start');
309 }
310
311 /**
312 * TLS proceed handler
313 *
314 * @param string $xml
315 */
316 protected function tls_proceed_handler($xml) {
317 $this->log->log("Starting TLS encryption");
318 stream_socket_enable_crypto($this->socket, true, STREAM_CRYPTO_METHOD_SSLv23_CLIENT);
319 $this->reset();
320 }
321}