Source

wsgiauth / wsgiauth / util.py

# Copyright (c) 2006 L. C. Rees.  All rights reserved.
#
# Permission is hereby granted, free of charge, to any person obtaining
# a copy of this software and associated documentation files (the "Software"),
# to deal in the Software without restriction, including without limitation
# the rights to use, copy, modify, merge, publish, distribute, sublicense,
# and/or sell copies of the Software, and to permit persons to whom the
# Software is furnished to do so, subject to the following conditions:
#
# The above copyright notice and this permission notice shall be included in
# all copies or substantial portions of the Software.
#
# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
# FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
# IN THE SOFTWARE.

import cgi
from urllib import quote


class Response(object):

    '''Generic WSGI application for HTTP responses.'''    

    _template = None    
    _status = '200 OK'
    _ctype = 'text/html'

    def __init__(self, message=None, **kw):
        # Status
        self.status = kw.get('status', self._status)
        # Response iterator        
        self.response = kw.get('response', self._response)
        # Authorization message
        self.message = message        
        # Authorization response template
        self.template = kw.get('template', self._template)
        # Header list
        self.headers = kw.get('headers', list())
        # Content type
        ctype = kw.get('content', self._ctype)
        self.headers.append(('Content-type', ctype))

    def __call__(self, environ, start_response):
        start_response(self.status, self.headers)
        return self.response(self.message or geturl(environ))

    def _response(self, message):
        '''Returns an iterator containing a message body.'''
        return [self.template % message]
    

class Redirect(Response):

    '''WSGI application for HTTP 30x redirects.'''

    _template = '<html>\n<head><title>Redirecting to %s</title></head>\n' \
        '<body>\nYou are being redirected to <a href="%s">%s</a>\n' \
        '</body>\n</html>'
    _status = '302 Found'

    def __call__(self, environ, start_response):
        location = self.message
        self.headers.append(('location', location))
        start_response(self.status, self.headers)
        return self.response((location, location, location))
    

class Forbidden(Response):
    
    '''WSGI application for 403 responses.'''

    _template = 'This server could not verify that you are authorized to ' \
             'access resource %s from your current location.'
    _status = '403 Forbidden'
    _ctype = 'text/plain'
        
    def __call__(self, environ, start_response):
        start_response(self.status, self.headers)
        return self.response(self.message or geturl(environ))

def extract(environ, empty=False, err=False):
    '''Extracts strings in form data and returns a dict.

    @param environ WSGI environ
    @param empty Stops on empty fields (default: Fault)
    @param err Stops on errors in fields (default: Fault)
    '''
    formdata = cgi.parse(environ['wsgi.input'], environ, empty, err)    
    # Remove single entries from lists
    for key, value in formdata.iteritems():
        if len(value) == 1: formdata[key] = value[0]
    return formdata

def geturl(environ, query=True, path=True):
    '''Rebuilds a request URL (from PEP 333).
    
    @param include_query Is QUERY_STRING included in URI (default: True)
    @param include_path Is path included in URI (default: True)
    '''    
    url = [environ['wsgi.url_scheme'] + '://']
    if environ.get('HTTP_HOST'):
        url.append(environ['HTTP_HOST'])
    else:
        url.append(environ['SERVER_NAME'])
        if environ['wsgi.url_scheme'] == 'https':
            if environ['SERVER_PORT'] != '443':
                url.append(':' + environ['SERVER_PORT'])
        else:
            if environ['SERVER_PORT'] != '80':
                url.append(':' + environ['SERVER_PORT'])
    if path:
        url.append(getpath(environ))
    if query and environ.get('QUERY_STRING'):
        url.append('?' + environ['QUERY_STRING'])
    return ''.join(url)

def getpath(environ):
    '''Builds a path.'''
    return ''.join([quote(environ.get('SCRIPT_NAME', '')),
        quote(environ.get('PATH_INFO', ''))])
Tip: Filter by directory path e.g. /media app.js to search for public/media/app.js.
Tip: Use camelCasing e.g. ProjME to search for ProjectModifiedEvent.java.
Tip: Filter by extension type e.g. /repo .js to search for all .js files in the /repo directory.
Tip: Separate your search with spaces e.g. /ssh pom.xml to search for src/ssh/pom.xml.
Tip: Use ↑ and ↓ arrow keys to navigate and return to view the file.
Tip: You can also navigate files with Ctrl+j (next) and Ctrl+k (previous) and view the file with Ctrl+o.
Tip: You can also navigate files with Alt+j (next) and Alt+k (previous) and view the file with Alt+o.