MediaWiki  master
SkinTemplate.php
Go to the documentation of this file.
1 <?php
23 
38 class SkinTemplate extends Skin {
43  public $skinname = 'monobook';
44 
50 
51  public $thispage;
52  public $titletxt;
53  public $userpage;
54  public $thisquery;
55  public $loggedin;
56  public $username;
58 
70  function setupTemplate( $classname, $repository = false, $cache_dir = false ) {
71  return new $classname( $this->getConfig() );
72  }
73 
79  public function getLanguages() {
81  if ( $wgHideInterlanguageLinks ) {
82  return [];
83  }
84 
85  $userLang = $this->getLanguage();
86  $languageLinks = [];
87 
88  foreach ( $this->getOutput()->getLanguageLinks() as $languageLinkText ) {
89  $class = 'interlanguage-link interwiki-' . explode( ':', $languageLinkText, 2 )[0];
90 
91  $languageLinkTitle = Title::newFromText( $languageLinkText );
92  if ( $languageLinkTitle ) {
93  $ilInterwikiCode = $languageLinkTitle->getInterwiki();
94  $ilLangName = Language::fetchLanguageName( $ilInterwikiCode );
95 
96  if ( strval( $ilLangName ) === '' ) {
97  $ilDisplayTextMsg = wfMessage( "interlanguage-link-$ilInterwikiCode" );
98  if ( !$ilDisplayTextMsg->isDisabled() ) {
99  // Use custom MW message for the display text
100  $ilLangName = $ilDisplayTextMsg->text();
101  } else {
102  // Last resort: fallback to the language link target
103  $ilLangName = $languageLinkText;
104  }
105  } else {
106  // Use the language autonym as display text
107  $ilLangName = $this->formatLanguageName( $ilLangName );
108  }
109 
110  // CLDR extension or similar is required to localize the language name;
111  // otherwise we'll end up with the autonym again.
112  $ilLangLocalName = Language::fetchLanguageName(
113  $ilInterwikiCode,
114  $userLang->getCode()
115  );
116 
117  $languageLinkTitleText = $languageLinkTitle->getText();
118  if ( $ilLangLocalName === '' ) {
119  $ilFriendlySiteName = wfMessage( "interlanguage-link-sitename-$ilInterwikiCode" );
120  if ( !$ilFriendlySiteName->isDisabled() ) {
121  if ( $languageLinkTitleText === '' ) {
122  $ilTitle = wfMessage(
123  'interlanguage-link-title-nonlangonly',
124  $ilFriendlySiteName->text()
125  )->text();
126  } else {
127  $ilTitle = wfMessage(
128  'interlanguage-link-title-nonlang',
129  $languageLinkTitleText,
130  $ilFriendlySiteName->text()
131  )->text();
132  }
133  } else {
134  // we have nothing friendly to put in the title, so fall back to
135  // displaying the interlanguage link itself in the title text
136  // (similar to what is done in page content)
137  $ilTitle = $languageLinkTitle->getInterwiki() .
138  ":$languageLinkTitleText";
139  }
140  } elseif ( $languageLinkTitleText === '' ) {
141  $ilTitle = wfMessage(
142  'interlanguage-link-title-langonly',
143  $ilLangLocalName
144  )->text();
145  } else {
146  $ilTitle = wfMessage(
147  'interlanguage-link-title',
148  $languageLinkTitleText,
149  $ilLangLocalName
150  )->text();
151  }
152 
153  $ilInterwikiCodeBCP47 = LanguageCode::bcp47( $ilInterwikiCode );
154  $languageLink = [
155  'href' => $languageLinkTitle->getFullURL(),
156  'text' => $ilLangName,
157  'title' => $ilTitle,
158  'class' => $class,
159  'link-class' => 'interlanguage-link-target',
160  'lang' => $ilInterwikiCodeBCP47,
161  'hreflang' => $ilInterwikiCodeBCP47,
162  ];
163  Hooks::run(
164  'SkinTemplateGetLanguageLink',
165  [ &$languageLink, $languageLinkTitle, $this->getTitle(), $this->getOutput() ]
166  );
167  $languageLinks[] = $languageLink;
168  }
169  }
170 
171  return $languageLinks;
172  }
173 
177  protected function setupTemplateForOutput() {
178  $request = $this->getRequest();
179  $user = $this->getUser();
180  $title = $this->getTitle();
181 
182  $tpl = $this->setupTemplate( $this->template, 'skins' );
183 
184  $this->thispage = $title->getPrefixedDBkey();
185  $this->titletxt = $title->getPrefixedText();
186  $this->userpage = $user->getUserPage()->getPrefixedText();
187  $query = [];
188  if ( !$request->wasPosted() ) {
189  $query = $request->getValues();
190  unset( $query['title'] );
191  unset( $query['returnto'] );
192  unset( $query['returntoquery'] );
193  }
194  $this->thisquery = wfArrayToCgi( $query );
195  $this->loggedin = $user->isLoggedIn();
196  $this->username = $user->getName();
197 
198  if ( $this->loggedin ) {
199  $this->userpageUrlDetails = self::makeUrlDetails( $this->userpage );
200  } else {
201  # This won't be used in the standard skins, but we define it to preserve the interface
202  # To save time, we check for existence
203  $this->userpageUrlDetails = self::makeKnownUrlDetails( $this->userpage );
204  }
205 
206  return $tpl;
207  }
208 
214  function outputPage( OutputPage $out = null ) {
215  Profiler::instance()->setTemplated( true );
216 
217  $oldContext = null;
218  if ( $out !== null ) {
219  // Deprecated since 1.20, note added in 1.25
220  wfDeprecated( __METHOD__, '1.25' );
221  $oldContext = $this->getContext();
222  $this->setContext( $out->getContext() );
223  }
224 
225  $out = $this->getOutput();
226 
227  $this->initPage( $out );
228  $tpl = $this->prepareQuickTemplate();
229  // execute template
230  $res = $tpl->execute();
231 
232  // result may be an error
233  $this->printOrError( $res );
234 
235  if ( $oldContext ) {
236  $this->setContext( $oldContext );
237  }
238  }
239 
247  protected function wrapHTML( $title, $html ) {
248  # An ID that includes the actual body text; without categories, contentSub, ...
249  $realBodyAttribs = [ 'id' => 'mw-content-text' ];
250 
251  # Add a mw-content-ltr/rtl class to be able to style based on text
252  # direction when the content is different from the UI language (only
253  # when viewing)
254  # Most information on special pages and file pages is in user language,
255  # rather than content language, so those will not get this
256  if ( Action::getActionName( $this ) === 'view' &&
257  ( !$title->inNamespaces( NS_SPECIAL, NS_FILE ) || $title->isRedirect() ) ) {
258  $pageLang = $title->getPageViewLanguage();
259  $realBodyAttribs['lang'] = $pageLang->getHtmlCode();
260  $realBodyAttribs['dir'] = $pageLang->getDir();
261  $realBodyAttribs['class'] = 'mw-content-' . $pageLang->getDir();
262  }
263 
264  return Html::rawElement( 'div', $realBodyAttribs, $html );
265  }
266 
273  protected function prepareQuickTemplate() {
278 
279  $title = $this->getTitle();
280  $request = $this->getRequest();
281  $out = $this->getOutput();
282  $tpl = $this->setupTemplateForOutput();
283 
284  $tpl->set( 'title', $out->getPageTitle() );
285  $tpl->set( 'pagetitle', $out->getHTMLTitle() );
286  $tpl->set( 'displaytitle', $out->mPageLinkTitle );
287 
288  $tpl->set( 'thispage', $this->thispage );
289  $tpl->set( 'titleprefixeddbkey', $this->thispage );
290  $tpl->set( 'titletext', $title->getText() );
291  $tpl->set( 'articleid', $title->getArticleID() );
292 
293  $tpl->set( 'isarticle', $out->isArticle() );
294 
295  $subpagestr = $this->subPageSubtitle();
296  if ( $subpagestr !== '' ) {
297  $subpagestr = '<span class="subpages">' . $subpagestr . '</span>';
298  }
299  $tpl->set( 'subtitle', $subpagestr . $out->getSubtitle() );
300 
301  $undelete = $this->getUndeleteLink();
302  if ( $undelete === '' ) {
303  $tpl->set( 'undelete', '' );
304  } else {
305  $tpl->set( 'undelete', '<span class="subpages">' . $undelete . '</span>' );
306  }
307 
308  $tpl->set( 'catlinks', $this->getCategories() );
309  if ( $out->isSyndicated() ) {
310  $feeds = [];
311  foreach ( $out->getSyndicationLinks() as $format => $link ) {
312  $feeds[$format] = [
313  // Messages: feed-atom, feed-rss
314  'text' => $this->msg( "feed-$format" )->text(),
315  'href' => $link
316  ];
317  }
318  $tpl->set( 'feeds', $feeds );
319  } else {
320  $tpl->set( 'feeds', false );
321  }
322 
323  $tpl->set( 'mimetype', $wgMimeType );
324  $tpl->set( 'jsmimetype', $wgJsMimeType );
325  $tpl->set( 'charset', 'UTF-8' );
326  $tpl->set( 'wgScript', $wgScript );
327  $tpl->set( 'skinname', $this->skinname );
328  $tpl->set( 'skinclass', static::class );
329  $tpl->set( 'skin', $this );
330  $tpl->set( 'stylename', $this->stylename );
331  $tpl->set( 'printable', $out->isPrintable() );
332  $tpl->set( 'handheld', $request->getBool( 'handheld' ) );
333  $tpl->set( 'loggedin', $this->loggedin );
334  $tpl->set( 'notspecialpage', !$title->isSpecialPage() );
335  $tpl->set( 'searchaction', $this->escapeSearchLink() );
336  $tpl->set( 'searchtitle', SpecialPage::getTitleFor( 'Search' )->getPrefixedDBkey() );
337  $tpl->set( 'search', trim( $request->getVal( 'search' ) ) );
338  $tpl->set( 'stylepath', $wgStylePath );
339  $tpl->set( 'articlepath', $wgArticlePath );
340  $tpl->set( 'scriptpath', $wgScriptPath );
341  $tpl->set( 'serverurl', $wgServer );
342  $tpl->set( 'logopath', $wgLogo );
343  $tpl->set( 'sitename', $wgSitename );
344 
345  $userLang = $this->getLanguage();
346  $userLangCode = $userLang->getHtmlCode();
347  $userLangDir = $userLang->getDir();
348 
349  $tpl->set( 'lang', $userLangCode );
350  $tpl->set( 'dir', $userLangDir );
351  $tpl->set( 'rtl', $userLang->isRTL() );
352 
353  $tpl->set( 'capitalizeallnouns', $userLang->capitalizeAllNouns() ? ' capitalize-all-nouns' : '' );
354  $tpl->set( 'showjumplinks', true ); // showjumplinks preference has been removed
355  $tpl->set( 'username', $this->loggedin ? $this->username : null );
356  $tpl->set( 'userpage', $this->userpage );
357  $tpl->set( 'userpageurl', $this->userpageUrlDetails['href'] );
358  $tpl->set( 'userlang', $userLangCode );
359 
360  // Users can have their language set differently than the
361  // content of the wiki. For these users, tell the web browser
362  // that interface elements are in a different language.
363  $tpl->set( 'userlangattributes', '' );
364  $tpl->set( 'specialpageattributes', '' ); # obsolete
365  // Used by VectorBeta to insert HTML before content but after the
366  // heading for the page title. Defaults to empty string.
367  $tpl->set( 'prebodyhtml', '' );
368 
369  $contLang = MediaWikiServices::getInstance()->getContentLanguage();
370  if (
371  $userLangCode !== $contLang->getHtmlCode() ||
372  $userLangDir !== $contLang->getDir()
373  ) {
374  $escUserlang = htmlspecialchars( $userLangCode );
375  $escUserdir = htmlspecialchars( $userLangDir );
376  // Attributes must be in double quotes because htmlspecialchars() doesn't
377  // escape single quotes
378  $attrs = " lang=\"$escUserlang\" dir=\"$escUserdir\"";
379  $tpl->set( 'userlangattributes', $attrs );
380  }
381 
382  $tpl->set( 'newtalk', $this->getNewtalks() );
383  $tpl->set( 'logo', $this->logoText() );
384 
385  $tpl->set( 'copyright', false );
386  // No longer used
387  $tpl->set( 'viewcount', false );
388  $tpl->set( 'lastmod', false );
389  $tpl->set( 'credits', false );
390  $tpl->set( 'numberofwatchingusers', false );
391  if ( $title->exists() ) {
392  if ( $out->isArticle() && $this->isRevisionCurrent() ) {
393  if ( $wgMaxCredits != 0 ) {
395  $action = Action::factory(
396  'credits', $this->getWikiPage(), $this->getContext() );
397  $tpl->set( 'credits',
398  $action->getCredits( $wgMaxCredits, $wgShowCreditsIfMax ) );
399  } else {
400  $tpl->set( 'lastmod', $this->lastModified() );
401  }
402  }
403  if ( $out->showsCopyright() ) {
404  $tpl->set( 'copyright', $this->getCopyright() );
405  }
406  }
407 
408  $tpl->set( 'copyrightico', $this->getCopyrightIcon() );
409  $tpl->set( 'poweredbyico', $this->getPoweredBy() );
410  $tpl->set( 'disclaimer', $this->disclaimerLink() );
411  $tpl->set( 'privacy', $this->privacyLink() );
412  $tpl->set( 'about', $this->aboutLink() );
413 
414  $tpl->set( 'footerlinks', [
415  'info' => [
416  'lastmod',
417  'numberofwatchingusers',
418  'credits',
419  'copyright',
420  ],
421  'places' => [
422  'privacy',
423  'about',
424  'disclaimer',
425  ],
426  ] );
427 
428  global $wgFooterIcons;
429  $tpl->set( 'footericons', $wgFooterIcons );
430  foreach ( $tpl->data['footericons'] as $footerIconsKey => &$footerIconsBlock ) {
431  if ( count( $footerIconsBlock ) > 0 ) {
432  foreach ( $footerIconsBlock as &$footerIcon ) {
433  if ( isset( $footerIcon['src'] ) ) {
434  if ( !isset( $footerIcon['width'] ) ) {
435  $footerIcon['width'] = 88;
436  }
437  if ( !isset( $footerIcon['height'] ) ) {
438  $footerIcon['height'] = 31;
439  }
440  }
441  }
442  } else {
443  unset( $tpl->data['footericons'][$footerIconsKey] );
444  }
445  }
446 
447  $tpl->set( 'indicators', $out->getIndicators() );
448 
449  $tpl->set( 'sitenotice', $this->getSiteNotice() );
450  $tpl->set( 'printfooter', $this->printSource() );
451  // Wrap the bodyText with #mw-content-text element
452  $out->mBodytext = $this->wrapHTML( $title, $out->mBodytext );
453  $tpl->set( 'bodytext', $out->mBodytext );
454 
455  $language_urls = $this->getLanguages();
456  if ( count( $language_urls ) ) {
457  $tpl->set( 'language_urls', $language_urls );
458  } else {
459  $tpl->set( 'language_urls', false );
460  }
461 
462  # Personal toolbar
463  $tpl->set( 'personal_urls', $this->buildPersonalUrls() );
464  $content_navigation = $this->buildContentNavigationUrls();
465  $content_actions = $this->buildContentActionUrls( $content_navigation );
466  $tpl->set( 'content_navigation', $content_navigation );
467  $tpl->set( 'content_actions', $content_actions );
468 
469  $tpl->set( 'sidebar', $this->buildSidebar() );
470  $tpl->set( 'nav_urls', $this->buildNavUrls() );
471 
472  // Do this last in case hooks above add bottom scripts
473  $tpl->set( 'bottomscripts', $this->bottomScripts() );
474 
475  // Set the head scripts near the end, in case the above actions resulted in added scripts
476  $tpl->set( 'headelement', $out->headElement( $this ) );
477 
478  $tpl->set( 'debug', '' );
479  $tpl->set( 'debughtml', $this->generateDebugHTML() );
480  $tpl->set( 'reporttime', wfReportTime( $out->getCSPNonce() ) );
481 
482  // Avoid PHP 7.1 warning of passing $this by reference
483  $skinTemplate = $this;
484  // original version by hansm
485  if ( !Hooks::run( 'SkinTemplateOutputPageBeforeExec', [ &$skinTemplate, &$tpl ] ) ) {
486  wfDebug( __METHOD__ . ": Hook SkinTemplateOutputPageBeforeExec broke outputPage execution!\n" );
487  }
488 
489  // Set the bodytext to another key so that skins can just output it on its own
490  // and output printfooter and debughtml separately
491  $tpl->set( 'bodycontent', $tpl->data['bodytext'] );
492 
493  // Append printfooter and debughtml onto bodytext so that skins that
494  // were already using bodytext before they were split out don't suddenly
495  // start not outputting information.
496  $tpl->data['bodytext'] .= Html::rawElement(
497  'div',
498  [ 'class' => 'printfooter' ],
499  "\n{$tpl->data['printfooter']}"
500  ) . "\n";
501  $tpl->data['bodytext'] .= $tpl->data['debughtml'];
502 
503  // allow extensions adding stuff after the page content.
504  // See Skin::afterContentHook() for further documentation.
505  $tpl->set( 'dataAfterContent', $this->afterContentHook() );
506 
507  return $tpl;
508  }
509 
514  public function getPersonalToolsList() {
515  return $this->makePersonalToolsList();
516  }
517 
527  public function makePersonalToolsList( $personalTools = null, $options = [] ) {
528  $tpl = $this->setupTemplateForOutput();
529  $tpl->set( 'personal_urls', $this->buildPersonalUrls() );
530  $html = '';
531 
532  if ( $personalTools === null ) {
533  $personalTools = ( $tpl instanceof BaseTemplate )
534  ? $tpl->getPersonalTools()
535  : [];
536  }
537 
538  foreach ( $personalTools as $key => $item ) {
539  $html .= $tpl->makeListItem( $key, $item, $options );
540  }
541 
542  return $html;
543  }
544 
552  public function getStructuredPersonalTools() {
553  $tpl = $this->setupTemplateForOutput();
554  $tpl->set( 'personal_urls', $this->buildPersonalUrls() );
555 
556  return ( $tpl instanceof BaseTemplate ) ? $tpl->getPersonalTools() : [];
557  }
558 
567  function formatLanguageName( $name ) {
568  return $this->getLanguage()->ucfirst( $name );
569  }
570 
579  function printOrError( $str ) {
580  echo $str;
581  }
582 
592  function useCombinedLoginLink() {
595  }
596 
601  protected function buildPersonalUrls() {
602  $title = $this->getTitle();
603  $request = $this->getRequest();
604  $pageurl = $title->getLocalURL();
605  $authManager = AuthManager::singleton();
606 
607  /* set up the default links for the personal toolbar */
608  $personal_urls = [];
609 
610  # Due to T34276, if a user does not have read permissions,
611  # $this->getTitle() will just give Special:Badtitle, which is
612  # not especially useful as a returnto parameter. Use the title
613  # from the request instead, if there was one.
614  if ( $this->getUser()->isAllowed( 'read' ) ) {
615  $page = $this->getTitle();
616  } else {
617  $page = Title::newFromText( $request->getVal( 'title', '' ) );
618  }
619  $page = $request->getVal( 'returnto', $page );
620  $returnto = [];
621  if ( strval( $page ) !== '' ) {
622  $returnto['returnto'] = $page;
623  $query = $request->getVal( 'returntoquery', $this->thisquery );
624  $paramsArray = wfCgiToArray( $query );
625  unset( $paramsArray['logoutToken'] );
626  $query = wfArrayToCgi( $paramsArray );
627  if ( $query != '' ) {
628  $returnto['returntoquery'] = $query;
629  }
630  }
631 
632  if ( $this->loggedin ) {
633  $personal_urls['userpage'] = [
634  'text' => $this->username,
635  'href' => &$this->userpageUrlDetails['href'],
636  'class' => $this->userpageUrlDetails['exists'] ? false : 'new',
637  'exists' => $this->userpageUrlDetails['exists'],
638  'active' => ( $this->userpageUrlDetails['href'] == $pageurl ),
639  'dir' => 'auto'
640  ];
641  $usertalkUrlDetails = $this->makeTalkUrlDetails( $this->userpage );
642  $personal_urls['mytalk'] = [
643  'text' => $this->msg( 'mytalk' )->text(),
644  'href' => &$usertalkUrlDetails['href'],
645  'class' => $usertalkUrlDetails['exists'] ? false : 'new',
646  'exists' => $usertalkUrlDetails['exists'],
647  'active' => ( $usertalkUrlDetails['href'] == $pageurl )
648  ];
649  $href = self::makeSpecialUrl( 'Preferences' );
650  $personal_urls['preferences'] = [
651  'text' => $this->msg( 'mypreferences' )->text(),
652  'href' => $href,
653  'active' => ( $href == $pageurl )
654  ];
655 
656  if ( $this->getUser()->isAllowed( 'viewmywatchlist' ) ) {
657  $href = self::makeSpecialUrl( 'Watchlist' );
658  $personal_urls['watchlist'] = [
659  'text' => $this->msg( 'mywatchlist' )->text(),
660  'href' => $href,
661  'active' => ( $href == $pageurl )
662  ];
663  }
664 
665  # We need to do an explicit check for Special:Contributions, as we
666  # have to match both the title, and the target, which could come
667  # from request values (Special:Contributions?target=Jimbo_Wales)
668  # or be specified in "sub page" form
669  # (Special:Contributions/Jimbo_Wales). The plot
670  # thickens, because the Title object is altered for special pages,
671  # so it doesn't contain the original alias-with-subpage.
672  $origTitle = Title::newFromText( $request->getText( 'title' ) );
673  if ( $origTitle instanceof Title && $origTitle->isSpecialPage() ) {
674  list( $spName, $spPar ) =
675  MediaWikiServices::getInstance()->getSpecialPageFactory()->
676  resolveAlias( $origTitle->getText() );
677  $active = $spName == 'Contributions'
678  && ( ( $spPar && $spPar == $this->username )
679  || $request->getText( 'target' ) == $this->username );
680  } else {
681  $active = false;
682  }
683 
684  $href = self::makeSpecialUrlSubpage( 'Contributions', $this->username );
685  $personal_urls['mycontris'] = [
686  'text' => $this->msg( 'mycontris' )->text(),
687  'href' => $href,
688  'active' => $active
689  ];
690 
691  // if we can't set the user, we can't unset it either
692  if ( $request->getSession()->canSetUser() ) {
693  $personal_urls['logout'] = [
694  'text' => $this->msg( 'pt-userlogout' )->text(),
695  'href' => self::makeSpecialUrl( 'Userlogout',
696  // Note: userlogout link must always contain an & character, otherwise we might not be able
697  // to detect a buggy precaching proxy (T19790)
698  ( $title->isSpecial( 'Preferences' ) ? [] : $returnto )
699  + [ 'logoutToken' => $this->getUser()->getEditToken( 'logoutToken', $this->getRequest() ) ] ),
700  'active' => false
701  ];
702  }
703  } else {
704  $useCombinedLoginLink = $this->useCombinedLoginLink();
705  if ( !$authManager->canCreateAccounts() || !$authManager->canAuthenticateNow() ) {
706  // don't show combined login/signup link if one of those is actually not available
707  $useCombinedLoginLink = false;
708  }
709 
710  $loginlink = $this->getUser()->isAllowed( 'createaccount' ) && $useCombinedLoginLink
711  ? 'nav-login-createaccount'
712  : 'pt-login';
713 
714  $login_url = [
715  'text' => $this->msg( $loginlink )->text(),
716  'href' => self::makeSpecialUrl( 'Userlogin', $returnto ),
717  'active' => $title->isSpecial( 'Userlogin' )
718  || $title->isSpecial( 'CreateAccount' ) && $useCombinedLoginLink,
719  ];
720  $createaccount_url = [
721  'text' => $this->msg( 'pt-createaccount' )->text(),
722  'href' => self::makeSpecialUrl( 'CreateAccount', $returnto ),
723  'active' => $title->isSpecial( 'CreateAccount' ),
724  ];
725 
726  // No need to show Talk and Contributions to anons if they can't contribute!
727  if ( User::groupHasPermission( '*', 'edit' ) ) {
728  // Because of caching, we can't link directly to the IP talk and
729  // contributions pages. Instead we use the special page shortcuts
730  // (which work correctly regardless of caching). This means we can't
731  // determine whether these links are active or not, but since major
732  // skins (MonoBook, Vector) don't use this information, it's not a
733  // huge loss.
734  $personal_urls['anontalk'] = [
735  'text' => $this->msg( 'anontalk' )->text(),
736  'href' => self::makeSpecialUrlSubpage( 'Mytalk', false ),
737  'active' => false
738  ];
739  $personal_urls['anoncontribs'] = [
740  'text' => $this->msg( 'anoncontribs' )->text(),
741  'href' => self::makeSpecialUrlSubpage( 'Mycontributions', false ),
742  'active' => false
743  ];
744  }
745 
746  if (
747  $authManager->canCreateAccounts()
748  && $this->getUser()->isAllowed( 'createaccount' )
749  && !$useCombinedLoginLink
750  ) {
751  $personal_urls['createaccount'] = $createaccount_url;
752  }
753 
754  if ( $authManager->canAuthenticateNow() ) {
755  $key = User::groupHasPermission( '*', 'read' )
756  ? 'login'
757  : 'login-private';
758  $personal_urls[$key] = $login_url;
759  }
760  }
761 
762  Hooks::runWithoutAbort( 'PersonalUrls', [ &$personal_urls, &$title, $this ] );
763  return $personal_urls;
764  }
765 
777  function tabAction( $title, $message, $selected, $query = '', $checkEdit = false ) {
778  $classes = [];
779  if ( $selected ) {
780  $classes[] = 'selected';
781  }
782  $exists = true;
783  if ( $checkEdit && !$title->isKnown() ) {
784  $classes[] = 'new';
785  $exists = false;
786  if ( $query !== '' ) {
787  $query = 'action=edit&redlink=1&' . $query;
788  } else {
789  $query = 'action=edit&redlink=1';
790  }
791  }
792 
793  $services = MediaWikiServices::getInstance();
794  $linkClass = $services->getLinkRenderer()->getLinkClasses( $title );
795 
796  // wfMessageFallback will nicely accept $message as an array of fallbacks
797  // or just a single key
798  $msg = wfMessageFallback( $message )->setContext( $this->getContext() );
799  if ( is_array( $message ) ) {
800  // for hook compatibility just keep the last message name
801  $message = end( $message );
802  }
803  if ( $msg->exists() ) {
804  $text = $msg->text();
805  } else {
806  $text = $services->getContentLanguage()->getConverter()->
807  convertNamespace( $services->getNamespaceInfo()->
808  getSubject( $title->getNamespace() ) );
809  }
810 
811  // Avoid PHP 7.1 warning of passing $this by reference
812  $skinTemplate = $this;
813  $result = [];
814  if ( !Hooks::run( 'SkinTemplateTabAction', [ &$skinTemplate,
815  $title, $message, $selected, $checkEdit,
816  &$classes, &$query, &$text, &$result ] ) ) {
817  return $result;
818  }
819 
820  $result = [
821  'class' => implode( ' ', $classes ),
822  'text' => $text,
823  'href' => $title->getLocalURL( $query ),
824  'exists' => $exists,
825  'primary' => true ];
826  if ( $linkClass !== '' ) {
827  $result['link-class'] = $linkClass;
828  }
829 
830  return $result;
831  }
832 
833  function makeTalkUrlDetails( $name, $urlaction = '' ) {
835  if ( !is_object( $title ) ) {
836  throw new MWException( __METHOD__ . " given invalid pagename $name" );
837  }
838  $title = $title->getTalkPage();
839  self::checkTitle( $title, $name );
840  return [
841  'href' => $title->getLocalURL( $urlaction ),
842  'exists' => $title->isKnown(),
843  ];
844  }
845 
852  function makeArticleUrlDetails( $name, $urlaction = '' ) {
854  $title = $title->getSubjectPage();
855  self::checkTitle( $title, $name );
856  return [
857  'href' => $title->getLocalURL( $urlaction ),
858  'exists' => $title->exists(),
859  ];
860  }
861 
896  protected function buildContentNavigationUrls() {
898 
899  // Display tabs for the relevant title rather than always the title itself
900  $title = $this->getRelevantTitle();
901  $onPage = $title->equals( $this->getTitle() );
902 
903  $out = $this->getOutput();
904  $request = $this->getRequest();
905  $user = $this->getUser();
906 
907  $content_navigation = [
908  'namespaces' => [],
909  'views' => [],
910  'actions' => [],
911  'variants' => []
912  ];
913 
914  // parameters
915  $action = $request->getVal( 'action', 'view' );
916 
917  $userCanRead = $title->quickUserCan( 'read', $user );
918 
919  // Avoid PHP 7.1 warning of passing $this by reference
920  $skinTemplate = $this;
921  $preventActiveTabs = false;
922  Hooks::run( 'SkinTemplatePreventOtherActiveTabs', [ &$skinTemplate, &$preventActiveTabs ] );
923 
924  // Checks if page is some kind of content
925  if ( $title->canExist() ) {
926  // Gets page objects for the related namespaces
927  $subjectPage = $title->getSubjectPage();
928  $talkPage = $title->getTalkPage();
929 
930  // Determines if this is a talk page
931  $isTalk = $title->isTalkPage();
932 
933  // Generates XML IDs from namespace names
934  $subjectId = $title->getNamespaceKey( '' );
935 
936  if ( $subjectId == 'main' ) {
937  $talkId = 'talk';
938  } else {
939  $talkId = "{$subjectId}_talk";
940  }
941 
942  $skname = $this->skinname;
943 
944  // Adds namespace links
945  $subjectMsg = [ "nstab-$subjectId" ];
946  if ( $subjectPage->isMainPage() ) {
947  array_unshift( $subjectMsg, 'mainpage-nstab' );
948  }
949  $content_navigation['namespaces'][$subjectId] = $this->tabAction(
950  $subjectPage, $subjectMsg, !$isTalk && !$preventActiveTabs, '', $userCanRead
951  );
952  $content_navigation['namespaces'][$subjectId]['context'] = 'subject';
953  $content_navigation['namespaces'][$talkId] = $this->tabAction(
954  $talkPage, [ "nstab-$talkId", 'talk' ], $isTalk && !$preventActiveTabs, '', $userCanRead
955  );
956  $content_navigation['namespaces'][$talkId]['context'] = 'talk';
957 
958  if ( $userCanRead ) {
959  // Adds "view" view link
960  if ( $title->isKnown() ) {
961  $content_navigation['views']['view'] = $this->tabAction(
962  $isTalk ? $talkPage : $subjectPage,
963  [ "$skname-view-view", 'view' ],
964  ( $onPage && ( $action == 'view' || $action == 'purge' ) ), '', true
965  );
966  // signal to hide this from simple content_actions
967  $content_navigation['views']['view']['redundant'] = true;
968  }
969 
970  $page = $this->canUseWikiPage() ? $this->getWikiPage() : false;
971  $isRemoteContent = $page && !$page->isLocal();
972 
973  // If it is a non-local file, show a link to the file in its own repository
974  // @todo abstract this for remote content that isn't a file
975  if ( $isRemoteContent ) {
976  $content_navigation['views']['view-foreign'] = [
977  'class' => '',
978  'text' => wfMessageFallback( "$skname-view-foreign", 'view-foreign' )->
979  setContext( $this->getContext() )->
980  params( $page->getWikiDisplayName() )->text(),
981  'href' => $page->getSourceURL(),
982  'primary' => false,
983  ];
984  }
985 
986  // Checks if user can edit the current page if it exists or create it otherwise
987  if ( $title->quickUserCan( 'edit', $user )
988  && ( $title->exists() || $title->quickUserCan( 'create', $user ) )
989  ) {
990  // Builds CSS class for talk page links
991  $isTalkClass = $isTalk ? ' istalk' : '';
992  // Whether the user is editing the page
993  $isEditing = $onPage && ( $action == 'edit' || $action == 'submit' );
994  // Whether to show the "Add a new section" tab
995  // Checks if this is a current rev of talk page and is not forced to be hidden
996  $showNewSection = !$out->forceHideNewSectionLink()
997  && ( ( $isTalk && $this->isRevisionCurrent() ) || $out->showNewSectionLink() );
998  $section = $request->getVal( 'section' );
999 
1000  if ( $title->exists()
1001  || ( $title->getNamespace() == NS_MEDIAWIKI
1002  && $title->getDefaultMessageText() !== false
1003  )
1004  ) {
1005  $msgKey = $isRemoteContent ? 'edit-local' : 'edit';
1006  } else {
1007  $msgKey = $isRemoteContent ? 'create-local' : 'create';
1008  }
1009  $content_navigation['views']['edit'] = [
1010  'class' => ( $isEditing && ( $section !== 'new' || !$showNewSection )
1011  ? 'selected'
1012  : ''
1013  ) . $isTalkClass,
1014  'text' => wfMessageFallback( "$skname-view-$msgKey", $msgKey )
1015  ->setContext( $this->getContext() )->text(),
1016  'href' => $title->getLocalURL( $this->editUrlOptions() ),
1017  'primary' => !$isRemoteContent, // don't collapse this in vector
1018  ];
1019 
1020  // section link
1021  if ( $showNewSection ) {
1022  // Adds new section link
1023  // $content_navigation['actions']['addsection']
1024  $content_navigation['views']['addsection'] = [
1025  'class' => ( $isEditing && $section == 'new' ) ? 'selected' : false,
1026  'text' => wfMessageFallback( "$skname-action-addsection", 'addsection' )
1027  ->setContext( $this->getContext() )->text(),
1028  'href' => $title->getLocalURL( 'action=edit&section=new' )
1029  ];
1030  }
1031  // Checks if the page has some kind of viewable source content
1032  } elseif ( $title->hasSourceText() ) {
1033  // Adds view source view link
1034  $content_navigation['views']['viewsource'] = [
1035  'class' => ( $onPage && $action == 'edit' ) ? 'selected' : false,
1036  'text' => wfMessageFallback( "$skname-action-viewsource", 'viewsource' )
1037  ->setContext( $this->getContext() )->text(),
1038  'href' => $title->getLocalURL( $this->editUrlOptions() ),
1039  'primary' => true, // don't collapse this in vector
1040  ];
1041  }
1042 
1043  // Checks if the page exists
1044  if ( $title->exists() ) {
1045  // Adds history view link
1046  $content_navigation['views']['history'] = [
1047  'class' => ( $onPage && $action == 'history' ) ? 'selected' : false,
1048  'text' => wfMessageFallback( "$skname-view-history", 'history_short' )
1049  ->setContext( $this->getContext() )->text(),
1050  'href' => $title->getLocalURL( 'action=history' ),
1051  ];
1052 
1053  if ( $title->quickUserCan( 'delete', $user ) ) {
1054  $content_navigation['actions']['delete'] = [
1055  'class' => ( $onPage && $action == 'delete' ) ? 'selected' : false,
1056  'text' => wfMessageFallback( "$skname-action-delete", 'delete' )
1057  ->setContext( $this->getContext() )->text(),
1058  'href' => $title->getLocalURL( 'action=delete' )
1059  ];
1060  }
1061 
1062  if ( $title->quickUserCan( 'move', $user ) ) {
1063  $moveTitle = SpecialPage::getTitleFor( 'Movepage', $title->getPrefixedDBkey() );
1064  $content_navigation['actions']['move'] = [
1065  'class' => $this->getTitle()->isSpecial( 'Movepage' ) ? 'selected' : false,
1066  'text' => wfMessageFallback( "$skname-action-move", 'move' )
1067  ->setContext( $this->getContext() )->text(),
1068  'href' => $moveTitle->getLocalURL()
1069  ];
1070  }
1071  } else {
1072  // article doesn't exist or is deleted
1073  if ( $title->quickUserCan( 'deletedhistory', $user ) ) {
1074  $n = $title->isDeleted();
1075  if ( $n ) {
1076  $undelTitle = SpecialPage::getTitleFor( 'Undelete', $title->getPrefixedDBkey() );
1077  // If the user can't undelete but can view deleted
1078  // history show them a "View .. deleted" tab instead.
1079  $msgKey = $title->quickUserCan( 'undelete', $user ) ? 'undelete' : 'viewdeleted';
1080  $content_navigation['actions']['undelete'] = [
1081  'class' => $this->getTitle()->isSpecial( 'Undelete' ) ? 'selected' : false,
1082  'text' => wfMessageFallback( "$skname-action-$msgKey", "{$msgKey}_short" )
1083  ->setContext( $this->getContext() )->numParams( $n )->text(),
1084  'href' => $undelTitle->getLocalURL()
1085  ];
1086  }
1087  }
1088  }
1089 
1090  if ( $title->quickUserCan( 'protect', $user ) && $title->getRestrictionTypes() &&
1091  MediaWikiServices::getInstance()->getNamespaceInfo()->
1092  getRestrictionLevels( $title->getNamespace(), $user ) !== [ '' ]
1093  ) {
1094  $mode = $title->isProtected() ? 'unprotect' : 'protect';
1095  $content_navigation['actions'][$mode] = [
1096  'class' => ( $onPage && $action == $mode ) ? 'selected' : false,
1097  'text' => wfMessageFallback( "$skname-action-$mode", $mode )
1098  ->setContext( $this->getContext() )->text(),
1099  'href' => $title->getLocalURL( "action=$mode" )
1100  ];
1101  }
1102 
1103  // Checks if the user is logged in
1104  if ( $this->loggedin && $user->isAllowedAll( 'viewmywatchlist', 'editmywatchlist' ) ) {
1114  $mode = $user->isWatched( $title ) ? 'unwatch' : 'watch';
1115  $content_navigation['actions'][$mode] = [
1116  'class' => 'mw-watchlink ' . (
1117  $onPage && ( $action == 'watch' || $action == 'unwatch' ) ? 'selected' : ''
1118  ),
1119  // uses 'watch' or 'unwatch' message
1120  'text' => $this->msg( $mode )->text(),
1121  'href' => $title->getLocalURL( [ 'action' => $mode ] ),
1122  // Set a data-mw=interface attribute, which the mediawiki.page.ajax
1123  // module will look for to make sure it's a trusted link
1124  'data' => [
1125  'mw' => 'interface',
1126  ],
1127  ];
1128  }
1129  }
1130 
1131  // Avoid PHP 7.1 warning of passing $this by reference
1132  $skinTemplate = $this;
1134  'SkinTemplateNavigation',
1135  [ &$skinTemplate, &$content_navigation ]
1136  );
1137 
1138  if ( $userCanRead && !$wgDisableLangConversion ) {
1139  $pageLang = $title->getPageLanguage();
1140  // Checks that language conversion is enabled and variants exist
1141  // And if it is not in the special namespace
1142  if ( $pageLang->hasVariants() ) {
1143  // Gets list of language variants
1144  $variants = $pageLang->getVariants();
1145  // Gets preferred variant (note that user preference is
1146  // only possible for wiki content language variant)
1147  $preferred = $pageLang->getPreferredVariant();
1148  if ( Action::getActionName( $this ) === 'view' ) {
1149  $params = $request->getQueryValues();
1150  unset( $params['title'] );
1151  } else {
1152  $params = [];
1153  }
1154  // Loops over each variant
1155  foreach ( $variants as $code ) {
1156  // Gets variant name from language code
1157  $varname = $pageLang->getVariantname( $code );
1158  // Appends variant link
1159  $content_navigation['variants'][] = [
1160  'class' => ( $code == $preferred ) ? 'selected' : false,
1161  'text' => $varname,
1162  'href' => $title->getLocalURL( [ 'variant' => $code ] + $params ),
1163  'lang' => LanguageCode::bcp47( $code ),
1164  'hreflang' => LanguageCode::bcp47( $code ),
1165  ];
1166  }
1167  }
1168  }
1169  } else {
1170  // If it's not content, it's got to be a special page
1171  $content_navigation['namespaces']['special'] = [
1172  'class' => 'selected',
1173  'text' => $this->msg( 'nstab-special' )->text(),
1174  'href' => $request->getRequestURL(), // @see: T4457, T4510
1175  'context' => 'subject'
1176  ];
1177 
1178  // Avoid PHP 7.1 warning of passing $this by reference
1179  $skinTemplate = $this;
1180  Hooks::runWithoutAbort( 'SkinTemplateNavigation::SpecialPage',
1181  [ &$skinTemplate, &$content_navigation ] );
1182  }
1183 
1184  // Avoid PHP 7.1 warning of passing $this by reference
1185  $skinTemplate = $this;
1186  // Equiv to SkinTemplateContentActions
1187  Hooks::runWithoutAbort( 'SkinTemplateNavigation::Universal',
1188  [ &$skinTemplate, &$content_navigation ] );
1189 
1190  // Setup xml ids and tooltip info
1191  foreach ( $content_navigation as $section => &$links ) {
1192  foreach ( $links as $key => &$link ) {
1193  $xmlID = $key;
1194  if ( isset( $link['context'] ) && $link['context'] == 'subject' ) {
1195  $xmlID = 'ca-nstab-' . $xmlID;
1196  } elseif ( isset( $link['context'] ) && $link['context'] == 'talk' ) {
1197  $xmlID = 'ca-talk';
1198  $link['rel'] = 'discussion';
1199  } elseif ( $section == 'variants' ) {
1200  $xmlID = 'ca-varlang-' . $xmlID;
1201  } else {
1202  $xmlID = 'ca-' . $xmlID;
1203  }
1204  $link['id'] = $xmlID;
1205  }
1206  }
1207 
1208  # We don't want to give the watch tab an accesskey if the
1209  # page is being edited, because that conflicts with the
1210  # accesskey on the watch checkbox. We also don't want to
1211  # give the edit tab an accesskey, because that's fairly
1212  # superfluous and conflicts with an accesskey (Ctrl-E) often
1213  # used for editing in Safari.
1214  if ( in_array( $action, [ 'edit', 'submit' ] ) ) {
1215  if ( isset( $content_navigation['views']['edit'] ) ) {
1216  $content_navigation['views']['edit']['tooltiponly'] = true;
1217  }
1218  if ( isset( $content_navigation['actions']['watch'] ) ) {
1219  $content_navigation['actions']['watch']['tooltiponly'] = true;
1220  }
1221  if ( isset( $content_navigation['actions']['unwatch'] ) ) {
1222  $content_navigation['actions']['unwatch']['tooltiponly'] = true;
1223  }
1224  }
1225 
1226  return $content_navigation;
1227  }
1228 
1234  private function buildContentActionUrls( $content_navigation ) {
1235  // content_actions has been replaced with content_navigation for backwards
1236  // compatibility and also for skins that just want simple tabs content_actions
1237  // is now built by flattening the content_navigation arrays into one
1238 
1239  $content_actions = [];
1240 
1241  foreach ( $content_navigation as $links ) {
1242  foreach ( $links as $key => $value ) {
1243  if ( isset( $value['redundant'] ) && $value['redundant'] ) {
1244  // Redundant tabs are dropped from content_actions
1245  continue;
1246  }
1247 
1248  // content_actions used to have ids built using the "ca-$key" pattern
1249  // so the xmlID based id is much closer to the actual $key that we want
1250  // for that reason we'll just strip out the ca- if present and use
1251  // the latter potion of the "id" as the $key
1252  if ( isset( $value['id'] ) && substr( $value['id'], 0, 3 ) == 'ca-' ) {
1253  $key = substr( $value['id'], 3 );
1254  }
1255 
1256  if ( isset( $content_actions[$key] ) ) {
1257  wfDebug( __METHOD__ . ": Found a duplicate key for $key while flattening " .
1258  "content_navigation into content_actions.\n" );
1259  continue;
1260  }
1261 
1262  $content_actions[$key] = $value;
1263  }
1264  }
1265 
1266  return $content_actions;
1267  }
1268 
1273  protected function buildNavUrls() {
1274  global $wgUploadNavigationUrl;
1275 
1276  $out = $this->getOutput();
1277  $request = $this->getRequest();
1278 
1279  $nav_urls = [];
1280  $nav_urls['mainpage'] = [ 'href' => self::makeMainPageUrl() ];
1281  if ( $wgUploadNavigationUrl ) {
1282  $nav_urls['upload'] = [ 'href' => $wgUploadNavigationUrl ];
1283  } elseif ( UploadBase::isEnabled() && UploadBase::isAllowed( $this->getUser() ) === true ) {
1284  $nav_urls['upload'] = [ 'href' => self::makeSpecialUrl( 'Upload' ) ];
1285  } else {
1286  $nav_urls['upload'] = false;
1287  }
1288  $nav_urls['specialpages'] = [ 'href' => self::makeSpecialUrl( 'Specialpages' ) ];
1289 
1290  $nav_urls['print'] = false;
1291  $nav_urls['permalink'] = false;
1292  $nav_urls['info'] = false;
1293  $nav_urls['whatlinkshere'] = false;
1294  $nav_urls['recentchangeslinked'] = false;
1295  $nav_urls['contributions'] = false;
1296  $nav_urls['log'] = false;
1297  $nav_urls['blockip'] = false;
1298  $nav_urls['emailuser'] = false;
1299  $nav_urls['userrights'] = false;
1300 
1301  // A print stylesheet is attached to all pages, but nobody ever
1302  // figures that out. :) Add a link...
1303  if ( !$out->isPrintable() && ( $out->isArticle() || $this->getTitle()->isSpecialPage() ) ) {
1304  $nav_urls['print'] = [
1305  'text' => $this->msg( 'printableversion' )->text(),
1306  'href' => $this->getTitle()->getLocalURL(
1307  $request->appendQueryValue( 'printable', 'yes' ) )
1308  ];
1309  }
1310 
1311  if ( $out->isArticle() ) {
1312  // Also add a "permalink" while we're at it
1313  $revid = $this->getRevisionId();
1314  if ( $revid ) {
1315  $nav_urls['permalink'] = [
1316  'text' => $this->msg( 'permalink' )->text(),
1317  'href' => $this->getTitle()->getLocalURL( "oldid=$revid" )
1318  ];
1319  }
1320 
1321  // Avoid PHP 7.1 warning of passing $this by reference
1322  $skinTemplate = $this;
1323  // Use the copy of revision ID in case this undocumented, shady hook tries to mess with internals
1324  Hooks::run( 'SkinTemplateBuildNavUrlsNav_urlsAfterPermalink',
1325  [ &$skinTemplate, &$nav_urls, &$revid, &$revid ] );
1326  }
1327 
1328  if ( $out->isArticleRelated() ) {
1329  $nav_urls['whatlinkshere'] = [
1330  'href' => SpecialPage::getTitleFor( 'Whatlinkshere', $this->thispage )->getLocalURL()
1331  ];
1332 
1333  $nav_urls['info'] = [
1334  'text' => $this->msg( 'pageinfo-toolboxlink' )->text(),
1335  'href' => $this->getTitle()->getLocalURL( "action=info" )
1336  ];
1337 
1338  if ( $this->getTitle()->exists() || $this->getTitle()->inNamespace( NS_CATEGORY ) ) {
1339  $nav_urls['recentchangeslinked'] = [
1340  'href' => SpecialPage::getTitleFor( 'Recentchangeslinked', $this->thispage )->getLocalURL()
1341  ];
1342  }
1343  }
1344 
1345  $user = $this->getRelevantUser();
1346  if ( $user ) {
1347  $rootUser = $user->getName();
1348 
1349  $nav_urls['contributions'] = [
1350  'text' => $this->msg( 'contributions', $rootUser )->text(),
1351  'href' => self::makeSpecialUrlSubpage( 'Contributions', $rootUser ),
1352  'tooltip-params' => [ $rootUser ],
1353  ];
1354 
1355  $nav_urls['log'] = [
1356  'href' => self::makeSpecialUrlSubpage( 'Log', $rootUser )
1357  ];
1358 
1359  if ( $this->getUser()->isAllowed( 'block' ) ) {
1360  $nav_urls['blockip'] = [
1361  'text' => $this->msg( 'blockip', $rootUser )->text(),
1362  'href' => self::makeSpecialUrlSubpage( 'Block', $rootUser )
1363  ];
1364  }
1365 
1366  if ( $this->showEmailUser( $user ) ) {
1367  $nav_urls['emailuser'] = [
1368  'text' => $this->msg( 'tool-link-emailuser', $rootUser )->text(),
1369  'href' => self::makeSpecialUrlSubpage( 'Emailuser', $rootUser ),
1370  'tooltip-params' => [ $rootUser ],
1371  ];
1372  }
1373 
1374  if ( !$user->isAnon() ) {
1375  $sur = new UserrightsPage;
1376  $sur->setContext( $this->getContext() );
1377  $canChange = $sur->userCanChangeRights( $user );
1378  $nav_urls['userrights'] = [
1379  'text' => $this->msg(
1380  $canChange ? 'tool-link-userrights' : 'tool-link-userrights-readonly',
1381  $rootUser
1382  )->text(),
1383  'href' => self::makeSpecialUrlSubpage( 'Userrights', $rootUser )
1384  ];
1385  }
1386  }
1387 
1388  return $nav_urls;
1389  }
1390 
1395  protected function getNameSpaceKey() {
1396  return $this->getTitle()->getNamespaceKey();
1397  }
1398 }
makePersonalToolsList( $personalTools=null, $options=[])
Get the HTML for the personal tools list.
setContext(IContextSource $context)
$wgShowCreditsIfMax
If there are more than $wgMaxCredits authors, show $wgMaxCredits of them.
showEmailUser( $id)
Definition: Skin.php:1099
makeArticleUrlDetails( $name, $urlaction='')
$wgFooterIcons
Abstract list of footer icons for skins in place of old copyrightico and poweredbyico code You can ad...
lastModified()
Get the timestamp of the latest revision, formatted in user language.
Definition: Skin.php:929
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:1982
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
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:1585
$wgScript
The URL path to index.php.
afterContentHook()
This runs a hook to allow extensions placing their stuff after content and article metadata (e...
Definition: Skin.php:645
getPoweredBy()
Gets the powered by MediaWiki icon.
Definition: Skin.php:906
getNewtalks()
Gets new talk page messages for the current user and returns an appropriate alert message (or an empt...
Definition: Skin.php:1446
getLanguages()
Generates array of language links for the current page.
$wgSitename
Name of the site.
outputPage(OutputPage $out=null)
initialize various variables and generate the template
processing should stop and the error should be shown to the user * false
Definition: hooks.txt:187
$wgJsMimeType
Previously used as content type in HTML script tags.
wrapHTML( $title, $html)
Wrap the body text with language information and identifiable element.
Apache License January AND DISTRIBUTION Definitions License shall mean the terms and conditions for use
buildSidebar()
Build an array that represents the sidebar(s), the navigation bar among them.
Definition: Skin.php:1295
$wgMimeType
The default Content-Type header.
static instance()
Singleton.
Definition: Profiler.php:62
privacyLink()
Gets the link to the wiki&#39;s privacy policy page.
Definition: Skin.php:1058
string $template
For QuickTemplate, the name of the subclass which will actually fill the template.
static factory( $action, Page $page, IContextSource $context=null)
Get an appropriate Action subclass for the given action.
Definition: Action.php:97
static rawElement( $element, $attribs=[], $contents='')
Returns an HTML element in a string.
Definition: Html.php:210
initPage(OutputPage $out)
Definition: Skin.php:163
editUrlOptions()
Return URL options for the &#39;edit page&#39; link.
Definition: Skin.php:1085
buildContentNavigationUrls()
a structured array of links usually used for the tabs in a skin
New base template for a skin&#39;s template extended from QuickTemplate this class features helper method...
$value
const NS_SPECIAL
Definition: Defines.php:53
getCopyrightIcon()
Definition: Skin.php:876
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 MediaWikiServices
Definition: injection.txt:23
msg( $key)
Get a Message object with context set Parameters are the same as wfMessage()
$wgArticlePath
Definition: img_auth.php:46
This list may contain false positives That usually means there is additional text with links below the first Each row contains links to the first and second as well as the first line of the second redirect text
getCategories()
Definition: Skin.php:610
getSiteNotice()
Get the site notice.
Definition: Skin.php:1589
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 'ImportHandleUnknownUser':When a user doesn 't exist locally, this hook is called to give extensions an opportunity to auto-create it. If the auto-creation is successful, return false. $name:User name '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. '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 '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:Array with elements of the form "language:title" in the order that they will be output. & $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 since 1.28! 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:1980
usually copyright or history_copyright This message must be in HTML not wikitext & $link
Definition: hooks.txt:3050
this hook is for auditing only or null if authentication failed before getting that far or null if we can t even determine that When $user is not it can be in the form of< username >< more info > e g for bot passwords intended to be added to log contexts Fields it might only if the login was with a bot password 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:780
wfArrayToCgi( $array1, $array2=null, $prefix='')
This function takes one or two arrays as input, and returns a CGI-style string, e.g.
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:1982
canUseWikiPage()
Check whether a WikiPage object can be get with getWikiPage().
$wgStylePath
The URL path of the skins directory.
wfReportTime( $nonce=null)
Returns a script tag that stores the amount of time it took MediaWiki to handle the request in millis...
setContext( $context)
Sets the context this SpecialPage is executed in.
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 use $formDescriptor instead 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
getStructuredPersonalTools()
Get personal tools for the user.
wfCgiToArray( $query)
This is the logical opposite of wfArrayToCgi(): it accepts a query string as its argument and returns...
static configuration should be added through ResourceLoaderGetConfigVars instead can be used to get the real title e g db for database replication lag or jobqueue for job queue size converted to pseudo seconds It is possible to add more fields and they will be returned to the user in the API response 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:2217
useCombinedLoginLink()
Output a boolean indicating if buildPersonalUrls should output separate login and create account link...
Base class for template-based skins.
getRelevantTitle()
Return the "relevant" title.
Definition: Skin.php:344
$res
Definition: database.txt:21
wfDebug( $text, $dest='all', array $context=[])
Sends a line to the debug log if enabled or, optionally, to a comment in output.
subPageSubtitle( $out=null)
Definition: Skin.php:752
disclaimerLink()
Gets the link to the wiki&#39;s general disclaimers page.
Definition: Skin.php:1074
wfMessageFallback(... $keys)
This function accepts multiple message keys and returns a message instance for the first message whic...
getContext()
Get the base IContextSource object.
$params
const NS_CATEGORY
Definition: Defines.php:78
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:1982
generateDebugHTML()
Generate debug data HTML for displaying at the bottom of the main content area.
Definition: Skin.php:671
this hook is for auditing only or null if authentication failed before getting that far or null if we can t even determine that When $user is not null
Definition: hooks.txt:780
static runWithoutAbort( $event, array $args=[], $deprecatedVersion=null)
Call hook functions defined in Hooks::register and $wgHooks.
Definition: Hooks.php:231
namespace and then decline to actually register it file or subcat img or subcat $title
Definition: hooks.txt:925
getRelevantUser()
Return the "relevant" user.
Definition: Skin.php:365
static getActionName(IContextSource $context)
Get the action that will be executed, not necessarily the one passed passed through the "action" requ...
Definition: Action.php:123
aboutLink()
Gets the link to the wiki&#39;s about page.
Definition: Skin.php:1066
const NS_FILE
Definition: Defines.php:70
static getTitleFor( $name, $subpage=false, $fragment='')
Get a localised Title object for a specified special page name If you don&#39;t need a full Title object...
Definition: SpecialPage.php:82
logoText( $align='')
Definition: Skin.php:956
this hook is for auditing only or null if authentication failed before getting that far or null if we can t even determine that When $user is not it can be in the form of< username >< more info > e g for bot passwords intended to be added to log contexts Fields it might only if the login was with a bot password 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:780
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
Definition: distributors.txt:9
$wgDisableLangConversion
Whether to enable language variant conversion.
const NS_MEDIAWIKI
Definition: Defines.php:72
static groupHasPermission( $group, $role)
Check, if the given group has the given permission.
Definition: User.php:4936
static isEnabled()
Returns true if uploads are enabled.
Definition: UploadBase.php:110
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:3050
static fetchLanguageName( $code, $inLanguage=self::AS_AUTONYMS, $include=self::ALL)
Definition: Language.php:937
buildContentActionUrls( $content_navigation)
an array of edit links by default used for the tabs
printSource()
Text with the permalink to the source page, usually shown on the footer of a printed page...
Definition: Skin.php:702
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:35
tabAction( $title, $message, $selected, $query='', $checkEdit=false)
Builds an array with tab definition.
$wgHideInterlanguageLinks
Hide interlanguage links from the sidebar.
buildPersonalUrls()
build array of urls for personal toolbar
you have access to all of the normal MediaWiki so you can get a DB use the etc For full docs on the Maintenance class
Definition: maintenance.txt:52
isRevisionCurrent()
Whether the revision displayed is the latest revision of the page.
Definition: Skin.php:320
$wgScriptPath
The path we should point to.
wfDeprecated( $function, $version=false, $component=false, $callerOffset=2)
Throws a warning that $function is deprecated.
string $skinname
Name of our skin, it probably needs to be all lower case.
getNameSpaceKey()
Generate strings used for xml &#39;id&#39; names.
$wgMaxCredits
Set this to the number of authors that you want to be credited below an article text.
getCopyright( $type='detect')
Definition: Skin.php:827
prepareQuickTemplate()
initialize various variables and generate the template
$wgLogo
The URL path of the wiki logo.
Special page to allow managing user group membership.
formatLanguageName( $name)
Format language name for use in sidebar interlanguage links list.
getUndeleteLink()
Definition: Skin.php:720
Allows to change the fields on the form that will be generated $name
Definition: hooks.txt:271
$wgServer
URL of the server.
makeTalkUrlDetails( $name, $urlaction='')
$wgUseCombinedLoginLink
Login / create account link behavior when it&#39;s possible for anonymous users to create an account...
getRevisionId()
Get the current revision ID.
Definition: Skin.php:311
$wgUploadNavigationUrl
Point the upload navigation link to an external URL Useful if you want to use a shared repository by ...
escapeSearchLink()
Definition: Skin.php:819
getWikiPage()
Get the WikiPage object.
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 $request
Definition: hooks.txt:2633
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...
bottomScripts()
This gets called shortly before the "</body>" tag.
Definition: Skin.php:680
static bcp47( $code)
Get the normalised IETF language tag See unit test for examples.
return true to allow those checks to and false if checking is done & $user
Definition: hooks.txt:1473
static run( $event, array $args=[], $deprecatedVersion=null)
Call hook functions defined in Hooks::register and $wgHooks.
Definition: Hooks.php:200
static isAllowed( $user)
Returns true if the user can use this upload module or else a string identifying the missing permissi...
Definition: UploadBase.php:129
printOrError( $str)
Output the string, or print error message if it&#39;s an error object of the appropriate type...
buildNavUrls()
build array of common navigation links
static newFromText( $text, $defaultNamespace=NS_MAIN)
Create a new Title from text, such as what one would find in a link.
Definition: Title.php:319
getPersonalToolsList()
Get the HTML for the p-personal list.