Changeset 11908

Timestamp:

06/09/2022 01:47:36 AM (3 years ago)

Author:

dd32

Message:

Plugin Directory: Readme Parser: Be more tolerable of blank lines within the headers if it's followed by a valid header.

This allows for these edgecases to be handled:

• "Tags: a,b,c\n\nStable Tag: 1.2"
• "Tags: a,b,c\nStrangeHeader: true\nStable Tag: 1.2"

along with the expected and valid

• "tags: a,b,c\nStable Tag: 1.2"

while also not discarding a Short description just because it contained a :.

Props Ipstenu for the report.
Fixes #6358.

File:

• sites/trunk/wordpress.org/public_html/wp-content/plugins/plugin-directory/readme/class-parser.php (modified) (2 diffs)

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

@@ -238 +238 @@
         $headers = array();
 
-        $line = $this->get_first_nonwhitespace( $contents );
+        $line                = $this->get_first_nonwhitespace( $contents );
+        $last_line_was_blank = false;
         do {
             $value = null;
-            if ( false === strpos( $line, ':' ) ) {
-
-                // Some plugins have line-breaks within the headers.
+            // If it doesn't look like a header value, maybe break to the next section.
+            if ( ! str_contains( $line, ':' ) || str_starts_with( $line, '#' ) || str_starts_with( $line, '=' ) ) {
                 if ( empty( $line ) ) {
+                    // Some plugins have line-breaks within the headers...
+                    $last_line_was_blank = true;
+                    continue;
+                } else {
+                    // We've hit a line that is not blank, but also doesn't look like a header, assume the Short Description and end Header parsing.
                     break;
-                } else {
-                    continue;
                 }
             }
@@ -254 +257 @@
             list( $key, $value ) = $bits;
             $key                 = strtolower( trim( $key, " \t*-\r\n" ) );
+
             if ( isset( $this->valid_headers[ $key ] ) ) {
                 $headers[ $this->valid_headers[ $key ] ] = trim( $value );
-            }
+            } elseif ( $last_line_was_blank ) {
+                // If we skipped over a blank line, and then ended up with an unexpected header, assume we parsed too far and ended up in the Short Description.
+                // This final line will be added back into the stack after the loop for further parsing.
+                break;
+            }
+
+            $last_line_was_blank = false;
         } while ( ( $line = array_shift( $contents ) ) !== null );
         array_unshift( $contents, $line );