4 * We're now using the HTMLForm object with some customisation to generate the
5 * Preferences form. This object handles generic submission, CSRF protection,
6 * layout and other logic in a reusable manner. We subclass it as a PreferencesForm
7 * to make some minor customisations.
9 * In order to generate the form, the HTMLForm object needs an array structure
10 * detailing the form fields available, and that's what this class is for. Each
11 * element of the array is a basic property-list, including the type of field,
12 * the label it is to be given in the form, callbacks for validation and
13 * 'filtering', and other pertinent information. Note that the 'default' field
14 * is named for generic forms, and does not represent the preference's default
15 * (which is stored in $wgDefaultUserOptions), but the default for the form
16 * field, which should be whatever the user has set for that preference. There
17 * is no need to override it unless you have some special storage logic (for
18 * instance, those not presently stored as options, but which are best set from
19 * the user preferences view).
21 * Field types are implemented as subclasses of the generic HTMLFormField
22 * object, and typically implement at least getInputHTML, which generates the
23 * HTML for the input field to be placed in the table.
25 * Once fields have been retrieved and validated, submission logic is handed
26 * over to the tryUISubmit static method of this class.
29 static $defaultPreferences = null;
32 'timecorrection' => array( 'Preferences', 'filterTimezoneInput' ),
35 static function getPreferences( $user ) {
36 if ( self
::$defaultPreferences )
37 return self
::$defaultPreferences;
41 $defaultPreferences = array();
43 self
::profilePreferences( $user, $defaultPreferences );
44 self
::skinPreferences( $user, $defaultPreferences );
45 self
::filesPreferences( $user, $defaultPreferences );
46 self
::mathPreferences( $user, $defaultPreferences );
47 self
::datetimePreferences( $user, $defaultPreferences );
48 self
::renderingPreferences( $user, $defaultPreferences );
49 self
::editingPreferences( $user, $defaultPreferences );
50 self
::rcPreferences( $user, $defaultPreferences );
51 self
::watchlistPreferences( $user, $defaultPreferences );
52 self
::searchPreferences( $user, $defaultPreferences );
53 self
::miscPreferences( $user, $defaultPreferences );
55 wfRunHooks( 'GetPreferences', array( $user, &$defaultPreferences ) );
57 ## Remove preferences that wikis don't want to use
58 global $wgHiddenPrefs;
59 foreach ( $wgHiddenPrefs as $pref ) {
60 if ( isset( $defaultPreferences[$pref] ) ) {
61 unset( $defaultPreferences[$pref] );
65 ## Prod in defaults from the user
66 global $wgDefaultUserOptions;
67 foreach( $defaultPreferences as $name => &$info ) {
68 $prefFromUser = self
::getOptionFromUser( $name, $info, $user );
69 $field = HTMLForm
::loadInputFromParameters( $info ); // For validation
70 $defaultOptions = User
::getDefaultOptions();
71 $globalDefault = isset( $defaultOptions[$name] )
72 ?
$defaultOptions[$name]
75 // If it validates, set it as the default
76 if ( isset( $info['default'] ) ) {
77 // Already set, no problem
79 } elseif ( !is_null( $prefFromUser ) && // Make sure we're not just pulling nothing
80 $field->validate( $prefFromUser, $user->mOptions
) === true ) {
81 $info['default'] = $prefFromUser;
82 } elseif( $field->validate( $globalDefault, $user->mOptions
) === true ) {
83 $info['default'] = $globalDefault;
85 throw new MWException( "Global default '$globalDefault' is invalid for field $name" );
89 self
::$defaultPreferences = $defaultPreferences;
91 return $defaultPreferences;
94 // Pull option from a user account. Handles stuff like array-type preferences.
95 static function getOptionFromUser( $name, $info, $user ) {
96 $val = $user->getOption( $name );
98 // Handling for array-type preferences
99 if ( ( isset( $info['type'] ) && $info['type'] == 'multiselect' ) ||
100 ( isset( $info['class'] ) && $info['class'] == 'HTMLMultiSelectField' ) ) {
102 $options = HTMLFormField
::flattenOptions( $info['options'] );
103 $prefix = isset( $info['prefix'] ) ?
$info['prefix'] : $name;
106 foreach( $options as $label => $value ) {
107 if( $user->getOption( "$prefix$value" ) ) {
116 static function profilePreferences( $user, &$defaultPreferences ) {
118 ## User info #####################################
120 $defaultPreferences['username'] =
123 'label-message' => 'username',
124 'default' => $user->getName(),
125 'section' => 'personal/info',
128 $defaultPreferences['userid'] =
131 'label-message' => 'uid',
132 'default' => $user->getId(),
133 'section' => 'personal/info',
136 # Get groups to which the user belongs
137 $userEffectiveGroups = $user->getEffectiveGroups();
138 $userGroups = $userMembers = array();
139 foreach( $userEffectiveGroups as $ueg ) {
141 // Skip the default * group, seems useless here
144 $groupName = User
::getGroupName( $ueg );
145 $userGroups[] = User
::makeGroupLinkHTML( $ueg, $groupName );
147 $memberName = User
::getGroupMember( $ueg );
148 $userMembers[] = User
::makeGroupLinkHTML( $ueg, $memberName );
150 asort( $userGroups );
151 asort( $userMembers );
153 $defaultPreferences['usergroups'] =
156 'label' => wfMsgExt( 'prefs-memberingroups', 'parseinline',
157 $wgLang->formatNum( count($userGroups) ) ),
158 'default' => wfMsgExt( 'prefs-memberingroups-type', array(),
159 $wgLang->commaList( $userGroups ),
160 $wgLang->commaList( $userMembers )
163 'section' => 'personal/info',
166 $defaultPreferences['editcount'] =
169 'label-message' => 'prefs-edits',
170 'default' => $wgLang->formatNum( $user->getEditCount() ),
171 'section' => 'personal/info',
174 if( $user->getRegistration() ) {
175 $defaultPreferences['registrationdate'] =
178 'label-message' => 'prefs-registration',
179 'default' => wfMsgExt( 'prefs-registration-date-time', 'parsemag',
180 $wgLang->timeanddate( $user->getRegistration(), true ),
181 $wgLang->date( $user->getRegistration(), true ),
182 $wgLang->time( $user->getRegistration(), true ) ),
183 'section' => 'personal/info',
187 // Actually changeable stuff
189 $defaultPreferences['realname'] =
191 'type' => $wgAuth->allowPropChange( 'realname' ) ?
'text' : 'info',
192 'default' => $user->getRealName(),
193 'section' => 'personal/info',
194 'label-message' => 'yourrealname',
195 'help-message' => 'prefs-help-realname',
198 $defaultPreferences['gender'] =
201 'section' => 'personal/info',
203 wfMsg( 'gender-male' ) => 'male',
204 wfMsg( 'gender-female' ) => 'female',
205 wfMsg( 'gender-unknown' ) => 'unknown',
207 'label-message' => 'yourgender',
208 'help-message' => 'prefs-help-gender',
211 if( $wgAuth->allowPasswordChange() ) {
212 global $wgUser; // For skin.
213 $link = $wgUser->getSkin()->link( SpecialPage
::getTitleFor( 'Resetpass' ),
214 wfMsgHtml( 'prefs-resetpass' ), array(),
215 array( 'returnto' => SpecialPage
::getTitleFor( 'Preferences' ) ) );
217 $defaultPreferences['password'] =
222 'label-message' => 'yourpassword',
223 'section' => 'personal/info',
227 $defaultPreferences['rememberpassword'] =
230 'label-message' => 'tog-rememberpassword',
231 'section' => 'personal/info',
235 global $wgContLanguageCode;
236 $languages = array_reverse( Language
::getLanguageNames( false ) );
237 if( !array_key_exists( $wgContLanguageCode, $languages ) ) {
238 $languages[$wgContLanguageCode] = $wgContLanguageCode;
243 foreach( $languages as $code => $name ) {
244 $display = wfBCP47( $code ) . ' - ' . $name;
245 $options[$display] = $code;
247 $defaultPreferences['language'] =
250 'section' => 'personal/i18n',
251 'options' => $options,
252 'label-message' => 'yourlanguage',
255 global $wgContLang, $wgDisableLangConversion;
256 global $wgDisableTitleConversion;
257 /* see if there are multiple language variants to choose from*/
258 $variantArray = array();
259 if( !$wgDisableLangConversion ) {
260 $variants = $wgContLang->getVariants();
262 $languages = Language
::getLanguageNames( true );
263 foreach( $variants as $v ) {
264 $v = str_replace( '_', '-', strtolower( $v ) );
265 if( array_key_exists( $v, $languages ) ) {
266 // If it doesn't have a name, we'll pretend it doesn't exist
267 $variantArray[$v] = $languages[$v];
272 foreach( $variantArray as $code => $name ) {
273 $display = wfBCP47( $code ) . ' - ' . $name;
274 $options[$display] = $code;
277 if( count( $variantArray ) > 1 ) {
278 $defaultPreferences['variant'] =
280 'label-message' => 'yourvariant',
282 'options' => $options,
283 'section' => 'personal/i18n',
288 if( count( $variantArray ) > 1 && !$wgDisableLangConversion && !$wgDisableTitleConversion ) {
289 $defaultPreferences['noconvertlink'] =
292 'section' => 'personal/i18n',
293 'label-message' => 'tog-noconvertlink',
297 global $wgMaxSigChars, $wgOut, $wgParser;
299 // show a preview of the old signature first
300 $oldsigWikiText = $wgParser->preSaveTransform( "~~~", new Title
, $user, new ParserOptions
);
301 $oldsigHTML = $wgOut->parseInline( $oldsigWikiText );
302 $defaultPreferences['oldsig'] =
306 'label-message' => 'tog-oldsig',
307 'default' => $oldsigHTML,
308 'section' => 'personal/signature',
310 $defaultPreferences['nickname'] =
312 'type' => $wgAuth->allowPropChange( 'nickname' ) ?
'text' : 'info',
313 'maxlength' => $wgMaxSigChars,
314 'label-message' => 'yournick',
315 'validation-callback' =>
316 array( 'Preferences', 'validateSignature' ),
317 'section' => 'personal/signature',
318 'filter-callback' => array( 'Preferences', 'cleanSignature' ),
320 $defaultPreferences['fancysig'] =
323 'label-message' => 'tog-fancysig',
324 'help-message' => 'prefs-help-signature', // show general help about signature at the bottom of the section
325 'section' => 'personal/signature'
330 global $wgEnableEmail;
331 if ($wgEnableEmail) {
333 global $wgEmailConfirmToEdit;
335 $defaultPreferences['emailaddress'] =
337 'type' => $wgAuth->allowPropChange( 'emailaddress' ) ?
'email' : 'info',
338 'default' => $user->getEmail(),
339 'section' => 'personal/email',
340 'label-message' => 'youremail',
341 'help-message' => $wgEmailConfirmToEdit
342 ?
'prefs-help-email-required'
343 : 'prefs-help-email',
344 'validation-callback' => array( 'Preferences', 'validateEmail' ),
347 global $wgEnableUserEmail, $wgEmailAuthentication;
349 $disableEmailPrefs = false;
351 if ( $wgEmailAuthentication ) {
352 if ( $user->getEmail() ) {
353 if( $user->getEmailAuthenticationTimestamp() ) {
354 // date and time are separate parameters to facilitate localisation.
355 // $time is kept for backward compat reasons.
356 // 'emailauthenticated' is also used in SpecialConfirmemail.php
357 $time = $wgLang->timeAndDate( $user->getEmailAuthenticationTimestamp(), true );
358 $d = $wgLang->date( $user->getEmailAuthenticationTimestamp(), true );
359 $t = $wgLang->time( $user->getEmailAuthenticationTimestamp(), true );
360 $emailauthenticated = wfMsgExt( 'emailauthenticated', 'parseinline',
361 array($time, $d, $t ) ) . '<br />';
362 $disableEmailPrefs = false;
364 $disableEmailPrefs = true;
365 global $wgUser; // wgUser is okay here, it's for display
366 $skin = $wgUser->getSkin();
367 $emailauthenticated = wfMsgExt( 'emailnotauthenticated', 'parseinline' ) . '<br />' .
369 SpecialPage
::getTitleFor( 'Confirmemail' ),
370 wfMsg( 'emailconfirmlink' ),
373 array( 'known', 'noclasses' )
377 $disableEmailPrefs = true;
378 $emailauthenticated = wfMsgHtml( 'noemailprefs' );
381 $defaultPreferences['emailauthentication'] =
385 'section' => 'personal/email',
386 'label-message' => 'prefs-emailconfirm-label',
387 'default' => $emailauthenticated,
392 if( $wgEnableUserEmail && $user->isAllowed( 'sendemail' ) ) {
393 $defaultPreferences['disablemail'] =
397 'section' => 'personal/email',
398 'label-message' => 'allowemail',
399 'disabled' => $disableEmailPrefs,
401 $defaultPreferences['ccmeonemails'] =
404 'section' => 'personal/email',
405 'label-message' => 'tog-ccmeonemails',
406 'disabled' => $disableEmailPrefs,
410 global $wgEnotifWatchlist;
411 if ( $wgEnotifWatchlist ) {
412 $defaultPreferences['enotifwatchlistpages'] =
415 'section' => 'personal/email',
416 'label-message' => 'tog-enotifwatchlistpages',
417 'disabled' => $disableEmailPrefs,
420 global $wgEnotifUserTalk;
421 if( $wgEnotifUserTalk ) {
422 $defaultPreferences['enotifusertalkpages'] =
425 'section' => 'personal/email',
426 'label-message' => 'tog-enotifusertalkpages',
427 'disabled' => $disableEmailPrefs,
430 if( $wgEnotifUserTalk ||
$wgEnotifWatchlist ) {
431 $defaultPreferences['enotifminoredits'] =
434 'section' => 'personal/email',
435 'label-message' => 'tog-enotifminoredits',
436 'disabled' => $disableEmailPrefs,
439 $defaultPreferences['enotifrevealaddr'] =
442 'section' => 'personal/email',
443 'label-message' => 'tog-enotifrevealaddr',
444 'disabled' => $disableEmailPrefs,
449 static function skinPreferences( $user, &$defaultPreferences ) {
450 ## Skin #####################################
451 $defaultPreferences['skin'] =
454 'options' => self
::generateSkinOptions( $user ),
456 'section' => 'rendering/skin',
459 $selectedSkin = $user->getOption( 'skin' );
460 if ( in_array( $selectedSkin, array( 'cologneblue', 'standard' ) ) ) {
462 $settings = array_flip( $wgLang->getQuickbarSettings() );
464 $defaultPreferences['quickbar'] =
467 'options' => $settings,
468 'section' => 'rendering/skin',
469 'label-message' => 'qbsettings',
474 static function mathPreferences( $user, &$defaultPreferences ) {
475 ## Math #####################################
476 global $wgUseTeX, $wgLang;
478 $defaultPreferences['math'] =
482 array_flip( array_map( 'wfMsgHtml', $wgLang->getMathNames() ) ),
484 'section' => 'rendering/math',
489 static function filesPreferences( $user, &$defaultPreferences ) {
490 ## Files #####################################
491 $defaultPreferences['imagesize'] =
494 'options' => self
::getImageSizes(),
495 'label-message' => 'imagemaxsize',
496 'section' => 'rendering/files',
498 $defaultPreferences['thumbsize'] =
501 'options' => self
::getThumbSizes(),
502 'label-message' => 'thumbsize',
503 'section' => 'rendering/files',
507 static function datetimePreferences( $user, &$defaultPreferences ) {
510 ## Date and time #####################################
511 $dateOptions = self
::getDateOptions();
513 $defaultPreferences['date'] =
516 'options' => $dateOptions,
518 'section' => 'datetime/dateformat',
523 $nowlocal = Xml
::element( 'span', array( 'id' => 'wpLocalTime' ),
524 $wgLang->time( $now = wfTimestampNow(), true ) );
525 $nowserver = $wgLang->time( $now, false ) .
526 Xml
::hidden( 'wpServerTime', substr( $now, 8, 2 ) * 60 +
substr( $now, 10, 2 ) );
528 $defaultPreferences['nowserver'] =
532 'label-message' => 'servertime',
533 'default' => $nowserver,
534 'section' => 'datetime/timeoffset',
537 $defaultPreferences['nowlocal'] =
541 'label-message' => 'localtime',
542 'default' => $nowlocal,
543 'section' => 'datetime/timeoffset',
546 // Grab existing pref.
547 $tzOffset = $user->getOption( 'timecorrection' );
548 $tz = explode( '|', $tzOffset, 2 );
550 $tzSetting = $tzOffset;
551 if( count( $tz ) > 1 && $tz[0] == 'Offset' ) {
553 $tzSetting = sprintf( '%+03d:%02d', floor( $minDiff/60 ), abs( $minDiff )%60
);
556 $defaultPreferences['timecorrection'] =
558 'class' => 'HTMLSelectOrOtherField',
559 'label-message' => 'timezonelegend',
560 'options' => self
::getTimezoneOptions(),
561 'default' => $tzSetting,
563 'section' => 'datetime/timeoffset',
567 static function renderingPreferences( $user, &$defaultPreferences ) {
568 ## Page Rendering ##############################
569 $defaultPreferences['underline'] =
573 wfMsg( 'underline-never' ) => 0,
574 wfMsg( 'underline-always' ) => 1,
575 wfMsg( 'underline-default' ) => 2,
577 'label-message' => 'tog-underline',
578 'section' => 'rendering/advancedrendering',
581 $stubThresholdValues = array( 0, 50, 100, 500, 1000, 2000, 5000, 10000 );
582 $stubThresholdOptions = array();
583 foreach( $stubThresholdValues as $value ) {
584 $stubThresholdOptions[wfMsg( 'size-bytes', $value )] = $value;
587 $defaultPreferences['stubthreshold'] =
589 'type' => 'selectorother',
590 'section' => 'rendering/advancedrendering',
591 'options' => $stubThresholdOptions,
593 'label' => wfMsg( 'stub-threshold' ), // Raw HTML message. Yay?
595 $defaultPreferences['highlightbroken'] =
598 'section' => 'rendering/advancedrendering',
599 'label' => wfMsg( 'tog-highlightbroken' ), // Raw HTML
601 $defaultPreferences['showtoc'] =
604 'section' => 'rendering/advancedrendering',
605 'label-message' => 'tog-showtoc',
607 $defaultPreferences['nocache'] =
610 'label-message' => 'tog-nocache',
611 'section' => 'rendering/advancedrendering',
613 $defaultPreferences['showhiddencats'] =
616 'section' => 'rendering/advancedrendering',
617 'label-message' => 'tog-showhiddencats'
619 $defaultPreferences['showjumplinks'] =
622 'section' => 'rendering/advancedrendering',
623 'label-message' => 'tog-showjumplinks',
625 $defaultPreferences['justify'] =
628 'section' => 'rendering/advancedrendering',
629 'label-message' => 'tog-justify',
631 $defaultPreferences['numberheadings'] =
634 'section' => 'rendering/advancedrendering',
635 'label-message' => 'tog-numberheadings',
639 static function editingPreferences( $user, &$defaultPreferences ) {
640 global $wgUseExternalEditor, $wgLivePreview;
642 ## Editing #####################################
643 $defaultPreferences['cols'] =
646 'label-message' => 'columns',
647 'section' => 'editing/textboxsize',
651 $defaultPreferences['rows'] =
654 'label-message' => 'rows',
655 'section' => 'editing/textboxsize',
660 $defaultPreferences['editfont'] =
663 'section' => 'editing/advancedediting',
664 'label-message' => 'editfont-style',
666 wfMsg( 'editfont-default' ) => 'default',
667 wfMsg( 'editfont-monospace' ) => 'monospace',
668 wfMsg( 'editfont-sansserif' ) => 'sans-serif',
669 wfMsg( 'editfont-serif' ) => 'serif',
672 $defaultPreferences['previewontop'] =
675 'section' => 'editing/advancedediting',
676 'label-message' => 'tog-previewontop',
678 $defaultPreferences['previewonfirst'] =
681 'section' => 'editing/advancedediting',
682 'label-message' => 'tog-previewonfirst',
684 $defaultPreferences['editsection'] =
687 'section' => 'editing/advancedediting',
688 'label-message' => 'tog-editsection',
690 $defaultPreferences['editsectiononrightclick'] =
693 'section' => 'editing/advancedediting',
694 'label-message' => 'tog-editsectiononrightclick',
696 $defaultPreferences['editondblclick'] =
699 'section' => 'editing/advancedediting',
700 'label-message' => 'tog-editondblclick',
702 $defaultPreferences['editwidth'] =
705 'section' => 'editing/advancedediting',
706 'label-message' => 'tog-editwidth',
708 $defaultPreferences['showtoolbar'] =
711 'section' => 'editing/advancedediting',
712 'label-message' => 'tog-showtoolbar',
714 $defaultPreferences['minordefault'] =
717 'section' => 'editing/advancedediting',
718 'label-message' => 'tog-minordefault',
721 if ( $wgUseExternalEditor ) {
722 $defaultPreferences['externaleditor'] =
725 'section' => 'editing/advancedediting',
726 'label-message' => 'tog-externaleditor',
728 $defaultPreferences['externaldiff'] =
731 'section' => 'editing/advancedediting',
732 'label-message' => 'tog-externaldiff',
736 $defaultPreferences['forceeditsummary'] =
739 'section' => 'editing/advancedediting',
740 'label-message' => 'tog-forceeditsummary',
742 if ( $wgLivePreview ) {
743 $defaultPreferences['uselivepreview'] =
746 'section' => 'editing/advancedediting',
747 'label-message' => 'tog-uselivepreview',
752 static function rcPreferences( $user, &$defaultPreferences ) {
753 global $wgRCMaxAge, $wgUseRCPatrol, $wgLang;
754 ## RecentChanges #####################################
755 $defaultPreferences['rcdays'] =
758 'label-message' => 'recentchangesdays',
759 'section' => 'rc/display',
761 'max' => ceil( $wgRCMaxAge / ( 3600*24 ) ),
762 'help' => wfMsgExt( 'recentchangesdays-max', array( 'parsemag' ), $wgLang->formatNum( ceil( $wgRCMaxAge / ( 3600*24 ) ) ) ),
764 $defaultPreferences['rclimit'] =
767 'label-message' => 'recentchangescount',
768 'help-message' => 'prefs-help-recentchangescount',
769 'section' => 'rc/display',
771 $defaultPreferences['usenewrc'] =
774 'label-message' => 'tog-usenewrc',
775 'section' => 'rc/advancedrc',
777 $defaultPreferences['hideminor'] =
780 'label-message' => 'tog-hideminor',
781 'section' => 'rc/advancedrc',
784 global $wgUseRCPatrol;
785 if( $wgUseRCPatrol ) {
786 $defaultPreferences['hidepatrolled'] =
789 'section' => 'rc/advancedrc',
790 'label-message' => 'tog-hidepatrolled',
792 $defaultPreferences['newpageshidepatrolled'] =
795 'section' => 'rc/advancedrc',
796 'label-message' => 'tog-newpageshidepatrolled',
800 global $wgRCShowWatchingUsers;
801 if( $wgRCShowWatchingUsers ) {
802 $defaultPreferences['shownumberswatching'] =
805 'section' => 'rc/advancedrc',
806 'label-message' => 'tog-shownumberswatching',
811 static function watchlistPreferences( $user, &$defaultPreferences ) {
812 global $wgUseRCPatrol, $wgEnableAPI;
813 ## Watchlist #####################################
814 $defaultPreferences['watchlistdays'] =
819 'section' => 'watchlist/display',
820 'help' => wfMsgHtml( 'prefs-watchlist-days-max' ),
821 'label-message' => 'prefs-watchlist-days',
823 $defaultPreferences['wllimit'] =
828 'label-message' => 'prefs-watchlist-edits',
829 'help' => wfMsgHtml( 'prefs-watchlist-edits-max' ),
830 'section' => 'watchlist/display',
832 $defaultPreferences['extendwatchlist'] =
835 'section' => 'watchlist/advancedwatchlist',
836 'label-message' => 'tog-extendwatchlist',
838 $defaultPreferences['watchlisthideminor'] =
841 'section' => 'watchlist/advancedwatchlist',
842 'label-message' => 'tog-watchlisthideminor',
844 $defaultPreferences['watchlisthidebots'] =
847 'section' => 'watchlist/advancedwatchlist',
848 'label-message' => 'tog-watchlisthidebots',
850 $defaultPreferences['watchlisthideown'] =
853 'section' => 'watchlist/advancedwatchlist',
854 'label-message' => 'tog-watchlisthideown',
856 $defaultPreferences['watchlisthideanons'] =
859 'section' => 'watchlist/advancedwatchlist',
860 'label-message' => 'tog-watchlisthideanons',
862 $defaultPreferences['watchlisthideliu'] =
865 'section' => 'watchlist/advancedwatchlist',
866 'label-message' => 'tog-watchlisthideliu',
868 if ( $wgEnableAPI ) {
869 # Some random gibberish as a proposed default
870 $hash = sha1( mt_rand() . microtime( true ) );
871 $defaultPreferences['watchlisttoken'] =
874 'section' => 'watchlist/advancedwatchlist',
875 'label-message' => 'prefs-watchlist-token',
876 'help' => wfMsgHtml( 'prefs-help-watchlist-token', $hash )
880 if ( $wgUseRCPatrol ) {
881 $defaultPreferences['watchlisthidepatrolled'] =
884 'section' => 'watchlist/advancedwatchlist',
885 'label-message' => 'tog-watchlisthidepatrolled',
890 'edit' => 'watchdefault',
891 'move' => 'watchmoves',
892 'delete' => 'watchdeletion'
896 if( $user->isAllowed( 'createpage' ) ||
$user->isAllowed( 'createtalk' ) ) {
897 $watchTypes['read'] = 'watchcreations';
900 foreach( $watchTypes as $action => $pref ) {
901 if ( $user->isAllowed( $action ) ) {
902 $defaultPreferences[$pref] = array(
904 'section' => 'watchlist/advancedwatchlist',
905 'label-message' => "tog-$pref",
911 static function searchPreferences( $user, &$defaultPreferences ) {
914 ## Search #####################################
915 $defaultPreferences['searchlimit'] =
918 'label-message' => 'resultsperpage',
919 'section' => 'searchoptions/display',
922 $defaultPreferences['contextlines'] =
925 'label-message' => 'contextlines',
926 'section' => 'searchoptions/display',
929 $defaultPreferences['contextchars'] =
932 'label-message' => 'contextchars',
933 'section' => 'searchoptions/display',
936 global $wgEnableMWSuggest;
937 if( $wgEnableMWSuggest ) {
938 $defaultPreferences['disablesuggest'] =
941 'label-message' => 'mwsuggest-disable',
942 'section' => 'searchoptions/display',
946 $defaultPreferences['searcheverything'] =
949 'label-message' => 'searcheverything-enable',
950 'section' => 'searchoptions/advancedsearchoptions',
953 // Searchable namespaces back-compat with old format
954 $searchableNamespaces = SearchEngine
::searchableNamespaces();
956 $nsOptions = array();
957 foreach( $wgContLang->getNamespaces() as $ns => $name ) {
958 if( $ns < 0 ) continue;
959 $displayNs = str_replace( '_', ' ', $name );
961 if( !$displayNs ) $displayNs = wfMsg( 'blanknamespace' );
963 $displayNs = htmlspecialchars( $displayNs );
964 $nsOptions[$displayNs] = $ns;
967 $defaultPreferences['searchnamespaces'] =
969 'type' => 'multiselect',
970 'label-message' => 'defaultns',
971 'options' => $nsOptions,
972 'section' => 'searchoptions/advancedsearchoptions',
973 'prefix' => 'searchNs',
977 static function miscPreferences( $user, &$defaultPreferences ) {
978 ## Misc #####################################
979 $defaultPreferences['diffonly'] =
982 'section' => 'misc/diffs',
983 'label-message' => 'tog-diffonly',
985 $defaultPreferences['norollbackdiff'] =
988 'section' => 'misc/diffs',
989 'label-message' => 'tog-norollbackdiff',
992 // Stuff from Language::getExtraUserToggles()
995 $toggles = $wgContLang->getExtraUserToggles();
997 foreach( $toggles as $toggle ) {
998 $defaultPreferences[$toggle] =
1001 'section' => 'personal/i18n',
1002 'label-message' => "tog-$toggle",
1008 * @param object $user The user object
1009 * @return array Text/links to display as key; $skinkey as value
1011 static function generateSkinOptions( $user ) {
1012 global $wgDefaultSkin, $wgLang, $wgAllowUserCss, $wgAllowUserJs;
1015 $mptitle = Title
::newMainPage();
1016 $previewtext = wfMsgHtml( 'skin-preview' );
1017 # Only show members of Skin::getSkinNames() rather than
1018 # $skinNames (skins is all skin names from Language.php)
1019 $validSkinNames = Skin
::getUsableSkins();
1020 # Sort by UI skin name. First though need to update validSkinNames as sometimes
1021 # the skinkey & UI skinname differ (e.g. "standard" skinkey is "Classic" in the UI).
1022 foreach ( $validSkinNames as $skinkey => &$skinname ) {
1023 $msgName = "skinname-{$skinkey}";
1024 $localisedSkinName = wfMsg( $msgName );
1025 if ( !wfEmptyMsg( $msgName, $localisedSkinName ) ) {
1026 $skinname = htmlspecialchars( $localisedSkinName );
1029 asort( $validSkinNames );
1030 $sk = $user->getSkin();
1032 foreach( $validSkinNames as $skinkey => $sn ) {
1033 $linkTools = array();
1035 # Mark the default skin
1036 if( $skinkey == $wgDefaultSkin ) {
1037 $linkTools[] = wfMsgHtml( 'default' );
1040 # Create preview link
1041 $mplink = htmlspecialchars( $mptitle->getLocalURL( "useskin=$skinkey" ) );
1042 $linkTools[] = "<a target='_blank' href=\"$mplink\">$previewtext</a>";
1044 # Create links to user CSS/JS pages
1045 if( $wgAllowUserCss ) {
1046 $cssPage = Title
::makeTitleSafe( NS_USER
, $user->getName() . '/' . $skinkey . '.css' );
1047 $linkTools[] = $sk->link( $cssPage, wfMsgHtml( 'prefs-custom-css' ) );
1049 if( $wgAllowUserJs ) {
1050 $jsPage = Title
::makeTitleSafe( NS_USER
, $user->getName() . '/' . $skinkey . '.js' );
1051 $linkTools[] = $sk->link( $jsPage, wfMsgHtml( 'prefs-custom-js' ) );
1054 $display = $sn . ' ' . wfMsg( 'parentheses', $wgLang->pipeList( $linkTools ) );
1055 $ret[$display] = $skinkey;
1061 static function getDateOptions() {
1063 $dateopts = $wgLang->getDatePreferences();
1068 if ( !in_array( 'default', $dateopts ) ) {
1069 $dateopts[] = 'default'; // Make sure default is always valid
1074 $epoch = '20010115161234'; # Wikipedia day
1075 foreach( $dateopts as $key ) {
1076 if( $key == 'default' ) {
1077 $formatted = wfMsgHtml( 'datedefault' );
1079 $formatted = htmlspecialchars( $wgLang->timeanddate( $epoch, false, $key ) );
1081 $ret[$formatted] = $key;
1087 static function getImageSizes() {
1088 global $wgImageLimits;
1092 foreach ( $wgImageLimits as $index => $limits ) {
1093 $display = "{$limits[0]}×{$limits[1]}" . wfMsg( 'unit-pixel' );
1094 $ret[$display] = $index;
1100 static function getThumbSizes() {
1101 global $wgThumbLimits;
1105 foreach ( $wgThumbLimits as $index => $size ) {
1106 $display = $size . wfMsg( 'unit-pixel' );
1107 $ret[$display] = $index;
1113 static function validateSignature( $signature, $alldata ) {
1114 global $wgParser, $wgMaxSigChars, $wgLang;
1115 if( mb_strlen( $signature ) > $wgMaxSigChars ) {
1117 Xml
::element( 'span', array( 'class' => 'error' ),
1118 wfMsgExt( 'badsiglength', 'parsemag',
1119 $wgLang->formatNum( $wgMaxSigChars )
1122 } elseif( !empty( $alldata['fancysig'] ) &&
1123 false === $wgParser->validateSig( $signature ) ) {
1124 return Xml
::element( 'span', array( 'class' => 'error' ), wfMsg( 'badsig' ) );
1130 static function cleanSignature( $signature, $alldata ) {
1132 if( $alldata['fancysig'] ) {
1133 $signature = $wgParser->cleanSig( $signature );
1135 // When no fancy sig used, make sure ~{3,5} get removed.
1136 $signature = $wgParser->cleanSigInSig( $signature );
1142 static function validateEmail( $email, $alldata ) {
1143 if ( $email && !User
::isValidEmailAddr( $email ) ) {
1144 return wfMsgExt( 'invalidemailaddress', 'parseinline' );
1147 global $wgEmailConfirmToEdit;
1148 if( $wgEmailConfirmToEdit && !$email ) {
1149 return wfMsgExt( 'noemailtitle', 'parseinline' );
1154 static function getFormObject( $user ) {
1155 $formDescriptor = Preferences
::getPreferences( $user );
1156 $htmlForm = new PreferencesForm( $formDescriptor, 'prefs' );
1158 $htmlForm->setSubmitText( wfMsg( 'saveprefs' ) );
1159 $htmlForm->setTitle( SpecialPage
::getTitleFor( 'Preferences' ) );
1160 $htmlForm->setSubmitID( 'prefsubmit' );
1161 $htmlForm->setSubmitCallback( array( 'Preferences', 'tryFormSubmit' ) );
1166 static function getTimezoneOptions() {
1169 global $wgLocalTZoffset;
1171 $opt[wfMsg( 'timezoneuseserverdefault' )] = "System|$wgLocalTZoffset";
1172 $opt[wfMsg( 'timezoneuseoffset' )] = 'other';
1173 $opt[wfMsg( 'guesstimezone' )] = 'guess';
1175 if ( function_exists( 'timezone_identifiers_list' ) ) {
1176 # Read timezone list
1177 $tzs = timezone_identifiers_list();
1180 $tzRegions = array();
1181 $tzRegions['Africa'] = wfMsg( 'timezoneregion-africa' );
1182 $tzRegions['America'] = wfMsg( 'timezoneregion-america' );
1183 $tzRegions['Antarctica'] = wfMsg( 'timezoneregion-antarctica' );
1184 $tzRegions['Arctic'] = wfMsg( 'timezoneregion-arctic' );
1185 $tzRegions['Asia'] = wfMsg( 'timezoneregion-asia' );
1186 $tzRegions['Atlantic'] = wfMsg( 'timezoneregion-atlantic' );
1187 $tzRegions['Australia'] = wfMsg( 'timezoneregion-australia' );
1188 $tzRegions['Europe'] = wfMsg( 'timezoneregion-europe' );
1189 $tzRegions['Indian'] = wfMsg( 'timezoneregion-indian' );
1190 $tzRegions['Pacific'] = wfMsg( 'timezoneregion-pacific' );
1191 asort( $tzRegions );
1193 $prefill = array_fill_keys( array_values( $tzRegions ), array() );
1194 $opt = array_merge( $opt, $prefill );
1196 $now = date_create( 'now' );
1198 foreach ( $tzs as $tz ) {
1199 $z = explode( '/', $tz, 2 );
1201 # timezone_identifiers_list() returns a number of
1202 # backwards-compatibility entries. This filters them out of the
1203 # list presented to the user.
1204 if ( count( $z ) != 2 ||
!array_key_exists( $z[0], $tzRegions ) )
1208 $z[0] = $tzRegions[$z[0]];
1210 $minDiff = floor( timezone_offset_get( timezone_open( $tz ), $now ) / 60 );
1212 $display = str_replace( '_', ' ', $z[0] . '/' . $z[1] );
1213 $value = "ZoneInfo|$minDiff|$tz";
1215 $opt[$z[0]][$display] = $value;
1221 static function filterTimezoneInput( $tz, $alldata ) {
1222 $data = explode( '|', $tz, 3 );
1223 switch ( $data[0] ) {
1228 $data = explode( ':', $tz, 2 );
1230 if( count( $data ) == 2 ) {
1231 $data[0] = intval( $data[0] );
1232 $data[1] = intval( $data[1] );
1233 $minDiff = abs( $data[0] ) * 60 +
$data[1];
1234 if ( $data[0] < 0 ) $minDiff = -$minDiff;
1236 $minDiff = intval( $data[0] ) * 60;
1239 # Max is +14:00 and min is -12:00, see:
1240 # http://en.wikipedia.org/wiki/Timezone
1241 $minDiff = min( $minDiff, 840 ); # 14:00
1242 $minDiff = max( $minDiff, -720 ); # -12:00
1243 return 'Offset|'.$minDiff;
1247 static function tryFormSubmit( $formData, $entryPoint = 'internal' ) {
1248 global $wgUser, $wgEmailAuthentication, $wgEnableEmail;
1253 foreach( array_keys( $formData ) as $name ) {
1254 if ( isset( self
::$saveFilters[$name] ) ) {
1256 call_user_func( self
::$saveFilters[$name], $formData[$name], $formData );
1260 // Stuff that shouldn't be saved as a preference.
1261 $saveBlacklist = array(
1266 if( $wgEnableEmail ) {
1267 $newadr = $formData['emailaddress'];
1268 $oldadr = $wgUser->getEmail();
1269 if( ( $newadr != '' ) && ( $newadr != $oldadr ) ) {
1270 # the user has supplied a new email address on the login page
1271 # new behaviour: set this new emailaddr from login-page into user database record
1272 $wgUser->setEmail( $newadr );
1273 # but flag as "dirty" = unauthenticated
1274 $wgUser->invalidateEmail();
1275 if( $wgEmailAuthentication ) {
1276 # Mail a temporary password to the dirty address.
1277 # User can come back through the confirmation URL to re-enable email.
1278 $result = $wgUser->sendConfirmationMail();
1279 if( WikiError
::isError( $result ) ) {
1280 return wfMsg( 'mailerror', htmlspecialchars( $result->getMessage() ) );
1281 } elseif( $entryPoint == 'ui' ) {
1286 $wgUser->setEmail( $newadr );
1288 if( $oldadr != $newadr ) {
1289 wfRunHooks( 'PrefsEmailAudit', array( $wgUser, $oldadr, $newadr ) );
1293 // Fortunately, the realname field is MUCH simpler
1294 global $wgHiddenPrefs;
1295 if ( !in_array( 'realname', $wgHiddenPrefs ) ) {
1296 $realName = $formData['realname'];
1297 $wgUser->setRealName( $realName );
1300 foreach( $saveBlacklist as $b )
1301 unset( $formData[$b] );
1303 // Keeps old preferences from interfering due to back-compat
1305 $wgUser->resetOptions();
1307 foreach( $formData as $key => $value ) {
1308 $wgUser->setOption( $key, $value );
1311 $wgUser->saveSettings();
1316 public static function tryUISubmit( $formData ) {
1317 $res = self
::tryFormSubmit( $formData, 'ui' );
1320 $urlOptions = array( 'success' );
1321 if( $res === 'eauth' )
1322 $urlOptions[] = 'eauth';
1324 $queryString = implode( '&', $urlOptions );
1326 $url = SpecialPage
::getTitleFor( 'Preferences' )->getFullURL( $queryString );
1328 $wgOut->redirect( $url );
1334 public static function loadOldSearchNs( $user ) {
1335 $searchableNamespaces = SearchEngine
::searchableNamespaces();
1336 // Back compat with old format
1339 foreach( $searchableNamespaces as $ns => $name ) {
1340 if( $user->getOption( 'searchNs' . $ns ) ) {
1349 /** Some tweaks to allow js prefs to work */
1350 class PreferencesForm
extends HTMLForm
{
1352 function wrapForm( $html ) {
1353 $html = Xml
::tags( 'div', array( 'id' => 'preferences' ), $html );
1355 return parent
::wrapForm( $html );
1358 function getButtons() {
1359 $html = parent
::getButtons();
1363 $sk = $wgUser->getSkin();
1364 $t = SpecialPage
::getTitleFor( 'Preferences', 'reset' );
1366 $html .= "\n" . $sk->link( $t, wfMsgHtml( 'restoreprefs' ) );
1368 $html = Xml
::tags( 'div', array( 'class' => 'mw-prefs-buttons' ), $html );
1373 function filterDataForSubmit( $data ) {
1374 // Support for separating MultiSelect preferences into multiple preferences
1375 // Due to lack of array support.
1376 foreach( $this->mFlatFields
as $fieldname => $field ) {
1377 $info = $field->mParams
;
1378 if( $field instanceof HTMLMultiSelectField
) {
1379 $options = HTMLFormField
::flattenOptions( $info['options'] );
1380 $prefix = isset( $info['prefix'] ) ?
$info['prefix'] : $fieldname;
1382 foreach( $options as $opt ) {
1383 $data["$prefix$opt"] = in_array( $opt, $data[$fieldname] );
1386 unset( $data[$fieldname] );