xref: /openbmc/bmcweb/features/redfish/include/utils/json_utils.hpp (revision 9712f8ac42746e65f32c2bc3de0835846652568e)

/*
// Copyright (c) 2018 Intel Corporation
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
//      http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
*/
#pragma once

#include <crow/http_request.h>
#include <crow/http_response.h>

#include <bitset>
#include <error_messages.hpp>
#include <nlohmann/json.hpp>
namespace redfish
{

namespace json_util
{

/**
 * @brief Defines JSON utils operation status
 */
enum class Result
{
    SUCCESS,
    NOT_EXIST,
    WRONG_TYPE,
    NULL_POINTER
};

/**
 * @brief Describes JSON utils messages requirement
 */
enum class MessageSetting
{
    NONE = 0x0,      ///< No messages will be added
    MISSING = 0x1,   ///< PropertyMissing message will be added
    TYPE_ERROR = 0x2 ///< PropertyValueTypeError message will be added
};

/**
 * @brief Wrapper function for extracting string from JSON object without
 *        throwing exceptions
 *
 * @param[in]  fieldName   Name of requested field
 * @param[in]  json        JSON object from which field should be extracted
 * @param[out] output      Variable to which extracted will be written in case
 *                         of success
 *
 * @return Result informing about operation status, output will be
 *         written only in case of Result::SUCCESS
 */
Result getString(const char* fieldName, const nlohmann::json& json,
                 const std::string*& output);

/**
 * @brief Wrapper function for extracting object from JSON object without
 *        throwing exceptions
 *
 * @param[in]  fieldName   Name of requested field
 * @param[in]  json        JSON object from which field should be extracted
 * @param[out] output      Variable to which extracted will be written in case
 *                         of success
 *
 * @return Result informing about operation status, output will be
 *         written only in case of Result::SUCCESS
 */
Result getObject(const char* fieldName, const nlohmann::json& json,
                 nlohmann::json* output);

/**
 * @brief Wrapper function for extracting array from JSON object without
 *        throwing exceptions
 *
 * @param[in]  fieldName   Name of requested field
 * @param[in]  json        JSON object from which field should be extracted
 * @param[out] output      Variable to which extracted will be written in case
 *                         of success
 *
 * @return Result informing about operation status, output will be
 *         written only in case of Result::SUCCESS
 */
Result getArray(const char* fieldName, const nlohmann::json& json,
                nlohmann::json* output);

/**
 * @brief Wrapper function for extracting int from JSON object without
 *        throwing exceptions
 *
 * @param[in]  fieldName   Name of requested field
 * @param[in]  json        JSON object from which field should be extracted
 * @param[out] output      Variable to which extracted will be written in case
 *                         of success
 *
 * @return Result informing about operation status, output will be
 *         written only in case of Result::SUCCESS
 */
Result getInt(const char* fieldName, const nlohmann::json& json,
              int64_t& output);

/**
 * @brief Wrapper function for extracting uint from JSON object without
 *        throwing exceptions
 *
 * @param[in]  fieldName   Name of requested field
 * @param[in]  json        JSON object from which field should be extracted
 * @param[out] output      Variable to which extracted will be written in case
 *                         of success
 *
 * @return Result informing about operation status, output will be
 *         written only in case of Result::SUCCESS
 */
Result getUnsigned(const char* fieldName, const nlohmann::json& json,
                   uint64_t& output);

/**
 * @brief Wrapper function for extracting bool from JSON object without
 *        throwing exceptions
 *
 * @param[in]  fieldName   Name of requested field
 * @param[in]  json        JSON object from which field should be extracted
 * @param[out] output      Variable to which extracted will be written in case
 *                         of success
 *
 * @return Result informing about operation status, output will be
 *         written only in case of Result::SUCCESS
 */
Result getBool(const char* fieldName, const nlohmann::json& json, bool& output);

/**
 * @brief Wrapper function for extracting float from JSON object without
 *        throwing exceptions (nlohmann stores JSON floats as C++ doubles)
 *
 * @param[in]  fieldName   Name of requested field
 * @param[in]  json        JSON object from which field should be extracted
 * @param[out] output      Variable to which extracted will be written in case
 *                         of success
 *
 * @return Result informing about operation status, output will be
 *         written only in case of Result::SUCCESS
 */
Result getDouble(const char* fieldName, const nlohmann::json& json,
                 double& output);

/**
 * @brief Wrapper function for extracting string from JSON object without
 *        throwing exceptions
 *
 * @param[in]  fieldName   Name of requested field
 * @param[in]  json        JSON object from which field should be extracted
 * @param[out] output      Variable to which extracted will be written in case
 *                         of success
 * @param[in]  msgCfgMap   Map for message addition settings
 * @param[out] msgJson     JSON to which error messages will be added
 * @param[in]  fieldPath   Field path in JSON
 *
 * @return Result informing about operation status, output will be
 *         written only in case of Result::SUCCESS
 */
Result getString(const char* fieldName, const nlohmann::json& json,
                 const std::string*& output, uint8_t msgCfgMap,
                 nlohmann::json& msgJson, const std::string&& fieldPath);

/**
 * @brief Wrapper function for extracting object from JSON object without
 *        throwing exceptions
 *
 * @param[in]  fieldName   Name of requested field
 * @param[in]  json        JSON object from which field should be extracted
 * @param[out] output      Variable to which extracted will be written in case
 *                         of success
 * @param[in]  msgCfgMap   Map for message addition settings
 * @param[out] msgJson     JSON to which error messages will be added
 * @param[in]  fieldPath   Field path in JSON
 *
 * @return Result informing about operation status, output will be
 *         written only in case of Result::SUCCESS
 */
Result getObject(const char* fieldName, const nlohmann::json& json,
                 nlohmann::json* output, uint8_t msgCfgMap,
                 nlohmann::json& msgJson, const std::string&& fieldPath);

/**
 * @brief Wrapper function for extracting array from JSON object without
 *        throwing exceptions
 *
 * @param[in]  fieldName   Name of requested field
 * @param[in]  json        JSON object from which field should be extracted
 * @param[out] output      Variable to which extracted will be written in case
 *                         of success
 * @param[in]  msgCfgMap   Map for message addition settings
 * @param[out] msgJson     JSON to which error messages will be added
 * @param[in]  fieldPath   Field path in JSON
 *
 * @return Result informing about operation status, output will be
 *         written only in case of Result::SUCCESS
 */
Result getArray(const char* fieldName, const nlohmann::json& json,
                nlohmann::json* output, uint8_t msgCfgMap,
                nlohmann::json& msgJson, const std::string&& fieldPath);

/**
 * @brief Wrapper function for extracting int from JSON object without
 *        throwing exceptions
 *
 * @param[in]  fieldName   Name of requested field
 * @param[in]  json        JSON object from which field should be extracted
 * @param[out] output      Variable to which extracted will be written in case
 *                         of success
 * @param[in]  msgCfgMap   Map for message addition settings
 * @param[out] msgJson     JSON to which error messages will be added
 * @param[in]  fieldPath   Field path in JSON
 *
 * @return Result informing about operation status, output will be
 *         written only in case of Result::SUCCESS
 */
Result getInt(const char* fieldName, const nlohmann::json& json,
              int64_t& output, uint8_t msgCfgMap, nlohmann::json& msgJson,
              const std::string&& fieldPath);

/**
 * @brief Wrapper function for extracting uint from JSON object without
 *        throwing exceptions
 *
 * @param[in]  fieldName   Name of requested field
 * @param[in]  json        JSON object from which field should be extracted
 * @param[out] output      Variable to which extracted will be written in case
 *                         of success
 * @param[in]  msgCfgMap   Map for message addition settings
 * @param[out] msgJson     JSON to which error messages will be added
 * @param[in]  fieldPath   Field path in JSON
 *
 * @return Result informing about operation status, output will be
 *         written only in case of Result::SUCCESS
 */
Result getUnsigned(const char* fieldName, const nlohmann::json& json,
                   uint64_t& output, uint8_t msgCfgMap, nlohmann::json& msgJson,
                   const std::string&& fieldPath);

/**
 * @brief Wrapper function for extracting bool from JSON object without
 *        throwing exceptions
 *
 * @param[in]  fieldName   Name of requested field
 * @param[in]  json        JSON object from which field should be extracted
 * @param[out] output      Variable to which extracted will be written in case
 *                         of success
 * @param[in]  msgCfgMap   Map for message addition settings
 * @param[out] msgJson     JSON to which error messages will be added
 * @param[in]  fieldPath   Field path in JSON
 *
 * @return Result informing about operation status, output will be
 *         written only in case of Result::SUCCESS
 */
Result getBool(const char* fieldName, const nlohmann::json& json, bool& output,
               uint8_t msgCfgMap, nlohmann::json& msgJson,
               const std::string&& fieldPath);

/**
 * @brief Wrapper function for extracting float from JSON object without
 *        throwing exceptions (nlohmann stores JSON floats as C++ doubles)
 *
 * @param[in]  fieldName   Name of requested field
 * @param[in]  json        JSON object from which field should be extracted
 * @param[out] output      Variable to which extracted will be written in case
 * of success
 * @param[in]  msgCfgMap   Map for message addition settings
 * @param[out] msgJson     JSON to which error messages will be added
 * @param[in]  fieldPath   Field path in JSON
 *
 * @return Result informing about operation status, output will be
 *         written only in case of Result::SUCCESS
 */
Result getDouble(const char* fieldName, const nlohmann::json& json,
                 double& output, uint8_t msgCfgMap, nlohmann::json& msgJson,
                 const std::string&& fieldPath);

/**
 * @brief Processes request to extract JSON from its body. If it fails, adds
 *       MalformedJSON message to response and ends it.
 *
 * @param[io]  res       Response object
 * @param[in]  req       Request object
 * @param[out] reqJson   JSON object extracted from request's body
 *
 * @return true if JSON is valid, false when JSON is invalid and response has
 *         been filled with message and ended.
 */
bool processJsonFromRequest(crow::Response& res, const crow::Request& req,
                            nlohmann::json& reqJson);
namespace details
{
template <typename Type> struct unpackValue
{
    using isRequired = std::true_type;
    using JsonType = std::add_const_t<std::add_pointer_t<Type>>;
};

template <typename OptionalType>
struct unpackValue<boost::optional<OptionalType>>
{
    using isRequired = std::false_type;
    using JsonType = std::add_const_t<std::add_pointer_t<OptionalType>>;
};

template <size_t Count, size_t Index>
void readJsonValues(const std::string& key, nlohmann::json& jsonValue,
                    crow::Response& res, std::bitset<Count>& handled)
{
    BMCWEB_LOG_DEBUG << "Unable to find variable for key" << key;
    messages::addMessageToErrorJson(res.jsonValue,
                                    messages::propertyUnknown(key));
    res.result(boost::beast::http::status::bad_request);
}

template <size_t Count, size_t Index, typename ValueType,
          typename... UnpackTypes>
void readJsonValues(const std::string& key, nlohmann::json& jsonValue,
                    crow::Response& res, std::bitset<Count>& handled,
                    const char* keyToCheck, ValueType& valueToFill,
                    UnpackTypes&... in)
{
    if (key != keyToCheck)
    {
        readJsonValues<Count, Index + 1>(key, jsonValue, res, handled, in...);
        return;
    }

    handled.set(Index);

    using UnpackType = typename unpackValue<ValueType>::JsonType;
    UnpackType value = jsonValue.get_ptr<UnpackType>();
    if (value == nullptr)
    {
        BMCWEB_LOG_DEBUG << "Value for key " << key
                         << " was incorrect type: " << jsonValue.type_name();
        messages::addMessageToErrorJson(
            res.jsonValue,
            messages::propertyValueTypeError(jsonValue.dump(), key));
        res.result(boost::beast::http::status::bad_request);

        return;
    }

    valueToFill = *value;
}

template <size_t Index = 0, size_t Count>
void handleMissing(std::bitset<Count>& handled, crow::Response& res)
{
}

template <size_t Index = 0, size_t Count, typename ValueType,
          typename... UnpackTypes>
void handleMissing(std::bitset<Count>& handled, crow::Response& res,
                   const char* key, ValueType& unused, UnpackTypes&... in)
{
    if (!handled.test(Index) && unpackValue<ValueType>::isRequired::value)
    {
        messages::addMessageToErrorJson(res.jsonValue,
                                        messages::propertyMissing(key));
        res.result(boost::beast::http::status::bad_request);
    }
    details::handleMissing<Index + 1, Count>(handled, res, in...);
}
} // namespace details

template <typename... UnpackTypes>
bool readJson(const crow::Request& req, crow::Response& res, const char* key,
              UnpackTypes&... in)
{
    nlohmann::json jsonRequest;
    if (!json_util::processJsonFromRequest(res, req, jsonRequest))
    {
        BMCWEB_LOG_DEBUG << "Json value not readable";
        return false;
    }
    if (!jsonRequest.is_object())
    {
        BMCWEB_LOG_DEBUG << "Json value is not an object";
        messages::addMessageToErrorJson(res.jsonValue,
                                        messages::unrecognizedRequestBody());
        res.result(boost::beast::http::status::bad_request);
        return false;
    }

    if (jsonRequest.empty())
    {
        BMCWEB_LOG_DEBUG << "Json value is empty";
        messages::addMessageToErrorJson(res.jsonValue, messages::emptyJSON());
        res.result(boost::beast::http::status::bad_request);
        return false;
    }

    std::bitset<(sizeof...(in) + 1) / 2> handled(0);
    for (const auto& item : jsonRequest.items())
    {
        details::readJsonValues<(sizeof...(in) + 1) / 2, 0, UnpackTypes...>(
            item.key(), item.value(), res, handled, key, in...);
    }

    if (!handled.all())
    {
        details::handleMissing(handled, res, key, in...);

        return false;
    }
    return res.result() == boost::beast::http::status::ok;
}

} // namespace json_util
} // namespace redfish