includes/Preferences.php

   1 <?php
   2 /**
   3  * Form to edit user preferences.
   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  */
  22 use MediaWiki\Auth\AuthManager;
  23 use MediaWiki\Auth\PasswordAuthenticationRequest;
  24 use MediaWiki\MediaWikiServices;
  25
  26 /**
  27  * We're now using the HTMLForm object with some customisation to generate the
  28  * Preferences form. This object handles generic submission, CSRF protection,
  29  * layout and other logic in a reusable manner. We subclass it as a PreferencesForm
  30  * to make some minor customisations.
  31  *
  32  * In order to generate the form, the HTMLForm object needs an array structure
  33  * detailing the form fields available, and that's what this class is for. Each
  34  * element of the array is a basic property-list, including the type of field,
  35  * the label it is to be given in the form, callbacks for validation and
  36  * 'filtering', and other pertinent information. Note that the 'default' field
  37  * is named for generic forms, and does not represent the preference's default
  38  * (which is stored in $wgDefaultUserOptions), but the default for the form
  39  * field, which should be whatever the user has set for that preference. There
  40  * is no need to override it unless you have some special storage logic (for
  41  * instance, those not presently stored as options, but which are best set from
  42  * the user preferences view).
  43  *
  44  * Field types are implemented as subclasses of the generic HTMLFormField
  45  * object, and typically implement at least getInputHTML, which generates the
  46  * HTML for the input field to be placed in the table.
  47  *
  48  * Once fields have been retrieved and validated, submission logic is handed
  49  * over to the tryUISubmit static method of this class.
  50  */
  51 class Preferences {
  52         /** @var array */
  53         protected static $defaultPreferences = null;
  54
  55         /** @var array */
  56         protected static $saveFilters = [
  57                 'timecorrection' => [ 'Preferences', 'filterTimezoneInput' ],
  58                 'rclimit' => [ 'Preferences', 'filterIntval' ],
  59                 'wllimit' => [ 'Preferences', 'filterIntval' ],
  60                 'searchlimit' => [ 'Preferences', 'filterIntval' ],
  61         ];
  62
  63         // Stuff that shouldn't be saved as a preference.
  64         private static $saveBlacklist = [
  65                 'realname',
  66                 'emailaddress',
  67         ];
  68
  69         /**
  70          * @return array
  71          */
  72         static function getSaveBlacklist() {
  73                 return self::$saveBlacklist;
  74         }
  75
  76         /**
  77          * @throws MWException
  78          * @param User $user
  79          * @param IContextSource $context
  80          * @return array|null
  81          */
  82         static function getPreferences( $user, IContextSource $context ) {
  83                 if ( self::$defaultPreferences ) {
  84                         return self::$defaultPreferences;
  85                 }
  86
  87                 $defaultPreferences = [];
  88
  89                 self::profilePreferences( $user, $context, $defaultPreferences );
  90                 self::skinPreferences( $user, $context, $defaultPreferences );
  91                 self::datetimePreferences( $user, $context, $defaultPreferences );
  92                 self::filesPreferences( $user, $context, $defaultPreferences );
  93                 self::renderingPreferences( $user, $context, $defaultPreferences );
  94                 self::editingPreferences( $user, $context, $defaultPreferences );
  95                 self::rcPreferences( $user, $context, $defaultPreferences );
  96                 self::watchlistPreferences( $user, $context, $defaultPreferences );
  97                 self::searchPreferences( $user, $context, $defaultPreferences );
  98                 self::miscPreferences( $user, $context, $defaultPreferences );
  99
 100                 Hooks::run( 'GetPreferences', [ $user, &$defaultPreferences ] );
 101
 102                 self::loadPreferenceValues( $user, $context, $defaultPreferences );
 103                 self::$defaultPreferences = $defaultPreferences;
 104                 return $defaultPreferences;
 105         }
 106
 107         /**
 108          * Loads existing values for a given array of preferences
 109          * @throws MWException
 110          * @param User $user
 111          * @param IContextSource $context
 112          * @param array $defaultPreferences Array to load values for
 113          * @return array|null
 114          */
 115         static function loadPreferenceValues( $user, $context, &$defaultPreferences ) {
 116                 # # Remove preferences that wikis don't want to use
 117                 foreach ( $context->getConfig()->get( 'HiddenPrefs' ) as $pref ) {
 118                         if ( isset( $defaultPreferences[$pref] ) ) {
 119                                 unset( $defaultPreferences[$pref] );
 120                         }
 121                 }
 122
 123                 # # Make sure that form fields have their parent set. See bug 41337.
 124                 $dummyForm = new HTMLForm( [], $context );
 125
 126                 $disable = !$user->isAllowed( 'editmyoptions' );
 127
 128                 $defaultOptions = User::getDefaultOptions();
 129                 # # Prod in defaults from the user
 130                 foreach ( $defaultPreferences as $name => &$info ) {
 131                         $prefFromUser = self::getOptionFromUser( $name, $info, $user );
 132                         if ( $disable && !in_array( $name, self::$saveBlacklist ) ) {
 133                                 $info['disabled'] = 'disabled';
 134                         }
 135                         $field = HTMLForm::loadInputFromParameters( $name, $info, $dummyForm ); // For validation
 136                         $globalDefault = isset( $defaultOptions[$name] )
 137                                 ? $defaultOptions[$name]
 138                                 : null;
 139
 140                         // If it validates, set it as the default
 141                         if ( isset( $info['default'] ) ) {
 142                                 // Already set, no problem
 143                                 continue;
 144                         } elseif ( !is_null( $prefFromUser ) && // Make sure we're not just pulling nothing
 145                                         $field->validate( $prefFromUser, $user->getOptions() ) === true ) {
 146                                 $info['default'] = $prefFromUser;
 147                         } elseif ( $field->validate( $globalDefault, $user->getOptions() ) === true ) {
 148                                 $info['default'] = $globalDefault;
 149                         } else {
 150                                 throw new MWException( "Global default '$globalDefault' is invalid for field $name" );
 151                         }
 152                 }
 153
 154                 return $defaultPreferences;
 155         }
 156
 157         /**
 158          * Pull option from a user account. Handles stuff like array-type preferences.
 159          *
 160          * @param string $name
 161          * @param array $info
 162          * @param User $user
 163          * @return array|string
 164          */
 165         static function getOptionFromUser( $name, $info, $user ) {
 166                 $val = $user->getOption( $name );
 167
 168                 // Handling for multiselect preferences
 169                 if ( ( isset( $info['type'] ) && $info['type'] == 'multiselect' ) ||
 170                                 ( isset( $info['class'] ) && $info['class'] == 'HTMLMultiSelectField' ) ) {
 171                         $options = HTMLFormField::flattenOptions( $info['options'] );
 172                         $prefix = isset( $info['prefix'] ) ? $info['prefix'] : $name;
 173                         $val = [];
 174
 175                         foreach ( $options as $value ) {
 176                                 if ( $user->getOption( "$prefix$value" ) ) {
 177                                         $val[] = $value;
 178                                 }
 179                         }
 180                 }
 181
 182                 // Handling for checkmatrix preferences
 183                 if ( ( isset( $info['type'] ) && $info['type'] == 'checkmatrix' ) ||
 184                                 ( isset( $info['class'] ) && $info['class'] == 'HTMLCheckMatrix' ) ) {
 185                         $columns = HTMLFormField::flattenOptions( $info['columns'] );
 186                         $rows = HTMLFormField::flattenOptions( $info['rows'] );
 187                         $prefix = isset( $info['prefix'] ) ? $info['prefix'] : $name;
 188                         $val = [];
 189
 190                         foreach ( $columns as $column ) {
 191                                 foreach ( $rows as $row ) {
 192                                         if ( $user->getOption( "$prefix$column-$row" ) ) {
 193                                                 $val[] = "$column-$row";
 194                                         }
 195                                 }
 196                         }
 197                 }
 198
 199                 return $val;
 200         }
 201
 202         /**
 203          * @param User $user
 204          * @param IContextSource $context
 205          * @param array $defaultPreferences
 206          * @return void
 207          */
 208         static function profilePreferences( $user, IContextSource $context, &$defaultPreferences ) {
 209                 global $wgContLang, $wgParser;
 210
 211                 $authManager = AuthManager::singleton();
 212                 $config = $context->getConfig();
 213                 // retrieving user name for GENDER and misc.
 214                 $userName = $user->getName();
 215
 216                 # # User info #####################################
 217                 // Information panel
 218                 $defaultPreferences['username'] = [
 219                         'type' => 'info',
 220                         'label-message' => [ 'username', $userName ],
 221                         'default' => $userName,
 222                         'section' => 'personal/info',
 223                 ];
 224
 225                 $lang = $context->getLanguage();
 226
 227                 # Get groups to which the user belongs
 228                 $userEffectiveGroups = $user->getEffectiveGroups();
 229                 $userGroupMemberships = $user->getGroupMemberships();
 230                 $userGroups = $userMembers = $userTempGroups = $userTempMembers = [];
 231                 foreach ( $userEffectiveGroups as $ueg ) {
 232                         if ( $ueg == '*' ) {
 233                                 // Skip the default * group, seems useless here
 234                                 continue;
 235                         }
 236
 237                         if ( isset( $userGroupMemberships[$ueg] ) ) {
 238                                 $groupStringOrObject = $userGroupMemberships[$ueg];
 239                         } else {
 240                                 $groupStringOrObject = $ueg;
 241                         }
 242
 243                         $userG = UserGroupMembership::getLink( $groupStringOrObject, $context, 'html' );
 244                         $userM = UserGroupMembership::getLink( $groupStringOrObject, $context, 'html',
 245                                 $userName );
 246
 247                         // Store expiring groups separately, so we can place them before non-expiring
 248                         // groups in the list. This is to avoid the ambiguity of something like
 249                         // "administrator, bureaucrat (until X date)" -- users might wonder whether the
 250                         // expiry date applies to both groups, or just the last one
 251                         if ( $groupStringOrObject instanceof UserGroupMembership &&
 252                                 $groupStringOrObject->getExpiry()
 253                         ) {
 254                                 $userTempGroups[] = $userG;
 255                                 $userTempMembers[] = $userM;
 256                         } else {
 257                                 $userGroups[] = $userG;
 258                                 $userMembers[] = $userM;
 259                         }
 260                 }
 261                 sort( $userGroups );
 262                 sort( $userMembers );
 263                 sort( $userTempGroups );
 264                 sort( $userTempMembers );
 265                 $userGroups = array_merge( $userTempGroups, $userGroups );
 266                 $userMembers = array_merge( $userTempMembers, $userMembers );
 267
 268                 $defaultPreferences['usergroups'] = [
 269                         'type' => 'info',
 270                         'label' => $context->msg( 'prefs-memberingroups' )->numParams(
 271                                 count( $userGroups ) )->params( $userName )->parse(),
 272                         'default' => $context->msg( 'prefs-memberingroups-type' )
 273                                 ->rawParams( $lang->commaList( $userGroups ), $lang->commaList( $userMembers ) )
 274                                 ->escaped(),
 275                         'raw' => true,
 276                         'section' => 'personal/info',
 277                 ];
 278
 279                 $linkRenderer = MediaWikiServices::getInstance()->getLinkRenderer();
 280
 281                 $editCount = $linkRenderer->makeLink( SpecialPage::getTitleFor( "Contributions", $userName ),
 282                         $lang->formatNum( $user->getEditCount() ) );
 283
 284                 $defaultPreferences['editcount'] = [
 285                         'type' => 'info',
 286                         'raw' => true,
 287                         'label-message' => 'prefs-edits',
 288                         'default' => $editCount,
 289                         'section' => 'personal/info',
 290                 ];
 291
 292                 if ( $user->getRegistration() ) {
 293                         $displayUser = $context->getUser();
 294                         $userRegistration = $user->getRegistration();
 295                         $defaultPreferences['registrationdate'] = [
 296                                 'type' => 'info',
 297                                 'label-message' => 'prefs-registration',
 298                                 'default' => $context->msg(
 299                                         'prefs-registration-date-time',
 300                                         $lang->userTimeAndDate( $userRegistration, $displayUser ),
 301                                         $lang->userDate( $userRegistration, $displayUser ),
 302                                         $lang->userTime( $userRegistration, $displayUser )
 303                                 )->parse(),
 304                                 'section' => 'personal/info',
 305                         ];
 306                 }
 307
 308                 $canViewPrivateInfo = $user->isAllowed( 'viewmyprivateinfo' );
 309                 $canEditPrivateInfo = $user->isAllowed( 'editmyprivateinfo' );
 310
 311                 // Actually changeable stuff
 312                 $defaultPreferences['realname'] = [
 313                         // (not really "private", but still shouldn't be edited without permission)
 314                         'type' => $canEditPrivateInfo && $authManager->allowsPropertyChange( 'realname' )
 315                                 ? 'text' : 'info',
 316                         'default' => $user->getRealName(),
 317                         'section' => 'personal/info',
 318                         'label-message' => 'yourrealname',
 319                         'help-message' => 'prefs-help-realname',
 320                 ];
 321
 322                 if ( $canEditPrivateInfo && $authManager->allowsAuthenticationDataChange(
 323                         new PasswordAuthenticationRequest(), false )->isGood()
 324                 ) {
 325                         $link = $linkRenderer->makeLink( SpecialPage::getTitleFor( 'ChangePassword' ),
 326                                 $context->msg( 'prefs-resetpass' )->text(), [],
 327                                 [ 'returnto' => SpecialPage::getTitleFor( 'Preferences' )->getPrefixedText() ] );
 328
 329                         $defaultPreferences['password'] = [
 330                                 'type' => 'info',
 331                                 'raw' => true,
 332                                 'default' => $link,
 333                                 'label-message' => 'yourpassword',
 334                                 'section' => 'personal/info',
 335                         ];
 336                 }
 337                 // Only show prefershttps if secure login is turned on
 338                 if ( $config->get( 'SecureLogin' ) && wfCanIPUseHTTPS( $context->getRequest()->getIP() ) ) {
 339                         $defaultPreferences['prefershttps'] = [
 340                                 'type' => 'toggle',
 341                                 'label-message' => 'tog-prefershttps',
 342                                 'help-message' => 'prefs-help-prefershttps',
 343                                 'section' => 'personal/info'
 344                         ];
 345                 }
 346
 347                 // Language
 348                 $languages = Language::fetchLanguageNames( null, 'mw' );
 349                 $languageCode = $config->get( 'LanguageCode' );
 350                 if ( !array_key_exists( $languageCode, $languages ) ) {
 351                         $languages[$languageCode] = $languageCode;
 352                 }
 353                 ksort( $languages );
 354
 355                 $options = [];
 356                 foreach ( $languages as $code => $name ) {
 357                         $display = wfBCP47( $code ) . ' - ' . $name;
 358                         $options[$display] = $code;
 359                 }
 360                 $defaultPreferences['language'] = [
 361                         'type' => 'select',
 362                         'section' => 'personal/i18n',
 363                         'options' => $options,
 364                         'label-message' => 'yourlanguage',
 365                 ];
 366
 367                 $defaultPreferences['gender'] = [
 368                         'type' => 'radio',
 369                         'section' => 'personal/i18n',
 370                         'options' => [
 371                                 $context->msg( 'parentheses' )
 372                                         ->params( $context->msg( 'gender-unknown' )->plain() )
 373                                         ->escaped() => 'unknown',
 374                                 $context->msg( 'gender-female' )->escaped() => 'female',
 375                                 $context->msg( 'gender-male' )->escaped() => 'male',
 376                         ],
 377                         'label-message' => 'yourgender',
 378                         'help-message' => 'prefs-help-gender',
 379                 ];
 380
 381                 // see if there are multiple language variants to choose from
 382                 if ( !$config->get( 'DisableLangConversion' ) ) {
 383                         foreach ( LanguageConverter::$languagesWithVariants as $langCode ) {
 384                                 if ( $langCode == $wgContLang->getCode() ) {
 385                                         $variants = $wgContLang->getVariants();
 386
 387                                         if ( count( $variants ) <= 1 ) {
 388                                                 continue;
 389                                         }
 390
 391                                         $variantArray = [];
 392                                         foreach ( $variants as $v ) {
 393                                                 $v = str_replace( '_', '-', strtolower( $v ) );
 394                                                 $variantArray[$v] = $lang->getVariantname( $v, false );
 395                                         }
 396
 397                                         $options = [];
 398                                         foreach ( $variantArray as $code => $name ) {
 399                                                 $display = wfBCP47( $code ) . ' - ' . $name;
 400                                                 $options[$display] = $code;
 401                                         }
 402
 403                                         $defaultPreferences['variant'] = [
 404                                                 'label-message' => 'yourvariant',
 405                                                 'type' => 'select',
 406                                                 'options' => $options,
 407                                                 'section' => 'personal/i18n',
 408                                                 'help-message' => 'prefs-help-variant',
 409                                         ];
 410                                 } else {
 411                                         $defaultPreferences["variant-$langCode"] = [
 412                                                 'type' => 'api',
 413                                         ];
 414                                 }
 415                         }
 416                 }
 417
 418                 // Stuff from Language::getExtraUserToggles()
 419                 // FIXME is this dead code? $extraUserToggles doesn't seem to be defined for any language
 420                 $toggles = $wgContLang->getExtraUserToggles();
 421
 422                 foreach ( $toggles as $toggle ) {
 423                         $defaultPreferences[$toggle] = [
 424                                 'type' => 'toggle',
 425                                 'section' => 'personal/i18n',
 426                                 'label-message' => "tog-$toggle",
 427                         ];
 428                 }
 429
 430                 // show a preview of the old signature first
 431                 $oldsigWikiText = $wgParser->preSaveTransform(
 432                         '~~~',
 433                         $context->getTitle(),
 434                         $user,
 435                         ParserOptions::newFromContext( $context )
 436                 );
 437                 $oldsigHTML = $context->getOutput()->parseInline( $oldsigWikiText, true, true );
 438                 $defaultPreferences['oldsig'] = [
 439                         'type' => 'info',
 440                         'raw' => true,
 441                         'label-message' => 'tog-oldsig',
 442                         'default' => $oldsigHTML,
 443                         'section' => 'personal/signature',
 444                 ];
 445                 $defaultPreferences['nickname'] = [
 446                         'type' => $authManager->allowsPropertyChange( 'nickname' ) ? 'text' : 'info',
 447                         'maxlength' => $config->get( 'MaxSigChars' ),
 448                         'label-message' => 'yournick',
 449                         'validation-callback' => [ 'Preferences', 'validateSignature' ],
 450                         'section' => 'personal/signature',
 451                         'filter-callback' => [ 'Preferences', 'cleanSignature' ],
 452                 ];
 453                 $defaultPreferences['fancysig'] = [
 454                         'type' => 'toggle',
 455                         'label-message' => 'tog-fancysig',
 456                         // show general help about signature at the bottom of the section
 457                         'help-message' => 'prefs-help-signature',
 458                         'section' => 'personal/signature'
 459                 ];
 460
 461                 # # Email stuff
 462
 463                 if ( $config->get( 'EnableEmail' ) ) {
 464                         if ( $canViewPrivateInfo ) {
 465                                 $helpMessages[] = $config->get( 'EmailConfirmToEdit' )
 466                                                 ? 'prefs-help-email-required'
 467                                                 : 'prefs-help-email';
 468
 469                                 if ( $config->get( 'EnableUserEmail' ) ) {
 470                                         // additional messages when users can send email to each other
 471                                         $helpMessages[] = 'prefs-help-email-others';
 472                                 }
 473
 474                                 $emailAddress = $user->getEmail() ? htmlspecialchars( $user->getEmail() ) : '';
 475                                 if ( $canEditPrivateInfo && $authManager->allowsPropertyChange( 'emailaddress' ) ) {
 476                                         $link = $linkRenderer->makeLink(
 477                                                 SpecialPage::getTitleFor( 'ChangeEmail' ),
 478                                                 $context->msg( $user->getEmail() ? 'prefs-changeemail' : 'prefs-setemail' )->text(),
 479                                                 [],
 480                                                 [ 'returnto' => SpecialPage::getTitleFor( 'Preferences' )->getPrefixedText() ] );
 481
 482                                         $emailAddress .= $emailAddress == '' ? $link : (
 483                                                 $context->msg( 'word-separator' )->escaped()
 484                                                 . $context->msg( 'parentheses' )->rawParams( $link )->escaped()
 485                                         );
 486                                 }
 487
 488                                 $defaultPreferences['emailaddress'] = [
 489                                         'type' => 'info',
 490                                         'raw' => true,
 491                                         'default' => $emailAddress,
 492                                         'label-message' => 'youremail',
 493                                         'section' => 'personal/email',
 494                                         'help-messages' => $helpMessages,
 495                                         # 'cssclass' chosen below
 496                                 ];
 497                         }
 498
 499                         $disableEmailPrefs = false;
 500
 501                         if ( $config->get( 'EmailAuthentication' ) ) {
 502                                 $emailauthenticationclass = 'mw-email-not-authenticated';
 503                                 if ( $user->getEmail() ) {
 504                                         if ( $user->getEmailAuthenticationTimestamp() ) {
 505                                                 // date and time are separate parameters to facilitate localisation.
 506                                                 // $time is kept for backward compat reasons.
 507                                                 // 'emailauthenticated' is also used in SpecialConfirmemail.php
 508                                                 $displayUser = $context->getUser();
 509                                                 $emailTimestamp = $user->getEmailAuthenticationTimestamp();
 510                                                 $time = $lang->userTimeAndDate( $emailTimestamp, $displayUser );
 511                                                 $d = $lang->userDate( $emailTimestamp, $displayUser );
 512                                                 $t = $lang->userTime( $emailTimestamp, $displayUser );
 513                                                 $emailauthenticated = $context->msg( 'emailauthenticated',
 514                                                         $time, $d, $t )->parse() . '<br />';
 515                                                 $disableEmailPrefs = false;
 516                                                 $emailauthenticationclass = 'mw-email-authenticated';
 517                                         } else {
 518                                                 $disableEmailPrefs = true;
 519                                                 $emailauthenticated = $context->msg( 'emailnotauthenticated' )->parse() . '<br />' .
 520                                                         $linkRenderer->makeKnownLink(
 521                                                                 SpecialPage::getTitleFor( 'Confirmemail' ),
 522                                                                 $context->msg( 'emailconfirmlink' )->text()
 523                                                         ) . '<br />';
 524                                                 $emailauthenticationclass = "mw-email-not-authenticated";
 525                                         }
 526                                 } else {
 527                                         $disableEmailPrefs = true;
 528                                         $emailauthenticated = $context->msg( 'noemailprefs' )->escaped();
 529                                         $emailauthenticationclass = 'mw-email-none';
 530                                 }
 531
 532                                 if ( $canViewPrivateInfo ) {
 533                                         $defaultPreferences['emailauthentication'] = [
 534                                                 'type' => 'info',
 535                                                 'raw' => true,
 536                                                 'section' => 'personal/email',
 537                                                 'label-message' => 'prefs-emailconfirm-label',
 538                                                 'default' => $emailauthenticated,
 539                                                 # Apply the same CSS class used on the input to the message:
 540                                                 'cssclass' => $emailauthenticationclass,
 541                                         ];
 542                                 }
 543                         }
 544
 545                         if ( $config->get( 'EnableUserEmail' ) && $user->isAllowed( 'sendemail' ) ) {
 546                                 $defaultPreferences['disablemail'] = [
 547                                         'type' => 'toggle',
 548                                         'invert' => true,
 549                                         'section' => 'personal/email',
 550                                         'label-message' => 'allowemail',
 551                                         'disabled' => $disableEmailPrefs,
 552                                 ];
 553                                 $defaultPreferences['ccmeonemails'] = [
 554                                         'type' => 'toggle',
 555                                         'section' => 'personal/email',
 556                                         'label-message' => 'tog-ccmeonemails',
 557                                         'disabled' => $disableEmailPrefs,
 558                                 ];
 559                         }
 560
 561                         if ( $config->get( 'EnotifWatchlist' ) ) {
 562                                 $defaultPreferences['enotifwatchlistpages'] = [
 563                                         'type' => 'toggle',
 564                                         'section' => 'personal/email',
 565                                         'label-message' => 'tog-enotifwatchlistpages',
 566                                         'disabled' => $disableEmailPrefs,
 567                                 ];
 568                         }
 569                         if ( $config->get( 'EnotifUserTalk' ) ) {
 570                                 $defaultPreferences['enotifusertalkpages'] = [
 571                                         'type' => 'toggle',
 572                                         'section' => 'personal/email',
 573                                         'label-message' => 'tog-enotifusertalkpages',
 574                                         'disabled' => $disableEmailPrefs,
 575                                 ];
 576                         }
 577                         if ( $config->get( 'EnotifUserTalk' ) || $config->get( 'EnotifWatchlist' ) ) {
 578                                 if ( $config->get( 'EnotifMinorEdits' ) ) {
 579                                         $defaultPreferences['enotifminoredits'] = [
 580                                                 'type' => 'toggle',
 581                                                 'section' => 'personal/email',
 582                                                 'label-message' => 'tog-enotifminoredits',
 583                                                 'disabled' => $disableEmailPrefs,
 584                                         ];
 585                                 }
 586
 587                                 if ( $config->get( 'EnotifRevealEditorAddress' ) ) {
 588                                         $defaultPreferences['enotifrevealaddr'] = [
 589                                                 'type' => 'toggle',
 590                                                 'section' => 'personal/email',
 591                                                 'label-message' => 'tog-enotifrevealaddr',
 592                                                 'disabled' => $disableEmailPrefs,
 593                                         ];
 594                                 }
 595                         }
 596                 }
 597         }
 598
 599         /**
 600          * @param User $user
 601          * @param IContextSource $context
 602          * @param array $defaultPreferences
 603          * @return void
 604          */
 605         static function skinPreferences( $user, IContextSource $context, &$defaultPreferences ) {
 606                 # # Skin #####################################
 607
 608                 // Skin selector, if there is at least one valid skin
 609                 $skinOptions = self::generateSkinOptions( $user, $context );
 610                 if ( $skinOptions ) {
 611                         $defaultPreferences['skin'] = [
 612                                 'type' => 'radio',
 613                                 'options' => $skinOptions,
 614                                 'label' => '&#160;',
 615                                 'section' => 'rendering/skin',
 616                         ];
 617                 }
 618
 619                 $config = $context->getConfig();
 620                 $allowUserCss = $config->get( 'AllowUserCss' );
 621                 $allowUserJs = $config->get( 'AllowUserJs' );
 622                 # Create links to user CSS/JS pages for all skins
 623                 # This code is basically copied from generateSkinOptions().  It'd
 624                 # be nice to somehow merge this back in there to avoid redundancy.
 625                 if ( $allowUserCss || $allowUserJs ) {
 626                         $linkTools = [];
 627                         $userName = $user->getName();
 628
 629                         $linkRenderer = MediaWikiServices::getInstance()->getLinkRenderer();
 630                         if ( $allowUserCss ) {
 631                                 $cssPage = Title::makeTitleSafe( NS_USER, $userName . '/common.css' );
 632                                 $linkTools[] = $linkRenderer->makeLink( $cssPage, $context->msg( 'prefs-custom-css' )->text() );
 633                         }
 634
 635                         if ( $allowUserJs ) {
 636                                 $jsPage = Title::makeTitleSafe( NS_USER, $userName . '/common.js' );
 637                                 $linkTools[] = $linkRenderer->makeLink( $jsPage, $context->msg( 'prefs-custom-js' )->text() );
 638                         }
 639
 640                         $defaultPreferences['commoncssjs'] = [
 641                                 'type' => 'info',
 642                                 'raw' => true,
 643                                 'default' => $context->getLanguage()->pipeList( $linkTools ),
 644                                 'label-message' => 'prefs-common-css-js',
 645                                 'section' => 'rendering/skin',
 646                         ];
 647                 }
 648         }
 649
 650         /**
 651          * @param User $user
 652          * @param IContextSource $context
 653          * @param array $defaultPreferences
 654          */
 655         static function filesPreferences( $user, IContextSource $context, &$defaultPreferences ) {
 656                 # # Files #####################################
 657                 $defaultPreferences['imagesize'] = [
 658                         'type' => 'select',
 659                         'options' => self::getImageSizes( $context ),
 660                         'label-message' => 'imagemaxsize',
 661                         'section' => 'rendering/files',
 662                 ];
 663                 $defaultPreferences['thumbsize'] = [
 664                         'type' => 'select',
 665                         'options' => self::getThumbSizes( $context ),
 666                         'label-message' => 'thumbsize',
 667                         'section' => 'rendering/files',
 668                 ];
 669         }
 670
 671         /**
 672          * @param User $user
 673          * @param IContextSource $context
 674          * @param array $defaultPreferences
 675          * @return void
 676          */
 677         static function datetimePreferences( $user, IContextSource $context, &$defaultPreferences ) {
 678                 # # Date and time #####################################
 679                 $dateOptions = self::getDateOptions( $context );
 680                 if ( $dateOptions ) {
 681                         $defaultPreferences['date'] = [
 682                                 'type' => 'radio',
 683                                 'options' => $dateOptions,
 684                                 'label' => '&#160;',
 685                                 'section' => 'rendering/dateformat',
 686                         ];
 687                 }
 688
 689                 // Info
 690                 $now = wfTimestampNow();
 691                 $lang = $context->getLanguage();
 692                 $nowlocal = Xml::element( 'span', [ 'id' => 'wpLocalTime' ],
 693                         $lang->userTime( $now, $user ) );
 694                 $nowserver = $lang->userTime( $now, $user,
 695                                 [ 'format' => false, 'timecorrection' => false ] ) .
 696                         Html::hidden( 'wpServerTime', (int)substr( $now, 8, 2 ) * 60 + (int)substr( $now, 10, 2 ) );
 697
 698                 $defaultPreferences['nowserver'] = [
 699                         'type' => 'info',
 700                         'raw' => 1,
 701                         'label-message' => 'servertime',
 702                         'default' => $nowserver,
 703                         'section' => 'rendering/timeoffset',
 704                 ];
 705
 706                 $defaultPreferences['nowlocal'] = [
 707                         'type' => 'info',
 708                         'raw' => 1,
 709                         'label-message' => 'localtime',
 710                         'default' => $nowlocal,
 711                         'section' => 'rendering/timeoffset',
 712                 ];
 713
 714                 // Grab existing pref.
 715                 $tzOffset = $user->getOption( 'timecorrection' );
 716                 $tz = explode( '|', $tzOffset, 3 );
 717
 718                 $tzOptions = self::getTimezoneOptions( $context );
 719
 720                 $tzSetting = $tzOffset;
 721                 if ( count( $tz ) > 1 && $tz[0] == 'ZoneInfo' &&
 722                         !in_array( $tzOffset, HTMLFormField::flattenOptions( $tzOptions ) )
 723                 ) {
 724                         // Timezone offset can vary with DST
 725                         try {
 726                                 $userTZ = new DateTimeZone( $tz[2] );
 727                                 $minDiff = floor( $userTZ->getOffset( new DateTime( 'now' ) ) / 60 );
 728                                 $tzSetting = "ZoneInfo|$minDiff|{$tz[2]}";
 729                         } catch ( Exception $e ) {
 730                                 // User has an invalid time zone set. Fall back to just using the offset
 731                                 $tz[0] = 'Offset';
 732                         }
 733                 }
 734                 if ( count( $tz ) > 1 && $tz[0] == 'Offset' ) {
 735                         $minDiff = $tz[1];
 736                         $tzSetting = sprintf( '%+03d:%02d', floor( $minDiff / 60 ), abs( $minDiff ) % 60 );
 737                 }
 738
 739                 $defaultPreferences['timecorrection'] = [
 740                         'class' => 'HTMLSelectOrOtherField',
 741                         'label-message' => 'timezonelegend',
 742                         'options' => $tzOptions,
 743                         'default' => $tzSetting,
 744                         'size' => 20,
 745                         'section' => 'rendering/timeoffset',
 746                 ];
 747         }
 748
 749         /**
 750          * @param User $user
 751          * @param IContextSource $context
 752          * @param array $defaultPreferences
 753          */
 754         static function renderingPreferences( $user, IContextSource $context, &$defaultPreferences ) {
 755                 # # Diffs ####################################
 756                 $defaultPreferences['diffonly'] = [
 757                         'type' => 'toggle',
 758                         'section' => 'rendering/diffs',
 759                         'label-message' => 'tog-diffonly',
 760                 ];
 761                 $defaultPreferences['norollbackdiff'] = [
 762                         'type' => 'toggle',
 763                         'section' => 'rendering/diffs',
 764                         'label-message' => 'tog-norollbackdiff',
 765                 ];
 766
 767                 # # Page Rendering ##############################
 768                 if ( $context->getConfig()->get( 'AllowUserCssPrefs' ) ) {
 769                         $defaultPreferences['underline'] = [
 770                                 'type' => 'select',
 771                                 'options' => [
 772                                         $context->msg( 'underline-never' )->text() => 0,
 773                                         $context->msg( 'underline-always' )->text() => 1,
 774                                         $context->msg( 'underline-default' )->text() => 2,
 775                                 ],
 776                                 'label-message' => 'tog-underline',
 777                                 'section' => 'rendering/advancedrendering',
 778                         ];
 779                 }
 780
 781                 $stubThresholdValues = [ 50, 100, 500, 1000, 2000, 5000, 10000 ];
 782                 $stubThresholdOptions = [ $context->msg( 'stub-threshold-disabled' )->text() => 0 ];
 783                 foreach ( $stubThresholdValues as $value ) {
 784                         $stubThresholdOptions[$context->msg( 'size-bytes', $value )->text()] = $value;
 785                 }
 786
 787                 $defaultPreferences['stubthreshold'] = [
 788                         'type' => 'select',
 789                         'section' => 'rendering/advancedrendering',
 790                         'options' => $stubThresholdOptions,
 791                         // This is not a raw HTML message; label-raw is needed for the manual <a></a>
 792                         'label-raw' => $context->msg( 'stub-threshold' )->rawParams(
 793                                 '<a href="#" class="stub">' .
 794                                 $context->msg( 'stub-threshold-sample-link' )->parse() .
 795                                 '</a>' )->parse(),
 796                 ];
 797
 798                 $defaultPreferences['showhiddencats'] = [
 799                         'type' => 'toggle',
 800                         'section' => 'rendering/advancedrendering',
 801                         'label-message' => 'tog-showhiddencats'
 802                 ];
 803
 804                 $defaultPreferences['numberheadings'] = [
 805                         'type' => 'toggle',
 806                         'section' => 'rendering/advancedrendering',
 807                         'label-message' => 'tog-numberheadings',
 808                 ];
 809         }
 810
 811         /**
 812          * @param User $user
 813          * @param IContextSource $context
 814          * @param array $defaultPreferences
 815          */
 816         static function editingPreferences( $user, IContextSource $context, &$defaultPreferences ) {
 817                 # # Editing #####################################
 818                 $defaultPreferences['editsectiononrightclick'] = [
 819                         'type' => 'toggle',
 820                         'section' => 'editing/advancedediting',
 821                         'label-message' => 'tog-editsectiononrightclick',
 822                 ];
 823                 $defaultPreferences['editondblclick'] = [
 824                         'type' => 'toggle',
 825                         'section' => 'editing/advancedediting',
 826                         'label-message' => 'tog-editondblclick',
 827                 ];
 828
 829                 if ( $context->getConfig()->get( 'AllowUserCssPrefs' ) ) {
 830                         $defaultPreferences['editfont'] = [
 831                                 'type' => 'select',
 832                                 'section' => 'editing/editor',
 833                                 'label-message' => 'editfont-style',
 834                                 'options' => [
 835                                         $context->msg( 'editfont-default' )->text() => 'default',
 836                                         $context->msg( 'editfont-monospace' )->text() => 'monospace',
 837                                         $context->msg( 'editfont-sansserif' )->text() => 'sans-serif',
 838                                         $context->msg( 'editfont-serif' )->text() => 'serif',
 839                                 ]
 840                         ];
 841                 }
 842
 843                 if ( $user->isAllowed( 'minoredit' ) ) {
 844                         $defaultPreferences['minordefault'] = [
 845                                 'type' => 'toggle',
 846                                 'section' => 'editing/editor',
 847                                 'label-message' => 'tog-minordefault',
 848                         ];
 849                 }
 850
 851                 $defaultPreferences['forceeditsummary'] = [
 852                         'type' => 'toggle',
 853                         'section' => 'editing/editor',
 854                         'label-message' => 'tog-forceeditsummary',
 855                 ];
 856                 $defaultPreferences['useeditwarning'] = [
 857                         'type' => 'toggle',
 858                         'section' => 'editing/editor',
 859                         'label-message' => 'tog-useeditwarning',
 860                 ];
 861                 $defaultPreferences['showtoolbar'] = [
 862                         'type' => 'toggle',
 863                         'section' => 'editing/editor',
 864                         'label-message' => 'tog-showtoolbar',
 865                 ];
 866
 867                 $defaultPreferences['previewonfirst'] = [
 868                         'type' => 'toggle',
 869                         'section' => 'editing/preview',
 870                         'label-message' => 'tog-previewonfirst',
 871                 ];
 872                 $defaultPreferences['previewontop'] = [
 873                         'type' => 'toggle',
 874                         'section' => 'editing/preview',
 875                         'label-message' => 'tog-previewontop',
 876                 ];
 877                 $defaultPreferences['uselivepreview'] = [
 878                         'type' => 'toggle',
 879                         'section' => 'editing/preview',
 880                         'label-message' => 'tog-uselivepreview',
 881                 ];
 882         }
 883
 884         /**
 885          * @param User $user
 886          * @param IContextSource $context
 887          * @param array $defaultPreferences
 888          */
 889         static function rcPreferences( $user, IContextSource $context, &$defaultPreferences ) {
 890                 $config = $context->getConfig();
 891                 $rcMaxAge = $config->get( 'RCMaxAge' );
 892                 # # RecentChanges #####################################
 893                 $defaultPreferences['rcdays'] = [
 894                         'type' => 'float',
 895                         'label-message' => 'recentchangesdays',
 896                         'section' => 'rc/displayrc',
 897                         'min' => 1,
 898                         'max' => ceil( $rcMaxAge / ( 3600 * 24 ) ),
 899                         'help' => $context->msg( 'recentchangesdays-max' )->numParams(
 900                                 ceil( $rcMaxAge / ( 3600 * 24 ) ) )->escaped()
 901                 ];
 902                 $defaultPreferences['rclimit'] = [
 903                         'type' => 'int',
 904                         'label-message' => 'recentchangescount',
 905                         'help-message' => 'prefs-help-recentchangescount',
 906                         'section' => 'rc/displayrc',
 907                 ];
 908                 $defaultPreferences['usenewrc'] = [
 909                         'type' => 'toggle',
 910                         'label-message' => 'tog-usenewrc',
 911                         'section' => 'rc/advancedrc',
 912                 ];
 913                 $defaultPreferences['hideminor'] = [
 914                         'type' => 'toggle',
 915                         'label-message' => 'tog-hideminor',
 916                         'section' => 'rc/advancedrc',
 917                 ];
 918
 919                 if ( $config->get( 'RCWatchCategoryMembership' ) ) {
 920                         $defaultPreferences['hidecategorization'] = [
 921                                 'type' => 'toggle',
 922                                 'label-message' => 'tog-hidecategorization',
 923                                 'section' => 'rc/advancedrc',
 924                         ];
 925                 }
 926
 927                 if ( $user->useRCPatrol() ) {
 928                         $defaultPreferences['hidepatrolled'] = [
 929                                 'type' => 'toggle',
 930                                 'section' => 'rc/advancedrc',
 931                                 'label-message' => 'tog-hidepatrolled',
 932                         ];
 933                 }
 934
 935                 if ( $user->useNPPatrol() ) {
 936                         $defaultPreferences['newpageshidepatrolled'] = [
 937                                 'type' => 'toggle',
 938                                 'section' => 'rc/advancedrc',
 939                                 'label-message' => 'tog-newpageshidepatrolled',
 940                         ];
 941                 }
 942
 943                 if ( $config->get( 'RCShowWatchingUsers' ) ) {
 944                         $defaultPreferences['shownumberswatching'] = [
 945                                 'type' => 'toggle',
 946                                 'section' => 'rc/advancedrc',
 947                                 'label-message' => 'tog-shownumberswatching',
 948                         ];
 949                 }
 950         }
 951
 952         /**
 953          * @param User $user
 954          * @param IContextSource $context
 955          * @param array $defaultPreferences
 956          */
 957         static function watchlistPreferences( $user, IContextSource $context, &$defaultPreferences ) {
 958                 $config = $context->getConfig();
 959                 $watchlistdaysMax = ceil( $config->get( 'RCMaxAge' ) / ( 3600 * 24 ) );
 960
 961                 # # Watchlist #####################################
 962                 if ( $user->isAllowed( 'editmywatchlist' ) ) {
 963                         $editWatchlistLinks = [];
 964                         $editWatchlistModes = [
 965                                 'edit' => [ 'EditWatchlist', false ],
 966                                 'raw' => [ 'EditWatchlist', 'raw' ],
 967                                 'clear' => [ 'EditWatchlist', 'clear' ],
 968                         ];
 969                         $linkRenderer = MediaWikiServices::getInstance()->getLinkRenderer();
 970                         foreach ( $editWatchlistModes as $editWatchlistMode => $mode ) {
 971                                 // Messages: prefs-editwatchlist-edit, prefs-editwatchlist-raw, prefs-editwatchlist-clear
 972                                 $editWatchlistLinks[] = $linkRenderer->makeKnownLink(
 973                                         SpecialPage::getTitleFor( $mode[0], $mode[1] ),
 974                                         new HtmlArmor( $context->msg( "prefs-editwatchlist-{$editWatchlistMode}" )->parse() )
 975                                 );
 976                         }
 977
 978                         $defaultPreferences['editwatchlist'] = [
 979                                 'type' => 'info',
 980                                 'raw' => true,
 981                                 'default' => $context->getLanguage()->pipeList( $editWatchlistLinks ),
 982                                 'label-message' => 'prefs-editwatchlist-label',
 983                                 'section' => 'watchlist/editwatchlist',
 984                         ];
 985                 }
 986
 987                 $defaultPreferences['watchlistdays'] = [
 988                         'type' => 'float',
 989                         'min' => 0,
 990                         'max' => $watchlistdaysMax,
 991                         'section' => 'watchlist/displaywatchlist',
 992                         'help' => $context->msg( 'prefs-watchlist-days-max' )->numParams(
 993                                 $watchlistdaysMax )->escaped(),
 994                         'label-message' => 'prefs-watchlist-days',
 995                 ];
 996                 $defaultPreferences['wllimit'] = [
 997                         'type' => 'int',
 998                         'min' => 0,
 999                         'max' => 1000,
1000                         'label-message' => 'prefs-watchlist-edits',
1001                         'help' => $context->msg( 'prefs-watchlist-edits-max' )->escaped(),
1002                         'section' => 'watchlist/displaywatchlist',
1003                 ];
1004                 $defaultPreferences['extendwatchlist'] = [
1005                         'type' => 'toggle',
1006                         'section' => 'watchlist/advancedwatchlist',
1007                         'label-message' => 'tog-extendwatchlist',
1008                 ];
1009                 $defaultPreferences['watchlisthideminor'] = [
1010                         'type' => 'toggle',
1011                         'section' => 'watchlist/advancedwatchlist',
1012                         'label-message' => 'tog-watchlisthideminor',
1013                 ];
1014                 $defaultPreferences['watchlisthidebots'] = [
1015                         'type' => 'toggle',
1016                         'section' => 'watchlist/advancedwatchlist',
1017                         'label-message' => 'tog-watchlisthidebots',
1018                 ];
1019                 $defaultPreferences['watchlisthideown'] = [
1020                         'type' => 'toggle',
1021                         'section' => 'watchlist/advancedwatchlist',
1022                         'label-message' => 'tog-watchlisthideown',
1023                 ];
1024                 $defaultPreferences['watchlisthideanons'] = [
1025                         'type' => 'toggle',
1026                         'section' => 'watchlist/advancedwatchlist',
1027                         'label-message' => 'tog-watchlisthideanons',
1028                 ];
1029                 $defaultPreferences['watchlisthideliu'] = [
1030                         'type' => 'toggle',
1031                         'section' => 'watchlist/advancedwatchlist',
1032                         'label-message' => 'tog-watchlisthideliu',
1033                 ];
1034                 $defaultPreferences['watchlistreloadautomatically'] = [
1035                         'type' => 'toggle',
1036                         'section' => 'watchlist/advancedwatchlist',
1037                         'label-message' => 'tog-watchlistreloadautomatically',
1038                 ];
1039
1040                 if ( $config->get( 'RCWatchCategoryMembership' ) ) {
1041                         $defaultPreferences['watchlisthidecategorization'] = [
1042                                 'type' => 'toggle',
1043                                 'section' => 'watchlist/advancedwatchlist',
1044                                 'label-message' => 'tog-watchlisthidecategorization',
1045                         ];
1046                 }
1047
1048                 if ( $user->useRCPatrol() ) {
1049                         $defaultPreferences['watchlisthidepatrolled'] = [
1050                                 'type' => 'toggle',
1051                                 'section' => 'watchlist/advancedwatchlist',
1052                                 'label-message' => 'tog-watchlisthidepatrolled',
1053                         ];
1054                 }
1055
1056                 $watchTypes = [
1057                         'edit' => 'watchdefault',
1058                         'move' => 'watchmoves',
1059                         'delete' => 'watchdeletion'
1060                 ];
1061
1062                 // Kinda hacky
1063                 if ( $user->isAllowed( 'createpage' ) || $user->isAllowed( 'createtalk' ) ) {
1064                         $watchTypes['read'] = 'watchcreations';
1065                 }
1066
1067                 if ( $user->isAllowed( 'rollback' ) ) {
1068                         $watchTypes['rollback'] = 'watchrollback';
1069                 }
1070
1071                 if ( $user->isAllowed( 'upload' ) ) {
1072                         $watchTypes['upload'] = 'watchuploads';
1073                 }
1074
1075                 foreach ( $watchTypes as $action => $pref ) {
1076                         if ( $user->isAllowed( $action ) ) {
1077                                 // Messages:
1078                                 // tog-watchdefault, tog-watchmoves, tog-watchdeletion, tog-watchcreations, tog-watchuploads
1079                                 // tog-watchrollback
1080                                 $defaultPreferences[$pref] = [
1081                                         'type' => 'toggle',
1082                                         'section' => 'watchlist/advancedwatchlist',
1083                                         'label-message' => "tog-$pref",
1084                                 ];
1085                         }
1086                 }
1087
1088                 if ( $config->get( 'EnableAPI' ) ) {
1089                         $defaultPreferences['watchlisttoken'] = [
1090                                 'type' => 'api',
1091                         ];
1092                         $defaultPreferences['watchlisttoken-info'] = [
1093                                 'type' => 'info',
1094                                 'section' => 'watchlist/tokenwatchlist',
1095                                 'label-message' => 'prefs-watchlist-token',
1096                                 'default' => $user->getTokenFromOption( 'watchlisttoken' ),
1097                                 'help-message' => 'prefs-help-watchlist-token2',
1098                         ];
1099                 }
1100         }
1101
1102         /**
1103          * @param User $user
1104          * @param IContextSource $context
1105          * @param array $defaultPreferences
1106          */
1107         static function searchPreferences( $user, IContextSource $context, &$defaultPreferences ) {
1108                 foreach ( MWNamespace::getValidNamespaces() as $n ) {
1109                         $defaultPreferences['searchNs' . $n] = [
1110                                 'type' => 'api',
1111                         ];
1112                 }
1113         }
1114
1115         /**
1116          * Dummy, kept for backwards-compatibility.
1117          */
1118         static function miscPreferences( $user, IContextSource $context, &$defaultPreferences ) {
1119         }
1120
1121         /**
1122          * @param User $user The User object
1123          * @param IContextSource $context
1124          * @return array Text/links to display as key; $skinkey as value
1125          */
1126         static function generateSkinOptions( $user, IContextSource $context ) {
1127                 $ret = [];
1128
1129                 $mptitle = Title::newMainPage();
1130                 $previewtext = $context->msg( 'skin-preview' )->escaped();
1131
1132                 $linkRenderer = MediaWikiServices::getInstance()->getLinkRenderer();
1133
1134                 # Only show skins that aren't disabled in $wgSkipSkins
1135                 $validSkinNames = Skin::getAllowedSkins();
1136
1137                 # Sort by UI skin name. First though need to update validSkinNames as sometimes
1138                 # the skinkey & UI skinname differ (e.g. "standard" skinkey is "Classic" in the UI).
1139                 foreach ( $validSkinNames as $skinkey => &$skinname ) {
1140                         $msg = $context->msg( "skinname-{$skinkey}" );
1141                         if ( $msg->exists() ) {
1142                                 $skinname = htmlspecialchars( $msg->text() );
1143                         }
1144                 }
1145                 asort( $validSkinNames );
1146
1147                 $config = $context->getConfig();
1148                 $defaultSkin = $config->get( 'DefaultSkin' );
1149                 $allowUserCss = $config->get( 'AllowUserCss' );
1150                 $allowUserJs = $config->get( 'AllowUserJs' );
1151
1152                 $foundDefault = false;
1153                 foreach ( $validSkinNames as $skinkey => $sn ) {
1154                         $linkTools = [];
1155
1156                         # Mark the default skin
1157                         if ( strcasecmp( $skinkey, $defaultSkin ) === 0 ) {
1158                                 $linkTools[] = $context->msg( 'default' )->escaped();
1159                                 $foundDefault = true;
1160                         }
1161
1162                         # Create preview link
1163                         $mplink = htmlspecialchars( $mptitle->getLocalURL( [ 'useskin' => $skinkey ] ) );
1164                         $linkTools[] = "<a target='_blank' href=\"$mplink\">$previewtext</a>";
1165
1166                         # Create links to user CSS/JS pages
1167                         if ( $allowUserCss ) {
1168                                 $cssPage = Title::makeTitleSafe( NS_USER, $user->getName() . '/' . $skinkey . '.css' );
1169                                 $linkTools[] = $linkRenderer->makeLink( $cssPage, $context->msg( 'prefs-custom-css' )->text() );
1170                         }
1171
1172                         if ( $allowUserJs ) {
1173                                 $jsPage = Title::makeTitleSafe( NS_USER, $user->getName() . '/' . $skinkey . '.js' );
1174                                 $linkTools[] = $linkRenderer->makeLink( $jsPage, $context->msg( 'prefs-custom-js' )->text() );
1175                         }
1176
1177                         $display = $sn . ' ' . $context->msg( 'parentheses' )
1178                                 ->rawParams( $context->getLanguage()->pipeList( $linkTools ) )
1179                                 ->escaped();
1180                         $ret[$display] = $skinkey;
1181                 }
1182
1183                 if ( !$foundDefault ) {
1184                         // If the default skin is not available, things are going to break horribly because the
1185                         // default value for skin selector will not be a valid value. Let's just not show it then.
1186                         return [];
1187                 }
1188
1189                 return $ret;
1190         }
1191
1192         /**
1193          * @param IContextSource $context
1194          * @return array
1195          */
1196         static function getDateOptions( IContextSource $context ) {
1197                 $lang = $context->getLanguage();
1198                 $dateopts = $lang->getDatePreferences();
1199
1200                 $ret = [];
1201
1202                 if ( $dateopts ) {
1203                         if ( !in_array( 'default', $dateopts ) ) {
1204                                 $dateopts[] = 'default'; // Make sure default is always valid
1205                                                                                 // Bug 19237
1206                         }
1207
1208                         // FIXME KLUGE: site default might not be valid for user language
1209                         global $wgDefaultUserOptions;
1210                         if ( !in_array( $wgDefaultUserOptions['date'], $dateopts ) ) {
1211                                 $wgDefaultUserOptions['date'] = 'default';
1212                         }
1213
1214                         $epoch = wfTimestampNow();
1215                         foreach ( $dateopts as $key ) {
1216                                 if ( $key == 'default' ) {
1217                                         $formatted = $context->msg( 'datedefault' )->escaped();
1218                                 } else {
1219                                         $formatted = htmlspecialchars( $lang->timeanddate( $epoch, false, $key ) );
1220                                 }
1221                                 $ret[$formatted] = $key;
1222                         }
1223                 }
1224                 return $ret;
1225         }
1226
1227         /**
1228          * @param IContextSource $context
1229          * @return array
1230          */
1231         static function getImageSizes( IContextSource $context ) {
1232                 $ret = [];
1233                 $pixels = $context->msg( 'unit-pixel' )->text();
1234
1235                 foreach ( $context->getConfig()->get( 'ImageLimits' ) as $index => $limits ) {
1236                         // Note: A left-to-right marker (\u200e) is inserted, see T144386
1237                         $display = "{$limits[0]}" . json_decode( '"\u200e"' ) . "×{$limits[1]}" . $pixels;
1238                         $ret[$display] = $index;
1239                 }
1240
1241                 return $ret;
1242         }
1243
1244         /**
1245          * @param IContextSource $context
1246          * @return array
1247          */
1248         static function getThumbSizes( IContextSource $context ) {
1249                 $ret = [];
1250                 $pixels = $context->msg( 'unit-pixel' )->text();
1251
1252                 foreach ( $context->getConfig()->get( 'ThumbLimits' ) as $index => $size ) {
1253                         $display = $size . $pixels;
1254                         $ret[$display] = $index;
1255                 }
1256
1257                 return $ret;
1258         }
1259
1260         /**
1261          * @param string $signature
1262          * @param array $alldata
1263          * @param HTMLForm $form
1264          * @return bool|string
1265          */
1266         static function validateSignature( $signature, $alldata, $form ) {
1267                 global $wgParser;
1268                 $maxSigChars = $form->getConfig()->get( 'MaxSigChars' );
1269                 if ( mb_strlen( $signature ) > $maxSigChars ) {
1270                         return Xml::element( 'span', [ 'class' => 'error' ],
1271                                 $form->msg( 'badsiglength' )->numParams( $maxSigChars )->text() );
1272                 } elseif ( isset( $alldata['fancysig'] ) &&
1273                                 $alldata['fancysig'] &&
1274                                 $wgParser->validateSig( $signature ) === false
1275                 ) {
1276                         return Xml::element(
1277                                 'span',
1278                                 [ 'class' => 'error' ],
1279                                 $form->msg( 'badsig' )->text()
1280                         );
1281                 } else {
1282                         return true;
1283                 }
1284         }
1285
1286         /**
1287          * @param string $signature
1288          * @param array $alldata
1289          * @param HTMLForm $form
1290          * @return string
1291          */
1292         static function cleanSignature( $signature, $alldata, $form ) {
1293                 if ( isset( $alldata['fancysig'] ) && $alldata['fancysig'] ) {
1294                         global $wgParser;
1295                         $signature = $wgParser->cleanSig( $signature );
1296                 } else {
1297                         // When no fancy sig used, make sure ~{3,5} get removed.
1298                         $signature = Parser::cleanSigInSig( $signature );
1299                 }
1300
1301                 return $signature;
1302         }
1303
1304         /**
1305          * @param User $user
1306          * @param IContextSource $context
1307          * @param string $formClass
1308          * @param array $remove Array of items to remove
1309          * @return PreferencesForm|HtmlForm
1310          */
1311         static function getFormObject(
1312                 $user,
1313                 IContextSource $context,
1314                 $formClass = 'PreferencesForm',
1315                 array $remove = []
1316         ) {
1317                 $formDescriptor = Preferences::getPreferences( $user, $context );
1318                 if ( count( $remove ) ) {
1319                         $removeKeys = array_flip( $remove );
1320                         $formDescriptor = array_diff_key( $formDescriptor, $removeKeys );
1321                 }
1322
1323                 // Remove type=api preferences. They are not intended for rendering in the form.
1324                 foreach ( $formDescriptor as $name => $info ) {
1325                         if ( isset( $info['type'] ) && $info['type'] === 'api' ) {
1326                                 unset( $formDescriptor[$name] );
1327                         }
1328                 }
1329
1330                 /**
1331                  * @var $htmlForm PreferencesForm
1332                  */
1333                 $htmlForm = new $formClass( $formDescriptor, $context, 'prefs' );
1334
1335                 $htmlForm->setModifiedUser( $user );
1336                 $htmlForm->setId( 'mw-prefs-form' );
1337                 $htmlForm->setAutocomplete( 'off' );
1338                 $htmlForm->setSubmitText( $context->msg( 'saveprefs' )->text() );
1339                 # Used message keys: 'accesskey-preferences-save', 'tooltip-preferences-save'
1340                 $htmlForm->setSubmitTooltip( 'preferences-save' );
1341                 $htmlForm->setSubmitID( 'prefsubmit' );
1342                 $htmlForm->setSubmitCallback( [ 'Preferences', 'tryFormSubmit' ] );
1343
1344                 return $htmlForm;
1345         }
1346
1347         /**
1348          * @param IContextSource $context
1349          * @return array
1350          */
1351         static function getTimezoneOptions( IContextSource $context ) {
1352                 $opt = [];
1353
1354                 $localTZoffset = $context->getConfig()->get( 'LocalTZoffset' );
1355                 $timeZoneList = self::getTimeZoneList( $context->getLanguage() );
1356
1357                 $timestamp = MWTimestamp::getLocalInstance();
1358                 // Check that the LocalTZoffset is the same as the local time zone offset
1359                 if ( $localTZoffset == $timestamp->format( 'Z' ) / 60 ) {
1360                         $timezoneName = $timestamp->getTimezone()->getName();
1361                         // Localize timezone
1362                         if ( isset( $timeZoneList[$timezoneName] ) ) {
1363                                 $timezoneName = $timeZoneList[$timezoneName]['name'];
1364                         }
1365                         $server_tz_msg = $context->msg(
1366                                 'timezoneuseserverdefault',
1367                                 $timezoneName
1368                         )->text();
1369                 } else {
1370                         $tzstring = sprintf(
1371                                 '%+03d:%02d',
1372                                 floor( $localTZoffset / 60 ),
1373                                 abs( $localTZoffset ) % 60
1374                         );
1375                         $server_tz_msg = $context->msg( 'timezoneuseserverdefault', $tzstring )->text();
1376                 }
1377                 $opt[$server_tz_msg] = "System|$localTZoffset";
1378                 $opt[$context->msg( 'timezoneuseoffset' )->text()] = 'other';
1379                 $opt[$context->msg( 'guesstimezone' )->text()] = 'guess';
1380
1381                 foreach ( $timeZoneList as $timeZoneInfo ) {
1382                         $region = $timeZoneInfo['region'];
1383                         if ( !isset( $opt[$region] ) ) {
1384                                 $opt[$region] = [];
1385                         }
1386                         $opt[$region][$timeZoneInfo['name']] = $timeZoneInfo['timecorrection'];
1387                 }
1388                 return $opt;
1389         }
1390
1391         /**
1392          * @param string $value
1393          * @param array $alldata
1394          * @return int
1395          */
1396         static function filterIntval( $value, $alldata ) {
1397                 return intval( $value );
1398         }
1399
1400         /**
1401          * @param string $tz
1402          * @param array $alldata
1403          * @return string
1404          */
1405         static function filterTimezoneInput( $tz, $alldata ) {
1406                 $data = explode( '|', $tz, 3 );
1407                 switch ( $data[0] ) {
1408                         case 'ZoneInfo':
1409                                 $valid = false;
1410
1411                                 if ( count( $data ) === 3 ) {
1412                                         // Make sure this timezone exists
1413                                         try {
1414                                                 new DateTimeZone( $data[2] );
1415                                                 // If the constructor didn't throw, we know it's valid
1416                                                 $valid = true;
1417                                         } catch ( Exception $e ) {
1418                                                 // Not a valid timezone
1419                                         }
1420                                 }
1421
1422                                 if ( !$valid ) {
1423                                         // If the supplied timezone doesn't exist, fall back to the encoded offset
1424                                         return 'Offset|' . intval( $tz[1] );
1425                                 }
1426                                 return $tz;
1427                         case 'System':
1428                                 return $tz;
1429                         default:
1430                                 $data = explode( ':', $tz, 2 );
1431                                 if ( count( $data ) == 2 ) {
1432                                         $data[0] = intval( $data[0] );
1433                                         $data[1] = intval( $data[1] );
1434                                         $minDiff = abs( $data[0] ) * 60 + $data[1];
1435                                         if ( $data[0] < 0 ) {
1436                                                 $minDiff = - $minDiff;
1437                                         }
1438                                 } else {
1439                                         $minDiff = intval( $data[0] ) * 60;
1440                                 }
1441
1442                                 # Max is +14:00 and min is -12:00, see:
1443                                 # https://en.wikipedia.org/wiki/Timezone
1444                                 $minDiff = min( $minDiff, 840 );  # 14:00
1445                                 $minDiff = max( $minDiff, -720 ); # -12:00
1446                                 return 'Offset|' . $minDiff;
1447                 }
1448         }
1449
1450         /**
1451          * Handle the form submission if everything validated properly
1452          *
1453          * @param array $formData
1454          * @param PreferencesForm $form
1455          * @return bool|Status|string
1456          */
1457         static function tryFormSubmit( $formData, $form ) {
1458                 $user = $form->getModifiedUser();
1459                 $hiddenPrefs = $form->getConfig()->get( 'HiddenPrefs' );
1460                 $result = true;
1461
1462                 if ( !$user->isAllowedAny( 'editmyprivateinfo', 'editmyoptions' ) ) {
1463                         return Status::newFatal( 'mypreferencesprotected' );
1464                 }
1465
1466                 // Filter input
1467                 foreach ( array_keys( $formData ) as $name ) {
1468                         if ( isset( self::$saveFilters[$name] ) ) {
1469                                 $formData[$name] =
1470                                         call_user_func( self::$saveFilters[$name], $formData[$name], $formData );
1471                         }
1472                 }
1473
1474                 // Fortunately, the realname field is MUCH simpler
1475                 // (not really "private", but still shouldn't be edited without permission)
1476
1477                 if ( !in_array( 'realname', $hiddenPrefs )
1478                         && $user->isAllowed( 'editmyprivateinfo' )
1479                         && array_key_exists( 'realname', $formData )
1480                 ) {
1481                         $realName = $formData['realname'];
1482                         $user->setRealName( $realName );
1483                 }
1484
1485                 if ( $user->isAllowed( 'editmyoptions' ) ) {
1486                         foreach ( self::$saveBlacklist as $b ) {
1487                                 unset( $formData[$b] );
1488                         }
1489
1490                         # If users have saved a value for a preference which has subsequently been disabled
1491                         # via $wgHiddenPrefs, we don't want to destroy that setting in case the preference
1492                         # is subsequently re-enabled
1493                         foreach ( $hiddenPrefs as $pref ) {
1494                                 # If the user has not set a non-default value here, the default will be returned
1495                                 # and subsequently discarded
1496                                 $formData[$pref] = $user->getOption( $pref, null, true );
1497                         }
1498
1499                         // Keep old preferences from interfering due to back-compat code, etc.
1500                         $user->resetOptions( 'unused', $form->getContext() );
1501
1502                         foreach ( $formData as $key => $value ) {
1503                                 $user->setOption( $key, $value );
1504                         }
1505
1506                         Hooks::run( 'PreferencesFormPreSave', [ $formData, $form, $user, &$result ] );
1507                 }
1508
1509                 MediaWiki\Auth\AuthManager::callLegacyAuthPlugin( 'updateExternalDB', [ $user ] );
1510                 $user->saveSettings();
1511
1512                 return $result;
1513         }
1514
1515         /**
1516          * @param array $formData
1517          * @param PreferencesForm $form
1518          * @return Status
1519          */
1520         public static function tryUISubmit( $formData, $form ) {
1521                 $res = self::tryFormSubmit( $formData, $form );
1522
1523                 if ( $res ) {
1524                         $urlOptions = [];
1525
1526                         if ( $res === 'eauth' ) {
1527                                 $urlOptions['eauth'] = 1;
1528                         }
1529
1530                         $urlOptions += $form->getExtraSuccessRedirectParameters();
1531
1532                         $url = $form->getTitle()->getFullURL( $urlOptions );
1533
1534                         $context = $form->getContext();
1535                         // Set session data for the success message
1536                         $context->getRequest()->getSession()->set( 'specialPreferencesSaveSuccess', 1 );
1537
1538                         $context->getOutput()->redirect( $url );
1539                 }
1540
1541                 return Status::newGood();
1542         }
1543
1544         /**
1545          * Get a list of all time zones
1546          * @param Language $language Language used for the localized names
1547          * @return array A list of all time zones. The system name of the time zone is used as key and
1548          *  the value is an array which contains localized name, the timecorrection value used for
1549          *  preferences and the region
1550          * @since 1.26
1551          */
1552         public static function getTimeZoneList( Language $language ) {
1553                 $identifiers = DateTimeZone::listIdentifiers();
1554                 if ( $identifiers === false ) {
1555                         return [];
1556                 }
1557                 sort( $identifiers );
1558
1559                 $tzRegions = [
1560                         'Africa' => wfMessage( 'timezoneregion-africa' )->inLanguage( $language )->text(),
1561                         'America' => wfMessage( 'timezoneregion-america' )->inLanguage( $language )->text(),
1562                         'Antarctica' => wfMessage( 'timezoneregion-antarctica' )->inLanguage( $language )->text(),
1563                         'Arctic' => wfMessage( 'timezoneregion-arctic' )->inLanguage( $language )->text(),
1564                         'Asia' => wfMessage( 'timezoneregion-asia' )->inLanguage( $language )->text(),
1565                         'Atlantic' => wfMessage( 'timezoneregion-atlantic' )->inLanguage( $language )->text(),
1566                         'Australia' => wfMessage( 'timezoneregion-australia' )->inLanguage( $language )->text(),
1567                         'Europe' => wfMessage( 'timezoneregion-europe' )->inLanguage( $language )->text(),
1568                         'Indian' => wfMessage( 'timezoneregion-indian' )->inLanguage( $language )->text(),
1569                         'Pacific' => wfMessage( 'timezoneregion-pacific' )->inLanguage( $language )->text(),
1570                 ];
1571                 asort( $tzRegions );
1572
1573                 $timeZoneList = [];
1574
1575                 $now = new DateTime();
1576
1577                 foreach ( $identifiers as $identifier ) {
1578                         $parts = explode( '/', $identifier, 2 );
1579
1580                         // DateTimeZone::listIdentifiers() returns a number of
1581                         // backwards-compatibility entries. This filters them out of the
1582                         // list presented to the user.
1583                         if ( count( $parts ) !== 2 || !array_key_exists( $parts[0], $tzRegions ) ) {
1584                                 continue;
1585                         }
1586
1587                         // Localize region
1588                         $parts[0] = $tzRegions[$parts[0]];
1589
1590                         $dateTimeZone = new DateTimeZone( $identifier );
1591                         $minDiff = floor( $dateTimeZone->getOffset( $now ) / 60 );
1592
1593                         $display = str_replace( '_', ' ', $parts[0] . '/' . $parts[1] );
1594                         $value = "ZoneInfo|$minDiff|$identifier";
1595
1596                         $timeZoneList[$identifier] = [
1597                                 'name' => $display,
1598                                 'timecorrection' => $value,
1599                                 'region' => $parts[0],
1600                         ];
1601                 }
1602
1603                 return $timeZoneList;
1604         }
1605 }
1606
1607 /** Some tweaks to allow js prefs to work */
1608 class PreferencesForm extends HTMLForm {
1609         // Override default value from HTMLForm
1610         protected $mSubSectionBeforeFields = false;
1611
1612         private $modifiedUser;
1613
1614         /**
1615          * @param User $user
1616          */
1617         public function setModifiedUser( $user ) {
1618                 $this->modifiedUser = $user;
1619         }
1620
1621         /**
1622          * @return User
1623          */
1624         public function getModifiedUser() {
1625                 if ( $this->modifiedUser === null ) {
1626                         return $this->getUser();
1627                 } else {
1628                         return $this->modifiedUser;
1629                 }
1630         }
1631
1632         /**
1633          * Get extra parameters for the query string when redirecting after
1634          * successful save.
1635          *
1636          * @return array
1637          */
1638         public function getExtraSuccessRedirectParameters() {
1639                 return [];
1640         }
1641
1642         /**
1643          * @param string $html
1644          * @return string
1645          */
1646         function wrapForm( $html ) {
1647                 $html = Xml::tags( 'div', [ 'id' => 'preferences' ], $html );
1648
1649                 return parent::wrapForm( $html );
1650         }
1651
1652         /**
1653          * @return string
1654          */
1655         function getButtons() {
1656                 $attrs = [ 'id' => 'mw-prefs-restoreprefs' ];
1657
1658                 if ( !$this->getModifiedUser()->isAllowedAny( 'editmyprivateinfo', 'editmyoptions' ) ) {
1659                         return '';
1660                 }
1661
1662                 $html = parent::getButtons();
1663
1664                 if ( $this->getModifiedUser()->isAllowed( 'editmyoptions' ) ) {
1665                         $t = SpecialPage::getTitleFor( 'Preferences', 'reset' );
1666
1667                         $linkRenderer = MediaWikiServices::getInstance()->getLinkRenderer();
1668                         $html .= "\n" . $linkRenderer->makeLink( $t, $this->msg( 'restoreprefs' )->text(),
1669                                 Html::buttonAttributes( $attrs, [ 'mw-ui-quiet' ] ) );
1670
1671                         $html = Xml::tags( 'div', [ 'class' => 'mw-prefs-buttons' ], $html );
1672                 }
1673
1674                 return $html;
1675         }
1676
1677         /**
1678          * Separate multi-option preferences into multiple preferences, since we
1679          * have to store them separately
1680          * @param array $data
1681          * @return array
1682          */
1683         function filterDataForSubmit( $data ) {
1684                 foreach ( $this->mFlatFields as $fieldname => $field ) {
1685                         if ( $field instanceof HTMLNestedFilterable ) {
1686                                 $info = $field->mParams;
1687                                 $prefix = isset( $info['prefix'] ) ? $info['prefix'] : $fieldname;
1688                                 foreach ( $field->filterDataForSubmit( $data[$fieldname] ) as $key => $value ) {
1689                                         $data["$prefix$key"] = $value;
1690                                 }
1691                                 unset( $data[$fieldname] );
1692                         }
1693                 }
1694
1695                 return $data;
1696         }
1697
1698         /**
1699          * Get the whole body of the form.
1700          * @return string
1701          */
1702         function getBody() {
1703                 return $this->displaySection( $this->mFieldTree, '', 'mw-prefsection-' );
1704         }
1705
1706         /**
1707          * Get the "<legend>" for a given section key. Normally this is the
1708          * prefs-$key message but we'll allow extensions to override it.
1709          * @param string $key
1710          * @return string
1711          */
1712         function getLegend( $key ) {
1713                 $legend = parent::getLegend( $key );
1714                 Hooks::run( 'PreferencesGetLegend', [ $this, $key, &$legend ] );
1715                 return $legend;
1716         }
1717
1718         /**
1719          * Get the keys of each top level preference section.
1720          * @return array of section keys
1721          */
1722         function getPreferenceSections() {
1723                 return array_keys( array_filter( $this->mFieldTree, 'is_array' ) );
1724         }
1725 }