Changeset 13649

Timestamp:

05/02/2024 06:47:34 AM (2 years ago)

Author:

dd32

Message:

Plugin Directory: Review API: Expand the API used for reviews.

• Make it work for all plugins, regardless of status.
• Include the ZIPs
• Include helpful links.

See #7385.

Location:

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

Files:

• api/class-base.php (modified) (1 diff)
• api/routes/class-plugin-review.php (moved) (moved from sites/trunk/wordpress.org/public_html/wp-content/plugins/plugin-directory/api/routes/class-pending-plugin.php ) (5 diffs)
• class-plugin-directory.php (modified) (1 diff)
• shortcodes/class-upload-handler.php (modified) (2 diffs)

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

@@ -40 +40 @@
                 new Routes\Plugin_Upload();
                 new Routes\Plugin_Blueprint();
-                new Routes\Pending_Plugin();
+                new Routes\Plugin_Review();
         }
 

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

@@ -1 +1 @@
 <?php
 namespace WordPressdotorg\Plugin_Directory\API\Routes;
+use WordPressdotorg\Plugin_Directory\Shortcodes\Upload_Handler;
 use WordPressdotorg\Plugin_Directory\API\Base;
+use WordPressdotorg\Plugin_Directory\Template;
 use WP_Error;
 use WP_REST_Server;
 
 /**
- * An API Endpoint to expose a single Plugin data via api.wordpress.org/plugins/info/1.x
+ * Plugin-review related endpoints.
  *
  * @package WordPressdotorg_Plugin_Directory
  */
-class Pending_Plugin extends Base {
+class Plugin_Review extends Base {
 
         /**
@@ -16 +18 @@
          */
         function __construct() {
-                register_rest_route( 'plugins/v1', '/pending-plugin/(?P<plugin_id>\d+)-(?P<token>[a-f0-9]{32})/?', array(
+                // An API Endpoint to expose more detailed plugin data for a pending plugin.
+                register_rest_route( 'plugins/v1', '/plugin-review/(?P<plugin_id>\d+)-(?P<token>[a-f0-9]{32})/?', array(
                         'methods'             => WP_REST_Server::READABLE,
-                        'callback'            => array( $this, 'pending_plugin_info' ),
-                        'permission_callback' => array( $this, 'pending_plugin_permission_check' ),
+                        'callback'            => array( $this, 'plugin_review_info' ),
+                        'permission_callback' => array( $this, 'plugin_info_permission_check' ),
                 ) );
         }
@@ -29 +32 @@
          * @return array A formatted array of all the data for the plugin.
          */
-        public function pending_plugin_permission_check( $request ) {
+        public function plugin_info_permission_check( $request ) {
                 $post          = get_post( $request['plugin_id'] );
-                $expected_hash = $post->{'_pending_access_token'} ?? false;
+                $expected_hash = wp_hash( $post->ID, 'plugin-review' );
 
                 return (
@@ -42 +45 @@
 
         /**
+         * Append a link to the plugin review info endpoint to a URL.
+         *
+         * @param string   $url  The URL.
+         * @param \WP_Post $post The WP post.
+         * @return string
+         */
+        public static function append_plugin_review_info_url( $url, $post ) {
+                if ( ! $url || ! $post || str_contains( $url, '#wporgapi:' ) ) {
+                        return $url;
+                }
+
+                // Append with a anchor, such that CLI environments don't require special handling.
+                $url .= '#wporgapi:' . self::get_plugin_review_info_url( $post );
+
+                return $url;
+        }
+        /**
+         * Fetch the URL to the plugin review info endpoint.
+         */
+        public static function get_plugin_review_info_url( $post ) {
+                return rest_url( sprintf(
+                        'plugins/v1/plugin-review/%d-%s/',
+                        $post->ID,
+                        wp_hash( $post->ID, 'plugin-review' )
+                ) );
+        }
+
+        /**
          * Endpoint to retrieve a full plugin representation for a pending plugin.
          *
@@ -47 +78 @@
          * @return array A formatted array of all the data for the plugin.
          */
-        public function pending_plugin_info( $request ) {
+        public function plugin_review_info( $request ) {
                 $post      = get_post( $request['plugin_id'] );
                 $submitter = get_user_by( 'id', $post->post_author );
 
-                if ( ! $post || ! in_array( $post->post_status, [ 'new', 'pending', 'rejected', 'approved' ] ) ) {
+                if ( ! $post ) {
                         return new WP_Error( 'plugin_not_found', 'Plugin not found', [ 'status' => 404 ] );
                 }
 
-                // Pending plugin specific fields
+                // Review-specific fields.
                 $details = [
-                        'ID'          => $post->ID,
-                        'post_status' => $post->post_status,
-                        'edit_url'    => add_query_arg( [ 'action' => 'edit', 'post' => $post->ID ], admin_url( 'post.php' ) ),
-                        'submitter'   => [
+                        'ID'            => $post->ID,
+                        'post_status'   => $post->post_status,
+                        'edit_url'      => add_query_arg( [ 'action' => 'edit', 'post' => $post->ID ], admin_url( 'post.php' ) ),
+                        'helpscout'     => null, // Link to Review email (or most recent open email)
+                        'submitter'     => [
                                 'user_login' => $submitter->user_login,
                                 'user_email' => $submitter->user_email,
-                        ]
+                        ],
+                        'zips'          => [],
                 ];
 
-                $plugin_endpoint = new Plugin;
+                // Append the public api fields.
+                $details = $details + (new Plugin)->plugin_info_data( $request, $post );
 
-                return $details + $plugin_endpoint->plugin_info_data( $request, $post );
+                // When the plugin is pre-publish, we'll overwrite some fields.
+                if ( in_array( $post->post_status, [ 'new', 'pending', 'approved' ] ) ) {
+                        $details['download_link'] = null;
+                        $details['preview_link']  = null;
+                }
+
+                $attachments = get_attached_media( 'application/zip', $post );
+                if ( $attachments ) {
+                        foreach ( $attachments as $zip_file ) {
+                                $url     = self::append_plugin_review_info_url( wp_get_attachment_url( $zip_file->ID ), $post );
+                                $preview = Template::preview_link_zip( $post->post_name, $zip_file->ID, 'pcp' );
+
+                                $details['zips'][] = [
+                                        'url'     => $url,
+                                        'name'    => $zip_file->submitted_name ?: preg_split( '/[?#]/', basename( $url ) )[0],
+                                        'date'    => $zip_file->post_date,
+                                        'version' => $zip_file->version,
+                                        'note'    => $zip_file->post_content,
+                                        'preview' => $preview,
+                                ];
+                        }
+
+                        // Use the last one, which should be the latest.
+                        $details['download_link'] ??= $url;
+                        $details['preview_link']  ??= $preview;
+                }
+
+                // For a published plugin, append the API url.
+                $details['download_link'] = self::append_plugin_review_info_url( $details['download_link'], $post );
+
+                return $details;
         }
 }

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

@@ -1847 +1847 @@
          * Add additional context to ZIP urls.
          *
-         * The ZIP URL will have a 'info' key attached which is a rest api URL to information about the plugin.
+         * The ZIP URL will have URL suffixed which is a rest api URL to information about the plugin.
          *
          * @param string $url           The URL to the ZIP file.
-         * @param int    $attachment_id The attachment ID.
+         * @param int    $attachment_id The attachment ID, or post ID.
          * @return string The URL to the ZIP file.
          */
         public function add_info_to_zip_url( $url, $attachment_id ) {
-                $attachment = get_post( $attachment_id );
-                $post       = get_post( $attachment->post_parent );
-                $token      = $post->{'_pending_access_token'} ?? false;
-
-                if ( ! $url || ! $attachment || ! $post || ! $token || ! current_user_can( 'edit_post', $post->ID ) ) {
+                $post = get_post( $attachment_id );
+                if ( 'attachment' === $post->post_type ) {
+                        $post = get_post( $post->post_parent );
+                }
+
+                if ( ! $url || ! $post || ! current_user_can( 'edit_post', $post->ID ) ) {
                         return $url;
                 }
 
                 // Append with a anchor, such that CLI environments don't require special handling.
-                $url .= '#wporgapi:' . rest_url( sprintf(
-                        'plugins/v1/pending-plugin/%d-%s/',
-                        $post->ID,
-                        $token
-                ) );
-
-                return $url;
+                return API\Routes\Plugin_Review::append_plugin_review_info_url( $url, $post );
         }
 

sites/trunk/wordpress.org/public_html/wp-content/plugins/plugin-directory/shortcodes/class-upload-handler.php

@@ -469 +469 @@
                 // First time submission, track some additional metadata.
                 if ( ! $updating_existing ) {
-                        $post_args['meta_input']['_author_ip']            = preg_replace( '/[^0-9a-fA-F:., ]/', '', $_SERVER['REMOTE_ADDR'] );
-                        $post_args['meta_input']['_submitted_date']       = time();
-                        $post_args['meta_input']['_used_upload_token']    = $has_upload_token;
-                        $post_args['meta_input']['_pending_access_token'] = md5( wp_generate_password( 32, true, true ) );
+                        $post_args['meta_input']['_author_ip']         = preg_replace( '/[^0-9a-fA-F:., ]/', '', $_SERVER['REMOTE_ADDR'] );
+                        $post_args['meta_input']['_submitted_date']    = time();
+                        $post_args['meta_input']['_used_upload_token'] = $has_upload_token;
                 }
 
@@ -741 +740 @@
                 global $wpdb;
 
-                if ( 'pending' !== $post->post_status || ! $post->post_name ) {
+                if ( ! in_array( $post->post_status, [ 'new', 'pending' ] ) || ! $post->post_name ) {
                         return false;
                 }