postgres_specific_query_executor.hpp

Go to the documentation of this file.

#ifndef IROHA_POSTGRES_SPECIFIC_QUERY_EXECUTOR_HPP
#define IROHA_POSTGRES_SPECIFIC_QUERY_EXECUTOR_HPP

#include "ametsuchi/specific_query_executor.hpp"

#include <soci/soci.h>
#include "common/result.hpp"
#include "interfaces/iroha_internal/query_response_factory.hpp"
#include "logger/logger_fwd.hpp"

namespace shared_model {
  namespace interface {
    class PermissionToString;
    class GetAccount;
    class GetBlock;
    class GetSignatories;
    class GetAccountTransactions;
    class GetAccountAssetTransactions;
    class GetTransactions;
    class GetAccountAssets;
    class GetAccountDetail;
    class GetRoles;
    class GetRolePermissions;
    class GetAssetInfo;
    class GetPendingTransactions;
    class GetPeers;
    class GetEngineReceipts;
  }  // namespace interface
}  // namespace shared_model

namespace iroha {

  class PendingTransactionStorage;

  namespace ametsuchi {

    class BlockStorage;

    using QueryErrorType =
        shared_model::interface::QueryResponseFactory::ErrorQueryType;

    using ErrorQueryResponse = shared_model::interface::ErrorQueryResponse;
    using QueryErrorMessageType = ErrorQueryResponse::ErrorMessageType;
    using QueryErrorCodeType = ErrorQueryResponse::ErrorCodeType;

    class PostgresSpecificQueryExecutor : public SpecificQueryExecutor {
     public:
      PostgresSpecificQueryExecutor(
          soci::session &sql,
          BlockStorage &block_store,
          std::shared_ptr<PendingTransactionStorage> pending_txs_storage,
          std::shared_ptr<shared_model::interface::QueryResponseFactory>
              response_factory,
          std::shared_ptr<shared_model::interface::PermissionToString>
              perm_converter,
          logger::LoggerPtr log);

      QueryExecutorResult execute(
          const shared_model::interface::Query &qry) override;

      bool hasAccountRolePermission(
          shared_model::interface::permissions::Role permission,
          const std::string &account_id) const override;

      QueryExecutorResult operator()(
          const shared_model::interface::GetAccount &q,
          const shared_model::interface::types::AccountIdType &creator_id,
          const shared_model::interface::types::HashType &query_hash);

      QueryExecutorResult operator()(
          const shared_model::interface::GetBlock &q,
          const shared_model::interface::types::AccountIdType &creator_id,
          const shared_model::interface::types::HashType &query_hash);

      QueryExecutorResult operator()(
          const shared_model::interface::GetSignatories &q,
          const shared_model::interface::types::AccountIdType &creator_id,
          const shared_model::interface::types::HashType &query_hash);

      QueryExecutorResult operator()(
          const shared_model::interface::GetAccountTransactions &q,
          const shared_model::interface::types::AccountIdType &creator_id,
          const shared_model::interface::types::HashType &query_hash);

      QueryExecutorResult operator()(
          const shared_model::interface::GetTransactions &q,
          const shared_model::interface::types::AccountIdType &creator_id,
          const shared_model::interface::types::HashType &query_hash);

      QueryExecutorResult operator()(
          const shared_model::interface::GetAccountAssetTransactions &q,
          const shared_model::interface::types::AccountIdType &creator_id,
          const shared_model::interface::types::HashType &query_hash);

      QueryExecutorResult operator()(
          const shared_model::interface::GetAccountAssets &q,
          const shared_model::interface::types::AccountIdType &creator_id,
          const shared_model::interface::types::HashType &query_hash);

      QueryExecutorResult operator()(
          const shared_model::interface::GetAccountDetail &q,
          const shared_model::interface::types::AccountIdType &creator_id,
          const shared_model::interface::types::HashType &query_hash);

      QueryExecutorResult operator()(
          const shared_model::interface::GetRoles &q,
          const shared_model::interface::types::AccountIdType &creator_id,
          const shared_model::interface::types::HashType &query_hash);

      QueryExecutorResult operator()(
          const shared_model::interface::GetRolePermissions &q,
          const shared_model::interface::types::AccountIdType &creator_id,
          const shared_model::interface::types::HashType &query_hash);

      QueryExecutorResult operator()(
          const shared_model::interface::GetAssetInfo &q,
          const shared_model::interface::types::AccountIdType &creator_id,
          const shared_model::interface::types::HashType &query_hash);

      QueryExecutorResult operator()(
          const shared_model::interface::GetPendingTransactions &q,
          const shared_model::interface::types::AccountIdType &creator_id,
          const shared_model::interface::types::HashType &query_hash);

      QueryExecutorResult operator()(
          const shared_model::interface::GetPeers &q,
          const shared_model::interface::types::AccountIdType &creator_id,
          const shared_model::interface::types::HashType &query_hash);

      QueryExecutorResult operator()(
          const shared_model::interface::GetEngineReceipts &q,
          const shared_model::interface::types::AccountIdType &creator_id,
          const shared_model::interface::types::HashType &query_hash);

     private:
      template <typename RangeGen, typename Pred, typename OutputIterator>
      iroha::expected::Result<void, std::string> getTransactionsFromBlock(
          uint64_t block_id,
          RangeGen &&range_gen,
          Pred &&pred,
          OutputIterator dest_it);

      template <typename QueryTuple,
                typename PermissionTuple,
                typename QueryExecutor,
                typename ResponseCreator,
                typename PermissionsErrResponse>
      QueryExecutorResult executeQuery(
          QueryExecutor &&query_executor,
          const shared_model::interface::types::HashType &query_hash,
          ResponseCreator &&response_creator,
          PermissionsErrResponse &&perms_err_response);

      std::unique_ptr<shared_model::interface::QueryResponse>
      logAndReturnErrorResponse(
          iroha::ametsuchi::QueryErrorType error_type,
          QueryErrorMessageType error_body,
          QueryErrorCodeType error_code,
          const shared_model::interface::types::HashType &query_hash) const;

      template <typename Query,
                typename QueryChecker,
                typename QueryApplier,
                typename... Permissions>
      QueryExecutorResult executeTransactionsQuery(
          const Query &query,
          const shared_model::interface::types::AccountIdType &creator_id,
          const shared_model::interface::types::HashType &query_hash,
          QueryChecker &&qry_checker,
          char const *related_txs,
          QueryApplier applier,
          Permissions... perms);

      template <typename ReturnValueType>
      bool existsInDb(const std::string &table_name,
                      const std::string &key_name,
                      const std::string &value_name,
                      const std::string &value) const;

      struct QueryFallbackCheckResult {
        QueryFallbackCheckResult() = default;
        QueryFallbackCheckResult(
            shared_model::interface::ErrorQueryResponse::ErrorCodeType
                error_code,
            shared_model::interface::ErrorQueryResponse::ErrorMessageType
                &&error_message)
            : contains_error{true},
              error_code{error_code},
              error_message{std::move(error_message)} {}

        explicit operator bool() const {
          return contains_error;
        }
        bool contains_error = false;
        shared_model::interface::ErrorQueryResponse::ErrorCodeType error_code =
            0;
        shared_model::interface::ErrorQueryResponse::ErrorMessageType
            error_message = "";
      };

      soci::session &sql_;
      BlockStorage &block_store_;
      std::shared_ptr<PendingTransactionStorage> pending_txs_storage_;
      std::shared_ptr<shared_model::interface::QueryResponseFactory>
          query_response_factory_;
      std::shared_ptr<shared_model::interface::PermissionToString>
          perm_converter_;
      logger::LoggerPtr log_;
      std::string ordering_str_;
    };

  }  // namespace ametsuchi
}  // namespace iroha

#endif  // IROHA_POSTGRES_SPECIFIC_QUERY_EXECUTOR_HPP