includes/Preferences.php

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