<!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>[10089] sites/trunk/wordpress.org/public_html/wp-content/plugins/plugin-directory: Plugin directory: catch known problem PHP function calls in block validator.</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/10089">10089</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/10089","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-22 05:00:49 +0000 (Wed, 22 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: catch known problem PHP function calls in block validator.
Some PHP calls are likely indicators of a plugin that is not compatible with the Block Directory. This will produce a warning or error if they are found in a plugin.
See <a href="http://meta.trac.wordpress.org/ticket/5303">#5303</a>.</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>
<li><a href="#sitestrunkwordpressorgpublic_htmlwpcontentpluginsplugindirectoryshortcodesclassblockvalidatorphp">sites/trunk/wordpress.org/public_html/wp-content/plugins/plugin-directory/shortcodes/class-block-validator.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-22 03:06:25 UTC (rev 10088)
+++ sites/trunk/wordpress.org/public_html/wp-content/plugins/plugin-directory/cli/class-block-plugin-checker.php 2020-07-22 05:00:49 UTC (rev 10089)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -38,6 +38,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> protected $block_json_validation = array();
</span><span class="cx" style="display: block; padding: 0 10px"> protected $block_assets = array();
</span><span class="cx" style="display: block; padding: 0 10px"> protected $block_scripts = array();
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ protected $php_function_calls = array();
</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"> * Constructor.
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -264,6 +265,8 @@
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> $this->block_assets = $this->find_block_assets( $this->path_to_plugin );
</span><span class="cx" style="display: block; padding: 0 10px"> $this->block_scripts = $this->find_block_scripts( $this->path_to_plugin );
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+
+ $this->php_function_calls = $this->find_php_functions( $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">@@ -364,6 +367,54 @@
</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">+ * Return a list of functions called in a given PHP file.
+ * This is not perfect, and will miss some.
+ *
+ * @param string $file Path to a PHP file.
+ * @return array A list of functions found, in (function, line, file) form.
+ */
+ public static function find_called_functions_in_file($file) {
+ $source = file_get_contents($file);
+ $tokens = token_get_all($source, TOKEN_PARSE);
+
+ $function_calls = array();
+ $context = array();
+
+ foreach($tokens as $token) {
+ if ( T_STRING === $token[0] ) {
+ $context[] = $token;
+ } elseif ( '(' === $token[0] ) {
+
+ while ( $last = array_pop( $context ) ) {
+ if ( T_STRING === $last[0] && function_exists( $last[1] ) ) {
+ $function_calls[] = array( $last[1], $last[2], $file );
+ }
+ }
+ $context[] = array();
+ } elseif ( ';' === $token[0] || '}' === $token[0] || T_COMMENT === $token[0] ) {
+ $context = array();
+ } elseif ( T_WHITESPACE === $token[0] ) {
+ $context[] = ' ';
+ } else {
+ $context[] = $token[0];
+ }
+ }
+
+ return $function_calls;
+ }
+
+ public function find_php_functions( $base_dir ) {
+ $all_calls = array();
+
+ foreach ( Filesystem::list_files( $base_dir, true, '!\.php$!i' ) as $filename ) {
+ $php_calls = self::find_called_functions_in_file( $filename );
+ $all_calls += $php_calls;
+ }
+
+ return $all_calls;
+ }
+
+ /**
</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">@@ -788,4 +839,38 @@
</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 make PHP function calls that shouldn't be in a block plugin?
+ */
+ function check_php_function_calls() {
+ $warning_functions = array(
+ 'wp_localize_script',
+ );
+ $error_functions = array(
+ 'header',
+ 'wp_redirect',
+ 'wp_safe_redirect',
+ );
+
+ foreach ( $this->php_function_calls as $call ) {
+ if ( in_array( $call[0], $warning_functions ) ) {
+ $this->record_result(
+ __FUNCTION__,
+ 'warning',
+ sprintf( __( 'Found PHP call <a href="%s">%s</a>. This may cause problems.', 'wporg-plugins' ), $this->get_browser_url( $call[2] ) . '#L' . $call[1], $call[0] . '()' ),
+ $call
+ );
+ } elseif ( in_array( $call[0], $error_functions ) ) {
+ $this->record_result(
+ __FUNCTION__,
+ 'error',
+ sprintf( __( 'Found PHP call <a href="%s">%s</a>. This is likely to prevent your plugin from working as expected.', 'wporg-plugins' ), $this->get_browser_url( $call[2] ) . '#L' . $call[1], $call[0] . '()' ),
+ $call
+ );
+ }
+
+ }
+
+ }
</ins><span class="cx" style="display: block; padding: 0 10px"> }
</span></span></pre></div>
<a id="sitestrunkwordpressorgpublic_htmlwpcontentpluginsplugindirectoryshortcodesclassblockvalidatorphp"></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/shortcodes/class-block-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/shortcodes/class-block-validator.php 2020-07-22 03:06:25 UTC (rev 10088)
+++ sites/trunk/wordpress.org/public_html/wp-content/plugins/plugin-directory/shortcodes/class-block-validator.php 2020-07-22 05:00:49 UTC (rev 10089)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -315,6 +315,8 @@
</span><span class="cx" style="display: block; padding: 0 10px"> ];
</span><span class="cx" style="display: block; padding: 0 10px"> case 'check_for_single_parent':
</span><span class="cx" style="display: block; padding: 0 10px"> return __( 'Block plugins should contain a single main block, which is added to the editor when the block is installed. If multiple blocks are used (ex: list items in a list block), the list items should set the `parent` property in their `block.json` file.', 'wporg-plugins' );
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ case 'check_php_function_calls':
+ return __( 'Block plugins should contain minimal PHP with no UI outside the editor. JavaScript should be used instead of PHP where possible.', 'wporg-plugins' );
</ins><span class="cx" style="display: block; padding: 0 10px"> // This is a special case, since multiple values may be collapsed.
</span><span class="cx" style="display: block; padding: 0 10px"> case 'check_block_json_is_valid':
</span><span class="cx" style="display: block; padding: 0 10px"> return false;
</span></span></pre>
</div>
</div>
</body>
</html>