qmsk/web/application.py
author Tero Marttila <terom@paivola.fi>
Thu, 29 Jan 2015 22:15:38 +0200
changeset 103 5263f65c990e
parent 92 e5799432071c
child 109 55f6a253cc15
permissions -rw-r--r--
qmsk.web.application: split lookup/respond
92
e5799432071c qmsk.web: port pvl.web to python3, and rewrite html
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
     1
from werkzeug.wrappers import Request, Response
e5799432071c qmsk.web: port pvl.web to python3, and rewrite html
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
     2
from werkzeug.exceptions import (
e5799432071c qmsk.web: port pvl.web to python3, and rewrite html
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
     3
        HTTPException,
e5799432071c qmsk.web: port pvl.web to python3, and rewrite html
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
     4
        BadRequest,         # 400
e5799432071c qmsk.web: port pvl.web to python3, and rewrite html
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
     5
        NotFound,           # 404
e5799432071c qmsk.web: port pvl.web to python3, and rewrite html
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
     6
)
e5799432071c qmsk.web: port pvl.web to python3, and rewrite html
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
     7
from werkzeug.utils import redirect
e5799432071c qmsk.web: port pvl.web to python3, and rewrite html
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
     8
e5799432071c qmsk.web: port pvl.web to python3, and rewrite html
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
     9
class Application:
e5799432071c qmsk.web: port pvl.web to python3, and rewrite html
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
    10
    URLS = None
e5799432071c qmsk.web: port pvl.web to python3, and rewrite html
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
    11
e5799432071c qmsk.web: port pvl.web to python3, and rewrite html
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
    12
    def __init__ (self, urls=None):
e5799432071c qmsk.web: port pvl.web to python3, and rewrite html
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
    13
        """
e5799432071c qmsk.web: port pvl.web to python3, and rewrite html
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
    14
            urls        - werkzeug.routing.Map -> Handler
e5799432071c qmsk.web: port pvl.web to python3, and rewrite html
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
    15
        """
e5799432071c qmsk.web: port pvl.web to python3, and rewrite html
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
    16
e5799432071c qmsk.web: port pvl.web to python3, and rewrite html
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
    17
        if not urls:
e5799432071c qmsk.web: port pvl.web to python3, and rewrite html
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
    18
            urls = self.URLS
e5799432071c qmsk.web: port pvl.web to python3, and rewrite html
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
    19
e5799432071c qmsk.web: port pvl.web to python3, and rewrite html
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
    20
        if not urls:
e5799432071c qmsk.web: port pvl.web to python3, and rewrite html
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
    21
            raise ValueError("Required URLS/urls=...")
e5799432071c qmsk.web: port pvl.web to python3, and rewrite html
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
    22
e5799432071c qmsk.web: port pvl.web to python3, and rewrite html
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
    23
        self.urls = urls
e5799432071c qmsk.web: port pvl.web to python3, and rewrite html
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
    24
103
5263f65c990e qmsk.web.application: split lookup/respond
Tero Marttila <terom@paivola.fi>
parents: 92
diff changeset
    25
    def lookup (self, request):
92
e5799432071c qmsk.web: port pvl.web to python3, and rewrite html
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
    26
        """
103
5263f65c990e qmsk.web.application: split lookup/respond
Tero Marttila <terom@paivola.fi>
parents: 92
diff changeset
    27
            Lookup Request -> Handler, params
92
e5799432071c qmsk.web: port pvl.web to python3, and rewrite html
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
    28
        """
e5799432071c qmsk.web: port pvl.web to python3, and rewrite html
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
    29
        
e5799432071c qmsk.web: port pvl.web to python3, and rewrite html
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
    30
        # bind to request
e5799432071c qmsk.web: port pvl.web to python3, and rewrite html
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
    31
        urls = self.urls.bind_to_environ(request)
e5799432071c qmsk.web: port pvl.web to python3, and rewrite html
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
    32
        
e5799432071c qmsk.web: port pvl.web to python3, and rewrite html
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
    33
        # lookup
e5799432071c qmsk.web: port pvl.web to python3, and rewrite html
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
    34
        handler, params = urls.match()
e5799432071c qmsk.web: port pvl.web to python3, and rewrite html
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
    35
e5799432071c qmsk.web: port pvl.web to python3, and rewrite html
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
    36
        # handler instance
e5799432071c qmsk.web: port pvl.web to python3, and rewrite html
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
    37
        handler = handler(self, request, urls)
103
5263f65c990e qmsk.web.application: split lookup/respond
Tero Marttila <terom@paivola.fi>
parents: 92
diff changeset
    38
        
5263f65c990e qmsk.web.application: split lookup/respond
Tero Marttila <terom@paivola.fi>
parents: 92
diff changeset
    39
        return handler, params
5263f65c990e qmsk.web.application: split lookup/respond
Tero Marttila <terom@paivola.fi>
parents: 92
diff changeset
    40
   
5263f65c990e qmsk.web.application: split lookup/respond
Tero Marttila <terom@paivola.fi>
parents: 92
diff changeset
    41
    def respond (self, request):
5263f65c990e qmsk.web.application: split lookup/respond
Tero Marttila <terom@paivola.fi>
parents: 92
diff changeset
    42
        """
5263f65c990e qmsk.web.application: split lookup/respond
Tero Marttila <terom@paivola.fi>
parents: 92
diff changeset
    43
            Process Request -> Response, using lookup()
5263f65c990e qmsk.web.application: split lookup/respond
Tero Marttila <terom@paivola.fi>
parents: 92
diff changeset
    44
        """
5263f65c990e qmsk.web.application: split lookup/respond
Tero Marttila <terom@paivola.fi>
parents: 92
diff changeset
    45
5263f65c990e qmsk.web.application: split lookup/respond
Tero Marttila <terom@paivola.fi>
parents: 92
diff changeset
    46
        handler, params = self.lookup(request)
92
e5799432071c qmsk.web: port pvl.web to python3, and rewrite html
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
    47
e5799432071c qmsk.web: port pvl.web to python3, and rewrite html
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
    48
        try :
e5799432071c qmsk.web: port pvl.web to python3, and rewrite html
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
    49
            handler.init()
e5799432071c qmsk.web: port pvl.web to python3, and rewrite html
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
    50
e5799432071c qmsk.web: port pvl.web to python3, and rewrite html
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
    51
            # apply
e5799432071c qmsk.web: port pvl.web to python3, and rewrite html
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
    52
            return handler.respond(**params)
e5799432071c qmsk.web: port pvl.web to python3, and rewrite html
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
    53
e5799432071c qmsk.web: port pvl.web to python3, and rewrite html
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
    54
        finally :
e5799432071c qmsk.web: port pvl.web to python3, and rewrite html
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
    55
            handler.cleanup()
e5799432071c qmsk.web: port pvl.web to python3, and rewrite html
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
    56
e5799432071c qmsk.web: port pvl.web to python3, and rewrite html
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
    57
    @Request.application
e5799432071c qmsk.web: port pvl.web to python3, and rewrite html
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
    58
    def __call__ (self, request) :
e5799432071c qmsk.web: port pvl.web to python3, and rewrite html
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
    59
        """
e5799432071c qmsk.web: port pvl.web to python3, and rewrite html
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
    60
            WSGI entry point, werkzeug Request -> Response
e5799432071c qmsk.web: port pvl.web to python3, and rewrite html
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
    61
        """
e5799432071c qmsk.web: port pvl.web to python3, and rewrite html
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
    62
e5799432071c qmsk.web: port pvl.web to python3, and rewrite html
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
    63
        try :
e5799432071c qmsk.web: port pvl.web to python3, and rewrite html
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
    64
            return self.respond(request)
e5799432071c qmsk.web: port pvl.web to python3, and rewrite html
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
    65
        
e5799432071c qmsk.web: port pvl.web to python3, and rewrite html
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
    66
        except HTTPException as ex :
e5799432071c qmsk.web: port pvl.web to python3, and rewrite html
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
    67
            return ex
e5799432071c qmsk.web: port pvl.web to python3, and rewrite html
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
    68
e5799432071c qmsk.web: port pvl.web to python3, and rewrite html
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
    69
class Handler (object) :
e5799432071c qmsk.web: port pvl.web to python3, and rewrite html
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
    70
    """
e5799432071c qmsk.web: port pvl.web to python3, and rewrite html
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
    71
        Per-Request controller/view, containing the request context and generating the response.
e5799432071c qmsk.web: port pvl.web to python3, and rewrite html
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
    72
    """
e5799432071c qmsk.web: port pvl.web to python3, and rewrite html
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
    73
    
e5799432071c qmsk.web: port pvl.web to python3, and rewrite html
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
    74
    # werkzeug defaults to UTF-8
e5799432071c qmsk.web: port pvl.web to python3, and rewrite html
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
    75
    MIMETYPE = 'text/html'
e5799432071c qmsk.web: port pvl.web to python3, and rewrite html
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
    76
e5799432071c qmsk.web: port pvl.web to python3, and rewrite html
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
    77
    def __init__ (self, app, request, urls) :
e5799432071c qmsk.web: port pvl.web to python3, and rewrite html
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
    78
        """
e5799432071c qmsk.web: port pvl.web to python3, and rewrite html
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
    79
            app     - wsgi.Application
e5799432071c qmsk.web: port pvl.web to python3, and rewrite html
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
    80
            request - werkzeug.Request
e5799432071c qmsk.web: port pvl.web to python3, and rewrite html
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
    81
            urls    - werkzeug.routing.Map.bind_to_environ()
e5799432071c qmsk.web: port pvl.web to python3, and rewrite html
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
    82
        """
e5799432071c qmsk.web: port pvl.web to python3, and rewrite html
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
    83
e5799432071c qmsk.web: port pvl.web to python3, and rewrite html
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
    84
        self.app = app
e5799432071c qmsk.web: port pvl.web to python3, and rewrite html
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
    85
        self.request = request
e5799432071c qmsk.web: port pvl.web to python3, and rewrite html
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
    86
        self.urls = urls
e5799432071c qmsk.web: port pvl.web to python3, and rewrite html
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
    87
e5799432071c qmsk.web: port pvl.web to python3, and rewrite html
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
    88
    def url (self, handler=None, **params) :
e5799432071c qmsk.web: port pvl.web to python3, and rewrite html
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
    89
        """
e5799432071c qmsk.web: port pvl.web to python3, and rewrite html
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
    90
            Return an URL for given endpoint, with parameters,
e5799432071c qmsk.web: port pvl.web to python3, and rewrite html
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
    91
        """
e5799432071c qmsk.web: port pvl.web to python3, and rewrite html
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
    92
e5799432071c qmsk.web: port pvl.web to python3, and rewrite html
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
    93
        if not handler :
e5799432071c qmsk.web: port pvl.web to python3, and rewrite html
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
    94
            handler = self.__class__
e5799432071c qmsk.web: port pvl.web to python3, and rewrite html
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
    95
e5799432071c qmsk.web: port pvl.web to python3, and rewrite html
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
    96
        return self.urls.build(handler, params)
e5799432071c qmsk.web: port pvl.web to python3, and rewrite html
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
    97
e5799432071c qmsk.web: port pvl.web to python3, and rewrite html
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
    98
    ## processing stages
e5799432071c qmsk.web: port pvl.web to python3, and rewrite html
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
    99
    def init (self) :
e5799432071c qmsk.web: port pvl.web to python3, and rewrite html
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
   100
        """
e5799432071c qmsk.web: port pvl.web to python3, and rewrite html
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
   101
            Initialize on request start.
e5799432071c qmsk.web: port pvl.web to python3, and rewrite html
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
   102
        """
e5799432071c qmsk.web: port pvl.web to python3, and rewrite html
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
   103
e5799432071c qmsk.web: port pvl.web to python3, and rewrite html
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
   104
        pass
e5799432071c qmsk.web: port pvl.web to python3, and rewrite html
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
   105
e5799432071c qmsk.web: port pvl.web to python3, and rewrite html
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
   106
    def process (self, **params) :
e5799432071c qmsk.web: port pvl.web to python3, and rewrite html
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
   107
        """
e5799432071c qmsk.web: port pvl.web to python3, and rewrite html
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
   108
            Process request args to build internal request state.
e5799432071c qmsk.web: port pvl.web to python3, and rewrite html
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
   109
e5799432071c qmsk.web: port pvl.web to python3, and rewrite html
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
   110
            May optionally return a Response, to e.g. redirect after POST.
e5799432071c qmsk.web: port pvl.web to python3, and rewrite html
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
   111
        """
e5799432071c qmsk.web: port pvl.web to python3, and rewrite html
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
   112
e5799432071c qmsk.web: port pvl.web to python3, and rewrite html
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
   113
        pass
e5799432071c qmsk.web: port pvl.web to python3, and rewrite html
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
   114
e5799432071c qmsk.web: port pvl.web to python3, and rewrite html
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
   115
    def render (self) :
e5799432071c qmsk.web: port pvl.web to python3, and rewrite html
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
   116
        """
e5799432071c qmsk.web: port pvl.web to python3, and rewrite html
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
   117
            Render response.
e5799432071c qmsk.web: port pvl.web to python3, and rewrite html
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
   118
        """
e5799432071c qmsk.web: port pvl.web to python3, and rewrite html
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
   119
e5799432071c qmsk.web: port pvl.web to python3, and rewrite html
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
   120
        raise NotImplementedError()
e5799432071c qmsk.web: port pvl.web to python3, and rewrite html
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
   121
e5799432071c qmsk.web: port pvl.web to python3, and rewrite html
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
   122
    def mimetype (self):
e5799432071c qmsk.web: port pvl.web to python3, and rewrite html
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
   123
        return self.MIMETYPE
e5799432071c qmsk.web: port pvl.web to python3, and rewrite html
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
   124
e5799432071c qmsk.web: port pvl.web to python3, and rewrite html
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
   125
    def status (self):
e5799432071c qmsk.web: port pvl.web to python3, and rewrite html
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
   126
        return 200
e5799432071c qmsk.web: port pvl.web to python3, and rewrite html
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
   127
e5799432071c qmsk.web: port pvl.web to python3, and rewrite html
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
   128
    def respond (self, **params) :
e5799432071c qmsk.web: port pvl.web to python3, and rewrite html
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
   129
        """
e5799432071c qmsk.web: port pvl.web to python3, and rewrite html
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
   130
            Generate a response, or raise an HTTPException
e5799432071c qmsk.web: port pvl.web to python3, and rewrite html
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
   131
        """
e5799432071c qmsk.web: port pvl.web to python3, and rewrite html
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
   132
        
e5799432071c qmsk.web: port pvl.web to python3, and rewrite html
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
   133
        # returning e.g. redirect?
e5799432071c qmsk.web: port pvl.web to python3, and rewrite html
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
   134
        response = self.process(**params)
e5799432071c qmsk.web: port pvl.web to python3, and rewrite html
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
   135
e5799432071c qmsk.web: port pvl.web to python3, and rewrite html
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
   136
        if response :
e5799432071c qmsk.web: port pvl.web to python3, and rewrite html
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
   137
            return response
e5799432071c qmsk.web: port pvl.web to python3, and rewrite html
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
   138
        
e5799432071c qmsk.web: port pvl.web to python3, and rewrite html
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
   139
        return Response(self.render_response(), mimetype=self.mimetype(), status=self.status())
103
5263f65c990e qmsk.web.application: split lookup/respond
Tero Marttila <terom@paivola.fi>
parents: 92
diff changeset
   140
92
e5799432071c qmsk.web: port pvl.web to python3, and rewrite html
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
   141
    def cleanup (self) :
e5799432071c qmsk.web: port pvl.web to python3, and rewrite html
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
   142
        """
e5799432071c qmsk.web: port pvl.web to python3, and rewrite html
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
   143
            After request processing. Do not fail :)
e5799432071c qmsk.web: port pvl.web to python3, and rewrite html
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
   144
        """
e5799432071c qmsk.web: port pvl.web to python3, and rewrite html
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
   145
        
e5799432071c qmsk.web: port pvl.web to python3, and rewrite html
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
   146
        pass
e5799432071c qmsk.web: port pvl.web to python3, and rewrite html
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
   147