Merge "Use MediaWiki\SuppressWarnings around trigger_error('') instead @"
[lhc/web/wiklou.git] / includes / Linker.php
1 <?php
2 /**
3 * Methods to make links and related items.
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 */
22 use MediaWiki\Linker\LinkTarget;
23 use MediaWiki\MediaWikiServices;
24
25 /**
26 * Some internal bits split of from Skin.php. These functions are used
27 * for primarily page content: links, embedded images, table of contents. Links
28 * are also used in the skin.
29 *
30 * @todo turn this into a legacy interface for HtmlPageLinkRenderer and similar services.
31 *
32 * @ingroup Skins
33 */
34 class Linker {
35 /**
36 * Flags for userToolLinks()
37 */
38 const TOOL_LINKS_NOBLOCK = 1;
39 const TOOL_LINKS_EMAIL = 2;
40
41 /**
42 * This function returns an HTML link to the given target. It serves a few
43 * purposes:
44 * 1) If $target is a Title, the correct URL to link to will be figured
45 * out automatically.
46 * 2) It automatically adds the usual classes for various types of link
47 * targets: "new" for red links, "stub" for short articles, etc.
48 * 3) It escapes all attribute values safely so there's no risk of XSS.
49 * 4) It provides a default tooltip if the target is a Title (the page
50 * name of the target).
51 * link() replaces the old functions in the makeLink() family.
52 *
53 * @since 1.18 Method exists since 1.16 as non-static, made static in 1.18.
54 * @deprecated since 1.28, use MediaWiki\Linker\LinkRenderer instead
55 *
56 * @param LinkTarget $target Can currently only be a LinkTarget, but this may
57 * change to support Images, literal URLs, etc.
58 * @param string $html The HTML contents of the <a> element, i.e.,
59 * the link text. This is raw HTML and will not be escaped. If null,
60 * defaults to the prefixed text of the Title; or if the Title is just a
61 * fragment, the contents of the fragment.
62 * @param array $customAttribs A key => value array of extra HTML attributes,
63 * such as title and class. (href is ignored.) Classes will be
64 * merged with the default classes, while other attributes will replace
65 * default attributes. All passed attribute values will be HTML-escaped.
66 * A false attribute value means to suppress that attribute.
67 * @param array $query The query string to append to the URL
68 * you're linking to, in key => value array form. Query keys and values
69 * will be URL-encoded.
70 * @param string|array $options String or array of strings:
71 * 'known': Page is known to exist, so don't check if it does.
72 * 'broken': Page is known not to exist, so don't check if it does.
73 * 'noclasses': Don't add any classes automatically (includes "new",
74 * "stub", "mw-redirect", "extiw"). Only use the class attribute
75 * provided, if any, so you get a simple blue link with no funny i-
76 * cons.
77 * 'forcearticlepath': Use the article path always, even with a querystring.
78 * Has compatibility issues on some setups, so avoid wherever possible.
79 * 'http': Force a full URL with http:// as the scheme.
80 * 'https': Force a full URL with https:// as the scheme.
81 * 'stubThreshold' => (int): Stub threshold to use when determining link classes.
82 * @return string HTML <a> attribute
83 */
84 public static function link(
85 $target, $html = null, $customAttribs = [], $query = [], $options = []
86 ) {
87 if ( !$target instanceof LinkTarget ) {
88 wfWarn( __METHOD__ . ': Requires $target to be a LinkTarget object.', 2 );
89 return "<!-- ERROR -->$html";
90 }
91
92 if ( is_string( $query ) ) {
93 // some functions withing core using this still hand over query strings
94 wfDeprecated( __METHOD__ . ' with parameter $query as string (should be array)', '1.20' );
95 $query = wfCgiToArray( $query );
96 }
97
98 $services = MediaWikiServices::getInstance();
99 $options = (array)$options;
100 if ( $options ) {
101 // Custom options, create new LinkRenderer
102 if ( !isset( $options['stubThreshold'] ) ) {
103 $defaultLinkRenderer = $services->getLinkRenderer();
104 $options['stubThreshold'] = $defaultLinkRenderer->getStubThreshold();
105 }
106 $linkRenderer = $services->getLinkRendererFactory()
107 ->createFromLegacyOptions( $options );
108 } else {
109 $linkRenderer = $services->getLinkRenderer();
110 }
111
112 if ( $html !== null ) {
113 $text = new HtmlArmor( $html );
114 } else {
115 $text = $html; // null
116 }
117 if ( in_array( 'known', $options, true ) ) {
118 return $linkRenderer->makeKnownLink( $target, $text, $customAttribs, $query );
119 } elseif ( in_array( 'broken', $options, true ) ) {
120 return $linkRenderer->makeBrokenLink( $target, $text, $customAttribs, $query );
121 } elseif ( in_array( 'noclasses', $options, true ) ) {
122 return $linkRenderer->makePreloadedLink( $target, $text, '', $customAttribs, $query );
123 } else {
124 return $linkRenderer->makeLink( $target, $text, $customAttribs, $query );
125 }
126 }
127
128 /**
129 * Identical to link(), except $options defaults to 'known'.
130 *
131 * @since 1.16.3
132 * @deprecated since 1.28, use MediaWiki\Linker\LinkRenderer instead
133 * @see Linker::link
134 * @param Title $target
135 * @param string $html
136 * @param array $customAttribs
137 * @param array $query
138 * @param string|array $options
139 * @return string
140 */
141 public static function linkKnown(
142 $target, $html = null, $customAttribs = [],
143 $query = [], $options = [ 'known' ]
144 ) {
145 return self::link( $target, $html, $customAttribs, $query, $options );
146 }
147
148 /**
149 * Make appropriate markup for a link to the current article. This is since
150 * MediaWiki 1.29.0 rendered as an <a> tag without an href and with a class
151 * showing the link text. The calling sequence is the same as for the other
152 * make*LinkObj static functions, but $query is not used.
153 *
154 * @since 1.16.3
155 * @param Title $nt
156 * @param string $html [optional]
157 * @param string $query [optional]
158 * @param string $trail [optional]
159 * @param string $prefix [optional]
160 *
161 * @return string
162 */
163 public static function makeSelfLinkObj( $nt, $html = '', $query = '', $trail = '', $prefix = '' ) {
164 $ret = "<a class=\"mw-selflink selflink\">{$prefix}{$html}</a>{$trail}";
165 if ( !Hooks::run( 'SelfLinkBegin', [ $nt, &$html, &$trail, &$prefix, &$ret ] ) ) {
166 return $ret;
167 }
168
169 if ( $html == '' ) {
170 $html = htmlspecialchars( $nt->getPrefixedText() );
171 }
172 list( $inside, $trail ) = self::splitTrail( $trail );
173 return "<a class=\"mw-selflink selflink\">{$prefix}{$html}{$inside}</a>{$trail}";
174 }
175
176 /**
177 * Get a message saying that an invalid title was encountered.
178 * This should be called after a method like Title::makeTitleSafe() returned
179 * a value indicating that the title object is invalid.
180 *
181 * @param IContextSource $context Context to use to get the messages
182 * @param int $namespace Namespace number
183 * @param string $title Text of the title, without the namespace part
184 * @return string
185 */
186 public static function getInvalidTitleDescription( IContextSource $context, $namespace, $title ) {
187 // First we check whether the namespace exists or not.
188 if ( MWNamespace::exists( $namespace ) ) {
189 if ( $namespace == NS_MAIN ) {
190 $name = $context->msg( 'blanknamespace' )->text();
191 } else {
192 $name = MediaWikiServices::getInstance()->getContentLanguage()->
193 getFormattedNsText( $namespace );
194 }
195 return $context->msg( 'invalidtitle-knownnamespace', $namespace, $name, $title )->text();
196 } else {
197 return $context->msg( 'invalidtitle-unknownnamespace', $namespace, $title )->text();
198 }
199 }
200
201 /**
202 * @since 1.16.3
203 * @param LinkTarget $target
204 * @return LinkTarget
205 */
206 public static function normaliseSpecialPage( LinkTarget $target ) {
207 if ( $target->getNamespace() == NS_SPECIAL && !$target->isExternal() ) {
208 list( $name, $subpage ) = MediaWikiServices::getInstance()->getSpecialPageFactory()->
209 resolveAlias( $target->getDBkey() );
210 if ( !$name ) {
211 return $target;
212 }
213 $ret = SpecialPage::getTitleValueFor( $name, $subpage, $target->getFragment() );
214 return $ret;
215 } else {
216 return $target;
217 }
218 }
219
220 /**
221 * Returns the filename part of an url.
222 * Used as alternative text for external images.
223 *
224 * @param string $url
225 *
226 * @return string
227 */
228 private static function fnamePart( $url ) {
229 $basename = strrchr( $url, '/' );
230 if ( $basename === false ) {
231 $basename = $url;
232 } else {
233 $basename = substr( $basename, 1 );
234 }
235 return $basename;
236 }
237
238 /**
239 * Return the code for images which were added via external links,
240 * via Parser::maybeMakeExternalImage().
241 *
242 * @since 1.16.3
243 * @param string $url
244 * @param string $alt
245 *
246 * @return string
247 */
248 public static function makeExternalImage( $url, $alt = '' ) {
249 if ( $alt == '' ) {
250 $alt = self::fnamePart( $url );
251 }
252 $img = '';
253 $success = Hooks::run( 'LinkerMakeExternalImage', [ &$url, &$alt, &$img ] );
254 if ( !$success ) {
255 wfDebug( "Hook LinkerMakeExternalImage changed the output of external image "
256 . "with url {$url} and alt text {$alt} to {$img}\n", true );
257 return $img;
258 }
259 return Html::element( 'img',
260 [
261 'src' => $url,
262 'alt' => $alt ] );
263 }
264
265 /**
266 * Given parameters derived from [[Image:Foo|options...]], generate the
267 * HTML that that syntax inserts in the page.
268 *
269 * @param Parser $parser
270 * @param Title $title Title object of the file (not the currently viewed page)
271 * @param File $file File object, or false if it doesn't exist
272 * @param array $frameParams Associative array of parameters external to the media handler.
273 * Boolean parameters are indicated by presence or absence, the value is arbitrary and
274 * will often be false.
275 * thumbnail If present, downscale and frame
276 * manualthumb Image name to use as a thumbnail, instead of automatic scaling
277 * framed Shows image in original size in a frame
278 * frameless Downscale but don't frame
279 * upright If present, tweak default sizes for portrait orientation
280 * upright_factor Fudge factor for "upright" tweak (default 0.75)
281 * border If present, show a border around the image
282 * align Horizontal alignment (left, right, center, none)
283 * valign Vertical alignment (baseline, sub, super, top, text-top, middle,
284 * bottom, text-bottom)
285 * alt Alternate text for image (i.e. alt attribute). Plain text.
286 * class HTML for image classes. Plain text.
287 * caption HTML for image caption.
288 * link-url URL to link to
289 * link-title Title object to link to
290 * link-target Value for the target attribute, only with link-url
291 * no-link Boolean, suppress description link
292 * targetlang (optional) Target language code, see Parser::getTargetLanguage()
293 *
294 * @param array $handlerParams Associative array of media handler parameters, to be passed
295 * to transform(). Typical keys are "width" and "page".
296 * @param string|bool $time Timestamp of the file, set as false for current
297 * @param string $query Query params for desc url
298 * @param int|null $widthOption Used by the parser to remember the user preference thumbnailsize
299 * @since 1.20
300 * @return string HTML for an image, with links, wrappers, etc.
301 */
302 public static function makeImageLink( Parser $parser, Title $title,
303 $file, $frameParams = [], $handlerParams = [], $time = false,
304 $query = "", $widthOption = null
305 ) {
306 $res = null;
307 $dummy = new DummyLinker;
308 if ( !Hooks::run( 'ImageBeforeProduceHTML', [ &$dummy, &$title,
309 &$file, &$frameParams, &$handlerParams, &$time, &$res,
310 $parser, &$query, &$widthOption
311 ] ) ) {
312 return $res;
313 }
314
315 if ( $file && !$file->allowInlineDisplay() ) {
316 wfDebug( __METHOD__ . ': ' . $title->getPrefixedDBkey() . " does not allow inline display\n" );
317 return self::link( $title );
318 }
319
320 // Clean up parameters
321 $page = $handlerParams['page'] ?? false;
322 if ( !isset( $frameParams['align'] ) ) {
323 $frameParams['align'] = '';
324 }
325 if ( !isset( $frameParams['alt'] ) ) {
326 $frameParams['alt'] = '';
327 }
328 if ( !isset( $frameParams['title'] ) ) {
329 $frameParams['title'] = '';
330 }
331 if ( !isset( $frameParams['class'] ) ) {
332 $frameParams['class'] = '';
333 }
334
335 $prefix = $postfix = '';
336
337 if ( $frameParams['align'] == 'center' ) {
338 $prefix = '<div class="center">';
339 $postfix = '</div>';
340 $frameParams['align'] = 'none';
341 }
342 if ( $file && !isset( $handlerParams['width'] ) ) {
343 if ( isset( $handlerParams['height'] ) && $file->isVectorized() ) {
344 // If its a vector image, and user only specifies height
345 // we don't want it to be limited by its "normal" width.
346 global $wgSVGMaxSize;
347 $handlerParams['width'] = $wgSVGMaxSize;
348 } else {
349 $handlerParams['width'] = $file->getWidth( $page );
350 }
351
352 if ( isset( $frameParams['thumbnail'] )
353 || isset( $frameParams['manualthumb'] )
354 || isset( $frameParams['framed'] )
355 || isset( $frameParams['frameless'] )
356 || !$handlerParams['width']
357 ) {
358 global $wgThumbLimits, $wgThumbUpright;
359
360 if ( $widthOption === null || !isset( $wgThumbLimits[$widthOption] ) ) {
361 $widthOption = User::getDefaultOption( 'thumbsize' );
362 }
363
364 // Reduce width for upright images when parameter 'upright' is used
365 if ( isset( $frameParams['upright'] ) && $frameParams['upright'] == 0 ) {
366 $frameParams['upright'] = $wgThumbUpright;
367 }
368
369 // For caching health: If width scaled down due to upright
370 // parameter, round to full __0 pixel to avoid the creation of a
371 // lot of odd thumbs.
372 $prefWidth = isset( $frameParams['upright'] ) ?
373 round( $wgThumbLimits[$widthOption] * $frameParams['upright'], -1 ) :
374 $wgThumbLimits[$widthOption];
375
376 // Use width which is smaller: real image width or user preference width
377 // Unless image is scalable vector.
378 if ( !isset( $handlerParams['height'] ) && ( $handlerParams['width'] <= 0 ||
379 $prefWidth < $handlerParams['width'] || $file->isVectorized() ) ) {
380 $handlerParams['width'] = $prefWidth;
381 }
382 }
383 }
384
385 if ( isset( $frameParams['thumbnail'] ) || isset( $frameParams['manualthumb'] )
386 || isset( $frameParams['framed'] )
387 ) {
388 # Create a thumbnail. Alignment depends on the writing direction of
389 # the page content language (right-aligned for LTR languages,
390 # left-aligned for RTL languages)
391 # If a thumbnail width has not been provided, it is set
392 # to the default user option as specified in Language*.php
393 if ( $frameParams['align'] == '' ) {
394 $frameParams['align'] = $parser->getTargetLanguage()->alignEnd();
395 }
396 return $prefix .
397 self::makeThumbLink2( $title, $file, $frameParams, $handlerParams, $time, $query ) .
398 $postfix;
399 }
400
401 if ( $file && isset( $frameParams['frameless'] ) ) {
402 $srcWidth = $file->getWidth( $page );
403 # For "frameless" option: do not present an image bigger than the
404 # source (for bitmap-style images). This is the same behavior as the
405 # "thumb" option does it already.
406 if ( $srcWidth && !$file->mustRender() && $handlerParams['width'] > $srcWidth ) {
407 $handlerParams['width'] = $srcWidth;
408 }
409 }
410
411 if ( $file && isset( $handlerParams['width'] ) ) {
412 # Create a resized image, without the additional thumbnail features
413 $thumb = $file->transform( $handlerParams );
414 } else {
415 $thumb = false;
416 }
417
418 if ( !$thumb ) {
419 $s = self::makeBrokenImageLinkObj( $title, $frameParams['title'], '', '', '', $time == true );
420 } else {
421 self::processResponsiveImages( $file, $thumb, $handlerParams );
422 $params = [
423 'alt' => $frameParams['alt'],
424 'title' => $frameParams['title'],
425 'valign' => $frameParams['valign'] ?? false,
426 'img-class' => $frameParams['class'] ];
427 if ( isset( $frameParams['border'] ) ) {
428 $params['img-class'] .= ( $params['img-class'] !== '' ? ' ' : '' ) . 'thumbborder';
429 }
430 $params = self::getImageLinkMTOParams( $frameParams, $query, $parser ) + $params;
431
432 $s = $thumb->toHtml( $params );
433 }
434 if ( $frameParams['align'] != '' ) {
435 $s = Html::rawElement(
436 'div',
437 [ 'class' => 'float' . $frameParams['align'] ],
438 $s
439 );
440 }
441 return str_replace( "\n", ' ', $prefix . $s . $postfix );
442 }
443
444 /**
445 * Get the link parameters for MediaTransformOutput::toHtml() from given
446 * frame parameters supplied by the Parser.
447 * @param array $frameParams The frame parameters
448 * @param string $query An optional query string to add to description page links
449 * @param Parser|null $parser
450 * @return array
451 */
452 private static function getImageLinkMTOParams( $frameParams, $query = '', $parser = null ) {
453 $mtoParams = [];
454 if ( isset( $frameParams['link-url'] ) && $frameParams['link-url'] !== '' ) {
455 $mtoParams['custom-url-link'] = $frameParams['link-url'];
456 if ( isset( $frameParams['link-target'] ) ) {
457 $mtoParams['custom-target-link'] = $frameParams['link-target'];
458 }
459 if ( $parser ) {
460 $extLinkAttrs = $parser->getExternalLinkAttribs( $frameParams['link-url'] );
461 foreach ( $extLinkAttrs as $name => $val ) {
462 // Currently could include 'rel' and 'target'
463 $mtoParams['parser-extlink-' . $name] = $val;
464 }
465 }
466 } elseif ( isset( $frameParams['link-title'] ) && $frameParams['link-title'] !== '' ) {
467 $mtoParams['custom-title-link'] = Title::newFromLinkTarget(
468 self::normaliseSpecialPage( $frameParams['link-title'] )
469 );
470 } elseif ( !empty( $frameParams['no-link'] ) ) {
471 // No link
472 } else {
473 $mtoParams['desc-link'] = true;
474 $mtoParams['desc-query'] = $query;
475 }
476 return $mtoParams;
477 }
478
479 /**
480 * Make HTML for a thumbnail including image, border and caption
481 * @param Title $title
482 * @param File|bool $file File object or false if it doesn't exist
483 * @param string $label
484 * @param string $alt
485 * @param string $align
486 * @param array $params
487 * @param bool $framed
488 * @param string $manualthumb
489 * @return string
490 */
491 public static function makeThumbLinkObj( Title $title, $file, $label = '', $alt = '',
492 $align = 'right', $params = [], $framed = false, $manualthumb = ""
493 ) {
494 $frameParams = [
495 'alt' => $alt,
496 'caption' => $label,
497 'align' => $align
498 ];
499 if ( $framed ) {
500 $frameParams['framed'] = true;
501 }
502 if ( $manualthumb ) {
503 $frameParams['manualthumb'] = $manualthumb;
504 }
505 return self::makeThumbLink2( $title, $file, $frameParams, $params );
506 }
507
508 /**
509 * @param Title $title
510 * @param File $file
511 * @param array $frameParams
512 * @param array $handlerParams
513 * @param bool $time
514 * @param string $query
515 * @return string
516 */
517 public static function makeThumbLink2( Title $title, $file, $frameParams = [],
518 $handlerParams = [], $time = false, $query = ""
519 ) {
520 $exists = $file && $file->exists();
521
522 $page = $handlerParams['page'] ?? false;
523 if ( !isset( $frameParams['align'] ) ) {
524 $frameParams['align'] = 'right';
525 }
526 if ( !isset( $frameParams['alt'] ) ) {
527 $frameParams['alt'] = '';
528 }
529 if ( !isset( $frameParams['title'] ) ) {
530 $frameParams['title'] = '';
531 }
532 if ( !isset( $frameParams['caption'] ) ) {
533 $frameParams['caption'] = '';
534 }
535
536 if ( empty( $handlerParams['width'] ) ) {
537 // Reduce width for upright images when parameter 'upright' is used
538 $handlerParams['width'] = isset( $frameParams['upright'] ) ? 130 : 180;
539 }
540 $thumb = false;
541 $noscale = false;
542 $manualthumb = false;
543
544 if ( !$exists ) {
545 $outerWidth = $handlerParams['width'] + 2;
546 } else {
547 if ( isset( $frameParams['manualthumb'] ) ) {
548 # Use manually specified thumbnail
549 $manual_title = Title::makeTitleSafe( NS_FILE, $frameParams['manualthumb'] );
550 if ( $manual_title ) {
551 $manual_img = wfFindFile( $manual_title );
552 if ( $manual_img ) {
553 $thumb = $manual_img->getUnscaledThumb( $handlerParams );
554 $manualthumb = true;
555 } else {
556 $exists = false;
557 }
558 }
559 } elseif ( isset( $frameParams['framed'] ) ) {
560 // Use image dimensions, don't scale
561 $thumb = $file->getUnscaledThumb( $handlerParams );
562 $noscale = true;
563 } else {
564 # Do not present an image bigger than the source, for bitmap-style images
565 # This is a hack to maintain compatibility with arbitrary pre-1.10 behavior
566 $srcWidth = $file->getWidth( $page );
567 if ( $srcWidth && !$file->mustRender() && $handlerParams['width'] > $srcWidth ) {
568 $handlerParams['width'] = $srcWidth;
569 }
570 $thumb = $file->transform( $handlerParams );
571 }
572
573 if ( $thumb ) {
574 $outerWidth = $thumb->getWidth() + 2;
575 } else {
576 $outerWidth = $handlerParams['width'] + 2;
577 }
578 }
579
580 # ThumbnailImage::toHtml() already adds page= onto the end of DjVu URLs
581 # So we don't need to pass it here in $query. However, the URL for the
582 # zoom icon still needs it, so we make a unique query for it. See T16771
583 $url = $title->getLocalURL( $query );
584 if ( $page ) {
585 $url = wfAppendQuery( $url, [ 'page' => $page ] );
586 }
587 if ( $manualthumb
588 && !isset( $frameParams['link-title'] )
589 && !isset( $frameParams['link-url'] )
590 && !isset( $frameParams['no-link'] ) ) {
591 $frameParams['link-url'] = $url;
592 }
593
594 $s = "<div class=\"thumb t{$frameParams['align']}\">"
595 . "<div class=\"thumbinner\" style=\"width:{$outerWidth}px;\">";
596
597 if ( !$exists ) {
598 $s .= self::makeBrokenImageLinkObj( $title, $frameParams['title'], '', '', '', $time == true );
599 $zoomIcon = '';
600 } elseif ( !$thumb ) {
601 $s .= wfMessage( 'thumbnail_error', '' )->escaped();
602 $zoomIcon = '';
603 } else {
604 if ( !$noscale && !$manualthumb ) {
605 self::processResponsiveImages( $file, $thumb, $handlerParams );
606 }
607 $params = [
608 'alt' => $frameParams['alt'],
609 'title' => $frameParams['title'],
610 'img-class' => ( isset( $frameParams['class'] ) && $frameParams['class'] !== ''
611 ? $frameParams['class'] . ' '
612 : '' ) . 'thumbimage'
613 ];
614 $params = self::getImageLinkMTOParams( $frameParams, $query ) + $params;
615 $s .= $thumb->toHtml( $params );
616 if ( isset( $frameParams['framed'] ) ) {
617 $zoomIcon = "";
618 } else {
619 $zoomIcon = Html::rawElement( 'div', [ 'class' => 'magnify' ],
620 Html::rawElement( 'a', [
621 'href' => $url,
622 'class' => 'internal',
623 'title' => wfMessage( 'thumbnail-more' )->text() ],
624 "" ) );
625 }
626 }
627 $s .= ' <div class="thumbcaption">' . $zoomIcon . $frameParams['caption'] . "</div></div></div>";
628 return str_replace( "\n", ' ', $s );
629 }
630
631 /**
632 * Process responsive images: add 1.5x and 2x subimages to the thumbnail, where
633 * applicable.
634 *
635 * @param File $file
636 * @param MediaTransformOutput $thumb
637 * @param array $hp Image parameters
638 */
639 public static function processResponsiveImages( $file, $thumb, $hp ) {
640 global $wgResponsiveImages;
641 if ( $wgResponsiveImages && $thumb && !$thumb->isError() ) {
642 $hp15 = $hp;
643 $hp15['width'] = round( $hp['width'] * 1.5 );
644 $hp20 = $hp;
645 $hp20['width'] = $hp['width'] * 2;
646 if ( isset( $hp['height'] ) ) {
647 $hp15['height'] = round( $hp['height'] * 1.5 );
648 $hp20['height'] = $hp['height'] * 2;
649 }
650
651 $thumb15 = $file->transform( $hp15 );
652 $thumb20 = $file->transform( $hp20 );
653 if ( $thumb15 && !$thumb15->isError() && $thumb15->getUrl() !== $thumb->getUrl() ) {
654 $thumb->responsiveUrls['1.5'] = $thumb15->getUrl();
655 }
656 if ( $thumb20 && !$thumb20->isError() && $thumb20->getUrl() !== $thumb->getUrl() ) {
657 $thumb->responsiveUrls['2'] = $thumb20->getUrl();
658 }
659 }
660 }
661
662 /**
663 * Make a "broken" link to an image
664 *
665 * @since 1.16.3
666 * @param Title $title
667 * @param string $label Link label (plain text)
668 * @param string $query Query string
669 * @param string $unused1 Unused parameter kept for b/c
670 * @param string $unused2 Unused parameter kept for b/c
671 * @param bool $time A file of a certain timestamp was requested
672 * @return string
673 */
674 public static function makeBrokenImageLinkObj( $title, $label = '',
675 $query = '', $unused1 = '', $unused2 = '', $time = false
676 ) {
677 if ( !$title instanceof Title ) {
678 wfWarn( __METHOD__ . ': Requires $title to be a Title object.' );
679 return "<!-- ERROR -->" . htmlspecialchars( $label );
680 }
681
682 global $wgEnableUploads, $wgUploadMissingFileUrl, $wgUploadNavigationUrl;
683 if ( $label == '' ) {
684 $label = $title->getPrefixedText();
685 }
686 $encLabel = htmlspecialchars( $label );
687 $currentExists = $time ? ( wfFindFile( $title ) != false ) : false;
688
689 if ( ( $wgUploadMissingFileUrl || $wgUploadNavigationUrl || $wgEnableUploads )
690 && !$currentExists
691 ) {
692 $redir = RepoGroup::singleton()->getLocalRepo()->checkRedirect( $title );
693
694 if ( $redir ) {
695 // We already know it's a redirect, so mark it
696 // accordingly
697 return self::link(
698 $title,
699 $encLabel,
700 [ 'class' => 'mw-redirect' ],
701 wfCgiToArray( $query ),
702 [ 'known', 'noclasses' ]
703 );
704 }
705
706 $href = self::getUploadUrl( $title, $query );
707
708 return '<a href="' . htmlspecialchars( $href ) . '" class="new" title="' .
709 htmlspecialchars( $title->getPrefixedText(), ENT_QUOTES ) . '">' .
710 $encLabel . '</a>';
711 }
712
713 return self::link( $title, $encLabel, [], wfCgiToArray( $query ), [ 'known', 'noclasses' ] );
714 }
715
716 /**
717 * Get the URL to upload a certain file
718 *
719 * @since 1.16.3
720 * @param Title $destFile Title object of the file to upload
721 * @param string $query Urlencoded query string to prepend
722 * @return string Urlencoded URL
723 */
724 protected static function getUploadUrl( $destFile, $query = '' ) {
725 global $wgUploadMissingFileUrl, $wgUploadNavigationUrl;
726 $q = 'wpDestFile=' . $destFile->getPartialURL();
727 if ( $query != '' ) {
728 $q .= '&' . $query;
729 }
730
731 if ( $wgUploadMissingFileUrl ) {
732 return wfAppendQuery( $wgUploadMissingFileUrl, $q );
733 } elseif ( $wgUploadNavigationUrl ) {
734 return wfAppendQuery( $wgUploadNavigationUrl, $q );
735 } else {
736 $upload = SpecialPage::getTitleFor( 'Upload' );
737 return $upload->getLocalURL( $q );
738 }
739 }
740
741 /**
742 * Create a direct link to a given uploaded file.
743 *
744 * @since 1.16.3
745 * @param Title $title
746 * @param string $html Pre-sanitized HTML
747 * @param string $time MW timestamp of file creation time
748 * @return string HTML
749 */
750 public static function makeMediaLinkObj( $title, $html = '', $time = false ) {
751 $img = wfFindFile( $title, [ 'time' => $time ] );
752 return self::makeMediaLinkFile( $title, $img, $html );
753 }
754
755 /**
756 * Create a direct link to a given uploaded file.
757 * This will make a broken link if $file is false.
758 *
759 * @since 1.16.3
760 * @param Title $title
761 * @param File|bool $file File object or false
762 * @param string $html Pre-sanitized HTML
763 * @return string HTML
764 *
765 * @todo Handle invalid or missing images better.
766 */
767 public static function makeMediaLinkFile( Title $title, $file, $html = '' ) {
768 if ( $file && $file->exists() ) {
769 $url = $file->getUrl();
770 $class = 'internal';
771 } else {
772 $url = self::getUploadUrl( $title );
773 $class = 'new';
774 }
775
776 $alt = $title->getText();
777 if ( $html == '' ) {
778 $html = $alt;
779 }
780
781 $ret = '';
782 $attribs = [
783 'href' => $url,
784 'class' => $class,
785 'title' => $alt
786 ];
787
788 if ( !Hooks::run( 'LinkerMakeMediaLinkFile',
789 [ $title, $file, &$html, &$attribs, &$ret ] ) ) {
790 wfDebug( "Hook LinkerMakeMediaLinkFile changed the output of link "
791 . "with url {$url} and text {$html} to {$ret}\n", true );
792 return $ret;
793 }
794
795 return Html::rawElement( 'a', $attribs, $html );
796 }
797
798 /**
799 * Make a link to a special page given its name and, optionally,
800 * a message key from the link text.
801 * Usage example: Linker::specialLink( 'Recentchanges' )
802 *
803 * @since 1.16.3
804 * @param string $name
805 * @param string $key
806 * @return string
807 */
808 public static function specialLink( $name, $key = '' ) {
809 if ( $key == '' ) {
810 $key = strtolower( $name );
811 }
812
813 return self::linkKnown( SpecialPage::getTitleFor( $name ), wfMessage( $key )->escaped() );
814 }
815
816 /**
817 * Make an external link
818 * @since 1.16.3. $title added in 1.21
819 * @param string $url URL to link to
820 * @param string $text Text of link
821 * @param bool $escape Do we escape the link text?
822 * @param string $linktype Type of external link. Gets added to the classes
823 * @param array $attribs Array of extra attributes to <a>
824 * @param Title|null $title Title object used for title specific link attributes
825 * @return string
826 */
827 public static function makeExternalLink( $url, $text, $escape = true,
828 $linktype = '', $attribs = [], $title = null
829 ) {
830 global $wgTitle;
831 $class = "external";
832 if ( $linktype ) {
833 $class .= " $linktype";
834 }
835 if ( isset( $attribs['class'] ) && $attribs['class'] ) {
836 $class .= " {$attribs['class']}";
837 }
838 $attribs['class'] = $class;
839
840 if ( $escape ) {
841 $text = htmlspecialchars( $text );
842 }
843
844 if ( !$title ) {
845 $title = $wgTitle;
846 }
847 $newRel = Parser::getExternalLinkRel( $url, $title );
848 if ( !isset( $attribs['rel'] ) || $attribs['rel'] === '' ) {
849 $attribs['rel'] = $newRel;
850 } elseif ( $newRel !== '' ) {
851 // Merge the rel attributes.
852 $newRels = explode( ' ', $newRel );
853 $oldRels = explode( ' ', $attribs['rel'] );
854 $combined = array_unique( array_merge( $newRels, $oldRels ) );
855 $attribs['rel'] = implode( ' ', $combined );
856 }
857 $link = '';
858 $success = Hooks::run( 'LinkerMakeExternalLink',
859 [ &$url, &$text, &$link, &$attribs, $linktype ] );
860 if ( !$success ) {
861 wfDebug( "Hook LinkerMakeExternalLink changed the output of link "
862 . "with url {$url} and text {$text} to {$link}\n", true );
863 return $link;
864 }
865 $attribs['href'] = $url;
866 return Html::rawElement( 'a', $attribs, $text );
867 }
868
869 /**
870 * Make user link (or user contributions for unregistered users)
871 * @param int $userId User id in database.
872 * @param string $userName User name in database.
873 * @param string $altUserName Text to display instead of the user name (optional)
874 * @return string HTML fragment
875 * @since 1.16.3. $altUserName was added in 1.19.
876 */
877 public static function userLink( $userId, $userName, $altUserName = false ) {
878 $classes = 'mw-userlink';
879 $page = null;
880 if ( $userId == 0 ) {
881 $page = ExternalUserNames::getUserLinkTitle( $userName );
882
883 if ( ExternalUserNames::isExternal( $userName ) ) {
884 $classes .= ' mw-extuserlink';
885 } elseif ( $altUserName === false ) {
886 $altUserName = IP::prettifyIP( $userName );
887 }
888 $classes .= ' mw-anonuserlink'; // Separate link class for anons (T45179)
889 } else {
890 $page = Title::makeTitle( NS_USER, $userName );
891 }
892
893 // Wrap the output with <bdi> tags for directionality isolation
894 $linkText =
895 '<bdi>' . htmlspecialchars( $altUserName !== false ? $altUserName : $userName ) . '</bdi>';
896
897 return $page
898 ? self::link( $page, $linkText, [ 'class' => $classes ] )
899 : Html::rawElement( 'span', [ 'class' => $classes ], $linkText );
900 }
901
902 /**
903 * Generate standard user tool links (talk, contributions, block link, etc.)
904 *
905 * @since 1.16.3
906 * @param int $userId User identifier
907 * @param string $userText User name or IP address
908 * @param bool $redContribsWhenNoEdits Should the contributions link be
909 * red if the user has no edits?
910 * @param int $flags Customisation flags (e.g. Linker::TOOL_LINKS_NOBLOCK
911 * and Linker::TOOL_LINKS_EMAIL).
912 * @param int|null $edits User edit count (optional, for performance)
913 * @return string HTML fragment
914 */
915 public static function userToolLinks(
916 $userId, $userText, $redContribsWhenNoEdits = false, $flags = 0, $edits = null
917 ) {
918 global $wgUser, $wgDisableAnonTalk, $wgLang;
919 $talkable = !( $wgDisableAnonTalk && $userId == 0 );
920 $blockable = !( $flags & self::TOOL_LINKS_NOBLOCK );
921 $addEmailLink = $flags & self::TOOL_LINKS_EMAIL && $userId;
922
923 if ( $userId == 0 && ExternalUserNames::isExternal( $userText ) ) {
924 // No tools for an external user
925 return '';
926 }
927
928 $items = [];
929 if ( $talkable ) {
930 $items[] = self::userTalkLink( $userId, $userText );
931 }
932 if ( $userId ) {
933 // check if the user has an edit
934 $attribs = [];
935 $attribs['class'] = 'mw-usertoollinks-contribs';
936 if ( $redContribsWhenNoEdits ) {
937 if ( intval( $edits ) === 0 && $edits !== 0 ) {
938 $user = User::newFromId( $userId );
939 $edits = $user->getEditCount();
940 }
941 if ( $edits === 0 ) {
942 $attribs['class'] .= ' new';
943 }
944 }
945 $contribsPage = SpecialPage::getTitleFor( 'Contributions', $userText );
946
947 $items[] = self::link( $contribsPage, wfMessage( 'contribslink' )->escaped(), $attribs );
948 }
949 if ( $blockable && $wgUser->isAllowed( 'block' ) ) {
950 $items[] = self::blockLink( $userId, $userText );
951 }
952
953 if ( $addEmailLink && $wgUser->canSendEmail() ) {
954 $items[] = self::emailLink( $userId, $userText );
955 }
956
957 Hooks::run( 'UserToolLinksEdit', [ $userId, $userText, &$items ] );
958
959 if ( $items ) {
960 return wfMessage( 'word-separator' )->escaped()
961 . '<span class="mw-usertoollinks">'
962 . wfMessage( 'parentheses' )->rawParams( $wgLang->pipeList( $items ) )->escaped()
963 . '</span>';
964 } else {
965 return '';
966 }
967 }
968
969 /**
970 * Alias for userToolLinks( $userId, $userText, true );
971 * @since 1.16.3
972 * @param int $userId User identifier
973 * @param string $userText User name or IP address
974 * @param int|null $edits User edit count (optional, for performance)
975 * @return string
976 */
977 public static function userToolLinksRedContribs( $userId, $userText, $edits = null ) {
978 return self::userToolLinks( $userId, $userText, true, 0, $edits );
979 }
980
981 /**
982 * @since 1.16.3
983 * @param int $userId User id in database.
984 * @param string $userText User name in database.
985 * @return string HTML fragment with user talk link
986 */
987 public static function userTalkLink( $userId, $userText ) {
988 $userTalkPage = Title::makeTitle( NS_USER_TALK, $userText );
989 $moreLinkAttribs['class'] = 'mw-usertoollinks-talk';
990 $userTalkLink = self::link( $userTalkPage,
991 wfMessage( 'talkpagelinktext' )->escaped(),
992 $moreLinkAttribs );
993 return $userTalkLink;
994 }
995
996 /**
997 * @since 1.16.3
998 * @param int $userId
999 * @param string $userText User name in database.
1000 * @return string HTML fragment with block link
1001 */
1002 public static function blockLink( $userId, $userText ) {
1003 $blockPage = SpecialPage::getTitleFor( 'Block', $userText );
1004 $moreLinkAttribs['class'] = 'mw-usertoollinks-block';
1005 $blockLink = self::link( $blockPage,
1006 wfMessage( 'blocklink' )->escaped(),
1007 $moreLinkAttribs );
1008 return $blockLink;
1009 }
1010
1011 /**
1012 * @param int $userId
1013 * @param string $userText User name in database.
1014 * @return string HTML fragment with e-mail user link
1015 */
1016 public static function emailLink( $userId, $userText ) {
1017 $emailPage = SpecialPage::getTitleFor( 'Emailuser', $userText );
1018 $moreLinkAttribs['class'] = 'mw-usertoollinks-mail';
1019 $emailLink = self::link( $emailPage,
1020 wfMessage( 'emaillink' )->escaped(),
1021 $moreLinkAttribs );
1022 return $emailLink;
1023 }
1024
1025 /**
1026 * Generate a user link if the current user is allowed to view it
1027 * @since 1.16.3
1028 * @param Revision $rev
1029 * @param bool $isPublic Show only if all users can see it
1030 * @return string HTML fragment
1031 */
1032 public static function revUserLink( $rev, $isPublic = false ) {
1033 if ( $rev->isDeleted( Revision::DELETED_USER ) && $isPublic ) {
1034 $link = wfMessage( 'rev-deleted-user' )->escaped();
1035 } elseif ( $rev->userCan( Revision::DELETED_USER ) ) {
1036 $link = self::userLink( $rev->getUser( Revision::FOR_THIS_USER ),
1037 $rev->getUserText( Revision::FOR_THIS_USER ) );
1038 } else {
1039 $link = wfMessage( 'rev-deleted-user' )->escaped();
1040 }
1041 if ( $rev->isDeleted( Revision::DELETED_USER ) ) {
1042 return '<span class="history-deleted">' . $link . '</span>';
1043 }
1044 return $link;
1045 }
1046
1047 /**
1048 * Generate a user tool link cluster if the current user is allowed to view it
1049 * @since 1.16.3
1050 * @param Revision $rev
1051 * @param bool $isPublic Show only if all users can see it
1052 * @return string HTML
1053 */
1054 public static function revUserTools( $rev, $isPublic = false ) {
1055 if ( $rev->isDeleted( Revision::DELETED_USER ) && $isPublic ) {
1056 $link = wfMessage( 'rev-deleted-user' )->escaped();
1057 } elseif ( $rev->userCan( Revision::DELETED_USER ) ) {
1058 $userId = $rev->getUser( Revision::FOR_THIS_USER );
1059 $userText = $rev->getUserText( Revision::FOR_THIS_USER );
1060 $link = self::userLink( $userId, $userText )
1061 . self::userToolLinks( $userId, $userText );
1062 } else {
1063 $link = wfMessage( 'rev-deleted-user' )->escaped();
1064 }
1065 if ( $rev->isDeleted( Revision::DELETED_USER ) ) {
1066 return ' <span class="history-deleted">' . $link . '</span>';
1067 }
1068 return $link;
1069 }
1070
1071 /**
1072 * This function is called by all recent changes variants, by the page history,
1073 * and by the user contributions list. It is responsible for formatting edit
1074 * summaries. It escapes any HTML in the summary, but adds some CSS to format
1075 * auto-generated comments (from section editing) and formats [[wikilinks]].
1076 *
1077 * @author Erik Moeller <moeller@scireview.de>
1078 * @since 1.16.3. $wikiId added in 1.26
1079 *
1080 * @param string $comment
1081 * @param Title|null $title Title object (to generate link to the section in autocomment)
1082 * or null
1083 * @param bool $local Whether section links should refer to local page
1084 * @param string|null $wikiId Id (as used by WikiMap) of the wiki to generate links to.
1085 * For use with external changes.
1086 *
1087 * @return string HTML
1088 */
1089 public static function formatComment(
1090 $comment, $title = null, $local = false, $wikiId = null
1091 ) {
1092 # Sanitize text a bit:
1093 $comment = str_replace( "\n", " ", $comment );
1094 # Allow HTML entities (for T15815)
1095 $comment = Sanitizer::escapeHtmlAllowEntities( $comment );
1096
1097 # Render autocomments and make links:
1098 $comment = self::formatAutocomments( $comment, $title, $local, $wikiId );
1099 $comment = self::formatLinksInComment( $comment, $title, $local, $wikiId );
1100
1101 return $comment;
1102 }
1103
1104 /**
1105 * Converts autogenerated comments in edit summaries into section links.
1106 *
1107 * The pattern for autogen comments is / * foo * /, which makes for
1108 * some nasty regex.
1109 * We look for all comments, match any text before and after the comment,
1110 * add a separator where needed and format the comment itself with CSS
1111 * Called by Linker::formatComment.
1112 *
1113 * @param string $comment Comment text
1114 * @param Title|null $title An optional title object used to links to sections
1115 * @param bool $local Whether section links should refer to local page
1116 * @param string|null $wikiId Id of the wiki to link to (if not the local wiki),
1117 * as used by WikiMap.
1118 *
1119 * @return string Formatted comment (wikitext)
1120 */
1121 private static function formatAutocomments(
1122 $comment, $title = null, $local = false, $wikiId = null
1123 ) {
1124 // @todo $append here is something of a hack to preserve the status
1125 // quo. Someone who knows more about bidi and such should decide
1126 // (1) what sane rendering even *is* for an LTR edit summary on an RTL
1127 // wiki, both when autocomments exist and when they don't, and
1128 // (2) what markup will make that actually happen.
1129 $append = '';
1130 $comment = preg_replace_callback(
1131 // To detect the presence of content before or after the
1132 // auto-comment, we use capturing groups inside optional zero-width
1133 // assertions. But older versions of PCRE can't directly make
1134 // zero-width assertions optional, so wrap them in a non-capturing
1135 // group.
1136 '!(?:(?<=(.)))?/\*\s*(.*?)\s*\*/(?:(?=(.)))?!',
1137 function ( $match ) use ( $title, $local, $wikiId, &$append ) {
1138 global $wgLang;
1139
1140 // Ensure all match positions are defined
1141 $match += [ '', '', '', '' ];
1142
1143 $pre = $match[1] !== '';
1144 $auto = $match[2];
1145 $post = $match[3] !== '';
1146 $comment = null;
1147
1148 Hooks::run(
1149 'FormatAutocomments',
1150 [ &$comment, $pre, $auto, $post, $title, $local, $wikiId ]
1151 );
1152
1153 if ( $comment === null ) {
1154 if ( $title ) {
1155 $section = $auto;
1156 # Remove links that a user may have manually put in the autosummary
1157 # This could be improved by copying as much of Parser::stripSectionName as desired.
1158 $section = str_replace( '[[:', '', $section );
1159 $section = str_replace( '[[', '', $section );
1160 $section = str_replace( ']]', '', $section );
1161
1162 // We don't want any links in the auto text to be linked, but we still
1163 // want to show any [[ ]]
1164 $sectionText = str_replace( '[[', '&#91;[', $auto );
1165
1166 $section = substr( Parser::guessSectionNameFromStrippedText( $section ), 1 );
1167 if ( $local ) {
1168 $sectionTitle = Title::makeTitleSafe( NS_MAIN, '', $section );
1169 } else {
1170 $sectionTitle = Title::makeTitleSafe( $title->getNamespace(),
1171 $title->getDBkey(), $section );
1172 }
1173 if ( $sectionTitle ) {
1174 $auto = Linker::makeCommentLink(
1175 $sectionTitle, $wgLang->getArrow() . $wgLang->getDirMark() . $sectionText,
1176 $wikiId, 'noclasses'
1177 );
1178 }
1179 }
1180 if ( $pre ) {
1181 # written summary $presep autocomment (summary /* section */)
1182 $pre = wfMessage( 'autocomment-prefix' )->inContentLanguage()->escaped();
1183 }
1184 if ( $post ) {
1185 # autocomment $postsep written summary (/* section */ summary)
1186 $auto .= wfMessage( 'colon-separator' )->inContentLanguage()->escaped();
1187 }
1188 if ( $auto ) {
1189 $auto = '<span dir="auto"><span class="autocomment">' . $auto . '</span>';
1190 $append .= '</span>';
1191 }
1192 $comment = $pre . $auto;
1193 }
1194 return $comment;
1195 },
1196 $comment
1197 );
1198 return $comment . $append;
1199 }
1200
1201 /**
1202 * Formats wiki links and media links in text; all other wiki formatting
1203 * is ignored
1204 *
1205 * @since 1.16.3. $wikiId added in 1.26
1206 * @todo FIXME: Doesn't handle sub-links as in image thumb texts like the main parser
1207 *
1208 * @param string $comment Text to format links in. WARNING! Since the output of this
1209 * function is html, $comment must be sanitized for use as html. You probably want
1210 * to pass $comment through Sanitizer::escapeHtmlAllowEntities() before calling
1211 * this function.
1212 * @param Title|null $title An optional title object used to links to sections
1213 * @param bool $local Whether section links should refer to local page
1214 * @param string|null $wikiId Id of the wiki to link to (if not the local wiki),
1215 * as used by WikiMap.
1216 *
1217 * @return string HTML
1218 * @return-taint onlysafefor_html
1219 */
1220 public static function formatLinksInComment(
1221 $comment, $title = null, $local = false, $wikiId = null
1222 ) {
1223 return preg_replace_callback(
1224 '/
1225 \[\[
1226 \s*+ # ignore leading whitespace, the *+ quantifier disallows backtracking
1227 :? # ignore optional leading colon
1228 ([^\]|]+) # 1. link target; page names cannot include ] or |
1229 (?:\|
1230 # 2. link text
1231 # Stop matching at ]] without relying on backtracking.
1232 ((?:]?[^\]])*+)
1233 )?
1234 \]\]
1235 ([^[]*) # 3. link trail (the text up until the next link)
1236 /x',
1237 function ( $match ) use ( $title, $local, $wikiId ) {
1238 $medians = '(?:' . preg_quote( MWNamespace::getCanonicalName( NS_MEDIA ), '/' ) . '|';
1239 $medians .= preg_quote(
1240 MediaWikiServices::getInstance()->getContentLanguage()->getNsText( NS_MEDIA ),
1241 '/'
1242 ) . '):';
1243
1244 $comment = $match[0];
1245
1246 # fix up urlencoded title texts (copied from Parser::replaceInternalLinks)
1247 if ( strpos( $match[1], '%' ) !== false ) {
1248 $match[1] = strtr(
1249 rawurldecode( $match[1] ),
1250 [ '<' => '&lt;', '>' => '&gt;' ]
1251 );
1252 }
1253
1254 # Handle link renaming [[foo|text]] will show link as "text"
1255 if ( $match[2] != "" ) {
1256 $text = $match[2];
1257 } else {
1258 $text = $match[1];
1259 }
1260 $submatch = [];
1261 $thelink = null;
1262 if ( preg_match( '/^' . $medians . '(.*)$/i', $match[1], $submatch ) ) {
1263 # Media link; trail not supported.
1264 $linkRegexp = '/\[\[(.*?)\]\]/';
1265 $title = Title::makeTitleSafe( NS_FILE, $submatch[1] );
1266 if ( $title ) {
1267 $thelink = Linker::makeMediaLinkObj( $title, $text );
1268 }
1269 } else {
1270 # Other kind of link
1271 # Make sure its target is non-empty
1272 if ( isset( $match[1][0] ) && $match[1][0] == ':' ) {
1273 $match[1] = substr( $match[1], 1 );
1274 }
1275 if ( $match[1] !== false && $match[1] !== '' ) {
1276 if ( preg_match(
1277 MediaWikiServices::getInstance()->getContentLanguage()->linkTrail(),
1278 $match[3],
1279 $submatch
1280 ) ) {
1281 $trail = $submatch[1];
1282 } else {
1283 $trail = "";
1284 }
1285 $linkRegexp = '/\[\[(.*?)\]\]' . preg_quote( $trail, '/' ) . '/';
1286 list( $inside, $trail ) = Linker::splitTrail( $trail );
1287
1288 $linkText = $text;
1289 $linkTarget = Linker::normalizeSubpageLink( $title, $match[1], $linkText );
1290
1291 $target = Title::newFromText( $linkTarget );
1292 if ( $target ) {
1293 if ( $target->getText() == '' && !$target->isExternal()
1294 && !$local && $title
1295 ) {
1296 $target = $title->createFragmentTarget( $target->getFragment() );
1297 }
1298
1299 $thelink = Linker::makeCommentLink( $target, $linkText . $inside, $wikiId ) . $trail;
1300 }
1301 }
1302 }
1303 if ( $thelink ) {
1304 // If the link is still valid, go ahead and replace it in!
1305 $comment = preg_replace(
1306 $linkRegexp,
1307 StringUtils::escapeRegexReplacement( $thelink ),
1308 $comment,
1309 1
1310 );
1311 }
1312
1313 return $comment;
1314 },
1315 $comment
1316 );
1317 }
1318
1319 /**
1320 * Generates a link to the given Title
1321 *
1322 * @note This is only public for technical reasons. It's not intended for use outside Linker.
1323 *
1324 * @param LinkTarget $linkTarget
1325 * @param string $text
1326 * @param string|null $wikiId Id of the wiki to link to (if not the local wiki),
1327 * as used by WikiMap.
1328 * @param string|string[] $options See the $options parameter in Linker::link.
1329 *
1330 * @return string HTML link
1331 */
1332 public static function makeCommentLink(
1333 LinkTarget $linkTarget, $text, $wikiId = null, $options = []
1334 ) {
1335 if ( $wikiId !== null && !$linkTarget->isExternal() ) {
1336 $link = self::makeExternalLink(
1337 WikiMap::getForeignURL(
1338 $wikiId,
1339 $linkTarget->getNamespace() === 0
1340 ? $linkTarget->getDBkey()
1341 : MWNamespace::getCanonicalName( $linkTarget->getNamespace() ) . ':'
1342 . $linkTarget->getDBkey(),
1343 $linkTarget->getFragment()
1344 ),
1345 $text,
1346 /* escape = */ false // Already escaped
1347 );
1348 } else {
1349 $link = self::link( $linkTarget, $text, [], [], $options );
1350 }
1351
1352 return $link;
1353 }
1354
1355 /**
1356 * @param Title $contextTitle
1357 * @param string $target
1358 * @param string &$text
1359 * @return string
1360 */
1361 public static function normalizeSubpageLink( $contextTitle, $target, &$text ) {
1362 # Valid link forms:
1363 # Foobar -- normal
1364 # :Foobar -- override special treatment of prefix (images, language links)
1365 # /Foobar -- convert to CurrentPage/Foobar
1366 # /Foobar/ -- convert to CurrentPage/Foobar, strip the initial and final / from text
1367 # ../ -- convert to CurrentPage, from CurrentPage/CurrentSubPage
1368 # ../Foobar -- convert to CurrentPage/Foobar,
1369 # (from CurrentPage/CurrentSubPage)
1370 # ../Foobar/ -- convert to CurrentPage/Foobar, use 'Foobar' as text
1371 # (from CurrentPage/CurrentSubPage)
1372
1373 $ret = $target; # default return value is no change
1374
1375 # Some namespaces don't allow subpages,
1376 # so only perform processing if subpages are allowed
1377 if ( $contextTitle && MWNamespace::hasSubpages( $contextTitle->getNamespace() ) ) {
1378 $hash = strpos( $target, '#' );
1379 if ( $hash !== false ) {
1380 $suffix = substr( $target, $hash );
1381 $target = substr( $target, 0, $hash );
1382 } else {
1383 $suffix = '';
1384 }
1385 # T9425
1386 $target = trim( $target );
1387 # Look at the first character
1388 if ( $target != '' && $target[0] === '/' ) {
1389 # / at end means we don't want the slash to be shown
1390 $m = [];
1391 $trailingSlashes = preg_match_all( '%(/+)$%', $target, $m );
1392 if ( $trailingSlashes ) {
1393 $noslash = $target = substr( $target, 1, -strlen( $m[0][0] ) );
1394 } else {
1395 $noslash = substr( $target, 1 );
1396 }
1397
1398 $ret = $contextTitle->getPrefixedText() . '/' . trim( $noslash ) . $suffix;
1399 if ( $text === '' ) {
1400 $text = $target . $suffix;
1401 } # this might be changed for ugliness reasons
1402 } else {
1403 # check for .. subpage backlinks
1404 $dotdotcount = 0;
1405 $nodotdot = $target;
1406 while ( strncmp( $nodotdot, "../", 3 ) == 0 ) {
1407 ++$dotdotcount;
1408 $nodotdot = substr( $nodotdot, 3 );
1409 }
1410 if ( $dotdotcount > 0 ) {
1411 $exploded = explode( '/', $contextTitle->getPrefixedText() );
1412 if ( count( $exploded ) > $dotdotcount ) { # not allowed to go below top level page
1413 $ret = implode( '/', array_slice( $exploded, 0, -$dotdotcount ) );
1414 # / at the end means don't show full path
1415 if ( substr( $nodotdot, -1, 1 ) === '/' ) {
1416 $nodotdot = rtrim( $nodotdot, '/' );
1417 if ( $text === '' ) {
1418 $text = $nodotdot . $suffix;
1419 }
1420 }
1421 $nodotdot = trim( $nodotdot );
1422 if ( $nodotdot != '' ) {
1423 $ret .= '/' . $nodotdot;
1424 }
1425 $ret .= $suffix;
1426 }
1427 }
1428 }
1429 }
1430
1431 return $ret;
1432 }
1433
1434 /**
1435 * Wrap a comment in standard punctuation and formatting if
1436 * it's non-empty, otherwise return empty string.
1437 *
1438 * @since 1.16.3. $wikiId added in 1.26
1439 * @param string $comment
1440 * @param Title|null $title Title object (to generate link to section in autocomment) or null
1441 * @param bool $local Whether section links should refer to local page
1442 * @param string|null $wikiId Id (as used by WikiMap) of the wiki to generate links to.
1443 * For use with external changes.
1444 *
1445 * @return string
1446 */
1447 public static function commentBlock(
1448 $comment, $title = null, $local = false, $wikiId = null, $useParentheses = true
1449 ) {
1450 // '*' used to be the comment inserted by the software way back
1451 // in antiquity in case none was provided, here for backwards
1452 // compatibility, acc. to brion -ævar
1453 if ( $comment == '' || $comment == '*' ) {
1454 return '';
1455 } else {
1456 $formatted = self::formatComment( $comment, $title, $local, $wikiId );
1457 if ( $useParentheses ) {
1458 $formatted = wfMessage( 'parentheses' )->rawParams( $formatted )->escaped();
1459 $classNames = 'comment';
1460 } else {
1461 $classNames = 'comment comment--without-parentheses';
1462 }
1463 return " <span class=\"$classNames\">$formatted</span>";
1464 }
1465 }
1466
1467 /**
1468 * Wrap and format the given revision's comment block, if the current
1469 * user is allowed to view it.
1470 *
1471 * @since 1.16.3
1472 * @param Revision $rev
1473 * @param bool $local Whether section links should refer to local page
1474 * @param bool $isPublic Show only if all users can see it
1475 * @param bool $useParentheses (optional) Wrap comments in parentheses where needed
1476 * @return string HTML fragment
1477 */
1478 public static function revComment( Revision $rev, $local = false, $isPublic = false,
1479 $useParentheses = true
1480 ) {
1481 if ( $rev->getComment( Revision::RAW ) == "" ) {
1482 return "";
1483 }
1484 if ( $rev->isDeleted( Revision::DELETED_COMMENT ) && $isPublic ) {
1485 $block = " <span class=\"comment\">" . wfMessage( 'rev-deleted-comment' )->escaped() . "</span>";
1486 } elseif ( $rev->userCan( Revision::DELETED_COMMENT ) ) {
1487 $block = self::commentBlock( $rev->getComment( Revision::FOR_THIS_USER ),
1488 $rev->getTitle(), $local, null, $useParentheses );
1489 } else {
1490 $block = " <span class=\"comment\">" . wfMessage( 'rev-deleted-comment' )->escaped() . "</span>";
1491 }
1492 if ( $rev->isDeleted( Revision::DELETED_COMMENT ) ) {
1493 return " <span class=\"history-deleted\">$block</span>";
1494 }
1495 return $block;
1496 }
1497
1498 /**
1499 * @since 1.16.3
1500 * @param int $size
1501 * @return string
1502 */
1503 public static function formatRevisionSize( $size ) {
1504 if ( $size == 0 ) {
1505 $stxt = wfMessage( 'historyempty' )->escaped();
1506 } else {
1507 $stxt = wfMessage( 'nbytes' )->numParams( $size )->escaped();
1508 $stxt = wfMessage( 'parentheses' )->rawParams( $stxt )->escaped();
1509 }
1510 return "<span class=\"history-size\">$stxt</span>";
1511 }
1512
1513 /**
1514 * Add another level to the Table of Contents
1515 *
1516 * @since 1.16.3
1517 * @return string
1518 */
1519 public static function tocIndent() {
1520 return "\n<ul>\n";
1521 }
1522
1523 /**
1524 * Finish one or more sublevels on the Table of Contents
1525 *
1526 * @since 1.16.3
1527 * @param int $level
1528 * @return string
1529 */
1530 public static function tocUnindent( $level ) {
1531 return "</li>\n" . str_repeat( "</ul>\n</li>\n", $level > 0 ? $level : 0 );
1532 }
1533
1534 /**
1535 * parameter level defines if we are on an indentation level
1536 *
1537 * @since 1.16.3
1538 * @param string $anchor
1539 * @param string $tocline
1540 * @param string $tocnumber
1541 * @param string $level
1542 * @param string|bool $sectionIndex
1543 * @return string
1544 */
1545 public static function tocLine( $anchor, $tocline, $tocnumber, $level, $sectionIndex = false ) {
1546 $classes = "toclevel-$level";
1547 if ( $sectionIndex !== false ) {
1548 $classes .= " tocsection-$sectionIndex";
1549 }
1550
1551 // <li class="$classes"><a href="#$anchor"><span class="tocnumber">
1552 // $tocnumber</span> <span class="toctext">$tocline</span></a>
1553 return Html::openElement( 'li', [ 'class' => $classes ] )
1554 . Html::rawElement( 'a',
1555 [ 'href' => "#$anchor" ],
1556 Html::element( 'span', [ 'class' => 'tocnumber' ], $tocnumber )
1557 . ' '
1558 . Html::rawElement( 'span', [ 'class' => 'toctext' ], $tocline )
1559 );
1560 }
1561
1562 /**
1563 * End a Table Of Contents line.
1564 * tocUnindent() will be used instead if we're ending a line below
1565 * the new level.
1566 * @since 1.16.3
1567 * @return string
1568 */
1569 public static function tocLineEnd() {
1570 return "</li>\n";
1571 }
1572
1573 /**
1574 * Wraps the TOC in a table and provides the hide/collapse javascript.
1575 *
1576 * @since 1.16.3
1577 * @param string $toc Html of the Table Of Contents
1578 * @param string|Language|bool $lang Language for the toc title, defaults to user language
1579 * @return string Full html of the TOC
1580 */
1581 public static function tocList( $toc, $lang = false ) {
1582 $lang = wfGetLangObj( $lang );
1583 $title = wfMessage( 'toc' )->inLanguage( $lang )->escaped();
1584
1585 return '<div id="toc" class="toc">'
1586 . Html::element( 'input', [
1587 'type' => 'checkbox',
1588 'role' => 'button',
1589 'id' => 'toctogglecheckbox',
1590 'class' => 'toctogglecheckbox',
1591 'style' => 'display:none',
1592 ] )
1593 . Html::openElement( 'div', [
1594 'class' => 'toctitle',
1595 'lang' => $lang->getHtmlCode(),
1596 'dir' => $lang->getDir(),
1597 ] )
1598 . "<h2>$title</h2>"
1599 . '<span class="toctogglespan">'
1600 . Html::label( '', 'toctogglecheckbox', [
1601 'class' => 'toctogglelabel',
1602 ] )
1603 . '</span>'
1604 . "</div>\n"
1605 . $toc
1606 . "</ul>\n</div>\n";
1607 }
1608
1609 /**
1610 * Generate a table of contents from a section tree.
1611 *
1612 * @since 1.16.3. $lang added in 1.17
1613 * @param array $tree Return value of ParserOutput::getSections()
1614 * @param string|Language|bool $lang Language for the toc title, defaults to user language
1615 * @return string HTML fragment
1616 */
1617 public static function generateTOC( $tree, $lang = false ) {
1618 $toc = '';
1619 $lastLevel = 0;
1620 foreach ( $tree as $section ) {
1621 if ( $section['toclevel'] > $lastLevel ) {
1622 $toc .= self::tocIndent();
1623 } elseif ( $section['toclevel'] < $lastLevel ) {
1624 $toc .= self::tocUnindent(
1625 $lastLevel - $section['toclevel'] );
1626 } else {
1627 $toc .= self::tocLineEnd();
1628 }
1629
1630 $toc .= self::tocLine( $section['anchor'],
1631 $section['line'], $section['number'],
1632 $section['toclevel'], $section['index'] );
1633 $lastLevel = $section['toclevel'];
1634 }
1635 $toc .= self::tocLineEnd();
1636 return self::tocList( $toc, $lang );
1637 }
1638
1639 /**
1640 * Create a headline for content
1641 *
1642 * @since 1.16.3
1643 * @param int $level The level of the headline (1-6)
1644 * @param string $attribs Any attributes for the headline, starting with
1645 * a space and ending with '>'
1646 * This *must* be at least '>' for no attribs
1647 * @param string $anchor The anchor to give the headline (the bit after the #)
1648 * @param string $html HTML for the text of the header
1649 * @param string $link HTML to add for the section edit link
1650 * @param string|bool $fallbackAnchor A second, optional anchor to give for
1651 * backward compatibility (false to omit)
1652 *
1653 * @return string HTML headline
1654 */
1655 public static function makeHeadline( $level, $attribs, $anchor, $html,
1656 $link, $fallbackAnchor = false
1657 ) {
1658 $anchorEscaped = htmlspecialchars( $anchor );
1659 $fallback = '';
1660 if ( $fallbackAnchor !== false && $fallbackAnchor !== $anchor ) {
1661 $fallbackAnchor = htmlspecialchars( $fallbackAnchor );
1662 $fallback = "<span id=\"$fallbackAnchor\"></span>";
1663 }
1664 $ret = "<h$level$attribs"
1665 . "$fallback<span class=\"mw-headline\" id=\"$anchorEscaped\">$html</span>"
1666 . $link
1667 . "</h$level>";
1668
1669 return $ret;
1670 }
1671
1672 /**
1673 * Split a link trail, return the "inside" portion and the remainder of the trail
1674 * as a two-element array
1675 * @param string $trail
1676 * @return array
1677 */
1678 static function splitTrail( $trail ) {
1679 $regex = MediaWikiServices::getInstance()->getContentLanguage()->linkTrail();
1680 $inside = '';
1681 if ( $trail !== '' ) {
1682 $m = [];
1683 if ( preg_match( $regex, $trail, $m ) ) {
1684 $inside = $m[1];
1685 $trail = $m[2];
1686 }
1687 }
1688 return [ $inside, $trail ];
1689 }
1690
1691 /**
1692 * Generate a rollback link for a given revision. Currently it's the
1693 * caller's responsibility to ensure that the revision is the top one. If
1694 * it's not, of course, the user will get an error message.
1695 *
1696 * If the calling page is called with the parameter &bot=1, all rollback
1697 * links also get that parameter. It causes the edit itself and the rollback
1698 * to be marked as "bot" edits. Bot edits are hidden by default from recent
1699 * changes, so this allows sysops to combat a busy vandal without bothering
1700 * other users.
1701 *
1702 * If the option verify is set this function will return the link only in case the
1703 * revision can be reverted. Please note that due to performance limitations
1704 * it might be assumed that a user isn't the only contributor of a page while
1705 * (s)he is, which will lead to useless rollback links. Furthermore this wont
1706 * work if $wgShowRollbackEditCount is disabled, so this can only function
1707 * as an additional check.
1708 *
1709 * If the option noBrackets is set the rollback link wont be enclosed in "[]".
1710 *
1711 * @since 1.16.3. $context added in 1.20. $options added in 1.21
1712 *
1713 * @param Revision $rev
1714 * @param IContextSource|null $context Context to use or null for the main context.
1715 * @param array $options
1716 * @return string
1717 */
1718 public static function generateRollback( $rev, IContextSource $context = null,
1719 $options = [ 'verify' ]
1720 ) {
1721 if ( $context === null ) {
1722 $context = RequestContext::getMain();
1723 }
1724
1725 $editCount = false;
1726 if ( in_array( 'verify', $options, true ) ) {
1727 $editCount = self::getRollbackEditCount( $rev, true );
1728 if ( $editCount === false ) {
1729 return '';
1730 }
1731 }
1732
1733 $inner = self::buildRollbackLink( $rev, $context, $editCount );
1734
1735 if ( !in_array( 'noBrackets', $options, true ) ) {
1736 $inner = $context->msg( 'brackets' )->rawParams( $inner )->escaped();
1737 }
1738
1739 return '<span class="mw-rollback-link">' . $inner . '</span>';
1740 }
1741
1742 /**
1743 * This function will return the number of revisions which a rollback
1744 * would revert and, if $verify is set it will verify that a revision
1745 * can be reverted (that the user isn't the only contributor and the
1746 * revision we might rollback to isn't deleted). These checks can only
1747 * function as an additional check as this function only checks against
1748 * the last $wgShowRollbackEditCount edits.
1749 *
1750 * Returns null if $wgShowRollbackEditCount is disabled or false if $verify
1751 * is set and the user is the only contributor of the page.
1752 *
1753 * @param Revision $rev
1754 * @param bool $verify Try to verify that this revision can really be rolled back
1755 * @return int|bool|null
1756 */
1757 public static function getRollbackEditCount( $rev, $verify ) {
1758 global $wgShowRollbackEditCount;
1759 if ( !is_int( $wgShowRollbackEditCount ) || !$wgShowRollbackEditCount > 0 ) {
1760 // Nothing has happened, indicate this by returning 'null'
1761 return null;
1762 }
1763
1764 $dbr = wfGetDB( DB_REPLICA );
1765
1766 // Up to the value of $wgShowRollbackEditCount revisions are counted
1767 $revQuery = Revision::getQueryInfo();
1768 $res = $dbr->select(
1769 $revQuery['tables'],
1770 [ 'rev_user_text' => $revQuery['fields']['rev_user_text'], 'rev_deleted' ],
1771 // $rev->getPage() returns null sometimes
1772 [ 'rev_page' => $rev->getTitle()->getArticleID() ],
1773 __METHOD__,
1774 [
1775 'USE INDEX' => [ 'revision' => 'page_timestamp' ],
1776 'ORDER BY' => 'rev_timestamp DESC',
1777 'LIMIT' => $wgShowRollbackEditCount + 1
1778 ],
1779 $revQuery['joins']
1780 );
1781
1782 $editCount = 0;
1783 $moreRevs = false;
1784 foreach ( $res as $row ) {
1785 if ( $rev->getUserText( Revision::RAW ) != $row->rev_user_text ) {
1786 if ( $verify &&
1787 ( $row->rev_deleted & Revision::DELETED_TEXT
1788 || $row->rev_deleted & Revision::DELETED_USER
1789 ) ) {
1790 // If the user or the text of the revision we might rollback
1791 // to is deleted in some way we can't rollback. Similar to
1792 // the sanity checks in WikiPage::commitRollback.
1793 return false;
1794 }
1795 $moreRevs = true;
1796 break;
1797 }
1798 $editCount++;
1799 }
1800
1801 if ( $verify && $editCount <= $wgShowRollbackEditCount && !$moreRevs ) {
1802 // We didn't find at least $wgShowRollbackEditCount revisions made by the current user
1803 // and there weren't any other revisions. That means that the current user is the only
1804 // editor, so we can't rollback
1805 return false;
1806 }
1807 return $editCount;
1808 }
1809
1810 /**
1811 * Build a raw rollback link, useful for collections of "tool" links
1812 *
1813 * @since 1.16.3. $context added in 1.20. $editCount added in 1.21
1814 * @param Revision $rev
1815 * @param IContextSource|null $context Context to use or null for the main context.
1816 * @param int $editCount Number of edits that would be reverted
1817 * @return string HTML fragment
1818 */
1819 public static function buildRollbackLink( $rev, IContextSource $context = null,
1820 $editCount = false
1821 ) {
1822 global $wgShowRollbackEditCount, $wgMiserMode;
1823
1824 // To config which pages are affected by miser mode
1825 $disableRollbackEditCountSpecialPage = [ 'Recentchanges', 'Watchlist' ];
1826
1827 if ( $context === null ) {
1828 $context = RequestContext::getMain();
1829 }
1830
1831 $title = $rev->getTitle();
1832 $query = [
1833 'action' => 'rollback',
1834 'from' => $rev->getUserText(),
1835 'token' => $context->getUser()->getEditToken( 'rollback' ),
1836 ];
1837 $attrs = [
1838 'data-mw' => 'interface',
1839 'title' => $context->msg( 'tooltip-rollback' )->text(),
1840 ];
1841 $options = [ 'known', 'noclasses' ];
1842
1843 if ( $context->getRequest()->getBool( 'bot' ) ) {
1844 $query['bot'] = '1';
1845 $query['hidediff'] = '1'; // T17999
1846 }
1847
1848 $disableRollbackEditCount = false;
1849 if ( $wgMiserMode ) {
1850 foreach ( $disableRollbackEditCountSpecialPage as $specialPage ) {
1851 if ( $context->getTitle()->isSpecial( $specialPage ) ) {
1852 $disableRollbackEditCount = true;
1853 break;
1854 }
1855 }
1856 }
1857
1858 if ( !$disableRollbackEditCount
1859 && is_int( $wgShowRollbackEditCount )
1860 && $wgShowRollbackEditCount > 0
1861 ) {
1862 if ( !is_numeric( $editCount ) ) {
1863 $editCount = self::getRollbackEditCount( $rev, false );
1864 }
1865
1866 if ( $editCount > $wgShowRollbackEditCount ) {
1867 $html = $context->msg( 'rollbacklinkcount-morethan' )
1868 ->numParams( $wgShowRollbackEditCount )->parse();
1869 } else {
1870 $html = $context->msg( 'rollbacklinkcount' )->numParams( $editCount )->parse();
1871 }
1872
1873 return self::link( $title, $html, $attrs, $query, $options );
1874 } else {
1875 $html = $context->msg( 'rollbacklink' )->escaped();
1876 return self::link( $title, $html, $attrs, $query, $options );
1877 }
1878 }
1879
1880 /**
1881 * @deprecated since 1.28, use TemplatesOnThisPageFormatter directly
1882 *
1883 * Returns HTML for the "templates used on this page" list.
1884 *
1885 * Make an HTML list of templates, and then add a "More..." link at
1886 * the bottom. If $more is null, do not add a "More..." link. If $more
1887 * is a Title, make a link to that title and use it. If $more is a string,
1888 * directly paste it in as the link (escaping needs to be done manually).
1889 * Finally, if $more is a Message, call toString().
1890 *
1891 * @since 1.16.3. $more added in 1.21
1892 * @param Title[] $templates Array of templates
1893 * @param bool $preview Whether this is for a preview
1894 * @param bool $section Whether this is for a section edit
1895 * @param Title|Message|string|null $more An escaped link for "More..." of the templates
1896 * @return string HTML output
1897 */
1898 public static function formatTemplates( $templates, $preview = false,
1899 $section = false, $more = null
1900 ) {
1901 wfDeprecated( __METHOD__, '1.28' );
1902
1903 $type = false;
1904 if ( $preview ) {
1905 $type = 'preview';
1906 } elseif ( $section ) {
1907 $type = 'section';
1908 }
1909
1910 if ( $more instanceof Message ) {
1911 $more = $more->toString();
1912 }
1913
1914 $formatter = new TemplatesOnThisPageFormatter(
1915 RequestContext::getMain(),
1916 MediaWikiServices::getInstance()->getLinkRenderer()
1917 );
1918 return $formatter->format( $templates, $type, $more );
1919 }
1920
1921 /**
1922 * Returns HTML for the "hidden categories on this page" list.
1923 *
1924 * @since 1.16.3
1925 * @param array $hiddencats Array of hidden categories from Article::getHiddenCategories
1926 * or similar
1927 * @return string HTML output
1928 */
1929 public static function formatHiddenCategories( $hiddencats ) {
1930 $outText = '';
1931 if ( count( $hiddencats ) > 0 ) {
1932 # Construct the HTML
1933 $outText = '<div class="mw-hiddenCategoriesExplanation">';
1934 $outText .= wfMessage( 'hiddencategories' )->numParams( count( $hiddencats ) )->parseAsBlock();
1935 $outText .= "</div><ul>\n";
1936
1937 foreach ( $hiddencats as $titleObj ) {
1938 # If it's hidden, it must exist - no need to check with a LinkBatch
1939 $outText .= '<li>'
1940 . self::link( $titleObj, null, [], [], 'known' )
1941 . "</li>\n";
1942 }
1943 $outText .= '</ul>';
1944 }
1945 return $outText;
1946 }
1947
1948 /**
1949 * @deprecated since 1.28, use Language::formatSize() directly
1950 *
1951 * Format a size in bytes for output, using an appropriate
1952 * unit (B, KB, MB or GB) according to the magnitude in question
1953 *
1954 * @since 1.16.3
1955 * @param int $size Size to format
1956 * @return string
1957 */
1958 public static function formatSize( $size ) {
1959 wfDeprecated( __METHOD__, '1.28' );
1960
1961 global $wgLang;
1962 return htmlspecialchars( $wgLang->formatSize( $size ) );
1963 }
1964
1965 /**
1966 * Given the id of an interface element, constructs the appropriate title
1967 * attribute from the system messages. (Note, this is usually the id but
1968 * isn't always, because sometimes the accesskey needs to go on a different
1969 * element than the id, for reverse-compatibility, etc.)
1970 *
1971 * @since 1.16.3 $msgParams added in 1.27
1972 * @param string $name Id of the element, minus prefixes.
1973 * @param string|array|null $options Null, string or array with some of the following options:
1974 * - 'withaccess' to add an access-key hint
1975 * - 'nonexisting' to add an accessibility hint that page does not exist
1976 * @param array $msgParams Parameters to pass to the message
1977 *
1978 * @return string Contents of the title attribute (which you must HTML-
1979 * escape), or false for no title attribute
1980 */
1981 public static function titleAttrib( $name, $options = null, array $msgParams = [] ) {
1982 $message = wfMessage( "tooltip-$name", $msgParams );
1983 if ( !$message->exists() ) {
1984 $tooltip = false;
1985 } else {
1986 $tooltip = $message->text();
1987 # Compatibility: formerly some tooltips had [alt-.] hardcoded
1988 $tooltip = preg_replace( "/ ?\[alt-.\]$/", '', $tooltip );
1989 # Message equal to '-' means suppress it.
1990 if ( $tooltip == '-' ) {
1991 $tooltip = false;
1992 }
1993 }
1994
1995 $options = (array)$options;
1996
1997 if ( in_array( 'nonexisting', $options ) ) {
1998 $tooltip = wfMessage( 'red-link-title', $tooltip ?: '' )->text();
1999 }
2000 if ( in_array( 'withaccess', $options ) ) {
2001 $accesskey = self::accesskey( $name );
2002 if ( $accesskey !== false ) {
2003 // Should be build the same as in jquery.accessKeyLabel.js
2004 if ( $tooltip === false || $tooltip === '' ) {
2005 $tooltip = wfMessage( 'brackets', $accesskey )->text();
2006 } else {
2007 $tooltip .= wfMessage( 'word-separator' )->text();
2008 $tooltip .= wfMessage( 'brackets', $accesskey )->text();
2009 }
2010 }
2011 }
2012
2013 return $tooltip;
2014 }
2015
2016 public static $accesskeycache;
2017
2018 /**
2019 * Given the id of an interface element, constructs the appropriate
2020 * accesskey attribute from the system messages. (Note, this is usually
2021 * the id but isn't always, because sometimes the accesskey needs to go on
2022 * a different element than the id, for reverse-compatibility, etc.)
2023 *
2024 * @since 1.16.3
2025 * @param string $name Id of the element, minus prefixes.
2026 * @return string Contents of the accesskey attribute (which you must HTML-
2027 * escape), or false for no accesskey attribute
2028 */
2029 public static function accesskey( $name ) {
2030 if ( isset( self::$accesskeycache[$name] ) ) {
2031 return self::$accesskeycache[$name];
2032 }
2033
2034 $message = wfMessage( "accesskey-$name" );
2035
2036 if ( !$message->exists() ) {
2037 $accesskey = false;
2038 } else {
2039 $accesskey = $message->plain();
2040 if ( $accesskey === '' || $accesskey === '-' ) {
2041 # @todo FIXME: Per standard MW behavior, a value of '-' means to suppress the
2042 # attribute, but this is broken for accesskey: that might be a useful
2043 # value.
2044 $accesskey = false;
2045 }
2046 }
2047
2048 self::$accesskeycache[$name] = $accesskey;
2049 return self::$accesskeycache[$name];
2050 }
2051
2052 /**
2053 * Get a revision-deletion link, or disabled link, or nothing, depending
2054 * on user permissions & the settings on the revision.
2055 *
2056 * Will use forward-compatible revision ID in the Special:RevDelete link
2057 * if possible, otherwise the timestamp-based ID which may break after
2058 * undeletion.
2059 *
2060 * @param User $user
2061 * @param Revision $rev
2062 * @param Title $title
2063 * @return string HTML fragment
2064 */
2065 public static function getRevDeleteLink( User $user, Revision $rev, Title $title ) {
2066 $canHide = $user->isAllowed( 'deleterevision' );
2067 if ( !$canHide && !( $rev->getVisibility() && $user->isAllowed( 'deletedhistory' ) ) ) {
2068 return '';
2069 }
2070
2071 if ( !$rev->userCan( Revision::DELETED_RESTRICTED, $user ) ) {
2072 return self::revDeleteLinkDisabled( $canHide ); // revision was hidden from sysops
2073 } else {
2074 if ( $rev->getId() ) {
2075 // RevDelete links using revision ID are stable across
2076 // page deletion and undeletion; use when possible.
2077 $query = [
2078 'type' => 'revision',
2079 'target' => $title->getPrefixedDBkey(),
2080 'ids' => $rev->getId()
2081 ];
2082 } else {
2083 // Older deleted entries didn't save a revision ID.
2084 // We have to refer to these by timestamp, ick!
2085 $query = [
2086 'type' => 'archive',
2087 'target' => $title->getPrefixedDBkey(),
2088 'ids' => $rev->getTimestamp()
2089 ];
2090 }
2091 return self::revDeleteLink( $query,
2092 $rev->isDeleted( Revision::DELETED_RESTRICTED ), $canHide );
2093 }
2094 }
2095
2096 /**
2097 * Creates a (show/hide) link for deleting revisions/log entries
2098 *
2099 * @param array $query Query parameters to be passed to link()
2100 * @param bool $restricted Set to true to use a "<strong>" instead of a "<span>"
2101 * @param bool $delete Set to true to use (show/hide) rather than (show)
2102 *
2103 * @return string HTML "<a>" link to Special:Revisiondelete, wrapped in a
2104 * span to allow for customization of appearance with CSS
2105 */
2106 public static function revDeleteLink( $query = [], $restricted = false, $delete = true ) {
2107 $sp = SpecialPage::getTitleFor( 'Revisiondelete' );
2108 $msgKey = $delete ? 'rev-delundel' : 'rev-showdeleted';
2109 $html = wfMessage( $msgKey )->escaped();
2110 $tag = $restricted ? 'strong' : 'span';
2111 $link = self::link( $sp, $html, [], $query, [ 'known', 'noclasses' ] );
2112 return Xml::tags(
2113 $tag,
2114 [ 'class' => 'mw-revdelundel-link' ],
2115 wfMessage( 'parentheses' )->rawParams( $link )->escaped()
2116 );
2117 }
2118
2119 /**
2120 * Creates a dead (show/hide) link for deleting revisions/log entries
2121 *
2122 * @since 1.16.3
2123 * @param bool $delete Set to true to use (show/hide) rather than (show)
2124 *
2125 * @return string HTML text wrapped in a span to allow for customization
2126 * of appearance with CSS
2127 */
2128 public static function revDeleteLinkDisabled( $delete = true ) {
2129 $msgKey = $delete ? 'rev-delundel' : 'rev-showdeleted';
2130 $html = wfMessage( $msgKey )->escaped();
2131 $htmlParentheses = wfMessage( 'parentheses' )->rawParams( $html )->escaped();
2132 return Xml::tags( 'span', [ 'class' => 'mw-revdelundel-link' ], $htmlParentheses );
2133 }
2134
2135 /**
2136 * Returns the attributes for the tooltip and access key.
2137 *
2138 * @since 1.16.3. $msgParams introduced in 1.27
2139 * @param string $name
2140 * @param array $msgParams Params for constructing the message
2141 * @param string|array|null $options Options to be passed to titleAttrib.
2142 *
2143 * @see Linker::titleAttrib for what options could be passed to $options.
2144 *
2145 * @return array
2146 */
2147 public static function tooltipAndAccesskeyAttribs(
2148 $name,
2149 array $msgParams = [],
2150 $options = null
2151 ) {
2152 $options = (array)$options;
2153 $options[] = 'withaccess';
2154
2155 $attribs = [
2156 'title' => self::titleAttrib( $name, $options, $msgParams ),
2157 'accesskey' => self::accesskey( $name )
2158 ];
2159 if ( $attribs['title'] === false ) {
2160 unset( $attribs['title'] );
2161 }
2162 if ( $attribs['accesskey'] === false ) {
2163 unset( $attribs['accesskey'] );
2164 }
2165 return $attribs;
2166 }
2167
2168 /**
2169 * Returns raw bits of HTML, use titleAttrib()
2170 * @since 1.16.3
2171 * @param string $name
2172 * @param array|null $options
2173 * @return null|string
2174 */
2175 public static function tooltip( $name, $options = null ) {
2176 $tooltip = self::titleAttrib( $name, $options );
2177 if ( $tooltip === false ) {
2178 return '';
2179 }
2180 return Xml::expandAttributes( [
2181 'title' => $tooltip
2182 ] );
2183 }
2184
2185 }