10 files changed, 345 insertions, 20 deletions

diff --git a/src/mailman_pgp/archivers/local_maildir.py b/src/mailman_pgp/archivers/local_maildir.py
new file mode 100644
index 0000000..4b7e75d
--- /dev/null
+++ b/src/mailman_pgp/archivers/local_maildir.py
@@ -0,0 +1,72 @@
+# Copyright (C) 2017 Jan Jancar
+#
+# This file is a part of the Mailman PGP plugin.
+#
+# This program 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.
+#
+# This program 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
+# this program.  If not, see <http://www.gnu.org/licenses/>.
+
+"""
+Archives messages to a maildir, locally, encrypted (TBD how),
+similar to Mailman's prototype archiver.
+"""
+import os
+from mailbox import Maildir
+
+from flufl.lock import Lock
+from mailman.interfaces.archiver import IArchiver
+from public import public
+from zope.interface import implementer
+
+from mailman_pgp.config import config, mm_config
+from mailman_pgp.model.list import PGPMailingList
+from mailman_pgp.pgp.mime import MIMEWrapper
+
+
+@public
+@implementer(IArchiver)
+class LocalMaildirArchiver:
+    """Local PGP enabled archiver."""
+
+    name = 'pgp-maildir-local'
+    is_enabled = False
+
+    @staticmethod
+    def list_url(mlist):
+        """See `IArchiver`."""
+        return None
+
+    @staticmethod
+    def permalink(mlist, msg):
+        """See `IArchiver`."""
+        return None
+
+    @staticmethod
+    def archive_message(mlist, msg):
+        """See `IArchiver`."""
+        pgp_list = PGPMailingList.for_list(mlist)
+        if not pgp_list:
+            return None
+        maildir_dir = config.get_value('archiving', 'maildir_dir')
+        maildir_dir.mkdir(parents=True, exist_ok=True)
+
+        list_dir = maildir_dir.joinpath(mlist.fqdn_listname)
+        maildir = Maildir(str(list_dir))
+        lock_file = os.path.join(mm_config.LOCK_DIR,
+                                 '{}-{}.lock'.format(mlist.fqdn_listname,
+                                                     LocalMaildirArchiver.name)
+                                 )
+        wrapped = MIMEWrapper(msg)
+        encrypted = wrapped.encrypt(pgp_list.pubkey)
+        with Lock(lock_file):
+            maildir.add(encrypted)
+        return None
diff --git a/src/mailman_pgp/archivers/local_mbox.py b/src/mailman_pgp/archivers/local_mbox.py
new file mode 100644
index 0000000..99264c2
--- /dev/null
+++ b/src/mailman_pgp/archivers/local_mbox.py
@@ -0,0 +1,72 @@
+# Copyright (C) 2017 Jan Jancar
+#
+# This file is a part of the Mailman PGP plugin.
+#
+# This program 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.
+#
+# This program 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
+# this program.  If not, see <http://www.gnu.org/licenses/>.
+
+"""
+Archives messages to a mbox, locally, encrypted (TBD how),
+similar to Mailman's prototype archiver.
+"""
+import os
+from mailbox import mbox
+
+from flufl.lock import Lock
+from mailman.interfaces.archiver import IArchiver
+from public import public
+from zope.interface import implementer
+
+from mailman_pgp.config import config, mm_config
+from mailman_pgp.model.list import PGPMailingList
+from mailman_pgp.pgp.mime import MIMEWrapper
+
+
+@public
+@implementer(IArchiver)
+class LocalMailboxArchiver:
+    """Local PGP enabled archiver."""
+
+    name = 'pgp-mbox-local'
+    is_enabled = False
+
+    @staticmethod
+    def list_url(mlist):
+        """See `IArchiver`."""
+        return None
+
+    @staticmethod
+    def permalink(mlist, msg):
+        """See `IArchiver`."""
+        return None
+
+    @staticmethod
+    def archive_message(mlist, msg):
+        """See `IArchiver`."""
+        pgp_list = PGPMailingList.for_list(mlist)
+        if not pgp_list:
+            return None
+        mailbox_dir = config.get_value('archiving', 'mailbox_dir')
+        mailbox_dir.mkdir(parents=True, exist_ok=True)
+
+        list_dir = mailbox_dir.joinpath(mlist.fqdn_listname)
+        mailbox = mbox(str(list_dir))
+        lock_file = os.path.join(mm_config.LOCK_DIR,
+                                 '{}-{}.lock'.format(mlist.fqdn_listname,
+                                                     LocalMailboxArchiver.name)
+                                 )
+        wrapped = MIMEWrapper(msg)
+        encrypted = wrapped.encrypt(pgp_list.pubkey)
+        with Lock(lock_file):
+            mailbox.add(encrypted)
+        return None
diff --git a/src/mailman_pgp/archivers/tests/__init__.py b/src/mailman_pgp/archivers/tests/__init__.py
new file mode 100644
index 0000000..e69de29
--- /dev/null
+++ b/src/mailman_pgp/archivers/tests/__init__.py
diff --git a/src/mailman_pgp/archivers/tests/test_maildir.py b/src/mailman_pgp/archivers/tests/test_maildir.py
new file mode 100644
index 0000000..bc810a7
--- /dev/null
+++ b/src/mailman_pgp/archivers/tests/test_maildir.py
@@ -0,0 +1,82 @@
+# Copyright (C) 2017 Jan Jancar
+#
+# This file is a part of the Mailman PGP plugin.
+#
+# This program 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.
+#
+# This program 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
+# this program.  If not, see <http://www.gnu.org/licenses/>.
+
+""""""
+import os
+import unittest
+from mailbox import Maildir
+from tempfile import TemporaryDirectory
+
+from mailman.app.lifecycle import create_list
+from mailman.testing.helpers import specialized_message_from_string as mfs
+
+from mailman_pgp.archivers.local_maildir import LocalMaildirArchiver
+from mailman_pgp.config import config
+from mailman_pgp.database import mm_transaction
+from mailman_pgp.model.list import PGPMailingList
+from mailman_pgp.pgp.mime import MIMEWrapper
+from mailman_pgp.testing.layers import PGPConfigLayer
+from mailman_pgp.testing.pgp import load_key
+
+
+class TestPGPMaildirArchiver(unittest.TestCase):
+    layer = PGPConfigLayer
+
+    def setUp(self):
+        self.msg = mfs("""\
+To: test@example.com
+From: anne@example.com
+Subject: Testing the test list
+Message-ID: <ant>
+Message-ID-Hash: MS6QLWERIJLGCRF44J7USBFDELMNT2BW
+
+Tests are better than no tests
+but the water deserves to be swum.
+""")
+        with mm_transaction():
+            self.mlist = create_list('test@example.com',
+                                     style_name='pgp-default')
+        self.pgp_list = PGPMailingList.for_list(self.mlist)
+        self.list_key = load_key('ecc_p256.priv.asc')
+        self.pgp_list.key = self.list_key
+
+    def test_no_links(self):
+        self.assertIsNone(LocalMaildirArchiver.list_url(self.mlist))
+        self.assertIsNone(LocalMaildirArchiver.permalink(self.mlist, self.msg))
+
+    def test_no_pgp_list(self):
+        with mm_transaction():
+            ordinary = create_list('ordinary@example.com')
+
+        LocalMaildirArchiver.archive_message(ordinary, self.msg)
+
+    def test_archives(self):
+        with TemporaryDirectory() as maildir_dir:
+            config.set('archiving', 'maildir_dir', maildir_dir)
+            LocalMaildirArchiver.archive_message(self.mlist, self.msg)
+
+            list_dir = os.path.join(maildir_dir, self.mlist.fqdn_listname)
+
+            maildir = Maildir(list_dir)
+            messages = maildir.values()
+            self.assertEqual(len(messages), 1)
+
+            message = messages[0]
+            wrapped = MIMEWrapper(message)
+            self.assertTrue(wrapped.is_encrypted())
+            decrypted = wrapped.decrypt(self.list_key)
+            self.assertTrue(self.msg.as_string(), decrypted.as_string())
diff --git a/src/mailman_pgp/archivers/tests/test_mbox.py b/src/mailman_pgp/archivers/tests/test_mbox.py
new file mode 100644
index 0000000..fde0e50
--- /dev/null
+++ b/src/mailman_pgp/archivers/tests/test_mbox.py
@@ -0,0 +1,82 @@
+# Copyright (C) 2017 Jan Jancar
+#
+# This file is a part of the Mailman PGP plugin.
+#
+# This program 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.
+#
+# This program 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
+# this program.  If not, see <http://www.gnu.org/licenses/>.
+
+""""""
+import os
+import unittest
+from mailbox import mbox
+from tempfile import TemporaryDirectory
+
+from mailman.app.lifecycle import create_list
+from mailman.testing.helpers import specialized_message_from_string as mfs
+
+from mailman_pgp.archivers.local_mbox import LocalMailboxArchiver
+from mailman_pgp.config import config
+from mailman_pgp.database import mm_transaction
+from mailman_pgp.model.list import PGPMailingList
+from mailman_pgp.pgp.mime import MIMEWrapper
+from mailman_pgp.testing.layers import PGPConfigLayer
+from mailman_pgp.testing.pgp import load_key
+
+
+class TestPGPMboxArchiver(unittest.TestCase):
+    layer = PGPConfigLayer
+
+    def setUp(self):
+        self.msg = mfs("""\
+To: test@example.com
+From: anne@example.com
+Subject: Testing the test list
+Message-ID: <ant>
+Message-ID-Hash: MS6QLWERIJLGCRF44J7USBFDELMNT2BW
+
+Tests are better than no tests
+but the water deserves to be swum.
+""")
+        with mm_transaction():
+            self.mlist = create_list('test@example.com',
+                                     style_name='pgp-default')
+        self.pgp_list = PGPMailingList.for_list(self.mlist)
+        self.list_key = load_key('ecc_p256.priv.asc')
+        self.pgp_list.key = self.list_key
+
+    def test_no_links(self):
+        self.assertIsNone(LocalMailboxArchiver.list_url(self.mlist))
+        self.assertIsNone(LocalMailboxArchiver.permalink(self.mlist, self.msg))
+
+    def test_no_pgp_list(self):
+        with mm_transaction():
+            ordinary = create_list('ordinary@example.com')
+
+            LocalMailboxArchiver.archive_message(ordinary, self.msg)
+
+    def test_archives(self):
+        with TemporaryDirectory() as mailbox_dir:
+            config.set('archiving', 'mailbox_dir', mailbox_dir)
+            LocalMailboxArchiver.archive_message(self.mlist, self.msg)
+
+            list_dir = os.path.join(mailbox_dir, self.mlist.fqdn_listname)
+
+            mailbox = mbox(list_dir)
+            messages = mailbox.values()
+            self.assertEqual(len(messages), 1)
+
+            message = messages[0]
+            wrapped = MIMEWrapper(message)
+            self.assertTrue(wrapped.is_encrypted())
+            decrypted = wrapped.decrypt(self.list_key)
+            self.assertTrue(self.msg.as_string(), decrypted.as_string())
diff --git a/src/mailman_pgp/config/mailman_pgp.cfg b/src/mailman_pgp/config/mailman_pgp.cfg
index e975836..0828b3d 100644
--- a/src/mailman_pgp/config/mailman_pgp.cfg
+++ b/src/mailman_pgp/config/mailman_pgp.cfg
@@ -22,6 +22,14 @@
 url: sqlite:////$DATA_DIR/pgp.db
 
 
+[archiving]
+# The directory where the local mbox archiver will save messages.
+mailbox_dir: $ARCHIVE_DIR/pgp/mbox
+
+# The directory where the local maildir archiver will save messages.
+maildir_dir: $ARCHIVE_DIR/pgp/maildir
+
+
 [keydirs]
 # Key directory used to store user public keys.
 user_keydir: $DATA_DIR/pgp/user_keydir/
diff --git a/src/mailman_pgp/config/schema.cfg b/src/mailman_pgp/config/schema.cfg
index 085ab0a..feed0b6 100644
--- a/src/mailman_pgp/config/schema.cfg
+++ b/src/mailman_pgp/config/schema.cfg
@@ -18,15 +18,20 @@
 # Schema of the mailman_pgp config.
 
 [db]
-url: pathlib.Path
+url: mailman_pgp.utils.config.expandable_str
+
+[archiving]
+mailbox_dir: mailman_pgp.utils.config.expandable_path
+
+maildir_dir: mailman_pgp.utils.config.expandable_path
 
 
 [keydirs]
-user_keydir: pathlib.Path
+user_keydir: mailman_pgp.utils.config.expandable_path
 
-list_keydir: pathlib.Path
+list_keydir: mailman_pgp.utils.config.expandable_path
 
-archive_keydir: pathlib.Path
+archive_keydir: mailman_pgp.utils.config.expandable_path
 
 
 [keypairs]
diff --git a/src/mailman_pgp/database/__init__.py b/src/mailman_pgp/database/__init__.py
index 2bd1feb..1f2794e 100644
--- a/src/mailman_pgp/database/__init__.py
+++ b/src/mailman_pgp/database/__init__.py
@@ -19,9 +19,7 @@
 import logging
 from contextlib import contextmanager
 
-from mailman.config import config as mailman_config
 from mailman.database.transaction import transaction as mailman_transaction
-from mailman.utilities.string import expand
 from public import public
 from sqlalchemy import create_engine
 from sqlalchemy.orm import scoped_session, sessionmaker
@@ -37,8 +35,7 @@ class Database:
     """A SQLAlchemy database."""
 
     def __init__(self):
-        url = config.get('db', 'url')
-        self._url = expand(url, None, mailman_config.paths)
+        self._url = config.get_value('db', 'url')
         log.debug('Creating database at {}'.format(self._url))
         self.engine = create_engine(self._url)
         self.scoped_session = scoped_session(sessionmaker(bind=self.engine))
diff --git a/src/mailman_pgp/testing/mailman_pgp.cfg b/src/mailman_pgp/testing/mailman_pgp.cfg
index c85d38a..1ef8938 100644
--- a/src/mailman_pgp/testing/mailman_pgp.cfg
+++ b/src/mailman_pgp/testing/mailman_pgp.cfg
@@ -22,6 +22,14 @@
 url: sqlite:////$DATA_DIR/pgp.db
 
 
+[archiving]
+# The directory where the local mbox archiver will save messages.
+mailbox_dir: $ARCHIVE_DIR/pgp/mbox
+
+# The directory where the local maildir archiver will save messages.
+maildir_dir: $ARCHIVE_DIR/pgp/maildir
+
+
 [keydirs]
 # Key directory used to store user public keys.
 user_keydir: $DATA_DIR/pgp/user_keydir/
diff --git a/src/mailman_pgp/archivers/local.py b/src/mailman_pgp/utils/config.py
index 04d9a22..3296379 100644
--- a/src/mailman_pgp/archivers/local.py
+++ b/src/mailman_pgp/utils/config.py
@@ -15,18 +15,17 @@
 # You should have received a copy of the GNU General Public License along with
 # this program.  If not, see <http://www.gnu.org/licenses/>.
 
-"""
-Archives messages locally, encrypted (TBD how),
-similar to Mailman's prototype archiver.
-"""
+""""""
+import pathlib
 
-from mailman.interfaces.archiver import IArchiver
-from public import public
-from zope.interface import implementer
+from mailman.utilities.string import expand
 
+from mailman_pgp.config import mm_config
 
-@public
-@implementer(IArchiver)
-class LocalArchiver:
-    """Local PGP enabled archiver."""
-    pass
+
+def expandable_str(value):
+    return expand(value, None, mm_config.paths)
+
+
+def expandable_path(value):
+    return pathlib.Path(expandable_str(value))