Package =TWiki::Func

<-- STARTINCLUDE required for huge TWikiDocumentation topic -->

Official list of stable TWiki functions for Plugin developers

This module defines official functions that TWiki plugins can use to interact with the TWiki engine and content.

Refer to EmptyPlugin and lib/TWiki/Plugins/EmptyPlugin.pm for a template plugin and documentation on how to write a plugin.

Plugins should only use functions published in this module. If you use functions in other TWiki libraries you might create a security hole and you will probably need to change your plugin when you upgrade TWiki.

Deprecated functions will still work in older code, though they should not be called in new plugins and should be replaced in older plugins as soon as possible.

The version of the TWiki::Func module is defined by the VERSION number of the TWiki::Plugins module, currently 6.10. This can be shown by the %PLUGINVERSION% TWiki variable, and accessed in code using $TWiki::Plugins::VERSION. The 'Since' field in the function documentation refers to $TWiki::Plugins::VERSION.

• TWiki::Plugins::VERSION also applies to the plugin handlers. The handlers are documented in the EmptyPlugin, and that module indicates what version of TWiki::Plugins::VERSION it relates to.

A full history of the changes to this API can be found at the end of this topic.

Environment

getSkin( ) -> $skin

Get the skin path, set by the SKIN and COVER preferences variables or the skin and cover CGI parameters

Return: $skin Comma-separated list of skins, e.g. 'gnu,tartan'. Empty string if none.

Since: TWiki::Plugins::VERSION 1.000 (29 Jul 2001)

getUrlHost( ) -> $host

Get protocol, domain and optional port of script URL

Return: $host URL host, e.g. "http://example.com:80"

Since: TWiki::Plugins::VERSION 1.000 (7 Dec 2002)

getScriptUrl( $web, $topic, $script, ... ) -> $url

Compose fully qualified URL

• $web - Web name, e.g. 'Main'
• $topic - Topic name, e.g. 'WebNotify'
• $script - Script name, e.g. 'view'
• ... - an arbitrary number of name=>value parameter pairs that will be url-encoded and added to the url. The special parameter name '#' is reserved for specifying an anchor. e.g. getScriptUrl('x','y','view','#'=>'XXX',a=>1,b=>2) will give .../view/x/y?a=1&b=2#XXX

Return: $url URL, e.g. "http://example.com:80/cgi-bin/view.pl/Main/WebNotify"

Since: TWiki::Plugins::VERSION 1.000 (7 Dec 2002)

getViewUrl( $web, $topic ) -> $url

Compose fully qualified view URL

• $web - Web name, e.g. 'Main'. The current web is taken if empty
• $topic - Topic name, e.g. 'WebNotify'

Since: TWiki::Plugins::VERSION 1.000 (7 Dec 2002)

getPubUrlPath( ) -> $path

Get pub URL path

Return: $path URL path of pub directory, e.g. "/pub"

Since: TWiki::Plugins::VERSION 1.000 (14 Jul 2001)

Note that the $url may have an optional user and password, as specified by the relevant RFC. Any proxy set in configure is honored.

Note that if LWP is not available, this function:

1. can only really be trusted for HTTP/1.0 urls. If HTTP/1.1 or another protocol is required, you are strongly recommended to require LWP.
2. Will not parse multipart content

In the event of the server returning an error, then is_error() will return true, code() will return a valid HTTP status code as specified in RFC 2616 and RFC 2518, and message() will return the message that was received from the server. In the event of a client-side error (e.g. an unparseable URL) then is_error() will return true and message() will return an explanatory message. code() will return 400 (BAD REQUEST).

Note: Callers can easily check the availability of other HTTP::Response methods as follows:

my $response = TWiki::Func::getExternalResource($url);
if (!$response->is_error() && $response->isa('HTTP::Response')) {
    $text = $response->content();
    # ... other methods of HTTP::Response may be called
} else {
    # ... only the methods listed above may be called
}

Since: TWiki::Plugins::VERSION 1.2

getCgiQuery( ) -> $query

Get CGI query object. Important: Plugins cannot assume that scripts run under CGI, Plugins must always test if the CGI query object is set

Return: $query CGI query object; or 0 if script is called as a shell script

Since: TWiki::Plugins::VERSION 1.000 (7 Dec 2002)

@keys"> getSessionKeys() -> @keys

Session keys are stored and retrieved using setSessionValue and getSessionValue.

Since: TWiki::Plugins::VERSION 1.2

getSessionValue( $key ) -> $value

Get a session value from the client session module

• $key - Session key

Since: TWiki::Plugins::VERSION 1.000 (27 Feb 200)

setSessionValue( $key, $value ) -> $boolean

Set a session value.

• $key - Session key
• $value - Value associated with key

Since: TWiki::Plugins::VERSION 1.000 (17 Aug 2001)

clearSessionValue( $key ) -> $boolean

Clear a session value that was set using setSessionValue.

• $key - name of value stored in session to be cleared. Note that you cannot clear AUTHUSER.

Since: TWiki::Plugins::VERSION 1.1

getContext() -> \%hash

Get a hash of context identifiers representing the currently active context.

The context is a set of identifiers that are set during specific phases of TWiki processing. For example, each of the standard scripts in the 'bin' directory each has a context identifier - the view script has 'view', the edit script has 'edit' etc. So you can easily tell what 'type' of script your Plugin is being called within. The core context identifiers are listed in the IfStatements topic. Please be careful not to overwrite any of these identifiers!

Context identifiers can be used to communicate between Plugins, and between Plugins and templates. For example, in FirstPlugin.pm, you might write:

sub initPlugin {
   TWiki::Func::getContext()->{'MyID'} = 1;
   ...

sub initPlugin {
   if( TWiki::Func::getContext()->{'MyID'} ) {
      ...
   }
   ...

%TMPL:DEF{"ON"}% Not off %TMPL:END%
%TMPL:DEF{"OFF"}% Not on %TMPL:END%
%TMPL:P{context="MyID" then="ON" else="OFF"}%

%IF{"context MyID" then="MyID is ON" else="MyID is OFF"}%

Since: TWiki::Plugins::VERSION 1.1

pushTopicContext($web, $topic)

• $web - new web
• $topic - new topic

It is the duty of the caller to restore the original context by calling popTopicContext.

Note that this call does not re-initialise plugins, so if you have used global variables to remember the web and topic in initPlugin, then those values will be unchanged.

Since: TWiki::Plugins::VERSION 1.2

popTopicContext()

Returns the TWiki context to the state it was in before the pushTopicContext was called.

Since: TWiki::Plugins::VERSION 1.2

Preferences

getPreferencesValue( $key, $web ) -> $value

Get a preferences value from TWiki or from a Plugin

• $key - Preferences key
• $web - Name of web, optional. Current web if not specified; does not apply to settings of Plugin topics

Since: TWiki::Plugins::VERSION 1.000 (7 Dec 2002)

• Example for Plugin setting:

• • Use "MYPLUGIN_COLOR" for $key
  • my $color = TWiki::Func::getPreferencesValue( "MYPLUGIN_COLOR" );

• Example for preferences setting:
  • WebPreferences topic has: * Set WEBBGCOLOR = #FFFFC0
  • my $webColor = TWiki::Func::getPreferencesValue( 'WEBBGCOLOR', 'Sandbox' );

NOTE: As of TWiki-4.1, if $NO_PREFS_IN_TOPIC is enabled in the plugin, then preferences set in the plugin topic will be ignored.

getPluginPreferencesValue( $key ) -> $value

Get a preferences value from your Plugin

• $key - Plugin Preferences key w/o PLUGINNAME_ prefix.

Note: This function will will only work when called from the Plugin.pm file itself. it will not work if called from a sub-package (e.g. TWiki::Plugins::MyPlugin::MyModule)

Since: TWiki::Plugins::VERSION 1.021 (27 Mar 2004)

NOTE: As of TWiki-4.1, if $NO_PREFS_IN_TOPIC is enabled in the plugin, then preferences set in the plugin topic will be ignored.

getPreferencesFlag( $key, $web ) -> $value

Get a preferences flag from TWiki or from a Plugin

• $key - Preferences key
• $web - Name of web, optional. Current web if not specified; does not apply to settings of Plugin topics

Since: TWiki::Plugins::VERSION 1.000 (7 Dec 2002)

• Example for Plugin setting:

• • Use "MYPLUGIN_SHOWHELP" for $key
  • my $showHelp = TWiki::Func::getPreferencesFlag( "MYPLUGIN_SHOWHELP" );

NOTE: As of TWiki-4.1, if $NO_PREFS_IN_TOPIC is enabled in the plugin, then preferences set in the plugin topic will be ignored.

getPluginPreferencesFlag( $key ) -> $boolean

Get a preferences flag from your Plugin

• $key - Plugin Preferences key w/o PLUGINNAME_ prefix.

Note: This function will will only work when called from the Plugin.pm file itself. it will not work if called from a sub-package (e.g. TWiki::Plugins::MyPlugin::MyModule)

Since: TWiki::Plugins::VERSION 1.021 (27 Mar 2004)

NOTE: As of TWiki-4.1, if $NO_PREFS_IN_TOPIC is enabled in the plugin, then preferences set in the plugin topic will be ignored.

setPreferencesValue($name, $val)

Set the preferences value so that future calls to getPreferencesValue will return this value, and %$name% will expand to the preference when used in future variable expansions.

The preference only persists for the rest of this request. Finalised preferences cannot be redefined using this function.

Returns 1 if the preference was defined, and 0 otherwise.

getWikiToolName( ) -> $name

Get toolname as defined in TWiki.cfg

Return: $name Name of tool, e.g. 'TWiki'

Since: TWiki::Plugins::VERSION 1.000 (27 Feb 2001)

getMainWebname( ) -> $name

Get name of Main web as defined in TWiki.cfg

Return: $name Name, e.g. 'Main'

Since: TWiki::Plugins::VERSION 1.000 (27 Feb 2001)

getTwikiWebname( ) -> $name

Get name of TWiki documentation web as defined in TWiki.cfg

Return: $name Name, e.g. 'TWiki'

Since: TWiki::Plugins::VERSION 1.000 (27 Feb 2001)

User Handling and Access Control

getDefaultUserName( ) -> $loginName

Return: $loginName Default user name, e.g. 'guest'

Since: TWiki::Plugins::VERSION 1.000 (7 Dec 2002)

getCanonicalUserID( $user ) -> $cUID

• $user can be a login, wikiname or web.wikiname

If $user is undefined, it assumes the currently logged-in user.

Return: $cUID, an internal unique and portable escaped identifier for registered users. This may be autogenerated for an authenticated but unregistered user.

Since: TWiki::Plugins::VERSION 1.2

getWikiName( $user ) -> $wikiName

return the WikiName of the specified user if $user is undefined Get Wiki name of logged in user

• $user can be a cUID, login, wikiname or web.wikiname

Return: $wikiName Wiki Name, e.g. 'JohnDoe'

Since: TWiki::Plugins::VERSION 1.000 (7 Dec 2002)

getWikiUserName( $user ) -> $wikiName

return the userWeb.WikiName of the specified user if $user is undefined Get Wiki name of logged in user

• $user can be a cUID, login, wikiname or web.wikiname

Return: $wikiName Wiki Name, e.g. "Main.JohnDoe"

Since: TWiki::Plugins::VERSION 1.000 (7 Dec 2002)

wikiToUserName( $id ) -> $loginName

• $id - Wiki name, e.g. 'Main.JohnDoe' or 'JohnDoe'. Since TWiki 4.2.1, $id may also be a login name. This will normally be transparent, but should be borne in mind if you have login names that are also legal wiki names.

Return: $loginName Login name of user, e.g. 'jdoe', or undef if not matched.

Note that it is possible for several login names to map to the same wikiname. This function will only return the first login name that maps to the wikiname.

returns undef if the WikiName is not found.

Since: TWiki::Plugins::VERSION 1.000 (7 Dec 2002)

userToWikiName( $loginName, $dontAddWeb ) -> $wikiName

• $loginName - Login name, e.g. 'jdoe'. Since TWiki 4.2.1 this may also be a wiki name. This will normally be transparent, but may be relevant if you have login names that are also valid wiki names.
• $dontAddWeb - Do not add web prefix if "1"

userToWikiName will always return a name. If the user does not exist in the mapping, the $loginName parameter is returned. (backward compatibility)

Since: TWiki::Plugins::VERSION 1.000 (7 Dec 2002)

emailToWikiNames( $email, $dontAddWeb ) -> @wikiNames

• $email - email address to look up
• $dontAddWeb - Do not add web prefix if "1"

Since: TWiki::Plugins::VERSION 1.2

@em"> wikinameToEmails( $user ) -> @emails

• $user - wikiname of user to look up

Since TWiki 4.2.1, $user may also be a login name, or the name of a group.

Since: TWiki::Plugins::VERSION 1.2

isGuest( ) -> $boolean

isGroupMember( $group, $id ) -> $boolean

Find out if $id is in the named group. e.g.

if( TWiki::Func::isGroupMember( "HesperionXXGroup", "jordi" )) {
    ...
}

• $id can be a login name or a WikiName

Since: TWiki::Plugins::VERSION 1.2

eachUser() -> $iterator

Use it as follows:

    my $iterator = TWiki::Func::eachUser();
    while ($it->hasNext()) {
        my $user = $it->next();
        # $user is a wikiname
    }

WARNING on large sites, this could be a long list!

Since: TWiki::Plugins::VERSION 1.2

eachMembership($id) -> $iterator

• $id - WikiName or login name of the user. If $id is undef, defaults to the currently logged-in user.

Since: TWiki::Plugins::VERSION 1.2

eachGroup() -> $iterator

Use it as follows:

    my $iterator = TWiki::Func::eachGroup();
    while ($it->hasNext()) {
        my $group = $it->next();
        # $group is a group name e.g. TWikiAdminGroup
    }

WARNING on large sites, this could be a long list!

Since: TWiki::Plugins::VERSION 1.2

isGroup( $group ) -> $boolean

Checks if $group is the name of a group known to TWiki.

eachGroupMember($group) -> $iterator

Use it as follows:

    my $iterator = TWiki::Func::eachGroupMember('RadioheadGroup');
    while ($it->hasNext()) {
        my $user = $it->next();
        # $user is a wiki name e.g. 'TomYorke', 'PhilSelway'
    }

WARNING on large sites, this could be a long list!

Since: TWiki::Plugins::VERSION 1.2

checkAccessPermission( $type, $id, $text, $topic, $web, $meta ) -> $boolean

Check access permission for a topic based on the TWiki.TWikiAccessControl rules

• $type - Access type, required, e.g. 'VIEW', 'CHANGE'.
• $id - WikiName of remote user, required, e.g. "PeterThoeny". From TWiki 4.2.1, $id may also be a login name. If $id is '', 0 or undef then access is always permitted.
• $text - Topic text, optional. If 'perl false' (undef, 0 or ''), topic $web.$topic is consulted. $text may optionally contain embedded %META:PREFERENCE tags. Provide this parameter if:
  1. You are setting different access controls in the text to those defined in the stored topic,
  2. You already have the topic text in hand, and want to help TWiki avoid having to read it again,
  3. You are providing a $meta parameter.
• $topic - Topic name, required, e.g. 'PrivateStuff'
• $web - Web name, required, e.g. 'Sandbox'
• $meta - Meta-data object, as returned by readTopic. Optional. If undef, but $text is defined, then access controls will be parsed from $text. If defined, then metadata embedded in $text will be ignored. This parameter is always ignored if $text is undefined. Settings in $meta override Set settings in $text.

Note the weird parameter order is due to compatibility constraints with earlier TWiki releases.

Tip if you want, you can use this method to check your own access control types. For example, if you:

Since: TWiki::Plugins::VERSION 1.000 (27 Feb 2001)

Webs, Topics and Attachments

@web"> getListOfWebs( $filter ) -> @webs

• $filter - spec of web types to recover

1. 'user' (for only user webs)
2. 'template' (for only template webs i.e. those starting with "_")

For example, the deprecated getPublicWebList function can be duplicated as follows:

   my @webs = TWiki::Func::getListOfWebs( "user,public" );

Since: TWiki::Plugins::VERSION 1.1

webExists( $web ) -> $boolean

Test if web exists

• $web - Web name, required, e.g. 'Sandbox'

Since: TWiki::Plugins::VERSION 1.000 (14 Jul 2001)

isValidWebName( $name, $templateWeb ) -> $boolean

Check for a valid web name.

• $name - web name
• $templateWeb - flag, optional. If true, then template web names (starting with _) are considered valid, otherwise only user web names are valid.

If $TWiki::cfg{EnableHierarchicalWebs} is off, it will also return false when a nested web name is passed to it.

Since: TWiki::Plugins::VERSION 1.4

createWeb( $newWeb, $baseWeb, $opts )

• $newWeb is the name of the new web.
• $baseWeb is the name of an existing web (a template web). If the base web is a system web, all topics in it will be copied into the new web. If it is a normal web, only topics starting with 'Web' will be copied. If no base web is specified, an empty web (with no topics) will be created. If it is specified but does not exist, an error will be thrown.
• $opts is a ref to a hash that contains settings to be modified in

use Error qw( :try );
use TWiki::AccessControlException;

try {
    TWiki::Func::createWeb( "Newweb" );
} catch Error::Simple with {
    my $e = shift;
    # see documentation on Error::Simple
} catch TWiki::AccessControlException with {
    my $e = shift;
    # see documentation on TWiki::AccessControlException
} otherwise {
    ...
};

Since: TWiki::Plugins::VERSION 1.1

moveWeb( $oldName, $newName )

Move (rename) a web.

use Error qw( :try );
use TWiki::AccessControlException;

try {
    TWiki::Func::moveWeb( "Oldweb", "Newweb" );
} catch Error::Simple with {
    my $e = shift;
    # see documentation on Error::Simple
} catch TWiki::AccessControlException with {
    my $e = shift;
    # see documentation on TWiki::AccessControlException
} otherwise {
    ...
};

To delete a web, move it to a subweb of Trash

TWiki::Func::moveWeb( "Deadweb", "Trash.Deadweb" );

Since: TWiki::Plugins::VERSION 1.1

eachChangeSince($web, $time) -> $iterator

Get an iterator over the list of all the changes in the given web between $time and now. $time is a time in seconds since 1st Jan 1970, and is not guaranteed to return any changes that occurred before (now - {Store}{RememberChangesFor}). {Store}{RememberChangesFor}) is a setting in configure. Changes are returned in most-recent-first order.

Use it as follows:

    my $iterator = TWiki::Func::eachChangeSince(
        $web, time() - 7 * 24 * 60 * 60); # the last 7 days
    while ($iterator->hasNext()) {
        my $change = $iterator->next();
        # $change is a perl hash that contains the following fields:
        # topic => topic name
        # user => wikiname - wikiname of user who made the change
        # time => time of the change
        # revision => revision number *after* the change
        # more => more info about the change (e.g. 'minor')
    }

@topics"> getTopicList( $web ) -> @topics

Get list of all topics in a web

• $web - Web name, required, e.g. 'Sandbox'

Since: TWiki::Plugins::VERSION 1.000 (7 Dec 2002)

topicExists( $web, $topic ) -> $boolean

Test if topic exists.

• $web - Web name, optional, e.g. 'Main'.
• $topic - Topic name, required, e.g. 'TokyoOffice', or "Main.TokyoOffice"

$web and $topic are parsed as described in the documentation for normalizeWebTopicName. Specifically, the Main is used if $web is not specified and $topic has no web specifier. To get an expected behaviour it is recommened to specify the current web for $web; don't leave it empty.

Since: TWiki::Plugins::VERSION 1.000 (14 Jul 2001)

isValidTopicName( $name ) -> $boolean

Check for a valid topic name. Names considerd valid for autolinking are WikiWords (such as 'SanFrancisco') and acronym (such as 'SWMBO').

• $name - topic name

Since: TWiki::Plugins::VERSION 1.4

checkTopicEditLock( $web, $topic, $script ) -> ( $oopsUrl, $loginName, $unlockTime )

Check if a lease has been taken by some other user.

• $web Web name, e.g. "Main", or empty
• $topic Topic name, e.g. "MyTopic", or "Main.MyTopic"

• $script The script to invoke when continuing with the edit

Since: TWiki::Plugins::VERSION 1.010 (31 Dec 2002)

setTopicEditLock( $web, $topic, $lock )

• $web Web name, e.g. "Main", or empty
• $topic Topic name, e.g. "MyTopic", or "Main.MyTopic"
• $lock 1 to lease the topic, 0 to clear an existing lease

Takes out a "lease" on the topic. The lease doesn't prevent anyone from editing and changing the topic, but it does redirect them to a warning screen, so this provides some protection. The edit script always takes out a lease.

It is impossible to fully lock a topic. Concurrent changes will be merged.

Since: TWiki::Plugins::VERSION 1.010 (31 Dec 2002)

saveTopic( $web, $topic, $meta, $text, $options ) -> $error

• $web - web for the topic
• $topic - topic name
• $meta - reference to TWiki::Meta object
• $text - text of the topic (without embedded meta-data!!!
• \%options - ref to hash of save options \%options may include:

  dontlog	don't log this change in twiki log
  forcenewrevision	force the save to increment the revision counter
  minor	True if this is a minor change, and is not to be notified

Since: TWiki::Plugins::VERSION 1.000 (29 Jul 2001)

Example:

    # read topic:
    my( $topicMeta, $topicText ) = TWiki::Func::readTopic( $web, $topic )
    # example to change topic text:
    $topicText =~ s/APPLE/ORANGE/g;
    # example to change TWiki form field:
    my $field = $topicMeta->get( 'FIELD', 'Title' );
    if( $field ) {
        $field->{value} = $newTitle;
        $topicMeta->putKeyed( 'FIELD', $field );
    }
    # save updated topic:
    TWiki::Func::saveTopic( $web, $topic, $topicMeta, $topicText, { forcenewrevision => 1 } );

Note: Plugins handlers ( e.g. beforeSaveHandler ) will be called as appropriate.

saveTopicText( $web, $topic, $text, $ignorePermissions, $dontNotify ) -> $oopsUrl

Save topic text, typically obtained by readTopicText(). Topic data usually includes meta data; the file attachment meta data is replaced by the meta data from the topic file if it exists.

• $web - Web name, e.g. 'Main', or empty
• $topic - Topic name, e.g. 'MyTopic', or "Main.MyTopic"
• $text - Topic text to save, assumed to include meta data
• $ignorePermissions - Set to "1" if checkAccessPermission() is already performed and OK
• $dontNotify - Set to "1" if not to notify users of the change

This method is a lot less efficient and much more dangerous than saveTopic.

Since: TWiki::Plugins::VERSION 1.010 (31 Dec 2002)

my $text = TWiki::Func::readTopicText( $web, $topic );

# check for oops URL in case of error:
if( $text =~ /^http.*?\/oops/ ) {
    TWiki::Func::redirectCgiQuery( $query, $text );
    return;
}
# do topic text manipulation like:
$text =~ s/old/new/g;
# do meta data manipulation like:
$text =~ s/(META\:FIELD.*?name\=\"TopicClassification\".*?value\=\")[^\"]*/$1BugResolved/;
$oopsUrl = TWiki::Func::saveTopicText( $web, $topic, $text ); # save topic text

moveTopic( $web, $topic, $newWeb, $newTopic )

• $web source web - required
• $topic source topic - required
• $newWeb dest web
• $newTopic dest topic

The destination topic must not already exist.

Rename a topic to the $TWiki::cfg{TrashWebName} to delete it.

Since: TWiki::Plugins::VERSION 1.1

use Error qw( :try );

try {
    moveTopic( "Work", "TokyoOffice", "Trash", "ClosedOffice" );
} catch Error::Simple with {
    my $e = shift;
    # see documentation on Error::Simple
} catch TWiki::AccessControlException with {
    my $e = shift;
    # see documentation on TWiki::AccessControlException
} otherwise {
    ...
};

getRevisionInfo($web, $topic, $rev, $attachment ) -> ( $date, $user, $rev, $comment )

Get revision info of a topic or attachment

• $web - Web name, optional, e.g. 'Main'
• $topic - Topic name, required, e.g. 'TokyoOffice'
• $rev - revsion number, or tag name (can be in the format 1.2, or just the minor number)
• $attachment -attachment filename

NOTE: if you are trying to get revision info for a topic, use $meta->getRevisionInfo instead if you can - it is significantly more efficient.

Since: TWiki::Plugins::VERSION 1.000 (29 Jul 2001)

getRevisionAtTime( $web, $topic, $time ) -> $rev

Get the revision number of a topic at a specific time.

• $web - web for topic
• $topic - topic
• $time - time (in epoch secs) for the rev

Since: TWiki::Plugins::VERSION 1.1

readTopic( $web, $topic, $rev ) -> ( $meta, $text )

Read topic text and meta data, regardless of access permissions.

• $web - Web name, required, e.g. 'Main'
• $topic - Topic name, required, e.g. 'TokyoOffice'
• $rev - revision to read (default latest)

$meta is a perl 'object' of class TWiki::Meta. This class is fully documented in the source code documentation shipped with the release, or can be inspected in the lib/TWiki/Meta.pm file.

This method ignores topic access permissions. You should be careful to use checkAccessPermission to ensure the current user has read access to the topic.

See usage example at TWiki::Func::saveTopic.

Since: TWiki::Plugins::VERSION 1.000 (7 Dec 2002)

readTopicText( $web, $topic, $rev, $ignorePermissions ) -> $text

Read topic text, including meta data

• $web - Web name, e.g. 'Main', or empty
• $topic - Topic name, e.g. 'MyTopic', or "Main.MyTopic"
• $rev - Topic revision to read, optional. Specify the minor part of the revision, e.g. "5", not "1.5"; the top revision is returned if omitted or empty.
• $ignorePermissions - Set to "1" if checkAccessPermission() is already performed and OK; an oops URL is returned if user has no permission

This method is more efficient than readTopic, but returns meta-data embedded in the text. Plugins authors must be very careful to avoid damaging meta-data. You are recommended to use readTopic instead, which is a lot safer.

Since: TWiki::Plugins::VERSION 1.010 (31 Dec 2002)

attachmentExists( $web, $topic, $attachment ) -> $boolean

Test if attachment exists

• $web - Web name, optional, e.g. Main.
• $topic - Topic name, required, e.g. TokyoOffice, or Main.TokyoOffice
• $attachment - attachment name, e.g. logo.gif

Since: TWiki::Plugins::VERSION 1.1

readAttachment( $web, $topic, $name, $rev ) -> $data

• $web - web for topic
• $topic - topic
• $name - attachment name
• $rev - revision to read (default latest)

View permission on the topic is required for the read to be successful. Access control violations are flagged by a TWiki::AccessControlException. Permissions are checked for the current user.

my( $meta, $text ) = TWiki::Func::readTopic( $web, $topic );
my @attachments = $meta->find( 'FILEATTACHMENT' );
foreach my $a ( @attachments ) {
   try {
       my $data = TWiki::Func::readAttachment( $web, $topic, $a->{name} );
       ...
   } catch TWiki::AccessControlException with {
   };
}

Since: TWiki::Plugins::VERSION 1.1

saveAttachment( $web, $topic, $attachment, $opts )

• $web - web for topic
• $topic - topic to atach to
• $attachment - name of the attachment
• $opts - Ref to hash of options

Save an attachment to the store for a topic. On success, returns undef. If there is an error, an exception will be thrown.

    try {
        TWiki::Func::saveAttachment( $web, $topic, 'image.gif',
                                     { file => 'image.gif',
                                       comment => 'Picture of Health',
                                       hide => 1 } );
   } catch Error::Simple with {
      # see documentation on Error
   } otherwise {
      ...
   };

Since: TWiki::Plugins::VERSION 1.1

moveAttachment( $web, $topic, $attachment, $newWeb, $newTopic, $newAttachment )

• $web source web - required
• $topic source topic - required
• $attachment source attachment - required
• $newWeb dest web
• $newTopic dest topic
• $newAttachment dest attachment

The destination topic must already exist, but the destination attachment must not exist.

Rename an attachment to $TWiki::cfg{TrashWebName}.TrashAttament to delete it.

use Error qw( :try );

try {
   # move attachment between topics
   moveAttachment( "Countries", "Germany", "AlsaceLorraine.dat",
                     "Countries", "France" );
   # Note destination attachment name is defaulted to the same as source
} catch TWiki::AccessControlException with {
   my $e = shift;
   # see documentation on TWiki::AccessControlException
} catch Error::Simple with {
   my $e = shift;
   # see documentation on Error::Simple
};

Since: TWiki::Plugins::VERSION 1.1

Assembling Pages

readTemplate( $name, $skin ) -> $text

Read a template or skin. Embedded template directives get expanded

• $name - Template name, e.g. 'view'
• $skin - Comma-separated list of skin names, optional, e.g. 'print'

Since: TWiki::Plugins::VERSION 1.000 (7 Dec 2002)

loadTemplate ( $name, $skin, $web ) -> $text

• $name - template file name
• $skin - comma-separated list of skins to use (default: current skin)
• $web - the web to look in for topics that contain templates (default: current web)

Reads a template and extracts template definitions, adding them to the list of loaded templates, overwriting any previous definition.

How TWiki searches for templates is described in TWikiTemplates.

If template text is found, extracts include statements and fully expands them.

expandTemplate( $def ) -> $string

• $def - template name

Since: TWiki::Plugins::VERSION 1.1

writeHeader( )

Print a basic content-type HTML header for text/html to standard out. No return value.

Note: In TWiki versions earlier than TWiki::Plugins::VERSION 1.3, this function used to have $query and $contentLength parameters. Both were marked "you should not pass this parameter".

Since: TWiki::Plugins::VERSION 1.000 (7 Dec 2002)

• $query - CGI query object. Ignored, only there for compatibility. The session CGI query object is used instead.
• $url - URL to redirect to
• $passthru - enable passthrough.

Print output to STDOUT that will cause a 302 redirect to a new URL. Nothing more should be printed to STDOUT after this method has been called.

The $passthru parameter allows you to pass the parameters that were passed to the current query on to the target URL, as long as it is another URL on the same TWiki installation. If $passthru is set to a true value, then TWiki will save the current URL parameters, and then try to restore them on the other side of the redirect. Parameters are stored on the server in a cache file.

Note that if $passthru is set, then any parameters in $url will be lost when the old parameters are restored. if you want to change any parameter values, you will need to do that in the current CGI query before redirecting e.g.

my $query = TWiki::Func::getCgiQuery();
$query->param(-name => 'text', -value => 'Different text');
TWiki::Func::redirectCgiQuery(
  undef, TWiki::Func::getScriptUrl($web, $topic, 'edit'), 1);

Since: TWiki::Plugins::VERSION 1.000 (7 Dec 2002)

addToHEAD( $id, $header, $requires )

Adds $header to the HTML header (the tag).

• $id - Unique ID to prevent the same HTML from being duplicated. Plugins should use a prefix to prevent name clashes (e.g EDITTABLEPLUGIN_JSCALENDAR)
• $header - the HTML to be added to the section. The HTML must be valid in a HEAD tag - no checks are performed.

Note that this is not the same as the HTTP header, which is modified through the Plugins modifyHeaderHandler.

Since: TWiki::Plugins::VERSION 1.1

example:

TWiki::Func::addToHEAD('PATTERN_STYLE','<link id="twikiLayoutCss" rel="stylesheet" type="text/css" href="%PUBURL%/TWiki/PatternSkin/layout.css" media="all" />');

expandCommonVariables( $text, $topic, $web, $meta ) -> $text

Expand all common %VARIABLES%

• $text - Text with variables to expand, e.g. 'Current user is %WIKIUSER%'
• $topic - Current topic name, e.g. 'WebNotify'
• $web - Web name, optional, e.g. 'Main'. The current web is taken if missing
• $meta - topic meta-data to use while expanding (Since TWiki::Plugins::VERSION 1.2)

Since: TWiki::Plugins::VERSION 1.000 (7 Dec 2002)

See also: expandVariablesOnTopicCreation

renderText( $text, $web ) -> $text

Render text from TWiki markup into XHTML as defined in TWiki.TextFormattingRules

• $text - Text to render, e.g. '*bold* text and =fixed font='
• $web - Web name, optional, e.g. 'Main'. The current web is taken if missing

Since: TWiki::Plugins::VERSION 1.000 (7 Dec 2002)

internalLink( $pre, $web, $topic, $label, $anchor, $createLink ) -> $text

Render topic name and link label into an XHTML link. Normally you do not need to call this funtion, it is called internally by renderText()

• $pre - Text occuring before the TWiki link syntax, optional
• $web - Web name, required, e.g. 'Main'
• $topic - Topic name to link to, required, e.g. 'WebNotify'
• $label - Link label, required. Usually the same as $topic, e.g. 'notify'
• $anchor - Anchor, optional, e.g. '#Jump'
• $createLink - Set to '1' to add question linked mark after topic name if topic does not exist;
  set to '0' to suppress link for non-existing topics

Since: TWiki::Plugins::VERSION 1.000 (7 Dec 2002)

E-mail

sendEmail ( $text, $retries ) -> $error

• $text - text of the mail, including MIME headers
• $retries - number of times to retry the send (default 1)

To: liz@windsor.gov.uk
From: serf@hovel.net
CC: george@whitehouse.gov
Subject: Revolution

Dear Liz,

Please abolish the monarchy (with King George's permission, of course)

Thanks,

A. Peasant

Since: TWiki::Plugins::VERSION 1.1

wikiToEmail( $wikiName ) -> $email

• $wikiname - wiki name of the user

Since: TWiki::Plugins::VERSION 1.1

Deprecated in favour of wikinameToEmails, because this function only returns a single email address, where a user may in fact have several.

Since TWiki 4.2.1, $wikiName may also be a login name.

Creating New Topics

• $text - the text to process

Since: TWiki::Plugins::VERSION 1.1

Expands only the variables expected in templates that must be statically expanded in new content.

The expanded variables are:

• %DATE% Signature-format date
• %SERVERTIME% See TWikiVariables
• %GMTIME% See TWikiVariables
• %USERNAME% Base login name
• %WIKINAME% Wiki name
• %WIKIUSERNAME% Wiki name with prepended web
• %URLPARAM{...}% - Parameters to the current CGI query
• %NOP% No-op

See also: expandVariables

Special Handlers

Special handlers can be defined to make functions in plugins behave as if they were built-in to TWiki.

registerTagHandler( $var, \&fn, $syntax )

Should only be called from initPlugin.

Register a function to handle a simple variable. Handles both %VAR% and %VAR{...}%. Registered variables are treated the same as TWiki internal variables, and are expanded at the same time. This is a lot more efficient than using the commonTagsHandler.

• $var - The name of the variable, i.e. the 'MYVAR' part of %MYVAR%. The variable name must match /^[A-Z][A-Z0-9_]*$/ or it won't work.
• \&fn - Reference to the handler function.
• $syntax can be 'classic' (the default) or 'context-free'. 'classic' syntax is appropriate where you want the variable to support classic TWiki syntax i.e. to accept the standard %MYVAR{ "unnamed" param1="value1" param2="value2" }% syntax, as well as an unquoted default parameter, such as %MYVAR{unquoted parameter}%. If your variable will only use named parameters, you can use 'context-free' syntax, which supports a more relaxed syntax. For example, %MYVAR{param1=value1, value 2, param3="value 3", param4='value 5"}%

Since: TWiki::Plugins::VERSION 1.1

The variable handler function must be of the form:

sub handler(\%session, \%params, $topic, $web)

• \%session - a reference to the TWiki session object (may be ignored)
• \%params - a reference to a TWiki::Attrs object containing parameters. This can be used as a simple hash that maps parameter names to values, with _DEFAULT being the name for the default parameter.
• $topic - name of the topic in the query
• $web - name of the web in the query
• $meta - topic meta-data to use while expanding, can be undef (Since TWiki::Plugins::VERSION 1.4)
• $textRef - reference to unexpanded topic text, can be undef (Since TWiki::Plugins::VERSION 1.4)

sub initPlugin{
   TWiki::Func::registerTagHandler('EXEC', \&boo);
}

sub boo {
    my( $session, $params, $topic, $web ) = @_;
    my $cmd = $params->{_DEFAULT};

    return "NO COMMAND SPECIFIED" unless $cmd;

    my $result = `$cmd 2>&1`;
    return $params->{silent} ? '' : $result;
}

Registered tags differ from tags implemented using the old TWiki approach (text substitution in commonTagsHandler) in the following ways:

• registered tags are evaluated at the same time as system tags, such as %SERVERTIME. commonTagsHandler is only called later, when all system tags have already been expanded (though they are expanded again after commonTagsHandler returns).
• registered tag names can only contain alphanumerics and _ (underscore)
• registering a tag FRED defines both %FRED{...}% and also %FRED%.
• registered tag handlers cannot return another tag as their only result (e.g. return '%SERVERTIME%';). It won't work.

registerRESTHandler( $alias, \&fn, )

Should only be called from initPlugin.

Adds a function to the dispatch table of the REST interface

• $alias - The name .
• \&fn - Reference to the function.

Since: TWiki::Plugins::VERSION 1.1

The handler function must be of the form:

sub handler(\%session)

• \%session - a reference to the TWiki session object (may be ignored)

From the REST interface, the name of the plugin must be used as the subject of the invokation.

Example

The EmptyPlugin has the following call in the initPlugin handler:

   TWiki::Func::registerRESTHandler('example', \&restExample);

This adds the restExample function to the REST dispatch table for the EmptyPlugin under the 'example' alias, and allows it to be invoked using the URL

http://server:port/bin/rest/EmptyPlugin/example

note that the URL

http://server:port/bin/rest/EmptyPlugin/restExample

(ie, with the name of the function instead of the alias) will not work.

decodeFormatTokens($str) -> $unencodedString

TWiki has an informal standard set of tokens used in format parameters that are used to block evaluation of paramater strings. For example, if you were to write

%MYTAG{format="%WURBLE%"}%

then %WURBLE would be expanded before %MYTAG is evaluated. To avoid this TWiki uses escapes in the format string. For example:

%MYTAG{format="$percntWURBLE$percnt"}%

This lets you enter arbitrary strings into parameters without worrying that TWiki will expand them before your plugin gets a chance to deal with them properly. Once you have processed your tag, you will want to expand these tokens to their proper value. That's what this function does.

Since: TWiki::Plugins::VERSION 1.2

Searching

searchInWebContent($searchString, $web, \@topics, \%options ) -> \%map

Search for a string in the content of a web. The search is over all content, including meta-data. Meta-data matches will be returned as formatted lines within the topic content (meta-data matches are returned as lines of the format %META:\w+{.*}%)

• $searchString - the search string, in egrep format
• $web - The web to search in
• \@topics - reference to a list of topics to search
• \%option - reference to an options hash

• type - if regex will perform a egrep-syntax RE search (default '')
• casesensitive - false to ignore case (default true)
• files_without_match - true to return files only (default false). If files_without_match is specified, it will return on the first match in each topic (i.e. it will return only one match per topic, and will not return matching lines).

The return value is a reference to a hash which maps each matching topic name to a list of the lines in that topic that matched the search, as would be returned by 'grep'.

To iterate over the returned topics use:

my $result = TWiki::Func::searchInWebContent( "Slimy Toad", $web, \@topics,
   { casesensitive => 0, files_without_match => 0 } );
foreach my $topic (keys %$result ) {
   foreach my $matching_line ( @{$result->{$topic}} ) {
      ...etc

Since: TWiki::Plugins::VERSION 1.1

Plugin-specific File Handling

getWorkArea( $pluginName ) -> $directorypath

Gets a private directory for Plugin use. The Plugin is entirely responsible for managing this directory; TWiki will not read from it, or write to it.

The directory is guaranteed to exist, and to be writable by the webserver user. By default it will not be web accessible.

The directory and it's contents are permanent, so Plugins must be careful to keep their areas tidy.

Since: TWiki::Plugins::VERSION 1.1 (Dec 2005)

readFile( $filename ) -> $text

Read file, low level. Used for Plugin workarea.

• $filename - Full path name of file

NOTE: Use this function only for the Plugin workarea, not for topics and attachments. Use the appropriate functions to manipulate topics and attachments.

Since: TWiki::Plugins::VERSION 1.000 (07 Dec 2002)

saveFile( $filename, $text )

Save file, low level. Used for Plugin workarea.

• $filename - Full path name of file
• $text - Text to save

NOTE: Use this function only for the Plugin workarea, not for topics and attachments. Use the appropriate functions to manipulate topics and attachments.

Since: TWiki::Plugins::VERSION 1.000 (07 Dec 2002)

General Utilities

getRegularExpression( $name ) -> $expr

Retrieves a TWiki predefined regular expression or character class.

• $name - Name of the expression to retrieve. See notes below

Since: TWiki::Plugins::VERSION 1.020 (9 Feb 2004)

Note: TWiki internally precompiles several regular expressions to represent various string entities in an I18N-compatible manner. Plugins authors are encouraged to use these in matching where appropriate. The following are guaranteed to be present. Others may exist, but their use is unsupported and they may be removed in future TWiki versions.

In the table below, the expression marked type 'String' are intended for use within character classes (i.e. for use within square brackets inside a regular expression), for example:

   my $upper = TWiki::Func::getRegularExpression('upperAlpha');
   my $alpha = TWiki::Func::getRegularExpression('mixedAlpha');
   my $capitalized = qr/[$upper][$alpha]+/;

   my $webRE = TWiki::Func::getRegularExpression('webNameRegex');
   my $isWebName = ( $s =~ m/$webRE/ );

normalizeWebTopicName($web, $topic) -> ($web, $topic)

Parse a web and topic name, supplying defaults as appropriate.

• $web - Web name, identifying variable, or empty string
• $topic - Topic name, may be a web.topic string, required.

Since: TWiki::Plugins::VERSION 1.1

sanitizeAttachmentName($fname) -> ($fileName, $origName)

Given a file namer, sanitise it according to the rules for transforming attachment names. Returns the sanitised name together with the basename before sanitisation.

Sanitation includes filtering illegal characters and mapping client file names to legal server names.

Since: TWiki::Plugins::VERSION 1.2

buildWikiWord( $text ) -> $text

Converts arbitrary text to a WikiWord.

• $pre - Arbitrary Text

Since: TWiki::Plugins::VERSION 1.3 (18 Jan 2010)

spaceOutWikiWord( $word, $sep ) -> $text

Spaces out a wiki word by inserting a string (default: one space) between each word component. With parameter $sep any string may be used as separator between the word components; if $sep is undefined it defaults to a space.

Since: TWiki::Plugins::VERSION 1.2

writeWarning( $text )

Log Warning that may require admin intervention to data/warning.txt

• $text - Text to write; timestamp gets added

Since: TWiki::Plugins::VERSION 1.020 (16 Feb 2004)

writeDebug( $text )

Log debug message to data/debug.txt

• $text - Text to write; timestamp gets added

Since: TWiki::Plugins::VERSION 1.020 (16 Feb 2004)

writeLog( $action, $extra, $web, $topic, $user )

Write the log for an event to the logfile.

• $action - name of the event, such as 'blacklist'.
• $extra - arbitrary extra information to add to the event.
• $web - web name, optional. Base web is taken if empty. Ignored if web is specified in $topic.
• $topic - topic name, optional. Can be Topic or Web.Topic. Base topic is taken if empty.

Since: TWiki::Plugins::VERSION 1.4

Example: Calling TWiki::Func::writeLog( 'blacklist', 'Magic number is missing' ) will add a log entry like this:

| 2011-01-19 - 01:13 | guest | blacklist | TWiki.TWikiRegistration | Magic number is missing | 1.2.3.4 |

Note: Older plugins that use $TWiki::cfg{LogFileName} or call the internal TWiki function directly should be fixed to use writeLog.

To maintain compatibility with older TWiki releases, you can write conditional code as follows:

  if( defined &TWiki::Func::writeLog ) {
    # use writeLog

formatTime( $time, $format, $timezone ) -> $text

Format the time in seconds into the desired time string

• $time - Time in epoc seconds

• $timezone - either not defined (uses the displaytime setting), 'gmtime', or 'servertime'

isTrue( $value, $default ) -> $boolean

Returns 1 if $value is true, and 0 otherwise. "true" means set to something with a Perl true value, with the special cases that "off", "false" and "no" (case insensitive) are forced to false. Leading and trailing spaces in $value are ignored.

If the value is undef, then $default is returned. If $default is not specified it is taken as 0.

Since: TWiki::Plugins::VERSION 1.2

isValidWikiWord ( $text ) -> $boolean

Check for a valid WikiWord or WikiName

• $text - Word to test

Since: TWiki::Plugins::VERSION 1.100 (Dec 2005)

extractParameters($attr ) -> %params

Extract all parameters from a variable string and returns a hash of parameters

• $attr - Attribute string

Since: TWiki::Plugins::VERSION 1.025 (26 Aug 2004)

• Example:
  • Variable: %TEST{ 'nameless' name1="val1" name2="val2" }%
  • First extract text between {...} to get: 'nameless' name1="val1" name2="val2"
  • Then call this on the text:
    
• params = TWiki::Func::extractParameters( $text );=
  • The %params hash contains now:
    _DEFAULT => 'nameless'
name1 => "val1"
name2 => "val2"

extractNameValuePair( $attr, $name ) -> $value

• $attr - Attribute string
• $name - Name, optional

Since: TWiki::Plugins::VERSION 1.000 (7 Dec 2002)

• Example:
  • Variable: %TEST{ 'nameless' name1="val1" name2="val2" }%
  • First extract text between {...} to get: 'nameless' name1="val1" name2="val2"
  • Then call this on the text:
    my $noname = TWiki::Func::extractNameValuePair( $text );
my $val1  = TWiki::Func::extractNameValuePair( $text, "name1" );
my $val2  = TWiki::Func::extractNameValuePair( $text, "name2" );

Deprecated functions

From time-to-time, the TWiki developers will add new functions to the interface (either to TWikiFuncDotPm, or new handlers). Sometimes these improvements mean that old functions have to be deprecated to keep the code manageable. When this happens, the deprecated functions will be supported in the interface for at least one more TWiki release, and probably longer, though this cannot be guaranteed.

Updated plugins may still need to define deprecated handlers for compatibility with old TWiki versions. In this case, the plugin package that defines old handlers can suppress the warnings in %FAILEDPLUGINS%.

This is done by defining a map from the handler name to the TWiki::Plugins version in which the handler was first deprecated. For example, if we need to define the endRenderingHandler for compatibility with TWiki::Plugins versions before 1.1, we would add this to the plugin:

package TWiki::Plugins::SinkPlugin;
use vars qw( %TWikiCompatibility );
$TWikiCompatibility{endRenderingHandler} = 1.1;

The following functions are retained for compatibility only. You should stop using them as soon as possible.

getScriptUrlPath( ) -> $path

Get script URL path

DEPRECATED since 1.1 - use getScriptUrl instead.

Return: $path URL path of TWiki scripts, e.g. "/cgi-bin"

WARNING: you are strongly recommended not to use this function, as the {ScriptUrlPaths} URL rewriting rules will not apply to urls generated using it.

Since: TWiki::Plugins::VERSION 1.000 (7 Dec 2002)

getOopsUrl( $web, $topic, $template, $param1, $param2, $param3, $param4 ) -> $url

Compose fully qualified 'oops' dialog URL

• $web - Web name, e.g. 'Main'. The current web is taken if empty
• $topic - Topic name, e.g. 'WebNotify'
• $template - Oops template name, e.g. 'oopsmistake'. The 'oops' is optional; 'mistake' will translate to 'oopsmistake'.
• $param1 ... $param4 - Parameter values for %PARAM1% ... %PARAMn% variables in template, optional

DEPRECATED since 1.1, the recommended approach is to throw an oops exception.

   use Error qw( :try );

   throw TWiki::OopsException(
      'toestuckerror',
      web => $web,
      topic => $topic,
      params => [ 'I got my toe stuck' ]);

If this is not possible (e.g. in a REST handler that does not trap the exception) then you can use getScriptUrl instead:

   my $url = TWiki::Func::getScriptUrl($web, $topic, 'oops',
            template => 'oopstoestuckerror',
            param1 => 'I got my toe stuck');
   TWiki::Func::redirectCgiQuery( undef, $url );
   return 0;

Since: TWiki::Plugins::VERSION 1.000 (7 Dec 2002)

permissionsSet( $web ) -> $boolean

Test if any access restrictions are set for this web, ignoring settings on individual pages

• $web - Web name, required, e.g. 'Sandbox'

Since: TWiki::Plugins::VERSION 1.000 (27 Feb 2001)

DEPRECATED since 1.2 - use getPreferencesValue instead to determine what permissions are set on the web, for example:

foreach my $type ( 'ALLOW', 'DENY' ) {
    foreach my $action ( 'CHANGE', 'VIEW' ) {
        my $pref = $type . 'WEB' . $action;
        my $val = getPreferencesValue( $pref, $web ) || '';
        if( $val =~ /\S/ ) {
            print "$pref is set to $val on $web\n";
        }
    }
}

@webs"> getPublicWebList( ) -> @webs

DEPRECATED since 1.1 - use getListOfWebs instead.

Get list of all public webs, e.g. all webs that do not have the NOSEARCHALL flag set in the WebPreferences

Return: @webs List of all public webs, e.g. ( 'Main',  'Know', 'TWiki' )

Since: TWiki::Plugins::VERSION 1.000 (07 Dec 2002)

formatGmTime( $time, $format ) -> $text

DEPRECATED since 1.1 - use formatTime instead.

Format the time to GM time

• $time - Time in epoc seconds
• $format - Format type, optional. Default e.g. '31 Dec 2002 - 19:30', can be 'iso' (e.g. '2002-12-31T19:30Z'), 'rcs' (e.g. '2001/12/31 23:59:59', 'http' for HTTP header format (e.g. 'Thu, 23 Jul 1998 07:21:56 GMT')

Since: TWiki::Plugins::VERSION 1.000 (7 Dec 2002)

getDataDir( ) -> $dir

DEPRECATED since 1.1 - use the "Webs, Topics and Attachments" functions to manipulate topics instead

Get data directory (topic file root)

Return: $dir Data directory, e.g. '/twiki/data'

This function violates store encapsulation and is therefore deprecated.

Since: TWiki::Plugins::VERSION 1.000 (07 Dec 2002)

getPubDir( ) -> $dir

DEPRECATED since 1.1 - use the "Webs, Topics and Attachments" functions to manipulateattachments instead

Get pub directory (file attachment root). Attachments are in $dir/Web/TopicName

Return: $dir Pub directory, e.g. '/htdocs/twiki/pub'

This function violates store encapsulation and is therefore deprecated.

Use readAttachment and saveAttachment instead.

Since: TWiki::Plugins::VERSION 1.000 (07 Dec 2002)

checkDependencies( $moduleName, $dependenciesRef ) -> $error

DEPRECATED since 1.1 - use TWiki:Plugins.BuildContrib and define DEPENDENCIES that can be statically evaluated at install time instead. It is a lot more efficient.

Since: TWiki::Plugins::VERSION 1.025 (01 Aug 2004)

TWiki API History

TWiki-2001-09-01 (Athens Release)

EmptyPlugin.pm

• commonTagsHandler($text, $topic, $web)
• endRenderingHandler($text)
• outsidePREHandler($text)
• insidePREHandler($text)
• startRenderingHandler($text, $web)

Func.pm

• checkAccessPermission($type, $login, $topicText, $topicName, $webName) -> $boolean
• expandCommonVariables($text, $topic, $web) -> $text
• extractNameValuePair($attrs, $name) -> $value
• formatGmTime($time) -> $text
• getCgiQuery() -> $query
• getDataDir() -> $dir
• getDefaultUserName() -> $loginName
• getMainWebname() -> $name
• getOopsUrl($web, $topic, $template, @theParams) -> $url
• getPreferencesFlag($key) -> $boolean
• getPreferencesValue($key, $web) -> $value
• getPublicWebList() -> @webs
• getPubDir() -> $dir
• getPubUrlPath() -> $path
• getRevisionInfo($webName, $topic, $rev, $attachment) -> ($date, $user, $rev, $comment)
• getScriptUrl($web, $topic, $script) -> $url
• getScriptUrlPath() -> $path
• getSessionValue($key) -> $value
• getSkin() -> $skin
• getTopicList($web) -> @topics
• getTwikiWebname() -> $name
• getUrlHost() -> $host
• getViewUrl($web, $topic) -> $url
• getWikiName() -> $wikiName
• getWikiUserName($text) -> $wikiName
• getWikiToolName() -> $name
• internalLink($preamble, $web, $topic, $linkText, $anchor, $createLink) -> $text
• isGuest() -> $boolean
• permissionsSet($web) -> $boolean
• readFile($filename) -> $text
• readTemplate($name, $skin) -> $text
• readTopic($webName, $topic) -> ($meta, $text)
• redirectCgiQuery($query, $url)
• renderText($text, $web) -> $text
• saveFile($filename, $text)
• setSessionValue($key, $value)
• topicExists($web, $topic) -> $boolean
• userToWikiName($user, $dontAddWeb) -> $wikiName
• webExists($web) -> $boolean
• wikiToUserName($wiki) -> $loginName
• writeDebug($text)
• writeHeader()
• writeWarning($text)

TWiki-2003-02-01 (Beijing Release)

EmptyPlugin.pm

• afterEditHandler($text, $topic, $web)
• beforeEditHandler($text, $topic, $web)
• beforeSaveHandler($text, $topic, $web)
• initializeUserHandler($loginName, $url, $pathInfo)
• redirectCgiQueryHandler($query, $url)
• registrationHandler($web, $wikiName, $loginName)
• writeHeaderHandler($query)

Func.pm

• checkTopicEditLock($web, $topic) ->($oopsUrl, $loginName, $unlockTime)
• readTopicText($web, $topic, $rev, $ignorePermissions) -> $text
• saveTopicText($web, $topic, $text, $ignorePermissions, $dontNotify) -> $oopsUrl
• setTopicEditLock($web, $topic, $lock) -> $oopsUrl

TWiki-2004-09-02 (Cairo Release)

EmptyPlugin.pm

• afterCommonTagsHandler($text, $topic, $web)
• afterSaveHandler($text, $topic, $web, $error)
• beforeCommonTagsHandler($text, $topic, $web)
• earlyInitPlugin()

Func.pm

• afterAttachmentSaveHandler(\%attrHash, $topic, $web, $error, $meta)
• beforeAttachmentSaveHandler(\%attrHash, $topic, $web, $meta)
• checkDependencies($moduleName, $dependenciesRef) -> $error
• extractParameters($attr) -> %params
• formatTime($time, $format, $timezone) -> $text
• getPluginPreferencesFlag($key) -> $boolean
• getPluginPreferencesValue($key) -> $value
• getRegularExpression($regexName) -> $pattern

TWiki-4.0.0 (Dakar Release)

EmptyPlugin.pm

• mergeHandler($diff, $old, $new, \%info) -> $text
• modifyHeaderHandler(\%headers, $query)
• postRenderingHandler($text)
• preRenderingHandler($text, \%map)
• renderFormFieldForEditHandler($name, $type, $size, $value, $attributes, $possibleValues) -> $html
• renderWikiWordHandler($linkText, $hasExplicitLinkLabel, $web, $topic) -> $linkText

• endRenderingHandler($text)
• startRenderingHandler($text, $web)

Func.pm

• addToHEAD($id, $header)
• attachmentExists($web, $topic, $attachment) -> $boolean
• clearSessionValue($key) -> $boolean
• checkDependencies($moduleName, $dependenciesRef) -> $error
• createWeb($newWeb, $baseWeb, $opts)
• expandTemplate($def ) -> $string
• expandVariablesOnTopicCreation($text) -> $text
• getContext() -> \%hash
• getListOfWebs($filter) -> @webs
• getScriptUrl($web, $topic, $script, @params) -> $url
• getRevisionAtTime($web, $topic, $time) -> $rev
• getWorkArea($pluginName) -> $directorypath
• isValidWikiWord($text) -> $boolean
• loadTemplate($name, $skin, $web) -> $text
• moveAttachment($web, $topic, $attachment, $newWeb, $newTopic, $newAttachment)
• moveTopic($web, $topic, $newWeb, $newTopic)
• moveWeb($oldName, $newName)
• normalizeWebTopicName($web, $topic) ->($web, $topic)
• readAttachment($web, $topic, $name, $rev) -> $data
• registerRESTHandler($alias, \&fn,)
• registerTagHandler($var, \&fn, $syntax)
• saveAttachment($web, $topic, $attachment, $opts)
• saveTopic($web, $topic, $meta, $text, $options) -> $error
• searchInWebContent($searchString, $web, \@topics, \%options) -> \%map
• sendEmail($text, $retries) -> $error
• wikiToEmail($wikiName) -> $email
• writeHeader($query, $contentLength)

• checkDependencies($moduleName, $dependenciesRef) -> $error
• formatGmTime($time, $format) -> $text
• getDataDir() -> $dir
• getOopsUrl( $web, $topic, $template, @params ) -> $url
• getPubDir() -> $dir
• getPublicWebList() -> @webs
• getScriptUrlPath() -> $path

TWiki-4.0.1 (Dakar Patch Release)

EmptyPlugin.pm

• afterSaveHandler($text, $topic, $web, $error, $meta)
• beforeSaveHandler($text, $topic, $web, $meta)

Func.pm

TWiki-4.1 (Edinburgh Release)

EmptyPlugin.pm

• afterRenameHandler($oldWeb, $oldTopic, $oldAttachment, $newWeb, $newTopic, $newAttachment)

Func.pm

TWiki-4.2 (Freetown Release)

EmptyPlugin.pm

• afterCommonTagsHandler($text, $topic, $web, $meta)
• beforeCommonTagsHandler($text, $topic, $web, $meta)
• commonTagsHandler($text, $topic, $web, $included, $meta)

Func.pm

• decodeFormatTokens($str) -> $unencodedString
• eachChangeSince($web, $time) -> $iterator
• eachGroup() -> $iterator
• eachGroupMember($group) -> $iterator
• eachMembership($wikiname) -> $iterator
• eachUser() -> $iterator
• emailToWikiNames($email, $dontAddWeb) -> @wikiNames
• expandCommonVariables($text, $topic, $web, $meta) -> $text
• getCanonicalUserID( $user ) -> $cUID
• getExternalResource($url) -> $response
• getSessionKeys() -> @keys
• isAnAdmin($login) -> $boolean
• isGroup($group) -> $boolean
• isGroupMember($group, $login) -> $boolean
• isTrue($value, $default) -> $boolean
• popTopicContext()
• pushTopicContext($web, $topic)
• sanitizeAttachmentName($fname) -> ($fileName, $origName)
• setPreferencesValue($name, $val)
• spaceOutWikiWord($word, $sep) -> $text
• wikiNameToEmails($wikiname) -> @emails
• permissionsSet($web) -> $boolean
• getOopsUrl( $web, $topic, $template, $param1, $param2, $param3, $param4 ) -> $url

TWiki-4.3 (Georgetown Release)

EmptyPlugin.pm

Func.pm

TWiki-5.0 (Helsinki Release)

EmptyPlugin.pm

Func.pm

• buildWikiWord( $text ) -> $text

TWiki-5.1 (Istanbul Release)

EmptyPlugin.pm

• Callback function registered by registerTagHandler has two new parameters $meta and $textRef

Func.pm

• afterAttachmentSaveHandler(\%attrHash, $topic, $web, $error, $meta) -- added $meta
• beforeAttachmentSaveHandler(\%attrHash, $topic, $web, $meta) = added =$meta
• writeLog( $action, $extra, $web, $topic, $user )