Changeset 13234

Timestamp:

02/22/2024 05:30:26 AM (10 months ago)

Author:

dd32

Message:

Plugin Directory: Store errors encountered during the plugin import process.

See #6921, #6108.

Location:

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

Files:

• cli/class-import.php (modified) (9 diffs)
• jobs/class-plugin-import.php (modified) (1 diff)

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

@@ -8 +8 @@
 use WordPressdotorg\Plugin_Directory\Plugin_Directory;
 use WordPressdotorg\Plugin_Directory\Email\Release_Confirmation as Release_Confirmation_Email;
-use WordPressdotorg\Plugin_Directory\Readme\Parser;
+use WordPressdotorg\Plugin_Directory\Readme\{ Parser as Readme_Parser, Validator as Readme_Validator };
 use WordPressdotorg\Plugin_Directory\Standalone\Plugins_Info_API;
 use WordPressdotorg\Plugin_Directory\Template;
@@ -58 +58 @@
 
     /**
+     * List of warnings generated during the import process.
+     *
+     * @var array
+     */
+    public $warnings = array();
+
+    /**
+     * The last plugin imported.
+     *
+     * @var \WP_Post
+     */
+    public $plugin;
+
+    /**
      * Process an import for a Plugin into the Plugin Directory.
      *
@@ -67 +81 @@
      */
     public function import_from_svn( $plugin_slug, $svn_changed_tags = array( 'trunk' ), $svn_revision_triggered = 0 ) {
-        $plugin = Plugin_Directory::get_plugin_post( $plugin_slug );
+        // Reset properties.
+        $this->warnings = [];
+
+        $plugin = $this->plugin = Plugin_Directory::get_plugin_post( $plugin_slug );
         if ( ! $plugin ) {
             throw new Exception( 'Unknown Plugin' );
@@ -87 +104 @@
         $touches_stable_tag = (bool) array_intersect( [ $stable_tag, $current_stable_tag ], $svn_changed_tags );
 
+        // If the readme generated any warnings, raise it to self::$import_warnings;
+        if ( $readme->warnings ) {
+            // Convert the warnings to a human readable format.
+            $readme_warnings = Readme_Validator::instance()->validate_content( $readme->raw_contents );
+
+            foreach ( [ 'errors', 'warnings' ] as $field ) {
+                foreach ( $readme_warnings[ $field ] ?? [] as $warning ) {
+                    $this->warnings[] = "Readme: {$warning}";
+                }
+            }
+        }
+
         // Validate various headers:
 
@@ -99 +128 @@
             $update_uri_valid = preg_match( '!^(https?://)?(wordpress.org|w.org)/plugins?/(?P<slug>[^/]+)/?$!i', $headers->UpdateURI, $update_uri_matches );
             if ( ! $update_uri_valid || $update_uri_matches['slug'] !== $plugin_slug ) {
-                throw new Exception( 'Invalid Update URI header detected: ' . $headers->UpdateURI );
+                $this->warnings['invalid_update_uri'] = 'Invalid Update URI header detected: ' . $headers->UpdateURI;
+
+                throw new Exception( $this->warnings['invalid_update_uri'] );
             }
         }
@@ -122 +153 @@
 
         if ( $unmet_dependencies ) {
-            throw new Exception( 'Invalid plugin dependencies specified. The following dependencies could not be resolved: ' . implode( ', ', $requires_plugins_unmet ) );
+            $this->warnings['unmet_dependencies'] = 'Invalid plugin dependencies specified. The following dependencies could not be resolved: ' . implode( ', ', $requires_plugins_unmet );
+
+            throw new Exception( $this->warnings['unmet_dependencies'] );
         }
         unset( $_requires_plugins, $unmet_dependencies );
@@ -412 +445 @@
          * @param array   $changed_tags   The list of SVN tags/trunk affected to trigger the import.
          * @param int     $svn_revision   The SVN revision that triggered the import.
+         * @param array   $warnings       The list of warnings generated during the import process.
          */
-        do_action( 'wporg_plugins_imported', $plugin, $stable_tag, $current_stable_tag, $svn_changed_tags, $svn_revision_triggered );
+        do_action( 'wporg_plugins_imported', $plugin, $stable_tag, $current_stable_tag, $svn_changed_tags, $svn_revision_triggered, $this->warnings );
 
         return true;
@@ -564 +598 @@
 
             $trunk_readme_file = self::PLUGIN_SVN_BASE . "/{$plugin_slug}/trunk/{$trunk_readme_file}";
-            $trunk_readme      = new Parser( $trunk_readme_file );
+            $trunk_readme      = new Readme_Parser( $trunk_readme_file );
 
             $stable_tag = $trunk_readme->stable_tag;
@@ -624 +658 @@
         // The readme may not actually exist, but that's okay.
         $readme = $this->find_readme_file( $tmp_dir . '/export' );
-        $readme = new Parser( $readme );
+        $readme = new Readme_Parser( $readme );
 
         // There must be valid plugin headers though.

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

@@ -44 +44 @@
         $revision     = max( (array) $plugin_data['revisions'] );
 
+        $importer = new CLI\Import();
         try {
-            $importer = new CLI\Import();
             $importer->import_from_svn( $plugin_slug, $tags_touched, $revision );
         } catch ( Exception $e ) {
             fwrite( STDERR, "[{$plugin_slug}] Plugin Import Failed: " . $e->getMessage() . "\n" );
+        } finally {
+            if ( $importer->plugin ) {
+                update_post_meta( $importer->plugin->ID, '_last_import', time() );
+                update_post_meta( $importer->plugin->ID, '_import_warnings', $importer->warnings );
+            }
         }