summaryrefslogtreecommitdiff
path: root/wsgitools/middlewares.py
blob: 09d4cfe57b4a98570cce11e43045eb13739b448c (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
__all__ = []

import time
import sys
import cgitb
import binascii
from wsgitools.filters import CloseableList, CloseableIterator
# Cannot use io module as it is broken in 2.6.
# Writing a str to a io.StringIO results in an exception.
try:
    import cStringIO as io
except ImportError:
    import StringIO as io
try:
    next
except NameError:
    def next(it):
        return it.next()

__all__.append("SubdirMiddleware")
class SubdirMiddleware:
    """Middleware choosing wsgi applications based on a dict."""
    def __init__(self, default, mapping={}):
        """
        @type default: wsgi app
        @type mapping: {str: wsgi app}
        """
        self.default = default
        self.mapping = mapping
    def __call__(self, environ, start_response):
        """wsgi interface
        @type environ: {str: str}
        @rtype: gen([str])
        """
        assert isinstance(environ, dict)
        app = None
        script = environ["PATH_INFO"]
        path_info = ""
        while '/' in script:
            if script in self.mapping:
                app = self.mapping[script]
                break
            script, tail = script.rsplit('/', 1)
            path_info = "/%s%s" % (tail, path_info)
        if app is None:
            app = self.mapping.get(script, None)
            if app is None:
                app = self.default
        environ["SCRIPT_NAME"] += script
        environ["PATH_INFO"] = path_info
        return app(environ, start_response)

__all__.append("NoWriteCallableMiddleware")
class NoWriteCallableMiddleware:
    """This middleware wraps a wsgi application that needs the return value of
    C{start_response} function to a wsgi application that doesn't need one by
    writing the data to a C{StringIO} and then making it be the first result
    element."""
    def __init__(self, app):
        """Wraps wsgi application app."""
        self.app = app
    def __call__(self, environ, start_response):
        """wsgi interface
        @type environ: {str, str}
        @rtype: gen([str])
        """
        assert isinstance(environ, dict)
        todo = []
        def modified_start_response(status, headers, exc_info=None):
            assert isinstance(status, str)
            assert isinstance(headers, list)
            if exc_info is not None:
                todo.append(None)
                return start_response(status, headers, exc_info)
            else:
                sio = io.StringIO()
                todo.append((status, headers, sio))
                return sio.write

        ret = self.app(environ, modified_start_response)
        assert hasattr(ret, "__iter__")
        assert len(todo) == 1

        if todo[0] is None:
            return ret

        status, headers, data = todo[0]
        data = data.getvalue()

        if not data:
            start_response(status, headers)
            return ret

        if isinstance(ret, list):
            ret.insert(0, data)
            start_response(status, headers)
            return ret

        ret = iter(ret)
        stopped = False
        try:
            first = next(ret)
        except StopIteration:
            stopped = True

        start_response(status, headers)

        if stopped:
            return CloseableList(getattr(ret, "close", None), (data,))

        return CloseableIterator(getattr(ret, "close", None),
                                 (data, first), ret)

__all__.append("ContentLengthMiddleware")
class ContentLengthMiddleware:
    """Guesses the content length header if possible.
    @note: The application used must not use the C{write} callable returned by
           C{start_response}."""
    def __init__(self, app, maxstore=0):
        """Wraps wsgi application app. It can also store the first result bytes
        to possibly return a list of strings which will make guessing the size
        of iterators possible. At most maxstore bytes will be accumulated.
        Please note that a value larger than 0 will violate the wsgi standard.
        The magical value C{()} will make it always gather all data.
        @type maxstore: int or ()
        """
        self.app = app
        self.maxstore = maxstore
    def __call__(self, environ, start_response):
        """wsgi interface"""
        assert isinstance(environ, dict)
        todo = []
        def modified_start_response(status, headers, exc_info=None):
            assert isinstance(status, str)
            assert isinstance(headers, list)
            if (exc_info is not None or
                 [v for h, v in headers if h.lower() == "content-length"]):
                todo[:] = (None,)
                return start_response(status, headers, exc_info)
            else:
                todo[:] = ((status, headers),)
                def raise_not_imp(*args):
                    raise NotImplementedError
                return raise_not_imp

        ret = self.app(environ, modified_start_response)
        assert hasattr(ret, "__iter__")

        if todo and todo[0] is None: # nothing to do
            #print "content-length: nothing"
            return ret

        if isinstance(ret, list):
            #print "content-length: simple"
            status, headers = todo[0]
            length = sum(map(len, ret))
            headers.append(("Content-length", str(length)))
            start_response(status, headers)
            return ret

        ret = iter(ret)
        stopped = False
        data = CloseableList(getattr(ret, "close", None))
        length = 0
        try:
            data.append(next(ret)) # fills todo
            length += len(data[-1])
        except StopIteration:
            stopped = True

        status, headers = todo[0]

        while (not stopped) and length < self.maxstore:
            try:
                data.append(next(ret))
                length += len(data[-1])
            except StopIteration:
                stopped = True

        if stopped:
            #print "content-length: gathered"
            headers.append(("Content-length", str(length)))
            start_response(status, headers)
            return data

        #print "content-length: passthrough"
        start_response(status, headers)

        return CloseableIterator(getattr(ret, "close", None), data, ret)

def storable(environ):
    if environ["REQUEST_METHOD"] != "GET":
        return False
    return True

def cacheable(environ):
    if environ.get("HTTP_CACHE_CONTROL", "") == "max-age=0":
        return False
    return True

__all__.append("CachingMiddleware")
class CachingMiddleware:
    """Caches reponses to requests based on C{SCRIPT_NAME}, C{PATH_INFO} and
    C{QUERY_STRING}."""
    def __init__(self, app, maxage=60, storable=storable, cacheable=cacheable):
        """
        @param app: is a wsgi application to be cached.
        @type maxage: int
        @param maxage: is the number of seconds a reponse may be cached.
        @param storable: is a predicate that determines whether the response
                may be cached at all based on the C{environ} dict.
        @param cacheable: is a predicate that determines whether this request
                invalidates the cache."""
        self.app = app
        self.maxage = maxage
        self.storable = storable
        self.cacheable = cacheable
        self.cache = {}
    def __call__(self, environ, start_response):
        """wsgi interface
        @type environ: {str: str}
        """
        assert isinstance(environ, dict)
        if not self.storable(environ):
            return self.app(environ, start_response)
        path = environ.get("SCRIPT_NAME", "/")
        path += environ.get("PATH_INFO", '')
        path += "?" + environ.get("QUERY_STRING", "")
        if self.cacheable(environ) and path in self.cache:
            if self.cache[path][0] + self.maxage >= time.time():
                start_response(self.cache[path][1], self.cache[path][2])
                return self.cache[path][3]
            else:
                del self.cache[path]
        cache_object = [time.time(), "", [], []]
        def modified_start_respesponse(status, headers, exc_info=None):
            assert isinstance(status, str)
            assert isinstance(headers, list)
            if exc_info is not None:
                return self.app(status, headers, exc_info)
            cache_object[1] = status
            cache_object[2] = headers
            write = start_response(status, headers)
            def modified_write(data):
                cache_object[3].append(data)
                write(data)
            return modified_write

        ret = self.app(environ, modified_start_respesponse)
        assert hasattr(ret, "__iter__")

        if isinstance(ret, list):
            cache_object[3].extend(ret)
            self.cache[path] = cache_object
            return ret
        def pass_through():
            for data in ret:
                cache_object[3].append(data)
                yield data
            self.cache[path] = cache_object
        return CloseableIterator(getattr(ret, "close", None), pass_through())

__all__.append("DictAuthChecker")
class DictAuthChecker:
    """Verifies usernames and passwords by looking them up in a dict."""
    def __init__(self, users):
        """
        @type users: {str: str}
        @param users: is a dict mapping usernames to password."""
        self.users = users
    def __call__(self, username, password):
        """check_function interface taking username and password and resulting
        in a bool.
        @type username: str
        @type password: str
        @rtype: bool
        """
        return username in self.users and self.users[username] == password

__all__.append("BasicAuthMiddleware")
class BasicAuthMiddleware:
    """Middleware implementing HTTP Basic Auth."""
    def __init__(self, app, check_function, realm='www', app401=None):
        """
        @param app: is a WSGI application.
        @param check_function: is a function taking three arguments username,
                password and environment returning a bool indicating whether the
                request may is allowed. The older interface of taking only the
                first two arguments is still supported via catching a
                C{TypeError}.
        @type realm: str
        @param app401: is an optional WSGI application to be used for error
                messages
        """
        self.app = app
        self.check_function = check_function
        self.realm = realm
        self.app401 = app401

    def __call__(self, environ, start_response):
        """wsgi interface
        @type environ: {str: str}
        """
        assert isinstance(environ, dict)
        auth = environ.get("HTTP_AUTHORIZATION")
        if not auth or ' ' not in auth:
            return self.authorization_required(environ, start_response)
        auth_type, enc_auth_info = auth.split(None, 1)
        try:
            auth_info = enc_auth_info.decode("base64")
        except binascii.Error:
            return self.authorization_required(environ, start_response)
        if auth_type.lower() != "basic" or ':' not in auth_info:
            return self.authorization_required(environ, start_response)
        username, password = auth_info.split(':', 1)
        try:
            result = self.check_function(username, password, environ)
        except TypeError: # catch old interface
            result = self.check_function(username, password)
        if result:
            environ["REMOTE_USER"] = username
            return self.app(environ, start_response)
        return self.authorization_required(environ, start_response)

    def authorization_required(self, environ, start_response):
        """wsgi application for indicating authorization is required.
        @type environ: {str: str}
        """
        if self.app401 is None:
            status = "401 Authorization required"
            html = "<html><head><title>Authorization required</title></head>" \
                    "<body><h1>Authorization required</h1></body></html>\n"
            headers = [('Content-type', 'text/html'),
                       ('WWW-Authenticate', 'Basic realm="%s"' % self.realm),
                       ("Content-length", str(len(html)))]
            start_response(status, headers)
            if environ["REQUEST_METHOD"].upper() == "HEAD":
                return []
            return [html]
        return self.app401(environ, start_response)

__all__.append("TracebackMiddleware")
class TracebackMiddleware:
    """In case the application throws an exception this middleware will show an
    html-formatted traceback using C{cgitb}."""
    def __init__(self, app):
        """app is the wsgi application to proxy."""
        self.app = app
    def __call__(self, environ, start_response):
        """wsgi interface
        @type environ: {str: str}
        """
        try:
            assert isinstance(environ, dict)
            ret = self.app(environ, start_response)
            assert hasattr(ret, "__iter__")

            if isinstance(ret, list):
                return ret
            # Take the first element of the iterator and possibly catch an
            # exception there.
            ret = iter(ret)
            try:
                first = next(ret)
            except StopIteration:
                return CloseableList(getattr(ret, "close", None), [])
            return CloseableIterator(getattr(ret, "close", None), [first], ret)
        except:
            exc_info = sys.exc_info()
            data = cgitb.html(exc_info)
            start_response("200 OK", [("Content-type", "text/html"),
                                      ("Content-length", str(len(data)))])
            if environ["REQUEST_METHOD"].upper() == "HEAD":
                return []
            return [data]