]> git.mxchange.org Git - quix0rs-gnu-social.git/blobdiff - plugins/Xmpp/XmppPlugin.php
Merge remote-tracking branch 'upstream/master' into social-master
[quix0rs-gnu-social.git] / plugins / Xmpp / XmppPlugin.php
index 20025417824e0126741cff6aad11e1d071cc9c72..7112b8b63eaeb8013bf24be41ff05047ab8b1b33 100644 (file)
@@ -44,13 +44,12 @@ if (!defined('STATUSNET')) {
  * @license   http://www.fsf.org/licensing/licenses/agpl-3.0.html AGPL 3.0
  * @link      http://status.net/
  */
-
 class XmppPlugin extends ImPlugin
 {
     public $server = null;
     public $port = 5222;
     public $user =  'update';
-    public $resource = null;
+    public $resource = 'gnusocial';
     public $encryption = true;
     public $password = null;
     public $host = null;  // only set if != server
@@ -59,22 +58,22 @@ class XmppPlugin extends ImPlugin
     public $transport = 'xmpp';
 
     function getDisplayName(){
-        return _m('XMPP/Jabber/GTalk');
+        // TRANS: Plugin display name.
+        return _m('XMPP/Jabber');
     }
 
     /**
      * 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. 
+     * @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
      */
-
     protected function splitJid($jid)
     {
         $chars = '';
@@ -102,11 +101,11 @@ class XmppPlugin extends ImPlugin
         $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];
@@ -117,10 +116,11 @@ class XmppPlugin extends ImPlugin
         } else {
             $resource = null;
         }
-    
+
         $node = explode("@", $parts[0]);
         if ((count($node) > 2) || (count($node) == 0)) {
-            throw new Exception("Invalid JID: too many @s");
+            // TRANS: Exception thrown when using too many @ signs in a Jabber ID.
+            throw new Exception(_m('Invalid JID: too many @s.'));
         } else if (count($node) == 1) {
             $domain = $node[0];
             $node = null;
@@ -128,47 +128,57 @@ class XmppPlugin extends ImPlugin
             $domain = $node[1];
             $node = $node[0];
             if ($node == '') {
-                throw new Exception("Invalid JID: @ but no node");
+            // TRANS: Exception thrown when using @ sign not followed by a Jabber ID.
+                throw new Exception(_m('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.");
+                // TRANS: Exception thrown when using too long a Jabber ID (>1023).
+                throw new Exception(_m('Invalid JID: node too long.'));
             }
             if (preg_match("/[".$nodeprepchars."]/u", $node)) {
-                throw new Exception("Invalid JID node '$node'");
+                // TRANS: Exception thrown when using an invalid Jabber ID.
+                // TRANS: %s is the invalid Jabber ID.
+                throw new Exception(sprintf(_m('Invalid JID node "%s".'),$node));
             }
         }
-    
+
         if (strlen($domain) > 1023) {
-            throw new Exception("Invalid JID: domain too long.");
+            // TRANS: Exception thrown when using too long a Jabber domain (>1023).
+            throw new Exception(_m('Invalid JID: domain too long.'));
         }
         if (!common_valid_domain($domain)) {
-            throw new Exception("Invalid JID domain name '$domain'");
+            // TRANS: Exception thrown when using an invalid Jabber domain name.
+            // TRANS: %s is the invalid domain name.
+            throw new Exception(sprintf(_m('Invalid JID domain name "%s".'),$domain));
         }
-    
+
         if ($resource !== null) {
             if (strlen($resource) > 1023) {
+                // TRANS: Exception thrown when using too long a resource (>1023).
                 throw new Exception("Invalid JID: resource too long.");
             }
             if (preg_match("/[".$chars."]/u", $resource)) {
-                throw new Exception("Invalid JID resource '$resource'");
+                // TRANS: Exception thrown when using an invalid Jabber resource.
+                // TRANS: %s is the invalid resource.
+                throw new Exception(sprintf(_m('Invalid JID resource "%s".'),$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...
      *
@@ -188,15 +198,15 @@ class XmppPlugin extends ImPlugin
             return false;
         }
     }
-    
+
     /**
      * 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...
      *
@@ -225,7 +235,6 @@ class XmppPlugin extends ImPlugin
      *
      * @return string an equivalent JID in normalized (lowercase) form
      */
-
     function normalize($jid)
     {
         try {
@@ -287,40 +296,28 @@ class XmppPlugin extends ImPlugin
         case 'XMPPHP_XMPP':
             require_once $dir . '/extlib/XMPPHP/XMPP.php';
             return false;
-        case 'Sharing_XMPP':
-        case 'Queued_XMPP':
-            require_once $dir . '/'.$cls.'.php';
-            return false;
-        case 'XmppManager':
-            require_once $dir . '/'.strtolower($cls).'.php';
-            return false;
-        default:
-            return true;
         }
+
+        return parent::onAutoload($cls);
     }
 
     function onStartImDaemonIoManagers(&$classes)
     {
-        parent::onStartImDaemonIoManagers(&$classes);
+        parent::onStartImDaemonIoManagers($classes);
         $classes[] = new XmppManager($this); // handles pings/reconnects
         return true;
     }
 
-    function microiduri($screenname)
-    {
-        return 'xmpp:' . $screenname;    
-    }
-
     function sendMessage($screenname, $body)
     {
         $this->queuedConnection()->message($screenname, $body, 'chat');
     }
 
-    function sendNotice($screenname, $notice)
+    function sendNotice($screenname, Notice $notice)
     {
         $msg   = $this->formatNotice($notice);
         $entry = $this->format_entry($notice);
-        
+
         $this->queuedConnection()->message($screenname, $msg, 'chat', null, $entry);
         return true;
     }
@@ -333,8 +330,7 @@ class XmppPlugin extends ImPlugin
      *
      * @return string Extra information (Atom, HTML, addresses) in string format
      */
-
-    function format_entry($notice)
+    protected function format_entry(Notice $notice)
     {
         $profile = $notice->getProfile();
 
@@ -343,19 +339,31 @@ class XmppPlugin extends ImPlugin
         $xs = new XMLStringer();
         $xs->elementStart('html', array('xmlns' => 'http://jabber.org/protocol/xhtml-im'));
         $xs->elementStart('body', array('xmlns' => 'http://www.w3.org/1999/xhtml'));
-        $xs->element('a', array('href' => $profile->profileurl),
-                     $profile->nickname);
-        $xs->text(": ");
-        if (!empty($notice->rendered)) {
-            $xs->raw($notice->rendered);
-        } else {
-            $xs->raw(common_render_content($notice->content, $notice));
+        $xs->element('a', array('href' => $profile->profileurl), $profile->nickname);
+        try {
+            $parent = $notice->getParent();
+            $orig_profile = $parent->getProfile();
+            $orig_profurl = $orig_profile->getUrl();
+            $xs->text(" => ");
+            $xs->element('a', array('href' => $orig_profurl), $orig_profile->nickname);
+            $xs->text(": ");
+        } catch (InvalidUrlException $e) {
+            $xs->text(sprintf(' => %s', $orig_profile->nickname));
+        } catch (NoParentNoticeException $e) {
+            $xs->text(": ");
+        } catch (NoResultException $e) {
+            // Parent notice was probably deleted.
+            $xs->text(": ");
         }
+        // FIXME: Why do we replace \t with ''? is it just to make it pretty? shouldn't whitespace be handled well...?
+        $xs->raw(str_replace("\t", "", $notice->getRendered()));
         $xs->text(" ");
         $xs->element('a', array(
             'href'=>common_local_url('conversation',
-                array('id' => $notice->conversation)).'#notice-'.$notice->id
-             ),sprintf(_('[%s]'),$notice->id));
+                array('id' => $notice->conversation)).'#notice-'.$notice->id),
+             // TRANS: Link description to notice in conversation.
+             // TRANS: %s is a notice ID.
+             sprintf(_m('[%u]'),$notice->id));
         $xs->elementEnd('body');
         $xs->elementEnd('html');
 
@@ -370,41 +378,45 @@ class XmppPlugin extends ImPlugin
 
         if ($pl['type'] != 'chat') {
             $this->log(LOG_WARNING, "Ignoring message of type ".$pl['type']." from $from: " . $pl['xml']->toString());
-            return;
+            return true;
         }
 
         if (mb_strlen($pl['body']) == 0) {
             $this->log(LOG_WARNING, "Ignoring message with empty body from $from: "  . $pl['xml']->toString());
-            return;
+            return true;
         }
 
         $this->handleIncoming($from, $pl['body']);
-        
+
         return true;
     }
 
     /**
      * Build a queue-proxied XMPP interface object. Any outgoing messages
      * will be run back through us for enqueing rather than sent directly.
-     * 
-     * @return Queued_XMPP
+     *
+     * @return QueuedXMPP
      * @throws Exception if server settings are invalid.
      */
     function queuedConnection(){
         if(!isset($this->server)){
-            throw new Exception("must specify a server");
+            // TRANS: Exception thrown when the plugin configuration is incorrect.
+            throw new Exception(_m('You must specify a server in the configuration.'));
         }
         if(!isset($this->port)){
-            throw new Exception("must specify a port");
+            // TRANS: Exception thrown when the plugin configuration is incorrect.
+            throw new Exception(_m('You must specify a port in the configuration.'));
         }
         if(!isset($this->user)){
-            throw new Exception("must specify a user");
+            // TRANS: Exception thrown when the plugin configuration is incorrect.
+            throw new Exception(_m('You must specify a user in the configuration.'));
         }
         if(!isset($this->password)){
-            throw new Exception("must specify a password");
+            // TRANS: Exception thrown when the plugin configuration is incorrect.
+            throw new Exception(_m('You must specify a password in the configuration.'));
         }
 
-        return new Queued_XMPP($this, $this->host ?
+        return new QueuedXMPP($this, $this->host ?
                                     $this->host :
                                     $this->server,
                                     $this->port,
@@ -419,13 +431,39 @@ class XmppPlugin extends ImPlugin
                                     );
     }
 
-    function onPluginVersion(&$versions)
+    /**
+     * Add XMPP plugin daemon to the list of daemon to start
+     *
+     * @param array $daemons the list of daemons to run
+     *
+     * @return boolean hook return
+     */
+    function onGetValidDaemons(array &$daemons)
+    {
+        if( isset($this->server) &&
+            isset($this->port)   &&
+            isset($this->user)   &&
+            isset($this->password) ){
+
+            array_push(
+                $daemons,
+                INSTALLDIR
+                . '/scripts/imdaemon.php'
+            );
+        }
+
+        return true;
+    }
+
+
+    function onPluginVersion(array &$versions)
     {
         $versions[] = array('name' => 'XMPP',
-                            'version' => STATUSNET_VERSION,
+                            'version' => GNUSOCIAL_VERSION,
                             'author' => 'Craig Andrews, Evan Prodromou',
                             'homepage' => 'http://status.net/wiki/Plugin:XMPP',
                             'rawdescription' =>
+                            // TRANS: Plugin description.
                             _m('The XMPP plugin allows users to send and receive notices over the XMPP/Jabber network.'));
         return true;
     }