New search option:
[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, $wgEnableVariants;
217 /* see if there are multiple language variants to choose from*/
218 $variantArray = array();
219 if($wgEnableVariants) {
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 && $wgEnableVariants && !$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 $defaultPreferences['skin'] =
383 array(
384 'type' => 'radio',
385 'options' => self::generateSkinOptions( $user ),
386 'label' => '&nbsp;',
387 'section' => 'rendering/skin',
388 );
389
390 $selectedSkin = $user->getOption( 'skin' );
391 if ( in_array( $selectedSkin, array( 'cologneblue', 'standard' ) ) ) {
392 global $wgLang;
393 $settings = array_flip($wgLang->getQuickbarSettings());
394
395 $defaultPreferences['quickbar'] =
396 array(
397 'type' => 'radio',
398 'options' => $settings,
399 'section' => 'rendering/skin',
400 'label-message' => 'qbsettings',
401 );
402 }
403 }
404
405 static function mathPreferences( $user, &$defaultPreferences ) {
406 ## Math #####################################
407 global $wgUseTeX, $wgLang;
408 if ($wgUseTeX) {
409 $defaultPreferences['math'] =
410 array(
411 'type' => 'radio',
412 'options' =>
413 array_flip( array_map( 'wfMsgHtml', $wgLang->getMathNames() ) ),
414 'label' => '&nbsp;',
415 'section' => 'rendering/math',
416 );
417 }
418 }
419
420 static function filesPreferences( $user, &$defaultPreferences ) {
421 ## Files #####################################
422 $defaultPreferences['imagesize'] =
423 array(
424 'type' => 'select',
425 'options' => self::getImageSizes(),
426 'label-message' => 'imagemaxsize',
427 'section' => 'rendering/files',
428 );
429 $defaultPreferences['thumbsize'] =
430 array(
431 'type' => 'select',
432 'options' => self::getThumbSizes(),
433 'label-message' => 'thumbsize',
434 'section' => 'rendering/files',
435 );
436 }
437
438 static function datetimePreferences( $user, &$defaultPreferences ) {
439 global $wgLang;
440
441 ## Date and time #####################################
442 $dateOptions = self::getDateOptions();
443 if ($dateOptions) {
444 $defaultPreferences['date'] =
445 array(
446 'type' => 'radio',
447 'options' => $dateOptions,
448 'label' => '&nbsp;',
449 'section' => 'datetime/dateformat',
450 );
451 }
452
453 // Info
454 $nowlocal = Xml::element( 'span', array( 'id' => 'wpLocalTime' ),
455 $wgLang->time( $now = wfTimestampNow(), true ) );
456 $nowserver = $wgLang->time( $now, false ) .
457 Xml::hidden( 'wpServerTime', substr( $now, 8, 2 ) * 60 + substr( $now, 10, 2 ) );
458
459 $defaultPreferences['nowserver'] =
460 array(
461 'type' => 'info',
462 'raw' => 1,
463 'label-message' => 'servertime',
464 'default' => $nowserver,
465 'section' => 'datetime/timeoffset',
466 );
467
468 $defaultPreferences['nowlocal'] =
469 array(
470 'type' => 'info',
471 'raw' => 1,
472 'label-message' => 'localtime',
473 'default' => $nowlocal,
474 'section' => 'datetime/timeoffset',
475 );
476
477 // Grab existing pref.
478 $tzOffset = $user->getOption( 'timecorrection' );
479 $tz = explode( '|', $tzOffset, 2 );
480
481 $tzSetting = $tzOffset;
482 if (count($tz) > 1 && $tz[0] == 'Offset') {
483 $minDiff = $tz[1];
484 $tzSetting = sprintf( '%+03d:%02d', floor($minDiff/60), abs($minDiff)%60 );;
485 }
486
487 $defaultPreferences['timecorrection'] =
488 array(
489 'class' => 'HTMLSelectOrOtherField',
490 'label-message' => 'timezonelegend',
491 'options' => self::getTimezoneOptions(),
492 'default' => $tzSetting,
493 'section' => 'datetime/timeoffset',
494 );
495 }
496
497 static function renderingPreferences( $user, &$defaultPreferences ) {
498 ## Page Rendering ##############################
499 $defaultPreferences['underline'] =
500 array(
501 'type' => 'select',
502 'options' => array(
503 wfMsg( 'underline-never' ) => 0,
504 wfMsg( 'underline-always' ) => 1,
505 wfMsg( 'underline-default' ) => 2,
506 ),
507 'label-message' => 'tog-underline',
508 'section' => 'rendering/advancedrendering',
509 );
510
511 $stubThresholdValues = array( 0, 50, 100, 500, 1000, 2000, 5000, 10000 );
512 $stubThresholdOptions = array();
513 foreach( $stubThresholdValues as $value ) {
514 $stubThresholdOptions[wfMsg( 'size-bytes', $value )] = $value;
515 }
516
517 $defaultPreferences['stubthreshold'] =
518 array(
519 'type' => 'selectorother',
520 'section' => 'rendering/advancedrendering',
521 'options' => $stubThresholdOptions,
522 'label' => wfMsg('stub-threshold'), // Raw HTML message. Yay?
523 );
524 $defaultPreferences['highlightbroken'] =
525 array(
526 'type' => 'toggle',
527 'section' => 'rendering/advancedrendering',
528 'label' => wfMsg('tog-highlightbroken'), // Raw HTML
529 );
530 $defaultPreferences['showtoc'] =
531 array(
532 'type' => 'toggle',
533 'section' => 'rendering/advancedrendering',
534 'label-message' => 'tog-showtoc',
535 );
536 $defaultPreferences['nocache'] =
537 array(
538 'type' => 'toggle',
539 'label-message' => 'tog-nocache',
540 'section' => 'rendering/advancedrendering',
541 );
542 $defaultPreferences['showhiddencats'] =
543 array(
544 'type' => 'toggle',
545 'section' => 'rendering/advancedrendering',
546 'label-message' => 'tog-showhiddencats'
547 );
548 $defaultPreferences['showjumplinks'] =
549 array(
550 'type' => 'toggle',
551 'section' => 'rendering/advancedrendering',
552 'label-message' => 'tog-showjumplinks',
553 );
554 $defaultPreferences['justify'] =
555 array(
556 'type' => 'toggle',
557 'section' => 'rendering/advancedrendering',
558 'label-message' => 'tog-justify',
559 );
560 $defaultPreferences['numberheadings'] =
561 array(
562 'type' => 'toggle',
563 'section' => 'rendering/advancedrendering',
564 'label-message' => 'tog-numberheadings',
565 );
566 }
567
568 static function editingPreferences( $user, &$defaultPreferences ) {
569 ## Editing #####################################
570 $defaultPreferences['cols'] =
571 array(
572 'type' => 'int',
573 'label-message' => 'columns',
574 'section' => 'editing/textboxsize',
575 'min' => 4,
576 'max' => 1000,
577 );
578 $defaultPreferences['rows'] =
579 array(
580 'type' => 'int',
581 'label-message' => 'rows',
582 'section' => 'editing/textboxsize',
583 'min' => 4,
584 'max' => 1000,
585 );
586 $defaultPreferences['previewontop'] =
587 array(
588 'type' => 'toggle',
589 'section' => 'editing/advancedediting',
590 'label-message' => 'tog-previewontop',
591 );
592 $defaultPreferences['previewonfirst'] =
593 array(
594 'type' => 'toggle',
595 'section' => 'editing/advancedediting',
596 'label-message' => 'tog-previewonfirst',
597 );
598 $defaultPreferences['editsection'] =
599 array(
600 'type' => 'toggle',
601 'section' => 'editing/advancedediting',
602 'label-message' => 'tog-editsection',
603 );
604 $defaultPreferences['editsectiononrightclick'] =
605 array(
606 'type' => 'toggle',
607 'section' => 'editing/advancedediting',
608 'label-message' => 'tog-editsectiononrightclick',
609 );
610 $defaultPreferences['editondblclick'] =
611 array(
612 'type' => 'toggle',
613 'section' => 'editing/advancedediting',
614 'label-message' => 'tog-editondblclick',
615 );
616 $defaultPreferences['editwidth'] =
617 array(
618 'type' => 'toggle',
619 'section' => 'editing/advancedediting',
620 'label-message' => 'tog-editwidth',
621 );
622 $defaultPreferences['showtoolbar'] =
623 array(
624 'type' => 'toggle',
625 'section' => 'editing/advancedediting',
626 'label-message' => 'tog-showtoolbar',
627 );
628 $defaultPreferences['minordefault'] =
629 array(
630 'type' => 'toggle',
631 'section' => 'editing/advancedediting',
632 'label-message' => 'tog-minordefault',
633 );
634 $defaultPreferences['externaleditor'] =
635 array(
636 'type' => 'toggle',
637 'section' => 'editing/advancedediting',
638 'label-message' => 'tog-externaleditor',
639 );
640 $defaultPreferences['externaldiff'] =
641 array(
642 'type' => 'toggle',
643 'section' => 'editing/advancedediting',
644 'label-message' => 'tog-externaldiff',
645 );
646 $defaultPreferences['forceeditsummary'] =
647 array(
648 'type' => 'toggle',
649 'section' => 'editing/advancedediting',
650 'label-message' => 'tog-forceeditsummary',
651 );
652 $defaultPreferences['uselivepreview'] =
653 array(
654 'type' => 'toggle',
655 'section' => 'editing/advancedediting',
656 'label-message' => 'tog-uselivepreview',
657 );
658 }
659
660 static function rcPreferences( $user, &$defaultPreferences ) {
661 global $wgRCMaxAge, $wgUseRCPatrol;
662 ## RecentChanges #####################################
663 $defaultPreferences['rcdays'] =
664 array(
665 'type' => 'int',
666 'label-message' => 'recentchangesdays',
667 'section' => 'rc/display',
668 'min' => 1,
669 'max' => ceil($wgRCMaxAge / (3600*24)),
670 );
671 $defaultPreferences['rclimit'] =
672 array(
673 'type' => 'int',
674 'label-message' => 'recentchangescount',
675 'help-message' => 'prefs-help-recentchangescount',
676 'section' => 'rc/display',
677 );
678 $defaultPreferences['usenewrc'] =
679 array(
680 'type' => 'toggle',
681 'label-message' => 'tog-usenewrc',
682 'section' => 'rc/advancedrc',
683 );
684 $defaultPreferences['hideminor'] =
685 array(
686 'type' => 'toggle',
687 'label-message' => 'tog-hideminor',
688 'section' => 'rc/advancedrc',
689 );
690
691 global $wgUseRCPatrol;
692 if ($wgUseRCPatrol) {
693 $defaultPreferences['hidepatrolled'] =
694 array(
695 'type' => 'toggle',
696 'section' => 'rc/advancedrc',
697 'label-message' => 'tog-hidepatrolled',
698 );
699 $defaultPreferences['newpageshidepatrolled'] =
700 array(
701 'type' => 'toggle',
702 'section' => 'rc/advancedrc',
703 'label-message' => 'tog-newpageshidepatrolled',
704 );
705 }
706
707 global $wgRCShowWatchingUsers;
708 if ($wgRCShowWatchingUsers) {
709 $defaultPreferences['shownumberswatching'] =
710 array(
711 'type' => 'toggle',
712 'section' => 'rc/advancedrc',
713 'label-message' => 'tog-shownumberswatching',
714 );
715 }
716 }
717
718 static function watchlistPreferences( $user, &$defaultPreferences ) {
719 global $wgUseRCPatrol;
720 ## Watchlist #####################################
721 $defaultPreferences['watchlistdays'] =
722 array(
723 'type' => 'int',
724 'min' => 0,
725 'max' => 7,
726 'section' => 'watchlist/display',
727 'label-message' => 'prefs-watchlist-days',
728 );
729 $defaultPreferences['wllimit'] =
730 array(
731 'type' => 'int',
732 'min' => 0,
733 'max' => 1000,
734 'label-message' => 'prefs-watchlist-edits',
735 'section' => 'watchlist/display'
736 );
737 $defaultPreferences['extendwatchlist'] =
738 array(
739 'type' => 'toggle',
740 'section' => 'watchlist/advancedwatchlist',
741 'label-message' => 'tog-extendwatchlist',
742 );
743 $defaultPreferences['watchlisthideminor'] =
744 array(
745 'type' => 'toggle',
746 'section' => 'watchlist/advancedwatchlist',
747 'label-message' => 'tog-watchlisthideminor',
748 );
749 $defaultPreferences['watchlisthidebots'] =
750 array(
751 'type' => 'toggle',
752 'section' => 'watchlist/advancedwatchlist',
753 'label-message' => 'tog-watchlisthidebots',
754 );
755 $defaultPreferences['watchlisthideown'] =
756 array(
757 'type' => 'toggle',
758 'section' => 'watchlist/advancedwatchlist',
759 'label-message' => 'tog-watchlisthideown',
760 );
761 $defaultPreferences['watchlisthideanons'] =
762 array(
763 'type' => 'toggle',
764 'section' => 'watchlist/advancedwatchlist',
765 'label-message' => 'tog-watchlisthideanons',
766 );
767 $defaultPreferences['watchlisthideliu'] =
768 array(
769 'type' => 'toggle',
770 'section' => 'watchlist/advancedwatchlist',
771 'label-message' => 'tog-watchlisthideliu',
772 );
773
774 if ( $wgUseRCPatrol ) {
775 $defaultPreferences['watchlisthidepatrolled'] =
776 array(
777 'type' => 'toggle',
778 'section' => 'watchlist/advancedwatchlist',
779 'label-message' => 'tog-watchlisthidepatrolled',
780 );
781 }
782
783 $watchTypes = array( 'edit' => 'watchdefault',
784 'move' => 'watchmoves',
785 'delete' => 'watchdeletion' );
786
787 // Kinda hacky
788 if( $user->isAllowed( 'createpage' ) || $user->isAllowed( 'createtalk' ) ) {
789 $watchTypes['read'] = 'watchcreations';
790 }
791
792 foreach( $watchTypes as $action => $pref ) {
793 if ( $user->isAllowed( $action ) ) {
794 $defaultPreferences[$pref] = array(
795 'type' => 'toggle',
796 'section' => 'watchlist/advancedwatchlist',
797 'label-message' => "tog-$pref",
798 );
799 }
800 }
801 }
802
803 static function searchPreferences( $user, &$defaultPreferences ) {
804 global $wgContLang;
805
806 ## Search #####################################
807 $defaultPreferences['searchlimit'] =
808 array(
809 'type' => 'int',
810 'label-message' => 'resultsperpage',
811 'section' => 'searchoptions/display',
812 'min' => 0,
813 );
814 $defaultPreferences['contextlines'] =
815 array(
816 'type' => 'int',
817 'label-message' => 'contextlines',
818 'section' => 'searchoptions/display',
819 'min' => 0,
820 );
821 $defaultPreferences['contextchars'] =
822 array(
823 'type' => 'int',
824 'label-message' => 'contextchars',
825 'section' => 'searchoptions/display',
826 'min' => 0,
827 );
828 global $wgEnableMWSuggest;
829 if ($wgEnableMWSuggest) {
830 $defaultPreferences['disablesuggest'] =
831 array(
832 'type' => 'toggle',
833 'label-message' => 'mwsuggest-disable',
834 'section' => 'searchoptions/display',
835 );
836 }
837
838 $defaultPreferences['searcheverything'] =
839 array(
840 'type' => 'toggle',
841 'label-message' => 'searcheverything-enable',
842 'section' => 'searchoptions/advancedsearchoptions',
843 );
844
845 // Searchable namespaces back-compat with old format
846 $searchableNamespaces = SearchEngine::searchableNamespaces();
847
848 $nsOptions = array();
849 foreach( $wgContLang->getNamespaces() as $ns => $name ) {
850 if ($ns < 0) continue;
851 $displayNs = str_replace( '_', ' ', $name );
852
853 if (!$displayNs) $displayNs = wfMsg( 'blanknamespace' );
854
855 $displayNs = htmlspecialchars( $displayNs );
856 $nsOptions[$displayNs] = $ns;
857 }
858
859 $defaultPreferences['searchnamespaces'] =
860 array(
861 'type' => 'multiselect',
862 'label-message' => 'defaultns',
863 'options' => $nsOptions,
864 'section' => 'searchoptions/advancedsearchoptions',
865 'prefix' => 'searchNs',
866 );
867
868
869
870 }
871
872 static function miscPreferences( $user, &$defaultPreferences ) {
873 ## Misc #####################################
874 $defaultPreferences['diffonly'] =
875 array(
876 'type' => 'toggle',
877 'section' => 'misc/diffs',
878 'label-message' => 'tog-diffonly',
879 );
880 $defaultPreferences['norollbackdiff'] =
881 array(
882 'type' => 'toggle',
883 'section' => 'misc/diffs',
884 'label-message' => 'tog-norollbackdiff',
885 );
886 }
887
888 static function generateSkinOptions( $user ) {
889 global $wgDefaultSkin;
890 $ret = array();
891
892 $mptitle = Title::newMainPage();
893 $previewtext = wfMsgHtml( 'skin-preview' );
894 # Only show members of Skin::getSkinNames() rather than
895 # $skinNames (skins is all skin names from Language.php)
896 $validSkinNames = Skin::getUsableSkins();
897 # Sort by UI skin name. First though need to update validSkinNames as sometimes
898 # the skinkey & UI skinname differ (e.g. "standard" skinkey is "Classic" in the UI).
899 foreach ( $validSkinNames as $skinkey => &$skinname ) {
900 $msgName = "skinname-{$skinkey}";
901 $localisedSkinName = wfMsg( $msgName );
902 if ( !wfEmptyMsg( $msgName, $localisedSkinName ) ) {
903 $skinname = htmlspecialchars($localisedSkinName);
904 }
905 }
906 asort($validSkinNames);
907 $sk = $user->getSkin();
908
909 foreach( $validSkinNames as $skinkey => $sn ) {
910 $mplink = htmlspecialchars( $mptitle->getLocalURL( "useskin=$skinkey" ) );
911 $previewlink = "(<a target='_blank' href=\"$mplink\">$previewtext</a>)";
912 $extraLinks = '';
913 global $wgAllowUserCss, $wgAllowUserJs;
914 if( $wgAllowUserCss ) {
915 $cssPage = Title::makeTitleSafe( NS_USER, $user->getName().'/'.$skinkey.'.css' );
916 $customCSS = $sk->link( $cssPage, wfMsgHtml( 'prefs-custom-css' ) );
917 $extraLinks .= " ($customCSS)";
918 }
919 if( $wgAllowUserJs ) {
920 $jsPage = Title::makeTitleSafe( NS_USER, $user->getName().'/'.$skinkey.'.js' );
921 $customJS = $sk->link( $jsPage, wfMsgHtml( 'prefs-custom-js' ) );
922 $extraLinks .= " ($customJS)";
923 }
924 if( $skinkey == $wgDefaultSkin )
925 $sn .= ' (' . wfMsgHtml( 'default' ) . ')';
926 $display = "$sn $previewlink{$extraLinks}";
927 $ret[$display] = $skinkey;
928 }
929
930 return $ret;
931 }
932
933 static function getDateOptions() {
934 global $wgLang;
935 $dateopts = $wgLang->getDatePreferences();
936
937 $ret = array();
938
939 if ($dateopts) {
940 $idCnt = 0;
941 $epoch = '20010115161234'; # Wikipedia day
942 foreach( $dateopts as $key ) {
943 if( $key == 'default' ) {
944 $formatted = wfMsgHtml( 'datedefault' );
945 } else {
946 $formatted = htmlspecialchars($wgLang->timeanddate( $epoch, false, $key ));
947 }
948 $ret[$formatted] = $key;
949 }
950 }
951 return $ret;
952 }
953
954 static function getImageSizes() {
955 global $wgImageLimits;
956
957 $ret = array();
958
959 foreach ( $wgImageLimits as $index => $limits ) {
960 $display = "{$limits[0]}×{$limits[1]}" . wfMsg('unit-pixel');
961 $ret[$display] = $index;
962 }
963
964 return $ret;
965 }
966
967 static function getThumbSizes() {
968 global $wgThumbLimits;
969
970 $ret = array();
971
972 foreach ( $wgThumbLimits as $index => $size ) {
973 $display = $size . wfMsg('unit-pixel');
974 $ret[$display] = $index;
975 }
976
977 return $ret;
978 }
979
980 static function validateSignature( $signature, $alldata ) {
981 global $wgParser, $wgMaxSigChars, $wgLang;
982 if( mb_strlen( $signature ) > $wgMaxSigChars ) {
983 return
984 Xml::element( 'span', array( 'class' => 'error' ),
985 wfMsgExt( 'badsiglength', 'parsemag',
986 $wgLang->formatNum( $wgMaxSigChars )
987 )
988 );
989 } elseif( !empty( $alldata['fancysig'] ) &&
990 false === $wgParser->validateSig( $signature ) ) {
991 return Xml::element( 'span', array( 'class' => 'error' ), wfMsg( 'badsig' ) );
992 } else {
993 return true;
994 }
995 }
996
997 static function cleanSignature( $signature, $alldata ) {
998 global $wgParser;
999 if( $alldata['fancysig'] ) {
1000 $signature = $wgParser->cleanSig( $signature );
1001 } else {
1002 // When no fancy sig used, make sure ~{3,5} get removed.
1003 $signature = $wgParser->cleanSigInSig( $signature );
1004 }
1005
1006 return $signature;
1007 }
1008
1009 static function validateEmail( $email, $alldata ) {
1010 if ( $email && !User::isValidEmailAddr( $email ) ) {
1011 return wfMsgExt( 'invalidemailaddress', 'parseinline' );
1012 }
1013
1014 global $wgEmailConfirmToEdit;
1015 if( $wgEmailConfirmToEdit && !$email ) {
1016 return wfMsgExt( 'noemailtitle', 'parseinline' );
1017 }
1018 return true;
1019 }
1020
1021 static function getFormObject( $user ) {
1022 $formDescriptor = Preferences::getPreferences( $user );
1023 $htmlForm = new PreferencesForm( $formDescriptor, 'prefs' );
1024
1025 $htmlForm->setSubmitText( wfMsg('saveprefs') );
1026 $htmlForm->setTitle( SpecialPage::getTitleFor( 'Preferences' ) );
1027 $htmlForm->setSubmitID( 'prefsubmit' );
1028 $htmlForm->setSubmitCallback( array( 'Preferences', 'tryFormSubmit' ) );
1029
1030 return $htmlForm;
1031 }
1032
1033 static function getTimezoneOptions() {
1034 $opt = array();
1035
1036 global $wgLocalTZoffset;
1037
1038 $opt[wfMsg( 'timezoneuseserverdefault' )] = "System|$wgLocalTZoffset";
1039 $opt[wfMsg( 'timezoneuseoffset' )] = 'other';
1040 $opt[wfMsg( 'guesstimezone' )] = 'guess';
1041
1042 if ( function_exists( 'timezone_identifiers_list' ) ) {
1043 # Read timezone list
1044 $tzs = timezone_identifiers_list();
1045 sort( $tzs );
1046
1047 $tzRegions = array();
1048 $tzRegions['Africa'] = wfMsg( 'timezoneregion-africa' );
1049 $tzRegions['America'] = wfMsg( 'timezoneregion-america' );
1050 $tzRegions['Antarctica'] = wfMsg( 'timezoneregion-antarctica' );
1051 $tzRegions['Arctic'] = wfMsg( 'timezoneregion-arctic' );
1052 $tzRegions['Asia'] = wfMsg( 'timezoneregion-asia' );
1053 $tzRegions['Atlantic'] = wfMsg( 'timezoneregion-atlantic' );
1054 $tzRegions['Australia'] = wfMsg( 'timezoneregion-australia' );
1055 $tzRegions['Europe'] = wfMsg( 'timezoneregion-europe' );
1056 $tzRegions['Indian'] = wfMsg( 'timezoneregion-indian' );
1057 $tzRegions['Pacific'] = wfMsg( 'timezoneregion-pacific' );
1058 asort( $tzRegions );
1059
1060 $prefill = array_fill_keys( array_values($tzRegions), array() );
1061 $opt = array_merge( $opt, $prefill );
1062
1063 $now = date_create( 'now' );
1064
1065 foreach ( $tzs as $tz ) {
1066 $z = explode( '/', $tz, 2 );
1067
1068 # timezone_identifiers_list() returns a number of
1069 # backwards-compatibility entries. This filters them out of the
1070 # list presented to the user.
1071 if ( count( $z ) != 2 || !array_key_exists( $z[0], $tzRegions ) )
1072 continue;
1073
1074 # Localize region
1075 $z[0] = $tzRegions[$z[0]];
1076
1077 $minDiff = floor( timezone_offset_get( timezone_open( $tz ), $now ) / 60 );
1078
1079 $display = str_replace( '_', ' ', $z[0] . '/' . $z[1] );
1080 $value = "ZoneInfo|$minDiff|$tz";
1081
1082 $opt[$z[0]][$display] = $value;
1083 }
1084 }
1085 return $opt;
1086 }
1087
1088 static function filterTimezoneInput( $tz, $alldata ) {
1089 $data = explode( '|', $tz, 3 );
1090 switch ( $data[0] ) {
1091 case 'ZoneInfo':
1092 case 'System':
1093 return $tz;
1094 default:
1095 $data = explode( ':', $tz, 2 );
1096 $minDiff = 0;
1097 if( count( $data ) == 2 ) {
1098 $data[0] = intval( $data[0] );
1099 $data[1] = intval( $data[1] );
1100 $minDiff = abs( $data[0] ) * 60 + $data[1];
1101 if ( $data[0] < 0 ) $minDiff = -$minDiff;
1102 } else {
1103 $minDiff = intval( $data[0] ) * 60;
1104 }
1105
1106 # Max is +14:00 and min is -12:00, see:
1107 # http://en.wikipedia.org/wiki/Timezone
1108 $minDiff = min( $minDiff, 840 ); # 14:00
1109 $minDiff = max( $minDiff, -720 ); # -12:00
1110 return 'Offset|'.$minDiff;
1111 }
1112 }
1113
1114 static function tryFormSubmit( $formData, $entryPoint = 'internal' ) {
1115 global $wgUser, $wgEmailAuthentication, $wgEnableEmail;
1116
1117 $result = true;
1118
1119 // Filter input
1120 foreach( array_keys($formData) as $name ) {
1121 if ( isset(self::$saveFilters[$name]) ) {
1122 $formData[$name] =
1123 call_user_func( self::$saveFilters[$name], $formData[$name], $formData );
1124 }
1125 }
1126
1127 // Stuff that shouldn't be saved as a preference.
1128 $saveBlacklist = array(
1129 'realname',
1130 'emailaddress',
1131 );
1132
1133 if( $wgEnableEmail ) {
1134 $newadr = $formData['emailaddress'];
1135 $oldadr = $wgUser->getEmail();
1136 if( ($newadr != '') && ($newadr != $oldadr) ) {
1137 # the user has supplied a new email address on the login page
1138 # new behaviour: set this new emailaddr from login-page into user database record
1139 $wgUser->setEmail( $newadr );
1140 # but flag as "dirty" = unauthenticated
1141 $wgUser->invalidateEmail();
1142 if ($wgEmailAuthentication) {
1143 # Mail a temporary password to the dirty address.
1144 # User can come back through the confirmation URL to re-enable email.
1145 $result = $wgUser->sendConfirmationMail();
1146 if( WikiError::isError( $result ) ) {
1147 return wfMsg( 'mailerror', htmlspecialchars( $result->getMessage() ) );
1148 } elseif ($entryPoint == 'ui') {
1149 $result = 'eauth';
1150 }
1151 }
1152 } else {
1153 $wgUser->setEmail( $newadr );
1154 }
1155 if( $oldadr != $newadr ) {
1156 wfRunHooks( 'PrefsEmailAudit', array( $wgUser, $oldadr, $newadr ) );
1157 }
1158 }
1159
1160 // Fortunately, the realname field is MUCH simpler
1161 global $wgHiddenPrefs;
1162 if ( !in_array( 'realname', $wgHiddenPrefs ) ) {
1163 $realName = $formData['realname'];
1164 $wgUser->setRealName( $realName );
1165 }
1166
1167 foreach( $saveBlacklist as $b )
1168 unset( $formData[$b] );
1169
1170 // Keeps old preferences from interfering due to back-compat
1171 // code, etc.
1172 $wgUser->resetOptions();
1173
1174 foreach( $formData as $key => $value ) {
1175 $wgUser->setOption( $key, $value );
1176 }
1177
1178 $wgUser->saveSettings();
1179
1180 return $result;
1181 }
1182
1183 public static function tryUISubmit( $formData ) {
1184 $res = self::tryFormSubmit( $formData, 'ui' );
1185
1186 if ($res) {
1187 $urlOptions = array( 'success' );
1188 if ($res === 'eauth')
1189 $urlOptions[] = 'eauth';
1190
1191 $queryString = implode( '&', $urlOptions );
1192
1193 $url = SpecialPage::getTitleFor( 'Preferences' )->getFullURL( $queryString );
1194 global $wgOut;
1195 $wgOut->redirect( $url );
1196 }
1197
1198 return true;
1199 }
1200
1201 public static function loadOldSearchNs( $user ) {
1202 $searchableNamespaces = SearchEngine::searchableNamespaces();
1203 // Back compat with old format
1204 $arr = array();
1205
1206 foreach( $searchableNamespaces as $ns => $name ) {
1207 if( $user->getOption( 'searchNs' . $ns ) ) {
1208 $arr[] = $ns;
1209 }
1210 }
1211
1212 return $arr;
1213 }
1214 }
1215
1216 /** Some tweaks to allow js prefs to work */
1217 class PreferencesForm extends HTMLForm {
1218
1219 function wrapForm( $html ) {
1220 $html = Xml::tags( 'div', array( 'id' => 'preferences' ), $html );
1221
1222 return parent::wrapForm( $html );
1223 }
1224
1225 function getButtons() {
1226 $html = parent::getButtons();
1227
1228 global $wgUser;
1229
1230 $sk = $wgUser->getSkin();
1231 $t = SpecialPage::getTitleFor( 'Preferences', 'reset' );
1232
1233 $html .= "\n" . $sk->link( $t, wfMsgHtml( 'restoreprefs' ) );
1234
1235 $html = Xml::tags( 'div', array( 'class' => 'mw-prefs-buttons' ), $html );
1236
1237 return $html;
1238 }
1239
1240 function filterDataForSubmit( $data ) {
1241 // Support for separating MultiSelect preferences into multiple preferences
1242 // Due to lack of array support.
1243 foreach( $this->mFlatFields as $fieldname => $field ) {
1244 $info = $field->mParams;
1245 if ($field instanceof HTMLMultiSelectField) {
1246 $options = HTMLFormField::flattenOptions( $info['options'] );
1247 $prefix = isset($info['prefix']) ? $info['prefix'] : $fieldname;
1248
1249 foreach( $options as $opt ) {
1250 $data["$prefix$opt"] = in_array( $opt, $data[$fieldname] );
1251 }
1252
1253 unset( $data[$fieldname] );
1254 }
1255 }
1256
1257 return $data;
1258 }
1259 }