MediaWiki master
Licenses.php
Go to the documentation of this file.
1<?php
29
33class Licenses extends HTMLFormField {
35 protected $msg;
36
38 protected $lines = [];
39
41 protected $html;
42
44 protected $selected;
45
49 public function __construct( $params ) {
50 parent::__construct( $params );
51
52 $this->msg = static::getMessageFromParams( $params );
53 $this->selected = null;
54
55 $this->makeLines();
56 }
57
62 protected static function getMessageFromParams( $params ) {
63 if ( !empty( $params['licenses'] ) ) {
64 return $params['licenses'];
65 }
66
67 // If the licenses page is in $wgForceUIMsgAsContentMsg (which is the case
68 // on Commons), translations will be in the database, in subpages of this
69 // message (e.g. MediaWiki:Licenses/<lang>)
70 // If there is no such translation, the result will be '-' (the empty default
71 // in the i18n files), so we'll need to force it to look up the actual licenses
72 // in the default site language (= get the translation from MediaWiki:Licenses)
73 // Also see https://phabricator.wikimedia.org/T3495
74 $defaultMsg = wfMessage( 'licenses' )->inContentLanguage();
75 if ( $defaultMsg->isDisabled() ) {
76 $defaultMsg = wfMessage( 'licenses' )->inLanguage(
77 MediaWikiServices::getInstance()->getContentLanguage() );
78 }
79
80 return $defaultMsg->plain();
81 }
82
87 protected function buildLine( $line ) {
88 return new License( $line );
89 }
90
94 protected function makeLines() {
95 $levels = [];
96 $lines = explode( "\n", $this->msg );
97
98 foreach ( $lines as $line ) {
99 if ( !str_starts_with( $line, '*' ) ) {
100 continue;
101 }
102 [ $level, $line ] = $this->trimStars( $line );
103
104 if ( str_contains( $line, '|' ) ) {
105 $obj = $this->buildLine( $line );
106 $this->stackItem( $this->lines, $levels, $obj );
107 } else {
108 if ( $level < count( $levels ) ) {
109 $levels = array_slice( $levels, 0, $level );
110 }
111 if ( $level == count( $levels ) ) {
112 $levels[$level - 1] = $line;
113 } elseif ( $level > count( $levels ) ) {
114 $levels[] = $line;
115 }
116 }
117 }
118 }
119
124 protected function trimStars( $str ) {
125 $numStars = strspn( $str, '*' );
126 return [ $numStars, ltrim( substr( $str, $numStars ), ' ' ) ];
127 }
128
134 protected function stackItem( &$list, $path, $item ) {
135 $position =& $list;
136 if ( $path ) {
137 foreach ( $path as $key ) {
138 $position =& $position[$key];
139 }
140 }
141 $position[] = $item;
142 }
143
149 protected function makeHtml( $tagset, $depth = 0 ) {
150 $html = '';
151
152 foreach ( $tagset as $key => $val ) {
153 if ( is_array( $val ) ) {
154 $html .= $this->outputOption(
155 $key, '',
156 [
157 'disabled' => 'disabled',
158 'style' => 'color: GrayText', // for MSIE
159 ],
160 $depth
161 );
162 $html .= $this->makeHtml( $val, $depth + 1 );
163 } else {
164 $html .= $this->outputOption(
165 $val->text, $val->template,
166 [ 'title' => '{{' . $val->template . '}}' ],
167 $depth
168 );
169 }
170 }
171
172 return $html;
173 }
174
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 && !isset( $attribs['disabled'] ) ) {
187 $attribs['selected'] = 'selected';
188 }
189
190 $val = str_repeat( /* &nbsp */ "\u{00A0}", $depth * 2 ) . $text;
191 return str_repeat( "\t", $depth ) . Html::element( 'option', $attribs, $val ) . "\n";
192 }
193
199 public function getLines() {
200 return $this->lines;
201 }
202
210 public function getLicenses() {
211 return $this->getLines();
212 }
213
217 public function getInputHTML( $value ) {
218 $this->selected = $value;
219
220 // add a default "no license selected" option
221 $default = $this->buildLine( '|nolicense' );
222 array_unshift( $this->lines, $default );
223
224 $html = $this->makeHtml( $this->getLines() );
225
226 $attribs = [
227 'name' => $this->mName,
228 'id' => $this->mID
229 ];
230 if ( !empty( $this->mParams['disabled'] ) ) {
231 $attribs['disabled'] = 'disabled';
232 }
233
234 $html = Html::rawElement( 'select', $attribs, $html );
235
236 // remove default "no license selected" from lines again
237 array_shift( $this->lines );
238
239 return $html;
240 }
241}
wfMessage( $key,... $params)
This is the function for getting translated interface messages.
A License class for use on Special:Upload (represents a single type of license).
Definition License.php:30
A License class for use on Special:Upload.
Definition Licenses.php:33
makeLines()
Definition Licenses.php:94
string $html
Definition Licenses.php:41
__construct( $params)
Definition Licenses.php:49
string null $selected
Definition Licenses.php:44
buildLine( $line)
Definition Licenses.php:87
makeHtml( $tagset, $depth=0)
Definition Licenses.php:149
string $msg
Definition Licenses.php:35
static getMessageFromParams( $params)
Definition Licenses.php:62
outputOption( $message, $value, $attribs=null, $depth=0)
Definition Licenses.php:182
getLicenses()
Accessor for $this->lines.
Definition Licenses.php:210
array $lines
Definition Licenses.php:38
getLines()
Accessor for $this->lines.
Definition Licenses.php:199
stackItem(&$list, $path, $item)
Definition Licenses.php:134
getInputHTML( $value)
This function must be implemented to return the HTML to generate the input object itself....
Definition Licenses.php:217
trimStars( $str)
Definition Licenses.php:124
The parent class to generate form fields.
msg( $key,... $params)
Get a translated interface message.
This class is a collection of static functions that serve two purposes:
Definition Html.php:56
Service locator for MediaWiki core services.