← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/plugins/launchpad/lp_indirect.py

  • Committer: Robert Collins
  • Date: 2008-04-06 23:37:06 UTC
  • mto: This revision was merged to the branch mainline in revision 3340.
  • Revision ID: robertc@robertcollins.net-20080406233706-3md3w1c651a0pndm
Fix ReST table formatting in doc/developers/plugin-api.txt.

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/plugins/launchpad/lp_indirect.py
1
 
# Copyright (C) 2007-2010 Canonical Ltd
 
1
# Copyright (C) 2007 Canonical Ltd
2
2
#
3
3
# This program is free software; you can redistribute it and/or modify
4
4
# it under the terms of the GNU General Public License as published by
12
12
#
13
13
# You should have received a copy of the GNU General Public License
14
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
 
 
18
 
"""Directory lookup that uses Launchpad."""
19
 
 
20
 
from urlparse import urlsplit
 
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 
16
 
 
17
 
 
18
"""Transport indirection that uses Launchpad as a directory lookup.
 
19
 
 
20
When the transport is opened, it immediately redirects to a url
 
21
on Launchpad, which can then either serve the branch itself or redirect
 
22
again.
 
23
"""
 
24
 
 
25
from urlparse import urlsplit, urlunsplit
21
26
import xmlrpclib
22
27
 
23
28
from bzrlib import (
24
29
    debug,
25
30
    errors,
26
31
    trace,
 
32
    urlutils,
27
33
    )
28
34
from bzrlib.transport import (
29
35
    get_transport,
30
36
    register_urlparse_netloc_protocol,
 
37
    Transport,
31
38
    )
32
39
 
33
40
from bzrlib.plugins.launchpad.lp_registration import (
41
48
register_urlparse_netloc_protocol('lp')
42
49
 
43
50
 
44
 
class LaunchpadDirectory(object):
 
51
class LaunchpadTransport(Transport):
 
52
    """lp:/// URL transport
 
53
 
 
54
    This transport redirects requests to the real branch location
 
55
    after resolving the URL via an XMLRPC request to Launchpad.
 
56
    """
 
57
 
 
58
    def __init__(self, base):
 
59
        super(LaunchpadTransport, self).__init__(base)
 
60
        # We only support URLs without a netloc
 
61
        self.lp_instance = urlsplit(base)[1]
 
62
        if self.lp_instance == '':
 
63
            self.lp_instance = None
 
64
        elif self.lp_instance not in LaunchpadService.LAUNCHPAD_INSTANCE:
 
65
            raise errors.InvalidURL(path=base)
45
66
 
46
67
    def _requires_launchpad_login(self, scheme, netloc, path, query,
47
68
                                  fragment):
54
75
                and (netloc.endswith('launchpad.net')
55
76
                     or netloc.endswith('launchpad.dev')))
56
77
 
57
 
    def look_up(self, name, url):
58
 
        """See DirectoryService.look_up"""
59
 
        return self._resolve(url)
60
 
 
61
 
    def _resolve(self, url,
 
78
    def _resolve(self, abspath,
62
79
                 _request_factory=ResolveLaunchpadPathRequest,
63
80
                 _lp_login=None):
64
81
        """Resolve the base URL for this transport."""
65
 
        service = LaunchpadService.for_url(url)
66
 
        result = urlsplit(url)
67
 
        resolve = _request_factory(result[2].strip('/'))
 
82
        path = urlsplit(abspath)[2].lstrip('/')
 
83
        # Perform an XMLRPC request to resolve the path
 
84
        resolve = _request_factory(path)
 
85
        service = LaunchpadService(lp_instance=self.lp_instance)
68
86
        try:
69
87
            result = resolve.submit(service)
70
88
        except xmlrpclib.Fault, fault:
71
89
            raise errors.InvalidURL(
72
 
                path=url, extra=fault.faultString)
 
90
                path=abspath, extra=fault.faultString)
73
91
 
74
92
        if 'launchpad' in debug.debug_flags:
75
 
            trace.mutter("resolve_lp_path(%r) == %r", url, result)
 
93
            trace.mutter("resolve_lp_path(%r) == %r", path, result)
76
94
 
77
95
        if _lp_login is None:
78
96
            _lp_login = get_lp_login()
79
 
        _warned_login = False
80
97
        for url in result['urls']:
81
98
            scheme, netloc, path, query, fragment = urlsplit(url)
82
99
            if self._requires_launchpad_login(scheme, netloc, path, query,
83
100
                                              fragment):
84
101
                # Only accept launchpad.net bzr+ssh URLs if we know
85
102
                # the user's Launchpad login:
86
 
                if _lp_login is not None:
87
 
                    break
88
103
                if _lp_login is None:
89
 
                    if not _warned_login:
90
 
                        trace.warning(
91
 
'You have not informed bzr of your Launchpad ID, and you must do this to\n'
92
 
'write to Launchpad or access private data.  See "bzr help launchpad-login".')
93
 
                        _warned_login = True
 
104
                    continue
 
105
                url = urlunsplit((scheme, '%s@%s' % (_lp_login, netloc),
 
106
                                  path, query, fragment))
 
107
                break
94
108
            else:
95
109
                # Use the URL if we can create a transport for it.
96
110
                try:
100
114
                else:
101
115
                    break
102
116
        else:
103
 
            raise errors.InvalidURL(path=url, extra='no supported schemes')
 
117
            raise errors.InvalidURL(path=abspath,
 
118
                                    extra='no supported schemes')
104
119
        return url
105
120
 
 
121
    def _request_redirect(self, relpath):
 
122
        source = urlutils.join(self.base, relpath)
 
123
        # Split the source location into the branch location, and the
 
124
        # extra path components.
 
125
        pos = source.find('/.bzr/')
 
126
        if pos >= 0:
 
127
            branchpath = source[:pos]
 
128
            extra = source[pos:]
 
129
        else:
 
130
            branchpath = source
 
131
            extra = ''
 
132
        target = self._resolve(branchpath) + extra
 
133
        raise errors.RedirectRequested(
 
134
            source=source,
 
135
            target=target)
 
136
 
 
137
    def get(self, relpath):
 
138
        """See Transport.get()."""
 
139
        self._request_redirect(relpath)
 
140
 
 
141
    def mkdir(self, relpath, mode=None):
 
142
        """See Transport.mkdir()."""
 
143
        self._request_redirect(relpath)
 
144
 
106
145
 
107
146
def get_test_permutations():
108
147
    # Since this transport doesn't do anything once opened, it's not subjected