Merge branch 'develop'

Author: manfred-kaiser

README.md

@@ -1,9 +1,9 @@
 # Sifter3 - Sieve email filter (RFC 5228)
 
-Sifter3 is a Python 3 implementation of the Sieve email filter language (RFC 5228) and is based on the Python 2 version from <https://github.com/garyp/sifter>
+Sifter3 is a Python 3 implementation of the Sieve email filter language (RFC 5228)
 
 ![Python package](https://github.com/manfred-kaiser/sifter3/workflows/Python%20package/badge.svg)
-[![Documentation Status](https://readthedocs.org/projects/sifter3/badge/?version=master)](https://sifter3.readthedocs.io/de/master/?badge=master)
+[![Documentation Status](https://readthedocs.org/projects/sifter3/badge/?version=latest)](https://sifter3.readthedocs.io/en/latest/?badge=latest)
 [![CodeFactor](https://www.codefactor.io/repository/github/manfred-kaiser/sifter3/badge)](https://www.codefactor.io/repository/github/manfred-kaiser/sifter3)
 [![Github version](https://img.shields.io/github/v/release/manfred-kaiser/sifter3?label=github&logo=github)](https://github.com/manfred-kaiser/sifter3/releases)
 [![PyPI version](https://img.shields.io/pypi/v/sifter3.svg?logo=pypi&logoColor=FFE873)](https://pypi.org/project/sifter3/)
@@ -18,13 +18,17 @@ FEATURES
 
 -   Supports all of the base Sieve spec from RFC 5228, except for
     features still listed under TODO below
+    -   multiline strings (since version 0.2.2)
+    -   bracketed comments (since version 0.2.4)
 -   Extensions supported:
     -   regex (draft-ietf-sieve-regex-01)
     -   body (RFC 5173)
     -   variables (RFC 5229)
     -   enotify (RFC 5435, particularly the mailto method RFC 5436)
     -   imap4flags (RFC 5232: setflag, addflag, removeflag; not supported: hasflags, :flags)
-- compatible with the python 2 version from https://github.com/garyp/sifter
+    -   reject and ereject (RFC 5429)
+    -   ihave (RFC 5463)
+
 
 INSTALL
 =======
@@ -45,6 +49,15 @@ email message. Each action is a tuple consisting of the action name and
 action-specific arguments. It is up to the caller to manipulate the
 message and message store based on the actions returned.
 
+COMMAND LINE
+============
+
+The output of the command line tool can be parsed as json.
+
+    $ sifter tests/evaluation_1.rules tests/evaluation_1.msg
+    [['redirect', '[email protected]']]
+
+
 WARNINGS
 ========
 
@@ -61,8 +74,6 @@ TODO
     filtering
 -   Base spec features not yet implemented:
     -   encoded characters (section 2.4.2.4)
-    -   multi-line strings (section 2.4.2)
-    -   bracketed comments (section 2.3)
     -   message uniqueness (section 2.10.3)
     -   envelope test (section 5.4)
     -   handle message loops (section 10)
@@ -84,6 +95,5 @@ TODO
     -   environment (RFC 5183)
     -   date and index (RFC 5260)
     -   editheader (RFC 5293)
-    -   ihave (RFC 5463)
     -   mailbox metadata (RFC 5490)
     -   xmpp notifications (RFC 5437)

docs/index.rst

@@ -9,15 +9,19 @@ FEATURES
 
 -   Supports all of the base Sieve spec from RFC 5228, except for
     features still listed under TODO below
+
+    - multiline strings (since version 0.2.2)
+    - bracketed comments (since version 0.2.4)
+
 -   Extensions supported:
 
     -   regex (draft-ietf-sieve-regex-01)
     -   body (RFC 5173)
     -   variables (RFC 5229)
     -   enotify (RFC 5435, particularly the mailto method RFC 5436)
     -   imap4flags (RFC 5232: setflag, addflag, removeflag; not supported: hasflags, :flags)
-
--   compatible with the Python 2 version from https://github.com/garyp/sifter
+    -   reject and ereject (RFC 5429) (since version 0.2.4)
+    -   ihave (RFC 5463) (since version 0.2.5)
 
 INSTALL
 -------
@@ -45,6 +49,17 @@ consisting of the action name and action-specific arguments. It is up to
 the caller to manipulate the message and message store based on the
 actions returned.
 
+COMMAND LINE
+------------
+
+The output of the command line tool can be parsed as json.
+
+.. code-block:: bash
+
+    $ sifter tests/evaluation_1.rules tests/evaluation_1.msg
+    [['redirect', '[email protected]']]
+
+
 WARNINGS
 --------
 
@@ -60,10 +75,11 @@ TODO
 -   An example adaptor that provides Unix LDA behavior using sieve for
     filtering
 -   Base spec features not yet implemented:
+
     -   encoded characters (section 2.4.2.4)
-    -   multi-line strings (section 2.4.2)
-    -   bracketed comments (section 2.3)
     -   message uniqueness (section 2.10.3)
     -   envelope test (section 5.4)
     -   handle message loops (section 10)
     -   limit abuse of redirect action (section
+    -   address test should limit allowed headers to those that contain
+        addresses (section 5.1)

setup.py

@@ -10,7 +10,7 @@
 
 setup(
     name="sifter3",
-    version="0.2.1",
+    version="0.2.6",
     author="Manfred Kaiser, Gary Peck",
     author_email="[email protected], [email protected]",
     url="https://sifter3.readthedocs.io/en/latest/",
@@ -60,6 +60,8 @@
             'keep = sifter.commands.keep:CommandKeep',
             'notify = sifter.commands.notify:CommandNotify',
             'redirect = sifter.commands.redirect:CommandRedirect',
+            'reject = sifter.commands.reject:CommandReject',
+            'ereject = sifter.commands.reject:CommandEReject',
             'require = sifter.commands.require:CommandRequire',
             'set = sifter.commands.variables:CommandSet',
             'stop = sifter.commands.stop:CommandStop',
@@ -76,6 +78,7 @@
             'true = sifter.tests.true:TestTrue',
             'valid_notify_method = sifter.tests.notify:TestValidNotifyMethod',
             'notify_method_capability = sifter.tests.notify:TestValidNotifyMethod',
+            'ihave = sifter.tests.ihave:TestIHave',
             # sifter comparators
             'ascii_casemap = sifter.comparators.ascii_casemap:ComparatorASCIICasemap',
             'ascii_casemap_noi = sifter.comparators.ascii_casemap:ComparatorASCIICasemapnoi',

sifter/cli.py

@@ -3,6 +3,7 @@
 import os
 import logging
 import sys
+import json
 
 import sifter.parser
 
@@ -24,4 +25,4 @@ def main() -> None:
     rules = sifter.parser.parse_file(open(args.rulefile))
     msg = email.message_from_file(open(args.messagefile))
     msg_actions = rules.evaluate(msg)
-    print(msg_actions)
+    print(json.dumps(msg_actions, indent=4))

sifter/commands/discard.py

@@ -1,18 +1,13 @@
 from email.message import Message
-from typing import (
-    Optional
-)
 
-from sifter.grammar.actions import Actions
 from sifter.grammar.state import EvaluationState
 from sifter.grammar.command import Command
 
 
 # section 4.4
 class CommandDiscard(Command):
 
-    RULE_IDENTIFIER = 'DISCARD'
+    HANDLER_ID = 'DISCARD'
 
-    def evaluate(self, message: Message, state: EvaluationState) -> Optional[Actions]:
+    def evaluate(self, message: Message, state: EvaluationState) -> None:
         state.actions.cancel_implicit_keep()
-        return None

sifter/commands/fileinto.py

@@ -1,27 +1,23 @@
 from email.message import Message
-from typing import (
-    Optional
-)
 
 from sifter.grammar.command import Command
 from sifter.grammar.string import expand_variables
 from sifter.validators.stringlist import StringList
 from sifter.grammar.state import EvaluationState
-from sifter.grammar.actions import Actions
 
 
 # section 4.1
 class CommandFileInto(Command):
 
-    RULE_IDENTIFIER = 'FILEINTO'
+    HANDLER_ID = 'FILEINTO'
+    EXTENSION_NAME = 'fileinto'
     POSITIONAL_ARGS = [StringList(length=1)]
 
-    def evaluate(self, message: Message, state: EvaluationState) -> Optional[Actions]:
+    def evaluate(self, message: Message, state: EvaluationState) -> None:
         state.check_required_extension('fileinto', 'FILEINTO')
 
         file_dest = self.positional_args[0]
         file_dest = list(map(lambda s: expand_variables(s, state), file_dest))  # type: ignore
 
         state.actions.append('fileinto', file_dest)
         state.actions.cancel_implicit_keep()
-        return None

sifter/commands/if_cmd.py

@@ -25,12 +25,12 @@ def evaluate(self, message: Message, state: EvaluationState) -> Optional[Actions
 
 class CommandIf(CommandIfBase):
 
-    RULE_IDENTIFIER = 'IF'
+    HANDLER_ID = 'IF'
 
 
 class CommandElsIf(CommandIfBase):
 
-    RULE_IDENTIFIER = 'ELSIF'
+    HANDLER_ID = 'ELSIF'
 
     def evaluate(self, message: Message, state: EvaluationState) -> Optional[Actions]:
         if state.last_if:
@@ -40,7 +40,7 @@ def evaluate(self, message: Message, state: EvaluationState) -> Optional[Actions
 
 class CommandElse(Command):
 
-    RULE_IDENTIFIER = 'ELSE'
+    HANDLER_ID = 'ELSE'
     TESTS_MIN = 0
     HAS_BLOCKS = False
 

sifter/commands/imap4flags.py

@@ -1,11 +1,9 @@
 from email.message import Message
-from typing import Optional
 
 from sifter.grammar.command import Command
 from sifter.validators.stringlist import StringList
 from sifter.grammar.string import expand_variables
 from sifter.grammar.state import EvaluationState
-from sifter.grammar.actions import Actions
 
 # This implements the RFC5232 imap4flags extension
 # commands: addflag, removeflag, setflag
@@ -15,38 +13,38 @@
 
 class CommandSetFlag(Command):
 
-    RULE_IDENTIFIER = 'SETFLAG'
+    HANDLER_ID = 'SETFLAG'
+    EXTENSION_NAME = 'imap4flags'
     POSITIONAL_ARGS = [StringList()]
 
-    def evaluate(self, message: Message, state: EvaluationState) -> Optional[Actions]:
+    def evaluate(self, message: Message, state: EvaluationState) -> None:
         state.check_required_extension('imap4flags', 'imapflags')
         flag_list = self.positional_args[0]
         flag_list = list(map(lambda s: expand_variables(s, state), flag_list))  # type: ignore
         state.actions.append('setflag', flag_list)
-        return None
 
 
 class CommandRemoveFlag(Command):
 
-    RULE_IDENTIFIER = 'REMOVEFLAG'
+    HANDLER_ID = 'REMOVEFLAG'
+    EXTENSION_NAME = 'imap4flags'
     POSITIONAL_ARGS = [StringList()]
 
-    def evaluate(self, message: Message, state: EvaluationState) -> Optional[Actions]:
+    def evaluate(self, message: Message, state: EvaluationState) -> None:
         state.check_required_extension('imap4flags', 'imapflags')
         flag_list = self.positional_args[0]
         flag_list = list(map(lambda s: expand_variables(s, state), flag_list))  # type: ignore
         state.actions.append('removeflag', flag_list)
-        return None
 
 
 class CommandAddFlag(Command):
 
-    RULE_IDENTIFIER = 'ADDFLAG'
+    HANDLER_ID = 'ADDFLAG'
+    EXTENSION_NAME = 'imap4flags'
     POSITIONAL_ARGS = [StringList()]
 
-    def evaluate(self, message: Message, state: EvaluationState) -> Optional[Actions]:
+    def evaluate(self, message: Message, state: EvaluationState) -> None:
         state.check_required_extension('imap4flags', 'imapflags')
         flag_list = self.positional_args[0]
         flag_list = list(map(lambda s: expand_variables(s, state), flag_list))  # type: ignore
         state.actions.append('addflag', flag_list)
-        return None

sifter/commands/keep.py

@@ -1,20 +1,15 @@
 from email.message import Message
-from typing import (
-    Optional
-)
 
 from sifter.grammar.command import Command
 from sifter.grammar.state import EvaluationState
-from sifter.grammar.actions import Actions
 
 
 # section 4.3
 class CommandKeep(Command):
 
-    RULE_IDENTIFIER = 'KEEP'
+    HANDLER_ID = 'KEEP'
     HAS_BLOCKS = False
 
-    def evaluate(self, message: Message, state: EvaluationState) -> Optional[Actions]:
+    def evaluate(self, message: Message, state: EvaluationState) -> None:
         state.actions.append('keep')
         state.actions.cancel_implicit_keep()
-        return None

sifter/commands/notify.py

@@ -1,6 +1,5 @@
 import re
 from email.message import Message
-from typing import Optional
 
 from sifter.grammar.command import Command
 from sifter.grammar.string import expand_variables
@@ -9,13 +8,13 @@
 from sifter.grammar.rule import RuleSyntaxError
 from sifter.extensions import ExtensionRegistry
 from sifter.grammar.state import EvaluationState
-from sifter.grammar.actions import Actions
 
 
 # RFC 5435
 class CommandNotify(Command):
 
-    RULE_IDENTIFIER = 'NOTIFY'
+    HANDLER_ID = 'NOTIFY'
+    EXTENSION_NAME = 'enotify'
     TAGGED_ARGS = {
         'from': Tag('FROM', (StringList(1),)),
         'importance': Tag('IMPORTANCE', (StringList(1),)),
@@ -26,7 +25,7 @@ class CommandNotify(Command):
         StringList(length=1)
     ]
 
-    def evaluate(self, message: Message, state: EvaluationState) -> Optional[Actions]:
+    def evaluate(self, message: Message, state: EvaluationState) -> None:
         notify_from = notify_importance = self.notify_message = None
         notify_options = []  # type: ignore
         if 'from' in self.tagged_args:
@@ -63,5 +62,3 @@ def evaluate(self, message: Message, state: EvaluationState) -> Optional[Actions
             'notify',
             (notify_method, notify_from, notify_importance, notify_options, notify_message)  # type: ignore
         )
-
-        return None