/* Copyright (c) 2016, 2025, 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 */

#include "sql/dd/impl/types/parameter_impl.h"

#include <assert.h>
#include <stddef.h>
#include <set>
#include <sstream>
#include <string>

#include "my_inttypes.h"
#include "my_sys.h"
#include "mysqld_error.h"
#include "sql/dd/impl/properties_impl.h"                 // Properties_impl
#include "sql/dd/impl/raw/raw_record.h"                  // Raw_record
#include "sql/dd/impl/tables/parameter_type_elements.h"  // Parameter_type_elements
#include "sql/dd/impl/tables/parameters.h"               // Parameters
#include "sql/dd/impl/transaction_impl.h"  // Open_dictionary_tables_ctx
#include "sql/dd/impl/types/parameter_type_element_impl.h"  // Parameter_type_element_impl
#include "sql/dd/impl/types/routine_impl.h"                 // Routine_impl
#include "sql/dd/string_type.h"                             // dd::String_type
#include "sql/dd/types/object_table.h"
#include "sql/dd/types/parameter_type_element.h"
#include "sql/dd/types/weak_object.h"

using dd::tables::Parameter_type_elements;
using dd::tables::Parameters;

namespace dd {

static const std::set<String_type> default_valid_option_keys = {"geom_type"};

///////////////////////////////////////////////////////////////////////////
// Parameter_impl implementation.
///////////////////////////////////////////////////////////////////////////

Parameter_impl::Parameter_impl()
    : m_is_name_null(false),
      m_parameter_mode(PM_IN),
      m_parameter_mode_null(false),
      m_data_type(enum_column_types::LONG),
      m_is_zerofill(false),
      m_is_unsigned(false),
      m_ordinal_position(0),
      m_char_length(0),
      m_numeric_precision(0),
      m_numeric_precision_null(true),
      m_numeric_scale(0),
      m_numeric_scale_null(true),
      m_datetime_precision(0),
      m_datetime_precision_null(true),
      m_elements(),
      m_options(default_valid_option_keys),
      m_routine(nullptr),
      m_collation_id(INVALID_OBJECT_ID) {}

Parameter_impl::Parameter_impl(Routine_impl *routine)
    : m_is_name_null(false),
      m_parameter_mode(PM_IN),
      m_parameter_mode_null(false),
      m_data_type(enum_column_types::LONG),
      m_is_zerofill(false),
      m_is_unsigned(false),
      m_ordinal_position(0),
      m_char_length(0),
      m_numeric_precision(0),
      m_numeric_precision_null(true),
      m_numeric_scale(0),
      m_numeric_scale_null(true),
      m_datetime_precision(0),
      m_datetime_precision_null(true),
      m_elements(),
      m_options(default_valid_option_keys),
      m_routine(routine),
      m_collation_id(INVALID_OBJECT_ID) {}

///////////////////////////////////////////////////////////////////////////

/* purecov: begin deadcode */
const Routine &Parameter_impl::routine() const { return *m_routine; }

Routine &Parameter_impl::routine() { return *m_routine; }
/* purecov: end */

///////////////////////////////////////////////////////////////////////////

bool Parameter_impl::validate() const {
  if (!m_routine) {
    my_error(ER_INVALID_DD_OBJECT, MYF(0), DD_table::instance().name().c_str(),
             "Parameter does not belong to any routine.");
    return true;
  }

  if (m_collation_id == INVALID_OBJECT_ID) {
    my_error(ER_INVALID_DD_OBJECT, MYF(0), DD_table::instance().name().c_str(),
             "Collation ID is not set");
    return true;
  }

  return false;
}

///////////////////////////////////////////////////////////////////////////

bool Parameter_impl::restore_children(Open_dictionary_tables_ctx *otx) {
  switch (data_type()) {
    case enum_column_types::ENUM:
    case enum_column_types::SET:
      return m_elements.restore_items(
          this, otx, otx->get_table<Parameter_type_element>(),
          Parameter_type_elements::create_key_by_parameter_id(this->id()));

    default:
      return false;
  }

  return false;
}

///////////////////////////////////////////////////////////////////////////

bool Parameter_impl::store_children(Open_dictionary_tables_ctx *otx) {
  return m_elements.store_items(otx);
}

///////////////////////////////////////////////////////////////////////////

bool Parameter_impl::drop_children(Open_dictionary_tables_ctx *otx) const {
  if (data_type() == enum_column_types::ENUM ||
      data_type() == enum_column_types::SET)
    return m_elements.drop_items(
        otx, otx->get_table<Parameter_type_element>(),
        Parameter_type_elements::create_key_by_parameter_id(this->id()));

  return false;
}

///////////////////////////////////////////////////////////////////////////

bool Parameter_impl::restore_attributes(const Raw_record &r) {
  check_parent_consistency(m_routine,
                           r.read_ref_id(Parameters::FIELD_ROUTINE_ID));

  restore_id(r, Parameters::FIELD_ID);
  restore_name(r, Parameters::FIELD_NAME);
  m_is_name_null = r.is_null(Parameters::FIELD_NAME);

  m_data_type_utf8 = r.read_str(Parameters::FIELD_DATA_TYPE_UTF8);
  m_is_zerofill = r.read_bool(Parameters::FIELD_IS_ZEROFILL);
  m_is_unsigned = r.read_bool(Parameters::FIELD_IS_UNSIGNED);

  m_parameter_mode = (enum_parameter_mode)r.read_int(Parameters::FIELD_MODE);
  m_parameter_mode_null = r.is_null(Parameters::FIELD_MODE);

  m_data_type = (enum_column_types)r.read_int(Parameters::FIELD_DATA_TYPE);

  m_ordinal_position = r.read_uint(Parameters::FIELD_ORDINAL_POSITION);
  m_char_length = r.read_uint(Parameters::FIELD_CHAR_LENGTH);
  m_numeric_precision = r.read_uint(Parameters::FIELD_NUMERIC_PRECISION);
  m_numeric_precision_null = r.is_null(Parameters::FIELD_NUMERIC_PRECISION);
  m_numeric_scale = r.read_uint(Parameters::FIELD_NUMERIC_SCALE);
  m_numeric_scale_null = r.is_null(Parameters::FIELD_NUMERIC_SCALE);
  m_datetime_precision = r.read_uint(Parameters::FIELD_DATETIME_PRECISION);
  m_datetime_precision_null = r.is_null(Parameters::FIELD_DATETIME_PRECISION);

  m_collation_id = r.read_ref_id(Parameters::FIELD_COLLATION_ID);

  set_options(r.read_str(Parameters::FIELD_OPTIONS, ""));

  return false;
}

///////////////////////////////////////////////////////////////////////////

bool Parameter_impl::store_attributes(Raw_record *r) {
  return store_id(r, Parameters::FIELD_ID) ||
         store_name(r, Parameters::FIELD_NAME, m_is_name_null) ||
         r->store(Parameters::FIELD_ROUTINE_ID, m_routine->id()) ||
         r->store(Parameters::FIELD_ORDINAL_POSITION, m_ordinal_position) ||
         r->store(Parameters::FIELD_DATA_TYPE_UTF8, m_data_type_utf8) ||
         r->store(Parameters::FIELD_MODE, m_parameter_mode,
                  m_parameter_mode_null) ||
         r->store(Parameters::FIELD_DATA_TYPE, static_cast<int>(m_data_type)) ||
         r->store(Parameters::FIELD_IS_ZEROFILL, m_is_zerofill) ||
         r->store(Parameters::FIELD_IS_UNSIGNED, m_is_unsigned) ||
         r->store(Parameters::FIELD_CHAR_LENGTH,
                  static_cast<uint>(m_char_length)) ||
         r->store(Parameters::FIELD_NUMERIC_PRECISION, m_numeric_precision,
                  m_numeric_precision_null) ||
         r->store(Parameters::FIELD_NUMERIC_SCALE, m_numeric_scale,
                  m_numeric_scale_null) ||
         r->store(Parameters::FIELD_DATETIME_PRECISION, m_datetime_precision,
                  m_datetime_precision_null) ||
         r->store_ref_id(Parameters::FIELD_COLLATION_ID, m_collation_id) ||
         r->store(Parameters::FIELD_OPTIONS, m_options);
}

///////////////////////////////////////////////////////////////////////////

void Parameter_impl::debug_print(String_type &outb) const {
  dd::Stringstream_type ss;
  ss << "PARAMETER OBJECT: { "
     << "m_id: {OID: " << id() << "}; "
     << "m_routine_id: {OID: " << m_routine->id() << "}; "
     << "m_name: " << name() << "; "
     << "m_is_name_null: " << m_is_name_null << "; "
     << "m_ordinal_position: " << m_ordinal_position << "; "
     << "m_parameter_mode: " << m_parameter_mode << "; "
     << "m_parameter_mode_null: " << m_parameter_mode_null << "; "
     << "m_data_type: " << static_cast<int>(m_data_type) << "; "
     << "m_data_type_utf8: " << m_data_type_utf8 << "; "
     << "m_is_zerofill: " << m_is_zerofill << "; "
     << "m_is_unsigned: " << m_is_unsigned << "; "
     << "m_char_length: " << m_char_length << "; "
     << "m_numeric_precision: " << m_numeric_precision << "; "
     << "m_numeric_precision_null: " << m_numeric_precision_null << "; "
     << "m_numeric_scale: " << m_numeric_scale << "; "
     << "m_numeric_scale_null: " << m_numeric_scale_null << "; "
     << "m_datetime_precision: " << m_datetime_precision << "; "
     << "m_datetime_precision_null: " << m_datetime_precision_null << "; "
     << "m_collation_id: {OID: " << m_collation_id << "}; "
     << "m_options: " << m_options.raw_string() << "; ";

  if (data_type() == enum_column_types::ENUM ||
      data_type() == enum_column_types::SET) {
    /* purecov: begin inspected */
    ss << "m_elements: [ ";

    for (const Parameter_type_element *e : elements()) {
      String_type ob;
      e->debug_print(ob);
      ss << ob;
    }

    ss << " ]";
    /* purecov: end */
  }

  outb = ss.str();
}

///////////////////////////////////////////////////////////////////////////
// Enum-elements.
///////////////////////////////////////////////////////////////////////////

Parameter_type_element *Parameter_impl::add_element() {
  assert(data_type() == enum_column_types::ENUM ||
         data_type() == enum_column_types::SET);

  Parameter_type_element_impl *e =
      new (std::nothrow) Parameter_type_element_impl(this);
  m_elements.push_back(e);
  return e;
}

///////////////////////////////////////////////////////////////////////////

Parameter_impl::Parameter_impl(const Parameter_impl &src, Routine_impl *parent)
    : Weak_object(src),
      Entity_object_impl(src),
      m_is_name_null(src.m_is_name_null),
      m_parameter_mode(src.m_parameter_mode),
      m_parameter_mode_null(src.m_parameter_mode_null),
      m_data_type(src.m_data_type),
      m_data_type_utf8(src.m_data_type_utf8),
      m_is_zerofill(src.m_is_zerofill),
      m_is_unsigned(src.m_is_unsigned),
      m_ordinal_position(src.m_ordinal_position),
      m_char_length(src.m_char_length),
      m_numeric_precision(src.m_numeric_precision),
      m_numeric_precision_null(src.m_numeric_precision_null),
      m_numeric_scale(src.m_numeric_scale),
      m_numeric_scale_null(src.m_numeric_scale_null),
      m_datetime_precision(src.m_datetime_precision),
      m_datetime_precision_null(src.m_datetime_precision_null),
      m_elements(),
      m_options(src.m_options),
      m_routine(parent),
      m_collation_id(src.m_collation_id) {
  m_elements.deep_copy(src.m_elements, this);
}

///////////////////////////////////////////////////////////////////////////

const Object_table &Parameter_impl::object_table() const {
  return DD_table::instance();
}

///////////////////////////////////////////////////////////////////////////

void Parameter_impl::register_tables(Open_dictionary_tables_ctx *otx) {
  otx->add_table<Parameters>();

  otx->register_tables<Parameter_type_element>();
}

///////////////////////////////////////////////////////////////////////////

}  // namespace dd
