/usr/lib/python3/dist-packages/sievelib/factory.py is in python3-sievelib 1.1.0-1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
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 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 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 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 | # coding: utf-8
"""
Tools for simpler sieve filters generation.
This module is intented to facilitate the creation of sieve filters
without having to write or to know the syntax.
Only commands (control/test/action) defined in the ``commands`` module
are supported.
"""
from __future__ import print_function, unicode_literals
import sys
from future.utils import python_2_unicode_compatible
import six
from sievelib.commands import (
get_command_instance, IfCommand, RequireCommand, FalseCommand
)
@python_2_unicode_compatible
class FiltersSet(object):
"""A set of filters."""
def __init__(self, name, filter_name_pretext=u"# Filter: ",
filter_desc_pretext=u"# Description: "):
"""Represents a set of one or more filters
:param name: the filterset's name
:param filter_name_pretext: the text that is used to mark a filter name
(as comment preceding the filter)
:param filter_desc_pretext: the text that is used to mark a filter
description
"""
self.name = name
self.filter_name_pretext = filter_name_pretext
self.filter_desc_pretext = filter_desc_pretext
self.requires = []
self.filters = []
def __str__(self):
target = six.StringIO()
self.tosieve(target)
ret = target.getvalue()
target.close()
return ret
def __isdisabled(self, fcontent):
"""Tells if a filter is disabled or not
Simply checks if the filter is surrounded by a "if false" test.
:param fcontent: the filter's name
"""
if not isinstance(fcontent, IfCommand):
return False
if not isinstance(fcontent["test"], FalseCommand):
return False
return True
def from_parser_result(self, parser):
cpt = 1
for f in parser.result:
if isinstance(f, RequireCommand):
if type(f.arguments["capabilities"]) == list:
[self.require(c) for c in f.arguments["capabilities"]]
else:
self.require(f.arguments["capabilities"])
continue
name = "Unnamed rule %d" % cpt
description = ""
for comment in f.hash_comments:
if isinstance(comment, six.binary_type):
comment = comment.decode("utf-8")
if comment.startswith(self.filter_name_pretext):
name = comment.replace(self.filter_name_pretext, "")
if comment.startswith(self.filter_desc_pretext):
description = comment.replace(self.filter_desc_pretext, "")
self.filters += [{"name": name,
"description": description,
"content": f,
"enabled": not self.__isdisabled(f)}]
cpt += 1
def require(self, name):
"""Add a new extension to the requirements list
:param name: the extension's name
"""
name = name.strip('"')
if name not in self.requires:
self.requires += [name]
def check_if_arg_is_extension(self, arg):
"""Include extension if arg requires one."""
args_using_extensions = {
":copy": "copy"
}
if arg in args_using_extensions:
self.require(args_using_extensions[arg])
def __gen_require_command(self):
"""Internal method to create a RequireCommand based on requirements
Called just before this object is going to be dumped.
"""
if not len(self.requires):
return None
reqcmd = get_command_instance("require")
reqcmd.check_next_arg("stringlist", self.requires)
return reqcmd
def __quote_if_necessary(self, value):
"""Add double quotes to the given string if necessary
:param value: the string to check
:return: the string between quotes
"""
if not value.startswith(('"', "'")):
return '"%s"' % value
return value
def __build_condition(self, condition, parent, tag=None):
"""Translate a condition to a valid sievelib Command.
:param list condition: condition's definition
:param ``Command`` parent: the parent
:param str tag: tag to use instead of the one included into :keyword:`condition`
:rtype: Command
:return: the generated command
"""
if tag is None:
tag = condition[1]
cmd = get_command_instance("header", parent)
cmd.check_next_arg("tag", tag)
cmd.check_next_arg("string", self.__quote_if_necessary(condition[0]))
cmd.check_next_arg("string", self.__quote_if_necessary(condition[2]))
return cmd
def __create_filter(self, conditions, actions, matchtype="anyof"):
"""Create a new filter
A filter is composed of:
* a name
* one or more conditions (tests) combined together using ``matchtype``
* one or more actions
A condition must be given as a 3-uple of the form::
(test's name, operator, value)
An action must be given as a 2-uple of the form::
(action's name, value)
It uses the "header" test to generate the sieve syntax
corresponding to the given conditions.
:param conditions: the list of conditions
:param actions: the list of actions
:param matchtype: "anyof" or "allof"
"""
ifcontrol = get_command_instance("if")
mtypeobj = get_command_instance(matchtype, ifcontrol)
for c in conditions:
if c[0].startswith("not"):
negate = True
cname = c[0].replace("not", "", 1)
else:
negate = False
cname = c[0]
if cname in ("true", "false"):
cmd = get_command_instance(c[0], ifcontrol)
elif cname == "size":
cmd = get_command_instance("size", ifcontrol)
cmd.check_next_arg("tag", c[1])
cmd.check_next_arg("number", c[2])
elif cname == "exists":
cmd = get_command_instance("exists", ifcontrol)
cmd.check_next_arg(
"stringlist",
"[%s]" % (",".join('"%s"' % val for val in c[1:]))
)
else:
if c[1].startswith(':not'):
cmd = self.__build_condition(
c, ifcontrol, c[1].replace("not", "", 1))
not_cmd = get_command_instance("not", ifcontrol)
not_cmd.check_next_arg("test", cmd)
cmd = not_cmd
else:
cmd = self.__build_condition(c, ifcontrol)
if negate:
not_cmd = get_command_instance("not", ifcontrol)
not_cmd.check_next_arg("test", cmd)
cmd = not_cmd
mtypeobj.check_next_arg("test", cmd)
ifcontrol.check_next_arg("test", mtypeobj)
for actdef in actions:
action = get_command_instance(actdef[0], ifcontrol, False)
if action.is_extension:
self.require(actdef[0])
for arg in actdef[1:]:
self.check_if_arg_is_extension(arg)
if arg.startswith(":"):
atype = "tag"
else:
atype = "string"
arg = self.__quote_if_necessary(arg)
action.check_next_arg(atype, arg, check_extension=False)
ifcontrol.addchild(action)
return ifcontrol
def _unicode_filter_name(self, name):
"""Convert name to unicode if necessary."""
return (
name.decode("utf-8") if isinstance(name, six.binary_type) else name
)
def addfilter(self, name, conditions, actions, matchtype="anyof"):
"""Add a new filter to this filters set
:param name: the filter's name
:param conditions: the list of conditions
:param actions: the list of actions
:param matchtype: "anyof" or "allof"
"""
ifcontrol = self.__create_filter(conditions, actions, matchtype)
self.filters += [{
"name": self._unicode_filter_name(name), "content": ifcontrol,
"enabled": True}
]
def updatefilter(
self, oldname, newname, conditions, actions, matchtype="anyof"):
"""Update a specific filter
Instead of removing and re-creating the filter, we update the
content in order to keep the original order between filters.
:param oldname: the filter's current name
:param newname: the filter's new name
:param conditions: the list of conditions
:param actions: the list of actions
:param matchtype: "anyof" or "allof"
"""
oldname = self._unicode_filter_name(oldname)
newname = self._unicode_filter_name(newname)
for f in self.filters:
if f["name"] == oldname:
f["name"] = newname
f["content"] = \
self.__create_filter(conditions, actions, matchtype)
if not f["enabled"]:
return self.disablefilter(newname)
return True
return False
def replacefilter(
self, oldname, sieve_filter, newname=None, description=None):
"""replace a specific sieve_filter
Instead of removing and re-creating the sieve_filter, we update the
content in order to keep the original order between filters.
:param oldname: the sieve_filter's current name
:param newname: the sieve_filter's new name
:param sieve_filter: the sieve_filter object as get from
FiltersSet.getfilter()
"""
oldname = self._unicode_filter_name(oldname)
newname = self._unicode_filter_name(newname)
if newname is None:
newname = oldname
for f in self.filters:
if f["name"] == oldname:
f["name"] = newname
f["content"] = sieve_filter
if description is not None:
f['description'] = description
if not f["enabled"]:
return self.disablefilter(newname)
return True
return False
def getfilter(self, name):
"""Search for a specific filter
:param name: the filter's name
:return: the Command object if found, None otherwise
"""
name = self._unicode_filter_name(name)
for f in self.filters:
if f["name"] == name:
if not f["enabled"]:
return f["content"].children[0]
return f["content"]
return None
def removefilter(self, name):
"""Remove a specific filter
:param name: the filter's name
"""
name = self._unicode_filter_name(name)
for f in self.filters:
if f["name"] == name:
self.filters.remove(f)
return True
return False
def enablefilter(self, name):
"""Enable a filter
Just removes the "if false" test surrouding this filter.
:param name: the filter's name
"""
name = self._unicode_filter_name(name)
for f in self.filters:
if f["name"] != name:
continue
if not self.__isdisabled(f["content"]):
return False
f["content"] = f["content"].children[0]
f["enabled"] = True
return True
return False # raise NotFound
def is_filter_disabled(self, name):
"""Tells if the filter is currently disabled or not
:param name: the filter's name
"""
name = self._unicode_filter_name(name)
for f in self.filters:
if f["name"] == name:
return self.__isdisabled(f["content"])
return True
def disablefilter(self, name):
"""Disable a filter
Instead of commenting the filter, we just surround it with a
"if false { }" test.
:param name: the filter's name
:return: True if filter was disabled, False otherwise
"""
name = self._unicode_filter_name(name)
ifcontrol = get_command_instance("if")
falsecmd = get_command_instance("false", ifcontrol)
ifcontrol.check_next_arg("test", falsecmd)
for f in self.filters:
if f["name"] != name:
continue
ifcontrol.addchild(f["content"])
f["content"] = ifcontrol
f["enabled"] = False
return True
return False
def movefilter(self, name, direction):
"""Moves the filter up or down
:param name: the filter's name
:param direction: string "up" or "down"
"""
name = self._unicode_filter_name(name)
cpt = 0
for f in self.filters:
if f["name"] == name:
if direction == "up":
if cpt == 0:
return False
self.filters.remove(f)
self.filters.insert(cpt - 1, f)
return True
if cpt == len(self.filters) - 1:
return False
self.filters.remove(f)
self.filters.insert(cpt + 1, f)
return True
cpt += 1
return False # raise not found
def dump(self):
"""Dump this object
Available for debugging purposes
"""
print("Dumping filters set %s\n" % self.name)
cmd = self.__gen_require_command()
if cmd:
print("Dumping requirements")
cmd.dump()
print
for f in self.filters:
print("Filter Name: %s" % f["name"])
print("Filter Description: %s" % f["description"])
f["content"].dump()
def tosieve(self, target=sys.stdout):
"""Generate the sieve syntax corresponding to this filters set
This method will usually be called when this filters set is
done. The default is to print the sieve syntax on the standard
output. You can pass an opened file pointer object if you want
to write the content elsewhere.
:param target: file pointer where the sieve syntax will be printed
"""
cmd = self.__gen_require_command()
if cmd:
cmd.tosieve(target=target)
target.write(u"\n")
for f in self.filters:
target.write("{}{}\n".format(self.filter_name_pretext, f["name"]))
if "description" in f and f["description"]:
target.write(u"{}{}\n".format(
self.filter_desc_pretext, f["description"]))
f["content"].tosieve(target=target)
if __name__ == "__main__":
fs = FiltersSet("test")
fs.addfilter("rule1",
[("Sender", ":is", "toto@toto.com"), ],
[("fileinto", "Toto"), ])
fs.tosieve()
|