Implementation and tests for XMPP service discovery and XMPP ping.

These are basic implementations of the representative iq messages for each
type of service and do not include any additional parsing or timer
handling (for ping).

Change-Id: I9d3eece8092a3ced347ab0ed04efa171109a9ba3
Signed-off-by: Robert Cole <[email protected]>
Reviewed-on: https://gerrit.iotivity.org/gerrit/1184
Reviewed-by: Charlie Lenahan <[email protected]>
Reviewed-by: Erich Keane <[email protected]>
Tested-by: Erich Keane <[email protected]>

Author: Robert Cole

WinDT/CCFXmpp_Tests/CCFXmpp_Tests.vcxproj

@@ -277,6 +277,7 @@ xcopy /y /d "$(SolutionDir)\packages\libssh2.redist.1.4.3.1\build\native\bin\v11
   </ItemDefinitionGroup>
   <ItemGroup>
     <ClInclude Include="..\..\test\xmpp_connect_config.h" />
+    <ClInclude Include="..\..\test\xmpp_connect_establish.h" />
     <ClInclude Include="..\..\test\xmpp_dummy_server.h" />
     <ClInclude Include="..\..\test\xmpp_test_config.h" />
     <ClInclude Include="stdafx.h" />
@@ -302,6 +303,7 @@ xcopy /y /d "$(SolutionDir)\packages\libssh2.redist.1.4.3.1\build\native\bin\v11
     <ClCompile Include="..\..\test\unittest_base.cpp" />
     <ClCompile Include="..\..\test\xmpp_compliance_tests.cpp" />
     <ClCompile Include="..\..\test\xmpp_connect_config.cpp" />
+    <ClCompile Include="..\..\test\xmpp_connect_establish.cpp" />
     <ClCompile Include="..\..\test\xmpp_dummy_server.cpp" />
     <ClCompile Include="..\..\test\xmpp_tests.cpp" />
     <ClCompile Include="stdafx.cpp">

WinDT/CCFXmpp_Tests/CCFXmpp_Tests.vcxproj.filters

@@ -30,6 +30,9 @@
     <ClInclude Include="..\..\test\xmpp_connect_config.h">
       <Filter>Header Files</Filter>
     </ClInclude>
+    <ClInclude Include="..\..\test\xmpp_connect_establish.h">
+      <Filter>Header Files</Filter>
+    </ClInclude>
   </ItemGroup>
   <ItemGroup>
     <ClCompile Include="stdafx.cpp">
@@ -77,6 +80,9 @@
     <ClCompile Include="..\..\test\xmpp_connect_config.cpp">
       <Filter>Source Files</Filter>
     </ClCompile>
+    <ClCompile Include="..\..\test\xmpp_connect_establish.cpp">
+      <Filter>Source Files</Filter>
+    </ClCompile>
   </ItemGroup>
   <ItemGroup>
     <None Include="packages.config" />

src/xmpp/xmppclient.cpp

@@ -39,14 +39,44 @@
 #include "../xmpp/xmppconfig.h"
 #include "../xmpp/jabberid.h"
 
+
 // TOOD: Move interface when refactoring for BOSH 'streams'
 #include "../connect/tcpclient.h"
 
 #include <iostream>
 
 
 
+
+/// @mainpage Iotivity XMPP Client
+///
+/// @section intro Introduction
+///
+/// The Iotivity XMPP Client is a basic C++ XMPP client implementation written to provide
+/// cross-platform support for XMPP for Iotivity and the CCF project.
+///
+/// @section XMPP Support
+///
+/// <ul>
+///     <li>RFC 6120 (XMPP Core)</li>
+///     <li>SASL
+///         <ul>
+///             <li>RFC 4616 (PLAIN)</li>
+///         </ul>
+///     </li>
+///     <li>XMPP Extensions
+///         <ul>
+///             <li>XEP-0077 (In-Band Registration)</li>
+///             <li>XEP-0030 (Service-Discovery) [Basic queries only]</li>
+///             <li>XEP-0199 (XMPP Ping) [Timer-based ping/pong still a WIP]</li>
+///        </ul>
+///     </li>
+/// </ul>
+
+
+
 /// @addtogroup XMPP
+/// @{
 /// Create and start an XMPP client:
 /// @code
 ///
@@ -101,30 +131,7 @@
 /// {}
 ///
 /// @endcode
-
-
-/// @mainpage Iotivity XMPP Client
-///
-/// @section intro Introduction
-///
-/// The Iotivity XMPP Client is a basic C++ XMPP client implementation written to provide
-/// cross-platform support for XMPP for Iotivity and the CCF project.
-///
-/// @section XMPP Support
-///
-/// <ul>
-///     <li>RFC 6120 (XMPP Core)</li>
-///     <li>SASL
-///         <ul>
-///             <li>RFC 4616 (PLAIN)</li>
-///         </ul>
-///     </li>
-///     <li>XMPP Extensions
-///         <ul>
-///             <li>XEP-0077 (In-Band Registration)</li>
-///        </ul>
-///     </li>
-/// </ul>
+/// @}
 
 
 
@@ -234,7 +241,7 @@ namespace Iotivity
             }
         }
 
-      //  const static size_t DEFAULT_BUFFER_SIZE = 4096;
+        //  const static size_t DEFAULT_BUFFER_SIZE = 4096;
 
         void XmppConnection::receive(XMLElement::Ptr &payload)
         {
@@ -987,6 +994,7 @@ namespace Iotivity
                                         onConnected().fire(XmppConnectedEvent(
                                                                connect_error::SUCCESS));
                                         m_boundPromise.set_value(m_boundJabberId);
+                                        m_negotiatedPromise.set_value();
                                     }
                                     else
                                     {
@@ -1486,7 +1494,7 @@ namespace Iotivity
         // Action runner for the XMPP client.
         struct XmppClientRunner: public ActionRunner<std::shared_ptr<IXmppConnection>, XmppContext>
         {
-                XmppClientRunner(XmppClient &owner) /*: m_owner(owner)*/ {}
+                XmppClientRunner(XmppClient &) {}
 
             protected:
                 virtual std::thread createActionThread(std::shared_ptr<runner_queue> queue,
@@ -1527,9 +1535,6 @@ namespace Iotivity
                         }
                     });
                 }
-
-            private:
-              //  XmppClient &m_owner;
         };
         /// @endcond
 

src/xmpp/xmppclient.h

@@ -139,12 +139,10 @@ namespace Iotivity
 
                 virtual SyncEvent<XmppStreamCreatedEvent> &onStreamCreated();
 
-                typedef std::shared_ptr<std::promise<std::shared_ptr<IXmppStream>>>
-                XmppStreamPromise;
-
-                void initiateXMPP(const XmppConfig &config,
-                                  std::shared_ptr<IXmppConnection> remoteServer,
-                                  XmppStreamPromise xmppConnection = XmppStreamPromise());
+                virtual void initiateXMPP(const XmppConfig &config,
+                                          std::shared_ptr<IXmppConnection> remoteServer,
+                                          XmppStreamPromise xmppConnection =
+                                              XmppStreamPromise()) override;
 
             protected:
                 XmppClient();

src/xmpp/xmppconfig.h

@@ -43,7 +43,7 @@ namespace Iotivity
         {
             void operator()(XmppConfigImpl *);
         };
-        /// @endcode
+        /// @endcond
 
     }
 }

src/xmpp/xmppinterfaces.h

@@ -53,6 +53,7 @@ namespace Iotivity
     {
         struct SaslResult;
         class connect_error;
+        class XmppConfig;
 
 
         /// @brief XML Stream interface. Provides a stream from which XML payloads may be
@@ -226,8 +227,15 @@ namespace Iotivity
         class XMPP_API IXmppClient
         {
             public:
+                typedef std::shared_ptr<std::promise<std::shared_ptr<IXmppStream>>>
+                XmppStreamPromise;
+
                 virtual ~IXmppClient() {}
 
+                virtual void initiateXMPP(const XmppConfig &config,
+                                          std::shared_ptr<IXmppConnection> remoteServer,
+                                          XmppStreamPromise xmppConnection =
+                                              XmppStreamPromise()) = 0;
                 virtual SyncEvent<XmppStreamCreatedEvent> &onStreamCreated() = 0;
         };
 

src/xmpp/xmppping.cpp

@@ -26,7 +26,7 @@
 #include "stdafx.h"
 
 #include "xmppping.h"
-
+#include "jabberid.h"
 #include "../connect/connecterror.h"
 
 #ifndef DISABLE_SUPPORT_XEP0199
@@ -38,6 +38,63 @@ namespace Iotivity
 {
     namespace Xmpp
     {
+        static const string XMPP_PING_NS = "urn:xmpp:ping";
+
+        shared_ptr<XmppPing::Params> XmppPing::Params::create()
+        {
+            return shared_ptr<Params>(new Params);
+        }
+
+        bool XmppPing::Params::supportsExtension(const string &extensionName) const
+        {
+            return extensionName == XmppPing::extensionName();
+        }
+
+        XmppPing::XmppPing(shared_ptr<IXmppStream> overStream):
+            XmppExtension(overStream)
+        {}
+
+        XmppPing::~XmppPing()
+        {
+            // Called here so any captured this is not stale when the queries halt.
+            haltSafeQueries();
+        }
+
+        void XmppPing::assignConfiguration(std::shared_ptr<IExtensionParams> config)
+        {
+            if (config && config->supportsExtension(XmppPing::extensionName()))
+            {
+                m_config = static_pointer_cast<Params>(config);
+            }
+        }
+
+        void XmppPing::sendPing(const JabberID &target, PongCallback onPong)
+        {
+            XMLElement::Ptr request = constructIQ("get", target.full());
+            XMLElement::Ptr query = request->owner()->createElement("ping");
+            query->setAttribute("xmlns", XMPP_PING_NS);
+            request->appendChild(query);
+
+            sendSafeQuery(move(request),
+                          [this, onPong]
+                          (const connect_error & ce, XMLElement::Ptr response)
+            {
+                if (!ce.succeeded())
+                {
+                    onPong(ce);
+                    return;
+                }
+
+                connect_error result = testAndProcessErrorResponse(response);
+                if (result.succeeded())
+                {
+
+                }
+                onPong(result);
+            });
+        }
+
+
     }
 }
 

src/xmpp/xmppping.h

@@ -39,6 +39,42 @@ namespace Iotivity
 {
     namespace Xmpp
     {
+        class connect_error;
+
+        // XEP-0199 XMPP Ping
+        class XmppPing: public XmppExtension
+        {
+            public:
+                class XMPP_API Params: public IExtensionParams
+                {
+                    public:
+                        Params() = default;
+                        Params(const Params &) = default;
+                        static std::shared_ptr<Params> create();
+
+                        virtual bool supportsExtension(const std::string &extensionName) const override;
+
+                    private:
+
+                };
+            public:
+                XmppPing(std::shared_ptr<IXmppStream> overStream);
+                virtual ~XmppPing() override;
+
+                static std::string extensionName() { return "XEP0199"; }
+                virtual std::string getExtensionName() const override
+                {
+                    return XmppPing::extensionName();
+                }
+
+                virtual void assignConfiguration(std::shared_ptr<IExtensionParams> config) override;
+
+                typedef std::function<void(const connect_error &)> PongCallback;
+                void sendPing(const JabberID &target, PongCallback onPong = PongCallback());
+
+            private:
+                std::shared_ptr<Params> m_config;
+        };
     }
 }