← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

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

  • Committer: John Arbash Meinel
  • Author(s): Mark Hammond
  • Date: 2008-09-09 17:02:21 UTC
  • mto: This revision was merged to the branch mainline in revision 3697.
  • Revision ID: john@arbash-meinel.com-20080909170221-svim3jw2mrz0amp3
An updated transparent icon for bzr.

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/plugins/launchpad/lp_registration.py
32
32
export BZR_LP_XMLRPC_URL=http://xmlrpc.staging.launchpad.net/bazaar/
33
33
'''
34
34
 
 
35
class InvalidLaunchpadInstance(errors.BzrError):
 
36
 
 
37
    _fmt = "%(lp_instance)s is not a valid Launchpad instance."
 
38
 
 
39
    def __init__(self, lp_instance):
 
40
        errors.BzrError.__init__(self, lp_instance=lp_instance)
 
41
 
 
42
 
35
43
class LaunchpadService(object):
36
44
    """A service to talk to Launchpad via XMLRPC.
37
 
    
 
45
 
38
46
    See http://bazaar-vcs.org/Specs/LaunchpadRpc for the methods we can call.
39
47
    """
40
48
 
41
 
    # NB: this should always end in a slash to avoid xmlrpclib appending
 
49
    # NB: these should always end in a slash to avoid xmlrpclib appending
42
50
    # '/RPC2'
43
 
    DEFAULT_SERVICE_URL = 'https://xmlrpc.launchpad.net/bazaar/'
 
51
    # We use edge as the default because:
 
52
    # Beta users get redirected to it
 
53
    # All users can use it
 
54
    # There is a bug in the launchpad side where redirection causes an OOPS.
 
55
    LAUNCHPAD_INSTANCE = {
 
56
        'production': 'https://xmlrpc.launchpad.net/bazaar/',
 
57
        'edge': 'https://xmlrpc.edge.launchpad.net/bazaar/',
 
58
        'staging': 'https://xmlrpc.staging.launchpad.net/bazaar/',
 
59
        'demo': 'https://xmlrpc.demo.launchpad.net/bazaar/',
 
60
        'dev': 'http://xmlrpc.launchpad.dev/bazaar/',
 
61
        }
 
62
    DEFAULT_SERVICE_URL = LAUNCHPAD_INSTANCE['edge']
44
63
 
45
64
    transport = None
46
65
    registrant_email = None
47
66
    registrant_password = None
48
67
 
49
68
 
50
 
    def __init__(self, transport=None):
 
69
    def __init__(self, transport=None, lp_instance=None):
51
70
        """Construct a new service talking to the launchpad rpc server"""
 
71
        self._lp_instance = lp_instance
52
72
        if transport is None:
53
73
            uri_type = urllib.splittype(self.service_url)[0]
54
74
            if uri_type == 'https':
69
89
        key = 'BZR_LP_XMLRPC_URL'
70
90
        if key in os.environ:
71
91
            return os.environ[key]
 
92
        elif self._lp_instance is not None:
 
93
            try:
 
94
                return self.LAUNCHPAD_INSTANCE[self._lp_instance]
 
95
            except KeyError:
 
96
                raise InvalidLaunchpadInstance(self._lp_instance)
72
97
        else:
73
98
            return self.DEFAULT_SERVICE_URL
74
99
 
75
 
    def get_proxy(self):
 
100
    def get_proxy(self, authenticated):
76
101
        """Return the proxy for XMLRPC requests."""
77
 
        # auth info must be in url
78
 
        # TODO: if there's no registrant email perhaps we should just connect
79
 
        # anonymously?
80
 
        scheme, hostinfo, path = urlsplit(self.service_url)[:3]
81
 
        assert '@' not in hostinfo
82
 
        assert self.registrant_email is not None
83
 
        assert self.registrant_password is not None
84
 
        # TODO: perhaps fully quote the password to make it very slightly
85
 
        # obscured
86
 
        # TODO: can we perhaps add extra Authorization headers directly to the 
87
 
        # request, rather than putting this into the url?  perhaps a bit more 
88
 
        # secure against accidentally revealing it.  std66 s3.2.1 discourages putting
89
 
        # the password in the url.
90
 
        hostinfo = '%s:%s@%s' % (urllib.quote(self.registrant_email),
91
 
                                 urllib.quote(self.registrant_password),
92
 
                                 hostinfo)
93
 
        url = urlunsplit((scheme, hostinfo, path, '', ''))
 
102
        if authenticated:
 
103
            # auth info must be in url
 
104
            # TODO: if there's no registrant email perhaps we should
 
105
            # just connect anonymously?
 
106
            scheme, hostinfo, path = urlsplit(self.service_url)[:3]
 
107
            if '@' in hostinfo:
 
108
                raise AssertionError(hostinfo)
 
109
            if self.registrant_email is None:
 
110
                raise AssertionError()
 
111
            if self.registrant_password is None:
 
112
                raise AssertionError()
 
113
            # TODO: perhaps fully quote the password to make it very slightly
 
114
            # obscured
 
115
            # TODO: can we perhaps add extra Authorization headers
 
116
            # directly to the request, rather than putting this into
 
117
            # the url?  perhaps a bit more secure against accidentally
 
118
            # revealing it.  std66 s3.2.1 discourages putting the
 
119
            # password in the url.
 
120
            hostinfo = '%s:%s@%s' % (urllib.quote(self.registrant_email),
 
121
                                     urllib.quote(self.registrant_password),
 
122
                                     hostinfo)
 
123
            url = urlunsplit((scheme, hostinfo, path, '', ''))
 
124
        else:
 
125
            url = self.service_url
94
126
        return xmlrpclib.ServerProxy(url, transport=self.transport)
95
127
 
96
128
    def gather_user_credentials(self):
97
129
        """Get the password from the user."""
98
 
        config = config.GlobalConfig()
99
 
        self.registrant_email = config.user_email()
 
130
        the_config = config.GlobalConfig()
 
131
        self.registrant_email = the_config.user_email()
100
132
        if self.registrant_password is None:
101
133
            auth = config.AuthenticationConfig()
102
134
            scheme, hostinfo = urlsplit(self.service_url)[:2]
105
137
            # We will reuse http[s] credentials if we can, prompt user
106
138
            # otherwise
107
139
            self.registrant_password = auth.get_password(scheme, hostinfo,
 
140
                                                         self.registrant_email,
108
141
                                                         prompt=prompt)
109
142
 
110
 
    def send_request(self, method_name, method_params):
111
 
        proxy = self.get_proxy()
112
 
        assert method_name
 
143
    def send_request(self, method_name, method_params, authenticated):
 
144
        proxy = self.get_proxy(authenticated)
113
145
        method = getattr(proxy, method_name)
114
146
        try:
115
147
            result = method(*method_params)
134
166
 
135
167
    # Set this to the XMLRPC method name.
136
168
    _methodname = None
 
169
    _authenticated = True
137
170
 
138
171
    def _request_params(self):
139
172
        """Return the arguments to pass to the method"""
145
178
        :param service: LaunchpadService indicating where to send
146
179
            the request and the authentication credentials.
147
180
        """
148
 
        return service.send_request(self._methodname, self._request_params())
 
181
        return service.send_request(self._methodname, self._request_params(),
 
182
                                    self._authenticated)
149
183
 
150
184
 
151
185
class DryRunLaunchpadService(LaunchpadService):
154
188
    The dummy service does not need authentication.
155
189
    """
156
190
 
157
 
    def send_request(self, method_name, method_params):
 
191
    def send_request(self, method_name, method_params, authenticated):
158
192
        pass
159
193
 
160
194
    def gather_user_credentials(self):
173
207
                 author_email='',
174
208
                 product_name='',
175
209
                 ):
176
 
        assert branch_url
 
210
        if not branch_url:
 
211
            raise errors.InvalidURL(branch_url, "You need to specify a non-empty branch URL.")
177
212
        self.branch_url = branch_url
178
213
        if branch_name:
179
214
            self.branch_name = branch_name
207
242
    _methodname = 'link_branch_to_bug'
208
243
 
209
244
    def __init__(self, branch_url, bug_id):
210
 
        assert branch_url
211
245
        self.bug_id = bug_id
212
246
        self.branch_url = branch_url
213
247
 
216
250
        # This must match the parameter tuple expected by Launchpad for this
217
251
        # method
218
252
        return (self.branch_url, self.bug_id, '')
 
253
 
 
254
 
 
255
class ResolveLaunchpadPathRequest(BaseRequest):
 
256
    """Request to resolve the path component of an lp: URL."""
 
257
 
 
258
    _methodname = 'resolve_lp_path'
 
259
    _authenticated = False
 
260
 
 
261
    def __init__(self, path):
 
262
        if not path:
 
263
            raise errors.InvalidURL(path=path,
 
264
                                    extra="You must specify a product.")
 
265
        self.path = path
 
266
 
 
267
    def _request_params(self):
 
268
        """Return xmlrpc request parameters"""
 
269
        return (self.path,)