includes/skins/SkinTemplate.php

   1 <?php
   2 /**
   3  * This program is free software; you can redistribute it and/or modify
   4  * it under the terms of the GNU General Public License as published by
   5  * the Free Software Foundation; either version 2 of the License, or
   6  * (at your option) any later version.
   7  *
   8  * This program is distributed in the hope that it will be useful,
   9  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  10  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  11  * GNU General Public License for more details.
  12  *
  13  * You should have received a copy of the GNU General Public License along
  14  * with this program; if not, write to the Free Software Foundation, Inc.,
  15  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
  16  * http://www.gnu.org/copyleft/gpl.html
  17  *
  18  * @file
  19  */
  20 use MediaWiki\MediaWikiServices;
  21
  22 /**
  23  * Base class for template-based skins.
  24  *
  25  * Template-filler skin base class
  26  * Formerly generic PHPTal (http://phptal.sourceforge.net/) skin
  27  * Based on Brion's smarty skin
  28  * @copyright Copyright © Gabriel Wicke -- http://www.aulinx.de/
  29  *
  30  * @todo Needs some serious refactoring into functions that correspond
  31  * to the computations individual esi snippets need. Most importantly no body
  32  * parsing for most of those of course.
  33  *
  34  * @ingroup Skins
  35  */
  36 class SkinTemplate extends Skin {
  37         /**
  38          * @var string Name of our skin, it probably needs to be all lower case.
  39          *   Child classes should override the default.
  40          */
  41         public $skinname = 'monobook';
  42
  43         /**
  44          * @var string For QuickTemplate, the name of the subclass which will
  45          *   actually fill the template.  Child classes should override the default.
  46          */
  47         public $template = 'QuickTemplate';
  48
  49         public $thispage;
  50         public $titletxt;
  51         public $userpage;
  52         public $thisquery;
  53         public $loggedin;
  54         public $username;
  55         public $userpageUrlDetails;
  56
  57         /**
  58          * Add specific styles for this skin
  59          *
  60          * @param OutputPage $out
  61          */
  62         function setupSkinUserCss( OutputPage $out ) {
  63                 $moduleStyles = [
  64                         'mediawiki.legacy.shared',
  65                         'mediawiki.legacy.commonPrint',
  66                         'mediawiki.sectionAnchor'
  67                 ];
  68                 if ( $out->isSyndicated() ) {
  69                         $moduleStyles[] = 'mediawiki.feedlink';
  70                 }
  71
  72                 // Deprecated since 1.26: Unconditional loading of mediawiki.ui.button
  73                 // on every page is deprecated. Express a dependency instead.
  74                 if ( strpos( $out->getHTML(), 'mw-ui-button' ) !== false ) {
  75                         $moduleStyles[] = 'mediawiki.ui.button';
  76                 }
  77
  78                 $out->addModuleStyles( $moduleStyles );
  79         }
  80
  81         /**
  82          * Create the template engine object; we feed it a bunch of data
  83          * and eventually it spits out some HTML. Should have interface
  84          * roughly equivalent to PHPTAL 0.7.
  85          *
  86          * @param string $classname
  87          * @param bool|string $repository Subdirectory where we keep template files
  88          * @param bool|string $cache_dir
  89          * @return QuickTemplate
  90          * @private
  91          */
  92         function setupTemplate( $classname, $repository = false, $cache_dir = false ) {
  93                 return new $classname( $this->getConfig() );
  94         }
  95
  96         /**
  97          * Generates array of language links for the current page
  98          *
  99          * @return array
 100          */
 101         public function getLanguages() {
 102                 global $wgHideInterlanguageLinks;
 103                 if ( $wgHideInterlanguageLinks ) {
 104                         return [];
 105                 }
 106
 107                 $userLang = $this->getLanguage();
 108                 $languageLinks = [];
 109
 110                 foreach ( $this->getOutput()->getLanguageLinks() as $languageLinkText ) {
 111                         $class = 'interlanguage-link interwiki-' . explode( ':', $languageLinkText, 2 )[0];
 112
 113                         $languageLinkTitle = Title::newFromText( $languageLinkText );
 114                         if ( $languageLinkTitle ) {
 115                                 $ilInterwikiCode = $languageLinkTitle->getInterwiki();
 116                                 $ilLangName = Language::fetchLanguageName( $ilInterwikiCode );
 117
 118                                 if ( strval( $ilLangName ) === '' ) {
 119                                         $ilDisplayTextMsg = wfMessage( "interlanguage-link-$ilInterwikiCode" );
 120                                         if ( !$ilDisplayTextMsg->isDisabled() ) {
 121                                                 // Use custom MW message for the display text
 122                                                 $ilLangName = $ilDisplayTextMsg->text();
 123                                         } else {
 124                                                 // Last resort: fallback to the language link target
 125                                                 $ilLangName = $languageLinkText;
 126                                         }
 127                                 } else {
 128                                         // Use the language autonym as display text
 129                                         $ilLangName = $this->formatLanguageName( $ilLangName );
 130                                 }
 131
 132                                 // CLDR extension or similar is required to localize the language name;
 133                                 // otherwise we'll end up with the autonym again.
 134                                 $ilLangLocalName = Language::fetchLanguageName(
 135                                         $ilInterwikiCode,
 136                                         $userLang->getCode()
 137                                 );
 138
 139                                 $languageLinkTitleText = $languageLinkTitle->getText();
 140                                 if ( $ilLangLocalName === '' ) {
 141                                         $ilFriendlySiteName = wfMessage( "interlanguage-link-sitename-$ilInterwikiCode" );
 142                                         if ( !$ilFriendlySiteName->isDisabled() ) {
 143                                                 if ( $languageLinkTitleText === '' ) {
 144                                                         $ilTitle = wfMessage(
 145                                                                 'interlanguage-link-title-nonlangonly',
 146                                                                 $ilFriendlySiteName->text()
 147                                                         )->text();
 148                                                 } else {
 149                                                         $ilTitle = wfMessage(
 150                                                                 'interlanguage-link-title-nonlang',
 151                                                                 $languageLinkTitleText,
 152                                                                 $ilFriendlySiteName->text()
 153                                                         )->text();
 154                                                 }
 155                                         } else {
 156                                                 // we have nothing friendly to put in the title, so fall back to
 157                                                 // displaying the interlanguage link itself in the title text
 158                                                 // (similar to what is done in page content)
 159                                                 $ilTitle = $languageLinkTitle->getInterwiki() .
 160                                                         ":$languageLinkTitleText";
 161                                         }
 162                                 } elseif ( $languageLinkTitleText === '' ) {
 163                                         $ilTitle = wfMessage(
 164                                                 'interlanguage-link-title-langonly',
 165                                                 $ilLangLocalName
 166                                         )->text();
 167                                 } else {
 168                                         $ilTitle = wfMessage(
 169                                                 'interlanguage-link-title',
 170                                                 $languageLinkTitleText,
 171                                                 $ilLangLocalName
 172                                         )->text();
 173                                 }
 174
 175                                 $ilInterwikiCodeBCP47 = wfBCP47( $ilInterwikiCode );
 176                                 $languageLink = [
 177                                         'href' => $languageLinkTitle->getFullURL(),
 178                                         'text' => $ilLangName,
 179                                         'title' => $ilTitle,
 180                                         'class' => $class,
 181                                         'lang' => $ilInterwikiCodeBCP47,
 182                                         'hreflang' => $ilInterwikiCodeBCP47,
 183                                 ];
 184                                 Hooks::run(
 185                                         'SkinTemplateGetLanguageLink',
 186                                         [ &$languageLink, $languageLinkTitle, $this->getTitle(), $this->getOutput() ]
 187                                 );
 188                                 $languageLinks[] = $languageLink;
 189                         }
 190                 }
 191
 192                 return $languageLinks;
 193         }
 194
 195         protected function setupTemplateForOutput() {
 196
 197                 $request = $this->getRequest();
 198                 $user = $this->getUser();
 199                 $title = $this->getTitle();
 200
 201                 $tpl = $this->setupTemplate( $this->template, 'skins' );
 202
 203                 $this->thispage = $title->getPrefixedDBkey();
 204                 $this->titletxt = $title->getPrefixedText();
 205                 $this->userpage = $user->getUserPage()->getPrefixedText();
 206                 $query = [];
 207                 if ( !$request->wasPosted() ) {
 208                         $query = $request->getValues();
 209                         unset( $query['title'] );
 210                         unset( $query['returnto'] );
 211                         unset( $query['returntoquery'] );
 212                 }
 213                 $this->thisquery = wfArrayToCgi( $query );
 214                 $this->loggedin = $user->isLoggedIn();
 215                 $this->username = $user->getName();
 216
 217                 if ( $this->loggedin ) {
 218                         $this->userpageUrlDetails = self::makeUrlDetails( $this->userpage );
 219                 } else {
 220                         # This won't be used in the standard skins, but we define it to preserve the interface
 221                         # To save time, we check for existence
 222                         $this->userpageUrlDetails = self::makeKnownUrlDetails( $this->userpage );
 223                 }
 224
 225                 return $tpl;
 226         }
 227
 228         /**
 229          * initialize various variables and generate the template
 230          *
 231          * @param OutputPage $out
 232          */
 233         function outputPage( OutputPage $out = null ) {
 234                 Profiler::instance()->setTemplated( true );
 235
 236                 $oldContext = null;
 237                 if ( $out !== null ) {
 238                         // Deprecated since 1.20, note added in 1.25
 239                         wfDeprecated( __METHOD__, '1.25' );
 240                         $oldContext = $this->getContext();
 241                         $this->setContext( $out->getContext() );
 242                 }
 243
 244                 $out = $this->getOutput();
 245
 246                 $this->initPage( $out );
 247                 $tpl = $this->prepareQuickTemplate( $out );
 248                 // execute template
 249                 $res = $tpl->execute();
 250
 251                 // result may be an error
 252                 $this->printOrError( $res );
 253
 254                 if ( $oldContext ) {
 255                         $this->setContext( $oldContext );
 256                 }
 257
 258         }
 259
 260         /**
 261          * Wrap the body text with language information and identifiable element
 262          *
 263          * @param Title $title
 264          * @param string $html body text
 265          * @return string html
 266          */
 267         protected function wrapHTML( $title, $html ) {
 268                 # An ID that includes the actual body text; without categories, contentSub, ...
 269                 $realBodyAttribs = [ 'id' => 'mw-content-text' ];
 270
 271                 # Add a mw-content-ltr/rtl class to be able to style based on text direction
 272                 # when the content is different from the UI language, i.e.:
 273                 # not for special pages or file pages AND only when viewing
 274                 if ( !in_array( $title->getNamespace(), [ NS_SPECIAL, NS_FILE ] ) &&
 275                         Action::getActionName( $this ) === 'view' ) {
 276                         $pageLang = $title->getPageViewLanguage();
 277                         $realBodyAttribs['lang'] = $pageLang->getHtmlCode();
 278                         $realBodyAttribs['dir'] = $pageLang->getDir();
 279                         $realBodyAttribs['class'] = 'mw-content-' . $pageLang->getDir();
 280                 }
 281
 282                 return Html::rawElement( 'div', $realBodyAttribs, $html );
 283         }
 284
 285         /**
 286          * initialize various variables and generate the template
 287          *
 288          * @since 1.23
 289          * @return QuickTemplate The template to be executed by outputPage
 290          */
 291         protected function prepareQuickTemplate() {
 292                 global $wgContLang, $wgScript, $wgStylePath, $wgMimeType, $wgJsMimeType,
 293                         $wgSitename, $wgLogo, $wgMaxCredits,
 294                         $wgShowCreditsIfMax, $wgArticlePath,
 295                         $wgScriptPath, $wgServer;
 296
 297                 $title = $this->getTitle();
 298                 $request = $this->getRequest();
 299                 $out = $this->getOutput();
 300                 $tpl = $this->setupTemplateForOutput();
 301
 302                 $tpl->set( 'title', $out->getPageTitle() );
 303                 $tpl->set( 'pagetitle', $out->getHTMLTitle() );
 304                 $tpl->set( 'displaytitle', $out->mPageLinkTitle );
 305
 306                 $tpl->setRef( 'thispage', $this->thispage );
 307                 $tpl->setRef( 'titleprefixeddbkey', $this->thispage );
 308                 $tpl->set( 'titletext', $title->getText() );
 309                 $tpl->set( 'articleid', $title->getArticleID() );
 310
 311                 $tpl->set( 'isarticle', $out->isArticle() );
 312
 313                 $subpagestr = $this->subPageSubtitle();
 314                 if ( $subpagestr !== '' ) {
 315                         $subpagestr = '<span class="subpages">' . $subpagestr . '</span>';
 316                 }
 317                 $tpl->set( 'subtitle', $subpagestr . $out->getSubtitle() );
 318
 319                 $undelete = $this->getUndeleteLink();
 320                 if ( $undelete === '' ) {
 321                         $tpl->set( 'undelete', '' );
 322                 } else {
 323                         $tpl->set( 'undelete', '<span class="subpages">' . $undelete . '</span>' );
 324                 }
 325
 326                 $tpl->set( 'catlinks', $this->getCategories() );
 327                 if ( $out->isSyndicated() ) {
 328                         $feeds = [];
 329                         foreach ( $out->getSyndicationLinks() as $format => $link ) {
 330                                 $feeds[$format] = [
 331                                         // Messages: feed-atom, feed-rss
 332                                         'text' => $this->msg( "feed-$format" )->text(),
 333                                         'href' => $link
 334                                 ];
 335                         }
 336                         $tpl->setRef( 'feeds', $feeds );
 337                 } else {
 338                         $tpl->set( 'feeds', false );
 339                 }
 340
 341                 $tpl->setRef( 'mimetype', $wgMimeType );
 342                 $tpl->setRef( 'jsmimetype', $wgJsMimeType );
 343                 $tpl->set( 'charset', 'UTF-8' );
 344                 $tpl->setRef( 'wgScript', $wgScript );
 345                 $tpl->setRef( 'skinname', $this->skinname );
 346                 $tpl->set( 'skinclass', get_class( $this ) );
 347                 $tpl->setRef( 'skin', $this );
 348                 $tpl->setRef( 'stylename', $this->stylename );
 349                 $tpl->set( 'printable', $out->isPrintable() );
 350                 $tpl->set( 'handheld', $request->getBool( 'handheld' ) );
 351                 $tpl->setRef( 'loggedin', $this->loggedin );
 352                 $tpl->set( 'notspecialpage', !$title->isSpecialPage() );
 353                 $tpl->set( 'searchaction', $this->escapeSearchLink() );
 354                 $tpl->set( 'searchtitle', SpecialPage::getTitleFor( 'Search' )->getPrefixedDBkey() );
 355                 $tpl->set( 'search', trim( $request->getVal( 'search' ) ) );
 356                 $tpl->setRef( 'stylepath', $wgStylePath );
 357                 $tpl->setRef( 'articlepath', $wgArticlePath );
 358                 $tpl->setRef( 'scriptpath', $wgScriptPath );
 359                 $tpl->setRef( 'serverurl', $wgServer );
 360                 $tpl->setRef( 'logopath', $wgLogo );
 361                 $tpl->setRef( 'sitename', $wgSitename );
 362
 363                 $userLang = $this->getLanguage();
 364                 $userLangCode = $userLang->getHtmlCode();
 365                 $userLangDir = $userLang->getDir();
 366
 367                 $tpl->set( 'lang', $userLangCode );
 368                 $tpl->set( 'dir', $userLangDir );
 369                 $tpl->set( 'rtl', $userLang->isRTL() );
 370
 371                 $tpl->set( 'capitalizeallnouns', $userLang->capitalizeAllNouns() ? ' capitalize-all-nouns' : '' );
 372                 $tpl->set( 'showjumplinks', true ); // showjumplinks preference has been removed
 373                 $tpl->set( 'username', $this->loggedin ? $this->username : null );
 374                 $tpl->setRef( 'userpage', $this->userpage );
 375                 $tpl->setRef( 'userpageurl', $this->userpageUrlDetails['href'] );
 376                 $tpl->set( 'userlang', $userLangCode );
 377
 378                 // Users can have their language set differently than the
 379                 // content of the wiki. For these users, tell the web browser
 380                 // that interface elements are in a different language.
 381                 $tpl->set( 'userlangattributes', '' );
 382                 $tpl->set( 'specialpageattributes', '' ); # obsolete
 383                 // Used by VectorBeta to insert HTML before content but after the
 384                 // heading for the page title. Defaults to empty string.
 385                 $tpl->set( 'prebodyhtml', '' );
 386
 387                 if ( $userLangCode !== $wgContLang->getHtmlCode() || $userLangDir !== $wgContLang->getDir() ) {
 388                         $escUserlang = htmlspecialchars( $userLangCode );
 389                         $escUserdir = htmlspecialchars( $userLangDir );
 390                         // Attributes must be in double quotes because htmlspecialchars() doesn't
 391                         // escape single quotes
 392                         $attrs = " lang=\"$escUserlang\" dir=\"$escUserdir\"";
 393                         $tpl->set( 'userlangattributes', $attrs );
 394                 }
 395
 396                 $tpl->set( 'newtalk', $this->getNewtalks() );
 397                 $tpl->set( 'logo', $this->logoText() );
 398
 399                 $tpl->set( 'copyright', false );
 400                 // No longer used
 401                 $tpl->set( 'viewcount', false );
 402                 $tpl->set( 'lastmod', false );
 403                 $tpl->set( 'credits', false );
 404                 $tpl->set( 'numberofwatchingusers', false );
 405                 if ( $out->isArticle() && $title->exists() ) {
 406                         if ( $this->isRevisionCurrent() ) {
 407                                 if ( $wgMaxCredits != 0 ) {
 408                                         $tpl->set( 'credits', Action::factory( 'credits', $this->getWikiPage(),
 409                                                 $this->getContext() )->getCredits( $wgMaxCredits, $wgShowCreditsIfMax ) );
 410                                 } else {
 411                                         $tpl->set( 'lastmod', $this->lastModified() );
 412                                 }
 413                         }
 414                         $tpl->set( 'copyright', $this->getCopyright() );
 415                 }
 416
 417                 $tpl->set( 'copyrightico', $this->getCopyrightIcon() );
 418                 $tpl->set( 'poweredbyico', $this->getPoweredBy() );
 419                 $tpl->set( 'disclaimer', $this->disclaimerLink() );
 420                 $tpl->set( 'privacy', $this->privacyLink() );
 421                 $tpl->set( 'about', $this->aboutLink() );
 422
 423                 $tpl->set( 'footerlinks', [
 424                         'info' => [
 425                                 'lastmod',
 426                                 'numberofwatchingusers',
 427                                 'credits',
 428                                 'copyright',
 429                         ],
 430                         'places' => [
 431                                 'privacy',
 432                                 'about',
 433                                 'disclaimer',
 434                         ],
 435                 ] );
 436
 437                 global $wgFooterIcons;
 438                 $tpl->set( 'footericons', $wgFooterIcons );
 439                 foreach ( $tpl->data['footericons'] as $footerIconsKey => &$footerIconsBlock ) {
 440                         if ( count( $footerIconsBlock ) > 0 ) {
 441                                 foreach ( $footerIconsBlock as &$footerIcon ) {
 442                                         if ( isset( $footerIcon['src'] ) ) {
 443                                                 if ( !isset( $footerIcon['width'] ) ) {
 444                                                         $footerIcon['width'] = 88;
 445                                                 }
 446                                                 if ( !isset( $footerIcon['height'] ) ) {
 447                                                         $footerIcon['height'] = 31;
 448                                                 }
 449                                         }
 450                                 }
 451                         } else {
 452                                 unset( $tpl->data['footericons'][$footerIconsKey] );
 453                         }
 454                 }
 455
 456                 $tpl->set( 'indicators', $out->getIndicators() );
 457
 458                 $tpl->set( 'sitenotice', $this->getSiteNotice() );
 459                 $tpl->set( 'bottomscripts', $this->bottomScripts() );
 460                 $tpl->set( 'printfooter', $this->printSource() );
 461                 // Wrap the bodyText with #mw-content-text element
 462                 $out->mBodytext = $this->wrapHTML( $title, $out->mBodytext );
 463                 $tpl->setRef( 'bodytext', $out->mBodytext );
 464
 465                 $language_urls = $this->getLanguages();
 466                 if ( count( $language_urls ) ) {
 467                         $tpl->setRef( 'language_urls', $language_urls );
 468                 } else {
 469                         $tpl->set( 'language_urls', false );
 470                 }
 471
 472                 # Personal toolbar
 473                 $tpl->set( 'personal_urls', $this->buildPersonalUrls() );
 474                 $content_navigation = $this->buildContentNavigationUrls();
 475                 $content_actions = $this->buildContentActionUrls( $content_navigation );
 476                 $tpl->setRef( 'content_navigation', $content_navigation );
 477                 $tpl->setRef( 'content_actions', $content_actions );
 478
 479                 $tpl->set( 'sidebar', $this->buildSidebar() );
 480                 $tpl->set( 'nav_urls', $this->buildNavUrls() );
 481
 482                 // Set the head scripts near the end, in case the above actions resulted in added scripts
 483                 $tpl->set( 'headelement', $out->headElement( $this ) );
 484
 485                 $tpl->set( 'debug', '' );
 486                 $tpl->set( 'debughtml', $this->generateDebugHTML() );
 487                 $tpl->set( 'reporttime', wfReportTime() );
 488
 489                 // original version by hansm
 490                 if ( !Hooks::run( 'SkinTemplateOutputPageBeforeExec', [ &$this, &$tpl ] ) ) {
 491                         wfDebug( __METHOD__ . ": Hook SkinTemplateOutputPageBeforeExec broke outputPage execution!\n" );
 492                 }
 493
 494                 // Set the bodytext to another key so that skins can just output it on its own
 495                 // and output printfooter and debughtml separately
 496                 $tpl->set( 'bodycontent', $tpl->data['bodytext'] );
 497
 498                 // Append printfooter and debughtml onto bodytext so that skins that
 499                 // were already using bodytext before they were split out don't suddenly
 500                 // start not outputting information.
 501                 $tpl->data['bodytext'] .= Html::rawElement(
 502                         'div',
 503                         [ 'class' => 'printfooter' ],
 504                         "\n{$tpl->data['printfooter']}"
 505                 ) . "\n";
 506                 $tpl->data['bodytext'] .= $tpl->data['debughtml'];
 507
 508                 // allow extensions adding stuff after the page content.
 509                 // See Skin::afterContentHook() for further documentation.
 510                 $tpl->set( 'dataAfterContent', $this->afterContentHook() );
 511
 512                 return $tpl;
 513         }
 514
 515         /**
 516          * Get the HTML for the p-personal list
 517          * @return string
 518          */
 519         public function getPersonalToolsList() {
 520                 $tpl = $this->setupTemplateForOutput();
 521                 $tpl->set( 'personal_urls', $this->buildPersonalUrls() );
 522                 $html = '';
 523                 foreach ( $tpl->getPersonalTools() as $key => $item ) {
 524                         $html .= $tpl->makeListItem( $key, $item );
 525                 }
 526                 return $html;
 527         }
 528
 529         /**
 530          * Format language name for use in sidebar interlanguage links list.
 531          * By default it is capitalized.
 532          *
 533          * @param string $name Language name, e.g. "English" or "español"
 534          * @return string
 535          * @private
 536          */
 537         function formatLanguageName( $name ) {
 538                 return $this->getLanguage()->ucfirst( $name );
 539         }
 540
 541         /**
 542          * Output the string, or print error message if it's
 543          * an error object of the appropriate type.
 544          * For the base class, assume strings all around.
 545          *
 546          * @param string $str
 547          * @private
 548          */
 549         function printOrError( $str ) {
 550                 echo $str;
 551         }
 552
 553         /**
 554          * Output a boolean indicating if buildPersonalUrls should output separate
 555          * login and create account links or output a combined link
 556          * By default we simply return a global config setting that affects most skins
 557          * This is setup as a method so that like with $wgLogo and getLogo() a skin
 558          * can override this setting and always output one or the other if it has
 559          * a reason it can't output one of the two modes.
 560          * @return bool
 561          */
 562         function useCombinedLoginLink() {
 563                 global $wgUseCombinedLoginLink;
 564                 return $wgUseCombinedLoginLink;
 565         }
 566
 567         /**
 568          * build array of urls for personal toolbar
 569          * @return array
 570          */
 571         protected function buildPersonalUrls() {
 572                 $title = $this->getTitle();
 573                 $request = $this->getRequest();
 574                 $pageurl = $title->getLocalURL();
 575
 576                 /* set up the default links for the personal toolbar */
 577                 $personal_urls = [];
 578
 579                 # Due to bug 32276, if a user does not have read permissions,
 580                 # $this->getTitle() will just give Special:Badtitle, which is
 581                 # not especially useful as a returnto parameter. Use the title
 582                 # from the request instead, if there was one.
 583                 if ( $this->getUser()->isAllowed( 'read' ) ) {
 584                         $page = $this->getTitle();
 585                 } else {
 586                         $page = Title::newFromText( $request->getVal( 'title', '' ) );
 587                 }
 588                 $page = $request->getVal( 'returnto', $page );
 589                 $a = [];
 590                 if ( strval( $page ) !== '' ) {
 591                         $a['returnto'] = $page;
 592                         $query = $request->getVal( 'returntoquery', $this->thisquery );
 593                         if ( $query != '' ) {
 594                                 $a['returntoquery'] = $query;
 595                         }
 596                 }
 597
 598                 $returnto = wfArrayToCgi( $a );
 599                 if ( $this->loggedin ) {
 600                         $personal_urls['userpage'] = [
 601                                 'text' => $this->username,
 602                                 'href' => &$this->userpageUrlDetails['href'],
 603                                 'class' => $this->userpageUrlDetails['exists'] ? false : 'new',
 604                                 'active' => ( $this->userpageUrlDetails['href'] == $pageurl ),
 605                                 'dir' => 'auto'
 606                         ];
 607                         $usertalkUrlDetails = $this->makeTalkUrlDetails( $this->userpage );
 608                         $personal_urls['mytalk'] = [
 609                                 'text' => $this->msg( 'mytalk' )->text(),
 610                                 'href' => &$usertalkUrlDetails['href'],
 611                                 'class' => $usertalkUrlDetails['exists'] ? false : 'new',
 612                                 'active' => ( $usertalkUrlDetails['href'] == $pageurl )
 613                         ];
 614                         $href = self::makeSpecialUrl( 'Preferences' );
 615                         $personal_urls['preferences'] = [
 616                                 'text' => $this->msg( 'mypreferences' )->text(),
 617                                 'href' => $href,
 618                                 'active' => ( $href == $pageurl )
 619                         ];
 620
 621                         if ( $this->getUser()->isAllowed( 'viewmywatchlist' ) ) {
 622                                 $href = self::makeSpecialUrl( 'Watchlist' );
 623                                 $personal_urls['watchlist'] = [
 624                                         'text' => $this->msg( 'mywatchlist' )->text(),
 625                                         'href' => $href,
 626                                         'active' => ( $href == $pageurl )
 627                                 ];
 628                         }
 629
 630                         # We need to do an explicit check for Special:Contributions, as we
 631                         # have to match both the title, and the target, which could come
 632                         # from request values (Special:Contributions?target=Jimbo_Wales)
 633                         # or be specified in "sub page" form
 634                         # (Special:Contributions/Jimbo_Wales). The plot
 635                         # thickens, because the Title object is altered for special pages,
 636                         # so it doesn't contain the original alias-with-subpage.
 637                         $origTitle = Title::newFromText( $request->getText( 'title' ) );
 638                         if ( $origTitle instanceof Title && $origTitle->isSpecialPage() ) {
 639                                 list( $spName, $spPar ) = SpecialPageFactory::resolveAlias( $origTitle->getText() );
 640                                 $active = $spName == 'Contributions'
 641                                         && ( ( $spPar && $spPar == $this->username )
 642                                                 || $request->getText( 'target' ) == $this->username );
 643                         } else {
 644                                 $active = false;
 645                         }
 646
 647                         $href = self::makeSpecialUrlSubpage( 'Contributions', $this->username );
 648                         $personal_urls['mycontris'] = [
 649                                 'text' => $this->msg( 'mycontris' )->text(),
 650                                 'href' => $href,
 651                                 'active' => $active
 652                         ];
 653                         $personal_urls['logout'] = [
 654                                 'text' => $this->msg( 'pt-userlogout' )->text(),
 655                                 'href' => self::makeSpecialUrl( 'Userlogout',
 656                                         // userlogout link must always contain an & character, otherwise we might not be able
 657                                         // to detect a buggy precaching proxy (bug 17790)
 658                                         $title->isSpecial( 'Preferences' ) ? 'noreturnto' : $returnto
 659                                 ),
 660                                 'active' => false
 661                         ];
 662                 } else {
 663                         $useCombinedLoginLink = $this->useCombinedLoginLink();
 664                         $loginlink = $this->getUser()->isAllowed( 'createaccount' ) && $useCombinedLoginLink
 665                                 ? 'nav-login-createaccount'
 666                                 : 'pt-login';
 667
 668                         // TODO remove this after AuthManager is stable
 669                         global $wgDisableAuthManager;
 670                         if ( $wgDisableAuthManager ) {
 671                                 $is_signup = $request->getText( 'type' ) == 'signup';
 672                                 $login_url = [
 673                                         'text' => $this->msg( $loginlink )->text(),
 674                                         'href' => self::makeSpecialUrl( 'Userlogin', $returnto ),
 675                                         'active' => $title->isSpecial( 'Userlogin' )
 676                                                 && ( $loginlink == 'nav-login-createaccount' || !$is_signup ),
 677                                 ];
 678                                 $createaccount_url = [
 679                                         'text' => $this->msg( 'pt-createaccount' )->text(),
 680                                         'href' => self::makeSpecialUrl( 'Userlogin', "$returnto&type=signup" ),
 681                                         'active' => $title->isSpecial( 'Userlogin' ) && $is_signup,
 682                                 ];
 683                         } else {
 684                                 $login_url = [
 685                                         'text' => $this->msg( $loginlink )->text(),
 686                                         'href' => self::makeSpecialUrl( 'Userlogin', $returnto ),
 687                                         'active' => $title->isSpecial( 'Userlogin' ) ||
 688                                                 $title->isSpecial( 'CreateAccount' ) && $useCombinedLoginLink,
 689                                 ];
 690                                 $createaccount_url = [
 691                                         'text' => $this->msg( 'pt-createaccount' )->text(),
 692                                         'href' => self::makeSpecialUrl( 'CreateAccount', $returnto ),
 693                                         'active' => $title->isSpecial( 'CreateAccount' ),
 694                                 ];
 695                         }
 696
 697                         // No need to show Talk and Contributions to anons if they can't contribute!
 698                         if ( User::groupHasPermission( '*', 'edit' ) ) {
 699                                 // Because of caching, we can't link directly to the IP talk and
 700                                 // contributions pages. Instead we use the special page shortcuts
 701                                 // (which work correctly regardless of caching). This means we can't
 702                                 // determine whether these links are active or not, but since major
 703                                 // skins (MonoBook, Vector) don't use this information, it's not a
 704                                 // huge loss.
 705                                 $personal_urls['anontalk'] = [
 706                                         'text' => $this->msg( 'anontalk' )->text(),
 707                                         'href' => self::makeSpecialUrlSubpage( 'Mytalk', false ),
 708                                         'active' => false
 709                                 ];
 710                                 $personal_urls['anoncontribs'] = [
 711                                         'text' => $this->msg( 'anoncontribs' )->text(),
 712                                         'href' => self::makeSpecialUrlSubpage( 'Mycontributions', false ),
 713                                         'active' => false
 714                                 ];
 715                         }
 716
 717                         if ( $this->getUser()->isAllowed( 'createaccount' ) && !$useCombinedLoginLink ) {
 718                                 $personal_urls['createaccount'] = $createaccount_url;
 719                         }
 720
 721                         $personal_urls['login'] = $login_url;
 722                 }
 723
 724                 Hooks::run( 'PersonalUrls', [ &$personal_urls, &$title, $this ] );
 725                 return $personal_urls;
 726         }
 727
 728         /**
 729          * Builds an array with tab definition
 730          *
 731          * @param Title $title Page Where the tab links to
 732          * @param string|array $message Message key or an array of message keys (will fall back)
 733          * @param bool $selected Display the tab as selected
 734          * @param string $query Query string attached to tab URL
 735          * @param bool $checkEdit Check if $title exists and mark with .new if one doesn't
 736          *
 737          * @return array
 738          */
 739         function tabAction( $title, $message, $selected, $query = '', $checkEdit = false ) {
 740                 $classes = [];
 741                 if ( $selected ) {
 742                         $classes[] = 'selected';
 743                 }
 744                 if ( $checkEdit && !$title->isKnown() ) {
 745                         $classes[] = 'new';
 746                         if ( $query !== '' ) {
 747                                 $query = 'action=edit&redlink=1&' . $query;
 748                         } else {
 749                                 $query = 'action=edit&redlink=1';
 750                         }
 751                 }
 752
 753                 $linkClass = MediaWikiServices::getInstance()->getLinkRenderer()->getLinkClasses( $title );
 754
 755                 // wfMessageFallback will nicely accept $message as an array of fallbacks
 756                 // or just a single key
 757                 $msg = wfMessageFallback( $message )->setContext( $this->getContext() );
 758                 if ( is_array( $message ) ) {
 759                         // for hook compatibility just keep the last message name
 760                         $message = end( $message );
 761                 }
 762                 if ( $msg->exists() ) {
 763                         $text = $msg->text();
 764                 } else {
 765                         global $wgContLang;
 766                         $text = $wgContLang->getConverter()->convertNamespace(
 767                                 MWNamespace::getSubject( $title->getNamespace() ) );
 768                 }
 769
 770                 $result = [];
 771                 if ( !Hooks::run( 'SkinTemplateTabAction', [ &$this,
 772                                 $title, $message, $selected, $checkEdit,
 773                                 &$classes, &$query, &$text, &$result ] ) ) {
 774                         return $result;
 775                 }
 776
 777                 $result = [
 778                         'class' => implode( ' ', $classes ),
 779                         'text' => $text,
 780                         'href' => $title->getLocalURL( $query ),
 781                         'primary' => true ];
 782                 if ( $linkClass !== '' ) {
 783                         $result['link-class'] = $linkClass;
 784                 }
 785
 786                 return $result;
 787         }
 788
 789         function makeTalkUrlDetails( $name, $urlaction = '' ) {
 790                 $title = Title::newFromText( $name );
 791                 if ( !is_object( $title ) ) {
 792                         throw new MWException( __METHOD__ . " given invalid pagename $name" );
 793                 }
 794                 $title = $title->getTalkPage();
 795                 self::checkTitle( $title, $name );
 796                 return [
 797                         'href' => $title->getLocalURL( $urlaction ),
 798                         'exists' => $title->isKnown(),
 799                 ];
 800         }
 801
 802         /**
 803          * @todo is this even used?
 804          */
 805         function makeArticleUrlDetails( $name, $urlaction = '' ) {
 806                 $title = Title::newFromText( $name );
 807                 $title = $title->getSubjectPage();
 808                 self::checkTitle( $title, $name );
 809                 return [
 810                         'href' => $title->getLocalURL( $urlaction ),
 811                         'exists' => $title->exists(),
 812                 ];
 813         }
 814
 815         /**
 816          * a structured array of links usually used for the tabs in a skin
 817          *
 818          * There are 4 standard sections
 819          * namespaces: Used for namespace tabs like special, page, and talk namespaces
 820          * views: Used for primary page views like read, edit, history
 821          * actions: Used for most extra page actions like deletion, protection, etc...
 822          * variants: Used to list the language variants for the page
 823          *
 824          * Each section's value is a key/value array of links for that section.
 825          * The links themselves have these common keys:
 826          * - class: The css classes to apply to the tab
 827          * - text: The text to display on the tab
 828          * - href: The href for the tab to point to
 829          * - rel: An optional rel= for the tab's link
 830          * - redundant: If true the tab will be dropped in skins using content_actions
 831          *   this is useful for tabs like "Read" which only have meaning in skins that
 832          *   take special meaning from the grouped structure of content_navigation
 833          *
 834          * Views also have an extra key which can be used:
 835          * - primary: If this is not true skins like vector may try to hide the tab
 836          *            when the user has limited space in their browser window
 837          *
 838          * content_navigation using code also expects these ids to be present on the
 839          * links, however these are usually automatically generated by SkinTemplate
 840          * itself and are not necessary when using a hook. The only things these may
 841          * matter to are people modifying content_navigation after it's initial creation:
 842          * - id: A "preferred" id, most skins are best off outputting this preferred
 843          *   id for best compatibility.
 844          * - tooltiponly: This is set to true for some tabs in cases where the system
 845          *   believes that the accesskey should not be added to the tab.
 846          *
 847          * @return array
 848          */
 849         protected function buildContentNavigationUrls() {
 850                 global $wgDisableLangConversion;
 851
 852                 // Display tabs for the relevant title rather than always the title itself
 853                 $title = $this->getRelevantTitle();
 854                 $onPage = $title->equals( $this->getTitle() );
 855
 856                 $out = $this->getOutput();
 857                 $request = $this->getRequest();
 858                 $user = $this->getUser();
 859
 860                 $content_navigation = [
 861                         'namespaces' => [],
 862                         'views' => [],
 863                         'actions' => [],
 864                         'variants' => []
 865                 ];
 866
 867                 // parameters
 868                 $action = $request->getVal( 'action', 'view' );
 869
 870                 $userCanRead = $title->quickUserCan( 'read', $user );
 871
 872                 $preventActiveTabs = false;
 873                 Hooks::run( 'SkinTemplatePreventOtherActiveTabs', [ &$this, &$preventActiveTabs ] );
 874
 875                 // Checks if page is some kind of content
 876                 if ( $title->canExist() ) {
 877                         // Gets page objects for the related namespaces
 878                         $subjectPage = $title->getSubjectPage();
 879                         $talkPage = $title->getTalkPage();
 880
 881                         // Determines if this is a talk page
 882                         $isTalk = $title->isTalkPage();
 883
 884                         // Generates XML IDs from namespace names
 885                         $subjectId = $title->getNamespaceKey( '' );
 886
 887                         if ( $subjectId == 'main' ) {
 888                                 $talkId = 'talk';
 889                         } else {
 890                                 $talkId = "{$subjectId}_talk";
 891                         }
 892
 893                         $skname = $this->skinname;
 894
 895                         // Adds namespace links
 896                         $subjectMsg = [ "nstab-$subjectId" ];
 897                         if ( $subjectPage->isMainPage() ) {
 898                                 array_unshift( $subjectMsg, 'mainpage-nstab' );
 899                         }
 900                         $content_navigation['namespaces'][$subjectId] = $this->tabAction(
 901                                 $subjectPage, $subjectMsg, !$isTalk && !$preventActiveTabs, '', $userCanRead
 902                         );
 903                         $content_navigation['namespaces'][$subjectId]['context'] = 'subject';
 904                         $content_navigation['namespaces'][$talkId] = $this->tabAction(
 905                                 $talkPage, [ "nstab-$talkId", 'talk' ], $isTalk && !$preventActiveTabs, '', $userCanRead
 906                         );
 907                         $content_navigation['namespaces'][$talkId]['context'] = 'talk';
 908
 909                         if ( $userCanRead ) {
 910                                 $isForeignFile = $title->inNamespace( NS_FILE ) && $this->canUseWikiPage() &&
 911                                         $this->getWikiPage() instanceof WikiFilePage && !$this->getWikiPage()->isLocal();
 912
 913                                 // Adds view view link
 914                                 if ( $title->exists() || $isForeignFile ) {
 915                                         $content_navigation['views']['view'] = $this->tabAction(
 916                                                 $isTalk ? $talkPage : $subjectPage,
 917                                                 [ "$skname-view-view", 'view' ],
 918                                                 ( $onPage && ( $action == 'view' || $action == 'purge' ) ), '', true
 919                                         );
 920                                         // signal to hide this from simple content_actions
 921                                         $content_navigation['views']['view']['redundant'] = true;
 922                                 }
 923
 924                                 // If it is a non-local file, show a link to the file in its own repository
 925                                 if ( $isForeignFile ) {
 926                                         $file = $this->getWikiPage()->getFile();
 927                                         $content_navigation['views']['view-foreign'] = [
 928                                                 'class' => '',
 929                                                 'text' => wfMessageFallback( "$skname-view-foreign", 'view-foreign' )->
 930                                                         setContext( $this->getContext() )->
 931                                                         params( $file->getRepo()->getDisplayName() )->text(),
 932                                                 'href' => $file->getDescriptionUrl(),
 933                                                 'primary' => false,
 934                                         ];
 935                                 }
 936
 937                                 // Checks if user can edit the current page if it exists or create it otherwise
 938                                 if ( $title->quickUserCan( 'edit', $user )
 939                                         && ( $title->exists() || $title->quickUserCan( 'create', $user ) )
 940                                 ) {
 941                                         // Builds CSS class for talk page links
 942                                         $isTalkClass = $isTalk ? ' istalk' : '';
 943                                         // Whether the user is editing the page
 944                                         $isEditing = $onPage && ( $action == 'edit' || $action == 'submit' );
 945                                         // Whether to show the "Add a new section" tab
 946                                         // Checks if this is a current rev of talk page and is not forced to be hidden
 947                                         $showNewSection = !$out->forceHideNewSectionLink()
 948                                                 && ( ( $isTalk && $this->isRevisionCurrent() ) || $out->showNewSectionLink() );
 949                                         $section = $request->getVal( 'section' );
 950
 951                                         if ( $title->exists()
 952                                                 || ( $title->getNamespace() == NS_MEDIAWIKI
 953                                                         && $title->getDefaultMessageText() !== false
 954                                                 )
 955                                         ) {
 956                                                 $msgKey = $isForeignFile ? 'edit-local' : 'edit';
 957                                         } else {
 958                                                 $msgKey = $isForeignFile ? 'create-local' : 'create';
 959                                         }
 960                                         $content_navigation['views']['edit'] = [
 961                                                 'class' => ( $isEditing && ( $section !== 'new' || !$showNewSection )
 962                                                         ? 'selected'
 963                                                         : ''
 964                                                 ) . $isTalkClass,
 965                                                 'text' => wfMessageFallback( "$skname-view-$msgKey", $msgKey )
 966                                                         ->setContext( $this->getContext() )->text(),
 967                                                 'href' => $title->getLocalURL( $this->editUrlOptions() ),
 968                                                 'primary' => !$isForeignFile, // don't collapse this in vector
 969                                         ];
 970
 971                                         // section link
 972                                         if ( $showNewSection ) {
 973                                                 // Adds new section link
 974                                                 // $content_navigation['actions']['addsection']
 975                                                 $content_navigation['views']['addsection'] = [
 976                                                         'class' => ( $isEditing && $section == 'new' ) ? 'selected' : false,
 977                                                         'text' => wfMessageFallback( "$skname-action-addsection", 'addsection' )
 978                                                                 ->setContext( $this->getContext() )->text(),
 979                                                         'href' => $title->getLocalURL( 'action=edit&section=new' )
 980                                                 ];
 981                                         }
 982                                 // Checks if the page has some kind of viewable content
 983                                 } elseif ( $title->hasSourceText() ) {
 984                                         // Adds view source view link
 985                                         $content_navigation['views']['viewsource'] = [
 986                                                 'class' => ( $onPage && $action == 'edit' ) ? 'selected' : false,
 987                                                 'text' => wfMessageFallback( "$skname-action-viewsource", 'viewsource' )
 988                                                         ->setContext( $this->getContext() )->text(),
 989                                                 'href' => $title->getLocalURL( $this->editUrlOptions() ),
 990                                                 'primary' => true, // don't collapse this in vector
 991                                         ];
 992                                 }
 993
 994                                 // Checks if the page exists
 995                                 if ( $title->exists() ) {
 996                                         // Adds history view link
 997                                         $content_navigation['views']['history'] = [
 998                                                 'class' => ( $onPage && $action == 'history' ) ? 'selected' : false,
 999                                                 'text' => wfMessageFallback( "$skname-view-history", 'history_short' )
1000                                                         ->setContext( $this->getContext() )->text(),
1001                                                 'href' => $title->getLocalURL( 'action=history' ),
1002                                         ];
1003
1004                                         if ( $title->quickUserCan( 'delete', $user ) ) {
1005                                                 $content_navigation['actions']['delete'] = [
1006                                                         'class' => ( $onPage && $action == 'delete' ) ? 'selected' : false,
1007                                                         'text' => wfMessageFallback( "$skname-action-delete", 'delete' )
1008                                                                 ->setContext( $this->getContext() )->text(),
1009                                                         'href' => $title->getLocalURL( 'action=delete' )
1010                                                 ];
1011                                         }
1012
1013                                         if ( $title->quickUserCan( 'move', $user ) ) {
1014                                                 $moveTitle = SpecialPage::getTitleFor( 'Movepage', $title->getPrefixedDBkey() );
1015                                                 $content_navigation['actions']['move'] = [
1016                                                         'class' => $this->getTitle()->isSpecial( 'Movepage' ) ? 'selected' : false,
1017                                                         'text' => wfMessageFallback( "$skname-action-move", 'move' )
1018                                                                 ->setContext( $this->getContext() )->text(),
1019                                                         'href' => $moveTitle->getLocalURL()
1020                                                 ];
1021                                         }
1022                                 } else {
1023                                         // article doesn't exist or is deleted
1024                                         if ( $user->isAllowed( 'deletedhistory' ) ) {
1025                                                 $n = $title->isDeleted();
1026                                                 if ( $n ) {
1027                                                         $undelTitle = SpecialPage::getTitleFor( 'Undelete', $title->getPrefixedDBkey() );
1028                                                         // If the user can't undelete but can view deleted
1029                                                         // history show them a "View .. deleted" tab instead.
1030                                                         $msgKey = $user->isAllowed( 'undelete' ) ? 'undelete' : 'viewdeleted';
1031                                                         $content_navigation['actions']['undelete'] = [
1032                                                                 'class' => $this->getTitle()->isSpecial( 'Undelete' ) ? 'selected' : false,
1033                                                                 'text' => wfMessageFallback( "$skname-action-$msgKey", "{$msgKey}_short" )
1034                                                                         ->setContext( $this->getContext() )->numParams( $n )->text(),
1035                                                                 'href' => $undelTitle->getLocalURL()
1036                                                         ];
1037                                                 }
1038                                         }
1039                                 }
1040
1041                                 if ( $title->quickUserCan( 'protect', $user ) && $title->getRestrictionTypes() &&
1042                                         MWNamespace::getRestrictionLevels( $title->getNamespace(), $user ) !== [ '' ]
1043                                 ) {
1044                                         $mode = $title->isProtected() ? 'unprotect' : 'protect';
1045                                         $content_navigation['actions'][$mode] = [
1046                                                 'class' => ( $onPage && $action == $mode ) ? 'selected' : false,
1047                                                 'text' => wfMessageFallback( "$skname-action-$mode", $mode )
1048                                                         ->setContext( $this->getContext() )->text(),
1049                                                 'href' => $title->getLocalURL( "action=$mode" )
1050                                         ];
1051                                 }
1052
1053                                 // Checks if the user is logged in
1054                                 if ( $this->loggedin && $user->isAllowedAll( 'viewmywatchlist', 'editmywatchlist' ) ) {
1055                                         /**
1056                                          * The following actions use messages which, if made particular to
1057                                          * the any specific skins, would break the Ajax code which makes this
1058                                          * action happen entirely inline. OutputPage::getJSVars
1059                                          * defines a set of messages in a javascript object - and these
1060                                          * messages are assumed to be global for all skins. Without making
1061                                          * a change to that procedure these messages will have to remain as
1062                                          * the global versions.
1063                                          */
1064                                         $mode = $user->isWatched( $title ) ? 'unwatch' : 'watch';
1065                                         $content_navigation['actions'][$mode] = [
1066                                                 'class' => 'mw-watchlink ' . (
1067                                                         $onPage && ( $action == 'watch' || $action == 'unwatch' ) ? 'selected' : ''
1068                                                 ),
1069                                                 // uses 'watch' or 'unwatch' message
1070                                                 'text' => $this->msg( $mode )->text(),
1071                                                 'href' => $title->getLocalURL( [ 'action' => $mode ] )
1072                                         ];
1073                                 }
1074                         }
1075
1076                         Hooks::run( 'SkinTemplateNavigation', [ &$this, &$content_navigation ] );
1077
1078                         if ( $userCanRead && !$wgDisableLangConversion ) {
1079                                 $pageLang = $title->getPageLanguage();
1080                                 // Gets list of language variants
1081                                 $variants = $pageLang->getVariants();
1082                                 // Checks that language conversion is enabled and variants exist
1083                                 // And if it is not in the special namespace
1084                                 if ( count( $variants ) > 1 ) {
1085                                         // Gets preferred variant (note that user preference is
1086                                         // only possible for wiki content language variant)
1087                                         $preferred = $pageLang->getPreferredVariant();
1088                                         if ( Action::getActionName( $this ) === 'view' ) {
1089                                                 $params = $request->getQueryValues();
1090                                                 unset( $params['title'] );
1091                                         } else {
1092                                                 $params = [];
1093                                         }
1094                                         // Loops over each variant
1095                                         foreach ( $variants as $code ) {
1096                                                 // Gets variant name from language code
1097                                                 $varname = $pageLang->getVariantname( $code );
1098                                                 // Appends variant link
1099                                                 $content_navigation['variants'][] = [
1100                                                         'class' => ( $code == $preferred ) ? 'selected' : false,
1101                                                         'text' => $varname,
1102                                                         'href' => $title->getLocalURL( [ 'variant' => $code ] + $params ),
1103                                                         'lang' => wfBCP47( $code ),
1104                                                         'hreflang' => wfBCP47( $code ),
1105                                                 ];
1106                                         }
1107                                 }
1108                         }
1109                 } else {
1110                         // If it's not content, it's got to be a special page
1111                         $content_navigation['namespaces']['special'] = [
1112                                 'class' => 'selected',
1113                                 'text' => $this->msg( 'nstab-special' )->text(),
1114                                 'href' => $request->getRequestURL(), // @see: bug 2457, bug 2510
1115                                 'context' => 'subject'
1116                         ];
1117
1118                         Hooks::run( 'SkinTemplateNavigation::SpecialPage',
1119                                 [ &$this, &$content_navigation ] );
1120                 }
1121
1122                 // Equiv to SkinTemplateContentActions
1123                 Hooks::run( 'SkinTemplateNavigation::Universal', [ &$this, &$content_navigation ] );
1124
1125                 // Setup xml ids and tooltip info
1126                 foreach ( $content_navigation as $section => &$links ) {
1127                         foreach ( $links as $key => &$link ) {
1128                                 $xmlID = $key;
1129                                 if ( isset( $link['context'] ) && $link['context'] == 'subject' ) {
1130                                         $xmlID = 'ca-nstab-' . $xmlID;
1131                                 } elseif ( isset( $link['context'] ) && $link['context'] == 'talk' ) {
1132                                         $xmlID = 'ca-talk';
1133                                         $link['rel'] = 'discussion';
1134                                 } elseif ( $section == 'variants' ) {
1135                                         $xmlID = 'ca-varlang-' . $xmlID;
1136                                 } else {
1137                                         $xmlID = 'ca-' . $xmlID;
1138                                 }
1139                                 $link['id'] = $xmlID;
1140                         }
1141                 }
1142
1143                 # We don't want to give the watch tab an accesskey if the
1144                 # page is being edited, because that conflicts with the
1145                 # accesskey on the watch checkbox.  We also don't want to
1146                 # give the edit tab an accesskey, because that's fairly
1147                 # superfluous and conflicts with an accesskey (Ctrl-E) often
1148                 # used for editing in Safari.
1149                 if ( in_array( $action, [ 'edit', 'submit' ] ) ) {
1150                         if ( isset( $content_navigation['views']['edit'] ) ) {
1151                                 $content_navigation['views']['edit']['tooltiponly'] = true;
1152                         }
1153                         if ( isset( $content_navigation['actions']['watch'] ) ) {
1154                                 $content_navigation['actions']['watch']['tooltiponly'] = true;
1155                         }
1156                         if ( isset( $content_navigation['actions']['unwatch'] ) ) {
1157                                 $content_navigation['actions']['unwatch']['tooltiponly'] = true;
1158                         }
1159                 }
1160
1161                 return $content_navigation;
1162         }
1163
1164         /**
1165          * an array of edit links by default used for the tabs
1166          * @param array $content_navigation
1167          * @return array
1168          */
1169         private function buildContentActionUrls( $content_navigation ) {
1170
1171                 // content_actions has been replaced with content_navigation for backwards
1172                 // compatibility and also for skins that just want simple tabs content_actions
1173                 // is now built by flattening the content_navigation arrays into one
1174
1175                 $content_actions = [];
1176
1177                 foreach ( $content_navigation as $links ) {
1178                         foreach ( $links as $key => $value ) {
1179                                 if ( isset( $value['redundant'] ) && $value['redundant'] ) {
1180                                         // Redundant tabs are dropped from content_actions
1181                                         continue;
1182                                 }
1183
1184                                 // content_actions used to have ids built using the "ca-$key" pattern
1185                                 // so the xmlID based id is much closer to the actual $key that we want
1186                                 // for that reason we'll just strip out the ca- if present and use
1187                                 // the latter potion of the "id" as the $key
1188                                 if ( isset( $value['id'] ) && substr( $value['id'], 0, 3 ) == 'ca-' ) {
1189                                         $key = substr( $value['id'], 3 );
1190                                 }
1191
1192                                 if ( isset( $content_actions[$key] ) ) {
1193                                         wfDebug( __METHOD__ . ": Found a duplicate key for $key while flattening " .
1194                                                 "content_navigation into content_actions.\n" );
1195                                         continue;
1196                                 }
1197
1198                                 $content_actions[$key] = $value;
1199                         }
1200                 }
1201
1202                 return $content_actions;
1203         }
1204
1205         /**
1206          * build array of common navigation links
1207          * @return array
1208          */
1209         protected function buildNavUrls() {
1210                 global $wgUploadNavigationUrl;
1211
1212                 $out = $this->getOutput();
1213                 $request = $this->getRequest();
1214
1215                 $nav_urls = [];
1216                 $nav_urls['mainpage'] = [ 'href' => self::makeMainPageUrl() ];
1217                 if ( $wgUploadNavigationUrl ) {
1218                         $nav_urls['upload'] = [ 'href' => $wgUploadNavigationUrl ];
1219                 } elseif ( UploadBase::isEnabled() && UploadBase::isAllowed( $this->getUser() ) === true ) {
1220                         $nav_urls['upload'] = [ 'href' => self::makeSpecialUrl( 'Upload' ) ];
1221                 } else {
1222                         $nav_urls['upload'] = false;
1223                 }
1224                 $nav_urls['specialpages'] = [ 'href' => self::makeSpecialUrl( 'Specialpages' ) ];
1225
1226                 $nav_urls['print'] = false;
1227                 $nav_urls['permalink'] = false;
1228                 $nav_urls['info'] = false;
1229                 $nav_urls['whatlinkshere'] = false;
1230                 $nav_urls['recentchangeslinked'] = false;
1231                 $nav_urls['contributions'] = false;
1232                 $nav_urls['log'] = false;
1233                 $nav_urls['blockip'] = false;
1234                 $nav_urls['emailuser'] = false;
1235                 $nav_urls['userrights'] = false;
1236
1237                 // A print stylesheet is attached to all pages, but nobody ever
1238                 // figures that out. :)  Add a link...
1239                 if ( !$out->isPrintable() && ( $out->isArticle() || $this->getTitle()->isSpecialPage() ) ) {
1240                         $nav_urls['print'] = [
1241                                 'text' => $this->msg( 'printableversion' )->text(),
1242                                 'href' => $this->getTitle()->getLocalURL(
1243                                         $request->appendQueryValue( 'printable', 'yes' ) )
1244                         ];
1245                 }
1246
1247                 if ( $out->isArticle() ) {
1248                         // Also add a "permalink" while we're at it
1249                         $revid = $this->getRevisionId();
1250                         if ( $revid ) {
1251                                 $nav_urls['permalink'] = [
1252                                         'text' => $this->msg( 'permalink' )->text(),
1253                                         'href' => $this->getTitle()->getLocalURL( "oldid=$revid" )
1254                                 ];
1255                         }
1256
1257                         // Use the copy of revision ID in case this undocumented, shady hook tries to mess with internals
1258                         Hooks::run( 'SkinTemplateBuildNavUrlsNav_urlsAfterPermalink',
1259                                 [ &$this, &$nav_urls, &$revid, &$revid ] );
1260                 }
1261
1262                 if ( $out->isArticleRelated() ) {
1263                         $nav_urls['whatlinkshere'] = [
1264                                 'href' => SpecialPage::getTitleFor( 'Whatlinkshere', $this->thispage )->getLocalURL()
1265                         ];
1266
1267                         $nav_urls['info'] = [
1268                                 'text' => $this->msg( 'pageinfo-toolboxlink' )->text(),
1269                                 'href' => $this->getTitle()->getLocalURL( "action=info" )
1270                         ];
1271
1272                         if ( $this->getTitle()->exists() ) {
1273                                 $nav_urls['recentchangeslinked'] = [
1274                                         'href' => SpecialPage::getTitleFor( 'Recentchangeslinked', $this->thispage )->getLocalURL()
1275                                 ];
1276                         }
1277                 }
1278
1279                 $user = $this->getRelevantUser();
1280                 if ( $user ) {
1281                         $rootUser = $user->getName();
1282
1283                         $nav_urls['contributions'] = [
1284                                 'text' => $this->msg( 'contributions', $rootUser )->text(),
1285                                 'href' => self::makeSpecialUrlSubpage( 'Contributions', $rootUser ),
1286                                 'tooltip-params' => [ $rootUser ],
1287                         ];
1288
1289                         $nav_urls['log'] = [
1290                                 'href' => self::makeSpecialUrlSubpage( 'Log', $rootUser )
1291                         ];
1292
1293                         if ( $this->getUser()->isAllowed( 'block' ) ) {
1294                                 $nav_urls['blockip'] = [
1295                                         'text' => $this->msg( 'blockip', $rootUser )->text(),
1296                                         'href' => self::makeSpecialUrlSubpage( 'Block', $rootUser )
1297                                 ];
1298                         }
1299
1300                         if ( $this->showEmailUser( $user ) ) {
1301                                 $nav_urls['emailuser'] = [
1302                                         'href' => self::makeSpecialUrlSubpage( 'Emailuser', $rootUser ),
1303                                         'tooltip-params' => [ $rootUser ],
1304                                 ];
1305                         }
1306
1307                         if ( !$user->isAnon() ) {
1308                                 $sur = new UserrightsPage;
1309                                 $sur->setContext( $this->getContext() );
1310                                 if ( $sur->userCanExecute( $this->getUser() ) ) {
1311                                         $nav_urls['userrights'] = [
1312                                                 'href' => self::makeSpecialUrlSubpage( 'Userrights', $rootUser )
1313                                         ];
1314                                 }
1315                         }
1316                 }
1317
1318                 return $nav_urls;
1319         }
1320
1321         /**
1322          * Generate strings used for xml 'id' names
1323          * @return string
1324          */
1325         protected function getNameSpaceKey() {
1326                 return $this->getTitle()->getNamespaceKey();
1327         }
1328 }