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