3 * StatusNet, the distributed open-source microblogging tool
5 * utility functions for Jabber/GTalk/XMPP messages
9 * LICENCE: This program is free software: you can redistribute it and/or modify
10 * it under the terms of the GNU Affero General Public License as published by
11 * the Free Software Foundation, either version 3 of the License, or
12 * (at your option) any later version.
14 * This program is distributed in the hope that it will be useful,
15 * but WITHOUT ANY WARRANTY; without even the implied warranty of
16 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17 * GNU Affero General Public License for more details.
19 * You should have received a copy of the GNU Affero General Public License
20 * along with this program. If not, see <http://www.gnu.org/licenses/>.
24 * @author Evan Prodromou <evan@status.net>
25 * @copyright 2008 StatusNet, Inc.
26 * @license http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
27 * @link http://status.net/
30 if (!defined('STATUSNET') && !defined('LACONICA')) {
34 require_once 'XMPPHP/XMPP.php';
37 * checks whether a string is a syntactically valid Jabber ID (JID)
39 * @param string $jid string to check
41 * @return boolean whether the string is a valid JID
44 function jabber_valid_base_jid($jid)
46 // Cheap but effective
47 return Validate::email($jid);
51 * normalizes a Jabber ID for comparison
53 * @param string $jid JID to check
55 * @return string an equivalent JID in normalized (lowercase) form
58 function jabber_normalize_jid($jid)
60 if (preg_match("/(?:([^\@]+)\@)?([^\/]+)(?:\/(.*))?$/", $jid, $matches)) {
62 $server = $matches[2];
63 return strtolower($node.'@'.$server);
70 * the JID of the Jabber daemon for this StatusNet instance
72 * @return string JID of the Jabber daemon
75 function jabber_daemon_address()
77 return common_config('xmpp', 'user') . '@' . common_config('xmpp', 'server');
80 class Sharing_XMPP extends XMPPHP_XMPP
89 * connect the configured Jabber account to the configured server
91 * @param string $resource Resource to connect (defaults to configured resource)
93 * @return XMPPHP connection to the configured server
96 function jabber_connect($resource=null)
100 $conn = new Sharing_XMPP(common_config('xmpp', 'host') ?
101 common_config('xmpp', 'host') :
102 common_config('xmpp', 'server'),
103 common_config('xmpp', 'port'),
104 common_config('xmpp', 'user'),
105 common_config('xmpp', 'password'),
106 ($resource) ? $resource :
107 common_config('xmpp', 'resource'),
108 common_config('xmpp', 'server'),
109 common_config('xmpp', 'debug') ?
111 common_config('xmpp', 'debug') ?
112 XMPPHP_Log::LEVEL_VERBOSE : null
119 $conn->autoSubscribe();
120 $conn->useEncryption(common_config('xmpp', 'encryption'));
123 $conn->connect(true); // true = persistent connection
124 } catch (XMPPHP_Exception $e) {
125 common_log(LOG_ERR, $e->getMessage());
129 $conn->processUntil('session_start');
135 * send a single notice to a given Jabber address
137 * @param string $to JID to send the notice to
138 * @param Notice $notice notice to send
140 * @return boolean success value
143 function jabber_send_notice($to, $notice)
145 $conn = jabber_connect();
149 $profile = Profile::staticGet($notice->profile_id);
151 common_log(LOG_WARNING, 'Refusing to send notice with ' .
152 'unknown profile ' . common_log_objstring($notice),
156 $msg = jabber_format_notice($profile, $notice);
157 $entry = jabber_format_entry($profile, $notice);
158 $conn->message($to, $msg, 'chat', null, $entry);
164 * extra information for XMPP messages, as defined by Twitter
166 * @param Profile $profile Profile of the sending user
167 * @param Notice $notice Notice being sent
169 * @return string Extra information (Atom, HTML, addresses) in string format
172 function jabber_format_entry($profile, $notice)
174 $entry = $notice->asAtomEntry(true, true);
176 $xs = new XMLStringer();
177 $xs->elementStart('html', array('xmlns' => 'http://jabber.org/protocol/xhtml-im'));
178 $xs->elementStart('body', array('xmlns' => 'http://www.w3.org/1999/xhtml'));
179 $xs->element('a', array('href' => $profile->profileurl),
182 if (!empty($notice->rendered)) {
183 $xs->raw($notice->rendered);
185 $xs->raw(common_render_content($notice->content, $notice));
187 $xs->elementEnd('body');
188 $xs->elementEnd('html');
190 $html = $xs->getString();
192 return $html . ' ' . $entry;
196 * sends a single text message to a given JID
198 * @param string $to JID to send the message to
199 * @param string $body body of the message
200 * @param string $type type of the message
201 * @param string $subject subject of the message
203 * @return boolean success flag
206 function jabber_send_message($to, $body, $type='chat', $subject=null)
208 $conn = jabber_connect();
212 $conn->message($to, $body, $type, $subject);
217 * sends a presence stanza on the Jabber network
219 * @param string $status current status, free-form string
220 * @param string $show structured status value
221 * @param string $to recipient of presence, null for general
222 * @param string $type type of status message, related to $show
223 * @param int $priority priority of the presence
225 * @return boolean success value
228 function jabber_send_presence($status, $show='available', $to=null,
229 $type = 'available', $priority=null)
231 $conn = jabber_connect();
235 $conn->presence($status, $show, $to, $type, $priority);
240 * sends a confirmation request to a JID
242 * @param string $code confirmation code for confirmation URL
243 * @param string $nickname nickname of confirming user
244 * @param string $address JID to send confirmation to
246 * @return boolean success flag
249 function jabber_confirm_address($code, $nickname, $address)
251 $body = 'User "' . $nickname . '" on ' . common_config('site', 'name') . ' ' .
252 'has said that your Jabber ID belongs to them. ' .
253 'If that\'s true, you can confirm by clicking on this URL: ' .
254 common_local_url('confirmaddress', array('code' => $code)) .
255 ' . (If you cannot click it, copy-and-paste it into the ' .
256 'address bar of your browser). If that user isn\'t you, ' .
257 'or if you didn\'t request this confirmation, just ignore this message.';
259 return jabber_send_message($address, $body);
263 * sends a "special" presence stanza on the Jabber network
265 * @param string $type Type of presence
266 * @param string $to JID to send presence to
267 * @param string $show show value for presence
268 * @param string $status status value for presence
270 * @return boolean success flag
272 * @see jabber_send_presence()
275 function jabber_special_presence($type, $to=null, $show=null, $status=null)
277 // FIXME: why use this instead of jabber_send_presence()?
278 $conn = jabber_connect();
280 $to = htmlspecialchars($to);
281 $status = htmlspecialchars($status);
288 $out .= " type='$type'";
290 if ($show == 'available' and !$status) {
294 if ($show && ($show != 'available')) {
295 $out .= "<show>$show</show>";
298 $out .= "<status>$status</status>";
300 $out .= "</presence>";
306 * broadcast a notice to all subscribers and reply recipients
308 * This function will send a notice to all subscribers on the local server
309 * who have Jabber addresses, and have Jabber notification enabled, and
310 * have this subscription enabled for Jabber. It also sends the notice to
311 * all recipients of @-replies who have Jabber addresses and Jabber notification
312 * enabled. This is really the heart of Jabber distribution in StatusNet.
314 * @param Notice $notice The notice to broadcast
316 * @return boolean success flag
319 function jabber_broadcast_notice($notice)
321 if (!common_config('xmpp', 'enabled')) {
324 $profile = Profile::staticGet($notice->profile_id);
327 common_log(LOG_WARNING, 'Refusing to broadcast notice with ' .
328 'unknown profile ' . common_log_objstring($notice),
333 $msg = jabber_format_notice($profile, $notice);
334 $entry = jabber_format_entry($profile, $notice);
341 $conn = jabber_connect();
343 // First, get users to whom this is a direct reply
345 $UT = common_config('db','type')=='pgsql'?'"user"':'user';
346 $user->query("SELECT $UT.id, $UT.jabber " .
347 "FROM $UT JOIN reply ON $UT.id = reply.profile_id " .
348 'WHERE reply.notice_id = ' . $notice->id . ' ' .
349 "AND $UT.jabber is not null " .
350 "AND $UT.jabbernotify = 1 " .
351 "AND $UT.jabberreplies = 1 ");
353 while ($user->fetch()) {
355 'Sending reply notice ' . $notice->id . ' to ' . $user->jabber,
357 $conn->message($user->jabber, $msg, 'chat', null, $entry);
358 $conn->processTime(0);
359 $sent_to[$user->id] = 1;
364 // Now, get users subscribed to this profile
367 $user->query("SELECT $UT.id, $UT.jabber " .
368 "FROM $UT JOIN subscription " .
369 "ON $UT.id = subscription.subscriber " .
370 'WHERE subscription.subscribed = ' . $notice->profile_id . ' ' .
371 "AND $UT.jabber is not null " .
372 "AND $UT.jabbernotify = 1 " .
373 'AND subscription.jabber = 1 ');
375 while ($user->fetch()) {
376 if (!array_key_exists($user->id, $sent_to)) {
378 'Sending notice ' . $notice->id . ' to ' . $user->jabber,
380 $conn->message($user->jabber, $msg, 'chat', null, $entry);
381 // To keep the incoming queue from filling up,
382 // we service it after each send.
383 $conn->processTime(0);
384 $sent_to[$user->id] = 1;
388 // Now, get users who have it in their inbox because of groups
391 $user->query("SELECT $UT.id, $UT.jabber " .
392 "FROM $UT JOIN notice_inbox " .
393 "ON $UT.id = notice_inbox.user_id " .
394 'WHERE notice_inbox.notice_id = ' . $notice->id . ' ' .
395 'AND notice_inbox.source = 2 ' .
396 "AND $UT.jabber is not null " .
397 "AND $UT.jabbernotify = 1 ");
399 while ($user->fetch()) {
400 if (!array_key_exists($user->id, $sent_to)) {
402 'Sending notice ' . $notice->id . ' to ' . $user->jabber,
404 $conn->message($user->jabber, $msg, 'chat', null, $entry);
405 // To keep the incoming queue from filling up,
406 // we service it after each send.
407 $conn->processTime(0);
408 $sent_to[$user->id] = 1;
418 * send a notice to all public listeners
420 * For notices that are generated on the local system (by users), we can optionally
421 * forward them to remote listeners by XMPP.
423 * @param Notice $notice notice to broadcast
425 * @return boolean success flag
428 function jabber_public_notice($notice)
430 // Now, users who want everything
432 $public = common_config('xmpp', 'public');
434 // FIXME PRIV don't send out private messages here
435 // XXX: should we send out non-local messages if public,localonly
436 // = false? I think not
438 if ($public && $notice->is_local) {
439 $profile = Profile::staticGet($notice->profile_id);
442 common_log(LOG_WARNING, 'Refusing to broadcast notice with ' .
443 'unknown profile ' . common_log_objstring($notice),
448 $msg = jabber_format_notice($profile, $notice);
449 $entry = jabber_format_entry($profile, $notice);
451 $conn = jabber_connect();
453 foreach ($public as $address) {
455 'Sending notice ' . $notice->id .
456 ' to public listener ' . $address,
458 $conn->message($address, $msg, 'chat', null, $entry);
459 $conn->processTime(0);
468 * makes a plain-text formatted version of a notice, suitable for Jabber distribution
470 * @param Profile &$profile profile of the sending user
471 * @param Notice &$notice notice being sent
473 * @return string plain-text version of the notice, with user nickname prefixed
476 function jabber_format_notice(&$profile, &$notice)
478 return $profile->nickname . ': ' . $notice->content;