/**
    * Copyright 2005-2006 the original author or authors.
    *
    * Licensed under the Gnu General Pubic 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.opensource.org/licenses/gpl-license.php
    *
   * 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 for more details.
   */
  package org.figure8.join.services.scripting.ruby;
  
  import org.figure8.join.core.ParameterDefinition;
  import org.figure8.join.core.InvalidParameterException;
  import org.figure8.join.services.scripting.ScriptLauncher;
  import org.figure8.join.services.scripting.ScriptException;
  import org.figure8.join.util.LogUtil;
  
  import org.apache.commons.logging.Log;
  //import org.jruby.IRuby;
  //import org.jruby.runtime.load.LoadService;
  //import org.jruby.javasupport.JavaEmbedUtils;
  
  import java.util.List;
  import java.util.Iterator;
  import java.util.ArrayList;
  import java.util.Properties;
  /**
   * @author <a href="mailto:laurent.broudoux@free.fr">Laurent Broudoux</a>
   * @version $Revision$
   */
  public class RubyScriptLauncher extends ScriptLauncher{
  
     // Static -------------------------------------------------------------------
  
     /** Get a commons logger. */
     private static final Log log = LogUtil.getLog(RubyScriptLauncher.class);
  
     /** Name of configurable parameter denoting the path to Ruby libraries */
     public static final String LIBRARY_PATH_PARAM = "libraryPath";
  
     /** List of {@link org.figure8.join.core.ParameterDefinition}s supported by this launcher */
     protected static List parameters = new ArrayList();
  
     /** ParameterDefinition representation of parameter denoting the target to execute. */
     protected static final ParameterDefinition targetParam = new ParameterDefinition(LIBRARY_PATH_PARAM,
             "A ; separated list of Ruby library paths that should be loaded before running script",
             "c:/ruby/lib/mylib.rb;c:/myproject/lib/mylib2.rb", false);
  
  
     // Attributes ---------------------------------------------------------------
  
     /** The path of Ruby libraries to load */
     private String libraryPath = null;
  
  
     // Constructors -------------------------------------------------------------
  
     /** Creates a new instance of RubyScriptLauncher */
     public RubyScriptLauncher(){
     }
  
     /**
      * Creates a new instance of RubyScriptLauncher with script path
      * @param scriptPath the path of script to later execute
      * @throws InvalidParameterException if path cannot be accessed
      */
     public RubyScriptLauncher(String scriptPath) throws InvalidParameterException{
        super(scriptPath);
     }
  
  
     // Public -------------------------------------------------------------------
  
     /** @return The path of Ruby libraries to load */
     public String getLibraryPath(){
        return libraryPath;
     }
     /** @param libraryPath The path of Ruby libraries to load */
     public void setLibraryPath(String libraryPath){
        this.libraryPath = libraryPath;
     }
  
  
     // Implementation of ScriptLauncher -----------------------------------------
     
     /**
      * Run the Ruby script file identified by <code>scriptPath</code> inner
      * field. Properties passed as param are injected into the Ruby runtime
      * as arguments. Script can directly use them using the $property
      * form.
      * @param properties The runtime properties to inject into execution environment
      * @throws ScriptException if something wrong occurs during script parsing, evaluation, ...
      */
     public void runScript(Properties properties) throws ScriptException{
       try{
          // Set user defined properties
          Iterator keys = properties.keySet().iterator();
          while (keys != null && keys.hasNext()){
             String key = (String)keys.next();
             String value = properties.getProperty(key);
          }
       }
       catch (Throwable t){
 
       }
       finally{
          // Output stream may still be open.
          if (getLogOutputStream() != null){
             try {getLogOutputStream().close();}
             catch (Exception e){
                log.warn("Exception while closing the log output stream: " + e.getMessage());
             }
          }
       }
    }
 
 
    // Override of ScriptLauncher -----------------------------------------------
 
    /**
     * Get this object parameters definitions as a list
     * @return A list of {@code ParameterDefinition} objects
     */
    public List getParameterDefinitionsAsList(){
       // Use super parameters as base.
       if (parameters.isEmpty()){
          parameters.addAll(super.getParameterDefinitionsAsList());
          parameters.add(libraryPath);
       }
       return parameters;
    }
 
    /**
     * Set the value of a parameter using its nama
     * @param parameterName The name of parameter so set value for
     * @param parameterValue The value of the paramater
     * @throws InvalidParameterException if this parameter is not supported by this object
     */
    public void setParameter(String parameterName, String parameterValue) throws InvalidParameterException{
       try{
          // Delegate to base class first.
          super.setParameter(parameterName, parameterValue);
       }
       catch (InvalidParameterException ipe){
          // Then test the managed parameters.
          if (LIBRARY_PATH_PARAM.equals(parameterName))
             setLibraryPath(parameterValue);
          else{
             log.warn("The parameter '" + parameterName + "' is not supported by RubyScriptLauncher");
             throw new InvalidParameterException("The parameter '" + parameterName + "' is not supported by RubyScriptLauncher");
          }
       }
    }
 }