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

Go to download
Show more of this group Show more artifacts with this name
Show all versions of shell-client Show documentation
There is a newer version: 8.0.112
/*
 * 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.util.ArrayList;
import java.util.List;

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

/**
 * @author amit bhayani
 *
 */
public abstract class AbstractCommandHandler implements CommandHandler {

    public static final int CONNECT_MANDATORY_FLAG = 1;
    public static final int DISCONNECT_MANDATORY_FLAG = 2;
    public static final int DOESNT_CARE_CONNECT_DISCONNECT_FLAG = 0;

    private final List completion;
    private final Tree tree;

    // Variable to indicate that tab completion should show commands only when
    // CLI is connected or disconnected or doesn't care
    private final int connectFlag;

    /**
     *
     */
    public AbstractCommandHandler(Tree tree, final int connectFlag) {
        this.tree = tree;
        this.connectFlag = connectFlag;
        this.completion = new ArrayList();
        final Node node = this.tree.getTopNode();
        final String data = node.getData();
        CommandLineCompleter commandLineCompleter = new CommandLineCompleter() {

            @Override
            public int complete(CommandContext ctx, String buffer, int cursor, List candidates) {

                if (connectFlag == CONNECT_MANDATORY_FLAG && !ctx.isControllerConnected()) {
                    return 0;
                } else if (connectFlag == DISCONNECT_MANDATORY_FLAG && ctx.isControllerConnected()) {
                    return 0;
                }

                if (buffer.equals("")) {
                    candidates.add(data);
                } else {
                    addCompletionrecursively(buffer, candidates, node);
                }
                return 0;
            }

        };

        this.completion.add(commandLineCompleter);

    }

    /*
     * (non-Javadoc)
     *
     * @see org.mobicents.ss7.management.console.CommandHandler#handles(java.lang .String)
     */
    @Override
    public boolean handles(String command) {
        if (command.startsWith(this.tree.getTopNode().getData())) {
            return true;
        }
        return false;
    }

    private boolean addCompletionrecursively(String buffer, List candidates, Node parentNode) {
        String command = parentNode.getCommand();
        String trimmedBuffer = buffer.trim();
        if (command.equals(trimmedBuffer)) {
            // If command is exactly what user has typed on CLI, show all
            // possible children
            List children = parentNode.getChildren();

            if (children.size() == 1) {
                // If there is only one child, directly print it rather than
                // showing option
                candidates.add(children.get(0).getCommand());
                return true;
            } else {
                for (Node n : children) {
                    candidates.add(n.getData());
                }
            }
            return true;
        } else if (command.startsWith(buffer)) {
            // If user has type partial command, complete it
            candidates.add(command);
            return true;
        }

        // None of the above conditions matched; lets check for child
        // recursively
        List children = parentNode.getChildren();
        for (Node n : children) {
            if (addCompletionrecursively(buffer, candidates, n)) {
                return true;
            }
        }

        return false;
    }

    /*
     * (non-Javadoc)
     *
     * @see org.mobicents.ss7.management.console.CommandHandler# getCommandLineCompleterList()
     */
    @Override
    public List getCommandLineCompleterList() {
        return this.completion;
    }

}