/*
    * 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.
   */
  package org.apache.maven.shared.release.phase;
  
  import javax.inject.Inject;
  import javax.inject.Named;
  import javax.inject.Singleton;
  
  import java.io.File;
  import java.util.ArrayList;
  import java.util.List;
  
  import org.apache.maven.project.MavenProject;
  import org.apache.maven.scm.ScmException;
  import org.apache.maven.scm.ScmFileSet;
  import org.apache.maven.scm.command.remove.RemoveScmResult;
  import org.apache.maven.scm.provider.ScmProvider;
  import org.apache.maven.scm.repository.ScmRepository;
  import org.apache.maven.shared.release.ReleaseExecutionException;
  import org.apache.maven.shared.release.ReleaseFailureException;
  import org.apache.maven.shared.release.ReleaseResult;
  import org.apache.maven.shared.release.config.ReleaseDescriptor;
  import org.apache.maven.shared.release.env.ReleaseEnvironment;
  import org.apache.maven.shared.release.scm.ReleaseScmCommandException;
  import org.apache.maven.shared.release.scm.ScmRepositoryConfigurator;
  import org.apache.maven.shared.release.util.ReleaseUtil;
  
  /**
   * Remove release POMs.
   *
   * @author <a href="mailto:brett@apache.org">Brett Porter</a>
   * @author <a href="mailto:markhobson@gmail.com">Mark Hobson</a>
   */
  @Singleton
  @Named("remove-release-poms")
  public class RemoveReleasePomsPhase extends AbstractReleasePomsPhase {
      @Inject
      public RemoveReleasePomsPhase(ScmRepositoryConfigurator scmRepositoryConfigurator) {
          super(scmRepositoryConfigurator);
      }
  
      @Override
      public ReleaseResult execute(
              ReleaseDescriptor releaseDescriptor,
              ReleaseEnvironment releaseEnvironment,
              List<MavenProject> reactorProjects)
              throws ReleaseFailureException, ReleaseExecutionException {
          return execute(releaseDescriptor, releaseEnvironment, reactorProjects, false);
      }
  
      @Override
      public ReleaseResult simulate(
              ReleaseDescriptor releaseDescriptor,
              ReleaseEnvironment releaseEnvironment,
              List<MavenProject> reactorProjects)
              throws ReleaseFailureException, ReleaseExecutionException {
          return execute(releaseDescriptor, releaseEnvironment, reactorProjects, true);
      }
  
      private ReleaseResult execute(
              ReleaseDescriptor releaseDescriptor,
              ReleaseEnvironment releaseEnvironment,
              List<MavenProject> reactorProjects,
              boolean simulate)
              throws ReleaseFailureException, ReleaseExecutionException {
          ReleaseResult result = new ReleaseResult();
  
          if (releaseDescriptor.isGenerateReleasePoms()) {
              removeReleasePoms(releaseDescriptor, releaseEnvironment, simulate, result, reactorProjects);
          } else {
              logInfo(result, "Not removing release POMs");
          }
  
          result.setResultCode(ReleaseResult.SUCCESS);
  
          return result;
      }
  
      private void removeReleasePoms(
              ReleaseDescriptor releaseDescriptor,
              ReleaseEnvironment releaseEnvironment,
              boolean simulate,
              ReleaseResult result,
             List<MavenProject> projects)
             throws ReleaseFailureException, ReleaseExecutionException {
         List<File> releasePoms = new ArrayList<>();
 
         for (MavenProject project : projects) {
             logInfo(result, "Removing release POM for '" + project.getName() + "'...");
 
             releasePoms.add(ReleaseUtil.getReleasePom(project));
         }
 
         if (releaseDescriptor.isSuppressCommitBeforeTagOrBranch()) {
             removeReleasePomsFromFilesystem(simulate, result, releasePoms);
         } else {
             removeReleasePomsFromScm(releaseDescriptor, releaseEnvironment, simulate, result, releasePoms);
         }
     }
 
     private void removeReleasePomsFromFilesystem(boolean simulate, ReleaseResult result, List<File> releasePoms) {
         if (simulate) {
             logInfo(result, "Full run would be removing " + releasePoms);
         } else {
             for (File releasePom : releasePoms) {
                 releasePom.delete();
             }
         }
     }
 
     private void removeReleasePomsFromScm(
             ReleaseDescriptor releaseDescriptor,
             ReleaseEnvironment releaseEnvironment,
             boolean simulate,
             ReleaseResult result,
             List<File> releasePoms)
             throws ReleaseFailureException, ReleaseExecutionException {
         if (simulate) {
             logInfo(result, "Full run would be removing " + releasePoms);
         } else {
             ScmRepository scmRepository = getScmRepository(releaseDescriptor, releaseEnvironment);
             ScmProvider scmProvider = getScmProvider(scmRepository);
 
             ScmFileSet scmFileSet = new ScmFileSet(new File(releaseDescriptor.getWorkingDirectory()), releasePoms);
 
             try {
                 RemoveScmResult scmResult =
                         scmProvider.remove(scmRepository, scmFileSet, "Removing for next development iteration.");
 
                 if (!scmResult.isSuccess()) {
                     throw new ReleaseScmCommandException("Cannot remove release POMs from SCM", scmResult);
                 }
             } catch (ScmException exception) {
                 throw new ReleaseExecutionException(
                         "Cannot remove release POMs from SCM: " + exception.getMessage(), exception);
             }
         }
     }
 }