Oartial revert of r50809. Call the old method names for b/c.
[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->allowRealNameChange() ? '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->allowNickChange() ? '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->allowEmailChange() ? '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 ## Editing #####################################
578 $defaultPreferences['cols'] =
579 array(
580 'type' => 'int',
581 'label-message' => 'columns',
582 'section' => 'editing/textboxsize',
583 'min' => 4,
584 'max' => 1000,
585 );
586 $defaultPreferences['rows'] =
587 array(
588 'type' => 'int',
589 'label-message' => 'rows',
590 'section' => 'editing/textboxsize',
591 'min' => 4,
592 'max' => 1000,
593 );
594 $defaultPreferences['previewontop'] =
595 array(
596 'type' => 'toggle',
597 'section' => 'editing/advancedediting',
598 'label-message' => 'tog-previewontop',
599 );
600 $defaultPreferences['previewonfirst'] =
601 array(
602 'type' => 'toggle',
603 'section' => 'editing/advancedediting',
604 'label-message' => 'tog-previewonfirst',
605 );
606 $defaultPreferences['editsection'] =
607 array(
608 'type' => 'toggle',
609 'section' => 'editing/advancedediting',
610 'label-message' => 'tog-editsection',
611 );
612 $defaultPreferences['editsectiononrightclick'] =
613 array(
614 'type' => 'toggle',
615 'section' => 'editing/advancedediting',
616 'label-message' => 'tog-editsectiononrightclick',
617 );
618 $defaultPreferences['editondblclick'] =
619 array(
620 'type' => 'toggle',
621 'section' => 'editing/advancedediting',
622 'label-message' => 'tog-editondblclick',
623 );
624 $defaultPreferences['editwidth'] =
625 array(
626 'type' => 'toggle',
627 'section' => 'editing/advancedediting',
628 'label-message' => 'tog-editwidth',
629 );
630 $defaultPreferences['showtoolbar'] =
631 array(
632 'type' => 'toggle',
633 'section' => 'editing/advancedediting',
634 'label-message' => 'tog-showtoolbar',
635 );
636 $defaultPreferences['minordefault'] =
637 array(
638 'type' => 'toggle',
639 'section' => 'editing/advancedediting',
640 'label-message' => 'tog-minordefault',
641 );
642
643 global $wgUseExternalEditor;
644 if ($wgUseExternalEditor) {
645 $defaultPreferences['externaleditor'] =
646 array(
647 'type' => 'toggle',
648 'section' => 'editing/advancedediting',
649 'label-message' => 'tog-externaleditor',
650 );
651 }
652
653 global $wgExternalDiffEngine;
654 if ($wgExternalDiffEngine) {
655 $defaultPreferences['externaldiff'] =
656 array(
657 'type' => 'toggle',
658 'section' => 'editing/advancedediting',
659 'label-message' => 'tog-externaldiff',
660 );
661 }
662
663 $defaultPreferences['forceeditsummary'] =
664 array(
665 'type' => 'toggle',
666 'section' => 'editing/advancedediting',
667 'label-message' => 'tog-forceeditsummary',
668 );
669 $defaultPreferences['uselivepreview'] =
670 array(
671 'type' => 'toggle',
672 'section' => 'editing/advancedediting',
673 'label-message' => 'tog-uselivepreview',
674 );
675 }
676
677 static function rcPreferences( $user, &$defaultPreferences ) {
678 global $wgRCMaxAge, $wgUseRCPatrol;
679 ## RecentChanges #####################################
680 $defaultPreferences['rcdays'] =
681 array(
682 'type' => 'int',
683 'label-message' => 'recentchangesdays',
684 'section' => 'rc/display',
685 'min' => 1,
686 'max' => ceil($wgRCMaxAge / (3600*24)),
687 );
688 $defaultPreferences['rclimit'] =
689 array(
690 'type' => 'int',
691 'label-message' => 'recentchangescount',
692 'help-message' => 'prefs-help-recentchangescount',
693 'section' => 'rc/display',
694 );
695 $defaultPreferences['usenewrc'] =
696 array(
697 'type' => 'toggle',
698 'label-message' => 'tog-usenewrc',
699 'section' => 'rc/advancedrc',
700 );
701 $defaultPreferences['hideminor'] =
702 array(
703 'type' => 'toggle',
704 'label-message' => 'tog-hideminor',
705 'section' => 'rc/advancedrc',
706 );
707
708 global $wgUseRCPatrol;
709 if ($wgUseRCPatrol) {
710 $defaultPreferences['hidepatrolled'] =
711 array(
712 'type' => 'toggle',
713 'section' => 'rc/advancedrc',
714 'label-message' => 'tog-hidepatrolled',
715 );
716 $defaultPreferences['newpageshidepatrolled'] =
717 array(
718 'type' => 'toggle',
719 'section' => 'rc/advancedrc',
720 'label-message' => 'tog-newpageshidepatrolled',
721 );
722 }
723
724 global $wgRCShowWatchingUsers;
725 if ($wgRCShowWatchingUsers) {
726 $defaultPreferences['shownumberswatching'] =
727 array(
728 'type' => 'toggle',
729 'section' => 'rc/advancedrc',
730 'label-message' => 'tog-shownumberswatching',
731 );
732 }
733 }
734
735 static function watchlistPreferences( $user, &$defaultPreferences ) {
736 global $wgUseRCPatrol;
737 ## Watchlist #####################################
738 $defaultPreferences['watchlistdays'] =
739 array(
740 'type' => 'int',
741 'min' => 0,
742 'max' => 7,
743 'section' => 'watchlist/display',
744 'label-message' => 'prefs-watchlist-days',
745 );
746 $defaultPreferences['wllimit'] =
747 array(
748 'type' => 'int',
749 'min' => 0,
750 'max' => 1000,
751 'label-message' => 'prefs-watchlist-edits',
752 'section' => 'watchlist/display'
753 );
754 $defaultPreferences['extendwatchlist'] =
755 array(
756 'type' => 'toggle',
757 'section' => 'watchlist/advancedwatchlist',
758 'label-message' => 'tog-extendwatchlist',
759 );
760 $defaultPreferences['watchlisthideminor'] =
761 array(
762 'type' => 'toggle',
763 'section' => 'watchlist/advancedwatchlist',
764 'label-message' => 'tog-watchlisthideminor',
765 );
766 $defaultPreferences['watchlisthidebots'] =
767 array(
768 'type' => 'toggle',
769 'section' => 'watchlist/advancedwatchlist',
770 'label-message' => 'tog-watchlisthidebots',
771 );
772 $defaultPreferences['watchlisthideown'] =
773 array(
774 'type' => 'toggle',
775 'section' => 'watchlist/advancedwatchlist',
776 'label-message' => 'tog-watchlisthideown',
777 );
778 $defaultPreferences['watchlisthideanons'] =
779 array(
780 'type' => 'toggle',
781 'section' => 'watchlist/advancedwatchlist',
782 'label-message' => 'tog-watchlisthideanons',
783 );
784 $defaultPreferences['watchlisthideliu'] =
785 array(
786 'type' => 'toggle',
787 'section' => 'watchlist/advancedwatchlist',
788 'label-message' => 'tog-watchlisthideliu',
789 );
790
791 if ( $wgUseRCPatrol ) {
792 $defaultPreferences['watchlisthidepatrolled'] =
793 array(
794 'type' => 'toggle',
795 'section' => 'watchlist/advancedwatchlist',
796 'label-message' => 'tog-watchlisthidepatrolled',
797 );
798 }
799
800 $watchTypes = array( 'edit' => 'watchdefault',
801 'move' => 'watchmoves',
802 'delete' => 'watchdeletion' );
803
804 // Kinda hacky
805 if( $user->isAllowed( 'createpage' ) || $user->isAllowed( 'createtalk' ) ) {
806 $watchTypes['read'] = 'watchcreations';
807 }
808
809 foreach( $watchTypes as $action => $pref ) {
810 if ( $user->isAllowed( $action ) ) {
811 $defaultPreferences[$pref] = array(
812 'type' => 'toggle',
813 'section' => 'watchlist/advancedwatchlist',
814 'label-message' => "tog-$pref",
815 );
816 }
817 }
818 }
819
820 static function searchPreferences( $user, &$defaultPreferences ) {
821 global $wgContLang;
822
823 ## Search #####################################
824 $defaultPreferences['searchlimit'] =
825 array(
826 'type' => 'int',
827 'label-message' => 'resultsperpage',
828 'section' => 'searchoptions/display',
829 'min' => 0,
830 );
831 $defaultPreferences['contextlines'] =
832 array(
833 'type' => 'int',
834 'label-message' => 'contextlines',
835 'section' => 'searchoptions/display',
836 'min' => 0,
837 );
838 $defaultPreferences['contextchars'] =
839 array(
840 'type' => 'int',
841 'label-message' => 'contextchars',
842 'section' => 'searchoptions/display',
843 'min' => 0,
844 );
845 global $wgEnableMWSuggest;
846 if ($wgEnableMWSuggest) {
847 $defaultPreferences['disablesuggest'] =
848 array(
849 'type' => 'toggle',
850 'label-message' => 'mwsuggest-disable',
851 'section' => 'searchoptions/display',
852 );
853 }
854
855 $defaultPreferences['searcheverything'] =
856 array(
857 'type' => 'toggle',
858 'label-message' => 'searcheverything-enable',
859 'section' => 'searchoptions/advancedsearchoptions',
860 );
861
862 // Searchable namespaces back-compat with old format
863 $searchableNamespaces = SearchEngine::searchableNamespaces();
864
865 $nsOptions = array();
866 foreach( $wgContLang->getNamespaces() as $ns => $name ) {
867 if ($ns < 0) continue;
868 $displayNs = str_replace( '_', ' ', $name );
869
870 if (!$displayNs) $displayNs = wfMsg( 'blanknamespace' );
871
872 $displayNs = htmlspecialchars( $displayNs );
873 $nsOptions[$displayNs] = $ns;
874 }
875
876 $defaultPreferences['searchnamespaces'] =
877 array(
878 'type' => 'multiselect',
879 'label-message' => 'defaultns',
880 'options' => $nsOptions,
881 'section' => 'searchoptions/advancedsearchoptions',
882 'prefix' => 'searchNs',
883 );
884
885
886
887 }
888
889 static function miscPreferences( $user, &$defaultPreferences ) {
890 ## Misc #####################################
891 $defaultPreferences['diffonly'] =
892 array(
893 'type' => 'toggle',
894 'section' => 'misc/diffs',
895 'label-message' => 'tog-diffonly',
896 );
897 $defaultPreferences['norollbackdiff'] =
898 array(
899 'type' => 'toggle',
900 'section' => 'misc/diffs',
901 'label-message' => 'tog-norollbackdiff',
902 );
903
904 // Stuff from Language::getExtraUserToggles()
905 global $wgContLang;
906
907 $toggles = $wgContLang->getExtraUserToggles();
908
909 foreach( $toggles as $toggle ) {
910 $defaultPreferences[$toggle] =
911 array(
912 'type' => 'toggle',
913 'section' => 'personal/i18n',
914 'label-message' => "tog-$toggle",
915 );
916 }
917 }
918
919 static function generateSkinOptions( $user ) {
920 global $wgDefaultSkin;
921 $ret = array();
922
923 $mptitle = Title::newMainPage();
924 $previewtext = wfMsgHtml( 'skin-preview' );
925 # Only show members of Skin::getSkinNames() rather than
926 # $skinNames (skins is all skin names from Language.php)
927 $validSkinNames = Skin::getUsableSkins();
928 # Sort by UI skin name. First though need to update validSkinNames as sometimes
929 # the skinkey & UI skinname differ (e.g. "standard" skinkey is "Classic" in the UI).
930 foreach ( $validSkinNames as $skinkey => &$skinname ) {
931 $msgName = "skinname-{$skinkey}";
932 $localisedSkinName = wfMsg( $msgName );
933 if ( !wfEmptyMsg( $msgName, $localisedSkinName ) ) {
934 $skinname = htmlspecialchars($localisedSkinName);
935 }
936 }
937 asort($validSkinNames);
938 $sk = $user->getSkin();
939
940 foreach( $validSkinNames as $skinkey => $sn ) {
941 $mplink = htmlspecialchars( $mptitle->getLocalURL( "useskin=$skinkey" ) );
942 $previewlink = "(<a target='_blank' href=\"$mplink\">$previewtext</a>)";
943 $extraLinks = '';
944 global $wgAllowUserCss, $wgAllowUserJs;
945 if( $wgAllowUserCss ) {
946 $cssPage = Title::makeTitleSafe( NS_USER, $user->getName().'/'.$skinkey.'.css' );
947 $customCSS = $sk->link( $cssPage, wfMsgHtml( 'prefs-custom-css' ) );
948 $extraLinks .= " ($customCSS)";
949 }
950 if( $wgAllowUserJs ) {
951 $jsPage = Title::makeTitleSafe( NS_USER, $user->getName().'/'.$skinkey.'.js' );
952 $customJS = $sk->link( $jsPage, wfMsgHtml( 'prefs-custom-js' ) );
953 $extraLinks .= " ($customJS)";
954 }
955 if( $skinkey == $wgDefaultSkin )
956 $sn .= ' (' . wfMsgHtml( 'default' ) . ')';
957 $display = "$sn $previewlink{$extraLinks}";
958 $ret[$display] = $skinkey;
959 }
960
961 return $ret;
962 }
963
964 static function getDateOptions() {
965 global $wgLang;
966 $dateopts = $wgLang->getDatePreferences();
967
968 $ret = array();
969
970 if ($dateopts) {
971 $idCnt = 0;
972 $epoch = '20010115161234'; # Wikipedia day
973 foreach( $dateopts as $key ) {
974 if( $key == 'default' ) {
975 $formatted = wfMsgHtml( 'datedefault' );
976 } else {
977 $formatted = htmlspecialchars($wgLang->timeanddate( $epoch, false, $key ));
978 }
979 $ret[$formatted] = $key;
980 }
981 }
982 return $ret;
983 }
984
985 static function getImageSizes() {
986 global $wgImageLimits;
987
988 $ret = array();
989
990 foreach ( $wgImageLimits as $index => $limits ) {
991 $display = "{$limits[0]}×{$limits[1]}" . wfMsg('unit-pixel');
992 $ret[$display] = $index;
993 }
994
995 return $ret;
996 }
997
998 static function getThumbSizes() {
999 global $wgThumbLimits;
1000
1001 $ret = array();
1002
1003 foreach ( $wgThumbLimits as $index => $size ) {
1004 $display = $size . wfMsg('unit-pixel');
1005 $ret[$display] = $index;
1006 }
1007
1008 return $ret;
1009 }
1010
1011 static function validateSignature( $signature, $alldata ) {
1012 global $wgParser, $wgMaxSigChars, $wgLang;
1013 if( mb_strlen( $signature ) > $wgMaxSigChars ) {
1014 return
1015 Xml::element( 'span', array( 'class' => 'error' ),
1016 wfMsgExt( 'badsiglength', 'parsemag',
1017 $wgLang->formatNum( $wgMaxSigChars )
1018 )
1019 );
1020 } elseif( !empty( $alldata['fancysig'] ) &&
1021 false === $wgParser->validateSig( $signature ) ) {
1022 return Xml::element( 'span', array( 'class' => 'error' ), wfMsg( 'badsig' ) );
1023 } else {
1024 return true;
1025 }
1026 }
1027
1028 static function cleanSignature( $signature, $alldata ) {
1029 global $wgParser;
1030 if( $alldata['fancysig'] ) {
1031 $signature = $wgParser->cleanSig( $signature );
1032 } else {
1033 // When no fancy sig used, make sure ~{3,5} get removed.
1034 $signature = $wgParser->cleanSigInSig( $signature );
1035 }
1036
1037 return $signature;
1038 }
1039
1040 static function validateEmail( $email, $alldata ) {
1041 if ( $email && !User::isValidEmailAddr( $email ) ) {
1042 return wfMsgExt( 'invalidemailaddress', 'parseinline' );
1043 }
1044
1045 global $wgEmailConfirmToEdit;
1046 if( $wgEmailConfirmToEdit && !$email ) {
1047 return wfMsgExt( 'noemailtitle', 'parseinline' );
1048 }
1049 return true;
1050 }
1051
1052 static function getFormObject( $user ) {
1053 $formDescriptor = Preferences::getPreferences( $user );
1054 $htmlForm = new PreferencesForm( $formDescriptor, 'prefs' );
1055
1056 $htmlForm->setSubmitText( wfMsg('saveprefs') );
1057 $htmlForm->setTitle( SpecialPage::getTitleFor( 'Preferences' ) );
1058 $htmlForm->setSubmitID( 'prefsubmit' );
1059 $htmlForm->setSubmitCallback( array( 'Preferences', 'tryFormSubmit' ) );
1060
1061 return $htmlForm;
1062 }
1063
1064 static function getTimezoneOptions() {
1065 $opt = array();
1066
1067 global $wgLocalTZoffset;
1068
1069 $opt[wfMsg( 'timezoneuseserverdefault' )] = "System|$wgLocalTZoffset";
1070 $opt[wfMsg( 'timezoneuseoffset' )] = 'other';
1071 $opt[wfMsg( 'guesstimezone' )] = 'guess';
1072
1073 if ( function_exists( 'timezone_identifiers_list' ) ) {
1074 # Read timezone list
1075 $tzs = timezone_identifiers_list();
1076 sort( $tzs );
1077
1078 $tzRegions = array();
1079 $tzRegions['Africa'] = wfMsg( 'timezoneregion-africa' );
1080 $tzRegions['America'] = wfMsg( 'timezoneregion-america' );
1081 $tzRegions['Antarctica'] = wfMsg( 'timezoneregion-antarctica' );
1082 $tzRegions['Arctic'] = wfMsg( 'timezoneregion-arctic' );
1083 $tzRegions['Asia'] = wfMsg( 'timezoneregion-asia' );
1084 $tzRegions['Atlantic'] = wfMsg( 'timezoneregion-atlantic' );
1085 $tzRegions['Australia'] = wfMsg( 'timezoneregion-australia' );
1086 $tzRegions['Europe'] = wfMsg( 'timezoneregion-europe' );
1087 $tzRegions['Indian'] = wfMsg( 'timezoneregion-indian' );
1088 $tzRegions['Pacific'] = wfMsg( 'timezoneregion-pacific' );
1089 asort( $tzRegions );
1090
1091 $prefill = array_fill_keys( array_values($tzRegions), array() );
1092 $opt = array_merge( $opt, $prefill );
1093
1094 $now = date_create( 'now' );
1095
1096 foreach ( $tzs as $tz ) {
1097 $z = explode( '/', $tz, 2 );
1098
1099 # timezone_identifiers_list() returns a number of
1100 # backwards-compatibility entries. This filters them out of the
1101 # list presented to the user.
1102 if ( count( $z ) != 2 || !array_key_exists( $z[0], $tzRegions ) )
1103 continue;
1104
1105 # Localize region
1106 $z[0] = $tzRegions[$z[0]];
1107
1108 $minDiff = floor( timezone_offset_get( timezone_open( $tz ), $now ) / 60 );
1109
1110 $display = str_replace( '_', ' ', $z[0] . '/' . $z[1] );
1111 $value = "ZoneInfo|$minDiff|$tz";
1112
1113 $opt[$z[0]][$display] = $value;
1114 }
1115 }
1116 return $opt;
1117 }
1118
1119 static function filterTimezoneInput( $tz, $alldata ) {
1120 $data = explode( '|', $tz, 3 );
1121 switch ( $data[0] ) {
1122 case 'ZoneInfo':
1123 case 'System':
1124 return $tz;
1125 default:
1126 $data = explode( ':', $tz, 2 );
1127 $minDiff = 0;
1128 if( count( $data ) == 2 ) {
1129 $data[0] = intval( $data[0] );
1130 $data[1] = intval( $data[1] );
1131 $minDiff = abs( $data[0] ) * 60 + $data[1];
1132 if ( $data[0] < 0 ) $minDiff = -$minDiff;
1133 } else {
1134 $minDiff = intval( $data[0] ) * 60;
1135 }
1136
1137 # Max is +14:00 and min is -12:00, see:
1138 # http://en.wikipedia.org/wiki/Timezone
1139 $minDiff = min( $minDiff, 840 ); # 14:00
1140 $minDiff = max( $minDiff, -720 ); # -12:00
1141 return 'Offset|'.$minDiff;
1142 }
1143 }
1144
1145 static function tryFormSubmit( $formData, $entryPoint = 'internal' ) {
1146 global $wgUser, $wgEmailAuthentication, $wgEnableEmail;
1147
1148 $result = true;
1149
1150 // Filter input
1151 foreach( array_keys($formData) as $name ) {
1152 if ( isset(self::$saveFilters[$name]) ) {
1153 $formData[$name] =
1154 call_user_func( self::$saveFilters[$name], $formData[$name], $formData );
1155 }
1156 }
1157
1158 // Stuff that shouldn't be saved as a preference.
1159 $saveBlacklist = array(
1160 'realname',
1161 'emailaddress',
1162 );
1163
1164 if( $wgEnableEmail ) {
1165 $newadr = $formData['emailaddress'];
1166 $oldadr = $wgUser->getEmail();
1167 if( ($newadr != '') && ($newadr != $oldadr) ) {
1168 # the user has supplied a new email address on the login page
1169 # new behaviour: set this new emailaddr from login-page into user database record
1170 $wgUser->setEmail( $newadr );
1171 # but flag as "dirty" = unauthenticated
1172 $wgUser->invalidateEmail();
1173 if ($wgEmailAuthentication) {
1174 # Mail a temporary password to the dirty address.
1175 # User can come back through the confirmation URL to re-enable email.
1176 $result = $wgUser->sendConfirmationMail();
1177 if( WikiError::isError( $result ) ) {
1178 return wfMsg( 'mailerror', htmlspecialchars( $result->getMessage() ) );
1179 } elseif ($entryPoint == 'ui') {
1180 $result = 'eauth';
1181 }
1182 }
1183 } else {
1184 $wgUser->setEmail( $newadr );
1185 }
1186 if( $oldadr != $newadr ) {
1187 wfRunHooks( 'PrefsEmailAudit', array( $wgUser, $oldadr, $newadr ) );
1188 }
1189 }
1190
1191 // Fortunately, the realname field is MUCH simpler
1192 global $wgHiddenPrefs;
1193 if ( !in_array( 'realname', $wgHiddenPrefs ) ) {
1194 $realName = $formData['realname'];
1195 $wgUser->setRealName( $realName );
1196 }
1197
1198 foreach( $saveBlacklist as $b )
1199 unset( $formData[$b] );
1200
1201 // Keeps old preferences from interfering due to back-compat
1202 // code, etc.
1203 $wgUser->resetOptions();
1204
1205 foreach( $formData as $key => $value ) {
1206 $wgUser->setOption( $key, $value );
1207 }
1208
1209 $wgUser->saveSettings();
1210
1211 return $result;
1212 }
1213
1214 public static function tryUISubmit( $formData ) {
1215 $res = self::tryFormSubmit( $formData, 'ui' );
1216
1217 if ($res) {
1218 $urlOptions = array( 'success' );
1219 if ($res === 'eauth')
1220 $urlOptions[] = 'eauth';
1221
1222 $queryString = implode( '&', $urlOptions );
1223
1224 $url = SpecialPage::getTitleFor( 'Preferences' )->getFullURL( $queryString );
1225 global $wgOut;
1226 $wgOut->redirect( $url );
1227 }
1228
1229 return true;
1230 }
1231
1232 public static function loadOldSearchNs( $user ) {
1233 $searchableNamespaces = SearchEngine::searchableNamespaces();
1234 // Back compat with old format
1235 $arr = array();
1236
1237 foreach( $searchableNamespaces as $ns => $name ) {
1238 if( $user->getOption( 'searchNs' . $ns ) ) {
1239 $arr[] = $ns;
1240 }
1241 }
1242
1243 return $arr;
1244 }
1245 }
1246
1247 /** Some tweaks to allow js prefs to work */
1248 class PreferencesForm extends HTMLForm {
1249
1250 function wrapForm( $html ) {
1251 $html = Xml::tags( 'div', array( 'id' => 'preferences' ), $html );
1252
1253 return parent::wrapForm( $html );
1254 }
1255
1256 function getButtons() {
1257 $html = parent::getButtons();
1258
1259 global $wgUser;
1260
1261 $sk = $wgUser->getSkin();
1262 $t = SpecialPage::getTitleFor( 'Preferences', 'reset' );
1263
1264 $html .= "\n" . $sk->link( $t, wfMsgHtml( 'restoreprefs' ) );
1265
1266 $html = Xml::tags( 'div', array( 'class' => 'mw-prefs-buttons' ), $html );
1267
1268 return $html;
1269 }
1270
1271 function filterDataForSubmit( $data ) {
1272 // Support for separating MultiSelect preferences into multiple preferences
1273 // Due to lack of array support.
1274 foreach( $this->mFlatFields as $fieldname => $field ) {
1275 $info = $field->mParams;
1276 if ($field instanceof HTMLMultiSelectField) {
1277 $options = HTMLFormField::flattenOptions( $info['options'] );
1278 $prefix = isset($info['prefix']) ? $info['prefix'] : $fieldname;
1279
1280 foreach( $options as $opt ) {
1281 $data["$prefix$opt"] = in_array( $opt, $data[$fieldname] );
1282 }
1283
1284 unset( $data[$fieldname] );
1285 }
1286 }
1287
1288 return $data;
1289 }
1290 }