← 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: matt.giuca
  • Date: 2009-01-18 23:03:54 UTC
  • Revision ID: svn-v3-trunk0:2b9c9e99-6f39-0410-b283-7f802c844ae2:trunk:1166
setup.install: Merged change from Storm branch (should have been committed
    directly to trunk). Small bugfix.

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 have three main types of registration:
30
 
     - forward_routes: A list of traversals from objects to their
31
 
       descendants. The discriminator is the source class and a list of zero
32
 
       or more intermediate path segments. An optional argument count may be
33
 
       given -- arguments will be taken from the path after the intermediate
34
 
       segments. The specified callable will be given the source object and
35
 
       any arguments, and should return the target object.
36
 
 
37
 
     - reverse_routes: A list of traversals from objects to their parents.
38
 
       The discriminator is just the child class. The provided callable must
39
 
       return a tuple of (parent_object, ('intermediate', path', 'segments')).
40
 
 
41
 
     - views: A list of named views for objects. The discriminator is the
42
 
       context object class, view name, and an optional view set. An optional
43
 
       (possibly infinite) argument count may again be given. The arguments
44
 
       values will be taken from the path after the view name. The callable
45
 
       should take the request object, target object and subpath, and return
46
 
       a view object.
47
 
 
48
 
    See ivle.dispatch.generate_publisher for the registry code.
49
 
 
50
 
    View plugins may also have a 'help' property, which should contain a dict
51
 
    of dicts and help file names. This dict is then used to generate the
52
 
    appropriate entries in the help system.
53
 
 
54
 
    Tabs can also be defined by view plugins. To define tabs, provide a 'tabs'
55
 
    property containing 6-tuples of (name, title, desc, icon, path, weight).
56
 
    The icon should be relative to the plugin's media directory, and the path
57
 
    should be relative to the root. The weight is used for ordering; larger
58
 
    weights are further right.
59
 
    """
60
 
    pass
61
 
 
62
 
class PublicViewPlugin(BasePlugin):
63
 
    """Marker class for plugins that provide public mode views.
64
 
 
65
 
    Public view plugins can specify the same 'urls' property as normal view
66
 
    plugins, but they are added to the public mode publisher instead.
67
 
    """
68
 
    pass
69
 
 
70
 
class OverlayPlugin(BasePlugin):
71
 
    """Marker class for plugins which provide overlays.
72
 
 
73
 
    Overlay plugins provide mini-views which can be displayed on top of other
74
 
    views. The canonical example of a plugin of this type is the Console plugin.
75
 
    """
76
 
    pass
77
 
 
78
 
class CookiePlugin(BasePlugin):
79
 
    """Marker class for plugins which provide cookies.
80
 
 
81
 
    Cookie plugins provide a 'cookies' dict mapping names to generation
82
 
    functions. The function should return the data to store in the cookie on
83
 
    login. If the function is None, the cookie is not created on login, just
84
 
    deleted on logout.
85
 
    """
86
 
    pass
87
 
 
88
 
class MediaPlugin(BasePlugin):
89
 
    """Marker class for plugins which provide media files.
90
 
 
91
 
    Media plugins provide a 'media' attribute, which is a string pointing to a
92
 
    subdirectory that contains media files to be served statically.
93
 
    """
94
 
    pass