glasswall.content_management.policies.word_search

  1import glasswall
  2from glasswall.content_management.config_elements.config_element import ConfigElement
  3from glasswall.content_management.policies.policy import Policy
  4from glasswall.content_management.switches.switch import Switch
  5
  6
  7class WordSearch(Policy):
  8    """ A content management policy for Word Search.
  9
 10    WordSearch(default="allow", config={
 11        "textSearchConfig": {
 12            "@libVersion": "core2",
 13            "textList": [
 14                {"name": "textItem", "switches": [
 15                    {"name": "text", "value": "generic"},
 16                    {"name": "textSetting", "@replacementChar": "*", "value": "redact"},
 17                ]},
 18            ]
 19        }
 20    })
 21    """
 22
 23    def __init__(self, default: str = "allow", config: dict = {}):
 24        self.default = default
 25        self.default_config_elements = [
 26            glasswall.content_management.config_elements.pdfConfig(default=default),
 27            glasswall.content_management.config_elements.pptConfig(default=default),
 28            glasswall.content_management.config_elements.sysConfig(interchange_type="xml"),
 29            glasswall.content_management.config_elements.tiffConfig(default=default),
 30            glasswall.content_management.config_elements.wordConfig(default=default),
 31            glasswall.content_management.config_elements.xlsConfig(default=default),
 32        ]
 33        self.config = config
 34
 35        super().__init__(
 36            default=self.default,
 37            default_config_elements=self.default_config_elements,
 38            config=self.config,
 39        )
 40
 41    def add_textItem(self, text: str, replacementChar: str, textSetting: str = "redact", **kwargs):
 42        """ Adds a textItem to the textSearchConfig textList subelements. """
 43        textSearchConfig = next(iter(c for c in self.config_elements if c.name == "textSearchConfig"), None)
 44        if not textSearchConfig:
 45            # Add textSearchConfig to ConfigElements
 46            textSearchConfig = ConfigElement(
 47                name="textSearchConfig",
 48                attributes={"libVersion": kwargs.get("libVersion", "core2")},
 49                subelements=[ConfigElement(name="textList")]
 50            )
 51            self.add_config_element(
 52                config_element=textSearchConfig,
 53            )
 54
 55        # Select the ConfigElement named textList
 56        textList = next(iter(s for s in textSearchConfig.subelements if s.name == "textList"))
 57
 58        # If textList has a subelement textItem that contains a switch named "text" with the same .value as arg "text", delete it to avoid duplicates.
 59        #   (cannot redact "generic" with "*" and also redact "generic" with "@")
 60        for textItem in textList.subelements.copy():
 61            for switch in textItem.switches:
 62                if switch.name == "text" and switch.value.lower() == text.lower():
 63                    # Remove textItem from tetList.subelements using the builtin list .remove method
 64                    textList.subelements.remove(textItem)
 65                    break
 66
 67        # Add textItem to end of textList.subelements
 68        textList.subelements.append(
 69            ConfigElement(
 70                name="textItem",
 71                switches=[
 72                    Switch(name="text", value=text),
 73                    Switch(name="textSetting", attributes={"replacementChar": replacementChar}, value=textSetting)
 74                ],
 75            )
 76        )
 77
 78        # Don't sort textList: this preserves top-down order for redaction settings.
 79
 80    def remove_textItem(self, text: str):
 81        """ Removes a textItem from the textSearchConfig textList subelements. """
 82        textSearchConfig = next(iter(c for c in self.config_elements if c.name == "textSearchConfig"), None)
 83        if not textSearchConfig:
 84            raise glasswall.content_management.errors.config_elements.ConfigElementNotFound("textSearchConfig")
 85
 86        # Select the ConfigElement named textList
 87        textList = next(iter(s for s in textSearchConfig.subelements if s.name == "textList"))
 88
 89        all_textItem_texts = [
 90            switch.value.lower()
 91            for textItem in textList.subelements
 92            for switch in textItem.switches
 93            if switch.name == "text"
 94        ]
 95        if text not in all_textItem_texts:
 96            raise glasswall.content_management.errors.switches.SwitchNotFound(f"No switch found with name: 'text' and value: '{text}'")
 97
 98        # If textList has a subelement textItem that contains a switch named "text" with the same .value as arg "text", delete it to avoid duplicates.
 99        #   (cannot redact "generic" with "*" and also redact "GeNeRiC" with "@")
100        for textItem in textList.subelements.copy():
101            for switch in textItem.switches:
102                if switch.name == "text" and switch.value.lower() == text.lower():
103                    textList.subelements.remove(textItem)
104                    break