mediawiki-extensions-Revisi.../modules/ext.RevisionSlider.RevisionListView.js
thiemowmde 0d8158de5c Partly drop dependency from RevisionListView to RevisionList
It turns out the view class doesn't really do anything with the
RevisionList object. All it does it manually iterating the array of
revisions. But it doesn't call anything from the RevisionList class.
With a single exception.

Warning: This doesn't mean the RevisionList class is pointless. It's
critical because this is where the relativeSize fields are calculated.

Bug: T224971
Change-Id: I06b8af815bb6f931355d68aa511070fb34b08156
2023-10-26 13:58:59 +02:00

685 lines
18 KiB
JavaScript

/**
* @class RevisionListView
* @param {RevisionList} revisionList
* @param {string} [dir]
* @constructor
*/
function RevisionListView( revisionList, dir ) {
this.revisions = revisionList.getRevisions();
// Cache a possibly expensive calculation, we are going to need this many times
this.maxChangeSize = revisionList.getBiggestChangeSize();
this.dir = dir;
}
$.extend( RevisionListView.prototype, {
/**
* @type {Revision[]}
*/
revisions: null,
/**
* @type {number}
*/
maxChangeSize: 0,
/**
* @type {number}
*/
revisionWidth: 16,
/**
* @type {number}
*/
minRevisionHeight: 5,
/**
* @type {number}
*/
maxRevisionHeight: 66,
/**
* @type {number}
*/
tooltipTimeout: -1,
/**
* @type {boolean}
*/
allowHover: true,
/**
* @type {string}
*/
dir: null,
/**
* @type {string}
*/
selectedUser: '',
/**
* @type {string}
*/
selectedTag: '',
/**
* @type {jQuery}
*/
html: null,
/**
* @param {number} revisionTickWidth
* @param {number} positionOffset
* @return {jQuery}
*/
render: function ( revisionTickWidth, positionOffset ) {
const revs = this.revisions,
self = this;
positionOffset = positionOffset || 0;
this.revisionWidth = revisionTickWidth;
this.$html = $( '<div>' ).addClass( 'mw-revslider-revisions' );
for ( let i = 0; i < revs.length; i++ ) {
const diffSize = revs[ i ].getRelativeSize();
const relativeChangeSize = this.calcRelativeChangeSize( diffSize );
this.$html
.append( $( '<div>' )
.addClass( 'mw-revslider-revision-wrapper' )
.width( this.revisionWidth )
.append( $( '<div>' )
.addClass( 'mw-revslider-revision' )
.attr( 'data-revid', revs[ i ].getId() )
.attr( 'data-pos', positionOffset + i + 1 )
.attr( 'data-user', revs[ i ].getUser() )
.css( {
height: relativeChangeSize + 'px',
width: this.revisionWidth + 'px',
top: diffSize > 0 ? '-' + relativeChangeSize + 'px' : 0
} )
.addClass( diffSize > 0 ? 'mw-revslider-revision-up' : 'mw-revslider-revision-down' )
.append( $( '<div>' ).addClass( 'mw-revslider-revision-border-box' ) )
)
.append( $( '<div>' )
.addClass( 'mw-revslider-revision-wrapper-up' )
.width( this.revisionWidth )
.append(
$( '<div>' )
.addClass( 'mw-revslider-pointer mw-revslider-pointer-ghost' )
)
)
.append( $( '<div>' )
.addClass( 'mw-revslider-revision-wrapper-down' )
.width( this.revisionWidth )
.append(
$( '<div>' )
.addClass( 'mw-revslider-pointer mw-revslider-pointer-ghost' )
)
)
.on( 'mouseenter', function ( event ) {
if ( self.allowHover ) {
self.setRevisionHoveredFromMouseEvent( $( this ), event );
}
} )
.on( 'mouseleave', function () {
self.unsetAllHovered();
self.hideCurrentTooltipWithDelay();
} )
);
}
this.keepTooltipsOnHover();
this.closeTooltipsOnClick();
return this.$html;
},
enableHover: function () {
this.allowHover = true;
},
disableHover: function () {
this.allowHover = false;
this.unsetAllHovered();
},
/**
* @param {jQuery} $revisionWrapper
* @param {MouseEvent} event
*/
setRevisionHoveredFromMouseEvent: function ( $revisionWrapper, event ) {
if ( !$revisionWrapper.length || $( event.target ).closest( '.mw-revslider-revision-tooltip' ).length ) {
return;
}
this.showTooltip( $revisionWrapper );
const hasMovedTop = event.pageY - $revisionWrapper.offset().top < $revisionWrapper.height() / 2,
isOlderTop = $revisionWrapper.hasClass( 'mw-revslider-revision-older' ) && hasMovedTop,
isNewerBottom = $revisionWrapper.hasClass( 'mw-revslider-revision-newer' ) && !hasMovedTop;
let $neighborRevisionWrapper = $revisionWrapper;
if ( isOlderTop ) {
$neighborRevisionWrapper = $revisionWrapper.prev();
} else if ( isNewerBottom ) {
$neighborRevisionWrapper = $revisionWrapper.next();
}
if ( $neighborRevisionWrapper.length === 0 ) {
return;
}
if ( hasMovedTop ) {
this.setRevisionGhost( $revisionWrapper.find( '.mw-revslider-revision-wrapper-up' ) );
if ( isOlderTop ) {
this.setRevisionGhost( $neighborRevisionWrapper.find( '.mw-revslider-revision-wrapper-down' ) );
}
} else {
this.setRevisionGhost( $revisionWrapper.find( '.mw-revslider-revision-wrapper-down' ) );
if ( isNewerBottom ) {
this.setRevisionGhost( $neighborRevisionWrapper.find( '.mw-revslider-revision-wrapper-up' ) );
}
}
},
/**
* @param {jQuery} $revisionWrapper
*/
setRevisionGhost: function ( $revisionWrapper ) {
$revisionWrapper.addClass( 'mw-revslider-revision-hovered' );
},
unsetAllHovered: function () {
$( '.mw-revslider-revision-wrapper-up, .mw-revslider-revision-wrapper-down' )
.removeClass( 'mw-revslider-revision-hovered' );
},
/**
* @param {jQuery} $renderedList
*/
adjustRevisionSizes: function ( $renderedList ) {
const revs = this.revisions;
for ( let i = 0; i < revs.length; i++ ) {
const diffSize = revs[ i ].getRelativeSize();
const relativeChangeSize = this.calcRelativeChangeSize( diffSize );
$renderedList.find( '.mw-revslider-revision[data-pos="' + ( i + 1 ) + '"]' ).css( {
height: relativeChangeSize + 'px',
top: diffSize > 0 ? '-' + relativeChangeSize + 'px' : 0
} );
}
},
/**
* @param {number} diffSize
* @return {number}
*/
calcRelativeChangeSize: function ( diffSize ) {
if ( !diffSize ) {
return 0;
}
return Math.ceil(
( this.maxRevisionHeight - this.minRevisionHeight ) *
Math.log( Math.abs( diffSize ) ) / Math.log( this.maxChangeSize ) ) +
this.minRevisionHeight;
},
/**
* Hides the current tooltip immediately
*/
hideCurrentTooltip: function () {
window.clearTimeout( this.tooltipTimeout );
$( '.mw-revslider-revision-wrapper-hovered' )
.removeClass( 'mw-revslider-revision-wrapper-hovered' );
$( '.mw-revslider-revision-tooltip' ).remove();
},
/**
* Hides the current tooltip after 500ms
*/
hideCurrentTooltipWithDelay: function () {
this.tooltipTimeout = window.setTimeout( this.hideCurrentTooltip.bind( this ), 500 );
},
/**
* Hides the current tooltip when the focus moves away and not to a pointer or tooltip
*
* @param {jQuery.Event} event
*/
onFocusBlur: function ( event ) {
const $outElement = $( event.relatedTarget );
if ( $outElement.hasClass( '.mw-revslider-pointer' ) || $outElement.closest( '.mw-revslider-revision-tooltip' ).length ) {
return;
}
this.hideCurrentTooltip();
},
/**
* Hides the previous tooltip and shows the new one. Also styles a revision as hovered.
*
* @param {jQuery} $revisionWrapper
*/
showTooltip: function ( $revisionWrapper ) {
const $revision = $revisionWrapper.find( '.mw-revslider-revision' );
const revId = +$revision.attr( 'data-revid' );
const pos = +$revision.attr( 'data-pos' );
const revision = this.revisions.find( ( rev ) => rev.getId() === revId );
if ( !revision ) {
return;
}
if ( $( '.mw-revslider-revision-tooltip-' + pos ).length ) {
window.clearTimeout( this.tooltipTimeout );
return;
}
this.hideCurrentTooltip();
const tooltip = this.makeTooltip( revision, $revisionWrapper );
// eslint-disable-next-line mediawiki/class-doc
tooltip.$element
.addClass( 'mw-revslider-revision-tooltip-' + pos )
.on( 'focusout', this.onFocusBlur.bind( this ) );
const $focusedRevisionPointer = $( '.mw-revslider-pointer[data-pos="' + pos + '"]' );
if ( $focusedRevisionPointer.length ) {
// Make sure tooltips are added next to the pointer so they can be reached when tabbing
$focusedRevisionPointer.parent().append( tooltip.$element );
} else {
$( document.body ).append( tooltip.$element );
}
tooltip.toggle( true );
// TODO this line should move somewhere else
$revisionWrapper.addClass( 'mw-revslider-revision-wrapper-hovered' );
},
/**
* Sets event handlers on tooltips so they do not disappear when hovering over them
*/
keepTooltipsOnHover: function () {
const self = this;
$( document )
.on( 'mouseenter', '.mw-revslider-revision-tooltip', function () {
window.clearTimeout( self.tooltipTimeout );
} )
.on( 'mouseleave', '.mw-revslider-revision-tooltip', function () {
self.hideCurrentTooltipWithDelay();
} );
},
/**
* Sets an event handler to close tooltips when clicking somewhere outside
*/
closeTooltipsOnClick: function () {
const self = this;
$( document )
.on( 'click', function ( event ) {
if ( $( event.target ).closest( '.mw-revslider-revision-tooltip' ).length === 0 &&
$( event.target ).closest( '.mw-revslider-revisions-container' ).length === 0 ) {
self.hideCurrentTooltip();
}
} );
},
/**
* Generates the HTML for a tooltip that appears on hover above each revision on the slider
*
* @param {Revision} revision
* @param {jQuery} $revisionWrapper
* @return {OO.ui.PopupWidget}
*/
makeTooltip: function ( revision, $revisionWrapper ) {
const $tooltip = $( '<div>' )
.append(
$( '<p>' ).append(
$( '<strong>' ).text( mw.msg( 'revisionslider-label-date' ) + mw.msg( 'colon-separator' ) ),
$( '<a>' ).attr( 'href', mw.util.getUrl( null, { oldid: revision.id } ) )
.text( revision.getFormattedDate() )
),
this.makeUserLine( revision.getUser(), revision.getUserGender() ),
this.makeCommentLine( revision ),
this.makePageSizeLine( revision.getSize() ),
this.makeChangeSizeLine( revision.getRelativeSize() ),
revision.isMinor() ? $( '<p>' ).text( mw.msg( 'revisionslider-minoredit' ) ) : '',
this.makeTagsLine( revision )
);
return new OO.ui.PopupWidget( {
$content: $tooltip,
$floatableContainer: $revisionWrapper,
padded: true,
classes: [ 'mw-revslider-tooltip', 'mw-revslider-revision-tooltip' ]
} );
},
/**
* Generates a link to user page or to contributions page for IP addresses
*
* @param {string} user
* @return {string}
*/
getUserPage: function ( user ) {
return ( mw.util.isIPAddress( user ) ? 'Special:Contributions/' : 'User:' ) + this.stripInvalidCharacters( user );
},
/**
* Generates the HTML for the user label
*
* @param {string} userString
* @param {string} [userGender='unknown']
* @return {string|jQuery}
*/
makeUserLine: function ( userString, userGender ) {
const self = this;
if ( !userString ) {
return '';
}
if ( !userGender ) {
userGender = 'unknown';
}
const $userBubble = $( '<div>' ).addClass( 'mw-revslider-bubble' )
.on( 'click mouseenter mouseleave', function ( event ) {
self.setUserFilterEvents( $( this ), userString, event );
} );
const $userLine = $( '<p>' ).addClass( 'mw-revslider-filter-highlightable-row mw-revslider-username-row' ).append(
$( '<strong>' ).text( mw.msg( 'revisionslider-label-username', userGender ) + mw.msg( 'colon-separator' ) ),
$( '<bdi>' ).append(
$( '<a>' ).addClass( 'mw-userlink' ).attr( 'href', mw.util.getUrl( this.getUserPage( userString ) ) ).text( this.stripInvalidCharacters( userString ) )
),
$userBubble
);
if ( self.selectedUser === userString ) {
self.selectedTag = '';
$userLine.addClass( 'mw-revslider-filter-highlight' );
$userBubble.addClass( 'mw-revslider-filter-highlight-bubble' );
}
return $userLine;
},
/**
* Set user filter events for revisions
*
* @param {jQuery} $userBubble
* @param {string} userName
* @param {MouseEvent} event
*/
setUserFilterEvents: function ( $userBubble, userName, event ) {
const $userLine = $userBubble.parent();
if ( this.selectedUser === userName && event.type !== 'click' ) {
return;
}
this.removeRevisionFilterHighlighting();
let oldUser;
switch ( event.type ) {
case 'mouseenter':
$userLine.addClass( 'mw-revslider-filter-highlight' );
$userBubble.addClass( 'mw-revslider-filter-highlight-bubble' );
this.filterHighlightSameUserRevisions( userName );
break;
case 'mouseleave':
this.reApplySavedFilterHighlighting( $userLine, $userBubble );
break;
case 'click':
oldUser = this.selectedUser;
this.resetRevisionFilterHighlighting();
$userLine.addClass( 'mw-revslider-filter-highlight' );
$userBubble.addClass( 'mw-revslider-filter-highlight-bubble' );
if ( oldUser !== userName ) {
this.filterHighlightSameUserRevisions( userName );
this.selectedUser = userName;
}
break;
}
},
/**
* Highlights revisions of the sameUser
*
* @param {string} userString
*/
filterHighlightSameUserRevisions: function ( userString ) {
$( '[data-user="' + userString + '"]' ).parent()
.toggleClass( 'mw-revslider-revision-filter-highlight' );
},
/**
* @param {string} s
* @return {string}
*/
stripInvalidCharacters: function ( s ) {
return s.replace( /[<>&]/g, '' );
},
/**
* Generates the HTML for the comment label
*
* @param {Revision} rev
* @return {string|jQuery}
*/
makeCommentLine: function ( rev ) {
const html = rev.getParsedComment();
if ( !html.trim().length ) {
return '';
}
return $( '<p>' ).append(
$( '<strong>' ).text( mw.msg( 'revisionslider-label-comment' ) + mw.msg( 'colon-separator' ) ),
$( '<em>' ).append(
$( '<bdi>' ).append( html )
)
);
},
/**
* Generates the HTML for the tags label
*
* @param {Revision} rev
* @return {string|jQuery}
*/
makeTagsLine: function ( rev ) {
const self = this;
const tags = rev.getTags();
if ( !tags.length ) {
return '';
}
const $tagLines = $( '<div>' );
for ( let i = 0; i < tags.length; i++ ) {
const $tagBubble = $( '<div>' ).addClass( 'mw-revslider-bubble' )
.on( 'click mouseenter mouseleave', function ( event ) {
self.setTagFilterEvents( $( this ), event );
} );
const $tagLine = $( '<div>' ).addClass( 'mw-revslider-filter-highlightable-row mw-revslider-tag-row' ).append(
tags[ i ],
$tagBubble,
'<br>'
);
if ( self.selectedTag === tags[ i ] ) {
self.selectedUser = '';
$tagLine.addClass( 'mw-revslider-filter-highlight' );
$tagLine.find( $tagBubble ).addClass( 'mw-revslider-filter-highlight-bubble' );
}
$tagLine.attr( 'data-tag-name', tags[ i ] );
$tagLines.append( $tagLine );
}
return $tagLines;
},
/**
* Set tag filter events for revisions
*
* @param {jQuery} $tagBubble
* @param {MouseEvent} event
*/
setTagFilterEvents: function ( $tagBubble, event ) {
const $tagLine = $tagBubble.parent(),
tagName = $tagLine.data( 'tag-name' );
if ( this.selectedTag === tagName && event.type !== 'click' ) {
return;
}
this.removeRevisionFilterHighlighting();
let oldTag;
switch ( event.type ) {
case 'mouseenter':
$tagLine.addClass( 'mw-revslider-filter-highlight' );
$tagBubble.addClass( 'mw-revslider-filter-highlight-bubble' );
this.filterHighlightSameTagRevisions( tagName );
break;
case 'mouseleave':
this.reApplySavedFilterHighlighting( $tagLine, $tagBubble );
break;
case 'click':
oldTag = this.selectedTag;
this.resetRevisionFilterHighlighting();
$tagLine.addClass( 'mw-revslider-filter-highlight' );
$tagBubble.addClass( 'mw-revslider-filter-highlight-bubble' );
if ( oldTag !== tagName ) {
this.filterHighlightSameTagRevisions( tagName );
this.selectedTag = tagName;
}
break;
}
},
/**
* Highlight same tag revisions
*
* @param {string} tagName
*/
filterHighlightSameTagRevisions: function ( tagName ) {
const revs = this.revisions;
for ( let i = 0; i < revs.length; i++ ) {
const revTags = revs[ i ].getTags();
for ( let j = 0; j < revTags.length; j++ ) {
if ( tagName === revTags[ j ] ) {
$( '[data-revid="' + revs[ i ].id + '"]' ).parent()
.addClass( 'mw-revslider-revision-filter-highlight' );
}
}
}
},
/**
* Re-apply filter highlighting from saved state
*
* @param {jQuery} $line
* @param {jQuery} $bubble
*/
reApplySavedFilterHighlighting: function ( $line, $bubble ) {
$line.removeClass( 'mw-revslider-filter-highlight' );
$bubble.removeClass( 'mw-revslider-filter-highlight-bubble' );
if ( this.selectedTag ) {
this.filterHighlightSameTagRevisions( this.selectedTag );
}
if ( this.selectedUser ) {
this.filterHighlightSameUserRevisions( this.selectedUser );
}
},
/**
* Removes the filter highlighting from the revisions
*/
removeRevisionFilterHighlighting: function () {
$( '.mw-revslider-revision-wrapper' ).removeClass( 'mw-revslider-revision-filter-highlight' );
},
/**
* Resets filter highlighting from setting state
*/
resetRevisionFilterHighlighting: function () {
$( '.mw-revslider-filter-highlightable-row' ).removeClass( 'mw-revslider-filter-highlight' );
$( '.mw-revslider-bubble' ).removeClass( 'mw-revslider-filter-highlight-bubble' );
this.selectedTag = '';
this.selectedUser = '';
},
/**
* Generates the HTML for the page size label
*
* @param {number} size
* @return {jQuery}
*/
makePageSizeLine: function ( size ) {
return $( '<p>' ).append(
$( '<strong>' ).text( mw.msg( 'revisionslider-label-page-size' ) + mw.msg( 'colon-separator' ) ),
mw.msg( 'revisionslider-page-size', mw.language.convertNumber( size ), size )
);
},
/**
* Generates the HTML for the change size label
*
* @param {number} relativeSize
* @return {jQuery}
*/
makeChangeSizeLine: function ( relativeSize ) {
let changeSizeClass = 'mw-revslider-change-none',
leadingSign = '';
if ( relativeSize > 0 ) {
changeSizeClass = 'mw-revslider-change-positive';
leadingSign = '+';
} else if ( relativeSize < 0 ) {
changeSizeClass = 'mw-revslider-change-negative';
}
// Classes are documented above
// eslint-disable-next-line mediawiki/class-doc
const $changeNumber = $( '<span>' )
.addClass( changeSizeClass )
.attr( {
dir: 'ltr' // Make sure that minus/plus is on the left
} )
.text( leadingSign + mw.language.convertNumber( relativeSize ) );
return $( '<p>' ).append(
$( '<strong>' ).text( mw.msg( 'revisionslider-label-change-size' ) + mw.msg( 'colon-separator' ) ),
mw.message( 'revisionslider-change-size', $changeNumber, relativeSize, Math.abs( relativeSize ) ).parse()
);
},
/**
* Set direction for the view
*
* @param {string} dir
*/
setDir: function ( dir ) {
this.dir = dir;
},
/**
* @return {jQuery}
*/
getElement: function () {
return this.$html;
}
} );
module.exports = RevisionListView;