← Back to branch summary

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

« back to all changes in this revision

Viewing changes to ivle/dispatch/__init__.py

Created a new help system.

The new help system allows plugins to register their help paths, using
a dict of dicts and helpfile paths. This system allows multiple plugins
to use the same heading for their help files (ie. 'admin').

It also allows XHTMLViews to have a 'help' property, which makes the
context-sensitive help link point to their help path.

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
    'ivle.webapp.help#Plugin',
 
68
] 
61
69
 
62
 
def get_routes_mapper():
 
70
def generate_route_mapper(view_plugins):
63
71
    """
64
72
    Build a Mapper object for doing URL matching using 'routes', based on the
65
 
    plugins config.
 
73
    given plugin registry.
66
74
    """
67
75
    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)
 
76
    for plugin in view_plugins:
74
77
        # Establish a URL pattern for each element of plugin.urls
 
78
        assert hasattr(plugin, 'urls'), "%r does not have any urls" % plugin 
75
79
        for url in plugin.urls:
76
80
            routex = url[0]
77
81
            view_class = url[1]
79
83
            m.connect(routex, view=view_class, **kwargs_dict)
80
84
    return m
81
85
 
 
86
def get_plugin(pluginstr):
 
87
    plugin_path, classname = pluginstr.split('#')
 
88
    # Load the plugin module from somewhere in the Python path
 
89
    # (Note that plugin_path is a fully-qualified Python module name).
 
90
    return (plugin_path,
 
91
            getattr(__import__(plugin_path, fromlist=[classname]), classname))
 
92
 
82
93
def handler(req):
83
94
    """Handles a request which may be to anywhere in the site except media.
84
95
    Intended to be called by mod_python, as a handler.
123
134
    # XXX This should be done ONCE per Python process, not per request.
124
135
    # (Wait till WSGI)
125
136
    # XXX No authentication is done here
126
 
    req.mapper = get_routes_mapper()
 
137
    req.plugins = dict([get_plugin(pluginstr) for pluginstr in plugins_HACK])
 
138
    # Index the plugins by base class
 
139
    req.plugin_index = {}
 
140
    for plugin in req.plugins.values():
 
141
        # Getmro returns a tuple of all the super-classes of the plugin
 
142
        for base in inspect.getmro(plugin):
 
143
            if base not in req.plugin_index:
 
144
                req.plugin_index[base] = []
 
145
            req.plugin_index[base].append(plugin)
 
146
    req.reverse_plugins = dict([(v, k) for (k, v) in req.plugins.items()])
 
147
    req.mapper = generate_route_mapper(req.plugin_index[ViewPlugin])
 
148
 
127
149
    matchdict = req.mapper.match(req.uri)
128
150
    if matchdict is not None:
129
151
        viewcls = matchdict['view']
131
153
        # (The latter two seem to be built-in, and we don't want them).
132
154
        kwargs = matchdict.copy()
133
155
        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
 
156
        try:
 
157
            # Instantiate the view, which should be a BaseView class
 
158
            view = viewcls(req, **kwargs)
 
159
            # Render the output
 
160
            view.render(req)
 
161
        except HTTPError, e:
 
162
            # A view explicitly raised an HTTP error. Respect it.
 
163
            req.status = e.code
 
164
 
 
165
            # Try to find a custom error view.
 
166
            if hasattr(viewcls, 'get_error_view'):
 
167
                errviewcls = viewcls.get_error_view(e)
 
168
            else:
 
169
                errviewcls = None
 
170
 
 
171
            if errviewcls:
 
172
                errview = errviewcls(req, e)
 
173
                errview.render(req)
 
174
                return req.OK
 
175
            else:
 
176
                req.write(e.message)
 
177
                return e.code
 
178
        except Exception, e:
 
179
            # A non-HTTPError appeared. We have an unknown exception. Panic.
 
180
            handle_unknown_exception(req, *sys.exc_info())
 
181
            return req.OK
 
182
        else:
 
183
            req.store.commit()
 
184
            return req.OK
140
185
    ### END New plugins framework ###
141
186
 
142
187
    # Check req.app to see if it is valid. 404 if not.
205
250
 
206
251
    # When done, write out the HTML footer if the app has requested it
207
252
    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
253
        html.write_html_foot(req)
212
254
 
213
255
    # Note: Apache will not write custom HTML error messages here.