<?php
-// require_once('Tokenizer.php');
-
/**
- * PHP Parser
- *
- * Processes wiki markup
- *
- * There are two main entry points into the Parser class:
- * parse()
- * produces HTML output
- * preSaveTransform().
- * produces altered wiki markup.
- *
- * Globals used:
- * objects: $wgLang, $wgDateFormatter, $wgLinkCache, $wgCurParser
- *
- * NOT $wgArticle, $wgUser or $wgTitle. Keep them away!
- *
- * settings:
- * $wgUseTex*, $wgUseDynamicDates*, $wgInterwikiMagic*,
- * $wgNamespacesWithSubpages, $wgLanguageCode, $wgAllowExternalImages*,
- * $wgLocaltimezone
- *
- * * only within ParserOptions
+ * File for Parser and related classes
*
* @package MediaWiki
+ * @version $Id$
*/
/**
* Variable substitution O(N^2) attack
*
-* Without countermeasures, it would be possible to attack the parser by saving
-* a page filled with a large number of inclusions of large pages. The size of
-* the generated page would be proportional to the square of the input size.
-* Hence, we limit the number of inclusions of any given page, thus bringing any
-* attack back to O(N).
-*/
+ * Without countermeasures, it would be possible to attack the parser by saving
+ * a page filled with a large number of inclusions of large pages. The size of
+ * the generated page would be proportional to the square of the input size.
+ * Hence, we limit the number of inclusions of any given page, thus bringing any
+ * attack back to O(N).
+ */
define( 'MAX_INCLUDE_REPEAT', 100 );
define( 'MAX_INCLUDE_SIZE', 1000000 ); // 1 Million
);
/**
- * @todo document
+ * PHP Parser
+ *
+ * Processes wiki markup
+ *
+ * <pre>
+ * There are three main entry points into the Parser class:
+ * parse()
+ * produces HTML output
+ * preSaveTransform().
+ * produces altered wiki markup.
+ * transformMsg()
+ * performs brace substitution on MediaWiki messages
+ *
+ * Globals used:
+ * objects: $wgLang, $wgDateFormatter, $wgLinkCache, $wgCurParser
+ *
+ * NOT $wgArticle, $wgUser or $wgTitle. Keep them away!
+ *
+ * settings:
+ * $wgUseTex*, $wgUseDynamicDates*, $wgInterwikiMagic*,
+ * $wgNamespacesWithSubpages, $wgAllowExternalImages*,
+ * $wgLocaltimezone
+ *
+ * * only within ParserOptions
+ * </pre>
+ *
* @package MediaWiki
*/
class Parser
{
+ /**#@+
+ * @access private
+ */
# Persistent:
var $mTagHooks;
$mTemplatePath; // stores an unsorted hash of all the templates already loaded
// in this path. Used for loop detection.
+ /**#@-*/
+
+ /**
+ * Constructor
+ *
+ * @access public
+ */
function Parser() {
$this->mTemplates = array();
$this->mTemplatePath = array();
$this->clearState();
}
+ /**
+ * Clear Parser state
+ *
+ * @access private
+ */
function clearState() {
$this->mOutput = new ParserOutput;
$this->mAutonumber = 0;
$this->mInPre = false;
}
- # First pass--just handle <nowiki> sections, pass the rest off
- # to internalParse() which does all the real work.
- #
- # Returns a ParserOutput
- #
+ /**
+ * First pass--just handle <nowiki> sections, pass the rest off
+ * to internalParse() which does all the real work.
+ *
+ * @access private
+ * @return ParserOutput a ParserOutput
+ */
function parse( $text, &$title, $options, $linestart = true, $clearState = true ) {
global $wgUseTidy;
$fname = 'Parser::parse';
# only once and last
$text = $this->doBlockLevels( $text, $linestart );
$text = $this->unstripNoWiki( $text, $this->mStripState );
- if($wgUseTidy) {
- $text = $this->tidy($text);
- }
$this->mOutput->setText( $text );
wfProfileOut( $fname );
return $this->mOutput;
}
- /* static */ function getRandomString() {
+ /**
+ * Get a random string
+ *
+ * @access private
+ * @static
+ */
+ function getRandomString() {
return dechex(mt_rand(0, 0x7fffffff)) . dechex(mt_rand(0, 0x7fffffff));
}
- # Replaces all occurrences of <$tag>content</$tag> in the text
- # with a random marker and returns the new text. the output parameter
- # $content will be an associative array filled with data on the form
- # $unique_marker => content.
-
- # If $content is already set, the additional entries will be appended
-
- # If $tag is set to STRIP_COMMENTS, the function will extract
- # <!-- HTML comments -->
-
- /* static */ function extractTags($tag, $text, &$content, $uniq_prefix = ''){
+ /**
+ * Replaces all occurrences of <$tag>content</$tag> in the text
+ * with a random marker and returns the new text. the output parameter
+ * $content will be an associative array filled with data on the form
+ * $unique_marker => content.
+ *
+ * If $content is already set, the additional entries will be appended
+ * If $tag is set to STRIP_COMMENTS, the function will extract
+ * <!-- HTML comments -->
+ *
+ * @access private
+ * @static
+ */
+ function extractTags($tag, $text, &$content, $uniq_prefix = ''){
$rnd = $uniq_prefix . '-' . $tag . Parser::getRandomString();
if ( !$content ) {
$content = array( );
return $stripped;
}
- # Strips and renders <nowiki>, <pre>, <math>, <hiero>
- # If $render is set, performs necessary rendering operations on plugins
- # Returns the text, and fills an array with data needed in unstrip()
- # If the $state is already a valid strip state, it adds to the state
-
- # When $stripcomments is set, HTML comments <!-- like this -->
- # will be stripped in addition to other tags. This is important
- # for section editing, where these comments cause confusion when
- # counting the sections in the wikisource
+ /**
+ * Strips and renders nowiki, pre, math, hiero
+ * If $render is set, performs necessary rendering operations on plugins
+ * Returns the text, and fills an array with data needed in unstrip()
+ * If the $state is already a valid strip state, it adds to the state
+ *
+ * @param bool $stripcomments when set, HTML comments <!-- like this -->
+ * will be stripped in addition to other tags. This is important
+ * for section editing, where these comments cause confusion when
+ * counting the sections in the wikisource
+ *
+ * @access private
+ */
function strip( $text, &$state, $stripcomments = false ) {
$render = ($this->mOutputType == OT_HTML);
$html_content = array();
#$text = str_replace( $uniq_prefix, wfHtmlEscapeFirst( $uniq_prefix ), $text );
# html
- global $wgRawHtml;
- if( $wgRawHtml ) {
+ global $wgRawHtml, $wgWhitelistEdit;
+ if( $wgRawHtml && $wgWhitelistEdit ) {
$text = Parser::extractTags('html', $text, $html_content, $uniq_prefix);
foreach( $html_content as $marker => $content ) {
if ($render ) {
return $text;
}
- # always call unstripNoWiki() after this one
+ /**
+ * restores pre, math, and heiro removed by strip()
+ *
+ * always call unstripNoWiki() after this one
+ * @access private
+ */
function unstrip( $text, &$state ) {
# Must expand in reverse order, otherwise nested tags will be corrupted
$contentDict = end( $state );
return $text;
}
- # always call this after unstrip() to preserve the order
+
+ /**
+ * always call this after unstrip() to preserve the order
+ *
+ * @access private
+ */
function unstripNoWiki( $text, &$state ) {
# Must expand in reverse order, otherwise nested tags will be corrupted
for ( $content = end($state['nowiki']); $content !== false; $content = prev( $state['nowiki'] ) ) {
return $text;
}
- # Add an item to the strip state
- # Returns the unique tag which must be inserted into the stripped text
- # The tag will be replaced with the original text in unstrip()
+ /**
+ * Add an item to the strip state
+ * Returns the unique tag which must be inserted into the stripped text
+ * The tag will be replaced with the original text in unstrip()
+ *
+ * @access private
+ */
function insertStripItem( $text, &$state ) {
$rnd = UNIQ_PREFIX . '-item' . Parser::getRandomString();
if ( !$state ) {
return $rnd;
}
- # Return allowed HTML attributes
+ /**
+ * Return allowed HTML attributes
+ *
+ * @access private
+ */
function getHTMLattrs () {
$htmlattrs = array( # Allowed attributes--no scripting, etc.
'title', 'align', 'lang', 'dir', 'width', 'height',
return $htmlattrs ;
}
- # Remove non approved attributes and javascript in css
+ /**
+ * Remove non approved attributes and javascript in css
+ *
+ * @access private
+ */
function fixTagAttributes ( $t ) {
if ( trim ( $t ) == '' ) return '' ; # Saves runtime ;-)
$htmlattrs = $this->getHTMLattrs() ;
return trim ( $t ) ;
}
- # interface with html tidy, used if $wgUseTidy = true
+ /**
+ * interface with html tidy, used if $wgUseTidy = true
+ *
+ * @access public
+ * @static
+ */
function tidy ( $text ) {
global $wgTidyConf, $wgTidyBin, $wgTidyOpts;
global $wgInputEncoding, $wgOutputEncoding;
wfProfileIn( $fname );
$cleansource = '';
+ $opts = '';
switch(strtoupper($wgOutputEncoding)) {
case 'ISO-8859-1':
- $wgTidyOpts .= ($wgInputEncoding == $wgOutputEncoding)? ' -latin1':' -raw';
+ $opts .= ($wgInputEncoding == $wgOutputEncoding)? ' -latin1':' -raw';
break;
case 'UTF-8':
- $wgTidyOpts .= ($wgInputEncoding == $wgOutputEncoding)? ' -utf8':' -raw';
+ $opts .= ($wgInputEncoding == $wgOutputEncoding)? ' -utf8':' -raw';
break;
default:
- $wgTidyOpts .= ' -raw';
+ $opts .= ' -raw';
}
$wrappedtext = '<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"'.
1 => array('pipe', 'w'),
2 => array('file', '/dev/null', 'a')
);
- $process = proc_open("$wgTidyBin -config $wgTidyConf $wgTidyOpts", $descriptorspec, $pipes);
+ $process = proc_open("$wgTidyBin -config $wgTidyConf $wgTidyOpts$opts", $descriptorspec, $pipes);
if (is_resource($process)) {
fwrite($pipes[0], $wrappedtext);
fclose($pipes[0]);
}
}
- # parse the wiki syntax used to render tables
+ /**
+ * parse the wiki syntax used to render tables
+ *
+ * @access private
+ */
function doTableStuff ( $t ) {
$fname = 'Parser::doTableStuff';
wfProfileIn( $fname );
return $t ;
}
- # Parses the text and adds the result to the strip state
- # Returns the strip tag
- function stripParse( $text, $newline, $args ) {
- $text = $this->strip( $text, $this->mStripState );
- $text = $this->internalParse( $text, (bool)$newline, $args, false );
- return $newline.$this->insertStripItem( $text, $this->mStripState );
- }
-
+ /**
+ * Helper function for parse() that transforms wiki markup into
+ * HTML. Only called for $mOutputType == OT_HTML.
+ *
+ * @access private
+ */
function internalParse( $text, $linestart, $args = array(), $isMain=true ) {
+ global $wgContLang;
+
$fname = 'Parser::internalParse';
wfProfileIn( $fname );
$text = $this->removeHTMLtags( $text );
$text = $this->replaceVariables( $text, $args );
+ $text = $wgContLang->convert($text);
+
$text = preg_replace( '/(^|\n)-----*/', '\\1<hr />', $text );
$text = $this->doHeadings( $text );
$text = $wgDateFormatter->reformat( $this->mOptions->getDateFormat(), $text );
}
$text = $this->doAllQuotes( $text );
- $text = $this->replaceExternalLinks( $text );
- $text = $this->doMagicLinks( $text );
$text = $this->replaceInternalLinks ( $text );
+ # Another call to replace links and images inside captions of images
$text = $this->replaceInternalLinks ( $text );
-
- $text = $this->unstrip( $text, $this->mStripState );
- $text = $this->unstripNoWiki( $text, $this->mStripState );
-
+ $text = $this->replaceExternalLinks( $text );
+ $text = $this->doMagicLinks( $text );
$text = $this->doTableStuff( $text );
$text = $this->formatHeadings( $text, $isMain );
$sk =& $this->mOptions->getSkin();
return $text;
}
- /* private */ function &doMagicLinks( &$text ) {
+ /**
+ * Replace special strings like "ISBN xxx" and "RFC xxx" with
+ * magic external links.
+ *
+ * @access private
+ */
+ function &doMagicLinks( &$text ) {
global $wgUseGeoMode;
$text = $this->magicISBN( $text );
if ( isset( $wgUseGeoMode ) && $wgUseGeoMode ) {
return $text;
}
- # Parse ^^ tokens and return html
- /* private */ function doExponent ( $text ) {
+ /**
+ * Parse ^^ tokens and return html
+ *
+ * @access private
+ */
+ function doExponent ( $text ) {
$fname = 'Parser::doExponent';
wfProfileIn( $fname);
$text = preg_replace('/\^\^(.*)\^\^/','<small><sup>\\1</sup></small>', $text);
return $text;
}
- # Parse headers and return html
- /* private */ function doHeadings( $text ) {
+ /**
+ * Parse headers and return html
+ *
+ * @access private
+ */
+ function doHeadings( $text ) {
$fname = 'Parser::doHeadings';
wfProfileIn( $fname );
for ( $i = 6; $i >= 1; --$i ) {
return $text;
}
- /* private */ function doAllQuotes( $text ) {
+ /**
+ * Replace single quotes with HTML markup
+ * @access private
+ * @return string the altered text
+ */
+ function doAllQuotes( $text ) {
$fname = 'Parser::doAllQuotes';
wfProfileIn( $fname );
$outtext = '';
return $outtext;
}
- /* private */ function doQuotes( $text ) {
+ /**
+ * Helper function for doAllQuotes()
+ * @access private
+ */
+ function doQuotes( $text ) {
$arr = preg_split ("/(''+)/", $text, -1, PREG_SPLIT_DELIM_CAPTURE);
if (count ($arr) == 1)
return $text;
{
if (strlen ($r) == 2)
{
- if ($state == 'em')
- { $output .= '</em>'; $state = ''; }
- else if ($state == 'strongem')
- { $output .= '</em>'; $state = 'strong'; }
- else if ($state == 'emstrong')
- { $output .= '</strong></em><strong>'; $state = 'strong'; }
+ if ($state == 'i')
+ { $output .= '</i>'; $state = ''; }
+ else if ($state == 'bi')
+ { $output .= '</i>'; $state = 'b'; }
+ else if ($state == 'ib')
+ { $output .= '</b></i><b>'; $state = 'b'; }
else if ($state == 'both')
- { $output .= '<strong><em>'.$buffer.'</em>'; $state = 'strong'; }
- else # $state can be 'strong' or ''
- { $output .= '<em>'; $state .= 'em'; }
+ { $output .= '<b><i>'.$buffer.'</i>'; $state = 'b'; }
+ else # $state can be 'b' or ''
+ { $output .= '<i>'; $state .= 'i'; }
}
else if (strlen ($r) == 3)
{
- if ($state == 'strong')
- { $output .= '</strong>'; $state = ''; }
- else if ($state == 'strongem')
- { $output .= '</em></strong><em>'; $state = 'em'; }
- else if ($state == 'emstrong')
- { $output .= '</strong>'; $state = 'em'; }
+ if ($state == 'b')
+ { $output .= '</b>'; $state = ''; }
+ else if ($state == 'bi')
+ { $output .= '</i></b><i>'; $state = 'i'; }
+ else if ($state == 'ib')
+ { $output .= '</b>'; $state = 'i'; }
else if ($state == 'both')
- { $output .= '<em><strong>'.$buffer.'</strong>'; $state = 'em'; }
- else # $state can be 'em' or ''
- { $output .= '<strong>'; $state .= 'strong'; }
+ { $output .= '<i><b>'.$buffer.'</b>'; $state = 'i'; }
+ else # $state can be 'i' or ''
+ { $output .= '<b>'; $state .= 'b'; }
}
else if (strlen ($r) == 5)
{
- if ($state == 'strong')
- { $output .= '</strong><em>'; $state = 'em'; }
- else if ($state == 'em')
- { $output .= '</em><strong>'; $state = 'strong'; }
- else if ($state == 'strongem')
- { $output .= '</em></strong>'; $state = ''; }
- else if ($state == 'emstrong')
- { $output .= '</strong></em>'; $state = ''; }
+ if ($state == 'b')
+ { $output .= '</b><i>'; $state = 'i'; }
+ else if ($state == 'i')
+ { $output .= '</i><b>'; $state = 'b'; }
+ else if ($state == 'bi')
+ { $output .= '</i></b>'; $state = ''; }
+ else if ($state == 'ib')
+ { $output .= '</b></i>'; $state = ''; }
else if ($state == 'both')
- { $output .= '<em><strong>'.$buffer.'</strong></em>'; $state = ''; }
+ { $output .= '<i><b>'.$buffer.'</b></i>'; $state = ''; }
else # ($state == '')
{ $buffer = ''; $state = 'both'; }
}
$i++;
}
# Now close all remaining tags. Notice that the order is important.
- if ($state == 'strong' || $state == 'emstrong')
- $output .= '</strong>';
- if ($state == 'em' || $state == 'strongem' || $state == 'emstrong')
- $output .= '</em>';
- if ($state == 'strongem')
- $output .= '</strong>';
+ if ($state == 'b' || $state == 'ib')
+ $output .= '</b>';
+ if ($state == 'i' || $state == 'bi' || $state == 'ib')
+ $output .= '</i>';
+ if ($state == 'bi')
+ $output .= '</b>';
if ($state == 'both')
- $output .= '<strong><em>'.$buffer.'</em></strong>';
+ $output .= '<b><i>'.$buffer.'</i></b>';
return $output;
}
}
- # Note: we have to do external links before the internal ones,
- # and otherwise take great care in the order of things here, so
- # that we don't end up interpreting some URLs twice.
-
- /* private */ function replaceExternalLinks( $text ) {
+ /**
+ * Replace external links
+ *
+ * Note: we have to do external links before the internal ones,
+ * and otherwise take great care in the order of things here, so
+ * that we don't end up interpreting some URLs twice.
+ *
+ * @access private
+ */
+ function replaceExternalLinks( $text ) {
$fname = 'Parser::replaceExternalLinks';
wfProfileIn( $fname );
$sk =& $this->mOptions->getSkin();
- $linktrail = wfMsg('linktrail');
+ $linktrail = wfMsgForContent('linktrail');
$bits = preg_split( EXT_LINK_BRACKETED, $text, -1, PREG_SPLIT_DELIM_CAPTURE );
$s = $this->replaceFreeExternalLinks( array_shift( $bits ) );
# This means that users can paste URLs directly into the text
# Funny characters like ö aren't valid in URLs anyway
# This was changed in August 2004
- $s .= "<a href=\"{$url}\" {$la}>{$text}</a>{$dtrail}{$paren}{$trail}";
+ $s .= "<a href=\"{$url}\"{$la}>{$text}</a>{$dtrail}{$paren}{$trail}";
}
wfProfileOut( $fname );
return $s;
}
- # Replace anything that looks like a URL with a link
+ /**
+ * Replace anything that looks like a URL with a link
+ * @access private
+ */
function replaceFreeExternalLinks( $text ) {
$bits = preg_split( '/((?:'.URL_PROTOCOLS.'):)/', $text, -1, PREG_SPLIT_DELIM_CAPTURE );
$s = array_shift( $bits );
return $s;
}
- # make an image if it's allowed
+ /**
+ * make an image if it's allowed
+ * @access private
+ */
function maybeMakeImageLink( $url ) {
$sk =& $this->mOptions->getSkin();
$text = false;
return $text;
}
- # The wikilinks [[ ]] are procedeed here.
- /* private */ function replaceInternalLinks( $s ) {
- global $wgLang, $wgLinkCache;
- global $wgNamespacesWithSubpages, $wgLanguageCode;
+ /**
+ * Process [[ ]] wikilinks
+ *
+ * @access private
+ */
+ function replaceInternalLinks( $s ) {
+ global $wgLang, $wgContLang, $wgLinkCache;
static $fname = 'Parser::replaceInternalLinks' ;
wfProfileIn( $fname );
# e.g. in the case of 'The Arab al[[Razi]]', 'al' will be matched
static $e2 = '/^(.*?)([a-zA-Z\x80-\xff]+)$/sD';
- $useLinkPrefixExtension = $wgLang->linkPrefixExtension();
+ $useLinkPrefixExtension = $wgContLang->linkPrefixExtension();
# Special and Media are pseudo-namespaces; no pages actually exist in them
$nottalk = !Namespace::isTalk( $this->mTitle->getNamespace() );
continue;
}
- # Valid link forms:
- # Foobar -- normal
- # :Foobar -- override special treatment of prefix (images, language links)
- # /Foobar -- convert to CurrentPage/Foobar
- # /Foobar/ -- convert to CurrentPage/Foobar, strip the initial / from text
-
- # Look at the first character
- $c = substr($m[1],0,1);
- $noforce = ($c != ':');
-
- # subpage
- if( $c == '/' ) {
- # / at end means we don't want the slash to be shown
- if(substr($m[1],-1,1)=='/') {
- $m[1]=substr($m[1],1,strlen($m[1])-2);
- $noslash=$m[1];
- } else {
- $noslash=substr($m[1],1);
- }
-
- # Some namespaces don't allow subpages
- if(!empty($wgNamespacesWithSubpages[$this->mTitle->getNamespace()])) {
- # subpages allowed here
- $link = $this->mTitle->getPrefixedText(). '/' . trim($noslash);
- if( '' == $text ) {
- $text= $m[1];
- } # this might be changed for ugliness reasons
- } else {
- # no subpage allowed, use standard link
- $link = $noslash;
- }
-
- } elseif( $noforce ) { # no subpage
- $link = $m[1];
- } else {
- # We don't want to keep the first character
- $link = substr( $m[1], 1 );
+ # Don't allow internal links to pages containing
+ # PROTO: where PROTO is a valid URL protocol; these
+ # should be external links.
+ if (preg_match('/((?:'.URL_PROTOCOLS.'):)/', $m[1])) {
+ $s .= $prefix . '[[' . $line ;
+ continue;
+ }
+
+ # Make subpage if necessary
+ $link = $this->maybeDoSubpageLink( $m[1], $text );
+
+ $noforce = (substr($m[1], 0, 1) != ':');
+ if (!$noforce) {
+ # Strip off leading ':'
+ $link = substr($link, 1);
}
$wasblank = ( '' == $text );
if( $noforce ) {
# Interwikis
- if( $iw && $this->mOptions->getInterwikiMagic() && $nottalk && $wgLang->getLanguageName( $iw ) ) {
+ if( $iw && $this->mOptions->getInterwikiMagic() && $nottalk && $wgContLang->getLanguageName( $iw ) ) {
array_push( $this->mOutput->mLanguageLinks, $nt->getFullText() );
$tmp = $prefix . $trail ;
$s .= (trim($tmp) == '')? '': $tmp;
return $s;
}
- # Some functions here used by doBlockLevels()
- #
+ /**
+ * Handle link to subpage if necessary
+ * @param $target string the source of the link
+ * @param &$text the link text, modified as necessary
+ * @return string the full name of the link
+ * @access private
+ */
+ function maybeDoSubpageLink($target, &$text) {
+ # Valid link forms:
+ # Foobar -- normal
+ # :Foobar -- override special treatment of prefix (images, language links)
+ # /Foobar -- convert to CurrentPage/Foobar
+ # /Foobar/ -- convert to CurrentPage/Foobar, strip the initial / from text
+ global $wgNamespacesWithSubpages;
+
+ $fname = 'Parser::maybeDoSubpageLink';
+ wfProfileIn( $fname );
+ # Look at the first character
+ if( $target{0} == '/' ) {
+ # / at end means we don't want the slash to be shown
+ if(substr($target,-1,1)=='/') {
+ $target=substr($target,1,-1);
+ $noslash=$target;
+ } else {
+ $noslash=substr($target,1);
+ }
+
+ # Some namespaces don't allow subpages
+ if(!empty($wgNamespacesWithSubpages[$this->mTitle->getNamespace()])) {
+ # subpages allowed here
+ $ret = $this->mTitle->getPrefixedText(). '/' . trim($noslash);
+ if( '' === $text ) {
+ $text = $target;
+ } # this might be changed for ugliness reasons
+ } else {
+ # no subpage allowed, use standard link
+ $ret = $target;
+ }
+ } else {
+ # no subpage
+ $ret = $target;
+ }
+
+ wfProfileOut( $fname );
+ return $ret;
+ }
+
+ /**#@+
+ * Used by doBlockLevels()
+ * @access private
+ */
/* private */ function closeParagraph() {
$result = '';
if ( '' != $this->mLastSection ) {
else { return '<!-- ERR 3 -->'; }
return $text."\n";
}
-
- /* private */ function doBlockLevels( $text, $linestart ) {
+ /**#@-*/
+
+ /**
+ * Make lists from lines starting with ':', '*', '#', etc.
+ *
+ * @access private
+ * @return string the lists rendered as HTML
+ */
+ function doBlockLevels( $text, $linestart ) {
$fname = 'Parser::doBlockLevels';
wfProfileIn( $fname );
# ; title : definition text
# So we check for : in the remainder text to split up the
# title and definition, without b0rking links.
- # FIXME: This is not foolproof. Something better in Tokenizer might help.
- if( preg_match( '/^(.*?(?:\s| )):(.*)$/', $t, $match ) ) {
- $term = $match[1];
+ if ($this->findColonNoLinks($t, $term, $t2) !== false) {
+ $t = $t2;
$output .= $term . $this->nextItem( ':' );
- $t = $match[2];
}
}
} elseif( $prefixLength || $lastPrefixLength ) {
if ( ';' == $char ) {
# FIXME: This is dupe of code above
- if( preg_match( '/^(.*?(?:\s| )):(.*)$/', $t, $match ) ) {
- $term = $match[1];
+ if ($this->findColonNoLinks($t, $term, $t2) !== false) {
+ $t = $t2;
$output .= $term . $this->nextItem( ':' );
- $t = $match[2];
}
}
++$commonPrefixLength;
$output .= $this->closeParagraph().'<pre>';
$this->mLastSection = 'pre';
}
+ $t = substr( $t, 1 );
} else {
// paragraph
if ( '' == trim($t) ) {
return $output;
}
- # Return value of a magic variable (like PAGENAME)
+ /**
+ * Split up a string on ':', ignoring any occurences inside
+ * <a>..</a> or <span>...</span>
+ * @param $str string the string to split
+ * @param &$before string set to everything before the ':'
+ * @param &$after string set to everything after the ':'
+ * return string the position of the ':', or false if none found
+ */
+ function findColonNoLinks($str, &$before, &$after) {
+ # I wonder if we should make this count all tags, not just <a>
+ # and <span>. That would prevent us from matching a ':' that
+ # comes in the middle of italics other such formatting....
+ # -- Wil
+ $fname = 'Parser::findColonNoLinks';
+ wfProfileIn( $fname );
+ $pos = 0;
+ do {
+ $colon = strpos($str, ':', $pos);
+
+ if ($colon !== false) {
+ $before = substr($str, 0, $colon);
+ $after = substr($str, $colon + 1);
+
+ # Skip any ':' within <a> or <span> pairs
+ $a = substr_count($before, '<a');
+ $s = substr_count($before, '<span');
+ $ca = substr_count($before, '</a>');
+ $cs = substr_count($before, '</span>');
+
+ if ($a <= $ca and $s <= $cs) {
+ # Tags are balanced before ':'; ok
+ break;
+ }
+ $pos = $colon + 1;
+ }
+ } while ($colon !== false);
+ wfProfileOut( $fname );
+ return $colon;
+ }
+
+ /**
+ * Return value of a magic variable (like PAGENAME)
+ *
+ * @access private
+ */
function getVariableValue( $index ) {
- global $wgLang, $wgSitename, $wgServer;
+ global $wgContLang, $wgSitename, $wgServer;
switch ( $index ) {
case MAG_CURRENTMONTH:
- return $wgLang->formatNum( date( 'm' ) );
+ return $wgContLang->formatNum( date( 'm' ) );
case MAG_CURRENTMONTHNAME:
- return $wgLang->getMonthName( date('n') );
+ return $wgContLang->getMonthName( date('n') );
case MAG_CURRENTMONTHNAMEGEN:
- return $wgLang->getMonthNameGen( date('n') );
+ return $wgContLang->getMonthNameGen( date('n') );
case MAG_CURRENTDAY:
- return $wgLang->formatNum( date('j') );
+ return $wgContLang->formatNum( date('j') );
case MAG_PAGENAME:
return $this->mTitle->getText();
case MAG_PAGENAMEE:
return $this->mTitle->getPartialURL();
case MAG_NAMESPACE:
# return Namespace::getCanonicalName($this->mTitle->getNamespace());
- return $wgLang->getNsText($this->mTitle->getNamespace()); # Patch by Dori
+ return $wgContLang->getNsText($this->mTitle->getNamespace()); # Patch by Dori
case MAG_CURRENTDAYNAME:
- return $wgLang->getWeekdayName( date('w')+1 );
+ return $wgContLang->getWeekdayName( date('w')+1 );
case MAG_CURRENTYEAR:
- return $wgLang->formatNum( date( 'Y' ) );
+ return $wgContLang->formatNum( date( 'Y' ) );
case MAG_CURRENTTIME:
- return $wgLang->time( wfTimestampNow(), false );
+ return $wgContLang->time( wfTimestampNow(), false );
case MAG_NUMBEROFARTICLES:
- return $wgLang->formatNum( wfNumberOfArticles() );
+ return $wgContLang->formatNum( wfNumberOfArticles() );
case MAG_SITENAME:
return $wgSitename;
case MAG_SERVER:
}
}
- # initialise the magic variables (like CURRENTMONTHNAME)
+ /**
+ * initialise the magic variables (like CURRENTMONTHNAME)
+ *
+ * @access private
+ */
function initialiseVariables() {
+ $fname = 'Parser::initialiseVariables';
+ wfProfileIn( $fname );
global $wgVariableIDs;
$this->mVariables = array();
foreach ( $wgVariableIDs as $id ) {
$mw =& MagicWord::get( $id );
$mw->addToArray( $this->mVariables, $this->getVariableValue( $id ) );
}
+ wfProfileOut( $fname );
}
- /* private */ function replaceVariables( $text, $args = array() ) {
+ /**
+ * Replace magic variables, templates, and template arguments
+ * with the appropriate text. Templates are substituted recursively,
+ * taking care to avoid infinite loops.
+ *
+ * Note that the substitution depends on value of $mOutputType:
+ * OT_WIKI: only {{subst:}} templates
+ * OT_MSG: only magic variables
+ * OT_HTML: all templates and magic variables
+ *
+ * @param string $tex The text to transform
+ * @param array $args Key-value pairs representing template parameters to substitute
+ * @access private
+ */
+ function replaceVariables( $text, $args = array() ) {
global $wgLang, $wgScript, $wgArticlePath;
# Prevent too big inclusions
$fname = 'Parser::replaceVariables';
wfProfileIn( $fname );
- $bail = false;
$titleChars = Title::legalChars();
- $nonBraceChars = str_replace( array( '{', '}' ), array( '', '' ), $titleChars );
# This function is called recursively. To keep track of arguments we need a stack:
array_push( $this->mArgStack, $args );
# PHP global rebinding syntax is a bit weird, need to use the GLOBALS array
$GLOBALS['wgCurParser'] =& $this;
- if ( $this->mOutputType == OT_HTML || $this->mOutputType == OT_MSG ) {
- # Variable substitution
- $text = preg_replace_callback( "/{{([$nonBraceChars]*?)}}/", 'wfVariableSubstitution', $text );
- }
+ # Variable substitution
+ $text = preg_replace_callback( "/{{([$titleChars]*?)}}/", 'wfVariableSubstitution', $text );
- if ( $this->mOutputType == OT_HTML ) {
+ if ( $this->mOutputType == OT_HTML || $this->mOutputType == OT_WIKI ) {
# Argument substitution
- $text = preg_replace_callback( "/(\\n?){{{([$titleChars]*?)}}}/", 'wfArgSubstitution', $text );
+ $text = preg_replace_callback( "/{{{([$titleChars]*?)}}}/", 'wfArgSubstitution', $text );
}
# Template substitution
- $regex = '/(\\n?){{(['.$nonBraceChars.']*)(\\|.*?|)}}/s';
+ $regex = '/(\\n|{)?{{(['.$titleChars.']*)(\\|.*?|)}}/s';
$text = preg_replace_callback( $regex, 'wfBraceSubstitution', $text );
array_pop( $this->mArgStack );
return $text;
}
+ /**
+ * Replace magic variables
+ * @access private
+ */
function variableSubstitution( $matches ) {
if ( !$this->mVariables ) {
$this->initialiseVariables();
}
- if ( array_key_exists( $matches[1], $this->mVariables ) ) {
+ $skip = false;
+ if ( $this->mOutputType == OT_WIKI ) {
+ # Do only magic variables prefixed by SUBST
+ $mwSubst =& MagicWord::get( MAG_SUBST );
+ if (!$mwSubst->matchStartAndRemove( $matches[1] ))
+ $skip = true;
+ # Note that if we don't substitute the variable below,
+ # we don't remove the {{subst:}} magic word, in case
+ # it is a template rather than a magic variable.
+ }
+ if ( !$skip && array_key_exists( $matches[1], $this->mVariables ) ) {
$text = $this->mVariables[$matches[1]];
$this->mOutput->mContainsOldMagic = true;
} else {
return $args;
}
+ /**
+ * Return the text of a template, after recursively
+ * replacing any variables or templates within the template.
+ *
+ * @param array $matches The parts of the template
+ * $matches[1]: the title, i.e. the part before the |
+ * $matches[2]: the parameters (including a leading |), if any
+ * @return string the text of the template
+ * @access private
+ */
function braceSubstitution( $matches ) {
- global $wgLinkCache, $wgLang;
+ global $wgLinkCache, $wgContLang;
$fname = 'Parser::braceSubstitution';
$found = false;
$nowiki = false;
$title = NULL;
- # $newline is an optional newline character before the braces
+ # Need to know if the template comes at the start of a line,
+ # to treat the beginning of the template like the beginning
+ # of a line for tables and block-level elements.
+ $linestart = $matches[1];
+
# $part1 is the bit before the first |, and must contain only title characters
# $args is a list of arguments, starting from index 0, not including $part1
- $newline = $matches[1];
$part1 = $matches[2];
# If the third subpattern matched anything, it will start with |
$args = $this->getTemplateArgs($matches[3]);
$argc = count( $args );
- # {{{}}}
- if ( strpos( $matches[0], '{{{' ) !== false ) {
+ # Don't parse {{{}}} because that's only for template arguments
+ if ( $linestart === '{' ) {
$text = $matches[0];
$found = true;
$noparse = true;
# SUBST
if ( !$found ) {
$mwSubst =& MagicWord::get( MAG_SUBST );
- if ( $mwSubst->matchStartAndRemove( $part1 ) ) {
- if ( $this->mOutputType != OT_WIKI ) {
- # Invalid SUBST not replaced at PST time
- # Return without further processing
- $text = $matches[0];
- $found = true;
- $noparse= true;
- }
- } elseif ( $this->mOutputType == OT_WIKI ) {
- # SUBST not found in PST pass, do nothing
+ if ( $mwSubst->matchStartAndRemove( $part1 ) xor ($this->mOutputType == OT_WIKI) ) {
+ # One of two possibilities is true:
+ # 1) Found SUBST but not in the PST phase
+ # 2) Didn't find SUBST and in the PST phase
+ # In either case, return without further processing
$text = $matches[0];
$found = true;
+ $noparse = true;
}
}
$mwInt =& MagicWord::get( MAG_INT );
if ( $mwInt->matchStartAndRemove( $part1 ) ) {
if ( $this->incrementIncludeCount( 'int:'.$part1 ) ) {
- $text = wfMsgReal( $part1, $args, true );
+ $text = $linestart . wfMsgReal( $part1, $args, true );
$found = true;
}
}
$mwNs = MagicWord::get( MAG_NS );
if ( $mwNs->matchStartAndRemove( $part1 ) ) {
if ( intval( $part1 ) ) {
- $text = $wgLang->getNsText( intval( $part1 ) );
+ $text = $linestart . $wgContLang->getNsText( intval( $part1 ) );
$found = true;
} else {
$index = Namespace::getCanonicalIndex( strtolower( $part1 ) );
if ( !is_null( $index ) ) {
- $text = $wgLang->getNsText( $index );
+ $text = $linestart . $wgContLang->getNsText( $index );
$found = true;
}
}
$title = Title::newFromText( $part1 );
if ( !is_null( $title ) ) {
if ( $argc > 0 ) {
- $text = $title->$func( $args[0] );
+ $text = $linestart . $title->$func( $args[0] );
} else {
- $text = $title->$func();
+ $text = $linestart . $title->$func();
}
$found = true;
}
}
}
- # Internal variables
- if ( !$this->mVariables ) {
- $this->initialiseVariables();
- }
- if ( !$found && array_key_exists( $part1, $this->mVariables ) ) {
- $text = $this->mVariables[$part1];
- $found = true;
- $this->mOutput->mContainsOldMagic = true;
- }
-
# GRAMMAR
if ( !$found && $argc == 1 ) {
$mwGrammar =& MagicWord::get( MAG_GRAMMAR );
if ( $mwGrammar->matchStartAndRemove( $part1 ) ) {
- $text = $wgLang->convertGrammar( $args[0], $part1 );
+ $text = $linestart . $wgContLang->convertGrammar( $args[0], $part1 );
$found = true;
}
}
# Did we encounter this template already? If yes, it is in the cache
# and we need to check for loops.
- if ( isset( $this->mTemplates[$part1] ) ) {
+ if ( !$found && isset( $this->mTemplates[$part1] ) ) {
+ # set $text to cached message.
+ $text = $linestart . $this->mTemplates[$part1];
+ $found = true;
+
# Infinite loop test
if ( isset( $this->mTemplatePath[$part1] ) ) {
$noparse = true;
$found = true;
+ $text .= '<!-- WARNING: template loop detected -->';
}
- # set $text to cached message.
- $text = $this->mTemplates[$part1];
- $found = true;
}
# Load from database
+ $itcamefromthedatabase = false;
if ( !$found ) {
- $title = Title::newFromText( $part1, NS_TEMPLATE );
+ $ns = NS_TEMPLATE;
+ $part1 = $this->maybeDoSubpageLink( $part1, $subpage='' );
+ if ($subpage !== '') {
+ $ns = $this->mTitle->getNamespace();
+ }
+ $title = Title::newFromText( $part1, $ns );
if ( !is_null( $title ) && !$title->isExternal() ) {
# Check for excessive inclusion
$dbk = $title->getPrefixedDBkey();
$articleContent = $article->getContentWithoutUsingSoManyDamnGlobals();
if ( $articleContent !== false ) {
$found = true;
- $text = $articleContent;
+ $text = $linestart . $articleContent;
+ $itcamefromthedatabase = true;
}
}
# If the title is valid but undisplayable, make a link to it
if ( $this->mOutputType == OT_HTML && !$found ) {
- $text = '[['.$title->getPrefixedText().']]';
+ $text = $linestart . '[['.$title->getPrefixedText().']]';
$found = true;
}
# Only for HTML output
if ( $nowiki && $found && $this->mOutputType == OT_HTML ) {
$text = wfEscapeWikiText( $text );
- } elseif ( $this->mOutputType == OT_HTML && $found && !$noparse) {
+ } elseif ( ($this->mOutputType == OT_HTML || $this->mOutputType == OT_WIKI) && $found && !$noparse) {
# Clean up argument array
$assocArgs = array();
$index = 1;
}
}
- # Do not enter included links in link table
- if ( !is_null( $title ) ) {
- $wgLinkCache->suspend();
- }
-
# Add a new element to the templace recursion path
$this->mTemplatePath[$part1] = 1;
- $text = $this->stripParse( $text, $newline, $assocArgs );
+ $text = $this->strip( $text, $this->mStripState );
+ $text = $this->removeHTMLtags( $text );
+ $text = $this->replaceVariables( $text, $assocArgs );
# Resume the link cache and register the inclusion as a link
- if ( !is_null( $title ) ) {
- $wgLinkCache->resume();
+ if ( $this->mOutputType == OT_HTML && !is_null( $title ) ) {
$wgLinkCache->addLinkObj( $title );
}
+
+ # If the template begins with a table or block-level
+ # element, it should be treated as beginning a new line.
+ if ($linestart !== '\n' && preg_match('/^({\\||:|;|#|\*)/', $text)) {
+ $text = "\n" . $text;
+ }
}
# Empties the template path
$this->mTemplatePath = array();
+ if ( !$found ) {
+ return $matches[0];
+ } else {
+ # replace ==section headers==
+ # XXX this needs to go away once we have a better parser.
+ if ( $this->mOutputType != OT_WIKI && $itcamefromthedatabase ) {
+ if( !is_null( $title ) )
+ $encodedname = base64_encode($title->getPrefixedDBkey());
+ else
+ $encodedname = base64_encode("");
+ $m = preg_split('/(^={1,6}.*?={1,6}\s*?$)/m', $text, -1,
+ PREG_SPLIT_DELIM_CAPTURE);
+ $text = '';
+ $nsec = 0;
+ for( $i = 0; $i < count($m); $i += 2 ) {
+ $text .= $m[$i];
+ if (!isset($m[$i + 1]) || $m[$i + 1] == "") continue;
+ $hl = $m[$i + 1];
+ if( strstr($hl, "<!--MWTEMPLATESECTION") ) {
+ $text .= $hl;
+ continue;
+ }
+ preg_match('/^(={1,6})(.*?)(={1,6})\s*?$/m', $hl, $m2);
+ $text .= $m2[1] . $m2[2] . "<!--MWTEMPLATESECTION="
+ . $encodedname . "&" . base64_encode("$nsec") . "-->" . $m2[3];
+
+ $nsec++;
+ }
+ }
+ }
+ # Empties the template path
+ $this->mTemplatePath = array();
if ( !$found ) {
return $matches[0];
} else {
}
}
- # Triple brace replacement -- used for template arguments
+ /**
+ * Triple brace replacement -- used for template arguments
+ * @access private
+ */
function argSubstitution( $matches ) {
- $newline = $matches[1];
- $arg = trim( $matches[2] );
+ $arg = trim( $matches[1] );
$text = $matches[0];
$inputArgs = end( $this->mArgStack );
if ( array_key_exists( $arg, $inputArgs ) ) {
- $text = $this->stripParse( $inputArgs[$arg], $newline, array() );
+ $text = $inputArgs[$arg];
}
return $text;
}
- # Returns true if the function is allowed to include this entity
+ /**
+ * Returns true if the function is allowed to include this entity
+ * @access private
+ */
function incrementIncludeCount( $dbk ) {
if ( !array_key_exists( $dbk, $this->mIncludeCount ) ) {
$this->mIncludeCount[$dbk] = 0;
}
- # Cleans up HTML, removes dangerous tags and attributes
- /* private */ function removeHTMLtags( $text ) {
+ /**
+ * Cleans up HTML, removes dangerous tags and attributes, and
+ * removes HTML comments
+ * @access private
+ */
+ function removeHTMLtags( $text ) {
global $wgUseTidy, $wgUserHtml;
$fname = 'Parser::removeHTMLtags';
wfProfileIn( $fname );
$htmlattrs = $this->getHTMLattrs () ;
# Remove HTML comments
- $text = preg_replace( '/(\\n *<!--.*--> *(?=\\n)|<!--.*-->)/sU', '$2', $text );
+ $text = $this->removeHTMLcomments( $text );
$bits = explode( '<', $text );
$text = array_shift( $bits );
return $text;
}
+ /**
+ * Remove '<!--', '-->', and everything between.
+ * To avoid leaving blank lines, when a comment is both preceded
+ * and followed by a newline (ignoring spaces), trim leading and
+ * trailing spaces and one of the newlines.
+ *
+ * @access private
+ */
+ function removeHTMLcomments( $text ) {
+ $fname='Parser::removeHTMLcomments';
+ wfProfileIn( $fname );
+ while (($start = strpos($text, '<!--')) !== false) {
+ $end = strpos($text, '-->', $start + 4);
+ if ($end === false) {
+ # Unterminated comment; bail out
+ break;
+ }
+
+ $end += 3;
- # This function accomplishes several tasks:
- # 1) Auto-number headings if that option is enabled
- # 2) Add an [edit] link to sections for logged in users who have enabled the option
- # 3) Add a Table of contents on the top for users who have enabled the option
- # 4) Auto-anchor headings
- #
- # It loops through all headlines, collects the necessary data, then splits up the
- # string and re-inserts the newly formatted headlines.
+ # Trim space and newline if the comment is both
+ # preceded and followed by a newline
+ $spaceStart = max($start - 1, 0);
+ $spaceLen = $end - $spaceStart;
+ while (substr($text, $spaceStart, 1) === ' ' && $spaceStart > 0) {
+ $spaceStart--;
+ $spaceLen++;
+ }
+ while (substr($text, $spaceStart + $spaceLen, 1) === ' ')
+ $spaceLen++;
+ if (substr($text, $spaceStart, 1) === "\n" and substr($text, $spaceStart + $spaceLen, 1) === "\n") {
+ # Remove the comment, leading and trailing
+ # spaces, and leave only one newline.
+ $text = substr_replace($text, "\n", $spaceStart, $spaceLen + 1);
+ }
+ else {
+ # Remove just the comment.
+ $text = substr_replace($text, '', $start, $end - $start);
+ }
+ }
+ wfProfileOut( $fname );
+ return $text;
+ }
+
+ /**
+ * This function accomplishes several tasks:
+ * 1) Auto-number headings if that option is enabled
+ * 2) Add an [edit] link to sections for logged in users who have enabled the option
+ * 3) Add a Table of contents on the top for users who have enabled the option
+ * 4) Auto-anchor headings
+ *
+ * It loops through all headlines, collects the necessary data, then splits up the
+ * string and re-inserts the newly formatted headlines.
+ * @access private
+ */
/* private */ function formatHeadings( $text, $isMain=true ) {
- global $wgInputEncoding, $wgMaxTocLevel, $wgLang;
+ global $wgInputEncoding, $wgMaxTocLevel, $wgContLang, $wgLinkHolders;
$doNumberHeadings = $this->mOptions->getNumberHeadings();
$doShowToc = $this->mOptions->getShowToc();
# headline counter
$headlineCount = 0;
+ $sectionCount = 0; # headlineCount excluding template sections
# Ugh .. the TOC should have neat indentation levels which can be
# passed to the skin functions. These are determined here
$level = 0;
$prevlevel = 0;
foreach( $matches[3] as $headline ) {
+ $istemplate = 0;
+ $templatetitle = "";
+ $templatesection = 0;
+
+ if (preg_match("/<!--MWTEMPLATESECTION=([^&]+)&([^_]+)-->/", $headline, $mat)) {
+ $istemplate = 1;
+ $templatetitle = base64_decode($mat[1]);
+ $templatesection = 1 + (int)base64_decode($mat[2]);
+ $headline = preg_replace("/<!--MWTEMPLATESECTION=([^&]+)&([^_]+)-->/", "", $headline);
+ }
+
$numbering = '';
if( $level ) {
$prevlevel = $level;
if( $dot ) {
$numbering .= '.';
}
- $numbering .= $wgLang->formatNum( $sublevelCount[$i] );
+ $numbering .= $wgContLang->formatNum( $sublevelCount[$i] );
$dot = 1;
}
}
$canonized_headline = $this->unstripNoWiki( $headline, $this->mStripState );
# Remove link placeholders by the link text.
- # <!--LINK namespace page_title link text with suffix-->
+ # <!--LINK number-->
# turns into
# link text with suffix
- $canonized_headline = preg_replace( '/<!--LINK [0-9]* [^ ]* *(.*?)-->/','$1', $canonized_headline );
+ $canonized_headline = preg_replace( '/<!--LINK ([0-9]*)-->/e',
+ "\$wgLinkHolders['texts'][\$1]",
+ $canonized_headline );
+
# strip out HTML
$canonized_headline = preg_replace( '/<.*?' . '>/','',$canonized_headline );
$tocline = trim( $canonized_headline );
if( $doShowToc && ( !isset($wgMaxTocLevel) || $toclevel<$wgMaxTocLevel ) ) {
$toc .= $sk->tocLine($anchor,$tocline,$toclevel);
}
- if( $showEditLink ) {
+ if( $showEditLink && ( !$istemplate || $templatetitle !== "" ) ) {
if ( empty( $head[$headlineCount] ) ) {
$head[$headlineCount] = '';
}
- $head[$headlineCount] .= $sk->editSectionLink($headlineCount+1);
+ if( $istemplate )
+ $head[$headlineCount] .= $sk->editSectionLinkForOther($templatetitle, $templatesection);
+ else
+ $head[$headlineCount] .= $sk->editSectionLink($sectionCount+1);
}
# Add the edit section span
if( $rightClickHack ) {
- $headline = $sk->editSectionScript($headlineCount+1,$headline);
+ if( $istemplate )
+ $headline = $sk->editSectionScriptForOther($templatetitle, $templatesection, $headline);
+ else
+ $headline = $sk->editSectionScript($sectionCount+1,$headline);
}
# give headline the correct <h#> tag
@$head[$headlineCount] .= "<a name=\"$anchor\"></a><h".$level.$matches[2][$headlineCount] .$headline.'</h'.$level.'>';
$headlineCount++;
+ if( !$istemplate )
+ $sectionCount++;
}
if( $doShowToc ) {
}
}
- # Return an HTML link for the "ISBN 123456" text
- /* private */ function magicISBN( $text ) {
+ /**
+ * Return an HTML link for the "ISBN 123456" text
+ * @access private
+ */
+ function magicISBN( $text ) {
global $wgLang;
$fname = 'Parser::magicISBN';
wfProfileIn( $fname );
return $text;
}
- # Return an HTML link for the "GEO ..." text
- /* private */ function magicGEO( $text ) {
+ /**
+ * Return an HTML link for the "GEO ..." text
+ * @access private
+ */
+ function magicGEO( $text ) {
global $wgLang, $wgUseGeoMode;
$fname = 'Parser::magicGEO';
wfProfileIn( $fname );
return $text;
}
- # Return an HTML link for the "RFC 1234" text
- /* private */ function magicRFC( $text ) {
+ /**
+ * Return an HTML link for the "RFC 1234" text
+ * @access private
+ * @param string $text text to be processed
+ */
+ function magicRFC( $text ) {
global $wgLang;
+
+ $valid = '0123456789';
+ $internal = false;
$a = split( 'RFC ', ' '.$text );
if ( count ( $a ) < 2 ) return $text;
$text = substr( array_shift( $a ), 1);
- $valid = '0123456789';
+
+ /* Check if RFC keyword is preceed by [[.
+ * This test is made here cause of the array_shift above
+ * that prevent the test to be done in the foreach.
+ */
+ if(substr($text, -2) == '[[') { $internal = true; }
foreach ( $a as $x ) {
+ /* token might be empty if we have RFC RFC 1234 */
+ if($x=='') {
+ $text.='RFC ';
+ continue;
+ }
+
$rfc = $blank = '' ;
- while ( ' ' == $x{0} ) {
+
+ /** remove and save whitespaces in $blank */
+ while ( $x{0} == ' ' ) {
$blank .= ' ';
$x = substr( $x, 1 );
}
+
+ /** remove and save the rfc number in $rfc */
while ( strstr( $valid, $x{0} ) != false ) {
$rfc .= $x{0};
$x = substr( $x, 1 );
}
- if ( '' == $rfc ) {
+ if ( $rfc == '') {
+ /* call back stripped spaces*/
$text .= "RFC $blank$x";
+ } elseif( $internal) {
+ /* normal link */
+ $text .= "RFC $rfc$x";
} else {
+ /* build the external link*/
$url = wfmsg( 'rfcurl' );
$url = str_replace( '$1', $rfc, $url);
$sk =& $this->mOptions->getSkin();
$la = $sk->getExternalLinkAttributes( $url, 'RFC '.$rfc );
$text .= "<a href='{$url}'{$la}>RFC {$rfc}</a>{$x}";
}
+
+ /* Check if the next RFC keyword is preceed by [[ */
+ $internal = (substr($x,-2) == '[[');
}
return $text;
}
+ /**
+ * Transform wiki markup when saving a page by doing \r\n -> \n
+ * conversion, substitting signatures, {{subst:}} templates, etc.
+ *
+ * @param string $text the text to transform
+ * @param Title &$title the Title object for the current article
+ * @param User &$user the User object describing the current user
+ * @param ParserOptions $options parsing options
+ * @param bool $clearState whether to clear the parser state first
+ * @return string the altered wiki markup
+ * @access public
+ */
function preSaveTransform( $text, &$title, &$user, $options, $clearState = true ) {
$this->mOptions = $options;
$this->mTitle =& $title;
return $text;
}
- /* private */ function pstPass2( $text, &$user ) {
- global $wgLang, $wgLocaltimezone, $wgCurParser;
+ /**
+ * Pre-save transform helper function
+ * @access private
+ */
+ function pstPass2( $text, &$user ) {
+ global $wgLang, $wgContLang, $wgLocaltimezone, $wgCurParser;
# Variable replacement
# Because mOutputType is OT_WIKI, this will only process {{subst:xxx}} type tags
$oldtz = getenv('TZ'); putenv('TZ='.$wgLocaltimezone);
}
/* Note: this is an ugly timezone hack for the European wikis */
- $d = $wgLang->timeanddate( date( 'YmdHis' ), false ) .
+ $d = $wgContLang->timeanddate( date( 'YmdHis' ), false ) .
' (' . date( 'T' ) . ')';
if(isset($wgLocaltimezone)) putenv('TZ='.$oldtzs);
$text = preg_replace( '/~~~~~/', $d, $text );
- $text = preg_replace( '/~~~~/', '[[' . $wgLang->getNsText( NS_USER ) . ":$n|$k]] $d", $text );
- $text = preg_replace( '/~~~/', '[[' . $wgLang->getNsText( NS_USER ) . ":$n|$k]]", $text );
+ $text = preg_replace( '/~~~~/', '[[' . $wgContLang->getNsText( NS_USER ) . ":$n|$k]] $d", $text );
+ $text = preg_replace( '/~~~/', '[[' . $wgContLang->getNsText( NS_USER ) . ":$n|$k]]", $text );
# Context links: [[|name]] and [[name (context)|]]
#
$text = preg_replace( $p2, "[[\\1 ({$context})|\\1]]", $text );
}
- /*
- $mw =& MagicWord::get( MAG_SUBST );
- $wgCurParser = $this->fork();
- $text = $mw->substituteCallback( $text, "wfBraceSubstitution" );
- $this->merge( $wgCurParser );
- */
-
# Trim trailing whitespace
# MAG_END (__END__) tag allows for trailing
# whitespace to be deliberately included
return $text;
}
- # Set up some variables which are usually set up in parse()
- # so that an external function can call some class members with confidence
+ /**
+ * Set up some variables which are usually set up in parse()
+ * so that an external function can call some class members with confidence
+ * @access public
+ */
function startExternalParse( &$title, $options, $outputType, $clearState = true ) {
$this->mTitle =& $title;
$this->mOptions = $options;
}
}
+ /**
+ * Transform a MediaWiki message by replacing magic variables.
+ *
+ * @param string $text the text to transform
+ * @param ParserOptions $options options
+ * @return string the text with variables substituted
+ * @access public
+ */
function transformMsg( $text, $options ) {
global $wgTitle;
static $executing = false;
return $text;
}
- # Create an HTML-style tag, e.g. <yourtag>special text</yourtag>
- # Callback will be called with the text within
- # Transform and return the text within
+ /**
+ * Create an HTML-style tag, e.g. <yourtag>special text</yourtag>
+ * Callback will be called with the text within
+ * Transform and return the text within
+ * @access public
+ */
function setHook( $tag, $callback ) {
$oldVal = @$this->mTagHooks[$tag];
$this->mTagHooks[$tag] = $callback;
$in );
}
-
?>