transaction_base.hxx

/* Common code and definitions for the transaction classes.
 *
 * pqxx::transaction_base defines the interface for any abstract class that
 * represents a database transaction.
 *
 * DO NOT INCLUDE THIS FILE DIRECTLY; include pqxx/transaction_base instead.
 *
 * Copyright (c) 2000-2020, Jeroen T. Vermeulen.
 *
 * See COPYING for copyright license.  If you did not receive a file called
 * COPYING with this source code, please notify the distributor of this
 * mistake, or contact the author.
 */
#ifndef PQXX_H_TRANSACTION_BASE
#define PQXX_H_TRANSACTION_BASE

#include "pqxx/compiler-public.hxx"
#include "pqxx/internal/compiler-internal-pre.hxx"

#include <string_view>

/* End-user programs need not include this file, unless they define their own
 * transaction classes.  This is not something the typical program should want
 * to do.
 *
 * However, reading this file is worthwhile because it defines the public
 * interface for the available transaction classes such as transaction and
 * nontransaction.
 */

#include "pqxx/connection.hxx"
#include "pqxx/internal/encoding_group.hxx"
#include "pqxx/isolation.hxx"
#include "pqxx/result.hxx"
#include "pqxx/row.hxx"


namespace pqxx::internal
{
class sql_cursor;

class PQXX_LIBEXPORT transactionfocus : public virtual namedclass
{
public:
  explicit transactionfocus(transaction_base &t) :
          namedclass{"transactionfocus"},
          m_trans{t}
  {}

  transactionfocus() = delete;
  transactionfocus(transactionfocus const &) = delete;
  transactionfocus &operator=(transactionfocus const &) = delete;

protected:
  void register_me();
  void unregister_me() noexcept;
  void reg_pending_error(std::string const &) noexcept;
  bool registered() const noexcept { return m_registered; }

  transaction_base &m_trans;

private:
  bool m_registered = false;
};
} // namespace pqxx::internal


namespace pqxx::internal::gate
{
class transaction_subtransaction;
class transaction_sql_cursor;
class transaction_stream_to;
class transaction_transactionfocus;
} // namespace pqxx::internal::gate


namespace pqxx
{

class PQXX_LIBEXPORT PQXX_NOVTABLE transaction_base
        : public virtual internal::namedclass
{
public:
  transaction_base() = delete;
  transaction_base(transaction_base const &) = delete;
  transaction_base &operator=(transaction_base const &) = delete;

  virtual ~transaction_base() = 0;


  void commit();


  void abort();

  [[nodiscard]] std::string esc(char const text[]) const
  {
    return conn().esc(text);
  }
  [[nodiscard]] std::string esc(char const text[], size_t maxlen) const
  {
    return conn().esc(text, maxlen);
  }
  [[nodiscard]] std::string esc(std::string const &text) const
  {
    return conn().esc(text);
  }
  [[nodiscard]] std::string esc(std::string_view text) const
  {
    return conn().esc(text);
  }


  [[nodiscard]] std::string
  esc_raw(unsigned char const data[], size_t len) const
  {
    return conn().esc_raw(data, len);
  }
  [[nodiscard]] std::string esc_raw(std::string const &) const;


  [[nodiscard]] std::string unesc_raw(std::string const &text) const
  {
    return conn().unesc_raw(text);
  }


  [[nodiscard]] std::string unesc_raw(char const *text) const
  {
    return conn().unesc_raw(text);
  }


  template<typename T>[[nodiscard]] std::string quote(T const &t) const
  {
    return conn().quote(t);
  }

  [[nodiscard]] std::string
  quote_raw(unsigned char const bin[], size_t len) const
  {
    return conn().quote_raw(bin, len);
  }

  [[nodiscard]] std::string quote_raw(std::string const &bin) const;

  [[nodiscard]] std::string quote_name(std::string_view identifier) const
  {
    return conn().quote_name(identifier);
  }

  [[nodiscard]] std::string
  esc_like(std::string const &bin, char escape_char = '\\') const
  {
    return conn().esc_like(bin, escape_char);
  }


  result exec(std::string_view query, std::string const &desc = std::string{});

  result
  exec(std::stringstream const &query, std::string const &desc = std::string{})
  {
    return exec(query.str(), desc);
  }


  result
  exec0(std::string const &query, std::string const &desc = std::string{})
  {
    return exec_n(0, query, desc);
  }


  row exec1(std::string const &query, std::string const &desc = std::string{})
  {
    return exec_n(1, query, desc).front();
  }


  result exec_n(
    result::size_type rows, std::string const &query,
    std::string const &desc = std::string{});

  template<typename TYPE>
  TYPE query_value(
    std::string const &query, std::string const &desc = std::string{})
  {
    row const r{exec1(query, desc)};
    if (r.size() != 1)
      throw usage_error{"Queried single value from result with " +
                        to_string(r.size()) + " columns."};
    return r[0].as<TYPE>();
  }

  template<typename... Args>
  result exec_params(std::string const &query, Args &&... args)
  {
    return internal_exec_params(
      query, internal::params(std::forward<Args>(args)...));
  }

  // Execute parameterised statement, expect a single-row result.
  template<typename... Args>
  row exec_params1(std::string const &query, Args &&... args)
  {
    return exec_params_n(1, query, std::forward<Args>(args)...).front();
  }

  // Execute parameterised statement, expect a result with zero rows.
  template<typename... Args>
  result exec_params0(std::string const &query, Args &&... args)
  {
    return exec_params_n(0, query, std::forward<Args>(args)...);
  }

  // Execute parameterised statement, expect exactly a given number of rows.
  template<typename... Args>
  result exec_params_n(size_t rows, std::string const &query, Args &&... args)
  {
    auto const r{exec_params(query, std::forward<Args>(args)...)};
    check_rowcount_params(rows, r.size());
    return r;
  }


  template<typename... Args>
  result exec_prepared(std::string const &statement, Args &&... args)
  {
    return internal_exec_prepared(
      zview{statement.c_str(), statement.size()},
      internal::params(std::forward<Args>(args)...));
  }

  template<typename... Args>
  result exec_prepared(zview statement, Args &&... args)
  {
    return internal_exec_prepared(
      statement, internal::params(std::forward<Args>(args)...));
  }


  template<typename... Args>
  row exec_prepared1(std::string const &statement, Args &&... args)
  {
    return exec_prepared_n(1, statement, std::forward<Args>(args)...).front();
  }

  template<typename... Args>
  row exec_prepared1(zview statement, Args &&... args)
  {
    return exec_prepared_n(1, statement, std::forward<Args>(args)...).front();
  }


  template<typename... Args>
  result exec_prepared0(std::string const &statement, Args &&... args)
  {
    return exec_prepared_n(0, statement, std::forward<Args>(args)...);
  }

  template<typename... Args>
  result exec_prepared0(zview statement, Args &&... args)
  {
    return exec_prepared_n(0, statement, std::forward<Args>(args)...);
  }


  template<typename... Args>
  result exec_prepared_n(
    result::size_type rows, std::string const &statement, Args &&... args)
  {
    auto const r{exec_prepared(statement, std::forward<Args>(args)...)};
    check_rowcount_prepared(statement, rows, r.size());
    return r;
  }

  template<typename... Args>
  result
  exec_prepared_n(result::size_type rows, zview statement, Args &&... args)
  {
    auto const r{exec_prepared(statement, std::forward<Args>(args)...)};
    check_rowcount_prepared(statement, rows, r.size());
    return r;
  }


  void process_notice(char const msg[]) const { m_conn.process_notice(msg); }
  void process_notice(std::string const &msg) const
  {
    m_conn.process_notice(msg);
  }

  [[nodiscard]] connection &conn() const { return m_conn; }


  void set_variable(std::string_view var, std::string_view value);


  std::string get_variable(std::string_view);

protected:

  explicit transaction_base(connection &c);

  void register_transaction();

  void close() noexcept;

  virtual void do_commit() = 0;
  virtual void do_abort() = 0;

  // For use by implementing class:

  result direct_exec(std::string_view);
  result direct_exec(std::shared_ptr<std::string>);

private:
  enum class status
  {
    nascent,
    active,
    aborted,
    committed,
    in_doubt
  };

  PQXX_PRIVATE void check_pending_error();

  template<typename T> bool parm_is_null(T *p) const noexcept
  {
    return p == nullptr;
  }
  template<typename T> bool parm_is_null(T) const noexcept { return false; }

  result internal_exec_prepared(zview statement, internal::params const &args);

  result
  internal_exec_params(std::string const &query, internal::params const &args);

  void check_rowcount_prepared(
    std::string const &statement, result::size_type expected_rows,
    result::size_type actual_rows);

  void check_rowcount_params(size_t expected_rows, size_t actual_rows);

  friend class pqxx::internal::gate::transaction_transactionfocus;
  PQXX_PRIVATE void register_focus(internal::transactionfocus *);
  PQXX_PRIVATE void unregister_focus(internal::transactionfocus *) noexcept;
  PQXX_PRIVATE void register_pending_error(std::string const &) noexcept;

  connection &m_conn;

  internal::unique<internal::transactionfocus> m_focus;
  status m_status = status::active;
  bool m_registered = false;
  std::string m_pending_error;
};
} // namespace pqxx


namespace pqxx::internal
{
template<pqxx::isolation_level isolation, pqxx::write_policy rw>
extern const zview begin_cmd;

// These are not static members, so "constexpr" does not imply "inline".
template<>
inline constexpr zview begin_cmd<read_committed, write_policy::read_write>{
  "BEGIN"};
template<>
inline constexpr zview begin_cmd<read_committed, write_policy::read_only>{
  "BEGIN READ ONLY"};
template<>
inline constexpr zview begin_cmd<repeatable_read, write_policy::read_write>{
  "BEGIN ISOLATION LEVEL REPEATABLE READ"};
template<>
inline constexpr zview begin_cmd<repeatable_read, write_policy::read_only>{
  "BEGIN ISOLATION LEVEL REPEATABLE READ READ ONLY"};
template<>
inline constexpr zview begin_cmd<serializable, write_policy::read_write>{
  "BEGIN ISOLATION LEVEL SERIALIZABLE"};
template<>
inline constexpr zview begin_cmd<serializable, write_policy::read_only>{
  "BEGIN ISOLATION LEVEL SERIALIZABLE READ ONLY"};
} // namespace pqxx::internal

#include "pqxx/internal/compiler-internal-post.hxx"
#endif