file_storage.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 "storage_interface.h"
 
#include <kcenon/pacs/core/dicom_dataset.h>
#include <kcenon/pacs/core/dicom_file.h>
 
#include <filesystem>
#include <mutex>
#include <shared_mutex>
#include <string>
#include <unordered_map>
 
namespace kcenon::pacs::storage {
 
enum class naming_scheme {
    uid_hierarchical,
 
    date_hierarchical,
 
    flat
};
 
enum class duplicate_policy {
    reject,
 
    replace,
 
    ignore
};
 
struct file_storage_config {
    std::filesystem::path root_path;
 
    naming_scheme naming = naming_scheme::uid_hierarchical;
 
    duplicate_policy duplicate = duplicate_policy::reject;
 
    bool create_directories = true;
 
    std::string file_extension = ".dcm";
};
 
class file_storage : public storage_interface {
public:
    // =========================================================================
    // Construction
    // =========================================================================
 
    explicit file_storage(const file_storage_config& config);
 
    ~file_storage() override = default;
 
    file_storage(const file_storage&) = delete;
    file_storage& operator=(const file_storage&) = delete;
 
    file_storage(file_storage&&) = delete;
    file_storage& operator=(file_storage&&) = delete;
 
    // =========================================================================
    // storage_interface Implementation
    // =========================================================================
 
    [[nodiscard]] auto store(const core::dicom_dataset& dataset)
        -> VoidResult override;
 
    [[nodiscard]] auto retrieve(std::string_view sop_instance_uid)
        -> Result<core::dicom_dataset> override;
 
    [[nodiscard]] auto remove(std::string_view sop_instance_uid)
        -> VoidResult override;
 
    [[nodiscard]] auto exists(std::string_view sop_instance_uid) const
        -> bool override;
 
    [[nodiscard]] auto find(const core::dicom_dataset& query)
        -> Result<std::vector<core::dicom_dataset>> override;
 
    [[nodiscard]] auto get_statistics() const -> storage_statistics override;
 
    [[nodiscard]] auto verify_integrity() -> VoidResult override;
 
    // =========================================================================
    // File-specific Operations
    // =========================================================================
 
    [[nodiscard]] auto get_file_path(std::string_view sop_instance_uid) const
        -> std::filesystem::path;
 
    [[nodiscard]] auto import_directory(const std::filesystem::path& source)
        -> VoidResult;
 
    [[nodiscard]] auto root_path() const -> const std::filesystem::path&;
 
    [[nodiscard]] auto rebuild_index() -> VoidResult;
 
private:
    // =========================================================================
    // Internal Helper Methods
    // =========================================================================
 
    [[nodiscard]] auto build_path(std::string_view study_uid,
                                  std::string_view series_uid,
                                  std::string_view sop_uid) const
        -> std::filesystem::path;
 
    [[nodiscard]] auto build_date_path(std::string_view study_date,
                                       std::string_view study_uid,
                                       std::string_view sop_uid) const
        -> std::filesystem::path;
 
    void update_index(const std::string& sop_uid,
                      const std::filesystem::path& path);
 
    void remove_from_index(const std::string& sop_uid);
 
    [[nodiscard]] static auto matches_query(const core::dicom_dataset& dataset,
                                            const core::dicom_dataset& query)
        -> bool;
 
    [[nodiscard]] static auto sanitize_uid(std::string_view uid) -> std::string;
 
    // =========================================================================
    // Member Variables
    // =========================================================================
 
    file_storage_config config_;
 
    std::unordered_map<std::string, std::filesystem::path> index_;
 
    mutable std::shared_mutex mutex_;
};
 
}  // namespace kcenon::pacs::storage