linspector-old/linspector/frontends/lish.py

"""
Lish is the Linspector Interactive Shell.

This  will become a commandline interface to Linspector. Think of a
network switch or router like those from Cisco.

Copyright (c) 2011-2013 by Johannes Findeisen and Rafael Timmerberg

This file is part of Linspector (http://linspector.org).

Linspector is free software: you can redistribute it and/or modify
it under the terms of the GNU Affero General Public License as
published by the Free Software Foundation, either version 3 of the
License, or (at your option) any later version.

This program 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 Affero General Public License for more details.

You should have received a copy of the GNU Affero General Public License
along with this program. If not, see <http://www.gnu.org/licenses/>.
"""

import os
import socket

from cmd import Cmd
from logging import getLogger
from shlex import split as shsplit

from linspector.frontends.frontend import Frontend

__version__ = "0.2.3-alpha"

PURPLE = "\033[95m"
BLUE   = "\033[94m"
YELLOW = "\033[93m"
GREEN  = "\033[92m"
RED    = "\033[91m"
END    = "\033[0m"

logger = getLogger(__name__)


class LishFrontend(Frontend):
    def __init__(self, linpsectorInterface):
        super(LishFrontend, self)
        commander = LishCommander(linpsectorInterface)

        run = True
        while run:
            try:
                commander.cmdloop(GREEN + "Lish - Linspector interactive shell (" + __version__ + ")" + END)
            except KeyboardInterrupt, ki:
                run = False
            except Exception, err:
                print(err)

            if commander.can_exit():
                run = False


class CommandBase(Cmd, object):
    def __init__(self):
        super(CommandBase, self).__init__()
        self._needs_update = False

    def get_completion(self, args, text):
        if len(text) == 0:
            return args
        else:
            return [x for x in args if x.startswith(text)]


class Exit(CommandBase, object):
    def __init__(self):
        super(Exit, self).__init__()
        self.set_can_exit(False)

    def set_can_exit(self, canExit=True):
        self._canExit = canExit

    def can_exit(self):
        return self._canExit

    def do_exit(self, text):
        self.set_can_exit()
        return self.can_exit()

    def help_exit(self):
        print('''
Exits Linspector
''')


class Command(object):
    def __init__(self, name, command, helpText, children=None):
        self.name = name
        self.command = command
        self.helpText = helpText
        self.children = children
        self.completion = []
        if isinstance(children, list):
            for child in children:
                self.completion.append((child.get_name()))


class CommandTree(object):
    def __init__(self, name):
        self.name = name


class LishCommander(Exit):
    def __init__(self, linspectorInterface):
        super(LishCommander, self).__init__()

        self.prompt = BLUE + "<Lish@" + socket.gethostname() + ">: " + END
        self.interface = linspectorInterface

    def do_python(self, text):
        exec text

    def help_python(self):
        print('''
Executes Python code using 'exec'
''')

    def print_color(self, color, text):
        print(color + str(text) + END)

    def print_dict(self, dict):
        for key, val in dict.items():
            tab = ":\t"
            if len(str(key)) < 7:
                tab += "\t"

            print(GREEN + str(key) + END + tab + YELLOW + str(val) + END)

    def print_jobs_infos(self, job):
        self.print_dict(self.interface.get_job_info_dict(job))

    def do_job(self, text):
        text = shsplit(text)
        job_hex = text[0]
        job = self.interface.find_job_by_hex_string(job_hex)

        if job is None:
            self.print_color(RED, "First parameter must be a job ID. Get a List of all IDs by typing 'jobs list'")
            self.help_job()
            return

        if len(text) == 1:
            self.print_jobs_infos(job)
            return

        cmd = text[1]
        if cmd in ["enable", "disable"]:
            job.set_enabled("n" in cmd)
        else:
            self.print_color(RED, "Invalid or missing parameter")
            self.help_job()

    def complete_job(self, text, line, begidx, endidx):
        if begidx == 4:
            return self.get_completion(self.interface.get_job_hex_strings(), text)
        elif begidx == 13:
            return self.get_completion(["enable", "disable"], text)

    def help_job(self):
        print('''
Usage:
  <ID>          Prints extended information about this job
  <ID> enable   Enables a job
  <ID> disable  Disables a job
''')

    def do_jobs(self, text):
        if text == "list":
            for job in self.interface.jobs:
                job_dict = self.interface.get_job_info_dict(job)
                print GREEN + job_dict["Job"] + END + ":\t" + \
                    PURPLE + "Hostgroup" + END + ": " + job_dict["Hostgroup"] + \
                    PURPLE + " Host" + END + ": " + job_dict["Host"] + \
                    PURPLE + " Service" + END + ": " + job_dict["Service"] + \
                    PURPLE + " Next run" + END + ": " + job_dict["Next run"] + \
                    PURPLE + " Runs" + END + ": " + job_dict["Runs"] + \
                    PURPLE + " Fails" + END + ": " + job_dict["Fails"] + \
                    PURPLE + " Enabled" + END + ": " + job_dict["Enabled"]
        elif text == "count":
            print GREEN + "Job Count" + END + ":\t" + str(self.interface.get_job_count())
        else:
            self.print_color(RED, "Invalid or missing parameter")
            self.help_jobs()

    def help_jobs(self):
        print('''
Usage:
  count  Show count of all jobs
  list   Lists all jobs
''')

    def do_host(self, text):
        pass

    def help_host(self):
        print('''
Usage:
  <HOST>          Prints extended information about <HOST>
  <HOST> enable   Enables all jobs for <HOST>
  <HOST> disable  Disables all jobs for <HOST>
  <HOST> list     Lists all jobs for <HOST>
''')

    def do_hostgroup(self, text):
        pass

    def help_hostgroup(self):
        print('''
Usage:
  <HOSTGROUP>          Prints extended information about <HOSTGROUP>
  <HOSTGROUP> enable   Enables all jobs for <HOSTGROUP>
  <HOSTGROUP> disable  Disables all jobs for <HOSTGROUP>
  <HOSTGROUP> list     Lists all jobs for <HOSTGROUP>
''')

    def do_hostgrouphost(self, text):
        pass

    def help_hostgrouphost(self):
        print('''
Usage:
  <HOSTGROUP> <HOST>          Prints extended information about <HOST> in <HOSTGROUP>
  <HOSTGROUP> <HOST> enable   Enables all jobs for <HOST> in <HOSTGROUP>
  <HOSTGROUP> <HOST> disable  Disables all jobs for <HOST> in <HOSTGROUP>
  <HOSTGROUP> <HOST> list     Lists all jobs for <HOST> in <HOSTGROUP>
''')

    def do_shell(self, text):
        os.system(text)

    def help_shell(self):
        print("Execute any shell command. Can also be achieved by a '!' prefix")

    def complete_shell(self, text, line, begidx, endidx):
        try:
            PATH = os.environ['PATH'].split(os.pathsep)
            bins = []
            for p in PATH:
                bins.extend(os.listdir(p))

            return self.get_completion(bins, text, False)
        except:
            pass

    def do_log(self, text):
        if text == "tail":
            try:
                # TODO: do the tail on the logfile set by args and not a static path
                with open(os.path.dirname(os.path.abspath(__file__)) + "/../../log/linspector.log"):
                    os.system("tail -F " + os.path.dirname(os.path.abspath(__file__)) + "/../../log/linspector.log")
            except IOError:
                self.print_color(RED, "Logfile not found.")
                self.help_log()
        elif text == "less":
            try:
                # TODO: do the tail on the logfile set by args and not a static path
                with open(os.path.dirname(os.path.abspath(__file__)) + "/../../log/linspector.log"):
                    os.system("less " + os.path.dirname(os.path.abspath(__file__)) + "/../../log/linspector.log")
            except IOError:
                self.print_color(RED, "Logfile not found.")
                self.help_log()

    def help_log(self):
        print('''
Usage:
  less  less on the linspector logfile (press "q" to exit)
  tail  tail on the linspector logfile (Ctrl+C to exit)
''')

    def do_status(self, text):
        # TODO: print instance name from core config
        print GREEN + "Hostname" + END + ":\t" + socket.gethostname()
        # TODO: print instance uptime
        print GREEN + "Job Count" + END + ":\t" + str(self.interface.get_job_count())
        thread_info = self.interface.get_thread_count()
        print GREEN + "Threads" + END + ":\t" + str(thread_info["Num Threads"]) + "/" + str(thread_info["Max Threads"])
        print GREEN + "Lish Version" + END + ":\t" + __version__
        # TODO: print Linspector version
        #print GREEN + "Core Version" + END + ":\t" + __linspector_version__

    def help_status(self):
        print('''
Show status information about the Linspector instance
''')

    def do_about(self, text):
        self.print_color(GREEN,  "Linspector Monitoring\n")
        self.print_color(YELLOW, "Developers:")
        self.print_color(BLUE,   " - Johannes Findeisen <hanez@linspector.org>")
        self.print_color(BLUE,   " - Rafael Timmerberg <ruff@linspector.org>\n")
        self.print_color(PURPLE, "(c) 2011 - 2013")
        self.print_color(PURPLE, "Web: http://linspector.org")
        self.print_color(PURPLE, "License: GNU Affero General Public License Version 3.0")

    def help_about(self):
        print('''
Show information about Linspector
''')

    def do_license(self, text):
        os.system("less " + os.path.dirname(os.path.abspath(__file__)) + "/../../LICENSE")

    def help_license(self):
        print('''
Show license information
''')

    def do_man(self, text):
        try:
            with open(os.path.dirname(os.path.abspath(__file__)) + "/../../man/" + text + ".md"):
                #TODO: maybe convert markdown to plain text before displaying it and write own pager in pure Python
                os.system("less " + os.path.dirname(os.path.abspath(__file__)) + "/../../man/" + text + ".md")
        except IOError:
            self.print_color(RED, "Manual page \"" + text + "\" not found.")
            self.help_man()

    def help_man(self):
        print('''
Usage:
  <PAGE>  Show manual page <PAGE>
''')