Fail gracefully when errors are detected

[christianwach]

Overview

Rewrites the error checking that the WordPress plugin performs and fails gracefully instead of throwing fatal errors and making WordPress inoperable. Introduces a "CiviCRM Troubleshooting" page to help diagnose and fix problems.

Before

When the PHP version was less than the required version, CiviCRM would call wp_die() and make WordPress inoperable. Other error checking during initialize was either never performed or never acted upon.

After

New framework for handling errors that provides a configurable "CiviCRM Troubleshooting" page to help diagnose and fix problems when they are encountered.

The plugin header Requires PHP: parameter prevents installation when an insufficient PHP version is detected. However, this does not handle the same situation after a CiviCRM upgrade. This Troubleshooting page is now shown instead of CiviCRM's admin UI:

It's more difficult to handle broken file systems - but, where possible, the following Troubleshooting page is now shown instead of CiviCRM's admin UI. (Try renaming civicrm/CRM/Core/Config.php to civicrm/CRM/Core/Config.php.bak to see this page)

Whilst not complete in its coverage of possible errors, this code can be developed to be more comprehensive in future. The major improvement is that WordPress does not stop functioning whilst problems are attended to.

[christianwach]

Hmm, not sure why this is failing - civilint passes and I don't know what No report files were found. Configuration error? means. @seamuslee001 Is this a problem with Jenkins?

[seamuslee001]

@christianwach

===============================[ php -l ]===============================
PHP Parse error:  syntax error, unexpected ')' in assets/templates/metaboxes/metabox.error.help.php on line 26

Parse error: syntax error, unexpected ')' in assets/templates/metaboxes/metabox.error.help.php on line 26

Errors parsing assets/templates/metaboxes/metabox.error.help.php
===============================[ phpcs  ]===============================

[seamuslee001]

Jenkins re test this please

[kcristiano]

@christianwach I have a server to test with multiple obsolete php versions. The code looks good - once the linting error is updated and the file name question is taken care of I can test.

Thanks for this it's a great improvement

[christianwach]

Jenkins re test this please

[seamuslee001]

@christianwach now civilint finds these issues https://test.civicrm.org/job/CiviCRM-WordPress-PR/180/checkstyleResult/new/

[christianwach]

@seamuslee001 Oh my. There must be something screwy with my civilint then grimaces.

[christianwach]

Jenkins re test this please

[christianwach]

Ah dammit, going to have to go through all the files individually it seems.

[kcristiano]

@christianwach Thanks for this.

On an r-run with the Nightly tarball we are trapped as you detailed. No way out at all as the code need php 7.2+ and all we get is an error screen.

Applying the patch brings us to an info page and we do not crash the site, the admin.

Upgrade php, reload and the upgrader works as expected.