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