Merge "Add protection indicators to mediawiki/core"

RELEASE-NOTES-1.43

@@ -34,6 +34,8 @@ For notes on 1.42.x and older releases, see HISTORY.
  More information: https://www.mediawiki.org/wiki/Heading_HTML_changes
  In a future release the new markup will become the default,
  and later this option will be removed.
+* (T12347) $wgEnableProtectionIndicators - Defaults to false, setting it to true
+ shows a lock icon indicator on protected pages.
 * …
 
 ==== Changed configuration ====

docs/config-schema.yaml

@@ -8066,3 +8066,9 @@ config-schema:
  Whether to display a confirmation screen during user log out.
  @unstable Temporary feature flag, T357484
  @since 1.42
+ EnableProtectionIndicators:
+ default: false
+ type: boolean
+ description: |-
+ Whether to show indicators on a page when it is protected.
+ @since 1.43

docs/config-vars.php

@@ -4452,3 +4452,9 @@
  * @see MediaWiki\MainConfigSchema::ShowLogoutConfirmation
  */
 $wgShowLogoutConfirmation = null;
+
+/**
+ * Config variable stub for the EnableProtectionIndicators setting, for use by phpdoc and IDEs.
+ * @see MediaWiki\MainConfigSchema::EnableProtectionIndicators
+ */
+$wgEnableProtectionIndicators = null;

includes/MainConfigNames.php

@@ -4468,4 +4468,10 @@ class MainConfigNames {
  */
  public const ShowLogoutConfirmation = 'ShowLogoutConfirmation';
 
+ /**
+ * Name constant for the EnableProtectionIndicators setting, for use with Config::get()
+ * @see MainConfigSchema::EnableProtectionIndicators
+ */
+ public const EnableProtectionIndicators = 'EnableProtectionIndicators';
+
 }

includes/MainConfigSchema.php

@@ -12899,6 +12899,16 @@ public static function getDefaultReadOnlyFile( $uploadDirectory ): string {
  'default' => false,
  'type' => 'boolean',
  ];
+
+ /**
+ * Whether to show indicators on a page when it is protected.
+ *
+ * @since 1.43
+ */
+ public const EnableProtectionIndicators = [
+ 'default' => false,
+ 'type' => 'boolean',
+ ];
  // endregion -- End Miscellaneous
 
 }

includes/config-schema.php

@@ -2535,6 +2535,7 @@
  'EditRecoveryExpiry' => 2592000,
  'UseCodexSpecialBlock' => false,
  'ShowLogoutConfirmation' => false,
+ 'EnableProtectionIndicators' => false,
  ],
  'type' => [
  'ConfigRegistry' => 'object',
@@ -3013,6 +3014,7 @@
  'EditRecoveryExpiry' => 'integer',
  'UseCodexSpecialBlock' => 'boolean',
  'ShowLogoutConfirmation' => 'boolean',
+ 'EnableProtectionIndicators' => 'boolean',
  ],
  'mergeStrategy' => [
  'TiffThumbnailType' => 'replace',

includes/page/Article.php

@@ -40,6 +40,7 @@
 use MediaWiki\Parser\ParserOutput;
 use MediaWiki\Permissions\Authority;
 use MediaWiki\Permissions\PermissionStatus;
+use MediaWiki\Permissions\RestrictionStore;
 use MediaWiki\Revision\ArchivedRevisionLookup;
 use MediaWiki\Revision\BadRevisionException;
 use MediaWiki\Revision\RevisionRecord;
@@ -123,6 +124,8 @@ class Article implements Page {
  protected IConnectionProvider $dbProvider;
  protected DatabaseBlockStore $blockStore;
 
+ protected RestrictionStore $restrictionStore;
+
  /**
  * @var RevisionRecord|null Revision to be shown
  *
@@ -150,6 +153,7 @@ public function __construct( Title $title, $oldId = null ) {
  $this->archivedRevisionLookup = $services->getArchivedRevisionLookup();
  $this->dbProvider = $services->getConnectionProvider();
  $this->blockStore = $services->getDatabaseBlockStore();
+ $this->restrictionStore = $services->getRestrictionStore();
  }
 
  /**
@@ -481,6 +485,8 @@ public function view() {
  return;
  }
 
+ $this->showProtectionIndicator();
+
  # Set page title (may be overridden from ParserOutput if title conversion is enabled or DISPLAYTITLE is used)
  $outputPage->setPageTitle( Parser::formatPageTitle(
  str_replace( '_', ' ', $this->getTitle()->getNsText() ),
@@ -582,6 +588,89 @@ public function view() {
  }
  }
 
+ /**
+ * Show a lock icon above the article body if the page is protected.
+ */
+ public function showProtectionIndicator(): void {
+ $title = $this->getTitle();
+ $context = $this->getContext();
+ $outputPage = $context->getOutput();
+
+ $protectionIndicatorsAreEnabled = $context->getConfig()
+ ->get( MainConfigNames::EnableProtectionIndicators );
+
+ if ( !$protectionIndicatorsAreEnabled || $title->isMainPage() ) {
+ return;
+ }
+
+ $protection = $this->restrictionStore->getRestrictions( $title, 'edit' );
+
+ $cascadeProtection = $this->restrictionStore->getCascadeProtectionSources( $title )[1];
+
+ $isCascadeProtected = array_key_exists( 'edit', $cascadeProtection );
+
+ if ( !$protection && !$isCascadeProtected ) {
+ return;
+ }
+
+ if ( $isCascadeProtected ) {
+ // Cascade-protected pages are protected at the sysop level. So it
+ // should not matter if we take the protection level of the first
+ // or last page that is being cascaded to the current page.
+ $protectionLevel = $cascadeProtection['edit'][0];
+ } else {
+ $protectionLevel = $protection[0];
+ }
+
+ // Protection levels are stored in the database as plain text, but
+ // they are expected to be valid protection levels. So we should be able to
+ // safely use them. However phan thinks this could be a XSS problem so we
+ // are being paranoid and escaping them once more.
+ $protectionLevel = htmlspecialchars( $protectionLevel );
+
+ $protectionExpiry = $this->restrictionStore->getRestrictionExpiry( $title, 'edit' );
+ $formattedProtectionExpiry = $context->getLanguage()
+ ->formatExpiry( $protectionExpiry ?? '' );
+
+ $protectionMsg = 'protection-indicator-title';
+ if ( $protectionExpiry === 'infinity' || !$protectionExpiry ) {
+ $protectionMsg .= '-infinity';
+ }
+
+ // Potential values: 'protection-sysop', 'protection-autoconfirmed',
+ // 'protection-sysop-cascade' etc.
+ // If the wiki has more protection levels, the additional ids that get
+ // added take the form 'protection-<protectionLevel>' and
+ // 'protection-<protectionLevel>-cascade'.
+ $protectionIndicatorId = 'protection-' . $protectionLevel;
+ $protectionIndicatorId .= ( $isCascadeProtected ? '-cascade' : '' );
+
+ // Messages 'protection-indicator-title', 'protection-indicator-title-infinity'
+ $protectionMsg = $outputPage->msg( $protectionMsg, $protectionLevel, $formattedProtectionExpiry )->text();
+
+ // Use a trick similar to the one used in Action::addHelpLink() to allow wikis
+ // to customize where the help link points to.
+ $protectionHelpLink = $outputPage->msg( $protectionIndicatorId . '-helppage' );
+ if ( $protectionHelpLink->isDisabled() ) {
+ $protectionHelpLink = 'https://mediawiki.org/wiki/Special:MyLanguage/Help:Protection';
+ } else {
+ $protectionHelpLink = $protectionHelpLink->text();
+ }
+
+ $outputPage->setIndicators( [
+ $protectionIndicatorId => Html::rawElement( 'a', [
+ 'class' => 'mw-protection-indicator-icon--lock',
+ 'title' => $protectionMsg,
+ 'href' => $protectionHelpLink
+ ],
+ // Screen reader-only text describing the same thing as
+ // was mentioned in the title attribute.
+ Html::element( 'span', [], $protectionMsg ) )
+ ] );
+
+ $outputPage->addModuleStyles( 'mediawiki.protectionIndicators.styles' );
+ }
+
  /**
  * Determines the desired ParserOutput and passes it to $outputPage.
  *

languages/i18n/en.json

@@ -314,6 +314,8 @@
  "querypage-no-updates": "Updates for this page are currently disabled.\nData here will not presently be refreshed.",
  "querypage-updates-periodical": "Updates for this page are run periodically.",
  "viewsource": "View source",
+ "protection-indicator-title-infinity": "This page is protected so that only users with the \"$1\" permission can edit it.",
+ "protection-indicator-title": "This page is protected so that only users with the \"$1\" permission can edit it until $2.",
  "skin-action-viewsource": "View source",
  "viewsource-title": "View source for $1",
  "actionthrottled": "Action throttled",

languages/i18n/qqq.json

@@ -576,6 +576,8 @@
  "querypage-no-updates": "Text on some special pages, e.g. [[Special:FewestRevisions]].",
  "querypage-updates-periodical": "Text on some special pages which are configurated with a periodical run of a maintenance script.\n\nSee also {{msg-mw|querypage-no-updates}}.",
  "viewsource": "The text displayed in place of the {{msg-mw|Edit}} tab when the user has no permission to edit the page.\n\nSee also:\n* {{msg-mw|Viewsource}}\n* {{msg-mw|Accesskey-ca-viewsource}}\n* {{msg-mw|Tooltip-ca-viewsource}}\n{{Identical|View source}}",
+ "protection-indicator-title": "Title text displayed when hovering over a lock icon that indicates a page is protected. Parameters:\n* $1 - protection level (e.g. \"autoconfirmed\")\n* $2 - expiry date (e.g. \"19 May 2024\")",
+ "protection-indicator-title-infinity": "Title text displayed when hovering over a lock icon that indicates a page is protected indefinitely. Parameters:\n* $1 - protection level (e.g. \"autoconfirmed\")",
  "skin-action-viewsource": "{{Identical|viewsource}}",
  "viewsource-title": "Page title shown when trying to edit a protected page. Parameters:\n* $1 - the name of the page",
  "actionthrottled": "This is the title of an error page. Read it in combination with {{msg-mw|actionthrottledtext}}.",

resources/Resources.php

@@ -2310,6 +2310,9 @@
  'ipb-hardblock'
  ],
  ],
+ 'mediawiki.protectionIndicators.styles' => [
+ 'styles' => 'resources/src/mediawiki.protectionIndicators/styles.less',
+ ],
  'mediawiki.special.changeslist' => [
  'styles' => [
  'resources/src/mediawiki.special.changeslist/changeslist.less'

resources/src/mediawiki.protectionIndicators/styles.less

@@ -0,0 +1,12 @@
+@import 'mediawiki.skin.variables.less';
+@import 'mediawiki.mixins.less';
+
+.mw-protection-indicator-icon {
+ &--lock {
+ .cdx-mixin-css-icon( @cdx-icon-lock );
+
+ > span {
+ .mixin-screen-reader-text();
+ }
+ }
+}

tests/phpunit/includes/page/ArticleTest.php

@@ -226,4 +226,56 @@ public function testOutputIsCached() {
  $this->assertStringContainsString( 'Old Kittens', $article->getContext()->getOutput()->getHTML() );
  }
 
+ /**
+ * Ensure that protection indicators are shown when the page is protected.
+ * @covers \Article::showProtectionIndicator
+ */
+ public function testShowProtectionIndicator() {
+ $this->overrideConfigValue(
+ MainConfigNames::EnableProtectionIndicators,
+ true
+ );
+ $title = $this->getExistingTestPage()->getTitle();
+ $article = $this->newArticle( $title );
+
+ $wikiPage = new WikiPage( $title );
+ $cascade = false;
+ $wikiPage->doUpdateRestrictions( [
+ 'edit' => 'autoconfirmed',
+ ],
+ [ 'edit' => 'infinity' ],
+ $cascade,
+ 'Test reason',
+ $this->getTestSysop()->getUser()
+ );
+
+ $article->showProtectionIndicator();
+ $output = $article->getContext()->getOutput();
+ $this->assertArrayHasKey( 'protection-autoconfirmed', $output->getIndicators(), 'Protection indicators are shown when a page is protected' );
+
+ $templateTitle = Title::newFromText( 'CascadeProtectionTest', NS_TEMPLATE );
+ $this->editPage( $templateTitle, 'Some text here', 'Test', NS_TEMPLATE, $this->getTestSysop()->getUser() );
+ $articleTitle = $this->getExistingTestPage()->getTitle();
+ $this->editPage( $articleTitle, '{{CascadeProtectionTest}}', 'Test', NS_MAIN, $this->getTestSysop()->getUser() );
+ $wikiPage = new WikiPage( $articleTitle );
+ $cascade = true;
+ $wikiPage->doUpdateRestrictions( [
+ 'edit' => 'sysop',
+ ],
+ [ 'edit' => 'infinity' ],
+ $cascade,
+ 'Test reason',
+ $this->getTestSysop()->getUser()
+ );
+
+ $template = $this->newArticle( $templateTitle );
+
+ $template->showProtectionIndicator();
+ $output = $template->getContext()->getOutput();
+ $this->assertArrayHasKey(
+ 'protection-sysop-cascade',
+ $output->getIndicators(),
+ 'Protection indicators are shown when a page protected using cascade protection'
+ );
+ }
 }