Difference: TWikiFuncDotPm (1 vs. 18)

Revision 182015-11-29 - TWikiContributor

Line: 483 to 483
 

getWikiName( $user ) -> $wikiName

Changed:
<
<
return the WikiName of the specified user if $user is undefined Get Wiki name of logged in user
>
>
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
Line: 496 to 496
 

getWikiUserName( $user ) -> $wikiName

Changed:
<
<
return the userWeb.WikiName of the specified user if $user is undefined Get Wiki name of logged in user
>
>
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
Line: 509 to 509
 

wikiToUserName( $id ) -> $loginName

Translate a Wiki name to a login name.
Changed:
<
<
  • $id - Wiki name, e.g. 'Main.JohnDoe' or 'JohnDoe'.
>
>
  • $id - Wiki name, required, 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.
Line: 521 to 521
 This function will only return the first login name that maps to the wikiname.
Changed:
<
<
returns undef if the WikiName is not found.
>
>
Returns undef if the WikiName is not found.

To get the login name of the currently logged in user use:

    my $user = TWiki::Func::wikiToUserName( TWiki::Func::getWikiName() );
  Since: TWiki::Plugins::VERSION 1.000 (7 Dec 2002)
Line: 1847 to 1855
 

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

Changed:
<
<
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.
>
>
Spaces out a wiki word by inserting a string between each word component. Word component boundaries are transitions from lowercase to uppercase or numeric, from numeric to uppercase or lowercase, and from uppercase to numeric characters.

Parameter $sep defines the separator between the word components, the default is a space.

Example: "ABC2015ProjectCharter" results in "ABC 2015 Project Charter"

  Since: TWiki::Plugins::VERSION 1.2
Line: 2443 to 2456
 

TWiki-6.0 (Jerusalem Release)

$TWiki::Plugins::VERSION 6.00

EmptyPlugin.pm

Changed:
<
<
No changes
>
>
  • viewRedirectHandler( $session, $web, $topic )
 

Func.pm

  • isAnAdmin( $user, $topic, $web ) -> $boolean -- added $topic and $web
  • expandVariablesOnTopicCreation( $text, $web, $topic ) -> $text -- added $web and $topic
Line: 2459 to 2472
 
  • urlEncode( $text ) -> $text
  • urlDecode( $text ) -> $text
Added:
>
>

TWiki-6.02 (Kampala Release)

$TWiki::Plugins::VERSION 6.02

EmptyPlugin.pm

  • viewFileRedirectHandler( $session, $web, $topic )
  • topicTitleHandler( $session, $web, $topic, $titleRef )

Revision 172014-10-05 - TWikiContributor

Line: 295 to 295
  Note: all plugins have an automatically generated context identifier if they are installed and initialised. For example, if the FirstPlugin is
Changed:
<
<
working, the context ID 'FirstPlugin' will be set.
>
>
working, the context ID 'FirstPluginEnabled' will be set.
  Since: TWiki::Plugins::VERSION 1.1
Line: 928 to 928
 Example:
    # read topic:
Changed:
<
<
my( $topicMeta, $topicText ) = TWiki::Func::readTopic( $web, $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:
Line: 1428 to 1428
 
  • %URLPARAM{...}% - Parameters to the current CGI query
  • %NOP% No-op
Changed:
<
<
See also: expandVariables
>
>
See also: expandCommonVariables
 

Line: 1913 to 1913
  Format the time in seconds into the desired time string
  • $time - Time in epoc seconds
Changed:
<
<
  • $format - Format type, optional. Default e.g. '2013-12-31 - 19:30'. Can be '$iso' (e.g. '2013-12-31T19:30Z'), '$rcs' (e.g. '2013/12/31 23:59:59', '$http' for HTTP header format (e.g. 'The, 2013-07-23 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
>
>
  • $format - Format type, optional. Default e.g. '2014-12-31 - 19:30'. Can be '$iso' (e.g. '2014-12-31T19:30Z'), '$rcs' (e.g. '2014/12/31 23:59:59', '$http' for HTTP header format (e.g. 'The, 2014-07-23 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'
Return: $text Formatted time string

Revision 162013-10-14 - TWikiContributor

Line: 25 to 25
 $TWiki::Plugins::VERSION. The 'Since' field in the function documentation refers to $TWiki::Plugins::VERSION.
Changed:
<
<
Notes on use of $TWiki::Plugins::VERSION (from 1.2 forwards):
>
>
Notes on use of $TWiki::Plugins::VERSION 6.00 and later:
 
Changed:
<
<
  • If the major version (e.g. 1.) is the same then any plugin coded to use any earlier revision of the 1. API will still work. No function has been removed from the interface, nor has any API published in that version changed in such a way as to require plugins to be recoded.
  • If the minor version (e.g. 1.1) is incremented there may be changes in the API that may help improve the coding of some plugins - for example, new interfaces giving access to previously hidden core functions. In addition, deprecation of functions in the interface trigger a minor version increment. Note that deprecated functions are not removed, they are merely frozen, and plugin authors are recommended to stop using them.
  • Any additional digits in the version number relate to minor changes, such as the addition of parameters to the existing functions, or addition of utility functions that are unlikely to require significant changes to existing plugins.
>
>
  • The version number is now aligned with the TWiki release version.
  • A TWiki-6.7.8 release will have a $TWiki::Plugins::VERSION = 6.78.
  • In an unlikely case where the patch number is 10 or larger, the patch number is added to the previous patch number. For example, TWiki-6.7.9 will have version 6.79, TWiki-6.7.10 will have 6.7910, and TWiki-6.7.11 will have 6.7911. This ensures that the version number can sort properly.
 
  • 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.
Line: 112 to 104
 

Changed:
<
<

getExternalResource( $url, @headers ) -> $response

>
>

getExternalResource( $url, \@headers, \%params ) -> $response

  Get whatever is at the other end of a URL (using an HTTP GET request). Will only work for encrypted protocols such as https if the LWP CPAN module is
Line: 121 to 113
 Note that the $url may have an optional user and password, as specified by the relevant RFC. Any proxy set in configure is honored.
Changed:
<
<
Optional headers may be supplied of form 'name1', 'value1', 'name2', 'value2'. Do not add a User-Agent header, it will be added.
>
>
Optional parameters may be supplied:
  • \@headers (an array ref): Additional HTTP headers of form 'name1', 'value1', 'name2', 'value2'. User-Agent header is set to "TWiki::Net/### libwww-perl/#.##" by default, where ### is the revision number of TWiki::Net and #.## is the version of LWP.
  • \%params (a hash ref): Additional options.

Below is the list of available %params. See CPAN:LWP::UserAgent for more details.

Name Usage
agent => $useragent ("User-Agent:" header)
cookie_jar => $cookies
credentials => [$netloc, $realm, $uname, $pass]
handlers => {$phase => \&cb, ...} Note: %matchspec is not available.
local_address => $address
max_redirect => $n
max_size => $bytes
method * => $method E.g. 'HEAD'
parse_head => $boolean
requests_redirectable => \@requests
ssl_opts => {$key => $value, ...}
timeout * => $secs
The parameters with * do not require LWP.

Example:

my $response = getExternalResource($url,
    ['Cache-Control' => 'max-age=0'], {timeout => 10});
  The $response is an object that is known to implement the following subset of
Changed:
<
<
the methods of LWP::Response. It may in fact be an LWP::Response object,
>
>
the methods of HTTP::Response. It may in fact be an HTTP::Response object,
 but it may also not be if LWP is not available, so callers may only assume the following subset of methods is available:
code()
Line: 163 to 184
  Since: TWiki::Plugins::VERSION 1.2
Added:
>
>
Note: The optional parameters \@headers and \%params were added in TWiki::Plugins::VERSION 6.00

postExternalResource( $url, $text, \@headers, \%params ) -> $response

This method is essentially the same as getExternalResource() except that it uses an HTTP POST method and that the additional $text parameter is required.

The $text is sent to the server as the body content of the HTTP request.

See getExternalResource() for more details.

Since: TWiki::Plugins::VERSION 6.00

 

getCgiQuery( ) -> $query

Line: 307 to 344
 Since: TWiki::Plugins::VERSION 1.000 (7 Dec 2002)

  • Example for Plugin setting:
Changed:
<
<
>
>
    • MyPlugin topic has: * Set COLOR = red
 
    • Use "MYPLUGIN_COLOR" for $key
    • my $color = TWiki::Func::getPreferencesValue( "MYPLUGIN_COLOR" );
Line: 345 to 382
 Since: TWiki::Plugins::VERSION 1.000 (7 Dec 2002)

  • Example for Plugin setting:
Changed:
<
<
    • MyPlugin topic has: * Set SHOWHELP = off
>
>
    • MyPlugin topic has: * Set SHOWHELP = off
 
    • Use "MYPLUGIN_SHOWHELP" for $key
    • my $showHelp = TWiki::Func::getPreferencesFlag( "MYPLUGIN_SHOWHELP" );
Line: 529 to 566
 

isGuest( ) -> $boolean

Changed:
<
<
Test if logged in user is a guest (TWikiGuest)
>
>
Test if logged in user is a guest (TWikiGuest)
  Since: TWiki::Plugins::VERSION 1.000 (7 Dec 2002)

Changed:
<
<

isAnAdmin( $id ) -> $boolean

>
>

isAnAdmin( $user, $topic, $web ) -> $boolean

  Find out if the user is an admin or not. If the user is not given, the currently logged-in user is assumed.
Changed:
<
<
  • $id can be either a login name or a WikiName
>
>
  • $user can be either a login name or a WikiName
  • a user mapping handler's isAdmin() may take $topic and $web arguments. That's why this function takes them too. For a user mapping handler whose isAdmin() doesn't care $topic and $web (e.g. TWikiUserMapping), $topic and $web are irrelevant, needless to say.
  Since: TWiki::Plugins::VERSION 1.2
Added:
>
>
Note: The parameters $topic and $web were added in TWiki::Plugins::VERSION 6.00
 

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

Line: 661 to 705
 earlier TWiki releases.

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

Changed:
<
<
>
>
  • Set ALLOWTOPICSPIN = IncyWincy
 in ThatWeb.ThisTopic, then a call to checkAccessPermission('SPIN', 'IncyWincy', undef, 'ThisTopic', 'ThatWeb', undef) will return true.

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

Line: 798 to 842
  }
Added:
>
>
Since: TWiki::Plugins::VERSION 1.2
 

getTopicList( $web ) -> @topics

Line: 1086 to 1132
 
  • $topic - topic to atach to
  • $attachment - name of the attachment
  • $opts - Ref to hash of options
Added:
>
>
  • $ignorePermissions - Set to "1" if checkAccessPermission() is already performed and OK.
 $opts may include:
dontlog don't log this change in twiki log
comment comment for save
Line: 1173 to 1220
 
  • $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)
Changed:
<
<
Return: expanded template text (what's left after removal of all %TMPL:DEF% statements)
>
>
Return: expanded template text (what's left after removal of all %TMPL:DEF% statements)
  Since: TWiki::Plugins::VERSION 1.1
Line: 1188 to 1235
 

expandTemplate( $def ) -> $string

Changed:
<
<
Do a , only expanding the template (not expanding any variables other than %TMPL)
>
>
Do a %TMPL:P{$def}%, only expanding the template (not expanding any variables other than %TMPL)
 
  • $def - template name
Return: the text of the expanded template

Since: TWiki::Plugins::VERSION 1.1

Changed:
<
<
A template is defined using a %TMPL:DEF% statement in a template
>
>
A template is defined using a %TMPL:DEF% statement in a template
 file. See the documentation on TWiki templates for more information.
Line: 1209 to 1256
 

Changed:
<
<

redirectCgiQuery( $query, $url, $passthru )

>
>

redirectCgiQuery( $query, $url, $passthru, $viaCache )

  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.
Added:
>
>
  • $viaCache - forcibly cache a redirect CGI query. It cuts off all the params in a GET url and replace with a "?$cache=..." param. "$viaCache" is meaningful only if "$passthru" is true.
  Return: none
Line: 1248 to 1296
 

addToHEAD( $id, $header, $requires )

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

Changed:
<
<
This is useful for Plugins that want to include some javascript custom css.
>
>
This is useful for Plugins that want to include some javascript and 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.
Changed:
<
<
  • requires optional, comma-separated list of id's of other head blocks this one depends on.
>
>
  • requires optional, comma-separated list of id's of other head blocks this one depends on. Those blocks will be loaded first.
  All TWiki variables present in $header will be expanded before being inserted into the section.
Line: 1357 to 1405
 

Changed:
<
<

expandVariablesOnTopicCreation ( $text ) -> $text

>
>

expandVariablesOnTopicCreation ( $text, $web, $topic ) -> $text

  Expand the limited set of variables that are always expanded during topic creation
  • $text - the text to process
Added:
>
>
  • $web - name of web, optional
  • $topic - name of topic, optional
 Return: text with variables expanded

Since: TWiki::Plugins::VERSION 1.1

Line: 1478 to 1528
 (ie, with the name of the function instead of the alias) will not work.
Added:
>
>

registerExternalHTTPHandler( \&fn )

Should only be called from initPlugin.

Adds a function to modify all the HTTP requests to any external resources.

  • \&fn - Reference to the function.

The handler function must be of the form:

sub handler(\%session, $url) -> (\@headers, \%params)
where:
  • \%session - a reference to the TWiki session object (may be ignored)
  • $url - a URL being requested

The returned \@headers and \%params are added to the request in the same manner as getExternalResource, except that \%params will not override any entries that have been set earlier. All the params explicitly given by the caller of getExternalResource or postExternalResource will have the highest precedence.

Example:

sub initPlugin {
    TWiki::Func::registerExternalHTTPHandler( \&handleExternalHTTPRequest );
}

sub handleExternalHTTPRequest {
    my ($session, $url) = @_;
    my @headers;
    my %params;

    # Add any necessary @headers and %params
    push @headers, 'X-Example-Header' => 'Value';
    $params{timeout} = 5;

    # Return refs to both
    return (\@headers, \%params);
}

Since: TWiki::Plugins::VERSION 6.00

 

decodeFormatTokens($str) -> $unencodedString

Line: 1501 to 1596
 
$n or $n() New line. Use $n() if followed by alphanumeric character, e.g. write Foo$n()Bar instead of Foo$nBar
$nop or $nop() Is a "no operation".
$quot Double quote (")
Added:
>
>
$aquot Apostrophe quote (')
 
$percnt Percent sign (%)
$dollar Dollar sign ($)
Added:
>
>
$lt Less than sign (<)
$gt Greater than sign (>)
 
Changed:
<
<
Note thath $quot, $percnt and $dollar all work *even if they are followed by
>
>
Note that $quot, $aquot, $percnt and $dollar all work *even if they are followed by
 alphanumeric characters*. You have been warned!

Since: TWiki::Plugins::VERSION 1.2

Line: 1587 to 1685
 Since: TWiki::Plugins::VERSION 1.000 (07 Dec 2002)
Added:
>
>

Read-only and Mirror Webs

The following functions are for ReadOnlyAndMirrorWebs.

getSiteName() -> $siteName

Returns the current site name if it's defined. Otherwise returns the null string.

getContentMode( $web ) -> $contentMode

Returns the content mode of the specified $web. Please read ReadOnlyAndMirrorWebs about content mode.

Since: TWiki::Plugins::VERSION 6.00

webWritable( $web ) -> $boolean

Checks if the web is wriable on this site - if it's master or local. Returns true if it's writable. Returns false otherwise.

Since: TWiki::Plugins::VERSION 6.00

Using multiple disks

The following functions are for UsingMultipleDisks.

getDiskList() -> @diskIDs

Returns IDs of disks used by TWiki. An disk ID is "" (a null string) or a decimal number without leading 0.

Since: TWiki::Plugins::VERSION 6.00

getDiskInfo($web, [$diskID]) -> ($dataDir, $pubDir, $diskID)

Returns the relevant paths and the disk ID of the specified web on the specified site.

Since: TWiki::Plugins::VERSION 6.00

trashWebName(web => $web | disk => $diskID) -> $trashWebName

Returns the name of the trash web to which topics of the $web web are moved. Or returns the name of the trash web of the specified disk.

Each disk (file system) TWiki uses needs to have a trash web since a topic deletion may entail an attachment directory move, which is possible only within the same disk/file system.

Since: TWiki::Plugins::VERSION 6.00

 

General Utilities

Line: 1656 to 1812
 
( '', 'Web.Subweb.Topic' ) ( 'Web/Subweb', 'Topic' )
( 'Web1', 'Web2.Topic' ) ( 'Web2', 'Topic' )
Changed:
<
<
Note that hierarchical web names (SubWeb) are only available if hierarchical webs are enabled in configure.
>
>
Note that hierarchical web names (Web.SubWeb) are only available if hierarchical webs are enabled in configure.
  The symbols %USERSWEB%, %SYSTEMWEB% and %DOCWEB% can be used in the input to represent the web names set in $cfg{UsersWebName} and $cfg{SystemWebName}. For example:
Input Return
Line: 1724 to 1880
 
  • $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.
Changed:
<
<
  • $user - WikiName of user, optional. Name of logged-in user is taken if not specified.
>
>
  • $user - WikiName, login name or cUID of user, optional. Name of logged-in user is taken if not specified.
 Return: none

Since: TWiki::Plugins::VERSION 1.4

Line: 1742 to 1898
 
  if( defined &TWiki::Func::writeLog ) {
    # use writeLog
Changed:
<
<
TWiki::Func::writeLog( $web, $topic, 'myevent', $extra );
>
>
TWiki::Func::writeLog( 'myevent', $extra, $web, $topic );
  } else { # deprecated code if plugin is used in older TWiki releases $TWiki::Plugins::VERSION > 1.1
Line: 1757 to 1913
  Format the time in seconds into the desired time string
  • $time - Time in epoc seconds
Changed:
<
<
  • $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
>
>
  • $format - Format type, optional. Default e.g. '2013-12-31 - 19:30'. Can be '$iso' (e.g. '2013-12-31T19:30Z'), '$rcs' (e.g. '2013/12/31 23:59:59', '$http' for HTTP header format (e.g. 'The, 2013-07-23 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'
Return: $text Formatted time string
Changed:
<
<
Note: if you used the removed formatGmTime, add a third parameter 'gmtime'
>
>
Note: If you used the removed formatGmTime, add a third parameter 'gmtime'
  Since: TWiki::Plugins::VERSION 1.020 (26 Feb 2004)
Line: 1811 to 1968
 

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

Changed:
<
<
Extract a named or unnamed value from a variable parameter string - Note: | Function TWiki::Func::extractParameters is more efficient for extracting several parameters
>
>
Extract a named or unnamed value from a variable parameter string.
 
  • $attr - Attribute string
  • $name - Name, optional
Return: $value Extracted value
Line: 1827 to 1983
  my $val1  = TWiki::Func::extractNameValuePair( $text, "name1" );
my $val2  = TWiki::Func::extractNameValuePair( $text, "name2" );
Added:
>
>
Note: Function TWiki::Func::extractParameters is more efficient for extracting several parameters

entityEncode( $text, $extra ) -> $text

Entity encode text.

  • $text - Text to encode, may be empty
  • $extra - Additional characters to include in the set of encoded characters, optional
Return: $text Entity encoded text

Since: TWiki::Plugins::VERSION 6.00

Escape special characters to HTML numeric entities. This is not a generic encoding, it is tuned specifically for use in TWiki.

HTML4.0 spec: "Certain characters in HTML are reserved for use as markup and must be escaped to appear literally. The "<" character may be represented with an entity, &lt;. Similarly, ">" is escaped as &gt;, and "&" is escaped as &amp;. If an attribute value contains a double quotation mark and is delimited by double quotation marks, then the quote should be escaped as &quot;.

Other entities exist for special characters that cannot easily be entered with some keyboards..."

This method encodes HTML special and any non-printable ASCII characters (except for \n and \r) using numeric entities.

FURTHER this method also encodes characters that are special in TWiki meta-language.

$extras is an optional param that may be used to include additional characters in the set of encoded characters. It should be a string containing the additional chars.

entityDecode( $text ) -> $text

Decode all numeric entities (e.g. &#123;). Does not decode named entities such as &amp; (use HTML::Entities for that)

  • $text - Text to decode, may be empty
Return: $text Entity decoded text

Since: TWiki::Plugins::VERSION 6.00

urlEncode( $text ) -> $text

URL encode text, mainly used to encode URL parameters.

  • $text - Text to encode, may be empty
Return: $text URL encoded text

Since: TWiki::Plugins::VERSION 6.00

Encoding is done by converting characters that are illegal in URLs to their %NN equivalents. This method is used for encoding strings that must be embedded verbatim in URLs; it cannot be applied to URLs themselves, as it escapes reserved characters such as = and ?.

RFC 1738, Dec. '94:

    ...Only alphanumerics [0-9a-zA-Z], the special
    characters $-_.+!*'(), and reserved characters used for their
    reserved purposes may be used unencoded within a URL.

Reserved characters are $&+,/:;=?@ - these are also encoded by this method.

This URL-encoding handles all character encodings including ISO-8859-*, KOI8-R, EUC-* and UTF-8.

This may not handle EBCDIC properly, as it generates an EBCDIC URL-encoded URL, but mainframe web servers seem to translate this outbound before it hits browser - see CGI::Util::escape for another approach.

urlDecode( $text ) -> $text

URL decode text, mainly used to decode URL parameters.

  • $text - Text to decode, may be empty
Return: $text URL decoded text

Since: TWiki::Plugins::VERSION 6.00

 

Deprecated functions

Line: 2191 to 2440
 
  • beforeAttachmentSaveHandler(\%attrHash, $topic, $web, $meta) = added =$meta
  • writeLog( $action, $extra, $web, $topic, $user )
Added:
>
>

TWiki-6.0 (Jerusalem Release)

$TWiki::Plugins::VERSION 6.00

EmptyPlugin.pm

No changes

Func.pm

  • isAnAdmin( $user, $topic, $web ) -> $boolean -- added $topic and $web
  • expandVariablesOnTopicCreation( $text, $web, $topic ) -> $text -- added $web and $topic
  • postExternalResource( $url, $text, \@headers, \%params ) -> $response
  • registerExternalHTTPHandler( \&fn )
  • getContentMode( $web ) -> $contentMode
  • webWritable( $web ) -> $boolean
  • getDiskList() -> @diskIDs
  • getDiskInfo($web, $siteName) -> ($dataDir, $pubDir, $diskID)
  • trashWebName(web => $web | disk => $diskID) -> $trashWebName
  • entityEncode( $text, $extra ) -> $text
  • entityDecode( $text ) -> $text
  • urlEncode( $text ) -> $text
  • urlDecode( $text ) -> $text

Revision 152013-02-16 - TWikiContributor

Line: 315 to 315
 
    • WebPreferences topic has: * Set WEBBGCOLOR = #FFFFC0
    • my $webColor = TWiki::Func::getPreferencesValue( 'WEBBGCOLOR', 'Sandbox' );
Changed:
<
<
NOTE: As of TWiki4.1, if $NO_PREFS_IN_TOPIC is enabled in the plugin, then
>
>
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.
Line: 330 to 330
  Since: TWiki::Plugins::VERSION 1.021 (27 Mar 2004)
Changed:
<
<
NOTE: As of TWiki4.1, if $NO_PREFS_IN_TOPIC is enabled in the plugin, then
>
>
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.
Line: 349 to 349
 
    • Use "MYPLUGIN_SHOWHELP" for $key
    • my $showHelp = TWiki::Func::getPreferencesFlag( "MYPLUGIN_SHOWHELP" );
Changed:
<
<
NOTE: As of TWiki4.1, if $NO_PREFS_IN_TOPIC is enabled in the plugin, then
>
>
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.
Line: 364 to 364
  Since: TWiki::Plugins::VERSION 1.021 (27 Mar 2004)
Changed:
<
<
NOTE: As of TWiki4.1, if $NO_PREFS_IN_TOPIC is enabled in the plugin, then
>
>
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.

Revision 142012-10-07 - TWikiContributor

Line: 112 to 112
 

Changed:
<
<

getExternalResource( $url ) -> $response

>
>

getExternalResource( $url, @headers ) -> $response

  Get whatever is at the other end of a URL (using an HTTP GET request). Will only work for encrypted protocols such as https if the LWP CPAN module is installed.

Note that the $url may have an optional user and password, as specified by

Changed:
<
<
the relevant RFC. Any proxy set in configure is honoured.
>
>
the relevant RFC. Any proxy set in configure is honored.

Optional headers may be supplied of form 'name1', 'value1', 'name2', 'value2'. Do not add a User-Agent header, it will be added.

  The $response is an object that is known to implement the following subset of the methods of LWP::Response. It may in fact be an LWP::Response object,
Line: 151 to 154
 
my $response = TWiki::Func::getExternalResource($url);
if (!$response->is_error() && $response->isa('HTTP::Response')) {
Changed:
<
<
... other methods of HTTP::Response may be called
>
>
$text = $response->content(); # ... other methods of HTTP::Response may be called
 } else {
Changed:
<
<
... only the methods listed above may be called
>
>
# ... only the methods listed above may be called
 }

Revision 132012-01-15 - TWikiContributor

Line: 1905 to 1905
 DEPRECATED since 1.2 - use getPreferencesValue instead to determine what permissions are set on the web, for example:
Changed:
<
<
foreach my $type qw( ALLOW DENY ) { foreach my $action qw( CHANGE VIEW ) {
>
>
foreach my $type ( 'ALLOW', 'DENY' ) { foreach my $action ( 'CHANGE', 'VIEW' ) {
  my $pref = $type . 'WEB' . $action; my $val = getPreferencesValue( $pref, $web ) || ''; if( $val =~ /\S/ ) {

Revision 122011-08-21 - TWikiContributor

Line: 697 to 697
 Since: TWiki::Plugins::VERSION 1.000 (14 Jul 2001)
Added:
>
>

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.
Return: true if web name is 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 )

Line: 794 to 808
 

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

Changed:
<
<
Test if topic exists
>
>
Test if topic exists.
 
  • $web - Web name, optional, e.g. 'Main'.
  • $topic - Topic name, required, e.g. 'TokyoOffice', or "Main.TokyoOffice"
Line: 805 to 819
 Since: TWiki::Plugins::VERSION 1.000 (14 Jul 2001)
Added:
>
>

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
Return: true if topic name is valid

Since: TWiki::Plugins::VERSION 1.4

 

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

Line: 851 to 875
  Since: TWiki::Plugins::VERSION 1.000 (29 Jul 2001)
Changed:
<
<
For example,
>
>
Example:
 
Changed:
<
<
my( $meta, $text ) = TWiki::Func::readTopic( $web, $topic ) $text =~ s/APPLE/ORANGE/g; TWiki::Func::saveTopic( $web, $topic, $meta, $text, { forcenewrevision => 1 } );
>
>
# 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

Line: 978 to 1011
 checkAccessPermission to ensure the current user has read access to the topic.
Added:
>
>
See usage example at TWiki::Func::saveTopic.
 Since: TWiki::Plugins::VERSION 1.000 (7 Dec 2002)
Line: 1369 to 1404
 
  • \%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
Added:
>
>
  • $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)
 for example, to execute an arbitrary command on the server, you might do this:
sub initPlugin{
Line: 1384 to 1421
  my $result = `$cmd 2>&1`; return $params->{silent} ? '' : $result; }
Deleted:
<
<
}
  would let you do this: %EXEC{"ps -Af" silent="on"}%
Line: 1677 to 1713
 Since: TWiki::Plugins::VERSION 1.020 (16 Feb 2004)
Added:
>
>

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.
  • $user - WikiName of user, optional. Name of logged-in user is taken if not specified.
Return: none

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
    TWiki::Func::writeLog( $web, $topic, 'myevent', $extra );
  } else {
    # deprecated code if plugin is used in older TWiki releases
    $TWiki::Plugins::VERSION > 1.1
      ? $TWiki::Plugins::SESSION->writeLog( 'myevent', "$web.$topic", $extra )
      : TWiki::Store::writeLog( 'myevent', "$web.$topic", $extra );
  }
 

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

Line: 1701 to 1772
 If the value is undef, then $default is returned. If $default is not specified it is taken as 0.
Changed:
<
<
Since: $TWiki::Plugins::VERSION 1.2
>
>
Since: TWiki::Plugins::VERSION 1.2
 

Line: 1990 to 2061
 
  • beforeCommonTagsHandler($text, $topic, $web)
  • earlyInitPlugin()

Func.pm

Changed:
<
<
  • afterAttachmentSaveHandler(\%attrHash, $topic, $web, $error)
  • beforeAttachmentSaveHandler(\%attrHash, $topic, $web)
>
>
  • afterAttachmentSaveHandler(\%attrHash, $topic, $web, $error, $meta)
  • beforeAttachmentSaveHandler(\%attrHash, $topic, $web, $meta)
 
  • checkDependencies($moduleName, $dependenciesRef) -> $error
  • extractParameters($attr) -> %params
  • formatTime($time, $format, $timezone) -> $text
Line: 2107 to 2178
 

Func.pm

  • buildWikiWord( $text ) -> $text
Added:
>
>

TWiki-5.1 (Istanbul Release)

$TWiki::Plugins::VERSION 1.4

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 )

Revision 112011-05-04 - TWikiContributor

Line: 50 to 52
 
On this page:
Added:
>
>
 

Environment

Added:
>
>
 

getSkin( ) -> $skin

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

Line: 62 to 66
 Since: TWiki::Plugins::VERSION 1.000 (29 Jul 2001)
Added:
>
>
 

getUrlHost( ) -> $host

Get protocol, domain and optional port of script URL

Line: 71 to 76
 Since: TWiki::Plugins::VERSION 1.000 (7 Dec 2002)
Added:
>
>
 

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

Compose fully qualified URL

Line: 84 to 90
 Since: TWiki::Plugins::VERSION 1.000 (7 Dec 2002)
Added:
>
>
 

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

Compose fully qualified view URL

Line: 94 to 101
 Since: TWiki::Plugins::VERSION 1.000 (7 Dec 2002)
Added:
>
>
 

getPubUrlPath( ) -> $path

Get pub URL path

Line: 103 to 111
 Since: TWiki::Plugins::VERSION 1.000 (14 Jul 2001)
Added:
>
>
 

getExternalResource( $url ) -> $response

Get whatever is at the other end of a URL (using an HTTP GET request). Will

Line: 151 to 160
 Since: TWiki::Plugins::VERSION 1.2
Added:
>
>
 

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

Line: 160 to 170
 Since: TWiki::Plugins::VERSION 1.000 (7 Dec 2002)
Added:
>
>
 

getSessionKeys() -> @keys

Get a list of all the names of session variables. The list is unsorted.
Line: 169 to 180
 Since: TWiki::Plugins::VERSION 1.2
Added:
>
>
 

getSessionValue( $key ) -> $value

Get a session value from the client session module

Line: 178 to 190
 Since: TWiki::Plugins::VERSION 1.000 (27 Feb 200)
Added:
>
>
 

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

Set a session value.

Line: 188 to 201
 Since: TWiki::Plugins::VERSION 1.000 (17 Aug 2001)
Added:
>
>
 

clearSessionValue( $key ) -> $boolean

Clear a session value that was set using setSessionValue.

Line: 198 to 212
 Since: TWiki::Plugins::VERSION 1.1
Added:
>
>
 

getContext() -> \%hash

Get a hash of context identifiers representing the currently active

Line: 244 to 259
 Since: TWiki::Plugins::VERSION 1.1
Added:
>
>
 

pushTopicContext($web, $topic)

  • $web - new web
  • $topic - new topic
Line: 263 to 279
 Since: TWiki::Plugins::VERSION 1.2
Added:
>
>
 

popTopicContext()

Returns the TWiki context to the state it was in before the

Line: 271 to 288
 Since: TWiki::Plugins::VERSION 1.2
Added:
>
>
 

Preferences

Added:
>
>
 

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

Get a preferences value from TWiki or from a Plugin

Line: 296 to 315
 preferences set in the plugin topic will be ignored.
Added:
>
>
 

getPluginPreferencesValue( $key ) -> $value

Get a preferences value from your Plugin

Line: 310 to 330
 preferences set in the plugin topic will be ignored.
Added:
>
>
 

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

Get a preferences flag from TWiki or from a Plugin

Line: 328 to 349
 preferences set in the plugin topic will be ignored.
Added:
>
>
 

getPluginPreferencesFlag( $key ) -> $boolean

Get a preferences flag from your Plugin

Line: 342 to 364
 preferences set in the plugin topic will be ignored.
Added:
>
>
 

setPreferencesValue($name, $val)

Set the preferences value so that future calls to getPreferencesValue will

Line: 354 to 377
 Returns 1 if the preference was defined, and 0 otherwise.
Added:
>
>
 

getWikiToolName( ) -> $name

Get toolname as defined in TWiki.cfg

Line: 363 to 387
 Since: TWiki::Plugins::VERSION 1.000 (27 Feb 2001)
Added:
>
>
 

getMainWebname( ) -> $name

Get name of Main web as defined in TWiki.cfg

Line: 372 to 397
 Since: TWiki::Plugins::VERSION 1.000 (27 Feb 2001)
Added:
>
>
 

getTwikiWebname( ) -> $name

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

Line: 381 to 407
 Since: TWiki::Plugins::VERSION 1.000 (27 Feb 2001)
Added:
>
>
 

User Handling and Access Control

Added:
>
>
 

getDefaultUserName( ) -> $loginName

Get default user name as defined in the configuration as DefaultUserLogin
Line: 390 to 420
 Since: TWiki::Plugins::VERSION 1.000 (7 Dec 2002)
Added:
>
>
 

getCanonicalUserID( $user ) -> $cUID

  • $user can be a login, wikiname or web.wikiname
Return the cUID of the specified user. A cUID is a unique identifier which
Line: 408 to 439
 Since: TWiki::Plugins::VERSION 1.2
Added:
>
>
 

getWikiName( $user ) -> $wikiName

return the WikiName of the specified user

Line: 420 to 452
 Since: TWiki::Plugins::VERSION 1.000 (7 Dec 2002)
Added:
>
>
 

getWikiUserName( $user ) -> $wikiName

return the userWeb.WikiName of the specified user

Line: 432 to 465
 Since: TWiki::Plugins::VERSION 1.000 (7 Dec 2002)
Added:
>
>
 

wikiToUserName( $id ) -> $loginName

Translate a Wiki name to a login name.
  • $id - Wiki name, e.g. 'Main.JohnDoe' or 'JohnDoe'.
Line: 451 to 485
 Since: TWiki::Plugins::VERSION 1.000 (7 Dec 2002)
Added:
>
>
 

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

Translate a login name to a Wiki name
  • $loginName - Login name, e.g. 'jdoe'. Since TWiki 4.2.1 this may
Line: 465 to 500
 Since: TWiki::Plugins::VERSION 1.000 (7 Dec 2002)
Added:
>
>
 

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

  • $email - email address to look up
  • $dontAddWeb - Do not add web prefix if "1"
Line: 475 to 511
 Since: TWiki::Plugins::VERSION 1.2
Added:
>
>
 

wikinameToEmails( $user ) -> @emails

  • $user - wikiname of user to look up
Returns the registered email addresses of the named user. If $user is
Line: 485 to 522
 Since: TWiki::Plugins::VERSION 1.2
Added:
>
>
 

isGuest( ) -> $boolean

Test if logged in user is a guest (TWikiGuest)

Line: 492 to 530
 Since: TWiki::Plugins::VERSION 1.000 (7 Dec 2002)
Added:
>
>
 

isAnAdmin( $id ) -> $boolean

Find out if the user is an admin or not. If the user is not given,

Line: 501 to 540
 Since: TWiki::Plugins::VERSION 1.2
Added:
>
>
 

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

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

Line: 516 to 556
 Since: TWiki::Plugins::VERSION 1.2
Added:
>
>
 

eachUser() -> $iterator

Get an iterator over the list of all the registered users not including groups. The iterator will return each wiki name in turn (e.g. 'FredBloggs').
Line: 534 to 575
 Since: TWiki::Plugins::VERSION 1.2
Added:
>
>
 

eachMembership($id) -> $iterator

  • $id - WikiName or login name of the user. If $id is undef, defaults to the currently logged-in user.
Line: 542 to 584
 Since: TWiki::Plugins::VERSION 1.2
Added:
>
>
 

eachGroup() -> $iterator

Get an iterator over all groups.
Line: 559 to 602
 Since: TWiki::Plugins::VERSION 1.2
Added:
>
>
 

isGroup( $group ) -> $boolean

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

Added:
>
>
 

eachGroupMember($group) -> $iterator

Get an iterator over all the members of the named group. Returns undef if $group is not a valid group.
Line: 582 to 627
 Since: TWiki::Plugins::VERSION 1.2
Added:
>
>
 

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

Check access permission for a topic based on the

Line: 617 to 663
 Since: TWiki::Plugins::VERSION 1.000 (27 Feb 2001)
Added:
>
>
 

Webs, Topics and Attachments

Added:
>
>
 

getListOfWebs( $filter ) -> @webs

  • $filter - spec of web types to recover
Line: 640 to 688
 Since: TWiki::Plugins::VERSION 1.1
Added:
>
>
 

webExists( $web ) -> $boolean

Test if web exists

Line: 648 to 697
 Since: TWiki::Plugins::VERSION 1.000 (14 Jul 2001)
Added:
>
>
 

createWeb( $newWeb, $baseWeb, $opts )

  • $newWeb is the name of the new web.
Line: 675 to 725
 Since: TWiki::Plugins::VERSION 1.1
Added:
>
>
 

moveWeb( $oldName, $newName )

Move (rename) a web.

Line: 704 to 755
 Since: TWiki::Plugins::VERSION 1.1
Added:
>
>
 

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

Get an iterator over the list of all the changes in the given web between

Line: 729 to 781
 
Added:
>
>
 

getTopicList( $web ) -> @topics

Get list of all topics in a web

Line: 738 to 791
 Since: TWiki::Plugins::VERSION 1.000 (7 Dec 2002)
Added:
>
>
 

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

Test if topic exists

Line: 751 to 805
 Since: TWiki::Plugins::VERSION 1.000 (14 Jul 2001)
Added:
>
>
 

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

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

Line: 762 to 817
 Since: TWiki::Plugins::VERSION 1.010 (31 Dec 2002)
Added:
>
>
 

setTopicEditLock( $web, $topic, $lock )

  • $web Web name, e.g. "Main", or empty
Line: 779 to 835
 Since: TWiki::Plugins::VERSION 1.010 (31 Dec 2002)
Added:
>
>
 

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

  • $web - web for the topic
Line: 805 to 862
 appropriate.
Added:
>
>
 

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.

Line: 835 to 893
 
Added:
>
>
 

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

  • $web source web - required
Line: 868 to 927
 
Added:
>
>
 

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

Get revision info of a topic or attachment

Line: 888 to 948
 Since: TWiki::Plugins::VERSION 1.000 (29 Jul 2001)
Added:
>
>
 

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

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

Line: 900 to 961
 Since: TWiki::Plugins::VERSION 1.1
Added:
>
>
 

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

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

Line: 919 to 981
 Since: TWiki::Plugins::VERSION 1.000 (7 Dec 2002)
Added:
>
>
 

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

Read topic text, including meta data

Line: 933 to 996
 Since: TWiki::Plugins::VERSION 1.010 (31 Dec 2002)
Added:
>
>
 

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

Test if attachment exists

Line: 944 to 1008
 Since: TWiki::Plugins::VERSION 1.1
Added:
>
>
 

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

  • $web - web for topic
Line: 975 to 1040
 Since: TWiki::Plugins::VERSION 1.1
Added:
>
>
 

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

  • $web - web for topic
Line: 1009 to 1075
 Since: TWiki::Plugins::VERSION 1.1
Added:
>
>
 

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

  • $web source web - required
Line: 1046 to 1113
 Since: TWiki::Plugins::VERSION 1.1
Added:
>
>
 

Assembling Pages

Added:
>
>
 

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

Read a template or skin. Embedded template directives get expanded

Line: 1059 to 1128
 Since: TWiki::Plugins::VERSION 1.000 (7 Dec 2002)
Added:
>
>
 

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

  • $name - template file name
Line: 1076 to 1146
 If template text is found, extracts include statements and fully expands them.
Added:
>
>
 

expandTemplate( $def ) -> $string

Do a , only expanding the template (not expanding any variables other than %TMPL)

Line: 1088 to 1159
 file. See the documentation on TWiki templates for more information.
Added:
>
>
 

writeHeader( )

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

Line: 1097 to 1169
 Since: TWiki::Plugins::VERSION 1.000 (7 Dec 2002)
Added:
>
>
 

redirectCgiQuery( $query, $url, $passthru )

Redirect to URL

Line: 1132 to 1205
 Since: TWiki::Plugins::VERSION 1.000 (7 Dec 2002)
Added:
>
>
 

addToHEAD( $id, $header, $requires )

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

Line: 1152 to 1226
 
Added:
>
>
 

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

Expand all common %VARIABLES%

Line: 1166 to 1241
 See also: expandVariablesOnTopicCreation
Added:
>
>
 

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

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

Line: 1176 to 1252
 Since: TWiki::Plugins::VERSION 1.000 (7 Dec 2002)
Added:
>
>
 

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()

Line: 1190 to 1267
 Since: TWiki::Plugins::VERSION 1.000 (7 Dec 2002)
Added:
>
>
 

E-mail

Added:
>
>
 

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

  • $text - text of the mail, including MIME headers
Line: 1218 to 1297
 Since: TWiki::Plugins::VERSION 1.1
Added:
>
>
 

wikiToEmail( $wikiName ) -> $email

  • $wikiname - wiki name of the user
Line: 1233 to 1313
 Since TWiki 4.2.1, $wikiName may also be a login name.
Added:
>
>
 

Creating New Topics

Added:
>
>
 

expandVariablesOnTopicCreation ( $text ) -> $text

Expand the limited set of variables that are always expanded during topic creation

Line: 1260 to 1342
 See also: expandVariables
Changed:
<
<

Special handlers

>
>

Special Handlers

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

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

Should only be called from initPlugin.

Line: 1312 to 1396
 
  • registered tag handlers cannot return another tag as their only result (e.g. return '%SERVERTIME%';). It won't work.
Added:
>
>
 

registerRESTHandler( $alias, \&fn, )

Should only be called from initPlugin.

Line: 1353 to 1438
 (ie, with the name of the function instead of the alias) will not work.
Added:
>
>
 

decodeFormatTokens($str) -> $unencodedString

TWiki has an informal standard set of tokens used in format

Line: 1384 to 1470
 Since: TWiki::Plugins::VERSION 1.2
Added:
>
>
 

Searching

Added:
>
>
 

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+{.*}%)

Line: 1396 to 1484
 
  • \%option - reference to an options hash
The \%options hash may contain the following options:
  • type - if regex will perform a egrep-syntax RE search (default '')
Changed:
<
<
  • casesensitive - false to ignore case (defaulkt true)
>
>
  • 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

Line: 1415 to 1503
 Since: TWiki::Plugins::VERSION 1.1
Changed:
<
<

Plugin-specific file handling

>
>

Plugin-specific File Handling

 
Added:
>
>
 

getWorkArea( $pluginName ) -> $directorypath

Gets a private directory for Plugin use. The Plugin is entirely responsible

Line: 1432 to 1522
 Since: TWiki::Plugins::VERSION 1.1 (Dec 2005)
Added:
>
>
 

readFile( $filename ) -> $text

Read file, low level. Used for Plugin workarea.

Line: 1443 to 1534
 Since: TWiki::Plugins::VERSION 1.000 (07 Dec 2002)
Added:
>
>
 

saveFile( $filename, $text )

Save file, low level. Used for Plugin workarea.

Line: 1455 to 1547
 Since: TWiki::Plugins::VERSION 1.000 (07 Dec 2002)
Added:
>
>
 

General Utilities

Added:
>
>
 

getRegularExpression( $name ) -> $expr

Retrieves a TWiki predefined regular expression or character class.

Line: 1502 to 1596
 
tagNameRegex Standard variable names e.g. %THIS_BIT% (THIS_BIT only) RE
Added:
>
>
 

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

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

Line: 1530 to 1625
 
( '', '%DOCWEB%.Topic' ) ( 'TWiki', 'Topic' )
Changed:
<
<

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

>
>

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

  Given a file namer, sanitise it according to the rules for transforming attachment names. Returns
Line: 1542 to 1638
 Since: TWiki::Plugins::VERSION 1.2
Changed:
<
<
>
>
 

buildWikiWord( $text ) -> $text

Converts arbitrary text to a WikiWord.

Line: 1552 to 1648
 Since: TWiki::Plugins::VERSION 1.3 (18 Jan 2010)
Added:
>
>
 

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

Spaces out a wiki word by inserting a string (default: one space) between each word component.

Line: 1560 to 1657
 Since: TWiki::Plugins::VERSION 1.2
Added:
>
>
 

writeWarning( $text )

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

Line: 1569 to 1667
 Since: TWiki::Plugins::VERSION 1.020 (16 Feb 2004)
Added:
>
>
 

writeDebug( $text )

Log debug message to data/debug.txt

Line: 1578 to 1677
 Since: TWiki::Plugins::VERSION 1.020 (16 Feb 2004)
Added:
>
>
 

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

Format the time in seconds into the desired time string

Line: 1590 to 1690
 Since: TWiki::Plugins::VERSION 1.020 (26 Feb 2004)
Added:
>
>
 

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

Returns 1 if $value is true, and 0 otherwise. "true" means set to

Line: 1603 to 1704
 Since: $TWiki::Plugins::VERSION 1.2
Added:
>
>
 

isValidWikiWord ( $text ) -> $boolean

Check for a valid WikiWord or WikiName

Line: 1611 to 1713
 Since: TWiki::Plugins::VERSION 1.100 (Dec 2005)
Added:
>
>
 

extractParameters($attr ) -> %params

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

Line: 1630 to 1733
  name2 => "val2"
Added:
>
>
 

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

Extract a named or unnamed value from a variable parameter string

Line: 1649 to 1753
  my $val2  = TWiki::Func::extractNameValuePair( $text, "name2" );
Added:
>
>
 

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.

Line: 1666 to 1771
 The following functions are retained for compatibility only. You should stop using them as soon as possible.
Added:
>
>
 

getScriptUrlPath( ) -> $path

Get script URL path

Line: 1681 to 1787
 Since: TWiki::Plugins::VERSION 1.000 (7 Dec 2002)
Added:
>
>
 

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

Compose fully qualified 'oops' dialog URL

Line: 1715 to 1822
 Since: TWiki::Plugins::VERSION 1.000 (7 Dec 2002)
Added:
>
>
 

permissionsSet( $web ) -> $boolean

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

Line: 1738 to 1846
 
Added:
>
>
 

getPublicWebList( ) -> @webs

DEPRECATED since 1.1 - use getListOfWebs instead.

Line: 1749 to 1858
 Since: TWiki::Plugins::VERSION 1.000 (07 Dec 2002)
Added:
>
>
 

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

DEPRECATED since 1.1 - use formatTime instead.

Line: 1761 to 1871
 Since: TWiki::Plugins::VERSION 1.000 (7 Dec 2002)
Added:
>
>
 

getDataDir( ) -> $dir

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

Line: 1774 to 1885
 Since: TWiki::Plugins::VERSION 1.000 (07 Dec 2002)
Added:
>
>
 

getPubDir( ) -> $dir

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

Line: 1789 to 1901
 Since: TWiki::Plugins::VERSION 1.000 (07 Dec 2002)
Added:
>
>
 

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

DEPRECATED since 1.1 - use TWiki:Plugins.BuildContrib and define DEPENDENCIES that can be statically

Line: 1797 to 1910
 Since: TWiki::Plugins::VERSION 1.025 (01 Aug 2004)
Added:
>
>
 

TWiki API History

TWiki-2001-09-01 (Athens Release)

Revision 102010-05-29 - TWikiContributor

Line: 5 to 5
  Official list of stable TWiki functions for Plugin developers
Changed:
<
<
This module defines official functions that Plugins
>
>
This module defines official functions that TWiki plugins
 can use to interact with the TWiki engine and content.
Changed:
<
<
Refer to EmptyPlugin and lib/TWiki/Plugins/EmptyPlugin.pm for a template Plugin and documentation on how to write a Plugin.
>
>
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
Changed:
<
<
you will probably need to change your Plugin when you upgrade TWiki.
>
>
you will probably need to change your plugin when you upgrade TWiki.
  Deprecated functions will still work in older code, though they should
Changed:
<
<
not be called in new Plugins and should be replaced in older Plugins
>
>
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

Line: 611 to 612
  Tip if you want, you can use this method to check your own access control types. For example, if you:
Changed:
<
<
in ThatWeb.ThisTopic, then a call to checkAccessPermissions('SPIN', 'IncyWincy', undef, 'ThisTopic', 'ThatWeb', undef) will return true.
>
>
in ThatWeb.ThisTopic, then a call to checkAccessPermission('SPIN', 'IncyWincy', undef, 'ThisTopic', 'ThatWeb', undef) will return true.
  Since: TWiki::Plugins::VERSION 1.000 (27 Feb 2001)
Line: 912 to 913
 release, or can be inspected in the lib/TWiki/Meta.pm file.

This method ignores topic access permissions. You should be careful to use

Changed:
<
<
checkAccessPermissions to ensure the current user has read access to the
>
>
checkAccessPermission to ensure the current user has read access to the
 topic.

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

Line: 1087 to 1088
 file. See the documentation on TWiki templates for more information.
Changed:
<
<

writeHeader( $query, $contentLength )

>
>

writeHeader( )

 
Changed:
<
<
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 (optional, in most cases you should not pass this parameter)
  • $contentLength - Length of content (optional, in most cases you should not pass this parameter)
Return: none
>
>
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)
Line: 1132 to 1132
 Since: TWiki::Plugins::VERSION 1.000 (7 Dec 2002)
Changed:
<
<

addToHEAD( $id, $header )

>
>

addToHEAD( $id, $header, $requires )

  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.
Added:
>
>
  • requires optional, comma-separated list of id's of other head blocks this one depends on.
  All TWiki variables present in $header will be expanded before being inserted into the section.
Line: 1147 to 1148
  example:
Changed:
<
<
TWiki::Func::addToHEAD('PATTERN_STYLE','')
>
>
TWiki::Func::addToHEAD('PATTERN_STYLE','');
 
Line: 1542 to 1543
 
Added:
>
>

buildWikiWord( $text ) -> $text

Converts arbitrary text to a WikiWord.

  • $pre - Arbitrary Text
Return: $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.

Line: 1786 to 1796
  Since: TWiki::Plugins::VERSION 1.025 (01 Aug 2004)
Added:
>
>

TWiki API History

TWiki-2001-09-01 (Athens Release)

$TWiki::Plugins::VERSION 1.000

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)

$TWiki::Plugins::VERSION 1.010

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)

$TWiki::Plugins::VERSION 1.025

EmptyPlugin.pm

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

Func.pm

  • afterAttachmentSaveHandler(\%attrHash, $topic, $web, $error)
  • beforeAttachmentSaveHandler(\%attrHash, $topic, $web)
  • 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)

$TWiki::Plugins::VERSION 1.1

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)

$TWiki::Plugins::VERSION 1.1

EmptyPlugin.pm

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

Func.pm

TWiki-4.1 (Edinburgh Release)

$TWiki::Plugins::VERSION 1.11

EmptyPlugin.pm

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

Func.pm

No changes

TWiki-4.2 (Freetown Release)

$TWiki::Plugins::VERSION 1.2

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)

$TWiki::Plugins::VERSION 1.2

EmptyPlugin.pm

No changes

Func.pm

No changes

TWiki-5.0 (Helsinki Release)

$TWiki::Plugins::VERSION 1.3

EmptyPlugin.pm

No changes

Func.pm

  • buildWikiWord( $text ) -> $text

Revision 92008-12-06 - TWikiContributor

Line: 208 to 208
 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
Changed:
<
<
in the TWikiTemplates topic. Please be careful not to
>
>
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

Revision 82008-08-03 - TWikiContributor

Line: 390 to 390
 

getCanonicalUserID( $user ) -> $cUID

Added:
>
>
  • $user can be a login, wikiname or web.wikiname
 Return the cUID of the specified user. A cUID is a unique identifier which is assigned by TWiki for each user. BEWARE: While the default TWikiUserMapping uses a cUID that looks like a user's LoginName, some characters are modified to make them compatible with rcs.
Changed:
<
<
Additionally, other usermappings will use other conventions - the JoomlauserMapping
>
>
Other usermappings may use other conventions - the JoomlaUserMapping
 for example, has cUIDs like 'JoomlaeUserMapping_1234'.

Changed:
<
<
If $user is undefined Get the cUID of logged in user, and will generally be 'BaseUserMapping_666'
>
>
If $user is undefined, it assumes the currently logged-in user.
 
Changed:
<
<
  • $user can be a cUID, login, wikiname or web.wikiname

Return: $cUID an internal unique and transportable escaped identifier for registered users (they can be autogenerated for an authenticated but unregistered 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
Line: 433 to 431
 Since: TWiki::Plugins::VERSION 1.000 (7 Dec 2002)
Changed:
<
<

wikiToUserName( $wikiName ) -> $loginName

Translate a Wiki name (or login name or cUID, if it can) to a login name.
  • $wikiName - Wiki name, e.g. 'Main.JohnDoe' or 'JohnDoe'
>
>

wikiToUserName( $id ) -> $loginName

Translate a Wiki name to a login name.
  • $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.
Line: 450 to 452
 

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

Translate a login name to a Wiki name
Changed:
<
<
  • $loginName - Login name, e.g. 'jdoe'
>
>
  • $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"
Return: $wikiName Wiki name of user, e.g. 'Main.JohnDoe' or 'JohnDoe'
Changed:
<
<
userToWikiName will always return a name, if the user does not
>
>
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)

Line: 470 to 474
 Since: TWiki::Plugins::VERSION 1.2
Changed:
<
<

wikiNameToEmails( $wikiname ) -> @emails

  • $wikiname - wikiname of user to look up
Returns the registered email addresses of the named user. If $wikiname is
>
>

wikinameToEmails( $user ) -> @emails

  • $user - wikiname of user to look up
Returns the registered email addresses of the named user. If $user is
 undef, returns the registered email addresses for the logged-in user.
Added:
>
>
Since TWiki 4.2.1, $user may also be a login name, or the name of a group.
 Since: TWiki::Plugins::VERSION 1.2
Line: 485 to 491
 Since: TWiki::Plugins::VERSION 1.000 (7 Dec 2002)
Changed:
<
<

isAnAdmin( $login ) -> $boolean

>
>

isAnAdmin( $id ) -> $boolean

  Find out if the user is an admin or not. If the user is not given, the currently logged-in user is assumed.
Changed:
<
<
  • $login can be either a login, or a CUID
>
>
  • $id can be either a login name or a WikiName
  Since: TWiki::Plugins::VERSION 1.2
Changed:
<
<

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

>
>

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

 
Changed:
<
<
Find out if $login is in the named group. e.g.
>
>
Find out if $id is in the named group. e.g.
 
if( TWiki::Func::isGroupMember( "HesperionXXGroup", "jordi" )) {
    ...
Line: 504 to 510
  If $user is undef, it defaults to the currently logged-in user.
Changed:
<
<
  • $login can be a login name, or a cUID, or WikiName
>
>
  Since: TWiki::Plugins::VERSION 1.2
Line: 527 to 533
 Since: TWiki::Plugins::VERSION 1.2
Changed:
<
<

eachMembership($wikiname) -> $iterator

>
>

eachMembership($id) -> $iterator

  • $id - WikiName or login name of the user. If $id is undef, defaults to the currently logged-in user.
 Get an iterator over the names of all groups that the user is a member of.
Deleted:
<
<
If $wikiname is undef, defaults to the currently logged-in user.
  Since: TWiki::Plugins::VERSION 1.2
Line: 574 to 581
 Since: TWiki::Plugins::VERSION 1.2
Changed:
<
<

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

>
>

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'.
Changed:
<
<
  • $wikiName - WikiName of remote user, required, e.g. "PeterThoeny". If $wikiName is '', 0 or undef then access is always permitted.
>
>
  • $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:
Line: 598 to 606
  Settings in $meta override Set settings in $text. A perl true result indicates that access is permitted.
Changed:
<
<
Note the wierd parameter order is due to compatibility constraints with
>
>
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:

Line: 708 to 716
 
    my $iterator = TWiki::Func::eachChangeSince(
        $web, time() - 7 * 24 * 60 * 60); # the last 7 days
Changed:
<
<
while ($it->hasNext()) { my $change = $it->next();
>
>
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
Line: 779 to 787
 
  • \%options - ref to hash of save options \%options may include:
    dontlog don't log this change in twiki log
Changed:
<
<
comment comment for save
>
>
forcenewrevision force the save to increment the revision counter
 
minor True if this is a minor change, and is not to be notified
Return: error message or undef.
Line: 789 to 797
 
my( $meta, $text ) = TWiki::Func::readTopic( $web, $topic )
$text =~ s/APPLE/ORANGE/g;
Changed:
<
<
TWiki::Func::saveTopic( $web, $topic, $meta, $text, { comment => 'refruited' } );
>
>
TWiki::Func::saveTopic( $web, $topic, $meta, $text, { forcenewrevision => 1 } );
 

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

Line: 903 to 911
 fully documented in the source code documentation shipped with the release, or can be inspected in the lib/TWiki/Meta.pm file.
Changed:
<
<
This method ignores topic access permissions. You should be careful to use checkAccessPermissions to ensure the current user has read access to the topic.
>
>
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)
Line: 1209 to 1219
 

wikiToEmail( $wikiName ) -> $email

Changed:
<
<
  • $wikiName - wiki name of the user
>
>
  • $wikiname - wiki name of the user
 Get the e-mail address(es) of the named user. If the user has multiple e-mail addresses (for example, the user is a group), then the list will be comma-separated.

Since: TWiki::Plugins::VERSION 1.1

Added:
>
>
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

Revision 72008-01-22 - TWikiContributor

Line: 5 to 5
  Official list of stable TWiki functions for Plugin developers
Changed:
<
<
This module defines official functions that Plugins
>
>
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.

Line: 20 to 20
  The version of the TWiki::Func module is defined by the VERSION number of the TWiki::Plugins module, currently 6.02. This can be shown
Changed:
<
<
by the %PLUGINVERSION% variable. The 'Since' field in the function documentation refers to the VERSION number and the date that the function was addded.

Note: Beware! These methods should only ever be called from the context of a TWiki Plugin. They require a Plugins SESSION context to be established before they are called, and will not work if simply called from another TWiki module. For example,

use TWiki;
print TWiki::Func::getSkin(),"\n";
will fail with Can't call method "getSkin" on an undefined value at TWiki/Func.pm line 83.

If you want to call the methods outside the context of a plugin, you can create a Plugins SESSION object. For example, the script:

use TWiki:
$TWiki::Plugins::SESSION = new TWiki();
print TWiki::Func::getSkin(),"\n";
will work happily.
>
>
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.

Notes on use of $TWiki::Plugins::VERSION (from 1.2 forwards):

  • If the major version (e.g. 1.) is the same then any plugin coded to use any earlier revision of the 1. API will still work. No function has been removed from the interface, nor has any API published in that version changed in such a way as to require plugins to be recoded.
  • If the minor version (e.g. 1.1) is incremented there may be changes in the API that may help improve the coding of some plugins - for example, new interfaces giving access to previously hidden core functions. In addition, deprecation of functions in the interface trigger a minor version increment. Note that deprecated functions are not removed, they are merely frozen, and plugin authors are recommended to stop using them.
  • Any additional digits in the version number relate to minor changes, such as the addition of parameters to the existing functions, or addition of utility functions that are unlikely to require significant changes to existing plugins.
  • 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.
 

On this page:
Line: 73 to 76
 
  • $web - Web name, e.g. 'Main'
  • $topic - Topic name, e.g. 'WebNotify'
  • $script - Script name, e.g. 'view'
Changed:
<
<
  • ... - 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
>
>
  • ... - 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"
Line: 90 to 93
 Since: TWiki::Plugins::VERSION 1.000 (7 Dec 2002)
Changed:
<
<

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
Return: $url URL, e.g. "http://example.com:80/cgi-bin/oops.pl/ Main/WebNotify?template=oopslocked&param1=joe"
>
>

getPubUrlPath( ) -> $path

 
Changed:
<
<
This might be used like this:
   my $url = TWiki::Func::getOopsUrl($web, $topic, 'oopsmistake', 'I made a boo-boo');
   TWiki::Func::redirectCgiQuery( undef, $url );
   return 0;
>
>
Get pub URL path
 
Changed:
<
<
Since: TWiki::Plugins::VERSION 1.000 (7 Dec 2002)
>
>
Return: $path URL path of pub directory, e.g. "/pub"
 
Changed:
<
<
Since TWiki::Plugins::VERSION 1.1, the recommended approach is to throw an oops exception.
   use Error qw( :try );
>
>
Since: TWiki::Plugins::VERSION 1.000 (14 Jul 2001)
 
Deleted:
<
<
throw TWiki::OopsException($web, $topic, undef, 0, [ 'I made a boo-boo' ]); and let TWiki handle the cleanup.
 
Added:
>
>

getExternalResource( $url ) -> $response

 
Changed:
<
<

getPubUrlPath( ) -> $path

>
>
Get whatever is at the other end of a URL (using an HTTP GET request). Will only work for encrypted protocols such as https if the LWP CPAN module is installed.

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

The $response is an object that is known to implement the following subset of the methods of LWP::Response. It may in fact be an LWP::Response object, but it may also not be if LWP is not available, so callers may only assume the following subset of methods is available:

code()
message()
header($field)
content()
is_error()
is_redirect()

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).

 
Changed:
<
<
Get pub URL path
>
>
Note: Callers can easily check the availability of other HTTP::Response methods as follows:
 
Changed:
<
<
Return: $path URL path of pub directory, e.g. "/pub"
>
>
my $response = TWiki::Func::getExternalResource($url);
if (!$response->is_error() && $response->isa('HTTP::Response')) {
    ... other methods of HTTP::Response may be called
} else {
    ... only the methods listed above may be called
}
 
Changed:
<
<
Since: TWiki::Plugins::VERSION 1.000 (14 Jul 2001)
>
>
Since: TWiki::Plugins::VERSION 1.2
 

getCgiQuery( ) -> $query

Line: 135 to 159
 Since: TWiki::Plugins::VERSION 1.000 (7 Dec 2002)
Added:
>
>

getSessionKeys() -> @keys

Get a list of all the names of session variables. The list is unsorted.

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

Line: 175 to 208
 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
Changed:
<
<
in the TWikiTemplates topic. Please be careful not to
>
>
in the TWikiTemplates topic. Please be careful not to
 overwrite any of these identifiers!

Context identifiers can be used to communicate between Plugins, and between

Line: 210 to 243
 Since: TWiki::Plugins::VERSION 1.1
Added:
>
>

pushTopicContext($web, $topic)

  • $web - new web
  • $topic - new topic
Change the TWiki context so it behaves as if it was processing $web.$topic from now on. All the preferences will be reset to those of the new topic. Note that if the new topic is not readable by the logged in user due to access control considerations, there will not be an exception. It is the duty of the caller to check access permissions before changing the 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

Line: 281 to 341
 preferences set in the plugin topic will be ignored.
Added:
>
>

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

Line: 319 to 389
 Since: TWiki::Plugins::VERSION 1.000 (7 Dec 2002)
Changed:
<
<

getWikiName( ) -> $wikiName

>
>

getCanonicalUserID( $user ) -> $cUID

Return the cUID of the specified user. A cUID is a unique identifier which is assigned by TWiki for each user. BEWARE: While the default TWikiUserMapping uses a cUID that looks like a user's LoginName, some characters are modified to make them compatible with rcs. Additionally, other usermappings will use other conventions - the JoomlauserMapping for example, has cUIDs like 'JoomlaeUserMapping_1234'.

If $user is undefined Get the cUID of logged in user, and will generally be 'BaseUserMapping_666'

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

Return: $cUID an internal unique and transportable escaped identifier for registered users (they can be autogenerated for an authenticated but unregistered user)

 
Changed:
<
<
Get Wiki name of logged in 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)

Changed:
<
<

getWikiUserName( ) -> $wikiName

>
>

getWikiUserName( $user ) -> $wikiName

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

 
Changed:
<
<
Get Wiki name of logged in user with web prefix
>
>
  • $user can be a cUID, login, wikiname or web.wikiname
  Return: $wikiName Wiki Name, e.g. "Main.JohnDoe"
Line: 338 to 434
 

wikiToUserName( $wikiName ) -> $loginName

Changed:
<
<
Translate a Wiki name to a login name based on Main.TWikiUsers topic
>
>
Translate a Wiki name (or login name or cUID, if it can) to a login name.
 
  • $wikiName - Wiki name, e.g. 'Main.JohnDoe' or 'JohnDoe'
Changed:
<
<
Return: $loginName Login name of user, e.g. 'jdoe'
>
>
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

Changed:
<
<
Translate a login name to a Wiki name based on Main.TWikiUsers topic
>
>
Translate a login name to a Wiki name
 
  • $loginName - Login name, e.g. 'jdoe'
  • $dontAddWeb - Do not add web prefix if "1"
Return: $wikiName Wiki name of user, e.g. 'Main.JohnDoe' or 'JohnDoe'
Added:
>
>
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)
Added:
>
>

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

  • $email - email address to look up
  • $dontAddWeb - Do not add web prefix if "1"
Find the wikinames of all users who have the given email address as their registered address. Since several users could register with the same email address, this returns a list of wikinames rather than a single wikiname.

Since: TWiki::Plugins::VERSION 1.2

wikiNameToEmails( $wikiname ) -> @emails

  • $wikiname - wikiname of user to look up
Returns the registered email addresses of the named user. If $wikiname is undef, returns the registered email addresses for the logged-in user.

Since: TWiki::Plugins::VERSION 1.2

 

isGuest( ) -> $boolean

Test if logged in user is a guest (TWikiGuest)

Line: 363 to 485
 Since: TWiki::Plugins::VERSION 1.000 (7 Dec 2002)
Changed:
<
<

permissionsSet( $web ) -> $boolean

>
>

isAnAdmin( $login ) -> $boolean

 
Changed:
<
<
Test if any access restrictions are set for this web, ignoring settings on individual pages
  • $web - Web name, required, e.g. 'Sandbox'
>
>
Find out if the user is an admin or not. If the user is not given, the currently logged-in user is assumed.
  • $login can be either a login, or a CUID
 
Changed:
<
<
Since: TWiki::Plugins::VERSION 1.000 (27 Feb 2001)
>
>
Since: TWiki::Plugins::VERSION 1.2

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

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

if( TWiki::Func::isGroupMember( "HesperionXXGroup", "jordi" )) {
    ...
}
If $user is undef, it defaults to the currently logged-in user.

  • $login can be a login name, or a cUID, or WikiName

Since: TWiki::Plugins::VERSION 1.2

eachUser() -> $iterator

Get an iterator over the list of all the registered users not including groups. The iterator will return each wiki name in turn (e.g. 'FredBloggs').

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($wikiname) -> $iterator

Get an iterator over the names of all groups that the user is a member of. If $wikiname is undef, defaults to the currently logged-in user.

Since: TWiki::Plugins::VERSION 1.2

eachGroup() -> $iterator

Get an iterator over all groups.

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

Get an iterator over all the members of the named group. Returns undef if $group is not a valid group.

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, $wikiName, $text, $topic, $web, $meta ) -> $boolean

Check access permission for a topic based on the

Changed:
<
<
TWiki.TWikiAccessControl rules
>
>
TWiki.TWikiAccessControl rules
 
  • $type - Access type, required, e.g. 'VIEW', 'CHANGE'.
  • $wikiName - WikiName of remote user, required, e.g. "PeterThoeny". If $wikiName is '', 0 or undef then access is always permitted.
Line: 492 to 695
 Since: TWiki::Plugins::VERSION 1.1
Added:
>
>

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 ($it->hasNext()) {
        my $change = $it->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')
    }
 

getTopicList( $web ) -> @topics

Get list of all topics in a web

Line: 506 to 734
 Test if topic exists
  • $web - Web name, optional, e.g. 'Main'.
  • $topic - Topic name, required, e.g. 'TokyoOffice', or "Main.TokyoOffice"
Added:
>
>
 $web and $topic are parsed as described in the documentation for normalizeWebTopicName.
Added:
>
>
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)
Line: 526 to 757
 
  • $web Web name, e.g. "Main", or empty
  • $topic Topic name, e.g. "MyTopic", or "Main.MyTopic"
Changed:
<
<
  • $lock 1 to lease the topic, 0 to clear the lease=
>
>
  • $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
Line: 643 to 874
  NOTE: if you are trying to get revision info for a topic, use $meta->getRevisionInfo instead if you can - it is significantly
Changed:
<
<
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.

>
>
more efficient.
  Since: TWiki::Plugins::VERSION 1.000 (29 Jul 2001)
Line: 692 to 917
 
  • $ignorePermissions - Set to "1" if checkAccessPermission() is already performed and OK; an oops URL is returned if user has no permission
Return: $text Topic text with embedded meta data; an oops URL for calling redirectCgiQuery() is returned in case of an error
Changed:
<
<
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..
>
>
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)
Line: 815 to 1040
 

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

Changed:
<
<
Read a template or skin. Embedded template directives get expanded
>
>
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'
Return: $text Template text
Line: 855 to 1080
 

writeHeader( $query, $contentLength )

Prints a basic content-type HTML header for text/html to standard out

Changed:
<
<
  • $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
>
>
  • $query - CGI query object. If not given, the default CGI query will be used (optional, in most cases you should not pass this parameter)
  • $contentLength - Length of content (optional, in most cases you should not pass this parameter)
 Return: none

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

Line: 879 to 1104
 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
Changed:
<
<
file (see {PassthroughDir} in =configure).
>
>
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
Line: 916 to 1141
 
Changed:
<
<

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

>
>

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
Added:
>
>
  • $meta - topic meta-data to use while expanding (Since TWiki::Plugins::VERSION 1.2)
 Return: $text Expanded text, e.g. 'Current user is TWikiGuest'

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

Line: 931 to 1157
 

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

Changed:
<
<
Render text from TWiki markup into XHTML as defined in TWiki.TextFormattingRules
>
>
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
Return: $text XHTML text, e.g. '<b>bold</b> and <code>fixed font</code>'
Line: 1111 to 1337
 (ie, with the name of the function instead of the alias) will not work.

Added:
>
>

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.

Escape: Expands To:
$n or $n() New line. Use $n() if followed by alphanumeric character, e.g. write Foo$n()Bar instead of Foo$nBar
$nop or $nop() Is a "no operation".
$quot Double quote (")
$percnt Percent sign (%)
$dollar Dollar sign ($)

Note thath $quot, $percnt and $dollar all work *even if they are followed by alphanumeric characters*. You have been warned!

Since: TWiki::Plugins::VERSION 1.2

 

Searching

Line: 1250 to 1507
  Note that hierarchical web names (SubWeb) are only available if hierarchical webs are enabled in configure.
Changed:
<
<
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:
>
>
The symbols %USERSWEB%, %SYSTEMWEB% and %DOCWEB% 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' )
Added:
>
>

StaticMethod 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

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

Line: 1287 to 1565
 Since: TWiki::Plugins::VERSION 1.020 (26 Feb 2004)
Added:
>
>

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

Line: 1365 to 1656
 Since: TWiki::Plugins::VERSION 1.000 (7 Dec 2002)
Added:
>
>

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
Return: $url URL, e.g. "http://example.com:80/cgi-bin/oops.pl/ Main/WebNotify?template=oopslocked&param1=joe"

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' ]);
(this example will use the oopstoestuckerror template.)

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

getPublicWebList( ) -> @webs

DEPRECATED since 1.1 - use getListOfWebs instead.

Revision 62007-03-03 - TWikiContributor

Line: 371 to 371
 Since: TWiki::Plugins::VERSION 1.000 (27 Feb 2001)
Changed:
<
<

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

>
>

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

 
Changed:
<
<
Check access permission for a topic based on the TWiki.TWikiAccessControl rules
  • $type - Access type, e.g. 'VIEW', 'CHANGE', 'CREATE'
  • $wikiName - WikiName of remote user, e.g. "PeterThoeny". If $wikiName is '', 0 or undef then access is always permitted.
  • $text - Topic text, optional. If 'perl false' (undef, 0 or ''), topic $web.$topic is consulted
>
>
Check access permission for a topic based on the TWiki.TWikiAccessControl rules
  • $type - Access type, required, e.g. 'VIEW', 'CHANGE'.
  • $wikiName - WikiName of remote user, required, e.g. "PeterThoeny". If $wikiName 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'
Added:
>
>
  • $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.
 A perl true result indicates that access is permitted.
Added:
>
>
Note the wierd 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:

in ThatWeb.ThisTopic, then a call to checkAccessPermissions('SPIN', 'IncyWincy', undef, 'ThisTopic', 'ThatWeb', undef) will return true.
 Since: TWiki::Plugins::VERSION 1.000 (27 Feb 2001)

Revision 52007-02-05 - TWikiContributor

Line: 1173 to 1173
 Since: TWiki::Plugins::VERSION 1.020 (9 Feb 2004)

Note: TWiki internally precompiles several regular expressions to

Changed:
<
<
represent various string entities in an I18N-compatible manner. Plugins
>
>
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.

Revision 42007-01-16 - TWikiContributor

Line: 73 to 73
 
  • $web - Web name, e.g. 'Main'
  • $topic - Topic name, e.g. 'WebNotify'
  • $script - Script name, e.g. 'view'
Added:
>
>
  • ... - 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)

Line: 144 to 146
 

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

Changed:
<
<
Set a session value via the client session module
>
>
Set a session value.
 
  • $key - Session key
  • $value - Value associated with key
Return: true if function succeeded
Line: 154 to 156
 

clearSessionValue( $key ) -> $boolean

Changed:
<
<
Clear a session value via the client session module
  • $key - Session key
Return: true if function succeeded
>
>
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.
Return: true if the session value was cleared
  Since: TWiki::Plugins::VERSION 1.1
Line: 227 to 231
 
    • WebPreferences topic has: * Set WEBBGCOLOR = #FFFFC0
    • my $webColor = TWiki::Func::getPreferencesValue( 'WEBBGCOLOR', 'Sandbox' );
Added:
>
>
NOTE: As of TWiki4.1, if $NO_PREFS_IN_TOPIC is enabled in the plugin, then preferences set in the plugin topic will be ignored.
 

getPluginPreferencesValue( $key ) -> $value

Line: 238 to 245
  Since: TWiki::Plugins::VERSION 1.021 (27 Mar 2004)
Added:
>
>
NOTE: As of TWiki4.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

Line: 253 to 263
 
    • Use "MYPLUGIN_SHOWHELP" for $key
    • my $showHelp = TWiki::Func::getPreferencesFlag( "MYPLUGIN_SHOWHELP" );
Added:
>
>
NOTE: As of TWiki4.1, if $NO_PREFS_IN_TOPIC is enabled in the plugin, then preferences set in the plugin topic will be ignored.
 

getPluginPreferencesFlag( $key ) -> $boolean

Line: 264 to 277
  Since: TWiki::Plugins::VERSION 1.021 (27 Mar 2004)
Added:
>
>
NOTE: As of TWiki4.1, if $NO_PREFS_IN_TOPIC is enabled in the plugin, then preferences set in the plugin topic will be ignored.
 

getWikiToolName( ) -> $name

Line: 473 to 490
 Since: TWiki::Plugins::VERSION 1.000 (14 Jul 2001)
Changed:
<
<

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

>
>

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"
Return: ( $oopsUrl, $loginName, $unlockTime ) - The $oopsUrl for calling redirectCgiQuery(), user's $loginName, and estimated $unlockTime in minutes, or ( '', '', 0 ) if no lease exists.
Added:
>
>
  • $script The script to invoke when continuing with the edit
  Since: TWiki::Plugins::VERSION 1.010 (31 Dec 2002)
Line: 814 to 841
 Since: TWiki::Plugins::VERSION 1.000 (7 Dec 2002)
Changed:
<
<

redirectCgiQuery( $query, $url )

>
>

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
Changed:
<
<
Return: none, never returns
>
>
  • $passthru - enable passthrough.

Return: none

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 (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)
Line: 984 to 1042
 would let you do this: %EXEC{"ps -Af" silent="on"}%
Added:
>
>
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, )

Added:
>
>
 Should only be called from initPlugin.

Adds a function to the dispatch table of the REST interface

Line: 1147 to 1213
 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.
Changed:
<
<
Return: the parsed Web/Topic pai
>
>
Return: the parsed Web/Topic pair
  Since: TWiki::Plugins::VERSION 1.1
Line: 1156 to 1222
 
( '', 'Topic' ) ( 'Main', 'Topic' )
( '', '' ) ( 'Main', 'WebHome' )
( '', 'Web/Topic' ) ( 'Web', 'Topic' )
Added:
>
>
( '', 'Web/Subweb/Topic' ) ( 'Web/Subweb', 'Topic' )
 
( '', 'Web.Topic' ) ( 'Web', 'Topic' )
Added:
>
>
( '', 'Web.Subweb.Topic' ) ( 'Web/Subweb', 'Topic' )
 
( 'Web1', 'Web2.Topic' ) ( 'Web2', 'Topic' )
Changed:
<
<
( 'Main', 'Topic' ) ( 'Main', 'Topic' )
( 'TWiki', 'Topic' ) ( 'TWiki', 'Topic' )
where Main and TWiki are the web names set in $cfg{UsersWebName} and $cfg{SystemWebName} respectively.
>
>
Note that hierarchical web names (SubWeb) are only available if hierarchical webs are enabled in 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 )

Line: 1296 to 1369
 

getDataDir( ) -> $dir

Changed:
<
<
DEPRECATED since 1.1 - use the content handling functions to manipulate topics instead
>
>
DEPRECATED since 1.1 - use the "Webs, Topics and Attachments" functions to manipulate topics instead
  Get data directory (topic file root)
Line: 1309 to 1382
 

getPubDir( ) -> $dir

Changed:
<
<
DEPRECATED since 1.1 - use the content handling functions to manipulateattachments instead
>
>
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

Revision 32006-10-25 - TWikiContributor

Line: 359 to 359
  Check access permission for a topic based on the TWiki.TWikiAccessControl rules
  • $type - Access type, e.g. 'VIEW', 'CHANGE', 'CREATE'
Changed:
<
<
  • $wikiName - WikiName of remote user, i.e. "Main.PeterThoeny"
  • $text - Topic text, optional. If empty, topic $web.$topic is consulted
>
>
  • $wikiName - WikiName of remote user, e.g. "PeterThoeny". If $wikiName is '', 0 or undef then access is always permitted.
  • $text - Topic text, optional. If 'perl false' (undef, 0 or ''), topic $web.$topic is consulted
 
  • $topic - Topic name, required, e.g. 'PrivateStuff'
  • $web - Web name, required, e.g. 'Sandbox'
Added:
>
>
A perl true result indicates that access is permitted.
  Since: TWiki::Plugins::VERSION 1.000 (27 Feb 2001)

Revision 22006-06-25 - TWikiContributor

Line: 271 to 271
  Return: $name Name of tool, e.g. 'TWiki'
Deleted:
<
<
Synonymous with TWiki::Func::getPreferencesValue('WIKITOOLNAME');
 Since: TWiki::Plugins::VERSION 1.000 (27 Feb 2001)
Line: 282 to 280
  Return: $name Name, e.g. 'Main'
Deleted:
<
<
Synonymous with TWiki::Func::getPreferencesValue('MAINWEB');
 Since: TWiki::Plugins::VERSION 1.000 (27 Feb 2001)
Line: 293 to 289
  Return: $name Name, e.g. 'TWiki'
Deleted:
<
<
Synonymous with TWiki::Func::getPreferencesValue('TWIKIWEB');
 Since: TWiki::Plugins::VERSION 1.000 (27 Feb 2001)
Line: 674 to 668
 
  • $topic - topic
  • $name - attachment name
  • $rev - revision to read (default latest)
Changed:
<
<
Read an attachment from the store for a topic, and return it as a string. The names of attachments on a topic can be recovered from the meta-data returned by readTopic. If the attachment does not exist, or cannot be read, undef will be returned.
>
>
Read an attachment from the store for a topic, and return it as a string. The names of attachments on a topic can be recovered from the meta-data returned by 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
Changed:
<
<
TWiki::AccessControlException. Permissions are checked for the user passed in.
>
>
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 {
Changed:
<
<
my $data = TWiki::Func::readAttachment( $meta, $a->{name} );
>
>
my $data = TWiki::Func::readAttachment( $web, $topic, $a->{name} );
  ... } catch TWiki::AccessControlException with { };

Revision 12006-02-01 - TWikiContributor

Line: 1 to 1
Added:
>
>

Package TWiki::Func

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

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 6.02. This can be shown by the %PLUGINVERSION% variable. The 'Since' field in the function documentation refers to the VERSION number and the date that the function was addded.

Note: Beware! These methods should only ever be called from the context of a TWiki Plugin. They require a Plugins SESSION context to be established before they are called, and will not work if simply called from another TWiki module. For example,

use TWiki;
print TWiki::Func::getSkin(),"\n";
will fail with Can't call method "getSkin" on an undefined value at TWiki/Func.pm line 83.

If you want to call the methods outside the context of a plugin, you can create a Plugins SESSION object. For example, the script:

use TWiki:
$TWiki::Plugins::SESSION = new TWiki();
print TWiki::Func::getSkin(),"\n";
will work happily.

On this page:

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'
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'
Return: $url URL, e.g. "http://example.com:80/cgi-bin/view.pl/Main/WebNotify"

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
Return: $url URL, e.g. "http://example.com:80/cgi-bin/oops.pl/ Main/WebNotify?template=oopslocked&param1=joe"

This might be used like this:

   my $url = TWiki::Func::getOopsUrl($web, $topic, 'oopsmistake', 'I made a boo-boo');
   TWiki::Func::redirectCgiQuery( undef, $url );
   return 0;

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

Since TWiki::Plugins::VERSION 1.1, the recommended approach is to throw an oops exception.

   use Error qw( :try );

   throw TWiki::OopsException($web, $topic, undef, 0, [ 'I made a boo-boo' ]);
and let TWiki handle the cleanup.

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)

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)

getSessionValue( $key ) -> $value

Get a session value from the client session module

  • $key - Session key
Return: $value Value associated with key; empty string if not set

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

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

Set a session value via the client session module

  • $key - Session key
  • $value - Value associated with key
Return: true if function succeeded

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

clearSessionValue( $key ) -> $boolean

Clear a session value via the client session module

  • $key - Session key
Return: true if function succeeded

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 TWikiTemplates 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;
   ...
This can be used in SecondPlugin.pm like this:
sub initPlugin {
   if( TWiki::Func::getContext()->{'MyID'} ) {
      ...
   }
   ...
or in a template, like this:
%TMPL:DEF{"ON"}% Not off %TMPL:END%
%TMPL:DEF{"OFF"}% Not on %TMPL:END%
%TMPL:P{context="MyID" then="ON" else="OFF"}%
or in a topic:
%IF{"context MyID" then="MyID is ON" else="MyID is OFF"}%
Note: all plugins have an automatically generated context identifier if they are installed and initialised. For example, if the FirstPlugin is working, the context ID 'FirstPlugin' will be set.

Since: TWiki::Plugins::VERSION 1.1

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
Return: $value Preferences value; empty string if not set

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

  • Example for Plugin setting:
    • MyPlugin topic has: * Set COLOR = red
    • 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' );

getPluginPreferencesValue( $key ) -> $value

Get a preferences value from your Plugin

  • $key - Plugin Preferences key w/o PLUGINNAME_ prefix.
Return: $value Preferences value; empty string if not set

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)

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
Return: $value Preferences flag '1' (if set), or "0" (for preferences values "off", "no" and "0")

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

  • Example for Plugin setting:
    • MyPlugin topic has: * Set SHOWHELP = off
    • Use "MYPLUGIN_SHOWHELP" for $key
    • my $showHelp = TWiki::Func::getPreferencesFlag( "MYPLUGIN_SHOWHELP" );

getPluginPreferencesFlag( $key ) -> $boolean

Get a preferences flag from your Plugin

  • $key - Plugin Preferences key w/o PLUGINNAME_ prefix.
Return: false for preferences values "off", "no" and "0", or values not set at all. True otherwise.

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)

getWikiToolName( ) -> $name

Get toolname as defined in TWiki.cfg

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

Synonymous with TWiki::Func::getPreferencesValue('WIKITOOLNAME');

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'

Synonymous with TWiki::Func::getPreferencesValue('MAINWEB');

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'

Synonymous with TWiki::Func::getPreferencesValue('TWIKIWEB');

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

User Handling and Access Control

getDefaultUserName( ) -> $loginName

Get default user name as defined in the configuration as DefaultUserLogin

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

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

getWikiName( ) -> $wikiName

Get Wiki name of logged in user

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

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

getWikiUserName( ) -> $wikiName

Get Wiki name of logged in user with web prefix

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

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

wikiToUserName( $wikiName ) -> $loginName

Translate a Wiki name to a login name based on Main.TWikiUsers topic

  • $wikiName - Wiki name, e.g. 'Main.JohnDoe' or 'JohnDoe'
Return: $loginName Login name of user, e.g. 'jdoe'

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

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

Translate a login name to a Wiki name based on Main.TWikiUsers topic

  • $loginName - Login name, e.g. 'jdoe'
  • $dontAddWeb - Do not add web prefix if "1"
Return: $wikiName Wiki name of user, e.g. 'Main.JohnDoe' or 'JohnDoe'

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

isGuest( ) -> $boolean

Test if logged in user is a guest (TWikiGuest)

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)

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

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

  • $type - Access type, e.g. 'VIEW', 'CHANGE', 'CREATE'
  • $wikiName - WikiName of remote user, i.e. "Main.PeterThoeny"
  • $text - Topic text, optional. If empty, topic $web.$topic is consulted
  • $topic - Topic name, required, e.g. 'PrivateStuff'
  • $web - Web name, required, e.g. 'Sandbox'

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

Webs, Topics and Attachments

getListOfWebs( $filter ) -> @webs

  • $filter - spec of web types to recover
Gets a list of webs, filtered according to the spec in the $filter, which may include one of:
  1. 'user' (for only user webs)
  2. 'template' (for only template webs i.e. those starting with "_")
$filter may also contain the word 'public' which will further filter out webs that have NOSEARCHALL set on them. 'allowed' filters out webs the current user can't read.

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)

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
the web preferences topic in the new web.

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

getTopicList( $web ) -> @topics

Get list of all topics in a web

  • $web - Web name, required, e.g. 'Sandbox'
Return: @topics Topic list, e.g. ( 'WebChanges',  'WebHome', 'WebIndex', 'WebNotify' )

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.

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

checkTopicEditLock( $web, $topic ) -> ( $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"
Return: ( $oopsUrl, $loginName, $unlockTime ) - The $oopsUrl for calling redirectCgiQuery(), user's $loginName, and estimated $unlockTime in minutes, or ( '', '', 0 ) if no lease exists.

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 the 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
    comment comment for save
    minor True if this is a minor change, and is not to be notified
Return: error message or undef.

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

For example,

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
Return: $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 )

  • $web source web - required
  • $topic source topic - required
  • $newWeb dest web
  • $newTopic dest topic
Renames the topic. Throws an exception if something went wrong. If $newWeb is undef, it defaults to $web. If $newTopic is undef, it defaults to $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
Return: ( $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?

NOTE: if you are trying to get revision info for a topic, use $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
Return: Single-digit revision number, or undef if it couldn't be determined (either because the topic isn't that old, or there was a problem)

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)
Return: ( $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
Return: $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, or Main.TokyoOffice
  • $attachment - attachment name, e.g.=logo.gif=
$web and $topic are parsed as described in the documentation for 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)
Read an attachment from the store for a topic, and return it as a string. The names of attachments on a topic can be recovered from the meta-data returned by readTopic. If the attachment does not exist, or cannot be read, undef 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 user passed in.

my( $meta, $text ) = TWiki::Func::readTopic( $web, $topic );
my @attachments = $meta->find( 'FILEATTACHMENT' );
foreach my $a ( @attachments ) {
   try {
       my $data = TWiki::Func::readAttachment( $meta, $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

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
Renames the topic. Throws an exception on error or access violation. If $newWeb is undef, it defaults to $web. If $newTopic is undef, it defaults to $topic. If $newAttachment is undef, it defaults to $attachment. If all of $newWeb, $newTopic and $newAttachment are undef, it is an error.

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'
Return: $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)
Return: expanded template text (what's left after removal of all %TMPL:DEF% statements)

Since: TWiki::Plugins::VERSION 1.1

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

Do a , only expanding the template (not expanding any variables other than %TMPL)
  • $def - template name
Return: the text of the expanded template

Since: TWiki::Plugins::VERSION 1.1

A template is defined using a %TMPL:DEF% statement in a template file. See the documentation on TWiki templates for more information.

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
Return: none

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

redirectCgiQuery( $query, $url )

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
Return: none, never returns

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.

All TWiki variables present in $header will be expanded before being inserted into the section.

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 ) -> $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
Return: $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
Return: $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 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
Return: $text XHTML anchor, e.g. '<a href='/cgi-bin/view/Main/WebNotify#Jump'>notify</a>'

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)
Send an e-mail specified as MIME format content. To specify MIME format mails, you create a string that contains a set of header lines that contain field definitions and a message body such as:
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
Leave 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
Get the e-mail address(es) of the named user. If the user has multiple e-mail addresses (for example, the user is a group), then the list will be comma-separated.

Since: TWiki::Plugins::VERSION 1.1

Creating New Topics

expandVariablesOnTopicCreation ( $text ) -> $text

Expand the limited set of variables that are always expanded during topic creation
  • $text - the text to process
Return: text with variables expanded

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)
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
for example, to execute an arbitrary command on the server, you might do this:
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"}%

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)
where:
  • \%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.

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
The \%options hash may contain the following options:
  • type - if regex will perform a egrep-syntax RE search (default '')
  • casesensitive - false to ignore case (defaulkt 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
Return: $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
Return: none

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
Return: String or precompiled regular expression matching as described 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]+/;
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.
Return: the parsed Web/Topic pai

Since: TWiki::Plugins::VERSION 1.1

Input Return
( 'Web', 'Topic' ) ( 'Web', 'Topic' )
( '', 'Topic' ) ( 'Main', 'Topic' )
( '', '' ) ( 'Main', 'WebHome' )
( '', 'Web/Topic' ) ( 'Web', 'Topic' )
( '', 'Web.Topic' ) ( 'Web', 'Topic' )
( 'Web1', 'Web2.Topic' ) ( 'Web2', 'Topic' )
( 'Main', 'Topic' ) ( 'Main', 'Topic' )
( 'TWiki', 'Topic' ) ( 'TWiki', 'Topic' )
where Main and TWiki are the web names set in $cfg{UsersWebName} and $cfg{SystemWebName} respectively.

writeWarning( $text )

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

  • $text - Text to write; timestamp gets added
Return: none

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
Return: none

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

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'
Return: $text Formatted time string
Note: if you used the removed formatGmTime, add a third parameter 'gmtime'

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

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
Return: %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:
  • params = TWiki::Func::extractParameters( $text );=
    • The %params hash contains now:
      _DEFAULT => 'nameless'
      name1 => "val1"
      name2 => "val2"

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
Return: $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" );

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;
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 - 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)

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')
Return: $text Formatted time string

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

getDataDir( ) -> $dir

DEPRECATED since 1.1 - use the content handling 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 content handling 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)

 
This site is powered by the TWiki collaboration platform Powered by PerlCopyright © 1999-2017 by the contributing authors. All material on this collaboration platform is the property of the contributing authors.
Ideas, requests, problems regarding URCS? Send feedback
Note: Please contribute updates to this topic on TWiki.org at TWiki:TWiki.TWikiFuncDotPm.