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