Merge pull request #74 from cleverdevil/next
Removes the need for paste.recursive
This commit is contained in:
cleverdevil
@@ -1,5 +1,4 @@
|
||||
from paste.errordocument import make_errordocument
|
||||
from paste.recursive import RecursiveMiddleware
|
||||
from paste.translogger import TransLogger
|
||||
from weberror.errormiddleware import ErrorMiddleware
|
||||
from weberror.evalexception import EvalException
|
||||
@@ -8,6 +7,7 @@ from core import (
|
||||
abort, override_template, Pecan, load_app, redirect, render,
|
||||
request, response
|
||||
)
|
||||
from recursive import RecursiveMiddleware
|
||||
from decorators import expose
|
||||
from hooks import RequestViewerHook
|
||||
from templating import error_formatters
|
||||
@@ -16,8 +16,6 @@ from static import SharedDataMiddleware
|
||||
from configuration import set_config
|
||||
from configuration import _runtime_conf as conf
|
||||
|
||||
import os
|
||||
|
||||
|
||||
__all__ = [
|
||||
'make_app', 'load_app', 'Pecan', 'request', 'response',
|
||||
|
||||
@@ -7,7 +7,7 @@ from webob import Request, Response, exc
|
||||
from threading import local
|
||||
from itertools import chain
|
||||
from mimetypes import guess_type, add_type
|
||||
from paste.recursive import ForwardRequestException
|
||||
from pecan.recursive import ForwardRequestException
|
||||
from urlparse import urlsplit, urlunsplit
|
||||
from os.path import splitext
|
||||
|
||||
|
||||
181
pecan/recursive.py
Normal file
181
pecan/recursive.py
Normal file
@@ -0,0 +1,181 @@
|
||||
# (c) 2005 Ian Bicking and contributors; written for Paste
|
||||
# Licensed under the MIT license:
|
||||
# http://www.opensource.org/licenses/mit-license.php
|
||||
|
||||
"""
|
||||
Middleware to make internal requests and forward requests internally.
|
||||
|
||||
Raise ``ForwardRequestException(new_path_info)`` to do a forward
|
||||
(aborting the current request).
|
||||
"""
|
||||
|
||||
__all__ = ['RecursiveMiddleware']
|
||||
|
||||
|
||||
class RecursionLoop(AssertionError):
|
||||
# Subclasses AssertionError for legacy reasons
|
||||
"""Raised when a recursion enters into a loop"""
|
||||
|
||||
|
||||
class CheckForRecursionMiddleware(object):
|
||||
def __init__(self, app, env):
|
||||
self.app = app
|
||||
self.env = env
|
||||
|
||||
def __call__(self, environ, start_response):
|
||||
path_info = environ.get('PATH_INFO', '')
|
||||
if path_info in self.env.get(
|
||||
'pecan.recursive.old_path_info', []):
|
||||
raise RecursionLoop(
|
||||
"Forwarding loop detected; %r visited twice (internal "
|
||||
"redirect path: %s)"
|
||||
% (path_info, self.env['pecan.recursive.old_path_info']))
|
||||
old_path_info = self.env.setdefault(
|
||||
'pecan.recursive.old_path_info', []
|
||||
)
|
||||
old_path_info.append(self.env.get('PATH_INFO', ''))
|
||||
return self.app(environ, start_response)
|
||||
|
||||
|
||||
class RecursiveMiddleware(object):
|
||||
|
||||
"""
|
||||
A WSGI middleware that allows for recursive and forwarded calls.
|
||||
All these calls go to the same 'application', but presumably that
|
||||
application acts differently with different URLs. The forwarded
|
||||
URLs must be relative to this container.
|
||||
"""
|
||||
|
||||
def __init__(self, application, global_conf=None):
|
||||
self.application = application
|
||||
|
||||
def __call__(self, environ, start_response):
|
||||
my_script_name = environ.get('SCRIPT_NAME', '')
|
||||
environ['pecan.recursive.script_name'] = my_script_name
|
||||
try:
|
||||
return self.application(environ, start_response)
|
||||
except ForwardRequestException, e:
|
||||
middleware = CheckForRecursionMiddleware(
|
||||
e.factory(self), environ)
|
||||
return middleware(environ, start_response)
|
||||
|
||||
|
||||
class ForwardRequestException(Exception):
|
||||
"""
|
||||
Used to signal that a request should be forwarded to a different location.
|
||||
|
||||
``url``
|
||||
The URL to forward to starting with a ``/`` and relative to
|
||||
``RecursiveMiddleware``. URL fragments can also contain query strings
|
||||
so ``/error?code=404`` would be a valid URL fragment.
|
||||
|
||||
``environ``
|
||||
An altertative WSGI environment dictionary to use for the forwarded
|
||||
request. If specified is used *instead* of the ``url_fragment``
|
||||
|
||||
``factory``
|
||||
If specifed ``factory`` is used instead of ``url`` or ``environ``.
|
||||
``factory`` is a callable that takes a WSGI application object
|
||||
as the first argument and returns an initialised WSGI middleware
|
||||
which can alter the forwarded response.
|
||||
|
||||
Basic usage (must have ``RecursiveMiddleware`` present) :
|
||||
|
||||
.. code-block:: python
|
||||
|
||||
from pecan.recursive import ForwardRequestException
|
||||
def app(environ, start_response):
|
||||
if environ['PATH_INFO'] == '/hello':
|
||||
start_response("200 OK", [('Content-type', 'text/plain')])
|
||||
return ['Hello World!']
|
||||
elif environ['PATH_INFO'] == '/error':
|
||||
start_response("404 Not Found",
|
||||
[('Content-type', 'text/plain')]
|
||||
)
|
||||
return ['Page not found']
|
||||
else:
|
||||
raise ForwardRequestException('/error')
|
||||
|
||||
from pecan.recursive import RecursiveMiddleware
|
||||
app = RecursiveMiddleware(app)
|
||||
|
||||
If you ran this application and visited ``/hello`` you would get a
|
||||
``Hello World!`` message. If you ran the application and visited
|
||||
``/not_found`` a ``ForwardRequestException`` would be raised and the caught
|
||||
by the ``RecursiveMiddleware``. The ``RecursiveMiddleware`` would then
|
||||
return the headers and response from the ``/error`` URL but would display
|
||||
a ``404 Not found`` status message.
|
||||
|
||||
You could also specify an ``environ`` dictionary instead of a url. Using
|
||||
the same example as before:
|
||||
|
||||
.. code-block:: python
|
||||
|
||||
def app(environ, start_response):
|
||||
... same as previous example ...
|
||||
else:
|
||||
new_environ = environ.copy()
|
||||
new_environ['PATH_INFO'] = '/error'
|
||||
raise ForwardRequestException(environ=new_environ)
|
||||
"""
|
||||
|
||||
def __init__(self, url=None, environ={}, factory=None, path_info=None):
|
||||
# Check no incompatible options have been chosen
|
||||
if factory and url:
|
||||
raise TypeError( # pragma: no cover
|
||||
'You cannot specify factory and a url in '
|
||||
'ForwardRequestException')
|
||||
elif factory and environ:
|
||||
raise TypeError( # pragma: no cover
|
||||
'You cannot specify factory and environ in '
|
||||
'ForwardRequestException')
|
||||
if url and environ:
|
||||
raise TypeError( # pragma: no cover
|
||||
'You cannot specify environ and url in '
|
||||
'ForwardRequestException')
|
||||
|
||||
# set the path_info or warn about its use.
|
||||
if path_info:
|
||||
self.path_info = path_info
|
||||
|
||||
# If the url can be treated as a path_info do that
|
||||
if url and not '?' in str(url):
|
||||
self.path_info = url
|
||||
|
||||
# Base middleware
|
||||
class ForwardRequestExceptionMiddleware(object):
|
||||
def __init__(self, app):
|
||||
self.app = app
|
||||
|
||||
# Otherwise construct the appropriate middleware factory
|
||||
if hasattr(self, 'path_info'):
|
||||
p = self.path_info
|
||||
|
||||
def factory_pi(app):
|
||||
class PathInfoForward(ForwardRequestExceptionMiddleware):
|
||||
def __call__(self, environ, start_response):
|
||||
environ['PATH_INFO'] = p
|
||||
return self.app(environ, start_response)
|
||||
return PathInfoForward(app)
|
||||
|
||||
self.factory = factory_pi
|
||||
elif url:
|
||||
def factory_url(app):
|
||||
class URLForward(ForwardRequestExceptionMiddleware):
|
||||
def __call__(self, environ, start_response):
|
||||
environ['PATH_INFO'] = url.split('?')[0]
|
||||
environ['QUERY_STRING'] = url.split('?')[1]
|
||||
return self.app(environ, start_response)
|
||||
return URLForward(app)
|
||||
|
||||
self.factory = factory_url
|
||||
elif environ:
|
||||
def factory_env(app):
|
||||
class EnvironForward(ForwardRequestExceptionMiddleware):
|
||||
def __call__(self, environ_, start_response):
|
||||
return self.app(environ, start_response)
|
||||
return EnvironForward(app)
|
||||
|
||||
self.factory = factory_env
|
||||
else:
|
||||
self.factory = factory
|
||||
128
pecan/tests/test_recursive.py
Normal file
128
pecan/tests/test_recursive.py
Normal file
@@ -0,0 +1,128 @@
|
||||
from unittest import TestCase
|
||||
from webtest import TestApp
|
||||
|
||||
from pecan.recursive import RecursiveMiddleware, ForwardRequestException
|
||||
|
||||
|
||||
def simple_app(environ, start_response):
|
||||
start_response("200 OK", [('Content-type', 'text/plain')])
|
||||
return ['requested page returned']
|
||||
|
||||
|
||||
def error_docs_app(environ, start_response):
|
||||
if environ['PATH_INFO'] == '/not_found':
|
||||
start_response("404 Not found", [('Content-type', 'text/plain')])
|
||||
return ['Not found']
|
||||
elif environ['PATH_INFO'] == '/error':
|
||||
start_response("200 OK", [('Content-type', 'text/plain')])
|
||||
return ['Page not found']
|
||||
elif environ['PATH_INFO'] == '/recurse':
|
||||
raise ForwardRequestException('/recurse')
|
||||
else:
|
||||
return simple_app(environ, start_response)
|
||||
|
||||
|
||||
class Middleware(object):
|
||||
def __init__(self, app, url='/error'):
|
||||
self.app = app
|
||||
self.url = url
|
||||
|
||||
def __call__(self, environ, start_response):
|
||||
raise ForwardRequestException(self.url)
|
||||
|
||||
|
||||
def forward(app):
|
||||
app = TestApp(RecursiveMiddleware(app))
|
||||
res = app.get('')
|
||||
|
||||
assert res.headers['content-type'] == 'text/plain'
|
||||
assert res.status == '200 OK'
|
||||
assert 'requested page returned' in res
|
||||
res = app.get('/error')
|
||||
assert res.headers['content-type'] == 'text/plain'
|
||||
assert res.status == '200 OK'
|
||||
assert 'Page not found' in res
|
||||
res = app.get('/not_found')
|
||||
assert res.headers['content-type'] == 'text/plain'
|
||||
assert res.status == '200 OK'
|
||||
assert 'Page not found' in res
|
||||
try:
|
||||
res = app.get('/recurse')
|
||||
except AssertionError, e:
|
||||
if str(e).startswith('Forwarding loop detected'):
|
||||
pass
|
||||
else:
|
||||
raise AssertionError('Failed to detect forwarding loop')
|
||||
|
||||
|
||||
class TestRecursiveMiddleware(TestCase):
|
||||
|
||||
def test_ForwardRequest_url(self):
|
||||
class TestForwardRequestMiddleware(Middleware):
|
||||
def __call__(self, environ, start_response):
|
||||
if environ['PATH_INFO'] != '/not_found':
|
||||
return self.app(environ, start_response)
|
||||
raise ForwardRequestException(self.url)
|
||||
forward(TestForwardRequestMiddleware(error_docs_app))
|
||||
|
||||
def test_ForwardRequest_url_with_params(self):
|
||||
class TestForwardRequestMiddleware(Middleware):
|
||||
def __call__(self, environ, start_response):
|
||||
if environ['PATH_INFO'] != '/not_found':
|
||||
return self.app(environ, start_response)
|
||||
raise ForwardRequestException(self.url + '?q=1')
|
||||
forward(TestForwardRequestMiddleware(error_docs_app))
|
||||
|
||||
def test_ForwardRequest_environ(self):
|
||||
class TestForwardRequestMiddleware(Middleware):
|
||||
def __call__(self, environ, start_response):
|
||||
if environ['PATH_INFO'] != '/not_found':
|
||||
return self.app(environ, start_response)
|
||||
environ['PATH_INFO'] = self.url
|
||||
raise ForwardRequestException(environ=environ)
|
||||
forward(TestForwardRequestMiddleware(error_docs_app))
|
||||
|
||||
def test_ForwardRequest_factory(self):
|
||||
from paste.errordocument import StatusKeeper
|
||||
|
||||
class TestForwardRequestMiddleware(Middleware):
|
||||
def __call__(self, environ, start_response):
|
||||
if environ['PATH_INFO'] != '/not_found':
|
||||
return self.app(environ, start_response)
|
||||
environ['PATH_INFO'] = self.url
|
||||
|
||||
def factory(app):
|
||||
return StatusKeeper(app,
|
||||
status='404 Not Found', url='/error', headers=[]
|
||||
)
|
||||
raise ForwardRequestException(factory=factory)
|
||||
|
||||
app = TestForwardRequestMiddleware(error_docs_app)
|
||||
app = TestApp(RecursiveMiddleware(app))
|
||||
res = app.get('')
|
||||
assert res.headers['content-type'] == 'text/plain'
|
||||
assert res.status == '200 OK'
|
||||
assert 'requested page returned' in res
|
||||
res = app.get('/error')
|
||||
assert res.headers['content-type'] == 'text/plain'
|
||||
assert res.status == '200 OK'
|
||||
assert 'Page not found' in res
|
||||
res = app.get('/not_found', status=404)
|
||||
assert res.headers['content-type'] == 'text/plain'
|
||||
assert res.status == '404 Not Found' # Different status
|
||||
assert 'Page not found' in res
|
||||
try:
|
||||
res = app.get('/recurse')
|
||||
except AssertionError, e:
|
||||
if str(e).startswith('Forwarding loop detected'):
|
||||
pass
|
||||
else:
|
||||
raise AssertionError('Failed to detect forwarding loop')
|
||||
|
||||
def test_ForwardRequestException(self):
|
||||
class TestForwardRequestExceptionMiddleware(Middleware):
|
||||
def __call__(self, environ, start_response):
|
||||
if environ['PATH_INFO'] != '/not_found':
|
||||
return self.app(environ, start_response)
|
||||
raise ForwardRequestException(path_info=self.url)
|
||||
forward(TestForwardRequestExceptionMiddleware(error_docs_app))
|
||||
Reference in New Issue
Block a user