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.Map;
027
028
029/**
030 *  Plugin that enumerates the pages in the wiki that have not yet been defined.
031 *  
032 *  Parameters  (from AbstractReferralPlugin):
033 *  <ul>
034 *  <li><b>separator</b> - how to separate generated links; default is a wikitext line break,  producing a vertical list</li>
035 * <li><b> maxwidth</b> - maximum width, in chars, of generated links.</li>
036 * </ul>
037 */
038public class UndefinedPagesPlugin extends AbstractReferralPlugin {
039
040    /**
041     *  {@inheritDoc}
042     */
043    @Override
044    public String execute( final Context context, final Map< String, String > params ) throws PluginException {
045        final ReferenceManager refmgr = context.getEngine().getManager( ReferenceManager.class );
046        super.initialize( context, params );
047
048        Collection< String > links = refmgr.findUncreated();
049        links = filterAndSortCollection( links );
050
051        if( m_lastModified ) {
052            throw new PluginException( "parameter " + PARAM_LASTMODIFIED + " is not valid for the UndefinedPagesPlugin" );
053        }
054
055        final String wikitext;
056        if( m_show.equals( PARAM_SHOW_VALUE_COUNT ) ) {
057            wikitext = "" + links.size();
058        } else {
059            wikitext = wikitizeCollection( links, m_separator, ALL_ITEMS );
060        }
061        
062        return makeHTML( context, wikitext );
063    }
064
065}