MediaWiki REL1_28
SkinTemplate.php
Go to the documentation of this file.
1<?php
23
38class SkinTemplate extends Skin {
43 public $skinname = 'monobook';
44
49 public $template = 'QuickTemplate';
50
51 public $thispage;
52 public $titletxt;
53 public $userpage;
54 public $thisquery;
55 public $loggedin;
56 public $username;
58
65 $moduleStyles = [
66 'mediawiki.legacy.shared',
67 'mediawiki.legacy.commonPrint',
68 'mediawiki.sectionAnchor'
69 ];
70 if ( $out->isSyndicated() ) {
71 $moduleStyles[] = 'mediawiki.feedlink';
72 }
73
74 // Deprecated since 1.26: Unconditional loading of mediawiki.ui.button
75 // on every page is deprecated. Express a dependency instead.
76 if ( strpos( $out->getHTML(), 'mw-ui-button' ) !== false ) {
77 $moduleStyles[] = 'mediawiki.ui.button';
78 }
79
80 $out->addModuleStyles( $moduleStyles );
81 }
82
94 function setupTemplate( $classname, $repository = false, $cache_dir = false ) {
95 return new $classname( $this->getConfig() );
96 }
97
103 public function getLanguages() {
106 return [];
107 }
108
109 $userLang = $this->getLanguage();
110 $languageLinks = [];
111
112 foreach ( $this->getOutput()->getLanguageLinks() as $languageLinkText ) {
113 $class = 'interlanguage-link interwiki-' . explode( ':', $languageLinkText, 2 )[0];
114
115 $languageLinkTitle = Title::newFromText( $languageLinkText );
116 if ( $languageLinkTitle ) {
117 $ilInterwikiCode = $languageLinkTitle->getInterwiki();
118 $ilLangName = Language::fetchLanguageName( $ilInterwikiCode );
119
120 if ( strval( $ilLangName ) === '' ) {
121 $ilDisplayTextMsg = wfMessage( "interlanguage-link-$ilInterwikiCode" );
122 if ( !$ilDisplayTextMsg->isDisabled() ) {
123 // Use custom MW message for the display text
124 $ilLangName = $ilDisplayTextMsg->text();
125 } else {
126 // Last resort: fallback to the language link target
127 $ilLangName = $languageLinkText;
128 }
129 } else {
130 // Use the language autonym as display text
131 $ilLangName = $this->formatLanguageName( $ilLangName );
132 }
133
134 // CLDR extension or similar is required to localize the language name;
135 // otherwise we'll end up with the autonym again.
136 $ilLangLocalName = Language::fetchLanguageName(
137 $ilInterwikiCode,
138 $userLang->getCode()
139 );
140
141 $languageLinkTitleText = $languageLinkTitle->getText();
142 if ( $ilLangLocalName === '' ) {
143 $ilFriendlySiteName = wfMessage( "interlanguage-link-sitename-$ilInterwikiCode" );
144 if ( !$ilFriendlySiteName->isDisabled() ) {
145 if ( $languageLinkTitleText === '' ) {
146 $ilTitle = wfMessage(
147 'interlanguage-link-title-nonlangonly',
148 $ilFriendlySiteName->text()
149 )->text();
150 } else {
151 $ilTitle = wfMessage(
152 'interlanguage-link-title-nonlang',
153 $languageLinkTitleText,
154 $ilFriendlySiteName->text()
155 )->text();
156 }
157 } else {
158 // we have nothing friendly to put in the title, so fall back to
159 // displaying the interlanguage link itself in the title text
160 // (similar to what is done in page content)
161 $ilTitle = $languageLinkTitle->getInterwiki() .
162 ":$languageLinkTitleText";
163 }
164 } elseif ( $languageLinkTitleText === '' ) {
165 $ilTitle = wfMessage(
166 'interlanguage-link-title-langonly',
167 $ilLangLocalName
168 )->text();
169 } else {
170 $ilTitle = wfMessage(
171 'interlanguage-link-title',
172 $languageLinkTitleText,
173 $ilLangLocalName
174 )->text();
175 }
176
177 $ilInterwikiCodeBCP47 = wfBCP47( $ilInterwikiCode );
178 $languageLink = [
179 'href' => $languageLinkTitle->getFullURL(),
180 'text' => $ilLangName,
181 'title' => $ilTitle,
182 'class' => $class,
183 'link-class' => 'interlanguage-link-target',
184 'lang' => $ilInterwikiCodeBCP47,
185 'hreflang' => $ilInterwikiCodeBCP47,
186 ];
187 Hooks::run(
188 'SkinTemplateGetLanguageLink',
189 [ &$languageLink, $languageLinkTitle, $this->getTitle(), $this->getOutput() ]
190 );
191 $languageLinks[] = $languageLink;
192 }
193 }
194
195 return $languageLinks;
196 }
197
198 protected function setupTemplateForOutput() {
199
200 $request = $this->getRequest();
201 $user = $this->getUser();
202 $title = $this->getTitle();
203
204 $tpl = $this->setupTemplate( $this->template, 'skins' );
205
206 $this->thispage = $title->getPrefixedDBkey();
207 $this->titletxt = $title->getPrefixedText();
208 $this->userpage = $user->getUserPage()->getPrefixedText();
209 $query = [];
210 if ( !$request->wasPosted() ) {
211 $query = $request->getValues();
212 unset( $query['title'] );
213 unset( $query['returnto'] );
214 unset( $query['returntoquery'] );
215 }
216 $this->thisquery = wfArrayToCgi( $query );
217 $this->loggedin = $user->isLoggedIn();
218 $this->username = $user->getName();
219
220 if ( $this->loggedin ) {
221 $this->userpageUrlDetails = self::makeUrlDetails( $this->userpage );
222 } else {
223 # This won't be used in the standard skins, but we define it to preserve the interface
224 # To save time, we check for existence
225 $this->userpageUrlDetails = self::makeKnownUrlDetails( $this->userpage );
226 }
227
228 return $tpl;
229 }
230
236 function outputPage( OutputPage $out = null ) {
237 Profiler::instance()->setTemplated( true );
238
239 $oldContext = null;
240 if ( $out !== null ) {
241 // Deprecated since 1.20, note added in 1.25
242 wfDeprecated( __METHOD__, '1.25' );
243 $oldContext = $this->getContext();
244 $this->setContext( $out->getContext() );
245 }
246
247 $out = $this->getOutput();
248
249 $this->initPage( $out );
250 $tpl = $this->prepareQuickTemplate();
251 // execute template
252 $res = $tpl->execute();
253
254 // result may be an error
255 $this->printOrError( $res );
256
257 if ( $oldContext ) {
258 $this->setContext( $oldContext );
259 }
260
261 }
262
270 protected function wrapHTML( $title, $html ) {
271 # An ID that includes the actual body text; without categories, contentSub, ...
272 $realBodyAttribs = [ 'id' => 'mw-content-text' ];
273
274 # Add a mw-content-ltr/rtl class to be able to style based on text direction
275 # when the content is different from the UI language, i.e.:
276 # not for special pages or file pages AND only when viewing
277 if ( !in_array( $title->getNamespace(), [ NS_SPECIAL, NS_FILE ] ) &&
278 Action::getActionName( $this ) === 'view' ) {
279 $pageLang = $title->getPageViewLanguage();
280 $realBodyAttribs['lang'] = $pageLang->getHtmlCode();
281 $realBodyAttribs['dir'] = $pageLang->getDir();
282 $realBodyAttribs['class'] = 'mw-content-' . $pageLang->getDir();
283 }
284
285 return Html::rawElement( 'div', $realBodyAttribs, $html );
286 }
287
294 protected function prepareQuickTemplate() {
299
300 $title = $this->getTitle();
301 $request = $this->getRequest();
302 $out = $this->getOutput();
303 $tpl = $this->setupTemplateForOutput();
304
305 $tpl->set( 'title', $out->getPageTitle() );
306 $tpl->set( 'pagetitle', $out->getHTMLTitle() );
307 $tpl->set( 'displaytitle', $out->mPageLinkTitle );
308
309 $tpl->setRef( 'thispage', $this->thispage );
310 $tpl->setRef( 'titleprefixeddbkey', $this->thispage );
311 $tpl->set( 'titletext', $title->getText() );
312 $tpl->set( 'articleid', $title->getArticleID() );
313
314 $tpl->set( 'isarticle', $out->isArticle() );
315
316 $subpagestr = $this->subPageSubtitle();
317 if ( $subpagestr !== '' ) {
318 $subpagestr = '<span class="subpages">' . $subpagestr . '</span>';
319 }
320 $tpl->set( 'subtitle', $subpagestr . $out->getSubtitle() );
321
322 $undelete = $this->getUndeleteLink();
323 if ( $undelete === '' ) {
324 $tpl->set( 'undelete', '' );
325 } else {
326 $tpl->set( 'undelete', '<span class="subpages">' . $undelete . '</span>' );
327 }
328
329 $tpl->set( 'catlinks', $this->getCategories() );
330 if ( $out->isSyndicated() ) {
331 $feeds = [];
332 foreach ( $out->getSyndicationLinks() as $format => $link ) {
333 $feeds[$format] = [
334 // Messages: feed-atom, feed-rss
335 'text' => $this->msg( "feed-$format" )->text(),
336 'href' => $link
337 ];
338 }
339 $tpl->setRef( 'feeds', $feeds );
340 } else {
341 $tpl->set( 'feeds', false );
342 }
343
344 $tpl->setRef( 'mimetype', $wgMimeType );
345 $tpl->setRef( 'jsmimetype', $wgJsMimeType );
346 $tpl->set( 'charset', 'UTF-8' );
347 $tpl->setRef( 'wgScript', $wgScript );
348 $tpl->setRef( 'skinname', $this->skinname );
349 $tpl->set( 'skinclass', get_class( $this ) );
350 $tpl->setRef( 'skin', $this );
351 $tpl->setRef( 'stylename', $this->stylename );
352 $tpl->set( 'printable', $out->isPrintable() );
353 $tpl->set( 'handheld', $request->getBool( 'handheld' ) );
354 $tpl->setRef( 'loggedin', $this->loggedin );
355 $tpl->set( 'notspecialpage', !$title->isSpecialPage() );
356 $tpl->set( 'searchaction', $this->escapeSearchLink() );
357 $tpl->set( 'searchtitle', SpecialPage::getTitleFor( 'Search' )->getPrefixedDBkey() );
358 $tpl->set( 'search', trim( $request->getVal( 'search' ) ) );
359 $tpl->setRef( 'stylepath', $wgStylePath );
360 $tpl->setRef( 'articlepath', $wgArticlePath );
361 $tpl->setRef( 'scriptpath', $wgScriptPath );
362 $tpl->setRef( 'serverurl', $wgServer );
363 $tpl->setRef( 'logopath', $wgLogo );
364 $tpl->setRef( 'sitename', $wgSitename );
365
366 $userLang = $this->getLanguage();
367 $userLangCode = $userLang->getHtmlCode();
368 $userLangDir = $userLang->getDir();
369
370 $tpl->set( 'lang', $userLangCode );
371 $tpl->set( 'dir', $userLangDir );
372 $tpl->set( 'rtl', $userLang->isRTL() );
373
374 $tpl->set( 'capitalizeallnouns', $userLang->capitalizeAllNouns() ? ' capitalize-all-nouns' : '' );
375 $tpl->set( 'showjumplinks', true ); // showjumplinks preference has been removed
376 $tpl->set( 'username', $this->loggedin ? $this->username : null );
377 $tpl->setRef( 'userpage', $this->userpage );
378 $tpl->setRef( 'userpageurl', $this->userpageUrlDetails['href'] );
379 $tpl->set( 'userlang', $userLangCode );
380
381 // Users can have their language set differently than the
382 // content of the wiki. For these users, tell the web browser
383 // that interface elements are in a different language.
384 $tpl->set( 'userlangattributes', '' );
385 $tpl->set( 'specialpageattributes', '' ); # obsolete
386 // Used by VectorBeta to insert HTML before content but after the
387 // heading for the page title. Defaults to empty string.
388 $tpl->set( 'prebodyhtml', '' );
389
390 if ( $userLangCode !== $wgContLang->getHtmlCode() || $userLangDir !== $wgContLang->getDir() ) {
391 $escUserlang = htmlspecialchars( $userLangCode );
392 $escUserdir = htmlspecialchars( $userLangDir );
393 // Attributes must be in double quotes because htmlspecialchars() doesn't
394 // escape single quotes
395 $attrs = " lang=\"$escUserlang\" dir=\"$escUserdir\"";
396 $tpl->set( 'userlangattributes', $attrs );
397 }
398
399 $tpl->set( 'newtalk', $this->getNewtalks() );
400 $tpl->set( 'logo', $this->logoText() );
401
402 $tpl->set( 'copyright', false );
403 // No longer used
404 $tpl->set( 'viewcount', false );
405 $tpl->set( 'lastmod', false );
406 $tpl->set( 'credits', false );
407 $tpl->set( 'numberofwatchingusers', false );
408 if ( $out->isArticle() && $title->exists() ) {
409 if ( $this->isRevisionCurrent() ) {
410 if ( $wgMaxCredits != 0 ) {
411 $tpl->set( 'credits', Action::factory( 'credits', $this->getWikiPage(),
412 $this->getContext() )->getCredits( $wgMaxCredits, $wgShowCreditsIfMax ) );
413 } else {
414 $tpl->set( 'lastmod', $this->lastModified() );
415 }
416 }
417 $tpl->set( 'copyright', $this->getCopyright() );
418 }
419
420 $tpl->set( 'copyrightico', $this->getCopyrightIcon() );
421 $tpl->set( 'poweredbyico', $this->getPoweredBy() );
422 $tpl->set( 'disclaimer', $this->disclaimerLink() );
423 $tpl->set( 'privacy', $this->privacyLink() );
424 $tpl->set( 'about', $this->aboutLink() );
425
426 $tpl->set( 'footerlinks', [
427 'info' => [
428 'lastmod',
429 'numberofwatchingusers',
430 'credits',
431 'copyright',
432 ],
433 'places' => [
434 'privacy',
435 'about',
436 'disclaimer',
437 ],
438 ] );
439
441 $tpl->set( 'footericons', $wgFooterIcons );
442 foreach ( $tpl->data['footericons'] as $footerIconsKey => &$footerIconsBlock ) {
443 if ( count( $footerIconsBlock ) > 0 ) {
444 foreach ( $footerIconsBlock as &$footerIcon ) {
445 if ( isset( $footerIcon['src'] ) ) {
446 if ( !isset( $footerIcon['width'] ) ) {
447 $footerIcon['width'] = 88;
448 }
449 if ( !isset( $footerIcon['height'] ) ) {
450 $footerIcon['height'] = 31;
451 }
452 }
453 }
454 } else {
455 unset( $tpl->data['footericons'][$footerIconsKey] );
456 }
457 }
458
459 $tpl->set( 'indicators', $out->getIndicators() );
460
461 $tpl->set( 'sitenotice', $this->getSiteNotice() );
462 $tpl->set( 'printfooter', $this->printSource() );
463 // Wrap the bodyText with #mw-content-text element
464 $out->mBodytext = $this->wrapHTML( $title, $out->mBodytext );
465 $tpl->setRef( 'bodytext', $out->mBodytext );
466
467 $language_urls = $this->getLanguages();
468 if ( count( $language_urls ) ) {
469 $tpl->setRef( 'language_urls', $language_urls );
470 } else {
471 $tpl->set( 'language_urls', false );
472 }
473
474 # Personal toolbar
475 $tpl->set( 'personal_urls', $this->buildPersonalUrls() );
476 $content_navigation = $this->buildContentNavigationUrls();
477 $content_actions = $this->buildContentActionUrls( $content_navigation );
478 $tpl->setRef( 'content_navigation', $content_navigation );
479 $tpl->setRef( 'content_actions', $content_actions );
480
481 $tpl->set( 'sidebar', $this->buildSidebar() );
482 $tpl->set( 'nav_urls', $this->buildNavUrls() );
483
484 // Do this last in case hooks above add bottom scripts
485 $tpl->set( 'bottomscripts', $this->bottomScripts() );
486
487 // Set the head scripts near the end, in case the above actions resulted in added scripts
488 $tpl->set( 'headelement', $out->headElement( $this ) );
489
490 $tpl->set( 'debug', '' );
491 $tpl->set( 'debughtml', $this->generateDebugHTML() );
492 $tpl->set( 'reporttime', wfReportTime() );
493
494 // Avoid PHP 7.1 warning of passing $this by reference
495 $skinTemplate = $this;
496 // original version by hansm
497 if ( !Hooks::run( 'SkinTemplateOutputPageBeforeExec', [ &$skinTemplate, &$tpl ] ) ) {
498 wfDebug( __METHOD__ . ": Hook SkinTemplateOutputPageBeforeExec broke outputPage execution!\n" );
499 }
500
501 // Set the bodytext to another key so that skins can just output it on its own
502 // and output printfooter and debughtml separately
503 $tpl->set( 'bodycontent', $tpl->data['bodytext'] );
504
505 // Append printfooter and debughtml onto bodytext so that skins that
506 // were already using bodytext before they were split out don't suddenly
507 // start not outputting information.
508 $tpl->data['bodytext'] .= Html::rawElement(
509 'div',
510 [ 'class' => 'printfooter' ],
511 "\n{$tpl->data['printfooter']}"
512 ) . "\n";
513 $tpl->data['bodytext'] .= $tpl->data['debughtml'];
514
515 // allow extensions adding stuff after the page content.
516 // See Skin::afterContentHook() for further documentation.
517 $tpl->set( 'dataAfterContent', $this->afterContentHook() );
518
519 return $tpl;
520 }
521
526 public function getPersonalToolsList() {
527 $tpl = $this->setupTemplateForOutput();
528 $tpl->set( 'personal_urls', $this->buildPersonalUrls() );
529 $html = '';
530 foreach ( $tpl->getPersonalTools() as $key => $item ) {
531 $html .= $tpl->makeListItem( $key, $item );
532 }
533 return $html;
534 }
535
544 function formatLanguageName( $name ) {
545 return $this->getLanguage()->ucfirst( $name );
546 }
547
556 function printOrError( $str ) {
557 echo $str;
558 }
559
573
578 protected function buildPersonalUrls() {
579 $title = $this->getTitle();
580 $request = $this->getRequest();
581 $pageurl = $title->getLocalURL();
582 $authManager = AuthManager::singleton();
583
584 /* set up the default links for the personal toolbar */
585 $personal_urls = [];
586
587 # Due to bug 32276, if a user does not have read permissions,
588 # $this->getTitle() will just give Special:Badtitle, which is
589 # not especially useful as a returnto parameter. Use the title
590 # from the request instead, if there was one.
591 if ( $this->getUser()->isAllowed( 'read' ) ) {
592 $page = $this->getTitle();
593 } else {
594 $page = Title::newFromText( $request->getVal( 'title', '' ) );
595 }
596 $page = $request->getVal( 'returnto', $page );
597 $a = [];
598 if ( strval( $page ) !== '' ) {
599 $a['returnto'] = $page;
600 $query = $request->getVal( 'returntoquery', $this->thisquery );
601 if ( $query != '' ) {
602 $a['returntoquery'] = $query;
603 }
604 }
605
606 $returnto = wfArrayToCgi( $a );
607 if ( $this->loggedin ) {
608 $personal_urls['userpage'] = [
609 'text' => $this->username,
610 'href' => &$this->userpageUrlDetails['href'],
611 'class' => $this->userpageUrlDetails['exists'] ? false : 'new',
612 'active' => ( $this->userpageUrlDetails['href'] == $pageurl ),
613 'dir' => 'auto'
614 ];
615 $usertalkUrlDetails = $this->makeTalkUrlDetails( $this->userpage );
616 $personal_urls['mytalk'] = [
617 'text' => $this->msg( 'mytalk' )->text(),
618 'href' => &$usertalkUrlDetails['href'],
619 'class' => $usertalkUrlDetails['exists'] ? false : 'new',
620 'active' => ( $usertalkUrlDetails['href'] == $pageurl )
621 ];
622 $href = self::makeSpecialUrl( 'Preferences' );
623 $personal_urls['preferences'] = [
624 'text' => $this->msg( 'mypreferences' )->text(),
625 'href' => $href,
626 'active' => ( $href == $pageurl )
627 ];
628
629 if ( $this->getUser()->isAllowed( 'viewmywatchlist' ) ) {
630 $href = self::makeSpecialUrl( 'Watchlist' );
631 $personal_urls['watchlist'] = [
632 'text' => $this->msg( 'mywatchlist' )->text(),
633 'href' => $href,
634 'active' => ( $href == $pageurl )
635 ];
636 }
637
638 # We need to do an explicit check for Special:Contributions, as we
639 # have to match both the title, and the target, which could come
640 # from request values (Special:Contributions?target=Jimbo_Wales)
641 # or be specified in "sub page" form
642 # (Special:Contributions/Jimbo_Wales). The plot
643 # thickens, because the Title object is altered for special pages,
644 # so it doesn't contain the original alias-with-subpage.
645 $origTitle = Title::newFromText( $request->getText( 'title' ) );
646 if ( $origTitle instanceof Title && $origTitle->isSpecialPage() ) {
647 list( $spName, $spPar ) = SpecialPageFactory::resolveAlias( $origTitle->getText() );
648 $active = $spName == 'Contributions'
649 && ( ( $spPar && $spPar == $this->username )
650 || $request->getText( 'target' ) == $this->username );
651 } else {
652 $active = false;
653 }
654
655 $href = self::makeSpecialUrlSubpage( 'Contributions', $this->username );
656 $personal_urls['mycontris'] = [
657 'text' => $this->msg( 'mycontris' )->text(),
658 'href' => $href,
659 'active' => $active
660 ];
661
662 // if we can't set the user, we can't unset it either
663 if ( $request->getSession()->canSetUser() ) {
664 $personal_urls['logout'] = [
665 'text' => $this->msg( 'pt-userlogout' )->text(),
666 'href' => self::makeSpecialUrl( 'Userlogout',
667 // userlogout link must always contain an & character, otherwise we might not be able
668 // to detect a buggy precaching proxy (bug 17790)
669 $title->isSpecial( 'Preferences' ) ? 'noreturnto' : $returnto ),
670 'active' => false
671 ];
672 }
673 } else {
674 $useCombinedLoginLink = $this->useCombinedLoginLink();
675 if ( !$authManager->canCreateAccounts() || !$authManager->canAuthenticateNow() ) {
676 // don't show combined login/signup link if one of those is actually not available
677 $useCombinedLoginLink = false;
678 }
679
680 $loginlink = $this->getUser()->isAllowed( 'createaccount' ) && $useCombinedLoginLink
681 ? 'nav-login-createaccount'
682 : 'pt-login';
683
684 $login_url = [
685 'text' => $this->msg( $loginlink )->text(),
686 'href' => self::makeSpecialUrl( 'Userlogin', $returnto ),
687 'active' => $title->isSpecial( 'Userlogin' )
688 || $title->isSpecial( 'CreateAccount' ) && $useCombinedLoginLink,
689 ];
690 $createaccount_url = [
691 'text' => $this->msg( 'pt-createaccount' )->text(),
692 'href' => self::makeSpecialUrl( 'CreateAccount', $returnto ),
693 'active' => $title->isSpecial( 'CreateAccount' ),
694 ];
695
696 // No need to show Talk and Contributions to anons if they can't contribute!
697 if ( User::groupHasPermission( '*', 'edit' ) ) {
698 // Because of caching, we can't link directly to the IP talk and
699 // contributions pages. Instead we use the special page shortcuts
700 // (which work correctly regardless of caching). This means we can't
701 // determine whether these links are active or not, but since major
702 // skins (MonoBook, Vector) don't use this information, it's not a
703 // huge loss.
704 $personal_urls['anontalk'] = [
705 'text' => $this->msg( 'anontalk' )->text(),
706 'href' => self::makeSpecialUrlSubpage( 'Mytalk', false ),
707 'active' => false
708 ];
709 $personal_urls['anoncontribs'] = [
710 'text' => $this->msg( 'anoncontribs' )->text(),
711 'href' => self::makeSpecialUrlSubpage( 'Mycontributions', false ),
712 'active' => false
713 ];
714 }
715
716 if (
717 $authManager->canCreateAccounts()
718 && $this->getUser()->isAllowed( 'createaccount' )
719 && !$useCombinedLoginLink
720 ) {
721 $personal_urls['createaccount'] = $createaccount_url;
722 }
723
724 if ( $authManager->canAuthenticateNow() ) {
725 $personal_urls['login'] = $login_url;
726 }
727 }
728
729 Hooks::run( 'PersonalUrls', [ &$personal_urls, &$title, $this ] );
730 return $personal_urls;
731 }
732
744 function tabAction( $title, $message, $selected, $query = '', $checkEdit = false ) {
745 $classes = [];
746 if ( $selected ) {
747 $classes[] = 'selected';
748 }
749 if ( $checkEdit && !$title->isKnown() ) {
750 $classes[] = 'new';
751 if ( $query !== '' ) {
752 $query = 'action=edit&redlink=1&' . $query;
753 } else {
754 $query = 'action=edit&redlink=1';
755 }
756 }
757
758 $linkClass = MediaWikiServices::getInstance()->getLinkRenderer()->getLinkClasses( $title );
759
760 // wfMessageFallback will nicely accept $message as an array of fallbacks
761 // or just a single key
762 $msg = wfMessageFallback( $message )->setContext( $this->getContext() );
763 if ( is_array( $message ) ) {
764 // for hook compatibility just keep the last message name
765 $message = end( $message );
766 }
767 if ( $msg->exists() ) {
768 $text = $msg->text();
769 } else {
771 $text = $wgContLang->getConverter()->convertNamespace(
772 MWNamespace::getSubject( $title->getNamespace() ) );
773 }
774
775 // Avoid PHP 7.1 warning of passing $this by reference
776 $skinTemplate = $this;
777 $result = [];
778 if ( !Hooks::run( 'SkinTemplateTabAction', [ &$skinTemplate,
779 $title, $message, $selected, $checkEdit,
780 &$classes, &$query, &$text, &$result ] ) ) {
781 return $result;
782 }
783
784 $result = [
785 'class' => implode( ' ', $classes ),
786 'text' => $text,
787 'href' => $title->getLocalURL( $query ),
788 'primary' => true ];
789 if ( $linkClass !== '' ) {
790 $result['link-class'] = $linkClass;
791 }
792
793 return $result;
794 }
795
796 function makeTalkUrlDetails( $name, $urlaction = '' ) {
797 $title = Title::newFromText( $name );
798 if ( !is_object( $title ) ) {
799 throw new MWException( __METHOD__ . " given invalid pagename $name" );
800 }
801 $title = $title->getTalkPage();
803 return [
804 'href' => $title->getLocalURL( $urlaction ),
805 'exists' => $title->isKnown(),
806 ];
807 }
808
812 function makeArticleUrlDetails( $name, $urlaction = '' ) {
813 $title = Title::newFromText( $name );
814 $title = $title->getSubjectPage();
816 return [
817 'href' => $title->getLocalURL( $urlaction ),
818 'exists' => $title->exists(),
819 ];
820 }
821
856 protected function buildContentNavigationUrls() {
858
859 // Display tabs for the relevant title rather than always the title itself
860 $title = $this->getRelevantTitle();
861 $onPage = $title->equals( $this->getTitle() );
862
863 $out = $this->getOutput();
864 $request = $this->getRequest();
865 $user = $this->getUser();
866
867 $content_navigation = [
868 'namespaces' => [],
869 'views' => [],
870 'actions' => [],
871 'variants' => []
872 ];
873
874 // parameters
875 $action = $request->getVal( 'action', 'view' );
876
877 $userCanRead = $title->quickUserCan( 'read', $user );
878
879 // Avoid PHP 7.1 warning of passing $this by reference
880 $skinTemplate = $this;
881 $preventActiveTabs = false;
882 Hooks::run( 'SkinTemplatePreventOtherActiveTabs', [ &$skinTemplate, &$preventActiveTabs ] );
883
884 // Checks if page is some kind of content
885 if ( $title->canExist() ) {
886 // Gets page objects for the related namespaces
887 $subjectPage = $title->getSubjectPage();
888 $talkPage = $title->getTalkPage();
889
890 // Determines if this is a talk page
891 $isTalk = $title->isTalkPage();
892
893 // Generates XML IDs from namespace names
894 $subjectId = $title->getNamespaceKey( '' );
895
896 if ( $subjectId == 'main' ) {
897 $talkId = 'talk';
898 } else {
899 $talkId = "{$subjectId}_talk";
900 }
901
902 $skname = $this->skinname;
903
904 // Adds namespace links
905 $subjectMsg = [ "nstab-$subjectId" ];
906 if ( $subjectPage->isMainPage() ) {
907 array_unshift( $subjectMsg, 'mainpage-nstab' );
908 }
909 $content_navigation['namespaces'][$subjectId] = $this->tabAction(
910 $subjectPage, $subjectMsg, !$isTalk && !$preventActiveTabs, '', $userCanRead
911 );
912 $content_navigation['namespaces'][$subjectId]['context'] = 'subject';
913 $content_navigation['namespaces'][$talkId] = $this->tabAction(
914 $talkPage, [ "nstab-$talkId", 'talk' ], $isTalk && !$preventActiveTabs, '', $userCanRead
915 );
916 $content_navigation['namespaces'][$talkId]['context'] = 'talk';
917
918 if ( $userCanRead ) {
919 // Adds "view" view link
920 if ( $title->isKnown() ) {
921 $content_navigation['views']['view'] = $this->tabAction(
922 $isTalk ? $talkPage : $subjectPage,
923 [ "$skname-view-view", 'view' ],
924 ( $onPage && ( $action == 'view' || $action == 'purge' ) ), '', true
925 );
926 // signal to hide this from simple content_actions
927 $content_navigation['views']['view']['redundant'] = true;
928 }
929
930 $isForeignFile = $title->inNamespace( NS_FILE ) && $this->canUseWikiPage() &&
931 $this->getWikiPage() instanceof WikiFilePage && !$this->getWikiPage()->isLocal();
932
933 // If it is a non-local file, show a link to the file in its own repository
934 // @todo abstract this for remote content that isn't a file
935 if ( $isForeignFile ) {
936 $file = $this->getWikiPage()->getFile();
937 $content_navigation['views']['view-foreign'] = [
938 'class' => '',
939 'text' => wfMessageFallback( "$skname-view-foreign", 'view-foreign' )->
940 setContext( $this->getContext() )->
941 params( $file->getRepo()->getDisplayName() )->text(),
942 'href' => $file->getDescriptionUrl(),
943 'primary' => false,
944 ];
945 }
946
947 // Checks if user can edit the current page if it exists or create it otherwise
948 if ( $title->quickUserCan( 'edit', $user )
949 && ( $title->exists() || $title->quickUserCan( 'create', $user ) )
950 ) {
951 // Builds CSS class for talk page links
952 $isTalkClass = $isTalk ? ' istalk' : '';
953 // Whether the user is editing the page
954 $isEditing = $onPage && ( $action == 'edit' || $action == 'submit' );
955 // Whether to show the "Add a new section" tab
956 // Checks if this is a current rev of talk page and is not forced to be hidden
957 $showNewSection = !$out->forceHideNewSectionLink()
958 && ( ( $isTalk && $this->isRevisionCurrent() ) || $out->showNewSectionLink() );
959 $section = $request->getVal( 'section' );
960
961 if ( $title->exists()
962 || ( $title->getNamespace() == NS_MEDIAWIKI
963 && $title->getDefaultMessageText() !== false
964 )
965 ) {
966 $msgKey = $isForeignFile ? 'edit-local' : 'edit';
967 } else {
968 $msgKey = $isForeignFile ? 'create-local' : 'create';
969 }
970 $content_navigation['views']['edit'] = [
971 'class' => ( $isEditing && ( $section !== 'new' || !$showNewSection )
972 ? 'selected'
973 : ''
974 ) . $isTalkClass,
975 'text' => wfMessageFallback( "$skname-view-$msgKey", $msgKey )
976 ->setContext( $this->getContext() )->text(),
977 'href' => $title->getLocalURL( $this->editUrlOptions() ),
978 'primary' => !$isForeignFile, // don't collapse this in vector
979 ];
980
981 // section link
982 if ( $showNewSection ) {
983 // Adds new section link
984 // $content_navigation['actions']['addsection']
985 $content_navigation['views']['addsection'] = [
986 'class' => ( $isEditing && $section == 'new' ) ? 'selected' : false,
987 'text' => wfMessageFallback( "$skname-action-addsection", 'addsection' )
988 ->setContext( $this->getContext() )->text(),
989 'href' => $title->getLocalURL( 'action=edit&section=new' )
990 ];
991 }
992 // Checks if the page has some kind of viewable source content
993 } elseif ( $title->hasSourceText() ) {
994 // Adds view source view link
995 $content_navigation['views']['viewsource'] = [
996 'class' => ( $onPage && $action == 'edit' ) ? 'selected' : false,
997 'text' => wfMessageFallback( "$skname-action-viewsource", 'viewsource' )
998 ->setContext( $this->getContext() )->text(),
999 'href' => $title->getLocalURL( $this->editUrlOptions() ),
1000 'primary' => true, // don't collapse this in vector
1001 ];
1002 }
1003
1004 // Checks if the page exists
1005 if ( $title->exists() ) {
1006 // Adds history view link
1007 $content_navigation['views']['history'] = [
1008 'class' => ( $onPage && $action == 'history' ) ? 'selected' : false,
1009 'text' => wfMessageFallback( "$skname-view-history", 'history_short' )
1010 ->setContext( $this->getContext() )->text(),
1011 'href' => $title->getLocalURL( 'action=history' ),
1012 ];
1013
1014 if ( $title->quickUserCan( 'delete', $user ) ) {
1015 $content_navigation['actions']['delete'] = [
1016 'class' => ( $onPage && $action == 'delete' ) ? 'selected' : false,
1017 'text' => wfMessageFallback( "$skname-action-delete", 'delete' )
1018 ->setContext( $this->getContext() )->text(),
1019 'href' => $title->getLocalURL( 'action=delete' )
1020 ];
1021 }
1022
1023 if ( $title->quickUserCan( 'move', $user ) ) {
1024 $moveTitle = SpecialPage::getTitleFor( 'Movepage', $title->getPrefixedDBkey() );
1025 $content_navigation['actions']['move'] = [
1026 'class' => $this->getTitle()->isSpecial( 'Movepage' ) ? 'selected' : false,
1027 'text' => wfMessageFallback( "$skname-action-move", 'move' )
1028 ->setContext( $this->getContext() )->text(),
1029 'href' => $moveTitle->getLocalURL()
1030 ];
1031 }
1032 } else {
1033 // article doesn't exist or is deleted
1034 if ( $user->isAllowed( 'deletedhistory' ) ) {
1035 $n = $title->isDeleted();
1036 if ( $n ) {
1037 $undelTitle = SpecialPage::getTitleFor( 'Undelete', $title->getPrefixedDBkey() );
1038 // If the user can't undelete but can view deleted
1039 // history show them a "View .. deleted" tab instead.
1040 $msgKey = $user->isAllowed( 'undelete' ) ? 'undelete' : 'viewdeleted';
1041 $content_navigation['actions']['undelete'] = [
1042 'class' => $this->getTitle()->isSpecial( 'Undelete' ) ? 'selected' : false,
1043 'text' => wfMessageFallback( "$skname-action-$msgKey", "{$msgKey}_short" )
1044 ->setContext( $this->getContext() )->numParams( $n )->text(),
1045 'href' => $undelTitle->getLocalURL()
1046 ];
1047 }
1048 }
1049 }
1050
1051 if ( $title->quickUserCan( 'protect', $user ) && $title->getRestrictionTypes() &&
1052 MWNamespace::getRestrictionLevels( $title->getNamespace(), $user ) !== [ '' ]
1053 ) {
1054 $mode = $title->isProtected() ? 'unprotect' : 'protect';
1055 $content_navigation['actions'][$mode] = [
1056 'class' => ( $onPage && $action == $mode ) ? 'selected' : false,
1057 'text' => wfMessageFallback( "$skname-action-$mode", $mode )
1058 ->setContext( $this->getContext() )->text(),
1059 'href' => $title->getLocalURL( "action=$mode" )
1060 ];
1061 }
1062
1063 // Checks if the user is logged in
1064 if ( $this->loggedin && $user->isAllowedAll( 'viewmywatchlist', 'editmywatchlist' ) ) {
1074 $mode = $user->isWatched( $title ) ? 'unwatch' : 'watch';
1075 $content_navigation['actions'][$mode] = [
1076 'class' => 'mw-watchlink ' . (
1077 $onPage && ( $action == 'watch' || $action == 'unwatch' ) ? 'selected' : ''
1078 ),
1079 // uses 'watch' or 'unwatch' message
1080 'text' => $this->msg( $mode )->text(),
1081 'href' => $title->getLocalURL( [ 'action' => $mode ] )
1082 ];
1083 }
1084 }
1085
1086 // Avoid PHP 7.1 warning of passing $this by reference
1087 $skinTemplate = $this;
1088 Hooks::run( 'SkinTemplateNavigation', [ &$skinTemplate, &$content_navigation ] );
1089
1090 if ( $userCanRead && !$wgDisableLangConversion ) {
1091 $pageLang = $title->getPageLanguage();
1092 // Gets list of language variants
1093 $variants = $pageLang->getVariants();
1094 // Checks that language conversion is enabled and variants exist
1095 // And if it is not in the special namespace
1096 if ( count( $variants ) > 1 ) {
1097 // Gets preferred variant (note that user preference is
1098 // only possible for wiki content language variant)
1099 $preferred = $pageLang->getPreferredVariant();
1100 if ( Action::getActionName( $this ) === 'view' ) {
1101 $params = $request->getQueryValues();
1102 unset( $params['title'] );
1103 } else {
1104 $params = [];
1105 }
1106 // Loops over each variant
1107 foreach ( $variants as $code ) {
1108 // Gets variant name from language code
1109 $varname = $pageLang->getVariantname( $code );
1110 // Appends variant link
1111 $content_navigation['variants'][] = [
1112 'class' => ( $code == $preferred ) ? 'selected' : false,
1113 'text' => $varname,
1114 'href' => $title->getLocalURL( [ 'variant' => $code ] + $params ),
1115 'lang' => wfBCP47( $code ),
1116 'hreflang' => wfBCP47( $code ),
1117 ];
1118 }
1119 }
1120 }
1121 } else {
1122 // If it's not content, it's got to be a special page
1123 $content_navigation['namespaces']['special'] = [
1124 'class' => 'selected',
1125 'text' => $this->msg( 'nstab-special' )->text(),
1126 'href' => $request->getRequestURL(), // @see: bug 2457, bug 2510
1127 'context' => 'subject'
1128 ];
1129
1130 // Avoid PHP 7.1 warning of passing $this by reference
1131 $skinTemplate = $this;
1132 Hooks::run( 'SkinTemplateNavigation::SpecialPage',
1133 [ &$skinTemplate, &$content_navigation ] );
1134 }
1135
1136 // Avoid PHP 7.1 warning of passing $this by reference
1137 $skinTemplate = $this;
1138 // Equiv to SkinTemplateContentActions
1139 Hooks::run( 'SkinTemplateNavigation::Universal', [ &$skinTemplate, &$content_navigation ] );
1140
1141 // Setup xml ids and tooltip info
1142 foreach ( $content_navigation as $section => &$links ) {
1143 foreach ( $links as $key => &$link ) {
1144 $xmlID = $key;
1145 if ( isset( $link['context'] ) && $link['context'] == 'subject' ) {
1146 $xmlID = 'ca-nstab-' . $xmlID;
1147 } elseif ( isset( $link['context'] ) && $link['context'] == 'talk' ) {
1148 $xmlID = 'ca-talk';
1149 $link['rel'] = 'discussion';
1150 } elseif ( $section == 'variants' ) {
1151 $xmlID = 'ca-varlang-' . $xmlID;
1152 } else {
1153 $xmlID = 'ca-' . $xmlID;
1154 }
1155 $link['id'] = $xmlID;
1156 }
1157 }
1158
1159 # We don't want to give the watch tab an accesskey if the
1160 # page is being edited, because that conflicts with the
1161 # accesskey on the watch checkbox. We also don't want to
1162 # give the edit tab an accesskey, because that's fairly
1163 # superfluous and conflicts with an accesskey (Ctrl-E) often
1164 # used for editing in Safari.
1165 if ( in_array( $action, [ 'edit', 'submit' ] ) ) {
1166 if ( isset( $content_navigation['views']['edit'] ) ) {
1167 $content_navigation['views']['edit']['tooltiponly'] = true;
1168 }
1169 if ( isset( $content_navigation['actions']['watch'] ) ) {
1170 $content_navigation['actions']['watch']['tooltiponly'] = true;
1171 }
1172 if ( isset( $content_navigation['actions']['unwatch'] ) ) {
1173 $content_navigation['actions']['unwatch']['tooltiponly'] = true;
1174 }
1175 }
1176
1177 return $content_navigation;
1178 }
1179
1185 private function buildContentActionUrls( $content_navigation ) {
1186
1187 // content_actions has been replaced with content_navigation for backwards
1188 // compatibility and also for skins that just want simple tabs content_actions
1189 // is now built by flattening the content_navigation arrays into one
1190
1191 $content_actions = [];
1192
1193 foreach ( $content_navigation as $links ) {
1194 foreach ( $links as $key => $value ) {
1195 if ( isset( $value['redundant'] ) && $value['redundant'] ) {
1196 // Redundant tabs are dropped from content_actions
1197 continue;
1198 }
1199
1200 // content_actions used to have ids built using the "ca-$key" pattern
1201 // so the xmlID based id is much closer to the actual $key that we want
1202 // for that reason we'll just strip out the ca- if present and use
1203 // the latter potion of the "id" as the $key
1204 if ( isset( $value['id'] ) && substr( $value['id'], 0, 3 ) == 'ca-' ) {
1205 $key = substr( $value['id'], 3 );
1206 }
1207
1208 if ( isset( $content_actions[$key] ) ) {
1209 wfDebug( __METHOD__ . ": Found a duplicate key for $key while flattening " .
1210 "content_navigation into content_actions.\n" );
1211 continue;
1212 }
1213
1214 $content_actions[$key] = $value;
1215 }
1216 }
1217
1218 return $content_actions;
1219 }
1220
1225 protected function buildNavUrls() {
1227
1228 $out = $this->getOutput();
1229 $request = $this->getRequest();
1230
1231 $nav_urls = [];
1232 $nav_urls['mainpage'] = [ 'href' => self::makeMainPageUrl() ];
1233 if ( $wgUploadNavigationUrl ) {
1234 $nav_urls['upload'] = [ 'href' => $wgUploadNavigationUrl ];
1235 } elseif ( UploadBase::isEnabled() && UploadBase::isAllowed( $this->getUser() ) === true ) {
1236 $nav_urls['upload'] = [ 'href' => self::makeSpecialUrl( 'Upload' ) ];
1237 } else {
1238 $nav_urls['upload'] = false;
1239 }
1240 $nav_urls['specialpages'] = [ 'href' => self::makeSpecialUrl( 'Specialpages' ) ];
1241
1242 $nav_urls['print'] = false;
1243 $nav_urls['permalink'] = false;
1244 $nav_urls['info'] = false;
1245 $nav_urls['whatlinkshere'] = false;
1246 $nav_urls['recentchangeslinked'] = false;
1247 $nav_urls['contributions'] = false;
1248 $nav_urls['log'] = false;
1249 $nav_urls['blockip'] = false;
1250 $nav_urls['emailuser'] = false;
1251 $nav_urls['userrights'] = false;
1252
1253 // A print stylesheet is attached to all pages, but nobody ever
1254 // figures that out. :) Add a link...
1255 if ( !$out->isPrintable() && ( $out->isArticle() || $this->getTitle()->isSpecialPage() ) ) {
1256 $nav_urls['print'] = [
1257 'text' => $this->msg( 'printableversion' )->text(),
1258 'href' => $this->getTitle()->getLocalURL(
1259 $request->appendQueryValue( 'printable', 'yes' ) )
1260 ];
1261 }
1262
1263 if ( $out->isArticle() ) {
1264 // Also add a "permalink" while we're at it
1265 $revid = $this->getRevisionId();
1266 if ( $revid ) {
1267 $nav_urls['permalink'] = [
1268 'text' => $this->msg( 'permalink' )->text(),
1269 'href' => $this->getTitle()->getLocalURL( "oldid=$revid" )
1270 ];
1271 }
1272
1273 // Avoid PHP 7.1 warning of passing $this by reference
1274 $skinTemplate = $this;
1275 // Use the copy of revision ID in case this undocumented, shady hook tries to mess with internals
1276 Hooks::run( 'SkinTemplateBuildNavUrlsNav_urlsAfterPermalink',
1277 [ &$skinTemplate, &$nav_urls, &$revid, &$revid ] );
1278 }
1279
1280 if ( $out->isArticleRelated() ) {
1281 $nav_urls['whatlinkshere'] = [
1282 'href' => SpecialPage::getTitleFor( 'Whatlinkshere', $this->thispage )->getLocalURL()
1283 ];
1284
1285 $nav_urls['info'] = [
1286 'text' => $this->msg( 'pageinfo-toolboxlink' )->text(),
1287 'href' => $this->getTitle()->getLocalURL( "action=info" )
1288 ];
1289
1290 if ( $this->getTitle()->exists() ) {
1291 $nav_urls['recentchangeslinked'] = [
1292 'href' => SpecialPage::getTitleFor( 'Recentchangeslinked', $this->thispage )->getLocalURL()
1293 ];
1294 }
1295 }
1296
1297 $user = $this->getRelevantUser();
1298 if ( $user ) {
1299 $rootUser = $user->getName();
1300
1301 $nav_urls['contributions'] = [
1302 'text' => $this->msg( 'contributions', $rootUser )->text(),
1303 'href' => self::makeSpecialUrlSubpage( 'Contributions', $rootUser ),
1304 'tooltip-params' => [ $rootUser ],
1305 ];
1306
1307 $nav_urls['log'] = [
1308 'href' => self::makeSpecialUrlSubpage( 'Log', $rootUser )
1309 ];
1310
1311 if ( $this->getUser()->isAllowed( 'block' ) ) {
1312 $nav_urls['blockip'] = [
1313 'text' => $this->msg( 'blockip', $rootUser )->text(),
1314 'href' => self::makeSpecialUrlSubpage( 'Block', $rootUser )
1315 ];
1316 }
1317
1318 if ( $this->showEmailUser( $user ) ) {
1319 $nav_urls['emailuser'] = [
1320 'text' => $this->msg( 'tool-link-emailuser', $rootUser )->text(),
1321 'href' => self::makeSpecialUrlSubpage( 'Emailuser', $rootUser ),
1322 'tooltip-params' => [ $rootUser ],
1323 ];
1324 }
1325
1326 if ( !$user->isAnon() ) {
1327 $sur = new UserrightsPage;
1328 $sur->setContext( $this->getContext() );
1329 if ( $sur->userCanExecute( $this->getUser() ) ) {
1330 $nav_urls['userrights'] = [
1331 'text' => $this->msg( 'tool-link-userrights', $this->getUser()->getName() )->text(),
1332 'href' => self::makeSpecialUrlSubpage( 'Userrights', $rootUser )
1333 ];
1334 }
1335 }
1336 }
1337
1338 return $nav_urls;
1339 }
1340
1345 protected function getNameSpaceKey() {
1346 return $this->getTitle()->getNamespaceKey();
1347 }
1348}
Apache License January AND DISTRIBUTION Definitions License shall mean the terms and conditions for use
$wgScript
The URL path to index.php.
$wgMimeType
The default Content-Type header.
$wgDisableLangConversion
Whether to enable language variant conversion.
$wgSitename
Name of the site.
$wgUseCombinedLoginLink
Login / create account link behavior when it's possible for anonymous users to create an account.
$wgHideInterlanguageLinks
Hide interlanguage links from the sidebar.
$wgShowCreditsIfMax
If there are more than $wgMaxCredits authors, show $wgMaxCredits of them.
$wgJsMimeType
Previously used as content type in HTML script tags.
$wgFooterIcons
Abstract list of footer icons for skins in place of old copyrightico and poweredbyico code You can ad...
$wgUploadNavigationUrl
Point the upload navigation link to an external URL Useful if you want to use a shared repository by ...
$wgScriptPath
The path we should point to.
$wgStylePath
The URL path of the skins directory.
$wgServer
URL of the server.
$wgLogo
The URL path of the wiki logo.
$wgMaxCredits
Set this to the number of authors that you want to be credited below an article text.
wfDebug( $text, $dest='all', array $context=[])
Sends a line to the debug log if enabled or, optionally, to a comment in output.
wfBCP47( $code)
Get the normalised IETF language tag See unit test for examples.
wfReportTime()
Returns a script tag that stores the amount of time it took MediaWiki to handle the request in millis...
wfMessageFallback()
This function accepts multiple message keys and returns a message instance for the first message whic...
wfArrayToCgi( $array1, $array2=null, $prefix='')
This function takes one or two arrays as input, and returns a CGI-style string, e....
wfDeprecated( $function, $version=false, $component=false, $callerOffset=2)
Throws a warning that $function is deprecated.
static factory( $action, Page $page, IContextSource $context=null)
Get an appropriate Action subclass for the given action.
Definition Action.php:95
static getActionName(IContextSource $context)
Get the action that will be executed, not necessarily the one passed passed through the "action" requ...
Definition Action.php:122
getUser()
Get the User object.
getRequest()
Get the WebRequest object.
canUseWikiPage()
Check whether a WikiPage object can be get with getWikiPage().
getConfig()
Get the Config object.
msg()
Get a Message object with context set Parameters are the same as wfMessage()
getTitle()
Get the Title object.
getOutput()
Get the OutputPage object.
getWikiPage()
Get the WikiPage object.
getLanguage()
Get the Language object.
getContext()
Get the base IContextSource object.
setContext(IContextSource $context)
Set the IContextSource object.
MediaWiki exception.
This serves as the entry point to the authentication system.
MediaWikiServices is the service locator for the application scope of MediaWiki.
This class should be covered by a general architecture document which does not exist as of January 20...
static instance()
Singleton.
Definition Profiler.php:61
Base class for template-based skins.
setupTemplate( $classname, $repository=false, $cache_dir=false)
Create the template engine object; we feed it a bunch of data and eventually it spits out some HTML.
string $template
For QuickTemplate, the name of the subclass which will actually fill the template.
formatLanguageName( $name)
Format language name for use in sidebar interlanguage links list.
prepareQuickTemplate()
initialize various variables and generate the template
getPersonalToolsList()
Get the HTML for the p-personal list.
buildPersonalUrls()
build array of urls for personal toolbar
buildContentNavigationUrls()
a structured array of links usually used for the tabs in a skin
useCombinedLoginLink()
Output a boolean indicating if buildPersonalUrls should output separate login and create account link...
getLanguages()
Generates array of language links for the current page.
wrapHTML( $title, $html)
Wrap the body text with language information and identifiable element.
makeTalkUrlDetails( $name, $urlaction='')
setupSkinUserCss(OutputPage $out)
Add specific styles for this skin.
outputPage(OutputPage $out=null)
initialize various variables and generate the template
buildNavUrls()
build array of common navigation links
string $skinname
Name of our skin, it probably needs to be all lower case.
buildContentActionUrls( $content_navigation)
an array of edit links by default used for the tabs
makeArticleUrlDetails( $name, $urlaction='')
tabAction( $title, $message, $selected, $query='', $checkEdit=false)
Builds an array with tab definition.
getNameSpaceKey()
Generate strings used for xml 'id' names.
printOrError( $str)
Output the string, or print error message if it's an error object of the appropriate type.
The main skin class which provides methods and properties for all other skins.
Definition Skin.php:34
aboutLink()
Gets the link to the wiki's about page.
Definition Skin.php:957
isRevisionCurrent()
Whether the revision displayed is the latest revision of the page.
Definition Skin.php:243
afterContentHook()
This runs a hook to allow extensions placing their stuff after content and article metadata (e....
Definition Skin.php:554
getNewtalks()
Gets new talk page messages for the current user and returns an appropriate alert message (or an empt...
Definition Skin.php:1332
static makeMainPageUrl( $urlaction='')
Definition Skin.php:1031
static makeKnownUrlDetails( $name, $urlaction='')
Make URL details where the article exists (or at least it's convenient to think so)
Definition Skin.php:1142
generateDebugHTML()
Generate debug data HTML for displaying at the bottom of the main content area.
Definition Skin.php:580
getCopyrightIcon()
Definition Skin.php:779
privacyLink()
Gets the link to the wiki's privacy policy page.
Definition Skin.php:949
getSiteNotice()
Get the site notice.
Definition Skin.php:1477
getUndeleteLink()
Definition Skin.php:623
getPoweredBy()
Gets the powered by MediaWiki icon.
Definition Skin.php:809
escapeSearchLink()
Definition Skin.php:725
static makeUrlDetails( $name, $urlaction='')
these return an array with the 'href' and boolean 'exists'
Definition Skin.php:1126
static makeSpecialUrlSubpage( $name, $subpage, $urlaction='')
Definition Skin.php:1064
getRelevantUser()
Return the "relevant" user.
Definition Skin.php:291
logoText( $align='')
Definition Skin.php:860
static checkTitle(&$title, $name)
make sure we have some title to operate on
Definition Skin.php:1158
editUrlOptions()
Return URL options for the 'edit page' link.
Definition Skin.php:976
showEmailUser( $id)
Definition Skin.php:990
buildSidebar()
Build an array that represents the sidebar(s), the navigation bar among them.
Definition Skin.php:1188
getCopyright( $type='detect')
Definition Skin.php:733
printSource()
Text with the permalink to the source page, usually shown on the footer of a printed page.
Definition Skin.php:605
getRevisionId()
Get the current revision ID.
Definition Skin.php:234
bottomScripts()
This gets called shortly before the "</body>" tag.
Definition Skin.php:589
disclaimerLink()
Gets the link to the wiki's general disclaimers page.
Definition Skin.php:965
static makeSpecialUrl( $name, $urlaction='', $proto=null)
Make a URL for a Special Page using the given query and protocol.
Definition Skin.php:1049
lastModified()
Get the timestamp of the latest revision, formatted in user language.
Definition Skin.php:833
initPage(OutputPage $out)
Definition Skin.php:144
subPageSubtitle( $out=null)
Definition Skin.php:652
getRelevantTitle()
Return the "relevant" title.
Definition Skin.php:267
getCategories()
Definition Skin.php:519
static resolveAlias( $alias)
Given a special page name with a possible subpage, return an array where the first element is the spe...
setContext( $context)
Sets the context this SpecialPage is executed in.
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,...
Represents a title within MediaWiki.
Definition Title.php:36
isSpecialPage()
Returns true if this is a special page.
Definition Title.php:1051
static isEnabled()
Returns true if uploads are enabled.
static isAllowed( $user)
Returns true if the user can use this upload module or else a string identifying the missing permissi...
Special page to allow managing user group membership.
Special handling for file pages.
$res
Definition database.txt:21
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
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 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
const NS_FILE
Definition Defines.php:62
const NS_MEDIAWIKI
Definition Defines.php:64
const NS_SPECIAL
Definition Defines.php:45
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:249
The index of the header message $result[1]=The index of the body text message $result[2 through n]=Parameters passed to body text message. Please note the header message cannot receive/use parameters. 'ImportHandleLogItemXMLTag':When parsing a XML tag in a log item. Return false to stop further processing of the tag $reader:XMLReader object $logInfo:Array of information 'ImportHandlePageXMLTag':When parsing a XML tag in a page. Return false to stop further processing of the tag $reader:XMLReader object & $pageInfo:Array of information 'ImportHandleRevisionXMLTag':When parsing a XML tag in a page revision. Return false to stop further processing of the tag $reader:XMLReader object $pageInfo:Array of page information $revisionInfo:Array of revision information 'ImportHandleToplevelXMLTag':When parsing a top level XML tag. Return false to stop further processing of the tag $reader:XMLReader object 'ImportHandleUploadXMLTag':When parsing a XML tag in a file upload. Return false to stop further processing of the tag $reader:XMLReader object $revisionInfo:Array of information 'ImportLogInterwikiLink':Hook to change the interwiki link used in log entries and edit summaries for transwiki imports. & $fullInterwikiPrefix:Interwiki prefix, may contain colons. & $pageTitle:String that contains page title. 'ImportSources':Called when reading from the $wgImportSources configuration variable. Can be used to lazy-load the import sources list. & $importSources:The value of $wgImportSources. Modify as necessary. See the comment in DefaultSettings.php for the detail of how to structure this array. 'InfoAction':When building information to display on the action=info page. $context:IContextSource object & $pageInfo:Array of information 'InitializeArticleMaybeRedirect':MediaWiki check to see if title is a redirect. & $title:Title object for the current page & $request:WebRequest & $ignoreRedirect:boolean to skip redirect check & $target:Title/string of redirect target & $article:Article object 'InternalParseBeforeLinks':during Parser 's internalParse method before links but after nowiki/noinclude/includeonly/onlyinclude and other processings. & $parser:Parser object & $text:string containing partially parsed text & $stripState:Parser 's internal StripState object 'InternalParseBeforeSanitize':during Parser 's internalParse method just before the parser removes unwanted/dangerous HTML tags and after nowiki/noinclude/includeonly/onlyinclude and other processings. Ideal for syntax-extensions after template/parser function execution which respect nowiki and HTML-comments. & $parser:Parser object & $text:string containing partially parsed text & $stripState:Parser 's internal StripState object 'InterwikiLoadPrefix':When resolving if a given prefix is an interwiki or not. Return true without providing an interwiki to continue interwiki search. $prefix:interwiki prefix we are looking for. & $iwData:output array describing the interwiki with keys iw_url, iw_local, iw_trans and optionally iw_api and iw_wikiid. 'InvalidateEmailComplete':Called after a user 's email has been invalidated successfully. $user:user(object) whose email is being invalidated 'IRCLineURL':When constructing the URL to use in an IRC notification. Callee may modify $url and $query, URL will be constructed as $url . $query & $url:URL to index.php & $query:Query string $rc:RecentChange object that triggered url generation 'IsFileCacheable':Override the result of Article::isFileCacheable()(if true) & $article:article(object) being checked 'IsTrustedProxy':Override the result of IP::isTrustedProxy() & $ip:IP being check & $result:Change this value to override the result of IP::isTrustedProxy() 'IsUploadAllowedFromUrl':Override the result of UploadFromUrl::isAllowedUrl() $url:URL used to upload from & $allowed:Boolean indicating if uploading is allowed for given URL 'isValidEmailAddr':Override the result of Sanitizer::validateEmail(), for instance to return false if the domain name doesn 't match your organization. $addr:The e-mail address entered by the user & $result:Set this and return false to override the internal checks 'isValidPassword':Override the result of User::isValidPassword() $password:The password entered by the user & $result:Set this and return false to override the internal checks $user:User the password is being validated for 'Language::getMessagesFileName':$code:The language code or the language we 're looking for a messages file for & $file:The messages file path, you can override this to change the location. 'LanguageGetMagic':DEPRECATED! Use $magicWords in a file listed in $wgExtensionMessagesFiles instead. Use this to define synonyms of magic words depending of the language & $magicExtensions:associative array of magic words synonyms $lang:language code(string) 'LanguageGetNamespaces':Provide custom ordering for namespaces or remove namespaces. Do not use this hook to add namespaces. Use CanonicalNamespaces for that. & $namespaces:Array of namespaces indexed by their numbers 'LanguageGetSpecialPageAliases':DEPRECATED! Use $specialPageAliases in a file listed in $wgExtensionMessagesFiles instead. Use to define aliases of special pages names depending of the language & $specialPageAliases:associative array of magic words synonyms $lang:language code(string) 'LanguageGetTranslatedLanguageNames':Provide translated language names. & $names:array of language code=> language name $code:language of the preferred translations 'LanguageLinks':Manipulate a page 's language links. This is called in various places to allow extensions to define the effective language links for a page. $title:The page 's Title. & $links:Associative array mapping language codes to prefixed links of the form "language:title". & $linkFlags:Associative array mapping prefixed links to arrays of flags. Currently unused, but planned to provide support for marking individual language links in the UI, e.g. for featured articles. 'LanguageSelector':Hook to change the language selector available on a page. $out:The output page. $cssClassName:CSS class name of the language selector. 'LinkBegin':DEPRECATED! Use HtmlPageLinkRendererBegin instead. Used when generating internal and interwiki links in Linker::link(), before processing starts. Return false to skip default processing and return $ret. See documentation for Linker::link() for details on the expected meanings of parameters. $skin:the Skin object $target:the Title that the link is pointing to & $html:the contents that the< a > tag should have(raw HTML) $result
Definition hooks.txt:1937
namespace are movable Hooks may change this value to override the return value of MWNamespace::isMovable(). 'NewDifferenceEngine' do that in ParserLimitReportFormat instead use this to modify the parameters of the image and a DIV can begin in one section and end in another Make sure your code can handle that case gracefully See the EditSectionClearerLink extension for an example zero but section is usually empty its values are the globals values before the output is cached one of or reset my talk my contributions etc & $personal_urls
Definition hooks.txt:2547
namespace and then decline to actually register it file or subcat img or subcat $title
Definition hooks.txt:986
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
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 true
Definition hooks.txt:1950
error also a ContextSource you ll probably need to make sure the header is varied on $request
Definition hooks.txt:2685
this hook is for auditing only or null if authentication failed before getting that far or null if we can t even determine that probably a stub it is not rendered in wiki pages or galleries in category pages allow injecting custom HTML after the section Any uses of the hook need to handle escaping see BaseTemplate::getToolbox and BaseTemplate::makeListItem for details on the format of individual items inside of this array or by returning and letting standard HTTP rendering take place modifiable or by returning false and taking over the output $out
Definition hooks.txt:886
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:1957
usually copyright or history_copyright This message must be in HTML not wikitext & $link
Definition hooks.txt:2900
Allows to change the fields on the form that will be generated $name
Definition hooks.txt:304
namespace are movable Hooks may change this value to override the return value of MWNamespace::isMovable(). 'NewDifferenceEngine' do that in ParserLimitReportFormat instead use this to modify the parameters of the image and a DIV can begin in one section and end in another Make sure your code can handle that case gracefully See the EditSectionClearerLink extension for an example zero but section is usually empty its values are the globals values before the output is cached $page
Definition hooks.txt:2534
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:1595
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:2901
processing should stop and the error should be shown to the user * false
Definition hooks.txt:189
this hook is for auditing only or null if authentication failed before getting that far or null if we can t even determine that probably a stub it is not rendered in wiki pages or galleries in category pages allow injecting custom HTML after the section Any uses of the hook need to handle escaping see BaseTemplate::getToolbox and BaseTemplate::makeListItem for details on the format of individual items inside of this array or by returning and letting standard HTTP rendering take place modifiable or by returning false and taking over the output modifiable & $code
Definition hooks.txt:887
$wgArticlePath
Definition img_auth.php:45
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
$params