3 * We're now using the HTMLForm object with some customisation to generate the
4 * Preferences form. This object handles generic submission, CSRF protection,
5 * layout and other logic in a reusable manner. We subclass it as a PreferencesForm
6 * to make some minor customisations.
8 * In order to generate the form, the HTMLForm object needs an array structure
9 * detailing the form fields available, and that's what this class is for. Each
10 * element of the array is a basic property-list, including the type of field,
11 * the label it is to be given in the form, callbacks for validation and
12 * 'filtering', and other pertinent information. Note that the 'default' field
13 * is named for generic forms, and does not represent the preference's default
14 * (which is stored in $wgDefaultUserOptions), but the default for the form
15 * field, which should be whatever the user has set for that preference. There
16 * is no need to override it unless you have some special storage logic (for
17 * instance, those not presently stored as options, but which are best set from
18 * the user preferences view).
20 * Field types are implemented as subclasses of the generic HTMLFormField
21 * object, and typically implement at least getInputHTML, which generates the
22 * HTML for the input field to be placed in the table.
24 * Once fields have been retrieved and validated, submission logic is handed
25 * over to the tryUISubmit static method of this class.
29 static $defaultPreferences = null;
30 static $saveFilters = array(
31 'timecorrection' => array( 'Preferences', 'filterTimezoneInput' ),
32 'cols' => array( 'Preferences', 'filterIntval' ),
33 'rows' => array( 'Preferences', 'filterIntval' ),
34 'rclimit' => array( 'Preferences', 'filterIntval' ),
35 'wllimit' => array( 'Preferences', 'filterIntval' ),
36 'searchlimit' => array( 'Preferences', 'filterIntval' ),
39 static function getPreferences( $user ) {
40 if ( self
::$defaultPreferences )
41 return self
::$defaultPreferences;
43 $defaultPreferences = array();
45 self
::profilePreferences( $user, $defaultPreferences );
46 self
::skinPreferences( $user, $defaultPreferences );
47 self
::filesPreferences( $user, $defaultPreferences );
48 self
::mathPreferences( $user, $defaultPreferences );
49 self
::datetimePreferences( $user, $defaultPreferences );
50 self
::renderingPreferences( $user, $defaultPreferences );
51 self
::editingPreferences( $user, $defaultPreferences );
52 self
::rcPreferences( $user, $defaultPreferences );
53 self
::watchlistPreferences( $user, $defaultPreferences );
54 self
::searchPreferences( $user, $defaultPreferences );
55 self
::miscPreferences( $user, $defaultPreferences );
57 wfRunHooks( 'GetPreferences', array( $user, &$defaultPreferences ) );
59 ## Remove preferences that wikis don't want to use
60 global $wgHiddenPrefs;
61 foreach ( $wgHiddenPrefs as $pref ) {
62 if ( isset( $defaultPreferences[$pref] ) ) {
63 unset( $defaultPreferences[$pref] );
67 ## Prod in defaults from the user
68 foreach ( $defaultPreferences as $name => &$info ) {
69 $prefFromUser = self
::getOptionFromUser( $name, $info, $user );
70 $field = HTMLForm
::loadInputFromParameters( $name, $info ); // For validation
71 $defaultOptions = User
::getDefaultOptions();
72 $globalDefault = isset( $defaultOptions[$name] )
73 ?
$defaultOptions[$name]
76 // If it validates, set it as the default
77 if ( isset( $info['default'] ) ) {
78 // Already set, no problem
80 } elseif ( !is_null( $prefFromUser ) && // Make sure we're not just pulling nothing
81 $field->validate( $prefFromUser, $user->mOptions
) === true ) {
82 $info['default'] = $prefFromUser;
83 } elseif ( $field->validate( $globalDefault, $user->mOptions
) === true ) {
84 $info['default'] = $globalDefault;
86 throw new MWException( "Global default '$globalDefault' is invalid for field $name" );
90 self
::$defaultPreferences = $defaultPreferences;
92 return $defaultPreferences;
95 // Pull option from a user account. Handles stuff like array-type preferences.
96 static function getOptionFromUser( $name, $info, $user ) {
97 $val = $user->getOption( $name );
99 // Handling for array-type preferences
100 if ( ( isset( $info['type'] ) && $info['type'] == 'multiselect' ) ||
101 ( isset( $info['class'] ) && $info['class'] == 'HTMLMultiSelectField' ) ) {
102 $options = HTMLFormField
::flattenOptions( $info['options'] );
103 $prefix = isset( $info['prefix'] ) ?
$info['prefix'] : $name;
106 foreach ( $options as $value ) {
107 if ( $user->getOption( "$prefix$value" ) ) {
116 static function profilePreferences( $user, &$defaultPreferences ) {
117 global $wgLang, $wgUser;
118 ## User info #####################################
120 $defaultPreferences['username'] = array(
122 'label-message' => 'username',
123 'default' => $user->getName(),
124 'section' => 'personal/info',
127 $defaultPreferences['userid'] = array(
129 'label-message' => 'uid',
130 'default' => $user->getId(),
131 'section' => 'personal/info',
134 # Get groups to which the user belongs
135 $userEffectiveGroups = $user->getEffectiveGroups();
136 $userGroups = $userMembers = array();
137 foreach ( $userEffectiveGroups as $ueg ) {
139 // Skip the default * group, seems useless here
142 $groupName = User
::getGroupName( $ueg );
143 $userGroups[] = User
::makeGroupLinkHTML( $ueg, $groupName );
145 $memberName = User
::getGroupMember( $ueg );
146 $userMembers[] = User
::makeGroupLinkHTML( $ueg, $memberName );
148 asort( $userGroups );
149 asort( $userMembers );
151 $defaultPreferences['usergroups'] = array(
154 'prefs-memberingroups', 'parseinline',
155 $wgLang->formatNum( count( $userGroups ) )
157 'default' => wfMsgExt(
158 'prefs-memberingroups-type', array(),
159 $wgLang->commaList( $userGroups ),
160 $wgLang->commaList( $userMembers )
163 'section' => 'personal/info',
166 $defaultPreferences['editcount'] = array(
168 'label-message' => 'prefs-edits',
169 'default' => $wgLang->formatNum( $user->getEditCount() ),
170 'section' => 'personal/info',
173 if ( $user->getRegistration() ) {
174 $defaultPreferences['registrationdate'] = array(
176 'label-message' => 'prefs-registration',
177 'default' => wfMsgExt(
178 'prefs-registration-date-time', 'parsemag',
179 $wgLang->timeanddate( $user->getRegistration(), true ),
180 $wgLang->date( $user->getRegistration(), true ),
181 $wgLang->time( $user->getRegistration(), true )
183 'section' => 'personal/info',
187 // Actually changeable stuff
189 $defaultPreferences['realname'] = array(
190 'type' => $wgAuth->allowPropChange( 'realname' ) ?
'text' : 'info',
191 'default' => $user->getRealName(),
192 'section' => 'personal/info',
193 'label-message' => 'yourrealname',
194 'help-message' => 'prefs-help-realname',
197 $defaultPreferences['gender'] = array(
199 'section' => 'personal/info',
201 wfMsg( 'gender-male' ) => 'male',
202 wfMsg( 'gender-female' ) => 'female',
203 wfMsg( 'gender-unknown' ) => 'unknown',
205 'label-message' => 'yourgender',
206 'help-message' => 'prefs-help-gender',
209 if ( $wgAuth->allowPasswordChange() ) {
210 $link = $wgUser->getSkin()->link( SpecialPage
::getTitleFor( 'Resetpass' ),
211 wfMsgHtml( 'prefs-resetpass' ), array(),
212 array( 'returnto' => SpecialPage
::getTitleFor( 'Preferences' ) ) );
214 $defaultPreferences['password'] = array(
218 'label-message' => 'yourpassword',
219 'section' => 'personal/info',
222 global $wgCookieExpiration;
223 if ( $wgCookieExpiration > 0 ) {
224 $defaultPreferences['rememberpassword'] = array(
227 'tog-rememberpassword',
229 $wgLang->formatNum( ceil( $wgCookieExpiration / ( 3600 * 24 ) ) )
231 'section' => 'personal/info',
236 global $wgLanguageCode;
237 $languages = Language
::getLanguageNames( false );
238 if ( !array_key_exists( $wgLanguageCode, $languages ) ) {
239 $languages[$wgLanguageCode] = $wgLanguageCode;
244 foreach ( $languages as $code => $name ) {
245 $display = wfBCP47( $code ) . ' - ' . $name;
246 $options[$display] = $code;
248 $defaultPreferences['language'] = array(
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'] = array(
279 'label-message' => 'yourvariant',
281 'options' => $options,
282 'section' => 'personal/i18n',
287 if ( count( $variantArray ) > 1 && !$wgDisableLangConversion && !$wgDisableTitleConversion ) {
288 $defaultPreferences['noconvertlink'] =
291 'section' => 'personal/i18n',
292 'label-message' => 'tog-noconvertlink',
296 global $wgMaxSigChars, $wgOut, $wgParser;
298 // show a preview of the old signature first
299 $oldsigWikiText = $wgParser->preSaveTransform( "~~~", new Title
, $user, new ParserOptions
);
300 $oldsigHTML = $wgOut->parseInline( $oldsigWikiText );
301 $defaultPreferences['oldsig'] = array(
304 'label-message' => 'tog-oldsig',
305 'default' => $oldsigHTML,
306 'section' => 'personal/signature',
308 $defaultPreferences['nickname'] = array(
309 'type' => $wgAuth->allowPropChange( 'nickname' ) ?
'text' : 'info',
310 'maxlength' => $wgMaxSigChars,
311 'label-message' => 'yournick',
312 'validation-callback' => array( 'Preferences', 'validateSignature' ),
313 'section' => 'personal/signature',
314 'filter-callback' => array( 'Preferences', 'cleanSignature' ),
316 $defaultPreferences['fancysig'] = array(
318 'label-message' => 'tog-fancysig',
319 'help-message' => 'prefs-help-signature', // show general help about signature at the bottom of the section
320 'section' => 'personal/signature'
325 global $wgEnableEmail;
326 if ( $wgEnableEmail ) {
327 global $wgEmailConfirmToEdit;
328 global $wgEnableUserEmail;
330 $helpMessages[] = $wgEmailConfirmToEdit
331 ?
'prefs-help-email-required'
332 : 'prefs-help-email' ;
333 $helpMessages[] = $wgEnableUserEmail
334 ?
'prefs-help-email-others'
337 $defaultPreferences['emailaddress'] = array(
338 'type' => $wgAuth->allowPropChange( 'emailaddress' ) ?
'email' : 'info',
339 'default' => $user->getEmail(),
340 'section' => 'personal/email',
341 'label-message' => 'youremail',
342 'help-messages' => $helpMessages,
343 'validation-callback' => array( 'Preferences', 'validateEmail' ),
346 global $wgEmailAuthentication;
348 $disableEmailPrefs = false;
350 if ( $wgEmailAuthentication ) {
351 if ( $user->getEmail() ) {
352 if ( $user->getEmailAuthenticationTimestamp() ) {
353 // date and time are separate parameters to facilitate localisation.
354 // $time is kept for backward compat reasons.
355 // 'emailauthenticated' is also used in SpecialConfirmemail.php
356 $time = $wgLang->timeAndDate( $user->getEmailAuthenticationTimestamp(), true );
357 $d = $wgLang->date( $user->getEmailAuthenticationTimestamp(), true );
358 $t = $wgLang->time( $user->getEmailAuthenticationTimestamp(), true );
359 $emailauthenticated = wfMsgExt(
360 'emailauthenticated', 'parseinline',
361 array( $time, $d, $t )
363 $disableEmailPrefs = false;
365 $disableEmailPrefs = true;
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'] = array(
384 'section' => 'personal/email',
385 'label-message' => 'prefs-emailconfirm-label',
386 'default' => $emailauthenticated,
391 if ( $wgEnableUserEmail && $user->isAllowed( 'sendemail' ) ) {
392 $defaultPreferences['disablemail'] = array(
395 'section' => 'personal/email',
396 'label-message' => 'allowemail',
397 'disabled' => $disableEmailPrefs,
399 $defaultPreferences['ccmeonemails'] = array(
401 'section' => 'personal/email',
402 'label-message' => 'tog-ccmeonemails',
403 'disabled' => $disableEmailPrefs,
407 global $wgEnotifWatchlist;
408 if ( $wgEnotifWatchlist ) {
409 $defaultPreferences['enotifwatchlistpages'] = array(
411 'section' => 'personal/email',
412 'label-message' => 'tog-enotifwatchlistpages',
413 'disabled' => $disableEmailPrefs,
416 global $wgEnotifUserTalk;
417 if ( $wgEnotifUserTalk ) {
418 $defaultPreferences['enotifusertalkpages'] = array(
420 'section' => 'personal/email',
421 'label-message' => 'tog-enotifusertalkpages',
422 'disabled' => $disableEmailPrefs,
425 if ( $wgEnotifUserTalk ||
$wgEnotifWatchlist ) {
426 $defaultPreferences['enotifminoredits'] = array(
428 'section' => 'personal/email',
429 'label-message' => 'tog-enotifminoredits',
430 'disabled' => $disableEmailPrefs,
433 global $wgEnotifRevealEditorAddress;
434 if ( $wgEnotifRevealEditorAddress ) {
435 $defaultPreferences['enotifrevealaddr'] = array(
437 'section' => 'personal/email',
438 'label-message' => 'tog-enotifrevealaddr',
439 'disabled' => $disableEmailPrefs,
446 static function skinPreferences( $user, &$defaultPreferences ) {
447 ## Skin #####################################
448 global $wgLang, $wgAllowUserCss, $wgAllowUserJs;
450 $defaultPreferences['skin'] = array(
452 'options' => self
::generateSkinOptions( $user ),
454 'section' => 'rendering/skin',
457 # Create links to user CSS/JS pages for all skins
458 # This code is basically copied from generateSkinOptions(). It'd
459 # be nice to somehow merge this back in there to avoid redundancy.
460 if ( $wgAllowUserCss ||
$wgAllowUserJs ) {
461 $sk = $user->getSkin();
462 $linkTools = array();
464 if ( $wgAllowUserCss ) {
465 $cssPage = Title
::makeTitleSafe( NS_USER
, $user->getName() . '/common.css' );
466 $linkTools[] = $sk->link( $cssPage, wfMsgHtml( 'prefs-custom-css' ) );
469 if ( $wgAllowUserJs ) {
470 $jsPage = Title
::makeTitleSafe( NS_USER
, $user->getName() . '/common.js' );
471 $linkTools[] = $sk->link( $jsPage, wfMsgHtml( 'prefs-custom-js' ) );
474 $defaultPreferences['commoncssjs'] = array(
477 'default' => $wgLang->pipeList( $linkTools ),
478 'label-message' => 'prefs-common-css-js',
479 'section' => 'rendering/skin',
483 $selectedSkin = $user->getOption( 'skin' );
484 if ( in_array( $selectedSkin, array( 'cologneblue', 'standard' ) ) ) {
485 $settings = array_flip( $wgLang->getQuickbarSettings() );
487 $defaultPreferences['quickbar'] = array(
489 'options' => $settings,
490 'section' => 'rendering/skin',
491 'label-message' => 'qbsettings',
496 static function mathPreferences( $user, &$defaultPreferences ) {
497 ## Math #####################################
498 global $wgUseTeX, $wgLang;
500 $defaultPreferences['math'] = array(
502 'options' => array_flip( array_map( 'wfMsgHtml', $wgLang->getMathNames() ) ),
504 'section' => 'rendering/math',
509 static function filesPreferences( $user, &$defaultPreferences ) {
510 ## Files #####################################
511 $defaultPreferences['imagesize'] = array(
513 'options' => self
::getImageSizes(),
514 'label-message' => 'imagemaxsize',
515 'section' => 'rendering/files',
517 $defaultPreferences['thumbsize'] = array(
519 'options' => self
::getThumbSizes(),
520 'label-message' => 'thumbsize',
521 'section' => 'rendering/files',
525 static function datetimePreferences( $user, &$defaultPreferences ) {
528 ## Date and time #####################################
529 $dateOptions = self
::getDateOptions();
530 if ( $dateOptions ) {
531 $defaultPreferences['date'] = array(
533 'options' => $dateOptions,
535 'section' => 'datetime/dateformat',
540 $nowlocal = Xml
::element( 'span', array( 'id' => 'wpLocalTime' ),
541 $wgLang->time( $now = wfTimestampNow(), true ) );
542 $nowserver = $wgLang->time( $now, false ) .
543 Html
::hidden( 'wpServerTime', substr( $now, 8, 2 ) * 60 +
substr( $now, 10, 2 ) );
545 $defaultPreferences['nowserver'] = array(
548 'label-message' => 'servertime',
549 'default' => $nowserver,
550 'section' => 'datetime/timeoffset',
553 $defaultPreferences['nowlocal'] = array(
556 'label-message' => 'localtime',
557 'default' => $nowlocal,
558 'section' => 'datetime/timeoffset',
561 // Grab existing pref.
562 $tzOffset = $user->getOption( 'timecorrection' );
563 $tz = explode( '|', $tzOffset, 2 );
565 $tzSetting = $tzOffset;
566 if ( count( $tz ) > 1 && $tz[0] == 'Offset' ) {
568 $tzSetting = sprintf( '%+03d:%02d', floor( $minDiff / 60 ), abs( $minDiff ) %
60 );
571 $defaultPreferences['timecorrection'] = array(
572 'class' => 'HTMLSelectOrOtherField',
573 'label-message' => 'timezonelegend',
574 'options' => self
::getTimezoneOptions(),
575 'default' => $tzSetting,
577 'section' => 'datetime/timeoffset',
581 static function renderingPreferences( $user, &$defaultPreferences ) {
582 ## Page Rendering ##############################
583 global $wgAllowUserCssPrefs;
584 if ( $wgAllowUserCssPrefs ) {
585 $defaultPreferences['underline'] = array(
588 wfMsg( 'underline-never' ) => 0,
589 wfMsg( 'underline-always' ) => 1,
590 wfMsg( 'underline-default' ) => 2,
592 'label-message' => 'tog-underline',
593 'section' => 'rendering/advancedrendering',
597 $stubThresholdValues = array( 50, 100, 500, 1000, 2000, 5000, 10000 );
598 $stubThresholdOptions = array( wfMsg( 'stub-threshold-disabled' ) => 0 );
599 foreach ( $stubThresholdValues as $value ) {
600 $stubThresholdOptions[wfMsg( 'size-bytes', $value )] = $value;
603 $defaultPreferences['stubthreshold'] = array(
604 'type' => 'selectorother',
605 'section' => 'rendering/advancedrendering',
606 'options' => $stubThresholdOptions,
608 'label' => wfMsg( 'stub-threshold' ), // Raw HTML message. Yay?
611 if ( $wgAllowUserCssPrefs ) {
612 $defaultPreferences['highlightbroken'] = array(
614 'section' => 'rendering/advancedrendering',
615 'label' => wfMsg( 'tog-highlightbroken' ), // Raw HTML
617 $defaultPreferences['showtoc'] = array(
619 'section' => 'rendering/advancedrendering',
620 'label-message' => 'tog-showtoc',
623 $defaultPreferences['nocache'] = array(
625 'label-message' => 'tog-nocache',
626 'section' => 'rendering/advancedrendering',
628 $defaultPreferences['showhiddencats'] = array(
630 'section' => 'rendering/advancedrendering',
631 'label-message' => 'tog-showhiddencats'
633 $defaultPreferences['showjumplinks'] = array(
635 'section' => 'rendering/advancedrendering',
636 'label-message' => 'tog-showjumplinks',
639 if ( $wgAllowUserCssPrefs ) {
640 $defaultPreferences['justify'] = array(
642 'section' => 'rendering/advancedrendering',
643 'label-message' => 'tog-justify',
647 $defaultPreferences['numberheadings'] = array(
649 'section' => 'rendering/advancedrendering',
650 'label-message' => 'tog-numberheadings',
654 static function editingPreferences( $user, &$defaultPreferences ) {
655 global $wgUseExternalEditor, $wgAllowUserCssPrefs;
657 ## Editing #####################################
658 $defaultPreferences['cols'] = array(
660 'label-message' => 'columns',
661 'section' => 'editing/textboxsize',
665 $defaultPreferences['rows'] = array(
667 'label-message' => 'rows',
668 'section' => 'editing/textboxsize',
673 if ( $wgAllowUserCssPrefs ) {
674 $defaultPreferences['editfont'] = array(
676 'section' => 'editing/advancedediting',
677 'label-message' => 'editfont-style',
679 wfMsg( 'editfont-default' ) => 'default',
680 wfMsg( 'editfont-monospace' ) => 'monospace',
681 wfMsg( 'editfont-sansserif' ) => 'sans-serif',
682 wfMsg( 'editfont-serif' ) => 'serif',
686 $defaultPreferences['previewontop'] = array(
688 'section' => 'editing/advancedediting',
689 'label-message' => 'tog-previewontop',
691 $defaultPreferences['previewonfirst'] = array(
693 'section' => 'editing/advancedediting',
694 'label-message' => 'tog-previewonfirst',
697 if ( $wgAllowUserCssPrefs ) {
698 $defaultPreferences['editsection'] = array(
700 'section' => 'editing/advancedediting',
701 'label-message' => 'tog-editsection',
704 $defaultPreferences['editsectiononrightclick'] = array(
706 'section' => 'editing/advancedediting',
707 'label-message' => 'tog-editsectiononrightclick',
709 $defaultPreferences['editondblclick'] = array(
711 'section' => 'editing/advancedediting',
712 'label-message' => 'tog-editondblclick',
714 $defaultPreferences['showtoolbar'] = array(
716 'section' => 'editing/advancedediting',
717 'label-message' => 'tog-showtoolbar',
719 $defaultPreferences['minordefault'] = array(
721 'section' => 'editing/advancedediting',
722 'label-message' => 'tog-minordefault',
725 if ( $wgUseExternalEditor ) {
726 $defaultPreferences['externaleditor'] = array(
728 'section' => 'editing/advancedediting',
729 'label-message' => 'tog-externaleditor',
731 $defaultPreferences['externaldiff'] = array(
733 'section' => 'editing/advancedediting',
734 'label-message' => 'tog-externaldiff',
738 $defaultPreferences['forceeditsummary'] = array(
740 'section' => 'editing/advancedediting',
741 'label-message' => 'tog-forceeditsummary',
745 $defaultPreferences['uselivepreview'] = array(
747 'section' => 'editing/advancedediting',
748 'label-message' => 'tog-uselivepreview',
752 static function rcPreferences( $user, &$defaultPreferences ) {
753 global $wgRCMaxAge, $wgUseRCPatrol, $wgLang;
755 ## RecentChanges #####################################
756 $defaultPreferences['rcdays'] = array(
758 'label-message' => 'recentchangesdays',
759 'section' => 'rc/displayrc',
761 'max' => ceil( $wgRCMaxAge / ( 3600 * 24 ) ),
763 'recentchangesdays-max',
765 $wgLang->formatNum( ceil( $wgRCMaxAge / ( 3600 * 24 ) ) )
768 $defaultPreferences['rclimit'] = array(
770 'label-message' => 'recentchangescount',
771 'help-message' => 'prefs-help-recentchangescount',
772 'section' => 'rc/displayrc',
774 $defaultPreferences['usenewrc'] = array(
776 'label-message' => 'tog-usenewrc',
777 'section' => 'rc/advancedrc',
779 $defaultPreferences['hideminor'] = array(
781 'label-message' => 'tog-hideminor',
782 'section' => 'rc/advancedrc',
785 if ( $wgUseRCPatrol ) {
786 $defaultPreferences['hidepatrolled'] = array(
788 'section' => 'rc/advancedrc',
789 'label-message' => 'tog-hidepatrolled',
791 $defaultPreferences['newpageshidepatrolled'] = array(
793 'section' => 'rc/advancedrc',
794 'label-message' => 'tog-newpageshidepatrolled',
798 global $wgRCShowWatchingUsers;
799 if ( $wgRCShowWatchingUsers ) {
800 $defaultPreferences['shownumberswatching'] = array(
802 'section' => 'rc/advancedrc',
803 'label-message' => 'tog-shownumberswatching',
808 static function watchlistPreferences( $user, &$defaultPreferences ) {
809 global $wgUseRCPatrol, $wgEnableAPI;
811 ## Watchlist #####################################
812 $defaultPreferences['watchlistdays'] = array(
816 'section' => 'watchlist/displaywatchlist',
817 'help' => wfMsgHtml( 'prefs-watchlist-days-max' ),
818 'label-message' => 'prefs-watchlist-days',
820 $defaultPreferences['wllimit'] = array(
824 'label-message' => 'prefs-watchlist-edits',
825 'help' => wfMsgHtml( 'prefs-watchlist-edits-max' ),
826 'section' => 'watchlist/displaywatchlist',
828 $defaultPreferences['extendwatchlist'] = array(
830 'section' => 'watchlist/advancedwatchlist',
831 'label-message' => 'tog-extendwatchlist',
833 $defaultPreferences['watchlisthideminor'] = array(
835 'section' => 'watchlist/advancedwatchlist',
836 'label-message' => 'tog-watchlisthideminor',
838 $defaultPreferences['watchlisthidebots'] = array(
840 'section' => 'watchlist/advancedwatchlist',
841 'label-message' => 'tog-watchlisthidebots',
843 $defaultPreferences['watchlisthideown'] = array(
845 'section' => 'watchlist/advancedwatchlist',
846 'label-message' => 'tog-watchlisthideown',
848 $defaultPreferences['watchlisthideanons'] = array(
850 'section' => 'watchlist/advancedwatchlist',
851 'label-message' => 'tog-watchlisthideanons',
853 $defaultPreferences['watchlisthideliu'] = array(
855 'section' => 'watchlist/advancedwatchlist',
856 'label-message' => 'tog-watchlisthideliu',
859 if ( $wgUseRCPatrol ) {
860 $defaultPreferences['watchlisthidepatrolled'] = array(
862 'section' => 'watchlist/advancedwatchlist',
863 'label-message' => 'tog-watchlisthidepatrolled',
867 if ( $wgEnableAPI ) {
868 # Some random gibberish as a proposed default
869 $hash = sha1( mt_rand() . microtime( true ) );
871 $defaultPreferences['watchlisttoken'] = array(
873 'section' => 'watchlist/advancedwatchlist',
874 'label-message' => 'prefs-watchlist-token',
875 'help' => wfMsgHtml( 'prefs-help-watchlist-token', $hash )
880 'edit' => 'watchdefault',
881 'move' => 'watchmoves',
882 'delete' => 'watchdeletion'
886 if ( $user->isAllowed( 'createpage' ) ||
$user->isAllowed( 'createtalk' ) ) {
887 $watchTypes['read'] = 'watchcreations';
890 foreach ( $watchTypes as $action => $pref ) {
891 if ( $user->isAllowed( $action ) ) {
892 $defaultPreferences[$pref] = array(
894 'section' => 'watchlist/advancedwatchlist',
895 'label-message' => "tog-$pref",
901 static function searchPreferences( $user, &$defaultPreferences ) {
904 ## Search #####################################
905 $defaultPreferences['searchlimit'] = array(
907 'label-message' => 'resultsperpage',
908 'section' => 'searchoptions/displaysearchoptions',
911 $defaultPreferences['contextlines'] = array(
913 'label-message' => 'contextlines',
914 'section' => 'searchoptions/displaysearchoptions',
917 $defaultPreferences['contextchars'] = array(
919 'label-message' => 'contextchars',
920 'section' => 'searchoptions/displaysearchoptions',
924 global $wgEnableMWSuggest;
925 if ( $wgEnableMWSuggest ) {
926 $defaultPreferences['disablesuggest'] = array(
928 'label-message' => 'mwsuggest-disable',
929 'section' => 'searchoptions/displaysearchoptions',
933 global $wgVectorUseSimpleSearch;
934 if ( $wgVectorUseSimpleSearch ) {
935 $defaultPreferences['vector-simplesearch'] = array(
937 'label-message' => 'vector-simplesearch-preference',
938 'section' => 'searchoptions/displaysearchoptions'
942 $defaultPreferences['searcheverything'] = array(
944 'label-message' => 'searcheverything-enable',
945 'section' => 'searchoptions/advancedsearchoptions',
948 // Searchable namespaces back-compat with old format
949 $searchableNamespaces = SearchEngine
::searchableNamespaces();
951 $nsOptions = array();
953 foreach ( $wgContLang->getNamespaces() as $ns => $name ) {
958 $displayNs = str_replace( '_', ' ', $name );
961 $displayNs = wfMsg( 'blanknamespace' );
964 $displayNs = htmlspecialchars( $displayNs );
965 $nsOptions[$displayNs] = $ns;
968 $defaultPreferences['searchnamespaces'] = array(
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'] = array(
981 'section' => 'misc/diffs',
982 'label-message' => 'tog-diffonly',
984 $defaultPreferences['norollbackdiff'] = array(
986 'section' => 'misc/diffs',
987 'label-message' => 'tog-norollbackdiff',
990 // Stuff from Language::getExtraUserToggles()
993 $toggles = $wgContLang->getExtraUserToggles();
995 foreach ( $toggles as $toggle ) {
996 $defaultPreferences[$toggle] = array(
998 'section' => 'personal/i18n',
999 'label-message' => "tog-$toggle",
1005 * @param $user The User object
1006 * @return Array: text/links to display as key; $skinkey as value
1008 static function generateSkinOptions( $user ) {
1009 global $wgDefaultSkin, $wgLang, $wgAllowUserCss, $wgAllowUserJs;
1012 $mptitle = Title
::newMainPage();
1013 $previewtext = wfMsgHtml( 'skin-preview' );
1015 # Only show members of Skin::getSkinNames() rather than
1016 # $skinNames (skins is all skin names from Language.php)
1017 $validSkinNames = Skin
::getUsableSkins();
1019 # Sort by UI skin name. First though need to update validSkinNames as sometimes
1020 # the skinkey & UI skinname differ (e.g. "standard" skinkey is "Classic" in the UI).
1021 foreach ( $validSkinNames as $skinkey => &$skinname ) {
1022 $msg = wfMessage( "skinname-{$skinkey}" );
1023 if ( $msg->exists() ) {
1024 $skinname = htmlspecialchars( $msg->text() );
1027 asort( $validSkinNames );
1028 $sk = $user->getSkin();
1030 foreach ( $validSkinNames as $skinkey => $sn ) {
1031 $linkTools = array();
1033 # Mark the default skin
1034 if ( $skinkey == $wgDefaultSkin ) {
1035 $linkTools[] = wfMsgHtml( 'default' );
1038 # Create preview link
1039 $mplink = htmlspecialchars( $mptitle->getLocalURL( "useskin=$skinkey" ) );
1040 $linkTools[] = "<a target='_blank' href=\"$mplink\">$previewtext</a>";
1042 # Create links to user CSS/JS pages
1043 if ( $wgAllowUserCss ) {
1044 $cssPage = Title
::makeTitleSafe( NS_USER
, $user->getName() . '/' . $skinkey . '.css' );
1045 $linkTools[] = $sk->link( $cssPage, wfMsgHtml( 'prefs-custom-css' ) );
1048 if ( $wgAllowUserJs ) {
1049 $jsPage = Title
::makeTitleSafe( NS_USER
, $user->getName() . '/' . $skinkey . '.js' );
1050 $linkTools[] = $sk->link( $jsPage, wfMsgHtml( 'prefs-custom-js' ) );
1053 $display = $sn . ' ' . wfMsg( 'parentheses', $wgLang->pipeList( $linkTools ) );
1054 $ret[$display] = $skinkey;
1060 static function getDateOptions() {
1062 $dateopts = $wgLang->getDatePreferences();
1067 if ( !in_array( 'default', $dateopts ) ) {
1068 $dateopts[] = 'default'; // Make sure default is always valid
1072 // KLUGE: site default might not be valid for user language
1073 global $wgDefaultUserOptions;
1074 if ( !in_array( $wgDefaultUserOptions['date'], $dateopts ) ) {
1075 $wgDefaultUserOptions['date'] = 'default';
1078 $epoch = wfTimestampNow();
1079 foreach ( $dateopts as $key ) {
1080 if ( $key == 'default' ) {
1081 $formatted = wfMsgHtml( 'datedefault' );
1083 $formatted = htmlspecialchars( $wgLang->timeanddate( $epoch, false, $key ) );
1085 $ret[$formatted] = $key;
1091 static function getImageSizes() {
1092 global $wgImageLimits;
1096 foreach ( $wgImageLimits as $index => $limits ) {
1097 $display = "{$limits[0]}×{$limits[1]}" . wfMsg( 'unit-pixel' );
1098 $ret[$display] = $index;
1104 static function getThumbSizes() {
1105 global $wgThumbLimits;
1109 foreach ( $wgThumbLimits as $index => $size ) {
1110 $display = $size . wfMsg( 'unit-pixel' );
1111 $ret[$display] = $index;
1117 static function validateSignature( $signature, $alldata ) {
1118 global $wgParser, $wgMaxSigChars, $wgLang;
1119 if ( mb_strlen( $signature ) > $wgMaxSigChars ) {
1120 return Xml
::element( 'span', array( 'class' => 'error' ),
1121 wfMsgExt( 'badsiglength', 'parsemag',
1122 $wgLang->formatNum( $wgMaxSigChars )
1125 } elseif ( isset( $alldata['fancysig'] ) &&
1126 $alldata['fancysig'] &&
1127 false === $wgParser->validateSig( $signature ) ) {
1128 return Xml
::element( 'span', array( 'class' => 'error' ), wfMsg( 'badsig' ) );
1134 static function cleanSignature( $signature, $alldata ) {
1136 if ( isset( $alldata['fancysig'] ) && $alldata['fancysig'] ) {
1137 $signature = $wgParser->cleanSig( $signature );
1139 // When no fancy sig used, make sure ~{3,5} get removed.
1140 $signature = $wgParser->cleanSigInSig( $signature );
1146 static function validateEmail( $email, $alldata ) {
1147 if ( $email && !User
::isValidEmailAddr( $email ) ) {
1148 return wfMsgExt( 'invalidemailaddress', 'parseinline' );
1151 global $wgEmailConfirmToEdit;
1152 if ( $wgEmailConfirmToEdit && !$email ) {
1153 return wfMsgExt( 'noemailtitle', 'parseinline' );
1158 static function getFormObject( $user, $formClass = 'PreferencesForm' ) {
1159 $formDescriptor = Preferences
::getPreferences( $user );
1160 $htmlForm = new $formClass( $formDescriptor, 'prefs' );
1162 $htmlForm->setId( 'mw-prefs-form' );
1163 $htmlForm->setSubmitText( wfMsg( 'saveprefs' ) );
1164 # Used message keys: 'accesskey-preferences-save', 'tooltip-preferences-save'
1165 $htmlForm->setSubmitTooltip( 'preferences-save' );
1166 $htmlForm->setTitle( SpecialPage
::getTitleFor( 'Preferences' ) );
1167 $htmlForm->setSubmitID( 'prefsubmit' );
1168 $htmlForm->setSubmitCallback( array( 'Preferences', 'tryFormSubmit' ) );
1173 static function getTimezoneOptions() {
1176 global $wgLocalTZoffset;
1178 $opt[wfMsg( 'timezoneuseserverdefault' )] = "System|$wgLocalTZoffset";
1179 $opt[wfMsg( 'timezoneuseoffset' )] = 'other';
1180 $opt[wfMsg( 'guesstimezone' )] = 'guess';
1182 if ( function_exists( 'timezone_identifiers_list' ) ) {
1183 # Read timezone list
1184 $tzs = timezone_identifiers_list();
1187 $tzRegions = array();
1188 $tzRegions['Africa'] = wfMsg( 'timezoneregion-africa' );
1189 $tzRegions['America'] = wfMsg( 'timezoneregion-america' );
1190 $tzRegions['Antarctica'] = wfMsg( 'timezoneregion-antarctica' );
1191 $tzRegions['Arctic'] = wfMsg( 'timezoneregion-arctic' );
1192 $tzRegions['Asia'] = wfMsg( 'timezoneregion-asia' );
1193 $tzRegions['Atlantic'] = wfMsg( 'timezoneregion-atlantic' );
1194 $tzRegions['Australia'] = wfMsg( 'timezoneregion-australia' );
1195 $tzRegions['Europe'] = wfMsg( 'timezoneregion-europe' );
1196 $tzRegions['Indian'] = wfMsg( 'timezoneregion-indian' );
1197 $tzRegions['Pacific'] = wfMsg( 'timezoneregion-pacific' );
1198 asort( $tzRegions );
1200 $prefill = array_fill_keys( array_values( $tzRegions ), array() );
1201 $opt = array_merge( $opt, $prefill );
1203 $now = date_create( 'now' );
1205 foreach ( $tzs as $tz ) {
1206 $z = explode( '/', $tz, 2 );
1208 # timezone_identifiers_list() returns a number of
1209 # backwards-compatibility entries. This filters them out of the
1210 # list presented to the user.
1211 if ( count( $z ) != 2 ||
!array_key_exists( $z[0], $tzRegions ) ) {
1216 $z[0] = $tzRegions[$z[0]];
1218 $minDiff = floor( timezone_offset_get( timezone_open( $tz ), $now ) / 60 );
1220 $display = str_replace( '_', ' ', $z[0] . '/' . $z[1] );
1221 $value = "ZoneInfo|$minDiff|$tz";
1223 $opt[$z[0]][$display] = $value;
1229 static function filterIntval( $value, $alldata ){
1230 return intval( $value );
1233 static function filterTimezoneInput( $tz, $alldata ) {
1234 $data = explode( '|', $tz, 3 );
1235 switch ( $data[0] ) {
1240 $data = explode( ':', $tz, 2 );
1241 if ( count( $data ) == 2 ) {
1242 $data[0] = intval( $data[0] );
1243 $data[1] = intval( $data[1] );
1244 $minDiff = abs( $data[0] ) * 60 +
$data[1];
1245 if ( $data[0] < 0 ) $minDiff = - $minDiff;
1247 $minDiff = intval( $data[0] ) * 60;
1250 # Max is +14:00 and min is -12:00, see:
1251 # http://en.wikipedia.org/wiki/Timezone
1252 $minDiff = min( $minDiff, 840 ); # 14:00
1253 $minDiff = max( $minDiff, - 720 ); # -12:00
1254 return 'Offset|' . $minDiff;
1258 static function tryFormSubmit( $formData, $entryPoint = 'internal' ) {
1259 global $wgUser, $wgEmailAuthentication, $wgEnableEmail;
1264 foreach ( array_keys( $formData ) as $name ) {
1265 if ( isset( self
::$saveFilters[$name] ) ) {
1267 call_user_func( self
::$saveFilters[$name], $formData[$name], $formData );
1271 // Stuff that shouldn't be saved as a preference.
1272 $saveBlacklist = array(
1277 if ( $wgEnableEmail ) {
1278 $newaddr = $formData['emailaddress'];
1279 $oldaddr = $wgUser->getEmail();
1280 if ( ( $newaddr != '' ) && ( $newaddr != $oldaddr ) ) {
1281 # the user has supplied a new email address on the login page
1282 # new behaviour: set this new emailaddr from login-page into user database record
1283 $wgUser->setEmail( $newaddr );
1284 # but flag as "dirty" = unauthenticated
1285 $wgUser->invalidateEmail();
1286 if ( $wgEmailAuthentication ) {
1287 # Mail a temporary password to the dirty address.
1288 # User can come back through the confirmation URL to re-enable email.
1289 $result = $wgUser->sendConfirmationMail( $oldaddr != '' );
1290 if ( !$result->isGood() ) {
1291 return htmlspecialchars( $result->getWikiText( 'mailerror' ) );
1292 } elseif ( $entryPoint == 'ui' ) {
1297 $wgUser->setEmail( $newaddr );
1299 if ( $oldaddr != $newaddr ) {
1300 wfRunHooks( 'PrefsEmailAudit', array( $wgUser, $oldaddr, $newaddr ) );
1304 // Fortunately, the realname field is MUCH simpler
1305 global $wgHiddenPrefs;
1306 if ( !in_array( 'realname', $wgHiddenPrefs ) ) {
1307 $realName = $formData['realname'];
1308 $wgUser->setRealName( $realName );
1311 foreach ( $saveBlacklist as $b ) {
1312 unset( $formData[$b] );
1315 // Keeps old preferences from interfering due to back-compat
1317 $wgUser->resetOptions();
1319 foreach ( $formData as $key => $value ) {
1320 $wgUser->setOption( $key, $value );
1323 $wgUser->saveSettings();
1328 public static function tryUISubmit( $formData ) {
1329 $res = self
::tryFormSubmit( $formData, 'ui' );
1332 $urlOptions = array( 'success' );
1334 if ( $res === 'eauth' ) {
1335 $urlOptions[] = 'eauth';
1338 $queryString = implode( '&', $urlOptions );
1340 $url = SpecialPage
::getTitleFor( 'Preferences' )->getFullURL( $queryString );
1343 $wgOut->redirect( $url );
1346 return Status
::newGood();
1349 public static function loadOldSearchNs( $user ) {
1350 $searchableNamespaces = SearchEngine
::searchableNamespaces();
1351 // Back compat with old format
1354 foreach ( $searchableNamespaces as $ns => $name ) {
1355 if ( $user->getOption( 'searchNs' . $ns ) ) {
1364 /** Some tweaks to allow js prefs to work */
1365 class PreferencesForm
extends HTMLForm
{
1366 function wrapForm( $html ) {
1367 $html = Xml
::tags( 'div', array( 'id' => 'preferences' ), $html );
1369 return parent
::wrapForm( $html );
1372 function getButtons() {
1373 $html = parent
::getButtons();
1377 $sk = $wgUser->getSkin();
1378 $t = SpecialPage
::getTitleFor( 'Preferences', 'reset' );
1380 $html .= "\n" . $sk->link( $t, wfMsgHtml( 'restoreprefs' ) );
1382 $html = Xml
::tags( 'div', array( 'class' => 'mw-prefs-buttons' ), $html );
1387 function filterDataForSubmit( $data ) {
1388 // Support for separating MultiSelect preferences into multiple preferences
1389 // Due to lack of array support.
1390 foreach ( $this->mFlatFields
as $fieldname => $field ) {
1391 $info = $field->mParams
;
1392 if ( $field instanceof HTMLMultiSelectField
) {
1393 $options = HTMLFormField
::flattenOptions( $info['options'] );
1394 $prefix = isset( $info['prefix'] ) ?
$info['prefix'] : $fieldname;
1396 foreach ( $options as $opt ) {
1397 $data["$prefix$opt"] = in_array( $opt, $data[$fieldname] );
1400 unset( $data[$fieldname] );