<?php
/**
- * Split off some of the internal bits from Skin.php. These functions are used
+ * 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
+ */
+use MediaWiki\Linker\LinkTarget;
+use MediaWiki\MediaWikiServices;
+
+/**
+ * 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. For the moment, Skin is a descendent class of
- * Linker. In the future, it should probably be further split so that every
- * other bit of the wiki doesn't have to go loading up Skin to get at it.
+ * 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()
*/
const TOOL_LINKS_NOBLOCK = 1;
-
- function __construct() {}
+ const TOOL_LINKS_EMAIL = 2;
/**
- * Get the appropriate HTML attributes to add to the "a" element of an ex-
- * ternal link, as created by [wikisyntax].
+ * Return the CSS colour of a known link
*
- * @param $class String: the contents of the class attribute; if an empty
- * string is passed, which is the default value, defaults to 'external'.
- */
- function getExternalLinkAttributes( $class = 'external' ) {
- return $this->getLinkAttributesInternal( '', $class );
- }
-
- /**
- * Get the appropriate HTML attributes to add to the "a" element of an in-
- * terwiki link.
- *
- * @param $title String: the title text for the link, URL-encoded (???) but
- * not HTML-escaped
- * @param $unused String: unused
- * @param $class String: the contents of the class attribute; if an empty
- * string is passed, which is the default value, defaults to 'external'.
- */
- function getInterwikiLinkAttributes( $title, $unused = null, $class = 'external' ) {
- global $wgContLang;
-
- # FIXME: We have a whole bunch of handling here that doesn't happen in
- # getExternalLinkAttributes, why?
- $title = urldecode( $title );
- $title = $wgContLang->checkTitleEncoding( $title );
- $title = preg_replace( '/[\\x00-\\x1f]/', ' ', $title );
-
- return $this->getLinkAttributesInternal( $title, $class );
- }
-
- /**
- * Get the appropriate HTML attributes to add to the "a" element of an in-
- * ternal link.
+ * @deprecated since 1.28, use LinkRenderer::getLinkClasses() instead
*
- * @param $title String: the title text for the link, URL-encoded (???) but
- * not HTML-escaped
- * @param $unused String: unused
- * @param $class String: the contents of the class attribute, default none
+ * @since 1.16.3
+ * @param LinkTarget $t
+ * @param int $threshold User defined threshold
+ * @return string CSS class
*/
- function getInternalLinkAttributes( $title, $unused = null, $class = '' ) {
- $title = urldecode( $title );
- $title = str_replace( '_', ' ', $title );
- return $this->getLinkAttributesInternal( $title, $class );
- }
-
- /**
- * Get the appropriate HTML attributes to add to the "a" element of an in-
- * ternal link, given the Title object for the page we want to link to.
- *
- * @param $nt The Title object
- * @param $unused String: unused
- * @param $class String: the contents of the class attribute, default none
- * @param $title Mixed: optional (unescaped) string to use in the title
- * attribute; if false, default to the name of the page we're linking to
- */
- function getInternalLinkAttributesObj( $nt, $unused = null, $class = '', $title = false ) {
- if ( $title === false ) {
- $title = $nt->getPrefixedText();
+ public static function getLinkColour( LinkTarget $t, $threshold ) {
+ wfDeprecated( __METHOD__, '1.28' );
+ $services = MediaWikiServices::getInstance();
+ $linkRenderer = $services->getLinkRenderer();
+ if ( $threshold !== $linkRenderer->getStubThreshold() ) {
+ // Need to create a new instance with the right stub threshold...
+ $linkRenderer = $services->getLinkRendererFactory()->create();
+ $linkRenderer->setStubThreshold( $threshold );
}
- return $this->getLinkAttributesInternal( $title, $class );
- }
- /**
- * Common code for getLinkAttributesX functions
- */
- private function getLinkAttributesInternal( $title, $class ) {
- $title = htmlspecialchars( $title );
- $class = htmlspecialchars( $class );
- $r = '';
- if ( $class != '' ) {
- $r .= " class=\"$class\"";
- }
- if ( $title != '' ) {
- $r .= " title=\"$title\"";
- }
- return $r;
- }
-
- /**
- * Return the CSS colour of a known link
- *
- * @param $t Title object
- * @param $threshold Integer: user defined threshold
- * @return String: CSS class
- */
- function getLinkColour( $t, $threshold ) {
- $colour = '';
- if ( $t->isRedirect() ) {
- # Page is a redirect
- $colour = 'mw-redirect';
- } elseif ( $threshold > 0 &&
- $t->exists() && $t->getLength() < $threshold &&
- $t->isContentPage() ) {
- # Page is a stub
- $colour = 'stub';
- }
- return $colour;
+ return $linkRenderer->getLinkClasses( $t );
}
/**
* name of the target).
* link() replaces the old functions in the makeLink() family.
*
- * @param $target Title Can currently only be a Title, but this may
+ * @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
$text string The HTML contents of the <a> element, i.e.,
+ * @param
string $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 Title; or if the Title is just a
* fragment, the contents of the fragment.
- * @param $customAttribs array A key => value array of extra HTML attri-
- * butes, such as title and class. (href is ignored.) Classes will be
+ * @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 $query array The query string to append to the URL
+ * @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 $options mixed String or array of strings:
+ * @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",
* cons.
* '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.
+ * 'stubThreshold' => (int): Stub threshold to use when determining link classes.
* @return string HTML <a> attribute
*/
- public function link( $target, $text = null, $customAttribs = array(), $query = array(), $options = array() ) {
- wfProfileIn( __METHOD__ );
- if ( !$target instanceof Title ) {
- wfProfileOut( __METHOD__ );
- return "<!-- ERROR -->$text";
+ 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";
}
- $options = (array)$options;
- $ret = null;
- if ( !wfRunHooks( 'LinkBegin', array( $this, $target, &$text,
- &$customAttribs, &$query, &$options, &$ret ) ) ) {
- wfProfileOut( __METHOD__ );
- return $ret;
+ if ( is_string( $query ) ) {
+ // some functions withing core using this still hand over query strings
+ wfDeprecated( __METHOD__ . ' with parameter $query as string (should be array)', '1.20' );
+ $query = wfCgiToArray( $query );
}
- # Normalize the Title if it's a special page
- $target = $this->normaliseSpecialPage( $target );
-
- # If we don't know whether the page exists, let's find out.
- wfProfileIn( __METHOD__ . '-checkPageExistence' );
- if ( !in_array( 'known', $options ) and !in_array( 'broken', $options ) ) {
- if ( $target->isKnown() ) {
- $options[] = 'known';
- } else {
- $options[] = 'broken';
+ $services = MediaWikiServices::getInstance();
+ $options = (array)$options;
+ if ( $options ) {
+ // Custom options, create new LinkRenderer
+ if ( !isset( $options['stubThreshold'] ) ) {
+ $defaultLinkRenderer = $services->getLinkRenderer();
+ $options['stubThreshold'] = $defaultLinkRenderer->getStubThreshold();
}
- }
- wfProfileOut( __METHOD__ . '-checkPageExistence' );
-
- $oldquery = array();
- if ( in_array( "forcearticlepath", $options ) && $query ) {
- $oldquery = $query;
- $query = array();
- }
-
- # Note: we want the href attribute first, for prettiness.
- $attribs = array( 'href' => $this->linkUrl( $target, $query, $options ) );
- if ( in_array( 'forcearticlepath', $options ) && $oldquery ) {
- $attribs['href'] = wfAppendQuery( $attribs['href'], wfArrayToCgi( $oldquery ) );
- }
-
- $attribs = array_merge(
- $attribs,
- $this->linkAttribs( $target, $customAttribs, $options )
- );
- if ( is_null( $text ) ) {
- $text = $this->linkText( $target );
+ $linkRenderer = $services->getLinkRendererFactory()
+ ->createFromLegacyOptions( $options );
+ } else {
+ $linkRenderer = $services->getLinkRenderer();
}
- $ret = null;
- if ( wfRunHooks( 'LinkEnd', array( $this, $target, $options, &$text, &$attribs, &$ret ) ) ) {
- $ret = Html::rawElement( 'a', $attribs, $text );
+ if ( $html !== null ) {
+ $text = new HtmlArmor( $html );
+ } else {
+ $text = $html; // null
+ }
+ if ( in_array( 'known', $options, true ) ) {
+ return $linkRenderer->makeKnownLink( $target, $text, $customAttribs, $query );
+ } elseif ( in_array( 'broken', $options, true ) ) {
+ return $linkRenderer->makeBrokenLink( $target, $text, $customAttribs, $query );
+ } elseif ( in_array( 'noclasses', $options, true ) ) {
+ return $linkRenderer->makePreloadedLink( $target, $text, '', $customAttribs, $query );
+ } else {
+ return $linkRenderer->makeLink( $target, $text, $customAttribs, $query );
}
-
- wfProfileOut( __METHOD__ );
- return $ret;
}
/**
* 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 Title $target
+ * @param string $html
+ * @param array $customAttribs
+ * @param array $query
+ * @param string|array $options
+ * @return string
*/
- public function linkKnown( $target, $text = null, $customAttribs = array(), $query = array(), $options = array( 'known', 'noclasses' ) ) {
- return $this->link( $target, $text, $customAttribs, $query, $options );
- }
-
- /**
- * Returns the Url used to link to a Title
- */
- private function linkUrl( $target, $query, $options ) {
- wfProfileIn( __METHOD__ );
- # We don't want to include fragments for broken links, because they
- # generally make no sense.
- if ( in_array( 'broken', $options ) and $target->mFragment !== '' ) {
- $target = clone $target;
- $target->mFragment = '';
- }
-
- # If it's a broken link, add the appropriate query pieces, unless
- # there's already an action specified, or unless 'edit' makes no sense
- # (i.e., for a nonexistent special page).
- if ( in_array( 'broken', $options ) and empty( $query['action'] )
- and $target->getNamespace() != NS_SPECIAL ) {
- $query['action'] = 'edit';
- $query['redlink'] = '1';
- }
- $ret = $target->getLinkUrl( $query );
- wfProfileOut( __METHOD__ );
- return $ret;
+ public static function linkKnown(
+ $target, $html = null, $customAttribs = [],
+ $query = [], $options = [ 'known' ]
+ ) {
+ return self::link( $target, $html, $customAttribs, $query, $options );
}
/**
- * Returns the array of attributes used when linking to the Title $target
+ * 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 Title $nt
+ * @param string $html [optional]
+ * @param string $query [optional]
+ * @param string $trail [optional]
+ * @param string $prefix [optional]
+ *
+ * @return string
*/
- private function linkAttribs( $target, $attribs, $options ) {
- wfProfileIn( __METHOD__ );
- global $wgUser;
- $defaults = array();
-
- if ( !in_array( 'noclasses', $options ) ) {
- wfProfileIn( __METHOD__ . '-getClasses' );
- # Now build the classes.
- $classes = array();
-
- if ( in_array( 'broken', $options ) ) {
- $classes[] = 'new';
- }
-
- if ( $target->isExternal() ) {
- $classes[] = 'extiw';
- }
-
- if ( !in_array( 'broken', $options ) ) { # Avoid useless calls to LinkCache (see r50387)
- $colour = $this->getLinkColour( $target, $wgUser->getStubThreshold() );
- if ( $colour !== '' ) {
- $classes[] = $colour; # mw-redirect or stub
- }
- }
- if ( $classes != array() ) {
- $defaults['class'] = implode( ' ', $classes );
- }
- wfProfileOut( __METHOD__ . '-getClasses' );
+ public static function makeSelfLinkObj( $nt, $html = '', $query = '', $trail = '', $prefix = '' ) {
+ $ret = "<a class=\"mw-selflink selflink\">{$prefix}{$html}</a>{$trail}";
+ if ( !Hooks::run( 'SelfLinkBegin', [ $nt, &$html, &$trail, &$prefix, &$ret ] ) ) {
+ return $ret;
}
- # Get a default title attribute.
- if ( $target->getPrefixedText() == '' ) {
- # A link like [[#Foo]]. This used to mean an empty title
- # attribute, but that's silly. Just don't output a title.
- } elseif ( in_array( 'known', $options ) ) {
- $defaults['title'] = $target->getPrefixedText();
- } else {
- $defaults['title'] = wfMsg( 'red-link-title', $target->getPrefixedText() );
- }
-
- # Finally, merge the custom attribs with the default ones, and iterate
- # over that, deleting all "false" attributes.
- $ret = array();
- $merged = Sanitizer::mergeAttributes( $defaults, $attribs );
- foreach ( $merged as $key => $val ) {
- # A false value suppresses the attribute, and we don't want the
- # href attribute to be overridden.
- if ( $key != 'href' and $val !== false ) {
- $ret[$key] = $val;
- }
+ if ( $html == '' ) {
+ $html = htmlspecialchars( $nt->getPrefixedText() );
}
- wfProfileOut( __METHOD__ );
- return $ret;
+ list( $inside, $trail ) = self::splitTrail( $trail );
+ return "<a class=\"mw-selflink selflink\">{$prefix}{$html}{$inside}</a>{$trail}";
}
/**
- * Default text of the links to the Title $target
+ * 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
*/
- private function linkText( $target ) {
- # We might be passed a non-Title by make*LinkObj(). Fail gracefully.
- if ( !$target instanceof Title ) {
- return '';
- }
+ public static function getInvalidTitleDescription( IContextSource $context, $namespace, $title ) {
+ global $wgContLang;
- # If the target is just a fragment, with no title, we return the frag-
- # ment text. Otherwise, we return the title text itself.
- if ( $target->getPrefixedText() === '' and $target->getFragment() !== '' ) {
- return htmlspecialchars( $target->getFragment() );
+ // First we check whether the namespace exists or not.
+ if ( MWNamespace::exists( $namespace ) ) {
+ if ( $namespace == NS_MAIN ) {
+ $name = $context->msg( 'blanknamespace' )->text();
+ } else {
+ $name = $wgContLang->getFormattedNsText( $namespace );
+ }
+ return $context->msg( 'invalidtitle-knownnamespace', $namespace, $name, $title )->text();
+ } else {
+ return $context->msg( 'invalidtitle-unknownnamespace', $namespace, $title )->text();
}
- return htmlspecialchars( $target->getPrefixedText() );
}
/**
- * Generate either a normal exists-style link or a stub link, depending
- * on the given page size.
- *
- * @param $size Integer
- * @param $nt Title object.
- * @param $text String
- * @param $query String
- * @param $trail String
- * @param $prefix String
- * @return string HTML of link
- * @deprecated
+ * @since 1.16.3
+ * @param LinkTarget $target
+ * @return LinkTarget
*/
- function makeSizeLinkObj( $size, $nt, $text = '', $query = '', $trail = '', $prefix = '' ) {
- global $wgUser;
- wfDeprecated( __METHOD__ );
-
- $threshold = $wgUser->getStubThreshold();
- $colour = ( $size < $threshold ) ? 'stub' : '';
- // FIXME: replace deprecated makeColouredLinkObj by link()
- return $this->makeColouredLinkObj( $nt, $colour, $text, $query, $trail, $prefix );
- }
-
- /**
- * Make appropriate markup for a link to the current article. This is currently rendered
- * as the bold link text. The calling sequence is the same as the other make*LinkObj functions,
- * despite $query not being used.
- */
- function makeSelfLinkObj( $nt, $text = '', $query = '', $trail = '', $prefix = '' ) {
- if ( $text == '' ) {
- $text = htmlspecialchars( $nt->getPrefixedText() );
- }
- list( $inside, $trail ) = Linker::splitTrail( $trail );
- return "<strong class=\"selflink\">{$prefix}{$text}{$inside}</strong>{$trail}";
- }
-
- function normaliseSpecialPage( Title $title ) {
- if ( $title->getNamespace() == NS_SPECIAL ) {
- list( $name, $subpage ) = SpecialPage::resolveAliasWithSubpage( $title->getDBkey() );
+ public static function normaliseSpecialPage( LinkTarget $target ) {
+ if ( $target->getNamespace() == NS_SPECIAL && !$target->isExternal() ) {
+ list( $name, $subpage ) = SpecialPageFactory::resolveAlias( $target->getDBkey() );
if ( !$name ) {
- return $title;
+ return $target;
}
- $ret = SpecialPage::getTitleFor( $name, $subpage );
- $ret->mFragment = $title->getFragment();
+ $ret = SpecialPage::getTitleValueFor( $name, $subpage, $target->getFragment() );
return $ret;
} else {
- return $title;
+ return $target;
}
}
/**
* Returns the filename part of an url.
* Used as alternative text for external images.
+ *
+ * @param string $url
+ *
+ * @return string
*/
- function fnamePart( $url ) {
+ private static function fnamePart( $url ) {
$basename = strrchr( $url, '/' );
if ( false === $basename ) {
$basename = $url;
/**
* 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
*/
- function makeExternalImage( $url, $alt = '' ) {
+ public static function makeExternalImage( $url, $alt = '' ) {
if ( $alt == '' ) {
- $alt = $this->fnamePart( $url );
+ $alt = self::fnamePart( $url );
}
$img = '';
- $success = wfRunHooks( 'LinkerMakeExternalImage', array( &$url, &$alt, &$img ) );
+ $success = Hooks::run( 'LinkerMakeExternalImage', [ &$url, &$alt, &$img ] );
if ( !$success ) {
- wfDebug( "Hook LinkerMakeExternalImage changed the output of external image with url {$url} and alt text {$alt} to {$img}\n", true );
+ wfDebug( "Hook LinkerMakeExternalImage changed the output of external image "
+ . "with url {$url} and alt text {$alt} to {$img}\n", true );
return $img;
}
return Html::element( 'img',
- array(
+ [
'src' => $url,
- 'alt' => $alt ) );
+ 'alt' => $alt ] );
}
/**
* Given parameters derived from [[Image:Foo|options...]], generate the
* HTML that that syntax inserts in the page.
*
- * @param $title Title object
- * @param $file File object, or false if it doesn't exist
- * @param $frameParams Array: associative array of parameters external to the media handler.
+ * @param Parser $parser
+ * @param Title $title Title object of the file (not the currently viewed page)
+ * @param File $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
* valign Vertical alignment (baseline, sub, super, top, text-top, middle,
* bottom, text-bottom)
* alt Alternate text for image (i.e. alt attribute). Plain text.
+ * class HTML for image classes. Plain text.
* caption HTML for image caption.
* link-url URL to link to
* link-title Title object to link to
- * link-target Value for the target attribue, only with link-url
+ * link-target Value for the target attribute, only with link-url
* no-link Boolean, suppress description link
*
- * @param $handlerParams Array: associative array of media handler parameters, to be passed
+ * @param array $handlerParams Associative array of media handler parameters, to be passed
* to transform(). Typical keys are "width" and "page".
- * @param $time String: timestamp of the file, set as false for current
- * @param $query String: query params for desc url
- * @param $widthOption: Used by the parser to remember the user preference thumbnailsize
- * @return String: HTML for an image, with links, wrappers, etc.
- */
- function makeImageLink2( Title $title, $file, $frameParams = array(), $handlerParams = array(), $time = false, $query = "", $widthOption = null ) {
+ * @param string|bool $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, Title $title,
+ $file, $frameParams = [], $handlerParams = [], $time = false,
+ $query = "", $widthOption = null
+ ) {
$res = null;
- if ( !wfRunHooks( 'ImageBeforeProduceHTML', array( &$this, &$title,
- &$file, &$frameParams, &$handlerParams, &$time, &$res ) ) ) {
+ $dummy = new DummyLinker;
+ if ( !Hooks::run( 'ImageBeforeProduceHTML', [ &$dummy, &$title,
+ &$file, &$frameParams, &$handlerParams, &$time, &$res ] ) ) {
return $res;
}
if ( $file && !$file->allowInlineDisplay() ) {
wfDebug( __METHOD__ . ': ' . $title->getPrefixedDBkey() . " does not allow inline display\n" );
- return $this->link( $title );
+ return self::link( $title );
}
- // Shortcuts
- $fp =& $frameParams;
- $hp =& $handlerParams;
-
// Clean up parameters
- $page = isset( $hp['page'] ) ? $hp['page'] : false;
- if ( !isset( $fp['align'] ) ) $fp['align'] = '';
- if ( !isset( $fp['alt'] ) ) $fp['alt'] = '';
- if ( !isset( $fp['title'] ) ) $fp['title'] = '';
+ $page = isset( $handlerParams['page'] ) ? $handlerParams['page'] : false;
+ if ( !isset( $frameParams['align'] ) ) {
+ $frameParams['align'] = '';
+ }
+ if ( !isset( $frameParams['alt'] ) ) {
+ $frameParams['alt'] = '';
+ }
+ if ( !isset( $frameParams['title'] ) ) {
+ $frameParams['title'] = '';
+ }
+ if ( !isset( $frameParams['class'] ) ) {
+ $frameParams['class'] = '';
+ }
$prefix = $postfix = '';
- if ( 'center' == $fp['align'] ) {
- $prefix
= '<div class="center">';
+ if ( 'center' == $frameParams['align'] ) {
+ $prefix = '<div class="center">';
$postfix = '</div>';
- $fp['align'] = 'none';
- }
- if ( $file && !isset( $hp['width'] ) ) {
- $hp['width'] = $file->getWidth( $page );
+ $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.
+ global $wgSVGMaxSize;
+ $handlerParams['width'] = $wgSVGMaxSize;
+ } else {
+ $handlerParams['width'] = $file->getWidth( $page );
+ }
- if ( isset( $fp['thumbnail'] ) || isset( $fp['framed'] ) || isset( $fp['frameless'] ) || !$hp['width'] ) {
+ if ( isset( $frameParams['thumbnail'] )
+ || isset( $frameParams['manualthumb'] )
+ || isset( $frameParams['framed'] )
+ || isset( $frameParams['frameless'] )
+ || !$handlerParams['width']
+ ) {
global $wgThumbLimits, $wgThumbUpright;
- if ( !isset( $widthOption ) || !isset( $wgThumbLimits[$widthOption] ) ) {
+
+ if ( $widthOption === null || !isset( $wgThumbLimits[$widthOption] ) ) {
$widthOption = User::getDefaultOption( 'thumbsize' );
}
// Reduce width for upright images when parameter 'upright' is used
- if ( isset( $fp['upright'] ) && $fp['upright'] == 0 ) {
- $fp['upright'] = $wgThumbUpright;
+ if ( isset( $frameParams['upright'] ) && $frameParams['upright'] == 0 ) {
+ $frameParams['upright'] = $wgThumbUpright;
}
- // 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( $fp['upright'] ) ?
- round( $wgThumbLimits[$widthOption] * $fp['upright'], -1 ) :
+
+ // 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( $wgThumbLimits[$widthOption] * $frameParams['upright'], -1 ) :
$wgThumbLimits[$widthOption];
// Use width which is smaller: real image width or user preference width
// Unless image is scalable vector.
- if ( !isset( $hp['height'] ) && ( $hp['width'] <= 0 ||
- $prefWidth < $hp['width'] || $file->isVectorized() ) ) {
- $hp['width'] = $prefWidth;
+ if ( !isset( $handlerParams['height'] ) && ( $handlerParams['width'] <= 0 ||
+ $prefWidth < $handlerParams['width'] || $file->isVectorized() ) ) {
+ $handlerParams['width'] = $prefWidth;
}
}
}
- if ( isset( $fp['thumbnail'] ) || isset( $fp['manualthumb'] ) || isset( $fp['framed'] ) ) {
- global $wgContLang;
- # Create a thumbnail. Alignment depends on language
- # writing direction, # right aligned for left-to-right-
- # languages ("Western languages"), left-aligned
- # for right-to-left-languages ("Semitic languages")
- #
- # If thumbnail width has not been provided, it is set
+ if ( isset( $frameParams['thumbnail'] ) || isset( $frameParams['manualthumb'] )
+ || isset( $frameParams['framed'] )
+ ) {
+ # 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 ( $fp['align'] == '' ) {
- $fp['align'] = $wgContLang->alignEnd();
+ if ( $frameParams['align'] == '' ) {
+ $frameParams['align'] = $parser->getTargetLanguage()->alignEnd();
}
- return $prefix . $this->makeThumbLink2( $title, $file, $fp, $hp, $time, $query ) . $postfix;
+ return $prefix .
+ self::makeThumbLink2( $title, $file, $frameParams, $handlerParams, $time, $query ) .
+ $postfix;
}
- if ( $file && isset( $fp['frameless'] ) ) {
+ if ( $file && isset( $frameParams['frameless'] ) ) {
$srcWidth = $file->getWidth( $page );
- # For "frameless" option: do not present an image bigger than the source (for bitmap-style images)
- # This is the same behaviour as the "thumb" option does it already.
- if ( $srcWidth && !$file->mustRender() && $hp['width'] > $srcWidth ) {
- $hp['width'] = $srcWidth;
+ # 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( $hp['width'] ) ) {
+ if ( $file && isset( $handlerParams['width'] ) ) {
# Create a resized image, without the additional thumbnail features
- $thumb = $file->transform( $hp );
+ $thumb = $file->transform( $handlerParams );
} else {
$thumb = false;
}
if ( !$thumb ) {
- $s = $this->makeBrokenImageLinkObj( $title, $fp['title'], '', '', '', $time == true );
+ $s = self::makeBrokenImageLinkObj( $title, $frameParams['title'], '', '', '', $time == true );
} else {
- $params = array(
- 'alt' => $fp['alt'],
- 'title' => $fp['title'],
- 'valign' => isset( $fp['valign'] ) ? $fp['valign'] : false ,
- 'img-class' => isset( $fp['border'] ) ? 'thumbborder' : false );
- $params = $this->getImageLinkMTOParams( $fp, $query ) + $params;
+ self::processResponsiveImages( $file, $thumb, $handlerParams );
+ $params = [
+ 'alt' => $frameParams['alt'],
+ 'title' => $frameParams['title'],
+ 'valign' => isset( $frameParams['valign'] ) ? $frameParams['valign'] : false,
+ 'img-class' => $frameParams['class'] ];
+ if ( isset( $frameParams['border'] ) ) {
+ $params['img-class'] .= ( $params['img-class'] !== '' ? ' ' : '' ) . 'thumbborder';
+ }
+ $params = self::getImageLinkMTOParams( $frameParams, $query, $parser ) + $params;
$s = $thumb->toHtml( $params );
}
- if ( $fp['align'] != '' ) {
- $s = "<div class=\"float{$fp['align']}\">{$s}</div>";
+ if ( $frameParams['align'] != '' ) {
+ $s = "<div class=\"float{$frameParams['align']}\">{$s}</div>";
}
return str_replace( "\n", ' ', $prefix . $s . $postfix );
}
/**
* Get the link parameters for MediaTransformOutput::toHtml() from given
* frame parameters supplied by the Parser.
- * @param $frameParams The frame parameters
- * @param $query An optional query string to add to description page links
+ * @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
*/
- function getImageLinkMTOParams( $frameParams, $query = '' ) {
- $mtoParams = array();
+ private 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'] !== '' ) {
- $mtoParams['custom-title-link'] = $this->normaliseSpecialPage( $frameParams['link-title'] );
+ $mtoParams['custom-title-link'] = Title::newFromLinkTarget(
+ self::normaliseSpecialPage( $frameParams['link-title'] )
+ );
} elseif ( !empty( $frameParams['no-link'] ) ) {
// No link
} else {
/**
* Make HTML for a thumbnail including image, border and caption
- * @param $title Title object
- * @param $file File object or false if it doesn't exist
- * @param $label String
- * @param $alt String
- * @param $align String
- * @param $params Array
- * @param $framed Boolean
- * @param $manualthumb String
+ * @param Title $title
+ * @param File|bool $file File object or false if it doesn't exist
+ * @param string $label
+ * @param string $alt
+ * @param string $align
+ * @param array $params
+ * @param bool $framed
+ * @param string $manualthumb
+ * @return string
*/
- function makeThumbLinkObj( Title $title, $file, $label = '', $alt, $align = 'right', $params = array(), $framed = false , $manualthumb = "" ) {
- $frameParams = array(
+ public static function makeThumbLinkObj( Title $title, $file, $label = '', $alt,
+ $align = 'right', $params = [], $framed = false, $manualthumb = ""
+ ) {
+ $frameParams = [
'alt' => $alt,
'caption' => $label,
'align' => $align
- );
- if ( $framed ) $frameParams['framed'] = true;
- if ( $manualthumb ) $frameParams['manualthumb'] = $manualthumb;
- return $this->makeThumbLink2( $title, $file, $frameParams, $params );
+ ];
+ if ( $framed ) {
+ $frameParams['framed'] = true;
+ }
+ if ( $manualthumb ) {
+ $frameParams['manualthumb'] = $manualthumb;
+ }
+ return self::makeThumbLink2( $title, $file, $frameParams, $params );
}
- function makeThumbLink2( Title $title, $file, $frameParams = array(), $handlerParams = array(), $time = false, $query = "" ) {
- global $wgStylePath;
+ /**
+ * @param Title $title
+ * @param File $file
+ * @param array $frameParams
+ * @param array $handlerParams
+ * @param bool $time
+ * @param string $query
+ * @return string
+ */
+ public static function makeThumbLink2( Title $title, $file, $frameParams = [],
+ $handlerParams = [], $time = false, $query = ""
+ ) {
$exists = $file && $file->exists();
- # Shortcuts
- $fp =& $frameParams;
- $hp =& $handlerParams;
-
- $page = isset( $hp['page'] ) ? $hp['page'] : false;
- if ( !isset( $fp['align'] ) ) $fp['align'] = 'right';
- if ( !isset( $fp['alt'] ) ) $fp['alt'] = '';
- if ( !isset( $fp['title'] ) ) $fp['title'] = '';
- if ( !isset( $fp['caption'] ) ) $fp['caption'] = '';
+ $page = isset( $handlerParams['page'] ) ? $handlerParams['page'] : false;
+ if ( !isset( $frameParams['align'] ) ) {
+ $frameParams['align'] = 'right';
+ }
+ if ( !isset( $frameParams['alt'] ) ) {
+ $frameParams['alt'] = '';
+ }
+ if ( !isset( $frameParams['title'] ) ) {
+ $frameParams['title'] = '';
+ }
+ if ( !isset( $frameParams['caption'] ) ) {
+ $frameParams['caption'] = '';
+ }
- if ( empty( $hp['width'] ) ) {
+ if ( empty( $handlerParams['width'] ) ) {
// Reduce width for upright images when parameter 'upright' is used
- $hp['width'] = isset( $fp['upright'] ) ? 130 : 180;
+ $handlerParams['width'] = isset( $frameParams['upright'] ) ? 130 : 180;
}
$thumb = false;
+ $noscale = false;
+ $manualthumb = false;
if ( !$exists ) {
- $outerWidth = $hp['width'] + 2;
+ $outerWidth = $handlerParams['width'] + 2;
} else {
- if ( isset( $fp['manualthumb'] ) ) {
+ if ( isset( $frameParams['manualthumb'] ) ) {
# Use manually specified thumbnail
- $manual_title = Title::makeTitleSafe( NS_FILE, $fp['manualthumb'] );
+ $manual_title = Title::makeTitleSafe( NS_FILE, $frameParams['manualthumb'] );
if ( $manual_title ) {
$manual_img = wfFindFile( $manual_title );
if ( $manual_img ) {
- $thumb = $manual_img->getUnscaledThumb( $hp );
+ $thumb = $manual_img->getUnscaledThumb( $handlerParams );
+ $manualthumb = true;
} else {
$exists = false;
}
}
- } elseif ( isset( $fp['framed'] ) ) {
+ } elseif ( isset( $frameParams['framed'] ) ) {
// Use image dimensions, don't scale
- $thumb = $file->getUnscaledThumb( $hp );
+ $thumb = $file->getUnscaledThumb( $handlerParams );
+ $noscale = true;
} else {
# 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 behaviour
+ # This is a hack to maintain compatibility with arbitrary pre-1.10 behavior
$srcWidth = $file->getWidth( $page );
- if ( $srcWidth && !$file->mustRender() && $hp['width'] > $srcWidth ) {
- $hp['width'] = $srcWidth;
+ if ( $srcWidth && !$file->mustRender() && $handlerParams['width'] > $srcWidth ) {
+ $handlerParams['width'] = $srcWidth;
}
- $thumb = $file->transform( $hp );
+ $thumb = $file->transform( $handlerParams );
}
if ( $thumb ) {
$outerWidth = $thumb->getWidth() + 2;
} else {
- $outerWidth = $hp['width'] + 2;
+ $outerWidth = $handlerParams['width'] + 2;
}
}
# 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 bug 14771
+ # zoom icon still needs it, so we make a unique query for it. See T16771
$url = $title->getLocalURL( $query );
if ( $page ) {
- $url = wfAppendQuery( $url, 'page=' . urlencode( $page ) );
+ $url = wfAppendQuery( $url, [ 'page' => $page ] );
+ }
+ if ( $manualthumb
+ && !isset( $frameParams['link-title'] )
+ && !isset( $frameParams['link-url'] )
+ && !isset( $frameParams['no-link'] ) ) {
+ $frameParams['link-url'] = $url;
}
- $s = "<div class=\"thumb t{$fp['align']}\"><div class=\"thumbinner\" style=\"width:{$outerWidth}px;\">";
+ $s = "<div class=\"thumb t{$frameParams['align']}\">"
+ . "<div class=\"thumbinner\" style=\"width:{$outerWidth}px;\">";
+
if ( !$exists ) {
- $s .= $this->makeBrokenImageLinkObj( $title, $fp['title'], '', '', '', $time == true );
+ $s .= self::makeBrokenImageLinkObj( $title, $frameParams['title'], '', '', '', $time == true );
$zoomIcon = '';
} elseif ( !$thumb ) {
- $s .= htmlspecialchars( wfMsg( 'thumbnail_error', '' ) );
+ $s .= wfMessage( 'thumbnail_error', '' )->escaped();
$zoomIcon = '';
} else {
- $params = array(
- 'alt' => $fp['alt'],
- 'title' => $fp['title'],
- 'img-class' => 'thumbimage' );
- $params = $this->getImageLinkMTOParams( $fp, $query ) + $params;
+ if ( !$noscale && !$manualthumb ) {
+ self::processResponsiveImages( $file, $thumb, $handlerParams );
+ }
+ $params = [
+ 'alt' => $frameParams['alt'],
+ 'title' => $frameParams['title'],
+ 'img-class' => ( isset( $frameParams['class'] ) && $frameParams['class'] !== ''
+ ? $frameParams['class'] . ' '
+ : '' ) . 'thumbimage'
+ ];
+ $params = self::getImageLinkMTOParams( $frameParams, $query ) + $params;
$s .= $thumb->toHtml( $params );
- if ( isset( $fp['framed'] ) ) {
+ if ( isset( $frameParams['framed'] ) ) {
$zoomIcon = "";
} else {
- $zoomIcon = '<div class="magnify">' .
- '<a href="' . htmlspecialchars( $url ) . '" class="internal" ' .
- 'title="' . htmlspecialchars( wfMsg( 'thumbnail-more' ) ) . '">' .
- '<img src="' . htmlspecialchars( $wgStylePath ) . '/common/images/magnify-clip.png" ' .
- 'width="15" height="11" alt="" /></a></div>';
+ $zoomIcon = Html::rawElement( 'div', [ 'class' => 'magnify' ],
+ Html::rawElement( 'a', [
+ 'href' => $url,
+ 'class' => 'internal',
+ 'title' => wfMessage( 'thumbnail-more' )->text() ],
+ "" ) );
}
}
- $s .= ' <div class="thumbcaption">' . $zoomIcon . $fp['caption'] . "</div></div></div>";
+ $s .= ' <div class="thumbcaption">' . $zoomIcon . $frameParams['caption'] . "</div></div></div>";
return str_replace( "\n", ' ', $s );
}
+ /**
+ * Process responsive images: add 1.5x and 2x subimages to the thumbnail, where
+ * applicable.
+ *
+ * @param File $file
+ * @param MediaTransformOutput $thumb
+ * @param array $hp Image parameters
+ */
+ public static function processResponsiveImages( $file, $thumb, $hp ) {
+ global $wgResponsiveImages;
+ if ( $wgResponsiveImages && $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
*
- * @param $title Title object
- * @param $text String: link label
- * @param $query String: query string
- * @param $trail String: link trail
- * @param $prefix String: link prefix
- * @param $time Boolean: a file of a certain timestamp was requested
- * @return String
+ * @since 1.16.3
+ * @param Title $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
+ * @return string
*/
- public function makeBrokenImageLinkObj( $title, $text = '', $query = '', $trail = '', $prefix = '', $time = false ) {
- global $wgEnableUploads, $wgUploadMissingFileUrl;
- if ( $title instanceof Title ) {
- wfProfileIn( __METHOD__ );
- $currentExists = $time ? ( wfFindFile( $title ) != false ) : false;
-
- list( $inside, $trail ) = self::splitTrail( $trail );
- if ( $text == '' )
- $text = htmlspecialchars( $title->getPrefixedText() );
-
- if ( ( $wgUploadMissingFileUrl || $wgEnableUploads ) && !$currentExists ) {
- $redir = RepoGroup::singleton()->getLocalRepo()->checkRedirect( $title );
-
- if ( $redir ) {
- wfProfileOut( __METHOD__ );
- return $this->linkKnown( $title, "$prefix$text$inside", array(), $query ) . $trail;
- }
+ public static function makeBrokenImageLinkObj( $title, $label = '',
+ $query = '', $unused1 = '', $unused2 = '', $time = false
+ ) {
+ if ( !$title instanceof Title ) {
+ wfWarn( __METHOD__ . ': Requires $title to be a Title object.' );
+ return "<!-- ERROR -->" . htmlspecialchars( $label );
+ }
+
+ global $wgEnableUploads, $wgUploadMissingFileUrl, $wgUploadNavigationUrl;
+ if ( $label == '' ) {
+ $label = $title->getPrefixedText();
+ }
+ $encLabel = htmlspecialchars( $label );
+ $currentExists = $time ? ( wfFindFile( $title ) != false ) : false;
+
+ if ( ( $wgUploadMissingFileUrl || $wgUploadNavigationUrl || $wgEnableUploads )
+ && !$currentExists
+ ) {
+ $redir = RepoGroup::singleton()->getLocalRepo()->checkRedirect( $title );
+
+ if ( $redir ) {
+ // We already know it's a redirect, so mark it
+ // accordingly
+ return self::link(
+ $title,
+ $encLabel,
+ [ 'class' => 'mw-redirect' ],
+ wfCgiToArray( $query ),
+ [ 'known', 'noclasses' ]
+ );
+ }
- $href = $this->getUploadUrl( $title, $query );
+ $href = self::getUploadUrl( $title, $query );
- wfProfileOut( __METHOD__ );
- return '<a href="' . htmlspecialchars( $href ) . '" class="new" title="' .
- htmlspecialchars( $title->getPrefixedText(), ENT_QUOTES ) . '">' .
- htmlspecialchars( $prefix . $text . $inside, ENT_NOQUOTES ) . '</a>' . $trail;
- } else {
- wfProfileOut( __METHOD__ );
- return $this->linkKnown( $title, "$prefix$text$inside", array(), $query ) . $trail;
- }
- } else {
- wfProfileOut( __METHOD__ );
- return "<!-- ERROR -->{$prefix}{$text}{$trail}";
+ return '<a href="' . htmlspecialchars( $href ) . '" class="new" title="' .
+ htmlspecialchars( $title->getPrefixedText(), ENT_QUOTES ) . '">' .
+ $encLabel . '</a>';
}
+
+ return self::link( $title, $encLabel, [], wfCgiToArray( $query ), [ 'known', 'noclasses' ] );
}
/**
* Get the URL to upload a certain file
*
- * @param $destFile Title object of the file to upload
- * @param $query String: urlencoded query string to prepend
- * @return String: urlencoded URL
- */
- protected function getUploadUrl( $destFile, $query = '' ) {
- global $wgUploadMissingFileUrl;
- $q = 'wpDestFile=' . $destFile->getPartialUrl();
- if ( $query != '' )
+ * @since 1.16.3
+ * @param Title $destFile Title object of the file to upload
+ * @param string $query Urlencoded query string to prepend
+ * @return string Urlencoded URL
+ */
+ protected static function getUploadUrl( $destFile, $query = '' ) {
+ global $wgUploadMissingFileUrl, $wgUploadNavigationUrl;
+ $q = 'wpDestFile=' . $destFile->getPartialURL();
+ if ( $query != '' ) {
$q .= '&' . $query;
+ }
if ( $wgUploadMissingFileUrl ) {
return wfAppendQuery( $wgUploadMissingFileUrl, $q );
+ } elseif ( $wgUploadNavigationUrl ) {
+ return wfAppendQuery( $wgUploadNavigationUrl, $q );
} else {
$upload = SpecialPage::getTitleFor( 'Upload' );
- return $upload->getLocalUrl( $q );
+ return $upload->getLocalURL( $q );
}
}
/**
* Create a direct link to a given uploaded file.
*
- * @param $title Title object.
- * @param $text String: pre-sanitized HTML
- * @param $time string: time image was created
- * @return String: HTML
+ * @since 1.16.3
+ * @param Title $title
+ * @param string $html Pre-sanitized HTML
+ * @param string $time MW timestamp of file creation time
+ * @return string HTML
+ */
+ public static function makeMediaLinkObj( $title, $html = '', $time = false ) {
+ $img = wfFindFile( $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 Title $title
+ * @param File|bool $file File object or false
+ * @param string $html Pre-sanitized HTML
+ * @return string HTML
*
* @todo Handle invalid or missing images better.
*/
- public function makeMediaLinkObj( $title, $text = '', $time = false ) {
- if ( is_null( $title ) ) {
- # # # HOTFIX. Instead of breaking, return empty string.
- return $text;
+ public static function makeMediaLinkFile( Title $title, $file, $html = '' ) {
+ if ( $file && $file->exists() ) {
+ $url = $file->getUrl();
+ $class = 'internal';
} else {
- $img = wfFindFile( $title, array( 'time' => $time ) );
- if ( $img ) {
- $url = $img->getURL();
- $class = 'internal';
- } else {
- $url = $this->getUploadUrl( $title );
- $class = 'new';
- }
- $alt = htmlspecialchars( $title->getText(), ENT_QUOTES );
- if ( $text == '' ) {
- $text = $alt;
- }
- $u = htmlspecialchars( $url );
- return "<a href=\"{$u}\" class=\"$class\" title=\"{$alt}\">{$text}</a>";
+ $url = self::getUploadUrl( $title );
+ $class = 'new';
}
+
+ $alt = $title->getText();
+ if ( $html == '' ) {
+ $html = $alt;
+ }
+
+ $ret = '';
+ $attribs = [
+ 'href' => $url,
+ 'class' => $class,
+ 'title' => $alt
+ ];
+
+ if ( !Hooks::run( 'LinkerMakeMediaLinkFile',
+ [ $title, $file, &$html, &$attribs, &$ret ] ) ) {
+ wfDebug( "Hook LinkerMakeMediaLinkFile changed the output of link "
+ . "with url {$url} and text {$html} to {$ret}\n", true );
+ return $ret;
+ }
+
+ return Html::rawElement( 'a', $attribs, $html );
}
/**
- * Make a link to a special page given its name and, optionally,
+ * Make a link to a special page given its name and, optionally,
* a message key from the link text.
- * Usage example: $skin->specialLink( 'recentchanges' )
+ * Usage example: Linker::specialLink( 'Recentchanges' )
+ *
+ * @since 1.16.3
+ * @param string $name
+ * @param string $key
+ * @return string
*/
- function specialLink( $name, $key = '' ) {
- if ( $key == '' ) { $key = strtolower( $name ); }
+ public static function specialLink( $name, $key = '' ) {
+ if ( $key == '' ) {
+ $key = strtolower( $name );
+ }
- return $this->linkKnown( SpecialPage::getTitleFor( $name ) , wfMsg( $key ) );
+ return self::linkKnown( SpecialPage::getTitleFor( $name ), wfMessage( $key )->text() );
}
/**
* Make an external link
- * @param $url String: URL to link to
- * @param $text String: text of link
- * @param $escape Boolean: do we escape the link text?
- * @param $linktype String: type of external link. Gets added to the classes
- * @param $attribs Array of extra attributes to <a>
- *
- * @todo FIXME: This is a really crappy implementation. $linktype and
- * 'external' are mashed into the class attrib for the link (which is made
- * into a string). Then, if we've got additional params in $attribs, we
- * add to it. People using this might want to change the classes (or other
- * default link attributes), but passing $attribsText is just messy. Would
- * make a lot more sense to make put the classes into $attribs, let the
- * hook play with them, *then* expand it all at once.
+ * @since 1.16.3. $title added in 1.21
+ * @param string $url URL to link to
+ * @param string $text Text of link
+ * @param bool $escape Do we escape the link text?
+ * @param string $linktype Type of external link. Gets added to the classes
+ * @param array $attribs Array of extra attributes to <a>
+ * @param Title|null $title Title object used for title specific link attributes
+ * @return string
*/
- function makeExternalLink( $url, $text, $escape = true, $linktype = '', $attribs = array() ) {
- if ( isset( $attribs['class'] ) ) {
- # yet another hack :(
- $class = $attribs['class'];
- } else {
- $class = "external $linktype";
+ public static function makeExternalLink( $url, $text, $escape = true,
+ $linktype = '', $attribs = [], $title = null
+ ) {
+ global $wgTitle;
+ $class = "external";
+ if ( $linktype ) {
+ $class .= " $linktype";
+ }
+ if ( isset( $attribs['class'] ) && $attribs['class'] ) {
+ $class .= " {$attribs['class']}";
}
+ $attribs['class'] = $class;
- $attribsText = $this->getExternalLinkAttributes( $class );
- $url = htmlspecialchars( $url );
if ( $escape ) {
$text = htmlspecialchars( $text );
}
+
+ if ( !$title ) {
+ $title = $wgTitle;
+ }
+ $newRel = Parser::getExternalLinkRel( $url, $title );
+ if ( !isset( $attribs['rel'] ) || $attribs['rel'] === '' ) {
+ $attribs['rel'] = $newRel;
+ } elseif ( $newRel !== '' ) {
+ // Merge the rel attributes.
+ $newRels = explode( ' ', $newRel );
+ $oldRels = explode( ' ', $attribs['rel'] );
+ $combined = array_unique( array_merge( $newRels, $oldRels ) );
+ $attribs['rel'] = implode( ' ', $combined );
+ }
$link = '';
- $success = wfRunHooks( 'LinkerMakeExternalLink', array( &$url, &$text, &$link, &$attribs, $linktype ) );
+ $success = Hooks::run( 'LinkerMakeExternalLink',
+ [ &$url, &$text, &$link, &$attribs, $linktype ] );
if ( !$success ) {
- wfDebug( "Hook LinkerMakeExternalLink changed the output of link with url {$url} and text {$text} to {$link}\n", true );
+ wfDebug( "Hook LinkerMakeExternalLink changed the output of link "
+ . "with url {$url} and text {$text} to {$link}\n", true );
return $link;
}
- if ( $attribs ) {
- $attribsText .= Html::expandAttributes( $attribs );
- }
- return '<a href="' . $url . '"' . $attribsText . '>' . $text . '</a>';
+ $attribs['href'] = $url;
+ return Html::rawElement( 'a', $attribs, $text );
}
/**
* Make user link (or user contributions for unregistered users)
- * @param $userId Integer: user id in database.
- * @param $userText String: user name in database
- * @return String: HTML fragment
- * @private
- */
- function userLink( $userId, $userText ) {
+ * @param int $userId User id in database.
+ * @param string $userName User name in database.
+ * @param string $altUserName Text to display instead of the user name (optional)
+ * @return string HTML fragment
+ * @since 1.16.3. $altUserName was added in 1.19.
+ */
+ public static function userLink( $userId, $userName, $altUserName = false ) {
+ $classes = 'mw-userlink';
if ( $userId == 0 ) {
- $page = SpecialPage::getTitleFor( 'Contributions', $userText );
+ $page = SpecialPage::getTitleFor( 'Contributions', $userName );
+ if ( $altUserName === false ) {
+ $altUserName = IP::prettifyIP( $userName );
+ }
+ $classes .= ' mw-anonuserlink'; // Separate link class for anons (T45179)
} else {
- $page = Title::makeTitle( NS_USER, $userText );
+ $page = Title::makeTitle( NS_USER, $userName );
}
- return $this->link( $page, htmlspecialchars( $userText ), array( 'class' => 'mw-userlink' ) );
+
+ // Wrap the output with <bdi> tags for directionality isolation
+ return self::link(
+ $page,
+ '<bdi>' . htmlspecialchars( $altUserName !== false ? $altUserName : $userName ) . '</bdi>',
+ [ 'class' => $classes ]
+ );
}
/**
* Generate standard user tool links (talk, contributions, block link, etc.)
*
- * @param $userId Integer: user identifier
- * @param $userText String: user name or IP address
- * @param $redContribsWhenNoEdits Boolean: should the contributions link be
- * red if the user has no edits?
- * @param $flags Integer: customisation flags (e.g. self::TOOL_LINKS_NOBLOCK)
- * @param $edits Integer: user edit count (optional, for performance)
- * @return String: HTML fragment
- */
- public function userToolLinks( $userId, $userText, $redContribsWhenNoEdits = false, $flags = 0, $edits = null ) {
- global $wgUser, $wgDisableAnonTalk, $wgSysopUserBans, $wgLang;
+ * @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 $edits User edit count (optional, for performance)
+ * @return string HTML fragment
+ */
+ public static function userToolLinks(
+ $userId, $userText, $redContribsWhenNoEdits = false, $flags = 0, $edits = null
+ ) {
+ global $wgUser, $wgDisableAnonTalk, $wgLang;
$talkable = !( $wgDisableAnonTalk && 0 == $userId );
- $blockable = ( $wgSysopUserBans || 0 == $userId ) && !$flags & self::TOOL_LINKS_NOBLOCK;
+ $blockable = !( $flags & self::TOOL_LINKS_NOBLOCK );
+ $addEmailLink = $flags & self::TOOL_LINKS_EMAIL && $userId;
- $items = array();
+ $items = [];
if ( $talkable ) {
- $items[] = $this->userTalkLink( $userId, $userText );
+ $items[] = self::userTalkLink( $userId, $userText );
}
if ( $userId ) {
// check if the user has an edit
- $attribs = array();
+ $attribs = [];
+ $attribs['class'] = 'mw-usertoollinks-contribs';
if ( $redContribsWhenNoEdits ) {
- $count = !is_null( $edits ) ? $edits : User::edits( $userId );
- if ( $count == 0 ) {
- $attribs['class'] = 'new';
+ if ( intval( $edits ) === 0 && $edits !== 0 ) {
+ $user = User::newFromId( $userId );
+ $edits = $user->getEditCount();
+ }
+ if ( $edits === 0 ) {
+ $attribs['class'] .= ' new';
}
}
$contribsPage = SpecialPage::getTitleFor( 'Contributions', $userText );
- $items[] = $this->link( $contribsPage, wfMsgHtml( 'contribslink' ), $attribs );
+ $items[] = self::link( $contribsPage, wfMessage( 'contribslink' )->escaped(), $attribs );
}
if ( $blockable && $wgUser->isAllowed( 'block' ) ) {
- $items[] = $this->blockLink( $userId, $userText );
+ $items[] = self::blockLink( $userId, $userText );
+ }
+
+ if ( $addEmailLink && $wgUser->canSendEmail() ) {
+ $items[] = self::emailLink( $userId, $userText );
}
+ Hooks::run( 'UserToolLinksEdit', [ $userId, $userText, &$items ] );
+
if ( $items ) {
- return ' <span class="mw-usertoollinks">(' . $wgLang->pipeList( $items ) . ')</span>';
+ return wfMessage( 'word-separator' )->escaped()
+ . '<span class="mw-usertoollinks">'
+ . wfMessage( 'parentheses' )->rawParams( $wgLang->pipeList( $items ) )->escaped()
+ . '</span>';
} else {
return '';
}
/**
* Alias for userToolLinks( $userId, $userText, true );
- * @param $userId Integer: user identifier
- * @param $userText String: user name or IP address
- * @param $edits Integer: user edit count (optional, for performance)
+ * @since 1.16.3
+ * @param int $userId User identifier
+ * @param string $userText User name or IP address
+ * @param int $edits User edit count (optional, for performance)
+ * @return string
*/
- public function userToolLinksRedContribs( $userId, $userText, $edits = null ) {
- return $this->userToolLinks( $userId, $userText, true, 0, $edits );
+ public static function userToolLinksRedContribs( $userId, $userText, $edits = null ) {
+ return self::userToolLinks( $userId, $userText, true, 0, $edits );
}
-
/**
- * @param $userId Integer: user id in database.
- * @param $userText String: user name in database.
- * @return String: HTML fragment with user talk link
- * @private
+ * @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
*/
- function userTalkLink( $userId, $userText ) {
+ public static function userTalkLink( $userId, $userText ) {
$userTalkPage = Title::makeTitle( NS_USER_TALK, $userText );
- $userTalkLink = $this->link( $userTalkPage, wfMsgHtml( 'talkpagelinktext' ) );
+ $moreLinkAttribs['class'] = 'mw-usertoollinks-talk';
+ $userTalkLink = self::link( $userTalkPage,
+ wfMessage( 'talkpagelinktext' )->escaped(),
+ $moreLinkAttribs );
return $userTalkLink;
}
/**
- * @param $userId Integer: userid
- * @param $userText String: user name in database.
- * @return String: HTML fragment with block link
- * @private
+ * @since 1.16.3
+ * @param int $userId Userid
+ * @param string $userText User name in database.
+ * @return string HTML fragment with block link
*/
- function blockLink( $userId, $userText ) {
- $blockPage = SpecialPage::getTitleFor( 'Blockip', $userText );
- $blockLink = $this->link( $blockPage, wfMsgHtml( 'blocklink' ) );
+ public static function blockLink( $userId, $userText ) {
+ $blockPage = SpecialPage::getTitleFor( 'Block', $userText );
+ $moreLinkAttribs['class'] = 'mw-usertoollinks-block';
+ $blockLink = self::link( $blockPage,
+ wfMessage( 'blocklink' )->escaped(),
+ $moreLinkAttribs );
return $blockLink;
}
+ /**
+ * @param int $userId Userid
+ * @param string $userText User name in database.
+ * @return string HTML fragment with e-mail user link
+ */
+ public static function emailLink( $userId, $userText ) {
+ $emailPage = SpecialPage::getTitleFor( 'Emailuser', $userText );
+ $moreLinkAttribs['class'] = 'mw-usertoollinks-mail';
+ $emailLink = self::link( $emailPage,
+ wfMessage( 'emaillink' )->escaped(),
+ $moreLinkAttribs );
+ return $emailLink;
+ }
+
/**
* Generate a user link if the current user is allowed to view it
- * @param $rev Revision object.
- * @param $isPublic Boolean: show only if all users can see it
- * @return String: HTML fragment
+ * @since 1.16.3
+ * @param Revision $rev
+ * @param bool $isPublic Show only if all users can see it
+ * @return string HTML fragment
*/
- function revUserLink( $rev, $isPublic = false ) {
+ public static function revUserLink( $rev, $isPublic = false ) {
if ( $rev->isDeleted( Revision::DELETED_USER ) && $isPublic ) {
- $link = wfMsgHtml( 'rev-deleted-user' );
- } else if ( $rev->userCan( Revision::DELETED_USER ) ) {
- $link = $this->userLink( $rev->getUser( Revision::FOR_THIS_USER ),
+ $link = wfMessage( 'rev-deleted-user' )->escaped();
+ } elseif ( $rev->userCan( Revision::DELETED_USER ) ) {
+ $link = self::userLink( $rev->getUser( Revision::FOR_THIS_USER ),
$rev->getUserText( Revision::FOR_THIS_USER ) );
} else {
- $link = wfMsgHtml( 'rev-deleted-user' );
+ $link = wfMessage( 'rev-deleted-user' )->escaped();
}
if ( $rev->isDeleted( Revision::DELETED_USER ) ) {
return '<span class="history-deleted">' . $link . '</span>';
/**
* Generate a user tool link cluster if the current user is allowed to view it
- * @param $rev Revision object.
- * @param $isPublic Boolean: show only if all users can see it
+ * @since 1.16.3
+ * @param Revision $rev
+ * @param bool $isPublic Show only if all users can see it
* @return string HTML
*/
- function revUserTools( $rev, $isPublic = false ) {
+ public static function revUserTools( $rev, $isPublic = false ) {
if ( $rev->isDeleted( Revision::DELETED_USER ) && $isPublic ) {
- $link = wfMsgHtml( 'rev-deleted-user' );
- } else if ( $rev->userCan( Revision::DELETED_USER ) ) {
+ $link = wfMessage( 'rev-deleted-user' )->escaped();
+ } elseif ( $rev->userCan( Revision::DELETED_USER ) ) {
$userId = $rev->getUser( Revision::FOR_THIS_USER );
$userText = $rev->getUserText( Revision::FOR_THIS_USER );
- $link = $this->userLink( $userId, $userText ) .
- ' ' . $this->userToolLinks( $userId, $userText );
+ $link = self::userLink( $userId, $userText )
+ . self::userToolLinks( $userId, $userText );
} else {
- $link = wfMsgHtml( 'rev-deleted-user' );
+ $link = wfMessage( 'rev-deleted-user' )->escaped();
}
if ( $rev->isDeleted( Revision::DELETED_USER ) ) {
return ' <span class="history-deleted">' . $link . '</span>';
/**
* This function is called by all recent changes variants, by the page history,
* and by the user contributions list. It is responsible for formatting edit
- * comments. It escapes any HTML in the comment, but adds some CSS to format
+ * summaries. It escapes any HTML in the summary, but adds some CSS to format
* auto-generated comments (from section editing) and formats [[wikilinks]].
*
* @author Erik Moeller <moeller@scireview.de>
+ * @since 1.16.3. $wikiId added in 1.26
*
* Note: there's not always a title to pass to this function.
* Since you can't set a default parameter for a reference, I've turned it
* temporarily to a value pass. Should be adjusted further. --brion
*
- * @param $comment String
- * @param $title Mixed: Title object (to generate link to the section in autocomment) or null
- * @param $local Boolean: whether section links should refer to local page
+ * @param string $comment
+ * @param Title|null $title Title object (to generate link to the section in autocomment)
+ * or null
+ * @param bool $local Whether section links should refer to local page
+ * @param string|null $wikiId Id (as used by WikiMap) of the wiki to generate links to.
+ * For use with external changes.
+ *
+ * @return mixed|string
*/
- function formatComment( $comment, $title = null, $local = false ) {
- wfProfileIn( __METHOD__ );
-
+ public static function formatComment(
+ $comment, $title = null, $local = false, $wikiId = null
+ ) {
# Sanitize text a bit:
$comment = str_replace( "\n", " ", $comment );
- # Allow HTML entities (for bug 13815)
+ # Allow HTML entities (for T15815)
$comment = Sanitizer::escapeHtmlAllowEntities( $comment );
# Render autocomments and make links:
- $comment = $this->formatAutocomments( $comment, $title, $local );
- $comment = $this->formatLinksInComment( $comment, $title, $local );
+ $comment = self::formatAutocomments( $comment, $title, $local, $wikiId );
+ $comment = self::formatLinksInComment( $comment, $title, $local, $wikiId );
- wfProfileOut( __METHOD__ );
return $comment;
}
/**
+ * Converts autogenerated comments in edit summaries into section links.
+ *
* The pattern for autogen comments is / * foo * /, which makes for
* some nasty regex.
* We look for all comments, match any text before and after the comment,
* add a separator where needed and format the comment itself with CSS
* Called by Linker::formatComment.
*
- * @param $comment String: comment text
- * @param $title An optional title object used to links to sections
- * @param $local Boolean: whether section links should refer to local page
- * @return String: formatted comment
- */
- private function formatAutocomments( $comment, $title = null, $local = false ) {
- // Bah!
- $this->autocommentTitle = $title;
- $this->autocommentLocal = $local;
+ * @param string $comment Comment text
+ * @param Title|null $title An optional title object used to links to sections
+ * @param bool $local Whether section links should refer to local page
+ * @param string|null $wikiId Id of the wiki to link to (if not the local wiki),
+ * as used by WikiMap.
+ *
+ * @return string Formatted comment (wikitext)
+ */
+ private static function formatAutocomments(
+ $comment, $title = null, $local = false, $wikiId = null
+ ) {
+ // @todo $append here is something of a hack to preserve the status
+ // quo. Someone who knows more about bidi and such should decide
+ // (1) what sane rendering even *is* for an LTR edit summary on an RTL
+ // wiki, both when autocomments exist and when they don't, and
+ // (2) what markup will make that actually happen.
+ $append = '';
$comment = preg_replace_callback(
- '!(.*)/\*\s*(.*?)\s*\*/(.*)!',
- array( $this, 'formatAutocommentsCallback' ),
- $comment );
- unset( $this->autocommentTitle );
- unset( $this->autocommentLocal );
- return $comment;
- }
-
- private function formatAutocommentsCallback( $match ) {
- $title = $this->autocommentTitle;
- $local = $this->autocommentLocal;
-
- $pre = $match[1];
- $auto = $match[2];
- $post = $match[3];
- $link = '';
- if ( $title ) {
- $section = $auto;
-
- # Remove links that a user may have manually put in the autosummary
- # This could be improved by copying as much of Parser::stripSectionName as desired.
- $section = str_replace( '[[:', '', $section );
- $section = str_replace( '[[', '', $section );
- $section = str_replace( ']]', '', $section );
-
- $section = Sanitizer::normalizeSectionNameWhitespace( $section ); # bug 22784
- if ( $local ) {
- $sectionTitle = Title::newFromText( '#' . $section );
- } else {
- $sectionTitle = Title::makeTitleSafe( $title->getNamespace(),
- $title->getDBkey(), $section );
- }
- if ( $sectionTitle ) {
- $link = $this->link( $sectionTitle,
- htmlspecialchars( wfMsgForContent( 'sectionlink' ) ), array(), array(),
- 'noclasses' );
- } else {
- $link = '';
- }
- }
- $auto = "$link$auto";
- if ( $pre ) {
- # written summary $presep autocomment (summary /* section */)
- $auto = wfMsgExt( 'autocomment-prefix', array( 'escapenoentities', 'content' ) ) . $auto;
- }
- if ( $post ) {
- # autocomment $postsep written summary (/* section */ summary)
- $auto .= wfMsgExt( 'colon-separator', array( 'escapenoentities', 'content' ) );
- }
- $auto = '<span class="autocomment">' . $auto . '</span>';
- $comment = $pre . $auto . $post;
- return $comment;
+ // To detect the presence of content before or after the
+ // auto-comment, we use capturing groups inside optional zero-width
+ // assertions. But older versions of PCRE can't directly make
+ // zero-width assertions optional, so wrap them in a non-capturing
+ // group.
+ '!(?:(?<=(.)))?/\*\s*(.*?)\s*\*/(?:(?=(.)))?!',
+ function ( $match ) use ( $title, $local, $wikiId, &$append ) {
+ global $wgLang;
+
+ // Ensure all match positions are defined
+ $match += [ '', '', '', '' ];
+
+ $pre = $match[1] !== '';
+ $auto = $match[2];
+ $post = $match[3] !== '';
+ $comment = null;
+
+ Hooks::run(
+ 'FormatAutocomments',
+ [ &$comment, $pre, $auto, $post, $title, $local, $wikiId ]
+ );
+
+ if ( $comment === null ) {
+ $link = '';
+ if ( $title ) {
+ $section = $auto;
+ # Remove links that a user may have manually put in the autosummary
+ # This could be improved by copying as much of Parser::stripSectionName as desired.
+ $section = str_replace( '[[:', '', $section );
+ $section = str_replace( '[[', '', $section );
+ $section = str_replace( ']]', '', $section );
+
+ $section = Sanitizer::normalizeSectionNameWhitespace( $section ); # T24784
+ if ( $local ) {
+ $sectionTitle = Title::newFromText( '#' . $section );
+ } else {
+ $sectionTitle = Title::makeTitleSafe( $title->getNamespace(),
+ $title->getDBkey(), Sanitizer::decodeCharReferences( $section ) );
+ }
+ if ( $sectionTitle ) {
+ $link = Linker::makeCommentLink( $sectionTitle, $wgLang->getArrow(), $wikiId, 'noclasses' );
+ } else {
+ $link = '';
+ }
+ }
+ if ( $pre ) {
+ # written summary $presep autocomment (summary /* section */)
+ $pre = wfMessage( 'autocomment-prefix' )->inContentLanguage()->escaped();
+ }
+ if ( $post ) {
+ # autocomment $postsep written summary (/* section */ summary)
+ $auto .= wfMessage( 'colon-separator' )->inContentLanguage()->escaped();
+ }
+ $auto = '<span class="autocomment">' . $auto . '</span>';
+ $comment = $pre . $link . $wgLang->getDirMark()
+ . '<span dir="auto">' . $auto;
+ $append .= '</span>';
+ }
+ return $comment;
+ },
+ $comment
+ );
+ return $comment . $append;
}
/**
* Formats wiki links and media links in text; all other wiki formatting
* is ignored
*
- * @todo Fixme: doesn't handle sub-links as in image thumb texts like the main parser
- * @param $comment String: text to format links in
- * @param $title An optional title object used to links to sections
- * @param $local Boolean: whether section links should refer to local page
- * @return String
+ * @since 1.16.3. $wikiId added in 1.26
+ * @todo FIXME: Doesn't handle sub-links as in image thumb texts like the main parser
+ *
+ * @param string $comment Text to format links in. WARNING! Since the output of this
+ * function is html, $comment must be sanitized for use as html. You probably want
+ * to pass $comment through Sanitizer::escapeHtmlAllowEntities() before calling
+ * this function.
+ * @param Title|null $title An optional title object used to links to sections
+ * @param bool $local Whether section links should refer to local page
+ * @param string|null $wikiId Id of the wiki to link to (if not the local wiki),
+ * as used by WikiMap.
+ *
+ * @return string
*/
- public function formatLinksInComment( $comment, $title = null, $local = false ) {
- $this->commentContextTitle = $title;
- $this->commentLocal = $local;
- $html = preg_replace_callback(
- '/\[\[:?(.*?)(\|(.*?))*\]\]([^[]*)/',
- array( $this, 'formatLinksInCommentCallback' ),
- $comment );
- unset( $this->commentContextTitle );
- unset( $this->commentLocal );
- return $html;
- }
-
- protected function formatLinksInCommentCallback( $match ) {
- global $wgContLang;
+ public static function formatLinksInComment(
+ $comment, $title = null, $local = false, $wikiId = null
+ ) {
+ return preg_replace_callback(
+ '/
+ \[\[
+ :? # ignore optional leading colon
+ ([^\]|]+) # 1. link target; page names cannot include ] or |
+ (?:\|
+ # 2. link text
+ # Stop matching at ]] without relying on backtracking.
+ ((?:]?[^\]])*+)
+ )?
+ \]\]
+ ([^[]*) # 3. link trail (the text up until the next link)
+ /x',
+ function ( $match ) use ( $title, $local, $wikiId ) {
+ global $wgContLang;
+
+ $medians = '(?:' . preg_quote( MWNamespace::getCanonicalName( NS_MEDIA ), '/' ) . '|';
+ $medians .= preg_quote( $wgContLang->getNsText( NS_MEDIA ), '/' ) . '):';
+
+ $comment = $match[0];
+
+ # fix up urlencoded title texts (copied from Parser::replaceInternalLinks)
+ if ( strpos( $match[1], '%' ) !== false ) {
+ $match[1] = strtr(
+ rawurldecode( $match[1] ),
+ [ '<' => '<', '>' => '>' ]
+ );
+ }
- $medians = '(?:' . preg_quote( MWNamespace::getCanonicalName( NS_MEDIA ), '/' ) . '|';
- $medians .= preg_quote( $wgContLang->getNsText( NS_MEDIA ), '/' ) . '):';
+ # Handle link renaming [[foo|text]] will show link as "text"
+ if ( $match[2] != "" ) {
+ $text = $match[2];
+ } else {
+ $text = $match[1];
+ }
+ $submatch = [];
+ $thelink = null;
+ if ( preg_match( '/^' . $medians . '(.*)$/i', $match[1], $submatch ) ) {
+ # Media link; trail not supported.
+ $linkRegexp = '/\[\[(.*?)\]\]/';
+ $title = Title::makeTitleSafe( NS_FILE, $submatch[1] );
+ if ( $title ) {
+ $thelink = Linker::makeMediaLinkObj( $title, $text );
+ }
+ } else {
+ # Other kind of link
+ # Make sure its target is non-empty
+ if ( isset( $match[1][0] ) && $match[1][0] == ':' ) {
+ $match[1] = substr( $match[1], 1 );
+ }
+ if ( $match[1] !== false && $match[1] !== '' ) {
+ if ( preg_match( $wgContLang->linkTrail(), $match[3], $submatch ) ) {
+ $trail = $submatch[1];
+ } else {
+ $trail = "";
+ }
+ $linkRegexp = '/\[\[(.*?)\]\]' . preg_quote( $trail, '/' ) . '/';
+ list( $inside, $trail ) = Linker::splitTrail( $trail );
+
+ $linkText = $text;
+ $linkTarget = Linker::normalizeSubpageLink( $title, $match[1], $linkText );
+
+ $target = Title::newFromText( $linkTarget );
+ if ( $target ) {
+ if ( $target->getText() == '' && !$target->isExternal()
+ && !$local && $title
+ ) {
+ $target = $title->createFragmentTarget( $target->getFragment() );
+ }
- $comment = $match[0];
+ $thelink = Linker::makeCommentLink( $target, $linkText . $inside, $wikiId ) . $trail;
+ }
+ }
+ }
+ if ( $thelink ) {
+ // If the link is still valid, go ahead and replace it in!
+ $comment = preg_replace(
+ $linkRegexp,
+ StringUtils::escapeRegexReplacement( $thelink ),
+ $comment,
+ 1
+ );
+ }
- # fix up urlencoded title texts (copied from Parser::replaceInternalLinks)
- if ( strpos( $match[1], '%' ) !== false ) {
- $match[1] = str_replace( array( '<', '>' ), array( '<', '>' ), urldecode( $match[1] ) );
- }
+ return $comment;
+ },
+ $comment
+ );
+ }
- # Handle link renaming [[foo|text]] will show link as "text"
- if ( $match[3] != "" ) {
- $text = $match[3];
- } else {
- $text = $match[1];
- }
- $submatch = array();
- $thelink = null;
- if ( preg_match( '/^' . $medians . '(.*)$/i', $match[1], $submatch ) ) {
- # Media link; trail not supported.
- $linkRegexp = '/\[\[(.*?)\]\]/';
- $title = Title::makeTitleSafe( NS_FILE, $submatch[1] );
- $thelink = $this->makeMediaLinkObj( $title, $text );
+ /**
+ * Generates a link to the given Title
+ *
+ * @note This is only public for technical reasons. It's not intended for use outside Linker.
+ *
+ * @param LinkTarget $linkTarget
+ * @param string $text
+ * @param string|null $wikiId Id of the wiki to link to (if not the local wiki),
+ * as used by WikiMap.
+ * @param string|string[] $options See the $options parameter in Linker::link.
+ *
+ * @return string HTML link
+ */
+ public static function makeCommentLink(
+ LinkTarget $linkTarget, $text, $wikiId = null, $options = []
+ ) {
+ if ( $wikiId !== null && !$linkTarget->isExternal() ) {
+ $link = self::makeExternalLink(
+ WikiMap::getForeignURL(
+ $wikiId,
+ $linkTarget->getNamespace() === 0
+ ? $linkTarget->getDBkey()
+ : MWNamespace::getCanonicalName( $linkTarget->getNamespace() ) . ':'
+ . $linkTarget->getDBkey(),
+ $linkTarget->getFragment()
+ ),
+ $text,
+ /* escape = */ false // Already escaped
+ );
} else {
- # Other kind of link
- if ( preg_match( $wgContLang->linkTrail(), $match[4], $submatch ) ) {
- $trail = $submatch[1];
- } else {
- $trail = "";
- }
- $linkRegexp = '/\[\[(.*?)\]\]' . preg_quote( $trail, '/' ) . '/';
- if ( isset( $match[1][0] ) && $match[1][0] == ':' )
- $match[1] = substr( $match[1], 1 );
- list( $inside, $trail ) = Linker::splitTrail( $trail );
-
- $linkText = $text;
- $linkTarget = Linker::normalizeSubpageLink( $this->commentContextTitle,
- $match[1], $linkText );
-
- $target = Title::newFromText( $linkTarget );
- if ( $target ) {
- if ( $target->getText() == '' && $target->getInterwiki() === ''
- && !$this->commentLocal && $this->commentContextTitle )
- {
- $newTarget = clone ( $this->commentContextTitle );
- $newTarget->setFragment( '#' . $target->getFragment() );
- $target = $newTarget;
- }
- $thelink = $this->link(
- $target,
- $linkText . $inside
- ) . $trail;
- }
- }
- if ( $thelink ) {
- // If the link is still valid, go ahead and replace it in!
- $comment = preg_replace( $linkRegexp, StringUtils::escapeRegexReplacement( $thelink ), $comment, 1 );
+ $link = self::link( $linkTarget, $text, [], [], $options );
}
- return $comment;
+ return $link;
}
- static function normalizeSubpageLink( $contextTitle, $target, &$text ) {
+ /**
+ * @param Title $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 / from text
+ # /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,
+ # (from CurrentPage/CurrentSubPage)
+ # ../Foobar/ -- convert to CurrentPage/Foobar, use 'Foobar' as text
+ # (from CurrentPage/CurrentSubPage)
- wfProfileIn( __METHOD__ );
$ret = $target; # default return value is no change
# Some namespaces don't allow subpages,
} else {
$suffix = '';
}
- # bug 7425
+ # T9425
$target = trim( $target );
# Look at the first character
- if ( $target != '' && $target { 0 } === '/' ) {
+ if ( $target != '' && $target[0] === '/' ) {
# / at end means we don't want the slash to be shown
- $m = array();
+ $m = [];
$trailingSlashes = preg_match_all( '%(/+)$%', $target, $m );
if ( $trailingSlashes ) {
$noslash = $target = substr( $target, 1, -strlen( $m[0][0] ) );
$nodotdot = substr( $nodotdot, 3 );
}
if ( $dotdotcount > 0 ) {
- $exploded = explode( '/', $contextTitle->GetPrefixedText() );
+ $exploded = explode( '/', $contextTitle->getPrefixedText() );
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 = substr( $nodotdot, 0, -1 );
+ $nodotdot = rtrim( $nodotdot, '/' );
if ( $text === '' ) {
$text = $nodotdot . $suffix;
}
}
}
- wfProfileOut( __METHOD__ );
return $ret;
}
* Wrap a comment in standard punctuation and formatting if
* it's non-empty, otherwise return empty string.
*
- * @param $comment String
- * @param $title Mixed: Title object (to generate link to section in autocomment) or null
- * @param $local Boolean: whether section links should refer to local page
+ * @since 1.16.3. $wikiId added in 1.26
+ * @param string $comment
+ * @param Title|null $title Title object (to generate link to section in autocomment) or null
+ * @param bool $local Whether section links should refer to local page
+ * @param string|null $wikiId Id (as used by WikiMap) of the wiki to generate links to.
+ * For use with external changes.
*
* @return string
*/
- function commentBlock( $comment, $title = null, $local = false ) {
+ public static function commentBlock(
+ $comment, $title = null, $local = false, $wikiId = null
+ ) {
// '*' used to be the comment inserted by the software way back
// in antiquity in case none was provided, here for backwards
- // compatability, acc. to brion -ævar
+ // compatibility, acc. to brion -ævar
if ( $comment == '' || $comment == '*' ) {
return '';
} else {
- $formatted = $this->formatComment( $comment, $title, $local );
- return " <span class=\"comment\">($formatted)</span>";
+ $formatted = self::formatComment( $comment, $title, $local, $wikiId );
+ $formatted = wfMessage( 'parentheses' )->rawParams( $formatted )->escaped();
+ return " <span class=\"comment\">$formatted</span>";
}
}
* Wrap and format the given revision's comment block, if the current
* user is allowed to view it.
*
- * @param $rev Revision object
- * @param $local Boolean: whether section links should refer to local page
- * @param $isPublic Boolean: show only if all users can see it
- * @return String: HTML fragment
+ * @since 1.16.3
+ * @param Revision $rev
+ * @param bool $local Whether section links should refer to local page
+ * @param bool $isPublic Show only if all users can see it
+ * @return string HTML fragment
*/
- function revComment( Revision $rev, $local = false, $isPublic = false ) {
- if ( $rev->getRawComment() == "" ) return "";
+ public static function revComment( Revision $rev, $local = false, $isPublic = false ) {
+ if ( $rev->getComment( Revision::RAW ) == "" ) {
+ return "";
+ }
if ( $rev->isDeleted( Revision::DELETED_COMMENT ) && $isPublic ) {
- $block = " <span class=\"comment\">" . wfMsgHtml( 'rev-deleted-comment' ) . "</span>";
- } else if ( $rev->userCan( Revision::DELETED_COMMENT ) ) {
- $block = $this->commentBlock( $rev->getComment( Revision::FOR_THIS_USER ),
+ $block = " <span class=\"comment\">" . wfMessage( 'rev-deleted-comment' )->escaped() . "</span>";
+ } elseif ( $rev->userCan( Revision::DELETED_COMMENT ) ) {
+ $block = self::commentBlock( $rev->getComment( Revision::FOR_THIS_USER ),
$rev->getTitle(), $local );
} else {
- $block = " <span class=\"comment\">" . wfMsgHtml( 'rev-deleted-comment' ) . "</span>";
+ $block = " <span class=\"comment\">" . wfMessage( 'rev-deleted-comment' )->escaped() . "</span>";
}
if ( $rev->isDeleted( Revision::DELETED_COMMENT ) ) {
return " <span class=\"history-deleted\">$block</span>";
return $block;
}
- public function formatRevisionSize( $size ) {
+ /**
+ * @since 1.16.3
+ * @param int $size
+ * @return string
+ */
+ public static function formatRevisionSize( $size ) {
if ( $size == 0 ) {
- $stxt = wfMsgExt( 'historyempty', 'parsemag' );
+ $stxt = wfMessage( 'historyempty' )->escaped();
} else {
- global $wgLang;
- $stxt = wfMsgExt( 'nbytes', 'parsemag', $wgLang->formatNum( $size ) );
- $stxt = "($stxt)";
+ $stxt = wfMessage( 'nbytes' )->numParams( $size )->escaped();
+ $stxt = wfMessage( 'parentheses' )->rawParams( $stxt )->escaped();
}
- $stxt = htmlspecialchars( $stxt );
return "<span class=\"history-size\">$stxt</span>";
}
/**
* Add another level to the Table of Contents
+ *
+ * @since 1.16.3
+ * @return string
*/
- function tocIndent() {
+ public static function tocIndent() {
return "\n<ul>";
}
/**
* Finish one or more sublevels on the Table of Contents
+ *
+ * @since 1.16.3
+ * @param int $level
+ * @return string
*/
- function tocUnindent( $level ) {
+ public static function tocUnindent( $level ) {
return "</li>\n" . str_repeat( "</ul>\n</li>\n", $level > 0 ? $level : 0 );
}
/**
* parameter level defines if we are on an indentation level
+ *
+ * @since 1.16.3
+ * @param string $anchor
+ * @param string $tocline
+ * @param string $tocnumber
+ * @param string $level
+ * @param string|bool $sectionIndex
+ * @return string
*/
- function tocLine( $anchor, $tocline, $tocnumber, $level, $sectionIndex = false ) {
+ public static function tocLine( $anchor, $tocline, $tocnumber, $level, $sectionIndex = false ) {
$classes = "toclevel-$level";
- if ( $sectionIndex !== false )
+ if ( $sectionIndex !== false ) {
$classes .= " tocsection-$sectionIndex";
- return "\n<li class=\"$classes\"><a href=\"#" .
- $anchor . '"><span class="tocnumber">' .
- $tocnumber . '</span> <span class="toctext">' .
- $tocline . '</span></a>';
+ }
+
+ // \n<li class="$classes"><a href="#$anchor"><span class="tocnumber">
+ // $tocnumber</span> <span class="toctext">$tocline</span></a>
+ return "\n" . Html::openElement( 'li', [ 'class' => $classes ] )
+ . Html::rawElement( 'a',
+ [ 'href' => "#$anchor" ],
+ Html::element( 'span', [ 'class' => 'tocnumber' ], $tocnumber )
+ . ' '
+ . Html::rawElement( 'span', [ 'class' => 'toctext' ], $tocline )
+ );
}
/**
* End a Table Of Contents line.
* tocUnindent() will be used instead if we're ending a line below
* the new level.
+ * @since 1.16.3
+ * @return string
*/
- function tocLineEnd() {
+ public static function tocLineEnd() {
return "</li>\n";
}
/**
* Wraps the TOC in a table and provides the hide/collapse javascript.
*
- * @param $toc String: html of the Table Of Contents
- * @param $lang mixed: Language code for the toc title
- * @return String: full html of the TOC
+ * @since 1.16.3
+ * @param string $toc Html of the Table Of Contents
+ * @param string|Language|bool $lang Language for the toc title, defaults to user language
+ * @return string Full html of the TOC
*/
- function tocList( $toc, $lang = false ) {
- $title = wfMsgExt( 'toc', array( 'language' => $lang, 'escape' ) );
- return
- '<table id="toc" class="toc"><tr><td>'
- . '<div id="toctitle"><h2>' . $title . "</h2></div>\n"
- . $toc
- . "</ul>\n</td></tr></table>\n";
+ public static function tocList( $toc, $lang = false ) {
+ $lang = wfGetLangObj( $lang );
+ $title = wfMessage( 'toc' )->inLanguage( $lang )->escaped();
+
+ return '<div id="toc" class="toc">'
+ . '<div class="toctitle"><h2>' . $title . "</h2></div>\n"
+ . $toc
+ . "</ul>\n</div>\n";
}
/**
- * Generate a table of contents from a section tree
- * Currently unused.
+ * Generate a table of contents from a section tree.
*
- * @param $tree Return value of ParserOutput::getSections()
- * @return String: HTML fragment
+ * @since 1.16.3. $lang added in 1.17
+ * @param array $tree Return value of ParserOutput::getSections()
+ * @param string|Language|bool $lang Language for the toc title, defaults to user language
+ * @return string HTML fragment
*/
- public function generateTOC( $tree ) {
+ public static function generateTOC( $tree, $lang = false ) {
$toc = '';
$lastLevel = 0;
foreach ( $tree as $section ) {
- if ( $section['toclevel'] > $lastLevel )
- $toc .= $this->tocIndent();
- else if ( $section['toclevel'] < $lastLevel )
- $toc .= $this->tocUnindent(
+ if ( $section['toclevel'] > $lastLevel ) {
+ $toc .= self::tocIndent();
+ } elseif ( $section['toclevel'] < $lastLevel ) {
+ $toc .= self::tocUnindent(
$lastLevel - $section['toclevel'] );
- else
- $toc .= $this->tocLineEnd();
+ } else {
+ $toc .= self::tocLineEnd();
+ }
- $toc .= $this->tocLine( $section['anchor'],
+ $toc .= self::tocLine( $section['anchor'],
$section['line'], $section['number'],
$section['toclevel'], $section['index'] );
$lastLevel = $section['toclevel'];
}
- $toc .= $this->tocLineEnd();
- return $this->tocList( $toc );
- }
-
- /**
- * Create a section edit link. This supersedes editSectionLink() and
- * editSectionLinkForOther().
- *
- * @param $nt Title The title being linked to (may not be the same as
- * $wgTitle, if the section is included from a template)
- * @param $section string The designation of the section being pointed to,
- * to be included in the link, like "§ion=$section"
- * @param $tooltip string The tooltip to use for the link: will be escaped
- * and wrapped in the 'editsectionhint' message
- * @param $lang string Language code
- * @return string HTML to use for edit link
- */
- public function doEditSectionLink( Title $nt, $section, $tooltip = null, $lang = false ) {
- // HTML generated here should probably have userlangattributes
- // added to it for LTR text on RTL pages
- $attribs = array();
- if ( !is_null( $tooltip ) ) {
- # Bug 25462: undo double-escaping.
- $tooltip = Sanitizer::decodeCharReferences( $tooltip );
- $attribs['title'] = wfMsgReal( 'editsectionhint', array( $tooltip ), true, $lang );
- }
- $link = $this->link( $nt, wfMsgExt( 'editsection', array( 'language' => $lang ) ),
- $attribs,
- array( 'action' => 'edit', 'section' => $section ),
- array( 'noclasses', 'known' )
- );
-
- # Run the old hook. This takes up half of the function . . . hopefully
- # we can rid of it someday.
- $attribs = '';
- if ( $tooltip ) {
- $attribs = htmlspecialchars( wfMsgReal( 'editsectionhint', array( $tooltip ), true, $lang ) );
- $attribs = " title=\"$attribs\"";
- }
- $result = null;
- wfRunHooks( 'EditSectionLink', array( &$this, $nt, $section, $attribs, $link, &$result, $lang ) );
- if ( !is_null( $result ) ) {
- # For reverse compatibility, add the brackets *after* the hook is
- # run, and even add them to hook-provided text. (This is the main
- # reason that the EditSectionLink hook is deprecated in favor of
- # DoEditSectionLink: it can't change the brackets or the span.)
- $result = wfMsgExt( 'editsection-brackets', array( 'escape', 'replaceafter', 'language' => $lang ), $result );
- return "<span class=\"editsection\">$result</span>";
- }
-
- # Add the brackets and the span, and *then* run the nice new hook, with
- # clean and non-redundant arguments.
- $result = wfMsgExt( 'editsection-brackets', array( 'escape', 'replaceafter', 'language' => $lang ), $link );
- $result = "<span class=\"editsection\">$result</span>";
-
- wfRunHooks( 'DoEditSectionLink', array( $this, $nt, $section, $tooltip, &$result, $lang ) );
- return $result;
+ $toc .= self::tocLineEnd();
+ return self::tocList( $toc, $lang );
}
/**
* Create a headline for content
*
- * @param $level Integer: the level of the headline (1-6)
- * @param $attribs String: any attributes for the headline, starting with
- * a space and ending with '>'
- * This *must* be at least '>' for no attribs
- * @param $anchor String: the anchor to give the headline (the bit after the #)
- * @param $text String: the text of the header
- * @param $link String: HTML to add for the section edit link
- * @param $legacyAnchor Mixed: a second, optional anchor to give for
+ * @since 1.16.3
+ * @param int $level The level of the headline (1-6)
+ * @param string $attribs Any attributes for the headline, starting with
+ * a space and ending with '>'
+ * This *must* be at least '>' for no attribs
+ * @param string $anchor The anchor to give the headline (the bit after the #)
+ * @param string $html HTML for the text of the header
+ * @param string $link HTML to add for the section edit link
+ * @param string|bool $fallbackAnchor A second, optional anchor to give for
* backward compatibility (false to omit)
*
- * @return String: HTML headline
+ * @return string HTML headline
*/
- public function makeHeadline( $level, $attribs, $anchor, $text, $link, $legacyAnchor = false ) {
+ public static function makeHeadline( $level, $attribs, $anchor, $html,
+ $link, $fallbackAnchor = false
+ ) {
+ $anchorEscaped = htmlspecialchars( $anchor );
+ $fallback = '';
+ if ( $fallbackAnchor !== false && $fallbackAnchor !== $anchor ) {
+ $fallbackAnchor = htmlspecialchars( $fallbackAnchor );
+ $fallback = "<span id=\"$fallbackAnchor\"></span>";
+ }
$ret = "<h$level$attribs"
+ . "$fallback<span class=\"mw-headline\" id=\"$anchorEscaped\">$html</span>"
. $link
- . " <span class=\"mw-headline\" id=\"$anchor\">$text</span>"
. "</h$level>";
- if ( $legacyAnchor !== false ) {
- $ret = "<div id=\"$legacyAnchor\"></div>$ret";
- }
+
return $ret;
}
/**
* Split a link trail, return the "inside" portion and the remainder of the trail
* as a two-element array
+ * @param string $trail
+ * @return array
*/
static function splitTrail( $trail ) {
- static $regex = false;
- if ( $regex === false ) {
- global $wgContLang;
- $regex = $wgContLang->linkTrail();
- }
+ global $wgContLang;
+ $regex = $wgContLang->linkTrail();
$inside = '';
if ( $trail !== '' ) {
- $m = array();
+ $m = [];
if ( preg_match( $regex, $trail, $m ) ) {
$inside = $m[1];
$trail = $m[2];
}
}
- return array( $inside, $trail );
+ return [ $inside, $trail ];
}
/**
* changes, so this allows sysops to combat a busy vandal without bothering
* other users.
*
- * @param $rev Revision object
+ * If the option verify is set this function will return the link only in case the
+ * revision can be reverted. 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 wont
+ * 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
+ *
+ * @param Revision $rev
+ * @param IContextSource $context Context to use or null for the main context.
+ * @param array $options
+ * @return string
*/
- function generateRollback( $rev ) {
- return '<span class="mw-rollback-link">['
- . $this->buildRollbackLink( $rev )
- . ']</span>';
+ public static function generateRollback( $rev, IContextSource $context = null,
+ $options = [ 'verify' ]
+ ) {
+ if ( $context === null ) {
+ $context = RequestContext::getMain();
+ }
+
+ $editCount = false;
+ if ( in_array( 'verify', $options, true ) ) {
+ $editCount = self::getRollbackEditCount( $rev, true );
+ if ( $editCount === false ) {
+ return '';
+ }
+ }
+
+ $inner = self::buildRollbackLink( $rev, $context, $editCount );
+
+ if ( !in_array( 'noBrackets', $options, true ) ) {
+ $inner = $context->msg( 'brackets' )->rawParams( $inner )->escaped();
+ }
+
+ return '<span class="mw-rollback-link">' . $inner . '</span>';
+ }
+
+ /**
+ * This function will return the number of revisions which a rollback
+ * would revert and, if $verify is set it 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 $verify
+ * is set and the user is the only contributor of the page.
+ *
+ * @param Revision $rev
+ * @param bool $verify Try to verify that this revision can really be rolled back
+ * @return int|bool|null
+ */
+ public static function getRollbackEditCount( $rev, $verify ) {
+ global $wgShowRollbackEditCount;
+ if ( !is_int( $wgShowRollbackEditCount ) || !$wgShowRollbackEditCount > 0 ) {
+ // Nothing has happened, indicate this by returning 'null'
+ return null;
+ }
+
+ $dbr = wfGetDB( DB_REPLICA );
+
+ // Up to the value of $wgShowRollbackEditCount revisions are counted
+ $res = $dbr->select(
+ 'revision',
+ [ 'rev_user_text', 'rev_deleted' ],
+ // $rev->getPage() returns null sometimes
+ [ 'rev_page' => $rev->getTitle()->getArticleID() ],
+ __METHOD__,
+ [
+ 'USE INDEX' => [ 'revision' => 'page_timestamp' ],
+ 'ORDER BY' => 'rev_timestamp DESC',
+ 'LIMIT' => $wgShowRollbackEditCount + 1
+ ]
+ );
+
+ $editCount = 0;
+ $moreRevs = false;
+ foreach ( $res as $row ) {
+ if ( $rev->getUserText( Revision::RAW ) != $row->rev_user_text ) {
+ if ( $verify &&
+ ( $row->rev_deleted & Revision::DELETED_TEXT
+ || $row->rev_deleted & Revision::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 sanity checks in WikiPage::commitRollback.
+ return false;
+ }
+ $moreRevs = true;
+ break;
+ }
+ $editCount++;
+ }
+
+ if ( $verify && $editCount <= $wgShowRollbackEditCount && !$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
*
- * @param $rev Revision object
- * @return String: HTML fragment
+ * @since 1.16.3. $context added in 1.20. $editCount added in 1.21
+ * @param Revision $rev
+ * @param IContextSource|null $context Context to use or null for the main context.
+ * @param int $editCount Number of edits that would be reverted
+ * @return string HTML fragment
*/
- public function buildRollbackLink( $rev ) {
- global $wgRequest, $wgUser;
+ public static function buildRollbackLink( $rev, IContextSource $context = null,
+ $editCount = false
+ ) {
+ global $wgShowRollbackEditCount, $wgMiserMode;
+
+ // To config which pages are affected by miser mode
+ $disableRollbackEditCountSpecialPage = [ 'Recentchanges', 'Watchlist' ];
+
+ if ( $context === null ) {
+ $context = RequestContext::getMain();
+ }
+
$title = $rev->getTitle();
- $query = array(
+ $query = [
'action' => 'rollback',
- 'from' => $rev->getUserText()
- );
- if ( $wgRequest->getBool( 'bot' ) ) {
+ 'from' => $rev->getUserText(),
+ 'token' => $context->getUser()->getEditToken( 'rollback' ),
+ ];
+ $attrs = [
+ 'data-mw' => 'interface',
+ 'title' => $context->msg( 'tooltip-rollback' )->text(),
+ ];
+ $options = [ 'known', 'noclasses' ];
+
+ if ( $context->getRequest()->getBool( 'bot' ) ) {
$query['bot'] = '1';
- $query['hidediff'] = '1'; // bug 15999
+ $query['hidediff'] = '1'; // T17999
+ }
+
+ $disableRollbackEditCount = false;
+ if ( $wgMiserMode ) {
+ foreach ( $disableRollbackEditCountSpecialPage as $specialPage ) {
+ if ( $context->getTitle()->isSpecial( $specialPage ) ) {
+ $disableRollbackEditCount = true;
+ break;
+ }
+ }
+ }
+
+ if ( !$disableRollbackEditCount
+ && is_int( $wgShowRollbackEditCount )
+ && $wgShowRollbackEditCount > 0
+ ) {
+ if ( !is_numeric( $editCount ) ) {
+ $editCount = self::getRollbackEditCount( $rev, false );
+ }
+
+ if ( $editCount > $wgShowRollbackEditCount ) {
+ $html = $context->msg( 'rollbacklinkcount-morethan' )
+ ->numParams( $wgShowRollbackEditCount )->parse();
+ } else {
+ $html = $context->msg( 'rollbacklinkcount' )->numParams( $editCount )->parse();
+ }
+
+ return self::link( $title, $html, $attrs, $query, $options );
+ } else {
+ $html = $context->msg( 'rollbacklink' )->escaped();
+ return self::link( $title, $html, $attrs, $query, $options );
}
- $query['token'] = $wgUser->editToken( array( $title->getPrefixedText(),
- $rev->getUserText() ) );
- return $this->link( $title, wfMsgHtml( 'rollbacklink' ),
- array( 'title' => wfMsg( 'tooltip-rollback' ) ),
- $query, array( 'known', 'noclasses' ) );
}
/**
+ * @deprecated since 1.28, use TemplatesOnThisPageFormatter directly
+ *
* Returns HTML for the "templates used on this page" list.
*
- * @param $templates Array of templates from Article::getUsedTemplate
- * or similar
- * @param $preview Boolean: whether this is for a preview
- * @param $section Boolean: whether this is for a section edit
- * @return String: HTML output
+ * Make an HTML list of templates, and then add a "More..." link at
+ * the bottom. If $more is null, do not add a "More..." link. If $more
+ * is a Title, make a link to that title and use it. If $more is a string,
+ * directly paste it in as the link (escaping needs to be done manually).
+ * Finally, if $more is a Message, call toString().
+ *
+ * @since 1.16.3. $more added in 1.21
+ * @param Title[] $templates Array of templates
+ * @param bool $preview Whether this is for a preview
+ * @param bool $section Whether this is for a section edit
+ * @param Title|Message|string|null $more An escaped link for "More..." of the templates
+ * @return string HTML output
*/
- public function formatTemplates( $templates, $preview = false, $section = false ) {
- wfProfileIn( __METHOD__ );
+ public static function formatTemplates( $templates, $preview = false,
+ $section = false, $more = null
+ ) {
+ wfDeprecated( __METHOD__, '1.28' );
- $outText = '';
- if ( count( $templates ) > 0 ) {
- # Do a batch existence check
- $batch = new LinkBatch;
- foreach ( $templates as $title ) {
- $batch->addObj( $title );
- }
- $batch->execute();
-
- # Construct the HTML
- $outText = '<div class="mw-templatesUsedExplanation">';
- if ( $preview ) {
- $outText .= wfMsgExt( 'templatesusedpreview', array( 'parse' ), count( $templates ) );
- } elseif ( $section ) {
- $outText .= wfMsgExt( 'templatesusedsection', array( 'parse' ), count( $templates ) );
- } else {
- $outText .= wfMsgExt( 'templatesused', array( 'parse' ), count( $templates ) );
- }
- $outText .= "</div><ul>\n";
+ $type = false;
+ if ( $preview ) {
+ $type = 'preview';
+ } elseif ( $section ) {
+ $type = 'section';
+ }
- usort( $templates, array( 'Title', 'compare' ) );
- foreach ( $templates as $titleObj ) {
- $r = $titleObj->getRestrictions( 'edit' );
- if ( in_array( 'sysop', $r ) ) {
- $protected = wfMsgExt( 'template-protected', array( 'parseinline' ) );
- } elseif ( in_array( 'autoconfirmed', $r ) ) {
- $protected = wfMsgExt( 'template-semiprotected', array( 'parseinline' ) );
- } else {
- $protected = '';
- }
- if ( $titleObj->quickUserCan( 'edit' ) ) {
- $editLink = $this->link(
- $titleObj,
- wfMsg( 'editlink' ),
- array(),
- array( 'action' => 'edit' )
- );
- } else {
- $editLink = $this->link(
- $titleObj,
- wfMsg( 'viewsourcelink' ),
- array(),
- array( 'action' => 'edit' )
- );
- }
- $outText .= '<li>' . $this->link( $titleObj ) . ' (' . $editLink . ') ' . $protected . '</li>';
- }
- $outText .= '</ul>';
+ if ( $more instanceof Message ) {
+ $more = $more->toString();
}
- wfProfileOut( __METHOD__ );
- return $outText;
+
+ $formatter = new TemplatesOnThisPageFormatter(
+ RequestContext::getMain(),
+ MediaWikiServices::getInstance()->getLinkRenderer()
+ );
+ return $formatter->format( $templates, $type, $more );
}
/**
* Returns HTML for the "hidden categories on this page" list.
*
- * @param $hiddencats Array of hidden categories from Article::getHiddenCategories
- * or similar
- * @return String: HTML output
+ * @since 1.16.3
+ * @param array $hiddencats Array of hidden categories from Article::getHiddenCategories
+ * or similar
+ * @return string HTML output
*/
- public function formatHiddenCategories( $hiddencats ) {
- global $wgLang;
- wfProfileIn( __METHOD__ );
-
+ public static function formatHiddenCategories( $hiddencats ) {
$outText = '';
if ( count( $hiddencats ) > 0 ) {
# Construct the HTML
$outText = '<div class="mw-hiddenCategoriesExplanation">';
- $outText .= wfMsgExt( 'hiddencategories', array( 'parse' ), $wgLang->formatnum( count( $hiddencats ) ) );
+ $outText .= wfMessage( 'hiddencategories' )->numParams( count( $hiddencats ) )->parseAsBlock();
$outText .= "</div><ul>\n";
foreach ( $hiddencats as $titleObj ) {
- $outText .= '<li>' . $this->link( $titleObj, null, array(), array(), 'known' ) . "</li>\n"; # If it's hidden, it must exist - no need to check with a LinkBatch
+ # 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>';
}
- wfProfileOut( __METHOD__ );
return $outText;
}
/**
+ * @deprecated since 1.28, use Language::formatSize() directly
+ *
* Format a size in bytes for output, using an appropriate
* unit (B, KB, MB or GB) according to the magnitude in question
*
- * @param $size Size to format
- * @return String
+ * @since 1.16.3
+ * @param int $size Size to format
+ * @return string
*/
- public function formatSize( $size ) {
+ public static function formatSize( $size ) {
+ wfDeprecated( __METHOD__, '1.28' );
+
global $wgLang;
return htmlspecialchars( $wgLang->formatSize( $size ) );
}
* isn't always, because sometimes the accesskey needs to go on a different
* element than the id, for reverse-compatibility, etc.)
*
- * @param $name String: id of the element, minus prefixes.
- * @param $options Mixed: null or the string 'withaccess' to add an access-
+ * @since 1.16.3 $msgParams added in 1.27
+ * @param string $name Id of the element, minus prefixes.
+ * @param string|null $options Null or the string 'withaccess' to add an access-
* key hint
- * @return String: contents of the title attribute (which you must HTML-
+ * @param array $msgParams Parameters to pass to the message
+ *
+ * @return string Contents of the title attribute (which you must HTML-
* escape), or false for no title attribute
*/
- public function titleAttrib( $name, $options = null ) {
- wfProfileIn( __METHOD__ );
-
- if ( wfEmptyMsg( "tooltip-$name" ) ) {
+ public static function titleAttrib( $name, $options = null, array $msgParams = [] ) {
+ $message = wfMessage( "tooltip-$name", $msgParams );
+ if ( !$message->exists() ) {
$tooltip = false;
} else {
- $tooltip = wfMsg( "tooltip-$name" );
+ $tooltip = $message->text();
# Compatibility: formerly some tooltips had [alt-.] hardcoded
$tooltip = preg_replace( "/ ?\[alt-.\]$/", '', $tooltip );
# Message equal to '-' means suppress it.
- if ( $tooltip == '-' ) {
+ if ( $tooltip == '-' ) {
$tooltip = false;
}
}
if ( $options == 'withaccess' ) {
- $accesskey = $this->accesskey( $name );
+ $accesskey = self::accesskey( $name );
if ( $accesskey !== false ) {
+ // Should be build the same as in jquery.accessKeyLabel.js
if ( $tooltip === false || $tooltip === '' ) {
- $tooltip = "[$accesskey]";
+ $tooltip = wfMessage( 'brackets', $accesskey )->text();
} else {
- $tooltip .= " [$accesskey]";
+ $tooltip .= wfMessage( 'word-separator' )->text();
+ $tooltip .= wfMessage( 'brackets', $accesskey )->text();
}
}
}
- wfProfileOut( __METHOD__ );
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.)
*
- * @param $name String: id of the element, minus prefixes.
- * @return String: contents of the accesskey attribute (which you must HTML-
+ * @since 1.16.3
+ * @param string $name Id of the element, minus prefixes.
+ * @return string Contents of the accesskey attribute (which you must HTML-
* escape), or false for no accesskey attribute
*/
- public function accesskey( $name ) {
- if ( isset( $this->accesskeycache[$name] ) ) {
- return $this->accesskeycache[$name];
+ public static function accesskey( $name ) {
+ if ( isset( self::$accesskeycache[$name] ) ) {
+ return self::$accesskeycache[$name];
}
- wfProfileIn( __METHOD__ );
$message = wfMessage( "accesskey-$name" );
} else {
$accesskey = $message->plain();
if ( $accesskey === '' || $accesskey === '-' ) {
- # FIXME: Per standard MW behavior, a value of '-' means to suppress the
+ # @todo FIXME: Per standard MW behavior, a value of '-' means to suppress the
# attribute, but this is broken for accesskey: that might be a useful
# value.
$accesskey = false;
}
}
- wfProfileOut( __METHOD__ );
- return $this->accesskeycache[$name] = $accesskey;
+ self::$accesskeycache[$name] = $accesskey;
+ return self::$accesskeycache[$name];
}
/**
- * Creates a (show/hide) link for deleting revisions/log entries
+ * Get a revision-deletion link, or disabled link, or nothing, depending
+ * on user permissions & the settings on the revision.
*
- * @param $query Array: query parameters to be passed to link()
- * @param $restricted Boolean: set to true to use a <strong> instead of a <span>
- * @param $delete Boolean: set to true to use (show/hide) rather than (show)
+ * Will use forward-compatible revision ID in the Special:RevDelete link
+ * if possible, otherwise the timestamp-based ID which may break after
+ * undeletion.
*
- * @return String: HTML <a> link to Special:Revisiondelete, wrapped in a
- * span to allow for customization of appearance with CSS
- */
- public function revDeleteLink( $query = array(), $restricted = false, $delete = true ) {
- $sp = SpecialPage::getTitleFor( 'Revisiondelete' );
- $text = $delete ? wfMsgHtml( 'rev-delundel' ) : wfMsgHtml( 'rev-showdeleted' );
- $tag = $restricted ? 'strong' : 'span';
- $link = $this->link( $sp, $text, array(), $query, array( 'known', 'noclasses' ) );
- return Xml::tags( $tag, array( 'class' => 'mw-revdelundel-link' ), "($link)" );
- }
-
- /**
- * Creates a dead (show/hide) link for deleting revisions/log entries
- *
- * @param $delete Boolean: 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 function revDeleteLinkDisabled( $delete = true ) {
- $text = $delete ? wfMsgHtml( 'rev-delundel' ) : wfMsgHtml( 'rev-showdeleted' );
- return Xml::tags( 'span', array( 'class' => 'mw-revdelundel-link' ), "($text)" );
- }
-
- /* Deprecated methods */
-
- /**
- * @deprecated
- */
- function postParseLinkColour( $s = null ) {
- wfDeprecated( __METHOD__ );
- return null;
- }
-
-
- /**
- * @deprecated Use link()
- *
- * This function is a shortcut to makeLinkObj(Title::newFromText($title),...). Do not call
- * it if you already have a title object handy. See makeLinkObj for further documentation.
- *
- * @param $title String: the text of the title
- * @param $text String: link text
- * @param $query String: optional query part
- * @param $trail String: optional trail. Alphabetic characters at the start of this string will
- * be included in the link text. Other characters will be appended after
- * the end of the link.
- */
- function makeLink( $title, $text = '', $query = '', $trail = '' ) {
- wfProfileIn( __METHOD__ );
- $nt = Title::newFromText( $title );
- if ( $nt instanceof Title ) {
- $result = $this->makeLinkObj( $nt, $text, $query, $trail );
- } else {
- wfDebug( 'Invalid title passed to Linker::makeLink(): "' . $title . "\"\n" );
- $result = $text == "" ? $title : $text;
- }
-
- wfProfileOut( __METHOD__ );
- return $result;
- }
-
- /**
- * @deprecated Use link()
- *
- * This function is a shortcut to makeKnownLinkObj(Title::newFromText($title),...). Do not call
- * it if you already have a title object handy. See makeKnownLinkObj for further documentation.
- *
- * @param $title String: the text of the title
- * @param $text String: link text
- * @param $query String: optional query part
- * @param $trail String: optional trail. Alphabetic characters at the start of this string will
- * be included in the link text. Other characters will be appended after
- * the end of the link.
- * @param $prefix String: Optional prefix
- * @param $aprops String: extra attributes to the a-element
- */
- function makeKnownLink( $title, $text = '', $query = '', $trail = '', $prefix = '', $aprops = '' ) {
- $nt = Title::newFromText( $title );
- if ( $nt instanceof Title ) {
- return $this->makeKnownLinkObj( $nt, $text, $query, $trail, $prefix , $aprops );
- } else {
- wfDebug( 'Invalid title passed to Linker::makeKnownLink(): "' . $title . "\"\n" );
- return $text == '' ? $title : $text;
+ * @param User $user
+ * @param Revision $rev
+ * @param Title $title
+ * @return string HTML fragment
+ */
+ public static function getRevDeleteLink( User $user, Revision $rev, Title $title ) {
+ $canHide = $user->isAllowed( 'deleterevision' );
+ if ( !$canHide && !( $rev->getVisibility() && $user->isAllowed( 'deletedhistory' ) ) ) {
+ return '';
}
- }
- /**
- * @deprecated Use link()
- *
- * This function is a shortcut to makeBrokenLinkObj(Title::newFromText($title),...). Do not call
- * it if you already have a title object handy. See makeBrokenLinkObj for further documentation.
- *
- * @param $title String: The text of the title
- * @param $text String: Link text
- * @param $query String: Optional query part
- * @param $trail String: Optional trail. Alphabetic characters at the start of this string will
- * be included in the link text. Other characters will be appended after
- * the end of the link.
- */
- function makeBrokenLink( $title, $text = '', $query = '', $trail = '' ) {
- $nt = Title::newFromText( $title );
- if ( $nt instanceof Title ) {
- return $this->makeBrokenLinkObj( $nt, $text, $query, $trail );
+ if ( !$rev->userCan( Revision::DELETED_RESTRICTED, $user ) ) {
+ return self::revDeleteLinkDisabled( $canHide ); // revision was hidden from sysops
} else {
- wfDebug( 'Invalid title passed to Linker::makeBrokenLink(): "' . $title . "\"\n" );
- return $text == '' ? $title : $text;
+ if ( $rev->getId() ) {
+ // RevDelete links using revision ID are stable across
+ // page deletion and undeletion; use when possible.
+ $query = [
+ 'type' => 'revision',
+ 'target' => $title->getPrefixedDBkey(),
+ 'ids' => $rev->getId()
+ ];
+ } else {
+ // Older deleted entries didn't save a revision ID.
+ // We have to refer to these by timestamp, ick!
+ $query = [
+ 'type' => 'archive',
+ 'target' => $title->getPrefixedDBkey(),
+ 'ids' => $rev->getTimestamp()
+ ];
+ }
+ return self::revDeleteLink( $query,
+ $rev->isDeleted( Revision::DELETED_RESTRICTED ), $canHide );
}
}
/**
- * @deprecated Use link()
+ * Creates a (show/hide) link for deleting revisions/log entries
*
- * This function is a shortcut to makeStubLinkObj(Title::newFromText($title),...). Do not call
- * it if you already have a title object handy. See makeStubLinkObj for further documentation.
+ * @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)
*
- * @param $title String: the text of the title
- * @param $text String: link text
- * @param $query String: optional query part
- * @param $trail String: optional trail. Alphabetic characters at the start of this string will
- * be included in the link text. Other characters will be appended after
- * the end of the link.
- */
- function makeStubLink( $title, $text = '', $query = '', $trail = '' ) {
- wfDeprecated( __METHOD__ );
- $nt = Title::newFromText( $title );
- if ( $nt instanceof Title ) {
- return $this->makeStubLinkObj( $nt, $text, $query, $trail );
- } else {
- wfDebug( 'Invalid title passed to Linker::makeStubLink(): "' . $title . "\"\n" );
- return $text == '' ? $title : $text;
- }
- }
-
- /**
- * @deprecated Use link()
- *
- * Make a link for a title which may or may not be in the database. If you need to
- * call this lots of times, pre-fill the link cache with a LinkBatch, otherwise each
- * call to this will result in a DB query.
- *
- * @param $nt Title: the title object to make the link from, e.g. from
- * Title::newFromText.
- * @param $text String: link text
- * @param $query String: optional query part
- * @param $trail String: optional trail. Alphabetic characters at the start of this string will
- * be included in the link text. Other characters will be appended after
- * the end of the link.
- * @param $prefix String: optional prefix. As trail, only before instead of after.
- */
- function makeLinkObj( $nt, $text = '', $query = '', $trail = '', $prefix = '' ) {
- wfProfileIn( __METHOD__ );
-
- $query = wfCgiToArray( $query );
- list( $inside, $trail ) = Linker::splitTrail( $trail );
- if ( $text === '' ) {
- $text = $this->linkText( $nt );
- }
-
- $ret = $this->link( $nt, "$prefix$text$inside", array(), $query ) . $trail;
-
- wfProfileOut( __METHOD__ );
- return $ret;
- }
-
- /**
- * @deprecated Use link()
- *
- * Make a link for a title which definitely exists. This is faster than makeLinkObj because
- * it doesn't have to do a database query. It's also valid for interwiki titles and special
- * pages.
- *
- * @param $title Title object of target page
- * @param $text String: text to replace the title
- * @param $query String: link target
- * @param $trail String: text after link
- * @param $prefix String: text before link text
- * @param $aprops String: extra attributes to the a-element
- * @param $style String: style to apply - if empty, use getInternalLinkAttributesObj instead
- * @return the a-element
+ * @return string HTML "<a>" link to Special:Revisiondelete, wrapped in a
+ * span to allow for customization of appearance with CSS
*/
- function makeKnownLinkObj( $title, $text = '', $query = '', $trail = '', $prefix = '' , $aprops = '', $style = '' ) {
- wfProfileIn( __METHOD__ );
-
- if ( $text == '' ) {
- $text = $this->linkText( $title );
- }
- $attribs = Sanitizer::mergeAttributes(
- Sanitizer::decodeTagAttributes( $aprops ),
- Sanitizer::decodeTagAttributes( $style )
+ 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()
);
- $query = wfCgiToArray( $query );
- list( $inside, $trail ) = Linker::splitTrail( $trail );
-
- $ret = $this->link( $title, "$prefix$text$inside", $attribs, $query,
- array( 'known', 'noclasses' ) ) . $trail;
-
- wfProfileOut( __METHOD__ );
- return $ret;
}
/**
- * @deprecated Use link()
- *
- * Make a red link to the edit page of a given title.
- *
- * @param $title Title object of the target page
- * @param $text String: Link text
- * @param $query String: Optional query part
- * @param $trail String: Optional trail. Alphabetic characters at the start of this string will
- * be included in the link text. Other characters will be appended after
- * the end of the link.
- * @param $prefix String: Optional prefix
- */
- function makeBrokenLinkObj( $title, $text = '', $query = '', $trail = '', $prefix = '' ) {
- wfProfileIn( __METHOD__ );
-
- list( $inside, $trail ) = Linker::splitTrail( $trail );
- if ( $text === '' ) {
- $text = $this->linkText( $title );
- }
-
- $ret = $this->link( $title, "$prefix$text$inside", array(),
- wfCgiToArray( $query ), 'broken' ) . $trail;
-
- wfProfileOut( __METHOD__ );
- return $ret;
- }
-
- /**
- * @deprecated Use link()
- *
- * Make a brown link to a short article.
+ * Creates a dead (show/hide) link for deleting revisions/log entries
*
- * @param $nt Title object of the target page
- * @param $text String: link text
- * @param $query String: optional query part
- * @param $trail String: optional trail. Alphabetic characters at the start of this string will
- * be included in the link text. Other characters will be appended after
- * the end of the link.
- * @param $prefix String: Optional prefix
- */
- function makeStubLinkObj( $nt, $text = '', $query = '', $trail = '', $prefix = '' ) {
- // wfDeprecated( __METHOD__ );
- return $this->makeColouredLinkObj( $nt, 'stub', $text, $query, $trail, $prefix );
- }
-
- /**
- * @deprecated Use link()
- *
- * Make a coloured link.
- *
- * @param $nt Title object of the target page
- * @param $colour Integer: colour of the link
- * @param $text String: link text
- * @param $query String: optional query part
- * @param $trail String: optional trail. Alphabetic characters at the start of this string will
- * be included in the link text. Other characters will be appended after
- * the end of the link.
- * @param $prefix String: Optional prefix
- */
- function makeColouredLinkObj( $nt, $colour, $text = '', $query = '', $trail = '', $prefix = '' ) {
- // wfDeprecated( __METHOD__ );
- if ( $colour != '' ) {
- $style = $this->getInternalLinkAttributesObj( $nt, $text, $colour );
- } else $style = '';
- return $this->makeKnownLinkObj( $nt, $text, $query, $trail, $prefix, '', $style );
- }
-
- /** Obsolete alias */
- function makeImage( $url, $alt = '' ) {
- wfDeprecated( __METHOD__ );
- return $this->makeExternalImage( $url, $alt );
- }
-
- /**
- * Creates the HTML source for images
- * @deprecated use makeImageLink2
- *
- * @param $title Title object
- * @param $label String: label text
- * @param $alt String: alt text
- * @param $align String: horizontal alignment: none, left, center, right)
- * @param $handlerParams Array: parameters to be passed to the media handler
- * @param $framed Boolean: shows image in original size in a frame
- * @param $thumb Boolean: shows image as thumbnail in a frame
- * @param $manualthumb String: image name for the manual thumbnail
- * @param $valign String: vertical alignment: baseline, sub, super, top, text-top, middle, bottom, text-bottom
- * @param $time String: timestamp of the file, set as false for current
- * @return String
- */
- function makeImageLinkObj( $title, $label, $alt, $align = '', $handlerParams = array(), $framed = false,
- $thumb = false, $manualthumb = '', $valign = '', $time = false )
- {
- $frameParams = array( 'alt' => $alt, 'caption' => $label );
- if ( $align ) {
- $frameParams['align'] = $align;
- }
- if ( $framed ) {
- $frameParams['framed'] = true;
- }
- if ( $thumb ) {
- $frameParams['thumbnail'] = true;
- }
- if ( $manualthumb ) {
- $frameParams['manualthumb'] = $manualthumb;
- }
- if ( $valign ) {
- $frameParams['valign'] = $valign;
- }
- $file = wfFindFile( $title, array( 'time' => $time ) );
- return $this->makeImageLink2( $title, $file, $frameParams, $handlerParams, $time );
- }
-
- /** @deprecated use Linker::makeMediaLinkObj() */
- function makeMediaLink( $name, $unused = '', $text = '', $time = false ) {
- $nt = Title::makeTitleSafe( NS_FILE, $name );
- return $this->makeMediaLinkObj( $nt, $text, $time );
- }
-
- /**
- * Used to generate section edit links that point to "other" pages
- * (sections that are really part of included pages).
+ * @since 1.16.3
+ * @param bool $delete Set to true to use (show/hide) rather than (show)
*
- * @deprecated use Linker::doEditSectionLink()
- * @param $title Title string.
- * @param $section Integer: section number.
+ * @return string HTML text wrapped in a span to allow for customization
+ * of appearance with CSS
*/
- public function editSectionLinkForOther( $title, $section ) {
- wfDeprecated( __METHOD__ );
- $title = Title::newFromText( $title );
- return $this->doEditSectionLink( $title, $section );
+ 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 );
}
- /**
- * @deprecated use Linker::doEditSectionLink()
- * @param $nt Title object.
- * @param $section Integer: section number.
- * @param $hint Link String: title, or default if omitted or empty
- */
- public function editSectionLink( Title $nt, $section, $hint = '' ) {
- wfDeprecated( __METHOD__ );
- if ( $hint === '' ) {
- # No way to pass an actual empty $hint here! The new interface al-
- # lows this, so we have to do this for compatibility.
- $hint = null;
- }
- return $this->doEditSectionLink( $nt, $section, $hint );
- }
+ /* Deprecated methods */
/**
* 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
+ *
+ * @return array
*/
- public function tooltipAndAccesskeyAttribs( $name ) {
- global $wgEnableTooltipsAndAccesskeys;
- if ( !$wgEnableTooltipsAndAccesskeys )
- return array();
- # FIXME: If Sanitizer::expandAttributes() treated "false" as "output
- # no attribute" instead of "output '' as value for attribute", this
- # would be three lines.
- $attribs = array(
- 'title' => $this->titleAttrib( $name, 'withaccess' ),
- 'accesskey' => $this->accesskey( $name )
- );
+ public static function tooltipAndAccesskeyAttribs( $name, array $msgParams = [] ) {
+ $attribs = [
+ 'title' => self::titleAttrib( $name, 'withaccess', $msgParams ),
+ 'accesskey' => self::accesskey( $name )
+ ];
if ( $attribs['title'] === false ) {
unset( $attribs['title'] );
}
}
return $attribs;
}
+
/**
- * @deprecated Returns raw bits of HTML, use titleAttrib() and accesskey()
+ * Returns raw bits of HTML, use titleAttrib()
+ * @since 1.16.3
+ * @param string $name
+ * @param array|null $options
+ * @return null|string
*/
- public function tooltipAndAccesskey( $name ) {
- return Xml::expandAttributes( $this->tooltipAndAccesskeyAttribs( $name ) );
- }
-
- /** @deprecated Returns raw bits of HTML, use titleAttrib() */
- public function tooltip( $name, $options = null ) {
- global $wgEnableTooltipsAndAccesskeys;
- if ( !$wgEnableTooltipsAndAccesskeys )
- return '';
- # FIXME: If Sanitizer::expandAttributes() treated "false" as "output
- # no attribute" instead of "output '' as value for attribute", this
- # would be two lines.
- $tooltip = $this->titleAttrib( $name, $options );
+ public static function tooltip( $name, $options = null ) {
+ $tooltip = self::titleAttrib( $name, $options );
if ( $tooltip === false ) {
return '';
}
- return Xml::expandAttributes( array(
- 'title' => $this->titleAttrib( $name, $options )
- ) );
+ return Xml::expandAttributes( [
+ 'title' => $tooltip
+ ] );
}
+
}
scripts.mit.edu / autoinstallsdev / mediawiki.git / blobdiff