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