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