...
Line: 308 to 308 | ||||||||
---|---|---|---|---|---|---|---|---|
Added: | ||||||||
> > | ObjectMethod *determineWebTopic ($pathInfo,$web,$topic) -> ($web,$topic,$requestedWeb)Determine the web and topic names from PATH_INFO and web and topic names explicitly provided. And then sanitize them. | |||||||
ClassMethod new ($loginName,$query,\%initialContext)Constructs a new TWiki object. Parameters are taken from the query object. | ||||||||
Line: 557 to 565 | ||||||||
StaticMethod *spaceOutWikiWord ($word,$sep) -> $string | ||||||||
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. | |||||||
Added: | ||||||||
> > | Parameter $sep defines the separator between the word components, the default is a space. | |||||||
Added: | ||||||||
> > | Example: "ABC2015ProjectCharter" results in "ABC 2015 Project Charter" | |||||||
Line: 707 to 720 | ||||||||
WARNING: Never, ever use this for accessing topics or attachments! Use the Store API for that. This is for global control files only, and should be used only if there is absolutely no alternative. | ||||||||
Added: | ||||||||
> > |
StaticMethod *suffixToMimeType ($filename) -> $mimeTypeReturns the MIME type corresponding to the extension of the $filename based on the file specified by {MimeTypesFileName}. If there is no extension or the extension is not found in the {MimeTypesFileName} file, 'text/plain' is returned. | |||||||
Line: 9 to 9 | ||||||||
---|---|---|---|---|---|---|---|---|
Global variables are avoided wherever possible to avoid problems with CGI accelerators such as mod_perl. | ||||||||
Changed: | ||||||||
< < | Public Data members | |||||||
> > | Public Data members | |||||||
| ||||||||
Line: 54 to 54 | ||||||||
Changed: | ||||||||
< < | ObjectMethod *writeCompletePage ($text,$pageType,$contentType) | |||||||
> > | ObjectMethod *writeCompletePage ($text,$pageType,$contentType,$status) | |||||||
Write a complete HTML page with basic header to the browser.
| ||||||||
Line: 62 to 62 | ||||||||
caching for 24 hours, to prevent BackFromPreviewLosesText bug, which caused
data loss with IE5 and IE6.
| ||||||||
Added: | ||||||||
> > |
| |||||||
This method removes noautolink and nop tags before outputting the page unless $contentType is text/plain. | ||||||||
Changed: | ||||||||
< < | ObjectMethod *generateHTTPHeaders ($pageType,$contentType,$contentLength) -> $header | |||||||
> > | ObjectMethod *generateHTTPHeaders ($pageType,$contentType,$status) -> $header | |||||||
All parameters are optional.
| ||||||||
Changed: | ||||||||
< < |
| |||||||
> > |
| |||||||
Implements the post-Dec2001 release plugin API, which requires the writeHeaderHandler in plugin to return a string of HTTP headers, CR/LF | ||||||||
Line: 91 to 92 | ||||||||
Changed: | ||||||||
< < | ObjectMethod redirect ($url,$passthrough,$action_redirectto) | |||||||
> > | ObjectMethod redirect ($url,$passthrough,$action_redirectto,$viaCache) | |||||||
| ||||||||
Added: | ||||||||
> > |
| |||||||
Redirects the request to $url , unless
| ||||||||
Line: 116 to 119 | ||||||||
over a cache reference in the redirect GET. NOTE: Passthrough is only meaningful if the redirect target is on the same | ||||||||
Changed: | ||||||||
< < | server. | |||||||
> > | server. "$viaCache" is meaningful only if "$action_redirectto" is false and "$passthru" is true. | |||||||
Line: 161 to 165 | ||||||||
Changed: | ||||||||
< < | ObjectMethod *readOnlyMirrorWeb ($theWeb) -> ($mirrorSiteName,$mirrorViewURL,$mirrorLink,$mirrorNote) | |||||||
> > | ObjectMethod modeAndMaster ($web)Returns the following hash reference such as this:('', undef) | |||||||
Changed: | ||||||||
< < | If this is a mirrored web, return information about the mirror. The info is returned in a quadruple: | |||||||
> > | and this:
('slave', { # master site data siteName => 'na', webScriptUrlTmpl => 'http://twiki.example.com/cgi-bin//Web', scriptSuffix => '', webViewUrl => 'http://twiki.example.com/Web', }) | |||||||
Changed: | ||||||||
< < |
| |||||||
> > | The first value is the mode of the web: either 'local', 'master', 'slave', or 'read-only'. The second value is defined only when the master site is defined for the web. | |||||||
ObjectMethod getSkin () -> $string | ||||||||
Line: 185 to 201 | ||||||||
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 | ||||||||
Changed: | ||||||||
< < | .../view/x/y?a=1&b=2#XXX | |||||||
> > | .../view/x/y?a=1&b=2#XXX | |||||||
If $absolute is set, generates an absolute URL. $absolute is advisory only; TWiki can decide to generate absolute URLs (for example when run from the | ||||||||
Line: 203 to 219 | ||||||||
(including web and topic). Otherwise will generate only up to the script name. An undefined web will default to the main web name. | ||||||||
Added: | ||||||||
> > | The returned URL takes ReadOnlyAndMirrorWebs into account.
If the specified $web is slave on this site, with the scripts
edit , save , attach , upload , and rename , this method returns
the URLs on the master site because it does not make sense to execute
those scripts on the master site of the web. | |||||||
Added: | ||||||||
> > | Even with the other scripts, you may need to get the URLs on the master site.
You can get those URLs by providing $master => 1 as a name value pair. | |||||||
Added: | ||||||||
> > |
ObjectMethod getDiskInfo ($web,$site,$diskID) -> ($dataDir,$pubDir,$diskID)You can specify either $web or $diskID, not both.ObjectMethod getDiskList () -> ('',1,2,...)ObjectMethod getDataDir ($web,$diskID) -> $dataDirYou can specify either $web or $diskID, not both.ObjectMethod getPubDir ($web,$diskID) -> $pubDirYou can specify either $web or $diskID, not both. | |||||||
ObjectMethod getPubUrl ($absolute,$web,$topic,$attachment) -> $urlComposes a pub url. If $absolute is set, returns an absolute URL. | ||||||||
Line: 502 to 548 | ||||||||
Added: | ||||||||
> > | StaticMethod topLevelWeb ($web) -> toplevelwebof$webIf $web is a top level web, it returns $web. If $web is a subweb, it returns the top level web of $web. | |||||||
StaticMethod *spaceOutWikiWord ($word,$sep) -> $stringSpaces out a wiki word by inserting a string (default: one space) between each word component. | ||||||||
Line: 623 to 676 | ||||||||
Changed: | ||||||||
< < | %<nop}RENDERHEAD% | |||||||
> > | %RENDERHEAD% | |||||||
== should be written where you want the sorted head tags to be generated. This will normally be in a template. The variable expands to a sorted list of the head blocks added up to the point the RENDERHEAD variable is expanded. Each expanded head block is preceded by an HTML comment that records the ID of the head block.
Head blocks are sorted to satisfy all their requires constraints. | ||||||||
Line: 666 to 719 | ||||||||
| ||||||||
Added: | ||||||||
> > |
| |||||||
|
Line: 387 to 387 | ||||||||
---|---|---|---|---|---|---|---|---|
| ||||||||
Added: | ||||||||
> > |
| |||||||
Expand limited set of variables during topic creation. These are variables expected in templates that must be statically expanded in new content. | ||||||||
Deleted: | ||||||||
< < |
| |||||||
# SMELL: no plugin handler |
Line: 181 to 181 | ||||||||
---|---|---|---|---|---|---|---|---|
Returns the URL to a TWiki script, providing the web and topic as "path info" parameters. The result looks something like this: "http://host/twiki/bin/$script/$web/$topic". | ||||||||
Changed: | ||||||||
< < |
| |||||||
> > |
| |||||||
If $absolute is set, generates an absolute URL. $absolute is advisory only; TWiki can decide to generate absolute URLs (for example when run from the | ||||||||
Line: 195 to 199 | ||||||||
when running from the command line, or when generating rss). If $script is not given, absolute URLs will always be generated. | ||||||||
Changed: | ||||||||
< < | If either the web or the topic is defined, will generate a full url (including web and topic). Otherwise will generate only up to the script name. An undefined web will default to the main web name. | |||||||
> > | If either the web or the topic is defined, will generate a full url (including web and topic). Otherwise will generate only up to the script name. An undefined web will default to the main web name. | |||||||
Line: 661 to 667 | ||||||||
| ||||||||
Added: | ||||||||
> > |
| |||||||
Line: 10 to 10 | ||||||||
---|---|---|---|---|---|---|---|---|
with CGI accelerators such as mod_perl.
Public Data members | ||||||||
Changed: | ||||||||
< < |
| |||||||
> > |
| |||||||
| ||||||||
Line: 25 to 26 | ||||||||
not consistently used. Avoid.
| ||||||||
Changed: | ||||||||
< < | the current CGI request. | |||||||
> > | the current request. | |||||||
| ||||||||
Line: 46 to 47 | ||||||||
Changed: | ||||||||
< < | StaticMethod *UTF82SiteCharSet ($utf8) -> $ascii | |||||||
> > | ObjectMethod *UTF82SiteCharSet ($utf8) -> $ascii | |||||||
Auto-detect UTF-8 vs. site charset in string, and convert UTF-8 into site charset. | ||||||||
Line: 67 to 68 | ||||||||
Changed: | ||||||||
< < | ObjectMethod *generateHTTPHeaders ($query,$pageType,$contentType,$contentLength) -> $header | |||||||
> > | ObjectMethod *generateHTTPHeaders ($pageType,$contentType,$contentLength) -> $header | |||||||
All parameters are optional. | ||||||||
Deleted: | ||||||||
< < |
| |||||||
| ||||||||
Line: 100 to 100 | ||||||||
Redirects the request to $url , unless
| ||||||||
Changed: | ||||||||
< < |
| |||||||
> > |
| |||||||
| ||||||||
Line: 211 to 211 | ||||||||
Changed: | ||||||||
< < | ObjectMethod getIconUrl ($absolute,$iconName) -> $iconURL | |||||||
> > | ObjectMethod cacheIconData ($action) | |||||||
Changed: | ||||||||
< < | Map an icon name to a URL path. | |||||||
> > | Cache icon data based on action:
| |||||||
Changed: | ||||||||
< < | ObjectMethod *mapToIconFileName ($fileName,$default) -> $fileName | |||||||
> > | ObjectMethod formatIcon ($iconName,$format,$default) -> $icon | |||||||
Changed: | ||||||||
< < | Maps from a filename (or just the extension) to the name of the file that contains the image for that file type. | |||||||
> > | Format an icon based on name and format parameter. The format parameter handles
these variables (with example):
| |||||||
Added: | ||||||||
> > | The optional default parameter specifies the icon name in case the icon is not defined. Leave empty if you assume icon files exist in the default location. | |||||||
Line: 245 to 263 | ||||||||
| ||||||||
Changed: | ||||||||
< < |
| |||||||
> > |
| |||||||
is used)
| ||||||||
Line: 566 to 584 | ||||||||
Deleted: | ||||||||
< < | StaticMethod restDispatch ($subject,$verb)=>\&fnReturns the handler function associated to the given $subject and $werb, or undef if none is found. Since: TWiki::Plugins::VERSION 1.1 | |||||||
ObjectMethod *handleCommonTags ($text,$web,$topic,$meta) -> $textProcesses %VARIABLE%, and %TOC% syntax; also includes | ||||||||
Line: 588 to 597 | ||||||||
Changed: | ||||||||
< < | ObjectMethod addToHEAD ($id,$html) | |||||||
> > | ObjectMethod ADDTOHEAD ($args) | |||||||
Add $html to the HEAD tag of the page currently being generated.
Note that TWiki variables may be used in the HEAD. They will be expanded
according to normal variable expansion rules. | ||||||||
Changed: | ||||||||
< < | The 'id' is used to ensure that multiple adds of the same block of HTML don't result in it being added many times. | |||||||
> > |
You can write == in a topic or template. This variable accepts the following parameters: | |||||||
Added: | ||||||||
> > | Use %RENDERHEAD% to generate the sorted head tags.
%<nop}RENDERHEAD% should be written where you want the sorted head tags to be generated. This will normally be in a template. The variable expands to a sorted list of the head blocks added up to the point the RENDERHEAD variable is expanded. Each expanded head block is preceded by an HTML comment that records the ID of the head block.
Head blocks are sorted to satisfy all their requires constraints.
The output order of blocks with no requires value is undefined. If cycles
exist in the dependency order, the cycles will be broken but the resulting
order of blocks in the cycle is undefined. | |||||||
StaticMethod initialize ($pathInfo,$remoteUser,$topic,$url,$query) -> ($topicName,$webName,$scriptUrlPath,$userName,$dataDir) |
Line: 9 to 9 | ||||||||
---|---|---|---|---|---|---|---|---|
Global variables are avoided wherever possible to avoid problems with CGI accelerators such as mod_perl. | ||||||||
Added: | ||||||||
> > | Public Data members
| |||||||
On this page:
StaticMethod getTWikiLibDir () -> $path | ||||||||
Deleted: | ||||||||
< < | STATIC method. | |||||||
Returns the full path of the directory containing TWiki.pm | ||||||||
Changed: | ||||||||
< < | ObjectMethod *UTF82SiteCharSet ($utf8) -> $ascii | |||||||
> > | StaticMethod *UTF82SiteCharSet ($utf8) -> $ascii | |||||||
Auto-detect UTF-8 vs. site charset in string, and convert UTF-8 into site charset. | ||||||||
Line: 41 to 67 | ||||||||
Changed: | ||||||||
< < | ObjectMethod *writePageHeader ($query,$pageType,$contentType,$contentLength) | |||||||
> > | ObjectMethod *generateHTTPHeaders ($query,$pageType,$contentType,$contentLength) -> $header | |||||||
All parameters are optional. | ||||||||
Line: 55 to 81 | ||||||||
delimited. Filters any illegal headers. Plugin headers will override core settings. | ||||||||
Added: | ||||||||
> > | Does not add a Content-length header. | |||||||
Deleted: | ||||||||
< < | ObjectMethod redirect ($url,$passthrough) | |||||||
Added: | ||||||||
> > | StaticMethod isRedirectSafe ($redirect)=>$oktests if the $redirect is an external URL, returning false if AllowRedirectUrl is deniedObjectMethod redirect ($url,$passthrough,$action_redirectto)
| |||||||
Redirects the request to $url , unless
| ||||||||
Changed: | ||||||||
< < | Normally this method will ignore parameters to the current query. If $passthrough is set, then it will pass all parameters that were passed to the current query on to the redirect target. If the request_method was GET, then all parameters can be passed in the URL. If the request_method was POST then it caches the form data and passes over a cache reference in the redirect GET. | |||||||
> > | Normally this method will ignore parameters to the current query. Sometimes, for example when redirecting to a login page during authentication (and then again from the login page to the original requested URL), you want to make sure all parameters are passed on, and for this $passthrough should be set to true. In this case it will pass all parameters that were passed to the current query on to the redirect target. If the request_method for the current query was GET, then all parameters will be passed by encoding them in the URL (after ?). If the request_method was POST, then there is a risk the URL would be too big for the receiver, so it caches the form data and passes over a cache reference in the redirect GET. | |||||||
Changed: | ||||||||
< < | Passthrough is only meaningful if the redirect target is on the same server. | |||||||
> > | NOTE: Passthrough is only meaningful if the redirect target is on the same server. | |||||||
Line: 112 to 156 | ||||||||
system web names are considered valid (names starting with _) otherwise only user web names are valid | ||||||||
Added: | ||||||||
> > | If $TWiki::cfg{EnableHierarchicalWebs} is off, it will also return false when a nested web name is passed to it. | |||||||
Line: 177 to 224 | ||||||||
Changed: | ||||||||
< < | ObjectMethod getOopsUrl ($template,@options) -> $absoluteOopsURL | |||||||
> > | ObjectMethod *normalizeWebTopicName ($theWeb,$theTopic) -> ($theWeb,$theTopic) | |||||||
Changed: | ||||||||
< < | Composes a URL for an "oops" error page. The @options consists of a list
of key => value pairs. The following keys are used:
| |||||||
> > | Normalize a Web.TopicName | |||||||
Changed: | ||||||||
< < | Do not include the "oops" part in front of the template name. | |||||||
> > | See TWikiFuncDotPm for a full specification of the expansion (not duplicated here) | |||||||
Changed: | ||||||||
< < | Alternatively you can pass a reference to an OopsException in place of the template. All other parameters will be ignored. | |||||||
> > | WARNING if there is no web specification (in the web or topic parameters) the web defaults to $TWiki::cfg{UsersWebName}. If there is no topic specification, or the topic is '0', the topic defaults to the web home topic name. | |||||||
Deleted: | ||||||||
< < | The returned URL ends up looking something like this: "http://host/twiki/bin/oops/$web/$topic?template=$template¶m1=$scriptParams[0]..." | |||||||
Deleted: | ||||||||
< < | Note: if {keep} is true in the params, then they will also be pushed into the current query. | |||||||
Added: | ||||||||
> > | ClassMethod new ($loginName,$query,\%initialContext) | |||||||
Added: | ||||||||
> > | Constructs a new TWiki object. Parameters are taken from the query object. | |||||||
Changed: | ||||||||
< < | ObjectMethod *normalizeWebTopicName ($theWeb,$theTopic) -> ($theWeb,$theTopic) | |||||||
> > |
| |||||||
Deleted: | ||||||||
< < | Normalize a Web.TopicName | |||||||
Deleted: | ||||||||
< < | See TWikiFuncDotPm for a full specification of the expansion (not duplicated here) | |||||||
Changed: | ||||||||
< < | WARNING if there is no web specification (in the web or topic parameters) the web defaults to $TWiki::cfg{UsersWebName}. If there is no topic specification, or the topic is '0', the topic defaults to the web home topic name. | |||||||
> > | ObjectMethod renderer ()Get a reference to the renderer object. Done lazily because not everyone needs the renderer. | |||||||
Changed: | ||||||||
< < | ClassMethod new ($loginName,$query,\%initialContext) | |||||||
> > | ObjectMethod attach ()Get a reference to the attach object. Done lazily because not everyone needs the attach. | |||||||
Deleted: | ||||||||
< < | Constructs a new TWiki object. Parameters are taken from the query object. | |||||||
Deleted: | ||||||||
< < |
| |||||||
Added: | ||||||||
> > | ObjectMethod templates ()Get a reference to the templates object. Done lazily because not everyone needs the templates. | |||||||
Deleted: | ||||||||
< < | ObjectMethod *finish | |||||||
Changed: | ||||||||
< < | Complete processing after the client's HTTP request has been responded
to. Right now this does two things:
| |||||||
> > | ObjectMethod i18n ()Get a reference to the i18n object. Done lazily because not everyone needs the i18ner. | |||||||
Added: | ||||||||
> > | ObjectMethod search ()Get a reference to the search object. Done lazily because not everyone needs the searcher.ObjectMethod security ()Get a reference to the security object. Done lazily because not everyone needs the security.ObjectMethod net ()Get a reference to the net object. Done lazily because not everyone needs the net.ObjectMethod finish ()Break circular references. | |||||||
ObjectMethod writeLog ($action,$webTopic,$extra,$user)
| ||||||||
Changed: | ||||||||
< < |
| |||||||
> > |
| |||||||
Write the log for an event to the logfile | ||||||||
Line: 292 to 359 | ||||||||
Changed: | ||||||||
< < | ObjectMethod *expandVariablesOnTopicCreation ($text,$user) -> $text | |||||||
> > | ObjectMethod *expandVariablesOnTopicCreation ($text,$user,$web,$topic) -> $text | |||||||
| ||||||||
Changed: | ||||||||
< < |
| |||||||
> > |
| |||||||
Expand limited set of variables during topic creation. These are variables expected in templates that must be statically expanded in new content. | ||||||||
Added: | ||||||||
> > |
| |||||||
# SMELL: no plugin handler | ||||||||
Line: 339 to 408 | ||||||||
Added: | ||||||||
> > | StaticMethod *urlEncodeAttachment ($text)For attachments, URL-encode specially to 'freeze' any characters >127 in the site charset (e.g. ISO-8859-1 or KOI8-R), by doing URL encoding into native charset ($siteCharset) - used when generating attachment URLs, to enable the web server to serve attachments, including images, directly. This encoding is required to handle the cases of: - browsers that generate UTF-8 URLs automatically from site charset URLs - now quite common - web servers that directly serve attachments, using the site charset for filenames, and cannot convert UTF-8 URLs into site charset filenames The aim is to prevent the browser from converting a site charset URL in the web page to a UTF-8 URL, which is the default. Hence we 'freeze' the URL into the site character set through URL encoding. In two cases, no URL encoding is needed: For EBCDIC mainframes, we assume that site charset URLs will be translated (outbound and inbound) by the web server to/from an EBCDIC character set. For sites running in UTF-8, there's no need for TWiki to do anything since all URLs and attachment filenames are already in UTF-8. | |||||||
StaticMethod urlEncode ($string) -> encodedstringEncode by converting characters that are illegal in URLs to | ||||||||
Line: 348 to 441 | ||||||||
characters such as = and ?. RFC 1738, Dec. '94: | ||||||||
Changed: | ||||||||
< < | > | |||||||
> > | ||||||||
...Only alphanumerics [0-9a-zA-Z], the special characters $-_.+!*'(), and reserved characters used for their reserved purposes may be used unencoded within a URL. | ||||||||
Line: 356 to 450 | ||||||||
Reserved characters are $&+,/:;=?@ - these are also encoded by this method. | ||||||||
Changed: | ||||||||
< < | SMELL: For non-ISO-8859-1 $TWiki::cfg{Site}{CharSet}, need to convert to UTF-8 before URL encoding. This encoding only supports 8-bit character codes. | |||||||
> > | This URL-encoding handles all character encodings including ISO-8859-*, KOI8-R, EUC-* and UTF-8. | |||||||
Added: | ||||||||
> > | 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. | |||||||
Line: 387 to 484 | ||||||||
Added: | ||||||||
> > | ObjectMethod expandAllTags (\$text,$topic,$web,$meta)Expands variables by replacing the variables with their values. Some example variables: %TOPIC%, %SCRIPTURL%, %WIKINAME%, etc. $web and $incs are passed in for recursive include expansion. They can safely be undef. The rules for tag expansion are:
| |||||||
ObjectMethod enterContext ($id,$val)Add the context id $id into the set of active contexts. The $val | ||||||||
Line: 461 to 575 | ||||||||
Changed: | ||||||||
< < | ObjectMethod *handleCommonTags ($text,$web,$topic) -> $text | |||||||
> > | ObjectMethod *handleCommonTags ($text,$web,$topic,$meta) -> $text | |||||||
Processes %VARIABLE%, and %TOC% syntax; also includes 'commonTagsHandler' plugin hook. Returns the text of the topic, after file inclusion, variable substitution, table-of-contents generation, and any plugin changes from commonTagsHandler. | ||||||||
Added: | ||||||||
> > | $meta may be undef when, for example, expanding templates, or one-off strings at a time when meta isn't available. | |||||||
Line: 29 to 30 | |||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|
ObjectMethod *writeCompletePage ($text,$pageType,$contentType)Write a complete HTML page with basic header to the browser. | |||||||||||||
Changed: | |||||||||||||
< < | $text is the HTML of the page body (<html> to </html>) | ||||||||||||
> > |
| ||||||||||||
Changed: | |||||||||||||
< < | This method removes noautolink and nop tags before outputting the page. | ||||||||||||
> > | This method removes noautolink and nop tags before outputting the page unless $contentType is text/plain. | ||||||||||||
Line: 51 to 57 | |||||||||||||
Changed: | |||||||||||||
< < | ObjectMethod redirect ($url,...) | ||||||||||||
> > | ObjectMethod redirect ($url,$passthrough) | ||||||||||||
Changed: | |||||||||||||
< < | Generate a CGI redirect to $url unless (1) $session->{cgiQuery} is undef or (2) $query->param('noredirect') is set to a true value. Thus a redirect is only generated when in a CGI context. | ||||||||||||
> > | Redirects the request to $url , unless
| ||||||||||||
Changed: | |||||||||||||
< < | The ... parameters are concatenated to the message written when printing to STDOUT, and are ignored for a redirect. | ||||||||||||
> > | Normally this method will ignore parameters to the current query. If $passthrough is set, then it will pass all parameters that were passed to the current query on to the redirect target. If the request_method was GET, then all parameters can be passed in the URL. If the request_method was POST then it caches the form data and passes over a cache reference in the redirect GET. | ||||||||||||
Changed: | |||||||||||||
< < | Redirects the request to $url, via the CGI module object $query unless
overridden by a plugin declaring a redirectCgiQueryHandler . | ||||||||||||
> > | Passthrough is only meaningful if the redirect target is on the same server. | ||||||||||||
Added: | |||||||||||||
> > | ObjectMethod cacheQuery () -> $queryStringCaches the current query in the params cache, and returns a rewritten query string for the cache to be picked up again on the other side of a redirect. We can't encode post params into a redirect, because they may exceed the size of the GET request. So we cache the params, and reload them when the redirect target is reached. | ||||||||||||
StaticMethod *isValidWikiWord ($name) -> $booleanCheck for a valid WikiWord or WikiName | |||||||||||||
Line: 111 to 134 | |||||||||||||
Returns the URL to a TWiki script, providing the web and topic as "path info" parameters. The result looks something like this: "http://host/twiki/bin/$script/$web/$topic". | |||||||||||||
Changed: | |||||||||||||
< < |
| ||||||||||||
> > |
| ||||||||||||
If $absolute is set, generates an absolute URL. $absolute is advisory only; TWiki can decide to generate absolute URLs (for example when run from the | |||||||||||||
Line: 170 to 193 | |||||||||||||
The returned URL ends up looking something like this: "http://host/twiki/bin/oops/$web/$topic?template=$template¶m1=$scriptParams[0]..." | |||||||||||||
Added: | |||||||||||||
> > | Note: if {keep} is true in the params, then they will also be pushed into the current query. | ||||||||||||
ObjectMethod *normalizeWebTopicName ($theWeb,$theTopic) -> ($theWeb,$theTopic)Normalize a Web.TopicName | |||||||||||||
Deleted: | |||||||||||||
< < | 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', 'Web2.Topic' ) ( 'Main', 'Topic' ) ( 'TWiki', 'Web2.Topic' ) ( 'TWiki', 'Topic' )Note: Function renamed from getWebTopic | ||||||||||||
Changed: | |||||||||||||
< < | SMELL: WARNING: this function defaults the web and topic names. Be very careful where you use it! | ||||||||||||
> > | See TWikiFuncDotPm for a full specification of the expansion (not duplicated here) | ||||||||||||
Added: | |||||||||||||
> > | WARNING if there is no web specification (in the web or topic parameters) the web defaults to $TWiki::cfg{UsersWebName}. If there is no topic specification, or the topic is '0', the topic defaults to the web home topic name. | ||||||||||||
Changed: | |||||||||||||
< < | ClassMethod new ($remoteUser,$query) | ||||||||||||
> > |
ClassMethod new ($loginName,$query,\%initialContext) | ||||||||||||
Constructs a new TWiki object. Parameters are taken from the query object. | |||||||||||||
Changed: | |||||||||||||
< < |
| ||||||||||||
> > |
| ||||||||||||
Line: 247 to 271 | |||||||||||||
Added: | |||||||||||||
> > | StaticMethod parseSections ($text) -> ($string,$sectionlistref)Generic parser for sections within a topic. Sections are delimited by STARTSECTION and ENDSECTION, which may be nested, overlapped or otherwise abused. The parser builds an array of sections, which is ordered by the order of the STARTSECTION within the topic. It also removes all the SECTION tags from the text, and returns the text and the array of sections. Each section is aTWiki::Attrs object, which contains the attributes
{type, name, start, end}
where start and end are character offsets in the
string after all section tags have been removed. All sections
are required to be uniquely named; if a section is unnamed, it
will be given a generated name. Sections may overlap or nest.
See test/unit/Fn_SECTION.pm for detailed testcases that
round out the spec.
| ||||||||||||
ObjectMethod *expandVariablesOnTopicCreation ($text,$user) -> $text
| |||||||||||||
Line: 384 to 430 | |||||||||||||
Changed: | |||||||||||||
< < | registerRESTHandler( $subject, $verb, \&fn ) | ||||||||||||
> > | StaticMethod *registerRESTHandler ($subject,$verb,\&fn) | ||||||||||||
Adds a function to the dispatch table of the REST interface for a given subject. See TWikiScripts#rest for more info. | |||||||||||||
Line: 403 to 450 | |||||||||||||
Since: TWiki::Plugins::VERSION 1.1 | |||||||||||||
Changed: | |||||||||||||
< < | restDispatch( $subject, $verb) => \&fn | ||||||||||||
> > |
StaticMethod restDispatch ($subject,$verb)=>\&fn | ||||||||||||
Returns the handler function associated to the given $subject and $werb, or undef if none is found. | |||||||||||||
Line: 451 to 505 | |||||||||||||
WARNING: Never, ever use this for accessing topics or attachments! Use the Store API for that. This is for global control files only, and should be used only if there is absolutely no alternative. | |||||||||||||
Added: | |||||||||||||
> > |
StaticMethod *expandStandardEscapes ($str) -> $unescapedStrExpands standard escapes used in parameter values to block evaluation. The following escapes are handled:
| ||||||||||||
Line: 203 to 203 | ||||||||
---|---|---|---|---|---|---|---|---|
ObjectMethod *finishComplete processing after the client's HTTP request has been responded | ||||||||
Changed: | ||||||||
< < | to. Right now this only entails one activity: calling TWiki::Client to flushing the user's session (if any) to disk. | |||||||
> > | to. Right now this does two things:
| |||||||
Line: 1 to 1 | ||||||||
---|---|---|---|---|---|---|---|---|
Added: | ||||||||
> > | Package =TWikiTWiki operates by creating a singleton object (known as the Session object) that acts as a point of reference for all the different modules in the system. This package is the class for this singleton, and also contains the vast bulk of the basic constants and the per- site configuration mechanisms. Global variables are avoided wherever possible to avoid problems with CGI accelerators such as mod_perl.On this page:
StaticMethod getTWikiLibDir () -> $pathSTATIC method. Returns the full path of the directory containing TWiki.pmObjectMethod *UTF82SiteCharSet ($utf8) -> $asciiAuto-detect UTF-8 vs. site charset in string, and convert UTF-8 into site charset.ObjectMethod *writeCompletePage ($text,$pageType,$contentType)Write a complete HTML page with basic header to the browser. $text is the HTML of the page body (<html> to </html>) This method removes noautolink and nop tags before outputting the page.ObjectMethod *writePageHeader ($query,$pageType,$contentType,$contentLength)All parameters are optional.
ObjectMethod redirect ($url,...)Generate a CGI redirect to $url unless (1) $session->{cgiQuery} is undef or (2) $query->param('noredirect') is set to a true value. Thus a redirect is only generated when in a CGI context. The ... parameters are concatenated to the message written when printing to STDOUT, and are ignored for a redirect. Redirects the request to $url, via the CGI module object $query unless overridden by a plugin declaring aredirectCgiQueryHandler .
StaticMethod *isValidWikiWord ($name) -> $booleanCheck for a valid WikiWord or WikiNameStaticMethod *isValidTopicName ($name) -> $booleanCheck for a valid topic nameStaticMethod isValidAbbrev ($name) -> $booleanCheck for a valid ABBREV (acronym)StaticMethod isValidWebName ($name,$system) -> $booleanSTATIC Check for a valid web name. If $system is true, then system web names are considered valid (names starting with _) otherwise only user web names are validObjectMethod *readOnlyMirrorWeb ($theWeb) -> ($mirrorSiteName,$mirrorViewURL,$mirrorLink,$mirrorNote)If this is a mirrored web, return information about the mirror. The info is returned in a quadruple:
ObjectMethod getSkin () -> $stringGet the currently requested skin pathObjectMethod getScriptUrl ($absolute,$script,$web,$topic,...) -> $scriptURLReturns the URL to a TWiki script, providing the web and topic as "path info" parameters. The result looks something like this: "http://host/twiki/bin/$script/$web/$topic".
ObjectMethod getPubUrl ($absolute,$web,$topic,$attachment) -> $urlComposes a pub url. If $absolute is set, returns an absolute URL. If $absolute is set, generates an absolute URL. $absolute is advisory only; TWiki can decide to generate absolute URLs (for example when run from the command-line) even when relative URLs have been requested. $web, $topic and $attachment are optional. A partial URL path will be generated if one or all is not given.ObjectMethod getIconUrl ($absolute,$iconName) -> $iconURLMap an icon name to a URL path.ObjectMethod *mapToIconFileName ($fileName,$default) -> $fileNameMaps from a filename (or just the extension) to the name of the file that contains the image for that file type.ObjectMethod getOopsUrl ($template,@options) -> $absoluteOopsURLComposes a URL for an "oops" error page. The @options consists of a list of key => value pairs. The following keys are used:
ObjectMethod *normalizeWebTopicName ($theWeb,$theTopic) -> ($theWeb,$theTopic)Normalize a Web.TopicNameInput: Return: ( 'Web', 'Topic' ) ( 'Web', 'Topic' ) ( '', 'Topic' ) ( 'Main', 'Topic' ) ( '', '' ) ( 'Main', 'WebHome' ) ( '', 'Web/Topic' ) ( 'Web', 'Topic' ) ( '', 'Web.Topic' ) ( 'Web', 'Topic' ) ( 'Web1', 'Web2.Topic' ) ( 'Web2', 'Topic' ) ( 'Main', 'Web2.Topic' ) ( 'Main', 'Topic' ) ( 'TWiki', 'Web2.Topic' ) ( 'TWiki', 'Topic' )Note: Function renamed from getWebTopic SMELL: WARNING: this function defaults the web and topic names. Be very careful where you use it! ClassMethod new ($remoteUser,$query)Constructs a new TWiki object. Parameters are taken from the query object.
ObjectMethod *finishComplete processing after the client's HTTP request has been responded to. Right now this only entails one activity: calling TWiki::Client to flushing the user's session (if any) to disk.ObjectMethod writeLog ($action,$webTopic,$extra,$user)
ObjectMethod writeWarning ($text)Prints date, time, and contents $text to $TWiki::cfg{WarningFileName}, typically 'warnings.txt'. Use for warnings and errors that may require admin intervention. Use this for defensive programming warnings (e.g. assertions).ObjectMethod writeDebug ($text)Prints date, time, and contents of $text to $TWiki::cfg{DebugFileName}, typically 'debug.txt'. Use for debugging messages.StaticMethod *applyPatternToIncludedText ($text,$pattern) -> $textApply a pattern on included text to extract a subsetObjectMethod inlineAlert ($template,$def,...) -> $stringFormat an error for inline inclusion in rendered output. The message string is obtained from the template 'oops'.$template, and the DEF $def is selected. The parameters (...) are used to populate %PARAM1%..%PARAMn%ObjectMethod *expandVariablesOnTopicCreation ($text,$user) -> $text
StaticMethod entityEncode ($text,$extras) -> $encodedTextEscape 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, <. Similarly, ">" is escaped as >, and "&" is escaped as &. If an attribute value contains a double quotation mark and is delimited by double quotation marks, then the quote should be escaped as ". 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.StaticMethod entityDecode ($encodedText) -> $textDecodes all numeric entities (e.g. {). Does not decode named entities such as & (use HTML::Entities for that)StaticMethod urlEncode ($string) -> encodedstringEncode 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. SMELL: For non-ISO-8859-1 $TWiki::cfg{Site}{CharSet}, need to convert to UTF-8 before URL encoding. This encoding only supports 8-bit character codes. StaticMethod urlDecode ($string) -> decodedstringReverses the encoding done in urlEncode.StaticMethod isTrue ($value,$default) -> $booleanReturns 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.
StaticMethod *spaceOutWikiWord ($word,$sep) -> $stringSpaces 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.ObjectMethod enterContext ($id,$val)Add the context id $id into the set of active contexts. The $val can be anything you like, but should always evaluate to boolean TRUE. An example of the use of contexts is in the use of tag expansion. The commonTagsHandler in plugins is called every time tags need to be expanded, and the context of that expansion is signalled by the expanding module using a context id. So the forms module adds the context id "form" before invoking common tags expansion. Contexts are not just useful for tag expansion; they are also relevant when rendering. Contexts are intended for use mainly by plugins. Core modules can use $session->inContext( $id ) to determine if a context is active.ObjectMethod leaveContext ($id)Remove the context id $id from the set of active contexts. (seeenterContext for more information on contexts)
ObjectMethod inContext ($id)Return the value for the given context id (seeenterContext for more information on contexts)
StaticMethod *registerTagHandler ($tag,$fnref)STATIC Add a tag handler to the function tag handlers.
registerRESTHandler( $subject, $verb, \&fn )Adds a function to the dispatch table of the REST interface for a given subject. See TWikiScripts#rest for more info.
sub handler(\%session,$subject,$verb) -> $textwhere:
restDispatch( $subject, $verb) => \&fnReturns the handler function associated to the given $subject and $werb, or undef if none is found. Since: TWiki::Plugins::VERSION 1.1ObjectMethod *handleCommonTags ($text,$web,$topic) -> $textProcesses %VARIABLE%, and %TOC% syntax; also includes 'commonTagsHandler' plugin hook. Returns the text of the topic, after file inclusion, variable substitution, table-of-contents generation, and any plugin changes from commonTagsHandler.ObjectMethod addToHEAD ($id,$html)Add$html to the HEAD tag of the page currently being generated.
Note that TWiki variables may be used in the HEAD. They will be expanded
according to normal variable expansion rules.
The 'id' is used to ensure that multiple adds of the same block of HTML don't
result in it being added many times.
StaticMethod initialize ($pathInfo,$remoteUser,$topic,$url,$query) -> ($topicName,$webName,$scriptUrlPath,$userName,$dataDir)Return value: ( $topicName, $webName, $TWiki::cfg{ScriptUrlPath}, $userName, $TWiki::cfg{DataDir} ) Static method to construct a new singleton session instance. It creates a new TWiki and sets the Plugins $SESSION variable to point to it, so that TWiki::Func methods will work. This method is DEPRECATED but is maintained for script compatibility. Note that $theUrl, if specified, must be identical to $query->url()StaticMethod readFile ($filename) -> $textReturns the entire contents of the given file, which can be specified in any format acceptable to the Perl open() function. Fast, but inherently unsafe. WARNING: Never, ever use this for accessing topics or attachments! Use the Store API for that. This is for global control files only, and should be used only if there is absolutely no alternative. |