/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 breezy/directory_service.py

[merge] robertc's integration, updated tests to check for retcode=3

Show diffs side-by-side

added added

removed removed

Lines of Context:
breezy/directory_service.py
1
 
# Copyright (C) 2008, 2009, 2011 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
 
"""Directory service registration and usage.
18
 
 
19
 
Directory services are utilities that provide a mapping from URL-like strings
20
 
to true URLs.  Examples include lp:urls and per-user location aliases.
21
 
"""
22
 
 
23
 
from __future__ import absolute_import
24
 
 
25
 
from . import (
26
 
    errors,
27
 
    registry,
28
 
    )
29
 
from .lazy_import import lazy_import
30
 
lazy_import(globals(), """
31
 
from breezy import (
32
 
    branch as _mod_branch,
33
 
    controldir as _mod_controldir,
34
 
    urlutils,
35
 
    )
36
 
""")
37
 
 
38
 
 
39
 
class DirectoryLookupFailure(errors.BzrError):
40
 
    """Base type for lookup errors."""
41
 
 
42
 
 
43
 
class InvalidLocationAlias(DirectoryLookupFailure):
44
 
 
45
 
    _fmt = '"%(alias_name)s" is not a valid location alias.'
46
 
 
47
 
    def __init__(self, alias_name):
48
 
        DirectoryLookupFailure.__init__(self, alias_name=alias_name)
49
 
 
50
 
 
51
 
class UnsetLocationAlias(DirectoryLookupFailure):
52
 
 
53
 
    _fmt = 'No %(alias_name)s location assigned.'
54
 
 
55
 
    def __init__(self, alias_name):
56
 
        DirectoryLookupFailure.__init__(self, alias_name=alias_name[1:])
57
 
 
58
 
 
59
 
class DirectoryServiceRegistry(registry.Registry):
60
 
    """This object maintains and uses a list of directory services.
61
 
 
62
 
    Directory services may be registered via the standard Registry methods.
63
 
    They will be invoked if their key is a prefix of the supplied URL.
64
 
 
65
 
    Each item registered should be a factory of objects that provide a look_up
66
 
    method, as invoked by dereference.  Specifically, look_up should accept a
67
 
    name and URL, and return a URL.
68
 
    """
69
 
 
70
 
    def dereference(self, url, purpose=None):
71
 
        """Dereference a supplied URL if possible.
72
 
 
73
 
        URLs that match a registered directory service prefix are looked up in
74
 
        it.  Non-matching urls are returned verbatim.
75
 
 
76
 
        This is applied only once; the resulting URL must not be one that
77
 
        requires further dereferencing.
78
 
 
79
 
        :param url: The URL to dereference
80
 
        :param purpose: Purpose of the URL ('read', 'write' or None - if not declared)
81
 
        :return: The dereferenced URL if applicable, the input URL otherwise.
82
 
        """
83
 
        match = self.get_prefix(url)
84
 
        if match is None:
85
 
            return url
86
 
        service, name = match
87
 
        directory = service()
88
 
        try:
89
 
            return directory.look_up(name, url, purpose=purpose)
90
 
        except TypeError:
91
 
            # Compatibility for plugins written for Breezy < 3.0.0
92
 
            return directory.look_up(name, url)
93
 
 
94
 
 
95
 
directories = DirectoryServiceRegistry()
96
 
 
97
 
 
98
 
class Directory(object):
99
 
    """Abstract directory lookup class."""
100
 
 
101
 
    def look_up(self, name, url, purpose=None):
102
 
        """Look up an entry in a directory.
103
 
 
104
 
        :param name: Directory name
105
 
        :param url: The URL to dereference
106
 
        :param purpose: Purpose of the URL ('read', 'write' or None - if not declared)
107
 
        :return: The dereferenced URL if applicable, the input URL otherwise.
108
 
        """
109
 
        raise NotImplementedError(self.look_up)
110
 
 
111
 
 
112
 
class AliasDirectory(Directory):
113
 
    """Directory lookup for locations associated with a branch.
114
 
 
115
 
    :parent, :submit, :public, :push, :this, and :bound are currently
116
 
    supported.  On error, a subclass of DirectoryLookupFailure will be raised.
117
 
    """
118
 
 
119
 
    branch_aliases = registry.Registry()
120
 
    branch_aliases.register('parent', lambda b: b.get_parent(),
121
 
                            help="The parent of this branch.")
122
 
    branch_aliases.register('submit', lambda b: b.get_submit_branch(),
123
 
                            help="The submit branch for this branch.")
124
 
    branch_aliases.register('public', lambda b: b.get_public_branch(),
125
 
                            help="The public location of this branch.")
126
 
    branch_aliases.register('bound', lambda b: b.get_bound_location(),
127
 
                            help="The branch this branch is bound to, for bound branches.")
128
 
    branch_aliases.register('push', lambda b: b.get_push_location(),
129
 
                            help="The saved location used for `brz push` with no arguments.")
130
 
    branch_aliases.register('this', lambda b: b.base,
131
 
                            help="This branch.")
132
 
 
133
 
    def look_up(self, name, url, purpose=None):
134
 
        branch = _mod_branch.Branch.open_containing('.')[0]
135
 
        parts = url.split('/', 1)
136
 
        if len(parts) == 2:
137
 
            name, extra = parts
138
 
        else:
139
 
            (name,) = parts
140
 
            extra = None
141
 
        try:
142
 
            method = self.branch_aliases.get(name[1:])
143
 
        except KeyError:
144
 
            raise InvalidLocationAlias(url)
145
 
        else:
146
 
            result = method(branch)
147
 
        if result is None:
148
 
            raise UnsetLocationAlias(url)
149
 
        if extra is not None:
150
 
            result = urlutils.join(result, extra)
151
 
        return result
152
 
 
153
 
    @classmethod
154
 
    def help_text(cls, topic):
155
 
        alias_lines = []
156
 
        for key in cls.branch_aliases.keys():
157
 
            help = cls.branch_aliases.get_help(key)
158
 
            alias_lines.append("  :%-10s%s\n" % (key, help))
159
 
        return """\
160
 
Location aliases
161
 
================
162
 
 
163
 
Bazaar defines several aliases for locations associated with a branch.  These
164
 
can be used with most commands that expect a location, such as `brz push`.
165
 
 
166
 
The aliases are::
167
 
 
168
 
%s
169
 
For example, to push to the parent location::
170
 
 
171
 
    brz push :parent
172
 
""" % "".join(alias_lines)
173
 
 
174
 
 
175
 
directories.register(':', AliasDirectory,
176
 
                     'Easy access to remembered branch locations')
177
 
 
178
 
 
179
 
class ColocatedDirectory(Directory):
180
 
    """Directory lookup for colocated branches.
181
 
 
182
 
    co:somename will resolve to the colocated branch with "somename" in
183
 
    the current directory.
184
 
    """
185
 
 
186
 
    def look_up(self, name, url, purpose=None):
187
 
        dir = _mod_controldir.ControlDir.open_containing('.')[0]
188
 
        return urlutils.join_segment_parameters(
189
 
            dir.user_url, {"branch": urlutils.escape(name)})
190
 
 
191
 
 
192
 
directories.register('co:', ColocatedDirectory,
193
 
                     'Easy access to colocated branches')