ATSK-240 change elog to query logs in batches (ros-industrial#63)

makotecki · web-flow · commit 1b2acbb680c6 · 2023-10-03T09:47:55.000+02:00
* ATSK-240 change elog to querry logs in batches

* ATSK-240 add error handling

* ATSK-240 fix elog arg default value
diff --git a/include/abb_librws/common/rw/elog.h b/include/abb_librws/common/rw/elog.h
@@ -43,7 +43,7 @@ namespace abb ::rws ::rw ::elog
     {
         int domain;                       // Domain of message.
         int sequenceNumber;               // Sequence number of message in domain.
-        ElogMessageType messageType;          // The elog message type.
+        ElogMessageType messageType;      // The elog message type.
         int code;                         // The elog message code.
         std::string sourceName;           // The elog message source.
         std::tm timestamp;                // The time stamp when the event log was generated.
diff --git a/include/abb_librws/v1_0/rw/elog.h b/include/abb_librws/v1_0/rw/elog.h
@@ -40,9 +40,9 @@ namespace abb ::rws ::v1_0 ::rw ::elog
      *
      * @param client RWSClient
      * @param domain domain number
-     * @param seqnum sequence number
+     * @param seqnum sequence number to start from. If -1, the last @param limit messages are returned. Default -1.
      * @param lang The language in which messages will be returned. English default.
      * @return ElogMessage structure
      */
-    ElogMessage getElogMessage(RWSClient &client, int const domain, int const seqnum, std::string const &lang = Language::ENGLISH);
+    std::vector<ElogMessage> getElogMessages(RWSClient& client, int const domain, int const seqnum = -1, std::string const& lang = Language::ENGLISH);
 }
diff --git a/include/abb_librws/v2_0/rw/elog.h b/include/abb_librws/v2_0/rw/elog.h
@@ -40,9 +40,10 @@ namespace abb ::rws ::v2_0 ::rw ::elog
      *
      * @param client RWSClient
      * @param domain domain number
-     * @param seqnum sequence number
+     * @param seqnum sequence number to start from. If -1, the last @param limit messages are returned. Default -1.
      * @param lang The language in which messages will be returned. English default.
+     * @param limit The number of messages to return. Default 50.
      * @return ElogMessage structure
      */
-    ElogMessage getElogMessage(RWSClient &client, int const domain, int const seqnum, std::string const &lang = Language::ENGLISH);
+    std::vector<ElogMessage> getElogMessages(RWSClient& client, int const domain, int const seqnum = -1, std::string const& lang = Language::ENGLISH, int const limit = 50);
 }
diff --git a/src/v1_0/rw/elog.cpp b/src/v1_0/rw/elog.cpp
@@ -93,45 +93,89 @@ namespace abb ::rws ::v1_0 ::rw ::elog
         return parseDomains(rws_result);
     }
 
-    ElogMessage parseElogMessageXml(std::string const xml_string)
+    std::string concatTextFromNodes(std::vector<Poco::XML::Node*> nodes, std::string separator = " ")
+    {
+        std::stringstream ss;
+        bool separator_flag = false;
+        for (auto node : nodes)
+        {
+            if (separator_flag)
+                ss << separator;
+            separator_flag = true;
+            ss << node->innerText();
+        }
+        return ss.str();
+    }
+
+    ElogMessage parseElogNode(Poco::XML::Node* node)
     {
-        Poco::AutoPtr<Poco::XML::Document> rws_result = parseXml(xml_string);
         ElogMessage message;
-        message.messageType = makeElogMessageType(std::stoi(xmlFindTextContent(rws_result, XMLAttribute("class", "msgtype"))));
-        message.code = std::stoi(xmlFindTextContent(rws_result, XMLAttribute("class", "code")));
-        message.sourceName;
-        std::istringstream ss(xmlFindTextContent(rws_result, XMLAttribute("class", "tstamp")));
+
+        std::string title = xmlNodeGetAttributeValue(node, "title");
+        int sep_pos = title.find_last_of("/");
+
+        message.domain = 0;
+        message.sequenceNumber = 0;        
+        if (sep_pos != std::string::npos)
+        {
+            try {message.domain = std::stoi(title.substr(9, sep_pos - 9));}
+            catch (std::out_of_range const& e) {}
+            catch (std::bad_alloc const& e) {}
+            catch (std::invalid_argument const& e) {}
+
+            try {message.sequenceNumber = std::stoi(title.substr(sep_pos + 1));}
+            catch (std::out_of_range const& e) {}
+            catch (std::bad_alloc const& e) {}
+            catch (std::invalid_argument const& e) {}
+        }
+        
+        message.messageType = makeElogMessageType(std::stoi(xmlFindTextContent(node, XMLAttribute("class", "msgtype"))));
+        message.code = std::stoi(xmlFindTextContent(node, XMLAttribute("class", "code")));
+        message.sourceName = xmlFindTextContent(node, XMLAttribute("class", "src-name"));
+        std::istringstream ss(xmlFindTextContent(node, XMLAttribute("class", "tstamp")));
         ss >> std::get_time(&message.timestamp, "%Y-%m-%d T %H:%M:%S");
-        message.title = xmlFindTextContent(rws_result, XMLAttribute("class", "title"));
-        message.desc = xmlFindTextContent(rws_result, XMLAttribute("class", "desc"));
-        message.conseqs = xmlFindTextContent(rws_result, XMLAttribute("class", "conseqs"));
-        message.causes = xmlFindTextContent(rws_result, XMLAttribute("class", "causes"));
-        message.actions = xmlFindTextContent(rws_result, XMLAttribute("class", "actions"));
+        message.title = concatTextFromNodes(xmlFindNodes(node, XMLAttribute("class", "title")));
+        message.desc = concatTextFromNodes(xmlFindNodes(node, XMLAttribute("class", "desc")));
+        message.conseqs = concatTextFromNodes(xmlFindNodes(node, XMLAttribute("class", "conseqs")));
+        message.causes = concatTextFromNodes(xmlFindNodes(node, XMLAttribute("class", "causes")));
+        message.actions = concatTextFromNodes(xmlFindNodes(node, XMLAttribute("class", "actions")));
 
-        int argc = std::stoi(xmlFindTextContent(rws_result, XMLAttribute("class", "argc")));
+        int argc = std::stoi(xmlFindTextContent(node, XMLAttribute("class", "argc")));
 
         for (int i = 1; i <= argc; i++)
         {
             std::stringstream arg_name;
             arg_name << "arg" << i;
-            auto node = xmlFindNodes(rws_result, XMLAttribute("class", arg_name.str()))[0];
-
-            std::string value = node->innerText();
-            std::string valueType = xmlNodeGetAttributeValue(node, "type");
-
+            auto arg_nodes = xmlFindNodes(node, XMLAttribute("class", arg_name.str()));
+            std::string value = "";
+            std::string valueType = "STRING";
+            if (!arg_nodes.empty())
+            {
+                value = arg_nodes[0]->innerText();
+                valueType = xmlNodeGetAttributeValue(arg_nodes[0], "type");
+            }
             message.argv[i] = makeElogMessageArg(valueType, value);
         }
         return message;
     }
 
-    ElogMessage getElogMessage(RWSClient &client, int const domain, int const seqnum, std::string const &lang)
+    std::vector<ElogMessage> parseElogMessagesXml(std::string const xml_string)
+    {
+        Poco::AutoPtr<Poco::XML::Document> rws_result = parseXml(xml_string);
+        std::vector<ElogMessage> messages;
+        auto nodes = xmlFindNodes(rws_result, XMLAttribute("class", "elog-message-li"));
+        for (auto node : nodes)
+            messages.push_back(parseElogNode(node));
+        return messages;
+    }
+
+    std::vector<ElogMessage> getElogMessages(RWSClient& client, int const domain, int const seqnum, std::string const& lang)
     {
         std::stringstream uri;
-        uri << "/rw/elog/" << domain << "/" << seqnum << "?lang=" << lang;
+        uri << "/rw/elog/" << domain << "?lang=" << lang << "&order=lifo";
+        if (seqnum >= 0) uri << "&elogseqnum=" << seqnum;
         POCOResult poco_result = client.httpGet(uri.str());
-        ElogMessage message = parseElogMessageXml(poco_result.content());
-        message.domain = domain;
-        message.sequenceNumber = seqnum;
-        return message;
+        std::vector<ElogMessage> messages = parseElogMessagesXml(poco_result.content());
+        return messages;
     }
 }
diff --git a/src/v2_0/rw/elog.cpp b/src/v2_0/rw/elog.cpp
@@ -93,45 +93,90 @@ namespace abb ::rws ::v2_0 ::rw ::elog
         return parseDomains(rws_result);
     }
 
-    ElogMessage parseElogMessageXml(std::string const xml_string)
+    std::string concatTextFromNodes(std::vector<Poco::XML::Node*> nodes, std::string separator = " ")
+    {
+        std::stringstream ss;
+        bool separator_flag = false;
+        for (auto node : nodes)
+        {
+            if (separator_flag)
+                ss << separator;
+            separator_flag = true;
+            ss << node->innerText();
+        }
+        return ss.str();
+    }
+
+    ElogMessage parseElogNode(Poco::XML::Node* node)
     {
-        Poco::AutoPtr<Poco::XML::Document> rws_result = parseXml(xml_string);
         ElogMessage message;
-        message.messageType = makeElogMessageType(std::stoi(xmlFindTextContent(rws_result, XMLAttribute("class", "msgtype"))));
-        message.code = std::stoi(xmlFindTextContent(rws_result, XMLAttribute("class", "code")));
-        message.sourceName;
-        std::istringstream ss(xmlFindTextContent(rws_result, XMLAttribute("class", "tstamp")));
+
+        std::string title = xmlNodeGetAttributeValue(node, "title");
+        int sep_pos = title.find_last_of("/");
+
+        message.domain = 0;
+        message.sequenceNumber = 0;        
+        if (sep_pos != std::string::npos)
+        {
+            try {message.domain = std::stoi(title.substr(9, sep_pos - 9));}
+            catch (std::out_of_range const& e) {}
+            catch (std::bad_alloc const& e) {}
+            catch (std::invalid_argument const& e) {}
+
+            try {message.sequenceNumber = std::stoi(title.substr(sep_pos + 1));}
+            catch (std::out_of_range const& e) {}
+            catch (std::bad_alloc const& e) {}
+            catch (std::invalid_argument const& e) {}
+        }
+        
+        message.messageType = makeElogMessageType(std::stoi(xmlFindTextContent(node, XMLAttribute("class", "msgtype"))));
+        message.code = std::stoi(xmlFindTextContent(node, XMLAttribute("class", "code")));
+        message.sourceName = xmlFindTextContent(node, XMLAttribute("class", "src-name"));
+        std::istringstream ss(xmlFindTextContent(node, XMLAttribute("class", "tstamp")));
         ss >> std::get_time(&message.timestamp, "%Y-%m-%d T %H:%M:%S");
-        message.title = xmlFindTextContent(rws_result, XMLAttribute("class", "title"));
-        message.desc = xmlFindTextContent(rws_result, XMLAttribute("class", "desc"));
-        message.conseqs = xmlFindTextContent(rws_result, XMLAttribute("class", "conseqs"));
-        message.causes = xmlFindTextContent(rws_result, XMLAttribute("class", "causes"));
-        message.actions = xmlFindTextContent(rws_result, XMLAttribute("class", "actions"));
+        message.title = concatTextFromNodes(xmlFindNodes(node, XMLAttribute("class", "title")));
+        message.desc = concatTextFromNodes(xmlFindNodes(node, XMLAttribute("class", "desc")));
+        message.conseqs = concatTextFromNodes(xmlFindNodes(node, XMLAttribute("class", "conseqs")));
+        message.causes = concatTextFromNodes(xmlFindNodes(node, XMLAttribute("class", "causes")));
+        message.actions = concatTextFromNodes(xmlFindNodes(node, XMLAttribute("class", "actions")));
 
-        int argc = std::stoi(xmlFindTextContent(rws_result, XMLAttribute("class", "argc")));
+        int argc = std::stoi(xmlFindTextContent(node, XMLAttribute("class", "argc")));
 
         for (int i = 1; i <= argc; i++)
         {
             std::stringstream arg_name;
             arg_name << "arg" << i;
-            auto node = xmlFindNodes(rws_result, XMLAttribute("class", arg_name.str()))[0];
-
-            std::string value = node->innerText();
-            std::string valueType = xmlNodeGetAttributeValue(node, "type");
-
+            auto arg_nodes = xmlFindNodes(node, XMLAttribute("class", arg_name.str()));
+            std::string value = "";
+            std::string valueType = "STRING";
+            if (!arg_nodes.empty())
+            {
+                value = arg_nodes[0]->innerText();
+                valueType = xmlNodeGetAttributeValue(arg_nodes[0], "type");
+            }
             message.argv[i] = makeElogMessageArg(valueType, value);
         }
         return message;
     }
 
-    ElogMessage getElogMessage(RWSClient &client, int const domain, int const seqnum, std::string const &lang)
+    std::vector<ElogMessage> parseElogMessagesXml(std::string const xml_string)
+    {
+        Poco::AutoPtr<Poco::XML::Document> rws_result = parseXml(xml_string);
+        std::vector<ElogMessage> messages;
+        auto nodes = xmlFindNodes(rws_result, XMLAttribute("class", "elog-message-li"));
+        for (auto node : nodes)
+            messages.push_back(parseElogNode(node));
+        return messages;
+    }
+
+    std::vector<ElogMessage> getElogMessages(RWSClient& client, int const domain, int const seqnum, std::string const& lang, int const limit)
     {
         std::stringstream uri;
-        uri << "/rw/elog/" << domain << "/" << seqnum << "?lang=" << lang;
+        uri << "/rw/elog/" << domain << "?lang=" << lang << "&order=lifo";
+        if (seqnum >= 0) uri << "&elogseqnum=" << seqnum;
+        if (limit > 0) uri << "&limit=" << limit;
         POCOResult poco_result = client.httpGet(uri.str());
-        ElogMessage message = parseElogMessageXml(poco_result.content());
-        message.domain = domain;
-        message.sequenceNumber = seqnum;
-        return message;
+        std::vector<ElogMessage> messages = parseElogMessagesXml(poco_result.content());
+        return messages;
     }
 }

Original file line number	Diff line number	Diff line change
`@@ -43,7 +43,7 @@ namespace abb ::rws ::rw ::elog`
`43`	`43`	`{`
`44`	`44`	`int domain; // Domain of message.`
`45`	`45`	`int sequenceNumber; // Sequence number of message in domain.`
`46`		`- ElogMessageType messageType; // The elog message type.`
	`46`	`+ ElogMessageType messageType; // The elog message type.`
`47`	`47`	`int code; // The elog message code.`
`48`	`48`	`std::string sourceName; // The elog message source.`
`49`	`49`	`std::tm timestamp; // The time stamp when the event log was generated.`
Original file line number	Diff line number	Diff line change
`@@ -40,9 +40,9 @@ namespace abb ::rws ::v1_0 ::rw ::elog`
`40`	`40`	`*`
`41`	`41`	`* @param client RWSClient`
`42`	`42`	`* @param domain domain number`
`43`		`- * @param seqnum sequence number`
	`43`	`+ * @param seqnum sequence number to start from. If -1, the last @param limit messages are returned. Default -1.`
`44`	`44`	`* @param lang The language in which messages will be returned. English default.`
`45`	`45`	`* @return ElogMessage structure`
`46`	`46`	`*/`
`47`		`- ElogMessage getElogMessage(RWSClient &client, int const domain, int const seqnum, std::string const &lang = Language::ENGLISH);`
	`47`	`+ std::vector<ElogMessage> getElogMessages(RWSClient& client, int const domain, int const seqnum = -1, std::string const& lang = Language::ENGLISH);`
`48`	`48`	`}`
Original file line number	Diff line number	Diff line change
`@@ -40,9 +40,10 @@ namespace abb ::rws ::v2_0 ::rw ::elog`
`40`	`40`	`*`
`41`	`41`	`* @param client RWSClient`
`42`	`42`	`* @param domain domain number`
`43`		`- * @param seqnum sequence number`
	`43`	`+ * @param seqnum sequence number to start from. If -1, the last @param limit messages are returned. Default -1.`
`44`	`44`	`* @param lang The language in which messages will be returned. English default.`
	`45`	`+ * @param limit The number of messages to return. Default 50.`
`45`	`46`	`* @return ElogMessage structure`
`46`	`47`	`*/`
`47`		`- ElogMessage getElogMessage(RWSClient &client, int const domain, int const seqnum, std::string const &lang = Language::ENGLISH);`
	`48`	`+ std::vector<ElogMessage> getElogMessages(RWSClient& client, int const domain, int const seqnum = -1, std::string const& lang = Language::ENGLISH, int const limit = 50);`
`48`	`49`	`}`