Add messages for hardcoded parser warnings
[lhc/web/wiklou.git] / includes / parser / Parser.php
1 <?php
2 /**
3 * @defgroup Parser Parser
4 *
5 * @file
6 * @ingroup Parser
7 * File for Parser and related classes
8 */
9
10
11 /**
12 * PHP Parser - Processes wiki markup (which uses a more user-friendly
13 * syntax, such as "[[link]]" for making links), and provides a one-way
14 * transformation of that wiki markup it into XHTML output / markup
15 * (which in turn the browser understands, and can display).
16 *
17 * <pre>
18 * There are five main entry points into the Parser class:
19 * parse()
20 * produces HTML output
21 * preSaveTransform().
22 * produces altered wiki markup.
23 * preprocess()
24 * removes HTML comments and expands templates
25 * cleanSig()
26 * Cleans a signature before saving it to preferences
27 * extractSections()
28 * Extracts sections from an article for section editing
29 *
30 * Globals used:
31 * objects: $wgLang, $wgContLang
32 *
33 * NOT $wgArticle, $wgUser or $wgTitle. Keep them away!
34 *
35 * settings:
36 * $wgUseTex*, $wgUseDynamicDates*, $wgInterwikiMagic*,
37 * $wgNamespacesWithSubpages, $wgAllowExternalImages*,
38 * $wgLocaltimezone, $wgAllowSpecialInclusion*,
39 * $wgMaxArticleSize*
40 *
41 * * only within ParserOptions
42 * </pre>
43 *
44 * @ingroup Parser
45 */
46 class Parser
47 {
48 /**
49 * Update this version number when the ParserOutput format
50 * changes in an incompatible way, so the parser cache
51 * can automatically discard old data.
52 */
53 const VERSION = '1.6.4';
54
55 # Flags for Parser::setFunctionHook
56 # Also available as global constants from Defines.php
57 const SFH_NO_HASH = 1;
58 const SFH_OBJECT_ARGS = 2;
59
60 # Constants needed for external link processing
61 # Everything except bracket, space, or control characters
62 const EXT_LINK_URL_CLASS = '[^][<>"\\x00-\\x20\\x7F]';
63 const EXT_IMAGE_REGEX = '/^(http:\/\/|https:\/\/)([^][<>"\\x00-\\x20\\x7F]+)
64 \\/([A-Za-z0-9_.,~%\\-+&;#*?!=()@\\x80-\\xFF]+)\\.((?i)gif|png|jpg|jpeg)$/Sx';
65
66 // State constants for the definition list colon extraction
67 const COLON_STATE_TEXT = 0;
68 const COLON_STATE_TAG = 1;
69 const COLON_STATE_TAGSTART = 2;
70 const COLON_STATE_CLOSETAG = 3;
71 const COLON_STATE_TAGSLASH = 4;
72 const COLON_STATE_COMMENT = 5;
73 const COLON_STATE_COMMENTDASH = 6;
74 const COLON_STATE_COMMENTDASHDASH = 7;
75
76 // Flags for preprocessToDom
77 const PTD_FOR_INCLUSION = 1;
78
79 // Allowed values for $this->mOutputType
80 // Parameter to startExternalParse().
81 const OT_HTML = 1;
82 const OT_WIKI = 2;
83 const OT_PREPROCESS = 3;
84 const OT_MSG = 3;
85
86 // Marker Suffix needs to be accessible staticly.
87 const MARKER_SUFFIX = "-QINU\x7f";
88
89 /**#@+
90 * @private
91 */
92 # Persistent:
93 var $mTagHooks, $mTransparentTagHooks, $mFunctionHooks, $mFunctionSynonyms, $mVariables,
94 $mImageParams, $mImageParamsMagicArray, $mStripList, $mMarkerIndex, $mPreprocessor,
95 $mExtLinkBracketedRegex, $mUrlProtocols, $mDefaultStripList, $mVarCache, $mConf;
96
97
98 # Cleared with clearState():
99 var $mOutput, $mAutonumber, $mDTopen, $mStripState;
100 var $mIncludeCount, $mArgStack, $mLastSection, $mInPre;
101 var $mLinkHolders, $mLinkID;
102 var $mIncludeSizes, $mPPNodeCount, $mDefaultSort;
103 var $mTplExpandCache; // empty-frame expansion cache
104 var $mTplRedirCache, $mTplDomCache, $mHeadings, $mDoubleUnderscores;
105 var $mExpensiveFunctionCount; // number of expensive parser function calls
106 var $mFileCache;
107
108 # Temporary
109 # These are variables reset at least once per parse regardless of $clearState
110 var $mOptions, // ParserOptions object
111 $mTitle, // Title context, used for self-link rendering and similar things
112 $mOutputType, // Output type, one of the OT_xxx constants
113 $ot, // Shortcut alias, see setOutputType()
114 $mRevisionId, // ID to display in {{REVISIONID}} tags
115 $mRevisionTimestamp, // The timestamp of the specified revision ID
116 $mRevIdForTs; // The revision ID which was used to fetch the timestamp
117
118 /**#@-*/
119
120 /**
121 * Constructor
122 *
123 * @public
124 */
125 function __construct( $conf = array() ) {
126 $this->mConf = $conf;
127 $this->mTagHooks = array();
128 $this->mTransparentTagHooks = array();
129 $this->mFunctionHooks = array();
130 $this->mFunctionSynonyms = array( 0 => array(), 1 => array() );
131 $this->mDefaultStripList = $this->mStripList = array( 'nowiki', 'gallery', 'poem' );
132 $this->mUrlProtocols = wfUrlProtocols();
133 $this->mExtLinkBracketedRegex = '/\[(\b(' . wfUrlProtocols() . ')'.
134 '[^][<>"\\x00-\\x20\\x7F]+) *([^\]\\x0a\\x0d]*?)\]/S';
135 $this->mVarCache = array();
136 if ( isset( $conf['preprocessorClass'] ) ) {
137 $this->mPreprocessorClass = $conf['preprocessorClass'];
138 } elseif ( extension_loaded( 'domxml' ) ) {
139 // PECL extension that conflicts with the core DOM extension (bug 13770)
140 wfDebug( "Warning: you have the obsolete domxml extension for PHP. Please remove it!\n" );
141 $this->mPreprocessorClass = 'Preprocessor_Hash';
142 } elseif ( extension_loaded( 'dom' ) ) {
143 $this->mPreprocessorClass = 'Preprocessor_DOM';
144 } else {
145 $this->mPreprocessorClass = 'Preprocessor_Hash';
146 }
147 $this->mMarkerIndex = 0;
148 $this->mFirstCall = true;
149 }
150
151 /**
152 * Reduce memory usage to reduce the impact of circular references
153 */
154 function __destruct() {
155 if ( isset( $this->mLinkHolders ) ) {
156 $this->mLinkHolders->__destruct();
157 }
158 foreach ( $this as $name => $value ) {
159 unset( $this->$name );
160 }
161 }
162
163 /**
164 * Do various kinds of initialisation on the first call of the parser
165 */
166 function firstCallInit() {
167 if ( !$this->mFirstCall ) {
168 return;
169 }
170 $this->mFirstCall = false;
171
172 wfProfileIn( __METHOD__ );
173
174 $this->setHook( 'pre', array( $this, 'renderPreTag' ) );
175 CoreParserFunctions::register( $this );
176 $this->initialiseVariables();
177
178 wfRunHooks( 'ParserFirstCallInit', array( &$this ) );
179 wfProfileOut( __METHOD__ );
180 }
181
182 /**
183 * Clear Parser state
184 *
185 * @private
186 */
187 function clearState() {
188 wfProfileIn( __METHOD__ );
189 if ( $this->mFirstCall ) {
190 $this->firstCallInit();
191 }
192 $this->mOutput = new ParserOutput;
193 $this->mAutonumber = 0;
194 $this->mLastSection = '';
195 $this->mDTopen = false;
196 $this->mIncludeCount = array();
197 $this->mStripState = new StripState;
198 $this->mArgStack = false;
199 $this->mInPre = false;
200 $this->mLinkHolders = new LinkHolderArray( $this );
201 $this->mLinkID = 0;
202 $this->mRevisionTimestamp = $this->mRevisionId = null;
203
204 /**
205 * Prefix for temporary replacement strings for the multipass parser.
206 * \x07 should never appear in input as it's disallowed in XML.
207 * Using it at the front also gives us a little extra robustness
208 * since it shouldn't match when butted up against identifier-like
209 * string constructs.
210 *
211 * Must not consist of all title characters, or else it will change
212 * the behaviour of <nowiki> in a link.
213 */
214 #$this->mUniqPrefix = "\x07UNIQ" . Parser::getRandomString();
215 # Changed to \x7f to allow XML double-parsing -- TS
216 $this->mUniqPrefix = "\x7fUNIQ" . self::getRandomString();
217
218
219 # Clear these on every parse, bug 4549
220 $this->mTplExpandCache = $this->mTplRedirCache = $this->mTplDomCache = array();
221
222 $this->mShowToc = true;
223 $this->mForceTocPosition = false;
224 $this->mIncludeSizes = array(
225 'post-expand' => 0,
226 'arg' => 0,
227 );
228 $this->mPPNodeCount = 0;
229 $this->mDefaultSort = false;
230 $this->mHeadings = array();
231 $this->mDoubleUnderscores = array();
232 $this->mExpensiveFunctionCount = 0;
233 $this->mFileCache = array();
234
235 # Fix cloning
236 if ( isset( $this->mPreprocessor ) && $this->mPreprocessor->parser !== $this ) {
237 $this->mPreprocessor = null;
238 }
239
240 wfRunHooks( 'ParserClearState', array( &$this ) );
241 wfProfileOut( __METHOD__ );
242 }
243
244 function setOutputType( $ot ) {
245 $this->mOutputType = $ot;
246 // Shortcut alias
247 $this->ot = array(
248 'html' => $ot == self::OT_HTML,
249 'wiki' => $ot == self::OT_WIKI,
250 'pre' => $ot == self::OT_PREPROCESS,
251 );
252 }
253
254 /**
255 * Set the context title
256 */
257 function setTitle( $t ) {
258 if ( !$t || $t instanceof FakeTitle ) {
259 $t = Title::newFromText( 'NO TITLE' );
260 }
261 if ( strval( $t->getFragment() ) !== '' ) {
262 # Strip the fragment to avoid various odd effects
263 $this->mTitle = clone $t;
264 $this->mTitle->setFragment( '' );
265 } else {
266 $this->mTitle = $t;
267 }
268 }
269
270 /**
271 * Accessor for mUniqPrefix.
272 *
273 * @public
274 */
275 function uniqPrefix() {
276 if( !isset( $this->mUniqPrefix ) ) {
277 // @fixme this is probably *horribly wrong*
278 // LanguageConverter seems to want $wgParser's uniqPrefix, however
279 // if this is called for a parser cache hit, the parser may not
280 // have ever been initialized in the first place.
281 // Not really sure what the heck is supposed to be going on here.
282 return '';
283 //throw new MWException( "Accessing uninitialized mUniqPrefix" );
284 }
285 return $this->mUniqPrefix;
286 }
287
288 /**
289 * Convert wikitext to HTML
290 * Do not call this function recursively.
291 *
292 * @param $text String: text we want to parse
293 * @param $title A title object
294 * @param $options ParserOptions
295 * @param $linestart boolean
296 * @param $clearState boolean
297 * @param $revid Int: number to pass in {{REVISIONID}}
298 * @return ParserOutput a ParserOutput
299 */
300 public function parse( $text, Title $title, ParserOptions $options, $linestart = true, $clearState = true, $revid = null ) {
301 /**
302 * First pass--just handle <nowiki> sections, pass the rest off
303 * to internalParse() which does all the real work.
304 */
305
306 global $wgUseTidy, $wgAlwaysUseTidy, $wgContLang;
307 $fname = __METHOD__.'-' . wfGetCaller();
308 wfProfileIn( __METHOD__ );
309 wfProfileIn( $fname );
310
311 if ( $clearState ) {
312 $this->clearState();
313 }
314
315 $this->mOptions = $options;
316 $this->setTitle( $title );
317 $oldRevisionId = $this->mRevisionId;
318 $oldRevisionTimestamp = $this->mRevisionTimestamp;
319 if( $revid !== null ) {
320 $this->mRevisionId = $revid;
321 $this->mRevisionTimestamp = null;
322 }
323 $this->setOutputType( self::OT_HTML );
324 wfRunHooks( 'ParserBeforeStrip', array( &$this, &$text, &$this->mStripState ) );
325 # No more strip!
326 wfRunHooks( 'ParserAfterStrip', array( &$this, &$text, &$this->mStripState ) );
327 $text = $this->internalParse( $text );
328 $text = $this->mStripState->unstripGeneral( $text );
329
330 # Clean up special characters, only run once, next-to-last before doBlockLevels
331 $fixtags = array(
332 # french spaces, last one Guillemet-left
333 # only if there is something before the space
334 '/(.) (?=\\?|:|;|!|%|\\302\\273)/' => '\\1&nbsp;\\2',
335 # french spaces, Guillemet-right
336 '/(\\302\\253) /' => '\\1&nbsp;',
337 '/&nbsp;(!\s*important)/' => ' \\1', #Beware of CSS magic word !important, bug #11874.
338 );
339 $text = preg_replace( array_keys($fixtags), array_values($fixtags), $text );
340
341 $text = $this->doBlockLevels( $text, $linestart );
342
343 $this->replaceLinkHolders( $text );
344
345 # the position of the parserConvert() call should not be changed. it
346 # assumes that the links are all replaced and the only thing left
347 # is the <nowiki> mark.
348 # Side-effects: this calls $this->mOutput->setTitleText()
349 $text = $wgContLang->parserConvert( $text, $this );
350
351 $text = $this->mStripState->unstripNoWiki( $text );
352
353 wfRunHooks( 'ParserBeforeTidy', array( &$this, &$text ) );
354
355 //!JF Move to its own function
356
357 $uniq_prefix = $this->mUniqPrefix;
358 $matches = array();
359 $elements = array_keys( $this->mTransparentTagHooks );
360 $text = self::extractTagsAndParams( $elements, $text, $matches, $uniq_prefix );
361
362 foreach( $matches as $marker => $data ) {
363 list( $element, $content, $params, $tag ) = $data;
364 $tagName = strtolower( $element );
365 if( isset( $this->mTransparentTagHooks[$tagName] ) ) {
366 $output = call_user_func_array( $this->mTransparentTagHooks[$tagName],
367 array( $content, $params, $this ) );
368 } else {
369 $output = $tag;
370 }
371 $this->mStripState->general->setPair( $marker, $output );
372 }
373 $text = $this->mStripState->unstripGeneral( $text );
374
375 $text = Sanitizer::normalizeCharReferences( $text );
376
377 if (($wgUseTidy and $this->mOptions->mTidy) or $wgAlwaysUseTidy) {
378 $text = self::tidy($text);
379 } else {
380 # attempt to sanitize at least some nesting problems
381 # (bug #2702 and quite a few others)
382 $tidyregs = array(
383 # ''Something [http://www.cool.com cool''] -->
384 # <i>Something</i><a href="http://www.cool.com"..><i>cool></i></a>
385 '/(<([bi])>)(<([bi])>)?([^<]*)(<\/?a[^<]*>)([^<]*)(<\/\\4>)?(<\/\\2>)/' =>
386 '\\1\\3\\5\\8\\9\\6\\1\\3\\7\\8\\9',
387 # fix up an anchor inside another anchor, only
388 # at least for a single single nested link (bug 3695)
389 '/(<a[^>]+>)([^<]*)(<a[^>]+>[^<]*)<\/a>(.*)<\/a>/' =>
390 '\\1\\2</a>\\3</a>\\1\\4</a>',
391 # fix div inside inline elements- doBlockLevels won't wrap a line which
392 # contains a div, so fix it up here; replace
393 # div with escaped text
394 '/(<([aib]) [^>]+>)([^<]*)(<div([^>]*)>)(.*)(<\/div>)([^<]*)(<\/\\2>)/' =>
395 '\\1\\3&lt;div\\5&gt;\\6&lt;/div&gt;\\8\\9',
396 # remove empty italic or bold tag pairs, some
397 # introduced by rules above
398 '/<([bi])><\/\\1>/' => '',
399 );
400
401 $text = preg_replace(
402 array_keys( $tidyregs ),
403 array_values( $tidyregs ),
404 $text );
405 }
406 global $wgExpensiveParserFunctionLimit;
407 if ( $this->mExpensiveFunctionCount > $wgExpensiveParserFunctionLimit ) {
408 $this->limitationWarn( 'expensive-parserfunction', $this->mExpensiveFunctionCount, $wgExpensiveParserFunctionLimit );
409 }
410
411 wfRunHooks( 'ParserAfterTidy', array( &$this, &$text ) );
412
413 # Information on include size limits, for the benefit of users who try to skirt them
414 if ( $this->mOptions->getEnableLimitReport() ) {
415 global $wgExpensiveParserFunctionLimit;
416 $max = $this->mOptions->getMaxIncludeSize();
417 $PFreport = "Expensive parser function count: {$this->mExpensiveFunctionCount}/$wgExpensiveParserFunctionLimit\n";
418 $limitReport =
419 "NewPP limit report\n" .
420 "Preprocessor node count: {$this->mPPNodeCount}/{$this->mOptions->mMaxPPNodeCount}\n" .
421 "Post-expand include size: {$this->mIncludeSizes['post-expand']}/$max bytes\n" .
422 "Template argument size: {$this->mIncludeSizes['arg']}/$max bytes\n".
423 $PFreport;
424 wfRunHooks( 'ParserLimitReport', array( $this, &$limitReport ) );
425 $text .= "\n<!-- \n$limitReport-->\n";
426 }
427 $this->mOutput->setText( $text );
428 $this->mRevisionId = $oldRevisionId;
429 $this->mRevisionTimestamp = $oldRevisionTimestamp;
430 wfProfileOut( $fname );
431 wfProfileOut( __METHOD__ );
432
433 return $this->mOutput;
434 }
435
436 /**
437 * Recursive parser entry point that can be called from an extension tag
438 * hook.
439 */
440 function recursiveTagParse( $text ) {
441 wfProfileIn( __METHOD__ );
442 wfRunHooks( 'ParserBeforeStrip', array( &$this, &$text, &$this->mStripState ) );
443 wfRunHooks( 'ParserAfterStrip', array( &$this, &$text, &$this->mStripState ) );
444 $text = $this->internalParse( $text );
445 wfProfileOut( __METHOD__ );
446 return $text;
447 }
448
449 /**
450 * Expand templates and variables in the text, producing valid, static wikitext.
451 * Also removes comments.
452 */
453 function preprocess( $text, $title, $options, $revid = null ) {
454 wfProfileIn( __METHOD__ );
455 $this->clearState();
456 $this->setOutputType( self::OT_PREPROCESS );
457 $this->mOptions = $options;
458 $this->setTitle( $title );
459 if( $revid !== null ) {
460 $this->mRevisionId = $revid;
461 }
462 wfRunHooks( 'ParserBeforeStrip', array( &$this, &$text, &$this->mStripState ) );
463 wfRunHooks( 'ParserAfterStrip', array( &$this, &$text, &$this->mStripState ) );
464 $text = $this->replaceVariables( $text );
465 $text = $this->mStripState->unstripBoth( $text );
466 wfProfileOut( __METHOD__ );
467 return $text;
468 }
469
470 /**
471 * Get a random string
472 *
473 * @private
474 * @static
475 */
476 function getRandomString() {
477 return dechex(mt_rand(0, 0x7fffffff)) . dechex(mt_rand(0, 0x7fffffff));
478 }
479
480 function &getTitle() { return $this->mTitle; }
481 function getOptions() { return $this->mOptions; }
482 function getRevisionId() { return $this->mRevisionId; }
483 function getOutput() { return $this->mOutput; }
484 function nextLinkID() { return $this->mLinkID++; }
485
486 function getFunctionLang() {
487 global $wgLang, $wgContLang;
488
489 $target = $this->mOptions->getTargetLanguage();
490 if ( $target !== null ) {
491 return $target;
492 } else {
493 return $this->mOptions->getInterfaceMessage() ? $wgLang : $wgContLang;
494 }
495 }
496
497 /**
498 * Get a preprocessor object
499 */
500 function getPreprocessor() {
501 if ( !isset( $this->mPreprocessor ) ) {
502 $class = $this->mPreprocessorClass;
503 $this->mPreprocessor = new $class( $this );
504 }
505 return $this->mPreprocessor;
506 }
507
508 /**
509 * Replaces all occurrences of HTML-style comments and the given tags
510 * in the text with a random marker and returns the next text. The output
511 * parameter $matches will be an associative array filled with data in
512 * the form:
513 * 'UNIQ-xxxxx' => array(
514 * 'element',
515 * 'tag content',
516 * array( 'param' => 'x' ),
517 * '<element param="x">tag content</element>' ) )
518 *
519 * @param $elements list of element names. Comments are always extracted.
520 * @param $text Source text string.
521 * @param $uniq_prefix
522 *
523 * @public
524 * @static
525 */
526 function extractTagsAndParams($elements, $text, &$matches, $uniq_prefix = ''){
527 static $n = 1;
528 $stripped = '';
529 $matches = array();
530
531 $taglist = implode( '|', $elements );
532 $start = "/<($taglist)(\\s+[^>]*?|\\s*?)(\/?>)|<(!--)/i";
533
534 while ( '' != $text ) {
535 $p = preg_split( $start, $text, 2, PREG_SPLIT_DELIM_CAPTURE );
536 $stripped .= $p[0];
537 if( count( $p ) < 5 ) {
538 break;
539 }
540 if( count( $p ) > 5 ) {
541 // comment
542 $element = $p[4];
543 $attributes = '';
544 $close = '';
545 $inside = $p[5];
546 } else {
547 // tag
548 $element = $p[1];
549 $attributes = $p[2];
550 $close = $p[3];
551 $inside = $p[4];
552 }
553
554 $marker = "$uniq_prefix-$element-" . sprintf('%08X', $n++) . self::MARKER_SUFFIX;
555 $stripped .= $marker;
556
557 if ( $close === '/>' ) {
558 // Empty element tag, <tag />
559 $content = null;
560 $text = $inside;
561 $tail = null;
562 } else {
563 if( $element === '!--' ) {
564 $end = '/(-->)/';
565 } else {
566 $end = "/(<\\/$element\\s*>)/i";
567 }
568 $q = preg_split( $end, $inside, 2, PREG_SPLIT_DELIM_CAPTURE );
569 $content = $q[0];
570 if( count( $q ) < 3 ) {
571 # No end tag -- let it run out to the end of the text.
572 $tail = '';
573 $text = '';
574 } else {
575 $tail = $q[1];
576 $text = $q[2];
577 }
578 }
579
580 $matches[$marker] = array( $element,
581 $content,
582 Sanitizer::decodeTagAttributes( $attributes ),
583 "<$element$attributes$close$content$tail" );
584 }
585 return $stripped;
586 }
587
588 /**
589 * Get a list of strippable XML-like elements
590 */
591 function getStripList() {
592 global $wgRawHtml;
593 $elements = $this->mStripList;
594 if( $wgRawHtml ) {
595 $elements[] = 'html';
596 }
597 if( $this->mOptions->getUseTeX() ) {
598 $elements[] = 'math';
599 }
600 return $elements;
601 }
602
603 /**
604 * @deprecated use replaceVariables
605 */
606 function strip( $text, $state, $stripcomments = false , $dontstrip = array () ) {
607 return $text;
608 }
609
610 /**
611 * Restores pre, math, and other extensions removed by strip()
612 *
613 * always call unstripNoWiki() after this one
614 * @private
615 * @deprecated use $this->mStripState->unstrip()
616 */
617 function unstrip( $text, $state ) {
618 return $state->unstripGeneral( $text );
619 }
620
621 /**
622 * Always call this after unstrip() to preserve the order
623 *
624 * @private
625 * @deprecated use $this->mStripState->unstrip()
626 */
627 function unstripNoWiki( $text, $state ) {
628 return $state->unstripNoWiki( $text );
629 }
630
631 /**
632 * @deprecated use $this->mStripState->unstripBoth()
633 */
634 function unstripForHTML( $text ) {
635 return $this->mStripState->unstripBoth( $text );
636 }
637
638 /**
639 * Add an item to the strip state
640 * Returns the unique tag which must be inserted into the stripped text
641 * The tag will be replaced with the original text in unstrip()
642 *
643 * @private
644 */
645 function insertStripItem( $text ) {
646 $rnd = "{$this->mUniqPrefix}-item-{$this->mMarkerIndex}-" . self::MARKER_SUFFIX;
647 $this->mMarkerIndex++;
648 $this->mStripState->general->setPair( $rnd, $text );
649 return $rnd;
650 }
651
652 /**
653 * Interface with html tidy, used if $wgUseTidy = true.
654 * If tidy isn't able to correct the markup, the original will be
655 * returned in all its glory with a warning comment appended.
656 *
657 * Either the external tidy program or the in-process tidy extension
658 * will be used depending on availability. Override the default
659 * $wgTidyInternal setting to disable the internal if it's not working.
660 *
661 * @param string $text Hideous HTML input
662 * @return string Corrected HTML output
663 * @public
664 * @static
665 */
666 function tidy( $text ) {
667 global $wgTidyInternal;
668
669 $wrappedtext = '<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"'.
670 ' "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"><html>'.
671 '<head><title>test</title></head><body>'.$text.'</body></html>';
672
673 # Tidy is known to clobber tabs; convert 'em to entities
674 $wrappedtext = str_replace("\t", '&#9;', $wrappedtext);
675
676 if( $wgTidyInternal ) {
677 $correctedtext = self::internalTidy( $wrappedtext );
678 } else {
679 $correctedtext = self::externalTidy( $wrappedtext );
680 }
681 if( is_null( $correctedtext ) ) {
682 wfDebug( "Tidy error detected!\n" );
683 return $text . "\n<!-- Tidy found serious XHTML errors -->\n";
684 }
685
686 # Convert the tabs back from entities
687 $correctedtext = str_replace('&#9;', "\t", $correctedtext);
688
689 return $correctedtext;
690 }
691
692 /**
693 * Spawn an external HTML tidy process and get corrected markup back from it.
694 *
695 * @private
696 * @static
697 */
698 function externalTidy( $text ) {
699 global $wgTidyConf, $wgTidyBin, $wgTidyOpts;
700 wfProfileIn( __METHOD__ );
701
702 $cleansource = '';
703 $opts = ' -utf8';
704
705 $descriptorspec = array(
706 0 => array('pipe', 'r'),
707 1 => array('pipe', 'w'),
708 2 => array('file', wfGetNull(), 'a')
709 );
710 $pipes = array();
711 if( function_exists('proc_open') ) {
712 $process = proc_open("$wgTidyBin -config $wgTidyConf $wgTidyOpts$opts", $descriptorspec, $pipes);
713 if (is_resource($process)) {
714 // Theoretically, this style of communication could cause a deadlock
715 // here. If the stdout buffer fills up, then writes to stdin could
716 // block. This doesn't appear to happen with tidy, because tidy only
717 // writes to stdout after it's finished reading from stdin. Search
718 // for tidyParseStdin and tidySaveStdout in console/tidy.c
719 fwrite($pipes[0], $text);
720 fclose($pipes[0]);
721 while (!feof($pipes[1])) {
722 $cleansource .= fgets($pipes[1], 1024);
723 }
724 fclose($pipes[1]);
725 proc_close($process);
726 }
727 }
728
729 wfProfileOut( __METHOD__ );
730
731 if( $cleansource == '' && $text != '') {
732 // Some kind of error happened, so we couldn't get the corrected text.
733 // Just give up; we'll use the source text and append a warning.
734 return null;
735 } else {
736 return $cleansource;
737 }
738 }
739
740 /**
741 * Use the HTML tidy PECL extension to use the tidy library in-process,
742 * saving the overhead of spawning a new process.
743 *
744 * 'pear install tidy' should be able to compile the extension module.
745 *
746 * @private
747 * @static
748 */
749 function internalTidy( $text ) {
750 global $wgTidyConf, $IP, $wgDebugTidy;
751 wfProfileIn( __METHOD__ );
752
753 $tidy = new tidy;
754 $tidy->parseString( $text, $wgTidyConf, 'utf8' );
755 $tidy->cleanRepair();
756 if( $tidy->getStatus() == 2 ) {
757 // 2 is magic number for fatal error
758 // http://www.php.net/manual/en/function.tidy-get-status.php
759 $cleansource = null;
760 } else {
761 $cleansource = tidy_get_output( $tidy );
762 }
763 if ( $wgDebugTidy && $tidy->getStatus() > 0 ) {
764 $cleansource .= "<!--\nTidy reports:\n" .
765 str_replace( '-->', '--&gt;', $tidy->errorBuffer ) .
766 "\n-->";
767 }
768
769 wfProfileOut( __METHOD__ );
770 return $cleansource;
771 }
772
773 /**
774 * parse the wiki syntax used to render tables
775 *
776 * @private
777 */
778 function doTableStuff ( $text ) {
779 wfProfileIn( __METHOD__ );
780
781 $lines = StringUtils::explode( "\n", $text );
782 $out = '';
783 $td_history = array (); // Is currently a td tag open?
784 $last_tag_history = array (); // Save history of last lag activated (td, th or caption)
785 $tr_history = array (); // Is currently a tr tag open?
786 $tr_attributes = array (); // history of tr attributes
787 $has_opened_tr = array(); // Did this table open a <tr> element?
788 $indent_level = 0; // indent level of the table
789
790 foreach ( $lines as $outLine ) {
791 $line = trim( $outLine );
792
793 if( $line == '' ) { // empty line, go to next line
794 $out .= $outLine."\n";
795 continue;
796 }
797 $first_character = $line[0];
798 $matches = array();
799
800 if ( preg_match( '/^(:*)\{\|(.*)$/', $line , $matches ) ) {
801 // First check if we are starting a new table
802 $indent_level = strlen( $matches[1] );
803
804 $attributes = $this->mStripState->unstripBoth( $matches[2] );
805 $attributes = Sanitizer::fixTagAttributes ( $attributes , 'table' );
806
807 $outLine = str_repeat( '<dl><dd>' , $indent_level ) . "<table{$attributes}>";
808 array_push ( $td_history , false );
809 array_push ( $last_tag_history , '' );
810 array_push ( $tr_history , false );
811 array_push ( $tr_attributes , '' );
812 array_push ( $has_opened_tr , false );
813 } else if ( count ( $td_history ) == 0 ) {
814 // Don't do any of the following
815 $out .= $outLine."\n";
816 continue;
817 } else if ( substr ( $line , 0 , 2 ) === '|}' ) {
818 // We are ending a table
819 $line = '</table>' . substr ( $line , 2 );
820 $last_tag = array_pop ( $last_tag_history );
821
822 if ( !array_pop ( $has_opened_tr ) ) {
823 $line = "<tr><td></td></tr>{$line}";
824 }
825
826 if ( array_pop ( $tr_history ) ) {
827 $line = "</tr>{$line}";
828 }
829
830 if ( array_pop ( $td_history ) ) {
831 $line = "</{$last_tag}>{$line}";
832 }
833 array_pop ( $tr_attributes );
834 $outLine = $line . str_repeat( '</dd></dl>' , $indent_level );
835 } else if ( substr ( $line , 0 , 2 ) === '|-' ) {
836 // Now we have a table row
837 $line = preg_replace( '#^\|-+#', '', $line );
838
839 // Whats after the tag is now only attributes
840 $attributes = $this->mStripState->unstripBoth( $line );
841 $attributes = Sanitizer::fixTagAttributes ( $attributes , 'tr' );
842 array_pop ( $tr_attributes );
843 array_push ( $tr_attributes , $attributes );
844
845 $line = '';
846 $last_tag = array_pop ( $last_tag_history );
847 array_pop ( $has_opened_tr );
848 array_push ( $has_opened_tr , true );
849
850 if ( array_pop ( $tr_history ) ) {
851 $line = '</tr>';
852 }
853
854 if ( array_pop ( $td_history ) ) {
855 $line = "</{$last_tag}>{$line}";
856 }
857
858 $outLine = $line;
859 array_push ( $tr_history , false );
860 array_push ( $td_history , false );
861 array_push ( $last_tag_history , '' );
862 }
863 else if ( $first_character === '|' || $first_character === '!' || substr ( $line , 0 , 2 ) === '|+' ) {
864 // This might be cell elements, td, th or captions
865 if ( substr ( $line , 0 , 2 ) === '|+' ) {
866 $first_character = '+';
867 $line = substr ( $line , 1 );
868 }
869
870 $line = substr ( $line , 1 );
871
872 if ( $first_character === '!' ) {
873 $line = str_replace ( '!!' , '||' , $line );
874 }
875
876 // Split up multiple cells on the same line.
877 // FIXME : This can result in improper nesting of tags processed
878 // by earlier parser steps, but should avoid splitting up eg
879 // attribute values containing literal "||".
880 $cells = StringUtils::explodeMarkup( '||' , $line );
881
882 $outLine = '';
883
884 // Loop through each table cell
885 foreach ( $cells as $cell )
886 {
887 $previous = '';
888 if ( $first_character !== '+' )
889 {
890 $tr_after = array_pop ( $tr_attributes );
891 if ( !array_pop ( $tr_history ) ) {
892 $previous = "<tr{$tr_after}>\n";
893 }
894 array_push ( $tr_history , true );
895 array_push ( $tr_attributes , '' );
896 array_pop ( $has_opened_tr );
897 array_push ( $has_opened_tr , true );
898 }
899
900 $last_tag = array_pop ( $last_tag_history );
901
902 if ( array_pop ( $td_history ) ) {
903 $previous = "</{$last_tag}>{$previous}";
904 }
905
906 if ( $first_character === '|' ) {
907 $last_tag = 'td';
908 } else if ( $first_character === '!' ) {
909 $last_tag = 'th';
910 } else if ( $first_character === '+' ) {
911 $last_tag = 'caption';
912 } else {
913 $last_tag = '';
914 }
915
916 array_push ( $last_tag_history , $last_tag );
917
918 // A cell could contain both parameters and data
919 $cell_data = explode ( '|' , $cell , 2 );
920
921 // Bug 553: Note that a '|' inside an invalid link should not
922 // be mistaken as delimiting cell parameters
923 if ( strpos( $cell_data[0], '[[' ) !== false ) {
924 $cell = "{$previous}<{$last_tag}>{$cell}";
925 } else if ( count ( $cell_data ) == 1 )
926 $cell = "{$previous}<{$last_tag}>{$cell_data[0]}";
927 else {
928 $attributes = $this->mStripState->unstripBoth( $cell_data[0] );
929 $attributes = Sanitizer::fixTagAttributes( $attributes , $last_tag );
930 $cell = "{$previous}<{$last_tag}{$attributes}>{$cell_data[1]}";
931 }
932
933 $outLine .= $cell;
934 array_push ( $td_history , true );
935 }
936 }
937 $out .= $outLine . "\n";
938 }
939
940 // Closing open td, tr && table
941 while ( count ( $td_history ) > 0 )
942 {
943 if ( array_pop ( $td_history ) ) {
944 $out .= "</td>\n";
945 }
946 if ( array_pop ( $tr_history ) ) {
947 $out .= "</tr>\n";
948 }
949 if ( !array_pop ( $has_opened_tr ) ) {
950 $out .= "<tr><td></td></tr>\n" ;
951 }
952
953 $out .= "</table>\n";
954 }
955
956 // Remove trailing line-ending (b/c)
957 if ( substr( $out, -1 ) === "\n" ) {
958 $out = substr( $out, 0, -1 );
959 }
960
961 // special case: don't return empty table
962 if( $out === "<table>\n<tr><td></td></tr>\n</table>" ) {
963 $out = '';
964 }
965
966 wfProfileOut( __METHOD__ );
967
968 return $out;
969 }
970
971 /**
972 * Helper function for parse() that transforms wiki markup into
973 * HTML. Only called for $mOutputType == self::OT_HTML.
974 *
975 * @private
976 */
977 function internalParse( $text ) {
978 $isMain = true;
979 wfProfileIn( __METHOD__ );
980
981 # Hook to suspend the parser in this state
982 if ( !wfRunHooks( 'ParserBeforeInternalParse', array( &$this, &$text, &$this->mStripState ) ) ) {
983 wfProfileOut( __METHOD__ );
984 return $text ;
985 }
986
987 $text = $this->replaceVariables( $text );
988 $text = Sanitizer::removeHTMLtags( $text, array( &$this, 'attributeStripCallback' ), false, array_keys( $this->mTransparentTagHooks ) );
989 wfRunHooks( 'InternalParseBeforeLinks', array( &$this, &$text, &$this->mStripState ) );
990
991 // Tables need to come after variable replacement for things to work
992 // properly; putting them before other transformations should keep
993 // exciting things like link expansions from showing up in surprising
994 // places.
995 $text = $this->doTableStuff( $text );
996
997 $text = preg_replace( '/(^|\n)-----*/', '\\1<hr />', $text );
998
999 $text = $this->doDoubleUnderscore( $text );
1000 $text = $this->doHeadings( $text );
1001 if($this->mOptions->getUseDynamicDates()) {
1002 $df = DateFormatter::getInstance();
1003 $text = $df->reformat( $this->mOptions->getDateFormat(), $text );
1004 }
1005 $text = $this->doAllQuotes( $text );
1006 $text = $this->replaceInternalLinks( $text );
1007 $text = $this->replaceExternalLinks( $text );
1008
1009 # replaceInternalLinks may sometimes leave behind
1010 # absolute URLs, which have to be masked to hide them from replaceExternalLinks
1011 $text = str_replace($this->mUniqPrefix."NOPARSE", "", $text);
1012
1013 $text = $this->doMagicLinks( $text );
1014 $text = $this->formatHeadings( $text, $isMain );
1015
1016 wfProfileOut( __METHOD__ );
1017 return $text;
1018 }
1019
1020 /**
1021 * Replace special strings like "ISBN xxx" and "RFC xxx" with
1022 * magic external links.
1023 *
1024 * DML
1025 * @private
1026 */
1027 function doMagicLinks( $text ) {
1028 wfProfileIn( __METHOD__ );
1029 $prots = $this->mUrlProtocols;
1030 $urlChar = self::EXT_LINK_URL_CLASS;
1031 $text = preg_replace_callback(
1032 '!(?: # Start cases
1033 (<a.*?</a>) | # m[1]: Skip link text
1034 (<.*?>) | # m[2]: Skip stuff inside HTML elements' . "
1035 (\\b(?:$prots)$urlChar+) | # m[3]: Free external links" . '
1036 (?:RFC|PMID)\s+([0-9]+) | # m[4]: RFC or PMID, capture number
1037 ISBN\s+(\b # m[5]: ISBN, capture number
1038 (?: 97[89] [\ \-]? )? # optional 13-digit ISBN prefix
1039 (?: [0-9] [\ \-]? ){9} # 9 digits with opt. delimiters
1040 [0-9Xx] # check digit
1041 \b)
1042 )!x', array( &$this, 'magicLinkCallback' ), $text );
1043 wfProfileOut( __METHOD__ );
1044 return $text;
1045 }
1046
1047 function magicLinkCallback( $m ) {
1048 if ( isset( $m[1] ) && strval( $m[1] ) !== '' ) {
1049 # Skip anchor
1050 return $m[0];
1051 } elseif ( isset( $m[2] ) && strval( $m[2] ) !== '' ) {
1052 # Skip HTML element
1053 return $m[0];
1054 } elseif ( isset( $m[3] ) && strval( $m[3] ) !== '' ) {
1055 # Free external link
1056 return $this->makeFreeExternalLink( $m[0] );
1057 } elseif ( isset( $m[4] ) && strval( $m[4] ) !== '' ) {
1058 # RFC or PMID
1059 if ( substr( $m[0], 0, 3 ) === 'RFC' ) {
1060 $keyword = 'RFC';
1061 $urlmsg = 'rfcurl';
1062 $id = $m[4];
1063 } elseif ( substr( $m[0], 0, 4 ) === 'PMID' ) {
1064 $keyword = 'PMID';
1065 $urlmsg = 'pubmedurl';
1066 $id = $m[4];
1067 } else {
1068 throw new MWException( __METHOD__.': unrecognised match type "' .
1069 substr($m[0], 0, 20 ) . '"' );
1070 }
1071 $url = wfMsg( $urlmsg, $id);
1072 $sk = $this->mOptions->getSkin();
1073 $la = $sk->getExternalLinkAttributes( $url, $keyword.$id );
1074 return "<a href=\"{$url}\"{$la}>{$keyword} {$id}</a>";
1075 } elseif ( isset( $m[5] ) && strval( $m[5] ) !== '' ) {
1076 # ISBN
1077 $isbn = $m[5];
1078 $num = strtr( $isbn, array(
1079 '-' => '',
1080 ' ' => '',
1081 'x' => 'X',
1082 ));
1083 $titleObj = SpecialPage::getTitleFor( 'Booksources', $num );
1084 return'<a href="' .
1085 $titleObj->escapeLocalUrl() .
1086 "\" class=\"internal\">ISBN $isbn</a>";
1087 } else {
1088 return $m[0];
1089 }
1090 }
1091
1092 /**
1093 * Make a free external link, given a user-supplied URL
1094 * @return HTML
1095 * @private
1096 */
1097 function makeFreeExternalLink( $url ) {
1098 global $wgContLang;
1099 wfProfileIn( __METHOD__ );
1100
1101 $sk = $this->mOptions->getSkin();
1102 $trail = '';
1103
1104 # The characters '<' and '>' (which were escaped by
1105 # removeHTMLtags()) should not be included in
1106 # URLs, per RFC 2396.
1107 $m2 = array();
1108 if (preg_match('/&(lt|gt);/', $url, $m2, PREG_OFFSET_CAPTURE)) {
1109 $trail = substr($url, $m2[0][1]) . $trail;
1110 $url = substr($url, 0, $m2[0][1]);
1111 }
1112
1113 # Move trailing punctuation to $trail
1114 $sep = ',;\.:!?';
1115 # If there is no left bracket, then consider right brackets fair game too
1116 if ( strpos( $url, '(' ) === false ) {
1117 $sep .= ')';
1118 }
1119
1120 $numSepChars = strspn( strrev( $url ), $sep );
1121 if ( $numSepChars ) {
1122 $trail = substr( $url, -$numSepChars ) . $trail;
1123 $url = substr( $url, 0, -$numSepChars );
1124 }
1125
1126 $url = Sanitizer::cleanUrl( $url );
1127
1128 # Is this an external image?
1129 $text = $this->maybeMakeExternalImage( $url );
1130 if ( $text === false ) {
1131 # Not an image, make a link
1132 $text = $sk->makeExternalLink( $url, $wgContLang->markNoConversion($url), true, 'free',
1133 $this->getExternalLinkAttribs() );
1134 # Register it in the output object...
1135 # Replace unnecessary URL escape codes with their equivalent characters
1136 $pasteurized = self::replaceUnusualEscapes( $url );
1137 $this->mOutput->addExternalLink( $pasteurized );
1138 }
1139 wfProfileOut( __METHOD__ );
1140 return $text . $trail;
1141 }
1142
1143
1144 /**
1145 * Parse headers and return html
1146 *
1147 * @private
1148 */
1149 function doHeadings( $text ) {
1150 wfProfileIn( __METHOD__ );
1151 for ( $i = 6; $i >= 1; --$i ) {
1152 $h = str_repeat( '=', $i );
1153 $text = preg_replace( "/^$h(.+)$h\\s*$/m",
1154 "<h$i>\\1</h$i>", $text );
1155 }
1156 wfProfileOut( __METHOD__ );
1157 return $text;
1158 }
1159
1160 /**
1161 * Replace single quotes with HTML markup
1162 * @private
1163 * @return string the altered text
1164 */
1165 function doAllQuotes( $text ) {
1166 wfProfileIn( __METHOD__ );
1167 $outtext = '';
1168 $lines = StringUtils::explode( "\n", $text );
1169 foreach ( $lines as $line ) {
1170 $outtext .= $this->doQuotes( $line ) . "\n";
1171 }
1172 $outtext = substr($outtext, 0,-1);
1173 wfProfileOut( __METHOD__ );
1174 return $outtext;
1175 }
1176
1177 /**
1178 * Helper function for doAllQuotes()
1179 */
1180 public function doQuotes( $text ) {
1181 $arr = preg_split( "/(''+)/", $text, -1, PREG_SPLIT_DELIM_CAPTURE );
1182 if ( count( $arr ) == 1 )
1183 return $text;
1184 else
1185 {
1186 # First, do some preliminary work. This may shift some apostrophes from
1187 # being mark-up to being text. It also counts the number of occurrences
1188 # of bold and italics mark-ups.
1189 $i = 0;
1190 $numbold = 0;
1191 $numitalics = 0;
1192 foreach ( $arr as $r )
1193 {
1194 if ( ( $i % 2 ) == 1 )
1195 {
1196 # If there are ever four apostrophes, assume the first is supposed to
1197 # be text, and the remaining three constitute mark-up for bold text.
1198 if ( strlen( $arr[$i] ) == 4 )
1199 {
1200 $arr[$i-1] .= "'";
1201 $arr[$i] = "'''";
1202 }
1203 # If there are more than 5 apostrophes in a row, assume they're all
1204 # text except for the last 5.
1205 else if ( strlen( $arr[$i] ) > 5 )
1206 {
1207 $arr[$i-1] .= str_repeat( "'", strlen( $arr[$i] ) - 5 );
1208 $arr[$i] = "'''''";
1209 }
1210 # Count the number of occurrences of bold and italics mark-ups.
1211 # We are not counting sequences of five apostrophes.
1212 if ( strlen( $arr[$i] ) == 2 ) { $numitalics++; }
1213 else if ( strlen( $arr[$i] ) == 3 ) { $numbold++; }
1214 else if ( strlen( $arr[$i] ) == 5 ) { $numitalics++; $numbold++; }
1215 }
1216 $i++;
1217 }
1218
1219 # If there is an odd number of both bold and italics, it is likely
1220 # that one of the bold ones was meant to be an apostrophe followed
1221 # by italics. Which one we cannot know for certain, but it is more
1222 # likely to be one that has a single-letter word before it.
1223 if ( ( $numbold % 2 == 1 ) && ( $numitalics % 2 == 1 ) )
1224 {
1225 $i = 0;
1226 $firstsingleletterword = -1;
1227 $firstmultiletterword = -1;
1228 $firstspace = -1;
1229 foreach ( $arr as $r )
1230 {
1231 if ( ( $i % 2 == 1 ) and ( strlen( $r ) == 3 ) )
1232 {
1233 $x1 = substr ($arr[$i-1], -1);
1234 $x2 = substr ($arr[$i-1], -2, 1);
1235 if ($x1 === ' ') {
1236 if ($firstspace == -1) $firstspace = $i;
1237 } else if ($x2 === ' ') {
1238 if ($firstsingleletterword == -1) $firstsingleletterword = $i;
1239 } else {
1240 if ($firstmultiletterword == -1) $firstmultiletterword = $i;
1241 }
1242 }
1243 $i++;
1244 }
1245
1246 # If there is a single-letter word, use it!
1247 if ($firstsingleletterword > -1)
1248 {
1249 $arr [ $firstsingleletterword ] = "''";
1250 $arr [ $firstsingleletterword-1 ] .= "'";
1251 }
1252 # If not, but there's a multi-letter word, use that one.
1253 else if ($firstmultiletterword > -1)
1254 {
1255 $arr [ $firstmultiletterword ] = "''";
1256 $arr [ $firstmultiletterword-1 ] .= "'";
1257 }
1258 # ... otherwise use the first one that has neither.
1259 # (notice that it is possible for all three to be -1 if, for example,
1260 # there is only one pentuple-apostrophe in the line)
1261 else if ($firstspace > -1)
1262 {
1263 $arr [ $firstspace ] = "''";
1264 $arr [ $firstspace-1 ] .= "'";
1265 }
1266 }
1267
1268 # Now let's actually convert our apostrophic mush to HTML!
1269 $output = '';
1270 $buffer = '';
1271 $state = '';
1272 $i = 0;
1273 foreach ($arr as $r)
1274 {
1275 if (($i % 2) == 0)
1276 {
1277 if ($state === 'both')
1278 $buffer .= $r;
1279 else
1280 $output .= $r;
1281 }
1282 else
1283 {
1284 if (strlen ($r) == 2)
1285 {
1286 if ($state === 'i')
1287 { $output .= '</i>'; $state = ''; }
1288 else if ($state === 'bi')
1289 { $output .= '</i>'; $state = 'b'; }
1290 else if ($state === 'ib')
1291 { $output .= '</b></i><b>'; $state = 'b'; }
1292 else if ($state === 'both')
1293 { $output .= '<b><i>'.$buffer.'</i>'; $state = 'b'; }
1294 else # $state can be 'b' or ''
1295 { $output .= '<i>'; $state .= 'i'; }
1296 }
1297 else if (strlen ($r) == 3)
1298 {
1299 if ($state === 'b')
1300 { $output .= '</b>'; $state = ''; }
1301 else if ($state === 'bi')
1302 { $output .= '</i></b><i>'; $state = 'i'; }
1303 else if ($state === 'ib')
1304 { $output .= '</b>'; $state = 'i'; }
1305 else if ($state === 'both')
1306 { $output .= '<i><b>'.$buffer.'</b>'; $state = 'i'; }
1307 else # $state can be 'i' or ''
1308 { $output .= '<b>'; $state .= 'b'; }
1309 }
1310 else if (strlen ($r) == 5)
1311 {
1312 if ($state === 'b')
1313 { $output .= '</b><i>'; $state = 'i'; }
1314 else if ($state === 'i')
1315 { $output .= '</i><b>'; $state = 'b'; }
1316 else if ($state === 'bi')
1317 { $output .= '</i></b>'; $state = ''; }
1318 else if ($state === 'ib')
1319 { $output .= '</b></i>'; $state = ''; }
1320 else if ($state === 'both')
1321 { $output .= '<i><b>'.$buffer.'</b></i>'; $state = ''; }
1322 else # ($state == '')
1323 { $buffer = ''; $state = 'both'; }
1324 }
1325 }
1326 $i++;
1327 }
1328 # Now close all remaining tags. Notice that the order is important.
1329 if ($state === 'b' || $state === 'ib')
1330 $output .= '</b>';
1331 if ($state === 'i' || $state === 'bi' || $state === 'ib')
1332 $output .= '</i>';
1333 if ($state === 'bi')
1334 $output .= '</b>';
1335 # There might be lonely ''''', so make sure we have a buffer
1336 if ($state === 'both' && $buffer)
1337 $output .= '<b><i>'.$buffer.'</i></b>';
1338 return $output;
1339 }
1340 }
1341
1342 /**
1343 * Replace external links (REL)
1344 *
1345 * Note: this is all very hackish and the order of execution matters a lot.
1346 * Make sure to run maintenance/parserTests.php if you change this code.
1347 *
1348 * @private
1349 */
1350 function replaceExternalLinks( $text ) {
1351 global $wgContLang;
1352 wfProfileIn( __METHOD__ );
1353
1354 $sk = $this->mOptions->getSkin();
1355
1356 $bits = preg_split( $this->mExtLinkBracketedRegex, $text, -1, PREG_SPLIT_DELIM_CAPTURE );
1357 $s = array_shift( $bits );
1358
1359 $i = 0;
1360 while ( $i<count( $bits ) ) {
1361 $url = $bits[$i++];
1362 $protocol = $bits[$i++];
1363 $text = $bits[$i++];
1364 $trail = $bits[$i++];
1365
1366 # The characters '<' and '>' (which were escaped by
1367 # removeHTMLtags()) should not be included in
1368 # URLs, per RFC 2396.
1369 $m2 = array();
1370 if (preg_match('/&(lt|gt);/', $url, $m2, PREG_OFFSET_CAPTURE)) {
1371 $text = substr($url, $m2[0][1]) . ' ' . $text;
1372 $url = substr($url, 0, $m2[0][1]);
1373 }
1374
1375 # If the link text is an image URL, replace it with an <img> tag
1376 # This happened by accident in the original parser, but some people used it extensively
1377 $img = $this->maybeMakeExternalImage( $text );
1378 if ( $img !== false ) {
1379 $text = $img;
1380 }
1381
1382 $dtrail = '';
1383
1384 # Set linktype for CSS - if URL==text, link is essentially free
1385 $linktype = ($text === $url) ? 'free' : 'text';
1386
1387 # No link text, e.g. [http://domain.tld/some.link]
1388 if ( $text == '' ) {
1389 # Autonumber if allowed. See bug #5918
1390 if ( strpos( wfUrlProtocols(), substr($protocol, 0, strpos($protocol, ':')) ) !== false ) {
1391 $langObj = $this->getFunctionLang();
1392 $text = '[' . $langObj->formatNum( ++$this->mAutonumber ) . ']';
1393 $linktype = 'autonumber';
1394 } else {
1395 # Otherwise just use the URL
1396 $text = htmlspecialchars( $url );
1397 $linktype = 'free';
1398 }
1399 } else {
1400 # Have link text, e.g. [http://domain.tld/some.link text]s
1401 # Check for trail
1402 list( $dtrail, $trail ) = Linker::splitTrail( $trail );
1403 }
1404
1405 $text = $wgContLang->markNoConversion($text);
1406
1407 $url = Sanitizer::cleanUrl( $url );
1408
1409 if ( $this->mOptions->mExternalLinkTarget ) {
1410 $attribs = array( 'target' => $this->mOptions->mExternalLinkTarget );
1411 } else {
1412 $attribs = array();
1413 }
1414
1415 # Use the encoded URL
1416 # This means that users can paste URLs directly into the text
1417 # Funny characters like &ouml; aren't valid in URLs anyway
1418 # This was changed in August 2004
1419 $s .= $sk->makeExternalLink( $url, $text, false, $linktype, $this->getExternalLinkAttribs() )
1420 . $dtrail . $trail;
1421
1422 # Register link in the output object.
1423 # Replace unnecessary URL escape codes with the referenced character
1424 # This prevents spammers from hiding links from the filters
1425 $pasteurized = self::replaceUnusualEscapes( $url );
1426 $this->mOutput->addExternalLink( $pasteurized );
1427 }
1428
1429 wfProfileOut( __METHOD__ );
1430 return $s;
1431 }
1432
1433 function getExternalLinkAttribs() {
1434 $attribs = array();
1435 global $wgNoFollowLinks, $wgNoFollowNsExceptions;
1436 $ns = $this->mTitle->getNamespace();
1437 if( $wgNoFollowLinks && !in_array($ns, $wgNoFollowNsExceptions) ) {
1438 $attribs['rel'] = 'nofollow';
1439 }
1440 if ( $this->mOptions->getExternalLinkTarget() ) {
1441 $attribs['target'] = $this->mOptions->getExternalLinkTarget();
1442 }
1443 return $attribs;
1444 }
1445
1446
1447 /**
1448 * Replace unusual URL escape codes with their equivalent characters
1449 * @param string
1450 * @return string
1451 * @static
1452 * @todo This can merge genuinely required bits in the path or query string,
1453 * breaking legit URLs. A proper fix would treat the various parts of
1454 * the URL differently; as a workaround, just use the output for
1455 * statistical records, not for actual linking/output.
1456 */
1457 static function replaceUnusualEscapes( $url ) {
1458 return preg_replace_callback( '/%[0-9A-Fa-f]{2}/',
1459 array( __CLASS__, 'replaceUnusualEscapesCallback' ), $url );
1460 }
1461
1462 /**
1463 * Callback function used in replaceUnusualEscapes().
1464 * Replaces unusual URL escape codes with their equivalent character
1465 * @static
1466 * @private
1467 */
1468 private static function replaceUnusualEscapesCallback( $matches ) {
1469 $char = urldecode( $matches[0] );
1470 $ord = ord( $char );
1471 // Is it an unsafe or HTTP reserved character according to RFC 1738?
1472 if ( $ord > 32 && $ord < 127 && strpos( '<>"#{}|\^~[]`;/?', $char ) === false ) {
1473 // No, shouldn't be escaped
1474 return $char;
1475 } else {
1476 // Yes, leave it escaped
1477 return $matches[0];
1478 }
1479 }
1480
1481 /**
1482 * make an image if it's allowed, either through the global
1483 * option, through the exception, or through the on-wiki whitelist
1484 * @private
1485 */
1486 function maybeMakeExternalImage( $url ) {
1487 $sk = $this->mOptions->getSkin();
1488 $imagesfrom = $this->mOptions->getAllowExternalImagesFrom();
1489 $imagesexception = !empty($imagesfrom);
1490 $text = false;
1491 # $imagesfrom could be either a single string or an array of strings, parse out the latter
1492 if( $imagesexception && is_array( $imagesfrom ) ) {
1493 $imagematch = false;
1494 foreach( $imagesfrom as $match ) {
1495 if( strpos( $url, $match ) === 0 ) {
1496 $imagematch = true;
1497 break;
1498 }
1499 }
1500 } elseif( $imagesexception ) {
1501 $imagematch = (strpos( $url, $imagesfrom ) === 0);
1502 } else {
1503 $imagematch = false;
1504 }
1505 if ( $this->mOptions->getAllowExternalImages()
1506 || ( $imagesexception && $imagematch ) ) {
1507 if ( preg_match( self::EXT_IMAGE_REGEX, $url ) ) {
1508 # Image found
1509 $text = $sk->makeExternalImage( $url );
1510 }
1511 }
1512 if( !$text && $this->mOptions->getEnableImageWhitelist()
1513 && preg_match( self::EXT_IMAGE_REGEX, $url ) ) {
1514 $whitelist = explode( "\n", wfMsgForContent( 'external_image_whitelist' ) );
1515 foreach( $whitelist as $entry ) {
1516 # Sanitize the regex fragment, make it case-insensitive, ignore blank entries/comments
1517 if( strpos( $entry, '#' ) === 0 || $entry === '' )
1518 continue;
1519 if( preg_match( '/' . str_replace( '/', '\\/', $entry ) . '/i', $url ) ) {
1520 # Image matches a whitelist entry
1521 $text = $sk->makeExternalImage( $url );
1522 break;
1523 }
1524 }
1525 }
1526 return $text;
1527 }
1528
1529 /**
1530 * Process [[ ]] wikilinks
1531 * @return processed text
1532 *
1533 * @private
1534 */
1535 function replaceInternalLinks( $s ) {
1536 $this->mLinkHolders->merge( $this->replaceInternalLinks2( $s ) );
1537 return $s;
1538 }
1539
1540 /**
1541 * Process [[ ]] wikilinks (RIL)
1542 * @return LinkHolderArray
1543 *
1544 * @private
1545 */
1546 function replaceInternalLinks2( &$s ) {
1547 global $wgContLang;
1548
1549 wfProfileIn( __METHOD__ );
1550
1551 wfProfileIn( __METHOD__.'-setup' );
1552 static $tc = FALSE, $e1, $e1_img;
1553 # the % is needed to support urlencoded titles as well
1554 if ( !$tc ) {
1555 $tc = Title::legalChars() . '#%';
1556 # Match a link having the form [[namespace:link|alternate]]trail
1557 $e1 = "/^([{$tc}]+)(?:\\|(.+?))?]](.*)\$/sD";
1558 # Match cases where there is no "]]", which might still be images
1559 $e1_img = "/^([{$tc}]+)\\|(.*)\$/sD";
1560 }
1561
1562 $sk = $this->mOptions->getSkin();
1563 $holders = new LinkHolderArray( $this );
1564
1565 #split the entire text string on occurences of [[
1566 $a = StringUtils::explode( '[[', ' ' . $s );
1567 #get the first element (all text up to first [[), and remove the space we added
1568 $s = $a->current();
1569 $a->next();
1570 $line = $a->current(); # Workaround for broken ArrayIterator::next() that returns "void"
1571 $s = substr( $s, 1 );
1572
1573 $useLinkPrefixExtension = $wgContLang->linkPrefixExtension();
1574 $e2 = null;
1575 if ( $useLinkPrefixExtension ) {
1576 # Match the end of a line for a word that's not followed by whitespace,
1577 # e.g. in the case of 'The Arab al[[Razi]]', 'al' will be matched
1578 $e2 = wfMsgForContent( 'linkprefix' );
1579 }
1580
1581 if( is_null( $this->mTitle ) ) {
1582 wfProfileOut( __METHOD__.'-setup' );
1583 wfProfileOut( __METHOD__ );
1584 throw new MWException( __METHOD__.": \$this->mTitle is null\n" );
1585 }
1586 $nottalk = !$this->mTitle->isTalkPage();
1587
1588 if ( $useLinkPrefixExtension ) {
1589 $m = array();
1590 if ( preg_match( $e2, $s, $m ) ) {
1591 $first_prefix = $m[2];
1592 } else {
1593 $first_prefix = false;
1594 }
1595 } else {
1596 $prefix = '';
1597 }
1598
1599 if($wgContLang->hasVariants()) {
1600 $selflink = $wgContLang->convertLinkToAllVariants($this->mTitle->getPrefixedText());
1601 } else {
1602 $selflink = array($this->mTitle->getPrefixedText());
1603 }
1604 $useSubpages = $this->areSubpagesAllowed();
1605 wfProfileOut( __METHOD__.'-setup' );
1606
1607 # Loop for each link
1608 for ( ; $line !== false && $line !== null ; $a->next(), $line = $a->current() ) {
1609 # Check for excessive memory usage
1610 if ( $holders->isBig() ) {
1611 # Too big
1612 # Do the existence check, replace the link holders and clear the array
1613 $holders->replace( $s );
1614 $holders->clear();
1615 }
1616
1617 if ( $useLinkPrefixExtension ) {
1618 wfProfileIn( __METHOD__.'-prefixhandling' );
1619 if ( preg_match( $e2, $s, $m ) ) {
1620 $prefix = $m[2];
1621 $s = $m[1];
1622 } else {
1623 $prefix='';
1624 }
1625 # first link
1626 if($first_prefix) {
1627 $prefix = $first_prefix;
1628 $first_prefix = false;
1629 }
1630 wfProfileOut( __METHOD__.'-prefixhandling' );
1631 }
1632
1633 $might_be_img = false;
1634
1635 wfProfileIn( __METHOD__."-e1" );
1636 if ( preg_match( $e1, $line, $m ) ) { # page with normal text or alt
1637 $text = $m[2];
1638 # If we get a ] at the beginning of $m[3] that means we have a link that's something like:
1639 # [[Image:Foo.jpg|[http://example.com desc]]] <- having three ] in a row fucks up,
1640 # the real problem is with the $e1 regex
1641 # See bug 1300.
1642 #
1643 # Still some problems for cases where the ] is meant to be outside punctuation,
1644 # and no image is in sight. See bug 2095.
1645 #
1646 if( $text !== '' &&
1647 substr( $m[3], 0, 1 ) === ']' &&
1648 strpos($text, '[') !== false
1649 )
1650 {
1651 $text .= ']'; # so that replaceExternalLinks($text) works later
1652 $m[3] = substr( $m[3], 1 );
1653 }
1654 # fix up urlencoded title texts
1655 if( strpos( $m[1], '%' ) !== false ) {
1656 # Should anchors '#' also be rejected?
1657 $m[1] = str_replace( array('<', '>'), array('&lt;', '&gt;'), urldecode($m[1]) );
1658 }
1659 $trail = $m[3];
1660 } elseif( preg_match($e1_img, $line, $m) ) { # Invalid, but might be an image with a link in its caption
1661 $might_be_img = true;
1662 $text = $m[2];
1663 if ( strpos( $m[1], '%' ) !== false ) {
1664 $m[1] = urldecode($m[1]);
1665 }
1666 $trail = "";
1667 } else { # Invalid form; output directly
1668 $s .= $prefix . '[[' . $line ;
1669 wfProfileOut( __METHOD__."-e1" );
1670 continue;
1671 }
1672 wfProfileOut( __METHOD__."-e1" );
1673 wfProfileIn( __METHOD__."-misc" );
1674
1675 # Don't allow internal links to pages containing
1676 # PROTO: where PROTO is a valid URL protocol; these
1677 # should be external links.
1678 if (preg_match('/^\b(?:' . wfUrlProtocols() . ')/', $m[1])) {
1679 $s .= $prefix . '[[' . $line ;
1680 wfProfileOut( __METHOD__."-misc" );
1681 continue;
1682 }
1683
1684 # Make subpage if necessary
1685 if( $useSubpages ) {
1686 $link = $this->maybeDoSubpageLink( $m[1], $text );
1687 } else {
1688 $link = $m[1];
1689 }
1690
1691 $noforce = (substr($m[1], 0, 1) !== ':');
1692 if (!$noforce) {
1693 # Strip off leading ':'
1694 $link = substr($link, 1);
1695 }
1696
1697 wfProfileOut( __METHOD__."-misc" );
1698 wfProfileIn( __METHOD__."-title" );
1699 $nt = Title::newFromText( $this->mStripState->unstripNoWiki($link) );
1700 if( !$nt ) {
1701 $s .= $prefix . '[[' . $line;
1702 wfProfileOut( __METHOD__."-title" );
1703 continue;
1704 }
1705
1706 $ns = $nt->getNamespace();
1707 $iw = $nt->getInterWiki();
1708 wfProfileOut( __METHOD__."-title" );
1709
1710 if ($might_be_img) { # if this is actually an invalid link
1711 wfProfileIn( __METHOD__."-might_be_img" );
1712 if ($ns == NS_IMAGE && $noforce) { #but might be an image
1713 $found = false;
1714 while ( true ) {
1715 #look at the next 'line' to see if we can close it there
1716 $a->next();
1717 $next_line = $a->current();
1718 if ( $next_line === false || $next_line === null ) {
1719 break;
1720 }
1721 $m = explode( ']]', $next_line, 3 );
1722 if ( count( $m ) == 3 ) {
1723 # the first ]] closes the inner link, the second the image
1724 $found = true;
1725 $text .= "[[{$m[0]}]]{$m[1]}";
1726 $trail = $m[2];
1727 break;
1728 } elseif ( count( $m ) == 2 ) {
1729 #if there's exactly one ]] that's fine, we'll keep looking
1730 $text .= "[[{$m[0]}]]{$m[1]}";
1731 } else {
1732 #if $next_line is invalid too, we need look no further
1733 $text .= '[[' . $next_line;
1734 break;
1735 }
1736 }
1737 if ( !$found ) {
1738 # we couldn't find the end of this imageLink, so output it raw
1739 #but don't ignore what might be perfectly normal links in the text we've examined
1740 $holders->merge( $this->replaceInternalLinks2( $text ) );
1741 $s .= "{$prefix}[[$link|$text";
1742 # note: no $trail, because without an end, there *is* no trail
1743 wfProfileOut( __METHOD__."-might_be_img" );
1744 continue;
1745 }
1746 } else { #it's not an image, so output it raw
1747 $s .= "{$prefix}[[$link|$text";
1748 # note: no $trail, because without an end, there *is* no trail
1749 wfProfileOut( __METHOD__."-might_be_img" );
1750 continue;
1751 }
1752 wfProfileOut( __METHOD__."-might_be_img" );
1753 }
1754
1755 $wasblank = ( '' == $text );
1756 if( $wasblank ) $text = $link;
1757
1758 # Link not escaped by : , create the various objects
1759 if( $noforce ) {
1760
1761 # Interwikis
1762 wfProfileIn( __METHOD__."-interwiki" );
1763 if( $iw && $this->mOptions->getInterwikiMagic() && $nottalk && $wgContLang->getLanguageName( $iw ) ) {
1764 $this->mOutput->addLanguageLink( $nt->getFullText() );
1765 $s = rtrim($s . $prefix);
1766 $s .= trim($trail, "\n") == '' ? '': $prefix . $trail;
1767 wfProfileOut( __METHOD__."-interwiki" );
1768 continue;
1769 }
1770 wfProfileOut( __METHOD__."-interwiki" );
1771
1772 if ( $ns == NS_IMAGE ) {
1773 wfProfileIn( __METHOD__."-image" );
1774 if ( !wfIsBadImage( $nt->getDBkey(), $this->mTitle ) ) {
1775 # recursively parse links inside the image caption
1776 # actually, this will parse them in any other parameters, too,
1777 # but it might be hard to fix that, and it doesn't matter ATM
1778 $text = $this->replaceExternalLinks($text);
1779 $holders->merge( $this->replaceInternalLinks2( $text ) );
1780
1781 # cloak any absolute URLs inside the image markup, so replaceExternalLinks() won't touch them
1782 $s .= $prefix . $this->armorLinks( $this->makeImage( $nt, $text, $holders ) ) . $trail;
1783 }
1784 $this->mOutput->addImage( $nt->getDBkey() );
1785 wfProfileOut( __METHOD__."-image" );
1786 continue;
1787
1788 }
1789
1790 if ( $ns == NS_CATEGORY ) {
1791 wfProfileIn( __METHOD__."-category" );
1792 $s = rtrim($s . "\n"); # bug 87
1793
1794 if ( $wasblank ) {
1795 $sortkey = $this->getDefaultSort();
1796 } else {
1797 $sortkey = $text;
1798 }
1799 $sortkey = Sanitizer::decodeCharReferences( $sortkey );
1800 $sortkey = str_replace( "\n", '', $sortkey );
1801 $sortkey = $wgContLang->convertCategoryKey( $sortkey );
1802 $this->mOutput->addCategory( $nt->getDBkey(), $sortkey );
1803
1804 /**
1805 * Strip the whitespace Category links produce, see bug 87
1806 * @todo We might want to use trim($tmp, "\n") here.
1807 */
1808 $s .= trim($prefix . $trail, "\n") == '' ? '': $prefix . $trail;
1809
1810 wfProfileOut( __METHOD__."-category" );
1811 continue;
1812 }
1813 }
1814
1815 # Self-link checking
1816 if( $nt->getFragment() === '' && $nt->getNamespace() != NS_SPECIAL ) {
1817 if( in_array( $nt->getPrefixedText(), $selflink, true ) ) {
1818 $s .= $prefix . $sk->makeSelfLinkObj( $nt, $text, '', $trail );
1819 continue;
1820 }
1821 }
1822
1823 # Special and Media are pseudo-namespaces; no pages actually exist in them
1824 if( $ns == NS_MEDIA ) {
1825 # Give extensions a chance to select the file revision for us
1826 $skip = $time = false;
1827 wfRunHooks( 'BeforeParserMakeImageLinkObj', array( &$this, &$nt, &$skip, &$time ) );
1828 if ( $skip ) {
1829 $link = $sk->link( $nt );
1830 } else {
1831 $link = $sk->makeMediaLinkObj( $nt, $text, $time );
1832 }
1833 # Cloak with NOPARSE to avoid replacement in replaceExternalLinks
1834 $s .= $prefix . $this->armorLinks( $link ) . $trail;
1835 $this->mOutput->addImage( $nt->getDBkey() );
1836 continue;
1837 } elseif( $ns == NS_SPECIAL ) {
1838 if( SpecialPage::exists( $nt->getDBkey() ) ) {
1839 $s .= $this->makeKnownLinkHolder( $nt, $text, '', $trail, $prefix );
1840 } else {
1841 $s .= $holders->makeHolder( $nt, $text, '', $trail, $prefix );
1842 }
1843 continue;
1844 } elseif( $ns == NS_IMAGE ) {
1845 $img = wfFindFile( $nt );
1846 if( $img ) {
1847 // Force a blue link if the file exists; may be a remote
1848 // upload on the shared repository, and we want to see its
1849 // auto-generated page.
1850 $s .= $this->makeKnownLinkHolder( $nt, $text, '', $trail, $prefix );
1851 $this->mOutput->addLink( $nt );
1852 continue;
1853 }
1854 }
1855 $s .= $holders->makeHolder( $nt, $text, '', $trail, $prefix );
1856 }
1857 wfProfileOut( __METHOD__ );
1858 return $holders;
1859 }
1860
1861 /**
1862 * Make a link placeholder. The text returned can be later resolved to a real link with
1863 * replaceLinkHolders(). This is done for two reasons: firstly to avoid further
1864 * parsing of interwiki links, and secondly to allow all existence checks and
1865 * article length checks (for stub links) to be bundled into a single query.
1866 *
1867 * @deprecated
1868 */
1869 function makeLinkHolder( &$nt, $text = '', $query = '', $trail = '', $prefix = '' ) {
1870 return $this->mLinkHolders->makeHolder( $nt, $text, $query, $trail, $prefix );
1871 }
1872
1873 /**
1874 * Render a forced-blue link inline; protect against double expansion of
1875 * URLs if we're in a mode that prepends full URL prefixes to internal links.
1876 * Since this little disaster has to split off the trail text to avoid
1877 * breaking URLs in the following text without breaking trails on the
1878 * wiki links, it's been made into a horrible function.
1879 *
1880 * @param Title $nt
1881 * @param string $text
1882 * @param string $query
1883 * @param string $trail
1884 * @param string $prefix
1885 * @return string HTML-wikitext mix oh yuck
1886 */
1887 function makeKnownLinkHolder( $nt, $text = '', $query = '', $trail = '', $prefix = '' ) {
1888 list( $inside, $trail ) = Linker::splitTrail( $trail );
1889 $sk = $this->mOptions->getSkin();
1890 $link = $sk->makeKnownLinkObj( $nt, $text, $query, $inside, $prefix );
1891 return $this->armorLinks( $link ) . $trail;
1892 }
1893
1894 /**
1895 * Insert a NOPARSE hacky thing into any inline links in a chunk that's
1896 * going to go through further parsing steps before inline URL expansion.
1897 *
1898 * Not needed quite as much as it used to be since free links are a bit
1899 * more sensible these days. But bracketed links are still an issue.
1900 *
1901 * @param string more-or-less HTML
1902 * @return string less-or-more HTML with NOPARSE bits
1903 */
1904 function armorLinks( $text ) {
1905 return preg_replace( '/\b(' . wfUrlProtocols() . ')/',
1906 "{$this->mUniqPrefix}NOPARSE$1", $text );
1907 }
1908
1909 /**
1910 * Return true if subpage links should be expanded on this page.
1911 * @return bool
1912 */
1913 function areSubpagesAllowed() {
1914 # Some namespaces don't allow subpages
1915 return MWNamespace::hasSubpages( $this->mTitle->getNamespace() );
1916 }
1917
1918 /**
1919 * Handle link to subpage if necessary
1920 * @param string $target the source of the link
1921 * @param string &$text the link text, modified as necessary
1922 * @return string the full name of the link
1923 * @private
1924 */
1925 function maybeDoSubpageLink($target, &$text) {
1926 # Valid link forms:
1927 # Foobar -- normal
1928 # :Foobar -- override special treatment of prefix (images, language links)
1929 # /Foobar -- convert to CurrentPage/Foobar
1930 # /Foobar/ -- convert to CurrentPage/Foobar, strip the initial / from text
1931 # ../ -- convert to CurrentPage, from CurrentPage/CurrentSubPage
1932 # ../Foobar -- convert to CurrentPage/Foobar, from CurrentPage/CurrentSubPage
1933
1934 wfProfileIn( __METHOD__ );
1935 $ret = $target; # default return value is no change
1936
1937 # Some namespaces don't allow subpages,
1938 # so only perform processing if subpages are allowed
1939 if( $this->areSubpagesAllowed() ) {
1940 $hash = strpos( $target, '#' );
1941 if( $hash !== false ) {
1942 $suffix = substr( $target, $hash );
1943 $target = substr( $target, 0, $hash );
1944 } else {
1945 $suffix = '';
1946 }
1947 # bug 7425
1948 $target = trim( $target );
1949 # Look at the first character
1950 if( $target != '' && $target{0} === '/' ) {
1951 # / at end means we don't want the slash to be shown
1952 $m = array();
1953 $trailingSlashes = preg_match_all( '%(/+)$%', $target, $m );
1954 if( $trailingSlashes ) {
1955 $noslash = $target = substr( $target, 1, -strlen($m[0][0]) );
1956 } else {
1957 $noslash = substr( $target, 1 );
1958 }
1959
1960 $ret = $this->mTitle->getPrefixedText(). '/' . trim($noslash) . $suffix;
1961 if( '' === $text ) {
1962 $text = $target . $suffix;
1963 } # this might be changed for ugliness reasons
1964 } else {
1965 # check for .. subpage backlinks
1966 $dotdotcount = 0;
1967 $nodotdot = $target;
1968 while( strncmp( $nodotdot, "../", 3 ) == 0 ) {
1969 ++$dotdotcount;
1970 $nodotdot = substr( $nodotdot, 3 );
1971 }
1972 if($dotdotcount > 0) {
1973 $exploded = explode( '/', $this->mTitle->GetPrefixedText() );
1974 if( count( $exploded ) > $dotdotcount ) { # not allowed to go below top level page
1975 $ret = implode( '/', array_slice( $exploded, 0, -$dotdotcount ) );
1976 # / at the end means don't show full path
1977 if( substr( $nodotdot, -1, 1 ) === '/' ) {
1978 $nodotdot = substr( $nodotdot, 0, -1 );
1979 if( '' === $text ) {
1980 $text = $nodotdot . $suffix;
1981 }
1982 }
1983 $nodotdot = trim( $nodotdot );
1984 if( $nodotdot != '' ) {
1985 $ret .= '/' . $nodotdot;
1986 }
1987 $ret .= $suffix;
1988 }
1989 }
1990 }
1991 }
1992
1993 wfProfileOut( __METHOD__ );
1994 return $ret;
1995 }
1996
1997 /**#@+
1998 * Used by doBlockLevels()
1999 * @private
2000 */
2001 /* private */ function closeParagraph() {
2002 $result = '';
2003 if ( '' != $this->mLastSection ) {
2004 $result = '</' . $this->mLastSection . ">\n";
2005 }
2006 $this->mInPre = false;
2007 $this->mLastSection = '';
2008 return $result;
2009 }
2010 # getCommon() returns the length of the longest common substring
2011 # of both arguments, starting at the beginning of both.
2012 #
2013 /* private */ function getCommon( $st1, $st2 ) {
2014 $fl = strlen( $st1 );
2015 $shorter = strlen( $st2 );
2016 if ( $fl < $shorter ) { $shorter = $fl; }
2017
2018 for ( $i = 0; $i < $shorter; ++$i ) {
2019 if ( $st1{$i} != $st2{$i} ) { break; }
2020 }
2021 return $i;
2022 }
2023 # These next three functions open, continue, and close the list
2024 # element appropriate to the prefix character passed into them.
2025 #
2026 /* private */ function openList( $char ) {
2027 $result = $this->closeParagraph();
2028
2029 if ( '*' === $char ) { $result .= '<ul><li>'; }
2030 else if ( '#' === $char ) { $result .= '<ol><li>'; }
2031 else if ( ':' === $char ) { $result .= '<dl><dd>'; }
2032 else if ( ';' === $char ) {
2033 $result .= '<dl><dt>';
2034 $this->mDTopen = true;
2035 }
2036 else { $result = '<!-- ERR 1 -->'; }
2037
2038 return $result;
2039 }
2040
2041 /* private */ function nextItem( $char ) {
2042 if ( '*' === $char || '#' === $char ) { return '</li><li>'; }
2043 else if ( ':' === $char || ';' === $char ) {
2044 $close = '</dd>';
2045 if ( $this->mDTopen ) { $close = '</dt>'; }
2046 if ( ';' === $char ) {
2047 $this->mDTopen = true;
2048 return $close . '<dt>';
2049 } else {
2050 $this->mDTopen = false;
2051 return $close . '<dd>';
2052 }
2053 }
2054 return '<!-- ERR 2 -->';
2055 }
2056
2057 /* private */ function closeList( $char ) {
2058 if ( '*' === $char ) { $text = '</li></ul>'; }
2059 else if ( '#' === $char ) { $text = '</li></ol>'; }
2060 else if ( ':' === $char ) {
2061 if ( $this->mDTopen ) {
2062 $this->mDTopen = false;
2063 $text = '</dt></dl>';
2064 } else {
2065 $text = '</dd></dl>';
2066 }
2067 }
2068 else { return '<!-- ERR 3 -->'; }
2069 return $text."\n";
2070 }
2071 /**#@-*/
2072
2073 /**
2074 * Make lists from lines starting with ':', '*', '#', etc. (DBL)
2075 *
2076 * @private
2077 * @return string the lists rendered as HTML
2078 */
2079 function doBlockLevels( $text, $linestart ) {
2080 wfProfileIn( __METHOD__ );
2081
2082 # Parsing through the text line by line. The main thing
2083 # happening here is handling of block-level elements p, pre,
2084 # and making lists from lines starting with * # : etc.
2085 #
2086 $textLines = StringUtils::explode( "\n", $text );
2087
2088 $lastPrefix = $output = '';
2089 $this->mDTopen = $inBlockElem = false;
2090 $prefixLength = 0;
2091 $paragraphStack = false;
2092
2093 foreach ( $textLines as $oLine ) {
2094 # Fix up $linestart
2095 if ( !$linestart ) {
2096 $output .= $oLine;
2097 $linestart = true;
2098 continue;
2099 }
2100
2101 $lastPrefixLength = strlen( $lastPrefix );
2102 $preCloseMatch = preg_match('/<\\/pre/i', $oLine );
2103 $preOpenMatch = preg_match('/<pre/i', $oLine );
2104 if ( !$this->mInPre ) {
2105 # Multiple prefixes may abut each other for nested lists.
2106 $prefixLength = strspn( $oLine, '*#:;' );
2107 $prefix = substr( $oLine, 0, $prefixLength );
2108
2109 # eh?
2110 $prefix2 = str_replace( ';', ':', $prefix );
2111 $t = substr( $oLine, $prefixLength );
2112 $this->mInPre = (bool)$preOpenMatch;
2113 } else {
2114 # Don't interpret any other prefixes in preformatted text
2115 $prefixLength = 0;
2116 $prefix = $prefix2 = '';
2117 $t = $oLine;
2118 }
2119
2120 # List generation
2121 if( $prefixLength && $lastPrefix === $prefix2 ) {
2122 # Same as the last item, so no need to deal with nesting or opening stuff
2123 $output .= $this->nextItem( substr( $prefix, -1 ) );
2124 $paragraphStack = false;
2125
2126 if ( substr( $prefix, -1 ) === ';') {
2127 # The one nasty exception: definition lists work like this:
2128 # ; title : definition text
2129 # So we check for : in the remainder text to split up the
2130 # title and definition, without b0rking links.
2131 $term = $t2 = '';
2132 if ($this->findColonNoLinks($t, $term, $t2) !== false) {
2133 $t = $t2;
2134 $output .= $term . $this->nextItem( ':' );
2135 }
2136 }
2137 } elseif( $prefixLength || $lastPrefixLength ) {
2138 # Either open or close a level...
2139 $commonPrefixLength = $this->getCommon( $prefix, $lastPrefix );
2140 $paragraphStack = false;
2141
2142 while( $commonPrefixLength < $lastPrefixLength ) {
2143 $output .= $this->closeList( $lastPrefix[$lastPrefixLength-1] );
2144 --$lastPrefixLength;
2145 }
2146 if ( $prefixLength <= $commonPrefixLength && $commonPrefixLength > 0 ) {
2147 $output .= $this->nextItem( $prefix[$commonPrefixLength-1] );
2148 }
2149 while ( $prefixLength > $commonPrefixLength ) {
2150 $char = substr( $prefix, $commonPrefixLength, 1 );
2151 $output .= $this->openList( $char );
2152
2153 if ( ';' === $char ) {
2154 # FIXME: This is dupe of code above
2155 if ($this->findColonNoLinks($t, $term, $t2) !== false) {
2156 $t = $t2;
2157 $output .= $term . $this->nextItem( ':' );
2158 }
2159 }
2160 ++$commonPrefixLength;
2161 }
2162 $lastPrefix = $prefix2;
2163 }
2164 if( 0 == $prefixLength ) {
2165 wfProfileIn( __METHOD__."-paragraph" );
2166 # No prefix (not in list)--go to paragraph mode
2167 // XXX: use a stack for nestable elements like span, table and div
2168 $openmatch = preg_match('/(?:<table|<blockquote|<h1|<h2|<h3|<h4|<h5|<h6|<pre|<tr|<p|<ul|<ol|<li|<\\/tr|<\\/td|<\\/th)/iS', $t );
2169 $closematch = preg_match(
2170 '/(?:<\\/table|<\\/blockquote|<\\/h1|<\\/h2|<\\/h3|<\\/h4|<\\/h5|<\\/h6|'.
2171 '<td|<th|<\\/?div|<hr|<\\/pre|<\\/p|'.$this->mUniqPrefix.'-pre|<\\/li|<\\/ul|<\\/ol|<\\/?center)/iS', $t );
2172 if ( $openmatch or $closematch ) {
2173 $paragraphStack = false;
2174 # TODO bug 5718: paragraph closed
2175 $output .= $this->closeParagraph();
2176 if ( $preOpenMatch and !$preCloseMatch ) {
2177 $this->mInPre = true;
2178 }
2179 if ( $closematch ) {
2180 $inBlockElem = false;
2181 } else {
2182 $inBlockElem = true;
2183 }
2184 } else if ( !$inBlockElem && !$this->mInPre ) {
2185 if ( ' ' == $t{0} and ( $this->mLastSection === 'pre' or trim($t) != '' ) ) {
2186 // pre
2187 if ($this->mLastSection !== 'pre') {
2188 $paragraphStack = false;
2189 $output .= $this->closeParagraph().'<pre>';
2190 $this->mLastSection = 'pre';
2191 }
2192 $t = substr( $t, 1 );
2193 } else {
2194 // paragraph
2195 if ( '' == trim($t) ) {
2196 if ( $paragraphStack ) {
2197 $output .= $paragraphStack.'<br />';
2198 $paragraphStack = false;
2199 $this->mLastSection = 'p';
2200 } else {
2201 if ($this->mLastSection !== 'p' ) {
2202 $output .= $this->closeParagraph();
2203 $this->mLastSection = '';
2204 $paragraphStack = '<p>';
2205 } else {
2206 $paragraphStack = '</p><p>';
2207 }
2208 }
2209 } else {
2210 if ( $paragraphStack ) {
2211 $output .= $paragraphStack;
2212 $paragraphStack = false;
2213 $this->mLastSection = 'p';
2214 } else if ($this->mLastSection !== 'p') {
2215 $output .= $this->closeParagraph().'<p>';
2216 $this->mLastSection = 'p';
2217 }
2218 }
2219 }
2220 }
2221 wfProfileOut( __METHOD__."-paragraph" );
2222 }
2223 // somewhere above we forget to get out of pre block (bug 785)
2224 if($preCloseMatch && $this->mInPre) {
2225 $this->mInPre = false;
2226 }
2227 if ($paragraphStack === false) {
2228 $output .= $t."\n";
2229 }
2230 }
2231 while ( $prefixLength ) {
2232 $output .= $this->closeList( $prefix2[$prefixLength-1] );
2233 --$prefixLength;
2234 }
2235 if ( '' != $this->mLastSection ) {
2236 $output .= '</' . $this->mLastSection . '>';
2237 $this->mLastSection = '';
2238 }
2239
2240 wfProfileOut( __METHOD__ );
2241 return $output;
2242 }
2243
2244 /**
2245 * Split up a string on ':', ignoring any occurences inside tags
2246 * to prevent illegal overlapping.
2247 * @param string $str the string to split
2248 * @param string &$before set to everything before the ':'
2249 * @param string &$after set to everything after the ':'
2250 * return string the position of the ':', or false if none found
2251 */
2252 function findColonNoLinks($str, &$before, &$after) {
2253 wfProfileIn( __METHOD__ );
2254
2255 $pos = strpos( $str, ':' );
2256 if( $pos === false ) {
2257 // Nothing to find!
2258 wfProfileOut( __METHOD__ );
2259 return false;
2260 }
2261
2262 $lt = strpos( $str, '<' );
2263 if( $lt === false || $lt > $pos ) {
2264 // Easy; no tag nesting to worry about
2265 $before = substr( $str, 0, $pos );
2266 $after = substr( $str, $pos+1 );
2267 wfProfileOut( __METHOD__ );
2268 return $pos;
2269 }
2270
2271 // Ugly state machine to walk through avoiding tags.
2272 $state = self::COLON_STATE_TEXT;
2273 $stack = 0;
2274 $len = strlen( $str );
2275 for( $i = 0; $i < $len; $i++ ) {
2276 $c = $str{$i};
2277
2278 switch( $state ) {
2279 // (Using the number is a performance hack for common cases)
2280 case 0: // self::COLON_STATE_TEXT:
2281 switch( $c ) {
2282 case "<":
2283 // Could be either a <start> tag or an </end> tag
2284 $state = self::COLON_STATE_TAGSTART;
2285 break;
2286 case ":":
2287 if( $stack == 0 ) {
2288 // We found it!
2289 $before = substr( $str, 0, $i );
2290 $after = substr( $str, $i + 1 );
2291 wfProfileOut( __METHOD__ );
2292 return $i;
2293 }
2294 // Embedded in a tag; don't break it.
2295 break;
2296 default:
2297 // Skip ahead looking for something interesting
2298 $colon = strpos( $str, ':', $i );
2299 if( $colon === false ) {
2300 // Nothing else interesting
2301 wfProfileOut( __METHOD__ );
2302 return false;
2303 }
2304 $lt = strpos( $str, '<', $i );
2305 if( $stack === 0 ) {
2306 if( $lt === false || $colon < $lt ) {
2307 // We found it!
2308 $before = substr( $str, 0, $colon );
2309 $after = substr( $str, $colon + 1 );
2310 wfProfileOut( __METHOD__ );
2311 return $i;
2312 }
2313 }
2314 if( $lt === false ) {
2315 // Nothing else interesting to find; abort!
2316 // We're nested, but there's no close tags left. Abort!
2317 break 2;
2318 }
2319 // Skip ahead to next tag start
2320 $i = $lt;
2321 $state = self::COLON_STATE_TAGSTART;
2322 }
2323 break;
2324 case 1: // self::COLON_STATE_TAG:
2325 // In a <tag>
2326 switch( $c ) {
2327 case ">":
2328 $stack++;
2329 $state = self::COLON_STATE_TEXT;
2330 break;
2331 case "/":
2332 // Slash may be followed by >?
2333 $state = self::COLON_STATE_TAGSLASH;
2334 break;
2335 default:
2336 // ignore
2337 }
2338 break;
2339 case 2: // self::COLON_STATE_TAGSTART:
2340 switch( $c ) {
2341 case "/":
2342 $state = self::COLON_STATE_CLOSETAG;
2343 break;
2344 case "!":
2345 $state = self::COLON_STATE_COMMENT;
2346 break;
2347 case ">":
2348 // Illegal early close? This shouldn't happen D:
2349 $state = self::COLON_STATE_TEXT;
2350 break;
2351 default:
2352 $state = self::COLON_STATE_TAG;
2353 }
2354 break;
2355 case 3: // self::COLON_STATE_CLOSETAG:
2356 // In a </tag>
2357 if( $c === ">" ) {
2358 $stack--;
2359 if( $stack < 0 ) {
2360 wfDebug( __METHOD__.": Invalid input; too many close tags\n" );
2361 wfProfileOut( __METHOD__ );
2362 return false;
2363 }
2364 $state = self::COLON_STATE_TEXT;
2365 }
2366 break;
2367 case self::COLON_STATE_TAGSLASH:
2368 if( $c === ">" ) {
2369 // Yes, a self-closed tag <blah/>
2370 $state = self::COLON_STATE_TEXT;
2371 } else {
2372 // Probably we're jumping the gun, and this is an attribute
2373 $state = self::COLON_STATE_TAG;
2374 }
2375 break;
2376 case 5: // self::COLON_STATE_COMMENT:
2377 if( $c === "-" ) {
2378 $state = self::COLON_STATE_COMMENTDASH;
2379 }
2380 break;
2381 case self::COLON_STATE_COMMENTDASH:
2382 if( $c === "-" ) {
2383 $state = self::COLON_STATE_COMMENTDASHDASH;
2384 } else {
2385 $state = self::COLON_STATE_COMMENT;
2386 }
2387 break;
2388 case self::COLON_STATE_COMMENTDASHDASH:
2389 if( $c === ">" ) {
2390 $state = self::COLON_STATE_TEXT;
2391 } else {
2392 $state = self::COLON_STATE_COMMENT;
2393 }
2394 break;
2395 default:
2396 throw new MWException( "State machine error in " . __METHOD__ );
2397 }
2398 }
2399 if( $stack > 0 ) {
2400 wfDebug( __METHOD__.": Invalid input; not enough close tags (stack $stack, state $state)\n" );
2401 return false;
2402 }
2403 wfProfileOut( __METHOD__ );
2404 return false;
2405 }
2406
2407 /**
2408 * Return value of a magic variable (like PAGENAME)
2409 *
2410 * @private
2411 */
2412 function getVariableValue( $index ) {
2413 global $wgContLang, $wgSitename, $wgServer, $wgServerName, $wgScriptPath;
2414
2415 /**
2416 * Some of these require message or data lookups and can be
2417 * expensive to check many times.
2418 */
2419 if ( wfRunHooks( 'ParserGetVariableValueVarCache', array( &$this, &$this->mVarCache ) ) ) {
2420 if ( isset( $this->mVarCache[$index] ) ) {
2421 return $this->mVarCache[$index];
2422 }
2423 }
2424
2425 $ts = wfTimestamp( TS_UNIX, $this->mOptions->getTimestamp() );
2426 wfRunHooks( 'ParserGetVariableValueTs', array( &$this, &$ts ) );
2427
2428 # Use the time zone
2429 global $wgLocaltimezone;
2430 if ( isset( $wgLocaltimezone ) ) {
2431 $oldtz = getenv( 'TZ' );
2432 putenv( 'TZ='.$wgLocaltimezone );
2433 }
2434
2435 wfSuppressWarnings(); // E_STRICT system time bitching
2436 $localTimestamp = date( 'YmdHis', $ts );
2437 $localMonth = date( 'm', $ts );
2438 $localMonthName = date( 'n', $ts );
2439 $localDay = date( 'j', $ts );
2440 $localDay2 = date( 'd', $ts );
2441 $localDayOfWeek = date( 'w', $ts );
2442 $localWeek = date( 'W', $ts );
2443 $localYear = date( 'Y', $ts );
2444 $localHour = date( 'H', $ts );
2445 if ( isset( $wgLocaltimezone ) ) {
2446 putenv( 'TZ='.$oldtz );
2447 }
2448 wfRestoreWarnings();
2449
2450 switch ( $index ) {
2451 case 'currentmonth':
2452 return $this->mVarCache[$index] = $wgContLang->formatNum( gmdate( 'm', $ts ) );
2453 case 'currentmonthname':
2454 return $this->mVarCache[$index] = $wgContLang->getMonthName( gmdate( 'n', $ts ) );
2455 case 'currentmonthnamegen':
2456 return $this->mVarCache[$index] = $wgContLang->getMonthNameGen( gmdate( 'n', $ts ) );
2457 case 'currentmonthabbrev':
2458 return $this->mVarCache[$index] = $wgContLang->getMonthAbbreviation( gmdate( 'n', $ts ) );
2459 case 'currentday':
2460 return $this->mVarCache[$index] = $wgContLang->formatNum( gmdate( 'j', $ts ) );
2461 case 'currentday2':
2462 return $this->mVarCache[$index] = $wgContLang->formatNum( gmdate( 'd', $ts ) );
2463 case 'localmonth':
2464 return $this->mVarCache[$index] = $wgContLang->formatNum( $localMonth );
2465 case 'localmonthname':
2466 return $this->mVarCache[$index] = $wgContLang->getMonthName( $localMonthName );
2467 case 'localmonthnamegen':
2468 return $this->mVarCache[$index] = $wgContLang->getMonthNameGen( $localMonthName );
2469 case 'localmonthabbrev':
2470 return $this->mVarCache[$index] = $wgContLang->getMonthAbbreviation( $localMonthName );
2471 case 'localday':
2472 return $this->mVarCache[$index] = $wgContLang->formatNum( $localDay );
2473 case 'localday2':
2474 return $this->mVarCache[$index] = $wgContLang->formatNum( $localDay2 );
2475 case 'pagename':
2476 return wfEscapeWikiText( $this->mTitle->getText() );
2477 case 'pagenamee':
2478 return $this->mTitle->getPartialURL();
2479 case 'fullpagename':
2480 return wfEscapeWikiText( $this->mTitle->getPrefixedText() );
2481 case 'fullpagenamee':
2482 return $this->mTitle->getPrefixedURL();
2483 case 'subpagename':
2484 return wfEscapeWikiText( $this->mTitle->getSubpageText() );
2485 case 'subpagenamee':
2486 return $this->mTitle->getSubpageUrlForm();
2487 case 'basepagename':
2488 return wfEscapeWikiText( $this->mTitle->getBaseText() );
2489 case 'basepagenamee':
2490 return wfUrlEncode( str_replace( ' ', '_', $this->mTitle->getBaseText() ) );
2491 case 'talkpagename':
2492 if( $this->mTitle->canTalk() ) {
2493 $talkPage = $this->mTitle->getTalkPage();
2494 return wfEscapeWikiText( $talkPage->getPrefixedText() );
2495 } else {
2496 return '';
2497 }
2498 case 'talkpagenamee':
2499 if( $this->mTitle->canTalk() ) {
2500 $talkPage = $this->mTitle->getTalkPage();
2501 return $talkPage->getPrefixedUrl();
2502 } else {
2503 return '';
2504 }
2505 case 'subjectpagename':
2506 $subjPage = $this->mTitle->getSubjectPage();
2507 return wfEscapeWikiText( $subjPage->getPrefixedText() );
2508 case 'subjectpagenamee':
2509 $subjPage = $this->mTitle->getSubjectPage();
2510 return $subjPage->getPrefixedUrl();
2511 case 'revisionid':
2512 // Let the edit saving system know we should parse the page
2513 // *after* a revision ID has been assigned.
2514 $this->mOutput->setFlag( 'vary-revision' );
2515 wfDebug( __METHOD__ . ": {{REVISIONID}} used, setting vary-revision...\n" );
2516 return $this->mRevisionId;
2517 case 'revisionday':
2518 // Let the edit saving system know we should parse the page
2519 // *after* a revision ID has been assigned. This is for null edits.
2520 $this->mOutput->setFlag( 'vary-revision' );
2521 wfDebug( __METHOD__ . ": {{REVISIONDAY}} used, setting vary-revision...\n" );
2522 return intval( substr( $this->getRevisionTimestamp(), 6, 2 ) );
2523 case 'revisionday2':
2524 // Let the edit saving system know we should parse the page
2525 // *after* a revision ID has been assigned. This is for null edits.
2526 $this->mOutput->setFlag( 'vary-revision' );
2527 wfDebug( __METHOD__ . ": {{REVISIONDAY2}} used, setting vary-revision...\n" );
2528 return substr( $this->getRevisionTimestamp(), 6, 2 );
2529 case 'revisionmonth':
2530 // Let the edit saving system know we should parse the page
2531 // *after* a revision ID has been assigned. This is for null edits.
2532 $this->mOutput->setFlag( 'vary-revision' );
2533 wfDebug( __METHOD__ . ": {{REVISIONMONTH}} used, setting vary-revision...\n" );
2534 return intval( substr( $this->getRevisionTimestamp(), 4, 2 ) );
2535 case 'revisionyear':
2536 // Let the edit saving system know we should parse the page
2537 // *after* a revision ID has been assigned. This is for null edits.
2538 $this->mOutput->setFlag( 'vary-revision' );
2539 wfDebug( __METHOD__ . ": {{REVISIONYEAR}} used, setting vary-revision...\n" );
2540 return substr( $this->getRevisionTimestamp(), 0, 4 );
2541 case 'revisiontimestamp':
2542 // Let the edit saving system know we should parse the page
2543 // *after* a revision ID has been assigned. This is for null edits.
2544 $this->mOutput->setFlag( 'vary-revision' );
2545 wfDebug( __METHOD__ . ": {{REVISIONTIMESTAMP}} used, setting vary-revision...\n" );
2546 return $this->getRevisionTimestamp();
2547 case 'namespace':
2548 return str_replace('_',' ',$wgContLang->getNsText( $this->mTitle->getNamespace() ) );
2549 case 'namespacee':
2550 return wfUrlencode( $wgContLang->getNsText( $this->mTitle->getNamespace() ) );
2551 case 'talkspace':
2552 return $this->mTitle->canTalk() ? str_replace('_',' ',$this->mTitle->getTalkNsText()) : '';
2553 case 'talkspacee':
2554 return $this->mTitle->canTalk() ? wfUrlencode( $this->mTitle->getTalkNsText() ) : '';
2555 case 'subjectspace':
2556 return $this->mTitle->getSubjectNsText();
2557 case 'subjectspacee':
2558 return( wfUrlencode( $this->mTitle->getSubjectNsText() ) );
2559 case 'currentdayname':
2560 return $this->mVarCache[$index] = $wgContLang->getWeekdayName( gmdate( 'w', $ts ) + 1 );
2561 case 'currentyear':
2562 return $this->mVarCache[$index] = $wgContLang->formatNum( gmdate( 'Y', $ts ), true );
2563 case 'currenttime':
2564 return $this->mVarCache[$index] = $wgContLang->time( wfTimestamp( TS_MW, $ts ), false, false );
2565 case 'currenthour':
2566 return $this->mVarCache[$index] = $wgContLang->formatNum( gmdate( 'H', $ts ), true );
2567 case 'currentweek':
2568 // @bug 4594 PHP5 has it zero padded, PHP4 does not, cast to
2569 // int to remove the padding
2570 return $this->mVarCache[$index] = $wgContLang->formatNum( (int)gmdate( 'W', $ts ) );
2571 case 'currentdow':
2572 return $this->mVarCache[$index] = $wgContLang->formatNum( gmdate( 'w', $ts ) );
2573 case 'localdayname':
2574 return $this->mVarCache[$index] = $wgContLang->getWeekdayName( $localDayOfWeek + 1 );
2575 case 'localyear':
2576 return $this->mVarCache[$index] = $wgContLang->formatNum( $localYear, true );
2577 case 'localtime':
2578 return $this->mVarCache[$index] = $wgContLang->time( $localTimestamp, false, false );
2579 case 'localhour':
2580 return $this->mVarCache[$index] = $wgContLang->formatNum( $localHour, true );
2581 case 'localweek':
2582 // @bug 4594 PHP5 has it zero padded, PHP4 does not, cast to
2583 // int to remove the padding
2584 return $this->mVarCache[$index] = $wgContLang->formatNum( (int)$localWeek );
2585 case 'localdow':
2586 return $this->mVarCache[$index] = $wgContLang->formatNum( $localDayOfWeek );
2587 case 'numberofarticles':
2588 return $this->mVarCache[$index] = $wgContLang->formatNum( SiteStats::articles() );
2589 case 'numberoffiles':
2590 return $this->mVarCache[$index] = $wgContLang->formatNum( SiteStats::images() );
2591 case 'numberofusers':
2592 return $this->mVarCache[$index] = $wgContLang->formatNum( SiteStats::users() );
2593 case 'numberofpages':
2594 return $this->mVarCache[$index] = $wgContLang->formatNum( SiteStats::pages() );
2595 case 'numberofadmins':
2596 return $this->mVarCache[$index] = $wgContLang->formatNum( SiteStats::numberingroup('sysop') );
2597 case 'numberofedits':
2598 return $this->mVarCache[$index] = $wgContLang->formatNum( SiteStats::edits() );
2599 case 'numberofviews':
2600 return $this->mVarCache[$index] = $wgContLang->formatNum( SiteStats::views() );
2601 case 'currenttimestamp':
2602 return $this->mVarCache[$index] = wfTimestamp( TS_MW, $ts );
2603 case 'localtimestamp':
2604 return $this->mVarCache[$index] = $localTimestamp;
2605 case 'currentversion':
2606 return $this->mVarCache[$index] = SpecialVersion::getVersion();
2607 case 'sitename':
2608 return $wgSitename;
2609 case 'server':
2610 return $wgServer;
2611 case 'servername':
2612 return $wgServerName;
2613 case 'scriptpath':
2614 return $wgScriptPath;
2615 case 'directionmark':
2616 return $wgContLang->getDirMark();
2617 case 'contentlanguage':
2618 global $wgContLanguageCode;
2619 return $wgContLanguageCode;
2620 default:
2621 $ret = null;
2622 if ( wfRunHooks( 'ParserGetVariableValueSwitch', array( &$this, &$this->mVarCache, &$index, &$ret ) ) )
2623 return $ret;
2624 else
2625 return null;
2626 }
2627 }
2628
2629 /**
2630 * initialise the magic variables (like CURRENTMONTHNAME)
2631 *
2632 * @private
2633 */
2634 function initialiseVariables() {
2635 wfProfileIn( __METHOD__ );
2636 $variableIDs = MagicWord::getVariableIDs();
2637
2638 $this->mVariables = new MagicWordArray( $variableIDs );
2639 wfProfileOut( __METHOD__ );
2640 }
2641
2642 /**
2643 * Preprocess some wikitext and return the document tree.
2644 * This is the ghost of replace_variables().
2645 *
2646 * @param string $text The text to parse
2647 * @param integer flags Bitwise combination of:
2648 * self::PTD_FOR_INCLUSION Handle <noinclude>/<includeonly> as if the text is being
2649 * included. Default is to assume a direct page view.
2650 *
2651 * The generated DOM tree must depend only on the input text and the flags.
2652 * The DOM tree must be the same in OT_HTML and OT_WIKI mode, to avoid a regression of bug 4899.
2653 *
2654 * Any flag added to the $flags parameter here, or any other parameter liable to cause a
2655 * change in the DOM tree for a given text, must be passed through the section identifier
2656 * in the section edit link and thus back to extractSections().
2657 *
2658 * The output of this function is currently only cached in process memory, but a persistent
2659 * cache may be implemented at a later date which takes further advantage of these strict
2660 * dependency requirements.
2661 *
2662 * @private
2663 */
2664 function preprocessToDom ( $text, $flags = 0 ) {
2665 $dom = $this->getPreprocessor()->preprocessToObj( $text, $flags );
2666 return $dom;
2667 }
2668
2669 /*
2670 * Return a three-element array: leading whitespace, string contents, trailing whitespace
2671 */
2672 public static function splitWhitespace( $s ) {
2673 $ltrimmed = ltrim( $s );
2674 $w1 = substr( $s, 0, strlen( $s ) - strlen( $ltrimmed ) );
2675 $trimmed = rtrim( $ltrimmed );
2676 $diff = strlen( $ltrimmed ) - strlen( $trimmed );
2677 if ( $diff > 0 ) {
2678 $w2 = substr( $ltrimmed, -$diff );
2679 } else {
2680 $w2 = '';
2681 }
2682 return array( $w1, $trimmed, $w2 );
2683 }
2684
2685 /**
2686 * Replace magic variables, templates, and template arguments
2687 * with the appropriate text. Templates are substituted recursively,
2688 * taking care to avoid infinite loops.
2689 *
2690 * Note that the substitution depends on value of $mOutputType:
2691 * self::OT_WIKI: only {{subst:}} templates
2692 * self::OT_PREPROCESS: templates but not extension tags
2693 * self::OT_HTML: all templates and extension tags
2694 *
2695 * @param string $tex The text to transform
2696 * @param PPFrame $frame Object describing the arguments passed to the template.
2697 * Arguments may also be provided as an associative array, as was the usual case before MW1.12.
2698 * Providing arguments this way may be useful for extensions wishing to perform variable replacement explicitly.
2699 * @param bool $argsOnly Only do argument (triple-brace) expansion, not double-brace expansion
2700 * @private
2701 */
2702 function replaceVariables( $text, $frame = false, $argsOnly = false ) {
2703 # Prevent too big inclusions
2704 if( strlen( $text ) > $this->mOptions->getMaxIncludeSize() ) {
2705 return $text;
2706 }
2707
2708 wfProfileIn( __METHOD__ );
2709
2710 if ( $frame === false ) {
2711 $frame = $this->getPreprocessor()->newFrame();
2712 } elseif ( !( $frame instanceof PPFrame ) ) {
2713 wfDebug( __METHOD__." called using plain parameters instead of a PPFrame instance. Creating custom frame.\n" );
2714 $frame = $this->getPreprocessor()->newCustomFrame($frame);
2715 }
2716
2717 $dom = $this->preprocessToDom( $text );
2718 $flags = $argsOnly ? PPFrame::NO_TEMPLATES : 0;
2719 $text = $frame->expand( $dom, $flags );
2720
2721 wfProfileOut( __METHOD__ );
2722 return $text;
2723 }
2724
2725 /// Clean up argument array - refactored in 1.9 so parserfunctions can use it, too.
2726 static function createAssocArgs( $args ) {
2727 $assocArgs = array();
2728 $index = 1;
2729 foreach( $args as $arg ) {
2730 $eqpos = strpos( $arg, '=' );
2731 if ( $eqpos === false ) {
2732 $assocArgs[$index++] = $arg;
2733 } else {
2734 $name = trim( substr( $arg, 0, $eqpos ) );
2735 $value = trim( substr( $arg, $eqpos+1 ) );
2736 if ( $value === false ) {
2737 $value = '';
2738 }
2739 if ( $name !== false ) {
2740 $assocArgs[$name] = $value;
2741 }
2742 }
2743 }
2744
2745 return $assocArgs;
2746 }
2747
2748 /**
2749 * Warn the user when a parser limitation is reached
2750 * Will warn at most once the user per limitation type
2751 *
2752 * @param string $limitationType, should be one of:
2753 * 'expensive-parserfunction' (corresponding messages: 'expensive-parserfunction-warning', 'expensive-parserfunction-category')
2754 * 'post-expand-template-argument' (corresponding messages: 'post-expand-template-argument-warning', 'post-expand-template-argument-category')
2755 * 'post-expand-template-inclusion' (corresponding messages: 'post-expand-template-inclusion-warning', 'post-expand-template-inclusion-category')
2756 * @params int $current, $max When an explicit limit has been
2757 * exceeded, provide the values (optional)
2758 */
2759 function limitationWarn( $limitationType, $current=null, $max=null) {
2760 $msgName = $limitationType . '-warning';
2761 //does no harm if $current and $max are present but are unnecessary for the message
2762 $warning = wfMsgExt( $msgName, array( 'parsemag', 'escape' ), $current, $max );
2763 $this->mOutput->addWarning( $warning );
2764 $cat = Title::makeTitleSafe( NS_CATEGORY, wfMsgForContent( $limitationType . '-category' ) );
2765 if ( $cat ) {
2766 $this->mOutput->addCategory( $cat->getDBkey(), $this->getDefaultSort() );
2767 }
2768 }
2769
2770 /**
2771 * Return the text of a template, after recursively
2772 * replacing any variables or templates within the template.
2773 *
2774 * @param array $piece The parts of the template
2775 * $piece['title']: the title, i.e. the part before the |
2776 * $piece['parts']: the parameter array
2777 * $piece['lineStart']: whether the brace was at the start of a line
2778 * @param PPFrame The current frame, contains template arguments
2779 * @return string the text of the template
2780 * @private
2781 */
2782 function braceSubstitution( $piece, $frame ) {
2783 global $wgContLang, $wgAllowDisplayTitle, $wgNonincludableNamespaces;
2784 wfProfileIn( __METHOD__ );
2785 wfProfileIn( __METHOD__.'-setup' );
2786
2787 # Flags
2788 $found = false; # $text has been filled
2789 $nowiki = false; # wiki markup in $text should be escaped
2790 $isHTML = false; # $text is HTML, armour it against wikitext transformation
2791 $forceRawInterwiki = false; # Force interwiki transclusion to be done in raw mode not rendered
2792 $isChildObj = false; # $text is a DOM node needing expansion in a child frame
2793 $isLocalObj = false; # $text is a DOM node needing expansion in the current frame
2794
2795 # Title object, where $text came from
2796 $title = NULL;
2797
2798 # $part1 is the bit before the first |, and must contain only title characters.
2799 # Various prefixes will be stripped from it later.
2800 $titleWithSpaces = $frame->expand( $piece['title'] );
2801 $part1 = trim( $titleWithSpaces );
2802 $titleText = false;
2803
2804 # Original title text preserved for various purposes
2805 $originalTitle = $part1;
2806
2807 # $args is a list of argument nodes, starting from index 0, not including $part1
2808 $args = (null == $piece['parts']) ? array() : $piece['parts'];
2809 wfProfileOut( __METHOD__.'-setup' );
2810
2811 # SUBST
2812 wfProfileIn( __METHOD__.'-modifiers' );
2813 if ( !$found ) {
2814 $mwSubst = MagicWord::get( 'subst' );
2815 if ( $mwSubst->matchStartAndRemove( $part1 ) xor $this->ot['wiki'] ) {
2816 # One of two possibilities is true:
2817 # 1) Found SUBST but not in the PST phase
2818 # 2) Didn't find SUBST and in the PST phase
2819 # In either case, return without further processing
2820 $text = $frame->virtualBracketedImplode( '{{', '|', '}}', $titleWithSpaces, $args );
2821 $isLocalObj = true;
2822 $found = true;
2823 }
2824 }
2825
2826 # Variables
2827 if ( !$found && $args->getLength() == 0 ) {
2828 $id = $this->mVariables->matchStartToEnd( $part1 );
2829 if ( $id !== false ) {
2830 $text = $this->getVariableValue( $id );
2831 if (MagicWord::getCacheTTL($id)>-1)
2832 $this->mOutput->mContainsOldMagic = true;
2833 $found = true;
2834 }
2835 }
2836
2837 # MSG, MSGNW and RAW
2838 if ( !$found ) {
2839 # Check for MSGNW:
2840 $mwMsgnw = MagicWord::get( 'msgnw' );
2841 if ( $mwMsgnw->matchStartAndRemove( $part1 ) ) {
2842 $nowiki = true;
2843 } else {
2844 # Remove obsolete MSG:
2845 $mwMsg = MagicWord::get( 'msg' );
2846 $mwMsg->matchStartAndRemove( $part1 );
2847 }
2848
2849 # Check for RAW:
2850 $mwRaw = MagicWord::get( 'raw' );
2851 if ( $mwRaw->matchStartAndRemove( $part1 ) ) {
2852 $forceRawInterwiki = true;
2853 }
2854 }
2855 wfProfileOut( __METHOD__.'-modifiers' );
2856
2857 # Parser functions
2858 if ( !$found ) {
2859 wfProfileIn( __METHOD__ . '-pfunc' );
2860
2861 $colonPos = strpos( $part1, ':' );
2862 if ( $colonPos !== false ) {
2863 # Case sensitive functions
2864 $function = substr( $part1, 0, $colonPos );
2865 if ( isset( $this->mFunctionSynonyms[1][$function] ) ) {
2866 $function = $this->mFunctionSynonyms[1][$function];
2867 } else {
2868 # Case insensitive functions
2869 $function = strtolower( $function );
2870 if ( isset( $this->mFunctionSynonyms[0][$function] ) ) {
2871 $function = $this->mFunctionSynonyms[0][$function];
2872 } else {
2873 $function = false;
2874 }
2875 }
2876 if ( $function ) {
2877 list( $callback, $flags ) = $this->mFunctionHooks[$function];
2878 $initialArgs = array( &$this );
2879 $funcArgs = array( trim( substr( $part1, $colonPos + 1 ) ) );
2880 if ( $flags & SFH_OBJECT_ARGS ) {
2881 # Add a frame parameter, and pass the arguments as an array
2882 $allArgs = $initialArgs;
2883 $allArgs[] = $frame;
2884 for ( $i = 0; $i < $args->getLength(); $i++ ) {
2885 $funcArgs[] = $args->item( $i );
2886 }
2887 $allArgs[] = $funcArgs;
2888 } else {
2889 # Convert arguments to plain text
2890 for ( $i = 0; $i < $args->getLength(); $i++ ) {
2891 $funcArgs[] = trim( $frame->expand( $args->item( $i ) ) );
2892 }
2893 $allArgs = array_merge( $initialArgs, $funcArgs );
2894 }
2895
2896 # Workaround for PHP bug 35229 and similar
2897 if ( !is_callable( $callback ) ) {
2898 throw new MWException( "Tag hook for $function is not callable\n" );
2899 }
2900 $result = call_user_func_array( $callback, $allArgs );
2901 $found = true;
2902 $noparse = true;
2903 $preprocessFlags = 0;
2904
2905 if ( is_array( $result ) ) {
2906 if ( isset( $result[0] ) ) {
2907 $text = $result[0];
2908 unset( $result[0] );
2909 }
2910
2911 // Extract flags into the local scope
2912 // This allows callers to set flags such as nowiki, found, etc.
2913 extract( $result );
2914 } else {
2915 $text = $result;
2916 }
2917 if ( !$noparse ) {
2918 $text = $this->preprocessToDom( $text, $preprocessFlags );
2919 $isChildObj = true;
2920 }
2921 }
2922 }
2923 wfProfileOut( __METHOD__ . '-pfunc' );
2924 }
2925
2926 # Finish mangling title and then check for loops.
2927 # Set $title to a Title object and $titleText to the PDBK
2928 if ( !$found ) {
2929 $ns = NS_TEMPLATE;
2930 # Split the title into page and subpage
2931 $subpage = '';
2932 $part1 = $this->maybeDoSubpageLink( $part1, $subpage );
2933 if ($subpage !== '') {
2934 $ns = $this->mTitle->getNamespace();
2935 }
2936 $title = Title::newFromText( $part1, $ns );
2937 if ( $title ) {
2938 $titleText = $title->getPrefixedText();
2939 # Check for language variants if the template is not found
2940 if($wgContLang->hasVariants() && $title->getArticleID() == 0){
2941 $wgContLang->findVariantLink( $part1, $title, true );
2942 }
2943 # Do infinite loop check
2944 if ( !$frame->loopCheck( $title ) ) {
2945 $found = true;
2946 $text = '<span class="error">' . wfMsgForContent( 'parser-template-loop-warning', $titleText ) . '</span>';
2947 wfDebug( __METHOD__.": template loop broken at '$titleText'\n" );
2948 }
2949 # Do recursion depth check
2950 $limit = $this->mOptions->getMaxTemplateDepth();
2951 if ( $frame->depth >= $limit ) {
2952 $found = true;
2953 $text = '<span class="error">' . wfMsgForContent( 'parser-template-recursion-depth-warning', $limit ) . '</span>';
2954 }
2955 }
2956 }
2957
2958 # Load from database
2959 if ( !$found && $title ) {
2960 wfProfileIn( __METHOD__ . '-loadtpl' );
2961 if ( !$title->isExternal() ) {
2962 if ( $title->getNamespace() == NS_SPECIAL && $this->mOptions->getAllowSpecialInclusion() && $this->ot['html'] ) {
2963 $text = SpecialPage::capturePath( $title );
2964 if ( is_string( $text ) ) {
2965 $found = true;
2966 $isHTML = true;
2967 $this->disableCache();
2968 }
2969 } else if ( $wgNonincludableNamespaces && in_array( $title->getNamespace(), $wgNonincludableNamespaces ) ) {
2970 $found = false; //access denied
2971 wfDebug( __METHOD__.": template inclusion denied for " . $title->getPrefixedDBkey() );
2972 } else {
2973 list( $text, $title ) = $this->getTemplateDom( $title );
2974 if ( $text !== false ) {
2975 $found = true;
2976 $isChildObj = true;
2977 }
2978 }
2979
2980 # If the title is valid but undisplayable, make a link to it
2981 if ( !$found && ( $this->ot['html'] || $this->ot['pre'] ) ) {
2982 $text = "[[:$titleText]]";
2983 $found = true;
2984 }
2985 } elseif ( $title->isTrans() ) {
2986 // Interwiki transclusion
2987 if ( $this->ot['html'] && !$forceRawInterwiki ) {
2988 $text = $this->interwikiTransclude( $title, 'render' );
2989 $isHTML = true;
2990 } else {
2991 $text = $this->interwikiTransclude( $title, 'raw' );
2992 // Preprocess it like a template
2993 $text = $this->preprocessToDom( $text, self::PTD_FOR_INCLUSION );
2994 $isChildObj = true;
2995 }
2996 $found = true;
2997 }
2998 wfProfileOut( __METHOD__ . '-loadtpl' );
2999 }
3000
3001 # If we haven't found text to substitute by now, we're done
3002 # Recover the source wikitext and return it
3003 if ( !$found ) {
3004 $text = $frame->virtualBracketedImplode( '{{', '|', '}}', $titleWithSpaces, $args );
3005 wfProfileOut( __METHOD__ );
3006 return array( 'object' => $text );
3007 }
3008
3009 # Expand DOM-style return values in a child frame
3010 if ( $isChildObj ) {
3011 # Clean up argument array
3012 $newFrame = $frame->newChild( $args, $title );
3013
3014 if ( $nowiki ) {
3015 $text = $newFrame->expand( $text, PPFrame::RECOVER_ORIG );
3016 } elseif ( $titleText !== false && $newFrame->isEmpty() ) {
3017 # Expansion is eligible for the empty-frame cache
3018 if ( isset( $this->mTplExpandCache[$titleText] ) ) {
3019 $text = $this->mTplExpandCache[$titleText];
3020 } else {
3021 $text = $newFrame->expand( $text );
3022 $this->mTplExpandCache[$titleText] = $text;
3023 }
3024 } else {
3025 # Uncached expansion
3026 $text = $newFrame->expand( $text );
3027 }
3028 }
3029 if ( $isLocalObj && $nowiki ) {
3030 $text = $frame->expand( $text, PPFrame::RECOVER_ORIG );
3031 $isLocalObj = false;
3032 }
3033
3034 # Replace raw HTML by a placeholder
3035 # Add a blank line preceding, to prevent it from mucking up
3036 # immediately preceding headings
3037 if ( $isHTML ) {
3038 $text = "\n\n" . $this->insertStripItem( $text );
3039 }
3040 # Escape nowiki-style return values
3041 elseif ( $nowiki && ( $this->ot['html'] || $this->ot['pre'] ) ) {
3042 $text = wfEscapeWikiText( $text );
3043 }
3044 # Bug 529: if the template begins with a table or block-level
3045 # element, it should be treated as beginning a new line.
3046 # This behaviour is somewhat controversial.
3047 elseif ( is_string( $text ) && !$piece['lineStart'] && preg_match('/^(?:{\\||:|;|#|\*)/', $text)) /*}*/{
3048 $text = "\n" . $text;
3049 }
3050
3051 if ( is_string( $text ) && !$this->incrementIncludeSize( 'post-expand', strlen( $text ) ) ) {
3052 # Error, oversize inclusion
3053 $text = "[[$originalTitle]]" .
3054 $this->insertStripItem( '<!-- WARNING: template omitted, post-expand include size too large -->' );
3055 $this->limitationWarn( 'post-expand-template-inclusion' );
3056 }
3057
3058 if ( $isLocalObj ) {
3059 $ret = array( 'object' => $text );
3060 } else {
3061 $ret = array( 'text' => $text );
3062 }
3063
3064 wfProfileOut( __METHOD__ );
3065 return $ret;
3066 }
3067
3068 /**
3069 * Get the semi-parsed DOM representation of a template with a given title,
3070 * and its redirect destination title. Cached.
3071 */
3072 function getTemplateDom( $title ) {
3073 $cacheTitle = $title;
3074 $titleText = $title->getPrefixedDBkey();
3075
3076 if ( isset( $this->mTplRedirCache[$titleText] ) ) {
3077 list( $ns, $dbk ) = $this->mTplRedirCache[$titleText];
3078 $title = Title::makeTitle( $ns, $dbk );
3079 $titleText = $title->getPrefixedDBkey();
3080 }
3081 if ( isset( $this->mTplDomCache[$titleText] ) ) {
3082 return array( $this->mTplDomCache[$titleText], $title );
3083 }
3084
3085 // Cache miss, go to the database
3086 list( $text, $title ) = $this->fetchTemplateAndTitle( $title );
3087
3088 if ( $text === false ) {
3089 $this->mTplDomCache[$titleText] = false;
3090 return array( false, $title );
3091 }
3092
3093 $dom = $this->preprocessToDom( $text, self::PTD_FOR_INCLUSION );
3094 $this->mTplDomCache[ $titleText ] = $dom;
3095
3096 if (! $title->equals($cacheTitle)) {
3097 $this->mTplRedirCache[$cacheTitle->getPrefixedDBkey()] =
3098 array( $title->getNamespace(),$cdb = $title->getDBkey() );
3099 }
3100
3101 return array( $dom, $title );
3102 }
3103
3104 /**
3105 * Fetch the unparsed text of a template and register a reference to it.
3106 */
3107 function fetchTemplateAndTitle( $title ) {
3108 $templateCb = $this->mOptions->getTemplateCallback();
3109 $stuff = call_user_func( $templateCb, $title, $this );
3110 $text = $stuff['text'];
3111 $finalTitle = isset( $stuff['finalTitle'] ) ? $stuff['finalTitle'] : $title;
3112 if ( isset( $stuff['deps'] ) ) {
3113 foreach ( $stuff['deps'] as $dep ) {
3114 $this->mOutput->addTemplate( $dep['title'], $dep['page_id'], $dep['rev_id'] );
3115 }
3116 }
3117 return array($text,$finalTitle);
3118 }
3119
3120 function fetchTemplate( $title ) {
3121 $rv = $this->fetchTemplateAndTitle($title);
3122 return $rv[0];
3123 }
3124
3125 /**
3126 * Static function to get a template
3127 * Can be overridden via ParserOptions::setTemplateCallback().
3128 */
3129 static function statelessFetchTemplate( $title, $parser=false ) {
3130 $text = $skip = false;
3131 $finalTitle = $title;
3132 $deps = array();
3133
3134 // Loop to fetch the article, with up to 1 redirect
3135 for ( $i = 0; $i < 2 && is_object( $title ); $i++ ) {
3136 # Give extensions a chance to select the revision instead
3137 $id = false; // Assume current
3138 wfRunHooks( 'BeforeParserFetchTemplateAndtitle', array( $parser, &$title, &$skip, &$id ) );
3139
3140 if( $skip ) {
3141 $text = false;
3142 $deps[] = array(
3143 'title' => $title,
3144 'page_id' => $title->getArticleID(),
3145 'rev_id' => null );
3146 break;
3147 }
3148 $rev = $id ? Revision::newFromId( $id ) : Revision::newFromTitle( $title );
3149 $rev_id = $rev ? $rev->getId() : 0;
3150 // If there is no current revision, there is no page
3151 if( $id === false && !$rev ) {
3152 $linkCache = LinkCache::singleton();
3153 $linkCache->addBadLinkObj( $title );
3154 }
3155
3156 $deps[] = array(
3157 'title' => $title,
3158 'page_id' => $title->getArticleID(),
3159 'rev_id' => $rev_id );
3160
3161 if( $rev ) {
3162 $text = $rev->getText();
3163 } elseif( $title->getNamespace() == NS_MEDIAWIKI ) {
3164 global $wgContLang;
3165 $message = $wgContLang->lcfirst( $title->getText() );
3166 $text = wfMsgForContentNoTrans( $message );
3167 if( wfEmptyMsg( $message, $text ) ) {
3168 $text = false;
3169 break;
3170 }
3171 } else {
3172 break;
3173 }
3174 if ( $text === false ) {
3175 break;
3176 }
3177 // Redirect?
3178 $finalTitle = $title;
3179 $title = Title::newFromRedirect( $text );
3180 }
3181 return array(
3182 'text' => $text,
3183 'finalTitle' => $finalTitle,
3184 'deps' => $deps );
3185 }
3186
3187 /**
3188 * Transclude an interwiki link.
3189 */
3190 function interwikiTransclude( $title, $action ) {
3191 global $wgEnableScaryTranscluding;
3192
3193 if (!$wgEnableScaryTranscluding)
3194 return wfMsg('scarytranscludedisabled');
3195
3196 $url = $title->getFullUrl( "action=$action" );
3197
3198 if (strlen($url) > 255)
3199 return wfMsg('scarytranscludetoolong');
3200 return $this->fetchScaryTemplateMaybeFromCache($url);
3201 }
3202
3203 function fetchScaryTemplateMaybeFromCache($url) {
3204 global $wgTranscludeCacheExpiry;
3205 $dbr = wfGetDB(DB_SLAVE);
3206 $obj = $dbr->selectRow('transcache', array('tc_time', 'tc_contents'),
3207 array('tc_url' => $url));
3208 if ($obj) {
3209 $time = $obj->tc_time;
3210 $text = $obj->tc_contents;
3211 if ($time && time() < $time + $wgTranscludeCacheExpiry ) {
3212 return $text;
3213 }
3214 }
3215
3216 $text = Http::get($url);
3217 if (!$text)
3218 return wfMsg('scarytranscludefailed', $url);
3219
3220 $dbw = wfGetDB(DB_MASTER);
3221 $dbw->replace('transcache', array('tc_url'), array(
3222 'tc_url' => $url,
3223 'tc_time' => time(),
3224 'tc_contents' => $text));
3225 return $text;
3226 }
3227
3228
3229 /**
3230 * Triple brace replacement -- used for template arguments
3231 * @private
3232 */
3233 function argSubstitution( $piece, $frame ) {
3234 wfProfileIn( __METHOD__ );
3235
3236 $error = false;
3237 $parts = $piece['parts'];
3238 $nameWithSpaces = $frame->expand( $piece['title'] );
3239 $argName = trim( $nameWithSpaces );
3240 $object = false;
3241 $text = $frame->getArgument( $argName );
3242 if ( $text === false && $parts->getLength() > 0
3243 && (
3244 $this->ot['html']
3245 || $this->ot['pre']
3246 || ( $this->ot['wiki'] && $frame->isTemplate() )
3247 )
3248 ) {
3249 # No match in frame, use the supplied default
3250 $object = $parts->item( 0 )->getChildren();
3251 }
3252 if ( !$this->incrementIncludeSize( 'arg', strlen( $text ) ) ) {
3253 $error = '<!-- WARNING: argument omitted, expansion size too large -->';
3254 $this->limitationWarn( 'post-expand-template-argument' );
3255 }
3256
3257 if ( $text === false && $object === false ) {
3258 # No match anywhere
3259 $object = $frame->virtualBracketedImplode( '{{{', '|', '}}}', $nameWithSpaces, $parts );
3260 }
3261 if ( $error !== false ) {
3262 $text .= $error;
3263 }
3264 if ( $object !== false ) {
3265 $ret = array( 'object' => $object );
3266 } else {
3267 $ret = array( 'text' => $text );
3268 }
3269
3270 wfProfileOut( __METHOD__ );
3271 return $ret;
3272 }
3273
3274 /**
3275 * Return the text to be used for a given extension tag.
3276 * This is the ghost of strip().
3277 *
3278 * @param array $params Associative array of parameters:
3279 * name PPNode for the tag name
3280 * attr PPNode for unparsed text where tag attributes are thought to be
3281 * attributes Optional associative array of parsed attributes
3282 * inner Contents of extension element
3283 * noClose Original text did not have a close tag
3284 * @param PPFrame $frame
3285 */
3286 function extensionSubstitution( $params, $frame ) {
3287 global $wgRawHtml, $wgContLang;
3288
3289 $name = $frame->expand( $params['name'] );
3290 $attrText = !isset( $params['attr'] ) ? null : $frame->expand( $params['attr'] );
3291 $content = !isset( $params['inner'] ) ? null : $frame->expand( $params['inner'] );
3292
3293 $marker = "{$this->mUniqPrefix}-$name-" . sprintf('%08X', $this->mMarkerIndex++) . self::MARKER_SUFFIX;
3294
3295 if ( $this->ot['html'] ) {
3296 $name = strtolower( $name );
3297
3298 $attributes = Sanitizer::decodeTagAttributes( $attrText );
3299 if ( isset( $params['attributes'] ) ) {
3300 $attributes = $attributes + $params['attributes'];
3301 }
3302 switch ( $name ) {
3303 case 'html':
3304 if( $wgRawHtml ) {
3305 $output = $content;
3306 break;
3307 } else {
3308 throw new MWException( '<html> extension tag encountered unexpectedly' );
3309 }
3310 case 'nowiki':
3311 $output = Xml::escapeTagsOnly( $content );
3312 break;
3313 case 'math':
3314 $output = $wgContLang->armourMath(
3315 MathRenderer::renderMath( $content, $attributes ) );
3316 break;
3317 case 'gallery':
3318 $output = $this->renderImageGallery( $content, $attributes );
3319 break;
3320 case 'poem':
3321 $output = $this->renderPoem( $content, $attributes );
3322 break;
3323 default:
3324 if( isset( $this->mTagHooks[$name] ) ) {
3325 # Workaround for PHP bug 35229 and similar
3326 if ( !is_callable( $this->mTagHooks[$name] ) ) {
3327 throw new MWException( "Tag hook for $name is not callable\n" );
3328 }
3329 $output = call_user_func_array( $this->mTagHooks[$name],
3330 array( $content, $attributes, $this ) );
3331 } else {
3332 $output = '<span class="error">Invalid tag extension name: ' .
3333 htmlspecialchars( $name ) . '</span>';
3334 }
3335 }
3336 } else {
3337 if ( is_null( $attrText ) ) {
3338 $attrText = '';
3339 }
3340 if ( isset( $params['attributes'] ) ) {
3341 foreach ( $params['attributes'] as $attrName => $attrValue ) {
3342 $attrText .= ' ' . htmlspecialchars( $attrName ) . '="' .
3343 htmlspecialchars( $attrValue ) . '"';
3344 }
3345 }
3346 if ( $content === null ) {
3347 $output = "<$name$attrText/>";
3348 } else {
3349 $close = is_null( $params['close'] ) ? '' : $frame->expand( $params['close'] );
3350 $output = "<$name$attrText>$content$close";
3351 }
3352 }
3353
3354 if ( $name === 'html' || $name === 'nowiki' ) {
3355 $this->mStripState->nowiki->setPair( $marker, $output );
3356 } else {
3357 $this->mStripState->general->setPair( $marker, $output );
3358 }
3359 return $marker;
3360 }
3361
3362 /**
3363 * Increment an include size counter
3364 *
3365 * @param string $type The type of expansion
3366 * @param integer $size The size of the text
3367 * @return boolean False if this inclusion would take it over the maximum, true otherwise
3368 */
3369 function incrementIncludeSize( $type, $size ) {
3370 if ( $this->mIncludeSizes[$type] + $size > $this->mOptions->getMaxIncludeSize( $type ) ) {
3371 return false;
3372 } else {
3373 $this->mIncludeSizes[$type] += $size;
3374 return true;
3375 }
3376 }
3377
3378 /**
3379 * Increment the expensive function count
3380 *
3381 * @return boolean False if the limit has been exceeded
3382 */
3383 function incrementExpensiveFunctionCount() {
3384 global $wgExpensiveParserFunctionLimit;
3385 $this->mExpensiveFunctionCount++;
3386 if($this->mExpensiveFunctionCount <= $wgExpensiveParserFunctionLimit) {
3387 return true;
3388 }
3389 return false;
3390 }
3391
3392 /**
3393 * Strip double-underscore items like __NOGALLERY__ and __NOTOC__
3394 * Fills $this->mDoubleUnderscores, returns the modified text
3395 */
3396 function doDoubleUnderscore( $text ) {
3397 // The position of __TOC__ needs to be recorded
3398 $mw = MagicWord::get( 'toc' );
3399 if( $mw->match( $text ) ) {
3400 $this->mShowToc = true;
3401 $this->mForceTocPosition = true;
3402
3403 // Set a placeholder. At the end we'll fill it in with the TOC.
3404 $text = $mw->replace( '<!--MWTOC-->', $text, 1 );
3405
3406 // Only keep the first one.
3407 $text = $mw->replace( '', $text );
3408 }
3409
3410 // Now match and remove the rest of them
3411 $mwa = MagicWord::getDoubleUnderscoreArray();
3412 $this->mDoubleUnderscores = $mwa->matchAndRemove( $text );
3413
3414 if ( isset( $this->mDoubleUnderscores['nogallery'] ) ) {
3415 $this->mOutput->mNoGallery = true;
3416 }
3417 if ( isset( $this->mDoubleUnderscores['notoc'] ) && !$this->mForceTocPosition ) {
3418 $this->mShowToc = false;
3419 }
3420 if ( isset( $this->mDoubleUnderscores['hiddencat'] ) && $this->mTitle->getNamespace() == NS_CATEGORY ) {
3421 $this->mOutput->setProperty( 'hiddencat', 'y' );
3422
3423 $containerCategory = Title::makeTitleSafe( NS_CATEGORY, wfMsgForContent( 'hidden-category-category' ) );
3424 if ( $containerCategory ) {
3425 $this->mOutput->addCategory( $containerCategory->getDBkey(), $this->getDefaultSort() );
3426 } else {
3427 wfDebug( __METHOD__.": [[MediaWiki:hidden-category-category]] is not a valid title!\n" );
3428 }
3429 }
3430 # (bug 8068) Allow control over whether robots index a page.
3431 #
3432 # FIXME (bug 14899): __INDEX__ always overrides __NOINDEX__ here! This
3433 # is not desirable, the last one on the page should win.
3434 if( isset( $this->mDoubleUnderscores['noindex'] ) ) {
3435 $this->mOutput->setIndexPolicy( 'noindex' );
3436 } elseif( isset( $this->mDoubleUnderscores['index'] ) ) {
3437 $this->mOutput->setIndexPolicy( 'index' );
3438 }
3439
3440 return $text;
3441 }
3442
3443 /**
3444 * This function accomplishes several tasks:
3445 * 1) Auto-number headings if that option is enabled
3446 * 2) Add an [edit] link to sections for users who have enabled the option and can edit the page
3447 * 3) Add a Table of contents on the top for users who have enabled the option
3448 * 4) Auto-anchor headings
3449 *
3450 * It loops through all headlines, collects the necessary data, then splits up the
3451 * string and re-inserts the newly formatted headlines.
3452 *
3453 * @param string $text
3454 * @param boolean $isMain
3455 * @private
3456 */
3457 function formatHeadings( $text, $isMain=true ) {
3458 global $wgMaxTocLevel, $wgContLang;
3459
3460 $doNumberHeadings = $this->mOptions->getNumberHeadings();
3461 $showEditLink = $this->mOptions->getEditSection();
3462
3463 // Do not call quickUserCan unless necessary
3464 if( $showEditLink && !$this->mTitle->quickUserCan( 'edit' ) ) {
3465 $showEditLink = 0;
3466 }
3467
3468 # Inhibit editsection links if requested in the page
3469 if ( isset( $this->mDoubleUnderscores['noeditsection'] ) ) {
3470 $showEditLink = 0;
3471 }
3472
3473 # Get all headlines for numbering them and adding funky stuff like [edit]
3474 # links - this is for later, but we need the number of headlines right now
3475 $matches = array();
3476 $numMatches = preg_match_all( '/<H(?P<level>[1-6])(?P<attrib>.*?'.'>)(?P<header>.*?)<\/H[1-6] *>/i', $text, $matches );
3477
3478 # if there are fewer than 4 headlines in the article, do not show TOC
3479 # unless it's been explicitly enabled.
3480 $enoughToc = $this->mShowToc &&
3481 (($numMatches >= 4) || $this->mForceTocPosition);
3482
3483 # Allow user to stipulate that a page should have a "new section"
3484 # link added via __NEWSECTIONLINK__
3485 if ( isset( $this->mDoubleUnderscores['newsectionlink'] ) ) {
3486 $this->mOutput->setNewSection( true );
3487 }
3488
3489 # if the string __FORCETOC__ (not case-sensitive) occurs in the HTML,
3490 # override above conditions and always show TOC above first header
3491 if ( isset( $this->mDoubleUnderscores['forcetoc'] ) ) {
3492 $this->mShowToc = true;
3493 $enoughToc = true;
3494 }
3495
3496 # We need this to perform operations on the HTML
3497 $sk = $this->mOptions->getSkin();
3498
3499 # headline counter
3500 $headlineCount = 0;
3501 $numVisible = 0;
3502
3503 # Ugh .. the TOC should have neat indentation levels which can be
3504 # passed to the skin functions. These are determined here
3505 $toc = '';
3506 $full = '';
3507 $head = array();
3508 $sublevelCount = array();
3509 $levelCount = array();
3510 $toclevel = 0;
3511 $level = 0;
3512 $prevlevel = 0;
3513 $toclevel = 0;
3514 $prevtoclevel = 0;
3515 $markerRegex = "{$this->mUniqPrefix}-h-(\d+)-" . self::MARKER_SUFFIX;
3516 $baseTitleText = $this->mTitle->getPrefixedDBkey();
3517 $tocraw = array();
3518
3519 foreach( $matches[3] as $headline ) {
3520 $isTemplate = false;
3521 $titleText = false;
3522 $sectionIndex = false;
3523 $numbering = '';
3524 $markerMatches = array();
3525 if (preg_match("/^$markerRegex/", $headline, $markerMatches)) {
3526 $serial = $markerMatches[1];
3527 list( $titleText, $sectionIndex ) = $this->mHeadings[$serial];
3528 $isTemplate = ($titleText != $baseTitleText);
3529 $headline = preg_replace("/^$markerRegex/", "", $headline);
3530 }
3531
3532 if( $toclevel ) {
3533 $prevlevel = $level;
3534 $prevtoclevel = $toclevel;
3535 }
3536 $level = $matches[1][$headlineCount];
3537
3538 if( $doNumberHeadings || $enoughToc ) {
3539
3540 if ( $level > $prevlevel ) {
3541 # Increase TOC level
3542 $toclevel++;
3543 $sublevelCount[$toclevel] = 0;
3544 if( $toclevel<$wgMaxTocLevel ) {
3545 $prevtoclevel = $toclevel;
3546 $toc .= $sk->tocIndent();
3547 $numVisible++;
3548 }
3549 }
3550 elseif ( $level < $prevlevel && $toclevel > 1 ) {
3551 # Decrease TOC level, find level to jump to
3552
3553 if ( $toclevel == 2 && $level <= $levelCount[1] ) {
3554 # Can only go down to level 1
3555 $toclevel = 1;
3556 } else {
3557 for ($i = $toclevel; $i > 0; $i--) {
3558 if ( $levelCount[$i] == $level ) {
3559 # Found last matching level
3560 $toclevel = $i;
3561 break;
3562 }
3563 elseif ( $levelCount[$i] < $level ) {
3564 # Found first matching level below current level
3565 $toclevel = $i + 1;
3566 break;
3567 }
3568 }
3569 }
3570 if( $toclevel<$wgMaxTocLevel ) {
3571 if($prevtoclevel < $wgMaxTocLevel) {
3572 # Unindent only if the previous toc level was shown :p
3573 $toc .= $sk->tocUnindent( $prevtoclevel - $toclevel );
3574 $prevtoclevel = $toclevel;
3575 } else {
3576 $toc .= $sk->tocLineEnd();
3577 }
3578 }
3579 }
3580 else {
3581 # No change in level, end TOC line
3582 if( $toclevel<$wgMaxTocLevel ) {
3583 $toc .= $sk->tocLineEnd();
3584 }
3585 }
3586
3587 $levelCount[$toclevel] = $level;
3588
3589 # count number of headlines for each level
3590 @$sublevelCount[$toclevel]++;
3591 $dot = 0;
3592 for( $i = 1; $i <= $toclevel; $i++ ) {
3593 if( !empty( $sublevelCount[$i] ) ) {
3594 if( $dot ) {
3595 $numbering .= '.';
3596 }
3597 $numbering .= $wgContLang->formatNum( $sublevelCount[$i] );
3598 $dot = 1;
3599 }
3600 }
3601 }
3602
3603 # The safe header is a version of the header text safe to use for links
3604 # Avoid insertion of weird stuff like <math> by expanding the relevant sections
3605 $safeHeadline = $this->mStripState->unstripBoth( $headline );
3606
3607 # Remove link placeholders by the link text.
3608 # <!--LINK number-->
3609 # turns into
3610 # link text with suffix
3611 $safeHeadline = $this->replaceLinkHoldersText( $safeHeadline );
3612
3613 # Strip out HTML (other than plain <sup> and <sub>: bug 8393)
3614 $tocline = preg_replace(
3615 array( '#<(?!/?(sup|sub)).*?'.'>#', '#<(/?(sup|sub)).*?'.'>#' ),
3616 array( '', '<$1>'),
3617 $safeHeadline
3618 );
3619 $tocline = trim( $tocline );
3620
3621 # For the anchor, strip out HTML-y stuff period
3622 $safeHeadline = preg_replace( '/<.*?'.'>/', '', $safeHeadline );
3623 $safeHeadline = trim( $safeHeadline );
3624
3625 # Save headline for section edit hint before it's escaped
3626 $headlineHint = $safeHeadline;
3627 $safeHeadline = Sanitizer::escapeId( $safeHeadline );
3628 # HTML names must be case-insensitively unique (bug 10721)
3629 $arrayKey = strtolower( $safeHeadline );
3630
3631 # count how many in assoc. array so we can track dupes in anchors
3632 isset( $refers[$arrayKey] ) ? $refers[$arrayKey]++ : $refers[$arrayKey] = 1;
3633 $refcount[$headlineCount] = $refers[$arrayKey];
3634
3635 # Don't number the heading if it is the only one (looks silly)
3636 if( $doNumberHeadings && count( $matches[3] ) > 1) {
3637 # the two are different if the line contains a link
3638 $headline=$numbering . ' ' . $headline;
3639 }
3640
3641 # Create the anchor for linking from the TOC to the section
3642 $anchor = $safeHeadline;
3643 if($refcount[$headlineCount] > 1 ) {
3644 $anchor .= '_' . $refcount[$headlineCount];
3645 }
3646 if( $enoughToc && ( !isset($wgMaxTocLevel) || $toclevel<$wgMaxTocLevel ) ) {
3647 $toc .= $sk->tocLine($anchor, $tocline, $numbering, $toclevel);
3648 $tocraw[] = array( 'toclevel' => $toclevel, 'level' => $level, 'line' => $tocline, 'number' => $numbering );
3649 }
3650 # give headline the correct <h#> tag
3651 if( $showEditLink && $sectionIndex !== false ) {
3652 if( $isTemplate ) {
3653 # Put a T flag in the section identifier, to indicate to extractSections()
3654 # that sections inside <includeonly> should be counted.
3655 $editlink = $sk->doEditSectionLink(Title::newFromText( $titleText ), "T-$sectionIndex");
3656 } else {
3657 $editlink = $sk->doEditSectionLink($this->mTitle, $sectionIndex, $headlineHint);
3658 }
3659 } else {
3660 $editlink = '';
3661 }
3662 $head[$headlineCount] = $sk->makeHeadline( $level, $matches['attrib'][$headlineCount], $anchor, $headline, $editlink );
3663
3664 $headlineCount++;
3665 }
3666
3667 $this->mOutput->setSections( $tocraw );
3668
3669 # Never ever show TOC if no headers
3670 if( $numVisible < 1 ) {
3671 $enoughToc = false;
3672 }
3673
3674 if( $enoughToc ) {
3675 if( $prevtoclevel > 0 && $prevtoclevel < $wgMaxTocLevel ) {
3676 $toc .= $sk->tocUnindent( $prevtoclevel - 1 );
3677 }
3678 $toc = $sk->tocList( $toc );
3679 }
3680
3681 # split up and insert constructed headlines
3682
3683 $blocks = preg_split( '/<H[1-6].*?' . '>.*?<\/H[1-6]>/i', $text );
3684 $i = 0;
3685
3686 foreach( $blocks as $block ) {
3687 if( $showEditLink && $headlineCount > 0 && $i == 0 && $block !== "\n" ) {
3688 # This is the [edit] link that appears for the top block of text when
3689 # section editing is enabled
3690
3691 # Disabled because it broke block formatting
3692 # For example, a bullet point in the top line
3693 # $full .= $sk->editSectionLink(0);
3694 }
3695 $full .= $block;
3696 if( $enoughToc && !$i && $isMain && !$this->mForceTocPosition ) {
3697 # Top anchor now in skin
3698 $full = $full.$toc;
3699 }
3700
3701 if( !empty( $head[$i] ) ) {
3702 $full .= $head[$i];
3703 }
3704 $i++;
3705 }
3706 if( $this->mForceTocPosition ) {
3707 return str_replace( '<!--MWTOC-->', $toc, $full );
3708 } else {
3709 return $full;
3710 }
3711 }
3712
3713 /**
3714 * Transform wiki markup when saving a page by doing \r\n -> \n
3715 * conversion, substitting signatures, {{subst:}} templates, etc.
3716 *
3717 * @param string $text the text to transform
3718 * @param Title &$title the Title object for the current article
3719 * @param User &$user the User object describing the current user
3720 * @param ParserOptions $options parsing options
3721 * @param bool $clearState whether to clear the parser state first
3722 * @return string the altered wiki markup
3723 * @public
3724 */
3725 function preSaveTransform( $text, &$title, $user, $options, $clearState = true ) {
3726 $this->mOptions = $options;
3727 $this->setTitle( $title );
3728 $this->setOutputType( self::OT_WIKI );
3729
3730 if ( $clearState ) {
3731 $this->clearState();
3732 }
3733
3734 $pairs = array(
3735 "\r\n" => "\n",
3736 );
3737 $text = str_replace( array_keys( $pairs ), array_values( $pairs ), $text );
3738 $text = $this->pstPass2( $text, $user );
3739 $text = $this->mStripState->unstripBoth( $text );
3740 return $text;
3741 }
3742
3743 /**
3744 * Pre-save transform helper function
3745 * @private
3746 */
3747 function pstPass2( $text, $user ) {
3748 global $wgContLang, $wgLocaltimezone;
3749
3750 /* Note: This is the timestamp saved as hardcoded wikitext to
3751 * the database, we use $wgContLang here in order to give
3752 * everyone the same signature and use the default one rather
3753 * than the one selected in each user's preferences.
3754 *
3755 * (see also bug 12815)
3756 */
3757 $ts = $this->mOptions->getTimestamp();
3758 $tz = wfMsgForContent( 'timezone-utc' );
3759 if ( isset( $wgLocaltimezone ) ) {
3760 $unixts = wfTimestamp( TS_UNIX, $ts );
3761 $oldtz = getenv( 'TZ' );
3762 putenv( 'TZ='.$wgLocaltimezone );
3763 $ts = date( 'YmdHis', $unixts );
3764 $tz = date( 'T', $unixts ); # might vary on DST changeover!
3765 putenv( 'TZ='.$oldtz );
3766 }
3767
3768 $d = $wgContLang->timeanddate( $ts, false, false ) . " ($tz)";
3769
3770 # Variable replacement
3771 # Because mOutputType is OT_WIKI, this will only process {{subst:xxx}} type tags
3772 $text = $this->replaceVariables( $text );
3773
3774 # Signatures
3775 $sigText = $this->getUserSig( $user );
3776 $text = strtr( $text, array(
3777 '~~~~~' => $d,
3778 '~~~~' => "$sigText $d",
3779 '~~~' => $sigText
3780 ) );
3781
3782 # Context links: [[|name]] and [[name (context)|]]
3783 #
3784 global $wgLegalTitleChars;
3785 $tc = "[$wgLegalTitleChars]";
3786 $nc = '[ _0-9A-Za-z\x80-\xff-]'; # Namespaces can use non-ascii!
3787
3788 $p1 = "/\[\[(:?$nc+:|:|)($tc+?)( \\($tc+\\))\\|]]/"; # [[ns:page (context)|]]
3789 $p4 = "/\[\[(:?$nc+:|:|)($tc+?)(($tc+))\\|]]/"; # [[ns:page(context)|]]
3790 $p3 = "/\[\[(:?$nc+:|:|)($tc+?)( \\($tc+\\)|)(, $tc+|)\\|]]/"; # [[ns:page (context), context|]]
3791 $p2 = "/\[\[\\|($tc+)]]/"; # [[|page]]
3792
3793 # try $p1 first, to turn "[[A, B (C)|]]" into "[[A, B (C)|A, B]]"
3794 $text = preg_replace( $p1, '[[\\1\\2\\3|\\2]]', $text );
3795 $text = preg_replace( $p4, '[[\\1\\2\\3|\\2]]', $text );
3796 $text = preg_replace( $p3, '[[\\1\\2\\3\\4|\\2]]', $text );
3797
3798 $t = $this->mTitle->getText();
3799 $m = array();
3800 if ( preg_match( "/^($nc+:|)$tc+?( \\($tc+\\))$/", $t, $m ) ) {
3801 $text = preg_replace( $p2, "[[$m[1]\\1$m[2]|\\1]]", $text );
3802 } elseif ( preg_match( "/^($nc+:|)$tc+?(, $tc+|)$/", $t, $m ) && '' != "$m[1]$m[2]" ) {
3803 $text = preg_replace( $p2, "[[$m[1]\\1$m[2]|\\1]]", $text );
3804 } else {
3805 # if there's no context, don't bother duplicating the title
3806 $text = preg_replace( $p2, '[[\\1]]', $text );
3807 }
3808
3809 # Trim trailing whitespace
3810 $text = rtrim( $text );
3811
3812 return $text;
3813 }
3814
3815 /**
3816 * Fetch the user's signature text, if any, and normalize to
3817 * validated, ready-to-insert wikitext.
3818 *
3819 * @param User $user
3820 * @return string
3821 * @private
3822 */
3823 function getUserSig( &$user ) {
3824 global $wgMaxSigChars;
3825
3826 $username = $user->getName();
3827 $nickname = $user->getOption( 'nickname' );
3828 $nickname = $nickname === '' ? $username : $nickname;
3829
3830 if( mb_strlen( $nickname ) > $wgMaxSigChars ) {
3831 $nickname = $username;
3832 wfDebug( __METHOD__ . ": $username has overlong signature.\n" );
3833 } elseif( $user->getBoolOption( 'fancysig' ) !== false ) {
3834 # Sig. might contain markup; validate this
3835 if( $this->validateSig( $nickname ) !== false ) {
3836 # Validated; clean up (if needed) and return it
3837 return $this->cleanSig( $nickname, true );
3838 } else {
3839 # Failed to validate; fall back to the default
3840 $nickname = $username;
3841 wfDebug( __METHOD__.": $username has bad XML tags in signature.\n" );
3842 }
3843 }
3844
3845 // Make sure nickname doesnt get a sig in a sig
3846 $nickname = $this->cleanSigInSig( $nickname );
3847
3848 # If we're still here, make it a link to the user page
3849 $userText = wfEscapeWikiText( $username );
3850 $nickText = wfEscapeWikiText( $nickname );
3851 if ( $user->isAnon() ) {
3852 return wfMsgExt( 'signature-anon', array( 'content', 'parsemag' ), $userText, $nickText );
3853 } else {
3854 return wfMsgExt( 'signature', array( 'content', 'parsemag' ), $userText, $nickText );
3855 }
3856 }
3857
3858 /**
3859 * Check that the user's signature contains no bad XML
3860 *
3861 * @param string $text
3862 * @return mixed An expanded string, or false if invalid.
3863 */
3864 function validateSig( $text ) {
3865 return( Xml::isWellFormedXmlFragment( $text ) ? $text : false );
3866 }
3867
3868 /**
3869 * Clean up signature text
3870 *
3871 * 1) Strip ~~~, ~~~~ and ~~~~~ out of signatures @see cleanSigInSig
3872 * 2) Substitute all transclusions
3873 *
3874 * @param string $text
3875 * @param $parsing Whether we're cleaning (preferences save) or parsing
3876 * @return string Signature text
3877 */
3878 function cleanSig( $text, $parsing = false ) {
3879 if ( !$parsing ) {
3880 global $wgTitle;
3881 $this->clearState();
3882 $this->setTitle( $wgTitle );
3883 $this->mOptions = new ParserOptions;
3884 $this->setOutputType = self::OT_PREPROCESS;
3885 }
3886
3887 # Option to disable this feature
3888 if ( !$this->mOptions->getCleanSignatures() ) {
3889 return $text;
3890 }
3891
3892 # FIXME: regex doesn't respect extension tags or nowiki
3893 # => Move this logic to braceSubstitution()
3894 $substWord = MagicWord::get( 'subst' );
3895 $substRegex = '/\{\{(?!(?:' . $substWord->getBaseRegex() . '))/x' . $substWord->getRegexCase();
3896 $substText = '{{' . $substWord->getSynonym( 0 );
3897
3898 $text = preg_replace( $substRegex, $substText, $text );
3899 $text = $this->cleanSigInSig( $text );
3900 $dom = $this->preprocessToDom( $text );
3901 $frame = $this->getPreprocessor()->newFrame();
3902 $text = $frame->expand( $dom );
3903
3904 if ( !$parsing ) {
3905 $text = $this->mStripState->unstripBoth( $text );
3906 }
3907
3908 return $text;
3909 }
3910
3911 /**
3912 * Strip ~~~, ~~~~ and ~~~~~ out of signatures
3913 * @param string $text
3914 * @return string Signature text with /~{3,5}/ removed
3915 */
3916 function cleanSigInSig( $text ) {
3917 $text = preg_replace( '/~{3,5}/', '', $text );
3918 return $text;
3919 }
3920
3921 /**
3922 * Set up some variables which are usually set up in parse()
3923 * so that an external function can call some class members with confidence
3924 * @public
3925 */
3926 function startExternalParse( &$title, $options, $outputType, $clearState = true ) {
3927 $this->setTitle( $title );
3928 $this->mOptions = $options;
3929 $this->setOutputType( $outputType );
3930 if ( $clearState ) {
3931 $this->clearState();
3932 }
3933 }
3934
3935 /**
3936 * Wrapper for preprocess()
3937 *
3938 * @param string $text the text to preprocess
3939 * @param ParserOptions $options options
3940 * @return string
3941 * @public
3942 */
3943 function transformMsg( $text, $options ) {
3944 global $wgTitle;
3945 static $executing = false;
3946
3947 # Guard against infinite recursion
3948 if ( $executing ) {
3949 return $text;
3950 }
3951 $executing = true;
3952
3953 wfProfileIn(__METHOD__);
3954 $text = $this->preprocess( $text, $wgTitle, $options );
3955
3956 $executing = false;
3957 wfProfileOut(__METHOD__);
3958 return $text;
3959 }
3960
3961 /**
3962 * Create an HTML-style tag, e.g. <yourtag>special text</yourtag>
3963 * The callback should have the following form:
3964 * function myParserHook( $text, $params, &$parser ) { ... }
3965 *
3966 * Transform and return $text. Use $parser for any required context, e.g. use
3967 * $parser->getTitle() and $parser->getOptions() not $wgTitle or $wgOut->mParserOptions
3968 *
3969 * @public
3970 *
3971 * @param mixed $tag The tag to use, e.g. 'hook' for <hook>
3972 * @param mixed $callback The callback function (and object) to use for the tag
3973 *
3974 * @return The old value of the mTagHooks array associated with the hook
3975 */
3976 function setHook( $tag, $callback ) {
3977 $tag = strtolower( $tag );
3978 $oldVal = isset( $this->mTagHooks[$tag] ) ? $this->mTagHooks[$tag] : null;
3979 $this->mTagHooks[$tag] = $callback;
3980 if( !in_array( $tag, $this->mStripList ) ) {
3981 $this->mStripList[] = $tag;
3982 }
3983
3984 return $oldVal;
3985 }
3986
3987 function setTransparentTagHook( $tag, $callback ) {
3988 $tag = strtolower( $tag );
3989 $oldVal = isset( $this->mTransparentTagHooks[$tag] ) ? $this->mTransparentTagHooks[$tag] : null;
3990 $this->mTransparentTagHooks[$tag] = $callback;
3991
3992 return $oldVal;
3993 }
3994
3995 /**
3996 * Remove all tag hooks
3997 */
3998 function clearTagHooks() {
3999 $this->mTagHooks = array();
4000 $this->mStripList = $this->mDefaultStripList;
4001 }
4002
4003 /**
4004 * Create a function, e.g. {{sum:1|2|3}}
4005 * The callback function should have the form:
4006 * function myParserFunction( &$parser, $arg1, $arg2, $arg3 ) { ... }
4007 *
4008 * Or with SFH_OBJECT_ARGS:
4009 * function myParserFunction( $parser, $frame, $args ) { ... }
4010 *
4011 * The callback may either return the text result of the function, or an array with the text
4012 * in element 0, and a number of flags in the other elements. The names of the flags are
4013 * specified in the keys. Valid flags are:
4014 * found The text returned is valid, stop processing the template. This
4015 * is on by default.
4016 * nowiki Wiki markup in the return value should be escaped
4017 * isHTML The returned text is HTML, armour it against wikitext transformation
4018 *
4019 * @public
4020 *
4021 * @param string $id The magic word ID
4022 * @param mixed $callback The callback function (and object) to use
4023 * @param integer $flags a combination of the following flags:
4024 * SFH_NO_HASH No leading hash, i.e. {{plural:...}} instead of {{#if:...}}
4025 *
4026 * SFH_OBJECT_ARGS Pass the template arguments as PPNode objects instead of text. This
4027 * allows for conditional expansion of the parse tree, allowing you to eliminate dead
4028 * branches and thus speed up parsing. It is also possible to analyse the parse tree of
4029 * the arguments, and to control the way they are expanded.
4030 *
4031 * The $frame parameter is a PPFrame. This can be used to produce expanded text from the
4032 * arguments, for instance:
4033 * $text = isset( $args[0] ) ? $frame->expand( $args[0] ) : '';
4034 *
4035 * For technical reasons, $args[0] is pre-expanded and will be a string. This may change in
4036 * future versions. Please call $frame->expand() on it anyway so that your code keeps
4037 * working if/when this is changed.
4038 *
4039 * If you want whitespace to be trimmed from $args, you need to do it yourself, post-
4040 * expansion.
4041 *
4042 * Please read the documentation in includes/parser/Preprocessor.php for more information
4043 * about the methods available in PPFrame and PPNode.
4044 *
4045 * @return The old callback function for this name, if any
4046 */
4047 function setFunctionHook( $id, $callback, $flags = 0 ) {
4048 $oldVal = isset( $this->mFunctionHooks[$id] ) ? $this->mFunctionHooks[$id][0] : null;
4049 $this->mFunctionHooks[$id] = array( $callback, $flags );
4050
4051 # Add to function cache
4052 $mw = MagicWord::get( $id );
4053 if( !$mw )
4054 throw new MWException( __METHOD__.'() expecting a magic word identifier.' );
4055
4056 $synonyms = $mw->getSynonyms();
4057 $sensitive = intval( $mw->isCaseSensitive() );
4058
4059 foreach ( $synonyms as $syn ) {
4060 # Case
4061 if ( !$sensitive ) {
4062 $syn = strtolower( $syn );
4063 }
4064 # Add leading hash
4065 if ( !( $flags & SFH_NO_HASH ) ) {
4066 $syn = '#' . $syn;
4067 }
4068 # Remove trailing colon
4069 if ( substr( $syn, -1, 1 ) === ':' ) {
4070 $syn = substr( $syn, 0, -1 );
4071 }
4072 $this->mFunctionSynonyms[$sensitive][$syn] = $id;
4073 }
4074 return $oldVal;
4075 }
4076
4077 /**
4078 * Get all registered function hook identifiers
4079 *
4080 * @return array
4081 */
4082 function getFunctionHooks() {
4083 return array_keys( $this->mFunctionHooks );
4084 }
4085
4086 /**
4087 * Replace <!--LINK--> link placeholders with actual links, in the buffer
4088 * Placeholders created in Skin::makeLinkObj()
4089 * Returns an array of link CSS classes, indexed by PDBK.
4090 */
4091 function replaceLinkHolders( &$text, $options = 0 ) {
4092 return $this->mLinkHolders->replace( $text );
4093 }
4094
4095 /**
4096 * Replace <!--LINK--> link placeholders with plain text of links
4097 * (not HTML-formatted).
4098 * @param string $text
4099 * @return string
4100 */
4101 function replaceLinkHoldersText( $text ) {
4102 return $this->mLinkHolders->replaceText( $text );
4103 }
4104
4105 /**
4106 * Tag hook handler for 'pre'.
4107 */
4108 function renderPreTag( $text, $attribs ) {
4109 // Backwards-compatibility hack
4110 $content = StringUtils::delimiterReplace( '<nowiki>', '</nowiki>', '$1', $text, 'i' );
4111
4112 $attribs = Sanitizer::validateTagAttributes( $attribs, 'pre' );
4113 return wfOpenElement( 'pre', $attribs ) .
4114 Xml::escapeTagsOnly( $content ) .
4115 '</pre>';
4116 }
4117
4118 /**
4119 * Renders an image gallery from a text with one line per image.
4120 * text labels may be given by using |-style alternative text. E.g.
4121 * Image:one.jpg|The number "1"
4122 * Image:tree.jpg|A tree
4123 * given as text will return the HTML of a gallery with two images,
4124 * labeled 'The number "1"' and
4125 * 'A tree'.
4126 */
4127 function renderImageGallery( $text, $params ) {
4128 $ig = new ImageGallery();
4129 $ig->setContextTitle( $this->mTitle );
4130 $ig->setShowBytes( false );
4131 $ig->setShowFilename( false );
4132 $ig->setParser( $this );
4133 $ig->setHideBadImages();
4134 $ig->setAttributes( Sanitizer::validateTagAttributes( $params, 'table' ) );
4135 $ig->useSkin( $this->mOptions->getSkin() );
4136 $ig->mRevisionId = $this->mRevisionId;
4137
4138 if( isset( $params['caption'] ) ) {
4139 $caption = $params['caption'];
4140 $caption = htmlspecialchars( $caption );
4141 $caption = $this->replaceInternalLinks( $caption );
4142 $ig->setCaptionHtml( $caption );
4143 }
4144 if( isset( $params['perrow'] ) ) {
4145 $ig->setPerRow( $params['perrow'] );
4146 }
4147 if( isset( $params['widths'] ) ) {
4148 $ig->setWidths( $params['widths'] );
4149 }
4150 if( isset( $params['heights'] ) ) {
4151 $ig->setHeights( $params['heights'] );
4152 }
4153
4154 wfRunHooks( 'BeforeParserrenderImageGallery', array( &$this, &$ig ) );
4155
4156 $lines = StringUtils::explode( "\n", $text );
4157 foreach ( $lines as $line ) {
4158 # match lines like these:
4159 # Image:someimage.jpg|This is some image
4160 $matches = array();
4161 preg_match( "/^([^|]+)(\\|(.*))?$/", $line, $matches );
4162 # Skip empty lines
4163 if ( count( $matches ) == 0 ) {
4164 continue;
4165 }
4166
4167 if ( strpos( $matches[0], '%' ) !== false )
4168 $matches[1] = urldecode( $matches[1] );
4169 $tp = Title::newFromText( $matches[1]/*, NS_IMAGE*/ );
4170 $nt =& $tp;
4171 if( is_null( $nt ) ) {
4172 # Bogus title. Ignore these so we don't bomb out later.
4173 continue;
4174 }
4175 if ( isset( $matches[3] ) ) {
4176 $label = $matches[3];
4177 } else {
4178 $label = '';
4179 }
4180
4181 $html = $this->recursiveTagParse( trim( $label ) );
4182
4183 $ig->add( $nt, $html );
4184
4185 # Only add real images (bug #5586)
4186 if ( $nt->getNamespace() == NS_IMAGE ) {
4187 $this->mOutput->addImage( $nt->getDBkey() );
4188 }
4189 }
4190 return $ig->toHTML();
4191 }
4192
4193 /** Renders any text in between <poem></poem> tags
4194 * based on http://www.mediawiki.org/wiki/Extension:Poem
4195 */
4196
4197 function renderPoem( $in, $param = array() ) {
4198
4199 /* using newlines in the text will cause the parser to add <p> tags,
4200 * which may not be desired in some cases
4201 */
4202 $nl = array_key_exists( 'compact', $param ) ? '' : "\n";
4203
4204 $replacer = new DoubleReplacer( ' ', '&nbsp;' );
4205 $text = $this->recursiveTagParse( $in );
4206 $text = $this->mStripState->unstripNoWiki( $text );
4207 // Only strip the very first and very last \n (which trim cannot do)
4208 if( substr( $text, 0, 1 ) == "\n" )
4209 $text = substr( $text, 1 );
4210 if( substr( $text, -1 ) == "\n" )
4211 $text = substr( $text, 0, -1 );
4212
4213 $text = str_replace( "\n", "<br />\n", $text );
4214 $text = preg_replace_callback(
4215 "/^( +)/m",
4216 $replacer->cb(),
4217 $text );
4218
4219 // Pass HTML attributes through to the output.
4220 $attribs = Sanitizer::validateTagAttributes( $param, 'div' );
4221
4222 // Wrap output in a <div> with "poem" class.
4223 if( array_key_exists( 'class', $attribs ) ) {
4224 $attribs['class'] = 'poem ' . $attribs['class'];
4225 } else {
4226 $attribs['class'] = 'poem';
4227 }
4228
4229 return Xml::openElement( 'div', $attribs ) . $nl . trim( $text ) . $nl . Xml::closeElement( 'div' );
4230 }
4231
4232 function getImageParams( $handler ) {
4233 if ( $handler ) {
4234 $handlerClass = get_class( $handler );
4235 } else {
4236 $handlerClass = '';
4237 }
4238 if ( !isset( $this->mImageParams[$handlerClass] ) ) {
4239 // Initialise static lists
4240 static $internalParamNames = array(
4241 'horizAlign' => array( 'left', 'right', 'center', 'none' ),
4242 'vertAlign' => array( 'baseline', 'sub', 'super', 'top', 'text-top', 'middle',
4243 'bottom', 'text-bottom' ),
4244 'frame' => array( 'thumbnail', 'manualthumb', 'framed', 'frameless',
4245 'upright', 'border', 'link', 'alt' ),
4246 );
4247 static $internalParamMap;
4248 if ( !$internalParamMap ) {
4249 $internalParamMap = array();
4250 foreach ( $internalParamNames as $type => $names ) {
4251 foreach ( $names as $name ) {
4252 $magicName = str_replace( '-', '_', "img_$name" );
4253 $internalParamMap[$magicName] = array( $type, $name );
4254 }
4255 }
4256 }
4257
4258 // Add handler params
4259 $paramMap = $internalParamMap;
4260 if ( $handler ) {
4261 $handlerParamMap = $handler->getParamMap();
4262 foreach ( $handlerParamMap as $magic => $paramName ) {
4263 $paramMap[$magic] = array( 'handler', $paramName );
4264 }
4265 }
4266 $this->mImageParams[$handlerClass] = $paramMap;
4267 $this->mImageParamsMagicArray[$handlerClass] = new MagicWordArray( array_keys( $paramMap ) );
4268 }
4269 return array( $this->mImageParams[$handlerClass], $this->mImageParamsMagicArray[$handlerClass] );
4270 }
4271
4272 /**
4273 * Parse image options text and use it to make an image
4274 * @param Title $title
4275 * @param string $options
4276 * @param LinkHolderArray $holders
4277 */
4278 function makeImage( $title, $options, $holders = false ) {
4279 # Check if the options text is of the form "options|alt text"
4280 # Options are:
4281 # * thumbnail make a thumbnail with enlarge-icon and caption, alignment depends on lang
4282 # * left no resizing, just left align. label is used for alt= only
4283 # * right same, but right aligned
4284 # * none same, but not aligned
4285 # * ___px scale to ___ pixels width, no aligning. e.g. use in taxobox
4286 # * center center the image
4287 # * framed Keep original image size, no magnify-button.
4288 # * frameless like 'thumb' but without a frame. Keeps user preferences for width
4289 # * upright reduce width for upright images, rounded to full __0 px
4290 # * border draw a 1px border around the image
4291 # * alt Text for HTML alt attribute (defaults to empty)
4292 # vertical-align values (no % or length right now):
4293 # * baseline
4294 # * sub
4295 # * super
4296 # * top
4297 # * text-top
4298 # * middle
4299 # * bottom
4300 # * text-bottom
4301
4302 $parts = StringUtils::explode( "|", $options );
4303 $sk = $this->mOptions->getSkin();
4304
4305 # Give extensions a chance to select the file revision for us
4306 $skip = $time = $descQuery = false;
4307 wfRunHooks( 'BeforeParserMakeImageLinkObj', array( &$this, &$title, &$skip, &$time, &$descQuery ) );
4308
4309 if ( $skip ) {
4310 return $sk->link( $title );
4311 }
4312
4313 # Get the file
4314 $imagename = $title->getDBkey();
4315 if ( isset( $this->mFileCache[$imagename][$time] ) ) {
4316 $file = $this->mFileCache[$imagename][$time];
4317 } else {
4318 $file = wfFindFile( $title, $time );
4319 if ( count( $this->mFileCache ) > 1000 ) {
4320 $this->mFileCache = array();
4321 }
4322 $this->mFileCache[$imagename][$time] = $file;
4323 }
4324 # Get parameter map
4325 $handler = $file ? $file->getHandler() : false;
4326
4327 list( $paramMap, $mwArray ) = $this->getImageParams( $handler );
4328
4329 # Process the input parameters
4330 $caption = '';
4331 $params = array( 'frame' => array(), 'handler' => array(),
4332 'horizAlign' => array(), 'vertAlign' => array() );
4333 foreach( $parts as $part ) {
4334 $part = trim( $part );
4335 list( $magicName, $value ) = $mwArray->matchVariableStartToEnd( $part );
4336 $validated = false;
4337 if( isset( $paramMap[$magicName] ) ) {
4338 list( $type, $paramName ) = $paramMap[$magicName];
4339
4340 // Special case; width and height come in one variable together
4341 if( $type === 'handler' && $paramName === 'width' ) {
4342 $m = array();
4343 # (bug 13500) In both cases (width/height and width only),
4344 # permit trailing "px" for backward compatibility.
4345 if ( preg_match( '/^([0-9]*)x([0-9]*)\s*(?:px)?\s*$/', $value, $m ) ) {
4346 $width = intval( $m[1] );
4347 $height = intval( $m[2] );
4348 if ( $handler->validateParam( 'width', $width ) ) {
4349 $params[$type]['width'] = $width;
4350 $validated = true;
4351 }
4352 if ( $handler->validateParam( 'height', $height ) ) {
4353 $params[$type]['height'] = $height;
4354 $validated = true;
4355 }
4356 } elseif ( preg_match( '/^[0-9]*\s*(?:px)?\s*$/', $value ) ) {
4357 $width = intval( $value );
4358 if ( $handler->validateParam( 'width', $width ) ) {
4359 $params[$type]['width'] = $width;
4360 $validated = true;
4361 }
4362 } // else no validation -- bug 13436
4363 } else {
4364 if ( $type === 'handler' ) {
4365 # Validate handler parameter
4366 $validated = $handler->validateParam( $paramName, $value );
4367 } else {
4368 # Validate internal parameters
4369 switch( $paramName ) {
4370 case 'manualthumb':
4371 case 'alt':
4372 // @fixme - possibly check validity here for
4373 // manualthumb? downstream behavior seems odd with
4374 // missing manual thumbs.
4375 $validated = true;
4376 $value = $this->stripAltText( $value, $holders );
4377 break;
4378 case 'link':
4379 $chars = self::EXT_LINK_URL_CLASS;
4380 $prots = $this->mUrlProtocols;
4381 if ( $value === '' ) {
4382 $paramName = 'no-link';
4383 $value = true;
4384 $validated = true;
4385 } elseif ( preg_match( "/^$prots/", $value ) ) {
4386 if ( preg_match( "/^($prots)$chars+$/", $value, $m ) ) {
4387 $paramName = 'link-url';
4388 $this->mOutput->addExternalLink( $value );
4389 $validated = true;
4390 }
4391 } else {
4392 $linkTitle = Title::newFromText( $value );
4393 if ( $linkTitle ) {
4394 $paramName = 'link-title';
4395 $value = $linkTitle;
4396 $this->mOutput->addLink( $linkTitle );
4397 $validated = true;
4398 }
4399 }
4400 break;
4401 default:
4402 // Most other things appear to be empty or numeric...
4403 $validated = ( $value === false || is_numeric( trim( $value ) ) );
4404 }
4405 }
4406
4407 if ( $validated ) {
4408 $params[$type][$paramName] = $value;
4409 }
4410 }
4411 }
4412 if ( !$validated ) {
4413 $caption = $part;
4414 }
4415 }
4416
4417 # Process alignment parameters
4418 if ( $params['horizAlign'] ) {
4419 $params['frame']['align'] = key( $params['horizAlign'] );
4420 }
4421 if ( $params['vertAlign'] ) {
4422 $params['frame']['valign'] = key( $params['vertAlign'] );
4423 }
4424
4425 $params['frame']['caption'] = $caption;
4426
4427 $params['frame']['title'] = $this->stripAltText( $caption, $holders );
4428
4429 # In the old days, [[Image:Foo|text...]] would set alt text. Later it
4430 # came to also set the caption, ordinary text after the image -- which
4431 # makes no sense, because that just repeats the text multiple times in
4432 # screen readers. It *also* came to set the title attribute.
4433 #
4434 # Now that we have an alt attribute, we should not set the alt text to
4435 # equal the caption: that's worse than useless, it just repeats the
4436 # text. This is the framed/thumbnail case. If there's no caption, we
4437 # use the unnamed parameter for alt text as well, just for the time be-
4438 # ing, if the unnamed param is set and the alt param is not.
4439 #
4440 # For the future, we need to figure out if we want to tweak this more,
4441 # e.g., introducing a title= parameter for the title; ignoring the un-
4442 # named parameter entirely for images without a caption; adding an ex-
4443 # plicit caption= parameter and preserving the old magic unnamed para-
4444 # meter for BC; ...
4445 if( $caption !== '' && !isset( $params['frame']['alt'] )
4446 && !isset( $params['frame']['framed'] )
4447 && !isset( $params['frame']['thumbnail'] )
4448 && !isset( $params['frame']['manualthumb'] ) ) {
4449 $params['frame']['alt'] = $params['frame']['title'];
4450 }
4451
4452 wfRunHooks( 'ParserMakeImageParams', array( $title, $file, &$params ) );
4453
4454 # Linker does the rest
4455 $ret = $sk->makeImageLink2( $title, $file, $params['frame'], $params['handler'], $time, $descQuery );
4456
4457 # Give the handler a chance to modify the parser object
4458 if ( $handler ) {
4459 $handler->parserTransformHook( $this, $file );
4460 }
4461
4462 return $ret;
4463 }
4464
4465 protected function stripAltText( $caption, $holders ) {
4466 # Strip bad stuff out of the title (tooltip). We can't just use
4467 # replaceLinkHoldersText() here, because if this function is called
4468 # from replaceInternalLinks2(), mLinkHolders won't be up-to-date.
4469 if ( $holders ) {
4470 $tooltip = $holders->replaceText( $caption );
4471 } else {
4472 $tooltip = $this->replaceLinkHoldersText( $caption );
4473 }
4474
4475 # make sure there are no placeholders in thumbnail attributes
4476 # that are later expanded to html- so expand them now and
4477 # remove the tags
4478 $tooltip = $this->mStripState->unstripBoth( $tooltip );
4479 $tooltip = Sanitizer::stripAllTags( $tooltip );
4480
4481 return $tooltip;
4482 }
4483
4484 /**
4485 * Set a flag in the output object indicating that the content is dynamic and
4486 * shouldn't be cached.
4487 */
4488 function disableCache() {
4489 wfDebug( "Parser output marked as uncacheable.\n" );
4490 $this->mOutput->mCacheTime = -1;
4491 }
4492
4493 /**#@+
4494 * Callback from the Sanitizer for expanding items found in HTML attribute
4495 * values, so they can be safely tested and escaped.
4496 * @param string $text
4497 * @param PPFrame $frame
4498 * @return string
4499 * @private
4500 */
4501 function attributeStripCallback( &$text, $frame = false ) {
4502 $text = $this->replaceVariables( $text, $frame );
4503 $text = $this->mStripState->unstripBoth( $text );
4504 return $text;
4505 }
4506
4507 /**#@-*/
4508
4509 /**#@+
4510 * Accessor/mutator
4511 */
4512 function Title( $x = NULL ) { return wfSetVar( $this->mTitle, $x ); }
4513 function Options( $x = NULL ) { return wfSetVar( $this->mOptions, $x ); }
4514 function OutputType( $x = NULL ) { return wfSetVar( $this->mOutputType, $x ); }
4515 /**#@-*/
4516
4517 /**#@+
4518 * Accessor
4519 */
4520 function getTags() { return array_merge( array_keys($this->mTransparentTagHooks), array_keys( $this->mTagHooks ) ); }
4521 /**#@-*/
4522
4523
4524 /**
4525 * Break wikitext input into sections, and either pull or replace
4526 * some particular section's text.
4527 *
4528 * External callers should use the getSection and replaceSection methods.
4529 *
4530 * @param string $text Page wikitext
4531 * @param string $section A section identifier string of the form:
4532 * <flag1> - <flag2> - ... - <section number>
4533 *
4534 * Currently the only recognised flag is "T", which means the target section number
4535 * was derived during a template inclusion parse, in other words this is a template
4536 * section edit link. If no flags are given, it was an ordinary section edit link.
4537 * This flag is required to avoid a section numbering mismatch when a section is
4538 * enclosed by <includeonly> (bug 6563).
4539 *
4540 * The section number 0 pulls the text before the first heading; other numbers will
4541 * pull the given section along with its lower-level subsections. If the section is
4542 * not found, $mode=get will return $newtext, and $mode=replace will return $text.
4543 *
4544 * @param string $mode One of "get" or "replace"
4545 * @param string $newText Replacement text for section data.
4546 * @return string for "get", the extracted section text.
4547 * for "replace", the whole page with the section replaced.
4548 */
4549 private function extractSections( $text, $section, $mode, $newText='' ) {
4550 global $wgTitle;
4551 $this->clearState();
4552 $this->setTitle( $wgTitle ); // not generally used but removes an ugly failure mode
4553 $this->mOptions = new ParserOptions;
4554 $this->setOutputType( self::OT_WIKI );
4555 $outText = '';
4556 $frame = $this->getPreprocessor()->newFrame();
4557
4558 // Process section extraction flags
4559 $flags = 0;
4560 $sectionParts = explode( '-', $section );
4561 $sectionIndex = array_pop( $sectionParts );
4562 foreach ( $sectionParts as $part ) {
4563 if ( $part === 'T' ) {
4564 $flags |= self::PTD_FOR_INCLUSION;
4565 }
4566 }
4567 // Preprocess the text
4568 $root = $this->preprocessToDom( $text, $flags );
4569
4570 // <h> nodes indicate section breaks
4571 // They can only occur at the top level, so we can find them by iterating the root's children
4572 $node = $root->getFirstChild();
4573
4574 // Find the target section
4575 if ( $sectionIndex == 0 ) {
4576 // Section zero doesn't nest, level=big
4577 $targetLevel = 1000;
4578 } else {
4579 while ( $node ) {
4580 if ( $node->getName() === 'h' ) {
4581 $bits = $node->splitHeading();
4582 if ( $bits['i'] == $sectionIndex ) {
4583 $targetLevel = $bits['level'];
4584 break;
4585 }
4586 }
4587 if ( $mode === 'replace' ) {
4588 $outText .= $frame->expand( $node, PPFrame::RECOVER_ORIG );
4589 }
4590 $node = $node->getNextSibling();
4591 }
4592 }
4593
4594 if ( !$node ) {
4595 // Not found
4596 if ( $mode === 'get' ) {
4597 return $newText;
4598 } else {
4599 return $text;
4600 }
4601 }
4602
4603 // Find the end of the section, including nested sections
4604 do {
4605 if ( $node->getName() === 'h' ) {
4606 $bits = $node->splitHeading();
4607 $curLevel = $bits['level'];
4608 if ( $bits['i'] != $sectionIndex && $curLevel <= $targetLevel ) {
4609 break;
4610 }
4611 }
4612 if ( $mode === 'get' ) {
4613 $outText .= $frame->expand( $node, PPFrame::RECOVER_ORIG );
4614 }
4615 $node = $node->getNextSibling();
4616 } while ( $node );
4617
4618 // Write out the remainder (in replace mode only)
4619 if ( $mode === 'replace' ) {
4620 // Output the replacement text
4621 // Add two newlines on -- trailing whitespace in $newText is conventionally
4622 // stripped by the editor, so we need both newlines to restore the paragraph gap
4623 $outText .= $newText . "\n\n";
4624 while ( $node ) {
4625 $outText .= $frame->expand( $node, PPFrame::RECOVER_ORIG );
4626 $node = $node->getNextSibling();
4627 }
4628 }
4629
4630 if ( is_string( $outText ) ) {
4631 // Re-insert stripped tags
4632 $outText = rtrim( $this->mStripState->unstripBoth( $outText ) );
4633 }
4634
4635 return $outText;
4636 }
4637
4638 /**
4639 * This function returns the text of a section, specified by a number ($section).
4640 * A section is text under a heading like == Heading == or \<h1\>Heading\</h1\>, or
4641 * the first section before any such heading (section 0).
4642 *
4643 * If a section contains subsections, these are also returned.
4644 *
4645 * @param string $text text to look in
4646 * @param string $section section identifier
4647 * @param string $deftext default to return if section is not found
4648 * @return string text of the requested section
4649 */
4650 public function getSection( $text, $section, $deftext='' ) {
4651 return $this->extractSections( $text, $section, "get", $deftext );
4652 }
4653
4654 public function replaceSection( $oldtext, $section, $text ) {
4655 return $this->extractSections( $oldtext, $section, "replace", $text );
4656 }
4657
4658 /**
4659 * Get the timestamp associated with the current revision, adjusted for
4660 * the default server-local timestamp
4661 */
4662 function getRevisionTimestamp() {
4663 if ( is_null( $this->mRevisionTimestamp ) ) {
4664 wfProfileIn( __METHOD__ );
4665 global $wgContLang;
4666 $dbr = wfGetDB( DB_SLAVE );
4667 $timestamp = $dbr->selectField( 'revision', 'rev_timestamp',
4668 array( 'rev_id' => $this->mRevisionId ), __METHOD__ );
4669
4670 // Normalize timestamp to internal MW format for timezone processing.
4671 // This has the added side-effect of replacing a null value with
4672 // the current time, which gives us more sensible behavior for
4673 // previews.
4674 $timestamp = wfTimestamp( TS_MW, $timestamp );
4675
4676 // The cryptic '' timezone parameter tells to use the site-default
4677 // timezone offset instead of the user settings.
4678 //
4679 // Since this value will be saved into the parser cache, served
4680 // to other users, and potentially even used inside links and such,
4681 // it needs to be consistent for all visitors.
4682 $this->mRevisionTimestamp = $wgContLang->userAdjust( $timestamp, '' );
4683
4684 wfProfileOut( __METHOD__ );
4685 }
4686 return $this->mRevisionTimestamp;
4687 }
4688
4689 /**
4690 * Mutator for $mDefaultSort
4691 *
4692 * @param $sort New value
4693 */
4694 public function setDefaultSort( $sort ) {
4695 $this->mDefaultSort = $sort;
4696 }
4697
4698 /**
4699 * Accessor for $mDefaultSort
4700 * Will use the title/prefixed title if none is set
4701 *
4702 * @return string
4703 */
4704 public function getDefaultSort() {
4705 global $wgCategoryPrefixedDefaultSortkey;
4706 if( $this->mDefaultSort !== false ) {
4707 return $this->mDefaultSort;
4708 } elseif ($this->mTitle->getNamespace() == NS_CATEGORY ||
4709 !$wgCategoryPrefixedDefaultSortkey) {
4710 return $this->mTitle->getText();
4711 } else {
4712 return $this->mTitle->getPrefixedText();
4713 }
4714 }
4715
4716 /**
4717 * Accessor for $mDefaultSort
4718 * Unlike getDefaultSort(), will return false if none is set
4719 *
4720 * @return string or false
4721 */
4722 public function getCustomDefaultSort() {
4723 return $this->mDefaultSort;
4724 }
4725
4726 /**
4727 * Try to guess the section anchor name based on a wikitext fragment
4728 * presumably extracted from a heading, for example "Header" from
4729 * "== Header ==".
4730 */
4731 public function guessSectionNameFromWikiText( $text ) {
4732 # Strip out wikitext links(they break the anchor)
4733 $text = $this->stripSectionName( $text );
4734 $headline = Sanitizer::decodeCharReferences( $text );
4735 # strip out HTML
4736 $headline = StringUtils::delimiterReplace( '<', '>', '', $headline );
4737 $headline = trim( $headline );
4738 $sectionanchor = '#' . urlencode( str_replace( ' ', '_', $headline ) );
4739 $replacearray = array(
4740 '%3A' => ':',
4741 '%' => '.'
4742 );
4743 return str_replace(
4744 array_keys( $replacearray ),
4745 array_values( $replacearray ),
4746 $sectionanchor );
4747 }
4748
4749 /**
4750 * Strips a text string of wikitext for use in a section anchor
4751 *
4752 * Accepts a text string and then removes all wikitext from the
4753 * string and leaves only the resultant text (i.e. the result of
4754 * [[User:WikiSysop|Sysop]] would be "Sysop" and the result of
4755 * [[User:WikiSysop]] would be "User:WikiSysop") - this is intended
4756 * to create valid section anchors by mimicing the output of the
4757 * parser when headings are parsed.
4758 *
4759 * @param $text string Text string to be stripped of wikitext
4760 * for use in a Section anchor
4761 * @return Filtered text string
4762 */
4763 public function stripSectionName( $text ) {
4764 # Strip internal link markup
4765 $text = preg_replace('/\[\[:?([^[|]+)\|([^[]+)\]\]/','$2',$text);
4766 $text = preg_replace('/\[\[:?([^[]+)\|?\]\]/','$1',$text);
4767
4768 # Strip external link markup (FIXME: Not Tolerant to blank link text
4769 # I.E. [http://www.mediawiki.org] will render as [1] or something depending
4770 # on how many empty links there are on the page - need to figure that out.
4771 $text = preg_replace('/\[(?:' . wfUrlProtocols() . ')([^ ]+?) ([^[]+)\]/','$2',$text);
4772
4773 # Parse wikitext quotes (italics & bold)
4774 $text = $this->doQuotes($text);
4775
4776 # Strip HTML tags
4777 $text = StringUtils::delimiterReplace( '<', '>', '', $text );
4778 return $text;
4779 }
4780
4781 function srvus( $text ) {
4782 return $this->testSrvus( $text, $this->mOutputType );
4783 }
4784
4785 /**
4786 * strip/replaceVariables/unstrip for preprocessor regression testing
4787 */
4788 function testSrvus( $text, $title, $options, $outputType = self::OT_HTML ) {
4789 $this->clearState();
4790 if ( ! ( $title instanceof Title ) ) {
4791 $title = Title::newFromText( $title );
4792 }
4793 $this->mTitle = $title;
4794 $this->mOptions = $options;
4795 $this->setOutputType( $outputType );
4796 $text = $this->replaceVariables( $text );
4797 $text = $this->mStripState->unstripBoth( $text );
4798 $text = Sanitizer::removeHTMLtags( $text );
4799 return $text;
4800 }
4801
4802 function testPst( $text, $title, $options ) {
4803 global $wgUser;
4804 if ( ! ( $title instanceof Title ) ) {
4805 $title = Title::newFromText( $title );
4806 }
4807 return $this->preSaveTransform( $text, $title, $wgUser, $options );
4808 }
4809
4810 function testPreprocess( $text, $title, $options ) {
4811 if ( ! ( $title instanceof Title ) ) {
4812 $title = Title::newFromText( $title );
4813 }
4814 return $this->testSrvus( $text, $title, $options, self::OT_PREPROCESS );
4815 }
4816
4817 function markerSkipCallback( $s, $callback ) {
4818 $i = 0;
4819 $out = '';
4820 while ( $i < strlen( $s ) ) {
4821 $markerStart = strpos( $s, $this->mUniqPrefix, $i );
4822 if ( $markerStart === false ) {
4823 $out .= call_user_func( $callback, substr( $s, $i ) );
4824 break;
4825 } else {
4826 $out .= call_user_func( $callback, substr( $s, $i, $markerStart - $i ) );
4827 $markerEnd = strpos( $s, self::MARKER_SUFFIX, $markerStart );
4828 if ( $markerEnd === false ) {
4829 $out .= substr( $s, $markerStart );
4830 break;
4831 } else {
4832 $markerEnd += strlen( self::MARKER_SUFFIX );
4833 $out .= substr( $s, $markerStart, $markerEnd - $markerStart );
4834 $i = $markerEnd;
4835 }
4836 }
4837 }
4838 return $out;
4839 }
4840 }
4841
4842 /**
4843 * @todo document, briefly.
4844 * @ingroup Parser
4845 */
4846 class StripState {
4847 var $general, $nowiki;
4848
4849 function __construct() {
4850 $this->general = new ReplacementArray;
4851 $this->nowiki = new ReplacementArray;
4852 }
4853
4854 function unstripGeneral( $text ) {
4855 wfProfileIn( __METHOD__ );
4856 do {
4857 $oldText = $text;
4858 $text = $this->general->replace( $text );
4859 } while ( $text !== $oldText );
4860 wfProfileOut( __METHOD__ );
4861 return $text;
4862 }
4863
4864 function unstripNoWiki( $text ) {
4865 wfProfileIn( __METHOD__ );
4866 do {
4867 $oldText = $text;
4868 $text = $this->nowiki->replace( $text );
4869 } while ( $text !== $oldText );
4870 wfProfileOut( __METHOD__ );
4871 return $text;
4872 }
4873
4874 function unstripBoth( $text ) {
4875 wfProfileIn( __METHOD__ );
4876 do {
4877 $oldText = $text;
4878 $text = $this->general->replace( $text );
4879 $text = $this->nowiki->replace( $text );
4880 } while ( $text !== $oldText );
4881 wfProfileOut( __METHOD__ );
4882 return $text;
4883 }
4884 }
4885
4886 /**
4887 * @todo document, briefly.
4888 * @ingroup Parser
4889 */
4890 class OnlyIncludeReplacer {
4891 var $output = '';
4892
4893 function replace( $matches ) {
4894 if ( substr( $matches[1], -1 ) === "\n" ) {
4895 $this->output .= substr( $matches[1], 0, -1 );
4896 } else {
4897 $this->output .= $matches[1];
4898 }
4899 }
4900 }