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