Changeset 11535

Timestamp:

02/10/2022 12:41:19 AM (3 years ago)

Author:

dd32

Message:

Plugin Directory: API: Allow clients to disable the versions and download_link fields.

Full changes:

• Can disable the versions response key.
• Can disable the download_link response key.
• Incorrectly documented downloadlink key will affect the download_link key.
• Requesting reviews without sections will now result in sections.reviews being returned still
• Typos in documentation & code cleanup.

See #6032.

Location:

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

Files:

• class-plugins-info-api-request.php (modified) (8 diffs)
• class-plugins-info-api.php (modified) (3 diffs)

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

@@ -19 +19 @@
         'donate_link'         => false,
         'downloaded'          => false,
-        'downloadlink'        => false,
+        'download_link'       => false,
         'homepage'            => false,
         'icons'               => false,
@@ -25 +25 @@
         'rating'              => false,
         'ratings'             => false,
-        'reviews'             => false,
+        'reviews'             => false, // NOTE: sub-key of 'sections'.
         'requires'            => false,
         'requires_php'        => false,
@@ -38 +38 @@
         'author_block_rating' => false,
         'language_packs'      => false,
+        'versions'            => false,
     );
 
@@ -46 +47 @@
         'bare_contributors' => true,
         'downloaded'        => true,
-        'downloadlink'      => true,
+        'download_link'     => true,
         'donate_link'       => true,
         'homepage'          => true,
@@ -76 +77 @@
         'downloaded'        => true,
         'description'       => true,
-        'downloadlink'      => true,
+        'download_link'     => true,
         'donate_link'       => true,
         'homepage'          => true,
@@ -109 +110 @@
         'author_block_count'   => true,
         'author_block_rating'  => true,
+    );
+
+    // Typo/incorrect field name transforms.
+    static $field_aliases = array(
+        // from => to
+        'downloadlink' => 'download_link', // Incorrectly documented in plugins_api().
     );
 
@@ -160 +167 @@
 
         // In WordPress 4.0+ we request the icons field however we don't use the
-        // description and compatibility fields so we exclue those by default unless requested.
+        // description and compatibility fields so we exclude those by default unless requested.
         if ( ! empty( $this->requested_fields['icons'] ) ) {
             $fields['compatibility'] = false;
@@ -192 +199 @@
                 }
             }
+
+            // If the field is an aliased field, redirect to the proper field.
+            $field = self::$field_aliases[ $field ] ?? $field;
+
+            // If it's a valid field, include it.
             if ( isset( self::$fields[ $field ] ) ) {
                 $requested_fields[ $field ] = (bool) $include;

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

@@ -155 +155 @@
      * @param string $method   The requested method, used to determine the default fields to include.
      *
-     * @return array The $resonse with the extra fields removed.
-     */
-    protected function remove_unexpected_fields( $response, $request, $method = '' ) {
-        $fields = $request->get_expected_fields( $method );
+     * @return array The $response with the extra fields removed.
+     */
+    protected function remove_unexpected_fields( $full_response, $request, $method = '' ) {
+        $response = $full_response;
+        $fields   = $request->get_expected_fields( $method );
         foreach ( $fields as $field => $include ) {
             if ( ! $include ) {
@@ -168 +169 @@
         }
 
+        // Support requesting reviews without sections.
+        if ( ! empty( $fields['reviews'] ) && empty( $fields['sections'] ) ) {
+            $response['sections'] = array(
+                'reviews' => $full_response['sections']['reviews']
+            );
+        }
+
         // Back-compatible routines.
         // WordPress 4.9 and older need a "bare" contributor map [ user => profile ]
         if ( ! empty( $fields['bare_contributors'] ) ) {
-            $contribs                 = $response['contributors'] ?? [];
+            $contributors             = $response['contributors'] ?? [];
             $response['contributors'] = array();
-            if ( $contribs ) {
-                foreach ( $contribs as $user => $data ) {
-                    $response['contributors'][ $user ] = $data['profile'];
-                }
+            foreach ( $contributors as $user => $data ) {
+                $response['contributors'][ $user ] = $data['profile'];
             }
         }
@@ -182 +188 @@
         // Only include block translation data for the selected locale.
         if ( ! empty( $response['block_translations'] ) ) {
-            $response['block_translations'] = !empty( $response['block_translations'][ $request->locale ] ) ? $response['block_translations'][ $request->locale ] : [];
+            $response['block_translations'] = $response['block_translations'][ $request->locale ] ?? [];
         }