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