/*
    * Licensed to the Apache Software Foundation (ASF) under one or more
    * contributor license agreements.  See the NOTICE file distributed with
    * this work for additional information regarding copyright ownership.
    * The ASF licenses this file to You 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
    *
    *     http://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 org.apache.shardingsphere.infra.executor.sql.execute.engine.driver.jdbc;
  
  import lombok.RequiredArgsConstructor;
  import org.apache.shardingsphere.infra.annotation.HighFrequencyInvocation;
  import org.apache.shardingsphere.infra.database.core.connector.ConnectionProperties;
  import org.apache.shardingsphere.infra.database.core.type.DatabaseType;
  import org.apache.shardingsphere.infra.executor.kernel.model.ExecutorCallback;
  import org.apache.shardingsphere.infra.executor.sql.context.SQLUnit;
  import org.apache.shardingsphere.infra.executor.sql.execute.engine.ConnectionMode;
  import org.apache.shardingsphere.infra.executor.sql.execute.engine.SQLExecutorExceptionHandler;
  import org.apache.shardingsphere.infra.executor.sql.hook.SPISQLExecutionHook;
  import org.apache.shardingsphere.infra.executor.sql.hook.SQLExecutionHook;
  import org.apache.shardingsphere.infra.executor.sql.process.ProcessEngine;
  import org.apache.shardingsphere.infra.metadata.database.resource.ResourceMetaData;
  import org.apache.shardingsphere.sql.parser.sql.common.statement.SQLStatement;
  
  import java.sql.SQLException;
  import java.sql.Statement;
  import java.util.Collection;
  import java.util.LinkedList;
  import java.util.Optional;
  
  /**
   * JDBC executor callback.
   *
   * @param <T> class type of return value
   */
  @HighFrequencyInvocation
  @RequiredArgsConstructor
  public abstract class JDBCExecutorCallback<T> implements ExecutorCallback<JDBCExecutionUnit, T> {
      
      private final DatabaseType protocolType;
      
      private final ResourceMetaData resourceMetaData;
      
      private final SQLStatement sqlStatement;
      
      private final boolean isExceptionThrown;
      
      private final ProcessEngine processEngine = new ProcessEngine();
      
      @Override
      public final Collection<T> execute(final Collection<JDBCExecutionUnit> executionUnits, final boolean isTrunkThread, final String processId) throws SQLException {
          // TODO It is better to judge whether need sane result before execute, can avoid exception thrown
          Collection<T> result = new LinkedList<>();
          for (JDBCExecutionUnit each : executionUnits) {
              T executeResult = execute(each, isTrunkThread, processId);
              if (null != executeResult) {
                  result.add(executeResult);
              }
          }
          return result;
      }
      
      /*
       * To make sure SkyWalking will be available at the next release of ShardingSphere, a new plugin should be provided to SkyWalking project if this API changed.
       *
       * @see <a href="https://github.com/apache/skywalking/blob/master/docs/en/guides/Java-Plugin-Development-Guide.md#user-content-plugin-development-guide">Plugin Development Guide</a>
       */
      private T execute(final JDBCExecutionUnit jdbcExecutionUnit, final boolean isTrunkThread, final String processId) throws SQLException {
          SQLExecutorExceptionHandler.setExceptionThrown(isExceptionThrown);
          DatabaseType storageType = resourceMetaData.getStorageUnits().get(jdbcExecutionUnit.getExecutionUnit().getDataSourceName()).getStorageType();
          ConnectionProperties connectionProps = resourceMetaData.getStorageUnits().get(jdbcExecutionUnit.getExecutionUnit().getDataSourceName()).getConnectionProperties();
          SQLExecutionHook sqlExecutionHook = new SPISQLExecutionHook();
          try {
              SQLUnit sqlUnit = jdbcExecutionUnit.getExecutionUnit().getSqlUnit();
              sqlExecutionHook.start(jdbcExecutionUnit.getExecutionUnit().getDataSourceName(), sqlUnit.getSql(), sqlUnit.getParameters(), connectionProps, isTrunkThread);
              T result = executeSQL(sqlUnit.getSql(), jdbcExecutionUnit.getStorageResource(), jdbcExecutionUnit.getConnectionMode(), storageType);
              sqlExecutionHook.finishSuccess();
              processEngine.completeSQLUnitExecution(jdbcExecutionUnit, processId);
              return result;
          } catch (final SQLException ex) {
              if (!storageType.equals(protocolType)) {
                  Optional<T> saneResult = getSaneResult(sqlStatement, ex);
                  if (saneResult.isPresent()) {
                      return isTrunkThread ? saneResult.get() : null;
                  }
              }
              sqlExecutionHook.finishFailure(ex);
              SQLExecutorExceptionHandler.handleException(ex);
              return null;
          }
     }
     
     protected abstract T executeSQL(String sql, Statement statement, ConnectionMode connectionMode, DatabaseType storageType) throws SQLException;
     
     protected abstract Optional<T> getSaneResult(SQLStatement sqlStatement, SQLException ex);
 }