function __construct() {}
- /**
- * @deprecated
- */
- function postParseLinkColour( $s = null ) {
- wfDeprecated( __METHOD__ );
- return null;
- }
-
/**
* Get the appropriate HTML attributes to add to the "a" element of an ex-
* ternal link, as created by [wikisyntax].
*
- * @param string $title The (unescaped) title text for the link
- * @param string $unused Unused
* @param string $class The contents of the class attribute; if an empty
* string is passed, which is the default value, defaults to 'external'.
*/
- function getExternalLinkAttributes( $title, $unused = null, $class='' ) {
- return $this->getLinkAttributesInternal( $title, $class, 'external' );
+ function getExternalLinkAttributes( $class = 'external' ) {
+ return $this->getLinkAttributesInternal( '', $class );
}
/**
* @param string $class 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='' ) {
+ function getInterwikiLinkAttributes( $title, $unused = null, $class = 'external' ) {
global $wgContLang;
# FIXME: We have a whole bunch of handling here that doesn't happen in
$title = $wgContLang->checkTitleEncoding( $title );
$title = preg_replace( '/[\\x00-\\x1f]/', ' ', $title );
- return $this->getLinkAttributesInternal( $title, $class, 'external' );
+ return $this->getLinkAttributesInternal( $title, $class );
}
/**
/**
* Common code for getLinkAttributesX functions
*/
- private function getLinkAttributesInternal( $title, $class, $classDefault = false ) {
+ private function getLinkAttributesInternal( $title, $class ) {
$title = htmlspecialchars( $title );
- if( $class === '' and $classDefault !== false ) {
- # FIXME: Parameter defaults the hard way! We should just have
- # $class = 'external' or whatever as the default in the externally-
- # exposed functions, not $class = ''.
- $class = $classDefault;
- }
$class = htmlspecialchars( $class );
$r = '';
- if( $class !== '' ) {
+ if ( $class != '' ) {
$r .= " class=\"$class\"";
}
- $r .= " title=\"$title\"";
+ if ( $title != '') {
+ $r .= " title=\"$title\"";
+ }
return $r;
}
if ( $t->isRedirect() ) {
# Page is a redirect
$colour = 'mw-redirect';
- } elseif ( $threshold > 0 && $t->getLength() < $threshold && MWNamespace::isContent( $t->getNamespace() ) ) {
+ } elseif ( $threshold > 0 &&
+ $t->exists() && $t->getLength() < $threshold &&
+ MWNamespace::isContent( $t->getNamespace() ) ) {
# Page is a stub
$colour = 'stub';
}
* 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 $query array 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 $customAttribs array A key => value array of extra HTML attri-
* butes, 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
+ * 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:
* '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.
* "stub", "mw-redirect", "extiw"). Only use the class attribute
* provided, if any, so you get a simple blue link with no funny i-
* cons.
+ * 'forcearticlepath': Use the article path always, even with a querystring.
+ * Has compatibility issues on some setups, so avoid wherever possible.
* @return string HTML <a> attribute
*/
public function link( $target, $text = null, $customAttribs = array(), $query = array(), $options = array() ) {
wfProfileIn( __METHOD__ );
- if( !($target instanceof Title) ) {
- throw new MWException( 'Linker::link passed invalid target' );
+ if( !$target instanceof Title ) {
+ return "<!-- ERROR -->$text";
}
$options = (array)$options;
- # Normalize the Title if it's a special page
- if( $target->getNamespace() == NS_SPECIAL ) {
- list( $name, $subpage ) = SpecialPage::resolveAliasWithSubpage( $target->getDBkey() );
- if( $name ) {
- $target = SpecialPage::getTitleFor( $name, $subpage );
- }
+ $ret = null;
+ if( !wfRunHooks( 'LinkBegin', array( $this, $target, &$text,
+ &$customAttribs, &$query, &$options, &$ret ) ) ) {
+ wfProfileOut( __METHOD__ );
+ return $ret;
}
+ # 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->getNamespace() == NS_SPECIAL ) {
- if( SpecialPage::exists( $target->getDbKey() ) ) {
- $options []= 'known';
- } else {
- $options []= 'broken';
- }
- } elseif( $target->isAlwaysKnown() or
- ($target->getPrefixedText() == '' and $target->getFragment() != '')
- or $target->exists() ) {
+ if( $target->isKnown() ) {
$options []= 'known';
} else {
- # Either it exists
$options []= 'broken';
}
}
+ 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, $options );
+ $text = $this->linkText( $target );
}
- $ret = Xml::openElement( 'a', $attribs )
- . $text
- . Xml::closeElement( 'a' );
+ $ret = null;
+ if( wfRunHooks( 'LinkEnd', array( $this, $target, $options, &$text, &$attribs, &$ret ) ) ) {
+ $ret = Xml::openElement( 'a', $attribs ) . $text . Xml::closeElement( 'a' );
+ }
wfProfileOut( __METHOD__ );
return $ret;
}
+ /**
+ * Identical to link(), except $options defaults to 'known'.
+ */
+ public function linkKnown( $target, $text = null, $customAttribs = array(), $query = array(), $options = 'known' ) {
+ return $this->link( $target, $text, $customAttribs, $query, $options );
+ }
+
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.
- if( in_array( 'broken', $options ) and empty( $query['action'] ) ) {
+ # 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';
}
- return $target->getLinkUrl( $query );
+ $ret = $target->getLinkUrl( $query );
+ wfProfileOut( __METHOD__ );
+ return $ret;
}
private function linkAttribs( $target, $attribs, $options ) {
+ wfProfileIn( __METHOD__ );
global $wgUser;
$defaults = array();
- # First get a default title attribute.
- if( in_array( 'known', $options ) ) {
- $defaults['title'] = $target->getPrefixedText();
- } else {
- $defaults['title'] = wfMsg( 'red-link-title', $target->getPrefixedText() );
- }
-
if( !in_array( 'noclasses', $options ) ) {
+ wfProfileIn( __METHOD__ . '-getClasses' );
# Now build the classes.
$classes = array();
}
# Note that redirects never count as stubs here.
- if ( $target->isRedirect() ) {
+ if ( !in_array( 'broken', $options ) && $target->isRedirect() ) {
$classes[] = 'mw-redirect';
} elseif( $target->isContentPage() ) {
# Check for stub.
$threshold = $wgUser->getOption( 'stubthreshold' );
- if( $threshold > 0 and $target->getLength() < $threshold ) {
+ if( $threshold > 0 and $target->exists() and $target->getLength() < $threshold ) {
$classes[] = 'stub';
}
}
if( $classes != array() ) {
$defaults['class'] = implode( ' ', $classes );
}
+ wfProfileOut( __METHOD__ . '-getClasses' );
+ }
+
+ # 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
$ret[$key] = $val;
}
}
+ wfProfileOut( __METHOD__ );
return $ret;
}
- private function linkText( $target, $options ) {
+ private function linkText( $target ) {
+ # We might be passed a non-Title by make*LinkObj(). Fail gracefully.
+ if( !$target instanceof Title ) {
+ return '';
+ }
+
# 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() !== '' ) {
}
/**
- * 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.
+ * Generate either a normal exists-style link or a stub link, depending
+ * on the given page size.
*
- * @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 $size Integer
+ * @param $nt Title object.
+ * @param $text String
+ * @param $query String
+ * @param $trail String
+ * @param $prefix String
+ * @return string HTML of 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;
+ function makeSizeLinkObj( $size, $nt, $text = '', $query = '', $trail = '', $prefix = '' ) {
+ global $wgUser;
+ $threshold = intval( $wgUser->getOption( 'stubthreshold' ) );
+ $colour = ( $size < $threshold ) ? 'stub' : '';
+ // FIXME: replace deprecated makeColouredLinkObj by link()
+ return $this->makeColouredLinkObj( $nt, $colour, $text, $query, $trail, $prefix );
}
/**
- * 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.
+ * 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 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;
+ 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}";
}
- /**
- * 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 string $title The text of the title
- * @param string $text Link text
- * @param string $query Optional query part
- * @param string $trail 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 );
+ function normaliseSpecialPage( Title $title ) {
+ if ( $title->getNamespace() == NS_SPECIAL ) {
+ list( $name, $subpage ) = SpecialPage::resolveAliasWithSubpage( $title->getDBkey() );
+ if ( !$name ) return $title;
+ $ret = SpecialPage::getTitleFor( $name, $subpage );
+ $ret->mFragment = $title->getFragment();
+ return $ret;
} else {
- wfDebug( 'Invalid title passed to Linker::makeBrokenLink(): "'.$title."\"\n" );
- return $text == '' ? $title : $text;
+ return $title;
}
}
- /**
- * @deprecated use makeColouredLinkObj
- *
- * 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 $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 = '' ) {
- $nt = Title::newFromText( $title );
- if ( $nt instanceof Title ) {
- return $this->makeStubLinkObj( $nt, $text, $query, $trail );
+ /** @todo document */
+ function fnamePart( $url ) {
+ $basename = strrchr( $url, '/' );
+ if ( false === $basename ) {
+ $basename = $url;
} else {
- wfDebug( 'Invalid title passed to Linker::makeStubLink(): "'.$title."\"\n" );
- return $text == '' ? $title : $text;
+ $basename = substr( $basename, 1 );
+ }
+ return $basename;
+ }
+
+ /** @todo document */
+ function makeExternalImage( $url, $alt = '' ) {
+ if ( '' == $alt ) {
+ $alt = $this->fnamePart( $url );
+ }
+ $img = '';
+ $success = wfRunHooks('LinkerMakeExternalImage', array( &$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);
+ return $img;
}
+ return Xml::element( 'img',
+ array(
+ 'src' => $url,
+ 'alt' => $alt ) );
}
/**
- * 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.
+ * Given parameters derived from [[Image:Foo|options...]], generate the
+ * HTML that that syntax inserts in the page.
*
- * @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.
+ * @param Title $title Title object
+ * @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
+ * manualthumb Image name to use as a thumbnail, instead of automatic scaling
+ * framed Shows image in original size in a frame
+ * frameless Downscale but don't frame
+ * upright If present, tweak default sizes for portrait orientation
+ * upright_factor Fudge factor for "upright" tweak (default 0.75)
+ * border If present, show a border around the image
+ * align Horizontal alignment (left, right, center, none)
+ * valign Vertical alignment (baseline, sub, super, top, text-top, middle,
+ * bottom, text-bottom)
+ * alt Alternate text for image (i.e. alt attribute). Plain text.
+ * caption HTML for image caption.
+ * link-url URL to link to
+ * link-title Title object to link to
+ * no-link Boolean, suppress description link
+ *
+ * @param array $handlerParams Associative array of media handler parameters, to be passed
+ * to transform(). Typical keys are "width" and "page".
+ * @param string $time, timestamp of the file, set as false for current
+ * @param string $query, query params for desc url
+ * @return string HTML for an image, with links, wrappers, etc.
*/
- function makeLinkObj( Title $nt, $text= '', $query = '', $trail = '', $prefix = '' ) {
- global $wgUser;
- wfProfileIn( __METHOD__ );
+ function makeImageLink2( Title $title, $file, $frameParams = array(), $handlerParams = array(), $time = false, $query = "" ) {
+ $res = null;
+ if( !wfRunHooks( 'ImageBeforeProduceHTML', array( &$this, &$title,
+ &$file, &$frameParams, &$handlerParams, &$time, &$res ) ) ) {
+ return $res;
+ }
- if ( $nt->isExternal() ) {
- $u = $nt->getFullURL();
- $link = $nt->getPrefixedURL();
- if ( '' == $text ) { $text = $nt->getPrefixedText(); }
- $style = $this->getInterwikiLinkAttributes( $link, $text, 'extiw' );
-
- $inside = '';
- if ( '' != $trail ) {
- $m = array();
- if ( preg_match( '/^([a-z]+)(.*)$$/sD', $trail, $m ) ) {
- $inside = $m[1];
- $trail = $m[2];
- }
- }
- $t = "<a href=\"{$u}\"{$style}>{$text}{$inside}</a>";
+ global $wgContLang, $wgUser, $wgThumbLimits, $wgThumbUpright;
+ if ( $file && !$file->allowInlineDisplay() ) {
+ wfDebug( __METHOD__.': '.$title->getPrefixedDBkey()." does not allow inline display\n" );
+ return $this->link( $title );
+ }
- wfProfileOut( __METHOD__ );
- return $t;
- } elseif ( $nt->isAlwaysKnown() ) {
- # Image links, special page links and self-links with fragments are always known.
- $retVal = $this->makeKnownLinkObj( $nt, $text, $query, $trail, $prefix );
- } else {
- wfProfileIn( __METHOD__.'-immediate' );
+ // Shortcuts
+ $fp =& $frameParams;
+ $hp =& $handlerParams;
- # Handles links to special pages which do not exist in the database:
- if( $nt->getNamespace() == NS_SPECIAL ) {
- if( SpecialPage::exists( $nt->getDBkey() ) ) {
- $retVal = $this->makeKnownLinkObj( $nt, $text, $query, $trail, $prefix );
- } else {
- $retVal = $this->makeBrokenLinkObj( $nt, $text, $query, $trail, $prefix );
- }
- wfProfileOut( __METHOD__.'-immediate' );
- wfProfileOut( __METHOD__ );
- return $retVal;
- }
+ // 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'] = '';
- # Work out link colour immediately
- $aid = $nt->getArticleID() ;
- if ( 0 == $aid ) {
- $retVal = $this->makeBrokenLinkObj( $nt, $text, $query, $trail, $prefix );
- } else {
- $colour = '';
- if ( $nt->isContentPage() ) {
- $threshold = $wgUser->getOption('stubthreshold');
- $colour = $this->getLinkColour( $nt, $threshold );
- }
- $retVal = $this->makeColouredLinkObj( $nt, $colour, $text, $query, $trail, $prefix );
- }
- wfProfileOut( __METHOD__.'-immediate' );
+ $prefix = $postfix = '';
+
+ if ( 'center' == $fp['align'] ) {
+ $prefix = '<div class="center">';
+ $postfix = '</div>';
+ $fp['align'] = 'none';
}
- wfProfileOut( __METHOD__ );
- return $retVal;
- }
+ if ( $file && !isset( $hp['width'] ) ) {
+ $hp['width'] = $file->getWidth( $page );
- /**
- * 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 $nt 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
- */
- function makeKnownLinkObj( Title $title, $text = '', $query = '', $trail = '', $prefix = '' , $aprops = '', $style = '' ) {
- wfProfileIn( __METHOD__ );
+ if( isset( $fp['thumbnail'] ) || isset( $fp['framed'] ) || isset( $fp['frameless'] ) || !$hp['width'] ) {
+ $wopt = $wgUser->getOption( 'thumbsize' );
- $nt = $this->normaliseSpecialPage( $title );
+ if( !isset( $wgThumbLimits[$wopt] ) ) {
+ $wopt = User::getDefaultOption( 'thumbsize' );
+ }
- $u = $nt->escapeLocalURL( $query );
- if ( $nt->getFragment() != '' ) {
- if( $nt->getPrefixedDbkey() == '' ) {
- $u = '';
- if ( '' == $text ) {
- $text = htmlspecialchars( $nt->getFragment() );
+ // Reduce width for upright images when parameter 'upright' is used
+ if ( isset( $fp['upright'] ) && $fp['upright'] == 0 ) {
+ $fp['upright'] = $wgThumbUpright;
+ }
+ // Use width which is smaller: real image width or user preference width
+ // 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[$wopt] * $fp['upright'], -1 ) :
+ $wgThumbLimits[$wopt];
+ if ( $hp['width'] <= 0 || $prefWidth < $hp['width'] ) {
+ $hp['width'] = $prefWidth;
}
}
- $u .= $nt->getFragmentForURL();
}
- if ( $text == '' ) {
- $text = htmlspecialchars( $nt->getPrefixedText() );
+
+ if ( isset( $fp['thumbnail'] ) || isset( $fp['manualthumb'] ) || isset( $fp['framed'] ) ) {
+ # 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
+ # to the default user option as specified in Language*.php
+ if ( $fp['align'] == '' ) {
+ $fp['align'] = $wgContLang->isRTL() ? 'left' : 'right';
+ }
+ return $prefix.$this->makeThumbLink2( $title, $file, $fp, $hp, $time, $query ).$postfix;
}
- if ( $style == '' ) {
- $style = $this->getInternalLinkAttributesObj( $nt, $text );
+
+ if ( $file && isset( $fp['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;
+ }
}
- if ( $aprops !== '' ) $aprops = " $aprops";
+ if ( $file && $hp['width'] ) {
+ # Create a resized image, without the additional thumbnail features
+ $thumb = $file->transform( $hp );
+ } else {
+ $thumb = false;
+ }
- list( $inside, $trail ) = Linker::splitTrail( $trail );
- $r = "<a href=\"{$u}\"{$style}{$aprops}>{$prefix}{$text}{$inside}</a>{$trail}";
- wfProfileOut( __METHOD__ );
- return $r;
+ if ( !$thumb ) {
+ $s = $this->makeBrokenImageLinkObj( $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 );
+ if ( !empty( $fp['link-url'] ) ) {
+ $params['custom-url-link'] = $fp['link-url'];
+ } elseif ( !empty( $fp['link-title'] ) ) {
+ $params['custom-title-link'] = $fp['link-title'];
+ } elseif ( !empty( $fp['no-link'] ) ) {
+ // No link
+ } else {
+ $params['desc-link'] = true;
+ $params['desc-query'] = $query;
+ }
+
+ $s = $thumb->toHtml( $params );
+ }
+ if ( '' != $fp['align'] ) {
+ $s = "<div class=\"float{$fp['align']}\">{$s}</div>";
+ }
+ return str_replace("\n", ' ',$prefix.$s.$postfix);
}
/**
- * Make a red link to the edit page of a given title.
- *
- * @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.
+ * Make HTML for a thumbnail including image, border and caption
+ * @param Title $title
+ * @param File $file File object or false if it doesn't exist
*/
- function makeBrokenLinkObj( Title $title, $text = '', $query = '', $trail = '', $prefix = '' ) {
- wfProfileIn( __METHOD__ );
+ function makeThumbLinkObj( Title $title, $file, $label = '', $alt, $align = 'right', $params = array(), $framed=false , $manualthumb = "" ) {
+ $frameParams = array(
+ 'alt' => $alt,
+ 'caption' => $label,
+ 'align' => $align
+ );
+ if ( $framed ) $frameParams['framed'] = true;
+ if ( $manualthumb ) $frameParams['manualthumb'] = $manualthumb;
+ return $this->makeThumbLink2( $title, $file, $frameParams, $params );
+ }
- $nt = $this->normaliseSpecialPage( $title );
+ function makeThumbLink2( Title $title, $file, $frameParams = array(), $handlerParams = array(), $time = false, $query = "" ) {
+ global $wgStylePath, $wgContLang;
+ $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'] = '';
+
+ if ( empty( $hp['width'] ) ) {
+ // Reduce width for upright images when parameter 'upright' is used
+ $hp['width'] = isset( $fp['upright'] ) ? 130 : 180;
+ }
+ $thumb = false;
- if( $nt->getNamespace() == NS_SPECIAL ) {
- $q = $query;
- } else if ( '' == $query ) {
- $q = 'action=edit&redlink=1';
+ if ( !$exists ) {
+ $outerWidth = $hp['width'] + 2;
} else {
- $q = 'action=edit&redlink=1&'.$query;
+ if ( isset( $fp['manualthumb'] ) ) {
+ # Use manually specified thumbnail
+ $manual_title = Title::makeTitleSafe( NS_FILE, $fp['manualthumb'] );
+ if( $manual_title ) {
+ $manual_img = wfFindFile( $manual_title );
+ if ( $manual_img ) {
+ $thumb = $manual_img->getUnscaledThumb();
+ } else {
+ $exists = false;
+ }
+ }
+ } elseif ( isset( $fp['framed'] ) ) {
+ // Use image dimensions, don't scale
+ $thumb = $file->getUnscaledThumb( $page );
+ } 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
+ $srcWidth = $file->getWidth( $page );
+ if ( $srcWidth && !$file->mustRender() && $hp['width'] > $srcWidth ) {
+ $hp['width'] = $srcWidth;
+ }
+ $thumb = $file->transform( $hp );
+ }
+
+ if ( $thumb ) {
+ $outerWidth = $thumb->getWidth() + 2;
+ } else {
+ $outerWidth = $hp['width'] + 2;
+ }
}
- $u = $nt->escapeLocalURL( $q );
- $titleText = $nt->getPrefixedText();
- if ( '' == $text ) {
- $text = htmlspecialchars( $titleText );
+ # 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
+ $url = $title->getLocalURL( $query );
+ if( $page ) {
+ $url = wfAppendQuery( $url, 'page=' . urlencode( $page ) );
}
- $titleAttr = wfMsg( 'red-link-title', $titleText );
- $style = $this->getInternalLinkAttributesObj( $nt, $text, 'new', $titleAttr );
- list( $inside, $trail ) = Linker::splitTrail( $trail );
- wfRunHooks( 'BrokenLink', array( &$this, $nt, $query, &$u, &$style, &$prefix, &$text, &$inside, &$trail ) );
- $s = "<a href=\"{$u}\"{$style}>{$prefix}{$text}{$inside}</a>{$trail}";
+ $more = htmlspecialchars( wfMsg( 'thumbnail-more' ) );
- wfProfileOut( __METHOD__ );
- return $s;
+ $s = "<div class=\"thumb t{$fp['align']}\"><div class=\"thumbinner\" style=\"width:{$outerWidth}px;\">";
+ if( !$exists ) {
+ $s .= $this->makeBrokenImageLinkObj( $title, '', '', '', '', $time==true );
+ $zoomicon = '';
+ } elseif ( !$thumb ) {
+ $s .= htmlspecialchars( wfMsg( 'thumbnail_error', '' ) );
+ $zoomicon = '';
+ } else {
+ $s .= $thumb->toHtml( array(
+ 'alt' => $fp['alt'],
+ 'title' => $fp['title'],
+ 'img-class' => 'thumbimage',
+ 'desc-link' => true,
+ 'desc-query' => $query ) );
+ if ( isset( $fp['framed'] ) ) {
+ $zoomicon="";
+ } else {
+ $zoomicon = '<div class="magnify">'.
+ '<a href="'.$url.'" class="internal" title="'.$more.'">'.
+ '<img src="'.$wgStylePath.'/common/images/magnify-clip.png" ' .
+ 'width="15" height="11" alt="" /></a></div>';
+ }
+ }
+ $s .= ' <div class="thumbcaption">'.$zoomicon.$fp['caption']."</div></div></div>";
+ return str_replace("\n", ' ', $s);
}
/**
- * @deprecated use makeColouredLinkObj
- *
- * Make a brown link to a short article.
+ * Make a "broken" link to an image
*
- * @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 Title $title Image title
+ * @param string $text Link label
+ * @param string $query Query string
+ * @param string $trail Link trail
+ * @param string $prefix Link prefix
+ * @param bool $time, a file of a certain timestamp was requested
+ * @return string
*/
- function makeStubLinkObj( $nt, $text = '', $query = '', $trail = '', $prefix = '' ) {
- wfDeprecated( __METHOD__ );
- return $this->makeColouredLinkObj( $nt, 'stub', $text, $query, $trail, $prefix );
+ public function makeBrokenImageLinkObj( $title, $text = '', $query = '', $trail = '', $prefix = '', $time = false ) {
+ global $wgEnableUploads;
+ if( $title instanceof Title ) {
+ wfProfileIn( __METHOD__ );
+ $currentExists = $time ? ( wfFindFile( $title ) != false ) : false;
+ if( $wgEnableUploads && !$currentExists ) {
+ $upload = SpecialPage::getTitleFor( 'Upload' );
+ if( $text == '' )
+ $text = htmlspecialchars( $title->getPrefixedText() );
+ $redir = RepoGroup::singleton()->getLocalRepo()->checkRedirect( $title );
+ if( $redir ) {
+ return $this->makeKnownLinkObj( $title, $text, $query, $trail, $prefix );
+ }
+ $q = 'wpDestFile=' . $title->getPartialUrl();
+ if( $query != '' )
+ $q .= '&' . $query;
+ list( $inside, $trail ) = self::splitTrail( $trail );
+ $style = $this->getInternalLinkAttributesObj( $title, $text, 'new' );
+ wfProfileOut( __METHOD__ );
+ return '<a href="' . $upload->escapeLocalUrl( $q ) . '"'
+ . $style . '>' . $prefix . $text . $inside . '</a>' . $trail;
+ } else {
+ wfProfileOut( __METHOD__ );
+ return $this->makeKnownLinkObj( $title, $text, $query, $trail, $prefix );
+ }
+ } else {
+ return "<!-- ERROR -->{$prefix}{$text}{$trail}";
+ }
}
/**
- * Make a coloured link.
+ * Create a direct link to a given uploaded file.
*
- * @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.
- */
- function makeColouredLinkObj( $nt, $colour, $text = '', $query = '', $trail = '', $prefix = '' ) {
- if($colour != ''){
- $style = $this->getInternalLinkAttributesObj( $nt, $text, $colour );
- } else $style = '';
- return $this->makeKnownLinkObj( $nt, $text, $query, $trail, $prefix, '', $style );
- }
-
- /**
- * Generate either a normal exists-style link or a stub link, depending
- * on the given page size.
+ * @param $title Title object.
+ * @param $text String: pre-sanitized HTML
+ * @param $time string: time image was created
+ * @return string HTML
*
- * @param $size Integer
- * @param $nt Title object.
- * @param $text String
- * @param $query String
- * @param $trail String
- * @param $prefix String
- * @return string HTML of link
+ * @public
+ * @todo Handle invalid or missing images better.
*/
- function makeSizeLinkObj( $size, $nt, $text = '', $query = '', $trail = '', $prefix = '' ) {
- global $wgUser;
- $threshold = intval( $wgUser->getOption( 'stubthreshold' ) );
- $colour = ( $size < $threshold ) ? 'stub' : '';
- 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() );
- if ( !$name ) return $title;
- return SpecialPage::getTitleFor( $name, $subpage );
+ function makeMediaLinkObj( $title, $text = '', $time = false ) {
+ if( is_null( $title ) ) {
+ ### HOTFIX. Instead of breaking, return empty string.
+ return $text;
} else {
- return $title;
+ $img = wfFindFile( $title, $time );
+ if( $img ) {
+ $url = $img->getURL();
+ $class = 'internal';
+ } else {
+ $upload = SpecialPage::getTitleFor( 'Upload' );
+ $url = $upload->getLocalUrl( 'wpDestFile=' . urlencode( $title->getDBkey() ) );
+ $class = 'new';
+ }
+ $alt = htmlspecialchars( $title->getText() );
+ if( $text == '' ) {
+ $text = $alt;
+ }
+ $u = htmlspecialchars( $url );
+ return "<a href=\"{$u}\" class=\"$class\" title=\"{$alt}\">{$text}</a>";
}
}
/** @todo document */
- function fnamePart( $url ) {
- $basename = strrchr( $url, '/' );
- if ( false === $basename ) {
- $basename = $url;
- } else {
- $basename = substr( $basename, 1 );
- }
- return $basename;
- }
+ function specialLink( $name, $key = '' ) {
+ global $wgContLang;
- /** Obsolete alias */
- function makeImage( $url, $alt = '' ) {
- wfDeprecated( __METHOD__ );
- return $this->makeExternalImage( $url, $alt );
+ if ( '' == $key ) { $key = strtolower( $name ); }
+ $pn = $wgContLang->ucfirst( $name );
+ return $this->makeKnownLink( $wgContLang->specialPage( $pn ),
+ wfMsg( $key ) );
}
- /** @todo document */
- function makeExternalImage( $url, $alt = '' ) {
- if ( '' == $alt ) {
- $alt = $this->fnamePart( $url );
+ /**
+ * Make an external link
+ * @param String $url URL to link to
+ * @param String $text text of link
+ * @param boolean $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>
+ *
+ * @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.
+ */
+ function makeExternalLink( $url, $text, $escape = true, $linktype = '', $attribs = array() ) {
+ $attribsText = $this->getExternalLinkAttributes( 'external ' . $linktype );
+ $url = htmlspecialchars( $url );
+ if( $escape ) {
+ $text = htmlspecialchars( $text );
}
- $img = '';
- $success = wfRunHooks('LinkerMakeExternalImage', array( &$url, &$alt, &$img ) );
+ $link = '';
+ $success = wfRunHooks('LinkerMakeExternalLink', array( &$url, &$text, &$link, &$attribs, $linktype ) );
if(!$success) {
- wfDebug("Hook LinkerMakeExternalImage changed the output of external image with url {$url} and alt text {$alt} to {$img}", true);
- return $img;
+ wfDebug("Hook LinkerMakeExternalLink changed the output of link with url {$url} and text {$text} to {$link}\n", true);
+ return $link;
}
- return Xml::element( 'img',
- array(
- 'src' => $url,
- 'alt' => $alt ) );
+ if ( $attribs ) {
+ $attribsText .= Xml::expandAttributes( $attribs );
+ }
+ return '<a href="'.$url.'"'.$attribsText.'>'.$text.'</a>';
}
/**
- * Creates the HTML source for images
- * @deprecated use makeImageLink2
- *
- * @param object $title
- * @param string $label label text
- * @param string $alt alt text
- * @param string $align horizontal alignment: none, left, center, right)
- * @param array $handlerParams Parameters to be passed to the media handler
- * @param boolean $framed shows image in original size in a frame
- * @param boolean $thumb shows image as thumbnail in a frame
- * @param string $manualthumb image name for the manual thumbnail
- * @param string $valign vertical alignment: baseline, sub, super, top, text-top, middle, bottom, text-bottom
- * @param string $time, timestamp of the file, set as false for current
- * @return string
+ * 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 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;
+ function userLink( $userId, $userText ) {
+ if( $userId == 0 ) {
+ $page = SpecialPage::getTitleFor( 'Contributions', $userText );
+ } else {
+ $page = Title::makeTitle( NS_USER, $userText );
}
- $file = wfFindFile( $title, $time );
- return $this->makeImageLink2( $title, $file, $frameParams, $handlerParams, $time );
+ return $this->link( $page, htmlspecialchars( $userText ), array( 'class' => 'mw-userlink' ) );
}
/**
- * Given parameters derived from [[Image:Foo|options...]], generate the
- * HTML that that syntax inserts in the page.
- *
- * @param Title $title Title object
- * @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
- * manualthumb Image name to use as a thumbnail, instead of automatic scaling
- * framed Shows image in original size in a frame
- * frameless Downscale but don't frame
- * upright If present, tweak default sizes for portrait orientation
- * upright_factor Fudge factor for "upright" tweak (default 0.75)
- * border If present, show a border around the image
- * align Horizontal alignment (left, right, center, none)
- * valign Vertical alignment (baseline, sub, super, top, text-top, middle,
- * bottom, text-bottom)
- * alt Alternate text for image (i.e. alt attribute). Plain text.
- * caption HTML for image caption.
+ * Generate standard user tool links (talk, contributions, block link, etc.)
*
- * @param array $handlerParams Associative array of media handler parameters, to be passed
- * to transform(). Typical keys are "width" and "page".
- * @param string $time, timestamp of the file, set as false for current
- * @param string $query, query params for desc url
- * @return string HTML for an image, with links, wrappers, etc.
+ * @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. self::TOOL_LINKS_NOBLOCK)
+ * @param int $edits, user edit count (optional, for performance)
+ * @return string
*/
- function makeImageLink2( Title $title, $file, $frameParams = array(), $handlerParams = array(), $time = false, $query = "" ) {
- $res = null;
- if( !wfRunHooks( 'ImageBeforeProduceHTML', array( &$this, &$title,
- &$file, &$frameParams, &$handlerParams, &$time, &$res ) ) ) {
- return $res;
- }
-
- global $wgContLang, $wgUser, $wgThumbLimits, $wgThumbUpright;
- if ( $file && !$file->allowInlineDisplay() ) {
- wfDebug( __METHOD__.': '.$title->getPrefixedDBkey()." does not allow inline display\n" );
- return $this->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'] = '';
-
- $prefix = $postfix = '';
+ public function userToolLinks( $userId, $userText, $redContribsWhenNoEdits = false, $flags = 0, $edits=null ) {
+ global $wgUser, $wgDisableAnonTalk, $wgSysopUserBans, $wgLang;
+ $talkable = !( $wgDisableAnonTalk && 0 == $userId );
+ $blockable = ( $wgSysopUserBans || 0 == $userId ) && !$flags & self::TOOL_LINKS_NOBLOCK;
- if ( 'center' == $fp['align'] )
- {
- $prefix = '<div class="center">';
- $postfix = '</div>';
- $fp['align'] = 'none';
+ $items = array();
+ if( $talkable ) {
+ $items[] = $this->userTalkLink( $userId, $userText );
}
- if ( $file && !isset( $hp['width'] ) ) {
- $hp['width'] = $file->getWidth( $page );
-
- if( isset( $fp['thumbnail'] ) || isset( $fp['framed'] ) || isset( $fp['frameless'] ) || !$hp['width'] ) {
- $wopt = $wgUser->getOption( 'thumbsize' );
-
- if( !isset( $wgThumbLimits[$wopt] ) ) {
- $wopt = User::getDefaultOption( 'thumbsize' );
- }
-
- // Reduce width for upright images when parameter 'upright' is used
- if ( isset( $fp['upright'] ) && $fp['upright'] == 0 ) {
- $fp['upright'] = $wgThumbUpright;
- }
- // Use width which is smaller: real image width or user preference width
- // 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[$wopt] * $fp['upright'], -1 ) :
- $wgThumbLimits[$wopt];
- if ( $hp['width'] <= 0 || $prefWidth < $hp['width'] ) {
- $hp['width'] = $prefWidth;
+ if( $userId ) {
+ // check if the user has an edit
+ $attribs = array();
+ if( $redContribsWhenNoEdits ) {
+ $count = !is_null($edits) ? $edits : User::edits( $userId );
+ if( $count == 0 ) {
+ $attribs['class'] = 'new';
}
}
- }
-
- if ( isset( $fp['thumbnail'] ) || isset( $fp['manualthumb'] ) || isset( $fp['framed'] ) ) {
+ $contribsPage = SpecialPage::getTitleFor( 'Contributions', $userText );
- # 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
- # to the default user option as specified in Language*.php
- if ( $fp['align'] == '' ) {
- $fp['align'] = $wgContLang->isRTL() ? 'left' : 'right';
- }
- return $prefix.$this->makeThumbLink2( $title, $file, $fp, $hp, $time, $query ).$postfix;
+ $items[] = $this->link( $contribsPage, wfMsgHtml( 'contribslink' ), $attribs );
}
-
- if ( $file && isset( $fp['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;
- }
+ if( $blockable && $wgUser->isAllowed( 'block' ) ) {
+ $items[] = $this->blockLink( $userId, $userText );
}
- if ( $file && $hp['width'] ) {
- # Create a resized image, without the additional thumbnail features
- $thumb = $file->transform( $hp );
+ if( $items ) {
+ return ' <span class="mw-usertoollinks">(' . $wgLang->pipeList( $items ) . ')</span>';
} else {
- $thumb = false;
+ return '';
}
+ }
- if ( !$thumb ) {
- $s = $this->makeBrokenImageLinkObj( $title, '', '', '', '', $time==true );
+ /**
+ * Alias for userToolLinks( $userId, $userText, true );
+ * @param int $userId User identifier
+ * @param string $userText User name or IP address
+ * @param int $edits, user edit count (optional, for performance)
+ */
+ public function userToolLinksRedContribs( $userId, $userText, $edits=null ) {
+ return $this->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
+ */
+ function userTalkLink( $userId, $userText ) {
+ $userTalkPage = Title::makeTitle( NS_USER_TALK, $userText );
+ $userTalkLink = $this->link( $userTalkPage, wfMsgHtml( 'talkpagelinktext' ) );
+ return $userTalkLink;
+ }
+
+ /**
+ * @param $userId Integer: userid
+ * @param $userText String: user name in database.
+ * @return string HTML fragment with block link
+ * @private
+ */
+ function blockLink( $userId, $userText ) {
+ $blockPage = SpecialPage::getTitleFor( 'Blockip', $userText );
+ $blockLink = $this->link( $blockPage, wfMsgHtml( 'blocklink' ) );
+ return $blockLink;
+ }
+
+ /**
+ * Generate a user link if the current user is allowed to view it
+ * @param $rev Revision object.
+ * @param $isPublic, bool, show only if all users can see it
+ * @return string HTML
+ */
+ 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 ),
+ $rev->getUserText( Revision::FOR_THIS_USER ) );
} else {
- $s = $thumb->toHtml( array(
- 'desc-link' => true,
- 'desc-query' => $query,
- 'alt' => $fp['alt'],
- 'valign' => isset( $fp['valign'] ) ? $fp['valign'] : false ,
- 'img-class' => isset( $fp['border'] ) ? 'thumbborder' : false ) );
+ $link = wfMsgHtml( 'rev-deleted-user' );
}
- if ( '' != $fp['align'] ) {
- $s = "<div class=\"float{$fp['align']}\"><span>{$s}</span></div>";
+ if( $rev->isDeleted( Revision::DELETED_USER ) ) {
+ return '<span class="history-deleted">' . $link . '</span>';
}
- return str_replace("\n", ' ',$prefix.$s.$postfix);
+ return $link;
}
/**
- * Make HTML for a thumbnail including image, border and caption
- * @param Title $title
- * @param File $file File object or false if it doesn't exist
+ * Generate a user tool link cluster if the current user is allowed to view it
+ * @param $rev Revision object.
+ * @param $isPublic, bool, show only if all users can see it
+ * @return string HTML
*/
- function makeThumbLinkObj( Title $title, $file, $label = '', $alt, $align = 'right', $params = array(), $framed=false , $manualthumb = "" ) {
- $frameParams = array(
- 'alt' => $alt,
- 'caption' => $label,
- 'align' => $align
- );
- if ( $framed ) $frameParams['framed'] = true;
- if ( $manualthumb ) $frameParams['manualthumb'] = $manualthumb;
- return $this->makeThumbLink2( $title, $file, $frameParams, $params );
+ function revUserTools( $rev, $isPublic = false ) {
+ if( $rev->isDeleted( Revision::DELETED_USER ) && $isPublic ) {
+ $link = wfMsgHtml( 'rev-deleted-user' );
+ } else if( $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 );
+ } else {
+ $link = wfMsgHtml( 'rev-deleted-user' );
+ }
+ if( $rev->isDeleted( Revision::DELETED_USER ) ) {
+ return ' <span class="history-deleted">' . $link . '</span>';
+ }
+ return $link;
}
- function makeThumbLink2( Title $title, $file, $frameParams = array(), $handlerParams = array(), $time = false, $query = "" ) {
- global $wgStylePath, $wgContLang;
- $exists = $file && $file->exists();
+ /**
+ * 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
+ * auto-generated comments (from section editing) and formats [[wikilinks]].
+ *
+ * @author Erik Moeller <moeller@scireview.de>
+ *
+ * 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 string $comment
+ * @param mixed $title Title object (to generate link to the section in autocomment) or null
+ * @param bool $local Whether section links should refer to local page
+ */
+ function formatComment($comment, $title = NULL, $local = false) {
+ wfProfileIn( __METHOD__ );
- # Shortcuts
- $fp =& $frameParams;
- $hp =& $handlerParams;
+ # Sanitize text a bit:
+ $comment = str_replace( "\n", " ", $comment );
+ # Allow HTML entities (for bug 13815)
+ $comment = Sanitizer::escapeHtmlAllowEntities( $comment );
- $page = isset( $hp['page'] ) ? $hp['page'] : false;
- if ( !isset( $fp['align'] ) ) $fp['align'] = 'right';
- if ( !isset( $fp['alt'] ) ) $fp['alt'] = '';
- if ( !isset( $fp['caption'] ) ) $fp['caption'] = '';
+ # Render autocomments and make links:
+ $comment = $this->formatAutoComments( $comment, $title, $local );
+ $comment = $this->formatLinksInComment( $comment );
- if ( empty( $hp['width'] ) ) {
- // Reduce width for upright images when parameter 'upright' is used
- $hp['width'] = isset( $fp['upright'] ) ? 130 : 180;
- }
- $thumb = false;
+ wfProfileOut( __METHOD__ );
+ return $comment;
+ }
- if ( !$exists ) {
- $outerWidth = $hp['width'] + 2;
- } else {
- if ( isset( $fp['manualthumb'] ) ) {
- # Use manually specified thumbnail
- $manual_title = Title::makeTitleSafe( NS_IMAGE, $fp['manualthumb'] );
- if( $manual_title ) {
- $manual_img = wfFindFile( $manual_title );
- if ( $manual_img ) {
- $thumb = $manual_img->getUnscaledThumb();
- } else {
- $exists = false;
- }
- }
- } elseif ( isset( $fp['framed'] ) ) {
- // Use image dimensions, don't scale
- $thumb = $file->getUnscaledThumb( $page );
+ /**
+ * 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 string $comment Comment text
+ * @param object $title An optional title object used to links to sections
+ * @return string $comment formatted comment
+ *
+ * @todo Document the $local parameter.
+ */
+ private function formatAutocomments( $comment, $title = null, $local = false ) {
+ // Bah!
+ $this->autocommentTitle = $title;
+ $this->autocommentLocal = $local;
+ $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;
+
+ # Generate a valid anchor name from the section title.
+ # Hackish, but should generally work - we strip wiki
+ # syntax, including the magic [[: that is used to
+ # "link rather than show" in case of images and
+ # interlanguage links.
+ $section = str_replace( '[[:', '', $section );
+ $section = str_replace( '[[', '', $section );
+ $section = str_replace( ']]', '', $section );
+ if ( $local ) {
+ $sectionTitle = Title::newFromText( '#' . $section );
} 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
- $srcWidth = $file->getWidth( $page );
- if ( $srcWidth && !$file->mustRender() && $hp['width'] > $srcWidth ) {
- $hp['width'] = $srcWidth;
- }
- $thumb = $file->transform( $hp );
+ $sectionTitle = Title::makeTitleSafe( $title->getNamespace(),
+ $title->getDBkey(), $section );
}
-
- if ( $thumb ) {
- $outerWidth = $thumb->getWidth() + 2;
+ if ( $sectionTitle ) {
+ $link = $this->link( $sectionTitle,
+ htmlspecialchars( wfMsgForContent( 'sectionlink' ) ), array(), array(),
+ 'noclasses' );
} else {
- $outerWidth = $hp['width'] + 2;
+ $link = '';
}
}
-
- if( $page ) {
- $query = $query ? '&page=' . urlencode( $page ) : 'page=' . urlencode( $page );
+ $auto = "$link$auto";
+ if( $pre ) {
+ # written summary $presep autocomment (summary /* section */)
+ $auto = wfMsgExt( 'autocomment-prefix', array( 'escapenoentities', 'content' ) ) . $auto;
}
- $url = $title->getLocalURL( $query );
+ 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;
+ }
- $more = htmlspecialchars( wfMsg( 'thumbnail-more' ) );
+ /**
+ * Formats wiki links and media links in text; all other wiki formatting
+ * is ignored
+ *
+ * @fixme doesn't handle sub-links as in image thumb texts like the main parser
+ * @param string $comment Text to format links in
+ * @return string
+ */
+ public function formatLinksInComment( $comment ) {
+ return preg_replace_callback(
+ '/\[\[:?(.*?)(\|(.*?))*\]\]([^[]*)/',
+ array( $this, 'formatLinksInCommentCallback' ),
+ $comment );
+ }
- $s = "<div class=\"thumb t{$fp['align']}\"><div class=\"thumbinner\" style=\"width:{$outerWidth}px;\">";
- if( !$exists ) {
- $s .= $this->makeBrokenImageLinkObj( $title, '', '', '', '', $time==true );
- $zoomicon = '';
- } elseif ( !$thumb ) {
- $s .= htmlspecialchars( wfMsg( 'thumbnail_error', '' ) );
- $zoomicon = '';
+ protected function formatLinksInCommentCallback( $match ) {
+ 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] = str_replace( array('<', '>'), array('<', '>'), urldecode($match[1]) );
+ }
+
+ # Handle link renaming [[foo|text]] will show link as "text"
+ if( "" != $match[3] ) {
+ $text = $match[3];
+ } else {
+ $text = $match[1];
+ }
+ $submatch = array();
+ 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 );
} else {
- $s .= $thumb->toHtml( array(
- 'alt' => $fp['alt'],
- 'img-class' => 'thumbimage',
- 'desc-link' => true,
- 'desc-query' => $query ) );
- if ( isset( $fp['framed'] ) ) {
- $zoomicon="";
+ # Other kind of link
+ if( preg_match( $wgContLang->linkTrail(), $match[4], $submatch ) ) {
+ $trail = $submatch[1];
} else {
- $zoomicon = '<div class="magnify">'.
- '<a href="'.$url.'" class="internal" title="'.$more.'">'.
- '<img src="'.$wgStylePath.'/common/images/magnify-clip.png" ' .
- 'width="15" height="11" alt="" /></a></div>';
+ $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 );
+ $thelink = $this->link(
+ Title::newFromText( $match[1] ),
+ $text . $inside
+ ) . $trail;
}
- $s .= ' <div class="thumbcaption">'.$zoomicon.$fp['caption']."</div></div></div>";
- return str_replace("\n", ' ', $s);
+ $comment = preg_replace( $linkRegexp, StringUtils::escapeRegexReplacement( $thelink ), $comment, 1 );
+
+ return $comment;
}
/**
- * Make a "broken" link to an image
+ * Wrap a comment in standard punctuation and formatting if
+ * it's non-empty, otherwise return empty string.
+ *
+ * @param string $comment
+ * @param mixed $title Title object (to generate link to section in autocomment) or null
+ * @param bool $local Whether section links should refer to local page
*
- * @param Title $title Image title
- * @param string $text Link label
- * @param string $query Query string
- * @param string $trail Link trail
- * @param string $prefix Link prefix
- * @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;
- if( $title instanceof Title ) {
- wfProfileIn( __METHOD__ );
- $currentExists = $time ? ( wfFindFile( $title ) != false ) : false;
- if( $wgEnableUploads && !$currentExists ) {
- $upload = SpecialPage::getTitleFor( 'Upload' );
- if( $text == '' )
- $text = htmlspecialchars( $title->getPrefixedText() );
- $redir = RepoGroup::singleton()->getLocalRepo()->checkRedirect( $title );
- if( $redir ) {
- return $this->makeKnownLinkObj( $title, $text, $query, $trail, $prefix );
- }
- $q = 'wpDestFile=' . $title->getPartialUrl();
- if( $query != '' )
- $q .= '&' . $query;
- list( $inside, $trail ) = self::splitTrail( $trail );
- $style = $this->getInternalLinkAttributesObj( $title, $text, 'new' );
- wfProfileOut( __METHOD__ );
- return '<a href="' . $upload->escapeLocalUrl( $q ) . '"'
- . $style . '>' . $prefix . $text . $inside . '</a>' . $trail;
- } else {
- wfProfileOut( __METHOD__ );
- return $this->makeKnownLinkObj( $title, $text, $query, $trail, $prefix );
- }
+ function commentBlock( $comment, $title = NULL, $local = false ) {
+ // '*' 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
+ if( $comment == '' || $comment == '*' ) {
+ return '';
} else {
- return "<!-- ERROR -->{$prefix}{$text}{$trail}";
+ $formatted = $this->formatComment( $comment, $title, $local );
+ return " <span class=\"comment\">($formatted)</span>";
}
}
- /** @deprecated use Linker::makeMediaLinkObj() */
- function makeMediaLink( $name, $unused = '', $text = '', $time = false ) {
- $nt = Title::makeTitleSafe( NS_IMAGE, $name );
- return $this->makeMediaLinkObj( $nt, $text, $time );
- }
-
/**
- * Create a direct link to a given uploaded file.
+ * Wrap and format the given revision's comment block, if the current
+ * user is allowed to view it.
*
- * @param $title Title object.
- * @param $text String: pre-sanitized HTML
- * @param $time string: time image was created
+ * @param Revision $rev
+ * @param bool $local Whether section links should refer to local page
+ * @param $isPublic, show only if all users can see it
* @return string HTML
- *
- * @public
- * @todo Handle invalid or missing images better.
*/
- function makeMediaLinkObj( $title, $text = '', $time = false ) {
- if( is_null( $title ) ) {
- ### HOTFIX. Instead of breaking, return empty string.
- return $text;
+ function revComment( Revision $rev, $local = false, $isPublic = false ) {
+ if( $rev->getRawComment() == "" ) 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 ),
+ $rev->getTitle(), $local );
} else {
- $img = wfFindFile( $title, $time );
- if( $img ) {
- $url = $img->getURL();
- $class = 'internal';
- } else {
- $upload = SpecialPage::getTitleFor( 'Upload' );
- $url = $upload->getLocalUrl( 'wpDestFile=' . urlencode( $title->getDBkey() ) );
- $class = 'new';
- }
- $alt = htmlspecialchars( $title->getText() );
- if( $text == '' ) {
- $text = $alt;
- }
- $u = htmlspecialchars( $url );
- return "<a href=\"{$u}\" class=\"$class\" title=\"{$alt}\">{$text}</a>";
+ $block = " <span class=\"comment\">" . wfMsgHtml( 'rev-deleted-comment' ) . "</span>";
}
+ if( $rev->isDeleted( Revision::DELETED_COMMENT ) ) {
+ return " <span class=\"history-deleted\">$block</span>";
+ }
+ return $block;
}
- /** @todo document */
- function specialLink( $name, $key = '' ) {
- global $wgContLang;
+ public function formatRevisionSize( $size ) {
+ if ( $size == 0 ) {
+ $stxt = wfMsgExt( 'historyempty', 'parsemag' );
+ } else {
+ global $wgLang;
+ $stxt = wfMsgExt( 'nbytes', 'parsemag', $wgLang->formatNum( $size ) );
+ $stxt = "($stxt)";
+ }
+ $stxt = htmlspecialchars( $stxt );
+ return "<span class=\"history-size\">$stxt</span>";
+ }
- if ( '' == $key ) { $key = strtolower( $name ); }
- $pn = $wgContLang->ucfirst( $name );
- return $this->makeKnownLink( $wgContLang->specialPage( $pn ),
- wfMsg( $key ) );
+ /** @todo document */
+ function tocIndent() {
+ return "\n<ul>";
}
/** @todo document */
- function makeExternalLink( $url, $text, $escape = true, $linktype = '', $ns = null ) {
- $style = $this->getExternalLinkAttributes( $url, $text, 'external ' . $linktype );
- global $wgNoFollowLinks, $wgNoFollowNsExceptions;
- if( $wgNoFollowLinks && !(isset($ns) && in_array($ns, $wgNoFollowNsExceptions)) ) {
- $style .= ' rel="nofollow"';
- }
- $url = htmlspecialchars( $url );
- if( $escape ) {
- $text = htmlspecialchars( $text );
- }
- $link = '';
- $success = wfRunHooks('LinkerMakeExternalLink', array( &$url, &$text, &$link ) );
- if(!$success) {
- wfDebug("Hook LinkerMakeExternalLink changed the output of link with url {$url} and text {$text} to {$link}", true);
- return $link;
- }
- return '<a href="'.$url.'"'.$style.'>'.$text.'</a>';
+ function tocUnindent($level) {
+ return "</li>\n" . str_repeat( "</ul>\n</li>\n", $level>0 ? $level : 0 );
}
/**
- * 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
+ * parameter level defines if we are on an indentation level
*/
- function userLink( $userId, $userText ) {
- if( $userId == 0 ) {
- $page = SpecialPage::getTitleFor( 'Contributions', $userText );
- } else {
- $page = Title::makeTitle( NS_USER, $userText );
- }
- return $this->link( $page, htmlspecialchars( $userText ) );
+ function tocLine( $anchor, $tocline, $tocnumber, $level, $sectionIndex = false ) {
+ $classes = "toclevel-$level";
+ 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>';
}
+ /** @todo document */
+ function tocLineEnd() {
+ return "</li>\n";
+ }
+
+ /** @todo document */
+ function tocList($toc) {
+ global $wgJsMimeType;
+ $title = wfMsgHtml('toc') ;
+ return
+ '<table id="toc" class="toc" summary="' . $title .'"><tr><td>'
+ . '<div id="toctitle"><h2>' . $title . "</h2></div>\n"
+ . $toc
+ # no trailing newline, script should not be wrapped in a
+ # paragraph
+ . "</ul>\n</td></tr></table>"
+ . '<script type="' . $wgJsMimeType . '">'
+ . ' if (window.showTocToggle) {'
+ . ' var tocShowText = "' . Xml::escapeJsString( wfMsg('showtoc') ) . '";'
+ . ' var tocHideText = "' . Xml::escapeJsString( wfMsg('hidetoc') ) . '";'
+ . ' showTocToggle();'
+ . ' } '
+ . "</script>\n";
+ }
+
/**
- * Generate standard user tool links (talk, contributions, block link, etc.)
- *
- * @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. self::TOOL_LINKS_NOBLOCK)
- * @param int $edits, user edit count (optional, for performance)
- * @return string
+ * Generate a table of contents from a section tree
+ * @param $tree Return value of ParserOutput::getSections()
+ * @return string HTML
*/
- public function userToolLinks( $userId, $userText, $redContribsWhenNoEdits = false, $flags = 0, $edits=null ) {
- global $wgUser, $wgDisableAnonTalk, $wgSysopUserBans;
- $talkable = !( $wgDisableAnonTalk && 0 == $userId );
- $blockable = ( $wgSysopUserBans || 0 == $userId ) && !$flags & self::TOOL_LINKS_NOBLOCK;
+ public function generateTOC( $tree ) {
+ $toc = '';
+ $lastLevel = 0;
+ foreach ( $tree as $section ) {
+ if ( $section['toclevel'] > $lastLevel )
+ $toc .= $this->tocIndent();
+ else if ( $section['toclevel'] < $lastLevel )
+ $toc .= $this->tocUnindent(
+ $lastLevel - $section['toclevel'] );
+ else
+ $toc .= $this->tocLineEnd();
+
+ $toc .= $this->tocLine( $section['anchor'],
+ $section['line'], $section['number'],
+ $section['toclevel'], $section['index'] );
+ $lastLevel = $section['toclevel'];
+ }
+ $toc .= $this->tocLineEnd();
+ return $this->tocList( $toc );
+ }
- $items = array();
- if( $talkable ) {
- $items[] = $this->userTalkLink( $userId, $userText );
+ /**
+ * 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
+ * @return string HTML to use for edit link
+ */
+ public function doEditSectionLink( Title $nt, $section, $tooltip = null ) {
+ $attribs = array();
+ if( !is_null( $tooltip ) ) {
+ $attribs['title'] = wfMsg( 'editsectionhint', $tooltip );
}
- if( $userId ) {
- // check if the user has an edit
- $attribs = array();
- if( $redContribsWhenNoEdits ) {
- $count = !is_null($edits) ? $edits : User::edits( $userId );
- if( $count == 0 ) {
- $attribs['class'] = 'new';
- }
- }
- $contribsPage = SpecialPage::getTitleFor( 'Contributions', $userText );
+ $link = $this->link( $nt, wfMsg('editsection'),
+ $attribs,
+ array( 'action' => 'edit', 'section' => $section ),
+ array( 'noclasses', 'known' )
+ );
- $items[] = $this->link( $contribsPage, wfMsgHtml( 'contribslink' ), $attribs );
+ # Run the old hook. This takes up half of the function . . . hopefully
+ # we can rid of it someday.
+ $attribs = '';
+ if( $tooltip ) {
+ $attribs = wfMsgHtml( 'editsectionhint', htmlspecialchars( $tooltip ) );
+ $attribs = " title=\"$attribs\"";
}
- if( $blockable && $wgUser->isAllowed( 'block' ) ) {
- $items[] = $this->blockLink( $userId, $userText );
+ $result = null;
+ wfRunHooks( 'EditSectionLink', array( &$this, $nt, $section, $attribs, $link, &$result ) );
+ 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 = wfMsgHtml( 'editsection-brackets', $result );
+ return "<span class=\"editsection\">$result</span>";
}
- if( $items ) {
- return ' (' . implode( ' | ', $items ) . ')';
- } else {
- return '';
- }
- }
+ # Add the brackets and the span, and *then* run the nice new hook, with
+ # clean and non-redundant arguments.
+ $result = wfMsgHtml( 'editsection-brackets', $link );
+ $result = "<span class=\"editsection\">$result</span>";
- /**
- * Alias for userToolLinks( $userId, $userText, true );
- * @param int $userId User identifier
- * @param string $userText User name or IP address
- * @param int $edits, user edit count (optional, for performance)
- */
- public function userToolLinksRedContribs( $userId, $userText, $edits=null ) {
- return $this->userToolLinks( $userId, $userText, true, 0, $edits );
+ wfRunHooks( 'DoEditSectionLink', array( $this, $nt, $section, $tooltip, &$result ) );
+ return $result;
}
-
/**
- * @param $userId Integer: user id in database.
- * @param $userText String: user name in database.
- * @return string HTML fragment with user talk link
- * @private
+ * Create a headline for content
+ *
+ * @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 $text The text of the header
+ * @param string $link HTML to add for the section edit link
+ * @param mixed $legacyAnchor A second, optional anchor to give for
+ * backward compatibility (false to omit)
+ *
+ * @return string HTML headline
*/
- function userTalkLink( $userId, $userText ) {
- $userTalkPage = Title::makeTitle( NS_USER_TALK, $userText );
- $userTalkLink = $this->link( $userTalkPage, wfMsgHtml( 'talkpagelinktext' ) );
- return $userTalkLink;
+ public function makeHeadline( $level, $attribs, $anchor, $text, $link, $legacyAnchor = false ) {
+ $ret = "<h$level id=\"$anchor\"$attribs"
+ . $link
+ . " <span class=\"mw-headline\">$text</span>"
+ . "</h$level>";
+ if ( $legacyAnchor !== false ) {
+ $ret = "<a id=\"$legacyAnchor\"></a>$ret";
+ }
+ return $ret;
}
/**
- * @param $userId Integer: userid
- * @param $userText String: user name in database.
- * @return string HTML fragment with block link
- * @private
+ * Split a link trail, return the "inside" portion and the remainder of the trail
+ * as a two-element array
+ *
+ * @static
*/
- function blockLink( $userId, $userText ) {
- $blockPage = SpecialPage::getTitleFor( 'Blockip', $userText );
- $blockLink = $this->link( $blockPage, wfMsgHtml( 'blocklink' ) );
- return $blockLink;
+ static function splitTrail( $trail ) {
+ static $regex = false;
+ if ( $regex === false ) {
+ global $wgContLang;
+ $regex = $wgContLang->linkTrail();
+ }
+ $inside = '';
+ if ( '' != $trail ) {
+ $m = array();
+ if ( preg_match( $regex, $trail, $m ) ) {
+ $inside = $m[1];
+ $trail = $m[2];
+ }
+ }
+ return array( $inside, $trail );
}
/**
- * Generate a user link if the current user is allowed to view it
- * @param $rev Revision object.
- * @param $isPublic, bool, show only if all users can see it
- * @return string HTML
+ * Generate a rollback link for a given revision. Currently it's the
+ * caller's responsibility to ensure that the revision is the top one. If
+ * it's not, of course, the user will get an error message.
+ *
+ * If the calling page is called with the parameter &bot=1, all rollback
+ * links also get that parameter. It causes the edit itself and the rollback
+ * to be marked as "bot" edits. Bot edits are hidden by default from recent
+ * changes, so this allows sysops to combat a busy vandal without bothering
+ * other users.
+ *
+ * @param Revision $rev
*/
- 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->getRawUser(), $rev->getRawUserText() );
- } else {
- $link = wfMsgHtml( 'rev-deleted-user' );
- }
- if( $rev->isDeleted( Revision::DELETED_USER ) ) {
- return '<span class="history-deleted">' . $link . '</span>';
- }
- return $link;
+ function generateRollback( $rev ) {
+ return '<span class="mw-rollback-link">['
+ . $this->buildRollbackLink( $rev )
+ . ']</span>';
}
/**
- * Generate a user tool link cluster if the current user is allowed to view it
- * @param $rev Revision object.
- * @param $isPublic, bool, show only if all users can see it
- * @return string HTML
+ * Build a raw rollback link, useful for collections of "tool" links
+ *
+ * @param Revision $rev
+ * @return string
*/
- 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 = $this->userLink( $rev->getRawUser(), $rev->getRawUserText() ) .
- ' ' . $this->userToolLinks( $rev->getRawUser(), $rev->getRawUserText() );
- } else {
- $link = wfMsgHtml( 'rev-deleted-user' );
- }
- if( $rev->isDeleted( Revision::DELETED_USER ) ) {
- return ' <span class="history-deleted">' . $link . '</span>';
+ public function buildRollbackLink( $rev ) {
+ global $wgRequest, $wgUser;
+ $title = $rev->getTitle();
+ $query = array(
+ 'action' => 'rollback',
+ 'from' => $rev->getUserText()
+ );
+ if( $wgRequest->getBool( 'bot' ) ) {
+ $query['bot'] = '1';
+ $query['hidediff'] = '1'; // bug 15999
}
- return $link;
+ $query['token'] = $wgUser->editToken( array( $title->getPrefixedText(),
+ $rev->getUserText() ) );
+ return $this->link( $title, wfMsgHtml( 'rollbacklink' ),
+ array( 'title' => wfMsg( 'tooltip-rollback' ) ),
+ $query, array( 'known', 'noclasses' ) );
}
/**
- * 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
- * auto-generated comments (from section editing) and formats [[wikilinks]].
- *
- * @author Erik Moeller <moeller@scireview.de>
- *
- * 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
+ * Returns HTML for the "templates used on this page" list.
*
- * @param string $comment
- * @param mixed $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 array $templates Array of templates from Article::getUsedTemplate
+ * or similar
+ * @param bool $preview Whether this is for a preview
+ * @param bool $section Whether this is for a section edit
+ * @return string HTML output
*/
- function formatComment($comment, $title = NULL, $local = false) {
+ public function formatTemplates( $templates, $preview = false, $section = false ) {
wfProfileIn( __METHOD__ );
- # Sanitize text a bit:
- $comment = str_replace( "\n", " ", $comment );
- $comment = htmlspecialchars( $comment );
-
- # Render autocomments and make links:
- $comment = $this->formatAutoComments( $comment, $title, $local );
- $comment = $this->formatLinksInComment( $comment );
+ $outText = '';
+ if ( count( $templates ) > 0 ) {
+ # Do a batch existence check
+ $batch = new LinkBatch;
+ foreach( $templates as $title ) {
+ $batch->addObj( $title );
+ }
+ $batch->execute();
- wfProfileOut( __METHOD__ );
- return $comment;
- }
+ # Construct the HTML
+ $outText = '<div class="mw-templatesUsedExplanation">';
+ if ( $preview ) {
+ $outText .= wfMsgExt( 'templatesusedpreview', array( 'parse' ) );
+ } elseif ( $section ) {
+ $outText .= wfMsgExt( 'templatesusedsection', array( 'parse' ) );
+ } else {
+ $outText .= wfMsgExt( 'templatesused', array( 'parse' ) );
+ }
+ $outText .= "</div><ul>\n";
- /**
- * 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 string $comment Comment text
- * @param object $title An optional title object used to links to sections
- * @return string $comment formatted comment
- *
- * @todo Document the $local parameter.
- */
- private function formatAutocomments( $comment, $title = null, $local = false ) {
- $match = array();
- while (preg_match('!(.*)/\*\s*(.*?)\s*\*/(.*)!', $comment,$match)) {
- $pre=$match[1];
- $auto=$match[2];
- $post=$match[3];
- $link='';
- if( $title ) {
- $section = $auto;
-
- # Generate a valid anchor name from the section title.
- # Hackish, but should generally work - we strip wiki
- # syntax, including the magic [[: that is used to
- # "link rather than show" in case of images and
- # interlanguage links.
- $section = str_replace( '[[:', '', $section );
- $section = str_replace( '[[', '', $section );
- $section = str_replace( ']]', '', $section );
- if ( $local ) {
- $sectionTitle = Title::newFromText( '#' . $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 {
- $sectionTitle = wfClone( $title );
- $sectionTitle->mFragment = $section;
+ $protected = '';
}
- $link = $this->link( $sectionTitle, wfMsgForContent( 'sectionlink' ) );
- }
- $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' ) );
+ 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>';
}
- $auto = '<span class="autocomment">' . $auto . '</span>';
- $comment = $pre . $auto . $post;
+ $outText .= '</ul>';
}
-
- return $comment;
+ wfProfileOut( __METHOD__ );
+ return $outText;
}
/**
- * Formats wiki links and media links in text; all other wiki formatting
- * is ignored
+ * Returns HTML for the "hidden categories on this page" list.
*
- * @fixme doesn't handle sub-links as in image thumb texts like the main parser
- * @param string $comment Text to format links in
- * @return string
+ * @param array $hiddencats Array of hidden categories from Article::getHiddenCategories
+ * or similar
+ * @return string HTML output
*/
- public function formatLinksInComment( $comment ) {
- return preg_replace_callback(
- '/\[\[:?(.*?)(\|(.*?))*\]\]([^[]*)/',
- array( $this, 'formatLinksInCommentCallback' ),
- $comment );
- }
-
- protected function formatLinksInCommentCallback( $match ) {
- global $wgContLang;
-
- $medians = '(?:' . preg_quote( MWNamespace::getCanonicalName( NS_MEDIA ), '/' ) . '|';
- $medians .= preg_quote( $wgContLang->getNsText( NS_MEDIA ), '/' ) . '):';
-
- $comment = $match[0];
+ public function formatHiddenCategories( $hiddencats ) {
+ global $wgLang;
+ wfProfileIn( __METHOD__ );
- # fix up urlencoded title texts (copied from Parser::replaceInternalLinks)
- if( strpos( $match[1], '%' ) !== false ) {
- $match[1] = str_replace( array('<', '>'), array('<', '>'), urldecode($match[1]) );
- }
+ $outText = '';
+ if ( count( $hiddencats ) > 0 ) {
+ # Construct the HTML
+ $outText = '<div class="mw-hiddenCategoriesExplanation">';
+ $outText .= wfMsgExt( 'hiddencategories', array( 'parse' ), $wgLang->formatnum( count( $hiddencats ) ) );
+ $outText .= "</div><ul>\n";
- # Handle link renaming [[foo|text]] will show link as "text"
- if( "" != $match[3] ) {
- $text = $match[3];
- } else {
- $text = $match[1];
- }
- $submatch = array();
- if( preg_match( '/^' . $medians . '(.*)$/i', $match[1], $submatch ) ) {
- # Media link; trail not supported.
- $linkRegexp = '/\[\[(.*?)\]\]/';
- $thelink = $this->makeMediaLink( $submatch[1], "", $text );
- } else {
- # Other kind of link
- if( preg_match( $wgContLang->linkTrail(), $match[4], $submatch ) ) {
- $trail = $submatch[1];
- } else {
- $trail = "";
+ 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
}
- $linkRegexp = '/\[\[(.*?)\]\]' . preg_quote( $trail, '/' ) . '/';
- if (isset($match[1][0]) && $match[1][0] == ':')
- $match[1] = substr($match[1], 1);
- $thelink = $this->makeLink( $match[1], $text, "", $trail );
- }
- $comment = preg_replace( $linkRegexp, StringUtils::escapeRegexReplacement( $thelink ), $comment, 1 );
-
- return $comment;
+ $outText .= '</ul>';
+ }
+ wfProfileOut( __METHOD__ );
+ return $outText;
}
/**
- * Wrap a comment in standard punctuation and formatting if
- * it's non-empty, otherwise return empty string.
- *
- * @param string $comment
- * @param mixed $title Title object (to generate link to section in autocomment) or null
- * @param bool $local Whether section links should refer to local page
+ * 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
*/
- function commentBlock( $comment, $title = NULL, $local = false ) {
- // '*' 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
- if( $comment == '' || $comment == '*' ) {
- return '';
- } else {
- $formatted = $this->formatComment( $comment, $title, $local );
- return " <span class=\"comment\">($formatted)</span>";
- }
+ public function formatSize( $size ) {
+ global $wgLang;
+ return htmlspecialchars( $wgLang->formatSize( $size ) );
}
/**
- * Wrap and format the given revision's comment block, if the current
- * user is allowed to view it.
+ * Given the id of an interface element, constructs the appropriate title
+ * attribute from the system messages. (Note, this is usually the id but
+ * isn't always, because sometimes the accesskey needs to go on a different
+ * element than the id, for reverse-compatibility, etc.)
*
- * @param Revision $rev
- * @param bool $local Whether section links should refer to local page
- * @param $isPublic, show only if all users can see it
- * @return string HTML
+ * @param string $name Id of the element, minus prefixes.
+ * @param mixed $options null or the string 'withaccess' to add an access-
+ * key hint
+ * @return string Contents of the title attribute (which you must HTML-
+ * escape), or false for no title attribute
*/
- function revComment( Revision $rev, $local = false, $isPublic = false ) {
- 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->getRawComment(), $rev->getTitle(), $local );
- } else {
- $block = " <span class=\"comment\">" . wfMsgHtml( 'rev-deleted-comment' ) . "</span>";
- }
- if( $rev->isDeleted( Revision::DELETED_COMMENT ) ) {
- return " <span class=\"history-deleted\">$block</span>";
- }
- return $block;
- }
+ public function titleAttrib( $name, $options = null ) {
+ wfProfileIn( __METHOD__ );
- public function formatRevisionSize( $size ) {
- if ( $size == 0 ) {
- $stxt = wfMsgExt( 'historyempty', 'parsemag' );
- } else {
- global $wgLang;
- $stxt = wfMsgExt( 'nbytes', 'parsemag', $wgLang->formatNum( $size ) );
- $stxt = "($stxt)";
+ $tooltip = wfMsg( "tooltip-$name" );
+ # Compatibility: formerly some tooltips had [alt-.] hardcoded
+ $tooltip = preg_replace( "/ ?\[alt-.\]$/", '', $tooltip );
+
+ # Message equal to '-' means suppress it.
+ if ( wfEmptyMsg( "tooltip-$name", $tooltip ) || $tooltip == '-' ) {
+ $tooltip = false;
}
- $stxt = htmlspecialchars( $stxt );
- return "<span class=\"history-size\">$stxt</span>";
- }
- /** @todo document */
- function tocIndent() {
- return "\n<ul>";
- }
+ if ( $options == 'withaccess' ) {
+ $accesskey = $this->accesskey( $name );
+ if( $accesskey !== false ) {
+ if ( $tooltip === false || $tooltip === '' ) {
+ $tooltip = "[$accesskey]";
+ } else {
+ $tooltip .= " [$accesskey]";
+ }
+ }
+ }
- /** @todo document */
- function tocUnindent($level) {
- return "</li>\n" . str_repeat( "</ul>\n</li>\n", $level>0 ? $level : 0 );
+ wfProfileOut( __METHOD__ );
+ return $tooltip;
}
/**
- * parameter level defines if we are on an indentation level
+ * 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 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
*/
- function tocLine( $anchor, $tocline, $tocnumber, $level ) {
- return "\n<li class=\"toclevel-$level\"><a href=\"#" .
- $anchor . '"><span class="tocnumber">' .
- $tocnumber . '</span> <span class="toctext">' .
- $tocline . '</span></a>';
- }
+ public function accesskey( $name ) {
+ wfProfileIn( __METHOD__ );
- /** @todo document */
- function tocLineEnd() {
- return "</li>\n";
- }
+ $accesskey = wfMsg( "accesskey-$name" );
- /** @todo document */
- function tocList($toc) {
- global $wgJsMimeType;
- $title = wfMsgHtml('toc') ;
- return
- '<table id="toc" class="toc" summary="' . $title .'"><tr><td>'
- . '<div id="toctitle"><h2>' . $title . "</h2></div>\n"
- . $toc
- # no trailing newline, script should not be wrapped in a
- # paragraph
- . "</ul>\n</td></tr></table>"
- . '<script type="' . $wgJsMimeType . '">'
- . ' if (window.showTocToggle) {'
- . ' var tocShowText = "' . wfEscapeJsString( wfMsg('showtoc') ) . '";'
- . ' var tocHideText = "' . wfEscapeJsString( wfMsg('hidetoc') ) . '";'
- . ' showTocToggle();'
- . ' } '
- . "</script>\n";
- }
+ # 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.
+ if( $accesskey != '' && $accesskey != '-' && !wfEmptyMsg( "accesskey-$name", $accesskey ) ) {
+ wfProfileOut( __METHOD__ );
+ return $accesskey;
+ }
+ wfProfileOut( __METHOD__ );
+ return false;
+ }
+
/**
- * Used to generate section edit links that point to "other" pages
- * (sections that are really part of included pages).
+ * Creates a (show/hide) link for deleting revisions/log entries
*
- * @param $title Title string.
- * @param $section Integer: section number.
+ * @param array $query Query parameters to be passed to link()
+ * @param bool $restricted Set to true to use a <strong> instead of a <span>
+ *
+ * @return string HTML <a> link to Special:Revisiondelete, 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 function revDeleteLink( $query = array(), $restricted = false ) {
+ $sp = SpecialPage::getTitleFor( 'Revisiondelete' );
+ $text = wfMsgHtml( 'rev-delundel' );
+ $tag = $restricted ? 'strong' : 'span';
+ $link = $this->link( $sp, $text, array(), $query, array( 'known', 'noclasses' ) );
+ return Xml::tags( $tag, array( 'class' => 'mw-revdelundel-link' ), "($link)" );
}
+ /* Deprecated methods */
+
/**
- * @param $nt Title object.
- * @param $section Integer: section number.
- * @param $hint Link String: title, or default if omitted or empty
+ * @deprecated
*/
- public function editSectionLink( Title $nt, $section, $hint = '' ) {
+ function postParseLinkColour( $s = null ) {
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 );
+ return null;
}
+
/**
- * Create a section edit link. This supersedes editSectionLink() and
- * editSectionLinkForOther().
+ * @deprecated Use link()
*
- * @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
- * @return string HTML to use for edit 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.
*/
- public function doEditSectionLink( Title $nt, $section, $tooltip = null ) {
- $attribs = array();
- if( !is_null( $tooltip ) ) {
- $attribs['title'] = wfMsg( 'editsectionhint', $tooltip );
- }
- $url = $this->link( $nt, wfMsg('editsection'),
- $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 = wfMsgHtml( 'editsectionhint', htmlspecialchars( $tooltip ) );
- $attribs = " title=\"$attribs\"";
- }
- $result = null;
- wfRunHooks( 'EditSectionLink', array( &$this, $nt, $section, $attribs, $url, &$result ) );
- 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 = wfMsgHtml( 'editsection-brackets', $url );
- return "<span class=\"editsection\">$result</span>";
+ 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;
}
- # Add the brackets and the span, and *then* run the nice new hook, with
- # clean and non-redundant arguments.
- $result = wfMsgHtml( 'editsection-brackets', $url );
- $result = "<span class=\"editsection\">$result</span>";
-
- wfRunHooks( 'DoEditSectionLink', array( $this, $nt, $section, $tooltip, &$result ) );
+ wfProfileOut( __METHOD__ );
return $result;
}
/**
- * Create a headline for content
+ * @deprecated Use link()
*
- * @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 $text The text of the header
- * @param string $link HTML to add for the section edit 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.
*
- * @return string HTML headline
+ * @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.
*/
- public function makeHeadline( $level, $attribs, $anchor, $text, $link ) {
- return "<a name=\"$anchor\"></a><h$level$attribs$link <span class=\"mw-headline\">$text</span></h$level>";
+ 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;
+ }
}
/**
- * Split a link trail, return the "inside" portion and the remainder of the trail
- * as a two-element array
+ * @deprecated Use link()
*
- * @static
+ * 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 string $title The text of the title
+ * @param string $text Link text
+ * @param string $query Optional query part
+ * @param string $trail 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.
*/
- static function splitTrail( $trail ) {
- static $regex = false;
- if ( $regex === false ) {
- global $wgContLang;
- $regex = $wgContLang->linkTrail();
+ function makeBrokenLink( $title, $text = '', $query = '', $trail = '' ) {
+ $nt = Title::newFromText( $title );
+ if ( $nt instanceof Title ) {
+ return $this->makeBrokenLinkObj( $nt, $text, $query, $trail );
+ } else {
+ wfDebug( 'Invalid title passed to Linker::makeBrokenLink(): "'.$title."\"\n" );
+ return $text == '' ? $title : $text;
}
- $inside = '';
- if ( '' != $trail ) {
- $m = array();
- if ( preg_match( $regex, $trail, $m ) ) {
- $inside = $m[1];
- $trail = $m[2];
- }
+ }
+
+ /**
+ * @deprecated Use link()
+ *
+ * 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 $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;
}
- return array( $inside, $trail );
}
/**
- * Generate a rollback link for a given revision. Currently it's the
- * caller's responsibility to ensure that the revision is the top one. If
- * it's not, of course, the user will get an error message.
+ * @deprecated Use link()
*
- * If the calling page is called with the parameter &bot=1, all rollback
- * links also get that parameter. It causes the edit itself and the rollback
- * to be marked as "bot" edits. Bot edits are hidden by default from recent
- * changes, so this allows sysops to combat a busy vandal without bothering
- * other users.
+ * 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 Revision $rev
+ * @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 generateRollback( $rev ) {
- return '<span class="mw-rollback-link">['
- . $this->buildRollbackLink( $rev )
- . ']</span>';
- }
+ function makeLinkObj( $nt, $text= '', $query = '', $trail = '', $prefix = '' ) {
+ wfProfileIn( __METHOD__ );
- /**
- * Build a raw rollback link, useful for collections of "tool" links
- *
- * @param Revision $rev
- * @return string
- */
- public function buildRollbackLink( $rev ) {
- global $wgRequest, $wgUser;
- $title = $rev->getTitle();
- $query = array(
- 'action' => 'rollback',
- 'from' => $rev->getUserText()
- );
- if( $wgRequest->getBool( 'bot' ) ) {
- $query['bot'] = '1';
+ $query = wfCgiToArray( $query );
+ list( $inside, $trail ) = Linker::splitTrail( $trail );
+ if( $text === '' ) {
+ $text = $this->linkText( $nt );
}
- $query['token'] = $wgUser->editToken( array( $title->getPrefixedText(),
- $rev->getUserText() ) );
- return $this->link( $title, wfMsgHtml( 'rollbacklink' ), array(),
- $query, array( 'known', 'noclasses' ) );
+
+ $ret = $this->link( $nt, "$prefix$text$inside", array(), $query ) . $trail;
+
+ wfProfileOut( __METHOD__ );
+ return $ret;
}
/**
- * Returns HTML for the "templates used on this page" list.
+ * @deprecated Use link()
*
- * @param array $templates Array of templates from Article::getUsedTemplate
- * or similar
- * @param bool $preview Whether this is for a preview
- * @param bool $section Whether this is for a section edit
- * @return string HTML output
+ * 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 $nt 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
*/
- public function formatTemplates( $templates, $preview = false, $section = false) {
- global $wgUser;
+ function makeKnownLinkObj( $title, $text = '', $query = '', $trail = '', $prefix = '' , $aprops = '', $style = '' ) {
wfProfileIn( __METHOD__ );
- $sk = $wgUser->getSkin();
-
- $outText = '';
- if ( count( $templates ) > 0 ) {
- # Do a batch existence check
- $batch = new LinkBatch;
- foreach( $templates as $title ) {
- $batch->addObj( $title );
- }
- $batch->execute();
+ if ( $text == '' ) {
+ $text = $this->linkText( $title );
+ }
+ $attribs = Sanitizer::mergeAttributes(
+ Sanitizer::decodeTagAttributes( $aprops ),
+ Sanitizer::decodeTagAttributes( $style )
+ );
+ $query = wfCgiToArray( $query );
+ list( $inside, $trail ) = Linker::splitTrail( $trail );
- # Construct the HTML
- $outText = '<div class="mw-templatesUsedExplanation">';
- if ( $preview ) {
- $outText .= wfMsgExt( 'templatesusedpreview', array( 'parse' ) );
- } elseif ( $section ) {
- $outText .= wfMsgExt( 'templatesusedsection', array( 'parse' ) );
- } else {
- $outText .= wfMsgExt( 'templatesused', array( 'parse' ) );
- }
- $outText .= '</div><ul>';
+ $ret = $this->link( $title, "$prefix$text$inside", $attribs, $query,
+ array( 'known', 'noclasses' ) ) . $trail;
- 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 = '';
- }
- $outText .= '<li>' . $sk->link( $titleObj ) . ' ' . $protected . '</li>';
- }
- $outText .= '</ul>';
- }
- wfProfileOut( __METHOD__ );
- return $outText;
+ wfProfileOut( __METHOD__ );
+ return $ret;
}
/**
- * Returns HTML for the "hidden categories on this page" list.
+ * @deprecated Use link()
*
- * @param array $hiddencats Array of hidden categories from Article::getHiddenCategories
- * or similar
- * @return string HTML output
+ * Make a red link to the edit page of a given title.
+ *
+ * @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.
*/
- public function formatHiddenCategories( $hiddencats) {
- global $wgUser, $wgLang;
+ function makeBrokenLinkObj( $title, $text = '', $query = '', $trail = '', $prefix = '' ) {
wfProfileIn( __METHOD__ );
- $sk = $wgUser->getSkin();
+ list( $inside, $trail ) = Linker::splitTrail( $trail );
+ if( $text === '' ) {
+ $text = $this->linkText( $title );
+ }
+ $nt = $this->normaliseSpecialPage( $title );
- $outText = '';
- if ( count( $hiddencats ) > 0 ) {
- # Construct the HTML
- $outText = '<div class="mw-hiddenCategoriesExplanation">';
- $outText .= wfMsgExt( 'hiddencategories', array( 'parse' ), $wgLang->formatnum( count( $hiddencats ) ) );
- $outText .= '</div><ul>';
+ $ret = $this->link( $title, "$prefix$text$inside", array(),
+ wfCgiToArray( $query ), 'broken' ) . $trail;
- foreach ( $hiddencats as $titleObj ) {
- $outText .= '<li>' . $sk->link( $titleObj, null, array(), array(), 'known' ) . '</li>'; # If it's hidden, it must exist - no need to check with a LinkBatch
- }
- $outText .= '</ul>';
- }
- wfProfileOut( __METHOD__ );
- return $outText;
+ wfProfileOut( __METHOD__ );
+ return $ret;
}
/**
- * Format a size in bytes for output, using an appropriate
- * unit (B, KB, MB or GB) according to the magnitude in question
+ * @deprecated Use link()
*
- * @param $size Size to format
- * @return string
+ * Make a brown link to a short article.
+ *
+ * @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.
*/
- public function formatSize( $size ) {
- global $wgLang;
- return htmlspecialchars( $wgLang->formatSize( $size ) );
+ function makeStubLinkObj( $nt, $text = '', $query = '', $trail = '', $prefix = '' ) {
+ wfDeprecated( __METHOD__ );
+ return $this->makeColouredLinkObj( $nt, 'stub', $text, $query, $trail, $prefix );
}
/**
- * Given the id of an interface element, constructs the appropriate title
- * and accesskey attributes from the system messages. (Note, this is usu-
- * ally the id but isn't always, because sometimes the accesskey needs to
- * go on a different element than the id, for reverse-compatibility, etc.)
+ * @deprecated Use link()
*
- * @param string $name Id of the element, minus prefixes.
- * @return string title and accesskey attributes, ready to drop in an
- * element (e.g., ' title="This does something [x]" accesskey="x"').
+ * 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.
*/
- public function tooltipAndAccesskey($name) {
- $fname="Linker::tooltipAndAccesskey";
- wfProfileIn($fname);
- $out = '';
+ function makeColouredLinkObj( $nt, $colour, $text = '', $query = '', $trail = '', $prefix = '' ) {
+ 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 );
+ }
- $tooltip = wfMsg('tooltip-'.$name);
- if (!wfEmptyMsg('tooltip-'.$name, $tooltip) && $tooltip != '-') {
- // Compatibility: formerly some tooltips had [alt-.] hardcoded
- $tooltip = preg_replace( "/ ?\[alt-.\]$/", '', $tooltip );
- $out .= ' title="'.htmlspecialchars($tooltip);
+ /**
+ * Creates the HTML source for images
+ * @deprecated use makeImageLink2
+ *
+ * @param object $title
+ * @param string $label label text
+ * @param string $alt alt text
+ * @param string $align horizontal alignment: none, left, center, right)
+ * @param array $handlerParams Parameters to be passed to the media handler
+ * @param boolean $framed shows image in original size in a frame
+ * @param boolean $thumb shows image as thumbnail in a frame
+ * @param string $manualthumb image name for the manual thumbnail
+ * @param string $valign vertical alignment: baseline, sub, super, top, text-top, middle, bottom, text-bottom
+ * @param string $time, 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;
}
- $accesskey = wfMsg('accesskey-'.$name);
- if ($accesskey && $accesskey != '-' && !wfEmptyMsg('accesskey-'.$name, $accesskey)) {
- if ($out) $out .= " [$accesskey]\" accesskey=\"$accesskey\"";
- else $out .= " title=\"[$accesskey]\" accesskey=\"$accesskey\"";
- } elseif ($out) {
- $out .= '"';
+ if ( $valign ) {
+ $frameParams['valign'] = $valign;
}
- wfProfileOut($fname);
- return $out;
+ $file = wfFindFile( $title, $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 );
}
/**
- * Given the id of an interface element, constructs the appropriate title
- * attribute from the system messages. (Note, this is usually the id but
- * isn't always, because sometimes the accesskey needs to go on a different
- * element than the id, for reverse-compatibility, etc.)
+ * Used to generate section edit links that point to "other" pages
+ * (sections that are really part of included pages).
*
- * @param string $name Id of the element, minus prefixes.
- * @return string title attribute, ready to drop in an element
- * (e.g., ' title="This does something"').
+ * @deprecated use Linker::doEditSectionLink()
+ * @param $title Title string.
+ * @param $section Integer: section number.
+ */
+ public function editSectionLinkForOther( $title, $section ) {
+ wfDeprecated( __METHOD__ );
+ $title = Title::newFromText( $title );
+ return $this->doEditSectionLink( $title, $section );
+ }
+
+ /**
+ * @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 tooltip($name) {
- $out = '';
+ 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 );
+ }
- $tooltip = wfMsg('tooltip-'.$name);
- if (!wfEmptyMsg('tooltip-'.$name, $tooltip) && $tooltip != '-') {
- $out = ' title="'.htmlspecialchars($tooltip).'"';
+ /**
+ * @deprecated Returns raw bits of HTML, use titleAttrib() and accesskey()
+ */
+ public function tooltipAndAccesskey( $name ) {
+ # 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 )
+ );
+ if ( $attribs['title'] === false ) {
+ unset( $attribs['title'] );
}
+ if ( $attribs['accesskey'] === false ) {
+ unset( $attribs['accesskey'] );
+ }
+ return Xml::expandAttributes( $attribs );
+ }
- return $out;
+ /** @deprecated Returns raw bits of HTML, use titleAttrib() */
+ public function tooltip( $name, $options = null ) {
+ # 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 );
+ if ( $tooltip === false ) {
+ return '';
+ }
+ return Xml::expandAttributes( array(
+ 'title' => $this->titleAttrib( $name, $options )
+ ) );
}
}