/brz/remove-bazaar

To get this branch, use:
bzr branch http://gegoxaren.bato24.eu/bzr/brz/remove-bazaar

« back to all changes in this revision

Viewing changes to bzrlib/smtp_connection.py

  • Committer: Vincent Ladeuil
  • Date: 2010-01-25 15:55:48 UTC
  • mto: (4985.1.4 add-attr-cleanup)
  • mto: This revision was merged to the branch mainline in revision 4988.
  • Revision ID: v.ladeuil+lp@free.fr-20100125155548-0l352pujvt5bzl5e
Deploy addAttrCleanup on the whole test suite.

Several use case worth mentioning:

- setting a module or any other object attribute is the majority
by far. In some cases the setting itself is deferred but most of
the time we want to set at the same time we add the cleanup.

- there multiple occurrences of protecting hooks or ui factory
which are now useless (the test framework takes care of that now),

- there was some lambda uses that can now be avoided.

That first cleanup already simplifies things a lot.

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/smtp_connection.py
 
1
# Copyright (C) 2007 Canonical Ltd
 
2
#
 
3
# This program is free software; you can redistribute it and/or modify
 
4
# it under the terms of the GNU General Public License as published by
 
5
# the Free Software Foundation; either version 2 of the License, or
 
6
# (at your option) any later version.
 
7
#
 
8
# This program is distributed in the hope that it will be useful,
 
9
# but WITHOUT ANY WARRANTY; without even the implied warranty of
 
10
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 
11
# GNU General Public License for more details.
 
12
#
 
13
# You should have received a copy of the GNU General Public License
 
14
# along with this program; if not, write to the Free Software
 
15
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
 
16
 
 
17
"""A convenience class around smtplib."""
 
18
 
 
19
from email import Utils
 
20
import errno
 
21
import smtplib
 
22
import socket
 
23
 
 
24
from bzrlib import (
 
25
    config,
 
26
    osutils,
 
27
    )
 
28
from bzrlib.errors import (
 
29
    NoDestinationAddress,
 
30
    SMTPError,
 
31
    DefaultSMTPConnectionRefused,
 
32
    SMTPConnectionRefused,
 
33
    )
 
34
 
 
35
 
 
36
class SMTPConnection(object):
 
37
    """Connect to an SMTP server and send an email.
 
38
 
 
39
    This is a gateway between bzrlib.config.Config and smtplib.SMTP. It
 
40
    understands the basic bzr SMTP configuration information: smtp_server,
 
41
    smtp_username, and smtp_password.
 
42
    """
 
43
 
 
44
    _default_smtp_server = 'localhost'
 
45
 
 
46
    def __init__(self, config, _smtp_factory=None):
 
47
        self._smtp_factory = _smtp_factory
 
48
        if self._smtp_factory is None:
 
49
            self._smtp_factory = smtplib.SMTP
 
50
        self._config = config
 
51
        self._config_smtp_server = config.get_user_option('smtp_server')
 
52
        self._smtp_server = self._config_smtp_server
 
53
        if self._smtp_server is None:
 
54
            self._smtp_server = self._default_smtp_server
 
55
 
 
56
        self._smtp_username = config.get_user_option('smtp_username')
 
57
        self._smtp_password = config.get_user_option('smtp_password')
 
58
 
 
59
        self._connection = None
 
60
 
 
61
    def _connect(self):
 
62
        """If we haven't connected, connect and authenticate."""
 
63
        if self._connection is not None:
 
64
            return
 
65
 
 
66
        self._create_connection()
 
67
        # FIXME: _authenticate() should only be called when the server has
 
68
        # refused unauthenticated access, so it can safely try to authenticate 
 
69
        # with the default username. JRV20090407
 
70
        self._authenticate()
 
71
 
 
72
    def _create_connection(self):
 
73
        """Create an SMTP connection."""
 
74
        self._connection = self._smtp_factory()
 
75
        try:
 
76
            self._connection.connect(self._smtp_server)
 
77
        except socket.error, e:
 
78
            if e.args[0] == errno.ECONNREFUSED:
 
79
                if self._config_smtp_server is None:
 
80
                    raise DefaultSMTPConnectionRefused(socket.error,
 
81
                                                       self._smtp_server)
 
82
                else:
 
83
                    raise SMTPConnectionRefused(socket.error,
 
84
                                                self._smtp_server)
 
85
            else:
 
86
                raise
 
87
 
 
88
        # Say EHLO (falling back to HELO) to query the server's features.
 
89
        code, resp = self._connection.ehlo()
 
90
        if not (200 <= code <= 299):
 
91
            code, resp = self._connection.helo()
 
92
            if not (200 <= code <= 299):
 
93
                raise SMTPError("server refused HELO: %d %s" % (code, resp))
 
94
 
 
95
        # Use TLS if the server advertised it:
 
96
        if self._connection.has_extn("starttls"):
 
97
            code, resp = self._connection.starttls()
 
98
            if not (200 <= code <= 299):
 
99
                raise SMTPError("server refused STARTTLS: %d %s" % (code, resp))
 
100
            # Say EHLO again, to check for newly revealed features
 
101
            code, resp = self._connection.ehlo()
 
102
            if not (200 <= code <= 299):
 
103
                raise SMTPError("server refused EHLO: %d %s" % (code, resp))
 
104
 
 
105
    def _authenticate(self):
 
106
        """If necessary authenticate yourself to the server."""
 
107
        auth = config.AuthenticationConfig()
 
108
        if self._smtp_username is None:
 
109
            # FIXME: Since _authenticate gets called even when no authentication
 
110
            # is necessary, it's not possible to use the default username 
 
111
            # here yet.
 
112
            self._smtp_username = auth.get_user('smtp', self._smtp_server)
 
113
            if self._smtp_username is None:
 
114
                return
 
115
 
 
116
        if self._smtp_password is None:
 
117
            self._smtp_password = auth.get_password(
 
118
                'smtp', self._smtp_server, self._smtp_username)
 
119
 
 
120
        # smtplib requires that the username and password be byte
 
121
        # strings.  The CRAM-MD5 spec doesn't give any guidance on
 
122
        # encodings, but the SASL PLAIN spec says UTF-8, so that's
 
123
        # what we'll use.
 
124
        username = osutils.safe_utf8(self._smtp_username)
 
125
        password = osutils.safe_utf8(self._smtp_password)
 
126
 
 
127
        self._connection.login(username, password)
 
128
 
 
129
    @staticmethod
 
130
    def get_message_addresses(message):
 
131
        """Get the origin and destination addresses of a message.
 
132
 
 
133
        :param message: A message object supporting get() to access its
 
134
            headers, like email.Message or bzrlib.email_message.EmailMessage.
 
135
        :return: A pair (from_email, to_emails), where from_email is the email
 
136
            address in the From header, and to_emails a list of all the
 
137
            addresses in the To, Cc, and Bcc headers.
 
138
        """
 
139
        from_email = Utils.parseaddr(message.get('From', None))[1]
 
140
        to_full_addresses = []
 
141
        for header in ['To', 'Cc', 'Bcc']:
 
142
            value = message.get(header, None)
 
143
            if value:
 
144
                to_full_addresses.append(value)
 
145
        to_emails = [ pair[1] for pair in
 
146
                Utils.getaddresses(to_full_addresses) ]
 
147
 
 
148
        return from_email, to_emails
 
149
 
 
150
    def send_email(self, message):
 
151
        """Send an email message.
 
152
 
 
153
        The message will be sent to all addresses in the To, Cc and Bcc
 
154
        headers.
 
155
 
 
156
        :param message: An email.Message or email.MIMEMultipart object.
 
157
        :return: None
 
158
        """
 
159
        from_email, to_emails = self.get_message_addresses(message)
 
160
 
 
161
        if not to_emails:
 
162
            raise NoDestinationAddress
 
163
 
 
164
        try:
 
165
            self._connect()
 
166
            self._connection.sendmail(from_email, to_emails,
 
167
                                      message.as_string())
 
168
        except smtplib.SMTPRecipientsRefused, e:
 
169
            raise SMTPError('server refused recipient: %d %s' %
 
170
                    e.recipients.values()[0])
 
171
        except smtplib.SMTPResponseException, e:
 
172
            raise SMTPError('%d %s' % (e.smtp_code, e.smtp_error))
 
173
        except smtplib.SMTPException, e:
 
174
            raise SMTPError(str(e))