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