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