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