# -*- coding: utf-8 -*-

# vim:set expandtab tabstop=4 shiftwidth=4: 

"""Gestion de la requête, des plugins et de l'affichage du Vigiboard"""

from vigiboard.model.vigiboard_bdd import Events, Host, Service, \

        HostGroups, ServiceGroups, EventHistory

from tg import tmpl_context, url

from vigiboard.model import DBSession

from sqlalchemy import not_ , and_ , asc , desc

from tw.jquery import JQueryUIDialog

from vigiboard.widgets.edit_event import EditEventForm , SearchForm

from vigiboard.controllers.vigiboard_ctl.userutils import get_user_groups

from pylons.i18n import ugettext as _

class VigiboardRequest():

    """

    Classe gérant la génération de la requête finale,

    le préformatage des évènements et celui des historiques

    """

    def __init__(self):

        """

        Initialisation de toutes les variables nécessaires: Liste des groupes de

        l'utilisateur, les classes à appliquer suivant la sévérité, les

        différentes étapes de la génération de la requête et la liste des

        plugins appliqués.

        """

        self.user_groups = get_user_groups()

        self.bouton_severity = { 0: 'Minor', 1: 'Minor', 2: 'Minor',

                3: 'Minor', 4: 'Minor', 5: 'Minor', 6: 'Major', 7: 'Critical' }

        self.class_severity = { 0: 'None', 1: 'None', 2: 'None', 3: 'None',

                4: 'None', 5: 'Minor', 6: 'Major', 7: 'Critical' }

        self.severity = { 0: _('None'), 1: _('OK'), 2: _('Suppressed'),

                3: _('Initial'), 4: _('Maintenance'), 5: _('Minor'),

                6: _('Major'), 7: _('Critical') }

        self.class_ack = {'Acknowledged': 'Ack', 'None': '', 'AAClosed': 'Ack'}

        self.generaterq = False

        self.table = [Events]

        self.join = [( Host, Events.hostname == Host.name ),

                ( Service, Events.servicename == Service.name ),

                ( HostGroups , Host.name == HostGroups.hostname ),

                ( ServiceGroups , Service.name == ServiceGroups.servicename )

                ]

        self.outerjoin = []

        self.filter = [HostGroups.groupname.in_(self.user_groups),

                 ServiceGroups.groupname.in_(self.user_groups),

                 not_(and_(Events.active == False,

                     Events.status == 'AAClosed')),

                 Events.timestamp_active != None,

                 not_(Events.timestamp_active.like('0000-00-00 00:00:00'))]

        self.orderby = [asc(Events.status),

                                desc(Events.active),

                                desc(Events.severity),

                                asc(Events.hostname),

                                desc(Events.timestamp)]

        self.groupby = []

        self.plugin = []

        self.events = []

        self.idevents = []

        self.hist = []

        self.req = DBSession

    def add_plugin(self, *argv):

        """

        Ajout d'un plugin, on lui prélève ses ajouts dans la requête

        """

        for i in argv :

            if isinstance(i, VigiboardRequestPlugin):

                if i.table :

                    self.add_table(*i.table)

                if i.join :

                    self.add_join(*i.join)

                if i.outerjoin :

                    self.add_outer_join(*i.outerjoin)

                if i.filter :

                    self.add_filter(*i.filter)

                if i.groupby :    

                    self.add_group_by(*i.groupby)

                if i.orderby :

                    self.add_order_by(*i.orderby)

                self.plugin.append(i)

    def generate_request(self):

        """

        Génération de la requête avec l'ensemble des données stockées

        et la place dans la variable rq de la classe

        """

        # query et join ont besoin de referrence

        self.req = self.req.query(*self.table)

        self.req = self.req.join(*self.join)

        # le reste, non

        for i in self.outerjoin:

            self.req = self.req.outerjoin(i)

        for i in self.filter:

            self.req = self.req.filter(i)

        for i in self.groupby:

            self.req = self.req.group_by(i)

        for i in self.orderby:

            self.req = self.req.order_by(i)

    def num_rows(self):

        """

        Retourne le nombre de lignes de la requête.

        Si celle-ci n'est pas encore générée, on le fait.

        @return: Nombre de ligne

        """

        if not self.generaterq :

            self.generate_request()

            self.generaterq = True

        return self.req.count()

    def add_table(self, *argv):

        """

        Ajoute une ou plusieurs tables/élément d'une table à

        la requête.

        @param argv: Liste des tables à ajouter

        """

        #On vérifi qu'il n'y a pas de doublons dans la liste des

        #tables finale

        for i in argv :

            for j in self.table:

                if str(i) == str(j):

                    break

            self.table.append(i)

    def add_join(self, *argv):

        """

        Ajoute une ou plusieurs jointures à

        la requête.

        @param argv: Liste des jointures à ajouter

        """

        #On vérifi qu'il n'y a pas de doublons dans la liste des

        #jointures finale

        for i in argv:

            for j in self.join:

                if str(i) == str(j):

                    break

            self.join.append(i)

    def add_outer_join(self, *argv):

        """

        Ajoute une ou plusieurs jointures externes à

        la requête.

        @param argv: Liste des jointures externes à ajouter

        """

        #On vérifi qu'il n'y a pas de doublons dans la liste des

        #jointures externes finale

        for i in argv:

            for j in self.outerjoin:

                if str(i) == str(j):

                    break

            self.outerjoin.append(i)    

    def add_filter(self, *argv):

        """

        Ajoute un ou plusieurs filtres à la requête.

        @param argv: Liste des filtres à ajouter

        """

        #On vérifi qu'il n'y a pas de doublons dans la liste des

        #filtres finale

        for i in argv:

            for j in self.filter:

                if str(i) == str(j):

                    break

            self.filter.append(i)

    def add_group_by(self, *argv):

        """

        Ajoute un ou plusieurs groupements à la requête.

        @param argv: Liste des groupements à ajouter

        """

        #On vérifi qu'il n'y a pas de doublons dans la liste des

        #groupements finale

        for i in argv:

            for j in self.groupby:

                if str(i) == str(j):

                    break

            self.groupby.append(i)

    def add_order_by(self, *argv):

        """

        Ajoute un ou plusieurs orders à la requête.

        @param argv: Liste des ordres à ajouter

        """

        #On vérifi qu'il n'y a pas de doublons dans la liste des

        #ordres finale

        for i in argv:

            for j in self.orderby:

                if str(i) == str(j):

                    break

            self.orderby.append(i)

    def format_events_img_statu (self, event):

        """

        Suivant l'état de l'évènement, retourne la classe à appliquer

        à l'image indiquant si l'évènement est pris en compte ou non.

        @param event: l'évènement à analyser

        @return: Dictionnaire représentant la classe à appliquer

        """

        if event.active and event.status == 'AAClosed':

            return { 'src': url('/images/vigiboard/crossed.png') }

        elif event.status == 'Acknowledged' :

            return { 'src': url('/images/vigiboard/checked.png') }

        else:

            return None

    def format_events(self, first_row, last_row):

        """

        Formate la réponse de la requête et y applique les plugins

        pour un affichage simple du résultat par Genshi.

        On génère une liste de liste, chaqu'une étant la description de

        l'affichage pour un évènement donné.

        @param first_row: Indice de début de la liste des évènements

        @param last_row: Indice de fin de la liste des évènements

        """

        # Si la requête n'est pas générée, on le fait

        if not self.generaterq :

            self.generate_request()

            self.generaterq = True

        # Liste des éléments pour la tête du tableau

        lst_title = ['', _('Date<br />[Duration]'), '#', _('Host'),

                _('Service Type<br />Service Name'), _('Output')]

        lst_title.extend([plug.name for plug in self.plugin])

        lst_title.extend(['[T T]', ''])

        events = [lst_title]

        i = 0

        class_tr = ['odd', 'even']

        ids = []

        for req in self.req[first_row : last_row]:

            # Si il y a plus d'un élément dans la liste des tables,

            # rq devient une liste plutôt que d'être directement la

            # table souhaité

            if isinstance(req, Events) :

                event = req

            else :

                event = req[0]

            ids.append(event.idevent)

            # La liste pour l'évènement actuel comporte dans l'ordre :

            #   L'évènment en lui même

            #   La classe à appliquer sur la ligne (permet d'alterner les

            #       couleurs suivant les lignes)

            #   La classe pour la case comportant la flèche de détails

            #   La classe pour la date, l'occurrence et l'édition

            #   L'image a affiche pour la flèche de détails

            #   Une liste (une case par plugin) de ce que le plugin souhaite

            #       afficher en fonction de l'évènement

            if event.active :

                events.append([

                    event,

                    {'class': class_tr[i%2]},

                    {'class' : self.bouton_severity[event.severity] + \

                            self.class_ack[event.status]},

                    {'class' : self.bouton_severity[event.severity] + \

                            self.class_ack[event.status] },

                    {'src' : '/images/vigiboard/%s2.png' % \

                            self.bouton_severity[event.severity].upper()},

                    self.format_events_img_statu(event),

                    [[j.__show__(req), j.style] for j in self.plugin]

                    ])

            else :

                events.append([

                    event,

                    {'class': class_tr[i%2]},

                    {'class' : self.bouton_severity[event.severity] + \

                            self.class_ack[event.status] },

                    {'class' : 'Cleared' + self.class_ack[event.status] },

                    {'src' : '/images/vigiboard/%s2.png' % \

                            self.bouton_severity[event.severity].upper()},

                    self.format_events_img_statu(event),

                    [[j.__show__(req), j.style] for j in self.plugin]

                    ])

            i = i + 1

        # On sauvegarde la liste précédemment créée puis rempli

        # le TmplContext

        self.events = events

        self.idevents = ids

    def format_history (self):

        """

        Formate les historiques correspondant aux évènements sélectionnés

        pour un affichage simple du résultat par Genshi.

        On génère une liste de liste, chaqu'une étant la description de l'affichage pour un

        historique donné.

        """

        history = DBSession.query(EventHistory

                ).filter(EventHistory.idevent.in_(self.idevents)

                ).order_by(desc(EventHistory.timestamp)

                ).order_by(desc(EventHistory.idhistory))

        if history.count() == 0:

            self.hist = []

            return

        hists = []

        i = 0

        class_tr = ['odd', 'even']

        hostname = self.events[1][0].hostname

        servicename = self.events[1][0].servicename

        for hist in history :

            # La liste pour l'historique actuel comporte dans l'ordre :

            #   Son identifiant

            #   Son nom d'hôte

            #   Son nom de service

            #   Le moment où il a été généré

            #   Qui l'a généré

            #   Le type d'action qui a été appliqué

            #   La sévérité de l'action si besoin est

            #   Le détail de l'action

            #   La classe à appliquer à la ligne (permet d'alterner

            #       les couleurs)

            #   La classe de la sévérité s'il y a

            if hist.value :

                hists.append([

                    hist.idhistory,

                    hostname,

                    servicename,

                    hist.timestamp,

                    hist.username,

                    hist.type_action,

                    self.severity[min(int(hist.value),7)],

                    hist.text,

                    {'class' : class_tr[i%2]},

                    {'class':self.class_severity[min(int(hist.value),7)]}

                ])

            else:

                hists.append([

                    hist.idhistory,

                    hostname,

                    servicename,

                    hist.timestamp,

                    hist.username,

                    hist.type_action,

                    self.severity[0],

                    hist.text,

                    {'class' : class_tr[i%2]},

                    {'class':self.class_severity[0]}

                ])    

            i = i + 1

        self.hist = hists

    def generate_tmpl_context(self):

        """

        Génère et peuple la variable tmpl_context avec les Dialogs et

        formulaires nécessaire au fonctionnement de Vigiboard

        """

        # Dialogue d'édition

        tmpl_context.edit_event_form = EditEventForm('edit_event_form',

                action=url('/vigiboard/update'))

        tmpl_context.edit_eventdialog = JQueryUIDialog(id='Edit_EventsDialog',

                autoOpen=False,title=_('Edit Event'))

        # Dialogue de recherche

        tmpl_context.search_form = SearchForm('search_form',

                action=url('/vigiboard'))

        tmpl_context.searchdialog = JQueryUIDialog(id='SearchDialog',

                autoOpen=False,title=_('Search Event'))

        # Dialogue de détail d'un évènement

        tmpl_context.historydialog = JQueryUIDialog(id='HistoryDialog',

                autoOpen=False,title=_('History'))

class VigiboardRequestPlugin():

    """

    Classe dont les plugins utilisé dans VigiboardRequest doivent étendre.

    """

    def __init__ (self, table = None, join = None, outerjoin = None,

            filters = None, groupby = None, orderby = None, name = '',

            style = None):

        self.table = table

        self.join = join

        self.outerjoin = outerjoin

        self.filter = filters

        self.orderby = orderby

        self.name = name

        self.groupby = groupby

        self.style = style

    def __show__ (self, event):

        """

        Permet d'éviter toutes erreurs d'affichage.

        C'est la fonction appelé par le formateur d'évènements.

        """

        show = self.show(event)

        if show != None :

            try:

                return str(show)

            except:

                return _('Error')

    def show(self, event):

        """

        Fonction qui affichera par défaut une chaîne de

        caractères vide dans la colonne attribué au plugin.

        En général, les plugins devront redéfinir cette fonction

        pour afficher ce qu'ils souhaitent.

        """

        return ''