1

"""

     2

    WSGI HTTP utility code

     3

"""

     4

     5

# for utility functions

     6

import cgi

     7

     8

# for header handling

     9

import wsgiref.headers

    10

    11

# for path handling

    12

import os.path

    13

    14

class Request (object) :

    15

    """

    16

        HTTP Request with associated metadata

    17

    """

    18

    19

    def __init__ (self, env) :

    20

        """

    21

            Parse env data

    22

        """

    23

    24

        # store env

    25

        self.env = env

    26

    27

        # get the querystring

    28

        self.arg_str = env.get('QUERY_STRING', '')

    29

    30

        # parse query args

    31

        self.arg_dict = cgi.parse_qs(self.arg_str, True)

    32

    33

    def get_script_dir (self) :

    34

        """

    35

            Returns the URL path to the requested script's directory with no trailing slash, i.e.

    36

    37

            /               -> 

    38

            /foo.cgi        -> 

    39

            /foo/bar.cgi    -> /foo

    40

        """

    41

    42

        return os.path.dirname(self.env['SCRIPT_NAME'])

    43

    72

    def get_page_name (self) :

    73

        """

    74

            Returns the requested page path with no leading slash, i.e.

    75

    76

            /foo.cgi        -> 

    77

            /foo.cgi/       -> 

    78

            /foo.cgi/bar    -> bar

    79

            /foo.cgi/quux/  -> quux/

    80

        """

    81

    82

        # the raw PATH_INFO

    83

        path_info = self.env.get('PATH_INFO')

    84

    85

        # avoid nasty '.' paths

    86

        if path_info :

    87

            return os.path.normpath(path_info).lstrip('/')

    88

    89

        else :

    90

            return ''

    91

    92

class Response (object) :

    93

    """

    94

        HTTP Response with headers and data

    95

    """

    96

    97

    def __init__ (self, data, content_type='text/html', status='200 OK', charset='utf8') :

    98

        """

    99

            Create the response. The Content-type header is built from the given values. The given \a data must be

   100

            either a str (which is sent plain), an unicode object (which is encoded with the relevant charset), or

   101

            None, whereupon an empty response body is sent. The content_type argument can also be forced to None to

   102

            not send a Content-type header (e.g. for redirects)

   103

        """

   104

   105

        # store info

   106

        self.status = status

   107

        self.data = data

   108

        self.charset = charset

   109

   110

        # headers

   111

        self.headers = wsgiref.headers.Headers([])

   112

   113

        # add Content-type header?

   114

        if content_type :

   115

            self.add_header('Content-type', content_type, charset=charset)

   116

   117

    def add_header (self, name, value, **params) :

   118

        """

   119

            Add response header with the given name/value, plus option params

   120

   121

            XXX: uses the wsgiref.headers code, not sure how that behaves re multiple headers with the same name, etc

   122

        """

   123

   124

        self.headers.add_header(name, value, **params)

   125

   126

    def get_status (self) :

   127

        """

   128

            Returns response status string (XXX Foo)

   129

        """

   130

   131

        return self.status

   132

   133

    def get_headers (self) :

   134

        """

   135

            Returns the list of header (name, value) pairs

   136

        """

   137

   138

        return self.headers.items()

   139

   140

    def get_data (self) :

   141

        """

   142

            Returns the response data - as an encoded string

   143

        """

   144

   145

        if self.data :

   146

            return self.data.encode(self.charset)

   147

   148

        else :

   149

            return ''

   150

   151

class ErrorResponse (Response) :

   152

    """

   153

        A response with an error code / message

   154

    """

   155

   156

    def __init__ (self, status, message, details=None) :

   157

        """

   158

            Build a plain error message response with the given status/message

   159

   160

            @param status HTTP status code

   161

            @param message short message to describe errors

   162

            @param details optional details, plaintext

   163

        """

   164

   165

        data = """\

   166

<html><head><title>%(title)s</title></head><body>

   167

<h1>%(title)s</h1>

   168

<p>%(message)s</p>

   169

%(details)s

   170

</body></html>

   171

""" % dict(

   172

            title       = status, 

   173

            message     = message,

   174

            details     = '<pre>%s</pre>' % details if details else ''

   175

        )

   176

   177

        super(ErrorResponse, self).__init__(data, status=status)

   178

   179

class ResponseError (Exception) :

   180

    """

   181

        An exception that results in a specfic 4xx ErrorResponse message to the client

   182

    """

   183

   184

    def __init__ (self, message, status='400 Bad Request', details=None) :

   185

        self.status = status

   186

        self.message = message

   187

        self.details = details

   188

   189

        super(ResponseError, self).__init__(message)

   190

   191

    def get_response (self) :

   192

        return ErrorResponse(self.status, self.message, self.details)

   193

   194

class Redirect (Response) :

   195

    """

   196

        Redirect response

   197

    """

   198

   199

    def __init__ (self, url) :

   200

        """

   201

            Redirect to given *absolute* URL

   202

        """

   203

   204

        # no content-type or data

   205

        super(Redirect, self).__init__(None, content_type=None, status='302 Found')

   206

   207

        # add Location: header

   208

        self.add_header("Location", url)

   209

   210