MediaWiki  master
Licenses.php
Go to the documentation of this file.
1 <?php
27 
31 class Licenses extends HTMLFormField {
33  protected $msg;
34 
36  protected $lines = [];
37 
39  protected $html;
40 
42  protected $selected;
48  public function __construct( $params ) {
49  parent::__construct( $params );
50 
51  $this->msg = static::getMessageFromParams( $params );
52  $this->selected = null;
53 
54  $this->makeLines();
55  }
56 
61  protected static function getMessageFromParams( $params ) {
62  if ( !empty( $params['licenses'] ) ) {
63  return $params['licenses'];
64  }
65 
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() );
77  }
78 
79  return $defaultMsg->plain();
80  }
81 
86  protected function buildLine( $line ) {
87  return new License( $line );
88  }
89 
93  protected function makeLines() {
94  $levels = [];
95  $lines = explode( "\n", $this->msg );
96 
97  foreach ( $lines as $line ) {
98  if ( strpos( $line, '*' ) !== 0 ) {
99  continue;
100  } else {
101  list( $level, $line ) = $this->trimStars( $line );
102 
103  if ( strpos( $line, '|' ) !== false ) {
104  $obj = $this->buildLine( $line );
105  $this->stackItem( $this->lines, $levels, $obj );
106  } else {
107  if ( $level < count( $levels ) ) {
108  $levels = array_slice( $levels, 0, $level );
109  }
110  if ( $level == count( $levels ) ) {
111  $levels[$level - 1] = $line;
112  } elseif ( $level > count( $levels ) ) {
113  $levels[] = $line;
114  }
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 ) {
187  $attribs['selected'] = 'selected';
188  }
189 
190  $val = str_repeat( /* &nbsp */ "\u{00A0}", $depth * 2 ) . $text;
191  return str_repeat( "\t", $depth ) . Xml::element( 'option', $attribs, $val ) . "\n";
192  }
193 
201  public function getLines() {
202  return $this->lines;
203  }
204 
212  public function getLicenses() {
213  return $this->getLines();
214  }
215 
219  public function getInputHTML( $value ) {
220  $this->selected = $value;
221 
222  // add a default "no license selected" option
223  $default = $this->buildLine( '|nolicense' );
224  array_unshift( $this->lines, $default );
225 
226  $html = $this->makeHtml( $this->getLines() );
227 
228  $attribs = [
229  'name' => $this->mName,
230  'id' => $this->mID
231  ];
232  if ( !empty( $this->mParams['disabled'] ) ) {
233  $attribs['disabled'] = 'disabled';
234  }
235 
236  $html = Html::rawElement( 'select', $attribs, $html );
237 
238  // remove default "no license selected" from lines again
239  array_shift( $this->lines );
240 
241  return $html;
242  }
243 }
Licenses\trimStars
trimStars( $str)
Definition: Licenses.php:124
MediaWiki\MediaWikiServices
MediaWikiServices is the service locator for the application scope of MediaWiki.
Definition: MediaWikiServices.php:129
Licenses\getLines
getLines()
#-
Definition: Licenses.php:201
Licenses\$selected
string null $selected
Definition: Licenses.php:42
Licenses\stackItem
stackItem(&$list, $path, $item)
Definition: Licenses.php:134
Licenses\makeLines
makeLines()
Definition: Licenses.php:93
wfMessage
wfMessage( $key,... $params)
This is the function for getting translated interface messages.
Definition: GlobalFunctions.php:1263
Licenses\$html
string $html
Definition: Licenses.php:39
Licenses\getInputHTML
getInputHTML( $value)
This function must be implemented to return the HTML to generate the input object itself....
Definition: Licenses.php:219
Licenses
A License class for use on Special:Upload.
Definition: Licenses.php:31
Licenses\$msg
string $msg
Definition: Licenses.php:33
Licenses\getLicenses
getLicenses()
Accessor for $this->lines.
Definition: Licenses.php:212
HTMLFormField\$mName
$mName
Definition: HTMLFormField.php:13
Licenses\makeHtml
makeHtml( $tagset, $depth=0)
Definition: Licenses.php:149
HTMLFormField
The parent class to generate form fields.
Definition: HTMLFormField.php:7
Xml\element
static element( $element, $attribs=null, $contents='', $allowShortTag=true)
Format an XML element with given attributes and, optionally, text content.
Definition: Xml.php:41
Licenses\$lines
array $lines
Definition: Licenses.php:36
Licenses\outputOption
outputOption( $message, $value, $attribs=null, $depth=0)
Definition: Licenses.php:182
HTMLFormField\$mID
$mID
Definition: HTMLFormField.php:16
License
A License class for use on Special:Upload (represents a single type of license).
Definition: License.php:30
$line
$line
Definition: mcc.php:119
Licenses\buildLine
buildLine( $line)
Definition: Licenses.php:86
Licenses\__construct
__construct( $params)
#-
Definition: Licenses.php:48
$path
$path
Definition: NoLocalSettings.php:25
HTMLFormField\msg
msg( $key,... $params)
Get a translated interface message.
Definition: HTMLFormField.php:83
Licenses\getMessageFromParams
static getMessageFromParams( $params)
Definition: Licenses.php:61