|
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Package
Official list of stable TWiki functions for Plugin developers
This module defines official functions that 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 1.11. This can be shown
by the |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
dontlog | don't log this change in twiki log |
comment | comment for save |
minor | True if this is a minor change, and is not to be notified |
my( $meta, $text ) = TWiki::Func::readTopic( $web, $topic )
$text =~ s/APPLE/ORANGE/g;
TWiki::Func::saveTopic( $web, $topic, $meta, $text, { comment => 'refruited' } );
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
$oopsUrl Empty string if OK; the $oopsUrl for calling redirectCgiQuery() in case of error
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 )
-
$websource web - required -
$topicsource topic - required -
$newWebdest web -
$newTopicdest topic
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
( $date, $user, $rev, $comment ) List with: ( last update date, login name of last user, minor part of top revision number ), e.g. ( 1234561, 'phoeny', "5" )
| $date | in epochSec |
| $user | Wiki name of the author (not login name) |
| $rev | actual rev number |
| $comment | WHAT COMMENT? |
$meta->getRevisionInfo instead if you can - it is significantly
more efficient, and returns a user object that contains other user
information.
NOTE: prior versions of TWiki may under some circumstances have returned
the login name of the user rather than the wiki name; the code documentation
was totally unclear, and we have been unable to establish the intent.
However the wikiname is obviously more useful, so that is what is returned.
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
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, $text ) Meta data object and topic text
$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 checkAccessPermissions to ensure the current user has read access to the topic.
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
$text Topic text with embedded meta data; an oops URL for calling redirectCgiQuery() is returned in case of an error
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, orMain.TokyoOffice -
$attachment- attachment name, e.g.=logo.gif=
normalizeWebTopicName.
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)
readTopic. If the attachment does not exist, or cannot be read, undef
will be returned. If the revision is not specified, the latest version will
be returned.
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
$opts may include:
dontlog | don't log this change in twiki log |
comment | comment for save |
hide | if the attachment is to be hidden in normal topic view |
stream | Stream of file to upload |
file | Name of a file to use for the attachment data. ignored if stream is set. Local file on the server. |
filepath | Client path to file |
filesize | Size of uploaded data |
filedate | Date |
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 )
-
$websource web - required -
$topicsource topic - required -
$attachmentsource attachment - required -
$newWebdest web -
$newTopicdest topic -
$newAttachmentdest attachment
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'
$text Template text
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)
expandTemplate( $def ) -> $string
Do a , only expanding the template (not expanding any variables other than %TMPL)-
$def- template name
writeHeader( $query, $contentLength )
Prints a basic content-type HTML header for text/html to standard out-
$query- CGI query object. If not given, the default CGI query will be used. In most cases you should not pass this parameter. -
$contentLength- Length of content
redirectCgiQuery( $query, $url, $passthru )
Redirect to URL-
$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.
$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 (see {PassthroughDir} in =configure).
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);
$passthru does nothing if $url does not point to a script in the current
TWiki installation.
Since: TWiki::Plugins::VERSION 1.000 (7 Dec 2002)
addToHEAD( $id, $header )
Adds$header to the HTML header (the tag).
This is useful for Plugins that want to include some javascript custom css. -
$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.
$header will be expanded before being inserted into the 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 ) -> $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
$text Expanded text, e.g. 'Current user is TWikiGuest'
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
$text XHTML text, e.g. '<b>bold</b> and <code>fixed font</code>'
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 byrenderText() -
$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
$text XHTML anchor, e.g. '<a href='/cgi-bin/view/Main/WebNotify#Jump'>notify</a>'
Since: TWiki::Plugins::VERSION 1.000 (7 Dec 2002)
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. PeasantLeave a blank line between the last header field and the message body. Since: TWiki::Plugins::VERSION 1.1
wikiToEmail( $wikiName ) -> $email
-
$wikiName- wiki name of the user
Creating New Topics
expandVariablesOnTopicCreation ( $text ) -> $text
Expand the limited set of variables that are always expanded during topic creation-
$text- the text to process
-
%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
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 thecommonTagsHandler. -
$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. -
$syntaxcan 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"}%
sub handler(\%session, \%params, $topic, $web)where:
-
\%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
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;
}
}
would let you do this:
%EXEC{"ps -Af" silent="on"}%
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.
commonTagsHandleris only called later, when all system tags have already been expanded (though they are expanded again aftercommonTagsHandlerreturns). - registered tag names can only contain alphanumerics and _ (underscore)
- registering a tag
FREDdefines 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.
sub handler(\%session)where:
-
\%session- a reference to the TWiki session object (may be ignored)
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.
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
\%options hash may contain the following options: -
type- ifregexwill perform a egrep-syntax RE search (default '') -
casesensitive- false to ignore case (defaulkt true) -
files_without_match- true to return files only (default false). Iffiles_without_matchis 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).
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
$text Content of file, empty if not found
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
General Utilities
getRegularExpression( $name ) -> $expr
Retrieves a TWiki predefined regular expression or character class.-
$name- Name of the expression to retrieve. See notes below
my $upper = TWiki::Func::getRegularExpression('upperAlpha');
my $alpha = TWiki::Func::getRegularExpression('mixedAlpha');
my $capitalized = qr/[$upper][$alpha]+/;
Those expressions marked type 'RE' are precompiled regular expressions that can be used outside square brackets. For example:
my $webRE = TWiki::Func::getRegularExpression('webNameRegex');
my $isWebName = ( $s =~ m/$webRE/ );
| Name | Matches | Type |
|---|---|---|
| upperAlpha | Upper case characters | String |
| upperAlphaNum | Upper case characters and digits | String |
| lowerAlpha | Lower case characters | String |
| lowerAlphaNum | Lower case characters and digits | String |
| numeric | Digits | String |
| mixedAlpha | Alphabetic characters | String |
| mixedAlphaNum | Alphanumeric characters | String |
| wikiWordRegex | WikiWords | RE |
| webNameRegex | User web names | RE |
| anchorRegex | #AnchorNames | RE |
| abbrevRegex | Abbreviations e.g. GOV, IRS | RE |
| emailAddrRegex | email@address.com | RE |
| tagNameRegex | Standard variable names e.g. %THIS_BIT% (THIS_BIT only) | RE |
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.
| Input | Return |
|---|---|
| ( 'Web', 'Topic' ) | ( 'Web', 'Topic' ) |
| ( '', 'Topic' ) | ( 'Main', 'Topic' ) |
| ( '', '' ) | ( 'Main', 'WebHome' ) |
| ( '', 'Web/Topic' ) | ( 'Web', 'Topic' ) |
| ( '', 'Web/Subweb/Topic' ) | ( 'Web/Subweb', 'Topic' ) |
| ( '', 'Web.Topic' ) | ( 'Web', 'Topic' ) |
| ( '', 'Web.Subweb.Topic' ) | ( 'Web/Subweb', 'Topic' ) |
| ( 'Web1', 'Web2.Topic' ) | ( 'Web2', 'Topic' ) |
configure.
The symbols %USERSWEB%, %SYSTEMWEB%, %DOCWEB%, %MAINWEB% and %TWIKIWEB% can be used in the input to represent the web names set in $cfg{UsersWebName} and $cfg{SystemWebName}. For example:
| Input | Return |
|---|---|
| ( '%USERSWEB%', 'Topic' ) | ( 'Main', 'Topic' ) |
| ( '%SYSTEMWEB%', 'Topic' ) | ( 'TWiki', 'Topic' ) |
| ( '', '%DOCWEB%.Topic' ) | ( 'TWiki', 'Topic' ) |
writeWarning( $text )
Log Warning that may require admin intervention to data/warning.txt-
$text- Text to write; timestamp gets added
writeDebug( $text )
Log debug message to data/debug.txt-
$text- Text to write; timestamp gets added
formatTime( $time, $format, $timezone ) -> $text
Format the time in seconds into the desired time string-
$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'), or any string with tokens'$seconds, $minutes, $hours, $day, $wday, $month, $mo, $year, $ye, $tz'for seconds, minutes, hours, day of month, day of week, 3 letter month, 2 digit month, 4 digit year, 2 digit year, timezone string, respectively -
$timezone- either not defined (uses the displaytime setting), 'gmtime', or 'servertime'
$text Formatted time string
| Note: | if you used the removed formatGmTime, add a third parameter 'gmtime' |
isValidWikiWord ( $text ) -> $boolean
Check for a valid WikiWord or WikiName-
$text- Word to test
extractParameters($attr ) -> %params
Extract all parameters from a variable string and returns a hash of parameters-
$attr- Attribute string
%params Hash containing all parameters. The nameless parameter is stored in key _DEFAULT
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:
- Variable:
- params = TWiki::Func::extractParameters( $text );=
- The
%paramshash contains now:
_DEFAULT => 'nameless'
name1 => "val1"
name2 => "val2"
- The
extractNameValuePair( $attr, $name ) -> $value
Extract a named or unnamed value from a variable parameter string - Note: | Function TWiki::Func::extractParameters is more efficient for extracting several parameters-
$attr- Attribute string -
$name- Name, optional
$value Extracted value
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" );
- Variable:
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 theTWiki::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;
If the currently-running TWiki version is 1.1 or later, then the handler will not be called and the warning will not be issued. TWiki with versions of TWiki::Plugins before 1.1 will still call the handler as required.
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 - usegetScriptUrl 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)
getPublicWebList( ) -> @webs
DEPRECATED since 1.1 - usegetListOfWebs 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 - useformatTime 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')
$text Formatted time string
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)
