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_ERR, $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     $entry = $notice->asAtomEntry(true, true);
 167
 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),
 172                  $profile->nickname);
 173     $xs->text(": ");
 174     if (!empty($notice->rendered)) {
 175         $xs->raw($notice->rendered);
 176     } else {
 177         $xs->raw(common_render_content($notice->content, $notice));
 178     }
 179     $xs->elementEnd('body');
 180     $xs->elementEnd('html');
 181
 182     $html = $xs->getString();
 183
 184     return $html . ' ' . $entry;
 185 }
 186
 187 /**
 188  * sends a single text message to a given JID
 189  *
 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
 194  *
 195  * @return boolean success flag
 196  */
 197
 198 function jabber_send_message($to, $body, $type='chat', $subject=null)
 199 {
 200     $conn = jabber_connect();
 201     if (!$conn) {
 202         return false;
 203     }
 204     $conn->message($to, $body, $type, $subject);
 205     return true;
 206 }
 207
 208 /**
 209  * sends a presence stanza on the Jabber network
 210  *
 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
 216  *
 217  * @return boolean success value
 218  */
 219
 220 function jabber_send_presence($status, $show='available', $to=null,
 221                               $type = 'available', $priority=null)
 222 {
 223     $conn = jabber_connect();
 224     if (!$conn) {
 225         return false;
 226     }
 227     $conn->presence($status, $show, $to, $type, $priority);
 228     return true;
 229 }
 230
 231 /**
 232  * sends a confirmation request to a JID
 233  *
 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
 237  *
 238  * @return boolean success flag
 239  */
 240
 241 function jabber_confirm_address($code, $nickname, $address)
 242 {
 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.';
 250
 251     return jabber_send_message($address, $body);
 252 }
 253
 254 /**
 255  * sends a "special" presence stanza on the Jabber network
 256  *
 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
 261  *
 262  * @return boolean success flag
 263  *
 264  * @see jabber_send_presence()
 265  */
 266
 267 function jabber_special_presence($type, $to=null, $show=null, $status=null)
 268 {
 269     // FIXME: why use this instead of jabber_send_presence()?
 270     $conn = jabber_connect();
 271
 272     $to     = htmlspecialchars($to);
 273     $status = htmlspecialchars($status);
 274
 275     $out = "<presence";
 276     if ($to) {
 277         $out .= " to='$to'";
 278     }
 279     if ($type) {
 280         $out .= " type='$type'";
 281     }
 282     if ($show == 'available' and !$status) {
 283         $out .= "/>";
 284     } else {
 285         $out .= ">";
 286         if ($show && ($show != 'available')) {
 287             $out .= "<show>$show</show>";
 288         }
 289         if ($status) {
 290             $out .= "<status>$status</status>";
 291         }
 292         $out .= "</presence>";
 293     }
 294     $conn->send($out);
 295 }
 296
 297 /**
 298  * broadcast a notice to all subscribers and reply recipients
 299  *
 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.
 305  *
 306  * @param Notice $notice The notice to broadcast
 307  *
 308  * @return boolean success flag
 309  */
 310
 311 function jabber_broadcast_notice($notice)
 312 {
 313     if (!common_config('xmpp', 'enabled')) {
 314         return true;
 315     }
 316     $profile = Profile::staticGet($notice->profile_id);
 317
 318     if (!$profile) {
 319         common_log(LOG_WARNING, 'Refusing to broadcast notice with ' .
 320                    'unknown profile ' . common_log_objstring($notice),
 321                    __FILE__);
 322         return false;
 323     }
 324
 325     $msg   = jabber_format_notice($profile, $notice);
 326     $entry = jabber_format_entry($profile, $notice);
 327
 328     $profile->free();
 329     unset($profile);
 330
 331     $sent_to = array();
 332
 333     $conn = jabber_connect();
 334
 335     // First, get users to whom this is a direct reply
 336     $user = new User();
 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 ");
 344
 345     while ($user->fetch()) {
 346         common_log(LOG_INFO,
 347                    'Sending reply notice ' . $notice->id . ' to ' . $user->jabber,
 348                    __FILE__);
 349         $conn->message($user->jabber, $msg, 'chat', null, $entry);
 350         $conn->processTime(0);
 351         $sent_to[$user->id] = 1;
 352     }
 353
 354     $user->free();
 355
 356     // Now, get users subscribed to this profile
 357
 358     $user = new User();
 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 ');
 366
 367     while ($user->fetch()) {
 368         if (!array_key_exists($user->id, $sent_to)) {
 369             common_log(LOG_INFO,
 370                        'Sending notice ' . $notice->id . ' to ' . $user->jabber,
 371                        __FILE__);
 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;
 377         }
 378     }
 379
 380     // Now, get users who have it in their inbox because of groups
 381
 382     $user = new User();
 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 ");
 390
 391     while ($user->fetch()) {
 392         if (!array_key_exists($user->id, $sent_to)) {
 393             common_log(LOG_INFO,
 394                        'Sending notice ' . $notice->id . ' to ' . $user->jabber,
 395                        __FILE__);
 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;
 401         }
 402     }
 403
 404     $user->free();
 405
 406     return true;
 407 }
 408
 409 /**
 410  * send a notice to all public listeners
 411  *
 412  * For notices that are generated on the local system (by users), we can optionally
 413  * forward them to remote listeners by XMPP.
 414  *
 415  * @param Notice $notice notice to broadcast
 416  *
 417  * @return boolean success flag
 418  */
 419
 420 function jabber_public_notice($notice)
 421 {
 422     // Now, users who want everything
 423
 424     $public = common_config('xmpp', 'public');
 425
 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
 429
 430     if ($public && $notice->is_local) {
 431         $profile = Profile::staticGet($notice->profile_id);
 432
 433         if (!$profile) {
 434             common_log(LOG_WARNING, 'Refusing to broadcast notice with ' .
 435                        'unknown profile ' . common_log_objstring($notice),
 436                        __FILE__);
 437             return false;
 438         }
 439
 440         $msg   = jabber_format_notice($profile, $notice);
 441         $entry = jabber_format_entry($profile, $notice);
 442
 443         $conn = jabber_connect();
 444
 445         foreach ($public as $address) {
 446             common_log(LOG_INFO,
 447                        'Sending notice ' . $notice->id .
 448                        ' to public listener ' . $address,
 449                        __FILE__);
 450             $conn->message($address, $msg, 'chat', null, $entry);
 451             $conn->processTime(0);
 452         }
 453         $profile->free();
 454     }
 455
 456     return true;
 457 }
 458
 459 /**
 460  * makes a plain-text formatted version of a notice, suitable for Jabber distribution
 461  *
 462  * @param Profile &$profile profile of the sending user
 463  * @param Notice  &$notice  notice being sent
 464  *
 465  * @return string plain-text version of the notice, with user nickname prefixed
 466  */
 467
 468 function jabber_format_notice(&$profile, &$notice)
 469 {
 470     return $profile->nickname . ': ' . $notice->content;
 471 }