← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/directory_service.py

  • Committer: Canonical.com Patch Queue Manager
  • Date: 2008-09-03 08:32:49 UTC
  • mfrom: (1739.2.13 integration)
  • Revision ID: pqm@pqm.ubuntu.com-20080903083249-e76ygekseh1peidm
Fix typo in ReadDirFeature.

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