dépôts / lhc / web / wiklou.git / blob
? search:
summary | shortlog | log | commit | commitdiff | tree
history | raw | HEAD
Merge "Set $wgNoFollowLinks to false iff "Authorized editors only" selected"
[lhc/web/wiklou.git] / includes / parser / Parser.php
1 <?php
2 /**
3 * PHP parser that converts wiki markup to HTML.
4 *
5 * This program is free software; you can redistribute it and/or modify
6 * it under the terms of the GNU General Public License as published by
7 * the Free Software Foundation; either version 2 of the License, or
8 * (at your option) any later version.
9 *
10 * This program is distributed in the hope that it will be useful,
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 * GNU General Public License for more details.
14 *
15 * You should have received a copy of the GNU General Public License along
16 * with this program; if not, write to the Free Software Foundation, Inc.,
17 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
18 * http://www.gnu.org/copyleft/gpl.html
19 *
20 * @file
21 * @ingroup Parser
22 */
23
24 /**
25 * @defgroup Parser Parser
26 */
27
28 /**
29 * PHP Parser - Processes wiki markup (which uses a more user-friendly
30 * syntax, such as "[[link]]" for making links), and provides a one-way
31 * transformation of that wiki markup it into (X)HTML output / markup
32 * (which in turn the browser understands, and can display).
33 *
34 * There are seven main entry points into the Parser class:
35 *
36 * - Parser::parse()
37 * produces HTML output
38 * - Parser::preSaveTransform().
39 * produces altered wiki markup.
40 * - Parser::preprocess()
41 * removes HTML comments and expands templates
42 * - Parser::cleanSig() and Parser::cleanSigInSig()
43 * Cleans a signature before saving it to preferences
44 * - Parser::getSection()
45 * Return the content of a section from an article for section editing
46 * - Parser::replaceSection()
47 * Replaces a section by number inside an article
48 * - Parser::getPreloadText()
49 * Removes <noinclude> sections, and <includeonly> tags.
50 *
51 * Globals used:
52 * object: $wgContLang
53 *
54 * @warning $wgUser or $wgTitle or $wgRequest or $wgLang. Keep them away!
55 *
56 * @par Settings:
57 * $wgNamespacesWithSubpages
58 *
59 * @par Settings only within ParserOptions:
60 * $wgAllowExternalImages
61 * $wgAllowSpecialInclusion
62 * $wgInterwikiMagic
63 * $wgMaxArticleSize
64 *
65 * @ingroup Parser
66 */
67 class Parser {
68 /**
69 * Update this version number when the ParserOutput format
70 * changes in an incompatible way, so the parser cache
71 * can automatically discard old data.
72 */
73 const VERSION = '1.6.4';
74
75 /**
76 * Update this version number when the output of serialiseHalfParsedText()
77 * changes in an incompatible way
78 */
79 const HALF_PARSED_VERSION = 2;
80
81 # Flags for Parser::setFunctionHook
82 # Also available as global constants from Defines.php
83 const SFH_NO_HASH = 1;
84 const SFH_OBJECT_ARGS = 2;
85
86 # Constants needed for external link processing
87 # Everything except bracket, space, or control characters
88 # \p{Zs} is unicode 'separator, space' category. It covers the space 0x20
89 # as well as U+3000 is IDEOGRAPHIC SPACE for bug 19052
90 const EXT_LINK_URL_CLASS = '[^][<>"\\x00-\\x20\\x7F\p{Zs}]';
91 const EXT_IMAGE_REGEX = '/^(http:\/\/|https:\/\/)([^][<>"\\x00-\\x20\\x7F\p{Zs}]+)
92 \\/([A-Za-z0-9_.,~%\\-+&;#*?!=()@\\x80-\\xFF]+)\\.((?i)gif|png|jpg|jpeg)$/Sxu';
93
94 # State constants for the definition list colon extraction
95 const COLON_STATE_TEXT = 0;
96 const COLON_STATE_TAG = 1;
97 const COLON_STATE_TAGSTART = 2;
98 const COLON_STATE_CLOSETAG = 3;
99 const COLON_STATE_TAGSLASH = 4;
100 const COLON_STATE_COMMENT = 5;
101 const COLON_STATE_COMMENTDASH = 6;
102 const COLON_STATE_COMMENTDASHDASH = 7;
103
104 # Flags for preprocessToDom
105 const PTD_FOR_INCLUSION = 1;
106
107 # Allowed values for $this->mOutputType
108 # Parameter to startExternalParse().
109 const OT_HTML = 1; # like parse()
110 const OT_WIKI = 2; # like preSaveTransform()
111 const OT_PREPROCESS = 3; # like preprocess()
112 const OT_MSG = 3;
113 const OT_PLAIN = 4; # like extractSections() - portions of the original are returned unchanged.
114
115 # Marker Suffix needs to be accessible staticly.
116 const MARKER_SUFFIX = "-QINU\x7f";
117
118 # Markers used for wrapping the table of contents
119 const TOC_START = '<mw:toc>';
120 const TOC_END = '</mw:toc>';
121
122 # Persistent:
123 var $mTagHooks = array();
124 var $mTransparentTagHooks = array();
125 var $mFunctionHooks = array();
126 var $mFunctionSynonyms = array( 0 => array(), 1 => array() );
127 var $mFunctionTagHooks = array();
128 var $mStripList = array();
129 var $mDefaultStripList = array();
130 var $mVarCache = array();
131 var $mImageParams = array();
132 var $mImageParamsMagicArray = array();
133 var $mMarkerIndex = 0;
134 var $mFirstCall = true;
135
136 # Initialised by initialiseVariables()
137
138 /**
139 * @var MagicWordArray
140 */
141 var $mVariables;
142
143 /**
144 * @var MagicWordArray
145 */
146 var $mSubstWords;
147 var $mConf, $mPreprocessor, $mExtLinkBracketedRegex, $mUrlProtocols; # Initialised in constructor
148
149 # Cleared with clearState():
150 /**
151 * @var ParserOutput
152 */
153 var $mOutput;
154 var $mAutonumber, $mDTopen;
155
156 /**
157 * @var StripState
158 */
159 var $mStripState;
160
161 var $mIncludeCount, $mArgStack, $mLastSection, $mInPre;
162 /**
163 * @var LinkHolderArray
164 */
165 var $mLinkHolders;
166
167 var $mLinkID;
168 var $mIncludeSizes, $mPPNodeCount, $mGeneratedPPNodeCount, $mHighestExpansionDepth;
169 var $mDefaultSort;
170 var $mTplExpandCache; # empty-frame expansion cache
171 var $mTplRedirCache, $mTplDomCache, $mHeadings, $mDoubleUnderscores;
172 var $mExpensiveFunctionCount; # number of expensive parser function calls
173 var $mShowToc, $mForceTocPosition;
174
175 /**
176 * @var User
177 */
178 var $mUser; # User object; only used when doing pre-save transform
179
180 # Temporary
181 # These are variables reset at least once per parse regardless of $clearState
182
183 /**
184 * @var ParserOptions
185 */
186 var $mOptions;
187
188 /**
189 * @var Title
190 */
191 var $mTitle; # Title context, used for self-link rendering and similar things
192 var $mOutputType; # Output type, one of the OT_xxx constants
193 var $ot; # Shortcut alias, see setOutputType()
194 var $mRevisionObject; # The revision object of the specified revision ID
195 var $mRevisionId; # ID to display in {{REVISIONID}} tags
196 var $mRevisionTimestamp; # The timestamp of the specified revision ID
197 var $mRevisionUser; # User to display in {{REVISIONUSER}} tag
198 var $mRevisionSize; # Size to display in {{REVISIONSIZE}} variable
199 var $mRevIdForTs; # The revision ID which was used to fetch the timestamp
200 var $mInputSize = false; # For {{PAGESIZE}} on current page.
201
202 /**
203 * @var string
204 */
205 var $mUniqPrefix;
206
207 /**
208 * @var Array with the language name of each language link (i.e. the
209 * interwiki prefix) in the key, value arbitrary. Used to avoid sending
210 * duplicate language links to the ParserOutput.
211 */
212 var $mLangLinkLanguages;
213
214 /**
215 * Constructor
216 *
217 * @param $conf array
218 */
219 public function __construct( $conf = array() ) {
220 $this->mConf = $conf;
221 $this->mUrlProtocols = wfUrlProtocols();
222 $this->mExtLinkBracketedRegex = '/\[(((?i)' . $this->mUrlProtocols . ')' .
223 self::EXT_LINK_URL_CLASS . '+)\p{Zs}*([^\]\\x00-\\x08\\x0a-\\x1F]*?)\]/Su';
224 if ( isset( $conf['preprocessorClass'] ) ) {
225 $this->mPreprocessorClass = $conf['preprocessorClass'];
226 } elseif ( defined( 'HPHP_VERSION' ) ) {
227 # Preprocessor_Hash is much faster than Preprocessor_DOM under HipHop
228 $this->mPreprocessorClass = 'Preprocessor_Hash';
229 } elseif ( extension_loaded( 'domxml' ) ) {
230 # PECL extension that conflicts with the core DOM extension (bug 13770)
231 wfDebug( "Warning: you have the obsolete domxml extension for PHP. Please remove it!\n" );
232 $this->mPreprocessorClass = 'Preprocessor_Hash';
233 } elseif ( extension_loaded( 'dom' ) ) {
234 $this->mPreprocessorClass = 'Preprocessor_DOM';
235 } else {
236 $this->mPreprocessorClass = 'Preprocessor_Hash';
237 }
238 wfDebug( __CLASS__ . ": using preprocessor: {$this->mPreprocessorClass}\n" );
239 }
240
241 /**
242 * Reduce memory usage to reduce the impact of circular references
243 */
244 function __destruct() {
245 if ( isset( $this->mLinkHolders ) ) {
246 unset( $this->mLinkHolders );
247 }
248 foreach ( $this as $name => $value ) {
249 unset( $this->$name );
250 }
251 }
252
253 /**
254 * Allow extensions to clean up when the parser is cloned
255 */
256 function __clone() {
257 wfRunHooks( 'ParserCloned', array( $this ) );
258 }
259
260 /**
261 * Do various kinds of initialisation on the first call of the parser
262 */
263 function firstCallInit() {
264 if ( !$this->mFirstCall ) {
265 return;
266 }
267 $this->mFirstCall = false;
268
269 wfProfileIn( __METHOD__ );
270
271 CoreParserFunctions::register( $this );
272 CoreTagHooks::register( $this );
273 $this->initialiseVariables();
274
275 wfRunHooks( 'ParserFirstCallInit', array( &$this ) );
276 wfProfileOut( __METHOD__ );
277 }
278
279 /**
280 * Clear Parser state
281 *
282 * @private
283 */
284 function clearState() {
285 wfProfileIn( __METHOD__ );
286 if ( $this->mFirstCall ) {
287 $this->firstCallInit();
288 }
289 $this->mOutput = new ParserOutput;
290 $this->mOptions->registerWatcher( array( $this->mOutput, 'recordOption' ) );
291 $this->mAutonumber = 0;
292 $this->mLastSection = '';
293 $this->mDTopen = false;
294 $this->mIncludeCount = array();
295 $this->mArgStack = false;
296 $this->mInPre = false;
297 $this->mLinkHolders = new LinkHolderArray( $this );
298 $this->mLinkID = 0;
299 $this->mRevisionObject = $this->mRevisionTimestamp =
300 $this->mRevisionId = $this->mRevisionUser = $this->mRevisionSize = null;
301 $this->mVarCache = array();
302 $this->mUser = null;
303 $this->mLangLinkLanguages = array();
304
305 /**
306 * Prefix for temporary replacement strings for the multipass parser.
307 * \x07 should never appear in input as it's disallowed in XML.
308 * Using it at the front also gives us a little extra robustness
309 * since it shouldn't match when butted up against identifier-like
310 * string constructs.
311 *
312 * Must not consist of all title characters, or else it will change
313 * the behavior of <nowiki> in a link.
314 */
315 $this->mUniqPrefix = "\x7fUNIQ" . self::getRandomString();
316 $this->mStripState = new StripState( $this->mUniqPrefix );
317
318 # Clear these on every parse, bug 4549
319 $this->mTplExpandCache = $this->mTplRedirCache = $this->mTplDomCache = array();
320
321 $this->mShowToc = true;
322 $this->mForceTocPosition = false;
323 $this->mIncludeSizes = array(
324 'post-expand' => 0,
325 'arg' => 0,
326 );
327 $this->mPPNodeCount = 0;
328 $this->mGeneratedPPNodeCount = 0;
329 $this->mHighestExpansionDepth = 0;
330 $this->mDefaultSort = false;
331 $this->mHeadings = array();
332 $this->mDoubleUnderscores = array();
333 $this->mExpensiveFunctionCount = 0;
334
335 # Fix cloning
336 if ( isset( $this->mPreprocessor ) && $this->mPreprocessor->parser !== $this ) {
337 $this->mPreprocessor = null;
338 }
339
340 wfRunHooks( 'ParserClearState', array( &$this ) );
341 wfProfileOut( __METHOD__ );
342 }
343
344 /**
345 * Convert wikitext to HTML
346 * Do not call this function recursively.
347 *
348 * @param string $text text we want to parse
349 * @param $title Title object
350 * @param $options ParserOptions
351 * @param $linestart boolean
352 * @param $clearState boolean
353 * @param int $revid number to pass in {{REVISIONID}}
354 * @return ParserOutput a ParserOutput
355 */
356 public function parse( $text, Title $title, ParserOptions $options, $linestart = true, $clearState = true, $revid = null ) {
357 /**
358 * First pass--just handle <nowiki> sections, pass the rest off
359 * to internalParse() which does all the real work.
360 */
361
362 global $wgUseTidy, $wgAlwaysUseTidy, $wgShowHostnames;
363 $fname = __METHOD__ . '-' . wfGetCaller();
364 wfProfileIn( __METHOD__ );
365 wfProfileIn( $fname );
366
367 $this->startParse( $title, $options, self::OT_HTML, $clearState );
368
369 $this->mInputSize = strlen( $text );
370 if ( $this->mOptions->getEnableLimitReport() ) {
371 $this->mOutput->resetParseStartTime();
372 }
373
374 # Remove the strip marker tag prefix from the input, if present.
375 if ( $clearState ) {
376 $text = str_replace( $this->mUniqPrefix, '', $text );
377 }
378
379 $oldRevisionId = $this->mRevisionId;
380 $oldRevisionObject = $this->mRevisionObject;
381 $oldRevisionTimestamp = $this->mRevisionTimestamp;
382 $oldRevisionUser = $this->mRevisionUser;
383 $oldRevisionSize = $this->mRevisionSize;
384 if ( $revid !== null ) {
385 $this->mRevisionId = $revid;
386 $this->mRevisionObject = null;
387 $this->mRevisionTimestamp = null;
388 $this->mRevisionUser = null;
389 $this->mRevisionSize = null;
390 }
391
392 wfRunHooks( 'ParserBeforeStrip', array( &$this, &$text, &$this->mStripState ) );
393 # No more strip!
394 wfRunHooks( 'ParserAfterStrip', array( &$this, &$text, &$this->mStripState ) );
395 $text = $this->internalParse( $text );
396 wfRunHooks( 'ParserAfterParse', array( &$this, &$text, &$this->mStripState ) );
397
398 $text = $this->mStripState->unstripGeneral( $text );
399
400 # Clean up special characters, only run once, next-to-last before doBlockLevels
401 $fixtags = array(
402 # french spaces, last one Guillemet-left
403 # only if there is something before the space
404 '/(.) (?=\\?|:|;|!|%|\\302\\273)/' => '\\1&#160;',
405 # french spaces, Guillemet-right
406 '/(\\302\\253) /' => '\\1&#160;',
407 '/&#160;(!\s*important)/' => ' \\1', # Beware of CSS magic word !important, bug #11874.
408 );
409 $text = preg_replace( array_keys( $fixtags ), array_values( $fixtags ), $text );
410
411 $text = $this->doBlockLevels( $text, $linestart );
412
413 $this->replaceLinkHolders( $text );
414
415 /**
416 * The input doesn't get language converted if
417 * a) It's disabled
418 * b) Content isn't converted
419 * c) It's a conversion table
420 * d) it is an interface message (which is in the user language)
421 */
422 if ( !( $options->getDisableContentConversion()
423 || isset( $this->mDoubleUnderscores['nocontentconvert'] ) )
424 ) {
425 if ( !$this->mOptions->getInterfaceMessage() ) {
426 # The position of the convert() call should not be changed. it
427 # assumes that the links are all replaced and the only thing left
428 # is the <nowiki> mark.
429 $text = $this->getConverterLanguage()->convert( $text );
430 }
431 }
432
433 /**
434 * A converted title will be provided in the output object if title and
435 * content conversion are enabled, the article text does not contain
436 * a conversion-suppressing double-underscore tag, and no
437 * {{DISPLAYTITLE:...}} is present. DISPLAYTITLE takes precedence over
438 * automatic link conversion.
439 */
440 if ( !( $options->getDisableTitleConversion()
441 || isset( $this->mDoubleUnderscores['nocontentconvert'] )
442 || isset( $this->mDoubleUnderscores['notitleconvert'] )
443 || $this->mOutput->getDisplayTitle() !== false )
444 ) {
445 $convruletitle = $this->getConverterLanguage()->getConvRuleTitle();
446 if ( $convruletitle ) {
447 $this->mOutput->setTitleText( $convruletitle );
448 } else {
449 $titleText = $this->getConverterLanguage()->convertTitle( $title );
450 $this->mOutput->setTitleText( $titleText );
451 }
452 }
453
454 $text = $this->mStripState->unstripNoWiki( $text );
455
456 wfRunHooks( 'ParserBeforeTidy', array( &$this, &$text ) );
457
458 $text = $this->replaceTransparentTags( $text );
459 $text = $this->mStripState->unstripGeneral( $text );
460
461 $text = Sanitizer::normalizeCharReferences( $text );
462
463 if ( ( $wgUseTidy && $this->mOptions->getTidy() ) || $wgAlwaysUseTidy ) {
464 $text = MWTidy::tidy( $text );
465 } else {
466 # attempt to sanitize at least some nesting problems
467 # (bug #2702 and quite a few others)
468 $tidyregs = array(
469 # ''Something [http://www.cool.com cool''] -->
470 # <i>Something</i><a href="http://www.cool.com"..><i>cool></i></a>
471 '/(<([bi])>)(<([bi])>)?([^<]*)(<\/?a[^<]*>)([^<]*)(<\/\\4>)?(<\/\\2>)/' =>
472 '\\1\\3\\5\\8\\9\\6\\1\\3\\7\\8\\9',
473 # fix up an anchor inside another anchor, only
474 # at least for a single single nested link (bug 3695)
475 '/(<a[^>]+>)([^<]*)(<a[^>]+>[^<]*)<\/a>(.*)<\/a>/' =>
476 '\\1\\2</a>\\3</a>\\1\\4</a>',
477 # fix div inside inline elements- doBlockLevels won't wrap a line which
478 # contains a div, so fix it up here; replace
479 # div with escaped text
480 '/(<([aib]) [^>]+>)([^<]*)(<div([^>]*)>)(.*)(<\/div>)([^<]*)(<\/\\2>)/' =>
481 '\\1\\3&lt;div\\5&gt;\\6&lt;/div&gt;\\8\\9',
482 # remove empty italic or bold tag pairs, some
483 # introduced by rules above
484 '/<([bi])><\/\\1>/' => '',
485 );
486
487 $text = preg_replace(
488 array_keys( $tidyregs ),
489 array_values( $tidyregs ),
490 $text );
491 }
492
493 if ( $this->mExpensiveFunctionCount > $this->mOptions->getExpensiveParserFunctionLimit() ) {
494 $this->limitationWarn( 'expensive-parserfunction',
495 $this->mExpensiveFunctionCount,
496 $this->mOptions->getExpensiveParserFunctionLimit()
497 );
498 }
499
500 wfRunHooks( 'ParserAfterTidy', array( &$this, &$text ) );
501
502 # Information on include size limits, for the benefit of users who try to skirt them
503 if ( $this->mOptions->getEnableLimitReport() ) {
504 $max = $this->mOptions->getMaxIncludeSize();
505
506 $cpuTime = $this->mOutput->getTimeSinceStart( 'cpu' );
507 if ( $cpuTime !== null ) {
508 $this->mOutput->setLimitReportData( 'limitreport-cputime',
509 sprintf( "%.3f", $cpuTime )
510 );
511 }
512
513 $wallTime = $this->mOutput->getTimeSinceStart( 'wall' );
514 $this->mOutput->setLimitReportData( 'limitreport-walltime',
515 sprintf( "%.3f", $wallTime )
516 );
517
518 $this->mOutput->setLimitReportData( 'limitreport-ppvisitednodes',
519 array( $this->mPPNodeCount, $this->mOptions->getMaxPPNodeCount() )
520 );
521 $this->mOutput->setLimitReportData( 'limitreport-ppgeneratednodes',
522 array( $this->mGeneratedPPNodeCount, $this->mOptions->getMaxGeneratedPPNodeCount() )
523 );
524 $this->mOutput->setLimitReportData( 'limitreport-postexpandincludesize',
525 array( $this->mIncludeSizes['post-expand'], $max )
526 );
527 $this->mOutput->setLimitReportData( 'limitreport-templateargumentsize',
528 array( $this->mIncludeSizes['arg'], $max )
529 );
530 $this->mOutput->setLimitReportData( 'limitreport-expansiondepth',
531 array( $this->mHighestExpansionDepth, $this->mOptions->getMaxPPExpandDepth() )
532 );
533 $this->mOutput->setLimitReportData( 'limitreport-expensivefunctioncount',
534 array( $this->mExpensiveFunctionCount, $this->mOptions->getExpensiveParserFunctionLimit() )
535 );
536 wfRunHooks( 'ParserLimitReportPrepare', array( $this, $this->mOutput ) );
537
538 $limitReport = "NewPP limit report\n";
539 if ( $wgShowHostnames ) {
540 $limitReport .= 'Parsed by ' . wfHostname() . "\n";
541 }
542 foreach ( $this->mOutput->getLimitReportData() as $key => $value ) {
543 if ( wfRunHooks( 'ParserLimitReportFormat',
544 array( $key, &$value, &$limitReport, false, false )
545 ) ) {
546 $keyMsg = wfMessage( $key )->inLanguage( 'en' )->useDatabase( false );
547 $valueMsg = wfMessage( array( "$key-value-text", "$key-value" ) )
548 ->inLanguage( 'en' )->useDatabase( false );
549 if ( !$valueMsg->exists() ) {
550 $valueMsg = new RawMessage( '$1' );
551 }
552 if ( !$keyMsg->isDisabled() && !$valueMsg->isDisabled() ) {
553 $valueMsg->params( $value );
554 $limitReport .= "{$keyMsg->text()}: {$valueMsg->text()}\n";
555 }
556 }
557 }
558 // Since we're not really outputting HTML, decode the entities and
559 // then re-encode the things that need hiding inside HTML comments.
560 $limitReport = htmlspecialchars_decode( $limitReport );
561 wfRunHooks( 'ParserLimitReport', array( $this, &$limitReport ) );
562
563 // Sanitize for comment. Note '‐' in the replacement is U+2010,
564 // which looks much like the problematic '-'.
565 $limitReport = str_replace( array( '-', '&' ), array( '‐', '&amp;' ), $limitReport );
566 $text .= "\n<!-- \n$limitReport-->\n";
567
568 if ( $this->mGeneratedPPNodeCount > $this->mOptions->getMaxGeneratedPPNodeCount() / 10 ) {
569 wfDebugLog( 'generated-pp-node-count', $this->mGeneratedPPNodeCount . ' ' .
570 $this->mTitle->getPrefixedDBkey() );
571 }
572 }
573 $this->mOutput->setText( $text );
574
575 $this->mRevisionId = $oldRevisionId;
576 $this->mRevisionObject = $oldRevisionObject;
577 $this->mRevisionTimestamp = $oldRevisionTimestamp;
578 $this->mRevisionUser = $oldRevisionUser;
579 $this->mRevisionSize = $oldRevisionSize;
580 $this->mInputSize = false;
581 wfProfileOut( $fname );
582 wfProfileOut( __METHOD__ );
583
584 return $this->mOutput;
585 }
586
587 /**
588 * Recursive parser entry point that can be called from an extension tag
589 * hook.
590 *
591 * If $frame is not provided, then template variables (e.g., {{{1}}}) within $text are not expanded
592 *
593 * @param string $text text extension wants to have parsed
594 * @param $frame PPFrame: The frame to use for expanding any template variables
595 *
596 * @return string
597 */
598 function recursiveTagParse( $text, $frame = false ) {
599 wfProfileIn( __METHOD__ );
600 wfRunHooks( 'ParserBeforeStrip', array( &$this, &$text, &$this->mStripState ) );
601 wfRunHooks( 'ParserAfterStrip', array( &$this, &$text, &$this->mStripState ) );
602 $text = $this->internalParse( $text, false, $frame );
603 wfProfileOut( __METHOD__ );
604 return $text;
605 }
606
607 /**
608 * Expand templates and variables in the text, producing valid, static wikitext.
609 * Also removes comments.
610 * @return mixed|string
611 */
612 function preprocess( $text, Title $title = null, ParserOptions $options, $revid = null ) {
613 wfProfileIn( __METHOD__ );
614 $this->startParse( $title, $options, self::OT_PREPROCESS, true );
615 if ( $revid !== null ) {
616 $this->mRevisionId = $revid;
617 }
618 wfRunHooks( 'ParserBeforeStrip', array( &$this, &$text, &$this->mStripState ) );
619 wfRunHooks( 'ParserAfterStrip', array( &$this, &$text, &$this->mStripState ) );
620 $text = $this->replaceVariables( $text );
621 $text = $this->mStripState->unstripBoth( $text );
622 wfProfileOut( __METHOD__ );
623 return $text;
624 }
625
626 /**
627 * Recursive parser entry point that can be called from an extension tag
628 * hook.
629 *
630 * @param string $text text to be expanded
631 * @param $frame PPFrame: The frame to use for expanding any template variables
632 * @return String
633 * @since 1.19
634 */
635 public function recursivePreprocess( $text, $frame = false ) {
636 wfProfileIn( __METHOD__ );
637 $text = $this->replaceVariables( $text, $frame );
638 $text = $this->mStripState->unstripBoth( $text );
639 wfProfileOut( __METHOD__ );
640 return $text;
641 }
642
643 /**
644 * Process the wikitext for the "?preload=" feature. (bug 5210)
645 *
646 * "<noinclude>", "<includeonly>" etc. are parsed as for template
647 * transclusion, comments, templates, arguments, tags hooks and parser
648 * functions are untouched.
649 *
650 * @param $text String
651 * @param $title Title
652 * @param $options ParserOptions
653 * @return String
654 */
655 public function getPreloadText( $text, Title $title, ParserOptions $options ) {
656 # Parser (re)initialisation
657 $this->startParse( $title, $options, self::OT_PLAIN, true );
658
659 $flags = PPFrame::NO_ARGS | PPFrame::NO_TEMPLATES;
660 $dom = $this->preprocessToDom( $text, self::PTD_FOR_INCLUSION );
661 $text = $this->getPreprocessor()->newFrame()->expand( $dom, $flags );
662 $text = $this->mStripState->unstripBoth( $text );
663 return $text;
664 }
665
666 /**
667 * Get a random string
668 *
669 * @return string
670 */
671 public static function getRandomString() {
672 return wfRandomString( 16 );
673 }
674
675 /**
676 * Set the current user.
677 * Should only be used when doing pre-save transform.
678 *
679 * @param $user Mixed: User object or null (to reset)
680 */
681 function setUser( $user ) {
682 $this->mUser = $user;
683 }
684
685 /**
686 * Accessor for mUniqPrefix.
687 *
688 * @return String
689 */
690 public function uniqPrefix() {
691 if ( !isset( $this->mUniqPrefix ) ) {
692 # @todo FIXME: This is probably *horribly wrong*
693 # LanguageConverter seems to want $wgParser's uniqPrefix, however
694 # if this is called for a parser cache hit, the parser may not
695 # have ever been initialized in the first place.
696 # Not really sure what the heck is supposed to be going on here.
697 return '';
698 # throw new MWException( "Accessing uninitialized mUniqPrefix" );
699 }
700 return $this->mUniqPrefix;
701 }
702
703 /**
704 * Set the context title
705 *
706 * @param $t Title
707 */
708 function setTitle( $t ) {
709 if ( !$t || $t instanceof FakeTitle ) {
710 $t = Title::newFromText( 'NO TITLE' );
711 }
712
713 if ( strval( $t->getFragment() ) !== '' ) {
714 # Strip the fragment to avoid various odd effects
715 $this->mTitle = clone $t;
716 $this->mTitle->setFragment( '' );
717 } else {
718 $this->mTitle = $t;
719 }
720 }
721
722 /**
723 * Accessor for the Title object
724 *
725 * @return Title object
726 */
727 function getTitle() {
728 return $this->mTitle;
729 }
730
731 /**
732 * Accessor/mutator for the Title object
733 *
734 * @param $x Title object or null to just get the current one
735 * @return Title object
736 */
737 function Title( $x = null ) {
738 return wfSetVar( $this->mTitle, $x );
739 }
740
741 /**
742 * Set the output type
743 *
744 * @param $ot Integer: new value
745 */
746 function setOutputType( $ot ) {
747 $this->mOutputType = $ot;
748 # Shortcut alias
749 $this->ot = array(
750 'html' => $ot == self::OT_HTML,
751 'wiki' => $ot == self::OT_WIKI,
752 'pre' => $ot == self::OT_PREPROCESS,
753 'plain' => $ot == self::OT_PLAIN,
754 );
755 }
756
757 /**
758 * Accessor/mutator for the output type
759 *
760 * @param int|null $x New value or null to just get the current one
761 * @return Integer
762 */
763 function OutputType( $x = null ) {
764 return wfSetVar( $this->mOutputType, $x );
765 }
766
767 /**
768 * Get the ParserOutput object
769 *
770 * @return ParserOutput object
771 */
772 function getOutput() {
773 return $this->mOutput;
774 }
775
776 /**
777 * Get the ParserOptions object
778 *
779 * @return ParserOptions object
780 */
781 function getOptions() {
782 return $this->mOptions;
783 }
784
785 /**
786 * Accessor/mutator for the ParserOptions object
787 *
788 * @param $x ParserOptions New value or null to just get the current one
789 * @return ParserOptions Current ParserOptions object
790 */
791 function Options( $x = null ) {
792 return wfSetVar( $this->mOptions, $x );
793 }
794
795 /**
796 * @return int
797 */
798 function nextLinkID() {
799 return $this->mLinkID++;
800 }
801
802 /**
803 * @param $id int
804 */
805 function setLinkID( $id ) {
806 $this->mLinkID = $id;
807 }
808
809 /**
810 * Get a language object for use in parser functions such as {{FORMATNUM:}}
811 * @return Language
812 */
813 function getFunctionLang() {
814 return $this->getTargetLanguage();
815 }
816
817 /**
818 * Get the target language for the content being parsed. This is usually the
819 * language that the content is in.
820 *
821 * @since 1.19
822 *
823 * @throws MWException
824 * @return Language|null
825 */
826 public function getTargetLanguage() {
827 $target = $this->mOptions->getTargetLanguage();
828
829 if ( $target !== null ) {
830 return $target;
831 } elseif ( $this->mOptions->getInterfaceMessage() ) {
832 return $this->mOptions->getUserLangObj();
833 } elseif ( is_null( $this->mTitle ) ) {
834 throw new MWException( __METHOD__ . ': $this->mTitle is null' );
835 }
836
837 return $this->mTitle->getPageLanguage();
838 }
839
840 /**
841 * Get the language object for language conversion
842 */
843 function getConverterLanguage() {
844 return $this->getTargetLanguage();
845 }
846
847 /**
848 * Get a User object either from $this->mUser, if set, or from the
849 * ParserOptions object otherwise
850 *
851 * @return User object
852 */
853 function getUser() {
854 if ( !is_null( $this->mUser ) ) {
855 return $this->mUser;
856 }
857 return $this->mOptions->getUser();
858 }
859
860 /**
861 * Get a preprocessor object
862 *
863 * @return Preprocessor instance
864 */
865 function getPreprocessor() {
866 if ( !isset( $this->mPreprocessor ) ) {
867 $class = $this->mPreprocessorClass;
868 $this->mPreprocessor = new $class( $this );
869 }
870 return $this->mPreprocessor;
871 }
872
873 /**
874 * Replaces all occurrences of HTML-style comments and the given tags
875 * in the text with a random marker and returns the next text. The output
876 * parameter $matches will be an associative array filled with data in
877 * the form:
878 *
879 * @code
880 * 'UNIQ-xxxxx' => array(
881 * 'element',
882 * 'tag content',
883 * array( 'param' => 'x' ),
884 * '<element param="x">tag content</element>' ) )
885 * @endcode
886 *
887 * @param array $elements list of element names. Comments are always extracted.
888 * @param string $text Source text string.
889 * @param array $matches Out parameter, Array: extracted tags
890 * @param $uniq_prefix string
891 * @return String: stripped text
892 */
893 public static function extractTagsAndParams( $elements, $text, &$matches, $uniq_prefix = '' ) {
894 static $n = 1;
895 $stripped = '';
896 $matches = array();
897
898 $taglist = implode( '|', $elements );
899 $start = "/<($taglist)(\\s+[^>]*?|\\s*?)(\/?" . ">)|<(!--)/i";
900
901 while ( $text != '' ) {
902 $p = preg_split( $start, $text, 2, PREG_SPLIT_DELIM_CAPTURE );
903 $stripped .= $p[0];
904 if ( count( $p ) < 5 ) {
905 break;
906 }
907 if ( count( $p ) > 5 ) {
908 # comment
909 $element = $p[4];
910 $attributes = '';
911 $close = '';
912 $inside = $p[5];
913 } else {
914 # tag
915 $element = $p[1];
916 $attributes = $p[2];
917 $close = $p[3];
918 $inside = $p[4];
919 }
920
921 $marker = "$uniq_prefix-$element-" . sprintf( '%08X', $n++ ) . self::MARKER_SUFFIX;
922 $stripped .= $marker;
923
924 if ( $close === '/>' ) {
925 # Empty element tag, <tag />
926 $content = null;
927 $text = $inside;
928 $tail = null;
929 } else {
930 if ( $element === '!--' ) {
931 $end = '/(-->)/';
932 } else {
933 $end = "/(<\\/$element\\s*>)/i";
934 }
935 $q = preg_split( $end, $inside, 2, PREG_SPLIT_DELIM_CAPTURE );
936 $content = $q[0];
937 if ( count( $q ) < 3 ) {
938 # No end tag -- let it run out to the end of the text.
939 $tail = '';
940 $text = '';
941 } else {
942 $tail = $q[1];
943 $text = $q[2];
944 }
945 }
946
947 $matches[$marker] = array( $element,
948 $content,
949 Sanitizer::decodeTagAttributes( $attributes ),
950 "<$element$attributes$close$content$tail" );
951 }
952 return $stripped;
953 }
954
955 /**
956 * Get a list of strippable XML-like elements
957 *
958 * @return array
959 */
960 function getStripList() {
961 return $this->mStripList;
962 }
963
964 /**
965 * Add an item to the strip state
966 * Returns the unique tag which must be inserted into the stripped text
967 * The tag will be replaced with the original text in unstrip()
968 *
969 * @param $text string
970 *
971 * @return string
972 */
973 function insertStripItem( $text ) {
974 $rnd = "{$this->mUniqPrefix}-item-{$this->mMarkerIndex}-" . self::MARKER_SUFFIX;
975 $this->mMarkerIndex++;
976 $this->mStripState->addGeneral( $rnd, $text );
977 return $rnd;
978 }
979
980 /**
981 * parse the wiki syntax used to render tables
982 *
983 * @private
984 * @return string
985 */
986 function doTableStuff( $text ) {
987 wfProfileIn( __METHOD__ );
988
989 $lines = StringUtils::explode( "\n", $text );
990 $out = '';
991 $td_history = array(); # Is currently a td tag open?
992 $last_tag_history = array(); # Save history of last lag activated (td, th or caption)
993 $tr_history = array(); # Is currently a tr tag open?
994 $tr_attributes = array(); # history of tr attributes
995 $has_opened_tr = array(); # Did this table open a <tr> element?
996 $indent_level = 0; # indent level of the table
997
998 foreach ( $lines as $outLine ) {
999 $line = trim( $outLine );
1000
1001 if ( $line === '' ) { # empty line, go to next line
1002 $out .= $outLine . "\n";
1003 continue;
1004 }
1005
1006 $first_character = $line[0];
1007 $matches = array();
1008
1009 if ( preg_match( '/^(:*)\{\|(.*)$/', $line, $matches ) ) {
1010 # First check if we are starting a new table
1011 $indent_level = strlen( $matches[1] );
1012
1013 $attributes = $this->mStripState->unstripBoth( $matches[2] );
1014 $attributes = Sanitizer::fixTagAttributes( $attributes, 'table' );
1015
1016 $outLine = str_repeat( '<dl><dd>', $indent_level ) . "<table{$attributes}>";
1017 array_push( $td_history, false );
1018 array_push( $last_tag_history, '' );
1019 array_push( $tr_history, false );
1020 array_push( $tr_attributes, '' );
1021 array_push( $has_opened_tr, false );
1022 } elseif ( count( $td_history ) == 0 ) {
1023 # Don't do any of the following
1024 $out .= $outLine . "\n";
1025 continue;
1026 } elseif ( substr( $line, 0, 2 ) === '|}' ) {
1027 # We are ending a table
1028 $line = '</table>' . substr( $line, 2 );
1029 $last_tag = array_pop( $last_tag_history );
1030
1031 if ( !array_pop( $has_opened_tr ) ) {
1032 $line = "<tr><td></td></tr>{$line}";
1033 }
1034
1035 if ( array_pop( $tr_history ) ) {
1036 $line = "</tr>{$line}";
1037 }
1038
1039 if ( array_pop( $td_history ) ) {
1040 $line = "</{$last_tag}>{$line}";
1041 }
1042 array_pop( $tr_attributes );
1043 $outLine = $line . str_repeat( '</dd></dl>', $indent_level );
1044 } elseif ( substr( $line, 0, 2 ) === '|-' ) {
1045 # Now we have a table row
1046 $line = preg_replace( '#^\|-+#', '', $line );
1047
1048 # Whats after the tag is now only attributes
1049 $attributes = $this->mStripState->unstripBoth( $line );
1050 $attributes = Sanitizer::fixTagAttributes( $attributes, 'tr' );
1051 array_pop( $tr_attributes );
1052 array_push( $tr_attributes, $attributes );
1053
1054 $line = '';
1055 $last_tag = array_pop( $last_tag_history );
1056 array_pop( $has_opened_tr );
1057 array_push( $has_opened_tr, true );
1058
1059 if ( array_pop( $tr_history ) ) {
1060 $line = '</tr>';
1061 }
1062
1063 if ( array_pop( $td_history ) ) {
1064 $line = "</{$last_tag}>{$line}";
1065 }
1066
1067 $outLine = $line;
1068 array_push( $tr_history, false );
1069 array_push( $td_history, false );
1070 array_push( $last_tag_history, '' );
1071 } elseif ( $first_character === '|' || $first_character === '!' || substr( $line, 0, 2 ) === '|+' ) {
1072 # This might be cell elements, td, th or captions
1073 if ( substr( $line, 0, 2 ) === '|+' ) {
1074 $first_character = '+';
1075 $line = substr( $line, 1 );
1076 }
1077
1078 $line = substr( $line, 1 );
1079
1080 if ( $first_character === '!' ) {
1081 $line = str_replace( '!!', '||', $line );
1082 }
1083
1084 # Split up multiple cells on the same line.
1085 # FIXME : This can result in improper nesting of tags processed
1086 # by earlier parser steps, but should avoid splitting up eg
1087 # attribute values containing literal "||".
1088 $cells = StringUtils::explodeMarkup( '||', $line );
1089
1090 $outLine = '';
1091
1092 # Loop through each table cell
1093 foreach ( $cells as $cell ) {
1094 $previous = '';
1095 if ( $first_character !== '+' ) {
1096 $tr_after = array_pop( $tr_attributes );
1097 if ( !array_pop( $tr_history ) ) {
1098 $previous = "<tr{$tr_after}>\n";
1099 }
1100 array_push( $tr_history, true );
1101 array_push( $tr_attributes, '' );
1102 array_pop( $has_opened_tr );
1103 array_push( $has_opened_tr, true );
1104 }
1105
1106 $last_tag = array_pop( $last_tag_history );
1107
1108 if ( array_pop( $td_history ) ) {
1109 $previous = "</{$last_tag}>\n{$previous}";
1110 }
1111
1112 if ( $first_character === '|' ) {
1113 $last_tag = 'td';
1114 } elseif ( $first_character === '!' ) {
1115 $last_tag = 'th';
1116 } elseif ( $first_character === '+' ) {
1117 $last_tag = 'caption';
1118 } else {
1119 $last_tag = '';
1120 }
1121
1122 array_push( $last_tag_history, $last_tag );
1123
1124 # A cell could contain both parameters and data
1125 $cell_data = explode( '|', $cell, 2 );
1126
1127 # Bug 553: Note that a '|' inside an invalid link should not
1128 # be mistaken as delimiting cell parameters
1129 if ( strpos( $cell_data[0], '[[' ) !== false ) {
1130 $cell = "{$previous}<{$last_tag}>{$cell}";
1131 } elseif ( count( $cell_data ) == 1 ) {
1132 $cell = "{$previous}<{$last_tag}>{$cell_data[0]}";
1133 } else {
1134 $attributes = $this->mStripState->unstripBoth( $cell_data[0] );
1135 $attributes = Sanitizer::fixTagAttributes( $attributes, $last_tag );
1136 $cell = "{$previous}<{$last_tag}{$attributes}>{$cell_data[1]}";
1137 }
1138
1139 $outLine .= $cell;
1140 array_push( $td_history, true );
1141 }
1142 }
1143 $out .= $outLine . "\n";
1144 }
1145
1146 # Closing open td, tr && table
1147 while ( count( $td_history ) > 0 ) {
1148 if ( array_pop( $td_history ) ) {
1149 $out .= "</td>\n";
1150 }
1151 if ( array_pop( $tr_history ) ) {
1152 $out .= "</tr>\n";
1153 }
1154 if ( !array_pop( $has_opened_tr ) ) {
1155 $out .= "<tr><td></td></tr>\n";
1156 }
1157
1158 $out .= "</table>\n";
1159 }
1160
1161 # Remove trailing line-ending (b/c)
1162 if ( substr( $out, -1 ) === "\n" ) {
1163 $out = substr( $out, 0, -1 );
1164 }
1165
1166 # special case: don't return empty table
1167 if ( $out === "<table>\n<tr><td></td></tr>\n</table>" ) {
1168 $out = '';
1169 }
1170
1171 wfProfileOut( __METHOD__ );
1172
1173 return $out;
1174 }
1175
1176 /**
1177 * Helper function for parse() that transforms wiki markup into
1178 * HTML. Only called for $mOutputType == self::OT_HTML.
1179 *
1180 * @private
1181 *
1182 * @param $text string
1183 * @param $isMain bool
1184 * @param $frame bool
1185 *
1186 * @return string
1187 */
1188 function internalParse( $text, $isMain = true, $frame = false ) {
1189 wfProfileIn( __METHOD__ );
1190
1191 $origText = $text;
1192
1193 # Hook to suspend the parser in this state
1194 if ( !wfRunHooks( 'ParserBeforeInternalParse', array( &$this, &$text, &$this->mStripState ) ) ) {
1195 wfProfileOut( __METHOD__ );
1196 return $text;
1197 }
1198
1199 # if $frame is provided, then use $frame for replacing any variables
1200 if ( $frame ) {
1201 # use frame depth to infer how include/noinclude tags should be handled
1202 # depth=0 means this is the top-level document; otherwise it's an included document
1203 if ( !$frame->depth ) {
1204 $flag = 0;
1205 } else {
1206 $flag = Parser::PTD_FOR_INCLUSION;
1207 }
1208 $dom = $this->preprocessToDom( $text, $flag );
1209 $text = $frame->expand( $dom );
1210 } else {
1211 # if $frame is not provided, then use old-style replaceVariables
1212 $text = $this->replaceVariables( $text );
1213 }
1214
1215 wfRunHooks( 'InternalParseBeforeSanitize', array( &$this, &$text, &$this->mStripState ) );
1216 $text = Sanitizer::removeHTMLtags( $text, array( &$this, 'attributeStripCallback' ), false, array_keys( $this->mTransparentTagHooks ) );
1217 wfRunHooks( 'InternalParseBeforeLinks', array( &$this, &$text, &$this->mStripState ) );
1218
1219 # Tables need to come after variable replacement for things to work
1220 # properly; putting them before other transformations should keep
1221 # exciting things like link expansions from showing up in surprising
1222 # places.
1223 $text = $this->doTableStuff( $text );
1224
1225 $text = preg_replace( '/(^|\n)-----*/', '\\1<hr />', $text );
1226
1227 $text = $this->doDoubleUnderscore( $text );
1228
1229 $text = $this->doHeadings( $text );
1230 $text = $this->replaceInternalLinks( $text );
1231 $text = $this->doAllQuotes( $text );
1232 $text = $this->replaceExternalLinks( $text );
1233
1234 # replaceInternalLinks may sometimes leave behind
1235 # absolute URLs, which have to be masked to hide them from replaceExternalLinks
1236 $text = str_replace( $this->mUniqPrefix . 'NOPARSE', '', $text );
1237
1238 $text = $this->doMagicLinks( $text );
1239 $text = $this->formatHeadings( $text, $origText, $isMain );
1240
1241 wfProfileOut( __METHOD__ );
1242 return $text;
1243 }
1244
1245 /**
1246 * Replace special strings like "ISBN xxx" and "RFC xxx" with
1247 * magic external links.
1248 *
1249 * DML
1250 * @private
1251 *
1252 * @param $text string
1253 *
1254 * @return string
1255 */
1256 function doMagicLinks( $text ) {
1257 wfProfileIn( __METHOD__ );
1258 $prots = wfUrlProtocolsWithoutProtRel();
1259 $urlChar = self::EXT_LINK_URL_CLASS;
1260 $text = preg_replace_callback(
1261 '!(?: # Start cases
1262 (<a[ \t\r\n>].*?</a>) | # m[1]: Skip link text
1263 (<.*?>) | # m[2]: Skip stuff inside HTML elements' . "
1264 (\\b(?i:$prots)$urlChar+) | # m[3]: Free external links" . '
1265 (?:RFC|PMID)\s+([0-9]+) | # m[4]: RFC or PMID, capture number
1266 ISBN\s+(\b # m[5]: ISBN, capture number
1267 (?: 97[89] [\ \-]? )? # optional 13-digit ISBN prefix
1268 (?: [0-9] [\ \-]? ){9} # 9 digits with opt. delimiters
1269 [0-9Xx] # check digit
1270 \b)
1271 )!xu', array( &$this, 'magicLinkCallback' ), $text );
1272 wfProfileOut( __METHOD__ );
1273 return $text;
1274 }
1275
1276 /**
1277 * @throws MWException
1278 * @param $m array
1279 * @return HTML|string
1280 */
1281 function magicLinkCallback( $m ) {
1282 if ( isset( $m[1] ) && $m[1] !== '' ) {
1283 # Skip anchor
1284 return $m[0];
1285 } elseif ( isset( $m[2] ) && $m[2] !== '' ) {
1286 # Skip HTML element
1287 return $m[0];
1288 } elseif ( isset( $m[3] ) && $m[3] !== '' ) {
1289 # Free external link
1290 return $this->makeFreeExternalLink( $m[0] );
1291 } elseif ( isset( $m[4] ) && $m[4] !== '' ) {
1292 # RFC or PMID
1293 if ( substr( $m[0], 0, 3 ) === 'RFC' ) {
1294 $keyword = 'RFC';
1295 $urlmsg = 'rfcurl';
1296 $CssClass = 'mw-magiclink-rfc';
1297 $id = $m[4];
1298 } elseif ( substr( $m[0], 0, 4 ) === 'PMID' ) {
1299 $keyword = 'PMID';
1300 $urlmsg = 'pubmedurl';
1301 $CssClass = 'mw-magiclink-pmid';
1302 $id = $m[4];
1303 } else {
1304 throw new MWException( __METHOD__ . ': unrecognised match type "' .
1305 substr( $m[0], 0, 20 ) . '"' );
1306 }
1307 $url = wfMessage( $urlmsg, $id )->inContentLanguage()->text();
1308 return Linker::makeExternalLink( $url, "{$keyword} {$id}", true, $CssClass );
1309 } elseif ( isset( $m[5] ) && $m[5] !== '' ) {
1310 # ISBN
1311 $isbn = $m[5];
1312 $num = strtr( $isbn, array(
1313 '-' => '',
1314 ' ' => '',
1315 'x' => 'X',
1316 ));
1317 $titleObj = SpecialPage::getTitleFor( 'Booksources', $num );
1318 return '<a href="' .
1319 htmlspecialchars( $titleObj->getLocalURL() ) .
1320 "\" class=\"internal mw-magiclink-isbn\">ISBN $isbn</a>";
1321 } else {
1322 return $m[0];
1323 }
1324 }
1325
1326 /**
1327 * Make a free external link, given a user-supplied URL
1328 *
1329 * @param $url string
1330 *
1331 * @return string HTML
1332 * @private
1333 */
1334 function makeFreeExternalLink( $url ) {
1335 wfProfileIn( __METHOD__ );
1336
1337 $trail = '';
1338
1339 # The characters '<' and '>' (which were escaped by
1340 # removeHTMLtags()) should not be included in
1341 # URLs, per RFC 2396.
1342 $m2 = array();
1343 if ( preg_match( '/&(lt|gt);/', $url, $m2, PREG_OFFSET_CAPTURE ) ) {
1344 $trail = substr( $url, $m2[0][1] ) . $trail;
1345 $url = substr( $url, 0, $m2[0][1] );
1346 }
1347
1348 # Move trailing punctuation to $trail
1349 $sep = ',;\.:!?';
1350 # If there is no left bracket, then consider right brackets fair game too
1351 if ( strpos( $url, '(' ) === false ) {
1352 $sep .= ')';
1353 }
1354
1355 $numSepChars = strspn( strrev( $url ), $sep );
1356 if ( $numSepChars ) {
1357 $trail = substr( $url, -$numSepChars ) . $trail;
1358 $url = substr( $url, 0, -$numSepChars );
1359 }
1360
1361 $url = Sanitizer::cleanUrl( $url );
1362
1363 # Is this an external image?
1364 $text = $this->maybeMakeExternalImage( $url );
1365 if ( $text === false ) {
1366 # Not an image, make a link
1367 $text = Linker::makeExternalLink( $url,
1368 $this->getConverterLanguage()->markNoConversion( $url, true ),
1369 true, 'free',
1370 $this->getExternalLinkAttribs( $url ) );
1371 # Register it in the output object...
1372 # Replace unnecessary URL escape codes with their equivalent characters
1373 $pasteurized = self::replaceUnusualEscapes( $url );
1374 $this->mOutput->addExternalLink( $pasteurized );
1375 }
1376 wfProfileOut( __METHOD__ );
1377 return $text . $trail;
1378 }
1379
1380 /**
1381 * Parse headers and return html
1382 *
1383 * @private
1384 *
1385 * @param $text string
1386 *
1387 * @return string
1388 */
1389 function doHeadings( $text ) {
1390 wfProfileIn( __METHOD__ );
1391 for ( $i = 6; $i >= 1; --$i ) {
1392 $h = str_repeat( '=', $i );
1393 $text = preg_replace( "/^$h(.+)$h\\s*$/m", "<h$i>\\1</h$i>", $text );
1394 }
1395 wfProfileOut( __METHOD__ );
1396 return $text;
1397 }
1398
1399 /**
1400 * Replace single quotes with HTML markup
1401 * @private
1402 *
1403 * @param $text string
1404 *
1405 * @return string the altered text
1406 */
1407 function doAllQuotes( $text ) {
1408 wfProfileIn( __METHOD__ );
1409 $outtext = '';
1410 $lines = StringUtils::explode( "\n", $text );
1411 foreach ( $lines as $line ) {
1412 $outtext .= $this->doQuotes( $line ) . "\n";
1413 }
1414 $outtext = substr( $outtext, 0, -1 );
1415 wfProfileOut( __METHOD__ );
1416 return $outtext;
1417 }
1418
1419 /**
1420 * Helper function for doAllQuotes()
1421 *
1422 * @param $text string
1423 *
1424 * @return string
1425 */
1426 public function doQuotes( $text ) {
1427 $arr = preg_split( "/(''+)/", $text, -1, PREG_SPLIT_DELIM_CAPTURE );
1428 $countarr = count( $arr );
1429 if ( $countarr == 1 ) {
1430 return $text;
1431 }
1432
1433 // First, do some preliminary work. This may shift some apostrophes from
1434 // being mark-up to being text. It also counts the number of occurrences
1435 // of bold and italics mark-ups.
1436 $numbold = 0;
1437 $numitalics = 0;
1438 for ( $i = 1; $i < $countarr; $i += 2 ) {
1439 $thislen = strlen( $arr[$i] );
1440 // If there are ever four apostrophes, assume the first is supposed to
1441 // be text, and the remaining three constitute mark-up for bold text.
1442 // (bug 13227: ''''foo'''' turns into ' ''' foo ' ''')
1443 if ( $thislen == 4 ) {
1444 $arr[$i - 1] .= "'";
1445 $arr[$i] = "'''";
1446 $thislen = 3;
1447 } elseif ( $thislen > 5 ) {
1448 // If there are more than 5 apostrophes in a row, assume they're all
1449 // text except for the last 5.
1450 // (bug 13227: ''''''foo'''''' turns into ' ''''' foo ' ''''')
1451 $arr[$i - 1] .= str_repeat( "'", $thislen - 5 );
1452 $arr[$i] = "'''''";
1453 $thislen = 5;
1454 }
1455 // Count the number of occurrences of bold and italics mark-ups.
1456 if ( $thislen == 2 ) {
1457 $numitalics++;
1458 } elseif ( $thislen == 3 ) {
1459 $numbold++;
1460 } elseif ( $thislen == 5 ) {
1461 $numitalics++;
1462 $numbold++;
1463 }
1464 }
1465
1466 // If there is an odd number of both bold and italics, it is likely
1467 // that one of the bold ones was meant to be an apostrophe followed
1468 // by italics. Which one we cannot know for certain, but it is more
1469 // likely to be one that has a single-letter word before it.
1470 if ( ( $numbold % 2 == 1 ) && ( $numitalics % 2 == 1 ) ) {
1471 $firstsingleletterword = -1;
1472 $firstmultiletterword = -1;
1473 $firstspace = -1;
1474 for ( $i = 1; $i < $countarr; $i += 2 ) {
1475 if ( strlen( $arr[$i] ) == 3 ) {
1476 $x1 = substr( $arr[$i - 1], -1 );
1477 $x2 = substr( $arr[$i - 1], -2, 1 );
1478 if ( $x1 === ' ' ) {
1479 if ( $firstspace == -1 ) {
1480 $firstspace = $i;
1481 }
1482 } elseif ( $x2 === ' ' ) {
1483 if ( $firstsingleletterword == -1 ) {
1484 $firstsingleletterword = $i;
1485 // if $firstsingleletterword is set, we don't
1486 // look at the other options, so we can bail early.
1487 break;
1488 }
1489 } else {
1490 if ( $firstmultiletterword == -1 ) {
1491 $firstmultiletterword = $i;
1492 }
1493 }
1494 }
1495 }
1496
1497 // If there is a single-letter word, use it!
1498 if ( $firstsingleletterword > -1 ) {
1499 $arr[$firstsingleletterword] = "''";
1500 $arr[$firstsingleletterword - 1] .= "'";
1501 } elseif ( $firstmultiletterword > -1 ) {
1502 // If not, but there's a multi-letter word, use that one.
1503 $arr[$firstmultiletterword] = "''";
1504 $arr[$firstmultiletterword - 1] .= "'";
1505 } elseif ( $firstspace > -1 ) {
1506 // ... otherwise use the first one that has neither.
1507 // (notice that it is possible for all three to be -1 if, for example,
1508 // there is only one pentuple-apostrophe in the line)
1509 $arr[$firstspace] = "''";
1510 $arr[$firstspace - 1] .= "'";
1511 }
1512 }
1513
1514 // Now let's actually convert our apostrophic mush to HTML!
1515 $output = '';
1516 $buffer = '';
1517 $state = '';
1518 $i = 0;
1519 foreach ( $arr as $r ) {
1520 if ( ( $i % 2 ) == 0 ) {
1521 if ( $state === 'both' ) {
1522 $buffer .= $r;
1523 } else {
1524 $output .= $r;
1525 }
1526 } else {
1527 $thislen = strlen( $r );
1528 if ( $thislen == 2 ) {
1529 if ( $state === 'i' ) {
1530 $output .= '</i>';
1531 $state = '';
1532 } elseif ( $state === 'bi' ) {
1533 $output .= '</i>';
1534 $state = 'b';
1535 } elseif ( $state === 'ib' ) {
1536 $output .= '</b></i><b>';
1537 $state = 'b';
1538 } elseif ( $state === 'both' ) {
1539 $output .= '<b><i>' . $buffer . '</i>';
1540 $state = 'b';
1541 } else { // $state can be 'b' or ''
1542 $output .= '<i>';
1543 $state .= 'i';
1544 }
1545 } elseif ( $thislen == 3 ) {
1546 if ( $state === 'b' ) {
1547 $output .= '</b>';
1548 $state = '';
1549 } elseif ( $state === 'bi' ) {
1550 $output .= '</i></b><i>';
1551 $state = 'i';
1552 } elseif ( $state === 'ib' ) {
1553 $output .= '</b>';
1554 $state = 'i';
1555 } elseif ( $state === 'both' ) {
1556 $output .= '<i><b>' . $buffer . '</b>';
1557 $state = 'i';
1558 } else { // $state can be 'i' or ''
1559 $output .= '<b>';
1560 $state .= 'b';
1561 }
1562 } elseif ( $thislen == 5 ) {
1563 if ( $state === 'b' ) {
1564 $output .= '</b><i>';
1565 $state = 'i';
1566 } elseif ( $state === 'i' ) {
1567 $output .= '</i><b>';
1568 $state = 'b';
1569 } elseif ( $state === 'bi' ) {
1570 $output .= '</i></b>';
1571 $state = '';
1572 } elseif ( $state === 'ib' ) {
1573 $output .= '</b></i>';
1574 $state = '';
1575 } elseif ( $state === 'both' ) {
1576 $output .= '<i><b>' . $buffer . '</b></i>';
1577 $state = '';
1578 } else { // ($state == '')
1579 $buffer = '';
1580 $state = 'both';
1581 }
1582 }
1583 }
1584 $i++;
1585 }
1586 // Now close all remaining tags. Notice that the order is important.
1587 if ( $state === 'b' || $state === 'ib' ) {
1588 $output .= '</b>';
1589 }
1590 if ( $state === 'i' || $state === 'bi' || $state === 'ib' ) {
1591 $output .= '</i>';
1592 }
1593 if ( $state === 'bi' ) {
1594 $output .= '</b>';
1595 }
1596 // There might be lonely ''''', so make sure we have a buffer
1597 if ( $state === 'both' && $buffer ) {
1598 $output .= '<b><i>' . $buffer . '</i></b>';
1599 }
1600 return $output;
1601 }
1602
1603 /**
1604 * Replace external links (REL)
1605 *
1606 * Note: this is all very hackish and the order of execution matters a lot.
1607 * Make sure to run tests/parserTests.php if you change this code.
1608 *
1609 * @private
1610 *
1611 * @param $text string
1612 *
1613 * @throws MWException
1614 * @return string
1615 */
1616 function replaceExternalLinks( $text ) {
1617 wfProfileIn( __METHOD__ );
1618
1619 $bits = preg_split( $this->mExtLinkBracketedRegex, $text, -1, PREG_SPLIT_DELIM_CAPTURE );
1620 if ( $bits === false ) {
1621 wfProfileOut( __METHOD__ );
1622 throw new MWException( "PCRE needs to be compiled with --enable-unicode-properties in order for MediaWiki to function" );
1623 }
1624 $s = array_shift( $bits );
1625
1626 $i = 0;
1627 while ( $i < count( $bits ) ) {
1628 $url = $bits[$i++];
1629 $i++; // protocol
1630 $text = $bits[$i++];
1631 $trail = $bits[$i++];
1632
1633 # The characters '<' and '>' (which were escaped by
1634 # removeHTMLtags()) should not be included in
1635 # URLs, per RFC 2396.
1636 $m2 = array();
1637 if ( preg_match( '/&(lt|gt);/', $url, $m2, PREG_OFFSET_CAPTURE ) ) {
1638 $text = substr( $url, $m2[0][1] ) . ' ' . $text;
1639 $url = substr( $url, 0, $m2[0][1] );
1640 }
1641
1642 # If the link text is an image URL, replace it with an <img> tag
1643 # This happened by accident in the original parser, but some people used it extensively
1644 $img = $this->maybeMakeExternalImage( $text );
1645 if ( $img !== false ) {
1646 $text = $img;
1647 }
1648
1649 $dtrail = '';
1650
1651 # Set linktype for CSS - if URL==text, link is essentially free
1652 $linktype = ( $text === $url ) ? 'free' : 'text';
1653
1654 # No link text, e.g. [http://domain.tld/some.link]
1655 if ( $text == '' ) {
1656 # Autonumber
1657 $langObj = $this->getTargetLanguage();
1658 $text = '[' . $langObj->formatNum( ++$this->mAutonumber ) . ']';
1659 $linktype = 'autonumber';
1660 } else {
1661 # Have link text, e.g. [http://domain.tld/some.link text]s
1662 # Check for trail
1663 list( $dtrail, $trail ) = Linker::splitTrail( $trail );
1664 }
1665
1666 $text = $this->getConverterLanguage()->markNoConversion( $text );
1667
1668 $url = Sanitizer::cleanUrl( $url );
1669
1670 # Use the encoded URL
1671 # This means that users can paste URLs directly into the text
1672 # Funny characters like ö aren't valid in URLs anyway
1673 # This was changed in August 2004
1674 $s .= Linker::makeExternalLink( $url, $text, false, $linktype,
1675 $this->getExternalLinkAttribs( $url ) ) . $dtrail . $trail;
1676
1677 # Register link in the output object.
1678 # Replace unnecessary URL escape codes with the referenced character
1679 # This prevents spammers from hiding links from the filters
1680 $pasteurized = self::replaceUnusualEscapes( $url );
1681 $this->mOutput->addExternalLink( $pasteurized );
1682 }
1683
1684 wfProfileOut( __METHOD__ );
1685 return $s;
1686 }
1687 /**
1688 * Get the rel attribute for a particular external link.
1689 *
1690 * @since 1.21
1691 * @param string|bool $url optional URL, to extract the domain from for rel =>
1692 * nofollow if appropriate
1693 * @param $title Title optional Title, for wgNoFollowNsExceptions lookups
1694 * @return string|null rel attribute for $url
1695 */
1696 public static function getExternalLinkRel( $url = false, $title = null ) {
1697 global $wgNoFollowLinks, $wgNoFollowNsExceptions, $wgNoFollowDomainExceptions;
1698 $ns = $title ? $title->getNamespace() : false;
1699 if ( $wgNoFollowLinks && !in_array( $ns, $wgNoFollowNsExceptions )
1700 && !wfMatchesDomainList( $url, $wgNoFollowDomainExceptions )
1701 ) {
1702 return 'nofollow';
1703 }
1704 return null;
1705 }
1706 /**
1707 * Get an associative array of additional HTML attributes appropriate for a
1708 * particular external link. This currently may include rel => nofollow
1709 * (depending on configuration, namespace, and the URL's domain) and/or a
1710 * target attribute (depending on configuration).
1711 *
1712 * @param string|bool $url optional URL, to extract the domain from for rel =>
1713 * nofollow if appropriate
1714 * @return Array associative array of HTML attributes
1715 */
1716 function getExternalLinkAttribs( $url = false ) {
1717 $attribs = array();
1718 $attribs['rel'] = self::getExternalLinkRel( $url, $this->mTitle );
1719
1720 if ( $this->mOptions->getExternalLinkTarget() ) {
1721 $attribs['target'] = $this->mOptions->getExternalLinkTarget();
1722 }
1723 return $attribs;
1724 }
1725
1726 /**
1727 * Replace unusual URL escape codes with their equivalent characters
1728 *
1729 * @param $url String
1730 * @return String
1731 *
1732 * @todo This can merge genuinely required bits in the path or query string,
1733 * breaking legit URLs. A proper fix would treat the various parts of
1734 * the URL differently; as a workaround, just use the output for
1735 * statistical records, not for actual linking/output.
1736 */
1737 static function replaceUnusualEscapes( $url ) {
1738 return preg_replace_callback( '/%[0-9A-Fa-f]{2}/',
1739 array( __CLASS__, 'replaceUnusualEscapesCallback' ), $url );
1740 }
1741
1742 /**
1743 * Callback function used in replaceUnusualEscapes().
1744 * Replaces unusual URL escape codes with their equivalent character
1745 *
1746 * @param $matches array
1747 *
1748 * @return string
1749 */
1750 private static function replaceUnusualEscapesCallback( $matches ) {
1751 $char = urldecode( $matches[0] );
1752 $ord = ord( $char );
1753 # Is it an unsafe or HTTP reserved character according to RFC 1738?
1754 if ( $ord > 32 && $ord < 127 && strpos( '<>"#{}|\^~[]`;/?', $char ) === false ) {
1755 # No, shouldn't be escaped
1756 return $char;
1757 } else {
1758 # Yes, leave it escaped
1759 return $matches[0];
1760 }
1761 }
1762
1763 /**
1764 * make an image if it's allowed, either through the global
1765 * option, through the exception, or through the on-wiki whitelist
1766 * @private
1767 *
1768 * $param $url string
1769 *
1770 * @return string
1771 */
1772 function maybeMakeExternalImage( $url ) {
1773 $imagesfrom = $this->mOptions->getAllowExternalImagesFrom();
1774 $imagesexception = !empty( $imagesfrom );
1775 $text = false;
1776 # $imagesfrom could be either a single string or an array of strings, parse out the latter
1777 if ( $imagesexception && is_array( $imagesfrom ) ) {
1778 $imagematch = false;
1779 foreach ( $imagesfrom as $match ) {
1780 if ( strpos( $url, $match ) === 0 ) {
1781 $imagematch = true;
1782 break;
1783 }
1784 }
1785 } elseif ( $imagesexception ) {
1786 $imagematch = ( strpos( $url, $imagesfrom ) === 0 );
1787 } else {
1788 $imagematch = false;
1789 }
1790 if ( $this->mOptions->getAllowExternalImages()
1791 || ( $imagesexception && $imagematch ) ) {
1792 if ( preg_match( self::EXT_IMAGE_REGEX, $url ) ) {
1793 # Image found
1794 $text = Linker::makeExternalImage( $url );
1795 }
1796 }
1797 if ( !$text && $this->mOptions->getEnableImageWhitelist()
1798 && preg_match( self::EXT_IMAGE_REGEX, $url ) ) {
1799 $whitelist = explode( "\n", wfMessage( 'external_image_whitelist' )->inContentLanguage()->text() );
1800 foreach ( $whitelist as $entry ) {
1801 # Sanitize the regex fragment, make it case-insensitive, ignore blank entries/comments
1802 if ( strpos( $entry, '#' ) === 0 || $entry === '' ) {
1803 continue;
1804 }
1805 if ( preg_match( '/' . str_replace( '/', '\\/', $entry ) . '/i', $url ) ) {
1806 # Image matches a whitelist entry
1807 $text = Linker::makeExternalImage( $url );
1808 break;
1809 }
1810 }
1811 }
1812 return $text;
1813 }
1814
1815 /**
1816 * Process [[ ]] wikilinks
1817 *
1818 * @param $s string
1819 *
1820 * @return String: processed text
1821 *
1822 * @private
1823 */
1824 function replaceInternalLinks( $s ) {
1825 $this->mLinkHolders->merge( $this->replaceInternalLinks2( $s ) );
1826 return $s;
1827 }
1828
1829 /**
1830 * Process [[ ]] wikilinks (RIL)
1831 * @param $s
1832 * @throws MWException
1833 * @return LinkHolderArray
1834 *
1835 * @private
1836 */
1837 function replaceInternalLinks2( &$s ) {
1838 wfProfileIn( __METHOD__ );
1839
1840 wfProfileIn( __METHOD__ . '-setup' );
1841 static $tc = false, $e1, $e1_img;
1842 # the % is needed to support urlencoded titles as well
1843 if ( !$tc ) {
1844 $tc = Title::legalChars() . '#%';
1845 # Match a link having the form [[namespace:link|alternate]]trail
1846 $e1 = "/^([{$tc}]+)(?:\\|(.+?))?]](.*)\$/sD";
1847 # Match cases where there is no "]]", which might still be images
1848 $e1_img = "/^([{$tc}]+)\\|(.*)\$/sD";
1849 }
1850
1851 $holders = new LinkHolderArray( $this );
1852
1853 # split the entire text string on occurrences of [[
1854 $a = StringUtils::explode( '[[', ' ' . $s );
1855 # get the first element (all text up to first [[), and remove the space we added
1856 $s = $a->current();
1857 $a->next();
1858 $line = $a->current(); # Workaround for broken ArrayIterator::next() that returns "void"
1859 $s = substr( $s, 1 );
1860
1861 $useLinkPrefixExtension = $this->getTargetLanguage()->linkPrefixExtension();
1862 $e2 = null;
1863 if ( $useLinkPrefixExtension ) {
1864 # Match the end of a line for a word that's not followed by whitespace,
1865 # e.g. in the case of 'The Arab al[[Razi]]', 'al' will be matched
1866 global $wgContLang;
1867 $charset = $wgContLang->linkPrefixCharset();
1868 $e2 = "/^((?>.*[^$charset]|))(.+)$/sDu";
1869 }
1870
1871 if ( is_null( $this->mTitle ) ) {
1872 wfProfileOut( __METHOD__ . '-setup' );
1873 wfProfileOut( __METHOD__ );
1874 throw new MWException( __METHOD__ . ": \$this->mTitle is null\n" );
1875 }
1876 $nottalk = !$this->mTitle->isTalkPage();
1877
1878 if ( $useLinkPrefixExtension ) {
1879 $m = array();
1880 if ( preg_match( $e2, $s, $m ) ) {
1881 $first_prefix = $m[2];
1882 } else {
1883 $first_prefix = false;
1884 }
1885 } else {
1886 $prefix = '';
1887 }
1888
1889 $useSubpages = $this->areSubpagesAllowed();
1890 wfProfileOut( __METHOD__ . '-setup' );
1891
1892 # Loop for each link
1893 for ( ; $line !== false && $line !== null; $a->next(), $line = $a->current() ) {
1894 # Check for excessive memory usage
1895 if ( $holders->isBig() ) {
1896 # Too big
1897 # Do the existence check, replace the link holders and clear the array
1898 $holders->replace( $s );
1899 $holders->clear();
1900 }
1901
1902 if ( $useLinkPrefixExtension ) {
1903 wfProfileIn( __METHOD__ . '-prefixhandling' );
1904 if ( preg_match( $e2, $s, $m ) ) {
1905 $prefix = $m[2];
1906 $s = $m[1];
1907 } else {
1908 $prefix = '';
1909 }
1910 # first link
1911 if ( $first_prefix ) {
1912 $prefix = $first_prefix;
1913 $first_prefix = false;
1914 }
1915 wfProfileOut( __METHOD__ . '-prefixhandling' );
1916 }
1917
1918 $might_be_img = false;
1919
1920 wfProfileIn( __METHOD__ . "-e1" );
1921 if ( preg_match( $e1, $line, $m ) ) { # page with normal text or alt
1922 $text = $m[2];
1923 # If we get a ] at the beginning of $m[3] that means we have a link that's something like:
1924 # [[Image:Foo.jpg|[http://example.com desc]]] <- having three ] in a row fucks up,
1925 # the real problem is with the $e1 regex
1926 # See bug 1300.
1927 #
1928 # Still some problems for cases where the ] is meant to be outside punctuation,
1929 # and no image is in sight. See bug 2095.
1930 #
1931 if ( $text !== ''
1932 && substr( $m[3], 0, 1 ) === ']'
1933 && strpos( $text, '[' ) !== false
1934 ) {
1935 $text .= ']'; # so that replaceExternalLinks($text) works later
1936 $m[3] = substr( $m[3], 1 );
1937 }
1938 # fix up urlencoded title texts
1939 if ( strpos( $m[1], '%' ) !== false ) {
1940 # Should anchors '#' also be rejected?
1941 $m[1] = str_replace( array( '<', '>' ), array( '&lt;', '&gt;' ), rawurldecode( $m[1] ) );
1942 }
1943 $trail = $m[3];
1944 } elseif ( preg_match( $e1_img, $line, $m ) ) { # Invalid, but might be an image with a link in its caption
1945 $might_be_img = true;
1946 $text = $m[2];
1947 if ( strpos( $m[1], '%' ) !== false ) {
1948 $m[1] = rawurldecode( $m[1] );
1949 }
1950 $trail = "";
1951 } else { # Invalid form; output directly
1952 $s .= $prefix . '[[' . $line;
1953 wfProfileOut( __METHOD__ . "-e1" );
1954 continue;
1955 }
1956 wfProfileOut( __METHOD__ . "-e1" );
1957 wfProfileIn( __METHOD__ . "-misc" );
1958
1959 # Don't allow internal links to pages containing
1960 # PROTO: where PROTO is a valid URL protocol; these
1961 # should be external links.
1962 if ( preg_match( '/^(?i:' . $this->mUrlProtocols . ')/', $m[1] ) ) {
1963 $s .= $prefix . '[[' . $line;
1964 wfProfileOut( __METHOD__ . "-misc" );
1965 continue;
1966 }
1967
1968 # Make subpage if necessary
1969 if ( $useSubpages ) {
1970 $link = $this->maybeDoSubpageLink( $m[1], $text );
1971 } else {
1972 $link = $m[1];
1973 }
1974
1975 $noforce = ( substr( $m[1], 0, 1 ) !== ':' );
1976 if ( !$noforce ) {
1977 # Strip off leading ':'
1978 $link = substr( $link, 1 );
1979 }
1980
1981 wfProfileOut( __METHOD__ . "-misc" );
1982 wfProfileIn( __METHOD__ . "-title" );
1983 $nt = Title::newFromText( $this->mStripState->unstripNoWiki( $link ) );
1984 if ( $nt === null ) {
1985 $s .= $prefix . '[[' . $line;
1986 wfProfileOut( __METHOD__ . "-title" );
1987 continue;
1988 }
1989
1990 $ns = $nt->getNamespace();
1991 $iw = $nt->getInterWiki();
1992 wfProfileOut( __METHOD__ . "-title" );
1993
1994 if ( $might_be_img ) { # if this is actually an invalid link
1995 wfProfileIn( __METHOD__ . "-might_be_img" );
1996 if ( $ns == NS_FILE && $noforce ) { # but might be an image
1997 $found = false;
1998 while ( true ) {
1999 # look at the next 'line' to see if we can close it there
2000 $a->next();
2001 $next_line = $a->current();
2002 if ( $next_line === false || $next_line === null ) {
2003 break;
2004 }
2005 $m = explode( ']]', $next_line, 3 );
2006 if ( count( $m ) == 3 ) {
2007 # the first ]] closes the inner link, the second the image
2008 $found = true;
2009 $text .= "[[{$m[0]}]]{$m[1]}";
2010 $trail = $m[2];
2011 break;
2012 } elseif ( count( $m ) == 2 ) {
2013 # if there's exactly one ]] that's fine, we'll keep looking
2014 $text .= "[[{$m[0]}]]{$m[1]}";
2015 } else {
2016 # if $next_line is invalid too, we need look no further
2017 $text .= '[[' . $next_line;
2018 break;
2019 }
2020 }
2021 if ( !$found ) {
2022 # we couldn't find the end of this imageLink, so output it raw
2023 # but don't ignore what might be perfectly normal links in the text we've examined
2024 $holders->merge( $this->replaceInternalLinks2( $text ) );
2025 $s .= "{$prefix}[[$link|$text";
2026 # note: no $trail, because without an end, there *is* no trail
2027 wfProfileOut( __METHOD__ . "-might_be_img" );
2028 continue;
2029 }
2030 } else { # it's not an image, so output it raw
2031 $s .= "{$prefix}[[$link|$text";
2032 # note: no $trail, because without an end, there *is* no trail
2033 wfProfileOut( __METHOD__ . "-might_be_img" );
2034 continue;
2035 }
2036 wfProfileOut( __METHOD__ . "-might_be_img" );
2037 }
2038
2039 $wasblank = ( $text == '' );
2040 if ( $wasblank ) {
2041 $text = $link;
2042 } else {
2043 # Bug 4598 madness. Handle the quotes only if they come from the alternate part
2044 # [[Lista d''e paise d''o munno]] -> <a href="...">Lista d''e paise d''o munno</a>
2045 # [[Criticism of Harry Potter|Criticism of ''Harry Potter'']]
2046 # -> <a href="Criticism of Harry Potter">Criticism of <i>Harry Potter</i></a>
2047 $text = $this->doQuotes( $text );
2048 }
2049
2050 # Link not escaped by : , create the various objects
2051 if ( $noforce ) {
2052 # Interwikis
2053 wfProfileIn( __METHOD__ . "-interwiki" );
2054 if ( $iw && $this->mOptions->getInterwikiMagic() && $nottalk && Language::fetchLanguageName( $iw, null, 'mw' ) ) {
2055 // XXX: the above check prevents links to sites with identifiers that are not language codes
2056
2057 # Bug 24502: filter duplicates
2058 if ( !isset( $this->mLangLinkLanguages[$iw] ) ) {
2059 $this->mLangLinkLanguages[$iw] = true;
2060 $this->mOutput->addLanguageLink( $nt->getFullText() );
2061 }
2062
2063 $s = rtrim( $s . $prefix );
2064 $s .= trim( $trail, "\n" ) == '' ? '': $prefix . $trail;
2065 wfProfileOut( __METHOD__ . "-interwiki" );
2066 continue;
2067 }
2068 wfProfileOut( __METHOD__ . "-interwiki" );
2069
2070 if ( $ns == NS_FILE ) {
2071 wfProfileIn( __METHOD__ . "-image" );
2072 if ( !wfIsBadImage( $nt->getDBkey(), $this->mTitle ) ) {
2073 if ( $wasblank ) {
2074 # if no parameters were passed, $text
2075 # becomes something like "File:Foo.png",
2076 # which we don't want to pass on to the
2077 # image generator
2078 $text = '';
2079 } else {
2080 # recursively parse links inside the image caption
2081 # actually, this will parse them in any other parameters, too,
2082 # but it might be hard to fix that, and it doesn't matter ATM
2083 $text = $this->replaceExternalLinks( $text );
2084 $holders->merge( $this->replaceInternalLinks2( $text ) );
2085 }
2086 # cloak any absolute URLs inside the image markup, so replaceExternalLinks() won't touch them
2087 $s .= $prefix . $this->armorLinks(
2088 $this->makeImage( $nt, $text, $holders ) ) . $trail;
2089 } else {
2090 $s .= $prefix . $trail;
2091 }
2092 wfProfileOut( __METHOD__ . "-image" );
2093 continue;
2094 }
2095
2096 if ( $ns == NS_CATEGORY ) {
2097 wfProfileIn( __METHOD__ . "-category" );
2098 $s = rtrim( $s . "\n" ); # bug 87
2099
2100 if ( $wasblank ) {
2101 $sortkey = $this->getDefaultSort();
2102 } else {
2103 $sortkey = $text;
2104 }
2105 $sortkey = Sanitizer::decodeCharReferences( $sortkey );
2106 $sortkey = str_replace( "\n", '', $sortkey );
2107 $sortkey = $this->getConverterLanguage()->convertCategoryKey( $sortkey );
2108 $this->mOutput->addCategory( $nt->getDBkey(), $sortkey );
2109
2110 /**
2111 * Strip the whitespace Category links produce, see bug 87
2112 * @todo We might want to use trim($tmp, "\n") here.
2113 */
2114 $s .= trim( $prefix . $trail, "\n" ) == '' ? '' : $prefix . $trail;
2115
2116 wfProfileOut( __METHOD__ . "-category" );
2117 continue;
2118 }
2119 }
2120
2121 # Self-link checking. For some languages, variants of the title are checked in
2122 # LinkHolderArray::doVariants() to allow batching the existence checks necessary
2123 # for linking to a different variant.
2124 if ( $ns != NS_SPECIAL && $nt->equals( $this->mTitle ) && $nt->getFragment() === '' ) {
2125 $s .= $prefix . Linker::makeSelfLinkObj( $nt, $text, '', $trail );
2126 continue;
2127 }
2128
2129 # NS_MEDIA is a pseudo-namespace for linking directly to a file
2130 # @todo FIXME: Should do batch file existence checks, see comment below
2131 if ( $ns == NS_MEDIA ) {
2132 wfProfileIn( __METHOD__ . "-media" );
2133 # Give extensions a chance to select the file revision for us
2134 $options = array();
2135 $descQuery = false;
2136 wfRunHooks( 'BeforeParserFetchFileAndTitle',
2137 array( $this, $nt, &$options, &$descQuery ) );
2138 # Fetch and register the file (file title may be different via hooks)
2139 list( $file, $nt ) = $this->fetchFileAndTitle( $nt, $options );
2140 # Cloak with NOPARSE to avoid replacement in replaceExternalLinks
2141 $s .= $prefix . $this->armorLinks(
2142 Linker::makeMediaLinkFile( $nt, $file, $text ) ) . $trail;
2143 wfProfileOut( __METHOD__ . "-media" );
2144 continue;
2145 }
2146
2147 wfProfileIn( __METHOD__ . "-always_known" );
2148 # Some titles, such as valid special pages or files in foreign repos, should
2149 # be shown as bluelinks even though they're not included in the page table
2150 #
2151 # @todo FIXME: isAlwaysKnown() can be expensive for file links; we should really do
2152 # batch file existence checks for NS_FILE and NS_MEDIA
2153 if ( $iw == '' && $nt->isAlwaysKnown() ) {
2154 $this->mOutput->addLink( $nt );
2155 $s .= $this->makeKnownLinkHolder( $nt, $text, array(), $trail, $prefix );
2156 } else {
2157 # Links will be added to the output link list after checking
2158 $s .= $holders->makeHolder( $nt, $text, array(), $trail, $prefix );
2159 }
2160 wfProfileOut( __METHOD__ . "-always_known" );
2161 }
2162 wfProfileOut( __METHOD__ );
2163 return $holders;
2164 }
2165
2166 /**
2167 * Render a forced-blue link inline; protect against double expansion of
2168 * URLs if we're in a mode that prepends full URL prefixes to internal links.
2169 * Since this little disaster has to split off the trail text to avoid
2170 * breaking URLs in the following text without breaking trails on the
2171 * wiki links, it's been made into a horrible function.
2172 *
2173 * @param $nt Title
2174 * @param $text String
2175 * @param array $query or String
2176 * @param $trail String
2177 * @param $prefix String
2178 * @return String: HTML-wikitext mix oh yuck
2179 */
2180 function makeKnownLinkHolder( $nt, $text = '', $query = array(), $trail = '', $prefix = '' ) {
2181 list( $inside, $trail ) = Linker::splitTrail( $trail );
2182
2183 if ( is_string( $query ) ) {
2184 $query = wfCgiToArray( $query );
2185 }
2186 if ( $text == '' ) {
2187 $text = htmlspecialchars( $nt->getPrefixedText() );
2188 }
2189
2190 $link = Linker::linkKnown( $nt, "$prefix$text$inside", array(), $query );
2191
2192 return $this->armorLinks( $link ) . $trail;
2193 }
2194
2195 /**
2196 * Insert a NOPARSE hacky thing into any inline links in a chunk that's
2197 * going to go through further parsing steps before inline URL expansion.
2198 *
2199 * Not needed quite as much as it used to be since free links are a bit
2200 * more sensible these days. But bracketed links are still an issue.
2201 *
2202 * @param string $text more-or-less HTML
2203 * @return String: less-or-more HTML with NOPARSE bits
2204 */
2205 function armorLinks( $text ) {
2206 return preg_replace( '/\b((?i)' . $this->mUrlProtocols . ')/',
2207 "{$this->mUniqPrefix}NOPARSE$1", $text );
2208 }
2209
2210 /**
2211 * Return true if subpage links should be expanded on this page.
2212 * @return Boolean
2213 */
2214 function areSubpagesAllowed() {
2215 # Some namespaces don't allow subpages
2216 return MWNamespace::hasSubpages( $this->mTitle->getNamespace() );
2217 }
2218
2219 /**
2220 * Handle link to subpage if necessary
2221 *
2222 * @param string $target the source of the link
2223 * @param &$text String: the link text, modified as necessary
2224 * @return string the full name of the link
2225 * @private
2226 */
2227 function maybeDoSubpageLink( $target, &$text ) {
2228 return Linker::normalizeSubpageLink( $this->mTitle, $target, $text );
2229 }
2230
2231 /**#@+
2232 * Used by doBlockLevels()
2233 * @private
2234 *
2235 * @return string
2236 */
2237 function closeParagraph() {
2238 $result = '';
2239 if ( $this->mLastSection != '' ) {
2240 $result = '</' . $this->mLastSection . ">\n";
2241 }
2242 $this->mInPre = false;
2243 $this->mLastSection = '';
2244 return $result;
2245 }
2246
2247 /**
2248 * getCommon() returns the length of the longest common substring
2249 * of both arguments, starting at the beginning of both.
2250 * @private
2251 *
2252 * @param $st1 string
2253 * @param $st2 string
2254 *
2255 * @return int
2256 */
2257 function getCommon( $st1, $st2 ) {
2258 $fl = strlen( $st1 );
2259 $shorter = strlen( $st2 );
2260 if ( $fl < $shorter ) {
2261 $shorter = $fl;
2262 }
2263
2264 for ( $i = 0; $i < $shorter; ++$i ) {
2265 if ( $st1[$i] != $st2[$i] ) {
2266 break;
2267 }
2268 }
2269 return $i;
2270 }
2271
2272 /**
2273 * These next three functions open, continue, and close the list
2274 * element appropriate to the prefix character passed into them.
2275 * @private
2276 *
2277 * @param $char string
2278 *
2279 * @return string
2280 */
2281 function openList( $char ) {
2282 $result = $this->closeParagraph();
2283
2284 if ( '*' === $char ) {
2285 $result .= "<ul>\n<li>";
2286 } elseif ( '#' === $char ) {
2287 $result .= "<ol>\n<li>";
2288 } elseif ( ':' === $char ) {
2289 $result .= "<dl>\n<dd>";
2290 } elseif ( ';' === $char ) {
2291 $result .= "<dl>\n<dt>";
2292 $this->mDTopen = true;
2293 } else {
2294 $result = '<!-- ERR 1 -->';
2295 }
2296
2297 return $result;
2298 }
2299
2300 /**
2301 * TODO: document
2302 * @param $char String
2303 * @private
2304 *
2305 * @return string
2306 */
2307 function nextItem( $char ) {
2308 if ( '*' === $char || '#' === $char ) {
2309 return "</li>\n<li>";
2310 } elseif ( ':' === $char || ';' === $char ) {
2311 $close = "</dd>\n";
2312 if ( $this->mDTopen ) {
2313 $close = "</dt>\n";
2314 }
2315 if ( ';' === $char ) {
2316 $this->mDTopen = true;
2317 return $close . '<dt>';
2318 } else {
2319 $this->mDTopen = false;
2320 return $close . '<dd>';
2321 }
2322 }
2323 return '<!-- ERR 2 -->';
2324 }
2325
2326 /**
2327 * TODO: document
2328 * @param $char String
2329 * @private
2330 *
2331 * @return string
2332 */
2333 function closeList( $char ) {
2334 if ( '*' === $char ) {
2335 $text = "</li>\n</ul>";
2336 } elseif ( '#' === $char ) {
2337 $text = "</li>\n</ol>";
2338 } elseif ( ':' === $char ) {
2339 if ( $this->mDTopen ) {
2340 $this->mDTopen = false;
2341 $text = "</dt>\n</dl>";
2342 } else {
2343 $text = "</dd>\n</dl>";
2344 }
2345 } else {
2346 return '<!-- ERR 3 -->';
2347 }
2348 return $text . "\n";
2349 }
2350 /**#@-*/
2351
2352 /**
2353 * Make lists from lines starting with ':', '*', '#', etc. (DBL)
2354 *
2355 * @param $text String
2356 * @param $linestart Boolean: whether or not this is at the start of a line.
2357 * @private
2358 * @return string the lists rendered as HTML
2359 */
2360 function doBlockLevels( $text, $linestart ) {
2361 wfProfileIn( __METHOD__ );
2362
2363 # Parsing through the text line by line. The main thing
2364 # happening here is handling of block-level elements p, pre,
2365 # and making lists from lines starting with * # : etc.
2366 #
2367 $textLines = StringUtils::explode( "\n", $text );
2368
2369 $lastPrefix = $output = '';
2370 $this->mDTopen = $inBlockElem = false;
2371 $prefixLength = 0;
2372 $paragraphStack = false;
2373 $inBlockquote = false;
2374
2375 foreach ( $textLines as $oLine ) {
2376 # Fix up $linestart
2377 if ( !$linestart ) {
2378 $output .= $oLine;
2379 $linestart = true;
2380 continue;
2381 }
2382 # * = ul
2383 # # = ol
2384 # ; = dt
2385 # : = dd
2386
2387 $lastPrefixLength = strlen( $lastPrefix );
2388 $preCloseMatch = preg_match( '/<\\/pre/i', $oLine );
2389 $preOpenMatch = preg_match( '/<pre/i', $oLine );
2390 # If not in a <pre> element, scan for and figure out what prefixes are there.
2391 if ( !$this->mInPre ) {
2392 # Multiple prefixes may abut each other for nested lists.
2393 $prefixLength = strspn( $oLine, '*#:;' );
2394 $prefix = substr( $oLine, 0, $prefixLength );
2395
2396 # eh?
2397 # ; and : are both from definition-lists, so they're equivalent
2398 # for the purposes of determining whether or not we need to open/close
2399 # elements.
2400 $prefix2 = str_replace( ';', ':', $prefix );
2401 $t = substr( $oLine, $prefixLength );
2402 $this->mInPre = (bool)$preOpenMatch;
2403 } else {
2404 # Don't interpret any other prefixes in preformatted text
2405 $prefixLength = 0;
2406 $prefix = $prefix2 = '';
2407 $t = $oLine;
2408 }
2409
2410 # List generation
2411 if ( $prefixLength && $lastPrefix === $prefix2 ) {
2412 # Same as the last item, so no need to deal with nesting or opening stuff
2413 $output .= $this->nextItem( substr( $prefix, -1 ) );
2414 $paragraphStack = false;
2415
2416 if ( substr( $prefix, -1 ) === ';' ) {
2417 # The one nasty exception: definition lists work like this:
2418 # ; title : definition text
2419 # So we check for : in the remainder text to split up the
2420 # title and definition, without b0rking links.
2421 $term = $t2 = '';
2422 if ( $this->findColonNoLinks( $t, $term, $t2 ) !== false ) {
2423 $t = $t2;
2424 $output .= $term . $this->nextItem( ':' );
2425 }
2426 }
2427 } elseif ( $prefixLength || $lastPrefixLength ) {
2428 # We need to open or close prefixes, or both.
2429
2430 # Either open or close a level...
2431 $commonPrefixLength = $this->getCommon( $prefix, $lastPrefix );
2432 $paragraphStack = false;
2433
2434 # Close all the prefixes which aren't shared.
2435 while ( $commonPrefixLength < $lastPrefixLength ) {
2436 $output .= $this->closeList( $lastPrefix[$lastPrefixLength - 1] );
2437 --$lastPrefixLength;
2438 }
2439
2440 # Continue the current prefix if appropriate.
2441 if ( $prefixLength <= $commonPrefixLength && $commonPrefixLength > 0 ) {
2442 $output .= $this->nextItem( $prefix[$commonPrefixLength - 1] );
2443 }
2444
2445 # Open prefixes where appropriate.
2446 while ( $prefixLength > $commonPrefixLength ) {
2447 $char = substr( $prefix, $commonPrefixLength, 1 );
2448 $output .= $this->openList( $char );
2449
2450 if ( ';' === $char ) {
2451 # @todo FIXME: This is dupe of code above
2452 if ( $this->findColonNoLinks( $t, $term, $t2 ) !== false ) {
2453 $t = $t2;
2454 $output .= $term . $this->nextItem( ':' );
2455 }
2456 }
2457 ++$commonPrefixLength;
2458 }
2459 $lastPrefix = $prefix2;
2460 }
2461
2462 # If we have no prefixes, go to paragraph mode.
2463 if ( 0 == $prefixLength ) {
2464 wfProfileIn( __METHOD__ . "-paragraph" );
2465 # No prefix (not in list)--go to paragraph mode
2466 # XXX: use a stack for nestable elements like span, table and div
2467 $openmatch = preg_match( '/(?:<table|<h1|<h2|<h3|<h4|<h5|<h6|<pre|<tr|<p|<ul|<ol|<dl|<li|<\\/tr|<\\/td|<\\/th)/iS', $t );
2468 $closematch = preg_match(
2469 '/(?:<\\/table|<\\/h1|<\\/h2|<\\/h3|<\\/h4|<\\/h5|<\\/h6|' .
2470 '<td|<th|<\\/?blockquote|<\\/?div|<hr|<\\/pre|<\\/p|<\\/mw:|' . $this->mUniqPrefix . '-pre|<\\/li|<\\/ul|<\\/ol|<\\/dl|<\\/?center)/iS', $t );
2471 if ( $openmatch or $closematch ) {
2472 $paragraphStack = false;
2473 # TODO bug 5718: paragraph closed
2474 $output .= $this->closeParagraph();
2475 if ( $preOpenMatch and !$preCloseMatch ) {
2476 $this->mInPre = true;
2477 }
2478 $bqOffset = 0;
2479 while ( preg_match( '/<(\\/?)blockquote[\s>]/i', $t, $bqMatch, PREG_OFFSET_CAPTURE, $bqOffset ) ) {
2480 $inBlockquote = !$bqMatch[1][0]; // is this a close tag?
2481 $bqOffset = $bqMatch[0][1] + strlen( $bqMatch[0][0] );
2482 }
2483 $inBlockElem = !$closematch;
2484 } elseif ( !$inBlockElem && !$this->mInPre ) {
2485 if ( ' ' == substr( $t, 0, 1 ) and ( $this->mLastSection === 'pre' || trim( $t ) != '' ) and !$inBlockquote ) {
2486 # pre
2487 if ( $this->mLastSection !== 'pre' ) {
2488 $paragraphStack = false;
2489 $output .= $this->closeParagraph() . '<pre>';
2490 $this->mLastSection = 'pre';
2491 }
2492 $t = substr( $t, 1 );
2493 } else {
2494 # paragraph
2495 if ( trim( $t ) === '' ) {
2496 if ( $paragraphStack ) {
2497 $output .= $paragraphStack . '<br />';
2498 $paragraphStack = false;
2499 $this->mLastSection = 'p';
2500 } else {
2501 if ( $this->mLastSection !== 'p' ) {
2502 $output .= $this->closeParagraph();
2503 $this->mLastSection = '';
2504 $paragraphStack = '<p>';
2505 } else {
2506 $paragraphStack = '</p><p>';
2507 }
2508 }
2509 } else {
2510 if ( $paragraphStack ) {
2511 $output .= $paragraphStack;
2512 $paragraphStack = false;
2513 $this->mLastSection = 'p';
2514 } elseif ( $this->mLastSection !== 'p' ) {
2515 $output .= $this->closeParagraph() . '<p>';
2516 $this->mLastSection = 'p';
2517 }
2518 }
2519 }
2520 }
2521 wfProfileOut( __METHOD__ . "-paragraph" );
2522 }
2523 # somewhere above we forget to get out of pre block (bug 785)
2524 if ( $preCloseMatch && $this->mInPre ) {
2525 $this->mInPre = false;
2526 }
2527 if ( $paragraphStack === false ) {
2528 $output .= $t . "\n";
2529 }
2530 }
2531 while ( $prefixLength ) {
2532 $output .= $this->closeList( $prefix2[$prefixLength - 1] );
2533 --$prefixLength;
2534 }
2535 if ( $this->mLastSection != '' ) {
2536 $output .= '</' . $this->mLastSection . '>';
2537 $this->mLastSection = '';
2538 }
2539
2540 wfProfileOut( __METHOD__ );
2541 return $output;
2542 }
2543
2544 /**
2545 * Split up a string on ':', ignoring any occurrences inside tags
2546 * to prevent illegal overlapping.
2547 *
2548 * @param string $str the string to split
2549 * @param &$before String set to everything before the ':'
2550 * @param &$after String set to everything after the ':'
2551 * @throws MWException
2552 * @return String the position of the ':', or false if none found
2553 */
2554 function findColonNoLinks( $str, &$before, &$after ) {
2555 wfProfileIn( __METHOD__ );
2556
2557 $pos = strpos( $str, ':' );
2558 if ( $pos === false ) {
2559 # Nothing to find!
2560 wfProfileOut( __METHOD__ );
2561 return false;
2562 }
2563
2564 $lt = strpos( $str, '<' );
2565 if ( $lt === false || $lt > $pos ) {
2566 # Easy; no tag nesting to worry about
2567 $before = substr( $str, 0, $pos );
2568 $after = substr( $str, $pos + 1 );
2569 wfProfileOut( __METHOD__ );
2570 return $pos;
2571 }
2572
2573 # Ugly state machine to walk through avoiding tags.
2574 $state = self::COLON_STATE_TEXT;
2575 $stack = 0;
2576 $len = strlen( $str );
2577 for ( $i = 0; $i < $len; $i++ ) {
2578 $c = $str[$i];
2579
2580 switch ( $state ) {
2581 # (Using the number is a performance hack for common cases)
2582 case 0: # self::COLON_STATE_TEXT:
2583 switch ( $c ) {
2584 case "<":
2585 # Could be either a <start> tag or an </end> tag
2586 $state = self::COLON_STATE_TAGSTART;
2587 break;
2588 case ":":
2589 if ( $stack == 0 ) {
2590 # We found it!
2591 $before = substr( $str, 0, $i );
2592 $after = substr( $str, $i + 1 );
2593 wfProfileOut( __METHOD__ );
2594 return $i;
2595 }
2596 # Embedded in a tag; don't break it.
2597 break;
2598 default:
2599 # Skip ahead looking for something interesting
2600 $colon = strpos( $str, ':', $i );
2601 if ( $colon === false ) {
2602 # Nothing else interesting
2603 wfProfileOut( __METHOD__ );
2604 return false;
2605 }
2606 $lt = strpos( $str, '<', $i );
2607 if ( $stack === 0 ) {
2608 if ( $lt === false || $colon < $lt ) {
2609 # We found it!
2610 $before = substr( $str, 0, $colon );
2611 $after = substr( $str, $colon + 1 );
2612 wfProfileOut( __METHOD__ );
2613 return $i;
2614 }
2615 }
2616 if ( $lt === false ) {
2617 # Nothing else interesting to find; abort!
2618 # We're nested, but there's no close tags left. Abort!
2619 break 2;
2620 }
2621 # Skip ahead to next tag start
2622 $i = $lt;
2623 $state = self::COLON_STATE_TAGSTART;
2624 }
2625 break;
2626 case 1: # self::COLON_STATE_TAG:
2627 # In a <tag>
2628 switch ( $c ) {
2629 case ">":
2630 $stack++;
2631 $state = self::COLON_STATE_TEXT;
2632 break;
2633 case "/":
2634 # Slash may be followed by >?
2635 $state = self::COLON_STATE_TAGSLASH;
2636 break;
2637 default:
2638 # ignore
2639 }
2640 break;
2641 case 2: # self::COLON_STATE_TAGSTART:
2642 switch ( $c ) {
2643 case "/":
2644 $state = self::COLON_STATE_CLOSETAG;
2645 break;
2646 case "!":
2647 $state = self::COLON_STATE_COMMENT;
2648 break;
2649 case ">":
2650 # Illegal early close? This shouldn't happen D:
2651 $state = self::COLON_STATE_TEXT;
2652 break;
2653 default:
2654 $state = self::COLON_STATE_TAG;
2655 }
2656 break;
2657 case 3: # self::COLON_STATE_CLOSETAG:
2658 # In a </tag>
2659 if ( $c === ">" ) {
2660 $stack--;
2661 if ( $stack < 0 ) {
2662 wfDebug( __METHOD__ . ": Invalid input; too many close tags\n" );
2663 wfProfileOut( __METHOD__ );
2664 return false;
2665 }
2666 $state = self::COLON_STATE_TEXT;
2667 }
2668 break;
2669 case self::COLON_STATE_TAGSLASH:
2670 if ( $c === ">" ) {
2671 # Yes, a self-closed tag <blah/>
2672 $state = self::COLON_STATE_TEXT;
2673 } else {
2674 # Probably we're jumping the gun, and this is an attribute
2675 $state = self::COLON_STATE_TAG;
2676 }
2677 break;
2678 case 5: # self::COLON_STATE_COMMENT:
2679 if ( $c === "-" ) {
2680 $state = self::COLON_STATE_COMMENTDASH;
2681 }
2682 break;
2683 case self::COLON_STATE_COMMENTDASH:
2684 if ( $c === "-" ) {
2685 $state = self::COLON_STATE_COMMENTDASHDASH;
2686 } else {
2687 $state = self::COLON_STATE_COMMENT;
2688 }
2689 break;
2690 case self::COLON_STATE_COMMENTDASHDASH:
2691 if ( $c === ">" ) {
2692 $state = self::COLON_STATE_TEXT;
2693 } else {
2694 $state = self::COLON_STATE_COMMENT;
2695 }
2696 break;
2697 default:
2698 wfProfileOut( __METHOD__ );
2699 throw new MWException( "State machine error in " . __METHOD__ );
2700 }
2701 }
2702 if ( $stack > 0 ) {
2703 wfDebug( __METHOD__ . ": Invalid input; not enough close tags (stack $stack, state $state)\n" );
2704 wfProfileOut( __METHOD__ );
2705 return false;
2706 }
2707 wfProfileOut( __METHOD__ );
2708 return false;
2709 }
2710
2711 /**
2712 * Return value of a magic variable (like PAGENAME)
2713 *
2714 * @private
2715 *
2716 * @param $index integer
2717 * @param bool|\PPFrame $frame
2718 *
2719 * @throws MWException
2720 * @return string
2721 */
2722 function getVariableValue( $index, $frame = false ) {
2723 global $wgContLang, $wgSitename, $wgServer;
2724 global $wgArticlePath, $wgScriptPath, $wgStylePath;
2725
2726 if ( is_null( $this->mTitle ) ) {
2727 // If no title set, bad things are going to happen
2728 // later. Title should always be set since this
2729 // should only be called in the middle of a parse
2730 // operation (but the unit-tests do funky stuff)
2731 throw new MWException( __METHOD__ . ' Should only be '
2732 . ' called while parsing (no title set)' );
2733 }
2734
2735 /**
2736 * Some of these require message or data lookups and can be
2737 * expensive to check many times.
2738 */
2739 if ( wfRunHooks( 'ParserGetVariableValueVarCache', array( &$this, &$this->mVarCache ) ) ) {
2740 if ( isset( $this->mVarCache[$index] ) ) {
2741 return $this->mVarCache[$index];
2742 }
2743 }
2744
2745 $ts = wfTimestamp( TS_UNIX, $this->mOptions->getTimestamp() );
2746 wfRunHooks( 'ParserGetVariableValueTs', array( &$this, &$ts ) );
2747
2748 $pageLang = $this->getFunctionLang();
2749
2750 switch ( $index ) {
2751 case 'currentmonth':
2752 $value = $pageLang->formatNum( MWTimestamp::getInstance( $ts )->format( 'm' ) );
2753 break;
2754 case 'currentmonth1':
2755 $value = $pageLang->formatNum( MWTimestamp::getInstance( $ts )->format( 'n' ) );
2756 break;
2757 case 'currentmonthname':
2758 $value = $pageLang->getMonthName( MWTimestamp::getInstance( $ts )->format( 'n' ) );
2759 break;
2760 case 'currentmonthnamegen':
2761 $value = $pageLang->getMonthNameGen( MWTimestamp::getInstance( $ts )->format( 'n' ) );
2762 break;
2763 case 'currentmonthabbrev':
2764 $value = $pageLang->getMonthAbbreviation( MWTimestamp::getInstance( $ts )->format( 'n' ) );
2765 break;
2766 case 'currentday':
2767 $value = $pageLang->formatNum( MWTimestamp::getInstance( $ts )->format( 'j' ) );
2768 break;
2769 case 'currentday2':
2770 $value = $pageLang->formatNum( MWTimestamp::getInstance( $ts )->format( 'd' ) );
2771 break;
2772 case 'localmonth':
2773 $value = $pageLang->formatNum( MWTimestamp::getLocalInstance( $ts )->format( 'm' ) );
2774 break;
2775 case 'localmonth1':
2776 $value = $pageLang->formatNum( MWTimestamp::getLocalInstance( $ts )->format( 'n' ) );
2777 break;
2778 case 'localmonthname':
2779 $value = $pageLang->getMonthName( MWTimestamp::getLocalInstance( $ts )->format( 'n' ) );
2780 break;
2781 case 'localmonthnamegen':
2782 $value = $pageLang->getMonthNameGen( MWTimestamp::getLocalInstance( $ts )->format( 'n' ) );
2783 break;
2784 case 'localmonthabbrev':
2785 $value = $pageLang->getMonthAbbreviation( MWTimestamp::getLocalInstance( $ts )->format( 'n' ) );
2786 break;
2787 case 'localday':
2788 $value = $pageLang->formatNum( MWTimestamp::getLocalInstance( $ts )->format( 'j' ) );
2789 break;
2790 case 'localday2':
2791 $value = $pageLang->formatNum( MWTimestamp::getLocalInstance( $ts )->format( 'd' ) );
2792 break;
2793 case 'pagename':
2794 $value = wfEscapeWikiText( $this->mTitle->getText() );
2795 break;
2796 case 'pagenamee':
2797 $value = wfEscapeWikiText( $this->mTitle->getPartialURL() );
2798 break;
2799 case 'fullpagename':
2800 $value = wfEscapeWikiText( $this->mTitle->getPrefixedText() );
2801 break;
2802 case 'fullpagenamee':
2803 $value = wfEscapeWikiText( $this->mTitle->getPrefixedURL() );
2804 break;
2805 case 'subpagename':
2806 $value = wfEscapeWikiText( $this->mTitle->getSubpageText() );
2807 break;
2808 case 'subpagenamee':
2809 $value = wfEscapeWikiText( $this->mTitle->getSubpageUrlForm() );
2810 break;
2811 case 'rootpagename':
2812 $value = wfEscapeWikiText( $this->mTitle->getRootText() );
2813 break;
2814 case 'rootpagenamee':
2815 $value = wfEscapeWikiText( wfUrlEncode( str_replace( ' ', '_', $this->mTitle->getRootText() ) ) );
2816 break;
2817 case 'basepagename':
2818 $value = wfEscapeWikiText( $this->mTitle->getBaseText() );
2819 break;
2820 case 'basepagenamee':
2821 $value = wfEscapeWikiText( wfUrlEncode( str_replace( ' ', '_', $this->mTitle->getBaseText() ) ) );
2822 break;
2823 case 'talkpagename':
2824 if ( $this->mTitle->canTalk() ) {
2825 $talkPage = $this->mTitle->getTalkPage();
2826 $value = wfEscapeWikiText( $talkPage->getPrefixedText() );
2827 } else {
2828 $value = '';
2829 }
2830 break;
2831 case 'talkpagenamee':
2832 if ( $this->mTitle->canTalk() ) {
2833 $talkPage = $this->mTitle->getTalkPage();
2834 $value = wfEscapeWikiText( $talkPage->getPrefixedURL() );
2835 } else {
2836 $value = '';
2837 }
2838 break;
2839 case 'subjectpagename':
2840 $subjPage = $this->mTitle->getSubjectPage();
2841 $value = wfEscapeWikiText( $subjPage->getPrefixedText() );
2842 break;
2843 case 'subjectpagenamee':
2844 $subjPage = $this->mTitle->getSubjectPage();
2845 $value = wfEscapeWikiText( $subjPage->getPrefixedURL() );
2846 break;
2847 case 'pageid': // requested in bug 23427
2848 $pageid = $this->getTitle()->getArticleID();
2849 if ( $pageid == 0 ) {
2850 # 0 means the page doesn't exist in the database,
2851 # which means the user is previewing a new page.
2852 # The vary-revision flag must be set, because the magic word
2853 # will have a different value once the page is saved.
2854 $this->mOutput->setFlag( 'vary-revision' );
2855 wfDebug( __METHOD__ . ": {{PAGEID}} used in a new page, setting vary-revision...\n" );
2856 }
2857 $value = $pageid ? $pageid : null;
2858 break;
2859 case 'revisionid':
2860 # Let the edit saving system know we should parse the page
2861 # *after* a revision ID has been assigned.
2862 $this->mOutput->setFlag( 'vary-revision' );
2863 wfDebug( __METHOD__ . ": {{REVISIONID}} used, setting vary-revision...\n" );
2864 $value = $this->mRevisionId;
2865 break;
2866 case 'revisionday':
2867 # Let the edit saving system know we should parse the page
2868 # *after* a revision ID has been assigned. This is for null edits.
2869 $this->mOutput->setFlag( 'vary-revision' );
2870 wfDebug( __METHOD__ . ": {{REVISIONDAY}} used, setting vary-revision...\n" );
2871 $value = intval( substr( $this->getRevisionTimestamp(), 6, 2 ) );
2872 break;
2873 case 'revisionday2':
2874 # Let the edit saving system know we should parse the page
2875 # *after* a revision ID has been assigned. This is for null edits.
2876 $this->mOutput->setFlag( 'vary-revision' );
2877 wfDebug( __METHOD__ . ": {{REVISIONDAY2}} used, setting vary-revision...\n" );
2878 $value = substr( $this->getRevisionTimestamp(), 6, 2 );
2879 break;
2880 case 'revisionmonth':
2881 # Let the edit saving system know we should parse the page
2882 # *after* a revision ID has been assigned. This is for null edits.
2883 $this->mOutput->setFlag( 'vary-revision' );
2884 wfDebug( __METHOD__ . ": {{REVISIONMONTH}} used, setting vary-revision...\n" );
2885 $value = substr( $this->getRevisionTimestamp(), 4, 2 );
2886 break;
2887 case 'revisionmonth1':
2888 # Let the edit saving system know we should parse the page
2889 # *after* a revision ID has been assigned. This is for null edits.
2890 $this->mOutput->setFlag( 'vary-revision' );
2891 wfDebug( __METHOD__ . ": {{REVISIONMONTH1}} used, setting vary-revision...\n" );
2892 $value = intval( substr( $this->getRevisionTimestamp(), 4, 2 ) );
2893 break;
2894 case 'revisionyear':
2895 # Let the edit saving system know we should parse the page
2896 # *after* a revision ID has been assigned. This is for null edits.
2897 $this->mOutput->setFlag( 'vary-revision' );
2898 wfDebug( __METHOD__ . ": {{REVISIONYEAR}} used, setting vary-revision...\n" );
2899 $value = substr( $this->getRevisionTimestamp(), 0, 4 );
2900 break;
2901 case 'revisiontimestamp':
2902 # Let the edit saving system know we should parse the page
2903 # *after* a revision ID has been assigned. This is for null edits.
2904 $this->mOutput->setFlag( 'vary-revision' );
2905 wfDebug( __METHOD__ . ": {{REVISIONTIMESTAMP}} used, setting vary-revision...\n" );
2906 $value = $this->getRevisionTimestamp();
2907 break;
2908 case 'revisionuser':
2909 # Let the edit saving system know we should parse the page
2910 # *after* a revision ID has been assigned. This is for null edits.
2911 $this->mOutput->setFlag( 'vary-revision' );
2912 wfDebug( __METHOD__ . ": {{REVISIONUSER}} used, setting vary-revision...\n" );
2913 $value = $this->getRevisionUser();
2914 break;
2915 case 'revisionsize':
2916 # Let the edit saving system know we should parse the page
2917 # *after* a revision ID has been assigned. This is for null edits.
2918 $this->mOutput->setFlag( 'vary-revision' );
2919 wfDebug( __METHOD__ . ": {{REVISIONSIZE}} used, setting vary-revision...\n" );
2920 $value = $this->getRevisionSize();
2921 break;
2922 case 'namespace':
2923 $value = str_replace( '_', ' ', $wgContLang->getNsText( $this->mTitle->getNamespace() ) );
2924 break;
2925 case 'namespacee':
2926 $value = wfUrlencode( $wgContLang->getNsText( $this->mTitle->getNamespace() ) );
2927 break;
2928 case 'namespacenumber':
2929 $value = $this->mTitle->getNamespace();
2930 break;
2931 case 'talkspace':
2932 $value = $this->mTitle->canTalk() ? str_replace( '_', ' ', $this->mTitle->getTalkNsText() ) : '';
2933 break;
2934 case 'talkspacee':
2935 $value = $this->mTitle->canTalk() ? wfUrlencode( $this->mTitle->getTalkNsText() ) : '';
2936 break;
2937 case 'subjectspace':
2938 $value = str_replace( '_', ' ', $this->mTitle->getSubjectNsText() );
2939 break;
2940 case 'subjectspacee':
2941 $value = ( wfUrlencode( $this->mTitle->getSubjectNsText() ) );
2942 break;
2943 case 'currentdayname':
2944 $value = $pageLang->getWeekdayName( MWTimestamp::getInstance( $ts )->format( 'w' ) + 1 );
2945 break;
2946 case 'currentyear':
2947 $value = $pageLang->formatNum( MWTimestamp::getInstance( $ts )->format( 'Y' ), true );
2948 break;
2949 case 'currenttime':
2950 $value = $pageLang->time( wfTimestamp( TS_MW, $ts ), false, false );
2951 break;
2952 case 'currenthour':
2953 $value = $pageLang->formatNum( MWTimestamp::getInstance( $ts )->format( 'H' ), true );
2954 break;
2955 case 'currentweek':
2956 # @bug 4594 PHP5 has it zero padded, PHP4 does not, cast to
2957 # int to remove the padding
2958 $value = $pageLang->formatNum( (int)MWTimestamp::getInstance( $ts )->format( 'W' ) );
2959 break;
2960 case 'currentdow':
2961 $value = $pageLang->formatNum( MWTimestamp::getInstance( $ts )->format( 'w' ) );
2962 break;
2963 case 'localdayname':
2964 $value = $pageLang->getWeekdayName( MWTimestamp::getLocalInstance( $ts )->format( 'w' ) + 1 );
2965 break;
2966 case 'localyear':
2967 $value = $pageLang->formatNum( MWTimestamp::getLocalInstance( $ts )->format( 'Y' ), true );
2968 break;
2969 case 'localtime':
2970 $value = $pageLang->time( MWTimestamp::getLocalInstance( $ts )->format( 'YmdHis' ), false, false );
2971 break;
2972 case 'localhour':
2973 $value = $pageLang->formatNum( MWTimestamp::getLocalInstance( $ts )->format( 'H' ), true );
2974 break;
2975 case 'localweek':
2976 # @bug 4594 PHP5 has it zero padded, PHP4 does not, cast to
2977 # int to remove the padding
2978 $value = $pageLang->formatNum( (int)MWTimestamp::getLocalInstance( $ts )->format( 'W' ) );
2979 break;
2980 case 'localdow':
2981 $value = $pageLang->formatNum( MWTimestamp::getLocalInstance( $ts )->format( 'w' ) );
2982 break;
2983 case 'numberofarticles':
2984 $value = $pageLang->formatNum( SiteStats::articles() );
2985 break;
2986 case 'numberoffiles':
2987 $value = $pageLang->formatNum( SiteStats::images() );
2988 break;
2989 case 'numberofusers':
2990 $value = $pageLang->formatNum( SiteStats::users() );
2991 break;
2992 case 'numberofactiveusers':
2993 $value = $pageLang->formatNum( SiteStats::activeUsers() );
2994 break;
2995 case 'numberofpages':
2996 $value = $pageLang->formatNum( SiteStats::pages() );
2997 break;
2998 case 'numberofadmins':
2999 $value = $pageLang->formatNum( SiteStats::numberingroup( 'sysop' ) );
3000 break;
3001 case 'numberofedits':
3002 $value = $pageLang->formatNum( SiteStats::edits() );
3003 break;
3004 case 'numberofviews':
3005 global $wgDisableCounters;
3006 $value = !$wgDisableCounters ? $pageLang->formatNum( SiteStats::views() ) : '';
3007 break;
3008 case 'currenttimestamp':
3009 $value = wfTimestamp( TS_MW, $ts );
3010 break;
3011 case 'localtimestamp':
3012 $value = MWTimestamp::getLocalInstance( $ts )->format( 'YmdHis' );
3013 break;
3014 case 'currentversion':
3015 $value = SpecialVersion::getVersion();
3016 break;
3017 case 'articlepath':
3018 return $wgArticlePath;
3019 case 'sitename':
3020 return $wgSitename;
3021 case 'server':
3022 return $wgServer;
3023 case 'servername':
3024 $serverParts = wfParseUrl( $wgServer );
3025 return $serverParts && isset( $serverParts['host'] ) ? $serverParts['host'] : $wgServer;
3026 case 'scriptpath':
3027 return $wgScriptPath;
3028 case 'stylepath':
3029 return $wgStylePath;
3030 case 'directionmark':
3031 return $pageLang->getDirMark();
3032 case 'contentlanguage':
3033 global $wgLanguageCode;
3034 return $wgLanguageCode;
3035 default:
3036 $ret = null;
3037 if ( wfRunHooks( 'ParserGetVariableValueSwitch', array( &$this, &$this->mVarCache, &$index, &$ret, &$frame ) ) ) {
3038 return $ret;
3039 } else {
3040 return null;
3041 }
3042 }
3043
3044 if ( $index ) {
3045 $this->mVarCache[$index] = $value;
3046 }
3047
3048 return $value;
3049 }
3050
3051 /**
3052 * initialise the magic variables (like CURRENTMONTHNAME) and substitution modifiers
3053 *
3054 * @private
3055 */
3056 function initialiseVariables() {
3057 wfProfileIn( __METHOD__ );
3058 $variableIDs = MagicWord::getVariableIDs();
3059 $substIDs = MagicWord::getSubstIDs();
3060
3061 $this->mVariables = new MagicWordArray( $variableIDs );
3062 $this->mSubstWords = new MagicWordArray( $substIDs );
3063 wfProfileOut( __METHOD__ );
3064 }
3065
3066 /**
3067 * Preprocess some wikitext and return the document tree.
3068 * This is the ghost of replace_variables().
3069 *
3070 * @param string $text The text to parse
3071 * @param $flags Integer: bitwise combination of:
3072 * self::PTD_FOR_INCLUSION Handle "<noinclude>" and "<includeonly>" as if the text is being
3073 * included. Default is to assume a direct page view.
3074 *
3075 * The generated DOM tree must depend only on the input text and the flags.
3076 * The DOM tree must be the same in OT_HTML and OT_WIKI mode, to avoid a regression of bug 4899.
3077 *
3078 * Any flag added to the $flags parameter here, or any other parameter liable to cause a
3079 * change in the DOM tree for a given text, must be passed through the section identifier
3080 * in the section edit link and thus back to extractSections().
3081 *
3082 * The output of this function is currently only cached in process memory, but a persistent
3083 * cache may be implemented at a later date which takes further advantage of these strict
3084 * dependency requirements.
3085 *
3086 * @private
3087 *
3088 * @return PPNode
3089 */
3090 function preprocessToDom( $text, $flags = 0 ) {
3091 $dom = $this->getPreprocessor()->preprocessToObj( $text, $flags );
3092 return $dom;
3093 }
3094
3095 /**
3096 * Return a three-element array: leading whitespace, string contents, trailing whitespace
3097 *
3098 * @param $s string
3099 *
3100 * @return array
3101 */
3102 public static function splitWhitespace( $s ) {
3103 $ltrimmed = ltrim( $s );
3104 $w1 = substr( $s, 0, strlen( $s ) - strlen( $ltrimmed ) );
3105 $trimmed = rtrim( $ltrimmed );
3106 $diff = strlen( $ltrimmed ) - strlen( $trimmed );
3107 if ( $diff > 0 ) {
3108 $w2 = substr( $ltrimmed, -$diff );
3109 } else {
3110 $w2 = '';
3111 }
3112 return array( $w1, $trimmed, $w2 );
3113 }
3114
3115 /**
3116 * Replace magic variables, templates, and template arguments
3117 * with the appropriate text. Templates are substituted recursively,
3118 * taking care to avoid infinite loops.
3119 *
3120 * Note that the substitution depends on value of $mOutputType:
3121 * self::OT_WIKI: only {{subst:}} templates
3122 * self::OT_PREPROCESS: templates but not extension tags
3123 * self::OT_HTML: all templates and extension tags
3124 *
3125 * @param string $text the text to transform
3126 * @param $frame PPFrame Object describing the arguments passed to the template.
3127 * Arguments may also be provided as an associative array, as was the usual case before MW1.12.
3128 * Providing arguments this way may be useful for extensions wishing to perform variable replacement explicitly.
3129 * @param $argsOnly Boolean only do argument (triple-brace) expansion, not double-brace expansion
3130 * @private
3131 *
3132 * @return string
3133 */
3134 function replaceVariables( $text, $frame = false, $argsOnly = false ) {
3135 # Is there any text? Also, Prevent too big inclusions!
3136 if ( strlen( $text ) < 1 || strlen( $text ) > $this->mOptions->getMaxIncludeSize() ) {
3137 return $text;
3138 }
3139 wfProfileIn( __METHOD__ );
3140
3141 if ( $frame === false ) {
3142 $frame = $this->getPreprocessor()->newFrame();
3143 } elseif ( !( $frame instanceof PPFrame ) ) {
3144 wfDebug( __METHOD__ . " called using plain parameters instead of a PPFrame instance. Creating custom frame.\n" );
3145 $frame = $this->getPreprocessor()->newCustomFrame( $frame );
3146 }
3147
3148 $dom = $this->preprocessToDom( $text );
3149 $flags = $argsOnly ? PPFrame::NO_TEMPLATES : 0;
3150 $text = $frame->expand( $dom, $flags );
3151
3152 wfProfileOut( __METHOD__ );
3153 return $text;
3154 }
3155
3156 /**
3157 * Clean up argument array - refactored in 1.9 so parserfunctions can use it, too.
3158 *
3159 * @param $args array
3160 *
3161 * @return array
3162 */
3163 static function createAssocArgs( $args ) {
3164 $assocArgs = array();
3165 $index = 1;
3166 foreach ( $args as $arg ) {
3167 $eqpos = strpos( $arg, '=' );
3168 if ( $eqpos === false ) {
3169 $assocArgs[$index++] = $arg;
3170 } else {
3171 $name = trim( substr( $arg, 0, $eqpos ) );
3172 $value = trim( substr( $arg, $eqpos + 1 ) );
3173 if ( $value === false ) {
3174 $value = '';
3175 }
3176 if ( $name !== false ) {
3177 $assocArgs[$name] = $value;
3178 }
3179 }
3180 }
3181
3182 return $assocArgs;
3183 }
3184
3185 /**
3186 * Warn the user when a parser limitation is reached
3187 * Will warn at most once the user per limitation type
3188 *
3189 * @param string $limitationType should be one of:
3190 * 'expensive-parserfunction' (corresponding messages:
3191 * 'expensive-parserfunction-warning',
3192 * 'expensive-parserfunction-category')
3193 * 'post-expand-template-argument' (corresponding messages:
3194 * 'post-expand-template-argument-warning',
3195 * 'post-expand-template-argument-category')
3196 * 'post-expand-template-inclusion' (corresponding messages:
3197 * 'post-expand-template-inclusion-warning',
3198 * 'post-expand-template-inclusion-category')
3199 * 'node-count-exceeded' (corresponding messages:
3200 * 'node-count-exceeded-warning',
3201 * 'node-count-exceeded-category')
3202 * 'expansion-depth-exceeded' (corresponding messages:
3203 * 'expansion-depth-exceeded-warning',
3204 * 'expansion-depth-exceeded-category')
3205 * @param int|null $current Current value
3206 * @param int|null $max Maximum allowed, when an explicit limit has been
3207 * exceeded, provide the values (optional)
3208 */
3209 function limitationWarn( $limitationType, $current = '', $max = '' ) {
3210 # does no harm if $current and $max are present but are unnecessary for the message
3211 $warning = wfMessage( "$limitationType-warning" )->numParams( $current, $max )
3212 ->inLanguage( $this->mOptions->getUserLangObj() )->text();
3213 $this->mOutput->addWarning( $warning );
3214 $this->addTrackingCategory( "$limitationType-category" );
3215 }
3216
3217 /**
3218 * Return the text of a template, after recursively
3219 * replacing any variables or templates within the template.
3220 *
3221 * @param array $piece the parts of the template
3222 * $piece['title']: the title, i.e. the part before the |
3223 * $piece['parts']: the parameter array
3224 * $piece['lineStart']: whether the brace was at the start of a line
3225 * @param $frame PPFrame The current frame, contains template arguments
3226 * @throws MWException
3227 * @return String: the text of the template
3228 * @private
3229 */
3230 function braceSubstitution( $piece, $frame ) {
3231 wfProfileIn( __METHOD__ );
3232 wfProfileIn( __METHOD__ . '-setup' );
3233
3234 # Flags
3235 $found = false; # $text has been filled
3236 $nowiki = false; # wiki markup in $text should be escaped
3237 $isHTML = false; # $text is HTML, armour it against wikitext transformation
3238 $forceRawInterwiki = false; # Force interwiki transclusion to be done in raw mode not rendered
3239 $isChildObj = false; # $text is a DOM node needing expansion in a child frame
3240 $isLocalObj = false; # $text is a DOM node needing expansion in the current frame
3241
3242 # Title object, where $text came from
3243 $title = false;
3244
3245 # $part1 is the bit before the first |, and must contain only title characters.
3246 # Various prefixes will be stripped from it later.
3247 $titleWithSpaces = $frame->expand( $piece['title'] );
3248 $part1 = trim( $titleWithSpaces );
3249 $titleText = false;
3250
3251 # Original title text preserved for various purposes
3252 $originalTitle = $part1;
3253
3254 # $args is a list of argument nodes, starting from index 0, not including $part1
3255 # @todo FIXME: If piece['parts'] is null then the call to getLength() below won't work b/c this $args isn't an object
3256 $args = ( null == $piece['parts'] ) ? array() : $piece['parts'];
3257 wfProfileOut( __METHOD__ . '-setup' );
3258
3259 $titleProfileIn = null; // profile templates
3260
3261 # SUBST
3262 wfProfileIn( __METHOD__ . '-modifiers' );
3263 if ( !$found ) {
3264
3265 $substMatch = $this->mSubstWords->matchStartAndRemove( $part1 );
3266
3267 # Possibilities for substMatch: "subst", "safesubst" or FALSE
3268 # Decide whether to expand template or keep wikitext as-is.
3269 if ( $this->ot['wiki'] ) {
3270 if ( $substMatch === false ) {
3271 $literal = true; # literal when in PST with no prefix
3272 } else {
3273 $literal = false; # expand when in PST with subst: or safesubst:
3274 }
3275 } else {
3276 if ( $substMatch == 'subst' ) {
3277 $literal = true; # literal when not in PST with plain subst:
3278 } else {
3279 $literal = false; # expand when not in PST with safesubst: or no prefix
3280 }
3281 }
3282 if ( $literal ) {
3283 $text = $frame->virtualBracketedImplode( '{{', '|', '}}', $titleWithSpaces, $args );
3284 $isLocalObj = true;
3285 $found = true;
3286 }
3287 }
3288
3289 # Variables
3290 if ( !$found && $args->getLength() == 0 ) {
3291 $id = $this->mVariables->matchStartToEnd( $part1 );
3292 if ( $id !== false ) {
3293 $text = $this->getVariableValue( $id, $frame );
3294 if ( MagicWord::getCacheTTL( $id ) > -1 ) {
3295 $this->mOutput->updateCacheExpiry( MagicWord::getCacheTTL( $id ) );
3296 }
3297 $found = true;
3298 }
3299 }
3300
3301 # MSG, MSGNW and RAW
3302 if ( !$found ) {
3303 # Check for MSGNW:
3304 $mwMsgnw = MagicWord::get( 'msgnw' );
3305 if ( $mwMsgnw->matchStartAndRemove( $part1 ) ) {
3306 $nowiki = true;
3307 } else {
3308 # Remove obsolete MSG:
3309 $mwMsg = MagicWord::get( 'msg' );
3310 $mwMsg->matchStartAndRemove( $part1 );
3311 }
3312
3313 # Check for RAW:
3314 $mwRaw = MagicWord::get( 'raw' );
3315 if ( $mwRaw->matchStartAndRemove( $part1 ) ) {
3316 $forceRawInterwiki = true;
3317 }
3318 }
3319 wfProfileOut( __METHOD__ . '-modifiers' );
3320
3321 # Parser functions
3322 if ( !$found ) {
3323 wfProfileIn( __METHOD__ . '-pfunc' );
3324
3325 $colonPos = strpos( $part1, ':' );
3326 if ( $colonPos !== false ) {
3327 $func = substr( $part1, 0, $colonPos );
3328 $funcArgs = array( trim( substr( $part1, $colonPos + 1 ) ) );
3329 for ( $i = 0; $i < $args->getLength(); $i++ ) {
3330 $funcArgs[] = $args->item( $i );
3331 }
3332 try {
3333 $result = $this->callParserFunction( $frame, $func, $funcArgs );
3334 } catch ( Exception $ex ) {
3335 wfProfileOut( __METHOD__ . '-pfunc' );
3336 wfProfileOut( __METHOD__ );
3337 throw $ex;
3338 }
3339
3340 # The interface for parser functions allows for extracting
3341 # flags into the local scope. Extract any forwarded flags
3342 # here.
3343 extract( $result );
3344 }
3345 wfProfileOut( __METHOD__ . '-pfunc' );
3346 }
3347
3348 # Finish mangling title and then check for loops.
3349 # Set $title to a Title object and $titleText to the PDBK
3350 if ( !$found ) {
3351 $ns = NS_TEMPLATE;
3352 # Split the title into page and subpage
3353 $subpage = '';
3354 $relative = $this->maybeDoSubpageLink( $part1, $subpage );
3355 if ( $part1 !== $relative ) {
3356 $part1 = $relative;
3357 $ns = $this->mTitle->getNamespace();
3358 }
3359 $title = Title::newFromText( $part1, $ns );
3360 if ( $title ) {
3361 $titleText = $title->getPrefixedText();
3362 # Check for language variants if the template is not found
3363 if ( $this->getConverterLanguage()->hasVariants() && $title->getArticleID() == 0 ) {
3364 $this->getConverterLanguage()->findVariantLink( $part1, $title, true );
3365 }
3366 # Do recursion depth check
3367 $limit = $this->mOptions->getMaxTemplateDepth();
3368 if ( $frame->depth >= $limit ) {
3369 $found = true;
3370 $text = '<span class="error">'
3371 . wfMessage( 'parser-template-recursion-depth-warning' )
3372 ->numParams( $limit )->inContentLanguage()->text()
3373 . '</span>';
3374 }
3375 }
3376 }
3377
3378 # Load from database
3379 if ( !$found && $title ) {
3380 if ( !Profiler::instance()->isPersistent() ) {
3381 # Too many unique items can kill profiling DBs/collectors
3382 $titleProfileIn = __METHOD__ . "-title-" . $title->getPrefixedDBkey();
3383 wfProfileIn( $titleProfileIn ); // template in
3384 }
3385 wfProfileIn( __METHOD__ . '-loadtpl' );
3386 if ( !$title->isExternal() ) {
3387 if ( $title->isSpecialPage()
3388 && $this->mOptions->getAllowSpecialInclusion()
3389 && $this->ot['html']
3390 ) {
3391 // Pass the template arguments as URL parameters.
3392 // "uselang" will have no effect since the Language object
3393 // is forced to the one defined in ParserOptions.
3394 $pageArgs = array();
3395 for ( $i = 0; $i < $args->getLength(); $i++ ) {
3396 $bits = $args->item( $i )->splitArg();
3397 if ( strval( $bits['index'] ) === '' ) {
3398 $name = trim( $frame->expand( $bits['name'], PPFrame::STRIP_COMMENTS ) );
3399 $value = trim( $frame->expand( $bits['value'] ) );
3400 $pageArgs[$name] = $value;
3401 }
3402 }
3403
3404 // Create a new context to execute the special page
3405 $context = new RequestContext;
3406 $context->setTitle( $title );
3407 $context->setRequest( new FauxRequest( $pageArgs ) );
3408 $context->setUser( $this->getUser() );
3409 $context->setLanguage( $this->mOptions->getUserLangObj() );
3410 $ret = SpecialPageFactory::capturePath( $title, $context );
3411 if ( $ret ) {
3412 $text = $context->getOutput()->getHTML();
3413 $this->mOutput->addOutputPageMetadata( $context->getOutput() );
3414 $found = true;
3415 $isHTML = true;
3416 $this->disableCache();
3417 }
3418 } elseif ( MWNamespace::isNonincludable( $title->getNamespace() ) ) {
3419 $found = false; # access denied
3420 wfDebug( __METHOD__ . ": template inclusion denied for " . $title->getPrefixedDBkey() );
3421 } else {
3422 list( $text, $title ) = $this->getTemplateDom( $title );
3423 if ( $text !== false ) {
3424 $found = true;
3425 $isChildObj = true;
3426 }
3427 }
3428
3429 # If the title is valid but undisplayable, make a link to it
3430 if ( !$found && ( $this->ot['html'] || $this->ot['pre'] ) ) {
3431 $text = "[[:$titleText]]";
3432 $found = true;
3433 }
3434 } elseif ( $title->isTrans() ) {
3435 # Interwiki transclusion
3436 if ( $this->ot['html'] && !$forceRawInterwiki ) {
3437 $text = $this->interwikiTransclude( $title, 'render' );
3438 $isHTML = true;
3439 } else {
3440 $text = $this->interwikiTransclude( $title, 'raw' );
3441 # Preprocess it like a template
3442 $text = $this->preprocessToDom( $text, self::PTD_FOR_INCLUSION );
3443 $isChildObj = true;
3444 }
3445 $found = true;
3446 }
3447
3448 # Do infinite loop check
3449 # This has to be done after redirect resolution to avoid infinite loops via redirects
3450 if ( !$frame->loopCheck( $title ) ) {
3451 $found = true;
3452 $text = '<span class="error">'
3453 . wfMessage( 'parser-template-loop-warning', $titleText )->inContentLanguage()->text()
3454 . '</span>';
3455 wfDebug( __METHOD__ . ": template loop broken at '$titleText'\n" );
3456 }
3457 wfProfileOut( __METHOD__ . '-loadtpl' );
3458 }
3459
3460 # If we haven't found text to substitute by now, we're done
3461 # Recover the source wikitext and return it
3462 if ( !$found ) {
3463 $text = $frame->virtualBracketedImplode( '{{', '|', '}}', $titleWithSpaces, $args );
3464 if ( $titleProfileIn ) {
3465 wfProfileOut( $titleProfileIn ); // template out
3466 }
3467 wfProfileOut( __METHOD__ );
3468 return array( 'object' => $text );
3469 }
3470
3471 # Expand DOM-style return values in a child frame
3472 if ( $isChildObj ) {
3473 # Clean up argument array
3474 $newFrame = $frame->newChild( $args, $title );
3475
3476 if ( $nowiki ) {
3477 $text = $newFrame->expand( $text, PPFrame::RECOVER_ORIG );
3478 } elseif ( $titleText !== false && $newFrame->isEmpty() ) {
3479 # Expansion is eligible for the empty-frame cache
3480 if ( isset( $this->mTplExpandCache[$titleText] ) ) {
3481 $text = $this->mTplExpandCache[$titleText];
3482 } else {
3483 $text = $newFrame->expand( $text );
3484 $this->mTplExpandCache[$titleText] = $text;
3485 }
3486 } else {
3487 # Uncached expansion
3488 $text = $newFrame->expand( $text );
3489 }
3490 }
3491 if ( $isLocalObj && $nowiki ) {
3492 $text = $frame->expand( $text, PPFrame::RECOVER_ORIG );
3493 $isLocalObj = false;
3494 }
3495
3496 if ( $titleProfileIn ) {
3497 wfProfileOut( $titleProfileIn ); // template out
3498 }
3499
3500 # Replace raw HTML by a placeholder
3501 if ( $isHTML ) {
3502 $text = $this->insertStripItem( $text );
3503 } elseif ( $nowiki && ( $this->ot['html'] || $this->ot['pre'] ) ) {
3504 # Escape nowiki-style return values
3505 $text = wfEscapeWikiText( $text );
3506 } elseif ( is_string( $text )
3507 && !$piece['lineStart']
3508 && preg_match( '/^(?:{\\||:|;|#|\*)/', $text )
3509 ) {
3510 # Bug 529: if the template begins with a table or block-level
3511 # element, it should be treated as beginning a new line.
3512 # This behavior is somewhat controversial.
3513 $text = "\n" . $text;
3514 }
3515
3516 if ( is_string( $text ) && !$this->incrementIncludeSize( 'post-expand', strlen( $text ) ) ) {
3517 # Error, oversize inclusion
3518 if ( $titleText !== false ) {
3519 # Make a working, properly escaped link if possible (bug 23588)
3520 $text = "[[:$titleText]]";
3521 } else {
3522 # This will probably not be a working link, but at least it may
3523 # provide some hint of where the problem is
3524 preg_replace( '/^:/', '', $originalTitle );
3525 $text = "[[:$originalTitle]]";
3526 }
3527 $text .= $this->insertStripItem( '<!-- WARNING: template omitted, post-expand include size too large -->' );
3528 $this->limitationWarn( 'post-expand-template-inclusion' );
3529 }
3530
3531 if ( $isLocalObj ) {
3532 $ret = array( 'object' => $text );
3533 } else {
3534 $ret = array( 'text' => $text );
3535 }
3536
3537 wfProfileOut( __METHOD__ );
3538 return $ret;
3539 }
3540
3541 /**
3542 * Call a parser function and return an array with text and flags.
3543 *
3544 * The returned array will always contain a boolean 'found', indicating
3545 * whether the parser function was found or not. It may also contain the
3546 * following:
3547 * text: string|object, resulting wikitext or PP DOM object
3548 * isHTML: bool, $text is HTML, armour it against wikitext transformation
3549 * isChildObj: bool, $text is a DOM node needing expansion in a child frame
3550 * isLocalObj: bool, $text is a DOM node needing expansion in the current frame
3551 * nowiki: bool, wiki markup in $text should be escaped
3552 *
3553 * @since 1.21
3554 * @param $frame PPFrame The current frame, contains template arguments
3555 * @param $function string Function name
3556 * @param $args array Arguments to the function
3557 * @return array
3558 */
3559 public function callParserFunction( $frame, $function, array $args = array() ) {
3560 global $wgContLang;
3561
3562 wfProfileIn( __METHOD__ );
3563
3564 # Case sensitive functions
3565 if ( isset( $this->mFunctionSynonyms[1][$function] ) ) {
3566 $function = $this->mFunctionSynonyms[1][$function];
3567 } else {
3568 # Case insensitive functions
3569 $function = $wgContLang->lc( $function );
3570 if ( isset( $this->mFunctionSynonyms[0][$function] ) ) {
3571 $function = $this->mFunctionSynonyms[0][$function];
3572 } else {
3573 wfProfileOut( __METHOD__ );
3574 return array( 'found' => false );
3575 }
3576 }
3577
3578 wfProfileIn( __METHOD__ . '-pfunc-' . $function );
3579 list( $callback, $flags ) = $this->mFunctionHooks[$function];
3580
3581 # Workaround for PHP bug 35229 and similar
3582 if ( !is_callable( $callback ) ) {
3583 wfProfileOut( __METHOD__ . '-pfunc-' . $function );
3584 wfProfileOut( __METHOD__ );
3585 throw new MWException( "Tag hook for $function is not callable\n" );
3586 }
3587
3588 $allArgs = array( &$this );
3589 if ( $flags & SFH_OBJECT_ARGS ) {
3590 # Convert arguments to PPNodes and collect for appending to $allArgs
3591 $funcArgs = array();
3592 foreach ( $args as $k => $v ) {
3593 if ( $v instanceof PPNode || $k === 0 ) {
3594 $funcArgs[] = $v;
3595 } else {
3596 $funcArgs[] = $this->mPreprocessor->newPartNodeArray( array( $k => $v ) )->item( 0 );
3597 }
3598 }
3599
3600 # Add a frame parameter, and pass the arguments as an array
3601 $allArgs[] = $frame;
3602 $allArgs[] = $funcArgs;
3603 } else {
3604 # Convert arguments to plain text and append to $allArgs
3605 foreach ( $args as $k => $v ) {
3606 if ( $v instanceof PPNode ) {
3607 $allArgs[] = trim( $frame->expand( $v ) );
3608 } elseif ( is_int( $k ) && $k >= 0 ) {
3609 $allArgs[] = trim( $v );
3610 } else {
3611 $allArgs[] = trim( "$k=$v" );
3612 }
3613 }
3614 }
3615
3616 $result = call_user_func_array( $callback, $allArgs );
3617
3618 # The interface for function hooks allows them to return a wikitext
3619 # string or an array containing the string and any flags. This mungs
3620 # things around to match what this method should return.
3621 if ( !is_array( $result ) ) {
3622 $result = array(
3623 'found' => true,
3624 'text' => $result,
3625 );
3626 } else {
3627 if ( isset( $result[0] ) && !isset( $result['text'] ) ) {
3628 $result['text'] = $result[0];
3629 }
3630 unset( $result[0] );
3631 $result += array(
3632 'found' => true,
3633 );
3634 }
3635
3636 $noparse = true;
3637 $preprocessFlags = 0;
3638 if ( isset( $result['noparse'] ) ) {
3639 $noparse = $result['noparse'];
3640 }
3641 if ( isset( $result['preprocessFlags'] ) ) {
3642 $preprocessFlags = $result['preprocessFlags'];
3643 }
3644
3645 if ( !$noparse ) {
3646 $result['text'] = $this->preprocessToDom( $result['text'], $preprocessFlags );
3647 $result['isChildObj'] = true;
3648 }
3649 wfProfileOut( __METHOD__ . '-pfunc-' . $function );
3650 wfProfileOut( __METHOD__ );
3651
3652 return $result;
3653 }
3654
3655 /**
3656 * Get the semi-parsed DOM representation of a template with a given title,
3657 * and its redirect destination title. Cached.
3658 *
3659 * @param $title Title
3660 *
3661 * @return array
3662 */
3663 function getTemplateDom( $title ) {
3664 $cacheTitle = $title;
3665 $titleText = $title->getPrefixedDBkey();
3666
3667 if ( isset( $this->mTplRedirCache[$titleText] ) ) {
3668 list( $ns, $dbk ) = $this->mTplRedirCache[$titleText];
3669 $title = Title::makeTitle( $ns, $dbk );
3670 $titleText = $title->getPrefixedDBkey();
3671 }
3672 if ( isset( $this->mTplDomCache[$titleText] ) ) {
3673 return array( $this->mTplDomCache[$titleText], $title );
3674 }
3675
3676 # Cache miss, go to the database
3677 list( $text, $title ) = $this->fetchTemplateAndTitle( $title );
3678
3679 if ( $text === false ) {
3680 $this->mTplDomCache[$titleText] = false;
3681 return array( false, $title );
3682 }
3683
3684 $dom = $this->preprocessToDom( $text, self::PTD_FOR_INCLUSION );
3685 $this->mTplDomCache[$titleText] = $dom;
3686
3687 if ( !$title->equals( $cacheTitle ) ) {
3688 $this->mTplRedirCache[$cacheTitle->getPrefixedDBkey()] =
3689 array( $title->getNamespace(), $cdb = $title->getDBkey() );
3690 }
3691
3692 return array( $dom, $title );
3693 }
3694
3695 /**
3696 * Fetch the unparsed text of a template and register a reference to it.
3697 * @param Title $title
3698 * @return Array ( string or false, Title )
3699 */
3700 function fetchTemplateAndTitle( $title ) {
3701 $templateCb = $this->mOptions->getTemplateCallback(); # Defaults to Parser::statelessFetchTemplate()
3702 $stuff = call_user_func( $templateCb, $title, $this );
3703 $text = $stuff['text'];
3704 $finalTitle = isset( $stuff['finalTitle'] ) ? $stuff['finalTitle'] : $title;
3705 if ( isset( $stuff['deps'] ) ) {
3706 foreach ( $stuff['deps'] as $dep ) {
3707 $this->mOutput->addTemplate( $dep['title'], $dep['page_id'], $dep['rev_id'] );
3708 if ( $dep['title']->equals( $this->getTitle() ) ) {
3709 // If we transclude ourselves, the final result
3710 // will change based on the new version of the page
3711 $this->mOutput->setFlag( 'vary-revision' );
3712 }
3713 }
3714 }
3715 return array( $text, $finalTitle );
3716 }
3717
3718 /**
3719 * Fetch the unparsed text of a template and register a reference to it.
3720 * @param Title $title
3721 * @return mixed string or false
3722 */
3723 function fetchTemplate( $title ) {
3724 $rv = $this->fetchTemplateAndTitle( $title );
3725 return $rv[0];
3726 }
3727
3728 /**
3729 * Static function to get a template
3730 * Can be overridden via ParserOptions::setTemplateCallback().
3731 *
3732 * @param $title Title
3733 * @param $parser Parser
3734 *
3735 * @return array
3736 */
3737 static function statelessFetchTemplate( $title, $parser = false ) {
3738 $text = $skip = false;
3739 $finalTitle = $title;
3740 $deps = array();
3741
3742 # Loop to fetch the article, with up to 1 redirect
3743 for ( $i = 0; $i < 2 && is_object( $title ); $i++ ) {
3744 # Give extensions a chance to select the revision instead
3745 $id = false; # Assume current
3746 wfRunHooks( 'BeforeParserFetchTemplateAndtitle',
3747 array( $parser, $title, &$skip, &$id ) );
3748
3749 if ( $skip ) {
3750 $text = false;
3751 $deps[] = array(
3752 'title' => $title,
3753 'page_id' => $title->getArticleID(),
3754 'rev_id' => null
3755 );
3756 break;
3757 }
3758 # Get the revision
3759 $rev = $id
3760 ? Revision::newFromId( $id )
3761 : Revision::newFromTitle( $title, false, Revision::READ_NORMAL );
3762 $rev_id = $rev ? $rev->getId() : 0;
3763 # If there is no current revision, there is no page
3764 if ( $id === false && !$rev ) {
3765 $linkCache = LinkCache::singleton();
3766 $linkCache->addBadLinkObj( $title );
3767 }
3768
3769 $deps[] = array(
3770 'title' => $title,
3771 'page_id' => $title->getArticleID(),
3772 'rev_id' => $rev_id );
3773 if ( $rev && !$title->equals( $rev->getTitle() ) ) {
3774 # We fetched a rev from a different title; register it too...
3775 $deps[] = array(
3776 'title' => $rev->getTitle(),
3777 'page_id' => $rev->getPage(),
3778 'rev_id' => $rev_id );
3779 }
3780
3781 if ( $rev ) {
3782 $content = $rev->getContent();
3783 $text = $content ? $content->getWikitextForTransclusion() : null;
3784
3785 if ( $text === false || $text === null ) {
3786 $text = false;
3787 break;
3788 }
3789 } elseif ( $title->getNamespace() == NS_MEDIAWIKI ) {
3790 global $wgContLang;
3791 $message = wfMessage( $wgContLang->lcfirst( $title->getText() ) )->inContentLanguage();
3792 if ( !$message->exists() ) {
3793 $text = false;
3794 break;
3795 }
3796 $content = $message->content();
3797 $text = $message->plain();
3798 } else {
3799 break;
3800 }
3801 if ( !$content ) {
3802 break;
3803 }
3804 # Redirect?
3805 $finalTitle = $title;
3806 $title = $content->getRedirectTarget();
3807 }
3808 return array(
3809 'text' => $text,
3810 'finalTitle' => $finalTitle,
3811 'deps' => $deps );
3812 }
3813
3814 /**
3815 * Fetch a file and its title and register a reference to it.
3816 * If 'broken' is a key in $options then the file will appear as a broken thumbnail.
3817 * @param Title $title
3818 * @param array $options Array of options to RepoGroup::findFile
3819 * @return File|bool
3820 */
3821 function fetchFile( $title, $options = array() ) {
3822 $res = $this->fetchFileAndTitle( $title, $options );
3823 return $res[0];
3824 }
3825
3826 /**
3827 * Fetch a file and its title and register a reference to it.
3828 * If 'broken' is a key in $options then the file will appear as a broken thumbnail.
3829 * @param Title $title
3830 * @param array $options Array of options to RepoGroup::findFile
3831 * @return Array ( File or false, Title of file )
3832 */
3833 function fetchFileAndTitle( $title, $options = array() ) {
3834 $file = $this->fetchFileNoRegister( $title, $options );
3835
3836 $time = $file ? $file->getTimestamp() : false;
3837 $sha1 = $file ? $file->getSha1() : false;
3838 # Register the file as a dependency...
3839 $this->mOutput->addImage( $title->getDBkey(), $time, $sha1 );
3840 if ( $file && !$title->equals( $file->getTitle() ) ) {
3841 # Update fetched file title
3842 $title = $file->getTitle();
3843 if ( is_null( $file->getRedirectedTitle() ) ) {
3844 # This file was not a redirect, but the title does not match.
3845 # Register under the new name because otherwise the link will
3846 # get lost.
3847 $this->mOutput->addImage( $title->getDBkey(), $time, $sha1 );
3848 }
3849 }
3850 return array( $file, $title );
3851 }
3852
3853 /**
3854 * Helper function for fetchFileAndTitle.
3855 *
3856 * Also useful if you need to fetch a file but not use it yet,
3857 * for example to get the file's handler.
3858 *
3859 * @param Title $title
3860 * @param array $options Array of options to RepoGroup::findFile
3861 * @return File or false
3862 */
3863 protected function fetchFileNoRegister( $title, $options = array() ) {
3864 if ( isset( $options['broken'] ) ) {
3865 $file = false; // broken thumbnail forced by hook
3866 } elseif ( isset( $options['sha1'] ) ) { // get by (sha1,timestamp)
3867 $file = RepoGroup::singleton()->findFileFromKey( $options['sha1'], $options );
3868 } else { // get by (name,timestamp)
3869 $file = wfFindFile( $title, $options );
3870 }
3871 return $file;
3872 }
3873
3874 /**
3875 * Transclude an interwiki link.
3876 *
3877 * @param $title Title
3878 * @param $action
3879 *
3880 * @return string
3881 */
3882 function interwikiTransclude( $title, $action ) {
3883 global $wgEnableScaryTranscluding;
3884
3885 if ( !$wgEnableScaryTranscluding ) {
3886 return wfMessage( 'scarytranscludedisabled' )->inContentLanguage()->text();
3887 }
3888
3889 $url = $title->getFullURL( array( 'action' => $action ) );
3890
3891 if ( strlen( $url ) > 255 ) {
3892 return wfMessage( 'scarytranscludetoolong' )->inContentLanguage()->text();
3893 }
3894 return $this->fetchScaryTemplateMaybeFromCache( $url );
3895 }
3896
3897 /**
3898 * @param $url string
3899 * @return Mixed|String
3900 */
3901 function fetchScaryTemplateMaybeFromCache( $url ) {
3902 global $wgTranscludeCacheExpiry;
3903 $dbr = wfGetDB( DB_SLAVE );
3904 $tsCond = $dbr->timestamp( time() - $wgTranscludeCacheExpiry );
3905 $obj = $dbr->selectRow( 'transcache', array( 'tc_time', 'tc_contents' ),
3906 array( 'tc_url' => $url, "tc_time >= " . $dbr->addQuotes( $tsCond ) ) );
3907 if ( $obj ) {
3908 return $obj->tc_contents;
3909 }
3910
3911 $req = MWHttpRequest::factory( $url );
3912 $status = $req->execute(); // Status object
3913 if ( $status->isOK() ) {
3914 $text = $req->getContent();
3915 } elseif ( $req->getStatus() != 200 ) { // Though we failed to fetch the content, this status is useless.
3916 return wfMessage( 'scarytranscludefailed-httpstatus', $url, $req->getStatus() /* HTTP status */ )->inContentLanguage()->text();
3917 } else {
3918 return wfMessage( 'scarytranscludefailed', $url )->inContentLanguage()->text();
3919 }
3920
3921 $dbw = wfGetDB( DB_MASTER );
3922 $dbw->replace( 'transcache', array( 'tc_url' ), array(
3923 'tc_url' => $url,
3924 'tc_time' => $dbw->timestamp( time() ),
3925 'tc_contents' => $text
3926 ) );
3927 return $text;
3928 }
3929
3930 /**
3931 * Triple brace replacement -- used for template arguments
3932 * @private
3933 *
3934 * @param $piece array
3935 * @param $frame PPFrame
3936 *
3937 * @return array
3938 */
3939 function argSubstitution( $piece, $frame ) {
3940 wfProfileIn( __METHOD__ );
3941
3942 $error = false;
3943 $parts = $piece['parts'];
3944 $nameWithSpaces = $frame->expand( $piece['title'] );
3945 $argName = trim( $nameWithSpaces );
3946 $object = false;
3947 $text = $frame->getArgument( $argName );
3948 if ( $text === false && $parts->getLength() > 0
3949 && ( $this->ot['html']
3950 || $this->ot['pre']
3951 || ( $this->ot['wiki'] && $frame->isTemplate() )
3952 )
3953 ) {
3954 # No match in frame, use the supplied default
3955 $object = $parts->item( 0 )->getChildren();
3956 }
3957 if ( !$this->incrementIncludeSize( 'arg', strlen( $text ) ) ) {
3958 $error = '<!-- WARNING: argument omitted, expansion size too large -->';
3959 $this->limitationWarn( 'post-expand-template-argument' );
3960 }
3961
3962 if ( $text === false && $object === false ) {
3963 # No match anywhere
3964 $object = $frame->virtualBracketedImplode( '{{{', '|', '}}}', $nameWithSpaces, $parts );
3965 }
3966 if ( $error !== false ) {
3967 $text .= $error;
3968 }
3969 if ( $object !== false ) {
3970 $ret = array( 'object' => $object );
3971 } else {
3972 $ret = array( 'text' => $text );
3973 }
3974
3975 wfProfileOut( __METHOD__ );
3976 return $ret;
3977 }
3978
3979 /**
3980 * Return the text to be used for a given extension tag.
3981 * This is the ghost of strip().
3982 *
3983 * @param array $params Associative array of parameters:
3984 * name PPNode for the tag name
3985 * attr PPNode for unparsed text where tag attributes are thought to be
3986 * attributes Optional associative array of parsed attributes
3987 * inner Contents of extension element
3988 * noClose Original text did not have a close tag
3989 * @param $frame PPFrame
3990 *
3991 * @throws MWException
3992 * @return string
3993 */
3994 function extensionSubstitution( $params, $frame ) {
3995 $name = $frame->expand( $params['name'] );
3996 $attrText = !isset( $params['attr'] ) ? null : $frame->expand( $params['attr'] );
3997 $content = !isset( $params['inner'] ) ? null : $frame->expand( $params['inner'] );
3998 $marker = "{$this->mUniqPrefix}-$name-" . sprintf( '%08X', $this->mMarkerIndex++ ) . self::MARKER_SUFFIX;
3999
4000 $isFunctionTag = isset( $this->mFunctionTagHooks[strtolower( $name )] ) &&
4001 ( $this->ot['html'] || $this->ot['pre'] );
4002 if ( $isFunctionTag ) {
4003 $markerType = 'none';
4004 } else {
4005 $markerType = 'general';
4006 }
4007 if ( $this->ot['html'] || $isFunctionTag ) {
4008 $name = strtolower( $name );
4009 $attributes = Sanitizer::decodeTagAttributes( $attrText );
4010 if ( isset( $params['attributes'] ) ) {
4011 $attributes = $attributes + $params['attributes'];
4012 }
4013
4014 if ( isset( $this->mTagHooks[$name] ) ) {
4015 # Workaround for PHP bug 35229 and similar
4016 if ( !is_callable( $this->mTagHooks[$name] ) ) {
4017 throw new MWException( "Tag hook for $name is not callable\n" );
4018 }
4019 $output = call_user_func_array( $this->mTagHooks[$name],
4020 array( $content, $attributes, $this, $frame ) );
4021 } elseif ( isset( $this->mFunctionTagHooks[$name] ) ) {
4022 list( $callback, ) = $this->mFunctionTagHooks[$name];
4023 if ( !is_callable( $callback ) ) {
4024 throw new MWException( "Tag hook for $name is not callable\n" );
4025 }
4026
4027 $output = call_user_func_array( $callback, array( &$this, $frame, $content, $attributes ) );
4028 } else {
4029 $output = '<span class="error">Invalid tag extension name: ' .
4030 htmlspecialchars( $name ) . '</span>';
4031 }
4032
4033 if ( is_array( $output ) ) {
4034 # Extract flags to local scope (to override $markerType)
4035 $flags = $output;
4036 $output = $flags[0];
4037 unset( $flags[0] );
4038 extract( $flags );
4039 }
4040 } else {
4041 if ( is_null( $attrText ) ) {
4042 $attrText = '';
4043 }
4044 if ( isset( $params['attributes'] ) ) {
4045 foreach ( $params['attributes'] as $attrName => $attrValue ) {
4046 $attrText .= ' ' . htmlspecialchars( $attrName ) . '="' .
4047 htmlspecialchars( $attrValue ) . '"';
4048 }
4049 }
4050 if ( $content === null ) {
4051 $output = "<$name$attrText/>";
4052 } else {
4053 $close = is_null( $params['close'] ) ? '' : $frame->expand( $params['close'] );
4054 $output = "<$name$attrText>$content$close";
4055 }
4056 }
4057
4058 if ( $markerType === 'none' ) {
4059 return $output;
4060 } elseif ( $markerType === 'nowiki' ) {
4061 $this->mStripState->addNoWiki( $marker, $output );
4062 } elseif ( $markerType === 'general' ) {
4063 $this->mStripState->addGeneral( $marker, $output );
4064 } else {
4065 throw new MWException( __METHOD__ . ': invalid marker type' );
4066 }
4067 return $marker;
4068 }
4069
4070 /**
4071 * Increment an include size counter
4072 *
4073 * @param string $type the type of expansion
4074 * @param $size Integer: the size of the text
4075 * @return Boolean: false if this inclusion would take it over the maximum, true otherwise
4076 */
4077 function incrementIncludeSize( $type, $size ) {
4078 if ( $this->mIncludeSizes[$type] + $size > $this->mOptions->getMaxIncludeSize() ) {
4079 return false;
4080 } else {
4081 $this->mIncludeSizes[$type] += $size;
4082 return true;
4083 }
4084 }
4085
4086 /**
4087 * Increment the expensive function count
4088 *
4089 * @return Boolean: false if the limit has been exceeded
4090 */
4091 function incrementExpensiveFunctionCount() {
4092 $this->mExpensiveFunctionCount++;
4093 return $this->mExpensiveFunctionCount <= $this->mOptions->getExpensiveParserFunctionLimit();
4094 }
4095
4096 /**
4097 * Strip double-underscore items like __NOGALLERY__ and __NOTOC__
4098 * Fills $this->mDoubleUnderscores, returns the modified text
4099 *
4100 * @param $text string
4101 *
4102 * @return string
4103 */
4104 function doDoubleUnderscore( $text ) {
4105 wfProfileIn( __METHOD__ );
4106
4107 # The position of __TOC__ needs to be recorded
4108 $mw = MagicWord::get( 'toc' );
4109 if ( $mw->match( $text ) ) {
4110 $this->mShowToc = true;
4111 $this->mForceTocPosition = true;
4112
4113 # Set a placeholder. At the end we'll fill it in with the TOC.
4114 $text = $mw->replace( '<!--MWTOC-->', $text, 1 );
4115
4116 # Only keep the first one.
4117 $text = $mw->replace( '', $text );
4118 }
4119
4120 # Now match and remove the rest of them
4121 $mwa = MagicWord::getDoubleUnderscoreArray();
4122 $this->mDoubleUnderscores = $mwa->matchAndRemove( $text );
4123
4124 if ( isset( $this->mDoubleUnderscores['nogallery'] ) ) {
4125 $this->mOutput->mNoGallery = true;
4126 }
4127 if ( isset( $this->mDoubleUnderscores['notoc'] ) && !$this->mForceTocPosition ) {
4128 $this->mShowToc = false;
4129 }
4130 if ( isset( $this->mDoubleUnderscores['hiddencat'] ) && $this->mTitle->getNamespace() == NS_CATEGORY ) {
4131 $this->addTrackingCategory( 'hidden-category-category' );
4132 }
4133 # (bug 8068) Allow control over whether robots index a page.
4134 #
4135 # @todo FIXME: Bug 14899: __INDEX__ always overrides __NOINDEX__ here! This
4136 # is not desirable, the last one on the page should win.
4137 if ( isset( $this->mDoubleUnderscores['noindex'] ) && $this->mTitle->canUseNoindex() ) {
4138 $this->mOutput->setIndexPolicy( 'noindex' );
4139 $this->addTrackingCategory( 'noindex-category' );
4140 }
4141 if ( isset( $this->mDoubleUnderscores['index'] ) && $this->mTitle->canUseNoindex() ) {
4142 $this->mOutput->setIndexPolicy( 'index' );
4143 $this->addTrackingCategory( 'index-category' );
4144 }
4145
4146 # Cache all double underscores in the database
4147 foreach ( $this->mDoubleUnderscores as $key => $val ) {
4148 $this->mOutput->setProperty( $key, '' );
4149 }
4150
4151 wfProfileOut( __METHOD__ );
4152 return $text;
4153 }
4154
4155 /**
4156 * Add a tracking category, getting the title from a system message,
4157 * or print a debug message if the title is invalid.
4158 *
4159 * @param string $msg message key
4160 * @return Boolean: whether the addition was successful
4161 */
4162 public function addTrackingCategory( $msg ) {
4163 if ( $this->mTitle->getNamespace() === NS_SPECIAL ) {
4164 wfDebug( __METHOD__ . ": Not adding tracking category $msg to special page!\n" );
4165 return false;
4166 }
4167 // Important to parse with correct title (bug 31469)
4168 $cat = wfMessage( $msg )
4169 ->title( $this->getTitle() )
4170 ->inContentLanguage()
4171 ->text();
4172
4173 # Allow tracking categories to be disabled by setting them to "-"
4174 if ( $cat === '-' ) {
4175 return false;
4176 }
4177
4178 $containerCategory = Title::makeTitleSafe( NS_CATEGORY, $cat );
4179 if ( $containerCategory ) {
4180 $this->mOutput->addCategory( $containerCategory->getDBkey(), $this->getDefaultSort() );
4181 return true;
4182 } else {
4183 wfDebug( __METHOD__ . ": [[MediaWiki:$msg]] is not a valid title!\n" );
4184 return false;
4185 }
4186 }
4187
4188 /**
4189 * This function accomplishes several tasks:
4190 * 1) Auto-number headings if that option is enabled
4191 * 2) Add an [edit] link to sections for users who have enabled the option and can edit the page
4192 * 3) Add a Table of contents on the top for users who have enabled the option
4193 * 4) Auto-anchor headings
4194 *
4195 * It loops through all headlines, collects the necessary data, then splits up the
4196 * string and re-inserts the newly formatted headlines.
4197 *
4198 * @param $text String
4199 * @param string $origText original, untouched wikitext
4200 * @param $isMain Boolean
4201 * @return mixed|string
4202 * @private
4203 */
4204 function formatHeadings( $text, $origText, $isMain = true ) {
4205 global $wgMaxTocLevel, $wgExperimentalHtmlIds;
4206
4207 # Inhibit editsection links if requested in the page
4208 if ( isset( $this->mDoubleUnderscores['noeditsection'] ) ) {
4209 $maybeShowEditLink = $showEditLink = false;
4210 } else {
4211 $maybeShowEditLink = true; /* Actual presence will depend on ParserOptions option */
4212 $showEditLink = $this->mOptions->getEditSection();
4213 }
4214 if ( $showEditLink ) {
4215 $this->mOutput->setEditSectionTokens( true );
4216 }
4217
4218 # Get all headlines for numbering them and adding funky stuff like [edit]
4219 # links - this is for later, but we need the number of headlines right now
4220 $matches = array();
4221 $numMatches = preg_match_all( '/<H(?P<level>[1-6])(?P<attrib>.*?' . '>)\s*(?P<header>[\s\S]*?)\s*<\/H[1-6] *>/i', $text, $matches );
4222
4223 # if there are fewer than 4 headlines in the article, do not show TOC
4224 # unless it's been explicitly enabled.
4225 $enoughToc = $this->mShowToc &&
4226 ( ( $numMatches >= 4 ) || $this->mForceTocPosition );
4227
4228 # Allow user to stipulate that a page should have a "new section"
4229 # link added via __NEWSECTIONLINK__
4230 if ( isset( $this->mDoubleUnderscores['newsectionlink'] ) ) {
4231 $this->mOutput->setNewSection( true );
4232 }
4233
4234 # Allow user to remove the "new section"
4235 # link via __NONEWSECTIONLINK__
4236 if ( isset( $this->mDoubleUnderscores['nonewsectionlink'] ) ) {
4237 $this->mOutput->hideNewSection( true );
4238 }
4239
4240 # if the string __FORCETOC__ (not case-sensitive) occurs in the HTML,
4241 # override above conditions and always show TOC above first header
4242 if ( isset( $this->mDoubleUnderscores['forcetoc'] ) ) {
4243 $this->mShowToc = true;
4244 $enoughToc = true;
4245 }
4246
4247 # headline counter
4248 $headlineCount = 0;
4249 $numVisible = 0;
4250
4251 # Ugh .. the TOC should have neat indentation levels which can be
4252 # passed to the skin functions. These are determined here
4253 $toc = '';
4254 $full = '';
4255 $head = array();
4256 $sublevelCount = array();
4257 $levelCount = array();
4258 $level = 0;
4259 $prevlevel = 0;
4260 $toclevel = 0;
4261 $prevtoclevel = 0;
4262 $markerRegex = "{$this->mUniqPrefix}-h-(\d+)-" . self::MARKER_SUFFIX;
4263 $baseTitleText = $this->mTitle->getPrefixedDBkey();
4264 $oldType = $this->mOutputType;
4265 $this->setOutputType( self::OT_WIKI );
4266 $frame = $this->getPreprocessor()->newFrame();
4267 $root = $this->preprocessToDom( $origText );
4268 $node = $root->getFirstChild();
4269 $byteOffset = 0;
4270 $tocraw = array();
4271 $refers = array();
4272
4273 foreach ( $matches[3] as $headline ) {
4274 $isTemplate = false;
4275 $titleText = false;
4276 $sectionIndex = false;
4277 $numbering = '';
4278 $markerMatches = array();
4279 if ( preg_match( "/^$markerRegex/", $headline, $markerMatches ) ) {
4280 $serial = $markerMatches[1];
4281 list( $titleText, $sectionIndex ) = $this->mHeadings[$serial];
4282 $isTemplate = ( $titleText != $baseTitleText );
4283 $headline = preg_replace( "/^$markerRegex\\s*/", "", $headline );
4284 }
4285
4286 if ( $toclevel ) {
4287 $prevlevel = $level;
4288 }
4289 $level = $matches[1][$headlineCount];
4290
4291 if ( $level > $prevlevel ) {
4292 # Increase TOC level
4293 $toclevel++;
4294 $sublevelCount[$toclevel] = 0;
4295 if ( $toclevel < $wgMaxTocLevel ) {
4296 $prevtoclevel = $toclevel;
4297 $toc .= Linker::tocIndent();
4298 $numVisible++;
4299 }
4300 } elseif ( $level < $prevlevel && $toclevel > 1 ) {
4301 # Decrease TOC level, find level to jump to
4302
4303 for ( $i = $toclevel; $i > 0; $i-- ) {
4304 if ( $levelCount[$i] == $level ) {
4305 # Found last matching level
4306 $toclevel = $i;
4307 break;
4308 } elseif ( $levelCount[$i] < $level ) {
4309 # Found first matching level below current level
4310 $toclevel = $i + 1;
4311 break;
4312 }
4313 }
4314 if ( $i == 0 ) {
4315 $toclevel = 1;
4316 }
4317 if ( $toclevel < $wgMaxTocLevel ) {
4318 if ( $prevtoclevel < $wgMaxTocLevel ) {
4319 # Unindent only if the previous toc level was shown :p
4320 $toc .= Linker::tocUnindent( $prevtoclevel - $toclevel );
4321 $prevtoclevel = $toclevel;
4322 } else {
4323 $toc .= Linker::tocLineEnd();
4324 }
4325 }
4326 } else {
4327 # No change in level, end TOC line
4328 if ( $toclevel < $wgMaxTocLevel ) {
4329 $toc .= Linker::tocLineEnd();
4330 }
4331 }
4332
4333 $levelCount[$toclevel] = $level;
4334
4335 # count number of headlines for each level
4336 $sublevelCount[$toclevel]++;
4337 $dot = 0;
4338 for ( $i = 1; $i <= $toclevel; $i++ ) {
4339 if ( !empty( $sublevelCount[$i] ) ) {
4340 if ( $dot ) {
4341 $numbering .= '.';
4342 }
4343 $numbering .= $this->getTargetLanguage()->formatNum( $sublevelCount[$i] );
4344 $dot = 1;
4345 }
4346 }
4347
4348 # The safe header is a version of the header text safe to use for links
4349
4350 # Remove link placeholders by the link text.
4351 # <!--LINK number-->
4352 # turns into
4353 # link text with suffix
4354 # Do this before unstrip since link text can contain strip markers
4355 $safeHeadline = $this->replaceLinkHoldersText( $headline );
4356
4357 # Avoid insertion of weird stuff like <math> by expanding the relevant sections
4358 $safeHeadline = $this->mStripState->unstripBoth( $safeHeadline );
4359
4360 # Strip out HTML (first regex removes any tag not allowed)
4361 # Allowed tags are:
4362 # * <sup> and <sub> (bug 8393)
4363 # * <i> (bug 26375)
4364 # * <b> (r105284)
4365 # * <span dir="rtl"> and <span dir="ltr"> (bug 35167)
4366 #
4367 # We strip any parameter from accepted tags (second regex), except dir="rtl|ltr" from <span>,
4368 # to allow setting directionality in toc items.
4369 $tocline = preg_replace(
4370 array( '#<(?!/?(span|sup|sub|i|b)(?: [^>]*)?>).*?' . '>#', '#<(/?(?:span(?: dir="(?:rtl|ltr)")?|sup|sub|i|b))(?: .*?)?' . '>#' ),
4371 array( '', '<$1>' ),
4372 $safeHeadline
4373 );
4374 $tocline = trim( $tocline );
4375
4376 # For the anchor, strip out HTML-y stuff period
4377 $safeHeadline = preg_replace( '/<.*?' . '>/', '', $safeHeadline );
4378 $safeHeadline = Sanitizer::normalizeSectionNameWhitespace( $safeHeadline );
4379
4380 # Save headline for section edit hint before it's escaped
4381 $headlineHint = $safeHeadline;
4382
4383 if ( $wgExperimentalHtmlIds ) {
4384 # For reverse compatibility, provide an id that's
4385 # HTML4-compatible, like we used to.
4386 #
4387 # It may be worth noting, academically, that it's possible for
4388 # the legacy anchor to conflict with a non-legacy headline
4389 # anchor on the page. In this case likely the "correct" thing
4390 # would be to either drop the legacy anchors or make sure
4391 # they're numbered first. However, this would require people
4392 # to type in section names like "abc_.D7.93.D7.90.D7.A4"
4393 # manually, so let's not bother worrying about it.
4394 $legacyHeadline = Sanitizer::escapeId( $safeHeadline,
4395 array( 'noninitial', 'legacy' ) );
4396 $safeHeadline = Sanitizer::escapeId( $safeHeadline );
4397
4398 if ( $legacyHeadline == $safeHeadline ) {
4399 # No reason to have both (in fact, we can't)
4400 $legacyHeadline = false;
4401 }
4402 } else {
4403 $legacyHeadline = false;
4404 $safeHeadline = Sanitizer::escapeId( $safeHeadline,
4405 'noninitial' );
4406 }
4407
4408 # HTML names must be case-insensitively unique (bug 10721).
4409 # This does not apply to Unicode characters per
4410 # http://dev.w3.org/html5/spec/infrastructure.html#case-sensitivity-and-string-comparison
4411 # @todo FIXME: We may be changing them depending on the current locale.
4412 $arrayKey = strtolower( $safeHeadline );
4413 if ( $legacyHeadline === false ) {
4414 $legacyArrayKey = false;
4415 } else {
4416 $legacyArrayKey = strtolower( $legacyHeadline );
4417 }
4418
4419 # count how many in assoc. array so we can track dupes in anchors
4420 if ( isset( $refers[$arrayKey] ) ) {
4421 $refers[$arrayKey]++;
4422 } else {
4423 $refers[$arrayKey] = 1;
4424 }
4425 if ( isset( $refers[$legacyArrayKey] ) ) {
4426 $refers[$legacyArrayKey]++;
4427 } else {
4428 $refers[$legacyArrayKey] = 1;
4429 }
4430
4431 # Don't number the heading if it is the only one (looks silly)
4432 if ( count( $matches[3] ) > 1 && $this->mOptions->getNumberHeadings() ) {
4433 # the two are different if the line contains a link
4434 $headline = Html::element( 'span', array( 'class' => 'mw-headline-number' ), $numbering ) . ' ' . $headline;
4435 }
4436
4437 # Create the anchor for linking from the TOC to the section
4438 $anchor = $safeHeadline;
4439 $legacyAnchor = $legacyHeadline;
4440 if ( $refers[$arrayKey] > 1 ) {
4441 $anchor .= '_' . $refers[$arrayKey];
4442 }
4443 if ( $legacyHeadline !== false && $refers[$legacyArrayKey] > 1 ) {
4444 $legacyAnchor .= '_' . $refers[$legacyArrayKey];
4445 }
4446 if ( $enoughToc && ( !isset( $wgMaxTocLevel ) || $toclevel < $wgMaxTocLevel ) ) {
4447 $toc .= Linker::tocLine( $anchor, $tocline,
4448 $numbering, $toclevel, ( $isTemplate ? false : $sectionIndex ) );
4449 }
4450
4451 # Add the section to the section tree
4452 # Find the DOM node for this header
4453 $noOffset = ( $isTemplate || $sectionIndex === false );
4454 while ( $node && !$noOffset ) {
4455 if ( $node->getName() === 'h' ) {
4456 $bits = $node->splitHeading();
4457 if ( $bits['i'] == $sectionIndex ) {
4458 break;
4459 }
4460 }
4461 $byteOffset += mb_strlen( $this->mStripState->unstripBoth(
4462 $frame->expand( $node, PPFrame::RECOVER_ORIG ) ) );
4463 $node = $node->getNextSibling();
4464 }
4465 $tocraw[] = array(
4466 'toclevel' => $toclevel,
4467 'level' => $level,
4468 'line' => $tocline,
4469 'number' => $numbering,
4470 'index' => ( $isTemplate ? 'T-' : '' ) . $sectionIndex,
4471 'fromtitle' => $titleText,
4472 'byteoffset' => ( $noOffset ? null : $byteOffset ),
4473 'anchor' => $anchor,
4474 );
4475
4476 # give headline the correct <h#> tag
4477 if ( $maybeShowEditLink && $sectionIndex !== false ) {
4478 // Output edit section links as markers with styles that can be customized by skins
4479 if ( $isTemplate ) {
4480 # Put a T flag in the section identifier, to indicate to extractSections()
4481 # that sections inside <includeonly> should be counted.
4482 $editlinkArgs = array( $titleText, "T-$sectionIndex"/*, null */ );
4483 } else {
4484 $editlinkArgs = array( $this->mTitle->getPrefixedText(), $sectionIndex, $headlineHint );
4485 }
4486 // We use a bit of pesudo-xml for editsection markers. The language converter is run later on
4487 // Using a UNIQ style marker leads to the converter screwing up the tokens when it converts stuff
4488 // And trying to insert strip tags fails too. At this point all real inputted tags have already been escaped
4489 // so we don't have to worry about a user trying to input one of these markers directly.
4490 // We use a page and section attribute to stop the language converter from converting these important bits
4491 // of data, but put the headline hint inside a content block because the language converter is supposed to
4492 // be able to convert that piece of data.
4493 $editlink = '<mw:editsection page="' . htmlspecialchars( $editlinkArgs[0] );
4494 $editlink .= '" section="' . htmlspecialchars( $editlinkArgs[1] ) . '"';
4495 if ( isset( $editlinkArgs[2] ) ) {
4496 $editlink .= '>' . $editlinkArgs[2] . '</mw:editsection>';
4497 } else {
4498 $editlink .= '/>';
4499 }
4500 } else {
4501 $editlink = '';
4502 }
4503 $head[$headlineCount] = Linker::makeHeadline( $level,
4504 $matches['attrib'][$headlineCount], $anchor, $headline,
4505 $editlink, $legacyAnchor );
4506
4507 $headlineCount++;
4508 }
4509
4510 $this->setOutputType( $oldType );
4511
4512 # Never ever show TOC if no headers
4513 if ( $numVisible < 1 ) {
4514 $enoughToc = false;
4515 }
4516
4517 if ( $enoughToc ) {
4518 if ( $prevtoclevel > 0 && $prevtoclevel < $wgMaxTocLevel ) {
4519 $toc .= Linker::tocUnindent( $prevtoclevel - 1 );
4520 }
4521 $toc = Linker::tocList( $toc, $this->mOptions->getUserLangObj() );
4522 $this->mOutput->setTOCHTML( $toc );
4523 $toc = self::TOC_START . $toc . self::TOC_END;
4524 }
4525
4526 if ( $isMain ) {
4527 $this->mOutput->setSections( $tocraw );
4528 }
4529
4530 # split up and insert constructed headlines
4531 $blocks = preg_split( '/<H[1-6].*?' . '>[\s\S]*?<\/H[1-6]>/i', $text );
4532 $i = 0;
4533
4534 // build an array of document sections
4535 $sections = array();
4536 foreach ( $blocks as $block ) {
4537 // $head is zero-based, sections aren't.
4538 if ( empty( $head[$i - 1] ) ) {
4539 $sections[$i] = $block;
4540 } else {
4541 $sections[$i] = $head[$i - 1] . $block;
4542 }
4543
4544 /**
4545 * Send a hook, one per section.
4546 * The idea here is to be able to make section-level DIVs, but to do so in a
4547 * lower-impact, more correct way than r50769
4548 *
4549 * $this : caller
4550 * $section : the section number
4551 * &$sectionContent : ref to the content of the section
4552 * $showEditLinks : boolean describing whether this section has an edit link
4553 */
4554 wfRunHooks( 'ParserSectionCreate', array( $this, $i, &$sections[$i], $showEditLink ) );
4555
4556 $i++;
4557 }
4558
4559 if ( $enoughToc && $isMain && !$this->mForceTocPosition ) {
4560 // append the TOC at the beginning
4561 // Top anchor now in skin
4562 $sections[0] = $sections[0] . $toc . "\n";
4563 }
4564
4565 $full .= join( '', $sections );
4566
4567 if ( $this->mForceTocPosition ) {
4568 return str_replace( '<!--MWTOC-->', $toc, $full );
4569 } else {
4570 return $full;
4571 }
4572 }
4573
4574 /**
4575 * Transform wiki markup when saving a page by doing "\r\n" -> "\n"
4576 * conversion, substitting signatures, {{subst:}} templates, etc.
4577 *
4578 * @param string $text the text to transform
4579 * @param $title Title: the Title object for the current article
4580 * @param $user User: the User object describing the current user
4581 * @param $options ParserOptions: parsing options
4582 * @param $clearState Boolean: whether to clear the parser state first
4583 * @return String: the altered wiki markup
4584 */
4585 public function preSaveTransform( $text, Title $title, User $user, ParserOptions $options, $clearState = true ) {
4586 $this->startParse( $title, $options, self::OT_WIKI, $clearState );
4587 $this->setUser( $user );
4588
4589 $pairs = array(
4590 "\r\n" => "\n",
4591 );
4592 $text = str_replace( array_keys( $pairs ), array_values( $pairs ), $text );
4593 if ( $options->getPreSaveTransform() ) {
4594 $text = $this->pstPass2( $text, $user );
4595 }
4596 $text = $this->mStripState->unstripBoth( $text );
4597
4598 $this->setUser( null ); #Reset
4599
4600 return $text;
4601 }
4602
4603 /**
4604 * Pre-save transform helper function
4605 * @private
4606 *
4607 * @param $text string
4608 * @param $user User
4609 *
4610 * @return string
4611 */
4612 function pstPass2( $text, $user ) {
4613 global $wgContLang;
4614
4615 # Note: This is the timestamp saved as hardcoded wikitext to
4616 # the database, we use $wgContLang here in order to give
4617 # everyone the same signature and use the default one rather
4618 # than the one selected in each user's preferences.
4619 # (see also bug 12815)
4620 $ts = $this->mOptions->getTimestamp();
4621 $timestamp = MWTimestamp::getLocalInstance( $ts );
4622 $ts = $timestamp->format( 'YmdHis' );
4623 $tzMsg = $timestamp->format( 'T' ); # might vary on DST changeover!
4624
4625 # Allow translation of timezones through wiki. format() can return
4626 # whatever crap the system uses, localised or not, so we cannot
4627 # ship premade translations.
4628 $key = 'timezone-' . strtolower( trim( $tzMsg ) );
4629 $msg = wfMessage( $key )->inContentLanguage();
4630 if ( $msg->exists() ) {
4631 $tzMsg = $msg->text();
4632 }
4633
4634 $d = $wgContLang->timeanddate( $ts, false, false ) . " ($tzMsg)";
4635
4636 # Variable replacement
4637 # Because mOutputType is OT_WIKI, this will only process {{subst:xxx}} type tags
4638 $text = $this->replaceVariables( $text );
4639
4640 # This works almost by chance, as the replaceVariables are done before the getUserSig(),
4641 # which may corrupt this parser instance via its wfMessage()->text() call-
4642
4643 # Signatures
4644 $sigText = $this->getUserSig( $user );
4645 $text = strtr( $text, array(
4646 '~~~~~' => $d,
4647 '~~~~' => "$sigText $d",
4648 '~~~' => $sigText
4649 ) );
4650
4651 # Context links ("pipe tricks"): [[|name]] and [[name (context)|]]
4652 $tc = '[' . Title::legalChars() . ']';
4653 $nc = '[ _0-9A-Za-z\x80-\xff-]'; # Namespaces can use non-ascii!
4654
4655 $p1 = "/\[\[(:?$nc+:|:|)($tc+?)( ?\\($tc+\\))\\|]]/"; # [[ns:page (context)|]]
4656 $p4 = "/\[\[(:?$nc+:|:|)($tc+?)( ?（$tc+）)\\|]]/"; # [[ns:page（context）|]] (double-width brackets, added in r40257)
4657 $p3 = "/\[\[(:?$nc+:|:|)($tc+?)( ?\\($tc+\\)|)((?:, |，)$tc+|)\\|]]/"; # [[ns:page (context), context|]] (using either single or double-width comma)
4658 $p2 = "/\[\[\\|($tc+)]]/"; # [[|page]] (reverse pipe trick: add context from page title)
4659
4660 # try $p1 first, to turn "[[A, B (C)|]]" into "[[A, B (C)|A, B]]"
4661 $text = preg_replace( $p1, '[[\\1\\2\\3|\\2]]', $text );
4662 $text = preg_replace( $p4, '[[\\1\\2\\3|\\2]]', $text );
4663 $text = preg_replace( $p3, '[[\\1\\2\\3\\4|\\2]]', $text );
4664
4665 $t = $this->mTitle->getText();
4666 $m = array();
4667 if ( preg_match( "/^($nc+:|)$tc+?( \\($tc+\\))$/", $t, $m ) ) {
4668 $text = preg_replace( $p2, "[[$m[1]\\1$m[2]|\\1]]", $text );
4669 } elseif ( preg_match( "/^($nc+:|)$tc+?(, $tc+|)$/", $t, $m ) && "$m[1]$m[2]" != '' ) {
4670 $text = preg_replace( $p2, "[[$m[1]\\1$m[2]|\\1]]", $text );
4671 } else {
4672 # if there's no context, don't bother duplicating the title
4673 $text = preg_replace( $p2, '[[\\1]]', $text );
4674 }
4675
4676 # Trim trailing whitespace
4677 $text = rtrim( $text );
4678
4679 return $text;
4680 }
4681
4682 /**
4683 * Fetch the user's signature text, if any, and normalize to
4684 * validated, ready-to-insert wikitext.
4685 * If you have pre-fetched the nickname or the fancySig option, you can
4686 * specify them here to save a database query.
4687 * Do not reuse this parser instance after calling getUserSig(),
4688 * as it may have changed if it's the $wgParser.
4689 *
4690 * @param $user User
4691 * @param string|bool $nickname nickname to use or false to use user's default nickname
4692 * @param $fancySig Boolean|null whether the nicknname is the complete signature
4693 * or null to use default value
4694 * @return string
4695 */
4696 function getUserSig( &$user, $nickname = false, $fancySig = null ) {
4697 global $wgMaxSigChars;
4698
4699 $username = $user->getName();
4700
4701 # If not given, retrieve from the user object.
4702 if ( $nickname === false ) {
4703 $nickname = $user->getOption( 'nickname' );
4704 }
4705
4706 if ( is_null( $fancySig ) ) {
4707 $fancySig = $user->getBoolOption( 'fancysig' );
4708 }
4709
4710 $nickname = $nickname == null ? $username : $nickname;
4711
4712 if ( mb_strlen( $nickname ) > $wgMaxSigChars ) {
4713 $nickname = $username;
4714 wfDebug( __METHOD__ . ": $username has overlong signature.\n" );
4715 } elseif ( $fancySig !== false ) {
4716 # Sig. might contain markup; validate this
4717 if ( $this->validateSig( $nickname ) !== false ) {
4718 # Validated; clean up (if needed) and return it
4719 return $this->cleanSig( $nickname, true );
4720 } else {
4721 # Failed to validate; fall back to the default
4722 $nickname = $username;
4723 wfDebug( __METHOD__ . ": $username has bad XML tags in signature.\n" );
4724 }
4725 }
4726
4727 # Make sure nickname doesnt get a sig in a sig
4728 $nickname = self::cleanSigInSig( $nickname );
4729
4730 # If we're still here, make it a link to the user page
4731 $userText = wfEscapeWikiText( $username );
4732 $nickText = wfEscapeWikiText( $nickname );
4733 $msgName = $user->isAnon() ? 'signature-anon' : 'signature';
4734
4735 return wfMessage( $msgName, $userText, $nickText )->inContentLanguage()->title( $this->getTitle() )->text();
4736 }
4737
4738 /**
4739 * Check that the user's signature contains no bad XML
4740 *
4741 * @param $text String
4742 * @return mixed An expanded string, or false if invalid.
4743 */
4744 function validateSig( $text ) {
4745 return Xml::isWellFormedXmlFragment( $text ) ? $text : false;
4746 }
4747
4748 /**
4749 * Clean up signature text
4750 *
4751 * 1) Strip ~~~, ~~~~ and ~~~~~ out of signatures @see cleanSigInSig
4752 * 2) Substitute all transclusions
4753 *
4754 * @param $text String
4755 * @param bool $parsing Whether we're cleaning (preferences save) or parsing
4756 * @return String: signature text
4757 */
4758 public function cleanSig( $text, $parsing = false ) {
4759 if ( !$parsing ) {
4760 global $wgTitle;
4761 $this->startParse( $wgTitle, new ParserOptions, self::OT_PREPROCESS, true );
4762 }
4763
4764 # Option to disable this feature
4765 if ( !$this->mOptions->getCleanSignatures() ) {
4766 return $text;
4767 }
4768
4769 # @todo FIXME: Regex doesn't respect extension tags or nowiki
4770 # => Move this logic to braceSubstitution()
4771 $substWord = MagicWord::get( 'subst' );
4772 $substRegex = '/\{\{(?!(?:' . $substWord->getBaseRegex() . '))/x' . $substWord->getRegexCase();
4773 $substText = '{{' . $substWord->getSynonym( 0 );
4774
4775 $text = preg_replace( $substRegex, $substText, $text );
4776 $text = self::cleanSigInSig( $text );
4777 $dom = $this->preprocessToDom( $text );
4778 $frame = $this->getPreprocessor()->newFrame();
4779 $text = $frame->expand( $dom );
4780
4781 if ( !$parsing ) {
4782 $text = $this->mStripState->unstripBoth( $text );
4783 }
4784
4785 return $text;
4786 }
4787
4788 /**
4789 * Strip ~~~, ~~~~ and ~~~~~ out of signatures
4790 *
4791 * @param $text String
4792 * @return String: signature text with /~{3,5}/ removed
4793 */
4794 public static function cleanSigInSig( $text ) {
4795 $text = preg_replace( '/~{3,5}/', '', $text );
4796 return $text;
4797 }
4798
4799 /**
4800 * Set up some variables which are usually set up in parse()
4801 * so that an external function can call some class members with confidence
4802 *
4803 * @param $title Title|null
4804 * @param $options ParserOptions
4805 * @param $outputType
4806 * @param $clearState bool
4807 */
4808 public function startExternalParse( Title $title = null, ParserOptions $options, $outputType, $clearState = true ) {
4809 $this->startParse( $title, $options, $outputType, $clearState );
4810 }
4811
4812 /**
4813 * @param $title Title|null
4814 * @param $options ParserOptions
4815 * @param $outputType
4816 * @param $clearState bool
4817 */
4818 private function startParse( Title $title = null, ParserOptions $options, $outputType, $clearState = true ) {
4819 $this->setTitle( $title );
4820 $this->mOptions = $options;
4821 $this->setOutputType( $outputType );
4822 if ( $clearState ) {
4823 $this->clearState();
4824 }
4825 }
4826
4827 /**
4828 * Wrapper for preprocess()
4829 *
4830 * @param string $text the text to preprocess
4831 * @param $options ParserOptions: options
4832 * @param $title Title object or null to use $wgTitle
4833 * @return String
4834 */
4835 public function transformMsg( $text, $options, $title = null ) {
4836 static $executing = false;
4837
4838 # Guard against infinite recursion
4839 if ( $executing ) {
4840 return $text;
4841 }
4842 $executing = true;
4843
4844 wfProfileIn( __METHOD__ );
4845 if ( !$title ) {
4846 global $wgTitle;
4847 $title = $wgTitle;
4848 }
4849
4850 $text = $this->preprocess( $text, $title, $options );
4851
4852 $executing = false;
4853 wfProfileOut( __METHOD__ );
4854 return $text;
4855 }
4856
4857 /**
4858 * Create an HTML-style tag, e.g. "<yourtag>special text</yourtag>"
4859 * The callback should have the following form:
4860 * function myParserHook( $text, $params, $parser, $frame ) { ... }
4861 *
4862 * Transform and return $text. Use $parser for any required context, e.g. use
4863 * $parser->getTitle() and $parser->getOptions() not $wgTitle or $wgOut->mParserOptions
4864 *
4865 * Hooks may return extended information by returning an array, of which the
4866 * first numbered element (index 0) must be the return string, and all other
4867 * entries are extracted into local variables within an internal function
4868 * in the Parser class.
4869 *
4870 * This interface (introduced r61913) appears to be undocumented, but
4871 * 'markerName' is used by some core tag hooks to override which strip
4872 * array their results are placed in. **Use great caution if attempting
4873 * this interface, as it is not documented and injudicious use could smash
4874 * private variables.**
4875 *
4876 * @param $tag Mixed: the tag to use, e.g. 'hook' for "<hook>"
4877 * @param $callback Mixed: the callback function (and object) to use for the tag
4878 * @throws MWException
4879 * @return Mixed|null The old value of the mTagHooks array associated with the hook
4880 */
4881 public function setHook( $tag, $callback ) {
4882 $tag = strtolower( $tag );
4883 if ( preg_match( '/[<>\r\n]/', $tag, $m ) ) {
4884 throw new MWException( "Invalid character {$m[0]} in setHook('$tag', ...) call" );
4885 }
4886 $oldVal = isset( $this->mTagHooks[$tag] ) ? $this->mTagHooks[$tag] : null;
4887 $this->mTagHooks[$tag] = $callback;
4888 if ( !in_array( $tag, $this->mStripList ) ) {
4889 $this->mStripList[] = $tag;
4890 }
4891
4892 return $oldVal;
4893 }
4894
4895 /**
4896 * As setHook(), but letting the contents be parsed.
4897 *
4898 * Transparent tag hooks are like regular XML-style tag hooks, except they
4899 * operate late in the transformation sequence, on HTML instead of wikitext.
4900 *
4901 * This is probably obsoleted by things dealing with parser frames?
4902 * The only extension currently using it is geoserver.
4903 *
4904 * @since 1.10
4905 * @todo better document or deprecate this
4906 *
4907 * @param $tag Mixed: the tag to use, e.g. 'hook' for "<hook>"
4908 * @param $callback Mixed: the callback function (and object) to use for the tag
4909 * @throws MWException
4910 * @return Mixed|null The old value of the mTagHooks array associated with the hook
4911 */
4912 function setTransparentTagHook( $tag, $callback ) {
4913 $tag = strtolower( $tag );
4914 if ( preg_match( '/[<>\r\n]/', $tag, $m ) ) {
4915 throw new MWException( "Invalid character {$m[0]} in setTransparentHook('$tag', ...) call" );
4916 }
4917 $oldVal = isset( $this->mTransparentTagHooks[$tag] ) ? $this->mTransparentTagHooks[$tag] : null;
4918 $this->mTransparentTagHooks[$tag] = $callback;
4919
4920 return $oldVal;
4921 }
4922
4923 /**
4924 * Remove all tag hooks
4925 */
4926 function clearTagHooks() {
4927 $this->mTagHooks = array();
4928 $this->mFunctionTagHooks = array();
4929 $this->mStripList = $this->mDefaultStripList;
4930 }
4931
4932 /**
4933 * Create a function, e.g. {{sum:1|2|3}}
4934 * The callback function should have the form:
4935 * function myParserFunction( &$parser, $arg1, $arg2, $arg3 ) { ... }
4936 *
4937 * Or with SFH_OBJECT_ARGS:
4938 * function myParserFunction( $parser, $frame, $args ) { ... }
4939 *
4940 * The callback may either return the text result of the function, or an array with the text
4941 * in element 0, and a number of flags in the other elements. The names of the flags are
4942 * specified in the keys. Valid flags are:
4943 * found The text returned is valid, stop processing the template. This
4944 * is on by default.
4945 * nowiki Wiki markup in the return value should be escaped
4946 * isHTML The returned text is HTML, armour it against wikitext transformation
4947 *
4948 * @param string $id The magic word ID
4949 * @param $callback Mixed: the callback function (and object) to use
4950 * @param $flags Integer: a combination of the following flags:
4951 * SFH_NO_HASH No leading hash, i.e. {{plural:...}} instead of {{#if:...}}
4952 *
4953 * SFH_OBJECT_ARGS Pass the template arguments as PPNode objects instead of text. This
4954 * allows for conditional expansion of the parse tree, allowing you to eliminate dead
4955 * branches and thus speed up parsing. It is also possible to analyse the parse tree of
4956 * the arguments, and to control the way they are expanded.
4957 *
4958 * The $frame parameter is a PPFrame. This can be used to produce expanded text from the
4959 * arguments, for instance:
4960 * $text = isset( $args[0] ) ? $frame->expand( $args[0] ) : '';
4961 *
4962 * For technical reasons, $args[0] is pre-expanded and will be a string. This may change in
4963 * future versions. Please call $frame->expand() on it anyway so that your code keeps
4964 * working if/when this is changed.
4965 *
4966 * If you want whitespace to be trimmed from $args, you need to do it yourself, post-
4967 * expansion.
4968 *
4969 * Please read the documentation in includes/parser/Preprocessor.php for more information
4970 * about the methods available in PPFrame and PPNode.
4971 *
4972 * @throws MWException
4973 * @return string|callback The old callback function for this name, if any
4974 */
4975 public function setFunctionHook( $id, $callback, $flags = 0 ) {
4976 global $wgContLang;
4977
4978 $oldVal = isset( $this->mFunctionHooks[$id] ) ? $this->mFunctionHooks[$id][0] : null;
4979 $this->mFunctionHooks[$id] = array( $callback, $flags );
4980
4981 # Add to function cache
4982 $mw = MagicWord::get( $id );
4983 if ( !$mw ) {
4984 throw new MWException( __METHOD__ . '() expecting a magic word identifier.' );
4985 }
4986
4987 $synonyms = $mw->getSynonyms();
4988 $sensitive = intval( $mw->isCaseSensitive() );
4989
4990 foreach ( $synonyms as $syn ) {
4991 # Case
4992 if ( !$sensitive ) {
4993 $syn = $wgContLang->lc( $syn );
4994 }
4995 # Add leading hash
4996 if ( !( $flags & SFH_NO_HASH ) ) {
4997 $syn = '#' . $syn;
4998 }
4999 # Remove trailing colon
5000 if ( substr( $syn, -1, 1 ) === ':' ) {
5001 $syn = substr( $syn, 0, -1 );
5002 }
5003 $this->mFunctionSynonyms[$sensitive][$syn] = $id;
5004 }
5005 return $oldVal;
5006 }
5007
5008 /**
5009 * Get all registered function hook identifiers
5010 *
5011 * @return Array
5012 */
5013 function getFunctionHooks() {
5014 return array_keys( $this->mFunctionHooks );
5015 }
5016
5017 /**
5018 * Create a tag function, e.g. "<test>some stuff</test>".
5019 * Unlike tag hooks, tag functions are parsed at preprocessor level.
5020 * Unlike parser functions, their content is not preprocessed.
5021 * @param $tag
5022 * @param $callback
5023 * @param $flags
5024 * @throws MWException
5025 * @return null
5026 */
5027 function setFunctionTagHook( $tag, $callback, $flags ) {
5028 $tag = strtolower( $tag );
5029 if ( preg_match( '/[<>\r\n]/', $tag, $m ) ) {
5030 throw new MWException( "Invalid character {$m[0]} in setFunctionTagHook('$tag', ...) call" );
5031 }
5032 $old = isset( $this->mFunctionTagHooks[$tag] ) ?
5033 $this->mFunctionTagHooks[$tag] : null;
5034 $this->mFunctionTagHooks[$tag] = array( $callback, $flags );
5035
5036 if ( !in_array( $tag, $this->mStripList ) ) {
5037 $this->mStripList[] = $tag;
5038 }
5039
5040 return $old;
5041 }
5042
5043 /**
5044 * @todo FIXME: Update documentation. makeLinkObj() is deprecated.
5045 * Replace "<!--LINK-->" link placeholders with actual links, in the buffer
5046 * Placeholders created in Skin::makeLinkObj()
5047 *
5048 * @param $text string
5049 * @param $options int
5050 *
5051 * @return array of link CSS classes, indexed by PDBK.
5052 */
5053 function replaceLinkHolders( &$text, $options = 0 ) {
5054 return $this->mLinkHolders->replace( $text );
5055 }
5056
5057 /**
5058 * Replace "<!--LINK-->" link placeholders with plain text of links
5059 * (not HTML-formatted).
5060 *
5061 * @param $text String
5062 * @return String
5063 */
5064 function replaceLinkHoldersText( $text ) {
5065 return $this->mLinkHolders->replaceText( $text );
5066 }
5067
5068 /**
5069 * Renders an image gallery from a text with one line per image.
5070 * text labels may be given by using |-style alternative text. E.g.
5071 * Image:one.jpg|The number "1"
5072 * Image:tree.jpg|A tree
5073 * given as text will return the HTML of a gallery with two images,
5074 * labeled 'The number "1"' and
5075 * 'A tree'.
5076 *
5077 * @param string $text
5078 * @param array $params
5079 * @return string HTML
5080 */
5081 function renderImageGallery( $text, $params ) {
5082 wfProfileIn( __METHOD__ );
5083
5084 $mode = false;
5085 if ( isset( $params['mode'] ) ) {
5086 $mode = $params['mode'];
5087 }
5088
5089 try {
5090 $ig = ImageGalleryBase::factory( $mode );
5091 } catch ( MWException $e ) {
5092 // If invalid type set, fallback to default.
5093 $ig = ImageGalleryBase::factory( false );
5094 }
5095
5096 $ig->setContextTitle( $this->mTitle );
5097 $ig->setShowBytes( false );
5098 $ig->setShowFilename( false );
5099 $ig->setParser( $this );
5100 $ig->setHideBadImages();
5101 $ig->setAttributes( Sanitizer::validateTagAttributes( $params, 'table' ) );
5102
5103 if ( isset( $params['showfilename'] ) ) {
5104 $ig->setShowFilename( true );
5105 } else {
5106 $ig->setShowFilename( false );
5107 }
5108 if ( isset( $params['caption'] ) ) {
5109 $caption = $params['caption'];
5110 $caption = htmlspecialchars( $caption );
5111 $caption = $this->replaceInternalLinks( $caption );
5112 $ig->setCaptionHtml( $caption );
5113 }
5114 if ( isset( $params['perrow'] ) ) {
5115 $ig->setPerRow( $params['perrow'] );
5116 }
5117 if ( isset( $params['widths'] ) ) {
5118 $ig->setWidths( $params['widths'] );
5119 }
5120 if ( isset( $params['heights'] ) ) {
5121 $ig->setHeights( $params['heights'] );
5122 }
5123 $ig->setAdditionalOptions( $params );
5124
5125 wfRunHooks( 'BeforeParserrenderImageGallery', array( &$this, &$ig ) );
5126
5127 $lines = StringUtils::explode( "\n", $text );
5128 foreach ( $lines as $line ) {
5129 # match lines like these:
5130 # Image:someimage.jpg|This is some image
5131 $matches = array();
5132 preg_match( "/^([^|]+)(\\|(.*))?$/", $line, $matches );
5133 # Skip empty lines
5134 if ( count( $matches ) == 0 ) {
5135 continue;
5136 }
5137
5138 if ( strpos( $matches[0], '%' ) !== false ) {
5139 $matches[1] = rawurldecode( $matches[1] );
5140 }
5141 $title = Title::newFromText( $matches[1], NS_FILE );
5142 if ( is_null( $title ) ) {
5143 # Bogus title. Ignore these so we don't bomb out later.
5144 continue;
5145 }
5146
5147 # We need to get what handler the file uses, to figure out parameters.
5148 # Note, a hook can overide the file name, and chose an entirely different
5149 # file (which potentially could be of a different type and have different handler).
5150 $options = array();
5151 $descQuery = false;
5152 wfRunHooks( 'BeforeParserFetchFileAndTitle',
5153 array( $this, $title, &$options, &$descQuery ) );
5154 # Don't register it now, as ImageGallery does that later.
5155 $file = $this->fetchFileNoRegister( $title, $options );
5156 $handler = $file ? $file->getHandler() : false;
5157
5158 wfProfileIn( __METHOD__ . '-getMagicWord' );
5159 $paramMap = array(
5160 'img_alt' => 'gallery-internal-alt',
5161 'img_link' => 'gallery-internal-link',
5162 );
5163 if ( $handler ) {
5164 $paramMap = $paramMap + $handler->getParamMap();
5165 // We don't want people to specify per-image widths.
5166 // Additionally the width parameter would need special casing anyhow.
5167 unset( $paramMap['img_width'] );
5168 }
5169
5170 $mwArray = new MagicWordArray( array_keys( $paramMap ) );
5171 wfProfileOut( __METHOD__ . '-getMagicWord' );
5172
5173 $label = '';
5174 $alt = '';
5175 $link = '';
5176 $handlerOptions = array();
5177 if ( isset( $matches[3] ) ) {
5178 // look for an |alt= definition while trying not to break existing
5179 // captions with multiple pipes (|) in it, until a more sensible grammar
5180 // is defined for images in galleries
5181
5182 // FIXME: Doing recursiveTagParse at this stage, and the trim before
5183 // splitting on '|' is a bit odd, and different from makeImage.
5184 $matches[3] = $this->recursiveTagParse( trim( $matches[3] ) );
5185 $parameterMatches = StringUtils::explode( '|', $matches[3] );
5186
5187 foreach ( $parameterMatches as $parameterMatch ) {
5188 list( $magicName, $match ) = $mwArray->matchVariableStartToEnd( $parameterMatch );
5189 if ( $magicName ) {
5190 $paramName = $paramMap[$magicName];
5191
5192 switch ( $paramName ) {
5193 case 'gallery-internal-alt':
5194 $alt = $this->stripAltText( $match, false );
5195 break;
5196 case 'gallery-internal-link':
5197 $linkValue = strip_tags( $this->replaceLinkHoldersText( $match ) );
5198 $chars = self::EXT_LINK_URL_CLASS;
5199 $prots = $this->mUrlProtocols;
5200 //check to see if link matches an absolute url, if not then it must be a wiki link.
5201 if ( preg_match( "/^($prots)$chars+$/u", $linkValue ) ) {
5202 $link = $linkValue;
5203 } else {
5204 $localLinkTitle = Title::newFromText( $linkValue );
5205 if ( $localLinkTitle !== null ) {
5206 $link = $localLinkTitle->getLocalURL();
5207 }
5208 }
5209 break;
5210 default:
5211 // Must be a handler specific parameter.
5212 if ( $handler->validateParam( $paramName, $match ) ) {
5213 $handlerOptions[$paramName] = $match;
5214 } else {
5215 // Guess not. Append it to the caption.
5216 wfDebug( "$parameterMatch failed parameter validation" );
5217 $label .= '|' . $parameterMatch;
5218 }
5219 }
5220
5221 } else {
5222 // concatenate all other pipes
5223 $label .= '|' . $parameterMatch;
5224 }
5225 }
5226 // remove the first pipe
5227 $label = substr( $label, 1 );
5228 }
5229
5230 $ig->add( $title, $label, $alt, $link, $handlerOptions );
5231 }
5232 $html = $ig->toHTML();
5233 wfProfileOut( __METHOD__ );
5234 return $html;
5235 }
5236
5237 /**
5238 * @param $handler
5239 * @return array
5240 */
5241 function getImageParams( $handler ) {
5242 if ( $handler ) {
5243 $handlerClass = get_class( $handler );
5244 } else {
5245 $handlerClass = '';
5246 }
5247 if ( !isset( $this->mImageParams[$handlerClass] ) ) {
5248 # Initialise static lists
5249 static $internalParamNames = array(
5250 'horizAlign' => array( 'left', 'right', 'center', 'none' ),
5251 'vertAlign' => array( 'baseline', 'sub', 'super', 'top', 'text-top', 'middle',
5252 'bottom', 'text-bottom' ),
5253 'frame' => array( 'thumbnail', 'manualthumb', 'framed', 'frameless',
5254 'upright', 'border', 'link', 'alt', 'class' ),
5255 );
5256 static $internalParamMap;
5257 if ( !$internalParamMap ) {
5258 $internalParamMap = array();
5259 foreach ( $internalParamNames as $type => $names ) {
5260 foreach ( $names as $name ) {
5261 $magicName = str_replace( '-', '_', "img_$name" );
5262 $internalParamMap[$magicName] = array( $type, $name );
5263 }
5264 }
5265 }
5266
5267 # Add handler params
5268 $paramMap = $internalParamMap;
5269 if ( $handler ) {
5270 $handlerParamMap = $handler->getParamMap();
5271 foreach ( $handlerParamMap as $magic => $paramName ) {
5272 $paramMap[$magic] = array( 'handler', $paramName );
5273 }
5274 }
5275 $this->mImageParams[$handlerClass] = $paramMap;
5276 $this->mImageParamsMagicArray[$handlerClass] = new MagicWordArray( array_keys( $paramMap ) );
5277 }
5278 return array( $this->mImageParams[$handlerClass], $this->mImageParamsMagicArray[$handlerClass] );
5279 }
5280
5281 /**
5282 * Parse image options text and use it to make an image
5283 *
5284 * @param $title Title
5285 * @param $options String
5286 * @param $holders LinkHolderArray|bool
5287 * @return string HTML
5288 */
5289 function makeImage( $title, $options, $holders = false ) {
5290 # Check if the options text is of the form "options|alt text"
5291 # Options are:
5292 # * thumbnail make a thumbnail with enlarge-icon and caption, alignment depends on lang
5293 # * left no resizing, just left align. label is used for alt= only
5294 # * right same, but right aligned
5295 # * none same, but not aligned
5296 # * ___px scale to ___ pixels width, no aligning. e.g. use in taxobox
5297 # * center center the image
5298 # * frame Keep original image size, no magnify-button.
5299 # * framed Same as "frame"
5300 # * frameless like 'thumb' but without a frame. Keeps user preferences for width
5301 # * upright reduce width for upright images, rounded to full __0 px
5302 # * border draw a 1px border around the image
5303 # * alt Text for HTML alt attribute (defaults to empty)
5304 # * class Set a class for img node
5305 # * link Set the target of the image link. Can be external, interwiki, or local
5306 # vertical-align values (no % or length right now):
5307 # * baseline
5308 # * sub
5309 # * super
5310 # * top
5311 # * text-top
5312 # * middle
5313 # * bottom
5314 # * text-bottom
5315
5316 $parts = StringUtils::explode( "|", $options );
5317
5318 # Give extensions a chance to select the file revision for us
5319 $options = array();
5320 $descQuery = false;
5321 wfRunHooks( 'BeforeParserFetchFileAndTitle',
5322 array( $this, $title, &$options, &$descQuery ) );
5323 # Fetch and register the file (file title may be different via hooks)
5324 list( $file, $title ) = $this->fetchFileAndTitle( $title, $options );
5325
5326 # Get parameter map
5327 $handler = $file ? $file->getHandler() : false;
5328
5329 list( $paramMap, $mwArray ) = $this->getImageParams( $handler );
5330
5331 if ( !$file ) {
5332 $this->addTrackingCategory( 'broken-file-category' );
5333 }
5334
5335 # Process the input parameters
5336 $caption = '';
5337 $params = array( 'frame' => array(), 'handler' => array(),
5338 'horizAlign' => array(), 'vertAlign' => array() );
5339 foreach ( $parts as $part ) {
5340 $part = trim( $part );
5341 list( $magicName, $value ) = $mwArray->matchVariableStartToEnd( $part );
5342 $validated = false;
5343 if ( isset( $paramMap[$magicName] ) ) {
5344 list( $type, $paramName ) = $paramMap[$magicName];
5345
5346 # Special case; width and height come in one variable together
5347 if ( $type === 'handler' && $paramName === 'width' ) {
5348 $parsedWidthParam = $this->parseWidthParam( $value );
5349 if ( isset( $parsedWidthParam['width'] ) ) {
5350 $width = $parsedWidthParam['width'];
5351 if ( $handler->validateParam( 'width', $width ) ) {
5352 $params[$type]['width'] = $width;
5353 $validated = true;
5354 }
5355 }
5356 if ( isset( $parsedWidthParam['height'] ) ) {
5357 $height = $parsedWidthParam['height'];
5358 if ( $handler->validateParam( 'height', $height ) ) {
5359 $params[$type]['height'] = $height;
5360 $validated = true;
5361 }
5362 }
5363 # else no validation -- bug 13436
5364 } else {
5365 if ( $type === 'handler' ) {
5366 # Validate handler parameter
5367 $validated = $handler->validateParam( $paramName, $value );
5368 } else {
5369 # Validate internal parameters
5370 switch ( $paramName ) {
5371 case 'manualthumb':
5372 case 'alt':
5373 case 'class':
5374 # @todo FIXME: Possibly check validity here for
5375 # manualthumb? downstream behavior seems odd with
5376 # missing manual thumbs.
5377 $validated = true;
5378 $value = $this->stripAltText( $value, $holders );
5379 break;
5380 case 'link':
5381 $chars = self::EXT_LINK_URL_CLASS;
5382 $prots = $this->mUrlProtocols;
5383 if ( $value === '' ) {
5384 $paramName = 'no-link';
5385 $value = true;
5386 $validated = true;
5387 } elseif ( preg_match( "/^(?i)$prots/", $value ) ) {
5388 if ( preg_match( "/^((?i)$prots)$chars+$/u", $value, $m ) ) {
5389 $paramName = 'link-url';
5390 $this->mOutput->addExternalLink( $value );
5391 if ( $this->mOptions->getExternalLinkTarget() ) {
5392 $params[$type]['link-target'] = $this->mOptions->getExternalLinkTarget();
5393 }
5394 $validated = true;
5395 }
5396 } else {
5397 $linkTitle = Title::newFromText( $value );
5398 if ( $linkTitle ) {
5399 $paramName = 'link-title';
5400 $value = $linkTitle;
5401 $this->mOutput->addLink( $linkTitle );
5402 $validated = true;
5403 }
5404 }
5405 break;
5406 default:
5407 # Most other things appear to be empty or numeric...
5408 $validated = ( $value === false || is_numeric( trim( $value ) ) );
5409 }
5410 }
5411
5412 if ( $validated ) {
5413 $params[$type][$paramName] = $value;
5414 }
5415 }
5416 }
5417 if ( !$validated ) {
5418 $caption = $part;
5419 }
5420 }
5421
5422 # Process alignment parameters
5423 if ( $params['horizAlign'] ) {
5424 $params['frame']['align'] = key( $params['horizAlign'] );
5425 }
5426 if ( $params['vertAlign'] ) {
5427 $params['frame']['valign'] = key( $params['vertAlign'] );
5428 }
5429
5430 $params['frame']['caption'] = $caption;
5431
5432 # Will the image be presented in a frame, with the caption below?
5433 $imageIsFramed = isset( $params['frame']['frame'] )
5434 || isset( $params['frame']['framed'] )
5435 || isset( $params['frame']['thumbnail'] )
5436 || isset( $params['frame']['manualthumb'] );
5437
5438 # In the old days, [[Image:Foo|text...]] would set alt text. Later it
5439 # came to also set the caption, ordinary text after the image -- which
5440 # makes no sense, because that just repeats the text multiple times in
5441 # screen readers. It *also* came to set the title attribute.
5442 #
5443 # Now that we have an alt attribute, we should not set the alt text to
5444 # equal the caption: that's worse than useless, it just repeats the
5445 # text. This is the framed/thumbnail case. If there's no caption, we
5446 # use the unnamed parameter for alt text as well, just for the time be-
5447 # ing, if the unnamed param is set and the alt param is not.
5448 #
5449 # For the future, we need to figure out if we want to tweak this more,
5450 # e.g., introducing a title= parameter for the title; ignoring the un-
5451 # named parameter entirely for images without a caption; adding an ex-
5452 # plicit caption= parameter and preserving the old magic unnamed para-
5453 # meter for BC; ...
5454 if ( $imageIsFramed ) { # Framed image
5455 if ( $caption === '' && !isset( $params['frame']['alt'] ) ) {
5456 # No caption or alt text, add the filename as the alt text so
5457 # that screen readers at least get some description of the image
5458 $params['frame']['alt'] = $title->getText();
5459 }
5460 # Do not set $params['frame']['title'] because tooltips don't make sense
5461 # for framed images
5462 } else { # Inline image
5463 if ( !isset( $params['frame']['alt'] ) ) {
5464 # No alt text, use the "caption" for the alt text
5465 if ( $caption !== '' ) {
5466 $params['frame']['alt'] = $this->stripAltText( $caption, $holders );
5467 } else {
5468 # No caption, fall back to using the filename for the
5469 # alt text
5470 $params['frame']['alt'] = $title->getText();
5471 }
5472 }
5473 # Use the "caption" for the tooltip text
5474 $params['frame']['title'] = $this->stripAltText( $caption, $holders );
5475 }
5476
5477 wfRunHooks( 'ParserMakeImageParams', array( $title, $file, &$params, $this ) );
5478
5479 # Linker does the rest
5480 $time = isset( $options['time'] ) ? $options['time'] : false;
5481 $ret = Linker::makeImageLink( $this, $title, $file, $params['frame'], $params['handler'],
5482 $time, $descQuery, $this->mOptions->getThumbSize() );
5483
5484 # Give the handler a chance to modify the parser object
5485 if ( $handler ) {
5486 $handler->parserTransformHook( $this, $file );
5487 }
5488
5489 return $ret;
5490 }
5491
5492 /**
5493 * @param $caption
5494 * @param $holders LinkHolderArray
5495 * @return mixed|String
5496 */
5497 protected function stripAltText( $caption, $holders ) {
5498 # Strip bad stuff out of the title (tooltip). We can't just use
5499 # replaceLinkHoldersText() here, because if this function is called
5500 # from replaceInternalLinks2(), mLinkHolders won't be up-to-date.
5501 if ( $holders ) {
5502 $tooltip = $holders->replaceText( $caption );
5503 } else {
5504 $tooltip = $this->replaceLinkHoldersText( $caption );
5505 }
5506
5507 # make sure there are no placeholders in thumbnail attributes
5508 # that are later expanded to html- so expand them now and
5509 # remove the tags
5510 $tooltip = $this->mStripState->unstripBoth( $tooltip );
5511 $tooltip = Sanitizer::stripAllTags( $tooltip );
5512
5513 return $tooltip;
5514 }
5515
5516 /**
5517 * Set a flag in the output object indicating that the content is dynamic and
5518 * shouldn't be cached.
5519 */
5520 function disableCache() {
5521 wfDebug( "Parser output marked as uncacheable.\n" );
5522 if ( !$this->mOutput ) {
5523 throw new MWException( __METHOD__ .
5524 " can only be called when actually parsing something" );
5525 }
5526 $this->mOutput->setCacheTime( -1 ); // old style, for compatibility
5527 $this->mOutput->updateCacheExpiry( 0 ); // new style, for consistency
5528 }
5529
5530 /**
5531 * Callback from the Sanitizer for expanding items found in HTML attribute
5532 * values, so they can be safely tested and escaped.
5533 *
5534 * @param $text String
5535 * @param $frame PPFrame
5536 * @return String
5537 */
5538 function attributeStripCallback( &$text, $frame = false ) {
5539 $text = $this->replaceVariables( $text, $frame );
5540 $text = $this->mStripState->unstripBoth( $text );
5541 return $text;
5542 }
5543
5544 /**
5545 * Accessor
5546 *
5547 * @return array
5548 */
5549 function getTags() {
5550 return array_merge( array_keys( $this->mTransparentTagHooks ), array_keys( $this->mTagHooks ), array_keys( $this->mFunctionTagHooks ) );
5551 }
5552
5553 /**
5554 * Replace transparent tags in $text with the values given by the callbacks.
5555 *
5556 * Transparent tag hooks are like regular XML-style tag hooks, except they
5557 * operate late in the transformation sequence, on HTML instead of wikitext.
5558 *
5559 * @param $text string
5560 *
5561 * @return string
5562 */
5563 function replaceTransparentTags( $text ) {
5564 $matches = array();
5565 $elements = array_keys( $this->mTransparentTagHooks );
5566 $text = self::extractTagsAndParams( $elements, $text, $matches, $this->mUniqPrefix );
5567 $replacements = array();
5568
5569 foreach ( $matches as $marker => $data ) {
5570 list( $element, $content, $params, $tag ) = $data;
5571 $tagName = strtolower( $element );
5572 if ( isset( $this->mTransparentTagHooks[$tagName] ) ) {
5573 $output = call_user_func_array( $this->mTransparentTagHooks[$tagName], array( $content, $params, $this ) );
5574 } else {
5575 $output = $tag;
5576 }
5577 $replacements[$marker] = $output;
5578 }
5579 return strtr( $text, $replacements );
5580 }
5581
5582 /**
5583 * Break wikitext input into sections, and either pull or replace
5584 * some particular section's text.
5585 *
5586 * External callers should use the getSection and replaceSection methods.
5587 *
5588 * @param string $text Page wikitext
5589 * @param string $section a section identifier string of the form:
5590 * "<flag1> - <flag2> - ... - <section number>"
5591 *
5592 * Currently the only recognised flag is "T", which means the target section number
5593 * was derived during a template inclusion parse, in other words this is a template
5594 * section edit link. If no flags are given, it was an ordinary section edit link.
5595 * This flag is required to avoid a section numbering mismatch when a section is
5596 * enclosed by "<includeonly>" (bug 6563).
5597 *
5598 * The section number 0 pulls the text before the first heading; other numbers will
5599 * pull the given section along with its lower-level subsections. If the section is
5600 * not found, $mode=get will return $newtext, and $mode=replace will return $text.
5601 *
5602 * Section 0 is always considered to exist, even if it only contains the empty
5603 * string. If $text is the empty string and section 0 is replaced, $newText is
5604 * returned.
5605 *
5606 * @param string $mode one of "get" or "replace"
5607 * @param string $newText replacement text for section data.
5608 * @return String: for "get", the extracted section text.
5609 * for "replace", the whole page with the section replaced.
5610 */
5611 private function extractSections( $text, $section, $mode, $newText = '' ) {
5612 global $wgTitle; # not generally used but removes an ugly failure mode
5613 $this->startParse( $wgTitle, new ParserOptions, self::OT_PLAIN, true );
5614 $outText = '';
5615 $frame = $this->getPreprocessor()->newFrame();
5616
5617 # Process section extraction flags
5618 $flags = 0;
5619 $sectionParts = explode( '-', $section );
5620 $sectionIndex = array_pop( $sectionParts );
5621 foreach ( $sectionParts as $part ) {
5622 if ( $part === 'T' ) {
5623 $flags |= self::PTD_FOR_INCLUSION;
5624 }
5625 }
5626
5627 # Check for empty input
5628 if ( strval( $text ) === '' ) {
5629 # Only sections 0 and T-0 exist in an empty document
5630 if ( $sectionIndex == 0 ) {
5631 if ( $mode === 'get' ) {
5632 return '';
5633 } else {
5634 return $newText;
5635 }
5636 } else {
5637 if ( $mode === 'get' ) {
5638 return $newText;
5639 } else {
5640 return $text;
5641 }
5642 }
5643 }
5644
5645 # Preprocess the text
5646 $root = $this->preprocessToDom( $text, $flags );
5647
5648 # <h> nodes indicate section breaks
5649 # They can only occur at the top level, so we can find them by iterating the root's children
5650 $node = $root->getFirstChild();
5651
5652 # Find the target section
5653 if ( $sectionIndex == 0 ) {
5654 # Section zero doesn't nest, level=big
5655 $targetLevel = 1000;
5656 } else {
5657 while ( $node ) {
5658 if ( $node->getName() === 'h' ) {
5659 $bits = $node->splitHeading();
5660 if ( $bits['i'] == $sectionIndex ) {
5661 $targetLevel = $bits['level'];
5662 break;
5663 }
5664 }
5665 if ( $mode === 'replace' ) {
5666 $outText .= $frame->expand( $node, PPFrame::RECOVER_ORIG );
5667 }
5668 $node = $node->getNextSibling();
5669 }
5670 }
5671
5672 if ( !$node ) {
5673 # Not found
5674 if ( $mode === 'get' ) {
5675 return $newText;
5676 } else {
5677 return $text;
5678 }
5679 }
5680
5681 # Find the end of the section, including nested sections
5682 do {
5683 if ( $node->getName() === 'h' ) {
5684 $bits = $node->splitHeading();
5685 $curLevel = $bits['level'];
5686 if ( $bits['i'] != $sectionIndex && $curLevel <= $targetLevel ) {
5687 break;
5688 }
5689 }
5690 if ( $mode === 'get' ) {
5691 $outText .= $frame->expand( $node, PPFrame::RECOVER_ORIG );
5692 }
5693 $node = $node->getNextSibling();
5694 } while ( $node );
5695
5696 # Write out the remainder (in replace mode only)
5697 if ( $mode === 'replace' ) {
5698 # Output the replacement text
5699 # Add two newlines on -- trailing whitespace in $newText is conventionally
5700 # stripped by the editor, so we need both newlines to restore the paragraph gap
5701 # Only add trailing whitespace if there is newText
5702 if ( $newText != "" ) {
5703 $outText .= $newText . "\n\n";
5704 }
5705
5706 while ( $node ) {
5707 $outText .= $frame->expand( $node, PPFrame::RECOVER_ORIG );
5708 $node = $node->getNextSibling();
5709 }
5710 }
5711
5712 if ( is_string( $outText ) ) {
5713 # Re-insert stripped tags
5714 $outText = rtrim( $this->mStripState->unstripBoth( $outText ) );
5715 }
5716
5717 return $outText;
5718 }
5719
5720 /**
5721 * This function returns the text of a section, specified by a number ($section).
5722 * A section is text under a heading like == Heading == or \<h1\>Heading\</h1\>, or
5723 * the first section before any such heading (section 0).
5724 *
5725 * If a section contains subsections, these are also returned.
5726 *
5727 * @param string $text text to look in
5728 * @param string $section section identifier
5729 * @param string $deftext default to return if section is not found
5730 * @return string text of the requested section
5731 */
5732 public function getSection( $text, $section, $deftext = '' ) {
5733 return $this->extractSections( $text, $section, "get", $deftext );
5734 }
5735
5736 /**
5737 * This function returns $oldtext after the content of the section
5738 * specified by $section has been replaced with $text. If the target
5739 * section does not exist, $oldtext is returned unchanged.
5740 *
5741 * @param string $oldtext former text of the article
5742 * @param int $section section identifier
5743 * @param string $text replacing text
5744 * @return String: modified text
5745 */
5746 public function replaceSection( $oldtext, $section, $text ) {
5747 return $this->extractSections( $oldtext, $section, "replace", $text );
5748 }
5749
5750 /**
5751 * Get the ID of the revision we are parsing
5752 *
5753 * @return Mixed: integer or null
5754 */
5755 function getRevisionId() {
5756 return $this->mRevisionId;
5757 }
5758
5759 /**
5760 * Get the revision object for $this->mRevisionId
5761 *
5762 * @return Revision|null either a Revision object or null
5763 * @since 1.23 (public since 1.23)
5764 */
5765 public function getRevisionObject() {
5766 if ( !is_null( $this->mRevisionObject ) ) {
5767 return $this->mRevisionObject;
5768 }
5769 if ( is_null( $this->mRevisionId ) ) {
5770 return null;
5771 }
5772
5773 $this->mRevisionObject = Revision::newFromId( $this->mRevisionId );
5774 return $this->mRevisionObject;
5775 }
5776
5777 /**
5778 * Get the timestamp associated with the current revision, adjusted for
5779 * the default server-local timestamp
5780 */
5781 function getRevisionTimestamp() {
5782 if ( is_null( $this->mRevisionTimestamp ) ) {
5783 wfProfileIn( __METHOD__ );
5784
5785 global $wgContLang;
5786
5787 $revObject = $this->getRevisionObject();
5788 $timestamp = $revObject ? $revObject->getTimestamp() : wfTimestampNow();
5789
5790 # The cryptic '' timezone parameter tells to use the site-default
5791 # timezone offset instead of the user settings.
5792 #
5793 # Since this value will be saved into the parser cache, served
5794 # to other users, and potentially even used inside links and such,
5795 # it needs to be consistent for all visitors.
5796 $this->mRevisionTimestamp = $wgContLang->userAdjust( $timestamp, '' );
5797
5798 wfProfileOut( __METHOD__ );
5799 }
5800 return $this->mRevisionTimestamp;
5801 }
5802
5803 /**
5804 * Get the name of the user that edited the last revision
5805 *
5806 * @return String: user name
5807 */
5808 function getRevisionUser() {
5809 if ( is_null( $this->mRevisionUser ) ) {
5810 $revObject = $this->getRevisionObject();
5811
5812 # if this template is subst: the revision id will be blank,
5813 # so just use the current user's name
5814 if ( $revObject ) {
5815 $this->mRevisionUser = $revObject->getUserText();
5816 } elseif ( $this->ot['wiki'] || $this->mOptions->getIsPreview() ) {
5817 $this->mRevisionUser = $this->getUser()->getName();
5818 }
5819 }
5820 return $this->mRevisionUser;
5821 }
5822
5823 /**
5824 * Get the size of the revision
5825 *
5826 * @return int|null revision size
5827 */
5828 function getRevisionSize() {
5829 if ( is_null( $this->mRevisionSize ) ) {
5830 $revObject = $this->getRevisionObject();
5831
5832 # if this variable is subst: the revision id will be blank,
5833 # so just use the parser input size, because the own substituation
5834 # will change the size.
5835 if ( $revObject ) {
5836 $this->mRevisionSize = $revObject->getSize();
5837 } elseif ( $this->ot['wiki'] || $this->mOptions->getIsPreview() ) {
5838 $this->mRevisionSize = $this->mInputSize;
5839 }
5840 }
5841 return $this->mRevisionSize;
5842 }
5843
5844 /**
5845 * Mutator for $mDefaultSort
5846 *
5847 * @param string $sort New value
5848 */
5849 public function setDefaultSort( $sort ) {
5850 $this->mDefaultSort = $sort;
5851 $this->mOutput->setProperty( 'defaultsort', $sort );
5852 }
5853
5854 /**
5855 * Accessor for $mDefaultSort
5856 * Will use the empty string if none is set.
5857 *
5858 * This value is treated as a prefix, so the
5859 * empty string is equivalent to sorting by
5860 * page name.
5861 *
5862 * @return string
5863 */
5864 public function getDefaultSort() {
5865 if ( $this->mDefaultSort !== false ) {
5866 return $this->mDefaultSort;
5867 } else {
5868 return '';
5869 }
5870 }
5871
5872 /**
5873 * Accessor for $mDefaultSort
5874 * Unlike getDefaultSort(), will return false if none is set
5875 *
5876 * @return string or false
5877 */
5878 public function getCustomDefaultSort() {
5879 return $this->mDefaultSort;
5880 }
5881
5882 /**
5883 * Try to guess the section anchor name based on a wikitext fragment
5884 * presumably extracted from a heading, for example "Header" from
5885 * "== Header ==".
5886 *
5887 * @param $text string
5888 *
5889 * @return string
5890 */
5891 public function guessSectionNameFromWikiText( $text ) {
5892 # Strip out wikitext links(they break the anchor)
5893 $text = $this->stripSectionName( $text );
5894 $text = Sanitizer::normalizeSectionNameWhitespace( $text );
5895 return '#' . Sanitizer::escapeId( $text, 'noninitial' );
5896 }
5897
5898 /**
5899 * Same as guessSectionNameFromWikiText(), but produces legacy anchors
5900 * instead. For use in redirects, since IE6 interprets Redirect: headers
5901 * as something other than UTF-8 (apparently?), resulting in breakage.
5902 *
5903 * @param string $text The section name
5904 * @return string An anchor
5905 */
5906 public function guessLegacySectionNameFromWikiText( $text ) {
5907 # Strip out wikitext links(they break the anchor)
5908 $text = $this->stripSectionName( $text );
5909 $text = Sanitizer::normalizeSectionNameWhitespace( $text );
5910 return '#' . Sanitizer::escapeId( $text, array( 'noninitial', 'legacy' ) );
5911 }
5912
5913 /**
5914 * Strips a text string of wikitext for use in a section anchor
5915 *
5916 * Accepts a text string and then removes all wikitext from the
5917 * string and leaves only the resultant text (i.e. the result of
5918 * [[User:WikiSysop|Sysop]] would be "Sysop" and the result of
5919 * [[User:WikiSysop]] would be "User:WikiSysop") - this is intended
5920 * to create valid section anchors by mimicing the output of the
5921 * parser when headings are parsed.
5922 *
5923 * @param string $text text string to be stripped of wikitext
5924 * for use in a Section anchor
5925 * @return string Filtered text string
5926 */
5927 public function stripSectionName( $text ) {
5928 # Strip internal link markup
5929 $text = preg_replace( '/\[\[:?([^[|]+)\|([^[]+)\]\]/', '$2', $text );
5930 $text = preg_replace( '/\[\[:?([^[]+)\|?\]\]/', '$1', $text );
5931
5932 # Strip external link markup
5933 # @todo FIXME: Not tolerant to blank link text
5934 # I.E. [http://www.mediawiki.org] will render as [1] or something depending
5935 # on how many empty links there are on the page - need to figure that out.
5936 $text = preg_replace( '/\[(?i:' . $this->mUrlProtocols . ')([^ ]+?) ([^[]+)\]/', '$2', $text );
5937
5938 # Parse wikitext quotes (italics & bold)
5939 $text = $this->doQuotes( $text );
5940
5941 # Strip HTML tags
5942 $text = StringUtils::delimiterReplace( '<', '>', '', $text );
5943 return $text;
5944 }
5945
5946 /**
5947 * strip/replaceVariables/unstrip for preprocessor regression testing
5948 *
5949 * @param $text string
5950 * @param $title Title
5951 * @param $options ParserOptions
5952 * @param $outputType int
5953 *
5954 * @return string
5955 */
5956 function testSrvus( $text, Title $title, ParserOptions $options, $outputType = self::OT_HTML ) {
5957 $this->startParse( $title, $options, $outputType, true );
5958
5959 $text = $this->replaceVariables( $text );
5960 $text = $this->mStripState->unstripBoth( $text );
5961 $text = Sanitizer::removeHTMLtags( $text );
5962 return $text;
5963 }
5964
5965 /**
5966 * @param $text string
5967 * @param $title Title
5968 * @param $options ParserOptions
5969 * @return string
5970 */
5971 function testPst( $text, Title $title, ParserOptions $options ) {
5972 return $this->preSaveTransform( $text, $title, $options->getUser(), $options );
5973 }
5974
5975 /**
5976 * @param $text
5977 * @param $title Title
5978 * @param $options ParserOptions
5979 * @return string
5980 */
5981 function testPreprocess( $text, Title $title, ParserOptions $options ) {
5982 return $this->testSrvus( $text, $title, $options, self::OT_PREPROCESS );
5983 }
5984
5985 /**
5986 * Call a callback function on all regions of the given text that are not
5987 * inside strip markers, and replace those regions with the return value
5988 * of the callback. For example, with input:
5989 *
5990 * aaa<MARKER>bbb
5991 *
5992 * This will call the callback function twice, with 'aaa' and 'bbb'. Those
5993 * two strings will be replaced with the value returned by the callback in
5994 * each case.
5995 *
5996 * @param $s string
5997 * @param $callback
5998 *
5999 * @return string
6000 */
6001 function markerSkipCallback( $s, $callback ) {
6002 $i = 0;
6003 $out = '';
6004 while ( $i < strlen( $s ) ) {
6005 $markerStart = strpos( $s, $this->mUniqPrefix, $i );
6006 if ( $markerStart === false ) {
6007 $out .= call_user_func( $callback, substr( $s, $i ) );
6008 break;
6009 } else {
6010 $out .= call_user_func( $callback, substr( $s, $i, $markerStart - $i ) );
6011 $markerEnd = strpos( $s, self::MARKER_SUFFIX, $markerStart );
6012 if ( $markerEnd === false ) {
6013 $out .= substr( $s, $markerStart );
6014 break;
6015 } else {
6016 $markerEnd += strlen( self::MARKER_SUFFIX );
6017 $out .= substr( $s, $markerStart, $markerEnd - $markerStart );
6018 $i = $markerEnd;
6019 }
6020 }
6021 }
6022 return $out;
6023 }
6024
6025 /**
6026 * Remove any strip markers found in the given text.
6027 *
6028 * @param $text Input string
6029 * @return string
6030 */
6031 function killMarkers( $text ) {
6032 return $this->mStripState->killMarkers( $text );
6033 }
6034
6035 /**
6036 * Save the parser state required to convert the given half-parsed text to
6037 * HTML. "Half-parsed" in this context means the output of
6038 * recursiveTagParse() or internalParse(). This output has strip markers
6039 * from replaceVariables (extensionSubstitution() etc.), and link
6040 * placeholders from replaceLinkHolders().
6041 *
6042 * Returns an array which can be serialized and stored persistently. This
6043 * array can later be loaded into another parser instance with
6044 * unserializeHalfParsedText(). The text can then be safely incorporated into
6045 * the return value of a parser hook.
6046 *
6047 * @param $text string
6048 *
6049 * @return array
6050 */
6051 function serializeHalfParsedText( $text ) {
6052 wfProfileIn( __METHOD__ );
6053 $data = array(
6054 'text' => $text,
6055 'version' => self::HALF_PARSED_VERSION,
6056 'stripState' => $this->mStripState->getSubState( $text ),
6057 'linkHolders' => $this->mLinkHolders->getSubArray( $text )
6058 );
6059 wfProfileOut( __METHOD__ );
6060 return $data;
6061 }
6062
6063 /**
6064 * Load the parser state given in the $data array, which is assumed to
6065 * have been generated by serializeHalfParsedText(). The text contents is
6066 * extracted from the array, and its markers are transformed into markers
6067 * appropriate for the current Parser instance. This transformed text is
6068 * returned, and can be safely included in the return value of a parser
6069 * hook.
6070 *
6071 * If the $data array has been stored persistently, the caller should first
6072 * check whether it is still valid, by calling isValidHalfParsedText().
6073 *
6074 * @param array $data Serialized data
6075 * @throws MWException
6076 * @return String
6077 */
6078 function unserializeHalfParsedText( $data ) {
6079 if ( !isset( $data['version'] ) || $data['version'] != self::HALF_PARSED_VERSION ) {
6080 throw new MWException( __METHOD__ . ': invalid version' );
6081 }
6082
6083 # First, extract the strip state.
6084 $texts = array( $data['text'] );
6085 $texts = $this->mStripState->merge( $data['stripState'], $texts );
6086
6087 # Now renumber links
6088 $texts = $this->mLinkHolders->mergeForeign( $data['linkHolders'], $texts );
6089
6090 # Should be good to go.
6091 return $texts[0];
6092 }
6093
6094 /**
6095 * Returns true if the given array, presumed to be generated by
6096 * serializeHalfParsedText(), is compatible with the current version of the
6097 * parser.
6098 *
6099 * @param $data Array
6100 *
6101 * @return bool
6102 */
6103 function isValidHalfParsedText( $data ) {
6104 return isset( $data['version'] ) && $data['version'] == self::HALF_PARSED_VERSION;
6105 }
6106
6107 /**
6108 * Parsed a width param of imagelink like 300px or 200x300px
6109 *
6110 * @param $value String
6111 *
6112 * @return array
6113 * @since 1.20
6114 */
6115 public function parseWidthParam( $value ) {
6116 $parsedWidthParam = array();
6117 if ( $value === '' ) {
6118 return $parsedWidthParam;
6119 }
6120 $m = array();
6121 # (bug 13500) In both cases (width/height and width only),
6122 # permit trailing "px" for backward compatibility.
6123 if ( preg_match( '/^([0-9]*)x([0-9]*)\s*(?:px)?\s*$/', $value, $m ) ) {
6124 $width = intval( $m[1] );
6125 $height = intval( $m[2] );
6126 $parsedWidthParam['width'] = $width;
6127 $parsedWidthParam['height'] = $height;
6128 } elseif ( preg_match( '/^[0-9]*\s*(?:px)?\s*$/', $value ) ) {
6129 $width = intval( $value );
6130 $parsedWidthParam['width'] = $width;
6131 }
6132 return $parsedWidthParam;
6133 }
6134 }
Wiklou, le Wiki du Wiklou