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 = '', $time = false )
445 global $wgContLang, $wgUser, $wgThumbLimits, $wgThumbUpright;
447 $img = wfFindFile( $nt, $time );
449 if ( $img && !$img->allowInlineDisplay() ) {
450 wfDebug( __METHOD__
.': '.$nt->getPrefixedDBkey()." does not allow inline display\n" );
451 return $this->makeKnownLinkObj( $nt );
454 $error = $prefix = $postfix = '';
455 $page = isset( $params['page'] ) ?
$params['page'] : false;
457 if ( 'center' == $align )
459 $prefix = '<div class="center">';
463 if ( $img && !isset( $params['width'] ) ) {
464 $params['width'] = $img->getWidth( $page );
465 if( $thumb ||
$framed ||
isset( $params['frameless'] ) ) {
466 $wopt = $wgUser->getOption( 'thumbsize' );
468 if( !isset( $wgThumbLimits[$wopt] ) ) {
469 $wopt = User
::getDefaultOption( 'thumbsize' );
472 // Reduce width for upright images when parameter 'upright' is used
473 if ( !isset( $params['upright_factor'] ) ||
$params['upright_factor'] == 0 ) {
474 $params['upright_factor'] = $wgThumbUpright;
476 // Use width which is smaller: real image width or user preference width
477 // 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
478 $params['width'] = min( $params['width'], isset( $params['upright'] ) ?
round( $wgThumbLimits[$wopt] * $params['upright_factor'], -1 ) : $wgThumbLimits[$wopt] );
482 if ( $thumb ||
$framed ) {
484 # Create a thumbnail. Alignment depends on language
485 # writing direction, # right aligned for left-to-right-
486 # languages ("Western languages"), left-aligned
487 # for right-to-left-languages ("Semitic languages")
489 # If thumbnail width has not been provided, it is set
490 # to the default user option as specified in Language*.php
491 if ( $align == '' ) {
492 $align = $wgContLang->isRTL() ?
'left' : 'right';
494 return $prefix.$this->makeThumbLinkObj( $nt, $img, $label, $alt, $align, $params, $framed, $manual_thumb ).$postfix;
497 if ( $img && $params['width'] ) {
498 # Create a resized image, without the additional thumbnail features
499 $thumb = $img->transform( $params );
505 $query = 'page=' . urlencode( $page );
509 $u = $nt->getLocalURL( $query );
516 $imgAttribs['style'] = "vertical-align: $valign";
518 if ( isset( $params['border'] ) ) {
519 $imgAttribs['class'] = "thumbborder";
521 $linkAttribs = array(
528 $s = $this->makeBrokenImageLinkObj( $nt );
530 $s = $thumb->toHtml( $imgAttribs, $linkAttribs );
532 if ( '' != $align ) {
533 $s = "<div class=\"float{$align}\"><span>{$s}</span></div>";
535 return str_replace("\n", ' ',$prefix.$s.$postfix);
539 * Make HTML for a thumbnail including image, border and caption
541 * @param Image $img Image object or false if it doesn't exist
543 function makeThumbLinkObj( Title
$nt, $img, $label = '', $alt, $align = 'right', $params = array(), $framed=false , $manual_thumb = "" ) {
544 global $wgStylePath, $wgContLang;
545 $exists = $img && $img->exists();
547 $page = isset( $params['page'] ) ?
$params['page'] : false;
549 if ( empty( $params['width'] ) ) {
550 // Reduce width for upright images when parameter 'upright' is used
551 $params['width'] = isset( $params['upright'] ) ?
130 : 180;
556 $outerWidth = $params['width'] +
2;
558 if ( $manual_thumb != '' ) {
559 # Use manually specified thumbnail
560 $manual_title = Title
::makeTitleSafe( NS_IMAGE
, $manual_thumb );
561 if( $manual_title ) {
562 $manual_img = wfFindFile( $manual_title );
564 $thumb = $manual_img->getUnscaledThumb();
569 } elseif ( $framed ) {
570 // Use image dimensions, don't scale
571 $thumb = $img->getUnscaledThumb( $page );
573 # Do not present an image bigger than the source, for bitmap-style images
574 # This is a hack to maintain compatibility with arbitrary pre-1.10 behaviour
575 $srcWidth = $img->getWidth( $page );
576 if ( $srcWidth && !$img->mustRender() && $params['width'] > $srcWidth ) {
577 $params['width'] = $srcWidth;
579 $thumb = $img->transform( $params );
583 $outerWidth = $thumb->getWidth() +
2;
585 $outerWidth = $params['width'] +
2;
589 $query = $page ?
'page=' . urlencode( $page ) : '';
590 $u = $nt->getLocalURL( $query );
592 $more = htmlspecialchars( wfMsg( 'thumbnail-more' ) );
593 $magnifyalign = $wgContLang->isRTL() ?
'left' : 'right';
594 $textalign = $wgContLang->isRTL() ?
' style="text-align:right"' : '';
596 $s = "<div class=\"thumb t{$align}\"><div class=\"thumbinner\" style=\"width:{$outerWidth}px;\">";
598 $s .= $this->makeBrokenImageLinkObj( $nt );
600 } elseif ( !$thumb ) {
601 $s .= htmlspecialchars( wfMsg( 'thumbnail_error', '' ) );
607 'class' => 'thumbimage'
609 $linkAttribs = array(
611 'class' => 'internal',
615 $s .= $thumb->toHtml( $imgAttribs, $linkAttribs );
619 $zoomicon = '<div class="magnify" style="float:'.$magnifyalign.'">'.
620 '<a href="'.$u.'" class="internal" title="'.$more.'">'.
621 '<img src="'.$wgStylePath.'/common/images/magnify-clip.png" ' .
622 'width="15" height="11" alt="" /></a></div>';
625 $s .= ' <div class="thumbcaption"'.$textalign.'>'.$zoomicon.$label."</div></div></div>";
626 return str_replace("\n", ' ', $s);
630 * Make a "broken" link to an image
632 * @param Title $title Image title
633 * @param string $text Link label
634 * @param string $query Query string
635 * @param string $trail Link trail
636 * @param string $prefix Link prefix
639 public function makeBrokenImageLinkObj( $title, $text = '', $query = '', $trail = '', $prefix = '' ) {
640 global $wgEnableUploads;
641 if( $title instanceof Title
) {
642 wfProfileIn( __METHOD__
);
643 if( $wgEnableUploads ) {
644 $upload = SpecialPage
::getTitleFor( 'Upload' );
646 $text = htmlspecialchars( $title->getPrefixedText() );
647 $q = 'wpDestFile=' . $title->getPrefixedUrl();
650 list( $inside, $trail ) = self
::splitTrail( $trail );
651 $style = $this->getInternalLinkAttributesObj( $title, $text, 'yes' );
652 wfProfileOut( __METHOD__
);
653 return '<a href="' . $upload->escapeLocalUrl( $q ) . '"'
654 . $style . '>' . $prefix . $text . $inside . '</a>' . $trail;
656 wfProfileOut( __METHOD__
);
657 return $this->makeKnownLinkObj( $title, $text, $query, $trail, $prefix );
660 return "<!-- ERROR -->{$prefix}{$text}{$trail}";
664 /** @deprecated use Linker::makeMediaLinkObj() */
665 function makeMediaLink( $name, $unused = '', $text = '' ) {
666 $nt = Title
::makeTitleSafe( NS_IMAGE
, $name );
667 return $this->makeMediaLinkObj( $nt, $text );
671 * Create a direct link to a given uploaded file.
673 * @param $title Title object.
674 * @param $text String: pre-sanitized HTML
675 * @return string HTML
678 * @todo Handle invalid or missing images better.
680 function makeMediaLinkObj( $title, $text = '' ) {
681 if( is_null( $title ) ) {
682 ### HOTFIX. Instead of breaking, return empty string.
685 $img = wfFindFile( $title );
687 $url = $img->getURL();
690 $upload = SpecialPage
::getTitleFor( 'Upload' );
691 $url = $upload->getLocalUrl( 'wpDestFile=' . urlencode( $title->getDbKey() ) );
694 $alt = htmlspecialchars( $title->getText() );
698 $u = htmlspecialchars( $url );
699 return "<a href=\"{$u}\" class=\"$class\" title=\"{$alt}\">{$text}</a>";
703 /** @todo document */
704 function specialLink( $name, $key = '' ) {
707 if ( '' == $key ) { $key = strtolower( $name ); }
708 $pn = $wgContLang->ucfirst( $name );
709 return $this->makeKnownLink( $wgContLang->specialPage( $pn ),
713 /** @todo document */
714 function makeExternalLink( $url, $text, $escape = true, $linktype = '', $ns = null ) {
715 $style = $this->getExternalLinkAttributes( $url, $text, 'external ' . $linktype );
716 global $wgNoFollowLinks, $wgNoFollowNsExceptions;
717 if( $wgNoFollowLinks && !(isset($ns) && in_array($ns, $wgNoFollowNsExceptions)) ) {
718 $style .= ' rel="nofollow"';
720 $url = htmlspecialchars( $url );
722 $text = htmlspecialchars( $text );
724 return '<a href="'.$url.'"'.$style.'>'.$text.'</a>';
728 * Make user link (or user contributions for unregistered users)
729 * @param $userId Integer: user id in database.
730 * @param $userText String: user name in database
731 * @return string HTML fragment
734 function userLink( $userId, $userText ) {
735 $encName = htmlspecialchars( $userText );
737 $contribsPage = SpecialPage
::getTitleFor( 'Contributions', $userText );
738 return $this->makeKnownLinkObj( $contribsPage,
741 $userPage = Title
::makeTitle( NS_USER
, $userText );
742 return $this->makeLinkObj( $userPage, $encName );
747 * @param $userId Integer: user id in database.
748 * @param $userText String: user name in database.
749 * @param $redContribsWhenNoEdits Bool: return a red contribs link when the user had no edits and this is true.
750 * @return string HTML fragment with talk and/or block links
752 public function userToolLinks( $userId, $userText, $redContribsWhenNoEdits = false ) {
753 global $wgUser, $wgDisableAnonTalk, $wgSysopUserBans;
754 $talkable = !( $wgDisableAnonTalk && 0 == $userId );
755 $blockable = ( $wgSysopUserBans ||
0 == $userId );
759 $items[] = $this->userTalkLink( $userId, $userText );
762 // check if the user has an edit
763 if( $redContribsWhenNoEdits && User
::edits( $userId ) == 0 ) {
764 $style = "class='new'";
768 $contribsPage = SpecialPage
::getTitleFor( 'Contributions', $userText );
770 $items[] = $this->makeKnownLinkObj( $contribsPage, wfMsgHtml( 'contribslink' ), '', '', '', '', $style );
772 if( $blockable && $wgUser->isAllowed( 'block' ) ) {
773 $items[] = $this->blockLink( $userId, $userText );
777 return ' (' . implode( ' | ', $items ) . ')';
784 * Alias for userToolLinks( $userId, $userText, true );
786 public function userToolLinksRedContribs( $userId, $userText ) {
787 return $this->userToolLinks( $userId, $userText, true );
792 * @param $userId Integer: user id in database.
793 * @param $userText String: user name in database.
794 * @return string HTML fragment with user talk link
797 function userTalkLink( $userId, $userText ) {
798 $userTalkPage = Title
::makeTitle( NS_USER_TALK
, $userText );
799 $userTalkLink = $this->makeLinkObj( $userTalkPage, wfMsgHtml( 'talkpagelinktext' ) );
800 return $userTalkLink;
804 * @param $userId Integer: userid
805 * @param $userText String: user name in database.
806 * @return string HTML fragment with block link
809 function blockLink( $userId, $userText ) {
810 $blockPage = SpecialPage
::getTitleFor( 'Blockip', $userText );
811 $blockLink = $this->makeKnownLinkObj( $blockPage,
812 wfMsgHtml( 'blocklink' ) );
817 * Generate a user link if the current user is allowed to view it
818 * @param $rev Revision object.
819 * @return string HTML
821 function revUserLink( $rev ) {
822 if( $rev->userCan( Revision
::DELETED_USER
) ) {
823 $link = $this->userLink( $rev->getRawUser(), $rev->getRawUserText() );
825 $link = wfMsgHtml( 'rev-deleted-user' );
827 if( $rev->isDeleted( Revision
::DELETED_USER
) ) {
828 return '<span class="history-deleted">' . $link . '</span>';
834 * Generate a user tool link cluster if the current user is allowed to view it
835 * @param $rev Revision object.
836 * @return string HTML
838 function revUserTools( $rev ) {
839 if( $rev->userCan( Revision
::DELETED_USER
) ) {
840 $link = $this->userLink( $rev->getRawUser(), $rev->getRawUserText() ) .
842 $this->userToolLinks( $rev->getRawUser(), $rev->getRawUserText() );
844 $link = wfMsgHtml( 'rev-deleted-user' );
846 if( $rev->isDeleted( Revision
::DELETED_USER
) ) {
847 return '<span class="history-deleted">' . $link . '</span>';
853 * This function is called by all recent changes variants, by the page history,
854 * and by the user contributions list. It is responsible for formatting edit
855 * comments. It escapes any HTML in the comment, but adds some CSS to format
856 * auto-generated comments (from section editing) and formats [[wikilinks]].
858 * @author Erik Moeller <moeller@scireview.de>
860 * Note: there's not always a title to pass to this function.
861 * Since you can't set a default parameter for a reference, I've turned it
862 * temporarily to a value pass. Should be adjusted further. --brion
864 * @param string $comment
865 * @param mixed $title Title object (to generate link to the section in autocomment) or null
866 * @param bool $local Whether section links should refer to local page
868 function formatComment($comment, $title = NULL, $local = false) {
869 wfProfileIn( __METHOD__
);
871 # Sanitize text a bit:
872 $comment = str_replace( "\n", " ", $comment );
873 $comment = htmlspecialchars( $comment );
875 # Render autocomments and make links:
876 $comment = $this->formatAutoComments( $comment, $title, $local );
877 $comment = $this->formatLinksInComment( $comment );
879 wfProfileOut( __METHOD__
);
884 * The pattern for autogen comments is / * foo * /, which makes for
886 * We look for all comments, match any text before and after the comment,
887 * add a separator where needed and format the comment itself with CSS
888 * Called by Linker::formatComment.
890 * @param $comment Comment text
891 * @param $title An optional title object used to links to sections
893 * @todo Document the $local parameter.
895 private function formatAutocomments( $comment, $title = NULL, $local = false ) {
897 while (preg_match('!(.*)/\*\s*(.*?)\s*\*/(.*)!', $comment,$match)) {
905 # Generate a valid anchor name from the section title.
906 # Hackish, but should generally work - we strip wiki
907 # syntax, including the magic [[: that is used to
908 # "link rather than show" in case of images and
909 # interlanguage links.
910 $section = str_replace( '[[:', '', $section );
911 $section = str_replace( '[[', '', $section );
912 $section = str_replace( ']]', '', $section );
914 $sectionTitle = Title
::newFromText( '#' . $section);
916 $sectionTitle = wfClone( $title );
917 $sectionTitle->mFragment
= $section;
919 $link = $this->makeKnownLinkObj( $sectionTitle, wfMsg( 'sectionlink' ) );
923 if($pre) { $auto = $sep.' '.$auto; }
924 if($post) { $auto .= ' '.$sep; }
925 $auto='<span class="autocomment">'.$auto.'</span>';
926 $comment=$pre.$auto.$post;
933 * Formats wiki links and media links in text; all other wiki formatting
936 * @param string $comment Text to format links in
939 public function formatLinksInComment( $comment ) {
942 $medians = '(?:' . preg_quote( Namespace::getCanonicalName( NS_MEDIA
), '/' ) . '|';
943 $medians .= preg_quote( $wgContLang->getNsText( NS_MEDIA
), '/' ) . '):';
945 while(preg_match('/\[\[:?(.*?)(\|(.*?))*\]\](.*)$/',$comment,$match)) {
946 # Handle link renaming [[foo|text]] will show link as "text"
947 if( "" != $match[3] ) {
953 if( preg_match( '/^' . $medians . '(.*)$/i', $match[1], $submatch ) ) {
954 # Media link; trail not supported.
955 $linkRegexp = '/\[\[(.*?)\]\]/';
956 $thelink = $this->makeMediaLink( $submatch[1], "", $text );
959 if( preg_match( $wgContLang->linkTrail(), $match[4], $submatch ) ) {
960 $trail = $submatch[1];
964 $linkRegexp = '/\[\[(.*?)\]\]' . preg_quote( $trail, '/' ) . '/';
965 if (isset($match[1][0]) && $match[1][0] == ':')
966 $match[1] = substr($match[1], 1);
967 $thelink = $this->makeLink( $match[1], $text, "", $trail );
969 $comment = preg_replace( $linkRegexp, StringUtils
::escapeRegexReplacement( $thelink ), $comment, 1 );
976 * Wrap a comment in standard punctuation and formatting if
977 * it's non-empty, otherwise return empty string.
979 * @param string $comment
980 * @param mixed $title Title object (to generate link to section in autocomment) or null
981 * @param bool $local Whether section links should refer to local page
985 function commentBlock( $comment, $title = NULL, $local = false ) {
986 // '*' used to be the comment inserted by the software way back
987 // in antiquity in case none was provided, here for backwards
988 // compatability, acc. to brion -ævar
989 if( $comment == '' ||
$comment == '*' ) {
992 $formatted = $this->formatComment( $comment, $title, $local );
993 return " <span class=\"comment\">($formatted)</span>";
998 * Wrap and format the given revision's comment block, if the current
999 * user is allowed to view it.
1001 * @param Revision $rev
1002 * @param bool $local Whether section links should refer to local page
1003 * @return string HTML
1005 function revComment( Revision
$rev, $local = false ) {
1006 if( $rev->userCan( Revision
::DELETED_COMMENT
) ) {
1007 $block = $this->commentBlock( $rev->getRawComment(), $rev->getTitle(), $local );
1009 $block = " <span class=\"comment\">" .
1010 wfMsgHtml( 'rev-deleted-comment' ) . "</span>";
1012 if( $rev->isDeleted( Revision
::DELETED_COMMENT
) ) {
1013 return " <span class=\"history-deleted\">$block</span>";
1018 /** @todo document */
1019 function tocIndent() {
1023 /** @todo document */
1024 function tocUnindent($level) {
1025 return "</li>\n" . str_repeat( "</ul>\n</li>\n", $level>0 ?
$level : 0 );
1029 * parameter level defines if we are on an indentation level
1031 function tocLine( $anchor, $tocline, $tocnumber, $level ) {
1032 return "\n<li class=\"toclevel-$level\"><a href=\"#" .
1033 $anchor . '"><span class="tocnumber">' .
1034 $tocnumber . '</span> <span class="toctext">' .
1035 $tocline . '</span></a>';
1038 /** @todo document */
1039 function tocLineEnd() {
1043 /** @todo document */
1044 function tocList($toc) {
1045 global $wgJsMimeType;
1046 $title = wfMsgHtml('toc') ;
1048 '<table id="toc" class="toc" summary="' . $title .'"><tr><td>'
1049 . '<div id="toctitle"><h2>' . $title . "</h2></div>\n"
1051 # no trailing newline, script should not be wrapped in a
1053 . "</ul>\n</td></tr></table>"
1054 . '<script type="' . $wgJsMimeType . '">'
1055 . ' if (window.showTocToggle) {'
1056 . ' var tocShowText = "' . wfEscapeJsString( wfMsg('showtoc') ) . '";'
1057 . ' var tocHideText = "' . wfEscapeJsString( wfMsg('hidetoc') ) . '";'
1058 . ' showTocToggle();'
1063 /** @todo document */
1064 public function editSectionLinkForOther( $title, $section ) {
1066 $title = Title
::newFromText( $title );
1067 $editurl = '§ion='.$section;
1068 $url = $this->makeKnownLinkObj( $title, wfMsg('editsection'), 'action=edit'.$editurl );
1070 wfRunHooks( 'EditSectionLinkForOther', array( &$this, $title, $section, $url, &$result ) );
1071 return is_null( $result )
1072 ?
"<span class=\"editsection\">[{$url}]</span>"
1073 : "<span class=\"editsection\">[{$result}]</span>";
1077 * @param $title Title object.
1078 * @param $section Integer: section number.
1079 * @param $hint Link String: title, or default if omitted or empty
1081 public function editSectionLink( $nt, $section, $hint='' ) {
1083 $editurl = '§ion='.$section;
1084 $hint = ( $hint=='' ) ?
'' : ' title="' . wfMsgHtml( 'editsectionhint', htmlspecialchars( $hint ) ) . '"';
1085 $url = $this->makeKnownLinkObj( $nt, wfMsg('editsection'), 'action=edit'.$editurl, '', '', '', $hint );
1087 wfRunHooks( 'EditSectionLink', array( &$this, $nt, $section, $hint, $url, &$result ) );
1088 return is_null( $result )
1089 ?
"<span class=\"editsection\">[{$url}]</span>"
1090 : "<span class=\"editsection\">[{$result}]</span>";
1094 * Create a headline for content
1096 * @param int $level The level of the headline (1-6)
1097 * @param string $attribs Any attributes for the headline, starting with a space and ending with '>'
1098 * This *must* be at least '>' for no attribs
1099 * @param string $anchor The anchor to give the headline (the bit after the #)
1100 * @param string $text The text of the header
1101 * @param string $link HTML to add for the section edit link
1103 * @return string HTML headline
1105 public function makeHeadline( $level, $attribs, $anchor, $text, $link ) {
1106 return "<a name=\"$anchor\"></a><h$level$attribs$link <span class=\"mw-headline\">$text</span></h$level>";
1110 * Split a link trail, return the "inside" portion and the remainder of the trail
1111 * as a two-element array
1115 static function splitTrail( $trail ) {
1116 static $regex = false;
1117 if ( $regex === false ) {
1119 $regex = $wgContLang->linkTrail();
1122 if ( '' != $trail ) {
1124 if ( preg_match( $regex, $trail, $m ) ) {
1129 return array( $inside, $trail );
1133 * Generate a rollback link for a given revision. Currently it's the
1134 * caller's responsibility to ensure that the revision is the top one. If
1135 * it's not, of course, the user will get an error message.
1137 * If the calling page is called with the parameter &bot=1, all rollback
1138 * links also get that parameter. It causes the edit itself and the rollback
1139 * to be marked as "bot" edits. Bot edits are hidden by default from recent
1140 * changes, so this allows sysops to combat a busy vandal without bothering
1143 * @param Revision $rev
1145 function generateRollback( $rev ) {
1146 global $wgUser, $wgRequest;
1147 $title = $rev->getTitle();
1149 $extraRollback = $wgRequest->getBool( 'bot' ) ?
'&bot=1' : '';
1150 $extraRollback .= '&token=' . urlencode(
1151 $wgUser->editToken( array( $title->getPrefixedText(), $rev->getUserText() ) ) );
1152 return '<span class="mw-rollback-link">['. $this->makeKnownLinkObj( $title,
1153 wfMsg('rollbacklink'),
1154 'action=rollback&from=' . urlencode( $rev->getUserText() ) . $extraRollback ) .']</span>';
1158 * Returns HTML for the "templates used on this page" list.
1160 * @param array $templates Array of templates from Article::getUsedTemplate
1162 * @param bool $preview Whether this is for a preview
1163 * @param bool $section Whether this is for a section edit
1164 * @return string HTML output
1166 public function formatTemplates( $templates, $preview = false, $section = false) {
1168 wfProfileIn( __METHOD__
);
1170 $sk = $wgUser->getSkin();
1173 if ( count( $templates ) > 0 ) {
1174 # Do a batch existence check
1175 $batch = new LinkBatch
;
1176 foreach( $templates as $title ) {
1177 $batch->addObj( $title );
1181 # Construct the HTML
1182 $outText = '<div class="mw-templatesUsedExplanation">';
1184 $outText .= wfMsgExt( 'templatesusedpreview', array( 'parse' ) );
1185 } elseif ( $section ) {
1186 $outText .= wfMsgExt( 'templatesusedsection', array( 'parse' ) );
1188 $outText .= wfMsgExt( 'templatesused', array( 'parse' ) );
1190 $outText .= '</div><ul>';
1192 foreach ( $templates as $titleObj ) {
1193 $r = $titleObj->getRestrictions( 'edit' );
1194 if ( in_array( 'sysop', $r ) ) {
1195 $protected = wfMsgExt( 'template-protected', array( 'parseinline' ) );
1196 } elseif ( in_array( 'autoconfirmed', $r ) ) {
1197 $protected = wfMsgExt( 'template-semiprotected', array( 'parseinline' ) );
1201 $outText .= '<li>' . $sk->makeLinkObj( $titleObj ) . ' ' . $protected . '</li>';
1203 $outText .= '</ul>';
1205 wfProfileOut( __METHOD__
);
1210 * Format a size in bytes for output, using an appropriate
1211 * unit (B, KB, MB or GB) according to the magnitude in question
1213 * @param $size Size to format
1216 public function formatSize( $size ) {
1218 // For small sizes no decimal places necessary
1220 if( $size > 1024 ) {
1221 $size = $size / 1024;
1222 if( $size > 1024 ) {
1223 $size = $size / 1024;
1224 // For MB and bigger two decimal places are smarter
1226 if( $size > 1024 ) {
1227 $size = $size / 1024;
1228 $msg = 'size-gigabytes';
1230 $msg = 'size-megabytes';
1233 $msg = 'size-kilobytes';
1236 $msg = 'size-bytes';
1238 $size = round( $size, $round );
1239 return wfMsgHtml( $msg, $wgLang->formatNum( $size ) );
1243 * Given the id of an interface element, constructs the appropriate title
1244 * and accesskey attributes from the system messages. (Note, this is usu-
1245 * ally the id but isn't always, because sometimes the accesskey needs to
1246 * go on a different element than the id, for reverse-compatibility, etc.)
1248 * @param string $name Id of the element, minus prefixes.
1249 * @return string title and accesskey attributes, ready to drop in an
1250 * element (e.g., ' title="This does something [x]" accesskey="x"').
1252 public function tooltipAndAccesskey($name) {
1255 $tooltip = wfMsg('tooltip-'.$name);
1256 if (!wfEmptyMsg('tooltip-'.$name, $tooltip) && $tooltip != '-') {
1257 // Compatibility: formerly some tooltips had [alt-.] hardcoded
1258 $tooltip = preg_replace( "/ ?\[alt-.\]$/", '', $tooltip );
1259 $out .= ' title="'.htmlspecialchars($tooltip);
1261 $accesskey = wfMsg('accesskey-'.$name);
1262 if ($accesskey && $accesskey != '-' && !wfEmptyMsg('accesskey-'.$name, $accesskey)) {
1263 if ($out) $out .= " [$accesskey]\" accesskey=\"$accesskey\"";
1264 else $out .= " title=\"[$accesskey]\" accesskey=\"$accesskey\"";
1272 * Given the id of an interface element, constructs the appropriate title
1273 * attribute from the system messages. (Note, this is usually the id but
1274 * isn't always, because sometimes the accesskey needs to go on a different
1275 * element than the id, for reverse-compatibility, etc.)
1277 * @param string $name Id of the element, minus prefixes.
1278 * @return string title attribute, ready to drop in an element
1279 * (e.g., ' title="This does something"').
1281 public function tooltip($name) {
1284 $tooltip = wfMsg('tooltip-'.$name);
1285 if (!wfEmptyMsg('tooltip-'.$name, $tooltip) && $tooltip != '-') {
1286 $out = ' title="'.htmlspecialchars($tooltip).'"';