wiki.techinc.nl/includes/Preferences.php

1649 lines
50 KiB
PHP
Raw Normal View History

<?php
/**
* Form to edit user preferences.
*
* This program is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation; either version 2 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License along
* with this program; if not, write to the Free Software Foundation, Inc.,
* 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
* http://www.gnu.org/copyleft/gpl.html
*
* @file
*/
/**
2009-08-23 20:09:59 +00:00
* We're now using the HTMLForm object with some customisation to generate the
* Preferences form. This object handles generic submission, CSRF protection,
* layout and other logic in a reusable manner. We subclass it as a PreferencesForm
* to make some minor customisations.
*
* In order to generate the form, the HTMLForm object needs an array structure
* detailing the form fields available, and that's what this class is for. Each
* element of the array is a basic property-list, including the type of field,
* the label it is to be given in the form, callbacks for validation and
* 'filtering', and other pertinent information. Note that the 'default' field
* is named for generic forms, and does not represent the preference's default
* (which is stored in $wgDefaultUserOptions), but the default for the form
* field, which should be whatever the user has set for that preference. There
* is no need to override it unless you have some special storage logic (for
* instance, those not presently stored as options, but which are best set from
* the user preferences view).
*
* Field types are implemented as subclasses of the generic HTMLFormField
* object, and typically implement at least getInputHTML, which generates the
* HTML for the input field to be placed in the table.
*
* Once fields have been retrieved and validated, submission logic is handed
* over to the tryUISubmit static method of this class.
*/
class Preferences {
static $defaultPreferences = null;
static $saveFilters = array(
'timecorrection' => array( 'Preferences', 'filterTimezoneInput' ),
'cols' => array( 'Preferences', 'filterIntval' ),
'rows' => array( 'Preferences', 'filterIntval' ),
'rclimit' => array( 'Preferences', 'filterIntval' ),
'wllimit' => array( 'Preferences', 'filterIntval' ),
'searchlimit' => array( 'Preferences', 'filterIntval' ),
);
2009-06-21 14:16:11 +00:00
// Stuff that shouldn't be saved as a preference.
private static $saveBlacklist = array(
'realname',
'emailaddress',
);
/**
* @throws MWException
* @param $user User
* @param $context IContextSource
* @return array|null
*/
static function getPreferences( $user, IContextSource $context ) {
if ( self::$defaultPreferences ) {
return self::$defaultPreferences;
}
2009-06-21 14:16:11 +00:00
$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] ) ) {
2009-06-21 14:16:11 +00:00
unset( $defaultPreferences[$pref] );
}
}
## Make sure that form fields have their parent set. See bug 41337.
$dummyForm = new HTMLForm( array(), $context );
$disable = !$user->isAllowed( 'editmyoptions' );
## Prod in defaults from the user
foreach ( $defaultPreferences as $name => &$info ) {
$prefFromUser = self::getOptionFromUser( $name, $info, $user );
if ( $disable && !in_array( $name, self::$saveBlacklist ) ) {
$info['disabled'] = 'disabled';
}
$field = HTMLForm::loadInputFromParameters( $name, $info ); // For validation
$field->mParent = $dummyForm;
2009-06-09 17:32:33 +00:00
$defaultOptions = User::getDefaultOptions();
2009-06-21 14:16:11 +00:00
$globalDefault = isset( $defaultOptions[$name] )
? $defaultOptions[$name]
: null;
2009-06-21 14:16:11 +00:00
// If it validates, set it as the default
2009-06-21 14:16:11 +00:00
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->getOptions() ) === true ) {
$info['default'] = $prefFromUser;
} elseif ( $field->validate( $globalDefault, $user->getOptions() ) === true ) {
$info['default'] = $globalDefault;
} else {
throw new MWException( "Global default '$globalDefault' is invalid for field $name" );
}
}
2009-06-21 14:16:11 +00:00
self::$defaultPreferences = $defaultPreferences;
2009-06-21 14:16:11 +00:00
return $defaultPreferences;
}
2009-06-21 14:16:11 +00:00
/**
* 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 );
2009-06-21 14:16:11 +00:00
// Handling for multiselect preferences
2009-06-21 14:16:11 +00:00
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();
2009-06-21 14:16:11 +00:00
2010-10-14 20:53:04 +00:00
foreach ( $options as $value ) {
if ( $user->getOption( "$prefix$value" ) ) {
$val[] = $value;
}
}
}
2009-06-21 14:16:11 +00:00
// Handling for checkmatrix preferences
if ( ( isset( $info['type'] ) && $info['type'] == 'checkmatrix' ) ||
( isset( $info['class'] ) && $info['class'] == 'HTMLCheckMatrix' ) ) {
$columns = HTMLFormField::flattenOptions( $info['columns'] );
$rows = HTMLFormField::flattenOptions( $info['rows'] );
$prefix = isset( $info['prefix'] ) ? $info['prefix'] : $name;
$val = array();
foreach ( $columns as $column ) {
foreach ( $rows as $row ) {
if ( $user->getOption( "$prefix$column-$row" ) ) {
$val[] = "$column-$row";
}
}
}
}
return $val;
}
2009-06-21 14:16:11 +00:00
/**
* @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,
$wgSecureLogin;
// retrieving user name for GENDER and misc.
$userName = $user->getName();
## User info #####################################
// Information panel
$defaultPreferences['username'] = array(
'type' => 'info',
'label-message' => array( 'username', $userName ),
'default' => $userName,
'section' => 'personal/info',
);
2009-06-21 14:16:11 +00:00
$defaultPreferences['userid'] = array(
'type' => 'info',
'label-message' => array( 'uid', $userName ),
'default' => $user->getId(),
'section' => 'personal/info',
);
2009-06-21 14:16:11 +00:00
# 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, $userName );
$userMembers[] = User::makeGroupLinkHTML( $ueg, $memberName );
}
asort( $userGroups );
asort( $userMembers );
2009-06-21 14:16:11 +00:00
$lang = $context->getLanguage();
$defaultPreferences['usergroups'] = array(
'type' => 'info',
'label' => $context->msg( 'prefs-memberingroups' )->numParams(
count( $userGroups ) )->params( $userName )->parse(),
'default' => $context->msg( 'prefs-memberingroups-type',
$lang->commaList( $userGroups ),
$lang->commaList( $userMembers )
)->plain(),
'raw' => true,
'section' => 'personal/info',
);
2009-06-21 14:16:11 +00:00
$editCount = Linker::link( SpecialPage::getTitleFor( "Contributions", $userName ),
$lang->formatNum( $user->getEditCount() ) );
$defaultPreferences['editcount'] = array(
'type' => 'info',
'raw' => true,
'label-message' => 'prefs-edits',
'default' => $editCount,
'section' => 'personal/info',
);
2009-06-21 14:16:11 +00:00
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',
);
}
2009-06-21 14:16:11 +00:00
$canViewPrivateInfo = $user->isAllowed( 'viewmyprivateinfo' );
$canEditPrivateInfo = $user->isAllowed( 'editmyprivateinfo' );
// Actually changeable stuff
$defaultPreferences['realname'] = array(
// (not really "private", but still shouldn't be edited without permission)
'type' => $canEditPrivateInfo && $wgAuth->allowPropChange( 'realname' ) ? 'text' : 'info',
'default' => $user->getRealName(),
'section' => 'personal/info',
'label-message' => 'yourrealname',
'help-message' => 'prefs-help-realname',
);
if ( $canEditPrivateInfo && $wgAuth->allowPasswordChange() ) {
2011-08-03 17:19:32 +00:00
$link = Linker::link( SpecialPage::getTitleFor( 'ChangePassword' ),
$context->msg( 'prefs-resetpass' )->escaped(), array(),
array( 'returnto' => SpecialPage::getTitleFor( 'Preferences' )->getPrefixedText() ) );
2009-06-21 14:16:11 +00:00
$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',
);
}
// Only show preferhttps if secure login is turned on
if ( $wgSecureLogin && wfCanIPUseHTTPS( $context->getRequest()->getIP() ) ) {
$defaultPreferences['prefershttps'] = array(
'type' => 'toggle',
'label-message' => 'tog-prefershttps',
'help-message' => 'prefs-help-prefershttps',
'section' => 'personal/info'
);
}
2009-06-21 14:16:11 +00:00
// Language
$languages = Language::fetchLanguageNames( null, 'mw' );
if ( !array_key_exists( $wgLanguageCode, $languages ) ) {
$languages[$wgLanguageCode] = $wgLanguageCode;
}
ksort( $languages );
2009-06-21 14:16:11 +00:00
$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',
);
2009-06-21 14:16:11 +00:00
$defaultPreferences['gender'] = array(
'type' => 'radio',
'section' => 'personal/i18n',
'options' => array(
$context->msg( 'parentheses',
$context->msg( 'gender-unknown' )->text()
)->text() => 'unknown',
$context->msg( 'gender-female' )->text() => 'female',
$context->msg( 'gender-male' )->text() => 'male',
),
'label-message' => 'yourgender',
'help-message' => 'prefs-help-gender',
);
// see if there are multiple language variants to choose from
if ( !$wgDisableLangConversion ) {
foreach ( LanguageConverter::$languagesWithVariants as $langCode ) {
if ( $langCode == $wgContLang->getCode() ) {
$variants = $wgContLang->getVariants();
if ( count( $variants ) <= 1 ) {
continue;
}
$variantArray = array();
foreach ( $variants as $v ) {
$v = str_replace( '_', '-', strtolower( $v ) );
$variantArray[$v] = $lang->getVariantname( $v, false );
}
$options = array();
foreach ( $variantArray as $code => $name ) {
$display = wfBCP47( $code ) . ' - ' . $name;
$options[$display] = $code;
}
$defaultPreferences['variant'] = array(
'label-message' => 'yourvariant',
'type' => 'select',
'options' => $options,
'section' => 'personal/i18n',
'help-message' => 'prefs-help-variant',
);
if ( !$wgDisableTitleConversion ) {
$defaultPreferences['noconvertlink'] = array(
'type' => 'toggle',
'section' => 'personal/i18n',
'label-message' => 'tog-noconvertlink',
);
}
} else {
$defaultPreferences["variant-$langCode"] = array(
'type' => 'api',
);
}
}
}
2009-06-21 14:16:11 +00:00
// Stuff from Language::getExtraUserToggles()
// FIXME is this dead code? $extraUserToggles doesn't seem to be defined for any language
$toggles = $wgContLang->getExtraUserToggles();
foreach ( $toggles as $toggle ) {
$defaultPreferences[$toggle] = array(
'type' => 'toggle',
'section' => 'personal/i18n',
'label-message' => "tog-$toggle",
);
}
// 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 ) {
if ( $canViewPrivateInfo ) {
$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';
}
$emailAddress = $user->getEmail() ? htmlspecialchars( $user->getEmail() ) : '';
if ( $canEditPrivateInfo && $wgAuth->allowPropChange( 'emailaddress' ) ) {
$link = Linker::link(
SpecialPage::getTitleFor( 'ChangeEmail' ),
$context->msg( $user->getEmail() ? 'prefs-changeemail' : 'prefs-setemail' )->escaped(),
array(),
array( 'returnto' => SpecialPage::getTitleFor( 'Preferences' )->getPrefixedText() ) );
$emailAddress .= $emailAddress == '' ? $link : (
$context->msg( 'word-separator' )->plain()
. $context->msg( 'parentheses' )->rawParams( $link )->plain()
);
}
$defaultPreferences['emailaddress'] = array(
'type' => 'info',
'raw' => true,
'default' => $emailAddress,
'label-message' => 'youremail',
'section' => 'personal/email',
'help-messages' => $helpMessages,
# 'cssclass' chosen below
);
}
$disableEmailPrefs = false;
if ( $wgEmailAuthentication ) {
$emailauthenticationclass = 'mw-email-not-authenticated';
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() . '<br />';
$disableEmailPrefs = false;
$emailauthenticationclass = 'mw-email-authenticated';
} else {
$disableEmailPrefs = true;
$emailauthenticated = $context->msg( 'emailnotauthenticated' )->parse() . '<br />' .
2011-08-03 17:19:32 +00:00
Linker::linkKnown(
SpecialPage::getTitleFor( 'Confirmemail' ),
$context->msg( 'emailconfirmlink' )->escaped()
) . '<br />';
$emailauthenticationclass = "mw-email-not-authenticated";
}
} else {
$disableEmailPrefs = true;
$emailauthenticated = $context->msg( 'noemailprefs' )->escaped();
$emailauthenticationclass = 'mw-email-none';
}
if ( $canViewPrivateInfo ) {
$defaultPreferences['emailauthentication'] = array(
'type' => 'info',
'raw' => true,
'section' => 'personal/email',
'label-message' => 'prefs-emailconfirm-label',
'default' => $emailauthenticated,
# Apply the same CSS class used on the input to the message:
'cssclass' => $emailauthenticationclass,
);
$defaultPreferences['emailaddress']['cssclass'] = $emailauthenticationclass;
}
}
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,
);
}
}
}
}
2009-06-21 14:16:11 +00:00
/**
* @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 ),
Remove most named character references from output Recommit of r66254 to trunk. This was just find extensions phase3 -iname '*.php' \! -iname '*.i18n.php' \! -iname 'Messages*.php' \! -iname '*_Messages.php' -exec sed -i 's/&nbsp;/\&#160;/g;s/&mdash;/―/g;s/&bull;/•/g;s/&aacute;/á/g;s/&acute;/´/g;s/&agrave;/à/g;s/&alpha;/α/g;s/&auml;/ä/g;s/&ccedil;/ç/g;s/&copy;/©/g;s/&darr;/↓/g;s/&deg;/°/g;s/&eacute;/é/g;s/&ecirc;/ê/g;s/&euml;/ë/g;s/&egrave;/è/g;s/&euro;/€/g;s/&harr;//g;s/&hellip;/…/g;s/&iacute;/í/g;s/&igrave;/ì/g;s/&larr;/←/g;s/&ldquo;/“/g;s/&middot;/·/g;s/&minus;/−/g;s/&ndash;/–/g;s/&oacute;/ó/g;s/&ocirc;/ô/g;s/&oelig;/œ/g;s/&ograve;/ò/g;s/&otilde;/õ/g;s/&ouml;/ö/g;s/&pound;/£/g;s/&prime;/′/g;s/&Prime;/″/g;s/&raquo;/»/g;s/&rarr;/→/g;s/&rdquo;/”/g;s/&Sigma;/Σ/g;s/&times;/×/g;s/&uacute;/ú/g;s/&uarr;/↑/g;s/&uuml;/ü/g;s/&yen;/¥/g' {} + followed by reading over every single line of the resulting diff and fixing a whole bunch of false positives. The reason for this change is given in <http://lists.wikimedia.org/pipermail/wikitech-l/2010-April/047617.html>. I cleared it with Tim and Brion on IRC before committing. It might cause a few problems, but I tried to be careful; please report any issues. I skipped all messages files. I plan to make a follow-up commit that alters wfMsgExt() with 'escapenoentities' to sanitize all the entities. That way, the only messages that will be problems will be ones that output raw HTML, and we want to get rid of those anyway. This should get rid of all named entities everywhere except messages. I skipped a few things like &nbsp that I noticed in manual inspection, because they weren't well-formed XML anyway. Also, to everyone who uses non-breaking spaces when they could use a normal space, or nothing at all, or CSS padding: I still hate you. Die.
2010-05-30 17:33:59 +00:00
'label' => '&#160;',
'section' => 'rendering/skin',
);
2009-06-21 14:16:11 +00:00
# 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();
$userName = $user->getName();
if ( $wgAllowUserCss ) {
$cssPage = Title::makeTitleSafe( NS_USER, $userName . '/common.css' );
$linkTools[] = Linker::link( $cssPage, $context->msg( 'prefs-custom-css' )->escaped() );
}
if ( $wgAllowUserJs ) {
$jsPage = Title::makeTitleSafe( NS_USER, $userName . '/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',
);
}
}
2009-06-21 14:16:11 +00:00
2011-05-28 16:32:09 +00:00
/**
* @param $user User
* @param $context IContextSource
2011-05-28 16:32:09 +00:00
* @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',
);
}
2009-06-21 14:16:11 +00:00
/**
* @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,
Remove most named character references from output Recommit of r66254 to trunk. This was just find extensions phase3 -iname '*.php' \! -iname '*.i18n.php' \! -iname 'Messages*.php' \! -iname '*_Messages.php' -exec sed -i 's/&nbsp;/\&#160;/g;s/&mdash;/―/g;s/&bull;/•/g;s/&aacute;/á/g;s/&acute;/´/g;s/&agrave;/à/g;s/&alpha;/α/g;s/&auml;/ä/g;s/&ccedil;/ç/g;s/&copy;/©/g;s/&darr;/↓/g;s/&deg;/°/g;s/&eacute;/é/g;s/&ecirc;/ê/g;s/&euml;/ë/g;s/&egrave;/è/g;s/&euro;/€/g;s/&harr;//g;s/&hellip;/…/g;s/&iacute;/í/g;s/&igrave;/ì/g;s/&larr;/←/g;s/&ldquo;/“/g;s/&middot;/·/g;s/&minus;/−/g;s/&ndash;/–/g;s/&oacute;/ó/g;s/&ocirc;/ô/g;s/&oelig;/œ/g;s/&ograve;/ò/g;s/&otilde;/õ/g;s/&ouml;/ö/g;s/&pound;/£/g;s/&prime;/′/g;s/&Prime;/″/g;s/&raquo;/»/g;s/&rarr;/→/g;s/&rdquo;/”/g;s/&Sigma;/Σ/g;s/&times;/×/g;s/&uacute;/ú/g;s/&uarr;/↑/g;s/&uuml;/ü/g;s/&yen;/¥/g' {} + followed by reading over every single line of the resulting diff and fixing a whole bunch of false positives. The reason for this change is given in <http://lists.wikimedia.org/pipermail/wikitech-l/2010-April/047617.html>. I cleared it with Tim and Brion on IRC before committing. It might cause a few problems, but I tried to be careful; please report any issues. I skipped all messages files. I plan to make a follow-up commit that alters wfMsgExt() with 'escapenoentities' to sanitize all the entities. That way, the only messages that will be problems will be ones that output raw HTML, and we want to get rid of those anyway. This should get rid of all named entities everywhere except messages. I skipped a few things like &nbsp that I noticed in manual inspection, because they weren't well-formed XML anyway. Also, to everyone who uses non-breaking spaces when they could use a normal space, or nothing at all, or CSS padding: I still hate you. Die.
2010-05-30 17:33:59 +00:00
'label' => '&#160;',
'section' => 'datetime/dateformat',
);
}
2009-06-21 14:16:11 +00:00
// 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 ) );
2009-06-21 14:16:11 +00:00
$defaultPreferences['nowserver'] = array(
'type' => 'info',
'raw' => 1,
'label-message' => 'servertime',
'default' => $nowserver,
'section' => 'datetime/timeoffset',
);
2009-06-21 14:16:11 +00:00
$defaultPreferences['nowlocal'] = array(
'type' => 'info',
'raw' => 1,
'label-message' => 'localtime',
'default' => $nowlocal,
'section' => 'datetime/timeoffset',
);
2009-06-21 14:16:11 +00:00
// Grab existing pref.
$tzOffset = $user->getOption( 'timecorrection' );
$tz = explode( '|', $tzOffset, 3 );
$tzOptions = self::getTimezoneOptions( $context );
2009-06-21 14:16:11 +00:00
$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]}";
}
}
2009-06-21 14:16:11 +00:00
$defaultPreferences['timecorrection'] = array(
'class' => 'HTMLSelectOrOtherField',
'label-message' => 'timezonelegend',
'options' => $tzOptions,
'default' => $tzSetting,
'size' => 20,
'section' => 'datetime/timeoffset',
);
}
2009-06-21 14:16:11 +00:00
2011-05-28 16:32:09 +00:00
/**
* @param $user User
* @param $context IContextSource
2011-05-28 16:32:09 +00:00
* @param $defaultPreferences Array
*/
static function renderingPreferences( $user, IContextSource $context, &$defaultPreferences ) {
## Diffs ####################################
$defaultPreferences['diffonly'] = array(
'type' => 'toggle',
'section' => 'rendering/diffs',
'label-message' => 'tog-diffonly',
);
$defaultPreferences['norollbackdiff'] = array(
'type' => 'toggle',
'section' => 'rendering/diffs',
'label-message' => 'tog-norollbackdiff',
);
## 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',
);
}
2009-06-21 14:16:11 +00:00
$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;
}
2009-06-21 14:16:11 +00:00
$defaultPreferences['stubthreshold'] = array(
'type' => 'selectorother',
'section' => 'rendering/advancedrendering',
'options' => $stubThresholdOptions,
'size' => 20,
'label-raw' => $context->msg( 'stub-threshold' )->text(), // Raw HTML message. Yay?
);
if ( $wgAllowUserCssPrefs ) {
$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'
);
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',
);
}
2009-06-21 14:16:11 +00:00
2011-05-28 16:32:09 +00:00
/**
* @param $user User
* @param $context IContextSource
2011-05-28 16:32:09 +00:00
* @param $defaultPreferences Array
*/
static function editingPreferences( $user, IContextSource $context, &$defaultPreferences ) {
global $wgAllowUserCssPrefs;
## Editing #####################################
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',
);
if ( $wgAllowUserCssPrefs ) {
$defaultPreferences['editfont'] = array(
'type' => 'select',
'section' => 'editing/editor',
'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['cols'] = array(
'type' => 'int',
'label-message' => 'columns',
'section' => 'editing/editor',
'min' => 4,
'max' => 1000,
);
$defaultPreferences['rows'] = array(
'type' => 'int',
'label-message' => 'rows',
'section' => 'editing/editor',
'min' => 4,
'max' => 1000,
);
if ( $user->isAllowed( 'minoredit' ) ) {
$defaultPreferences['minordefault'] = array(
'type' => 'toggle',
'section' => 'editing/editor',
'label-message' => 'tog-minordefault',
);
}
$defaultPreferences['forceeditsummary'] = array(
'type' => 'toggle',
'section' => 'editing/editor',
'label-message' => 'tog-forceeditsummary',
);
$defaultPreferences['useeditwarning'] = array(
'type' => 'toggle',
'section' => 'editing/editor',
'label-message' => 'tog-useeditwarning',
);
$defaultPreferences['showtoolbar'] = array(
'type' => 'toggle',
'section' => 'editing/editor',
'label-message' => 'tog-showtoolbar',
);
$defaultPreferences['previewonfirst'] = array(
'type' => 'toggle',
'section' => 'editing/preview',
'label-message' => 'tog-previewonfirst',
);
$defaultPreferences['previewontop'] = array(
'type' => 'toggle',
'section' => 'editing/preview',
'label-message' => 'tog-previewontop',
);
$defaultPreferences['uselivepreview'] = array(
'type' => 'toggle',
'section' => 'editing/preview',
'label-message' => 'tog-uselivepreview',
);
}
2009-06-21 14:16:11 +00:00
2011-05-28 16:32:09 +00:00
/**
* @param $user User
* @param $context IContextSource
2011-05-28 16:32:09 +00:00
* @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',
);
2009-06-21 14:16:11 +00:00
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',
);
}
2009-06-21 14:16:11 +00:00
if ( $wgRCShowWatchingUsers ) {
$defaultPreferences['shownumberswatching'] = array(
'type' => 'toggle',
'section' => 'rc/advancedrc',
'label-message' => 'tog-shownumberswatching',
);
}
}
2009-06-21 14:16:11 +00:00
/**
* @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',
);
}
2009-06-21 14:16:11 +00:00
$watchTypes = array(
'edit' => 'watchdefault',
'move' => 'watchmoves',
'delete' => 'watchdeletion'
);
// Kinda hacky
if ( $user->isAllowed( 'createpage' ) || $user->isAllowed( 'createtalk' ) ) {
$watchTypes['read'] = 'watchcreations';
}
2009-06-21 14:16:11 +00:00
foreach ( $watchTypes as $action => $pref ) {
if ( $user->isAllowed( $action ) ) {
// Messages:
// tog-watchdefault, tog-watchmoves, tog-watchdeletion, tog-watchcreations
$defaultPreferences[$pref] = array(
'type' => 'toggle',
'section' => 'watchlist/advancedwatchlist',
'label-message' => "tog-$pref",
);
}
}
2013-06-14 16:59:59 +00:00
if ( $wgEnableAPI ) {
$defaultPreferences['watchlisttoken'] = array(
'type' => 'api',
);
$defaultPreferences['watchlisttoken-info'] = array(
'type' => 'info',
'section' => 'watchlist/tokenwatchlist',
'label-message' => 'prefs-watchlist-token',
'default' => $user->getTokenFromOption( 'watchlisttoken' ),
'help-message' => 'prefs-help-watchlist-token2',
);
}
}
2009-06-21 14:16:11 +00:00
2011-05-28 16:32:09 +00:00
/**
* @param $user User
* @param $context IContextSource
2011-05-28 16:32:09 +00:00
* @param $defaultPreferences Array
*/
static function searchPreferences( $user, IContextSource $context, &$defaultPreferences ) {
(bug 40448) Replace legacy mwsuggest with mediawiki.searchSuggest The module has been broken for a while now, but nobody noticed because in plain core it is disabled by default, and in the bundle we ship with Extension:Vector (and its SimpleSearch). This commit removed the mediawiki.legacy.mwsuggest module (and related components that become obsolete with its deletion) and replaces it with the new mediawiki.searchSuggest module, which is based on SimpleSearch from Extension:Vector (where it will be removed soon). The following and all references to it in core have been removed, I also made sure that they weren't used in any of extensions/*. Only matches in extensions/Settings and some file that dumped the startup module, and in extensions/Vector which are addressed in I1d5bf81a8a0266c51c99d41eefacc0f4b3ae4b76. Had to make a few updates to jquery.suggestions to make it work in other skins. So far it was only used in Vector, but now that it is used in mediawiki.searchSuggest, I noticed several issues in other skins. Most importantly the fact that it assumed the default offset was from the right corner, which isn't the case in Monobook where the search bar is on the left (in the sidebar). It now detects the appropiate origin corner automatically, and also takes directionality of the page into account. It also uses the correct font-size automatically. Previously it used font-size: 0.8; but that only works in Vector. Every skin seems to have its own way of making a sane font-size. In Monobook the <body> has an extra small font-size which is then fixed in div#globalWrapper, and in Vector it is extra large, which is then fixed as well deeper in the document. Either way, the size on <body> can't be used, and since this suggestions box is appended to the <body> (it is a generic jQuery plugin without knowledge of the document, and even if we could give it knowledge inside the configuration, it'd have to be per-skin). So I removed the Vector specific font-size and let it handle it automatically. This was needed because it is now used in all skins. Removed modules: * mediawiki.legacy.mwsuggest: > Replaced with mediawiki.searchSuggest. Removed messages: * search-mwsuggest-enabled * search-mwsuggest-disabled > No longer used. Removed mw.config.values: * wgMWSuggestTemplate > Obsolete. * wgSearchNamespaces > Obsolete. Removed server-side settings: * $wgEnableMWSuggest > Suggestions are now enabled by default and can be disabled through the user preference `disablesuggest` still. They can be disabled by default site-wide or hidden from prefs through the standard mechanisms for that. * $wgMWSuggestTemplate > Obsolete. Removed methods * SearchEngine::getMWSuggestTemplate() > Obsolete. Filters: $ ack mwsuggest -i -Q --ignore-dir=languages/messages $ ack wgSearchNamespaces -Q Message changes: * vector-simplesearch-preference > It was wrong, it didn't activate search suggestions, that was handled by the Vector extension. This preference in MediaWiki core controls whether the SimpleSearch bar HTML and CSS will be used (e.g. the rectangle search box with the magnifying class instead of the browser-default input field with the plain submit buttons). * searchsuggest-search * searchsuggest-containing These come from Extension:Vector message and should be imported by translatewiki: - vector-simplesearch-search - vector-simplesearch-containing Change-Id: Icd721011b40bb8d2c20aefa8b359a3e45413a07f
2012-09-23 01:06:53 +00:00
global $wgContLang, $wgVectorUseSimpleSearch;
2009-06-21 14:16:11 +00:00
## Search #####################################
$defaultPreferences['searchlimit'] = array(
'type' => 'int',
'label-message' => 'resultsperpage',
'section' => 'searchoptions/displaysearchoptions',
'min' => 0,
);
if ( $wgVectorUseSimpleSearch ) {
$defaultPreferences['vector-simplesearch'] = array(
'type' => 'toggle',
'label-message' => 'vector-simplesearch-preference',
(bug 40448) Replace legacy mwsuggest with mediawiki.searchSuggest The module has been broken for a while now, but nobody noticed because in plain core it is disabled by default, and in the bundle we ship with Extension:Vector (and its SimpleSearch). This commit removed the mediawiki.legacy.mwsuggest module (and related components that become obsolete with its deletion) and replaces it with the new mediawiki.searchSuggest module, which is based on SimpleSearch from Extension:Vector (where it will be removed soon). The following and all references to it in core have been removed, I also made sure that they weren't used in any of extensions/*. Only matches in extensions/Settings and some file that dumped the startup module, and in extensions/Vector which are addressed in I1d5bf81a8a0266c51c99d41eefacc0f4b3ae4b76. Had to make a few updates to jquery.suggestions to make it work in other skins. So far it was only used in Vector, but now that it is used in mediawiki.searchSuggest, I noticed several issues in other skins. Most importantly the fact that it assumed the default offset was from the right corner, which isn't the case in Monobook where the search bar is on the left (in the sidebar). It now detects the appropiate origin corner automatically, and also takes directionality of the page into account. It also uses the correct font-size automatically. Previously it used font-size: 0.8; but that only works in Vector. Every skin seems to have its own way of making a sane font-size. In Monobook the <body> has an extra small font-size which is then fixed in div#globalWrapper, and in Vector it is extra large, which is then fixed as well deeper in the document. Either way, the size on <body> can't be used, and since this suggestions box is appended to the <body> (it is a generic jQuery plugin without knowledge of the document, and even if we could give it knowledge inside the configuration, it'd have to be per-skin). So I removed the Vector specific font-size and let it handle it automatically. This was needed because it is now used in all skins. Removed modules: * mediawiki.legacy.mwsuggest: > Replaced with mediawiki.searchSuggest. Removed messages: * search-mwsuggest-enabled * search-mwsuggest-disabled > No longer used. Removed mw.config.values: * wgMWSuggestTemplate > Obsolete. * wgSearchNamespaces > Obsolete. Removed server-side settings: * $wgEnableMWSuggest > Suggestions are now enabled by default and can be disabled through the user preference `disablesuggest` still. They can be disabled by default site-wide or hidden from prefs through the standard mechanisms for that. * $wgMWSuggestTemplate > Obsolete. Removed methods * SearchEngine::getMWSuggestTemplate() > Obsolete. Filters: $ ack mwsuggest -i -Q --ignore-dir=languages/messages $ ack wgSearchNamespaces -Q Message changes: * vector-simplesearch-preference > It was wrong, it didn't activate search suggestions, that was handled by the Vector extension. This preference in MediaWiki core controls whether the SimpleSearch bar HTML and CSS will be used (e.g. the rectangle search box with the magnifying class instead of the browser-default input field with the plain submit buttons). * searchsuggest-search * searchsuggest-containing These come from Extension:Vector message and should be imported by translatewiki: - vector-simplesearch-search - vector-simplesearch-containing Change-Id: Icd721011b40bb8d2c20aefa8b359a3e45413a07f
2012-09-23 01:06:53 +00:00
'section' => 'searchoptions/displaysearchoptions',
);
}
2009-06-21 14:16:11 +00:00
(bug 40448) Replace legacy mwsuggest with mediawiki.searchSuggest The module has been broken for a while now, but nobody noticed because in plain core it is disabled by default, and in the bundle we ship with Extension:Vector (and its SimpleSearch). This commit removed the mediawiki.legacy.mwsuggest module (and related components that become obsolete with its deletion) and replaces it with the new mediawiki.searchSuggest module, which is based on SimpleSearch from Extension:Vector (where it will be removed soon). The following and all references to it in core have been removed, I also made sure that they weren't used in any of extensions/*. Only matches in extensions/Settings and some file that dumped the startup module, and in extensions/Vector which are addressed in I1d5bf81a8a0266c51c99d41eefacc0f4b3ae4b76. Had to make a few updates to jquery.suggestions to make it work in other skins. So far it was only used in Vector, but now that it is used in mediawiki.searchSuggest, I noticed several issues in other skins. Most importantly the fact that it assumed the default offset was from the right corner, which isn't the case in Monobook where the search bar is on the left (in the sidebar). It now detects the appropiate origin corner automatically, and also takes directionality of the page into account. It also uses the correct font-size automatically. Previously it used font-size: 0.8; but that only works in Vector. Every skin seems to have its own way of making a sane font-size. In Monobook the <body> has an extra small font-size which is then fixed in div#globalWrapper, and in Vector it is extra large, which is then fixed as well deeper in the document. Either way, the size on <body> can't be used, and since this suggestions box is appended to the <body> (it is a generic jQuery plugin without knowledge of the document, and even if we could give it knowledge inside the configuration, it'd have to be per-skin). So I removed the Vector specific font-size and let it handle it automatically. This was needed because it is now used in all skins. Removed modules: * mediawiki.legacy.mwsuggest: > Replaced with mediawiki.searchSuggest. Removed messages: * search-mwsuggest-enabled * search-mwsuggest-disabled > No longer used. Removed mw.config.values: * wgMWSuggestTemplate > Obsolete. * wgSearchNamespaces > Obsolete. Removed server-side settings: * $wgEnableMWSuggest > Suggestions are now enabled by default and can be disabled through the user preference `disablesuggest` still. They can be disabled by default site-wide or hidden from prefs through the standard mechanisms for that. * $wgMWSuggestTemplate > Obsolete. Removed methods * SearchEngine::getMWSuggestTemplate() > Obsolete. Filters: $ ack mwsuggest -i -Q --ignore-dir=languages/messages $ ack wgSearchNamespaces -Q Message changes: * vector-simplesearch-preference > It was wrong, it didn't activate search suggestions, that was handled by the Vector extension. This preference in MediaWiki core controls whether the SimpleSearch bar HTML and CSS will be used (e.g. the rectangle search box with the magnifying class instead of the browser-default input field with the plain submit buttons). * searchsuggest-search * searchsuggest-containing These come from Extension:Vector message and should be imported by translatewiki: - vector-simplesearch-search - vector-simplesearch-containing Change-Id: Icd721011b40bb8d2c20aefa8b359a3e45413a07f
2012-09-23 01:06:53 +00:00
$defaultPreferences['disablesuggest'] = array(
'type' => 'toggle',
'label-message' => 'mwsuggest-disable',
'section' => 'searchoptions/displaysearchoptions',
);
$defaultPreferences['searcheverything'] = array(
'type' => 'toggle',
'label-message' => 'searcheverything-enable',
'section' => 'searchoptions/advancedsearchoptions',
);
2009-06-21 14:16:11 +00:00
$nsOptions = $wgContLang->getFormattedNamespaces();
$nsOptions[0] = $context->msg( 'blanknamespace' )->text();
foreach ( $nsOptions as $ns => $name ) {
if ( $ns < 0 ) {
unset( $nsOptions[$ns] );
}
}
2009-06-21 14:16:11 +00:00
$defaultPreferences['searchnamespaces'] = array(
'type' => 'multiselect',
'label-message' => 'defaultns',
'options' => array_flip( $nsOptions ),
'section' => 'searchoptions/advancedsearchoptions',
'prefix' => 'searchNs',
);
}
2009-06-21 14:16:11 +00:00
2011-05-28 16:32:09 +00:00
/**
* Dummy, kept for backwards-compatibility.
2011-05-28 16:32:09 +00:00
*/
static function miscPreferences( $user, IContextSource $context, &$defaultPreferences ) {
}
2009-06-21 14:16:11 +00:00
/**
* @param $user User The User object
* @param $context IContextSource
2010-07-01 20:45:21 +00:00
* @return Array: text/links to display as key; $skinkey as value
*/
static function generateSkinOptions( $user, IContextSource $context ) {
global $wgDefaultSkin, $wgAllowUserCss, $wgAllowUserJs;
$ret = array();
2009-06-21 14:16:11 +00:00
$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() );
}
}
2009-06-21 14:16:11 +00:00
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( array( 'useskin' => $skinkey ) ) );
$linkTools[] = "<a target='_blank' href=\"$mplink\">$previewtext</a>";
# Create links to user CSS/JS pages
if ( $wgAllowUserCss ) {
2009-06-21 14:16:11 +00:00
$cssPage = Title::makeTitleSafe( NS_USER, $user->getName() . '/' . $skinkey . '.css' );
$linkTools[] = Linker::link( $cssPage, $context->msg( 'prefs-custom-css' )->escaped() );
}
if ( $wgAllowUserJs ) {
2009-06-21 14:16:11 +00:00
$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;
}
2009-06-21 14:16:11 +00:00
return $ret;
}
2009-06-21 14:16:11 +00:00
2011-05-28 16:32:09 +00:00
/**
* @param $context IContextSource
2011-05-28 16:32:09 +00:00
* @return array
*/
static function getDateOptions( IContextSource $context ) {
$lang = $context->getLanguage();
$dateopts = $lang->getDatePreferences();
2009-06-21 14:16:11 +00:00
$ret = array();
2009-06-21 14:16:11 +00:00
if ( $dateopts ) {
if ( !in_array( 'default', $dateopts ) ) {
$dateopts[] = 'default'; // Make sure default is always valid
2009-06-21 14:16:11 +00:00
// Bug 19237
}
// KLUGE: site default might not be valid for user language
global $wgDefaultUserOptions;
if ( !in_array( $wgDefaultUserOptions['date'], $dateopts ) ) {
$wgDefaultUserOptions['date'] = 'default';
}
2009-06-21 14:16:11 +00:00
$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;
}
2009-06-21 14:16:11 +00:00
2011-05-28 16:32:09 +00:00
/**
* @param $context IContextSource
2011-05-28 16:32:09 +00:00
* @return array
*/
static function getImageSizes( IContextSource $context ) {
global $wgImageLimits;
2009-06-21 14:16:11 +00:00
$ret = array();
$pixels = $context->msg( 'unit-pixel' )->text();
2009-06-21 14:16:11 +00:00
foreach ( $wgImageLimits as $index => $limits ) {
$display = "{$limits[0]}×{$limits[1]}" . $pixels;
$ret[$display] = $index;
}
2009-06-21 14:16:11 +00:00
return $ret;
}
2009-06-21 14:16:11 +00:00
2011-05-28 16:32:09 +00:00
/**
* @param $context IContextSource
2011-05-28 16:32:09 +00:00
* @return array
*/
static function getThumbSizes( IContextSource $context ) {
global $wgThumbLimits;
2009-06-21 14:16:11 +00:00
$ret = array();
$pixels = $context->msg( 'unit-pixel' )->text();
2009-06-21 14:16:11 +00:00
foreach ( $wgThumbLimits as $index => $size ) {
$display = $size . $pixels;
$ret[$display] = $index;
}
2009-06-21 14:16:11 +00:00
return $ret;
}
2009-06-21 14:16:11 +00:00
2011-05-28 16:32:09 +00:00
/**
* @param $signature string
* @param $alldata array
* @param $form HTMLForm
2011-05-28 16:32:09 +00:00
* @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() );
2010-10-02 21:35:00 +00:00
} elseif ( isset( $alldata['fancysig'] ) &&
$alldata['fancysig'] &&
false === $wgParser->validateSig( $signature ) ) {
return Xml::element( 'span', array( 'class' => 'error' ), $form->msg( 'badsig' )->text() );
} else {
return true;
}
}
2009-06-21 14:16:11 +00:00
2011-05-28 16:32:09 +00:00
/**
2011-05-29 14:01:47 +00:00
* @param $signature string
* @param $alldata array
* @param $form HTMLForm
2011-05-29 14:01:47 +00:00
* @return string
2011-05-28 16:32:09 +00:00
*/
static function cleanSignature( $signature, $alldata, $form ) {
2010-10-02 21:35:00 +00:00
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 );
}
2009-06-21 14:16:11 +00:00
return $signature;
}
2009-06-21 14:16:11 +00:00
2011-05-28 16:32:09 +00:00
/**
* @param $user User
* @param $context IContextSource
2011-05-28 16:32:09 +00:00
* @param $formClass string
* @param array $remove array of items to remove
2011-05-28 16:32:09 +00:00
* @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 );
}
// Remove type=api preferences. They are not intended for rendering in the form.
foreach ( $formDescriptor as $name => $info ) {
if ( isset( $info['type'] ) && $info['type'] === 'api' ) {
unset( $formDescriptor[$name] );
}
}
/**
* @var $htmlForm PreferencesForm
*/
$htmlForm = new $formClass( $formDescriptor, $context, 'prefs' );
2009-06-21 14:16:11 +00:00
$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' ) );
2009-06-21 14:16:11 +00:00
return $htmlForm;
}
2009-06-21 14:16:11 +00:00
2011-05-28 16:32:09 +00:00
/**
* @param $context IContextSource
2011-05-28 16:32:09 +00:00
* @return array
*/
static function getTimezoneOptions( IContextSource $context ) {
$opt = array();
2009-06-21 14:16:11 +00:00
global $wgLocalTZoffset;
$timestamp = MWTimestamp::getLocalInstance();
// Check that $wgLocalTZoffset is the same as the local time zone offset
if ( $wgLocalTZoffset == $timestamp->format( 'Z' ) / 60 ) {
$server_tz_msg = $context->msg( 'timezoneuseserverdefault', $timestamp->getTimezone()->getName() )->text();
2011-05-16 09:59:23 +00:00
} 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 );
2009-06-21 14:16:11 +00:00
$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;
}
2011-04-04 18:45:03 +00:00
2011-05-28 16:32:09 +00:00
/**
* @param $value
* @param $alldata
* @return int
*/
static function filterIntval( $value, $alldata ) {
return intval( $value );
}
2009-06-21 14:16:11 +00:00
2011-05-28 16:32:09 +00:00
/**
* @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;
}
}
2011-05-28 16:32:09 +00:00
/**
* Handle the form submission if everything validated properly
*
2011-05-28 16:32:09 +00:00
* @param $formData
* @param $form PreferencesForm
2011-05-28 16:32:09 +00:00
* @param $entryPoint string
* @return bool|Status|string
*/
static function tryFormSubmit( $formData, $form, $entryPoint = 'internal' ) {
global $wgHiddenPrefs, $wgAuth;
2009-06-21 14:16:11 +00:00
$user = $form->getModifiedUser();
$result = true;
2009-06-21 14:16:11 +00:00
if ( !$user->isAllowedAny( 'editmyprivateinfo', 'editmyoptions' ) ) {
return Status::newFatal( 'mypreferencesprotected' );
}
// Filter input
foreach ( array_keys( $formData ) as $name ) {
2009-06-21 14:16:11 +00:00
if ( isset( self::$saveFilters[$name] ) ) {
$formData[$name] =
call_user_func( self::$saveFilters[$name], $formData[$name], $formData );
}
}
2009-06-21 14:16:11 +00:00
// Fortunately, the realname field is MUCH simpler
// (not really "private", but still shouldn't be edited without permission)
if ( !in_array( 'realname', $wgHiddenPrefs ) && $user->isAllowed( 'editmyprivateinfo' ) ) {
$realName = $formData['realname'];
$user->setRealName( $realName );
}
2009-06-21 14:16:11 +00:00
if ( $user->isAllowed( 'editmyoptions' ) ) {
foreach ( self::$saveBlacklist as $b ) {
unset( $formData[$b] );
}
2009-06-21 14:16:11 +00:00
# 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 );
}
// Keep old preferences from interfering due to back-compat code, etc.
$user->resetOptions( 'unused', $form->getContext() );
2009-06-21 14:16:11 +00:00
foreach ( $formData as $key => $value ) {
$user->setOption( $key, $value );
}
2009-06-21 14:16:11 +00:00
$user->saveSettings();
}
2009-06-21 14:16:11 +00:00
$wgAuth->updateExternalDB( $user );
return $result;
}
2009-06-21 14:16:11 +00:00
2011-05-28 16:32:09 +00:00
/**
* @param $formData
* @param $form PreferencesForm
2011-05-28 16:32:09 +00:00
* @return Status
*/
public static function tryUISubmit( $formData, $form ) {
$res = self::tryFormSubmit( $formData, $form, 'ui' );
2009-06-21 14:16:11 +00:00
if ( $res ) {
$urlOptions = array( 'success' => 1 );
if ( $res === 'eauth' ) {
$urlOptions['eauth'] = 1;
}
2009-06-21 14:16:11 +00:00
$urlOptions += $form->getExtraSuccessRedirectParameters();
2009-06-21 14:16:11 +00:00
$url = $form->getTitle()->getFullURL( $urlOptions );
$form->getContext()->getOutput()->redirect( $url );
}
2009-06-21 14:16:11 +00:00
return Status::newGood();
}
2009-06-21 14:16:11 +00:00
/**
* Try to set a user's email address.
* This does *not* try to validate the address.
* Caller is responsible for checking $wgAuth and 'editmyprivateinfo'
* right.
*
* @deprecated in 1.20; use User::setEmailWithConfirmation() instead.
* @param $user User
* @param string $newaddr New email address
* @return Array (true on success or Status on failure, info string)
*/
public static function trySetUserEmail( User $user, $newaddr ) {
wfDeprecated( __METHOD__, '1.20' );
$result = $user->setEmailWithConfirmation( $newaddr );
if ( $result->isGood() ) {
return array( true, $result->value );
} else {
return array( $result, 'mailerror' );
}
}
/**
* @deprecated in 1.19
* @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();
}
2011-05-28 16:32:09 +00:00
/**
* @param $html string
* @return String
*/
function wrapForm( $html ) {
$html = Xml::tags( 'div', array( 'id' => 'preferences' ), $html );
2009-06-21 14:16:11 +00:00
return parent::wrapForm( $html );
}
2009-06-21 14:16:11 +00:00
2011-05-28 16:32:09 +00:00
/**
* @return String
*/
function getButtons() {
if ( !$this->getModifiedUser()->isAllowedAny( 'editmyprivateinfo', 'editmyoptions' ) ) {
return '';
}
$html = parent::getButtons();
2009-06-21 14:16:11 +00:00
if ( $this->getModifiedUser()->isAllowed( 'editmyoptions' ) ) {
$t = SpecialPage::getTitleFor( 'Preferences', 'reset' );
2009-06-21 14:16:11 +00:00
$html .= "\n" . Linker::link( $t, $this->msg( 'restoreprefs' )->escaped() );
2009-06-21 14:16:11 +00:00
$html = Xml::tags( 'div', array( 'class' => 'mw-prefs-buttons' ), $html );
}
2009-06-21 14:16:11 +00:00
return $html;
}
2009-06-21 14:16:11 +00:00
2011-05-28 16:32:09 +00:00
/**
* Separate multi-option preferences into multiple preferences, since we
* have to store them separately
2011-05-28 16:32:09 +00:00
* @param $data array
* @return array
*/
function filterDataForSubmit( $data ) {
foreach ( $this->mFlatFields as $fieldname => $field ) {
if ( $field instanceof HTMLNestedFilterable ) {
$info = $field->mParams;
$prefix = isset( $info['prefix'] ) ? $info['prefix'] : $fieldname;
foreach ( $field->filterDataForSubmit( $data[$fieldname] ) as $key => $value ) {
$data["$prefix$key"] = $value;
}
unset( $data[$fieldname] );
}
}
2009-06-21 14:16:11 +00:00
return $data;
}
/**
* Get the whole body of the form.
* @return string
*/
function getBody() {
return $this->displaySection( $this->mFieldTree, '', 'mw-prefsection-' );
}
/**
* Get the "<legend>" for a given section key. Normally this is the
* prefs-$key message but we'll allow extensions to override it.
* @param $key string
* @return string
*/
function getLegend( $key ) {
$legend = parent::getLegend( $key );
wfRunHooks( 'PreferencesGetLegend', array( $this, $key, &$legend ) );
return $legend;
}
}