/*
    * (c) Copyright 2006-2020 by rapiddweller GmbH & Volker Bergmann. All rights reserved.
    *
    * Redistribution and use in source and binary forms, with or without
    * modification, is permitted under the terms of the
    * GNU General Public License.
    *
    * For redistributing this software or a derivative work under a license other
    * than the GPL-compatible Free Software License as defined by the Free
   * Software Foundation or approved by OSI, you must first obtain a commercial
   * license to this software product from rapiddweller GmbH & Volker Bergmann.
   *
   * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
   * WITHOUT A WARRANTY OF ANY KIND. ALL EXPRESS OR IMPLIED CONDITIONS,
   * REPRESENTATIONS AND WARRANTIES, INCLUDING ANY IMPLIED WARRANTY OF
   * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE OR NON-INFRINGEMENT, ARE
   * HEREBY EXCLUDED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
   * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
   * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
   * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
   * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
   * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
   * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
   * POSSIBILITY OF SUCH DAMAGE.
   */
  
  package com.rapiddweller.benerator.engine;
  
  import com.rapiddweller.benerator.BeneratorFactory;
  import com.rapiddweller.benerator.consumer.FileExporter;
  import com.rapiddweller.benerator.engine.parser.xml.BeneratorParseContext;
  import com.rapiddweller.common.ExceptionUtil;
  import com.rapiddweller.common.IOUtil;
  import com.rapiddweller.common.RoundedNumberFormat;
  import com.rapiddweller.common.converter.ConverterManager;
  import com.rapiddweller.common.time.ElapsedTimeFormatter;
  import com.rapiddweller.common.xml.XMLUtil;
  import com.rapiddweller.profile.Profiler;
  import com.rapiddweller.profile.Profiling;
  import org.apache.logging.log4j.LogManager;
  import org.apache.logging.log4j.Logger;
  import org.w3c.dom.Document;
  import org.w3c.dom.Element;
  
  import java.io.Closeable;
  import java.io.IOException;
  import java.util.ArrayList;
  import java.util.List;
  
  /**
   * Parses and executes a benerator descriptor file.<br/>
   * <br/>
   * Created at 26.02.2009 15:51:59
   *
   * @author Volker Bergmann
   * @since 0.5.8
   */
  public class DescriptorRunner implements ResourceManager {
  
    /**
     * The constant LOCALE_VM_PARAM.
     */
    public static final String LOCALE_VM_PARAM = "benerator.locale";
  
    private static final Logger LOGGER = LogManager.getLogger(DescriptorRunner.class);
  
    // attributes ------------------------------------------------------------------------------------------------------
  
    private final String uri;
  
    private final BeneratorContext context;
  
    /**
     * The Factory.
     */
    final BeneratorFactory factory;
    private List<String> generatedFiles;
  
    private final ResourceManagerSupportort.html#ResourceManagerSupport">ResourceManagerSupport resourceManager = new ResourceManagerSupport();
    /**
     * The Start time.
     */
    long startTime = 0;
  
  
    // constructor -----------------------------------------------------------------------------------------------------
  
    /**
     * Instantiates a new Descriptor runner.
     *
     * @param uri     the uri
     * @param context the context
     */
    public DescriptorRunner(String uri, BeneratorContext context) {
      this.uri = uri;
      this.context = context;
      this.factory = BeneratorFactory.getInstance();
      this.generatedFiles = new ArrayList<>();
      ConverterManager.getInstance().setContext(context);
   }
 
   /**
    * Reset monitor.
    */
   public static void resetMonitor() {
     BeneratorMonitor.INSTANCE.reset();
   }
 
   // interface -------------------------------------------------------------------------------------------------------
 
   /**
    * Gets context.
    *
    * @return the context
    */
   public BeneratorContext getContext() {
     return context;
   }
 
   /**
    * Run.
    *
    * @throws IOException the io exception
    */
   public void run() throws IOException {
     Runtime runtime = Runtime.getRuntime();
     BeneratorShutdownHookorShutdownHook.html#BeneratorShutdownHook">BeneratorShutdownHook hook = new BeneratorShutdownHook(this);
     runtime.addShutdownHook(hook);
     try {
       runWithoutShutdownHook();
     } finally {
       runtime.removeShutdownHook(hook);
     }
   }
 
   /**
    * Run without shutdown hook.
    *
    * @throws IOException the io exception
    */
   public void runWithoutShutdownHook() throws IOException {
     execute(parseDescriptorFile());
   }
 
   /**
    * Parse descriptor file benerator root statement.
    *
    * @return the benerator root statement
    * @throws IOException the io exception
    */
   public BeneratorRootStatement parseDescriptorFile() throws IOException {
     Document document = XMLUtil.parse(uri);
     Element root = document.getDocumentElement();
     BeneratorParseContext parsingContext = factory.createParseContext(resourceManager);
     BeneratorRootStatementiddweller/benerator/engine/BeneratorRootStatement.html#BeneratorRootStatement">BeneratorRootStatement statement = (BeneratorRootStatement) parsingContext.parseElement(root, null);
     // prepare system
     generatedFiles = new ArrayList<>();
     context.setContextUri(IOUtil.getParentUri(uri));
     return statement;
   }
 
   /**
    * Execute.
    *
    * @param rootStatement the root statement
    */
   public void execute(BeneratorRootStatement rootStatement) {
     try {
       startTime = System.currentTimeMillis();
       // run AST
       rootStatement.execute(context);
       // calculate and print statistics
       long elapsedTime = java.lang.System.currentTimeMillis() - startTime;
       printStats(elapsedTime);
       if (Profiling.isEnabled()) {
         Profiler.defaultInstance().printSummary();
       }
       List<String> generations = getGeneratedFiles();
       if (generations.size() > 0) {
         LOGGER.info("Generated file(s): " + generations);
       }
     } catch (Throwable t) {
       if (ExceptionUtil.containsException(OutOfMemoryError.class, t) && Profiling.isEnabled()) {
         LOGGER.error("OutOfMemoryError! This probably happened because you activated profiling", t);
       } else {
         LOGGER.error("Error in Benerator execution", t);
       }
     } finally {
       context.close();
     }
   }
 
   /**
    * Gets generated files.
    *
    * @return the generated files
    */
   public List<String> getGeneratedFiles() {
     return generatedFiles;
   }
 
 
   // ResourceManager interface implementation ------------------------------------------------------------------------
 
   @Override
   public boolean addResource(Closeable resource) {
     if (!resourceManager.addResource(resource)) {
       return false;
     } else if (resource instanceof FileExporter) {
       generatedFiles.add(((FileExporter) resource).getUri());
     }
     return true;
   }
 
   @Override
   public void close() {
     resourceManager.close();
   }
 
 
   // private helpers -------------------------------------------------------------------------------------------------
 
   private static void printStats(long elapsedTime) {
     String message = "Created a total of " + BeneratorMonitor.INSTANCE.getTotalGenerationCount() + " entities";
     if (elapsedTime != 0) {
       long throughput = BeneratorMonitor.INSTANCE.getTotalGenerationCount() * 3600000L / elapsedTime;
       message += " in " + ElapsedTimeFormatter.format(elapsedTime) + " (~" + RoundedNumberFormat.format(throughput, 0) + " p.h.)";
     }
     LOGGER.info(message);
   }
 
 
   // java.lang.Object overrides --------------------------------------------------------------------------------------
 
   @Override
   public String toString() {
     return getClass().getSimpleName();
   }
 
 }