array( 'Preferences', 'filterTimezoneInput' ),
'cols' => array( 'Preferences', 'filterIntval' ),
'rows' => array( 'Preferences', 'filterIntval' ),
'rclimit' => array( 'Preferences', 'filterIntval' ),
'wllimit' => array( 'Preferences', 'filterIntval' ),
'searchlimit' => array( 'Preferences', 'filterIntval' ),
);
/**
* @throws MWException
* @param $user User
* @param $context IContextSource
* @return array|null
*/
static function getPreferences( $user, IContextSource $context ) {
if ( self::$defaultPreferences ) {
return self::$defaultPreferences;
}
$defaultPreferences = array();
self::profilePreferences( $user, $context, $defaultPreferences );
self::skinPreferences( $user, $context, $defaultPreferences );
self::filesPreferences( $user, $context, $defaultPreferences );
self::datetimePreferences( $user, $context, $defaultPreferences );
self::renderingPreferences( $user, $context, $defaultPreferences );
self::editingPreferences( $user, $context, $defaultPreferences );
self::rcPreferences( $user, $context, $defaultPreferences );
self::watchlistPreferences( $user, $context, $defaultPreferences );
self::searchPreferences( $user, $context, $defaultPreferences );
self::miscPreferences( $user, $context, $defaultPreferences );
wfRunHooks( 'GetPreferences', array( $user, &$defaultPreferences ) );
## Remove preferences that wikis don't want to use
global $wgHiddenPrefs;
foreach ( $wgHiddenPrefs as $pref ) {
if ( isset( $defaultPreferences[$pref] ) ) {
unset( $defaultPreferences[$pref] );
}
}
## Prod in defaults from the user
foreach ( $defaultPreferences as $name => &$info ) {
$prefFromUser = self::getOptionFromUser( $name, $info, $user );
$field = HTMLForm::loadInputFromParameters( $name, $info ); // For validation
$defaultOptions = User::getDefaultOptions();
$globalDefault = isset( $defaultOptions[$name] )
? $defaultOptions[$name]
: null;
// If it validates, set it as the default
if ( isset( $info['default'] ) ) {
// Already set, no problem
continue;
} elseif ( !is_null( $prefFromUser ) && // Make sure we're not just pulling nothing
$field->validate( $prefFromUser, $user->mOptions ) === true ) {
$info['default'] = $prefFromUser;
} elseif ( $field->validate( $globalDefault, $user->mOptions ) === true ) {
$info['default'] = $globalDefault;
} else {
throw new MWException( "Global default '$globalDefault' is invalid for field $name" );
}
}
self::$defaultPreferences = $defaultPreferences;
return $defaultPreferences;
}
/**
* Pull option from a user account. Handles stuff like array-type preferences.
*
* @param $name
* @param $info
* @param $user User
* @return array|String
*/
static function getOptionFromUser( $name, $info, $user ) {
$val = $user->getOption( $name );
// Handling for array-type preferences
if ( ( isset( $info['type'] ) && $info['type'] == 'multiselect' ) ||
( isset( $info['class'] ) && $info['class'] == 'HTMLMultiSelectField' ) ) {
$options = HTMLFormField::flattenOptions( $info['options'] );
$prefix = isset( $info['prefix'] ) ? $info['prefix'] : $name;
$val = array();
foreach ( $options as $value ) {
if ( $user->getOption( "$prefix$value" ) ) {
$val[] = $value;
}
}
}
return $val;
}
/**
* @param $user User
* @param $context IContextSource
* @param $defaultPreferences
* @return void
*/
static function profilePreferences( $user, IContextSource $context, &$defaultPreferences ) {
global $wgAuth, $wgContLang, $wgParser, $wgCookieExpiration, $wgLanguageCode,
$wgDisableTitleConversion, $wgDisableLangConversion, $wgMaxSigChars,
$wgEnableEmail, $wgEmailConfirmToEdit, $wgEnableUserEmail, $wgEmailAuthentication,
$wgEnotifWatchlist, $wgEnotifUserTalk, $wgEnotifRevealEditorAddress;
## User info #####################################
// Information panel
$defaultPreferences['username'] = array(
'type' => 'info',
'label-message' => 'username',
'default' => $user->getName(),
'section' => 'personal/info',
);
$defaultPreferences['userid'] = array(
'type' => 'info',
'label-message' => 'uid',
'default' => $user->getId(),
'section' => 'personal/info',
);
# Get groups to which the user belongs
$userEffectiveGroups = $user->getEffectiveGroups();
$userGroups = $userMembers = array();
foreach ( $userEffectiveGroups as $ueg ) {
if ( $ueg == '*' ) {
// Skip the default * group, seems useless here
continue;
}
$groupName = User::getGroupName( $ueg );
$userGroups[] = User::makeGroupLinkHTML( $ueg, $groupName );
$memberName = User::getGroupMember( $ueg, $user->getName() );
$userMembers[] = User::makeGroupLinkHTML( $ueg, $memberName );
}
asort( $userGroups );
asort( $userMembers );
$lang = $context->getLanguage();
$defaultPreferences['usergroups'] = array(
'type' => 'info',
'label' => $context->msg( 'prefs-memberingroups' )->numParams(
count( $userGroups ) )->parse(),
'default' => $context->msg( 'prefs-memberingroups-type',
$lang->commaList( $userGroups ),
$lang->commaList( $userMembers )
)->plain(),
'raw' => true,
'section' => 'personal/info',
);
$defaultPreferences['editcount'] = array(
'type' => 'info',
'label-message' => 'prefs-edits',
'default' => $lang->formatNum( $user->getEditCount() ),
'section' => 'personal/info',
);
if ( $user->getRegistration() ) {
$displayUser = $context->getUser();
$userRegistration = $user->getRegistration();
$defaultPreferences['registrationdate'] = array(
'type' => 'info',
'label-message' => 'prefs-registration',
'default' => $context->msg(
'prefs-registration-date-time',
$lang->userTimeAndDate( $userRegistration, $displayUser ),
$lang->userDate( $userRegistration, $displayUser ),
$lang->userTime( $userRegistration, $displayUser )
)->parse(),
'section' => 'personal/info',
);
}
// Actually changeable stuff
$defaultPreferences['realname'] = array(
'type' => $wgAuth->allowPropChange( 'realname' ) ? 'text' : 'info',
'default' => $user->getRealName(),
'section' => 'personal/info',
'label-message' => 'yourrealname',
'help-message' => 'prefs-help-realname',
);
$defaultPreferences['gender'] = array(
'type' => 'select',
'section' => 'personal/info',
'options' => array(
$context->msg( 'gender-male' )->text() => 'male',
$context->msg( 'gender-female' )->text() => 'female',
$context->msg( 'gender-unknown' )->text() => 'unknown',
),
'label-message' => 'yourgender',
'help-message' => 'prefs-help-gender',
);
if ( $wgAuth->allowPasswordChange() ) {
$link = Linker::link( SpecialPage::getTitleFor( 'ChangePassword' ),
$context->msg( 'prefs-resetpass' )->escaped(), array(),
array( 'returnto' => SpecialPage::getTitleFor( 'Preferences' ) ) );
$defaultPreferences['password'] = array(
'type' => 'info',
'raw' => true,
'default' => $link,
'label-message' => 'yourpassword',
'section' => 'personal/info',
);
}
if ( $wgCookieExpiration > 0 ) {
$defaultPreferences['rememberpassword'] = array(
'type' => 'toggle',
'label' => $context->msg( 'tog-rememberpassword' )->numParams(
ceil( $wgCookieExpiration / ( 3600 * 24 ) ) )->text(),
'section' => 'personal/info',
);
}
// Language
$languages = Language::getLanguageNames( false );
if ( !array_key_exists( $wgLanguageCode, $languages ) ) {
$languages[$wgLanguageCode] = $wgLanguageCode;
}
ksort( $languages );
$options = array();
foreach ( $languages as $code => $name ) {
$display = wfBCP47( $code ) . ' - ' . $name;
$options[$display] = $code;
}
$defaultPreferences['language'] = array(
'type' => 'select',
'section' => 'personal/i18n',
'options' => $options,
'label-message' => 'yourlanguage',
);
/* see if there are multiple language variants to choose from*/
$variantArray = array();
if ( !$wgDisableLangConversion ) {
$variants = $wgContLang->getVariants();
foreach ( $variants as $v ) {
$v = str_replace( '_', '-', strtolower( $v ) );
$variantArray[$v] = $wgContLang->getVariantname( $v, false );
}
$options = array();
foreach ( $variantArray as $code => $name ) {
$display = wfBCP47( $code ) . ' - ' . $name;
$options[$display] = $code;
}
if ( count( $variantArray ) > 1 ) {
$defaultPreferences['variant'] = array(
'label-message' => 'yourvariant',
'type' => 'select',
'options' => $options,
'section' => 'personal/i18n',
'help-message' => 'prefs-help-variant',
);
}
}
if ( count( $variantArray ) > 1 && !$wgDisableLangConversion && !$wgDisableTitleConversion ) {
$defaultPreferences['noconvertlink'] =
array(
'type' => 'toggle',
'section' => 'personal/i18n',
'label-message' => 'tog-noconvertlink',
);
}
// show a preview of the old signature first
$oldsigWikiText = $wgParser->preSaveTransform( "~~~", $context->getTitle(), $user, ParserOptions::newFromContext( $context ) );
$oldsigHTML = $context->getOutput()->parseInline( $oldsigWikiText, true, true );
$defaultPreferences['oldsig'] = array(
'type' => 'info',
'raw' => true,
'label-message' => 'tog-oldsig',
'default' => $oldsigHTML,
'section' => 'personal/signature',
);
$defaultPreferences['nickname'] = array(
'type' => $wgAuth->allowPropChange( 'nickname' ) ? 'text' : 'info',
'maxlength' => $wgMaxSigChars,
'label-message' => 'yournick',
'validation-callback' => array( 'Preferences', 'validateSignature' ),
'section' => 'personal/signature',
'filter-callback' => array( 'Preferences', 'cleanSignature' ),
);
$defaultPreferences['fancysig'] = array(
'type' => 'toggle',
'label-message' => 'tog-fancysig',
'help-message' => 'prefs-help-signature', // show general help about signature at the bottom of the section
'section' => 'personal/signature'
);
## Email stuff
if ( $wgEnableEmail ) {
$helpMessages[] = $wgEmailConfirmToEdit
? 'prefs-help-email-required'
: 'prefs-help-email' ;
if( $wgEnableUserEmail ) {
// additional messages when users can send email to each other
$helpMessages[] = 'prefs-help-email-others';
}
$link = Linker::link(
SpecialPage::getTitleFor( 'ChangeEmail' ),
$context->msg( $user->getEmail() ? 'prefs-changeemail' : 'prefs-setemail' )->escaped(),
array(),
array( 'returnto' => SpecialPage::getTitleFor( 'Preferences' ) ) );
$emailAddress = $user->getEmail() ? htmlspecialchars( $user->getEmail() ) : '';
if ( $wgAuth->allowPropChange( 'emailaddress' ) ) {
$emailAddress .= $emailAddress == '' ? $link : " ($link)";
}
$defaultPreferences['emailaddress'] = array(
'type' => 'info',
'raw' => true,
'default' => $emailAddress,
'label-message' => 'youremail',
'section' => 'personal/email',
'help-messages' => $helpMessages,
);
$disableEmailPrefs = false;
if ( $wgEmailAuthentication ) {
if ( $user->getEmail() ) {
if ( $user->getEmailAuthenticationTimestamp() ) {
// date and time are separate parameters to facilitate localisation.
// $time is kept for backward compat reasons.
// 'emailauthenticated' is also used in SpecialConfirmemail.php
$displayUser = $context->getUser();
$emailTimestamp = $user->getEmailAuthenticationTimestamp();
$time = $lang->userTimeAndDate( $emailTimestamp, $displayUser );
$d = $lang->userDate( $emailTimestamp, $displayUser );
$t = $lang->userTime( $emailTimestamp, $displayUser );
$emailauthenticated = $context->msg( 'emailauthenticated',
$time, $d, $t )->parse() . '
';
$disableEmailPrefs = false;
} else {
$disableEmailPrefs = true;
$emailauthenticated = $context->msg( 'emailnotauthenticated' )->parse() . '
' .
Linker::linkKnown(
SpecialPage::getTitleFor( 'Confirmemail' ),
$context->msg( 'emailconfirmlink' )->escaped()
) . '
';
}
} else {
$disableEmailPrefs = true;
$emailauthenticated = $context->msg( 'noemailprefs' )->escaped();
}
$defaultPreferences['emailauthentication'] = array(
'type' => 'info',
'raw' => true,
'section' => 'personal/email',
'label-message' => 'prefs-emailconfirm-label',
'default' => $emailauthenticated,
);
}
if ( $wgEnableUserEmail && $user->isAllowed( 'sendemail' ) ) {
$defaultPreferences['disablemail'] = array(
'type' => 'toggle',
'invert' => true,
'section' => 'personal/email',
'label-message' => 'allowemail',
'disabled' => $disableEmailPrefs,
);
$defaultPreferences['ccmeonemails'] = array(
'type' => 'toggle',
'section' => 'personal/email',
'label-message' => 'tog-ccmeonemails',
'disabled' => $disableEmailPrefs,
);
}
if ( $wgEnotifWatchlist ) {
$defaultPreferences['enotifwatchlistpages'] = array(
'type' => 'toggle',
'section' => 'personal/email',
'label-message' => 'tog-enotifwatchlistpages',
'disabled' => $disableEmailPrefs,
);
}
if ( $wgEnotifUserTalk ) {
$defaultPreferences['enotifusertalkpages'] = array(
'type' => 'toggle',
'section' => 'personal/email',
'label-message' => 'tog-enotifusertalkpages',
'disabled' => $disableEmailPrefs,
);
}
if ( $wgEnotifUserTalk || $wgEnotifWatchlist ) {
$defaultPreferences['enotifminoredits'] = array(
'type' => 'toggle',
'section' => 'personal/email',
'label-message' => 'tog-enotifminoredits',
'disabled' => $disableEmailPrefs,
);
if ( $wgEnotifRevealEditorAddress ) {
$defaultPreferences['enotifrevealaddr'] = array(
'type' => 'toggle',
'section' => 'personal/email',
'label-message' => 'tog-enotifrevealaddr',
'disabled' => $disableEmailPrefs,
);
}
}
}
}
/**
* @param $user User
* @param $context IContextSource
* @param $defaultPreferences
* @return void
*/
static function skinPreferences( $user, IContextSource $context, &$defaultPreferences ) {
## Skin #####################################
global $wgAllowUserCss, $wgAllowUserJs;
$defaultPreferences['skin'] = array(
'type' => 'radio',
'options' => self::generateSkinOptions( $user, $context ),
'label' => ' ',
'section' => 'rendering/skin',
);
# Create links to user CSS/JS pages for all skins
# This code is basically copied from generateSkinOptions(). It'd
# be nice to somehow merge this back in there to avoid redundancy.
if ( $wgAllowUserCss || $wgAllowUserJs ) {
$linkTools = array();
if ( $wgAllowUserCss ) {
$cssPage = Title::makeTitleSafe( NS_USER, $user->getName() . '/common.css' );
$linkTools[] = Linker::link( $cssPage, $context->msg( 'prefs-custom-css' )->escaped() );
}
if ( $wgAllowUserJs ) {
$jsPage = Title::makeTitleSafe( NS_USER, $user->getName() . '/common.js' );
$linkTools[] = Linker::link( $jsPage, $context->msg( 'prefs-custom-js' )->escaped() );
}
$defaultPreferences['commoncssjs'] = array(
'type' => 'info',
'raw' => true,
'default' => $context->getLanguage()->pipeList( $linkTools ),
'label-message' => 'prefs-common-css-js',
'section' => 'rendering/skin',
);
}
$selectedSkin = $user->getOption( 'skin' );
if ( in_array( $selectedSkin, array( 'cologneblue', 'standard' ) ) ) {
$settings = array_flip( $context->getLanguage()->getQuickbarSettings() );
$defaultPreferences['quickbar'] = array(
'type' => 'radio',
'options' => $settings,
'section' => 'rendering/skin',
'label-message' => 'qbsettings',
);
}
}
/**
* @param $user User
* @param $context IContextSource
* @param $defaultPreferences Array
*/
static function filesPreferences( $user, IContextSource $context, &$defaultPreferences ) {
## Files #####################################
$defaultPreferences['imagesize'] = array(
'type' => 'select',
'options' => self::getImageSizes( $context ),
'label-message' => 'imagemaxsize',
'section' => 'rendering/files',
);
$defaultPreferences['thumbsize'] = array(
'type' => 'select',
'options' => self::getThumbSizes( $context ),
'label-message' => 'thumbsize',
'section' => 'rendering/files',
);
}
/**
* @param $user User
* @param $context IContextSource
* @param $defaultPreferences
* @return void
*/
static function datetimePreferences( $user, IContextSource $context, &$defaultPreferences ) {
## Date and time #####################################
$dateOptions = self::getDateOptions( $context );
if ( $dateOptions ) {
$defaultPreferences['date'] = array(
'type' => 'radio',
'options' => $dateOptions,
'label' => ' ',
'section' => 'datetime/dateformat',
);
}
// Info
$now = wfTimestampNow();
$lang = $context->getLanguage();
$nowlocal = Xml::element( 'span', array( 'id' => 'wpLocalTime' ),
$lang->time( $now, true ) );
$nowserver = $lang->time( $now, false ) .
Html::hidden( 'wpServerTime', (int)substr( $now, 8, 2 ) * 60 + (int)substr( $now, 10, 2 ) );
$defaultPreferences['nowserver'] = array(
'type' => 'info',
'raw' => 1,
'label-message' => 'servertime',
'default' => $nowserver,
'section' => 'datetime/timeoffset',
);
$defaultPreferences['nowlocal'] = array(
'type' => 'info',
'raw' => 1,
'label-message' => 'localtime',
'default' => $nowlocal,
'section' => 'datetime/timeoffset',
);
// Grab existing pref.
$tzOffset = $user->getOption( 'timecorrection' );
$tz = explode( '|', $tzOffset, 3 );
$tzOptions = self::getTimezoneOptions( $context );
$tzSetting = $tzOffset;
if ( count( $tz ) > 1 && $tz[0] == 'Offset' ) {
$minDiff = $tz[1];
$tzSetting = sprintf( '%+03d:%02d', floor( $minDiff / 60 ), abs( $minDiff ) % 60 );
} elseif ( count( $tz ) > 1 && $tz[0] == 'ZoneInfo' &&
!in_array( $tzOffset, HTMLFormField::flattenOptions( $tzOptions ) ) )
{
# Timezone offset can vary with DST
$userTZ = timezone_open( $tz[2] );
if ( $userTZ !== false ) {
$minDiff = floor( timezone_offset_get( $userTZ, date_create( 'now' ) ) / 60 );
$tzSetting = "ZoneInfo|$minDiff|{$tz[2]}";
}
}
$defaultPreferences['timecorrection'] = array(
'class' => 'HTMLSelectOrOtherField',
'label-message' => 'timezonelegend',
'options' => $tzOptions,
'default' => $tzSetting,
'size' => 20,
'section' => 'datetime/timeoffset',
);
}
/**
* @param $user User
* @param $context IContextSource
* @param $defaultPreferences Array
*/
static function renderingPreferences( $user, IContextSource $context, &$defaultPreferences ) {
## Page Rendering ##############################
global $wgAllowUserCssPrefs;
if ( $wgAllowUserCssPrefs ) {
$defaultPreferences['underline'] = array(
'type' => 'select',
'options' => array(
$context->msg( 'underline-never' )->text() => 0,
$context->msg( 'underline-always' )->text() => 1,
$context->msg( 'underline-default' )->text() => 2,
),
'label-message' => 'tog-underline',
'section' => 'rendering/advancedrendering',
);
}
$stubThresholdValues = array( 50, 100, 500, 1000, 2000, 5000, 10000 );
$stubThresholdOptions = array( $context->msg( 'stub-threshold-disabled' )->text() => 0 );
foreach ( $stubThresholdValues as $value ) {
$stubThresholdOptions[$context->msg( 'size-bytes', $value )->text()] = $value;
}
$defaultPreferences['stubthreshold'] = array(
'type' => 'selectorother',
'section' => 'rendering/advancedrendering',
'options' => $stubThresholdOptions,
'size' => 20,
'label' => $context->msg( 'stub-threshold' )->text(), // Raw HTML message. Yay?
);
if ( $wgAllowUserCssPrefs ) {
$defaultPreferences['highlightbroken'] = array(
'type' => 'toggle',
'section' => 'rendering/advancedrendering',
'label' => $context->msg( 'tog-highlightbroken' )->text(), // Raw HTML
);
$defaultPreferences['showtoc'] = array(
'type' => 'toggle',
'section' => 'rendering/advancedrendering',
'label-message' => 'tog-showtoc',
);
}
$defaultPreferences['nocache'] = array(
'type' => 'toggle',
'label-message' => 'tog-nocache',
'section' => 'rendering/advancedrendering',
);
$defaultPreferences['showhiddencats'] = array(
'type' => 'toggle',
'section' => 'rendering/advancedrendering',
'label-message' => 'tog-showhiddencats'
);
$defaultPreferences['showjumplinks'] = array(
'type' => 'toggle',
'section' => 'rendering/advancedrendering',
'label-message' => 'tog-showjumplinks',
);
if ( $wgAllowUserCssPrefs ) {
$defaultPreferences['justify'] = array(
'type' => 'toggle',
'section' => 'rendering/advancedrendering',
'label-message' => 'tog-justify',
);
}
$defaultPreferences['numberheadings'] = array(
'type' => 'toggle',
'section' => 'rendering/advancedrendering',
'label-message' => 'tog-numberheadings',
);
}
/**
* @param $user User
* @param $context IContextSource
* @param $defaultPreferences Array
*/
static function editingPreferences( $user, IContextSource $context, &$defaultPreferences ) {
global $wgUseExternalEditor, $wgAllowUserCssPrefs;
## Editing #####################################
$defaultPreferences['cols'] = array(
'type' => 'int',
'label-message' => 'columns',
'section' => 'editing/textboxsize',
'min' => 4,
'max' => 1000,
);
$defaultPreferences['rows'] = array(
'type' => 'int',
'label-message' => 'rows',
'section' => 'editing/textboxsize',
'min' => 4,
'max' => 1000,
);
if ( $wgAllowUserCssPrefs ) {
$defaultPreferences['editfont'] = array(
'type' => 'select',
'section' => 'editing/advancedediting',
'label-message' => 'editfont-style',
'options' => array(
$context->msg( 'editfont-default' )->text() => 'default',
$context->msg( 'editfont-monospace' )->text() => 'monospace',
$context->msg( 'editfont-sansserif' )->text() => 'sans-serif',
$context->msg( 'editfont-serif' )->text() => 'serif',
)
);
}
$defaultPreferences['previewontop'] = array(
'type' => 'toggle',
'section' => 'editing/advancedediting',
'label-message' => 'tog-previewontop',
);
$defaultPreferences['previewonfirst'] = array(
'type' => 'toggle',
'section' => 'editing/advancedediting',
'label-message' => 'tog-previewonfirst',
);
if ( $wgAllowUserCssPrefs ) {
$defaultPreferences['editsection'] = array(
'type' => 'toggle',
'section' => 'editing/advancedediting',
'label-message' => 'tog-editsection',
);
}
$defaultPreferences['editsectiononrightclick'] = array(
'type' => 'toggle',
'section' => 'editing/advancedediting',
'label-message' => 'tog-editsectiononrightclick',
);
$defaultPreferences['editondblclick'] = array(
'type' => 'toggle',
'section' => 'editing/advancedediting',
'label-message' => 'tog-editondblclick',
);
$defaultPreferences['showtoolbar'] = array(
'type' => 'toggle',
'section' => 'editing/advancedediting',
'label-message' => 'tog-showtoolbar',
);
if ( $user->isAllowed( 'minoredit' ) ) {
$defaultPreferences['minordefault'] = array(
'type' => 'toggle',
'section' => 'editing/advancedediting',
'label-message' => 'tog-minordefault',
);
}
if ( $wgUseExternalEditor ) {
$defaultPreferences['externaleditor'] = array(
'type' => 'toggle',
'section' => 'editing/advancedediting',
'label-message' => 'tog-externaleditor',
);
$defaultPreferences['externaldiff'] = array(
'type' => 'toggle',
'section' => 'editing/advancedediting',
'label-message' => 'tog-externaldiff',
);
}
$defaultPreferences['forceeditsummary'] = array(
'type' => 'toggle',
'section' => 'editing/advancedediting',
'label-message' => 'tog-forceeditsummary',
);
$defaultPreferences['uselivepreview'] = array(
'type' => 'toggle',
'section' => 'editing/advancedediting',
'label-message' => 'tog-uselivepreview',
);
}
/**
* @param $user User
* @param $context IContextSource
* @param $defaultPreferences Array
*/
static function rcPreferences( $user, IContextSource $context, &$defaultPreferences ) {
global $wgRCMaxAge, $wgRCShowWatchingUsers;
## RecentChanges #####################################
$defaultPreferences['rcdays'] = array(
'type' => 'float',
'label-message' => 'recentchangesdays',
'section' => 'rc/displayrc',
'min' => 1,
'max' => ceil( $wgRCMaxAge / ( 3600 * 24 ) ),
'help' => $context->msg( 'recentchangesdays-max' )->numParams(
ceil( $wgRCMaxAge / ( 3600 * 24 ) ) )->text()
);
$defaultPreferences['rclimit'] = array(
'type' => 'int',
'label-message' => 'recentchangescount',
'help-message' => 'prefs-help-recentchangescount',
'section' => 'rc/displayrc',
);
$defaultPreferences['usenewrc'] = array(
'type' => 'toggle',
'label-message' => 'tog-usenewrc',
'section' => 'rc/advancedrc',
);
$defaultPreferences['hideminor'] = array(
'type' => 'toggle',
'label-message' => 'tog-hideminor',
'section' => 'rc/advancedrc',
);
if ( $user->useRCPatrol() ) {
$defaultPreferences['hidepatrolled'] = array(
'type' => 'toggle',
'section' => 'rc/advancedrc',
'label-message' => 'tog-hidepatrolled',
);
$defaultPreferences['newpageshidepatrolled'] = array(
'type' => 'toggle',
'section' => 'rc/advancedrc',
'label-message' => 'tog-newpageshidepatrolled',
);
}
if ( $wgRCShowWatchingUsers ) {
$defaultPreferences['shownumberswatching'] = array(
'type' => 'toggle',
'section' => 'rc/advancedrc',
'label-message' => 'tog-shownumberswatching',
);
}
}
/**
* @param $user User
* @param $context IContextSource
* @param $defaultPreferences
*/
static function watchlistPreferences( $user, IContextSource $context, &$defaultPreferences ) {
global $wgUseRCPatrol, $wgEnableAPI, $wgRCMaxAge;
$watchlistdaysMax = ceil( $wgRCMaxAge / ( 3600 * 24 ) );
## Watchlist #####################################
$defaultPreferences['watchlistdays'] = array(
'type' => 'float',
'min' => 0,
'max' => $watchlistdaysMax,
'section' => 'watchlist/displaywatchlist',
'help' => $context->msg( 'prefs-watchlist-days-max' )->numParams(
$watchlistdaysMax )->text(),
'label-message' => 'prefs-watchlist-days',
);
$defaultPreferences['wllimit'] = array(
'type' => 'int',
'min' => 0,
'max' => 1000,
'label-message' => 'prefs-watchlist-edits',
'help' => $context->msg( 'prefs-watchlist-edits-max' )->escaped(),
'section' => 'watchlist/displaywatchlist',
);
$defaultPreferences['extendwatchlist'] = array(
'type' => 'toggle',
'section' => 'watchlist/advancedwatchlist',
'label-message' => 'tog-extendwatchlist',
);
$defaultPreferences['watchlisthideminor'] = array(
'type' => 'toggle',
'section' => 'watchlist/advancedwatchlist',
'label-message' => 'tog-watchlisthideminor',
);
$defaultPreferences['watchlisthidebots'] = array(
'type' => 'toggle',
'section' => 'watchlist/advancedwatchlist',
'label-message' => 'tog-watchlisthidebots',
);
$defaultPreferences['watchlisthideown'] = array(
'type' => 'toggle',
'section' => 'watchlist/advancedwatchlist',
'label-message' => 'tog-watchlisthideown',
);
$defaultPreferences['watchlisthideanons'] = array(
'type' => 'toggle',
'section' => 'watchlist/advancedwatchlist',
'label-message' => 'tog-watchlisthideanons',
);
$defaultPreferences['watchlisthideliu'] = array(
'type' => 'toggle',
'section' => 'watchlist/advancedwatchlist',
'label-message' => 'tog-watchlisthideliu',
);
if ( $wgUseRCPatrol ) {
$defaultPreferences['watchlisthidepatrolled'] = array(
'type' => 'toggle',
'section' => 'watchlist/advancedwatchlist',
'label-message' => 'tog-watchlisthidepatrolled',
);
}
if ( $wgEnableAPI ) {
# Some random gibberish as a proposed default
$hash = sha1( mt_rand() . microtime( true ) );
$defaultPreferences['watchlisttoken'] = array(
'type' => 'text',
'section' => 'watchlist/advancedwatchlist',
'label-message' => 'prefs-watchlist-token',
'help' => $context->msg( 'prefs-help-watchlist-token', $hash )->escaped()
);
}
$watchTypes = array(
'edit' => 'watchdefault',
'move' => 'watchmoves',
'delete' => 'watchdeletion'
);
// Kinda hacky
if ( $user->isAllowed( 'createpage' ) || $user->isAllowed( 'createtalk' ) ) {
$watchTypes['read'] = 'watchcreations';
}
foreach ( $watchTypes as $action => $pref ) {
if ( $user->isAllowed( $action ) ) {
$defaultPreferences[$pref] = array(
'type' => 'toggle',
'section' => 'watchlist/advancedwatchlist',
'label-message' => "tog-$pref",
);
}
}
}
/**
* @param $user User
* @param $context IContextSource
* @param $defaultPreferences Array
*/
static function searchPreferences( $user, IContextSource $context, &$defaultPreferences ) {
global $wgContLang, $wgEnableMWSuggest, $wgVectorUseSimpleSearch;
## Search #####################################
$defaultPreferences['searchlimit'] = array(
'type' => 'int',
'label-message' => 'resultsperpage',
'section' => 'searchoptions/displaysearchoptions',
'min' => 0,
);
if ( $wgEnableMWSuggest ) {
$defaultPreferences['disablesuggest'] = array(
'type' => 'toggle',
'label-message' => 'mwsuggest-disable',
'section' => 'searchoptions/displaysearchoptions',
);
}
if ( $wgVectorUseSimpleSearch ) {
$defaultPreferences['vector-simplesearch'] = array(
'type' => 'toggle',
'label-message' => 'vector-simplesearch-preference',
'section' => 'searchoptions/displaysearchoptions'
);
}
$defaultPreferences['searcheverything'] = array(
'type' => 'toggle',
'label-message' => 'searcheverything-enable',
'section' => 'searchoptions/advancedsearchoptions',
);
$nsOptions = array();
foreach ( $wgContLang->getNamespaces() as $ns => $name ) {
if ( $ns < 0 ) {
continue;
}
$displayNs = str_replace( '_', ' ', $name );
if ( !$displayNs ) {
$displayNs = $context->msg( 'blanknamespace' )->text();
}
$displayNs = htmlspecialchars( $displayNs );
$nsOptions[$displayNs] = $ns;
}
$defaultPreferences['searchnamespaces'] = array(
'type' => 'multiselect',
'label-message' => 'defaultns',
'options' => $nsOptions,
'section' => 'searchoptions/advancedsearchoptions',
'prefix' => 'searchNs',
);
}
/**
* @param $user User
* @param $context IContextSource
* @param $defaultPreferences Array
*/
static function miscPreferences( $user, IContextSource $context, &$defaultPreferences ) {
global $wgContLang;
## Misc #####################################
$defaultPreferences['diffonly'] = array(
'type' => 'toggle',
'section' => 'misc/diffs',
'label-message' => 'tog-diffonly',
);
$defaultPreferences['norollbackdiff'] = array(
'type' => 'toggle',
'section' => 'misc/diffs',
'label-message' => 'tog-norollbackdiff',
);
// Stuff from Language::getExtraUserToggles()
$toggles = $wgContLang->getExtraUserToggles();
foreach ( $toggles as $toggle ) {
$defaultPreferences[$toggle] = array(
'type' => 'toggle',
'section' => 'personal/i18n',
'label-message' => "tog-$toggle",
);
}
}
/**
* @param $user User The User object
* @param $context IContextSource
* @return Array: text/links to display as key; $skinkey as value
*/
static function generateSkinOptions( $user, IContextSource $context ) {
global $wgDefaultSkin, $wgAllowUserCss, $wgAllowUserJs;
$ret = array();
$mptitle = Title::newMainPage();
$previewtext = $context->msg( 'skin-preview' )->text();
# Only show members of Skin::getSkinNames() rather than
# $skinNames (skins is all skin names from Language.php)
$validSkinNames = Skin::getUsableSkins();
# Sort by UI skin name. First though need to update validSkinNames as sometimes
# the skinkey & UI skinname differ (e.g. "standard" skinkey is "Classic" in the UI).
foreach ( $validSkinNames as $skinkey => &$skinname ) {
$msg = $context->msg( "skinname-{$skinkey}" );
if ( $msg->exists() ) {
$skinname = htmlspecialchars( $msg->text() );
}
}
asort( $validSkinNames );
foreach ( $validSkinNames as $skinkey => $sn ) {
$linkTools = array();
# Mark the default skin
if ( $skinkey == $wgDefaultSkin ) {
$linkTools[] = $context->msg( 'default' )->escaped();
}
# Create preview link
$mplink = htmlspecialchars( $mptitle->getLocalURL( "useskin=$skinkey" ) );
$linkTools[] = "$previewtext";
# Create links to user CSS/JS pages
if ( $wgAllowUserCss ) {
$cssPage = Title::makeTitleSafe( NS_USER, $user->getName() . '/' . $skinkey . '.css' );
$linkTools[] = Linker::link( $cssPage, $context->msg( 'prefs-custom-css' )->escaped() );
}
if ( $wgAllowUserJs ) {
$jsPage = Title::makeTitleSafe( NS_USER, $user->getName() . '/' . $skinkey . '.js' );
$linkTools[] = Linker::link( $jsPage, $context->msg( 'prefs-custom-js' )->escaped() );
}
$display = $sn . ' ' . $context->msg( 'parentheses', $context->getLanguage()->pipeList( $linkTools ) )->text();
$ret[$display] = $skinkey;
}
return $ret;
}
/**
* @param $context IContextSource
* @return array
*/
static function getDateOptions( IContextSource $context ) {
$lang = $context->getLanguage();
$dateopts = $lang->getDatePreferences();
$ret = array();
if ( $dateopts ) {
if ( !in_array( 'default', $dateopts ) ) {
$dateopts[] = 'default'; // Make sure default is always valid
// Bug 19237
}
// KLUGE: site default might not be valid for user language
global $wgDefaultUserOptions;
if ( !in_array( $wgDefaultUserOptions['date'], $dateopts ) ) {
$wgDefaultUserOptions['date'] = 'default';
}
$epoch = wfTimestampNow();
foreach ( $dateopts as $key ) {
if ( $key == 'default' ) {
$formatted = $context->msg( 'datedefault' )->escaped();
} else {
$formatted = htmlspecialchars( $lang->timeanddate( $epoch, false, $key ) );
}
$ret[$formatted] = $key;
}
}
return $ret;
}
/**
* @param $context IContextSource
* @return array
*/
static function getImageSizes( IContextSource $context ) {
global $wgImageLimits;
$ret = array();
$pixels = $context->msg( 'unit-pixel' )->text();
foreach ( $wgImageLimits as $index => $limits ) {
$display = "{$limits[0]}×{$limits[1]}" . $pixels;
$ret[$display] = $index;
}
return $ret;
}
/**
* @param $context IContextSource
* @return array
*/
static function getThumbSizes( IContextSource $context ) {
global $wgThumbLimits;
$ret = array();
$pixels = $context->msg( 'unit-pixel' )->text();
foreach ( $wgThumbLimits as $index => $size ) {
$display = $size . $pixels;
$ret[$display] = $index;
}
return $ret;
}
/**
* @param $signature string
* @param $alldata array
* @param $form HTMLForm
* @return bool|string
*/
static function validateSignature( $signature, $alldata, $form ) {
global $wgParser, $wgMaxSigChars;
if ( mb_strlen( $signature ) > $wgMaxSigChars ) {
return Xml::element( 'span', array( 'class' => 'error' ),
$form->msg( 'badsiglength' )->numParams( $wgMaxSigChars )->text() );
} elseif ( isset( $alldata['fancysig'] ) &&
$alldata['fancysig'] &&
false === $wgParser->validateSig( $signature ) ) {
return Xml::element( 'span', array( 'class' => 'error' ), $form->msg( 'badsig' )->text() );
} else {
return true;
}
}
/**
* @param $signature string
* @param $alldata array
* @param $form HTMLForm
* @return string
*/
static function cleanSignature( $signature, $alldata, $form ) {
if ( isset( $alldata['fancysig'] ) && $alldata['fancysig'] ) {
global $wgParser;
$signature = $wgParser->cleanSig( $signature );
} else {
// When no fancy sig used, make sure ~{3,5} get removed.
$signature = Parser::cleanSigInSig( $signature );
}
return $signature;
}
/**
* @param $user User
* @param $context IContextSource
* @param $formClass string
* @param $remove Array: array of items to remove
* @return HtmlForm
*/
static function getFormObject( $user, IContextSource $context, $formClass = 'PreferencesForm', array $remove = array() ) {
$formDescriptor = Preferences::getPreferences( $user, $context );
if ( count( $remove ) ) {
$removeKeys = array_flip( $remove );
$formDescriptor = array_diff_key( $formDescriptor, $removeKeys );
}
/**
* @var $htmlForm PreferencesForm
*/
$htmlForm = new $formClass( $formDescriptor, $context, 'prefs' );
$htmlForm->setModifiedUser( $user );
$htmlForm->setId( 'mw-prefs-form' );
$htmlForm->setSubmitText( $context->msg( 'saveprefs' )->text() );
# Used message keys: 'accesskey-preferences-save', 'tooltip-preferences-save'
$htmlForm->setSubmitTooltip( 'preferences-save' );
$htmlForm->setSubmitID( 'prefsubmit' );
$htmlForm->setSubmitCallback( array( 'Preferences', 'tryFormSubmit' ) );
return $htmlForm;
}
/**
* @return array
*/
static function getTimezoneOptions( IContextSource $context ) {
$opt = array();
global $wgLocalTZoffset, $wgLocaltimezone;
// Check that $wgLocalTZoffset is the same as $wgLocaltimezone
if ( $wgLocalTZoffset == date( 'Z' ) / 60 ) {
$server_tz_msg = $context->msg( 'timezoneuseserverdefault', $wgLocaltimezone )->text();
} else {
$tzstring = sprintf( '%+03d:%02d', floor( $wgLocalTZoffset / 60 ), abs( $wgLocalTZoffset ) % 60 );
$server_tz_msg = $context->msg( 'timezoneuseserverdefault', $tzstring )->text();
}
$opt[$server_tz_msg] = "System|$wgLocalTZoffset";
$opt[$context->msg( 'timezoneuseoffset' )->text()] = 'other';
$opt[$context->msg( 'guesstimezone' )->text()] = 'guess';
if ( function_exists( 'timezone_identifiers_list' ) ) {
# Read timezone list
$tzs = timezone_identifiers_list();
sort( $tzs );
$tzRegions = array();
$tzRegions['Africa'] = $context->msg( 'timezoneregion-africa' )->text();
$tzRegions['America'] = $context->msg( 'timezoneregion-america' )->text();
$tzRegions['Antarctica'] = $context->msg( 'timezoneregion-antarctica' )->text();
$tzRegions['Arctic'] = $context->msg( 'timezoneregion-arctic' )->text();
$tzRegions['Asia'] = $context->msg( 'timezoneregion-asia' )->text();
$tzRegions['Atlantic'] = $context->msg( 'timezoneregion-atlantic' )->text();
$tzRegions['Australia'] = $context->msg( 'timezoneregion-australia' )->text();
$tzRegions['Europe'] = $context->msg( 'timezoneregion-europe' )->text();
$tzRegions['Indian'] = $context->msg( 'timezoneregion-indian' )->text();
$tzRegions['Pacific'] = $context->msg( 'timezoneregion-pacific' )->text();
asort( $tzRegions );
$prefill = array_fill_keys( array_values( $tzRegions ), array() );
$opt = array_merge( $opt, $prefill );
$now = date_create( 'now' );
foreach ( $tzs as $tz ) {
$z = explode( '/', $tz, 2 );
# timezone_identifiers_list() returns a number of
# backwards-compatibility entries. This filters them out of the
# list presented to the user.
if ( count( $z ) != 2 || !array_key_exists( $z[0], $tzRegions ) ) {
continue;
}
# Localize region
$z[0] = $tzRegions[$z[0]];
$minDiff = floor( timezone_offset_get( timezone_open( $tz ), $now ) / 60 );
$display = str_replace( '_', ' ', $z[0] . '/' . $z[1] );
$value = "ZoneInfo|$minDiff|$tz";
$opt[$z[0]][$display] = $value;
}
}
return $opt;
}
/**
* @param $value
* @param $alldata
* @return int
*/
static function filterIntval( $value, $alldata ){
return intval( $value );
}
/**
* @param $tz
* @param $alldata
* @return string
*/
static function filterTimezoneInput( $tz, $alldata ) {
$data = explode( '|', $tz, 3 );
switch ( $data[0] ) {
case 'ZoneInfo':
case 'System':
return $tz;
default:
$data = explode( ':', $tz, 2 );
if ( count( $data ) == 2 ) {
$data[0] = intval( $data[0] );
$data[1] = intval( $data[1] );
$minDiff = abs( $data[0] ) * 60 + $data[1];
if ( $data[0] < 0 ) $minDiff = - $minDiff;
} else {
$minDiff = intval( $data[0] ) * 60;
}
# Max is +14:00 and min is -12:00, see:
# http://en.wikipedia.org/wiki/Timezone
$minDiff = min( $minDiff, 840 ); # 14:00
$minDiff = max( $minDiff, - 720 ); # -12:00
return 'Offset|' . $minDiff;
}
}
/**
* @param $formData
* @param $form PreferencesForm
* @param $entryPoint string
* @return bool|Status|string
*/
static function tryFormSubmit( $formData, $form, $entryPoint = 'internal' ) {
global $wgHiddenPrefs;
$user = $form->getModifiedUser();
$result = true;
// Filter input
foreach ( array_keys( $formData ) as $name ) {
if ( isset( self::$saveFilters[$name] ) ) {
$formData[$name] =
call_user_func( self::$saveFilters[$name], $formData[$name], $formData );
}
}
// Stuff that shouldn't be saved as a preference.
$saveBlacklist = array(
'realname',
'emailaddress',
);
// Fortunately, the realname field is MUCH simpler
if ( !in_array( 'realname', $wgHiddenPrefs ) ) {
$realName = $formData['realname'];
$user->setRealName( $realName );
}
foreach ( $saveBlacklist as $b ) {
unset( $formData[$b] );
}
# If users have saved a value for a preference which has subsequently been disabled
# via $wgHiddenPrefs, we don't want to destroy that setting in case the preference
# is subsequently re-enabled
# TODO: maintenance script to actually delete these
foreach( $wgHiddenPrefs as $pref ){
# If the user has not set a non-default value here, the default will be returned
# and subsequently discarded
$formData[$pref] = $user->getOption( $pref, null, true );
}
// Keeps old preferences from interfering due to back-compat
// code, etc.
$user->resetOptions();
foreach ( $formData as $key => $value ) {
$user->setOption( $key, $value );
}
$user->saveSettings();
return $result;
}
/**
* @param $formData
* @param $form PreferencesForm
* @return Status
*/
public static function tryUISubmit( $formData, $form ) {
$res = self::tryFormSubmit( $formData, $form, 'ui' );
if ( $res ) {
$urlOptions = array( 'success' => 1 );
if ( $res === 'eauth' ) {
$urlOptions['eauth'] = 1;
}
$urlOptions += $form->getExtraSuccessRedirectParameters();
$url = $form->getTitle()->getFullURL( $urlOptions );
$form->getContext()->getOutput()->redirect( $url );
}
return Status::newGood();
}
/**
* Try to set a user's email address.
* This does *not* try to validate the address.
* Caller is responsible for checking $wgAuth.
* @param $user User
* @param $newaddr string New email address
* @return Array (true on success or Status on failure, info string)
*/
public static function trySetUserEmail( User $user, $newaddr ) {
global $wgEnableEmail, $wgEmailAuthentication;
$info = ''; // none
if ( $wgEnableEmail ) {
$oldaddr = $user->getEmail();
if ( ( $newaddr != '' ) && ( $newaddr != $oldaddr ) ) {
# The user has supplied a new email address on the login page
# new behaviour: set this new emailaddr from login-page into user database record
$user->setEmail( $newaddr );
if ( $wgEmailAuthentication ) {
# Mail a temporary password to the dirty address.
# User can come back through the confirmation URL to re-enable email.
$type = $oldaddr != '' ? 'changed' : 'set';
$result = $user->sendConfirmationMail( $type );
if ( !$result->isGood() ) {
return array( $result, 'mailerror' );
}
$info = 'eauth';
}
} elseif ( $newaddr != $oldaddr ) { // if the address is the same, don't change it
$user->setEmail( $newaddr );
}
if ( $oldaddr != $newaddr ) {
wfRunHooks( 'PrefsEmailAudit', array( $user, $oldaddr, $newaddr ) );
}
}
return array( true, $info );
}
/**
* @deprecated in 1.19; will be removed in 1.20.
* @param $user User
* @return array
*/
public static function loadOldSearchNs( $user ) {
wfDeprecated( __METHOD__, '1.19' );
$searchableNamespaces = SearchEngine::searchableNamespaces();
// Back compat with old format
$arr = array();
foreach ( $searchableNamespaces as $ns => $name ) {
if ( $user->getOption( 'searchNs' . $ns ) ) {
$arr[] = $ns;
}
}
return $arr;
}
}
/** Some tweaks to allow js prefs to work */
class PreferencesForm extends HTMLForm {
// Override default value from HTMLForm
protected $mSubSectionBeforeFields = false;
private $modifiedUser;
/**
* @param $user User
*/
public function setModifiedUser( $user ) {
$this->modifiedUser = $user;
}
/**
* @return User
*/
public function getModifiedUser() {
if ( $this->modifiedUser === null ) {
return $this->getUser();
} else {
return $this->modifiedUser;
}
}
/**
* Get extra parameters for the query string when redirecting after
* successful save.
*
* @return array()
*/
public function getExtraSuccessRedirectParameters() {
return array();
}
/**
* @param $html string
* @return String
*/
function wrapForm( $html ) {
$html = Xml::tags( 'div', array( 'id' => 'preferences' ), $html );
return parent::wrapForm( $html );
}
/**
* @return String
*/
function getButtons() {
$html = parent::getButtons();
$t = SpecialPage::getTitleFor( 'Preferences', 'reset' );
$html .= "\n" . Linker::link( $t, $this->msg( 'restoreprefs' )->escaped() );
$html = Xml::tags( 'div', array( 'class' => 'mw-prefs-buttons' ), $html );
return $html;
}
/**
* @param $data array
* @return array
*/
function filterDataForSubmit( $data ) {
// Support for separating MultiSelect preferences into multiple preferences
// Due to lack of array support.
foreach ( $this->mFlatFields as $fieldname => $field ) {
$info = $field->mParams;
if ( $field instanceof HTMLMultiSelectField ) {
$options = HTMLFormField::flattenOptions( $info['options'] );
$prefix = isset( $info['prefix'] ) ? $info['prefix'] : $fieldname;
foreach ( $options as $opt ) {
$data["$prefix$opt"] = in_array( $opt, $data[$fieldname] );
}
unset( $data[$fieldname] );
}
}
return $data;
}
/**
* Get the whole body of the form.
* @return string
*/
function getBody() {
return $this->displaySection( $this->mFieldTree, '', 'mw-prefsection-' );
}
/**
* Get the