3 * Split off some of the internal bits from Skin.php.
4 * These functions are used for primarily page content:
5 * links, embedded images, table of contents. Links are
6 * also used in the skin.
7 * For the moment, Skin is a descendent class of Linker.
8 * In the future, it should probably be further split
9 * so that ever other bit of the wiki doesn't have to
10 * go loading up Skin to get at it.
15 function __construct() {}
20 function postParseLinkColour( $s = NULL ) {
25 function getExternalLinkAttributes( $link, $text, $class='' ) {
26 $link = htmlspecialchars( $link );
28 $r = ($class != '') ?
" class=\"$class\"" : " class=\"external\"";
30 $r .= " title=\"{$link}\"";
34 function getInterwikiLinkAttributes( $link, $text, $class='' ) {
37 $link = urldecode( $link );
38 $link = $wgContLang->checkTitleEncoding( $link );
39 $link = preg_replace( '/[\\x00-\\x1f]/', ' ', $link );
40 $link = htmlspecialchars( $link );
42 $r = ($class != '') ?
" class=\"$class\"" : " class=\"external\"";
44 $r .= " title=\"{$link}\"";
49 function getInternalLinkAttributes( $link, $text, $broken = false ) {
50 $link = urldecode( $link );
51 $link = str_replace( '_', ' ', $link );
52 $link = htmlspecialchars( $link );
54 if( $broken == 'stub' ) {
56 } else if ( $broken == 'yes' ) {
62 $r .= " title=\"{$link}\"";
67 * @param $nt Title object.
68 * @param $text String: FIXME
69 * @param $broken Boolean: FIXME, default 'false'.
71 function getInternalLinkAttributesObj( &$nt, $text, $broken = false ) {
72 if( $broken == 'stub' ) {
74 } else if ( $broken == 'yes' ) {
80 $r .= ' title="' . $nt->getEscapedText() . '"';
85 * This function is a shortcut to makeLinkObj(Title::newFromText($title),...). Do not call
86 * it if you already have a title object handy. See makeLinkObj for further documentation.
88 * @param $title String: the text of the title
89 * @param $text String: link text
90 * @param $query String: optional query part
91 * @param $trail String: optional trail. Alphabetic characters at the start of this string will
92 * be included in the link text. Other characters will be appended after
93 * the end of the link.
95 function makeLink( $title, $text = '', $query = '', $trail = '' ) {
96 wfProfileIn( 'Linker::makeLink' );
97 $nt = Title
::newFromText( $title );
99 $result = $this->makeLinkObj( Title
::newFromText( $title ), $text, $query, $trail );
101 wfDebug( 'Invalid title passed to Linker::makeLink(): "'.$title."\"\n" );
102 $result = $text == "" ?
$title : $text;
105 wfProfileOut( 'Linker::makeLink' );
110 * This function is a shortcut to makeKnownLinkObj(Title::newFromText($title),...). Do not call
111 * it if you already have a title object handy. See makeKnownLinkObj for further documentation.
113 * @param $title String: the text of the title
114 * @param $text String: link text
115 * @param $query String: optional query part
116 * @param $trail String: optional trail. Alphabetic characters at the start of this string will
117 * be included in the link text. Other characters will be appended after
118 * the end of the link.
120 function makeKnownLink( $title, $text = '', $query = '', $trail = '', $prefix = '',$aprops = '') {
121 $nt = Title
::newFromText( $title );
123 return $this->makeKnownLinkObj( Title
::newFromText( $title ), $text, $query, $trail, $prefix , $aprops );
125 wfDebug( 'Invalid title passed to Linker::makeKnownLink(): "'.$title."\"\n" );
126 return $text == '' ?
$title : $text;
131 * This function is a shortcut to makeBrokenLinkObj(Title::newFromText($title),...). Do not call
132 * it if you already have a title object handy. See makeBrokenLinkObj for further documentation.
134 * @param string $title The text of the title
135 * @param string $text Link text
136 * @param string $query Optional query part
137 * @param string $trail Optional trail. Alphabetic characters at the start of this string will
138 * be included in the link text. Other characters will be appended after
139 * the end of the link.
141 function makeBrokenLink( $title, $text = '', $query = '', $trail = '' ) {
142 $nt = Title
::newFromText( $title );
144 return $this->makeBrokenLinkObj( Title
::newFromText( $title ), $text, $query, $trail );
146 wfDebug( 'Invalid title passed to Linker::makeBrokenLink(): "'.$title."\"\n" );
147 return $text == '' ?
$title : $text;
152 * This function is a shortcut to makeStubLinkObj(Title::newFromText($title),...). Do not call
153 * it if you already have a title object handy. See makeStubLinkObj for further documentation.
155 * @param $title String: the text of the title
156 * @param $text String: link text
157 * @param $query String: optional query part
158 * @param $trail String: optional trail. Alphabetic characters at the start of this string will
159 * be included in the link text. Other characters will be appended after
160 * the end of the link.
162 function makeStubLink( $title, $text = '', $query = '', $trail = '' ) {
163 $nt = Title
::newFromText( $title );
165 return $this->makeStubLinkObj( Title
::newFromText( $title ), $text, $query, $trail );
167 wfDebug( 'Invalid title passed to Linker::makeStubLink(): "'.$title."\"\n" );
168 return $text == '' ?
$title : $text;
173 * Make a link for a title which may or may not be in the database. If you need to
174 * call this lots of times, pre-fill the link cache with a LinkBatch, otherwise each
175 * call to this will result in a DB query.
177 * @param $nt Title: the title object to make the link from, e.g. from
178 * Title::newFromText.
179 * @param $text String: link text
180 * @param $query String: optional query part
181 * @param $trail String: optional trail. Alphabetic characters at the start of this string will
182 * be included in the link text. Other characters will be appended after
183 * the end of the link.
184 * @param $prefix String: optional prefix. As trail, only before instead of after.
186 function makeLinkObj( $nt, $text= '', $query = '', $trail = '', $prefix = '' ) {
188 $fname = 'Linker::makeLinkObj';
189 wfProfileIn( $fname );
192 if ( ! is_object($nt) ) {
193 # throw new MWException();
194 wfProfileOut( $fname );
195 return "<!-- ERROR -->{$prefix}{$text}{$trail}";
198 if ( $nt->isExternal() ) {
199 $u = $nt->getFullURL();
200 $link = $nt->getPrefixedURL();
201 if ( '' == $text ) { $text = $nt->getPrefixedText(); }
202 $style = $this->getInterwikiLinkAttributes( $link, $text, 'extiw' );
205 if ( '' != $trail ) {
207 if ( preg_match( '/^([a-z]+)(.*)$$/sD', $trail, $m ) ) {
212 $t = "<a href=\"{$u}\"{$style}>{$text}{$inside}</a>";
214 wfProfileOut( $fname );
216 } elseif ( $nt->isAlwaysKnown() ) {
217 # Image links, special page links and self-links with fragements are always known.
218 $retVal = $this->makeKnownLinkObj( $nt, $text, $query, $trail, $prefix );
220 wfProfileIn( $fname.'-immediate' );
222 # Handles links to special pages wich do not exist in the database:
223 if( $nt->getNamespace() == NS_SPECIAL
) {
224 if( SpecialPage
::exists( $nt->getDbKey() ) ) {
225 $retVal = $this->makeKnownLinkObj( $nt, $text, $query, $trail, $prefix );
227 $retVal = $this->makeBrokenLinkObj( $nt, $text, $query, $trail, $prefix );
229 wfProfileOut( $fname.'-immediate' );
230 wfProfileOut( $fname );
234 # Work out link colour immediately
235 $aid = $nt->getArticleID() ;
237 $retVal = $this->makeBrokenLinkObj( $nt, $text, $query, $trail, $prefix );
240 if ( $nt->isContentPage() ) {
241 $threshold = $wgUser->getOption('stubthreshold');
242 if ( $threshold > 0 ) {
243 $dbr = wfGetDB( DB_SLAVE
);
244 $s = $dbr->selectRow(
247 'page_is_redirect' ),
248 array( 'page_id' => $aid ), $fname ) ;
249 $stub = ( $s !== false && !$s->page_is_redirect
&&
250 $s->page_len
< $threshold );
254 $retVal = $this->makeStubLinkObj( $nt, $text, $query, $trail, $prefix );
256 $retVal = $this->makeKnownLinkObj( $nt, $text, $query, $trail, $prefix );
259 wfProfileOut( $fname.'-immediate' );
261 wfProfileOut( $fname );
266 * Make a link for a title which definitely exists. This is faster than makeLinkObj because
267 * it doesn't have to do a database query. It's also valid for interwiki titles and special
270 * @param $nt Title object of target page
271 * @param $text String: text to replace the title
272 * @param $query String: link target
273 * @param $trail String: text after link
274 * @param $prefix String: text before link text
275 * @param $aprops String: extra attributes to the a-element
276 * @param $style String: style to apply - if empty, use getInternalLinkAttributesObj instead
277 * @return the a-element
279 function makeKnownLinkObj( $nt, $text = '', $query = '', $trail = '', $prefix = '' , $aprops = '', $style = '' ) {
281 $fname = 'Linker::makeKnownLinkObj';
282 wfProfileIn( $fname );
284 if ( !is_object( $nt ) ) {
285 wfProfileOut( $fname );
289 $u = $nt->escapeLocalURL( $query );
290 if ( $nt->getFragment() != '' ) {
291 if( $nt->getPrefixedDbkey() == '' ) {
294 $text = htmlspecialchars( $nt->getFragment() );
297 $u .= $nt->getFragmentForURL();
300 $text = htmlspecialchars( $nt->getPrefixedText() );
302 if ( $style == '' ) {
303 $style = $this->getInternalLinkAttributesObj( $nt, $text );
306 if ( $aprops !== '' ) $aprops = ' ' . $aprops;
308 list( $inside, $trail ) = Linker
::splitTrail( $trail );
309 $r = "<a href=\"{$u}\"{$style}{$aprops}>{$prefix}{$text}{$inside}</a>{$trail}";
310 wfProfileOut( $fname );
315 * Make a red link to the edit page of a given title.
317 * @param $title String: The text of the title
318 * @param $text String: Link text
319 * @param $query String: Optional query part
320 * @param $trail String: Optional trail. Alphabetic characters at the start of this string will
321 * be included in the link text. Other characters will be appended after
322 * the end of the link.
324 function makeBrokenLinkObj( $nt, $text = '', $query = '', $trail = '', $prefix = '' ) {
326 if ( ! isset($nt) ) {
327 # throw new MWException();
328 return "<!-- ERROR -->{$prefix}{$text}{$trail}";
331 $fname = 'Linker::makeBrokenLinkObj';
332 wfProfileIn( $fname );
334 if( $nt->getNamespace() == NS_SPECIAL
) {
336 } else if ( '' == $query ) {
339 $q = 'action=edit&'.$query;
341 $u = $nt->escapeLocalURL( $q );
344 $text = htmlspecialchars( $nt->getPrefixedText() );
346 $style = $this->getInternalLinkAttributesObj( $nt, $text, "yes" );
348 list( $inside, $trail ) = Linker
::splitTrail( $trail );
349 $s = "<a href=\"{$u}\"{$style}>{$prefix}{$text}{$inside}</a>{$trail}";
351 wfProfileOut( $fname );
356 * Make a brown link to a short article.
358 * @param $title String: the text of the title
359 * @param $text String: link text
360 * @param $query String: optional query part
361 * @param $trail String: optional trail. Alphabetic characters at the start of this string will
362 * be included in the link text. Other characters will be appended after
363 * the end of the link.
365 function makeStubLinkObj( $nt, $text = '', $query = '', $trail = '', $prefix = '' ) {
366 $style = $this->getInternalLinkAttributesObj( $nt, $text, 'stub' );
367 return $this->makeKnownLinkObj( $nt, $text, $query, $trail, $prefix, '', $style );
371 * Generate either a normal exists-style link or a stub link, depending
372 * on the given page size.
374 * @param $size Integer
375 * @param $nt Title object.
376 * @param $text String
377 * @param $query String
378 * @param $trail String
379 * @param $prefix String
380 * @return string HTML of link
382 function makeSizeLinkObj( $size, $nt, $text = '', $query = '', $trail = '', $prefix = '' ) {
384 $threshold = intval( $wgUser->getOption( 'stubthreshold' ) );
385 if( $size < $threshold ) {
386 return $this->makeStubLinkObj( $nt, $text, $query, $trail, $prefix );
388 return $this->makeKnownLinkObj( $nt, $text, $query, $trail, $prefix );
393 * Make appropriate markup for a link to the current article. This is currently rendered
394 * as the bold link text. The calling sequence is the same as the other make*LinkObj functions,
395 * despite $query not being used.
397 function makeSelfLinkObj( $nt, $text = '', $query = '', $trail = '', $prefix = '' ) {
399 $text = htmlspecialchars( $nt->getPrefixedText() );
401 list( $inside, $trail ) = Linker
::splitTrail( $trail );
402 return "<strong class=\"selflink\">{$prefix}{$text}{$inside}</strong>{$trail}";
405 /** @todo document */
406 function fnamePart( $url ) {
407 $basename = strrchr( $url, '/' );
408 if ( false === $basename ) {
411 $basename = substr( $basename, 1 );
413 return htmlspecialchars( $basename );
416 /** Obsolete alias */
417 function makeImage( $url, $alt = '' ) {
418 return $this->makeExternalImage( $url, $alt );
421 /** @todo document */
422 function makeExternalImage( $url, $alt = '' ) {
424 $alt = $this->fnamePart( $url );
426 $s = '<img src="'.$url.'" alt="'.$alt.'" />';
430 /** Creates the HTML source for images
432 * @param string $label label text
433 * @param string $alt alt text
434 * @param string $align horizontal alignment: none, left, center, right)
435 * @param array $params some format keywords: width, height, page, upright, upright_factor, frameless, border
436 * @param boolean $framed shows image in original size in a frame
437 * @param boolean $thumb shows image as thumbnail in a frame
438 * @param string $manual_thumb image name for the manual thumbnail
439 * @param string $valign vertical alignment: baseline, sub, super, top, text-top, middle, bottom, text-bottom
442 function makeImageLinkObj( $nt, $label, $alt, $align = '', $params = array(), $framed = false,
443 $thumb = false, $manual_thumb = '', $valign = '' )
445 global $wgContLang, $wgUser, $wgThumbLimits, $wgThumbUpright;
447 $img = new Image( $nt );
449 if ( !$img->allowInlineDisplay() && $img->exists() ) {
450 return $this->makeKnownLinkObj( $nt );
453 $error = $prefix = $postfix = '';
454 $page = isset( $params['page'] ) ?
$params['page'] : false;
456 if ( 'center' == $align )
458 $prefix = '<div class="center">';
462 if ( !isset( $params['width'] ) ) {
463 $params['width'] = $img->getWidth( $page );
464 if( $thumb ||
$framed ||
isset( $params['frameless'] ) ) {
465 $wopt = $wgUser->getOption( 'thumbsize' );
467 if( !isset( $wgThumbLimits[$wopt] ) ) {
468 $wopt = User
::getDefaultOption( 'thumbsize' );
471 // Reduce width for upright images when parameter 'upright' is used
472 if ( !isset( $params['upright_factor'] ) ||
$params['upright_factor'] == 0 ) {
473 $params['upright_factor'] = $wgThumbUpright;
475 // Use width which is smaller: real image width or user preference width
476 // 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
477 $params['width'] = min( $params['width'], isset( $params['upright'] ) ?
round( $wgThumbLimits[$wopt] * $params['upright_factor'], -1 ) : $wgThumbLimits[$wopt] );
481 if ( $thumb ||
$framed ) {
483 # Create a thumbnail. Alignment depends on language
484 # writing direction, # right aligned for left-to-right-
485 # languages ("Western languages"), left-aligned
486 # for right-to-left-languages ("Semitic languages")
488 # If thumbnail width has not been provided, it is set
489 # to the default user option as specified in Language*.php
490 if ( $align == '' ) {
491 $align = $wgContLang->isRTL() ?
'left' : 'right';
493 return $prefix.$this->makeThumbLinkObj( $img, $label, $alt, $align, $params, $framed, $manual_thumb ).$postfix;
496 if ( $params['width'] && $img->exists() ) {
497 # Create a resized image, without the additional thumbnail features
498 $thumb = $img->transform( $params );
504 $query = 'page=' . urlencode( $page );
508 $u = $nt->getLocalURL( $query );
515 $imgAttribs['style'] = "vertical-align: $valign";
517 if ( isset( $params['border'] ) ) {
518 $imgAttribs['class'] = "thumbborder";
520 $linkAttribs = array(
527 $s = $this->makeBrokenImageLinkObj( $img->getTitle() );
529 $s = $thumb->toHtml( $imgAttribs, $linkAttribs );
531 if ( '' != $align ) {
532 $s = "<div class=\"float{$align}\"><span>{$s}</span></div>";
534 return str_replace("\n", ' ',$prefix.$s.$postfix);
538 * Make HTML for a thumbnail including image, border and caption
539 * $img is an Image object
541 function makeThumbLinkObj( $img, $label = '', $alt, $align = 'right', $params = array(), $framed=false , $manual_thumb = "" ) {
542 global $wgStylePath, $wgContLang;
544 $page = isset( $params['page'] ) ?
$params['page'] : false;
546 if ( empty( $params['width'] ) ) {
547 // Reduce width for upright images when parameter 'upright' is used
548 $params['width'] = isset( $params['upright'] ) ?
130 : 180;
551 if ( $manual_thumb != '' ) {
552 # Use manually specified thumbnail
553 $manual_title = Title
::makeTitleSafe( NS_IMAGE
, $manual_thumb );
554 if( $manual_title ) {
555 $manual_img = new Image( $manual_title );
556 $thumb = $manual_img->getUnscaledThumb();
558 } elseif ( $framed ) {
559 // Use image dimensions, don't scale
560 $thumb = $img->getUnscaledThumb( $page );
562 # Do not present an image bigger than the source, for bitmap-style images
563 # This is a hack to maintain compatibility with arbitrary pre-1.10 behaviour
564 $srcWidth = $img->getWidth( $page );
565 if ( $srcWidth && !$img->mustRender() && $params['width'] > $srcWidth ) {
566 $params['width'] = $srcWidth;
568 $thumb = $img->transform( $params );
572 $outerWidth = $thumb->getWidth() +
2;
574 $outerWidth = $params['width'] +
2;
577 $query = $page ?
'page=' . urlencode( $page ) : '';
578 $u = $img->getTitle()->getLocalURL( $query );
580 $more = htmlspecialchars( wfMsg( 'thumbnail-more' ) );
581 $magnifyalign = $wgContLang->isRTL() ?
'left' : 'right';
582 $textalign = $wgContLang->isRTL() ?
' style="text-align:right"' : '';
584 $s = "<div class=\"thumb t{$align}\"><div class=\"thumbinner\" style=\"width:{$outerWidth}px;\">";
586 $s .= htmlspecialchars( wfMsg( 'thumbnail_error', '' ) );
588 } elseif( !$img->exists() ) {
589 $s .= $this->makeBrokenImageLinkObj( $img->getTitle() );
595 'class' => 'thumbimage'
597 $linkAttribs = array(
599 'class' => 'internal',
603 $s .= $thumb->toHtml( $imgAttribs, $linkAttribs );
607 $zoomicon = '<div class="magnify" style="float:'.$magnifyalign.'">'.
608 '<a href="'.$u.'" class="internal" title="'.$more.'">'.
609 '<img src="'.$wgStylePath.'/common/images/magnify-clip.png" ' .
610 'width="15" height="11" alt="" /></a></div>';
613 $s .= ' <div class="thumbcaption"'.$textalign.'>'.$zoomicon.$label."</div></div></div>";
614 return str_replace("\n", ' ', $s);
618 * Pass a title object, not a title string
620 function makeBrokenImageLinkObj( $nt, $text = '', $query = '', $trail = '', $prefix = '' ) {
622 if ( ! isset($nt) ) {
623 # throw new MWException();
624 return "<!-- ERROR -->{$prefix}{$text}{$trail}";
627 $fname = 'Linker::makeBrokenImageLinkObj';
628 wfProfileIn( $fname );
630 $q = 'wpDestFile=' . urlencode( $nt->getDBkey() );
631 if ( '' != $query ) {
634 $uploadTitle = SpecialPage
::getTitleFor( 'Upload' );
635 $url = $uploadTitle->escapeLocalURL( $q );
638 $text = htmlspecialchars( $nt->getPrefixedText() );
640 $style = $this->getInternalLinkAttributesObj( $nt, $text, "yes" );
641 list( $inside, $trail ) = Linker
::splitTrail( $trail );
642 $s = "<a href=\"{$url}\"{$style}>{$prefix}{$text}{$inside}</a>{$trail}";
644 wfProfileOut( $fname );
648 /** @todo document */
649 function makeMediaLink( $name, /* wtf?! */ $url, $alt = '' ) {
650 $nt = Title
::makeTitleSafe( NS_IMAGE
, $name );
651 return $this->makeMediaLinkObj( $nt, $alt );
655 * Create a direct link to a given uploaded file.
657 * @param $title Title object.
658 * @param $text String: pre-sanitized HTML
659 * @return string HTML
662 * @todo Handle invalid or missing images better.
664 function makeMediaLinkObj( $title, $text = '' ) {
665 if( is_null( $title ) ) {
666 ### HOTFIX. Instead of breaking, return empty string.
669 $img = new Image( $title );
670 if( $img->exists() ) {
671 $url = $img->getURL();
674 $upload = SpecialPage
::getTitleFor( 'Upload' );
675 $url = $upload->getLocalUrl( 'wpDestFile=' . urlencode( $img->getName() ) );
678 $alt = htmlspecialchars( $title->getText() );
682 $u = htmlspecialchars( $url );
683 return "<a href=\"{$u}\" class=\"$class\" title=\"{$alt}\">{$text}</a>";
687 /** @todo document */
688 function specialLink( $name, $key = '' ) {
691 if ( '' == $key ) { $key = strtolower( $name ); }
692 $pn = $wgContLang->ucfirst( $name );
693 return $this->makeKnownLink( $wgContLang->specialPage( $pn ),
697 /** @todo document */
698 function makeExternalLink( $url, $text, $escape = true, $linktype = '', $ns = null ) {
699 $style = $this->getExternalLinkAttributes( $url, $text, 'external ' . $linktype );
700 global $wgNoFollowLinks, $wgNoFollowNsExceptions;
701 if( $wgNoFollowLinks && !(isset($ns) && in_array($ns, $wgNoFollowNsExceptions)) ) {
702 $style .= ' rel="nofollow"';
704 $url = htmlspecialchars( $url );
706 $text = htmlspecialchars( $text );
708 return '<a href="'.$url.'"'.$style.'>'.$text.'</a>';
712 * Make user link (or user contributions for unregistered users)
713 * @param $userId Integer: user id in database.
714 * @param $userText String: user name in database
715 * @return string HTML fragment
718 function userLink( $userId, $userText ) {
719 $encName = htmlspecialchars( $userText );
721 $contribsPage = SpecialPage
::getTitleFor( 'Contributions', $userText );
722 return $this->makeKnownLinkObj( $contribsPage,
725 $userPage = Title
::makeTitle( NS_USER
, $userText );
726 return $this->makeLinkObj( $userPage, $encName );
731 * @param $userId Integer: user id in database.
732 * @param $userText String: user name in database.
733 * @param $redContribsWhenNoEdits Bool: return a red contribs link when the user had no edits and this is true.
734 * @return string HTML fragment with talk and/or block links
736 public function userToolLinks( $userId, $userText, $redContribsWhenNoEdits = false ) {
737 global $wgUser, $wgDisableAnonTalk, $wgSysopUserBans;
738 $talkable = !( $wgDisableAnonTalk && 0 == $userId );
739 $blockable = ( $wgSysopUserBans ||
0 == $userId );
743 $items[] = $this->userTalkLink( $userId, $userText );
746 // check if the user has an edit
747 if( $redContribsWhenNoEdits && User
::edits( $userId ) == 0 ) {
748 $style = "class='new'";
752 $contribsPage = SpecialPage
::getTitleFor( 'Contributions', $userText );
754 $items[] = $this->makeKnownLinkObj( $contribsPage, wfMsgHtml( 'contribslink' ), '', '', '', '', $style );
756 if( $blockable && $wgUser->isAllowed( 'block' ) ) {
757 $items[] = $this->blockLink( $userId, $userText );
761 return ' (' . implode( ' | ', $items ) . ')';
768 * Alias for userToolLinks( $userId, $userText, true );
770 public function userToolLinksRedContribs( $userId, $userText ) {
771 return $this->userToolLinks( $userId, $userText, true );
776 * @param $userId Integer: user id in database.
777 * @param $userText String: user name in database.
778 * @return string HTML fragment with user talk link
781 function userTalkLink( $userId, $userText ) {
782 $userTalkPage = Title
::makeTitle( NS_USER_TALK
, $userText );
783 $userTalkLink = $this->makeLinkObj( $userTalkPage, wfMsgHtml( 'talkpagelinktext' ) );
784 return $userTalkLink;
788 * @param $userId Integer: userid
789 * @param $userText String: user name in database.
790 * @return string HTML fragment with block link
793 function blockLink( $userId, $userText ) {
794 $blockPage = SpecialPage
::getTitleFor( 'Blockip', $userText );
795 $blockLink = $this->makeKnownLinkObj( $blockPage,
796 wfMsgHtml( 'blocklink' ) );
801 * Generate a user link if the current user is allowed to view it
802 * @param $rev Revision object.
803 * @return string HTML
805 function revUserLink( $rev ) {
806 if( $rev->userCan( Revision
::DELETED_USER
) ) {
807 $link = $this->userLink( $rev->getRawUser(), $rev->getRawUserText() );
809 $link = wfMsgHtml( 'rev-deleted-user' );
811 if( $rev->isDeleted( Revision
::DELETED_USER
) ) {
812 return '<span class="history-deleted">' . $link . '</span>';
818 * Generate a user tool link cluster if the current user is allowed to view it
819 * @param $rev Revision object.
820 * @return string HTML
822 function revUserTools( $rev ) {
823 if( $rev->userCan( Revision
::DELETED_USER
) ) {
824 $link = $this->userLink( $rev->getRawUser(), $rev->getRawUserText() ) .
826 $this->userToolLinks( $rev->getRawUser(), $rev->getRawUserText() );
828 $link = wfMsgHtml( 'rev-deleted-user' );
830 if( $rev->isDeleted( Revision
::DELETED_USER
) ) {
831 return '<span class="history-deleted">' . $link . '</span>';
837 * This function is called by all recent changes variants, by the page history,
838 * and by the user contributions list. It is responsible for formatting edit
839 * comments. It escapes any HTML in the comment, but adds some CSS to format
840 * auto-generated comments (from section editing) and formats [[wikilinks]].
842 * @author Erik Moeller <moeller@scireview.de>
844 * Note: there's not always a title to pass to this function.
845 * Since you can't set a default parameter for a reference, I've turned it
846 * temporarily to a value pass. Should be adjusted further. --brion
848 * @param string $comment
849 * @param mixed $title Title object (to generate link to the section in autocomment) or null
850 * @param bool $local Whether section links should refer to local page
852 function formatComment($comment, $title = NULL, $local = false) {
853 wfProfileIn( __METHOD__
);
855 # Sanitize text a bit:
856 $comment = str_replace( "\n", " ", $comment );
857 $comment = htmlspecialchars( $comment );
859 # Render autocomments and make links:
860 $comment = $this->formatAutoComments( $comment, $title, $local );
861 $comment = $this->formatLinksInComment( $comment );
863 wfProfileOut( __METHOD__
);
868 * The pattern for autogen comments is / * foo * /, which makes for
870 * We look for all comments, match any text before and after the comment,
871 * add a separator where needed and format the comment itself with CSS
872 * Called by Linker::formatComment.
874 * @param $comment Comment text
875 * @param $title An optional title object used to links to sections
877 * @todo Document the $local parameter.
879 private function formatAutocomments( $comment, $title = NULL, $local = false ) {
881 while (preg_match('!(.*)/\*\s*(.*?)\s*\*/(.*)!', $comment,$match)) {
889 # Generate a valid anchor name from the section title.
890 # Hackish, but should generally work - we strip wiki
891 # syntax, including the magic [[: that is used to
892 # "link rather than show" in case of images and
893 # interlanguage links.
894 $section = str_replace( '[[:', '', $section );
895 $section = str_replace( '[[', '', $section );
896 $section = str_replace( ']]', '', $section );
898 $sectionTitle = Title
::newFromText( '#' . $section);
900 $sectionTitle = wfClone( $title );
901 $sectionTitle->mFragment
= $section;
903 $link = $this->makeKnownLinkObj( $sectionTitle, wfMsg( 'sectionlink' ) );
907 if($pre) { $auto = $sep.' '.$auto; }
908 if($post) { $auto .= ' '.$sep; }
909 $auto='<span class="autocomment">'.$auto.'</span>';
910 $comment=$pre.$auto.$post;
917 * Format regular and media links - all other wiki formatting is ignored
918 * Called by Linker::formatComment.
919 * @param $comment The comment text.
920 * @return Comment text with links using HTML.
922 private function formatLinksInComment( $comment ) {
925 $medians = '(?:' . preg_quote( Namespace::getCanonicalName( NS_MEDIA
), '/' ) . '|';
926 $medians .= preg_quote( $wgContLang->getNsText( NS_MEDIA
), '/' ) . '):';
928 while(preg_match('/\[\[:?(.*?)(\|(.*?))*\]\](.*)$/',$comment,$match)) {
929 # Handle link renaming [[foo|text]] will show link as "text"
930 if( "" != $match[3] ) {
936 if( preg_match( '/^' . $medians . '(.*)$/i', $match[1], $submatch ) ) {
937 # Media link; trail not supported.
938 $linkRegexp = '/\[\[(.*?)\]\]/';
939 $thelink = $this->makeMediaLink( $submatch[1], "", $text );
942 if( preg_match( $wgContLang->linkTrail(), $match[4], $submatch ) ) {
943 $trail = $submatch[1];
947 $linkRegexp = '/\[\[(.*?)\]\]' . preg_quote( $trail, '/' ) . '/';
948 if (isset($match[1][0]) && $match[1][0] == ':')
949 $match[1] = substr($match[1], 1);
950 $thelink = $this->makeLink( $match[1], $text, "", $trail );
952 $comment = preg_replace( $linkRegexp, StringUtils
::escapeRegexReplacement( $thelink ), $comment, 1 );
959 * Wrap a comment in standard punctuation and formatting if
960 * it's non-empty, otherwise return empty string.
962 * @param string $comment
963 * @param mixed $title Title object (to generate link to section in autocomment) or null
964 * @param bool $local Whether section links should refer to local page
968 function commentBlock( $comment, $title = NULL, $local = false ) {
969 // '*' used to be the comment inserted by the software way back
970 // in antiquity in case none was provided, here for backwards
971 // compatability, acc. to brion -ævar
972 if( $comment == '' ||
$comment == '*' ) {
975 $formatted = $this->formatComment( $comment, $title, $local );
976 return " <span class=\"comment\">($formatted)</span>";
981 * Wrap and format the given revision's comment block, if the current
982 * user is allowed to view it.
984 * @param Revision $rev
985 * @param bool $local Whether section links should refer to local page
986 * @return string HTML
988 function revComment( Revision
$rev, $local = false ) {
989 if( $rev->userCan( Revision
::DELETED_COMMENT
) ) {
990 $block = $this->commentBlock( $rev->getRawComment(), $rev->getTitle(), $local );
992 $block = " <span class=\"comment\">" .
993 wfMsgHtml( 'rev-deleted-comment' ) . "</span>";
995 if( $rev->isDeleted( Revision
::DELETED_COMMENT
) ) {
996 return " <span class=\"history-deleted\">$block</span>";
1001 /** @todo document */
1002 function tocIndent() {
1006 /** @todo document */
1007 function tocUnindent($level) {
1008 return "</li>\n" . str_repeat( "</ul>\n</li>\n", $level>0 ?
$level : 0 );
1012 * parameter level defines if we are on an indentation level
1014 function tocLine( $anchor, $tocline, $tocnumber, $level ) {
1015 return "\n<li class=\"toclevel-$level\"><a href=\"#" .
1016 $anchor . '"><span class="tocnumber">' .
1017 $tocnumber . '</span> <span class="toctext">' .
1018 $tocline . '</span></a>';
1021 /** @todo document */
1022 function tocLineEnd() {
1026 /** @todo document */
1027 function tocList($toc) {
1028 global $wgJsMimeType;
1029 $title = wfMsgHtml('toc') ;
1031 '<table id="toc" class="toc" summary="' . $title .'"><tr><td>'
1032 . '<div id="toctitle"><h2>' . $title . "</h2></div>\n"
1034 # no trailing newline, script should not be wrapped in a
1036 . "</ul>\n</td></tr></table>"
1037 . '<script type="' . $wgJsMimeType . '">'
1038 . ' if (window.showTocToggle) {'
1039 . ' var tocShowText = "' . wfEscapeJsString( wfMsg('showtoc') ) . '";'
1040 . ' var tocHideText = "' . wfEscapeJsString( wfMsg('hidetoc') ) . '";'
1041 . ' showTocToggle();'
1046 /** @todo document */
1047 public function editSectionLinkForOther( $title, $section ) {
1050 $title = Title
::newFromText( $title );
1051 $editurl = '§ion='.$section;
1052 $url = $this->makeKnownLinkObj( $title, wfMsg('editsection'), 'action=edit'.$editurl );
1054 return "<span class=\"editsection\">[".$url."]</span>";
1059 * @param $title Title object.
1060 * @param $section Integer: section number.
1061 * @param $hint Link String: title, or default if omitted or empty
1063 public function editSectionLink( $nt, $section, $hint='' ) {
1066 $editurl = '§ion='.$section;
1067 $hint = ( $hint=='' ) ?
'' : ' title="' . wfMsgHtml( 'editsectionhint', htmlspecialchars( $hint ) ) . '"';
1068 $url = $this->makeKnownLinkObj( $nt, wfMsg('editsection'), 'action=edit'.$editurl, '', '', '', $hint );
1070 return "<span class=\"editsection\">[".$url."]</span>";
1074 * Create a headline for content
1076 * @param int $level The level of the headline (1-6)
1077 * @param string $attribs Any attributes for the headline, starting with a space and ending with '>'
1078 * This *must* be at least '>' for no attribs
1079 * @param string $anchor The anchor to give the headline (the bit after the #)
1080 * @param string $text The text of the header
1081 * @param string $link HTML to add for the section edit link
1083 * @return string HTML headline
1085 public function makeHeadline( $level, $attribs, $anchor, $text, $link ) {
1086 return "<a name=\"$anchor\"></a><h$level$attribs$link <span class=\"mw-headline\">$text</span></h$level>";
1090 * Split a link trail, return the "inside" portion and the remainder of the trail
1091 * as a two-element array
1095 static function splitTrail( $trail ) {
1096 static $regex = false;
1097 if ( $regex === false ) {
1099 $regex = $wgContLang->linkTrail();
1102 if ( '' != $trail ) {
1104 if ( preg_match( $regex, $trail, $m ) ) {
1109 return array( $inside, $trail );
1113 * Generate a rollback link for a given revision. Currently it's the
1114 * caller's responsibility to ensure that the revision is the top one. If
1115 * it's not, of course, the user will get an error message.
1117 * If the calling page is called with the parameter &bot=1, all rollback
1118 * links also get that parameter. It causes the edit itself and the rollback
1119 * to be marked as "bot" edits. Bot edits are hidden by default from recent
1120 * changes, so this allows sysops to combat a busy vandal without bothering
1123 * @param Revision $rev
1125 function generateRollback( $rev ) {
1126 global $wgUser, $wgRequest;
1127 $title = $rev->getTitle();
1129 $extraRollback = $wgRequest->getBool( 'bot' ) ?
'&bot=1' : '';
1130 $extraRollback .= '&token=' . urlencode(
1131 $wgUser->editToken( array( $title->getPrefixedText(), $rev->getUserText() ) ) );
1132 return '<span class="mw-rollback-link">['. $this->makeKnownLinkObj( $title,
1133 wfMsg('rollbacklink'),
1134 'action=rollback&from=' . urlencode( $rev->getUserText() ) . $extraRollback ) .']</span>';
1138 * Returns HTML for the "templates used on this page" list.
1140 * @param array $templates Array of templates from Article::getUsedTemplate
1142 * @param bool $preview Whether this is for a preview
1143 * @param bool $section Whether this is for a section edit
1144 * @return string HTML output
1146 public function formatTemplates( $templates, $preview = false, $section = false) {
1148 wfProfileIn( __METHOD__
);
1150 $sk = $wgUser->getSkin();
1153 if ( count( $templates ) > 0 ) {
1154 # Do a batch existence check
1155 $batch = new LinkBatch
;
1156 foreach( $templates as $title ) {
1157 $batch->addObj( $title );
1161 # Construct the HTML
1162 $outText = '<div class="mw-templatesUsedExplanation">';
1164 $outText .= wfMsgExt( 'templatesusedpreview', array( 'parse' ) );
1165 } elseif ( $section ) {
1166 $outText .= wfMsgExt( 'templatesusedsection', array( 'parse' ) );
1168 $outText .= wfMsgExt( 'templatesused', array( 'parse' ) );
1170 $outText .= '</div><ul>';
1172 foreach ( $templates as $titleObj ) {
1173 $r = $titleObj->getRestrictions( 'edit' );
1174 if ( in_array( 'sysop', $r ) ) {
1175 $protected = wfMsgExt( 'template-protected', array( 'parseinline' ) );
1176 } elseif ( in_array( 'autoconfirmed', $r ) ) {
1177 $protected = wfMsgExt( 'template-semiprotected', array( 'parseinline' ) );
1181 $outText .= '<li>' . $sk->makeLinkObj( $titleObj ) . ' ' . $protected . '</li>';
1183 $outText .= '</ul>';
1185 wfProfileOut( __METHOD__
);
1190 * Format a size in bytes for output, using an appropriate
1191 * unit (B, KB, MB or GB) according to the magnitude in question
1193 * @param $size Size to format
1196 public function formatSize( $size ) {
1198 // For small sizes no decimal places necessary
1200 if( $size > 1024 ) {
1201 $size = $size / 1024;
1202 if( $size > 1024 ) {
1203 $size = $size / 1024;
1204 // For MB and bigger two decimal places are smarter
1206 if( $size > 1024 ) {
1207 $size = $size / 1024;
1208 $msg = 'size-gigabytes';
1210 $msg = 'size-megabytes';
1213 $msg = 'size-kilobytes';
1216 $msg = 'size-bytes';
1218 $size = round( $size, $round );
1219 return wfMsgHtml( $msg, $wgLang->formatNum( $size ) );
1223 * Given the id of an interface element, constructs the appropriate title
1224 * and accesskey attributes from the system messages. (Note, this is usu-
1225 * ally the id but isn't always, because sometimes the accesskey needs to
1226 * go on a different element than the id, for reverse-compatibility, etc.)
1228 * @param string $name Id of the element, minus prefixes.
1229 * @return string title and accesskey attributes, ready to drop in an
1230 * element (e.g., ' title="This does something [x]" accesskey="x"').
1232 public function tooltipAndAccesskey($name) {
1235 $tooltip = wfMsg('tooltip-'.$name);
1236 if (!wfEmptyMsg('tooltip-'.$name, $tooltip) && $tooltip != '-') {
1237 // Compatibility: formerly some tooltips had [alt-.] hardcoded
1238 $tooltip = preg_replace( "/ ?\[alt-.\]$/", '', $tooltip );
1239 $out .= ' title="'.htmlspecialchars($tooltip);
1241 $accesskey = wfMsg('accesskey-'.$name);
1242 if ($accesskey && $accesskey != '-' && !wfEmptyMsg('accesskey-'.$name, $accesskey)) {
1243 if ($out) $out .= " [$accesskey]\" accesskey=\"$accesskey\"";
1244 else $out .= " title=\"[$accesskey]\" accesskey=\"$accesskey\"";
1252 * Given the id of an interface element, constructs the appropriate title
1253 * attribute from the system messages. (Note, this is usually the id but
1254 * isn't always, because sometimes the accesskey needs to go on a different
1255 * element than the id, for reverse-compatibility, etc.)
1257 * @param string $name Id of the element, minus prefixes.
1258 * @return string title attribute, ready to drop in an element
1259 * (e.g., ' title="This does something"').
1261 public function tooltip($name) {
1264 $tooltip = wfMsg('tooltip-'.$name);
1265 if (!wfEmptyMsg('tooltip-'.$name, $tooltip) && $tooltip != '-') {
1266 $out = ' title="'.htmlspecialchars($tooltip).'"';