1 # <a name="Package <code>TWiki::Func="></a> Package =TWiki::Func
3 _Official list of stable TWiki functions for Plugin developers_
5 This module defines official functions that [[Plugins|TWiki/TWikiPlugins]] can use to interact with the TWiki engine and content.
7 Refer to [[EmptyPlugin]] and lib/TWiki/Plugins/EmptyPlugin.pm for a template Plugin and documentation on how to write a Plugin.
9 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.
11 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.
13 The version of the TWiki::Func module is defined by the VERSION number of the TWiki::Plugins module, currently 1.11. This can be shown by the `%PLUGINVERSION%` variable. The 'Since' field in the function documentation refers to the VERSION number and the date that the function was addded.
15 **_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,
18 print TWiki::Func::getSkin(),"\n";
20 will fail with `Can't call method "getSkin" on an undefined value at TWiki/Func.pm line 83`.
22 If you want to call the methods outside the context of a plugin, you can create a Plugins SESSION object. For example, the script:
25 $TWiki::Plugins::SESSION = new TWiki();
26 print TWiki::Func::getSkin(),"\n";
32 <li><a href="#Package =TWiki::Func="> Package TWiki::Func</a><ul>
33 <li><a href="#Environment"> Environment</a><ul>
34 <li><a href="#getSkin( ) -> $skin"> getSkin( ) -> $skin</a></li>
35 <li><a href="#get_UrlHost( ) -> $host"> getUrlHost( ) -> $host</a></li>
36 <li><a href="#get_ScriptUrl( $web, $topic, $sc"> getScriptUrl( $web, $topic, $script, ... ) -> $url</a></li>
37 <li><a href="#get_ViewUrl( $web, $topic ) -> $"> getViewUrl( $web, $topic ) -> $url</a></li>
38 <li><a href="#get_OopsUrl( $web, $topic, $temp"> getOopsUrl( $web, $topic, $template, $param1, $param2, $param3, $param4 ) -> $url</a></li>
39 <li><a href="#get_PubUrlPath( ) -> $path"> getPubUrlPath( ) -> $path</a></li>
40 <li><a href="#get_CgiQuery( ) -> $query"> getCgiQuery( ) -> $query</a></li>
41 <li><a href="#get_SessionValue( $key ) -> $val"> getSessionValue( $key ) -> $value</a></li>
42 <li><a href="#set_SessionValue( $key, $value )"> setSessionValue( $key, $value ) -> $boolean</a></li>
43 <li><a href="#clear_SessionValue( $key ) -> $b"> clearSessionValue( $key ) -> $boolean</a></li>
44 <li><a href="#getContext() -> \%hash"> getContext() -> \%hash</a></li>
47 <li><a href="#Preferences"> Preferences</a><ul>
48 <li><a href="#get_PreferencesValue( $key, $web"> getPreferencesValue( $key, $web ) -> $value</a></li>
49 <li><a href="#get_PluginPreferencesValue( $key"> getPluginPreferencesValue( $key ) -> $value</a></li>
50 <li><a href="#get_PreferencesFlag( $key, $web"> getPreferencesFlag( $key, $web ) -> $value</a></li>
51 <li><a href="#get_PluginPreferencesFlag( $key"> getPluginPreferencesFlag( $key ) -> $boolean</a></li>
52 <li><a href="#get_WikiToolName( ) -> $name"> getWikiToolName( ) -> $name</a></li>
53 <li><a href="#get_MainWebname( ) -> $name"> getMainWebname( ) -> $name</a></li>
54 <li><a href="#get_TwikiWebname( ) -> $name"> getTwikiWebname( ) -> $name</a></li>
57 <li><a href="#User Handling and Access Control"> User Handling and Access Control</a><ul>
58 <li><a href="#get_DefaultUserName( ) -> $login"> getDefaultUserName( ) -> $loginName</a></li>
59 <li><a href="#get_WikiName( ) -> $wikiName"> getWikiName( ) -> $wikiName</a></li>
60 <li><a href="#get_WikiUserName( ) -> $wikiName"> getWikiUserName( ) -> $wikiName</a></li>
61 <li><a href="#wiki_ToUserName( $wikiName ) ->"> wikiToUserName( $wikiName ) -> $loginName</a></li>
62 <li><a href="#user_ToWikiName( $loginName, $do"> userToWikiName( $loginName, $dontAddWeb ) -> $wikiName</a></li>
63 <li><a href="#isGuest( ) -> $boolean"> isGuest( ) -> $boolean</a></li>
64 <li><a href="#permissionsSet( $web ) -> $boole"> permissionsSet( $web ) -> $boolean</a></li>
65 <li><a href="#check_AccessPermission( $type, $"> checkAccessPermission( $type, $wikiName, $text, $topic, $web ) -> $boolean</a></li>
68 <li><a href="#Webs, Topics and Attachments"> Webs, Topics and Attachments</a><ul>
69 <li><a href="#get_ListOfWebs( $filter ) -> @we"> getListOfWebs( $filter ) -> @webs</a></li>
70 <li><a href="#webExists( $web ) -> $boolean"> webExists( $web ) -> $boolean</a></li>
71 <li><a href="#createWeb( $newWeb, $baseWeb, $o"> createWeb( $newWeb, $baseWeb, $opts )</a></li>
72 <li><a href="#moveWeb( $oldName, $newName )"> moveWeb( $oldName, $newName )</a></li>
73 <li><a href="#get_TopicList( $web ) -> @topics"> getTopicList( $web ) -> @topics</a></li>
74 <li><a href="#topicExists( $web, $topic ) -> $"> topicExists( $web, $topic ) -> $boolean</a></li>
75 <li><a href="#check_TopicEditLock( $web, $topi"> checkTopicEditLock( $web, $topic ) -> ( $oopsUrl, $loginName, $unlockTime )</a></li>
76 <li><a href="#set_TopicEditLock( $web, $topic,"> setTopicEditLock( $web, $topic, $lock )</a></li>
77 <li><a href="#saveTopic( $web, $topic, $meta,"> saveTopic( $web, $topic, $meta, $text, $options ) -> $error</a></li>
78 <li><a href="#save_TopicText( $web, $topic, $t"> saveTopicText( $web, $topic, $text, $ignorePermissions, $dontNotify ) -> $oopsUrl</a></li>
79 <li><a href="#moveTopic( $web, $topic, $newWeb"> moveTopic( $web, $topic, $newWeb, $newTopic )</a></li>
80 <li><a href="#get_RevisionInfo($web, $topic, $"> getRevisionInfo($web, $topic, $rev, $attachment ) -> ( $date, $user, $rev, $comment ) </a></li>
81 <li><a href="#get_RevisionAtTime( $web, $topic"> getRevisionAtTime( $web, $topic, $time ) -> $rev</a></li>
82 <li><a href="#readTopic( $web, $topic, $rev )"> readTopic( $web, $topic, $rev ) -> ( $meta, $text )</a></li>
83 <li><a href="#read_TopicText( $web, $topic, $r"> readTopicText( $web, $topic, $rev, $ignorePermissions ) -> $text</a></li>
84 <li><a href="#attachmentExists( $web, $topic,"> attachmentExists( $web, $topic, $attachment ) -> $boolean</a></li>
85 <li><a href="#readAttachment( $web, $topic, $n"> readAttachment( $web, $topic, $name, $rev ) -> $data</a></li>
86 <li><a href="#saveAttachment( $web, $topic, $a"> saveAttachment( $web, $topic, $attachment, $opts )</a></li>
87 <li><a href="#moveAttachment( $web, $topic, $a"> moveAttachment( $web, $topic, $attachment, $newWeb, $newTopic, $newAttachment )</a></li>
90 <li><a href="#Assembling Pages"> Assembling Pages</a><ul>
91 <li><a href="#readTemplate( $name, $skin ) ->"> readTemplate( $name, $skin ) -> $text</a></li>
92 <li><a href="#loadTemplate ( $name, $skin, $we"> loadTemplate ( $name, $skin, $web ) -> $text</a></li>
93 <li><a href="#expandTemplate( $def ) -> $stri"> expandTemplate( $def ) -> $string</a></li>
94 <li><a href="#writeHeader( $query, $contentLen"> writeHeader( $query, $contentLength )</a></li>
95 <li><a href="#redirect_CgiQuery( $query, $url"> redirectCgiQuery( $query, $url )</a></li>
96 <li><a href="#add_ToHEAD( $id, $header )"> addToHEAD( $id, $header )</a></li>
97 <li><a href="#expand_CommonVariables( $text, $"> expandCommonVariables( $text, $topic, $web ) -> $text</a></li>
98 <li><a href="#renderText( $text, $web ) -> $te"> renderText( $text, $web ) -> $text</a></li>
99 <li><a href="#internalLink( $pre, $web, $topic"> internalLink( $pre, $web, $topic, $label, $anchor, $createLink ) -> $text</a></li>
102 <li><a href="#E-mail"> E-mail</a><ul>
103 <li><a href="#sendEmail ( $text, $retries ) ->"> sendEmail ( $text, $retries ) -> $error</a></li>
104 <li><a href="#wiki_ToEmail( $wikiName ) -> $em"> wikiToEmail( $wikiName ) -> $email</a></li>
107 <li><a href="#Creating New Topics"> Creating New Topics</a><ul>
108 <li><a href="#expand_VariablesOnTopicCreation"> expandVariablesOnTopicCreation ( $text ) -> $text</a></li>
111 <li><a href="#Special handlers"> Special handlers</a><ul>
112 <li><a href="#register_TagHandler( $var, \fn,"> registerTagHandler( $var, \&fn, $syntax )</a></li>
113 <li><a href="#registerRESTHandler( $alias, \fn"> registerRESTHandler( $alias, \&fn, )</a></li>
116 <li><a href="#Searching"> Searching</a><ul>
117 <li><a href="#search_InWebContent($searchStrin"> searchInWebContent($searchString, $web, \@topics, \%options ) -> \%map</a></li>
120 <li><a href="#Plugin-specific file handling"> Plugin-specific file handling</a><ul>
121 <li><a href="#get_WorkArea( $pluginName ) -> $"> getWorkArea( $pluginName ) -> $directorypath</a></li>
122 <li><a href="#readFile( $filename ) -> $text"> readFile( $filename ) -> $text</a></li>
123 <li><a href="#saveFile( $filename, $text )"> saveFile( $filename, $text )</a></li>
126 <li><a href="#General Utilities"> General Utilities</a><ul>
127 <li><a href="#get_RegularExpression( $name ) -"> getRegularExpression( $name ) -> $expr</a></li>
128 <li><a href="#normalize_WebTopicName($web, $to"> normalizeWebTopicName($web, $topic) -> ($web, $topic)</a></li>
129 <li><a href="#writeWarning( $text )"> writeWarning( $text )</a></li>
130 <li><a href="#writeDebug( $text )"> writeDebug( $text )</a></li>
131 <li><a href="#formatTime( $time, $format, $tim"> formatTime( $time, $format, $timezone ) -> $text</a></li>
132 <li><a href="#is_ValidWikiWord ( $text ) -> $b"> isValidWikiWord ( $text ) -> $boolean</a></li>
133 <li><a href="#extractParameters($attr ) -> %pa"> extractParameters($attr ) -> %params</a></li>
134 <li><a href="#extract_NameValuePair( $attr, $n"> extractNameValuePair( $attr, $name ) -> $value</a></li>
137 <li><a href="#Deprecated functions"> Deprecated functions</a><ul>
138 <li><a href="#get_ScriptUrlPath( ) -> $path"> getScriptUrlPath( ) -> $path</a></li>
139 <li><a href="#get_PublicWebList( ) -> @webs"> getPublicWebList( ) -> @webs</a></li>
140 <li><a href="#format_GmTime( $time, $format )"> formatGmTime( $time, $format ) -> $text</a></li>
141 <li><a href="#get_DataDir( ) -> $dir"> getDataDir( ) -> $dir</a></li>
142 <li><a href="#get_PubDir( ) -> $dir"> getPubDir( ) -> $dir</a></li>
143 <li><a href="#checkDependencies( $moduleName,"> checkDependencies( $moduleName, $dependenciesRef ) -> $error</a></li>
151 ## <a name="Environment"></a> Environment
153 ### <a name="getSkin( ) - $skin"></a> getSkin( ) -> $skin
155 Get the skin path, set by the `SKIN` and `COVER` preferences variables or the `skin` and `cover` CGI parameters
157 Return: `$skin` Comma-separated list of skins, e.g. `'gnu,tartan'`. Empty string if none.
159 **Since:** TWiki::Plugins::VERSION 1.000 (29 Jul 2001)
161 ### <a name="get_UrlHost( ) - $host"></a> getUrlHost( ) -> $host
163 Get protocol, domain and optional port of script URL
165 Return: `$host` URL host, e.g. `"http://example.com:80"`
167 **Since:** TWiki::Plugins::VERSION 1.000 (7 Dec 2002)
169 ### <a name="get_ScriptUrl( $web, $topic, $sc"></a> getScriptUrl( $web, $topic, $script, ... ) -> $url
171 Compose fully qualified URL
173 - `$web` - Web name, e.g. `'Main'`
174 - `$topic` - Topic name, e.g. `'WebNotify'`
175 - `$script` - Script name, e.g. `'view'`
177 Return: `$url` URL, e.g. `"http://example.com:80/cgi-bin/view.pl/Main/WebNotify"`
179 **Since:** TWiki::Plugins::VERSION 1.000 (7 Dec 2002)
181 ### <a name="get_ViewUrl( $web, $topic ) - $u"></a> getViewUrl( $web, $topic ) -> $url
183 Compose fully qualified view URL
185 - `$web` - Web name, e.g. `'Main'`. The current web is taken if empty
186 - `$topic` - Topic name, e.g. `'WebNotify'`
188 Return: `$url` URL, e.g. `"http://example.com:80/cgi-bin/view.pl/Main/WebNotify"`
190 **Since:** TWiki::Plugins::VERSION 1.000 (7 Dec 2002)
192 ### <a name="get_OopsUrl( $web, $topic, $temp"></a> getOopsUrl( $web, $topic, $template, $param1, $param2, $param3, $param4 ) -> $url
194 Compose fully qualified 'oops' dialog URL
196 - `$web` - Web name, e.g. `'Main'`. The current web is taken if empty
197 - `$topic` - Topic name, e.g. `'WebNotify'`
198 - `$template` - Oops template name, e.g. `'oopsmistake'`. The 'oops' is optional; 'mistake' will translate to 'oopsmistake'.
199 - `$param1` ... `$param4` - Parameter values for %PARAM1% ... %PARAMn% variables in template, optional
201 Return: `$url` URL, e.g. `"http://example.com:80/cgi-bin/oops.pl/ Main/WebNotify?template=oopslocked¶m1=joe"`
203 This might be used like this:
205 my $url = TWiki::Func::getOopsUrl($web, $topic, 'oopsmistake', 'I made a boo-boo');
206 TWiki::Func::redirectCgiQuery( undef, $url );
209 **Since:** TWiki::Plugins::VERSION 1.000 (7 Dec 2002)
211 Since TWiki::Plugins::VERSION 1.1, the recommended approach is to throw an [[oops exception|Main/TWikiOopsExceptionDotPm]].
213 use Error qw( :try );
215 throw TWiki::OopsException($web, $topic, undef, 0, [ 'I made a boo-boo' ]);
217 and let TWiki handle the cleanup.
219 ### <a name="get_PubUrlPath( ) - $path"></a> getPubUrlPath( ) -> $path
223 Return: `$path` URL path of pub directory, e.g. `"/pub"`
225 **Since:** TWiki::Plugins::VERSION 1.000 (14 Jul 2001)
227 ### <a name="get_CgiQuery( ) - $query"></a> getCgiQuery( ) -> $query
229 Get CGI query object. Important: Plugins cannot assume that scripts run under CGI, Plugins must always test if the CGI query object is set
231 Return: `$query` CGI query object; or 0 if script is called as a shell script
233 **Since:** TWiki::Plugins::VERSION 1.000 (7 Dec 2002)
235 ### <a name="get_SessionValue( $key ) - $valu"></a> getSessionValue( $key ) -> $value
237 Get a session value from the client session module
239 - `$key` - Session key
241 Return: `$value` Value associated with key; empty string if not set
243 **Since:** TWiki::Plugins::VERSION 1.000 (27 Feb 200)
245 ### <a name="set_SessionValue( $key, $value )"></a> setSessionValue( $key, $value ) -> $boolean
247 Set a session value via the client session module
249 - `$key` - Session key
250 - `$value` - Value associated with key
252 Return: true if function succeeded
254 **Since:** TWiki::Plugins::VERSION 1.000 (17 Aug 2001)
256 ### <a name="clear_SessionValue( $key ) - $bo"></a> clearSessionValue( $key ) -> $boolean
258 Clear a session value via the client session module
260 - `$key` - Session key
262 Return: true if function succeeded
264 **Since:** TWiki::Plugins::VERSION 1.1
266 ### <a name="getContext() - \%hash"></a> getContext() -> \\%hash
268 Get a hash of context identifiers representing the currently active context.
270 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!
272 Context identifiers can be used to communicate between Plugins, and between Plugins and templates. For example, in [[FirstPlugin]].pm, you might write:
275 TWiki::Func::getContext()->{'MyID'} = 1;
278 This can be used in SecondPlugin.pm like this:
281 if( TWiki::Func::getContext()->{'MyID'} ) {
286 or in a template, like this:
288 %TMPL:DEF{"ON"}% Not off %TMPL:END%
289 %TMPL:DEF{"OFF"}% Not on %TMPL:END%
290 %TMPL:P{context="MyID" then="ON" else="OFF"}%
294 %IF{"context MyID" then="MyID is ON" else="MyID is OFF"}%
296 **_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.
298 **Since:** TWiki::Plugins::VERSION 1.1
300 ## <a name="Preferences"></a> Preferences
302 ### <a name="get_PreferencesValue( $key, $web"></a> getPreferencesValue( $key, $web ) -> $value
304 Get a preferences value from TWiki or from a Plugin
306 - `$key` - Preferences key
307 - `$web` - Name of web, optional. Current web if not specified; does not apply to settings of Plugin topics
309 Return: `$value` Preferences value; empty string if not set
311 **Since:** TWiki::Plugins::VERSION 1.000 (7 Dec 2002)
313 - Example for Plugin setting:
314 - [[MyPlugin]] topic has: `* Set COLOR = red`
315 - Use `"MYPLUGIN_COLOR"` for `$key`
316 - `my $color = TWiki::Func::getPreferencesValue( "MYPLUGIN_COLOR" );`
318 - Example for preferences setting:
319 - [[WebPreferences]] topic has: `* Set WEBBGCOLOR = #FFFFC0`
320 - `my $webColor = TWiki::Func::getPreferencesValue( 'WEBBGCOLOR', 'Sandbox' );`
322 ### <a name="get_PluginPreferencesValue( $key"></a> getPluginPreferencesValue( $key ) -> $value
324 Get a preferences value from your Plugin
326 - `$key` - Plugin Preferences key w/o PLUGINNAME\_ prefix.
328 Return: `$value` Preferences value; empty string if not set
330 **_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)
332 **Since:** TWiki::Plugins::VERSION 1.021 (27 Mar 2004)
334 ### <a name="get_PreferencesFlag( $key, $web"></a><a name="get_PreferencesFlag( $key, $web "></a> getPreferencesFlag( $key, $web ) -> $value
336 Get a preferences flag from TWiki or from a Plugin
338 - `$key` - Preferences key
339 - `$web` - Name of web, optional. Current web if not specified; does not apply to settings of Plugin topics
341 Return: `$value` Preferences flag `'1'` (if set), or `"0"` (for preferences values `"off"`, `"no"` and `"0"`)
343 **Since:** TWiki::Plugins::VERSION 1.000 (7 Dec 2002)
345 - Example for Plugin setting:
346 - [[MyPlugin]] topic has: `* Set SHOWHELP = off`
347 - Use `"MYPLUGIN_SHOWHELP"` for `$key`
348 - `my $showHelp = TWiki::Func::getPreferencesFlag( "MYPLUGIN_SHOWHELP" );`
350 ### <a name="get_PluginPreferencesFlag( $key"></a><a name="get_PluginPreferencesFlag( $key "></a> getPluginPreferencesFlag( $key ) -> $boolean
352 Get a preferences flag from your Plugin
354 - `$key` - Plugin Preferences key w/o PLUGINNAME\_ prefix.
356 Return: false for preferences values `"off"`, `"no"` and `"0"`, or values not set at all. True otherwise.
358 **_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)
360 **Since:** TWiki::Plugins::VERSION 1.021 (27 Mar 2004)
362 ### <a name="get_WikiToolName( ) - $name"></a> getWikiToolName( ) -> $name
364 Get toolname as defined in TWiki.cfg
366 Return: `$name` Name of tool, e.g. `'TWiki'`
368 **Since:** TWiki::Plugins::VERSION 1.000 (27 Feb 2001)
370 ### <a name="get_MainWebname( ) - $name"></a> getMainWebname( ) -> $name
372 Get name of Main web as defined in TWiki.cfg
374 Return: `$name` Name, e.g. `'Main'`
376 **Since:** TWiki::Plugins::VERSION 1.000 (27 Feb 2001)
378 ### <a name="get_TwikiWebname( ) - $name"></a> getTwikiWebname( ) -> $name
380 Get name of TWiki documentation web as defined in TWiki.cfg
382 Return: `$name` Name, e.g. `'TWiki'`
384 **Since:** TWiki::Plugins::VERSION 1.000 (27 Feb 2001)
386 ## <a name="User Handling and Access Control"></a> User Handling and Access Control
388 ### <a name="get_DefaultUserName( ) - $loginN"></a> getDefaultUserName( ) -> $loginName
390 Get default user name as defined in the configuration as `DefaultUserLogin`
392 Return: `$loginName` Default user name, e.g. `'guest'`
394 **Since:** TWiki::Plugins::VERSION 1.000 (7 Dec 2002)
396 ### <a name="get_WikiName( ) - $wikiName"></a> getWikiName( ) -> $wikiName
398 Get Wiki name of logged in user
400 Return: `$wikiName` Wiki Name, e.g. `'JohnDoe'`
402 **Since:** TWiki::Plugins::VERSION 1.000 (7 Dec 2002)
404 ### <a name="get_WikiUserName( ) - $wikiName"></a> getWikiUserName( ) -> $wikiName
406 Get Wiki name of logged in user with web prefix
408 Return: `$wikiName` Wiki Name, e.g. `"Main.JohnDoe"`
410 **Since:** TWiki::Plugins::VERSION 1.000 (7 Dec 2002)
412 ### <a name="wiki_ToUserName( $wikiName ) - $"></a> wikiToUserName( $wikiName ) -> $loginName
414 Translate a Wiki name to a login name based on [[Main.TWikiUsers|Main/TWikiUsers]] topic
416 - `$wikiName` - Wiki name, e.g. `'Main.JohnDoe'` or `'JohnDoe'`
418 Return: `$loginName` Login name of user, e.g. `'jdoe'`
420 **Since:** TWiki::Plugins::VERSION 1.000 (7 Dec 2002)
422 ### <a name="user_ToWikiName( $loginName, $do"></a> userToWikiName( $loginName, $dontAddWeb ) -> $wikiName
424 Translate a login name to a Wiki name based on [[Main.TWikiUsers|Main/TWikiUsers]] topic
426 - `$loginName` - Login name, e.g. `'jdoe'`
427 - `$dontAddWeb` - Do not add web prefix if `"1"`
429 Return: `$wikiName` Wiki name of user, e.g. `'Main.JohnDoe'` or `'JohnDoe'`
431 **Since:** TWiki::Plugins::VERSION 1.000 (7 Dec 2002)
433 ### <a name="isGuest( ) - $boolean"></a> isGuest( ) -> $boolean
435 Test if logged in user is a guest ([[TWikiGuest]])
437 **Since:** TWiki::Plugins::VERSION 1.000 (7 Dec 2002)
439 ### <a name="permissionsSet( $web ) - $boolea"></a> permissionsSet( $web ) -> $boolean
441 Test if any access restrictions are set for this web, ignoring settings on individual pages
443 - `$web` - Web name, required, e.g. `'Sandbox'`
445 **Since:** TWiki::Plugins::VERSION 1.000 (27 Feb 2001)
447 ### <a name="check_AccessPermission( $type, $"></a> checkAccessPermission( $type, $wikiName, $text, $topic, $web ) -> $boolean
449 Check access permission for a topic based on the [[TWiki.TWikiAccessControl|TWiki/TWikiAccessControl]] rules
451 - `$type` - Access type, e.g. `'VIEW'`, `'CHANGE'`, `'CREATE'`
452 - `$wikiName` - [[WikiName]] of remote user, i.e. `"Main.PeterThoeny"`
453 - `$text` - Topic text, optional. If empty, topic `$web.$topic` is consulted
454 - `$topic` - Topic name, required, e.g. `'PrivateStuff'`
455 - `$web` - Web name, required, e.g. `'Sandbox'`
457 **Since:** TWiki::Plugins::VERSION 1.000 (27 Feb 2001)
459 ## <a name="Webs, Topics and Attachments"></a> Webs, Topics and Attachments
461 ### <a name="get_ListOfWebs( $filter ) - @web"></a> getListOfWebs( $filter ) -> @webs
463 - `$filter` - spec of web types to recover
465 Gets a list of webs, filtered according to the spec in the $filter, which may include one of:
467 1. 'user' (for only user webs)
468 2. 'template' (for only template webs i.e. those starting with "\_")
470 `$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.
472 For example, the deprecated getPublicWebList function can be duplicated as follows:
474 my @webs = TWiki::Func::getListOfWebs( "user,public" );
476 **Since:** TWiki::Plugins::VERSION 1.1
478 ### <a name="webExists( $web ) - $boolean"></a> webExists( $web ) -> $boolean
482 - `$web` - Web name, required, e.g. `'Sandbox'`
484 **Since:** TWiki::Plugins::VERSION 1.000 (14 Jul 2001)
486 ### <a name="createWeb( $newWeb, $baseWeb, $o"></a> createWeb( $newWeb, $baseWeb, $opts )
488 - `$newWeb` is the name of the new web.
489 - `$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.
490 - `$opts` is a ref to a hash that contains settings to be modified in
492 the web preferences topic in the new web.
494 use Error qw( :try );
495 use TWiki::AccessControlException;
498 TWiki::Func::createWeb( "Newweb" );
499 } catch Error::Simple with {
501 # see documentation on Error::Simple
502 } catch TWiki::AccessControlException with {
504 # see documentation on TWiki::AccessControlException
509 **Since:** TWiki::Plugins::VERSION 1.1
511 ### <a name="moveWeb( $oldName, $newName )"></a> moveWeb( $oldName, $newName )
515 use Error qw( :try );
516 use TWiki::AccessControlException;
519 TWiki::Func::moveWeb( "Oldweb", "Newweb" );
520 } catch Error::Simple with {
522 # see documentation on Error::Simple
523 } catch TWiki::AccessControlException with {
525 # see documentation on TWiki::AccessControlException
530 To delete a web, move it to a subweb of `Trash`
532 TWiki::Func::moveWeb( "Deadweb", "Trash.Deadweb" );
534 **Since:** TWiki::Plugins::VERSION 1.1
536 ### <a name="get_TopicList( $web ) - @topics"></a> getTopicList( $web ) -> @topics
538 Get list of all topics in a web
540 - `$web` - Web name, required, e.g. `'Sandbox'`
542 Return: `@topics` Topic list, e.g. `( 'WebChanges', 'WebHome', 'WebIndex', 'WebNotify' )`
544 **Since:** TWiki::Plugins::VERSION 1.000 (7 Dec 2002)
546 ### <a name="topicExists( $web, $topic ) - $b"></a> topicExists( $web, $topic ) -> $boolean
550 - `$web` - Web name, optional, e.g. `'Main'`.
551 - `$topic` - Topic name, required, e.g. `'TokyoOffice'`, or `"Main.TokyoOffice"`
553 $web and $topic are parsed as described in the documentation for `normalizeWebTopicName`.
555 **Since:** TWiki::Plugins::VERSION 1.000 (14 Jul 2001)
557 ### <a name="check_TopicEditLock( $web, $topi"></a> checkTopicEditLock( $web, $topic ) -> ( $oopsUrl, $loginName, $unlockTime )
559 Check if a lease has been taken by some other user.
561 - `$web` Web name, e.g. `"Main"`, or empty
562 - `$topic` Topic name, e.g. `"MyTopic"`, or `"Main.MyTopic"`
564 Return: `( $oopsUrl, $loginName, $unlockTime )` - The `$oopsUrl` for calling redirectCgiQuery(), user's `$loginName`, and estimated `$unlockTime` in minutes, or ( '', '', 0 ) if no lease exists.
566 **Since:** TWiki::Plugins::VERSION 1.010 (31 Dec 2002)
568 ### <a name="set_TopicEditLock( $web, $topic,"></a> setTopicEditLock( $web, $topic, $lock )
570 - `$web` Web name, e.g. `"Main"`, or empty
571 - `$topic` Topic name, e.g. `"MyTopic"`, or `"Main.MyTopic"`
572 - `$lock` 1 to lease the topic, 0 to clear the lease=
574 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.
576 It is **impossible** to fully lock a topic. Concurrent changes will be merged.
578 **Since:** TWiki::Plugins::VERSION 1.010 (31 Dec 2002)
580 ### <a name="saveTopic( $web, $topic, $meta,"></a><a name="saveTopic( $web, $topic, $meta, "></a> saveTopic( $web, $topic, $meta, $text, $options ) -> $error
582 - `$web` - web for the topic
583 - `$topic` - topic name
584 - `$meta` - reference to TWiki::Meta object
585 - `$text` - text of the topic (without embedded meta-data!!!
586 - `\%options` - ref to hash of save options `\%options` may include: <table border="1" cellpadding="0" cellspacing="0">
588 <td><code>dontlog</code></td>
589 <td> don't log this change in twiki log </td>
592 <td><code>comment</code></td>
593 <td> comment for save </td>
596 <td><code>minor</code></td>
597 <td> True if this is a minor change, and is not to be notified </td>
601 Return: error message or undef.
603 **Since:** TWiki::Plugins::VERSION 1.000 (29 Jul 2001)
607 my( $meta, $text ) = TWiki::Func::readTopic( $web, $topic )
608 $text =~ s/APPLE/ORANGE/g;
609 TWiki::Func::saveTopic( $web, $topic, $meta, $text, { comment => 'refruited' } );
611 **_Note:_** Plugins handlers ( e.g. `beforeSaveHandler` ) will be called as appropriate.
613 ### <a name="save_TopicText( $web, $topic, $t"></a> saveTopicText( $web, $topic, $text, $ignorePermissions, $dontNotify ) -> $oopsUrl
615 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.
617 - `$web` - Web name, e.g. `'Main'`, or empty
618 - `$topic` - Topic name, e.g. `'MyTopic'`, or `"Main.MyTopic"`
619 - `$text` - Topic text to save, assumed to include meta data
620 - `$ignorePermissions` - Set to `"1"` if checkAccessPermission() is already performed and OK
621 - `$dontNotify` - Set to `"1"` if not to notify users of the change
623 Return: `$oopsUrl` Empty string if OK; the `$oopsUrl` for calling redirectCgiQuery() in case of error
625 This method is a lot less efficient and much more dangerous than `saveTopic`.
627 **Since:** TWiki::Plugins::VERSION 1.010 (31 Dec 2002)
629 my $text = TWiki::Func::readTopicText( $web, $topic );
631 # check for oops URL in case of error:
632 if( $text =~ /^http.*?\/oops/ ) {
633 TWiki::Func::redirectCgiQuery( $query, $text );
636 # do topic text manipulation like:
637 $text =~ s/old/new/g;
638 # do meta data manipulation like:
639 $text =~ s/(META\:FIELD.*?name\=\"TopicClassification\".*?value\=\")[^\"]*/$1BugResolved/;
640 $oopsUrl = TWiki::Func::saveTopicText( $web, $topic, $text ); # save topic text
642 ### <a name="moveTopic( $web, $topic, $newWeb"></a> moveTopic( $web, $topic, $newWeb, $newTopic )
644 - `$web` source web - required
645 - `$topic` source topic - required
647 - `$newTopic` dest topic
649 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.
651 The destination topic must not already exist.
653 Rename a topic to the $TWiki::cfg\{TrashWebName\} to delete it.
655 **Since:** TWiki::Plugins::VERSION 1.1
657 use Error qw( :try );
660 moveTopic( "Work", "TokyoOffice", "Trash", "ClosedOffice" );
661 } catch Error::Simple with {
663 # see documentation on Error::Simple
664 } catch TWiki::AccessControlException with {
666 # see documentation on TWiki::AccessControlException
671 ### <a name="get_RevisionInfo($web, $topic, $"></a> getRevisionInfo($web, $topic, $rev, $attachment ) -> ( $date, $user, $rev, $comment )
673 Get revision info of a topic or attachment
675 - `$web` - Web name, optional, e.g. `'Main'`
676 - `$topic` - Topic name, required, e.g. `'TokyoOffice'`
677 - `$rev` - revsion number, or tag name (can be in the format 1.2, or just the minor number)
678 - `$attachment` -attachment filename
680 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" )`
682 <table border="1" cellpadding="0" cellspacing="0">
685 <td> in epochSec </td>
689 <td> Wiki name of the author (<strong>not</strong> login name) </td>
693 <td> actual rev number </td>
697 <td> WHAT COMMENT? </td>
701 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.
703 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.
705 **Since:** TWiki::Plugins::VERSION 1.000 (29 Jul 2001)
707 ### <a name="get_RevisionAtTime( $web, $topic"></a> getRevisionAtTime( $web, $topic, $time ) -> $rev
709 Get the revision number of a topic at a specific time.
711 - `$web` - web for topic
713 - `$time` - time (in epoch secs) for the rev
715 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)
717 **Since:** TWiki::Plugins::VERSION 1.1
719 ### <a name="readTopic( $web, $topic, $rev )"></a><a name="readTopic( $web, $topic, $rev ) "></a> readTopic( $web, $topic, $rev ) -> ( $meta, $text )
721 Read topic text and meta data, regardless of access permissions.
723 - `$web` - Web name, required, e.g. `'Main'`
724 - `$topic` - Topic name, required, e.g. `'TokyoOffice'`
725 - `$rev` - revision to read (default latest)
727 Return: `( $meta, $text )` Meta data object and topic text
729 `$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.
731 This method **ignores** topic access permissions. You should be careful to use `checkAccessPermissions` to ensure the current user has read access to the topic.
733 **Since:** TWiki::Plugins::VERSION 1.000 (7 Dec 2002)
735 ### <a name="read_TopicText( $web, $topic, $r"></a> readTopicText( $web, $topic, $rev, $ignorePermissions ) -> $text
737 Read topic text, including meta data
739 - `$web` - Web name, e.g. `'Main'`, or empty
740 - `$topic` - Topic name, e.g. `'MyTopic'`, or `"Main.MyTopic"`
741 - `$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.
742 - `$ignorePermissions` - Set to `"1"` if checkAccessPermission() is already performed and OK; an oops URL is returned if user has no permission
744 Return: `$text` Topic text with embedded meta data; an oops URL for calling redirectCgiQuery() is returned in case of an error
746 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..
748 **Since:** TWiki::Plugins::VERSION 1.010 (31 Dec 2002)
750 ### <a name="attachmentExists( $web, $topic,"></a><a name="attachmentExists( $web, $topic, "></a> attachmentExists( $web, $topic, $attachment ) -> $boolean
752 Test if attachment exists
754 - `$web` - Web name, optional, e.g. `Main`.
755 - `$topic` - Topic name, required, e.g. `TokyoOffice`, or `Main.TokyoOffice`
756 - `$attachment` - attachment name, e.g.=logo.gif=
758 $web and $topic are parsed as described in the documentation for `normalizeWebTopicName`.
760 **Since:** TWiki::Plugins::VERSION 1.1
762 ### <a name="readAttachment( $web, $topic, $n"></a> readAttachment( $web, $topic, $name, $rev ) -> $data
764 - `$web` - web for topic
766 - `$name` - attachment name
767 - `$rev` - revision to read (default latest)
769 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.
771 View permission on the topic is required for the read to be successful. Access control violations are flagged by a TWiki::AccessControlException. Permissions are checked for the current user.
773 my( $meta, $text ) = TWiki::Func::readTopic( $web, $topic );
774 my @attachments = $meta->find( 'FILEATTACHMENT' );
775 foreach my $a ( @attachments ) {
777 my $data = TWiki::Func::readAttachment( $web, $topic, $a->{name} );
779 } catch TWiki::AccessControlException with {
783 **Since:** TWiki::Plugins::VERSION 1.1
785 ### <a name="saveAttachment( $web, $topic, $a"></a> saveAttachment( $web, $topic, $attachment, $opts )
787 - `$web` - web for topic
788 - `$topic` - topic to atach to
789 - `$attachment` - name of the attachment
790 - `$opts` - Ref to hash of options
794 <table border="1" cellpadding="0" cellspacing="0">
796 <td><code>dontlog</code></td>
797 <td> don't log this change in twiki log </td>
800 <td><code>comment</code></td>
801 <td> comment for save </td>
804 <td><code>hide</code></td>
805 <td> if the attachment is to be hidden in normal topic view </td>
808 <td><code>stream</code></td>
809 <td> Stream of file to upload </td>
812 <td><code>file</code></td>
813 <td> Name of a file to use for the attachment data. ignored if stream is set. Local file on the server. </td>
816 <td><code>filepath</code></td>
817 <td> Client path to file </td>
820 <td><code>filesize</code></td>
821 <td> Size of uploaded data </td>
824 <td><code>filedate</code></td>
829 Save an attachment to the store for a topic. On success, returns undef. If there is an error, an exception will be thrown.
832 TWiki::Func::saveAttachment( $web, $topic, 'image.gif',
833 { file => 'image.gif',
834 comment => 'Picture of Health',
836 } catch Error::Simple with {
837 # see documentation on Error
842 **Since:** TWiki::Plugins::VERSION 1.1
844 ### <a name="moveAttachment( $web, $topic, $a"></a> moveAttachment( $web, $topic, $attachment, $newWeb, $newTopic, $newAttachment )
846 - `$web` source web - required
847 - `$topic` source topic - required
848 - `$attachment` source attachment - required
850 - `$newTopic` dest topic
851 - `$newAttachment` dest attachment
853 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.
855 The destination topic must already exist, but the destination attachment must **not** exist.
857 Rename an attachment to $TWiki::cfg\{TrashWebName\}.TrashAttament to delete it.
859 use Error qw( :try );
862 # move attachment between topics
863 moveAttachment( "Countries", "Germany", "AlsaceLorraine.dat",
864 "Countries", "France" );
865 # Note destination attachment name is defaulted to the same as source
866 } catch TWiki::AccessControlException with {
868 # see documentation on TWiki::AccessControlException
869 } catch Error::Simple with {
871 # see documentation on Error::Simple
874 **Since:** TWiki::Plugins::VERSION 1.1
876 ## <a name="Assembling Pages"></a> Assembling Pages
878 ### <a name="readTemplate( $name, $skin ) - $"></a> readTemplate( $name, $skin ) -> $text
880 Read a template or skin. Embedded [[template directives|TWiki/TWikiTemplates]] get expanded
882 - `$name` - Template name, e.g. `'view'`
883 - `$skin` - Comma-separated list of skin names, optional, e.g. `'print'`
885 Return: `$text` Template text
887 **Since:** TWiki::Plugins::VERSION 1.000 (7 Dec 2002)
889 ### <a name="loadTemplate ( $name, $skin, $we"></a> loadTemplate ( $name, $skin, $web ) -> $text
891 - `$name` - template file name
892 - `$skin` - comma-separated list of skins to use (default: current skin)
893 - `$web` - the web to look in for topics that contain templates (default: current web)
895 Return: expanded template text (what's left after removal of all %TMPL:DEF% statements)
897 **Since:** TWiki::Plugins::VERSION 1.1
899 Reads a template and extracts template definitions, adding them to the list of loaded templates, overwriting any previous definition.
901 How TWiki searches for templates is described in [[TWikiTemplates]].
903 If template text is found, extracts include statements and fully expands them.
905 ### <a name="expandTemplate( $def ) - $strin"></a> expandTemplate( $def ) -> $string
907 Do a , only expanding the template (not expanding any variables other than %TMPL)
909 - `$def` - template name
911 Return: the text of the expanded template
913 **Since:** TWiki::Plugins::VERSION 1.1
915 A template is defined using a %TMPL:DEF% statement in a template file. See the documentation on TWiki templates for more information.
917 ### <a name="writeHeader( $query, $contentLen"></a> writeHeader( $query, $contentLength )
919 Prints a basic content-type HTML header for text/html to standard out
921 - `$query` - CGI query object. If not given, the default CGI query will be used. In most cases you should _not_ pass this parameter.
922 - `$contentLength` - Length of content
926 **Since:** TWiki::Plugins::VERSION 1.000 (7 Dec 2002)
928 ### <a name="redirect_CgiQuery( $query, $url"></a><a name="redirect_CgiQuery( $query, $url "></a> redirectCgiQuery( $query, $url )
932 - `$query` - CGI query object. Ignored, only there for compatibility. The session CGI query object is used instead.
933 - `$url` - URL to redirect to
935 Return: none, never returns
937 **Since:** TWiki::Plugins::VERSION 1.000 (7 Dec 2002)
939 ### <a name="add_ToHEAD( $id, $header )"></a> addToHEAD( $id, $header )
941 Adds `$header` to the HTML header (the
943 tag). This is useful for Plugins that want to include some javascript custom css.
945 - `$id` - Unique ID to prevent the same HTML from being duplicated. Plugins should use a prefix to prevent name clashes (e.g EDITTABLEPLUGIN\_JSCALENDAR)
946 - `$header` - the HTML to be added to the
948 section. The HTML must be valid in a HEAD tag - no checks are performed.
950 All TWiki variables present in `$header` will be expanded before being inserted into the ``
954 Note that this is _not_ the same as the HTTP header, which is modified through the Plugins `modifyHeaderHandler`.
956 **Since:** TWiki::Plugins::VERSION 1.1
960 TWiki::Func::addToHEAD('PATTERN_STYLE','<link id="twikiLayoutCss" rel="stylesheet" type="text/css" href="%PUBURL%/TWiki/PatternSkin/layout.css" media="all" />')
962 ### <a name="expand_CommonVariables( $text, $"></a> expandCommonVariables( $text, $topic, $web ) -> $text
964 Expand all common `%VARIABLES%`
966 - `$text` - Text with variables to expand, e.g. `'Current user is %WIKIUSER%'`
967 - `$topic` - Current topic name, e.g. `'WebNotify'`
968 - `$web` - Web name, optional, e.g. `'Main'`. The current web is taken if missing
970 Return: `$text` Expanded text, e.g. `'Current user is TWikiGuest'`
972 **Since:** TWiki::Plugins::VERSION 1.000 (7 Dec 2002)
974 See also: expandVariablesOnTopicCreation
976 ### <a name="renderText( $text, $web ) - $tex"></a> renderText( $text, $web ) -> $text
978 Render text from TWiki markup into XHTML as defined in [[TWiki.TextFormattingRules|TWiki/TextFormattingRules]]
980 - `$text` - Text to render, e.g. `'*bold* text and =fixed font='`
981 - `$web` - Web name, optional, e.g. `'Main'`. The current web is taken if missing
983 Return: `$text` XHTML text, e.g. `'<b>bold</b> and <code>fixed font</code>'`
985 **Since:** TWiki::Plugins::VERSION 1.000 (7 Dec 2002)
987 ### <a name="internalLink( $pre, $web, $topic"></a> internalLink( $pre, $web, $topic, $label, $anchor, $createLink ) -> $text
989 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()`
991 - `$pre` - Text occuring before the TWiki link syntax, optional
992 - `$web` - Web name, required, e.g. `'Main'`
993 - `$topic` - Topic name to link to, required, e.g. `'WebNotify'`
994 - `$label` - Link label, required. Usually the same as `$topic`, e.g. `'notify'`
995 - `$anchor` - Anchor, optional, e.g. `'#Jump'`
996 - `$createLink` - Set to `'1'` to add question linked mark after topic name if topic does not exist;<br /> set to `'0'` to suppress link for non-existing topics
998 Return: `$text` XHTML anchor, e.g. `'<a href='/cgi-bin/view/Main/WebNotify#Jump'>notify</a>'`
1000 **Since:** TWiki::Plugins::VERSION 1.000 (7 Dec 2002)
1002 ## <a name="E-mail"></a> E-mail
1004 ### <a name="sendEmail ( $text, $retries ) -"></a><a name="sendEmail ( $text, $retries ) - "></a> sendEmail ( $text, $retries ) -> $error
1006 - `$text` - text of the mail, including MIME headers
1007 - `$retries` - number of times to retry the send (default 1)
1009 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:
1011 To: liz@windsor.gov.uk
1012 From: serf@hovel.net
1013 CC: george@whitehouse.gov
1018 Please abolish the monarchy (with King George's permission, of course)
1024 Leave a blank line between the last header field and the message body.
1026 **Since:** TWiki::Plugins::VERSION 1.1
1028 ### <a name="wiki_ToEmail( $wikiName ) - $ema"></a> wikiToEmail( $wikiName ) -> $email
1030 - `$wikiName` - wiki name of the user
1032 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.
1034 **Since:** TWiki::Plugins::VERSION 1.1
1036 ## <a name="Creating New Topics"></a> Creating New Topics
1038 ### <a name="expand_VariablesOnTopicCreation"></a><a name="expand_VariablesOnTopicCreation "></a> expandVariablesOnTopicCreation ( $text ) -> $text
1040 Expand the limited set of variables that are always expanded during topic creation
1042 - `$text` - the text to process
1044 Return: text with variables expanded
1046 **Since:** TWiki::Plugins::VERSION 1.1
1048 Expands only the variables expected in templates that must be statically expanded in new content.
1050 The expanded variables are:
1052 - `%DATE%` Signature-format date
1053 - `%SERVERTIME%` See [[TWikiVariables]]
1054 - `%GMTIME%` See [[TWikiVariables]]
1055 - `%USERNAME%` Base login name
1056 - `%WIKINAME%` Wiki name
1057 - `%WIKIUSERNAME%` Wiki name with prepended web
1058 - `%URLPARAM{...}%` - Parameters to the current CGI query
1061 See also: expandVariables
1063 ## <a name="Special handlers"></a> Special handlers
1065 Special handlers can be defined to make functions in plugins behave as if they were built-in to TWiki.
1067 ### <a name="register_TagHandler( $var, \fn,"></a><a name="register_TagHandler( $var, \fn, "></a> registerTagHandler( $var, \\&fn, $syntax )
1069 Should only be called from initPlugin.
1071 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`.
1073 - `$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.
1074 - `\&fn` - Reference to the handler function.
1075 - `$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"\}%
1077 **Since:** TWiki::Plugins::VERSION 1.1
1079 The variable handler function must be of the form:
1081 sub handler(\%session, \%params, $topic, $web)
1085 - `\%session` - a reference to the TWiki session object (may be ignored)
1086 - `\%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.
1087 - `$topic` - name of the topic in the query
1088 - `$web` - name of the web in the query
1090 for example, to execute an arbitrary command on the server, you might do this:
1093 TWiki::Func::registerTagHandler('EXEC', \&boo);
1097 my( $session, $params, $topic, $web ) = @_;
1098 my $cmd = $params->{_DEFAULT};
1100 return "NO COMMAND SPECIFIED" unless $cmd;
1102 my $result = `$cmd 2>&1`;
1103 return $params->{silent} ? '' : $result;
1107 would let you do this: `%EXEC{"ps -Af" silent="on"}%`
1109 ### <a name="registerRESTHandler( $alias, \fn"></a> registerRESTHandler( $alias, \\&fn, )
1111 Should only be called from initPlugin.
1113 Adds a function to the dispatch table of the REST interface
1115 - `$alias` - The name .
1116 - `\&fn` - Reference to the function.
1118 **Since:** TWiki::Plugins::VERSION 1.1
1120 The handler function must be of the form:
1122 sub handler(\%session)
1126 - `\%session` - a reference to the TWiki session object (may be ignored)
1128 From the REST interface, the name of the plugin must be used as the subject of the invokation.
1134 The [[EmptyPlugin]] has the following call in the initPlugin handler:
1136 TWiki::Func::registerRESTHandler('example', \&restExample);
1138 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
1140 `http://server:port/bin/rest/EmptyPlugin/example`
1144 `http://server:port/bin/rest/EmptyPlugin/restExample`
1146 (ie, with the name of the function instead of the alias) will not work.
1148 ## <a name="Searching"></a> Searching
1150 ### <a name="search_InWebContent($searchStrin"></a> searchInWebContent($searchString, $web, \\@topics, \\%options ) -> \\%map
1152 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+\{.\*\}%)
1154 - `$searchString` - the search string, in egrep format
1155 - `$web` - The web to search in
1156 - `\@topics` - reference to a list of topics to search
1157 - `\%option` - reference to an options hash
1159 The `\%options` hash may contain the following options:
1161 - `type` - if `regex` will perform a egrep-syntax RE search (default '')
1162 - `casesensitive` - false to ignore case (defaulkt true)
1163 - `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).
1165 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'.
1167 To iterate over the returned topics use:
1169 my $result = TWiki::Func::searchInWebContent( "Slimy Toad", $web, \@topics,
1170 { casesensitive => 0, files_without_match => 0 } );
1171 foreach my $topic (keys %$result ) {
1172 foreach my $matching_line ( @{$result->{$topic}} ) {
1175 **Since:** TWiki::Plugins::VERSION 1.1
1177 ## <a name="Plugin-specific file handling"></a> Plugin-specific file handling
1179 ### <a name="get_WorkArea( $pluginName ) - $d"></a> getWorkArea( $pluginName ) -> $directorypath
1181 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.
1183 The directory is guaranteed to exist, and to be writable by the webserver user. By default it will **not** be web accessible.
1185 The directory and it's contents are permanent, so Plugins must be careful to keep their areas tidy.
1187 **Since:** TWiki::Plugins::VERSION 1.1 (Dec 2005)
1189 ### <a name="readFile( $filename ) - $text"></a> readFile( $filename ) -> $text
1191 Read file, low level. Used for Plugin workarea.
1193 - `$filename` - Full path name of file
1195 Return: `$text` Content of file, empty if not found
1197 **_NOTE:_** Use this function only for the Plugin workarea, **not** for topics and attachments. Use the appropriate functions to manipulate topics and attachments.
1199 **Since:** TWiki::Plugins::VERSION 1.000 (07 Dec 2002)
1201 ### <a name="saveFile( $filename, $text )"></a> saveFile( $filename, $text )
1203 Save file, low level. Used for Plugin workarea.
1205 - `$filename` - Full path name of file
1206 - `$text` - Text to save
1210 **_NOTE:_** Use this function only for the Plugin workarea, **not** for topics and attachments. Use the appropriate functions to manipulate topics and attachments.
1212 **Since:** TWiki::Plugins::VERSION 1.000 (07 Dec 2002)
1214 ## <a name="General Utilities"></a> General Utilities
1216 ### <a name="get_RegularExpression( $name ) -"></a> getRegularExpression( $name ) -> $expr
1218 Retrieves a TWiki predefined regular expression or character class.
1220 - `$name` - Name of the expression to retrieve. See notes below
1222 Return: String or precompiled regular expression matching as described below.
1224 **Since:** TWiki::Plugins::VERSION 1.020 (9 Feb 2004)
1226 **_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.
1228 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:
1230 my $upper = TWiki::Func::getRegularExpression('upperAlpha');
1231 my $alpha = TWiki::Func::getRegularExpression('mixedAlpha');
1232 my $capitalized = qr/[$upper][$alpha]+/;
1234 Those expressions marked type 'RE' are precompiled regular expressions that can be used outside square brackets. For example:
1236 my $webRE = TWiki::Func::getRegularExpression('webNameRegex');
1237 my $isWebName = ( $s =~ m/$webRE/ );
1239 <table border="1" cellpadding="0" cellspacing="0">
1241 <th bgcolor="#99CCCC"><strong> Name </strong></th>
1242 <th bgcolor="#99CCCC"><strong> Matches </strong></th>
1243 <th bgcolor="#99CCCC"><strong> Type </strong></th>
1246 <td> upperAlpha </td>
1247 <td> Upper case characters </td>
1251 <td> upperAlphaNum </td>
1252 <td> Upper case characters and digits </td>
1256 <td> lowerAlpha </td>
1257 <td> Lower case characters </td>
1261 <td> lowerAlphaNum </td>
1262 <td> Lower case characters and digits </td>
1271 <td> mixedAlpha </td>
1272 <td> Alphabetic characters </td>
1276 <td> mixedAlphaNum </td>
1277 <td> Alphanumeric characters </td>
1281 <td> wikiWordRegex </td>
1282 <td>[[Main/WikiWords]]</td>
1286 <td> webNameRegex </td>
1287 <td> User web names </td>
1291 <td> anchorRegex </td>
1292 <td> #AnchorNames </td>
1296 <td> abbrevRegex </td>
1297 <td> Abbreviations e.g. GOV, IRS </td>
1301 <td> emailAddrRegex </td>
1302 <td><a href="mailto:email@address.com">email@address.com</a></td>
1306 <td> tagNameRegex </td>
1307 <td> Standard variable names e.g. %THIS_BIT% (THIS_BIT only) </td>
1312 ### <a name="normalize_WebTopicName($web, $to"></a> normalizeWebTopicName($web, $topic) -> ($web, $topic)
1314 Parse a web and topic name, supplying defaults as appropriate.
1316 - `$web` - Web name, identifying variable, or empty string
1317 - `$topic` - Topic name, may be a web.topic string, required.
1319 Return: the parsed Web/Topic pai
1321 **Since:** TWiki::Plugins::VERSION 1.1
1323 <table border="1" cellpadding="0" cellspacing="0">
1325 <th bgcolor="#99CCCC"><strong> Input </strong></th>
1326 <th bgcolor="#99CCCC"><strong> Return </strong></th>
1329 <td><tt>( 'Web', 'Topic' ) </tt></td>
1330 <td><tt>( 'Web', 'Topic' ) </tt></td>
1333 <td><tt>( '', 'Topic' ) </tt></td>
1334 <td><tt>( 'Main', 'Topic' ) </tt></td>
1337 <td><tt>( '', '' ) </tt></td>
1338 <td><tt>( 'Main', 'WebHome' ) </tt></td>
1341 <td><tt>( '', 'Web/Topic' ) </tt></td>
1342 <td><tt>( 'Web', 'Topic' ) </tt></td>
1345 <td><tt>( '', 'Web.Topic' ) </tt></td>
1346 <td><tt>( 'Web', 'Topic' ) </tt></td>
1349 <td><tt>( 'Web1', 'Web2.Topic' )</tt></td>
1350 <td><tt>( 'Web2', 'Topic' ) </tt></td>
1353 <td><tt>( 'Main', 'Topic' )</tt></td>
1354 <td><tt>( 'Main', 'Topic' ) </tt></td>
1357 <td><tt>( 'TWiki', 'Topic' )</tt></td>
1358 <td><tt>( 'TWiki', 'Topic' ) </tt></td>
1362 where `Main` and `TWiki` are the web names set in $cfg\{UsersWebName\} and $cfg\{SystemWebName\} respectively.
1364 ### <a name="writeWarning( $text )"></a> writeWarning( $text )
1366 Log Warning that may require admin intervention to data/warning.txt
1368 - `$text` - Text to write; timestamp gets added
1372 **Since:** TWiki::Plugins::VERSION 1.020 (16 Feb 2004)
1374 ### <a name="writeDebug( $text )"></a> writeDebug( $text )
1376 Log debug message to data/debug.txt
1378 - `$text` - Text to write; timestamp gets added
1382 **Since:** TWiki::Plugins::VERSION 1.020 (16 Feb 2004)
1384 ### <a name="formatTime( $time, $format, $tim"></a> formatTime( $time, $format, $timezone ) -> $text
1386 Format the time in seconds into the desired time string
1388 - `$time` - Time in epoc seconds
1389 - `$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
1390 - `$timezone` - either not defined (uses the displaytime setting), 'gmtime', or 'servertime'
1392 Return: `$text` Formatted time string
1394 <table border="1" cellpadding="0" cellspacing="0">
1397 <td> if you used the removed formatGmTime, add a third parameter 'gmtime' </td>
1401 **Since:** TWiki::Plugins::VERSION 1.020 (26 Feb 2004)
1403 ### <a name="is_ValidWikiWord ( $text ) - $bo"></a> isValidWikiWord ( $text ) -> $boolean
1405 Check for a valid [[WikiWord]] or [[WikiName]]
1407 - `$text` - Word to test
1409 **Since:** TWiki::Plugins::VERSION 1.100 (Dec 2005)
1411 ### <a name="extractParameters($attr ) - %par"></a> extractParameters($attr ) -> %params
1413 Extract all parameters from a variable string and returns a hash of parameters
1415 - `$attr` - Attribute string
1417 Return: `%params` Hash containing all parameters. The nameless parameter is stored in key `_DEFAULT`
1419 **Since:** TWiki::Plugins::VERSION 1.025 (26 Aug 2004)
1422 - Variable: `%TEST{ 'nameless' name1="val1" name2="val2" }%`
1423 - First extract text between `{...}` to get: `'nameless' name1="val1" name2="val2"`
1424 - Then call this on the text: <br />
1425 - params = TWiki::Func::extractParameters( $text );=
1426 - The `%params` hash contains now: <br />`_DEFAULT => 'nameless'`<br />`name1 => "val1"`<br />`name2 => "val2"`
1428 ### <a name="extract_NameValuePair( $attr, $n"></a> extractNameValuePair( $attr, $name ) -> $value
1430 Extract a named or unnamed value from a variable parameter string - Note: | Function TWiki::Func::extractParameters is more efficient for extracting several parameters
1432 - `$attr` - Attribute string
1433 - `$name` - Name, optional
1435 Return: `$value` Extracted value
1437 **Since:** TWiki::Plugins::VERSION 1.000 (7 Dec 2002)
1440 - Variable: `%TEST{ 'nameless' name1="val1" name2="val2" }%`
1441 - First extract text between `{...}` to get: `'nameless' name1="val1" name2="val2"`
1442 - Then call this on the text: <br />`my $noname = TWiki::Func::extractNameValuePair( $text );`<br />`my $val1 = TWiki::Func::extractNameValuePair( $text, "name1" );`<br />`my $val2 = TWiki::Func::extractNameValuePair( $text, "name2" );`
1444 ## <a name="Deprecated functions"></a> Deprecated functions
1446 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.
1448 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%.
1450 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:
1452 package TWiki::Plugins::SinkPlugin;
1453 use vars qw( %TWikiCompatibility );
1454 $TWikiCompatibility{endRenderingHandler} = 1.1;
1456 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.
1458 The following functions are retained for compatibility only. You should stop using them as soon as possible.
1460 ### <a name="get_ScriptUrlPath( ) - $path"></a> getScriptUrlPath( ) -> $path
1464 **DEPRECATED** since 1.1 - use `getScriptUrl` instead.
1466 Return: `$path` URL path of TWiki scripts, e.g. `"/cgi-bin"`
1468 **WARNING:** you are strongly recommended **not** to use this function, as the \{ScriptUrlPaths\} URL rewriting rules will not apply to urls generated using it.
1470 **Since:** TWiki::Plugins::VERSION 1.000 (7 Dec 2002)
1472 ### <a name="get_PublicWebList( ) - @webs"></a> getPublicWebList( ) -> @webs
1474 **DEPRECATED** since 1.1 - use `getListOfWebs` instead.
1476 Get list of all public webs, e.g. all webs that do not have the `NOSEARCHALL` flag set in the [[WebPreferences]]
1478 Return: `@webs` List of all public webs, e.g. `( 'Main', 'Know', 'TWiki' )`
1480 **Since:** TWiki::Plugins::VERSION 1.000 (07 Dec 2002)
1482 ### <a name="format_GmTime( $time, $format )"></a><a name="format_GmTime( $time, $format ) "></a> formatGmTime( $time, $format ) -> $text
1484 **DEPRECATED** since 1.1 - use `formatTime` instead.
1486 Format the time to GM time
1488 - `$time` - Time in epoc seconds
1489 - `$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'`)
1491 Return: `$text` Formatted time string
1493 **Since:** TWiki::Plugins::VERSION 1.000 (7 Dec 2002)
1495 ### <a name="get_DataDir( ) - $dir"></a> getDataDir( ) -> $dir
1497 **DEPRECATED** since 1.1 - use the [[content handling functions|Main/WebHome#Functions_Content_Handling]] to manipulate topics instead
1499 Get data directory (topic file root)
1501 Return: `$dir` Data directory, e.g. `'/twiki/data'`
1503 This function violates store encapsulation and is therefore **deprecated**.
1505 **Since:** TWiki::Plugins::VERSION 1.000 (07 Dec 2002)
1507 ### <a name="get_PubDir( ) - $dir"></a> getPubDir( ) -> $dir
1509 **DEPRECATED** since 1.1 - use the [[content handling functions|Main/WebHome#Functions_Content_Handling]] to manipulateattachments instead
1511 Get pub directory (file attachment root). Attachments are in `$dir/Web/TopicName`
1513 Return: `$dir` Pub directory, e.g. `'/htdocs/twiki/pub'`
1515 This function violates store encapsulation and is therefore **deprecated**.
1517 Use `readAttachment` and `saveAttachment` instead.
1519 **Since:** TWiki::Plugins::VERSION 1.000 (07 Dec 2002)
1521 ### <a name="checkDependencies( $moduleName,"></a><a name="checkDependencies( $moduleName, "></a> checkDependencies( $moduleName, $dependenciesRef ) -> $error
1523 **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.
1525 **Since:** TWiki::Plugins::VERSION 1.025 (01 Aug 2004)