'; - /* translators: 1 is the theme the snapshot was created for */ - echo sprintf( esc_html__( 'This snapshot was made when a different theme was active (%1$s), so currently it cannot be edited.', 'customize-snapshots' ), esc_html( $snapshot_theme ) ); + /* translators: 1 is the theme the changeset was created for */ + echo sprintf( esc_html__( 'This changeset was made when a different theme was active (%1$s), so currently it cannot be edited.', 'customize-snapshots' ), esc_html( $snapshot_theme ) ); echo '
'; } elseif ( 'publish' !== $post->post_status ) { echo ''; - $args = array( - static::CUSTOMIZE_UUID_PARAM_NAME => $post->post_name, + $args = array_merge( + $this->get_customizer_state_query_vars( $post->ID ), + array( + static::CUSTOMIZE_UUID_PARAM_NAME => $post->post_name, + ) ); + $customize_url = add_query_arg( array_map( 'rawurlencode', $args ), wp_customize_url() ); echo sprintf( '%s ', @@ -359,7 +362,7 @@ public function render_data_metabox( $post ) { echo sprintf( '%s', esc_url( $frontend_view_url ), - esc_html__( 'Preview Snapshot', 'customize-snapshots' ) + esc_html__( 'Preview Changeset', 'customize-snapshots' ) ); echo '
'; } @@ -681,7 +684,7 @@ public function hide_add_new_changeset_button() { * @return mixed */ public function add_snapshot_bulk_actions( $bulk_actions ) { - $bulk_actions['merge_snapshot'] = __( 'Merge Snapshot', 'customize-snapshots' ); + $bulk_actions['merge_snapshot'] = __( 'Merge Changeset', 'customize-snapshots' ); return $bulk_actions; } @@ -791,7 +794,7 @@ public function admin_show_merge_error() { return; } $error = array( - 1 => __( 'At-least two snapshot required for merge.', 'customize-snapshots' ), + 1 => __( 'At-least two changesets required for merge.', 'customize-snapshots' ), ); $error_code = intval( $_REQUEST['merge-error'] ); // WPCS: input var ok. if ( ! isset( $error[ $error_code ] ) ) { @@ -849,4 +852,76 @@ public function filter_out_settings_if_removed_in_metabox( $content ) { return $content; } + + /** + * Get customizer session state query vars. + * + * @param int $post_id Post id. + * @return array $preview_url_query_vars Preview url query vars. + */ + public function get_customizer_state_query_vars( $post_id ) { + $preview_url_query_vars = get_post_meta( $post_id, '_preview_url_query_vars', true ); + + if ( ! is_array( $preview_url_query_vars ) ) { + $preview_url_query_vars = array(); + } + + return $preview_url_query_vars; + } + + /** + * Set customizer session state query vars. + * + * Supplied query vars are validated and sanitized. + * + * @param int $post_id Post id. + * @param array $query_vars Post id. + * @return array Sanitized query vars. + */ + public function set_customizer_state_query_vars( $post_id, $query_vars ) { + $stored_query_vars = array(); + $autofocus_query_vars = array( 'autofocus[panel]', 'autofocus[section]', 'autofocus[control]' ); + + $this->snapshot_manager->ensure_customize_manager(); + + foreach ( wp_array_slice_assoc( $query_vars, $autofocus_query_vars ) as $key => $value ) { + if ( preg_match( '/^[a-z|\[|\]|_|\-|0-9]+$/', $value ) ) { + $stored_query_vars[ $key ] = $value; + } + } + if ( ! empty( $query_vars['url'] ) && wp_validate_redirect( $query_vars['url'] ) ) { + $stored_query_vars['url'] = esc_url_raw( $query_vars['url'] ); + } + if ( isset( $query_vars['device'] ) && in_array( $query_vars['device'], array_keys( $this->snapshot_manager->customize_manager->get_previewable_devices() ), true ) ) { + $stored_query_vars['device'] = $query_vars['device']; + } + if ( isset( $query_vars['scroll'] ) && is_int( $query_vars['scroll'] ) ) { + $stored_query_vars['scroll'] = $query_vars['scroll']; + } + update_post_meta( $post_id, '_preview_url_query_vars', $stored_query_vars ); + return $stored_query_vars; + } + + /** + * Get frontend view link. + * + * Returns URL to frontend with customize_changeset_uuid param supplied. + * If the changeset was saved in the customizer then the URL being previewed + * will serve as the base URL as opposed to the home URL as normally. + * + * @see Post_Type::filter_post_type_link() + * @param int|\WP_Post $post Changeset post. + * @return string URL. + */ + public function get_frontend_view_link( $post ) { + $post = get_post( $post ); + $preview_url_query_vars = $this->get_customizer_state_query_vars( $post->ID ); + $base_url = isset( $preview_url_query_vars['url'] ) ? $preview_url_query_vars['url'] : home_url( '/' ); + return add_query_arg( + array( + static::FRONT_UUID_PARAM_NAME => $post->post_name, + ), + $base_url + ); + } } diff --git a/tests/php/test-class-customize-snapshot-manager.php b/tests/php/test-class-customize-snapshot-manager.php index 8d9c3c5f..d349e339 100644 --- a/tests/php/test-class-customize-snapshot-manager.php +++ b/tests/php/test-class-customize-snapshot-manager.php @@ -241,6 +241,8 @@ function test_hooks() { $this->assertEquals( 100000, has_action( 'admin_bar_menu', array( $manager, 'remove_all_non_snapshot_admin_bar_links' ) ) ); $this->assertEquals( 10, has_action( 'wp_before_admin_bar_render', array( $manager, 'print_admin_bar_styles' ) ) ); $this->assertEquals( 10, has_filter( 'removable_query_args', array( $manager, 'filter_removable_query_args' ) ) ); + $this->assertEquals( 10, has_action( 'save_post_' . $manager->get_post_type(), array( $manager, 'create_initial_changeset_revision' ) ) ); + $this->assertEquals( 10, has_action( 'save_post_' . $manager->get_post_type(), array( $manager, 'save_customizer_state_query_vars' ) ) ); $this->assertEquals( 10, has_filter( 'wp_insert_post_data', array( $manager, 'prepare_snapshot_post_content_for_publish' ) ) ); } @@ -729,4 +731,55 @@ public function test_replace_customize_link() { $parsed_preview_url = wp_parse_url( $query_params['url'] ); $this->assertArrayNotHasKey( 'query', $parsed_preview_url ); } + + /** + * Test save_customizer_state_query_vars. + * + * @convers \CustomizeSnapshots\Customize_Snapshot_Manager::save_customizer_state_query_vars() + * @convers \CustomizeSnapshots\Post_Type::get_frontend_view_link() + * @convers \CustomizeSnapshots\Post_Type::get_customizer_state_query_vars() + * @convers \CustomizeSnapshots\Post_Type::set_customizer_state_query_vars() + */ + public function test_save_customizer_state_query_vars() { + $post_id = $this->manager->post_type->save( array( + 'uuid' => self::UUID, + 'data' => array( + 'blogname' => array( + 'value' => 'Hello', + ), + ), + 'status' => 'draft', + ) ); + + $original_query_vars = array( + 'scroll' => 123, + 'device' => 'mobile', + 'url' => home_url( 'about/' ), + 'autofocus[panel]' => 'widgets', + 'autofocus[section]' => 'sidebar-widgets-sidebar-1', + 'autofocus[control]' => 'widget_test[123]', + ); + + $this->assertContains( sprintf( '?%s=%s', $this->front_param, self::UUID ), get_permalink( $post_id ) ); + $this->assertEmpty( $this->manager->post_type->get_customizer_state_query_vars( $post_id ) ); + $this->manager->save_customizer_state_query_vars( $post_id ); + $this->assertEmpty( $this->manager->post_type->get_customizer_state_query_vars( $post_id ) ); + + $_POST['customizer_state_query_vars'] = wp_slash( wp_json_encode( $original_query_vars ) ); + $this->manager->save_customizer_state_query_vars( $post_id ); + $this->assertContains( sprintf( 'about/?%s=%s', $this->front_param, self::UUID ), get_permalink( $post_id ) ); + $this->assertEquals( $this->manager->post_type->get_customizer_state_query_vars( $post_id ), $original_query_vars ); + $this->assertEquals( $this->manager->post_type->get_frontend_view_link( $post_id ), get_permalink( $post_id ) ); + + $this->manager->post_type->set_customizer_state_query_vars( $post_id, array( + 'scroll' => 'bad', + 'device' => 'bad', + 'url' => 'http://bogus.example.com/', + 'autofocus[panel]' => 'badid!', + 'autofocus[section]' => '#sobad', + 'autofocus[control]' => '*horrible', + 'unrecognized' => 'yes', + ) ); + $this->assertEmpty( $this->manager->post_type->get_customizer_state_query_vars( $post_id ) ); + } } diff --git a/tests/php/test-class-post-type.php b/tests/php/test-class-post-type.php index 1186159d..f58f23f8 100644 --- a/tests/php/test-class-post-type.php +++ b/tests/php/test-class-post-type.php @@ -313,6 +313,9 @@ public function test_filter_post_row_actions() { 'data' => $data, 'status' => 'draft', ) ); + $post_type->set_customizer_state_query_vars( $post_id, array( + 'url' => home_url( 'hello-beautiful-world/' ), + ) ); $original_actions = array( 'inline hide-if-no-js' => '...', 'edit' => '', @@ -322,7 +325,9 @@ public function test_filter_post_row_actions() { $filtered_actions = apply_filters( 'post_row_actions', $original_actions, get_post( $post_id ) ); $this->assertArrayNotHasKey( 'inline hide-if-no-js', $filtered_actions ); $this->assertArrayHasKey( 'customize', $filtered_actions ); + $this->assertContains( 'hello-beautiful-world', $filtered_actions['customize'] ); $this->assertArrayHasKey( 'front-view', $filtered_actions ); + $this->assertContains( 'hello-beautiful-world', $filtered_actions['front-view'] ); wp_set_current_user( $subscriber_user_id ); $filtered_actions = apply_filters( 'post_row_actions', $original_actions, get_post( $post_id ) ); @@ -423,7 +428,7 @@ public function test_render_data_metabox() { ob_start(); $post_type->render_data_metabox( get_post( $post_id ) ); $metabox_content = ob_get_clean(); - $this->assertContains( 'snapshot was made when a different theme was active', $metabox_content ); + $this->assertContains( 'changeset was made when a different theme was active', $metabox_content ); } /**