mediawiki-extensions-Revisi.../modules/ext.RevisionSlider.RevisionListView.js
thiemowmde ac0096b23b Revert "partly drop dependency from RevisionListView"
This is a manual revert of I06b8af8. Turns out the list of revisions
(and with that the maximum size calculated from the list of revisions)
changes during the lifetime of the view. It must be recalculated.
Maybe not as often. But this is an optimization for a later patch.

Change-Id: Id1dce5566a9041396bcf72df7e4936be0e53188a
2023-11-14 17:40:52 +01:00

711 lines
19 KiB
JavaScript

/**
* @class RevisionListView
* @param {RevisionList} revisionList
* @param {string} [dir]
* @constructor
*/
function RevisionListView( revisionList, dir ) {
this.revisionList = revisionList;
this.dir = dir;
}
$.extend( RevisionListView.prototype, {
/**
* @type {RevisionList}
*/
revisionList: null,
/**
* @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.revisionList.getRevisions();
const maxChangeSize = this.revisionList.getBiggestChangeSize();
const 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, maxChangeSize );
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.removeCurrentRevisionFocusWithDelay();
} )
);
}
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.setRevisionFocus( $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' ) );
}
}
},
/**
* @private
* @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.revisionList.getRevisions();
const maxChangeSize = this.revisionList.getBiggestChangeSize();
for ( let i = 0; i < revs.length; i++ ) {
const diffSize = revs[ i ].getRelativeSize();
const relativeChangeSize = this.calcRelativeChangeSize( diffSize, maxChangeSize );
$renderedList.find( '.mw-revslider-revision[data-pos="' + ( i + 1 ) + '"]' ).css( {
height: relativeChangeSize + 'px',
top: diffSize > 0 ? '-' + relativeChangeSize + 'px' : 0
} );
}
},
/**
* @private
* @param {number} diffSize
* @param {number} maxChangeSize
* @return {number}
*/
calcRelativeChangeSize: function ( diffSize, maxChangeSize ) {
if ( !diffSize ) {
return 0;
}
return Math.ceil(
( this.maxRevisionHeight - this.minRevisionHeight ) *
Math.log( Math.abs( diffSize ) ) / Math.log( maxChangeSize ) ) +
this.minRevisionHeight;
},
/**
* Clears the current revision focus and removes highlights and tooltip
*/
removeCurrentRevisionFocus: function () {
window.clearTimeout( this.tooltipTimeout );
this.removeCurrentRevisionFocusHighlight();
$( '.mw-revslider-revision-tooltip' ).remove();
},
/**
* Removes the current revision focus after 500ms
*
* @private
*/
removeCurrentRevisionFocusWithDelay: function () {
this.tooltipTimeout = window.setTimeout( this.removeCurrentRevisionFocus.bind( this ), 500 );
},
removeCurrentRevisionFocusHighlight: function () {
$( '.mw-revslider-revision-wrapper-hovered' )
.removeClass( 'mw-revslider-revision-wrapper-hovered' );
},
/**
* Sets the revision focus adding highlights and tooltip
*
* @param {jQuery} $revisionWrapper
*/
setRevisionFocus: function ( $revisionWrapper ) {
if ( $revisionWrapper.hasClass( 'mw-revslider-revision-wrapper-hovered' ) ) {
window.clearTimeout( this.tooltipTimeout );
return;
}
this.removeCurrentRevisionFocus();
this.showTooltip( $revisionWrapper );
$revisionWrapper.addClass( 'mw-revslider-revision-wrapper-hovered' );
},
/**
* 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.removeCurrentRevisionFocus();
},
/**
* 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.revisionList.getRevisions().find( ( rev ) => rev.getId() === revId );
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 );
},
/**
* Sets event handlers on tooltips so they do not disappear when hovering over them
*
* @private
*/
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.removeCurrentRevisionFocusWithDelay();
} );
},
/**
* Sets an event handler to close tooltips when clicking somewhere outside
*
* @private
*/
closeTooltipsOnClick: function () {
const self = this;
$( document )
.on( 'click', function ( event ) {
const $inside = $( event.target )
.closest( '.mw-revslider-revision-tooltip, .mw-revslider-revisions-container' );
if ( !$inside.length ) {
self.removeCurrentRevisionFocus();
}
} );
},
/**
* Generates the HTML for a tooltip that appears on hover above each revision on the slider
*
* @private
* @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
*
* @private
* @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
*
* @private
* @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
*
* @private
* @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
*
* @private
* @param {string} userString
*/
filterHighlightSameUserRevisions: function ( userString ) {
$( '[data-user="' + userString + '"]' ).parent()
.toggleClass( 'mw-revslider-revision-filter-highlight' );
},
/**
* @private
* @param {string} s
* @return {string}
*/
stripInvalidCharacters: function ( s ) {
return s.replace( /[<>&]/g, '' );
},
/**
* Generates the HTML for the comment label
*
* @private
* @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
*
* @private
* @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
*
* @private
* @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
*
* @private
* @param {string} tagName
*/
filterHighlightSameTagRevisions: function ( tagName ) {
const revs = this.revisionList.getRevisions();
for ( let i = 0; i < revs.length; i++ ) {
if ( revs[ i ].getTags().indexOf( tagName ) !== -1 ) {
$( '[data-revid="' + revs[ i ].id + '"]' ).parent()
.addClass( 'mw-revslider-revision-filter-highlight' );
}
}
},
/**
* Re-apply filter highlighting from saved state
*
* @private
* @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
*
* @private
*/
removeRevisionFilterHighlighting: function () {
$( '.mw-revslider-revision-wrapper' ).removeClass( 'mw-revslider-revision-filter-highlight' );
},
/**
* Resets filter highlighting from setting state
*
* @private
*/
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
*
* @private
* @param {number} size
* @return {jQuery}
*/
makePageSizeLine: function ( size ) {
return $( '<p>' )
.text( mw.msg( 'revisionslider-page-size', mw.language.convertNumber( size ), size ) )
.prepend( $( '<strong>' ).text( mw.msg( 'revisionslider-label-page-size' ) + mw.msg( 'colon-separator' ) ) );
},
/**
* Generates the HTML for the change size label
*
* @private
* @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;