mediawiki-extensions-Multim.../resources/mmv/mmv.EmbedFileFormatter.js

231 lines
6.5 KiB
JavaScript
Raw Normal View History

/*
* 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();
/**
* @property {mw.mmv.routing.Router} router -
*/
this.router = new mw.mmv.routing.Router();
}
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.getMainText() + 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)
* @param {Function} [formatterFunction] Format function for the text - defaults to whitelisting HTML links, but all else sanitized.
* @return {string} Byline (can contain HTML)
*/
EFFP.getByline = function ( author, source, formatterFunction ) {
var formatter = this;
formatterFunction = formatterFunction || function ( txt ) {
return formatter.htmlUtils.htmlToTextWithLinks( txt );
};
author = author && formatterFunction( author );
source = source && formatterFunction( source );
if ( author && source ) {
return mw.message(
'multimediaviewer-credit',
author,
source
).parse();
} else {
return author || source;
}
};
/**
* Generates the plain text embed code for the image credit line.
* @param {mw.mmv.model.EmbedFileInfo} info
* @return {string}
*/
EFFP.getCreditText = function ( info ) {
var creditText, creditParams,
formatter = this,
titleText = info.imageInfo.title.getNameText(),
titleUrl = this.getLinkUrl( info ),
byline = this.getByline( info.imageInfo.author, info.imageInfo.source, function ( txt ) {
return formatter.htmlUtils.htmlToText( txt );
} );
creditParams = [
'multimediaviewer-text-embed-credit-text-t',
titleText
];
if ( byline ) {
creditParams[0] += 'b';
creditParams.push( byline );
}
if ( info.imageInfo.license ) {
creditParams[0] += 'l';
creditParams.push( this.htmlUtils.htmlToText( info.imageInfo.license.longName ) );
}
creditParams[0] += 's';
creditParams.push( info.repoInfo.displayName + ' - ' + titleUrl );
creditText = mw.message.apply( mw, creditParams ).plain();
return creditText;
};
/**
* Generates the HTML embed code for the image credit line.
* @param {mw.mmv.model.EmbedFileInfo} info
* @return {string}
*/
EFFP.getCreditHtml = function ( info ) {
var creditText, 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 );
creditParams = [
'multimediaviewer-html-embed-credit-text-t',
this.htmlUtils.jqueryToHtml( $title )
];
if ( byline ) {
creditParams[0] += 'b';
creditParams.push( byline );
}
if ( info.imageInfo.license ) {
creditParams[0] += 'l';
creditParams.push( info.imageInfo.license.getShortLink() );
}
creditParams[0] += 's';
creditParams.push( this.getSiteLink( info ) );
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 )
)
);
};
/**
* Generate a link which we will be using for sharing stuff.
* @param {mw.mmv.model.EmbedFileInfo} info
*/
EFFP.getLinkUrl = function ( info ) {
var route = new mw.mmv.routing.ThumbnailRoute( info.imageInfo.title );
return this.router.createHashedUrl( route, info.imageInfo.descriptionUrl );
};
mw.mmv.EmbedFileFormatter = EmbedFileFormatter;
}( mediaWiki, jQuery ) );