MediaWiki REL1_39
WikiTextStructure.php
Go to the documentation of this file.
1<?php
2
3use HtmlFormatter\HtmlFormatter;
4
12 private $openingText;
16 private $allText;
20 private $auxText = [];
24 private $parserOutput;
25
29 private $excludedElementSelectors = [
30 // "it looks like you don't have javascript enabled..." – do not need to index
31 'audio', 'video',
32 // CSS stylesheets aren't content
33 'style',
34 // The [1] for references from Cite
35 'sup.reference',
36 // The ↑ next to references in the references section from Cite
37 '.mw-cite-backlink',
38 // Headings are already indexed in their own field.
39 'h1', 'h2', 'h3', 'h4', 'h5', 'h6',
40 // Collapsed fields are hidden by default so we don't want them showing up.
41 '.autocollapse',
42 // Content explicitly decided to be not searchable by editors such
43 // as custom navigation templates.
44 '.navigation-not-searchable',
45 // User-facing interface code prompting the user to act from WikibaseMediaInfo
46 '.wbmi-entityview-emptyCaption',
47 ];
48
52 private $auxiliaryElementSelectors = [
53 // Thumbnail captions aren't really part of the text proper
54 '.thumbcaption',
55 // Neither are tables
56 'table',
57 // Common style for "See also:".
58 '.rellink',
59 // Common style for calling out helpful links at the top of the article.
60 '.dablink',
61 // New class users can use to mark stuff as auxiliary to searches.
62 '.searchaux',
63 ];
64
68 public function __construct( ParserOutput $parserOutput ) {
69 $this->parserOutput = $parserOutput;
70 }
71
85 public function headings() {
86 $headings = [];
87 $ignoredHeadings = $this->getIgnoredHeadings();
88 foreach ( $this->parserOutput->getSections() as $heading ) {
89 $heading = $heading[ 'line' ];
90
91 // Some wikis wrap the brackets in a span:
92 // https://en.wikipedia.org/wiki/MediaWiki:Cite_reference_link
93 $heading = preg_replace( '/<\/?span>/', '', $heading );
94 // Normalize [] so the following regexp would work.
95 $heading = preg_replace( [ '/&#91;/', '/&#93;/' ], [ '[', ']' ], $heading );
96 $heading = preg_replace( '/<sup>\s*\[\s*\d+\s*\]\s*<\/sup>/is', '', $heading );
97
98 // Strip tags from the heading or else we'll display them (escaped) in search results
99 $heading = trim( Sanitizer::stripAllTags( $heading ) );
100
101 // Note that we don't take the level of the heading into account - all headings are equal.
102 // Except the ones we ignore.
103 if ( !in_array( $heading, $ignoredHeadings ) ) {
104 $headings[] = $heading;
105 }
106 }
107 return $headings;
108 }
109
117 public static function parseSettingsInMessage( $message ) {
118 $lines = explode( "\n", $message );
119 $lines = preg_replace( '/#.*$/', '', $lines ); // Remove comments
120 $lines = array_map( 'trim', $lines ); // Remove extra spaces
121 $lines = array_filter( $lines ); // Remove empty lines
122 return $lines;
123 }
124
129 private function getIgnoredHeadings() {
130 static $ignoredHeadings = null;
131 if ( $ignoredHeadings === null ) {
132 $ignoredHeadings = [];
133 $source = wfMessage( 'search-ignored-headings' )->inContentLanguage();
134 if ( $source->isBlank() ) {
135 // Try old version too, just in case
136 $source = wfMessage( 'cirrussearch-ignored-headings' )->inContentLanguage();
137 }
138 if ( !$source->isDisabled() ) {
140 $ignoredHeadings = $lines; // Now we just have headings!
141 }
142 }
143 return $ignoredHeadings;
144 }
145
149 private function extractWikitextParts() {
150 if ( $this->allText !== null ) {
151 return;
152 }
153 $text = $this->parserOutput->getText( [
154 'enableSectionEditTokens' => false,
155 'allowTOC' => false,
156 ] );
157 if ( $text === '' ) {
158 $this->allText = "";
159 // empty text - nothing to seek here
160 return;
161 }
162
163 $this->openingText = $this->extractHeadingBeforeFirstHeading( $text );
164
165 $formatter = new HtmlFormatter( $text );
166
167 // Strip elements from the page that we never want in the search text.
168 $formatter->remove( $this->excludedElementSelectors );
169 $formatter->filterContent();
170
171 // Strip elements from the page that are auxiliary text. These will still be
172 // searched but matches will be ranked lower and non-auxiliary matches will be
173 // preferred in highlighting.
174 $formatter->remove( $this->auxiliaryElementSelectors );
175 $auxiliaryElements = $formatter->filterContent();
176 $this->allText = trim( Sanitizer::stripAllTags( $formatter->getText() ) );
177 foreach ( $auxiliaryElements as $auxiliaryElement ) {
178 $this->auxText[] =
179 trim( Sanitizer::stripAllTags( $formatter->getText( $auxiliaryElement ) ) );
180 }
181 }
182
188 private function extractHeadingBeforeFirstHeading( $text ) {
189 $matches = [];
190 if ( !preg_match( '/<h[123456]>/', $text, $matches, PREG_OFFSET_CAPTURE ) ) {
191 // There isn't a first heading so we interpret this as the article
192 // being entirely without heading.
193 return null;
194 }
195 $text = substr( $text, 0, $matches[ 0 ][ 1 ] );
196 if ( !$text ) {
197 // There isn't any text before the first heading so we declare there isn't
198 // a first heading.
199 return null;
200 }
201
202 $formatter = new HtmlFormatter( $text );
203 $formatter->remove( $this->excludedElementSelectors );
204 $formatter->remove( $this->auxiliaryElementSelectors );
205 $formatter->filterContent();
206 $text = trim( Sanitizer::stripAllTags( $formatter->getText() ) );
207
208 if ( !$text ) {
209 // There isn't any text after filtering before the first heading so we declare
210 // that there isn't a first heading.
211 return null;
212 }
213
214 return $text;
215 }
216
220 public function getOpeningText() {
221 $this->extractWikitextParts();
222 return $this->openingText;
223 }
224
228 public function getMainText() {
229 $this->extractWikitextParts();
230 return $this->allText;
231 }
232
236 public function getAuxiliaryText() {
237 $this->extractWikitextParts();
238 return $this->auxText;
239 }
240
245 public function getDefaultSort() {
246 return $this->parserOutput->getPageProperty( 'defaultsort' );
247 }
248}
wfMessage( $key,... $params)
This is the function for getting translated interface messages.
Class allowing to explore structure of parsed wikitext.
getDefaultSort()
Get the defaultsort property.
static parseSettingsInMessage( $message)
Parse a message content into an array.
headings()
Get headings on the page.
__construct(ParserOutput $parserOutput)
$source
if(!file_exists( $CREDITS)) $lines