001package org.apache.maven.scm.provider.git.gitexe.command.add;
002
003/*
004 * Licensed to the Apache Software Foundation (ASF) under one
005 * or more contributor license agreements.  See the NOTICE file
006 * distributed with this work for additional information
007 * regarding copyright ownership.  The ASF licenses this file
008 * to you under the Apache License, Version 2.0 (the
009 * "License"); you may not use this file except in compliance
010 * with the License.  You may obtain a copy of the License at
011 *
012 * http://www.apache.org/licenses/LICENSE-2.0
013 *
014 * Unless required by applicable law or agreed to in writing,
015 * software distributed under the License is distributed on an
016 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
017 * KIND, either express or implied.  See the License for the
018 * specific language governing permissions and limitations
019 * under the License.
020 */
021
022import org.apache.commons.io.FilenameUtils;
023import org.apache.maven.scm.ScmException;
024import org.apache.maven.scm.ScmFile;
025import org.apache.maven.scm.ScmFileSet;
026import org.apache.maven.scm.ScmResult;
027import org.apache.maven.scm.command.add.AbstractAddCommand;
028import org.apache.maven.scm.command.add.AddScmResult;
029import org.apache.maven.scm.provider.ScmProviderRepository;
030import org.apache.maven.scm.provider.git.command.GitCommand;
031import org.apache.maven.scm.provider.git.gitexe.command.GitCommandLineUtils;
032import org.apache.maven.scm.provider.git.gitexe.command.status.GitStatusCommand;
033import org.apache.maven.scm.provider.git.gitexe.command.status.GitStatusConsumer;
034import org.apache.maven.scm.provider.git.repository.GitScmProviderRepository;
035import org.codehaus.plexus.util.Os;
036import org.codehaus.plexus.util.cli.CommandLineUtils;
037import org.codehaus.plexus.util.cli.Commandline;
038
039import java.io.File;
040import java.net.URI;
041import java.util.ArrayList;
042import java.util.Collections;
043import java.util.List;
044
045/**
046 * @author <a href="mailto:struberg@yahoo.de">Mark Struberg</a>
047 */
048public class GitAddCommand
049    extends AbstractAddCommand
050    implements GitCommand
051{
052    /**
053     * {@inheritDoc}
054     */
055    protected ScmResult executeAddCommand( ScmProviderRepository repo, ScmFileSet fileSet, String message,
056                                           boolean binary )
057        throws ScmException
058    {
059        GitScmProviderRepository repository = (GitScmProviderRepository) repo;
060
061        if ( fileSet.getFileList().isEmpty() )
062        {
063            throw new ScmException( "You must provide at least one file/directory to add" );
064        }
065
066        AddScmResult result = executeAddFileSet( fileSet );
067
068        if ( result != null )
069        {
070            return result;
071        }
072        
073        // SCM-709: statusCommand uses repositoryRoot instead of workingDirectory, adjust it with relativeRepositoryPath
074        Commandline clRevparse = GitStatusCommand.createRevparseShowToplevelCommand( fileSet );
075        
076        CommandLineUtils.StringStreamConsumer stdout = new CommandLineUtils.StringStreamConsumer();
077        CommandLineUtils.StringStreamConsumer stderr = new CommandLineUtils.StringStreamConsumer();
078
079        URI relativeRepositoryPath = null;
080        
081        int exitCode;
082
083        exitCode = GitCommandLineUtils.execute( clRevparse, stdout, stderr, getLogger() );
084        if ( exitCode != 0 )
085        {
086            // git-status returns non-zero if nothing to do
087            if ( getLogger().isInfoEnabled() )
088            {
089                getLogger().info( "Could not resolve toplevel" );
090            }
091        }
092        else
093        {
094            relativeRepositoryPath = GitStatusConsumer.resolveURI( stdout.getOutput().trim() , fileSet.getBasedir().toURI() ); 
095        }
096
097        // git-add doesn't show single files, but only summary :/
098        // so we must run git-status and consume the output
099        // borrow a few things from the git-status command
100        Commandline clStatus = GitStatusCommand.createCommandLine( repository, fileSet );
101
102        GitStatusConsumer statusConsumer = new GitStatusConsumer( getLogger(), fileSet.getBasedir(), relativeRepositoryPath );
103        stderr = new CommandLineUtils.StringStreamConsumer();
104        exitCode = GitCommandLineUtils.execute( clStatus, statusConsumer, stderr, getLogger() );
105        if ( exitCode != 0 )
106        {
107            // git-status returns non-zero if nothing to do
108            if ( getLogger().isInfoEnabled() )
109            {
110                getLogger().info( "nothing added to commit but untracked files present (use \"git add\" to track)" );
111            }
112        }
113
114        List<ScmFile> changedFiles = new ArrayList<ScmFile>();
115
116        // rewrite all detected files to now have status 'checked_in'
117        for ( ScmFile scmfile : statusConsumer.getChangedFiles() )
118        {
119            // if a specific fileSet is given, we have to check if the file is really tracked
120            for ( File f : fileSet.getFileList() )
121            {
122                if ( FilenameUtils.separatorsToUnix( f.getPath() ).equals( scmfile.getPath() ) )
123                {
124                    changedFiles.add( scmfile );
125                }
126            }
127        }
128
129        Commandline cl = createCommandLine( fileSet.getBasedir(), fileSet.getFileList() );
130        return new AddScmResult( cl.toString(), changedFiles );
131    }
132
133    public static Commandline createCommandLine( File workingDirectory, List<File> files )
134        throws ScmException
135    {
136        Commandline cl = GitCommandLineUtils.getBaseGitCommandLine( workingDirectory, "add" );
137
138        // use this separator to make clear that the following parameters are files and not revision info.
139        cl.createArg().setValue( "--" );
140
141        GitCommandLineUtils.addTarget( cl, files );
142
143        return cl;
144    }
145
146    private AddScmResult executeAddFileSet( ScmFileSet fileSet )
147        throws ScmException
148    {
149        File workingDirectory = fileSet.getBasedir();
150        List<File> files = fileSet.getFileList();
151
152        // command line can be too long for windows so add files individually (see SCM-697)
153        if ( Os.isFamily( Os.FAMILY_WINDOWS ) )
154        {
155            for ( File file : files )
156            {
157                AddScmResult result = executeAddFiles( workingDirectory, Collections.singletonList( file ) );
158
159                if ( result != null )
160                {
161                    return result;
162                }
163            }
164        }
165        else
166        {
167            AddScmResult result = executeAddFiles( workingDirectory, files );
168
169            if ( result != null )
170            {
171                return result;
172            }
173        }
174
175        return null;
176    }
177
178    private AddScmResult executeAddFiles( File workingDirectory, List<File> files )
179        throws ScmException
180    {
181        Commandline cl = createCommandLine( workingDirectory, files );
182
183        CommandLineUtils.StringStreamConsumer stderr = new CommandLineUtils.StringStreamConsumer();
184        CommandLineUtils.StringStreamConsumer stdout = new CommandLineUtils.StringStreamConsumer();
185
186        int exitCode = GitCommandLineUtils.execute( cl, stdout, stderr, getLogger() );
187
188        if ( exitCode != 0 )
189        {
190            return new AddScmResult( cl.toString(), "The git-add command failed.", stderr.getOutput(), false );
191        }
192
193        return null;
194    }
195}