← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/smtp_connection.py

  • Committer: Canonical.com Patch Queue Manager
  • Date: 2009-04-09 20:23:07 UTC
  • mfrom: (4265.1.4 bbc-merge)
  • Revision ID: pqm@pqm.ubuntu.com-20090409202307-n0depb16qepoe21o
(jam) Change _fetch_uses_deltas = False for CHK repos until we can
        write a better fix.

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
        self._authenticate()
 
68
 
 
69
    def _create_connection(self):
 
70
        """Create an SMTP connection."""
 
71
        self._connection = self._smtp_factory()
 
72
        try:
 
73
            self._connection.connect(self._smtp_server)
 
74
        except socket.error, e:
 
75
            if e.args[0] == errno.ECONNREFUSED:
 
76
                if self._config_smtp_server is None:
 
77
                    raise DefaultSMTPConnectionRefused(socket.error,
 
78
                                                       self._smtp_server)
 
79
                else:
 
80
                    raise SMTPConnectionRefused(socket.error,
 
81
                                                self._smtp_server)
 
82
            else:
 
83
                raise
 
84
 
 
85
        # Say EHLO (falling back to HELO) to query the server's features.
 
86
        code, resp = self._connection.ehlo()
 
87
        if not (200 <= code <= 299):
 
88
            code, resp = self._connection.helo()
 
89
            if not (200 <= code <= 299):
 
90
                raise SMTPError("server refused HELO: %d %s" % (code, resp))
 
91
 
 
92
        # Use TLS if the server advertised it:
 
93
        if self._connection.has_extn("starttls"):
 
94
            code, resp = self._connection.starttls()
 
95
            if not (200 <= code <= 299):
 
96
                raise SMTPError("server refused STARTTLS: %d %s" % (code, resp))
 
97
            # Say EHLO again, to check for newly revealed features
 
98
            code, resp = self._connection.ehlo()
 
99
            if not (200 <= code <= 299):
 
100
                raise SMTPError("server refused EHLO: %d %s" % (code, resp))
 
101
 
 
102
    def _authenticate(self):
 
103
        """If necessary authenticate yourself to the server."""
 
104
        auth = config.AuthenticationConfig()
 
105
        if self._smtp_username is None:
 
106
            self._smtp_username = auth.get_user('smtp', self._smtp_server)
 
107
            if self._smtp_username is None:
 
108
                return
 
109
 
 
110
        if self._smtp_password is None:
 
111
            self._smtp_password = auth.get_password(
 
112
                'smtp', self._smtp_server, self._smtp_username)
 
113
 
 
114
        # smtplib requires that the username and password be byte
 
115
        # strings.  The CRAM-MD5 spec doesn't give any guidance on
 
116
        # encodings, but the SASL PLAIN spec says UTF-8, so that's
 
117
        # what we'll use.
 
118
        username = osutils.safe_utf8(self._smtp_username)
 
119
        password = osutils.safe_utf8(self._smtp_password)
 
120
 
 
121
        self._connection.login(username, password)
 
122
 
 
123
    @staticmethod
 
124
    def get_message_addresses(message):
 
125
        """Get the origin and destination addresses of a message.
 
126
 
 
127
        :param message: A message object supporting get() to access its
 
128
            headers, like email.Message or bzrlib.email_message.EmailMessage.
 
129
        :return: A pair (from_email, to_emails), where from_email is the email
 
130
            address in the From header, and to_emails a list of all the
 
131
            addresses in the To, Cc, and Bcc headers.
 
132
        """
 
133
        from_email = Utils.parseaddr(message.get('From', None))[1]
 
134
        to_full_addresses = []
 
135
        for header in ['To', 'Cc', 'Bcc']:
 
136
            value = message.get(header, None)
 
137
            if value:
 
138
                to_full_addresses.append(value)
 
139
        to_emails = [ pair[1] for pair in
 
140
                Utils.getaddresses(to_full_addresses) ]
 
141
 
 
142
        return from_email, to_emails
 
143
 
 
144
    def send_email(self, message):
 
145
        """Send an email message.
 
146
 
 
147
        The message will be sent to all addresses in the To, Cc and Bcc
 
148
        headers.
 
149
 
 
150
        :param message: An email.Message or email.MIMEMultipart object.
 
151
        :return: None
 
152
        """
 
153
        from_email, to_emails = self.get_message_addresses(message)
 
154
 
 
155
        if not to_emails:
 
156
            raise NoDestinationAddress
 
157
 
 
158
        try:
 
159
            self._connect()
 
160
            self._connection.sendmail(from_email, to_emails,
 
161
                                      message.as_string())
 
162
        except smtplib.SMTPRecipientsRefused, e:
 
163
            raise SMTPError('server refused recipient: %d %s' %
 
164
                    e.recipients.values()[0])
 
165
        except smtplib.SMTPResponseException, e:
 
166
            raise SMTPError('%d %s' % (e.smtp_code, e.smtp_error))
 
167
        except smtplib.SMTPException, e:
 
168
            raise SMTPError(str(e))