XmppPlugin.php

   1 <?php
   2 /**
   3  * StatusNet - the distributed open-source microblogging tool
   4  * Copyright (C) 2009, StatusNet, Inc.
   5  *
   6  * Send and receive notices using the XMPP network
   7  *
   8  * PHP version 7
   9  *
  10  * This program is free software: you can redistribute it and/or modify
  11  * it under the terms of the GNU Affero General Public License as published by
  12  * the Free Software Foundation, either version 3 of the License, or
  13  * (at your option) any later version.
  14  *
  15  * This program is distributed in the hope that it will be useful,
  16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  18  * GNU Affero General Public License for more details.
  19  *
  20  * You should have received a copy of the GNU Affero General Public License
  21  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  22  *
  23  * @category  IM
  24  * @package   StatusNet
  25  * @author    Evan Prodromou <evan@status.net>
  26  * @copyright 2009 StatusNet, Inc.
  27  * @license   http://www.fsf.org/licensing/licenses/agpl-3.0.html AGPL 3.0
  28  * @link      http://status.net/
  29  */
  30
  31 if (!defined('STATUSNET')) {
  32     // This check helps protect against security problems;
  33     // your code file can't be executed directly from the web.
  34     exit(1);
  35 }
  36
  37 /**
  38  * Plugin for XMPP
  39  *
  40  * @category  Plugin
  41  * @package   StatusNet
  42  * @author    Evan Prodromou <evan@status.net>
  43  * @copyright 2009 StatusNet, Inc.
  44  * @license   http://www.fsf.org/licensing/licenses/agpl-3.0.html AGPL 3.0
  45  * @link      http://status.net/
  46  */
  47 class XmppPlugin extends ImPlugin
  48 {
  49     const PLUGIN_VERSION = '2.0.0';
  50
  51     public $server = null;
  52     public $port = 5222;
  53     public $user = 'update';
  54     public $resource = 'gnusocial';
  55     public $encryption = true;
  56     public $password = null;
  57     public $host = null;  // only set if != server
  58     public $debug = false; // print extra debug info
  59
  60     public $transport = 'xmpp';
  61
  62     function getDisplayName()
  63     {
  64         // TRANS: Plugin display name.
  65         return _m('XMPP/Jabber');
  66     }
  67
  68     function daemonScreenname()
  69     {
  70         $ret = $this->user . '@' . $this->server;
  71         if ($this->resource) {
  72             return $ret . '/' . $this->resource;
  73         } else {
  74             return $ret;
  75         }
  76     }
  77
  78     function validate($screenname)
  79     {
  80         return $this->validateBaseJid($screenname, common_config('email', 'check_domain'));
  81     }
  82
  83     /**
  84      * Checks whether a string is a syntactically valid base Jabber ID (JID).
  85      * A base JID won't include a resource specifier on the end; since we
  86      * take it off when reading input we can't really use them reliably
  87      * to direct outgoing messages yet (sorry guys!)
  88      *
  89      * Note that a bare domain can be a valid JID.
  90      *
  91      * @param string $jid string to check
  92      * @param bool $check_domain whether we should validate that domain...
  93      *
  94      * @return     boolean whether the string is a valid JID
  95      */
  96     protected function validateBaseJid($jid, $check_domain = false)
  97     {
  98         try {
  99             $parts = $this->splitJid($jid);
 100             if ($check_domain) {
 101                 if (!$this->checkDomain($parts['domain'])) {
 102                     return false;
 103                 }
 104             }
 105             return ($parts['resource'] === null); // missing; empty ain't kosher
 106         } catch (Exception $e) {
 107             return false;
 108         }
 109     }
 110
 111     /**
 112      * Splits a Jabber ID (JID) into node, domain, and resource portions.
 113      *
 114      * Based on validation routine submitted by:
 115      * @param string $jid string to check
 116      *
 117      * @return array with "node", "domain", and "resource" indices
 118      * @throws Exception if input is not valid
 119      * @license Licensed under ISC-L, which is compatible with everything else that keeps the copyright notice intact.
 120      *
 121      * @copyright 2009 Patrick Georgi <patrick@georgi-clan.de>
 122      */
 123     protected function splitJid($jid)
 124     {
 125         $chars = '';
 126         /* the following definitions come from stringprep, Appendix C,
 127            which is used in its entirety by nodeprop, Chapter 5, "Prohibited Output" */
 128         /* C1.1 ASCII space characters */
 129         $chars .= "\x{20}";
 130         /* C1.2 Non-ASCII space characters */
 131         $chars .= "\x{a0}\x{1680}\x{2000}-\x{200b}\x{202f}\x{205f}\x{3000a}";
 132         /* C2.1 ASCII control characters */
 133         $chars .= "\x{00}-\x{1f}\x{7f}";
 134         /* C2.2 Non-ASCII control characters */
 135         $chars .= "\x{80}-\x{9f}\x{6dd}\x{70f}\x{180e}\x{200c}\x{200d}\x{2028}\x{2029}\x{2060}-\x{2063}\x{206a}-\x{206f}\x{feff}\x{fff9}-\x{fffc}\x{1d173}-\x{1d17a}";
 136         /* C3 - Private Use */
 137         $chars .= "\x{e000}-\x{f8ff}\x{f0000}-\x{ffffd}\x{100000}-\x{10fffd}";
 138         /* C4 - Non-character code points */
 139         $chars .= "\x{fdd0}-\x{fdef}\x{fffe}\x{ffff}\x{1fffe}\x{1ffff}\x{2fffe}\x{2ffff}\x{3fffe}\x{3ffff}\x{4fffe}\x{4ffff}\x{5fffe}\x{5ffff}\x{6fffe}\x{6ffff}\x{7fffe}\x{7ffff}\x{8fffe}\x{8ffff}\x{9fffe}\x{9ffff}\x{afffe}\x{affff}\x{bfffe}\x{bffff}\x{cfffe}\x{cffff}\x{dfffe}\x{dffff}\x{efffe}\x{effff}\x{ffffe}\x{fffff}\x{10fffe}\x{10ffff}";
 140         /* C5 - Surrogate codes */
 141         // We can't use preg_match to check this, fix below
 142         // $chars .= "\x{d800}-\x{dfff}";
 143         /* C6 - Inappropriate for plain text */
 144         $chars .= "\x{fff9}-\x{fffd}";
 145         /* C7 - Inappropriate for canonical representation */
 146         $chars .= "\x{2ff0}-\x{2ffb}";
 147         /* C8 - Change display properties or are deprecated */
 148         $chars .= "\x{340}\x{341}\x{200e}\x{200f}\x{202a}-\x{202e}\x{206a}-\x{206f}";
 149         /* C9 - Tagging characters */
 150         $chars .= "\x{e0001}\x{e0020}-\x{e007f}";
 151
 152         /* Nodeprep forbids some more characters */
 153         $nodeprepchars = $chars;
 154         $nodeprepchars .= "\x{22}\x{26}\x{27}\x{2f}\x{3a}\x{3c}\x{3e}\x{40}";
 155
 156         $parts = explode("/", $jid, 2);
 157         if (count($parts) > 1) {
 158             $resource = $parts[1];
 159             // if ($resource == '') then
 160             // Warning: empty resource isn't legit.
 161             // But if we're normalizing, we may as well take it...
 162         } else {
 163             $resource = null;
 164         }
 165
 166         $node = explode("@", $parts[0]);
 167         if ((count($node) > 2) || (count($node) == 0)) {
 168             // TRANS: Exception thrown when using too many @ signs in a Jabber ID.
 169             throw new Exception(_m('Invalid JID: too many @s.'));
 170         } else if (count($node) == 1) {
 171             $domain = $node[0];
 172             $node = null;
 173         } else {
 174             $domain = $node[1];
 175             $node = $node[0];
 176             if ($node == '') {
 177                 // TRANS: Exception thrown when using @ sign not followed by a Jabber ID.
 178                 throw new Exception(_m('Invalid JID: @ but no node'));
 179             }
 180         }
 181
 182         if ($node !== null) {
 183             // Length limits per http://xmpp.org/rfcs/rfc3920.html#addressing
 184             if (strlen($node) > 1023) {
 185                 // TRANS: Exception thrown when using too long a Jabber ID (>1023).
 186                 throw new Exception(_m('Invalid JID: node too long.'));
 187             }
 188             // C5 - Surrogate codes is ensured by encoding check
 189             if (preg_match("/[" . $nodeprepchars . "]/u", $node) || mb_detect_encoding($node, 'UTF-8', true) != 'UTF-8') {
 190                 // TRANS: Exception thrown when using an invalid Jabber ID.
 191                 // TRANS: %s is the invalid Jabber ID.
 192                 throw new Exception(sprintf(_m('Invalid JID node "%s".'), $node));
 193             }
 194         }
 195
 196         if (strlen($domain) > 1023) {
 197             // TRANS: Exception thrown when using too long a Jabber domain (>1023).
 198             throw new Exception(_m('Invalid JID: domain too long.'));
 199         }
 200         if (!common_valid_domain($domain)) {
 201             // TRANS: Exception thrown when using an invalid Jabber domain name.
 202             // TRANS: %s is the invalid domain name.
 203             throw new Exception(sprintf(_m('Invalid JID domain name "%s".'), $domain));
 204         }
 205
 206         if ($resource !== null) {
 207             if (strlen($resource) > 1023) {
 208                 // TRANS: Exception thrown when using too long a resource (>1023).
 209                 throw new Exception("Invalid JID: resource too long.");
 210             }
 211             if (preg_match("/[" . $chars . "]/u", $resource)) {
 212                 // TRANS: Exception thrown when using an invalid Jabber resource.
 213                 // TRANS: %s is the invalid resource.
 214                 throw new Exception(sprintf(_m('Invalid JID resource "%s".'), $resource));
 215             }
 216         }
 217
 218         return array('node' => is_null($node) ? null : mb_strtolower($node),
 219             'domain' => is_null($domain) ? null : mb_strtolower($domain),
 220             'resource' => $resource);
 221     }
 222
 223     /**
 224      * Check if this domain's got some legit DNS record
 225      * @param $domain
 226      * @return bool
 227      */
 228     protected function checkDomain($domain)
 229     {
 230         if (checkdnsrr("_xmpp-server._tcp." . $domain, "SRV")) {
 231             return true;
 232         }
 233         if (checkdnsrr($domain, "ANY")) {
 234             return true;
 235         }
 236         return false;
 237     }
 238
 239     /**
 240      * Load related modules when needed
 241      *
 242      * @param string $cls Name of the class to be loaded
 243      *
 244      * @return boolean hook value; true means continue processing, false means stop.
 245      */
 246
 247     function onAutoload($cls)
 248     {
 249         switch ($cls) {
 250             case 'XMPPHP_XMPP':
 251                 require_once __DIR__ . '/extlib/XMPPHP/XMPP.php';
 252                 return false;
 253         }
 254
 255         return parent::onAutoload($cls);
 256     }
 257
 258     function onStartImDaemonIoManagers(&$classes)
 259     {
 260         parent::onStartImDaemonIoManagers($classes);
 261         $classes[] = new XmppManager($this); // handles pings/reconnects
 262         return true;
 263     }
 264
 265     function sendMessage($screenname, $body)
 266     {
 267         $this->queuedConnection()->message($screenname, $body, 'chat');
 268     }
 269
 270     /**
 271      * Build a queue-proxied XMPP interface object. Any outgoing messages
 272      * will be run back through us for enqueing rather than sent directly.
 273      *
 274      * @return QueuedXMPP
 275      * @throws Exception if server settings are invalid.
 276      */
 277     function queuedConnection()
 278     {
 279         if (!isset($this->server)) {
 280             // TRANS: Exception thrown when the plugin configuration is incorrect.
 281             throw new Exception(_m('You must specify a server in the configuration.'));
 282         }
 283         if (!isset($this->port)) {
 284             // TRANS: Exception thrown when the plugin configuration is incorrect.
 285             throw new Exception(_m('You must specify a port in the configuration.'));
 286         }
 287         if (!isset($this->user)) {
 288             // TRANS: Exception thrown when the plugin configuration is incorrect.
 289             throw new Exception(_m('You must specify a user in the configuration.'));
 290         }
 291         if (!isset($this->password)) {
 292             // TRANS: Exception thrown when the plugin configuration is incorrect.
 293             throw new Exception(_m('You must specify a password in the configuration.'));
 294         }
 295
 296         return new QueuedXMPP($this, $this->host ?
 297             $this->host :
 298             $this->server,
 299             $this->port,
 300             $this->user,
 301             $this->password,
 302             $this->resource,
 303             $this->server,
 304             $this->debug ?
 305                 true : false,
 306             $this->debug ?
 307                 \XMPPHP\Log::LEVEL_VERBOSE : null
 308         );
 309     }
 310
 311     function sendNotice($screenname, Notice $notice)
 312     {
 313         try {
 314             $msg = $this->formatNotice($notice);
 315             $entry = $this->format_entry($notice);
 316         } catch (Exception $e) {
 317             common_log(LOG_ERR, __METHOD__ . ": Discarding outgoing stanza because of exception: {$e->getMessage()}");
 318             return false;   // return value of sendNotice is never actually used as of now
 319         }
 320         $this->queuedConnection()->message($screenname, $msg, 'chat', null, $entry);
 321         return true;
 322     }
 323
 324     /**
 325      * extra information for XMPP messages, as defined by Twitter
 326      *
 327      * @param Notice $notice Notice being sent
 328      *
 329      * @return string Extra information (Atom, HTML, addresses) in string format
 330      */
 331     protected function format_entry(Notice $notice)
 332     {
 333         $profile = $notice->getProfile();
 334
 335         $entry = $notice->asAtomEntry(true, true);
 336
 337         $xs = new XMLStringer();
 338         $xs->elementStart('html', array('xmlns' => 'http://jabber.org/protocol/xhtml-im'));
 339         $xs->elementStart('body', array('xmlns' => 'http://www.w3.org/1999/xhtml'));
 340         $xs->element('a', array('href' => $profile->profileurl), $profile->nickname);
 341         try {
 342             $parent = $notice->getParent();
 343             $orig_profile = $parent->getProfile();
 344             $orig_profurl = $orig_profile->getUrl();
 345             $xs->text(" => ");
 346             $xs->element('a', array('href' => $orig_profurl), $orig_profile->nickname);
 347             $xs->text(": ");
 348         } catch (NoParentNoticeException $e) {
 349             $xs->text(": ");
 350         }
 351         // FIXME: Why do we replace \t with ''? is it just to make it pretty? shouldn't whitespace be handled well...?
 352         $xs->raw(str_replace("\t", "", $notice->getRendered()));
 353         $xs->text(" ");
 354         $xs->element('a', array(
 355             'href' => common_local_url('conversation',
 356                     array('id' => $notice->conversation)) . '#notice-' . $notice->id),
 357             // TRANS: Link description to notice in conversation.
 358             // TRANS: %s is a notice ID.
 359             sprintf(_m('[%u]'), $notice->id));
 360         $xs->elementEnd('body');
 361         $xs->elementEnd('html');
 362
 363         $html = $xs->getString();
 364
 365         return $html . ' ' . $entry;
 366     }
 367
 368     function receiveRawMessage($pl)
 369     {
 370         $from = $this->normalize($pl['from']);
 371
 372         if ($pl['type'] != 'chat') {
 373             $this->log(LOG_WARNING, "Ignoring message of type " . $pl['type'] . " from $from: " . $pl['xml']->toString());
 374             return true;
 375         }
 376
 377         if (mb_strlen($pl['body']) == 0) {
 378             $this->log(LOG_WARNING, "Ignoring message with empty body from $from: " . $pl['xml']->toString());
 379             return true;
 380         }
 381
 382         $this->handleIncoming($from, $pl['body']);
 383
 384         return true;
 385     }
 386
 387     /**
 388      * Normalizes a Jabber ID for comparison, dropping the resource component if any.
 389      *
 390      * @param string $jid JID to check
 391      * @return string an equivalent JID in normalized (lowercase) form
 392      */
 393     function normalize($jid)
 394     {
 395         try {
 396             $parts = $this->splitJid($jid);
 397             if ($parts['node'] !== null) {
 398                 return $parts['node'] . '@' . $parts['domain'];
 399             } else {
 400                 return $parts['domain'];
 401             }
 402         } catch (Exception $e) {
 403             return null;
 404         }
 405     }
 406
 407     /**
 408      * Add XMPP plugin daemon to the list of daemon to start
 409      *
 410      * @param array $daemons the list of daemons to run
 411      *
 412      * @return boolean hook return
 413      */
 414     function onGetValidDaemons(&$daemons)
 415     {
 416         if (isset($this->server) &&
 417             isset($this->port) &&
 418             isset($this->user) &&
 419             isset($this->password)) {
 420
 421             array_push(
 422                 $daemons,
 423                 INSTALLDIR
 424                 . '/scripts/imdaemon.php'
 425             );
 426         }
 427
 428         return true;
 429     }
 430
 431     /**
 432      * Plugin Nodeinfo information
 433      *
 434      * @param array $protocols
 435      * @return bool hook true
 436      */
 437     public function onNodeInfoProtocols(array &$protocols)
 438     {
 439         $protocols[] = "xmpp";
 440         return true;
 441     }
 442
 443     function onPluginVersion(array &$versions)
 444     {
 445         $versions[] = array('name' => 'XMPP',
 446             'version' => self::PLUGIN_VERSION,
 447             'author' => 'Craig Andrews, Evan Prodromou',
 448             'homepage' => 'https://git.gnu.io/gnu/gnu-social/tree/master/plugins/XMPP',
 449             'rawdescription' =>
 450             // TRANS: Plugin description.
 451                 _m('The XMPP plugin allows users to send and receive notices over the XMPP/Jabber network.'));
 452         return true;
 453     }
 454
 455     /**
 456      * Checks whether a string is a syntactically valid Jabber ID (JID),
 457      * either with or without a resource.
 458      *
 459      * Note that a bare domain can be a valid JID.
 460      *
 461      * @param string $jid string to check
 462      * @param bool $check_domain whether we should validate that domain...
 463      *
 464      * @return     boolean whether the string is a valid JID
 465      */
 466     protected function validateFullJid($jid, $check_domain = false)
 467     {
 468         try {
 469             $parts = $this->splitJid($jid);
 470             if ($check_domain) {
 471                 if (!$this->checkDomain($parts['domain'])) {
 472                     return false;
 473                 }
 474             }
 475             return $parts['resource'] !== ''; // missing or present; empty ain't kosher
 476         } catch (Exception $e) {
 477             return false;
 478         }
 479     }
 480 }
 481