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