3 * License selector for use on Special:Upload.
5 * This program is free software; you can redistribute it and/or modify
6 * it under the terms of the GNU General Public License as published by
7 * the Free Software Foundation; either version 2 of the License, or
8 * (at your option) any later version.
10 * This program is distributed in the hope that it will be useful,
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 * GNU General Public License for more details.
15 * You should have received a copy of the GNU General Public License along
16 * with this program; if not, write to the Free Software Foundation, Inc.,
17 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
18 * http://www.gnu.org/copyleft/gpl.html
21 * @ingroup SpecialPage
22 * @author Ævar Arnfjörð Bjarmason <avarab@gmail.com>
23 * @copyright Copyright © 2005, Ævar Arnfjörð Bjarmason
26 use MediaWiki\MediaWikiServices
;
29 * A License class for use on Special:Upload
31 class Licenses
extends HTMLFormField
{
36 protected $lines = [];
41 /** @var string|null */
46 * @param array $params
48 public function __construct( $params ) {
49 parent
::__construct( $params );
51 $this->msg
= static::getMessageFromParams( $params );
52 $this->selected
= null;
58 * @param array $params
61 protected static function getMessageFromParams( $params ) {
62 if ( !empty( $params['licenses'] ) ) {
63 return $params['licenses'];
66 // If the licenses page is in $wgForceUIMsgAsContentMsg (which is the case
67 // on Commons), translations will be in the database, in subpages of this
68 // message (e.g. MediaWiki:Licenses/<lang>)
69 // If there is no such translation, the result will be '-' (the empty default
70 // in the i18n files), so we'll need to force it to look up the actual licenses
71 // in the default site language (= get the translation from MediaWiki:Licenses)
72 // Also see https://phabricator.wikimedia.org/T3495
73 $defaultMsg = wfMessage( 'licenses' )->inContentLanguage();
74 if ( !$defaultMsg->exists() ||
$defaultMsg->plain() === '-' ) {
75 $defaultMsg = wfMessage( 'licenses' )->inLanguage(
76 MediaWikiServices
::getInstance()->getContentLanguage() );
79 return $defaultMsg->plain();
86 protected function buildLine( $line ) {
87 return new License( $line );
93 protected function makeLines() {
95 $lines = explode( "\n", $this->msg
);
97 foreach ( $lines as $line ) {
98 if ( strpos( $line, '*' ) !== 0 ) {
101 list( $level, $line ) = $this->trimStars( $line );
103 if ( strpos( $line, '|' ) !== false ) {
104 $obj = $this->buildLine( $line );
105 $this->stackItem( $this->lines
, $levels, $obj );
107 if ( $level < count( $levels ) ) {
108 $levels = array_slice( $levels, 0, $level );
110 if ( $level == count( $levels ) ) {
111 $levels[$level - 1] = $line;
112 } elseif ( $level > count( $levels ) ) {
124 protected function trimStars( $str ) {
125 $numStars = strspn( $str, '*' );
126 return [ $numStars, ltrim( substr( $str, $numStars ), ' ' ) ];
130 * @param array &$list
134 protected function stackItem( &$list, $path, $item ) {
137 foreach ( $path as $key ) {
138 $position =& $position[$key];
145 * @param array $tagset
149 protected function makeHtml( $tagset, $depth = 0 ) {
152 foreach ( $tagset as $key => $val ) {
153 if ( is_array( $val ) ) {
154 $html .= $this->outputOption(
157 'disabled' => 'disabled',
158 'style' => 'color: GrayText', // for MSIE
162 $html .= $this->makeHtml( $val, $depth +
1 );
164 $html .= $this->outputOption(
165 $val->text
, $val->template
,
166 [ 'title' => '{{' . $val->template
. '}}' ],
176 * @param string $message
177 * @param string $value
178 * @param null|array $attribs
182 protected function outputOption( $message, $value, $attribs = null, $depth = 0 ) {
183 $msgObj = $this->msg( $message );
184 $text = $msgObj->exists() ?
$msgObj->text() : $message;
185 $attribs['value'] = $value;
186 if ( $value === $this->selected
) {
187 $attribs['selected'] = 'selected';
190 $val = str_repeat( /*   */ "\u{00A0}", $depth * 2 ) . $text;
191 return str_repeat( "\t", $depth ) . Xml
::element( 'option', $attribs, $val ) . "\n";
197 * Accessor for $this->lines
201 public function getLines() {
206 * Accessor for $this->lines
210 * @deprecated since 1.31 Use getLines() instead
212 public function getLicenses() {
213 return $this->getLines();
219 public function getInputHTML( $value ) {
220 $this->selected
= $value;
222 // add a default "no license selected" option
223 $default = $this->buildLine( '|nolicense' );
224 array_unshift( $this->lines
, $default );
226 $html = $this->makeHtml( $this->getLines() );
229 'name' => $this->mName
,
232 if ( !empty( $this->mParams
['disabled'] ) ) {
233 $attribs['disabled'] = 'disabled';
236 $html = Html
::rawElement( 'select', $attribs, $html );
238 // remove default "no license selected" from lines again
239 array_shift( $this->lines
);