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