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