    001/*
    002    Licensed to the Apache Software Foundation (ASF) under one
    003    or more contributor license agreements.  See the NOTICE file
    004    distributed with this work for additional information
    005    regarding copyright ownership.  The ASF licenses this file
    006    to you under the Apache License, Version 2.0 (the
    007    "License"); you may not use this file except in compliance
    008    with the License.  You may obtain a copy of the License at
    009
    010       http://www.apache.org/licenses/LICENSE-2.0
    011
    012    Unless required by applicable law or agreed to in writing,
    013    software distributed under the License is distributed on an
    014    "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
    015    KIND, either express or implied.  See the License for the
    016    specific language governing permissions and limitations
    017    under the License.
    018 */
    019package org.apache.wiki.plugin;
    020
    021import org.apache.wiki.api.core.Context;
    022import org.apache.wiki.api.exceptions.PluginException;
    023import org.apache.wiki.references.ReferenceManager;
    024
    025import java.util.Collection;
    026import java.util.Locale;
    027import java.util.Map;
    028import java.util.ResourceBundle;
    029
    030
    031/**
    032 *  Plugin that enumerates the pages in the wiki that have not yet been defined.
    033 *
    034 *  Parameters  (from AbstractReferralPlugin):
    035 *  <ul>
    036 *  <li><b>separator</b> - how to separate generated links; default is a wikitext line break,  producing a vertical list</li>
    037 * <li><b> maxwidth</b> - maximum width, in chars, of generated links.</li>
    038 * </ul>
    039 */
    040public class UndefinedPagesPlugin extends AbstractReferralPlugin {
    041
    042    @Override
    043    public String getDisplayName(Locale locale) {
    044        final ResourceBundle rb = ResourceBundle.getBundle(PluginManager.PLUGIN_I18N_RESOURCE, locale);
    045        return rb.getString(this.getClass().getSimpleName());
    046    }
    047
    048    /**
    049     *  {@inheritDoc}
    050     */
    051    @Override
    052    public String execute( final Context context, final Map< String, String > params ) throws PluginException {
    053        final ReferenceManager refmgr = context.getEngine().getManager( ReferenceManager.class );
    054        super.initialize( context, params );
    055
    056        Collection< String > links = refmgr.findUncreated();
    057        links = filterAndSortCollection( links );
    058
    059        if( m_lastModified ) {
    060            throw new PluginException( "parameter " + PARAM_LASTMODIFIED + " is not valid for the UndefinedPagesPlugin" );
    061        }
    062
    063        final String wikitext;
    064        if( m_show.equals( PARAM_SHOW_VALUE_COUNT ) ) {
    065            wikitext = "" + links.size();
    066            return makeHTML( context, wikitext );
    067        } else {
    068            wikitext = wikitizeCollection( links, m_separator, ALL_ITEMS );
    069            return applyColumnsStyle( makeHTML( context, wikitext ) );
    070        }
    071    }
    072
    073}