ulgmodel.py 11 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
import whois
32 33 34
import defaults


35 36 37 38 39

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

def debug(message):
45 46
    if(defaults.debug):
        log('DEBUG:' + message)
47 48


49 50 51
def annotateAS(asn):
    return asn+' | '+whois.lookup_as_name(asn)

52

53 54
class PersistentStorage(object):
    def __init__(self):
55 56
        self.data = {}

57 58 59
    def save(self,filename=defaults.persistent_storage_file):
        # TODO: locking
        f = open(filename,'wb')
60 61 62 63 64
        pickle.dump(self, f)
        f.close()

    @staticmethod
    def load(filename=defaults.persistent_storage_file):
65
        # TODO: locking
66 67 68 69 70 71 72 73 74 75 76 77 78 79
        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

80 81 82 83
    def delete(self,key):
        if(key in self.data.keys()):
            del(self.data[key])

84 85 86
    def getDict(self):
        return self.data

87
class TableDecorator(object):
88 89 90 91 92 93
    WHITE = 'white'
    RED = 'red'
    GREEN = 'green'
    BLUE = 'blue'
    YELLOW = 'yellow'
    BLACK = 'black'
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 122 123 124 125 126

    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 '',
127
                                 ).render('html')
128

129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156

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.")

157 158 159 160 161

class SelectionParameter(TextParameter):
    def __init__(self,option_tuples=[],name=defaults.STRING_PARAMETER,default=None):
        "option_tupes=[(value,name),(value2,name2),(value3equalsname3,),...]"
        self.option_tuples = []
162 163 164 165 166 167 168 169
        self.setOptions(option_tuples)
        self.name=name
        self.default=default

    def getType(self):
        return 'select'

    def getDefault(self):
170 171 172 173
        if(self.default and (self.default in [v[0] for v in self.getOptions()])):
            return self.default
        else:
            return self.getOptions()[0]
174 175

    def setOptions(self,option_tuples):
176 177 178 179 180 181 182 183
        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.")
184 185 186 187 188

    def getOptions(self):
        return self.option_tuples

    def checkInput(self,input):
189
        if(input and (input in [v[0] for v in self.getOptions()])):
190 191 192 193 194
            return True
        else:
            return False

    def normalizeInput(self,input):
195
        log("DEBUG: returning selection parameter input: "+str(input))
196
        if(self.checkInput(input)):
197
            return input
198
        else:
199 200
            raise Exception("Invalid input encountered: Check did not passed.")

201 202 203 204 205 206 207

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

        if(name==None):
208 209 210 211
            if(self.param_specs):
                self.name=command % tuple([('<'+str(c.getName())+'>') for c in self.param_specs])
            else:
                self.name=command
212 213
        else:
            self.name=name
214 215 216 217 218 219 220 221 222

    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()))):
223
            log("Failed checking parameter count to zero, input:"+str(input)+' .')
224 225 226
            return False

        if(len(input)!=len(self.getParamSpecs())):
227
            log("Failed checking parameter count (nonzero), input: "+str(input)+' .')
228 229 230 231
            return False

        for pidx,p in enumerate(self.getParamSpecs()):
            if not p.checkInput(input[pidx]):
232
                log("Failed checking parameter: "+str(input[pidx]))
233 234 235 236 237 238 239 240 241 242 243 244 245 246
                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)

247 248 249 250
            if(parameters_normalized):
                return self.command % tuple(parameters_normalized)
            else:
                return self.command
251 252 253 254

        else:
            return None

255
    def rescanHook(self,router):
256 257
        pass

258
    def decorateResult(self,session,decorator_helper=None):
259
        if(session.getRange() != None and self.showRange()):
260
            s = str.splitlines(session.getResult())
261
            r=''
262
            for sl in s[session.getRange():session.getRange()+defaults.range_step+1]:
263 264 265
                r += sl + "\n"
            return ("<pre>\n%s\n</pre>" % r, len(s))
        else:
266 267 268 269
            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
270 271 272

    def showRange(self):
        return True
273 274 275

    def finishHook(self,session):
        pass
276 277 278 279 280 281
    
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
282
        self.asn = 'My ASN'
283 284 285 286 287 288 289 290 291 292 293 294 295 296 297

    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):
298
        self.setCommands([])
299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314
        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():
315
            c.rescanHook(self)
316 317 318 319 320 321

    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
322
    def __prepareCommand(self,command,parameters):
323 324 325
        c = command.getCommandText(parameters)

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

329
        debug("Going to run command "+c+" on router "+self.getName())
Tomas Hlavacek's avatar
Tomas Hlavacek committed
330
        return c
331

Tomas Hlavacek's avatar
Tomas Hlavacek committed
332 333
    def runSyncCommand(self,command,parameters):
        return self.runRawSyncCommand(self.__prepareCommand(command,parameters))
334 335

    def runAsyncCommand(self,command,parameters,outfile):
Tomas Hlavacek's avatar
Tomas Hlavacek committed
336
        return self.runRawCommand(self.__prepareCommand(command,parameters),outfile)
337 338 339 340 341

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

343
    def runRawCommand(self,command,outfile):
344 345 346 347 348 349
        """ 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
350 351 352 353 354 355
    def setASN(self,asn):
        self.asn = asn

    def getASN(self):
        return self.asn

356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380
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