Changeset 10971

Timestamp:

05/13/2021 07:20:04 PM (4 years ago)

Author:

ocean90

Message:

Plugin Directory: Update text domain check for plugins using the Requires at least header in the plugin's main PHP file.

Fixes #4514.

Location:

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

Files:

• class-import.php (modified) (3 diffs)
• i18n/class-code-import.php (modified) (4 diffs)

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

@@ -297 +297 @@
         /**
          * Action that fires after a plugin is imported.
-         * 
+         *
          * @param WP_Post $plugin         The plugin updated.
          * @param string  $stable_tag     The new stable tag for the plugin.
@@ -680 +680 @@
      * @return string The plugin readme.txt or readme.md filename.
      */
-    static function find_readme_file( $directory ) {
+    public static function find_readme_file( $directory ) {
         $files = Filesystem::list_files( $directory, false /* non-recursive */, '!(?:^|/)readme\.(txt|md)$!i' );
 
@@ -700 +700 @@
      * @return object The plugin headers.
      */
-    static function find_plugin_headers( $directory ) {
+    public static function find_plugin_headers( $directory ) {
         $files = Filesystem::list_files( $directory, false, '!\.php$!i' );
 

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

@@ -3 +3 @@
 
 use Exception;
+use WordPressdotorg\Plugin_Directory\CLI\Import;
 use WordPressdotorg\Plugin_Directory\Readme\Parser;
 use WordPressdotorg\Plugin_Directory\Tools\Filesystem;
@@ -86 +87 @@
      */
     private function is_plugin_valid( $export_directory ) {
-        $readme = new Parser( $this->find_readme_file( $export_directory ) );
+        $readme   = new Parser( Import::find_readme_file( $export_directory ) );
+        $requires = $readme->requires;
 
-        // Whether plugin files should be checked for valid text domains.
-        if ( empty( $readme->requires ) || version_compare( $readme->requires, '4.6', '<' ) ) {
+        // Prefer requires field from the plugin headers if set.
+        $headers = Import::find_plugin_headers( $export_directory );
+        if ( $headers->RequiresWP && preg_match( '!^[\d.]{3,}$!', $headers->RequiresWP ) ) {
+            $requires = $headers->RequiresWP;
+        }
+
+        // Whether plugin files should be checked for valid text domain setup.
+        if ( empty( $requires ) || version_compare( $requires, '4.6', '<' ) ) {
             $error                = new WP_Error();
             $esc_export_directory = escapeshellarg( $export_directory );
@@ -101 +109 @@
 
                 if ( ! $has_slug_as_textdomain_header ) {
-                    $error->add( 'wrong_textdomain', 'Wrong text domain in header.' );
+                    $error->add( 'wrong_textdomain', 'Requires WordPress ' . ( $requires ?: 'n/a' ) . '; wrong text domain in header, expected `' . $this->plugin . '`.' );
                 }
             } else {
-                $error->add( 'missing_textdomain', 'Missing text domain in header.' );
+                $error->add( 'missing_textdomain', 'Requires WordPress ' .  ( $requires ?: 'n/a' ) . '; missing text domain in header.' );
             }
 
             if ( ! $has_load_plugin_textdomain ) {
-                $error->add( 'missing_load_plugin_textdomain', 'Missing load_plugin_textdomain().' );
+                $error->add( 'missing_load_plugin_textdomain', 'Requires WordPress ' .  ( $requires ?: 'n/a' ) . '; missing load_plugin_textdomain() call.' );
             }
 
@@ -118 +126 @@
         return true;
     }
-
-    /**
-     * Find the plugin readme file.
-     *
-     * Looks for either a readme.txt or readme.md file, prioritizing readme.txt.
-     *
-     * @param string $directory
-     * @return string The plugin readme.txt or readme.md filename.
-     */
-    private function find_readme_file( $directory ) {
-        $files = Filesystem::list_files( $directory, false /* non-recursive */, '!^readme\.(txt|md)$!i' );
-
-        // Prioritize readme.txt
-        foreach ( $files as $file ) {
-            if ( '.txt' === strtolower( substr( $file, -4 ) ) ) {
-                return $file;
-            }
-        }
-
-        return reset( $files );
-    }
 }