org.mobicents.ss7.management.console.CommandHandlerWithHelp Maven / Gradle / Ivy

Go to download
/*
 * TeleStax, Open Source Cloud Communications  Copyright 2012.
 * and individual contributors
 * by the @authors tag. See the copyright.txt in the distribution for a
 * full listing of individual contributors.
 *
 * This is free software; you can redistribute it and/or modify it
 * under the terms of the GNU Lesser General Public License as
 * published by the Free Software Foundation; either version 2.1 of
 * the License, or (at your option) any later version.
 *
 * This software is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with this software; if not, write to the Free
 * Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
 * 02110-1301 USA, or see the FSF site: http://www.fsf.org.
 */
package org.mobicents.ss7.management.console;

import java.io.BufferedReader;
import java.io.IOException;
import java.io.InputStream;
import java.io.InputStreamReader;
import java.util.List;

import org.mobicents.ss7.management.console.Tree.Node;

/**
 * @author amit bhayani
 *
 */
public abstract class CommandHandlerWithHelp extends AbstractCommandHandler {

    /**
     * @param tree
     */
    public CommandHandlerWithHelp(Tree tree, final int connectFlag) {
        super(tree, connectFlag);
        Node topNode = tree.getTopNode();

        if (topNode.getChildren().size() > 0) {
            // add --help only if there is atleast 1 child. Else for top command
            // --help is any way added
            addHelpToLastNode(topNode);
        }

        topNode.addChild("--help");

    }

    private void addHelpToLastNode(Node node) {
        List children = node.getChildren();
        if (children.size() == 0) {
            // If this is last Node in the branch we add --help
            node.addChild("--help");
        } else {
            for (Node n : children) {
                addHelpToLastNode(n);
            }
        }
    }

    protected void printHelp(String commandLine, CommandContext ctx) {

        String fileName = commandLine.trim().replaceAll(" --help", "");
        fileName = "help/" + fileName.replace(" ", "_") + ".txt";

        InputStream helpInput = SecurityActions.getClassLoader(CommandHandlerWithHelp.class).getResourceAsStream(fileName);
        if (helpInput != null) {
            BufferedReader reader = new BufferedReader(new InputStreamReader(helpInput));
            try {
                String helpLine = reader.readLine();
                while (helpLine != null) {
                    ctx.printLine(helpLine);
                    helpLine = reader.readLine();
                }
            } catch (java.io.IOException e) {
                ctx.printLine("Failed to read help/help.txt: " + e.getLocalizedMessage());
            } finally {
                try {
                    reader.close();
                } catch (IOException e) {

                }
            }
        } else {
            ctx.printLine("Failed to locate command description " + fileName);
        }
    }
}