Changeset 13162

Timestamp:

02/01/2024 04:11:12 AM (2 years ago)

Author:

dd32

Message:

Plugin Directory: Readme: Parse readme's that lack a plugin header.

Fixes #7428.

File:

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

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

@@ -228 +228 @@
             $this->warnings['invalid_plugin_name_header'] = true;
 
-            $this->name = $line = $this->get_first_nonwhitespace( $contents );
-
-            // Ensure that the line read wasn't an actual header or description.
-            if ( strlen( $line ) > 50 || preg_match( '~^(' . implode( '|', array_keys( $this->valid_headers ) ) . ')\s*:~i', $line ) ) {
-                $this->name = false;
-                array_unshift( $contents, $line );
-            }
+            $this->name = false;
+            $line       = $this->get_first_nonwhitespace( $contents );
+
+            // Ensure that the line read doesn't look like a description.
+            if ( strlen( $line ) < 50 && ! $this->parse_possible_header( $line, true /* only valid headers */ ) ) {
+                $this->name = $this->sanitize_text( trim( $line, "#= \t\0\x0B" ) );
+            }
+        }
+
+        // It's possible to leave the plugin name header off entirely.
+        if ( $this->parse_possible_header( $this->name, true /* only valid headers */ ) ) {
+            array_unshift( $contents, $line );
+
+            $this->warnings['invalid_plugin_name_header'] = true;
+            $this->name                                   = false;
         }
 
@@ -243 +251 @@
         $last_line_was_blank = false;
         do {
-            $value = null;
+            $value  = null;
+            $header = $this->parse_possible_header( $line );
+
             // 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 ( ! $header ) {
                 if ( empty( $line ) ) {
                     // Some plugins have line-breaks within the headers...
@@ -256 +266 @@
             }
 
-            $bits                = explode( ':', trim( $line ), 2 );
-            list( $key, $value ) = $bits;
-            $key                 = strtolower( trim( $key, " \t*-\r\n" ) );
+            list( $key, $value ) = $header;
 
             if ( isset( $this->valid_headers[ $key ] ) ) {
-                $headers[ $this->valid_headers[ $key ] ] = trim( $value );
+                $headers[ $this->valid_headers[ $key ] ] = $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.
@@ -520 +528 @@
 
         return trim( $desc );
+    }
+
+    /**
+     * Parse a line to see if it's a header.
+     *
+     * @access protected
+     *
+     * @param string $line       The line from the readme to parse.
+     * @param bool   $only_valid Whether to only return a valid known header.
+     * @return false|array
+     */
+    protected function parse_possible_header( $line, $only_valid = false ) {
+        if ( ! str_contains( $line, ':' ) || str_starts_with( $line, '#' ) || str_starts_with( $line, '=' ) ) {
+            return false;
+        }
+
+        list( $key, $value ) = explode( ':', $line, 2 );
+        $key                 = strtolower( trim( $key, " \t*-\r\n" ) );
+        $value               = trim( $value, " \t*-\r\n" );
+
+        if ( $only_valid && ! isset( $this->valid_headers[ $key ] ) ) {
+            return false;
+        }
+
+        return [ $key, $value ];
     }