org.ceryle.wiki.plugin
Class Groovy

java.lang.Object
  org.ceryle.wiki.plugin.Groovy

All Implemented Interfaces:

WikiPlugin

public class Groovy
extends Object
implements WikiPlugin

JSPWiki plugin to support both local and linked Groovy scripting on a wiki page.

Parameters

• debug = 'true' | 'false'. When true, displays the provided source code and debugging level information. Defaults to false.
• href = 'URI'. When specified, any script content in the plugin is ignored in favour of resolving the provided URI as the script content. The provided URL must use a file extension convention of either *.gvy or *.groovy.

In the absence of an href parameter, the Groovy script content is contained within the plugin body. More docs TBD.

Example 1

The international standard that just prints "Hello World!" back to the wiki page.

    [{Groovy println("Hello World!") }]
  

Example 2

Opens the file 'Console.groovy' located in the scripts directory on the wiki server. Yes, this actually opens a Groovy console window.

    [{Groovy href='http://localhost:9099/wiki/scripts/Console.groovy' }]
  

Notes

• Note that plugin invocation occurs more than once per page view, as plugins get parsed and invoked during permission checks and other calls for the page's HTML content. This in itself isn't a problem, but you should know that the script will likewise get run multiple times per page view, which whatever impact that may have.

Security Risks

There is a compile-time flag

• CHECK_AUTHENTICATION (default is true); in this case the script will fail if the user is not authenticated.
• PERMIT_HREF (default true); permitting remote scripts when false remote script references are ignored. Apart from this, installation of this plugin on a wiki permits any and all user-written Groovy scripts to run on any wiki page, with no other security restrictions. This obviously incurs huge security risks, hence it's NOT RECOMMENDED FOR PUBLIC WIKIS.

  Since:

  2.5.x

  Author:

  Murray Altheim

  Field Summary

  protected static boolean	CHECK_AUTHENTICATION If true, check to see that user is authenticated.
  static String	PARAM_HREF When enabled by PERMIT_HREF, permits remote script invocation.
  protected static boolean	PERMIT_HREF If true, permit remote scripts via the href parameter.

  Fields inherited from interface com.ecyrd.jspwiki.plugin.WikiPlugin

  CORE_PLUGINS_RESOURCEBUNDLE

  Constructor Summary

  Groovy()
  

  Method Summary

  String	execute(WikiContext context, Map params)
  void	message(String message) Write the contents of the String message to the output.
  void	warning(String message) Write the contents of the String message to the output as a warning message.

  Methods inherited from class java.lang.Object

  clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

  Field Detail

  PARAM_HREF

  public static final String PARAM_HREF

  When enabled by PERMIT_HREF, permits remote script invocation.

  See Also:

  Constant Field Values

  CHECK_AUTHENTICATION

  protected static final boolean CHECK_AUTHENTICATION

  If true, check to see that user is authenticated. The value is false.

  See Also:

  Constant Field Values

  PERMIT_HREF

  protected static final boolean PERMIT_HREF

  If true, permit remote scripts via the href parameter. If false, remote script references are ignored. The value is true.

  See Also:

  Constant Field Values

  Constructor Detail

  Groovy

  public Groovy()

  Method Detail

  execute

  public String execute(WikiContext context,
                        Map params)
                 throws PluginException

  Specified by:

  execute in interface WikiPlugin

  Throws:

  PluginException

  message

  public void message(String message)

  Write the contents of the String message to the output. This is not displayed if 'debug' is false, though written to the log in any case. The message is appended with a line break (<br>) element.

  warning

  public void warning(String message)

  Write the contents of the String message to the output as a warning message.

  The message is contained within a paragraph with a 'warning' class.