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 java.io.File;

 import java.io.FileOutputStream;

 import java.io.OutputStreamWriter;

 import java.io.Writer;

 import java.util.ArrayList;

 import java.util.Collections;

 import java.util.List;

 import java.util.Map;

 import org.apache.maven.plugin.MojoExecutionException;

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

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

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

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

 import org.apache.maven.plugin.issues.Issue;

 import org.apache.maven.plugin.issues.IssueUtils;

 import org.apache.maven.plugin.trac.TracDownloader;

 import org.apache.maven.plugins.changes.model.Release;

 import org.apache.maven.project.MavenProject;

 import org.apache.maven.settings.Settings;

 import org.apache.velocity.Template;

 import org.apache.velocity.VelocityContext;

 import org.apache.velocity.app.VelocityEngine;

 import org.apache.velocity.context.Context;

 import org.apache.velocity.exception.ResourceNotFoundException;

 import org.apache.velocity.exception.VelocityException;

 import org.codehaus.plexus.util.ReaderFactory;

 import org.codehaus.plexus.util.StringUtils;

 import org.codehaus.plexus.velocity.VelocityComponent;

 /**

  * Goal which generate the template for an announcement.

  *

  * @goal announcement-generate

  * @requiresDependencyResolution test

  * @author aramirez@exist.com

  * @version $Id$

  * @since 2.0-beta-2

  * @threadSafe

  */

 public class AnnouncementMojo

     extends AbstractAnnouncementMojo

 {

     private static final String CHANGES_XML = "changes.xml";

     private static final String JIRA = "JIRA";

     private static final String TRAC = "Trac";

     /**

      * The name of the file which will contain the generated announcement. If

      * no value is specified the plugin will use the name of the template.

      *

      * @parameter expression="${changes.announcementFile}"

      * @since 2.4

      */

     private String announcementFile;

     /**

      * Map of custom parameters for the announcement.

      * This Map will be passed to the template.

      *

      * @parameter

      * @since 2.1

      */

     private Map announceParameters;

     /**

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

      * @readonly

      */

     private String artifactId;

     /**

      * Name of the team that develops the artifact.

      * This parameter will be passed to the template.

      *

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

      * @required

      */

     private String developmentTeam;

     /**

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

      *

      * @parameter expression="${changes.finalName}" default-value="${project.build.finalName}"

      * @required

      */

     private String finalName;

     /**

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

      * @readonly

      */

     private String groupId;

     /**

      * Short description or introduction of the released artifact.

      * This parameter will be passed to the template.

      *

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

      */

     private String introduction;

     /**

      * A list of issue management systems to fetch releases from. This parameter

      * replaces the parameters <code>generateJiraAnnouncement</code> and

      * <code>jiraMerge</code>.

      * <p>

      * Valid values are: <code>changes.xml</code> and <code>JIRA</code>.

      * </p>

      * <strong>Note:</strong> Only one issue management system that is

      * configured in <project>/<issueManagement> can be used. This

      * currently means that you can combine a changes.xml file with one other

      * issue management system.

      *

      * @parameter

      * @since 2.4

      */

     private List<String> issueManagementSystems;

     /**

      * Directory where the template file will be generated.

      *

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

      * @required

      */

     private File outputDirectory;

     /**

      * Packaging structure for the artifact.

      *

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

      * @readonly

      */

     private String packaging;

     /**

      * The Maven Project.

      *

      * @parameter expression="${project}"

      * @required

      * @readonly

      */

     private MavenProject project;

     /**

      * The Velocity template used to format the announcement.

      *

      * @parameter default-value="announcement.vm" expression="${changes.template}"

      * @required

      */

     private String template;

     /**

      * Directory that contains the template.

      * <p>

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

      * <code>/src/main/resources/ or current project base directory</code>.

      * </p>

      *

      * @parameter default-value="org/apache/maven/plugin/announcement" expression="${changes.templateDirectory}"

      * @required

      */

     private String templateDirectory;

     /**

      * The template encoding.

      *

      * @parameter expression="${changes.templateEncoding}" default-value="${project.build.sourceEncoding}"

      * @since 2.1

      */

     private String templateEncoding;

     /**

      * Distribution URL of the artifact.

      * This parameter will be passed to the template.

      *

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

      */

     private String url;

     /**

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

      * no URL is used.

      * This parameter will be passed to the template.

      *

      * @parameter

      */

     private String urlDownload;

     /**

      * Velocity Component.

      *

      * @component role="org.codehaus.plexus.velocity.VelocityComponent" roleHint="maven-changes-plugin"

      * @readonly

      */

     private VelocityComponent velocity;

     /**

      * Version of the artifact.

      *

      * @parameter expression="${changes.version}" default-value="${project.version}"

      * @required

      */

     private String version;

     /**

      * The path of the changes.xml file.

      *

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

      * @required

      */

     private File xmlPath;

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

     //  JIRA-Announcement Needed Parameters  //

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

     /**

      * Defines the filter parameters to restrict which issues are retrieved

      * from JIRA. The filter parameter uses the same format of url

      * parameters that is used in a JIRA search.

      *

      * @parameter default-value=""

      * @since 2.4

      */

     private String filter;

     /**

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

      *

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

      * @required

      * @deprecated Since version 2.4 this parameter has been deprecated. Please use the issueManagementSystems parameter instead.

      */

     private boolean generateJiraAnnouncement;

     /**

      * If releases from JIRA should be merged with the releases from a

      * changes.xml file.

      *

      * @parameter expression="${changes.jiraMerge}" default-value="false"

      * @since 2.1

      * @deprecated Since version 2.4 this parameter has been deprecated. Please use the issueManagementSystems parameter instead.

      */

     private boolean jiraMerge;

     /**

      * Defines the JIRA password for authentication into a private JIRA installation.

      *

      * @parameter default-value="" expression="${changes.jiraPassword}"

      * @since 2.1

      */

     private String jiraPassword;

     /**

      * Defines the JIRA username for authentication into a private JIRA installation.

      *

      * @parameter default-value="" expression="${changes.jiraUser}"

      * @since 2.1

      */

     private String jiraUser;

     /**

      * Path to the JIRA XML file, which will be parsed.

      *

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

      * @required

      * @readonly

      */

     private File jiraXML;

     /**

      * The maximum number of issues to fetch from JIRA.

      * <p>

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

      * called "nbEntries".

      * </p>

      *

      * @parameter default-value="25"  expression="${changes.maxEntries}"

      * @required

      */

     private int maxEntries;

     /**

      * Include issues from JIRA with these resolution ids. Multiple resolution

      * ids can be specified as a comma separated list of ids.

      * <p>

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

      * called "resolutionId".

      * </p>

      *

      * @parameter default-value="Fixed" expression="${changes.resolutionIds}"

      */

     private String resolutionIds;

     /**

      * Settings XML configuration.

      *

      * @parameter expression="${settings}"

      * @required

      * @readonly

      */

     private Settings settings;

     /**

      * Include issues from JIRA with these status ids. Multiple status ids can

      * be specified as a comma separated list of ids.

      * <p>

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

      * called "statusId".

      * </p>

      *

      * @parameter default-value="Closed" expression="${changes.statusIds}"

      */

     private String statusIds;

     /**

      * Defines the http user for basic authentication into the JIRA webserver.

      *

      * @parameter default-value=""

      * @since 2.4

      */

     private String webUser;

     /**

      * Defines the http password for basic authentication into the JIRA webserver.

      *

      * @parameter default-value=""

      * @since 2.4

      */

     private String webPassword;

     /**

      * The prefix used when naming versions in JIRA.

      * <p>

      * If you have a project in JIRA with several components that have different

      * release cycles, it is an often used pattern to prefix the version with

      * the name of the component, e.g. maven-filtering-1.0 etc. To fetch issues

      * from JIRA for a release of the "maven-filtering" component you would need

      * to set this parameter to "maven-filtering-".

      * </p>

      *

      * @parameter default-value=""

      * @since 2.5

      */

     private String versionPrefix;

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

     //  Trac Parameters                      //

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

     /**

      * Defines the Trac password for authentication into a private Trac

      * installation.

      *

      * @parameter default-value="" expression="${changes.tracPassword}"

      * @since 2.4

      */

     private String tracPassword;

     /**

      * Defines the Trac query for searching for tickets.

      *

      * @parameter default-value="order=id"

      * @since 2.4

      */

     private String tracQuery;

     /**

      * Defines the Trac username for authentication into a private Trac

      * installation.

      *

      * @parameter default-value="" expression="${changes.tracUser}"

      * @since 2.4

      */

     private String tracUser;

     private ReleaseUtils releaseUtils = new ReleaseUtils( getLog() );

     private ChangesXML xml;

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

     //    announcement-generate execution    //

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

     /**

      * Generate the template

      *

      * @throws MojoExecutionException

      */

     public void execute()

         throws MojoExecutionException

     {

         // Run only at the execution root

         if ( runOnlyAtExecutionRoot && !isThisTheExecutionRoot() )

         {

             getLog().info( "Skipping the announcement generation in this project because it's not the Execution Root" );

         }

         else

         {

             if ( issueManagementSystems == null )

             {

                 issueManagementSystems = new ArrayList<String>();

             }

             // Handle deprecated parameters, in a backward compatible way

             if ( issueManagementSystems.isEmpty() )

             {

                 if ( this.jiraMerge )

                 {

                     issueManagementSystems.add( CHANGES_XML );

                     issueManagementSystems.add( JIRA );

                 }

                 else if ( generateJiraAnnouncement )

                 {

                     issueManagementSystems.add( JIRA );

                 }

                 else

                 {

                     issueManagementSystems.add( CHANGES_XML );

                 }

             }

             // Fetch releases from the configured issue management systems

             List<Release> releases = null;

             if ( issueManagementSystems.contains( CHANGES_XML ) )

             {

                 if ( getXmlPath().exists() )

                 {

                     ChangesXML changesXML = new ChangesXML( getXmlPath(), getLog() );

                     List<Release> changesReleases = releaseUtils.convertReleaseList( changesXML.getReleaseList() );

                     releases = releaseUtils.mergeReleases( releases, changesReleases );

                     getLog().info( "Including issues from file " + getXmlPath() + " in announcement..." );

                 }

                 else

                 {

                     getLog().warn( "changes.xml file " + getXmlPath().getAbsolutePath() + " does not exist." );

                 }

             }

             if ( issueManagementSystems.contains( JIRA ) )

             {

                 if ( ProjectUtils.validateIfIssueManagementComplete( project, JIRA, "JIRA announcement", getLog() ) )

                 {

                     List<Release> jiraReleases = getJiraReleases();

                     releases = releaseUtils.mergeReleases( releases, jiraReleases );

                     getLog().info( "Including issues from JIRA in announcement..." );

                 }

                 else

                 {

                     throw new MojoExecutionException(

                         "Something is wrong with the Issue Management section." + " See previous error messages." );

                 }

             }

             if ( issueManagementSystems.contains( TRAC ) )

             {

                 if ( ProjectUtils.validateIfIssueManagementComplete( project, TRAC, "Trac announcement", getLog() ) )

                 {

                     List<Release> tracReleases = getTracReleases();

                     releases = releaseUtils.mergeReleases( releases, tracReleases );

                     getLog().info( "Including issues from Trac in announcement..." );

                 }

                 else

                 {

                     throw new MojoExecutionException(

                         "Something is wrong with the Issue Management section." + " See previous error messages." );

                 }

             }

             // @todo Add more issue management systems here.

             // Follow these steps:

             // 1. Add a constant for the name of the issue management system

             // 2. Add the @parameters needed to configure the issue management system

             // 3. Add a protected List get<IMSname>Releases() method that retrieves a list of releases

             // 4. Merge those releases into the "releases" variable

             // For help with these steps, you can have a look at how this has been done for JIRA or Trac

             // Generate the report

             if ( releases == null || releases.isEmpty() )

             {

                 throw new MojoExecutionException(

                     "No releases found in any of the configured issue management systems." );

             }

             else

             {

                 doGenerate( releases );

             }

         }

     }

     /**

      * Add the parameters to velocity context

      *

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

      * @throws MojoExecutionException

      */

     public void doGenerate( List<Release> releases )

         throws MojoExecutionException

     {

         String version = ( versionPrefix == null ? "" : versionPrefix ) + getVersion();

         doGenerate( releases, releaseUtils.getLatestRelease( releases, version )  );

     }

     protected void doGenerate( List<Release> releases, Release release )

         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", release );

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

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

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

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

             context.put( "project", project );

             if ( announceParameters == null )

             {

                 // empty Map to prevent NPE in velocity execution

                 context.put( "announceParameters", Collections.EMPTY_MAP );

             }

             else

             {

                 context.put( "announceParameters", announceParameters );

             }

             processTemplate( context, getOutputDirectory(), template, announcementFile );

         }

         catch ( ResourceNotFoundException rnfe )

         {

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

         }

         catch ( VelocityException ve )

         {

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

         }

     }

     /**

      * 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

      * @param announcementFile The file name of the generated announcement

      * @throws ResourceNotFoundException, VelocityException, IOException

      */

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

         throws ResourceNotFoundException, VelocityException, MojoExecutionException

     {

         File f;

         // Use the name of the template as a default value

         if ( StringUtils.isEmpty( announcementFile ) )

         {

             announcementFile = template;

         }

         try

         {

             f = new File( outputDirectory, announcementFile );

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

             {

                 f.getParentFile().mkdirs();

             }

             VelocityEngine engine = velocity.getEngine();

             engine.setApplicationAttribute( "baseDirectory", basedir );

             if ( StringUtils.isEmpty( templateEncoding ) )

             {

                 templateEncoding =  ReaderFactory.FILE_ENCODING;

                 getLog().warn(

                                "File encoding has not been set, using platform encoding " + templateEncoding

                                    + ", i.e. build is platform dependent!" );

             }

             Writer writer = new OutputStreamWriter( new FileOutputStream( f ), templateEncoding );

             Template velocityTemplate = engine.getTemplate( templateDirectory + "/" + template, templateEncoding );

             velocityTemplate.merge( 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() );

         }

     }

     protected List<Release> getJiraReleases()

         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 );

         jiraDownloader.setFilter( filter );

         jiraDownloader.setJiraUser( jiraUser );

         jiraDownloader.setJiraPassword( jiraPassword );

         jiraDownloader.setWebUser( webUser );

         jiraDownloader.setWebPassword( webPassword );

         try

         {

             jiraDownloader.doExecute();

             List<Issue> issueList = jiraDownloader.getIssueList();

             if ( StringUtils.isNotEmpty( versionPrefix ) )

             {

                 int originalNumberOfIssues = issueList.size();

                 issueList = IssueUtils.filterIssuesWithVersionPrefix( issueList, versionPrefix );

                 getLog().debug( "Filtered out " + issueList.size() + " issues of " + originalNumberOfIssues

                     + " that matched the versionPrefix '" + versionPrefix + "'." );

             }

             return getReleases( issueList );

         }

         catch ( Exception e )

         {

             throw new MojoExecutionException( "Failed to extract issues from JIRA.", e );

         }

     }

     private List<Release> getReleases( List<Issue> issues )

     {

         if ( issues.isEmpty() )

         {

             return Collections.emptyList();

         }

         else

         {

             return IssueAdapter.getReleases( issues );

         }

     }

     protected List<Release> getTracReleases()

         throws MojoExecutionException

     {

         TracDownloader issueDownloader = new TracDownloader();

         issueDownloader.setProject( project );

         issueDownloader.setQuery( tracQuery );

         issueDownloader.setTracPassword( tracPassword );

         issueDownloader.setTracUser( tracUser );

         try

         {

             return getReleases( issueDownloader.getIssueList() );

         }

         catch ( Exception e )

         {

             throw new MojoExecutionException( "Failed to extract issues from Trac.", e );

         }

     }

     /*

      * accessors

      */

     public String getArtifactId()

     {

         return artifactId;

     }

     public void setArtifactId( String artifactId )

     {

         this.artifactId = artifactId;

     }

     public String getDevelopmentTeam()

     {

         return developmentTeam;

     }

     public void setDevelopmentTeam( String developmentTeam )

     {

         this.developmentTeam = developmentTeam;

     }

     public String getFinalName()

     {

         return finalName;

     }

     public void setFinalName( String finalName )

     {

         this.finalName = finalName;

     }

     public String getGroupId()

     {

         return groupId;

     }

     public void setGroupId( String groupId )

     {

         this.groupId = groupId;

     }

     public String getIntroduction()

     {

         return introduction;

     }

     public void setIntroduction( String introduction )

     {

         this.introduction = introduction;

     }

     public File getOutputDirectory()

     {

         return outputDirectory;

     }

     public void setOutputDirectory( File outputDirectory )

     {

         this.outputDirectory = outputDirectory;

     }

     public String getPackaging()

     {

         return packaging;

     }

     public void setPackaging( String packaging )

     {

         this.packaging = packaging;

     }

     public String getUrl()

     {

         return url;

     }

     public void setUrl( String url )

     {

         this.url = url;

     }

     public String getUrlDownload()

     {

         return urlDownload;

     }

     public void setUrlDownload( String urlDownload )

     {

         this.urlDownload = urlDownload;

     }

     public VelocityComponent getVelocity()

     {

         return velocity;

     }

     public void setVelocity( VelocityComponent velocity )

     {

         this.velocity = velocity;

     }

     public String getVersion()

     {

         return version;

     }

     public void setVersion( String version )

     {

         this.version = version;

     }

     public ChangesXML getXml()

     {

         return xml;

     }

     public void setXml( ChangesXML xml )

     {

         this.xml = xml;

     }

     public File getXmlPath()

     {

         return xmlPath;

     }

     public void setXmlPath( File xmlPath )

     {

         this.xmlPath = xmlPath;

     }

 }