includes/htmlform/HTMLFormField.php

   1 <?php
   2
   3 /**
   4  * The parent class to generate form fields.  Any field type should
   5  * be a subclass of this.
   6  */
   7 abstract class HTMLFormField {
   8         public $mParams;
   9
  10         protected $mValidationCallback;
  11         protected $mFilterCallback;
  12         protected $mName;
  13         protected $mDir;
  14         protected $mLabel; # String label, as HTML. Set on construction.
  15         protected $mID;
  16         protected $mClass = '';
  17         protected $mVFormClass = '';
  18         protected $mHelpClass = false;
  19         protected $mDefault;
  20         /**
  21          * @var array|bool|null
  22          */
  23         protected $mOptions = false;
  24         protected $mOptionsLabelsNotFromMessage = false;
  25         protected $mHideIf = null;
  26
  27         /**
  28          * @var bool If true will generate an empty div element with no label
  29          * @since 1.22
  30          */
  31         protected $mShowEmptyLabels = true;
  32
  33         /**
  34          * @var HTMLForm|null
  35          */
  36         public $mParent;
  37
  38         /**
  39          * This function must be implemented to return the HTML to generate
  40          * the input object itself.  It should not implement the surrounding
  41          * table cells/rows, or labels/help messages.
  42          *
  43          * @param string $value The value to set the input to; eg a default
  44          *     text for a text input.
  45          *
  46          * @return string Valid HTML.
  47          */
  48         abstract public function getInputHTML( $value );
  49
  50         /**
  51          * Same as getInputHTML, but returns an OOUI object.
  52          * Defaults to false, which getOOUI will interpret as "use the HTML version"
  53          *
  54          * @param string $value
  55          * @return OOUI\Widget|false
  56          */
  57         public function getInputOOUI( $value ) {
  58                 return false;
  59         }
  60
  61         /**
  62          * True if this field type is able to display errors; false if validation errors need to be
  63          * displayed in the main HTMLForm error area.
  64          * @return bool
  65          */
  66         public function canDisplayErrors() {
  67                 return $this->hasVisibleOutput();
  68         }
  69
  70         /**
  71          * Get a translated interface message
  72          *
  73          * This is a wrapper around $this->mParent->msg() if $this->mParent is set
  74          * and wfMessage() otherwise.
  75          *
  76          * Parameters are the same as wfMessage().
  77          *
  78          * @return Message
  79          */
  80         public function msg() {
  81                 $args = func_get_args();
  82
  83                 if ( $this->mParent ) {
  84                         return $this->mParent->msg( ...$args );
  85                 }
  86                 return wfMessage( ...$args );
  87         }
  88
  89         /**
  90          * If this field has a user-visible output or not. If not,
  91          * it will not be rendered
  92          *
  93          * @return bool
  94          */
  95         public function hasVisibleOutput() {
  96                 return true;
  97         }
  98
  99         /**
 100          * Fetch a field value from $alldata for the closest field matching a given
 101          * name.
 102          *
 103          * This is complex because it needs to handle array fields like the user
 104          * would expect. The general algorithm is to look for $name as a sibling
 105          * of $this, then a sibling of $this's parent, and so on. Keeping in mind
 106          * that $name itself might be referencing an array.
 107          *
 108          * @param array $alldata
 109          * @param string $name
 110          * @return string
 111          */
 112         protected function getNearestFieldByName( $alldata, $name ) {
 113                 $tmp = $this->mName;
 114                 $thisKeys = [];
 115                 while ( preg_match( '/^(.+)\[([^\]]+)\]$/', $tmp, $m ) ) {
 116                         array_unshift( $thisKeys, $m[2] );
 117                         $tmp = $m[1];
 118                 }
 119                 if ( substr( $tmp, 0, 2 ) == 'wp' &&
 120                         !array_key_exists( $tmp, $alldata ) &&
 121                         array_key_exists( substr( $tmp, 2 ), $alldata )
 122                 ) {
 123                         // Adjust for name mangling.
 124                         $tmp = substr( $tmp, 2 );
 125                 }
 126                 array_unshift( $thisKeys, $tmp );
 127
 128                 $tmp = $name;
 129                 $nameKeys = [];
 130                 while ( preg_match( '/^(.+)\[([^\]]+)\]$/', $tmp, $m ) ) {
 131                         array_unshift( $nameKeys, $m[2] );
 132                         $tmp = $m[1];
 133                 }
 134                 array_unshift( $nameKeys, $tmp );
 135
 136                 $testValue = '';
 137                 for ( $i = count( $thisKeys ) - 1; $i >= 0; $i-- ) {
 138                         $keys = array_merge( array_slice( $thisKeys, 0, $i ), $nameKeys );
 139                         $data = $alldata;
 140                         while ( $keys ) {
 141                                 $key = array_shift( $keys );
 142                                 if ( !is_array( $data ) || !array_key_exists( $key, $data ) ) {
 143                                         continue 2;
 144                                 }
 145                                 $data = $data[$key];
 146                         }
 147                         $testValue = (string)$data;
 148                         break;
 149                 }
 150
 151                 return $testValue;
 152         }
 153
 154         /**
 155          * Helper function for isHidden to handle recursive data structures.
 156          *
 157          * @param array $alldata
 158          * @param array $params
 159          * @return bool
 160          * @throws MWException
 161          */
 162         protected function isHiddenRecurse( array $alldata, array $params ) {
 163                 $origParams = $params;
 164                 $op = array_shift( $params );
 165
 166                 try {
 167                         switch ( $op ) {
 168                                 case 'AND':
 169                                         foreach ( $params as $i => $p ) {
 170                                                 if ( !is_array( $p ) ) {
 171                                                         throw new MWException(
 172                                                                 "Expected array, found " . gettype( $p ) . " at index $i"
 173                                                         );
 174                                                 }
 175                                                 if ( !$this->isHiddenRecurse( $alldata, $p ) ) {
 176                                                         return false;
 177                                                 }
 178                                         }
 179                                         return true;
 180
 181                                 case 'OR':
 182                                         foreach ( $params as $i => $p ) {
 183                                                 if ( !is_array( $p ) ) {
 184                                                         throw new MWException(
 185                                                                 "Expected array, found " . gettype( $p ) . " at index $i"
 186                                                         );
 187                                                 }
 188                                                 if ( $this->isHiddenRecurse( $alldata, $p ) ) {
 189                                                         return true;
 190                                                 }
 191                                         }
 192                                         return false;
 193
 194                                 case 'NAND':
 195                                         foreach ( $params as $i => $p ) {
 196                                                 if ( !is_array( $p ) ) {
 197                                                         throw new MWException(
 198                                                                 "Expected array, found " . gettype( $p ) . " at index $i"
 199                                                         );
 200                                                 }
 201                                                 if ( !$this->isHiddenRecurse( $alldata, $p ) ) {
 202                                                         return true;
 203                                                 }
 204                                         }
 205                                         return false;
 206
 207                                 case 'NOR':
 208                                         foreach ( $params as $i => $p ) {
 209                                                 if ( !is_array( $p ) ) {
 210                                                         throw new MWException(
 211                                                                 "Expected array, found " . gettype( $p ) . " at index $i"
 212                                                         );
 213                                                 }
 214                                                 if ( $this->isHiddenRecurse( $alldata, $p ) ) {
 215                                                         return false;
 216                                                 }
 217                                         }
 218                                         return true;
 219
 220                                 case 'NOT':
 221                                         if ( count( $params ) !== 1 ) {
 222                                                 throw new MWException( "NOT takes exactly one parameter" );
 223                                         }
 224                                         $p = $params[0];
 225                                         if ( !is_array( $p ) ) {
 226                                                 throw new MWException(
 227                                                         "Expected array, found " . gettype( $p ) . " at index 0"
 228                                                 );
 229                                         }
 230                                         return !$this->isHiddenRecurse( $alldata, $p );
 231
 232                                 case '===':
 233                                 case '!==':
 234                                         if ( count( $params ) !== 2 ) {
 235                                                 throw new MWException( "$op takes exactly two parameters" );
 236                                         }
 237                                         list( $field, $value ) = $params;
 238                                         if ( !is_string( $field ) || !is_string( $value ) ) {
 239                                                 throw new MWException( "Parameters for $op must be strings" );
 240                                         }
 241                                         $testValue = $this->getNearestFieldByName( $alldata, $field );
 242                                         switch ( $op ) {
 243                                                 case '===':
 244                                                         return ( $value === $testValue );
 245                                                 case '!==':
 246                                                         return ( $value !== $testValue );
 247                                         }
 248
 249                                 default:
 250                                         throw new MWException( "Unknown operation" );
 251                         }
 252                 } catch ( Exception $ex ) {
 253                         throw new MWException(
 254                                 "Invalid hide-if specification for $this->mName: " .
 255                                 $ex->getMessage() . " in " . var_export( $origParams, true ),
 256                                 0, $ex
 257                         );
 258                 }
 259         }
 260
 261         /**
 262          * Test whether this field is supposed to be hidden, based on the values of
 263          * the other form fields.
 264          *
 265          * @since 1.23
 266          * @param array $alldata The data collected from the form
 267          * @return bool
 268          */
 269         public function isHidden( $alldata ) {
 270                 if ( !$this->mHideIf ) {
 271                         return false;
 272                 }
 273
 274                 return $this->isHiddenRecurse( $alldata, $this->mHideIf );
 275         }
 276
 277         /**
 278          * Override this function if the control can somehow trigger a form
 279          * submission that shouldn't actually submit the HTMLForm.
 280          *
 281          * @since 1.23
 282          * @param string|array $value The value the field was submitted with
 283          * @param array $alldata The data collected from the form
 284          *
 285          * @return bool True to cancel the submission
 286          */
 287         public function cancelSubmit( $value, $alldata ) {
 288                 return false;
 289         }
 290
 291         /**
 292          * Override this function to add specific validation checks on the
 293          * field input.  Don't forget to call parent::validate() to ensure
 294          * that the user-defined callback mValidationCallback is still run
 295          *
 296          * @param string|array $value The value the field was submitted with
 297          * @param array $alldata The data collected from the form
 298          *
 299          * @return bool|string|Message True on success, or String/Message error to display, or
 300          *   false to fail validation without displaying an error.
 301          */
 302         public function validate( $value, $alldata ) {
 303                 if ( $this->isHidden( $alldata ) ) {
 304                         return true;
 305                 }
 306
 307                 if ( isset( $this->mParams['required'] )
 308                         && $this->mParams['required'] !== false
 309                         && $value === ''
 310                 ) {
 311                         return $this->msg( 'htmlform-required' );
 312                 }
 313
 314                 if ( isset( $this->mValidationCallback ) ) {
 315                         return ( $this->mValidationCallback )( $value, $alldata, $this->mParent );
 316                 }
 317
 318                 return true;
 319         }
 320
 321         public function filter( $value, $alldata ) {
 322                 if ( isset( $this->mFilterCallback ) ) {
 323                         $value = ( $this->mFilterCallback )( $value, $alldata, $this->mParent );
 324                 }
 325
 326                 return $value;
 327         }
 328
 329         /**
 330          * Should this field have a label, or is there no input element with the
 331          * appropriate id for the label to point to?
 332          *
 333          * @return bool True to output a label, false to suppress
 334          */
 335         protected function needsLabel() {
 336                 return true;
 337         }
 338
 339         /**
 340          * Tell the field whether to generate a separate label element if its label
 341          * is blank.
 342          *
 343          * @since 1.22
 344          *
 345          * @param bool $show Set to false to not generate a label.
 346          * @return void
 347          */
 348         public function setShowEmptyLabel( $show ) {
 349                 $this->mShowEmptyLabels = $show;
 350         }
 351
 352         /**
 353          * Can we assume that the request is an attempt to submit a HTMLForm, as opposed to an attempt to
 354          * just view it? This can't normally be distinguished for e.g. checkboxes.
 355          *
 356          * Returns true if the request has a field for a CSRF token (wpEditToken) or a form identifier
 357          * (wpFormIdentifier).
 358          *
 359          * @param WebRequest $request
 360          * @return bool
 361          */
 362         protected function isSubmitAttempt( WebRequest $request ) {
 363                 return $request->getCheck( 'wpEditToken' ) || $request->getCheck( 'wpFormIdentifier' );
 364         }
 365
 366         /**
 367          * Get the value that this input has been set to from a posted form,
 368          * or the input's default value if it has not been set.
 369          *
 370          * @param WebRequest $request
 371          * @return string The value
 372          */
 373         public function loadDataFromRequest( $request ) {
 374                 if ( $request->getCheck( $this->mName ) ) {
 375                         return $request->getText( $this->mName );
 376                 } else {
 377                         return $this->getDefault();
 378                 }
 379         }
 380
 381         /**
 382          * Initialise the object
 383          *
 384          * @param array $params Associative Array. See HTMLForm doc for syntax.
 385          *
 386          * @since 1.22 The 'label' attribute no longer accepts raw HTML, use 'label-raw' instead
 387          * @throws MWException
 388          */
 389         public function __construct( $params ) {
 390                 $this->mParams = $params;
 391
 392                 if ( isset( $params['parent'] ) && $params['parent'] instanceof HTMLForm ) {
 393                         $this->mParent = $params['parent'];
 394                 }
 395
 396                 # Generate the label from a message, if possible
 397                 if ( isset( $params['label-message'] ) ) {
 398                         $this->mLabel = $this->getMessage( $params['label-message'] )->parse();
 399                 } elseif ( isset( $params['label'] ) ) {
 400                         if ( $params['label'] === '&#160;' || $params['label'] === "\u{00A0}" ) {
 401                                 // Apparently some things set &nbsp directly and in an odd format
 402                                 $this->mLabel = "\u{00A0}";
 403                         } else {
 404                                 $this->mLabel = htmlspecialchars( $params['label'] );
 405                         }
 406                 } elseif ( isset( $params['label-raw'] ) ) {
 407                         $this->mLabel = $params['label-raw'];
 408                 }
 409
 410                 $this->mName = "wp{$params['fieldname']}";
 411                 if ( isset( $params['name'] ) ) {
 412                         $this->mName = $params['name'];
 413                 }
 414
 415                 if ( isset( $params['dir'] ) ) {
 416                         $this->mDir = $params['dir'];
 417                 }
 418
 419                 $validName = urlencode( $this->mName );
 420                 $validName = str_replace( [ '%5B', '%5D' ], [ '[', ']' ], $validName );
 421                 if ( $this->mName != $validName && !isset( $params['nodata'] ) ) {
 422                         throw new MWException( "Invalid name '{$this->mName}' passed to " . __METHOD__ );
 423                 }
 424
 425                 $this->mID = "mw-input-{$this->mName}";
 426
 427                 if ( isset( $params['default'] ) ) {
 428                         $this->mDefault = $params['default'];
 429                 }
 430
 431                 if ( isset( $params['id'] ) ) {
 432                         $id = $params['id'];
 433                         $validId = urlencode( $id );
 434
 435                         if ( $id != $validId ) {
 436                                 throw new MWException( "Invalid id '$id' passed to " . __METHOD__ );
 437                         }
 438
 439                         $this->mID = $id;
 440                 }
 441
 442                 if ( isset( $params['cssclass'] ) ) {
 443                         $this->mClass = $params['cssclass'];
 444                 }
 445
 446                 if ( isset( $params['csshelpclass'] ) ) {
 447                         $this->mHelpClass = $params['csshelpclass'];
 448                 }
 449
 450                 if ( isset( $params['validation-callback'] ) ) {
 451                         $this->mValidationCallback = $params['validation-callback'];
 452                 }
 453
 454                 if ( isset( $params['filter-callback'] ) ) {
 455                         $this->mFilterCallback = $params['filter-callback'];
 456                 }
 457
 458                 if ( isset( $params['hidelabel'] ) ) {
 459                         $this->mShowEmptyLabels = false;
 460                 }
 461
 462                 if ( isset( $params['hide-if'] ) ) {
 463                         $this->mHideIf = $params['hide-if'];
 464                 }
 465         }
 466
 467         /**
 468          * Get the complete table row for the input, including help text,
 469          * labels, and whatever.
 470          *
 471          * @param string $value The value to set the input to.
 472          *
 473          * @return string Complete HTML table row.
 474          */
 475         public function getTableRow( $value ) {
 476                 list( $errors, $errorClass ) = $this->getErrorsAndErrorClass( $value );
 477                 $inputHtml = $this->getInputHTML( $value );
 478                 $fieldType = static::class;
 479                 $helptext = $this->getHelpTextHtmlTable( $this->getHelpText() );
 480                 $cellAttributes = [];
 481                 $rowAttributes = [];
 482                 $rowClasses = '';
 483
 484                 if ( !empty( $this->mParams['vertical-label'] ) ) {
 485                         $cellAttributes['colspan'] = 2;
 486                         $verticalLabel = true;
 487                 } else {
 488                         $verticalLabel = false;
 489                 }
 490
 491                 $label = $this->getLabelHtml( $cellAttributes );
 492
 493                 $field = Html::rawElement(
 494                         'td',
 495                         [ 'class' => 'mw-input' ] + $cellAttributes,
 496                         $inputHtml . "\n$errors"
 497                 );
 498
 499                 if ( $this->mHideIf ) {
 500                         $rowAttributes['data-hide-if'] = FormatJson::encode( $this->mHideIf );
 501                         $rowClasses .= ' mw-htmlform-hide-if';
 502                 }
 503
 504                 if ( $verticalLabel ) {
 505                         $html = Html::rawElement( 'tr',
 506                                 $rowAttributes + [ 'class' => "mw-htmlform-vertical-label $rowClasses" ], $label );
 507                         $html .= Html::rawElement( 'tr',
 508                                 $rowAttributes + [
 509                                         'class' => "mw-htmlform-field-$fieldType {$this->mClass} $errorClass $rowClasses"
 510                                 ],
 511                                 $field );
 512                 } else {
 513                         $html =
 514                                 Html::rawElement( 'tr',
 515                                         $rowAttributes + [
 516                                                 'class' => "mw-htmlform-field-$fieldType {$this->mClass} $errorClass $rowClasses"
 517                                         ],
 518                                         $label . $field );
 519                 }
 520
 521                 return $html . $helptext;
 522         }
 523
 524         /**
 525          * Get the complete div for the input, including help text,
 526          * labels, and whatever.
 527          * @since 1.20
 528          *
 529          * @param string $value The value to set the input to.
 530          *
 531          * @return string Complete HTML table row.
 532          */
 533         public function getDiv( $value ) {
 534                 list( $errors, $errorClass ) = $this->getErrorsAndErrorClass( $value );
 535                 $inputHtml = $this->getInputHTML( $value );
 536                 $fieldType = static::class;
 537                 $helptext = $this->getHelpTextHtmlDiv( $this->getHelpText() );
 538                 $cellAttributes = [];
 539                 $label = $this->getLabelHtml( $cellAttributes );
 540
 541                 $outerDivClass = [
 542                         'mw-input',
 543                         'mw-htmlform-nolabel' => ( $label === '' )
 544                 ];
 545
 546                 $horizontalLabel = $this->mParams['horizontal-label'] ?? false;
 547
 548                 if ( $horizontalLabel ) {
 549                         $field = "\u{00A0}" . $inputHtml . "\n$errors";
 550                 } else {
 551                         $field = Html::rawElement(
 552                                 'div',
 553                                 [ 'class' => $outerDivClass ] + $cellAttributes,
 554                                 $inputHtml . "\n$errors"
 555                         );
 556                 }
 557                 $divCssClasses = [ "mw-htmlform-field-$fieldType",
 558                         $this->mClass, $this->mVFormClass, $errorClass ];
 559
 560                 $wrapperAttributes = [
 561                         'class' => $divCssClasses,
 562                 ];
 563                 if ( $this->mHideIf ) {
 564                         $wrapperAttributes['data-hide-if'] = FormatJson::encode( $this->mHideIf );
 565                         $wrapperAttributes['class'][] = ' mw-htmlform-hide-if';
 566                 }
 567                 $html = Html::rawElement( 'div', $wrapperAttributes, $label . $field );
 568                 $html .= $helptext;
 569
 570                 return $html;
 571         }
 572
 573         /**
 574          * Get the OOUI version of the div. Falls back to getDiv by default.
 575          * @since 1.26
 576          *
 577          * @param string $value The value to set the input to.
 578          *
 579          * @return OOUI\FieldLayout|OOUI\ActionFieldLayout
 580          */
 581         public function getOOUI( $value ) {
 582                 $inputField = $this->getInputOOUI( $value );
 583
 584                 if ( !$inputField ) {
 585                         // This field doesn't have an OOUI implementation yet at all. Fall back to getDiv() to
 586                         // generate the whole field, label and errors and all, then wrap it in a Widget.
 587                         // It might look weird, but it'll work OK.
 588                         return $this->getFieldLayoutOOUI(
 589                                 new OOUI\Widget( [ 'content' => new OOUI\HtmlSnippet( $this->getDiv( $value ) ) ] ),
 590                                 [ 'infusable' => false, 'align' => 'top' ]
 591                         );
 592                 }
 593
 594                 $infusable = true;
 595                 if ( is_string( $inputField ) ) {
 596                         // We have an OOUI implementation, but it's not proper, and we got a load of HTML.
 597                         // Cheat a little and wrap it in a widget. It won't be infusable, though, since client-side
 598                         // JavaScript doesn't know how to rebuilt the contents.
 599                         $inputField = new OOUI\Widget( [ 'content' => new OOUI\HtmlSnippet( $inputField ) ] );
 600                         $infusable = false;
 601                 }
 602
 603                 $fieldType = static::class;
 604                 $help = $this->getHelpText();
 605                 $errors = $this->getErrorsRaw( $value );
 606                 foreach ( $errors as &$error ) {
 607                         $error = new OOUI\HtmlSnippet( $error );
 608                 }
 609
 610                 $notices = $this->getNotices();
 611                 foreach ( $notices as &$notice ) {
 612                         $notice = new OOUI\HtmlSnippet( $notice );
 613                 }
 614
 615                 $config = [
 616                         'classes' => [ "mw-htmlform-field-$fieldType", $this->mClass ],
 617                         'align' => $this->getLabelAlignOOUI(),
 618                         'help' => ( $help !== null && $help !== '' ) ? new OOUI\HtmlSnippet( $help ) : null,
 619                         'errors' => $errors,
 620                         'notices' => $notices,
 621                         'infusable' => $infusable,
 622                 ];
 623
 624                 $preloadModules = false;
 625
 626                 if ( $infusable && $this->shouldInfuseOOUI() ) {
 627                         $preloadModules = true;
 628                         $config['classes'][] = 'mw-htmlform-field-autoinfuse';
 629                 }
 630
 631                 // the element could specify, that the label doesn't need to be added
 632                 $label = $this->getLabel();
 633                 if ( $label && $label !== "\u{00A0}" && $label !== '&#160;' ) {
 634                         $config['label'] = new OOUI\HtmlSnippet( $label );
 635                 }
 636
 637                 if ( $this->mHideIf ) {
 638                         $preloadModules = true;
 639                         $config['hideIf'] = $this->mHideIf;
 640                 }
 641
 642                 $config['modules'] = $this->getOOUIModules();
 643
 644                 if ( $preloadModules ) {
 645                         $this->mParent->getOutput()->addModules( 'mediawiki.htmlform.ooui' );
 646                         $this->mParent->getOutput()->addModules( $this->getOOUIModules() );
 647                 }
 648
 649                 return $this->getFieldLayoutOOUI( $inputField, $config );
 650         }
 651
 652         /**
 653          * Get label alignment when generating field for OOUI.
 654          * @return string 'left', 'right', 'top' or 'inline'
 655          */
 656         protected function getLabelAlignOOUI() {
 657                 return 'top';
 658         }
 659
 660         /**
 661          * Get a FieldLayout (or subclass thereof) to wrap this field in when using OOUI output.
 662          * @param string $inputField
 663          * @param array $config
 664          * @return OOUI\FieldLayout|OOUI\ActionFieldLayout
 665          */
 666         protected function getFieldLayoutOOUI( $inputField, $config ) {
 667                 if ( isset( $this->mClassWithButton ) ) {
 668                         $buttonWidget = $this->mClassWithButton->getInputOOUI( '' );
 669                         return new HTMLFormActionFieldLayout( $inputField, $buttonWidget, $config );
 670                 }
 671                 return new HTMLFormFieldLayout( $inputField, $config );
 672         }
 673
 674         /**
 675          * Whether the field should be automatically infused. Note that all OOUI HTMLForm fields are
 676          * infusable (you can call OO.ui.infuse() on them), but not all are infused by default, since
 677          * there is no benefit in doing it e.g. for buttons and it's a small performance hit on page load.
 678          *
 679          * @return bool
 680          */
 681         protected function shouldInfuseOOUI() {
 682                 // Always infuse fields with help text, since the interface for it is nicer with JS
 683                 return $this->getHelpText() !== null;
 684         }
 685
 686         /**
 687          * Get the list of extra ResourceLoader modules which must be loaded client-side before it's
 688          * possible to infuse this field's OOUI widget.
 689          *
 690          * @return string[]
 691          */
 692         protected function getOOUIModules() {
 693                 return [];
 694         }
 695
 696         /**
 697          * Get the complete raw fields for the input, including help text,
 698          * labels, and whatever.
 699          * @since 1.20
 700          *
 701          * @param string $value The value to set the input to.
 702          *
 703          * @return string Complete HTML table row.
 704          */
 705         public function getRaw( $value ) {
 706                 list( $errors, ) = $this->getErrorsAndErrorClass( $value );
 707                 $inputHtml = $this->getInputHTML( $value );
 708                 $helptext = $this->getHelpTextHtmlRaw( $this->getHelpText() );
 709                 $cellAttributes = [];
 710                 $label = $this->getLabelHtml( $cellAttributes );
 711
 712                 $html = "\n$errors";
 713                 $html .= $label;
 714                 $html .= $inputHtml;
 715                 $html .= $helptext;
 716
 717                 return $html;
 718         }
 719
 720         /**
 721          * Get the complete field for the input, including help text,
 722          * labels, and whatever. Fall back from 'vform' to 'div' when not overridden.
 723          *
 724          * @since 1.25
 725          * @param string $value The value to set the input to.
 726          * @return string Complete HTML field.
 727          */
 728         public function getVForm( $value ) {
 729                 // Ewwww
 730                 $this->mVFormClass = ' mw-ui-vform-field';
 731                 return $this->getDiv( $value );
 732         }
 733
 734         /**
 735          * Get the complete field as an inline element.
 736          * @since 1.25
 737          * @param string $value The value to set the input to.
 738          * @return string Complete HTML inline element
 739          */
 740         public function getInline( $value ) {
 741                 list( $errors, $errorClass ) = $this->getErrorsAndErrorClass( $value );
 742                 $inputHtml = $this->getInputHTML( $value );
 743                 $helptext = $this->getHelpTextHtmlDiv( $this->getHelpText() );
 744                 $cellAttributes = [];
 745                 $label = $this->getLabelHtml( $cellAttributes );
 746
 747                 $html = "\n" . $errors .
 748                         $label . "\u{00A0}" .
 749                         $inputHtml .
 750                         $helptext;
 751
 752                 return $html;
 753         }
 754
 755         /**
 756          * Generate help text HTML in table format
 757          * @since 1.20
 758          *
 759          * @param string|null $helptext
 760          * @return string
 761          */
 762         public function getHelpTextHtmlTable( $helptext ) {
 763                 if ( is_null( $helptext ) ) {
 764                         return '';
 765                 }
 766
 767                 $rowAttributes = [];
 768                 if ( $this->mHideIf ) {
 769                         $rowAttributes['data-hide-if'] = FormatJson::encode( $this->mHideIf );
 770                         $rowAttributes['class'] = 'mw-htmlform-hide-if';
 771                 }
 772
 773                 $tdClasses = [ 'htmlform-tip' ];
 774                 if ( $this->mHelpClass !== false ) {
 775                         $tdClasses[] = $this->mHelpClass;
 776                 }
 777                 $row = Html::rawElement( 'td', [ 'colspan' => 2, 'class' => $tdClasses ], $helptext );
 778                 $row = Html::rawElement( 'tr', $rowAttributes, $row );
 779
 780                 return $row;
 781         }
 782
 783         /**
 784          * Generate help text HTML in div format
 785          * @since 1.20
 786          *
 787          * @param string|null $helptext
 788          *
 789          * @return string
 790          */
 791         public function getHelpTextHtmlDiv( $helptext ) {
 792                 if ( is_null( $helptext ) ) {
 793                         return '';
 794                 }
 795
 796                 $wrapperAttributes = [
 797                         'class' => 'htmlform-tip',
 798                 ];
 799                 if ( $this->mHelpClass !== false ) {
 800                         $wrapperAttributes['class'] .= " {$this->mHelpClass}";
 801                 }
 802                 if ( $this->mHideIf ) {
 803                         $wrapperAttributes['data-hide-if'] = FormatJson::encode( $this->mHideIf );
 804                         $wrapperAttributes['class'] .= ' mw-htmlform-hide-if';
 805                 }
 806                 $div = Html::rawElement( 'div', $wrapperAttributes, $helptext );
 807
 808                 return $div;
 809         }
 810
 811         /**
 812          * Generate help text HTML formatted for raw output
 813          * @since 1.20
 814          *
 815          * @param string|null $helptext
 816          * @return string
 817          */
 818         public function getHelpTextHtmlRaw( $helptext ) {
 819                 return $this->getHelpTextHtmlDiv( $helptext );
 820         }
 821
 822         /**
 823          * Determine the help text to display
 824          * @since 1.20
 825          * @return string|null HTML
 826          */
 827         public function getHelpText() {
 828                 $helptext = null;
 829
 830                 if ( isset( $this->mParams['help-message'] ) ) {
 831                         $this->mParams['help-messages'] = [ $this->mParams['help-message'] ];
 832                 }
 833
 834                 if ( isset( $this->mParams['help-messages'] ) ) {
 835                         foreach ( $this->mParams['help-messages'] as $msg ) {
 836                                 $msg = $this->getMessage( $msg );
 837
 838                                 if ( $msg->exists() ) {
 839                                         if ( is_null( $helptext ) ) {
 840                                                 $helptext = '';
 841                                         } else {
 842                                                 $helptext .= $this->msg( 'word-separator' )->escaped(); // some space
 843                                         }
 844                                         $helptext .= $msg->parse(); // Append message
 845                                 }
 846                         }
 847                 } elseif ( isset( $this->mParams['help'] ) ) {
 848                         $helptext = $this->mParams['help'];
 849                 }
 850
 851                 return $helptext;
 852         }
 853
 854         /**
 855          * Determine form errors to display and their classes
 856          * @since 1.20
 857          *
 858          * @param string $value The value of the input
 859          * @return array array( $errors, $errorClass )
 860          */
 861         public function getErrorsAndErrorClass( $value ) {
 862                 $errors = $this->validate( $value, $this->mParent->mFieldData );
 863
 864                 if ( is_bool( $errors ) || !$this->mParent->wasSubmitted() ) {
 865                         $errors = '';
 866                         $errorClass = '';
 867                 } else {
 868                         $errors = self::formatErrors( $errors );
 869                         $errorClass = 'mw-htmlform-invalid-input';
 870                 }
 871
 872                 return [ $errors, $errorClass ];
 873         }
 874
 875         /**
 876          * Determine form errors to display, returning them in an array.
 877          *
 878          * @since 1.26
 879          * @param string $value The value of the input
 880          * @return string[] Array of error HTML strings
 881          */
 882         public function getErrorsRaw( $value ) {
 883                 $errors = $this->validate( $value, $this->mParent->mFieldData );
 884
 885                 if ( is_bool( $errors ) || !$this->mParent->wasSubmitted() ) {
 886                         $errors = [];
 887                 }
 888
 889                 if ( !is_array( $errors ) ) {
 890                         $errors = [ $errors ];
 891                 }
 892                 foreach ( $errors as &$error ) {
 893                         if ( $error instanceof Message ) {
 894                                 $error = $error->parse();
 895                         }
 896                 }
 897
 898                 return $errors;
 899         }
 900
 901         /**
 902          * Determine notices to display for the field.
 903          *
 904          * @since 1.28
 905          * @return string[]
 906          */
 907         public function getNotices() {
 908                 $notices = [];
 909
 910                 if ( isset( $this->mParams['notice-message'] ) ) {
 911                         $notices[] = $this->getMessage( $this->mParams['notice-message'] )->parse();
 912                 }
 913
 914                 if ( isset( $this->mParams['notice-messages'] ) ) {
 915                         foreach ( $this->mParams['notice-messages'] as $msg ) {
 916                                 $notices[] = $this->getMessage( $msg )->parse();
 917                         }
 918                 } elseif ( isset( $this->mParams['notice'] ) ) {
 919                         $notices[] = $this->mParams['notice'];
 920                 }
 921
 922                 return $notices;
 923         }
 924
 925         /**
 926          * @return string HTML
 927          */
 928         public function getLabel() {
 929                 return $this->mLabel ?? '';
 930         }
 931
 932         public function getLabelHtml( $cellAttributes = [] ) {
 933                 # Don't output a for= attribute for labels with no associated input.
 934                 # Kind of hacky here, possibly we don't want these to be <label>s at all.
 935                 $for = [];
 936
 937                 if ( $this->needsLabel() ) {
 938                         $for['for'] = $this->mID;
 939                 }
 940
 941                 $labelValue = trim( $this->getLabel() );
 942                 $hasLabel = false;
 943                 if ( $labelValue !== "\u{00A0}" && $labelValue !== '&#160;' && $labelValue !== '' ) {
 944                         $hasLabel = true;
 945                 }
 946
 947                 $displayFormat = $this->mParent->getDisplayFormat();
 948                 $html = '';
 949                 $horizontalLabel = $this->mParams['horizontal-label'] ?? false;
 950
 951                 if ( $displayFormat === 'table' ) {
 952                         $html =
 953                                 Html::rawElement( 'td',
 954                                         [ 'class' => 'mw-label' ] + $cellAttributes,
 955                                         Html::rawElement( 'label', $for, $labelValue ) );
 956                 } elseif ( $hasLabel || $this->mShowEmptyLabels ) {
 957                         if ( $displayFormat === 'div' && !$horizontalLabel ) {
 958                                 $html =
 959                                         Html::rawElement( 'div',
 960                                                 [ 'class' => 'mw-label' ] + $cellAttributes,
 961                                                 Html::rawElement( 'label', $for, $labelValue ) );
 962                         } else {
 963                                 $html = Html::rawElement( 'label', $for, $labelValue );
 964                         }
 965                 }
 966
 967                 return $html;
 968         }
 969
 970         public function getDefault() {
 971                 if ( isset( $this->mDefault ) ) {
 972                         return $this->mDefault;
 973                 } else {
 974                         return null;
 975                 }
 976         }
 977
 978         /**
 979          * Returns the attributes required for the tooltip and accesskey, for Html::element() etc.
 980          *
 981          * @return array Attributes
 982          */
 983         public function getTooltipAndAccessKey() {
 984                 if ( empty( $this->mParams['tooltip'] ) ) {
 985                         return [];
 986                 }
 987
 988                 return Linker::tooltipAndAccesskeyAttribs( $this->mParams['tooltip'] );
 989         }
 990
 991         /**
 992          * Returns the attributes required for the tooltip and accesskey, for OOUI widgets' config.
 993          *
 994          * @return array Attributes
 995          */
 996         public function getTooltipAndAccessKeyOOUI() {
 997                 if ( empty( $this->mParams['tooltip'] ) ) {
 998                         return [];
 999                 }
1000
1001                 return [
1002                         'title' => Linker::titleAttrib( $this->mParams['tooltip'] ),
1003                         'accessKey' => Linker::accesskey( $this->mParams['tooltip'] ),
1004                 ];
1005         }
1006
1007         /**
1008          * Returns the given attributes from the parameters
1009          *
1010          * @param array $list List of attributes to get
1011          * @return array Attributes
1012          */
1013         public function getAttributes( array $list ) {
1014                 static $boolAttribs = [ 'disabled', 'required', 'autofocus', 'multiple', 'readonly' ];
1015
1016                 $ret = [];
1017                 foreach ( $list as $key ) {
1018                         if ( in_array( $key, $boolAttribs ) ) {
1019                                 if ( !empty( $this->mParams[$key] ) ) {
1020                                         $ret[$key] = '';
1021                                 }
1022                         } elseif ( isset( $this->mParams[$key] ) ) {
1023                                 $ret[$key] = $this->mParams[$key];
1024                         }
1025                 }
1026
1027                 return $ret;
1028         }
1029
1030         /**
1031          * Given an array of msg-key => value mappings, returns an array with keys
1032          * being the message texts. It also forces values to strings.
1033          *
1034          * @param array $options
1035          * @return array
1036          */
1037         private function lookupOptionsKeys( $options ) {
1038                 $ret = [];
1039                 foreach ( $options as $key => $value ) {
1040                         $key = $this->msg( $key )->plain();
1041                         $ret[$key] = is_array( $value )
1042                                 ? $this->lookupOptionsKeys( $value )
1043                                 : strval( $value );
1044                 }
1045                 return $ret;
1046         }
1047
1048         /**
1049          * Recursively forces values in an array to strings, because issues arise
1050          * with integer 0 as a value.
1051          *
1052          * @param array $array
1053          * @return array|string
1054          */
1055         public static function forceToStringRecursive( $array ) {
1056                 if ( is_array( $array ) ) {
1057                         return array_map( [ __CLASS__, 'forceToStringRecursive' ], $array );
1058                 } else {
1059                         return strval( $array );
1060                 }
1061         }
1062
1063         /**
1064          * Fetch the array of options from the field's parameters. In order, this
1065          * checks 'options-messages', 'options', then 'options-message'.
1066          *
1067          * @return array|null Options array
1068          */
1069         public function getOptions() {
1070                 if ( $this->mOptions === false ) {
1071                         if ( array_key_exists( 'options-messages', $this->mParams ) ) {
1072                                 $this->mOptions = $this->lookupOptionsKeys( $this->mParams['options-messages'] );
1073                         } elseif ( array_key_exists( 'options', $this->mParams ) ) {
1074                                 $this->mOptionsLabelsNotFromMessage = true;
1075                                 $this->mOptions = self::forceToStringRecursive( $this->mParams['options'] );
1076                         } elseif ( array_key_exists( 'options-message', $this->mParams ) ) {
1077                                 $message = $this->getMessage( $this->mParams['options-message'] )->inContentLanguage()->plain();
1078                                 $this->mOptions = Xml::listDropDownOptions( $message );
1079                         } else {
1080                                 $this->mOptions = null;
1081                         }
1082                 }
1083
1084                 return $this->mOptions;
1085         }
1086
1087         /**
1088          * Get options and make them into arrays suitable for OOUI.
1089          * @return array Options for inclusion in a select or whatever.
1090          */
1091         public function getOptionsOOUI() {
1092                 $oldoptions = $this->getOptions();
1093
1094                 if ( $oldoptions === null ) {
1095                         return null;
1096                 }
1097
1098                 return Xml::listDropDownOptionsOoui( $oldoptions );
1099         }
1100
1101         /**
1102          * flatten an array of options to a single array, for instance,
1103          * a set of "<options>" inside "<optgroups>".
1104          *
1105          * @param array $options Associative Array with values either Strings or Arrays
1106          * @return array Flattened input
1107          */
1108         public static function flattenOptions( $options ) {
1109                 $flatOpts = [];
1110
1111                 foreach ( $options as $value ) {
1112                         if ( is_array( $value ) ) {
1113                                 $flatOpts = array_merge( $flatOpts, self::flattenOptions( $value ) );
1114                         } else {
1115                                 $flatOpts[] = $value;
1116                         }
1117                 }
1118
1119                 return $flatOpts;
1120         }
1121
1122         /**
1123          * Formats one or more errors as accepted by field validation-callback.
1124          *
1125          * @param string|Message|array $errors Array of strings or Message instances
1126          * @return string HTML
1127          * @since 1.18
1128          */
1129         protected static function formatErrors( $errors ) {
1130                 // Note: If you change the logic in this method, change
1131                 // htmlform.Checker.js to match.
1132
1133                 if ( is_array( $errors ) && count( $errors ) === 1 ) {
1134                         $errors = array_shift( $errors );
1135                 }
1136
1137                 if ( is_array( $errors ) ) {
1138                         $lines = [];
1139                         foreach ( $errors as $error ) {
1140                                 if ( $error instanceof Message ) {
1141                                         $lines[] = Html::rawElement( 'li', [], $error->parse() );
1142                                 } else {
1143                                         $lines[] = Html::rawElement( 'li', [], $error );
1144                                 }
1145                         }
1146
1147                         return Html::rawElement( 'ul', [ 'class' => 'error' ], implode( "\n", $lines ) );
1148                 } else {
1149                         if ( $errors instanceof Message ) {
1150                                 $errors = $errors->parse();
1151                         }
1152
1153                         return Html::rawElement( 'span', [ 'class' => 'error' ], $errors );
1154                 }
1155         }
1156
1157         /**
1158          * Turns a *-message parameter (which could be a MessageSpecifier, or a message name, or a
1159          * name + parameters array) into a Message.
1160          * @param mixed $value
1161          * @return Message
1162          */
1163         protected function getMessage( $value ) {
1164                 $message = Message::newFromSpecifier( $value );
1165
1166                 if ( $this->mParent ) {
1167                         $message->setContext( $this->mParent );
1168                 }
1169
1170                 return $message;
1171         }
1172
1173         /**
1174          * Skip this field when collecting data.
1175          * @param WebRequest $request
1176          * @return bool
1177          * @since 1.27
1178          */
1179         public function skipLoadData( $request ) {
1180                 return !empty( $this->mParams['nodata'] );
1181         }
1182
1183         /**
1184          * Whether this field requires the user agent to have JavaScript enabled for the client-side HTML5
1185          * form validation to work correctly.
1186          *
1187          * @return bool
1188          * @since 1.29
1189          */
1190         public function needsJSForHtml5FormValidation() {
1191                 if ( $this->mHideIf ) {
1192                         // This is probably more restrictive than it needs to be, but better safe than sorry
1193                         return true;
1194                 }
1195                 return false;
1196         }
1197 }