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

Support replying when timestamp is template-generated

Browse source 
* Move modifier#getFullyCoveredWrapper to utils
* Use that method to find the node where we start searching for
  template wrappers, rather than using endContainer

Bug: T252058
Change-Id: I55de58102f3468fce01290bd413a7fdc96d322d6
This commit is contained in:
Bartosz Dziewoński 2020-05-27 19:31:31 +02:00
parent c7575b49f6
commit 01b4a8f4f4
6 changed files with 153 additions and 150 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

70
includes/CommentModifier.php
View file

@ -82,74 +82,6 @@ class CommentModifier {
$target->parentNode->insertBefore( $linkNode, $target->nextSibling );
}
/**
* Get a node (if any) that contains the given comment, and nothing else.
*
* @param stdClass $comment Comment data returned by parser#groupThreads
* @return DOMElement|null
*/
private static function getFullyCoveredWrapper( $comment ) {
$ancestor = $comment->range->commonAncestorContainer;
$isIgnored = function ( $node ) {
// Ignore empty text nodes
return $node->nodeType === XML_TEXT_NODE && CommentUtils::htmlTrim( $node->nodeValue ) === '';
};
$firstNonemptyChild = function ( $node ) use ( $isIgnored ) {
$node = $node->firstChild;
while ( $node && $isIgnored( $node ) ) {
$node = $node->nextSibling;
}
return $node;
};
$lastNonemptyChild = function ( $node ) use ( $isIgnored ) {
$node = $node->lastChild;
while ( $node && $isIgnored( $node ) ) {
$node = $node->previousSibling;
}
return $node;
};
$startMatches = false;
$node = $ancestor;
while ( $node ) {
if ( $comment->range->startContainer === $node && $comment->range->startOffset === 0 ) {
$startMatches = true;
break;
}
$node = $firstNonemptyChild( $node );
}
$endMatches = false;
$node = $ancestor;
while ( $node ) {
$length = ( $node->nodeType === XML_TEXT_NODE ) ?
strlen( rtrim( $node->nodeValue, "\t\n\f\r " ) ) :
// PHP bug: childNodes can be null for comment nodes
// (it should always be a DOMNodeList, even if the node can't have children)
( $node->childNodes ? $node->childNodes->length : 0 );
if ( $comment->range->endContainer === $node && $comment->range->endOffset === $length ) {
$endMatches = true;
break;
}
$node = $lastNonemptyChild( $node );
}
if ( $startMatches && $endMatches ) {
// If this is the only child, go up one more level
while (
$ancestor->parentNode &&
$firstNonemptyChild( $ancestor->parentNode ) === $lastNonemptyChild( $ancestor->parentNode )
) {
$ancestor = $ancestor->parentNode;
}
return $ancestor;
}
return null;
}
/**
* Given a comment, add a list item to its document's DOM tree, inside of which a reply to said
* comment can be added.
@ -205,7 +137,7 @@ class CommentModifier {
// If the comment is fully covered by some wrapper element, insert replies outside that wrapper.
// This will often just be a paragraph node (<p>), but it can be a <div> or <table> that serves
// as some kind of a fancy frame, which are often used for barnstars and announcements.
if ( $curLevel === 1 && ( $wrapper = self::getFullyCoveredWrapper( $curComment ) ) ) {
if ( $curLevel === 1 && ( $wrapper = CommentUtils::getFullyCoveredWrapper( $curComment ) ) ) {
$target = $wrapper;
$parent = $target->parentNode;
}

11
includes/CommentParser.php
View file

@ -977,11 +977,12 @@ class CommentParser {
* we can't determine the source.
*/
public function getTranscludedFrom( stdClass $comment ) {
// If some template is used within the comment (e.g. {{ping|…}} or {{tl|…}}), that *does not* mean
// the comment is transcluded. We only want to consider comments to be transcluded if the wrapper
// element (usually <li> or <p>) is marked as part of a transclusion.
// TODO: This seems to work fine but I'm having a hard time explaining why it is correct...
$node = $comment->range->endContainer;
// If some template is used within the comment (e.g. {{ping|…}} or {{tl|…}}, or a
// non-substituted signature template), that *does not* mean the comment is transcluded.
// We only want to consider comments to be transcluded if the wrapper element (usually
// <li> or <p>) is marked as part of a transclusion. If we can't find a wrapper, using
// endContainer should avoid false negatives (although may have false positives).
$node = CommentUtils::getFullyCoveredWrapper( $comment ) ?: $comment->range->endContainer;
// Find the node containing information about the transclusion:
// 1. Find the closest ancestor with an 'about' attribute

68
includes/CommentUtils.php
View file

@ -71,6 +71,74 @@ class CommentUtils {
return trim( $str, "\t\n\f\r " );
}
/**
* Get a node (if any) that contains the given comment, and nothing else.
*
* @param stdClass $comment Comment data returned by parser#groupThreads
* @return DOMElement|null
*/
public static function getFullyCoveredWrapper( $comment ) {
$ancestor = $comment->range->commonAncestorContainer;
$isIgnored = function ( $node ) {
// Ignore empty text nodes
return $node->nodeType === XML_TEXT_NODE && CommentUtils::htmlTrim( $node->nodeValue ) === '';
};
$firstNonemptyChild = function ( $node ) use ( $isIgnored ) {
$node = $node->firstChild;
while ( $node && $isIgnored( $node ) ) {
$node = $node->nextSibling;
}
return $node;
};
$lastNonemptyChild = function ( $node ) use ( $isIgnored ) {
$node = $node->lastChild;
while ( $node && $isIgnored( $node ) ) {
$node = $node->previousSibling;
}
return $node;
};
$startMatches = false;
$node = $ancestor;
while ( $node ) {
if ( $comment->range->startContainer === $node && $comment->range->startOffset === 0 ) {
$startMatches = true;
break;
}
$node = $firstNonemptyChild( $node );
}
$endMatches = false;
$node = $ancestor;
while ( $node ) {
$length = ( $node->nodeType === XML_TEXT_NODE ) ?
strlen( rtrim( $node->nodeValue, "\t\n\f\r " ) ) :
// PHP bug: childNodes can be null for comment nodes
// (it should always be a DOMNodeList, even if the node can't have children)
( $node->childNodes ? $node->childNodes->length : 0 );
if ( $comment->range->endContainer === $node && $comment->range->endOffset === $length ) {
$endMatches = true;
break;
}
$node = $lastNonemptyChild( $node );
}
if ( $startMatches && $endMatches ) {
// If this is the only child, go up one more level
while (
$ancestor->parentNode &&
$firstNonemptyChild( $ancestor->parentNode ) === $lastNonemptyChild( $ancestor->parentNode )
) {
$ancestor = $ancestor->parentNode;
}
return $ancestor;
}
return null;
}
/**
* Unwrap Parsoid sections
*

72
modules/modifier.js
View file

@ -44,76 +44,6 @@ function addReplyLink( comment, linkNode ) {
target.parentNode.insertBefore( linkNode, target.nextSibling );
}
/**
* Get a node (if any) that contains the given comment, and nothing else.
*
* @param {Object} comment Comment data returned by parser#groupThreads
* @return {HTMLElement|null}
*/
function getFullyCoveredWrapper( comment ) {
var nativeRange, ancestor, node, startMatches, endMatches, length;
nativeRange = utils.getNativeRange( comment );
ancestor = nativeRange.commonAncestorContainer;
function isIgnored( node ) {
// Ignore empty text nodes, and our own reply buttons
return ( node.nodeType === Node.TEXT_NODE && utils.htmlTrim( node.textContent ) === '' ) ||
( node.className && node.className.indexOf( 'dt-init-replylink-buttons' ) !== -1 );
}
function firstNonemptyChild( node ) {
node = node.firstChild;
while ( node && isIgnored( node ) ) {
node = node.nextSibling;
}
return node;
}
function lastNonemptyChild( node ) {
node = node.lastChild;
while ( node && isIgnored( node ) ) {
node = node.previousSibling;
}
return node;
}
startMatches = false;
node = ancestor;
while ( node ) {
if ( comment.range.startContainer === node && comment.range.startOffset === 0 ) {
startMatches = true;
break;
}
node = firstNonemptyChild( node );
}
endMatches = false;
node = ancestor;
while ( node ) {
length = node.nodeType === Node.TEXT_NODE ?
node.textContent.replace( /[\t\n\f\r ]+$/, '' ).length :
node.childNodes.length;
if ( comment.range.endContainer === node && comment.range.endOffset === length ) {
endMatches = true;
break;
}
node = lastNonemptyChild( node );
}
if ( startMatches && endMatches ) {
// If this is the only child, go up one more level
while (
ancestor.parentNode &&
firstNonemptyChild( ancestor.parentNode ) === lastNonemptyChild( ancestor.parentNode )
) {
ancestor = ancestor.parentNode;
}
return ancestor;
}
return null;
}
/**
* Given a comment, add a list item to its document's DOM tree, inside of which a reply to said
* comment can be added.
@ -170,7 +100,7 @@ function addListItem( comment ) {
// If the comment is fully covered by some wrapper element, insert replies outside that wrapper.
// This will often just be a paragraph node (<p>), but it can be a <div> or <table> that serves
// as some kind of a fancy frame, which are often used for barnstars and announcements.
if ( curLevel === 1 && ( wrapper = getFullyCoveredWrapper( curComment ) ) ) {
if ( curLevel === 1 && ( wrapper = utils.getFullyCoveredWrapper( curComment ) ) ) {
target = wrapper;
parent = target.parentNode;
}

11
modules/parser.js
View file

@ -975,11 +975,12 @@ function getAuthors( comment ) {
function getTranscludedFrom( comment ) {
var node, about, dataMw;
// If some template is used within the comment (e.g. {{ping|…}} or {{tl|…}}), that *does not* mean
// the comment is transcluded. We only want to consider comments to be transcluded if the wrapper
// element (usually <li> or <p>) is marked as part of a transclusion.
// TODO: This seems to work fine but I'm having a hard time explaining why it is correct...
node = comment.range.endContainer;
// If some template is used within the comment (e.g. {{ping|…}} or {{tl|…}}, or a
// non-substituted signature template), that *does not* mean the comment is transcluded.
// We only want to consider comments to be transcluded if the wrapper element (usually
// <li> or <p>) is marked as part of a transclusion. If we can't find a wrapper, using
// endContainer should avoid false negatives (although may have false positives).
node = utils.getFullyCoveredWrapper( comment ) || comment.range.endContainer;
// Find the node containing information about the transclusion:
// 1. Find the closest ancestor with an 'about' attribute

71
modules/utils.js
View file

@ -69,9 +69,80 @@ function htmlTrim( str ) {
return str.replace( /^[\t\n\f\r ]+/, '' ).replace( /[\t\n\f\r ]+$/, '' );
}
/**
* Get a node (if any) that contains the given comment, and nothing else.
*
* @param {Object} comment Comment data returned by parser#groupThreads
* @return {HTMLElement|null}
*/
function getFullyCoveredWrapper( comment ) {
var nativeRange, ancestor, node, startMatches, endMatches, length;
nativeRange = getNativeRange( comment );
ancestor = nativeRange.commonAncestorContainer;
function isIgnored( node ) {
// Ignore empty text nodes, and our own reply buttons
return ( node.nodeType === Node.TEXT_NODE && htmlTrim( node.textContent ) === '' ) ||
( node.className && node.className.indexOf( 'dt-init-replylink-buttons' ) !== -1 );
}
function firstNonemptyChild( node ) {
node = node.firstChild;
while ( node && isIgnored( node ) ) {
node = node.nextSibling;
}
return node;
}
function lastNonemptyChild( node ) {
node = node.lastChild;
while ( node && isIgnored( node ) ) {
node = node.previousSibling;
}
return node;
}
startMatches = false;
node = ancestor;
while ( node ) {
if ( comment.range.startContainer === node && comment.range.startOffset === 0 ) {
startMatches = true;
break;
}
node = firstNonemptyChild( node );
}
endMatches = false;
node = ancestor;
while ( node ) {
length = node.nodeType === Node.TEXT_NODE ?
node.textContent.replace( /[\t\n\f\r ]+$/, '' ).length :
node.childNodes.length;
if ( comment.range.endContainer === node && comment.range.endOffset === length ) {
endMatches = true;
break;
}
node = lastNonemptyChild( node );
}
if ( startMatches && endMatches ) {
// If this is the only child, go up one more level
while (
ancestor.parentNode &&
firstNonemptyChild( ancestor.parentNode ) === lastNonemptyChild( ancestor.parentNode )
) {
ancestor = ancestor.parentNode;
}
return ancestor;
}
return null;
}
module.exports = {
getNativeRange: getNativeRange,
childIndexOf: childIndexOf,
closestElement: closestElement,
getFullyCoveredWrapper: getFullyCoveredWrapper,
htmlTrim: htmlTrim
};