Difference: TWikiDotPm (3 vs. 4)

Public Data members

• cgiQuery Pointer to the CGI::
• context Hash of context ids
• moved: loginManager TWiki::LoginManager singleton (moved to TWiki::Users)
• plugins TWiki::Plugins singleton
• prefs TWiki::Prefs singleton
• remoteUser Login ID when using ApacheLogin? . Maintained for compatibility only, do not use.
• requestedWebName Name of web found in URL path or web URL parameter
• sandbox TWiki::Sandbox singleton
• scriptUrlPath URL path to the current script. May be dynamically extracted from the URL path if {GetScriptUrlFromCgi}. Only required to support {GetScriptUrlFromCgi} and not consistently used. Avoid.
• security TWiki::Access singleton
• SESSION_TAGS Hash of TWiki variables whose value is specific to the current CGI request.
• store TWiki::Store singleton
• topicName Name of topic found in URL path or topic URL parameter
• urlHost Host part of the URL (including the protocol) determined during intialisation and defaulting to {DefaultUrlHost}
• user Unique user ID of logged-in user
• users TWiki::Users singleton
• webName Name of web found in URL path, or web URL parameter, or {UsersWebName}

StaticMethod UTF82SiteCharSet ($utf8) -> $ascii

ObjectMethod generateHTTPHeaders ($query,$pageType,$contentType,$contentLength) -> $header

StaticMethod isRedirectSafe ($redirect)=>$ok

ObjectMethod redirect ($url,$passthrough,$action_redirectto)

• $url - url or twikitopic to redirect to
• $passthrough - (optional) parameter to *FILLMEIN*
• $action_redirectto - (optional) redirect to where ?redirectto= points to (if it's valid)

ObjectMethod normalizeWebTopicName ($theWeb,$theTopic) -> ($theWeb,$theTopic)

Normalize a Web.TopicName

ClassMethod new ($loginName,$query,\%initialContext)

• $loginName is the login username (not the wikiname) of the user you want to be logged-in if none is available from a session or browser. Used mainly for side scripts and debugging.
• $query the CGI query (may be undef, in which case an empty query is used)
• \%initialContext - reference to a hash containing context name=value pairs to be pre-installed in the context hash

ObjectMethod renderer ()

ObjectMethod attach ()

ObjectMethod templates ()

ObjectMethod i18n ()

ObjectMethod search ()

ObjectMethod security ()

ObjectMethod net ()

ObjectMethod finish ()

• $user - user who did the saving (user id)

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

• $user - This is the user expanded in e.g. %USERNAME. Optional, defaults to logged-in user.

• $web - name of web
• $topic - name of topic

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.

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.

ObjectMethod expandAllTags (\$text,$topic,$web,$meta)

1. Tags are expanded left to right, in the order they are encountered.
2. Tags are recursively expanded as soon as they are encountered - the algorithm is inherently single-pass
3. A tag is not "encountered" until the matching }% has been seen, by which time all tags in parameters will have been expanded
4. Tag expansions that create new tags recursively are limited to a set number of hierarchical levels of expansion

ObjectMethod handleCommonTags ($text,$web,$topic,$meta) -> $text