Changeset 41805

Timestamp:

10/10/2017 05:26:53 AM (7 years ago)

Author:

westonruter

Message:

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 [41721].
See #21622.
Fixes #42102.

Location:

trunk/src

Files:

• wp-admin/includes/file.php (modified) (3 diffs)
• wp-admin/js/theme-plugin-editor.js (modified) (2 diffs)
• wp-includes/load.php (modified) (2 diffs)
• wp-includes/script-loader.php (modified) (1 diff)

trunk/src/wp-admin/includes/file.php

@@ -487 +487 @@
         );
 
-        $needle = "###### begin_scraped_error:$scrape_key ######";
+        // 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'] ) );
+        }
+
+        // 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 ######";
 
         // Attempt loopback request to editor to see if user just whitescreened themselves.
@@ -504 +516 @@
         }
         $url = add_query_arg( $scrape_params, $url );
-        $r = wp_remote_get( $url, compact( 'cookies', 'headers' ) );
+        $r = wp_remote_get( $url, compact( 'cookies', 'headers', 'timeout' ) );
         $body = wp_remote_retrieve_body( $r );
-        $error_position = strpos( $body, $needle );
+        $scrape_result_position = strpos( $body, $needle_start );
+
+        $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;
+            }
+        }
 
         // Try making request to homepage as well to see if visitors have been whitescreened.
-        if ( false === $error_position ) {
+        if ( true === $result ) {
             $url = home_url( '/' );
             $url = add_query_arg( $scrape_params, $url );
-            $r = wp_remote_get( $url, compact( 'cookies', 'headers' ) );
+            $r = wp_remote_get( $url, compact( 'cookies', 'headers', 'timeout' ) );
             $body = wp_remote_retrieve_body( $r );
-            $error_position = strpos( $body, $needle );
+            $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;
+                }
+            }
         }
 
         delete_transient( $transient );
 
-        if ( false !== $error_position ) {
+        if ( true !== $result ) {
+
+            // Roll-back file change.
             file_put_contents( $real_file, $previous_content );
             if ( function_exists( 'opcache_invalidate' ) ) {
@@ -525 +570 @@
             }
 
-            $error_output = trim( substr( $body, $error_position + strlen( $needle ) ) );
-            $error = json_decode( $error_output, true );
-            if ( ! isset( $error['message'] ) ) {
-                $message = $error_output;
+            if ( ! isset( $result['message'] ) ) {
+                $message = __( 'An unidentified error has occurred.' );
             } else {
-                $message = $error['message'];
-                unset( $error['message'] );
+                $message = $result['message'];
+                unset( $result['message'] );
             }
-            return new WP_Error( 'php_error', $message, $error );
+            return new WP_Error( 'php_error', $message, $result );
         }
     }

trunk/src/wp-admin/js/theme-plugin-editor.js

@@ -14 +14 @@
                 plural: ''
             },
-            saveAlert: ''
+            saveAlert: '',
+            saveError: ''
         },
         codeEditor: {},
@@ -162 +163 @@
             var notice = $.extend(
                 {
-                    code: 'save_error'
+                    code: 'save_error',
+                    message: component.l10n.saveError
                 },
                 response,

trunk/src/wp-includes/load.php

@@ -1127 +1127 @@
 
     if ( get_transient( 'scrape_key_' . $key ) !== $nonce ) {
-        echo "###### begin_scraped_error:$key ######";
+        echo "###### wp_scraping_result_start:$key ######";
         echo wp_json_encode( array(
             'code' => 'scrape_nonce_failure',
             'message' => __( 'Scrape nonce check failed. Please try again.' ),
         ) );
+        echo "###### wp_scraping_result_end:$key ######";
         die();
     }
@@ -1146 +1147 @@
 function wp_finalize_scraping_edited_file_errors( $scrape_key ) {
     $error = error_get_last();
-    if ( empty( $error ) ) {
-        return;
-    }
-    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 );
-}
+    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 );
+    }
+    echo "\n###### wp_scraping_result_end:$scrape_key ######\n";
+}

trunk/src/wp-includes/script-loader.php

@@ -473 +473 @@
     did_action( 'init' ) && $scripts->add_inline_script( 'wp-theme-plugin-editor', sprintf( 'wp.themePluginEditor.l10n = %s;', wp_json_encode( array(
         'saveAlert' => __( 'The changes you made will be lost if you navigate away from this page.' ),
+        '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.' ),
         'lintError' => wp_array_slice_assoc(
             /* translators: %d: error count */