From a869ebdad781ae9549681853f3581b7e315de444 Mon Sep 17 00:00:00 2001
From: J08nY
Date: Mon, 7 Aug 2017 19:58:20 +0200
Subject: Add some utility functions for config transforms.

---
 src/mailman_pgp/archivers/local.py         | 32 -------------------
 src/mailman_pgp/archivers/local_maildir.py | 51 ++++++++++++++++++++++++++++++
 src/mailman_pgp/archivers/local_mbox.py    | 51 ++++++++++++++++++++++++++++++
 src/mailman_pgp/config/mailman_pgp.cfg     |  8 +++++
 src/mailman_pgp/config/schema.cfg          | 13 +++++---
 src/mailman_pgp/database/__init__.py       |  6 ++--
 src/mailman_pgp/testing/mailman_pgp.cfg    |  8 +++++
 src/mailman_pgp/utils/config.py            | 31 ++++++++++++++++++
 8 files changed, 160 insertions(+), 40 deletions(-)
 delete mode 100644 src/mailman_pgp/archivers/local.py
 create mode 100644 src/mailman_pgp/archivers/local_maildir.py
 create mode 100644 src/mailman_pgp/archivers/local_mbox.py
 create mode 100644 src/mailman_pgp/utils/config.py

diff --git a/src/mailman_pgp/archivers/local.py b/src/mailman_pgp/archivers/local.py
deleted file mode 100644
index 04d9a22..0000000
--- a/src/mailman_pgp/archivers/local.py
+++ /dev/null
@@ -1,32 +0,0 @@
-# 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 locally, encrypted (TBD how),
-similar to Mailman's prototype archiver.
-"""
-
-from mailman.interfaces.archiver import IArchiver
-from public import public
-from zope.interface import implementer
-
-
-@public
-@implementer(IArchiver)
-class LocalArchiver:
-    """Local PGP enabled archiver."""
-    pass
diff --git a/src/mailman_pgp/archivers/local_maildir.py b/src/mailman_pgp/archivers/local_maildir.py
new file mode 100644
index 0000000..31cb6e6
--- /dev/null
+++ b/src/mailman_pgp/archivers/local_maildir.py
@@ -0,0 +1,51 @@
+# 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.
+"""
+
+from mailman.interfaces.archiver import IArchiver
+from public import public
+from zope.interface import implementer
+
+from mailman_pgp.model.list import PGPMailingList
+
+
+@public
+@implementer(IArchiver)
+class LocalMaildirArchiver:
+    """Local PGP enabled archiver."""
+
+    name = 'pgp-maildir-local'
+    is_enabled = False
+
+    def list_url(self, mlist):
+        """See `IArchiver`."""
+        return None
+
+    def permalink(self, mlist, msg):
+        """See `IArchiver`."""
+        return None
+
+    def archive_message(self, mlist, msg):
+        """See `IArchiver`."""
+        pgp_list = PGPMailingList.for_list(mlist)
+        if not pgp_list:
+            return None
+        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..2a08c4a
--- /dev/null
+++ b/src/mailman_pgp/archivers/local_mbox.py
@@ -0,0 +1,51 @@
+# 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.
+"""
+
+from mailman.interfaces.archiver import IArchiver
+from public import public
+from zope.interface import implementer
+
+from mailman_pgp.model.list import PGPMailingList
+
+
+@public
+@implementer(IArchiver)
+class LocalMailboxArchiver:
+    """Local PGP enabled archiver."""
+
+    name = 'pgp-mbox-local'
+    is_enabled = False
+
+    def list_url(self, mlist):
+        """See `IArchiver`."""
+        return None
+
+    def permalink(self, mlist, msg):
+        """See `IArchiver`."""
+        return None
+
+    def archive_message(self, mlist, msg):
+        """See `IArchiver`."""
+        pgp_list = PGPMailingList.for_list(mlist)
+        if not pgp_list:
+            return None
+        return None
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..a7f0c64 100644
--- a/src/mailman_pgp/database/__init__.py
+++ b/src/mailman_pgp/database/__init__.py
@@ -19,14 +19,13 @@
 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
 
-from mailman_pgp.config import config
+from mailman_pgp.config import config, mm_config
 from mailman_pgp.model.base import Base
 
 log = logging.getLogger('mailman.plugin.pgp.database')
@@ -37,8 +36,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/utils/config.py b/src/mailman_pgp/utils/config.py
new file mode 100644
index 0000000..3296379
--- /dev/null
+++ b/src/mailman_pgp/utils/config.py
@@ -0,0 +1,31 @@
+# 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 pathlib
+
+from mailman.utilities.string import expand
+
+from mailman_pgp.config import mm_config
+
+
+def expandable_str(value):
+    return expand(value, None, mm_config.paths)
+
+
+def expandable_path(value):
+    return pathlib.Path(expandable_str(value))
-- 
cgit v1.2.3-70-g09d2