1 /* 2 Copyright (c) 2019 Intel Corporation 3 4 Licensed under the Apache License, Version 2.0 (the "License"); 5 you may not use this file except in compliance with the License. 6 You may obtain a copy of the License at 7 8 http://www.apache.org/licenses/LICENSE-2.0 9 10 Unless required by applicable law or agreed to in writing, software 11 distributed under the License is distributed on an "AS IS" BASIS, 12 WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 13 See the License for the specific language governing permissions and 14 limitations under the License. 15 */ 16 #pragma once 17 18 #include "bmcweb_config.h" 19 20 #include <nlohmann/json.hpp> 21 22 #include <array> 23 #include <charconv> 24 #include <cstddef> 25 #include <format> 26 #include <numeric> 27 #include <span> 28 #include <string> 29 #include <string_view> 30 #include <utility> 31 32 namespace redfish::registries 33 { 34 struct Header 35 { 36 const char* copyright; 37 const char* type; 38 unsigned int versionMajor; 39 unsigned int versionMinor; 40 unsigned int versionPatch; 41 const char* name; 42 const char* language; 43 const char* description; 44 const char* registryPrefix; 45 const char* owningEntity; 46 }; 47 48 struct Message 49 { 50 const char* description; 51 const char* message; 52 const char* messageSeverity; 53 const size_t numberOfArgs; 54 std::array<const char*, 5> paramTypes; 55 const char* resolution; 56 }; 57 using MessageEntry = std::pair<const char*, const Message>; 58 59 inline std::string fillMessageArgs( 60 const std::span<const std::string_view> messageArgs, std::string_view msg) 61 { 62 std::string ret; 63 size_t reserve = msg.size(); 64 for (std::string_view arg : messageArgs) 65 { 66 reserve += arg.size(); 67 } 68 ret.reserve(reserve); 69 70 for (size_t stringIndex = msg.find('%'); stringIndex != std::string::npos; 71 stringIndex = msg.find('%')) 72 { 73 ret += msg.substr(0, stringIndex); 74 msg.remove_prefix(stringIndex + 1); 75 size_t number = 0; 76 auto it = std::from_chars(&*msg.begin(), &*msg.end(), number); 77 if (it.ec != std::errc()) 78 { 79 return ""; 80 } 81 msg.remove_prefix(1); 82 // Redfish message args are 1 indexed. 83 number--; 84 if (number >= messageArgs.size()) 85 { 86 return ""; 87 } 88 ret += messageArgs[number]; 89 } 90 ret += msg; 91 return ret; 92 } 93 94 inline nlohmann::json::object_t getLogFromRegistry( 95 const Header& header, std::span<const MessageEntry> registry, size_t index, 96 std::span<const std::string_view> args) 97 { 98 const redfish::registries::MessageEntry& entry = registry[index]; 99 // Intentionally make a copy of the string, so we can append in the 100 // parameters. 101 std::string msg = 102 redfish::registries::fillMessageArgs(args, entry.second.message); 103 nlohmann::json jArgs = nlohmann::json::array(); 104 for (std::string_view arg : args) 105 { 106 jArgs.push_back(arg); 107 } 108 std::string msgId; 109 if (BMCWEB_REDFISH_USE_3_DIGIT_MESSAGEID) 110 { 111 msgId = std::format("{}.{}.{}.{}.{}", header.registryPrefix, 112 header.versionMajor, header.versionMinor, 113 header.versionPatch, entry.first); 114 } 115 else 116 { 117 msgId = 118 std::format("{}.{}.{}.{}", header.registryPrefix, 119 header.versionMajor, header.versionMinor, entry.first); 120 } 121 nlohmann::json::object_t response; 122 response["@odata.type"] = "#Message.v1_1_1.Message"; 123 response["MessageId"] = std::move(msgId); 124 response["Message"] = std::move(msg); 125 response["MessageArgs"] = std::move(jArgs); 126 response["MessageSeverity"] = entry.second.messageSeverity; 127 response["Resolution"] = entry.second.resolution; 128 return response; 129 } 130 131 const Message* getMessage(std::string_view messageID); 132 133 const Message* getMessageFromRegistry(const std::string& messageKey, 134 std::span<const MessageEntry> registry); 135 136 } // namespace redfish::registries 137