xref: /openbmc/bmcweb/features/redfish/include/event_service_manager.hpp (revision 8dab0f580cd31638bdf1a6ed1cef249fc6e1a14d)
1b52664e2SAppaRao Puli /*
2b52664e2SAppaRao Puli // Copyright (c) 2020 Intel Corporation
3b52664e2SAppaRao Puli //
4b52664e2SAppaRao Puli // Licensed under the Apache License, Version 2.0 (the "License");
5b52664e2SAppaRao Puli // you may not use this file except in compliance with the License.
6b52664e2SAppaRao Puli // You may obtain a copy of the License at
7b52664e2SAppaRao Puli //
8b52664e2SAppaRao Puli //      http://www.apache.org/licenses/LICENSE-2.0
9b52664e2SAppaRao Puli //
10b52664e2SAppaRao Puli // Unless required by applicable law or agreed to in writing, software
11b52664e2SAppaRao Puli // distributed under the License is distributed on an "AS IS" BASIS,
12b52664e2SAppaRao Puli // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13b52664e2SAppaRao Puli // See the License for the specific language governing permissions and
14b52664e2SAppaRao Puli // limitations under the License.
15b52664e2SAppaRao Puli */
16b52664e2SAppaRao Puli #pragma once
173ccb3adbSEd Tanous #include "dbus_utility.hpp"
183ccb3adbSEd Tanous #include "error_messages.hpp"
193ccb3adbSEd Tanous #include "event_service_store.hpp"
203ccb3adbSEd Tanous #include "http_client.hpp"
21c0353249SWludzik, Jozef #include "metric_report.hpp"
223ccb3adbSEd Tanous #include "persistent_data.hpp"
233ccb3adbSEd Tanous #include "random.hpp"
247f4eb588SAppaRao Puli #include "registries.hpp"
25*8dab0f58SEd Tanous #include "registries_selector.hpp"
263ccb3adbSEd Tanous #include "server_sent_events.hpp"
2750ebd4afSEd Tanous #include "str_utility.hpp"
2877665bdaSNan Zhou #include "utility.hpp"
293ccb3adbSEd Tanous #include "utils/json_utils.hpp"
307f4eb588SAppaRao Puli 
317f4eb588SAppaRao Puli #include <sys/inotify.h>
32b52664e2SAppaRao Puli 
3311ba3979SEd Tanous #include <boost/algorithm/string/classification.hpp>
34fb4fd5d4SZhenfei Tai #include <boost/asio/io_context.hpp>
35b52664e2SAppaRao Puli #include <boost/container/flat_map.hpp>
36ef4c65b7SEd Tanous #include <boost/url/format.hpp>
37b5b40605Snitroglycerine #include <sdbusplus/bus/match.hpp>
381214b7e7SGunnar Mills 
395e44e3d8SAppaRao Puli #include <algorithm>
40b52664e2SAppaRao Puli #include <cstdlib>
41b52664e2SAppaRao Puli #include <ctime>
421bf712bcSAyushi Smriti #include <fstream>
43b52664e2SAppaRao Puli #include <memory>
4426702d01SEd Tanous #include <span>
45b52664e2SAppaRao Puli 
46b52664e2SAppaRao Puli namespace redfish
47b52664e2SAppaRao Puli {
48156d6b00SAppaRao Puli 
49156d6b00SAppaRao Puli using ReadingsObjType =
5093f5d7c7SWludzik, Jozef     std::vector<std::tuple<std::string, std::string, double, int32_t>>;
51156d6b00SAppaRao Puli 
52156d6b00SAppaRao Puli static constexpr const char* eventFormatType = "Event";
53156d6b00SAppaRao Puli static constexpr const char* metricReportFormatType = "MetricReport";
54156d6b00SAppaRao Puli 
555e44e3d8SAppaRao Puli static constexpr const char* subscriptionTypeSSE = "SSE";
561bf712bcSAyushi Smriti static constexpr const char* eventServiceFile =
571bf712bcSAyushi Smriti     "/var/lib/bmcweb/eventservice_config.json";
581bf712bcSAyushi Smriti 
595e44e3d8SAppaRao Puli static constexpr const uint8_t maxNoOfSubscriptions = 20;
605e44e3d8SAppaRao Puli static constexpr const uint8_t maxNoOfSSESubscriptions = 10;
615e44e3d8SAppaRao Puli 
624642bf8fSGeorge Liu #ifndef BMCWEB_ENABLE_REDFISH_DBUS_LOG_ENTRIES
63cf9e417dSEd Tanous // NOLINTNEXTLINE(cppcoreguidelines-avoid-non-const-global-variables)
644642bf8fSGeorge Liu static std::optional<boost::asio::posix::stream_descriptor> inotifyConn;
654642bf8fSGeorge Liu static constexpr const char* redfishEventLogDir = "/var/log";
664642bf8fSGeorge Liu static constexpr const char* redfishEventLogFile = "/var/log/redfish";
674642bf8fSGeorge Liu static constexpr const size_t iEventSize = sizeof(inotify_event);
68cf9e417dSEd Tanous 
69cf9e417dSEd Tanous // NOLINTNEXTLINE(cppcoreguidelines-avoid-non-const-global-variables)
704642bf8fSGeorge Liu static int inotifyFd = -1;
71cf9e417dSEd Tanous // NOLINTNEXTLINE(cppcoreguidelines-avoid-non-const-global-variables)
724642bf8fSGeorge Liu static int dirWatchDesc = -1;
73cf9e417dSEd Tanous // NOLINTNEXTLINE(cppcoreguidelines-avoid-non-const-global-variables)
744642bf8fSGeorge Liu static int fileWatchDesc = -1;
754642bf8fSGeorge Liu 
764642bf8fSGeorge Liu // <ID, timestamp, RedfishLogId, registryPrefix, MessageId, MessageArgs>
774642bf8fSGeorge Liu using EventLogObjectsType =
784642bf8fSGeorge Liu     std::tuple<std::string, std::string, std::string, std::string, std::string,
794642bf8fSGeorge Liu                std::vector<std::string>>;
804642bf8fSGeorge Liu 
81fffb8c1fSEd Tanous namespace registries
824642bf8fSGeorge Liu {
837f4eb588SAppaRao Puli static const Message*
847f4eb588SAppaRao Puli     getMsgFromRegistry(const std::string& messageKey,
8526702d01SEd Tanous                        const std::span<const MessageEntry>& registry)
867f4eb588SAppaRao Puli {
8726702d01SEd Tanous     std::span<const MessageEntry>::iterator messageIt =
8826702d01SEd Tanous         std::find_if(registry.begin(), registry.end(),
897f4eb588SAppaRao Puli                      [&messageKey](const MessageEntry& messageEntry) {
9055f79e6fSEd Tanous         return messageKey == messageEntry.first;
917f4eb588SAppaRao Puli         });
9226702d01SEd Tanous     if (messageIt != registry.end())
937f4eb588SAppaRao Puli     {
947f4eb588SAppaRao Puli         return &messageIt->second;
957f4eb588SAppaRao Puli     }
967f4eb588SAppaRao Puli 
977f4eb588SAppaRao Puli     return nullptr;
987f4eb588SAppaRao Puli }
997f4eb588SAppaRao Puli 
10026ccae32SEd Tanous static const Message* formatMessage(std::string_view messageID)
1017f4eb588SAppaRao Puli {
1027f4eb588SAppaRao Puli     // Redfish MessageIds are in the form
1037f4eb588SAppaRao Puli     // RegistryName.MajorVersion.MinorVersion.MessageKey, so parse it to find
1047f4eb588SAppaRao Puli     // the right Message
1057f4eb588SAppaRao Puli     std::vector<std::string> fields;
1067f4eb588SAppaRao Puli     fields.reserve(4);
10750ebd4afSEd Tanous 
10850ebd4afSEd Tanous     bmcweb::split(fields, messageID, '.');
1097f4eb588SAppaRao Puli     if (fields.size() != 4)
1107f4eb588SAppaRao Puli     {
1117f4eb588SAppaRao Puli         return nullptr;
1127f4eb588SAppaRao Puli     }
11302cad96eSEd Tanous     const std::string& registryName = fields[0];
11402cad96eSEd Tanous     const std::string& messageKey = fields[3];
1157f4eb588SAppaRao Puli 
1167f4eb588SAppaRao Puli     // Find the right registry and check it for the MessageKey
117b304bd79SP Dheeraj Srujan Kumar     return getMsgFromRegistry(messageKey, getRegistryFromPrefix(registryName));
1187f4eb588SAppaRao Puli }
119fffb8c1fSEd Tanous } // namespace registries
1207f4eb588SAppaRao Puli 
1217f4eb588SAppaRao Puli namespace event_log
1227f4eb588SAppaRao Puli {
1232558979cSP Dheeraj Srujan Kumar inline bool getUniqueEntryID(const std::string& logEntry, std::string& entryID)
1247f4eb588SAppaRao Puli {
1257f4eb588SAppaRao Puli     static time_t prevTs = 0;
1267f4eb588SAppaRao Puli     static int index = 0;
1277f4eb588SAppaRao Puli 
1287f4eb588SAppaRao Puli     // Get the entry timestamp
1297f4eb588SAppaRao Puli     std::time_t curTs = 0;
1307f4eb588SAppaRao Puli     std::tm timeStruct = {};
1317f4eb588SAppaRao Puli     std::istringstream entryStream(logEntry);
1327f4eb588SAppaRao Puli     if (entryStream >> std::get_time(&timeStruct, "%Y-%m-%dT%H:%M:%S"))
1337f4eb588SAppaRao Puli     {
1347f4eb588SAppaRao Puli         curTs = std::mktime(&timeStruct);
1357f4eb588SAppaRao Puli         if (curTs == -1)
1367f4eb588SAppaRao Puli         {
1377f4eb588SAppaRao Puli             return false;
1387f4eb588SAppaRao Puli         }
1397f4eb588SAppaRao Puli     }
1407f4eb588SAppaRao Puli     // If the timestamp isn't unique, increment the index
1417f4eb588SAppaRao Puli     index = (curTs == prevTs) ? index + 1 : 0;
1427f4eb588SAppaRao Puli 
1437f4eb588SAppaRao Puli     // Save the timestamp
1447f4eb588SAppaRao Puli     prevTs = curTs;
1457f4eb588SAppaRao Puli 
1467f4eb588SAppaRao Puli     entryID = std::to_string(curTs);
1477f4eb588SAppaRao Puli     if (index > 0)
1487f4eb588SAppaRao Puli     {
1497f4eb588SAppaRao Puli         entryID += "_" + std::to_string(index);
1507f4eb588SAppaRao Puli     }
1517f4eb588SAppaRao Puli     return true;
1527f4eb588SAppaRao Puli }
1537f4eb588SAppaRao Puli 
15423a21a1cSEd Tanous inline int getEventLogParams(const std::string& logEntry,
15523a21a1cSEd Tanous                              std::string& timestamp, std::string& messageID,
1565e715de6SAppaRao Puli                              std::vector<std::string>& messageArgs)
1577f4eb588SAppaRao Puli {
1587f4eb588SAppaRao Puli     // The redfish log format is "<Timestamp> <MessageId>,<MessageArgs>"
1597f4eb588SAppaRao Puli     // First get the Timestamp
160f23b7296SEd Tanous     size_t space = logEntry.find_first_of(' ');
1617f4eb588SAppaRao Puli     if (space == std::string::npos)
1627f4eb588SAppaRao Puli     {
1637f4eb588SAppaRao Puli         return -EINVAL;
1647f4eb588SAppaRao Puli     }
1657f4eb588SAppaRao Puli     timestamp = logEntry.substr(0, space);
1667f4eb588SAppaRao Puli     // Then get the log contents
167f23b7296SEd Tanous     size_t entryStart = logEntry.find_first_not_of(' ', space);
1687f4eb588SAppaRao Puli     if (entryStart == std::string::npos)
1697f4eb588SAppaRao Puli     {
1707f4eb588SAppaRao Puli         return -EINVAL;
1717f4eb588SAppaRao Puli     }
1727f4eb588SAppaRao Puli     std::string_view entry(logEntry);
1737f4eb588SAppaRao Puli     entry.remove_prefix(entryStart);
1747f4eb588SAppaRao Puli     // Use split to separate the entry into its fields
1757f4eb588SAppaRao Puli     std::vector<std::string> logEntryFields;
17650ebd4afSEd Tanous     bmcweb::split(logEntryFields, entry, ',');
1777f4eb588SAppaRao Puli     // We need at least a MessageId to be valid
17826f6976fSEd Tanous     if (logEntryFields.empty())
1797f4eb588SAppaRao Puli     {
1807f4eb588SAppaRao Puli         return -EINVAL;
1817f4eb588SAppaRao Puli     }
1827f4eb588SAppaRao Puli     messageID = logEntryFields[0];
1837f4eb588SAppaRao Puli 
1847f4eb588SAppaRao Puli     // Get the MessageArgs from the log if there are any
1857f4eb588SAppaRao Puli     if (logEntryFields.size() > 1)
1867f4eb588SAppaRao Puli     {
18702cad96eSEd Tanous         const std::string& messageArgsStart = logEntryFields[1];
1887f4eb588SAppaRao Puli         // If the first string is empty, assume there are no MessageArgs
1897f4eb588SAppaRao Puli         if (!messageArgsStart.empty())
1907f4eb588SAppaRao Puli         {
1915e715de6SAppaRao Puli             messageArgs.assign(logEntryFields.begin() + 1,
1925e715de6SAppaRao Puli                                logEntryFields.end());
1937f4eb588SAppaRao Puli         }
1947f4eb588SAppaRao Puli     }
1957f4eb588SAppaRao Puli 
1967f4eb588SAppaRao Puli     return 0;
1977f4eb588SAppaRao Puli }
1987f4eb588SAppaRao Puli 
19923a21a1cSEd Tanous inline void getRegistryAndMessageKey(const std::string& messageID,
2007f4eb588SAppaRao Puli                                      std::string& registryName,
2017f4eb588SAppaRao Puli                                      std::string& messageKey)
2027f4eb588SAppaRao Puli {
2037f4eb588SAppaRao Puli     // Redfish MessageIds are in the form
2047f4eb588SAppaRao Puli     // RegistryName.MajorVersion.MinorVersion.MessageKey, so parse it to find
2057f4eb588SAppaRao Puli     // the right Message
2067f4eb588SAppaRao Puli     std::vector<std::string> fields;
2077f4eb588SAppaRao Puli     fields.reserve(4);
20850ebd4afSEd Tanous     bmcweb::split(fields, messageID, '.');
2097f4eb588SAppaRao Puli     if (fields.size() == 4)
2107f4eb588SAppaRao Puli     {
2117f4eb588SAppaRao Puli         registryName = fields[0];
2127f4eb588SAppaRao Puli         messageKey = fields[3];
2137f4eb588SAppaRao Puli     }
2147f4eb588SAppaRao Puli }
2157f4eb588SAppaRao Puli 
21623a21a1cSEd Tanous inline int formatEventLogEntry(const std::string& logEntryID,
2177f4eb588SAppaRao Puli                                const std::string& messageID,
218c5ba4c27SEd Tanous                                const std::span<std::string_view> messageArgs,
21923a21a1cSEd Tanous                                std::string timestamp,
220b5a76932SEd Tanous                                const std::string& customText,
2217f4eb588SAppaRao Puli                                nlohmann::json& logEntryJson)
2227f4eb588SAppaRao Puli {
2237f4eb588SAppaRao Puli     // Get the Message from the MessageRegistry
224fffb8c1fSEd Tanous     const registries::Message* message = registries::formatMessage(messageID);
2257f4eb588SAppaRao Puli 
22680f595e7SEd Tanous     if (message == nullptr)
2277f4eb588SAppaRao Puli     {
22880f595e7SEd Tanous         return -1;
2297f4eb588SAppaRao Puli     }
2307f4eb588SAppaRao Puli 
23189492a15SPatrick Williams     std::string msg = redfish::registries::fillMessageArgs(messageArgs,
23289492a15SPatrick Williams                                                            message->message);
23380f595e7SEd Tanous     if (msg.empty())
23480f595e7SEd Tanous     {
23580f595e7SEd Tanous         return -1;
23680f595e7SEd Tanous     }
2377f4eb588SAppaRao Puli 
2387f4eb588SAppaRao Puli     // Get the Created time from the timestamp. The log timestamp is in
2397f4eb588SAppaRao Puli     // RFC3339 format which matches the Redfish format except for the
2407f4eb588SAppaRao Puli     // fractional seconds between the '.' and the '+', so just remove them.
241f23b7296SEd Tanous     std::size_t dot = timestamp.find_first_of('.');
242b2f7609bSEd Tanous     std::size_t plus = timestamp.find_first_of('+', dot);
2437f4eb588SAppaRao Puli     if (dot != std::string::npos && plus != std::string::npos)
2447f4eb588SAppaRao Puli     {
2457f4eb588SAppaRao Puli         timestamp.erase(dot, plus - dot);
2467f4eb588SAppaRao Puli     }
2477f4eb588SAppaRao Puli 
2487f4eb588SAppaRao Puli     // Fill in the log entry with the gathered data
2491476687dSEd Tanous     logEntryJson["EventId"] = logEntryID;
2501476687dSEd Tanous     logEntryJson["EventType"] = "Event";
25180f595e7SEd Tanous     logEntryJson["Severity"] = message->messageSeverity;
2521476687dSEd Tanous     logEntryJson["Message"] = std::move(msg);
2531476687dSEd Tanous     logEntryJson["MessageId"] = messageID;
2541476687dSEd Tanous     logEntryJson["MessageArgs"] = messageArgs;
2551476687dSEd Tanous     logEntryJson["EventTimestamp"] = std::move(timestamp);
2561476687dSEd Tanous     logEntryJson["Context"] = customText;
2577f4eb588SAppaRao Puli     return 0;
2587f4eb588SAppaRao Puli }
2597f4eb588SAppaRao Puli 
2607f4eb588SAppaRao Puli } // namespace event_log
2617f4eb588SAppaRao Puli #endif
2627f4eb588SAppaRao Puli 
26323a21a1cSEd Tanous inline bool isFilterQuerySpecialChar(char c)
26407941a88SAyushi Smriti {
26507941a88SAyushi Smriti     switch (c)
26607941a88SAyushi Smriti     {
26707941a88SAyushi Smriti         case '(':
26807941a88SAyushi Smriti         case ')':
26907941a88SAyushi Smriti         case '\'':
27007941a88SAyushi Smriti             return true;
27107941a88SAyushi Smriti         default:
27207941a88SAyushi Smriti             return false;
27307941a88SAyushi Smriti     }
27407941a88SAyushi Smriti }
27507941a88SAyushi Smriti 
27623a21a1cSEd Tanous inline bool
27723a21a1cSEd Tanous     readSSEQueryParams(std::string sseFilter, std::string& formatType,
27807941a88SAyushi Smriti                        std::vector<std::string>& messageIds,
27907941a88SAyushi Smriti                        std::vector<std::string>& registryPrefixes,
280144b6318SAppaRao Puli                        std::vector<std::string>& metricReportDefinitions)
28107941a88SAyushi Smriti {
28207941a88SAyushi Smriti     sseFilter.erase(std::remove_if(sseFilter.begin(), sseFilter.end(),
28307941a88SAyushi Smriti                                    isFilterQuerySpecialChar),
28407941a88SAyushi Smriti                     sseFilter.end());
28507941a88SAyushi Smriti 
28607941a88SAyushi Smriti     std::vector<std::string> result;
28750ebd4afSEd Tanous 
28850ebd4afSEd Tanous     // NOLINTNEXTLINE
28950ebd4afSEd Tanous     bmcweb::split(result, sseFilter, ' ');
29007941a88SAyushi Smriti 
29107941a88SAyushi Smriti     BMCWEB_LOG_DEBUG << "No of tokens in SEE query: " << result.size();
29207941a88SAyushi Smriti 
29307941a88SAyushi Smriti     constexpr uint8_t divisor = 4;
29407941a88SAyushi Smriti     constexpr uint8_t minTokenSize = 3;
29507941a88SAyushi Smriti     if (result.size() % divisor != minTokenSize)
29607941a88SAyushi Smriti     {
29707941a88SAyushi Smriti         BMCWEB_LOG_ERROR << "Invalid SSE filter specified.";
29807941a88SAyushi Smriti         return false;
29907941a88SAyushi Smriti     }
30007941a88SAyushi Smriti 
30107941a88SAyushi Smriti     for (std::size_t i = 0; i < result.size(); i += divisor)
30207941a88SAyushi Smriti     {
30302cad96eSEd Tanous         const std::string& key = result[i];
30402cad96eSEd Tanous         const std::string& op = result[i + 1];
30502cad96eSEd Tanous         const std::string& value = result[i + 2];
30607941a88SAyushi Smriti 
30707941a88SAyushi Smriti         if ((i + minTokenSize) < result.size())
30807941a88SAyushi Smriti         {
30902cad96eSEd Tanous             const std::string& separator = result[i + minTokenSize];
31007941a88SAyushi Smriti             // SSE supports only "or" and "and" in query params.
3114e0453b1SGunnar Mills             if ((separator != "or") && (separator != "and"))
31207941a88SAyushi Smriti             {
31307941a88SAyushi Smriti                 BMCWEB_LOG_ERROR
31407941a88SAyushi Smriti                     << "Invalid group operator in SSE query parameters";
31507941a88SAyushi Smriti                 return false;
31607941a88SAyushi Smriti             }
31707941a88SAyushi Smriti         }
31807941a88SAyushi Smriti 
31907941a88SAyushi Smriti         // SSE supports only "eq" as per spec.
32007941a88SAyushi Smriti         if (op != "eq")
32107941a88SAyushi Smriti         {
32207941a88SAyushi Smriti             BMCWEB_LOG_ERROR
32307941a88SAyushi Smriti                 << "Invalid assignment operator in SSE query parameters";
32407941a88SAyushi Smriti             return false;
32507941a88SAyushi Smriti         }
32607941a88SAyushi Smriti 
32707941a88SAyushi Smriti         BMCWEB_LOG_DEBUG << key << " : " << value;
32807941a88SAyushi Smriti         if (key == "EventFormatType")
32907941a88SAyushi Smriti         {
33007941a88SAyushi Smriti             formatType = value;
33107941a88SAyushi Smriti         }
33207941a88SAyushi Smriti         else if (key == "MessageId")
33307941a88SAyushi Smriti         {
33407941a88SAyushi Smriti             messageIds.push_back(value);
33507941a88SAyushi Smriti         }
33607941a88SAyushi Smriti         else if (key == "RegistryPrefix")
33707941a88SAyushi Smriti         {
33807941a88SAyushi Smriti             registryPrefixes.push_back(value);
33907941a88SAyushi Smriti         }
34007941a88SAyushi Smriti         else if (key == "MetricReportDefinition")
34107941a88SAyushi Smriti         {
34207941a88SAyushi Smriti             metricReportDefinitions.push_back(value);
34307941a88SAyushi Smriti         }
34407941a88SAyushi Smriti         else
34507941a88SAyushi Smriti         {
34607941a88SAyushi Smriti             BMCWEB_LOG_ERROR << "Invalid property(" << key
34707941a88SAyushi Smriti                              << ")in SSE filter query.";
34807941a88SAyushi Smriti             return false;
34907941a88SAyushi Smriti         }
35007941a88SAyushi Smriti     }
35107941a88SAyushi Smriti     return true;
35207941a88SAyushi Smriti }
35307941a88SAyushi Smriti 
35428afb49cSJunLin Chen class Subscription : public persistent_data::UserSubscription
355b52664e2SAppaRao Puli {
356b52664e2SAppaRao Puli   public:
357b52664e2SAppaRao Puli     Subscription(const Subscription&) = delete;
358b52664e2SAppaRao Puli     Subscription& operator=(const Subscription&) = delete;
359b52664e2SAppaRao Puli     Subscription(Subscription&&) = delete;
360b52664e2SAppaRao Puli     Subscription& operator=(Subscription&&) = delete;
361b52664e2SAppaRao Puli 
362eb1c47d3SEd Tanous     Subscription(const std::string& inHost, uint16_t inPort,
363f8ca6d79SEd Tanous                  const std::string& inPath, const std::string& inUriProto,
364f8ca6d79SEd Tanous                  boost::asio::io_context& ioc) :
365d14a48ffSCarson Labrado         host(inHost),
366d14a48ffSCarson Labrado         port(inPort), policy(std::make_shared<crow::ConnectionPolicy>()),
3675e44e3d8SAppaRao Puli         path(inPath), uriProto(inUriProto)
368b52664e2SAppaRao Puli     {
3695e44e3d8SAppaRao Puli         client.emplace(ioc, policy);
3707adb85acSSunitha Harish         // Subscription constructor
371d14a48ffSCarson Labrado         policy->invalidResp = retryRespHandler;
372b52664e2SAppaRao Puli     }
3734bbf237fSAppaRao Puli 
3745e44e3d8SAppaRao Puli     explicit Subscription(crow::sse_socket::Connection& connIn) :
3755e44e3d8SAppaRao Puli         sseConn(&connIn)
3765e44e3d8SAppaRao Puli     {}
3775e44e3d8SAppaRao Puli 
3789f616dd1SEd Tanous     ~Subscription() = default;
379b52664e2SAppaRao Puli 
3805e44e3d8SAppaRao Puli     bool sendEvent(std::string&& msg)
381b52664e2SAppaRao Puli     {
3826ba8c82eSsunharis_in         persistent_data::EventServiceConfig eventServiceConfig =
3836ba8c82eSsunharis_in             persistent_data::EventServiceStore::getInstance()
3846ba8c82eSsunharis_in                 .getEventServiceConfig();
3856ba8c82eSsunharis_in         if (!eventServiceConfig.enabled)
3866ba8c82eSsunharis_in         {
3876ba8c82eSsunharis_in             return false;
3886ba8c82eSsunharis_in         }
3896ba8c82eSsunharis_in 
390e38778a5SAppaRao Puli         bool useSSL = (uriProto == "https");
391f52c03c1SCarson Labrado         // A connection pool will be created if one does not already exist
3925e44e3d8SAppaRao Puli         if (client)
3935e44e3d8SAppaRao Puli         {
3945e44e3d8SAppaRao Puli             client->sendData(std::move(msg), host, port, path, useSSL,
3955e44e3d8SAppaRao Puli                              httpHeaders, boost::beast::http::verb::post);
3965e44e3d8SAppaRao Puli             return true;
3975e44e3d8SAppaRao Puli         }
3987adb85acSSunitha Harish 
3994bbf237fSAppaRao Puli         if (sseConn != nullptr)
4004bbf237fSAppaRao Puli         {
4015e44e3d8SAppaRao Puli             eventSeqNum++;
4025e44e3d8SAppaRao Puli             sseConn->sendEvent(std::to_string(eventSeqNum), msg);
4034bbf237fSAppaRao Puli         }
4046ba8c82eSsunharis_in         return true;
4054bbf237fSAppaRao Puli     }
4064bbf237fSAppaRao Puli 
4076ba8c82eSsunharis_in     bool sendTestEventLog()
4080b4bdd93SAppaRao Puli     {
4090b4bdd93SAppaRao Puli         nlohmann::json logEntryArray;
4100b4bdd93SAppaRao Puli         logEntryArray.push_back({});
4110b4bdd93SAppaRao Puli         nlohmann::json& logEntryJson = logEntryArray.back();
4120b4bdd93SAppaRao Puli 
413613dabeaSEd Tanous         logEntryJson["EventId"] = "TestID";
414613dabeaSEd Tanous         logEntryJson["EventType"] = "Event";
415613dabeaSEd Tanous         logEntryJson["Severity"] = "OK";
416613dabeaSEd Tanous         logEntryJson["Message"] = "Generated test event";
417613dabeaSEd Tanous         logEntryJson["MessageId"] = "OpenBMC.0.2.TestEventLog";
418613dabeaSEd Tanous         logEntryJson["MessageArgs"] = nlohmann::json::array();
419613dabeaSEd Tanous         logEntryJson["EventTimestamp"] =
420613dabeaSEd Tanous             redfish::time_utils::getDateTimeOffsetNow().first;
421613dabeaSEd Tanous         logEntryJson["Context"] = customText;
4220b4bdd93SAppaRao Puli 
4231476687dSEd Tanous         nlohmann::json msg;
4241476687dSEd Tanous         msg["@odata.type"] = "#Event.v1_4_0.Event";
4251476687dSEd Tanous         msg["Id"] = std::to_string(eventSeqNum);
4261476687dSEd Tanous         msg["Name"] = "Event Log";
4271476687dSEd Tanous         msg["Events"] = logEntryArray;
4280b4bdd93SAppaRao Puli 
42989492a15SPatrick Williams         std::string strMsg = msg.dump(2, ' ', true,
43089492a15SPatrick Williams                                       nlohmann::json::error_handler_t::replace);
4315e44e3d8SAppaRao Puli         return sendEvent(std::move(strMsg));
4320b4bdd93SAppaRao Puli     }
4330b4bdd93SAppaRao Puli 
4347f4eb588SAppaRao Puli #ifndef BMCWEB_ENABLE_REDFISH_DBUS_LOG_ENTRIES
4357f4eb588SAppaRao Puli     void filterAndSendEventLogs(
4367f4eb588SAppaRao Puli         const std::vector<EventLogObjectsType>& eventRecords)
4377f4eb588SAppaRao Puli     {
4387f4eb588SAppaRao Puli         nlohmann::json logEntryArray;
4397f4eb588SAppaRao Puli         for (const EventLogObjectsType& logEntry : eventRecords)
4407f4eb588SAppaRao Puli         {
4417f4eb588SAppaRao Puli             const std::string& idStr = std::get<0>(logEntry);
4427f4eb588SAppaRao Puli             const std::string& timestamp = std::get<1>(logEntry);
4437f4eb588SAppaRao Puli             const std::string& messageID = std::get<2>(logEntry);
4447f4eb588SAppaRao Puli             const std::string& registryName = std::get<3>(logEntry);
4457f4eb588SAppaRao Puli             const std::string& messageKey = std::get<4>(logEntry);
4465e715de6SAppaRao Puli             const std::vector<std::string>& messageArgs = std::get<5>(logEntry);
4477f4eb588SAppaRao Puli 
4487f4eb588SAppaRao Puli             // If registryPrefixes list is empty, don't filter events
4497f4eb588SAppaRao Puli             // send everything.
45026f6976fSEd Tanous             if (!registryPrefixes.empty())
4517f4eb588SAppaRao Puli             {
4527f4eb588SAppaRao Puli                 auto obj = std::find(registryPrefixes.begin(),
4537f4eb588SAppaRao Puli                                      registryPrefixes.end(), registryName);
4547f4eb588SAppaRao Puli                 if (obj == registryPrefixes.end())
4557f4eb588SAppaRao Puli                 {
4567f4eb588SAppaRao Puli                     continue;
4577f4eb588SAppaRao Puli                 }
4587f4eb588SAppaRao Puli             }
4597f4eb588SAppaRao Puli 
4607f4eb588SAppaRao Puli             // If registryMsgIds list is empty, don't filter events
4617f4eb588SAppaRao Puli             // send everything.
46226f6976fSEd Tanous             if (!registryMsgIds.empty())
4637f4eb588SAppaRao Puli             {
4647f4eb588SAppaRao Puli                 auto obj = std::find(registryMsgIds.begin(),
4657f4eb588SAppaRao Puli                                      registryMsgIds.end(), messageKey);
4667f4eb588SAppaRao Puli                 if (obj == registryMsgIds.end())
4677f4eb588SAppaRao Puli                 {
4687f4eb588SAppaRao Puli                     continue;
4697f4eb588SAppaRao Puli                 }
4707f4eb588SAppaRao Puli             }
4717f4eb588SAppaRao Puli 
472c5ba4c27SEd Tanous             std::vector<std::string_view> messageArgsView(messageArgs.begin(),
473c5ba4c27SEd Tanous                                                           messageArgs.end());
474c5ba4c27SEd Tanous 
4757f4eb588SAppaRao Puli             logEntryArray.push_back({});
4767f4eb588SAppaRao Puli             nlohmann::json& bmcLogEntry = logEntryArray.back();
477c5ba4c27SEd Tanous             if (event_log::formatEventLogEntry(idStr, messageID,
478c5ba4c27SEd Tanous                                                messageArgsView, timestamp,
479c5ba4c27SEd Tanous                                                customText, bmcLogEntry) != 0)
4807f4eb588SAppaRao Puli             {
4817f4eb588SAppaRao Puli                 BMCWEB_LOG_DEBUG << "Read eventLog entry failed";
4827f4eb588SAppaRao Puli                 continue;
4837f4eb588SAppaRao Puli             }
4847f4eb588SAppaRao Puli         }
4857f4eb588SAppaRao Puli 
48626f6976fSEd Tanous         if (logEntryArray.empty())
4877f4eb588SAppaRao Puli         {
4887f4eb588SAppaRao Puli             BMCWEB_LOG_DEBUG << "No log entries available to be transferred.";
4897f4eb588SAppaRao Puli             return;
4907f4eb588SAppaRao Puli         }
4917f4eb588SAppaRao Puli 
4921476687dSEd Tanous         nlohmann::json msg;
4931476687dSEd Tanous         msg["@odata.type"] = "#Event.v1_4_0.Event";
4941476687dSEd Tanous         msg["Id"] = std::to_string(eventSeqNum);
4951476687dSEd Tanous         msg["Name"] = "Event Log";
4961476687dSEd Tanous         msg["Events"] = logEntryArray;
49789492a15SPatrick Williams         std::string strMsg = msg.dump(2, ' ', true,
49889492a15SPatrick Williams                                       nlohmann::json::error_handler_t::replace);
4995e44e3d8SAppaRao Puli         sendEvent(std::move(strMsg));
5005e44e3d8SAppaRao Puli         eventSeqNum++;
5017f4eb588SAppaRao Puli     }
5027f4eb588SAppaRao Puli #endif
5037f4eb588SAppaRao Puli 
504248d0230SEd Tanous     void filterAndSendReports(const std::string& reportId,
5051e1e598dSJonathan Doman                               const telemetry::TimestampReadings& var)
506156d6b00SAppaRao Puli     {
507ef4c65b7SEd Tanous         boost::urls::url mrdUri = boost::urls::format(
508ef4c65b7SEd Tanous             "/redfish/v1/TelemetryService/MetricReportDefinitions/{}",
509ef4c65b7SEd Tanous             reportId);
510156d6b00SAppaRao Puli 
511156d6b00SAppaRao Puli         // Empty list means no filter. Send everything.
51226f6976fSEd Tanous         if (!metricReportDefinitions.empty())
513156d6b00SAppaRao Puli         {
514156d6b00SAppaRao Puli             if (std::find(metricReportDefinitions.begin(),
515156d6b00SAppaRao Puli                           metricReportDefinitions.end(),
516079360aeSEd Tanous                           mrdUri.buffer()) == metricReportDefinitions.end())
517156d6b00SAppaRao Puli             {
518156d6b00SAppaRao Puli                 return;
519156d6b00SAppaRao Puli             }
520156d6b00SAppaRao Puli         }
521156d6b00SAppaRao Puli 
522c0353249SWludzik, Jozef         nlohmann::json msg;
523248d0230SEd Tanous         if (!telemetry::fillReport(msg, reportId, var))
524156d6b00SAppaRao Puli         {
525c0353249SWludzik, Jozef             BMCWEB_LOG_ERROR << "Failed to fill the MetricReport for DBus "
526c0353249SWludzik, Jozef                                 "Report with id "
527248d0230SEd Tanous                              << reportId;
528c0353249SWludzik, Jozef             return;
529156d6b00SAppaRao Puli         }
530156d6b00SAppaRao Puli 
53122daffd7SAppaRao Puli         // Context is set by user during Event subscription and it must be
53222daffd7SAppaRao Puli         // set for MetricReport response.
53322daffd7SAppaRao Puli         if (!customText.empty())
53422daffd7SAppaRao Puli         {
53522daffd7SAppaRao Puli             msg["Context"] = customText;
53622daffd7SAppaRao Puli         }
53722daffd7SAppaRao Puli 
53889492a15SPatrick Williams         std::string strMsg = msg.dump(2, ' ', true,
53989492a15SPatrick Williams                                       nlohmann::json::error_handler_t::replace);
5405e44e3d8SAppaRao Puli         sendEvent(std::move(strMsg));
541156d6b00SAppaRao Puli     }
542156d6b00SAppaRao Puli 
543d14a48ffSCarson Labrado     void updateRetryConfig(uint32_t retryAttempts,
544d14a48ffSCarson Labrado                            uint32_t retryTimeoutInterval)
545fe44eb0bSAyushi Smriti     {
546d14a48ffSCarson Labrado         policy->maxRetryAttempts = retryAttempts;
547d14a48ffSCarson Labrado         policy->retryIntervalSecs = std::chrono::seconds(retryTimeoutInterval);
54862de0c68SAppaRao Puli     }
549fe44eb0bSAyushi Smriti 
5509eb808c1SEd Tanous     uint64_t getEventSeqNum() const
55196330b99SSunitha Harish     {
55296330b99SSunitha Harish         return eventSeqNum;
55396330b99SSunitha Harish     }
55496330b99SSunitha Harish 
5555e44e3d8SAppaRao Puli     void setSubscriptionId(const std::string& id2)
5565e44e3d8SAppaRao Puli     {
5575e44e3d8SAppaRao Puli         BMCWEB_LOG_DEBUG << "Subscription ID: " << id2;
5585e44e3d8SAppaRao Puli         subId = id2;
5595e44e3d8SAppaRao Puli     }
5605e44e3d8SAppaRao Puli 
5615e44e3d8SAppaRao Puli     std::string getSubscriptionId()
5625e44e3d8SAppaRao Puli     {
5635e44e3d8SAppaRao Puli         return subId;
5645e44e3d8SAppaRao Puli     }
5655e44e3d8SAppaRao Puli 
5665e44e3d8SAppaRao Puli     bool matchSseId(const crow::sse_socket::Connection& thisConn)
5675e44e3d8SAppaRao Puli     {
5685e44e3d8SAppaRao Puli         return &thisConn == sseConn;
5695e44e3d8SAppaRao Puli     }
5705e44e3d8SAppaRao Puli 
571b52664e2SAppaRao Puli   private:
5725e44e3d8SAppaRao Puli     std::string subId;
573d14a48ffSCarson Labrado     uint64_t eventSeqNum = 1;
574b52664e2SAppaRao Puli     std::string host;
575eb1c47d3SEd Tanous     uint16_t port = 0;
576d14a48ffSCarson Labrado     std::shared_ptr<crow::ConnectionPolicy> policy;
5775e44e3d8SAppaRao Puli     crow::sse_socket::Connection* sseConn = nullptr;
5785e44e3d8SAppaRao Puli     std::optional<crow::HttpClient> client;
579b52664e2SAppaRao Puli     std::string path;
580b52664e2SAppaRao Puli     std::string uriProto;
581a7a80296SCarson Labrado 
582a7a80296SCarson Labrado     // Check used to indicate what response codes are valid as part of our retry
583a7a80296SCarson Labrado     // policy.  2XX is considered acceptable
584a7a80296SCarson Labrado     static boost::system::error_code retryRespHandler(unsigned int respCode)
585a7a80296SCarson Labrado     {
586a7a80296SCarson Labrado         BMCWEB_LOG_DEBUG
587a7a80296SCarson Labrado             << "Checking response code validity for SubscriptionEvent";
588a7a80296SCarson Labrado         if ((respCode < 200) || (respCode >= 300))
589a7a80296SCarson Labrado         {
590a7a80296SCarson Labrado             return boost::system::errc::make_error_code(
591a7a80296SCarson Labrado                 boost::system::errc::result_out_of_range);
592a7a80296SCarson Labrado         }
593a7a80296SCarson Labrado 
594a7a80296SCarson Labrado         // Return 0 if the response code is valid
595a7a80296SCarson Labrado         return boost::system::errc::make_error_code(
596a7a80296SCarson Labrado             boost::system::errc::success);
5979fa6d147SNan Zhou     }
598b52664e2SAppaRao Puli };
599b52664e2SAppaRao Puli 
600b52664e2SAppaRao Puli class EventServiceManager
601b52664e2SAppaRao Puli {
602b52664e2SAppaRao Puli   private:
603d3a9e084SEd Tanous     bool serviceEnabled = false;
604d3a9e084SEd Tanous     uint32_t retryAttempts = 0;
605d3a9e084SEd Tanous     uint32_t retryTimeoutInterval = 0;
6067d1cc387SAppaRao Puli 
6072558979cSP Dheeraj Srujan Kumar     std::streampos redfishLogFilePosition{0};
6089f616dd1SEd Tanous     size_t noOfEventLogSubscribers{0};
6099f616dd1SEd Tanous     size_t noOfMetricReportSubscribers{0};
61059d494eeSPatrick Williams     std::shared_ptr<sdbusplus::bus::match_t> matchTelemetryMonitor;
611b52664e2SAppaRao Puli     boost::container::flat_map<std::string, std::shared_ptr<Subscription>>
612b52664e2SAppaRao Puli         subscriptionsMap;
613b52664e2SAppaRao Puli 
6149f616dd1SEd Tanous     uint64_t eventId{1};
61596330b99SSunitha Harish 
616f8ca6d79SEd Tanous     boost::asio::io_context& ioc;
617f8ca6d79SEd Tanous 
618b52664e2SAppaRao Puli   public:
6199f616dd1SEd Tanous     EventServiceManager(const EventServiceManager&) = delete;
6209f616dd1SEd Tanous     EventServiceManager& operator=(const EventServiceManager&) = delete;
6219f616dd1SEd Tanous     EventServiceManager(EventServiceManager&&) = delete;
6229f616dd1SEd Tanous     EventServiceManager& operator=(EventServiceManager&&) = delete;
623ecd6a3a2SEd Tanous     ~EventServiceManager() = default;
6249f616dd1SEd Tanous 
625f8ca6d79SEd Tanous     explicit EventServiceManager(boost::asio::io_context& iocIn) : ioc(iocIn)
626b52664e2SAppaRao Puli     {
627f8ca6d79SEd Tanous         // Load config from persist store.
628f8ca6d79SEd Tanous         initConfig();
629f8ca6d79SEd Tanous     }
630f8ca6d79SEd Tanous 
631f8ca6d79SEd Tanous     static EventServiceManager&
632f8ca6d79SEd Tanous         getInstance(boost::asio::io_context* ioc = nullptr)
633f8ca6d79SEd Tanous     {
634f8ca6d79SEd Tanous         static EventServiceManager handler(*ioc);
635b52664e2SAppaRao Puli         return handler;
636b52664e2SAppaRao Puli     }
637b52664e2SAppaRao Puli 
6381bf712bcSAyushi Smriti     void initConfig()
6391bf712bcSAyushi Smriti     {
64028afb49cSJunLin Chen         loadOldBehavior();
6411bf712bcSAyushi Smriti 
64228afb49cSJunLin Chen         persistent_data::EventServiceConfig eventServiceConfig =
64328afb49cSJunLin Chen             persistent_data::EventServiceStore::getInstance()
64428afb49cSJunLin Chen                 .getEventServiceConfig();
6451bf712bcSAyushi Smriti 
64628afb49cSJunLin Chen         serviceEnabled = eventServiceConfig.enabled;
64728afb49cSJunLin Chen         retryAttempts = eventServiceConfig.retryAttempts;
64828afb49cSJunLin Chen         retryTimeoutInterval = eventServiceConfig.retryTimeoutInterval;
6491bf712bcSAyushi Smriti 
65028afb49cSJunLin Chen         for (const auto& it : persistent_data::EventServiceStore::getInstance()
65128afb49cSJunLin Chen                                   .subscriptionsConfigMap)
6521bf712bcSAyushi Smriti         {
65328afb49cSJunLin Chen             std::shared_ptr<persistent_data::UserSubscription> newSub =
65428afb49cSJunLin Chen                 it.second;
6554bbf237fSAppaRao Puli 
6561bf712bcSAyushi Smriti             std::string host;
6571bf712bcSAyushi Smriti             std::string urlProto;
658eb1c47d3SEd Tanous             uint16_t port = 0;
6591bf712bcSAyushi Smriti             std::string path;
66011baefe4SEd Tanous             bool status = crow::utility::validateAndSplitUrl(
66111baefe4SEd Tanous                 newSub->destinationUrl, urlProto, host, port, path);
6621bf712bcSAyushi Smriti 
6631bf712bcSAyushi Smriti             if (!status)
6641bf712bcSAyushi Smriti             {
6651bf712bcSAyushi Smriti                 BMCWEB_LOG_ERROR
6661bf712bcSAyushi Smriti                     << "Failed to validate and split destination url";
6671bf712bcSAyushi Smriti                 continue;
6681bf712bcSAyushi Smriti             }
6691bf712bcSAyushi Smriti             std::shared_ptr<Subscription> subValue =
670f8ca6d79SEd Tanous                 std::make_shared<Subscription>(host, port, path, urlProto, ioc);
6711bf712bcSAyushi Smriti 
67228afb49cSJunLin Chen             subValue->id = newSub->id;
67328afb49cSJunLin Chen             subValue->destinationUrl = newSub->destinationUrl;
67428afb49cSJunLin Chen             subValue->protocol = newSub->protocol;
67528afb49cSJunLin Chen             subValue->retryPolicy = newSub->retryPolicy;
67628afb49cSJunLin Chen             subValue->customText = newSub->customText;
67728afb49cSJunLin Chen             subValue->eventFormatType = newSub->eventFormatType;
67828afb49cSJunLin Chen             subValue->subscriptionType = newSub->subscriptionType;
67928afb49cSJunLin Chen             subValue->registryMsgIds = newSub->registryMsgIds;
68028afb49cSJunLin Chen             subValue->registryPrefixes = newSub->registryPrefixes;
68128afb49cSJunLin Chen             subValue->resourceTypes = newSub->resourceTypes;
68228afb49cSJunLin Chen             subValue->httpHeaders = newSub->httpHeaders;
68328afb49cSJunLin Chen             subValue->metricReportDefinitions = newSub->metricReportDefinitions;
6841bf712bcSAyushi Smriti 
68528afb49cSJunLin Chen             if (subValue->id.empty())
6861bf712bcSAyushi Smriti             {
6871bf712bcSAyushi Smriti                 BMCWEB_LOG_ERROR << "Failed to add subscription";
6881bf712bcSAyushi Smriti             }
68928afb49cSJunLin Chen             subscriptionsMap.insert(std::pair(subValue->id, subValue));
69028afb49cSJunLin Chen 
69128afb49cSJunLin Chen             updateNoOfSubscribersCount();
69228afb49cSJunLin Chen 
69328afb49cSJunLin Chen #ifndef BMCWEB_ENABLE_REDFISH_DBUS_LOG_ENTRIES
6942558979cSP Dheeraj Srujan Kumar 
6952558979cSP Dheeraj Srujan Kumar             cacheRedfishLogFile();
6962558979cSP Dheeraj Srujan Kumar 
69728afb49cSJunLin Chen #endif
69828afb49cSJunLin Chen             // Update retry configuration.
69928afb49cSJunLin Chen             subValue->updateRetryConfig(retryAttempts, retryTimeoutInterval);
7001bf712bcSAyushi Smriti         }
7011bf712bcSAyushi Smriti     }
7021bf712bcSAyushi Smriti 
70356d2396dSEd Tanous     static void loadOldBehavior()
704b52664e2SAppaRao Puli     {
70528afb49cSJunLin Chen         std::ifstream eventConfigFile(eventServiceFile);
70628afb49cSJunLin Chen         if (!eventConfigFile.good())
7071bf712bcSAyushi Smriti         {
70828afb49cSJunLin Chen             BMCWEB_LOG_DEBUG << "Old eventService config not exist";
70928afb49cSJunLin Chen             return;
71028afb49cSJunLin Chen         }
71128afb49cSJunLin Chen         auto jsonData = nlohmann::json::parse(eventConfigFile, nullptr, false);
71228afb49cSJunLin Chen         if (jsonData.is_discarded())
7134bbf237fSAppaRao Puli         {
71428afb49cSJunLin Chen             BMCWEB_LOG_ERROR << "Old eventService config parse error.";
71528afb49cSJunLin Chen             return;
71628afb49cSJunLin Chen         }
71728afb49cSJunLin Chen 
71828afb49cSJunLin Chen         for (const auto& item : jsonData.items())
71928afb49cSJunLin Chen         {
72028afb49cSJunLin Chen             if (item.key() == "Configuration")
72128afb49cSJunLin Chen             {
72228afb49cSJunLin Chen                 persistent_data::EventServiceStore::getInstance()
72328afb49cSJunLin Chen                     .getEventServiceConfig()
72428afb49cSJunLin Chen                     .fromJson(item.value());
72528afb49cSJunLin Chen             }
72628afb49cSJunLin Chen             else if (item.key() == "Subscriptions")
72728afb49cSJunLin Chen             {
72828afb49cSJunLin Chen                 for (const auto& elem : item.value())
72928afb49cSJunLin Chen                 {
73028afb49cSJunLin Chen                     std::shared_ptr<persistent_data::UserSubscription>
73128afb49cSJunLin Chen                         newSubscription =
73228afb49cSJunLin Chen                             persistent_data::UserSubscription::fromJson(elem,
73328afb49cSJunLin Chen                                                                         true);
73428afb49cSJunLin Chen                     if (newSubscription == nullptr)
73528afb49cSJunLin Chen                     {
73628afb49cSJunLin Chen                         BMCWEB_LOG_ERROR << "Problem reading subscription "
73728afb49cSJunLin Chen                                             "from old persistent store";
7384bbf237fSAppaRao Puli                         continue;
7394bbf237fSAppaRao Puli                     }
7401bf712bcSAyushi Smriti 
74128afb49cSJunLin Chen                     std::uniform_int_distribution<uint32_t> dist(0);
74228afb49cSJunLin Chen                     bmcweb::OpenSSLGenerator gen;
7431bf712bcSAyushi Smriti 
74428afb49cSJunLin Chen                     std::string id;
7451bf712bcSAyushi Smriti 
74628afb49cSJunLin Chen                     int retry = 3;
747e662eae8SEd Tanous                     while (retry != 0)
7481bf712bcSAyushi Smriti                     {
74928afb49cSJunLin Chen                         id = std::to_string(dist(gen));
75028afb49cSJunLin Chen                         if (gen.error())
7517d1cc387SAppaRao Puli                         {
75228afb49cSJunLin Chen                             retry = 0;
75328afb49cSJunLin Chen                             break;
75428afb49cSJunLin Chen                         }
75528afb49cSJunLin Chen                         newSubscription->id = id;
75628afb49cSJunLin Chen                         auto inserted =
75728afb49cSJunLin Chen                             persistent_data::EventServiceStore::getInstance()
75828afb49cSJunLin Chen                                 .subscriptionsConfigMap.insert(
75928afb49cSJunLin Chen                                     std::pair(id, newSubscription));
76028afb49cSJunLin Chen                         if (inserted.second)
76128afb49cSJunLin Chen                         {
76228afb49cSJunLin Chen                             break;
76328afb49cSJunLin Chen                         }
76428afb49cSJunLin Chen                         --retry;
7657d1cc387SAppaRao Puli                     }
7667d1cc387SAppaRao Puli 
76728afb49cSJunLin Chen                     if (retry <= 0)
76828afb49cSJunLin Chen                     {
76928afb49cSJunLin Chen                         BMCWEB_LOG_ERROR
77028afb49cSJunLin Chen                             << "Failed to generate random number from old "
77128afb49cSJunLin Chen                                "persistent store";
77228afb49cSJunLin Chen                         continue;
77328afb49cSJunLin Chen                     }
77428afb49cSJunLin Chen                 }
77528afb49cSJunLin Chen             }
77628afb49cSJunLin Chen 
77728afb49cSJunLin Chen             persistent_data::getConfig().writeData();
77828afb49cSJunLin Chen             std::remove(eventServiceFile);
77928afb49cSJunLin Chen             BMCWEB_LOG_DEBUG << "Remove old eventservice config";
78028afb49cSJunLin Chen         }
78128afb49cSJunLin Chen     }
78228afb49cSJunLin Chen 
7839eb808c1SEd Tanous     void updateSubscriptionData() const
78428afb49cSJunLin Chen     {
78528afb49cSJunLin Chen         persistent_data::EventServiceStore::getInstance()
78628afb49cSJunLin Chen             .eventServiceConfig.enabled = serviceEnabled;
78728afb49cSJunLin Chen         persistent_data::EventServiceStore::getInstance()
78828afb49cSJunLin Chen             .eventServiceConfig.retryAttempts = retryAttempts;
78928afb49cSJunLin Chen         persistent_data::EventServiceStore::getInstance()
79028afb49cSJunLin Chen             .eventServiceConfig.retryTimeoutInterval = retryTimeoutInterval;
79128afb49cSJunLin Chen 
79228afb49cSJunLin Chen         persistent_data::getConfig().writeData();
79328afb49cSJunLin Chen     }
79428afb49cSJunLin Chen 
79528afb49cSJunLin Chen     void setEventServiceConfig(const persistent_data::EventServiceConfig& cfg)
7967d1cc387SAppaRao Puli     {
7977d1cc387SAppaRao Puli         bool updateConfig = false;
798fe44eb0bSAyushi Smriti         bool updateRetryCfg = false;
7997d1cc387SAppaRao Puli 
80028afb49cSJunLin Chen         if (serviceEnabled != cfg.enabled)
8017d1cc387SAppaRao Puli         {
80228afb49cSJunLin Chen             serviceEnabled = cfg.enabled;
803e662eae8SEd Tanous             if (serviceEnabled && noOfMetricReportSubscribers != 0U)
8047d1cc387SAppaRao Puli             {
8057d1cc387SAppaRao Puli                 registerMetricReportSignal();
8067d1cc387SAppaRao Puli             }
8077d1cc387SAppaRao Puli             else
8087d1cc387SAppaRao Puli             {
8097d1cc387SAppaRao Puli                 unregisterMetricReportSignal();
8107d1cc387SAppaRao Puli             }
8117d1cc387SAppaRao Puli             updateConfig = true;
8127d1cc387SAppaRao Puli         }
8137d1cc387SAppaRao Puli 
81428afb49cSJunLin Chen         if (retryAttempts != cfg.retryAttempts)
8157d1cc387SAppaRao Puli         {
81628afb49cSJunLin Chen             retryAttempts = cfg.retryAttempts;
8177d1cc387SAppaRao Puli             updateConfig = true;
818fe44eb0bSAyushi Smriti             updateRetryCfg = true;
8197d1cc387SAppaRao Puli         }
8207d1cc387SAppaRao Puli 
82128afb49cSJunLin Chen         if (retryTimeoutInterval != cfg.retryTimeoutInterval)
8227d1cc387SAppaRao Puli         {
82328afb49cSJunLin Chen             retryTimeoutInterval = cfg.retryTimeoutInterval;
8247d1cc387SAppaRao Puli             updateConfig = true;
825fe44eb0bSAyushi Smriti             updateRetryCfg = true;
8267d1cc387SAppaRao Puli         }
8277d1cc387SAppaRao Puli 
8287d1cc387SAppaRao Puli         if (updateConfig)
8297d1cc387SAppaRao Puli         {
8307d1cc387SAppaRao Puli             updateSubscriptionData();
8317d1cc387SAppaRao Puli         }
832fe44eb0bSAyushi Smriti 
833fe44eb0bSAyushi Smriti         if (updateRetryCfg)
834fe44eb0bSAyushi Smriti         {
835fe44eb0bSAyushi Smriti             // Update the changed retry config to all subscriptions
836fe44eb0bSAyushi Smriti             for (const auto& it :
837fe44eb0bSAyushi Smriti                  EventServiceManager::getInstance().subscriptionsMap)
838fe44eb0bSAyushi Smriti             {
8395e44e3d8SAppaRao Puli                 Subscription& entry = *it.second;
8405e44e3d8SAppaRao Puli                 entry.updateRetryConfig(retryAttempts, retryTimeoutInterval);
841fe44eb0bSAyushi Smriti             }
842fe44eb0bSAyushi Smriti         }
8437d1cc387SAppaRao Puli     }
8447d1cc387SAppaRao Puli 
8457d1cc387SAppaRao Puli     void updateNoOfSubscribersCount()
8467d1cc387SAppaRao Puli     {
8477d1cc387SAppaRao Puli         size_t eventLogSubCount = 0;
8487d1cc387SAppaRao Puli         size_t metricReportSubCount = 0;
8497d1cc387SAppaRao Puli         for (const auto& it : subscriptionsMap)
8507d1cc387SAppaRao Puli         {
8517d1cc387SAppaRao Puli             std::shared_ptr<Subscription> entry = it.second;
8527d1cc387SAppaRao Puli             if (entry->eventFormatType == eventFormatType)
8537d1cc387SAppaRao Puli             {
8547d1cc387SAppaRao Puli                 eventLogSubCount++;
8557d1cc387SAppaRao Puli             }
8567d1cc387SAppaRao Puli             else if (entry->eventFormatType == metricReportFormatType)
8577d1cc387SAppaRao Puli             {
8587d1cc387SAppaRao Puli                 metricReportSubCount++;
8597d1cc387SAppaRao Puli             }
8607d1cc387SAppaRao Puli         }
8617d1cc387SAppaRao Puli 
8627d1cc387SAppaRao Puli         noOfEventLogSubscribers = eventLogSubCount;
8637d1cc387SAppaRao Puli         if (noOfMetricReportSubscribers != metricReportSubCount)
8647d1cc387SAppaRao Puli         {
8657d1cc387SAppaRao Puli             noOfMetricReportSubscribers = metricReportSubCount;
866e662eae8SEd Tanous             if (noOfMetricReportSubscribers != 0U)
8677d1cc387SAppaRao Puli             {
8687d1cc387SAppaRao Puli                 registerMetricReportSignal();
8697d1cc387SAppaRao Puli             }
8707d1cc387SAppaRao Puli             else
8717d1cc387SAppaRao Puli             {
8727d1cc387SAppaRao Puli                 unregisterMetricReportSignal();
8737d1cc387SAppaRao Puli             }
8747d1cc387SAppaRao Puli         }
8757d1cc387SAppaRao Puli     }
8767d1cc387SAppaRao Puli 
877b52664e2SAppaRao Puli     std::shared_ptr<Subscription> getSubscription(const std::string& id)
878b52664e2SAppaRao Puli     {
879b52664e2SAppaRao Puli         auto obj = subscriptionsMap.find(id);
880b52664e2SAppaRao Puli         if (obj == subscriptionsMap.end())
881b52664e2SAppaRao Puli         {
882b52664e2SAppaRao Puli             BMCWEB_LOG_ERROR << "No subscription exist with ID:" << id;
883b52664e2SAppaRao Puli             return nullptr;
884b52664e2SAppaRao Puli         }
885b52664e2SAppaRao Puli         std::shared_ptr<Subscription> subValue = obj->second;
886b52664e2SAppaRao Puli         return subValue;
887b52664e2SAppaRao Puli     }
888b52664e2SAppaRao Puli 
889b5a76932SEd Tanous     std::string addSubscription(const std::shared_ptr<Subscription>& subValue,
8901bf712bcSAyushi Smriti                                 const bool updateFile = true)
891b52664e2SAppaRao Puli     {
892fc76b8acSEd Tanous         std::uniform_int_distribution<uint32_t> dist(0);
893fc76b8acSEd Tanous         bmcweb::OpenSSLGenerator gen;
894fc76b8acSEd Tanous 
895b52664e2SAppaRao Puli         std::string id;
896b52664e2SAppaRao Puli 
897b52664e2SAppaRao Puli         int retry = 3;
898e662eae8SEd Tanous         while (retry != 0)
899b52664e2SAppaRao Puli         {
900fc76b8acSEd Tanous             id = std::to_string(dist(gen));
901fc76b8acSEd Tanous             if (gen.error())
902fc76b8acSEd Tanous             {
903fc76b8acSEd Tanous                 retry = 0;
904fc76b8acSEd Tanous                 break;
905fc76b8acSEd Tanous             }
906b52664e2SAppaRao Puli             auto inserted = subscriptionsMap.insert(std::pair(id, subValue));
907b52664e2SAppaRao Puli             if (inserted.second)
908b52664e2SAppaRao Puli             {
909b52664e2SAppaRao Puli                 break;
910b52664e2SAppaRao Puli             }
911b52664e2SAppaRao Puli             --retry;
91223a21a1cSEd Tanous         }
913b52664e2SAppaRao Puli 
914b52664e2SAppaRao Puli         if (retry <= 0)
915b52664e2SAppaRao Puli         {
916b52664e2SAppaRao Puli             BMCWEB_LOG_ERROR << "Failed to generate random number";
917abb93cddSEd Tanous             return "";
918b52664e2SAppaRao Puli         }
919b52664e2SAppaRao Puli 
92028afb49cSJunLin Chen         std::shared_ptr<persistent_data::UserSubscription> newSub =
92128afb49cSJunLin Chen             std::make_shared<persistent_data::UserSubscription>();
92228afb49cSJunLin Chen         newSub->id = id;
92328afb49cSJunLin Chen         newSub->destinationUrl = subValue->destinationUrl;
92428afb49cSJunLin Chen         newSub->protocol = subValue->protocol;
92528afb49cSJunLin Chen         newSub->retryPolicy = subValue->retryPolicy;
92628afb49cSJunLin Chen         newSub->customText = subValue->customText;
92728afb49cSJunLin Chen         newSub->eventFormatType = subValue->eventFormatType;
92828afb49cSJunLin Chen         newSub->subscriptionType = subValue->subscriptionType;
92928afb49cSJunLin Chen         newSub->registryMsgIds = subValue->registryMsgIds;
93028afb49cSJunLin Chen         newSub->registryPrefixes = subValue->registryPrefixes;
93128afb49cSJunLin Chen         newSub->resourceTypes = subValue->resourceTypes;
93228afb49cSJunLin Chen         newSub->httpHeaders = subValue->httpHeaders;
93328afb49cSJunLin Chen         newSub->metricReportDefinitions = subValue->metricReportDefinitions;
93428afb49cSJunLin Chen         persistent_data::EventServiceStore::getInstance()
93528afb49cSJunLin Chen             .subscriptionsConfigMap.emplace(newSub->id, newSub);
93628afb49cSJunLin Chen 
9377d1cc387SAppaRao Puli         updateNoOfSubscribersCount();
9381bf712bcSAyushi Smriti 
9391bf712bcSAyushi Smriti         if (updateFile)
9401bf712bcSAyushi Smriti         {
941b52664e2SAppaRao Puli             updateSubscriptionData();
9421bf712bcSAyushi Smriti         }
9437f4eb588SAppaRao Puli 
9447f4eb588SAppaRao Puli #ifndef BMCWEB_ENABLE_REDFISH_DBUS_LOG_ENTRIES
9452558979cSP Dheeraj Srujan Kumar         if (redfishLogFilePosition != 0)
9467f4eb588SAppaRao Puli         {
9472558979cSP Dheeraj Srujan Kumar             cacheRedfishLogFile();
9487f4eb588SAppaRao Puli         }
9497f4eb588SAppaRao Puli #endif
950fe44eb0bSAyushi Smriti         // Update retry configuration.
951fe44eb0bSAyushi Smriti         subValue->updateRetryConfig(retryAttempts, retryTimeoutInterval);
952fe44eb0bSAyushi Smriti 
9535e44e3d8SAppaRao Puli         // Set Subscription ID for back trace
9545e44e3d8SAppaRao Puli         subValue->setSubscriptionId(id);
955b52664e2SAppaRao Puli         return id;
956b52664e2SAppaRao Puli     }
957b52664e2SAppaRao Puli 
958b52664e2SAppaRao Puli     bool isSubscriptionExist(const std::string& id)
959b52664e2SAppaRao Puli     {
960b52664e2SAppaRao Puli         auto obj = subscriptionsMap.find(id);
96155f79e6fSEd Tanous         return obj != subscriptionsMap.end();
962b52664e2SAppaRao Puli     }
963b52664e2SAppaRao Puli 
964b52664e2SAppaRao Puli     void deleteSubscription(const std::string& id)
965b52664e2SAppaRao Puli     {
966b52664e2SAppaRao Puli         auto obj = subscriptionsMap.find(id);
967b52664e2SAppaRao Puli         if (obj != subscriptionsMap.end())
968b52664e2SAppaRao Puli         {
969b52664e2SAppaRao Puli             subscriptionsMap.erase(obj);
97028afb49cSJunLin Chen             auto obj2 = persistent_data::EventServiceStore::getInstance()
97128afb49cSJunLin Chen                             .subscriptionsConfigMap.find(id);
97228afb49cSJunLin Chen             persistent_data::EventServiceStore::getInstance()
97328afb49cSJunLin Chen                 .subscriptionsConfigMap.erase(obj2);
9747d1cc387SAppaRao Puli             updateNoOfSubscribersCount();
975b52664e2SAppaRao Puli             updateSubscriptionData();
976b52664e2SAppaRao Puli         }
977b52664e2SAppaRao Puli     }
978b52664e2SAppaRao Puli 
9795e44e3d8SAppaRao Puli     void deleteSseSubscription(const crow::sse_socket::Connection& thisConn)
9805e44e3d8SAppaRao Puli     {
9815e44e3d8SAppaRao Puli         for (const auto& it : subscriptionsMap)
9825e44e3d8SAppaRao Puli         {
9835e44e3d8SAppaRao Puli             std::shared_ptr<Subscription> entry = it.second;
9845e44e3d8SAppaRao Puli             bool entryIsThisConn = entry->matchSseId(thisConn);
9855e44e3d8SAppaRao Puli             if (entryIsThisConn)
9865e44e3d8SAppaRao Puli             {
9875e44e3d8SAppaRao Puli                 persistent_data::EventServiceStore::getInstance()
9885e44e3d8SAppaRao Puli                     .subscriptionsConfigMap.erase(
9895e44e3d8SAppaRao Puli                         it.second->getSubscriptionId());
9905e44e3d8SAppaRao Puli                 return;
9915e44e3d8SAppaRao Puli             }
9925e44e3d8SAppaRao Puli         }
9935e44e3d8SAppaRao Puli     }
9945e44e3d8SAppaRao Puli 
9955e44e3d8SAppaRao Puli     size_t getNumberOfSubscriptions() const
996b52664e2SAppaRao Puli     {
997b52664e2SAppaRao Puli         return subscriptionsMap.size();
998b52664e2SAppaRao Puli     }
999b52664e2SAppaRao Puli 
10005e44e3d8SAppaRao Puli     size_t getNumberOfSSESubscriptions() const
10015e44e3d8SAppaRao Puli     {
10025e44e3d8SAppaRao Puli         auto size = std::count_if(
10035e44e3d8SAppaRao Puli             subscriptionsMap.begin(), subscriptionsMap.end(),
10045e44e3d8SAppaRao Puli             [](const std::pair<std::string, std::shared_ptr<Subscription>>&
10055e44e3d8SAppaRao Puli                    entry) {
10065e44e3d8SAppaRao Puli             return (entry.second->subscriptionType == subscriptionTypeSSE);
10075e44e3d8SAppaRao Puli             });
10085e44e3d8SAppaRao Puli         return static_cast<size_t>(size);
10095e44e3d8SAppaRao Puli     }
10105e44e3d8SAppaRao Puli 
1011b52664e2SAppaRao Puli     std::vector<std::string> getAllIDs()
1012b52664e2SAppaRao Puli     {
1013b52664e2SAppaRao Puli         std::vector<std::string> idList;
1014b52664e2SAppaRao Puli         for (const auto& it : subscriptionsMap)
1015b52664e2SAppaRao Puli         {
1016b52664e2SAppaRao Puli             idList.emplace_back(it.first);
1017b52664e2SAppaRao Puli         }
1018b52664e2SAppaRao Puli         return idList;
1019b52664e2SAppaRao Puli     }
1020b52664e2SAppaRao Puli 
10215e44e3d8SAppaRao Puli     bool isDestinationExist(const std::string& destUrl) const
1022b52664e2SAppaRao Puli     {
1023b52664e2SAppaRao Puli         for (const auto& it : subscriptionsMap)
1024b52664e2SAppaRao Puli         {
1025b52664e2SAppaRao Puli             std::shared_ptr<Subscription> entry = it.second;
1026b52664e2SAppaRao Puli             if (entry->destinationUrl == destUrl)
1027b52664e2SAppaRao Puli             {
1028b52664e2SAppaRao Puli                 BMCWEB_LOG_ERROR << "Destination exist already" << destUrl;
1029b52664e2SAppaRao Puli                 return true;
1030b52664e2SAppaRao Puli             }
1031b52664e2SAppaRao Puli         }
1032b52664e2SAppaRao Puli         return false;
1033b52664e2SAppaRao Puli     }
10340b4bdd93SAppaRao Puli 
10356ba8c82eSsunharis_in     bool sendTestEventLog()
10360b4bdd93SAppaRao Puli     {
10375e44e3d8SAppaRao Puli         for (const auto& it : subscriptionsMap)
10380b4bdd93SAppaRao Puli         {
10390b4bdd93SAppaRao Puli             std::shared_ptr<Subscription> entry = it.second;
10406ba8c82eSsunharis_in             if (!entry->sendTestEventLog())
10416ba8c82eSsunharis_in             {
10426ba8c82eSsunharis_in                 return false;
10430b4bdd93SAppaRao Puli             }
10440b4bdd93SAppaRao Puli         }
10456ba8c82eSsunharis_in         return true;
10466ba8c82eSsunharis_in     }
1047e9a14131SAppaRao Puli 
1048613dabeaSEd Tanous     void sendEvent(nlohmann::json eventMessage, const std::string& origin,
1049613dabeaSEd Tanous                    const std::string& resType)
105096330b99SSunitha Harish     {
1051dbb59d4dSEd Tanous         if (!serviceEnabled || (noOfEventLogSubscribers == 0U))
10526ba8c82eSsunharis_in         {
10536ba8c82eSsunharis_in             BMCWEB_LOG_DEBUG << "EventService disabled or no Subscriptions.";
10546ba8c82eSsunharis_in             return;
10556ba8c82eSsunharis_in         }
105696330b99SSunitha Harish         nlohmann::json eventRecord = nlohmann::json::array();
105796330b99SSunitha Harish 
1058613dabeaSEd Tanous         eventMessage["EventId"] = eventId;
1059613dabeaSEd Tanous         // MemberId is 0 : since we are sending one event record.
1060613dabeaSEd Tanous         eventMessage["MemberId"] = 0;
1061613dabeaSEd Tanous         eventMessage["EventTimestamp"] =
1062613dabeaSEd Tanous             redfish::time_utils::getDateTimeOffsetNow().first;
1063613dabeaSEd Tanous         eventMessage["OriginOfCondition"] = origin;
1064613dabeaSEd Tanous 
1065613dabeaSEd Tanous         eventRecord.emplace_back(std::move(eventMessage));
106696330b99SSunitha Harish 
10675e44e3d8SAppaRao Puli         for (const auto& it : subscriptionsMap)
106896330b99SSunitha Harish         {
106996330b99SSunitha Harish             std::shared_ptr<Subscription> entry = it.second;
107096330b99SSunitha Harish             bool isSubscribed = false;
107196330b99SSunitha Harish             // Search the resourceTypes list for the subscription.
107296330b99SSunitha Harish             // If resourceTypes list is empty, don't filter events
107396330b99SSunitha Harish             // send everything.
107426f6976fSEd Tanous             if (!entry->resourceTypes.empty())
107596330b99SSunitha Harish             {
10763174e4dfSEd Tanous                 for (const auto& resource : entry->resourceTypes)
107796330b99SSunitha Harish                 {
107896330b99SSunitha Harish                     if (resType == resource)
107996330b99SSunitha Harish                     {
108096330b99SSunitha Harish                         BMCWEB_LOG_INFO << "ResourceType " << resource
108196330b99SSunitha Harish                                         << " found in the subscribed list";
108296330b99SSunitha Harish                         isSubscribed = true;
108396330b99SSunitha Harish                         break;
108496330b99SSunitha Harish                     }
108596330b99SSunitha Harish                 }
108696330b99SSunitha Harish             }
108796330b99SSunitha Harish             else // resourceTypes list is empty.
108896330b99SSunitha Harish             {
108996330b99SSunitha Harish                 isSubscribed = true;
109096330b99SSunitha Harish             }
109196330b99SSunitha Harish             if (isSubscribed)
109296330b99SSunitha Harish             {
1093613dabeaSEd Tanous                 nlohmann::json msgJson;
1094613dabeaSEd Tanous 
1095613dabeaSEd Tanous                 msgJson["@odata.type"] = "#Event.v1_4_0.Event";
1096613dabeaSEd Tanous                 msgJson["Name"] = "Event Log";
1097613dabeaSEd Tanous                 msgJson["Id"] = eventId;
1098613dabeaSEd Tanous                 msgJson["Events"] = eventRecord;
1099f52c03c1SCarson Labrado 
1100f52c03c1SCarson Labrado                 std::string strMsg = msgJson.dump(
1101f52c03c1SCarson Labrado                     2, ' ', true, nlohmann::json::error_handler_t::replace);
11025e44e3d8SAppaRao Puli                 entry->sendEvent(std::move(strMsg));
110396330b99SSunitha Harish                 eventId++; // increament the eventId
110496330b99SSunitha Harish             }
110596330b99SSunitha Harish             else
110696330b99SSunitha Harish             {
110796330b99SSunitha Harish                 BMCWEB_LOG_INFO << "Not subscribed to this resource";
110896330b99SSunitha Harish             }
110996330b99SSunitha Harish         }
111096330b99SSunitha Harish     }
11115738de59SAsmitha Karunanithi     void sendBroadcastMsg(const std::string& broadcastMsg)
11125738de59SAsmitha Karunanithi     {
11135e44e3d8SAppaRao Puli         for (const auto& it : subscriptionsMap)
11145738de59SAsmitha Karunanithi         {
11155738de59SAsmitha Karunanithi             std::shared_ptr<Subscription> entry = it.second;
1116613dabeaSEd Tanous             nlohmann::json msgJson;
1117613dabeaSEd Tanous             msgJson["Timestamp"] =
1118613dabeaSEd Tanous                 redfish::time_utils::getDateTimeOffsetNow().first;
1119613dabeaSEd Tanous             msgJson["OriginOfCondition"] = "/ibm/v1/HMC/BroadcastService";
1120613dabeaSEd Tanous             msgJson["Name"] = "Broadcast Message";
1121613dabeaSEd Tanous             msgJson["Message"] = broadcastMsg;
1122f52c03c1SCarson Labrado 
1123f52c03c1SCarson Labrado             std::string strMsg = msgJson.dump(
1124f52c03c1SCarson Labrado                 2, ' ', true, nlohmann::json::error_handler_t::replace);
11255e44e3d8SAppaRao Puli             entry->sendEvent(std::move(strMsg));
11265738de59SAsmitha Karunanithi         }
11275738de59SAsmitha Karunanithi     }
112896330b99SSunitha Harish 
11297f4eb588SAppaRao Puli #ifndef BMCWEB_ENABLE_REDFISH_DBUS_LOG_ENTRIES
11302558979cSP Dheeraj Srujan Kumar 
11312558979cSP Dheeraj Srujan Kumar     void resetRedfishFilePosition()
11327f4eb588SAppaRao Puli     {
11332558979cSP Dheeraj Srujan Kumar         // Control would be here when Redfish file is created.
11342558979cSP Dheeraj Srujan Kumar         // Reset File Position as new file is created
11352558979cSP Dheeraj Srujan Kumar         redfishLogFilePosition = 0;
11362558979cSP Dheeraj Srujan Kumar     }
11372558979cSP Dheeraj Srujan Kumar 
11382558979cSP Dheeraj Srujan Kumar     void cacheRedfishLogFile()
11392558979cSP Dheeraj Srujan Kumar     {
11402558979cSP Dheeraj Srujan Kumar         // Open the redfish file and read till the last record.
11412558979cSP Dheeraj Srujan Kumar 
11427f4eb588SAppaRao Puli         std::ifstream logStream(redfishEventLogFile);
11437f4eb588SAppaRao Puli         if (!logStream.good())
11447f4eb588SAppaRao Puli         {
11457f4eb588SAppaRao Puli             BMCWEB_LOG_ERROR << " Redfish log file open failed \n";
11467f4eb588SAppaRao Puli             return;
11477f4eb588SAppaRao Puli         }
11487f4eb588SAppaRao Puli         std::string logEntry;
11497f4eb588SAppaRao Puli         while (std::getline(logStream, logEntry))
11507f4eb588SAppaRao Puli         {
11512558979cSP Dheeraj Srujan Kumar             redfishLogFilePosition = logStream.tellg();
11527f4eb588SAppaRao Puli         }
11532558979cSP Dheeraj Srujan Kumar 
11542558979cSP Dheeraj Srujan Kumar         BMCWEB_LOG_DEBUG << "Next Log Position : " << redfishLogFilePosition;
11557f4eb588SAppaRao Puli     }
11567f4eb588SAppaRao Puli 
11577f4eb588SAppaRao Puli     void readEventLogsFromFile()
11587f4eb588SAppaRao Puli     {
11597f4eb588SAppaRao Puli         std::ifstream logStream(redfishEventLogFile);
11607f4eb588SAppaRao Puli         if (!logStream.good())
11617f4eb588SAppaRao Puli         {
11627f4eb588SAppaRao Puli             BMCWEB_LOG_ERROR << " Redfish log file open failed";
11637f4eb588SAppaRao Puli             return;
11647f4eb588SAppaRao Puli         }
11657f4eb588SAppaRao Puli 
11667f4eb588SAppaRao Puli         std::vector<EventLogObjectsType> eventRecords;
11677f4eb588SAppaRao Puli 
11687f4eb588SAppaRao Puli         std::string logEntry;
11692558979cSP Dheeraj Srujan Kumar 
11702558979cSP Dheeraj Srujan Kumar         // Get the read pointer to the next log to be read.
11712558979cSP Dheeraj Srujan Kumar         logStream.seekg(redfishLogFilePosition);
11722558979cSP Dheeraj Srujan Kumar 
11737f4eb588SAppaRao Puli         while (std::getline(logStream, logEntry))
11747f4eb588SAppaRao Puli         {
11752558979cSP Dheeraj Srujan Kumar             // Update Pointer position
11762558979cSP Dheeraj Srujan Kumar             redfishLogFilePosition = logStream.tellg();
11772558979cSP Dheeraj Srujan Kumar 
11782558979cSP Dheeraj Srujan Kumar             std::string idStr;
11792558979cSP Dheeraj Srujan Kumar             if (!event_log::getUniqueEntryID(logEntry, idStr))
11807f4eb588SAppaRao Puli             {
11817f4eb588SAppaRao Puli                 continue;
11827f4eb588SAppaRao Puli             }
11837f4eb588SAppaRao Puli 
1184e662eae8SEd Tanous             if (!serviceEnabled || noOfEventLogSubscribers == 0)
11857f4eb588SAppaRao Puli             {
11862558979cSP Dheeraj Srujan Kumar                 // If Service is not enabled, no need to compute
11872558979cSP Dheeraj Srujan Kumar                 // the remaining items below.
11882558979cSP Dheeraj Srujan Kumar                 // But, Loop must continue to keep track of Timestamp
11897f4eb588SAppaRao Puli                 continue;
11907f4eb588SAppaRao Puli             }
11917f4eb588SAppaRao Puli 
11927f4eb588SAppaRao Puli             std::string timestamp;
11937f4eb588SAppaRao Puli             std::string messageID;
11945e715de6SAppaRao Puli             std::vector<std::string> messageArgs;
11957f4eb588SAppaRao Puli             if (event_log::getEventLogParams(logEntry, timestamp, messageID,
11967f4eb588SAppaRao Puli                                              messageArgs) != 0)
11977f4eb588SAppaRao Puli             {
11987f4eb588SAppaRao Puli                 BMCWEB_LOG_DEBUG << "Read eventLog entry params failed";
11997f4eb588SAppaRao Puli                 continue;
12007f4eb588SAppaRao Puli             }
12017f4eb588SAppaRao Puli 
12027f4eb588SAppaRao Puli             std::string registryName;
12037f4eb588SAppaRao Puli             std::string messageKey;
12047f4eb588SAppaRao Puli             event_log::getRegistryAndMessageKey(messageID, registryName,
12057f4eb588SAppaRao Puli                                                 messageKey);
12067f4eb588SAppaRao Puli             if (registryName.empty() || messageKey.empty())
12077f4eb588SAppaRao Puli             {
12087f4eb588SAppaRao Puli                 continue;
12097f4eb588SAppaRao Puli             }
12107f4eb588SAppaRao Puli 
12117f4eb588SAppaRao Puli             eventRecords.emplace_back(idStr, timestamp, messageID, registryName,
12127f4eb588SAppaRao Puli                                       messageKey, messageArgs);
12137f4eb588SAppaRao Puli         }
12147f4eb588SAppaRao Puli 
1215e662eae8SEd Tanous         if (!serviceEnabled || noOfEventLogSubscribers == 0)
12162558979cSP Dheeraj Srujan Kumar         {
12172558979cSP Dheeraj Srujan Kumar             BMCWEB_LOG_DEBUG << "EventService disabled or no Subscriptions.";
12182558979cSP Dheeraj Srujan Kumar             return;
12192558979cSP Dheeraj Srujan Kumar         }
12202558979cSP Dheeraj Srujan Kumar 
12212558979cSP Dheeraj Srujan Kumar         if (eventRecords.empty())
12222558979cSP Dheeraj Srujan Kumar         {
12232558979cSP Dheeraj Srujan Kumar             // No Records to send
12242558979cSP Dheeraj Srujan Kumar             BMCWEB_LOG_DEBUG << "No log entries available to be transferred.";
12252558979cSP Dheeraj Srujan Kumar             return;
12262558979cSP Dheeraj Srujan Kumar         }
12272558979cSP Dheeraj Srujan Kumar 
12285e44e3d8SAppaRao Puli         for (const auto& it : subscriptionsMap)
12297f4eb588SAppaRao Puli         {
12307f4eb588SAppaRao Puli             std::shared_ptr<Subscription> entry = it.second;
12317f4eb588SAppaRao Puli             if (entry->eventFormatType == "Event")
12327f4eb588SAppaRao Puli             {
12337f4eb588SAppaRao Puli                 entry->filterAndSendEventLogs(eventRecords);
12347f4eb588SAppaRao Puli             }
12357f4eb588SAppaRao Puli         }
12367f4eb588SAppaRao Puli     }
12377f4eb588SAppaRao Puli 
12387f4eb588SAppaRao Puli     static void watchRedfishEventLogFile()
12397f4eb588SAppaRao Puli     {
12406a9f85f9SAppaRao Puli         if (!inotifyConn)
12417f4eb588SAppaRao Puli         {
12427f4eb588SAppaRao Puli             return;
12437f4eb588SAppaRao Puli         }
12447f4eb588SAppaRao Puli 
12457f4eb588SAppaRao Puli         static std::array<char, 1024> readBuffer;
12467f4eb588SAppaRao Puli 
1247002d39b4SEd Tanous         inotifyConn->async_read_some(boost::asio::buffer(readBuffer),
12487f4eb588SAppaRao Puli                                      [&](const boost::system::error_code& ec,
12497f4eb588SAppaRao Puli                                          const std::size_t& bytesTransferred) {
12507f4eb588SAppaRao Puli             if (ec)
12517f4eb588SAppaRao Puli             {
12527f4eb588SAppaRao Puli                 BMCWEB_LOG_ERROR << "Callback Error: " << ec.message();
12537f4eb588SAppaRao Puli                 return;
12547f4eb588SAppaRao Puli             }
12557f4eb588SAppaRao Puli             std::size_t index = 0;
1256b792cc56SAppaRao Puli             while ((index + iEventSize) <= bytesTransferred)
12577f4eb588SAppaRao Puli             {
1258d3a9e084SEd Tanous                 struct inotify_event event
1259d3a9e084SEd Tanous                 {};
1260b792cc56SAppaRao Puli                 std::memcpy(&event, &readBuffer[index], iEventSize);
1261b792cc56SAppaRao Puli                 if (event.wd == dirWatchDesc)
1262b792cc56SAppaRao Puli                 {
1263b792cc56SAppaRao Puli                     if ((event.len == 0) ||
1264b792cc56SAppaRao Puli                         (index + iEventSize + event.len > bytesTransferred))
1265b792cc56SAppaRao Puli                     {
1266b792cc56SAppaRao Puli                         index += (iEventSize + event.len);
1267b792cc56SAppaRao Puli                         continue;
1268b792cc56SAppaRao Puli                     }
1269b792cc56SAppaRao Puli 
12704f568f74SJiaqing Zhao                     std::string fileName(&readBuffer[index + iEventSize]);
12714f568f74SJiaqing Zhao                     if (fileName != "redfish")
1272b792cc56SAppaRao Puli                     {
1273b792cc56SAppaRao Puli                         index += (iEventSize + event.len);
1274b792cc56SAppaRao Puli                         continue;
1275b792cc56SAppaRao Puli                     }
1276b792cc56SAppaRao Puli 
1277b792cc56SAppaRao Puli                     BMCWEB_LOG_DEBUG
1278b792cc56SAppaRao Puli                         << "Redfish log file created/deleted. event.name: "
1279b792cc56SAppaRao Puli                         << fileName;
1280b792cc56SAppaRao Puli                     if (event.mask == IN_CREATE)
1281b792cc56SAppaRao Puli                     {
1282b792cc56SAppaRao Puli                         if (fileWatchDesc != -1)
1283b792cc56SAppaRao Puli                         {
1284b792cc56SAppaRao Puli                             BMCWEB_LOG_DEBUG
1285016761afSAppaRao Puli                                 << "Remove and Add inotify watcher on "
1286016761afSAppaRao Puli                                    "redfish event log file";
1287016761afSAppaRao Puli                             // Remove existing inotify watcher and add
1288016761afSAppaRao Puli                             // with new redfish event log file.
1289016761afSAppaRao Puli                             inotify_rm_watch(inotifyFd, fileWatchDesc);
1290016761afSAppaRao Puli                             fileWatchDesc = -1;
1291b792cc56SAppaRao Puli                         }
1292b792cc56SAppaRao Puli 
1293b792cc56SAppaRao Puli                         fileWatchDesc = inotify_add_watch(
1294b792cc56SAppaRao Puli                             inotifyFd, redfishEventLogFile, IN_MODIFY);
1295b792cc56SAppaRao Puli                         if (fileWatchDesc == -1)
1296b792cc56SAppaRao Puli                         {
1297002d39b4SEd Tanous                             BMCWEB_LOG_ERROR << "inotify_add_watch failed for "
1298b792cc56SAppaRao Puli                                                 "redfish log file.";
1299b792cc56SAppaRao Puli                             return;
1300b792cc56SAppaRao Puli                         }
1301b792cc56SAppaRao Puli 
1302b792cc56SAppaRao Puli                         EventServiceManager::getInstance()
13032558979cSP Dheeraj Srujan Kumar                             .resetRedfishFilePosition();
1304b792cc56SAppaRao Puli                         EventServiceManager::getInstance()
1305b792cc56SAppaRao Puli                             .readEventLogsFromFile();
1306b792cc56SAppaRao Puli                     }
1307b792cc56SAppaRao Puli                     else if ((event.mask == IN_DELETE) ||
1308b792cc56SAppaRao Puli                              (event.mask == IN_MOVED_TO))
1309b792cc56SAppaRao Puli                     {
1310b792cc56SAppaRao Puli                         if (fileWatchDesc != -1)
1311b792cc56SAppaRao Puli                         {
1312b792cc56SAppaRao Puli                             inotify_rm_watch(inotifyFd, fileWatchDesc);
1313b792cc56SAppaRao Puli                             fileWatchDesc = -1;
1314b792cc56SAppaRao Puli                         }
1315b792cc56SAppaRao Puli                     }
1316b792cc56SAppaRao Puli                 }
1317b792cc56SAppaRao Puli                 else if (event.wd == fileWatchDesc)
1318b792cc56SAppaRao Puli                 {
1319b792cc56SAppaRao Puli                     if (event.mask == IN_MODIFY)
13207f4eb588SAppaRao Puli                     {
13217f4eb588SAppaRao Puli                         EventServiceManager::getInstance()
13227f4eb588SAppaRao Puli                             .readEventLogsFromFile();
13237f4eb588SAppaRao Puli                     }
1324b792cc56SAppaRao Puli                 }
1325b792cc56SAppaRao Puli                 index += (iEventSize + event.len);
13267f4eb588SAppaRao Puli             }
13277f4eb588SAppaRao Puli 
13287f4eb588SAppaRao Puli             watchRedfishEventLogFile();
13297f4eb588SAppaRao Puli         });
13307f4eb588SAppaRao Puli     }
13317f4eb588SAppaRao Puli 
13327f4eb588SAppaRao Puli     static int startEventLogMonitor(boost::asio::io_context& ioc)
13337f4eb588SAppaRao Puli     {
133423a21a1cSEd Tanous         inotifyConn.emplace(ioc);
1335b792cc56SAppaRao Puli         inotifyFd = inotify_init1(IN_NONBLOCK);
1336b792cc56SAppaRao Puli         if (inotifyFd == -1)
13377f4eb588SAppaRao Puli         {
13387f4eb588SAppaRao Puli             BMCWEB_LOG_ERROR << "inotify_init1 failed.";
13397f4eb588SAppaRao Puli             return -1;
13407f4eb588SAppaRao Puli         }
1341b792cc56SAppaRao Puli 
1342b792cc56SAppaRao Puli         // Add watch on directory to handle redfish event log file
1343b792cc56SAppaRao Puli         // create/delete.
1344b792cc56SAppaRao Puli         dirWatchDesc = inotify_add_watch(inotifyFd, redfishEventLogDir,
1345b792cc56SAppaRao Puli                                          IN_CREATE | IN_MOVED_TO | IN_DELETE);
1346b792cc56SAppaRao Puli         if (dirWatchDesc == -1)
13477f4eb588SAppaRao Puli         {
13487f4eb588SAppaRao Puli             BMCWEB_LOG_ERROR
1349b792cc56SAppaRao Puli                 << "inotify_add_watch failed for event log directory.";
13507f4eb588SAppaRao Puli             return -1;
13517f4eb588SAppaRao Puli         }
13527f4eb588SAppaRao Puli 
1353b792cc56SAppaRao Puli         // Watch redfish event log file for modifications.
135489492a15SPatrick Williams         fileWatchDesc = inotify_add_watch(inotifyFd, redfishEventLogFile,
135589492a15SPatrick Williams                                           IN_MODIFY);
1356b792cc56SAppaRao Puli         if (fileWatchDesc == -1)
1357b792cc56SAppaRao Puli         {
1358b792cc56SAppaRao Puli             BMCWEB_LOG_ERROR
1359b792cc56SAppaRao Puli                 << "inotify_add_watch failed for redfish log file.";
1360b792cc56SAppaRao Puli             // Don't return error if file not exist.
1361b792cc56SAppaRao Puli             // Watch on directory will handle create/delete of file.
1362b792cc56SAppaRao Puli         }
1363b792cc56SAppaRao Puli 
13647f4eb588SAppaRao Puli         // monitor redfish event log file
1365b792cc56SAppaRao Puli         inotifyConn->assign(inotifyFd);
13667f4eb588SAppaRao Puli         watchRedfishEventLogFile();
13677f4eb588SAppaRao Puli 
13687f4eb588SAppaRao Puli         return 0;
13697f4eb588SAppaRao Puli     }
13707f4eb588SAppaRao Puli 
13717f4eb588SAppaRao Puli #endif
137259d494eeSPatrick Williams     static void getReadingsForReport(sdbusplus::message_t& msg)
1373156d6b00SAppaRao Puli     {
137456d2396dSEd Tanous         if (msg.is_method_error())
137556d2396dSEd Tanous         {
137656d2396dSEd Tanous             BMCWEB_LOG_ERROR << "TelemetryMonitor Signal error";
137756d2396dSEd Tanous             return;
137856d2396dSEd Tanous         }
137956d2396dSEd Tanous 
1380c0353249SWludzik, Jozef         sdbusplus::message::object_path path(msg.get_path());
1381c0353249SWludzik, Jozef         std::string id = path.filename();
1382c0353249SWludzik, Jozef         if (id.empty())
1383156d6b00SAppaRao Puli         {
1384c0353249SWludzik, Jozef             BMCWEB_LOG_ERROR << "Failed to get Id from path";
1385156d6b00SAppaRao Puli             return;
1386156d6b00SAppaRao Puli         }
1387156d6b00SAppaRao Puli 
1388c0353249SWludzik, Jozef         std::string interface;
1389b9d36b47SEd Tanous         dbus::utility::DBusPropertiesMap props;
1390c0353249SWludzik, Jozef         std::vector<std::string> invalidProps;
1391c0353249SWludzik, Jozef         msg.read(interface, props, invalidProps);
1392c0353249SWludzik, Jozef 
1393c0353249SWludzik, Jozef         auto found =
1394c0353249SWludzik, Jozef             std::find_if(props.begin(), props.end(),
1395c0353249SWludzik, Jozef                          [](const auto& x) { return x.first == "Readings"; });
1396c0353249SWludzik, Jozef         if (found == props.end())
1397156d6b00SAppaRao Puli         {
1398c0353249SWludzik, Jozef             BMCWEB_LOG_INFO << "Failed to get Readings from Report properties";
1399156d6b00SAppaRao Puli             return;
1400156d6b00SAppaRao Puli         }
1401156d6b00SAppaRao Puli 
14021e1e598dSJonathan Doman         const telemetry::TimestampReadings* readings =
14031e1e598dSJonathan Doman             std::get_if<telemetry::TimestampReadings>(&found->second);
1404e662eae8SEd Tanous         if (readings == nullptr)
14051e1e598dSJonathan Doman         {
14061e1e598dSJonathan Doman             BMCWEB_LOG_INFO << "Failed to get Readings from Report properties";
14071e1e598dSJonathan Doman             return;
14081e1e598dSJonathan Doman         }
14091e1e598dSJonathan Doman 
1410156d6b00SAppaRao Puli         for (const auto& it :
1411156d6b00SAppaRao Puli              EventServiceManager::getInstance().subscriptionsMap)
1412156d6b00SAppaRao Puli         {
1413e05aec50SEd Tanous             Subscription& entry = *it.second;
1414c0353249SWludzik, Jozef             if (entry.eventFormatType == metricReportFormatType)
1415156d6b00SAppaRao Puli             {
14161e1e598dSJonathan Doman                 entry.filterAndSendReports(id, *readings);
1417156d6b00SAppaRao Puli             }
1418156d6b00SAppaRao Puli         }
1419156d6b00SAppaRao Puli     }
1420156d6b00SAppaRao Puli 
1421156d6b00SAppaRao Puli     void unregisterMetricReportSignal()
1422156d6b00SAppaRao Puli     {
14237d1cc387SAppaRao Puli         if (matchTelemetryMonitor)
14247d1cc387SAppaRao Puli         {
1425156d6b00SAppaRao Puli             BMCWEB_LOG_DEBUG << "Metrics report signal - Unregister";
1426156d6b00SAppaRao Puli             matchTelemetryMonitor.reset();
1427156d6b00SAppaRao Puli             matchTelemetryMonitor = nullptr;
1428156d6b00SAppaRao Puli         }
14297d1cc387SAppaRao Puli     }
1430156d6b00SAppaRao Puli 
1431156d6b00SAppaRao Puli     void registerMetricReportSignal()
1432156d6b00SAppaRao Puli     {
14337d1cc387SAppaRao Puli         if (!serviceEnabled || matchTelemetryMonitor)
1434156d6b00SAppaRao Puli         {
14357d1cc387SAppaRao Puli             BMCWEB_LOG_DEBUG << "Not registering metric report signal.";
1436156d6b00SAppaRao Puli             return;
1437156d6b00SAppaRao Puli         }
1438156d6b00SAppaRao Puli 
1439156d6b00SAppaRao Puli         BMCWEB_LOG_DEBUG << "Metrics report signal - Register";
1440c0353249SWludzik, Jozef         std::string matchStr = "type='signal',member='PropertiesChanged',"
1441c0353249SWludzik, Jozef                                "interface='org.freedesktop.DBus.Properties',"
1442c0353249SWludzik, Jozef                                "arg0=xyz.openbmc_project.Telemetry.Report";
1443156d6b00SAppaRao Puli 
144459d494eeSPatrick Williams         matchTelemetryMonitor = std::make_shared<sdbusplus::bus::match_t>(
144556d2396dSEd Tanous             *crow::connections::systemBus, matchStr, getReadingsForReport);
1446156d6b00SAppaRao Puli     }
144723a21a1cSEd Tanous };
1448b52664e2SAppaRao Puli 
1449b52664e2SAppaRao Puli } // namespace redfish
1450