3 * Laconica, 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@controlyourself.ca>
25 * @copyright 2008 Control Yourself, Inc.
26 * @license http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
27 * @link http://laconi.ca/
30 if (!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 Laconica instance
72 * @return string JID of the Jabber daemon
75 function jabber_daemon_address()
77 return common_config('xmpp', 'user') . '@' . common_config('xmpp', 'server');
81 * connect the configured Jabber account to the configured server
83 * @param string $resource Resource to connect (defaults to configured resource)
85 * @return XMPPHP connection to the configured server
88 function jabber_connect($resource=null)
92 $conn = new XMPPHP_XMPP(common_config('xmpp', 'host') ?
93 common_config('xmpp', 'host') :
94 common_config('xmpp', 'server'),
95 common_config('xmpp', 'port'),
96 common_config('xmpp', 'user'),
97 common_config('xmpp', 'password'),
98 ($resource) ? $resource :
99 common_config('xmpp', 'resource'),
100 common_config('xmpp', 'server'),
101 common_config('xmpp', 'debug') ?
103 common_config('xmpp', 'debug') ?
104 XMPPHP_Log::LEVEL_VERBOSE : null
111 $conn->autoSubscribe();
112 $conn->useEncryption(common_config('xmpp', 'encryption'));
115 $conn->connect(true); // true = persistent connection
116 } catch (XMPPHP_Exception $e) {
117 common_log(LOG_ERR, $e->getMessage());
121 $conn->processUntil('session_start');
127 * send a single notice to a given Jabber address
129 * @param string $to JID to send the notice to
130 * @param Notice $notice notice to send
132 * @return boolean success value
135 function jabber_send_notice($to, $notice)
137 $conn = jabber_connect();
141 $profile = Profile::staticGet($notice->profile_id);
143 common_log(LOG_WARNING, 'Refusing to send notice with ' .
144 'unknown profile ' . common_log_objstring($notice),
148 $msg = jabber_format_notice($profile, $notice);
149 $entry = jabber_format_entry($profile, $notice);
150 $conn->message($to, $msg, 'chat', null, $entry);
156 * extra information for XMPP messages, as defined by Twitter
158 * @param Profile $profile Profile of the sending user
159 * @param Notice $notice Notice being sent
161 * @return string Extra information (Atom, HTML, addresses) in string format
164 function jabber_format_entry($profile, $notice)
166 $entry = $notice->asAtomEntry(true, true);
168 $xs = new XMLStringer();
169 $xs->elementStart('html', array('xmlns' => 'http://jabber.org/protocol/xhtml-im'));
170 $xs->elementStart('body', array('xmlns' => 'http://www.w3.org/1999/xhtml'));
171 $xs->element('a', array('href' => $profile->profileurl),
174 if (!empty($notice->rendered)) {
175 $xs->raw($notice->rendered);
177 $xs->raw(common_render_content($notice->content, $notice));
179 $xs->elementEnd('body');
180 $xs->elementEnd('html');
182 $html = $xs->getString();
184 return $html . ' ' . $entry;
188 * sends a single text message to a given JID
190 * @param string $to JID to send the message to
191 * @param string $body body of the message
192 * @param string $type type of the message
193 * @param string $subject subject of the message
195 * @return boolean success flag
198 function jabber_send_message($to, $body, $type='chat', $subject=null)
200 $conn = jabber_connect();
204 $conn->message($to, $body, $type, $subject);
209 * sends a presence stanza on the Jabber network
211 * @param string $status current status, free-form string
212 * @param string $show structured status value
213 * @param string $to recipient of presence, null for general
214 * @param string $type type of status message, related to $show
215 * @param int $priority priority of the presence
217 * @return boolean success value
220 function jabber_send_presence($status, $show='available', $to=null,
221 $type = 'available', $priority=null)
223 $conn = jabber_connect();
227 $conn->presence($status, $show, $to, $type, $priority);
232 * sends a confirmation request to a JID
234 * @param string $code confirmation code for confirmation URL
235 * @param string $nickname nickname of confirming user
236 * @param string $address JID to send confirmation to
238 * @return boolean success flag
241 function jabber_confirm_address($code, $nickname, $address)
243 $body = 'User "' . $nickname . '" on ' . common_config('site', 'name') . ' ' .
244 'has said that your Jabber ID belongs to them. ' .
245 'If that\'s true, you can confirm by clicking on this URL: ' .
246 common_local_url('confirmaddress', array('code' => $code)) .
247 ' . (If you cannot click it, copy-and-paste it into the ' .
248 'address bar of your browser). If that user isn\'t you, ' .
249 'or if you didn\'t request this confirmation, just ignore this message.';
251 return jabber_send_message($address, $body);
255 * sends a "special" presence stanza on the Jabber network
257 * @param string $type Type of presence
258 * @param string $to JID to send presence to
259 * @param string $show show value for presence
260 * @param string $status status value for presence
262 * @return boolean success flag
264 * @see jabber_send_presence()
267 function jabber_special_presence($type, $to=null, $show=null, $status=null)
269 // FIXME: why use this instead of jabber_send_presence()?
270 $conn = jabber_connect();
272 $to = htmlspecialchars($to);
273 $status = htmlspecialchars($status);
280 $out .= " type='$type'";
282 if ($show == 'available' and !$status) {
286 if ($show && ($show != 'available')) {
287 $out .= "<show>$show</show>";
290 $out .= "<status>$status</status>";
292 $out .= "</presence>";
298 * broadcast a notice to all subscribers and reply recipients
300 * This function will send a notice to all subscribers on the local server
301 * who have Jabber addresses, and have Jabber notification enabled, and
302 * have this subscription enabled for Jabber. It also sends the notice to
303 * all recipients of @-replies who have Jabber addresses and Jabber notification
304 * enabled. This is really the heart of Jabber distribution in Laconica.
306 * @param Notice $notice The notice to broadcast
308 * @return boolean success flag
311 function jabber_broadcast_notice($notice)
313 if (!common_config('xmpp', 'enabled')) {
316 $profile = Profile::staticGet($notice->profile_id);
319 common_log(LOG_WARNING, 'Refusing to broadcast notice with ' .
320 'unknown profile ' . common_log_objstring($notice),
325 $msg = jabber_format_notice($profile, $notice);
326 $entry = jabber_format_entry($profile, $notice);
333 $conn = jabber_connect();
335 // First, get users to whom this is a direct reply
337 $UT = common_config('db','type')=='pgsql'?'"user"':'user';
338 $user->query("SELECT $UT.id, $UT.jabber " .
339 "FROM $UT JOIN reply ON $UT.id = reply.profile_id " .
340 'WHERE reply.notice_id = ' . $notice->id . ' ' .
341 "AND $UT.jabber is not null " .
342 "AND $UT.jabbernotify = 1 " .
343 "AND $UT.jabberreplies = 1 ");
345 while ($user->fetch()) {
347 'Sending reply notice ' . $notice->id . ' to ' . $user->jabber,
349 $conn->message($user->jabber, $msg, 'chat', null, $entry);
350 $conn->processTime(0);
351 $sent_to[$user->id] = 1;
356 // Now, get users subscribed to this profile
359 $user->query("SELECT $UT.id, $UT.jabber " .
360 "FROM $UT JOIN subscription " .
361 "ON $UT.id = subscription.subscriber " .
362 'WHERE subscription.subscribed = ' . $notice->profile_id . ' ' .
363 "AND $UT.jabber is not null " .
364 "AND $UT.jabbernotify = 1 " .
365 'AND subscription.jabber = 1 ');
367 while ($user->fetch()) {
368 if (!array_key_exists($user->id, $sent_to)) {
370 'Sending notice ' . $notice->id . ' to ' . $user->jabber,
372 $conn->message($user->jabber, $msg, 'chat', null, $entry);
373 // To keep the incoming queue from filling up,
374 // we service it after each send.
375 $conn->processTime(0);
376 $sent_to[$user->id] = 1;
380 // Now, get users who have it in their inbox because of groups
383 $user->query("SELECT $UT.id, $UT.jabber " .
384 "FROM $UT JOIN notice_inbox " .
385 "ON $UT.id = notice_inbox.user_id " .
386 'WHERE notice_inbox.notice_id = ' . $notice->id . ' ' .
387 'AND notice_inbox.source = 2 ' .
388 "AND $UT.jabber is not null " .
389 "AND $UT.jabbernotify = 1 ");
391 while ($user->fetch()) {
392 if (!array_key_exists($user->id, $sent_to)) {
394 'Sending notice ' . $notice->id . ' to ' . $user->jabber,
396 $conn->message($user->jabber, $msg, 'chat', null, $entry);
397 // To keep the incoming queue from filling up,
398 // we service it after each send.
399 $conn->processTime(0);
400 $sent_to[$user->id] = 1;
410 * send a notice to all public listeners
412 * For notices that are generated on the local system (by users), we can optionally
413 * forward them to remote listeners by XMPP.
415 * @param Notice $notice notice to broadcast
417 * @return boolean success flag
420 function jabber_public_notice($notice)
422 // Now, users who want everything
424 $public = common_config('xmpp', 'public');
426 // FIXME PRIV don't send out private messages here
427 // XXX: should we send out non-local messages if public,localonly
428 // = false? I think not
430 if ($public && $notice->is_local) {
431 $profile = Profile::staticGet($notice->profile_id);
434 common_log(LOG_WARNING, 'Refusing to broadcast notice with ' .
435 'unknown profile ' . common_log_objstring($notice),
440 $msg = jabber_format_notice($profile, $notice);
441 $entry = jabber_format_entry($profile, $notice);
443 $conn = jabber_connect();
445 foreach ($public as $address) {
447 'Sending notice ' . $notice->id .
448 ' to public listener ' . $address,
450 $conn->message($address, $msg, 'chat', null, $entry);
451 $conn->processTime(0);
460 * makes a plain-text formatted version of a notice, suitable for Jabber distribution
462 * @param Profile &$profile profile of the sending user
463 * @param Notice &$notice notice being sent
465 * @return string plain-text version of the notice, with user nickname prefixed
468 function jabber_format_notice(&$profile, &$notice)
470 return $profile->nickname . ': ' . $notice->content;