* 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.

*/

* Generate a <a href="http://usefulinc.com/ns/doap">Description of a Project (DOAP)</a> file from the main information

* found in a POM. <br/>

* <b>Note</b>: The generated file is tailored for use by projects at <a

* href="http://projects.apache.org/doap.html">Apache</a>.

*

* @author Jason van Zyl

* @author <a href="mailto:vincent.siveton@gmail.com">Vincent Siveton</a>

* @version $Id$

* @since 1.0-beta-1

*/

    extends AbstractMojo

    /**

     * UTC Time Zone

     */

    private static final TimeZone UTC_TIME_ZONE = TimeZone.getTimeZone( "UTC" );

    /**

     * Date format for <lastUpdated/> tag in the repository metadata, i.e.: yyyyMMddHHmmss

     */

    private static final DateFormat REPOSITORY_DATE_FORMAT;

    /**

     * Date format for DOAP file, i.e. ISO-8601 YYYY-MM-DD

     */

    private static final DateFormat DOAP_DATE_FORMAT;

    static

    {

        REPOSITORY_DATE_FORMAT = new SimpleDateFormat( "yyyyMMddHHmmss", Locale.ENGLISH );

        REPOSITORY_DATE_FORMAT.setTimeZone( UTC_TIME_ZONE );

        DOAP_DATE_FORMAT = new SimpleDateFormat( "yyyy-MM-dd", Locale.ENGLISH );

        DOAP_DATE_FORMAT.setTimeZone( UTC_TIME_ZONE );

    }

    // ----------------------------------------------------------------------

    // Mojo components

    // ----------------------------------------------------------------------

    /**

     * Maven SCM Manager.

     *

     * @since 1.0

     */

    @Component

    private ScmManager scmManager;

    /**

     * Artifact factory.

     *

     * @since 1.0

     */

    @Component

    private ArtifactFactory artifactFactory;

    /**

     * Used to resolve artifacts.

     *

     * @since 1.0

     */

    @Component

    private RepositoryMetadataManager repositoryMetadataManager;

    /**

     * Internationalization component.

     *

     * @since 1.0

     */

    @Component

    private I18N i18n;

    // ----------------------------------------------------------------------

    // Mojo parameters

    // ----------------------------------------------------------------------

    /**

     * The POM from which information will be extracted to create a DOAP file.

     */

    @Parameter( defaultValue = "${project}", readonly = true, required = true )

    private MavenProject project;

    /**

     * The name of the DOAP file that will be generated.

     */

    @Parameter( property = "doapFile", defaultValue = "doap_${project.artifactId}.rdf", required = true )

    private String doapFile;

    /**

     * The output directory of the DOAP file that will be generated.

     *

     * @since 1.1

     */

    @Parameter( defaultValue = "${project.reporting.outputDirectory}", required = true )

    private String outputDirectory;

    /**

     * The local repository where the artifacts are located.

     *

     * @since 1.0

     */

    @Parameter( defaultValue = "${localRepository}", required = true, readonly = true )

    private ArtifactRepository localRepository;

    /**

     * The remote repositories where the artifacts are located.

     *

     * @since 1.0

     */

    @Parameter( defaultValue = "${project.remoteArtifactRepositories}", required = true, readonly = true )

    private List<ArtifactRepository> remoteRepositories;

    /**

     * Factory for creating artifact objects

     *

     * @since 1.1

     */

    @Component

    private ArtifactFactory factory;

    /**

     * Project builder

     *

     * @since 1.1

     */

    @Component

    private MavenProjectBuilder mavenProjectBuilder;

    /**

     * Used for resolving artifacts

     *

     * @since 1.1

     */

    @Component

    private ArtifactResolver resolver;

    /**

     * The current user system settings for use in Maven.

     *

     * @since 1.1

     */

    @Parameter( defaultValue = "${settings}", readonly = true, required = true )

    protected Settings settings;

    // ----------------------------------------------------------------------

    // Doap options

    // ----------------------------------------------------------------------

    /**

     * The category which should be displayed in the DOAP file.

     *

     * @deprecated Since 1.0. Instead of, configure

     *             <code>&lt;doapOptions&gt;&lt;category/&gt;&lt;/doapOptions&gt;</code> parameter.

     */

    @Parameter( property = "category" )

    private String category;

    /**

     * The programming language which should be displayed in the DOAP file.

     *

     * @deprecated Since 1.0. Instead of, configure

     *             <code>&lt;doapOptions&gt;&lt;programmingLanguage/&gt;&lt;/doapOptions&gt;</code> parameter.

     */

    @Parameter( property = "language" )

    private String language;

    /**

     * Specific DOAP parameters, i.e. options that POM doesn't have any notions. <br/>

     * Example:

     * <p/>

     * <pre>

     * &lt;doapOptions&gt;

     * &nbsp;&nbsp;&lt;programmingLanguage&gt;java&lt;/programmingLanguage&gt;

     * &lt;/doapOptions&gt;

     * </pre>

     * <p/>

     * <br/>

     * See <a href="./apidocs/org/apache/maven/plugin/doap/options/DoapOptions.html">Javadoc</a> <br/>

     *

     * @see <a href="http://usefulinc.com/ns/doap#">http://usefulinc.com/ns/doap#</a>

     * @since 1.0

     */

    @Parameter( property = "doapOptions" )

    private DoapOptions doapOptions;

    /**

     * Specific ASF extensions parameters, i.e. options that POM doesn't have any notions but required by ASF DOAP

     * requirements. <br/>

     * Example:

     * <p/>

     * <pre>

     * &lt;asfExtOptions&gt;

     * &nbsp;&nbsp;&lt;included&gt;true&lt;/included&gt;

     * &nbsp;&nbsp;&lt;charter&gt;The mission of the Apache XXX project is to create and maintain software

     * &nbsp;&nbsp;libraries that provide ...&lt;/charter&gt;

     * &nbsp;&nbsp;...

     * &lt;/asfExtOptions&gt;

     * </pre>

     * <p/>

     * <b>Note</b>: By default, <code>&lt;asfExtOptions&gt;&lt;included/&gt;&lt;/asfExtOptions&gt;</code> will be

     * automatically set to <code>true</code> if the project is hosted at ASF. <br/>

     * See <a href="./apidocs/org/apache/maven/plugin/doap/options/ASFExtOptions.html">Javadoc</a> <br/>

     *

     * @see <a href="http://svn.apache.org/repos/asf/infrastructure/site-tools/trunk/projects/asfext">

     *      http://svn.apache.org/repos/asf/infrastructure/site-tools/trunk/projects/asfext</a>

     * @see <a href="http://projects.apache.org/docs/pmc.html">http://projects.apache.org/docs/pmc.html</a>

     * @see <a href="http://projects.apache.org/docs/standards.html">http://projects.apache.org/docs/standards.html</a>

     * @see ASFExtOptionsUtil#isASFProject(MavenProject)

     * @since 1.0

     */

    @Parameter( property = "asfExtOptions" )

    private ASFExtOptions asfExtOptions;

    /**

     * The value for the <code>xml:lang</code> attribute used by the <code>&lt;rdf:RDF/&gt;<code>,

     * <code>&lt;description/&gt;</code> and <code>&lt;shortdesc/&gt;</code> elements. <br/>

     * POM doesn't have any notions about language. <br/>

     * See <a href="http://www.w3.org/TR/REC-xml/#sec-lang-tag">http://www.w3.org/TR/REC-xml/#sec-lang-tag</a> <br/>

     *

     * @since 1.0

     */

    @Parameter( property = "lang", defaultValue = "en", required = true )

    private String lang;

    /**

     * The <code>about</code> URI-reference which should be displayed in the DOAP file. Example:

     * <p/>

     * <pre>

     * &lt;rdf:RDF&gt;

     * &nbsp;&nbsp;&lt;Project rdf:about="http://maven.apache.org/"&gt;

     * &nbsp;&nbsp;...

     * &nbsp;&nbsp;&lt;/Project&gt;

     * &lt;/rdf:RDF&gt;

     * </pre>

     * <p/>

     * See <a href="http://www.w3.org/TR/1999/REC-rdf-syntax-19990222/#aboutAttr">

     * http://www.w3.org/TR/1999/REC-rdf-syntax-19990222/#aboutAttr</a> <br/>

     *

     * @since 1.0

     */

    @Parameter( property = "about", defaultValue = "${project.url}" )

    private String about;

    /**

     * Flag to validate the generated DOAP.

     *

     * @since 1.1

     */

    @Parameter( defaultValue = "true" )

    private boolean validate;

    /**

     * An artifact to generate the DOAP file against. <br/>

     * Example:

     * <p/>

     * <pre>

     * &lt;artifact&gt;

     * &nbsp;&nbsp;&lt;groupId&gt;given-artifact-groupId&lt;/groupId&gt;

     * &nbsp;&nbsp;&lt;artifactId&gt;given-artifact-artifactId&lt;/artifactId&gt;

     * &nbsp;&nbsp;&lt;version&gt;given-artifact-version&lt;/version&gt;

     * &lt;/artifact&gt;

     * </pre>

     * <p/>

     * <br/>

     * See <a href="./apidocs/org/apache/maven/plugin/doap/options/DaopArtifact.html">Javadoc</a> <br/>

     *

     * @since 1.1

     */

    @Parameter

    private DoapArtifact artifact;

    /**

     * Specifies whether the DOAP generation should be skipped.

     *

     * @since 1.1

     */

    @Parameter( property = "maven.doap.skip", defaultValue = "false" )

    private boolean skip;

    /**

     * Extensions parameters. <br/>

     * Example:

     * <p/>

     * <pre>

     * &lt;extOptions&gt;

     * &nbsp;&lt;extOption&gt;

     * &nbsp;&nbsp;&nbsp;&lt;xmlnsPrefix&gt;labs&lt;/xmlnsPrefix&gt;

     * &nbsp;&nbsp;&nbsp;&lt;xmlnsNamespaceURI&gt;http://labs.apache.org/doap-ext/1.0#&lt;/xmlnsNamespaceURI&gt;

     * &nbsp;&nbsp;&nbsp;&lt;extensions&gt;

     * &nbsp;&nbsp;&nbsp;&nbsp;&lt;status&gt;active&lt;/status&gt;

     * &nbsp;&nbsp;&nbsp;&lt;/extensions&gt;

     * &nbsp;&lt;/extOption&gt;

     * &lt;/extOptions&gt;

     * </pre>

     * <p/>

     * See <a href="./apidocs/org/apache/maven/plugin/doap/options/ExtOptions.html">Javadoc</a> <br/>

     *

     * @since 1.1

     */

    @Parameter( property = "extOptions" )

    private ExtOptions[] extOptions;

    /**

     * All warn/error messages for the user.

     *

     * @since 1.1

     */

    private UserMessages messages = new UserMessages();

    // ----------------------------------------------------------------------

    // Public methods

    // ----------------------------------------------------------------------

    /**

     * {@inheritDoc}

     */

    public void execute()

        throws MojoExecutionException

    {

        if ( skip )

        {

            getLog().info( "Skipping DOAP generation" );

            return;

        }

        // single artifact

        if ( artifact != null )

        {

            MavenProject givenProject = getMavenProject( artifact );

            if ( givenProject != null )

            {

                File outDir = new File( outputDirectory );

                if ( !outDir.isAbsolute() )

                {

                    outDir = new File( project.getBasedir(), outputDirectory );

                }

                File outFile = new File( outDir, artifact.getDoapFileName() );

                writeDoapFile( givenProject, outFile );

                return;

            }

        }

        // current project

        File outFile = new File( doapFile );

        if ( !outFile.isAbsolute() )

        {

            outFile = new File( project.getBasedir(), doapFile );

        }

        if ( !doapFile.replaceAll( "\\\\", "/" ).contains( "/" ) )

        {

            File outDir = new File( outputDirectory );

            if ( !outDir.isAbsolute() )

            {

                outDir = new File( project.getBasedir(), outputDirectory );

            }

            outFile = new File( outDir, doapFile );

        }

        writeDoapFile( project, outFile );

    }

    // ----------------------------------------------------------------------

    // Private methods

    // ----------------------------------------------------------------------

    /**

     * @param artifact not null

     * @return the maven project for the given doap artifact

     * @since 1.1

     */

    private MavenProject getMavenProject( DoapArtifact artifact )

    {

        if ( artifact == null )

        {

            return null;

        }

        if ( StringUtils.isEmpty( artifact.getGroupId() ) || StringUtils.isEmpty( artifact.getArtifactId() )

            || StringUtils.isEmpty( artifact.getVersion() ) )

        {

            getLog().warn( "Missing groupId or artifactId or version in <artifact/> parameter, ignored it." );

            return null;

        }

        getLog().info(

            "Using artifact " + artifact.getGroupId() + ":" + artifact.getArtifactId() + ":" + artifact.getVersion() );

        try

        {

            Artifact art =

                factory.createProjectArtifact( artifact.getGroupId(), artifact.getArtifactId(), artifact.getVersion(),

                                               Artifact.SCOPE_COMPILE );

            if ( art.getFile() == null )

            {

                MavenProject proj = mavenProjectBuilder.buildFromRepository( art, remoteRepositories, localRepository );

                art = proj.getArtifact();

                resolver.resolve( art, remoteRepositories, localRepository );

                return proj;

            }

        }

        catch ( ArtifactResolutionException e )

        {

            getLog().error( "ArtifactResolutionException: " + e.getMessage() + "\nIgnored <artifact/> parameter." );

        }

        catch ( ArtifactNotFoundException e )

        {

            getLog().error( "ArtifactNotFoundException: " + e.getMessage() + "\nIgnored <artifact/> parameter." );

        }

        catch ( ProjectBuildingException e )

        {

            getLog().error( "ProjectBuildingException: " + e.getMessage() + "\nIgnored <artifact/> parameter." );

        }

        return null;

    }

    /**

     * Write a doap file for the given project.

     *

     * @param project    not null

     * @param outputFile not null

     * @since 1.1

     */

    private void writeDoapFile( MavenProject project, File outputFile )

        throws MojoExecutionException

    {

        // ----------------------------------------------------------------------------

        // Includes ASF extensions

        // ----------------------------------------------------------------------------

        if ( !asfExtOptions.isIncluded() && ASFExtOptionsUtil.isASFProject( project ) )

        {

            getLog().info( "This project is an ASF project, ASF Extensions to DOAP will be added." );

            asfExtOptions.setIncluded( true );

        }

        // ----------------------------------------------------------------------------

        // setup pretty print xml writer

        // ----------------------------------------------------------------------------

        Writer w;

        try

        {

            if ( !outputFile.getParentFile().exists() )

            {

                FileUtils.mkdir( outputFile.getParentFile().getAbsolutePath() );

            }

            w = WriterFactory.newXmlWriter( outputFile );

        }

        catch ( IOException e )

        {

            throw new MojoExecutionException( "Error creating DOAP file " + outputFile.getAbsolutePath(), e );

        }

        if ( asfExtOptions.isIncluded() )

        {

            getLog().info( "Generating an ASF DOAP file " + outputFile.getAbsolutePath() );

        }

        else

        {

            getLog().info( "Generating a pure DOAP file " + outputFile.getAbsolutePath() );

        }

        XMLWriter writer = new PrettyPrintXMLWriter( w, project.getModel().getModelEncoding(), null );

        // ----------------------------------------------------------------------------

        // Convert POM to DOAP

        // ----------------------------------------------------------------------------

        DoapUtil.writeHeader( writer );

        // Heading

        DoapUtil.writeStartElement( writer, "rdf", "RDF" );

        if ( Arrays.binarySearch( Locale.getISOLanguages(), lang ) < 0 )

        {

            messages.addMessage( new String[]{ "doapOptions", "lang" }, lang, UserMessages.INVALID_ISO_DATE );

            throw new MojoExecutionException( messages.getErrorMessages().get( 0 ) );

        }

        writer.addAttribute( "xml:lang", lang );

        if ( StringUtils.isEmpty( doapOptions.getXmlnsNamespaceURI() ) )

        {

            messages.addMessage( new String[]{ "doapOptions", "xmlnsNamespaceURI" }, null, UserMessages.REQUIRED );

            throw new MojoExecutionException( messages.getErrorMessages().get( 0 ) );

        }

        writer.addAttribute(

            "xmlns" + ( StringUtils.isEmpty( doapOptions.getXmlnsPrefix() ) ? "" : ":" + doapOptions.getXmlnsPrefix() ),

            doapOptions.getXmlnsNamespaceURI() );

        writer.addAttribute( "xmlns:rdf", "http://www.w3.org/1999/02/22-rdf-syntax-ns#" );

        writer.addAttribute( "xmlns:foaf", "http://xmlns.com/foaf/0.1/" );

        if ( asfExtOptions.isIncluded() )

        {

            if ( StringUtils.isEmpty( asfExtOptions.getXmlnsPrefix() ) )

            {

                messages.addMessage( new String[]{ "doapOptions", "xmlnsPrefix" }, null, UserMessages.REQUIRED );

                throw new MojoExecutionException( messages.getErrorMessages().get( 0 ) );

            }

            if ( StringUtils.isEmpty( asfExtOptions.getXmlnsNamespaceURI() ) )

            {

                messages.addMessage( new String[]{ "doapOptions", "xmlnsNamespaceURI" }, null, UserMessages.REQUIRED );

            }

            writer.addAttribute( "xmlns" + ( StringUtils.isEmpty( asfExtOptions.getXmlnsPrefix() )

                ? ""

                : ":" + asfExtOptions.getXmlnsPrefix() ), asfExtOptions.getXmlnsNamespaceURI() );

        }

        if ( extOptions != null && extOptions.length > 0 && !extOptions[0].getExtensions().isEmpty() )

        {

            for ( ExtOptions extOption : extOptions )

            {

                if ( StringUtils.isEmpty( extOption.getXmlnsPrefix() ) )

                {

                    messages.addMessage( new String[]{ "extOptions", "extOption", "xmlnsPrefix" }, null,

                                         UserMessages.REQUIRED );

                    throw new MojoExecutionException( messages.getErrorMessages().get( 0 ) );

                }

                if ( StringUtils.isEmpty( extOption.getXmlnsNamespaceURI() ) )

                {

                    messages.addMessage( new String[]{ "extOptions", "extOption", "xmlnsNamespaceURI" }, null,

                                         UserMessages.REQUIRED );

                    throw new MojoExecutionException( messages.getErrorMessages().get( 0 ) );

                }

                writer.addAttribute( "xmlns" + ( StringUtils.isEmpty( extOption.getXmlnsPrefix() )

                    ? ""

                    : ":" + extOption.getXmlnsPrefix() ), extOption.getXmlnsNamespaceURI() );

            }

        }

        // Project

        DoapUtil.writeStartElement( writer, doapOptions.getXmlnsPrefix(), "Project" );

        boolean added = false;

        if ( artifact != null )

        {

            String about_ = project.getUrl();

            if ( StringUtils.isNotEmpty( about_ ) )

            {

                try

                {

                    new URL( about_ );

                    writer.addAttribute( "rdf:about", about_ );

                    added = true;

                }

                catch ( MalformedURLException e )

                {

                }

            }

            if ( !added )

            {

                messages.getWarnMessages().add( "The project's url defined from " + artifact.toConfiguration()

                                                    + " is empty or not a valid URL, using <about/> parameter." );

            }

        }

        if ( !added )

        {

            if ( StringUtils.isNotEmpty( about ) )

            {

                try

                {

                    new URL( about );

                    writer.addAttribute( "rdf:about", about );

                }

                catch ( MalformedURLException e )

                {

                    messages.addMessage( new String[]{ "about" }, about, UserMessages.INVALID_URL );

                }

                added = true;

            }

        }

        if ( !added )

        {

            messages.addMessage( new String[]{ "about" }, null, UserMessages.RECOMMENDED );

        }

        // name

        writeName( writer, project );

        // description

        writeDescription( writer, project );

        // implements

        writeImplements( writer );

        // Audience

        writeAudience( writer );

        // Vendor

        writeVendor( writer, project );

        // created

        writeCreated( writer, project );

        // homepage and old-homepage

        writeHomepage( writer, project );

        // Blog

        writeBlog( writer );

        // licenses

        writeLicenses( writer, project );

        // programming-language

        writeProgrammingLanguage( writer, project );

        // category

        writeCategory( writer, project );

        // os

        writeOS( writer, project );

        // Plateform

        writePlateform( writer );

        // Language

        writeLanguage( writer );

        // SCM

        writeSourceRepositories( writer, project );

        // bug-database

        writeBugDatabase( writer, project );

        // mailing list

        writeMailingList( writer, project );

        // download-page and download-mirror

        writeDownloadPage( writer, project );

        // screenshots

        writeScreenshots( writer, project );

        // service-endpoint

        writeServiceEndpoint( writer );

        // wiki

        writeWiki( writer, project );

        // Releases

        writeReleases( writer, project );

        // Developers

        List<Contributor> developers = project.getDevelopers();

        writeContributors( writer, developers );

        // Contributors

        List<Contributor> contributors = project.getContributors();

        writeContributors( writer, contributors );

        // Extra DOAP

        Map<Object, String> map = doapOptions.getExtra();

        writeExtra( writer, project, "Extra DOAP vocabulary.", map, doapOptions.getXmlnsPrefix() );

        // ASFext

        writeASFext( writer, project );

        // Extra extensions

        writeExtensions( writer );

        writer.endElement(); // Project

        writeOrganizations( writer );

        writer.endElement(); // rdf:RDF

        try

        {

            w.close();

        }

        catch ( IOException e )

        {

            throw new MojoExecutionException( "Error when closing the writer.", e );

        }

        if ( !messages.getWarnMessages().isEmpty() )

        {

            for ( String warn : messages.getWarnMessages() )

            {

                getLog().warn( warn );

            }

        }

        if ( !messages.getErrorMessages().isEmpty() )

        {

            getLog().error( "" );

            for ( String error : messages.getErrorMessages() )

            {

                getLog().error( error );

            }

            getLog().error( "" );

            if ( ASFExtOptionsUtil.isASFProject( project ) )

            {

                getLog().error(

                    "For more information about the errors and possible solutions, please read the plugin documentation:" );

                getLog().error( "http://maven.apache.org/plugins/maven-doap-plugin/usage.html#DOAP_ASF_Configuration" );

                throw new MojoExecutionException( "The generated DOAP doesn't respect ASF rules, see above." );

            }

        }

        if ( validate )

        {

            List<String> errors = DoapUtil.validate( outputFile );

            if ( !errors.isEmpty() )

            {

                getLog().error( "" );

                for ( String error : errors )

                {

                    getLog().error( error );

                }

                getLog().error( "" );

                throw new MojoExecutionException( "Error parsing the generated DOAP file, see above." );

            }