Changeset 52286

Timestamp:

11/30/2021 05:30:22 PM (5 years ago)

Author:

spacedmonkey

Message:

Site Editor: Add site export REST API endpoint.

Add a REST API to export site templates and template part as html files. When the REST API is requested, it responds by downloading a single ZIP file and exits early, without completing full request. To create the exported zip, the ZipArchive class is required. If this class is not present then the export will gracefully fail, returning a WP_Error object and 500 status error code.

Props spacedmonkey, youknowriad, Mamaduka, walbo, peterwilsoncc.
Fixes #54448 .

Location:

trunk

Files:

• src/wp-includes/block-template-utils.php (modified) (2 diffs)
• src/wp-includes/rest-api.php (modified) (1 diff)
• src/wp-includes/rest-api/endpoints/class-wp-rest-edit-site-export-controller.php (added)
• src/wp-settings.php (modified) (1 diff)
• tests/phpunit/tests/block-template-utils.php (modified) (2 diffs)
• tests/qunit/fixtures/wp-api-generated.js (modified) (1 diff)

trunk/src/wp-includes/block-template-utils.php

@@ -456 +456 @@
 
 /**
+ * Parses a block template and removes the theme attribute from each template part.
+ *
+ * @access private
+ * @since 5.9.0
+ *
+ * @param string $template_content Serialized block template content.
+ * @return string Updated block template content.
+ */
+function _remove_theme_attribute_in_block_template_content( $template_content ) {
+        $has_updated_content = false;
+        $new_content         = '';
+        $template_blocks     = parse_blocks( $template_content );
+
+        $blocks = _flatten_blocks( $template_blocks );
+        foreach ( $blocks as $key => $block ) {
+                if ( 'core/template-part' === $block['blockName'] && isset( $block['attrs']['theme'] ) ) {
+                        unset( $blocks[ $key ]['attrs']['theme'] );
+                        $has_updated_content = true;
+                }
+        }
+
+        if ( ! $has_updated_content ) {
+                return $template_content;
+        }
+
+        foreach ( $template_blocks as $block ) {
+                $new_content .= serialize_block( $block );
+        }
+
+        return $new_content;
+}
+
+/**
  * Build a unified template object based on a theme file.
  *
@@ -864 +897 @@
         block_template_part( 'footer' );
 }
+
+/**
+ * Creates an export of the current templates and
+ * template parts from the site editor at the
+ * specified path in a ZIP file.
+ *
+ * @since 5.9.0
+ *
+ * @return WP_Error|string Path of the ZIP file or error on failure.
+ */
+function wp_generate_block_templates_export_file() {
+        if ( ! class_exists( 'ZipArchive' ) ) {
+                return new WP_Error( __( 'Zip Export not supported.' ) );
+        }
+
+        $obscura  = wp_generate_password( 12, false, false );
+        $filename = get_temp_dir() . 'edit-site-export-' . $obscura . '.zip';
+
+        $zip = new ZipArchive();
+        if ( true !== $zip->open( $filename, ZipArchive::CREATE ) ) {
+                return new WP_Error( __( 'Unable to open export file (archive) for writing.' ) );
+        }
+
+        $zip->addEmptyDir( 'theme' );
+        $zip->addEmptyDir( 'theme/templates' );
+        $zip->addEmptyDir( 'theme/parts' );
+
+        // Load templates into the zip file.
+        $templates = get_block_templates();
+        foreach ( $templates as $template ) {
+                $template->content = _remove_theme_attribute_in_block_template_content( $template->content );
+
+                $zip->addFromString(
+                        'theme/templates/' . $template->slug . '.html',
+                        $template->content
+                );
+        }
+
+        // Load template parts into the zip file.
+        $template_parts = get_block_templates( array(), 'wp_template_part' );
+        foreach ( $template_parts as $template_part ) {
+                $zip->addFromString(
+                        'theme/parts/' . $template_part->slug . '.html',
+                        $template_part->content
+                );
+        }
+
+        // Save changes to the zip file.
+        $zip->close();
+
+        return $filename;
+}

trunk/src/wp-includes/rest-api.php

@@ -349 +349 @@
         // Menu Locations.
         $controller = new WP_REST_Menu_Locations_Controller();
+        $controller->register_routes();
+
+        // Site Editor Export.
+        $controller = new WP_REST_Edit_Site_Export_Controller();
         $controller->register_routes();
 }

trunk/src/wp-settings.php

@@ -276 +276 @@
 require ABSPATH . WPINC . '/rest-api/endpoints/class-wp-rest-plugins-controller.php';
 require ABSPATH . WPINC . '/rest-api/endpoints/class-wp-rest-block-directory-controller.php';
+require ABSPATH . WPINC . '/rest-api/endpoints/class-wp-rest-edit-site-export-controller.php';
 require ABSPATH . WPINC . '/rest-api/endpoints/class-wp-rest-pattern-directory-controller.php';
 require ABSPATH . WPINC . '/rest-api/endpoints/class-wp-rest-application-passwords-controller.php';

trunk/tests/phpunit/tests/block-template-utils.php

@@ -191 +191 @@
 
         /**
+         * @ticket 54448
+         *
+         * @dataProvider data_remove_theme_attribute_in_block_template_content
+         */
+        function test_remove_theme_attribute_in_block_template_content( $template_content, $expected ) {
+                $this->assertEquals( $expected, _remove_theme_attribute_in_block_template_content( $template_content ) );
+        }
+
+        function data_remove_theme_attribute_in_block_template_content() {
+                return array(
+                        array(
+                                '<!-- wp:template-part {"slug":"header","theme":"tt1-blocks","align":"full","tagName":"header","className":"site-header"} /-->',
+                                '<!-- wp:template-part {"slug":"header","align":"full","tagName":"header","className":"site-header"} /-->',
+                        ),
+                        array(
+                                '<!-- wp:group --><!-- wp:template-part {"slug":"header","theme":"tt1-blocks","align":"full","tagName":"header","className":"site-header"} /--><!-- /wp:group -->',
+                                '<!-- wp:group --><!-- wp:template-part {"slug":"header","align":"full","tagName":"header","className":"site-header"} /--><!-- /wp:group -->',
+                        ),
+                        // Does not modify content when there is no existing theme attribute.
+                        array(
+                                '<!-- wp:template-part {"slug":"header","align":"full","tagName":"header","className":"site-header"} /-->',
+                                '<!-- wp:template-part {"slug":"header","align":"full","tagName":"header","className":"site-header"} /-->',
+                        ),
+                        // Does not remove theme when there is no template part.
+                        array(
+                                '<!-- wp:post-content /-->',
+                                '<!-- wp:post-content /-->',
+                        ),
+                );
+        }
+
+        /**
          * Should retrieve the template from the theme files.
          */
@@ -312 +344 @@
                 $this->assertSame( $expected, $actual );
         }
+
+        /**
+         * Should generate block templates export file.
+         *
+         * @ticket 54448
+         */
+        function test_wp_generate_block_templates_export_file() {
+                $filename = wp_generate_block_templates_export_file();
+                $this->assertFileExists( $filename, 'zip file is created at the specified path' );
+                $this->assertTrue( filesize( $filename ) > 0, 'zip file is larger than 0 bytes' );
+
+                // Open ZIP file and make sure the directories exist.
+                $zip = new ZipArchive();
+                $zip->open( $filename );
+                $has_theme_dir                = $zip->locateName( 'theme/' ) !== false;
+                $has_block_templates_dir      = $zip->locateName( 'theme/templates/' ) !== false;
+                $has_block_template_parts_dir = $zip->locateName( 'theme/parts/' ) !== false;
+                $this->assertTrue( $has_theme_dir, 'theme directory exists' );
+                $this->assertTrue( $has_block_templates_dir, 'theme/templates directory exists' );
+                $this->assertTrue( $has_block_template_parts_dir, 'theme/parts directory exists' );
+
+                // ZIP file contains at least one HTML file.
+                $has_html_files = false;
+                $num_files      = $zip->numFiles;
+                for ( $i = 0; $i < $num_files; $i++ ) {
+                        $filename = $zip->getNameIndex( $i );
+                        if ( '.html' === substr( $filename, -5 ) ) {
+                                $has_html_files = true;
+                                break;
+                        }
+                }
+                $this->assertTrue( $has_html_files, 'contains at least one html file' );
+        }
 }

trunk/tests/qunit/fixtures/wp-api-generated.js

@@ -10643 +10643 @@
                 }
             ]
+        },
+        "/wp-block-editor/v1/export": {
+            "namespace": "wp-block-editor/v1",
+            "methods": [
+                "GET"
+            ],
+            "endpoints": [
+                {
+                    "methods": [
+                        "GET"
+                    ],
+                    "args": []
+                }
+            ],
+            "_links": {
+                "self": [
+                    {
+                        "href": "http://example.org/index.php?rest_route=/wp-block-editor/v1/export"
+                    }
+                ]
+            }
         }
     },