prototype.py 2.44 KB
Newer Older
Barry Warsaw's avatar
Barry Warsaw committed
1
# Copyright (C) 2008-2009 by the Free Software Foundation, Inc.
2
#
Barry Warsaw's avatar
Barry Warsaw committed
3
# This file is part of GNU Mailman.
4
#
Barry Warsaw's avatar
Barry Warsaw committed
5 6 7 8
# 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.
9
#
Barry Warsaw's avatar
Barry Warsaw committed
10 11 12 13 14 15 16
# 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/>.
17 18 19

"""Prototypical permalinking archiver."""

Barry Warsaw's avatar
Barry Warsaw committed
20 21
from __future__ import absolute_import, unicode_literals

22 23 24 25 26 27 28 29 30 31 32 33
__metaclass__ = type
__all__ = [
    'Prototype',
    ]


import hashlib

from base64 import b32encode
from urlparse import urljoin
from zope.interface import implements

34
from mailman.config import config
35
from mailman.interfaces.archiver import IArchiver
36
from mailman.interfaces.domain import IDomainManager
37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53



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`."""
54
        return IDomainManager(config)[mlist.host_name].base_url
55 56 57 58 59 60

    @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.
61 62 63
        # If this header is missing, there is no permalink.
        if message_id is None:
            return None
64 65 66
        # 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]
67 68
        else:
            message_id = message_id.strip()
69 70 71 72 73 74 75 76 77 78
        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