buildrelease

[openafs-wiki.git] / TWiki / TWikiPluginsDotPm.mdwn

# <a name="Package &lt;code&gt;TWiki::Plugins="></a> Package =TWiki::Plugins

This module defines the singleton object that handles Plugins loading, initialization and execution.

This class uses Chain of Responsibility (GOF) pattern to dispatch handler calls to registered plugins.

<div>
  <ul>
    <li><a href="#Package =TWiki::Plugins="> Package TWiki::Plugins</a><ul>
        <li><a href="#PUBLIC constant $VERSION"> PUBLIC constant $VERSION</a></li>
        <li><a href="#PUBLIC $SESSION"> PUBLIC $SESSION</a></li>
        <li><a href="#ClassMethod <strong>new</strong> ($session)"> ClassMethod new <tt>($session)</tt></a></li>
        <li><a href="#ObjectMethod <strong>load</strong> ($allDisable"> ObjectMethod load <tt>($allDisabled) -&gt; $loginName</tt></a></li>
        <li><a href="#ObjectMethod <strong>enable</strong> ()"> ObjectMethod enable <tt>()</tt></a></li>
        <li><a href="#ObjectMethod *get_PluginVersion*"> ObjectMethod getPluginVersion <tt>() -&gt; $number</tt></a></li>
        <li><a href="#ObjectMethod <strong>addListener</strong> ($com"> ObjectMethod addListener <tt>($command,$handler)</tt></a></li>
        <li><a href="#ObjectMethod <strong>have_HandlerFor</strong> ("> ObjectMethod haveHandlerFor <tt>($handlerName) -&gt; $boolean</tt></a></li>
        <li><a href="#ObjectMethod *registrationHandle"> ObjectMethod registrationHandler <tt>()</tt></a></li>
        <li><a href="#ObjectMethod *before_CommonTagsH"> ObjectMethod beforeCommonTagsHandler <tt>()</tt></a></li>
        <li><a href="#ObjectMethod *common_TagsHandler"> ObjectMethod commonTagsHandler <tt>()</tt></a></li>
        <li><a href="#ObjectMethod *after_CommonTagsHa"> ObjectMethod afterCommonTagsHandler <tt>()</tt></a></li>
        <li><a href="#ObjectMethd pre_RenderingHandler"> ObjectMethd preRenderingHandler( $text, \%map )</a></li>
      </ul>
    </li>
  </ul>
</div>

Note that as of version 1.026 of this module, TWiki internal methods are _no longer available_ to plugins. Any calls to TWiki internal methods must be replaced by calls via the $SESSION object in this package, or via the Func package. For example, the call:

my $pref = TWiki::getPreferencesValue('URGH');

should be replaced with

my $pref = TWiki::Func::getPreferencesValue('URGH');

and the call

my $t = TWiki::writeWarning($message);

should be replaced with

my $pref = $TWiki::Plugins::SESSION-&gt;writeWarning($message);

Methods in other modules such as Store must be accessed through the relevant TWiki sub-object, for example

TWiki::Store::saveTopic(...)

should be replaced with

$TWiki::Plugins::SESSION-&gt;\{store\}-&gt;saveTopic(...)

Note that calling TWiki internal methods is very very bad practice, and should be avoided wherever practical.

The developers of TWiki reserve the right to change internal methods without warning, unless those methods are clearly marked as PUBLIC. PUBLIC methods are part of the core specification of a module and can be trusted.

## <a name="PUBLIC constant $VERSION"></a> PUBLIC constant $VERSION

This is the version number of the plugins package. Use it for checking if you have a recent enough version.

## <a name="PUBLIC $SESSION"></a> PUBLIC $SESSION

This is a reference to the TWiki session object. It can be used in plugins to get at the methods of the TWiki kernel.

You are _highly_ recommended to only use the methods in the [[Func|Main/TWikiFuncDotPm]] interface, unless you have no other choice, as kernel methods may change between TWiki releases.

## <a name="ClassMethod &lt;strong&gt;new&lt;/strong&gt; ($session)"></a> [[ClassMethod]] **new** `($session)`

Construct new singleton plugins collection object. The object is a container for a list of plugins and the handlers registered by the plugins. The plugins and the handlers are carefully ordered.

## <a name="ObjectMethod &lt;strong&gt;load&lt;/strong&gt; ($allDisable"></a> [[ObjectMethod]] **load** `($allDisabled) -> $loginName`

Find all active plugins, and invoke the early initialisation. Has to be done _after_ prefs are read.

Returns the user returned by the last `initializeUserHandler` to be called.

If allDisabled is set, no plugin handlers will be called.

## <a name="ObjectMethod &lt;strong&gt;enable&lt;/strong&gt; ()"></a> [[ObjectMethod]] **enable** `()`

Initialisation that is done after the user is known.

## <a name="ObjectMethod &lt;strong&gt;get_PluginVersion*"></a> [[ObjectMethod]] \*getPluginVersion `() -> $number`

Returns the $TWiki::Plugins::VERSION number if no parameter is specified, else returns the version number of a named Plugin. If the Plugin cannot be found or is not active, 0 is returned.

## <a name="ObjectMethod &lt;strong&gt;addListener&lt;/strong&gt; ($com"></a> [[ObjectMethod]] **addListener** `($command,$handler)`

- =$command\* - name of the event
- `$handler` - the handler object.

Add a listener to the end of the list of registered listeners for this event. The listener must implement `invoke($command,...)`, which will be triggered when the event is to be processed.

## <a name="ObjectMethod &lt;strong&gt;have_HandlerFor&lt;/strong&gt; ("></a> [[ObjectMethod]] **haveHandlerFor** `($handlerName) -> $boolean`

- `$handlerName` - name of the handler e.g. preRenderingHandler

Return: true if at least one plugin has registered a handler of this type.

## <a name="ObjectMethod &lt;strong&gt;registrationHandle"></a> [[ObjectMethod]] \*registrationHandler `()`

Called by the register script

## <a name="ObjectMethod &lt;strong&gt;before_CommonTagsH"></a> [[ObjectMethod]] \*beforeCommonTagsHandler `()`

Called at the beginning (for cache Plugins only)

## <a name="ObjectMethod &lt;strong&gt;common_TagsHandler"></a> [[ObjectMethod]] \*commonTagsHandler `()`

Called after %INCLUDE:"..."%

## <a name="ObjectMethod &lt;strong&gt;after_CommonTagsHa"></a> [[ObjectMethod]] \*afterCommonTagsHandler `()`

Called at the end (for cache Plugins only)

## <a name="ObjectMethd pre_RenderingHandler"></a> [[ObjectMethd]] preRenderingHandler( $text, \\%map )

- `$text` - the text, with the head, verbatim and pre blocks replaced with placeholders
- `\%removed` - reference to a hash that maps the placeholders to the removed blocks.

Placeholders are text strings constructed using the tag name and a sequence number e.g. 'pre1', "verbatim6", "head1" etc. Placeholders are inserted into the text inside \\1 characters so the text will contain \\1\_pre1\\1 for placeholder pre1.

Each removed block is represented by the block text and the parameters passed to the tag (usually empty) e.g. for

    <pre class='slobadob'>
    XYZ
    </pre>
    the map will contain:
    <pre>
    $removed->{'pre1'}{text}:   XYZ
    $removed->{'pre1'}{params}: class="slobadob"
    </pre>

    Iterating over blocks for a single tag is easy. For example, to prepend a line number to every line of a pre block you might use this code:

    foreach my $placeholder ( keys %$map ) {
        if( $placeholder =~ /^pre/i ) {
           my $n = 1;
           $map->{$placeholder}{text} =~ s/^/$n++/gem;
        }
    }

    ---++ ObjectMethod *postRenderingHandler* <tt>(\$text)</tt>

       * =\$text= - a reference to the HTML, with the head, verbatim and pre blocks replaced with placeholders

    ---++ ObjectMethod *startRenderingHandler* <tt>()</tt>

    Called just before the line loop

    *DEPRECATED* Use preRenderingHandler instead. This handler correctly
    handles verbatim and other TWiki ML block types, and exposes them to
    the plugin.

    ---++ ObjectMethod *outsidePREHandler* <tt>()</tt>

    Called in line loop outside of &lt;PRE&gt; tag

    *DEPRECATED* Use preRenderingHandler instead.
    This handler correctly handles pre and other
    TWiki ML block types, and is called only once
    instead of line-by-line.

    ---++ ObjectMethod *insidePREHandler* <tt>()</tt>

    Called in line loop inside of &lt;PRE&gt; tag

    *DEPRECATED* Use preRenderingHandler instead.
    This handler correctly handles pre and other
    TWiki ML block types, and is called only once
    instead of line-by-line.

    ---++ ObjectMethod *endRenderingHandler* <tt>()</tt>

    Called just after the line loop

    *DEPRECATED* Use postRenderingHandler instead.

    ---++ ObjectMethod *beforeEditHandler* <tt>()</tt>

    Called by edit

    ---++ ObjectMethod *afterEditHandler* <tt>()</tt>

    Called by edit

    ---++ ObjectMethod *beforeSaveHandler* <tt>()</tt>

    Called just before the save action

    ---++ ObjectMethod *afterSaveHandler* <tt>()</tt>

    Called just after the save action

    ---++ ObjectMethod *mergeHandler* <tt>()</tt>

    Called to handle text merge.

    ---++ ObjectMethod *beforeAttachmentSaveHandler* <tt>($attrHashRef,$topic,$web)</tt>

    This code provides Plugins with the opportunity to alter an uploaded attachment between the upload and save-to-store processes. It is invoked as per other Plugins.
       * =$attrHashRef= - Hash reference of attachment attributes (keys are indicated below)
       * =$topic= -     | Topic name
       * =$web= -       | Web name

    Keys in $attrHashRef:
    | *Key*       | *Value* |
    | attachment  | Name of the attachment |
    | tmpFilename | Name of the local file that stores the upload |
    | comment     | Comment to be associated with the upload |
    | user        | Login name of the person submitting the attachment, e.g. 'jsmith' |

    Note: All keys should be used read-only, except for comment which can be modified.

    Example usage:

    <pre>
       my( $attrHashRef, $topic, $web ) = @_;
       $$attrHashRef{'comment'} .= " (NOTE: Extracted from blah.tar.gz)";
    </pre>

    ---++ ObjectMethod *afterAttachmentSaveHandler* <tt>($attachmentAttrHash,$topic,$web,$error)</tt>

    deal with an uploaded attachment between the upload and save-to-store processes. It is invoked as per other plugins.

       * =$attrHashRef= - Hash reference of attachment attributes (keys are indicated below)
       * =$topic= -     | Topic name
       * =$web= -       | Web name
       * =$error= -     | Error string of save action, empty if OK

    Keys in $attrHashRef:
    | *Key*       | *Value* |
    | attachment  | Name of the attachment |
    | tmpFilename | Name of the local file that stores the upload |
    | comment     | Comment to be associated with the upload |
    | user        | Login name of the person submitting the attachment, e.g. 'jsmith' |

    Note: The hash is *read-only*

    ---++ ObjectMethod *writeHeaderHandler* <tt>() -> $headers</tt>

    Called by TWiki::writePageHeader. *DEPRECATED* do not use!

    *DEPRECATED* Use modifyHeaderHandler instead. it is a lot
    more flexible, and allows you to modify existing headers
    as well as add new ones. It also works correctly when
    multiple plugins want to modify headers.

    ---++ ObjectMethod *modifyHeaderHandler* <tt>(\@headers,$query)</tt>

    ---++ ObjectMethod *redirectCgiQueryHandler* <tt>() -> $result</tt>

    Called by TWiki::redirect

    ---++ ObjectMethod *renderFormFieldForEditHandler* <tt>($name,$type,$size,$value,$attributes,$possibleValues) -> $html</tt>

    This handler is called before built-in types are considered. It generates the HTML text rendering this form field, or false, if the rendering should be done by the built-in type handlers.
       * =$name= - name of form field
       * =$type= - type of form field
       * =$size= - size of form field
       * =$value= - value held in the form field
       * =$attributes= - attributes of form field
       * =$possibleValues= - the values defined as options for form field, if any. May be a scalar (one legal value) or an array (several legal values)
    Return HTML text that renders this field. If false, form rendering continues by considering the built-in types.

    Note that a common application would be to generate formatting of the
    field involving generation of javascript. Such usually also requires
    the insertion of some common javascript into the page header. Unfortunately,
    there is currently no mechanism to pass that script to where the header of
    the page is visible. Consequentially, the common javascript may have to
    be emitted as part of the field formatting and might be duplicated many
    times throughout the page.

    ---++ ObjectMethod *renderWikiWordHandler* <tt>() -> $result</tt>

    Change how a WikiWord is rendered

    Originated from the TWiki:Plugins.SpacedWikiWordPlugin hack