Changeset 12975

Timestamp:

11/22/2023 06:44:21 AM (14 months ago)

Author:

tellyworth

Message:

Plugin directory: supporting code for blueprint files.

This adds support for a new assets/blueprints folder.

Required for #7251.

Location:

sites/trunk/wordpress.org/public_html/wp-content/plugins/plugin-directory

Files:

• class-template.php (modified) (1 diff)
• cli/class-import.php (modified) (6 diffs)

sites/trunk/wordpress.org/public_html/wp-content/plugins/plugin-directory/class-template.php

@@ -723 +723 @@
 
     /**
+     * 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;
+    }
+
+    /**
      * Generate a live preview (playground) link for a given plugin.
      *
      * @param int|\WP_Post|null $post    Optional. Post ID or post object. Defaults to global $post.
-     * @param string            $landing_page The landing page for the preview. Option. Default: /wp-admin/plugins.php.
-     * @return string The preview url.
-     */
-    public static function preview_link( $post = null, $landing_page = '/wp-admin/plugins.php' ) {
+     * @return false|string The preview url. False if no preview is configured.
+     */
+    public static function preview_link( $post = null ) {
         $post = get_post( $post );
 
-        return sprintf( 'https://playground.wordpress.net/?plugin=%s&login=1&url=%s', esc_attr( $post->post_name ), esc_attr( $landing_page ) );
+        $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 );
     }
 

sites/trunk/wordpress.org/public_html/wp-content/plugins/plugin-directory/cli/class-import.php

@@ -337 +337 @@
         update_post_meta( $plugin->ID, 'assets_banners_color', wp_slash( $banner_average_color ) );
 
+        // 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' );
+        }
+
         // Store the block data, if known
         if ( count( $blocks ) ) {
@@ -565 +572 @@
 
         if ( ! $svn_info || ! $svn_info['result'] ) {
-            $stable_tag = 'trunk';
-            $stable_url = self::PLUGIN_SVN_BASE . "/{$plugin_slug}/trunk";
-            $svn_info   = SVN::info( $stable_url );
-        }
-
-        if ( ! $svn_info['result'] ) {
             throw new Exception( 'Could not find stable SVN URL: ' . implode( ' ', reset( $svn_info['errors'] ) ) );
         }
@@ -614 +615 @@
             'banner'     => array(),
             'icon'       => array(),
+            'blueprint'  => array(),
         );
 
@@ -620 +622 @@
             'banner'     => 4 * MB_IN_BYTES,
             'icon'       => 1 * MB_IN_BYTES,
+            'blueprint'  => 100 * KB_IN_BYTES,
         );
 
+        $svn_blueprints_folder = null;
         $svn_assets_folder = SVN::ls( self::PLUGIN_SVN_BASE . "/{$plugin_slug}/assets/", true /* verbose */ );
         if ( $svn_assets_folder ) { // /assets/ may not exist.
             foreach ( $svn_assets_folder as $asset ) {
+                if ( 'blueprints' === $asset['filename'] ) {
+                    $svn_blueprints_folder = self::PLUGIN_SVN_BASE . "/{$plugin_slug}/assets/blueprints/";
+                    continue;
+                }
+
                 // screenshot-0(-rtl)(-de_DE).(png|jpg|jpeg|gif) || banner-772x250.PNG || icon.svg
                 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 ) ) {
@@ -652 +661 @@
 
                 $assets[ $type ][ $asset['filename'] ] = compact( 'filename', 'revision', 'resolution', 'location', 'locale' );
+            }
+        }
+
+        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 );
             }
         }
@@ -1041 +1089 @@
         return array_unique( $build_files );
     }
+
+    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;
+    }
 }