ab921d7f36d4754fd19cfbf4c6d5fa747f51947c
3 * Some internal bits split of from Skin.php. These functions are used
4 * for primarily page content: links, embedded images, table of contents. Links
5 * are also used in the skin.
12 * Flags for userToolLinks()
14 const TOOL_LINKS_NOBLOCK
= 1;
15 const TOOL_LINKS_EMAIL
= 2;
18 * Get the appropriate HTML attributes to add to the "a" element of an ex-
19 * ternal link, as created by [wikisyntax].
21 * @param $class String: the contents of the class attribute; if an empty
22 * string is passed, which is the default value, defaults to 'external'.
23 * @deprecated since 1.18 Just pass the external class directly to something using Html::expandAttributes
25 static function getExternalLinkAttributes( $class = 'external' ) {
26 wfDeprecated( __METHOD__
, '1.18' );
27 return self
::getLinkAttributesInternal( '', $class );
31 * Get the appropriate HTML attributes to add to the "a" element of an in-
34 * @param $title String: the title text for the link, URL-encoded (???) but
36 * @param $unused String: unused
37 * @param $class String: the contents of the class attribute; if an empty
38 * string is passed, which is the default value, defaults to 'external'.
40 static function getInterwikiLinkAttributes( $title, $unused = null, $class = 'external' ) {
43 # @todo FIXME: We have a whole bunch of handling here that doesn't happen in
44 # getExternalLinkAttributes, why?
45 $title = urldecode( $title );
46 $title = $wgContLang->checkTitleEncoding( $title );
47 $title = preg_replace( '/[\\x00-\\x1f]/', ' ', $title );
49 return self
::getLinkAttributesInternal( $title, $class );
53 * Get the appropriate HTML attributes to add to the "a" element of an in-
56 * @param $title String: the title text for the link, URL-encoded (???) but
58 * @param $unused String: unused
59 * @param $class String: the contents of the class attribute, default none
61 static function getInternalLinkAttributes( $title, $unused = null, $class = '' ) {
62 $title = urldecode( $title );
63 $title = str_replace( '_', ' ', $title );
64 return self
::getLinkAttributesInternal( $title, $class );
68 * Get the appropriate HTML attributes to add to the "a" element of an in-
69 * ternal link, given the Title object for the page we want to link to.
72 * @param $unused String: unused
73 * @param $class String: the contents of the class attribute, default none
74 * @param $title Mixed: optional (unescaped) string to use in the title
75 * attribute; if false, default to the name of the page we're linking to
77 static function getInternalLinkAttributesObj( $nt, $unused = null, $class = '', $title = false ) {
78 if ( $title === false ) {
79 $title = $nt->getPrefixedText();
81 return self
::getLinkAttributesInternal( $title, $class );
85 * Common code for getLinkAttributesX functions
87 * @param $title string
88 * @param $class string
92 private static function getLinkAttributesInternal( $title, $class ) {
93 $title = htmlspecialchars( $title );
94 $class = htmlspecialchars( $class );
97 $r .= " class=\"$class\"";
100 $r .= " title=\"$title\"";
106 * Return the CSS colour of a known link
108 * @param $t Title object
109 * @param $threshold Integer: user defined threshold
110 * @return String: CSS class
112 public static function getLinkColour( $t, $threshold ) {
114 if ( $t->isRedirect() ) {
116 $colour = 'mw-redirect';
117 } elseif ( $threshold > 0 &&
118 $t->exists() && $t->getLength() < $threshold &&
119 $t->isContentPage() ) {
127 * This function returns an HTML link to the given target. It serves a few
129 * 1) If $target is a Title, the correct URL to link to will be figured
131 * 2) It automatically adds the usual classes for various types of link
132 * targets: "new" for red links, "stub" for short articles, etc.
133 * 3) It escapes all attribute values safely so there's no risk of XSS.
134 * 4) It provides a default tooltip if the target is a Title (the page
135 * name of the target).
136 * link() replaces the old functions in the makeLink() family.
138 * @since 1.18 Method exists since 1.16 as non-static, made static in 1.18.
139 * You can call it using this if you want to keep compat with these:
140 * $linker = class_exists( 'DummyLinker' ) ? new DummyLinker() : new Linker();
141 * $linker->link( ... );
143 * @param $target Title Can currently only be a Title, but this may
144 * change to support Images, literal URLs, etc.
145 * @param $html string The HTML contents of the <a> element, i.e.,
146 * the link text. This is raw HTML and will not be escaped. If null,
147 * defaults to the prefixed text of the Title; or if the Title is just a
148 * fragment, the contents of the fragment.
149 * @param $customAttribs array A key => value array of extra HTML attri-
150 * butes, such as title and class. (href is ignored.) Classes will be
151 * merged with the default classes, while other attributes will replace
152 * default attributes. All passed attribute values will be HTML-escaped.
153 * A false attribute value means to suppress that attribute.
154 * @param $query array The query string to append to the URL
155 * you're linking to, in key => value array form. Query keys and values
156 * will be URL-encoded.
157 * @param $options string|array String or array of strings:
158 * 'known': Page is known to exist, so don't check if it does.
159 * 'broken': Page is known not to exist, so don't check if it does.
160 * 'noclasses': Don't add any classes automatically (includes "new",
161 * "stub", "mw-redirect", "extiw"). Only use the class attribute
162 * provided, if any, so you get a simple blue link with no funny i-
164 * 'forcearticlepath': Use the article path always, even with a querystring.
165 * Has compatibility issues on some setups, so avoid wherever possible.
166 * @return string HTML <a> attribute
168 public static function link(
169 $target, $html = null, $customAttribs = array(), $query = array(), $options = array()
171 wfProfileIn( __METHOD__
);
172 if ( !$target instanceof Title
) {
173 wfProfileOut( __METHOD__
);
174 return "<!-- ERROR -->$html";
176 $options = (array)$options;
178 $dummy = new DummyLinker
; // dummy linker instance for bc on the hooks
181 if ( !wfRunHooks( 'LinkBegin', array( $dummy, $target, &$html,
182 &$customAttribs, &$query, &$options, &$ret ) ) ) {
183 wfProfileOut( __METHOD__
);
187 # Normalize the Title if it's a special page
188 $target = self
::normaliseSpecialPage( $target );
190 # If we don't know whether the page exists, let's find out.
191 wfProfileIn( __METHOD__
. '-checkPageExistence' );
192 if ( !in_array( 'known', $options ) and !in_array( 'broken', $options ) ) {
193 if ( $target->isKnown() ) {
194 $options[] = 'known';
196 $options[] = 'broken';
199 wfProfileOut( __METHOD__
. '-checkPageExistence' );
202 if ( in_array( "forcearticlepath", $options ) && $query ) {
207 # Note: we want the href attribute first, for prettiness.
208 $attribs = array( 'href' => self
::linkUrl( $target, $query, $options ) );
209 if ( in_array( 'forcearticlepath', $options ) && $oldquery ) {
210 $attribs['href'] = wfAppendQuery( $attribs['href'], wfArrayToCgi( $oldquery ) );
213 $attribs = array_merge(
215 self
::linkAttribs( $target, $customAttribs, $options )
217 if ( is_null( $html ) ) {
218 $html = self
::linkText( $target );
222 if ( wfRunHooks( 'LinkEnd', array( $dummy, $target, $options, &$html, &$attribs, &$ret ) ) ) {
223 $ret = Html
::rawElement( 'a', $attribs, $html );
226 wfProfileOut( __METHOD__
);
231 * Identical to link(), except $options defaults to 'known'.
233 public static function linkKnown(
234 $target, $html = null, $customAttribs = array(),
235 $query = array(), $options = array( 'known', 'noclasses' ) )
237 return self
::link( $target, $html, $customAttribs, $query, $options );
241 * Returns the Url used to link to a Title
243 * @param $target Title
245 private static function linkUrl( $target, $query, $options ) {
246 wfProfileIn( __METHOD__
);
247 # We don't want to include fragments for broken links, because they
248 # generally make no sense.
249 if ( in_array( 'broken', $options ) && $target->mFragment
!== '' ) {
250 $target = clone $target;
251 $target->mFragment
= '';
254 # If it's a broken link, add the appropriate query pieces, unless
255 # there's already an action specified, or unless 'edit' makes no sense
256 # (i.e., for a nonexistent special page).
257 if ( in_array( 'broken', $options ) && empty( $query['action'] )
258 && !$target->isSpecialPage() ) {
259 $query['action'] = 'edit';
260 $query['redlink'] = '1';
262 $ret = $target->getLinkURL( $query );
263 wfProfileOut( __METHOD__
);
268 * Returns the array of attributes used when linking to the Title $target
270 * @param $target Title
276 private static function linkAttribs( $target, $attribs, $options ) {
277 wfProfileIn( __METHOD__
);
281 if ( !in_array( 'noclasses', $options ) ) {
282 wfProfileIn( __METHOD__
. '-getClasses' );
283 # Now build the classes.
286 if ( in_array( 'broken', $options ) ) {
290 if ( $target->isExternal() ) {
291 $classes[] = 'extiw';
294 if ( !in_array( 'broken', $options ) ) { # Avoid useless calls to LinkCache (see r50387)
295 $colour = self
::getLinkColour( $target, $wgUser->getStubThreshold() );
296 if ( $colour !== '' ) {
297 $classes[] = $colour; # mw-redirect or stub
300 if ( $classes != array() ) {
301 $defaults['class'] = implode( ' ', $classes );
303 wfProfileOut( __METHOD__
. '-getClasses' );
306 # Get a default title attribute.
307 if ( $target->getPrefixedText() == '' ) {
308 # A link like [[#Foo]]. This used to mean an empty title
309 # attribute, but that's silly. Just don't output a title.
310 } elseif ( in_array( 'known', $options ) ) {
311 $defaults['title'] = $target->getPrefixedText();
313 $defaults['title'] = wfMsg( 'red-link-title', $target->getPrefixedText() );
316 # Finally, merge the custom attribs with the default ones, and iterate
317 # over that, deleting all "false" attributes.
319 $merged = Sanitizer
::mergeAttributes( $defaults, $attribs );
320 foreach ( $merged as $key => $val ) {
321 # A false value suppresses the attribute, and we don't want the
322 # href attribute to be overridden.
323 if ( $key != 'href' and $val !== false ) {
327 wfProfileOut( __METHOD__
);
332 * Default text of the links to the Title $target
334 * @param $target Title
338 private static function linkText( $target ) {
339 # We might be passed a non-Title by make*LinkObj(). Fail gracefully.
340 if ( !$target instanceof Title
) {
344 # If the target is just a fragment, with no title, we return the frag-
345 # ment text. Otherwise, we return the title text itself.
346 if ( $target->getPrefixedText() === '' && $target->getFragment() !== '' ) {
347 return htmlspecialchars( $target->getFragment() );
349 return htmlspecialchars( $target->getPrefixedText() );
353 * Generate either a normal exists-style link or a stub link, depending
354 * on the given page size.
356 * @param $size Integer
357 * @param $nt Title object.
358 * @param $text String
359 * @param $query String
360 * @param $trail String
361 * @param $prefix String
362 * @return string HTML of link
363 * @deprecated since 1.17
365 static function makeSizeLinkObj( $size, $nt, $text = '', $query = '', $trail = '', $prefix = '' ) {
367 wfDeprecated( __METHOD__
, '1.17' );
369 $threshold = $wgUser->getStubThreshold();
370 $colour = ( $size < $threshold ) ?
'stub' : '';
371 // @todo FIXME: Replace deprecated makeColouredLinkObj by link()
372 return self
::makeColouredLinkObj( $nt, $colour, $text, $query, $trail, $prefix );
376 * Make appropriate markup for a link to the current article. This is currently rendered
377 * as the bold link text. The calling sequence is the same as the other make*LinkObj static functions,
378 * despite $query not being used.
384 public static function makeSelfLinkObj( $nt, $html = '', $query = '', $trail = '', $prefix = '' ) {
386 $html = htmlspecialchars( $nt->getPrefixedText() );
388 list( $inside, $trail ) = self
::splitTrail( $trail );
389 return "<strong class=\"selflink\">{$prefix}{$html}{$inside}</strong>{$trail}";
393 * @param $title Title
396 static function normaliseSpecialPage( Title
$title ) {
397 if ( $title->isSpecialPage() ) {
398 list( $name, $subpage ) = SpecialPageFactory
::resolveAlias( $title->getDBkey() );
402 $ret = SpecialPage
::getTitleFor( $name, $subpage );
403 $ret->mFragment
= $title->getFragment();
411 * Returns the filename part of an url.
412 * Used as alternative text for external images.
418 private static function fnamePart( $url ) {
419 $basename = strrchr( $url, '/' );
420 if ( false === $basename ) {
423 $basename = substr( $basename, 1 );
429 * Return the code for images which were added via external links,
430 * via Parser::maybeMakeExternalImage().
437 public static function makeExternalImage( $url, $alt = '' ) {
439 $alt = self
::fnamePart( $url );
442 $success = wfRunHooks( 'LinkerMakeExternalImage', array( &$url, &$alt, &$img ) );
444 wfDebug( "Hook LinkerMakeExternalImage changed the output of external image with url {$url} and alt text {$alt} to {$img}\n", true );
447 return Html
::element( 'img',
454 * Given parameters derived from [[Image:Foo|options...]], generate the
455 * HTML that that syntax inserts in the page.
457 * @param $title Title object
458 * @param $file File object, or false if it doesn't exist
459 * @param $frameParams Array: associative array of parameters external to the media handler.
460 * Boolean parameters are indicated by presence or absence, the value is arbitrary and
461 * will often be false.
462 * thumbnail If present, downscale and frame
463 * manualthumb Image name to use as a thumbnail, instead of automatic scaling
464 * framed Shows image in original size in a frame
465 * frameless Downscale but don't frame
466 * upright If present, tweak default sizes for portrait orientation
467 * upright_factor Fudge factor for "upright" tweak (default 0.75)
468 * border If present, show a border around the image
469 * align Horizontal alignment (left, right, center, none)
470 * valign Vertical alignment (baseline, sub, super, top, text-top, middle,
471 * bottom, text-bottom)
472 * alt Alternate text for image (i.e. alt attribute). Plain text.
473 * caption HTML for image caption.
474 * link-url URL to link to
475 * link-title Title object to link to
476 * link-target Value for the target attribue, only with link-url
477 * no-link Boolean, suppress description link
479 * @param $handlerParams Array: associative array of media handler parameters, to be passed
480 * to transform(). Typical keys are "width" and "page".
481 * @param $time String: timestamp of the file, set as false for current
482 * @param $query String: query params for desc url
483 * @param $widthOption: Used by the parser to remember the user preference thumbnailsize
484 * @return String: HTML for an image, with links, wrappers, etc.
486 public static function makeImageLink2( Title
$title, $file, $frameParams = array(),
487 $handlerParams = array(), $time = false, $query = "", $widthOption = null )
490 $dummy = new DummyLinker
;
491 if ( !wfRunHooks( 'ImageBeforeProduceHTML', array( &$dummy, &$title,
492 &$file, &$frameParams, &$handlerParams, &$time, &$res ) ) ) {
496 if ( $file && !$file->allowInlineDisplay() ) {
497 wfDebug( __METHOD__
. ': ' . $title->getPrefixedDBkey() . " does not allow inline display\n" );
498 return self
::link( $title );
503 $hp =& $handlerParams;
505 // Clean up parameters
506 $page = isset( $hp['page'] ) ?
$hp['page'] : false;
507 if ( !isset( $fp['align'] ) ) {
510 if ( !isset( $fp['alt'] ) ) {
513 if ( !isset( $fp['title'] ) ) {
517 $prefix = $postfix = '';
519 if ( 'center' == $fp['align'] ) {
520 $prefix = '<div class="center">';
522 $fp['align'] = 'none';
524 if ( $file && !isset( $hp['width'] ) ) {
525 if ( isset( $hp['height'] ) && $file->isVectorized() ) {
526 // If its a vector image, and user only specifies height
527 // we don't want it to be limited by its "normal" width.
528 global $wgSVGMaxSize;
529 $hp['width'] = $wgSVGMaxSize;
531 $hp['width'] = $file->getWidth( $page );
534 if ( isset( $fp['thumbnail'] ) ||
isset( $fp['framed'] ) ||
isset( $fp['frameless'] ) ||
!$hp['width'] ) {
535 global $wgThumbLimits, $wgThumbUpright;
536 if ( !isset( $widthOption ) ||
!isset( $wgThumbLimits[$widthOption] ) ) {
537 $widthOption = User
::getDefaultOption( 'thumbsize' );
540 // Reduce width for upright images when parameter 'upright' is used
541 if ( isset( $fp['upright'] ) && $fp['upright'] == 0 ) {
542 $fp['upright'] = $wgThumbUpright;
544 // For caching health: If width scaled down due to upright parameter, round to full __0 pixel to avoid the creation of a lot of odd thumbs
545 $prefWidth = isset( $fp['upright'] ) ?
546 round( $wgThumbLimits[$widthOption] * $fp['upright'], -1 ) :
547 $wgThumbLimits[$widthOption];
549 // Use width which is smaller: real image width or user preference width
550 // Unless image is scalable vector.
551 if ( !isset( $hp['height'] ) && ( $hp['width'] <= 0 ||
552 $prefWidth < $hp['width'] ||
$file->isVectorized() ) ) {
553 $hp['width'] = $prefWidth;
558 if ( isset( $fp['thumbnail'] ) ||
isset( $fp['manualthumb'] ) ||
isset( $fp['framed'] ) ) {
560 # Create a thumbnail. Alignment depends on language
561 # writing direction, # right aligned for left-to-right-
562 # languages ("Western languages"), left-aligned
563 # for right-to-left-languages ("Semitic languages")
565 # If thumbnail width has not been provided, it is set
566 # to the default user option as specified in Language*.php
567 if ( $fp['align'] == '' ) {
568 $fp['align'] = $wgContLang->alignEnd();
570 return $prefix . self
::makeThumbLink2( $title, $file, $fp, $hp, $time, $query ) . $postfix;
573 if ( $file && isset( $fp['frameless'] ) ) {
574 $srcWidth = $file->getWidth( $page );
575 # For "frameless" option: do not present an image bigger than the source (for bitmap-style images)
576 # This is the same behaviour as the "thumb" option does it already.
577 if ( $srcWidth && !$file->mustRender() && $hp['width'] > $srcWidth ) {
578 $hp['width'] = $srcWidth;
582 if ( $file && isset( $hp['width'] ) ) {
583 # Create a resized image, without the additional thumbnail features
584 $thumb = $file->transform( $hp );
590 $s = self
::makeBrokenImageLinkObj( $title, $fp['title'], '', '', '', $time == true );
594 'title' => $fp['title'],
595 'valign' => isset( $fp['valign'] ) ?
$fp['valign'] : false ,
596 'img-class' => isset( $fp['border'] ) ?
'thumbborder' : false );
597 $params = self
::getImageLinkMTOParams( $fp, $query ) +
$params;
599 $s = $thumb->toHtml( $params );
601 if ( $fp['align'] != '' ) {
602 $s = "<div class=\"float{$fp['align']}\">{$s}</div>";
604 return str_replace( "\n", ' ', $prefix . $s . $postfix );
608 * Get the link parameters for MediaTransformOutput::toHtml() from given
609 * frame parameters supplied by the Parser.
610 * @param $frameParams The frame parameters
611 * @param $query An optional query string to add to description page links
613 private static function getImageLinkMTOParams( $frameParams, $query = '' ) {
614 $mtoParams = array();
615 if ( isset( $frameParams['link-url'] ) && $frameParams['link-url'] !== '' ) {
616 $mtoParams['custom-url-link'] = $frameParams['link-url'];
617 if ( isset( $frameParams['link-target'] ) ) {
618 $mtoParams['custom-target-link'] = $frameParams['link-target'];
620 } elseif ( isset( $frameParams['link-title'] ) && $frameParams['link-title'] !== '' ) {
621 $mtoParams['custom-title-link'] = self
::normaliseSpecialPage( $frameParams['link-title'] );
622 } elseif ( !empty( $frameParams['no-link'] ) ) {
625 $mtoParams['desc-link'] = true;
626 $mtoParams['desc-query'] = $query;
632 * Make HTML for a thumbnail including image, border and caption
633 * @param $title Title object
634 * @param $file File object or false if it doesn't exist
635 * @param $label String
637 * @param $align String
638 * @param $params Array
639 * @param $framed Boolean
640 * @param $manualthumb String
642 public static function makeThumbLinkObj( Title
$title, $file, $label = '', $alt,
643 $align = 'right', $params = array(), $framed = false , $manualthumb = "" )
645 $frameParams = array(
651 $frameParams['framed'] = true;
653 if ( $manualthumb ) {
654 $frameParams['manualthumb'] = $manualthumb;
656 return self
::makeThumbLink2( $title, $file, $frameParams, $params );
660 * @param $title Title
662 * @param array $frameParams
663 * @param array $handlerParams
665 * @param string $query
668 public static function makeThumbLink2( Title
$title, $file, $frameParams = array(),
669 $handlerParams = array(), $time = false, $query = "" )
671 global $wgStylePath, $wgContLang;
672 $exists = $file && $file->exists();
676 $hp =& $handlerParams;
678 $page = isset( $hp['page'] ) ?
$hp['page'] : false;
679 if ( !isset( $fp['align'] ) ) $fp['align'] = 'right';
680 if ( !isset( $fp['alt'] ) ) $fp['alt'] = '';
681 if ( !isset( $fp['title'] ) ) $fp['title'] = '';
682 if ( !isset( $fp['caption'] ) ) $fp['caption'] = '';
684 if ( empty( $hp['width'] ) ) {
685 // Reduce width for upright images when parameter 'upright' is used
686 $hp['width'] = isset( $fp['upright'] ) ?
130 : 180;
691 $outerWidth = $hp['width'] +
2;
693 if ( isset( $fp['manualthumb'] ) ) {
694 # Use manually specified thumbnail
695 $manual_title = Title
::makeTitleSafe( NS_FILE
, $fp['manualthumb'] );
696 if ( $manual_title ) {
697 $manual_img = wfFindFile( $manual_title );
699 $thumb = $manual_img->getUnscaledThumb( $hp );
704 } elseif ( isset( $fp['framed'] ) ) {
705 // Use image dimensions, don't scale
706 $thumb = $file->getUnscaledThumb( $hp );
708 # Do not present an image bigger than the source, for bitmap-style images
709 # This is a hack to maintain compatibility with arbitrary pre-1.10 behaviour
710 $srcWidth = $file->getWidth( $page );
711 if ( $srcWidth && !$file->mustRender() && $hp['width'] > $srcWidth ) {
712 $hp['width'] = $srcWidth;
714 $thumb = $file->transform( $hp );
718 $outerWidth = $thumb->getWidth() +
2;
720 $outerWidth = $hp['width'] +
2;
724 # ThumbnailImage::toHtml() already adds page= onto the end of DjVu URLs
725 # So we don't need to pass it here in $query. However, the URL for the
726 # zoom icon still needs it, so we make a unique query for it. See bug 14771
727 $url = $title->getLocalURL( $query );
729 $url = wfAppendQuery( $url, 'page=' . urlencode( $page ) );
732 $s = "<div class=\"thumb t{$fp['align']}\"><div class=\"thumbinner\" style=\"width:{$outerWidth}px;\">";
734 $s .= self
::makeBrokenImageLinkObj( $title, $fp['title'], '', '', '', $time == true );
736 } elseif ( !$thumb ) {
737 $s .= htmlspecialchars( wfMsg( 'thumbnail_error', '' ) );
742 'title' => $fp['title'],
743 'img-class' => 'thumbimage' );
744 $params = self
::getImageLinkMTOParams( $fp, $query ) +
$params;
745 $s .= $thumb->toHtml( $params );
746 if ( isset( $fp['framed'] ) ) {
749 $zoomIcon = Html
::rawElement( 'div', array( 'class' => 'magnify' ),
750 Html
::rawElement( 'a', array(
752 'class' => 'internal',
753 'title' => wfMsg( 'thumbnail-more' ) ),
754 Html
::element( 'img', array(
755 'src' => $wgStylePath . '/common/images/magnify-clip' . ( $wgContLang->isRTL() ?
'-rtl' : '' ) . '.png',
761 $s .= ' <div class="thumbcaption">' . $zoomIcon . $fp['caption'] . "</div></div></div>";
762 return str_replace( "\n", ' ', $s );
766 * Make a "broken" link to an image
768 * @param $title Title object
769 * @param $html String: link label in htmlescaped text form
770 * @param $query String: query string
771 * @param $trail String: link trail (HTML fragment)
772 * @param $prefix String: link prefix (HTML fragment)
773 * @param $time Boolean: a file of a certain timestamp was requested
776 public static function makeBrokenImageLinkObj( $title, $html = '', $query = '', $trail = '', $prefix = '', $time = false ) {
777 global $wgEnableUploads, $wgUploadMissingFileUrl, $wgUploadNavigationUrl;
778 if ( ! $title instanceof Title
) {
779 return "<!-- ERROR -->{$prefix}{$html}{$trail}";
781 wfProfileIn( __METHOD__
);
782 $currentExists = $time ?
( wfFindFile( $title ) != false ) : false;
784 list( $inside, $trail ) = self
::splitTrail( $trail );
786 $html = htmlspecialchars( $title->getPrefixedText() );
788 if ( ( $wgUploadMissingFileUrl ||
$wgUploadNavigationUrl ||
$wgEnableUploads ) && !$currentExists ) {
789 $redir = RepoGroup
::singleton()->getLocalRepo()->checkRedirect( $title );
792 wfProfileOut( __METHOD__
);
793 return self
::linkKnown( $title, "$prefix$html$inside", array(), $query ) . $trail;
796 $href = self
::getUploadUrl( $title, $query );
798 wfProfileOut( __METHOD__
);
799 return '<a href="' . htmlspecialchars( $href ) . '" class="new" title="' .
800 htmlspecialchars( $title->getPrefixedText(), ENT_QUOTES
) . '">' .
801 "$prefix$html$inside</a>$trail";
803 wfProfileOut( __METHOD__
);
804 return self
::linkKnown( $title, "$prefix$html$inside", array(), $query ) . $trail;
809 * Get the URL to upload a certain file
811 * @param $destFile Title object of the file to upload
812 * @param $query String: urlencoded query string to prepend
813 * @return String: urlencoded URL
815 protected static function getUploadUrl( $destFile, $query = '' ) {
816 global $wgUploadMissingFileUrl, $wgUploadNavigationUrl;
817 $q = 'wpDestFile=' . $destFile->getPartialUrl();
821 if ( $wgUploadMissingFileUrl ) {
822 return wfAppendQuery( $wgUploadMissingFileUrl, $q );
823 } elseif( $wgUploadNavigationUrl ) {
824 return wfAppendQuery( $wgUploadNavigationUrl, $q );
826 $upload = SpecialPage
::getTitleFor( 'Upload' );
827 return $upload->getLocalUrl( $q );
832 * Create a direct link to a given uploaded file.
834 * @param $title Title object.
835 * @param $html String: pre-sanitized HTML
836 * @param $time string: MW timestamp of file creation time
837 * @return String: HTML
839 public static function makeMediaLinkObj( $title, $html = '', $time = false ) {
840 $img = wfFindFile( $title, array( 'time' => $time ) );
841 return self
::makeMediaLinkFile( $title, $img, $html );
845 * Create a direct link to a given uploaded file.
846 * This will make a broken link if $file is false.
848 * @param $title Title object.
849 * @param $file File|false mixed File object or false
850 * @param $html String: pre-sanitized HTML
851 * @return String: HTML
853 * @todo Handle invalid or missing images better.
855 public static function makeMediaLinkFile( Title
$title, $file, $html = '' ) {
856 if ( $file && $file->exists() ) {
857 $url = $file->getURL();
860 $url = self
::getUploadUrl( $title );
863 $alt = htmlspecialchars( $title->getText(), ENT_QUOTES
);
867 $u = htmlspecialchars( $url );
868 return "<a href=\"{$u}\" class=\"$class\" title=\"{$alt}\">{$html}</a>";
872 * Make a link to a special page given its name and, optionally,
873 * a message key from the link text.
874 * Usage example: Linker::specialLink( 'Recentchanges' )
878 public static function specialLink( $name, $key = '' ) {
880 $key = strtolower( $name );
883 return self
::linkKnown( SpecialPage
::getTitleFor( $name ) , wfMsg( $key ) );
887 * Make an external link
888 * @param $url String: URL to link to
889 * @param $text String: text of link
890 * @param $escape Boolean: do we escape the link text?
891 * @param $linktype String: type of external link. Gets added to the classes
892 * @param $attribs Array of extra attributes to <a>
894 public static function makeExternalLink( $url, $text, $escape = true, $linktype = '', $attribs = array() ) {
897 $class .= " $linktype";
899 if ( isset( $attribs['class'] ) && $attribs['class'] ) {
900 $class .= " {$attribs['class']}";
902 $attribs['class'] = $class;
905 $text = htmlspecialchars( $text );
908 $success = wfRunHooks( 'LinkerMakeExternalLink',
909 array( &$url, &$text, &$link, &$attribs, $linktype ) );
911 wfDebug( "Hook LinkerMakeExternalLink changed the output of link with url {$url} and text {$text} to {$link}\n", true );
914 $attribs['href'] = $url;
915 return Html
::rawElement( 'a', $attribs, $text );
919 * Make user link (or user contributions for unregistered users)
920 * @param $userId Integer: user id in database.
921 * @param $userName String: user name in database.
922 * @param $altUserName String: text to display instead of the user name (optional)
923 * @return String: HTML fragment
924 * @since 1.19 Method exists for a long time. $displayText was added in 1.19.
926 public static function userLink( $userId, $userName, $altUserName = false ) {
927 if ( $userId == 0 ) {
928 $page = SpecialPage
::getTitleFor( 'Contributions', $userName );
930 $page = Title
::makeTitle( NS_USER
, $userName );
935 htmlspecialchars( $altUserName !== false ?
$altUserName : $userName ),
936 array( 'class' => 'mw-userlink' )
941 * Generate standard user tool links (talk, contributions, block link, etc.)
943 * @param $userId Integer: user identifier
944 * @param $userText String: user name or IP address
945 * @param $redContribsWhenNoEdits Boolean: should the contributions link be
946 * red if the user has no edits?
947 * @param $flags Integer: customisation flags (e.g. Linker::TOOL_LINKS_NOBLOCK and Linker::TOOL_LINKS_EMAIL)
948 * @param $edits Integer: user edit count (optional, for performance)
949 * @return String: HTML fragment
951 public static function userToolLinks(
952 $userId, $userText, $redContribsWhenNoEdits = false, $flags = 0, $edits = null
954 global $wgUser, $wgDisableAnonTalk, $wgLang;
955 $talkable = !( $wgDisableAnonTalk && 0 == $userId );
956 $blockable = !( $flags & self
::TOOL_LINKS_NOBLOCK
);
957 $addEmailLink = $flags & self
::TOOL_LINKS_EMAIL
&& $userId;
961 $items[] = self
::userTalkLink( $userId, $userText );
964 // check if the user has an edit
966 if ( $redContribsWhenNoEdits ) {
967 $count = !is_null( $edits ) ?
$edits : User
::edits( $userId );
969 $attribs['class'] = 'new';
972 $contribsPage = SpecialPage
::getTitleFor( 'Contributions', $userText );
974 $items[] = self
::link( $contribsPage, wfMsgHtml( 'contribslink' ), $attribs );
976 if ( $blockable && $wgUser->isAllowed( 'block' ) ) {
977 $items[] = self
::blockLink( $userId, $userText );
980 if ( $addEmailLink && $wgUser->canSendEmail() ) {
981 $items[] = self
::emailLink( $userId, $userText );
984 wfRunHooks( 'UserToolLinksEdit', array( $userId, $userText, &$items ) );
987 return ' <span class="mw-usertoollinks">(' . $wgLang->pipeList( $items ) . ')</span>';
994 * Alias for userToolLinks( $userId, $userText, true );
995 * @param $userId Integer: user identifier
996 * @param $userText String: user name or IP address
997 * @param $edits Integer: user edit count (optional, for performance)
999 public static function userToolLinksRedContribs( $userId, $userText, $edits = null ) {
1000 return self
::userToolLinks( $userId, $userText, true, 0, $edits );
1005 * @param $userId Integer: user id in database.
1006 * @param $userText String: user name in database.
1007 * @return String: HTML fragment with user talk link
1009 public static function userTalkLink( $userId, $userText ) {
1010 $userTalkPage = Title
::makeTitle( NS_USER_TALK
, $userText );
1011 $userTalkLink = self
::link( $userTalkPage, wfMsgHtml( 'talkpagelinktext' ) );
1012 return $userTalkLink;
1016 * @param $userId Integer: userid
1017 * @param $userText String: user name in database.
1018 * @return String: HTML fragment with block link
1020 public static function blockLink( $userId, $userText ) {
1021 $blockPage = SpecialPage
::getTitleFor( 'Block', $userText );
1022 $blockLink = self
::link( $blockPage, wfMsgHtml( 'blocklink' ) );
1027 * @param $userId Integer: userid
1028 * @param $userText String: user name in database.
1029 * @return String: HTML fragment with e-mail user link
1031 public static function emailLink( $userId, $userText ) {
1032 $emailPage = SpecialPage
::getTitleFor( 'Emailuser', $userText );
1033 $emailLink = self
::link( $emailPage, wfMsgHtml( 'emaillink' ) );
1038 * Generate a user link if the current user is allowed to view it
1039 * @param $rev Revision object.
1040 * @param $isPublic Boolean: show only if all users can see it
1041 * @return String: HTML fragment
1043 public static function revUserLink( $rev, $isPublic = false ) {
1044 if ( $rev->isDeleted( Revision
::DELETED_USER
) && $isPublic ) {
1045 $link = wfMsgHtml( 'rev-deleted-user' );
1046 } elseif ( $rev->userCan( Revision
::DELETED_USER
) ) {
1047 $link = self
::userLink( $rev->getUser( Revision
::FOR_THIS_USER
),
1048 $rev->getUserText( Revision
::FOR_THIS_USER
) );
1050 $link = wfMsgHtml( 'rev-deleted-user' );
1052 if ( $rev->isDeleted( Revision
::DELETED_USER
) ) {
1053 return '<span class="history-deleted">' . $link . '</span>';
1059 * Generate a user tool link cluster if the current user is allowed to view it
1060 * @param $rev Revision object.
1061 * @param $isPublic Boolean: show only if all users can see it
1062 * @return string HTML
1064 public static function revUserTools( $rev, $isPublic = false ) {
1065 if ( $rev->isDeleted( Revision
::DELETED_USER
) && $isPublic ) {
1066 $link = wfMsgHtml( 'rev-deleted-user' );
1067 } elseif ( $rev->userCan( Revision
::DELETED_USER
) ) {
1068 $userId = $rev->getUser( Revision
::FOR_THIS_USER
);
1069 $userText = $rev->getUserText( Revision
::FOR_THIS_USER
);
1070 $link = self
::userLink( $userId, $userText ) .
1071 ' ' . self
::userToolLinks( $userId, $userText );
1073 $link = wfMsgHtml( 'rev-deleted-user' );
1075 if ( $rev->isDeleted( Revision
::DELETED_USER
) ) {
1076 return ' <span class="history-deleted">' . $link . '</span>';
1082 * This function is called by all recent changes variants, by the page history,
1083 * and by the user contributions list. It is responsible for formatting edit
1084 * comments. It escapes any HTML in the comment, but adds some CSS to format
1085 * auto-generated comments (from section editing) and formats [[wikilinks]].
1087 * @author Erik Moeller <moeller@scireview.de>
1089 * Note: there's not always a title to pass to this function.
1090 * Since you can't set a default parameter for a reference, I've turned it
1091 * temporarily to a value pass. Should be adjusted further. --brion
1093 * @param $comment String
1094 * @param $title Mixed: Title object (to generate link to the section in autocomment) or null
1095 * @param $local Boolean: whether section links should refer to local page
1097 public static function formatComment( $comment, $title = null, $local = false ) {
1098 wfProfileIn( __METHOD__
);
1100 # Sanitize text a bit:
1101 $comment = str_replace( "\n", " ", $comment );
1102 # Allow HTML entities (for bug 13815)
1103 $comment = Sanitizer
::escapeHtmlAllowEntities( $comment );
1105 # Render autocomments and make links:
1106 $comment = self
::formatAutocomments( $comment, $title, $local );
1107 $comment = self
::formatLinksInComment( $comment, $title, $local );
1109 wfProfileOut( __METHOD__
);
1116 static $autocommentTitle;
1117 static $autocommentLocal;
1120 * The pattern for autogen comments is / * foo * /, which makes for
1122 * We look for all comments, match any text before and after the comment,
1123 * add a separator where needed and format the comment itself with CSS
1124 * Called by Linker::formatComment.
1126 * @param $comment String: comment text
1127 * @param $title An optional title object used to links to sections
1128 * @param $local Boolean: whether section links should refer to local page
1129 * @return String: formatted comment
1131 private static function formatAutocomments( $comment, $title = null, $local = false ) {
1133 self
::$autocommentTitle = $title;
1134 self
::$autocommentLocal = $local;
1135 $comment = preg_replace_callback(
1136 '!(.*)/\*\s*(.*?)\s*\*/(.*)!',
1137 array( 'Linker', 'formatAutocommentsCallback' ),
1139 self
::$autocommentTitle = null;
1140 self
::$autocommentLocal = null;
1148 private static function formatAutocommentsCallback( $match ) {
1150 $title = self
::$autocommentTitle;
1151 $local = self
::$autocommentLocal;
1160 # Remove links that a user may have manually put in the autosummary
1161 # This could be improved by copying as much of Parser::stripSectionName as desired.
1162 $section = str_replace( '[[:', '', $section );
1163 $section = str_replace( '[[', '', $section );
1164 $section = str_replace( ']]', '', $section );
1166 $section = Sanitizer
::normalizeSectionNameWhitespace( $section ); # bug 22784
1168 $sectionTitle = Title
::newFromText( '#' . $section );
1170 $sectionTitle = Title
::makeTitleSafe( $title->getNamespace(),
1171 $title->getDBkey(), $section );
1173 if ( $sectionTitle ) {
1174 $link = self
::link( $sectionTitle,
1175 $wgLang->getArrow(), array(), array(),
1182 # written summary $presep autocomment (summary /* section */)
1183 $auto = wfMsgExt( 'autocomment-prefix', array( 'escapenoentities', 'content' ) ) . $auto;
1186 # autocomment $postsep written summary (/* section */ summary)
1187 $auto .= wfMsgExt( 'colon-separator', array( 'escapenoentities', 'content' ) );
1189 $auto = '<span class="autocomment">' . $auto . '</span>';
1190 $comment = $pre . $link . $wgLang->getDirMark() . '<span dir="auto">' . $auto . $post . '</span>';
1197 static $commentContextTitle;
1198 static $commentLocal;
1201 * Formats wiki links and media links in text; all other wiki formatting
1204 * @todo FIXME: Doesn't handle sub-links as in image thumb texts like the main parser
1205 * @param $comment String: text to format links in
1206 * @param $title An optional title object used to links to sections
1207 * @param $local Boolean: whether section links should refer to local page
1210 public static function formatLinksInComment( $comment, $title = null, $local = false ) {
1211 self
::$commentContextTitle = $title;
1212 self
::$commentLocal = $local;
1213 $html = preg_replace_callback(
1214 '/\[\[:?(.*?)(\|(.*?))*\]\]([^[]*)/',
1215 array( 'Linker', 'formatLinksInCommentCallback' ),
1217 self
::$commentContextTitle = null;
1218 self
::$commentLocal = null;
1226 protected static function formatLinksInCommentCallback( $match ) {
1229 $medians = '(?:' . preg_quote( MWNamespace
::getCanonicalName( NS_MEDIA
), '/' ) . '|';
1230 $medians .= preg_quote( $wgContLang->getNsText( NS_MEDIA
), '/' ) . '):';
1232 $comment = $match[0];
1234 # fix up urlencoded title texts (copied from Parser::replaceInternalLinks)
1235 if ( strpos( $match[1], '%' ) !== false ) {
1236 $match[1] = str_replace( array( '<', '>' ), array( '<', '>' ), rawurldecode( $match[1] ) );
1239 # Handle link renaming [[foo|text]] will show link as "text"
1240 if ( $match[3] != "" ) {
1245 $submatch = array();
1247 if ( preg_match( '/^' . $medians . '(.*)$/i', $match[1], $submatch ) ) {
1248 # Media link; trail not supported.
1249 $linkRegexp = '/\[\[(.*?)\]\]/';
1250 $title = Title
::makeTitleSafe( NS_FILE
, $submatch[1] );
1252 $thelink = self
::makeMediaLinkObj( $title, $text );
1255 # Other kind of link
1256 if ( preg_match( $wgContLang->linkTrail(), $match[4], $submatch ) ) {
1257 $trail = $submatch[1];
1261 $linkRegexp = '/\[\[(.*?)\]\]' . preg_quote( $trail, '/' ) . '/';
1262 if ( isset( $match[1][0] ) && $match[1][0] == ':' )
1263 $match[1] = substr( $match[1], 1 );
1264 list( $inside, $trail ) = self
::splitTrail( $trail );
1267 $linkTarget = self
::normalizeSubpageLink( self
::$commentContextTitle,
1268 $match[1], $linkText );
1270 $target = Title
::newFromText( $linkTarget );
1272 if ( $target->getText() == '' && $target->getInterwiki() === ''
1273 && !self
::$commentLocal && self
::$commentContextTitle )
1275 $newTarget = clone ( self
::$commentContextTitle );
1276 $newTarget->setFragment( '#' . $target->getFragment() );
1277 $target = $newTarget;
1279 $thelink = self
::link(
1286 // If the link is still valid, go ahead and replace it in!
1287 $comment = preg_replace( $linkRegexp, StringUtils
::escapeRegexReplacement( $thelink ), $comment, 1 );
1294 * @param $contextTitle Title
1299 public static function normalizeSubpageLink( $contextTitle, $target, &$text ) {
1302 # :Foobar -- override special treatment of prefix (images, language links)
1303 # /Foobar -- convert to CurrentPage/Foobar
1304 # /Foobar/ -- convert to CurrentPage/Foobar, strip the initial / from text
1305 # ../ -- convert to CurrentPage, from CurrentPage/CurrentSubPage
1306 # ../Foobar -- convert to CurrentPage/Foobar, from CurrentPage/CurrentSubPage
1308 wfProfileIn( __METHOD__
);
1309 $ret = $target; # default return value is no change
1311 # Some namespaces don't allow subpages,
1312 # so only perform processing if subpages are allowed
1313 if ( $contextTitle && MWNamespace
::hasSubpages( $contextTitle->getNamespace() ) ) {
1314 $hash = strpos( $target, '#' );
1315 if ( $hash !== false ) {
1316 $suffix = substr( $target, $hash );
1317 $target = substr( $target, 0, $hash );
1322 $target = trim( $target );
1323 # Look at the first character
1324 if ( $target != '' && $target[0] === '/' ) {
1325 # / at end means we don't want the slash to be shown
1327 $trailingSlashes = preg_match_all( '%(/+)$%', $target, $m );
1328 if ( $trailingSlashes ) {
1329 $noslash = $target = substr( $target, 1, -strlen( $m[0][0] ) );
1331 $noslash = substr( $target, 1 );
1334 $ret = $contextTitle->getPrefixedText() . '/' . trim( $noslash ) . $suffix;
1335 if ( $text === '' ) {
1336 $text = $target . $suffix;
1337 } # this might be changed for ugliness reasons
1339 # check for .. subpage backlinks
1341 $nodotdot = $target;
1342 while ( strncmp( $nodotdot, "../", 3 ) == 0 ) {
1344 $nodotdot = substr( $nodotdot, 3 );
1346 if ( $dotdotcount > 0 ) {
1347 $exploded = explode( '/', $contextTitle->GetPrefixedText() );
1348 if ( count( $exploded ) > $dotdotcount ) { # not allowed to go below top level page
1349 $ret = implode( '/', array_slice( $exploded, 0, -$dotdotcount ) );
1350 # / at the end means don't show full path
1351 if ( substr( $nodotdot, -1, 1 ) === '/' ) {
1352 $nodotdot = substr( $nodotdot, 0, -1 );
1353 if ( $text === '' ) {
1354 $text = $nodotdot . $suffix;
1357 $nodotdot = trim( $nodotdot );
1358 if ( $nodotdot != '' ) {
1359 $ret .= '/' . $nodotdot;
1367 wfProfileOut( __METHOD__
);
1372 * Wrap a comment in standard punctuation and formatting if
1373 * it's non-empty, otherwise return empty string.
1375 * @param $comment String
1376 * @param $title Mixed: Title object (to generate link to section in autocomment) or null
1377 * @param $local Boolean: whether section links should refer to local page
1381 public static function commentBlock( $comment, $title = null, $local = false ) {
1382 // '*' used to be the comment inserted by the software way back
1383 // in antiquity in case none was provided, here for backwards
1384 // compatability, acc. to brion -ævar
1385 if ( $comment == '' ||
$comment == '*' ) {
1388 $formatted = self
::formatComment( $comment, $title, $local );
1389 return " <span class=\"comment\" dir=\"auto\">($formatted)</span>";
1394 * Wrap and format the given revision's comment block, if the current
1395 * user is allowed to view it.
1397 * @param $rev Revision object
1398 * @param $local Boolean: whether section links should refer to local page
1399 * @param $isPublic Boolean: show only if all users can see it
1400 * @return String: HTML fragment
1402 public static function revComment( Revision
$rev, $local = false, $isPublic = false ) {
1403 if ( $rev->getRawComment() == "" ) {
1406 if ( $rev->isDeleted( Revision
::DELETED_COMMENT
) && $isPublic ) {
1407 $block = " <span class=\"comment\">" . wfMsgHtml( 'rev-deleted-comment' ) . "</span>";
1408 } elseif ( $rev->userCan( Revision
::DELETED_COMMENT
) ) {
1409 $block = self
::commentBlock( $rev->getComment( Revision
::FOR_THIS_USER
),
1410 $rev->getTitle(), $local );
1412 $block = " <span class=\"comment\">" . wfMsgHtml( 'rev-deleted-comment' ) . "</span>";
1414 if ( $rev->isDeleted( Revision
::DELETED_COMMENT
) ) {
1415 return " <span class=\"history-deleted\">$block</span>";
1424 public static function formatRevisionSize( $size ) {
1426 $stxt = wfMsgExt( 'historyempty', 'parsemag' );
1429 $stxt = wfMsgExt( 'nbytes', 'parsemag', $wgLang->formatNum( $size ) );
1432 $stxt = htmlspecialchars( $stxt );
1433 return "<span class=\"history-size\">$stxt</span>";
1437 * Add another level to the Table of Contents
1441 public static function tocIndent() {
1446 * Finish one or more sublevels on the Table of Contents
1450 public static function tocUnindent( $level ) {
1451 return "</li>\n" . str_repeat( "</ul>\n</li>\n", $level > 0 ?
$level : 0 );
1455 * parameter level defines if we are on an indentation level
1459 public static function tocLine( $anchor, $tocline, $tocnumber, $level, $sectionIndex = false ) {
1460 $classes = "toclevel-$level";
1461 if ( $sectionIndex !== false ) {
1462 $classes .= " tocsection-$sectionIndex";
1464 return "\n<li class=\"$classes\"><a href=\"#" .
1465 $anchor . '"><span class="tocnumber">' .
1466 $tocnumber . '</span> <span class="toctext">' .
1467 $tocline . '</span></a>';
1471 * End a Table Of Contents line.
1472 * tocUnindent() will be used instead if we're ending a line below
1475 public static function tocLineEnd() {
1480 * Wraps the TOC in a table and provides the hide/collapse javascript.
1482 * @param $toc String: html of the Table Of Contents
1483 * @param $lang mixed: Language code for the toc title
1484 * @return String: full html of the TOC
1486 public static function tocList( $toc, $lang = false ) {
1487 $title = wfMsgExt( 'toc', array( 'language' => $lang, 'escape' ) );
1489 '<table id="toc" class="toc"><tr><td>'
1490 . '<div id="toctitle"><h2>' . $title . "</h2></div>\n"
1492 . "</ul>\n</td></tr></table>\n";
1496 * Generate a table of contents from a section tree
1499 * @param $tree Return value of ParserOutput::getSections()
1500 * @return String: HTML fragment
1502 public static function generateTOC( $tree ) {
1505 foreach ( $tree as $section ) {
1506 if ( $section['toclevel'] > $lastLevel )
1507 $toc .= self
::tocIndent();
1508 elseif ( $section['toclevel'] < $lastLevel )
1509 $toc .= self
::tocUnindent(
1510 $lastLevel - $section['toclevel'] );
1512 $toc .= self
::tocLineEnd();
1514 $toc .= self
::tocLine( $section['anchor'],
1515 $section['line'], $section['number'],
1516 $section['toclevel'], $section['index'] );
1517 $lastLevel = $section['toclevel'];
1519 $toc .= self
::tocLineEnd();
1520 return self
::tocList( $toc );
1524 * Create a headline for content
1526 * @param $level Integer: the level of the headline (1-6)
1527 * @param $attribs String: any attributes for the headline, starting with
1528 * a space and ending with '>'
1529 * This *must* be at least '>' for no attribs
1530 * @param $anchor String: the anchor to give the headline (the bit after the #)
1531 * @param $html String: html for the text of the header
1532 * @param $link String: HTML to add for the section edit link
1533 * @param $legacyAnchor Mixed: a second, optional anchor to give for
1534 * backward compatibility (false to omit)
1536 * @return String: HTML headline
1538 public static function makeHeadline( $level, $attribs, $anchor, $html, $link, $legacyAnchor = false ) {
1539 $ret = "<h$level$attribs"
1541 . " <span class=\"mw-headline\" id=\"$anchor\">$html</span>"
1543 if ( $legacyAnchor !== false ) {
1544 $ret = "<div id=\"$legacyAnchor\"></div>$ret";
1550 * Split a link trail, return the "inside" portion and the remainder of the trail
1551 * as a two-element array
1553 static function splitTrail( $trail ) {
1555 $regex = $wgContLang->linkTrail();
1557 if ( $trail !== '' ) {
1559 if ( preg_match( $regex, $trail, $m ) ) {
1564 return array( $inside, $trail );
1568 * Generate a rollback link for a given revision. Currently it's the
1569 * caller's responsibility to ensure that the revision is the top one. If
1570 * it's not, of course, the user will get an error message.
1572 * If the calling page is called with the parameter &bot=1, all rollback
1573 * links also get that parameter. It causes the edit itself and the rollback
1574 * to be marked as "bot" edits. Bot edits are hidden by default from recent
1575 * changes, so this allows sysops to combat a busy vandal without bothering
1578 * @param $rev Revision object
1580 public static function generateRollback( $rev ) {
1581 return '<span class="mw-rollback-link">['
1582 . self
::buildRollbackLink( $rev )
1587 * Build a raw rollback link, useful for collections of "tool" links
1589 * @param $rev Revision object
1590 * @return String: HTML fragment
1592 public static function buildRollbackLink( $rev ) {
1593 global $wgRequest, $wgUser;
1594 $title = $rev->getTitle();
1596 'action' => 'rollback',
1597 'from' => $rev->getUserText(),
1598 'token' => $wgUser->getEditToken( array( $title->getPrefixedText(), $rev->getUserText() ) ),
1600 if ( $wgRequest->getBool( 'bot' ) ) {
1601 $query['bot'] = '1';
1602 $query['hidediff'] = '1'; // bug 15999
1606 wfMsgHtml( 'rollbacklink' ),
1607 array( 'title' => wfMsg( 'tooltip-rollback' ) ),
1609 array( 'known', 'noclasses' )
1614 * Returns HTML for the "templates used on this page" list.
1616 * @param $templates Array of templates from Article::getUsedTemplate
1618 * @param $preview Boolean: whether this is for a preview
1619 * @param $section Boolean: whether this is for a section edit
1620 * @return String: HTML output
1622 public static function formatTemplates( $templates, $preview = false, $section = false ) {
1623 wfProfileIn( __METHOD__
);
1626 if ( count( $templates ) > 0 ) {
1627 # Do a batch existence check
1628 $batch = new LinkBatch
;
1629 foreach ( $templates as $title ) {
1630 $batch->addObj( $title );
1634 # Construct the HTML
1635 $outText = '<div class="mw-templatesUsedExplanation">';
1637 $outText .= wfMsgExt( 'templatesusedpreview', array( 'parse' ), count( $templates ) );
1638 } elseif ( $section ) {
1639 $outText .= wfMsgExt( 'templatesusedsection', array( 'parse' ), count( $templates ) );
1641 $outText .= wfMsgExt( 'templatesused', array( 'parse' ), count( $templates ) );
1643 $outText .= "</div><ul>\n";
1645 usort( $templates, array( 'Title', 'compare' ) );
1646 foreach ( $templates as $titleObj ) {
1647 $r = $titleObj->getRestrictions( 'edit' );
1648 if ( in_array( 'sysop', $r ) ) {
1649 $protected = wfMsgExt( 'template-protected', array( 'parseinline' ) );
1650 } elseif ( in_array( 'autoconfirmed', $r ) ) {
1651 $protected = wfMsgExt( 'template-semiprotected', array( 'parseinline' ) );
1655 if ( $titleObj->quickUserCan( 'edit' ) ) {
1656 $editLink = self
::link(
1658 wfMsg( 'editlink' ),
1660 array( 'action' => 'edit' )
1663 $editLink = self
::link(
1665 wfMsg( 'viewsourcelink' ),
1667 array( 'action' => 'edit' )
1670 $outText .= '<li>' . self
::link( $titleObj ) . ' (' . $editLink . ') ' . $protected . '</li>';
1672 $outText .= '</ul>';
1674 wfProfileOut( __METHOD__
);
1679 * Returns HTML for the "hidden categories on this page" list.
1681 * @param $hiddencats Array of hidden categories from Article::getHiddenCategories
1683 * @return String: HTML output
1685 public static function formatHiddenCategories( $hiddencats ) {
1687 wfProfileIn( __METHOD__
);
1690 if ( count( $hiddencats ) > 0 ) {
1691 # Construct the HTML
1692 $outText = '<div class="mw-hiddenCategoriesExplanation">';
1693 $outText .= wfMsgExt( 'hiddencategories', array( 'parse' ), $wgLang->formatnum( count( $hiddencats ) ) );
1694 $outText .= "</div><ul>\n";
1696 foreach ( $hiddencats as $titleObj ) {
1697 $outText .= '<li>' . self
::link( $titleObj, null, array(), array(), 'known' ) . "</li>\n"; # If it's hidden, it must exist - no need to check with a LinkBatch
1699 $outText .= '</ul>';
1701 wfProfileOut( __METHOD__
);
1706 * Format a size in bytes for output, using an appropriate
1707 * unit (B, KB, MB or GB) according to the magnitude in question
1709 * @param $size Size to format
1712 public static function formatSize( $size ) {
1714 return htmlspecialchars( $wgLang->formatSize( $size ) );
1718 * Given the id of an interface element, constructs the appropriate title
1719 * attribute from the system messages. (Note, this is usually the id but
1720 * isn't always, because sometimes the accesskey needs to go on a different
1721 * element than the id, for reverse-compatibility, etc.)
1723 * @param $name String: id of the element, minus prefixes.
1724 * @param $options Mixed: null or the string 'withaccess' to add an access-
1726 * @return String: contents of the title attribute (which you must HTML-
1727 * escape), or false for no title attribute
1729 public static function titleAttrib( $name, $options = null ) {
1730 wfProfileIn( __METHOD__
);
1732 $message = wfMessage( "tooltip-$name" );
1734 if ( !$message->exists() ) {
1737 $tooltip = $message->text();
1738 # Compatibility: formerly some tooltips had [alt-.] hardcoded
1739 $tooltip = preg_replace( "/ ?\[alt-.\]$/", '', $tooltip );
1740 # Message equal to '-' means suppress it.
1741 if ( $tooltip == '-' ) {
1746 if ( $options == 'withaccess' ) {
1747 $accesskey = self
::accesskey( $name );
1748 if ( $accesskey !== false ) {
1749 if ( $tooltip === false ||
$tooltip === '' ) {
1750 $tooltip = "[$accesskey]";
1752 $tooltip .= " [$accesskey]";
1757 wfProfileOut( __METHOD__
);
1761 static $accesskeycache;
1764 * Given the id of an interface element, constructs the appropriate
1765 * accesskey attribute from the system messages. (Note, this is usually
1766 * the id but isn't always, because sometimes the accesskey needs to go on
1767 * a different element than the id, for reverse-compatibility, etc.)
1769 * @param $name String: id of the element, minus prefixes.
1770 * @return String: contents of the accesskey attribute (which you must HTML-
1771 * escape), or false for no accesskey attribute
1773 public static function accesskey( $name ) {
1774 if ( isset( self
::$accesskeycache[$name] ) ) {
1775 return self
::$accesskeycache[$name];
1777 wfProfileIn( __METHOD__
);
1779 $message = wfMessage( "accesskey-$name" );
1781 if ( !$message->exists() ) {
1784 $accesskey = $message->plain();
1785 if ( $accesskey === '' ||
$accesskey === '-' ) {
1786 # @todo FIXME: Per standard MW behavior, a value of '-' means to suppress the
1787 # attribute, but this is broken for accesskey: that might be a useful
1793 wfProfileOut( __METHOD__
);
1794 return self
::$accesskeycache[$name] = $accesskey;
1798 * Get a revision-deletion link, or disabled link, or nothing, depending
1799 * on user permissions & the settings on the revision.
1801 * Will use forward-compatible revision ID in the Special:RevDelete link
1802 * if possible, otherwise the timestamp-based ID which may break after
1806 * @param Revision $rev
1807 * @param Revision $title
1808 * @return string HTML fragment
1810 public static function getRevDeleteLink( User
$user, Revision
$rev, Title
$title ) {
1811 $canHide = $user->isAllowed( 'deleterevision' );
1812 if ( !$canHide && !( $rev->getVisibility() && $user->isAllowed( 'deletedhistory' ) ) ) {
1816 if ( !$rev->userCan( Revision
::DELETED_RESTRICTED
, $user ) ) {
1817 return Linker
::revDeleteLinkDisabled( $canHide ); // revision was hidden from sysops
1819 if ( $rev->getId() ) {
1820 // RevDelete links using revision ID are stable across
1821 // page deletion and undeletion; use when possible.
1823 'type' => 'revision',
1824 'target' => $title->getPrefixedDBkey(),
1825 'ids' => $rev->getId()
1828 // Older deleted entries didn't save a revision ID.
1829 // We have to refer to these by timestamp, ick!
1831 'type' => 'archive',
1832 'target' => $title->getPrefixedDBkey(),
1833 'ids' => $rev->getTimestamp()
1836 return Linker
::revDeleteLink( $query,
1837 $rev->isDeleted( Revision
::DELETED_RESTRICTED
), $canHide );
1842 * Creates a (show/hide) link for deleting revisions/log entries
1844 * @param $query Array: query parameters to be passed to link()
1845 * @param $restricted Boolean: set to true to use a <strong> instead of a <span>
1846 * @param $delete Boolean: set to true to use (show/hide) rather than (show)
1848 * @return String: HTML <a> link to Special:Revisiondelete, wrapped in a
1849 * span to allow for customization of appearance with CSS
1851 public static function revDeleteLink( $query = array(), $restricted = false, $delete = true ) {
1852 $sp = SpecialPage
::getTitleFor( 'Revisiondelete' );
1853 $html = $delete ?
wfMsgHtml( 'rev-delundel' ) : wfMsgHtml( 'rev-showdeleted' );
1854 $tag = $restricted ?
'strong' : 'span';
1855 $link = self
::link( $sp, $html, array(), $query, array( 'known', 'noclasses' ) );
1856 return Xml
::tags( $tag, array( 'class' => 'mw-revdelundel-link' ), "($link)" );
1860 * Creates a dead (show/hide) link for deleting revisions/log entries
1862 * @param $delete Boolean: set to true to use (show/hide) rather than (show)
1864 * @return string HTML text wrapped in a span to allow for customization
1865 * of appearance with CSS
1867 public static function revDeleteLinkDisabled( $delete = true ) {
1868 $html = $delete ?
wfMsgHtml( 'rev-delundel' ) : wfMsgHtml( 'rev-showdeleted' );
1869 return Xml
::tags( 'span', array( 'class' => 'mw-revdelundel-link' ), "($html)" );
1872 /* Deprecated methods */
1875 * @deprecated since 1.16 Use link()
1877 * This function is a shortcut to makeBrokenLinkObj(Title::newFromText($title),...). Do not call
1878 * it if you already have a title object handy. See makeBrokenLinkObj for further documentation.
1880 * @param $title String: The text of the title
1881 * @param $text String: Link text
1882 * @param $query String: Optional query part
1883 * @param $trail String: Optional trail. Alphabetic characters at the start of this string will
1884 * be included in the link text. Other characters will be appended after
1885 * the end of the link.
1887 static function makeBrokenLink( $title, $text = '', $query = '', $trail = '' ) {
1888 wfDeprecated( __METHOD__
, '1.16' );
1890 $nt = Title
::newFromText( $title );
1891 if ( $nt instanceof Title
) {
1892 return self
::makeBrokenLinkObj( $nt, $text, $query, $trail );
1894 wfDebug( 'Invalid title passed to self::makeBrokenLink(): "' . $title . "\"\n" );
1895 return $text == '' ?
$title : $text;
1900 * @deprecated since 1.16 Use link()
1902 * Make a link for a title which may or may not be in the database. If you need to
1903 * call this lots of times, pre-fill the link cache with a LinkBatch, otherwise each
1904 * call to this will result in a DB query.
1906 * @param $nt Title: the title object to make the link from, e.g. from
1907 * Title::newFromText.
1908 * @param $text String: link text
1909 * @param $query String: optional query part
1910 * @param $trail String: optional trail. Alphabetic characters at the start of this string will
1911 * be included in the link text. Other characters will be appended after
1912 * the end of the link.
1913 * @param $prefix String: optional prefix. As trail, only before instead of after.
1915 static function makeLinkObj( $nt, $text = '', $query = '', $trail = '', $prefix = '' ) {
1916 # wfDeprecated( __METHOD__, '1.16' ); // See r105985 and it's revert. Somewhere still used.
1918 wfProfileIn( __METHOD__
);
1919 $query = wfCgiToArray( $query );
1920 list( $inside, $trail ) = self
::splitTrail( $trail );
1921 if ( $text === '' ) {
1922 $text = self
::linkText( $nt );
1925 $ret = self
::link( $nt, "$prefix$text$inside", array(), $query ) . $trail;
1927 wfProfileOut( __METHOD__
);
1932 * @deprecated since 1.16 Use link()
1934 * Make a link for a title which definitely exists. This is faster than makeLinkObj because
1935 * it doesn't have to do a database query. It's also valid for interwiki titles and special
1938 * @param $title Title object of target page
1939 * @param $text String: text to replace the title
1940 * @param $query String: link target
1941 * @param $trail String: text after link
1942 * @param $prefix String: text before link text
1943 * @param $aprops String: extra attributes to the a-element
1944 * @param $style String: style to apply - if empty, use getInternalLinkAttributesObj instead
1945 * @return the a-element
1947 static function makeKnownLinkObj(
1948 $title, $text = '', $query = '', $trail = '', $prefix = '' , $aprops = '', $style = ''
1950 # wfDeprecated( __METHOD__, '1.16' ); // See r105985 and it's revert. Somewhere still used.
1952 wfProfileIn( __METHOD__
);
1954 if ( $text == '' ) {
1955 $text = self
::linkText( $title );
1957 $attribs = Sanitizer
::mergeAttributes(
1958 Sanitizer
::decodeTagAttributes( $aprops ),
1959 Sanitizer
::decodeTagAttributes( $style )
1961 $query = wfCgiToArray( $query );
1962 list( $inside, $trail ) = self
::splitTrail( $trail );
1964 $ret = self
::link( $title, "$prefix$text$inside", $attribs, $query,
1965 array( 'known', 'noclasses' ) ) . $trail;
1967 wfProfileOut( __METHOD__
);
1972 * @deprecated since 1.16 Use link()
1974 * Make a red link to the edit page of a given title.
1976 * @param $title Title object of the target page
1977 * @param $text String: Link text
1978 * @param $query String: Optional query part
1979 * @param $trail String: Optional trail. Alphabetic characters at the start of this string will
1980 * be included in the link text. Other characters will be appended after
1981 * the end of the link.
1982 * @param $prefix String: Optional prefix
1984 static function makeBrokenLinkObj( $title, $text = '', $query = '', $trail = '', $prefix = '' ) {
1985 wfDeprecated( __METHOD__
, '1.16' );
1987 wfProfileIn( __METHOD__
);
1989 list( $inside, $trail ) = self
::splitTrail( $trail );
1990 if ( $text === '' ) {
1991 $text = self
::linkText( $title );
1994 $ret = self
::link( $title, "$prefix$text$inside", array(),
1995 wfCgiToArray( $query ), 'broken' ) . $trail;
1997 wfProfileOut( __METHOD__
);
2002 * @deprecated since 1.16 Use link()
2004 * Make a coloured link.
2006 * @param $nt Title object of the target page
2007 * @param $colour Integer: colour of the link
2008 * @param $text String: link text
2009 * @param $query String: optional query part
2010 * @param $trail String: optional trail. Alphabetic characters at the start of this string will
2011 * be included in the link text. Other characters will be appended after
2012 * the end of the link.
2013 * @param $prefix String: Optional prefix
2015 static function makeColouredLinkObj( $nt, $colour, $text = '', $query = '', $trail = '', $prefix = '' ) {
2016 wfDeprecated( __METHOD__
, '1.16' );
2018 if ( $colour != '' ) {
2019 $style = self
::getInternalLinkAttributesObj( $nt, $text, $colour );
2023 return self
::makeKnownLinkObj( $nt, $text, $query, $trail, $prefix, '', $style );
2027 * Returns the attributes for the tooltip and access key.
2029 public static function tooltipAndAccesskeyAttribs( $name ) {
2030 # @todo FIXME: If Sanitizer::expandAttributes() treated "false" as "output
2031 # no attribute" instead of "output '' as value for attribute", this
2032 # would be three lines.
2034 'title' => self
::titleAttrib( $name, 'withaccess' ),
2035 'accesskey' => self
::accesskey( $name )
2037 if ( $attribs['title'] === false ) {
2038 unset( $attribs['title'] );
2040 if ( $attribs['accesskey'] === false ) {
2041 unset( $attribs['accesskey'] );
2047 * Returns raw bits of HTML, use titleAttrib()
2049 public static function tooltip( $name, $options = null ) {
2050 # @todo FIXME: If Sanitizer::expandAttributes() treated "false" as "output
2051 # no attribute" instead of "output '' as value for attribute", this
2052 # would be two lines.
2053 $tooltip = self
::titleAttrib( $name, $options );
2054 if ( $tooltip === false ) {
2057 return Xml
::expandAttributes( array(
2069 * Use PHP's magic __call handler to transform instance calls to a dummy instance
2070 * into static calls to the new Linker for backwards compatibility.
2072 * @param $fname String Name of called method
2073 * @param $args Array Arguments to the method
2075 public function __call( $fname, $args ) {
2076 return call_user_func_array( array( 'Linker', $fname ), $args );