Make schemas selectable

Which schemas are installed should be selectable in both a meson config,
and trivially by forks.  This commit gets us closer to that idea.

It does it in several ways, first, the code for generating
JsonSchemaFile resources has been changed to be generated at runtime,
based on files on disk.  This is slightly slower, but allows installing
schemas from anywhere, and matches the CSDL handling.

Next, the schema folders are separated into two sets
csdl -> This includes the complete schema pack from dmtf
installed -> this includes only the schemas the bmc includes

Similar folders exist for json-schema and json-schema-installed.

This allows any additional schemas to be a single symlink addition.
Note, this also checks in all of the dmtf json schemas, not just the
versions we use.  This allows us to update the schema pack without
needing to break our versions we ship.

Because the static files are now selectable, all files need to be in a
folder.  This forces the css and image for the redfish built-in gui to
be moved.

Tested:
/redfish/v1/JsonSchemas returns the correct result
/redfish/v1/JsonSchemas/UpdateService returns a JsonSchemaFile instance
/redfish/v1/JsonSchemas/UpdateService/UpdateService<version>json returns
the JsonSchemaFile contents.

Redfish service validator passes.

Change-Id: Ie96b2e4b623788dc2ec94eb40fcfd80325f0d826
Signed-off-by: Ed Tanous <ed@tanous.net>

.eslintignore

@@ -0,0 +1 @@
+redfish-core/schema/dmtf

meson.build

@@ -318,10 +318,10 @@ summary(
     section: 'Directories',
 )
 
-install_subdir('static', install_dir: 'share/www', strip_directory: true, follow_symlinks: true)
+subdir('static')
+subdir('redfish-core')
 
 # Config subdirectory
-
 subdir('config')
 bmcweb_dependencies += conf_h_dep
 

redfish-core/lib/redfish_v1.hpp

@@ -6,7 +6,6 @@
 #include "http_response.hpp"
 #include "query.hpp"
 #include "registries/privilege_registry.hpp"
-#include "schemas.hpp"
 #include "utility.hpp"
 
 #include <boost/url/format.hpp>
@@ -86,15 +85,32 @@ inline void
     json["Name"] = "JsonSchemaFile Collection";
     json["Description"] = "Collection of JsonSchemaFiles";
     nlohmann::json::array_t members;
-    for (std::string_view schema : schemas)
+
+    std::error_code ec;
+    std::filesystem::directory_iterator dirList(
+        "/usr/share/www/redfish/v1/JsonSchemas", ec);
+    if (ec)
+    {
+        messages::internalError(asyncResp->res);
+        return;
+    }
+    for (const std::filesystem::path& file : dirList)
     {
+        std::string filename = file.filename();
+        std::vector<std::string> split;
+        bmcweb::split(split, filename, '.');
+        if (split.empty())
+        {
+            continue;
+        }
         nlohmann::json::object_t member;
         member["@odata.id"] = boost::urls::format("/redfish/v1/JsonSchemas/{}",
-                                                  schema);
+                                                  split[0]);
         members.emplace_back(std::move(member));
     }
+
+    json["Members@odata.count"] = members.size();
     json["Members"] = std::move(members);
-    json["Members@odata.count"] = schemas.size();
 }
 
 inline void jsonSchemaGet(App& app, const crow::Request& req,
@@ -106,40 +122,97 @@ inline void jsonSchemaGet(App& app, const crow::Request& req,
         return;
     }
 
-    if (std::ranges::find(schemas, schema) == schemas.end())
+    std::error_code ec;
+    std::filesystem::directory_iterator dirList(
+        "/usr/share/www/redfish/v1/JsonSchemas", ec);
+    if (ec)
     {
         messages::resourceNotFound(asyncResp->res, "JsonSchemaFile", schema);
         return;
     }
+    for (const std::filesystem::path& file : dirList)
+    {
+        std::string filename = file.filename();
+        std::vector<std::string> split;
+        bmcweb::split(split, filename, '.');
+        if (split.empty())
+        {
+            continue;
+        }
+        BMCWEB_LOG_DEBUG("Checking {}", split[0]);
+        if (split[0] != schema)
+        {
+            continue;
+        }
+
+        nlohmann::json& json = asyncResp->res.jsonValue;
+        json["@odata.id"] = boost::urls::format("/redfish/v1/JsonSchemas/{}",
+                                                schema);
+        json["@odata.type"] = "#JsonSchemaFile.v1_0_2.JsonSchemaFile";
+        json["Name"] = schema + " Schema File";
+        json["Description"] = schema + " Schema File Location";
+        json["Id"] = schema;
+        std::string schemaName = std::format("#{}.{}", schema, schema);
+        json["Schema"] = std::move(schemaName);
+        constexpr std::array<std::string_view, 1> languages{"en"};
+        json["Languages"] = languages;
+        json["Languages@odata.count"] = languages.size();
+
+        nlohmann::json::array_t locationArray;
+        nlohmann::json::object_t locationEntry;
+        locationEntry["Language"] = "en";
+
+        locationEntry["PublicationUri"] = boost::urls::format(
+            "http://redfish.dmtf.org/schemas/v1/{}", filename);
+        locationEntry["Uri"] = boost::urls::format(
+            "/redfish/v1/JsonSchemas/{}/{}", schema, filename);
+
+        locationArray.emplace_back(locationEntry);
+
+        json["Location"] = std::move(locationArray);
+        json["Location@odata.count"] = 1;
+        return;
+    }
+    messages::resourceNotFound(asyncResp->res, "JsonSchemaFile", schema);
+}
 
-    nlohmann::json& json = asyncResp->res.jsonValue;
-    json["@odata.id"] = boost::urls::format("/redfish/v1/JsonSchemas/{}",
-                                            schema);
-    json["@odata.type"] = "#JsonSchemaFile.v1_0_2.JsonSchemaFile";
-    json["Name"] = schema + " Schema File";
-    json["Description"] = schema + " Schema File Location";
-    json["Id"] = schema;
-    std::string schemaName = "#";
-    schemaName += schema;
-    schemaName += ".";
-    schemaName += schema;
-    json["Schema"] = std::move(schemaName);
-    constexpr std::array<std::string_view, 1> languages{"en"};
-    json["Languages"] = languages;
-    json["Languages@odata.count"] = languages.size();
-
-    nlohmann::json::array_t locationArray;
-    nlohmann::json::object_t locationEntry;
-    locationEntry["Language"] = "en";
-    locationEntry["PublicationUri"] = "http://redfish.dmtf.org/schemas/v1/" +
-                                      schema + ".json";
-    locationEntry["Uri"] = boost::urls::format(
-        "/redfish/v1/JsonSchemas/{}/{}", schema, std::string(schema) + ".json");
-
-    locationArray.emplace_back(locationEntry);
-
-    json["Location"] = std::move(locationArray);
-    json["Location@odata.count"] = 1;
+inline void
+    jsonSchemaGetFile(const crow::Request& /*req*/,
+                      const std::shared_ptr<bmcweb::AsyncResp>& asyncResp,
+                      const std::string& schema, const std::string& schemaFile)
+{
+    // Sanity check the filename
+    if (schemaFile.find_first_not_of(
+            "abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789_-.") !=
+        std::string::npos)
+    {
+        messages::resourceNotFound(asyncResp->res, "JsonSchemaFile", schema);
+        return;
+    }
+    // Schema path should look like /redfish/v1/JsonSchemas/Foo/Foo.x.json
+    // Make sure the two paths match.
+    if (!schemaFile.starts_with(schema))
+    {
+        messages::resourceNotFound(asyncResp->res, "JsonSchemaFile", schema);
+        return;
+    }
+    std::filesystem::path filepath("/usr/share/www/redfish/v1/JsonSchemas");
+    filepath /= schemaFile;
+    if (filepath.is_relative())
+    {
+        messages::resourceNotFound(asyncResp->res, "JsonSchemaFile", schema);
+        return;
+    }
+
+    if (!asyncResp->res.openFile(filepath))
+    {
+        BMCWEB_LOG_DEBUG("failed to read file");
+        asyncResp->res.result(
+            boost::beast::http::status::internal_server_error);
+        return;
+    }
+
+    messages::resourceNotFound(asyncResp->res, "JsonSchemaFile", schema);
 }
 
 inline void requestRoutesRedfish(App& app)
@@ -148,6 +221,10 @@ inline void requestRoutesRedfish(App& app)
         .methods(boost::beast::http::verb::get)(
             std::bind_front(redfishGet, std::ref(app)));
 
+    BMCWEB_ROUTE(app, "/redfish/v1/JsonSchemas/<str>/<str>")
+        .privileges(redfish::privileges::getJsonSchemaFile)
+        .methods(boost::beast::http::verb::get)(jsonSchemaGetFile);
+
     BMCWEB_ROUTE(app, "/redfish/v1/JsonSchemas/<str>/")
         .privileges(redfish::privileges::getJsonSchemaFileCollection)
         .methods(boost::beast::http::verb::get)(

redfish-core/meson.build

@@ -0,0 +1 @@
+subdir('schema')

redfish-core/schema/dmtf/json-schema-installed/AccountService.v1_15_1.json

@@ -0,0 +1 @@
+../json-schema/AccountService.v1_15_1.json

redfish-core/schema/dmtf/json-schema-installed/ActionInfo.v1_4_2.json

@@ -0,0 +1 @@
+../json-schema/ActionInfo.v1_4_2.json

redfish-core/schema/dmtf/json-schema-installed/AggregationService.v1_0_3.json

@@ -0,0 +1 @@
+../json-schema/AggregationService.v1_0_3.json

redfish-core/schema/dmtf/json-schema-installed/AggregationSource.v1_4_1.json

@@ -0,0 +1 @@
+../json-schema/AggregationSource.v1_4_1.json

redfish-core/schema/dmtf/json-schema-installed/AggregationSourceCollection.json

@@ -0,0 +1 @@
+../json-schema/AggregationSourceCollection.json

redfish-core/schema/dmtf/json-schema-installed/Assembly.v1_5_1.json

@@ -0,0 +1 @@
+../json-schema/Assembly.v1_5_1.json

redfish-core/schema/dmtf/json-schema-installed/AttributeRegistry.v1_3_9.json

@@ -0,0 +1 @@
+../json-schema/AttributeRegistry.v1_3_9.json

redfish-core/schema/dmtf/json-schema-installed/Bios.v1_2_3.json

@@ -0,0 +1 @@
+../json-schema/Bios.v1_2_3.json

redfish-core/schema/dmtf/json-schema-installed/Cable.v1_2_3.json

@@ -0,0 +1 @@
+../json-schema/Cable.v1_2_3.json

redfish-core/schema/dmtf/json-schema-installed/CableCollection.json

@@ -0,0 +1 @@
+../json-schema/CableCollection.json

redfish-core/schema/dmtf/json-schema-installed/Certificate.v1_8_2.json

@@ -0,0 +1 @@
+../json-schema/Certificate.v1_8_2.json

redfish-core/schema/dmtf/json-schema-installed/CertificateCollection.json

@@ -0,0 +1 @@
+../json-schema/CertificateCollection.json

redfish-core/schema/dmtf/json-schema-installed/CertificateLocations.v1_0_4.json

@@ -0,0 +1 @@
+../json-schema/CertificateLocations.v1_0_4.json

redfish-core/schema/dmtf/json-schema-installed/CertificateService.v1_0_5.json

@@ -0,0 +1 @@
+../json-schema/CertificateService.v1_0_5.json

redfish-core/schema/dmtf/json-schema-installed/Chassis.v1_25_1.json

@@ -0,0 +1 @@
+../json-schema/Chassis.v1_25_1.json

redfish-core/schema/dmtf/json-schema-installed/ChassisCollection.json

@@ -0,0 +1 @@
+../json-schema/ChassisCollection.json

redfish-core/schema/dmtf/json-schema-installed/ComponentIntegrity.v1_2_3.json

@@ -0,0 +1 @@
+../json-schema/ComponentIntegrity.v1_2_3.json

redfish-core/schema/dmtf/json-schema-installed/ComponentIntegrityCollection.json

@@ -0,0 +1 @@
+../json-schema/ComponentIntegrityCollection.json

redfish-core/schema/dmtf/json-schema-installed/ComputerSystem.v1_22_1.json

@@ -0,0 +1 @@
+../json-schema/ComputerSystem.v1_22_1.json

redfish-core/schema/dmtf/json-schema-installed/ComputerSystemCollection.json

@@ -0,0 +1 @@
+../json-schema/ComputerSystemCollection.json

redfish-core/schema/dmtf/json-schema-installed/Drive.v1_19_0.json

@@ -0,0 +1 @@
+../json-schema/Drive.v1_19_0.json

redfish-core/schema/dmtf/json-schema-installed/DriveCollection.json

@@ -0,0 +1 @@
+../json-schema/DriveCollection.json

redfish-core/schema/dmtf/json-schema-installed/EnvironmentMetrics.v1_3_2.json

@@ -0,0 +1 @@
+../json-schema/EnvironmentMetrics.v1_3_2.json

redfish-core/schema/dmtf/json-schema-installed/EthernetInterface.v1_12_1.json

@@ -0,0 +1 @@
+../json-schema/EthernetInterface.v1_12_1.json

redfish-core/schema/dmtf/json-schema-installed/EthernetInterfaceCollection.json

@@ -0,0 +1 @@
+../json-schema/EthernetInterfaceCollection.json

redfish-core/schema/dmtf/json-schema-installed/Event.v1_10_1.json

@@ -0,0 +1 @@
+../json-schema/Event.v1_10_1.json

redfish-core/schema/dmtf/json-schema-installed/EventDestination.v1_14_1.json

@@ -0,0 +1 @@
+../json-schema/EventDestination.v1_14_1.json

redfish-core/schema/dmtf/json-schema-installed/EventDestinationCollection.json

@@ -0,0 +1 @@
+../json-schema/EventDestinationCollection.json

redfish-core/schema/dmtf/json-schema-installed/EventService.v1_10_2.json

@@ -0,0 +1 @@
+../json-schema/EventService.v1_10_2.json

redfish-core/schema/dmtf/json-schema-installed/FabricAdapter.v1_5_3.json

@@ -0,0 +1 @@
+../json-schema/FabricAdapter.v1_5_3.json

redfish-core/schema/dmtf/json-schema-installed/FabricAdapterCollection.json

@@ -0,0 +1 @@
+../json-schema/FabricAdapterCollection.json

redfish-core/schema/dmtf/json-schema-installed/Fan.v1_5_2.json

@@ -0,0 +1 @@
+../json-schema/Fan.v1_5_2.json

redfish-core/schema/dmtf/json-schema-installed/FanCollection.json

@@ -0,0 +1 @@
+../json-schema/FanCollection.json

redfish-core/schema/dmtf/json-schema-installed/IPAddresses.v1_1_5.json

@@ -0,0 +1 @@
+../json-schema/IPAddresses.v1_1_5.json

redfish-core/schema/dmtf/json-schema-installed/JsonSchemaFile.v1_1_5.json

@@ -0,0 +1 @@
+../json-schema/JsonSchemaFile.v1_1_5.json

redfish-core/schema/dmtf/json-schema-installed/JsonSchemaFileCollection.json

@@ -0,0 +1 @@
+../json-schema/JsonSchemaFileCollection.json

redfish-core/schema/dmtf/json-schema-installed/LogEntry.v1_16_1.json

@@ -0,0 +1 @@
+../json-schema/LogEntry.v1_16_1.json

redfish-core/schema/dmtf/json-schema-installed/LogEntryCollection.json

@@ -0,0 +1 @@
+../json-schema/LogEntryCollection.json

redfish-core/schema/dmtf/json-schema-installed/LogService.v1_7_0.json

@@ -0,0 +1 @@
+../json-schema/LogService.v1_7_0.json

redfish-core/schema/dmtf/json-schema-installed/LogServiceCollection.json

@@ -0,0 +1 @@
+../json-schema/LogServiceCollection.json

redfish-core/schema/dmtf/json-schema-installed/Manager.v1_19_1.json

@@ -0,0 +1 @@
+../json-schema/Manager.v1_19_1.json

redfish-core/schema/dmtf/json-schema-installed/ManagerAccount.v1_12_1.json

@@ -0,0 +1 @@
+../json-schema/ManagerAccount.v1_12_1.json

redfish-core/schema/dmtf/json-schema-installed/ManagerAccountCollection.json

@@ -0,0 +1 @@
+../json-schema/ManagerAccountCollection.json

redfish-core/schema/dmtf/json-schema-installed/ManagerCollection.json

@@ -0,0 +1 @@
+../json-schema/ManagerCollection.json

redfish-core/schema/dmtf/json-schema-installed/ManagerDiagnosticData.v1_2_3.json

@@ -0,0 +1 @@
+../json-schema/ManagerDiagnosticData.v1_2_3.json

redfish-core/schema/dmtf/json-schema-installed/ManagerNetworkProtocol.v1_10_1.json

@@ -0,0 +1 @@
+../json-schema/ManagerNetworkProtocol.v1_10_1.json

redfish-core/schema/dmtf/json-schema-installed/Memory.v1_20_0.json

@@ -0,0 +1 @@
+../json-schema/Memory.v1_20_0.json

redfish-core/schema/dmtf/json-schema-installed/MemoryCollection.json

@@ -0,0 +1 @@
+../json-schema/MemoryCollection.json

redfish-core/schema/dmtf/json-schema-installed/Message.v1_2_1.json

@@ -0,0 +1 @@
+../json-schema/Message.v1_2_1.json

redfish-core/schema/dmtf/json-schema-installed/MessageRegistry.v1_6_3.json

@@ -0,0 +1 @@
+../json-schema/MessageRegistry.v1_6_3.json

redfish-core/schema/dmtf/json-schema-installed/MessageRegistryCollection.json

@@ -0,0 +1 @@
+../json-schema/MessageRegistryCollection.json

redfish-core/schema/dmtf/json-schema-installed/MessageRegistryFile.v1_1_5.json

@@ -0,0 +1 @@
+../json-schema/MessageRegistryFile.v1_1_5.json

redfish-core/schema/dmtf/json-schema-installed/MessageRegistryFileCollection.json

@@ -0,0 +1 @@
+../json-schema/MessageRegistryFileCollection.json

redfish-core/schema/dmtf/json-schema-installed/MetricDefinition.v1_3_4.json

@@ -0,0 +1 @@
+../json-schema/MetricDefinition.v1_3_4.json

redfish-core/schema/dmtf/json-schema-installed/MetricDefinitionCollection.json

@@ -0,0 +1 @@
+../json-schema/MetricDefinitionCollection.json

redfish-core/schema/dmtf/json-schema-installed/MetricReport.v1_5_1.json

@@ -0,0 +1 @@
+../json-schema/MetricReport.v1_5_1.json

redfish-core/schema/dmtf/json-schema-installed/MetricReportCollection.json

@@ -0,0 +1 @@
+../json-schema/MetricReportCollection.json

redfish-core/schema/dmtf/json-schema-installed/MetricReportDefinition.v1_4_6.json

@@ -0,0 +1 @@
+../json-schema/MetricReportDefinition.v1_4_6.json

redfish-core/schema/dmtf/json-schema-installed/MetricReportDefinitionCollection.json

@@ -0,0 +1 @@
+../json-schema/MetricReportDefinitionCollection.json

redfish-core/schema/dmtf/json-schema-installed/OperatingConfig.v1_0_4.json

@@ -0,0 +1 @@
+../json-schema/OperatingConfig.v1_0_4.json

redfish-core/schema/dmtf/json-schema-installed/OperatingConfigCollection.json

@@ -0,0 +1 @@
+../json-schema/OperatingConfigCollection.json

redfish-core/schema/dmtf/json-schema-installed/PCIeDevice.v1_14_0.json

@@ -0,0 +1 @@
+../json-schema/PCIeDevice.v1_14_0.json

redfish-core/schema/dmtf/json-schema-installed/PCIeDeviceCollection.json

@@ -0,0 +1 @@
+../json-schema/PCIeDeviceCollection.json

redfish-core/schema/dmtf/json-schema-installed/PCIeFunction.v1_6_0.json

@@ -0,0 +1 @@
+../json-schema/PCIeFunction.v1_6_0.json

redfish-core/schema/dmtf/json-schema-installed/PCIeFunctionCollection.json

@@ -0,0 +1 @@
+../json-schema/PCIeFunctionCollection.json

redfish-core/schema/dmtf/json-schema-installed/PCIeSlots.v1_6_1.json

@@ -0,0 +1 @@
+../json-schema/PCIeSlots.v1_6_1.json