← Back to branch summary

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

« back to all changes in this revision

Viewing changes to ivle/webapp/base/plugins.py

  • Committer: mattgiuca
  • Date: 2008-01-12 15:32:54 UTC
  • Revision ID: svn-v3-trunk0:2b9c9e99-6f39-0410-b283-7f802c844ae2:trunk:200
fileservice.listing: Now returns a nicer date format for mtime_nice.
    Applies an intuitive algorithm to make the date even shorter,
    (eg. "today" or "3 days ago") and returns this as mtime_short.
util.js: Fixed path_join if the first path is empty. (Was incorrectly adding
    a leading slash).
    Added optional "title" arguments to dom_make_text_elem and
    dom_make_link_elem.
browser.js: Displays mtime_short in the file table instead of mtime_nice
    (it was always too long). Displays the full date as a tooltip.
    Auto-navigates to the user's home directory if accessed from the root.
    (This may be a temporary measure, but it was giving a mean error before).
    Various code makes use of util's new optional "title" arguments.
dispatch.html: Writes a new JavaScript variable, "username", so JavaScript
    code knows which user is logged in.
    Cleaned up JS variables repr (previously they did bad escapes in some
    cases).

Show diffs side-by-side

added added

removed removed

Lines of Context:
ivle/webapp/base/plugins.py
1
 
# IVLE - Informatics Virtual Learning Environment
2
 
# Copyright (C) 2007-2009 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
 
# Author: Matt Giuca, Will Grant
19
 
 
20
 
class BasePlugin(object):
21
 
    """
22
 
    Base class for all Plugin classes.
23
 
    """
24
 
    pass
25
 
 
26
 
class ViewPlugin(BasePlugin):
27
 
    """Marker class for plugins that provide views.
28
 
 
29
 
    View plugins must have a 'urls' property which contains an iterable of pairs
30
 
    or triples, like (routex string, handler class, kwargs dict). The kwargs
31
 
    dict is optional. If present, the members of the kwargs dict will be passed
32
 
    as keyword arguments to the constructor of the view object.
33
 
 
34
 
    View plugins may also have a 'help' property, which should contain a dict
35
 
    of dicts and help file names. This dict is then used to generate the
36
 
    appropriate entries in the help system.
37
 
 
38
 
    Tabs can also be defined by view plugins. To define tabs, provide a 'tabs'
39
 
    property containing 6-tuples of (name, title, desc, icon, path, weight).
40
 
    The icon should be relative to the plugin's media directory, and the path
41
 
    should be relative to the root. The weight is used for ordering; larger
42
 
    weights are further right.
43
 
    """
44
 
    pass
45
 
 
46
 
class PublicViewPlugin(BasePlugin):
47
 
    """Marker class for plugins that provide public mode views.
48
 
 
49
 
    Public view plugins can specify the same 'urls' property as normal view
50
 
    plugins, but they are added to the public mode router instead.
51
 
    """
52
 
    pass
53
 
 
54
 
class OverlayPlugin(BasePlugin):
55
 
    """Marker class for plugins which provide overlays.
56
 
 
57
 
    Overlay plugins provide mini-views which can be displayed on top of other
58
 
    views. The canonical example of a plugin of this type is the Console plugin.
59
 
    """
60
 
    pass
61
 
 
62
 
class CookiePlugin(BasePlugin):
63
 
    """Marker class for plugins which provide cookies.
64
 
 
65
 
    Cookie plugins provide a 'cookies' dict mapping names to generation
66
 
    functions. The function should return the data to store in the cookie on
67
 
    login. If the function is None, the cookie is not created on login, just
68
 
    deleted on logout.
69
 
    """
70
 
    pass
71
 
 
72
 
class MediaPlugin(BasePlugin):
73
 
    """Marker class for plugins which provide media files.
74
 
 
75
 
    Media plugins provide a 'media' attribute, which is a string pointing to a
76
 
    subdirectory that contains media files to be served statically.
77
 
    """
78
 
    pass