MySQL.Data/src/X/XDevAPI/Common/BaseStatement.cs

// Copyright © 2015, 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.
//
// Without limiting anything contained in the foregoing, this file,
// which is part of MySQL Connector/NET, is also subject to the
// Universal FOSS Exception, version 1.0, a copy of which can be found at
// http://oss.oracle.com/licenses/universal-foss-exception.
//
// 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

using MySql.Data;
using MySql.Data.MySqlClient;
using MySqlX.XDevAPI.Relational;
using System;
using System.Collections;
using System.Threading;
using System.Threading.Tasks;

namespace MySqlX.XDevAPI.Common
{
  /// <summary>
  /// Base abstract class for API statement.
  /// </summary>
  /// <typeparam name="TResult"></typeparam>
  /// <typeparam name="TType"></typeparam>
  public abstract class BaseStatement<TResult, TType> where TResult : BaseResult
  {
    // Prepared statements flags
    internal bool _hasChanged, _isPrepared;
    protected int _stmtId;

    /// <summary>
    /// Initializes a new instance of the BaseStatement class based on the specified session.
    /// </summary>
    /// <param name="session">The session where the statement will be executed.</param>
    public BaseStatement(BaseSession session)
    {
      Session = session;
      _hasChanged = true;
    }

    /// <summary>
    /// Gets the <see cref="Session"/> that owns the statement.
    /// </summary>
    public BaseSession Session { get; private set; }

    /// <summary>
    /// Executes the base statements. This method is intended to be defined by child classes.
    /// </summary>
    /// <returns>A result object containing the details of the execution.</returns>
    public abstract TResult Execute();

    /// <summary>
    /// Executes a statement asynchronously.
    /// </summary>
    /// <returns>A result object containing the details of the execution.</returns>
    public async Task<TResult> ExecuteAsync()
    {
      return await Task.Factory.StartNew<TResult>(() =>
      {
        var result = Execute();
        if (result is BufferingResult<TType>)
        {
          (result as BufferingResult<TType>).FetchAll();
        }
        else if (result is BufferingResult<Row>)
        {
          (result as BufferingResult<Row>).FetchAll();
        }
        return result;
      },
        CancellationToken.None,
        TaskCreationOptions.None,
        Session._scheduler).ConfigureAwait(false);
    }

    /// <summary>
    /// Validates if the session is open and valid.
    /// </summary>
    protected void ValidateOpenSession()
    {
      if (Session.XSession.SessionState != SessionState.Open)
        throw new MySqlException(ResourcesX.InvalidSession);
    }

    /// <summary>
    /// Sets the status as Changed for prepared statement validation.
    /// </summary>
    protected void SetChanged()
    {
      _hasChanged = true;
    }

    /// <summary>
    /// Converts a statement to prepared statement for a second execution 
    /// without any change but Bind, Limit, or Offset.
    /// </summary>
    protected virtual TResult ConvertToPreparedStatement<T>(Func<T, TResult> executeFunc, T t, IEnumerable args)
    //where T : FilterableStatement<T, DatabaseObject, TResult>
    {
      if (!Session.SupportsPreparedStatements)
      {
        // Normal execution
        return executeFunc(t);
      }

      if (_hasChanged)
      {
        if (_isPrepared)
        {
          // Deallocate prepared statement
          Session.XSession.DeallocatePreparedStatement(_stmtId);
          _isPrepared = false;
        }
        // Normal execution
        return executeFunc(t);
      }
      else
      {
        if (!_isPrepared)
        {
          // Create prepared statement
          try
          {
            _stmtId = Session.XSession.PrepareStatement<TResult, TType>(this);
            _isPrepared = true;
          }
          catch (MySqlException ex)
            when (ex.Code == 1461 // Can't create more than max_prepared_stmt_count statements
              || ex.Code == 1047) // Unexpected message received
          {
            // Set prepared statements not supported to avoid trying it 
            // on following executions.
            Session.SupportsPreparedStatements = false;
            _isPrepared = false;
            // Normal execution
            return executeFunc(t);
          }
        }
        // Execute prepared statement
        return Session.XSession.ExecutePreparedStatement<TResult, TType>(_stmtId, args);
      }
    }
  }
}