var lastHighlightedPublishedComment = null, CommentItem = require( './CommentItem.js' ), utils = require( './utils.js' ); /** * Draw a semi-transparent rectangle on the page to highlight the given comment. * * @class * @param {CommentItem|CommentItem[]} comments Comment item(s) to highlight */ function Highlight( comments ) { var highlightNodes = []; var ranges = []; this.topmostElement = null; comments = Array.isArray( comments ) ? comments : [ comments ]; this.rootNode = comments[ 0 ] ? comments[ 0 ].rootNode : null; comments.forEach( function ( comment ) { var $highlight = $( '
' ).addClass( 'ext-discussiontools-init-highlight' ); // We insert the highlight in the DOM near the comment, so that it remains positioned correctly // when it shifts (e.g. collapsing the table of contents), and disappears when it is hidden (e.g. // opening visual editor). var range = comment.getNativeRange(); // Support: Firefox, IE 11 // The highlight node must be inserted after the start marker node (data-mw-comment-start), not // before, otherwise Node#getBoundingClientRect() returns wrong results. range.insertNode( $highlight[ 0 ] ); // If the item is a top-level comment wrapped in a frame, highlight outside that frame if ( comment.level === 1 ) { var coveredSiblings = utils.getFullyCoveredSiblings( comment, comment.rootNode ); if ( coveredSiblings ) { range.setStartBefore( coveredSiblings[ 0 ] ); range.setEndAfter( coveredSiblings[ coveredSiblings.length - 1 ] ); } } // If the item is a heading, highlight the full extent of it (not only the text) if ( comment.type === 'heading' && !comment.placeholderHeading ) { range.selectNode( $highlight.closest( 'h1, h2, h3, h4, h5, h6' )[ 0 ] ); } ranges.push( range ); highlightNodes.push( $highlight[ 0 ] ); } ); this.ranges = ranges; this.$element = $( highlightNodes ); // Events this.updateDebounced = OO.ui.debounce( this.update.bind( this ), 500 ); window.addEventListener( 'resize', this.updateDebounced ); this.update(); } OO.initClass( Highlight ); /** * Update position of highlights, e.g. after window resize */ Highlight.prototype.update = function () { var highlight = this; this.$element.css( { 'margin-top': '', 'margin-left': '', 'margin-right': '', width: '', height: '' } ); var rootRect = this.rootNode.getBoundingClientRect(); this.topmostElement = null; var topmostTop = Infinity; this.ranges.forEach( function ( range, i ) { var $element = highlight.$element.eq( i ); var baseRect = $element[ 0 ].getBoundingClientRect(); var rect = RangeFix.getBoundingClientRect( range ); // rect may be null if the range is in a detached or hidden node if ( rect ) { // Draw the highlight over the full width of the page, except for very short comments // (less than 1/3 of the available width). // // This lets the far edges of almost all comments align nicely (T309444#7968858), // while still accurately highlighting comments in narrow floating boxes, such as // image captions or {{archive top}}. // // It seems difficult to distinguish the floating boxes from comments that are just // very short or very deeply indented, and this seems to work well enough in practice. var useFullWidth = rect.width > rootRect.width / 3; var top = rect.top - baseRect.top; var width = rect.width; var height = rect.height; var left, right; if ( $element.css( 'direction' ) === 'ltr' ) { left = rect.left - baseRect.left; if ( useFullWidth ) { width = rootRect.width - ( rect.left - rootRect.left ); } } else { right = ( baseRect.left + baseRect.width ) - ( rect.left + rect.width ); if ( useFullWidth ) { width = rootRect.width - ( ( rootRect.left + rootRect.width ) - ( rect.left + rect.width ) ); } } var padding = 5; $element.css( { 'margin-top': top - padding, 'margin-left': left !== undefined ? left - padding : '', 'margin-right': right !== undefined ? right - padding : '', width: width + ( padding * 2 ), height: height + ( padding * 2 ) } ); if ( rect.top < topmostTop ) { highlight.topmostElement = $element[ 0 ]; topmostTop = rect.top; } } } ); }; /** * Scroll the topmost comment into view */ Highlight.prototype.scrollIntoView = function () { if ( this.topmostElement ) { this.topmostElement.scrollIntoView(); } }; /** * Destroy the highlight */ Highlight.prototype.destroy = function () { this.$element.remove(); window.removeEventListener( 'resize', this.updateDebounced ); }; var highlightedTarget = null; var missingTargetNotifPromise = null; /** * Highlight the comment(s) on the page associated with the URL hash or query string * * @param {ThreadItemSet} threadItemSet * @param {boolean} [noScroll] Don't scroll to the topmost highlighted comment, e.g. on popstate */ function highlightTargetComment( threadItemSet, noScroll ) { if ( highlightedTarget ) { highlightedTarget.destroy(); highlightedTarget = null; } if ( missingTargetNotifPromise ) { missingTargetNotifPromise.then( function ( notif ) { notif.close(); } ); missingTargetNotifPromise = null; } var targetElement = getTargetFromFragment( location.hash.slice( 1 ) ); if ( targetElement && targetElement.hasAttribute( 'data-mw-comment-start' ) ) { var comment = threadItemSet.findCommentById( targetElement.getAttribute( 'id' ) ); if ( comment ) { highlightedTarget = new Highlight( comment ); highlightedTarget.$element.addClass( 'ext-discussiontools-init-targetcomment' ); highlightedTarget.$element.addClass( 'ext-discussiontools-init-highlight-fadein' ); } return; } if ( location.hash.match( /^#c-/ ) && !targetElement ) { missingTargetNotifPromise = mw.loader.using( 'mediawiki.notification' ).then( function () { return mw.notification.notify( mw.message( 'discussiontools-target-comment-missing' ).parse(), { type: 'warn', autoHide: false } ); } ); } var url = new URL( location.href ); highlightNewComments( threadItemSet, noScroll, url.searchParams.get( 'dtnewcomments' ) && url.searchParams.get( 'dtnewcomments' ).split( '|' ), url.searchParams.get( 'dtnewcommentssince' ), url.searchParams.get( 'dtinthread' ) ); } /** * Highlight a just-published comment/topic * * These highlights show for a short period of time then tear themselves down. * * @param {ThreadItemSet} threadItemSet Thread item set * @param {string} threadItemId Thread item ID (NEW_TOPIC_COMMENT_ID for the a new topic) */ function highlightPublishedComment( threadItemSet, threadItemId ) { var highlightComments = []; if ( threadItemId === utils.NEW_TOPIC_COMMENT_ID ) { // Highlight the last comment on the page var lastComment = threadItemSet.threadItems[ threadItemSet.threadItems.length - 1 ]; lastHighlightedPublishedComment = lastComment; highlightComments.push( lastComment ); // If it's the only comment under its heading, highlight the heading too. // (It might not be if the new discussion topic was posted without a title: T272666.) if ( lastComment.parent && lastComment.parent.type === 'heading' && lastComment.parent.replies.length === 1 ) { highlightComments.push( lastComment.parent ); lastHighlightedPublishedComment = lastComment.parent; // Change URL to point to this section, like the old section=new wikitext editor does. // This also expands collapsed sections on mobile (T301840). var sectionTitle = lastHighlightedPublishedComment.getLinkableTitle(); var urlFragment = mw.util.escapeIdForLink( sectionTitle ); // Navigate to fragment without scrolling location.hash = '#' + urlFragment + '-DoesNotExist-DiscussionToolsHack'; history.replaceState( null, '', '#' + urlFragment ); } } else { // Find the comment we replied to, then highlight the last reply var repliedToComment = threadItemSet.threadItemsById[ threadItemId ]; highlightComments.push( repliedToComment.replies[ repliedToComment.replies.length - 1 ] ); lastHighlightedPublishedComment = highlightComments[ 0 ]; } // We may have changed the location hash on mobile, so wait for that to cause // the section to expand before drawing the highlight. setTimeout( function () { var highlight = new Highlight( highlightComments ); highlight.$element.addClass( 'ext-discussiontools-init-publishedcomment' ); // Show a highlight with the same timing as the post-edit message (mediawiki.action.view.postEdit): // show for 3000ms, fade out for 250ms (animation duration is defined in CSS). OO.ui.Element.static.scrollIntoView( highlight.topmostElement, { padding: { // Add padding to avoid overlapping the post-edit notification (above on desktop, below on mobile) top: OO.ui.isMobile() ? 10 : 60, bottom: OO.ui.isMobile() ? 85 : 10 }, // Specify scrollContainer for compatibility with MobileFrontend. // Apparently it makes `
` elements scrollable and OOUI tried to scroll them instead of body. scrollContainer: OO.ui.Element.static.getRootScrollableElement( highlight.topmostElement ) } ).then( function () { highlight.$element.addClass( 'ext-discussiontools-init-highlight-fadein' ); setTimeout( function () { highlight.$element.addClass( 'ext-discussiontools-init-highlight-fadeout' ); setTimeout( function () { // Remove the node when no longer needed, because it's using CSS 'mix-blend-mode', which // affects the text rendering of the whole page, disabling subpixel antialiasing on Windows highlight.destroy(); }, 250 ); }, 3000 ); } ); } ); } /** * Highlight the new comments on the page associated with the query string * * @param {ThreadItemSet} threadItemSet * @param {boolean} [noScroll] Don't scroll to the topmost highlighted comment, e.g. on popstate * @param {string[]} [newCommentIds] A list of comment IDs to highlight * @param {string} [newCommentsSinceId] Highlight all comments after the comment with this ID * @param {boolean} [inThread] When using newCommentsSinceId, only highlight comments in the same thread */ function highlightNewComments( threadItemSet, noScroll, newCommentIds, newCommentsSinceId, inThread ) { if ( highlightedTarget ) { highlightedTarget.destroy(); highlightedTarget = null; } newCommentIds = newCommentIds || []; var highlightsRequested = newCommentIds.length || newCommentsSinceId; var highlightsRequestedSingle = !newCommentsSinceId && newCommentIds.length === 1; if ( newCommentsSinceId ) { var newCommentsSince = threadItemSet.findCommentById( newCommentsSinceId ); if ( newCommentsSince && newCommentsSince instanceof CommentItem ) { var sinceTimestamp = newCommentsSince.timestamp; var threadItems; if ( inThread ) { var heading = newCommentsSince.getSubscribableHeading() || newCommentsSince.getHeading(); threadItems = heading.getThreadItemsBelow(); } else { threadItems = threadItemSet.getCommentItems(); } threadItems.forEach( function ( threadItem ) { if ( threadItem instanceof CommentItem && threadItem.timestamp >= sinceTimestamp ) { newCommentIds.push( threadItem.id ); } } ); } } if ( newCommentIds.length ) { var comments = newCommentIds.map( function ( id ) { return threadItemSet.findCommentById( id ); } ).filter( function ( cmt ) { return !!cmt; } ); if ( comments.length === 0 ) { return; } highlightedTarget = new Highlight( comments ); highlightedTarget.$element.addClass( 'ext-discussiontools-init-targetcomment' ); highlightedTarget.$element.addClass( 'ext-discussiontools-init-highlight-fadein' ); if ( !noScroll ) { highlightedTarget.scrollIntoView(); } } else if ( highlightsRequested ) { missingTargetNotifPromise = mw.loader.using( 'mediawiki.notification' ).then( function () { return mw.notification.notify( mw.message( highlightsRequestedSingle ? 'discussiontools-target-comment-missing' : 'discussiontools-target-comments-missing' ).parse(), { type: 'warn', autoHide: false } ); } ); } } /** * Clear the highlighting of the comment in the URL hash * * @param {ThreadItemSet} threadItemSet */ function clearHighlightTargetComment( threadItemSet ) { if ( missingTargetNotifPromise ) { missingTargetNotifPromise.then( function ( notif ) { notif.close(); } ); missingTargetNotifPromise = null; } var url = new URL( location.href ); var targetElement = getTargetFromFragment( location.hash.slice( 1 ) ); if ( targetElement && targetElement.hasAttribute( 'data-mw-comment-start' ) ) { // Clear the hash from the URL, triggering the 'hashchange' event and updating the :target // selector (so that our code to clear our highlight works), but without scrolling anywhere. // This is tricky because: // * Using history.pushState() does not trigger 'hashchange' or update the :target selector. // https://developer.mozilla.org/en-US/docs/Web/API/History/pushState#description // https://github.com/whatwg/html/issues/639 // * Using location.hash does, but it also scrolls to the target, which is the top of the // page for the empty hash. // Instead, we first use location.hash to navigate to a *different* hash (whose target // doesn't exist on the page, hopefully), and then use history.pushState() to clear it. location.hash += '-DoesNotExist-DiscussionToolsHack'; url.hash = ''; history.replaceState( null, '', url ); } else if ( url.searchParams.has( 'dtnewcomments' ) || url.searchParams.has( 'dtnewcommentssince' ) ) { url.searchParams.delete( 'dtnewcomments' ); url.searchParams.delete( 'dtnewcommentssince' ); url.searchParams.delete( 'dtinthread' ); history.pushState( null, '', url ); highlightTargetComment( threadItemSet ); } else if ( highlightedTarget ) { // Highlights were applied without changing the URL, e.g. when showing // new comments while drafting. Just clear the highlights. highlightedTarget.destroy(); highlightedTarget = null; } } /** * Get the target element from a link hash * * This is the same element as you would get from * document.querySelectorAll(':target'), but can be used on * an arbitrary hash fragment, or after pushState/replaceState * has been used. * * @param {string} hash Hash fragment, without the leading '#' * @return {Element|null} Element, if found */ function getTargetFromFragment( hash ) { // Per https://html.spec.whatwg.org/multipage/browsing-the-web.html#target-element // we try the raw fragment first, then the percent-decoded fragment. return document.getElementById( hash ) || document.getElementById( percentDecode( hash ) ); } /** * Percent decode a link fragment * * Link fragments can be unencoded, fully encoded or partially * encoded, as defined in the spec. * * We can't just use decodeURI as that assumes the fragment * is fully encoded, and throws an error on a string like '%A'. * * @param {string} text Text to decode * @return {string|null} Decoded text, null if decoding failed */ function percentDecode( text ) { var params = new URLSearchParams( 'q=' + // Query string param decoding replaces '+' with ' ' before doing the // percent_decode, so encode '+' to prevent this. text.replace( /\+/g, '%2B' ) ); return params.get( 'q' ); } /** * Get the last highlighted just-published comment, if any * * Used to show an auto-subscription popup to first-time users * * @return {ThreadItem|null} */ function getLastHighlightedPublishedComment() { return lastHighlightedPublishedComment; } module.exports = { highlightTargetComment: highlightTargetComment, highlightPublishedComment: highlightPublishedComment, highlightNewComments: highlightNewComments, clearHighlightTargetComment: clearHighlightTargetComment, getLastHighlightedPublishedComment: getLastHighlightedPublishedComment };