includes/linker/Linker.php
<?php
/**
* Methods to make links and related items.
*
* This program is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation; either version 2 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License along
* with this program; if not, write to the Free Software Foundation, Inc.,
* 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
* http://www.gnu.org/copyleft/gpl.html
*
* @file
*/
namespace MediaWiki\Linker;
use File;
use HtmlArmor;
use MediaTransformError;
use MediaTransformOutput;
use MediaWiki\Context\ContextSource;
use MediaWiki\Context\DerivativeContext;
use MediaWiki\Context\IContextSource;
use MediaWiki\Context\RequestContext;
use MediaWiki\HookContainer\HookRunner;
use MediaWiki\Html\Html;
use MediaWiki\Html\HtmlHelper;
use MediaWiki\MainConfigNames;
use MediaWiki\MediaWikiServices;
use MediaWiki\Message\Message;
use MediaWiki\Parser\Parser;
use MediaWiki\Permissions\Authority;
use MediaWiki\Revision\RevisionRecord;
use MediaWiki\SpecialPage\SpecialPage;
use MediaWiki\Title\Title;
use MediaWiki\Title\TitleValue;
use MediaWiki\User\ExternalUserNames;
use MediaWiki\User\UserIdentityValue;
use MediaWiki\Xml\Xml;
use MessageLocalizer;
use Wikimedia\Assert\Assert;
use Wikimedia\IPUtils;
use Wikimedia\Rdbms\SelectQueryBuilder;
use Wikimedia\RemexHtml\Serializer\SerializerNode;
/**
* Some internal bits split of from Skin.php. These functions are used
* for primarily page content: links, embedded images, table of contents. Links
* are also used in the skin.
*
* @todo turn this into a legacy interface for HtmlPageLinkRenderer and similar services.
*
* @ingroup Skins
*/
class Linker {
/**
* Flags for userToolLinks()
*/
public const TOOL_LINKS_NOBLOCK = 1;
public const TOOL_LINKS_EMAIL = 2;
/**
* This function returns an HTML link to the given target. It serves a few
* purposes:
* 1) If $target is a LinkTarget, the correct URL to link to will be figured
* out automatically.
* 2) It automatically adds the usual classes for various types of link
* targets: "new" for red links, "stub" for short articles, etc.
* 3) It escapes all attribute values safely so there's no risk of XSS.
* 4) It provides a default tooltip if the target is a LinkTarget (the page
* name of the target).
* link() replaces the old functions in the makeLink() family.
*
* @since 1.18 Method exists since 1.16 as non-static, made static in 1.18.
* @deprecated since 1.28, use MediaWiki\Linker\LinkRenderer instead
*
* @param LinkTarget $target Can currently only be a LinkTarget, but this may
* change to support Images, literal URLs, etc.
* @param string|null $html The HTML contents of the <a> element, i.e.,
* the link text. This is raw HTML and will not be escaped. If null,
* defaults to the prefixed text of the LinkTarget; or if the LinkTarget is just a
* fragment, the contents of the fragment.
* @param array $customAttribs A key => value array of extra HTML attributes,
* such as title and class. (href is ignored.) Classes will be
* merged with the default classes, while other attributes will replace
* default attributes. All passed attribute values will be HTML-escaped.
* A false attribute value means to suppress that attribute.
* @param array $query The query string to append to the URL
* you're linking to, in key => value array form. Query keys and values
* will be URL-encoded.
* @param string|array $options String or array of strings:
* 'known': Page is known to exist, so don't check if it does.
* 'broken': Page is known not to exist, so don't check if it does.
* 'noclasses': Don't add any classes automatically (includes "new",
* "stub", "mw-redirect", "extiw"). Only use the class attribute
* provided, if any, so you get a simple blue link with no icons.
* 'forcearticlepath': Use the article path always, even with a querystring.
* Has compatibility issues on some setups, so avoid wherever possible.
* 'http': Force a full URL with http:// as the scheme.
* 'https': Force a full URL with https:// as the scheme.
* @return string HTML <a> attribute
*/
public static function link(
$target, $html = null, $customAttribs = [], $query = [], $options = []
) {
if ( !$target instanceof LinkTarget ) {
wfWarn( __METHOD__ . ': Requires $target to be a LinkTarget object.', 2 );
return "<!-- ERROR -->$html";
}
$services = MediaWikiServices::getInstance();
$options = (array)$options;
if ( $options ) {
// Custom options, create new LinkRenderer
$linkRenderer = $services->getLinkRendererFactory()
->createFromLegacyOptions( $options );
} else {
$linkRenderer = $services->getLinkRenderer();
}
if ( $html !== null ) {
$text = new HtmlArmor( $html );
} else {
$text = null;
}
if ( in_array( 'known', $options, true ) ) {
return $linkRenderer->makeKnownLink( $target, $text, $customAttribs, $query );
}
if ( in_array( 'broken', $options, true ) ) {
return $linkRenderer->makeBrokenLink( $target, $text, $customAttribs, $query );
}
if ( in_array( 'noclasses', $options, true ) ) {
return $linkRenderer->makePreloadedLink( $target, $text, '', $customAttribs, $query );
}
return $linkRenderer->makeLink( $target, $text, $customAttribs, $query );
}
/**
* Identical to link(), except $options defaults to 'known'.
*
* @since 1.16.3
* @deprecated since 1.28, use MediaWiki\Linker\LinkRenderer instead
* @see Linker::link
* @param LinkTarget $target
* @param-taint $target none
* @param string|null $html
* @param-taint $html exec_html
* @param array $customAttribs
* @param-taint $customAttribs none
* @param array $query
* @param-taint $query none
* @param string|array $options
* @param-taint $options none
* @return string
* @return-taint escaped
*/
public static function linkKnown(
$target, $html = null, $customAttribs = [],
$query = [], $options = [ 'known' ]
) {
return self::link( $target, $html, $customAttribs, $query, $options );
}
/**
* Make appropriate markup for a link to the current article. This is since
* MediaWiki 1.29.0 rendered as an <a> tag without an href and with a class
* showing the link text. The calling sequence is the same as for the other
* make*LinkObj static functions, but $query is not used.
*
* @since 1.16.3
* @param LinkTarget $nt
* @param string $html
* @param string $query
* @param string $trail
* @param string $prefix
* @param string $hash hash fragment since 1.40. Should be properly escaped using
* Sanitizer::escapeIdForLink before being passed to this function.
*
* @return string
*/
public static function makeSelfLinkObj( $nt, $html = '', $query = '', $trail = '', $prefix = '', $hash = '' ) {
$nt = Title::newFromLinkTarget( $nt );
$attrs = [];
if ( $hash ) {
$attrs['class'] = 'mw-selflink-fragment';
$attrs['href'] = '#' . $hash;
} else {
// For backwards compatibility with gadgets we add selflink as well.
$attrs['class'] = 'mw-selflink selflink';
}
$ret = Html::rawElement( 'a', $attrs, $prefix . $html ) . $trail;
$hookRunner = new HookRunner( MediaWikiServices::getInstance()->getHookContainer() );
if ( !$hookRunner->onSelfLinkBegin( $nt, $html, $trail, $prefix, $ret ) ) {
return $ret;
}
if ( $html == '' ) {
$html = htmlspecialchars( $nt->getPrefixedText() );
}
[ $inside, $trail ] = self::splitTrail( $trail );
return Html::rawElement( 'a', $attrs, $prefix . $html . $inside ) . $trail;
}
/**
* Get a message saying that an invalid title was encountered.
* This should be called after a method like Title::makeTitleSafe() returned
* a value indicating that the title object is invalid.
*
* @param IContextSource $context Context to use to get the messages
* @param int $namespace Namespace number
* @param string $title Text of the title, without the namespace part
* @return string
*/
public static function getInvalidTitleDescription( IContextSource $context, $namespace, $title ) {
// First we check whether the namespace exists or not.
if ( MediaWikiServices::getInstance()->getNamespaceInfo()->exists( $namespace ) ) {
if ( $namespace == NS_MAIN ) {
$name = $context->msg( 'blanknamespace' )->text();
} else {
$name = MediaWikiServices::getInstance()->getContentLanguage()->
getFormattedNsText( $namespace );
}
return $context->msg( 'invalidtitle-knownnamespace', $namespace, $name, $title )->text();
}
return $context->msg( 'invalidtitle-unknownnamespace', $namespace, $title )->text();
}
/**
* Returns the filename part of an url.
* Used as alternative text for external images.
*
* @param string $url
*
* @return string
*/
private static function fnamePart( $url ) {
$basename = strrchr( $url, '/' );
if ( $basename === false ) {
$basename = $url;
} else {
$basename = substr( $basename, 1 );
}
return $basename;
}
/**
* Return the code for images which were added via external links,
* via Parser::maybeMakeExternalImage().
*
* @since 1.16.3
* @param string $url
* @param string $alt
*
* @return string
*/
public static function makeExternalImage( $url, $alt = '' ) {
if ( $alt == '' ) {
$alt = self::fnamePart( $url );
}
$img = '';
$success = ( new HookRunner( MediaWikiServices::getInstance()->getHookContainer() ) )
->onLinkerMakeExternalImage( $url, $alt, $img );
if ( !$success ) {
wfDebug( "Hook LinkerMakeExternalImage changed the output of external image "
. "with url {$url} and alt text {$alt} to {$img}" );
return $img;
}
return Html::element( 'img',
[
'src' => $url,
'alt' => $alt
]
);
}
/**
* Given parameters derived from [[Image:Foo|options...]], generate the
* HTML that that syntax inserts in the page.
*
* @param Parser $parser
* @param LinkTarget $title LinkTarget object of the file (not the currently viewed page)
* @param File|false $file File object, or false if it doesn't exist
* @param array $frameParams Associative array of parameters external to the media handler.
* Boolean parameters are indicated by presence or absence, the value is arbitrary and
* will often be false.
* thumbnail If present, downscale and frame
* manualthumb Image name to use as a thumbnail, instead of automatic scaling
* framed Shows image in original size in a frame
* frameless Downscale but don't frame
* upright If present, tweak default sizes for portrait orientation
* upright_factor Fudge factor for "upright" tweak (default 0.75)
* border If present, show a border around the image
* align Horizontal alignment (left, right, center, none)
* valign Vertical alignment (baseline, sub, super, top, text-top, middle,
* bottom, text-bottom)
* alt Alternate text for image (i.e. alt attribute). Plain text.
* title Used for tooltips if caption isn't visible.
* class HTML for image classes. Plain text.
* caption HTML for image caption.
* link-url URL to link to
* link-title LinkTarget object to link to
* link-target Value for the target attribute, only with link-url
* no-link Boolean, suppress description link
*
* @param array $handlerParams Associative array of media handler parameters, to be passed
* to transform(). Typical keys are "width" and "page".
* targetlang (optional) Target language code, see Parser::getTargetLanguage()
* @param string|false $time Timestamp of the file, set as false for current
* @param string $query Query params for desc url
* @param int|null $widthOption Used by the parser to remember the user preference thumbnailsize
* @since 1.20
* @return string HTML for an image, with links, wrappers, etc.
*/
public static function makeImageLink( Parser $parser, LinkTarget $title,
$file, $frameParams = [], $handlerParams = [], $time = false,
$query = '', $widthOption = null
) {
$title = Title::newFromLinkTarget( $title );
$res = null;
$hookRunner = new HookRunner( MediaWikiServices::getInstance()->getHookContainer() );
if ( !$hookRunner->onImageBeforeProduceHTML( null, $title,
// @phan-suppress-next-line PhanTypeMismatchArgument Type mismatch on pass-by-ref args
$file, $frameParams, $handlerParams, $time, $res,
// @phan-suppress-next-line PhanTypeMismatchArgument Type mismatch on pass-by-ref args
$parser, $query, $widthOption )
) {
return $res;
}
if ( $file && !$file->allowInlineDisplay() ) {
wfDebug( __METHOD__ . ': ' . $title->getPrefixedDBkey() . ' does not allow inline display' );
return self::link( $title );
}
// Clean up parameters
$page = $handlerParams['page'] ?? false;
if ( !isset( $frameParams['align'] ) ) {
$frameParams['align'] = '';
}
if ( !isset( $frameParams['title'] ) ) {
$frameParams['title'] = '';
}
if ( !isset( $frameParams['class'] ) ) {
$frameParams['class'] = '';
}
$services = MediaWikiServices::getInstance();
$config = $services->getMainConfig();
$enableLegacyMediaDOM = $config->get( MainConfigNames::ParserEnableLegacyMediaDOM );
$classes = [];
if (
!isset( $handlerParams['width'] ) &&
!isset( $frameParams['manualthumb'] ) &&
!isset( $frameParams['framed'] )
) {
$classes[] = 'mw-default-size';
}
$prefix = $postfix = '';
if ( $enableLegacyMediaDOM ) {
if ( $frameParams['align'] == 'center' ) {
$prefix = '<div class="center">';
$postfix = '</div>';
$frameParams['align'] = 'none';
}
}
if ( $file && !isset( $handlerParams['width'] ) ) {
if ( isset( $handlerParams['height'] ) && $file->isVectorized() ) {
// If its a vector image, and user only specifies height
// we don't want it to be limited by its "normal" width.
$svgMaxSize = $config->get( MainConfigNames::SVGMaxSize );
$handlerParams['width'] = $svgMaxSize;
} else {
$handlerParams['width'] = $file->getWidth( $page );
}
if ( isset( $frameParams['thumbnail'] )
|| isset( $frameParams['manualthumb'] )
|| isset( $frameParams['framed'] )
|| isset( $frameParams['frameless'] )
|| !$handlerParams['width']
) {
$thumbLimits = $config->get( MainConfigNames::ThumbLimits );
$thumbUpright = $config->get( MainConfigNames::ThumbUpright );
if ( $widthOption === null || !isset( $thumbLimits[$widthOption] ) ) {
$userOptionsLookup = $services->getUserOptionsLookup();
$widthOption = $userOptionsLookup->getDefaultOption( 'thumbsize' );
}
// Reduce width for upright images when parameter 'upright' is used
if ( isset( $frameParams['upright'] ) && $frameParams['upright'] == 0 ) {
$frameParams['upright'] = $thumbUpright;
}
// 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.
$prefWidth = isset( $frameParams['upright'] ) ?
round( $thumbLimits[$widthOption] * $frameParams['upright'], -1 ) :
$thumbLimits[$widthOption];
// Use width which is smaller: real image width or user preference width
// Unless image is scalable vector.
if ( !isset( $handlerParams['height'] ) && ( $handlerParams['width'] <= 0 ||
$prefWidth < $handlerParams['width'] || $file->isVectorized() ) ) {
$handlerParams['width'] = $prefWidth;
}
}
}
// Parser::makeImage has a similarly named variable
$hasVisibleCaption = isset( $frameParams['thumbnail'] ) ||
isset( $frameParams['manualthumb'] ) ||
isset( $frameParams['framed'] );
if ( $hasVisibleCaption ) {
if ( $enableLegacyMediaDOM ) {
// This is no longer needed in our new media output, since the
// default styling in content.media-common.less takes care of it;
// see T269704.
# Create a thumbnail. Alignment depends on the writing direction of
# the page content language (right-aligned for LTR languages,
# left-aligned for RTL languages)
# If a thumbnail width has not been provided, it is set
# to the default user option as specified in Language*.php
if ( $frameParams['align'] == '' ) {
$frameParams['align'] = $parser->getTargetLanguage()->alignEnd();
}
}
return $prefix . self::makeThumbLink2(
$title, $file, $frameParams, $handlerParams, $time, $query,
$classes, $parser
) . $postfix;
}
$rdfaType = 'mw:File';
if ( isset( $frameParams['frameless'] ) ) {
$rdfaType .= '/Frameless';
if ( $file ) {
$srcWidth = $file->getWidth( $page );
# For "frameless" option: do not present an image bigger than the
# source (for bitmap-style images). This is the same behavior as the
# "thumb" option does it already.
if ( $srcWidth && !$file->mustRender() && $handlerParams['width'] > $srcWidth ) {
$handlerParams['width'] = $srcWidth;
}
}
}
if ( $file && isset( $handlerParams['width'] ) ) {
# Create a resized image, without the additional thumbnail features
$thumb = $file->transform( $handlerParams );
} else {
$thumb = false;
}
$isBadFile = $file && $thumb &&
$parser->getBadFileLookup()->isBadFile( $title->getDBkey(), $parser->getTitle() );
if ( !$thumb || ( !$enableLegacyMediaDOM && $thumb->isError() ) || $isBadFile ) {
$rdfaType = 'mw:Error ' . $rdfaType;
$currentExists = $file && $file->exists();
if ( $enableLegacyMediaDOM ) {
$label = $frameParams['title'];
} else {
if ( $currentExists && !$thumb ) {
$label = wfMessage( 'thumbnail_error', '' )->text();
} elseif ( $thumb && $thumb->isError() ) {
Assert::invariant(
$thumb instanceof MediaTransformError,
'Unknown MediaTransformOutput: ' . get_class( $thumb )
);
$label = $thumb->toText();
} else {
$label = $frameParams['alt'] ?? '';
}
}
$s = self::makeBrokenImageLinkObj(
$title, $label, '', '', '', (bool)$time, $handlerParams, $currentExists
);
} else {
self::processResponsiveImages( $file, $thumb, $handlerParams );
$params = [];
// An empty alt indicates an image is not a key part of the content
// and that non-visual browsers may omit it from rendering. Only
// set the parameter if it's explicitly requested.
if ( isset( $frameParams['alt'] ) ) {
$params['alt'] = $frameParams['alt'];
}
$params['title'] = $frameParams['title'];
if ( $enableLegacyMediaDOM ) {
$params += [
'valign' => $frameParams['valign'] ?? false,
'img-class' => $frameParams['class'],
];
if ( isset( $frameParams['border'] ) ) {
$params['img-class'] .= ( $params['img-class'] !== '' ? ' ' : '' ) . 'thumbborder';
}
} else {
$params += [
'img-class' => 'mw-file-element',
];
}
$params = self::getImageLinkMTOParams( $frameParams, $query, $parser ) + $params;
$s = $thumb->toHtml( $params );
}
if ( $enableLegacyMediaDOM ) {
if ( $frameParams['align'] != '' ) {
$s = Html::rawElement(
'div',
[ 'class' => 'float' . $frameParams['align'] ],
$s
);
}
return str_replace( "\n", ' ', $prefix . $s . $postfix );
}
$wrapper = 'span';
$caption = '';
if ( $frameParams['align'] != '' ) {
$wrapper = 'figure';
// Possible values: mw-halign-left mw-halign-center mw-halign-right mw-halign-none
$classes[] = "mw-halign-{$frameParams['align']}";
$caption = Html::rawElement(
'figcaption', [], $frameParams['caption'] ?? ''
);
} elseif ( isset( $frameParams['valign'] ) ) {
// Possible values: mw-valign-middle mw-valign-baseline mw-valign-sub
// mw-valign-super mw-valign-top mw-valign-text-top mw-valign-bottom
// mw-valign-text-bottom
$classes[] = "mw-valign-{$frameParams['valign']}";
}
if ( isset( $frameParams['border'] ) ) {
$classes[] = 'mw-image-border';
}
if ( isset( $frameParams['class'] ) ) {
$classes[] = $frameParams['class'];
}
$attribs = [
'class' => $classes,
'typeof' => $rdfaType,
];
$s = Html::rawElement( $wrapper, $attribs, $s . $caption );
return str_replace( "\n", ' ', $s );
}
/**
* Get the link parameters for MediaTransformOutput::toHtml() from given
* frame parameters supplied by the Parser.
* @param array $frameParams The frame parameters
* @param string $query An optional query string to add to description page links
* @param Parser|null $parser
* @return array
*/
public static function getImageLinkMTOParams( $frameParams, $query = '', $parser = null ) {
$mtoParams = [];
if ( isset( $frameParams['link-url'] ) && $frameParams['link-url'] !== '' ) {
$mtoParams['custom-url-link'] = $frameParams['link-url'];
if ( isset( $frameParams['link-target'] ) ) {
$mtoParams['custom-target-link'] = $frameParams['link-target'];
}
if ( $parser ) {
$extLinkAttrs = $parser->getExternalLinkAttribs( $frameParams['link-url'] );
foreach ( $extLinkAttrs as $name => $val ) {
// Currently could include 'rel' and 'target'
$mtoParams['parser-extlink-' . $name] = $val;
}
}
} elseif ( isset( $frameParams['link-title'] ) && $frameParams['link-title'] !== '' ) {
$linkRenderer = MediaWikiServices::getInstance()->getLinkRenderer();
$mtoParams['custom-title-link'] = Title::newFromLinkTarget(
$linkRenderer->normalizeTarget( $frameParams['link-title'] )
);
if ( isset( $frameParams['link-title-query'] ) ) {
$mtoParams['custom-title-link-query'] = $frameParams['link-title-query'];
}
} elseif ( !empty( $frameParams['no-link'] ) ) {
// No link
} else {
$mtoParams['desc-link'] = true;
$mtoParams['desc-query'] = $query;
}
return $mtoParams;
}
/**
* Make HTML for a thumbnail including image, border and caption
* @param LinkTarget $title
* @param File|false $file File object or false if it doesn't exist
* @param string $label
* @param string $alt
* @param string|null $align
* @param array $params
* @param bool $framed
* @param string $manualthumb
* @return string
*/
public static function makeThumbLinkObj(
LinkTarget $title, $file, $label = '', $alt = '', $align = null,
$params = [], $framed = false, $manualthumb = ''
) {
$frameParams = [
'alt' => $alt,
'caption' => $label,
'align' => $align
];
$classes = [];
if ( $manualthumb ) {
$frameParams['manualthumb'] = $manualthumb;
} elseif ( $framed ) {
$frameParams['framed'] = true;
} elseif ( !isset( $params['width'] ) ) {
$classes[] = 'mw-default-size';
}
return self::makeThumbLink2(
$title, $file, $frameParams, $params, false, '', $classes
);
}
/**
* @param LinkTarget $title
* @param File|false $file
* @param array $frameParams
* @param array $handlerParams
* @param bool $time If a file of a certain timestamp was requested
* @param string $query
* @param string[] $classes @since 1.36
* @param Parser|null $parser @since 1.38
* @return string
*/
public static function makeThumbLink2(
LinkTarget $title, $file, $frameParams = [], $handlerParams = [],
$time = false, $query = '', array $classes = [], ?Parser $parser = null
) {
$exists = $file && $file->exists();
$services = MediaWikiServices::getInstance();
$enableLegacyMediaDOM = $services->getMainConfig()->get( MainConfigNames::ParserEnableLegacyMediaDOM );
$page = $handlerParams['page'] ?? false;
$lang = $handlerParams['lang'] ?? false;
if ( !isset( $frameParams['align'] ) ) {
$frameParams['align'] = '';
if ( $enableLegacyMediaDOM ) {
$frameParams['align'] = 'right';
}
}
if ( !isset( $frameParams['caption'] ) ) {
$frameParams['caption'] = '';
}
if ( empty( $handlerParams['width'] ) ) {
// Reduce width for upright images when parameter 'upright' is used
$handlerParams['width'] = isset( $frameParams['upright'] ) ? 130 : 180;
}
$thumb = false;
$noscale = false;
$manualthumb = false;
$manual_title = '';
$rdfaType = 'mw:File/Thumb';
if ( !$exists ) {
// Same precedence as the $exists case
if ( !isset( $frameParams['manualthumb'] ) && isset( $frameParams['framed'] ) ) {
$rdfaType = 'mw:File/Frame';
}
$outerWidth = $handlerParams['width'] + 2;
} else {
if ( isset( $frameParams['manualthumb'] ) ) {
# Use manually specified thumbnail
$manual_title = Title::makeTitleSafe( NS_FILE, $frameParams['manualthumb'] );
if ( $manual_title ) {
$manual_img = $services->getRepoGroup()
->findFile( $manual_title );
if ( $manual_img ) {
$thumb = $manual_img->getUnscaledThumb( $handlerParams );
$manualthumb = true;
}
}
} else {
$srcWidth = $file->getWidth( $page );
if ( isset( $frameParams['framed'] ) ) {
$rdfaType = 'mw:File/Frame';
if ( !$file->isVectorized() ) {
// Use image dimensions, don't scale
$noscale = true;
} else {
// framed is unscaled, but for vectorized images
// we need to a width for scaling up for the high density variants
$handlerParams['width'] = $srcWidth;
}
}
// Do not present an image bigger than the source, for bitmap-style images
// This is a hack to maintain compatibility with arbitrary pre-1.10 behavior
if ( $srcWidth && !$file->mustRender() && $handlerParams['width'] > $srcWidth ) {
$handlerParams['width'] = $srcWidth;
}
$thumb = $noscale
? $file->getUnscaledThumb( $handlerParams )
: $file->transform( $handlerParams );
}
if ( $thumb ) {
$outerWidth = $thumb->getWidth() + 2;
} else {
$outerWidth = $handlerParams['width'] + 2;
}
}
if ( !$enableLegacyMediaDOM && $parser && $rdfaType === 'mw:File/Thumb' ) {
$parser->getOutput()->addModules( [ 'mediawiki.page.media' ] );
}
$url = Title::newFromLinkTarget( $title )->getLocalURL( $query );
$linkTitleQuery = [];
if ( $page || $lang ) {
if ( $page ) {
$linkTitleQuery['page'] = $page;
}
if ( $lang ) {
$linkTitleQuery['lang'] = $lang;
}
# ThumbnailImage::toHtml() already adds page= onto the end of DjVu URLs
# So we don't need to pass it here in $query. However, the URL for the
# zoom icon still needs it, so we make a unique query for it. See T16771
$url = wfAppendQuery( $url, $linkTitleQuery );
}
if ( $manualthumb
&& !isset( $frameParams['link-title'] )
&& !isset( $frameParams['link-url'] )
&& !isset( $frameParams['no-link'] ) ) {
$frameParams['link-title'] = $title;
$frameParams['link-title-query'] = $linkTitleQuery;
}
if ( $frameParams['align'] != '' ) {
// Possible values: mw-halign-left mw-halign-center mw-halign-right mw-halign-none
$classes[] = "mw-halign-{$frameParams['align']}";
}
if ( isset( $frameParams['class'] ) ) {
$classes[] = $frameParams['class'];
}
$s = '';
if ( $enableLegacyMediaDOM ) {
$s .= "<div class=\"thumb t{$frameParams['align']}\">"
. "<div class=\"thumbinner\" style=\"width:{$outerWidth}px;\">";
}
$isBadFile = $exists && $thumb && $parser &&
$parser->getBadFileLookup()->isBadFile(
$manualthumb ? $manual_title : $title->getDBkey(),
$parser->getTitle()
);
if ( !$exists ) {
$rdfaType = 'mw:Error ' . $rdfaType;
$label = '';
if ( !$enableLegacyMediaDOM ) {
$label = $frameParams['alt'] ?? '';
}
$s .= self::makeBrokenImageLinkObj(
$title, $label, '', '', '', (bool)$time, $handlerParams, false
);
$zoomIcon = '';
} elseif ( !$thumb || ( !$enableLegacyMediaDOM && $thumb->isError() ) || $isBadFile ) {
$rdfaType = 'mw:Error ' . $rdfaType;
if ( $enableLegacyMediaDOM ) {
if ( !$thumb ) {
$s .= wfMessage( 'thumbnail_error', '' )->escaped();
} else {
$s .= self::makeBrokenImageLinkObj(
$title, '', '', '', '', (bool)$time, $handlerParams, true
);
}
} else {
if ( $thumb && $thumb->isError() ) {
Assert::invariant(
$thumb instanceof MediaTransformError,
'Unknown MediaTransformOutput: ' . get_class( $thumb )
);
$label = $thumb->toText();
} elseif ( !$thumb ) {
$label = wfMessage( 'thumbnail_error', '' )->text();
} else {
$label = '';
}
$s .= self::makeBrokenImageLinkObj(
$title, $label, '', '', '', (bool)$time, $handlerParams, true
);
}
$zoomIcon = '';
} else {
if ( !$noscale && !$manualthumb ) {
self::processResponsiveImages( $file, $thumb, $handlerParams );
}
$params = [];
// An empty alt indicates an image is not a key part of the content
// and that non-visual browsers may omit it from rendering. Only
// set the parameter if it's explicitly requested.
if ( isset( $frameParams['alt'] ) ) {
$params['alt'] = $frameParams['alt'];
}
if ( $enableLegacyMediaDOM ) {
$params += [
'img-class' => ( isset( $frameParams['class'] ) && $frameParams['class'] !== ''
? $frameParams['class'] . ' '
: '' ) . 'thumbimage'
];
} else {
$params += [
'img-class' => 'mw-file-element',
];
// Only thumbs gets the magnify link
if ( $rdfaType === 'mw:File/Thumb' ) {
$params['magnify-resource'] = $url;
}
}
$params = self::getImageLinkMTOParams( $frameParams, $query, $parser ) + $params;
$s .= $thumb->toHtml( $params );
if ( isset( $frameParams['framed'] ) ) {
$zoomIcon = '';
} else {
$zoomIcon = Html::rawElement( 'div', [ 'class' => 'magnify' ],
Html::rawElement( 'a', [
'href' => $url,
'class' => 'internal',
'title' => wfMessage( 'thumbnail-more' )->text(),
] )
);
}
}
if ( $enableLegacyMediaDOM ) {
$s .= ' <div class="thumbcaption">' . $zoomIcon . $frameParams['caption'] . '</div></div></div>';
return str_replace( "\n", ' ', $s );
}
$s .= Html::rawElement(
'figcaption', [], $frameParams['caption'] ?? ''
);
$attribs = [
'class' => $classes,
'typeof' => $rdfaType,
];
$s = Html::rawElement( 'figure', $attribs, $s );
return str_replace( "\n", ' ', $s );
}
/**
* Process responsive images: add 1.5x and 2x subimages to the thumbnail, where
* applicable.
*
* @param File $file
* @param MediaTransformOutput|null $thumb
* @param array $hp Image parameters
*/
public static function processResponsiveImages( $file, $thumb, $hp ) {
$responsiveImages = MediaWikiServices::getInstance()->getMainConfig()->get( MainConfigNames::ResponsiveImages );
if ( $responsiveImages && $thumb && !$thumb->isError() ) {
$hp15 = $hp;
$hp15['width'] = round( $hp['width'] * 1.5 );
$hp20 = $hp;
$hp20['width'] = $hp['width'] * 2;
if ( isset( $hp['height'] ) ) {
$hp15['height'] = round( $hp['height'] * 1.5 );
$hp20['height'] = $hp['height'] * 2;
}
$thumb15 = $file->transform( $hp15 );
$thumb20 = $file->transform( $hp20 );
if ( $thumb15 && !$thumb15->isError() && $thumb15->getUrl() !== $thumb->getUrl() ) {
$thumb->responsiveUrls['1.5'] = $thumb15->getUrl();
}
if ( $thumb20 && !$thumb20->isError() && $thumb20->getUrl() !== $thumb->getUrl() ) {
$thumb->responsiveUrls['2'] = $thumb20->getUrl();
}
}
}
/**
* Make a "broken" link to an image
*
* @since 1.16.3
* @param LinkTarget $title
* @param string $label Link label (plain text)
* @param string $query Query string
* @param string $unused1 Unused parameter kept for b/c
* @param string $unused2 Unused parameter kept for b/c
* @param bool $time A file of a certain timestamp was requested
* @param array $handlerParams @since 1.36
* @param bool $currentExists @since 1.41
* @return string
*/
public static function makeBrokenImageLinkObj(
$title, $label = '', $query = '', $unused1 = '', $unused2 = '',
$time = false, array $handlerParams = [], bool $currentExists = false
) {
if ( !$title instanceof LinkTarget ) {
wfWarn( __METHOD__ . ': Requires $title to be a LinkTarget object.' );
return "<!-- ERROR -->" . htmlspecialchars( $label );
}
$title = Title::newFromLinkTarget( $title );
$services = MediaWikiServices::getInstance();
$mainConfig = $services->getMainConfig();
$enableUploads = $mainConfig->get( MainConfigNames::EnableUploads );
$uploadMissingFileUrl = $mainConfig->get( MainConfigNames::UploadMissingFileUrl );
$uploadNavigationUrl = $mainConfig->get( MainConfigNames::UploadNavigationUrl );
if ( $label == '' ) {
$label = $title->getPrefixedText();
}
$html = Html::element( 'span', [
'class' => 'mw-file-element mw-broken-media',
// These data attributes are used to dynamically size the span, see T273013
'data-width' => $handlerParams['width'] ?? null,
'data-height' => $handlerParams['height'] ?? null,
], $label );
if ( $mainConfig->get( MainConfigNames::ParserEnableLegacyMediaDOM ) ) {
$html = htmlspecialchars( $label, ENT_COMPAT );
}
$repoGroup = $services->getRepoGroup();
$currentExists = $currentExists ||
( $time && $repoGroup->findFile( $title ) !== false );
if ( ( $uploadMissingFileUrl || $uploadNavigationUrl || $enableUploads )
&& !$currentExists
) {
if (
$title->inNamespace( NS_FILE ) &&
$repoGroup->getLocalRepo()->checkRedirect( $title )
) {
// We already know it's a redirect, so mark it accordingly
return self::link(
$title,
$html,
[ 'class' => 'mw-redirect' ],
wfCgiToArray( $query ),
[ 'known', 'noclasses' ]
);
}
return Html::rawElement( 'a', [
'href' => self::getUploadUrl( $title, $query ),
'class' => 'new',
'title' => $title->getPrefixedText()
], $html );
}
return self::link(
$title,
$html,
[],
wfCgiToArray( $query ),
[ 'known', 'noclasses' ]
);
}
/**
* Get the URL to upload a certain file
*
* @since 1.16.3
* @param LinkTarget $destFile LinkTarget object of the file to upload
* @param string $query Urlencoded query string to prepend
* @return string Urlencoded URL
*/
public static function getUploadUrl( $destFile, $query = '' ) {
$mainConfig = MediaWikiServices::getInstance()->getMainConfig();
$uploadMissingFileUrl = $mainConfig->get( MainConfigNames::UploadMissingFileUrl );
$uploadNavigationUrl = $mainConfig->get( MainConfigNames::UploadNavigationUrl );
$q = 'wpDestFile=' . Title::newFromLinkTarget( $destFile )->getPartialURL();
if ( $query != '' ) {
$q .= '&' . $query;
}
if ( $uploadMissingFileUrl ) {
return wfAppendQuery( $uploadMissingFileUrl, $q );
}
if ( $uploadNavigationUrl ) {
return wfAppendQuery( $uploadNavigationUrl, $q );
}
$upload = SpecialPage::getTitleFor( 'Upload' );
return $upload->getLocalURL( $q );
}
/**
* Create a direct link to a given uploaded file.
*
* @since 1.16.3
* @param LinkTarget $title
* @param string $html Pre-sanitized HTML
* @param string|false $time MW timestamp of file creation time
* @return string HTML
*/
public static function makeMediaLinkObj( $title, $html = '', $time = false ) {
$img = MediaWikiServices::getInstance()->getRepoGroup()->findFile(
$title, [ 'time' => $time ]
);
return self::makeMediaLinkFile( $title, $img, $html );
}
/**
* Create a direct link to a given uploaded file.
* This will make a broken link if $file is false.
*
* @since 1.16.3
* @param LinkTarget $title
* @param File|false $file File object or false
* @param string $html Pre-sanitized HTML
* @return string HTML
*
* @todo Handle invalid or missing images better.
*/
public static function makeMediaLinkFile( LinkTarget $title, $file, $html = '' ) {
if ( $file && $file->exists() ) {
$url = $file->getUrl();
$class = 'internal';
} else {
$url = self::getUploadUrl( $title );
$class = 'new';
}
$alt = $title->getText();
if ( $html == '' ) {
$html = $alt;
}
$ret = '';
$attribs = [
'href' => $url,
'class' => $class,
'title' => $alt
];
if ( !( new HookRunner( MediaWikiServices::getInstance()->getHookContainer() ) )->onLinkerMakeMediaLinkFile(
Title::newFromLinkTarget( $title ), $file, $html, $attribs, $ret )
) {
wfDebug( "Hook LinkerMakeMediaLinkFile changed the output of link "
. "with url {$url} and text {$html} to {$ret}" );
return $ret;
}
return Html::rawElement( 'a', $attribs, $html );
}
/**
* Make a link to a special page given its name and, optionally,
* a message key from the link text.
* Usage example: Linker::specialLink( 'Recentchanges' )
*
* @since 1.16.3
* @param string $name Special page name, can optionally include …/subpages and …?parameters
* @param string $key Optional message key if different from $name
* @return string
*/
public static function specialLink( $name, $key = '' ) {
$queryPos = strpos( $name, '?' );
if ( $queryPos !== false ) {
$getParams = wfCgiToArray( substr( $name, $queryPos + 1 ) );
$name = substr( $name, 0, $queryPos );
} else {
$getParams = [];
}
$slashPos = strpos( $name, '/' );
if ( $slashPos !== false ) {
$subpage = substr( $name, $slashPos + 1 );
$name = substr( $name, 0, $slashPos );
} else {
$subpage = false;
}
if ( $key == '' ) {
$key = strtolower( $name );
}
return self::linkKnown(
SpecialPage::getTitleFor( $name, $subpage ),
wfMessage( $key )->escaped(),
[],
$getParams
);
}
/**
* Make an external link
*
* @since 1.16.3. $title added in 1.21
* @param string $url URL to link to
* @param-taint $url escapes_html
* @param string $text Text of link
* @param-taint $text none
* @param bool $escape Do we escape the link text?
* @param-taint $escape none
* @param string $linktype Type of external link. Gets added to the classes
* @param-taint $linktype escapes_html
* @param array $attribs Array of extra attributes to <a>
* @param-taint $attribs escapes_html
* @param LinkTarget|null $title LinkTarget object used for title specific link attributes
* @param-taint $title none
* @return string
* @deprecated since 1.43; use LinkRenderer::makeExternalLink(), passing
* in an HtmlArmor instance if $escape was false.
*/
public static function makeExternalLink( $url, $text, $escape = true,
$linktype = '', $attribs = [], $title = null
) {
global $wgTitle;
$linkRenderer = MediaWikiServices::getInstance()->getLinkRenderer();
return $linkRenderer->makeExternalLink(
$url,
$escape ? $text : new HtmlArmor( $text ),
$title ?? $wgTitle ?? SpecialPage::getTitleFor( 'Badtitle' ),
$linktype,
$attribs
);
}
/**
* Make user link (or user contributions for unregistered users)
*
* This method produces HTML that requires CSS styles in mediawiki.interface.helpers.styles.
*
* @param int $userId User id in database.
* @param string $userName User name in database.
* @param string|false $altUserName Text to display instead of the user name (optional)
* @param string[] $attributes Extra HTML attributes. See Linker::link.
* @return string HTML fragment
* @since 1.16.3. $altUserName was added in 1.19. $attributes was added in 1.40.
*/
public static function userLink(
$userId,
$userName,
$altUserName = false,
$attributes = []
) {
if ( $userName === '' || $userName === false || $userName === null ) {
wfDebug( __METHOD__ . ' received an empty username. Are there database errors ' .
'that need to be fixed?' );
return wfMessage( 'empty-username' )->parse();
}
$classes = 'mw-userlink';
if ( MediaWikiServices::getInstance()->getTempUserConfig()->isTempName( $userName ) ) {
$classes .= ' mw-tempuserlink';
$page = SpecialPage::getTitleValueFor( 'Contributions', $userName );
} elseif ( $userId == 0 ) {
$page = ExternalUserNames::getUserLinkTitle( $userName );
if ( ExternalUserNames::isExternal( $userName ) ) {
$classes .= ' mw-extuserlink';
} elseif ( $altUserName === false ) {
$altUserName = IPUtils::prettifyIP( $userName );
}
$classes .= ' mw-anonuserlink'; // Separate link class for anons (T45179)
} else {
$page = TitleValue::tryNew( NS_USER, strtr( $userName, ' ', '_' ) );
}
// Wrap the output with <bdi> tags for directionality isolation
$linkText =
'<bdi>' . htmlspecialchars( $altUserName !== false ? $altUserName : $userName ) . '</bdi>';
if ( isset( $attributes['class'] ) ) {
$attributes['class'] .= ' ' . $classes;
} else {
$attributes['class'] = $classes;
}
return $page
? self::link( $page, $linkText, $attributes )
: Html::rawElement( 'span', $attributes, $linkText );
}
/**
* Generate standard user tool links (talk, contributions, block link, etc.)
*
* @since 1.42
* @param int $userId User identifier
* @param string $userText User name or IP address
* @param bool $redContribsWhenNoEdits Should the contributions link be
* red if the user has no edits?
* @param int $flags Customisation flags (e.g. Linker::TOOL_LINKS_NOBLOCK
* and Linker::TOOL_LINKS_EMAIL).
* @param int|null $edits User edit count. If you enable $redContribsWhenNoEdits,
* you may pass a pre-computed edit count here, or 0 if the caller knows that
* the account has 0 edits. Otherwise, the value is unused and null may
* be passed. If $redContribsWhenNoEdits is enabled and null is passed, the
* edit count will be lazily fetched from UserEditTracker.
* @return string[] Array of HTML fragments, each of them a link tag with a distinctive
* class; or a single string on error.
*/
public static function userToolLinkArray(
$userId, $userText, $redContribsWhenNoEdits = false, $flags = 0, $edits = null
): array {
$services = MediaWikiServices::getInstance();
$disableAnonTalk = $services->getMainConfig()->get( MainConfigNames::DisableAnonTalk );
$talkable = !( $disableAnonTalk && $userId == 0 );
$blockable = !( $flags & self::TOOL_LINKS_NOBLOCK );
$addEmailLink = $flags & self::TOOL_LINKS_EMAIL && $userId;
if ( $userId == 0 && ExternalUserNames::isExternal( $userText ) ) {
// No tools for an external user
return [];
}
$items = [];
if ( $talkable ) {
$items[] = self::userTalkLink( $userId, $userText );
}
if ( $userId ) {
// check if the user has an edit
$attribs = [];
$attribs['class'] = 'mw-usertoollinks-contribs';
if ( $redContribsWhenNoEdits ) {
if ( $edits === null ) {
$user = UserIdentityValue::newRegistered( $userId, $userText );
$edits = $services->getUserEditTracker()->getUserEditCount( $user );
}
if ( $edits === 0 ) {
// Note: "new" class is inappropriate here, as "new" class
// should only be used for pages that do not exist.
$attribs['class'] .= ' mw-usertoollinks-contribs-no-edits';
}
}
$contribsPage = SpecialPage::getTitleFor( 'Contributions', $userText );
$items[] = self::link( $contribsPage, wfMessage( 'contribslink' )->escaped(), $attribs );
}
$userCanBlock = RequestContext::getMain()->getAuthority()->isAllowed( 'block' );
if ( $blockable && $userCanBlock ) {
$items[] = self::blockLink( $userId, $userText );
}
if (
$addEmailLink
&& MediaWikiServices::getInstance()->getEmailUserFactory()
->newEmailUser( RequestContext::getMain()->getAuthority() )
->canSend()
->isGood()
) {
$items[] = self::emailLink( $userId, $userText );
}
( new HookRunner( $services->getHookContainer() ) )->onUserToolLinksEdit( $userId, $userText, $items );
return $items;
}
/**
* Generate standard tool links HTML from a link array returned by userToolLinkArray().
* @since 1.42
* @param array $items
* @param bool $useParentheses (optional, default true) Wrap comments in parentheses where needed
* @return string
*/
public static function renderUserToolLinksArray( array $items, bool $useParentheses ): string {
global $wgLang;
if ( !$items ) {
return '';
}
if ( $useParentheses ) {
return wfMessage( 'word-separator' )->escaped()
. '<span class="mw-usertoollinks">'
. wfMessage( 'parentheses' )->rawParams( $wgLang->pipeList( $items ) )->escaped()
. '</span>';
}
$tools = [];
foreach ( $items as $tool ) {
$tools[] = Html::rawElement( 'span', [], $tool );
}
return ' <span class="mw-usertoollinks mw-changeslist-links">' .
implode( ' ', $tools ) . '</span>';
}
/**
* Generate standard user tool links (talk, contributions, block link, etc.)
*
* @since 1.16.3
* @param int $userId User identifier
* @param string $userText User name or IP address
* @param bool $redContribsWhenNoEdits Should the contributions link be
* red if the user has no edits?
* @param int $flags Customisation flags (e.g. Linker::TOOL_LINKS_NOBLOCK
* and Linker::TOOL_LINKS_EMAIL).
* @param int|null $edits User edit count (optional, for performance)
* @param bool $useParentheses (optional, default true) Wrap comments in parentheses where needed
* @return string HTML fragment
*/
public static function userToolLinks(
$userId, $userText, $redContribsWhenNoEdits = false, $flags = 0, $edits = null,
$useParentheses = true
) {
if ( $userText === '' ) {
wfDebug( __METHOD__ . ' received an empty username. Are there database errors ' .
'that need to be fixed?' );
return ' ' . wfMessage( 'empty-username' )->parse();
}
$items = self::userToolLinkArray( $userId, $userText, $redContribsWhenNoEdits, $flags, $edits );
return self::renderUserToolLinksArray( $items, $useParentheses );
}
/**
* Alias for userToolLinks( $userId, $userText, true );
* @since 1.16.3
* @param int $userId User identifier
* @param string $userText User name or IP address
* @param int|null $edits User edit count (optional, for performance)
* @param bool $useParentheses (optional) Wrap comments in parentheses where needed
* @return string
*/
public static function userToolLinksRedContribs(
$userId, $userText, $edits = null, $useParentheses = true
) {
return self::userToolLinks( $userId, $userText, true, 0, $edits, $useParentheses );
}
/**
* @since 1.16.3
* @param int $userId User id in database.
* @param string $userText User name in database.
* @return string HTML fragment with user talk link
*/
public static function userTalkLink( $userId, $userText ) {
if ( $userText === '' ) {
wfDebug( __METHOD__ . ' received an empty username. Are there database errors ' .
'that need to be fixed?' );
return wfMessage( 'empty-username' )->parse();
}
$userTalkPage = TitleValue::tryNew( NS_USER_TALK, strtr( $userText, ' ', '_' ) );
$moreLinkAttribs = [ 'class' => 'mw-usertoollinks-talk' ];
$linkText = wfMessage( 'talkpagelinktext' )->escaped();
return $userTalkPage
? self::link( $userTalkPage, $linkText, $moreLinkAttribs )
: Html::rawElement( 'span', $moreLinkAttribs, $linkText );
}
/**
* @since 1.16.3
* @param int $userId
* @param string $userText User name in database.
* @return string HTML fragment with block link
*/
public static function blockLink( $userId, $userText ) {
if ( $userText === '' ) {
wfDebug( __METHOD__ . ' received an empty username. Are there database errors ' .
'that need to be fixed?' );
return wfMessage( 'empty-username' )->parse();
}
$blockPage = SpecialPage::getTitleFor( 'Block', $userText );
$moreLinkAttribs = [ 'class' => 'mw-usertoollinks-block' ];
return self::link( $blockPage,
wfMessage( 'blocklink' )->escaped(),
$moreLinkAttribs
);
}
/**
* @param int $userId
* @param string $userText User name in database.
* @return string HTML fragment with e-mail user link
*/
public static function emailLink( $userId, $userText ) {
if ( $userText === '' ) {
wfLogWarning( __METHOD__ . ' received an empty username. Are there database errors ' .
'that need to be fixed?' );
return wfMessage( 'empty-username' )->parse();
}
$emailPage = SpecialPage::getTitleFor( 'Emailuser', $userText );
$moreLinkAttribs = [ 'class' => 'mw-usertoollinks-mail' ];
return self::link( $emailPage,
wfMessage( 'emaillink' )->escaped(),
$moreLinkAttribs
);
}
/**
* Generate a user link if the current user is allowed to view it
*
* This method produces HTML that requires CSS styles in mediawiki.interface.helpers.styles.
*
* @since 1.16.3
* @param RevisionRecord $revRecord (Switched from the old Revision class to RevisionRecord
* since 1.35)
* @param bool $isPublic Show only if all users can see it
* @return string HTML fragment
*/
public static function revUserLink( RevisionRecord $revRecord, $isPublic = false ) {
// TODO inject authority
$authority = RequestContext::getMain()->getAuthority();
$revUser = $revRecord->getUser(
$isPublic ? RevisionRecord::FOR_PUBLIC : RevisionRecord::FOR_THIS_USER,
$authority
);
if ( $revUser ) {
$link = self::userLink( $revUser->getId(), $revUser->getName() );
} else {
// User is deleted and we can't (or don't want to) view it
$link = wfMessage( 'rev-deleted-user' )->escaped();
}
if ( $revRecord->isDeleted( RevisionRecord::DELETED_USER ) ) {
$class = self::getRevisionDeletedClass( $revRecord );
return '<span class="' . $class . '">' . $link . '</span>';
}
return $link;
}
/**
* Returns css class of a deleted revision
* @param RevisionRecord $revisionRecord
* @return string 'history-deleted', 'mw-history-suppressed' added if suppressed too
* @since 1.37
*/
public static function getRevisionDeletedClass( RevisionRecord $revisionRecord ): string {
$class = 'history-deleted';
if ( $revisionRecord->isDeleted( RevisionRecord::DELETED_RESTRICTED ) ) {
$class .= ' mw-history-suppressed';
}
return $class;
}
/**
* Generate a user tool link cluster if the current user is allowed to view it
*
* This method produces HTML that requires CSS styles in mediawiki.interface.helpers.styles.
*
* @since 1.16.3
* @param RevisionRecord $revRecord (Switched from the old Revision class to RevisionRecord
* since 1.35)
* @param bool $isPublic Show only if all users can see it
* @param bool $useParentheses (optional) Wrap comments in parentheses where needed
* @return string HTML
*/
public static function revUserTools(
RevisionRecord $revRecord,
$isPublic = false,
$useParentheses = true
) {
// TODO inject authority
$authority = RequestContext::getMain()->getAuthority();
$revUser = $revRecord->getUser(
$isPublic ? RevisionRecord::FOR_PUBLIC : RevisionRecord::FOR_THIS_USER,
$authority
);
if ( $revUser ) {
$link = self::userLink(
$revUser->getId(),
$revUser->getName(),
false,
[ 'data-mw-revid' => $revRecord->getId() ]
) . self::userToolLinks(
$revUser->getId(),
$revUser->getName(),
false,
0,
null,
$useParentheses
);
} else {
// User is deleted and we can't (or don't want to) view it
$link = wfMessage( 'rev-deleted-user' )->escaped();
}
if ( $revRecord->isDeleted( RevisionRecord::DELETED_USER ) ) {
$class = self::getRevisionDeletedClass( $revRecord );
return ' <span class="' . $class . ' mw-userlink">' . $link . '</span>';
}
return $link;
}
/**
* Helper function to expand local links. Mostly used in action=render
*
* @since 1.38
* @unstable
*
* @param string $html
*
* @return string HTML
*/
public static function expandLocalLinks( string $html ) {
return HtmlHelper::modifyElements(
$html,
static function ( SerializerNode $node ): bool {
return $node->name === 'a' && isset( $node->attrs['href'] );
},
static function ( SerializerNode $node ): SerializerNode {
$node->attrs['href'] =
wfExpandUrl( $node->attrs['href'], PROTO_RELATIVE );
return $node;
}
);
}
/**
* @param LinkTarget|null $contextTitle
* @param string $target
* @param string &$text
* @return string
*/
public static function normalizeSubpageLink( $contextTitle, $target, &$text ) {
# Valid link forms:
# Foobar -- normal
# :Foobar -- override special treatment of prefix (images, language links)
# /Foobar -- convert to CurrentPage/Foobar
# /Foobar/ -- convert to CurrentPage/Foobar, strip the initial and final / from text
# ../ -- convert to CurrentPage, from CurrentPage/CurrentSubPage
# ../Foobar -- convert to CurrentPage/Foobar,
# (from CurrentPage/CurrentSubPage)
# ../Foobar/ -- convert to CurrentPage/Foobar, use 'Foobar' as text
# (from CurrentPage/CurrentSubPage)
$ret = $target; # default return value is no change
# Some namespaces don't allow subpages,
# so only perform processing if subpages are allowed
if (
$contextTitle && MediaWikiServices::getInstance()->getNamespaceInfo()->
hasSubpages( $contextTitle->getNamespace() )
) {
$hash = strpos( $target, '#' );
if ( $hash !== false ) {
$suffix = substr( $target, $hash );
$target = substr( $target, 0, $hash );
} else {
$suffix = '';
}
# T9425
$target = trim( $target );
$contextPrefixedText = MediaWikiServices::getInstance()->getTitleFormatter()->
getPrefixedText( $contextTitle );
# Look at the first character
if ( $target != '' && $target[0] === '/' ) {
# / at end means we don't want the slash to be shown
$m = [];
$trailingSlashes = preg_match_all( '%(/+)$%', $target, $m );
if ( $trailingSlashes ) {
$noslash = $target = substr( $target, 1, -strlen( $m[0][0] ) );
} else {
$noslash = substr( $target, 1 );
}
$ret = $contextPrefixedText . '/' . trim( $noslash ) . $suffix;
if ( $text === '' ) {
$text = $target . $suffix;
} # this might be changed for ugliness reasons
} else {
# check for .. subpage backlinks
$dotdotcount = 0;
$nodotdot = $target;
while ( str_starts_with( $nodotdot, '../' ) ) {
++$dotdotcount;
$nodotdot = substr( $nodotdot, 3 );
}
if ( $dotdotcount > 0 ) {
$exploded = explode( '/', $contextPrefixedText );
if ( count( $exploded ) > $dotdotcount ) { # not allowed to go below top level page
$ret = implode( '/', array_slice( $exploded, 0, -$dotdotcount ) );
# / at the end means don't show full path
if ( substr( $nodotdot, -1, 1 ) === '/' ) {
$nodotdot = rtrim( $nodotdot, '/' );
if ( $text === '' ) {
$text = $nodotdot . $suffix;
}
}
$nodotdot = trim( $nodotdot );
if ( $nodotdot != '' ) {
$ret .= '/' . $nodotdot;
}
$ret .= $suffix;
}
}
}
}
return $ret;
}
/**
* @since 1.16.3
* @param int $size
* @return string
*/
public static function formatRevisionSize( $size ) {
if ( $size == 0 ) {
$stxt = wfMessage( 'historyempty' )->escaped();
} else {
$stxt = wfMessage( 'nbytes' )->numParams( $size )->escaped();
}
return "<span class=\"history-size mw-diff-bytes\" data-mw-bytes=\"$size\">$stxt</span>";
}
/**
* Split a link trail, return the "inside" portion and the remainder of the trail
* as a two-element array
* @param string $trail
* @return string[]
*/
public static function splitTrail( $trail ) {
$regex = MediaWikiServices::getInstance()->getContentLanguage()->linkTrail();
$inside = '';
if ( $trail !== '' && preg_match( $regex, $trail, $m ) ) {
[ , $inside, $trail ] = $m;
}
return [ $inside, $trail ];
}
/**
* Generate a rollback link for a given revision. Currently it's the
* caller's responsibility to ensure that the revision is the top one. If
* it's not, of course, the user will get an error message.
*
* If the calling page is called with the parameter &bot=1, all rollback
* links also get that parameter. It causes the edit itself and the rollback
* to be marked as "bot" edits. Bot edits are hidden by default from recent
* changes, so this allows sysops to combat a busy vandal without bothering
* other users.
*
* This function will return the link only in case the revision can be reverted
* (not all revisions are by the same user, and the last revision by a different
* user is visible). Please note that due to performance limitations it might be
* assumed that a user isn't the only contributor of a page while (s)he is, which
* will lead to useless rollback links. Furthermore this won't work if
* $wgShowRollbackEditCount is disabled, so this can only function as an
* additional check.
*
* If the option noBrackets is set the rollback link wont be enclosed in "[]".
*
* @since 1.16.3. $context added in 1.20. $options added in 1.21
* $rev could be a RevisionRecord since 1.35
*
* @param RevisionRecord $revRecord (Switched from the old Revision class to RevisionRecord
* since 1.35)
* @param IContextSource|null $context Context to use or null for the main context.
* @param array $options
* @return string
*/
public static function generateRollback(
RevisionRecord $revRecord,
IContextSource $context = null,
$options = []
) {
$context ??= RequestContext::getMain();
$editCount = self::getRollbackEditCount( $revRecord );
if ( $editCount === false ) {
return '';
}
$inner = self::buildRollbackLink( $revRecord, $context, $editCount );
$services = MediaWikiServices::getInstance();
// Allow extensions to modify the rollback link.
// Abort further execution if the extension wants full control over the link.
if ( !( new HookRunner( $services->getHookContainer() ) )->onLinkerGenerateRollbackLink(
$revRecord, $context, $options, $inner ) ) {
return $inner;
}
if ( !in_array( 'noBrackets', $options, true ) ) {
$inner = $context->msg( 'brackets' )->rawParams( $inner )->escaped();
}
if ( $services->getUserOptionsLookup()
->getBoolOption( $context->getUser(), 'showrollbackconfirmation' )
) {
$services->getStatsFactory()
->getCounter( 'rollbackconfirmation_event_load_total' )
->copyToStatsdAt( 'rollbackconfirmation.event.load' )
->increment();
$context->getOutput()->addModules( 'mediawiki.misc-authed-curate' );
}
return '<span class="mw-rollback-link">' . $inner . '</span>';
}
/**
* This function will return the number of revisions which a rollback
* would revert and will verify that a revision can be reverted (that
* the user isn't the only contributor and the revision we might
* rollback to isn't deleted). These checks can only function as an
* additional check as this function only checks against the last
* $wgShowRollbackEditCount edits.
*
* Returns null if $wgShowRollbackEditCount is disabled or false if
* the user is the only contributor of the page.
*
* @todo Unused outside of this file - should it be made private?
*
* @param RevisionRecord $revRecord (Switched from the old Revision class to RevisionRecord
* since 1.35)
* @param bool $verify Deprecated since 1.40, has no effect.
* @return int|false|null
*/
public static function getRollbackEditCount( RevisionRecord $revRecord, $verify = true ) {
if ( func_num_args() > 1 ) {
wfDeprecated( __METHOD__ . ' with $verify parameter', '1.40' );
}
$showRollbackEditCount = MediaWikiServices::getInstance()->getMainConfig()
->get( MainConfigNames::ShowRollbackEditCount );
if ( !is_int( $showRollbackEditCount ) || !$showRollbackEditCount > 0 ) {
// Nothing has happened, indicate this by returning 'null'
return null;
}
$dbr = MediaWikiServices::getInstance()->getConnectionProvider()->getReplicaDatabase();
// Up to the value of $wgShowRollbackEditCount revisions are counted
$queryBuilder = MediaWikiServices::getInstance()->getRevisionStore()->newSelectQueryBuilder( $dbr );
$res = $queryBuilder->where( [ 'rev_page' => $revRecord->getPageId() ] )
->useIndex( [ 'revision' => 'rev_page_timestamp' ] )
->orderBy( [ 'rev_timestamp', 'rev_id' ], SelectQueryBuilder::SORT_DESC )
->limit( $showRollbackEditCount + 1 )
->caller( __METHOD__ )->fetchResultSet();
$revUser = $revRecord->getUser( RevisionRecord::RAW );
$revUserText = $revUser ? $revUser->getName() : '';
$editCount = 0;
$moreRevs = false;
foreach ( $res as $row ) {
if ( $row->rev_user_text != $revUserText ) {
if ( $row->rev_deleted & RevisionRecord::DELETED_TEXT
|| $row->rev_deleted & RevisionRecord::DELETED_USER
) {
// If the user or the text of the revision we might rollback
// to is deleted in some way we can't rollback. Similar to
// the checks in WikiPage::commitRollback.
return false;
}
$moreRevs = true;
break;
}
$editCount++;
}
if ( $editCount <= $showRollbackEditCount && !$moreRevs ) {
// We didn't find at least $wgShowRollbackEditCount revisions made by the current user
// and there weren't any other revisions. That means that the current user is the only
// editor, so we can't rollback
return false;
}
return $editCount;
}
/**
* Build a raw rollback link, useful for collections of "tool" links
*
* @since 1.16.3. $context added in 1.20. $editCount added in 1.21
* $rev could be a RevisionRecord since 1.35
*
* @todo Unused outside of this file - should it be made private?
*
* @param RevisionRecord $revRecord (Switched from the old Revision class to RevisionRecord
* since 1.35)
* @param IContextSource|null $context Context to use or null for the main context.
* @param int|false|null $editCount Number of edits that would be reverted
* @return string HTML fragment
*/
public static function buildRollbackLink(
RevisionRecord $revRecord,
IContextSource $context = null,
$editCount = false
) {
$config = MediaWikiServices::getInstance()->getMainConfig();
$showRollbackEditCount = $config->get( MainConfigNames::ShowRollbackEditCount );
$miserMode = $config->get( MainConfigNames::MiserMode );
// To config which pages are affected by miser mode
$disableRollbackEditCountSpecialPage = [ 'Recentchanges', 'Watchlist' ];
$context ??= RequestContext::getMain();
$title = $revRecord->getPageAsLinkTarget();
$revUser = $revRecord->getUser();
$revUserText = $revUser ? $revUser->getName() : '';
$query = [
'action' => 'rollback',
'from' => $revUserText,
'token' => $context->getUser()->getEditToken( 'rollback' ),
];
$attrs = [
'data-mw' => 'interface',
'title' => $context->msg( 'tooltip-rollback' )->text()
];
$options = [ 'known', 'noclasses' ];
if ( $context->getRequest()->getBool( 'bot' ) ) {
// T17999
$query['hidediff'] = '1';
$query['bot'] = '1';
}
if ( $miserMode ) {
foreach ( $disableRollbackEditCountSpecialPage as $specialPage ) {
if ( $context->getTitle()->isSpecial( $specialPage ) ) {
$showRollbackEditCount = false;
break;
}
}
}
// The edit count can be 0 on replica lag, fall back to the generic rollbacklink message
$msg = [ 'rollbacklink' ];
if ( is_int( $showRollbackEditCount ) && $showRollbackEditCount > 0 ) {
if ( !is_numeric( $editCount ) ) {
$editCount = self::getRollbackEditCount( $revRecord );
}
if ( $editCount > $showRollbackEditCount ) {
$msg = [ 'rollbacklinkcount-morethan', Message::numParam( $showRollbackEditCount ) ];
} elseif ( $editCount ) {
$msg = [ 'rollbacklinkcount', Message::numParam( $editCount ) ];
}
}
$html = $context->msg( ...$msg )->parse();
return self::link( $title, $html, $attrs, $query, $options );
}
/**
* Returns HTML for the "hidden categories on this page" list.
*
* @since 1.16.3
* @param array $hiddencats Array of hidden categories
* from {@link WikiPage::getHiddenCategories} or similar
* @return string HTML output
*/
public static function formatHiddenCategories( $hiddencats ) {
$outText = '';
if ( count( $hiddencats ) > 0 ) {
# Construct the HTML
$outText = '<div class="mw-hiddenCategoriesExplanation">';
$outText .= wfMessage( 'hiddencategories' )->numParams( count( $hiddencats ) )->parseAsBlock();
$outText .= "</div><ul>\n";
foreach ( $hiddencats as $titleObj ) {
# If it's hidden, it must exist - no need to check with a LinkBatch
$outText .= '<li>'
. self::link( $titleObj, null, [], [], 'known' )
. "</li>\n";
}
$outText .= '</ul>';
}
return $outText;
}
/**
* @return ContextSource
*/
private static function getContextFromMain() {
$context = RequestContext::getMain();
$context = new DerivativeContext( $context );
return $context;
}
/**
* Given the id of an interface element, constructs the appropriate title
* attribute from the system messages. (Note, this is usually the id but
* isn't always, because sometimes the accesskey needs to go on a different
* element than the id, for reverse-compatibility, etc.)
*
* @since 1.16.3 $msgParams added in 1.27
* @param string $name Id of the element, minus prefixes.
* @param string|array|null $options Null, string or array with some of the following options:
* - 'withaccess' to add an access-key hint
* - 'nonexisting' to add an accessibility hint that page does not exist
* @param array $msgParams Parameters to pass to the message
* @param MessageLocalizer|null $localizer
*
* @return string|false Contents of the title attribute (which you must HTML-
* escape), or false for no title attribute
*/
public static function titleAttrib( $name, $options = null, array $msgParams = [], $localizer = null ) {
if ( !$localizer ) {
$localizer = self::getContextFromMain();
}
$message = $localizer->msg( "tooltip-$name", $msgParams );
// Set a default tooltip for subject namespace tabs if that hasn't
// been defined. See T22126
if ( !$message->exists() && str_starts_with( $name, 'ca-nstab-' ) ) {
$message = $localizer->msg( 'tooltip-ca-nstab' );
}
if ( $message->isDisabled() ) {
$tooltip = false;
} else {
$tooltip = $message->text();
# Compatibility: formerly some tooltips had [alt-.] hardcoded
$tooltip = preg_replace( "/ ?\[alt-.\]$/", '', $tooltip );
}
$options = (array)$options;
if ( in_array( 'nonexisting', $options ) ) {
$tooltip = $localizer->msg( 'red-link-title', $tooltip ?: '' )->text();
}
if ( in_array( 'withaccess', $options ) ) {
$accesskey = self::accesskey( $name, $localizer );
if ( $accesskey !== false ) {
// Should be build the same as in jquery.accessKeyLabel.js
if ( $tooltip === false || $tooltip === '' ) {
$tooltip = $localizer->msg( 'brackets', $accesskey )->text();
} else {
$tooltip .= $localizer->msg( 'word-separator' )->text();
$tooltip .= $localizer->msg( 'brackets', $accesskey )->text();
}
}
}
return $tooltip;
}
public static $accesskeycache;
/**
* Given the id of an interface element, constructs the appropriate
* accesskey attribute from the system messages. (Note, this is usually
* the id but isn't always, because sometimes the accesskey needs to go on
* a different element than the id, for reverse-compatibility, etc.)
*
* @since 1.16.3
* @param string $name Id of the element, minus prefixes.
* @param MessageLocalizer|null $localizer
* @return string|false Contents of the accesskey attribute (which you must HTML-
* escape), or false for no accesskey attribute
*/
public static function accesskey( $name, $localizer = null ) {
if ( !isset( self::$accesskeycache[$name] ) ) {
if ( !$localizer ) {
$localizer = self::getContextFromMain();
}
$msg = $localizer->msg( "accesskey-$name" );
// Set a default accesskey for subject namespace tabs if an
// accesskey has not been defined. See T22126
if ( !$msg->exists() && str_starts_with( $name, 'ca-nstab-' ) ) {
$msg = $localizer->msg( 'accesskey-ca-nstab' );
}
self::$accesskeycache[$name] = $msg->isDisabled() ? false : $msg->plain();
}
return self::$accesskeycache[$name];
}
/**
* Get a revision-deletion link, or disabled link, or nothing, depending
* on user permissions & the settings on the revision.
*
* Will use forward-compatible revision ID in the Special:RevDelete link
* if possible, otherwise the timestamp-based ID which may break after
* undeletion.
*
* @param Authority $performer
* @param RevisionRecord $revRecord (Switched from the old Revision class to RevisionRecord
* since 1.35)
* @param LinkTarget $title
* @return string HTML fragment
*/
public static function getRevDeleteLink(
Authority $performer,
RevisionRecord $revRecord,
LinkTarget $title
) {
$canHide = $performer->isAllowed( 'deleterevision' );
$canHideHistory = $performer->isAllowed( 'deletedhistory' );
if ( !$canHide && !( $revRecord->getVisibility() && $canHideHistory ) ) {
return '';
}
if ( !$revRecord->userCan( RevisionRecord::DELETED_RESTRICTED, $performer ) ) {
return self::revDeleteLinkDisabled( $canHide ); // revision was hidden from sysops
}
$prefixedDbKey = MediaWikiServices::getInstance()->getTitleFormatter()->
getPrefixedDBkey( $title );
if ( $revRecord->getId() ) {
// RevDelete links using revision ID are stable across
// page deletion and undeletion; use when possible.
$query = [
'type' => 'revision',
'target' => $prefixedDbKey,
'ids' => $revRecord->getId()
];
} else {
// Older deleted entries didn't save a revision ID.
// We have to refer to these by timestamp, ick!
$query = [
'type' => 'archive',
'target' => $prefixedDbKey,
'ids' => $revRecord->getTimestamp()
];
}
return self::revDeleteLink(
$query,
$revRecord->isDeleted( RevisionRecord::DELETED_RESTRICTED ),
$canHide
);
}
/**
* Creates a (show/hide) link for deleting revisions/log entries
*
* This method produces HTML that requires CSS styles in mediawiki.interface.helpers.styles.
*
* @param array $query Query parameters to be passed to link()
* @param bool $restricted Set to true to use a "<strong>" instead of a "<span>"
* @param bool $delete Set to true to use (show/hide) rather than (show)
*
* @return string HTML "<a>" link to Special:Revisiondelete, wrapped in a
* span to allow for customization of appearance with CSS
*/
public static function revDeleteLink( $query = [], $restricted = false, $delete = true ) {
$sp = SpecialPage::getTitleFor( 'Revisiondelete' );
$msgKey = $delete ? 'rev-delundel' : 'rev-showdeleted';
$html = wfMessage( $msgKey )->escaped();
$tag = $restricted ? 'strong' : 'span';
$link = self::link( $sp, $html, [], $query, [ 'known', 'noclasses' ] );
return Xml::tags(
$tag,
[ 'class' => 'mw-revdelundel-link' ],
wfMessage( 'parentheses' )->rawParams( $link )->escaped()
);
}
/**
* Creates a dead (show/hide) link for deleting revisions/log entries
*
* This method produces HTML that requires CSS styles in mediawiki.interface.helpers.styles.
*
* @since 1.16.3
* @param bool $delete Set to true to use (show/hide) rather than (show)
*
* @return string HTML text wrapped in a span to allow for customization
* of appearance with CSS
*/
public static function revDeleteLinkDisabled( $delete = true ) {
$msgKey = $delete ? 'rev-delundel' : 'rev-showdeleted';
$html = wfMessage( $msgKey )->escaped();
$htmlParentheses = wfMessage( 'parentheses' )->rawParams( $html )->escaped();
return Xml::tags( 'span', [ 'class' => 'mw-revdelundel-link' ], $htmlParentheses );
}
/**
* Returns the attributes for the tooltip and access key.
*
* @since 1.16.3. $msgParams introduced in 1.27
* @param string $name
* @param array $msgParams Params for constructing the message
* @param string|array|null $options Options to be passed to titleAttrib.
* @param MessageLocalizer|null $localizer
*
* @see Linker::titleAttrib for what options could be passed to $options.
*
* @return array
*/
public static function tooltipAndAccesskeyAttribs(
$name,
array $msgParams = [],
$options = null,
$localizer = null
) {
$options = (array)$options;
$options[] = 'withaccess';
// Get optional parameters from global context if any missing.
if ( !$localizer ) {
$localizer = self::getContextFromMain();
}
$attribs = [
'title' => self::titleAttrib( $name, $options, $msgParams, $localizer ),
'accesskey' => self::accesskey( $name, $localizer )
];
if ( $attribs['title'] === false ) {
unset( $attribs['title'] );
}
if ( $attribs['accesskey'] === false ) {
unset( $attribs['accesskey'] );
}
return $attribs;
}
/**
* Returns raw bits of HTML, use titleAttrib()
* @since 1.16.3
* @param string $name
* @param array|null $options
* @return null|string
*/
public static function tooltip( $name, $options = null ) {
$tooltip = self::titleAttrib( $name, $options );
if ( $tooltip === false ) {
return '';
}
return Xml::expandAttributes( [
'title' => $tooltip
] );
}
}
/** @deprecated class alias since 1.40 */
class_alias( Linker::class, 'Linker' );