3 * This program is free software; you can redistribute it and/or modify
4 * it under the terms of the GNU General Public License as published by
5 * the Free Software Foundation; either version 2 of the License, or
6 * (at your option) any later version.
8 * This program is distributed in the hope that it will be useful,
9 * but WITHOUT ANY WARRANTY; without even the implied warranty of
10 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11 * GNU General Public License for more details.
13 * You should have received a copy of the GNU General Public License along
14 * with this program; if not, write to the Free Software Foundation, Inc.,
15 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
16 * http://www.gnu.org/copyleft/gpl.html
21 namespace MediaWiki\Preferences
;
34 use LanguageConverter
;
35 use MediaWiki\Auth\AuthManager
;
36 use MediaWiki\Auth\PasswordAuthenticationRequest
;
37 use MediaWiki\Linker\LinkRenderer
;
38 use MediaWiki\MediaWikiServices
;
46 use PreferencesFormLegacy
;
47 use Psr\Log\LoggerAwareTrait
;
48 use Psr\Log\NullLogger
;
53 use UnexpectedValueException
;
55 use UserGroupMembership
;
59 * This is the default implementation of PreferencesFactory.
61 class DefaultPreferencesFactory
implements PreferencesFactory
{
67 /** @var Language The wiki's content language. */
70 /** @var AuthManager */
71 protected $authManager;
73 /** @var LinkRenderer */
74 protected $linkRenderer;
77 * @param Config $config
78 * @param Language $contLang
79 * @param AuthManager $authManager
80 * @param LinkRenderer $linkRenderer
82 public function __construct(
85 AuthManager
$authManager,
86 LinkRenderer
$linkRenderer
88 $this->config
= $config;
89 $this->contLang
= $contLang;
90 $this->authManager
= $authManager;
91 $this->linkRenderer
= $linkRenderer;
92 $this->logger
= new NullLogger();
98 public function getSaveBlacklist() {
106 * @throws MWException
108 * @param IContextSource $context
111 public function getFormDescriptor( User
$user, IContextSource
$context ) {
114 OutputPage
::setupOOUI(
115 strtolower( $context->getSkin()->getSkinName() ),
116 $context->getLanguage()->getDir()
119 $canIPUseHTTPS = wfCanIPUseHTTPS( $context->getRequest()->getIP() );
120 $this->profilePreferences( $user, $context, $preferences, $canIPUseHTTPS );
121 $this->skinPreferences( $user, $context, $preferences );
122 $this->datetimePreferences( $user, $context, $preferences );
123 $this->filesPreferences( $context, $preferences );
124 $this->renderingPreferences( $context, $preferences );
125 $this->editingPreferences( $user, $context, $preferences );
126 $this->rcPreferences( $user, $context, $preferences );
127 $this->watchlistPreferences( $user, $context, $preferences );
128 $this->searchPreferences( $preferences );
130 Hooks
::run( 'GetPreferences', [ $user, &$preferences ] );
132 $this->loadPreferenceValues( $user, $context, $preferences );
133 $this->logger
->debug( "Created form descriptor for user '{$user->getName()}'" );
138 * Loads existing values for a given array of preferences
139 * @throws MWException
141 * @param IContextSource $context
142 * @param array &$defaultPreferences Array to load values for
145 private function loadPreferenceValues(
146 User
$user, IContextSource
$context, &$defaultPreferences
148 # # Remove preferences that wikis don't want to use
149 foreach ( $this->config
->get( 'HiddenPrefs' ) as $pref ) {
150 if ( isset( $defaultPreferences[$pref] ) ) {
151 unset( $defaultPreferences[$pref] );
155 # # Make sure that form fields have their parent set. See T43337.
156 $dummyForm = new HTMLForm( [], $context );
158 $disable = !$user->isAllowed( 'editmyoptions' );
160 $defaultOptions = User
::getDefaultOptions();
161 $userOptions = $user->getOptions();
162 $this->applyFilters( $userOptions, $defaultPreferences, 'filterForForm' );
163 # # Prod in defaults from the user
164 foreach ( $defaultPreferences as $name => &$info ) {
165 $prefFromUser = $this->getOptionFromUser( $name, $info, $userOptions );
166 if ( $disable && !in_array( $name, $this->getSaveBlacklist() ) ) {
167 $info['disabled'] = 'disabled';
169 $field = HTMLForm
::loadInputFromParameters( $name, $info, $dummyForm ); // For validation
170 $globalDefault = $defaultOptions[$name] ??
null;
172 // If it validates, set it as the default
173 if ( isset( $info['default'] ) ) {
174 // Already set, no problem
176 } elseif ( !is_null( $prefFromUser ) && // Make sure we're not just pulling nothing
177 $field->validate( $prefFromUser, $user->getOptions() ) === true ) {
178 $info['default'] = $prefFromUser;
179 } elseif ( $field->validate( $globalDefault, $user->getOptions() ) === true ) {
180 $info['default'] = $globalDefault;
182 throw new MWException( "Global default '$globalDefault' is invalid for field $name" );
186 return $defaultPreferences;
190 * Pull option from a user account. Handles stuff like array-type preferences.
192 * @param string $name
194 * @param array $userOptions
195 * @return array|string
197 protected function getOptionFromUser( $name, $info, array $userOptions ) {
198 $val = $userOptions[$name] ??
null;
200 // Handling for multiselect preferences
201 if ( ( isset( $info['type'] ) && $info['type'] == 'multiselect' ) ||
202 ( isset( $info['class'] ) && $info['class'] == \HTMLMultiSelectField
::class ) ) {
203 $options = HTMLFormField
::flattenOptions( $info['options'] );
204 $prefix = $info['prefix'] ??
$name;
207 foreach ( $options as $value ) {
208 if ( $userOptions["$prefix$value"] ??
false ) {
214 // Handling for checkmatrix preferences
215 if ( ( isset( $info['type'] ) && $info['type'] == 'checkmatrix' ) ||
216 ( isset( $info['class'] ) && $info['class'] == \HTMLCheckMatrix
::class ) ) {
217 $columns = HTMLFormField
::flattenOptions( $info['columns'] );
218 $rows = HTMLFormField
::flattenOptions( $info['rows'] );
219 $prefix = $info['prefix'] ??
$name;
222 foreach ( $columns as $column ) {
223 foreach ( $rows as $row ) {
224 if ( $userOptions["$prefix$column-$row"] ??
false ) {
225 $val[] = "$column-$row";
235 * @todo Inject user Language instead of using context.
237 * @param IContextSource $context
238 * @param array &$defaultPreferences
239 * @param bool $canIPUseHTTPS Whether the user's IP is likely to be able to access the wiki
243 protected function profilePreferences(
244 User
$user, IContextSource
$context, &$defaultPreferences, $canIPUseHTTPS
246 // retrieving user name for GENDER and misc.
247 $userName = $user->getName();
249 # # User info #####################################
251 $defaultPreferences['username'] = [
253 'label-message' => [ 'username', $userName ],
254 'default' => $userName,
255 'section' => 'personal/info',
258 $lang = $context->getLanguage();
260 # Get groups to which the user belongs
261 $userEffectiveGroups = $user->getEffectiveGroups();
262 $userGroupMemberships = $user->getGroupMemberships();
263 $userGroups = $userMembers = $userTempGroups = $userTempMembers = [];
264 foreach ( $userEffectiveGroups as $ueg ) {
266 // Skip the default * group, seems useless here
270 if ( isset( $userGroupMemberships[$ueg] ) ) {
271 $groupStringOrObject = $userGroupMemberships[$ueg];
273 $groupStringOrObject = $ueg;
276 $userG = UserGroupMembership
::getLink( $groupStringOrObject, $context, 'html' );
277 $userM = UserGroupMembership
::getLink( $groupStringOrObject, $context, 'html',
280 // Store expiring groups separately, so we can place them before non-expiring
281 // groups in the list. This is to avoid the ambiguity of something like
282 // "administrator, bureaucrat (until X date)" -- users might wonder whether the
283 // expiry date applies to both groups, or just the last one
284 if ( $groupStringOrObject instanceof UserGroupMembership
&&
285 $groupStringOrObject->getExpiry()
287 $userTempGroups[] = $userG;
288 $userTempMembers[] = $userM;
290 $userGroups[] = $userG;
291 $userMembers[] = $userM;
295 sort( $userMembers );
296 sort( $userTempGroups );
297 sort( $userTempMembers );
298 $userGroups = array_merge( $userTempGroups, $userGroups );
299 $userMembers = array_merge( $userTempMembers, $userMembers );
301 $defaultPreferences['usergroups'] = [
303 'label' => $context->msg( 'prefs-memberingroups' )->numParams(
304 count( $userGroups ) )->params( $userName )->parse(),
305 'default' => $context->msg( 'prefs-memberingroups-type' )
306 ->rawParams( $lang->commaList( $userGroups ), $lang->commaList( $userMembers ) )
309 'section' => 'personal/info',
312 $contribTitle = SpecialPage
::getTitleFor( "Contributions", $userName );
313 $formattedEditCount = $lang->formatNum( $user->getEditCount() );
314 $editCount = $this->linkRenderer
->makeLink( $contribTitle, $formattedEditCount );
316 $defaultPreferences['editcount'] = [
319 'label-message' => 'prefs-edits',
320 'default' => $editCount,
321 'section' => 'personal/info',
324 if ( $user->getRegistration() ) {
325 $displayUser = $context->getUser();
326 $userRegistration = $user->getRegistration();
327 $defaultPreferences['registrationdate'] = [
329 'label-message' => 'prefs-registration',
330 'default' => $context->msg(
331 'prefs-registration-date-time',
332 $lang->userTimeAndDate( $userRegistration, $displayUser ),
333 $lang->userDate( $userRegistration, $displayUser ),
334 $lang->userTime( $userRegistration, $displayUser )
336 'section' => 'personal/info',
340 $canViewPrivateInfo = $user->isAllowed( 'viewmyprivateinfo' );
341 $canEditPrivateInfo = $user->isAllowed( 'editmyprivateinfo' );
343 // Actually changeable stuff
344 $defaultPreferences['realname'] = [
345 // (not really "private", but still shouldn't be edited without permission)
346 'type' => $canEditPrivateInfo && $this->authManager
->allowsPropertyChange( 'realname' )
348 'default' => $user->getRealName(),
349 'section' => 'personal/info',
350 'label-message' => 'yourrealname',
351 'help-message' => 'prefs-help-realname',
354 if ( $canEditPrivateInfo && $this->authManager
->allowsAuthenticationDataChange(
355 new PasswordAuthenticationRequest(), false )->isGood()
357 $defaultPreferences['password'] = [
360 'default' => (string)new \OOUI\
ButtonWidget( [
361 'href' => SpecialPage
::getTitleFor( 'ChangePassword' )->getLinkURL( [
362 'returnto' => SpecialPage
::getTitleFor( 'Preferences' )->getPrefixedText()
364 'label' => $context->msg( 'prefs-resetpass' )->text(),
366 'label-message' => 'yourpassword',
367 'section' => 'personal/info',
370 // Only show prefershttps if secure login is turned on
371 if ( $this->config
->get( 'SecureLogin' ) && $canIPUseHTTPS ) {
372 $defaultPreferences['prefershttps'] = [
374 'label-message' => 'tog-prefershttps',
375 'help-message' => 'prefs-help-prefershttps',
376 'section' => 'personal/info'
381 $languages = Language
::fetchLanguageNames( null, 'mwfile' );
382 $languageCode = $this->config
->get( 'LanguageCode' );
383 if ( !array_key_exists( $languageCode, $languages ) ) {
384 $languages[$languageCode] = $languageCode;
385 // Sort the array again
390 foreach ( $languages as $code => $name ) {
391 $display = LanguageCode
::bcp47( $code ) . ' - ' . $name;
392 $options[$display] = $code;
394 $defaultPreferences['language'] = [
396 'section' => 'personal/i18n',
397 'options' => $options,
398 'label-message' => 'yourlanguage',
401 $defaultPreferences['gender'] = [
403 'section' => 'personal/i18n',
405 $context->msg( 'parentheses' )
406 ->params( $context->msg( 'gender-unknown' )->plain() )
407 ->escaped() => 'unknown',
408 $context->msg( 'gender-female' )->escaped() => 'female',
409 $context->msg( 'gender-male' )->escaped() => 'male',
411 'label-message' => 'yourgender',
412 'help-message' => 'prefs-help-gender',
415 // see if there are multiple language variants to choose from
416 if ( !$this->config
->get( 'DisableLangConversion' ) ) {
417 foreach ( LanguageConverter
::$languagesWithVariants as $langCode ) {
418 if ( $langCode == $this->contLang
->getCode() ) {
419 if ( !$this->contLang
->hasVariants() ) {
423 $variants = $this->contLang
->getVariants();
425 foreach ( $variants as $v ) {
426 $v = str_replace( '_', '-', strtolower( $v ) );
427 $variantArray[$v] = $lang->getVariantname( $v, false );
431 foreach ( $variantArray as $code => $name ) {
432 $display = LanguageCode
::bcp47( $code ) . ' - ' . $name;
433 $options[$display] = $code;
436 $defaultPreferences['variant'] = [
437 'label-message' => 'yourvariant',
439 'options' => $options,
440 'section' => 'personal/i18n',
441 'help-message' => 'prefs-help-variant',
444 $defaultPreferences["variant-$langCode"] = [
451 // Stuff from Language::getExtraUserToggles()
452 // FIXME is this dead code? $extraUserToggles doesn't seem to be defined for any language
453 $toggles = $this->contLang
->getExtraUserToggles();
455 foreach ( $toggles as $toggle ) {
456 $defaultPreferences[$toggle] = [
458 'section' => 'personal/i18n',
459 'label-message' => "tog-$toggle",
463 // show a preview of the old signature first
464 $oldsigWikiText = MediaWikiServices
::getInstance()->getParser()->preSaveTransform(
466 $context->getTitle(),
468 ParserOptions
::newFromContext( $context )
470 $oldsigHTML = $context->getOutput()->parseInline( $oldsigWikiText, true, true );
471 $defaultPreferences['oldsig'] = [
474 'label-message' => 'tog-oldsig',
475 'default' => $oldsigHTML,
476 'section' => 'personal/signature',
478 $defaultPreferences['nickname'] = [
479 'type' => $this->authManager
->allowsPropertyChange( 'nickname' ) ?
'text' : 'info',
480 'maxlength' => $this->config
->get( 'MaxSigChars' ),
481 'label-message' => 'yournick',
482 'validation-callback' => function ( $signature, $alldata, HTMLForm
$form ) {
483 return $this->validateSignature( $signature, $alldata, $form );
485 'section' => 'personal/signature',
486 'filter-callback' => function ( $signature, array $alldata, HTMLForm
$form ) {
487 return $this->cleanSignature( $signature, $alldata, $form );
490 $defaultPreferences['fancysig'] = [
492 'label-message' => 'tog-fancysig',
493 // show general help about signature at the bottom of the section
494 'help-message' => 'prefs-help-signature',
495 'section' => 'personal/signature'
500 if ( $this->config
->get( 'EnableEmail' ) ) {
501 if ( $canViewPrivateInfo ) {
502 $helpMessages[] = $this->config
->get( 'EmailConfirmToEdit' )
503 ?
'prefs-help-email-required'
504 : 'prefs-help-email';
506 if ( $this->config
->get( 'EnableUserEmail' ) ) {
507 // additional messages when users can send email to each other
508 $helpMessages[] = 'prefs-help-email-others';
511 $emailAddress = $user->getEmail() ?
htmlspecialchars( $user->getEmail() ) : '';
512 if ( $canEditPrivateInfo && $this->authManager
->allowsPropertyChange( 'emailaddress' ) ) {
513 $button = new \OOUI\
ButtonWidget( [
514 'href' => SpecialPage
::getTitleFor( 'ChangeEmail' )->getLinkURL( [
515 'returnto' => SpecialPage
::getTitleFor( 'Preferences' )->getPrefixedText()
518 $context->msg( $user->getEmail() ?
'prefs-changeemail' : 'prefs-setemail' )->text(),
521 $emailAddress .= $emailAddress == '' ?
$button : ( '<br />' . $button );
524 $defaultPreferences['emailaddress'] = [
527 'default' => $emailAddress,
528 'label-message' => 'youremail',
529 'section' => 'personal/email',
530 'help-messages' => $helpMessages,
531 # 'cssclass' chosen below
535 $disableEmailPrefs = false;
537 if ( $this->config
->get( 'EmailAuthentication' ) ) {
538 $emailauthenticationclass = 'mw-email-not-authenticated';
539 if ( $user->getEmail() ) {
540 if ( $user->getEmailAuthenticationTimestamp() ) {
541 // date and time are separate parameters to facilitate localisation.
542 // $time is kept for backward compat reasons.
543 // 'emailauthenticated' is also used in SpecialConfirmemail.php
544 $displayUser = $context->getUser();
545 $emailTimestamp = $user->getEmailAuthenticationTimestamp();
546 $time = $lang->userTimeAndDate( $emailTimestamp, $displayUser );
547 $d = $lang->userDate( $emailTimestamp, $displayUser );
548 $t = $lang->userTime( $emailTimestamp, $displayUser );
549 $emailauthenticated = $context->msg( 'emailauthenticated',
550 $time, $d, $t )->parse() . '<br />';
551 $disableEmailPrefs = false;
552 $emailauthenticationclass = 'mw-email-authenticated';
554 $disableEmailPrefs = true;
555 $emailauthenticated = $context->msg( 'emailnotauthenticated' )->parse() . '<br />' .
556 new \OOUI\
ButtonWidget( [
557 'href' => SpecialPage
::getTitleFor( 'Confirmemail' )->getLinkURL(),
558 'label' => $context->msg( 'emailconfirmlink' )->text(),
560 $emailauthenticationclass = "mw-email-not-authenticated";
563 $disableEmailPrefs = true;
564 $emailauthenticated = $context->msg( 'noemailprefs' )->escaped();
565 $emailauthenticationclass = 'mw-email-none';
568 if ( $canViewPrivateInfo ) {
569 $defaultPreferences['emailauthentication'] = [
572 'section' => 'personal/email',
573 'label-message' => 'prefs-emailconfirm-label',
574 'default' => $emailauthenticated,
575 # Apply the same CSS class used on the input to the message:
576 'cssclass' => $emailauthenticationclass,
581 if ( $this->config
->get( 'EnableUserEmail' ) && $user->isAllowed( 'sendemail' ) ) {
582 $defaultPreferences['disablemail'] = [
583 'id' => 'wpAllowEmail',
586 'section' => 'personal/email',
587 'label-message' => 'allowemail',
588 'disabled' => $disableEmailPrefs,
591 $defaultPreferences['email-allow-new-users'] = [
592 'id' => 'wpAllowEmailFromNewUsers',
594 'section' => 'personal/email',
595 'label-message' => 'email-allow-new-users-label',
596 'disabled' => $disableEmailPrefs,
599 $defaultPreferences['ccmeonemails'] = [
601 'section' => 'personal/email',
602 'label-message' => 'tog-ccmeonemails',
603 'disabled' => $disableEmailPrefs,
606 if ( $this->config
->get( 'EnableUserEmailBlacklist' ) ) {
607 $defaultPreferences['email-blacklist'] = [
608 'type' => 'usersmultiselect',
609 'label-message' => 'email-blacklist-label',
610 'section' => 'personal/email',
611 'disabled' => $disableEmailPrefs,
612 'filter' => MultiUsernameFilter
::class,
617 if ( $this->config
->get( 'EnotifWatchlist' ) ) {
618 $defaultPreferences['enotifwatchlistpages'] = [
620 'section' => 'personal/email',
621 'label-message' => 'tog-enotifwatchlistpages',
622 'disabled' => $disableEmailPrefs,
625 if ( $this->config
->get( 'EnotifUserTalk' ) ) {
626 $defaultPreferences['enotifusertalkpages'] = [
628 'section' => 'personal/email',
629 'label-message' => 'tog-enotifusertalkpages',
630 'disabled' => $disableEmailPrefs,
633 if ( $this->config
->get( 'EnotifUserTalk' ) ||
$this->config
->get( 'EnotifWatchlist' ) ) {
634 if ( $this->config
->get( 'EnotifMinorEdits' ) ) {
635 $defaultPreferences['enotifminoredits'] = [
637 'section' => 'personal/email',
638 'label-message' => 'tog-enotifminoredits',
639 'disabled' => $disableEmailPrefs,
643 if ( $this->config
->get( 'EnotifRevealEditorAddress' ) ) {
644 $defaultPreferences['enotifrevealaddr'] = [
646 'section' => 'personal/email',
647 'label-message' => 'tog-enotifrevealaddr',
648 'disabled' => $disableEmailPrefs,
657 * @param IContextSource $context
658 * @param array &$defaultPreferences
661 protected function skinPreferences( User
$user, IContextSource
$context, &$defaultPreferences ) {
662 # # Skin #####################################
664 // Skin selector, if there is at least one valid skin
665 $skinOptions = $this->generateSkinOptions( $user, $context );
666 if ( $skinOptions ) {
667 $defaultPreferences['skin'] = [
669 'options' => $skinOptions,
670 'section' => 'rendering/skin',
674 $allowUserCss = $this->config
->get( 'AllowUserCss' );
675 $allowUserJs = $this->config
->get( 'AllowUserJs' );
676 # Create links to user CSS/JS pages for all skins
677 # This code is basically copied from generateSkinOptions(). It'd
678 # be nice to somehow merge this back in there to avoid redundancy.
679 if ( $allowUserCss ||
$allowUserJs ) {
681 $userName = $user->getName();
683 if ( $allowUserCss ) {
684 $cssPage = Title
::makeTitleSafe( NS_USER
, $userName . '/common.css' );
685 $cssLinkText = $context->msg( 'prefs-custom-css' )->text();
686 $linkTools[] = $this->linkRenderer
->makeLink( $cssPage, $cssLinkText );
689 if ( $allowUserJs ) {
690 $jsPage = Title
::makeTitleSafe( NS_USER
, $userName . '/common.js' );
691 $jsLinkText = $context->msg( 'prefs-custom-js' )->text();
692 $linkTools[] = $this->linkRenderer
->makeLink( $jsPage, $jsLinkText );
695 $defaultPreferences['commoncssjs'] = [
698 'default' => $context->getLanguage()->pipeList( $linkTools ),
699 'label-message' => 'prefs-common-config',
700 'section' => 'rendering/skin',
706 * @param IContextSource $context
707 * @param array &$defaultPreferences
709 protected function filesPreferences( IContextSource
$context, &$defaultPreferences ) {
710 # # Files #####################################
711 $defaultPreferences['imagesize'] = [
713 'options' => $this->getImageSizes( $context ),
714 'label-message' => 'imagemaxsize',
715 'section' => 'rendering/files',
717 $defaultPreferences['thumbsize'] = [
719 'options' => $this->getThumbSizes( $context ),
720 'label-message' => 'thumbsize',
721 'section' => 'rendering/files',
727 * @param IContextSource $context
728 * @param array &$defaultPreferences
731 protected function datetimePreferences( $user, IContextSource
$context, &$defaultPreferences ) {
732 # # Date and time #####################################
733 $dateOptions = $this->getDateOptions( $context );
734 if ( $dateOptions ) {
735 $defaultPreferences['date'] = [
737 'options' => $dateOptions,
738 'section' => 'rendering/dateformat',
743 $now = wfTimestampNow();
744 $lang = $context->getLanguage();
745 $nowlocal = Xml
::element( 'span', [ 'id' => 'wpLocalTime' ],
746 $lang->userTime( $now, $user ) );
747 $nowserver = $lang->userTime( $now, $user,
748 [ 'format' => false, 'timecorrection' => false ] ) .
749 Html
::hidden( 'wpServerTime', (int)substr( $now, 8, 2 ) * 60 +
(int)substr( $now, 10, 2 ) );
751 $defaultPreferences['nowserver'] = [
754 'label-message' => 'servertime',
755 'default' => $nowserver,
756 'section' => 'rendering/timeoffset',
759 $defaultPreferences['nowlocal'] = [
762 'label-message' => 'localtime',
763 'default' => $nowlocal,
764 'section' => 'rendering/timeoffset',
767 // Grab existing pref.
768 $tzOffset = $user->getOption( 'timecorrection' );
769 $tz = explode( '|', $tzOffset, 3 );
771 $tzOptions = $this->getTimezoneOptions( $context );
773 $tzSetting = $tzOffset;
774 if ( count( $tz ) > 1 && $tz[0] == 'ZoneInfo' &&
775 !in_array( $tzOffset, HTMLFormField
::flattenOptions( $tzOptions ) )
777 // Timezone offset can vary with DST
779 $userTZ = new DateTimeZone( $tz[2] );
780 $minDiff = floor( $userTZ->getOffset( new DateTime( 'now' ) ) / 60 );
781 $tzSetting = "ZoneInfo|$minDiff|{$tz[2]}";
782 } catch ( Exception
$e ) {
783 // User has an invalid time zone set. Fall back to just using the offset
787 if ( count( $tz ) > 1 && $tz[0] == 'Offset' ) {
789 $tzSetting = sprintf( '%+03d:%02d', floor( $minDiff / 60 ), abs( $minDiff ) %
60 );
792 $defaultPreferences['timecorrection'] = [
793 'class' => \HTMLSelectOrOtherField
::class,
794 'label-message' => 'timezonelegend',
795 'options' => $tzOptions,
796 'default' => $tzSetting,
798 'section' => 'rendering/timeoffset',
799 'id' => 'wpTimeCorrection',
800 'filter' => TimezoneFilter
::class,
805 * @param MessageLocalizer $l10n
806 * @param array &$defaultPreferences
808 protected function renderingPreferences( MessageLocalizer
$l10n, &$defaultPreferences ) {
809 # # Diffs ####################################
810 $defaultPreferences['diffonly'] = [
812 'section' => 'rendering/diffs',
813 'label-message' => 'tog-diffonly',
815 $defaultPreferences['norollbackdiff'] = [
817 'section' => 'rendering/diffs',
818 'label-message' => 'tog-norollbackdiff',
821 # # Page Rendering ##############################
822 if ( $this->config
->get( 'AllowUserCssPrefs' ) ) {
823 $defaultPreferences['underline'] = [
826 $l10n->msg( 'underline-never' )->text() => 0,
827 $l10n->msg( 'underline-always' )->text() => 1,
828 $l10n->msg( 'underline-default' )->text() => 2,
830 'label-message' => 'tog-underline',
831 'section' => 'rendering/advancedrendering',
835 $stubThresholdValues = [ 50, 100, 500, 1000, 2000, 5000, 10000 ];
836 $stubThresholdOptions = [ $l10n->msg( 'stub-threshold-disabled' )->text() => 0 ];
837 foreach ( $stubThresholdValues as $value ) {
838 $stubThresholdOptions[$l10n->msg( 'size-bytes', $value )->text()] = $value;
841 $defaultPreferences['stubthreshold'] = [
843 'section' => 'rendering/advancedrendering',
844 'options' => $stubThresholdOptions,
845 // This is not a raw HTML message; label-raw is needed for the manual <a></a>
846 'label-raw' => $l10n->msg( 'stub-threshold' )->rawParams(
847 '<a href="#" class="stub">' .
848 $l10n->msg( 'stub-threshold-sample-link' )->parse() .
852 $defaultPreferences['showhiddencats'] = [
854 'section' => 'rendering/advancedrendering',
855 'label-message' => 'tog-showhiddencats'
858 $defaultPreferences['numberheadings'] = [
860 'section' => 'rendering/advancedrendering',
861 'label-message' => 'tog-numberheadings',
867 * @param MessageLocalizer $l10n
868 * @param array &$defaultPreferences
870 protected function editingPreferences( User
$user, MessageLocalizer
$l10n, &$defaultPreferences ) {
871 # # Editing #####################################
872 $defaultPreferences['editsectiononrightclick'] = [
874 'section' => 'editing/advancedediting',
875 'label-message' => 'tog-editsectiononrightclick',
877 $defaultPreferences['editondblclick'] = [
879 'section' => 'editing/advancedediting',
880 'label-message' => 'tog-editondblclick',
883 if ( $this->config
->get( 'AllowUserCssPrefs' ) ) {
884 $defaultPreferences['editfont'] = [
886 'section' => 'editing/editor',
887 'label-message' => 'editfont-style',
889 $l10n->msg( 'editfont-monospace' )->text() => 'monospace',
890 $l10n->msg( 'editfont-sansserif' )->text() => 'sans-serif',
891 $l10n->msg( 'editfont-serif' )->text() => 'serif',
896 if ( $user->isAllowed( 'minoredit' ) ) {
897 $defaultPreferences['minordefault'] = [
899 'section' => 'editing/editor',
900 'label-message' => 'tog-minordefault',
904 $defaultPreferences['forceeditsummary'] = [
906 'section' => 'editing/editor',
907 'label-message' => 'tog-forceeditsummary',
909 $defaultPreferences['useeditwarning'] = [
911 'section' => 'editing/editor',
912 'label-message' => 'tog-useeditwarning',
914 $defaultPreferences['showtoolbar'] = [
916 'section' => 'editing/editor',
917 'label-message' => 'tog-showtoolbar',
920 $defaultPreferences['previewonfirst'] = [
922 'section' => 'editing/preview',
923 'label-message' => 'tog-previewonfirst',
925 $defaultPreferences['previewontop'] = [
927 'section' => 'editing/preview',
928 'label-message' => 'tog-previewontop',
930 $defaultPreferences['uselivepreview'] = [
932 'section' => 'editing/preview',
933 'label-message' => 'tog-uselivepreview',
939 * @param MessageLocalizer $l10n
940 * @param array &$defaultPreferences
942 protected function rcPreferences( User
$user, MessageLocalizer
$l10n, &$defaultPreferences ) {
943 $rcMaxAge = $this->config
->get( 'RCMaxAge' );
944 # # RecentChanges #####################################
945 $defaultPreferences['rcdays'] = [
947 'label-message' => 'recentchangesdays',
948 'section' => 'rc/displayrc',
950 'max' => ceil( $rcMaxAge / ( 3600 * 24 ) ),
951 'help' => $l10n->msg( 'recentchangesdays-max' )->numParams(
952 ceil( $rcMaxAge / ( 3600 * 24 ) ) )->escaped()
954 $defaultPreferences['rclimit'] = [
958 'label-message' => 'recentchangescount',
959 'help-message' => 'prefs-help-recentchangescount',
960 'section' => 'rc/displayrc',
961 'filter' => IntvalFilter
::class,
963 $defaultPreferences['usenewrc'] = [
965 'label-message' => 'tog-usenewrc',
966 'section' => 'rc/advancedrc',
968 $defaultPreferences['hideminor'] = [
970 'label-message' => 'tog-hideminor',
971 'section' => 'rc/advancedrc',
973 $defaultPreferences['rcfilters-rc-collapsed'] = [
976 $defaultPreferences['rcfilters-wl-collapsed'] = [
979 $defaultPreferences['rcfilters-saved-queries'] = [
982 $defaultPreferences['rcfilters-wl-saved-queries'] = [
985 // Override RCFilters preferences for RecentChanges 'limit'
986 $defaultPreferences['rcfilters-limit'] = [
989 $defaultPreferences['rcfilters-saved-queries-versionbackup'] = [
992 $defaultPreferences['rcfilters-wl-saved-queries-versionbackup'] = [
996 if ( $this->config
->get( 'RCWatchCategoryMembership' ) ) {
997 $defaultPreferences['hidecategorization'] = [
999 'label-message' => 'tog-hidecategorization',
1000 'section' => 'rc/advancedrc',
1004 if ( $user->useRCPatrol() ) {
1005 $defaultPreferences['hidepatrolled'] = [
1007 'section' => 'rc/advancedrc',
1008 'label-message' => 'tog-hidepatrolled',
1012 if ( $user->useNPPatrol() ) {
1013 $defaultPreferences['newpageshidepatrolled'] = [
1015 'section' => 'rc/advancedrc',
1016 'label-message' => 'tog-newpageshidepatrolled',
1020 if ( $this->config
->get( 'RCShowWatchingUsers' ) ) {
1021 $defaultPreferences['shownumberswatching'] = [
1023 'section' => 'rc/advancedrc',
1024 'label-message' => 'tog-shownumberswatching',
1028 $defaultPreferences['rcenhancedfilters-disable'] = [
1030 'section' => 'rc/optoutrc',
1031 'label-message' => 'rcfilters-preference-label',
1032 'help-message' => 'rcfilters-preference-help',
1038 * @param IContextSource $context
1039 * @param array &$defaultPreferences
1041 protected function watchlistPreferences(
1042 User
$user, IContextSource
$context, &$defaultPreferences
1044 $watchlistdaysMax = ceil( $this->config
->get( 'RCMaxAge' ) / ( 3600 * 24 ) );
1046 # # Watchlist #####################################
1047 if ( $user->isAllowed( 'editmywatchlist' ) ) {
1048 $editWatchlistLinks = '';
1049 $editWatchlistLinksOld = [];
1050 $editWatchlistModes = [
1051 'edit' => [ 'subpage' => false, 'flags' => [] ],
1052 'raw' => [ 'subpage' => 'raw', 'flags' => [] ],
1053 'clear' => [ 'subpage' => 'clear', 'flags' => [ 'destructive' ] ],
1055 foreach ( $editWatchlistModes as $mode => $options ) {
1056 // Messages: prefs-editwatchlist-edit, prefs-editwatchlist-raw, prefs-editwatchlist-clear
1057 $editWatchlistLinks .=
1058 new \OOUI\
ButtonWidget( [
1059 'href' => SpecialPage
::getTitleFor( 'EditWatchlist', $options['subpage'] )->getLinkURL(),
1060 'flags' => $options[ 'flags' ],
1061 'label' => new \OOUI\
HtmlSnippet(
1062 $context->msg( "prefs-editwatchlist-{$mode}" )->parse()
1067 $defaultPreferences['editwatchlist'] = [
1070 'default' => $editWatchlistLinks,
1071 'label-message' => 'prefs-editwatchlist-label',
1072 'section' => 'watchlist/editwatchlist',
1076 $defaultPreferences['watchlistdays'] = [
1079 'max' => $watchlistdaysMax,
1080 'section' => 'watchlist/displaywatchlist',
1081 'help' => $context->msg( 'prefs-watchlist-days-max' )->numParams(
1082 $watchlistdaysMax )->escaped(),
1083 'label-message' => 'prefs-watchlist-days',
1085 $defaultPreferences['wllimit'] = [
1089 'label-message' => 'prefs-watchlist-edits',
1090 'help' => $context->msg( 'prefs-watchlist-edits-max' )->escaped(),
1091 'section' => 'watchlist/displaywatchlist',
1092 'filter' => IntvalFilter
::class,
1094 $defaultPreferences['extendwatchlist'] = [
1096 'section' => 'watchlist/advancedwatchlist',
1097 'label-message' => 'tog-extendwatchlist',
1099 $defaultPreferences['watchlisthideminor'] = [
1101 'section' => 'watchlist/advancedwatchlist',
1102 'label-message' => 'tog-watchlisthideminor',
1104 $defaultPreferences['watchlisthidebots'] = [
1106 'section' => 'watchlist/advancedwatchlist',
1107 'label-message' => 'tog-watchlisthidebots',
1109 $defaultPreferences['watchlisthideown'] = [
1111 'section' => 'watchlist/advancedwatchlist',
1112 'label-message' => 'tog-watchlisthideown',
1114 $defaultPreferences['watchlisthideanons'] = [
1116 'section' => 'watchlist/advancedwatchlist',
1117 'label-message' => 'tog-watchlisthideanons',
1119 $defaultPreferences['watchlisthideliu'] = [
1121 'section' => 'watchlist/advancedwatchlist',
1122 'label-message' => 'tog-watchlisthideliu',
1125 if ( !\SpecialWatchlist
::checkStructuredFilterUiEnabled(
1129 $defaultPreferences['watchlistreloadautomatically'] = [
1131 'section' => 'watchlist/advancedwatchlist',
1132 'label-message' => 'tog-watchlistreloadautomatically',
1136 $defaultPreferences['watchlistunwatchlinks'] = [
1138 'section' => 'watchlist/advancedwatchlist',
1139 'label-message' => 'tog-watchlistunwatchlinks',
1142 if ( $this->config
->get( 'RCWatchCategoryMembership' ) ) {
1143 $defaultPreferences['watchlisthidecategorization'] = [
1145 'section' => 'watchlist/advancedwatchlist',
1146 'label-message' => 'tog-watchlisthidecategorization',
1150 if ( $user->useRCPatrol() ) {
1151 $defaultPreferences['watchlisthidepatrolled'] = [
1153 'section' => 'watchlist/advancedwatchlist',
1154 'label-message' => 'tog-watchlisthidepatrolled',
1159 'edit' => 'watchdefault',
1160 'move' => 'watchmoves',
1161 'delete' => 'watchdeletion'
1165 if ( $user->isAllowed( 'createpage' ) ||
$user->isAllowed( 'createtalk' ) ) {
1166 $watchTypes['read'] = 'watchcreations';
1169 if ( $user->isAllowed( 'rollback' ) ) {
1170 $watchTypes['rollback'] = 'watchrollback';
1173 if ( $user->isAllowed( 'upload' ) ) {
1174 $watchTypes['upload'] = 'watchuploads';
1177 foreach ( $watchTypes as $action => $pref ) {
1178 if ( $user->isAllowed( $action ) ) {
1180 // tog-watchdefault, tog-watchmoves, tog-watchdeletion, tog-watchcreations, tog-watchuploads
1181 // tog-watchrollback
1182 $defaultPreferences[$pref] = [
1184 'section' => 'watchlist/advancedwatchlist',
1185 'label-message' => "tog-$pref",
1190 $defaultPreferences['watchlisttoken'] = [
1194 $tokenButton = new \OOUI\
ButtonWidget( [
1195 'href' => SpecialPage
::getTitleFor( 'ResetTokens' )->getLinkURL( [
1196 'returnto' => SpecialPage
::getTitleFor( 'Preferences' )->getPrefixedText()
1198 'label' => $context->msg( 'prefs-watchlist-managetokens' )->text(),
1200 $defaultPreferences['watchlisttoken-info'] = [
1202 'section' => 'watchlist/tokenwatchlist',
1203 'label-message' => 'prefs-watchlist-token',
1204 'help-message' => 'prefs-help-tokenmanagement',
1206 'default' => (string)$tokenButton,
1209 $defaultPreferences['wlenhancedfilters-disable'] = [
1211 'section' => 'watchlist/optoutwatchlist',
1212 'label-message' => 'rcfilters-watchlist-preference-label',
1213 'help-message' => 'rcfilters-watchlist-preference-help',
1218 * @param array &$defaultPreferences
1220 protected function searchPreferences( &$defaultPreferences ) {
1221 foreach ( MWNamespace
::getValidNamespaces() as $n ) {
1222 $defaultPreferences['searchNs' . $n] = [
1229 * @param User $user The User object
1230 * @param IContextSource $context
1231 * @return array Text/links to display as key; $skinkey as value
1233 protected function generateSkinOptions( User
$user, IContextSource
$context ) {
1236 $mptitle = Title
::newMainPage();
1237 $previewtext = $context->msg( 'skin-preview' )->escaped();
1239 # Only show skins that aren't disabled in $wgSkipSkins
1240 $validSkinNames = Skin
::getAllowedSkins();
1242 foreach ( $validSkinNames as $skinkey => &$skinname ) {
1243 $msg = $context->msg( "skinname-{$skinkey}" );
1244 if ( $msg->exists() ) {
1245 $skinname = htmlspecialchars( $msg->text() );
1249 $defaultSkin = $this->config
->get( 'DefaultSkin' );
1250 $allowUserCss = $this->config
->get( 'AllowUserCss' );
1251 $allowUserJs = $this->config
->get( 'AllowUserJs' );
1253 # Sort by the internal name, so that the ordering is the same for each display language,
1254 # especially if some skin names are translated to use a different alphabet and some are not.
1255 uksort( $validSkinNames, function ( $a, $b ) use ( $defaultSkin ) {
1256 # Display the default first in the list by comparing it as lesser than any other.
1257 if ( strcasecmp( $a, $defaultSkin ) === 0 ) {
1260 if ( strcasecmp( $b, $defaultSkin ) === 0 ) {
1263 return strcasecmp( $a, $b );
1266 $foundDefault = false;
1267 foreach ( $validSkinNames as $skinkey => $sn ) {
1270 # Mark the default skin
1271 if ( strcasecmp( $skinkey, $defaultSkin ) === 0 ) {
1272 $linkTools[] = $context->msg( 'default' )->escaped();
1273 $foundDefault = true;
1276 # Create preview link
1277 $mplink = htmlspecialchars( $mptitle->getLocalURL( [ 'useskin' => $skinkey ] ) );
1278 $linkTools[] = "<a target='_blank' href=\"$mplink\">$previewtext</a>";
1280 # Create links to user CSS/JS pages
1281 if ( $allowUserCss ) {
1282 $cssPage = Title
::makeTitleSafe( NS_USER
, $user->getName() . '/' . $skinkey . '.css' );
1283 $cssLinkText = $context->msg( 'prefs-custom-css' )->text();
1284 $linkTools[] = $this->linkRenderer
->makeLink( $cssPage, $cssLinkText );
1287 if ( $allowUserJs ) {
1288 $jsPage = Title
::makeTitleSafe( NS_USER
, $user->getName() . '/' . $skinkey . '.js' );
1289 $jsLinkText = $context->msg( 'prefs-custom-js' )->text();
1290 $linkTools[] = $this->linkRenderer
->makeLink( $jsPage, $jsLinkText );
1293 $display = $sn . ' ' . $context->msg( 'parentheses' )
1294 ->rawParams( $context->getLanguage()->pipeList( $linkTools ) )
1296 $ret[$display] = $skinkey;
1299 if ( !$foundDefault ) {
1300 // If the default skin is not available, things are going to break horribly because the
1301 // default value for skin selector will not be a valid value. Let's just not show it then.
1309 * @param IContextSource $context
1312 protected function getDateOptions( IContextSource
$context ) {
1313 $lang = $context->getLanguage();
1314 $dateopts = $lang->getDatePreferences();
1319 if ( !in_array( 'default', $dateopts ) ) {
1320 $dateopts[] = 'default'; // Make sure default is always valid T21237
1323 // FIXME KLUGE: site default might not be valid for user language
1324 global $wgDefaultUserOptions;
1325 if ( !in_array( $wgDefaultUserOptions['date'], $dateopts ) ) {
1326 $wgDefaultUserOptions['date'] = 'default';
1329 $epoch = wfTimestampNow();
1330 foreach ( $dateopts as $key ) {
1331 if ( $key == 'default' ) {
1332 $formatted = $context->msg( 'datedefault' )->escaped();
1334 $formatted = htmlspecialchars( $lang->timeanddate( $epoch, false, $key ) );
1336 $ret[$formatted] = $key;
1343 * @param MessageLocalizer $l10n
1346 protected function getImageSizes( MessageLocalizer
$l10n ) {
1348 $pixels = $l10n->msg( 'unit-pixel' )->text();
1350 foreach ( $this->config
->get( 'ImageLimits' ) as $index => $limits ) {
1351 // Note: A left-to-right marker (U+200E) is inserted, see T144386
1352 $display = "{$limits[0]}\u{200E}×{$limits[1]}$pixels";
1353 $ret[$display] = $index;
1360 * @param MessageLocalizer $l10n
1363 protected function getThumbSizes( MessageLocalizer
$l10n ) {
1365 $pixels = $l10n->msg( 'unit-pixel' )->text();
1367 foreach ( $this->config
->get( 'ThumbLimits' ) as $index => $size ) {
1368 $display = $size . $pixels;
1369 $ret[$display] = $index;
1376 * @param string $signature
1377 * @param array $alldata
1378 * @param HTMLForm $form
1379 * @return bool|string
1381 protected function validateSignature( $signature, $alldata, HTMLForm
$form ) {
1382 $maxSigChars = $this->config
->get( 'MaxSigChars' );
1383 if ( mb_strlen( $signature ) > $maxSigChars ) {
1384 return Xml
::element( 'span', [ 'class' => 'error' ],
1385 $form->msg( 'badsiglength' )->numParams( $maxSigChars )->text() );
1386 } elseif ( isset( $alldata['fancysig'] ) &&
1387 $alldata['fancysig'] &&
1388 MediaWikiServices
::getInstance()->getParser()->validateSig( $signature ) === false
1390 return Xml
::element(
1392 [ 'class' => 'error' ],
1393 $form->msg( 'badsig' )->text()
1401 * @param string $signature
1402 * @param array $alldata
1403 * @param HTMLForm $form
1406 protected function cleanSignature( $signature, $alldata, HTMLForm
$form ) {
1407 $parser = MediaWikiServices
::getInstance()->getParser();
1408 if ( isset( $alldata['fancysig'] ) && $alldata['fancysig'] ) {
1409 $signature = $parser->cleanSig( $signature );
1411 // When no fancy sig used, make sure ~{3,5} get removed.
1412 $signature = Parser
::cleanSigInSig( $signature );
1420 * @param IContextSource $context
1421 * @param string $formClass
1422 * @param array $remove Array of items to remove
1425 public function getForm(
1427 IContextSource
$context,
1428 $formClass = PreferencesFormLegacy
::class,
1431 // We use ButtonWidgets in some of the getPreferences() functions
1432 $context->getOutput()->enableOOUI();
1434 $formDescriptor = $this->getFormDescriptor( $user, $context );
1435 if ( count( $remove ) ) {
1436 $removeKeys = array_flip( $remove );
1437 $formDescriptor = array_diff_key( $formDescriptor, $removeKeys );
1440 // Remove type=api preferences. They are not intended for rendering in the form.
1441 foreach ( $formDescriptor as $name => $info ) {
1442 if ( isset( $info['type'] ) && $info['type'] === 'api' ) {
1443 unset( $formDescriptor[$name] );
1448 * @var $htmlForm HTMLForm
1450 $htmlForm = new $formClass( $formDescriptor, $context, 'prefs' );
1452 $htmlForm->setModifiedUser( $user );
1453 $htmlForm->setId( 'mw-prefs-form' );
1454 $htmlForm->setAutocomplete( 'off' );
1455 $htmlForm->setSubmitText( $context->msg( 'saveprefs' )->text() );
1456 # Used message keys: 'accesskey-preferences-save', 'tooltip-preferences-save'
1457 $htmlForm->setSubmitTooltip( 'preferences-save' );
1458 $htmlForm->setSubmitID( 'prefcontrol' );
1459 $htmlForm->setSubmitCallback(
1460 function ( array $formData, HTMLForm
$form ) use ( $formDescriptor ) {
1461 return $this->submitForm( $formData, $form, $formDescriptor );
1469 * @param IContextSource $context
1472 protected function getTimezoneOptions( IContextSource
$context ) {
1475 $localTZoffset = $this->config
->get( 'LocalTZoffset' );
1476 $timeZoneList = $this->getTimeZoneList( $context->getLanguage() );
1478 $timestamp = MWTimestamp
::getLocalInstance();
1479 // Check that the LocalTZoffset is the same as the local time zone offset
1480 if ( $localTZoffset == $timestamp->format( 'Z' ) / 60 ) {
1481 $timezoneName = $timestamp->getTimezone()->getName();
1482 // Localize timezone
1483 if ( isset( $timeZoneList[$timezoneName] ) ) {
1484 $timezoneName = $timeZoneList[$timezoneName]['name'];
1486 $server_tz_msg = $context->msg(
1487 'timezoneuseserverdefault',
1491 $tzstring = sprintf(
1493 floor( $localTZoffset / 60 ),
1494 abs( $localTZoffset ) %
60
1496 $server_tz_msg = $context->msg( 'timezoneuseserverdefault', $tzstring )->text();
1498 $opt[$server_tz_msg] = "System|$localTZoffset";
1499 $opt[$context->msg( 'timezoneuseoffset' )->text()] = 'other';
1500 $opt[$context->msg( 'guesstimezone' )->text()] = 'guess';
1502 foreach ( $timeZoneList as $timeZoneInfo ) {
1503 $region = $timeZoneInfo['region'];
1504 if ( !isset( $opt[$region] ) ) {
1507 $opt[$region][$timeZoneInfo['name']] = $timeZoneInfo['timecorrection'];
1513 * Handle the form submission if everything validated properly
1515 * @param array $formData
1516 * @param HTMLForm $form
1517 * @param array[] $formDescriptor
1518 * @return bool|Status|string
1520 protected function saveFormData( $formData, HTMLForm
$form, array $formDescriptor ) {
1521 /** @var \User $user */
1522 $user = $form->getModifiedUser();
1523 $hiddenPrefs = $this->config
->get( 'HiddenPrefs' );
1526 if ( !$user->isAllowedAny( 'editmyprivateinfo', 'editmyoptions' ) ) {
1527 return Status
::newFatal( 'mypreferencesprotected' );
1531 $this->applyFilters( $formData, $formDescriptor, 'filterFromForm' );
1533 // Fortunately, the realname field is MUCH simpler
1534 // (not really "private", but still shouldn't be edited without permission)
1536 if ( !in_array( 'realname', $hiddenPrefs )
1537 && $user->isAllowed( 'editmyprivateinfo' )
1538 && array_key_exists( 'realname', $formData )
1540 $realName = $formData['realname'];
1541 $user->setRealName( $realName );
1544 if ( $user->isAllowed( 'editmyoptions' ) ) {
1545 $oldUserOptions = $user->getOptions();
1547 foreach ( $this->getSaveBlacklist() as $b ) {
1548 unset( $formData[$b] );
1551 # If users have saved a value for a preference which has subsequently been disabled
1552 # via $wgHiddenPrefs, we don't want to destroy that setting in case the preference
1553 # is subsequently re-enabled
1554 foreach ( $hiddenPrefs as $pref ) {
1555 # If the user has not set a non-default value here, the default will be returned
1556 # and subsequently discarded
1557 $formData[$pref] = $user->getOption( $pref, null, true );
1560 // If the user changed the rclimit preference, also change the rcfilters-rclimit preference
1562 isset( $formData['rclimit'] ) &&
1563 intval( $formData[ 'rclimit' ] ) !== $user->getIntOption( 'rclimit' )
1565 $formData['rcfilters-limit'] = $formData['rclimit'];
1568 // Keep old preferences from interfering due to back-compat code, etc.
1569 $user->resetOptions( 'unused', $form->getContext() );
1571 foreach ( $formData as $key => $value ) {
1572 $user->setOption( $key, $value );
1576 'PreferencesFormPreSave',
1577 [ $formData, $form, $user, &$result, $oldUserOptions ]
1581 AuthManager
::callLegacyAuthPlugin( 'updateExternalDB', [ $user ] );
1582 $user->saveSettings();
1588 * Applies filters to preferences either before or after form usage
1590 * @param array &$preferences
1591 * @param array $formDescriptor
1592 * @param string $verb Name of the filter method to call, either 'filterFromForm' or
1595 protected function applyFilters( array &$preferences, array $formDescriptor, $verb ) {
1596 foreach ( $formDescriptor as $preference => $desc ) {
1597 if ( !isset( $desc['filter'] ) ||
!isset( $preferences[$preference] ) ) {
1600 $filterDesc = $desc['filter'];
1601 if ( $filterDesc instanceof Filter
) {
1602 $filter = $filterDesc;
1603 } elseif ( class_exists( $filterDesc ) ) {
1604 $filter = new $filterDesc();
1605 } elseif ( is_callable( $filterDesc ) ) {
1606 $filter = $filterDesc();
1608 throw new UnexpectedValueException(
1609 "Unrecognized filter type for preference '$preference'"
1612 $preferences[$preference] = $filter->$verb( $preferences[$preference] );
1617 * Save the form data and reload the page
1619 * @param array $formData
1620 * @param HTMLForm $form
1621 * @param array $formDescriptor
1624 protected function submitForm( array $formData, HTMLForm
$form, array $formDescriptor ) {
1625 $res = $this->saveFormData( $formData, $form, $formDescriptor );
1627 if ( $res === true ) {
1628 $context = $form->getContext();
1631 if ( $res === 'eauth' ) {
1632 $urlOptions['eauth'] = 1;
1635 $urlOptions +
= $form->getExtraSuccessRedirectParameters();
1637 $url = $form->getTitle()->getFullURL( $urlOptions );
1639 // Set session data for the success message
1640 $context->getRequest()->getSession()->set( 'specialPreferencesSaveSuccess', 1 );
1642 $context->getOutput()->redirect( $url );
1645 return ( $res === true ? Status
::newGood() : $res );
1649 * Get a list of all time zones
1650 * @param Language $language Language used for the localized names
1651 * @return array A list of all time zones. The system name of the time zone is used as key and
1652 * the value is an array which contains localized name, the timecorrection value used for
1653 * preferences and the region
1656 protected function getTimeZoneList( Language
$language ) {
1657 $identifiers = DateTimeZone
::listIdentifiers();
1658 if ( $identifiers === false ) {
1661 sort( $identifiers );
1664 'Africa' => wfMessage( 'timezoneregion-africa' )->inLanguage( $language )->text(),
1665 'America' => wfMessage( 'timezoneregion-america' )->inLanguage( $language )->text(),
1666 'Antarctica' => wfMessage( 'timezoneregion-antarctica' )->inLanguage( $language )->text(),
1667 'Arctic' => wfMessage( 'timezoneregion-arctic' )->inLanguage( $language )->text(),
1668 'Asia' => wfMessage( 'timezoneregion-asia' )->inLanguage( $language )->text(),
1669 'Atlantic' => wfMessage( 'timezoneregion-atlantic' )->inLanguage( $language )->text(),
1670 'Australia' => wfMessage( 'timezoneregion-australia' )->inLanguage( $language )->text(),
1671 'Europe' => wfMessage( 'timezoneregion-europe' )->inLanguage( $language )->text(),
1672 'Indian' => wfMessage( 'timezoneregion-indian' )->inLanguage( $language )->text(),
1673 'Pacific' => wfMessage( 'timezoneregion-pacific' )->inLanguage( $language )->text(),
1675 asort( $tzRegions );
1679 $now = new DateTime();
1681 foreach ( $identifiers as $identifier ) {
1682 $parts = explode( '/', $identifier, 2 );
1684 // DateTimeZone::listIdentifiers() returns a number of
1685 // backwards-compatibility entries. This filters them out of the
1686 // list presented to the user.
1687 if ( count( $parts ) !== 2 ||
!array_key_exists( $parts[0], $tzRegions ) ) {
1692 $parts[0] = $tzRegions[$parts[0]];
1694 $dateTimeZone = new DateTimeZone( $identifier );
1695 $minDiff = floor( $dateTimeZone->getOffset( $now ) / 60 );
1697 $display = str_replace( '_', ' ', $parts[0] . '/' . $parts[1] );
1698 $value = "ZoneInfo|$minDiff|$identifier";
1700 $timeZoneList[$identifier] = [
1702 'timecorrection' => $value,
1703 'region' => $parts[0],
1707 return $timeZoneList;