/*
    * 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.scm.plugin;
  
  import javax.inject.Inject;
  
  import java.io.IOException;
  import java.text.SimpleDateFormat;
  import java.util.Date;
  
  import org.apache.maven.plugin.MojoExecutionException;
  import org.apache.maven.plugins.annotations.Mojo;
  import org.apache.maven.plugins.annotations.Parameter;
  import org.apache.maven.scm.CommandParameters.SignOption;
  import org.apache.maven.scm.ScmException;
  import org.apache.maven.scm.ScmTagParameters;
  import org.apache.maven.scm.command.tag.TagScmResult;
  import org.apache.maven.scm.manager.ScmManager;
  import org.apache.maven.scm.provider.ScmProvider;
  import org.apache.maven.scm.repository.ScmRepository;
  import org.apache.maven.settings.crypto.SettingsDecrypter;
  
  /**
   * Tag the project.
   *
   * @author <a href="evenisse@apache.org">Emmanuel Venisse</a>
   * @author <a href="saden1@gmil.com">Sharmarke Aden</a>
   */
  @Mojo(name = "tag", aggregator = true)
  public class TagMojo extends AbstractScmMojo {
      /**
       * The tag name.
       */
      @Parameter(property = "tag", required = true)
      private String tag;
  
      /**
       * The message applied to the tag creation.
       */
      @Parameter(property = "message")
      private String message;
  
      /**
       * Set the timestamp format.
       */
      @Parameter(property = "timestampFormat", defaultValue = "yyyyMMddHHmmss")
      private String timestampFormat;
  
      /**
       * Use timestamp tagging.
       */
      @Parameter(property = "addTimestamp", defaultValue = "false")
      private boolean addTimestamp;
  
      /**
       * Define the timestamp position (end or begin).
       */
      @Parameter(property = "timestampPosition", defaultValue = "end")
      private String timestampPosition;
  
      /**
       * Timestamp tag prefix.
       */
      @Parameter(property = "timestampPrefix", defaultValue = "-")
      private String timestampPrefix;
  
      /**
       * Currently only implemented with svn scm. Enable a workaround to prevent issue
       * due to svn client > 1.5.0 (https://issues.apache.org/jira/browse/SCM-406)
       *
       * @since 1.2
       */
      @Parameter(property = "remoteTagging", defaultValue = "true")
      private boolean remoteTagging;
  
      /**
       * Currently only implemented with Subversion. Enable the "--pin-externals"
       * option in svn copy commands which is new in Subversion 1.9.
       *
       * @see https://subversion.apache.org/docs/release-notes/1.9.html
       * @since 1.11.0
       */
      @Parameter(property = "pinExternals", defaultValue = "false")
     private boolean pinExternals;
 
     /**
      * Enable the "--sign" in Git.
      * Same as {@link #signOption} set to either {@link SignOption#FORCE_SIGN} or {@link SignOption#DEFAULT}.
      *
      * @since 1.11.0
      * @deprecated since 2.2.1, use {@link #signOption} instead
      */
     @Parameter(property = "sign", defaultValue = "false")
     private boolean sign;
 
     /**
      * Toggles the signing for the tag command (only applicable to SCMs that support signing).
      *
      * @since 2.2.1
      */
     @Parameter(property = "signOption")
     private SignOption signOption = SignOption.DEFAULT;
 
     @Inject
     public TagMojo(ScmManager manager, SettingsDecrypter settingsDecrypter) {
         super(manager, settingsDecrypter);
     }
 
     /**
      * {@inheritDoc}
      */
     public void execute() throws MojoExecutionException {
         super.execute();
 
         try {
             SimpleDateFormat dateFormat = null;
             String tagTimestamp = "";
             String finalTag = tag;
 
             if (addTimestamp) {
                 try {
                     getLog().debug("Using timestamp pattern '" + timestampFormat + "'");
                     dateFormat = new SimpleDateFormat(timestampFormat);
                     tagTimestamp = dateFormat.format(new Date());
                     getLog().debug("Using timestamp '" + tagTimestamp + "'");
                 } catch (IllegalArgumentException e) {
                     String msg = "The timestamp format '" + timestampFormat + "' is invalid.";
                     throw new MojoExecutionException(msg, e);
                 }
 
                 if ("end".equals(timestampPosition)) {
                     finalTag += timestampPrefix + tagTimestamp;
                 } else {
                     finalTag = tagTimestamp + timestampPrefix + finalTag;
                 }
             }
 
             ScmRepository repository = getScmRepository();
             ScmProvider provider = getScmManager().getProviderByRepository(repository);
 
             finalTag = provider.sanitizeTagName(finalTag);
             getLog().debug("Final Tag Name: '" + finalTag + "'");
 
             ScmTagParameters scmTagParameters = new ScmTagParameters(message);
             scmTagParameters.setRemoteTagging(remoteTagging);
             scmTagParameters.setPinExternals(pinExternals);
             if (signOption != null) {
                 scmTagParameters.setSignOption(signOption);
             } else if (sign) {
                 getLog().warn("The 'sign' parameter is deprecated, use 'signOption' instead.");
                 scmTagParameters.setSign(sign);
             }
 
             TagScmResult result = provider.tag(repository, getFileSet(), finalTag, scmTagParameters);
 
             checkResult(result);
         } catch (IOException | ScmException e) {
             throw new MojoExecutionException("Cannot run tag command : ", e);
         }
     }
 }