Changeset 13620

Timestamp:

04/30/2024 05:26:07 AM (2 years ago)

Author:

dd32

Message:

Plugin Directory: Expose the plugin closed status through the plugin_information API endpoint.

This only applies to v1.2+ clients, as v1.0/1.1 expect a null response for any error case.

See #7057.

Location:

sites/trunk/wordpress.org/public_html/wp-content

Files:

• plugins/plugin-directory/api/routes/class-plugin.php (modified) (3 diffs)
• plugins/plugin-directory/class-template.php (modified) (1 diff)
• plugins/plugin-directory/standalone/class-plugins-info-api.php (modified) (2 diffs)
• themes/pub/wporg-plugins-2024/inc/template-tags.php (modified) (1 diff)

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

@@ -7 +7 @@
 use WordPressdotorg\Plugin_Directory\Tools;
 use WordPressdotorg\Plugin_Directory\API\Base;
+use function WordPressdotorg\Plugin_Directory\Theme\get_plugin_status_notice;
 use WP_REST_Server;
 
@@ -39 +40 @@
          */
         function plugin_info( $request ) {
+                global $post;
                 $post = Plugin_Directory::get_plugin_post( $request['plugin_slug'] );
 
-                if ( ! $post || 'publish' != $post->post_status ) {
+                // Support returning API data in different locales, even on wordpress.org (for api.wordpress.org usage)
+                if ( ! empty( $request['locale'] ) && ! in_array( strtolower( $request['locale'] ), array( 'en_us', 'en' ) ) ) {
+                        switch_to_locale( $request['locale'] );
+                }
+
+                if ( $post && in_array( $post->post_status, [ 'closed', 'disabled' ] ) ) {
+                        $close_data = Template::get_close_data( $post );
+
+                        $close_text = '';
+                        if ( is_callable( '\WordPressdotorg\Plugin_Directory\Theme\get_plugin_status_notice' ) ) {
+                                $close_text = strip_tags( get_plugin_status_notice( $post ) );
+                        }
+
+                        return [
+                                'error'       => 'closed',
+                                'name'        => get_the_title(),
+                                'slug'        => $post->post_name,
+                                'description' => $close_text,
+                                'closed'      => true,
+                                'closed_date' => $close_data['date'] ?: false,
+                                'reason'      => $close_data['public'] ? $close_data['reason'] : false,
+                                'reason_text' => $close_data['public'] ? $close_data['label'] : false,
+                        ];
+
+                } elseif ( ! $post || 'publish' != $post->post_status ) {
                         // Copy what the REST API does if the param is incorrect
                         return new \WP_Error(
@@ -69 +95 @@
          */
         public function plugin_info_data( $request, $post ) {
-                $GLOBALS['post'] = $post;
-                $plugin_slug     = $post->post_name;
-                $post_id         = $post->ID;
-
-                // Support returning API data in different locales, even on wordpress.org (for api.wordpress.org usage)
-                if ( ! empty( $request['locale'] ) && ! in_array( strtolower( $request['locale'] ), array( 'en_us', 'en' ) ) ) {
-                        switch_to_locale( $request['locale'] );
-                }
+                global $post;
+
+                $plugin_slug = $post->post_name;
+                $post_id     = $post->ID;
 
                 $result            = array();

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

@@ -1060 +1060 @@
          */
         public static function get_close_reason( $post = null ) {
+                return self::get_close_data( $post )['label'] ?? '';
+        }
+
+        /**
+         * Returns the close/disable data for a plugin.
+         *
+         * @param int|\WP_Post|null $post Optional. Post ID or post object. Defaults to global $post.
+         */
+        public static function get_close_data( $post = null ) {
                 $post = get_post( $post );
-
-                $close_reasons = self::get_close_reasons();
-                $close_reason  = (string) get_post_meta( $post->ID, '_close_reason', true );
-
-                if ( isset( $close_reasons[ $close_reason ] ) ) {
-                        $reason_label = $close_reasons[ $close_reason ];
-                } else {
-                        $reason_label = _x( 'Unknown', 'unknown close reason', 'wporg-plugins' );
-                }
-
-                return $reason_label;
+                if ( ! $post || ! in_array( $post->post_status, array( 'closed', 'disabled' ), true ) ) {
+                        return false;
+                }
+
+                $result = [
+                        'date'      => get_post_meta( $post->ID, 'plugin_closed_date', true ) ?: false,
+                        'reason'    => (string) get_post_meta( $post->ID, '_close_reason', true ),
+                        'label'     => '',
+                        'permanent' => false,
+                        'public'    => false,
+                ];
+
+                if (
+                        'author-request' === $result['reason'] ||
+                        ! Tools::get_plugin_committers( $post->post_name )
+                ) {
+                        $result['permanent'] = true;
+                }
+
+                $result['label'] = self::get_close_reasons()[ $result['reason'] ] ?? _x( 'Unknown', 'unknown close reason', 'wporg-plugins' );
+                $days_closed     = $result['date'] ? (int) ( ( time() - strtotime( $result['date'] ) ) / DAY_IN_SECONDS ) : false;
+
+                // If it's closed for more than 60 days, it's by author request, or we're unsure about the close date, it's publicly known.
+                if ( ! $result['date'] || $days_closed >= 60 || 'author-request' === $result['reason'] ) {
+                        $result['public'] = true;
+                }
+
+                return $result; 
         }
 

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

@@ -137 +137 @@
                 }
 
-                // Only include the fields requested.
-                $response = $this->remove_unexpected_fields( $response, $request, 'plugin_information' );
+                // Only include the fields requested. If an error is present, we ignore the requested fields.
+                if ( ! isset( $response['error'] ) ) {
+                        $response = $this->remove_unexpected_fields( $response, $request, 'plugin_information' );
+                }
 
                 $this->output( (object) $response );
@@ -256 +258 @@
                                 ), true
                         );
+
+                        // Don't include unknown plugins OR closed plugins.
                         if ( isset( $plugin['error'] ) ) {
                                 unset( $response['plugins'][ $i ] );

sites/trunk/wordpress.org/public_html/wp-content/themes/pub/wporg-plugins-2024/inc/template-tags.php

@@ -209 +209 @@
                 case 'disabled':
                 case 'closed':
-                        $closed_date  = get_post_meta( get_the_ID(), 'plugin_closed_date', true );
-                        $close_reason = Template::get_close_reason( $post );
-
-                        if ( $closed_date ) {
+                        $close_data = Template::get_close_data( $post );
+
+                        if ( $close_data['date'] ) {
                                 if ( 'disabled' === $post_status && current_user_can( 'plugin_approve' ) ) {
-                                        /* translators: %s: plugin closing date */
-                                        $message = sprintf( __( 'This plugin has been disabled as of %s -- this means it is closed, but actively serving updates.', 'wporg-plugins' ), mysql2date( get_option( 'date_format' ), $closed_date ) );
+                                        $message = sprintf(
+                                                /* translators: %s: plugin closing date */
+                                                __( 'This plugin has been disabled as of %s -- this means it is closed, but actively serving updates.', 'wporg-plugins' ),
+                                                mysql2date( get_option( 'date_format' ), $close_data['date'] )
+                                        );
                                 } else {
-                                        /* translators: %s: plugin closing date */
-                                        $message = sprintf( __( 'This plugin has been closed as of %s and is not available for download.', 'wporg-plugins' ), mysql2date( get_option( 'date_format' ), $closed_date ) );
+                                        $message = sprintf(
+                                                /* translators: %s: plugin closing date */
+                                                __( 'This plugin has been closed as of %s and is not available for download.', 'wporg-plugins' ),
+                                                mysql2date( get_option( 'date_format' ), $close_data['date'] )
+                                        );
                                 }
 
-                                // Determine permanence of closure.
-                                $committers = Tools::get_plugin_committers( $post->post_name );
-                                $permanent  = ( __( 'Author Request', 'wporg-plugins' ) === $close_reason || ! $committers );
-
-                                $days_passed = (int) ( ( current_time( 'timestamp' ) - mysql2date( 'U', $closed_date ) ) / DAY_IN_SECONDS );
-
                                 // If we're closed, it may be permanent.
-                                if ( $permanent ) {
+                                if ( $close_data['permanent'] ) {
                                         $message .= ' ' . __( 'This closure is permanent.', 'wporg-plugins' );
-                                } elseif ( $days_passed < 60 ) {
+                                } elseif ( ! $close_data['public'] ) {
                                         $message .= ' ' . __( 'This closure is temporary, pending a full review.', 'wporg-plugins' );
                                 }
 
-                                // Display close reason if more than 60 days have passed.
-                                if ( $days_passed >= 60 ) {
+                                // Display close reason if it's now publicly known.
+                                if ( $close_data['public'] && $close_data['reason'] ) {
                                         /* translators: %s: plugin close/disable reason */
-                                        $message .= ' ' . sprintf( __( 'Reason: %s.', 'wporg-plugins' ), $close_reason );
+                                        $message .= ' ' . sprintf( __( 'Reason: %s.', 'wporg-plugins' ), $close_data['label'] );
                                 }
                         } else {