lib/jabber.php

   1 <?php
   2 /**
   3  * StatusNet, 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   StatusNet
  24  * @author    Evan Prodromou <evan@controlyourself.ca>
  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://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 StatusNet 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 class Sharing_XMPP extends XMPPHP_XMPP
  81 {
  82     function getSocket()
  83     {
  84         return $this->socket;
  85     }
  86 }
  87
  88 /**
  89  * connect the configured Jabber account to the configured server
  90  *
  91  * @param string $resource Resource to connect (defaults to configured resource)
  92  *
  93  * @return XMPPHP connection to the configured server
  94  */
  95
  96 function jabber_connect($resource=null)
  97 {
  98     static $conn = null;
  99     if (!$conn) {
 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') ?
 110                                 true : false,
 111                                 common_config('xmpp', 'debug') ?
 112                                 XMPPHP_Log::LEVEL_VERBOSE :  null
 113                                 );
 114
 115         if (!$conn) {
 116             return false;
 117         }
 118
 119         $conn->autoSubscribe();
 120         $conn->useEncryption(common_config('xmpp', 'encryption'));
 121
 122         try {
 123             $conn->connect(true); // true = persistent connection
 124         } catch (XMPPHP_Exception $e) {
 125             common_log(LOG_ERR, $e->getMessage());
 126             return false;
 127         }
 128
 129         $conn->processUntil('session_start');
 130     }
 131     return $conn;
 132 }
 133
 134 /**
 135  * send a single notice to a given Jabber address
 136  *
 137  * @param string $to     JID to send the notice to
 138  * @param Notice $notice notice to send
 139  *
 140  * @return boolean success value
 141  */
 142
 143 function jabber_send_notice($to, $notice)
 144 {
 145     $conn = jabber_connect();
 146     if (!$conn) {
 147         return false;
 148     }
 149     $profile = Profile::staticGet($notice->profile_id);
 150     if (!$profile) {
 151         common_log(LOG_WARNING, 'Refusing to send notice with ' .
 152                    'unknown profile ' . common_log_objstring($notice),
 153                    __FILE__);
 154         return false;
 155     }
 156     $msg   = jabber_format_notice($profile, $notice);
 157     $entry = jabber_format_entry($profile, $notice);
 158     $conn->message($to, $msg, 'chat', null, $entry);
 159     $profile->free();
 160     return true;
 161 }
 162
 163 /**
 164  * extra information for XMPP messages, as defined by Twitter
 165  *
 166  * @param Profile $profile Profile of the sending user
 167  * @param Notice  $notice  Notice being sent
 168  *
 169  * @return string Extra information (Atom, HTML, addresses) in string format
 170  */
 171
 172 function jabber_format_entry($profile, $notice)
 173 {
 174     $entry = $notice->asAtomEntry(true, true);
 175
 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),
 180                  $profile->nickname);
 181     $xs->text(": ");
 182     if (!empty($notice->rendered)) {
 183         $xs->raw($notice->rendered);
 184     } else {
 185         $xs->raw(common_render_content($notice->content, $notice));
 186     }
 187     $xs->elementEnd('body');
 188     $xs->elementEnd('html');
 189
 190     $html = $xs->getString();
 191
 192     return $html . ' ' . $entry;
 193 }
 194
 195 /**
 196  * sends a single text message to a given JID
 197  *
 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
 202  *
 203  * @return boolean success flag
 204  */
 205
 206 function jabber_send_message($to, $body, $type='chat', $subject=null)
 207 {
 208     $conn = jabber_connect();
 209     if (!$conn) {
 210         return false;
 211     }
 212     $conn->message($to, $body, $type, $subject);
 213     return true;
 214 }
 215
 216 /**
 217  * sends a presence stanza on the Jabber network
 218  *
 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
 224  *
 225  * @return boolean success value
 226  */
 227
 228 function jabber_send_presence($status, $show='available', $to=null,
 229                               $type = 'available', $priority=null)
 230 {
 231     $conn = jabber_connect();
 232     if (!$conn) {
 233         return false;
 234     }
 235     $conn->presence($status, $show, $to, $type, $priority);
 236     return true;
 237 }
 238
 239 /**
 240  * sends a confirmation request to a JID
 241  *
 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
 245  *
 246  * @return boolean success flag
 247  */
 248
 249 function jabber_confirm_address($code, $nickname, $address)
 250 {
 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.';
 258
 259     return jabber_send_message($address, $body);
 260 }
 261
 262 /**
 263  * sends a "special" presence stanza on the Jabber network
 264  *
 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
 269  *
 270  * @return boolean success flag
 271  *
 272  * @see jabber_send_presence()
 273  */
 274
 275 function jabber_special_presence($type, $to=null, $show=null, $status=null)
 276 {
 277     // FIXME: why use this instead of jabber_send_presence()?
 278     $conn = jabber_connect();
 279
 280     $to     = htmlspecialchars($to);
 281     $status = htmlspecialchars($status);
 282
 283     $out = "<presence";
 284     if ($to) {
 285         $out .= " to='$to'";
 286     }
 287     if ($type) {
 288         $out .= " type='$type'";
 289     }
 290     if ($show == 'available' and !$status) {
 291         $out .= "/>";
 292     } else {
 293         $out .= ">";
 294         if ($show && ($show != 'available')) {
 295             $out .= "<show>$show</show>";
 296         }
 297         if ($status) {
 298             $out .= "<status>$status</status>";
 299         }
 300         $out .= "</presence>";
 301     }
 302     $conn->send($out);
 303 }
 304
 305 /**
 306  * broadcast a notice to all subscribers and reply recipients
 307  *
 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.
 313  *
 314  * @param Notice $notice The notice to broadcast
 315  *
 316  * @return boolean success flag
 317  */
 318
 319 function jabber_broadcast_notice($notice)
 320 {
 321     if (!common_config('xmpp', 'enabled')) {
 322         return true;
 323     }
 324     $profile = Profile::staticGet($notice->profile_id);
 325
 326     if (!$profile) {
 327         common_log(LOG_WARNING, 'Refusing to broadcast notice with ' .
 328                    'unknown profile ' . common_log_objstring($notice),
 329                    __FILE__);
 330         return false;
 331     }
 332
 333     $msg   = jabber_format_notice($profile, $notice);
 334     $entry = jabber_format_entry($profile, $notice);
 335
 336     $profile->free();
 337     unset($profile);
 338
 339     $sent_to = array();
 340
 341     $conn = jabber_connect();
 342
 343     // First, get users to whom this is a direct reply
 344     $user = new User();
 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 ");
 352
 353     while ($user->fetch()) {
 354         common_log(LOG_INFO,
 355                    'Sending reply notice ' . $notice->id . ' to ' . $user->jabber,
 356                    __FILE__);
 357         $conn->message($user->jabber, $msg, 'chat', null, $entry);
 358         $conn->processTime(0);
 359         $sent_to[$user->id] = 1;
 360     }
 361
 362     $user->free();
 363
 364     // Now, get users subscribed to this profile
 365
 366     $user = new User();
 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 ');
 374
 375     while ($user->fetch()) {
 376         if (!array_key_exists($user->id, $sent_to)) {
 377             common_log(LOG_INFO,
 378                        'Sending notice ' . $notice->id . ' to ' . $user->jabber,
 379                        __FILE__);
 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;
 385         }
 386     }
 387
 388     // Now, get users who have it in their inbox because of groups
 389
 390     $user = new User();
 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 ");
 398
 399     while ($user->fetch()) {
 400         if (!array_key_exists($user->id, $sent_to)) {
 401             common_log(LOG_INFO,
 402                        'Sending notice ' . $notice->id . ' to ' . $user->jabber,
 403                        __FILE__);
 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;
 409         }
 410     }
 411
 412     $user->free();
 413
 414     return true;
 415 }
 416
 417 /**
 418  * send a notice to all public listeners
 419  *
 420  * For notices that are generated on the local system (by users), we can optionally
 421  * forward them to remote listeners by XMPP.
 422  *
 423  * @param Notice $notice notice to broadcast
 424  *
 425  * @return boolean success flag
 426  */
 427
 428 function jabber_public_notice($notice)
 429 {
 430     // Now, users who want everything
 431
 432     $public = common_config('xmpp', 'public');
 433
 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
 437
 438     if ($public && $notice->is_local) {
 439         $profile = Profile::staticGet($notice->profile_id);
 440
 441         if (!$profile) {
 442             common_log(LOG_WARNING, 'Refusing to broadcast notice with ' .
 443                        'unknown profile ' . common_log_objstring($notice),
 444                        __FILE__);
 445             return false;
 446         }
 447
 448         $msg   = jabber_format_notice($profile, $notice);
 449         $entry = jabber_format_entry($profile, $notice);
 450
 451         $conn = jabber_connect();
 452
 453         foreach ($public as $address) {
 454             common_log(LOG_INFO,
 455                        'Sending notice ' . $notice->id .
 456                        ' to public listener ' . $address,
 457                        __FILE__);
 458             $conn->message($address, $msg, 'chat', null, $entry);
 459             $conn->processTime(0);
 460         }
 461         $profile->free();
 462     }
 463
 464     return true;
 465 }
 466
 467 /**
 468  * makes a plain-text formatted version of a notice, suitable for Jabber distribution
 469  *
 470  * @param Profile &$profile profile of the sending user
 471  * @param Notice  &$notice  notice being sent
 472  *
 473  * @return string plain-text version of the notice, with user nickname prefixed
 474  */
 475
 476 function jabber_format_notice(&$profile, &$notice)
 477 {
 478     return $profile->nickname . ': ' . $notice->content;
 479 }