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