com.izforge.izpack.installer.console.AbstractTextConsolePanel Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of izpack-installer Show documentation
There is a newer version: 5.2.3
/*
 * IzPack - Copyright 2001-2012 Julien Ponge, All Rights Reserved.
 *
 * http://izpack.org/
 * http://izpack.codehaus.org/
 *
 * Copyright 2012 Tim Anderson
 *
 * Licensed 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 com.izforge.izpack.installer.console;

import java.util.Properties;
import java.util.StringTokenizer;
import java.util.logging.Logger;

import com.izforge.izpack.api.data.InstallData;
import com.izforge.izpack.installer.panel.PanelView;
import com.izforge.izpack.util.Console;

/**
 * Abstract console panel for displaying paginated text.
 *
 * @author Tim Anderson
 */
public abstract class AbstractTextConsolePanel extends AbstractConsolePanel
{

    /**
     * The logger.
     */
    private static final Logger logger = Logger.getLogger(AbstractTextConsolePanel.class.getName());

    /**
     * Constructs an {@code AbstractTextConsolePanel}.
     *
     * @param panel the parent panel/view. May be {@code null}
     */
    public AbstractTextConsolePanel(PanelView panel)
    {
        super(panel);
    }

    /**
     * Runs the panel using the supplied properties.
     *
     * @param installData the installation data
     * @param properties  the properties
     * @return true
     */
    @Override
    public boolean run(InstallData installData, Properties properties)
    {
        return true;
    }

    /**
     * Runs the panel using the specified console.
     * 
     * If there is no text to display, the panel will return false.
     *
     * @param installData the installation data
     * @param console     the console
     * @return true if the panel ran successfully, otherwise false
     */
    @Override
    public boolean run(InstallData installData, Console console)
    {
        boolean result;
        String text = getText();
        if (text != null)
        {
            result = paginateText(text, console);
        }
        else
        {
            logger.warning("No text to display");
            result = false;
        }
        return result && promptEndPanel(installData, console);
    }

    /**
     * Returns the text to display.
     *
     * @return the text. A null indicates failure
     */
    protected abstract String getText();

    /**
     * Pages through the supplied text.
     *
     * @param text    the text to display
     * @param console the console to display to
     * @return true if paginated through, false if terminated
     */
    protected boolean paginateText(String text, Console console)
    {
        boolean result = true;
        int lines = 22; // the no. of lines to display at a time
        int line = 0;

        StringTokenizer tokens = new StringTokenizer(text, "\n");
        while (tokens.hasMoreTokens())
        {
            String token = tokens.nextToken();
            console.println(token);
            line++;
            if (line >= lines && tokens.hasMoreTokens())
            {
                if (!promptContinue(console))
                {
                    result = false;
                    break;
                }
                line = 0;
            }
        }
        return result;
    }

    /**
     * Displays a prompt to continue, providing the option to terminate installation.
     *
     * @param console the console to perform I/O
     * @return true if the installation should continue, false if it should terminate
     */
    protected boolean promptContinue(Console console)
    {
        String value = console.prompt("\nPress Enter to continue, X to exit", "x");
        console.println();
        return !value.equalsIgnoreCase("x");
    }

    /**
     * Helper to strip HTML from text.
     * From code originally developed by Jan Blok.
     *
     * @param text the text. May be {@code null}
     * @return the text with HTML removed
     */
    protected String removeHTML(String text)
    {
        String result = "";

        if (text != null)
        {
            // chose to keep newline (\n) instead of carriage return (\r) for line breaks.

            // Replace line breaks with space
            result = text.replaceAll("\r", " ");
            // Remove step-formatting
            result = result.replaceAll("\t", "");
            // Remove repeating spaces because browsers ignore them

            result = result.replaceAll("( )+", " ");


            result = result.replaceAll("<( )*head([^>])*>", "");
            result = result.replaceAll("(<( )*(/)( )*head( )*>)", "");
            result = result.replaceAll("().*()", "");
            result = result.replaceAll("<( )*script([^>])*>", "");
            result = result.replaceAll("()", "");

            // remove all styles (prepare first by clearing attributes)
            result = result.replaceAll("<( )*style([^>])*>", "");
            result = result.replaceAll("()", "");

            result = result.replaceAll("(<( )*(/)( )*sup( )*>)", "");
            result = result.replaceAll("<( )*sup([^>])*>", "^{");
            result = result.replaceAll("(^).*()", "");

            // insert tabs in spaces of  tags
            result = result.replaceAll("<( )*td([^>])*>", "\t");

            // insert line breaks in places of 
 and} tags
            result = result.replaceAll("<( )*br( )*>", "\r");
            result = result.replaceAll("<( )*li( )*>", "\r");

            // insert line paragraphs (double line breaks) in place
            // if ,  and  tags
            result = result.replaceAll("<( )*div([^>])*>", "\r\r");
            result = result.replaceAll("<( )*tr([^>])*>", "\r\r");

            result = result.replaceAll("(<) h (\\w+) >", "\r");
            result = result.replaceAll("(\\b) () (\\b)", "");
            result = result.replaceAll("<( )*p([^>])*>", "\r\r");

            // Remove remaining tags like , links, images,
            // comments etc - anything that's enclosed inside < >
            result = result.replaceAll("<[^>]*>", "");


            result = result.replaceAll("•", " * ");
            result = result.replaceAll("‹", "<");
            result = result.replaceAll("›", ">");
            result = result.replaceAll("™", "(tm)");
            result = result.replaceAll("⁄", "/");
            result = result.replaceAll("<", "<");
            result = result.replaceAll(">", ">");

            result = result.replaceAll("©", "(c)");
            result = result.replaceAll("®", "(r)");
            result = result.replaceAll("&(.{2,6});", "");

            // Remove extra line breaks and tabs:
            // replace over 2 breaks with 2 and over 4 tabs with 4.
            // Prepare first to remove any whitespaces in between
            // the escaped characters and remove redundant tabs in between line breaks
            result = result.replaceAll("(\r)( )+(\r)", "\r\r");
            result = result.replaceAll("(\t)( )+(\t)", "\t\t");
            result = result.replaceAll("(\t)( )+(\r)", "\t\r");
            result = result.replaceAll("(\r)( )+(\t)", "\r\t");
            result = result.replaceAll("(\r)(\t)+(\\r)", "\r\r");
            result = result.replaceAll("(\r)(\t)+", "\r\t");
        }
        return result;
    }
}
Related Artifacts