includes/Preferences.php

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