includes/Preferences.php

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