lib/jabber.php

   1 <?php
   2 /**
   3  * Laconica, the distributed open-source microblogging tool
   4  *
   5  * utility functions for Jabber/GTalk/XMPP messages
   6  *
   7  * PHP version 5
   8  *
   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.
  13  *
  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.
  18  *
  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/>.
  21  *
  22  * @category  Network
  23  * @package   Laconica
  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/
  28  */
  29
  30 if (!defined('LACONICA')) {
  31     exit(1);
  32 }
  33
  34 require_once 'XMPPHP/XMPP.php';
  35
  36 /**
  37  * checks whether a string is a syntactically valid Jabber ID (JID)
  38  *
  39  * @param string $jid string to check
  40  *
  41  * @return     boolean whether the string is a valid JID
  42  */
  43
  44 function jabber_valid_base_jid($jid)
  45 {
  46     // Cheap but effective
  47     return Validate::email($jid);
  48 }
  49
  50 /**
  51  * normalizes a Jabber ID for comparison
  52  *
  53  * @param string $jid JID to check
  54  *
  55  * @return string an equivalent JID in normalized (lowercase) form
  56  */
  57
  58 function jabber_normalize_jid($jid)
  59 {
  60     if (preg_match("/(?:([^\@]+)\@)?([^\/]+)(?:\/(.*))?$/", $jid, $matches)) {
  61         $node   = $matches[1];
  62         $server = $matches[2];
  63         return strtolower($node.'@'.$server);
  64     } else {
  65         return null;
  66     }
  67 }
  68
  69 /**
  70  * the JID of the Jabber daemon for this Laconica instance
  71  *
  72  * @return string JID of the Jabber daemon
  73  */
  74
  75 function jabber_daemon_address()
  76 {
  77     return common_config('xmpp', 'user') . '@' . common_config('xmpp', 'server');
  78 }
  79
  80 /**
  81  * connect the configured Jabber account to the configured server
  82  *
  83  * @param string $resource Resource to connect (defaults to configured resource)
  84  *
  85  * @return XMPPHP connection to the configured server
  86  */
  87
  88 function jabber_connect($resource=null)
  89 {
  90     static $conn = null;
  91     if (!$conn) {
  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') ?
 102                                 true : false,
 103                                 common_config('xmpp', 'debug') ?
 104                                 XMPPHP_Log::LEVEL_VERBOSE :  null
 105                                 );
 106
 107         if (!$conn) {
 108             return false;
 109         }
 110
 111         $conn->autoSubscribe();
 112         $conn->useEncryption(common_config('xmpp', 'encryption'));
 113
 114         try {
 115             $conn->connect(true); // true = persistent connection
 116         } catch (XMPPHP_Exception $e) {
 117             common_log(LOG_ERROR, $e->getMessage());
 118             return false;
 119         }
 120
 121         $conn->processUntil('session_start');
 122     }
 123     return $conn;
 124 }
 125
 126 /**
 127  * send a single notice to a given Jabber address
 128  *
 129  * @param string $to     JID to send the notice to
 130  * @param Notice $notice notice to send
 131  *
 132  * @return boolean success value
 133  */
 134
 135 function jabber_send_notice($to, $notice)
 136 {
 137     $conn = jabber_connect();
 138     if (!$conn) {
 139         return false;
 140     }
 141     $profile = Profile::staticGet($notice->profile_id);
 142     if (!$profile) {
 143         common_log(LOG_WARNING, 'Refusing to send notice with ' .
 144                    'unknown profile ' . common_log_objstring($notice),
 145                    __FILE__);
 146         return false;
 147     }
 148     $msg   = jabber_format_notice($profile, $notice);
 149     $entry = jabber_format_entry($profile, $notice);
 150     $conn->message($to, $msg, 'chat', null, $entry);
 151     $profile->free();
 152     return true;
 153 }
 154
 155 /**
 156  * extra information for XMPP messages, as defined by Twitter
 157  *
 158  * @param Profile $profile Profile of the sending user
 159  * @param Notice  $notice  Notice being sent
 160  *
 161  * @return string Extra information (Atom, HTML, addresses) in string format
 162  */
 163
 164 function jabber_format_entry($profile, $notice)
 165 {
 166     // FIXME: notice url might be remote
 167
 168     $noticeurl = common_local_url('shownotice',
 169                                   array('notice' => $notice->id));
 170
 171     $msg = jabber_format_notice($profile, $notice);
 172
 173     $self_url = common_local_url('userrss', array('nickname' => $profile->nickname));
 174
 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     $entry .= "</entry>\n";
 190
 191     $html  = "\n<html xmlns='http://jabber.org/protocol/xhtml-im'>\n";
 192     $html .= "<body xmlns='http://www.w3.org/1999/xhtml'>\n";
 193     $html .= "<a href='".htmlspecialchars($profile->profileurl)."'>".$profile->nickname."</a>: ";
 194     $html .= ($notice->rendered) ? $notice->rendered : common_render_content($notice->content, $notice);
 195     $html .= "\n</body>\n";
 196     $html .= "\n</html>\n";
 197
 198     $address  = "<addresses xmlns='http://jabber.org/protocol/address'>\n";
 199     $address .= "<address type='replyto' jid='" . jabber_daemon_address() . "' />\n";
 200     $address .= "</addresses>\n";
 201
 202     // FIXME: include a pubsub event, too.
 203
 204     return $html . $entry . $address;
 205 }
 206
 207 /**
 208  * sends a single text message to a given JID
 209  *
 210  * @param string $to      JID to send the message to
 211  * @param string $body    body of the message
 212  * @param string $type    type of the message
 213  * @param string $subject subject of the message
 214  *
 215  * @return boolean success flag
 216  */
 217
 218 function jabber_send_message($to, $body, $type='chat', $subject=null)
 219 {
 220     $conn = jabber_connect();
 221     if (!$conn) {
 222         return false;
 223     }
 224     $conn->message($to, $body, $type, $subject);
 225     return true;
 226 }
 227
 228 /**
 229  * sends a presence stanza on the Jabber network
 230  *
 231  * @param string $status   current status, free-form string
 232  * @param string $show     structured status value
 233  * @param string $to       recipient of presence, null for general
 234  * @param string $type     type of status message, related to $show
 235  * @param int    $priority priority of the presence
 236  *
 237  * @return boolean success value
 238  */
 239
 240 function jabber_send_presence($status, $show='available', $to=null,
 241                               $type = 'available', $priority=null)
 242 {
 243     $conn = jabber_connect();
 244     if (!$conn) {
 245         return false;
 246     }
 247     $conn->presence($status, $show, $to, $type, $priority);
 248     return true;
 249 }
 250
 251 /**
 252  * sends a confirmation request to a JID
 253  *
 254  * @param string $code     confirmation code for confirmation URL
 255  * @param string $nickname nickname of confirming user
 256  * @param string $address  JID to send confirmation to
 257  *
 258  * @return boolean success flag
 259  */
 260
 261 function jabber_confirm_address($code, $nickname, $address)
 262 {
 263     $body = 'User "' . $nickname . '" on ' . common_config('site', 'name') . ' ' .
 264       'has said that your Jabber ID belongs to them. ' .
 265       'If that\'s true, you can confirm by clicking on this URL: ' .
 266       common_local_url('confirmaddress', array('code' => $code)) .
 267       ' . (If you cannot click it, copy-and-paste it into the ' .
 268       'address bar of your browser). If that user isn\'t you, ' .
 269       'or if you didn\'t request this confirmation, just ignore this message.';
 270
 271     return jabber_send_message($address, $body);
 272 }
 273
 274 /**
 275  * sends a "special" presence stanza on the Jabber network
 276  *
 277  * @param string $type   Type of presence
 278  * @param string $to     JID to send presence to
 279  * @param string $show   show value for presence
 280  * @param string $status status value for presence
 281  *
 282  * @return boolean success flag
 283  *
 284  * @see jabber_send_presence()
 285  */
 286
 287 function jabber_special_presence($type, $to=null, $show=null, $status=null)
 288 {
 289     // FIXME: why use this instead of jabber_send_presence()?
 290     $conn = jabber_connect();
 291
 292     $to     = htmlspecialchars($to);
 293     $status = htmlspecialchars($status);
 294
 295     $out = "<presence";
 296     if ($to) {
 297         $out .= " to='$to'";
 298     }
 299     if ($type) {
 300         $out .= " type='$type'";
 301     }
 302     if ($show == 'available' and !$status) {
 303         $out .= "/>";
 304     } else {
 305         $out .= ">";
 306         if ($show && ($show != 'available')) {
 307             $out .= "<show>$show</show>";
 308         }
 309         if ($status) {
 310             $out .= "<status>$status</status>";
 311         }
 312         $out .= "</presence>";
 313     }
 314     $conn->send($out);
 315 }
 316
 317 /**
 318  * broadcast a notice to all subscribers and reply recipients
 319  *
 320  * This function will send a notice to all subscribers on the local server
 321  * who have Jabber addresses, and have Jabber notification enabled, and
 322  * have this subscription enabled for Jabber. It also sends the notice to
 323  * all recipients of @-replies who have Jabber addresses and Jabber notification
 324  * enabled. This is really the heart of Jabber distribution in Laconica.
 325  *
 326  * @param Notice $notice The notice to broadcast
 327  *
 328  * @return boolean success flag
 329  */
 330
 331 function jabber_broadcast_notice($notice)
 332 {
 333     if (!common_config('xmpp', 'enabled')) {
 334         return true;
 335     }
 336     $profile = Profile::staticGet($notice->profile_id);
 337
 338     if (!$profile) {
 339         common_log(LOG_WARNING, 'Refusing to broadcast notice with ' .
 340                    'unknown profile ' . common_log_objstring($notice),
 341                    __FILE__);
 342         return false;
 343     }
 344
 345     $msg   = jabber_format_notice($profile, $notice);
 346     $entry = jabber_format_entry($profile, $notice);
 347
 348     $profile->free();
 349     unset($profile);
 350
 351     $sent_to = array();
 352
 353     $conn = jabber_connect();
 354
 355     // First, get users to whom this is a direct reply
 356     $user = new User();
 357     $UT = common_config('db','type')=='pgsql'?'"user"':'user';
 358     $user->query("SELECT $UT.id, $UT.jabber " .
 359                  "FROM $UT JOIN reply ON $UT.id = reply.profile_id " .
 360                  'WHERE reply.notice_id = ' . $notice->id . ' ' .
 361                  "AND $UT.jabber is not null " .
 362                  "AND $UT.jabbernotify = 1 " .
 363                  "AND $UT.jabberreplies = 1 ");
 364
 365     while ($user->fetch()) {
 366         common_log(LOG_INFO,
 367                    'Sending reply notice ' . $notice->id . ' to ' . $user->jabber,
 368                    __FILE__);
 369         $conn->message($user->jabber, $msg, 'chat', null, $entry);
 370         $conn->processTime(0);
 371         $sent_to[$user->id] = 1;
 372     }
 373
 374     $user->free();
 375
 376     // Now, get users subscribed to this profile
 377
 378     $user = new User();
 379     $user->query("SELECT $UT.id, $UT.jabber " .
 380                  "FROM $UT JOIN subscription " .
 381                  "ON $UT.id = subscription.subscriber " .
 382                  'WHERE subscription.subscribed = ' . $notice->profile_id . ' ' .
 383                  "AND $UT.jabber is not null " .
 384                  "AND $UT.jabbernotify = 1 " .
 385                  'AND subscription.jabber = 1 ');
 386
 387     while ($user->fetch()) {
 388         if (!array_key_exists($user->id, $sent_to)) {
 389             common_log(LOG_INFO,
 390                        'Sending notice ' . $notice->id . ' to ' . $user->jabber,
 391                        __FILE__);
 392             $conn->message($user->jabber, $msg, 'chat', null, $entry);
 393             // To keep the incoming queue from filling up,
 394             // we service it after each send.
 395             $conn->processTime(0);
 396             $sent_to[$user->id] = 1;
 397         }
 398     }
 399
 400     // Now, get users who have it in their inbox because of groups
 401
 402     $user = new User();
 403     $user->query("SELECT $UT.id, $UT.jabber " .
 404                  "FROM $UT JOIN notice_inbox " .
 405                  "ON $UT.id = notice_inbox.user_id " .
 406                  'WHERE notice_inbox.notice_id = ' . $notice->id . ' ' .
 407                  'AND notice_inbox.source = 2 ' .
 408                  'AND user.jabber is not null ' .
 409                  'AND user.jabbernotify = 1 ');
 410
 411     while ($user->fetch()) {
 412         if (!array_key_exists($user->id, $sent_to)) {
 413             common_log(LOG_INFO,
 414                        'Sending notice ' . $notice->id . ' to ' . $user->jabber,
 415                        __FILE__);
 416             $conn->message($user->jabber, $msg, 'chat', null, $entry);
 417             // To keep the incoming queue from filling up,
 418             // we service it after each send.
 419             $conn->processTime(0);
 420             $sent_to[$user->id] = 1;
 421         }
 422     }
 423
 424     $user->free();
 425
 426     return true;
 427 }
 428
 429 /**
 430  * send a notice to all public listeners
 431  *
 432  * For notices that are generated on the local system (by users), we can optionally
 433  * forward them to remote listeners by XMPP.
 434  *
 435  * @param Notice $notice notice to broadcast
 436  *
 437  * @return boolean success flag
 438  */
 439
 440 function jabber_public_notice($notice)
 441 {
 442     // Now, users who want everything
 443
 444     $public = common_config('xmpp', 'public');
 445
 446     // FIXME PRIV don't send out private messages here
 447     // XXX: should we send out non-local messages if public,localonly
 448     // = false? I think not
 449
 450     if ($public && $notice->is_local) {
 451         $profile = Profile::staticGet($notice->profile_id);
 452
 453         if (!$profile) {
 454             common_log(LOG_WARNING, 'Refusing to broadcast notice with ' .
 455                        'unknown profile ' . common_log_objstring($notice),
 456                        __FILE__);
 457             return false;
 458         }
 459
 460         $msg   = jabber_format_notice($profile, $notice);
 461         $entry = jabber_format_entry($profile, $notice);
 462
 463         $conn = jabber_connect();
 464
 465         foreach ($public as $address) {
 466             common_log(LOG_INFO,
 467                        'Sending notice ' . $notice->id .
 468                        ' to public listener ' . $address,
 469                        __FILE__);
 470             $conn->message($address, $msg, 'chat', null, $entry);
 471             $conn->processTime(0);
 472         }
 473         $profile->free();
 474     }
 475
 476     return true;
 477 }
 478
 479 /**
 480  * makes a plain-text formatted version of a notice, suitable for Jabber distribution
 481  *
 482  * @param Profile &$profile profile of the sending user
 483  * @param Notice  &$notice  notice being sent
 484  *
 485  * @return string plain-text version of the notice, with user nickname prefixed
 486  */
 487
 488 function jabber_format_notice(&$profile, &$notice)
 489 {
 490     return $profile->nickname . ': ' . $notice->content;
 491 }