<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"
"http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head><meta http-equiv="content-type" content="text/html; charset=utf-8" />
<title>[9934] sites/trunk/wordpress.org/public_html/wp-content/plugins/plugin-directory/cli/class-import.php: Plugin dir: improve block asset detection during import.</title>
</head>
<body>
<style type="text/css"><!--
#msg dl.meta { border: 1px #006 solid; background: #369; padding: 6px; color: #fff; }
#msg dl.meta dt { float: left; width: 6em; font-weight: bold; }
#msg dt:after { content:':';}
#msg dl, #msg dt, #msg ul, #msg li, #header, #footer, #logmsg { font-family: verdana,arial,helvetica,sans-serif; font-size: 10pt; }
#msg dl a { font-weight: bold}
#msg dl a:link { color:#fc3; }
#msg dl a:active { color:#ff0; }
#msg dl a:visited { color:#cc6; }
h3 { font-family: verdana,arial,helvetica,sans-serif; font-size: 10pt; font-weight: bold; }
#msg pre { white-space: pre-line; overflow: auto; background: #ffc; border: 1px #fa0 solid; padding: 6px; }
#logmsg { background: #ffc; border: 1px #fa0 solid; padding: 1em 1em 0 1em; }
#logmsg p, #logmsg pre, #logmsg blockquote { margin: 0 0 1em 0; }
#logmsg p, #logmsg li, #logmsg dt, #logmsg dd { line-height: 14pt; }
#logmsg h1, #logmsg h2, #logmsg h3, #logmsg h4, #logmsg h5, #logmsg h6 { margin: .5em 0; }
#logmsg h1:first-child, #logmsg h2:first-child, #logmsg h3:first-child, #logmsg h4:first-child, #logmsg h5:first-child, #logmsg h6:first-child { margin-top: 0; }
#logmsg ul, #logmsg ol { padding: 0; list-style-position: inside; margin: 0 0 0 1em; }
#logmsg ul { text-indent: -1em; padding-left: 1em; }#logmsg ol { text-indent: -1.5em; padding-left: 1.5em; }
#logmsg > ul, #logmsg > ol { margin: 0 0 1em 0; }
#logmsg pre { background: #eee; padding: 1em; }
#logmsg blockquote { border: 1px solid #fa0; border-left-width: 10px; padding: 1em 1em 0 1em; background: white;}
#logmsg dl { margin: 0; }
#logmsg dt { font-weight: bold; }
#logmsg dd { margin: 0; padding: 0 0 0.5em 0; }
#logmsg dd:before { content:'\00bb';}
#logmsg table { border-spacing: 0px; border-collapse: collapse; border-top: 4px solid #fa0; border-bottom: 1px solid #fa0; background: #fff; }
#logmsg table th { text-align: left; font-weight: normal; padding: 0.2em 0.5em; border-top: 1px dotted #fa0; }
#logmsg table td { text-align: right; border-top: 1px dotted #fa0; padding: 0.2em 0.5em; }
#logmsg table thead th { text-align: center; border-bottom: 1px solid #fa0; }
#logmsg table th.Corner { text-align: left; }
#logmsg hr { border: none 0; border-top: 2px dashed #fa0; height: 1px; }
#header, #footer { color: #fff; background: #636; border: 1px #300 solid; padding: 6px; }
#patch { width: 100%; }
#patch h4 {font-family: verdana,arial,helvetica,sans-serif;font-size:10pt;padding:8px;background:#369;color:#fff;margin:0;}
#patch .propset h4, #patch .binary h4 {margin:0;}
#patch pre {padding:0;line-height:1.2em;margin:0;}
#patch .diff {width:100%;background:#eee;padding: 0 0 10px 0;overflow:auto;}
#patch .propset .diff, #patch .binary .diff {padding:10px 0;}
#patch span {display:block;padding:0 10px;}
#patch .modfile, #patch .addfile, #patch .delfile, #patch .propset, #patch .binary, #patch .copfile {border:1px solid #ccc;margin:10px 0;}
#patch ins {background:#dfd;text-decoration:none;display:block;padding:0 10px;}
#patch del {background:#fdd;text-decoration:none;display:block;padding:0 10px;}
#patch .lines, .info {color:#888;background:#fff;}
--></style>
<div id="msg">
<dl class="meta" style="font-size: 105%">
<dt style="float: left; width: 6em; font-weight: bold">Revision</dt> <dd><a style="font-weight: bold" href="http://meta.trac.wordpress.org/changeset/9934">9934</a><script type="application/ld+json">{"@context":"http://schema.org","@type":"EmailMessage","description":"Review this Commit","action":{"@type":"ViewAction","url":"http://meta.trac.wordpress.org/changeset/9934","name":"Review Commit"}}</script></dd>
<dt style="float: left; width: 6em; font-weight: bold">Author</dt> <dd>tellyworth</dd>
<dt style="float: left; width: 6em; font-weight: bold">Date</dt> <dd>2020-05-27 04:56:53 +0000 (Wed, 27 May 2020)</dd>
</dl>
<pre style='padding-left: 1em; margin: 2em 0; border-left: 2px solid #ccc; line-height: 1.25; font-size: 105%; font-family: sans-serif'>Plugin dir: improve block asset detection during import.
This refactors the code and does a smarter job of finding asset files. It successfully works with most blocks currently in the directory.
Props coreymckrill.
See <a href="http://meta.trac.wordpress.org/ticket/5207">#5207</a></pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#sitestrunkwordpressorgpublic_htmlwpcontentpluginsplugindirectorycliclassimportphp">sites/trunk/wordpress.org/public_html/wp-content/plugins/plugin-directory/cli/class-import.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="sitestrunkwordpressorgpublic_htmlwpcontentpluginsplugindirectorycliclassimportphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: sites/trunk/wordpress.org/public_html/wp-content/plugins/plugin-directory/cli/class-import.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- sites/trunk/wordpress.org/public_html/wp-content/plugins/plugin-directory/cli/class-import.php 2020-05-27 01:44:38 UTC (rev 9933)
+++ sites/trunk/wordpress.org/public_html/wp-content/plugins/plugin-directory/cli/class-import.php 2020-05-27 04:56:53 UTC (rev 9934)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -443,16 +443,49 @@
</span><span class="cx" style="display: block; padding: 0 10px"> );
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- // Find blocks
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ if ( 'trunk' === $stable_tag ) {
+ $stable_path = $stable_tag;
+ } else {
+ $stable_path = 'tags/';
+ $stable_path .= $_stable_tag ?? $stable_tag;
+ }
+
+ // Find registered blocks and their files.
</ins><span class="cx" style="display: block; padding: 0 10px"> $blocks = array();
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $files_with_blocks = array();
- foreach ( Filesystem::list_files( "$tmp_dir/export/", true /* recursive */, '!\.(?:php|js|jsx|json)$!i' ) as $filename ) {
- $file_blocks = $this->find_blocks_in_file( $filename );
- if ( $file_blocks ) {
- $files_with_blocks[] = str_replace( "$tmp_dir/export/", '', $filename );
- foreach ( $file_blocks as $block ) {
- // If the info came from a block.json file with more metadata (like description) then we want it to override less detailed info scraped from php/js.
- if ( empty( $blocks[ $block->name ]->title ) || isset( $block->description ) ) {
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $block_files = array();
+ $potential_block_directories = array();
+ $base_dir = "$tmp_dir/export";
+
+ $block_json_files = Filesystem::list_files( $base_dir, true, '!^block\.json$!i' );
+ if ( ! empty( $block_json_files ) ) {
+ foreach ( $block_json_files as $filename ) {
+ $blocks_in_file = $this->find_blocks_in_file( $filename );
+ $relative_filename = str_replace( "$base_dir/", '', $filename );
+ $potential_block_directories[] = dirname( $relative_filename );
+ foreach ( $blocks_in_file as $block ) {
+ $blocks[ $block->name ] = $block;
+
+ $extracted_files = $this->extract_file_paths_from_block_json( $block, dirname( $relative_filename ) );
+ if ( ! empty( $extracted_files ) ) {
+ $block_files = array_merge(
+ $block_files,
+ array_map(
+ function( $file ) use ( $stable_path ) {
+ return "/$stable_path/" . ltrim( $file, '\\' );
+ },
+ $extracted_files
+ )
+ );
+ }
+ }
+ }
+ } else {
+ foreach ( Filesystem::list_files( $base_dir, true, '!\.(?:php|js|jsx)$!i' ) as $filename ) {
+ $blocks_in_file = $this->find_blocks_in_file( $filename );
+ if ( ! empty( $blocks_in_file ) ) {
+ $relative_filename = str_replace( "$base_dir/", '', $filename );
+ $potential_block_directories[] = dirname( $relative_filename );
+ foreach ( $blocks_in_file as $block ) {
</ins><span class="cx" style="display: block; padding: 0 10px"> $blocks[ $block->name ] = $block;
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -460,33 +493,61 @@
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> foreach ( $blocks as $block_name => $block ) {
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- if ( empty( $block->title ) )
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ if ( empty( $block->title ) ) {
</ins><span class="cx" style="display: block; padding: 0 10px"> $blocks[ $block_name ]->title = $trunk_readme->name;
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ }
</ins><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- if ( 'trunk' === $stable_tag ) {
- $stable_path = $stable_tag;
- } else {
- $stable_path = "tags/$stable_tag";
- }
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ // Only search for block files if none were found in a block.json.
+ if ( empty( $block_files ) ) {
+ $build_files = array();
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- // Find blocks dist/build JS files
- $block_files = array();
- $dist_files = SVN::ls( 'https://plugins.svn.wordpress.org' . "/{$plugin_slug}/{$stable_path}/dist" ) ?: array();
- $build_files = SVN::ls( 'https://plugins.svn.wordpress.org' . "/{$plugin_slug}/{$stable_path}/build" ) ?: array();
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ if ( ! empty( $potential_block_directories ) ) {
+ $potential_block_directories = array_unique( $potential_block_directories );
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- foreach ( $dist_files as $file ) {
- $block_files[] = "/{$stable_path}/dist/" . $file;
- }
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ foreach ( $potential_block_directories as $block_dir ) {
+ // dirname() returns . when there is no directory separator present.
+ if ( '.' === $block_dir ) {
+ $block_dir = '';
+ }
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- foreach ( $build_files as $file ) {
- $block_files[] = "/{$stable_path}/build/" . $file;
- }
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ // First look for a dedicated "build" or "dist" directory.
+ foreach ( array( 'build', 'dist' ) as $dirname ) {
+ if ( is_dir( "$base_dir/$block_dir/$dirname" ) ) {
+ $build_files += Filesystem::list_files( "$base_dir/$block_dir/$dirname", true, '!\.(?:js|jsx|css)$!i' );
+ }
+ }
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- if ( empty( $block_files ) ) {
- foreach ( $files_with_blocks as $file ) {
- $block_files[] = "/{$stable_path}/" . $file;
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ // There must be at least on JS file, so if only css was found, keep looking.
+ if ( empty( preg_grep( '!\.(?:js|jsx)$!i', $build_files ) ) ) {
+ // Then check for files in the current directory with "build" or "min" in the filename.
+ $build_files += Filesystem::list_files( "$base_dir/$block_dir", false, '![_\-\.]+(?:build|dist|min)[_\-\.]+!i' );
+ }
+
+ if ( empty( preg_grep( '!\.(?:js|jsx)$!i', $build_files ) ) ) {
+ // Finally, just grab whatever js/css files there are in the current directory.
+ $build_files += Filesystem::list_files( "$base_dir/$block_dir", false, '!\.(?:js|jsx|css)$!i' );
+ }
+ }
</ins><span class="cx" style="display: block; padding: 0 10px"> }
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+
+ if ( empty( preg_grep( '!\.(?:js|jsx)$!i', $build_files ) ) ) {
+ // Nothing in the potential block directories. Check if we somehow missed build/dist directories in the root.
+ foreach ( array( 'build', 'dist' ) as $dirname ) {
+ if ( is_dir( "$base_dir/$dirname" ) ) {
+ $build_files += Filesystem::list_files( "$base_dir/$dirname", true, '!\.(?:js|jsx|css)$!i' );
+ }
+ }
+ }
+
+ if ( empty( preg_grep( '!\.(?:js|jsx)$!i', $build_files ) ) ) {
+ // Still nothing. Take on last wild swing.
+ $build_files += Filesystem::list_files( $base_dir, false, '!\.(?:js|jsx|css)$!i' );
+ }
+
+ foreach ( $build_files as $file ) {
+ $block_files[] = "/$stable_path/" . str_replace( "$base_dir/", '', $file );
+ }
</ins><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> // Only allow js or css files
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -606,4 +667,26 @@
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> return $blocks;
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+
+ /**
+ * Get script and style file paths from an imported block.json.
+ *
+ * @param object $parsed_json
+ * @param string $block_json_path
+ *
+ * @return array
+ */
+ protected function extract_file_paths_from_block_json( $parsed_json, $block_json_path = '' ) {
+ $files = array();
+
+ $props = array( 'editorScript', 'script', 'editorStyle', 'style' );
+
+ foreach ( $props as $prop ) {
+ if ( isset( $parsed_json->$prop ) ) {
+ $files[] = trailingslashit( $block_json_path ) . $parsed_json->$prop;
+ }
+ }
+
+ return $files;
+ }
</ins><span class="cx" style="display: block; padding: 0 10px"> }
</span></span></pre>
</div>
</div>
</body>
</html>