package org.apache.maven.plugin.announcement;

 /*

  * 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.plugin.AbstractMojo;

 import org.apache.maven.plugin.MojoExecutionException;

 import org.apache.maven.plugin.changes.Action;

 import org.apache.maven.plugin.changes.ChangesXML;

 import org.apache.maven.plugin.changes.Release;

 import org.apache.maven.plugin.jira.JiraXML;

 import org.apache.maven.project.MavenProject;

 import org.apache.maven.settings.Settings;

 import org.apache.velocity.VelocityContext;

 import org.apache.velocity.context.Context;

 import org.apache.velocity.exception.ResourceNotFoundException;

 import org.apache.velocity.exception.VelocityException;

 import org.codehaus.plexus.velocity.VelocityComponent;

 import java.io.File;

 import java.io.FileWriter;

 import java.io.Writer;

 import java.util.Iterator;

 import java.util.List;

 /**

  * Goal which generate the template for an announcement.

  *

  * @goal announcement-generate

  * @requiresDependencyResolution test

  * @author aramirez@exist.com

  * @version $Id: org.apache.maven.plugin.announcement.AnnouncementMojo.html 816584 2012-05-08 12:33:35Z hboutemy $

  */

 public class AnnouncementMojo

     extends AbstractMojo

 {

     private static final String SNAPSHOT_SUFFIX = "-SNAPSHOT";

     /**

      * Directory where the template file will be generated.

      *

      * @parameter expression="${project.build.directory}/announcement"

      * @required

      */

     private File outputDirectory;

     /**

      * @parameter expression="${project.groupId}"

      * @readonly

      */

     private String groupId;

     /**

      * @parameter expression="${project.artifactId}"

      * @readonly

      */

     private String artifactId;

     /**

      * Version of the artifact.

      *

      * @parameter expression="${project.version}"

      * @readonly

      */

     private String version;

     /**

      * Distribution url of the artifact.

      *

      * @parameter expression="${project.url}"

      * @required

      */

     private String url;

     /**

      * Packaging structure for the artifact.

      *

      * @parameter expression="${project.packaging}"

      * @readonly

      */

     private String packaging;

     /**

      * The name of the artifact to be used in the announcement.

      *

      * @parameter expression="${project.build.finalName}"

      * @required

      */

     private String finalName;

     /**

      * URL where the artifact can be downloaded. If not specified,

      * no URL is used.

      *

      * @parameter

      */

     private String urlDownload;

     /**

      * The path of the changes.xml file.

      *

      * @parameter expression="${basedir}/src/changes/changes.xml"

      * @required

      */

     private File xmlPath;

     /**

      * Name of the team that develops the artifact.

      *

      * @parameter default-value="${project.name} team"

      * @required

      */

     private String developmentTeam;

     /**

      * Short description or introduction of the released artifact.

      *

      * @parameter expression="${project.description}"

      */

     private String introduction;

     /**

      * Velocity Component.

      *

      * @parameter expression="${component.org.codehaus.plexus.velocity.VelocityComponent}"

      * @readonly

      */

     private VelocityComponent velocity;

     /**

      * The Velocity template used to format the announcement.

      *

      * @parameter default-value="announcement.vm"

      * @required

      */

     private String template;

     /**

      * Directory that contains the template.

      * <p>

      * <b>Note:</b> This directory must be a subdirectory of

      * <code>/src/main/resources/</code>.

      * </p>

      *

      * @parameter default-value="org/apache/maven/plugin/announcement"

      * @required

      */

     private String templateDirectory;

     private ChangesXML xml;

     //=======================================//

     //  JIRA-Announcement Needed Parameters  //

     //=======================================//

     /**

      * The Maven Project.

      *

      * @parameter expression="${project}"

      * @required

      * @readonly

      */

     private MavenProject project;

     /**

      * Settings XML configuration.

      *

      * @parameter expression="${settings}"

      * @required

      * @readonly

      */

     private Settings settings;

     /**

      * Flag to determine if the plugin will generate a JIRA announcement.

      *

      * @parameter expression="${generateJiraAnnouncement}" default-value="false"

      * @required

      */

     private boolean generateJiraAnnouncement;

     /**

      * Only closed issues are needed.

      * <p>

      * <b>Note:</b> In versions 2.0-beta-3 and earlier this parameter was

      * called "statusId".

      * </p>

      *

      * @parameter default-value="Closed"

      */

     private String statusIds;

     /**

      * Only fixed issues are needed.

      * <p>

      * <b>Note:</b> In versions 2.0-beta-3 and earlier this parameter was

      * called "resolutionId".

      * </p>

      *

      * @parameter default-value="Fixed"

      */

     private String resolutionIds;

     /**

      * The path of the XML file of JIRA-announcements to be parsed.

      *

      * @parameter expression="${project.build.directory}/jira-announcement.xml"

      * @required

      * @readonly

      */

     private File jiraXML;

     /**

      * The maximum number of issues to include.

      * <p>

      * <b>Note:</b> In versions 2.0-beta-3 and earlier this parameter was

      * called "nbEntries".

      * </p>

      *

      * @parameter default-value="25"

      * @required

      */

     private int maxEntries;

     //=======================================//

     //    announcement-generate execution    //

     //=======================================//

     /**

      * Generate the template

      *

      * @throws MojoExecutionException

      */

     public void execute()

         throws MojoExecutionException

     {

         if ( !generateJiraAnnouncement )

         {

             setXml( new ChangesXML( getXmlPath(), getLog() ) );

             getLog().info( "Creating announcement file from " + getXmlPath() + "..." );

             doGenerate( getXml().getReleaseList() );

         }

         else

         {

             doJiraGenerate();

         }

     }

     /**

      * Add the parameters to velocity context

      *

      * @param releases A <code>List</code> of <code>Release</code>s

      * @throws MojoExecutionException

      */

     public void doGenerate( List releases )

         throws MojoExecutionException

     {

         try

         {

             Context context = new VelocityContext();

             if ( getIntroduction() == null || getIntroduction().equals( "" ) )

             {

                 setIntroduction( getUrl() );

             }

             context.put( "releases", releases );

             context.put( "groupId", getGroupId() );

             context.put( "artifactId", getArtifactId() );

             context.put( "version", getVersion() );

             context.put( "packaging", getPackaging() );

             context.put( "url", getUrl() );

             context.put( "release", getLatestRelease( releases ) );

             context.put( "introduction", getIntroduction() );

             context.put( "developmentTeam", getDevelopmentTeam() );

             context.put( "finalName", getFinalName() );

             context.put( "urlDownload", getUrlDownload() );

             processTemplate( context, getOutputDirectory(), template );

         }

         catch ( ResourceNotFoundException rnfe )

         {

             throw new MojoExecutionException( "Resource not found.", rnfe );

         }

         catch ( VelocityException ve )

         {

             throw new MojoExecutionException( ve.toString(), ve );

         }

     }

     /**

      * Get the latest release by matching the supplied releases

      * with the version from the pom.

      *

      * @param releases list of releases

      * @return A <code>Release</code> that matches the next release of the current project

      * @throws MojoExecutionException

      */

     public Release getLatestRelease( List releases )

         throws MojoExecutionException

     {

         boolean isFound = false;

         Release release = null;

         // Remove "-SNAPSHOT" from the end, if it's there

         String pomVersion = getVersion();

         if ( pomVersion != null && pomVersion.endsWith( SNAPSHOT_SUFFIX ) )

         {

             pomVersion = pomVersion.substring( 0, pomVersion.length() - SNAPSHOT_SUFFIX.length() );

         }

         getLog().debug( "Found " + releases.size() + " releases." );

         for ( int i = 0; i < releases.size(); i++ )

         {

             release = (Release) releases.get( i );

             if ( getLog().isDebugEnabled() )

             {

                 getLog().debug( "The release: " + release.getVersion()

                     + " has " + release.getAction().size() + " actions." );

             }

             if ( release.getVersion() != null && release.getVersion().equals( pomVersion ) )

             {

                 isFound = true;

                 if ( getLog().isDebugEnabled() )

                 {

                     getLog().debug( "Found the correct release: " + release.getVersion() );

                     logRelease( release );

                 }

                 return release;

             }

         }

         if ( !isFound )

         {

             throw new MojoExecutionException( "Couldn't find the release '" + pomVersion

                 + "' among the supplied releases." );

         }

         return release;

     }

     private void logRelease( Release release )

     {

         Action action;

         for ( Iterator iterator = release.getAction().iterator(); iterator.hasNext(); )

         {

             action = (Action) iterator.next();

             getLog().debug( "o " + action.getType() );

             getLog().debug( "  - " + action.getIssue() );

             getLog().debug( "  - " + action.getAction() );

             getLog().debug( "  - " + action.getDueTo() );

         }

     }

     /**

      * Create the velocity template

      *

      * @param context velocity context that has the parameter values

      * @param outputDirectory directory where the file will be generated

      * @param template velocity template which will the context be merged

      * @throws ResourceNotFoundException, VelocityException, IOException

      */

     public void processTemplate( Context context, File outputDirectory, String template )

         throws ResourceNotFoundException, VelocityException, MojoExecutionException

     {

         File f;

         try

         {

             f = new File( outputDirectory, template );

             if ( !f.getParentFile().exists() )

             {

                 f.getParentFile().mkdirs();

             }

             Writer writer = new FileWriter( f );

             getVelocity().getEngine().mergeTemplate( templateDirectory + "/" + template, context, writer );

             writer.flush();

             writer.close();

             getLog().info( "Created template " + f );

         }

         catch ( ResourceNotFoundException rnfe )

         {

             throw new ResourceNotFoundException( "Template not found. ( " + templateDirectory + "/" + template + " )" );

         }

         catch ( VelocityException ve )

         {

             throw new VelocityException( ve.toString() );

         }

         catch ( Exception e )

         {

             if ( e.getCause() != null )

             {

                 getLog().warn( e.getCause() );

             }

             throw new MojoExecutionException( e.toString(), e.getCause() );

         }

     }

     public void doJiraGenerate()

         throws MojoExecutionException

     {

         JiraDownloader jiraDownloader = new JiraDownloader();

         File jiraXMLFile = jiraXML;

         jiraDownloader.setLog( getLog() );

         jiraDownloader.setOutput( jiraXMLFile );

         jiraDownloader.setStatusIds( statusIds );

         jiraDownloader.setResolutionIds( resolutionIds );

         jiraDownloader.setMavenProject( project );

         jiraDownloader.setSettings( settings );

         jiraDownloader.setNbEntries( maxEntries );

         try

         {

             jiraDownloader.doExecute();

             if ( jiraXMLFile.exists() )

             {

                 JiraXML jiraParser = new JiraXML( jiraXMLFile );

                 List issues = jiraParser.getIssueList();

                 List releases = JiraXML.getReleases( issues );

                 getLog().info( "Creating announcement file from JIRA releases..." );

                 doGenerate( releases );

             }

         }

         catch ( Exception e )

         {

             throw new MojoExecutionException( "Failed to extract JIRA issues from the downloaded file", e );

         }

     }

     /*

      * accessors

      */

     public File getXmlPath()

     {

         return xmlPath;

     }

     public void setXmlPath( File xmlPath )

     {

         this.xmlPath = xmlPath;

     }

     public File getOutputDirectory()

     {

         return outputDirectory;

     }

     public void setOutputDirectory( File outputDirectory )

     {

         this.outputDirectory = outputDirectory;

     }

     public String getGroupId()

     {

         return groupId;

     }

     public void setGroupId( String groupId )

     {

         this.groupId = groupId;

     }

     public String getArtifactId()

     {

         return artifactId;

     }

     public void setArtifactId( String artifactId )

     {

         this.artifactId = artifactId;

     }

     public String getVersion()

     {

         return version;

     }

     public void setVersion( String version )

     {

         this.version = version;

     }

     public String getUrl()

     {

         return url;

     }

     public void setUrl( String url )

     {

         this.url = url;

     }

     public ChangesXML getXml()

     {

         return xml;

     }

     public void setXml( ChangesXML xml )

     {

         this.xml = xml;

     }

     public String getPackaging()

     {

         return packaging;

     }

     public void setPackaging( String packaging )

     {

         this.packaging = packaging;

     }

     public String getDevelopmentTeam()

     {

         return developmentTeam;

     }

     public void setDevelopmentTeam( String developmentTeam )

     {

         this.developmentTeam = developmentTeam;

     }

     public String getIntroduction()

     {

         return introduction;

     }

     public void setIntroduction( String introduction )

     {

         this.introduction = introduction;

     }

     public VelocityComponent getVelocity()

     {

         return velocity;

     }

     public void setVelocity( VelocityComponent velocity )

     {

         this.velocity = velocity;

     }

     public String getFinalName()

     {

         return finalName;

     }

     public void setFinalName( String finalName )

     {

         this.finalName = finalName;

     }

     public String getUrlDownload()

     {

         return urlDownload;

     }

     public void setUrlDownload( String urlDownload )

     {

         this.urlDownload = urlDownload;

     }

 }