← 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: 2010-07-07 21:30:06 UTC
  • mfrom: (5333.1.2 better_pyqt_include)
  • Revision ID: pqm@pqm.ubuntu.com-20100707213006-lriphkkbzwwrl7ne
(jameinel) Use a better list of PyQt includes and excludes. (Gary van der
 Merwe)

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/smtp_connection.py
12
12
#
13
13
# You should have received a copy of the GNU General Public License
14
14
# along with this program; if not, write to the Free Software
15
 
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 
15
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
16
16
 
17
17
"""A convenience class around smtplib."""
18
18
 
19
19
from email import Utils
 
20
import errno
20
21
import smtplib
 
22
import socket
21
23
 
22
 
from bzrlib import ui
23
 
from bzrlib.errors import NoDestinationAddress, SMTPError
 
24
from bzrlib import (
 
25
    config,
 
26
    osutils,
 
27
    )
 
28
from bzrlib.errors import (
 
29
    NoDestinationAddress,
 
30
    SMTPError,
 
31
    DefaultSMTPConnectionRefused,
 
32
    SMTPConnectionRefused,
 
33
    )
24
34
 
25
35
 
26
36
class SMTPConnection(object):
33
43
 
34
44
    _default_smtp_server = 'localhost'
35
45
 
36
 
    def __init__(self, config):
 
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
37
50
        self._config = config
38
 
        self._smtp_server = config.get_user_option('smtp_server')
 
51
        self._config_smtp_server = config.get_user_option('smtp_server')
 
52
        self._smtp_server = self._config_smtp_server
39
53
        if self._smtp_server is None:
40
54
            self._smtp_server = self._default_smtp_server
41
55
 
50
64
            return
51
65
 
52
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
53
70
        self._authenticate()
54
71
 
55
72
    def _create_connection(self):
56
73
        """Create an SMTP connection."""
57
 
        self._connection = smtplib.SMTP()
58
 
        self._connection.connect(self._smtp_server)
59
 
 
60
 
        # If this fails, it just returns an error, but it shouldn't raise an
61
 
        # exception unless something goes really wrong (in which case we want
62
 
        # to fail anyway).
63
 
        self._connection.starttls()
 
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))
64
104
 
65
105
    def _authenticate(self):
66
106
        """If necessary authenticate yourself to the server."""
 
107
        auth = config.AuthenticationConfig()
67
108
        if self._smtp_username is None:
68
 
            return
 
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
69
115
 
70
116
        if self._smtp_password is None:
71
 
            self._smtp_password = ui.ui_factory.get_password(
72
 
                'Please enter the SMTP password: %(user)s@%(host)s',
73
 
                user=self._smtp_username,
74
 
                host=self._smtp_server)
75
 
 
76
 
        self._connection.login(self._smtp_username, self._smtp_password)
 
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)
77
128
 
78
129
    @staticmethod
79
130
    def get_message_addresses(message):
80
131
        """Get the origin and destination addresses of a message.
81
132
 
82
 
        :param message: An email.Message or email.MIMEMultipart object.
 
133
        :param message: A message object supporting get() to access its
 
134
            headers, like email.Message or bzrlib.email_message.EmailMessage.
83
135
        :return: A pair (from_email, to_emails), where from_email is the email
84
136
            address in the From header, and to_emails a list of all the
85
137
            addresses in the To, Cc, and Bcc headers.
86
138
        """
87
 
        from_email = Utils.parseaddr(message['From'])[1]
 
139
        from_email = Utils.parseaddr(message.get('From', None))[1]
88
140
        to_full_addresses = []
89
141
        for header in ['To', 'Cc', 'Bcc']:
90
 
            to_full_addresses += message.get_all(header, [])
 
142
            value = message.get(header, None)
 
143
            if value:
 
144
                to_full_addresses.append(value)
91
145
        to_emails = [ pair[1] for pair in
92
146
                Utils.getaddresses(to_full_addresses) ]
93
147