WordPress.org

Making WordPress.org

Changeset 7049


Ignore:
Timestamp:
04/06/2018 05:04:54 AM (18 months 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:
2 edited

Legend:

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

    r7021 r7049  
    8989
    9090    /**
    91      * Flag to specify that a Contributor was ignored.
    92      *
    93      * @var bool
    94      */
    95     public $contributor_ignored = false;
     91     * Warning flags which indicate specific parsing failures have occured.
     92     *
     93     * @var array
     94     */
     95    public $warnings = array();
    9696
    9797    /**
     
    244244        }
    245245        if ( ! empty( $headers['requires_php'] ) ) {
    246             $this->requires_php = $headers['requires_php'];
     246            $this->requires_php = $this->sanitize_requires_php( $headers['requires_php'] );
    247247        }
    248248        if ( ! empty( $headers['contributors'] ) ) {
     
    551551            if ( ! $user ) {
    552552                unset( $users[ $i ] );
    553                 $this->contributor_ignored = true;
     553                $this->warnings['contributor_ignored'] = true;
    554554                continue;
    555555            }
     
    580580
    581581        return $stable_tag;
     582    }
     583
     584    /**
     585     * Sanitizes the Requires PHP header to ensure that it's a valid version header.
     586     *
     587     * @param string $version
     588     * @return string The sanitized $version
     589     */
     590    protected function sanitize_requires_php( $version ) {
     591        $version = trim( $version );
     592
     593        // x.y or x.y.z
     594        if ( $version && ! preg_match( '!^\d+(\.\d+){1,2}$!', $version ) ) {
     595            $this->warnings['requires_php_ignored'] = true;
     596            // Ignore the readme value.
     597            $version = '';
     598        }
     599
     600        return $version;
    582601    }
    583602
  • sites/trunk/wordpress.org/public_html/wp-content/plugins/plugin-directory/readme/class-validator.php

    r7023 r7049  
    7777            $warnings[] = sprintf( __( '%s field is missing.', 'wporg-plugins' ), '<code>Tested up to</code>' );
    7878        }
    79         if ( empty( $readme->requires_php ) ) {
     79        if ( isset( $readme->warnings['requires_php_ignored'] ) ) {
     80            /* translators: 1: plugin header tag; 2: Example version 5.2.4. 3: Example version 7.0. */
     81            $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>' );
     82        } elseif ( empty( $readme->requires_php ) ) {
    8083            /* translators: %s: plugin header tag */
    8184            $warnings[] = sprintf( __( '%s field is missing.', 'wporg-plugins' ), '<code>Requires PHP</code>' );
     
    8992            $warnings[] = sprintf( __( '%s field is missing.', 'wporg-plugins' ), '<code>Contributors</code>' );
    9093        }
    91         if ( $readme->contributor_ignored ) {
     94        if ( isset( $readme->warnings['contributor_ignored'] ) ) {
    9295            /* translators: %s: plugin header tag */
    9396            $warnings[] = sprintf( __( 'One or more contributors listed were ignored. %s field should only contain WordPress.org usernames.', 'wporg-plugins' ), '<code>Contributors</code>' );
Note: See TracChangeset for help on using the changeset viewer.