commitment_repository.h

Go to the documentation of this file.

// BSD 3-Clause License
// Copyright (c) 2021-2025, 🍀☀🌕🌥 🌊
// See the LICENSE file in the project root for full license information.
 
#pragma once
 
#include "kcenon/pacs/services/storage_commitment_types.h"
 
#include <kcenon/common/patterns/result.h>
 
#include <chrono>
#include <cstdint>
#include <memory>
#include <optional>
#include <string>
#include <vector>
 
#ifdef PACS_WITH_DATABASE_SYSTEM
 
#include "kcenon/pacs/storage/base_repository.h"
 
namespace kcenon::pacs::storage {
 
// =============================================================================
// Entity Types
// =============================================================================
 
enum class commitment_status {
    pending,    
    success,    
    partial,    
    failed      
};
 
[[nodiscard]] inline std::string_view to_string(commitment_status s) noexcept {
    switch (s) {
        case commitment_status::pending: return "pending";
        case commitment_status::success: return "success";
        case commitment_status::partial: return "partial";
        case commitment_status::failed: return "failed";
    }
    return "unknown";
}
 
[[nodiscard]] inline commitment_status commitment_status_from_string(
    std::string_view str) noexcept {
    if (str == "success") return commitment_status::success;
    if (str == "partial") return commitment_status::partial;
    if (str == "failed") return commitment_status::failed;
    return commitment_status::pending;
}
 
struct commitment_record {
    std::string transaction_uid;    
    std::string requesting_ae;      
    std::string request_time;       
    std::string completion_time;    
    commitment_status status{commitment_status::pending};
    int total_instances{0};
    int success_count{0};
    int failure_count{0};
};
 
struct commitment_reference_record {
    std::string transaction_uid;    
    std::string sop_class_uid;
    std::string sop_instance_uid;
    std::string status{"pending"};  
    std::optional<int> failure_reason;
};
 
// =============================================================================
// Repository
// =============================================================================
 
class commitment_repository
    : public base_repository<commitment_record, std::string> {
public:
    explicit commitment_repository(std::shared_ptr<pacs_database_adapter> db);
    ~commitment_repository() override = default;
 
    commitment_repository(const commitment_repository&) = delete;
    auto operator=(const commitment_repository&)
        -> commitment_repository& = delete;
    commitment_repository(commitment_repository&&) noexcept = default;
    auto operator=(commitment_repository&&) noexcept
        -> commitment_repository& = default;
 
    // =========================================================================
    // Domain-Specific Operations
    // =========================================================================
 
    [[nodiscard]] auto record_request(
        const std::string& transaction_uid,
        const std::string& requesting_ae,
        const std::vector<services::sop_reference>& references) -> VoidResult;
 
    [[nodiscard]] auto update_result(
        const std::string& transaction_uid,
        const services::commitment_result& result) -> VoidResult;
 
    [[nodiscard]] auto get_status(const std::string& transaction_uid)
        -> Result<commitment_status>;
 
    [[nodiscard]] auto is_duplicate_transaction(
        const std::string& transaction_uid) -> bool;
 
    [[nodiscard]] auto get_references(const std::string& transaction_uid)
        -> Result<std::vector<commitment_reference_record>>;
 
    [[nodiscard]] auto find_by_status(commitment_status status,
                                       size_t limit = 100)
        -> list_result_type;
 
    [[nodiscard]] auto cleanup_old_transactions(std::chrono::hours max_age)
        -> Result<size_t>;
 
protected:
    // =========================================================================
    // base_repository Overrides
    // =========================================================================
 
    [[nodiscard]] auto map_row_to_entity(const database_row& row) const
        -> commitment_record override;
 
    [[nodiscard]] auto entity_to_row(const commitment_record& entity) const
        -> std::map<std::string, database_value> override;
 
    [[nodiscard]] auto get_pk(const commitment_record& entity) const
        -> std::string override;
 
    [[nodiscard]] auto has_pk(const commitment_record& entity) const
        -> bool override;
 
private:
    [[nodiscard]] auto format_timestamp(
        std::chrono::system_clock::time_point tp) const -> std::string;
 
    [[nodiscard]] auto insert_references(
        const std::string& transaction_uid,
        const std::vector<services::sop_reference>& references) -> VoidResult;
};
 
}  // namespace kcenon::pacs::storage
 
#endif  // PACS_WITH_DATABASE_SYSTEM