org.apache.wiki.plugin.WeblogArchivePlugin Maven / Gradle / Ivy

Go to download
/*
    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.
 */
package org.apache.wiki.plugin;

import org.apache.wiki.api.core.Context;
import org.apache.wiki.api.core.ContextEnum;
import org.apache.wiki.api.core.Engine;
import org.apache.wiki.api.core.Page;
import org.apache.wiki.api.exceptions.PluginException;
import org.apache.wiki.api.plugin.Plugin;
import org.apache.wiki.util.TextUtil;

import java.text.SimpleDateFormat;
import java.util.Calendar;
import java.util.Collection;
import java.util.Comparator;
import java.util.Date;
import java.util.List;
import java.util.Map;
import java.util.SortedSet;
import java.util.TreeSet;

/**
 *  Creates a list of all weblog entries on a monthly basis.
 *
 *  Parameters : 
 *  
 *  page - the page name
 *  
 *
 *  @since 1.9.21
 */
public class WeblogArchivePlugin implements Plugin {

    /** Parameter name for setting the page.  Value is {@value}. */
    public static final String PARAM_PAGE = "page";

    private SimpleDateFormat m_monthUrlFormat;

    /**
     *  {@inheritDoc}
     */
    @Override
    public String execute( final Context context, final Map< String, String > params ) throws PluginException {
        final Engine engine = context.getEngine();

        //  Parameters
        String weblogName = params.get( PARAM_PAGE );

        if( weblogName == null ) {
            weblogName = context.getPage().getName();
        }

        final String pttrn = "'" + context.getURL( ContextEnum.PAGE_VIEW.getRequestContext(), weblogName,"weblog.startDate='ddMMyy'&weblog.days=%d" ) + "'";
        m_monthUrlFormat = new SimpleDateFormat( pttrn );

        final StringBuilder sb = new StringBuilder();
        sb.append( "\n" );

        //  Collect months that have blog entries
        final Collection< Calendar > months = collectMonths( engine, weblogName );
        int year = 0;

        //  Output proper HTML.
        sb.append( "\n" );

        if(!months.isEmpty()) {
            year = ( months.iterator().next() ).get( Calendar.YEAR );
            sb.append( "" ).append( year ).append( "\n" );
        }

        for( final Calendar cal : months ) {
            if( cal.get( Calendar.YEAR ) != year ) {
                year = cal.get( Calendar.YEAR );
                sb.append( "" ).append( year ).append( "\n" );
            }
            sb.append( "  " );
            sb.append( getMonthLink( cal ) );
            sb.append( "\n" );
        }

        sb.append( "\n" );
        sb.append( "\n" );
        return sb.toString();
    }

    private SortedSet< Calendar > collectMonths( final Engine engine, final String page ) {
        final Comparator< Calendar > comp = new ArchiveComparator();
        final TreeSet res = new TreeSet<>( comp );

        final WeblogPlugin pl = new WeblogPlugin();

        final List< Page > blogEntries = pl.findBlogEntries( engine, page, new Date(0L), new Date() );

        for( final Page p : blogEntries ) {
            // FIXME: Not correct, should parse page creation time.
            final Date d = p.getLastModified();
            final Calendar cal = Calendar.getInstance();
            cal.setTime( d );
            res.add( cal );
        }

        return res;
    }

    private String getMonthLink( final Calendar day )
    {
        final SimpleDateFormat monthfmt = new SimpleDateFormat( "MMMM" );
        final String result;

        if( m_monthUrlFormat == null ) {
            result = monthfmt.format( day.getTime() );
        } else {
            final Calendar cal = (Calendar)day.clone();
            final int firstDay = cal.getActualMinimum( Calendar.DATE );
            final int lastDay  = cal.getActualMaximum( Calendar.DATE );

            cal.set( Calendar.DATE, lastDay );
            String url = m_monthUrlFormat.format( cal.getTime() );

            url = TextUtil.replaceString( url, "%d", Integer.toString( lastDay-firstDay+1 ) );

            result = ""+monthfmt.format(cal.getTime())+"";
        }

        return result;

    }


    /**
     * This is a simple comparator for ordering weblog archive entries.
     * Two dates in the same month are considered equal.
     */
    private static class ArchiveComparator implements Comparator< Calendar > {

        @Override
        public int compare( final Calendar a, final Calendar b ) {
            if( a == null || b == null ) {
                throw new ClassCastException( "Invalid calendar supplied for comparison." );
            }

            if( a.get( Calendar.YEAR ) == b.get( Calendar.YEAR ) && a.get( Calendar.MONTH ) == b.get( Calendar.MONTH ) ) {
                return 0;
            }

            //sort recent dates first
            return b.getTime().before( a.getTime() ) ? -1 : 1;
        }
    }

}