All Downloads are FREE. Search and download functionalities are using the official Maven repository.

de.tsl2.nano.incubation.terminal.SIShell Maven / Gradle / Ivy

Go to download

TSL2 Framework Terminal (Console Application Framework named SIShell, providing Actions, Options, Commands, Inputs, lots of Selectors, PlatformManagement)

There is a newer version: 2.5.2
Show newest version
/*
 * File: $HeadURL$
 * Id  : $Id$
 * 
 * created by: Tom
 * created on: 13.12.2014
 * 
 * Copyright: (c) Thomas Schneider 2014, all rights reserved
 */
package de.tsl2.nano.incubation.terminal;

import static de.tsl2.nano.incubation.terminal.TextTerminal.BLOCK_BAR;
import static de.tsl2.nano.incubation.terminal.TextTerminal.SCREEN_HEIGHT;
import static de.tsl2.nano.incubation.terminal.TextTerminal.SCREEN_WIDTH;
import static de.tsl2.nano.incubation.terminal.TextTerminal.getTextFrame;

import java.io.File;
import java.io.InputStream;
import java.io.PrintStream;
import java.io.PrintWriter;
import java.io.Serializable;
import java.util.List;
import java.util.Map;
import java.util.Properties;
import java.util.Scanner;
import java.util.Set;
import java.util.concurrent.TimeUnit;

import javax.imageio.ImageIO;

import org.apache.commons.logging.Log;
import org.simpleframework.xml.Attribute;
import org.simpleframework.xml.Default;
import org.simpleframework.xml.DefaultType;
import org.simpleframework.xml.Element;
import org.simpleframework.xml.ElementMap;
import org.simpleframework.xml.core.Commit;

import de.tsl2.nano.core.AppLoader;
import de.tsl2.nano.core.ENV;
import de.tsl2.nano.core.Finished;
import de.tsl2.nano.core.ManagedException;
import de.tsl2.nano.core.Messages;
import de.tsl2.nano.core.classloader.NetworkClassLoader;
import de.tsl2.nano.core.cls.PrivateAccessor;
import de.tsl2.nano.core.cls.UnboundAccessor;
import de.tsl2.nano.core.execution.CompatibilityLayer;
import de.tsl2.nano.core.execution.SystemUtil;
import de.tsl2.nano.core.log.LogFactory;
import de.tsl2.nano.core.serialize.XmlUtil;
import de.tsl2.nano.core.util.ConcurrentUtil;
import de.tsl2.nano.core.util.FileUtil;
import de.tsl2.nano.core.util.NetUtil;
import de.tsl2.nano.core.util.StringUtil;
import de.tsl2.nano.core.util.Util;
import de.tsl2.nano.incubation.platform.PlatformManagement;
import de.tsl2.nano.incubation.terminal.IItem.Type;
import de.tsl2.nano.incubation.terminal.item.Container;
import de.tsl2.nano.util.SchedulerUtil;

/**
 * Structured Input Shell (SIShell) showing a textual manual. The configuration can be read through an xml file
 * (standard name: {@link #DEFAULT_NAME}). For further informations, see {@link IItem}.
 * 
 * 
 * Features:
 * - simple input and output on small screens
 * - input constraints check
 * - configuration over xml
 * - result will be written to a property map
 * - tree nodes can be selected through numbers or names (the first unique characters are enough)
 * - batch mode possible
 * - macro recording and replaying
 * - simplified java method calls
 * - variable output sizes and styles
 * - workflow conditions: items are active if an optional condition is true
 * - if an item container (a tree) has only one visible item (perhaps filtered through conditions), it delegates directly to that item
 * - actions get the entire environment properties (including system properties) on calling run().
 * - sequential mode: if true, all tree items will be asked for in a sequential mode.
 * - show ascii-pictures (transformed from pixel-images) for an item (description must point to an image file)
 * - extends itself downloading required jars from network (if {@link #useNetworkExtension} ist true)
 * - schedule mode: starts a scheduler for an action
 * - selectors for files, content of files, class members, properties, csv-files etc.
 * - administration modus to create/change/remove items, change terminal properties
 * 

 * 
 * @author Tom
 * @version $Revision$
 */
@SuppressWarnings({ "unchecked", "rawtypes" })
@Default(value = DefaultType.FIELD, required = false)
public class SIShell implements IItemHandler, Serializable {
    /** serialVersionUID */
    private static final long serialVersionUID = -5767124822662015899L;
    transient private static final Log LOG;
    static {
        LogFactory.setPrintToConsole(false);
        LOG = LogFactory.getLog(SIShell.class);
    }
    /** used as file name */
    @Attribute
    String name = DEFAULT_NAME;
    /** utility to read user input */
    transient Scanner input;
    transient InputStream in;
    transient PrintStream out;
    @Attribute
    int width = SCREEN_WIDTH;
    /** if height < 1, the height will be dynamic to the items height */
    @Attribute
    int height = SCREEN_HEIGHT;
    @Attribute
    int style = BLOCK_BAR;
    @Attribute
    boolean bars = true;
    /** item properties */
    transient Properties env;
    /** default: false. if true, on each terminal save, the terminals xml serialization file will be stored. */
    @Attribute(required = false)
    boolean refreshConfig = false;
    transient Exception lastException;
    /**
     * predefined variables (not changable through user input) copied to the {@link #env} but not saved in property
     * file. mostly technical definitions.
     */
    @ElementMap(entry = "definition", attribute = true, inline = true, keyType = String.class, key = "name", required = false, value = "value", valueType = Object.class)
    Map definitions;

    /** batch file name. the batch file contains input instructions (numbers or names) separated by '\n'. */
    @Element(required = false)
    String batch;

    /** base item - should be a Selection */
    @Element
    IItem root;

    /** useNetworkExtension */
    @Attribute
    boolean useNetworkExtension = true;

    /**
     * true, if macro recording was started through {@link #KEY_MACRO_RECORD} and not yet stoped with
     * {@link #KEY_MACRO_STOP}
     */
    transient boolean isRecording;

    /** if true, all tree items will be accessed directly and sequentially */
    @Attribute(required = false)
    boolean sequential = false;

    @Element(required = false)
    String clearScreenCmd = AppLoader.isUnix() ? "clear" : "cls";

    /** command identifier */
    static final String KEY_COMMAND = ":";
    /*
     * available commands
     */
    static final String KEY_HELP = "help";
    /** prints system informations */
    static final String KEY_INFO = "info";
    /** prints content of all platform MBeans (JMX) */
    static final String KEY_PLATFORMINFO = "platform";
    /** prints all system properties */
    static final String KEY_PROPERTIES = "properties";
    /** starts macro recording. user input will be stored to {@link #batch} and saved on terminal end. */
    static final String KEY_MACRO_RECORD = "record";
    /** stops macro recording */
    static final String KEY_MACRO_STOP = "stop";

    /** starts a scheduler for the given action */
    static final String KEY_SCHEDULE = "schedule";

    /** starts the given reflection expression on a given property */
    static final String KEY_REFLECT = "reflect";

    static final String KEY_ADMIN = "admin";

    public static final String KEY_SEQUENTIAL0 = "sequential";

    static final String KEY_USENETWORKEXTENSION = "network";

    public static final String KEY_LASTEXCEPTION = "exception";

    /** saves the current state to xml and property files */
    static final String KEY_SAVE = "save";
    /** quits the terminal */
    static final String KEY_QUIT = "quit";

    public static final String PREFIX = "sishell.";
    public static final String KEY_NAME = PREFIX + "name";
    public static final String KEY_WIDTH = PREFIX + "width";
    public static final String KEY_HEIGHT = PREFIX + "height";

    public static final String KEY_SEQUENTIAL = PREFIX + "sequential";

    /** default script file name */
    public static final String DEFAULT_NAME = PREFIX + "xml";

    static final String ASK_ENTER = ENV.translate("ask.enter", false);
    private static final String LOGO = "tsl2nano.logo.png";

    public SIShell() {
        initDeserialization();
    }

    public SIShell(IItem root) {
        this(root, System.in, System.out);
    }

    public SIShell(IItem root, InputStream in, PrintStream out) {
        this(root, in, out, SCREEN_WIDTH, SCREEN_HEIGHT, BLOCK_BAR, null);
    }

    public SIShell(IItem root, InputStream in, PrintStream out, int width, int height, int style) {
        this(root, in, out, width, height, style, null);
    }

    /**
     * constructor
     * 
     * @param root
     * @param input
     * @param in
     * @param out
     */
    public SIShell(IItem root,
            InputStream in,
            PrintStream out,
            int width,
            int height,
            int style,
            Map defintions) {
        super();
        this.root = root;
        this.in = in;
        this.out = out;
        this.width = width;
        this.height = height;
        this.style = style;
        this.definitions = defintions;
        this.env = createEnvironment(name, defintions);
    }

    static Properties createEnvironment(String name, Map definitions) {
        String p = name + ".properties";
        Properties env = new File(p).getAbsoluteFile().canRead() ? FileUtil.loadPropertiesFromFile(p) : new Properties();
        if (definitions != null) {
            env.putAll(definitions);
        }
        return env;
    }

    public static SIShell create(String file) {
        File ffile = new File(file);
        //do a pre-check on the toolbox configuration file which needs ant to be available
        if (file.contains(DEFAULT_NAME) && ffile.getAbsoluteFile().exists() && !NetUtil.isOnline()
            && !new CompatibilityLayer().isAvailable("org.apache.tools.ant.Task"))
            throw new ManagedException("error.ant.missing", file);
        SIShell t =
            ffile.exists() ? XmlUtil.loadXml(file, SIShell.class) : new SIShell(new Container(file, null));
        t.name = file;
        return t;
    }

    /**
     * {@inheritDoc}
     */
    @Override
    public void run() {
        try {
            LOG.info("starting SI-Shell " + name);
            input = new Scanner(in);
            prepareEnvironment(env, root);
//            //welcome screen
            if (!isInBatchMode()) {
                printAsciiImage(LOGO, new PrintWriter(out), width, height > 0 ? height : 22, true, bars);
                nextLine(in);
            }
            //if only one tree-item available, go to that item
            if (root instanceof Container) {
                root = ((Container) root).delegateToUniqueChild(root, in, out, env);
            }
            serve(root, in, out, env);
            shutdown();
        } catch (Finished ex) {
            shutdown();
        } catch (Exception ex) {
            ManagedException.forward(ex);
        } finally {
            if (input != null) {
                input.close();
            }
        }
    }

    public static void printAsciiImage(String name,
            PrintWriter out,
            int width,
            int height,
            boolean resource,
            boolean bars) {
        try {
            if (resource) {
                new AsciiImage(bars ? AsciiImage.BARS : AsciiImage.CHARS, AsciiImage.RGB).convertToAscii(
                    ImageIO.read(FileUtil.getResource(name)), out, width, height).flush();
            } else {
                new AsciiImage().convertToAscii(name, out, width, height).flush();
            }
        } catch (Exception e) {
            //it's only a logo, no problem (perhaps on android)
            LOG.error(e.toString());
        }
    }

    /**
     * see {@link #definitions}
     * 
     * @return Returns the definitions.
     */
    public Map getDefinitions() {
        return definitions;
    }

    /**
     * see {@link #definitions}
     * 
     * @param definitions The definitions to set.
     */
    public void setDefinitions(Map definitions) {
        this.definitions = definitions;
    }

    protected void shutdown() {
        save(refreshConfig || !new File(name).getAbsoluteFile().exists());
        String shutdownInfo =
            ENV.translate("message.shutdown", false, name);
        printScreen(shutdownInfo, in, out, null, width, height, style, true, isInBatchMode());
        LOG.info("si-shell " + name + " ended");
    }

    protected void save(boolean saveConfiguration) {
        if (saveConfiguration) {
            XmlUtil.saveXml(name, this);
        }
        Set keys = env.keySet();
        //replace objects through their toString()
        Properties envCopy = new Properties();
        for (Object k : keys) {
            //pre defined variables are not content of item properties
            if (definitions != null && definitions.containsKey(k)) {
                continue;
            }
            Object v = env.get(k);
            envCopy.put(k, v instanceof String ? v : StringUtil.toString(v, -1));
        }
        FileUtil.saveProperties(name + ".properties", envCopy);
    }

    private void prepareEnvironment(Properties env, IItem root) {
        if (root.getType() == Type.Option) {
            return;
        }
        Object value = root.getValue();
        if (value != null) {
            env.put(root.getName(), value);
        }
        if (root.getType() == Type.Selector) {
            return;
        }
        if (root.getType().equals(Type.Container)) {
            List childs = ((IContainer) root).getNodes(env);
            if (childs != null) {
                for (IItem c : childs) {
                    prepareEnvironment(env, c);
                }
            }
        }
        if (useNetworkExtension) {
            String classpath = System.getProperty("user.dir") + "/." + getClass().getSimpleName().toLowerCase();
            new File(classpath).mkdirs();
            NetworkClassLoader.createAndRegister(classpath);
        }
        provideToSystem();
    }

    public void provideToSystem() {
        //to be accessible for actions
        System.setProperty(KEY_NAME, name);
        System.getProperties().put(KEY_WIDTH, width);
        if (height > 0)
            System.getProperties().put(KEY_HEIGHT, height);
        else
            System.getProperties().remove(KEY_HEIGHT);
        System.getProperties().put(KEY_SEQUENTIAL, sequential);
    }

    /**
     * {@inheritDoc}
     */
    @Override
    public Object getUserInterface() {
        // TODO Auto-generated method stub
        return null;
    }

    @Override
    public String printScreen(IItem item, PrintStream out) {
        String title = item.toString();
        int style = item.getStyle() != null ? item.getStyle() : this.style;
        out.print(title.length() > (3 * width) ? title : TextTerminal.getTextFrame(title, style, width, true));
        String question = item.ask(env);
        return printScreen(
            item.getDescription(env, false),
            in,
            out, question, width, height, style, false, isInBatchMode());
    }

    public String printScreen(String screen, InputStream in, PrintStream out, String question) {
        return printScreen(screen, in, out, question, width, height, style, false, isInBatchMode());
    }

    /**
     * {@inheritDoc}
     */
    public static String printScreen(String screen, InputStream in, PrintStream out, String question, int width, int height, int style, boolean center, boolean isInBatchMode) {
        //split screens to max height
        String pagingInput;
        String s = screen;
        int lines = 0, page = 0, i = 0, l = -1;
        while ((i = s.indexOf("\n", l + 1)) < s.length() && i != -1) {
            if (i - l > width - 2) {
                i = l + width - 2;
            }
            if (++lines > height && height > 0) {
                out.print(getTextFrame(s.substring(page, i), style, width, center));
                out.print(ASK_ENTER);
                page = i + 1;
                lines = 0;
                if (!isInBatchMode) {
                    if ((pagingInput = nextLine(in, out)).length() > 0) {
                        return pagingInput;
                    }
                } else {
                    out.println();
                }
            }
            l = i;
        }
        //print the rest
        if (lines > 1 && (height < 1 || lines <= height)) {
            screen = s.substring(page, s.length());
            if (height > 0)
                screen += StringUtil.fixString(height - lines, ' ').replace(" ", " \n");
            out.print(getTextFrame(screen, style, width, center));
        }
        out.print(question);
        return null;
    }

    public static String translate(String name) {
        return StringUtil.toFirstUpper(Messages.getStringOpt(name));
    }

    /**
     * {@inheritDoc}
     */
    @Override
    public void serve(final IItem item, InputStream in, final PrintStream out, Properties env) {
        try {
            env.put("out", out);
            clearScreeen();
            String input = printScreen(item, out);
            if (input == null) {
                input = nextLine(in);
                if (input.equals("stop")) {
                    ConcurrentUtil.stopOrInterrupt("sishell.printscreen");
                }
            }
            //shell commands
            if (!Util.isEmpty(input) && input.startsWith(KEY_COMMAND)) {
                if (isCommand(input, KEY_HELP)) {
                    printScreen(getHelp(), in, out, ASK_ENTER);
                    nextLine(in);
                    printScreen(item.getDescription(env, true), in, out, "");
                } else if (isCommand(input, KEY_PROPERTIES)) {
                    System.getProperties().list(out);
                } else if (isCommand(input, KEY_INFO)) {
                    printScreen(SystemUtil.createInfo(null), in, out, "");
                } else if (isCommand(input, KEY_PLATFORMINFO)) {
                    printScreen(PlatformManagement.getMBeanInfo(null).toString(), in, out, "");
                } else if (isCommand(input, KEY_LASTEXCEPTION)) {
                    if (lastException != null)
                        lastException.printStackTrace(out);
                    else
                        out.println("no exception thrown!");
                } else if (isCommand(input, KEY_MACRO_RECORD)) {
                    isRecording = true;
                } else if (isCommand(input, KEY_MACRO_STOP)) {
                    isRecording = false;
                } else if (isCommand(input, KEY_SCHEDULE)) {
                    schedule(item, input, in, out, env);
                } else if (isCommand(input, KEY_REFLECT)) {
                    reflect(input, in, out, env);
                } else if (isCommand(input, KEY_SEQUENTIAL0)) {
                    sequential = !sequential;
                    prepareEnvironment(env, root);
                } else if (isCommand(input, KEY_USENETWORKEXTENSION)) {
                    useNetworkExtension = !useNetworkExtension;
                    prepareEnvironment(env, root);
                } else if (isCommand(input, KEY_ADMIN)) {
                    startAmin(item);
                } else if (isCommand(input, KEY_SAVE)) {
                    save(true);
                } else if (isCommand(input, KEY_QUIT)) {
                    throw new Finished("si-shell stopped");
                } else {
                    throw new IllegalArgumentException(input + ENV.translate("unknown.command", false));
                }
                nextLine(in);
                serve(item, in, out, env);
            } else {
                input = provideInputParameter(input, env);
                IItem next = item.react(item, input, in, out, env);
                if (next != null) {
                    serve(next, in, out, env);
                }
            }
        } catch (Finished ex) {
            //terminal will be stopped
            throw ex;
        } catch (Exception ex) {
            lastException = ex;
            //print only - no problem
            out.println(ex.getLocalizedMessage());
            //do it again
            nextLine(in);
            serve(item, in, out, env);
        }
    }

    private void clearScreeen() {
        try {
            if (!Util.isEmpty(clearScreenCmd))
                SystemUtil.execute(clearScreenCmd);
        } catch (Exception e) {
            LOG.warn("clear screen command '" + clearScreenCmd + "' failed: " + e.toString()
                + ". resetting the clear screen command.");
            clearScreenCmd = null;
        }
    }

    private void reflect(String input, InputStream in, PrintStream out, Properties env) {
        env = new Properties(env);
        input = provideInputParameter(input, env);
        Object instance = env.get("instance");
        UnboundAccessor acc = new UnboundAccessor(instance);
        Object args = null;
        Object result = acc.call(env.getProperty("method"), Object.class, args);
        out.println("result of reflection call: " + result);
    }

    private String provideInputParameter(String input, Properties par) {
        String[] p = input.split("\\s");
        if (p.length < 1)
            return input;
        //the first array item is the command itself
        for (int i = 1; i < p.length; i++) {
            par.put(StringUtil.substring(p[i], null, "="), StringUtil.substring(p[i], "=", null));
        }
        return p[0];
    }

    private void startAmin(IItem item) {
        int ostyle = style;
        style = 3;
        ItemAdministrator administrator = new ItemAdministrator(this, (Container) item);
        serve(administrator, in, out, env);
        administrator.clean();
        style = ostyle;
    }

    /**
     * schedule
     * 
     * @param item
     * @param input
     * @param in
     * @param out
     * @param env
     */
    private void schedule(final IItem item,
            final String input,
            InputStream in,
            final PrintStream out,
            final Properties env) {
        out.println("preparing scheduler on parameters (:schedule:command:delay:period:end), input=" + input);
        String[] args = input.split(":");
        int i = 2;
        final IItem action = ((Container) item).getNode(args[i++], env);
        long delay = Integer.valueOf(Util.value(args, i++, "1000"));
        long period = Integer.valueOf(Util.value(args, i++, "1000"));
        long end = Integer.valueOf(Util.value(args, i++, "3600000"));
        TimeUnit unit = TimeUnit.MICROSECONDS;
        out.println("starting scheduler for action " + action + ":\n"
            + "  delay : " + delay + " milliseconds\n"
            + "  period: " + period + " milliseconds\n"
            + "  end   : " + end + " milliseconds\n");
        SchedulerUtil.runAt(delay, period, end, unit, new Runnable() {
            @Override
            public void run() {
                InputStream in0 = SystemUtil.createBatchStream("\n");
                action.react(item, input, in0, out, env);
            }
        });
    }

//    private void put(IItem item) {
//        if (item.getValue() != null)
//            env.put(item.getName(), item.getValue());
//        else
//            env.remove(item.getName());
//    }

    boolean isInBatchMode() {
        return isInBatchMode(in);
    }

    static boolean isInBatchMode(InputStream in) {
        return in != System.in;
    }

    /**
     * can be used to use a file as input (no user input possible). call this before you call {@link #run()}. this file
     * should have newline-separated entries that match the terminal structure.
     * 
     * @param batch The batch to set.
     */
    public void setBatch(File batch) {
        this.batch = batch.getPath();
        in = FileUtil.getFile(this.batch);
    }

    public void setBatch(String... cmds) {
        in = SystemUtil.createBatchStream(cmds);
    }

    private boolean isCommand(String input, String cmd) {
        return cmd.startsWith(StringUtil.substring(input.substring(1), null, KEY_COMMAND).toLowerCase());
    }

    /**
     * @return Returns the sequential.
     */
    public boolean isSequential() {
        return sequential;
    }

    /**
     * @param sequential The sequential to set.
     */
    public void setSequential(boolean sequential) {
        this.sequential = sequential;
    }

    /**
     * @return Returns the refreshConfig. see {@link #refreshConfig}
     */
    public boolean isRefreshConfig() {
        return refreshConfig;
    }

    /**
     * @param refreshConfig The refreshConfig to set. see {@link #refreshConfig}
     */
    public void setRefreshConfig(boolean refreshConfig) {
        this.refreshConfig = refreshConfig;
    }

    /**
     * nextLine
     * 
     * @param in
     * @return
     */
    private String nextLine(InputStream in) {
        String line = nextLine(input, in, out);
        //TODO: refactore to do the recording inside the base static nextLine(..)
        if (isRecording) {
            batch = batch == null ? line : batch + ", " + line;
        }
        return line;
    }

    public static String nextLine(InputStream in, PrintStream out) {
        return nextLine(new Scanner(in), in, out);
    }

    static String nextLine(Scanner scanner, InputStream in, PrintStream out) {
        String text = scanner.hasNextLine() ? scanner.nextLine() : null;
        if (isInBatchMode(in)) {
            out.println(text);
        }
        return text;
    }

    @Commit
    protected void initDeserialization() {
        env = createEnvironment(name, definitions);
        in = System.in;
        out = System.out;
    }

    public static final String getHelp() {
        return ENV.translate("help", false);
    }

    @Override
    public String toString() {
        return getClass() + ":\n"
            + StringUtil.toFormattedString(new PrivateAccessor(this).members(presentalMembers()), -1, false);
    }

    static String[] presentalMembers() {
        return new String[] { "name", "width", "height", "style", "bars", "refreshConfig", "batch",
            "useNetworkExtension", "sequential" };
    }

    public static void main(String[] args) {
    	AppLoader.useCp1252();
    	
//        if (args.length == 0) {
//            System.out.println("Please provide a file name as base for this terminal");
//            return;
//        }
        try {
//            //TODO: refactor
//            ClassLoader cl = new NetworkClassLoader(Thread.currentThread().getContextClassLoader());
//            Thread.currentThread().setContextClassLoader(cl);

            String name = args.length > 0 ? args[0] : DEFAULT_NAME;
            if (FileUtil.hasResource(name)) {
                ENV.extractResource(name);
                name = ENV.getConfigPath() + name;
            }
            ENV.extractResource("messages.properties");
            ENV.extractResource("wrench.png");
            boolean admin = args.length > 1 && args[1].equals(TerminalAdmin.ADMIN) ? true : false;
            if (admin/* || !new File(name).exists()*/) {
                TerminalAdmin.create(name).run();
            } else {
                create(name).run();
            }
        } catch (Exception e) {
            ManagedException.forward(e);
        }
    }

}
    

    

    

            

    

            



    
    






    
© 2015 - 2024 Weber Informatics LLC | Privacy Policy