query_rest_table.h

Go to the documentation of this file.

/*
  Copyright (c) 2021, 2026, Oracle and/or its affiliates.
 
  This program is free software; you can redistribute it and/or modify
  it under the terms of the GNU General Public License, version 2.0,
  as published by the Free Software Foundation.
 
  This program is designed to work with certain software (including
  but not limited to OpenSSL) that is licensed under separate terms,
  as designated in a particular file or component or in included license
  documentation.  The authors of MySQL hereby grant you an additional
  permission to link the program and your derivative works with the
  separately licensed software that they have either included with
  the program or referenced in the documentation.
 
  This program is distributed in the hope that it will be useful,
  but WITHOUT ANY WARRANTY; without even the implied warranty of
  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  GNU General Public License for more details.
 
  You should have received a copy of the GNU General Public License
  along with this program; if not, write to the Free Software
  Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
*/
 
#ifndef ROUTER_SRC_REST_MRS_SRC_MRS_DATABASE_REST_QUERY_H_
#define ROUTER_SRC_REST_MRS_SRC_MRS_DATABASE_REST_QUERY_H_
 
#include <memory>
#include <optional>
#include <set>
#include <string>
#include <vector>
 
#include "mrs/database/entry/auth_user.h"
#include "mrs/database/entry/object.h"
#include "mrs/database/entry/row_group_ownership.h"
#include "mrs/database/entry/row_user_ownership.h"
#include "mrs/database/filter_object_generator.h"
#include "mrs/database/helper/object_row_ownership.h"
#include "mrs/database/helper/query.h"
#include "mrs/database/json_mapper/select.h"
#include "mrs/database/json_template.h"
 
namespace mrs {
namespace database {
 
class QueryRestTable : protected Query {
 public:
  using Object = entry::Object;
  using ObjectField = entry::ObjectField;
  using UserId = entry::AuthUser::UserId;
  using UniversalId = entry::UniversalId;
  using RowGroupOwnership = entry::RowGroupOwnership;
  using RowUserOwnership = entry::RowUserOwnership;
  using ObjectFieldFilter = dv::ObjectFieldFilter;
 
  using VectorOfRowGroupOwnershp = std::vector<RowGroupOwnership>;
 
  explicit QueryRestTable(const JsonTemplateFactory *factory = nullptr,
                          bool encode_bigints_as_strings = false,
                          bool include_links = true,
                          uint64_t max_execution_time_ms = 0);
  explicit QueryRestTable(bool encode_bigints_as_strings, bool include_links,
                          uint64_t max_execution_time_ms = 0);
 
 public:
  virtual void query_entries(
      MySQLSession *session, std::shared_ptr<database::entry::Object> object,
      const ObjectFieldFilter &field_filter, const uint64_t offset,
      const uint64_t limit, const std::string &url, const bool is_default_limit,
      const ObjectRowOwnership &row_ownership = {},
      const FilterObjectGenerator &fog = {}, const bool compute_etag = false);
 
  std::string response;
  uint64_t items{0};
 
 protected:
  struct Config {
    uint64_t offset;
    uint64_t limit;
    bool is_default_limit;
    std::string url_route;
  };
 
  Config config_;
  std::vector<helper::Column> columns_;
  std::shared_ptr<database::JsonTemplate> serializer_;
  std::shared_ptr<Object> object_;
  const ObjectFieldFilter *field_filter_{nullptr};
  bool compute_etag_{false};
  mysqlrouter::sqlstring where_;
  bool metadata_received_{false};
  const JsonTemplateFactory *factory_;
  bool encode_bigints_as_strings_;
  bool include_links_;
  uint64_t max_execution_time_ms_;
 
  void create_serializer();
  void on_row(const ResultRow &r) override;
  void on_metadata(unsigned number, MYSQL_FIELD *fields) override;
 
  const mysqlrouter::sqlstring &build_where(
      const ObjectRowOwnership &row_ownership);
 
  const mysqlrouter::sqlstring &build_where(
      const RowUserOwnership &row_user, UserId *user_id,
      const std::vector<RowGroupOwnership> &row_groups,
      const std::set<UniversalId> &user_groups);
 
  void build_query(const ObjectFieldFilter &field_filter, const uint64_t offset,
                   const uint64_t limit, const std::string &url,
                   const ObjectRowOwnership &row_ownership,
                   const FilterObjectGenerator &fog);
 
  void extend_where(mysqlrouter::sqlstring &where,
                    const FilterObjectGenerator &fog);
};
 
class QueryRestTableMedia : public QueryRestTable {
 public:
  using Column = entry::Column;
 
  explicit QueryRestTableMedia(uint64_t max_execution_time_ms = 0)
      : QueryRestTable(nullptr, false, false, max_execution_time_ms) {}
 
  void query_media_entries(MySQLSession *session,
                           std::shared_ptr<database::entry::Object> object,
                           const Column &column, const uint64_t offset,
                           const uint64_t limit,
                           const ObjectRowOwnership &row_ownership = {},
                           const FilterObjectGenerator &fog = {});
 
  void query_entry(MySQLSession *session,
                   std::shared_ptr<database::entry::Object> object,
                   const Column &column, const PrimaryKeyColumnValues &pk,
                   const ObjectRowOwnership &row_ownership = {},
                   const FilterObjectGenerator &fog = {});
 
  std::optional<std::string> media_response;
 
 private:
  void on_row(const ResultRow &r) override;
 
  void build_query(const Column &column, const uint64_t offset,
                   const uint64_t limit,
                   const ObjectRowOwnership &row_ownership,
                   const FilterObjectGenerator &fog);
 
  void build_query(const Column &column, const PrimaryKeyColumnValues &pk,
                   const ObjectRowOwnership &row_ownership,
                   const FilterObjectGenerator &fog);
};
 
}  // namespace database
}  // namespace mrs
 
#endif  // ROUTER_SRC_REST_MRS_SRC_MRS_DATABASE_REST_QUERY_H_