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