Server IP : 85.214.239.14 / Your IP : 18.222.182.226 Web Server : Apache/2.4.62 (Debian) System : Linux h2886529.stratoserver.net 4.9.0 #1 SMP Tue Jan 9 19:45:01 MSK 2024 x86_64 User : www-data ( 33) PHP Version : 7.4.18 Disable Function : pcntl_alarm,pcntl_fork,pcntl_waitpid,pcntl_wait,pcntl_wifexited,pcntl_wifstopped,pcntl_wifsignaled,pcntl_wifcontinued,pcntl_wexitstatus,pcntl_wtermsig,pcntl_wstopsig,pcntl_signal,pcntl_signal_get_handler,pcntl_signal_dispatch,pcntl_get_last_error,pcntl_strerror,pcntl_sigprocmask,pcntl_sigwaitinfo,pcntl_sigtimedwait,pcntl_exec,pcntl_getpriority,pcntl_setpriority,pcntl_async_signals,pcntl_unshare, MySQL : OFF | cURL : OFF | WGET : ON | Perl : ON | Python : ON | Sudo : ON | Pkexec : OFF Directory : /srv/modoboa/env/lib/python3.5/site-packages/sievelib/ |
Upload File : |
# 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()