229 lines
8.5 KiB
Python
229 lines
8.5 KiB
Python
# PyMod-Milter 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.
|
|
#
|
|
# PyMod-Milter 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 PyMod-Milter. If not, see <http://www.gnu.org/licenses/>.
|
|
#
|
|
|
|
__all__ = [
|
|
"ActionConfig",
|
|
"Action"]
|
|
|
|
import os
|
|
import re
|
|
|
|
from bs4 import BeautifulSoup
|
|
|
|
from pymodmilter import CustomLogger, BaseConfig
|
|
from pymodmilter.conditions import ConditionsConfig, Conditions
|
|
from pymodmilter import modifications, storages
|
|
|
|
|
|
class ActionConfig(BaseConfig):
|
|
def __init__(self, idx, rule_cfg, cfg, debug):
|
|
if "name" in cfg:
|
|
assert isinstance(cfg["name"], str), \
|
|
f"{rule_cfg['name']}: Action #{idx}: name: invalid value, " \
|
|
f"should be string"
|
|
cfg["name"] = f"{rule_cfg['name']}: {cfg['name']}"
|
|
else:
|
|
cfg["name"] = f"{rule_cfg['name']}: Action #{idx}"
|
|
|
|
if "loglevel" not in cfg:
|
|
cfg["loglevel"] = rule_cfg["loglevel"]
|
|
|
|
super().__init__(cfg, debug)
|
|
|
|
self["pretend"] = rule_cfg["pretend"]
|
|
self["conditions"] = None
|
|
self["type"] = ""
|
|
|
|
if "pretend" in cfg:
|
|
pretend = cfg["pretend"]
|
|
assert isinstance(pretend, bool), \
|
|
f"{self['name']}: pretend: invalid value, should be bool"
|
|
self["pretend"] = pretend
|
|
|
|
assert "type" in cfg, \
|
|
f"{self['name']}: mandatory parameter 'type' not found"
|
|
assert isinstance(cfg["type"], str), \
|
|
f"{self['name']}: type: invalid value, should be string"
|
|
self["type"] = cfg["type"]
|
|
|
|
if self["type"] == "add_header":
|
|
self["class"] = modifications.AddHeader
|
|
self["headersonly"] = True
|
|
|
|
if "field" not in cfg and "header" in cfg:
|
|
cfg["field"] = cfg["header"]
|
|
|
|
self.add_string_arg(cfg, ("field", "value"))
|
|
|
|
elif self["type"] == "mod_header":
|
|
self["class"] = modifications.ModHeader
|
|
self["headersonly"] = True
|
|
|
|
if "field" not in cfg and "header" in cfg:
|
|
cfg["field"] = cfg["header"]
|
|
|
|
args = ["field", "value"]
|
|
if "search" in cfg:
|
|
args.append("search")
|
|
|
|
for arg in args:
|
|
self.add_string_arg(cfg, arg)
|
|
if arg in ("field", "search"):
|
|
try:
|
|
self["args"][arg] = re.compile(
|
|
self["args"][arg],
|
|
re.MULTILINE + re.DOTALL + re.IGNORECASE)
|
|
except re.error as e:
|
|
raise ValueError(f"{self['name']}: {arg}: {e}")
|
|
|
|
elif self["type"] == "del_header":
|
|
self["class"] = modifications.DelHeader
|
|
self["headersonly"] = True
|
|
|
|
if "field" not in cfg and "header" in cfg:
|
|
cfg["field"] = cfg["header"]
|
|
|
|
args = ["field"]
|
|
if "value" in cfg:
|
|
args.append("value")
|
|
|
|
for arg in args:
|
|
self.add_string_arg(cfg, arg)
|
|
try:
|
|
self["args"][arg] = re.compile(
|
|
self["args"][arg],
|
|
re.MULTILINE + re.DOTALL + re.IGNORECASE)
|
|
except re.error as e:
|
|
raise ValueError(f"{self['name']}: {arg}: {e}")
|
|
|
|
elif self["type"] == "add_disclaimer":
|
|
self["class"] = modifications.AddDisclaimer
|
|
self["headersonly"] = False
|
|
|
|
if "html_template" not in cfg and "html_file" in cfg:
|
|
cfg["html_template"] = cfg["html_file"]
|
|
|
|
if "text_template" not in cfg and "text_file" in cfg:
|
|
cfg["text_template"] = cfg["text_file"]
|
|
|
|
if "error_policy" not in cfg:
|
|
cfg["error_policy"] = "wrap"
|
|
|
|
self.add_string_arg(
|
|
cfg, ("action", "html_template", "text_template",
|
|
"error_policy"))
|
|
assert self["args"]["action"] in ("append", "prepend"), \
|
|
f"{self['name']}: action: invalid value, " \
|
|
f"should be 'append' or 'prepend'"
|
|
assert self["args"]["error_policy"] in ("wrap",
|
|
"ignore",
|
|
"reject"), \
|
|
f"{self['name']}: error_policy: invalid value, " \
|
|
f"should be 'wrap', 'ignore' or 'reject'"
|
|
|
|
try:
|
|
with open(self["args"]["html_template"], "r") as f:
|
|
html = BeautifulSoup(f.read(), "html.parser")
|
|
body = html.find('body')
|
|
if body:
|
|
# just use content within the body tag if present
|
|
html = body
|
|
self["args"]["html_template"] = html
|
|
|
|
with open(self["args"]["text_template"], "r") as f:
|
|
self["args"]["text_template"] = f.read()
|
|
|
|
except IOError as e:
|
|
raise RuntimeError(
|
|
f"{self['name']}: unable to open/read template file: {e}")
|
|
|
|
elif self["type"] == "rewrite_links":
|
|
self["class"] = modifications.RewriteLinks
|
|
self["headersonly"] = False
|
|
self.add_string_arg(cfg, "repl")
|
|
|
|
elif self["type"] == "store":
|
|
self["headersonly"] = False
|
|
|
|
assert "storage_type" in cfg, \
|
|
f"{self['name']}: mandatory parameter 'storage_type' not found"
|
|
assert isinstance(cfg["type"], str), \
|
|
f"{self['name']}: storage_type: invalid value, " \
|
|
f"should be string"
|
|
self["storage_type"] = cfg["storage_type"]
|
|
|
|
if "original" in cfg:
|
|
self.add_bool_arg(cfg, "original")
|
|
|
|
if self["storage_type"] == "file":
|
|
self["class"] = storages.FileMailStorage
|
|
self.add_string_arg(cfg, "directory")
|
|
# check if directory exists and is writable
|
|
if not os.path.isdir(self["args"]["directory"]) or \
|
|
not os.access(self["args"]["directory"], os.W_OK):
|
|
raise RuntimeError(
|
|
f"{self['name']}: file quarantine directory "
|
|
f"'{self['directory']}' does not exist or is "
|
|
f"not writable")
|
|
else:
|
|
raise RuntimeError(
|
|
f"{self['name']}: storage_type: invalid storage type")
|
|
|
|
else:
|
|
raise RuntimeError(f"{self['name']}: type: invalid action type")
|
|
|
|
if "conditions" in cfg:
|
|
conditions = cfg["conditions"]
|
|
assert isinstance(conditions, dict), \
|
|
f"{self['name']}: conditions: invalid value, should be dict"
|
|
self["conditions"] = ConditionsConfig(self, conditions, debug)
|
|
|
|
self.logger.debug(f"pretend={self['pretend']}, "
|
|
f"loglevel={self['loglevel']}, "
|
|
f"type={self['type']}, "
|
|
f"args={self['args']}")
|
|
|
|
|
|
class Action:
|
|
"""Action to implement a pre-configured action to perform on e-mails."""
|
|
|
|
def __init__(self, milter_cfg, cfg):
|
|
self.logger = cfg.logger
|
|
|
|
if cfg["conditions"] is None:
|
|
self.conditions = None
|
|
else:
|
|
self.conditions = Conditions(milter_cfg, cfg["conditions"])
|
|
|
|
self.pretend = cfg["pretend"]
|
|
self._name = cfg["name"]
|
|
self._class = cfg["class"](**cfg["args"])
|
|
self._headersonly = cfg["headersonly"]
|
|
|
|
def headersonly(self):
|
|
"""Return the needs of this action."""
|
|
return self._headersonly
|
|
|
|
def execute(self, milter):
|
|
"""Execute configured action."""
|
|
logger = CustomLogger(
|
|
self.logger, {"name": self._name, "qid": milter.qid})
|
|
|
|
if self.conditions is None or \
|
|
self.conditions.match(envfrom=milter.mailfrom,
|
|
envto=[*milter.rcpts],
|
|
headers=milter.msg.items()):
|
|
return self._class.execute(
|
|
milter=milter, pretend=self.pretend, logger=logger)
|