logger_adapter.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 <chrono>
#include <cstdint>
#include <filesystem>
#include <kcenon/pacs/compat/format.h>
#include <functional>
#include <map>
#include <memory>
#include <optional>
#include <string>
#include <string_view>
 
namespace kcenon::pacs::integration {
 
// ─────────────────────────────────────────────────────
// Forward Declarations
// ─────────────────────────────────────────────────────
 
enum class log_level {
    trace = 0,
    debug = 1,
    info = 2,
    warn = 3,
    error = 4,
    fatal = 5,
    off = 6
};
 
enum class storage_status {
    success,
    out_of_resources,
    dataset_error,
    cannot_understand,
    processing_failure,
    duplicate_rejected,
    duplicate_stored,
    unknown_error
};
 
enum class move_status {
    success,
    partial_success,
    refused_out_of_resources,
    refused_move_destination_unknown,
    identifier_does_not_match,
    unable_to_process,
    cancelled,
    unknown_error
};
 
// Note: query_level may also be defined in monitoring_adapter.hpp
#ifndef PACS_INTEGRATION_QUERY_LEVEL_DEFINED
#define PACS_INTEGRATION_QUERY_LEVEL_DEFINED
enum class query_level { patient, study, series, image };
#endif
 
enum class security_event_type {
    authentication_success,
    authentication_failure,
    access_denied,
    configuration_change,
    data_export,
    association_rejected,
    invalid_request
};
 
// ─────────────────────────────────────────────────────
// Configuration
// ─────────────────────────────────────────────────────
 
struct logger_config {
    std::filesystem::path log_directory{"logs"};
 
    log_level min_level{log_level::info};
 
    bool enable_console{true};
 
    bool enable_file{true};
 
    bool enable_audit_log{true};
 
    std::size_t max_file_size_mb{100};
 
    std::size_t max_files{10};
 
    std::string audit_log_format{"json"};
 
    bool async_mode{true};
 
    std::size_t buffer_size{8192};
};
 
// ─────────────────────────────────────────────────────
// Logger Adapter Class
// ─────────────────────────────────────────────────────
 
class logger_adapter {
public:
    // ─────────────────────────────────────────────────────
    // Initialization
    // ─────────────────────────────────────────────────────
 
    static void initialize(const logger_config& config);
 
    static void shutdown();
 
    [[nodiscard]] static auto is_initialized() noexcept -> bool;
 
    // ─────────────────────────────────────────────────────
    // Standard Logging
    // ─────────────────────────────────────────────────────
 
    template <typename... Args>
    static void trace(kcenon::pacs::compat::format_string<Args...> fmt, Args&&... args) {
        log(log_level::trace, kcenon::pacs::compat::format(fmt, std::forward<Args>(args)...));
    }
 
    template <typename... Args>
    static void debug(kcenon::pacs::compat::format_string<Args...> fmt, Args&&... args) {
        log(log_level::debug, kcenon::pacs::compat::format(fmt, std::forward<Args>(args)...));
    }
 
    template <typename... Args>
    static void info(kcenon::pacs::compat::format_string<Args...> fmt, Args&&... args) {
        log(log_level::info, kcenon::pacs::compat::format(fmt, std::forward<Args>(args)...));
    }
 
    template <typename... Args>
    static void warn(kcenon::pacs::compat::format_string<Args...> fmt, Args&&... args) {
        log(log_level::warn, kcenon::pacs::compat::format(fmt, std::forward<Args>(args)...));
    }
 
    template <typename... Args>
    static void error(kcenon::pacs::compat::format_string<Args...> fmt, Args&&... args) {
        log(log_level::error, kcenon::pacs::compat::format(fmt, std::forward<Args>(args)...));
    }
 
    template <typename... Args>
    static void fatal(kcenon::pacs::compat::format_string<Args...> fmt, Args&&... args) {
        log(log_level::fatal, kcenon::pacs::compat::format(fmt, std::forward<Args>(args)...));
    }
 
    static void log(log_level level, const std::string& message);
 
    [[nodiscard]] static auto is_level_enabled(log_level level) noexcept -> bool;
 
    static void flush();
 
    // ─────────────────────────────────────────────────────
    // DICOM Audit Logging (for HIPAA/compliance)
    // ─────────────────────────────────────────────────────
 
    static void log_association_established(const std::string& calling_ae,
                                            const std::string& called_ae,
                                            const std::string& remote_ip);
 
    static void log_association_released(const std::string& calling_ae,
                                         const std::string& called_ae);
 
    static void log_c_store_received(const std::string& calling_ae,
                                     const std::string& patient_id,
                                     const std::string& study_uid,
                                     const std::string& sop_instance_uid,
                                     storage_status status);
 
    static void log_c_find_executed(const std::string& calling_ae,
                                    query_level level,
                                    std::size_t matches_returned);
 
    static void log_c_move_executed(const std::string& calling_ae,
                                    const std::string& destination_ae,
                                    const std::string& study_uid,
                                    std::size_t instances_moved,
                                    move_status status);
 
    static void log_security_event(security_event_type type,
                                   const std::string& description,
                                   const std::string& user_id = "");
 
    // ─────────────────────────────────────────────────────
    // Configuration
    // ─────────────────────────────────────────────────────
 
    static void set_min_level(log_level level);
 
    [[nodiscard]] static auto get_min_level() noexcept -> log_level;
 
    [[nodiscard]] static auto get_config() -> const logger_config&;
 
private:
    // Private implementation helpers
    static void write_audit_log(const std::string& event_type,
                                const std::string& outcome,
                                const std::map<std::string, std::string>& fields);
 
    [[nodiscard]] static auto storage_status_to_string(storage_status status) -> std::string;
    [[nodiscard]] static auto move_status_to_string(move_status status) -> std::string;
    [[nodiscard]] static auto query_level_to_string(query_level level) -> std::string;
    [[nodiscard]] static auto security_event_to_string(security_event_type type) -> std::string;
    [[nodiscard]] static auto log_level_to_string(log_level level) -> std::string;
 
    // Internal state (managed through pimpl or static members)
    class impl;
    static std::unique_ptr<impl> pimpl_;
};
 
}  // namespace kcenon::pacs::integration