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