package org.apache.maven.scm.provider.integrity.command.blame;
   
   /*
    * 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.
   */
  
  import org.apache.maven.scm.ScmException;
  import org.apache.maven.scm.ScmFileSet;
  import org.apache.maven.scm.ScmResult;
  import org.apache.maven.scm.command.blame.AbstractBlameCommand;
  import org.apache.maven.scm.command.blame.BlameScmResult;
  import org.apache.maven.scm.provider.ScmProviderRepository;
  import org.apache.maven.scm.provider.integrity.repository.IntegrityScmProviderRepository;
  import org.codehaus.plexus.util.cli.CommandLineException;
  import org.codehaus.plexus.util.cli.CommandLineUtils;
  import org.codehaus.plexus.util.cli.Commandline;
  
  /**
   * MKS Integrity implementation for Maven's AbstractBlameCommand
   * <br>This class will execute a 'si annotate' command for the specified filename
   *
   * @author <a href="mailto:cletus@mks.com">Cletus D'Souza</a>
   * @since 1.6
   */
  public class IntegrityBlameCommand
      extends AbstractBlameCommand
  {
      /**
       * {@inheritDoc}
       */
      @Override
      public BlameScmResult executeBlameCommand( ScmProviderRepository repository, ScmFileSet workingDirectory,
                                                 String filename )
          throws ScmException
      {
          getLogger().info( "Attempting to display blame results for file: " + filename );
          if ( null == filename || filename.length() == 0 )
          {
              throw new ScmException( "A single filename is required to execute the blame command!" );
          }
          BlameScmResult result;
          IntegrityScmProviderRepository iRepo = (IntegrityScmProviderRepository) repository;
          // Since the si annotate command is not completely API ready, we will use the CLI for this command
          // Ensure shell 'si' client is connected.
          doShellConnect( iRepo, workingDirectory );
          result = doShellAnnotate( iRepo, workingDirectory, filename );
  
          return result;
      }
  
      /**
       * Execute 'si connect' command in current shell.
       *
       * @param iRepo            the Integrity repository instance.
       * @param workingDirectory the SCM working directory.
       * @throws ScmException if connect command failed.
       */
      private void doShellConnect( IntegrityScmProviderRepository iRepo, ScmFileSet workingDirectory )
          throws ScmException
      {
          Commandline shell = new Commandline();
          shell.setWorkingDirectory( workingDirectory.getBasedir() );
          shell.setExecutable( "si" );
          shell.createArg().setValue( "connect" );
          shell.createArg().setValue( "--hostname=" + iRepo.getHost() );
          shell.createArg().setValue( "--port=" + iRepo.getPort() );
          shell.createArg().setValue( "--user=" + iRepo.getUser() );
          shell.createArg().setValue( "--batch" );
          shell.createArg().setValue( "--password=" + iRepo.getPassword() );
          CommandLineUtils.StringStreamConsumer shellConsumer = new CommandLineUtils.StringStreamConsumer();
  
          try
          {
              getLogger().debug( "Executing: " + CommandLineUtils.toString( shell.getCommandline() ) );
              int exitCode = CommandLineUtils.executeCommandLine( shell, shellConsumer, shellConsumer );
              if ( exitCode != 0 )
              {
                  throw new ScmException( "Can't login to integrity. Message : " + shellConsumer.toString() );
              }
          }
          catch ( CommandLineException cle )
          {
              getLogger().error( "Command Line Connect Exception: " + cle.getMessage() );
              throw new ScmException( "Can't login to integrity. Message : " + cle.getMessage() );
         }
 
     }
 
     /**
      * Execute 'si annotate' command in current shell and process output as {@link BlameScmResult} instance.
      *
      * @param iRepo            the Integrity repository instance.
      * @param workingDirectory the SCM working directory.
      * @param filename         the file name.
      * @return the {@link BlameScmResult} instance.
      */
     private BlameScmResult doShellAnnotate( IntegrityScmProviderRepository iRepo, ScmFileSet workingDirectory,
                                             String filename )
     {
         BlameScmResult result;
         Commandline shell = new Commandline();
         shell.setWorkingDirectory( workingDirectory.getBasedir() );
         shell.setExecutable( "si" );
         shell.createArg().setValue( "annotate" );
         shell.createArg().setValue( "--hostname=" + iRepo.getHost() );
         shell.createArg().setValue( "--port=" + iRepo.getPort() );
         shell.createArg().setValue( "--user=" + iRepo.getUser() );
         shell.createArg().setValue( "--fields=date,revision,author" );
         shell.createArg().setValue( '"' + filename + '"' );
         IntegrityBlameConsumer shellConsumer = new IntegrityBlameConsumer( getLogger() );
         String commandLine = CommandLineUtils.toString( shell.getCommandline() );
 
         try
         {
             getLogger().debug( "Executing: " +  commandLine );
             int exitCode = CommandLineUtils.executeCommandLine( shell, shellConsumer,
                                                                 new CommandLineUtils.StringStreamConsumer() );
             boolean success = ( exitCode == 0 ? true : false );
             ScmResult scmResult =
                 new ScmResult( commandLine, "", "Exit Code: " + exitCode, success );
             return new BlameScmResult( shellConsumer.getBlameList(), scmResult );
         }
         catch ( CommandLineException cle )
         {
             getLogger().error( "Command Line Exception: " + cle.getMessage() );
             result = new BlameScmResult( commandLine, cle.getMessage(), "", false );
         }
 
         return result;
     }
 
 }