/*! * VisualEditor MediaWiki ArticleTargetLoader. * * @copyright 2011-2020 VisualEditor Team and others; see AUTHORS.txt * @license The MIT License (MIT); see LICENSE.txt */ // TODO: ve.now and ve.track should be moved to mw.libs.ve /* global ve */ /** * Target loader. * * Light-weight loader that loads ResourceLoader modules for VisualEditor * and HTML and page data from the API. Also handles plugin registration. * * @class mw.libs.ve.targetLoader * @singleton */ ( function () { var conf = mw.config.get( 'wgVisualEditorConfig' ), pluginCallbacks = [], modules = [ 'ext.visualEditor.articleTarget' ] // Add modules from $wgVisualEditorPluginModules .concat( conf.pluginModules.filter( mw.loader.getState ) ); var url = new URL( location.href ); // Provide the new wikitext editor if ( conf.enableWikitext && ( mw.user.options.get( 'visualeditor-newwikitext' ) || url.searchParams.get( 'veaction' ) === 'editsource' ) && mw.loader.getState( 'ext.visualEditor.mwwikitext' ) ) { modules.push( 'ext.visualEditor.mwwikitext' ); } var namespaces = mw.config.get( 'wgNamespaceIds' ); // Load signature tool if *any* namespace supports it. // It will be shown disabled on namespaces that don't support it. if ( Object.keys( namespaces ).some( function ( name ) { return mw.Title.wantSignaturesNamespace( namespaces[ name ] ); } ) ) { modules.push( 'ext.visualEditor.mwsignature' ); } mw.libs.ve = mw.libs.ve || {}; mw.libs.ve.targetLoader = { /** * Add a plugin module or callback. * * If a module name is passed, that module will be loaded alongside the other modules. * * If a callback is passed, it will be executed after the modules have loaded. The callback * may optionally return a jQuery.Promise; if it does, loading won't be complete until * that promise is resolved. * * @param {string|Function} plugin Plugin module name or callback */ addPlugin: function ( plugin ) { if ( typeof plugin === 'string' ) { modules.push( plugin ); } else { pluginCallbacks.push( plugin ); } }, /** * Load modules needed for VisualEditor, as well as plugins. * * This loads the base VE modules as well as any registered plugin modules. * Once those are loaded, any registered plugin callbacks are executed, * and we wait for all promises returned by those callbacks to resolve. * * @param {string} mode Initial editor mode, for tracking * @return {jQuery.Promise} Promise resolved when the loading process is complete */ loadModules: function ( mode ) { mw.hook( 've.loadModules' ).fire( this.addPlugin.bind( this ) ); ve.track( 'trace.moduleLoad.enter', { mode: mode } ); return mw.loader.using( modules ) .then( function () { ve.track( 'trace.moduleLoad.exit', { mode: mode } ); pluginCallbacks.push( ve.init.platform.getInitializedPromise.bind( ve.init.platform ) ); // Execute plugin callbacks and collect promises return $.when.apply( $, pluginCallbacks.map( function ( callback ) { return callback(); } ) ); } ); }, /** * Creates an OOUI checkbox inside an inline field layout * * @param {Object[]} checkboxesDef Checkbox definitions from the API * @param {Object} [widgetConfig] Additional widget config * @return {Object} Result object with checkboxFields (OO.ui.FieldLayout[]) and * checkboxesByName (keyed object of OO.ui.CheckboxInputWidget). */ createCheckboxFields: function ( checkboxesDef, widgetConfig ) { var checkboxFields = [], checkboxesByName = {}; if ( checkboxesDef ) { Object.keys( checkboxesDef ).forEach( function ( name ) { var options = checkboxesDef[ name ], accesskey = null, title = null; // The messages documented below are just the ones defined in core. // Extensions may add other checkboxes. if ( options.tooltip ) { // The following messages are used here: // * accesskey-minoredit // * accesskey-watch accesskey = mw.message( 'accesskey-' + options.tooltip ).text(); // The following messages are used here: // * tooltip-minoredit // * tooltip-watch title = mw.message( 'tooltip-' + options.tooltip ).text(); } if ( options[ 'title-message' ] ) { // Not used in core // eslint-disable-next-line mediawiki/msg-doc title = mw.message( options[ 'title-message' ] ).text(); } // The following messages are used here: // * minoredit // * watchthis var $label = mw.message( options[ 'label-message' ] ).parseDom(); var config = $.extend( { accessKey: accesskey, // The following classes are used here: // * ve-ui-mwSaveDialog-checkbox-wpMinoredit // * ve-ui-mwSaveDialog-checkbox-wpWatchthis // * ve-ui-mwSaveDialog-checkbox-wpWatchlistExpiry classes: [ 've-ui-mwSaveDialog-checkbox-' + name ] }, widgetConfig ); var checkbox; switch ( options.class ) { case 'OOUI\\DropdownInputWidget': checkbox = new OO.ui.DropdownInputWidget( $.extend( config, { value: options.default, options: options.options } ) ); break; default: checkbox = new OO.ui.CheckboxInputWidget( $.extend( config, { selected: options.default } ) ); break; } checkboxFields.push( new OO.ui.FieldLayout( checkbox, { align: 'inline', label: $label, title: title, invisibleLabel: !!options.invisibleLabel, // * ve-ui-mwSaveDialog-field-wpMinoredit // * ve-ui-mwSaveDialog-field-wpWatchthis // * ve-ui-mwSaveDialog-field-wpWatchlistExpiry classes: [ 've-ui-mwSaveDialog-field-' + name ] } ) ); checkboxesByName[ name ] = checkbox; } ); } return { checkboxFields: checkboxFields, checkboxesByName: checkboxesByName }; }, /** * Request the page data and various metadata from the MediaWiki API (which will use * Parsoid or RESTBase). * * @param {string} mode Target mode: 'visual' or 'source' * @param {string} pageName Page name to request, in prefixed DB key form (underscores instead of spaces) * @param {Object} [options] * @param {boolean} [options.sessionStore] Store result in session storage (by page+mode+section) for auto-save * @param {null|string} [options.section] Section to edit; number, 'T-'-prefixed, null or 'new' (currently just source mode) * @param {number} [options.oldId] Old revision ID. Current if omitted. * @param {string} [options.targetName] Optional target name for tracking * @param {boolean} [options.modified] The page was been modified before loading (e.g. in source mode) * @param {string} [options.wikitext] Wikitext to convert to HTML. The original document is fetched if undefined. * @param {string} [options.editintro] Name of a page to use as edit intro message * @param {string} [options.preload] Name of a page to use as preloaded content if pageName is empty * @param {Array} [options.preloadparams] Parameters to substitute into preload if it's used * @return {jQuery.Promise} Abortable promise resolved with a JSON object */ requestPageData: function ( mode, pageName, options ) { options = options || {}; var apiRequest = mode === 'source' ? this.requestWikitext.bind( this, pageName, options ) : this.requestParsoidData.bind( this, pageName, options ); if ( options.sessionStore ) { var sessionState; try { // ve.init.platform.getSessionObject is not available yet sessionState = JSON.parse( mw.storage.session.get( 've-docstate' ) ); } catch ( e ) {} if ( sessionState ) { var request = sessionState.request || {}; // Check true section editing is in use var enableVisualSectionEditing = conf.enableVisualSectionEditing; var section = request.mode === 'source' || enableVisualSectionEditing === true || enableVisualSectionEditing === options.targetName ? options.section : null; // Check the requested page, mode and section match the stored one if ( request.pageName === pageName && request.mode === mode && request.section === section // NB we don't cache by oldid so that cached results can be recovered // even if the page has been since edited ) { var dataPromise = $.Deferred().resolve( { visualeditor: $.extend( { content: mw.storage.session.get( 've-dochtml' ) }, sessionState.response, { recovered: true } ) } ).promise(); // If the document hasn't been edited since the user first loaded it, recover // their changes automatically. if ( sessionState.response.oldid === mw.config.get( 'wgCurRevisionId' ) ) { return dataPromise; } else { // Otherwise, prompt them if they want to recover, or reload the document // to see the latest version // This prompt will throw off all of our timing data, so just disable tracking // for this session ve.track = function () {}; return mw.loader.using( 'oojs-ui-windows' ).then( function () { return OO.ui.confirm( mw.msg( 'visualeditor-autosave-modified-prompt-message' ), { title: mw.msg( 'visualeditor-autosave-modified-prompt-title' ), actions: [ { action: 'accept', label: mw.msg( 'visualeditor-autosave-modified-prompt-accept' ), flags: [ 'primary', 'progressive' ] }, { action: 'reject', label: mw.msg( 'visualeditor-autosave-modified-prompt-reject' ), flags: 'destructive' } ] } ).then( function ( confirmed ) { if ( confirmed ) { return dataPromise; } else { // If they requested the latest version, invalidate the autosave state mw.storage.session.remove( 've-docstate' ); return apiRequest(); } } ); } ); } } } } return apiRequest(); }, /** * Request the page HTML and various metadata from the MediaWiki API (which will use * Parsoid or RESTBase). * * @param {string} pageName See #requestPageData * @param {Object} [options] See #requestPageData * @param {boolean} [noRestbase=false] Don't query RESTBase directly * @param {boolean} [noMetadata=false] Don't fetch document metadata when querying RESTBase. Metadata * is not required for some use cases, e.g. diffing. * @return {jQuery.Promise} Abortable promise resolved with a JSON object */ requestParsoidData: function ( pageName, options, noRestbase, noMetadata ) { var section = options.section !== undefined ? options.section : null, useRestbase = !noRestbase && ( conf.fullRestbaseUrl || conf.restbaseUrl ) && section === null, switched = false, fromEditedState = false; options = options || {}; var data = { action: 'visualeditor', paction: useRestbase ? 'metadata' : 'parse', page: pageName, badetag: options.badetag, uselang: mw.config.get( 'wgUserLanguage' ), editintro: options.editintro, preload: options.preload, preloadparams: options.preloadparams, formatversion: 2 }; // Only request the API to explicitly load the currently visible revision if we're restoring // from oldid. Otherwise we should load the latest version. This prevents us from editing an // old version if an edit was made while the user was viewing the page and/or the user is // seeing (slightly) stale cache. if ( options.oldId !== undefined ) { data.oldid = options.oldId; } // Load DOM var start = ve.now(); ve.track( 'trace.apiLoad.enter', { mode: 'visual' } ); var apiXhr, apiPromise; if ( !useRestbase && options.wikitext !== undefined ) { // Non-RESTBase custom wikitext parse data.paction = 'parse'; data.stash = true; switched = true; fromEditedState = options.modified; data.wikitext = options.wikitext; data.section = options.section; data.oldid = options.oldId; apiXhr = new mw.Api().post( data ); } else { if ( useRestbase && noMetadata ) { apiPromise = $.Deferred().resolve( { visualeditor: {} } ).promise(); } else { apiXhr = new mw.Api().get( data ); } } if ( !apiPromise ) { apiPromise = apiXhr.then( function ( response ) { ve.track( 'trace.apiLoad.exit', { mode: 'visual' } ); mw.track( 'timing.ve.' + options.targetName + '.performance.system.apiLoad', ve.now() - start ); if ( response.visualeditor ) { response.visualeditor.switched = switched; response.visualeditor.fromEditedState = fromEditedState; } return response; } ); } var dataPromise, abort; if ( useRestbase ) { ve.track( 'trace.restbaseLoad.enter', { mode: 'visual' } ); var headers = { // Should be synchronised with DirectParsoidClient.php Accept: 'text/html; charset=utf-8; profile="https://www.mediawiki.org/wiki/Specs/HTML/2.6.0"', 'Accept-Language': mw.config.get( 'wgVisualEditor' ).pageLanguageCode, 'Api-User-Agent': 'VisualEditor-MediaWiki/' + mw.config.get( 'wgVersion' ) }; var restbaseXhr, pageHtmlUrl; // Convert specified Wikitext to HTML if ( // wikitext can be an empty string options.wikitext !== undefined && // eslint-disable-next-line no-jquery/no-global-selector !$( '[name=wpSection]' ).val() ) { if ( conf.fullRestbaseUrl ) { pageHtmlUrl = conf.fullRestbaseUrl + 'v1/transform/wikitext/to/html/'; } else { pageHtmlUrl = conf.restbaseUrl.replace( 'v1/page/html/', 'v1/transform/wikitext/to/html/' ); } switched = true; fromEditedState = options.modified; window.onbeforeunload = null; $( window ).off( 'beforeunload' ); restbaseXhr = $.ajax( { url: pageHtmlUrl + encodeURIComponent( pageName ) + ( data.oldid === undefined ? '' : '/' + data.oldid ), type: 'POST', data: { title: pageName, wikitext: options.wikitext, stash: 'true' }, headers: headers, dataType: 'text' } ); } else { // Fetch revision if ( conf.fullRestbaseUrl ) { pageHtmlUrl = conf.fullRestbaseUrl + 'v1/page/html/'; } else { pageHtmlUrl = conf.restbaseUrl; } restbaseXhr = $.ajax( { url: pageHtmlUrl + encodeURIComponent( pageName ) + ( data.oldid === undefined ? '' : '/' + data.oldid ) + '?redirect=false&stash=true', type: 'GET', headers: headers, dataType: 'text' } ); } var restbasePromise = restbaseXhr.then( function ( response, status, jqxhr ) { ve.track( 'trace.restbaseLoad.exit', { mode: 'visual' } ); mw.track( 'timing.ve.' + options.targetName + '.performance.system.restbaseLoad', ve.now() - start ); return [ response, jqxhr.getResponseHeader( 'etag' ) ]; }, function ( xhr, code, _ ) { if ( xhr.status === 404 ) { // Page does not exist, so let the user start with a blank document. return $.Deferred().resolve( [ '', undefined ] ).promise(); } else { mw.log.warn( 'RESTBase load failed: ' + xhr.statusText ); return $.Deferred().reject( code, xhr, _ ).promise(); } } ); dataPromise = $.when( apiPromise, restbasePromise ) .then( function ( apiData, restbaseData ) { if ( apiData.visualeditor ) { if ( restbaseData[ 0 ] || !apiData.visualeditor.content ) { // If we have actual content loaded, use it. // Otherwise, allow fallback content if present. // If no fallback content, this will give us an empty string for // content, which is desirable. apiData.visualeditor.content = restbaseData[ 0 ]; apiData.visualeditor.etag = restbaseData[ 1 ]; } apiData.visualeditor.switched = switched; apiData.visualeditor.fromEditedState = fromEditedState; } return apiData; } ); abort = function () { if ( apiXhr ) { apiXhr.abort(); } restbaseXhr.abort(); }; } else { dataPromise = apiPromise; if ( apiXhr ) { abort = apiXhr.abort; } } return dataPromise.then( function ( resp ) { // Adapted from RESTBase mwUtil.parseETag() var etagRegexp = /^(?:W\/)?"?([^"/]+)(?:\/([0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}))(?:\/([^"]+))?"?$/; // `etag` is expected to be undefined when creating a new page. // We can detect that case by `content` being empty, and not retry. if ( useRestbase && resp.visualeditor.content && ( !resp.visualeditor.etag || !etagRegexp.test( resp.visualeditor.etag ) ) ) { // Direct request to RESTBase returned a mangled or missing etag. // Retry via the MediaWiki API. return mw.libs.ve.targetLoader.requestParsoidData( pageName, $.extend( {}, options, { badetag: resp.visualeditor.etag || '' } ), true ); } resp.veMode = 'visual'; return resp; } ).promise( { abort: abort } ); }, /** * Request the page wikitext and various metadata from the MediaWiki API. * * @param {string} pageName See #requestPageData * @param {Object} [options] See #requestPageData * @return {jQuery.Promise} Abortable promise resolved with a JSON object */ requestWikitext: function ( pageName, options ) { options = options || {}; var data = { action: 'visualeditor', paction: 'wikitext', page: pageName, uselang: mw.config.get( 'wgUserLanguage' ), editintro: options.editintro, preload: options.preload, preloadparams: options.preloadparams, formatversion: 2 }; // section should never really be undefined, but check just in case if ( options.section !== null && options.section !== undefined ) { data.section = options.section; } if ( options.oldId !== undefined ) { data.oldid = options.oldId; } var dataPromise = new mw.Api().get( data ); return dataPromise.then( function ( resp ) { resp.veMode = 'source'; return resp; } ).promise( { abort: dataPromise.abort } ); } }; }() );