package org.apache.maven.it.util.cli;
   
   /*
    * The MIT License
    *
    * Copyright (c) 2004, The Codehaus
    *
    * Permission is hereby granted, free of charge, to any person obtaining a copy of
    * this software and associated documentation files (the "Software"), to deal in
   * the Software without restriction, including without limitation the rights to
   * use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies
   * of the Software, and to permit persons to whom the Software is furnished to do
   * so, subject to the following conditions:
   *
   * The above copyright notice and this permission notice shall be included in all
   * copies or substantial portions of the Software.
   *
   * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
   * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
   * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
   * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
   * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
   * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
   * SOFTWARE.
   */
  
  /********************************************************************************
   * CruiseControl, a Continuous Integration Toolkit
   * Copyright (c) 2001-2003, ThoughtWorks, Inc.
   * 651 W Washington Ave. Suite 500
   * Chicago, IL 60661 USA
   * All rights reserved.
   *
   * Redistribution and use in source and binary forms, with or without
   * modification, are permitted provided that the following conditions
   * are met:
   *
   *     + Redistributions of source code must retain the above copyright
   *       notice, this list of conditions and the following disclaimer.
   *
   *     + Redistributions in binary form must reproduce the above
   *       copyright notice, this list of conditions and the following
   *       disclaimer in the documentation and/or other materials provided
   *       with the distribution.
   *
   *     + Neither the name of ThoughtWorks, Inc., CruiseControl, nor the
   *       names of its contributors may be used to endorse or promote
   *       products derived from this software without specific prior
   *       written permission.
   *
   * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
   * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
   * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
   * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS 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.
   ********************************************************************************/
  
  /* ====================================================================
   * Copyright 2003-2004 The Apache Software Foundation.
   *
   * 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
   *
   *      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.
   * ====================================================================
   */
  
  import org.apache.maven.it.util.cli.shell.CommandShell;
  import org.apache.maven.it.util.cli.shell.CmdShell;
  import org.apache.maven.it.util.cli.shell.Shell;
  
  import java.io.File;
  import java.io.IOException;
  import java.util.ArrayList;
  import java.util.Arrays;
  import java.util.Iterator;
  import java.util.List;
  import java.util.Properties;
  import java.util.StringTokenizer;
  import java.util.Vector;
  import java.util.Hashtable;
  
  /**
   * <p/>
   * Commandline objects help handling command lines specifying processes to
   * execute.
  * </p>
  * <p/>
  * The class can be used to define a command line as nested elements or as a
  * helper to define a command line by an application.
  * </p>
  * <p/>
  * <code>
  * &lt;someelement&gt;<br>
  * &nbsp;&nbsp;&lt;acommandline executable="/executable/to/run"&gt;<br>
  * &nbsp;&nbsp;&nbsp;&nbsp;&lt;argument value="argument 1" /&gt;<br>
  * &nbsp;&nbsp;&nbsp;&nbsp;&lt;argument line="argument_1 argument_2 argument_3" /&gt;<br>
  * &nbsp;&nbsp;&nbsp;&nbsp;&lt;argument value="argument 4" /&gt;<br>
  * &nbsp;&nbsp;&lt;/acommandline&gt;<br>
  * &lt;/someelement&gt;<br>
  * </code>
  * </p>
  * <p/>
  * The element <code>someelement</code> must provide a method
  * <code>createAcommandline</code> which returns an instance of this class.
  * </p>
  *
  * @author thomas.haas@softwired-inc.com
  * @author <a href="mailto:stefan.bodewig@epost.de">Stefan Bodewig</a>
  */
 public class Commandline
     implements Cloneable
 {
     protected static final String OS_NAME = "os.name";
 
     protected static final String WINDOWS = "Windows";
 
     protected String executable = null;
 
     protected Vector arguments = new Vector();
 
     protected Hashtable envVars = new Hashtable();
 
     private File workingDir = null;
 
     private long pid = -1;
 
     private Shell shell;
 
     /**
      * Create a new command line object.
      * Shell is autodetected from operating system
      *
      * @param toProcess
      */
     public Commandline( String toProcess )
     {
         super();
         setDefaultShell();
         String[] tmp = new String[0];
         try
         {
             tmp = translateCommandline( toProcess );
         }
         catch ( Exception e )
         {
             System.err.println( "Error translating Commandline." );
         }
         if ( tmp != null && tmp.length > 0 )
         {
             setExecutable( tmp[0] );
             for ( int i = 1; i < tmp.length; i++ )
             {
                 createArgument().setValue( tmp[i] );
             }
         }
     }
 
     /**
      * Create a new command line object.
      * Shell is autodetected from operating system
      */
     public Commandline()
     {
         super();
         setDefaultShell();
     }
 
     public long getPid()
     {
         if ( pid == -1 )
         {
             pid = Long.parseLong( String.valueOf( System.currentTimeMillis() ) );
         }
 
         return pid;
     }
 
     public void setPid( long pid )
     {
         this.pid = pid;
     }
 
     /**
      * Used for nested xml command line definitions.
      */
     public static class Argument
     {
 
         private String[] parts;
 
         /**
          * Sets a single commandline argument.
          *
          * @param value a single commandline argument.
          */
         public void setValue( String value )
         {
             if ( value != null )
             {
                 parts = new String[]{value};
             }
         }
 
         /**
          * Line to split into several commandline arguments.
          *
          * @param line line to split into several commandline arguments
          */
         public void setLine( String line )
         {
             if ( line == null )
             {
                 return;
             }
             try
             {
                 parts = translateCommandline( line );
             }
             catch ( Exception e )
             {
                 System.err.println( "Error translating Commandline." );
             }
         }
 
         /**
          * Sets a single commandline argument to the absolute filename
          * of the given file.
          *
          * @param value a single commandline argument.
          */
         public void setFile( File value )
         {
             parts = new String[]{value.getAbsolutePath()};
         }
 
         /**
          * Returns the parts this Argument consists of.
          */
         public String[] getParts()
         {
             return parts;
         }
     }
 
     /**
      * Class to keep track of the position of an Argument.
      */
     // <p>This class is there to support the srcfile and targetfile
     // elements of &lt;execon&gt; and &lt;transform&gt; - don't know
     // whether there might be additional use cases.</p> --SB
     public class Marker
     {
 
         private int position;
 
         private int realPos = -1;
 
         Marker( int position )
         {
             this.position = position;
         }
 
         /**
          * Return the number of arguments that preceeded this marker.
          * <p/>
          * <p>The name of the executable - if set - is counted as the
          * very first argument.</p>
          */
         public int getPosition()
         {
             if ( realPos == -1 )
             {
                 realPos = ( executable == null ? 0 : 1 );
                 for ( int i = 0; i < position; i++ )
                 {
                     Argument arg = (Argument) arguments.elementAt( i );
                     realPos += arg.getParts().length;
                 }
             }
             return realPos;
         }
     }
 
 
     /**
      * <p>Sets the shell or command-line interpretor for the detected operating system,
      * and the shell arguments.</p>
      */
     private void setDefaultShell()
     {
         String os = System.getProperty( OS_NAME );
 
         //If this is windows set the shell to command.com or cmd.exe with correct arguments.
         if ( os.indexOf( WINDOWS ) > -1 )
         {
             if ( os.indexOf( "95" ) > -1 || os.indexOf( "98" ) > -1 || os.indexOf( "Me" ) > -1 )
             {
                 setShell( new CommandShell() );
             }
             else
             {
                 setShell( new CmdShell() );
             }
         }
     }
 
     /**
      * Creates an argument object.
      * <p/>
      * <p>Each commandline object has at most one instance of the
      * argument class.  This method calls
      * <code>this.createArgument(false)</code>.</p>
      *
      * @return the argument object.
      * @see #createArgument(boolean)
      */
     public Argument createArgument()
     {
         return this.createArgument( false );
     }
 
     /**
      * Creates an argument object and adds it to our list of args.
      * <p/>
      * <p>Each commandline object has at most one instance of the
      * argument class.</p>
      *
      * @param insertAtStart if true, the argument is inserted at the
      *                      beginning of the list of args, otherwise it is appended.
      */
     public Argument createArgument( boolean insertAtStart )
     {
         Argument argument = new Argument();
         if ( insertAtStart )
         {
             arguments.insertElementAt( argument, 0 );
         }
         else
         {
             arguments.addElement( argument );
         }
         return argument;
     }
 
     /**
      * Sets the executable to run.
      */
     public void setExecutable( String executable )
     {
         if ( executable == null || executable.length() == 0 )
         {
             return;
         }
         this.executable = executable.replace( '/', File.separatorChar ).replace( '\\', File.separatorChar );
     }
 
     public String getExecutable()
     {
         return executable;
     }
 
     public void addArguments( String[] line )
     {
         for ( int i = 0; i < line.length; i++ )
         {
             createArgument().setValue( line[i] );
         }
     }
 
     /**
      * Add an environment variable
      */
     public void addEnvironment( String name,
                                 String value )
     {
         envVars.put( name, name + "=" + value );
     }
 
     /**
      * Add system environment variables
      */
     public void addSystemEnvironment()
         throws Exception
     {
         Properties envVars = CommandLineUtils.getSystemEnvVars();
 
         for ( Iterator i = envVars.keySet().iterator(); i.hasNext(); )
         {
             String key = (String) i.next();
 
             if ( !this.envVars.containsKey( key ) )
             {
                 this.envVars.put( key, key + "=" + envVars.getProperty( key ) );
             }
         }
     }
 
     /**
      * Return the list of environment variables
      */
     public String[] getEnvironmentVariables()
         throws CommandLineException
     {
         try
         {
             addSystemEnvironment();
         }
         catch ( Exception e )
         {
             throw new CommandLineException( "Error setting up environmental variables", e );
         }
 
         return (String[]) envVars.values().toArray( new String[envVars.size()] );
     }
 
     /**
      * Returns the executable and all defined arguments.
      */
     public String[] getCommandline()
     {
         final String[] args = getArguments();
         if ( executable == null )
         {
             return args;
         }
         final String[] result = new String[args.length + 1];
         result[0] = executable;
         System.arraycopy( args, 0, result, 1, args.length );
         return result;
     }
 
     /**
      * Returns the shell, executable and all defined arguments.
      */
     public String[] getShellCommandline()
     {
 
         if ( getShell() == null )
         {
             if ( executable != null )
             {
                 List commandLine = new ArrayList();
                 commandLine.add( executable );
                 commandLine.addAll( Arrays.asList( getArguments() ) );
                 return (String[]) commandLine.toArray( new String[0] );
             }
             else
             {
                 return getArguments();
             }
 
         }
         else
         {
             return (String[]) getShell().getShellCommandLine( executable, getArguments() ).toArray( new String[0] );
         }
     }
 
     /**
      * Returns all arguments defined by <code>addLine</code>,
      * <code>addValue</code> or the argument object.
      */
     public String[] getArguments()
     {
         Vector result = new Vector( arguments.size() * 2 );
         for ( int i = 0; i < arguments.size(); i++ )
         {
             Argument arg = (Argument) arguments.elementAt( i );
             String[] s = arg.getParts();
             if ( s != null )
             {
                 for ( int j = 0; j < s.length; j++ )
                 {
                     result.addElement( s[j] );
                 }
             }
         }
 
         String[] res = new String[result.size()];
         result.copyInto( res );
         return res;
     }
 
     public String toString()
     {
         return toString( getCommandline() );
     }
 
     /**
      * <p>Put quotes around the given String if necessary.</p>
      * <p>If the argument doesn't include spaces or quotes, return it
      * as is. If it contains double quotes, use single quotes - else
      * surround the argument by double quotes.</p>
      *
      * @throws CommandLineException if the argument contains both, single
      *                              and double quotes.
      */
     public static String quoteArgument( String argument )
         throws CommandLineException
     {
         if ( argument.indexOf( '\"' ) > -1 )
         {
             if ( argument.indexOf( '\'' ) > -1 )
             {
                 throw new CommandLineException( "Can't handle single and double quotes in same argument" );
             }
             else
             {
                 return '\'' + argument + '\'';
             }
         }
         else if ( containsAny( argument, "'<>&|*? " ) )
         {
             return '\"' + argument + '\"';
         }
         else
         {
             return argument;
         }
     }
 
     private static boolean containsAny( String argument, String chars )
     {
         for ( int i = chars.length() - 1; i >= 0; i-- )
         {
             if ( argument.indexOf( chars.charAt( i ) ) >= 0 )
             {
                 return true;
             }
         }
         return false;
     }
 
     public static String toString( String[] line )
     {
         // empty path return empty string
         if ( line == null || line.length == 0 )
         {
             return "";
         }
 
         // path containing one or more elements
         final StringBuffer result = new StringBuffer();
         for ( int i = 0; i < line.length; i++ )
         {
             if ( i > 0 )
             {
                 result.append( ' ' );
             }
             try
             {
                 result.append( quoteArgument( line[i] ) );
             }
             catch ( Exception e )
             {
                 System.err.println( "Error quoting argument." );
             }
         }
         return result.toString();
     }
 
     public static String[] translateCommandline( String toProcess )
         throws Exception
     {
         if ( toProcess == null || toProcess.length() == 0 )
         {
             return new String[0];
         }
 
         // parse with a simple finite state machine
 
         final int normal = 0;
         final int inQuote = 1;
         final int inDoubleQuote = 2;
         int state = normal;
         StringTokenizer tok = new StringTokenizer( toProcess, "\"\' ", true );
         Vector v = new Vector();
         StringBuffer current = new StringBuffer();
 
         while ( tok.hasMoreTokens() )
         {
             String nextTok = tok.nextToken();
             switch ( state )
             {
                 case inQuote:
                     if ( "\'".equals( nextTok ) )
                     {
                         state = normal;
                     }
                     else
                     {
                         current.append( nextTok );
                     }
                     break;
                 case inDoubleQuote:
                     if ( "\"".equals( nextTok ) )
                     {
                         state = normal;
                     }
                     else
                     {
                         current.append( nextTok );
                     }
                     break;
                 default:
                     if ( "\'".equals( nextTok ) )
                     {
                         state = inQuote;
                     }
                     else if ( "\"".equals( nextTok ) )
                     {
                         state = inDoubleQuote;
                     }
                     else if ( " ".equals( nextTok ) )
                     {
                         if ( current.length() != 0 )
                         {
                             v.addElement( current.toString() );
                             current.setLength( 0 );
                         }
                     }
                     else
                     {
                         current.append( nextTok );
                     }
                     break;
             }
         }
 
         if ( current.length() != 0 )
         {
             v.addElement( current.toString() );
         }
 
         if ( state == inQuote || state == inDoubleQuote )
         {
             throw new CommandLineException( "unbalanced quotes in " + toProcess );
         }
 
         String[] args = new String[v.size()];
         v.copyInto( args );
         return args;
     }
 
     public int size()
     {
         return getCommandline().length;
     }
 
     public Object clone()
     {
         Commandline c = new Commandline();
         c.setExecutable( executable );
         c.addArguments( getArguments() );
         return c;
     }
 
     /**
      * Clear out the whole command line.
      */
     public void clear()
     {
         executable = null;
         arguments.removeAllElements();
     }
 
     /**
      * Clear out the arguments but leave the executable in place for another operation.
      */
     public void clearArgs()
     {
         arguments.removeAllElements();
     }
 
     /**
      * Return a marker.
      * <p/>
      * <p>This marker can be used to locate a position on the
      * commandline - to insert something for example - when all
      * parameters have been set.</p>
      */
     public Marker createMarker()
     {
         return new Marker( arguments.size() );
     }
 
     /**
      * Sets execution directory.
      */
     public void setWorkingDirectory( String path )
     {
         if ( path != null )
         {
             workingDir = new File( path );
         }
     }
 
     public File getWorkingDirectory()
     {
         return workingDir;
     }
 
     /**
      * Executes the command.
      */
     public Process execute()
         throws CommandLineException
     {
         Process process;
 
         //addEnvironment( "MAVEN_TEST_ENVAR", "MAVEN_TEST_ENVAR_VALUE" );
 
         String[] environment = getEnvironmentVariables();
 
         try
         {
             if ( workingDir == null )
             {
                 process = Runtime.getRuntime().exec( getShellCommandline(), environment );
             }
             else
             {
                 if ( !workingDir.exists() )
                 {
                     throw new CommandLineException(
                         "Working directory \"" + workingDir.getPath() + "\" does not exist!" );
                 }
                 else if ( !workingDir.isDirectory() )
                 {
                     throw new CommandLineException(
                         "Path \"" + workingDir.getPath() + "\" does not specify a directory." );
                 }
 
                 process = Runtime.getRuntime().exec( getShellCommandline(), environment, workingDir );
             }
         }
         catch ( IOException ex )
         {
             throw new CommandLineException( "Error while executing process.", ex );
         }
 
         return process;
     }
 
     public Properties getSystemEnvVars()
         throws Exception
     {
         return CommandLineUtils.getSystemEnvVars();
     }
 
     /**
      * Allows to set the shell to be used in this command line.
      *
      * @param shell
      * @since 1.2
      */
     public void setShell( Shell shell )
     {
         this.shell = shell;
     }
 
     /**
      * Get the shell to be used in this command line.
      *
      * @since 1.2
      */
     public Shell getShell()
     {
         return shell;
     }
 }