← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/directory_service.py

  • Committer: Patch Queue Manager
  • Date: 2011-09-22 14:12:18 UTC
  • mfrom: (6155.3.1 jam)
  • Revision ID: pqm@pqm.ubuntu.com-20110922141218-86s4uu6nqvourw4f
(jameinel) Cleanup comments bzrlib/smart/__init__.py (John A Meinel)

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