1
# Copyright (C) 2006 Canonical Ltd
1
# Copyright (C) 2006-2010 Canonical Ltd
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
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., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
15
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
17
17
"""WSGI application for bzr HTTP smart server.
20
20
http://www.python.org/dev/peps/pep-0333/
23
from __future__ import absolute_import
23
25
from cStringIO import StringIO
25
from bzrlib.transport import chroot, get_transport, remote
27
from bzrlib.smart import medium
28
from bzrlib.transport import chroot, get_transport
26
29
from bzrlib.urlutils import local_path_to_url
29
def make_app(root, prefix, path_var, readonly=True):
32
def make_app(root, prefix, path_var='REQUEST_URI', readonly=True,
33
load_plugins=True, enable_logging=True):
30
34
"""Convenience function to construct a WSGI bzr smart server.
32
36
:param root: a local path that requests will be relative to.
33
37
:param prefix: See RelpathSetter.
34
38
:param path_var: See RelpathSetter.
38
42
base_transport = get_transport('readonly+' + local_url)
40
44
base_transport = get_transport(local_url)
41
app = SmartWSGIApp(base_transport)
42
app = RelpathSetter(app, prefix, path_var)
46
from bzrlib.plugin import load_plugins
50
bzrlib.trace.enable_default_logging()
51
app = SmartWSGIApp(base_transport, prefix)
52
app = RelpathSetter(app, '', path_var)
46
56
class RelpathSetter(object):
47
57
"""WSGI middleware to set 'bzrlib.relpath' in the environ.
49
59
Different servers can invoke a SmartWSGIApp in different ways. This
50
60
middleware allows an adminstrator to configure how to the SmartWSGIApp will
51
61
determine what path it should be serving for a given request for many common
57
67
prefix="/some/prefix/" and path_var="REQUEST_URI" will set that request's
58
68
'bzrlib.relpath' variable to "repo/branch".
61
71
def __init__(self, app, prefix='', path_var='REQUEST_URI'):
75
85
path = environ[self.path_var]
76
86
suffix = '/.bzr/smart'
77
87
if not (path.startswith(self.prefix) and path.endswith(suffix)):
78
start_response('404 Not Found', {})
88
start_response('404 Not Found', [])
80
90
environ['bzrlib.relpath'] = path[len(self.prefix):-len(suffix)]
81
91
return self.app(environ, start_response)
84
94
class SmartWSGIApp(object):
85
95
"""A WSGI application for the bzr smart server."""
87
def __init__(self, backing_transport):
97
def __init__(self, backing_transport, root_client_path='/'):
90
100
:param backing_transport: a transport. Requests will be processed
91
101
relative to this transport.
102
:param root_client_path: the client path that maps to the root of
103
backing_transport. This is used to interpret relpaths received from
93
# Use a ChrootTransportDecorator so that this web application won't
106
# Use a ChrootServer so that this web application won't
94
107
# accidentally let people access locations they shouldn't.
95
108
# e.g. consider a smart server request for "get /etc/passwd" or
97
110
self.chroot_server = chroot.ChrootServer(backing_transport)
98
self.chroot_server.setUp()
111
self.chroot_server.start_server()
99
112
self.backing_transport = get_transport(self.chroot_server.get_url())
113
self.root_client_path = root_client_path
100
114
# While the chroot server can technically be torn down at this point,
101
# as all it does is remove the scheme registration from transport's
102
# protocol dictionary, we don't *just in case* there are parts of
115
# as all it does is remove the scheme registration from transport's
116
# protocol dictionary, we don't *just in case* there are parts of
103
117
# bzrlib that will invoke 'get_transport' on urls rather than cloning
104
118
# around the existing transport.
105
#self.chroot_server.tearDown()
119
#self.chroot_server.stop_server()
107
121
def __call__(self, environ, start_response):
108
122
"""WSGI application callable."""
113
127
relpath = environ['bzrlib.relpath']
114
transport = self.backing_transport.clone(relpath)
129
if not relpath.startswith('/'):
130
relpath = '/' + relpath
131
if not relpath.endswith('/'):
134
# Compare the HTTP path (relpath) and root_client_path, and calculate
135
# new relpath and root_client_path accordingly, to be used to build the
137
if relpath.startswith(self.root_client_path):
138
# The relpath traverses all of the mandatory root client path.
139
# Remove the root_client_path from the relpath, and set
140
# adjusted_tcp to None to tell the request handler that no further
141
# path translation is required.
143
adjusted_relpath = relpath[len(self.root_client_path):]
144
elif self.root_client_path.startswith(relpath):
145
# The relpath traverses some of the mandatory root client path.
146
# Subtract the relpath from the root_client_path, and set the
148
adjusted_rcp = '/' + self.root_client_path[len(relpath):]
149
adjusted_relpath = '.'
151
adjusted_rcp = self.root_client_path
152
adjusted_relpath = relpath
154
if adjusted_relpath.startswith('/'):
155
adjusted_relpath = adjusted_relpath[1:]
156
if adjusted_relpath.startswith('/'):
157
raise AssertionError(adjusted_relpath)
159
transport = self.backing_transport.clone(adjusted_relpath)
115
160
out_buffer = StringIO()
116
smart_protocol_request = self.make_request(transport, out_buffer.write)
117
161
request_data_length = int(environ['CONTENT_LENGTH'])
118
162
request_data_bytes = environ['wsgi.input'].read(request_data_length)
119
smart_protocol_request.accept_bytes(request_data_bytes)
163
smart_protocol_request = self.make_request(
164
transport, out_buffer.write, request_data_bytes, adjusted_rcp)
120
165
if smart_protocol_request.next_read_size() != 0:
121
166
# The request appears to be incomplete, or perhaps it's just a
122
167
# newer version we don't understand. Regardless, all we can do
130
175
start_response('200 OK', headers)
131
176
return [response_data]
133
def make_request(self, transport, write_func):
134
return protocol.SmartServerRequestProtocolOne(transport, write_func)
178
def make_request(self, transport, write_func, request_bytes, rcp):
179
protocol_factory, unused_bytes = medium._get_protocol_factory_for_bytes(
181
server_protocol = protocol_factory(
182
transport, write_func, rcp, self.backing_transport)
183
server_protocol.accept_bytes(unused_bytes)
184
return server_protocol