← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/directory_service.py

  • Committer: Launchpad Translations on behalf of bzr-core
  • Date: 2012-05-29 04:30:47 UTC
  • mto: (6581.1.1 trunk)
  • mto: This revision was merged to the branch mainline in revision 6582.
  • Revision ID: launchpad_translations_on_behalf_of_bzr-core-20120529043047-mmj2hkq63ke8kl81
Launchpad automatic translations update.

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/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 bzrlib import (
 
26
    errors,
 
27
    registry,
 
28
    )
 
29
from bzrlib.lazy_import import lazy_import
 
30
lazy_import(globals(), """
 
31
from bzrlib import (
 
32
    branch as _mod_branch,
 
33
    urlutils,
 
34
    )
 
35
""")
 
36
 
 
37
 
 
38
class DirectoryServiceRegistry(registry.Registry):
 
39
    """This object maintains and uses a list of directory services.
 
40
 
 
41
    Directory services may be registered via the standard Registry methods.
 
42
    They will be invoked if their key is a prefix of the supplied URL.
 
43
 
 
44
    Each item registered should be a factory of objects that provide a look_up
 
45
    method, as invoked by dereference.  Specifically, look_up should accept a
 
46
    name and URL, and return a URL.
 
47
    """
 
48
 
 
49
    def dereference(self, url):
 
50
        """Dereference a supplied URL if possible.
 
51
 
 
52
        URLs that match a registered directory service prefix are looked up in
 
53
        it.  Non-matching urls are returned verbatim.
 
54
 
 
55
        This is applied only once; the resulting URL must not be one that
 
56
        requires further dereferencing.
 
57
 
 
58
        :param url: The URL to dereference
 
59
        :return: The dereferenced URL if applicable, the input URL otherwise.
 
60
        """
 
61
        match = self.get_prefix(url)
 
62
        if match is None:
 
63
            return url
 
64
        service, name = match
 
65
        return service().look_up(name, url)
 
66
 
 
67
directories = DirectoryServiceRegistry()
 
68
 
 
69
class AliasDirectory(object):
 
70
    """Directory lookup for locations associated with a branch.
 
71
 
 
72
    :parent, :submit, :public, :push, :this, and :bound are currently
 
73
    supported.  On error, a subclass of DirectoryLookupFailure will be raised.
 
74
    """
 
75
 
 
76
    branch_aliases = registry.Registry()
 
77
    branch_aliases.register('parent', lambda b: b.get_parent(),
 
78
        help="The parent of this branch.")
 
79
    branch_aliases.register('submit', lambda b: b.get_submit_branch(),
 
80
        help="The submit branch for this branch.")
 
81
    branch_aliases.register('public', lambda b: b.get_public_branch(),
 
82
        help="The public location of this branch.")
 
83
    branch_aliases.register('bound', lambda b: b.get_bound_location(),
 
84
        help="The branch this branch is bound to, for bound branches.")
 
85
    branch_aliases.register('push', lambda b: b.get_push_location(),
 
86
        help="The saved location used for `bzr push` with no arguments.")
 
87
    branch_aliases.register('this', lambda b: b.base,
 
88
        help="This branch.")
 
89
 
 
90
    def look_up(self, name, url):
 
91
        branch = _mod_branch.Branch.open_containing('.')[0]
 
92
        parts = url.split('/', 1)
 
93
        if len(parts) == 2:
 
94
            name, extra = parts
 
95
        else:
 
96
            (name,) = parts
 
97
            extra = None
 
98
        try:
 
99
            method = self.branch_aliases.get(name[1:])
 
100
        except KeyError:
 
101
            raise errors.InvalidLocationAlias(url)
 
102
        else:
 
103
            result = method(branch)
 
104
        if result is None:
 
105
            raise errors.UnsetLocationAlias(url)
 
106
        if extra is not None:
 
107
            result = urlutils.join(result, extra)
 
108
        return result
 
109
 
 
110
    @classmethod
 
111
    def help_text(cls, topic):
 
112
        alias_lines = []
 
113
        for key in cls.branch_aliases.keys():
 
114
            help = cls.branch_aliases.get_help(key)
 
115
            alias_lines.append("  :%-10s%s\n" % (key, help))
 
116
        return """\
 
117
Location aliases
 
118
================
 
119
 
 
120
Bazaar defines several aliases for locations associated with a branch.  These
 
121
can be used with most commands that expect a location, such as `bzr push`.
 
122
 
 
123
The aliases are::
 
124
 
 
125
%s
 
126
For example, to push to the parent location::
 
127
 
 
128
    bzr push :parent
 
129
""" % "".join(alias_lines)
 
130
 
 
131
 
 
132
directories.register(':', AliasDirectory,
 
133
                     'Easy access to remembered branch locations')