<!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>[12975] sites/trunk/wordpress.org/public_html/wp-content/plugins/plugin-directory: Plugin directory: supporting code for blueprint files.</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/12975">12975</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/12975","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>2023-11-22 06:44:21 +0000 (Wed, 22 Nov 2023)</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 directory: supporting code for blueprint files.
This adds support for a new `assets/blueprints` folder.
Required for <a href="http://meta.trac.wordpress.org/ticket/7251">#7251</a>.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#sitestrunkwordpressorgpublic_htmlwpcontentpluginsplugindirectoryclasstemplatephp">sites/trunk/wordpress.org/public_html/wp-content/plugins/plugin-directory/class-template.php</a></li>
<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_htmlwpcontentpluginsplugindirectoryclasstemplatephp"></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/class-template.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/class-template.php 2023-11-22 01:41:09 UTC (rev 12974)
+++ sites/trunk/wordpress.org/public_html/wp-content/plugins/plugin-directory/class-template.php 2023-11-22 06:44:21 UTC (rev 12975)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -722,16 +722,44 @@
</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><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * Is a live preview available for the plugin, and allowed for the current user to view?
+ *
+ * @param int|\WP_Post|null $post Optional. Post ID or post object. Defaults to global $post.
+ * @return bool True if a preview is available and the current user is permitted to see it.
+ */
+ public static function is_preview_available( $post = null ) {
+
+ if ( self::preview_link( $post ) ) {
+ // Plugin committers can always use the plugin preview button if it exists.
+ if ( current_user_can( 'plugin_admin_edit', $post ) ) {
+ return true;
+ }
+ }
+ return false;
+ }
+
+ /**
</ins><span class="cx" style="display: block; padding: 0 10px"> * Generate a live preview (playground) link for a given plugin.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @param int|\WP_Post|null $post Optional. Post ID or post object. Defaults to global $post.
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @param string $landing_page The landing page for the preview. Option. Default: /wp-admin/plugins.php.
- * @return string The preview url.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @return false|string The preview url. False if no preview is configured.
</ins><span class="cx" style="display: block; padding: 0 10px"> */
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- public static function preview_link( $post = null, $landing_page = '/wp-admin/plugins.php' ) {
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ public static function preview_link( $post = null ) {
</ins><span class="cx" style="display: block; padding: 0 10px"> $post = get_post( $post );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- return sprintf( 'https://playground.wordpress.net/?plugin=%s&login=1&url=%s', esc_attr( $post->post_name ), esc_attr( $landing_page ) );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $blueprints = get_post_meta( $post->ID, 'assets_blueprints', true );
+ // Note: for now, only use a file called `blueprint.json`.
+ if ( !isset( $blueprints['blueprint.json'] ) ) {
+ return false;
+ }
+ $blueprint = $blueprints['blueprint.json'];
+ if ( !$blueprint || !isset( $blueprint['contents'] ) || !is_string( $blueprint['contents'] ) ) {
+ return false;
+ }
+
+ $blueprint_encoded = esc_html( $blueprint['contents'] );
+
+ return sprintf( 'https://playground.wordpress.net/?plugin=%s#%s', $post->post_name, $blueprint_encoded );
</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"> /**
</span></span></pre></div>
<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 2023-11-22 01:41:09 UTC (rev 12974)
+++ sites/trunk/wordpress.org/public_html/wp-content/plugins/plugin-directory/cli/class-import.php 2023-11-22 06:44:21 UTC (rev 12975)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -336,6 +336,13 @@
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px"> update_post_meta( $plugin->ID, 'assets_banners_color', wp_slash( $banner_average_color ) );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ // Store the content of blueprint files, if they're available and valid.
+ if ( isset( $assets['blueprint'] ) ) {
+ update_post_meta( $plugin->ID, 'assets_blueprints', wp_slash( $assets['blueprint'] ) );
+ } else {
+ delete_post_meta( $plugin->ID, 'assets_blueprints' );
+ }
+
</ins><span class="cx" style="display: block; padding: 0 10px"> // Store the block data, if known
</span><span class="cx" style="display: block; padding: 0 10px"> if ( count( $blocks ) ) {
</span><span class="cx" style="display: block; padding: 0 10px"> $changed = update_post_meta( $plugin->ID, 'all_blocks', $blocks );
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -564,12 +571,6 @@
</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"> if ( ! $svn_info || ! $svn_info['result'] ) {
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $stable_tag = 'trunk';
- $stable_url = self::PLUGIN_SVN_BASE . "/{$plugin_slug}/trunk";
- $svn_info = SVN::info( $stable_url );
- }
-
- if ( ! $svn_info['result'] ) {
</del><span class="cx" style="display: block; padding: 0 10px"> throw new Exception( 'Could not find stable SVN URL: ' . implode( ' ', reset( $svn_info['errors'] ) ) );
</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">@@ -613,6 +614,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> 'screenshot' => array(),
</span><span class="cx" style="display: block; padding: 0 10px"> 'banner' => array(),
</span><span class="cx" style="display: block; padding: 0 10px"> 'icon' => array(),
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ 'blueprint' => array(),
</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"> $asset_limits = array(
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -619,11 +621,18 @@
</span><span class="cx" style="display: block; padding: 0 10px"> 'screenshot' => 10 * MB_IN_BYTES,
</span><span class="cx" style="display: block; padding: 0 10px"> 'banner' => 4 * MB_IN_BYTES,
</span><span class="cx" style="display: block; padding: 0 10px"> 'icon' => 1 * MB_IN_BYTES,
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ 'blueprint' => 100 * KB_IN_BYTES,
</ins><span class="cx" style="display: block; padding: 0 10px"> );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $svn_blueprints_folder = null;
</ins><span class="cx" style="display: block; padding: 0 10px"> $svn_assets_folder = SVN::ls( self::PLUGIN_SVN_BASE . "/{$plugin_slug}/assets/", true /* verbose */ );
</span><span class="cx" style="display: block; padding: 0 10px"> if ( $svn_assets_folder ) { // /assets/ may not exist.
</span><span class="cx" style="display: block; padding: 0 10px"> foreach ( $svn_assets_folder as $asset ) {
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ if ( 'blueprints' === $asset['filename'] ) {
+ $svn_blueprints_folder = self::PLUGIN_SVN_BASE . "/{$plugin_slug}/assets/blueprints/";
+ continue;
+ }
+
</ins><span class="cx" style="display: block; padding: 0 10px"> // screenshot-0(-rtl)(-de_DE).(png|jpg|jpeg|gif) || banner-772x250.PNG || icon.svg
</span><span class="cx" style="display: block; padding: 0 10px"> if ( ! preg_match( '!^(?P<type>screenshot|banner|icon)(?:-(?P<resolution>\d+(?:\D\d+)?)(-rtl)?(?:-(?P<locale>[a-z]{2,3}(?:_[A-Z]{2})?(?:_[a-z0-9]+)?))?\.(png|jpg|jpeg|gif)|\.svg)$!iu', $asset['filename'], $m ) ) {
</span><span class="cx" style="display: block; padding: 0 10px"> continue;
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -654,6 +663,45 @@
</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><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ if ( $svn_blueprints_folder ) {
+ $svn_export = SVN::export(
+ $svn_blueprints_folder,
+ $tmp_dir . '/blueprints',
+ array(
+ 'ignore-externals',
+ )
+ );
+
+ foreach ( Filesystem::list_files( "$tmp_dir/blueprints/", false /* non-recursive */, '!^blueprint[-\w]*\.json$!' ) as $plugin_blueprint ) {
+ $filename = basename( $plugin_blueprint );
+
+ // Don't import oversize blueprints
+ if ( filesize( $plugin_blueprint ) > $asset_limits['blueprint'] ) {
+ continue;
+ }
+
+ // Make sure the blueprint file is valid json and contains the essentials; also minimize whitespace etc.
+ $contents = self::normalize_blueprint_json( file_get_contents( $plugin_blueprint ), $plugin_slug );
+ if ( !$contents ) {
+ continue;
+ }
+
+ $assets['blueprint'][ $filename ] = array(
+ 'filename' => $filename,
+ 'revision' => $svn_export['revision'],
+ 'resolution' => false,
+ 'location' => 'assets',
+ 'locale' => '',
+ 'contents' => $contents
+ );
+ }
+
+ // For the time being, limit the number of blueprints. Revise this when the case for multiple blueprints is more clear.
+ if ( isset( $assets['blueprint'] ) && count ( $assets['blueprint'] ) > 10 ) {
+ $assets['blueprint'] = array_slice( $assets['blueprint'], 0, 10, true );
+ }
+ }
+
</ins><span class="cx" style="display: block; padding: 0 10px"> // Find screenshots in the stable plugin folder (but don't overwrite /assets/)
</span><span class="cx" style="display: block; padding: 0 10px"> foreach ( Filesystem::list_files( "$tmp_dir/export/", false /* non-recursive */, '!^screenshot-\d+\.(jpeg|jpg|png|gif)$!' ) as $plugin_screenshot ) {
</span><span class="cx" style="display: block; padding: 0 10px"> $filename = basename( $plugin_screenshot );
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1040,4 +1088,44 @@
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> return array_unique( $build_files );
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+
+ static function normalize_blueprint_json( $blueprint_file_contents, $plugin_slug ) {
+ $decoded_file = json_decode( $blueprint_file_contents, true );
+
+ $contents = false;
+ if ( is_array( $decoded_file ) && JSON_ERROR_NONE === json_last_error() ) {
+
+ $has_self_install_step = false;
+ if ( isset( $decoded_file[ 'steps' ] ) ) {
+ foreach ( $decoded_file[ 'steps' ] as $i => $step ) {
+ if ( 'installPlugin' === $step['step']
+ && $plugin_slug === $step['pluginZipFile']['slug'] ) {
+ $has_self_install_step = true;
+
+ if ( true != $step['options']['activate'] ) {
+ $decoded_file[ 'steps' ][ $i ][ 'options' ][ 'activate' ] = true;
+ }
+ }
+ }
+ }
+
+ if ( !$has_self_install_step ) {
+ $decoded_file['steps'][] = array(
+ 'step' => 'installPlugin',
+ 'pluginZipFile' => array(
+ 'resource' => 'wordpress.org/plugins',
+ 'slug' => $plugin_slug,
+ ),
+ 'options' => array(
+ 'activate' => true,
+ )
+ );
+ }
+
+
+ $contents = json_encode( $decoded_file ); // Re-encode to minimize whitespace
+ }
+
+ return $contents;
+ }
</ins><span class="cx" style="display: block; padding: 0 10px"> }
</span></span></pre>
</div>
</div>
</body>
</html>