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