/*
    * Copyright 2004-2024 the original author or authors.
    *
    * Licensed under the Apache License, Version 2.0 (the "License");
    * you may not use this file except in compliance with the License.
    * You may obtain a copy of the License at
    *
    *    https://www.apache.org/licenses/LICENSE-2.0
    *
   * Unless required by applicable law or agreed to in writing, software
   * distributed under the License is distributed on an "AS IS" BASIS,
   * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
   * See the License for the specific language governing permissions and
   * limitations under the License.
   */
  package com.ibatis.sqlmap.engine.mapping.statement;
  
  import com.ibatis.common.io.ReaderInputStream;
  import com.ibatis.common.jdbc.exception.NestedSQLException;
  import com.ibatis.sqlmap.client.SqlMapClient;
  import com.ibatis.sqlmap.client.event.RowHandler;
  import com.ibatis.sqlmap.engine.cache.CacheKey;
  import com.ibatis.sqlmap.engine.execution.SqlExecutor;
  import com.ibatis.sqlmap.engine.impl.SqlMapClientImpl;
  import com.ibatis.sqlmap.engine.mapping.parameter.ParameterMap;
  import com.ibatis.sqlmap.engine.mapping.result.ResultMap;
  import com.ibatis.sqlmap.engine.mapping.sql.Sql;
  import com.ibatis.sqlmap.engine.scope.ErrorContext;
  import com.ibatis.sqlmap.engine.scope.StatementScope;
  import com.ibatis.sqlmap.engine.transaction.Transaction;
  import com.ibatis.sqlmap.engine.transaction.TransactionException;
  import com.ibatis.sqlmap.engine.type.DomTypeMarker;
  import com.ibatis.sqlmap.engine.type.XmlTypeMarker;
  
  import java.io.StringReader;
  import java.sql.Connection;
  import java.sql.SQLException;
  import java.util.ArrayList;
  import java.util.Arrays;
  import java.util.List;
  
  import javax.xml.XMLConstants;
  import javax.xml.parsers.DocumentBuilder;
  import javax.xml.parsers.DocumentBuilderFactory;
  
  import org.w3c.dom.Document;
  
  /**
   * The Class MappedStatement.
   */
  public class MappedStatement {
  
    /** The id. */
    private String id;
  
    /** The result set type. */
    private Integer resultSetType;
  
    /** The fetch size. */
    private Integer fetchSize;
  
    /** The result map. */
    private ResultMap resultMap;
  
    /** The parameter map. */
    private ParameterMap parameterMap;
  
    /** The parameter class. */
    private Class parameterClass;
  
    /** The sql. */
    private Sql sql;
  
    /** The base cache key. */
    private int baseCacheKey;
  
    /** The sql map client. */
    private SqlMapClientImpl sqlMapClient;
  
    /** The timeout. */
    private Integer timeout;
  
    /** The additional result maps. */
    private ResultMap[] additionalResultMaps = new ResultMap[0];
  
    /** The execute listeners. */
    private List executeListeners = new ArrayList();
  
    /** The resource. */
    private String resource;
  
    /**
     * Gets the statement type.
     *
     * @return the statement type
     */
    public StatementType getStatementType() {
      return StatementType.UNKNOWN;
    }
 
   /**
    * Execute update.
    *
    * @param statementScope
    *          the statement scope
    * @param trans
    *          the trans
    * @param parameterObject
    *          the parameter object
    *
    * @return the int
    *
    * @throws SQLException
    *           the SQL exception
    */
   public int executeUpdate(StatementScope statementScope, Transaction trans, Object parameterObject)
       throws SQLException {
     ErrorContext errorContext = statementScope.getErrorContext();
     errorContext.setActivity("preparing the mapped statement for execution");
     errorContext.setObjectId(this.getId());
     errorContext.setResource(this.getResource());
 
     statementScope.getSession().setCommitRequired(true);
 
     try {
       parameterObject = validateParameter(parameterObject);
 
       Sql sql = getSql();
 
       errorContext.setMoreInfo("Check the parameter map.");
       ParameterMap parameterMap = sql.getParameterMap(statementScope, parameterObject);
 
       errorContext.setMoreInfo("Check the result map.");
       ResultMap resultMap = sql.getResultMap(statementScope, parameterObject);
 
       statementScope.setResultMap(resultMap);
       statementScope.setParameterMap(parameterMap);
 
       int rows = 0;
 
       errorContext.setMoreInfo("Check the parameter map.");
       Object[] parameters = parameterMap.getParameterObjectValues(statementScope, parameterObject);
 
       errorContext.setMoreInfo("Check the SQL statement.");
       String sqlString = sql.getSql(statementScope, parameterObject);
 
       errorContext.setActivity("executing mapped statement");
       errorContext.setMoreInfo("Check the statement or the result map.");
       rows = sqlExecuteUpdate(statementScope, trans.getConnection(), sqlString, parameters);
 
       errorContext.setMoreInfo("Check the output parameters.");
       if (parameterObject != null) {
         postProcessParameterObject(statementScope, parameterObject, parameters);
       }
 
       errorContext.reset();
       sql.cleanup(statementScope);
       notifyListeners();
       return rows;
     } catch (SQLException e) {
       errorContext.setCause(e);
       throw new NestedSQLException(errorContext.toString(), e.getSQLState(), e.getErrorCode(), e);
     } catch (Exception e) {
       errorContext.setCause(e);
       throw new NestedSQLException(errorContext.toString(), e);
     }
   }
 
   /**
    * Execute query for object.
    *
    * @param statementScope
    *          the statement scope
    * @param trans
    *          the trans
    * @param parameterObject
    *          the parameter object
    * @param resultObject
    *          the result object
    *
    * @return the object
    *
    * @throws SQLException
    *           the SQL exception
    */
   public Object executeQueryForObject(StatementScope statementScope, Transaction trans, Object parameterObject,
       Object resultObject) throws SQLException {
     try {
       Object object = null;
 
       DefaultRowHandler rowHandler = new DefaultRowHandler();
       executeQueryWithCallback(statementScope, trans.getConnection(), parameterObject, resultObject, rowHandler,
           SqlExecutor.NO_SKIPPED_RESULTS, SqlExecutor.NO_MAXIMUM_RESULTS);
       List list = rowHandler.getList();
 
       if (list.size() > 1) {
         throw new SQLException("Error: executeQueryForObject returned too many results.");
       } else if (list.size() > 0) {
         object = list.get(0);
       }
 
       return object;
     } catch (TransactionException e) {
       throw new NestedSQLException("Error getting Connection from Transaction.  Cause: " + e, e);
     }
   }
 
   /**
    * Execute query for list.
    *
    * @param statementScope
    *          the statement scope
    * @param trans
    *          the trans
    * @param parameterObject
    *          the parameter object
    * @param skipResults
    *          the skip results
    * @param maxResults
    *          the max results
    *
    * @return the list
    *
    * @throws SQLException
    *           the SQL exception
    */
   public List executeQueryForList(StatementScope statementScope, Transaction trans, Object parameterObject,
       int skipResults, int maxResults) throws SQLException {
     try {
       DefaultRowHandler rowHandler = new DefaultRowHandler();
       executeQueryWithCallback(statementScope, trans.getConnection(), parameterObject, null, rowHandler, skipResults,
           maxResults);
       return rowHandler.getList();
     } catch (TransactionException e) {
       throw new NestedSQLException("Error getting Connection from Transaction.  Cause: " + e, e);
     }
   }
 
   /**
    * Execute query with row handler.
    *
    * @param statementScope
    *          the statement scope
    * @param trans
    *          the trans
    * @param parameterObject
    *          the parameter object
    * @param rowHandler
    *          the row handler
    *
    * @throws SQLException
    *           the SQL exception
    */
   public void executeQueryWithRowHandler(StatementScope statementScope, Transaction trans, Object parameterObject,
       RowHandler rowHandler) throws SQLException {
     try {
       executeQueryWithCallback(statementScope, trans.getConnection(), parameterObject, null, rowHandler,
           SqlExecutor.NO_SKIPPED_RESULTS, SqlExecutor.NO_MAXIMUM_RESULTS);
     } catch (TransactionException e) {
       throw new NestedSQLException("Error getting Connection from Transaction.  Cause: " + e, e);
     }
   }
 
   //
   // PROTECTED METHODS
   //
 
   /**
    * Execute query with callback.
    *
    * @param statementScope
    *          the statement scope
    * @param conn
    *          the conn
    * @param parameterObject
    *          the parameter object
    * @param resultObject
    *          the result object
    * @param rowHandler
    *          the row handler
    * @param skipResults
    *          the skip results
    * @param maxResults
    *          the max results
    *
    * @throws SQLException
    *           the SQL exception
    */
   protected void executeQueryWithCallback(StatementScope statementScope, Connection conn, Object parameterObject,
       Object resultObject, RowHandler rowHandler, int skipResults, int maxResults) throws SQLException {
     ErrorContext errorContext = statementScope.getErrorContext();
     errorContext.setActivity("preparing the mapped statement for execution");
     errorContext.setObjectId(this.getId());
     errorContext.setResource(this.getResource());
 
     try {
       parameterObject = validateParameter(parameterObject);
 
       Sql sql = getSql();
 
       errorContext.setMoreInfo("Check the parameter map.");
       ParameterMap parameterMap = sql.getParameterMap(statementScope, parameterObject);
 
       errorContext.setMoreInfo("Check the result map.");
       ResultMap resultMap = sql.getResultMap(statementScope, parameterObject);
 
       statementScope.setResultMap(resultMap);
       statementScope.setParameterMap(parameterMap);
 
       errorContext.setMoreInfo("Check the parameter map.");
       Object[] parameters = parameterMap.getParameterObjectValues(statementScope, parameterObject);
 
       errorContext.setMoreInfo("Check the SQL statement.");
       String sqlString = sql.getSql(statementScope, parameterObject);
 
       errorContext.setActivity("executing mapped statement");
       errorContext.setMoreInfo("Check the SQL statement or the result map.");
       RowHandlerCallback callback = new RowHandlerCallback(resultMap, resultObject, rowHandler);
       sqlExecuteQuery(statementScope, conn, sqlString, parameters, skipResults, maxResults, callback);
 
       errorContext.setMoreInfo("Check the output parameters.");
       if (parameterObject != null) {
         postProcessParameterObject(statementScope, parameterObject, parameters);
       }
 
       errorContext.reset();
       sql.cleanup(statementScope);
       notifyListeners();
     } catch (SQLException e) {
       errorContext.setCause(e);
       throw new NestedSQLException(errorContext.toString(), e.getSQLState(), e.getErrorCode(), e);
     } catch (Exception e) {
       errorContext.setCause(e);
       throw new NestedSQLException(errorContext.toString(), e);
     }
   }
 
   /**
    * Post process parameter object.
    *
    * @param statementScope
    *          the statement scope
    * @param parameterObject
    *          the parameter object
    * @param parameters
    *          the parameters
    */
   protected void postProcessParameterObject(StatementScope statementScope, Object parameterObject,
       Object[] parameters) {
   }
 
   /**
    * Sql execute update.
    *
    * @param statementScope
    *          the statement scope
    * @param conn
    *          the conn
    * @param sqlString
    *          the sql string
    * @param parameters
    *          the parameters
    *
    * @return the int
    *
    * @throws SQLException
    *           the SQL exception
    */
   protected int sqlExecuteUpdate(StatementScope statementScope, Connection conn, String sqlString, Object[] parameters)
       throws SQLException {
     if (statementScope.getSession().isInBatch()) {
       getSqlExecutor().addBatch(statementScope, conn, sqlString, parameters);
       return 0;
     } else {
       return getSqlExecutor().executeUpdate(statementScope, conn, sqlString, parameters);
     }
   }
 
   /**
    * Sql execute query.
    *
    * @param statementScope
    *          the statement scope
    * @param conn
    *          the conn
    * @param sqlString
    *          the sql string
    * @param parameters
    *          the parameters
    * @param skipResults
    *          the skip results
    * @param maxResults
    *          the max results
    * @param callback
    *          the callback
    *
    * @throws SQLException
    *           the SQL exception
    */
   protected void sqlExecuteQuery(StatementScope statementScope, Connection conn, String sqlString, Object[] parameters,
       int skipResults, int maxResults, RowHandlerCallback callback) throws SQLException {
     getSqlExecutor().executeQuery(statementScope, conn, sqlString, parameters, skipResults, maxResults, callback);
   }
 
   /**
    * Validate parameter.
    *
    * @param param
    *          the param
    *
    * @return the object
    *
    * @throws SQLException
    *           the SQL exception
    */
   protected Object validateParameter(Object param) throws SQLException {
     Object newParam = param;
     Class parameterClass = getParameterClass();
     if (newParam != null && parameterClass != null) {
       if (DomTypeMarker.class.isAssignableFrom(parameterClass)) {
         if (XmlTypeMarker.class.isAssignableFrom(parameterClass)) {
           if (!(newParam instanceof String) && !(newParam instanceof Document)) {
             throw new SQLException("Invalid parameter object type.  Expected '" + String.class.getName() + "' or '"
                 + Document.class.getName() + "' but found '" + newParam.getClass().getName() + "'.");
           }
           if (!(newParam instanceof Document)) {
             newParam = stringToDocument((String) newParam);
           }
         } else {
           if (!Document.class.isAssignableFrom(newParam.getClass())) {
             throw new SQLException("Invalid parameter object type.  Expected '" + Document.class.getName()
                 + "' but found '" + newParam.getClass().getName() + "'.");
           }
         }
       } else {
         if (!parameterClass.isAssignableFrom(newParam.getClass())) {
           throw new SQLException("Invalid parameter object type.  Expected '" + parameterClass.getName()
               + "' but found '" + newParam.getClass().getName() + "'.");
         }
       }
     }
     return newParam;
   }
 
   /**
    * String to document.
    *
    * @param s
    *          the s
    *
    * @return the document
    */
   private Document stringToDocument(String s) {
     try {
       DocumentBuilderFactory documentBuilderFactory = DocumentBuilderFactory.newInstance();
       documentBuilderFactory.setFeature(XMLConstants.FEATURE_SECURE_PROCESSING, true);
       documentBuilderFactory.setAttribute(XMLConstants.ACCESS_EXTERNAL_DTD, "");
       documentBuilderFactory.setAttribute(XMLConstants.ACCESS_EXTERNAL_SCHEMA, "");
       DocumentBuilder documentBuilder = documentBuilderFactory.newDocumentBuilder();
       return documentBuilder.parse(new ReaderInputStream(new StringReader(s)));
     } catch (Exception e) {
       throw new RuntimeException("Error occurred.  Cause: " + e, e);
     }
   }
 
   /**
    * Gets the id.
    *
    * @return the id
    */
   public String getId() {
     return id;
   }
 
   /**
    * Gets the result set type.
    *
    * @return the result set type
    */
   public Integer getResultSetType() {
     return resultSetType;
   }
 
   /**
    * Sets the result set type.
    *
    * @param resultSetType
    *          the new result set type
    */
   public void setResultSetType(Integer resultSetType) {
     this.resultSetType = resultSetType;
   }
 
   /**
    * Gets the fetch size.
    *
    * @return the fetch size
    */
   public Integer getFetchSize() {
     return fetchSize;
   }
 
   /**
    * Sets the fetch size.
    *
    * @param fetchSize
    *          the new fetch size
    */
   public void setFetchSize(Integer fetchSize) {
     this.fetchSize = fetchSize;
   }
 
   /**
    * Sets the id.
    *
    * @param id
    *          the new id
    */
   public void setId(String id) {
     this.id = id;
   }
 
   /**
    * Gets the sql.
    *
    * @return the sql
    */
   public Sql getSql() {
     return sql;
   }
 
   /**
    * Sets the sql.
    *
    * @param sql
    *          the new sql
    */
   public void setSql(Sql sql) {
     this.sql = sql;
   }
 
   /**
    * Gets the result map.
    *
    * @return the result map
    */
   public ResultMap getResultMap() {
     return resultMap;
   }
 
   /**
    * Sets the result map.
    *
    * @param resultMap
    *          the new result map
    */
   public void setResultMap(ResultMap resultMap) {
     this.resultMap = resultMap;
   }
 
   /**
    * Gets the parameter map.
    *
    * @return the parameter map
    */
   public ParameterMap getParameterMap() {
     return parameterMap;
   }
 
   /**
    * Sets the parameter map.
    *
    * @param parameterMap
    *          the new parameter map
    */
   public void setParameterMap(ParameterMap parameterMap) {
     this.parameterMap = parameterMap;
   }
 
   /**
    * Gets the parameter class.
    *
    * @return the parameter class
    */
   public Class getParameterClass() {
     return parameterClass;
   }
 
   /**
    * Sets the parameter class.
    *
    * @param parameterClass
    *          the new parameter class
    */
   public void setParameterClass(Class parameterClass) {
     this.parameterClass = parameterClass;
   }
 
   /**
    * Gets the resource.
    *
    * @return the resource
    */
   public String getResource() {
     return resource;
   }
 
   /**
    * Sets the resource.
    *
    * @param resource
    *          the new resource
    */
   public void setResource(String resource) {
     this.resource = resource;
   }
 
   /**
    * Gets the cache key.
    *
    * @param statementScope
    *          the statement scope
    * @param parameterObject
    *          the parameter object
    *
    * @return the cache key
    */
   public CacheKey getCacheKey(StatementScope statementScope, Object parameterObject) {
     Sql sql = statementScope.getSql();
     ParameterMap pmap = sql.getParameterMap(statementScope, parameterObject);
     CacheKey cacheKey = pmap.getCacheKey(statementScope, parameterObject);
     cacheKey.update(id);
 
     // I am not sure how any clustered cache solution would ever have had any cache hits against
     // replicated objects. I could not make it happen
     // The baseCacheKey value which was being used in the update below is consistent across
     // JVMInstances on the same machine
     // but it's not consistent across machines, and therefore breaks clustered caching.
 
     // What would happen is the cache values were being replicated across machines but there
     // were never any cache hits for cached objects on
     // anything but the original machine an object was created on.
 
     // After reviewing this implementation I could not figure out why baseCacheKey is used for
     // this anyway as it's not needed, so I removed it.
     // The values used from the pmap.getCacheKey, plus id, plus the params below are unique and
     // the same accross machines, so now I get replicated
     // cache hits when I force failover in my cluster
 
     // I wish I could make a unit test for this, but I can't do it as the old implementaion
     // works on 1 machine, but fails across machines.
     // cacheKey.update(baseCacheKey);
 
     cacheKey.update(sql.getSql(statementScope, parameterObject)); // Fixes bug 953001
     return cacheKey;
   }
 
   /**
    * Sets the base cache key.
    *
    * @param base
    *          the new base cache key
    */
   public void setBaseCacheKey(int base) {
     this.baseCacheKey = base;
   }
 
   /**
    * Adds the execute listener.
    *
    * @param listener
    *          the listener
    */
   public void addExecuteListener(ExecuteListener listener) {
     executeListeners.add(listener);
   }
 
   /**
    * Notify listeners.
    */
   public void notifyListeners() {
     for (int i = 0, n = executeListeners.size(); i < n; i++) {
       ((ExecuteListener) executeListeners.get(i)).onExecuteStatement(this);
     }
   }
 
   /**
    * Gets the sql executor.
    *
    * @return the sql executor
    */
   public SqlExecutor getSqlExecutor() {
     return sqlMapClient.getSqlExecutor();
   }
 
   /**
    * Gets the sql map client.
    *
    * @return the sql map client
    */
   public SqlMapClient getSqlMapClient() {
     return sqlMapClient;
   }
 
   /**
    * Sets the sql map client.
    *
    * @param sqlMapClient
    *          the new sql map client
    */
   public void setSqlMapClient(SqlMapClient sqlMapClient) {
     this.sqlMapClient = (SqlMapClientImpl) sqlMapClient;
   }
 
   /**
    * Inits the request.
    *
    * @param statementScope
    *          the statement scope
    */
   public void initRequest(StatementScope statementScope) {
     statementScope.setStatement(this);
     statementScope.setParameterMap(parameterMap);
     statementScope.setResultMap(resultMap);
     statementScope.setSql(sql);
   }
 
   /**
    * Gets the timeout.
    *
    * @return the timeout
    */
   public Integer getTimeout() {
     return timeout;
   }
 
   /**
    * Sets the timeout.
    *
    * @param timeout
    *          the new timeout
    */
   public void setTimeout(Integer timeout) {
     this.timeout = timeout;
   }
 
   /**
    * Adds the result map.
    *
    * @param resultMap
    *          the result map
    */
   public void addResultMap(ResultMap resultMap) {
     List resultMapList = Arrays.asList(additionalResultMaps);
     resultMapList = new ArrayList(resultMapList);
     resultMapList.add(resultMap);
     additionalResultMaps = (ResultMap[]) resultMapList.toArray(new ResultMap[resultMapList.size()]);
   }
 
   /**
    * Checks for multiple result maps.
    *
    * @return true, if successful
    */
   public boolean hasMultipleResultMaps() {
     return additionalResultMaps.length > 0;
   }
 
   /**
    * Gets the additional result maps.
    *
    * @return the additional result maps
    */
   public ResultMap[] getAdditionalResultMaps() {
     return additionalResultMaps;
   }
 }