<!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>[41805] trunk/src: File Editor: Increase robustness of fatal error checking when saving PHP file edits.</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/41805">41805</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/41805","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-10-10 05:26:53 +0000 (Tue, 10 Oct 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'>File Editor: Increase robustness of fatal error checking when saving PHP file edits.
* Increase PHP execution time limit prior to issuing loopback requests where are themselves given timeouts to ensure PHP file can be reverted.
* Output scrape messages on success and failure so that absence of either can also be flagged as an error condition.
* Forward browser's HTTP Basic Auth credentials in loopback requests to admin and home URL.
* Display more helpful message when loopback request fails.
Amends <a href="https://core.trac.wordpress.org/changeset/41721">[41721]</a>.
See <a href="https://core.trac.wordpress.org/ticket/21622">#21622</a>.
Fixes <a href="https://core.trac.wordpress.org/ticket/42102">#42102</a>.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunksrcwpadminincludesfilephp">trunk/src/wp-admin/includes/file.php</a></li>
<li><a href="#trunksrcwpadminjsthemeplugineditorjs">trunk/src/wp-admin/js/theme-plugin-editor.js</a></li>
<li><a href="#trunksrcwpincludesloadphp">trunk/src/wp-includes/load.php</a></li>
<li><a href="#trunksrcwpincludesscriptloaderphp">trunk/src/wp-includes/script-loader.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunksrcwpadminincludesfilephp"></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/file.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-admin/includes/file.php 2017-10-10 04:50:37 UTC (rev 41804)
+++ trunk/src/wp-admin/includes/file.php 2017-10-10 05:26:53 UTC (rev 41805)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -486,8 +486,20 @@
</span><span class="cx" style="display: block; padding: 0 10px"> 'Cache-Control' => 'no-cache',
</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">- $needle = "###### begin_scraped_error:$scrape_key ######";
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ // Include Basic auth in loopback requests.
+ if ( isset( $_SERVER['PHP_AUTH_USER'] ) && isset( $_SERVER['PHP_AUTH_PW'] ) ) {
+ $headers['Authorization'] = 'Basic ' . base64_encode( wp_unslash( $_SERVER['PHP_AUTH_USER'] ) . ':' . wp_unslash( $_SERVER['PHP_AUTH_PW'] ) );
+ }
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ // Make sure PHP process doesn't die before loopback requests complete.
+ @set_time_limit( 300 );
+
+ // Time to wait for loopback requests to finish.
+ $timeout = 100;
+
+ $needle_start = "###### wp_scraping_result_start:$scrape_key ######";
+ $needle_end = "###### wp_scraping_result_end:$scrape_key ######";
+
</ins><span class="cx" style="display: block; padding: 0 10px"> // Attempt loopback request to editor to see if user just whitescreened themselves.
</span><span class="cx" style="display: block; padding: 0 10px"> if ( $plugin ) {
</span><span class="cx" style="display: block; padding: 0 10px"> $url = add_query_arg( compact( 'plugin', 'file' ), admin_url( 'plugin-editor.php' ) );
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -503,36 +515,67 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $url = admin_url();
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px"> $url = add_query_arg( $scrape_params, $url );
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $r = wp_remote_get( $url, compact( 'cookies', 'headers' ) );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $r = wp_remote_get( $url, compact( 'cookies', 'headers', 'timeout' ) );
</ins><span class="cx" style="display: block; padding: 0 10px"> $body = wp_remote_retrieve_body( $r );
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $error_position = strpos( $body, $needle );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $scrape_result_position = strpos( $body, $needle_start );
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $loopback_request_failure = array(
+ 'code' => 'loopback_request_failed',
+ 'message' => __( 'Unable to communicate back with site to check for fatal errors, so the PHP change was reverted. You will need to upload your PHP file change by some other means, such as by using SFTP.' ),
+ );
+ $json_parse_failure = array(
+ 'code' => 'json_parse_error',
+ );
+
+ $result = null;
+ if ( false === $scrape_result_position ) {
+ $result = $loopback_request_failure;
+ } else {
+ $error_output = substr( $body, $scrape_result_position + strlen( $needle_start ) );
+ $error_output = substr( $error_output, 0, strpos( $error_output, $needle_end ) );
+ $result = json_decode( trim( $error_output ), true );
+ if ( empty( $result ) ) {
+ $result = $json_parse_failure;
+ }
+ }
+
</ins><span class="cx" style="display: block; padding: 0 10px"> // Try making request to homepage as well to see if visitors have been whitescreened.
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- if ( false === $error_position ) {
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ if ( true === $result ) {
</ins><span class="cx" style="display: block; padding: 0 10px"> $url = home_url( '/' );
</span><span class="cx" style="display: block; padding: 0 10px"> $url = add_query_arg( $scrape_params, $url );
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $r = wp_remote_get( $url, compact( 'cookies', 'headers' ) );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $r = wp_remote_get( $url, compact( 'cookies', 'headers', 'timeout' ) );
</ins><span class="cx" style="display: block; padding: 0 10px"> $body = wp_remote_retrieve_body( $r );
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $error_position = strpos( $body, $needle );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $scrape_result_position = strpos( $body, $needle_start );
+
+ if ( false === $scrape_result_position ) {
+ $result = $loopback_request_failure;
+ } else {
+ $error_output = substr( $body, $scrape_result_position + strlen( $needle_start ) );
+ $error_output = substr( $error_output, 0, strpos( $error_output, $needle_end ) );
+ $result = json_decode( trim( $error_output ), true );
+ if ( empty( $result ) ) {
+ $result = $json_parse_failure;
+ }
+ }
</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"> delete_transient( $transient );
</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 ( false !== $error_position ) {
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ if ( true !== $result ) {
+
+ // Roll-back file change.
</ins><span class="cx" style="display: block; padding: 0 10px"> file_put_contents( $real_file, $previous_content );
</span><span class="cx" style="display: block; padding: 0 10px"> if ( function_exists( 'opcache_invalidate' ) ) {
</span><span class="cx" style="display: block; padding: 0 10px"> opcache_invalidate( $real_file, 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">- $error_output = trim( substr( $body, $error_position + strlen( $needle ) ) );
- $error = json_decode( $error_output, true );
- if ( ! isset( $error['message'] ) ) {
- $message = $error_output;
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ if ( ! isset( $result['message'] ) ) {
+ $message = __( 'An unidentified error has occurred.' );
</ins><span class="cx" style="display: block; padding: 0 10px"> } else {
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $message = $error['message'];
- unset( $error['message'] );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $message = $result['message'];
+ unset( $result['message'] );
</ins><span class="cx" style="display: block; padding: 0 10px"> }
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- return new WP_Error( 'php_error', $message, $error );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ return new WP_Error( 'php_error', $message, $result );
</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></pre></div>
<a id="trunksrcwpadminjsthemeplugineditorjs"></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/js/theme-plugin-editor.js</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-admin/js/theme-plugin-editor.js 2017-10-10 04:50:37 UTC (rev 41804)
+++ trunk/src/wp-admin/js/theme-plugin-editor.js 2017-10-10 05:26:53 UTC (rev 41805)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -13,7 +13,8 @@
</span><span class="cx" style="display: block; padding: 0 10px"> singular: '',
</span><span class="cx" style="display: block; padding: 0 10px"> plural: ''
</span><span class="cx" style="display: block; padding: 0 10px"> },
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- saveAlert: ''
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ saveAlert: '',
+ saveError: ''
</ins><span class="cx" style="display: block; padding: 0 10px"> },
</span><span class="cx" style="display: block; padding: 0 10px"> codeEditor: {},
</span><span class="cx" style="display: block; padding: 0 10px"> instance: null,
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -161,7 +162,8 @@
</span><span class="cx" style="display: block; padding: 0 10px"> request.fail( function ( response ) {
</span><span class="cx" style="display: block; padding: 0 10px"> var notice = $.extend(
</span><span class="cx" style="display: block; padding: 0 10px"> {
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- code: 'save_error'
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ code: 'save_error',
+ message: component.l10n.saveError
</ins><span class="cx" style="display: block; padding: 0 10px"> },
</span><span class="cx" style="display: block; padding: 0 10px"> response,
</span><span class="cx" style="display: block; padding: 0 10px"> {
</span></span></pre></div>
<a id="trunksrcwpincludesloadphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/src/wp-includes/load.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-includes/load.php 2017-10-10 04:50:37 UTC (rev 41804)
+++ trunk/src/wp-includes/load.php 2017-10-10 05:26:53 UTC (rev 41805)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1126,11 +1126,12 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $nonce = wp_unslash( $_REQUEST['wp_scrape_nonce'] );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> if ( get_transient( 'scrape_key_' . $key ) !== $nonce ) {
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- echo "###### begin_scraped_error:$key ######";
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ echo "###### wp_scraping_result_start:$key ######";
</ins><span class="cx" style="display: block; padding: 0 10px"> echo wp_json_encode( array(
</span><span class="cx" style="display: block; padding: 0 10px"> 'code' => 'scrape_nonce_failure',
</span><span class="cx" style="display: block; padding: 0 10px"> 'message' => __( 'Scrape nonce check failed. Please try again.' ),
</span><span class="cx" style="display: block; padding: 0 10px"> ) );
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ echo "###### wp_scraping_result_end:$key ######";
</ins><span class="cx" style="display: block; padding: 0 10px"> die();
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px"> register_shutdown_function( 'wp_finalize_scraping_edited_file_errors', $key );
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1145,13 +1146,12 @@
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> function wp_finalize_scraping_edited_file_errors( $scrape_key ) {
</span><span class="cx" style="display: block; padding: 0 10px"> $error = error_get_last();
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- if ( empty( $error ) ) {
- return;
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ echo "\n###### wp_scraping_result_start:$scrape_key ######\n";
+ if ( ! empty( $error ) && in_array( $error['type'], array( E_CORE_ERROR, E_COMPILE_ERROR, E_ERROR, E_PARSE, E_USER_ERROR, E_RECOVERABLE_ERROR ), true ) ) {
+ $error = str_replace( ABSPATH, '', $error );
+ echo wp_json_encode( $error );
+ } else {
+ echo wp_json_encode( true );
</ins><span class="cx" style="display: block; padding: 0 10px"> }
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- if ( ! in_array( $error['type'], array( E_CORE_ERROR, E_COMPILE_ERROR, E_ERROR, E_PARSE, E_USER_ERROR, E_RECOVERABLE_ERROR ), true ) ) {
- return;
- }
- $error = str_replace( ABSPATH, '', $error );
- echo "###### begin_scraped_error:$scrape_key ######";
- echo wp_json_encode( $error );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ echo "\n###### wp_scraping_result_end:$scrape_key ######\n";
</ins><span class="cx" style="display: block; padding: 0 10px"> }
</span></span></pre></div>
<a id="trunksrcwpincludesscriptloaderphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/src/wp-includes/script-loader.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-includes/script-loader.php 2017-10-10 04:50:37 UTC (rev 41804)
+++ trunk/src/wp-includes/script-loader.php 2017-10-10 05:26:53 UTC (rev 41805)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -472,6 +472,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $scripts->add( 'wp-theme-plugin-editor', "/wp-admin/js/theme-plugin-editor$suffix.js", array( 'wp-util', 'jquery', 'jquery-ui-core', 'wp-a11y', 'underscore' ) );
</span><span class="cx" style="display: block; padding: 0 10px"> did_action( 'init' ) && $scripts->add_inline_script( 'wp-theme-plugin-editor', sprintf( 'wp.themePluginEditor.l10n = %s;', wp_json_encode( array(
</span><span class="cx" style="display: block; padding: 0 10px"> 'saveAlert' => __( 'The changes you made will be lost if you navigate away from this page.' ),
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ 'saveError' => __( 'Something went wrong. Your change may not have been saved. Please try again. There is also a chance that you may need to manually fix and upload the file over FTP.' ),
</ins><span class="cx" style="display: block; padding: 0 10px"> 'lintError' => wp_array_slice_assoc(
</span><span class="cx" style="display: block; padding: 0 10px"> /* translators: %d: error count */
</span><span class="cx" style="display: block; padding: 0 10px"> _n_noop( 'There is %d error which must be fixed before you can update this file.', 'There are %d errors which must be fixed before you can update this file.' ),
</span></span></pre>
</div>
</div>
</body>
</html>