dq_message_handler.hpp

/* -*- mode: c++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*-
 *
 * Copyright (C) 2025 Marco Craveiro <marco.craveiro@gmail.com>
 *
 * This program is free software; you can redistribute it and/or modify it under
 * the terms of the GNU General Public License as published by the Free Software
 * Foundation; either version 3 of the License, or (at your option) any later
 * version.
 *
 * This program is distributed in the hope that it will be useful, but WITHOUT
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
 * FOR A PARTICULAR PURPOSE. See the GNU General Public License for more
 * details.
 *
 * You should have received a copy of the GNU General Public License along with
 * this program; if not, write to the Free Software Foundation, Inc., 51
 * Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
 *
 */
#ifndef ORES_DQ_MESSAGING_DQ_MESSAGE_HANDLER_HPP
#define ORES_DQ_MESSAGING_DQ_MESSAGE_HANDLER_HPP
 
#include <memory>
#include "ores.database/domain/context.hpp"
#include "ores.logging/make_logger.hpp"
#include "ores.comms/messaging/message_handler.hpp"
#include "ores.comms/service/auth_session_service.hpp"
#include "ores.iam/service/authorization_service.hpp"
#include "ores.dq/service/change_management_service.hpp"
#include "ores.dq/service/data_organization_service.hpp"
#include "ores.dq/service/dataset_service.hpp"
#include "ores.dq/service/coding_scheme_service.hpp"
#include "ores.dq/service/dimension_service.hpp"
#include "ores.dq/service/publication_service.hpp"
#include "ores.dq/service/dataset_bundle_service.hpp"
#include "ores.dq/service/dataset_bundle_member_service.hpp"
 
namespace ores::dq::messaging {
 
class dq_message_handler final : public comms::messaging::message_handler {
private:
    [[nodiscard]] static auto& lg() {
        using namespace ores::logging;
        static auto instance = make_logger(
            "ores.dq.messaging.dq_message_handler");
        return instance;
    }
 
public:
    dq_message_handler(database::context ctx,
        std::shared_ptr<comms::service::auth_session_service> sessions,
        std::shared_ptr<iam::service::authorization_service> auth_service);
 
    using handler_result = boost::asio::awaitable<
        std::expected<std::vector<std::byte>, ores::utility::serialization::error_code>
    >;
 
    handler_result
    handle_message(comms::messaging::message_type type,
        std::span<const std::byte> payload,
        const std::string& remote_address) override;
 
private:
    // =========================================================================
    // Change Management Handlers
    // =========================================================================
 
    handler_result
    handle_get_change_reason_categories_request(
        std::span<const std::byte> payload,
        const std::string& remote_address);
 
    handler_result
    handle_get_change_reasons_request(std::span<const std::byte> payload,
        const std::string& remote_address);
 
    handler_result
    handle_get_change_reasons_by_category_request(
        std::span<const std::byte> payload,
        const std::string& remote_address);
 
    handler_result
    handle_save_change_reason_request(std::span<const std::byte> payload,
        const std::string& remote_address);
 
    handler_result
    handle_delete_change_reason_request(std::span<const std::byte> payload,
        const std::string& remote_address);
 
    handler_result
    handle_get_change_reason_history_request(std::span<const std::byte> payload,
        const std::string& remote_address);
 
    handler_result
    handle_save_change_reason_category_request(
        std::span<const std::byte> payload,
        const std::string& remote_address);
 
    handler_result
    handle_delete_change_reason_category_request(
        std::span<const std::byte> payload,
        const std::string& remote_address);
 
    handler_result
    handle_get_change_reason_category_history_request(
        std::span<const std::byte> payload,
        const std::string& remote_address);
 
    // =========================================================================
    // Catalog Handlers
    // =========================================================================
 
    handler_result
    handle_get_catalogs_request(std::span<const std::byte> payload,
        const std::string& remote_address);
 
    handler_result
    handle_save_catalog_request(std::span<const std::byte> payload,
        const std::string& remote_address);
 
    handler_result
    handle_delete_catalog_request(std::span<const std::byte> payload,
        const std::string& remote_address);
 
    handler_result
    handle_get_catalog_history_request(std::span<const std::byte> payload,
        const std::string& remote_address);
 
    // =========================================================================
    // Dataset Dependency Handlers
    // =========================================================================
 
    handler_result
    handle_get_dataset_dependencies_request(std::span<const std::byte> payload,
        const std::string& remote_address);
 
    handler_result
    handle_get_dataset_dependencies_by_dataset_request(
        std::span<const std::byte> payload,
        const std::string& remote_address);
 
    // =========================================================================
    // Data Domain Handlers
    // =========================================================================
 
    handler_result
    handle_get_data_domains_request(std::span<const std::byte> payload,
        const std::string& remote_address);
 
    handler_result
    handle_save_data_domain_request(std::span<const std::byte> payload,
        const std::string& remote_address);
 
    handler_result
    handle_delete_data_domain_request(std::span<const std::byte> payload,
        const std::string& remote_address);
 
    handler_result
    handle_get_data_domain_history_request(std::span<const std::byte> payload,
        const std::string& remote_address);
 
    // =========================================================================
    // Subject Area Handlers
    // =========================================================================
 
    handler_result
    handle_get_subject_areas_request(std::span<const std::byte> payload,
        const std::string& remote_address);
 
    handler_result
    handle_get_subject_areas_by_domain_request(std::span<const std::byte> payload,
        const std::string& remote_address);
 
    handler_result
    handle_save_subject_area_request(std::span<const std::byte> payload,
        const std::string& remote_address);
 
    handler_result
    handle_delete_subject_area_request(std::span<const std::byte> payload,
        const std::string& remote_address);
 
    handler_result
    handle_get_subject_area_history_request(std::span<const std::byte> payload,
        const std::string& remote_address);
 
    // =========================================================================
    // Dataset Handlers
    // =========================================================================
 
    handler_result
    handle_get_datasets_request(std::span<const std::byte> payload,
        const std::string& remote_address);
 
    handler_result
    handle_save_dataset_request(std::span<const std::byte> payload,
        const std::string& remote_address);
 
    handler_result
    handle_delete_dataset_request(std::span<const std::byte> payload,
        const std::string& remote_address);
 
    handler_result
    handle_get_dataset_history_request(std::span<const std::byte> payload,
        const std::string& remote_address);
 
    // =========================================================================
    // Methodology Handlers
    // =========================================================================
 
    handler_result
    handle_get_methodologies_request(std::span<const std::byte> payload,
        const std::string& remote_address);
 
    handler_result
    handle_save_methodology_request(std::span<const std::byte> payload,
        const std::string& remote_address);
 
    handler_result
    handle_delete_methodology_request(std::span<const std::byte> payload,
        const std::string& remote_address);
 
    handler_result
    handle_get_methodology_history_request(std::span<const std::byte> payload,
        const std::string& remote_address);
 
    // =========================================================================
    // Coding Scheme Handlers
    // =========================================================================
 
    handler_result
    handle_get_coding_schemes_request(std::span<const std::byte> payload,
        const std::string& remote_address);
 
    handler_result
    handle_get_coding_schemes_by_authority_type_request(
        std::span<const std::byte> payload,
        const std::string& remote_address);
 
    handler_result
    handle_save_coding_scheme_request(std::span<const std::byte> payload,
        const std::string& remote_address);
 
    handler_result
    handle_delete_coding_scheme_request(std::span<const std::byte> payload,
        const std::string& remote_address);
 
    handler_result
    handle_get_coding_scheme_history_request(std::span<const std::byte> payload,
        const std::string& remote_address);
 
    // =========================================================================
    // Coding Scheme Authority Type Handlers
    // =========================================================================
 
    handler_result
    handle_get_coding_scheme_authority_types_request(
        std::span<const std::byte> payload,
        const std::string& remote_address);
 
    handler_result
    handle_save_coding_scheme_authority_type_request(
        std::span<const std::byte> payload,
        const std::string& remote_address);
 
    handler_result
    handle_delete_coding_scheme_authority_type_request(
        std::span<const std::byte> payload,
        const std::string& remote_address);
 
    handler_result
    handle_get_coding_scheme_authority_type_history_request(
        std::span<const std::byte> payload,
        const std::string& remote_address);
 
    // =========================================================================
    // Nature Dimension Handlers
    // =========================================================================
 
    handler_result
    handle_get_nature_dimensions_request(std::span<const std::byte> payload,
        const std::string& remote_address);
 
    handler_result
    handle_save_nature_dimension_request(std::span<const std::byte> payload,
        const std::string& remote_address);
 
    handler_result
    handle_delete_nature_dimension_request(std::span<const std::byte> payload,
        const std::string& remote_address);
 
    handler_result
    handle_get_nature_dimension_history_request(std::span<const std::byte> payload,
        const std::string& remote_address);
 
    // =========================================================================
    // Origin Dimension Handlers
    // =========================================================================
 
    handler_result
    handle_get_origin_dimensions_request(std::span<const std::byte> payload,
        const std::string& remote_address);
 
    handler_result
    handle_save_origin_dimension_request(std::span<const std::byte> payload,
        const std::string& remote_address);
 
    handler_result
    handle_delete_origin_dimension_request(std::span<const std::byte> payload,
        const std::string& remote_address);
 
    handler_result
    handle_get_origin_dimension_history_request(std::span<const std::byte> payload,
        const std::string& remote_address);
 
    // =========================================================================
    // Treatment Dimension Handlers
    // =========================================================================
 
    handler_result
    handle_get_treatment_dimensions_request(std::span<const std::byte> payload,
        const std::string& remote_address);
 
    handler_result
    handle_save_treatment_dimension_request(std::span<const std::byte> payload,
        const std::string& remote_address);
 
    handler_result
    handle_delete_treatment_dimension_request(std::span<const std::byte> payload,
        const std::string& remote_address);
 
    handler_result
    handle_get_treatment_dimension_history_request(std::span<const std::byte> payload,
        const std::string& remote_address);
 
    // =========================================================================
    // Publication Handlers
    // =========================================================================
 
    handler_result
    handle_publish_datasets_request(std::span<const std::byte> payload,
        const std::string& remote_address);
 
    handler_result
    handle_get_publications_request(std::span<const std::byte> payload,
        const std::string& remote_address);
 
    handler_result
    handle_resolve_dependencies_request(std::span<const std::byte> payload,
        const std::string& remote_address);
 
    handler_result
    handle_publish_bundle_request(std::span<const std::byte> payload,
        const std::string& remote_address);
 
    // =========================================================================
    // Dataset Bundle Handlers
    // =========================================================================
 
    handler_result
    handle_get_dataset_bundles_request(std::span<const std::byte> payload,
        const std::string& remote_address);
 
    handler_result
    handle_save_dataset_bundle_request(std::span<const std::byte> payload,
        const std::string& remote_address);
 
    handler_result
    handle_delete_dataset_bundle_request(std::span<const std::byte> payload,
        const std::string& remote_address);
 
    handler_result
    handle_get_dataset_bundle_history_request(std::span<const std::byte> payload,
        const std::string& remote_address);
 
    // =========================================================================
    // Dataset Bundle Member Handlers
    // =========================================================================
 
    handler_result
    handle_get_dataset_bundle_members_request(std::span<const std::byte> payload,
        const std::string& remote_address);
 
    handler_result
    handle_get_dataset_bundle_members_by_bundle_request(
        std::span<const std::byte> payload,
        const std::string& remote_address);
 
    handler_result
    handle_save_dataset_bundle_member_request(std::span<const std::byte> payload,
        const std::string& remote_address);
 
    handler_result
    handle_delete_dataset_bundle_member_request(std::span<const std::byte> payload,
        const std::string& remote_address);
 
    using auth_check_result = std::expected<
        comms::service::session_info,
        ores::utility::serialization::error_code
    >;
 
    auth_check_result check_authorization(
        const std::string& remote_address,
        std::string_view permission,
        std::string_view operation_name);
 
    auth_check_result get_authenticated_session(
        const std::string& remote_address,
        std::string_view operation_name);
 
    database::context ctx_;
    std::shared_ptr<comms::service::auth_session_service> sessions_;
    std::shared_ptr<iam::service::authorization_service> auth_service_;
    service::change_management_service change_management_service_;
    service::data_organization_service data_organization_service_;
    service::dataset_service dataset_service_;
    service::coding_scheme_service coding_scheme_service_;
    service::dimension_service dimension_service_;
    service::publication_service publication_service_;
    service::dataset_bundle_service dataset_bundle_service_;
    service::dataset_bundle_member_service dataset_bundle_member_service_;
};
 
}
 
#endif