← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/directory_service.py

 * Hook up the new remote method ``RemoteBzrDir.find_repositoryV2`` so
   that it is now attempted first when lookup up repositories, leading to
   an extra round trip on older bzr smart servers but supporting the
   feature on newer servers. (Robert Collins)

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/directory_service.py
1
 
# Copyright (C) 2008 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
 
"""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 bzrlib import errors, registry
24
 
from bzrlib.lazy_import import lazy_import
25
 
lazy_import(globals(), """
26
 
from bzrlib.branch import Branch
27
 
from bzrlib import urlutils
28
 
""")
29
 
 
30
 
 
31
 
class DirectoryServiceRegistry(registry.Registry):
32
 
    """This object maintains and uses a list of directory services.
33
 
 
34
 
    Directory services may be registered via the standard Registry methods.
35
 
    They will be invoked if their key is a prefix of the supplied URL.
36
 
 
37
 
    Each item registered should be a factory of objects that provide a look_up
38
 
    method, as invoked by dereference.  Specifically, look_up should accept a
39
 
    name and URL, and return a URL.
40
 
    """
41
 
 
42
 
    def dereference(self, url):
43
 
        """Dereference a supplied URL if possible.
44
 
 
45
 
        URLs that match a registered directory service prefix are looked up in
46
 
        it.  Non-matching urls are returned verbatim.
47
 
 
48
 
        This is applied only once; the resulting URL must not be one that
49
 
        requires further dereferencing.
50
 
 
51
 
        :param url: The URL to dereference
52
 
        :return: The dereferenced URL if applicable, the input URL otherwise.
53
 
        """
54
 
        match = self.get_prefix(url)
55
 
        if match is None:
56
 
            return url
57
 
        service, name = match
58
 
        return service().look_up(name, url)
59
 
 
60
 
directories = DirectoryServiceRegistry()
61
 
 
62
 
 
63
 
class AliasDirectory(object):
64
 
    """Directory lookup for locations associated with a branch.
65
 
 
66
 
    :parent, :submit, :public, :push, :this, and :bound are currently
67
 
    supported.  On error, a subclass of DirectoryLookupFailure will be raised.
68
 
    """
69
 
 
70
 
    def look_up(self, name, url):
71
 
        branch = Branch.open_containing('.')[0]
72
 
        lookups = {
73
 
            'parent': branch.get_parent,
74
 
            'submit': branch.get_submit_branch,
75
 
            'public': branch.get_public_branch,
76
 
            'bound': branch.get_bound_location,
77
 
            'push': branch.get_push_location,
78
 
            'this': lambda: branch.base
79
 
        }
80
 
        parts = url.split('/', 1)
81
 
        if len(parts) == 2:
82
 
            name, extra = parts
83
 
        else:
84
 
            (name,) = parts
85
 
            extra = None
86
 
        try:
87
 
            method = lookups[name[1:]]
88
 
        except KeyError:
89
 
            raise errors.InvalidLocationAlias(url)
90
 
        else:
91
 
            result = method()
92
 
        if result is None:
93
 
            raise errors.UnsetLocationAlias(url)
94
 
        if extra is not None:
95
 
            result = urlutils.join(result, extra)
96
 
        return result
97
 
 
98
 
directories.register(':', AliasDirectory,
99
 
                     'Easy access to remembered branch locations')