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