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