<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"
"http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head><meta http-equiv="content-type" content="text/html; charset=utf-8" />
<title>[7874] sites/trunk/wordpress.org/public_html/wp-content/plugins/plugin-directory/readme: Plugin Directory: Readme: Validate the `Tested up to` and `Requires at least` fields contain a WordPress version value.</title>
</head>
<body>
<style type="text/css"><!--
#msg dl.meta { border: 1px #006 solid; background: #369; padding: 6px; color: #fff; }
#msg dl.meta dt { float: left; width: 6em; font-weight: bold; }
#msg dt:after { content:':';}
#msg dl, #msg dt, #msg ul, #msg li, #header, #footer, #logmsg { font-family: verdana,arial,helvetica,sans-serif; font-size: 10pt; }
#msg dl a { font-weight: bold}
#msg dl a:link { color:#fc3; }
#msg dl a:active { color:#ff0; }
#msg dl a:visited { color:#cc6; }
h3 { font-family: verdana,arial,helvetica,sans-serif; font-size: 10pt; font-weight: bold; }
#msg pre { white-space: pre-line; overflow: auto; background: #ffc; border: 1px #fa0 solid; padding: 6px; }
#logmsg { background: #ffc; border: 1px #fa0 solid; padding: 1em 1em 0 1em; }
#logmsg p, #logmsg pre, #logmsg blockquote { margin: 0 0 1em 0; }
#logmsg p, #logmsg li, #logmsg dt, #logmsg dd { line-height: 14pt; }
#logmsg h1, #logmsg h2, #logmsg h3, #logmsg h4, #logmsg h5, #logmsg h6 { margin: .5em 0; }
#logmsg h1:first-child, #logmsg h2:first-child, #logmsg h3:first-child, #logmsg h4:first-child, #logmsg h5:first-child, #logmsg h6:first-child { margin-top: 0; }
#logmsg ul, #logmsg ol { padding: 0; list-style-position: inside; margin: 0 0 0 1em; }
#logmsg ul { text-indent: -1em; padding-left: 1em; }#logmsg ol { text-indent: -1.5em; padding-left: 1.5em; }
#logmsg > ul, #logmsg > ol { margin: 0 0 1em 0; }
#logmsg pre { background: #eee; padding: 1em; }
#logmsg blockquote { border: 1px solid #fa0; border-left-width: 10px; padding: 1em 1em 0 1em; background: white;}
#logmsg dl { margin: 0; }
#logmsg dt { font-weight: bold; }
#logmsg dd { margin: 0; padding: 0 0 0.5em 0; }
#logmsg dd:before { content:'\00bb';}
#logmsg table { border-spacing: 0px; border-collapse: collapse; border-top: 4px solid #fa0; border-bottom: 1px solid #fa0; background: #fff; }
#logmsg table th { text-align: left; font-weight: normal; padding: 0.2em 0.5em; border-top: 1px dotted #fa0; }
#logmsg table td { text-align: right; border-top: 1px dotted #fa0; padding: 0.2em 0.5em; }
#logmsg table thead th { text-align: center; border-bottom: 1px solid #fa0; }
#logmsg table th.Corner { text-align: left; }
#logmsg hr { border: none 0; border-top: 2px dashed #fa0; height: 1px; }
#header, #footer { color: #fff; background: #636; border: 1px #300 solid; padding: 6px; }
#patch { width: 100%; }
#patch h4 {font-family: verdana,arial,helvetica,sans-serif;font-size:10pt;padding:8px;background:#369;color:#fff;margin:0;}
#patch .propset h4, #patch .binary h4 {margin:0;}
#patch pre {padding:0;line-height:1.2em;margin:0;}
#patch .diff {width:100%;background:#eee;padding: 0 0 10px 0;overflow:auto;}
#patch .propset .diff, #patch .binary .diff {padding:10px 0;}
#patch span {display:block;padding:0 10px;}
#patch .modfile, #patch .addfile, #patch .delfile, #patch .propset, #patch .binary, #patch .copfile {border:1px solid #ccc;margin:10px 0;}
#patch ins {background:#dfd;text-decoration:none;display:block;padding:0 10px;}
#patch del {background:#fdd;text-decoration:none;display:block;padding:0 10px;}
#patch .lines, .info {color:#888;background:#fff;}
--></style>
<div id="msg">
<dl class="meta" style="font-size: 105%">
<dt style="float: left; width: 6em; font-weight: bold">Revision</dt> <dd><a style="font-weight: bold" href="http://meta.trac.wordpress.org/changeset/7874">7874</a><script type="application/ld+json">{"@context":"http://schema.org","@type":"EmailMessage","description":"Review this Commit","action":{"@type":"ViewAction","url":"http://meta.trac.wordpress.org/changeset/7874","name":"Review Commit"}}</script></dd>
<dt style="float: left; width: 6em; font-weight: bold">Author</dt> <dd>dd32</dd>
<dt style="float: left; width: 6em; font-weight: bold">Date</dt> <dd>2018-11-20 05:36:35 +0000 (Tue, 20 Nov 2018)</dd>
</dl>
<pre style='padding-left: 1em; margin: 2em 0; border-left: 2px solid #ccc; line-height: 1.25; font-size: 105%; font-family: sans-serif'>Plugin Directory: Readme: Validate the `Tested up to` and `Requires at least` fields contain a WordPress version value.
This commit will strip `Tested up to`/`Requires at least` values which are invalid versions, or higher than trunk/master - For example, currently that's 5.0, a value of '6.0' will be ignored, and 'Tested up to: PHP 5.2.4' will be also be ignored.
Fixes <a href="http://meta.trac.wordpress.org/ticket/3936">#3936</a></pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#sitestrunkwordpressorgpublic_htmlwpcontentpluginsplugindirectoryreadmeclassparserphp">sites/trunk/wordpress.org/public_html/wp-content/plugins/plugin-directory/readme/class-parser.php</a></li>
<li><a href="#sitestrunkwordpressorgpublic_htmlwpcontentpluginsplugindirectoryreadmeclassvalidatorphp">sites/trunk/wordpress.org/public_html/wp-content/plugins/plugin-directory/readme/class-validator.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="sitestrunkwordpressorgpublic_htmlwpcontentpluginsplugindirectoryreadmeclassparserphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: sites/trunk/wordpress.org/public_html/wp-content/plugins/plugin-directory/readme/class-parser.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- sites/trunk/wordpress.org/public_html/wp-content/plugins/plugin-directory/readme/class-parser.php 2018-11-19 20:57:27 UTC (rev 7873)
+++ sites/trunk/wordpress.org/public_html/wp-content/plugins/plugin-directory/readme/class-parser.php 2018-11-20 05:36:35 UTC (rev 7874)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -237,10 +237,10 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $this->tags = array_slice( $this->tags, 0, 5 );
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px"> if ( ! empty( $headers['requires'] ) ) {
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $this->requires = $headers['requires'];
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $this->requires = $this->sanitize_requires_version( $headers['requires'] );
</ins><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px"> if ( ! empty( $headers['tested'] ) ) {
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $this->tested = $headers['tested'];
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $this->tested = $this->sanitize_tested_version( $headers['tested'] );
</ins><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px"> if ( ! empty( $headers['requires_php'] ) ) {
</span><span class="cx" style="display: block; padding: 0 10px"> $this->requires_php = $this->sanitize_requires_php( $headers['requires_php'] );
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -580,7 +580,7 @@
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> // x.y or x.y.z
</span><span class="cx" style="display: block; padding: 0 10px"> if ( $version && ! preg_match( '!^\d+(\.\d+){1,2}$!', $version ) ) {
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $this->warnings['requires_php_ignored'] = true;
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $this->warnings['requires_php_header_ignored'] = true;
</ins><span class="cx" style="display: block; padding: 0 10px"> // Ignore the readme value.
</span><span class="cx" style="display: block; padding: 0 10px"> $version = '';
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -589,6 +589,81 @@
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> /**
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * Sanitizes the Tested header to ensure that it's a valid version header.
+ *
+ * @param string $version
+ * @return string The sanitized $version
+ */
+ protected function sanitize_tested_version( $version ) {
+ $version = trim( $version );
+
+ if ( $version ) {
+
+ // Handle the edge-case of 'WordPress 5.0' and 'WP 5.0' for historical purposes.
+ $strip_phrases = [
+ 'WordPress',
+ 'WP',
+ ];
+ $version = trim( str_ireplace( $strip_phrases, '', $version ) );
+
+ // Strip off any -alpha, -RC, -beta suffixes, as these complicate comparisons and are rarely used.
+ list( $version, ) = explode( '-', $version );
+
+ if (
+ // x.y or x.y.z
+ ! preg_match( '!^\d+\.\d(\.\d+)?$!', $version ) ||
+ // Allow plugins to mark themselves as compatible with Stable+0.1 (trunk/master) but not higher
+ defined( 'WP_CORE_STABLE_BRANCH' ) && ( (float)$version > (float)WP_CORE_STABLE_BRANCH+0.1 )
+ ) {
+ $this->warnings['tested_header_ignored'] = true;
+ // Ignore the readme value.
+ $version = '';
+ }
+ }
+
+ return $version;
+ }
+
+ /**
+ * Sanitizes the Requires at least header to ensure that it's a valid version header.
+ *
+ * @param string $version
+ * @return string The sanitized $version
+ */
+ protected function sanitize_requires_version( $version ) {
+ $version = trim( $version );
+
+ if ( $version ) {
+
+ // Handle the edge-case of 'WordPress 5.0' and 'WP 5.0' for historical purposes.
+ $strip_phrases = [
+ 'WordPress',
+ 'WP',
+ 'or higher',
+ 'and above',
+ '+',
+ ];
+ $version = trim( str_ireplace( $strip_phrases, '', $version ) );
+
+ // Strip off any -alpha, -RC, -beta suffixes, as these complicate comparisons and are rarely used.
+ list( $version, ) = explode( '-', $version );
+
+ if (
+ // x.y or x.y.z
+ ! preg_match( '!^\d+\.\d(\.\d+)?$!', $version ) ||
+ // Allow plugins to mark themselves as requireing Stable+0.1 (trunk/master) but not higher
+ defined( 'WP_CORE_STABLE_BRANCH' ) && ( (float)$version > (float)WP_CORE_STABLE_BRANCH+0.1 )
+ ) {
+ $this->warnings['requires_header_ignored'] = true;
+ // Ignore the readme value.
+ $version = '';
+ }
+ }
+
+ return $version;
+ }
+
+ /**
</ins><span class="cx" style="display: block; padding: 0 10px"> * Parses a slice of lines from the file into an array of Heading => Content.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * We assume that every heading encountered is a new item, and not a sub heading.
</span></span></pre></div>
<a id="sitestrunkwordpressorgpublic_htmlwpcontentpluginsplugindirectoryreadmeclassvalidatorphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: sites/trunk/wordpress.org/public_html/wp-content/plugins/plugin-directory/readme/class-validator.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- sites/trunk/wordpress.org/public_html/wp-content/plugins/plugin-directory/readme/class-validator.php 2018-11-19 20:57:27 UTC (rev 7873)
+++ sites/trunk/wordpress.org/public_html/wp-content/plugins/plugin-directory/readme/class-validator.php 2018-11-20 05:36:35 UTC (rev 7874)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -68,15 +68,37 @@
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> // Warnings.
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- if ( empty( $readme->requires ) ) {
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ if ( isset( $readme->warnings['requires_header_ignored'] ) ) {
+ $latest_wordpress_version = defined( 'WP_CORE_STABLE_BRANCH' ) ? WP_CORE_STABLE_BRANCH : '5.0';
+
+ /* translators: 1: plugin header tag; 2: Example version 5.0. 3: Example version 4.9. */
+ $warnings[] = sprintf(
+ __( 'The Requires at least field was ignored. %1$s field should only contain a valid WordPress version such as %2$s or %3$s.', 'wporg-plugins' ),
+ '<code>Requires at least</code>',
+ '<code>' . number_format( $latest_wordpress_version, 1 ) . '</code>',
+ '<code>' . number_format( $latest_wordpress_version - 0.1, 1 ) . '</code>'
+ );
+ } elseif ( empty( $readme->requires ) ) {
</ins><span class="cx" style="display: block; padding: 0 10px"> /* translators: %s: plugin header tag */
</span><span class="cx" style="display: block; padding: 0 10px"> $warnings[] = sprintf( __( '%s field is missing.', 'wporg-plugins' ), '<code>Requires at least</code>' );
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- if ( empty( $readme->tested ) ) {
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+
+ if ( isset( $readme->warnings['tested_header_ignored'] ) ) {
+ $latest_wordpress_version = defined( 'WP_CORE_STABLE_BRANCH' ) ? WP_CORE_STABLE_BRANCH : '5.0';
+
+ /* translators: 1: plugin header tag; 2: Example version 5.0. 3: Example version 5.1. */
+ $warnings[] = sprintf(
+ __( 'The Tested up to field was ignored. %1$s field should only contain a valid WordPress version such as %2$s or %3$s.', 'wporg-plugins' ),
+ '<code>Tested up to</code>',
+ '<code>' . number_format( $latest_wordpress_version, 1 ) . '</code>',
+ '<code>' . number_format( $latest_wordpress_version + 0.1, 1 ) . '</code>'
+ );
+ } elseif ( empty( $readme->tested ) ) {
</ins><span class="cx" style="display: block; padding: 0 10px"> /* translators: %s: plugin header tag */
</span><span class="cx" style="display: block; padding: 0 10px"> $warnings[] = sprintf( __( '%s field is missing.', 'wporg-plugins' ), '<code>Tested up to</code>' );
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- if ( isset( $readme->warnings['requires_php_ignored'] ) ) {
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+
+ if ( isset( $readme->warnings['requires_php_header_ignored'] ) ) {
</ins><span class="cx" style="display: block; padding: 0 10px"> /* translators: 1: plugin header tag; 2: Example version 5.2.4. 3: Example version 7.0. */
</span><span class="cx" style="display: block; padding: 0 10px"> $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>' );
</span><span class="cx" style="display: block; padding: 0 10px"> } elseif ( empty( $readme->requires_php ) ) {
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -87,13 +109,13 @@
</span><span class="cx" style="display: block; padding: 0 10px"> /* translators: 1: 'Stable tag', 2: /trunk/ SVN directory, 3: 'Stable tag: trunk' */
</span><span class="cx" style="display: block; padding: 0 10px"> $warnings[] = sprintf( __( '%1$s field is missing. Hint: If you treat %2$s as stable, put %3$s.', 'wporg-plugins' ), '<code>Stable tag</code>', '<code>/trunk/</code>', '<code>Stable tag: trunk</code>' );
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- if ( ! count( $readme->contributors ) ) {
- /* translators: %s: plugin header tag */
- $warnings[] = sprintf( __( '%s field is missing.', 'wporg-plugins' ), '<code>Contributors</code>' );
- }
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+
</ins><span class="cx" style="display: block; padding: 0 10px"> if ( isset( $readme->warnings['contributor_ignored'] ) ) {
</span><span class="cx" style="display: block; padding: 0 10px"> /* translators: %s: plugin header tag */
</span><span class="cx" style="display: block; padding: 0 10px"> $warnings[] = sprintf( __( 'One or more contributors listed were ignored. %s field should only contain WordPress.org usernames.', 'wporg-plugins' ), '<code>Contributors</code>' );
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ } elseif ( ! count( $readme->contributors ) ) {
+ /* translators: %s: plugin header tag */
+ $warnings[] = sprintf( __( '%s field is missing.', 'wporg-plugins' ), '<code>Contributors</code>' );
</ins><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> // Notes.
</span></span></pre>
</div>
</div>
</body>
</html>