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        URI relativeRepositoryPath = GitStatusCommand.getRelativeCWD( this, fileSet );
075
076        int exitCode;
077        CommandLineUtils.StringStreamConsumer stderr;
078
079        // git-add doesn't show single files, but only summary :/
080        // so we must run git-status and consume the output
081        // borrow a few things from the git-status command
082        Commandline clStatus = GitStatusCommand.createCommandLine( repository, fileSet );
083
084        GitStatusConsumer statusConsumer =
085            new GitStatusConsumer( getLogger(), fileSet.getBasedir(), relativeRepositoryPath );
086        stderr = new CommandLineUtils.StringStreamConsumer();
087        exitCode = GitCommandLineUtils.execute( clStatus, statusConsumer, stderr, getLogger() );
088        if ( exitCode != 0 )
089        {
090            // git-status returns non-zero if nothing to do
091            if ( getLogger().isInfoEnabled() )
092            {
093                getLogger().info( "nothing added to commit but untracked files present (use \"git add\" to track)" );
094            }
095        }
096
097        List<ScmFile> changedFiles = new ArrayList<ScmFile>();
098
099        // rewrite all detected files to now have status 'checked_in'
100        for ( ScmFile scmfile : statusConsumer.getChangedFiles() )
101        {
102            // if a specific fileSet is given, we have to check if the file is really tracked
103            for ( File f : fileSet.getFileList() )
104            {
105                if ( FilenameUtils.separatorsToUnix( f.getPath() ).equals( scmfile.getPath() ) )
106                {
107                    changedFiles.add( scmfile );
108                }
109            }
110        }
111
112        Commandline cl = createCommandLine( fileSet.getBasedir(), fileSet.getFileList() );
113        return new AddScmResult( cl.toString(), changedFiles );
114    }
115
116    public static Commandline createCommandLine( File workingDirectory, List<File> files )
117        throws ScmException
118    {
119        Commandline cl = GitCommandLineUtils.getBaseGitCommandLine( workingDirectory, "add" );
120
121        // use this separator to make clear that the following parameters are files and not revision info.
122        cl.createArg().setValue( "--" );
123
124        GitCommandLineUtils.addTarget( cl, files );
125
126        return cl;
127    }
128
129    private AddScmResult executeAddFileSet( ScmFileSet fileSet )
130        throws ScmException
131    {
132        File workingDirectory = fileSet.getBasedir();
133        List<File> files = fileSet.getFileList();
134
135        // command line can be too long for windows so add files individually (see SCM-697)
136        if ( Os.isFamily( Os.FAMILY_WINDOWS ) )
137        {
138            for ( File file : files )
139            {
140                AddScmResult result = executeAddFiles( workingDirectory, Collections.singletonList( file ) );
141
142                if ( result != null )
143                {
144                    return result;
145                }
146            }
147        }
148        else
149        {
150            AddScmResult result = executeAddFiles( workingDirectory, files );
151
152            if ( result != null )
153            {
154                return result;
155            }
156        }
157
158        return null;
159    }
160
161    private AddScmResult executeAddFiles( File workingDirectory, List<File> files )
162        throws ScmException
163    {
164        Commandline cl = createCommandLine( workingDirectory, files );
165
166        CommandLineUtils.StringStreamConsumer stderr = new CommandLineUtils.StringStreamConsumer();
167        CommandLineUtils.StringStreamConsumer stdout = new CommandLineUtils.StringStreamConsumer();
168
169        int exitCode = GitCommandLineUtils.execute( cl, stdout, stderr, getLogger() );
170
171        if ( exitCode != 0 )
172        {
173            return new AddScmResult( cl.toString(), "The git-add command failed.", stderr.getOutput(), false );
174        }
175
176        return null;
177    }
178}