/
RuleTable.py
297 lines (252 loc) · 8.69 KB
/
RuleTable.py
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
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
122
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
152
153
154
155
156
157
158
159
160
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
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
import os
import sys
import time
import exceptions
import copy
import logging
from threading import Thread, Lock
import uuid
try:
import cPickle as pickle
except:
import pickle
'''
@author: msune,lbergesio,omoya,cbermudo,CarolinaFernandez
@organization: i2CAT, OFELIA FP7
PolicyEngine RuleTable class
Encapsulates logic of a simple Rule Table
'''
from pypelib.resolver.Resolver import Resolver
from pypelib.Rule import Rule,TerminalMatch
from pypelib.parsing.ParseEngine import ParseEngine
from pypelib.persistence.PersistenceEngine import PersistenceEngine
from pypelib.utils.Logger import Logger
from pypelib.utils.Exceptions import *
class RuleEntry():
rule = None
enabled = True
def __init__(self,rule, enabled=True):
self.rule = rule
self.enabled = enabled
class RuleTable():
logger = Logger.getLogger()
uuid=None
name=None
_persist = None
_parser = None
_persistenceBackend = None
_persistenceBackendParameters=None
#Default table policy
_policy = None
_ruleSet = None
_mappings = None
_mutex = None
_resolver = None
#Constructor
def __init__(self,name,resolverMappings,defaultParser, defaultPersistence, defaultPersistenceFlag, pType = False, uuid = None,**kwargs):
if not isinstance(pType,bool):
raise Exception("Unknown default table policy")
self.uuid = uuid
self.name = name
self._mutex = Lock()
self._policy = pType
self._parser = defaultParser
self._persistenceBackend = defaultPersistence
self._persist = defaultPersistenceFlag
self._mappings = resolverMappings
self._ruleSet = list()
self._persistenceBackendParameters = kwargs
if self._persist:
self.save(self._persistenceBackend,**kwargs)
#Generate the resolver
self._resolver = Resolver(resolverMappings)
#Deep copy
def clone(self):
#XXX: in principle mutex is not needed since methods calling clone() are already protected
#with self._mutex:
cpTable = RuleTable(self.name,None,self._parser,self._persistenceBackend, False,self._policy,self.uuid, **self._persistenceBackendParameters)
cpTable._mutex = None
cpTable._persist = copy.deepcopy(self._persist)
cpTable._ruleSet = copy.deepcopy(self._ruleSet)
cpTable._resolver = None
return cpTable
#Determine rule position
def _getRuleIndex(self, rule):
for it in self._ruleSet:
if it.rule == rule:
return self._ruleSet.index(it)
return None
def getRule(self, index):
return self._ruleSet[index].rule
#Add, move and remove rule
def addRule(self,string,enabled=True,pos=None,parser=None,pBackend=None,persist=True):
if not parser:
parser = self._parser
rule = ParseEngine.parseRule(string, parser)
rule.setUUID(uuid.uuid4().hex)
with self._mutex:
if pos > len(self._ruleSet):
#raise Exception("Invalid position")
self._ruleSet.append(RuleEntry(rule,enabled))
elif pos !=None:
self._ruleSet.insert(pos,RuleEntry(rule,enabled))
else:
self._ruleSet.append(RuleEntry(rule,enabled))
if self._persist:
self.save()
def removeRule(self,rule=None, index=None):
if (not rule) and (index == None):
raise Exception("Unable to determine which rule to remove; you must specify either the rule or the index")
with self._mutex:
if index == None:
index = self._getRuleIndex(rule)
if index == None:
raise Exception("Unable to find rule in the ruleSet")
self._ruleSet.pop(index)
if self._persist:
self.save()
def moveRule(self, newIndex, rule=None, index=None):
if (not rule) and (index == None):
raise Exception("Unable to determine which rule to move; you must specify either the rule or the index")
with self._mutex:
if index == None:
index = self._getRuleIndex(rule)
if index == None:
raise Exception("Unable to find rule in the ruleSet")
self._ruleSet.insert(newIndex, self._ruleSet.pop(index))
if self._persist:
self.save()
def _modEnableRule(self, enable, rule=None,index=None):
if (not rule) and (index == None):
raise Exception("Unable to determine which rule to enable; you must specify either the rule or the index")
with self._mutex:
if index == None:
index = self._getRuleIndex(rule)
if index == None:
raise Exception("Unable to find rule in the ruleSet")
self._ruleSet[index].enabled = enable
if self._persist:
self.save()
def enableRule(self, rule=None, index=None):
return self._modEnableRule(True,rule,index)
def disableRule(self, rule=None, index= None):
return self._modEnableRule(False,rule,index)
def setPolicy(self, policy):
if not isinstance(policy,bool):
raise Exception("Unknown default table policy")
with self._mutex:
self._policy = policy
if self._persist:
self.save()
def setParser(self, parser):
with self._mutex:
self._parser = parser
if self._persist:
self.save()
def setPersistenceBackend(self, persistenceBackend):
with self._mutex:
self._persistenceBackend = persistenceBackend
if self._persist:
self.save()
def setPersistenceFlag(self, persistenceFlag):
with self._mutex:
self._persist = persistenceFlag
if self._persist:
self.save()
def setMappings(self, mappings):
with self._mutex:
self._mappings = mappings
if self._persist:
self.save()
def dump(self):
print "Table: "+self.name+" UUID: "+str(self.uuid)
print "NUmber of rules: "+str(len(self._ruleSet))
with self._mutex:
i=0
for it in self._ruleSet:
print "[%s]:"%i +it.rule.dump()+ " Enabled: "+str(it.enabled)
i+=1
print "Default policy: "+str(self._policy)
#Go through the table
def evaluate(self,metaObj):
#Iterate over ruleset
print "Policies > evaluating"
with self._mutex:
print "Policies > self: ", self
print "Policies > ruleset: ", self._ruleSet
for it in self._ruleSet:
if it.enabled:
print "Policies > it: ", it
print "Policies > it.enabled: ", it.enabled
print "Policies > it.rule: ", it.rule
try:
it.rule.evaluate(metaObj,self._resolver)
except TerminalMatch as terminal:
if terminal.value:
return True
else:
raise terminal
if self._policy:
return self._policy
else:
raise Exception("Policy verification failed. Policy type is DENY")
def save(self, pBackend=None,**kwargs):
if not pBackend:
pBackend = self._persistenceBackend
if not kwargs:
kwargs2 = self._persistenceBackendParameters
else:
kwargs2 = kwargs
PersistenceEngine.save(self,pBackend,**kwargs2)
#In general should not be called, use loadOrGenerate instead
@staticmethod
def load(name, resolverMappings, pBackend, **kwargs):
return PersistenceEngine.load(name,pBackend,resolverMappings,**kwargs)
@staticmethod
def loadOrGenerate(name,resolverMappings,defaultParser, defaultPersistence, defaultPersistenceFlag, pType=False, uuid=None,**kwargs):
print "name: ", name
print "resolverMappings: ",resolverMappings
print "defaultParser: ",defaultParser
print "defaultPersistence: ",defaultPersistence
print "defaultPersistenceFlag: ",defaultPersistenceFlag
print "pType: ",pType
print "uuid: ",uuid
try:
return PersistenceEngine.load(name,defaultPersistence, resolverMappings, defaultParser,**kwargs)
except ZeroPolicyObjectsReturned:
RuleTable.logger.warning("Unable to load RuleTable, generating a new one")
return RuleTable(name,resolverMappings,defaultParser, defaultPersistence, defaultPersistenceFlag, pType, uuid,**kwargs)
except MultiplePolicyObjectsReturned:
RuleTable.logger.warning("Unable to load a single RuleTable, asking the user")
raise MultiplePolicyObjectsReturned
except Exception as e:
RuleTable.logger.error("Unable to load RuleTable. Exception: %s" % str(e))
'''
Retrieves every Engine's PolicyRuleTable object for a given name.
This method should be seldom used.
'''
@staticmethod
def loadAll(name, defaultPersistence):
return PersistenceEngine.loadAll(name, defaultPersistence)
'''
Deletes a Engine's PolicyRuleTable object for a given ID.
This method should be seldom used.
'''
@staticmethod
def delete(tableID, defaultPersistence):
return PersistenceEngine.delete(tableID, defaultPersistence)
#Getters
def getRuleSet(self):
return self._ruleSet
def getName(self):
return self.name
def getPolicyType(self):
return self._policy
def getPersistence(self):
return self._persistenceBackend
def getParser(self):
return self._parser
def getResolverMappings(self):
return self._mappings
def getPersistenceFlag(self):
return self._persist