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_ERROR, $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 // FIXME: notice url might be remote
168 $noticeurl = common_local_url('shownotice',
169 array('notice' => $notice->id));
171 $msg = jabber_format_notice($profile, $notice);
173 $self_url = common_local_url('userrss', array('nickname' => $profile->nickname));
175 $entry = "\n<entry xmlns='http://www.w3.org/2005/Atom'>\n";
176 $entry .= "<source>\n";
177 $entry .= "<title>" . $profile->nickname . " - " . common_config('site', 'name') . "</title>\n";
178 $entry .= "<link href='" . htmlspecialchars($profile->profileurl) . "'/>\n";
179 $entry .= "<link rel='self' type='application/rss+xml' href='" . $self_url . "'/>\n";
180 $entry .= "<author><name>" . $profile->nickname . "</name></author>\n";
181 $entry .= "<icon>" . $profile->avatarUrl(AVATAR_PROFILE_SIZE) . "</icon>\n";
182 $entry .= "</source>\n";
183 $entry .= "<title>" . htmlspecialchars($msg) . "</title>\n";
184 $entry .= "<summary>" . htmlspecialchars($msg) . "</summary>\n";
185 $entry .= "<link rel='alternate' href='" . $noticeurl . "' />\n";
186 $entry .= "<id>". $notice->uri . "</id>\n";
187 $entry .= "<published>".common_date_w3dtf($notice->created)."</published>\n";
188 $entry .= "<updated>".common_date_w3dtf($notice->modified)."</updated>\n";
189 if ($notice->reply_to) {
190 $replyurl = common_local_url('shownotice',
191 array('notice' => $notice->reply_to));
192 $entry .= "<link rel='related' href='" . $replyurl . "'/>\n";
194 $entry .= "</entry>\n";
196 $html = "\n<html xmlns='http://jabber.org/protocol/xhtml-im'>\n";
197 $html .= "<body xmlns='http://www.w3.org/1999/xhtml'>\n";
198 $html .= "<a href='".htmlspecialchars($profile->profileurl)."'>".$profile->nickname."</a>: ";
199 $html .= ($notice->rendered) ? $notice->rendered : common_render_content($notice->content, $notice);
200 $html .= "\n</body>\n";
201 $html .= "\n</html>\n";
203 $address = "<addresses xmlns='http://jabber.org/protocol/address'>\n";
204 $address .= "<address type='replyto' jid='" . jabber_daemon_address() . "' />\n";
205 $address .= "</addresses>\n";
207 // FIXME: include a pubsub event, too.
209 return $html . $entry . $address;
213 * sends a single text message to a given JID
215 * @param string $to JID to send the message to
216 * @param string $body body of the message
217 * @param string $type type of the message
218 * @param string $subject subject of the message
220 * @return boolean success flag
223 function jabber_send_message($to, $body, $type='chat', $subject=null)
225 $conn = jabber_connect();
229 $conn->message($to, $body, $type, $subject);
234 * sends a presence stanza on the Jabber network
236 * @param string $status current status, free-form string
237 * @param string $show structured status value
238 * @param string $to recipient of presence, null for general
239 * @param string $type type of status message, related to $show
240 * @param int $priority priority of the presence
242 * @return boolean success value
245 function jabber_send_presence($status, $show='available', $to=null,
246 $type = 'available', $priority=null)
248 $conn = jabber_connect();
252 $conn->presence($status, $show, $to, $type, $priority);
257 * sends a confirmation request to a JID
259 * @param string $code confirmation code for confirmation URL
260 * @param string $nickname nickname of confirming user
261 * @param string $address JID to send confirmation to
263 * @return boolean success flag
266 function jabber_confirm_address($code, $nickname, $address)
268 $body = 'User "' . $nickname . '" on ' . common_config('site', 'name') . ' ' .
269 'has said that your Jabber ID belongs to them. ' .
270 'If that\'s true, you can confirm by clicking on this URL: ' .
271 common_local_url('confirmaddress', array('code' => $code)) .
272 ' . (If you cannot click it, copy-and-paste it into the ' .
273 'address bar of your browser). If that user isn\'t you, ' .
274 'or if you didn\'t request this confirmation, just ignore this message.';
276 return jabber_send_message($address, $body);
280 * sends a "special" presence stanza on the Jabber network
282 * @param string $type Type of presence
283 * @param string $to JID to send presence to
284 * @param string $show show value for presence
285 * @param string $status status value for presence
287 * @return boolean success flag
289 * @see jabber_send_presence()
292 function jabber_special_presence($type, $to=null, $show=null, $status=null)
294 // FIXME: why use this instead of jabber_send_presence()?
295 $conn = jabber_connect();
297 $to = htmlspecialchars($to);
298 $status = htmlspecialchars($status);
305 $out .= " type='$type'";
307 if ($show == 'available' and !$status) {
311 if ($show && ($show != 'available')) {
312 $out .= "<show>$show</show>";
315 $out .= "<status>$status</status>";
317 $out .= "</presence>";
323 * broadcast a notice to all subscribers and reply recipients
325 * This function will send a notice to all subscribers on the local server
326 * who have Jabber addresses, and have Jabber notification enabled, and
327 * have this subscription enabled for Jabber. It also sends the notice to
328 * all recipients of @-replies who have Jabber addresses and Jabber notification
329 * enabled. This is really the heart of Jabber distribution in Laconica.
331 * @param Notice $notice The notice to broadcast
333 * @return boolean success flag
336 function jabber_broadcast_notice($notice)
338 if (!common_config('xmpp', 'enabled')) {
341 $profile = Profile::staticGet($notice->profile_id);
344 common_log(LOG_WARNING, 'Refusing to broadcast notice with ' .
345 'unknown profile ' . common_log_objstring($notice),
350 $msg = jabber_format_notice($profile, $notice);
351 $entry = jabber_format_entry($profile, $notice);
358 $conn = jabber_connect();
360 // First, get users to whom this is a direct reply
362 $UT = common_config('db','type')=='pgsql'?'"user"':'user';
363 $user->query("SELECT $UT.id, $UT.jabber " .
364 "FROM $UT JOIN reply ON $UT.id = reply.profile_id " .
365 'WHERE reply.notice_id = ' . $notice->id . ' ' .
366 "AND $UT.jabber is not null " .
367 "AND $UT.jabbernotify = 1 " .
368 "AND $UT.jabberreplies = 1 ");
370 while ($user->fetch()) {
372 'Sending reply notice ' . $notice->id . ' to ' . $user->jabber,
374 $conn->message($user->jabber, $msg, 'chat', null, $entry);
375 $conn->processTime(0);
376 $sent_to[$user->id] = 1;
381 // Now, get users subscribed to this profile
384 $user->query("SELECT $UT.id, $UT.jabber " .
385 "FROM $UT JOIN subscription " .
386 "ON $UT.id = subscription.subscriber " .
387 'WHERE subscription.subscribed = ' . $notice->profile_id . ' ' .
388 "AND $UT.jabber is not null " .
389 "AND $UT.jabbernotify = 1 " .
390 'AND subscription.jabber = 1 ');
392 while ($user->fetch()) {
393 if (!array_key_exists($user->id, $sent_to)) {
395 'Sending notice ' . $notice->id . ' to ' . $user->jabber,
397 $conn->message($user->jabber, $msg, 'chat', null, $entry);
398 // To keep the incoming queue from filling up,
399 // we service it after each send.
400 $conn->processTime(0);
401 $sent_to[$user->id] = 1;
405 // Now, get users who have it in their inbox because of groups
408 $user->query("SELECT $UT.id, $UT.jabber " .
409 "FROM $UT JOIN notice_inbox " .
410 "ON $UT.id = notice_inbox.user_id " .
411 'WHERE notice_inbox.notice_id = ' . $notice->id . ' ' .
412 'AND notice_inbox.source = 2 ' .
413 'AND user.jabber is not null ' .
414 'AND user.jabbernotify = 1 ');
416 while ($user->fetch()) {
417 if (!array_key_exists($user->id, $sent_to)) {
419 'Sending notice ' . $notice->id . ' to ' . $user->jabber,
421 $conn->message($user->jabber, $msg, 'chat', null, $entry);
422 // To keep the incoming queue from filling up,
423 // we service it after each send.
424 $conn->processTime(0);
425 $sent_to[$user->id] = 1;
435 * send a notice to all public listeners
437 * For notices that are generated on the local system (by users), we can optionally
438 * forward them to remote listeners by XMPP.
440 * @param Notice $notice notice to broadcast
442 * @return boolean success flag
445 function jabber_public_notice($notice)
447 // Now, users who want everything
449 $public = common_config('xmpp', 'public');
451 // FIXME PRIV don't send out private messages here
452 // XXX: should we send out non-local messages if public,localonly
453 // = false? I think not
455 if ($public && $notice->is_local) {
456 $profile = Profile::staticGet($notice->profile_id);
459 common_log(LOG_WARNING, 'Refusing to broadcast notice with ' .
460 'unknown profile ' . common_log_objstring($notice),
465 $msg = jabber_format_notice($profile, $notice);
466 $entry = jabber_format_entry($profile, $notice);
468 $conn = jabber_connect();
470 foreach ($public as $address) {
472 'Sending notice ' . $notice->id .
473 ' to public listener ' . $address,
475 $conn->message($address, $msg, 'chat', null, $entry);
476 $conn->processTime(0);
485 * makes a plain-text formatted version of a notice, suitable for Jabber distribution
487 * @param Profile &$profile profile of the sending user
488 * @param Notice &$notice notice being sent
490 * @return string plain-text version of the notice, with user nickname prefixed
493 function jabber_format_notice(&$profile, &$notice)
495 return $profile->nickname . ': ' . $notice->content;