ulgmodel.py 13.6 KB
Newer Older
1 2 3
#!/usr/bin/env python
#
# ULG - Universal Looking Glass
4
# (C) 2012 CZ.NIC, z.s.p.o.
5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22
#
# 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
23 24 25
from time import localtime, strftime
from genshi.template import TemplateLoader
from genshi.core import Markup
26 27
import pickle
import fcntl
28
import StringIO
29
import socket
30

31
import whois
32 33 34
import defaults


35 36 37 38
IPV4_SUBNET_REGEXP = '^[0-9]{1,3}\.[0-9]{1,3}\.[0-9]{1,3}\.[0-9]{1,3}(/[0-9]{1,2}){0,1}$'
IPV4_ADDRESS_REGEXP = '^[0-9]{1,3}\.[0-9]{1,3}\.[0-9]{1,3}\.[0-9]{1,3}$'
IPV6_SUBNET_REGEXP = '^[0-9a-fA-F:]+(/[0-9]{1,2}){0,1}$'
IPV6_ADDRESS_REGEXP = '^[0-9a-fA-F:]+$'
39 40 41 42 43

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

def debug(message):
49 50
    if(defaults.debug):
        log('DEBUG:' + message)
51 52


53 54 55
def annotateAS(asn):
    return asn+' | '+whois.lookup_as_name(asn)

56

57 58
class PersistentStorage(object):
    def __init__(self):
59 60
        self.data = {}

61 62 63
    def save(self,filename=defaults.persistent_storage_file):
        # TODO: locking
        f = open(filename,'wb')
64 65 66 67 68
        pickle.dump(self, f)
        f.close()

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

84 85 86 87
    def delete(self,key):
        if(key in self.data.keys()):
            del(self.data[key])

88 89 90
    def getDict(self):
        return self.data

91
class TableDecorator(object):
92 93 94 95 96 97
    WHITE = 'white'
    RED = 'red'
    GREEN = 'green'
    BLUE = 'blue'
    YELLOW = 'yellow'
    BLACK = 'black'
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 127 128 129 130

    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 '',
131
                                 ).render('html')
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 157 158 159 160

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

161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197
class AddressParameter(TextParameter):
    def __init__(self,pattern=None,name=defaults.STRING_IPADDRESS,default=''):
        TextParameter.__init__(self,pattern,name,default)

    def _resolveAddress(self,input):
        try:
            return(socket.getaddrinfo(input,80,self.addrfam,0,socket.SOL_TCP)[0][4][0])
        except Exception as e:
            return None

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

        if(self._resolveAddress(input)):
            return True
        else:
            return False

    def normalizeInput(self,input):
        if(re.compile(self.pattern).match(input)):
            return input

        res = self._resolveAddress(input)
        if(res):
            return res
        else:
            return input

class IPv4SubnetParameter(AddressParameter):
    def __init__(self,name=defaults.STRING_IPSUBNET,default=''):
        AddressParameter.__init__(self,IPV4_SUBNET_REGEXP,name,default)
        self.addrfam=socket.AF_INET

    def _resolveAddress(self,input):
        addr = AddressParameter._resolveAddress(self,input)
        if(addr):
198
            return (addr)
199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214
        else:
            return None

class IPv4AddressParameter(AddressParameter):
    def __init__(self,name=defaults.STRING_IPADDRESS,default=''):
        AddressParameter.__init__(self,IPV4_ADDRESS_REGEXP,name,default)
        self.addrfam=socket.AF_INET

class IPv6SubnetParameter(AddressParameter):
    def __init__(self,name=defaults.STRING_IPSUBNET,default=''):
        AddressParameter.__init__(self,IPV6_SUBNET_REGEXP,name,default)
        self.addrfam=socket.AF_INET6

    def _resolveAddress(self,input):
        addr = AddressParameter._resolveAddress(self,input)
        if(addr):
215
            return (addr)
216 217 218 219 220 221 222 223
        else:
            return None

class IPv6AddressParameter(AddressParameter):
    def __init__(self,name=defaults.STRING_IPADDRESS,default=''):
        AddressParameter.__init__(self,IPV6_ADDRESS_REGEXP,name,default)
        self.addrfam=socket.AF_INET6

224 225 226 227 228

class SelectionParameter(TextParameter):
    def __init__(self,option_tuples=[],name=defaults.STRING_PARAMETER,default=None):
        "option_tupes=[(value,name),(value2,name2),(value3equalsname3,),...]"
        self.option_tuples = []
229 230 231 232 233 234 235 236
        self.setOptions(option_tuples)
        self.name=name
        self.default=default

    def getType(self):
        return 'select'

    def getDefault(self):
237 238 239 240
        if(self.default and (self.default in [v[0] for v in self.getOptions()])):
            return self.default
        else:
            return self.getOptions()[0]
241 242

    def setOptions(self,option_tuples):
243 244 245 246 247 248 249 250
        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.")
251 252 253 254 255

    def getOptions(self):
        return self.option_tuples

    def checkInput(self,input):
256
        if(input and (input in [v[0] for v in self.getOptions()])):
257 258 259 260 261
            return True
        else:
            return False

    def normalizeInput(self,input):
262
        log("DEBUG: returning selection parameter input: "+str(input))
263
        if(self.checkInput(input)):
264
            return input
265
        else:
266 267
            raise Exception("Invalid input encountered: Check did not passed.")

268 269 270 271 272 273 274

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

        if(name==None):
275 276 277 278
            if(self.param_specs):
                self.name=command % tuple([('<'+str(c.getName())+'>') for c in self.param_specs])
            else:
                self.name=command
279 280
        else:
            self.name=name
281 282 283 284 285 286 287 288 289

    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()))):
290
            log("Failed checking parameter count to zero, input:"+str(input)+' .')
291 292 293
            return False

        if(len(input)!=len(self.getParamSpecs())):
294
            log("Failed checking parameter count (nonzero), input: "+str(input)+' .')
295 296 297 298
            return False

        for pidx,p in enumerate(self.getParamSpecs()):
            if not p.checkInput(input[pidx]):
299
                log("Failed checking parameter: "+str(input[pidx]))
300 301 302 303 304 305 306 307 308 309 310 311 312 313
                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)

314 315 316 317
            if(parameters_normalized):
                return self.command % tuple(parameters_normalized)
            else:
                return self.command
318 319 320 321

        else:
            return None

322
    def rescanHook(self,router):
323 324
        pass

325
    def decorateResult(self,session,decorator_helper=None):
326 327
        if(session.getResult() == None):
            return (decorator_helper.pre(defaults.STRING_EMPTY), 1)
328
        if(session.getRange() != None and self.showRange()):
329
            s = str.splitlines(session.getResult())
330
            r=''
331
            for sl in s[session.getRange():session.getRange()+defaults.range_step+1]:
332
                r += sl + "\n"
333
                r = r.replace('<','&lt;').replace('>','&gt;')
334 335
            return ("<pre>\n%s\n</pre>" % r, len(s))
        else:
336 337
            return ("<pre>\n%s\n</pre>" % session.getResult().replace('<','&lt;').replace('>','&gt;'),
                    len(str.splitlines(session.getResult())))
338 339 340

    def getSpecialContent(self,session,**params):
        raise Exception("getSpecialContet() is not implemented in ulgmodel.TextCommand.")
341 342 343

    def showRange(self):
        return True
344 345 346

    def finishHook(self,session):
        pass
347 348 349 350 351 352
    
class AnyCommand(TextCommand):
    def __init__(self):
        self.command=''
        self.parameter = TextParameter('.+', name=defaults.STRING_COMMAND)
        self.name=defaults.STRING_ANY
353
        self.asn = 'My ASN'
354 355 356 357 358 359 360 361 362 363 364 365 366 367 368

    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):
369
        self.setCommands([])
370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385
        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():
386
            c.rescanHook(self)
387 388 389 390 391 392

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

393
    def __prepareCommand(self,command,parameters):
394 395 396
        c = command.getCommandText(parameters)

        if(c == None):
397
            log("Bad params encountered in command "+str(command.getName())+" : "+str(parameters))
398
            return None
399

400
        debug("Going to run command "+c+" on router "+self.getName())
401
        return c
402

403
    def runSyncCommand(self,command,parameters):
404 405 406 407 408
        c = self.__prepareCommand(command,parameters)
        if(c):
            return self.runRawSyncCommand(c)
        else:
            return self.returnError(defaults.STRING_BAD_PARAMS)
409 410

    def runAsyncCommand(self,command,parameters,outfile):
411 412 413 414 415 416
        c = self.__prepareCommand(command,parameters)
        if(c):
            return self.runRawCommand(c,outfile)
        else:
            outfile.write(self.returnError(defaults.STRING_BAD_PARAMS))
            return
417 418 419 420 421

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

423
    def runRawCommand(self,command,outfile):
424 425 426 427 428 429
        """ 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

430 431 432 433 434 435
    def setASN(self,asn):
        self.asn = asn

    def getASN(self):
        return self.asn

436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460
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