Changeset 13076

Timestamp:

12/21/2023 05:40:09 AM (2 years ago)

Author:

tellyworth

Message:

Plugin Dir: Add Preview links for moderators in plugin queue

This adds private Playground Preview links for the plugin review team to more easily test newly submitted plugins that have not yet been published.

Plugins are loaded with plugin-check active.

See #7380.

Location:

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

Files:

• admin/list-table/class-plugin-posts.php (modified) (1 diff)
• admin/metabox/class-review-tools.php (modified) (1 diff)
• api/routes/class-plugin-blueprint.php (modified) (2 diffs)
• class-template.php (modified) (1 diff)

sites/trunk/wordpress.org/public_html/wp-content/plugins/plugin-directory/admin/list-table/class-plugin-posts.php

@@ -712 +712 @@
 
             printf(
-                '<a href="%1$s">%2$s</a><br>%3$s</li>',
+                '<a href="%1$s">%2$s</a><br>%3$s<br>(<a href="%4$s" target="_blank">preview</a>)</li>',
                 esc_url( $url ),
                 esc_html( $name ),
-                esc_html( $zip_size )
+                esc_html( $zip_size ),
+                esc_url( Template::preview_link_zip( $post->post_name, $zip_file->ID ) )
             );
         }

sites/trunk/wordpress.org/public_html/wp-content/plugins/plugin-directory/admin/metabox/class-review-tools.php

@@ -128 +128 @@
                 list( $zip_url, $zip_file ) = $zip;
                 $zip_size                   = size_format( filesize( get_attached_file( $zip_file->ID ) ), 1 );
+                $zip_preview                = Template::preview_link_zip( $slug, $zip_file->ID );
 
                 printf(
-                    '<li>%1$s <a href="%2$s">%3$s</a> (%4$s)</li>',
+                    '<li>%1$s <a href="%2$s">%3$s</a> (%4$s) (<a href="%5$s" target="_blank">preview</a>)</li>',
                     esc_html( $zip_date ),
                     esc_url( $zip_url ),
                     esc_html( basename( $zip_url ) ),
-                    esc_html( $zip_size )
+                    esc_html( $zip_size ),
+                    esc_url( $zip_preview )
                 );
             }

sites/trunk/wordpress.org/public_html/wp-content/plugins/plugin-directory/api/routes/class-plugin-blueprint.php

@@ -18 +18 @@
             'methods'             => array( \WP_REST_Server::READABLE, \WP_REST_Server::CREATABLE ),
             'callback'            => array( $this, 'blueprint' ),
+            // Note: the zip part of the endpoint is also public, since playground requests blueprints without cookie credentials
             'permission_callback' => '__return_true',
             'args'                => array(
@@ -35 +36 @@
     public function blueprint( $request ) {
         $plugin = Plugin_Directory::get_plugin_post( $request['plugin_slug'] );
+
+        // Direct zip preview for plugin reviewers
+        if ( $request->get_param('zip_hash') ) {
+            foreach ( get_attached_media( 'application/zip', $plugin ) as $zip_file ) {
+                if ( hash_equals( Template::preview_link_hash( $zip_file->ID, 0 ), $request->get_param('zip_hash') ) ||
+                     hash_equals( Template::preview_link_hash( $zip_file->ID, -1 ), $request->get_param('zip_hash') ) ) {
+                    $zip_url = wp_get_attachment_url( $zip_file->ID );
+                    $zip_blueprint =<<<EOF
+{
+    "landingPage": "/wp-admin/plugins.php",
+    "preferredVersions": {
+        "php": "8.0",
+        "wp": "latest"
+    },
+    "phpExtensionBundles": [
+        "kitchen-sink"
+    ],
+    "features": {
+        "networking": true
+    },
+    "steps": [
+        {
+            "step": "installPlugin",
+            "pluginZipFile": {
+                "resource": "wordpress.org/plugins",
+                "slug": "plugin-check"
+            }
+        },
+        {
+            "step": "installPlugin",
+            "pluginZipFile": {
+                "resource": "url",
+                "url": "$zip_url"
+            }
+        },
+        {
+            "step": "login",
+            "username": "admin",
+            "password": "password"
+        }
+    ]
+}
+EOF;
+                    header( 'Access-Control-Allow-Origin: https://playground.wordpress.net' );
+                    die( $zip_blueprint );
+                }
+            }
+        }
 
         $blueprints = get_post_meta( $plugin->ID, 'assets_blueprints', true );

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

@@ -763 +763 @@
 
         return sprintf( 'https://playground.wordpress.net/?plugin=%s&blueprint-url=%s', esc_attr($post->post_name), esc_attr($blueprint['url'] ) );
+    }
+
+    /**
+     * Generate a live preview (playground) link for a zip attachment. Needed for newly uploaded plugins that have not yet been published.
+     *
+     * @param string $slug            The slug of the plugin post.
+     * @param int $attachment_id      The ID of the attachment post corresponding to a plugin zip file. Must be attached to the post identified by $slug.
+     * @return false|string           The preview URL.
+     */
+    public static function preview_link_zip( $slug, $attachment_id ) {
+
+        $zip_hash = self::preview_link_hash( $attachment_id );
+        if ( !$zip_hash ) {
+            return false;
+        }
+        $zip_blueprint = sprintf( 'https://wordpress.org/plugins/wp-json/plugins/v1/plugin/%s/blueprint.json?zip_hash=%s', esc_attr( $slug ), esc_attr( $zip_hash ) );
+        $zip_preview = add_query_arg( 'blueprint-url', urlencode($zip_blueprint), 'https://playground.wordpress.net/' );
+
+        return $zip_preview;
+    }
+
+    /**
+     * Return a time-dependent variable for zip preview links.
+     *
+     * @param int $lifespan           The life span of the nonce, in seconds. Default is one week.
+     * @return float                  The tick value.
+     */
+    public static function preview_link_tick( $lifespan = WEEK_IN_SECONDS ) {
+        return ceil( time() / ( $lifespan / 2 ) );
+    }
+
+    /**
+     * Return a nonce-style hash for zip preview links.
+     *
+     * @param int $attachment_id      The ID of the attachment post corresponding to a plugin zip file.
+     * @param int $tick_offest        Number to subtract from the nonce tick. Use both 0 and -1 to verify older nonces.
+     * @return false|string           The hash as a hex string; or false if the attachment ID is invalid.
+     */
+    public static function preview_link_hash( $attachment_id, $tick_offset = 0 ) {
+        $file = get_attached_file( $attachment_id );
+        if ( !$file ) {
+            return false;
+        }
+        $tick = self::preview_link_tick() - $tick_offset;
+        return wp_hash( $tick . '|' . $file, 'nonce' );
     }