Changeset 12532

Timestamp:

04/12/2023 04:50:46 AM (22 months ago)

Author:

dd32

Message:

Plugin Directory: Import the Requires Plugins header on plugin import.

At present this is not used for anything, and is for future purposes.

See #6921, ​https://core.trac.wordpress.org/ticket/22316.

Location:

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

Files:

• cli/class-import.php (modified) (3 diffs)
• shortcodes/class-upload-handler.php (modified) (5 diffs)

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

@@ -42 +42 @@
     // Plugin headers that are stored in plugin meta
     public $plugin_headers = array(
-        // Header    => meta_key
-        'Name'       => 'header_name',
-        'PluginURI'  => 'header_plugin_uri',
-        'Author'     => 'header_author',
-        'AuthorURI'  => 'header_author_uri',
-        'TextDomain' => 'header_textdomain',
+        // Header         => meta_key
+        'Name'            => 'header_name',
+        'PluginURI'       => 'header_plugin_uri',
+        'Author'          => 'header_author',
+        'AuthorURI'       => 'header_author_uri',
+        'TextDomain'      => 'header_textdomain',
+        'RequiresPlugins' => 'requires_plugins'
 
         // These headers are stored in these fields, but are handled separately.
@@ -723 +724 @@
      *
      * @param string $directory The directory of the plugin.
+     * @param int    $max_depth The maximum depth to search for files. Default: current directory only.
      *
      * @return object The plugin headers.
      */
-    public static function find_plugin_headers( $directory ) {
-        $files = Filesystem::list_files( $directory, false, '!\.php$!i' );
+    public static function find_plugin_headers( $directory, $max_depth = -1 ) {
+        $files = Filesystem::list_files( $directory, ( $max_depth > 0 ), '!\.php$!i', $max_depth );
 
         if ( ! function_exists( 'get_plugin_data' ) ) {
@@ -733 +735 @@
         }
 
+        // Add any additional headers required.
+        add_filter( 'extra_plugin_headers', array( __CLASS__, 'add_extra_plugin_headers' ) );
+
         /*
          * Sometimes plugins have multiple files which we detect as a plugin based on the headers.
-         * We'll return immediately if the file has a `Plugin Name:` header, otherwise
+         * We'll break immediately if the file has a `Plugin Name:` header, otherwise
          * simply return the last set of headers we come across.
          */
-        $possible_headers = false;
+        $headers = false;
         foreach ( $files as $file ) {
             $data = get_plugin_data( $file, false, false );
             if ( array_filter( $data ) ) {
-                if ( $data['Name'] ) {
-                    return (object) $data;
-                } else {
-                    $possible_headers = (object) $data;
-                }
-            }
-        }
-
-        if ( $possible_headers ) {
-            return $possible_headers;
-        }
-
-        return false;
+                $data['PluginFile'] = $file;
+                $headers            = $data;
+
+                if ( $headers['Name'] ) {
+                    break;
+                }
+            }
+        }
+
+        remove_filter( 'extra_plugin_headers', array( __CLASS__, 'add_extra_plugin_headers' ) );
+
+        if ( ! $headers ) {
+            return false;
+        }
+
+        // The extra_plugin_headers filter doesn't let you set the key.
+        foreach ( self::add_extra_plugin_headers( [] ) as $key => $header ) {
+            if (
+                $key != $header &&
+                ! isset( $headers[ $key ] ) &&
+                isset( $headers[ $header ] )
+            ) {
+                $headers[ $key ] = $headers[ $header ];
+                unset( $headers[ $header ] );
+            }
+        }
+
+        return (object) $headers;
+    }
+
+    /**
+     * Add support for additional plugin headers prior to WordPress supporting it.
+     *
+     * @param array $headers The headers to look for in plugins.
+     * @return array
+     */
+    public static function add_extra_plugin_headers( $headers ) {
+        // WordPress Plugin Dependencies - See https://meta.trac.wordpress.org/ticket/6921
+        if ( ! isset( $headers['RequiresPlugins'] ) ) {
+            $headers['RequiresPlugins'] = 'Requires Plugins';
+        }
+
+        return $headers;
     }
 

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

@@ -2 +2 @@
 namespace WordPressdotorg\Plugin_Directory\Shortcodes;
 
+use WordPressdotorg\Plugin_Directory\CLI\Import;
 use WordPressdotorg\Plugin_Directory\Readme\Parser;
 use WordPressdotorg\Plugin_Directory\Plugin_Directory;
@@ -64 +65 @@
         $this->plugin_dir = Filesystem::unzip( $zip_file );
 
-        $plugin_files = Filesystem::list_files( $this->plugin_dir, true /* Recursive */, '!\.php$!i', 1 /* Depth */ );
-        foreach ( $plugin_files as $plugin_file ) {
-            $plugin_data = get_plugin_data( $plugin_file, false, false ); // No markup/translation needed.
-            if ( ! empty( $plugin_data['Name'] ) ) {
-                $this->plugin      = $plugin_data;
-                $this->plugin_root = dirname( $plugin_file );
-                break;
-            }
+        $plugin_data = (array) Import::find_plugin_headers( $this->plugin_dir, 1 /* Max Depth to search */ );
+        if ( ! empty( $plugin_data['Name'] ) ) {
+            $this->plugin      = $plugin_data;
+            $this->plugin_root = dirname( $plugin_data['PluginFile'] );
         }
 
@@ -262 +259 @@
 
         // Check for a valid readme.
-        $readme = $this->find_readme_file();
+        $readme = Import::find_readme_file( $this->plugin_root );
         if ( empty( $readme ) ) {
             $error = __( 'Error: The plugin has no readme.', 'wporg-plugins' );
@@ -381 +378 @@
                     'header_textdomain'        => $this->plugin['TextDomain'],
                     'header_description'       => $this->plugin['Description'],
+                    'requires_plugins'         => $this->plugin['RequiresPlugins'],
                     'assets_screenshots'       => array(),
                     'assets_icons'             => array(),
@@ -677 +675 @@
 
     /**
-     * Find the plugin readme file.
-     *
-     * Looks for either a readme.txt or readme.md file, prioritizing readme.txt.
-     *
-     * @return string The plugin readme.txt or readme.md filename.
-     */
-    protected function find_readme_file() {
-        $files = Filesystem::list_files( $this->plugin_root, false /* non-recursive */, '!^readme\.(txt|md)$!i' );
-
-        // Prioritize readme.txt file.
-        foreach ( $files as $file ) {
-            if ( '.txt' === strtolower( substr( $file, -4 ) ) ) {
-                return $file;
-            }
-        }
-
-        return reset( $files );
-    }
-
-    /**
      * Sends a plugin through Plugin Check.
      *