Merge "Add new topics subscription button in Minerva"

extension.json

@@ -90,6 +90,7 @@
 			],
 			"dependencies": [
 				"ext.discussionTools.init.styles",
+				"ext.discussionTools.minervaicons",
 				"web2017-polyfills",
 				"moment",
 				"rangefix",
@@ -159,6 +160,16 @@
 				"mobile"
 			]
 		},
+		"ext.discussionTools.minervaicons": {
+			"selectorWithoutVariant": ".mw-ui-icon-minerva-{name}:before",
+			"useDataURI": false,
+			"defaultColor": "#54595d",
+			"class": "ResourceLoaderOOUIIconPackModule",
+			"icons": [
+				"bell",
+				"bellOutline"
+			]
+		},
 		"ext.discussionTools.debug": {
 			"packageFiles": [
 				"dt.debug.js",
@@ -421,6 +432,7 @@
 		"GetActionName": "page",
 		"OutputPageBeforeHTML": "page",
 		"OutputPageParserOutput": "page",
+		"SidebarBeforeOutput": "page",
 		"SkinTemplateNavigation::Universal": "page",
 		"TitleGetEditNotices": "page",
 		"ResourceLoaderGetConfigVars": "resourceloader",

includes/Hooks/PageHooks.php

@@ -23,10 +23,12 @@ use MediaWiki\Extension\VisualEditor\Hooks as VisualEditorHooks;
 use MediaWiki\Hook\BeforePageDisplayHook;
 use MediaWiki\Hook\OutputPageBeforeHTMLHook;
 use MediaWiki\Hook\OutputPageParserOutputHook;
+use MediaWiki\Hook\SidebarBeforeOutputHook;
 use MediaWiki\Hook\SkinTemplateNavigation__UniversalHook;
 use MediaWiki\Hook\TitleGetEditNoticesHook;
 use MediaWiki\MediaWikiServices;
 use MediaWiki\Page\Hook\BeforeDisplayNoArticleTextHook;
+use MediaWiki\User\UserIdentity;
 use MediaWiki\User\UserNameUtils;
 use MediaWiki\User\UserOptionsLookup;
 use OOUI\ButtonWidget;
@@ -46,6 +48,7 @@ class PageHooks implements
 	GetActionNameHook,
 	OutputPageBeforeHTMLHook,
 	OutputPageParserOutputHook,
+	SidebarBeforeOutputHook,
 	SkinTemplateNavigation__UniversalHook,
 	TitleGetEditNoticesHook
 {
@@ -532,6 +535,29 @@ class PageHooks implements
 		return $wrapped;
 	}
 
+	/**
+	 * @param Skin $skin
+	 * @param array &$sidebar
+	 */
+	public function onSidebarBeforeOutput( $skin, &$sidebar ): void {
+		$output = $skin->getOutput();
+		if (
+			$skin->getSkinName() === 'minerva' &&
+			HookUtils::isFeatureEnabledForOutput( $output, HookUtils::TOPICSUBSCRIPTION )
+		) {
+			$button = $this->getNewTopicsSubscriptionButton(
+				$skin->getUser(),
+				$skin->getTitle(),
+				$skin->getContext()
+			);
+			$sidebar['TOOLBOX']['t-page-subscribe'] = [
+				'icon' => $button['icon'],
+				'text' => $button['label'],
+				'href' => '#',
+			];
+		}
+	}
+
 	/**
 	 * @param SkinTemplate $sktemplate
 	 * @param array &$links
@@ -541,32 +567,55 @@ class PageHooks implements
 	public function onSkinTemplateNavigation__Universal( $sktemplate, &$links ): void {
 		$output = $sktemplate->getOutput();
 		if ( HookUtils::isFeatureEnabledForOutput( $output, HookUtils::TOPICSUBSCRIPTION ) ) {
-			$user = $sktemplate->getUser();
-			$title = $sktemplate->getTitle();
-			$items = $this->subscriptionStore->getSubscriptionItemsForUser(
-				$user,
-				[ CommentUtils::getNewTopicsSubscriptionId( $title ) ]
+			$button = $this->getNewTopicsSubscriptionButton(
+				$sktemplate->getUser(),
+				$sktemplate->getTitle(),
+				$sktemplate->getContext()
 			);
-			$subscriptionItem = count( $items ) ? $items[ 0 ] : null;
-			$isSubscribed = $subscriptionItem && !$subscriptionItem->isMuted();
 
-			$context = $sktemplate->getContext();
 			$links['actions']['dt-page-subscribe'] = [
-				'text' => $context->msg( $isSubscribed ?
-					'discussiontools-newtopicssubscription-button-unsubscribe-label' :
-					'discussiontools-newtopicssubscription-button-subscribe-label'
-				),
-				'title' => $context->msg( $isSubscribed ?
-					'discussiontools-newtopicssubscription-button-unsubscribe-tooltip' :
-					'discussiontools-newtopicssubscription-button-subscribe-tooltip'
-				),
-				'data-mw-subscribed' => $isSubscribed ? '1' : '0',
-				// TODO: Provide a no-JS action?
-				'href' => '#',
+				'text' => $button['label'],
+				'title' => $button['tooltip'],
+				'data-mw-subscribed' => $button['isSubscribed'] ? '1' : '0',
+				'href' => $button['href'],
 			];
 		}
 	}
 
+	/**
+	 * Get data from a new topics subcription button
+	 *
+	 * @param UserIdentity $user User
+	 * @param Title $title Title
+	 * @param IContextSource $context Context
+	 * @return array Array containing label, tooltip, icon, isSubscribed and href.
+	 */
+	private function getNewTopicsSubscriptionButton(
+		UserIdentity $user, Title $title, IContextSource $context
+	): array {
+		$items = $this->subscriptionStore->getSubscriptionItemsForUser(
+			$user,
+			[ CommentUtils::getNewTopicsSubscriptionId( $title ) ]
+		);
+		$subscriptionItem = count( $items ) ? $items[ 0 ] : null;
+		$isSubscribed = $subscriptionItem && !$subscriptionItem->isMuted();
+
+		return [
+			'label' => $context->msg( $isSubscribed ?
+				'discussiontools-newtopicssubscription-button-unsubscribe-label' :
+				'discussiontools-newtopicssubscription-button-subscribe-label'
+			)->text(),
+			'tooltip' => $context->msg( $isSubscribed ?
+				'discussiontools-newtopicssubscription-button-unsubscribe-tooltip' :
+				'discussiontools-newtopicssubscription-button-subscribe-tooltip'
+			)->text(),
+			'icon' => $isSubscribed ? 'bell' : 'bellOutline',
+			'isSubscribed' => $isSubscribed,
+			// TODO: Provide a no-JS action?
+			'href' => '#',
+		];
+	}
+
 	/**
 	 * @param Title $title Title object for the page the edit notices are for
 	 * @param int $oldid Revision ID that the edit notices are for (or 0 for latest)

modules/topicsubscriptions.js

@@ -222,9 +222,24 @@ function initTopicSubscriptions( $container, threadItemSet ) {
 
 	// New topics subscription button
 	( function () {
-		// eslint-disable-next-line no-jquery/no-global-selector
-		var $button = $( '#ca-dt-page-subscribe > a' );
-		var $label = $button.find( 'span' );
+		var $button, $label, $icon;
+
+		if ( mw.config.get( 'skin' ) === 'minerva' ) {
+			// eslint-disable-next-line no-jquery/no-global-selector
+			$button = $( '.menu__item--page-actions-overflow-t-page-subscribe' );
+			$label = $button.find( '.toggle-list-item__label' );
+			$icon = $button.find( '.mw-ui-icon' );
+			// HACK: We can't set data-mw-subscribed intially in Minerva, so work it out from the icon
+			// eslint-disable-next-line no-jquery/no-class-state
+			var initialState = $icon.hasClass( 'mw-ui-icon-minerva-bell' ) ? STATE_SUBSCRIBED : STATE_UNSUBSCRIBED;
+			$button.attr( 'data-mw-subscribed', String( initialState ) );
+		} else {
+			// eslint-disable-next-line no-jquery/no-global-selector
+			$button = $( '#ca-dt-page-subscribe > a' );
+			$label = $button.find( 'span' );
+			$icon = $( [] );
+		}
+
 		var titleObj = mw.Title.newFromText( mw.config.get( 'wgRelevantPageName' ) );
 		var name = utils.getNewTopicsSubscriptionId( titleObj );
 
@@ -236,6 +251,8 @@ function initTopicSubscriptions( $container, threadItemSet ) {
 			changeSubscription( titleObj.getPrefixedText(), name, !subscribedState, true )
 				.then( function ( result ) {
 					updateSubscribeLink( $button[ 0 ], result.subscribe ? STATE_SUBSCRIBED : STATE_UNSUBSCRIBED, $label[ 0 ], true );
+					$icon.toggleClass( 'mw-ui-icon-minerva-bell', !!result.subscribe );
+					$icon.toggleClass( 'mw-ui-icon-minerva-bellOutline', !result.subscribe );
 				} );
 		} );
 	}() );