ReferringUndefinedPagesPlugin.java

/*
    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.log4j.Logger;
import org.apache.wiki.ReferenceManager;
import org.apache.wiki.WikiContext;
import org.apache.wiki.api.exceptions.PluginException;
import org.apache.wiki.api.plugin.WikiPlugin;
import org.apache.wiki.preferences.Preferences;
import org.apache.wiki.util.TextUtil;

import java.text.MessageFormat;
import java.util.Collection;
import java.util.Map;
import java.util.ResourceBundle;
import java.util.TreeMap;
/**
 *  <p>Lists all pages containing links to Undefined Pages (pages containing dead links).</p>
 *
 *  An original idea from Gregor Hagedorn.
 *
 *  @since 2.10.0
 */
public class ReferringUndefinedPagesPlugin extends AbstractReferralPlugin {
    private static Logger log = Logger.getLogger(ReferringUndefinedPagesPlugin.class);

    /**
     * Parameter name for setting the maximum items to show.  Value is <tt>{@value}</tt>.
     */
    public static final String PARAM_MAX = "max";

    /**
     * Parameter name for setting the text to show when the maximum items is overruled.
     * Value is <tt>{@value}</tt>.
     */
    public static final String PARAM_EXTRAS = "extras";

    public String execute(WikiContext context, Map<String, String> params) throws PluginException {
        ResourceBundle rb = Preferences.getBundle(context, WikiPlugin.CORE_PLUGINS_RESOURCEBUNDLE);

        ReferenceManager referenceManager = context.getEngine().getReferenceManager();

        int items = TextUtil.parseIntParameter(params.get(PARAM_MAX), ALL_ITEMS);
        String extras = params.get(PARAM_EXTRAS);
        if (extras == null) {
            extras = rb.getString("referringundefinedpagesplugin.more");
        }

        StringBuilder resultHTML = new StringBuilder();

        Collection<String> uncreatedPages = referenceManager.findUncreated();

        super.initialize(context, params);

        Collection<String> result = null;

        TreeMap sortedMap = new TreeMap();
        if (uncreatedPages != null) {
            for (String uncreatedPageName : uncreatedPages) {
                Collection<String> referrers = referenceManager.findReferrers(uncreatedPageName);
                if (referrers != null) {
                    for (String referringPage : referrers) {
                        sortedMap.put(referringPage, "");
                    }
                }
            }
            result = sortedMap.keySet();
        }

        result = super.filterAndSortCollection(result);

        String wikitext = wikitizeCollection(result, m_separator, items);

        resultHTML.append(makeHTML(context, wikitext));

        // add the more.... text
        if (items < result.size() && items > 0) {
            Object[] args = {"" + (result.size() - items)};
            extras = MessageFormat.format(extras, args);

            resultHTML.append("<br/>" + extras + "<br/>");
        }
        return resultHTML.toString();
    }

}