Changeset 7049

Timestamp:

04/06/2018 05:04:54 AM (6 years ago)

Author:

dd32

Message:

Plugin Directory: Readme: Ignore invalid Requires PHP headers and add a parsing warning clarifying the expected contents.

Fixes #3551.

Location:

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

Files:

• class-parser.php (modified) (4 diffs)
• class-validator.php (modified) (2 diffs)

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

@@ -89 +89 @@
 
     /**
-     * Flag to specify that a Contributor was ignored.
-     *
-     * @var bool
-     */
-    public $contributor_ignored = false;
+     * Warning flags which indicate specific parsing failures have occured.
+     *
+     * @var array
+     */
+    public $warnings = array();
 
     /**
@@ -244 +244 @@
         }
         if ( ! empty( $headers['requires_php'] ) ) {
-            $this->requires_php = $headers['requires_php'];
+            $this->requires_php = $this->sanitize_requires_php( $headers['requires_php'] );
         }
         if ( ! empty( $headers['contributors'] ) ) {
@@ -551 +551 @@
             if ( ! $user ) {
                 unset( $users[ $i ] );
-                $this->contributor_ignored = true;
+                $this->warnings['contributor_ignored'] = true;
                 continue;
             }
@@ -580 +580 @@
 
         return $stable_tag;
+    }
+
+    /**
+     * Sanitizes the Requires PHP header to ensure that it's a valid version header.
+     *
+     * @param string $version
+     * @return string The sanitized $version
+     */
+    protected function sanitize_requires_php( $version ) {
+        $version = trim( $version );
+
+        // x.y or x.y.z
+        if ( $version && ! preg_match( '!^\d+(\.\d+){1,2}$!', $version ) ) {
+            $this->warnings['requires_php_ignored'] = true;
+            // Ignore the readme value.
+            $version = '';
+        }
+
+        return $version;
     }
 

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

@@ -77 +77 @@
             $warnings[] = sprintf( __( '%s field is missing.', 'wporg-plugins' ), '<code>Tested up to</code>' );
         }
-        if ( empty( $readme->requires_php ) ) {
+        if ( isset( $readme->warnings['requires_php_ignored'] ) ) {
+            /* translators: 1: plugin header tag; 2: Example version 5.2.4. 3: Example version 7.0. */
+            $warnings[] = sprintf( __( 'The Requires PHP field was ignored. %1$s field should only contain a PHP version such as %2$s or %3$s.', 'wporg-plugins' ), '<code>Requires PHP</code>', '<code>5.2.4</code>', '<code>7.0</code>' );
+        } elseif ( empty( $readme->requires_php ) ) {
             /* translators: %s: plugin header tag */
             $warnings[] = sprintf( __( '%s field is missing.', 'wporg-plugins' ), '<code>Requires PHP</code>' );
@@ -89 +92 @@
             $warnings[] = sprintf( __( '%s field is missing.', 'wporg-plugins' ), '<code>Contributors</code>' );
         }
-        if ( $readme->contributor_ignored ) {
+        if ( isset( $readme->warnings['contributor_ignored'] ) ) {
             /* translators: %s: plugin header tag */
             $warnings[] = sprintf( __( 'One or more contributors listed were ignored. %s field should only contain WordPress.org usernames.', 'wporg-plugins' ), '<code>Contributors</code>' );