summaryrefslogtreecommitdiff
path: root/src/leap/bitmask/services/mail/imap.py
blob: b06c1d4a05ad60f4e5f821d3c91bceb1ec01e7be (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
# -*- coding: utf-8 -*-
# imap.py
# Copyright (C) 2013 LEAP
#
# 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/>.
"""
Initialization of imap service
"""
import os
import sys

from leap.bitmask.logs.utils import get_logger
from leap.mail.constants import INBOX_NAME
from leap.mail.imap.service import imap
from leap.mail.incoming.service import IncomingMail, INCOMING_CHECK_PERIOD
from twisted.python import log

logger = get_logger()

# The name of the environment variable that has to be
# set to override the default time value, in seconds.
INCOMING_CHECK_PERIOD_ENV = "BITMASK_MAILCHECK_PERIOD"


def get_mail_check_period():
    """
    Tries to get the value of the environment variable for
    overriding the period for incoming mail fetch.
    """
    period = None
    period_str = os.environ.get(INCOMING_CHECK_PERIOD_ENV, None)
    try:
        period = int(period_str)
    except (ValueError, TypeError):
        if period is not None:
            logger.warning("BAD value found for %s: %s" % (
                INCOMING_CHECK_PERIOD_ENV,
                period_str))
    except Exception as exc:
        logger.warning("Unhandled error while getting %s: %r" % (
            INCOMING_CHECK_PERIOD_ENV,
            exc))

    if period is None:
        period = INCOMING_CHECK_PERIOD
    return period


def start_imap_service(*args, **kwargs):
    """
    Initializes and run imap service.

    :returns: LeapIMAPFactory instance
    """
    from leap.bitmask.config import flags
    logger.debug('Launching imap service')

    if flags.MAIL_LOGFILE:
        log.startLogging(open(flags.MAIL_LOGFILE, 'w'))
        log.startLogging(sys.stdout)

    return imap.run_service(*args, **kwargs)


def start_incoming_mail_service(keymanager, soledad, imap_factory, userid):
    """
    Initalizes and starts the incomming mail service.

    :returns: a Deferred that will be fired with the IncomingMail instance
    """
    def setUpIncomingMail(inbox):
        incoming_mail = IncomingMail(
            keymanager,
            soledad,
            inbox.collection,
            userid,
            check_period=get_mail_check_period())
        return incoming_mail

    # XXX: do I really need to know here how to get a mailbox??
    # XXX: ideally, the parent service in mail would take care of initializing
    # the account, and passing the mailbox to the incoming service.
    # In an even better world, we just would subscribe to a channel that would
    # pass us the serialized object to be inserted.
    acc = imap_factory.theAccount
    d = acc.callWhenReady(lambda _: acc.getMailbox(INBOX_NAME))
    d.addCallback(setUpIncomingMail)
    return d