/*
 * Copyright (c) 2017, 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, version 2.0, 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 MODULES_UTIL_UPGRADE_CHECKER_SQL_UPGRADE_CHECK_H_
#define MODULES_UTIL_UPGRADE_CHECKER_SQL_UPGRADE_CHECK_H_

#include <forward_list>
#include <memory>
#include <string>
#include <string_view>
#include <vector>

#include "modules/util/upgrade_checker/common.h"
#include "modules/util/upgrade_checker/upgrade_check.h"
#include "mysqlshdk/libs/db/row.h"

namespace mysqlsh {
namespace upgrade_checker {
// Check_query represents a query used in the upgrade checker to identify issues
// of the associated object type
using Check_query = std::pair<std::string, Upgrade_issue::Object_type>;

class Sql_upgrade_check : public Upgrade_check {
 public:
  Sql_upgrade_check(const std::string_view name, Category category,
                    std::vector<Check_query> &&queries,
                    Upgrade_issue::Level level = Upgrade_issue::WARNING,
                    const char *minimal_version = nullptr,
                    bool filter_out_objects_with_error = false,
                    std::forward_list<std::string> &&set_up =
                        std::forward_list<std::string>(),
                    std::forward_list<std::string> &&clean_up =
                        std::forward_list<std::string>());

  std::vector<Upgrade_issue> run(const Check_context &context) override;

  const std::vector<Check_query> &get_queries() const { return m_queries; }

 protected:
  virtual Upgrade_issue parse_row(const std::vector<std::string> &field_names,
                                  const mysqlshdk::db::IRow *row,
                                  Upgrade_issue::Object_type object_type);
  virtual void add_issue(const std::vector<std::string> &field_names,
                         const mysqlshdk::db::IRow *row,
                         Upgrade_issue::Object_type object_type,
                         std::vector<Upgrade_issue> *issues);
  Upgrade_issue::Level get_level() const { return m_level; }
  Token_definitions base_tokens() const override { return m_base_tokens; }
  std::vector<Check_query> m_queries;
  std::forward_list<std::string> m_set_up;
  std::forward_list<std::string> m_clean_up;
  const Upgrade_issue::Level m_level;
  const char *m_minimal_version;
  bool m_filter_out_objects_with_error = false;
  mysqlshdk::db::Filtering_options *m_db_filters = nullptr;
  std::mutex m_db_filters_mutex;
  // By default, the target_version is the shell version
  Token_definitions m_base_tokens = {{"target_version", MYSH_VERSION}};
};

}  // namespace upgrade_checker
}  // namespace mysqlsh

#endif  // MODULES_UTIL_UPGRADE_CHECKER_SQL_UPGRADE_CHECK_H_