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