<!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>[41560] trunk/src/wp-admin: Plugin Editor: Improve reliability of detecting PHP fatal errors when editing an active plugin.</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 { 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="https://core.trac.wordpress.org/changeset/41560">41560</a><script type="application/ld+json">{"@context":"http://schema.org","@type":"EmailMessage","description":"Review this Commit","action":{"@type":"ViewAction","url":"https://core.trac.wordpress.org/changeset/41560","name":"Review Commit"}}</script></dd>
<dt style="float: left; width: 6em; font-weight: bold">Author</dt> <dd>westonruter</dd>
<dt style="float: left; width: 6em; font-weight: bold">Date</dt> <dd>2017-09-22 01:35:09 +0000 (Fri, 22 Sep 2017)</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 Editor: Improve reliability of detecting PHP fatal errors when editing an active plugin.
* Invalidate PHP opcache after file is updated to ensure `include` will ''include'' the written changes.
* Define `WP_ADMIN` when activating plugin in sandbox so plugin code targeting admin will be loaded.
* Do actions that get triggered when loading the admin to ensure plugin code runs that could cause errors on plugin editor screen (and lock out access).
* Fix ability to re-activate a plugin after editing a PHP file other than the main plugin file, and ensure PHP fatal error will be displayed in such cases.
* Consolidate duplicated code into `plugin_sandbox_scrape()` and re-use in `activate_plugin()`.
* Show an error notice instead of a success notice when a file is updated but a plugin was deactivated due to a fatal error.
* Update style of warning when editing an active plugin to be styled as an actual warning notice.
See <a href="https://core.trac.wordpress.org/ticket/12423">#12423</a>, <a href="https://core.trac.wordpress.org/ticket/21622">#21622</a>.
Fixes <a href="https://core.trac.wordpress.org/ticket/39766">#39766</a>.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunksrcwpadmincsscommoncss">trunk/src/wp-admin/css/common.css</a></li>
<li><a href="#trunksrcwpadminincludespluginphp">trunk/src/wp-admin/includes/plugin.php</a></li>
<li><a href="#trunksrcwpadminplugineditorphp">trunk/src/wp-admin/plugin-editor.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunksrcwpadmincsscommoncss"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/src/wp-admin/css/common.css</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-admin/css/common.css 2017-09-21 23:32:25 UTC (rev 41559)
+++ trunk/src/wp-admin/css/common.css 2017-09-22 01:35:09 UTC (rev 41560)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -2203,6 +2203,14 @@
</span><span class="cx" style="display: block; padding: 0 10px"> #template > div {
</span><span class="cx" style="display: block; padding: 0 10px"> margin-right: 190px;
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+#template .active-plugin-edit-warning {
+ margin-top: 1em;
+ margin-right: 30%;
+ margin-right: calc( 184px + 3% );
+}
+#template .active-plugin-edit-warning p {
+ width: auto;
+}
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> .metabox-holder .stuffbox > h3, /* Back-compat for pre-4.4 */
</span><span class="cx" style="display: block; padding: 0 10px"> .metabox-holder .postbox > h3, /* Back-compat for pre-4.4 */
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -3609,9 +3617,10 @@
</span><span class="cx" style="display: block; padding: 0 10px"> margin-top: -5px;
</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">- #template > div {
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ #template > div,
+ #template .active-plugin-edit-warning {
</ins><span class="cx" style="display: block; padding: 0 10px"> float: none;
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- margin: 0;
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ margin: 1em 0;
</ins><span class="cx" style="display: block; padding: 0 10px"> width: auto;
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span></span></pre></div>
<a id="trunksrcwpadminincludespluginphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/src/wp-admin/includes/plugin.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-admin/includes/plugin.php 2017-09-21 23:32:25 UTC (rev 41559)
+++ trunk/src/wp-admin/includes/plugin.php 2017-09-22 01:35:09 UTC (rev 41560)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -555,11 +555,9 @@
</span><span class="cx" style="display: block; padding: 0 10px"> if ( !empty($redirect) )
</span><span class="cx" style="display: block; padding: 0 10px"> wp_redirect(add_query_arg('_error_nonce', wp_create_nonce('plugin-activation-error_' . $plugin), $redirect)); // we'll override this later if the plugin can be included without fatal error
</span><span class="cx" style="display: block; padding: 0 10px"> ob_start();
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- wp_register_plugin_realpath( WP_PLUGIN_DIR . '/' . $plugin );
- $_wp_plugin_file = $plugin;
- include_once( WP_PLUGIN_DIR . '/' . $plugin );
- $plugin = $_wp_plugin_file; // Avoid stomping of the $plugin variable in a plugin.
</del><span class="cx" style="display: block; padding: 0 10px">
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ plugin_sandbox_scrape( $plugin );
+
</ins><span class="cx" style="display: block; padding: 0 10px"> if ( ! $silent ) {
</span><span class="cx" style="display: block; padding: 0 10px"> /**
</span><span class="cx" style="display: block; padding: 0 10px"> * Fires before a plugin is activated.
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1881,9 +1879,42 @@
</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><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @param string $plugin
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * Simulate loading the WordPress admin with a given plugin active to attempt to generate errors.
+ *
+ * Actions are re-triggered in the WP bootstrap process for the WP Admin, and the WP_ADMIN constant is defined.
+ *
+ * @since 3.0.0
+ * @since 4.4.0 Function was moved into the `wp-admin/includes/plugin.php` file.
+ * @since 4.9.0 Add defining of WP_ADMIN and triggering admin WP bootstrap actions.
+ *
+ * @global array $wp_actions
+ * @param string $plugin Plugin file to load.
</ins><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> function plugin_sandbox_scrape( $plugin ) {
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ global $wp_actions;
</ins><span class="cx" style="display: block; padding: 0 10px"> wp_register_plugin_realpath( WP_PLUGIN_DIR . '/' . $plugin );
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+
+ if ( ! defined( 'WP_ADMIN' ) ) {
+ define( 'WP_ADMIN', true );
+ }
+
+ $tested_actions = array(
+ 'plugins_loaded' => array(),
+ 'setup_theme' => array(),
+ 'after_setup_theme' => array(),
+ 'init' => array(),
+ 'wp_loaded' => array(),
+ 'admin_init' => array(),
+ );
+ $old_wp_actions = $wp_actions;
+ array_map( 'remove_all_actions', array_keys( $tested_actions ) );
+
</ins><span class="cx" style="display: block; padding: 0 10px"> include( WP_PLUGIN_DIR . '/' . $plugin );
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+
+ // Trigger key actions that are done on the plugin editor to cause the relevant plugin hooks to fire and potentially cause errors.
+ foreach ( $tested_actions as $action => $args ) {
+ do_action_ref_array( $action, $args );
+ }
+
+ $wp_actions = $old_wp_actions; // Restore actions.
</ins><span class="cx" style="display: block; padding: 0 10px"> }
</span></span></pre></div>
<a id="trunksrcwpadminplugineditorphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/src/wp-admin/plugin-editor.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-admin/plugin-editor.php 2017-09-21 23:32:25 UTC (rev 41559)
+++ trunk/src/wp-admin/plugin-editor.php 2017-09-22 01:35:09 UTC (rev 41560)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -46,7 +46,20 @@
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> if ( empty( $plugin ) ) {
</span><span class="cx" style="display: block; padding: 0 10px"> if ( $file ) {
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $plugin = $file;
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+
+ // Locate the plugin for a given plugin file being edited.
+ $file_dirname = dirname( $file );
+ foreach ( array_keys( $plugins ) as $plugin_candidate ) {
+ if ( $plugin_candidate === $file || ( '.' !== $file_dirname && dirname( $plugin_candidate ) === $file_dirname ) ) {
+ $plugin = $plugin_candidate;
+ break;
+ }
+ }
+
+ // Fallback to the file as the plugin.
+ if ( empty( $plugin ) ) {
+ $plugin = $file;
+ }
</ins><span class="cx" style="display: block; padding: 0 10px"> } else {
</span><span class="cx" style="display: block; padding: 0 10px"> $plugin = array_keys( $plugins );
</span><span class="cx" style="display: block; padding: 0 10px"> $plugin = $plugin[0];
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -72,6 +85,10 @@
</span><span class="cx" style="display: block; padding: 0 10px"> fwrite($f, $newcontent);
</span><span class="cx" style="display: block; padding: 0 10px"> fclose($f);
</span><span class="cx" style="display: block; padding: 0 10px">
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ if ( preg_match( '/\.php$/', $real_file ) && function_exists( 'opcache_invalidate' ) ) {
+ opcache_invalidate( $real_file, true );
+ }
+
</ins><span class="cx" style="display: block; padding: 0 10px"> $network_wide = is_plugin_active_for_network( $file );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> // Deactivate so we can test it.
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -220,12 +237,12 @@
</span><span class="cx" style="display: block; padding: 0 10px"> <?php if (isset($_GET['a'])) : ?>
</span><span class="cx" style="display: block; padding: 0 10px"> <div id="message" class="updated notice is-dismissible"><p><?php _e('File edited successfully.') ?></p></div>
</span><span class="cx" style="display: block; padding: 0 10px"> <?php elseif (isset($_GET['phperror'])) : ?>
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- <div id="message" class="updated"><p><?php _e('This plugin has been deactivated because your changes resulted in a <strong>fatal error</strong>.') ?></p>
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ <div id="message" class="notice notice-error"><p><?php _e( 'This plugin has been deactivated because your changes resulted in a <strong>fatal error</strong>.' ); ?></p>
</ins><span class="cx" style="display: block; padding: 0 10px"> <?php
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- if ( wp_verify_nonce( $_GET['_error_nonce'], 'plugin-activation-error_' . $file ) ) {
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ if ( wp_verify_nonce( $_GET['_error_nonce'], 'plugin-activation-error_' . $plugin ) ) {
</ins><span class="cx" style="display: block; padding: 0 10px"> $iframe_url = add_query_arg( array(
</span><span class="cx" style="display: block; padding: 0 10px"> 'action' => 'error_scrape',
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- 'plugin' => urlencode( $file ),
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ 'plugin' => urlencode( $plugin ),
</ins><span class="cx" style="display: block; padding: 0 10px"> '_wpnonce' => urlencode( $_GET['_error_nonce'] ),
</span><span class="cx" style="display: block; padding: 0 10px"> ), admin_url( 'plugins.php' ) );
</span><span class="cx" style="display: block; padding: 0 10px"> ?>
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -315,7 +332,9 @@
</span><span class="cx" style="display: block; padding: 0 10px"> <?php endif; ?>
</span><span class="cx" style="display: block; padding: 0 10px"> <?php if ( is_writeable($real_file) ) : ?>
</span><span class="cx" style="display: block; padding: 0 10px"> <?php if ( in_array( $plugin, (array) get_option( 'active_plugins', array() ) ) ) { ?>
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- <p><?php _e('<strong>Warning:</strong> Making changes to active plugins is not recommended. If your changes cause a fatal error, the plugin will be automatically deactivated.'); ?></p>
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ <div class="notice notice-warning inline active-plugin-edit-warning">
+ <p><?php _e('<strong>Warning:</strong> Making changes to active plugins is not recommended. If your changes cause a fatal error, the plugin will be automatically deactivated.'); ?></p>
+ </div>
</ins><span class="cx" style="display: block; padding: 0 10px"> <?php } ?>
</span><span class="cx" style="display: block; padding: 0 10px"> <p class="submit">
</span><span class="cx" style="display: block; padding: 0 10px"> <?php
</span></span></pre>
</div>
</div>
</body>
</html>