<!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>[13618] sites/trunk/wordpress.org/public_html/wp-content/plugins/plugin-directory/readme: Plugin Directory: Readme: Validate that the license field contains a likely valid license.</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/13618">13618</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/13618","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>2024-04-30 04:41:42 +0000 (Tue, 30 Apr 2024)</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 that the license field contains a likely valid license.
This adds to the existing "no license" with two new ones:
- Warning: License appears to be not-GPL-compatible, invalid
- Note: We could not parse the license specified, unknown
Fixes <a href="http://meta.trac.wordpress.org/ticket/1944">#1944</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 2024-04-30 04:01:46 UTC (rev 13617)
+++ sites/trunk/wordpress.org/public_html/wp-content/plugins/plugin-directory/readme/class-parser.php 2024-04-30 04:41:42 UTC (rev 13618)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -341,9 +341,10 @@
</span><span class="cx" style="display: block; padding: 0 10px"> if ( ! empty( $headers['license'] ) ) {
</span><span class="cx" style="display: block; padding: 0 10px"> // Handle the many cases of "License: GPLv2 - http://..."
</span><span class="cx" style="display: block; padding: 0 10px"> if ( empty( $headers['license_uri'] ) && preg_match( '!(https?://\S+)!i', $headers['license'], $url ) ) {
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $headers['license_uri'] = $url[1];
- $headers['license'] = trim( str_replace( $url[1], '', $headers['license'] ), " -*\t\n\r\n" );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $headers['license_uri'] = trim( $url[1], " -*\t\n\r\n(" );
+ $headers['license'] = trim( str_replace( $url[1], '', $headers['license'] ), " -*\t\n\r\n(" );
</ins><span class="cx" style="display: block; padding: 0 10px"> }
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+
</ins><span class="cx" style="display: block; padding: 0 10px"> $this->license = $headers['license'];
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px"> if ( ! empty( $headers['license_uri'] ) ) {
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -350,6 +351,16 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $this->license_uri = $headers['license_uri'];
</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">+ // Validate the license specified.
+ if ( ! $this->license ) {
+ $this->warnings['license_missing'] = true;
+ } else {
+ $license_error = $this->validate_license( $this->license );
+ if ( true !== $license_error ) {
+ $this->warnings[ $license_error ] = $this->license;
+ }
+ }
+
</ins><span class="cx" style="display: block; padding: 0 10px"> // Parse the short description.
</span><span class="cx" style="display: block; padding: 0 10px"> while ( ( $line = array_shift( $contents ) ) !== null ) {
</span><span class="cx" style="display: block; padding: 0 10px"> $trimmed = trim( $line );
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -919,4 +930,95 @@
</span><span class="cx" style="display: block; padding: 0 10px"> return $markdown->transform( $text );
</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">+ /**
+ * Validate whether the license specified appears to be valid or not.
+ *
+ * NOTE: This does not require a SPDX license to be specified, but it should be a valid license nonetheless.
+ *
+ * @param string $license The specified license.
+ * @return string|bool True if it looks good, error code on failure.
+ */
+ public function validate_license( $license ) {
+ /*
+ * This is a shortlist of keywords that are expected to be found in a valid license field.
+ * See https://www.gnu.org/licenses/license-list.en.html for possible compatible licenses.
+ */
+ $probably_compatible = [
+ 'GPL', 'General Public License',
+ // 'GNU 2', 'GNU Public', 'GNU Version 2' explicitely not included, as it's not a specific license.
+ 'MIT',
+ 'ISC',
+ 'Expat',
+ 'Apache 2', 'Apache License 2',
+ 'X11', 'Modified BSD', 'New BSD', '3 Clause BSD', 'BSD 3',
+ 'FreeBSD', 'Simplified BSD', '2 Clause BSD', 'BSD 2',
+ 'MPL', 'Mozilla Public License',
+ strrev( 'LPFTW' ), strrev( 'kcuf eht tahw od' ), // To avoid some code scanners..
+ 'Public Domain', 'CC0', 'Unlicense',
+ 'CC BY', // Note: BY-NC & BY-ND are a no-no. See below.
+ 'zlib',
+ ];
+
+ /*
+ * This is a shortlist of keywords that are likely related to a non-GPL compatible license.
+ * See https://www.gnu.org/licenses/license-list.en.html for possible explanations.
+ */
+ $probably_incompatible = [
+ '4 Clause BSD', 'BSD 4 Clause',
+ 'Apache 1',
+ 'CC BY-NC', 'CC-NC', 'NonCommercial',
+ 'CC BY-ND', 'NoDerivative',
+ 'EUPL',
+ 'OSL',
+ 'Personal use', 'without permission', 'without prior auth', 'you may not',
+ 'Proprietery', 'proprietary',
+ ];
+
+ $sanitize_license = static function( $license ) {
+ $license = strtolower( $license );
+
+ // Localised or verbose licences.
+ $license = str_replace( 'licence', 'license', $license );
+ $license = str_replace( 'clauses', 'clause', $license ); // BSD
+ $license = str_replace( 'creative commons', 'cc', $license );
+
+ // If it looks like a full GPL statement, trim it back, for this function.
+ if ( 0 === stripos( $license, 'GNU GENERAL PUBLIC LICENSE Version 2, June 1991 Copyright (C) 1989' ) ) {
+ $license = 'gplv2';
+ }
+
+ // Replace 'Version 9' & v9 with '9' for simplicity.
+ $license = preg_replace( '/(version |v)([0-9])/i', '$2', $license );
+
+ // Remove unexpected characters
+ $license = preg_replace( '/(\s*[^a-z0-9. ]+\s*)/i', '', $license );
+
+ // Remove all spaces
+ $license = preg_replace( '/\s+/', '', $license );
+
+ return $license;
+ };
+
+ $probably_compatible = array_map( $sanitize_license, $probably_compatible );
+ $probably_incompatible = array_map( $sanitize_license, $probably_incompatible );
+ $license = $sanitize_license( $license );
+
+ // First check to see if it's most probably an incompatible license.
+ foreach ( $probably_incompatible as $match ) {
+ if ( str_contains( $license, $match ) ) {
+ return 'invalid_license';
+ }
+ }
+
+ // Check to see if it's likely compatible.
+ foreach ( $probably_compatible as $match ) {
+ if ( str_contains( $license, $match ) ) {
+ return true;
+ }
+ }
+
+ // If we've made it this far, it's neither likely incompatible, or likely compatible, so unknown.
+ return 'unknown_license';
+ }
+
</ins><span class="cx" style="display: block; padding: 0 10px"> }
</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 2024-04-30 04:01:46 UTC (rev 13617)
+++ sites/trunk/wordpress.org/public_html/wp-content/plugins/plugin-directory/readme/class-validator.php 2024-04-30 04:41:42 UTC (rev 13618)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -144,8 +144,12 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $notes['contributors_missing'] = true;
</span><span class="cx" style="display: block; padding: 0 10px"> }
</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->license ) ) {
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ if ( ! empty( $readme->warnings['license_missing'] ) ) {
</ins><span class="cx" style="display: block; padding: 0 10px"> $warnings['license_missing'] = true;
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ } elseif ( ! empty( $readme->warnings['invalid_license'] ) ) {
+ $errors['invalid_license'] = $readme->warnings['invalid_license'];
+ } elseif ( ! empty( $readme->warnings['unknown_license'] ) ) {
+ $notes['unknown_license'] = $readme->warnings['unknown_license'];
</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"> if ( isset( $readme->warnings['too_many_tags'] ) ) {
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -397,13 +401,31 @@
</span><span class="cx" style="display: block; padding: 0 10px"> );
</span><span class="cx" style="display: block; padding: 0 10px"> case 'donate_link_missing':
</span><span class="cx" style="display: block; padding: 0 10px"> return __( 'No donate link was found', 'wporg-plugins' );
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+
</ins><span class="cx" style="display: block; padding: 0 10px"> case 'license_missing':
</span><span class="cx" style="display: block; padding: 0 10px"> return sprintf(
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- /* translators: 1: 'License' */
- __( 'The %1$s field is missing or invalid. A GPLv2 or later compatible license should be specified.', 'wporg-plugins' ),
- '<code>License</code>'
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ /* translators: 1: 'License', 2: Link to a compatible licenses page. */
+ __( 'The %1$s field is missing. <a href="%2$s">A GPLv2 or later compatible license</a> should be specified.', 'wporg-plugins' ),
+ '<code>License</code>',
+ 'https://www.gnu.org/licenses/license-list.en.html'
</ins><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">+ case 'invalid_license':
+ return sprintf(
+ /* translators: 1: 'License', 2: Link to a compatible licenses page. */
+ __( 'The %1$s field appears to be invalid. <a href="%2$s">A GPLv2 or later compatible license</a> should be specified.', 'wporg-plugins' ),
+ '<code>License</code>',
+ 'https://www.gnu.org/licenses/license-list.en.html'
+ );
+
+ case 'unknown_license':
+ return sprintf(
+ /* translators: 1: 'License', 2: Link to a compatible licenses page. */
+ __( 'The %1$s field could not be validated. <a href="%2$s">A GPLv2 or later compatible license</a> should be specified. The specified license may be compatible.', 'wporg-plugins' ),
+ '<code>License</code>',
+ 'https://www.gnu.org/licenses/license-list.en.html'
+ );
+
</ins><span class="cx" style="display: block; padding: 0 10px"> case 'trademarked_name':
</span><span class="cx" style="display: block; padding: 0 10px"> case 'trademarked_slug':
</span><span class="cx" style="display: block; padding: 0 10px"> case 'trademarked':
</span></span></pre>
</div>
</div>
</body>
</html>