includes/specials/formfields/Licenses.php

   1 <?php
   2 /**
   3  * License selector for use on Special:Upload.
   4  *
   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.
   9  *
  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.
  14  *
  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
  19  *
  20  * @file
  21  * @ingroup SpecialPage
  22  * @author Ævar Arnfjörð Bjarmason <avarab@gmail.com>
  23  * @copyright Copyright © 2005, Ævar Arnfjörð Bjarmason
  24  */
  25
  26 use MediaWiki\MediaWikiServices;
  27
  28 /**
  29  * A License class for use on Special:Upload
  30  */
  31 class Licenses extends HTMLFormField {
  32         /** @var string */
  33         protected $msg;
  34
  35         /** @var array */
  36         protected $lines = [];
  37
  38         /** @var string */
  39         protected $html;
  40
  41         /** @var string|null */
  42         protected $selected;
  43         /** #@- */
  44
  45         /**
  46          * @param array $params
  47          */
  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
  57         /**
  58          * @param array $params
  59          * @return string
  60          */
  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
  82         /**
  83          * @param string $line
  84          * @return License
  85          */
  86         protected function buildLine( $line ) {
  87                 return new License( $line );
  88         }
  89
  90         /**
  91          * @private
  92          */
  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
 120         /**
 121          * @param string $str
 122          * @return array
 123          */
 124         protected function trimStars( $str ) {
 125                 $numStars = strspn( $str, '*' );
 126                 return [ $numStars, ltrim( substr( $str, $numStars ), ' ' ) ];
 127         }
 128
 129         /**
 130          * @param array &$list
 131          * @param array $path
 132          * @param mixed $item
 133          */
 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
 144         /**
 145          * @param array $tagset
 146          * @param int $depth
 147          * @return string
 148          */
 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
 175         /**
 176          * @param string $message
 177          * @param string $value
 178          * @param null|array $attribs
 179          * @param int $depth
 180          * @return string
 181          */
 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
 194         /** #@- */
 195
 196         /**
 197          * Accessor for $this->lines
 198          *
 199          * @return array
 200          */
 201         public function getLines() {
 202                 return $this->lines;
 203         }
 204
 205         /**
 206          * Accessor for $this->lines
 207          *
 208          * @return array
 209          *
 210          * @deprecated since 1.31 Use getLines() instead
 211          */
 212         public function getLicenses() {
 213                 return $this->getLines();
 214         }
 215
 216         /**
 217          * @inheritDoc
 218          */
 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 }