web commit by http://jblevins.org/: Request for comments about SVG and MathML whitelists
[ikiwiki.git] / plugins / pythondemo
1 #!/usr/bin/python
2 # -*- coding: utf-8 -*-
3 #
4 # pythondemo — demo Python ikiwiki plugin
5 #
6 # Copyright © martin f. krafft <madduck@madduck.net>
7 # Released under the terms of the GNU GPL version 2
8 #
9 __name__ = 'pythondemo'
10 __description__ = 'demo Python ikiwiki plugin'
11 __version__ = '0.1'
12 __author__ = 'martin f. krafft <madduck@madduck.net>'
13 __copyright__ = 'Copyright © ' + __author__
14 __licence__ = 'GPLv2'
15
16 from proxy import IkiWikiProcedureProxy
17
18 import sys
19 def debug(s):
20     sys.stderr.write(__name__ + ':DEBUG:%s\n' % s)
21     sys.stderr.flush()
22
23 proxy = IkiWikiProcedureProxy(__name__, debug_fn=None)
24
25 def _arglist_to_dict(args):
26     if len(args) % 2 != 0:
27         raise ValueError, 'odd number of arguments, cannot convert to dict'
28     return dict([args[i:i+2] for i in xrange(0, len(args), 2)])
29
30 def getopt_demo(*args):
31     # This allows for plugins to perform their own processing of command-line
32     # options and so add options to the ikiwiki command line. It's called
33     # during command line processing, with @ARGV full of any options that
34     # ikiwiki was not able to process on its own. The function should process
35     # any options it can, removing them from @ARGV, and probably recording the
36     # configuration settings in %config. It should take care not to abort if
37     # it sees an option it cannot process, and should just skip over those
38     # options and leave them in @ARGV.
39     #
40     # TODO: See
41     # http://ikiwiki.info/bugs/external_plugins_cannot_access_ARGV_needed_for_getopt
42     debug("hook `getopt' called with arguments %s" % str(args))
43     raise NotImplementedError
44 #proxy.hook('getopt', getopt_demo)
45
46 def checkconfig_demo(*args):
47     # This is useful if the plugin needs to check for or modify ikiwiki's
48     # configuration. It's called early in the startup process. The function is
49     # passed no values. It's ok for the function to call error() if something
50     # isn't configured right.
51     # TODO: how do we tell ikiwiki about errors?
52     debug("hook `checkconfig' called with arguments %s" % str(args))
53     raise NotImplementedError
54 #proxy.hook('checkconfig', checkconfig_demo)
55
56 def refresh_demo(*args):
57     # This hook is called just before ikiwiki scans the wiki for changed
58     # files. It's useful for plugins that need to create or modify a source
59     # page. The function is passed no values.
60     debug("hook `refresh' called with arguments %s" % str(args))
61 proxy.hook('refresh', refresh_demo)
62
63 def needsbuild_demo(*args):
64     # This allows a plugin to manipulate the list of files that need to be
65     # built when the wiki is refreshed. The function is passed a reference to
66     # an array of pages that will be rebuilt, and can modify the array, either
67     # adding or removing files from it.
68     # TODO: how do we modify the array?
69     debug("hook `needsbuild' called with arguments %s" % str(args))
70     raise NotImplementedError
71 #proxy.hook('needsbuild', needsbuild_demo)
72
73 def filter_demo(*args):
74     # Runs on the raw source of a page, before anything else touches it, and
75     # can make arbitrary changes. The function is passed named parameters
76     # "page", "destpage", and "content". It should return the filtered
77     # content.
78     kwargs = _arglist_to_dict(args)
79     debug("hook `filter' called with arguments %s" % kwargs);
80     return kwargs['content']
81 proxy.hook('filter', filter_demo)
82
83 def preprocess_demo(*args):
84     # Each time the directive is processed, the referenced function
85     # (preprocess in the example above) is called, and is passed named
86     # parameters. A "page" parameter gives the name of the page that embedded
87     # the preprocessor directive, while a "destpage" parameter gives the name
88     # of the page the content is going to (different for inlined pages), and
89     # a "preview" parameter is set to a true value if the page is being
90     # previewed. All parameters included in the directive are included as
91     # named parameters as well. Whatever the function returns goes onto the
92     # page in place of the directive.
93     #
94     # An optional "scan" parameter, if set to a true value, makes the hook be
95     # called during the preliminary scan that ikiwiki makes of updated pages,
96     # before begining to render pages. This parameter should be set to true if
97     # the hook modifies data in %links. Note that doing so will make the hook
98     # be run twice per page build, so avoid doing it for expensive hooks. (As
99     # an optimisation, if your preprocessor hook is called in a void contets,
100     # you can assume it's being run in scan mode.)
101     #
102     # Note that if the htmlscrubber is enabled, html in PreProcessorDirective
103     # output is sanitised, which may limit what your plugin can do. Also, the
104     # rest of the page content is not in html format at preprocessor time.
105     # Text output by a preprocessor directive will be linkified and passed
106     # through markdown (or whatever engine is used to htmlize the page) along
107     # with the rest of the page.
108     #
109     # TODO: needs to be handled differently, the ID cannot be the plugin name.
110     kwargs = _arglist_to_dict(args)
111     debug("hook `preprocess' called with arguments %s" % kwargs)
112     raise NotImplementedError
113     return kwargs['content']
114 #proxy.hook('preprocess', preprocess_demo)
115
116 def linkify_demo(*args):
117     # This hook is called to convert WikiLinks on the page into html links.
118     # The function is passed named parameters "page", "destpage", and
119     # "content". It should return the linkified content.
120     #
121     # Plugins that implement linkify must also implement a scan hook, that
122     # scans for the links on the page and adds them to %links.
123     kwargs = _arglist_to_dict(args)
124     debug("hook `linkify' called with arguments %s" % kwargs)
125     return kwargs['content']
126 proxy.hook('linkify', linkify_demo)
127
128 def scan_demo(*args):
129     # This hook is called early in the process of building the wiki, and is
130     # used as a first pass scan of the page, to collect metadata about the
131     # page. It's mostly used to scan the page for WikiLinks, and add them to
132     # %links.
133     #
134     # The function is passed named parameters "page" and "content". Its return
135     # value is ignored.
136     #
137     # TODO: how do we add to %links?
138     kwargs = _arglist_to_dict(args)
139     debug("hook `scan' called with arguments %s" % kwargs)
140     raise NotImplementedError
141 #proxy.hook('scan', scan_demo)
142
143 def htmlize_demo(*args):
144     # Runs on the raw source of a page and turns it into html. The id
145     # parameter specifies the filename extension that a file must have to be
146     # htmlized using this plugin. This is how you can add support for new and
147     # exciting markup languages to ikiwiki.
148     #
149     # The function is passed named parameters: "page" and "content" and should
150     # return the htmlized content.
151     kwargs = _arglist_to_dict(args)
152     debug("hook `htmlize' called with arguments %s" % kwargs)
153     return kwargs['content']
154 proxy.hook('htmlize', htmlize_demo)
155
156 def pagetemplate_demo(*args):
157     # Templates are filled out for many different things in ikiwiki, like
158     # generating a page, or part of a blog page, or an rss feed, or a cgi.
159     # This hook allows modifying the variables available on those templates.
160     # The function is passed named parameters. The "page" and "destpage"
161     # parameters are the same as for a preprocess hook. The "template"
162     # parameter is a HTML::Template object that is the template that will be
163     # used to generate the page. The function can manipulate that template
164     # object.
165     #
166     # The most common thing to do is probably to call $template->param() to
167     # add a new custom parameter to the template.
168     # TODO: how do we call $template->param()
169     kwargs = _arglist_to_dict(args)
170     debug("hook `pagetemplate' called with arguments %s" % kwargs)
171     raise NotImplementedError
172 #proxy.hook('pagetemplate', pagetemplate_demo)
173
174 def templatefile_demo(*args):
175     # This hook allows plugins to change the template that is used for a page
176     # in the wiki. The hook is passed a "page" parameter, and should return
177     # the name of the template file to use, or undef if it doesn't want to
178     # change the default ("page.tmpl"). Template files are looked for in
179     # /usr/share/ikiwiki/templates by default.
180     #
181     # TODO: we cannot really pass undef/None via xml-rpc, so what to do?
182     kwargs = _arglist_to_dict(args)
183     debug("hook `templatefile' called with arguments %s" % kwargs)
184     raise NotImplementedError
185     return None
186 #proxy.hook('templatefile', templatefile_demo)
187
188 def sanitize_demo(*args):
189     # Use this to implement html sanitization or anything else that needs to
190     # modify the body of a page after it has been fully converted to html.
191     #
192     # The function is passed named parameters: "page" and "content", and
193     # should return the sanitized content.
194     kwargs = _arglist_to_dict(args)
195     debug("hook `sanitize' called with arguments %s" % kwargs)
196     return kwargs['content']
197 proxy.hook('sanitize', sanitize_demo)
198
199 def format_demo(*args):
200     # The difference between format and sanitize is that sanitize only acts on
201     # the page body, while format can modify the entire html page including
202     # the header and footer inserted by ikiwiki, the html document type, etc.
203     #
204     # The function is passed named parameters: "page" and "content", and
205     # should return the formatted content.
206     kwargs = _arglist_to_dict(args)
207     debug("hook `format' called with arguments %s" % kwargs)
208     return kwargs['content']
209 proxy.hook('format', format_demo)
210
211 def delete_demo(*args):
212     # Each time a page or pages is removed from the wiki, the referenced
213     # function is called, and passed the names of the source files that were
214     # removed.
215     debug("hook `delete' called with arguments %s" % str(args))
216 proxy.hook('delete', delete_demo)
217
218 def change_demo(*args):
219     # Each time ikiwiki renders a change or addition (but not deletion) to the
220     # wiki, the referenced function is called, and passed the names of the
221     # source files that were rendered.
222     debug("hook `change' called with arguments %s" % str(args))
223 proxy.hook('change', change_demo)
224
225 def cgi_demo(*args):
226     # Use this to hook into ikiwiki's cgi script. Each registered cgi hook is
227     # called in turn, and passed a CGI object. The hook should examine the
228     # parameters, and if it will handle this CGI request, output a page
229     # (including the http headers) and terminate the program.
230     #
231     # Note that cgi hooks are called as early as possible, before any ikiwiki
232     # state is loaded, and with no session information.
233     debug("hook `cgi' called with arguments %s" % str(args))
234     raise NotImplementedError
235 #proxy.hook('cgi', cgi_demo)
236
237 def auth_demo(*args):
238     # This hook can be used to implement a different authentication method
239     # than the standard web form. When a user needs to be authenticated, each
240     # registered auth hook is called in turn, and passed a CGI object and
241     # a session object.
242     #
243     # If the hook is able to authenticate the user, it should set the session
244     # object's "name" parameter to the authenticated user's name. Note that if
245     # the name is set to the name of a user who is not registered, a basic
246     # registration of the user will be automatically performed.
247     #
248     # TODO: how do we set the session parameter?
249     debug("hook `auth' called with arguments %s" % str(args))
250     raise NotImplementedError
251 #proxy.hook('auth', auth_demo)
252
253 def sessioncgi_demo(*args):
254     # Unlike the cgi hook, which is run as soon as possible, the sessioncgi
255     # hook is only run once a session object is available. It is passed both
256     # a CGI object and a session object. To check if the user is in fact
257     # signed in, you can check if the session object has a "name" parameter
258     # set.
259     debug("hook `sessioncgi' called with arguments %s" % str(args))
260     raise NotImplementedError
261 #proxy.hook('sessioncgi', sessioncgi_demo)
262
263 def canedit_demo(*args):
264     # This hook can be used to implement arbitrary access methods to control
265     # when a page can be edited using the web interface (commits from revision
266     # control bypass it). When a page is edited, each registered canedit hook
267     # is called in turn, and passed the page name, a CGI object, and a session
268     # object.
269     #
270     # If the hook has no opinion about whether the edit can proceed, return
271     # undef, and the next plugin will be asked to decide. If edit can proceed,
272     # the hook should return "". If the edit is not allowed by this hook, the
273     # hook should return an error message for the user to see, or a function
274     # that can be run to log the user in or perform other action necessary for
275     # them to be able to edit the page.
276     #
277     # This hook should avoid directly redirecting the user to a signin page,
278     # since it's sometimes used to test to see which pages in a set of pages
279     # a user can edit.
280     #
281     # TODO: we cannot return undef/None, see above.
282     # TODO: how do we return a function?
283     debug("hook `canedit' called with arguments %s" % str(args))
284     raise NotImplementedError
285 #proxy.hook('canedit', canedit_demo)
286
287 def editcontent_demo(*args):
288     # This hook is called when a page is saved (or previewed) using the web
289     # interface. It is passed named parameters: content, page, cgi, and
290     # session. These are, respectively, the new page content as entered by the
291     # user, the page name, a CGI object, and the user's CGI::Session.
292     #
293     # It can modify the content as desired, and should return the content.
294     kwargs = _arglist_to_dict(args)
295     debug("hook `editcontent' called with arguments %s" % kwargs)
296     return kwargs['content']
297 proxy.hook('editcontent', editcontent_demo)
298
299 def formbuilder_setup_demo(*args):
300     # These hooks allow tapping into the parts of ikiwiki that use
301     # CGI::FormBuilder to generate web forms. These hooks are passed named
302     # parameters: cgi, session, form, and buttons. These are, respectively,
303     # the CGI object, the user's CGI::Session, a CGI::FormBuilder, and
304     # a reference to an array of names of buttons to go on the form.
305     #
306     # Each time a form is set up, the formbuilder_setup hook is called.
307     # Typically the formbuilder_setup hook will check the form's title, and if
308     # it's a form that it needs to modify, will call various methods to
309     # add/remove/change fields, tweak the validation code for the fields, etc.
310     # It will not validate or display the form.
311     #
312     # Just before a form is displayed to the user, the formbuilder hook is
313     # called. It can be used to validate the form, but should not display it.
314     #
315     # TODO: how do we modify the form?
316     kwargs = _arglist_to_dict(args)
317     debug("hook `formbuilder_setup' called with arguments %s" % kwargs)
318     raise NotImplementedError
319     return kwargs['content']
320 #proxy.hook('formbuilder_setup', formbuilder_setup_demo)
321
322 def formbuilder_demo(*args):
323     # These hooks allow tapping into the parts of ikiwiki that use
324     # CGI::FormBuilder to generate web forms. These hooks are passed named
325     # parameters: cgi, session, form, and buttons. These are, respectively,
326     # the CGI object, the user's CGI::Session, a CGI::FormBuilder, and
327     # a reference to an array of names of buttons to go on the form.
328     #
329     # Each time a form is set up, the formbuilder_setup hook is called.
330     # Typically the formbuilder_setup hook will check the form's title, and if
331     # it's a form that it needs to modify, will call various methods to
332     # add/remove/change fields, tweak the validation code for the fields, etc.
333     # It will not validate or display the form.
334     #
335     # Just before a form is displayed to the user, the formbuilder hook is
336     # called. It can be used to validate the form, but should not display it.
337     # TODO: how do we modify the form?
338     kwargs = _arglist_to_dict(args)
339     debug("hook `formbuilder' called with arguments %s" % kwargs)
340     raise NotImplementedError
341     return kwargs['content']
342 #proxy.hook('formbuilder', formbuilder_demo)
343
344 def savestate_demo(*args):
345     # This hook is called wheneven ikiwiki normally saves its state, just
346     # before the state is saved. The function can save other state, modify
347     # values before they're saved, etc.
348     #
349     # TODO: how?
350     debug("hook `savestate' called with arguments %s" % str(args))
351     raise NotImplementedError
352 #proxy.hook('savestate', savestate_demo)
353
354 proxy.run()