prototype.py 4.2 KB
Newer Older
Barry Warsaw's avatar
Barry Warsaw committed
1
# Copyright (C) 2008-2014 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
from __future__ import absolute_import, print_function, unicode_literals
Barry Warsaw's avatar
Barry Warsaw committed
21

22 23 24 25 26 27
__metaclass__ = type
__all__ = [
    'Prototype',
    ]


28 29 30
import os
import errno
import logging
31

32 33
from datetime import timedelta
from mailbox import Maildir
34 35
from urlparse import urljoin

36
from flufl.lock import Lock, TimeOutError
Barry Warsaw's avatar
Barry Warsaw committed
37
from zope.interface import implementer
38

39
from mailman.config import config
40 41
from mailman.interfaces.archiver import IArchiver

42 43
log = logging.getLogger('mailman.error')

44 45


Barry Warsaw's avatar
Barry Warsaw committed
46
@implementer(IArchiver)
47 48 49 50 51 52 53 54
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>.
    """

    name = 'prototype'
Barry Warsaw's avatar
Barry Warsaw committed
55
    is_enabled = False
56 57 58 59

    @staticmethod
    def list_url(mlist):
        """See `IArchiver`."""
60
        return mlist.domain.base_url
61 62 63 64

    @staticmethod
    def permalink(mlist, msg):
        """See `IArchiver`."""
65 66 67 68 69
        # It is the LMTP server's responsibility to ensure that the message
        # has a X-Message-ID-Hash header.  If it doesn't then there's no
        # permalink.
        message_id_hash = msg.get('x-message-id-hash')
        if message_id_hash is None:
70
            return None
71 72 73 74
        return urljoin(Prototype.list_url(mlist), message_id_hash)

    @staticmethod
    def archive_message(mlist, message):
75
        """See `IArchiver`.
76 77

        This archiver saves messages into a maildir.
78
        """
79
        archive_dir = os.path.join(config.ARCHIVE_DIR, 'prototype')
80
        try:
81
            os.makedirs(archive_dir, 0o775)
82
        except OSError as error:
83
            # If this already exists, then we're fine
84
            if error.errno != errno.EEXIST:
85 86 87 88
                raise

        # Maildir will throw an error if the directories are partially created
        # (for instance the toplevel exists but cur, new, or tmp do not)
89
        # therefore we don't create the toplevel as we did above.
90
        list_dir = os.path.join(archive_dir, mlist.fqdn_listname)
91 92 93 94 95 96 97 98 99 100 101 102 103
        mailbox = Maildir(list_dir, create=True, factory=None)
        lock_file = os.path.join(
            config.LOCK_DIR, '{0}-maildir.lock'.format(mlist.fqdn_listname))
        # Lock the maildir as Maildir.add() is not threadsafe.  Don't use the
        # context manager because it's not an error if we can't acquire the
        # archiver lock.  We'll just log the problem and continue.
        #
        # XXX 2012-03-14 BAW: When we extend the chain/pipeline architecture
        # to other runners, e.g. the archive runner, it would be better to let
        # any TimeOutError propagate up.  That would cause the message to be
        # re-queued and tried again later, rather than being discarded as
        # happens now below.
        lock = Lock(lock_file)
104 105
        try:
            lock.lock(timeout=timedelta(seconds=1))
106 107 108 109 110 111
            # Add the message to the maildir.  The return value could be used
            # to construct the file path if necessary.  E.g.
            #
            # os.path.join(archive_dir, mlist.fqdn_listname, 'new',
            #              message_key)
            mailbox.add(message)
112
        except TimeOutError:
113 114 115 116 117
            # Log the error and go on.
            log.error('Unable to acquire prototype archiver lock for {0}, '
                      'discarding: {1}'.format(
                          mlist.fqdn_listname,
                          message.get('message-id', 'n/a')))
118 119
        finally:
            lock.unlock(unconditionally=True)