/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: Robert Collins
  • Date: 2008-01-06 20:04:22 UTC
  • mto: (3221.11.1 StackableBranch)
  • mto: This revision was merged to the branch mainline in revision 3226.
  • Revision ID: robertc@robertcollins.net-20080106200422-x8yz6cxotlzltvwp
The bzrdir format registry now accepts an ``alias`` keyword to
register_metadir, used to indicate that a format name is an alias for
some other format and thus should not be reported when describing the
format. (Robert Collins)
-------------- This line and the fmllowing will be ignored --------------

modified:
  NEWS
  bzrlib/bzrdir.py
  bzrlib/info.py
  bzrlib/tests/test_bzrdir.py
  bzrlib/tests/test_info.py

=== modified file 'NEWS'
--- a/NEWS      2008-01-02 22:30:46 +0000
+++ b/NEWS      2008-01-06 20:04:15 +0000
@@ -135,6 +135,11 @@
     * Patience Diff now supports arbitrary python objects, as long as they
       support ``hash()``. (John Arbash Meinel)
 
+    * The bzrdir format registry now accepts an ``alias`` keyword to
+      register_metadir, used to indicate that a format name is an alias for
+      some other format and thus should not be reported when describing the
+      format. (Robert Collins)
+
   API BREAKS:
 
   TESTING:

=== modified file 'bzrlib/bzrdir.py'
--- a/bzrlib/bzrdir.py  2008-01-02 22:30:46 +0000
+++ b/bzrlib/bzrdir.py  2008-01-06 19:41:29 +0000
@@ -2447,12 +2447,22 @@
     e.g. BzrDirMeta1 with weave repository.  Also, it's more user-oriented.
     """
 
+    def __init__(self):
+        """Create a BzrDirFormatRegistry."""
+        self._aliases = set()
+        super(BzrDirFormatRegistry, self).__init__()
+
+    def aliases(self):
+        """Return a set of the format names which are aliases."""
+        return frozenset(self._aliases)
+
     def register_metadir(self, key,
              repository_format, help, native=True, deprecated=False,
              branch_format=None,
              tree_format=None,
              hidden=False,
-             experimental=False):
+             experimental=False,
+             alias=False):
         """Register a metadir subformat.
 
         These all use a BzrDirMetaFormat1 bzrdir, but can be parameterized
@@ -2491,10 +2501,10 @@
                 bd.repository_format = _load(repository_format)
             return bd
         self.register(key, helper, help, native, deprecated, hidden,
-            experimental)
+            experimental, alias)
 
     def register(self, key, factory, help, native=True, deprecated=False,
-                 hidden=False, experimental=False):
+                 hidden=False, experimental=False, alias=False):
         """Register a BzrDirFormat factory.
         
         The factory must be a callable that takes one parameter: the key.
@@ -2505,11 +2515,15 @@
         """
         registry.Registry.register(self, key, factory, help,
             BzrDirFormatInfo(native, deprecated, hidden, experimental))
+        if alias:
+            self._aliases.add(key)
 
     def register_lazy(self, key, module_name, member_name, help, native=True,
-                      deprecated=False, hidden=False, experimental=False):
+        deprecated=False, hidden=False, experimental=False, alias=False):
         registry.Registry.register_lazy(self, key, module_name, member_name,
             help, BzrDirFormatInfo(native, deprecated, hidden, experimental))
+        if alias:
+            self._aliases.add(key)
 
     def set_default(self, key):
         """Set the 'default' key to be a clone of the supplied key.
@@ -2518,6 +2532,7 @@
         """
         registry.Registry.register(self, 'default', self.get(key),
             self.get_help(key), info=self.get_info(key))
+        self._aliases.add('default')
 
     def set_default_repository(self, key):
         """Set the FormatRegistry default and Repository default.
@@ -2670,6 +2685,7 @@
     tree_format='bzrlib.workingtree.WorkingTreeFormat4',
     hidden=False,
     )
+# The following two formats should always just be aliases.
 format_registry.register_metadir('development',
     'bzrlib.repofmt.pack_repo.RepositoryFormatPackDevelopment0',
     help='Current development format. Can convert data to and from pack-0.92 '
@@ -2681,6 +2697,7 @@
     branch_format='bzrlib.branch.BzrBranchFormat6',
     tree_format='bzrlib.workingtree.WorkingTreeFormat4',
     experimental=True,
+    alias=True,
     )
 format_registry.register_metadir('development-subtree',
     'bzrlib.repofmt.pack_repo.RepositoryFormatPackDevelopment0Subtree',
@@ -2693,7 +2710,9 @@
     branch_format='bzrlib.branch.BzrBranchFormat6',
     tree_format='bzrlib.workingtree.WorkingTreeFormat4',
     experimental=True,
+    alias=True,
     )
+# And the development formats which the will have aliased one of follow:
 format_registry.register_metadir('development0',
     'bzrlib.repofmt.pack_repo.RepositoryFormatPackDevelopment0',
     help='Trivial rename of pack-0.92 to provide a development format. '

=== modified file 'bzrlib/info.py'
--- a/bzrlib/info.py    2007-11-06 09:00:25 +0000
+++ b/bzrlib/info.py    2008-01-06 20:01:30 +0000
@@ -440,7 +440,9 @@
         tree.bzrdir.root_transport.base):
         branch = None
         repository = None
-    for key in bzrdir.format_registry.keys():
+    non_aliases = set(bzrdir.format_registry.keys())
+    non_aliases.difference_update(bzrdir.format_registry.aliases())
+    for key in non_aliases:
         format = bzrdir.format_registry.make_bzrdir(key)
         if isinstance(format, bzrdir.BzrDirMetaFormat1):
             if (tree and format.workingtree_format !=
@@ -457,11 +459,12 @@
         candidates.append(key)
     if len(candidates) == 0:
         return 'unnamed'
-    new_candidates = [c for c in candidates if c != 'default']
-    if len(new_candidates) > 0:
-        candidates = new_candidates
+    candidates.sort()
     new_candidates = [c for c in candidates if not
         bzrdir.format_registry.get_info(c).hidden]
     if len(new_candidates) > 0:
+        # If there are any non-hidden formats that match, only return those to
+        # avoid listing hidden formats except when only a hidden format will
+        # do.
         candidates = new_candidates
     return ' or '.join(candidates)

=== modified file 'bzrlib/tests/test_bzrdir.py'
--- a/bzrlib/tests/test_bzrdir.py       2007-12-21 20:32:22 +0000
+++ b/bzrlib/tests/test_bzrdir.py       2008-01-06 19:45:00 +0000
@@ -170,6 +170,16 @@
         finally:
             bzrdir.format_registry.set_default_repository(old_default)
 
+    def test_aliases(self):
+        a_registry = bzrdir.BzrDirFormatRegistry()
+        a_registry.register('weave', bzrdir.BzrDirFormat6,
+            'Pre-0.8 format.  Slower and does not support checkouts or shared'
+            ' repositories', deprecated=True)
+        a_registry.register('weavealias', bzrdir.BzrDirFormat6,
+            'Pre-0.8 format.  Slower and does not support checkouts or shared'
+            ' repositories', deprecated=True, alias=True)
+        self.assertEqual(frozenset(['weavealias']), a_registry.aliases())
+    
 
 class SampleBranch(bzrlib.branch.Branch):
     """A dummy branch for guess what, dummy use."""

=== modified file 'bzrlib/tests/test_info.py'
--- a/bzrlib/tests/test_info.py 2007-11-26 13:55:51 +0000
+++ b/bzrlib/tests/test_info.py 2008-01-06 20:02:10 +0000
@@ -126,16 +126,22 @@
 
     def test_describe_tree_format(self):
         for key in bzrdir.format_registry.keys():
-            if key == 'default':
+            if key in bzrdir.format_registry.aliases():
                 continue
             self.assertTreeDescription(key)
 
     def test_describe_checkout_format(self):
         for key in bzrdir.format_registry.keys():
-            if key in ('default', 'weave', 'experimental'):
-                continue
-            if key.startswith('experimental-'):
-                # these are typically hidden or aliases for other formats
+            if key in bzrdir.format_registry.aliases():
+                # Aliases will not describe correctly in the UI because the
+                # real format is found.
+                continue
+            # legacy: weave does not support checkouts
+            if key == 'weave':
+                continue
+            if bzrdir.format_registry.get_info(key).experimental:
+                # We don't require that experimental formats support checkouts
+                # or describe correctly in the UI.
                 continue
             expected = None
             if key in ('dirstate', 'dirstate-tags', 'dirstate-with-subtree',
@@ -149,7 +155,7 @@
 
     def test_describe_branch_format(self):
         for key in bzrdir.format_registry.keys():
-            if key == 'default':
+            if key in bzrdir.format_registry.aliases():
                 continue
             expected = None
             if key in ('dirstate', 'knit'):
@@ -158,7 +164,7 @@
 
     def test_describe_repo_format(self):
         for key in bzrdir.format_registry.keys():
-            if key == 'default':
+            if key in bzrdir.format_registry.aliases():
                 continue
             expected = None
             if key in ('dirstate', 'knit', 'dirstate-tags'):

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., 59 Temple Place, Suite 330, Boston, MA  02111-1307  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
    ui,
 
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
        self._connection.login(self._smtp_username, self._smtp_password)
 
115
 
 
116
    @staticmethod
 
117
    def get_message_addresses(message):
 
118
        """Get the origin and destination addresses of a message.
 
119
 
 
120
        :param message: A message object supporting get() to access its
 
121
            headers, like email.Message or bzrlib.email_message.EmailMessage.
 
122
        :return: A pair (from_email, to_emails), where from_email is the email
 
123
            address in the From header, and to_emails a list of all the
 
124
            addresses in the To, Cc, and Bcc headers.
 
125
        """
 
126
        from_email = Utils.parseaddr(message.get('From', None))[1]
 
127
        to_full_addresses = []
 
128
        for header in ['To', 'Cc', 'Bcc']:
 
129
            value = message.get(header, None)
 
130
            if value:
 
131
                to_full_addresses.append(value)
 
132
        to_emails = [ pair[1] for pair in
 
133
                Utils.getaddresses(to_full_addresses) ]
 
134
 
 
135
        return from_email, to_emails
 
136
 
 
137
    def send_email(self, message):
 
138
        """Send an email message.
 
139
 
 
140
        The message will be sent to all addresses in the To, Cc and Bcc
 
141
        headers.
 
142
 
 
143
        :param message: An email.Message or email.MIMEMultipart object.
 
144
        :return: None
 
145
        """
 
146
        from_email, to_emails = self.get_message_addresses(message)
 
147
 
 
148
        if not to_emails:
 
149
            raise NoDestinationAddress
 
150
 
 
151
        try:
 
152
            self._connect()
 
153
            self._connection.sendmail(from_email, to_emails,
 
154
                                      message.as_string())
 
155
        except smtplib.SMTPRecipientsRefused, e:
 
156
            raise SMTPError('server refused recipient: %d %s' %
 
157
                    e.recipients.values()[0])
 
158
        except smtplib.SMTPResponseException, e:
 
159
            raise SMTPError('%d %s' % (e.smtp_code, e.smtp_error))
 
160
        except smtplib.SMTPException, e:
 
161
            raise SMTPError(str(e))