Attachment.h

/*
 * MIT License
 *
 * Copyright (c) 2025 Adriano dos Santos Fernandes
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in all
 * copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 * SOFTWARE.
 */
 
#ifndef FBCPP_ATTACHMENT_H
#define FBCPP_ATTACHMENT_H
 
#include "fb-cpp-export.h"
#include "fb-api.h"
#include "Blob.h"
#include "RowSet.h"
#include "SmartPtrs.h"
#include "StatementOptions.h"
#include <cstddef>
#include <cstdint>
#include <memory>
#include <optional>
#include <string>
#include <string_view>
#include <vector>
 
 
namespace fbcpp
{
    class Client;
    class Statement;
    class Transaction;
 
    class AttachmentOptions final
    {
    public:
        const std::optional<std::string>& getConnectionCharSet() const
        {
            return connectionCharSet;
        }
 
        AttachmentOptions& setConnectionCharSet(const std::string& value)
        {
            connectionCharSet = value;
            return *this;
        }
 
        const std::optional<std::string>& getUserName() const
        {
            return userName;
        }
 
        AttachmentOptions& setUserName(const std::string& value)
        {
            userName = value;
            return *this;
        }
 
        const std::optional<std::string>& getPassword() const
        {
            return password;
        }
 
        AttachmentOptions& setPassword(const std::string& value)
        {
            password = value;
            return *this;
        }
 
        const std::optional<std::string>& getRole() const
        {
            return role;
        }
 
        AttachmentOptions& setRole(const std::string& value)
        {
            role = value;
            return *this;
        }
 
        const std::optional<std::uint32_t>& getSqlDialect() const
        {
            return sqlDialect;
        }
 
        AttachmentOptions& setSqlDialect(std::uint32_t value)
        {
            sqlDialect = value;
            return *this;
        }
 
        const std::vector<std::uint8_t>& getDpb() const
        {
            return dpb;
        }
 
        AttachmentOptions& setDpb(const std::vector<std::uint8_t>& value)
        {
            dpb = value;
            return *this;
        }
 
        AttachmentOptions& setDpb(std::vector<std::uint8_t>&& value)
        {
            dpb = std::move(value);
            return *this;
        }
 
        bool getCreateDatabase() const
        {
            return createDatabase;
        }
 
        AttachmentOptions& setCreateDatabase(bool value)
        {
            createDatabase = value;
            return *this;
        }
 
        const std::optional<bool>& getForcedWrites() const
        {
            return forcedWrites;
        }
 
        AttachmentOptions& setForcedWrites(bool value)
        {
            forcedWrites = value;
            return *this;
        }
 
    private:
        std::optional<std::string> connectionCharSet;
        std::optional<std::string> userName;
        std::optional<std::string> password;
        std::optional<std::string> role;
        std::optional<std::uint32_t> sqlDialect;
        std::optional<bool> forcedWrites;
        std::vector<std::uint8_t> dpb;
        bool createDatabase = false;
    };
 
    class FB_CPP_EXPORT Attachment final
    {
    public:
        explicit Attachment(Client& client, const std::string& uri, const AttachmentOptions& options = {});
 
        Attachment(Attachment&& o) noexcept
            : client{o.client},
              handle{std::move(o.handle)}
        {
        }
 
        Attachment& operator=(Attachment&& o) noexcept
        {
            if (this != &o)
            {
                client = o.client;
                handle = std::move(o.handle);
            }
 
            return *this;
        }
 
        Attachment(const Attachment&) = delete;
        Attachment& operator=(const Attachment&) = delete;
 
        ~Attachment() noexcept
        {
            if (isValid())
            {
                try
                {
                    disconnectOrDrop(false);
                }
                catch (...)
                {
                    // swallow
                }
            }
        }
 
    public:
        bool isValid() noexcept
        {
            return handle != nullptr;
        }
 
        Client& getClient() noexcept
        {
            return *client;
        }
 
        FbRef<fb::IAttachment> getHandle() noexcept
        {
            return handle;
        }
 
        std::optional<std::string> blobIdToString(
            Transaction& transaction, std::optional<BlobId> blobId, const BlobOptions& options = {});
 
        std::optional<std::vector<std::byte>> blobIdToBytes(
            Transaction& transaction, std::optional<BlobId> blobId, const BlobOptions& options = {});
 
        std::optional<BlobId> blobIdFromString(
            Transaction& transaction, std::optional<std::string_view> value, const BlobOptions& options = {});
 
        std::optional<BlobId> blobIdFromBytes(
            Transaction& transaction, std::optional<std::span<const std::byte>> value, const BlobOptions& options = {});
 
        void disconnect();
 
        void dropDatabase();
 
        void ping();
 
        void resetSession();
 
        bool execute(Transaction& transaction, std::string_view sql, const StatementOptions& options = {});
 
        template <typename Params>
        bool execute(Transaction& transaction, std::string_view sql, const Params& params);
 
        template <typename Params>
        bool execute(
            Transaction& transaction, std::string_view sql, const StatementOptions& options, const Params& params);
 
        RowSet queryRowSet(
            Transaction& transaction, std::string_view sql, unsigned maxRows, const StatementOptions& options = {});
 
        template <typename Params>
        RowSet queryRowSet(Transaction& transaction, std::string_view sql, unsigned maxRows, const Params& params);
 
        template <typename Params>
        RowSet queryRowSet(Transaction& transaction, std::string_view sql, unsigned maxRows,
            const StatementOptions& options, const Params& params);
 
        template <typename T>
        std::optional<T> queryScalar(
            Transaction& transaction, std::string_view sql, const StatementOptions& options = {});
 
        template <typename T, typename Params>
        std::optional<T> queryScalar(Transaction& transaction, std::string_view sql, const Params& params);
 
        template <typename T, typename Params>
        std::optional<T> queryScalar(
            Transaction& transaction, std::string_view sql, const StatementOptions& options, const Params& params);
 
        template <typename T>
        std::optional<T> queryFirstRowAs(
            Transaction& transaction, std::string_view sql, const StatementOptions& options = {});
 
        template <typename T, typename Params>
        std::optional<T> queryFirstRowAs(Transaction& transaction, std::string_view sql, const Params& params);
 
        template <typename T, typename Params>
        std::optional<T> queryFirstRowAs(
            Transaction& transaction, std::string_view sql, const StatementOptions& options, const Params& params);
 
    private:
        void disconnectOrDrop(bool drop);
        RowSet queryPreparedRowSet(Statement& statement, Transaction& transaction, unsigned maxRows);
 
    private:
        Client* client;
        FbRef<fb::IAttachment> handle;
    };
 
    template <typename T>
    std::optional<T> Attachment::queryScalar(
        Transaction& transaction, std::string_view sql, const StatementOptions& options)
    {
        auto rowSet = queryRowSet(transaction, sql, 1u, options);
 
        if (rowSet.getCount() == 0u)
            return std::nullopt;
 
        return rowSet.getRow(0).get<std::optional<T>>(0);
    }
 
    template <typename T>
    std::optional<T> Attachment::queryFirstRowAs(
        Transaction& transaction, std::string_view sql, const StatementOptions& options)
    {
        auto rowSet = queryRowSet(transaction, sql, 1u, options);
 
        if (rowSet.getCount() == 0u)
            return std::nullopt;
 
        return rowSet.getRow(0).get<T>();
    }
}  // namespace fbcpp
 
#include "Statement.h"
 
namespace fbcpp
{
    template <typename Params>
    bool Attachment::execute(Transaction& transaction, std::string_view sql, const Params& params)
    {
        return execute(transaction, sql, StatementOptions{}, params);
    }
 
    template <typename Params>
    bool Attachment::execute(
        Transaction& transaction, std::string_view sql, const StatementOptions& options, const Params& params)
    {
        Statement statement{*this, transaction, sql, options};
        statement.set(params);
        return statement.execute(transaction);
    }
 
    template <typename Params>
    RowSet Attachment::queryRowSet(
        Transaction& transaction, std::string_view sql, unsigned maxRows, const Params& params)
    {
        return queryRowSet(transaction, sql, maxRows, StatementOptions{}, params);
    }
 
    template <typename Params>
    RowSet Attachment::queryRowSet(Transaction& transaction, std::string_view sql, unsigned maxRows,
        const StatementOptions& options, const Params& params)
    {
        Statement statement{*this, transaction, sql, options};
        statement.set(params);
        return queryPreparedRowSet(statement, transaction, maxRows);
    }
 
    template <typename T, typename Params>
    std::optional<T> Attachment::queryScalar(Transaction& transaction, std::string_view sql, const Params& params)
    {
        auto rowSet = queryRowSet(transaction, sql, 1u, params);
 
        if (rowSet.getCount() == 0u)
            return std::nullopt;
 
        return rowSet.getRow(0).template get<std::optional<T>>(0);
    }
 
    template <typename T, typename Params>
    std::optional<T> Attachment::queryScalar(
        Transaction& transaction, std::string_view sql, const StatementOptions& options, const Params& params)
    {
        auto rowSet = queryRowSet(transaction, sql, 1u, options, params);
 
        if (rowSet.getCount() == 0u)
            return std::nullopt;
 
        return rowSet.getRow(0).template get<std::optional<T>>(0);
    }
 
    template <typename T, typename Params>
    std::optional<T> Attachment::queryFirstRowAs(Transaction& transaction, std::string_view sql, const Params& params)
    {
        auto rowSet = queryRowSet(transaction, sql, 1u, params);
 
        if (rowSet.getCount() == 0u)
            return std::nullopt;
 
        return rowSet.getRow(0).template get<T>();
    }
 
    template <typename T, typename Params>
    std::optional<T> Attachment::queryFirstRowAs(
        Transaction& transaction, std::string_view sql, const StatementOptions& options, const Params& params)
    {
        auto rowSet = queryRowSet(transaction, sql, 1u, options, params);
 
        if (rowSet.getCount() == 0u)
            return std::nullopt;
 
        return rowSet.getRow(0).template get<T>();
    }
}  // namespace fbcpp
 
#endif  // FBCPP_ATTACHMENT_H