]> git.mxchange.org Git - quix0rs-gnu-social.git/blobdiff - lib/jabber.php
Tickets #2112, 2333, 1677, 2362, 2831: fix AJAX form posting on SSL page views with...
[quix0rs-gnu-social.git] / lib / jabber.php
index 3dcdce5dbf349b87b629e9186bcb98ef519d22a9..cdcfc44232b8f659d325bbedabbc665ae2510e70 100644 (file)
@@ -34,38 +34,197 @@ if (!defined('STATUSNET') && !defined('LACONICA')) {
 require_once 'XMPPHP/XMPP.php';
 
 /**
- * checks whether a string is a syntactically valid Jabber ID (JID)
+ * Splits a Jabber ID (JID) into node, domain, and resource portions.
+ * 
+ * Based on validation routine submitted by:
+ * @copyright 2009 Patrick Georgi <patrick@georgi-clan.de>
+ * @license Licensed under ISC-L, which is compatible with everything else that keeps the copyright notice intact. 
  *
  * @param string $jid string to check
  *
+ * @return array with "node", "domain", and "resource" indices
+ * @throws Exception if input is not valid
+ */
+
+function jabber_split_jid($jid)
+{
+    $chars = '';
+    /* the following definitions come from stringprep, Appendix C,
+       which is used in its entirety by nodeprop, Chapter 5, "Prohibited Output" */
+    /* C1.1 ASCII space characters */
+    $chars .= "\x{20}";
+    /* C1.2 Non-ASCII space characters */
+    $chars .= "\x{a0}\x{1680}\x{2000}-\x{200b}\x{202f}\x{205f}\x{3000a}";
+    /* C2.1 ASCII control characters */
+    $chars .= "\x{00}-\x{1f}\x{7f}";
+    /* C2.2 Non-ASCII control characters */
+    $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}";
+    /* C3 - Private Use */
+    $chars .= "\x{e000}-\x{f8ff}\x{f0000}-\x{ffffd}\x{100000}-\x{10fffd}";
+    /* C4 - Non-character code points */
+    $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}";
+    /* C5 - Surrogate codes */
+    $chars .= "\x{d800}-\x{dfff}";
+    /* C6 - Inappropriate for plain text */
+    $chars .= "\x{fff9}-\x{fffd}";
+    /* C7 - Inappropriate for canonical representation */
+    $chars .= "\x{2ff0}-\x{2ffb}";
+    /* C8 - Change display properties or are deprecated */
+    $chars .= "\x{340}\x{341}\x{200e}\x{200f}\x{202a}-\x{202e}\x{206a}-\x{206f}";
+    /* C9 - Tagging characters */
+    $chars .= "\x{e0001}\x{e0020}-\x{e007f}";
+
+    /* Nodeprep forbids some more characters */
+    $nodeprepchars = $chars;
+    $nodeprepchars .= "\x{22}\x{26}\x{27}\x{2f}\x{3a}\x{3c}\x{3e}\x{40}";
+
+    $parts = explode("/", $jid, 2);
+    if (count($parts) > 1) {
+        $resource = $parts[1];
+        if ($resource == '') {
+            // Warning: empty resource isn't legit.
+            // But if we're normalizing, we may as well take it...
+        }
+    } else {
+        $resource = null;
+    }
+
+    $node = explode("@", $parts[0]);
+    if ((count($node) > 2) || (count($node) == 0)) {
+        throw new Exception("Invalid JID: too many @s");
+    } else if (count($node) == 1) {
+        $domain = $node[0];
+        $node = null;
+    } else {
+        $domain = $node[1];
+        $node = $node[0];
+        if ($node == '') {
+            throw new Exception("Invalid JID: @ but no node");
+        }
+    }
+
+    // Length limits per http://xmpp.org/rfcs/rfc3920.html#addressing
+    if ($node !== null) {
+        if (strlen($node) > 1023) {
+            throw new Exception("Invalid JID: node too long.");
+        }
+        if (preg_match("/[".$nodeprepchars."]/u", $node)) {
+            throw new Exception("Invalid JID node '$node'");
+        }
+    }
+
+    if (strlen($domain) > 1023) {
+        throw new Exception("Invalid JID: domain too long.");
+    }
+    if (!common_valid_domain($domain)) {
+        throw new Exception("Invalid JID domain name '$domain'");
+    }
+
+    if ($resource !== null) {
+        if (strlen($resource) > 1023) {
+            throw new Exception("Invalid JID: resource too long.");
+        }
+        if (preg_match("/[".$chars."]/u", $resource)) {
+            throw new Exception("Invalid JID resource '$resource'");
+        }
+    }
+
+    return array('node' => is_null($node) ? null : mb_strtolower($node),
+                 'domain' => is_null($domain) ? null : mb_strtolower($domain),
+                 'resource' => $resource);
+}
+
+/**
+ * Checks whether a string is a syntactically valid Jabber ID (JID),
+ * either with or without a resource.
+ * 
+ * Note that a bare domain can be a valid JID.
+ * 
+ * @param string $jid string to check
+ * @param bool $check_domain whether we should validate that domain...
+ *
  * @return     boolean whether the string is a valid JID
  */
+function jabber_valid_full_jid($jid, $check_domain=false)
+{
+    try {
+        $parts = jabber_split_jid($jid);
+        if ($check_domain) {
+            if (!jabber_check_domain($parts['domain'])) {
+                return false;
+            }
+        }
+        return $parts['resource'] !== ''; // missing or present; empty ain't kosher
+    } catch (Exception $e) {
+        return false;
+    }
+}
 
-function jabber_valid_base_jid($jid)
+/**
+ * Checks whether a string is a syntactically valid base Jabber ID (JID).
+ * A base JID won't include a resource specifier on the end; since we
+ * take it off when reading input we can't really use them reliably
+ * to direct outgoing messages yet (sorry guys!)
+ * 
+ * Note that a bare domain can be a valid JID.
+ * 
+ * @param string $jid string to check
+ * @param bool $check_domain whether we should validate that domain...
+ *
+ * @return     boolean whether the string is a valid JID
+ */
+function jabber_valid_base_jid($jid, $check_domain=false)
 {
-    // Cheap but effective
-    return Validate::email($jid);
+    try {
+        $parts = jabber_split_jid($jid);
+        if ($check_domain) {
+            if (!jabber_check_domain($parts['domain'])) {
+                return false;
+            }
+        }
+        return ($parts['resource'] === null); // missing; empty ain't kosher
+    } catch (Exception $e) {
+        return false;
+    }
 }
 
 /**
- * normalizes a Jabber ID for comparison
+ * Normalizes a Jabber ID for comparison, dropping the resource component if any.
  *
  * @param string $jid JID to check
+ * @param bool $check_domain if true, reject if the domain isn't findable
  *
  * @return string an equivalent JID in normalized (lowercase) form
  */
 
 function jabber_normalize_jid($jid)
 {
-    if (preg_match("/(?:([^\@]+)\@)?([^\/]+)(?:\/(.*))?$/", $jid, $matches)) {
-        $node   = $matches[1];
-        $server = $matches[2];
-        return strtolower($node.'@'.$server);
-    } else {
+    try {
+        $parts = jabber_split_jid($jid);
+        if ($parts['node'] !== null) {
+            return $parts['node'] . '@' . $parts['domain'];
+        } else {
+            return $parts['domain'];
+        }
+    } catch (Exception $e) {
         return null;
     }
 }
 
+/**
+ * Check if this domain's got some legit DNS record
+ */
+function jabber_check_domain($domain)
+{
+    if (checkdnsrr("_xmpp-server._tcp." . $domain, "SRV")) {
+        return true;
+    }
+    if (checkdnsrr($domain, "ANY")) {
+        return true;
+    }
+    return false;
+}
+
 /**
  * the JID of the Jabber daemon for this StatusNet instance
  *
@@ -86,7 +245,40 @@ class Sharing_XMPP extends XMPPHP_XMPP
 }
 
 /**
- * connect the configured Jabber account to the configured server
+ * Build an XMPP proxy connection that'll save outgoing messages
+ * to the 'xmppout' queue to be picked up by xmppdaemon later.
+ *
+ * If queueing is disabled, we'll grab a live connection.
+ *
+ * @return XMPPHP
+ */
+function jabber_proxy()
+{
+    if (common_config('queue', 'enabled')) {
+           $proxy = new Queued_XMPP(common_config('xmpp', 'host') ?
+                                 common_config('xmpp', 'host') :
+                                 common_config('xmpp', 'server'),
+                                 common_config('xmpp', 'port'),
+                                 common_config('xmpp', 'user'),
+                                 common_config('xmpp', 'password'),
+                                 common_config('xmpp', 'resource') . 'daemon',
+                                 common_config('xmpp', 'server'),
+                                 common_config('xmpp', 'debug') ?
+                                 true : false,
+                                 common_config('xmpp', 'debug') ?
+                                 XMPPHP_Log::LEVEL_VERBOSE :  null);
+        return $proxy;
+    } else {
+        return jabber_connect();
+    }
+}
+
+/**
+ * Lazy-connect the configured Jabber account to the configured server;
+ * if already opened, the same connection will be returned.
+ *
+ * In a multi-site background process, each site configuration
+ * will get its own connection.
  *
  * @param string $resource Resource to connect (defaults to configured resource)
  *
@@ -95,16 +287,19 @@ class Sharing_XMPP extends XMPPHP_XMPP
 
 function jabber_connect($resource=null)
 {
-    static $conn = null;
-    if (!$conn) {
+    static $connections = array();
+    $site = common_config('site', 'server');
+    if (empty($connections[$site])) {
+        if (empty($resource)) {
+            $resource = common_config('xmpp', 'resource');
+        }
         $conn = new Sharing_XMPP(common_config('xmpp', 'host') ?
                                 common_config('xmpp', 'host') :
                                 common_config('xmpp', 'server'),
                                 common_config('xmpp', 'port'),
                                 common_config('xmpp', 'user'),
                                 common_config('xmpp', 'password'),
-                                ($resource) ? $resource :
-                                common_config('xmpp', 'resource'),
+                                $resource,
                                 common_config('xmpp', 'server'),
                                 common_config('xmpp', 'debug') ?
                                 true : false,
@@ -115,12 +310,16 @@ function jabber_connect($resource=null)
         if (!$conn) {
             return false;
         }
+        $connections[$site] = $conn;
 
         $conn->autoSubscribe();
         $conn->useEncryption(common_config('xmpp', 'encryption'));
 
         try {
-            $conn->connect(true); // true = persistent connection
+            common_log(LOG_INFO, __METHOD__ . ": connecting " .
+                common_config('xmpp', 'user') . '/' . $resource);
+            //$conn->connect(true); // true = persistent connection
+            $conn->connect(); // persistent connections break multisite
         } catch (XMPPHP_Exception $e) {
             common_log(LOG_ERR, $e->getMessage());
             return false;
@@ -128,11 +327,11 @@ function jabber_connect($resource=null)
 
         $conn->processUntil('session_start');
     }
-    return $conn;
+    return $connections[$site];
 }
 
 /**
- * send a single notice to a given Jabber address
+ * Queue send for a single notice to a given Jabber address
  *
  * @param string $to     JID to send the notice to
  * @param Notice $notice notice to send
@@ -142,10 +341,7 @@ function jabber_connect($resource=null)
 
 function jabber_send_notice($to, $notice)
 {
-    $conn = jabber_connect();
-    if (!$conn) {
-        return false;
-    }
+    $conn = jabber_proxy();
     $profile = Profile::staticGet($notice->profile_id);
     if (!$profile) {
         common_log(LOG_WARNING, 'Refusing to send notice with ' .
@@ -184,6 +380,11 @@ function jabber_format_entry($profile, $notice)
     } else {
         $xs->raw(common_render_content($notice->content, $notice));
     }
+    $xs->text(" ");
+    $xs->element('a', array(
+        'href'=>common_local_url('conversation',
+            array('id' => $notice->conversation)).'#notice-'.$notice->id
+         ),sprintf(_('[%s]'),$notice->id));
     $xs->elementEnd('body');
     $xs->elementEnd('html');
 
@@ -205,10 +406,7 @@ function jabber_format_entry($profile, $notice)
 
 function jabber_send_message($to, $body, $type='chat', $subject=null)
 {
-    $conn = jabber_connect();
-    if (!$conn) {
-        return false;
-    }
+    $conn = jabber_proxy();
     $conn->message($to, $body, $type, $subject);
     return true;
 }
@@ -303,7 +501,7 @@ function jabber_special_presence($type, $to=null, $show=null, $status=null)
 }
 
 /**
- * broadcast a notice to all subscribers and reply recipients
+ * Queue broadcast of a notice to all subscribers and reply recipients
  *
  * This function will send a notice to all subscribers on the local server
  * who have Jabber addresses, and have Jabber notification enabled, and
@@ -327,7 +525,7 @@ function jabber_broadcast_notice($notice)
         common_log(LOG_WARNING, 'Refusing to broadcast notice with ' .
                    'unknown profile ' . common_log_objstring($notice),
                    __FILE__);
-        return false;
+        return true; // not recoverable; discard.
     }
 
     $msg   = jabber_format_notice($profile, $notice);
@@ -338,84 +536,48 @@ function jabber_broadcast_notice($notice)
 
     $sent_to = array();
 
-    $conn = jabber_connect();
-
-    // First, get users to whom this is a direct reply
-    $user = new User();
-    $UT = common_config('db','type')=='pgsql'?'"user"':'user';
-    $user->query("SELECT $UT.id, $UT.jabber " .
-                 "FROM $UT JOIN reply ON $UT.id = reply.profile_id " .
-                 'WHERE reply.notice_id = ' . $notice->id . ' ' .
-                 "AND $UT.jabber is not null " .
-                 "AND $UT.jabbernotify = 1 " .
-                 "AND $UT.jabberreplies = 1 ");
-
-    while ($user->fetch()) {
-        common_log(LOG_INFO,
-                   'Sending reply notice ' . $notice->id . ' to ' . $user->jabber,
-                   __FILE__);
-        $conn->message($user->jabber, $msg, 'chat', null, $entry);
-        $conn->processTime(0);
-        $sent_to[$user->id] = 1;
-    }
-
-    $user->free();
-
-    // Now, get users subscribed to this profile
+    $conn = jabber_proxy();
 
-    $user = new User();
-    $user->query("SELECT $UT.id, $UT.jabber " .
-                 "FROM $UT JOIN subscription " .
-                 "ON $UT.id = subscription.subscriber " .
-                 'WHERE subscription.subscribed = ' . $notice->profile_id . ' ' .
-                 "AND $UT.jabber is not null " .
-                 "AND $UT.jabbernotify = 1 " .
-                 'AND subscription.jabber = 1 ');
+    $ni = $notice->whoGets();
 
-    while ($user->fetch()) {
-        if (!array_key_exists($user->id, $sent_to)) {
-            common_log(LOG_INFO,
-                       'Sending notice ' . $notice->id . ' to ' . $user->jabber,
-                       __FILE__);
-            $conn->message($user->jabber, $msg, 'chat', null, $entry);
-            // To keep the incoming queue from filling up,
-            // we service it after each send.
-            $conn->processTime(0);
-            $sent_to[$user->id] = 1;
+    foreach ($ni as $user_id => $reason) {
+        $user = User::staticGet($user_id);
+        if (empty($user) ||
+            empty($user->jabber) ||
+            !$user->jabbernotify) {
+            // either not a local user, or just not found
+            continue;
         }
-    }
-
-    // Now, get users who have it in their inbox because of groups
-
-    $user = new User();
-    $user->query("SELECT $UT.id, $UT.jabber " .
-                 "FROM $UT JOIN notice_inbox " .
-                 "ON $UT.id = notice_inbox.user_id " .
-                 'WHERE notice_inbox.notice_id = ' . $notice->id . ' ' .
-                 'AND notice_inbox.source = 2 ' .
-                 "AND $UT.jabber is not null " .
-                 "AND $UT.jabbernotify = 1 ");
-
-    while ($user->fetch()) {
-        if (!array_key_exists($user->id, $sent_to)) {
-            common_log(LOG_INFO,
-                       'Sending notice ' . $notice->id . ' to ' . $user->jabber,
-                       __FILE__);
-            $conn->message($user->jabber, $msg, 'chat', null, $entry);
-            // To keep the incoming queue from filling up,
-            // we service it after each send.
-            $conn->processTime(0);
-            $sent_to[$user->id] = 1;
+        switch ($reason) {
+        case NOTICE_INBOX_SOURCE_REPLY:
+            if (!$user->jabberreplies) {
+                continue 2;
+            }
+            break;
+        case NOTICE_INBOX_SOURCE_SUB:
+            $sub = Subscription::pkeyGet(array('subscriber' => $user->id,
+                                               'subscribed' => $notice->profile_id));
+            if (empty($sub) || !$sub->jabber) {
+                continue 2;
+            }
+            break;
+        case NOTICE_INBOX_SOURCE_GROUP:
+            break;
+        default:
+            throw new Exception(sprintf(_("Unknown inbox source %d."), $reason));
         }
-    }
 
-    $user->free();
+        common_log(LOG_INFO,
+                   'Sending notice ' . $notice->id . ' to ' . $user->jabber,
+                   __FILE__);
+        $conn->message($user->jabber, $msg, 'chat', null, $entry);
+    }
 
     return true;
 }
 
 /**
- * send a notice to all public listeners
+ * Queue send of a notice to all public listeners
  *
  * For notices that are generated on the local system (by users), we can optionally
  * forward them to remote listeners by XMPP.
@@ -435,20 +597,20 @@ function jabber_public_notice($notice)
     // XXX: should we send out non-local messages if public,localonly
     // = false? I think not
 
-    if ($public && $notice->is_local) {
+    if ($public && $notice->is_local == Notice::LOCAL_PUBLIC) {
         $profile = Profile::staticGet($notice->profile_id);
 
         if (!$profile) {
             common_log(LOG_WARNING, 'Refusing to broadcast notice with ' .
                        'unknown profile ' . common_log_objstring($notice),
                        __FILE__);
-            return false;
+            return true; // not recoverable; discard.
         }
 
         $msg   = jabber_format_notice($profile, $notice);
         $entry = jabber_format_entry($profile, $notice);
 
-        $conn = jabber_connect();
+        $conn = jabber_proxy();
 
         foreach ($public as $address) {
             common_log(LOG_INFO,
@@ -456,7 +618,6 @@ function jabber_public_notice($notice)
                        ' to public listener ' . $address,
                        __FILE__);
             $conn->message($address, $msg, 'chat', null, $entry);
-            $conn->processTime(0);
         }
         $profile->free();
     }
@@ -475,5 +636,5 @@ function jabber_public_notice($notice)
 
 function jabber_format_notice(&$profile, &$notice)
 {
-    return $profile->nickname . ': ' . $notice->content;
+    return $profile->nickname . ': ' . $notice->content . ' [' . $notice->id . ']';
 }