This Contributed Plugin allows you to execute JavaScript code on the server. Useful for creating pages with dynamic content. This plugin is experimental at this stage; clearly better wiki integration and server safety issues need to be addressed.

The plugin's JavaScript implementation is Mozilla's Rhino. The public discussion for Mozilla's JavaScript implementations is at netscape.public.mozilla.jseng.

For more information please contact Andrew Gilmartin at andrewgilmartin at yahoo.com.

Building

To built you will need to add the following libraries to the project's lib directory:

• JSPWiki.jar (version 2.4.24 or better);
• servlet-api.jar from your Tomcat distribution;
• js.jar from Rhino 1.6R2 at http://www.mozilla.org/rhino/download.html;
• xbean.jar from XMLBeans 2.20 at http://www.apache.org/dyn/closer.cgi/xmlbeans.

Then run ant.

The code does not yet conform to the JSPWiki Coding Standard.

Installing

Copy the file build/jspwiki-js-plugin.jar, lib/js.jar, and lib/xbean.jar to JSPWiki's WEB-INF/lib directory.

Using

The plugin is called using

[{com.ingenta.jspwiki.plugin.js.JSPlugin scriptPage='wikiPage' scriptResult='text|xml|wiki' }]

[{com.ingenta.jspwiki.plugin.js.JSPlugin script='javascript' scriptResult='text|xml|wiki' }]

[{com.ingenta.jspwiki.plugin.js.JSPlugin scriptResult='text|xml|wiki'

.. javascript body content ..
}]

[{scriptPage scriptResult='text|xml|wiki'

.. data body content ..
}]

For most installations you need only refer to the plugin as JSPlugin as the installation will have added com.ingenta.jspwiki.plugin.js to the jspwiki.plugin.searchPath property.

The script and scriptPage parameter or body content selects the JavaScript code to execute. The scriptResult parameter determines how the script's result is further processed; xml result output is sent as is to the browser; text result output is send to the browser after escaping &, <, >, and " characters; wiki result output is send to the browser after first converting to HTML. The default scriptResult value is wiki.

Using the scriptPage as the name of the plugin only works for JSPWiki implementations using the modified com.ecyrd.jspwiki.plugin.PluginManager supporting the jspwiki.plugin.unknownPlugin property. For more information see ScriptedPlugin.

During execution the following global variables are available to the script:

See JSPluginScripts for examples of scripts.

Note that the current interpreter is not a safe one. Thus all event, file, socket, and use of Java classes is enabled.

Class and method detail

class JSWikiPage

class JSWikiPageVersionInfo

class JSWikePageAttachmentInfo

class JSWikiInfo

Comments

Q: I can't get the JSPlugin compiled yet. Is it possible to post the .jar on this page.
My compiler complains about the call to wikiEngine.saveText(...) in JSWikiPage.java. -- DF

A: Done. Note that this version works with JSPWIki 2.0.39. -- Andrew Gilmartin

A: There are a number of examples on the JSPluginScripts page. Perhaps these will answer your questions. Otherwise, please do send me email with some context of how you want to use the plugin and perhaps with all this information I can help. -- Andrew Gilmartin