package org.apache.maven.plugin.doap;

 /*

  * 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.text.DateFormat;

 import java.util.ArrayList;

 import java.util.Date;

 import java.util.HashMap;

 import java.util.Iterator;

 import java.util.List;

 import java.util.Locale;

 import java.util.Map;

 import org.apache.maven.model.Contributor;

 import org.apache.maven.model.Developer;

 import org.codehaus.plexus.i18n.I18N;

 import org.codehaus.plexus.util.StringUtils;

 import org.codehaus.plexus.util.xml.XMLWriter;

 import org.codehaus.plexus.util.xml.XmlWriterUtil;

 /**

  * Utility class for DOAP mojo.

  *

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

  * @version $Id: org.apache.maven.plugin.doap.DoapUtil.html 815332 2012-05-01 21:25:03Z hboutemy $

  * @since 1.0

  */

 public class DoapUtil

 {

     /** Magic number to repeat '=' */

     private static final int REPEAT_EQUALS = 21;

     /** RDF resource attribute */

     protected static final String RDF_RESOURCE = "rdf:resource";

     /**

      * Write comments in the DOAP file header

      *

      * @param writer not null

      */

     public static void writeHeader( XMLWriter writer )

     {

         XmlWriterUtil.writeLineBreak( writer );

         XmlWriterUtil.writeCommentLineBreak( writer );

         XmlWriterUtil.writeComment( writer, StringUtils.repeat( "=", REPEAT_EQUALS ) + " - DO NOT EDIT THIS FILE! - "

             + StringUtils.repeat( "=", REPEAT_EQUALS ) );

         XmlWriterUtil.writeCommentLineBreak( writer );

         XmlWriterUtil.writeComment( writer, " " );

         XmlWriterUtil.writeComment( writer, "Any modifications will be overwritten." );

         XmlWriterUtil.writeComment( writer, " " );

         DateFormat dateFormat = DateFormat.getDateTimeInstance( DateFormat.SHORT, DateFormat.SHORT, Locale.US );

         XmlWriterUtil.writeComment( writer, "Generated by Maven Doap Plugin on "

             + dateFormat.format( new Date( System.currentTimeMillis() ) ) );

         XmlWriterUtil.writeComment( writer, "See: http://maven.apache.org/plugins/maven-doap-plugin/" );

         XmlWriterUtil.writeComment( writer, " " );

         XmlWriterUtil.writeCommentLineBreak( writer );

         XmlWriterUtil.writeLineBreak( writer );

     }

     /**

      * @param writer not null

      * @param name not null

      * @param value could be null. In this case, the element is not written.

      * @throws IllegalArgumentException if name is null or empty

      */

     public static void writeElement( XMLWriter writer, String name, String value )

         throws IllegalArgumentException

     {

         if ( StringUtils.isEmpty( name ) )

         {

             throw new IllegalArgumentException( "name should be defined" );

         }

         if ( value != null )

         {

             writer.startElement( name );

             writer.writeText( value );

             writer.endElement();

         }

     }

     /**

      * @param writer not null

      * @param name not null

      * @param lang not null

      * @param value could be null. In this case, the element is not written.

      * @throws IllegalArgumentException if name is null or empty

      */

     public static void writeElement( XMLWriter writer, String name, String value, String lang )

         throws IllegalArgumentException

     {

         if ( StringUtils.isEmpty( lang ) )

         {

             writeElement( writer, name, value );

             return;

         }

         if ( StringUtils.isEmpty( name ) )

         {

             throw new IllegalArgumentException( "name should be defined" );

         }

         if ( value != null )

         {

             writer.startElement( name );

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

             writer.writeText( value );

             writer.endElement();

         }

     }

     /**

      * @param writer not null

      * @param name not null

      * @param value could be null. In this case, the element is not written.

      * @throws IllegalArgumentException if name is null or empty

      */

     public static void writeRdfResourceElement( XMLWriter writer, String name, String value )

         throws IllegalArgumentException

     {

         if ( StringUtils.isEmpty( name ) )

         {

             throw new IllegalArgumentException( "name should be defined" );

         }

         if ( value != null )

         {

             writer.startElement( name );

             writer.addAttribute( RDF_RESOURCE, value );

             writer.endElement();

         }

     }

     /**

      * @param i18n the internationalization component

      * @param developersOrContributors list of <code>{@link Developer}/{@link Contributor}</code>

      * @return a none null list of developers or contributors which have a <code>developer</code> DOAP role.

      */

     public static List getDevelopersOrContributorsWithDeveloperRole( I18N i18n, List developersOrContributors )

     {

         return (List) filterDevelopersOrContributorsByDoapRoles( i18n, developersOrContributors ).get( "developers" );

     }

     /**

      * @param i18n the internationalization component

      * @param developersOrContributors list of <code>{@link Developer}/{@link Contributor}</code>

      * @return a none null list of developers or contributors which have a <code>documenter</code> DOAP role.

      */

     public static List getDevelopersOrContributorsWithDocumenterRole( I18N i18n, List developersOrContributors )

     {

         return (List) filterDevelopersOrContributorsByDoapRoles( i18n, developersOrContributors ).get( "documenters" );

     }

     /**

      * @param i18n the internationalization component

      * @param developersOrContributors list of <code>{@link Developer}/{@link Contributor}</code>

      * @return a none null list of developers or contributors which have an <code>helper</code> DOAP role.

      */

     public static List getDevelopersOrContributorsWithHelperRole( I18N i18n, List developersOrContributors )

     {

         return (List) filterDevelopersOrContributorsByDoapRoles( i18n, developersOrContributors ).get( "helpers" );

     }

     /**

      * @param i18n the internationalization component

      * @param developersOrContributors list of <code>{@link Developer}/{@link Contributor}</code>

      * @return a none null list of developers or contributors which have a <code>maintainer</code> DOAP role.

      */

     public static List getDevelopersOrContributorsWithMaintainerRole( I18N i18n, List developersOrContributors )

     {

         return (List) filterDevelopersOrContributorsByDoapRoles( i18n, developersOrContributors ).get( "maintainers" );

     }

     /**

      * @param i18n the internationalization component

      * @param developersOrContributors list of <code>{@link Developer}/{@link Contributor}</code>

      * @return a none null list of developers or contributors which have a <code>tester</code> DOAP role.

      */

     public static List getDevelopersOrContributorsWithTesterRole( I18N i18n, List developersOrContributors )

     {

         return (List) filterDevelopersOrContributorsByDoapRoles( i18n, developersOrContributors ).get( "testers" );

     }

     /**

      * @param i18n the internationalization component

      * @param developersOrContributors list of <code>{@link Developer}/{@link Contributor}</code>

      * @return a none null list of developers or contributors which have a <code>translator</code> DOAP role.

      */

     public static List getDevelopersOrContributorsWithTranslatorRole( I18N i18n, List developersOrContributors )

     {

         return (List) filterDevelopersOrContributorsByDoapRoles( i18n, developersOrContributors ).get( "translators" );

     }

     /**

      * @param i18n the internationalization component

      * @param developersOrContributors list of <code>{@link Developer}/{@link Contributor}</code>

      * @return a none null list of developers or contributors which have an <code>unknown</code> DOAP role.

      */

     public static List getDevelopersOrContributorsWithUnknownRole( I18N i18n, List developersOrContributors )

     {

         return (List) filterDevelopersOrContributorsByDoapRoles( i18n, developersOrContributors ).get( "unknowns" );

     }

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

     // Private methods

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

     /**

      * Filter the developers/contributors roles by the keys from {@link I18N#getBundle()}.

      * <br/>

      * I18N roles supported in DOAP, i.e. <code>maintainer</code>, <code>developer</code>, <code>documenter</code>,

      * <code>translator</code>, <code>tester</code>, <code>helper</code>.

      * <br/>

      * <b>Note:</b> Actually, only English keys are used.

      *

      * @param i18n i18n component

      * @param developersOrContributors list of <code>{@link Developer}/{@link Contributor}</code>

      * @return a none null map with <code>maintainers</code>, <code>developers</code>, <code>documenters</code>,

      * <code>translators</code>, <code>testers</code>, <code>helpers</code>, <code>unknowns</code> as keys and list of

      * <code>{@link Developer}/{@link Contributor}</code> as value.

      */

     private static Map filterDevelopersOrContributorsByDoapRoles( I18N i18n, List developersOrContributors )

     {

         Map returnMap = new HashMap( 7 );

         returnMap.put( "maintainers", new ArrayList() );

         returnMap.put( "developers", new ArrayList() );

         returnMap.put( "documenters", new ArrayList() );

         returnMap.put( "translators", new ArrayList() );

         returnMap.put( "testers", new ArrayList() );

         returnMap.put( "helpers", new ArrayList() );

         returnMap.put( "unknowns", new ArrayList() );

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

         {

             return returnMap;

         }

         for ( Iterator it = developersOrContributors.iterator(); it.hasNext(); )

         {

             Object obj = it.next();

             List roles;

             if ( Developer.class.isAssignableFrom( obj.getClass() ) )

             {

                 Developer developer = (Developer) obj;

                 roles = developer.getRoles();

             }

             else

             {

                 Contributor contributor = (Contributor) obj;

                 roles = contributor.getRoles();

             }

             if ( roles != null && roles.size() != 0 )

             {

                 for ( Iterator it2 = roles.iterator(); it2.hasNext(); )

                 {

                     String role = (String) it2.next();

                     role = role.toLowerCase( Locale.ENGLISH );

                     if ( role.indexOf( getLowerCaseString( i18n, "doap.maintainer" ) ) != -1 )

                     {

                         ( (List) returnMap.get( "maintainers" ) ).add( obj );

                     }

                     else if ( role.indexOf( getLowerCaseString( i18n, "doap.developer" ) ) != -1 )

                     {

                         ( (List) returnMap.get( "developers" ) ).add( obj );

                     }

                     else if ( role.indexOf( getLowerCaseString( i18n, "doap.documenter" ) ) != -1 )

                     {

                         ( (List) returnMap.get( "documenters" ) ).add( obj );

                     }

                     else if ( role.indexOf( getLowerCaseString( i18n, "doap.translator" ) ) != -1 )

                     {

                         ( (List) returnMap.get( "translators" ) ).add( obj );

                     }

                     else if ( role.indexOf( getLowerCaseString( i18n, "doap.tester" ) ) != -1 )

                     {

                         ( (List) returnMap.get( "testers" ) ).add( obj );

                     }

                     else if ( role.indexOf( getLowerCaseString( i18n, "doap.helper" ) ) != -1 )

                     {

                         ( (List) returnMap.get( "helpers" ) ).add( obj );

                     }

                     else

                     {

                         ( (List) returnMap.get( "unknowns" ) ).add( obj );

                     }

                 }

             }

             else

             {

                 ( (List) returnMap.get( "unknowns" ) ).add( obj );

             }

         }

         return returnMap;

     }

     /**

      * @param i18n not null

      * @param key not null

      * @return lower case value for the key in the i18n bundle.

      */

     private static String getLowerCaseString( I18N i18n, String key )

     {

         return i18n.getString( "doap-person", Locale.ENGLISH, key ).toLowerCase( Locale.ENGLISH );

     }

 }