libddwaf-src 2.1.0

// Unless explicitly stated otherwise all files in this repository are
// dual-licensed under the Apache-2.0 License or BSD-3-Clause License.
//
// This product includes software developed at Datadog (https://www.datadoghq.com/).
// Copyright 2025 Datadog, Inc.

#pragma once

#include <cstdint>
#include <span>
#include <string>
#include <string_view>
#include <unordered_map>
#include <utility>

#include "memory_resource.hpp"
#include "object.hpp"
#include "object_store.hpp"
#include "pointer.hpp"
#include "target_address.hpp"

namespace ddwaf {

/**
 * @brief A class for collecting and managing attributes from various sources.
 *
 * The attribute_collector is responsible for gathering attributes from different sources,
 * such as processors and rules, and maintaining them in a structured format. It provides methods
 * to insert various types of attributes (strings, numbers, booleans) and collect attributes
 * from the object store based on specified target addresses and key paths.
 *
 * The collector also maintains a queue of pending attributes which are to be collected
 * from the object store if unavailable when the caller performs a collection. This can be done
 * through the use of the `collect_pending` method.
 *
 * The class is not copyable or moveable to ensure proper resource management.
 */
class attribute_collector {
public:
    explicit attribute_collector(
        nonnull_ptr<memory::memory_resource> alloc = memory::get_default_resource())
        : alloc_(alloc)
    {}
    attribute_collector(const attribute_collector &) = delete;
    attribute_collector &operator=(const attribute_collector &) = delete;
    attribute_collector(attribute_collector &&other) noexcept = default;
    attribute_collector &operator=(attribute_collector &&other) noexcept = default;
    ~attribute_collector() = default;

    bool insert(std::string_view key, bool value)
    {
        return insert(key, owned_object::make_boolean(value));
    }

    template <typename T>
    bool insert(std::string_view key, T value)
        requires std::is_integral_v<T> && std::is_signed_v<T>
    {
        return insert(key, owned_object::make_signed(value));
    }

    template <typename T>
    bool insert(std::string_view key, T value)
        requires std::is_integral_v<T> && std::is_unsigned_v<T> && (!std::same_as<T, bool>)
    {
        return insert(key, owned_object::make_unsigned(value));
    }

    template <typename T>
    bool insert(std::string_view key, T value)
        requires std::is_floating_point_v<T>
    {
        return insert(key, owned_object::make_float(value));
    }

    template <typename T>
    bool insert(std::string_view key, T &&value)
        requires std::convertible_to<T, std::string_view> &&
                 (!std::is_integral_v<std::remove_cvref_t<T>>) &&
                 (!std::is_floating_point_v<std::remove_cvref_t<T>>)
    {
        return insert(
            key, owned_object::make_string(std::string_view(std::forward<T>(value)), alloc_));
    }

    bool insert(std::string_view key, owned_object &&object);
    bool insert_or_assign(std::string_view key, owned_object &&object);

    bool collect(const object_store &store, target_index input_target,
        std::span<const std::variant<std::string, int64_t>> input_key_path,
        std::string_view attribute_key);

    void collect_pending(const object_store &store);

    // This method returns the object map containing all the inserted and
    // collected attributes and resets both the internal object (to an empty map)
    // and the list of previously collected attributes.
    owned_object get_available_attributes_and_reset()
    {
        auto attributes = owned_object::make_map(inserted_.size(), alloc_);
        for (auto &[key, value] : inserted_) { attributes.emplace(key, std::move(value)); }
        inserted_.clear();

        return attributes;
    }

    // Only used for testing
    [[nodiscard]] bool has_pending_attributes() const { return !pending_.empty(); }

    static attribute_collector from_upstream_collector(const attribute_collector &upstream)
    {
        attribute_collector collector{upstream.alloc_};
        collector.pending_ = upstream.pending_;
        return collector;
    }

protected:
    enum class collection_state : uint8_t { success, unavailable, failed };

    collection_state collect_helper(const object_store &store, target_index input_target,
        std::span<const std::variant<std::string, int64_t>> input_key_path,
        std::string_view attribute_key);
    void insert_helper(std::string_view key, owned_object &&object);

    // The views and spans used here are owned by rules and processors, these
    // are part of their definition and are unchanging during the lifetime of
    // the context, therefore it's safe to use them..
    // In this pair, the target_index represents the required address and the
    // string span represents the key path.
    using target_type =
        std::pair<target_index, std::span<const std::variant<std::string, int64_t>>>;
    std::unordered_map<std::string_view, target_type> pending_;

    nonnull_ptr<memory::memory_resource> alloc_;
    std::unordered_map<std::string_view, owned_object> inserted_;
};

} // namespace ddwaf