query_scp.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.
 
#ifndef PACS_SERVICES_QUERY_SCP_HPP
#define PACS_SERVICES_QUERY_SCP_HPP
 
#include "scp_service.h"
 
#include <atomic>
#include <functional>
#include <memory>
#include <optional>
 
namespace kcenon::pacs::security { class atna_service_auditor; }
 
namespace kcenon::pacs::services {
 
// =============================================================================
// SOP Class UIDs
// =============================================================================
 
inline constexpr std::string_view patient_root_find_sop_class_uid =
    "1.2.840.10008.5.1.4.1.2.1.1";
 
inline constexpr std::string_view study_root_find_sop_class_uid =
    "1.2.840.10008.5.1.4.1.2.2.1";
 
inline constexpr std::string_view patient_study_only_find_sop_class_uid =
    "1.2.840.10008.5.1.4.1.2.3.1";
 
inline constexpr std::string_view modality_worklist_find_sop_class_uid =
    "1.2.840.10008.5.1.4.31";
 
// =============================================================================
// Query Level
// =============================================================================
 
enum class query_level {
    patient,  
    study,    
    series,   
    image     
};
 
[[nodiscard]] constexpr std::string_view to_string(query_level level) noexcept {
    switch (level) {
        case query_level::patient: return "PATIENT";
        case query_level::study: return "STUDY";
        case query_level::series: return "SERIES";
        case query_level::image: return "IMAGE";
        default: return "UNKNOWN";
    }
}
 
[[nodiscard]] inline std::optional<query_level> parse_query_level(
    std::string_view level_str) noexcept {
    if (level_str == "PATIENT") return query_level::patient;
    if (level_str == "STUDY") return query_level::study;
    if (level_str == "SERIES") return query_level::series;
    if (level_str == "IMAGE") return query_level::image;
    return std::nullopt;
}
 
// =============================================================================
// Query Handler Types
// =============================================================================
 
using query_handler = std::function<std::vector<core::dicom_dataset>(
    query_level level,
    const core::dicom_dataset& query_keys,
    const std::string& calling_ae)>;
 
using cancel_check = std::function<bool()>;
 
// =============================================================================
// Query SCP Class
// =============================================================================
 
class query_scp final : public scp_service {
public:
    // =========================================================================
    // Construction
    // =========================================================================
 
    explicit query_scp(std::shared_ptr<di::ILogger> logger = nullptr);
 
    ~query_scp() override = default;
 
    // =========================================================================
    // Configuration
    // =========================================================================
 
    void set_handler(query_handler handler);
 
    void set_max_results(size_t max) noexcept;
 
    [[nodiscard]] size_t max_results() const noexcept;
 
    void set_cancel_check(cancel_check check);
 
    void set_audit_handler(
        std::shared_ptr<kcenon::pacs::security::atna_service_auditor> auditor);
 
    // =========================================================================
    // scp_service Interface Implementation
    // =========================================================================
 
    [[nodiscard]] std::vector<std::string> supported_sop_classes() const override;
 
    [[nodiscard]] network::Result<std::monostate> handle_message(
        network::association& assoc,
        uint8_t context_id,
        const network::dimse::dimse_message& request) override;
 
    [[nodiscard]] std::string_view service_name() const noexcept override;
 
    // =========================================================================
    // Statistics
    // =========================================================================
 
    [[nodiscard]] size_t queries_processed() const noexcept;
 
    void reset_statistics() noexcept;
 
private:
    // =========================================================================
    // Private Implementation
    // =========================================================================
 
    [[nodiscard]] std::optional<query_level> extract_query_level(
        const core::dicom_dataset& dataset) const;
 
    [[nodiscard]] network::Result<std::monostate> send_pending_response(
        network::association& assoc,
        uint8_t context_id,
        uint16_t message_id,
        std::string_view sop_class_uid,
        const core::dicom_dataset& result);
 
    [[nodiscard]] network::Result<std::monostate> send_final_response(
        network::association& assoc,
        uint8_t context_id,
        uint16_t message_id,
        std::string_view sop_class_uid,
        network::dimse::status_code status);
 
    // =========================================================================
    // Member Variables
    // =========================================================================
 
    query_handler handler_;
    cancel_check cancel_check_;
    std::shared_ptr<kcenon::pacs::security::atna_service_auditor> auditor_;
    size_t max_results_{0};  // 0 = unlimited
    std::atomic<size_t> queries_processed_{0};
};
 
}  // namespace kcenon::pacs::services
 
#endif  // PACS_SERVICES_QUERY_SCP_HPP