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