GVOClient using publish_fits to broadcast data without using GVOTable

Thierry Louge
1 parent 2e8c917e
Showing 8 changed files with 187 additions and 74 deletions
include/GSkymap.hpp
include/GVOClient.hpp
include/GVOHub.hpp
pyext/GVOClient.i
src/sky/GSkymap.cpp
src/vo/GVOClient.cpp
src/vo/GVOHub.cpp
src/vo/GVOTable.cpp
@@ -41,6 +41,7 @@
 #include "GMatrix.hpp"
 #include "GVector.hpp"
 #include "GBilinear.hpp"
+#include "GVOClient.hpp"
 /***********************************************************************//**
  * @class GSkymap
@@ -146,7 +147,6 @@ public:
     void                  read(const GFitsHDU& hdu);
     void                  write(GFits& file) const;
     std::string           print(const GChatter& chatter = NORMAL) const;
-    
 private:
     // Private methods
@@ -75,6 +75,7 @@ public:
     void        shutdown_hub(void) const;
     GXml        execute(const std::string& request) const;
     std::string print(const GChatter& chatter = NORMAL) const;
+    void        publish_fits(const std::string& filename);
 protected:
     // Protected methods
@@ -103,10 +103,9 @@ protected:
     std::vector<std::string> get_subscriptions(const GXml& xml) const;
     std::string              get_callback_url(const GXml& xml) const;
     std::string              get_hub_lockfile(void) const;
-    void 		             send_notifications(const std::string& method,
-                                                const std::string& client);
-    void                     request_call(const GXml& xml,
-                                                  const socklen_t& sock);
+    void 		     send_notifications(const std::string& method,const std::string& client);
+  void 		             send_notifications(const std::string& method,const std::string& client,const GXml& xml);
+    void                     broadcast(const GXml& xml,const socklen_t& sock);
     std::string              get_mtype(const GXml& xml) const;
     std::string              get_destination(const GXml& xml) const;
@@ -52,6 +52,7 @@ public:
     bool        ping_hub(void) const;
     void        shutdown_hub(void) const;
     GXml        execute(const std::string& request) const;
+    void        publish_fits(const std::string& filename);
 };
@@ -1673,7 +1673,6 @@ void GSkymap::write(GFits&amp; file) const
     return;
 }
-
 /***********************************************************************//**
  * @brief Print sky map
  *
@@ -412,7 +412,38 @@ std::string GVOClient::print(const GChatter&amp; chatter) const
     // Return result
     return result;
 }
-
+/***********************************************************************//**
+ * @brief publishes the VOTable in a VO Hub
+ *
+ * @param[in] 
+ *
+ * @exception GException::
+ *            
+ ***************************************************************************/
+void GVOClient::publish_fits(const std::string& filename)
+{
+    std::string hub_command = "";
+    //ELABORATE THE COMMAND TO BE PASSED TO THE HUB
+    //SEND THE DATA
+    hub_command.append("<?xml version=\"1.0\"?>\n");
+    hub_command.append("<methodCall>");
+    hub_command.append("  <methodName>samp.hub.notifyAll</methodName>\n");
+    hub_command.append("  <params>\n");
+    hub_command.append("    <param><value>image.load.fits</value></param>\n");
+    hub_command.append("    <param><value>"+m_secret+"</value></param>\n");
+    hub_command.append("    <param><value><struct>\n");
+    hub_command.append("      <member><name>samp.params</name><value><struct>\n");
+    hub_command.append("        <member><name>name</name><value>Gammalib_FITS_FILE</value></member>\n");
+    hub_command.append("        <member><name>url</name><value>file://localhost:2526/"+filename+"</value></member>\n");
+    hub_command.append("        <member><name>image-id</name><value>file:"+filename+"</value></member>\n");
+    hub_command.append("      </struct></value></member>\n");
+    hub_command.append("      <member><name>samp.mtype</name><value>image.load.fits</value></member>\n");
+    hub_command.append("    </struct></value></param>\n");
+    hub_command.append("  </params>\n</methodCall>\n");
+    execute(hub_command);
+    // Return
+    return;
+}
 /*==========================================================================
  =                                                                         =
@@ -53,7 +53,7 @@
 /* __ Coding definitions _________________________________________________ */
 /* __ Debug definitions __________________________________________________ */
-//#define G_CONSOLE_DUMP
+#define G_CONSOLE_DUMP
 #define G_SHOW_MESSAGE
@@ -85,7 +85,7 @@ GVOHub::GVOHub(const GVOHub&amp; hub)
 {
     // Initialise members
     init_members();
-
+    
     // Copy members
     copy_members(hub);
@@ -481,14 +481,21 @@ void GVOHub::handle_request(const socklen_t&amp; sock)
     else if (method_called.compare("samp.hub.getMetadata") == 0) {
         request_get_metadata(xml, sock);
     }
+    else if (method_called.compare("table.load.votable") == 0) {
+        request_ping(sock);
+    }
     else if (method_called.compare("samp.hub.notify") == 0) {
         request_ping(sock);
     }
     else if (method_called.compare("samp.hub.notifyAll") == 0) {
-        request_ping(sock);
+         #if defined(G_CONSOLE_DUMP)
+	 std::cout << "==========================================" << std::endl;
+	 std::cout << "samp.hub.notifyAll" << std::endl;
+         #endif
+        broadcast(xml, sock);
     }
     else if (method_called.compare("samp.hub.call") == 0) {
-        request_call(xml,sock);
+        request_ping(sock);
     }
     else if (method_called.compare("samp.hub.callAll") == 0) {
         request_ping(sock);
@@ -1123,72 +1130,49 @@ void GVOHub::request_get_metadata(const GXml&amp; xml, const socklen_t&amp; sock)
 }
 /***********************************************************************//**
- * @brief Handles calls to specific client
+ * @brief broadcasts a message
  *
  * @param[in] xml XML message sent by client.
  * @param[in] sock Socket.
  *
- * Handles all incoming cals for a specific client
+ * broadcasts an image to every registered client
  ***************************************************************************/
-void GVOHub::request_call(const GXml& xml, const socklen_t& sock)
+void GVOHub::broadcast(const GXml& xml, const socklen_t& sock)
 {
     // Header
-    #if defined(G_CONSOLE_DUMP)
-    std::cout << "GVOHub::request_get_registered_clients" << std::endl;
-    #endif
-
-    // Get client key
-    std::string key = get_client_key(xml);
+   
+    // Get client index
+    int i = get_client_index(xml);
     // Get message mtype
     std::string mtype = get_mtype(xml);
-    // Get the key of client who is to be contacted with the message
-    // Declare message
-    std::string msg = "";
-    // Determine which call has been invoqued
-    // Loop over all clients and send notification
-    for (int i = 0; i < m_clients.size(); ++i) {
-	    msg = "";
-	    
-	    // Set response for table.load.votable
-	    msg.append("<?xml version=\"1.0\"?>\n");
-	    msg.append("<methodCall><methodName>samp.client.receiveCall</methodName>\n");
-	    msg.append("<params>\n");
-	    msg.append("  <param><value>");
-	    msg.append(m_clients[i].private_key);
-	    msg.append("</value></param>\n");
-	    msg.append("  <param><value>"+m_hub_id+"</value></param>\n");
-	    msg.append("  <param><value><struct>\n");
-	    msg.append("    <member>\n");
-	    msg.append("      <name>samp.mtype</name>\n");
-	    msg.append("      <value>table.load.votable</value>\n");
-	    msg.append("    </member>\n");
-	    msg.append("    <member>\n");
-	    msg.append("      <name>samp.params</name>\n");
-	    msg.append("      <value><struct>\n");
-	    msg.append("        <member>\n");
-	    msg.append("          <name>name</name>\n");
-	    msg.append("          <value>imagename</value>\n");
-	    msg.append("        </member>\n");
-	    msg.append("        <member>\n");
-	    msg.append("          <name>table-id</name>\n");
-	    msg.append("          <value>id of table</value>\n");
-	    msg.append("        </member>\n");
-	    msg.append("        <member>\n");
-	    msg.append("           <name>url</name>\n");
-	    msg.append("           <value>url to the table</value>\n");
-	    msg.append("         </member>\n");
-	    msg.append("       </struct></value>\n");
-	    msg.append("      </member>\n");				
-	    msg.append("      </struct></value>\n");
-	    msg.append("    </param>\n");
-	    msg.append("</params>\n");
-	    msg.append("</methodCall>\n");
-              
-	
-            // Post notification
-            notify(m_clients[i].url, msg);
+    #if defined(G_CONSOLE_DUMP)
+    std::cout<<"mtype is: " +mtype + "i value: " + gammalib::str(i)<<std::endl;
+    #endif
+    // Continue only if index is valid
+    if (i != -1) {
+         #if defined(G_CONSOLE_DUMP)
+	 std::cout<<"i not negative"<<std::endl;
+         #endif
+        // Post void message
+        post_samp_void(sock);
+	if (mtype == "image.load.fits") {
+	    #if defined(G_CONSOLE_DUMP)
+	    std::cout<<"notifying image.load.fits"<<std::endl;
+            #endif
+	    // Send notifications
+	    send_notifications("image.load.fits",
+			       m_clients[i].reference,xml);
 	}
-    
+	if (mtype == "table.load.votable") {
+	    // Send notifications
+	    send_notifications("table.load.votable",
+			       m_clients[i].reference,xml);
+	}
+        
+    } // endif: valid client found
+    #if defined(G_CONSOLE_DUMP)
+    std::cout<<"Returning from broadcast function"<<std::endl;
+    #endif
     // Return
     return;
@@ -1527,6 +1511,9 @@ std::string GVOHub::get_hub_lockfile(void) const
 void GVOHub::send_notifications(const std::string& method,
                                 const std::string& client)
 {
+     #if defined(G_CONSOLE_DUMP)
+    std::cout << "GVOHub::send_notifications 1st form" << std::endl;
+    #endif
     // Loop over all clients
     for (int i = 0; i < m_clients.size(); ++i) {
@@ -1573,7 +1560,7 @@ void GVOHub::send_notifications(const std::string&amp; method,
                     notify(m_clients[i].url, msg);
                 }
-                    
+               
                 // Unregister
                 else if (method == "samp.hub.event.unregister") {
@@ -1693,7 +1680,7 @@ void GVOHub::send_notifications(const std::string&amp; method,
                     // Post notification
                     notify(m_clients[i].url, msg);
-                } // endelse: metadata
+	      } // endelse: metadata
             } // endif: method was requested one
@@ -1704,7 +1691,102 @@ void GVOHub::send_notifications(const std::string&amp; method,
     // Return
     return;
 }
+/***********************************************************************//**
+ * @brief Send notifications
+ *
+ * @param[in] method Name of the method
+ * @param[in] client Reference of the client
+ * @param[in] xml message sent by the client
+ *
+ * The method send notifications to all registered clients that request so.
+ ***************************************************************************/
+void GVOHub::send_notifications(const std::string& method,
+                                const std::string& client,
+				const GXml& xml)
+{
+    #if defined(G_CONSOLE_DUMP)
+    std::cout << "GVOHub::send_notifications 2nd form" << std::endl;
+    #endif
+    // Loop over all clients
+    for (int i = 0; i < m_clients.size(); ++i) {
+    
+        // Loop over all methods
+        for (int j = 0; j < m_clients[i].subscriptions.size(); ++j) {
+
+            // Continue only if method matches
+            if (method == m_clients[i].subscriptions[j]) {
+    
+                // Declare notification
+                std::string msg = "";
+                if (method == "image.load.fits") {
+		   /*
+		     Example of message to send for VOTABLE message
+		     { "samp.mtype": "table.load.votable",
+		     "samp.params": {
+		     "name": "SDSS DR7",
+		     "table-id": "http://alasky.u-strasbg.fr/cats/SDSS-DR7",
+		     "url": "file://localhost/root/.aladin/.aladin.28999/sampSDSSDR71446626818775.xml" } }
+		   */
+		   
+		   // Set response for image.load.fits
+                    msg.append("<?xml version=\"1.0\"?>\n");
+                    msg.append("<methodCall>\n");
+                    msg.append("<methodName>samp.client.receiveNotification</methodName>\n");
+                    msg.append("<params>\n");
+                    msg.append("  <param><value>");
+                    msg.append(m_clients[i].private_key);
+                    msg.append("</value></param>\n");
+                    msg.append("  <param><value>");
+                    msg.append(m_hub_id);
+                    msg.append("</value></param>\n");
+                    msg.append("  <param><value><struct>\n");
+                    msg.append("    <member>\n");
+                    msg.append("      <name>samp.mtype</name>\n");
+                    msg.append("      <value>image.load.fits</value>\n");
+                    msg.append("    </member>\n");
+                    msg.append("    <member>\n");
+                    msg.append("      <name>samp.params</name>\n");
+                    msg.append("      <value><struct>\n");
+                    msg.append("        <member>\n");
+                    msg.append("          <name>name</name>\n");
+                    msg.append("          <value>");
+		    const GXmlNode* node = xml.element("methodCall > params > param[1] > value > struct > member[1] > value");
+		    if (node != NULL) {
+		      const GXmlText* text = static_cast<const GXmlText*>((*node)[0]);
+		      if (text != NULL) {
+			msg.append(text->text());
+		      }
+		    }
+		     msg.append("</value>\n");
+                    msg.append("        </member>\n");
+		    msg.append("        <member>\n");
+                    msg.append("          <name>image-id</name>\n");
+                    msg.append("          <value>IMAGE_ID</value>\n");
+                    msg.append("        </member>\n");
+		    msg.append("        <member>\n");
+                    msg.append("          <name>url</name>\n");
+                    msg.append("          <value>http://127.0.0.1:2526/</value>\n");
+                    msg.append("        </member>\n");
+                    msg.append("      </struct></value>\n");
+                    msg.append("    </member>\n");
+                    msg.append("  </struct></value></param>\n");
+                    msg.append("</params>\n");
+                    msg.append("</methodCall>\n");
+                        
+                    // Post notification
+                    notify(m_clients[i].url, msg);
+		  
+		}
+            } // endif: method was requested one
+
+        } // endfor: looped over all methods
+
+    } // endfor: looped over all clients
+    
+    // Return
+    return;
+}
 /***********************************************************************//**
  * @brief Creates the lockfile, fill it
@@ -221,13 +221,13 @@ std::string GVOTable::print(const GChatter&amp; chatter) const
 void GVOTable::open_votable(void)
 {
     m_header.append("<?xml version=\"1.0\"?>\n");
-    m_header.append("<VOTABLE version=\"1.3\" xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\"\n");
-    m_header.append("xmlns=\"http://www.ivoa.net/xml/VOTable/v1.3\"\n");
+    // m_header.append("<VOTABLE version=\"1.3\" xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\"\n");
+    //m_header.append("xmlns=\"http://www.ivoa.net/xml/VOTable/v1.3\"\n");
     //STC is recommended space time coordinates datamodel for galaxies
     m_header.append("xmlns:stc=\"http://www.ivoa.net/xml/STC/v1.30\">\n");
-    m_header.append("\t<RESOURCE name=\"Gammalib\">\n");
-    m_header.append("\t\t<TABLE name=\"GammalibTable\">\n");
-    m_header.append("\t\t\t<DESCRIPTION>VOTable coming from gammalib</DESCRIPTION>\n");
+    //m_header.append("\t<RESOURCE name=\"Gammalib\">\n");
+    //m_header.append("\t\t<TABLE name=\"GammalibTable\">\n");
+    //m_header.append("\t\t\t<DESCRIPTION>VOTable coming from gammalib</DESCRIPTION>\n");
     // Return
     return;
 }