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 
212  function outputPage() {
213  Profiler::instance()->setTemplated( true );
214  $out = $this->getOutput();
215 
216  $this->initPage( $out );
217  $tpl = $this->prepareQuickTemplate();
218  // execute template
219  $res = $tpl->execute();
220 
221  // result may be an error
222  $this->printOrError( $res );
223  }
224 
232  protected function wrapHTML( $title, $html ) {
233  # An ID that includes the actual body text; without categories, contentSub, ...
234  $realBodyAttribs = [ 'id' => 'mw-content-text' ];
235 
236  # Add a mw-content-ltr/rtl class to be able to style based on text
237  # direction when the content is different from the UI language (only
238  # when viewing)
239  # Most information on special pages and file pages is in user language,
240  # rather than content language, so those will not get this
241  if ( Action::getActionName( $this ) === 'view' &&
242  ( !$title->inNamespaces( NS_SPECIAL, NS_FILE ) || $title->isRedirect() ) ) {
243  $pageLang = $title->getPageViewLanguage();
244  $realBodyAttribs['lang'] = $pageLang->getHtmlCode();
245  $realBodyAttribs['dir'] = $pageLang->getDir();
246  $realBodyAttribs['class'] = 'mw-content-' . $pageLang->getDir();
247  }
248 
249  return Html::rawElement( 'div', $realBodyAttribs, $html );
250  }
251 
258  protected function prepareQuickTemplate() {
263 
264  $title = $this->getTitle();
265  $request = $this->getRequest();
266  $out = $this->getOutput();
267  $tpl = $this->setupTemplateForOutput();
268 
269  $tpl->set( 'title', $out->getPageTitle() );
270  $tpl->set( 'pagetitle', $out->getHTMLTitle() );
271  $tpl->set( 'displaytitle', $out->mPageLinkTitle );
272 
273  $tpl->set( 'thispage', $this->thispage );
274  $tpl->set( 'titleprefixeddbkey', $this->thispage );
275  $tpl->set( 'titletext', $title->getText() );
276  $tpl->set( 'articleid', $title->getArticleID() );
277 
278  $tpl->set( 'isarticle', $out->isArticle() );
279 
280  $subpagestr = $this->subPageSubtitle();
281  if ( $subpagestr !== '' ) {
282  $subpagestr = '<span class="subpages">' . $subpagestr . '</span>';
283  }
284  $tpl->set( 'subtitle', $subpagestr . $out->getSubtitle() );
285 
286  $undelete = $this->getUndeleteLink();
287  if ( $undelete === '' ) {
288  $tpl->set( 'undelete', '' );
289  } else {
290  $tpl->set( 'undelete', '<span class="subpages">' . $undelete . '</span>' );
291  }
292 
293  $tpl->set( 'catlinks', $this->getCategories() );
294  if ( $out->isSyndicated() ) {
295  $feeds = [];
296  foreach ( $out->getSyndicationLinks() as $format => $link ) {
297  $feeds[$format] = [
298  // Messages: feed-atom, feed-rss
299  'text' => $this->msg( "feed-$format" )->text(),
300  'href' => $link
301  ];
302  }
303  $tpl->set( 'feeds', $feeds );
304  } else {
305  $tpl->set( 'feeds', false );
306  }
307 
308  $tpl->set( 'mimetype', $wgMimeType );
309  $tpl->set( 'jsmimetype', $wgJsMimeType );
310  $tpl->set( 'charset', 'UTF-8' );
311  $tpl->set( 'wgScript', $wgScript );
312  $tpl->set( 'skinname', $this->skinname );
313  $tpl->set( 'skinclass', static::class );
314  $tpl->set( 'skin', $this );
315  $tpl->set( 'stylename', $this->stylename );
316  $tpl->set( 'printable', $out->isPrintable() );
317  $tpl->set( 'handheld', $request->getBool( 'handheld' ) );
318  $tpl->set( 'loggedin', $this->loggedin );
319  $tpl->set( 'notspecialpage', !$title->isSpecialPage() );
320  $tpl->set( 'searchaction', $this->getSearchLink() );
321  $tpl->set( 'searchtitle', SpecialPage::getTitleFor( 'Search' )->getPrefixedDBkey() );
322  $tpl->set( 'search', trim( $request->getVal( 'search' ) ) );
323  $tpl->set( 'stylepath', $wgStylePath );
324  $tpl->set( 'articlepath', $wgArticlePath );
325  $tpl->set( 'scriptpath', $wgScriptPath );
326  $tpl->set( 'serverurl', $wgServer );
327  $tpl->set( 'logopath', $wgLogo );
328  $tpl->set( 'sitename', $wgSitename );
329 
330  $userLang = $this->getLanguage();
331  $userLangCode = $userLang->getHtmlCode();
332  $userLangDir = $userLang->getDir();
333 
334  $tpl->set( 'lang', $userLangCode );
335  $tpl->set( 'dir', $userLangDir );
336  $tpl->set( 'rtl', $userLang->isRTL() );
337 
338  $tpl->set( 'capitalizeallnouns', $userLang->capitalizeAllNouns() ? ' capitalize-all-nouns' : '' );
339  $tpl->set( 'showjumplinks', true ); // showjumplinks preference has been removed
340  $tpl->set( 'username', $this->loggedin ? $this->username : null );
341  $tpl->set( 'userpage', $this->userpage );
342  $tpl->set( 'userpageurl', $this->userpageUrlDetails['href'] );
343  $tpl->set( 'userlang', $userLangCode );
344 
345  // Users can have their language set differently than the
346  // content of the wiki. For these users, tell the web browser
347  // that interface elements are in a different language.
348  $tpl->set( 'userlangattributes', '' );
349  $tpl->set( 'specialpageattributes', '' ); # obsolete
350  // Used by VectorBeta to insert HTML before content but after the
351  // heading for the page title. Defaults to empty string.
352  $tpl->set( 'prebodyhtml', '' );
353 
354  $contLang = MediaWikiServices::getInstance()->getContentLanguage();
355  if (
356  $userLangCode !== $contLang->getHtmlCode() ||
357  $userLangDir !== $contLang->getDir()
358  ) {
359  $escUserlang = htmlspecialchars( $userLangCode );
360  $escUserdir = htmlspecialchars( $userLangDir );
361  // Attributes must be in double quotes because htmlspecialchars() doesn't
362  // escape single quotes
363  $attrs = " lang=\"$escUserlang\" dir=\"$escUserdir\"";
364  $tpl->set( 'userlangattributes', $attrs );
365  }
366 
367  $tpl->set( 'newtalk', $this->getNewtalks() );
368  $tpl->set( 'logo', $this->logoText() );
369 
370  $tpl->set( 'copyright', false );
371  // No longer used
372  $tpl->set( 'viewcount', false );
373  $tpl->set( 'lastmod', false );
374  $tpl->set( 'credits', false );
375  $tpl->set( 'numberofwatchingusers', false );
376  if ( $title->exists() ) {
377  if ( $out->isArticle() && $this->isRevisionCurrent() ) {
378  if ( $wgMaxCredits != 0 ) {
380  $action = Action::factory(
381  'credits', $this->getWikiPage(), $this->getContext() );
382  $tpl->set( 'credits',
383  $action->getCredits( $wgMaxCredits, $wgShowCreditsIfMax ) );
384  } else {
385  $tpl->set( 'lastmod', $this->lastModified() );
386  }
387  }
388  if ( $out->showsCopyright() ) {
389  $tpl->set( 'copyright', $this->getCopyright() );
390  }
391  }
392 
393  $tpl->set( 'copyrightico', $this->getCopyrightIcon() );
394  $tpl->set( 'poweredbyico', $this->getPoweredBy() );
395  $tpl->set( 'disclaimer', $this->disclaimerLink() );
396  $tpl->set( 'privacy', $this->privacyLink() );
397  $tpl->set( 'about', $this->aboutLink() );
398 
399  $tpl->set( 'footerlinks', [
400  'info' => [
401  'lastmod',
402  'numberofwatchingusers',
403  'credits',
404  'copyright',
405  ],
406  'places' => [
407  'privacy',
408  'about',
409  'disclaimer',
410  ],
411  ] );
412 
413  global $wgFooterIcons;
414  $tpl->set( 'footericons', $wgFooterIcons );
415  foreach ( $tpl->data['footericons'] as $footerIconsKey => &$footerIconsBlock ) {
416  if ( count( $footerIconsBlock ) > 0 ) {
417  foreach ( $footerIconsBlock as &$footerIcon ) {
418  if ( isset( $footerIcon['src'] ) ) {
419  if ( !isset( $footerIcon['width'] ) ) {
420  $footerIcon['width'] = 88;
421  }
422  if ( !isset( $footerIcon['height'] ) ) {
423  $footerIcon['height'] = 31;
424  }
425  }
426  }
427  } else {
428  unset( $tpl->data['footericons'][$footerIconsKey] );
429  }
430  }
431 
432  $tpl->set( 'indicators', $out->getIndicators() );
433 
434  $tpl->set( 'sitenotice', $this->getSiteNotice() );
435  $tpl->set( 'printfooter', $this->printSource() );
436  // Wrap the bodyText with #mw-content-text element
437  $out->mBodytext = $this->wrapHTML( $title, $out->mBodytext );
438  $tpl->set( 'bodytext', $out->mBodytext );
439 
440  $language_urls = $this->getLanguages();
441  if ( count( $language_urls ) ) {
442  $tpl->set( 'language_urls', $language_urls );
443  } else {
444  $tpl->set( 'language_urls', false );
445  }
446 
447  # Personal toolbar
448  $tpl->set( 'personal_urls', $this->buildPersonalUrls() );
449  $content_navigation = $this->buildContentNavigationUrls();
450  $content_actions = $this->buildContentActionUrls( $content_navigation );
451  $tpl->set( 'content_navigation', $content_navigation );
452  $tpl->set( 'content_actions', $content_actions );
453 
454  $tpl->set( 'sidebar', $this->buildSidebar() );
455  $tpl->set( 'nav_urls', $this->buildNavUrls() );
456 
457  // Do this last in case hooks above add bottom scripts
458  $tpl->set( 'bottomscripts', $this->bottomScripts() );
459 
460  // Set the head scripts near the end, in case the above actions resulted in added scripts
461  $tpl->set( 'headelement', $out->headElement( $this ) );
462 
463  $tpl->set( 'debug', '' );
464  $tpl->set( 'debughtml', $this->generateDebugHTML() );
465  $tpl->set( 'reporttime', wfReportTime( $out->getCSPNonce() ) );
466 
467  // Avoid PHP 7.1 warning of passing $this by reference
468  $skinTemplate = $this;
469  // original version by hansm
470  if ( !Hooks::run( 'SkinTemplateOutputPageBeforeExec', [ &$skinTemplate, &$tpl ] ) ) {
471  wfDebug( __METHOD__ . ": Hook SkinTemplateOutputPageBeforeExec broke outputPage execution!\n" );
472  }
473 
474  // Set the bodytext to another key so that skins can just output it on its own
475  // and output printfooter and debughtml separately
476  $tpl->set( 'bodycontent', $tpl->data['bodytext'] );
477 
478  // Append printfooter and debughtml onto bodytext so that skins that
479  // were already using bodytext before they were split out don't suddenly
480  // start not outputting information.
481  $tpl->data['bodytext'] .= Html::rawElement(
482  'div',
483  [ 'class' => 'printfooter' ],
484  "\n{$tpl->data['printfooter']}"
485  ) . "\n";
486  $tpl->data['bodytext'] .= $tpl->data['debughtml'];
487 
488  // allow extensions adding stuff after the page content.
489  // See Skin::afterContentHook() for further documentation.
490  $tpl->set( 'dataAfterContent', $this->afterContentHook() );
491 
492  return $tpl;
493  }
494 
499  public function getPersonalToolsList() {
500  return $this->makePersonalToolsList();
501  }
502 
512  public function makePersonalToolsList( $personalTools = null, $options = [] ) {
513  $tpl = $this->setupTemplateForOutput();
514  $tpl->set( 'personal_urls', $this->buildPersonalUrls() );
515  $html = '';
516 
517  if ( $personalTools === null ) {
518  $personalTools = ( $tpl instanceof BaseTemplate )
519  ? $tpl->getPersonalTools()
520  : [];
521  }
522 
523  foreach ( $personalTools as $key => $item ) {
524  $html .= $tpl->makeListItem( $key, $item, $options );
525  }
526 
527  return $html;
528  }
529 
537  public function getStructuredPersonalTools() {
538  $tpl = $this->setupTemplateForOutput();
539  $tpl->set( 'personal_urls', $this->buildPersonalUrls() );
540 
541  return ( $tpl instanceof BaseTemplate ) ? $tpl->getPersonalTools() : [];
542  }
543 
552  function formatLanguageName( $name ) {
553  return $this->getLanguage()->ucfirst( $name );
554  }
555 
564  function printOrError( $str ) {
565  echo $str;
566  }
567 
577  function useCombinedLoginLink() {
580  }
581 
586  protected function buildPersonalUrls() {
587  $title = $this->getTitle();
588  $request = $this->getRequest();
589  $pageurl = $title->getLocalURL();
590  $authManager = AuthManager::singleton();
591 
592  /* set up the default links for the personal toolbar */
593  $personal_urls = [];
594 
595  # Due to T34276, if a user does not have read permissions,
596  # $this->getTitle() will just give Special:Badtitle, which is
597  # not especially useful as a returnto parameter. Use the title
598  # from the request instead, if there was one.
599  if ( $this->getUser()->isAllowed( 'read' ) ) {
600  $page = $this->getTitle();
601  } else {
602  $page = Title::newFromText( $request->getVal( 'title', '' ) );
603  }
604  $page = $request->getVal( 'returnto', $page );
605  $returnto = [];
606  if ( strval( $page ) !== '' ) {
607  $returnto['returnto'] = $page;
608  $query = $request->getVal( 'returntoquery', $this->thisquery );
609  $paramsArray = wfCgiToArray( $query );
610  $query = wfArrayToCgi( $paramsArray );
611  if ( $query != '' ) {
612  $returnto['returntoquery'] = $query;
613  }
614  }
615 
616  if ( $this->loggedin ) {
617  $personal_urls['userpage'] = [
618  'text' => $this->username,
619  'href' => &$this->userpageUrlDetails['href'],
620  'class' => $this->userpageUrlDetails['exists'] ? false : 'new',
621  'exists' => $this->userpageUrlDetails['exists'],
622  'active' => ( $this->userpageUrlDetails['href'] == $pageurl ),
623  'dir' => 'auto'
624  ];
625  $usertalkUrlDetails = $this->makeTalkUrlDetails( $this->userpage );
626  $personal_urls['mytalk'] = [
627  'text' => $this->msg( 'mytalk' )->text(),
628  'href' => &$usertalkUrlDetails['href'],
629  'class' => $usertalkUrlDetails['exists'] ? false : 'new',
630  'exists' => $usertalkUrlDetails['exists'],
631  'active' => ( $usertalkUrlDetails['href'] == $pageurl )
632  ];
633  $href = self::makeSpecialUrl( 'Preferences' );
634  $personal_urls['preferences'] = [
635  'text' => $this->msg( 'mypreferences' )->text(),
636  'href' => $href,
637  'active' => ( $href == $pageurl )
638  ];
639 
640  if ( $this->getUser()->isAllowed( 'viewmywatchlist' ) ) {
641  $href = self::makeSpecialUrl( 'Watchlist' );
642  $personal_urls['watchlist'] = [
643  'text' => $this->msg( 'mywatchlist' )->text(),
644  'href' => $href,
645  'active' => ( $href == $pageurl )
646  ];
647  }
648 
649  # We need to do an explicit check for Special:Contributions, as we
650  # have to match both the title, and the target, which could come
651  # from request values (Special:Contributions?target=Jimbo_Wales)
652  # or be specified in "sub page" form
653  # (Special:Contributions/Jimbo_Wales). The plot
654  # thickens, because the Title object is altered for special pages,
655  # so it doesn't contain the original alias-with-subpage.
656  $origTitle = Title::newFromText( $request->getText( 'title' ) );
657  if ( $origTitle instanceof Title && $origTitle->isSpecialPage() ) {
658  list( $spName, $spPar ) =
659  MediaWikiServices::getInstance()->getSpecialPageFactory()->
660  resolveAlias( $origTitle->getText() );
661  $active = $spName == 'Contributions'
662  && ( ( $spPar && $spPar == $this->username )
663  || $request->getText( 'target' ) == $this->username );
664  } else {
665  $active = false;
666  }
667 
668  $href = self::makeSpecialUrlSubpage( 'Contributions', $this->username );
669  $personal_urls['mycontris'] = [
670  'text' => $this->msg( 'mycontris' )->text(),
671  'href' => $href,
672  'active' => $active
673  ];
674 
675  // if we can't set the user, we can't unset it either
676  if ( $request->getSession()->canSetUser() ) {
677  $personal_urls['logout'] = [
678  'text' => $this->msg( 'pt-userlogout' )->text(),
679  'href' => self::makeSpecialUrl( 'Userlogout',
680  // Note: userlogout link must always contain an & character, otherwise we might not be able
681  // to detect a buggy precaching proxy (T19790)
682  ( $title->isSpecial( 'Preferences' ) ? [] : $returnto ) ),
683  'active' => false
684  ];
685  }
686  } else {
687  $useCombinedLoginLink = $this->useCombinedLoginLink();
688  if ( !$authManager->canCreateAccounts() || !$authManager->canAuthenticateNow() ) {
689  // don't show combined login/signup link if one of those is actually not available
690  $useCombinedLoginLink = false;
691  }
692 
693  $loginlink = $this->getUser()->isAllowed( 'createaccount' ) && $useCombinedLoginLink
694  ? 'nav-login-createaccount'
695  : 'pt-login';
696 
697  $login_url = [
698  'text' => $this->msg( $loginlink )->text(),
699  'href' => self::makeSpecialUrl( 'Userlogin', $returnto ),
700  'active' => $title->isSpecial( 'Userlogin' )
701  || $title->isSpecial( 'CreateAccount' ) && $useCombinedLoginLink,
702  ];
703  $createaccount_url = [
704  'text' => $this->msg( 'pt-createaccount' )->text(),
705  'href' => self::makeSpecialUrl( 'CreateAccount', $returnto ),
706  'active' => $title->isSpecial( 'CreateAccount' ),
707  ];
708 
709  // No need to show Talk and Contributions to anons if they can't contribute!
710  if ( User::groupHasPermission( '*', 'edit' ) ) {
711  // Because of caching, we can't link directly to the IP talk and
712  // contributions pages. Instead we use the special page shortcuts
713  // (which work correctly regardless of caching). This means we can't
714  // determine whether these links are active or not, but since major
715  // skins (MonoBook, Vector) don't use this information, it's not a
716  // huge loss.
717  $personal_urls['anontalk'] = [
718  'text' => $this->msg( 'anontalk' )->text(),
719  'href' => self::makeSpecialUrlSubpage( 'Mytalk', false ),
720  'active' => false
721  ];
722  $personal_urls['anoncontribs'] = [
723  'text' => $this->msg( 'anoncontribs' )->text(),
724  'href' => self::makeSpecialUrlSubpage( 'Mycontributions', false ),
725  'active' => false
726  ];
727  }
728 
729  if (
730  $authManager->canCreateAccounts()
731  && $this->getUser()->isAllowed( 'createaccount' )
732  && !$useCombinedLoginLink
733  ) {
734  $personal_urls['createaccount'] = $createaccount_url;
735  }
736 
737  if ( $authManager->canAuthenticateNow() ) {
738  $key = User::groupHasPermission( '*', 'read' )
739  ? 'login'
740  : 'login-private';
741  $personal_urls[$key] = $login_url;
742  }
743  }
744 
745  Hooks::runWithoutAbort( 'PersonalUrls', [ &$personal_urls, &$title, $this ] );
746  return $personal_urls;
747  }
748 
760  function tabAction( $title, $message, $selected, $query = '', $checkEdit = false ) {
761  $classes = [];
762  if ( $selected ) {
763  $classes[] = 'selected';
764  }
765  $exists = true;
766  if ( $checkEdit && !$title->isKnown() ) {
767  $classes[] = 'new';
768  $exists = false;
769  if ( $query !== '' ) {
770  $query = 'action=edit&redlink=1&' . $query;
771  } else {
772  $query = 'action=edit&redlink=1';
773  }
774  }
775 
776  $services = MediaWikiServices::getInstance();
777  $linkClass = $services->getLinkRenderer()->getLinkClasses( $title );
778 
779  // wfMessageFallback will nicely accept $message as an array of fallbacks
780  // or just a single key
781  $msg = wfMessageFallback( $message )->setContext( $this->getContext() );
782  if ( is_array( $message ) ) {
783  // for hook compatibility just keep the last message name
784  $message = end( $message );
785  }
786  if ( $msg->exists() ) {
787  $text = $msg->text();
788  } else {
789  $text = $services->getContentLanguage()->getConverter()->
790  convertNamespace( $services->getNamespaceInfo()->
791  getSubject( $title->getNamespace() ) );
792  }
793 
794  // Avoid PHP 7.1 warning of passing $this by reference
795  $skinTemplate = $this;
796  $result = [];
797  if ( !Hooks::run( 'SkinTemplateTabAction', [ &$skinTemplate,
798  $title, $message, $selected, $checkEdit,
799  &$classes, &$query, &$text, &$result ] ) ) {
800  return $result;
801  }
802 
803  $result = [
804  'class' => implode( ' ', $classes ),
805  'text' => $text,
806  'href' => $title->getLocalURL( $query ),
807  'exists' => $exists,
808  'primary' => true ];
809  if ( $linkClass !== '' ) {
810  $result['link-class'] = $linkClass;
811  }
812 
813  return $result;
814  }
815 
816  function makeTalkUrlDetails( $name, $urlaction = '' ) {
818  if ( !is_object( $title ) ) {
819  throw new MWException( __METHOD__ . " given invalid pagename $name" );
820  }
821  $title = $title->getTalkPage();
822  self::checkTitle( $title, $name );
823  return [
824  'href' => $title->getLocalURL( $urlaction ),
825  'exists' => $title->isKnown(),
826  ];
827  }
828 
835  function makeArticleUrlDetails( $name, $urlaction = '' ) {
837  $title = $title->getSubjectPage();
838  self::checkTitle( $title, $name );
839  return [
840  'href' => $title->getLocalURL( $urlaction ),
841  'exists' => $title->exists(),
842  ];
843  }
844 
879  protected function buildContentNavigationUrls() {
881 
882  // Display tabs for the relevant title rather than always the title itself
883  $title = $this->getRelevantTitle();
884  $onPage = $title->equals( $this->getTitle() );
885 
886  $out = $this->getOutput();
887  $request = $this->getRequest();
888  $user = $this->getUser();
889 
890  $content_navigation = [
891  'namespaces' => [],
892  'views' => [],
893  'actions' => [],
894  'variants' => []
895  ];
896 
897  // parameters
898  $action = $request->getVal( 'action', 'view' );
899 
900  $userCanRead = $title->quickUserCan( 'read', $user );
901 
902  // Avoid PHP 7.1 warning of passing $this by reference
903  $skinTemplate = $this;
904  $preventActiveTabs = false;
905  Hooks::run( 'SkinTemplatePreventOtherActiveTabs', [ &$skinTemplate, &$preventActiveTabs ] );
906 
907  // Checks if page is some kind of content
908  if ( $title->canExist() ) {
909  // Gets page objects for the related namespaces
910  $subjectPage = $title->getSubjectPage();
911  $talkPage = $title->getTalkPage();
912 
913  // Determines if this is a talk page
914  $isTalk = $title->isTalkPage();
915 
916  // Generates XML IDs from namespace names
917  $subjectId = $title->getNamespaceKey( '' );
918 
919  if ( $subjectId == 'main' ) {
920  $talkId = 'talk';
921  } else {
922  $talkId = "{$subjectId}_talk";
923  }
924 
925  $skname = $this->skinname;
926 
927  // Adds namespace links
928  $subjectMsg = [ "nstab-$subjectId" ];
929  if ( $subjectPage->isMainPage() ) {
930  array_unshift( $subjectMsg, 'mainpage-nstab' );
931  }
932  $content_navigation['namespaces'][$subjectId] = $this->tabAction(
933  $subjectPage, $subjectMsg, !$isTalk && !$preventActiveTabs, '', $userCanRead
934  );
935  $content_navigation['namespaces'][$subjectId]['context'] = 'subject';
936  $content_navigation['namespaces'][$talkId] = $this->tabAction(
937  $talkPage, [ "nstab-$talkId", 'talk' ], $isTalk && !$preventActiveTabs, '', $userCanRead
938  );
939  $content_navigation['namespaces'][$talkId]['context'] = 'talk';
940 
941  if ( $userCanRead ) {
942  // Adds "view" view link
943  if ( $title->isKnown() ) {
944  $content_navigation['views']['view'] = $this->tabAction(
945  $isTalk ? $talkPage : $subjectPage,
946  [ "$skname-view-view", 'view' ],
947  ( $onPage && ( $action == 'view' || $action == 'purge' ) ), '', true
948  );
949  // signal to hide this from simple content_actions
950  $content_navigation['views']['view']['redundant'] = true;
951  }
952 
953  $page = $this->canUseWikiPage() ? $this->getWikiPage() : false;
954  $isRemoteContent = $page && !$page->isLocal();
955 
956  // If it is a non-local file, show a link to the file in its own repository
957  // @todo abstract this for remote content that isn't a file
958  if ( $isRemoteContent ) {
959  $content_navigation['views']['view-foreign'] = [
960  'class' => '',
961  'text' => wfMessageFallback( "$skname-view-foreign", 'view-foreign' )->
962  setContext( $this->getContext() )->
963  params( $page->getWikiDisplayName() )->text(),
964  'href' => $page->getSourceURL(),
965  'primary' => false,
966  ];
967  }
968 
969  // Checks if user can edit the current page if it exists or create it otherwise
970  if ( $title->quickUserCan( 'edit', $user )
971  && ( $title->exists() || $title->quickUserCan( 'create', $user ) )
972  ) {
973  // Builds CSS class for talk page links
974  $isTalkClass = $isTalk ? ' istalk' : '';
975  // Whether the user is editing the page
976  $isEditing = $onPage && ( $action == 'edit' || $action == 'submit' );
977  // Whether to show the "Add a new section" tab
978  // Checks if this is a current rev of talk page and is not forced to be hidden
979  $showNewSection = !$out->forceHideNewSectionLink()
980  && ( ( $isTalk && $this->isRevisionCurrent() ) || $out->showNewSectionLink() );
981  $section = $request->getVal( 'section' );
982 
983  if ( $title->exists()
984  || ( $title->getNamespace() == NS_MEDIAWIKI
985  && $title->getDefaultMessageText() !== false
986  )
987  ) {
988  $msgKey = $isRemoteContent ? 'edit-local' : 'edit';
989  } else {
990  $msgKey = $isRemoteContent ? 'create-local' : 'create';
991  }
992  $content_navigation['views']['edit'] = [
993  'class' => ( $isEditing && ( $section !== 'new' || !$showNewSection )
994  ? 'selected'
995  : ''
996  ) . $isTalkClass,
997  'text' => wfMessageFallback( "$skname-view-$msgKey", $msgKey )
998  ->setContext( $this->getContext() )->text(),
999  'href' => $title->getLocalURL( $this->editUrlOptions() ),
1000  'primary' => !$isRemoteContent, // don't collapse this in vector
1001  ];
1002 
1003  // section link
1004  if ( $showNewSection ) {
1005  // Adds new section link
1006  // $content_navigation['actions']['addsection']
1007  $content_navigation['views']['addsection'] = [
1008  'class' => ( $isEditing && $section == 'new' ) ? 'selected' : false,
1009  'text' => wfMessageFallback( "$skname-action-addsection", 'addsection' )
1010  ->setContext( $this->getContext() )->text(),
1011  'href' => $title->getLocalURL( 'action=edit&section=new' )
1012  ];
1013  }
1014  // Checks if the page has some kind of viewable source content
1015  } elseif ( $title->hasSourceText() ) {
1016  // Adds view source view link
1017  $content_navigation['views']['viewsource'] = [
1018  'class' => ( $onPage && $action == 'edit' ) ? 'selected' : false,
1019  'text' => wfMessageFallback( "$skname-action-viewsource", 'viewsource' )
1020  ->setContext( $this->getContext() )->text(),
1021  'href' => $title->getLocalURL( $this->editUrlOptions() ),
1022  'primary' => true, // don't collapse this in vector
1023  ];
1024  }
1025 
1026  // Checks if the page exists
1027  if ( $title->exists() ) {
1028  // Adds history view link
1029  $content_navigation['views']['history'] = [
1030  'class' => ( $onPage && $action == 'history' ) ? 'selected' : false,
1031  'text' => wfMessageFallback( "$skname-view-history", 'history_short' )
1032  ->setContext( $this->getContext() )->text(),
1033  'href' => $title->getLocalURL( 'action=history' ),
1034  ];
1035 
1036  if ( $title->quickUserCan( 'delete', $user ) ) {
1037  $content_navigation['actions']['delete'] = [
1038  'class' => ( $onPage && $action == 'delete' ) ? 'selected' : false,
1039  'text' => wfMessageFallback( "$skname-action-delete", 'delete' )
1040  ->setContext( $this->getContext() )->text(),
1041  'href' => $title->getLocalURL( 'action=delete' )
1042  ];
1043  }
1044 
1045  if ( $title->quickUserCan( 'move', $user ) ) {
1046  $moveTitle = SpecialPage::getTitleFor( 'Movepage', $title->getPrefixedDBkey() );
1047  $content_navigation['actions']['move'] = [
1048  'class' => $this->getTitle()->isSpecial( 'Movepage' ) ? 'selected' : false,
1049  'text' => wfMessageFallback( "$skname-action-move", 'move' )
1050  ->setContext( $this->getContext() )->text(),
1051  'href' => $moveTitle->getLocalURL()
1052  ];
1053  }
1054  } else {
1055  // article doesn't exist or is deleted
1056  if ( $title->quickUserCan( 'deletedhistory', $user ) ) {
1057  $n = $title->isDeleted();
1058  if ( $n ) {
1059  $undelTitle = SpecialPage::getTitleFor( 'Undelete', $title->getPrefixedDBkey() );
1060  // If the user can't undelete but can view deleted
1061  // history show them a "View .. deleted" tab instead.
1062  $msgKey = $title->quickUserCan( 'undelete', $user ) ? 'undelete' : 'viewdeleted';
1063  $content_navigation['actions']['undelete'] = [
1064  'class' => $this->getTitle()->isSpecial( 'Undelete' ) ? 'selected' : false,
1065  'text' => wfMessageFallback( "$skname-action-$msgKey", "{$msgKey}_short" )
1066  ->setContext( $this->getContext() )->numParams( $n )->text(),
1067  'href' => $undelTitle->getLocalURL()
1068  ];
1069  }
1070  }
1071  }
1072 
1073  if ( $title->quickUserCan( 'protect', $user ) && $title->getRestrictionTypes() &&
1074  MediaWikiServices::getInstance()->getNamespaceInfo()->
1075  getRestrictionLevels( $title->getNamespace(), $user ) !== [ '' ]
1076  ) {
1077  $mode = $title->isProtected() ? 'unprotect' : 'protect';
1078  $content_navigation['actions'][$mode] = [
1079  'class' => ( $onPage && $action == $mode ) ? 'selected' : false,
1080  'text' => wfMessageFallback( "$skname-action-$mode", $mode )
1081  ->setContext( $this->getContext() )->text(),
1082  'href' => $title->getLocalURL( "action=$mode" )
1083  ];
1084  }
1085 
1086  // Checks if the user is logged in
1087  if ( $this->loggedin && $user->isAllowedAll( 'viewmywatchlist', 'editmywatchlist' ) ) {
1097  $mode = $user->isWatched( $title ) ? 'unwatch' : 'watch';
1098  $content_navigation['actions'][$mode] = [
1099  'class' => 'mw-watchlink ' . (
1100  $onPage && ( $action == 'watch' || $action == 'unwatch' ) ? 'selected' : ''
1101  ),
1102  // uses 'watch' or 'unwatch' message
1103  'text' => $this->msg( $mode )->text(),
1104  'href' => $title->getLocalURL( [ 'action' => $mode ] ),
1105  // Set a data-mw=interface attribute, which the mediawiki.page.ajax
1106  // module will look for to make sure it's a trusted link
1107  'data' => [
1108  'mw' => 'interface',
1109  ],
1110  ];
1111  }
1112  }
1113 
1114  // Avoid PHP 7.1 warning of passing $this by reference
1115  $skinTemplate = $this;
1117  'SkinTemplateNavigation',
1118  [ &$skinTemplate, &$content_navigation ]
1119  );
1120 
1121  if ( $userCanRead && !$wgDisableLangConversion ) {
1122  $pageLang = $title->getPageLanguage();
1123  // Checks that language conversion is enabled and variants exist
1124  // And if it is not in the special namespace
1125  if ( $pageLang->hasVariants() ) {
1126  // Gets list of language variants
1127  $variants = $pageLang->getVariants();
1128  // Gets preferred variant (note that user preference is
1129  // only possible for wiki content language variant)
1130  $preferred = $pageLang->getPreferredVariant();
1131  if ( Action::getActionName( $this ) === 'view' ) {
1132  $params = $request->getQueryValues();
1133  unset( $params['title'] );
1134  } else {
1135  $params = [];
1136  }
1137  // Loops over each variant
1138  foreach ( $variants as $code ) {
1139  // Gets variant name from language code
1140  $varname = $pageLang->getVariantname( $code );
1141  // Appends variant link
1142  $content_navigation['variants'][] = [
1143  'class' => ( $code == $preferred ) ? 'selected' : false,
1144  'text' => $varname,
1145  'href' => $title->getLocalURL( [ 'variant' => $code ] + $params ),
1146  'lang' => LanguageCode::bcp47( $code ),
1147  'hreflang' => LanguageCode::bcp47( $code ),
1148  ];
1149  }
1150  }
1151  }
1152  } else {
1153  // If it's not content, it's got to be a special page
1154  $content_navigation['namespaces']['special'] = [
1155  'class' => 'selected',
1156  'text' => $this->msg( 'nstab-special' )->text(),
1157  'href' => $request->getRequestURL(), // @see: T4457, T4510
1158  'context' => 'subject'
1159  ];
1160 
1161  // Avoid PHP 7.1 warning of passing $this by reference
1162  $skinTemplate = $this;
1163  Hooks::runWithoutAbort( 'SkinTemplateNavigation::SpecialPage',
1164  [ &$skinTemplate, &$content_navigation ] );
1165  }
1166 
1167  // Avoid PHP 7.1 warning of passing $this by reference
1168  $skinTemplate = $this;
1169  // Equiv to SkinTemplateContentActions
1170  Hooks::runWithoutAbort( 'SkinTemplateNavigation::Universal',
1171  [ &$skinTemplate, &$content_navigation ] );
1172 
1173  // Setup xml ids and tooltip info
1174  foreach ( $content_navigation as $section => &$links ) {
1175  foreach ( $links as $key => &$link ) {
1176  $xmlID = $key;
1177  if ( isset( $link['context'] ) && $link['context'] == 'subject' ) {
1178  $xmlID = 'ca-nstab-' . $xmlID;
1179  } elseif ( isset( $link['context'] ) && $link['context'] == 'talk' ) {
1180  $xmlID = 'ca-talk';
1181  $link['rel'] = 'discussion';
1182  } elseif ( $section == 'variants' ) {
1183  $xmlID = 'ca-varlang-' . $xmlID;
1184  } else {
1185  $xmlID = 'ca-' . $xmlID;
1186  }
1187  $link['id'] = $xmlID;
1188  }
1189  }
1190 
1191  # We don't want to give the watch tab an accesskey if the
1192  # page is being edited, because that conflicts with the
1193  # accesskey on the watch checkbox. We also don't want to
1194  # give the edit tab an accesskey, because that's fairly
1195  # superfluous and conflicts with an accesskey (Ctrl-E) often
1196  # used for editing in Safari.
1197  if ( in_array( $action, [ 'edit', 'submit' ] ) ) {
1198  if ( isset( $content_navigation['views']['edit'] ) ) {
1199  $content_navigation['views']['edit']['tooltiponly'] = true;
1200  }
1201  if ( isset( $content_navigation['actions']['watch'] ) ) {
1202  $content_navigation['actions']['watch']['tooltiponly'] = true;
1203  }
1204  if ( isset( $content_navigation['actions']['unwatch'] ) ) {
1205  $content_navigation['actions']['unwatch']['tooltiponly'] = true;
1206  }
1207  }
1208 
1209  return $content_navigation;
1210  }
1211 
1217  private function buildContentActionUrls( $content_navigation ) {
1218  // content_actions has been replaced with content_navigation for backwards
1219  // compatibility and also for skins that just want simple tabs content_actions
1220  // is now built by flattening the content_navigation arrays into one
1221 
1222  $content_actions = [];
1223 
1224  foreach ( $content_navigation as $links ) {
1225  foreach ( $links as $key => $value ) {
1226  if ( isset( $value['redundant'] ) && $value['redundant'] ) {
1227  // Redundant tabs are dropped from content_actions
1228  continue;
1229  }
1230 
1231  // content_actions used to have ids built using the "ca-$key" pattern
1232  // so the xmlID based id is much closer to the actual $key that we want
1233  // for that reason we'll just strip out the ca- if present and use
1234  // the latter potion of the "id" as the $key
1235  if ( isset( $value['id'] ) && substr( $value['id'], 0, 3 ) == 'ca-' ) {
1236  $key = substr( $value['id'], 3 );
1237  }
1238 
1239  if ( isset( $content_actions[$key] ) ) {
1240  wfDebug( __METHOD__ . ": Found a duplicate key for $key while flattening " .
1241  "content_navigation into content_actions.\n" );
1242  continue;
1243  }
1244 
1245  $content_actions[$key] = $value;
1246  }
1247  }
1248 
1249  return $content_actions;
1250  }
1251 
1256  protected function buildNavUrls() {
1257  global $wgUploadNavigationUrl;
1258 
1259  $out = $this->getOutput();
1260  $request = $this->getRequest();
1261 
1262  $nav_urls = [];
1263  $nav_urls['mainpage'] = [ 'href' => self::makeMainPageUrl() ];
1264  if ( $wgUploadNavigationUrl ) {
1265  $nav_urls['upload'] = [ 'href' => $wgUploadNavigationUrl ];
1266  } elseif ( UploadBase::isEnabled() && UploadBase::isAllowed( $this->getUser() ) === true ) {
1267  $nav_urls['upload'] = [ 'href' => self::makeSpecialUrl( 'Upload' ) ];
1268  } else {
1269  $nav_urls['upload'] = false;
1270  }
1271  $nav_urls['specialpages'] = [ 'href' => self::makeSpecialUrl( 'Specialpages' ) ];
1272 
1273  $nav_urls['print'] = false;
1274  $nav_urls['permalink'] = false;
1275  $nav_urls['info'] = false;
1276  $nav_urls['whatlinkshere'] = false;
1277  $nav_urls['recentchangeslinked'] = false;
1278  $nav_urls['contributions'] = false;
1279  $nav_urls['log'] = false;
1280  $nav_urls['blockip'] = false;
1281  $nav_urls['emailuser'] = false;
1282  $nav_urls['userrights'] = false;
1283 
1284  // A print stylesheet is attached to all pages, but nobody ever
1285  // figures that out. :) Add a link...
1286  if ( !$out->isPrintable() && ( $out->isArticle() || $this->getTitle()->isSpecialPage() ) ) {
1287  $nav_urls['print'] = [
1288  'text' => $this->msg( 'printableversion' )->text(),
1289  'href' => $this->getTitle()->getLocalURL(
1290  $request->appendQueryValue( 'printable', 'yes' ) )
1291  ];
1292  }
1293 
1294  if ( $out->isArticle() ) {
1295  // Also add a "permalink" while we're at it
1296  $revid = $this->getRevisionId();
1297  if ( $revid ) {
1298  $nav_urls['permalink'] = [
1299  'text' => $this->msg( 'permalink' )->text(),
1300  'href' => $this->getTitle()->getLocalURL( "oldid=$revid" )
1301  ];
1302  }
1303 
1304  // Avoid PHP 7.1 warning of passing $this by reference
1305  $skinTemplate = $this;
1306  // Use the copy of revision ID in case this undocumented, shady hook tries to mess with internals
1307  Hooks::run( 'SkinTemplateBuildNavUrlsNav_urlsAfterPermalink',
1308  [ &$skinTemplate, &$nav_urls, &$revid, &$revid ] );
1309  }
1310 
1311  if ( $out->isArticleRelated() ) {
1312  $nav_urls['whatlinkshere'] = [
1313  'href' => SpecialPage::getTitleFor( 'Whatlinkshere', $this->thispage )->getLocalURL()
1314  ];
1315 
1316  $nav_urls['info'] = [
1317  'text' => $this->msg( 'pageinfo-toolboxlink' )->text(),
1318  'href' => $this->getTitle()->getLocalURL( "action=info" )
1319  ];
1320 
1321  if ( $this->getTitle()->exists() || $this->getTitle()->inNamespace( NS_CATEGORY ) ) {
1322  $nav_urls['recentchangeslinked'] = [
1323  'href' => SpecialPage::getTitleFor( 'Recentchangeslinked', $this->thispage )->getLocalURL()
1324  ];
1325  }
1326  }
1327 
1328  $user = $this->getRelevantUser();
1329  if ( $user ) {
1330  $rootUser = $user->getName();
1331 
1332  $nav_urls['contributions'] = [
1333  'text' => $this->msg( 'contributions', $rootUser )->text(),
1334  'href' => self::makeSpecialUrlSubpage( 'Contributions', $rootUser ),
1335  'tooltip-params' => [ $rootUser ],
1336  ];
1337 
1338  $nav_urls['log'] = [
1339  'href' => self::makeSpecialUrlSubpage( 'Log', $rootUser )
1340  ];
1341 
1342  if ( $this->getUser()->isAllowed( 'block' ) ) {
1343  $nav_urls['blockip'] = [
1344  'text' => $this->msg( 'blockip', $rootUser )->text(),
1345  'href' => self::makeSpecialUrlSubpage( 'Block', $rootUser )
1346  ];
1347  }
1348 
1349  if ( $this->showEmailUser( $user ) ) {
1350  $nav_urls['emailuser'] = [
1351  'text' => $this->msg( 'tool-link-emailuser', $rootUser )->text(),
1352  'href' => self::makeSpecialUrlSubpage( 'Emailuser', $rootUser ),
1353  'tooltip-params' => [ $rootUser ],
1354  ];
1355  }
1356 
1357  if ( !$user->isAnon() ) {
1358  $sur = new UserrightsPage;
1359  $sur->setContext( $this->getContext() );
1360  $canChange = $sur->userCanChangeRights( $user );
1361  $nav_urls['userrights'] = [
1362  'text' => $this->msg(
1363  $canChange ? 'tool-link-userrights' : 'tool-link-userrights-readonly',
1364  $rootUser
1365  )->text(),
1366  'href' => self::makeSpecialUrlSubpage( 'Userrights', $rootUser )
1367  ];
1368  }
1369  }
1370 
1371  return $nav_urls;
1372  }
1373 
1378  protected function getNameSpaceKey() {
1379  return $this->getTitle()->getNamespaceKey();
1380  }
1381 }
setContext(IContextSource $context)
makePersonalToolsList( $personalTools=null, $options=[])
Get the HTML for the personal tools list.
$wgShowCreditsIfMax
If there are more than $wgMaxCredits authors, show $wgMaxCredits of them.
showEmailUser( $id)
Definition: Skin.php:1100
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:930
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:1963
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
outputPage()
Initialize various variables and generate the template.
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:1566
$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:644
getPoweredBy()
Gets the powered by MediaWiki icon.
Definition: Skin.php:907
getNewtalks()
Gets new talk page messages for the current user and returns an appropriate alert message (or an empt...
Definition: Skin.php:1447
getLanguages()
Generates array of language links for the current page.
$wgSitename
Name of the site.
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:1296
$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:1059
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:209
initPage(OutputPage $out)
Definition: Skin.php:163
editUrlOptions()
Return URL options for the &#39;edit page&#39; link.
Definition: Skin.php:1086
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:49
getCopyrightIcon()
Definition: Skin.php:877
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:609
getSiteNotice()
Get the site notice.
Definition: Skin.php:1590
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:1961
usually copyright or history_copyright This message must be in HTML not wikitext & $link
Definition: hooks.txt:3032
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:767
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:1963
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:2198
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:751
disclaimerLink()
Gets the link to the wiki&#39;s general disclaimers page.
Definition: Skin.php:1075
wfMessageFallback(... $keys)
This function accepts multiple message keys and returns a message instance for the first message whic...
getContext()
Get the base IContextSource object.
getSearchLink()
Definition: Skin.php:810
$params
const NS_CATEGORY
Definition: Defines.php:74
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:1963
generateDebugHTML()
Generate debug data HTML for displaying at the bottom of the main content area.
Definition: Skin.php:670
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:767
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:912
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:1067
const NS_FILE
Definition: Defines.php:66
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:83
logoText( $align='')
Definition: Skin.php:957
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:767
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:68
static groupHasPermission( $group, $role)
Check, if the given group has the given permission.
Definition: User.php:4831
static isEnabled()
Returns true if uploads are enabled.
Definition: UploadBase.php:132
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:3032
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:701
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.
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:828
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:719
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 ...
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:2614
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:679
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:1454
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:151
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:320
getPersonalToolsList()
Get the HTML for the p-personal list.