MediaWiki REL1_30
Linker.php
Go to the documentation of this file.
1<?php
24
34class Linker {
40
51 public static function getLinkColour( LinkTarget $t, $threshold ) {
52 wfDeprecated( __METHOD__, '1.28' );
53 $services = MediaWikiServices::getInstance();
54 $linkRenderer = $services->getLinkRenderer();
55 if ( $threshold !== $linkRenderer->getStubThreshold() ) {
56 // Need to create a new instance with the right stub threshold...
57 $linkRenderer = $services->getLinkRendererFactory()->create();
58 $linkRenderer->setStubThreshold( $threshold );
59 }
60
61 return $linkRenderer->getLinkClasses( $t );
62 }
63
107 public static function link(
108 $target, $html = null, $customAttribs = [], $query = [], $options = []
109 ) {
110 if ( !$target instanceof LinkTarget ) {
111 wfWarn( __METHOD__ . ': Requires $target to be a LinkTarget object.', 2 );
112 return "<!-- ERROR -->$html";
113 }
114
115 if ( is_string( $query ) ) {
116 // some functions withing core using this still hand over query strings
117 wfDeprecated( __METHOD__ . ' with parameter $query as string (should be array)', '1.20' );
119 }
120
121 $services = MediaWikiServices::getInstance();
123 if ( $options ) {
124 // Custom options, create new LinkRenderer
125 if ( !isset( $options['stubThreshold'] ) ) {
126 $defaultLinkRenderer = $services->getLinkRenderer();
127 $options['stubThreshold'] = $defaultLinkRenderer->getStubThreshold();
128 }
129 $linkRenderer = $services->getLinkRendererFactory()
130 ->createFromLegacyOptions( $options );
131 } else {
132 $linkRenderer = $services->getLinkRenderer();
133 }
134
135 if ( $html !== null ) {
136 $text = new HtmlArmor( $html );
137 } else {
138 $text = $html; // null
139 }
140 if ( in_array( 'known', $options, true ) ) {
141 return $linkRenderer->makeKnownLink( $target, $text, $customAttribs, $query );
142 } elseif ( in_array( 'broken', $options, true ) ) {
143 return $linkRenderer->makeBrokenLink( $target, $text, $customAttribs, $query );
144 } elseif ( in_array( 'noclasses', $options, true ) ) {
145 return $linkRenderer->makePreloadedLink( $target, $text, '', $customAttribs, $query );
146 } else {
147 return $linkRenderer->makeLink( $target, $text, $customAttribs, $query );
148 }
149 }
150
164 public static function linkKnown(
165 $target, $html = null, $customAttribs = [],
166 $query = [], $options = [ 'known' ]
167 ) {
168 return self::link( $target, $html, $customAttribs, $query, $options );
169 }
170
186 public static function makeSelfLinkObj( $nt, $html = '', $query = '', $trail = '', $prefix = '' ) {
187 $ret = "<a class=\"mw-selflink selflink\">{$prefix}{$html}</a>{$trail}";
188 if ( !Hooks::run( 'SelfLinkBegin', [ $nt, &$html, &$trail, &$prefix, &$ret ] ) ) {
189 return $ret;
190 }
191
192 if ( $html == '' ) {
193 $html = htmlspecialchars( $nt->getPrefixedText() );
194 }
195 list( $inside, $trail ) = self::splitTrail( $trail );
196 return "<a class=\"mw-selflink selflink\">{$prefix}{$html}{$inside}</a>{$trail}";
197 }
198
209 public static function getInvalidTitleDescription( IContextSource $context, $namespace, $title ) {
211
212 // First we check whether the namespace exists or not.
213 if ( MWNamespace::exists( $namespace ) ) {
214 if ( $namespace == NS_MAIN ) {
215 $name = $context->msg( 'blanknamespace' )->text();
216 } else {
217 $name = $wgContLang->getFormattedNsText( $namespace );
218 }
219 return $context->msg( 'invalidtitle-knownnamespace', $namespace, $name, $title )->text();
220 } else {
221 return $context->msg( 'invalidtitle-unknownnamespace', $namespace, $title )->text();
222 }
223 }
224
230 public static function normaliseSpecialPage( LinkTarget $target ) {
231 if ( $target->getNamespace() == NS_SPECIAL && !$target->isExternal() ) {
232 list( $name, $subpage ) = SpecialPageFactory::resolveAlias( $target->getDBkey() );
233 if ( !$name ) {
234 return $target;
235 }
236 $ret = SpecialPage::getTitleValueFor( $name, $subpage, $target->getFragment() );
237 return $ret;
238 } else {
239 return $target;
240 }
241 }
242
251 private static function fnamePart( $url ) {
252 $basename = strrchr( $url, '/' );
253 if ( false === $basename ) {
254 $basename = $url;
255 } else {
256 $basename = substr( $basename, 1 );
257 }
258 return $basename;
259 }
260
271 public static function makeExternalImage( $url, $alt = '' ) {
272 if ( $alt == '' ) {
273 $alt = self::fnamePart( $url );
274 }
275 $img = '';
276 $success = Hooks::run( 'LinkerMakeExternalImage', [ &$url, &$alt, &$img ] );
277 if ( !$success ) {
278 wfDebug( "Hook LinkerMakeExternalImage changed the output of external image "
279 . "with url {$url} and alt text {$alt} to {$img}\n", true );
280 return $img;
281 }
282 return Html::element( 'img',
283 [
284 'src' => $url,
285 'alt' => $alt ] );
286 }
287
324 public static function makeImageLink( Parser $parser, Title $title,
325 $file, $frameParams = [], $handlerParams = [], $time = false,
326 $query = "", $widthOption = null
327 ) {
328 $res = null;
329 $dummy = new DummyLinker;
330 if ( !Hooks::run( 'ImageBeforeProduceHTML', [ &$dummy, &$title,
331 &$file, &$frameParams, &$handlerParams, &$time, &$res ] ) ) {
332 return $res;
333 }
334
335 if ( $file && !$file->allowInlineDisplay() ) {
336 wfDebug( __METHOD__ . ': ' . $title->getPrefixedDBkey() . " does not allow inline display\n" );
337 return self::link( $title );
338 }
339
340 // Clean up parameters
341 $page = isset( $handlerParams['page'] ) ? $handlerParams['page'] : false;
342 if ( !isset( $frameParams['align'] ) ) {
343 $frameParams['align'] = '';
344 }
345 if ( !isset( $frameParams['alt'] ) ) {
346 $frameParams['alt'] = '';
347 }
348 if ( !isset( $frameParams['title'] ) ) {
349 $frameParams['title'] = '';
350 }
351 if ( !isset( $frameParams['class'] ) ) {
352 $frameParams['class'] = '';
353 }
354
355 $prefix = $postfix = '';
356
357 if ( 'center' == $frameParams['align'] ) {
358 $prefix = '<div class="center">';
359 $postfix = '</div>';
360 $frameParams['align'] = 'none';
361 }
362 if ( $file && !isset( $handlerParams['width'] ) ) {
363 if ( isset( $handlerParams['height'] ) && $file->isVectorized() ) {
364 // If its a vector image, and user only specifies height
365 // we don't want it to be limited by its "normal" width.
367 $handlerParams['width'] = $wgSVGMaxSize;
368 } else {
369 $handlerParams['width'] = $file->getWidth( $page );
370 }
371
372 if ( isset( $frameParams['thumbnail'] )
373 || isset( $frameParams['manualthumb'] )
374 || isset( $frameParams['framed'] )
375 || isset( $frameParams['frameless'] )
376 || !$handlerParams['width']
377 ) {
379
380 if ( $widthOption === null || !isset( $wgThumbLimits[$widthOption] ) ) {
381 $widthOption = User::getDefaultOption( 'thumbsize' );
382 }
383
384 // Reduce width for upright images when parameter 'upright' is used
385 if ( isset( $frameParams['upright'] ) && $frameParams['upright'] == 0 ) {
386 $frameParams['upright'] = $wgThumbUpright;
387 }
388
389 // For caching health: If width scaled down due to upright
390 // parameter, round to full __0 pixel to avoid the creation of a
391 // lot of odd thumbs.
392 $prefWidth = isset( $frameParams['upright'] ) ?
393 round( $wgThumbLimits[$widthOption] * $frameParams['upright'], -1 ) :
394 $wgThumbLimits[$widthOption];
395
396 // Use width which is smaller: real image width or user preference width
397 // Unless image is scalable vector.
398 if ( !isset( $handlerParams['height'] ) && ( $handlerParams['width'] <= 0 ||
399 $prefWidth < $handlerParams['width'] || $file->isVectorized() ) ) {
400 $handlerParams['width'] = $prefWidth;
401 }
402 }
403 }
404
405 if ( isset( $frameParams['thumbnail'] ) || isset( $frameParams['manualthumb'] )
406 || isset( $frameParams['framed'] )
407 ) {
408 # Create a thumbnail. Alignment depends on the writing direction of
409 # the page content language (right-aligned for LTR languages,
410 # left-aligned for RTL languages)
411 # If a thumbnail width has not been provided, it is set
412 # to the default user option as specified in Language*.php
413 if ( $frameParams['align'] == '' ) {
414 $frameParams['align'] = $parser->getTargetLanguage()->alignEnd();
415 }
416 return $prefix .
417 self::makeThumbLink2( $title, $file, $frameParams, $handlerParams, $time, $query ) .
418 $postfix;
419 }
420
421 if ( $file && isset( $frameParams['frameless'] ) ) {
422 $srcWidth = $file->getWidth( $page );
423 # For "frameless" option: do not present an image bigger than the
424 # source (for bitmap-style images). This is the same behavior as the
425 # "thumb" option does it already.
426 if ( $srcWidth && !$file->mustRender() && $handlerParams['width'] > $srcWidth ) {
427 $handlerParams['width'] = $srcWidth;
428 }
429 }
430
431 if ( $file && isset( $handlerParams['width'] ) ) {
432 # Create a resized image, without the additional thumbnail features
433 $thumb = $file->transform( $handlerParams );
434 } else {
435 $thumb = false;
436 }
437
438 if ( !$thumb ) {
439 $s = self::makeBrokenImageLinkObj( $title, $frameParams['title'], '', '', '', $time == true );
440 } else {
442 $params = [
443 'alt' => $frameParams['alt'],
444 'title' => $frameParams['title'],
445 'valign' => isset( $frameParams['valign'] ) ? $frameParams['valign'] : false,
446 'img-class' => $frameParams['class'] ];
447 if ( isset( $frameParams['border'] ) ) {
448 $params['img-class'] .= ( $params['img-class'] !== '' ? ' ' : '' ) . 'thumbborder';
449 }
451
452 $s = $thumb->toHtml( $params );
453 }
454 if ( $frameParams['align'] != '' ) {
455 $s = "<div class=\"float{$frameParams['align']}\">{$s}</div>";
456 }
457 return str_replace( "\n", ' ', $prefix . $s . $postfix );
458 }
459
468 private static function getImageLinkMTOParams( $frameParams, $query = '', $parser = null ) {
469 $mtoParams = [];
470 if ( isset( $frameParams['link-url'] ) && $frameParams['link-url'] !== '' ) {
471 $mtoParams['custom-url-link'] = $frameParams['link-url'];
472 if ( isset( $frameParams['link-target'] ) ) {
473 $mtoParams['custom-target-link'] = $frameParams['link-target'];
474 }
475 if ( $parser ) {
476 $extLinkAttrs = $parser->getExternalLinkAttribs( $frameParams['link-url'] );
477 foreach ( $extLinkAttrs as $name => $val ) {
478 // Currently could include 'rel' and 'target'
479 $mtoParams['parser-extlink-' . $name] = $val;
480 }
481 }
482 } elseif ( isset( $frameParams['link-title'] ) && $frameParams['link-title'] !== '' ) {
483 $mtoParams['custom-title-link'] = Title::newFromLinkTarget(
484 self::normaliseSpecialPage( $frameParams['link-title'] )
485 );
486 } elseif ( !empty( $frameParams['no-link'] ) ) {
487 // No link
488 } else {
489 $mtoParams['desc-link'] = true;
490 $mtoParams['desc-query'] = $query;
491 }
492 return $mtoParams;
493 }
494
507 public static function makeThumbLinkObj( Title $title, $file, $label = '', $alt,
508 $align = 'right', $params = [], $framed = false, $manualthumb = ""
509 ) {
510 $frameParams = [
511 'alt' => $alt,
512 'caption' => $label,
513 'align' => $align
514 ];
515 if ( $framed ) {
516 $frameParams['framed'] = true;
517 }
518 if ( $manualthumb ) {
519 $frameParams['manualthumb'] = $manualthumb;
520 }
521 return self::makeThumbLink2( $title, $file, $frameParams, $params );
522 }
523
533 public static function makeThumbLink2( Title $title, $file, $frameParams = [],
534 $handlerParams = [], $time = false, $query = ""
535 ) {
536 $exists = $file && $file->exists();
537
538 $page = isset( $handlerParams['page'] ) ? $handlerParams['page'] : false;
539 if ( !isset( $frameParams['align'] ) ) {
540 $frameParams['align'] = 'right';
541 }
542 if ( !isset( $frameParams['alt'] ) ) {
543 $frameParams['alt'] = '';
544 }
545 if ( !isset( $frameParams['title'] ) ) {
546 $frameParams['title'] = '';
547 }
548 if ( !isset( $frameParams['caption'] ) ) {
549 $frameParams['caption'] = '';
550 }
551
552 if ( empty( $handlerParams['width'] ) ) {
553 // Reduce width for upright images when parameter 'upright' is used
554 $handlerParams['width'] = isset( $frameParams['upright'] ) ? 130 : 180;
555 }
556 $thumb = false;
557 $noscale = false;
558 $manualthumb = false;
559
560 if ( !$exists ) {
561 $outerWidth = $handlerParams['width'] + 2;
562 } else {
563 if ( isset( $frameParams['manualthumb'] ) ) {
564 # Use manually specified thumbnail
565 $manual_title = Title::makeTitleSafe( NS_FILE, $frameParams['manualthumb'] );
566 if ( $manual_title ) {
567 $manual_img = wfFindFile( $manual_title );
568 if ( $manual_img ) {
569 $thumb = $manual_img->getUnscaledThumb( $handlerParams );
570 $manualthumb = true;
571 } else {
572 $exists = false;
573 }
574 }
575 } elseif ( isset( $frameParams['framed'] ) ) {
576 // Use image dimensions, don't scale
577 $thumb = $file->getUnscaledThumb( $handlerParams );
578 $noscale = true;
579 } else {
580 # Do not present an image bigger than the source, for bitmap-style images
581 # This is a hack to maintain compatibility with arbitrary pre-1.10 behavior
582 $srcWidth = $file->getWidth( $page );
583 if ( $srcWidth && !$file->mustRender() && $handlerParams['width'] > $srcWidth ) {
584 $handlerParams['width'] = $srcWidth;
585 }
586 $thumb = $file->transform( $handlerParams );
587 }
588
589 if ( $thumb ) {
590 $outerWidth = $thumb->getWidth() + 2;
591 } else {
592 $outerWidth = $handlerParams['width'] + 2;
593 }
594 }
595
596 # ThumbnailImage::toHtml() already adds page= onto the end of DjVu URLs
597 # So we don't need to pass it here in $query. However, the URL for the
598 # zoom icon still needs it, so we make a unique query for it. See T16771
599 $url = $title->getLocalURL( $query );
600 if ( $page ) {
601 $url = wfAppendQuery( $url, [ 'page' => $page ] );
602 }
603 if ( $manualthumb
604 && !isset( $frameParams['link-title'] )
605 && !isset( $frameParams['link-url'] )
606 && !isset( $frameParams['no-link'] ) ) {
607 $frameParams['link-url'] = $url;
608 }
609
610 $s = "<div class=\"thumb t{$frameParams['align']}\">"
611 . "<div class=\"thumbinner\" style=\"width:{$outerWidth}px;\">";
612
613 if ( !$exists ) {
614 $s .= self::makeBrokenImageLinkObj( $title, $frameParams['title'], '', '', '', $time == true );
615 $zoomIcon = '';
616 } elseif ( !$thumb ) {
617 $s .= wfMessage( 'thumbnail_error', '' )->escaped();
618 $zoomIcon = '';
619 } else {
620 if ( !$noscale && !$manualthumb ) {
622 }
623 $params = [
624 'alt' => $frameParams['alt'],
625 'title' => $frameParams['title'],
626 'img-class' => ( isset( $frameParams['class'] ) && $frameParams['class'] !== ''
627 ? $frameParams['class'] . ' '
628 : '' ) . 'thumbimage'
629 ];
631 $s .= $thumb->toHtml( $params );
632 if ( isset( $frameParams['framed'] ) ) {
633 $zoomIcon = "";
634 } else {
635 $zoomIcon = Html::rawElement( 'div', [ 'class' => 'magnify' ],
636 Html::rawElement( 'a', [
637 'href' => $url,
638 'class' => 'internal',
639 'title' => wfMessage( 'thumbnail-more' )->text() ],
640 "" ) );
641 }
642 }
643 $s .= ' <div class="thumbcaption">' . $zoomIcon . $frameParams['caption'] . "</div></div></div>";
644 return str_replace( "\n", ' ', $s );
645 }
646
655 public static function processResponsiveImages( $file, $thumb, $hp ) {
657 if ( $wgResponsiveImages && $thumb && !$thumb->isError() ) {
658 $hp15 = $hp;
659 $hp15['width'] = round( $hp['width'] * 1.5 );
660 $hp20 = $hp;
661 $hp20['width'] = $hp['width'] * 2;
662 if ( isset( $hp['height'] ) ) {
663 $hp15['height'] = round( $hp['height'] * 1.5 );
664 $hp20['height'] = $hp['height'] * 2;
665 }
666
667 $thumb15 = $file->transform( $hp15 );
668 $thumb20 = $file->transform( $hp20 );
669 if ( $thumb15 && !$thumb15->isError() && $thumb15->getUrl() !== $thumb->getUrl() ) {
670 $thumb->responsiveUrls['1.5'] = $thumb15->getUrl();
671 }
672 if ( $thumb20 && !$thumb20->isError() && $thumb20->getUrl() !== $thumb->getUrl() ) {
673 $thumb->responsiveUrls['2'] = $thumb20->getUrl();
674 }
675 }
676 }
677
690 public static function makeBrokenImageLinkObj( $title, $label = '',
691 $query = '', $unused1 = '', $unused2 = '', $time = false
692 ) {
693 if ( !$title instanceof Title ) {
694 wfWarn( __METHOD__ . ': Requires $title to be a Title object.' );
695 return "<!-- ERROR -->" . htmlspecialchars( $label );
696 }
697
699 if ( $label == '' ) {
700 $label = $title->getPrefixedText();
701 }
702 $encLabel = htmlspecialchars( $label );
703 $currentExists = $time ? ( wfFindFile( $title ) != false ) : false;
704
706 && !$currentExists
707 ) {
708 $redir = RepoGroup::singleton()->getLocalRepo()->checkRedirect( $title );
709
710 if ( $redir ) {
711 // We already know it's a redirect, so mark it
712 // accordingly
713 return self::link(
714 $title,
715 $encLabel,
716 [ 'class' => 'mw-redirect' ],
718 [ 'known', 'noclasses' ]
719 );
720 }
721
722 $href = self::getUploadUrl( $title, $query );
723
724 return '<a href="' . htmlspecialchars( $href ) . '" class="new" title="' .
725 htmlspecialchars( $title->getPrefixedText(), ENT_QUOTES ) . '">' .
726 $encLabel . '</a>';
727 }
728
729 return self::link( $title, $encLabel, [], wfCgiToArray( $query ), [ 'known', 'noclasses' ] );
730 }
731
740 protected static function getUploadUrl( $destFile, $query = '' ) {
742 $q = 'wpDestFile=' . $destFile->getPartialURL();
743 if ( $query != '' ) {
744 $q .= '&' . $query;
745 }
746
749 } elseif ( $wgUploadNavigationUrl ) {
751 } else {
752 $upload = SpecialPage::getTitleFor( 'Upload' );
753 return $upload->getLocalURL( $q );
754 }
755 }
756
766 public static function makeMediaLinkObj( $title, $html = '', $time = false ) {
767 $img = wfFindFile( $title, [ 'time' => $time ] );
768 return self::makeMediaLinkFile( $title, $img, $html );
769 }
770
783 public static function makeMediaLinkFile( Title $title, $file, $html = '' ) {
784 if ( $file && $file->exists() ) {
785 $url = $file->getUrl();
786 $class = 'internal';
787 } else {
788 $url = self::getUploadUrl( $title );
789 $class = 'new';
790 }
791
792 $alt = $title->getText();
793 if ( $html == '' ) {
794 $html = $alt;
795 }
796
797 $ret = '';
798 $attribs = [
799 'href' => $url,
800 'class' => $class,
801 'title' => $alt
802 ];
803
804 if ( !Hooks::run( 'LinkerMakeMediaLinkFile',
805 [ $title, $file, &$html, &$attribs, &$ret ] ) ) {
806 wfDebug( "Hook LinkerMakeMediaLinkFile changed the output of link "
807 . "with url {$url} and text {$html} to {$ret}\n", true );
808 return $ret;
809 }
810
811 return Html::rawElement( 'a', $attribs, $html );
812 }
813
824 public static function specialLink( $name, $key = '' ) {
825 if ( $key == '' ) {
826 $key = strtolower( $name );
827 }
828
830 }
831
843 public static function makeExternalLink( $url, $text, $escape = true,
844 $linktype = '', $attribs = [], $title = null
845 ) {
847 $class = "external";
848 if ( $linktype ) {
849 $class .= " $linktype";
850 }
851 if ( isset( $attribs['class'] ) && $attribs['class'] ) {
852 $class .= " {$attribs['class']}";
853 }
854 $attribs['class'] = $class;
855
856 if ( $escape ) {
857 $text = htmlspecialchars( $text );
858 }
859
860 if ( !$title ) {
862 }
863 $newRel = Parser::getExternalLinkRel( $url, $title );
864 if ( !isset( $attribs['rel'] ) || $attribs['rel'] === '' ) {
865 $attribs['rel'] = $newRel;
866 } elseif ( $newRel !== '' ) {
867 // Merge the rel attributes.
868 $newRels = explode( ' ', $newRel );
869 $oldRels = explode( ' ', $attribs['rel'] );
870 $combined = array_unique( array_merge( $newRels, $oldRels ) );
871 $attribs['rel'] = implode( ' ', $combined );
872 }
873 $link = '';
874 $success = Hooks::run( 'LinkerMakeExternalLink',
875 [ &$url, &$text, &$link, &$attribs, $linktype ] );
876 if ( !$success ) {
877 wfDebug( "Hook LinkerMakeExternalLink changed the output of link "
878 . "with url {$url} and text {$text} to {$link}\n", true );
879 return $link;
880 }
881 $attribs['href'] = $url;
882 return Html::rawElement( 'a', $attribs, $text );
883 }
884
893 public static function userLink( $userId, $userName, $altUserName = false ) {
894 $classes = 'mw-userlink';
895 if ( $userId == 0 ) {
896 $page = SpecialPage::getTitleFor( 'Contributions', $userName );
897 if ( $altUserName === false ) {
898 $altUserName = IP::prettifyIP( $userName );
899 }
900 $classes .= ' mw-anonuserlink'; // Separate link class for anons (T45179)
901 } else {
902 $page = Title::makeTitle( NS_USER, $userName );
903 }
904
905 // Wrap the output with <bdi> tags for directionality isolation
906 return self::link(
907 $page,
908 '<bdi>' . htmlspecialchars( $altUserName !== false ? $altUserName : $userName ) . '</bdi>',
909 [ 'class' => $classes ]
910 );
911 }
912
926 public static function userToolLinks(
927 $userId, $userText, $redContribsWhenNoEdits = false, $flags = 0, $edits = null
928 ) {
930 $talkable = !( $wgDisableAnonTalk && 0 == $userId );
931 $blockable = !( $flags & self::TOOL_LINKS_NOBLOCK );
932 $addEmailLink = $flags & self::TOOL_LINKS_EMAIL && $userId;
933
934 $items = [];
935 if ( $talkable ) {
936 $items[] = self::userTalkLink( $userId, $userText );
937 }
938 if ( $userId ) {
939 // check if the user has an edit
940 $attribs = [];
941 $attribs['class'] = 'mw-usertoollinks-contribs';
942 if ( $redContribsWhenNoEdits ) {
943 if ( intval( $edits ) === 0 && $edits !== 0 ) {
944 $user = User::newFromId( $userId );
945 $edits = $user->getEditCount();
946 }
947 if ( $edits === 0 ) {
948 $attribs['class'] .= ' new';
949 }
950 }
951 $contribsPage = SpecialPage::getTitleFor( 'Contributions', $userText );
952
953 $items[] = self::link( $contribsPage, wfMessage( 'contribslink' )->escaped(), $attribs );
954 }
955 if ( $blockable && $wgUser->isAllowed( 'block' ) ) {
956 $items[] = self::blockLink( $userId, $userText );
957 }
958
959 if ( $addEmailLink && $wgUser->canSendEmail() ) {
960 $items[] = self::emailLink( $userId, $userText );
961 }
962
963 Hooks::run( 'UserToolLinksEdit', [ $userId, $userText, &$items ] );
964
965 if ( $items ) {
966 return wfMessage( 'word-separator' )->escaped()
967 . '<span class="mw-usertoollinks">'
968 . wfMessage( 'parentheses' )->rawParams( $wgLang->pipeList( $items ) )->escaped()
969 . '</span>';
970 } else {
971 return '';
972 }
973 }
974
983 public static function userToolLinksRedContribs( $userId, $userText, $edits = null ) {
984 return self::userToolLinks( $userId, $userText, true, 0, $edits );
985 }
986
993 public static function userTalkLink( $userId, $userText ) {
994 $userTalkPage = Title::makeTitle( NS_USER_TALK, $userText );
995 $moreLinkAttribs['class'] = 'mw-usertoollinks-talk';
996 $userTalkLink = self::link( $userTalkPage,
997 wfMessage( 'talkpagelinktext' )->escaped(),
998 $moreLinkAttribs );
999 return $userTalkLink;
1000 }
1001
1008 public static function blockLink( $userId, $userText ) {
1009 $blockPage = SpecialPage::getTitleFor( 'Block', $userText );
1010 $moreLinkAttribs['class'] = 'mw-usertoollinks-block';
1011 $blockLink = self::link( $blockPage,
1012 wfMessage( 'blocklink' )->escaped(),
1013 $moreLinkAttribs );
1014 return $blockLink;
1015 }
1016
1022 public static function emailLink( $userId, $userText ) {
1023 $emailPage = SpecialPage::getTitleFor( 'Emailuser', $userText );
1024 $moreLinkAttribs['class'] = 'mw-usertoollinks-mail';
1025 $emailLink = self::link( $emailPage,
1026 wfMessage( 'emaillink' )->escaped(),
1027 $moreLinkAttribs );
1028 return $emailLink;
1029 }
1030
1038 public static function revUserLink( $rev, $isPublic = false ) {
1039 if ( $rev->isDeleted( Revision::DELETED_USER ) && $isPublic ) {
1040 $link = wfMessage( 'rev-deleted-user' )->escaped();
1041 } elseif ( $rev->userCan( Revision::DELETED_USER ) ) {
1043 $rev->getUserText( Revision::FOR_THIS_USER ) );
1044 } else {
1045 $link = wfMessage( 'rev-deleted-user' )->escaped();
1046 }
1047 if ( $rev->isDeleted( Revision::DELETED_USER ) ) {
1048 return '<span class="history-deleted">' . $link . '</span>';
1049 }
1050 return $link;
1051 }
1052
1060 public static function revUserTools( $rev, $isPublic = false ) {
1061 if ( $rev->isDeleted( Revision::DELETED_USER ) && $isPublic ) {
1062 $link = wfMessage( 'rev-deleted-user' )->escaped();
1063 } elseif ( $rev->userCan( Revision::DELETED_USER ) ) {
1064 $userId = $rev->getUser( Revision::FOR_THIS_USER );
1065 $userText = $rev->getUserText( Revision::FOR_THIS_USER );
1066 $link = self::userLink( $userId, $userText )
1067 . self::userToolLinks( $userId, $userText );
1068 } else {
1069 $link = wfMessage( 'rev-deleted-user' )->escaped();
1070 }
1071 if ( $rev->isDeleted( Revision::DELETED_USER ) ) {
1072 return ' <span class="history-deleted">' . $link . '</span>';
1073 }
1074 return $link;
1075 }
1076
1099 public static function formatComment(
1100 $comment, $title = null, $local = false, $wikiId = null
1101 ) {
1102 # Sanitize text a bit:
1103 $comment = str_replace( "\n", " ", $comment );
1104 # Allow HTML entities (for T15815)
1105 $comment = Sanitizer::escapeHtmlAllowEntities( $comment );
1106
1107 # Render autocomments and make links:
1108 $comment = self::formatAutocomments( $comment, $title, $local, $wikiId );
1109 $comment = self::formatLinksInComment( $comment, $title, $local, $wikiId );
1110
1111 return $comment;
1112 }
1113
1131 private static function formatAutocomments(
1132 $comment, $title = null, $local = false, $wikiId = null
1133 ) {
1134 // @todo $append here is something of a hack to preserve the status
1135 // quo. Someone who knows more about bidi and such should decide
1136 // (1) what sane rendering even *is* for an LTR edit summary on an RTL
1137 // wiki, both when autocomments exist and when they don't, and
1138 // (2) what markup will make that actually happen.
1139 $append = '';
1140 $comment = preg_replace_callback(
1141 // To detect the presence of content before or after the
1142 // auto-comment, we use capturing groups inside optional zero-width
1143 // assertions. But older versions of PCRE can't directly make
1144 // zero-width assertions optional, so wrap them in a non-capturing
1145 // group.
1146 '!(?:(?<=(.)))?/\*\s*(.*?)\s*\*/(?:(?=(.)))?!',
1147 function ( $match ) use ( $title, $local, $wikiId, &$append ) {
1149
1150 // Ensure all match positions are defined
1151 $match += [ '', '', '', '' ];
1152
1153 $pre = $match[1] !== '';
1154 $auto = $match[2];
1155 $post = $match[3] !== '';
1156 $comment = null;
1157
1158 Hooks::run(
1159 'FormatAutocomments',
1160 [ &$comment, $pre, $auto, $post, $title, $local, $wikiId ]
1161 );
1162
1163 if ( $comment === null ) {
1164 $link = '';
1165 if ( $title ) {
1166 $section = $auto;
1167 # Remove links that a user may have manually put in the autosummary
1168 # This could be improved by copying as much of Parser::stripSectionName as desired.
1169 $section = str_replace( '[[:', '', $section );
1170 $section = str_replace( '[[', '', $section );
1171 $section = str_replace( ']]', '', $section );
1172
1173 $section = Sanitizer::normalizeSectionNameWhitespace( $section ); # T24784
1174 if ( $local ) {
1175 $sectionTitle = Title::newFromText( '#' . $section );
1176 } else {
1177 $sectionTitle = Title::makeTitleSafe( $title->getNamespace(),
1178 $title->getDBkey(), Sanitizer::decodeCharReferences( $section ) );
1179 }
1180 if ( $sectionTitle ) {
1181 $link = Linker::makeCommentLink( $sectionTitle, $wgLang->getArrow(), $wikiId, 'noclasses' );
1182 } else {
1183 $link = '';
1184 }
1185 }
1186 if ( $pre ) {
1187 # written summary $presep autocomment (summary /* section */)
1188 $pre = wfMessage( 'autocomment-prefix' )->inContentLanguage()->escaped();
1189 }
1190 if ( $post ) {
1191 # autocomment $postsep written summary (/* section */ summary)
1192 $auto .= wfMessage( 'colon-separator' )->inContentLanguage()->escaped();
1193 }
1194 $auto = '<span class="autocomment">' . $auto . '</span>';
1195 $comment = $pre . $link . $wgLang->getDirMark()
1196 . '<span dir="auto">' . $auto;
1197 $append .= '</span>';
1198 }
1199 return $comment;
1200 },
1201 $comment
1202 );
1203 return $comment . $append;
1204 }
1205
1224 public static function formatLinksInComment(
1225 $comment, $title = null, $local = false, $wikiId = null
1226 ) {
1227 return preg_replace_callback(
1228 '/
1229 \[\[
1230 :? # ignore optional leading colon
1231 ([^\]|]+) # 1. link target; page names cannot include ] or |
1232 (?:\|
1233 # 2. link text
1234 # Stop matching at ]] without relying on backtracking.
1235 ((?:]?[^\]])*+)
1236 )?
1237 \]\]
1238 ([^[]*) # 3. link trail (the text up until the next link)
1239 /x',
1240 function ( $match ) use ( $title, $local, $wikiId ) {
1242
1243 $medians = '(?:' . preg_quote( MWNamespace::getCanonicalName( NS_MEDIA ), '/' ) . '|';
1244 $medians .= preg_quote( $wgContLang->getNsText( NS_MEDIA ), '/' ) . '):';
1245
1246 $comment = $match[0];
1247
1248 # fix up urlencoded title texts (copied from Parser::replaceInternalLinks)
1249 if ( strpos( $match[1], '%' ) !== false ) {
1250 $match[1] = strtr(
1251 rawurldecode( $match[1] ),
1252 [ '<' => '&lt;', '>' => '&gt;' ]
1253 );
1254 }
1255
1256 # Handle link renaming [[foo|text]] will show link as "text"
1257 if ( $match[2] != "" ) {
1258 $text = $match[2];
1259 } else {
1260 $text = $match[1];
1261 }
1262 $submatch = [];
1263 $thelink = null;
1264 if ( preg_match( '/^' . $medians . '(.*)$/i', $match[1], $submatch ) ) {
1265 # Media link; trail not supported.
1266 $linkRegexp = '/\[\[(.*?)\]\]/';
1267 $title = Title::makeTitleSafe( NS_FILE, $submatch[1] );
1268 if ( $title ) {
1269 $thelink = Linker::makeMediaLinkObj( $title, $text );
1270 }
1271 } else {
1272 # Other kind of link
1273 # Make sure its target is non-empty
1274 if ( isset( $match[1][0] ) && $match[1][0] == ':' ) {
1275 $match[1] = substr( $match[1], 1 );
1276 }
1277 if ( $match[1] !== false && $match[1] !== '' ) {
1278 if ( preg_match( $wgContLang->linkTrail(), $match[3], $submatch ) ) {
1279 $trail = $submatch[1];
1280 } else {
1281 $trail = "";
1282 }
1283 $linkRegexp = '/\[\[(.*?)\]\]' . preg_quote( $trail, '/' ) . '/';
1284 list( $inside, $trail ) = Linker::splitTrail( $trail );
1285
1286 $linkText = $text;
1287 $linkTarget = Linker::normalizeSubpageLink( $title, $match[1], $linkText );
1288
1289 $target = Title::newFromText( $linkTarget );
1290 if ( $target ) {
1291 if ( $target->getText() == '' && !$target->isExternal()
1292 && !$local && $title
1293 ) {
1294 $target = $title->createFragmentTarget( $target->getFragment() );
1295 }
1296
1297 $thelink = Linker::makeCommentLink( $target, $linkText . $inside, $wikiId ) . $trail;
1298 }
1299 }
1300 }
1301 if ( $thelink ) {
1302 // If the link is still valid, go ahead and replace it in!
1303 $comment = preg_replace(
1304 $linkRegexp,
1306 $comment,
1307 1
1308 );
1309 }
1310
1311 return $comment;
1312 },
1313 $comment
1314 );
1315 }
1316
1330 public static function makeCommentLink(
1331 LinkTarget $linkTarget, $text, $wikiId = null, $options = []
1332 ) {
1333 if ( $wikiId !== null && !$linkTarget->isExternal() ) {
1336 $wikiId,
1337 $linkTarget->getNamespace() === 0
1338 ? $linkTarget->getDBkey()
1339 : MWNamespace::getCanonicalName( $linkTarget->getNamespace() ) . ':'
1340 . $linkTarget->getDBkey(),
1341 $linkTarget->getFragment()
1342 ),
1343 $text,
1344 /* escape = */ false // Already escaped
1345 );
1346 } else {
1347 $link = self::link( $linkTarget, $text, [], [], $options );
1348 }
1349
1350 return $link;
1351 }
1352
1359 public static function normalizeSubpageLink( $contextTitle, $target, &$text ) {
1360 # Valid link forms:
1361 # Foobar -- normal
1362 # :Foobar -- override special treatment of prefix (images, language links)
1363 # /Foobar -- convert to CurrentPage/Foobar
1364 # /Foobar/ -- convert to CurrentPage/Foobar, strip the initial and final / from text
1365 # ../ -- convert to CurrentPage, from CurrentPage/CurrentSubPage
1366 # ../Foobar -- convert to CurrentPage/Foobar,
1367 # (from CurrentPage/CurrentSubPage)
1368 # ../Foobar/ -- convert to CurrentPage/Foobar, use 'Foobar' as text
1369 # (from CurrentPage/CurrentSubPage)
1370
1371 $ret = $target; # default return value is no change
1372
1373 # Some namespaces don't allow subpages,
1374 # so only perform processing if subpages are allowed
1375 if ( $contextTitle && MWNamespace::hasSubpages( $contextTitle->getNamespace() ) ) {
1376 $hash = strpos( $target, '#' );
1377 if ( $hash !== false ) {
1378 $suffix = substr( $target, $hash );
1379 $target = substr( $target, 0, $hash );
1380 } else {
1381 $suffix = '';
1382 }
1383 # T9425
1384 $target = trim( $target );
1385 # Look at the first character
1386 if ( $target != '' && $target[0] === '/' ) {
1387 # / at end means we don't want the slash to be shown
1388 $m = [];
1389 $trailingSlashes = preg_match_all( '%(/+)$%', $target, $m );
1390 if ( $trailingSlashes ) {
1391 $noslash = $target = substr( $target, 1, -strlen( $m[0][0] ) );
1392 } else {
1393 $noslash = substr( $target, 1 );
1394 }
1395
1396 $ret = $contextTitle->getPrefixedText() . '/' . trim( $noslash ) . $suffix;
1397 if ( $text === '' ) {
1398 $text = $target . $suffix;
1399 } # this might be changed for ugliness reasons
1400 } else {
1401 # check for .. subpage backlinks
1402 $dotdotcount = 0;
1403 $nodotdot = $target;
1404 while ( strncmp( $nodotdot, "../", 3 ) == 0 ) {
1405 ++$dotdotcount;
1406 $nodotdot = substr( $nodotdot, 3 );
1407 }
1408 if ( $dotdotcount > 0 ) {
1409 $exploded = explode( '/', $contextTitle->getPrefixedText() );
1410 if ( count( $exploded ) > $dotdotcount ) { # not allowed to go below top level page
1411 $ret = implode( '/', array_slice( $exploded, 0, -$dotdotcount ) );
1412 # / at the end means don't show full path
1413 if ( substr( $nodotdot, -1, 1 ) === '/' ) {
1414 $nodotdot = rtrim( $nodotdot, '/' );
1415 if ( $text === '' ) {
1416 $text = $nodotdot . $suffix;
1417 }
1418 }
1419 $nodotdot = trim( $nodotdot );
1420 if ( $nodotdot != '' ) {
1421 $ret .= '/' . $nodotdot;
1422 }
1423 $ret .= $suffix;
1424 }
1425 }
1426 }
1427 }
1428
1429 return $ret;
1430 }
1431
1445 public static function commentBlock(
1446 $comment, $title = null, $local = false, $wikiId = null
1447 ) {
1448 // '*' used to be the comment inserted by the software way back
1449 // in antiquity in case none was provided, here for backwards
1450 // compatibility, acc. to brion -ævar
1451 if ( $comment == '' || $comment == '*' ) {
1452 return '';
1453 } else {
1454 $formatted = self::formatComment( $comment, $title, $local, $wikiId );
1455 $formatted = wfMessage( 'parentheses' )->rawParams( $formatted )->escaped();
1456 return " <span class=\"comment\">$formatted</span>";
1457 }
1458 }
1459
1470 public static function revComment( Revision $rev, $local = false, $isPublic = false ) {
1471 if ( $rev->getComment( Revision::RAW ) == "" ) {
1472 return "";
1473 }
1474 if ( $rev->isDeleted( Revision::DELETED_COMMENT ) && $isPublic ) {
1475 $block = " <span class=\"comment\">" . wfMessage( 'rev-deleted-comment' )->escaped() . "</span>";
1476 } elseif ( $rev->userCan( Revision::DELETED_COMMENT ) ) {
1477 $block = self::commentBlock( $rev->getComment( Revision::FOR_THIS_USER ),
1478 $rev->getTitle(), $local );
1479 } else {
1480 $block = " <span class=\"comment\">" . wfMessage( 'rev-deleted-comment' )->escaped() . "</span>";
1481 }
1482 if ( $rev->isDeleted( Revision::DELETED_COMMENT ) ) {
1483 return " <span class=\"history-deleted\">$block</span>";
1484 }
1485 return $block;
1486 }
1487
1493 public static function formatRevisionSize( $size ) {
1494 if ( $size == 0 ) {
1495 $stxt = wfMessage( 'historyempty' )->escaped();
1496 } else {
1497 $stxt = wfMessage( 'nbytes' )->numParams( $size )->escaped();
1498 $stxt = wfMessage( 'parentheses' )->rawParams( $stxt )->escaped();
1499 }
1500 return "<span class=\"history-size\">$stxt</span>";
1501 }
1502
1509 public static function tocIndent() {
1510 return "\n<ul>";
1511 }
1512
1520 public static function tocUnindent( $level ) {
1521 return "</li>\n" . str_repeat( "</ul>\n</li>\n", $level > 0 ? $level : 0 );
1522 }
1523
1535 public static function tocLine( $anchor, $tocline, $tocnumber, $level, $sectionIndex = false ) {
1536 $classes = "toclevel-$level";
1537 if ( $sectionIndex !== false ) {
1538 $classes .= " tocsection-$sectionIndex";
1539 }
1540
1541 // \n<li class="$classes"><a href="#$anchor"><span class="tocnumber">
1542 // $tocnumber</span> <span class="toctext">$tocline</span></a>
1543 return "\n" . Html::openElement( 'li', [ 'class' => $classes ] )
1544 . Html::rawElement( 'a',
1545 [ 'href' => "#$anchor" ],
1546 Html::element( 'span', [ 'class' => 'tocnumber' ], $tocnumber )
1547 . ' '
1548 . Html::rawElement( 'span', [ 'class' => 'toctext' ], $tocline )
1549 );
1550 }
1551
1559 public static function tocLineEnd() {
1560 return "</li>\n";
1561 }
1562
1571 public static function tocList( $toc, $lang = false ) {
1573 $title = wfMessage( 'toc' )->inLanguage( $lang )->escaped();
1574
1575 return '<div id="toc" class="toc">'
1576 . '<div class="toctitle"><h2>' . $title . "</h2></div>\n"
1577 . $toc
1578 . "</ul>\n</div>\n";
1579 }
1580
1589 public static function generateTOC( $tree, $lang = false ) {
1590 $toc = '';
1591 $lastLevel = 0;
1592 foreach ( $tree as $section ) {
1593 if ( $section['toclevel'] > $lastLevel ) {
1594 $toc .= self::tocIndent();
1595 } elseif ( $section['toclevel'] < $lastLevel ) {
1596 $toc .= self::tocUnindent(
1597 $lastLevel - $section['toclevel'] );
1598 } else {
1599 $toc .= self::tocLineEnd();
1600 }
1601
1602 $toc .= self::tocLine( $section['anchor'],
1603 $section['line'], $section['number'],
1604 $section['toclevel'], $section['index'] );
1605 $lastLevel = $section['toclevel'];
1606 }
1607 $toc .= self::tocLineEnd();
1608 return self::tocList( $toc, $lang );
1609 }
1610
1627 public static function makeHeadline( $level, $attribs, $anchor, $html,
1628 $link, $fallbackAnchor = false
1629 ) {
1630 $anchorEscaped = htmlspecialchars( $anchor );
1631 $fallback = '';
1632 if ( $fallbackAnchor !== false && $fallbackAnchor !== $anchor ) {
1633 $fallbackAnchor = htmlspecialchars( $fallbackAnchor );
1634 $fallback = "<span id=\"$fallbackAnchor\"></span>";
1635 }
1636 $ret = "<h$level$attribs"
1637 . "$fallback<span class=\"mw-headline\" id=\"$anchorEscaped\">$html</span>"
1638 . $link
1639 . "</h$level>";
1640
1641 return $ret;
1642 }
1643
1650 static function splitTrail( $trail ) {
1652 $regex = $wgContLang->linkTrail();
1653 $inside = '';
1654 if ( $trail !== '' ) {
1655 $m = [];
1656 if ( preg_match( $regex, $trail, $m ) ) {
1657 $inside = $m[1];
1658 $trail = $m[2];
1659 }
1660 }
1661 return [ $inside, $trail ];
1662 }
1663
1691 public static function generateRollback( $rev, IContextSource $context = null,
1692 $options = [ 'verify' ]
1693 ) {
1694 if ( $context === null ) {
1696 }
1697
1698 $editCount = false;
1699 if ( in_array( 'verify', $options, true ) ) {
1700 $editCount = self::getRollbackEditCount( $rev, true );
1701 if ( $editCount === false ) {
1702 return '';
1703 }
1704 }
1705
1706 $inner = self::buildRollbackLink( $rev, $context, $editCount );
1707
1708 if ( !in_array( 'noBrackets', $options, true ) ) {
1709 $inner = $context->msg( 'brackets' )->rawParams( $inner )->escaped();
1710 }
1711
1712 return '<span class="mw-rollback-link">' . $inner . '</span>';
1713 }
1714
1730 public static function getRollbackEditCount( $rev, $verify ) {
1732 if ( !is_int( $wgShowRollbackEditCount ) || !$wgShowRollbackEditCount > 0 ) {
1733 // Nothing has happened, indicate this by returning 'null'
1734 return null;
1735 }
1736
1737 $dbr = wfGetDB( DB_REPLICA );
1738
1739 // Up to the value of $wgShowRollbackEditCount revisions are counted
1740 $res = $dbr->select(
1741 'revision',
1742 [ 'rev_user_text', 'rev_deleted' ],
1743 // $rev->getPage() returns null sometimes
1744 [ 'rev_page' => $rev->getTitle()->getArticleID() ],
1745 __METHOD__,
1746 [
1747 'USE INDEX' => [ 'revision' => 'page_timestamp' ],
1748 'ORDER BY' => 'rev_timestamp DESC',
1749 'LIMIT' => $wgShowRollbackEditCount + 1
1750 ]
1751 );
1752
1753 $editCount = 0;
1754 $moreRevs = false;
1755 foreach ( $res as $row ) {
1756 if ( $rev->getUserText( Revision::RAW ) != $row->rev_user_text ) {
1757 if ( $verify &&
1758 ( $row->rev_deleted & Revision::DELETED_TEXT
1759 || $row->rev_deleted & Revision::DELETED_USER
1760 ) ) {
1761 // If the user or the text of the revision we might rollback
1762 // to is deleted in some way we can't rollback. Similar to
1763 // the sanity checks in WikiPage::commitRollback.
1764 return false;
1765 }
1766 $moreRevs = true;
1767 break;
1768 }
1769 $editCount++;
1770 }
1771
1772 if ( $verify && $editCount <= $wgShowRollbackEditCount && !$moreRevs ) {
1773 // We didn't find at least $wgShowRollbackEditCount revisions made by the current user
1774 // and there weren't any other revisions. That means that the current user is the only
1775 // editor, so we can't rollback
1776 return false;
1777 }
1778 return $editCount;
1779 }
1780
1790 public static function buildRollbackLink( $rev, IContextSource $context = null,
1791 $editCount = false
1792 ) {
1794
1795 // To config which pages are affected by miser mode
1796 $disableRollbackEditCountSpecialPage = [ 'Recentchanges', 'Watchlist' ];
1797
1798 if ( $context === null ) {
1800 }
1801
1802 $title = $rev->getTitle();
1803 $query = [
1804 'action' => 'rollback',
1805 'from' => $rev->getUserText(),
1806 'token' => $context->getUser()->getEditToken( 'rollback' ),
1807 ];
1808 $attrs = [
1809 'data-mw' => 'interface',
1810 'title' => $context->msg( 'tooltip-rollback' )->text(),
1811 ];
1812 $options = [ 'known', 'noclasses' ];
1813
1814 if ( $context->getRequest()->getBool( 'bot' ) ) {
1815 $query['bot'] = '1';
1816 $query['hidediff'] = '1'; // T17999
1817 }
1818
1819 $disableRollbackEditCount = false;
1820 if ( $wgMiserMode ) {
1821 foreach ( $disableRollbackEditCountSpecialPage as $specialPage ) {
1822 if ( $context->getTitle()->isSpecial( $specialPage ) ) {
1823 $disableRollbackEditCount = true;
1824 break;
1825 }
1826 }
1827 }
1828
1829 if ( !$disableRollbackEditCount
1830 && is_int( $wgShowRollbackEditCount )
1832 ) {
1833 if ( !is_numeric( $editCount ) ) {
1834 $editCount = self::getRollbackEditCount( $rev, false );
1835 }
1836
1837 if ( $editCount > $wgShowRollbackEditCount ) {
1838 $html = $context->msg( 'rollbacklinkcount-morethan' )
1839 ->numParams( $wgShowRollbackEditCount )->parse();
1840 } else {
1841 $html = $context->msg( 'rollbacklinkcount' )->numParams( $editCount )->parse();
1842 }
1843
1844 return self::link( $title, $html, $attrs, $query, $options );
1845 } else {
1846 $html = $context->msg( 'rollbacklink' )->escaped();
1847 return self::link( $title, $html, $attrs, $query, $options );
1848 }
1849 }
1850
1869 public static function formatTemplates( $templates, $preview = false,
1870 $section = false, $more = null
1871 ) {
1872 wfDeprecated( __METHOD__, '1.28' );
1873
1874 $type = false;
1875 if ( $preview ) {
1876 $type = 'preview';
1877 } elseif ( $section ) {
1878 $type = 'section';
1879 }
1880
1881 if ( $more instanceof Message ) {
1882 $more = $more->toString();
1883 }
1884
1885 $formatter = new TemplatesOnThisPageFormatter(
1887 MediaWikiServices::getInstance()->getLinkRenderer()
1888 );
1889 return $formatter->format( $templates, $type, $more );
1890 }
1891
1900 public static function formatHiddenCategories( $hiddencats ) {
1901 $outText = '';
1902 if ( count( $hiddencats ) > 0 ) {
1903 # Construct the HTML
1904 $outText = '<div class="mw-hiddenCategoriesExplanation">';
1905 $outText .= wfMessage( 'hiddencategories' )->numParams( count( $hiddencats ) )->parseAsBlock();
1906 $outText .= "</div><ul>\n";
1907
1908 foreach ( $hiddencats as $titleObj ) {
1909 # If it's hidden, it must exist - no need to check with a LinkBatch
1910 $outText .= '<li>'
1911 . self::link( $titleObj, null, [], [], 'known' )
1912 . "</li>\n";
1913 }
1914 $outText .= '</ul>';
1915 }
1916 return $outText;
1917 }
1918
1929 public static function formatSize( $size ) {
1930 wfDeprecated( __METHOD__, '1.28' );
1931
1933 return htmlspecialchars( $wgLang->formatSize( $size ) );
1934 }
1935
1951 public static function titleAttrib( $name, $options = null, array $msgParams = [] ) {
1952 $message = wfMessage( "tooltip-$name", $msgParams );
1953 if ( !$message->exists() ) {
1954 $tooltip = false;
1955 } else {
1956 $tooltip = $message->text();
1957 # Compatibility: formerly some tooltips had [alt-.] hardcoded
1958 $tooltip = preg_replace( "/ ?\[alt-.\]$/", '', $tooltip );
1959 # Message equal to '-' means suppress it.
1960 if ( $tooltip == '-' ) {
1961 $tooltip = false;
1962 }
1963 }
1964
1965 if ( $options == 'withaccess' ) {
1966 $accesskey = self::accesskey( $name );
1967 if ( $accesskey !== false ) {
1968 // Should be build the same as in jquery.accessKeyLabel.js
1969 if ( $tooltip === false || $tooltip === '' ) {
1970 $tooltip = wfMessage( 'brackets', $accesskey )->text();
1971 } else {
1972 $tooltip .= wfMessage( 'word-separator' )->text();
1973 $tooltip .= wfMessage( 'brackets', $accesskey )->text();
1974 }
1975 }
1976 }
1977
1978 return $tooltip;
1979 }
1980
1981 public static $accesskeycache;
1982
1994 public static function accesskey( $name ) {
1995 if ( isset( self::$accesskeycache[$name] ) ) {
1996 return self::$accesskeycache[$name];
1997 }
1998
1999 $message = wfMessage( "accesskey-$name" );
2000
2001 if ( !$message->exists() ) {
2002 $accesskey = false;
2003 } else {
2004 $accesskey = $message->plain();
2005 if ( $accesskey === '' || $accesskey === '-' ) {
2006 # @todo FIXME: Per standard MW behavior, a value of '-' means to suppress the
2007 # attribute, but this is broken for accesskey: that might be a useful
2008 # value.
2009 $accesskey = false;
2010 }
2011 }
2012
2013 self::$accesskeycache[$name] = $accesskey;
2014 return self::$accesskeycache[$name];
2015 }
2016
2030 public static function getRevDeleteLink( User $user, Revision $rev, Title $title ) {
2031 $canHide = $user->isAllowed( 'deleterevision' );
2032 if ( !$canHide && !( $rev->getVisibility() && $user->isAllowed( 'deletedhistory' ) ) ) {
2033 return '';
2034 }
2035
2036 if ( !$rev->userCan( Revision::DELETED_RESTRICTED, $user ) ) {
2037 return self::revDeleteLinkDisabled( $canHide ); // revision was hidden from sysops
2038 } else {
2039 if ( $rev->getId() ) {
2040 // RevDelete links using revision ID are stable across
2041 // page deletion and undeletion; use when possible.
2042 $query = [
2043 'type' => 'revision',
2044 'target' => $title->getPrefixedDBkey(),
2045 'ids' => $rev->getId()
2046 ];
2047 } else {
2048 // Older deleted entries didn't save a revision ID.
2049 // We have to refer to these by timestamp, ick!
2050 $query = [
2051 'type' => 'archive',
2052 'target' => $title->getPrefixedDBkey(),
2053 'ids' => $rev->getTimestamp()
2054 ];
2055 }
2057 $rev->isDeleted( Revision::DELETED_RESTRICTED ), $canHide );
2058 }
2059 }
2060
2071 public static function revDeleteLink( $query = [], $restricted = false, $delete = true ) {
2072 $sp = SpecialPage::getTitleFor( 'Revisiondelete' );
2073 $msgKey = $delete ? 'rev-delundel' : 'rev-showdeleted';
2074 $html = wfMessage( $msgKey )->escaped();
2075 $tag = $restricted ? 'strong' : 'span';
2076 $link = self::link( $sp, $html, [], $query, [ 'known', 'noclasses' ] );
2077 return Xml::tags(
2078 $tag,
2079 [ 'class' => 'mw-revdelundel-link' ],
2080 wfMessage( 'parentheses' )->rawParams( $link )->escaped()
2081 );
2082 }
2083
2093 public static function revDeleteLinkDisabled( $delete = true ) {
2094 $msgKey = $delete ? 'rev-delundel' : 'rev-showdeleted';
2095 $html = wfMessage( $msgKey )->escaped();
2096 $htmlParentheses = wfMessage( 'parentheses' )->rawParams( $html )->escaped();
2097 return Xml::tags( 'span', [ 'class' => 'mw-revdelundel-link' ], $htmlParentheses );
2098 }
2099
2100 /* Deprecated methods */
2101
2111 public static function tooltipAndAccesskeyAttribs( $name, array $msgParams = [] ) {
2112 $attribs = [
2113 'title' => self::titleAttrib( $name, 'withaccess', $msgParams ),
2114 'accesskey' => self::accesskey( $name )
2115 ];
2116 if ( $attribs['title'] === false ) {
2117 unset( $attribs['title'] );
2118 }
2119 if ( $attribs['accesskey'] === false ) {
2120 unset( $attribs['accesskey'] );
2121 }
2122 return $attribs;
2123 }
2124
2132 public static function tooltip( $name, $options = null ) {
2133 $tooltip = self::titleAttrib( $name, $options );
2134 if ( $tooltip === false ) {
2135 return '';
2136 }
2137 return Xml::expandAttributes( [
2138 'title' => $tooltip
2139 ] );
2140 }
2141
2142}
Apache License January AND DISTRIBUTION Definitions License shall mean the terms and conditions for use
target page
$wgThumbUpright
Adjust width of upright images when parameter 'upright' is used This allows a nicer look for upright ...
$wgThumbLimits
Adjust thumbnails on image pages according to a user setting.
$wgDisableAnonTalk
Disable links to talk pages of anonymous users (IPs) in listings on special pages like page history,...
$wgSVGMaxSize
Don't scale a SVG larger than this.
$wgShowRollbackEditCount
The $wgShowRollbackEditCount variable is used to show how many edits can be rolled back.
$wgUploadMissingFileUrl
Point the upload link for missing files to an external URL, as with $wgUploadNavigationUrl.
$wgUploadNavigationUrl
Point the upload navigation link to an external URL Useful if you want to use a shared repository by ...
$wgResponsiveImages
Generate and use thumbnails suitable for screens with 1.5 and 2.0 pixel densities.
$wgEnableUploads
Uploads have to be specially set up to be secure.
$wgMiserMode
Disable database-intensive features.
wfGetLangObj( $langcode=false)
Return a Language object from $langcode.
wfDebug( $text, $dest='all', array $context=[])
Sends a line to the debug log if enabled or, optionally, to a comment in output.
wfWarn( $msg, $callerOffset=1, $level=E_USER_NOTICE)
Send a warning either to the debug log or in a PHP error depending on $wgDevelopmentWarnings.
wfGetDB( $db, $groups=[], $wiki=false)
Get a Database object.
wfFindFile( $title, $options=[])
Find a file.
wfAppendQuery( $url, $query)
Append a query string to an existing URL, which may or may not already have query string parameters a...
wfCgiToArray( $query)
This is the logical opposite of wfArrayToCgi(): it accepts a query string as its argument and returns...
wfDeprecated( $function, $version=false, $component=false, $callerOffset=2)
Throws a warning that $function is deprecated.
$fallback
$wgUser
Definition Setup.php:817
if(! $wgRequest->checkUrlExtension()) if(isset($_SERVER[ 'PATH_INFO']) &&$_SERVER[ 'PATH_INFO'] !='') if(! $wgEnableAPI) $wgTitle
Definition api.php:68
Marks HTML that shouldn't be escaped.
Definition HtmlArmor.php:28
Some internal bits split of from Skin.php.
Definition Linker.php:34
static tocList( $toc, $lang=false)
Wraps the TOC in a table and provides the hide/collapse javascript.
Definition Linker.php:1571
static generateRollback( $rev, IContextSource $context=null, $options=[ 'verify'])
Generate a rollback link for a given revision.
Definition Linker.php:1691
static makeMediaLinkFile(Title $title, $file, $html='')
Create a direct link to a given uploaded file.
Definition Linker.php:783
static link( $target, $html=null, $customAttribs=[], $query=[], $options=[])
This function returns an HTML link to the given target.
Definition Linker.php:107
static fnamePart( $url)
Returns the filename part of an url.
Definition Linker.php:251
static tocLine( $anchor, $tocline, $tocnumber, $level, $sectionIndex=false)
parameter level defines if we are on an indentation level
Definition Linker.php:1535
static userLink( $userId, $userName, $altUserName=false)
Make user link (or user contributions for unregistered users)
Definition Linker.php:893
static $accesskeycache
Definition Linker.php:1981
static titleAttrib( $name, $options=null, array $msgParams=[])
Given the id of an interface element, constructs the appropriate title attribute from the system mess...
Definition Linker.php:1951
static makeThumbLink2(Title $title, $file, $frameParams=[], $handlerParams=[], $time=false, $query="")
Definition Linker.php:533
static formatSize( $size)
Definition Linker.php:1929
static accesskey( $name)
Given the id of an interface element, constructs the appropriate accesskey attribute from the system ...
Definition Linker.php:1994
static formatAutocomments( $comment, $title=null, $local=false, $wikiId=null)
Converts autogenerated comments in edit summaries into section links.
Definition Linker.php:1131
static specialLink( $name, $key='')
Make a link to a special page given its name and, optionally, a message key from the link text.
Definition Linker.php:824
static getLinkColour(LinkTarget $t, $threshold)
Return the CSS colour of a known link.
Definition Linker.php:51
static makeImageLink(Parser $parser, Title $title, $file, $frameParams=[], $handlerParams=[], $time=false, $query="", $widthOption=null)
Given parameters derived from [[Image:Foo|options...]], generate the HTML that that syntax inserts in...
Definition Linker.php:324
static linkKnown( $target, $html=null, $customAttribs=[], $query=[], $options=[ 'known'])
Identical to link(), except $options defaults to 'known'.
Definition Linker.php:164
static generateTOC( $tree, $lang=false)
Generate a table of contents from a section tree.
Definition Linker.php:1589
static makeExternalImage( $url, $alt='')
Return the code for images which were added via external links, via Parser::maybeMakeExternalImage().
Definition Linker.php:271
static userToolLinksRedContribs( $userId, $userText, $edits=null)
Alias for userToolLinks( $userId, $userText, true );.
Definition Linker.php:983
static buildRollbackLink( $rev, IContextSource $context=null, $editCount=false)
Build a raw rollback link, useful for collections of "tool" links.
Definition Linker.php:1790
static makeCommentLink(LinkTarget $linkTarget, $text, $wikiId=null, $options=[])
Generates a link to the given Title.
Definition Linker.php:1330
static processResponsiveImages( $file, $thumb, $hp)
Process responsive images: add 1.5x and 2x subimages to the thumbnail, where applicable.
Definition Linker.php:655
static blockLink( $userId, $userText)
Definition Linker.php:1008
static revDeleteLinkDisabled( $delete=true)
Creates a dead (show/hide) link for deleting revisions/log entries.
Definition Linker.php:2093
static getRollbackEditCount( $rev, $verify)
This function will return the number of revisions which a rollback would revert and,...
Definition Linker.php:1730
static normalizeSubpageLink( $contextTitle, $target, &$text)
Definition Linker.php:1359
static revComment(Revision $rev, $local=false, $isPublic=false)
Wrap and format the given revision's comment block, if the current user is allowed to view it.
Definition Linker.php:1470
const TOOL_LINKS_NOBLOCK
Flags for userToolLinks()
Definition Linker.php:38
static makeSelfLinkObj( $nt, $html='', $query='', $trail='', $prefix='')
Make appropriate markup for a link to the current article.
Definition Linker.php:186
static getUploadUrl( $destFile, $query='')
Get the URL to upload a certain file.
Definition Linker.php:740
static tocIndent()
Add another level to the Table of Contents.
Definition Linker.php:1509
static revUserLink( $rev, $isPublic=false)
Generate a user link if the current user is allowed to view it.
Definition Linker.php:1038
static commentBlock( $comment, $title=null, $local=false, $wikiId=null)
Wrap a comment in standard punctuation and formatting if it's non-empty, otherwise return empty strin...
Definition Linker.php:1445
static tooltipAndAccesskeyAttribs( $name, array $msgParams=[])
Returns the attributes for the tooltip and access key.
Definition Linker.php:2111
static getInvalidTitleDescription(IContextSource $context, $namespace, $title)
Get a message saying that an invalid title was encountered.
Definition Linker.php:209
static revUserTools( $rev, $isPublic=false)
Generate a user tool link cluster if the current user is allowed to view it.
Definition Linker.php:1060
static emailLink( $userId, $userText)
Definition Linker.php:1022
static makeThumbLinkObj(Title $title, $file, $label='', $alt, $align='right', $params=[], $framed=false, $manualthumb="")
Make HTML for a thumbnail including image, border and caption.
Definition Linker.php:507
static formatHiddenCategories( $hiddencats)
Returns HTML for the "hidden categories on this page" list.
Definition Linker.php:1900
static splitTrail( $trail)
Split a link trail, return the "inside" portion and the remainder of the trail as a two-element array...
Definition Linker.php:1650
const TOOL_LINKS_EMAIL
Definition Linker.php:39
static userToolLinks( $userId, $userText, $redContribsWhenNoEdits=false, $flags=0, $edits=null)
Generate standard user tool links (talk, contributions, block link, etc.)
Definition Linker.php:926
static formatRevisionSize( $size)
Definition Linker.php:1493
static tooltip( $name, $options=null)
Returns raw bits of HTML, use titleAttrib()
Definition Linker.php:2132
static userTalkLink( $userId, $userText)
Definition Linker.php:993
static formatLinksInComment( $comment, $title=null, $local=false, $wikiId=null)
Formats wiki links and media links in text; all other wiki formatting is ignored.
Definition Linker.php:1224
static makeMediaLinkObj( $title, $html='', $time=false)
Create a direct link to a given uploaded file.
Definition Linker.php:766
static makeExternalLink( $url, $text, $escape=true, $linktype='', $attribs=[], $title=null)
Make an external link.
Definition Linker.php:843
static normaliseSpecialPage(LinkTarget $target)
Definition Linker.php:230
static makeHeadline( $level, $attribs, $anchor, $html, $link, $fallbackAnchor=false)
Create a headline for content.
Definition Linker.php:1627
static formatTemplates( $templates, $preview=false, $section=false, $more=null)
Definition Linker.php:1869
static tocUnindent( $level)
Finish one or more sublevels on the Table of Contents.
Definition Linker.php:1520
static getImageLinkMTOParams( $frameParams, $query='', $parser=null)
Get the link parameters for MediaTransformOutput::toHtml() from given frame parameters supplied by th...
Definition Linker.php:468
static revDeleteLink( $query=[], $restricted=false, $delete=true)
Creates a (show/hide) link for deleting revisions/log entries.
Definition Linker.php:2071
static tocLineEnd()
End a Table Of Contents line.
Definition Linker.php:1559
static formatComment( $comment, $title=null, $local=false, $wikiId=null)
This function is called by all recent changes variants, by the page history, and by the user contribu...
Definition Linker.php:1099
static makeBrokenImageLinkObj( $title, $label='', $query='', $unused1='', $unused2='', $time=false)
Make a "broken" link to an image.
Definition Linker.php:690
static getRevDeleteLink(User $user, Revision $rev, Title $title)
Get a revision-deletion link, or disabled link, or nothing, depending on user permissions & the setti...
Definition Linker.php:2030
MediaWikiServices is the service locator for the application scope of MediaWiki.
getTitle()
Get the Title object that we'll be acting on, as specified in the WebRequest.
The Message class provides methods which fulfil two basic services:
Definition Message.php:159
PHP Parser - Processes wiki markup (which uses a more user-friendly syntax, such as "[[link]]" for ma...
Definition Parser.php:70
static singleton()
Get a RepoGroup instance.
Definition RepoGroup.php:59
static getMain()
Static methods.
const DELETED_USER
Definition Revision.php:92
const DELETED_TEXT
Definition Revision.php:90
const DELETED_RESTRICTED
Definition Revision.php:93
const RAW
Definition Revision.php:100
const DELETED_COMMENT
Definition Revision.php:91
const FOR_THIS_USER
Definition Revision.php:99
static resolveAlias( $alias)
Given a special page name with a possible subpage, return an array where the first element is the spe...
static getTitleFor( $name, $subpage=false, $fragment='')
Get a localised Title object for a specified special page name If you don't need a full Title object,...
static getTitleValueFor( $name, $subpage=false, $fragment='')
Get a localised TitleValue object for a specified special page name.
static escapeRegexReplacement( $string)
Escape a string to make it suitable for inclusion in a preg_replace() replacement parameter.
Handles formatting for the "templates used on this page" lists.
Represents a title within MediaWiki.
Definition Title.php:39
The User object encapsulates all of the user-specific settings (user_id, name, rights,...
Definition User.php:51
static getForeignURL( $wikiID, $page, $fragmentId=null)
Convenience to get a url to a page on a foreign wiki.
Definition WikiMap.php:171
$res
Definition database.txt:21
We use the convention $dbr for read and $dbw for write to help you keep track of whether the database object is a the world will explode Or to be a subsequent write query which succeeded on the master may fail when replicated to the slave due to a unique key collision Replication on the slave will stop and it may take hours to repair the database and get it back online Setting read_only in my cnf on the slave will avoid this but given the dire we prefer to have as many checks as possible We provide a but the wrapper functions like please read the documentation for except in special pages derived from QueryPage It s a common pitfall for new developers to submit code containing SQL queries which examine huge numbers of rows Remember that COUNT * is(N), counting rows in atable is like counting beans in a bucket.------------------------------------------------------------------------ Replication------------------------------------------------------------------------The largest installation of MediaWiki, Wikimedia, uses a large set ofslave MySQL servers replicating writes made to a master MySQL server. Itis important to understand the issues associated with this setup if youwant to write code destined for Wikipedia.It 's often the case that the best algorithm to use for a given taskdepends on whether or not replication is in use. Due to our unabashedWikipedia-centrism, we often just use the replication-friendly version, but if you like, you can use wfGetLB() ->getServerCount() > 1 tocheck to see if replication is in use.===Lag===Lag primarily occurs when large write queries are sent to the master.Writes on the master are executed in parallel, but they are executed inserial when they are replicated to the slaves. The master writes thequery to the binlog when the transaction is committed. The slaves pollthe binlog and start executing the query as soon as it appears. They canservice reads while they are performing a write query, but will not readanything more from the binlog and thus will perform no more writes. Thismeans that if the write query runs for a long time, the slaves will lagbehind the master for the time it takes for the write query to complete.Lag can be exacerbated by high read load. MediaWiki 's load balancer willstop sending reads to a slave when it is lagged by more than 30 seconds.If the load ratios are set incorrectly, or if there is too much loadgenerally, this may lead to a slave permanently hovering around 30seconds lag.If all slaves are lagged by more than 30 seconds, MediaWiki will stopwriting to the database. All edits and other write operations will berefused, with an error returned to the user. This gives the slaves achance to catch up. Before we had this mechanism, the slaves wouldregularly lag by several minutes, making review of recent editsdifficult.In addition to this, MediaWiki attempts to ensure that the user seesevents occurring on the wiki in chronological order. A few seconds of lagcan be tolerated, as long as the user sees a consistent picture fromsubsequent requests. This is done by saving the master binlog positionin the session, and then at the start of each request, waiting for theslave to catch up to that position before doing any reads from it. Ifthis wait times out, reads are allowed anyway, but the request isconsidered to be in "lagged slave mode". Lagged slave mode can bechecked by calling wfGetLB() ->getLaggedSlaveMode(). The onlypractical consequence at present is a warning displayed in the pagefooter.===Lag avoidance===To avoid excessive lag, queries which write large numbers of rows shouldbe split up, generally to write one row at a time. Multi-row INSERT ...SELECT queries are the worst offenders should be avoided altogether.Instead do the select first and then the insert.===Working with lag===Despite our best efforts, it 's not practical to guarantee a low-lagenvironment. Lag will usually be less than one second, but mayoccasionally be up to 30 seconds. For scalability, it 's very importantto keep load on the master low, so simply sending all your queries tothe master is not the answer. So when you have a genuine need forup-to-date data, the following approach is advised:1) Do a quick query to the master for a sequence number or timestamp 2) Run the full query on the slave and check if it matches the data you gotfrom the master 3) If it doesn 't, run the full query on the masterTo avoid swamping the master every time the slaves lag, use of thisapproach should be kept to a minimum. In most cases you should just readfrom the slave and let the user deal with the delay.------------------------------------------------------------------------ Lock contention------------------------------------------------------------------------Due to the high write rate on Wikipedia(and some other wikis), MediaWiki developers need to be very careful to structure their writesto avoid long-lasting locks. By default, MediaWiki opens a transactionat the first query, and commits it before the output is sent. Locks willbe held from the time when the query is done until the commit. So youcan reduce lock time by doing as much processing as possible before youdo your write queries.Often this approach is not good enough, and it becomes necessary toenclose small groups of queries in their own transaction. Use thefollowing syntax:$dbw=wfGetDB(DB_MASTER
deferred txt A few of the database updates required by various functions here can be deferred until after the result page is displayed to the user For updating the view updating the linked to tables after a etc PHP does not yet have any way to tell the server to actually return and disconnect while still running these but it might have such a feature in the future We handle these by creating a deferred update object and putting those objects on a global list
Definition deferred.txt:11
this class mediates it Skin Encapsulates a look and feel for the wiki All of the functions that render HTML and make choices about how to render it are here and are called from various other places when and is meant to be subclassed with other skins that may override some of its functions The User object contains a reference to a and so rather than having a global skin object we just rely on the global User and get the skin with $wgUser and also has some character encoding functions and other locale stuff The current user interface language is instantiated as and the local content language as $wgContLang
Definition design.txt:57
design txt This is a brief overview of the new design More thorough and up to date information is available on the documentation wiki at etc Handles the details of getting and saving to the user table of the and dealing with sessions and cookies OutputPage Encapsulates the entire HTML page that will be sent in response to any server request It is used by calling its functions to add in any and then calling but I prefer the flexibility This should also do the output encoding The system allocates a global one in $wgOut Title Represents the title of an and does all the work of translating among various forms such as plain database etc For and for historical reasons
Definition design.txt:27
when a variable name is used in a it is silently declared as a new local masking the global
Definition design.txt:95
design txt This is a brief overview of the new design More thorough and up to date information is available on the documentation wiki at etc Handles the details of getting and saving to the user table of the and dealing with sessions and cookies OutputPage Encapsulates the entire HTML page that will be sent in response to any server request It is used by calling its functions to add text
Definition design.txt:18
this class mediates it Skin Encapsulates a look and feel for the wiki All of the functions that render HTML and make choices about how to render it are here and are called from various other places when and is meant to be subclassed with other skins that may override some of its functions The User object contains a reference to a and so rather than having a global skin object we just rely on the global User and get the skin with $wgUser and also has some character encoding functions and other locale stuff The current user interface language is instantiated as $wgLang
Definition design.txt:56
This document is intended to provide useful advice for parties seeking to redistribute MediaWiki to end users It s targeted particularly at maintainers for Linux since it s been observed that distribution packages of MediaWiki often break We ve consistently had to recommend that users seeking support use official tarballs instead of their distribution s and this often solves whatever problem the user is having It would be nice if this could such as
This document is intended to provide useful advice for parties seeking to redistribute MediaWiki to end users It s targeted particularly at maintainers for Linux since it s been observed that distribution packages of MediaWiki often break We ve consistently had to recommend that users seeking support use official tarballs instead of their distribution s and this often solves whatever problem the user is having It would be nice if this could change
const NS_USER
Definition Defines.php:67
const NS_FILE
Definition Defines.php:71
const NS_MAIN
Definition Defines.php:65
const NS_SPECIAL
Definition Defines.php:54
const NS_MEDIA
Definition Defines.php:53
const NS_USER_TALK
Definition Defines.php:68
the array() calling protocol came about after MediaWiki 1.4rc1.
do that in ParserLimitReportFormat instead $parser
Definition hooks.txt:2572
see documentation in includes Linker php for Linker::makeImageLink & $time
Definition hooks.txt:1778
return true to allow those checks to and false if checking is done remove or add to the links of a group of changes in EnhancedChangesList Hook subscribers can return false to omit this line from recentchanges use this to change the tables headers change it to an object instance and return false override the list derivative used the name of the old file when set the default code will be skipped $pre
Definition hooks.txt:1575
return true to allow those checks to and false if checking is done remove or add to the links of a group of changes in EnhancedChangesList Hook subscribers can return false to omit this line from recentchanges use this to change the tables headers change it to an object instance and return false override the list derivative used the name of the old file when set the default code will be skipped true if there is text before this autocomment $auto
Definition hooks.txt:1577
null means default in associative array with keys and values unescaped Should be merged with default with a value of false meaning to suppress the attribute in associative array with keys and values unescaped & $options
Definition hooks.txt:1971
usually copyright or history_copyright This message must be in HTML not wikitext if the section is included from a template to be included in the link
Definition hooks.txt:2991
do that in ParserLimitReportFormat instead use this to modify the parameters of the image all existing parser cache entries will be invalid To avoid you ll need to handle that somehow(e.g. with the RejectParserCacheValue hook) because MediaWiki won 't do it for you. & $defaults also a ContextSource after deleting those rows but within the same transaction you ll probably need to make sure the header is varied on and they can depend only on the ResourceLoaderContext $context
Definition hooks.txt:2780
null means default & $customAttribs
Definition hooks.txt:1965
namespace and then decline to actually register it file or subcat img or subcat $title
Definition hooks.txt:962
either a unescaped string or a HtmlArmor object after in associative array form externallinks including delete and has completed for all link tables whether this was an auto creation default is conds Array Extra conditions for the No matching items in log is displayed if loglist is empty msgKey Array If you want a nice box with a set this to the key of the message First element is the message additional optional elements are parameters for the key that are processed with wfMessage() -> params() ->parseAsBlock() - offset Set to overwrite offset parameter in $wgRequest set to '' to unset offset - wrap String Wrap the message in html(usually something like "&lt;div ...>$1&lt;/div>"). - flags Integer display flags(NO_ACTION_LINK, NO_EXTRA_USER_LINKS) 'LogException':Called before an exception(or PHP error) is logged. This is meant for integration with external error aggregation services
it s the revision text itself In either if gzip is the revision text is gzipped $flags
Definition hooks.txt:2805
static configuration should be added through ResourceLoaderGetConfigVars instead can be used to get the real title after the basic globals have been set but before ordinary actions take place or wrap services the preferred way to define a new service is the $wgServiceWiringFiles array $services
Definition hooks.txt:2243
null means default in associative array with keys and values unescaped Should be merged with default with a value of false meaning to suppress the attribute in associative array with keys and values unescaped noclasses & $ret
Definition hooks.txt:1975
null means default in associative array with keys and values unescaped Should be merged with default with a value of false meaning to suppress the attribute in associative array with keys and values unescaped noclasses just before the function returns a value If you return an< a > element with HTML attributes $attribs and contents $html will be returned If you return $ret will be returned and may include noclasses & $html
Definition hooks.txt:1983
usually copyright or history_copyright This message must be in HTML not wikitext & $link
Definition hooks.txt:2989
Allows to change the fields on the form that will be generated $name
Definition hooks.txt:302
null means default in associative array with keys and values unescaped Should be merged with default with a value of false meaning to suppress the attribute in associative array with keys and values unescaped noclasses just before the function returns a value If you return an< a > element with HTML attributes $attribs and contents $html will be returned If you return $ret will be returned and may include noclasses after processing & $attribs
Definition hooks.txt:1984
null for the local wiki Added should default to null in handler for backwards compatibility add a value to it if you want to add a cookie that have to vary cache options can modify $query
Definition hooks.txt:1610
null means default in associative array with keys and values unescaped Should be merged with default with a value of false meaning to suppress the attribute in associative array with keys and values unescaped noclasses just before the function returns a value If you return an< a > element with HTML attributes $attribs and contents $html will be returned If you return $ret will be returned and may include noclasses after processing after in associative array form before processing starts Return false to skip default processing and return $ret $linkRenderer
Definition hooks.txt:2026
see documentation in includes Linker php for Linker::makeImageLink & $handlerParams
Definition hooks.txt:1776
usually copyright or history_copyright This message must be in HTML not wikitext if the section is included from a template $section
Definition hooks.txt:2990
presenting them properly to the user as errors is done by the caller return true use this to change the list i e etc $rev
Definition hooks.txt:1760
processing should stop and the error should be shown to the user * false
Definition hooks.txt:187
please add to it if you re going to add events to the MediaWiki code where normally authentication against an external auth plugin would be creating a local account $user
Definition hooks.txt:247
injection txt This is an overview of how MediaWiki makes use of dependency injection The design described here grew from the discussion of RFC T384 The term dependency this means that anything an object needs to operate should be injected from the the object itself should only know narrow no concrete implementation of the logic it relies on The requirement to inject everything typically results in an architecture that based on two main types of and essentially stateless service objects that use other service objects to operate on the value objects As of the beginning MediaWiki is only starting to use the DI approach Much of the code still relies on global state or direct resulting in a highly cyclical dependency which acts as the top level factory for services in MediaWiki which can be used to gain access to default instances of various services MediaWikiServices however also allows new services to be defined and default services to be redefined Services are defined or redefined by providing a callback the instantiator that will return a new instance of the service When it will create an instance of MediaWikiServices and populate it with the services defined in the files listed by thereby bootstrapping the DI framework Per $wgServiceWiringFiles lists includes ServiceWiring php
Definition injection.txt:37
Interface for objects which can provide a MediaWiki context on request.
getFragment()
Get the link fragment (i.e.
getNamespace()
Get the namespace index.
getDBkey()
Get the main part with underscores.
isExternal()
Whether this LinkTarget has an interwiki component.
controlled by $wgMainCacheType controlled by $wgParserCacheType controlled by $wgMessageCacheType If you set CACHE_NONE to one of the three control default value for MediaWiki still create a but requests to it are no ops and we always fall through to the database If the cache daemon can t be it should also disable itself fairly smoothly By $wgMemc is used but when it is $parserMemc or $messageMemc this is mentioned below
Definition memcached.txt:96
const DB_REPLICA
Definition defines.php:25
$params
if(!isset( $args[0])) $lang