Fix a regression from the preference rewrite: The help messages for maximum values...
[lhc/web/wiklou.git] / includes / Preferences.php
1 <?php
2
3 class Preferences {
4 static $defaultPreferences = null;
5 static $saveFilters =
6 array(
7 'timecorrection' => array( 'Preferences', 'filterTimezoneInput' ),
8 );
9
10 static function getPreferences( $user ) {
11 if ( self::$defaultPreferences )
12 return self::$defaultPreferences;
13
14 global $wgRCMaxAge;
15
16 $defaultPreferences = array();
17
18 self::profilePreferences( $user, $defaultPreferences );
19 self::skinPreferences( $user, $defaultPreferences );
20 self::filesPreferences( $user, $defaultPreferences );
21 self::mathPreferences( $user, $defaultPreferences );
22 self::datetimePreferences( $user, $defaultPreferences );
23 self::renderingPreferences( $user, $defaultPreferences );
24 self::editingPreferences( $user, $defaultPreferences );
25 self::rcPreferences( $user, $defaultPreferences );
26 self::watchlistPreferences( $user, $defaultPreferences );
27 self::searchPreferences( $user, $defaultPreferences );
28 self::miscPreferences( $user, $defaultPreferences );
29
30 wfRunHooks( 'GetPreferences', array( $user, &$defaultPreferences ) );
31
32 ## Remove preferences that wikis don't want to use
33 global $wgHiddenPrefs;
34 foreach ( $wgHiddenPrefs as $pref ) {
35 if ( isset( $defaultPreferences[$pref] ) ) {
36 unset( $defaultPreferences[$pref] );
37 }
38 }
39
40 ## Prod in defaults from the user
41 global $wgDefaultUserOptions;
42 foreach( $defaultPreferences as $name => &$info ) {
43 $prefFromUser = self::getOptionFromUser( $name, $info, $user );
44 $field = HTMLForm::loadInputFromParameters( $info ); // For validation
45 $defaultOptions = User::getDefaultOptions();
46 $globalDefault = isset( $defaultOptions[$name] )
47 ? $defaultOptions[$name]
48 : null;
49
50 // If it validates, set it as the default
51 if ( isset( $info['default'] ) ) {
52 // Already set, no problem
53 continue;
54 } elseif ( !is_null( $prefFromUser ) && // Make sure we're not just pulling nothing
55 $field->validate( $prefFromUser, $user->mOptions ) === true ) {
56 $info['default'] = $prefFromUser;
57 } elseif( $field->validate( $globalDefault, $user->mOptions ) === true ) {
58 $info['default'] = $globalDefault;
59 } else {
60 throw new MWException( "Global default '$globalDefault' is invalid for field $name" );
61 }
62 }
63
64 self::$defaultPreferences = $defaultPreferences;
65
66 return $defaultPreferences;
67 }
68
69 // Pull option from a user account. Handles stuff like array-type preferences.
70 static function getOptionFromUser( $name, $info, $user ) {
71 $val = $user->getOption( $name );
72
73 // Handling for array-type preferences
74 if ( ( isset( $info['type'] ) && $info['type'] == 'multiselect' ) ||
75 ( isset( $info['class'] ) && $info['class'] == 'HTMLMultiSelectField' ) ) {
76
77 $options = HTMLFormField::flattenOptions( $info['options'] );
78 $prefix = isset( $info['prefix'] ) ? $info['prefix'] : $name;
79 $val = array();
80
81 foreach( $options as $label => $value ) {
82 if( $user->getOption( "$prefix$value" ) ) {
83 $val[] = $value;
84 }
85 }
86 }
87
88 return $val;
89 }
90
91 static function profilePreferences( $user, &$defaultPreferences ) {
92 global $wgLang;
93 ## User info #####################################
94 // Information panel
95 $defaultPreferences['username'] =
96 array(
97 'type' => 'info',
98 'label-message' => 'username',
99 'default' => $user->getName(),
100 'section' => 'personal/info',
101 );
102
103 $defaultPreferences['userid'] =
104 array(
105 'type' => 'info',
106 'label-message' => 'uid',
107 'default' => $user->getId(),
108 'section' => 'personal/info',
109 );
110
111 # Get groups to which the user belongs
112 $userEffectiveGroups = $user->getEffectiveGroups();
113 $userEffectiveGroupsArray = array();
114 foreach( $userEffectiveGroups as $ueg ) {
115 if( $ueg == '*' ) {
116 // Skip the default * group, seems useless here
117 continue;
118 }
119 $userEffectiveGroupsArray[] = User::makeGroupLinkHTML( $ueg );
120 }
121 asort( $userEffectiveGroupsArray );
122
123 $defaultPreferences['usergroups'] =
124 array(
125 'type' => 'info',
126 'label' => wfMsgExt( 'prefs-memberingroups', 'parseinline',
127 count( $userEffectiveGroupsArray ) ),
128 'default' => $wgLang->commaList( $userEffectiveGroupsArray ),
129 'raw' => true,
130 'section' => 'personal/info',
131 );
132
133 $defaultPreferences['editcount'] =
134 array(
135 'type' => 'info',
136 'label-message' => 'prefs-edits',
137 'default' => $wgLang->formatNum( $user->getEditCount() ),
138 'section' => 'personal/info',
139 );
140
141 if( $user->getRegistration() ) {
142 $defaultPreferences['registrationdate'] =
143 array(
144 'type' => 'info',
145 'label-message' => 'prefs-registration',
146 'default' => wfMsgExt( 'prefs-registration-date-time', 'parsemag',
147 $wgLang->timeanddate( $user->getRegistration(), true ),
148 $wgLang->date( $user->getRegistration(), true ),
149 $wgLang->time( $user->getRegistration(), true ) ),
150 'section' => 'personal/info',
151 );
152 }
153
154 // Actually changeable stuff
155 global $wgAuth;
156 $defaultPreferences['realname'] =
157 array(
158 'type' => $wgAuth->allowPropChange( 'realname' ) ? 'text' : 'info',
159 'default' => $user->getRealName(),
160 'section' => 'personal/info',
161 'label-message' => 'yourrealname',
162 'help-message' => 'prefs-help-realname',
163 );
164
165 $defaultPreferences['gender'] =
166 array(
167 'type' => 'select',
168 'section' => 'personal/info',
169 'options' => array(
170 wfMsg( 'gender-male' ) => 'male',
171 wfMsg( 'gender-female' ) => 'female',
172 wfMsg( 'gender-unknown' ) => 'unknown',
173 ),
174 'label-message' => 'yourgender',
175 'help-message' => 'prefs-help-gender',
176 );
177
178 if( $wgAuth->allowPasswordChange() ) {
179 global $wgUser; // For skin.
180 $link = $wgUser->getSkin()->link( SpecialPage::getTitleFor( 'Resetpass' ),
181 wfMsgHtml( 'prefs-resetpass' ), array(),
182 array( 'returnto' => SpecialPage::getTitleFor( 'Preferences' ) ) );
183
184 $defaultPreferences['password'] =
185 array(
186 'type' => 'info',
187 'raw' => true,
188 'default' => $link,
189 'label-message' => 'yourpassword',
190 'section' => 'personal/info',
191 );
192 }
193
194 $defaultPreferences['rememberpassword'] =
195 array(
196 'type' => 'toggle',
197 'label-message' => 'tog-rememberpassword',
198 'section' => 'personal/info',
199 );
200
201 // Language
202 global $wgContLanguageCode;
203 $languages = array_reverse( Language::getLanguageNames( false ) );
204 if( !array_key_exists( $wgContLanguageCode, $languages ) ) {
205 $languages[$wgContLanguageCode] = $wgContLanguageCode;
206 }
207 ksort( $languages );
208
209 $options = array();
210 foreach( $languages as $code => $name ) {
211 $display = "$code - $name";
212 $options[$display] = $code;
213 }
214 $defaultPreferences['language'] =
215 array(
216 'type' => 'select',
217 'section' => 'personal/i18n',
218 'options' => $options,
219 'label-message' => 'yourlanguage',
220 );
221
222 global $wgContLang, $wgDisableLangConversion;
223 global $wgDisableTitleConversion;
224 /* see if there are multiple language variants to choose from*/
225 $variantArray = array();
226 if( !$wgDisableLangConversion ) {
227 $variants = $wgContLang->getVariants();
228
229 $languages = Language::getLanguageNames( true );
230 foreach( $variants as $v ) {
231 $v = str_replace( '_', '-', strtolower( $v ) );
232 if( array_key_exists( $v, $languages ) ) {
233 // If it doesn't have a name, we'll pretend it doesn't exist
234 $variantArray[$v] = $languages[$v];
235 }
236 }
237
238 $options = array();
239 foreach( $variantArray as $code => $name ) {
240 $display = "$code - $name";
241 $options[$display] = $code;
242 }
243
244 if( count( $variantArray ) > 1 ) {
245 $defaultPreferences['variant'] =
246 array(
247 'label-message' => 'yourvariant',
248 'type' => 'select',
249 'options' => $options,
250 'section' => 'personal/i18n',
251 );
252 }
253 }
254
255 if( count( $variantArray ) > 1 && !$wgDisableLangConversion && !$wgDisableTitleConversion ) {
256 $defaultPreferences['noconvertlink'] =
257 array(
258 'type' => 'toggle',
259 'section' => 'personal/i18n',
260 'label-message' => 'tog-noconvertlink',
261 );
262 }
263
264 global $wgMaxSigChars;
265 $defaultPreferences['nickname'] =
266 array(
267 'type' => $wgAuth->allowPropChange( 'nickname' ) ? 'text' : 'info',
268 'maxlength' => $wgMaxSigChars,
269 'label-message' => 'yournick',
270 'validation-callback' =>
271 array( 'Preferences', 'validateSignature' ),
272 'section' => 'personal/signature',
273 'filter-callback' => array( 'Preferences', 'cleanSignature' ),
274 );
275 $defaultPreferences['fancysig'] =
276 array(
277 'type' => 'toggle',
278 'label-message' => 'tog-fancysig',
279 'section' => 'personal/signature'
280 );
281
282 ## Email stuff
283
284 global $wgEnableEmail;
285 if ($wgEnableEmail) {
286
287 global $wgEmailConfirmToEdit;
288
289 $defaultPreferences['emailaddress'] =
290 array(
291 'type' => $wgAuth->allowPropChange( 'emailaddress' ) ? 'text' : 'info',
292 'default' => $user->getEmail(),
293 'section' => 'personal/email',
294 'label-message' => 'youremail',
295 'help-message' => $wgEmailConfirmToEdit
296 ? 'prefs-help-email-required'
297 : 'prefs-help-email',
298 'validation-callback' => array( 'Preferences', 'validateEmail' ),
299 );
300
301 global $wgEnableUserEmail, $wgEmailAuthentication;
302
303 $disableEmailPrefs = false;
304
305 if ( $wgEmailAuthentication ) {
306 if ( $user->getEmail() ) {
307 if( $user->getEmailAuthenticationTimestamp() ) {
308 // date and time are separate parameters to facilitate localisation.
309 // $time is kept for backward compat reasons.
310 // 'emailauthenticated' is also used in SpecialConfirmemail.php
311 $time = $wgLang->timeAndDate( $user->getEmailAuthenticationTimestamp(), true );
312 $d = $wgLang->date( $user->getEmailAuthenticationTimestamp(), true );
313 $t = $wgLang->time( $user->getEmailAuthenticationTimestamp(), true );
314 $emailauthenticated = htmlspecialchars( wfMsg( 'emailauthenticated', $time, $d, $t ) ) . '<br />';
315 $disableEmailPrefs = false;
316 } else {
317 $disableEmailPrefs = true;
318 global $wgUser; // wgUser is okay here, it's for display
319 $skin = $wgUser->getSkin();
320 $emailauthenticated = wfMsgHtml( 'emailnotauthenticated' ) . '<br />' .
321 $skin->link(
322 SpecialPage::getTitleFor( 'Confirmemail' ),
323 wfMsg( 'emailconfirmlink' ),
324 array(),
325 array(),
326 array( 'known', 'noclasses' )
327 ) . '<br />';
328 }
329 } else {
330 $disableEmailPrefs = true;
331 $emailauthenticated = wfMsgHtml( 'noemailprefs' );
332 }
333
334 $defaultPreferences['emailauthentication'] =
335 array(
336 'type' => 'info',
337 'raw' => true,
338 'section' => 'personal/email',
339 'label-message' => 'prefs-emailconfirm-label',
340 'default' => $emailauthenticated,
341 );
342
343 }
344
345 if( $wgEnableUserEmail ) {
346 $defaultPreferences['disablemail'] =
347 array(
348 'type' => 'toggle',
349 'invert' => true,
350 'section' => 'personal/email',
351 'label-message' => 'allowemail',
352 'disabled' => $disableEmailPrefs,
353 );
354 $defaultPreferences['ccmeonemails'] =
355 array(
356 'type' => 'toggle',
357 'section' => 'personal/email',
358 'label-message' => 'tog-ccmeonemails',
359 'disabled' => $disableEmailPrefs,
360 );
361 }
362
363 global $wgEnotifWatchlist;
364 if ( $wgEnotifWatchlist ) {
365 $defaultPreferences['enotifwatchlistpages'] =
366 array(
367 'type' => 'toggle',
368 'section' => 'personal/email',
369 'label-message' => 'tog-enotifwatchlistpages',
370 'disabled' => $disableEmailPrefs,
371 );
372 }
373 global $wgEnotifUserTalk;
374 if( $wgEnotifUserTalk ) {
375 $defaultPreferences['enotifusertalkpages'] =
376 array(
377 'type' => 'toggle',
378 'section' => 'personal/email',
379 'label-message' => 'tog-enotifusertalkpages',
380 'disabled' => $disableEmailPrefs,
381 );
382 }
383 if( $wgEnotifUserTalk || $wgEnotifWatchlist ) {
384 $defaultPreferences['enotifminoredits'] =
385 array(
386 'type' => 'toggle',
387 'section' => 'personal/email',
388 'label-message' => 'tog-enotifminoredits',
389 'disabled' => $disableEmailPrefs,
390 );
391 }
392 $defaultPreferences['enotifrevealaddr'] =
393 array(
394 'type' => 'toggle',
395 'section' => 'personal/email',
396 'label-message' => 'tog-enotifrevealaddr',
397 'disabled' => $disableEmailPrefs,
398 );
399 }
400 }
401
402 static function skinPreferences( $user, &$defaultPreferences ) {
403 ## Skin #####################################
404 $defaultPreferences['skin'] =
405 array(
406 'type' => 'radio',
407 'options' => self::generateSkinOptions( $user ),
408 'label' => '&nbsp;',
409 'section' => 'rendering/skin',
410 );
411
412 $selectedSkin = $user->getOption( 'skin' );
413 if ( in_array( $selectedSkin, array( 'cologneblue', 'standard' ) ) ) {
414 global $wgLang;
415 $settings = array_flip( $wgLang->getQuickbarSettings() );
416
417 $defaultPreferences['quickbar'] =
418 array(
419 'type' => 'radio',
420 'options' => $settings,
421 'section' => 'rendering/skin',
422 'label-message' => 'qbsettings',
423 );
424 }
425 }
426
427 static function mathPreferences( $user, &$defaultPreferences ) {
428 ## Math #####################################
429 global $wgUseTeX, $wgLang;
430 if( $wgUseTeX ) {
431 $defaultPreferences['math'] =
432 array(
433 'type' => 'radio',
434 'options' =>
435 array_flip( array_map( 'wfMsgHtml', $wgLang->getMathNames() ) ),
436 'label' => '&nbsp;',
437 'section' => 'rendering/math',
438 );
439 }
440 }
441
442 static function filesPreferences( $user, &$defaultPreferences ) {
443 ## Files #####################################
444 $defaultPreferences['imagesize'] =
445 array(
446 'type' => 'select',
447 'options' => self::getImageSizes(),
448 'label-message' => 'imagemaxsize',
449 'section' => 'rendering/files',
450 );
451 $defaultPreferences['thumbsize'] =
452 array(
453 'type' => 'select',
454 'options' => self::getThumbSizes(),
455 'label-message' => 'thumbsize',
456 'section' => 'rendering/files',
457 );
458 }
459
460 static function datetimePreferences( $user, &$defaultPreferences ) {
461 global $wgLang;
462
463 ## Date and time #####################################
464 $dateOptions = self::getDateOptions();
465 if( $dateOptions ) {
466 $defaultPreferences['date'] =
467 array(
468 'type' => 'radio',
469 'options' => $dateOptions,
470 'label' => '&nbsp;',
471 'section' => 'datetime/dateformat',
472 );
473 }
474
475 // Info
476 $nowlocal = Xml::element( 'span', array( 'id' => 'wpLocalTime' ),
477 $wgLang->time( $now = wfTimestampNow(), true ) );
478 $nowserver = $wgLang->time( $now, false ) .
479 Xml::hidden( 'wpServerTime', substr( $now, 8, 2 ) * 60 + substr( $now, 10, 2 ) );
480
481 $defaultPreferences['nowserver'] =
482 array(
483 'type' => 'info',
484 'raw' => 1,
485 'label-message' => 'servertime',
486 'default' => $nowserver,
487 'section' => 'datetime/timeoffset',
488 );
489
490 $defaultPreferences['nowlocal'] =
491 array(
492 'type' => 'info',
493 'raw' => 1,
494 'label-message' => 'localtime',
495 'default' => $nowlocal,
496 'section' => 'datetime/timeoffset',
497 );
498
499 // Grab existing pref.
500 $tzOffset = $user->getOption( 'timecorrection' );
501 $tz = explode( '|', $tzOffset, 2 );
502
503 $tzSetting = $tzOffset;
504 if( count( $tz ) > 1 && $tz[0] == 'Offset' ) {
505 $minDiff = $tz[1];
506 $tzSetting = sprintf( '%+03d:%02d', floor( $minDiff/60 ), abs( $minDiff )%60 );
507 }
508
509 $defaultPreferences['timecorrection'] =
510 array(
511 'class' => 'HTMLSelectOrOtherField',
512 'label-message' => 'timezonelegend',
513 'options' => self::getTimezoneOptions(),
514 'default' => $tzSetting,
515 'section' => 'datetime/timeoffset',
516 );
517 }
518
519 static function renderingPreferences( $user, &$defaultPreferences ) {
520 ## Page Rendering ##############################
521 $defaultPreferences['underline'] =
522 array(
523 'type' => 'select',
524 'options' => array(
525 wfMsg( 'underline-never' ) => 0,
526 wfMsg( 'underline-always' ) => 1,
527 wfMsg( 'underline-default' ) => 2,
528 ),
529 'label-message' => 'tog-underline',
530 'section' => 'rendering/advancedrendering',
531 );
532
533 $stubThresholdValues = array( 0, 50, 100, 500, 1000, 2000, 5000, 10000 );
534 $stubThresholdOptions = array();
535 foreach( $stubThresholdValues as $value ) {
536 $stubThresholdOptions[wfMsg( 'size-bytes', $value )] = $value;
537 }
538
539 $defaultPreferences['stubthreshold'] =
540 array(
541 'type' => 'selectorother',
542 'section' => 'rendering/advancedrendering',
543 'options' => $stubThresholdOptions,
544 'label' => wfMsg( 'stub-threshold' ), // Raw HTML message. Yay?
545 );
546 $defaultPreferences['highlightbroken'] =
547 array(
548 'type' => 'toggle',
549 'section' => 'rendering/advancedrendering',
550 'label' => wfMsg( 'tog-highlightbroken' ), // Raw HTML
551 );
552 $defaultPreferences['showtoc'] =
553 array(
554 'type' => 'toggle',
555 'section' => 'rendering/advancedrendering',
556 'label-message' => 'tog-showtoc',
557 );
558 $defaultPreferences['nocache'] =
559 array(
560 'type' => 'toggle',
561 'label-message' => 'tog-nocache',
562 'section' => 'rendering/advancedrendering',
563 );
564 $defaultPreferences['showhiddencats'] =
565 array(
566 'type' => 'toggle',
567 'section' => 'rendering/advancedrendering',
568 'label-message' => 'tog-showhiddencats'
569 );
570 $defaultPreferences['showjumplinks'] =
571 array(
572 'type' => 'toggle',
573 'section' => 'rendering/advancedrendering',
574 'label-message' => 'tog-showjumplinks',
575 );
576 $defaultPreferences['justify'] =
577 array(
578 'type' => 'toggle',
579 'section' => 'rendering/advancedrendering',
580 'label-message' => 'tog-justify',
581 );
582 $defaultPreferences['numberheadings'] =
583 array(
584 'type' => 'toggle',
585 'section' => 'rendering/advancedrendering',
586 'label-message' => 'tog-numberheadings',
587 );
588 }
589
590 static function editingPreferences( $user, &$defaultPreferences ) {
591 global $wgUseExternalEditor, $wgLivePreview;
592
593 ## Editing #####################################
594 $defaultPreferences['cols'] =
595 array(
596 'type' => 'int',
597 'label-message' => 'columns',
598 'section' => 'editing/textboxsize',
599 'min' => 4,
600 'max' => 1000,
601 );
602 $defaultPreferences['rows'] =
603 array(
604 'type' => 'int',
605 'label-message' => 'rows',
606 'section' => 'editing/textboxsize',
607 'min' => 4,
608 'max' => 1000,
609 );
610 $defaultPreferences['previewontop'] =
611 array(
612 'type' => 'toggle',
613 'section' => 'editing/advancedediting',
614 'label-message' => 'tog-previewontop',
615 );
616 $defaultPreferences['previewonfirst'] =
617 array(
618 'type' => 'toggle',
619 'section' => 'editing/advancedediting',
620 'label-message' => 'tog-previewonfirst',
621 );
622 $defaultPreferences['editsection'] =
623 array(
624 'type' => 'toggle',
625 'section' => 'editing/advancedediting',
626 'label-message' => 'tog-editsection',
627 );
628 $defaultPreferences['editsectiononrightclick'] =
629 array(
630 'type' => 'toggle',
631 'section' => 'editing/advancedediting',
632 'label-message' => 'tog-editsectiononrightclick',
633 );
634 $defaultPreferences['editondblclick'] =
635 array(
636 'type' => 'toggle',
637 'section' => 'editing/advancedediting',
638 'label-message' => 'tog-editondblclick',
639 );
640 $defaultPreferences['editwidth'] =
641 array(
642 'type' => 'toggle',
643 'section' => 'editing/advancedediting',
644 'label-message' => 'tog-editwidth',
645 );
646 $defaultPreferences['showtoolbar'] =
647 array(
648 'type' => 'toggle',
649 'section' => 'editing/advancedediting',
650 'label-message' => 'tog-showtoolbar',
651 );
652 $defaultPreferences['minordefault'] =
653 array(
654 'type' => 'toggle',
655 'section' => 'editing/advancedediting',
656 'label-message' => 'tog-minordefault',
657 );
658
659 if ( $wgUseExternalEditor ) {
660 $defaultPreferences['externaleditor'] =
661 array(
662 'type' => 'toggle',
663 'section' => 'editing/advancedediting',
664 'label-message' => 'tog-externaleditor',
665 );
666 $defaultPreferences['externaldiff'] =
667 array(
668 'type' => 'toggle',
669 'section' => 'editing/advancedediting',
670 'label-message' => 'tog-externaldiff',
671 );
672 }
673
674 $defaultPreferences['forceeditsummary'] =
675 array(
676 'type' => 'toggle',
677 'section' => 'editing/advancedediting',
678 'label-message' => 'tog-forceeditsummary',
679 );
680 if ( $wgLivePreview ) {
681 $defaultPreferences['uselivepreview'] =
682 array(
683 'type' => 'toggle',
684 'section' => 'editing/advancedediting',
685 'label-message' => 'tog-uselivepreview',
686 );
687 }
688 }
689
690 static function rcPreferences( $user, &$defaultPreferences ) {
691 global $wgRCMaxAge, $wgUseRCPatrol, $wgLang;
692 ## RecentChanges #####################################
693 $defaultPreferences['rcdays'] =
694 array(
695 'type' => 'float',
696 'label-message' => 'recentchangesdays',
697 'section' => 'rc/display',
698 'min' => 1,
699 'max' => ceil( $wgRCMaxAge / ( 3600*24 ) ),
700 'help' => wfMsgExt( 'recentchangesdays-max', array( 'parsemag' ), $wgLang->formatNum( ceil( $wgRCMaxAge / ( 3600*24 ) ) ) ),
701 );
702 $defaultPreferences['rclimit'] =
703 array(
704 'type' => 'int',
705 'label-message' => 'recentchangescount',
706 'help-message' => 'prefs-help-recentchangescount',
707 'section' => 'rc/display',
708 );
709 $defaultPreferences['usenewrc'] =
710 array(
711 'type' => 'toggle',
712 'label-message' => 'tog-usenewrc',
713 'section' => 'rc/advancedrc',
714 );
715 $defaultPreferences['hideminor'] =
716 array(
717 'type' => 'toggle',
718 'label-message' => 'tog-hideminor',
719 'section' => 'rc/advancedrc',
720 );
721
722 global $wgUseRCPatrol;
723 if( $wgUseRCPatrol ) {
724 $defaultPreferences['hidepatrolled'] =
725 array(
726 'type' => 'toggle',
727 'section' => 'rc/advancedrc',
728 'label-message' => 'tog-hidepatrolled',
729 );
730 $defaultPreferences['newpageshidepatrolled'] =
731 array(
732 'type' => 'toggle',
733 'section' => 'rc/advancedrc',
734 'label-message' => 'tog-newpageshidepatrolled',
735 );
736 }
737
738 global $wgRCShowWatchingUsers;
739 if( $wgRCShowWatchingUsers ) {
740 $defaultPreferences['shownumberswatching'] =
741 array(
742 'type' => 'toggle',
743 'section' => 'rc/advancedrc',
744 'label-message' => 'tog-shownumberswatching',
745 );
746 }
747 }
748
749 static function watchlistPreferences( $user, &$defaultPreferences ) {
750 global $wgUseRCPatrol, $wgEnableAPI;
751 ## Watchlist #####################################
752 $defaultPreferences['watchlistdays'] =
753 array(
754 'type' => 'float',
755 'min' => 0,
756 'max' => 7,
757 'section' => 'watchlist/display',
758 'help' => wfMsgHtml( 'prefs-watchlist-days-max' ),
759 'label-message' => 'prefs-watchlist-days',
760 );
761 $defaultPreferences['wllimit'] =
762 array(
763 'type' => 'int',
764 'min' => 0,
765 'max' => 1000,
766 'label-message' => 'prefs-watchlist-edits',
767 'help' => wfMsgHtml( 'prefs-watchlist-edits-max' ),
768 'section' => 'watchlist/display',
769 );
770 $defaultPreferences['extendwatchlist'] =
771 array(
772 'type' => 'toggle',
773 'section' => 'watchlist/advancedwatchlist',
774 'label-message' => 'tog-extendwatchlist',
775 );
776 $defaultPreferences['watchlisthideminor'] =
777 array(
778 'type' => 'toggle',
779 'section' => 'watchlist/advancedwatchlist',
780 'label-message' => 'tog-watchlisthideminor',
781 );
782 $defaultPreferences['watchlisthidebots'] =
783 array(
784 'type' => 'toggle',
785 'section' => 'watchlist/advancedwatchlist',
786 'label-message' => 'tog-watchlisthidebots',
787 );
788 $defaultPreferences['watchlisthideown'] =
789 array(
790 'type' => 'toggle',
791 'section' => 'watchlist/advancedwatchlist',
792 'label-message' => 'tog-watchlisthideown',
793 );
794 $defaultPreferences['watchlisthideanons'] =
795 array(
796 'type' => 'toggle',
797 'section' => 'watchlist/advancedwatchlist',
798 'label-message' => 'tog-watchlisthideanons',
799 );
800 $defaultPreferences['watchlisthideliu'] =
801 array(
802 'type' => 'toggle',
803 'section' => 'watchlist/advancedwatchlist',
804 'label-message' => 'tog-watchlisthideliu',
805 );
806 if ( $wgEnableAPI ) {
807 # Some random gibberish as a proposed default
808 $hash = sha1( mt_rand() . microtime( true ) );
809 $defaultPreferences['watchlisttoken'] =
810 array(
811 'type' => 'text',
812 'section' => 'watchlist/advancedwatchlist',
813 'label-message' => 'prefs-watchlist-token',
814 'help' => wfMsgHtml( 'prefs-help-watchlist-token', $hash )
815 );
816 }
817
818 if ( $wgUseRCPatrol ) {
819 $defaultPreferences['watchlisthidepatrolled'] =
820 array(
821 'type' => 'toggle',
822 'section' => 'watchlist/advancedwatchlist',
823 'label-message' => 'tog-watchlisthidepatrolled',
824 );
825 }
826
827 $watchTypes = array(
828 'edit' => 'watchdefault',
829 'move' => 'watchmoves',
830 'delete' => 'watchdeletion'
831 );
832
833 // Kinda hacky
834 if( $user->isAllowed( 'createpage' ) || $user->isAllowed( 'createtalk' ) ) {
835 $watchTypes['read'] = 'watchcreations';
836 }
837
838 foreach( $watchTypes as $action => $pref ) {
839 if ( $user->isAllowed( $action ) ) {
840 $defaultPreferences[$pref] = array(
841 'type' => 'toggle',
842 'section' => 'watchlist/advancedwatchlist',
843 'label-message' => "tog-$pref",
844 );
845 }
846 }
847 }
848
849 static function searchPreferences( $user, &$defaultPreferences ) {
850 global $wgContLang;
851
852 ## Search #####################################
853 $defaultPreferences['searchlimit'] =
854 array(
855 'type' => 'int',
856 'label-message' => 'resultsperpage',
857 'section' => 'searchoptions/display',
858 'min' => 0,
859 );
860 $defaultPreferences['contextlines'] =
861 array(
862 'type' => 'int',
863 'label-message' => 'contextlines',
864 'section' => 'searchoptions/display',
865 'min' => 0,
866 );
867 $defaultPreferences['contextchars'] =
868 array(
869 'type' => 'int',
870 'label-message' => 'contextchars',
871 'section' => 'searchoptions/display',
872 'min' => 0,
873 );
874 global $wgEnableMWSuggest;
875 if( $wgEnableMWSuggest ) {
876 $defaultPreferences['disablesuggest'] =
877 array(
878 'type' => 'toggle',
879 'label-message' => 'mwsuggest-disable',
880 'section' => 'searchoptions/display',
881 );
882 }
883
884 $defaultPreferences['searcheverything'] =
885 array(
886 'type' => 'toggle',
887 'label-message' => 'searcheverything-enable',
888 'section' => 'searchoptions/advancedsearchoptions',
889 );
890
891 // Searchable namespaces back-compat with old format
892 $searchableNamespaces = SearchEngine::searchableNamespaces();
893
894 $nsOptions = array();
895 foreach( $wgContLang->getNamespaces() as $ns => $name ) {
896 if( $ns < 0 ) continue;
897 $displayNs = str_replace( '_', ' ', $name );
898
899 if( !$displayNs ) $displayNs = wfMsg( 'blanknamespace' );
900
901 $displayNs = htmlspecialchars( $displayNs );
902 $nsOptions[$displayNs] = $ns;
903 }
904
905 $defaultPreferences['searchnamespaces'] =
906 array(
907 'type' => 'multiselect',
908 'label-message' => 'defaultns',
909 'options' => $nsOptions,
910 'section' => 'searchoptions/advancedsearchoptions',
911 'prefix' => 'searchNs',
912 );
913 }
914
915 static function miscPreferences( $user, &$defaultPreferences ) {
916 ## Misc #####################################
917 $defaultPreferences['diffonly'] =
918 array(
919 'type' => 'toggle',
920 'section' => 'misc/diffs',
921 'label-message' => 'tog-diffonly',
922 );
923 $defaultPreferences['norollbackdiff'] =
924 array(
925 'type' => 'toggle',
926 'section' => 'misc/diffs',
927 'label-message' => 'tog-norollbackdiff',
928 );
929
930 // Stuff from Language::getExtraUserToggles()
931 global $wgContLang;
932
933 $toggles = $wgContLang->getExtraUserToggles();
934
935 foreach( $toggles as $toggle ) {
936 $defaultPreferences[$toggle] =
937 array(
938 'type' => 'toggle',
939 'section' => 'personal/i18n',
940 'label-message' => "tog-$toggle",
941 );
942 }
943 }
944
945 static function generateSkinOptions( $user ) {
946 global $wgDefaultSkin;
947 $ret = array();
948
949 $mptitle = Title::newMainPage();
950 $previewtext = wfMsgHtml( 'skin-preview' );
951 # Only show members of Skin::getSkinNames() rather than
952 # $skinNames (skins is all skin names from Language.php)
953 $validSkinNames = Skin::getUsableSkins();
954 # Sort by UI skin name. First though need to update validSkinNames as sometimes
955 # the skinkey & UI skinname differ (e.g. "standard" skinkey is "Classic" in the UI).
956 foreach ( $validSkinNames as $skinkey => &$skinname ) {
957 $msgName = "skinname-{$skinkey}";
958 $localisedSkinName = wfMsg( $msgName );
959 if ( !wfEmptyMsg( $msgName, $localisedSkinName ) ) {
960 $skinname = htmlspecialchars( $localisedSkinName );
961 }
962 }
963 asort( $validSkinNames );
964 $sk = $user->getSkin();
965
966 foreach( $validSkinNames as $skinkey => $sn ) {
967 $mplink = htmlspecialchars( $mptitle->getLocalURL( "useskin=$skinkey" ) );
968 $previewlink = "(<a target='_blank' href=\"$mplink\">$previewtext</a>)";
969 $extraLinks = '';
970 global $wgAllowUserCss, $wgAllowUserJs;
971 if( $wgAllowUserCss ) {
972 $cssPage = Title::makeTitleSafe( NS_USER, $user->getName() . '/' . $skinkey . '.css' );
973 $customCSS = $sk->link( $cssPage, wfMsgHtml( 'prefs-custom-css' ) );
974 $extraLinks .= " ($customCSS)";
975 }
976 if( $wgAllowUserJs ) {
977 $jsPage = Title::makeTitleSafe( NS_USER, $user->getName() . '/' . $skinkey . '.js' );
978 $customJS = $sk->link( $jsPage, wfMsgHtml( 'prefs-custom-js' ) );
979 $extraLinks .= " ($customJS)";
980 }
981 if( $skinkey == $wgDefaultSkin )
982 $sn .= ' (' . wfMsgHtml( 'default' ) . ')';
983 $display = "$sn $previewlink{$extraLinks}";
984 $ret[$display] = $skinkey;
985 }
986
987 return $ret;
988 }
989
990 static function getDateOptions() {
991 global $wgLang;
992 $dateopts = $wgLang->getDatePreferences();
993
994 $ret = array();
995
996 if( $dateopts ) {
997 if ( !in_array( 'default', $dateopts ) ) {
998 $dateopts[] = 'default'; // Make sure default is always valid
999 // Bug 19237
1000 }
1001
1002 $idCnt = 0;
1003 $epoch = '20010115161234'; # Wikipedia day
1004 foreach( $dateopts as $key ) {
1005 if( $key == 'default' ) {
1006 $formatted = wfMsgHtml( 'datedefault' );
1007 } else {
1008 $formatted = htmlspecialchars( $wgLang->timeanddate( $epoch, false, $key ) );
1009 }
1010 $ret[$formatted] = $key;
1011 }
1012 }
1013 return $ret;
1014 }
1015
1016 static function getImageSizes() {
1017 global $wgImageLimits;
1018
1019 $ret = array();
1020
1021 foreach ( $wgImageLimits as $index => $limits ) {
1022 $display = "{$limits[0]}×{$limits[1]}" . wfMsg( 'unit-pixel' );
1023 $ret[$display] = $index;
1024 }
1025
1026 return $ret;
1027 }
1028
1029 static function getThumbSizes() {
1030 global $wgThumbLimits;
1031
1032 $ret = array();
1033
1034 foreach ( $wgThumbLimits as $index => $size ) {
1035 $display = $size . wfMsg( 'unit-pixel' );
1036 $ret[$display] = $index;
1037 }
1038
1039 return $ret;
1040 }
1041
1042 static function validateSignature( $signature, $alldata ) {
1043 global $wgParser, $wgMaxSigChars, $wgLang;
1044 if( mb_strlen( $signature ) > $wgMaxSigChars ) {
1045 return
1046 Xml::element( 'span', array( 'class' => 'error' ),
1047 wfMsgExt( 'badsiglength', 'parsemag',
1048 $wgLang->formatNum( $wgMaxSigChars )
1049 )
1050 );
1051 } elseif( !empty( $alldata['fancysig'] ) &&
1052 false === $wgParser->validateSig( $signature ) ) {
1053 return Xml::element( 'span', array( 'class' => 'error' ), wfMsg( 'badsig' ) );
1054 } else {
1055 return true;
1056 }
1057 }
1058
1059 static function cleanSignature( $signature, $alldata ) {
1060 global $wgParser;
1061 if( $alldata['fancysig'] ) {
1062 $signature = $wgParser->cleanSig( $signature );
1063 } else {
1064 // When no fancy sig used, make sure ~{3,5} get removed.
1065 $signature = $wgParser->cleanSigInSig( $signature );
1066 }
1067
1068 return $signature;
1069 }
1070
1071 static function validateEmail( $email, $alldata ) {
1072 if ( $email && !User::isValidEmailAddr( $email ) ) {
1073 return wfMsgExt( 'invalidemailaddress', 'parseinline' );
1074 }
1075
1076 global $wgEmailConfirmToEdit;
1077 if( $wgEmailConfirmToEdit && !$email ) {
1078 return wfMsgExt( 'noemailtitle', 'parseinline' );
1079 }
1080 return true;
1081 }
1082
1083 static function getFormObject( $user ) {
1084 $formDescriptor = Preferences::getPreferences( $user );
1085 $htmlForm = new PreferencesForm( $formDescriptor, 'prefs' );
1086
1087 $htmlForm->setSubmitText( wfMsg( 'saveprefs' ) );
1088 $htmlForm->setTitle( SpecialPage::getTitleFor( 'Preferences' ) );
1089 $htmlForm->setSubmitID( 'prefsubmit' );
1090 $htmlForm->setSubmitCallback( array( 'Preferences', 'tryFormSubmit' ) );
1091
1092 return $htmlForm;
1093 }
1094
1095 static function getTimezoneOptions() {
1096 $opt = array();
1097
1098 global $wgLocalTZoffset;
1099
1100 $opt[wfMsg( 'timezoneuseserverdefault' )] = "System|$wgLocalTZoffset";
1101 $opt[wfMsg( 'timezoneuseoffset' )] = 'other';
1102 $opt[wfMsg( 'guesstimezone' )] = 'guess';
1103
1104 if ( function_exists( 'timezone_identifiers_list' ) ) {
1105 # Read timezone list
1106 $tzs = timezone_identifiers_list();
1107 sort( $tzs );
1108
1109 $tzRegions = array();
1110 $tzRegions['Africa'] = wfMsg( 'timezoneregion-africa' );
1111 $tzRegions['America'] = wfMsg( 'timezoneregion-america' );
1112 $tzRegions['Antarctica'] = wfMsg( 'timezoneregion-antarctica' );
1113 $tzRegions['Arctic'] = wfMsg( 'timezoneregion-arctic' );
1114 $tzRegions['Asia'] = wfMsg( 'timezoneregion-asia' );
1115 $tzRegions['Atlantic'] = wfMsg( 'timezoneregion-atlantic' );
1116 $tzRegions['Australia'] = wfMsg( 'timezoneregion-australia' );
1117 $tzRegions['Europe'] = wfMsg( 'timezoneregion-europe' );
1118 $tzRegions['Indian'] = wfMsg( 'timezoneregion-indian' );
1119 $tzRegions['Pacific'] = wfMsg( 'timezoneregion-pacific' );
1120 asort( $tzRegions );
1121
1122 $prefill = array_fill_keys( array_values( $tzRegions ), array() );
1123 $opt = array_merge( $opt, $prefill );
1124
1125 $now = date_create( 'now' );
1126
1127 foreach ( $tzs as $tz ) {
1128 $z = explode( '/', $tz, 2 );
1129
1130 # timezone_identifiers_list() returns a number of
1131 # backwards-compatibility entries. This filters them out of the
1132 # list presented to the user.
1133 if ( count( $z ) != 2 || !array_key_exists( $z[0], $tzRegions ) )
1134 continue;
1135
1136 # Localize region
1137 $z[0] = $tzRegions[$z[0]];
1138
1139 $minDiff = floor( timezone_offset_get( timezone_open( $tz ), $now ) / 60 );
1140
1141 $display = str_replace( '_', ' ', $z[0] . '/' . $z[1] );
1142 $value = "ZoneInfo|$minDiff|$tz";
1143
1144 $opt[$z[0]][$display] = $value;
1145 }
1146 }
1147 return $opt;
1148 }
1149
1150 static function filterTimezoneInput( $tz, $alldata ) {
1151 $data = explode( '|', $tz, 3 );
1152 switch ( $data[0] ) {
1153 case 'ZoneInfo':
1154 case 'System':
1155 return $tz;
1156 default:
1157 $data = explode( ':', $tz, 2 );
1158 $minDiff = 0;
1159 if( count( $data ) == 2 ) {
1160 $data[0] = intval( $data[0] );
1161 $data[1] = intval( $data[1] );
1162 $minDiff = abs( $data[0] ) * 60 + $data[1];
1163 if ( $data[0] < 0 ) $minDiff = -$minDiff;
1164 } else {
1165 $minDiff = intval( $data[0] ) * 60;
1166 }
1167
1168 # Max is +14:00 and min is -12:00, see:
1169 # http://en.wikipedia.org/wiki/Timezone
1170 $minDiff = min( $minDiff, 840 ); # 14:00
1171 $minDiff = max( $minDiff, -720 ); # -12:00
1172 return 'Offset|'.$minDiff;
1173 }
1174 }
1175
1176 static function tryFormSubmit( $formData, $entryPoint = 'internal' ) {
1177 global $wgUser, $wgEmailAuthentication, $wgEnableEmail;
1178
1179 $result = true;
1180
1181 // Filter input
1182 foreach( array_keys( $formData ) as $name ) {
1183 if ( isset( self::$saveFilters[$name] ) ) {
1184 $formData[$name] =
1185 call_user_func( self::$saveFilters[$name], $formData[$name], $formData );
1186 }
1187 }
1188
1189 // Stuff that shouldn't be saved as a preference.
1190 $saveBlacklist = array(
1191 'realname',
1192 'emailaddress',
1193 );
1194
1195 if( $wgEnableEmail ) {
1196 $newadr = $formData['emailaddress'];
1197 $oldadr = $wgUser->getEmail();
1198 if( ( $newadr != '' ) && ( $newadr != $oldadr ) ) {
1199 # the user has supplied a new email address on the login page
1200 # new behaviour: set this new emailaddr from login-page into user database record
1201 $wgUser->setEmail( $newadr );
1202 # but flag as "dirty" = unauthenticated
1203 $wgUser->invalidateEmail();
1204 if( $wgEmailAuthentication ) {
1205 # Mail a temporary password to the dirty address.
1206 # User can come back through the confirmation URL to re-enable email.
1207 $result = $wgUser->sendConfirmationMail();
1208 if( WikiError::isError( $result ) ) {
1209 return wfMsg( 'mailerror', htmlspecialchars( $result->getMessage() ) );
1210 } elseif( $entryPoint == 'ui' ) {
1211 $result = 'eauth';
1212 }
1213 }
1214 } else {
1215 $wgUser->setEmail( $newadr );
1216 }
1217 if( $oldadr != $newadr ) {
1218 wfRunHooks( 'PrefsEmailAudit', array( $wgUser, $oldadr, $newadr ) );
1219 }
1220 }
1221
1222 // Fortunately, the realname field is MUCH simpler
1223 global $wgHiddenPrefs;
1224 if ( !in_array( 'realname', $wgHiddenPrefs ) ) {
1225 $realName = $formData['realname'];
1226 $wgUser->setRealName( $realName );
1227 }
1228
1229 foreach( $saveBlacklist as $b )
1230 unset( $formData[$b] );
1231
1232 // Keeps old preferences from interfering due to back-compat
1233 // code, etc.
1234 $wgUser->resetOptions();
1235
1236 foreach( $formData as $key => $value ) {
1237 $wgUser->setOption( $key, $value );
1238 }
1239
1240 $wgUser->saveSettings();
1241
1242 return $result;
1243 }
1244
1245 public static function tryUISubmit( $formData ) {
1246 $res = self::tryFormSubmit( $formData, 'ui' );
1247
1248 if( $res ) {
1249 $urlOptions = array( 'success' );
1250 if( $res === 'eauth' )
1251 $urlOptions[] = 'eauth';
1252
1253 $queryString = implode( '&', $urlOptions );
1254
1255 $url = SpecialPage::getTitleFor( 'Preferences' )->getFullURL( $queryString );
1256 global $wgOut;
1257 $wgOut->redirect( $url );
1258 }
1259
1260 return true;
1261 }
1262
1263 public static function loadOldSearchNs( $user ) {
1264 $searchableNamespaces = SearchEngine::searchableNamespaces();
1265 // Back compat with old format
1266 $arr = array();
1267
1268 foreach( $searchableNamespaces as $ns => $name ) {
1269 if( $user->getOption( 'searchNs' . $ns ) ) {
1270 $arr[] = $ns;
1271 }
1272 }
1273
1274 return $arr;
1275 }
1276 }
1277
1278 /** Some tweaks to allow js prefs to work */
1279 class PreferencesForm extends HTMLForm {
1280
1281 function wrapForm( $html ) {
1282 $html = Xml::tags( 'div', array( 'id' => 'preferences' ), $html );
1283
1284 return parent::wrapForm( $html );
1285 }
1286
1287 function getButtons() {
1288 $html = parent::getButtons();
1289
1290 global $wgUser;
1291
1292 $sk = $wgUser->getSkin();
1293 $t = SpecialPage::getTitleFor( 'Preferences', 'reset' );
1294
1295 $html .= "\n" . $sk->link( $t, wfMsgHtml( 'restoreprefs' ) );
1296
1297 $html = Xml::tags( 'div', array( 'class' => 'mw-prefs-buttons' ), $html );
1298
1299 return $html;
1300 }
1301
1302 function filterDataForSubmit( $data ) {
1303 // Support for separating MultiSelect preferences into multiple preferences
1304 // Due to lack of array support.
1305 foreach( $this->mFlatFields as $fieldname => $field ) {
1306 $info = $field->mParams;
1307 if( $field instanceof HTMLMultiSelectField ) {
1308 $options = HTMLFormField::flattenOptions( $info['options'] );
1309 $prefix = isset( $info['prefix'] ) ? $info['prefix'] : $fieldname;
1310
1311 foreach( $options as $opt ) {
1312 $data["$prefix$opt"] = in_array( $opt, $data[$fieldname] );
1313 }
1314
1315 unset( $data[$fieldname] );
1316 }
1317 }
1318
1319 return $data;
1320 }
1321 }