<!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>[10013] sites/trunk/wordpress.org/public_html/wp-content/plugins/plugin-directory/cli/class-block-plugin-checker.php: Plugin directory: add more validation rules.</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/10013">10013</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/10013","name":"Review Commit"}}</script></dd>
<dt style="float: left; width: 6em; font-weight: bold">Author</dt> <dd>tellyworth</dd>
<dt style="float: left; width: 6em; font-weight: bold">Date</dt> <dd>2020-07-06 04:20:13 +0000 (Mon, 06 Jul 2020)</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: add more validation rules.
Also improve a few existing rules.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#sitestrunkwordpressorgpublic_htmlwpcontentpluginsplugindirectorycliclassblockplugincheckerphp">sites/trunk/wordpress.org/public_html/wp-content/plugins/plugin-directory/cli/class-block-plugin-checker.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="sitestrunkwordpressorgpublic_htmlwpcontentpluginsplugindirectorycliclassblockplugincheckerphp"></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/cli/class-block-plugin-checker.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/cli/class-block-plugin-checker.php 2020-07-05 23:54:45 UTC (rev 10012)
+++ sites/trunk/wordpress.org/public_html/wp-content/plugins/plugin-directory/cli/class-block-plugin-checker.php 2020-07-06 04:20:13 UTC (rev 10013)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -34,6 +34,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> protected $headers = null;
</span><span class="cx" style="display: block; padding: 0 10px"> protected $blocks = null;
</span><span class="cx" style="display: block; padding: 0 10px"> protected $block_json_files = null;
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ protected $asset_php_files = null;
</ins><span class="cx" style="display: block; padding: 0 10px"> protected $block_json_validation = array();
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> /**
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -43,6 +44,11 @@
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> public function __construct( $slug = null ) {
</span><span class="cx" style="display: block; padding: 0 10px"> $this->slug = $slug;
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+
+ add_filter( 'extra_plugin_headers', function( $extra_headers ) {
+ $extra_headers[ 'License' ] = 'License';
+ return $extra_headers;
+ } );
</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"> /**
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -203,6 +209,8 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $block_json = Block_JSON_Parser::parse( array( 'file' => $block_json_file ) );
</span><span class="cx" style="display: block; padding: 0 10px"> $this->block_json_validation[ $block_json_file ] = $validator->validate( $block_json );
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+
+ $this->asset_php_files = $this->find_asset_php_files( $this->path_to_plugin );
</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"> public function relative_filename( $filename ) {
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -260,6 +268,13 @@
</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">+ * Find index.asset.php files as generated by the create block scripts.
+ */
+ public function find_asset_php_files( $base_dir ) {
+ return Filesystem::list_files( $base_dir, true, '!(:^|/)\w+\.asset\.php$!' );
+ }
+
+ /**
</ins><span class="cx" style="display: block; padding: 0 10px"> * Used by check_*() functions to record info.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @param string $check_name An unambiguous name of the check. Should normally be the calling __FUNCTION__.
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -296,21 +311,58 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * Readme should have a license.
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> function check_license() {
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- if ( empty( $this->readme->license ) ) {
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ if ( empty( $this->readme->license ) && empty( $this->headers->License ) ) {
</ins><span class="cx" style="display: block; padding: 0 10px"> $this->record_result( __FUNCTION__,
</span><span class="cx" style="display: block; padding: 0 10px"> 'warning',
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- __( 'Missing license in readme.txt.', 'wporg-plugins' )
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ __( 'No plugin license was found.', 'wporg-plugins' )
</ins><span class="cx" style="display: block; padding: 0 10px"> );
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- } else {
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ } elseif ( !empty( $this->readme->license ) ) {
</ins><span class="cx" style="display: block; padding: 0 10px"> $this->record_result( __FUNCTION__,
</span><span class="cx" style="display: block; padding: 0 10px"> 'info',
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- __( 'Found a license in readme.txt.', 'wporg-plugins' ),
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ sprintf( __( 'Found a license in readme.txt: %s.', 'wporg-plugins' ), $this->readme->license ),
</ins><span class="cx" style="display: block; padding: 0 10px"> $this->readme->license
</span><span class="cx" style="display: block; padding: 0 10px"> );
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ } elseif ( !empty( $this->headers->License ) ) {
+ $this->record_result( __FUNCTION__,
+ 'info',
+ sprintf( __( 'Found a license in plugin headers: %s.', 'wporg-plugins' ), $this->headers->License ),
+ $this->headers->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">
</span><span class="cx" style="display: block; padding: 0 10px"> /**
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * Must have plugin headers.
+ */
+ function check_plugin_headers() {
+ if ( empty( $this->headers ) ) {
+ $this->record_result( __FUNCTION__,
+ 'error',
+ __( 'Missing plugin headers. Is this a WordPress plugin?', 'wporg-plugins' )
+ );
+ }
+ }
+
+ /**
+ * Should have the 'block' tag.
+ */
+ function check_block_tag() {
+ if ( empty( $this->readme->tags ) || !in_array( 'block', array_map( 'strtolower', $this->readme_tags ) ) ) {
+ $this->record_result( __FUNCTION__,
+ 'warning',
+ __( 'No block tag found in readme.txt.', 'wporg-plugins' ),
+ $this->readme->tags
+ );
+ } else {
+ $this->record_result( __FUNCTION__,
+ 'info',
+ __( 'Found a block tag in readme.txt.', 'wporg-plugins' ),
+ $this->readme->tags
+ );
+ }
+ }
+
+ /**
</ins><span class="cx" style="display: block; padding: 0 10px"> * Does the plugin have a block name that already exists in the DB?
</span><span class="cx" style="display: block; padding: 0 10px"> * Note that this isn't a blocker if we're re-running checks on a plugin that has already been uploaded, since it will match with itself.
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -357,7 +409,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> );
</span><span class="cx" style="display: block; padding: 0 10px"> } else {
</span><span class="cx" style="display: block; padding: 0 10px"> $this->record_result( __FUNCTION__,
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- 'info',
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ ( count( $this->blocks ) < 5 ? 'info' : 'warning' ), // 5+ blocks suggests it's probably not a block plugin
</ins><span class="cx" style="display: block; padding: 0 10px"> sprintf( _n( 'Found %d block.', 'Found %d blocks.', count( $this->blocks ), 'wporg-plugins' ), count( $this->blocks ) ),
</span><span class="cx" style="display: block; padding: 0 10px"> array_keys( $this->blocks )
</span><span class="cx" style="display: block; padding: 0 10px"> );
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -504,4 +556,60 @@
</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">+
+ /**
+ * Does it have an index.asset.php file generate by the create block scripts?
+ */
+ function check_asset_php_file() {
+ $count = 0;
+ foreach ( $this->asset_php_files as $file ) {
+ $contents = file_get_contents( $file );
+ if ( false !== strpos( $contents, '<?php return array(' ) )
+ ++ $count;
+ }
+
+ if ( 1 === $count ) {
+ $this->record_result( __FUNCTION__,
+ 'info',
+ sprintf( __( 'PHP asset file found: %s.', 'wporg-plugins' ), $this->relative_filename( $file ) ),
+ $this->relative_filename( $file )
+ );
+ } elseif ( $count > 1 ) {
+ $this->record_result( __FUNCTION__,
+ 'warning',
+ sprintf( __( 'Found %s PHP asset files.', 'wporg-plugins' ), $count ),
+ array_map( array( $this, relative_filename ), $this->asset_php_files )
+ );
+ }
+ }
+
+ /**
+ * Does it have a lot of PHP code?
+ */
+ function check_php_size() {
+ $php_files = Filesystem::list_files( $this->path_to_plugin, true, '!\.php$!i' );
+ $total_size = 0;
+ foreach ( $php_files as $file ) {
+ $total_size += filesize( $file );
+ }
+ if ( $total_size > 50 * KB_IN_BYTES ) {
+ $this->record_result( __FUNCTION__,
+ 'error',
+ sprintf( __( 'Found %s of PHP code. Please submit PHP plugins to the plugin directory.', 'wporg-plugins' ), size_format( $total_size ) ),
+ $total_size
+ );
+ } elseif ( $total_size > 10 * KB_IN_BYTES ) {
+ $this->record_result( __FUNCTION__,
+ 'warning',
+ sprintf( __( 'Found %s of PHP code. This might not be a block plugin.', 'wporg-plugins' ), size_format( $total_size ) ),
+ $total_size
+ );
+ } else {
+ $this->record_result( __FUNCTION__,
+ 'info',
+ sprintf( __( 'Found %s of PHP code. Thanks for keeping it minimal!', 'wporg-plugins' ), size_format( $total_size ) ),
+ $total_size
+ );
+ }
+ }
</ins><span class="cx" style="display: block; padding: 0 10px"> }
</span></span></pre>
</div>
</div>
</body>
</html>