← Back to branch summary

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

« back to all changes in this revision

Viewing changes to ivle/dispatch/__init__.py

Replaced Python config files (conf.py) with new config files system, using
    configobj (INI-file style config files).

setup.py config now produces ./etc/ivle.conf, a new-style config file.
ivle/conf/conf.py is now part of the IVLE source code. It reads the new config
file and provides the same legacy interface, so all of IVLE still functions,
including setup.py config.

Added /etc to the source tree (config files will be stored here).
Added configobj as a dependency in doc/setup/install_proc.txt.

setup.py install copies ./etc/ivle.conf into /etc/ivle/ivle.conf.

Removed boilerplate code generation from setup/configure.py (that code is now
part of ivle/conf/conf.py which is now in the source tree).

Show diffs side-by-side

added added

removed removed

Lines of Context:
ivle/dispatch/__init__.py
35
35
import logging
36
36
import socket
37
37
import time
 
38
import inspect
38
39
 
39
40
import mod_python
40
41
import routes
44
45
import ivle.conf.apps
45
46
from ivle.dispatch.request import Request
46
47
from ivle.dispatch import login
 
48
from ivle.webapp.base.plugins import ViewPlugin
 
49
from ivle.webapp.errors import HTTPError
47
50
import apps
48
51
import html
49
 
import plugins.console # XXX: Relies on www/ being in the Python path.
50
52
 
51
53
# XXX List of plugins, which will eventually be read in from conf
52
54
plugins_HACK = [
 
55
    'ivle.webapp.core#Plugin',
53
56
    'ivle.webapp.admin.user#Plugin',
54
57
    'ivle.webapp.tutorial#Plugin',
55
58
    'ivle.webapp.admin.subject#Plugin',
56
 
    'ivle.webapp.browser#Plugin',
 
59
    'ivle.webapp.filesystem.browser#Plugin',
 
60
    'ivle.webapp.filesystem.diff#Plugin',
 
61
    'ivle.webapp.filesystem.svnlog#Plugin',
57
62
    'ivle.webapp.groups#Plugin',
58
63
    'ivle.webapp.console#Plugin',
59
64
    'ivle.webapp.security#Plugin',
60
 
]
 
65
    'ivle.webapp.media#Plugin',
 
66
    'ivle.webapp.forum#Plugin',
 
67
] 
61
68
 
62
 
def get_routes_mapper():
 
69
def generate_route_mapper(view_plugins):
63
70
    """
64
71
    Build a Mapper object for doing URL matching using 'routes', based on the
65
 
    plugins config.
 
72
    given plugin registry.
66
73
    """
67
74
    m = routes.Mapper(explicit=True)
68
 
    for pluginstr in plugins_HACK:
69
 
        plugin_path, classname = pluginstr.split('#')
70
 
        # Load the plugin module from somewhere in the Python path
71
 
        # (Note that plugin_path is a fully-qualified Python module name).
72
 
        plugin = getattr(__import__(plugin_path, fromlist=[classname]),
73
 
            classname)
 
75
    for plugin in view_plugins:
74
76
        # Establish a URL pattern for each element of plugin.urls
 
77
        assert hasattr(plugin, 'urls'), "%r does not have any urls" % plugin 
75
78
        for url in plugin.urls:
76
79
            routex = url[0]
77
80
            view_class = url[1]
79
82
            m.connect(routex, view=view_class, **kwargs_dict)
80
83
    return m
81
84
 
 
85
def get_plugin(pluginstr):
 
86
    plugin_path, classname = pluginstr.split('#')
 
87
    # Load the plugin module from somewhere in the Python path
 
88
    # (Note that plugin_path is a fully-qualified Python module name).
 
89
    return (plugin_path,
 
90
            getattr(__import__(plugin_path, fromlist=[classname]), classname))
 
91
 
82
92
def handler(req):
83
93
    """Handles a request which may be to anywhere in the site except media.
84
94
    Intended to be called by mod_python, as a handler.
123
133
    # XXX This should be done ONCE per Python process, not per request.
124
134
    # (Wait till WSGI)
125
135
    # XXX No authentication is done here
126
 
    req.mapper = get_routes_mapper()
 
136
    req.plugins = dict([get_plugin(pluginstr) for pluginstr in plugins_HACK])
 
137
    # Index the plugins by base class
 
138
    req.plugin_index = {}
 
139
    for plugin in req.plugins.values():
 
140
        # Getmro returns a tuple of all the super-classes of the plugin
 
141
        for base in inspect.getmro(plugin):
 
142
            if base not in req.plugin_index:
 
143
                req.plugin_index[base] = []
 
144
            req.plugin_index[base].append(plugin)
 
145
    req.reverse_plugins = dict([(v, k) for (k, v) in req.plugins.items()])
 
146
    req.mapper = generate_route_mapper(req.plugin_index[ViewPlugin])
 
147
 
127
148
    matchdict = req.mapper.match(req.uri)
128
149
    if matchdict is not None:
129
150
        viewcls = matchdict['view']
131
152
        # (The latter two seem to be built-in, and we don't want them).
132
153
        kwargs = matchdict.copy()
133
154
        del kwargs['view']
134
 
        # Instantiate the view, which should be a BaseView class
135
 
        view = viewcls(req, **kwargs)
136
 
        # Render the output
137
 
        view.render(req)
138
 
        req.store.commit()
139
 
        return req.OK
 
155
        try:
 
156
            # Instantiate the view, which should be a BaseView class
 
157
            view = viewcls(req, **kwargs)
 
158
            # Render the output
 
159
            view.render(req)
 
160
        except HTTPError, e:
 
161
            # A view explicitly raised an HTTP error. Respect it.
 
162
            req.status = e.code
 
163
 
 
164
            # Try to find a custom error view.
 
165
            if hasattr(viewcls, 'get_error_view'):
 
166
                errviewcls = viewcls.get_error_view(e)
 
167
            else:
 
168
                errviewcls = None
 
169
 
 
170
            if errviewcls:
 
171
                errview = errviewcls(req, e)
 
172
                errview.render(req)
 
173
                return req.OK
 
174
            else:
 
175
                req.write(e.message)
 
176
                return e.code
 
177
        except Exception, e:
 
178
            # A non-HTTPError appeared. We have an unknown exception. Panic.
 
179
            handle_unknown_exception(req, *sys.exc_info())
 
180
            return req.OK
 
181
        else:
 
182
            req.store.commit()
 
183
            return req.OK
140
184
    ### END New plugins framework ###
141
185
 
142
186
    # Check req.app to see if it is valid. 404 if not.
205
249
 
206
250
    # When done, write out the HTML footer if the app has requested it
207
251
    if req.write_html_head_foot:
208
 
        # Show the console if required
209
 
        if logged_in and app.useconsole:
210
 
            plugins.console.present(req, windowpane=True)
211
252
        html.write_html_foot(req)
212
253
 
213
254
    # Note: Apache will not write custom HTML error messages here.