1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
|
/*
* 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]
* @param {string} [alt]
* @return {string}
*/
EFFP.getThumbnailWikitext = function ( title, width, caption, alt ) {
var widthSection, captionSection, altSection;
widthSection = width ? '|' + width + 'px' : '';
captionSection = caption ? '|' + caption : '';
altSection = alt ? '|alt=' + alt : '';
return '[[File:' + title.getMainText() + widthSection + '|thumb' + captionSection + altSection + ']]';
};
/**
* 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 ), info.alt );
};
/**
* Byline construction
*
* @param {string} [author] author name (can contain HTML)
* @param {string} [source] source name (can contain HTML)
* @param {string} [attribution] custom attribution line (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, attribution, formatterFunction ) {
var formatter = this;
formatterFunction = formatterFunction || function ( txt ) {
return formatter.htmlUtils.htmlToTextWithLinks( txt );
};
if ( attribution ) {
attribution = attribution && formatterFunction( attribution );
return attribution;
} else {
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,
shortURL = info.imageInfo.descriptionShortUrl,
license = info.imageInfo.license,
byline = this.getByline( info.imageInfo.author, info.imageInfo.source, info.imageInfo.attribution, function ( txt ) {
return formatter.htmlUtils.htmlToText( txt );
} );
// If both the byline and licence are missing, the credit text is simply the URL
if ( !byline && !license ) {
return shortURL;
}
creditParams = [
'multimediaviewer-text-embed-credit-text-'
];
if ( byline ) {
creditParams[ 0 ] += 'b';
creditParams.push( byline );
}
if ( license ) {
creditParams[ 0 ] += 'l';
creditParams.push( this.htmlUtils.htmlToText( license.getShortName() ) );
}
creditParams.push( shortURL );
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,
shortURL = info.imageInfo.descriptionShortUrl,
shortLink = this.htmlUtils.makeLinkText( mw.message( 'multimediaviewer-html-embed-credit-link-text' ), { href: shortURL } ),
license = info.imageInfo.license,
byline = this.getByline( info.imageInfo.author, info.imageInfo.source, info.imageInfo.attribution );
if ( !byline && !license ) {
return shortLink;
}
creditParams = [
'multimediaviewer-html-embed-credit-text-'
];
if ( byline ) {
creditParams[ 0 ] += 'b';
creditParams.push( byline );
}
if ( license ) {
creditParams[ 0 ] += 'l';
creditParams.push( license.getShortLink() );
}
creditParams.push( shortLink );
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.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
* @return {string} URL
*/
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 ) );
|
