Changeset 44973 for trunk/src/wp-admin/includes/plugin.php

Timestamp:

03/21/2019 09:52:07 PM (6 years ago)

Author:

flixos90

Message:

Bootstrap/Load: Introduce a recovery mode for fixing fatal errors.

Using the new fatal handler introduced in [44962], an email is sent to the admin when a fatal error occurs. This email includes a secret link to enter recovery mode. When clicked, the link will be validated and on success a cookie will be placed on the client, enabling recovery mode for that user. This functionality is executed early before plugins and themes are loaded, in order to be unaffected by potential fatal errors these might be causing.

When in recovery mode, broken plugins and themes will be paused for that client, so that they are able to access the admin backend despite of these errors. They are notified about the broken extensions and the errors caused, and can then decide whether they would like to temporarily deactivate the extension or fix the problem and resume the extension.

A link in the admin bar allows the client to exit recovery mode.

Props timothyblynjacobs, afragen, flixos90, nerrad, miss_jwo, schlessera, spacedmonkey, swissspidy.
Fixes #46130, #44458.

File:

• trunk/src/wp-admin/includes/plugin.php (modified) (2 diffs)

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

@@ -469 +469 @@
 function _get_dropins() {
     $dropins = array(
-        'advanced-cache.php' => array( __( 'Advanced caching plugin.' ), 'WP_CACHE' ), // WP_CACHE
-        'db.php'             => array( __( 'Custom database class.' ), true ), // auto on load
-        'db-error.php'       => array( __( 'Custom database error message.' ), true ), // auto on error
-        'install.php'        => array( __( 'Custom installation script.' ), true ), // auto on installation
-        'maintenance.php'    => array( __( 'Custom maintenance message.' ), true ), // auto on maintenance
-        'object-cache.php'   => array( __( 'External object cache.' ), true ), // auto on load
+        'advanced-cache.php'      => array( __( 'Advanced caching plugin.' ), 'WP_CACHE' ), // WP_CACHE
+        'db.php'                  => array( __( 'Custom database class.' ), true ), // auto on load
+        'db-error.php'            => array( __( 'Custom database error message.' ), true ), // auto on error
+        'install.php'             => array( __( 'Custom installation script.' ), true ), // auto on installation
+        'maintenance.php'         => array( __( 'Custom maintenance message.' ), true ), // auto on maintenance
+        'object-cache.php'        => array( __( 'External object cache.' ), true ), // auto on load
+        'php-error.php'           => array( __( 'Custom PHP error message.' ), true ), // auto on error
+        'fatal-error-handler.php' => array( __( 'Custom PHP fatal error handler.' ), true ), // auto on error
     );
 
@@ -2102 +2104 @@
     WP_Privacy_Policy_Content::add( $plugin_name, $policy_text );
 }
+
+/**
+ * Determines whether a plugin is technically active but was paused while
+ * loading.
+ *
+ * For more information on this and similar theme functions, check out
+ * the {@link https://developer.wordpress.org/themes/basics/conditional-tags/
+ * Conditional Tags} article in the Theme Developer Handbook.
+ *
+ * @since 5.2.0
+ *
+ * @param string $plugin Path to the plugin file relative to the plugins directory.
+ * @return bool True, if in the list of paused plugins. False, not in the list.
+ */
+function is_plugin_paused( $plugin ) {
+    if ( ! isset( $GLOBALS['_paused_plugins'] ) ) {
+        return false;
+    }
+
+    if ( ! is_plugin_active( $plugin ) ) {
+        return false;
+    }
+
+    list( $plugin ) = explode( '/', $plugin );
+
+    return array_key_exists( $plugin, $GLOBALS['_paused_plugins'] );
+}
+
+/**
+ * Gets the error that was recorded for a paused plugin.
+ *
+ * @since 5.2.0
+ *
+ * @param string $plugin Path to the plugin file relative to the plugins
+ *                       directory.
+ * @return array|false Array of error information as it was returned by
+ *                     `error_get_last()`, or false if none was recorded.
+ */
+function wp_get_plugin_error( $plugin ) {
+    if ( ! isset( $GLOBALS['_paused_plugins'] ) ) {
+        return false;
+    }
+
+    list( $plugin ) = explode( '/', $plugin );
+
+    if ( ! array_key_exists( $plugin, $GLOBALS['_paused_plugins'] ) ) {
+        return false;
+    }
+
+    return $GLOBALS['_paused_plugins'][ $plugin ];
+}
+
+/**
+ * Tries to resume a single plugin.
+ *
+ * If a redirect was provided, we first ensure the plugin does not throw fatal
+ * errors anymore.
+ *
+ * The way it works is by setting the redirection to the error before trying to
+ * include the plugin file. If the plugin fails, then the redirection will not
+ * be overwritten with the success message and the plugin will not be resumed.
+ *
+ * @since 5.2.0
+ *
+ * @param string $plugin       Single plugin to resume.
+ * @param string $redirect     Optional. URL to redirect to. Default empty string.
+ * @return bool|WP_Error True on success, false if `$plugin` was not paused,
+ *                       `WP_Error` on failure.
+ */
+function resume_plugin( $plugin, $redirect = '' ) {
+    /*
+     * We'll override this later if the plugin could be resumed without
+     * creating a fatal error.
+     */
+    if ( ! empty( $redirect ) ) {
+        wp_redirect(
+            add_query_arg(
+                '_error_nonce',
+                wp_create_nonce( 'plugin-resume-error_' . $plugin ),
+                $redirect
+            )
+        );
+
+        // Load the plugin to test whether it throws a fatal error.
+        ob_start();
+        plugin_sandbox_scrape( $plugin );
+        ob_clean();
+    }
+
+    list( $extension ) = explode( '/', $plugin );
+
+    $result = wp_paused_plugins()->delete( $extension );
+
+    if ( ! $result ) {
+        return new WP_Error(
+            'could_not_resume_plugin',
+            __( 'Could not resume the plugin.' )
+        );
+    }
+
+    return true;
+}
+
+/**
+ * Renders an admin notice in case some plugins have been paused due to errors.
+ *
+ * @since 5.2.0
+ */
+function paused_plugins_notice() {
+    if ( 'plugins.php' === $GLOBALS['pagenow'] ) {
+        return;
+    }
+
+    if ( ! current_user_can( 'resume_plugins' ) ) {
+        return;
+    }
+
+    if ( ! isset( $GLOBALS['_paused_plugins'] ) || empty( $GLOBALS['_paused_plugins'] ) ) {
+        return;
+    }
+
+    printf(
+        '<div class="notice notice-error"><p><strong>%s</strong><br>%s</p><p><a href="%s">%s</a></p></div>',
+        __( 'One or more plugins failed to load properly.' ),
+        __( 'You can find more details and make changes on the Plugins screen.' ),
+        esc_url( admin_url( 'plugins.php?plugin_status=paused' ) ),
+        __( 'Go to the Plugins screen' )
+    );
+}