/*
* This file is part of the MediaWiki extension MultimediaViewer.
*
* MultimediaViewer is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation, either version 2 of the License, or
* (at your option) any later version.
*
* MultimediaViewer is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with MultimediaViewer. If not, see
' ) .addClass( 'mw-mmv-download-attribution-cta-header' ) .text( mw.message( 'multimediaviewer-download-attribution-cta-header' ).text() ); this.$attributionCta = $( '
' ) .addClass( 'mw-mmv-download-attribution-cta-invite' ) .text( mw.message( 'multimediaviewer-download-attribution-cta' ).text() ) ) .appendTo( this.$attributionSection ); this.attributionInput = attributionInput; this.$attributionHowHeader = $( '
' ) .addClass( 'mw-mmv-download-attribution-how-header' ) .text( mw.message( 'multimediaviewer-download-attribution-cta-header' ).text() ); this.$attributionHow = $( '
' ) .addClass( 'mw-mmv-download-attribution-close-button' ) .on( 'click', ( e ) => { this.$container.trigger( 'mmv-download-cta-close' ); this.$attributionSection.addClass( 'mw-mmv-download-attribution-collapsed' ); e.stopPropagation(); } ) .text( ' ' ) ) .appendTo( this.$attributionSection ); } /** * Selects the specified attribution type. * * @param {string} [name='plain'] The attribution type to use ('plain' or 'html') */ selectAttribution( name ) { this.currentAttrView = name; if ( this.currentAttrView === 'html' ) { this.attributionInput.textInput.setValue( this.htmlCredit ); } else { this.attributionInput.textInput.setValue( this.textCredit ); } } /** * Registers listeners. */ attach() { // Register handlers for switching between file sizes this.downloadSizeMenu.getMenu().on( 'choose', ( item ) => this.handleSizeSwitch( item ) ); this.$selectionArrow.on( 'click', () => this.downloadSizeMenu.getMenu().toggle() ); } /** * Clears listeners. */ unattach() { super.unattach(); this.downloadSizeMenu.getMenu().off( 'choose' ); this.$selectionArrow.off( 'click' ); } /** * Handles size menu change events. * * @param {OO.ui.MenuOptionWidget} item */ handleSizeSwitch( item ) { const value = item.getData(); if ( value.name === 'original' && this.image !== null ) { this.setDownloadUrl( this.image.url ); this.setButtonText( value.name, this.getExtensionFromUrl( this.image.url ), value.width, value.height ); } else { // Disable download while we get the image this.$downloadButton.addClass( 'disabledLink' ); // Set a temporary message. It will be updated once we have the file type. this.setButtonText( value.name, this.imageExtension, value.width, value.height ); this.utils.getThumbnailUrlPromise( value.width ).done( ( thumbnail ) => { this.setDownloadUrl( thumbnail.url ); this.setButtonText( value.name, this.getExtensionFromUrl( thumbnail.url ), value.width, value.height ); } ); } } /** * Sets the URL on the download button. * * @param {string} url */ setDownloadUrl( url ) { this.$downloadButton.attr( 'href', `${ url }?download` ); this.$previewLink.attr( 'href', url ); // Re-enable download this.$downloadButton.removeClass( 'disabledLink' ); } /** * Sets the text of the download button. * * @param {string} sizeClass A size class such as 'small' * @param {string} extension file extension * @param {number} width * @param {number} height */ setButtonText( sizeClass, extension, width, height ) { // The following messages are used here: // * multimediaviewer-download-original-button-name // * multimediaviewer-download-small-button-name // * multimediaviewer-download-medium-button-name // * multimediaviewer-download-large-button-name // * multimediaviewer-download-xl-button-name const sizeClassMessage = mw.message( `multimediaviewer-download-${ sizeClass }-button-name` ).text(); const dimensionMessage = mw.message( 'multimediaviewer-embed-dimensions', width, height ).text(); const sizeMessage = mw.message( 'multimediaviewer-embed-dimensions-with-file-format', dimensionMessage, extension ).text(); // Update button label and size strings to reflect new selected size this.$downloadButton.html( `${ sizeClassMessage }` + `${ sizeMessage }` ); } /** * Sets the text in the attribution input element. * * @param {Object} embed * @param {Image} embed.imageInfo * @param {Repo} embed.repoInfo */ setAttributionText( embed ) { this.htmlCredit = this.formatter.getCreditHtml( embed ); this.textCredit = this.formatter.getCreditText( embed ); this.selectAttribution( this.currentAttrView ); } /** * Chops off the extension part of an URL. * * @param {string} url URL * @return {string} Extension */ getExtensionFromUrl( url ) { const urlParts = url.split( '.' ); return urlParts[ urlParts.length - 1 ]; } /** * Sets the data on the element. * * @param {Image} image * @param {Repo} repo */ set( image, repo ) { const license = image && image.license; const sizeOptions = this.downloadSizeMenu.getMenu().getItems(); const sizes = this.utils.getPossibleImageSizesForHtml( image.width, image.height ); this.image = image; this.utils.updateMenuOptions( sizes, sizeOptions ); this.downloadSizeMenu.$element.addClass( 'active' ); // Note: This extension will not be the real one for file types other than: png/gif/jpg/jpeg this.imageExtension = image.title.getExtension().toLowerCase(); // Reset size menu to default item and update download button label now that we have the info this.downloadSizeMenu.getMenu().chooseItem( this.defaultItem ); if ( image && repo ) { const embedFileInfo = { imageInfo: image, repoInfo: repo }; this.setAttributionText( embedFileInfo ); } const attributionCtaMessage = ( license && license.needsAttribution() ) ? 'multimediaviewer-download-attribution-cta-header' : 'multimediaviewer-download-optional-attribution-cta-header'; // Message defined above // eslint-disable-next-line mediawiki/msg-doc this.$attributionCtaHeader.text( mw.message( attributionCtaMessage ).text() ); // eslint-disable-next-line mediawiki/msg-doc this.$attributionHowHeader.text( mw.message( attributionCtaMessage ).text() ); } /** * @inheritdoc */ empty() { this.downloadSizeMenu.getMenu().toggle( false ); this.downloadSizeMenu.$element.removeClass( 'active' ); this.$downloadButton.attr( 'href', '' ); this.$previewLink.attr( 'href', '' ); this.imageExtension = undefined; this.image = null; } } module.exports = DownloadPane; }() );