includes/Preferences.php

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