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 }
Apache License January AND DISTRIBUTION Definitions License shall mean the terms and conditions for and distribution as defined by Sections through of this document Licensor shall mean the copyright owner or entity authorized by the copyright owner that is granting the License Legal Entity shall mean the union of the acting entity and all other entities that control are controlled by or are under common control with that entity For the purposes of this definition control direct or to cause the direction or management of such whether by contract or including but not limited to software source documentation and configuration files Object form shall mean any form resulting from mechanical transformation or translation of a Source including but not limited to compiled object generated and conversions to other media types Work shall mean the work of whether in Source or Object made available under the License
static getMessageFromParams( $params)
Definition: Licenses.php:61
deferred txt A few of the database updates required by various functions here can be deferred until after the result page is displayed to the user For updating the view updating the linked to tables after a etc PHP does not yet have any way to tell the server to actually return and disconnect while still running these but it might have such a feature in the future We handle these by creating a deferred update object and putting those objects on a global list
Definition: deferred.txt:11
getLicenses()
Accessor for $this->lines.
Definition: Licenses.php:212
makeHtml( $tagset, $depth=0)
Definition: Licenses.php:149
trimStars( $str)
Definition: Licenses.php:124
Apache License January AND DISTRIBUTION Definitions License shall mean the terms and conditions for use
msg()
Get a translated interface message.
static rawElement( $element, $attribs=[], $contents='')
Returns an HTML element in a string.
Definition: Html.php:209
string $html
Definition: Licenses.php:39
getLines()
#-
Definition: Licenses.php:201
$value
injection txt This is an overview of how MediaWiki makes use of dependency injection The design described here grew from the discussion of RFC T384 The term dependency this means that anything an object needs to operate should be injected from the the object itself should only know narrow no concrete implementation of the logic it relies on The requirement to inject everything typically results in an architecture that based on two main types of and essentially stateless service objects that use other service objects to operate on the value objects As of the beginning MediaWiki is only starting to use the DI approach Much of the code still relies on global state or direct resulting in a highly cyclical dependency MediaWikiServices
Definition: injection.txt:23
__construct( $params)
#-
Definition: Licenses.php:48
array $lines
Definition: Licenses.php:36
string $msg
Definition: Licenses.php:33
either a unescaped string or a HtmlArmor object after in associative array form externallinks including delete and has completed for all link tables whether this was an auto creation use $formDescriptor instead default is conds Array Extra conditions for the No matching items in log is displayed if loglist is empty msgKey Array If you want a nice box with a set this to the key of the message First element is the message additional optional elements are parameters for the key that are processed with wfMessage() -> params() ->parseAsBlock() - offset Set to overwrite offset parameter in $wgRequest set to '' to unset offset - wrap String Wrap the message in html(usually something like "&lt
outputOption( $message, $value, $attribs=null, $depth=0)
Definition: Licenses.php:182
buildLine( $line)
Definition: Licenses.php:86
makeLines()
Definition: Licenses.php:93
$params
null means default in associative array with keys and values unescaped Should be merged with default with a value of false meaning to suppress the attribute in associative array with keys and values unescaped noclasses just before the function returns a value If you return an< a > element with HTML attributes $attribs and contents $html will be returned If you return $ret will be returned and may include noclasses after processing & $attribs
Definition: hooks.txt:1971
this hook is for auditing only or null if authentication failed before getting that far or null if we can t even determine that When $user is not null
Definition: hooks.txt:767
stackItem(&$list, $path, $item)
Definition: Licenses.php:134
This document is intended to provide useful advice for parties seeking to redistribute MediaWiki to end users It s targeted particularly at maintainers for Linux since it s been observed that distribution packages of MediaWiki often break We ve consistently had to recommend that users seeking support use official tarballs instead of their distribution s and this often solves whatever problem the user is having It would be nice if this could such as
Definition: distributors.txt:9
injection txt This is an overview of how MediaWiki makes use of dependency injection The design described here grew from the discussion of RFC T384 The term dependency this means that anything an object needs to operate should be injected from the the object itself should only know narrow no concrete implementation of the logic it relies on The requirement to inject everything typically results in an architecture that based on two main types of and essentially stateless service objects that use other service objects to operate on the value objects As of the beginning MediaWiki is only starting to use the DI approach Much of the code still relies on global state or direct resulting in a highly cyclical dependency which acts as the top level factory for services in MediaWiki which can be used to gain access to default instances of various services MediaWikiServices however also allows new services to be defined and default services to be redefined Services are defined or redefined by providing a callback the instantiator that will return a new instance of the service When it will create an instance of MediaWikiServices and populate it with the services defined in the files listed by thereby bootstrapping the DI framework Per $wgServiceWiringFiles lists includes ServiceWiring php
Definition: injection.txt:35
A License class for use on Special:Upload.
Definition: Licenses.php:31
$line
Definition: cdb.php:59
static element( $element, $attribs=null, $contents='', $allowShortTag=true)
Format an XML element with given attributes and, optionally, text content.
Definition: Xml.php:41
string null $selected
Definition: Licenses.php:42
getInputHTML( $value)
Definition: Licenses.php:219