mediawiki-extensions-Visual.../modules/ve-mw/init/ve.init.mw.Platform.js
Roan Kattouw b15f819fdf ve.init.mw.Platform: Migrate away from deprecated specialCharacters API
Use require('mediawiki.language.specialCharacters') instead of
mw.language.specialCharacters.

Change-Id: I9cf525a1e1aadc12d72284d08b98882b0ab95f5e
2019-02-08 16:59:25 -08:00

279 lines
7.4 KiB
JavaScript

/*!
* VisualEditor MediaWiki Initialization Platform class.
*
* @copyright 2011-2019 VisualEditor Team and others; see AUTHORS.txt
* @license The MIT License (MIT); see LICENSE.txt
*/
/**
* Initialization MediaWiki platform.
*
* @class
* @extends ve.init.Platform
*
* @constructor
*/
ve.init.mw.Platform = function VeInitMwPlatform() {
// Parent constructor
ve.init.Platform.call( this );
// Properties
this.externalLinkUrlProtocolsRegExp = new RegExp(
'^(' + mw.config.get( 'wgUrlProtocols' ) + ')',
'i'
);
this.unanchoredExternalLinkUrlProtocolsRegExp = new RegExp(
'(' + mw.config.get( 'wgUrlProtocols' ) + ')',
'i'
);
this.parsedMessages = {};
this.linkCache = new ve.init.mw.LinkCache();
this.imageInfoCache = new ve.init.mw.ImageInfoCache();
this.galleryImageInfoCache = new ve.init.mw.GalleryImageInfoCache();
};
/* Inheritance */
OO.inheritClass( ve.init.mw.Platform, ve.init.Platform );
/* Methods */
/** @inheritdoc */
ve.init.mw.Platform.prototype.getExternalLinkUrlProtocolsRegExp = function () {
return this.externalLinkUrlProtocolsRegExp;
};
/** @inheritdoc */
ve.init.mw.Platform.prototype.getUnanchoredExternalLinkUrlProtocolsRegExp = function () {
return this.unanchoredExternalLinkUrlProtocolsRegExp;
};
/** @inheritdoc */
ve.init.mw.Platform.prototype.notify = function ( message, title, options ) {
return mw.notify( message, ve.extendObject( { title: title }, options ) );
};
/**
* Regular expression matching RESTBase IDs
*
* This isn't perfect, see T147607
*
* @inheritdoc
*/
ve.init.mw.Platform.prototype.getMetadataIdRegExp = function () {
return /^mw[a-zA-Z0-9\-_]{2,6}$/;
};
/** @inheritdoc */
ve.init.mw.Platform.prototype.addMessages = function ( messages ) {
return mw.messages.set( messages );
};
/**
* @method
* @inheritdoc
*/
ve.init.mw.Platform.prototype.getMessage = mw.msg.bind( mw );
/**
* @inheritdoc
*/
ve.init.mw.Platform.prototype.getHtmlMessage = function () {
return mw.message.apply( mw.message, arguments ).parseDom().toArray();
};
/**
* @method
* @inheritdoc
*/
ve.init.mw.Platform.prototype.getConfig = mw.config.get.bind( mw.config );
/**
* All values are JSON-parsed. To get raw values, use mw.user.options.get directly.
*
* @method
* @inheritdoc
*/
ve.init.mw.Platform.prototype.getUserConfig = function ( keys ) {
var values, parsedValues;
if ( Array.isArray( keys ) ) {
values = mw.user.options.get( keys );
parsedValues = {};
Object.keys( values ).forEach( function ( value ) {
parsedValues[ value ] = JSON.parse( values[ value ] );
} );
return parsedValues;
} else {
try {
return JSON.parse( mw.user.options.get( keys ) );
} catch ( e ) {
// We might encounter an old unencoded value in the store
return null;
}
}
};
/**
* Options must be registered in onGetPreferences
*
* All values are JSON encoded. To set raw values, use mw.user.options.set directly.
*
* @method
* @inheritdoc
*/
ve.init.mw.Platform.prototype.setUserConfig = function ( keyOrValueMap, value ) {
var jsonValues, jsonValue;
// T214963: Don't try to set user preferences for logged-out users, it doesn't work
if ( mw.user.isAnon() ) {
return false;
}
if ( typeof keyOrValueMap === 'object' ) {
if ( OO.compare( keyOrValueMap, this.getUserConfig( Object.keys( keyOrValueMap ) ) ) ) {
return false;
}
// JSON encode all the values for API storage
jsonValues = {};
Object.keys( keyOrValueMap ).forEach( function ( key ) {
jsonValues[ key ] = JSON.stringify( keyOrValueMap[ key ] );
} );
ve.init.target.getLocalApi().saveOptions( jsonValues );
return mw.user.options.set( jsonValues );
} else {
if ( value === this.getUserConfig( keyOrValueMap ) ) {
return false;
}
// JSON encode the value for API storage
jsonValue = JSON.stringify( value );
ve.init.target.getLocalApi().saveOption( keyOrValueMap, jsonValue );
return mw.user.options.set( keyOrValueMap, jsonValue );
}
};
/**
* @inheritdoc
*/
ve.init.mw.Platform.prototype.getSession = function ( key ) {
return mw.storage.session.get( key );
};
/**
* @inheritdoc
*/
ve.init.mw.Platform.prototype.setSession = function ( key, value ) {
return mw.storage.session.set( key, value );
};
/**
* @inheritdoc
*/
ve.init.mw.Platform.prototype.removeSession = function ( key ) {
return mw.storage.session.remove( key );
};
/**
* @inheritdoc
*/
ve.init.mw.Platform.prototype.addParsedMessages = function ( messages ) {
var key;
for ( key in messages ) {
this.parsedMessages[ key ] = messages[ key ];
}
};
/**
* @inheritdoc
*/
ve.init.mw.Platform.prototype.getParsedMessage = function ( key ) {
if ( Object.prototype.hasOwnProperty.call( this.parsedMessages, key ) ) {
// Prefer parsed results from VisualEditorDataModule if available.
return this.parsedMessages[ key ];
}
// Fallback to regular messages, with mw.message html escaping applied.
return mw.message( key ).escaped();
};
/**
* @inheritdoc
*/
ve.init.mw.Platform.prototype.getLanguageCodes = function () {
return Object.keys(
mw.language.getData( mw.config.get( 'wgUserLanguage' ), 'languageNames' ) ||
$.uls.data.getAutonyms()
);
};
/**
* @inheritdoc
*/
ve.init.mw.Platform.prototype.getLanguageName = function ( code ) {
var languageNames = mw.language.getData( mw.config.get( 'wgUserLanguage' ), 'languageNames' ) ||
$.uls.data.getAutonyms();
return languageNames[ code ] || '';
};
/**
* @method
* @inheritdoc
*/
ve.init.mw.Platform.prototype.getLanguageAutonym = $.uls.data.getAutonym;
/**
* @method
* @inheritdoc
*/
ve.init.mw.Platform.prototype.getLanguageDirection = $.uls.data.getDir;
/**
* @method
* @inheritdoc
*/
ve.init.mw.Platform.prototype.getUserLanguages = mw.language.getFallbackLanguageChain;
/**
* @inheritdoc
*/
ve.init.mw.Platform.prototype.fetchSpecialCharList = function () {
return mw.loader.using( 'mediawiki.language.specialCharacters' ).then( function () {
var specialCharacterGroups = require( 'mediawiki.language.specialCharacters' ),
characters = {},
otherGroupName = mw.msg( 'visualeditor-special-characters-group-other' ),
otherMsg = mw.message( 'visualeditor-quick-access-characters.json' ).plain(),
// TODO: This information should be available upstream in mw.language.specialCharacters
rtlGroups = [ 'arabic', 'arabicextended', 'hebrew' ],
other, groupObject;
try {
other = JSON.parse( otherMsg );
if ( other ) {
characters[ otherGroupName ] = other;
other.attributes = { dir: mw.config.get( 'wgVisualEditorConfig' ).pageLanguageDir };
}
} catch ( err ) {
ve.log( 've.init.mw.Platform: Could not parse the Special Character list.' );
ve.log( err );
}
// eslint-disable-next-line jquery/no-each-util
$.each( specialCharacterGroups, function ( groupName, groupCharacters ) {
groupObject = {}; // button label => character data to insert
// eslint-disable-next-line jquery/no-each-util
$.each( groupCharacters, function ( charKey, charVal ) {
// VE has a different format and it would be a pain to change it now
if ( typeof charVal === 'string' ) {
groupObject[ charVal ] = charVal;
} else if ( typeof charVal === 'object' && 0 in charVal && 1 in charVal ) {
groupObject[ charVal[ 0 ] ] = charVal[ 1 ];
} else {
groupObject[ charVal.label ] = charVal;
}
} );
characters[ mw.msg( 'special-characters-group-' + groupName ) ] = groupObject;
groupObject.attributes = { dir: rtlGroups.indexOf( groupName ) !== -1 ? 'rtl' : 'ltr' };
} );
return characters;
} );
};