org.apache.wiki.plugin.RecentChangesPlugin Maven / Gradle / Ivy
/*
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.commons.lang3.StringUtils;
import org.apache.logging.log4j.LogManager;
import org.apache.logging.log4j.Logger;
import org.apache.wiki.WikiContext;
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.attachment.Attachment;
import org.apache.wiki.i18n.InternationalizationManager;
import org.apache.wiki.pages.PageManager;
import org.apache.wiki.preferences.Preferences;
import org.apache.wiki.preferences.Preferences.TimeFormat;
import org.apache.wiki.render.RenderingManager;
import org.apache.wiki.util.TextUtil;
import org.apache.wiki.util.XHTML;
import org.apache.wiki.util.XhtmlUtil;
import org.jdom2.Element;
import java.text.DateFormat;
import java.text.SimpleDateFormat;
import java.util.Calendar;
import java.util.Collection;
import java.util.Date;
import java.util.GregorianCalendar;
import java.util.Map;
/**
* Returns the Recent Changes in the wiki being a date-sorted list of page names.
*
* Parameters:
*
* - since - show changes from the last n days, for example since=5 shows only the pages that were changed in the last five days
* - format - (full|compact) : if "full", then display a long version with all possible info. If "compact", then be as compact as possible.
* - timeFormat - the time format to use, the default is "HH:mm:ss"
* - dateFormat - the date format to use, the default is "dd.MM.yyyy"
*
*/
public class RecentChangesPlugin extends AbstractReferralPlugin implements Plugin {
private static final Logger LOG = LogManager.getLogger( RecentChangesPlugin.class );
/** Parameter name for the separator format. Value is {@value}. */
public static final String PARAM_FORMAT = "format";
/** Parameter name for the separator timeFormat. Value is {@value}. */
public static final String PARAM_TIME_FORMAT = "timeFormat";
/** Parameter name for the separator dateFormat. Value is {@value}. */
public static final String PARAM_DATE_FORMAT = "dateFormat";
/** How many days we show by default. */
private static final int DEFAULT_DAYS = 100*365;
public static final String DEFAULT_TIME_FORMAT ="HH:mm:ss";
public static final String DEFAULT_DATE_FORMAT ="dd.MM.yyyy";
/**
* {@inheritDoc}
*/
@Override
public String execute( final Context context, final Map< String, String > params ) throws PluginException {
final int since = TextUtil.parseIntParameter( params.get( "since" ), DEFAULT_DAYS );
String spacing = "4";
boolean showAuthor = true;
boolean showChangenote = true;
String tablewidth = "4";
final Engine engine = context.getEngine();
//
// Which format we want to see?
//
if( "compact".equals( params.get( PARAM_FORMAT ) ) ) {
spacing = "0";
showAuthor = false;
showChangenote = false;
tablewidth = "2";
}
final Calendar sincedate = new GregorianCalendar();
sincedate.add( Calendar.DAY_OF_MONTH, -since );
LOG.debug("Calculating recent changes from "+sincedate.getTime());
// FIXME: Should really have a since date on the getRecentChanges method.
Collection< Page > changes = engine.getManager( PageManager.class ).getRecentChanges();
super.initialize( context, params );
changes = filterWikiPageCollection( changes );
if ( changes != null ) {
Date olddate = new Date( 0 );
final DateFormat fmt = getDateFormat( context, params );
final DateFormat tfmt = getTimeFormat( context, params );
final Element rt = XhtmlUtil.element( XHTML.table );
rt.setAttribute( XHTML.ATTR_class, "recentchanges" );
rt.setAttribute( XHTML.ATTR_cellpadding, spacing );
for( final Page pageref : changes ) {
final Date lastmod = pageref.getLastModified();
if( lastmod.before( sincedate.getTime() ) ) {
break;
}
if( !isSameDay( lastmod, olddate ) ) {
final Element row = XhtmlUtil.element( XHTML.tr );
final Element col = XhtmlUtil.element( XHTML.td );
col.setAttribute( XHTML.ATTR_colspan, tablewidth );
col.setAttribute( XHTML.ATTR_class, "date" );
col.addContent( XhtmlUtil.element( XHTML.b, fmt.format( lastmod ) ) );
rt.addContent( row );
row.addContent( col );
olddate = lastmod;
}
final String href = context.getURL( pageref instanceof Attachment ? ContextEnum.PAGE_ATTACH.getRequestContext()
: ContextEnum.PAGE_VIEW.getRequestContext(), pageref.getName() );
Element link = XhtmlUtil.link( href, engine.getManager( RenderingManager.class ).beautifyTitle( pageref.getName() ) );
final Element row = XhtmlUtil.element( XHTML.tr );
final Element col = XhtmlUtil.element( XHTML.td );
col.setAttribute( XHTML.ATTR_width, "30%" );
col.addContent( link );
//
// Add the direct link to the attachment info.
//
if( pageref instanceof Attachment ) {
link = XhtmlUtil.link( context.getURL( WikiContext.INFO, pageref.getName() ), null );
link.setAttribute( XHTML.ATTR_class, "infolink" );
final Element img = XhtmlUtil.img( context.getURL( WikiContext.NONE, "images/attachment_small.png" ), null );
link.addContent( img );
col.addContent( link );
}
row.addContent( col );
rt.addContent( row );
if( pageref instanceof Attachment ) {
final Element td = XhtmlUtil.element( XHTML.td, tfmt.format( lastmod ) );
td.setAttribute( XHTML.ATTR_class, "lastchange" );
row.addContent( td );
} else {
final Element infocol = XhtmlUtil.element( XHTML.td );
infocol.setAttribute( XHTML.ATTR_class, "lastchange" );
infocol.addContent( XhtmlUtil.link( context.getURL( WikiContext.DIFF, pageref.getName(), "r1=-1" ),
tfmt.format( lastmod ) ) );
row.addContent( infocol );
}
//
// Display author information.
//
if( showAuthor ) {
final String author = pageref.getAuthor();
final Element authorinfo = XhtmlUtil.element( XHTML.td );
authorinfo.setAttribute( XHTML.ATTR_class, "author" );
if( author != null ) {
if( engine.getManager( PageManager.class ).wikiPageExists( author ) ) {
authorinfo.addContent( XhtmlUtil.link( context.getURL( WikiContext.VIEW, author ), author ) );
} else {
authorinfo.addContent( author );
}
} else {
authorinfo.addContent( Preferences.getBundle( context, InternationalizationManager.CORE_BUNDLE )
.getString( "common.unknownauthor" ) );
}
row.addContent( authorinfo );
}
// Change note
if( showChangenote ) {
final String changenote = pageref.getAttribute( Page.CHANGENOTE );
final Element td_changenote = XhtmlUtil.element( XHTML.td, changenote );
td_changenote.setAttribute( XHTML.ATTR_class, "changenote" );
row.addContent( td_changenote );
}
// Revert note
/*
if( context.hasAdminPermissions() )
{
row.addElement( new td("Revert") );
}
*/
}
return XhtmlUtil.serialize( rt, XhtmlUtil.EXPAND_EMPTY_NODES );
}
return "";
}
private boolean isSameDay( final Date a, final Date b ) {
final Calendar aa = Calendar.getInstance(); aa.setTime( a );
final Calendar bb = Calendar.getInstance(); bb.setTime( b );
return aa.get( Calendar.YEAR ) == bb.get( Calendar.YEAR )
&& aa.get( Calendar.DAY_OF_YEAR ) == bb.get( Calendar.DAY_OF_YEAR );
}
// TODO: Ideally the default behavior should be to return the default format for the default
// locale, but that is at odds with the 1st version of this plugin. We seek to preserve the
// behaviour of that first version, so to get the default format, the user must explicitly do
// something like: dateFormat='' timeformat='' which is a odd, but probably okay.
private DateFormat getTimeFormat( final Context context, final Map< String, String > params ) {
final String formatString = get( params, DEFAULT_TIME_FORMAT, PARAM_TIME_FORMAT );
if( StringUtils.isBlank( formatString ) ) {
return Preferences.getDateFormat( context, TimeFormat.TIME );
}
return new SimpleDateFormat( formatString );
}
private DateFormat getDateFormat( final Context context, final Map< String, String > params ) {
final String formatString = get( params, DEFAULT_DATE_FORMAT, PARAM_DATE_FORMAT );
if( StringUtils.isBlank( formatString ) ) {
return Preferences.getDateFormat( context, TimeFormat.DATE );
}
return new SimpleDateFormat( formatString );
}
private String get( final Map< String, String > params, final String defaultValue, final String paramName ) {
final String value = params.get( paramName );
return value == null ? defaultValue : value;
}
}© 2015 - 2025 Weber Informatics LLC | Privacy Policy