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