ulgmodel.py 10.8 KB
Newer Older
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23
#!/usr/bin/env python
#
# ULG - Universal Looking Glass
# by Tomas Hlavacek (tomas.hlavacek@nic.cz)
# last udate: June 21 2012
#
# This program is free software: you can redistribute it and/or modify
# it under the terms of the GNU 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 General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program.  If not, see <http://www.gnu.org/licenses/>.


# Imports
import os
import re
24 25 26
from time import localtime, strftime
from genshi.template import TemplateLoader
from genshi.core import Markup
27 28
import pickle
import fcntl
29
import StringIO
30 31 32 33

import defaults


34 35 36 37 38

def log(*messages):
    try:
        with open(defaults.log_file, 'a') as l:
            for m in messages:
39
                l.write(strftime("%b %d %Y %H:%M:%S: ", localtime()) + m + "\n")
40 41 42 43 44 45 46
    except Exception:
        pass

def debug(message):
    log('DEBUG:' + message)


47

48 49
class PersistentStorage(object):
    def __init__(self):
50 51
        self.data = {}

52 53 54
    def save(self,filename=defaults.persistent_storage_file):
        # TODO: locking
        f = open(filename,'wb')
55 56 57 58 59
        pickle.dump(self, f)
        f.close()

    @staticmethod
    def load(filename=defaults.persistent_storage_file):
60
        # TODO: locking
61 62 63 64 65 66 67 68 69 70 71 72 73 74
        if(os.path.isfile(filename)):
            f = open(filename, 'rb')
            s = pickle.load(f)
            f.close()
            return s
        else:
            return PersistentStorage()

    def get(self,key):
        return self.data.get(key,None)

    def set(self,key,value):
        self.data[key] = value

75 76 77 78
    def delete(self,key):
        if(key in self.data.keys()):
            del(self.data[key])

79 80 81
    def getDict(self):
        return self.data

82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121
class TableDecorator(object):
    WHITE = '#FFFFFF'
    RED = '#FF0000'
    GREEN = '#00FF00'
    BLUE = '#0000FF'
    YELLOW = '#FFFF00'
    BLACK = '#000000'

    def __init__(self, table, table_header, table_headline=None, before=None, after=None):
        self.table = table
        self.table_header = table_header
        self.table_headline = table_headline
        self.before = before
        self.after = after

        self.loader=TemplateLoader(
            os.path.join(os.path.dirname(__file__), defaults.template_dir),
            auto_reload=True
            )

    def decorate(self):
        def preprocessTableCell(td):
            if(isinstance(td,(list,tuple))):
                if(len(td) >= 2):
                    return (Markup(str(td[0])),Markup(str(td[1])))
                elif(len(td) == 1):
                    return (Markup(str(td[0])),Markup(TableDecorator.WHITE))
                else:
                    return ('',Markup(TableDecorator.WHITE))
            else:
                return (Markup(str(td)),Markup(TableDecorator.WHITE))

        t = [[preprocessTableCell(td) for td in tr ] for tr in self.table]

        template = self.loader.load(defaults.table_decorator_template_file)
        return template.generate(table=t,
                                 table_header=self.table_header,
                                 table_headline=Markup(self.table_headline) if self.table_headline else '',
                                 before=Markup(self.before) if self.before else '',
                                 after=Markup(self.after) if self.after else '',
122
                                 ).render('html')
123

124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151

class TextParameter(object):
    def __init__(self,pattern='.*',name=defaults.STRING_PARAMETER,default=''):
        self.name=name
        self.pattern=pattern
        self.default=default

    def getType(self):
        return 'text'

    def getName(self):
        return self.name

    def getDefault(self):
        return self.default

    def checkInput(self,input):
        if(re.compile(self.pattern).match(input)):
            return True
        else:
            return False

    def normalizeInput(self,input):
        if(self.checkInput(input)):
            return input
        else:
            raise Exception("Invalid input encountered: Check did not passed.")

152 153 154 155 156

class SelectionParameter(TextParameter):
    def __init__(self,option_tuples=[],name=defaults.STRING_PARAMETER,default=None):
        "option_tupes=[(value,name),(value2,name2),(value3equalsname3,),...]"
        self.option_tuples = []
157 158 159 160 161 162 163 164
        self.setOptions(option_tuples)
        self.name=name
        self.default=default

    def getType(self):
        return 'select'

    def getDefault(self):
165 166 167 168
        if(self.default and (self.default in [v[0] for v in self.getOptions()])):
            return self.default
        else:
            return self.getOptions()[0]
169 170

    def setOptions(self,option_tuples):
171 172 173 174 175 176 177 178
        self.option_tuples = []
        for o in option_tuples:
            if(len(o) >= 2):
                self.option_tuples.append(tuple((o[0],o[1],)))
            elif(len(o) == 1):
                self.option_tuples.append(tuple((o[0],o[0],)))
            else:
                raise Exception("Invalid option passed in SelectionParameter configuration. Zero-sized tuple.")
179 180 181 182 183

    def getOptions(self):
        return self.option_tuples

    def checkInput(self,input):
184
        if(input and (input in [v[0] for v in self.getOptions()])):
185 186 187 188 189
            return True
        else:
            return False

    def normalizeInput(self,input):
190
        log("DEBUG: returning selection parameter input: "+str(input))
191
        if(self.checkInput(input)):
192
            return input
193
        else:
194 195
            raise Exception("Invalid input encountered: Check did not passed.")

196 197 198 199 200 201 202

class TextCommand(object):
    def __init__(self,command,param_specs=[],name=None):
        self.command=command
        self.param_specs=param_specs

        if(name==None):
203 204 205 206
            if(self.param_specs):
                self.name=command % tuple([('<'+str(c.getName())+'>') for c in self.param_specs])
            else:
                self.name=command
207 208
        else:
            self.name=name
209 210 211 212 213 214 215 216 217

    def getParamSpecs(self):
        return self.param_specs

    def getName(self):
        return self.name

    def checkParamsInput(self,input):
        if(((not input) and (self.getParamSpecs()))or((input) and (not self.getParamSpecs()))):
218
            log("Failed checking parameter count to zero, input:"+str(input)+' .')
219 220 221
            return False

        if(len(input)!=len(self.getParamSpecs())):
222
            log("Failed checking parameter count (nonzero), input: "+str(input)+' .')
223 224 225 226
            return False

        for pidx,p in enumerate(self.getParamSpecs()):
            if not p.checkInput(input[pidx]):
227
                log("Failed checking parameter: "+str(input[pidx]))
228 229 230 231 232 233 234 235 236 237 238 239 240 241
                return False

        return True

    def normalizeParameters(self,parameters):
        if parameters == None:
            return [] 
        else:
            return [self.getParamSpecs()[pidx].normalizeInput(p) for pidx,p in enumerate(parameters)]

    def getCommandText(self,parameters=None):
        if(self.checkParamsInput(parameters)):
            parameters_normalized = self.normalizeParameters(parameters)

242 243 244 245
            if(parameters_normalized):
                return self.command % tuple(parameters_normalized)
            else:
                return self.command
246 247 248 249

        else:
            return None

250
    def rescanHook(self,router):
251 252
        pass

253 254 255
    def decorateResult(self,session,decorator_helper=None):
        if(session.getRange() != None):
            s = str.splitlines(session.getResult())
256
            r=''
257
            for sl in s[session.getRange():session.getRange()+defaults.range_step+1]:
258 259 260
                r += sl + "\n"
            return ("<pre>\n%s\n</pre>" % r, len(s))
        else:
261 262 263 264
            return ("<pre>\n%s\n</pre>" % session.getResult(), len(str.splitlines(session.getResult())))

    def getSpecialContent(self,session,**params):
        raise Exception("getSpecialContet() is not implemented in ulgmodel.TextCommand.")
Tomas Hlavacek's avatar
Tomas Hlavacek committed
265 266 267

    def showRange(self):
        return True
268 269 270 271 272 273
    
class AnyCommand(TextCommand):
    def __init__(self):
        self.command=''
        self.parameter = TextParameter('.+', name=defaults.STRING_COMMAND)
        self.name=defaults.STRING_ANY
Tomas Hlavacek's avatar
Tomas Hlavacek committed
274
        self.asn = 'My ASN'
275 276 277 278 279 280 281 282 283 284 285 286 287 288 289

    def getCommandText(self,parameters=None):
        c = ''

        parameters_normalized = self.normalizeParameters(parameters)
        if(len(parameters_normalized) == 0):
            raise Exception("Can not construct AnyCommand without valid parameter.")

        for p in parameters_normalized:
            c = c + ' ' + p

        return c

class Router(object):
    def __init__(self):
290
        self.setCommands([])
291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306
        self.setName('')

    def setName(self,name):
        self.name=name

    def getName(self):
        return self.name

    def setCommands(self, commands):
        self.commands=commands

    def listCommands(self):
        return self.commands

    def rescanHook(self):
        for c in self.listCommands():
307
            c.rescanHook(self)
308 309 310 311 312 313

    def returnError(self,error=None):
        r = '<em>'+defaults.STRING_ERROR_COMMANDRUN
        r = r + ': '+error+'</em>' if error else r+'.</em>'
        return r

Tomas Hlavacek's avatar
Tomas Hlavacek committed
314
    def __prepareCommand(self,command,parameters):
315 316 317
        c = command.getCommandText(parameters)

        if(c == None):
318
            log("Bad params encountered in command "+str(command.getName())+" : "+str(parameters))
319 320
            return self.returnError(defaults.STRING_BAD_PARAMS)

321
        debug("Going to run command "+c+" on router "+self.getName())
Tomas Hlavacek's avatar
Tomas Hlavacek committed
322
        return c
323

Tomas Hlavacek's avatar
Tomas Hlavacek committed
324 325
    def runSyncCommand(self,command,parameters):
        return self.runRawSyncCommand(self.__prepareCommand(command,parameters))
326 327

    def runAsyncCommand(self,command,parameters,outfile):
Tomas Hlavacek's avatar
Tomas Hlavacek committed
328
        return self.runRawCommand(self.__prepareCommand(command,parameters),outfile)
329 330 331 332 333

    def runRawSyncCommand(self,command):
        cr = StringIO.StringIO()
        self.runRawCommand(command,cr)
        return cr.getvalue()
334

335
    def runRawCommand(self,command,outfile):
336 337 338 339 340 341
        """ Abstract method. """
        raise Exception("runRawCommand() method not supported for the abstract class Router. Inherit from the class and implement the method.")

    def getForkNeeded(self):
        return False

Tomas Hlavacek's avatar
Tomas Hlavacek committed
342 343 344 345 346 347
    def setASN(self,asn):
        self.asn = asn

    def getASN(self):
        return self.asn

348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372
class RemoteRouter(Router):
    def getHost(self):
        return self.host

    def setHost(self,host):
        self.host = host

    def getPort(self):
        return self.port

    def setPort(self,port):
        self.port = port

    def getUser(self):
        return self.user

    def setUser(self,user):
        self.user = user

    def setPassword(self, password):
        self.password = password

class LocalRouter(Router):
    pass