| Current File : /home/digitaw/www/wp-content/plugins/the-events-calendar/common/src/Tribe/Admin/Troubleshooting.php |
<?php
/**
* Admin Troubleshooting for TEC plugins.
*
* @since 4.14.2
*
* @package Tribe\Admin
*/
namespace Tribe\Admin;
use \Tribe__Settings;
use \Tribe__Main;
use \Tribe__Admin__Helpers;
use \Tribe__Timezones as Timezones;
use \Tribe__Events__Google__Maps_API_Key;
/**
* Class Admin Troubleshooting.
*
* @since 4.14.2
*
* @package Tribe\Admin
*/
class Troubleshooting {
/**
* Defines the slug of the troubleshooting page in the WP admin menu item.
*
* @since 4.14.2
*
* @const string The troubleshooting menu slug.
*/
const MENU_SLUG = 'tec-troubleshooting';
/**
* The slug for the new admin page.
*
* @since 4.14.2
*
* @var string|null
*/
private $admin_page = null;
/**
* Class constructor.
*
* @since 4.14.2
*/
public function hook() {
add_action( 'admin_menu', [ $this, 'add_menu_page' ], 90 );
add_filter( 'admin_body_class', [ $this, 'admin_body_class' ] );
add_action( 'wp_before_admin_bar_render', [ $this, 'add_toolbar_item' ], 20 );
}
/**
* This method creates the troubleshooting page and adds it to the TEC menu.
*
* @since 4.14.2
*/
public function add_menu_page() {
if ( ! tribe( 'settings' )->should_setup_pages() ) {
return;
}
$page_title = esc_html__( 'Troubleshooting', 'tribe-common' );
$menu_title = esc_html__( 'Troubleshooting', 'tribe-common' );
$capability = $this->get_required_capability();
$where = tribe( 'settings' )->get_parent_slug();
$this->admin_page = add_submenu_page(
$where,
$page_title,
$menu_title,
$capability,
static::MENU_SLUG,
[
$this,
'do_menu_page',
]
);
}
/**
* Gets the required capability for the troubleshooting page.
*
* @since 4.14.2
*
* @return string The capability required for the troubleshooting page.
*/
public function get_required_capability() {
/**
* Allows third-party filtering of the capability required to see the Troubleshooting page.
*
* @since 4.14.2
*
* @param string $capability The capability we are using as the one required for the troubleshooting page.
* @param static $troubleshooting The current instance of the class that handles this page.
*/
$capability = apply_filters( 'tec_troubleshooting_capability', 'install_plugins', $this );
return $capability;
}
/**
* Hooked to admin_body_class to add a class for the troubleshooting page.
*
* @since 4.15.0
*
* @param string $classes A space-separated string of classes to be added to the body tag.
*
* @return string A space-separated string of classes to be added to the body tag.
*/
public function admin_body_class( $classes ) {
if ( ! $this->is_current_page() ) {
return $classes;
}
$classes .= ' tec-troubleshooting';
return $classes;
}
/**
* Adds the troubleshooting menu to the WP admin bar under events.
*
* @since 4.14.2
*/
public function add_toolbar_item() {
$capability = $this->get_required_capability();
if ( ! current_user_can( $capability ) ) {
return;
}
global $wp_admin_bar;
$wp_admin_bar->add_menu(
[
'id' => 'tec-troubleshooting',
'title' => esc_html__( 'Troubleshooting', 'tribe-common' ),
'href' => tribe( 'settings' )->get_url( [ 'page' => static::MENU_SLUG ] ),
'parent' => 'tribe-events-settings-group',
]
);
}
/**
* Checks if the current page is the troubleshooting page.
*
* @since 4.14.2
*
* @return boolean Returns true if the current page is the troubleshooting page.
*/
public function is_current_page() {
if ( ! tribe( 'settings' )->should_setup_pages() || ! did_action( 'admin_menu' ) ) {
return false;
}
if ( is_null( $this->admin_page ) ) {
_doing_it_wrong(
__FUNCTION__,
'Function was called before it is possible to accurately determine what the current page is.',
'4.5.6'
);
return false;
}
global $current_screen;
$troubleshooting_pages = [
'tribe_events_page_tec-troubleshooting',
'tickets_page_tec-tickets-troubleshooting',
];
return in_array( $current_screen->id, $troubleshooting_pages );
}
/**
* Renders the Troubleshooting page.
*
* @since 4.14.2
*/
public function do_menu_page() {
tribe_asset_enqueue( 'tribe-admin-help-page' );
$main = Tribe__Main::instance();
include_once Tribe__Main::instance()->plugin_path . 'src/admin-views/troubleshooting.php';
}
/**
* This method checks if there are any active issues that need to be flagged.
*
* @since 4.14.2
*
* @return boolean Returns true if there are any active issues.
*/
public function is_any_issue_active() {
$issues = $this->get_issues_found();
$active_issues = wp_list_pluck( $issues, 'active' );
return in_array( true, $active_issues );
}
/**
* Checks if any active TEC plugins require an update.
*
* @since 4.14.2
*
* @return boolean Returns true if any of the plugins require an update.
*/
public function is_any_tec_plugin_out_of_date() {
$current = get_site_transient( 'update_plugins' );
$plugins = [];
if ( defined( 'TRIBE_EVENTS_FILE' ) ) {
$plugins[] = TRIBE_EVENTS_FILE;
}
if ( defined( 'EVENTS_CALENDAR_PRO_FILE' ) ) {
$plugins[] = EVENTS_CALENDAR_PRO_FILE;
}
if ( defined( 'EVENT_TICKETS_PLUS_FILE' ) ) {
$plugins[] = EVENT_TICKETS_PLUS_FILE;
}
if ( defined( 'EVENTS_VIRTUAL_FILE' ) ) {
$plugins[] = EVENTS_VIRTUAL_FILE;
}
if ( defined( 'EVENT_TICKETS_MAIN_PLUGIN_FILE' ) ) {
$plugins[] = EVENT_TICKETS_MAIN_PLUGIN_FILE;
}
if ( defined( 'TRIBE_EVENTS_FILTERBAR_FILE' ) ) {
$plugins[] = TRIBE_EVENTS_FILTERBAR_FILE;
}
if ( defined( 'EVENTS_COMMUNITY_TICKETS_FILE' ) ) {
$plugins[] = EVENTS_COMMUNITY_TICKETS_FILE;
}
if ( defined( 'EVENTS_COMMUNITY_FILE' ) ) {
$plugins[] = EVENTS_COMMUNITY_FILE;
}
if ( defined( 'EVENTBRITE_PLUGIN_FILE' ) ) {
$plugins[] = EVENTBRITE_PLUGIN_FILE;
}
if ( defined( 'TRIBE_APM_FILE' ) ) {
$plugins[] = TRIBE_APM_FILE;
}
if ( defined( 'IMAGE_WIDGET_PLUS_DIR' ) ) {
$plugins[] = IMAGE_WIDGET_PLUS_DIR;
}
$plugins = array_map(
static function ( $file ) {
$file = \str_replace( WP_PLUGIN_DIR . '/', '', $file );
return $file;
},
$plugins
);
foreach ( $plugins as $file ) {
if ( ! isset( $current->response[ $file ] ) ) {
continue;
}
$response = $current->response[ $file ];
if ( ! empty( $response->new_version ) ) {
return true;
}
}
return false;
}
/**
* Checks if any of the issues defined are active.
*
* @since 4.14.2
*
* @param string $slug The slug of active issue.
*
* @return boolean Returns a boolean value for each issue depending on whether it is active or not.
*/
public function is_active_issue( $slug ) {
if ( 'timezone' === $slug ) {
return Timezones::is_utc_offset( Timezones::wp_timezone_string() );
}
if ( 'geolocation' === $slug && class_exists( 'Tribe__Events__Google__Maps_API_Key' ) ) {
$key = \tribe_get_option( 'google_maps_js_api_key', false );
return empty( $key ) || Tribe__Events__Google__Maps_API_Key::$default_api_key === $key;
}
if ( 'out-of-date' === $slug ) {
return $this->is_any_tec_plugin_out_of_date();
}
if ( 'php-version' === $slug ) {
return version_compare( PHP_VERSION, '8.0.0', '<' );
}
if ( 'php-timezone' === $slug ) {
$php_timezone = date_default_timezone_get();
return $php_timezone != 'UTC';
}
if ( 'caching' === $slug ) {
$intersection = $this->get_active_caching_plugins();
return ! empty( $intersection );
}
return false;
}
/**
* Displays issues found in the UI.
*
* @since 4.14.2
*
* @return array Array of issues that are displayed on the troubleshooting page.
*/
public function get_issues_found(): array {
return apply_filters(
'tec_help_troubleshooting_issues_found',
[
[
'title' => __( 'Site time zone uses UTC', 'tribe-common' ),
'description' => __( 'When using The Events Calendar, we highly recommend that you use a geographic timezone such as "America/Los_Angeles" and avoid using a UTC timezone offset such as “UTC+9”. Choosing a UTC timezone for your site or individual events may cause problems when importing events or with Daylight Saving Time. Go to your the General WordPress settings to adjust your site timezone.', 'tribe-common' ),
'more_info' => 'https://evnt.is/1ad3',
'resolve_text' => __( 'Adjust your timezone', 'tribe-common' ),
'fix' => '/wp-admin/options-general.php',
'active' => $this->is_active_issue( 'timezone' ),
],
[
'title' => __( 'Install max has been reached', 'tribe-common' ),
'description' => __( 'License keys can only be used on a limited number of sites, which varies depending on your license level. You\'ll need to remove the license from one or more other site\'s in order to use it on this one.', 'tribe-common' ),
'more_info' => 'https://evnt.is/1aqz',
'resolve_text' => __( 'Manage your licenses', 'tribe-common' ),
'fix' => 'https://evnt.is/1aq-',
'active' => $this->is_active_issue( 'install-max' ),
],
[
'title' => __( 'Default Google Maps API key', 'tribe-common' ),
'description' => __( 'The Events Calendar comes with an API key for basic maps functionality. If you’d like to use more advanced features like custom map pins, dynamic map loads, or Events Calendar Pro\'s Location Search and advanced Map View, you’ll need to get your own Google Maps API key and add it to Events > Settings > Integrations', 'tribe-common' ),
'more_info' => 'https://evnt.is/1aqx',
'resolve_text' => __( 'Enter a custom API key', 'tribe-common' ),
'fix' => '/wp-admin/edit.php?page=tec-events-settings&tab=addons&post_type=tribe_events#tribe-field-google_maps_js_api_key',
'active' => $this->is_active_issue( 'geolocation' ),
],
[
'title' => __( 'Plugin(s) are out of date', 'tribe-common' ),
'description' => __( 'It\'s important to use the most recent versions of our plugins so that you have access to the latest features, bug fixes, and security updates. Plugin functionality can be compromised if your site is running outdated or mis-matched versions.', 'tribe-common' ),
'more_info' => 'https://evnt.is/1aqy',
'resolve_text' => __( 'Check for updates', 'tribe-common' ),
'fix' => '/wp-admin/update-core.php',
'active' => $this->is_active_issue( 'out-of-date' ),
],
[
'title' => __( 'PHP version out of date', 'tribe-common' ),
'description' => __( 'The PHP version your site uses has reached its end of life of life on November 28, 2022. This means it no longer receives security updates or bug fixes. Users are encouraged to upgrade to newer versions of PHP to ensure continued support and security. Reach out to your hosting provider for assistance.', 'tribe-common' ),
'more_info' => 'https://evnt.is/tec-php-support',
'resolve_text' => false,
'fix' => false,
'active' => $this->is_active_issue( 'php-version' ),
],
[
'title' => __( 'Default PHP timezone is other than UTC', 'tribe-common' ),
'description' => __( 'The default PHP timezone of your server is set to something else than UTC. This can cause issues when displaying event times and time zones. We recommend you to set the default PHP time zone on your server to UTC. This is usually done with the `date.timezone` directive in the php.ini file.', 'tribe-common' ),
'more_info' => 'https://evnt.is/1aql',
'resolve_text' => false,
'fix' => false,
'active' => $this->is_active_issue( 'php-timezone' ),
],
[
/* translators: %s: The name of the caching plugin. */
'title' => sprintf( __( 'Caching plugin detected: %s', 'tribe-common' ), $this->get_active_caching_plugin_name() ),
'description' => __( 'Caching can improve your site performance and speed up your site. Check out our Caching Guide to help you set up caching with our plugins correctly.', 'tribe-common' ),
'more_info' => 'https://evnt.is/tec-and-caching',
'resolve_text' => false,
'fix' => false,
'active' => $this->is_active_issue( 'caching' ),
],
]
);
}
/**
* Defines common troubleshooting issues and displays them in the UI.
*
* @since 4.14.2
*
* @return array Array of common issues which are displayed on the troubleshooting page.
*/
public function get_common_issues(): array {
return apply_filters(
'tec_help_troubleshooting_issues',
[
[
'issue' => __( 'Common Error Messages', 'tribe-common' ),
/* Translators: %s: The link label, i.e. "common error messages" */
'solution' => __( 'Here’s an overview of %s and what they mean.', 'tribe-common' ),
'link' => 'https://evnt.is/1as0',
'link_label' => __( 'common error messages', 'tribe-common' ),
],
[
'issue' => __( 'My calendar doesn’t look right.', 'tribe-common' ),
/* Translators: %s: The link label, i.e. "More info" */
'solution' => __( 'This can happen when other plugins try to improve performance. %s.' ),
'link' => 'https://theeventscalendar.com/knowledgebase/k/troubleshooting-the-most-common-installation-issues/#layout-issue',
'link_label' => __( 'More info', 'tribe-common' ),
],
[
'issue' => __( 'I installed the calendar and it crashed my site.', 'tribe-common' ),
/* Translators: %s: The link label, i.e. "Find solutions to this" */
'solution' => __( '%s and other common installation issues.', 'tribe-common' ),
'link' => 'https://theeventscalendar.com/knowledgebase/k/troubleshooting-the-most-common-installation-issues/#fatal-errors',
'link_label' => __( 'Find solutions to this', 'tribe-common' ),
],
[
'issue' => __( 'I keep getting “Page Not Found” on events.', 'tribe-common' ),
/* Translators: %s: The link label, i.e. "things you can do" */
'solution' => __( 'There are a few %s to resolve and prevent 404 errors.', 'tribe-common' ),
'link' => 'https://evnt.is/1as2',
'link_label' => __( 'things you can do', 'tribe-common' ),
],
]
);
}
/**
* Fired to display notices in the admin pages where the method is called.
*
* @since 4.14.2
*
* @param string $page The page which the action is being applied to.
*/
public function admin_notice( $page ) {
do_action( 'tec_admin_notice_area', $page );
}
/**
* Check if any caching plugins are active on the site.
*
* @since 6.9.4
*
* @return string[] An array of the active caching plugins.
*/
private function get_active_caching_plugins(): array {
$active_plugins = get_option( 'active_plugins' );
$caching_plugins = [
'autoptimize/autoptimize.php',
'breeze/breeze.php',
'comet-cache/comet-cache.php',
'litespeed-cache/litespeed-cache.php',
'pantheon-advanced-page-cache/pantheon-advanced-page-cache.php',
'redis-cache/redis-cache.php',
'sg-cachepress/sg-cachepress.php',
'speedycache/speedycache.php',
'w3-total-cache/w3-total-cache.php',
'wp-cloudflare-page-cache/wp-cloudflare-super-page-cache.php',
'wp-fastest-cache/wpFastestCache.php',
'wp-optimize/wp-optimize.php',
'wp-rocket/wp-rocket.php',
'wp-super-cache/wp-cache.php',
];
// Return the active caching plugins.
return array_intersect( $caching_plugins, $active_plugins );
}
/**
* Get the name of the first found active caching plugin.
*
* @since 6.9.4
*
* @return string The name of the caching plugin.
*/
private function get_active_caching_plugin_name() {
$active_caching_plugins = $this->get_active_caching_plugins();
if ( empty( $active_caching_plugins ) ) {
return __( "Plugin couldn't be identified.", 'tribe-common' );
}
$plugin = array_pop( $active_caching_plugins );
$plugin_data = get_plugin_data( WP_PLUGIN_DIR . '/' . $plugin, false );
return $plugin_data['Name'];
}
}