diff --git a/Gruntfile.js b/Gruntfile.js index 14e558f2d1..37848c1449 100644 --- a/Gruntfile.js +++ b/Gruntfile.js @@ -456,7 +456,7 @@ module.exports = function(grunt) { dest: BUILD_DIR, ext: '.min.js', src: [ - 'wp-admin/js/*.js', + 'wp-admin/js/**/*.js', 'wp-includes/js/*.js', 'wp-includes/js/mediaelement/wp-mediaelement.js', 'wp-includes/js/mediaelement/wp-playlist.js', diff --git a/src/wp-admin/css/customize-widgets.css b/src/wp-admin/css/customize-widgets.css index bdb58982fe..0a9fbf5869 100644 --- a/src/wp-admin/css/customize-widgets.css +++ b/src/wp-admin/css/customize-widgets.css @@ -213,6 +213,21 @@ display: block; } +/* Text Widget */ +.wp-customizer div.mce-inline-toolbar-grp, +.wp-customizer div.mce-tooltip { + z-index: 500100 !important; +} +.wp-customizer .ui-autocomplete.wplink-autocomplete { + z-index: 500110; /* originally 100110, but z-index of .wp-full-overlay is 500000 */ +} +.wp-customizer #wp-link-backdrop { + z-index: 500100; /* originally 100100, but z-index of .wp-full-overlay is 500000 */ +} +.wp-customizer #wp-link-wrap { + z-index: 500105; /* originally 100105, but z-index of .wp-full-overlay is 500000 */ +} + /** * Styles for new widget addition panel */ diff --git a/src/wp-admin/js/widgets/text-widgets.js b/src/wp-admin/js/widgets/text-widgets.js new file mode 100644 index 0000000000..2d3a5b812c --- /dev/null +++ b/src/wp-admin/js/widgets/text-widgets.js @@ -0,0 +1,326 @@ +/* global tinymce, switchEditors */ +/* eslint consistent-this: [ "error", "control" ] */ +wp.textWidgets = ( function( $ ) { + 'use strict'; + + var component = {}; + + /** + * Text widget control. + * + * @class TextWidgetControl + * @constructor + * @abstract + */ + component.TextWidgetControl = Backbone.View.extend({ + + /** + * View events. + * + * @type {Object} + */ + events: {}, + + /** + * Initialize. + * + * @param {Object} options - Options. + * @param {Backbone.Model} options.model - Model. + * @param {jQuery} options.el - Control container element. + * @returns {void} + */ + initialize: function initialize( options ) { + var control = this; + + if ( ! options.el ) { + throw new Error( 'Missing options.el' ); + } + + Backbone.View.prototype.initialize.call( control, options ); + + /* + * Create a container element for the widget control fields. + * This is inserted into the DOM immediately before the the .widget-content + * element because the contents of this element are essentially "managed" + * by PHP, where each widget update cause the entire element to be emptied + * and replaced with the rendered output of WP_Widget::form() which is + * sent back in Ajax request made to save/update the widget instance. + * To prevent a "flash of replaced DOM elements and re-initialized JS + * components", the JS template is rendered outside of the normal form + * container. + */ + control.fieldContainer = $( '
' ); + control.fieldContainer.html( wp.template( 'widget-text-control-fields' ) ); + control.widgetContentContainer = control.$el.find( '.widget-content:first' ); + control.widgetContentContainer.before( control.fieldContainer ); + + control.fields = { + title: control.fieldContainer.find( '.title' ), + text: control.fieldContainer.find( '.text' ) + }; + + // Sync input fields to hidden sync fields which actually get sent to the server. + _.each( control.fields, function( fieldInput, fieldName ) { + fieldInput.on( 'input change', function updateSyncField() { + var syncInput = control.widgetContentContainer.find( 'input[type=hidden].' + fieldName ); + if ( syncInput.val() !== $( this ).val() ) { + syncInput.val( $( this ).val() ); + syncInput.trigger( 'change' ); + } + }); + + // Note that syncInput cannot be re-used because it will be destroyed with each widget-updated event. + fieldInput.val( control.widgetContentContainer.find( 'input[type=hidden].' + fieldName ).val() ); + }); + }, + + /** + * Update input fields from the sync fields. + * + * This function is called at the widget-updated and widget-synced events. + * A field will only be updated if it is not currently focused, to avoid + * overwriting content that the user is entering. + * + * @returns {void} + */ + updateFields: function updateFields() { + var control = this, syncInput; + + if ( ! control.fields.title.is( document.activeElement ) ) { + syncInput = control.widgetContentContainer.find( 'input[type=hidden].title' ); + control.fields.title.val( syncInput.val() ); + } + + syncInput = control.widgetContentContainer.find( 'input[type=hidden].text' ); + if ( control.fields.text.is( ':visible' ) ) { + if ( ! control.fields.text.is( document.activeElement ) ) { + control.fields.text.val( syncInput.val() ); + } + } else if ( control.editor && ! control.editorFocused && syncInput.val() !== control.fields.text.val() ) { + control.editor.setContent( wp.editor.autop( syncInput.val() ) ); + } + }, + + /** + * Initialize editor. + * + * @returns {void} + */ + initializeEditor: function initializeEditor() { + var control = this, changeDebounceDelay = 1000, id, textarea, restoreTextMode = false; + textarea = control.fields.text; + id = textarea.attr( 'id' ); + + /** + * Build (or re-build) the visual editor. + * + * @returns {void} + */ + function buildEditor() { + var editor, triggerChangeIfDirty, onInit; + + // Abort building if the textarea is gone, likely due to the widget having been deleted entirely. + if ( ! document.getElementById( id ) ) { + return; + } + + // Destroy any existing editor so that it can be re-initialized after a widget-updated event. + if ( tinymce.get( id ) ) { + restoreTextMode = tinymce.get( id ).isHidden(); + wp.editor.remove( id ); + } + + wp.editor.initialize( id, { + tinymce: { + wpautop: true + }, + quicktags: true + } ); + + editor = window.tinymce.get( id ); + if ( ! editor ) { + throw new Error( 'Failed to initialize editor' ); + } + onInit = function() { + + // When a widget is moved in the DOM the dynamically-created TinyMCE iframe will be destroyed and has to be re-built. + $( editor.getWin() ).on( 'unload', function() { + _.defer( buildEditor ); + }); + + // If a prior mce instance was replaced, and it was in text mode, toggle to text mode. + if ( restoreTextMode ) { + switchEditors.go( id, 'toggle' ); + } + }; + + if ( editor.initialized ) { + onInit(); + } else { + editor.on( 'init', onInit ); + } + + control.editorFocused = false; + triggerChangeIfDirty = function() { + var updateWidgetBuffer = 300; // See wp.customize.Widgets.WidgetControl._setupUpdateUI() which uses 250ms for updateWidgetDebounced. + if ( editor.isDirty() ) { + + /* + * Account for race condition in customizer where user clicks Save & Publish while + * focus was just previously given to to the editor. Since updates to the editor + * are debounced at 1 second and since widget input changes are only synced to + * settings after 250ms, the customizer needs to be put into the processing + * state during the time between the change event is triggered and updateWidget + * logic starts. Note that the debounced update-widget request should be able + * to be removed with the removal of the update-widget request entirely once + * widgets are able to mutate their own instance props directly in JS without + * having to make server round-trips to call the respective WP_Widget::update() + * callbacks. See-
+ + + - - -/>
+ /** + * Render form template scripts. + * + * @since 4.8.0 + * @access public + */ + public function render_control_template_scripts() { + ?> + _register(); + + $this->assertEquals( 10, has_action( 'admin_print_scripts-widgets.php', array( $widget, 'enqueue_admin_scripts' ) ) ); + $this->assertEquals( 10, has_action( 'admin_footer-widgets.php', array( $widget, 'render_control_template_scripts' ) ) ); + } + + /** + * Test widget method. + * + * @covers WP_Widget_Text::widget + */ + function test_widget() { + $widget = new WP_Widget_Text(); + $text = "Lorem ipsum dolor sit amet, consectetur adipiscing elit.\n Praesent ut turpis consequat lorem volutpat bibendum vitae vitae ante."; + + $args = array( + 'before_title' => '', $output );
+ $this->assertNotContains( '
', $output );
+ $this->assertEmpty( $this->widget_text_content_args );
+ $this->assertNotEmpty( $this->widget_text_args );
+
+ // Test with filter=true.
+ $instance['filter'] = true;
+ ob_start();
+ $widget->widget( $args, $instance );
+ $output = ob_get_clean();
+ $this->assertContains( '
', $output );
+ $this->assertContains( '
', $output );
+ $this->assertNotEmpty( $this->widget_text_args );
+ $this->assertEquals( $instance['text'], $this->widget_text_args[0] );
+ $this->assertEquals( $instance, $this->widget_text_args[1] );
+ $this->assertEquals( $widget, $this->widget_text_args[2] );
+ $this->assertEmpty( $this->widget_text_content_args );
+
+ // Test with filter=content, the upgraded widget.
+ $instance['filter'] = 'content';
+ ob_start();
+ $widget->widget( $args, $instance );
+ $output = ob_get_clean();
+ $this->assertContains( '
', $output );
+ $this->assertContains( '
', $output );
+ $this->assertCount( 3, $this->widget_text_args );
+ $this->assertEquals( $instance['text'], $this->widget_text_args[0] );
+ $this->assertEquals( $instance, $this->widget_text_args[1] );
+ $this->assertEquals( $widget, $this->widget_text_args[2] );
+ $this->assertCount( 3, $this->widget_text_content_args );
+ $this->assertEquals( wpautop( $instance['text'] ), $this->widget_text_content_args[0] );
+ $this->assertEquals( $instance, $this->widget_text_content_args[1] );
+ $this->assertEquals( $widget, $this->widget_text_content_args[2] );
+ }
+
+ /**
+ * Filters the content of the Text widget.
+ *
+ * @param string $widget_text The widget content.
+ * @param array $instance Array of settings for the current widget.
+ * @param WP_Widget_Text $widget Current Text widget instance.
+ * @return string Widget text.
+ */
+ function filter_widget_text( $widget_text, $instance, $widget ) {
+ $this->widget_text_args = func_get_args();
+
+ return $widget_text;
+ }
+
+ /**
+ * Filters the content of the Text widget to apply changes expected from the visual (TinyMCE) editor.
+ *
+ * @param string $widget_text The widget content.
+ * @param array $instance Array of settings for the current widget.
+ * @param WP_Widget_Text $widget Current Text widget instance.
+ * @return string Widget content.
+ */
+ function filter_widget_text_content( $widget_text, $instance, $widget ) {
+ $this->widget_text_content_args = func_get_args();
+
+ return $widget_text;
+ }
+
+ /**
+ * Test update method.
+ *
+ * @covers WP_Widget_Text::update
+ */
+ function test_update() {
+ $widget = new WP_Widget_Text();
+ $instance = array(
+ 'title' => "The\nTitle",
+ 'text' => "The\n\nText",
+ 'filter' => false,
+ );
+
+ wp_set_current_user( $this->factory()->user->create( array(
+ 'role' => 'administrator',
+ ) ) );
+
+ // Should return valid instance.
+ $expected = array(
+ 'title' => sanitize_text_field( $instance['title'] ),
+ 'text' => $instance['text'],
+ 'filter' => 'content',
+ );
+ $result = $widget->update( $instance, array() );
+ $this->assertEquals( $result, $expected );
+ $this->assertTrue( ! empty( $expected['filter'] ), 'Expected filter prop to be truthy, to handle case where 4.8 is downgraded to 4.7.' );
+
+ // Make sure KSES is applying as expected.
+ add_filter( 'map_meta_cap', array( $this, 'grant_unfiltered_html_cap' ), 10, 2 );
+ $this->assertTrue( current_user_can( 'unfiltered_html' ) );
+ $instance['text'] = '';
+ $expected['text'] = $instance['text'];
+ $result = $widget->update( $instance, array() );
+ $this->assertEquals( $result, $expected );
+
+ remove_filter( 'map_meta_cap', array( $this, 'grant_unfiltered_html_cap' ) );
+ add_filter( 'map_meta_cap', array( $this, 'revoke_unfiltered_html_cap' ), 10, 2 );
+ $this->assertFalse( current_user_can( 'unfiltered_html' ) );
+ $instance['text'] = '';
+ $expected['text'] = wp_kses_post( $instance['text'] );
+ $result = $widget->update( $instance, array() );
+ $this->assertEquals( $result, $expected );
+ remove_filter( 'map_meta_cap', array( $this, 'revoke_unfiltered_html_cap' ), 10, 2 );
+ }
+
+ /**
+ * Grant unfiltered_html cap via map_meta_cap.
+ *
+ * @param array $caps Returns the user's actual capabilities.
+ * @param string $cap Capability name.
+ * @return array Caps.
+ */
+ function grant_unfiltered_html_cap( $caps, $cap ) {
+ if ( 'unfiltered_html' === $cap ) {
+ $caps = array_diff( $caps, array( 'do_not_allow' ) );
+ $caps[] = 'unfiltered_html';
+ }
+ return $caps;
+ }
+
+ /**
+ * Revoke unfiltered_html cap via map_meta_cap.
+ *
+ * @param array $caps Returns the user's actual capabilities.
+ * @param string $cap Capability name.
+ * @return array Caps.
+ */
+ function revoke_unfiltered_html_cap( $caps, $cap ) {
+ if ( 'unfiltered_html' === $cap ) {
+ $caps = array_diff( $caps, array( 'unfiltered_html' ) );
+ $caps[] = 'do_not_allow';
+ }
+ return $caps;
+ }
+
+ /**
+ * Test enqueue_admin_scripts method.
+ *
+ * @covers WP_Widget_Text::enqueue_admin_scripts
+ */
+ function test_enqueue_admin_scripts() {
+ set_current_screen( 'widgets.php' );
+ $widget = new WP_Widget_Text();
+ $widget->enqueue_admin_scripts();
+
+ $this->assertTrue( wp_script_is( 'text-widgets' ) );
+ }
+
+ /**
+ * Test render_control_template_scripts method.
+ *
+ * @covers WP_Widget_Text::render_control_template_scripts
+ */
+ function test_render_control_template_scripts() {
+ $widget = new WP_Widget_Text();
+
+ ob_start();
+ $widget->render_control_template_scripts();
+ $output = ob_get_clean();
+
+ $this->assertContains( '