← Back to branch summary

~azzar1/unity/add-show-desktop-key

« back to all changes in this revision

Viewing changes to www/dispatch/__init__.py

  • Committer: William Grant
  • Date: 2010-02-17 08:57:40 UTC
  • Revision ID: grantw@unimelb.edu.au-20100217085740-3atwitguxi3ukx2l
Add a Projects breadcrumb.

Show diffs side-by-side

added added

removed removed

Lines of Context:
www/dispatch/__init__.py
1
 
# IVLE
2
 
# Copyright (C) 2007-2008 The University of Melbourne
3
 
#
4
 
# This program is free software; you can redistribute it and/or modify
5
 
# it under the terms of the GNU General Public License as published by
6
 
# the Free Software Foundation; either version 2 of the License, or
7
 
# (at your option) any later version.
8
 
#
9
 
# This program is distributed in the hope that it will be useful,
10
 
# but WITHOUT ANY WARRANTY; without even the implied warranty of
11
 
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
12
 
# GNU General Public License for more details.
13
 
#
14
 
# You should have received a copy of the GNU General Public License
15
 
# along with this program; if not, write to the Free Software
16
 
# Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
17
 
 
18
 
# Module: dispatch
19
 
# Author: Matt Giuca
20
 
# Date: 11/12/2007
21
 
 
22
 
# This is a mod_python handler program. The correct way to call it is to have
23
 
# Apache send all requests to be handled by the module 'dispatch'.
24
 
 
25
 
# Top-level handler. Handles all requests to all pages in IVLE.
26
 
# Handles authentication (not authorization).
27
 
# Then passes the request along to the appropriate ivle app.
28
 
 
29
 
import mod_python
30
 
from mod_python import apache
31
 
 
32
 
import os
33
 
import os.path
34
 
import conf
35
 
import conf.apps
36
 
import apps
37
 
 
38
 
from request import Request
39
 
import html
40
 
import login
41
 
from common import util
42
 
 
43
 
def handler(req):
44
 
    """Handles a request which may be to anywhere in the site except media.
45
 
    Intended to be called by mod_python, as a handler.
46
 
 
47
 
    req: An Apache request object.
48
 
    """
49
 
    # Make the request object into an IVLE request which can be passed to apps
50
 
    apachereq = req
51
 
    req = Request(req, html.write_html_head)
52
 
 
53
 
    # Check req.app to see if it is valid. 404 if not.
54
 
    if req.app is not None and req.app not in conf.apps.app_url:
55
 
        # Maybe it is a special app!
56
 
        if req.app == 'logout':
57
 
            logout(req)
58
 
        else:
59
 
            # TODO: Nicer 404 message?
60
 
            req.throw_error(Request.HTTP_NOT_FOUND)
61
 
 
62
 
    # app is the App object for the chosen app
63
 
    if req.app is None:
64
 
        app = conf.apps.app_url[conf.default_app]
65
 
    else:
66
 
        app = conf.apps.app_url[req.app]
67
 
 
68
 
    # Check if app requires auth. If so, perform authentication and login.
69
 
    if app.requireauth:
70
 
        req.username = login.login(req)
71
 
        logged_in = req.username is not None
72
 
    else:
73
 
        req.username = login.get_username(req)
74
 
        logged_in = True
75
 
 
76
 
    if logged_in:
77
 
        # If user did not specify an app, HTTP redirect to default app and
78
 
        # exit.
79
 
        if req.app is None:
80
 
            req.throw_redirect(util.make_path(conf.default_app))
81
 
 
82
 
        # Set the default title to the app's tab name, if any. Otherwise URL
83
 
        # name.
84
 
        if app.name is not None:
85
 
            req.title = app.name
86
 
        else:
87
 
            req.title = req.app
88
 
 
89
 
        # Call the specified app with the request object
90
 
        apps.call_app(app.dir, req)
91
 
    # if not logged in, login.login will have written the login box.
92
 
    # Just clean up and exit.
93
 
 
94
 
    # MAKE SURE we write the HTTP (and possibly HTML) header. This
95
 
    # wouldn't happen if nothing else ever got written, so we have to make
96
 
    # sure.
97
 
    req.ensure_headers_written()
98
 
 
99
 
    # When done, write out the HTML footer if the app has requested it
100
 
    if req.write_html_head_foot:
101
 
        html.write_html_foot(req)
102
 
 
103
 
    # Note: Apache will not write custom HTML error messages here.
104
 
    # Use req.throw_error to do that.
105
 
    return req.OK
106
 
 
107
 
def logout(req):
108
 
    """Log out the current user (if any) by destroying the session state.
109
 
    Then redirect to the top-level IVLE page."""
110
 
    session = req.get_session()
111
 
    session.invalidate()
112
 
    session.delete()
113
 
    req.throw_redirect(util.make_path(''))