audit.h

Go to the documentation of this file.

#pragma once
 
#include <parcel/cell.h>
#include <parcel/common.h>
#include <parcel/defaults.h>
#include <parcel/descriptor.h>
#include <parcel/json.h>
 
#include <commons/audit_record.hpp>
#include <commons/identity.hpp>
#include <commons/json/audit_record.hpp>
 
#include <cstddef>
#include <string>
#include <string_view>
 
namespace parcel {
 
class AuditRecordCell : public BaseCell<AuditRecordCell, comms::AuditRecord> {
    using base_t = BaseCell<AuditRecordCell, comms::AuditRecord>;
 
public:
    using base_t::base_t;
    using base_t::operator=;
 
    static constexpr std::string_view kind_id = "audit_record";
 
    [[nodiscard]] std::string to_string() const override {
        return this->value.identity ? comms::to_string(*this->value.identity) : std::string{"—"};
    }
 
    static cell_t from_json(json_t const& j, ParcelRegistry const&) {
        return base_t::from_json_strict(j);
    }
 
    static cell_type_descriptor_t descriptor() {
        static const auto d = std::make_shared<SimpleCellTypeDescriptor<AuditRecordCell>>(
            DisplayInfo{.name = "AuditRecord",
                        .description = "Audit-trail entry (who did what, when, from where)"});
        return d;
    }
};
 
class AuditRecordsCell : public BaseCell<AuditRecordsCell, comms::AuditRecords> {
    using base_t = BaseCell<AuditRecordsCell, comms::AuditRecords>;
 
public:
    using base_t::base_t;
    using base_t::operator=;
 
    static constexpr std::string_view kind_id = "audit_records";
 
    [[nodiscard]] std::string to_string() const override {
        return "[" + std::to_string(this->value.size()) + " audit records]";
    }
 
    static cell_t from_json(json_t const& j, ParcelRegistry const&) {
        return base_t::from_json_strict(j);
    }
 
    static cell_type_descriptor_t descriptor() {
        static const auto d = std::make_shared<SimpleCellTypeDescriptor<AuditRecordsCell>>(
            DisplayInfo{.name = "AuditRecords",
                        .description = "Capped, insertion-ordered log of audit records"});
        return d;
    }
};
 
template <CellLike P>
class ChangeAuditRecordCell
    : public BaseCell<ChangeAuditRecordCell<P>, comms::ChangeAuditRecord<typename P::storage_t>> {
    using base_t = BaseCell<ChangeAuditRecordCell, comms::ChangeAuditRecord<typename P::storage_t>>;
 
public:
    using element_type = P;
 
    using base_t::base_t;
    using base_t::operator=;
 
    static constexpr std::string_view kind_id = prefixed_id_v<"change_audit_record:", P::kind_id>;
 
    [[nodiscard]] std::string to_string() const override {
        return this->value.identity ? comms::to_string(*this->value.identity) : std::string{"—"};
    }
 
    static cell_t from_json(json_t const& j, ParcelRegistry const&) {
        return base_t::from_json_strict(j);
    }
 
    static cell_type_descriptor_t descriptor() {
        static const auto d = std::make_shared<SimpleCellTypeDescriptor<ChangeAuditRecordCell>>(
            DisplayInfo{.name = "ChangeAuditRecord",
                        .description = std::string("Audit-trail change entry (before/after ") +
                                       std::string(P::kind_id) + ")"});
        return d;
    }
};
 
template <CellLike P>
class ChangeAuditRecordsCell
    : public BaseCell<ChangeAuditRecordsCell<P>, comms::ChangeAuditRecords<typename P::storage_t>> {
    using base_t =
        BaseCell<ChangeAuditRecordsCell, comms::ChangeAuditRecords<typename P::storage_t>>;
 
public:
    using element_type = P;
 
    using base_t::base_t;
    using base_t::operator=;
 
    static constexpr std::string_view kind_id = prefixed_id_v<"change_audit_records:", P::kind_id>;
 
    [[nodiscard]] std::string to_string() const override {
        return "[" + std::to_string(this->value.size()) + " change audit records]";
    }
 
    static cell_t from_json(json_t const& j, ParcelRegistry const&) {
        return base_t::from_json_strict(j);
    }
 
    static cell_type_descriptor_t descriptor() {
        static const auto d =
            std::make_shared<SimpleCellTypeDescriptor<ChangeAuditRecordsCell>>(DisplayInfo{
                .name = "ChangeAuditRecords",
                .description = std::string("Capped log of change audit records (before/after ") +
                               std::string(P::kind_id) + ")"});
        return d;
    }
};
 
}  // namespace parcel
 
PARCEL_DEFAULT_CELL(parcel::AuditRecordCell);
PARCEL_DEFAULT_CELL(parcel::AuditRecordsCell);