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 $groupStringOrObject = $userGroupMemberships[$ueg] ??
$ueg;
272 $userG = UserGroupMembership
::getLink( $groupStringOrObject, $context, 'html' );
273 $userM = UserGroupMembership
::getLink( $groupStringOrObject, $context, 'html',
276 // Store expiring groups separately, so we can place them before non-expiring
277 // groups in the list. This is to avoid the ambiguity of something like
278 // "administrator, bureaucrat (until X date)" -- users might wonder whether the
279 // expiry date applies to both groups, or just the last one
280 if ( $groupStringOrObject instanceof UserGroupMembership
&&
281 $groupStringOrObject->getExpiry()
283 $userTempGroups[] = $userG;
284 $userTempMembers[] = $userM;
286 $userGroups[] = $userG;
287 $userMembers[] = $userM;
291 sort( $userMembers );
292 sort( $userTempGroups );
293 sort( $userTempMembers );
294 $userGroups = array_merge( $userTempGroups, $userGroups );
295 $userMembers = array_merge( $userTempMembers, $userMembers );
297 $defaultPreferences['usergroups'] = [
299 'label' => $context->msg( 'prefs-memberingroups' )->numParams(
300 count( $userGroups ) )->params( $userName )->parse(),
301 'default' => $context->msg( 'prefs-memberingroups-type' )
302 ->rawParams( $lang->commaList( $userGroups ), $lang->commaList( $userMembers ) )
305 'section' => 'personal/info',
308 $contribTitle = SpecialPage
::getTitleFor( "Contributions", $userName );
309 $formattedEditCount = $lang->formatNum( $user->getEditCount() );
310 $editCount = $this->linkRenderer
->makeLink( $contribTitle, $formattedEditCount );
312 $defaultPreferences['editcount'] = [
315 'label-message' => 'prefs-edits',
316 'default' => $editCount,
317 'section' => 'personal/info',
320 if ( $user->getRegistration() ) {
321 $displayUser = $context->getUser();
322 $userRegistration = $user->getRegistration();
323 $defaultPreferences['registrationdate'] = [
325 'label-message' => 'prefs-registration',
326 'default' => $context->msg(
327 'prefs-registration-date-time',
328 $lang->userTimeAndDate( $userRegistration, $displayUser ),
329 $lang->userDate( $userRegistration, $displayUser ),
330 $lang->userTime( $userRegistration, $displayUser )
332 'section' => 'personal/info',
336 $canViewPrivateInfo = $user->isAllowed( 'viewmyprivateinfo' );
337 $canEditPrivateInfo = $user->isAllowed( 'editmyprivateinfo' );
339 // Actually changeable stuff
340 $defaultPreferences['realname'] = [
341 // (not really "private", but still shouldn't be edited without permission)
342 'type' => $canEditPrivateInfo && $this->authManager
->allowsPropertyChange( 'realname' )
344 'default' => $user->getRealName(),
345 'section' => 'personal/info',
346 'label-message' => 'yourrealname',
347 'help-message' => 'prefs-help-realname',
350 if ( $canEditPrivateInfo && $this->authManager
->allowsAuthenticationDataChange(
351 new PasswordAuthenticationRequest(), false )->isGood()
353 $defaultPreferences['password'] = [
356 'default' => (string)new \OOUI\
ButtonWidget( [
357 'href' => SpecialPage
::getTitleFor( 'ChangePassword' )->getLinkURL( [
358 'returnto' => SpecialPage
::getTitleFor( 'Preferences' )->getPrefixedText()
360 'label' => $context->msg( 'prefs-resetpass' )->text(),
362 'label-message' => 'yourpassword',
363 'section' => 'personal/info',
366 // Only show prefershttps if secure login is turned on
367 if ( $this->config
->get( 'SecureLogin' ) && $canIPUseHTTPS ) {
368 $defaultPreferences['prefershttps'] = [
370 'label-message' => 'tog-prefershttps',
371 'help-message' => 'prefs-help-prefershttps',
372 'section' => 'personal/info'
377 $languages = Language
::fetchLanguageNames( null, 'mwfile' );
378 $languageCode = $this->config
->get( 'LanguageCode' );
379 if ( !array_key_exists( $languageCode, $languages ) ) {
380 $languages[$languageCode] = $languageCode;
381 // Sort the array again
386 foreach ( $languages as $code => $name ) {
387 $display = LanguageCode
::bcp47( $code ) . ' - ' . $name;
388 $options[$display] = $code;
390 $defaultPreferences['language'] = [
392 'section' => 'personal/i18n',
393 'options' => $options,
394 'label-message' => 'yourlanguage',
397 $defaultPreferences['gender'] = [
399 'section' => 'personal/i18n',
401 $context->msg( 'parentheses' )
402 ->params( $context->msg( 'gender-unknown' )->plain() )
403 ->escaped() => 'unknown',
404 $context->msg( 'gender-female' )->escaped() => 'female',
405 $context->msg( 'gender-male' )->escaped() => 'male',
407 'label-message' => 'yourgender',
408 'help-message' => 'prefs-help-gender',
411 // see if there are multiple language variants to choose from
412 if ( !$this->config
->get( 'DisableLangConversion' ) ) {
413 foreach ( LanguageConverter
::$languagesWithVariants as $langCode ) {
414 if ( $langCode == $this->contLang
->getCode() ) {
415 if ( !$this->contLang
->hasVariants() ) {
419 $variants = $this->contLang
->getVariants();
421 foreach ( $variants as $v ) {
422 $v = str_replace( '_', '-', strtolower( $v ) );
423 $variantArray[$v] = $lang->getVariantname( $v, false );
427 foreach ( $variantArray as $code => $name ) {
428 $display = LanguageCode
::bcp47( $code ) . ' - ' . $name;
429 $options[$display] = $code;
432 $defaultPreferences['variant'] = [
433 'label-message' => 'yourvariant',
435 'options' => $options,
436 'section' => 'personal/i18n',
437 'help-message' => 'prefs-help-variant',
440 $defaultPreferences["variant-$langCode"] = [
447 // Stuff from Language::getExtraUserToggles()
448 // FIXME is this dead code? $extraUserToggles doesn't seem to be defined for any language
449 $toggles = $this->contLang
->getExtraUserToggles();
451 foreach ( $toggles as $toggle ) {
452 $defaultPreferences[$toggle] = [
454 'section' => 'personal/i18n',
455 'label-message' => "tog-$toggle",
459 // show a preview of the old signature first
460 $oldsigWikiText = MediaWikiServices
::getInstance()->getParser()->preSaveTransform(
462 $context->getTitle(),
464 ParserOptions
::newFromContext( $context )
466 $oldsigHTML = $context->getOutput()->parseInline( $oldsigWikiText, true, true );
467 $defaultPreferences['oldsig'] = [
470 'label-message' => 'tog-oldsig',
471 'default' => $oldsigHTML,
472 'section' => 'personal/signature',
474 $defaultPreferences['nickname'] = [
475 'type' => $this->authManager
->allowsPropertyChange( 'nickname' ) ?
'text' : 'info',
476 'maxlength' => $this->config
->get( 'MaxSigChars' ),
477 'label-message' => 'yournick',
478 'validation-callback' => function ( $signature, $alldata, HTMLForm
$form ) {
479 return $this->validateSignature( $signature, $alldata, $form );
481 'section' => 'personal/signature',
482 'filter-callback' => function ( $signature, array $alldata, HTMLForm
$form ) {
483 return $this->cleanSignature( $signature, $alldata, $form );
486 $defaultPreferences['fancysig'] = [
488 'label-message' => 'tog-fancysig',
489 // show general help about signature at the bottom of the section
490 'help-message' => 'prefs-help-signature',
491 'section' => 'personal/signature'
496 if ( $this->config
->get( 'EnableEmail' ) ) {
497 if ( $canViewPrivateInfo ) {
498 $helpMessages[] = $this->config
->get( 'EmailConfirmToEdit' )
499 ?
'prefs-help-email-required'
500 : 'prefs-help-email';
502 if ( $this->config
->get( 'EnableUserEmail' ) ) {
503 // additional messages when users can send email to each other
504 $helpMessages[] = 'prefs-help-email-others';
507 $emailAddress = $user->getEmail() ?
htmlspecialchars( $user->getEmail() ) : '';
508 if ( $canEditPrivateInfo && $this->authManager
->allowsPropertyChange( 'emailaddress' ) ) {
509 $button = new \OOUI\
ButtonWidget( [
510 'href' => SpecialPage
::getTitleFor( 'ChangeEmail' )->getLinkURL( [
511 'returnto' => SpecialPage
::getTitleFor( 'Preferences' )->getPrefixedText()
514 $context->msg( $user->getEmail() ?
'prefs-changeemail' : 'prefs-setemail' )->text(),
517 $emailAddress .= $emailAddress == '' ?
$button : ( '<br />' . $button );
520 $defaultPreferences['emailaddress'] = [
523 'default' => $emailAddress,
524 'label-message' => 'youremail',
525 'section' => 'personal/email',
526 'help-messages' => $helpMessages,
527 # 'cssclass' chosen below
531 $disableEmailPrefs = false;
533 if ( $this->config
->get( 'EmailAuthentication' ) ) {
534 $emailauthenticationclass = 'mw-email-not-authenticated';
535 if ( $user->getEmail() ) {
536 if ( $user->getEmailAuthenticationTimestamp() ) {
537 // date and time are separate parameters to facilitate localisation.
538 // $time is kept for backward compat reasons.
539 // 'emailauthenticated' is also used in SpecialConfirmemail.php
540 $displayUser = $context->getUser();
541 $emailTimestamp = $user->getEmailAuthenticationTimestamp();
542 $time = $lang->userTimeAndDate( $emailTimestamp, $displayUser );
543 $d = $lang->userDate( $emailTimestamp, $displayUser );
544 $t = $lang->userTime( $emailTimestamp, $displayUser );
545 $emailauthenticated = $context->msg( 'emailauthenticated',
546 $time, $d, $t )->parse() . '<br />';
547 $disableEmailPrefs = false;
548 $emailauthenticationclass = 'mw-email-authenticated';
550 $disableEmailPrefs = true;
551 $emailauthenticated = $context->msg( 'emailnotauthenticated' )->parse() . '<br />' .
552 new \OOUI\
ButtonWidget( [
553 'href' => SpecialPage
::getTitleFor( 'Confirmemail' )->getLinkURL(),
554 'label' => $context->msg( 'emailconfirmlink' )->text(),
556 $emailauthenticationclass = "mw-email-not-authenticated";
559 $disableEmailPrefs = true;
560 $emailauthenticated = $context->msg( 'noemailprefs' )->escaped();
561 $emailauthenticationclass = 'mw-email-none';
564 if ( $canViewPrivateInfo ) {
565 $defaultPreferences['emailauthentication'] = [
568 'section' => 'personal/email',
569 'label-message' => 'prefs-emailconfirm-label',
570 'default' => $emailauthenticated,
571 # Apply the same CSS class used on the input to the message:
572 'cssclass' => $emailauthenticationclass,
577 if ( $this->config
->get( 'EnableUserEmail' ) && $user->isAllowed( 'sendemail' ) ) {
578 $defaultPreferences['disablemail'] = [
579 'id' => 'wpAllowEmail',
582 'section' => 'personal/email',
583 'label-message' => 'allowemail',
584 'disabled' => $disableEmailPrefs,
587 $defaultPreferences['email-allow-new-users'] = [
588 'id' => 'wpAllowEmailFromNewUsers',
590 'section' => 'personal/email',
591 'label-message' => 'email-allow-new-users-label',
592 'disabled' => $disableEmailPrefs,
595 $defaultPreferences['ccmeonemails'] = [
597 'section' => 'personal/email',
598 'label-message' => 'tog-ccmeonemails',
599 'disabled' => $disableEmailPrefs,
602 if ( $this->config
->get( 'EnableUserEmailBlacklist' ) ) {
603 $defaultPreferences['email-blacklist'] = [
604 'type' => 'usersmultiselect',
605 'label-message' => 'email-blacklist-label',
606 'section' => 'personal/email',
607 'disabled' => $disableEmailPrefs,
608 'filter' => MultiUsernameFilter
::class,
613 if ( $this->config
->get( 'EnotifWatchlist' ) ) {
614 $defaultPreferences['enotifwatchlistpages'] = [
616 'section' => 'personal/email',
617 'label-message' => 'tog-enotifwatchlistpages',
618 'disabled' => $disableEmailPrefs,
621 if ( $this->config
->get( 'EnotifUserTalk' ) ) {
622 $defaultPreferences['enotifusertalkpages'] = [
624 'section' => 'personal/email',
625 'label-message' => 'tog-enotifusertalkpages',
626 'disabled' => $disableEmailPrefs,
629 if ( $this->config
->get( 'EnotifUserTalk' ) ||
$this->config
->get( 'EnotifWatchlist' ) ) {
630 if ( $this->config
->get( 'EnotifMinorEdits' ) ) {
631 $defaultPreferences['enotifminoredits'] = [
633 'section' => 'personal/email',
634 'label-message' => 'tog-enotifminoredits',
635 'disabled' => $disableEmailPrefs,
639 if ( $this->config
->get( 'EnotifRevealEditorAddress' ) ) {
640 $defaultPreferences['enotifrevealaddr'] = [
642 'section' => 'personal/email',
643 'label-message' => 'tog-enotifrevealaddr',
644 'disabled' => $disableEmailPrefs,
653 * @param IContextSource $context
654 * @param array &$defaultPreferences
657 protected function skinPreferences( User
$user, IContextSource
$context, &$defaultPreferences ) {
658 # # Skin #####################################
660 // Skin selector, if there is at least one valid skin
661 $skinOptions = $this->generateSkinOptions( $user, $context );
662 if ( $skinOptions ) {
663 $defaultPreferences['skin'] = [
665 'options' => $skinOptions,
666 'section' => 'rendering/skin',
670 $allowUserCss = $this->config
->get( 'AllowUserCss' );
671 $allowUserJs = $this->config
->get( 'AllowUserJs' );
672 # Create links to user CSS/JS pages for all skins
673 # This code is basically copied from generateSkinOptions(). It'd
674 # be nice to somehow merge this back in there to avoid redundancy.
675 if ( $allowUserCss ||
$allowUserJs ) {
677 $userName = $user->getName();
679 if ( $allowUserCss ) {
680 $cssPage = Title
::makeTitleSafe( NS_USER
, $userName . '/common.css' );
681 $cssLinkText = $context->msg( 'prefs-custom-css' )->text();
682 $linkTools[] = $this->linkRenderer
->makeLink( $cssPage, $cssLinkText );
685 if ( $allowUserJs ) {
686 $jsPage = Title
::makeTitleSafe( NS_USER
, $userName . '/common.js' );
687 $jsLinkText = $context->msg( 'prefs-custom-js' )->text();
688 $linkTools[] = $this->linkRenderer
->makeLink( $jsPage, $jsLinkText );
691 $defaultPreferences['commoncssjs'] = [
694 'default' => $context->getLanguage()->pipeList( $linkTools ),
695 'label-message' => 'prefs-common-config',
696 'section' => 'rendering/skin',
702 * @param IContextSource $context
703 * @param array &$defaultPreferences
705 protected function filesPreferences( IContextSource
$context, &$defaultPreferences ) {
706 # # Files #####################################
707 $defaultPreferences['imagesize'] = [
709 'options' => $this->getImageSizes( $context ),
710 'label-message' => 'imagemaxsize',
711 'section' => 'rendering/files',
713 $defaultPreferences['thumbsize'] = [
715 'options' => $this->getThumbSizes( $context ),
716 'label-message' => 'thumbsize',
717 'section' => 'rendering/files',
723 * @param IContextSource $context
724 * @param array &$defaultPreferences
727 protected function datetimePreferences( $user, IContextSource
$context, &$defaultPreferences ) {
728 # # Date and time #####################################
729 $dateOptions = $this->getDateOptions( $context );
730 if ( $dateOptions ) {
731 $defaultPreferences['date'] = [
733 'options' => $dateOptions,
734 'section' => 'rendering/dateformat',
739 $now = wfTimestampNow();
740 $lang = $context->getLanguage();
741 $nowlocal = Xml
::element( 'span', [ 'id' => 'wpLocalTime' ],
742 $lang->userTime( $now, $user ) );
743 $nowserver = $lang->userTime( $now, $user,
744 [ 'format' => false, 'timecorrection' => false ] ) .
745 Html
::hidden( 'wpServerTime', (int)substr( $now, 8, 2 ) * 60 +
(int)substr( $now, 10, 2 ) );
747 $defaultPreferences['nowserver'] = [
750 'label-message' => 'servertime',
751 'default' => $nowserver,
752 'section' => 'rendering/timeoffset',
755 $defaultPreferences['nowlocal'] = [
758 'label-message' => 'localtime',
759 'default' => $nowlocal,
760 'section' => 'rendering/timeoffset',
763 // Grab existing pref.
764 $tzOffset = $user->getOption( 'timecorrection' );
765 $tz = explode( '|', $tzOffset, 3 );
767 $tzOptions = $this->getTimezoneOptions( $context );
769 $tzSetting = $tzOffset;
770 if ( count( $tz ) > 1 && $tz[0] == 'ZoneInfo' &&
771 !in_array( $tzOffset, HTMLFormField
::flattenOptions( $tzOptions ) )
773 // Timezone offset can vary with DST
775 $userTZ = new DateTimeZone( $tz[2] );
776 $minDiff = floor( $userTZ->getOffset( new DateTime( 'now' ) ) / 60 );
777 $tzSetting = "ZoneInfo|$minDiff|{$tz[2]}";
778 } catch ( Exception
$e ) {
779 // User has an invalid time zone set. Fall back to just using the offset
783 if ( count( $tz ) > 1 && $tz[0] == 'Offset' ) {
785 $tzSetting = sprintf( '%+03d:%02d', floor( $minDiff / 60 ), abs( $minDiff ) %
60 );
788 $defaultPreferences['timecorrection'] = [
789 'class' => \HTMLSelectOrOtherField
::class,
790 'label-message' => 'timezonelegend',
791 'options' => $tzOptions,
792 'default' => $tzSetting,
794 'section' => 'rendering/timeoffset',
795 'id' => 'wpTimeCorrection',
796 'filter' => TimezoneFilter
::class,
801 * @param MessageLocalizer $l10n
802 * @param array &$defaultPreferences
804 protected function renderingPreferences( MessageLocalizer
$l10n, &$defaultPreferences ) {
805 # # Diffs ####################################
806 $defaultPreferences['diffonly'] = [
808 'section' => 'rendering/diffs',
809 'label-message' => 'tog-diffonly',
811 $defaultPreferences['norollbackdiff'] = [
813 'section' => 'rendering/diffs',
814 'label-message' => 'tog-norollbackdiff',
817 # # Page Rendering ##############################
818 if ( $this->config
->get( 'AllowUserCssPrefs' ) ) {
819 $defaultPreferences['underline'] = [
822 $l10n->msg( 'underline-never' )->text() => 0,
823 $l10n->msg( 'underline-always' )->text() => 1,
824 $l10n->msg( 'underline-default' )->text() => 2,
826 'label-message' => 'tog-underline',
827 'section' => 'rendering/advancedrendering',
831 $stubThresholdValues = [ 50, 100, 500, 1000, 2000, 5000, 10000 ];
832 $stubThresholdOptions = [ $l10n->msg( 'stub-threshold-disabled' )->text() => 0 ];
833 foreach ( $stubThresholdValues as $value ) {
834 $stubThresholdOptions[$l10n->msg( 'size-bytes', $value )->text()] = $value;
837 $defaultPreferences['stubthreshold'] = [
839 'section' => 'rendering/advancedrendering',
840 'options' => $stubThresholdOptions,
841 // This is not a raw HTML message; label-raw is needed for the manual <a></a>
842 'label-raw' => $l10n->msg( 'stub-threshold' )->rawParams(
843 '<a href="#" class="stub">' .
844 $l10n->msg( 'stub-threshold-sample-link' )->parse() .
848 $defaultPreferences['showhiddencats'] = [
850 'section' => 'rendering/advancedrendering',
851 'label-message' => 'tog-showhiddencats'
854 $defaultPreferences['numberheadings'] = [
856 'section' => 'rendering/advancedrendering',
857 'label-message' => 'tog-numberheadings',
863 * @param MessageLocalizer $l10n
864 * @param array &$defaultPreferences
866 protected function editingPreferences( User
$user, MessageLocalizer
$l10n, &$defaultPreferences ) {
867 # # Editing #####################################
868 $defaultPreferences['editsectiononrightclick'] = [
870 'section' => 'editing/advancedediting',
871 'label-message' => 'tog-editsectiononrightclick',
873 $defaultPreferences['editondblclick'] = [
875 'section' => 'editing/advancedediting',
876 'label-message' => 'tog-editondblclick',
879 if ( $this->config
->get( 'AllowUserCssPrefs' ) ) {
880 $defaultPreferences['editfont'] = [
882 'section' => 'editing/editor',
883 'label-message' => 'editfont-style',
885 $l10n->msg( 'editfont-monospace' )->text() => 'monospace',
886 $l10n->msg( 'editfont-sansserif' )->text() => 'sans-serif',
887 $l10n->msg( 'editfont-serif' )->text() => 'serif',
892 if ( $user->isAllowed( 'minoredit' ) ) {
893 $defaultPreferences['minordefault'] = [
895 'section' => 'editing/editor',
896 'label-message' => 'tog-minordefault',
900 $defaultPreferences['forceeditsummary'] = [
902 'section' => 'editing/editor',
903 'label-message' => 'tog-forceeditsummary',
905 $defaultPreferences['useeditwarning'] = [
907 'section' => 'editing/editor',
908 'label-message' => 'tog-useeditwarning',
911 $defaultPreferences['previewonfirst'] = [
913 'section' => 'editing/preview',
914 'label-message' => 'tog-previewonfirst',
916 $defaultPreferences['previewontop'] = [
918 'section' => 'editing/preview',
919 'label-message' => 'tog-previewontop',
921 $defaultPreferences['uselivepreview'] = [
923 'section' => 'editing/preview',
924 'label-message' => 'tog-uselivepreview',
930 * @param MessageLocalizer $l10n
931 * @param array &$defaultPreferences
933 protected function rcPreferences( User
$user, MessageLocalizer
$l10n, &$defaultPreferences ) {
934 $rcMaxAge = $this->config
->get( 'RCMaxAge' );
935 # # RecentChanges #####################################
936 $defaultPreferences['rcdays'] = [
938 'label-message' => 'recentchangesdays',
939 'section' => 'rc/displayrc',
941 'max' => ceil( $rcMaxAge / ( 3600 * 24 ) ),
942 'help' => $l10n->msg( 'recentchangesdays-max' )->numParams(
943 ceil( $rcMaxAge / ( 3600 * 24 ) ) )->escaped()
945 $defaultPreferences['rclimit'] = [
949 'label-message' => 'recentchangescount',
950 'help-message' => 'prefs-help-recentchangescount',
951 'section' => 'rc/displayrc',
952 'filter' => IntvalFilter
::class,
954 $defaultPreferences['usenewrc'] = [
956 'label-message' => 'tog-usenewrc',
957 'section' => 'rc/advancedrc',
959 $defaultPreferences['hideminor'] = [
961 'label-message' => 'tog-hideminor',
962 'section' => 'rc/advancedrc',
964 $defaultPreferences['rcfilters-rc-collapsed'] = [
967 $defaultPreferences['rcfilters-wl-collapsed'] = [
970 $defaultPreferences['rcfilters-saved-queries'] = [
973 $defaultPreferences['rcfilters-wl-saved-queries'] = [
976 // Override RCFilters preferences for RecentChanges 'limit'
977 $defaultPreferences['rcfilters-limit'] = [
980 $defaultPreferences['rcfilters-saved-queries-versionbackup'] = [
983 $defaultPreferences['rcfilters-wl-saved-queries-versionbackup'] = [
987 if ( $this->config
->get( 'RCWatchCategoryMembership' ) ) {
988 $defaultPreferences['hidecategorization'] = [
990 'label-message' => 'tog-hidecategorization',
991 'section' => 'rc/advancedrc',
995 if ( $user->useRCPatrol() ) {
996 $defaultPreferences['hidepatrolled'] = [
998 'section' => 'rc/advancedrc',
999 'label-message' => 'tog-hidepatrolled',
1003 if ( $user->useNPPatrol() ) {
1004 $defaultPreferences['newpageshidepatrolled'] = [
1006 'section' => 'rc/advancedrc',
1007 'label-message' => 'tog-newpageshidepatrolled',
1011 if ( $this->config
->get( 'RCShowWatchingUsers' ) ) {
1012 $defaultPreferences['shownumberswatching'] = [
1014 'section' => 'rc/advancedrc',
1015 'label-message' => 'tog-shownumberswatching',
1019 $defaultPreferences['rcenhancedfilters-disable'] = [
1021 'section' => 'rc/optoutrc',
1022 'label-message' => 'rcfilters-preference-label',
1023 'help-message' => 'rcfilters-preference-help',
1029 * @param IContextSource $context
1030 * @param array &$defaultPreferences
1032 protected function watchlistPreferences(
1033 User
$user, IContextSource
$context, &$defaultPreferences
1035 $watchlistdaysMax = ceil( $this->config
->get( 'RCMaxAge' ) / ( 3600 * 24 ) );
1037 # # Watchlist #####################################
1038 if ( $user->isAllowed( 'editmywatchlist' ) ) {
1039 $editWatchlistLinks = '';
1040 $editWatchlistLinksOld = [];
1041 $editWatchlistModes = [
1042 'edit' => [ 'subpage' => false, 'flags' => [] ],
1043 'raw' => [ 'subpage' => 'raw', 'flags' => [] ],
1044 'clear' => [ 'subpage' => 'clear', 'flags' => [ 'destructive' ] ],
1046 foreach ( $editWatchlistModes as $mode => $options ) {
1047 // Messages: prefs-editwatchlist-edit, prefs-editwatchlist-raw, prefs-editwatchlist-clear
1048 $editWatchlistLinks .=
1049 new \OOUI\
ButtonWidget( [
1050 'href' => SpecialPage
::getTitleFor( 'EditWatchlist', $options['subpage'] )->getLinkURL(),
1051 'flags' => $options[ 'flags' ],
1052 'label' => new \OOUI\
HtmlSnippet(
1053 $context->msg( "prefs-editwatchlist-{$mode}" )->parse()
1058 $defaultPreferences['editwatchlist'] = [
1061 'default' => $editWatchlistLinks,
1062 'label-message' => 'prefs-editwatchlist-label',
1063 'section' => 'watchlist/editwatchlist',
1067 $defaultPreferences['watchlistdays'] = [
1070 'max' => $watchlistdaysMax,
1071 'section' => 'watchlist/displaywatchlist',
1072 'help' => $context->msg( 'prefs-watchlist-days-max' )->numParams(
1073 $watchlistdaysMax )->escaped(),
1074 'label-message' => 'prefs-watchlist-days',
1076 $defaultPreferences['wllimit'] = [
1080 'label-message' => 'prefs-watchlist-edits',
1081 'help' => $context->msg( 'prefs-watchlist-edits-max' )->escaped(),
1082 'section' => 'watchlist/displaywatchlist',
1083 'filter' => IntvalFilter
::class,
1085 $defaultPreferences['extendwatchlist'] = [
1087 'section' => 'watchlist/advancedwatchlist',
1088 'label-message' => 'tog-extendwatchlist',
1090 $defaultPreferences['watchlisthideminor'] = [
1092 'section' => 'watchlist/advancedwatchlist',
1093 'label-message' => 'tog-watchlisthideminor',
1095 $defaultPreferences['watchlisthidebots'] = [
1097 'section' => 'watchlist/advancedwatchlist',
1098 'label-message' => 'tog-watchlisthidebots',
1100 $defaultPreferences['watchlisthideown'] = [
1102 'section' => 'watchlist/advancedwatchlist',
1103 'label-message' => 'tog-watchlisthideown',
1105 $defaultPreferences['watchlisthideanons'] = [
1107 'section' => 'watchlist/advancedwatchlist',
1108 'label-message' => 'tog-watchlisthideanons',
1110 $defaultPreferences['watchlisthideliu'] = [
1112 'section' => 'watchlist/advancedwatchlist',
1113 'label-message' => 'tog-watchlisthideliu',
1116 if ( !\SpecialWatchlist
::checkStructuredFilterUiEnabled(
1120 $defaultPreferences['watchlistreloadautomatically'] = [
1122 'section' => 'watchlist/advancedwatchlist',
1123 'label-message' => 'tog-watchlistreloadautomatically',
1127 $defaultPreferences['watchlistunwatchlinks'] = [
1129 'section' => 'watchlist/advancedwatchlist',
1130 'label-message' => 'tog-watchlistunwatchlinks',
1133 if ( $this->config
->get( 'RCWatchCategoryMembership' ) ) {
1134 $defaultPreferences['watchlisthidecategorization'] = [
1136 'section' => 'watchlist/advancedwatchlist',
1137 'label-message' => 'tog-watchlisthidecategorization',
1141 if ( $user->useRCPatrol() ) {
1142 $defaultPreferences['watchlisthidepatrolled'] = [
1144 'section' => 'watchlist/advancedwatchlist',
1145 'label-message' => 'tog-watchlisthidepatrolled',
1150 'edit' => 'watchdefault',
1151 'move' => 'watchmoves',
1152 'delete' => 'watchdeletion'
1156 if ( $user->isAllowed( 'createpage' ) ||
$user->isAllowed( 'createtalk' ) ) {
1157 $watchTypes['read'] = 'watchcreations';
1160 if ( $user->isAllowed( 'rollback' ) ) {
1161 $watchTypes['rollback'] = 'watchrollback';
1164 if ( $user->isAllowed( 'upload' ) ) {
1165 $watchTypes['upload'] = 'watchuploads';
1168 foreach ( $watchTypes as $action => $pref ) {
1169 if ( $user->isAllowed( $action ) ) {
1171 // tog-watchdefault, tog-watchmoves, tog-watchdeletion, tog-watchcreations, tog-watchuploads
1172 // tog-watchrollback
1173 $defaultPreferences[$pref] = [
1175 'section' => 'watchlist/advancedwatchlist',
1176 'label-message' => "tog-$pref",
1181 $defaultPreferences['watchlisttoken'] = [
1185 $tokenButton = new \OOUI\
ButtonWidget( [
1186 'href' => SpecialPage
::getTitleFor( 'ResetTokens' )->getLinkURL( [
1187 'returnto' => SpecialPage
::getTitleFor( 'Preferences' )->getPrefixedText()
1189 'label' => $context->msg( 'prefs-watchlist-managetokens' )->text(),
1191 $defaultPreferences['watchlisttoken-info'] = [
1193 'section' => 'watchlist/tokenwatchlist',
1194 'label-message' => 'prefs-watchlist-token',
1195 'help-message' => 'prefs-help-tokenmanagement',
1197 'default' => (string)$tokenButton,
1200 $defaultPreferences['wlenhancedfilters-disable'] = [
1202 'section' => 'watchlist/optoutwatchlist',
1203 'label-message' => 'rcfilters-watchlist-preference-label',
1204 'help-message' => 'rcfilters-watchlist-preference-help',
1209 * @param array &$defaultPreferences
1211 protected function searchPreferences( &$defaultPreferences ) {
1212 foreach ( MWNamespace
::getValidNamespaces() as $n ) {
1213 $defaultPreferences['searchNs' . $n] = [
1220 * @param User $user The User object
1221 * @param IContextSource $context
1222 * @return array Text/links to display as key; $skinkey as value
1224 protected function generateSkinOptions( User
$user, IContextSource
$context ) {
1227 $mptitle = Title
::newMainPage();
1228 $previewtext = $context->msg( 'skin-preview' )->escaped();
1230 # Only show skins that aren't disabled in $wgSkipSkins
1231 $validSkinNames = Skin
::getAllowedSkins();
1233 foreach ( $validSkinNames as $skinkey => &$skinname ) {
1234 $msg = $context->msg( "skinname-{$skinkey}" );
1235 if ( $msg->exists() ) {
1236 $skinname = htmlspecialchars( $msg->text() );
1240 $defaultSkin = $this->config
->get( 'DefaultSkin' );
1241 $allowUserCss = $this->config
->get( 'AllowUserCss' );
1242 $allowUserJs = $this->config
->get( 'AllowUserJs' );
1244 # Sort by the internal name, so that the ordering is the same for each display language,
1245 # especially if some skin names are translated to use a different alphabet and some are not.
1246 uksort( $validSkinNames, function ( $a, $b ) use ( $defaultSkin ) {
1247 # Display the default first in the list by comparing it as lesser than any other.
1248 if ( strcasecmp( $a, $defaultSkin ) === 0 ) {
1251 if ( strcasecmp( $b, $defaultSkin ) === 0 ) {
1254 return strcasecmp( $a, $b );
1257 $foundDefault = false;
1258 foreach ( $validSkinNames as $skinkey => $sn ) {
1261 # Mark the default skin
1262 if ( strcasecmp( $skinkey, $defaultSkin ) === 0 ) {
1263 $linkTools[] = $context->msg( 'default' )->escaped();
1264 $foundDefault = true;
1267 # Create preview link
1268 $mplink = htmlspecialchars( $mptitle->getLocalURL( [ 'useskin' => $skinkey ] ) );
1269 $linkTools[] = "<a target='_blank' href=\"$mplink\">$previewtext</a>";
1271 # Create links to user CSS/JS pages
1272 if ( $allowUserCss ) {
1273 $cssPage = Title
::makeTitleSafe( NS_USER
, $user->getName() . '/' . $skinkey . '.css' );
1274 $cssLinkText = $context->msg( 'prefs-custom-css' )->text();
1275 $linkTools[] = $this->linkRenderer
->makeLink( $cssPage, $cssLinkText );
1278 if ( $allowUserJs ) {
1279 $jsPage = Title
::makeTitleSafe( NS_USER
, $user->getName() . '/' . $skinkey . '.js' );
1280 $jsLinkText = $context->msg( 'prefs-custom-js' )->text();
1281 $linkTools[] = $this->linkRenderer
->makeLink( $jsPage, $jsLinkText );
1284 $display = $sn . ' ' . $context->msg( 'parentheses' )
1285 ->rawParams( $context->getLanguage()->pipeList( $linkTools ) )
1287 $ret[$display] = $skinkey;
1290 if ( !$foundDefault ) {
1291 // If the default skin is not available, things are going to break horribly because the
1292 // default value for skin selector will not be a valid value. Let's just not show it then.
1300 * @param IContextSource $context
1303 protected function getDateOptions( IContextSource
$context ) {
1304 $lang = $context->getLanguage();
1305 $dateopts = $lang->getDatePreferences();
1310 if ( !in_array( 'default', $dateopts ) ) {
1311 $dateopts[] = 'default'; // Make sure default is always valid T21237
1314 // FIXME KLUGE: site default might not be valid for user language
1315 global $wgDefaultUserOptions;
1316 if ( !in_array( $wgDefaultUserOptions['date'], $dateopts ) ) {
1317 $wgDefaultUserOptions['date'] = 'default';
1320 $epoch = wfTimestampNow();
1321 foreach ( $dateopts as $key ) {
1322 if ( $key == 'default' ) {
1323 $formatted = $context->msg( 'datedefault' )->escaped();
1325 $formatted = htmlspecialchars( $lang->timeanddate( $epoch, false, $key ) );
1327 $ret[$formatted] = $key;
1334 * @param MessageLocalizer $l10n
1337 protected function getImageSizes( MessageLocalizer
$l10n ) {
1339 $pixels = $l10n->msg( 'unit-pixel' )->text();
1341 foreach ( $this->config
->get( 'ImageLimits' ) as $index => $limits ) {
1342 // Note: A left-to-right marker (U+200E) is inserted, see T144386
1343 $display = "{$limits[0]}\u{200E}×{$limits[1]}$pixels";
1344 $ret[$display] = $index;
1351 * @param MessageLocalizer $l10n
1354 protected function getThumbSizes( MessageLocalizer
$l10n ) {
1356 $pixels = $l10n->msg( 'unit-pixel' )->text();
1358 foreach ( $this->config
->get( 'ThumbLimits' ) as $index => $size ) {
1359 $display = $size . $pixels;
1360 $ret[$display] = $index;
1367 * @param string $signature
1368 * @param array $alldata
1369 * @param HTMLForm $form
1370 * @return bool|string
1372 protected function validateSignature( $signature, $alldata, HTMLForm
$form ) {
1373 $maxSigChars = $this->config
->get( 'MaxSigChars' );
1374 if ( mb_strlen( $signature ) > $maxSigChars ) {
1375 return Xml
::element( 'span', [ 'class' => 'error' ],
1376 $form->msg( 'badsiglength' )->numParams( $maxSigChars )->text() );
1377 } elseif ( isset( $alldata['fancysig'] ) &&
1378 $alldata['fancysig'] &&
1379 MediaWikiServices
::getInstance()->getParser()->validateSig( $signature ) === false
1381 return Xml
::element(
1383 [ 'class' => 'error' ],
1384 $form->msg( 'badsig' )->text()
1392 * @param string $signature
1393 * @param array $alldata
1394 * @param HTMLForm $form
1397 protected function cleanSignature( $signature, $alldata, HTMLForm
$form ) {
1398 $parser = MediaWikiServices
::getInstance()->getParser();
1399 if ( isset( $alldata['fancysig'] ) && $alldata['fancysig'] ) {
1400 $signature = $parser->cleanSig( $signature );
1402 // When no fancy sig used, make sure ~{3,5} get removed.
1403 $signature = Parser
::cleanSigInSig( $signature );
1411 * @param IContextSource $context
1412 * @param string $formClass
1413 * @param array $remove Array of items to remove
1416 public function getForm(
1418 IContextSource
$context,
1419 $formClass = PreferencesFormLegacy
::class,
1422 // We use ButtonWidgets in some of the getPreferences() functions
1423 $context->getOutput()->enableOOUI();
1425 $formDescriptor = $this->getFormDescriptor( $user, $context );
1426 if ( count( $remove ) ) {
1427 $removeKeys = array_flip( $remove );
1428 $formDescriptor = array_diff_key( $formDescriptor, $removeKeys );
1431 // Remove type=api preferences. They are not intended for rendering in the form.
1432 foreach ( $formDescriptor as $name => $info ) {
1433 if ( isset( $info['type'] ) && $info['type'] === 'api' ) {
1434 unset( $formDescriptor[$name] );
1439 * @var $htmlForm HTMLForm
1441 $htmlForm = new $formClass( $formDescriptor, $context, 'prefs' );
1443 $htmlForm->setModifiedUser( $user );
1444 $htmlForm->setId( 'mw-prefs-form' );
1445 $htmlForm->setAutocomplete( 'off' );
1446 $htmlForm->setSubmitText( $context->msg( 'saveprefs' )->text() );
1447 # Used message keys: 'accesskey-preferences-save', 'tooltip-preferences-save'
1448 $htmlForm->setSubmitTooltip( 'preferences-save' );
1449 $htmlForm->setSubmitID( 'prefcontrol' );
1450 $htmlForm->setSubmitCallback(
1451 function ( array $formData, HTMLForm
$form ) use ( $formDescriptor ) {
1452 return $this->submitForm( $formData, $form, $formDescriptor );
1460 * @param IContextSource $context
1463 protected function getTimezoneOptions( IContextSource
$context ) {
1466 $localTZoffset = $this->config
->get( 'LocalTZoffset' );
1467 $timeZoneList = $this->getTimeZoneList( $context->getLanguage() );
1469 $timestamp = MWTimestamp
::getLocalInstance();
1470 // Check that the LocalTZoffset is the same as the local time zone offset
1471 if ( $localTZoffset == $timestamp->format( 'Z' ) / 60 ) {
1472 $timezoneName = $timestamp->getTimezone()->getName();
1473 // Localize timezone
1474 if ( isset( $timeZoneList[$timezoneName] ) ) {
1475 $timezoneName = $timeZoneList[$timezoneName]['name'];
1477 $server_tz_msg = $context->msg(
1478 'timezoneuseserverdefault',
1482 $tzstring = sprintf(
1484 floor( $localTZoffset / 60 ),
1485 abs( $localTZoffset ) %
60
1487 $server_tz_msg = $context->msg( 'timezoneuseserverdefault', $tzstring )->text();
1489 $opt[$server_tz_msg] = "System|$localTZoffset";
1490 $opt[$context->msg( 'timezoneuseoffset' )->text()] = 'other';
1491 $opt[$context->msg( 'guesstimezone' )->text()] = 'guess';
1493 foreach ( $timeZoneList as $timeZoneInfo ) {
1494 $region = $timeZoneInfo['region'];
1495 if ( !isset( $opt[$region] ) ) {
1498 $opt[$region][$timeZoneInfo['name']] = $timeZoneInfo['timecorrection'];
1504 * Handle the form submission if everything validated properly
1506 * @param array $formData
1507 * @param HTMLForm $form
1508 * @param array[] $formDescriptor
1509 * @return bool|Status|string
1511 protected function saveFormData( $formData, HTMLForm
$form, array $formDescriptor ) {
1512 /** @var \User $user */
1513 $user = $form->getModifiedUser();
1514 $hiddenPrefs = $this->config
->get( 'HiddenPrefs' );
1517 if ( !$user->isAllowedAny( 'editmyprivateinfo', 'editmyoptions' ) ) {
1518 return Status
::newFatal( 'mypreferencesprotected' );
1522 $this->applyFilters( $formData, $formDescriptor, 'filterFromForm' );
1524 // Fortunately, the realname field is MUCH simpler
1525 // (not really "private", but still shouldn't be edited without permission)
1527 if ( !in_array( 'realname', $hiddenPrefs )
1528 && $user->isAllowed( 'editmyprivateinfo' )
1529 && array_key_exists( 'realname', $formData )
1531 $realName = $formData['realname'];
1532 $user->setRealName( $realName );
1535 if ( $user->isAllowed( 'editmyoptions' ) ) {
1536 $oldUserOptions = $user->getOptions();
1538 foreach ( $this->getSaveBlacklist() as $b ) {
1539 unset( $formData[$b] );
1542 # If users have saved a value for a preference which has subsequently been disabled
1543 # via $wgHiddenPrefs, we don't want to destroy that setting in case the preference
1544 # is subsequently re-enabled
1545 foreach ( $hiddenPrefs as $pref ) {
1546 # If the user has not set a non-default value here, the default will be returned
1547 # and subsequently discarded
1548 $formData[$pref] = $user->getOption( $pref, null, true );
1551 // If the user changed the rclimit preference, also change the rcfilters-rclimit preference
1553 isset( $formData['rclimit'] ) &&
1554 intval( $formData[ 'rclimit' ] ) !== $user->getIntOption( 'rclimit' )
1556 $formData['rcfilters-limit'] = $formData['rclimit'];
1559 // Keep old preferences from interfering due to back-compat code, etc.
1560 $user->resetOptions( 'unused', $form->getContext() );
1562 foreach ( $formData as $key => $value ) {
1563 $user->setOption( $key, $value );
1567 'PreferencesFormPreSave',
1568 [ $formData, $form, $user, &$result, $oldUserOptions ]
1572 AuthManager
::callLegacyAuthPlugin( 'updateExternalDB', [ $user ] );
1573 $user->saveSettings();
1579 * Applies filters to preferences either before or after form usage
1581 * @param array &$preferences
1582 * @param array $formDescriptor
1583 * @param string $verb Name of the filter method to call, either 'filterFromForm' or
1586 protected function applyFilters( array &$preferences, array $formDescriptor, $verb ) {
1587 foreach ( $formDescriptor as $preference => $desc ) {
1588 if ( !isset( $desc['filter'] ) ||
!isset( $preferences[$preference] ) ) {
1591 $filterDesc = $desc['filter'];
1592 if ( $filterDesc instanceof Filter
) {
1593 $filter = $filterDesc;
1594 } elseif ( class_exists( $filterDesc ) ) {
1595 $filter = new $filterDesc();
1596 } elseif ( is_callable( $filterDesc ) ) {
1597 $filter = $filterDesc();
1599 throw new UnexpectedValueException(
1600 "Unrecognized filter type for preference '$preference'"
1603 $preferences[$preference] = $filter->$verb( $preferences[$preference] );
1608 * Save the form data and reload the page
1610 * @param array $formData
1611 * @param HTMLForm $form
1612 * @param array $formDescriptor
1615 protected function submitForm( array $formData, HTMLForm
$form, array $formDescriptor ) {
1616 $res = $this->saveFormData( $formData, $form, $formDescriptor );
1618 if ( $res === true ) {
1619 $context = $form->getContext();
1622 if ( $res === 'eauth' ) {
1623 $urlOptions['eauth'] = 1;
1626 $urlOptions +
= $form->getExtraSuccessRedirectParameters();
1628 $url = $form->getTitle()->getFullURL( $urlOptions );
1630 // Set session data for the success message
1631 $context->getRequest()->getSession()->set( 'specialPreferencesSaveSuccess', 1 );
1633 $context->getOutput()->redirect( $url );
1636 return ( $res === true ? Status
::newGood() : $res );
1640 * Get a list of all time zones
1641 * @param Language $language Language used for the localized names
1642 * @return array A list of all time zones. The system name of the time zone is used as key and
1643 * the value is an array which contains localized name, the timecorrection value used for
1644 * preferences and the region
1647 protected function getTimeZoneList( Language
$language ) {
1648 $identifiers = DateTimeZone
::listIdentifiers();
1649 if ( $identifiers === false ) {
1652 sort( $identifiers );
1655 'Africa' => wfMessage( 'timezoneregion-africa' )->inLanguage( $language )->text(),
1656 'America' => wfMessage( 'timezoneregion-america' )->inLanguage( $language )->text(),
1657 'Antarctica' => wfMessage( 'timezoneregion-antarctica' )->inLanguage( $language )->text(),
1658 'Arctic' => wfMessage( 'timezoneregion-arctic' )->inLanguage( $language )->text(),
1659 'Asia' => wfMessage( 'timezoneregion-asia' )->inLanguage( $language )->text(),
1660 'Atlantic' => wfMessage( 'timezoneregion-atlantic' )->inLanguage( $language )->text(),
1661 'Australia' => wfMessage( 'timezoneregion-australia' )->inLanguage( $language )->text(),
1662 'Europe' => wfMessage( 'timezoneregion-europe' )->inLanguage( $language )->text(),
1663 'Indian' => wfMessage( 'timezoneregion-indian' )->inLanguage( $language )->text(),
1664 'Pacific' => wfMessage( 'timezoneregion-pacific' )->inLanguage( $language )->text(),
1666 asort( $tzRegions );
1670 $now = new DateTime();
1672 foreach ( $identifiers as $identifier ) {
1673 $parts = explode( '/', $identifier, 2 );
1675 // DateTimeZone::listIdentifiers() returns a number of
1676 // backwards-compatibility entries. This filters them out of the
1677 // list presented to the user.
1678 if ( count( $parts ) !== 2 ||
!array_key_exists( $parts[0], $tzRegions ) ) {
1683 $parts[0] = $tzRegions[$parts[0]];
1685 $dateTimeZone = new DateTimeZone( $identifier );
1686 $minDiff = floor( $dateTimeZone->getOffset( $now ) / 60 );
1688 $display = str_replace( '_', ' ', $parts[0] . '/' . $parts[1] );
1689 $value = "ZoneInfo|$minDiff|$identifier";
1691 $timeZoneList[$identifier] = [
1693 'timecorrection' => $value,
1694 'region' => $parts[0],
1698 return $timeZoneList;