← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/transport/http/wsgi.py

  • Committer: John Arbash Meinel
  • Date: 2013-05-19 14:29:37 UTC
  • mfrom: (6437.63.9 2.5)
  • mto: (6437.63.10 2.5)
  • mto: This revision was merged to the branch mainline in revision 6575.
  • Revision ID: john@arbash-meinel.com-20130519142937-21ykz2n2y2f22za9
Merge in the actual 2.5 branch. It seems I failed before

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/transport/http/wsgi.py
1
 
# Copyright (C) 2006 Canonical Ltd
 
1
# Copyright (C) 2006-2010 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., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 
15
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
16
16
 
17
17
"""WSGI application for bzr HTTP smart server.
18
18
 
20
20
    http://www.python.org/dev/peps/pep-0333/
21
21
"""
22
22
 
 
23
from __future__ import absolute_import
 
24
 
23
25
from cStringIO import StringIO
24
26
 
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
27
 
    
28
 
 
29
 
def make_app(root, prefix, path_var, readonly=True):
 
30
 
 
31
 
 
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.
31
 
    
 
35
 
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)
39
43
    else:
40
44
        base_transport = get_transport(local_url)
41
 
    app = SmartWSGIApp(base_transport)
42
 
    app = RelpathSetter(app, prefix, path_var)
 
45
    if load_plugins:
 
46
        from bzrlib.plugin import load_plugins
 
47
        load_plugins()
 
48
    if enable_logging:
 
49
        import bzrlib.trace
 
50
        bzrlib.trace.enable_default_logging()
 
51
    app = SmartWSGIApp(base_transport, prefix)
 
52
    app = RelpathSetter(app, '', path_var)
43
53
    return app
44
54
 
45
55
 
46
56
class RelpathSetter(object):
47
57
    """WSGI middleware to set 'bzrlib.relpath' in the environ.
48
 
    
 
58
 
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".
59
69
    """
60
 
    
 
70
 
61
71
    def __init__(self, app, prefix='', path_var='REQUEST_URI'):
62
72
        """Constructor.
63
73
 
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', [])
79
89
            return []
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."""
86
96
 
87
 
    def __init__(self, backing_transport):
 
97
    def __init__(self, backing_transport, root_client_path='/'):
88
98
        """Constructor.
89
99
 
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
 
104
            the client.
92
105
        """
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
96
109
        # something.
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()
106
120
 
107
121
    def __call__(self, environ, start_response):
108
122
        """WSGI application callable."""
111
125
            return []
112
126
 
113
127
        relpath = environ['bzrlib.relpath']
114
 
        transport = self.backing_transport.clone(relpath)
 
128
 
 
129
        if not relpath.startswith('/'):
 
130
            relpath = '/' + relpath
 
131
        if not relpath.endswith('/'):
 
132
            relpath += '/'
 
133
 
 
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
 
136
        # request.
 
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.
 
142
            adjusted_rcp = None
 
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
 
147
            # relpath to '.'.
 
148
            adjusted_rcp = '/' + self.root_client_path[len(relpath):]
 
149
            adjusted_relpath = '.'
 
150
        else:
 
151
            adjusted_rcp = self.root_client_path
 
152
            adjusted_relpath = relpath
 
153
 
 
154
        if adjusted_relpath.startswith('/'):
 
155
            adjusted_relpath = adjusted_relpath[1:]
 
156
        if adjusted_relpath.startswith('/'):
 
157
            raise AssertionError(adjusted_relpath)
 
158
 
 
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]
132
177
 
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(
 
180
            request_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