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