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