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 T43337.
 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-monospace' )->text() => 'monospace',
 836                                         $context->msg( 'editfont-sansserif' )->text() => 'sans-serif',
 837                                         $context->msg( 'editfont-serif' )->text() => 'serif',
 838                                         $context->msg( 'editfont-default' )->text() => 'default',
 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                         'min' => 0,
 905                         'max' => 1000,
 906                         'label-message' => 'recentchangescount',
 907                         'help-message' => 'prefs-help-recentchangescount',
 908                         'section' => 'rc/displayrc',
 909                 ];
 910                 $defaultPreferences['usenewrc'] = [
 911                         'type' => 'toggle',
 912                         'label-message' => 'tog-usenewrc',
 913                         'section' => 'rc/advancedrc',
 914                 ];
 915                 $defaultPreferences['hideminor'] = [
 916                         'type' => 'toggle',
 917                         'label-message' => 'tog-hideminor',
 918                         'section' => 'rc/advancedrc',
 919                 ];
 920                 $defaultPreferences['rcfilters-saved-queries'] = [
 921                         'type' => 'api',
 922                 ];
 923                 $defaultPreferences['rcfilters-wl-saved-queries'] = [
 924                         'type' => 'api',
 925                 ];
 926                 $defaultPreferences['rcfilters-rclimit'] = [
 927                         'type' => 'api',
 928                 ];
 929
 930                 if ( $config->get( 'RCWatchCategoryMembership' ) ) {
 931                         $defaultPreferences['hidecategorization'] = [
 932                                 'type' => 'toggle',
 933                                 'label-message' => 'tog-hidecategorization',
 934                                 'section' => 'rc/advancedrc',
 935                         ];
 936                 }
 937
 938                 if ( $user->useRCPatrol() ) {
 939                         $defaultPreferences['hidepatrolled'] = [
 940                                 'type' => 'toggle',
 941                                 'section' => 'rc/advancedrc',
 942                                 'label-message' => 'tog-hidepatrolled',
 943                         ];
 944                 }
 945
 946                 if ( $user->useNPPatrol() ) {
 947                         $defaultPreferences['newpageshidepatrolled'] = [
 948                                 'type' => 'toggle',
 949                                 'section' => 'rc/advancedrc',
 950                                 'label-message' => 'tog-newpageshidepatrolled',
 951                         ];
 952                 }
 953
 954                 if ( $config->get( 'RCShowWatchingUsers' ) ) {
 955                         $defaultPreferences['shownumberswatching'] = [
 956                                 'type' => 'toggle',
 957                                 'section' => 'rc/advancedrc',
 958                                 'label-message' => 'tog-shownumberswatching',
 959                         ];
 960                 }
 961
 962                 if ( $config->get( 'StructuredChangeFiltersShowPreference' ) ) {
 963                         $defaultPreferences['rcenhancedfilters-disable'] = [
 964                                 'type' => 'toggle',
 965                                 'section' => 'rc/advancedrc',
 966                                 'label-message' => 'rcfilters-preference-label',
 967                                 'help-message' => 'rcfilters-preference-help',
 968                         ];
 969                 }
 970         }
 971
 972         /**
 973          * @param User $user
 974          * @param IContextSource $context
 975          * @param array &$defaultPreferences
 976          */
 977         static function watchlistPreferences( $user, IContextSource $context, &$defaultPreferences ) {
 978                 $config = $context->getConfig();
 979                 $watchlistdaysMax = ceil( $config->get( 'RCMaxAge' ) / ( 3600 * 24 ) );
 980
 981                 # # Watchlist #####################################
 982                 if ( $user->isAllowed( 'editmywatchlist' ) ) {
 983                         $editWatchlistLinks = [];
 984                         $editWatchlistModes = [
 985                                 'edit' => [ 'EditWatchlist', false ],
 986                                 'raw' => [ 'EditWatchlist', 'raw' ],
 987                                 'clear' => [ 'EditWatchlist', 'clear' ],
 988                         ];
 989                         $linkRenderer = MediaWikiServices::getInstance()->getLinkRenderer();
 990                         foreach ( $editWatchlistModes as $editWatchlistMode => $mode ) {
 991                                 // Messages: prefs-editwatchlist-edit, prefs-editwatchlist-raw, prefs-editwatchlist-clear
 992                                 $editWatchlistLinks[] = $linkRenderer->makeKnownLink(
 993                                         SpecialPage::getTitleFor( $mode[0], $mode[1] ),
 994                                         new HtmlArmor( $context->msg( "prefs-editwatchlist-{$editWatchlistMode}" )->parse() )
 995                                 );
 996                         }
 997
 998                         $defaultPreferences['editwatchlist'] = [
 999                                 'type' => 'info',
1000                                 'raw' => true,
1001                                 'default' => $context->getLanguage()->pipeList( $editWatchlistLinks ),
1002                                 'label-message' => 'prefs-editwatchlist-label',
1003                                 'section' => 'watchlist/editwatchlist',
1004                         ];
1005                 }
1006
1007                 $defaultPreferences['watchlistdays'] = [
1008                         'type' => 'float',
1009                         'min' => 0,
1010                         'max' => $watchlistdaysMax,
1011                         'section' => 'watchlist/displaywatchlist',
1012                         'help' => $context->msg( 'prefs-watchlist-days-max' )->numParams(
1013                                 $watchlistdaysMax )->escaped(),
1014                         'label-message' => 'prefs-watchlist-days',
1015                 ];
1016                 $defaultPreferences['wllimit'] = [
1017                         'type' => 'int',
1018                         'min' => 0,
1019                         'max' => 1000,
1020                         'label-message' => 'prefs-watchlist-edits',
1021                         'help' => $context->msg( 'prefs-watchlist-edits-max' )->escaped(),
1022                         'section' => 'watchlist/displaywatchlist',
1023                 ];
1024                 $defaultPreferences['extendwatchlist'] = [
1025                         'type' => 'toggle',
1026                         'section' => 'watchlist/advancedwatchlist',
1027                         'label-message' => 'tog-extendwatchlist',
1028                 ];
1029                 $defaultPreferences['watchlisthideminor'] = [
1030                         'type' => 'toggle',
1031                         'section' => 'watchlist/advancedwatchlist',
1032                         'label-message' => 'tog-watchlisthideminor',
1033                 ];
1034                 $defaultPreferences['watchlisthidebots'] = [
1035                         'type' => 'toggle',
1036                         'section' => 'watchlist/advancedwatchlist',
1037                         'label-message' => 'tog-watchlisthidebots',
1038                 ];
1039                 $defaultPreferences['watchlisthideown'] = [
1040                         'type' => 'toggle',
1041                         'section' => 'watchlist/advancedwatchlist',
1042                         'label-message' => 'tog-watchlisthideown',
1043                 ];
1044                 $defaultPreferences['watchlisthideanons'] = [
1045                         'type' => 'toggle',
1046                         'section' => 'watchlist/advancedwatchlist',
1047                         'label-message' => 'tog-watchlisthideanons',
1048                 ];
1049                 $defaultPreferences['watchlisthideliu'] = [
1050                         'type' => 'toggle',
1051                         'section' => 'watchlist/advancedwatchlist',
1052                         'label-message' => 'tog-watchlisthideliu',
1053                 ];
1054                 $defaultPreferences['watchlistreloadautomatically'] = [
1055                         'type' => 'toggle',
1056                         'section' => 'watchlist/advancedwatchlist',
1057                         'label-message' => 'tog-watchlistreloadautomatically',
1058                 ];
1059                 $defaultPreferences['watchlistunwatchlinks'] = [
1060                         'type' => 'toggle',
1061                         'section' => 'watchlist/advancedwatchlist',
1062                         'label-message' => 'tog-watchlistunwatchlinks',
1063                 ];
1064
1065                 if ( $config->get( 'RCWatchCategoryMembership' ) ) {
1066                         $defaultPreferences['watchlisthidecategorization'] = [
1067                                 'type' => 'toggle',
1068                                 'section' => 'watchlist/advancedwatchlist',
1069                                 'label-message' => 'tog-watchlisthidecategorization',
1070                         ];
1071                 }
1072
1073                 if ( $user->useRCPatrol() ) {
1074                         $defaultPreferences['watchlisthidepatrolled'] = [
1075                                 'type' => 'toggle',
1076                                 'section' => 'watchlist/advancedwatchlist',
1077                                 'label-message' => 'tog-watchlisthidepatrolled',
1078                         ];
1079                 }
1080
1081                 $watchTypes = [
1082                         'edit' => 'watchdefault',
1083                         'move' => 'watchmoves',
1084                         'delete' => 'watchdeletion'
1085                 ];
1086
1087                 // Kinda hacky
1088                 if ( $user->isAllowed( 'createpage' ) || $user->isAllowed( 'createtalk' ) ) {
1089                         $watchTypes['read'] = 'watchcreations';
1090                 }
1091
1092                 if ( $user->isAllowed( 'rollback' ) ) {
1093                         $watchTypes['rollback'] = 'watchrollback';
1094                 }
1095
1096                 if ( $user->isAllowed( 'upload' ) ) {
1097                         $watchTypes['upload'] = 'watchuploads';
1098                 }
1099
1100                 foreach ( $watchTypes as $action => $pref ) {
1101                         if ( $user->isAllowed( $action ) ) {
1102                                 // Messages:
1103                                 // tog-watchdefault, tog-watchmoves, tog-watchdeletion, tog-watchcreations, tog-watchuploads
1104                                 // tog-watchrollback
1105                                 $defaultPreferences[$pref] = [
1106                                         'type' => 'toggle',
1107                                         'section' => 'watchlist/advancedwatchlist',
1108                                         'label-message' => "tog-$pref",
1109                                 ];
1110                         }
1111                 }
1112
1113                 if ( $config->get( 'EnableAPI' ) ) {
1114                         $defaultPreferences['watchlisttoken'] = [
1115                                 'type' => 'api',
1116                         ];
1117                         $defaultPreferences['watchlisttoken-info'] = [
1118                                 'type' => 'info',
1119                                 'section' => 'watchlist/tokenwatchlist',
1120                                 'label-message' => 'prefs-watchlist-token',
1121                                 'default' => $user->getTokenFromOption( 'watchlisttoken' ),
1122                                 'help-message' => 'prefs-help-watchlist-token2',
1123                         ];
1124                 }
1125         }
1126
1127         /**
1128          * @param User $user
1129          * @param IContextSource $context
1130          * @param array &$defaultPreferences
1131          */
1132         static function searchPreferences( $user, IContextSource $context, &$defaultPreferences ) {
1133                 foreach ( MWNamespace::getValidNamespaces() as $n ) {
1134                         $defaultPreferences['searchNs' . $n] = [
1135                                 'type' => 'api',
1136                         ];
1137                 }
1138         }
1139
1140         /**
1141          * Dummy, kept for backwards-compatibility.
1142          * @param User $user
1143          * @param IContextSource $context
1144          * @param array &$defaultPreferences
1145          */
1146         static function miscPreferences( $user, IContextSource $context, &$defaultPreferences ) {
1147         }
1148
1149         /**
1150          * @param User $user The User object
1151          * @param IContextSource $context
1152          * @return array Text/links to display as key; $skinkey as value
1153          */
1154         static function generateSkinOptions( $user, IContextSource $context ) {
1155                 $ret = [];
1156
1157                 $mptitle = Title::newMainPage();
1158                 $previewtext = $context->msg( 'skin-preview' )->escaped();
1159
1160                 $linkRenderer = MediaWikiServices::getInstance()->getLinkRenderer();
1161
1162                 # Only show skins that aren't disabled in $wgSkipSkins
1163                 $validSkinNames = Skin::getAllowedSkins();
1164
1165                 # Sort by UI skin name. First though need to update validSkinNames as sometimes
1166                 # the skinkey & UI skinname differ (e.g. "standard" skinkey is "Classic" in the UI).
1167                 foreach ( $validSkinNames as $skinkey => &$skinname ) {
1168                         $msg = $context->msg( "skinname-{$skinkey}" );
1169                         if ( $msg->exists() ) {
1170                                 $skinname = htmlspecialchars( $msg->text() );
1171                         }
1172                 }
1173                 asort( $validSkinNames );
1174
1175                 $config = $context->getConfig();
1176                 $defaultSkin = $config->get( 'DefaultSkin' );
1177                 $allowUserCss = $config->get( 'AllowUserCss' );
1178                 $allowUserJs = $config->get( 'AllowUserJs' );
1179
1180                 $foundDefault = false;
1181                 foreach ( $validSkinNames as $skinkey => $sn ) {
1182                         $linkTools = [];
1183
1184                         # Mark the default skin
1185                         if ( strcasecmp( $skinkey, $defaultSkin ) === 0 ) {
1186                                 $linkTools[] = $context->msg( 'default' )->escaped();
1187                                 $foundDefault = true;
1188                         }
1189
1190                         # Create preview link
1191                         $mplink = htmlspecialchars( $mptitle->getLocalURL( [ 'useskin' => $skinkey ] ) );
1192                         $linkTools[] = "<a target='_blank' href=\"$mplink\">$previewtext</a>";
1193
1194                         # Create links to user CSS/JS pages
1195                         if ( $allowUserCss ) {
1196                                 $cssPage = Title::makeTitleSafe( NS_USER, $user->getName() . '/' . $skinkey . '.css' );
1197                                 $linkTools[] = $linkRenderer->makeLink( $cssPage, $context->msg( 'prefs-custom-css' )->text() );
1198                         }
1199
1200                         if ( $allowUserJs ) {
1201                                 $jsPage = Title::makeTitleSafe( NS_USER, $user->getName() . '/' . $skinkey . '.js' );
1202                                 $linkTools[] = $linkRenderer->makeLink( $jsPage, $context->msg( 'prefs-custom-js' )->text() );
1203                         }
1204
1205                         $display = $sn . ' ' . $context->msg( 'parentheses' )
1206                                 ->rawParams( $context->getLanguage()->pipeList( $linkTools ) )
1207                                 ->escaped();
1208                         $ret[$display] = $skinkey;
1209                 }
1210
1211                 if ( !$foundDefault ) {
1212                         // If the default skin is not available, things are going to break horribly because the
1213                         // default value for skin selector will not be a valid value. Let's just not show it then.
1214                         return [];
1215                 }
1216
1217                 return $ret;
1218         }
1219
1220         /**
1221          * @param IContextSource $context
1222          * @return array
1223          */
1224         static function getDateOptions( IContextSource $context ) {
1225                 $lang = $context->getLanguage();
1226                 $dateopts = $lang->getDatePreferences();
1227
1228                 $ret = [];
1229
1230                 if ( $dateopts ) {
1231                         if ( !in_array( 'default', $dateopts ) ) {
1232                                 $dateopts[] = 'default'; // Make sure default is always valid T21237
1233                         }
1234
1235                         // FIXME KLUGE: site default might not be valid for user language
1236                         global $wgDefaultUserOptions;
1237                         if ( !in_array( $wgDefaultUserOptions['date'], $dateopts ) ) {
1238                                 $wgDefaultUserOptions['date'] = 'default';
1239                         }
1240
1241                         $epoch = wfTimestampNow();
1242                         foreach ( $dateopts as $key ) {
1243                                 if ( $key == 'default' ) {
1244                                         $formatted = $context->msg( 'datedefault' )->escaped();
1245                                 } else {
1246                                         $formatted = htmlspecialchars( $lang->timeanddate( $epoch, false, $key ) );
1247                                 }
1248                                 $ret[$formatted] = $key;
1249                         }
1250                 }
1251                 return $ret;
1252         }
1253
1254         /**
1255          * @param IContextSource $context
1256          * @return array
1257          */
1258         static function getImageSizes( IContextSource $context ) {
1259                 $ret = [];
1260                 $pixels = $context->msg( 'unit-pixel' )->text();
1261
1262                 foreach ( $context->getConfig()->get( 'ImageLimits' ) as $index => $limits ) {
1263                         // Note: A left-to-right marker (\u200e) is inserted, see T144386
1264                         $display = "{$limits[0]}" . json_decode( '"\u200e"' ) . "×{$limits[1]}" . $pixels;
1265                         $ret[$display] = $index;
1266                 }
1267
1268                 return $ret;
1269         }
1270
1271         /**
1272          * @param IContextSource $context
1273          * @return array
1274          */
1275         static function getThumbSizes( IContextSource $context ) {
1276                 $ret = [];
1277                 $pixels = $context->msg( 'unit-pixel' )->text();
1278
1279                 foreach ( $context->getConfig()->get( 'ThumbLimits' ) as $index => $size ) {
1280                         $display = $size . $pixels;
1281                         $ret[$display] = $index;
1282                 }
1283
1284                 return $ret;
1285         }
1286
1287         /**
1288          * @param string $signature
1289          * @param array $alldata
1290          * @param HTMLForm $form
1291          * @return bool|string
1292          */
1293         static function validateSignature( $signature, $alldata, $form ) {
1294                 global $wgParser;
1295                 $maxSigChars = $form->getConfig()->get( 'MaxSigChars' );
1296                 if ( mb_strlen( $signature ) > $maxSigChars ) {
1297                         return Xml::element( 'span', [ 'class' => 'error' ],
1298                                 $form->msg( 'badsiglength' )->numParams( $maxSigChars )->text() );
1299                 } elseif ( isset( $alldata['fancysig'] ) &&
1300                                 $alldata['fancysig'] &&
1301                                 $wgParser->validateSig( $signature ) === false
1302                 ) {
1303                         return Xml::element(
1304                                 'span',
1305                                 [ 'class' => 'error' ],
1306                                 $form->msg( 'badsig' )->text()
1307                         );
1308                 } else {
1309                         return true;
1310                 }
1311         }
1312
1313         /**
1314          * @param string $signature
1315          * @param array $alldata
1316          * @param HTMLForm $form
1317          * @return string
1318          */
1319         static function cleanSignature( $signature, $alldata, $form ) {
1320                 if ( isset( $alldata['fancysig'] ) && $alldata['fancysig'] ) {
1321                         global $wgParser;
1322                         $signature = $wgParser->cleanSig( $signature );
1323                 } else {
1324                         // When no fancy sig used, make sure ~{3,5} get removed.
1325                         $signature = Parser::cleanSigInSig( $signature );
1326                 }
1327
1328                 return $signature;
1329         }
1330
1331         /**
1332          * @param User $user
1333          * @param IContextSource $context
1334          * @param string $formClass
1335          * @param array $remove Array of items to remove
1336          * @return PreferencesForm|HtmlForm
1337          */
1338         static function getFormObject(
1339                 $user,
1340                 IContextSource $context,
1341                 $formClass = 'PreferencesForm',
1342                 array $remove = []
1343         ) {
1344                 $formDescriptor = self::getPreferences( $user, $context );
1345                 if ( count( $remove ) ) {
1346                         $removeKeys = array_flip( $remove );
1347                         $formDescriptor = array_diff_key( $formDescriptor, $removeKeys );
1348                 }
1349
1350                 // Remove type=api preferences. They are not intended for rendering in the form.
1351                 foreach ( $formDescriptor as $name => $info ) {
1352                         if ( isset( $info['type'] ) && $info['type'] === 'api' ) {
1353                                 unset( $formDescriptor[$name] );
1354                         }
1355                 }
1356
1357                 /**
1358                  * @var $htmlForm PreferencesForm
1359                  */
1360                 $htmlForm = new $formClass( $formDescriptor, $context, 'prefs' );
1361
1362                 $htmlForm->setModifiedUser( $user );
1363                 $htmlForm->setId( 'mw-prefs-form' );
1364                 $htmlForm->setAutocomplete( 'off' );
1365                 $htmlForm->setSubmitText( $context->msg( 'saveprefs' )->text() );
1366                 # Used message keys: 'accesskey-preferences-save', 'tooltip-preferences-save'
1367                 $htmlForm->setSubmitTooltip( 'preferences-save' );
1368                 $htmlForm->setSubmitID( 'prefsubmit' );
1369                 $htmlForm->setSubmitCallback( [ 'Preferences', 'tryFormSubmit' ] );
1370
1371                 return $htmlForm;
1372         }
1373
1374         /**
1375          * @param IContextSource $context
1376          * @return array
1377          */
1378         static function getTimezoneOptions( IContextSource $context ) {
1379                 $opt = [];
1380
1381                 $localTZoffset = $context->getConfig()->get( 'LocalTZoffset' );
1382                 $timeZoneList = self::getTimeZoneList( $context->getLanguage() );
1383
1384                 $timestamp = MWTimestamp::getLocalInstance();
1385                 // Check that the LocalTZoffset is the same as the local time zone offset
1386                 if ( $localTZoffset == $timestamp->format( 'Z' ) / 60 ) {
1387                         $timezoneName = $timestamp->getTimezone()->getName();
1388                         // Localize timezone
1389                         if ( isset( $timeZoneList[$timezoneName] ) ) {
1390                                 $timezoneName = $timeZoneList[$timezoneName]['name'];
1391                         }
1392                         $server_tz_msg = $context->msg(
1393                                 'timezoneuseserverdefault',
1394                                 $timezoneName
1395                         )->text();
1396                 } else {
1397                         $tzstring = sprintf(
1398                                 '%+03d:%02d',
1399                                 floor( $localTZoffset / 60 ),
1400                                 abs( $localTZoffset ) % 60
1401                         );
1402                         $server_tz_msg = $context->msg( 'timezoneuseserverdefault', $tzstring )->text();
1403                 }
1404                 $opt[$server_tz_msg] = "System|$localTZoffset";
1405                 $opt[$context->msg( 'timezoneuseoffset' )->text()] = 'other';
1406                 $opt[$context->msg( 'guesstimezone' )->text()] = 'guess';
1407
1408                 foreach ( $timeZoneList as $timeZoneInfo ) {
1409                         $region = $timeZoneInfo['region'];
1410                         if ( !isset( $opt[$region] ) ) {
1411                                 $opt[$region] = [];
1412                         }
1413                         $opt[$region][$timeZoneInfo['name']] = $timeZoneInfo['timecorrection'];
1414                 }
1415                 return $opt;
1416         }
1417
1418         /**
1419          * @param string $value
1420          * @param array $alldata
1421          * @return int
1422          */
1423         static function filterIntval( $value, $alldata ) {
1424                 return intval( $value );
1425         }
1426
1427         /**
1428          * @param string $tz
1429          * @param array $alldata
1430          * @return string
1431          */
1432         static function filterTimezoneInput( $tz, $alldata ) {
1433                 $data = explode( '|', $tz, 3 );
1434                 switch ( $data[0] ) {
1435                         case 'ZoneInfo':
1436                                 $valid = false;
1437
1438                                 if ( count( $data ) === 3 ) {
1439                                         // Make sure this timezone exists
1440                                         try {
1441                                                 new DateTimeZone( $data[2] );
1442                                                 // If the constructor didn't throw, we know it's valid
1443                                                 $valid = true;
1444                                         } catch ( Exception $e ) {
1445                                                 // Not a valid timezone
1446                                         }
1447                                 }
1448
1449                                 if ( !$valid ) {
1450                                         // If the supplied timezone doesn't exist, fall back to the encoded offset
1451                                         return 'Offset|' . intval( $tz[1] );
1452                                 }
1453                                 return $tz;
1454                         case 'System':
1455                                 return $tz;
1456                         default:
1457                                 $data = explode( ':', $tz, 2 );
1458                                 if ( count( $data ) == 2 ) {
1459                                         $data[0] = intval( $data[0] );
1460                                         $data[1] = intval( $data[1] );
1461                                         $minDiff = abs( $data[0] ) * 60 + $data[1];
1462                                         if ( $data[0] < 0 ) {
1463                                                 $minDiff = - $minDiff;
1464                                         }
1465                                 } else {
1466                                         $minDiff = intval( $data[0] ) * 60;
1467                                 }
1468
1469                                 # Max is +14:00 and min is -12:00, see:
1470                                 # https://en.wikipedia.org/wiki/Timezone
1471                                 $minDiff = min( $minDiff, 840 );  # 14:00
1472                                 $minDiff = max( $minDiff, -720 ); # -12:00
1473                                 return 'Offset|' . $minDiff;
1474                 }
1475         }
1476
1477         /**
1478          * Handle the form submission if everything validated properly
1479          *
1480          * @param array $formData
1481          * @param PreferencesForm $form
1482          * @return bool|Status|string
1483          */
1484         static function tryFormSubmit( $formData, $form ) {
1485                 $user = $form->getModifiedUser();
1486                 $hiddenPrefs = $form->getConfig()->get( 'HiddenPrefs' );
1487                 $result = true;
1488
1489                 if ( !$user->isAllowedAny( 'editmyprivateinfo', 'editmyoptions' ) ) {
1490                         return Status::newFatal( 'mypreferencesprotected' );
1491                 }
1492
1493                 // Filter input
1494                 foreach ( array_keys( $formData ) as $name ) {
1495                         if ( isset( self::$saveFilters[$name] ) ) {
1496                                 $formData[$name] =
1497                                         call_user_func( self::$saveFilters[$name], $formData[$name], $formData );
1498                         }
1499                 }
1500
1501                 // Fortunately, the realname field is MUCH simpler
1502                 // (not really "private", but still shouldn't be edited without permission)
1503
1504                 if ( !in_array( 'realname', $hiddenPrefs )
1505                         && $user->isAllowed( 'editmyprivateinfo' )
1506                         && array_key_exists( 'realname', $formData )
1507                 ) {
1508                         $realName = $formData['realname'];
1509                         $user->setRealName( $realName );
1510                 }
1511
1512                 if ( $user->isAllowed( 'editmyoptions' ) ) {
1513                         $oldUserOptions = $user->getOptions();
1514
1515                         foreach ( self::$saveBlacklist as $b ) {
1516                                 unset( $formData[$b] );
1517                         }
1518
1519                         # If users have saved a value for a preference which has subsequently been disabled
1520                         # via $wgHiddenPrefs, we don't want to destroy that setting in case the preference
1521                         # is subsequently re-enabled
1522                         foreach ( $hiddenPrefs as $pref ) {
1523                                 # If the user has not set a non-default value here, the default will be returned
1524                                 # and subsequently discarded
1525                                 $formData[$pref] = $user->getOption( $pref, null, true );
1526                         }
1527
1528                         // Keep old preferences from interfering due to back-compat code, etc.
1529                         $user->resetOptions( 'unused', $form->getContext() );
1530
1531                         foreach ( $formData as $key => $value ) {
1532                                 $user->setOption( $key, $value );
1533                         }
1534
1535                         Hooks::run(
1536                                 'PreferencesFormPreSave',
1537                                 [ $formData, $form, $user, &$result, $oldUserOptions ]
1538                         );
1539                 }
1540
1541                 MediaWiki\Auth\AuthManager::callLegacyAuthPlugin( 'updateExternalDB', [ $user ] );
1542                 $user->saveSettings();
1543
1544                 return $result;
1545         }
1546
1547         /**
1548          * @param array $formData
1549          * @param PreferencesForm $form
1550          * @return Status
1551          */
1552         public static function tryUISubmit( $formData, $form ) {
1553                 $res = self::tryFormSubmit( $formData, $form );
1554
1555                 if ( $res ) {
1556                         $urlOptions = [];
1557
1558                         if ( $res === 'eauth' ) {
1559                                 $urlOptions['eauth'] = 1;
1560                         }
1561
1562                         $urlOptions += $form->getExtraSuccessRedirectParameters();
1563
1564                         $url = $form->getTitle()->getFullURL( $urlOptions );
1565
1566                         $context = $form->getContext();
1567                         // Set session data for the success message
1568                         $context->getRequest()->getSession()->set( 'specialPreferencesSaveSuccess', 1 );
1569
1570                         $context->getOutput()->redirect( $url );
1571                 }
1572
1573                 return Status::newGood();
1574         }
1575
1576         /**
1577          * Get a list of all time zones
1578          * @param Language $language Language used for the localized names
1579          * @return array A list of all time zones. The system name of the time zone is used as key and
1580          *  the value is an array which contains localized name, the timecorrection value used for
1581          *  preferences and the region
1582          * @since 1.26
1583          */
1584         public static function getTimeZoneList( Language $language ) {
1585                 $identifiers = DateTimeZone::listIdentifiers();
1586                 if ( $identifiers === false ) {
1587                         return [];
1588                 }
1589                 sort( $identifiers );
1590
1591                 $tzRegions = [
1592                         'Africa' => wfMessage( 'timezoneregion-africa' )->inLanguage( $language )->text(),
1593                         'America' => wfMessage( 'timezoneregion-america' )->inLanguage( $language )->text(),
1594                         'Antarctica' => wfMessage( 'timezoneregion-antarctica' )->inLanguage( $language )->text(),
1595                         'Arctic' => wfMessage( 'timezoneregion-arctic' )->inLanguage( $language )->text(),
1596                         'Asia' => wfMessage( 'timezoneregion-asia' )->inLanguage( $language )->text(),
1597                         'Atlantic' => wfMessage( 'timezoneregion-atlantic' )->inLanguage( $language )->text(),
1598                         'Australia' => wfMessage( 'timezoneregion-australia' )->inLanguage( $language )->text(),
1599                         'Europe' => wfMessage( 'timezoneregion-europe' )->inLanguage( $language )->text(),
1600                         'Indian' => wfMessage( 'timezoneregion-indian' )->inLanguage( $language )->text(),
1601                         'Pacific' => wfMessage( 'timezoneregion-pacific' )->inLanguage( $language )->text(),
1602                 ];
1603                 asort( $tzRegions );
1604
1605                 $timeZoneList = [];
1606
1607                 $now = new DateTime();
1608
1609                 foreach ( $identifiers as $identifier ) {
1610                         $parts = explode( '/', $identifier, 2 );
1611
1612                         // DateTimeZone::listIdentifiers() returns a number of
1613                         // backwards-compatibility entries. This filters them out of the
1614                         // list presented to the user.
1615                         if ( count( $parts ) !== 2 || !array_key_exists( $parts[0], $tzRegions ) ) {
1616                                 continue;
1617                         }
1618
1619                         // Localize region
1620                         $parts[0] = $tzRegions[$parts[0]];
1621
1622                         $dateTimeZone = new DateTimeZone( $identifier );
1623                         $minDiff = floor( $dateTimeZone->getOffset( $now ) / 60 );
1624
1625                         $display = str_replace( '_', ' ', $parts[0] . '/' . $parts[1] );
1626                         $value = "ZoneInfo|$minDiff|$identifier";
1627
1628                         $timeZoneList[$identifier] = [
1629                                 'name' => $display,
1630                                 'timecorrection' => $value,
1631                                 'region' => $parts[0],
1632                         ];
1633                 }
1634
1635                 return $timeZoneList;
1636         }
1637 }
1638
1639 /** Some tweaks to allow js prefs to work */
1640 class PreferencesForm extends HTMLForm {
1641         // Override default value from HTMLForm
1642         protected $mSubSectionBeforeFields = false;
1643
1644         private $modifiedUser;
1645
1646         /**
1647          * @param User $user
1648          */
1649         public function setModifiedUser( $user ) {
1650                 $this->modifiedUser = $user;
1651         }
1652
1653         /**
1654          * @return User
1655          */
1656         public function getModifiedUser() {
1657                 if ( $this->modifiedUser === null ) {
1658                         return $this->getUser();
1659                 } else {
1660                         return $this->modifiedUser;
1661                 }
1662         }
1663
1664         /**
1665          * Get extra parameters for the query string when redirecting after
1666          * successful save.
1667          *
1668          * @return array
1669          */
1670         public function getExtraSuccessRedirectParameters() {
1671                 return [];
1672         }
1673
1674         /**
1675          * @param string $html
1676          * @return string
1677          */
1678         function wrapForm( $html ) {
1679                 $html = Xml::tags( 'div', [ 'id' => 'preferences' ], $html );
1680
1681                 return parent::wrapForm( $html );
1682         }
1683
1684         /**
1685          * @return string
1686          */
1687         function getButtons() {
1688                 $attrs = [ 'id' => 'mw-prefs-restoreprefs' ];
1689
1690                 if ( !$this->getModifiedUser()->isAllowedAny( 'editmyprivateinfo', 'editmyoptions' ) ) {
1691                         return '';
1692                 }
1693
1694                 $html = parent::getButtons();
1695
1696                 if ( $this->getModifiedUser()->isAllowed( 'editmyoptions' ) ) {
1697                         $t = $this->getTitle()->getSubpage( 'reset' );
1698
1699                         $linkRenderer = MediaWikiServices::getInstance()->getLinkRenderer();
1700                         $html .= "\n" . $linkRenderer->makeLink( $t, $this->msg( 'restoreprefs' )->text(),
1701                                 Html::buttonAttributes( $attrs, [ 'mw-ui-quiet' ] ) );
1702
1703                         $html = Xml::tags( 'div', [ 'class' => 'mw-prefs-buttons' ], $html );
1704                 }
1705
1706                 return $html;
1707         }
1708
1709         /**
1710          * Separate multi-option preferences into multiple preferences, since we
1711          * have to store them separately
1712          * @param array $data
1713          * @return array
1714          */
1715         function filterDataForSubmit( $data ) {
1716                 foreach ( $this->mFlatFields as $fieldname => $field ) {
1717                         if ( $field instanceof HTMLNestedFilterable ) {
1718                                 $info = $field->mParams;
1719                                 $prefix = isset( $info['prefix'] ) ? $info['prefix'] : $fieldname;
1720                                 foreach ( $field->filterDataForSubmit( $data[$fieldname] ) as $key => $value ) {
1721                                         $data["$prefix$key"] = $value;
1722                                 }
1723                                 unset( $data[$fieldname] );
1724                         }
1725                 }
1726
1727                 return $data;
1728         }
1729
1730         /**
1731          * Get the whole body of the form.
1732          * @return string
1733          */
1734         function getBody() {
1735                 return $this->displaySection( $this->mFieldTree, '', 'mw-prefsection-' );
1736         }
1737
1738         /**
1739          * Get the "<legend>" for a given section key. Normally this is the
1740          * prefs-$key message but we'll allow extensions to override it.
1741          * @param string $key
1742          * @return string
1743          */
1744         function getLegend( $key ) {
1745                 $legend = parent::getLegend( $key );
1746                 Hooks::run( 'PreferencesGetLegend', [ $this, $key, &$legend ] );
1747                 return $legend;
1748         }
1749
1750         /**
1751          * Get the keys of each top level preference section.
1752          * @return array of section keys
1753          */
1754         function getPreferenceSections() {
1755                 return array_keys( array_filter( $this->mFieldTree, 'is_array' ) );
1756         }
1757 }