wikimedia/mediawiki-extensions-DiscussionTools
1
0
Fork 0
mirror of https://gerrit.wikimedia.org/r/mediawiki/extensions/DiscussionTools synced 2024-09-23 18:38:18 +00:00
Code Issues Packages Projects Releases Wiki Activity

Merge "Implement getSubscribableHeading/isSubscribable in JS and use"

Browse source
This commit is contained in:
jenkins-bot 2021-12-20 21:49:03 +00:00 committed by Gerrit Code Review
parent 6c1550b66e be9a9aa2a9
commit 793c8e990e
3 changed files with 35 additions and 8 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

11
modules/CommentItem.js
View file

@ -42,6 +42,17 @@ CommentItem.prototype.getHeading = function () {
return parent;
};
/**
* @return {HeadingItem|null} losest heading that can be used for topic subscriptions
*/
CommentItem.prototype.getSubscribableHeading = function () {
var heading = this.getHeading();
while ( heading && heading.type === 'heading' && !heading.isSubscribable() ) {
heading = heading.parent;
}
return ( heading && heading.type === 'heading' ) ? heading : null;
};
// TODO: Implement getBodyRange/getBodyHTML/getBodyText/getMentions if required
module.exports = CommentItem;

18
modules/HeadingItem.js
View file

@ -45,4 +45,22 @@ HeadingItem.prototype.getHeading = function () {
return this;
};
/**
* Check whether this heading can be used for topic subscriptions.
*
* @return {boolean}
*/
HeadingItem.prototype.isSubscribable = function () {
return (
// Placeholder headings have nothing to attach the button to.
!this.placeholderHeading &&
// We only allow subscribing to level 2 headings, because the user interface for sub-headings
// would be difficult to present.
this.headingLevel === 2 &&
// Check if the name corresponds to a section that contain no comments (only sub-sections).
// They can't be distinguished from each other, so disallow subscribing.
this.name !== 'h-'
);
};
module.exports = HeadingItem;

14
modules/controller.js
View file

@ -8,7 +8,6 @@ var
storage = mw.storage.session,
Parser = require( './Parser.js' ),
ThreadItem = require( './ThreadItem.js' ),
HeadingItem = require( './HeadingItem.js' ),
CommentItem = require( './CommentItem.js' ),
CommentDetails = require( './CommentDetails.js' ),
ReplyLinksController = require( './ReplyLinksController.js' ),
@ -862,14 +861,13 @@ function init( $container, state ) {
}
}
}
for ( i = 0; i < recentComments.length; i++ ) {
var headingItem = recentComments[ i ].getHeading();
while ( headingItem instanceof HeadingItem && headingItem.headingLevel !== 2 ) {
headingItem = headingItem.parent;
recentComments.forEach( function ( recentComment ) {
var headingItem = recentComment.getSubscribableHeading();
if ( headingItem ) {
// Use names as object keys to deduplicate if there are multiple comments in a topic.
headingsToUpdate[ headingItem.name ] = headingItem;
}
// Use names as object keys to deduplicate if there are multiple comments in a topic.
headingsToUpdate[ headingItem.name ] = headingItem;
}
} );
updateSubscriptionStates( $container, headingsToUpdate );
}
} );