WordPress/wp-includes/js/mce-view.js
Ella Iseulde Van Dorpe ef01315cac TinyMCE: make sure markers are removed after first init
This is only relevant to non embeddable URLs.
After first init, markers were set but not removed,
causing an edited URL to revert when switching to text mode
or any paragraph after the URL to just contain that URL.

Fixes #33954.

Built from https://develop.svn.wordpress.org/trunk@35216


git-svn-id: http://core.svn.wordpress.org/trunk@35182 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2015-10-16 05:43:26 +00:00

914 lines
23 KiB
JavaScript

/* global tinymce */
/*
* The TinyMCE view API.
*
* Note: this API is "experimental" meaning that it will probably change
* in the next few releases based on feedback from 3.9.0.
* If you decide to use it, please follow the development closely.
*
* Diagram
*
* |- registered view constructor (type)
* | |- view instance (unique text)
* | | |- editor 1
* | | | |- view node
* | | | |- view node
* | | | |- ...
* | | |- editor 2
* | | | |- ...
* | |- view instance
* | | |- ...
* |- registered view
* | |- ...
*/
( function( window, wp, shortcode, $ ) {
'use strict';
var views = {},
instances = {};
wp.mce = wp.mce || {};
/**
* wp.mce.views
*
* A set of utilities that simplifies adding custom UI within a TinyMCE editor.
* At its core, it serves as a series of converters, transforming text to a
* custom UI, and back again.
*/
wp.mce.views = {
/**
* Registers a new view type.
*
* @param {String} type The view type.
* @param {Object} extend An object to extend wp.mce.View.prototype with.
*/
register: function( type, extend ) {
views[ type ] = wp.mce.View.extend( _.extend( extend, { type: type } ) );
},
/**
* Unregisters a view type.
*
* @param {String} type The view type.
*/
unregister: function( type ) {
delete views[ type ];
},
/**
* Returns the settings of a view type.
*
* @param {String} type The view type.
*
* @return {Function} The view constructor.
*/
get: function( type ) {
return views[ type ];
},
/**
* Unbinds all view nodes.
* Runs before removing all view nodes from the DOM.
*/
unbind: function() {
_.each( instances, function( instance ) {
instance.unbind();
} );
},
/**
* Scans a given string for each view's pattern,
* replacing any matches with markers,
* and creates a new instance for every match.
*
* @param {String} content The string to scan.
*
* @return {String} The string with markers.
*/
setMarkers: function( content ) {
var pieces = [ { content: content } ],
self = this,
instance, current;
_.each( views, function( view, type ) {
current = pieces.slice();
pieces = [];
_.each( current, function( piece ) {
var remaining = piece.content,
result, text;
// Ignore processed pieces, but retain their location.
if ( piece.processed ) {
pieces.push( piece );
return;
}
// Iterate through the string progressively matching views
// and slicing the string as we go.
while ( remaining && ( result = view.prototype.match( remaining ) ) ) {
// Any text before the match becomes an unprocessed piece.
if ( result.index ) {
pieces.push( { content: remaining.substring( 0, result.index ) } );
}
instance = self.createInstance( type, result.content, result.options );
text = instance.loader ? '.' : instance.text;
// Add the processed piece for the match.
pieces.push( {
content: instance.ignore ? text : '<p data-wpview-marker="' + instance.encodedText + '">' + text + '</p>',
processed: true
} );
// Update the remaining content.
remaining = remaining.slice( result.index + result.content.length );
}
// There are no additional matches.
// If any content remains, add it as an unprocessed piece.
if ( remaining ) {
pieces.push( { content: remaining } );
}
} );
} );
content = _.pluck( pieces, 'content' ).join( '' );
return content.replace( /<p>\s*<p data-wpview-marker=/g, '<p data-wpview-marker=' ).replace( /<\/p>\s*<\/p>/g, '</p>' );
},
/**
* Create a view instance.
*
* @param {String} type The view type.
* @param {String} text The textual representation of the view.
* @param {Object} options Options.
* @param {Boolean} force Recreate the instance. Optional.
*
* @return {wp.mce.View} The view instance.
*/
createInstance: function( type, text, options, force ) {
var View = this.get( type ),
encodedText,
instance;
text = tinymce.DOM.decode( text );
if ( ! force ) {
instance = this.getInstance( text );
if ( instance ) {
return instance;
}
}
encodedText = encodeURIComponent( text );
options = _.extend( options || {}, {
text: text,
encodedText: encodedText
} );
return instances[ encodedText ] = new View( options );
},
/**
* Get a view instance.
*
* @param {(String|HTMLElement)} object The textual representation of the view or the view node.
*
* @return {wp.mce.View} The view instance or undefined.
*/
getInstance: function( object ) {
if ( typeof object === 'string' ) {
return instances[ encodeURIComponent( object ) ];
}
return instances[ $( object ).attr( 'data-wpview-text' ) ];
},
/**
* Given a view node, get the view's text.
*
* @param {HTMLElement} node The view node.
*
* @return {String} The textual representation of the view.
*/
getText: function( node ) {
return decodeURIComponent( $( node ).attr( 'data-wpview-text' ) || '' );
},
/**
* Renders all view nodes that are not yet rendered.
*
* @param {Boolean} force Rerender all view nodes.
*/
render: function( force ) {
_.each( instances, function( instance ) {
instance.render( force );
} );
},
/**
* Update the text of a given view node.
*
* @param {String} text The new text.
* @param {tinymce.Editor} editor The TinyMCE editor instance the view node is in.
* @param {HTMLElement} node The view node to update.
* @param {Boolean} force Recreate the instance. Optional.
*/
update: function( text, editor, node, force ) {
var instance = this.getInstance( node );
if ( instance ) {
instance.update( text, editor, node, force );
}
},
/**
* Renders any editing interface based on the view type.
*
* @param {tinymce.Editor} editor The TinyMCE editor instance the view node is in.
* @param {HTMLElement} node The view node to edit.
*/
edit: function( editor, node ) {
var instance = this.getInstance( node );
if ( instance && instance.edit ) {
instance.edit( instance.text, function( text, force ) {
instance.update( text, editor, node, force );
} );
}
},
/**
* Remove a given view node from the DOM.
*
* @param {tinymce.Editor} editor The TinyMCE editor instance the view node is in.
* @param {HTMLElement} node The view node to remove.
*/
remove: function( editor, node ) {
var instance = this.getInstance( node );
if ( instance ) {
instance.remove( editor, node );
}
}
};
/**
* A Backbone-like View constructor intended for use when rendering a TinyMCE View.
* The main difference is that the TinyMCE View is not tied to a particular DOM node.
*
* @param {Object} options Options.
*/
wp.mce.View = function( options ) {
_.extend( this, options );
this.initialize();
};
wp.mce.View.extend = Backbone.View.extend;
_.extend( wp.mce.View.prototype, {
/**
* The content.
*
* @type {*}
*/
content: null,
/**
* Whether or not to display a loader.
*
* @type {Boolean}
*/
loader: true,
/**
* Runs after the view instance is created.
*/
initialize: function() {},
/**
* Retuns the content to render in the view node.
*
* @return {*}
*/
getContent: function() {
return this.content;
},
/**
* Renders all view nodes tied to this view instance that are not yet rendered.
*
* @param {String} content The content to render. Optional.
* @param {Boolean} force Rerender all view nodes tied to this view instance. Optional.
*/
render: function( content, force ) {
if ( content != null ) {
this.content = content;
}
content = this.getContent();
// If there's nothing to render an no loader needs to be shown, stop.
if ( ! this.loader && ! content ) {
return;
}
// We're about to rerender all views of this instance, so unbind rendered views.
force && this.unbind();
// Replace any left over markers.
this.replaceMarkers();
if ( content ) {
this.setContent( content, function( editor, node, contentNode ) {
$( node ).data( 'rendered', true );
this.bindNode.call( this, editor, node, contentNode );
}, force ? null : false );
} else {
this.setLoader();
}
},
/**
* Binds a given node after its content is added to the DOM.
*/
bindNode: function() {},
/**
* Unbinds a given node before its content is removed from the DOM.
*/
unbindNode: function() {},
/**
* Unbinds all view nodes tied to this view instance.
* Runs before their content is removed from the DOM.
*/
unbind: function() {
this.getNodes( function( editor, node, contentNode ) {
this.unbindNode.call( this, editor, node, contentNode );
$( node ).trigger( 'wp-mce-view-unbind' );
}, true );
},
/**
* Gets all the TinyMCE editor instances that support views.
*
* @param {Function} callback A callback.
*/
getEditors: function( callback ) {
_.each( tinymce.editors, function( editor ) {
if ( editor.plugins.wpview ) {
callback.call( this, editor );
}
}, this );
},
/**
* Gets all view nodes tied to this view instance.
*
* @param {Function} callback A callback.
* @param {Boolean} rendered Get (un)rendered view nodes. Optional.
*/
getNodes: function( callback, rendered ) {
this.getEditors( function( editor ) {
var self = this;
$( editor.getBody() )
.find( '[data-wpview-text="' + self.encodedText + '"]' )
.filter( function() {
var data;
if ( rendered == null ) {
return true;
}
data = $( this ).data( 'rendered' ) === true;
return rendered ? data : ! data;
} )
.each( function() {
callback.call( self, editor, this, $( this ).find( '.wpview-content' ).get( 0 ) );
} );
} );
},
/**
* Gets all marker nodes tied to this view instance.
*
* @param {Function} callback A callback.
*/
getMarkers: function( callback ) {
this.getEditors( function( editor ) {
var self = this;
$( editor.getBody() )
.find( '[data-wpview-marker="' + this.encodedText + '"]' )
.each( function() {
callback.call( self, editor, this );
} );
} );
},
/**
* Replaces all marker nodes tied to this view instance.
*/
replaceMarkers: function() {
this.getMarkers( function( editor, node ) {
var selected = node === editor.selection.getNode(),
$viewNode;
if ( ! this.loader && $( node ).text() !== this.text ) {
editor.dom.setAttrib( node, 'data-wpview-marker', null );
return;
}
$viewNode = editor.$(
'<div class="wpview-wrap" data-wpview-text="' + this.encodedText + '" data-wpview-type="' + this.type + '">' +
'<p class="wpview-selection-before">\u00a0</p>' +
'<div class="wpview-body" contenteditable="false">' +
'<div class="wpview-content wpview-type-' + this.type + '"></div>' +
'</div>' +
'<p class="wpview-selection-after">\u00a0</p>' +
'</div>'
);
editor.$( node ).replaceWith( $viewNode );
if ( selected ) {
editor.wp.setViewCursor( false, $viewNode[0] );
}
} );
},
/**
* Removes all marker nodes tied to this view instance.
*/
removeMarkers: function() {
this.getMarkers( function( editor, node ) {
editor.dom.setAttrib( node, 'data-wpview-marker', null );
} );
},
/**
* Sets the content for all view nodes tied to this view instance.
*
* @param {*} content The content to set.
* @param {Function} callback A callback. Optional.
* @param {Boolean} rendered Only set for (un)rendered nodes. Optional.
*/
setContent: function( content, callback, rendered ) {
if ( _.isObject( content ) && content.body.indexOf( '<script' ) !== -1 ) {
this.setIframes( content.head || '', content.body, callback, rendered );
} else if ( _.isString( content ) && content.indexOf( '<script' ) !== -1 ) {
this.setIframes( '', content, callback, rendered );
} else {
this.getNodes( function( editor, node, contentNode ) {
content = content.body || content;
if ( content.indexOf( '<iframe' ) !== -1 ) {
content += '<div class="wpview-overlay"></div>';
}
contentNode.innerHTML = '';
contentNode.appendChild( _.isString( content ) ? editor.dom.createFragment( content ) : content );
callback && callback.call( this, editor, node, contentNode );
}, rendered );
}
},
/**
* Sets the content in an iframe for all view nodes tied to this view instance.
*
* @param {String} head HTML string to be added to the head of the document.
* @param {String} body HTML string to be added to the body of the document.
* @param {Function} callback A callback. Optional.
* @param {Boolean} rendered Only set for (un)rendered nodes. Optional.
*/
setIframes: function( head, body, callback, rendered ) {
var MutationObserver = window.MutationObserver || window.WebKitMutationObserver || window.MozMutationObserver,
self = this;
this.getNodes( function( editor, node, contentNode ) {
var dom = editor.dom,
styles = '',
bodyClasses = editor.getBody().className || '',
editorHead = editor.getDoc().getElementsByTagName( 'head' )[0];
tinymce.each( dom.$( 'link[rel="stylesheet"]', editorHead ), function( link ) {
if ( link.href && link.href.indexOf( 'skins/lightgray/content.min.css' ) === -1 &&
link.href.indexOf( 'skins/wordpress/wp-content.css' ) === -1 ) {
styles += dom.getOuterHTML( link );
}
} );
if ( self.iframeHeight ) {
dom.add( contentNode, 'div', { style: {
width: '100%',
height: self.iframeHeight
} } );
}
// Seems the browsers need a bit of time to insert/set the view nodes,
// or the iframe will fail especially when switching Text => Visual.
setTimeout( function() {
var iframe, iframeDoc, observer, i, block;
contentNode.innerHTML = '';
iframe = dom.add( contentNode, 'iframe', {
/* jshint scripturl: true */
src: tinymce.Env.ie ? 'javascript:""' : '',
frameBorder: '0',
allowTransparency: 'true',
scrolling: 'no',
'class': 'wpview-sandbox',
style: {
width: '100%',
display: 'block'
},
height: self.iframeHeight
} );
dom.add( contentNode, 'div', { 'class': 'wpview-overlay' } );
iframeDoc = iframe.contentWindow.document;
iframeDoc.open();
iframeDoc.write(
'<!DOCTYPE html>' +
'<html>' +
'<head>' +
'<meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />' +
head +
styles +
'<style>' +
'html {' +
'background: transparent;' +
'padding: 0;' +
'margin: 0;' +
'}' +
'body#wpview-iframe-sandbox {' +
'background: transparent;' +
'padding: 1px 0 !important;' +
'margin: -1px 0 0 !important;' +
'}' +
'body#wpview-iframe-sandbox:before,' +
'body#wpview-iframe-sandbox:after {' +
'display: none;' +
'content: "";' +
'}' +
'</style>' +
'</head>' +
'<body id="wpview-iframe-sandbox" class="' + bodyClasses + '">' +
body +
'</body>' +
'</html>'
);
iframeDoc.close();
function resize() {
var $iframe;
if ( block ) {
return;
}
// Make sure the iframe still exists.
if ( iframe.contentWindow ) {
$iframe = $( iframe );
self.iframeHeight = $( iframeDoc.body ).height();
if ( $iframe.height() !== self.iframeHeight ) {
$iframe.height( self.iframeHeight );
editor.nodeChanged();
}
}
}
if ( self.iframeHeight ) {
block = true;
setTimeout( function() {
block = false;
resize();
}, 3000 );
}
$( iframe.contentWindow ).on( 'load', resize );
if ( MutationObserver ) {
observer = new MutationObserver( _.debounce( resize, 100 ) );
observer.observe( iframeDoc.body, {
attributes: true,
childList: true,
subtree: true
} );
$( node ).one( 'wp-mce-view-unbind', function() {
observer.disconnect();
} );
} else {
for ( i = 1; i < 6; i++ ) {
setTimeout( resize, i * 700 );
}
}
function classChange() {
iframeDoc.body.className = editor.getBody().className;
}
editor.on( 'wp-body-class-change', classChange );
$( node ).one( 'wp-mce-view-unbind', function() {
editor.off( 'wp-body-class-change', classChange );
} );
callback && callback.call( self, editor, node, contentNode );
}, 50 );
}, rendered );
},
/**
* Sets a loader for all view nodes tied to this view instance.
*/
setLoader: function() {
this.setContent(
'<div class="loading-placeholder">' +
'<div class="dashicons dashicons-admin-media"></div>' +
'<div class="wpview-loading"><ins></ins></div>' +
'</div>'
);
},
/**
* Sets an error for all view nodes tied to this view instance.
*
* @param {String} message The error message to set.
* @param {String} dashicon A dashicon ID. Optional. {@link https://developer.wordpress.org/resource/dashicons/}
*/
setError: function( message, dashicon ) {
this.setContent(
'<div class="wpview-error">' +
'<div class="dashicons dashicons-' + ( dashicon || 'no' ) + '"></div>' +
'<p>' + message + '</p>' +
'</div>'
);
},
/**
* Tries to find a text match in a given string.
*
* @param {String} content The string to scan.
*
* @return {Object}
*/
match: function( content ) {
var match = shortcode.next( this.type, content );
if ( match ) {
return {
index: match.index,
content: match.content,
options: {
shortcode: match.shortcode
}
};
}
},
/**
* Update the text of a given view node.
*
* @param {String} text The new text.
* @param {tinymce.Editor} editor The TinyMCE editor instance the view node is in.
* @param {HTMLElement} node The view node to update.
* @param {Boolean} force Recreate the instance. Optional.
*/
update: function( text, editor, node, force ) {
_.find( views, function( view, type ) {
var match = view.prototype.match( text );
if ( match ) {
$( node ).data( 'rendered', false );
editor.dom.setAttrib( node, 'data-wpview-text', encodeURIComponent( text ) );
wp.mce.views.createInstance( type, text, match.options, force ).render();
editor.focus();
return true;
}
} );
},
/**
* Remove a given view node from the DOM.
*
* @param {tinymce.Editor} editor The TinyMCE editor instance the view node is in.
* @param {HTMLElement} node The view node to remove.
*/
remove: function( editor, node ) {
this.unbindNode.call( this, editor, node, $( node ).find( '.wpview-content' ).get( 0 ) );
$( node ).trigger( 'wp-mce-view-unbind' );
editor.dom.remove( node );
editor.focus();
}
} );
} )( window, window.wp, window.wp.shortcode, window.jQuery );
/*
* The WordPress core TinyMCE views.
* Views for the gallery, audio, video, playlist and embed shortcodes,
* and a view for embeddable URLs.
*/
( function( window, views, media, $ ) {
var base, gallery, av, embed;
base = {
state: [],
edit: function( text, update ) {
var type = this.type,
frame = media[ type ].edit( text );
this.pausePlayers && this.pausePlayers();
_.each( this.state, function( state ) {
frame.state( state ).on( 'update', function( selection ) {
update( media[ type ].shortcode( selection ).string(), type === 'gallery' );
} );
} );
frame.on( 'close', function() {
frame.detach();
} );
frame.open();
}
};
gallery = _.extend( {}, base, {
state: [ 'gallery-edit' ],
template: media.template( 'editor-gallery' ),
initialize: function() {
var attachments = media.gallery.attachments( this.shortcode, media.view.settings.post.id ),
attrs = this.shortcode.attrs.named,
self = this;
attachments.more()
.done( function() {
attachments = attachments.toJSON();
_.each( attachments, function( attachment ) {
if ( attachment.sizes ) {
if ( attrs.size && attachment.sizes[ attrs.size ] ) {
attachment.thumbnail = attachment.sizes[ attrs.size ];
} else if ( attachment.sizes.thumbnail ) {
attachment.thumbnail = attachment.sizes.thumbnail;
} else if ( attachment.sizes.full ) {
attachment.thumbnail = attachment.sizes.full;
}
}
} );
self.render( self.template( {
attachments: attachments,
columns: attrs.columns ? parseInt( attrs.columns, 10 ) : media.galleryDefaults.columns
} ) );
} )
.fail( function( jqXHR, textStatus ) {
self.setError( textStatus );
} );
}
} );
av = _.extend( {}, base, {
action: 'parse-media-shortcode',
initialize: function() {
var self = this;
if ( this.url ) {
this.loader = false;
this.shortcode = media.embed.shortcode( {
url: this.text
} );
}
wp.ajax.post( this.action, {
post_ID: media.view.settings.post.id,
type: this.shortcode.tag,
shortcode: this.shortcode.string()
} )
.done( function( response ) {
self.render( response );
} )
.fail( function( response ) {
if ( self.url ) {
self.ignore = true;
self.removeMarkers();
} else {
self.setError( response.message || response.statusText, 'admin-media' );
}
} );
this.getEditors( function( editor ) {
editor.on( 'wpview-selected', function() {
self.pausePlayers();
} );
} );
},
pausePlayers: function() {
this.getNodes( function( editor, node, content ) {
var win = $( 'iframe.wpview-sandbox', content ).get( 0 );
if ( win && ( win = win.contentWindow ) && win.mejs ) {
_.each( win.mejs.players, function( player ) {
try {
player.pause();
} catch ( e ) {}
} );
}
} );
}
} );
embed = _.extend( {}, av, {
action: 'parse-embed',
edit: function( text, update ) {
var frame = media.embed.edit( text, this.url ),
self = this;
this.pausePlayers();
frame.state( 'embed' ).props.on( 'change:url', function( model, url ) {
if ( url && model.get( 'url' ) ) {
frame.state( 'embed' ).metadata = model.toJSON();
}
} );
frame.state( 'embed' ).on( 'select', function() {
var data = frame.state( 'embed' ).metadata;
if ( self.url ) {
update( data.url );
} else {
update( media.embed.shortcode( data ).string() );
}
} );
frame.on( 'close', function() {
frame.detach();
} );
frame.open();
}
} );
views.register( 'gallery', _.extend( {}, gallery ) );
views.register( 'audio', _.extend( {}, av, {
state: [ 'audio-details' ]
} ) );
views.register( 'video', _.extend( {}, av, {
state: [ 'video-details' ]
} ) );
views.register( 'playlist', _.extend( {}, av, {
state: [ 'playlist-edit', 'video-playlist-edit' ]
} ) );
views.register( 'embed', _.extend( {}, embed ) );
views.register( 'embedURL', _.extend( {}, embed, {
match: function( content ) {
var re = /(^|<p>)(https?:\/\/[^\s"]+?)(<\/p>\s*|$)/gi,
match = re.exec( content );
if ( match ) {
return {
index: match.index + match[1].length,
content: match[2],
options: {
url: true
}
};
}
}
} ) );
} )( window, window.wp.mce.views, window.wp.media, window.jQuery );