    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;
    024import org.apache.wiki.util.TextUtil;
    025
    026import java.util.Collection;
    027import java.util.Map;
    028
    029/**
    030 * Plugin for displaying pages that are not linked to in other pages.
    031 * Uses the ReferenceManager.
    032 * <p>
    033 *  Parameters  (from AbstractReferralPlugin):
    034 *  <ul>
    035 *  <li><b>separator</b> - how to separate generated links; default is a wikitext line break,  producing a vertical list</li>
    036 * <li><b> maxwidth</b> - maximum width, in chars, of generated links.</li>
    037 * </ul>
    038 */
    039public class UnusedPagesPlugin extends AbstractReferralPlugin {
    040
    041    /** If set to "true", attachments are excluded from display.  Value is {@value}. */
    042    public static final String PARAM_EXCLUDEATTS = "excludeattachments";
    043
    044    /**
    045     *  {@inheritDoc}
    046     */
    047    @Override
    048    public String execute( final Context context, final Map< String, String > params ) throws PluginException {
    049        final ReferenceManager refmgr = context.getEngine().getManager( ReferenceManager.class );
    050        Collection< String > links = refmgr.findUnreferenced();
    051
    052        // filter out attachments if "excludeattachments" was requested:
    053        final String prop = params.get( PARAM_EXCLUDEATTS );
    054        if( TextUtil.isPositive( prop ) ) {
    055            // remove links to attachments (recognizable by a slash in it)
    056            links.removeIf( link -> link.contains( "/" ) );
    057        }
    058
    059        super.initialize( context, params );
    060        links = filterAndSortCollection( links );
    061
    062        String wikitext;
    063        if( m_show.equals( PARAM_SHOW_VALUE_COUNT ) ) {
    064            wikitext = "" + links.size();
    065            if( m_lastModified && !links.isEmpty()) {
    066                wikitext = links.size() + " (" + m_dateFormat.format( m_dateLastModified ) + ")";
    067            }
    068            return makeHTML( context, wikitext );
    069        } else {
    070            wikitext = wikitizeCollection( links, m_separator, ALL_ITEMS );
    071            return applyColumnsStyle( makeHTML( context, wikitext ) );
    072        }
    073    }
    074
    075}
    076