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