-
Notifications
You must be signed in to change notification settings - Fork 1.4k
/
Parser.php
6467 lines (5887 loc) · 199 KB
/
Parser.php
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
<?php
/**
* PHP parser that converts wiki markup to HTML.
*
* This program is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation; either version 2 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License along
* with this program; if not, write to the Free Software Foundation, Inc.,
* 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
* http://www.gnu.org/copyleft/gpl.html
*
* @file
* @ingroup Parser
*/
/**
* @defgroup Parser Parser
*/
/**
* PHP Parser - Processes wiki markup (which uses a more user-friendly
* syntax, such as "[[link]]" for making links), and provides a one-way
* transformation of that wiki markup it into (X)HTML output / markup
* (which in turn the browser understands, and can display).
*
* There are seven main entry points into the Parser class:
*
* - Parser::parse()
* produces HTML output
* - Parser::preSaveTransform()
* produces altered wiki markup
* - Parser::preprocess()
* removes HTML comments and expands templates
* - Parser::cleanSig() and Parser::cleanSigInSig()
* cleans a signature before saving it to preferences
* - Parser::getSection()
* return the content of a section from an article for section editing
* - Parser::replaceSection()
* replaces a section by number inside an article
* - Parser::getPreloadText()
* removes <noinclude> sections and <includeonly> tags
*
* Globals used:
* object: $wgContLang
*
* @warning $wgUser or $wgTitle or $wgRequest or $wgLang. Keep them away!
*
* @par Settings:
* $wgNamespacesWithSubpages
*
* @par Settings only within ParserOptions:
* $wgAllowExternalImages
* $wgAllowSpecialInclusion
* $wgInterwikiMagic
* $wgMaxArticleSize
*
* @ingroup Parser
*/
class Parser {
/**
* Update this version number when the ParserOutput format
* changes in an incompatible way, so the parser cache
* can automatically discard old data.
*/
const VERSION = '1.6.4';
/**
* Update this version number when the output of serialiseHalfParsedText()
* changes in an incompatible way
*/
const HALF_PARSED_VERSION = 2;
# Flags for Parser::setFunctionHook
const SFH_NO_HASH = 1;
const SFH_OBJECT_ARGS = 2;
# Constants needed for external link processing
# Everything except bracket, space, or control characters
# \p{Zs} is unicode 'separator, space' category. It covers the space 0x20
# as well as U+3000 is IDEOGRAPHIC SPACE for bug 19052
const EXT_LINK_URL_CLASS = '[^][<>"\\x00-\\x20\\x7F\p{Zs}]';
# Simplified expression to match an IPv4 or IPv6 address, or
# at least one character of a host name (embeds EXT_LINK_URL_CLASS)
const EXT_LINK_ADDR = '(?:[0-9.]+|\\[(?i:[0-9a-f:.]+)\\]|[^][<>"\\x00-\\x20\\x7F\p{Zs}])';
# RegExp to make image URLs (embeds IPv6 part of EXT_LINK_ADDR)
// @codingStandardsIgnoreStart Generic.Files.LineLength
const EXT_IMAGE_REGEX = '/^(http:\/\/|https:\/\/)((?:\\[(?i:[0-9a-f:.]+)\\])?[^][<>"\\x00-\\x20\\x7F\p{Zs}]+)
\\/([A-Za-z0-9_.,~%\\-+&;#*?!=()@\\x80-\\xFF]+)\\.((?i)gif|png|jpg|jpeg)$/Sxu';
// @codingStandardsIgnoreEnd
# Regular expression for a non-newline space
const SPACE_NOT_NL = '(?:\t| |&\#0*160;|&\#[Xx]0*[Aa]0;|\p{Zs})';
# State constants for the definition list colon extraction
const COLON_STATE_TEXT = 0;
const COLON_STATE_TAG = 1;
const COLON_STATE_TAGSTART = 2;
const COLON_STATE_CLOSETAG = 3;
const COLON_STATE_TAGSLASH = 4;
const COLON_STATE_COMMENT = 5;
const COLON_STATE_COMMENTDASH = 6;
const COLON_STATE_COMMENTDASHDASH = 7;
# Flags for preprocessToDom
const PTD_FOR_INCLUSION = 1;
# Allowed values for $this->mOutputType
# Parameter to startExternalParse().
const OT_HTML = 1; # like parse()
const OT_WIKI = 2; # like preSaveTransform()
const OT_PREPROCESS = 3; # like preprocess()
const OT_MSG = 3;
const OT_PLAIN = 4; # like extractSections() - portions of the original are returned unchanged.
/**
* @var string Prefix and suffix for temporary replacement strings
* for the multipass parser.
*
* \x7f should never appear in input as it's disallowed in XML.
* Using it at the front also gives us a little extra robustness
* since it shouldn't match when butted up against identifier-like
* string constructs.
*
* Must not consist of all title characters, or else it will change
* the behavior of <nowiki> in a link.
*/
const MARKER_SUFFIX = "-QINU\x7f";
const MARKER_PREFIX = "\x7fUNIQ-";
# Markers used for wrapping the table of contents
const TOC_START = '<mw:toc>';
const TOC_END = '</mw:toc>';
# Persistent:
public $mTagHooks = [];
public $mTransparentTagHooks = [];
public $mFunctionHooks = [];
public $mFunctionSynonyms = [ 0 => [], 1 => [] ];
public $mFunctionTagHooks = [];
public $mStripList = [];
public $mDefaultStripList = [];
public $mVarCache = [];
public $mImageParams = [];
public $mImageParamsMagicArray = [];
public $mMarkerIndex = 0;
public $mFirstCall = true;
# Initialised by initialiseVariables()
/**
* @var MagicWordArray
*/
public $mVariables;
/**
* @var MagicWordArray
*/
public $mSubstWords;
# Initialised in constructor
public $mConf, $mExtLinkBracketedRegex, $mUrlProtocols;
# Initialized in getPreprocessor()
/** @var Preprocessor */
public $mPreprocessor;
# Cleared with clearState():
/**
* @var ParserOutput
*/
public $mOutput;
public $mAutonumber, $mDTopen;
/**
* @var StripState
*/
public $mStripState;
public $mIncludeCount, $mArgStack, $mLastSection, $mInPre;
/**
* @var LinkHolderArray
*/
public $mLinkHolders;
public $mLinkID;
public $mIncludeSizes, $mPPNodeCount, $mGeneratedPPNodeCount, $mHighestExpansionDepth;
public $mDefaultSort;
public $mTplRedirCache, $mTplDomCache, $mHeadings, $mDoubleUnderscores;
public $mExpensiveFunctionCount; # number of expensive parser function calls
public $mShowToc, $mForceTocPosition;
/**
* @var User
*/
public $mUser; # User object; only used when doing pre-save transform
# Temporary
# These are variables reset at least once per parse regardless of $clearState
/**
* @var ParserOptions
*/
public $mOptions;
/**
* @var Title
*/
public $mTitle; # Title context, used for self-link rendering and similar things
public $mOutputType; # Output type, one of the OT_xxx constants
public $ot; # Shortcut alias, see setOutputType()
public $mRevisionObject; # The revision object of the specified revision ID
public $mRevisionId; # ID to display in {{REVISIONID}} tags
public $mRevisionTimestamp; # The timestamp of the specified revision ID
public $mRevisionUser; # User to display in {{REVISIONUSER}} tag
public $mRevisionSize; # Size to display in {{REVISIONSIZE}} variable
public $mRevIdForTs; # The revision ID which was used to fetch the timestamp
public $mInputSize = false; # For {{PAGESIZE}} on current page.
/**
* @var string Deprecated accessor for the strip marker prefix.
* @deprecated since 1.26; use Parser::MARKER_PREFIX instead.
**/
public $mUniqPrefix = Parser::MARKER_PREFIX;
/**
* @var array Array with the language name of each language link (i.e. the
* interwiki prefix) in the key, value arbitrary. Used to avoid sending
* duplicate language links to the ParserOutput.
*/
public $mLangLinkLanguages;
/**
* @var MapCacheLRU|null
* @since 1.24
*
* A cache of the current revisions of titles. Keys are $title->getPrefixedDbKey()
*/
public $currentRevisionCache;
/**
* @var bool Recursive call protection.
* This variable should be treated as if it were private.
*/
public $mInParse = false;
/** @var SectionProfiler */
protected $mProfiler;
/**
* @param array $conf
*/
public function __construct( $conf = [] ) {
$this->mConf = $conf;
$this->mUrlProtocols = wfUrlProtocols();
$this->mExtLinkBracketedRegex = '/\[(((?i)' . $this->mUrlProtocols . ')' .
self::EXT_LINK_ADDR .
self::EXT_LINK_URL_CLASS . '*)\p{Zs}*([^\]\\x00-\\x08\\x0a-\\x1F]*?)\]/Su';
if ( isset( $conf['preprocessorClass'] ) ) {
$this->mPreprocessorClass = $conf['preprocessorClass'];
} elseif ( defined( 'HPHP_VERSION' ) ) {
# Preprocessor_Hash is much faster than Preprocessor_DOM under HipHop
$this->mPreprocessorClass = 'Preprocessor_Hash';
} elseif ( extension_loaded( 'domxml' ) ) {
# PECL extension that conflicts with the core DOM extension (bug 13770)
wfDebug( "Warning: you have the obsolete domxml extension for PHP. Please remove it!\n" );
$this->mPreprocessorClass = 'Preprocessor_Hash';
} elseif ( extension_loaded( 'dom' ) ) {
$this->mPreprocessorClass = 'Preprocessor_DOM';
} else {
$this->mPreprocessorClass = 'Preprocessor_Hash';
}
wfDebug( __CLASS__ . ": using preprocessor: {$this->mPreprocessorClass}\n" );
}
/**
* Reduce memory usage to reduce the impact of circular references
*/
public function __destruct() {
if ( isset( $this->mLinkHolders ) ) {
unset( $this->mLinkHolders );
}
foreach ( $this as $name => $value ) {
unset( $this->$name );
}
}
/**
* Allow extensions to clean up when the parser is cloned
*/
public function __clone() {
$this->mInParse = false;
// Bug 56226: When you create a reference "to" an object field, that
// makes the object field itself be a reference too (until the other
// reference goes out of scope). When cloning, any field that's a
// reference is copied as a reference in the new object. Both of these
// are defined PHP5 behaviors, as inconvenient as it is for us when old
// hooks from PHP4 days are passing fields by reference.
foreach ( [ 'mStripState', 'mVarCache' ] as $k ) {
// Make a non-reference copy of the field, then rebind the field to
// reference the new copy.
$tmp = $this->$k;
$this->$k =& $tmp;
unset( $tmp );
}
Hooks::run( 'ParserCloned', [ $this ] );
}
/**
* Do various kinds of initialisation on the first call of the parser
*/
public function firstCallInit() {
if ( !$this->mFirstCall ) {
return;
}
$this->mFirstCall = false;
CoreParserFunctions::register( $this );
CoreTagHooks::register( $this );
$this->initialiseVariables();
Hooks::run( 'ParserFirstCallInit', [ &$this ] );
}
/**
* Clear Parser state
*
* @private
*/
public function clearState() {
if ( $this->mFirstCall ) {
$this->firstCallInit();
}
$this->mOutput = new ParserOutput;
$this->mOptions->registerWatcher( [ $this->mOutput, 'recordOption' ] );
$this->mAutonumber = 0;
$this->mLastSection = '';
$this->mDTopen = false;
$this->mIncludeCount = [];
$this->mArgStack = false;
$this->mInPre = false;
$this->mLinkHolders = new LinkHolderArray( $this );
$this->mLinkID = 0;
$this->mRevisionObject = $this->mRevisionTimestamp =
$this->mRevisionId = $this->mRevisionUser = $this->mRevisionSize = null;
$this->mVarCache = [];
$this->mUser = null;
$this->mLangLinkLanguages = [];
$this->currentRevisionCache = null;
$this->mStripState = new StripState;
# Clear these on every parse, bug 4549
$this->mTplRedirCache = $this->mTplDomCache = [];
$this->mShowToc = true;
$this->mForceTocPosition = false;
$this->mIncludeSizes = [
'post-expand' => 0,
'arg' => 0,
];
$this->mPPNodeCount = 0;
$this->mGeneratedPPNodeCount = 0;
$this->mHighestExpansionDepth = 0;
$this->mDefaultSort = false;
$this->mHeadings = [];
$this->mDoubleUnderscores = [];
$this->mExpensiveFunctionCount = 0;
# Fix cloning
if ( isset( $this->mPreprocessor ) && $this->mPreprocessor->parser !== $this ) {
$this->mPreprocessor = null;
}
$this->mProfiler = new SectionProfiler();
Hooks::run( 'ParserClearState', [ &$this ] );
}
/**
* Convert wikitext to HTML
* Do not call this function recursively.
*
* @param string $text Text we want to parse
* @param Title $title
* @param ParserOptions $options
* @param bool $linestart
* @param bool $clearState
* @param int $revid Number to pass in {{REVISIONID}}
* @return ParserOutput A ParserOutput
*/
public function parse( $text, Title $title, ParserOptions $options,
$linestart = true, $clearState = true, $revid = null
) {
/**
* First pass--just handle <nowiki> sections, pass the rest off
* to internalParse() which does all the real work.
*/
global $wgShowHostnames;
if ( $clearState ) {
// We use U+007F DELETE to construct strip markers, so we have to make
// sure that this character does not occur in the input text.
$text = strtr( $text, "\x7f", "?" );
$magicScopeVariable = $this->lock();
}
$this->startParse( $title, $options, self::OT_HTML, $clearState );
$this->currentRevisionCache = null;
$this->mInputSize = strlen( $text );
if ( $this->mOptions->getEnableLimitReport() ) {
$this->mOutput->resetParseStartTime();
}
$oldRevisionId = $this->mRevisionId;
$oldRevisionObject = $this->mRevisionObject;
$oldRevisionTimestamp = $this->mRevisionTimestamp;
$oldRevisionUser = $this->mRevisionUser;
$oldRevisionSize = $this->mRevisionSize;
if ( $revid !== null ) {
$this->mRevisionId = $revid;
$this->mRevisionObject = null;
$this->mRevisionTimestamp = null;
$this->mRevisionUser = null;
$this->mRevisionSize = null;
}
Hooks::run( 'ParserBeforeStrip', [ &$this, &$text, &$this->mStripState ] );
# No more strip!
Hooks::run( 'ParserAfterStrip', [ &$this, &$text, &$this->mStripState ] );
$text = $this->internalParse( $text );
Hooks::run( 'ParserAfterParse', [ &$this, &$text, &$this->mStripState ] );
$text = $this->internalParseHalfParsed( $text, true, $linestart );
/**
* A converted title will be provided in the output object if title and
* content conversion are enabled, the article text does not contain
* a conversion-suppressing double-underscore tag, and no
* {{DISPLAYTITLE:...}} is present. DISPLAYTITLE takes precedence over
* automatic link conversion.
*/
if ( !( $options->getDisableTitleConversion()
|| isset( $this->mDoubleUnderscores['nocontentconvert'] )
|| isset( $this->mDoubleUnderscores['notitleconvert'] )
|| $this->mOutput->getDisplayTitle() !== false )
) {
$convruletitle = $this->getConverterLanguage()->getConvRuleTitle();
if ( $convruletitle ) {
$this->mOutput->setTitleText( $convruletitle );
} else {
$titleText = $this->getConverterLanguage()->convertTitle( $title );
$this->mOutput->setTitleText( $titleText );
}
}
if ( $this->mExpensiveFunctionCount > $this->mOptions->getExpensiveParserFunctionLimit() ) {
$this->limitationWarn( 'expensive-parserfunction',
$this->mExpensiveFunctionCount,
$this->mOptions->getExpensiveParserFunctionLimit()
);
}
# Information on include size limits, for the benefit of users who try to skirt them
if ( $this->mOptions->getEnableLimitReport() ) {
$max = $this->mOptions->getMaxIncludeSize();
$cpuTime = $this->mOutput->getTimeSinceStart( 'cpu' );
if ( $cpuTime !== null ) {
$this->mOutput->setLimitReportData( 'limitreport-cputime',
sprintf( "%.3f", $cpuTime )
);
}
$wallTime = $this->mOutput->getTimeSinceStart( 'wall' );
$this->mOutput->setLimitReportData( 'limitreport-walltime',
sprintf( "%.3f", $wallTime )
);
$this->mOutput->setLimitReportData( 'limitreport-ppvisitednodes',
[ $this->mPPNodeCount, $this->mOptions->getMaxPPNodeCount() ]
);
$this->mOutput->setLimitReportData( 'limitreport-ppgeneratednodes',
[ $this->mGeneratedPPNodeCount, $this->mOptions->getMaxGeneratedPPNodeCount() ]
);
$this->mOutput->setLimitReportData( 'limitreport-postexpandincludesize',
[ $this->mIncludeSizes['post-expand'], $max ]
);
$this->mOutput->setLimitReportData( 'limitreport-templateargumentsize',
[ $this->mIncludeSizes['arg'], $max ]
);
$this->mOutput->setLimitReportData( 'limitreport-expansiondepth',
[ $this->mHighestExpansionDepth, $this->mOptions->getMaxPPExpandDepth() ]
);
$this->mOutput->setLimitReportData( 'limitreport-expensivefunctioncount',
[ $this->mExpensiveFunctionCount, $this->mOptions->getExpensiveParserFunctionLimit() ]
);
Hooks::run( 'ParserLimitReportPrepare', [ $this, $this->mOutput ] );
$limitReport = "NewPP limit report\n";
if ( $wgShowHostnames ) {
$limitReport .= 'Parsed by ' . wfHostname() . "\n";
}
$limitReport .= 'Cached time: ' . $this->mOutput->getCacheTime() . "\n";
$limitReport .= 'Cache expiry: ' . $this->mOutput->getCacheExpiry() . "\n";
$limitReport .= 'Dynamic content: ' .
( $this->mOutput->hasDynamicContent() ? 'true' : 'false' ) .
"\n";
foreach ( $this->mOutput->getLimitReportData() as $key => $value ) {
if ( Hooks::run( 'ParserLimitReportFormat',
[ $key, &$value, &$limitReport, false, false ]
) ) {
$keyMsg = wfMessage( $key )->inLanguage( 'en' )->useDatabase( false );
$valueMsg = wfMessage( [ "$key-value-text", "$key-value" ] )
->inLanguage( 'en' )->useDatabase( false );
if ( !$valueMsg->exists() ) {
$valueMsg = new RawMessage( '$1' );
}
if ( !$keyMsg->isDisabled() && !$valueMsg->isDisabled() ) {
$valueMsg->params( $value );
$limitReport .= "{$keyMsg->text()}: {$valueMsg->text()}\n";
}
}
}
// Since we're not really outputting HTML, decode the entities and
// then re-encode the things that need hiding inside HTML comments.
$limitReport = htmlspecialchars_decode( $limitReport );
Hooks::run( 'ParserLimitReport', [ $this, &$limitReport ] );
// Sanitize for comment. Note '‐' in the replacement is U+2010,
// which looks much like the problematic '-'.
$limitReport = str_replace( [ '-', '&' ], [ '‐', '&' ], $limitReport );
$text .= "\n<!-- \n$limitReport-->\n";
// Add on template profiling data
$dataByFunc = $this->mProfiler->getFunctionStats();
uasort( $dataByFunc, function ( $a, $b ) {
return $a['real'] < $b['real']; // descending order
} );
$profileReport = "Transclusion expansion time report (%,ms,calls,template)\n";
foreach ( array_slice( $dataByFunc, 0, 10 ) as $item ) {
$profileReport .= sprintf( "%6.2f%% %8.3f %6d - %s\n",
$item['%real'], $item['real'], $item['calls'],
htmlspecialchars( $item['name'] ) );
}
$text .= "\n<!-- \n$profileReport-->\n";
if ( $this->mGeneratedPPNodeCount > $this->mOptions->getMaxGeneratedPPNodeCount() / 10 ) {
wfDebugLog( 'generated-pp-node-count', $this->mGeneratedPPNodeCount . ' ' .
$this->mTitle->getPrefixedDBkey() );
}
}
$this->mOutput->setText( $text );
$this->mRevisionId = $oldRevisionId;
$this->mRevisionObject = $oldRevisionObject;
$this->mRevisionTimestamp = $oldRevisionTimestamp;
$this->mRevisionUser = $oldRevisionUser;
$this->mRevisionSize = $oldRevisionSize;
$this->mInputSize = false;
$this->currentRevisionCache = null;
return $this->mOutput;
}
/**
* Half-parse wikitext to half-parsed HTML. This recursive parser entry point
* can be called from an extension tag hook.
*
* The output of this function IS NOT SAFE PARSED HTML; it is "half-parsed"
* instead, which means that lists and links have not been fully parsed yet,
* and strip markers are still present.
*
* Use recursiveTagParseFully() to fully parse wikitext to output-safe HTML.
*
* Use this function if you're a parser tag hook and you want to parse
* wikitext before or after applying additional transformations, and you
* intend to *return the result as hook output*, which will cause it to go
* through the rest of parsing process automatically.
*
* If $frame is not provided, then template variables (e.g., {{{1}}}) within
* $text are not expanded
*
* @param string $text Text extension wants to have parsed
* @param bool|PPFrame $frame The frame to use for expanding any template variables
* @return string UNSAFE half-parsed HTML
*/
public function recursiveTagParse( $text, $frame = false ) {
Hooks::run( 'ParserBeforeStrip', [ &$this, &$text, &$this->mStripState ] );
Hooks::run( 'ParserAfterStrip', [ &$this, &$text, &$this->mStripState ] );
$text = $this->internalParse( $text, false, $frame );
return $text;
}
/**
* Fully parse wikitext to fully parsed HTML. This recursive parser entry
* point can be called from an extension tag hook.
*
* The output of this function is fully-parsed HTML that is safe for output.
* If you're a parser tag hook, you might want to use recursiveTagParse()
* instead.
*
* If $frame is not provided, then template variables (e.g., {{{1}}}) within
* $text are not expanded
*
* @since 1.25
*
* @param string $text Text extension wants to have parsed
* @param bool|PPFrame $frame The frame to use for expanding any template variables
* @return string Fully parsed HTML
*/
public function recursiveTagParseFully( $text, $frame = false ) {
$text = $this->recursiveTagParse( $text, $frame );
$text = $this->internalParseHalfParsed( $text, false );
return $text;
}
/**
* Expand templates and variables in the text, producing valid, static wikitext.
* Also removes comments.
* Do not call this function recursively.
* @param string $text
* @param Title $title
* @param ParserOptions $options
* @param int|null $revid
* @param bool|PPFrame $frame
* @return mixed|string
*/
public function preprocess( $text, Title $title = null,
ParserOptions $options, $revid = null, $frame = false
) {
$magicScopeVariable = $this->lock();
$this->startParse( $title, $options, self::OT_PREPROCESS, true );
if ( $revid !== null ) {
$this->mRevisionId = $revid;
}
Hooks::run( 'ParserBeforeStrip', [ &$this, &$text, &$this->mStripState ] );
Hooks::run( 'ParserAfterStrip', [ &$this, &$text, &$this->mStripState ] );
$text = $this->replaceVariables( $text, $frame );
$text = $this->mStripState->unstripBoth( $text );
return $text;
}
/**
* Recursive parser entry point that can be called from an extension tag
* hook.
*
* @param string $text Text to be expanded
* @param bool|PPFrame $frame The frame to use for expanding any template variables
* @return string
* @since 1.19
*/
public function recursivePreprocess( $text, $frame = false ) {
$text = $this->replaceVariables( $text, $frame );
$text = $this->mStripState->unstripBoth( $text );
return $text;
}
/**
* Process the wikitext for the "?preload=" feature. (bug 5210)
*
* "<noinclude>", "<includeonly>" etc. are parsed as for template
* transclusion, comments, templates, arguments, tags hooks and parser
* functions are untouched.
*
* @param string $text
* @param Title $title
* @param ParserOptions $options
* @param array $params
* @return string
*/
public function getPreloadText( $text, Title $title, ParserOptions $options, $params = [] ) {
$msg = new RawMessage( $text );
$text = $msg->params( $params )->plain();
# Parser (re)initialisation
$magicScopeVariable = $this->lock();
$this->startParse( $title, $options, self::OT_PLAIN, true );
$flags = PPFrame::NO_ARGS | PPFrame::NO_TEMPLATES;
$dom = $this->preprocessToDom( $text, self::PTD_FOR_INCLUSION );
$text = $this->getPreprocessor()->newFrame()->expand( $dom, $flags );
$text = $this->mStripState->unstripBoth( $text );
return $text;
}
/**
* Get a random string
*
* @return string
* @deprecated since 1.26; use wfRandomString() instead.
*/
public static function getRandomString() {
wfDeprecated( __METHOD__, '1.26' );
return wfRandomString( 16 );
}
/**
* Set the current user.
* Should only be used when doing pre-save transform.
*
* @param User|null $user User object or null (to reset)
*/
public function setUser( $user ) {
$this->mUser = $user;
}
/**
* Accessor for mUniqPrefix.
*
* @return string
* @deprecated since 1.26; use Parser::MARKER_PREFIX instead.
*/
public function uniqPrefix() {
wfDeprecated( __METHOD__, '1.26' );
return self::MARKER_PREFIX;
}
/**
* Set the context title
*
* @param Title $t
*/
public function setTitle( $t ) {
if ( !$t ) {
$t = Title::newFromText( 'NO TITLE' );
}
if ( $t->hasFragment() ) {
# Strip the fragment to avoid various odd effects
$this->mTitle = clone $t;
$this->mTitle->setFragment( '' );
} else {
$this->mTitle = $t;
}
}
/**
* Accessor for the Title object
*
* @return Title
*/
public function getTitle() {
return $this->mTitle;
}
/**
* Accessor/mutator for the Title object
*
* @param Title $x Title object or null to just get the current one
* @return Title
*/
public function Title( $x = null ) {
return wfSetVar( $this->mTitle, $x );
}
/**
* Set the output type
*
* @param int $ot New value
*/
public function setOutputType( $ot ) {
$this->mOutputType = $ot;
# Shortcut alias
$this->ot = [
'html' => $ot == self::OT_HTML,
'wiki' => $ot == self::OT_WIKI,
'pre' => $ot == self::OT_PREPROCESS,
'plain' => $ot == self::OT_PLAIN,
];
}
/**
* Accessor/mutator for the output type
*
* @param int|null $x New value or null to just get the current one
* @return int
*/
public function OutputType( $x = null ) {
return wfSetVar( $this->mOutputType, $x );
}
/**
* Get the ParserOutput object
*
* @return ParserOutput
*/
public function getOutput() {
return $this->mOutput;
}
/**
* Get the ParserOptions object
*
* @return ParserOptions
*/
public function getOptions() {
return $this->mOptions;
}
/**
* Accessor/mutator for the ParserOptions object
*
* @param ParserOptions $x New value or null to just get the current one
* @return ParserOptions Current ParserOptions object
*/
public function Options( $x = null ) {
return wfSetVar( $this->mOptions, $x );
}
/**
* @return int
*/
public function nextLinkID() {
return $this->mLinkID++;
}
/**
* @param int $id
*/
public function setLinkID( $id ) {
$this->mLinkID = $id;
}
/**
* Get a language object for use in parser functions such as {{FORMATNUM:}}
* @return Language
*/
public function getFunctionLang() {
return $this->getTargetLanguage();
}
/**
* Get the target language for the content being parsed. This is usually the
* language that the content is in.
*
* @since 1.19
*
* @throws MWException
* @return Language
*/
public function getTargetLanguage() {
$target = $this->mOptions->getTargetLanguage();
if ( $target !== null ) {
return $target;
} elseif ( $this->mOptions->getInterfaceMessage() ) {
return $this->mOptions->getUserLangObj();
} elseif ( is_null( $this->mTitle ) ) {
throw new MWException( __METHOD__ . ': $this->mTitle is null' );
}
return $this->mTitle->getPageLanguage();
}
/**
* Get the language object for language conversion
* @return Language|null
*/
public function getConverterLanguage() {
return $this->getTargetLanguage();
}
/**
* Get a User object either from $this->mUser, if set, or from the
* ParserOptions object otherwise
*
* @return User
*/
public function getUser() {
if ( !is_null( $this->mUser ) ) {
return $this->mUser;
}
return $this->mOptions->getUser();
}
/**
* Get a preprocessor object
*
* @return Preprocessor
*/
public function getPreprocessor() {
if ( !isset( $this->mPreprocessor ) ) {
$class = $this->mPreprocessorClass;
$this->mPreprocessor = new $class( $this );
}
return $this->mPreprocessor;
}
/**
* Replaces all occurrences of HTML-style comments and the given tags
* in the text with a random marker and returns the next text. The output
* parameter $matches will be an associative array filled with data in
* the form:
*
* @code
* 'UNIQ-xxxxx' => array(
* 'element',
* 'tag content',
* array( 'param' => 'x' ),
* '<element param="x">tag content</element>' ) )
* @endcode
*
* @param array $elements List of element names. Comments are always extracted.
* @param string $text Source text string.
* @param array $matches Out parameter, Array: extracted tags
* @param string|null $uniq_prefix
* @return string Stripped text
* @since 1.26 The uniq_prefix argument is deprecated.
*/
public static function extractTagsAndParams( $elements, $text, &$matches, $uniq_prefix = null ) {
if ( $uniq_prefix !== null ) {
wfDeprecated( __METHOD__ . ' called with $prefix argument', '1.26' );
}
static $n = 1;
$stripped = '';
$matches = [];
$taglist = implode( '|', $elements );
$start = "/<($taglist)(\\s+[^>]*?|\\s*?)(\/?" . ">)|<(!--)/i";
while ( $text != '' ) {
$p = preg_split( $start, $text, 2, PREG_SPLIT_DELIM_CAPTURE );
$stripped .= $p[0];
if ( count( $p ) < 5 ) {
break;
}
if ( count( $p ) > 5 ) {
# comment
$element = $p[4];
$attributes = '';
$close = '';
$inside = $p[5];
} else {
# tag
$element = $p[1];
$attributes = $p[2];
$close = $p[3];
$inside = $p[4];
}
$marker = self::MARKER_PREFIX . "-$element-" . sprintf( '%08X', $n++ ) . self::MARKER_SUFFIX;
$stripped .= $marker;
if ( $close === '/>' ) {
# Empty element tag, <tag />
$content = null;
$text = $inside;
$tail = null;
} else {
if ( $element === '!--' ) {
$end = '/(-->)/';
} else {
$end = "/(<\\/$element\\s*>)/i";
}
$q = preg_split( $end, $inside, 2, PREG_SPLIT_DELIM_CAPTURE );
$content = $q[0];
if ( count( $q ) < 3 ) {
# No end tag -- let it run out to the end of the text.
$tail = '';
$text = '';
} else {
$tail = $q[1];
$text = $q[2];
}
}
$matches[$marker] = [ $element,
$content,
Sanitizer::decodeTagAttributes( $attributes ),
"<$element$attributes$close$content$tail" ];
}
return $stripped;
}
/**
* Get a list of strippable XML-like elements
*
* @return array
*/
public function getStripList() {
return $this->mStripList;
}
/**
* Add an item to the strip state
* Returns the unique tag which must be inserted into the stripped text
* The tag will be replaced with the original text in unstrip()
*