mirror of
https://gerrit.wikimedia.org/r/mediawiki/extensions/MultimediaViewer
synced 2024-09-29 13:17:35 +00:00
b9b1529e9b
Adds site link, license link and long name, replaces internal license name (we don't have it for most licenses) with short name. Also fixes some problems in previous changesets that I stumbled on, renames things to be more consistent/less misleading, and makes EmbedFileInfo a thin container for existing classes. (That results in a lot of Demeter's law violations, but it means one less model to remember, which is a good thing since our property names are often not very informative (e.g. EmbedFileInfo.url and Image.url which had completely different meanings)) We always have the site information for embed texts (comes from the repo API); that part of the tests was pointless, but now that EmbedFileInfo depends on Repo they became impossible to maintain, hence the deletion of half the test cases in getThumbnailHtml(). Change-Id: I94e1d0aca14e2a7d5fad983412090add8ad6bfa3 Mingle: https://wikimedia.mingle.thoughtworks.com/projects/multimedia/cards/369
178 lines
5 KiB
JavaScript
178 lines
5 KiB
JavaScript
/*
|
|
* This file is part of the MediaWiki extension MediaViewer.
|
|
*
|
|
* MediaViewer 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.
|
|
*
|
|
* MediaViewer 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 MediaViewer. If not, see <http://www.gnu.org/licenses/>.
|
|
*/
|
|
|
|
( function( mw, $ ) {
|
|
var EFFP;
|
|
|
|
/**
|
|
* Converts data in various formats needed by the Embed sub-dialog
|
|
* @class mw.mmv.EmbedFileFormatter
|
|
* @constructor
|
|
*/
|
|
function EmbedFileFormatter() {
|
|
/** @property {mw.mmv.HtmlUtils} htmlUtils - */
|
|
this.htmlUtils = new mw.mmv.HtmlUtils();
|
|
}
|
|
EFFP = EmbedFileFormatter.prototype;
|
|
|
|
/**
|
|
* Returns the caption of the image (possibly a fallback generated from image metadata).
|
|
* @param {mw.mmv.model.EmbedFileInfo} info
|
|
* @return {string}
|
|
*/
|
|
EFFP.getCaption = function ( info ) {
|
|
if ( info.caption ) {
|
|
return this.htmlUtils.htmlToText( info.caption );
|
|
} else {
|
|
return info.imageInfo.title.getNameText();
|
|
}
|
|
};
|
|
|
|
/**
|
|
* Helper function to generate thumbnail wikicode
|
|
* @param {mw.Title} title
|
|
* @param {number} [width]
|
|
* @param {string} [caption]
|
|
* @return {string}
|
|
*/
|
|
EFFP.getThumbnailWikitext = function ( title, width, caption ) {
|
|
var widthSection, captionSection;
|
|
|
|
|
|
widthSection = width ? '|' + width + 'px' : '';
|
|
captionSection = caption ? '|' + caption : '';
|
|
|
|
return '[[File:' + title.getMain() + widthSection + '|thumb' + captionSection + ']]';
|
|
};
|
|
|
|
/**
|
|
* Helper function to generate thumbnail wikicode
|
|
* @param {mw.mmv.model.EmbedFileInfo} info
|
|
* @param {number} [width]
|
|
* @return {string}
|
|
*/
|
|
EFFP.getThumbnailWikitextFromEmbedFileInfo = function ( info, width ) {
|
|
return this.getThumbnailWikitext( info.imageInfo.title, width, this.getCaption( info ) );
|
|
};
|
|
|
|
/**
|
|
* Byline construction
|
|
* @param {string} [author] author name (can contain HTML)
|
|
* @param {string} [source] source name (can contain HTML)
|
|
* @return {string} byline (can contain HTML)
|
|
*/
|
|
EFFP.getByline = function ( author, source ) {
|
|
if ( author && source) {
|
|
return mw.message(
|
|
'multimediaviewer-credit',
|
|
author,
|
|
source
|
|
).parse();
|
|
} else {
|
|
return author || source;
|
|
}
|
|
};
|
|
|
|
/**
|
|
* Generates the HTML embed code for the image credit line.
|
|
* @param {mw.mmv.model.EmbedFileInfo} info
|
|
* @return {string}
|
|
*/
|
|
EFFP.getCreditHtml = function ( info ) {
|
|
var creditText, creditFormat, creditParams,
|
|
titleText = info.imageInfo.title.getNameText(),
|
|
titleUrl = this.getLinkUrl( info ),
|
|
$title = $( '<a>' ).text( titleText ).prop( 'href', titleUrl ),
|
|
byline = this.getByline( info.imageInfo.author, info.imageInfo.source );
|
|
|
|
creditFormat = 't';
|
|
creditParams = [ this.htmlUtils.jqueryToHtml( $title ) ];
|
|
if ( byline ) {
|
|
creditFormat += 'b';
|
|
creditParams.push( byline );
|
|
}
|
|
if ( info.imageInfo.license ) {
|
|
creditFormat += 'l';
|
|
creditParams.push( info.imageInfo.license.getShortLink() );
|
|
}
|
|
creditFormat += 's';
|
|
creditParams.push( this.getSiteLink( info ) );
|
|
|
|
creditParams.unshift( 'multimediaviewer-html-embed-credit-text-' + creditFormat );
|
|
creditText = mw.message.apply( mw, creditParams ).plain();
|
|
|
|
return creditText;
|
|
};
|
|
|
|
/**
|
|
* Returns HTML code for a link to the site of the image.
|
|
* @param {mw.mmv.model.EmbedFileInfo} info
|
|
* @return {string}
|
|
*/
|
|
EFFP.getSiteLink = function ( info ) {
|
|
var siteName = info.repoInfo.displayName,
|
|
siteUrl = info.repoInfo.getSiteLink();
|
|
|
|
if ( siteUrl ) {
|
|
return this.htmlUtils.jqueryToHtml(
|
|
$( '<a>' ).prop( 'href', siteUrl ).text( siteName )
|
|
);
|
|
} else {
|
|
return siteName;
|
|
}
|
|
};
|
|
|
|
/**
|
|
* Generates the HTML embed code for the image.
|
|
*
|
|
* @param {mw.mmv.model.EmbedFileInfo} info
|
|
* @param {string} imgUrl URL to the file itself.
|
|
* @param {number} [width] Width to put into the image element.
|
|
* @param {number} [height] Height to put into the image element.
|
|
* @return {string} Embed code.
|
|
*/
|
|
EFFP.getThumbnailHtml = function ( info, imgUrl, width, height ) {
|
|
return this.htmlUtils.jqueryToHtml(
|
|
$( '<p>' ).append(
|
|
$( '<a>' )
|
|
.attr( 'href', this.getLinkUrl( info ) )
|
|
.append(
|
|
$( '<img>' )
|
|
.attr( 'src', imgUrl )
|
|
.attr( 'alt', info.imageInfo.title.getMainText() )
|
|
.attr( 'height', height )
|
|
.attr( 'width', width )
|
|
),
|
|
$( '<br>' ),
|
|
this.getCreditHtml( info )
|
|
)
|
|
);
|
|
};
|
|
|
|
/**
|
|
* Generare a link which we will be using for sharing stuff.
|
|
* FIXME this should be handled by mmv.js to be DRY
|
|
*
|
|
* @param {mw.mmv.model.EmbedFileInfo} info
|
|
*/
|
|
EFFP.getLinkUrl = function ( info ) {
|
|
return info.imageInfo.descriptionUrl + '#mediaviewer/' + info.imageInfo.title.getMainText();
|
|
};
|
|
|
|
mw.mmv.EmbedFileFormatter = EmbedFileFormatter;
|
|
}( mediaWiki, jQuery ) );
|