includes/Preferences.php

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