added reject command and multiline strings

Author: manfred-kaiser

README.md

@@ -18,6 +18,7 @@ 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)
 -   Extensions supported:
     -   regex (draft-ietf-sieve-regex-01)
     -   body (RFC 5173)

docs/index.rst

@@ -9,6 +9,9 @@ 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)
+
 -   Extensions supported:
 
     -   regex (draft-ietf-sieve-regex-01)
@@ -73,7 +76,6 @@ TODO
 -   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)

setup.py

@@ -10,7 +10,7 @@
 
 setup(
     name="sifter3",
-    version="0.2.1",
+    version="0.2.2",
     author="Manfred Kaiser, Gary Peck",
     author_email="[email protected], [email protected]",
     url="https://sifter3.readthedocs.io/en/latest/",
@@ -60,6 +60,7 @@
             'keep = sifter.commands.keep:CommandKeep',
             'notify = sifter.commands.notify:CommandNotify',
             'redirect = sifter.commands.redirect:CommandRedirect',
+            'reject = sifter.commands.reject:CommandReject',
             'require = sifter.commands.require:CommandRequire',
             'set = sifter.commands.variables:CommandSet',
             'stop = sifter.commands.stop:CommandStop',

sifter/commands/reject.py

@@ -0,0 +1,23 @@
+from email.message import Message
+from typing import (
+    Text,
+    Optional
+)
+
+from sifter.grammar.command import Command
+from sifter.validators.stringlist import StringList
+from sifter.grammar.state import EvaluationState
+from sifter.grammar.actions import Actions
+
+
+# section 3.2
+class CommandReject(Command):
+
+    RULE_IDENTIFIER: Text = 'REJECT'
+    POSITIONAL_ARGS = [StringList()]
+
+    def evaluate(self, message: Message, state: EvaluationState) -> Optional[Actions]:
+        print(self.positional_args[0][0])
+        state.actions.append('reject', self.positional_args[0][0])
+        state.actions.cancel_implicit_keep()
+        return None

sifter/extensions/__init__.py

@@ -34,14 +34,15 @@ class ExtensionRegistry():
         ]
     ] = {}
     DEFAULT_EXTENSION: List[Text] = [
-        'regex',
+        'body',
         'comparator-i;ascii-casemap',
         'comparator-i;octet',
+        'enotify',
         'fileinto',
-        'body'
+        'imap4flags',
+        'regex',
+        'reject',
         'variables',
-        'enotify',
-        'imap4flags'
     ]
 
     def __init__(self) -> None:

sifter/grammar/grammar.py

@@ -32,7 +32,7 @@ def __init__(self, debug: bool = False) -> None:
     def make_parser(mod: Any, debug: bool = False) -> 'LRParser':
         return yacc(
             module=mod,
-            debug=debug,
+            debug=True,
             write_tables=False,
             errorlog=NullLogger() if not debug else None
         )
@@ -167,6 +167,10 @@ def p_argument_tag(self, p: 'YaccProduction') -> None:
         """argument : TAG"""
         p[0] = Tag(p[1])
 
+    def p_argument_multiline_string(self, p: 'YaccProduction') -> None:
+        """argument : MULTILINE_STRING"""
+        p[0] = [p[1]]
+
     def p_stringlist_error(self, p: 'YaccProduction') -> None:
         """argument : '[' error ']'"""
         print("Syntax error in string list that starts on line %d" % p.lineno(1))
@@ -186,4 +190,9 @@ def p_string(self, p: 'YaccProduction') -> None:
         p[0] = String(p[1])
 
     def p_error(self, p: 'YaccProduction') -> None:
-        pass
+        if p is None:
+            token = "end of file"
+        else:
+            token = f"{p.type}({p.value}) on line {p.lineno}"
+
+        print(f"Syntax error: Unexpected {token}")

sifter/grammar/lexer.py

@@ -54,7 +54,7 @@ def t_BRACKET_COMMENT(self, t: 'LexToken') -> Optional['LexToken']:
 
     # section 2.4.2
     def t_MULTILINE_STRING(self, t: 'LexToken') -> Optional['LexToken']:
-        r'"@@@@@@@@@@@@@@@"'
+        r'text:\s?(?:\#.*)\r?\n(?P<multilinetext>[\r\n\S\s.]*?\r?\n)\.\r?\n'
         # TODO: For entering larger amounts of text, such as an email message,
         # a multi-line form is allowed.  It starts with the keyword "text:",
         # followed by a CRLF, and ends with the sequence of a CRLF, a single
@@ -68,7 +68,8 @@ def t_MULTILINE_STRING(self, t: 'LexToken') -> Optional['LexToken']:
         # that is, ".foo" is interpreted as ".foo".  However, because this is
         # potentially ambiguous, scripts SHOULD be properly dot-stuffed so such
         # lines do not appear.
-        return None
+        t.value = t.lexer.lexmatch.group('multilinetext')
+        return t
 
     # section 2.4.2
     def t_QUOTED_STRING(self, t: 'LexToken') -> Optional['LexToken']:

tests/evaluation_4.rules

@@ -0,0 +1,7 @@
+require "reject";
+
+if header "from" "[email protected]"
+  {
+    reject "I do not accept messages from this address."
+;
+  }

tests/evaluation_5.rules

@@ -0,0 +1,11 @@
+require "reject";
+
+if header "from" "[email protected]"
+  {
+    reject text: # testcomment
+I do not accept messages from
+this address.
+..
+.
+;
+  }

tests/test_evaluation.py

@@ -24,6 +24,8 @@ def test_evaulation():
         ("evaluation_3.msg", "evaluation_1.rules", [('redirect', '[email protected]')]),
         ("evaluation_3.msg", "evaluation_2.rules", [('fileinto', ['INBOX'])]),
         ("evaluation_3.msg", "evaluation_3.rules", [('keep', None)]),
+        ("evaluation_1.msg", "evaluation_4.rules", [('reject', 'I do not accept messages from this address.')]),
+        ("evaluation_1.msg", "evaluation_5.rules", [('reject', 'I do not accept messages from\nthis address.\n..\n')]),
     )
 
     for messagefile, rulefile, evaluated_rules in EVAL_RESULTS: