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