5 files changed, 382 insertions, 0 deletions

diff --git a/src/mailman/archiving/__init__.py b/src/mailman/archiving/__init__.py
new file mode 100644
index 000000000..e69de29bb
--- /dev/null
+++ b/src/mailman/archiving/__init__.py
diff --git a/src/mailman/archiving/mailarchive.py b/src/mailman/archiving/mailarchive.py
new file mode 100644
index 000000000..a5eb27db0
--- /dev/null
+++ b/src/mailman/archiving/mailarchive.py
@@ -0,0 +1,87 @@
+# Copyright (C) 2008-2009 by the Free Software Foundation, Inc.
+#
+# This file is part of GNU Mailman.
+#
+# GNU Mailman 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.
+#
+# GNU Mailman 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
+# GNU Mailman.  If not, see <http://www.gnu.org/licenses/>.
+
+"""The Mail-Archive.com archiver."""
+
+from __future__ import absolute_import, unicode_literals
+
+__metaclass__ = type
+__all__ = [
+    'MailArchive',
+    ]
+
+
+import hashlib
+
+from base64 import urlsafe_b64encode
+from urllib import quote
+from urlparse import urljoin
+from zope.interface import implements
+
+from mailman.config import config
+from mailman.interfaces.archiver import IArchiver
+
+
+
+class MailArchive:
+    """Public archiver at the Mail-Archive.com.
+
+    Messages get archived at http://go.mail-archive.com.
+    """
+
+    implements(IArchiver)
+
+    name = 'mail-archive'
+
+    @staticmethod
+    def list_url(mlist):
+        """See `IArchiver`."""
+        if mlist.archive_private:
+            return None
+        return urljoin(config.archiver.mail_archive.base_url,
+                       quote(mlist.posting_address))
+
+    @staticmethod
+    def permalink(mlist, msg):
+        """See `IArchiver`."""
+        if mlist.archive_private:
+            return None
+        message_id = msg.get('message-id')
+        # It is not the archiver's job to ensure the message has a Message-ID.
+        # If no Message-ID is available, there is no permalink.
+        if message_id is None:
+            return None
+        # The angle brackets are not part of the Message-ID.  See RFC 2822.
+        if message_id.startswith('<') and message_id.endswith('>'):
+            message_id = message_id[1:-1]
+        else:
+            message_id = message_id.strip()
+        sha = hashlib.sha1(message_id)
+        sha.update(str(mlist.posting_address))
+        message_id_hash = urlsafe_b64encode(sha.digest())
+        del msg['x-message-id-hash']
+        msg['X-Message-ID-Hash'] = message_id_hash
+        return urljoin(config.archiver.mail_archive.base_url, message_id_hash)
+
+    @staticmethod
+    def archive_message(mlist, msg):
+        """See `IArchiver`."""
+        if not mlist.archive_private:
+            config.switchboards['out'].enqueue(
+                msg,
+                listname=mlist.fqdn_listname,
+                recips=[config.archiver.mail_archive.recipient])
diff --git a/src/mailman/archiving/mhonarc.py b/src/mailman/archiving/mhonarc.py
new file mode 100644
index 000000000..949a79144
--- /dev/null
+++ b/src/mailman/archiving/mhonarc.py
@@ -0,0 +1,97 @@
+# Copyright (C) 2008-2009 by the Free Software Foundation, Inc.
+#
+# This file is part of GNU Mailman.
+#
+# GNU Mailman 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.
+#
+# GNU Mailman 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
+# GNU Mailman.  If not, see <http://www.gnu.org/licenses/>.
+
+"""MHonArc archiver."""
+
+from __future__ import absolute_import, unicode_literals
+
+__metaclass__ = type
+__all__ = [
+    'MHonArc',
+    ]
+
+
+import hashlib
+import logging
+import subprocess
+
+from base64 import b32encode
+from urlparse import urljoin
+from zope.interface import implements
+
+from mailman.config import config
+from mailman.interfaces.archiver import IArchiver
+from mailman.utilities.string import expand
+
+
+log = logging.getLogger('mailman.archiver')
+
+
+
+class MHonArc:
+    """Local MHonArc archiver."""
+
+    implements(IArchiver)
+
+    name = 'mhonarc'
+
+    @staticmethod
+    def list_url(mlist):
+        """See `IArchiver`."""
+        # XXX What about private MHonArc archives?
+        web_host = config.domains[mlist.host_name].url_host
+        return expand(config.archiver.mhonarc.base_url,
+                      dict(listname=mlist.fqdn_listname,
+                           hostname=web_host,
+                           fqdn_listname=mlist.fqdn_listname,
+                           ))
+
+    @staticmethod
+    def permalink(mlist, msg):
+        """See `IArchiver`."""
+        # XXX What about private MHonArc archives?
+        message_id = msg.get('message-id')
+        # It is not the archiver's job to ensure the message has a Message-ID.
+        # If no Message-ID is available, there is no permalink.
+        if message_id is None:
+            return None
+        # The angle brackets are not part of the Message-ID.  See RFC 2822.
+        if message_id.startswith('<') and message_id.endswith('>'):
+            message_id = message_id[1:-1]
+        else:
+            message_id = message_id.strip()
+        sha = hashlib.sha1(message_id)
+        message_id_hash = b32encode(sha.digest())
+        del msg['x-message-id-hash']
+        msg['X-Message-ID-Hash'] = message_id_hash
+        return urljoin(MHonArc.list_url(mlist), message_id_hash)
+
+    @staticmethod
+    def archive_message(mlist, msg):
+        """See `IArchiver`."""
+        substitutions = config.__dict__.copy()
+        substitutions['listname'] = mlist.fqdn_listname
+        command = expand(config.archiver.mhonarc.command, substitutions)
+        proc = subprocess.Popen(
+            command, stdout=subprocess.PIPE, stderr=subprocess.PIPE,
+            shell=True)
+        stdout, stderr = proc.communicate(msg.as_string())
+        if proc.returncode <> 0:
+            log.error('%s: mhonarc subprocess had non-zero exit code: %s' %
+                      (msg['message-id'], proc.returncode))
+        log.info(stdout)
+        log.error(stderr)
diff --git a/src/mailman/archiving/pipermail.py b/src/mailman/archiving/pipermail.py
new file mode 100644
index 000000000..377f4ab53
--- /dev/null
+++ b/src/mailman/archiving/pipermail.py
@@ -0,0 +1,121 @@
+# Copyright (C) 2007-2009 by the Free Software Foundation, Inc.
+#
+# This file is part of GNU Mailman.
+#
+# GNU Mailman 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.
+#
+# GNU Mailman 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
+# GNU Mailman.  If not, see <http://www.gnu.org/licenses/>.
+
+"""Pipermail archiver."""
+
+from __future__ import absolute_import, unicode_literals
+
+__metaclass__ = type
+__all__ = [
+    'Pipermail',
+    ]
+
+
+import os
+
+from cStringIO import StringIO
+from zope.interface import implements
+from zope.interface.interface import adapter_hooks
+
+from mailman.config import config
+from mailman.interfaces.archiver import IArchiver, IPipermailMailingList
+from mailman.interfaces.mailinglist import IMailingList
+from mailman.utilities.filesystem import makedirs
+from mailman.utilities.string import expand
+
+from mailman.Archiver.HyperArch import HyperArchive
+
+
+
+class PipermailMailingListAdapter:
+    """An adapter for MailingList objects to work with Pipermail."""
+
+    implements(IPipermailMailingList)
+
+    def __init__(self, mlist):
+        self._mlist = mlist
+
+    def __getattr__(self, name):
+        return getattr(self._mlist, name)
+
+    def archive_dir(self):
+        """See `IPipermailMailingList`."""
+        if self._mlist.archive_private:
+            basedir = config.PRIVATE_ARCHIVE_FILE_DIR
+        else:
+            basedir = config.PUBLIC_ARCHIVE_FILE_DIR
+        # Make sure the archive directory exists.
+        archive_dir = os.path.join(basedir, self._mlist.fqdn_listname)
+        makedirs(archive_dir)
+        return archive_dir
+
+
+def adapt_mailing_list_for_pipermail(iface, obj):
+    """Adapt `IMailingLists` to `IPipermailMailingList`.
+
+    :param iface: The interface to adapt to.
+    :type iface: `zope.interface.Interface`
+    :param obj: The object being adapted.
+    :type obj: any object
+    :return: An `IPipermailMailingList` instance if adaptation succeeded or
+        None if it didn't.
+    """
+    return (PipermailMailingListAdapter(obj)
+            if IMailingList.providedBy(obj) and iface is IPipermailMailingList
+            else None)
+
+adapter_hooks.append(adapt_mailing_list_for_pipermail)
+
+
+
+class Pipermail:
+    """The stock Pipermail archiver."""
+
+    implements(IArchiver)
+
+    name = 'pipermail'
+
+    @staticmethod
+    def list_url(mlist):
+        """See `IArchiver`."""
+        if mlist.archive_private:
+            url = mlist.script_url('private') + '/index.html'
+        else:
+            web_host = config.domains[mlist.host_name].url_host
+            return expand(config.archiver.pipermail.base_url,
+                          dict(listname=mlist.fqdn_listname,
+                               hostname=web_host,
+                               fqdn_listname=mlist.fqdn_listname,
+                               ))
+
+    @staticmethod
+    def permalink(mlist, message):
+        """See `IArchiver`."""
+        # Not currently implemented.
+        return None
+
+    @staticmethod
+    def archive_message(mlist, message):
+        """See `IArchiver`."""
+        text = str(message)
+        fileobj = StringIO(text)
+        h = HyperArchive(IPipermailMailingList(mlist))
+        h.processUnixMailbox(fileobj)
+        h.close()
+        fileobj.close()
+        # There's no good way to know the url for the archived message.
+        return None
diff --git a/src/mailman/archiving/prototype.py b/src/mailman/archiving/prototype.py
new file mode 100644
index 000000000..81163e184
--- /dev/null
+++ b/src/mailman/archiving/prototype.py
@@ -0,0 +1,77 @@
+# Copyright (C) 2008-2009 by the Free Software Foundation, Inc.
+#
+# This file is part of GNU Mailman.
+#
+# GNU Mailman 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.
+#
+# GNU Mailman 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
+# GNU Mailman.  If not, see <http://www.gnu.org/licenses/>.
+
+"""Prototypical permalinking archiver."""
+
+from __future__ import absolute_import, unicode_literals
+
+__metaclass__ = type
+__all__ = [
+    'Prototype',
+    ]
+
+
+import hashlib
+
+from base64 import b32encode
+from urlparse import urljoin
+from zope.interface import implements
+
+from mailman.config import config
+from mailman.interfaces.archiver import IArchiver
+
+
+
+class Prototype:
+    """A prototype of a third party archiver.
+
+    Mailman proposes a draft specification for interoperability between list
+    servers and archivers: <http://wiki.list.org/display/DEV/Stable+URLs>.
+    """
+
+    implements(IArchiver)
+
+    name = 'prototype'
+
+    @staticmethod
+    def list_url(mlist):
+        """See `IArchiver`."""
+        return config.domains[mlist.host_name].base_url
+
+    @staticmethod
+    def permalink(mlist, msg):
+        """See `IArchiver`."""
+        message_id = msg.get('message-id')
+        # It is not the archiver's job to ensure the message has a Message-ID.
+        # If this header is missing, there is no permalink.
+        if message_id is None:
+            return None
+        # The angle brackets are not part of the Message-ID.  See RFC 2822.
+        if message_id.startswith('<') and message_id.endswith('>'):
+            message_id = message_id[1:-1]
+        else:
+            message_id = message_id.strip()
+        digest = hashlib.sha1(message_id).digest()
+        message_id_hash = b32encode(digest)
+        del msg['x-message-id-hash']
+        msg['X-Message-ID-Hash'] = message_id_hash
+        return urljoin(Prototype.list_url(mlist), message_id_hash)
+
+    @staticmethod
+    def archive_message(mlist, message):
+        """See `IArchiver`."""
+        raise NotImplementedError