package org.apache.velocity.site.news.plugin;
   
   /*
    * 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.lang.reflect.Method;
  import java.util.Iterator;
  import java.util.List;
  import java.util.Locale;
  import java.util.ResourceBundle;
  
  import org.apache.maven.doxia.parser.Parser;
  import org.apache.maven.doxia.siterenderer.Renderer;
  import org.apache.maven.project.MavenProject;
  import org.apache.maven.reporting.AbstractMavenReport;
  import org.apache.maven.reporting.MavenReport;
  import org.apache.maven.reporting.MavenReportException;
  import org.apache.velocity.site.news.NewsReport;
  import org.apache.velocity.site.news.VelocityNewsException;
  import org.apache.velocity.site.news.VelocityNewsUtils;
  import org.apache.velocity.site.news.model.Item;
  import org.apache.velocity.site.news.model.NewsManager;
  import org.apache.velocity.site.news.model.NewsModel;
  import org.apache.velocity.site.plexus.PlexusKludgeException;
  import org.apache.velocity.site.plexus.PlexusKludgeUtils;
  import org.codehaus.plexus.PlexusConstants;
  import org.codehaus.plexus.PlexusContainer;
  import org.codehaus.plexus.component.repository.exception.ComponentLookupException;
  import org.codehaus.plexus.context.Context;
  import org.codehaus.plexus.context.ContextException;
  import org.codehaus.plexus.personality.plexus.lifecycle.phase.Contextualizable;
  
  /**
   * Report news items for the site.
   *
   * @author <a href="mailto:henning@apache.org">Henning P. Schmiedehausen</a>
   * @version $Revision: 526767 $
   *
   * @goal news
   */
  public class VelocityNewsReport extends AbstractMavenReport implements MavenReport, NewsReport, NewsFeed, Contextualizable
  {
  
      /**
       * @component
       * @required
       * @readonly
       */
      private Renderer siteRenderer;
  
      /**
       * @component role-hint="apt"
       * @required
       * @readonly
       */
      private Parser aptParser;
  
      /**
       * Specifies the directory where the report will be generated
       *
       * @parameter default-value="${project.reporting.outputDirectory}"
       * @required
       */
      private File outputDirectory;
  
      /**
       * The Maven Project Object
       *
       * @parameter default-value="${project}"
       * @required
       * @readonly
       */
      private MavenProject project;
  
      /**
       * Configuration of the base URL of the feed
       *
       * @parameter expression="${baseUrl}"
       * @required
       */
      private String baseUrl;
  
     protected PlexusContainer container = null;
 
     public void contextualize(final Context context) throws ContextException
     {
         this.container = (PlexusContainer) context.get(PlexusConstants.PLEXUS_KEY);
     }
 
     /**
      * @see org.apache.maven.reporting.AbstractMavenReport#getOutputDirectory()
      */
     public String getOutputDirectory()
     {
         return outputDirectory.getAbsolutePath();
     }
 
     /**
      * @see org.apache.maven.reporting.AbstractMavenReport#getProject()
      */
     public MavenProject getProject()
     {
         return project;
     }
 
     /**
      * @see org.apache.maven.reporting.AbstractMavenReport#getSiteRenderer()
      */
     protected Renderer getSiteRenderer()
     {
         return siteRenderer;
     }
 
     /**
      * @see org.apache.maven.reporting.MavenReport#getOutputName()
      */
     public String getOutputName()
     {
         try
         {
             Object newsManager = getNewsManager();
             Method newsFileNameMethod = newsManager.getClass().getMethod(NewsManager.NEWS_FILE_NAME_METHOD, new Class[] {});
             return (String) newsFileNameMethod.invoke(newsManager, new Object[] {});
         }
         catch (RuntimeException re)
         {
             throw re;
         }
         catch (Exception e)
         {
             throw new IllegalStateException("Could not retrieve page name from model!");
         }
     }
 
     public ResourceBundle getBundle(final Locale locale)
     {
         return ResourceBundle.getBundle("velocity-news-report", locale, VelocityNewsReport.class.getClassLoader());
     }
 
     /**
      * @see org.apache.maven.reporting.MavenReport#getDescription(java.util.Locale)
      */
     public String getDescription(final Locale locale)
     {
         return getBundle(locale).getString("report.news.description");
     }
 
     /**
      * @see org.apache.maven.reporting.MavenReport#getName(java.util.Locale)
      */
     public String getName(final Locale locale)
     {
         return getBundle(locale).getString("report.news.name");
     }
 
     public String getBaseUrl()
     {
         return baseUrl;
     }
 
     public Parser getAptParser()
     {
         return aptParser;
     }
 
     protected void executeReport(final Locale locale) throws MavenReportException
     {
 
         try
         {
 
             Object newsManager = getNewsManager();
             Method newsModelMethod = newsManager.getClass().getMethod(NewsManager.NEWS_MODEL_METHOD, new Class[] {});
             NewsModel newsModel = (NewsModel) newsModelMethod.invoke(newsManager, new Object[] {});
 
             if (newsModel != null)
             {
                 generateNewsPage(newsModel, locale);
                 generateNewsRssFeed(newsModel);
             }
 
         }
         catch (RuntimeException re)
         {
             throw re;
         }
         catch (Exception e)
         {
             throw new MavenReportException("While generating report: ", e);
         }
     }
 
     private void generateNewsPage(final NewsModel newsModel, final Locale locale) throws VelocityNewsException
     {
 
         NewsPageGenerator newsPageGenerator = new NewsPageGenerator(this, locale);
 
         newsPageGenerator.openPage();
         newsPageGenerator.displayHeader();
 
         List items = VelocityNewsUtils.sortItemsByReverseDate(newsModel.getItems());
 
         for (Iterator it = items.iterator(); it.hasNext();)
         {
             Item newsItem = (Item) it.next();
             newsPageGenerator.displayItem(newsItem);
         }
 
         newsPageGenerator.closePage();
     }
 
     private void generateNewsRssFeed(final NewsModel newsModel) throws VelocityNewsException
     {
         String outputDirectory = getOutputDirectory();
 
         if (outputDirectory == null)
         {
             throw new VelocityNewsException("No output directory specified!");
         }
 
         NewsFeedGenerator newsFeedGenerator = new NewsFeedGenerator(this);
 
         newsFeedGenerator.openFeed();
 
         List items = VelocityNewsUtils.sortItemsByReverseDate(newsModel.getItems());
 
         for (Iterator it = items.iterator(); it.hasNext();)
         {
             Item newsItem = (Item) it.next();
             newsFeedGenerator.publishItem(newsItem);
         }
 
         newsFeedGenerator.publishFeed();
     }
 
     /**
      * Returns the News Manager.
      *
      * It must be injected into an instance of this component.
      *
      * @return A {@link DoxiaVelocityContextFactory} instance that generates
      *         {@link VelocityContext} objects for the render process.
      */
     private Object getNewsManager() throws ComponentLookupException
     {
         try
         {
             PlexusContainer velocityContainer = PlexusKludgeUtils.lookupContainer(container,
                     VelocityNewsPlugin.CONTAINER_LOOKUP_NAME);
             return velocityContainer.lookup(NewsManager.ROLE);
         }
         catch (PlexusKludgeException pke)
         {
             throw new ComponentLookupException("While retrieving News Manager: ", pke);
         }
     }
 }