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
|
/*
* 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 LP;
/**
* Class for storing license information about an image. For available fields, see
* TemplateParser::$licenseFieldClasses in the CommonsMetadata extension.
*
* @class mw.mmv.model.License
* @param {string} shortName see {@link #shortName}
* @param {string} [internalName] see {@link #internalName}
* @param {string} [longName] see {@link #longName}
* @param {string} [deedUrl] see {@link #deedUrl}
* @param {boolean} [attributionRequired] see {@link #attributionRequired}
* @param {boolean} [nonFree] see {@link #nonFree}
* @constructor
*/
function License(
shortName,
internalName,
longName,
deedUrl,
attributionRequired,
nonFree
) {
if ( !shortName ) {
throw new Error( 'mw.mmv.model.License: shortName is required' );
}
/** @property {string} shortName short (abbreviated) name of the license (e.g. CC-BY-SA-3.0) */
this.shortName = shortName;
/** @property {string} internalName internal name of the license, used for localization (e.g. cc-by-sa ) */
this.internalName = internalName;
/** @property {string} longName full name of the license (e.g. Creative Commons etc. etc.) */
this.longName = longName;
/** @property {string} deedUrl URL to the description of the license (e.g. the CC deed) */
this.deedUrl = deedUrl;
/** @property {boolean} attributionRequired does the author need to be attributed on reuse? */
this.attributionRequired = attributionRequired;
/** @property {boolean} nonFree is this a non-free license? */
this.nonFree = nonFree;
/** @property {mw.mmv.HtmlUtils} htmlUtils - */
this.htmlUtils = new mw.mmv.HtmlUtils();
}
LP = License.prototype;
/**
* Check whether this is a Creative Commons license.
*
* @return {boolean}
*/
LP.isCc = function () {
return this.internalName ? this.internalName.substr( 0, 2 ) === 'cc' : false;
};
/**
* Check whether this is a public domain "license".
*
* @return {boolean}
*/
LP.isPd = function () {
return this.internalName === 'pd';
};
/**
* Check whether this is a free license.
*
* @return {boolean}
*/
LP.isFree = function () {
// licenses with missing nonfree information are assumed free
return !this.nonFree;
};
/**
* Check whether reusers need to attribute the author
*
* @return {boolean}
*/
LP.needsAttribution = function () {
// to be on the safe side, if the attribution required flag is not set, it is assumed to be true
return !this.isPd() && this.attributionRequired !== false;
};
/**
* Returns the short name of the license:
* - if we have interface messages for this license (basically just CC and PD), use those
* - otherwise use the short name from the license template (might or might not be translated
* still, depending on how the template is set up)
*
* @return {string}
* FIXME a model should not depend on an i18n class. We should probably use view models.
*/
LP.getShortName = function () {
var message = 'multimediaviewer-license-' + ( this.internalName || '' );
if ( mw.messages.exists( message ) ) {
return mw.message( message ).text();
} else {
return this.shortName;
}
};
/**
* Returns a short HTML representation of the license.
*
* @return {string}
*/
LP.getShortLink = function () {
var shortName = this.getShortName();
if ( this.deedUrl ) {
return this.htmlUtils.makeLinkText( shortName, {
href: this.deedUrl,
title: this.longName || shortName
} );
} else {
return shortName;
}
};
mw.mmv.model.License = License;
}( mediaWiki ) );
|
