*/ trait Activecampaign_For_Woocommerce_Admin_Status { /** * Logger class. * * @var Activecampaign_For_Woocommerce_Logger The logger class. */ private $logger; /** * Highest tested PHP version (major.minor, inclusive), keep in sync with the release notes. * The minimum PHP and WordPress versions are read from the plugin header, see get_version_requirements(). * * @var string */ private $max_tested_php = '8.4'; /** * Initialize the class and set its properties. */ public function __construct() { $this->logger = new Logger(); } /** * Fetch the PHP template file that is used for the admin status page. * * @since 1.4.9 */ public function fetch_status_page() { // This gets ported to the display page through require $activecampaign_for_woocommerce_status_data = $this->get_status_page_data(); wp_enqueue_script( $this->plugin_name . 'status-page' ); require_once plugin_dir_path( __FILE__ ) . 'views/activecampaign-for-woocommerce-status-display.php'; } /** * Gets the data for the status page. * * @return array */ public function get_status_page_data() { $data = array(); $this->delete_old_log_records(); $data = $this->get_cron_data( $data ); $data = $this->get_table_data( $data ); $data = $this->get_woocommerce_data( $data ); $data = $this->get_recent_ac_data( $data ); $data = $this->get_log_data( $data ); $data = $this->get_whitelist( $data ); return $data; } /** * Gets the whitelist for the support page. * * @param mixed $data all the data for the page. * * @return mixed */ public function get_whitelist( $data ) { $logger = new Logger(); try { if ( isset( $this->api_client ) ) { $whitelist_repo = new Activecampaign_For_Woocommerce_Whitelist_Repository( $this->api_client ); if ( $whitelist_repo ) { $data['whitelist'] = $whitelist_repo->list_all(); } } } catch ( Throwable $t ) { $logger->warning( 'There was an issue retrieving the whitelist from ActiveCampaign.', array( $t->getMessage() ) ); } $ac_forms_settings = get_option( 'settings_activecampaign' ); // This is the setting from the other AC plugin $data['other_ac_tracking'] = false; if ( isset( $ac_forms_settings['activecampaign_site_tracking_default'], $ac_forms_settings['site_tracking'] ) && in_array( $ac_forms_settings['site_tracking'], array( '1', 1 ) ) ) { $data['other_ac_tracking'] = true; } return $data; } /** * Clears the error log history. */ public function clear_error_logs() { $logger = new Logger(); $result = $logger->clear_wc_error_log(); if ( $result['error'] ) { wp_send_json_error( 'Action Failed. Unauthorized access.' ); } else { $count = $result['count']; delete_option( 'activecampaign_for_woocommerce_dismiss_error_notice' ); wp_send_json_success( $count . ' ' . translate_nooped_plural( array( 'singular' => 'record', 'plural' => 'records', 'domain' => ACTIVECAMPAIGN_FOR_WOOCOMMERCE_LOCALIZATION_DOMAIN, 'context' => null, ), $count ) . ' removed from the database.' ); } } /** * Delete old records */ public function delete_old_log_records() { // remove very old records try { $date = new DateTime(); $date->modify( '-30 days' ); WC_Log_Handler_DB::delete_logs_before_timestamp( $date->format( 'U' ) ); } catch ( Throwable $t ) { $logger = new Logger(); $logger->warning( 'There was an issue trying to remove old log records.', array( 'message' => $t->getMessage(), ) ); } } /** * Gets the most recent 10 error log entries saved * * @return array|object|null */ public function fetch_recent_log_errors() { global $wpdb; $wc_log_cache = wp_cache_get( 'wc_log_results', 'activecampaign_for_woocommerce' ); if ( ! $wc_log_cache ) { $results = $wpdb->get_results( 'SELECT message, context, timestamp FROM ' . $wpdb->prefix . 'woocommerce_log WHERE ( source = "activecampaign-for-woocommerce" OR source = "activecampaign-for-woocommerce-errors" ) AND level = "500" GROUP BY message ORDER BY timestamp DESC LIMIT 20 ' ); wp_cache_set( 'wc_log_results', $results, 'activecampaign_for_woocommerce', 60 ); } else { $results = $wc_log_cache; } return $results; } /** * Gets the recent AC data stuff. * * @param mixed $data The data. * * @return mixed The data. */ private function get_recent_ac_data( $data ) { global $wpdb; try { $data['recent_log_errors'] = $this->fetch_recent_log_errors(); $data['log_errors_count'] = $this->get_ac_error_count(); // phpcs:disable $data['wc_actionscheduler_status_array'] = $wpdb->get_results( 'SELECT status, COUNT(*) as "count" FROM ' . $wpdb->prefix . 'actionscheduler_actions GROUP BY status;' ); $data['wc_webhooks'] = $wpdb->get_results( 'SELECT name, status FROM ' . $wpdb->prefix . 'wc_webhooks;' ); $data['wc_rest_keys'] = $wpdb->get_results( 'SELECT description, last_access, permissions FROM ' . $wpdb->prefix . 'woocommerce_api_keys;' ); $data['synced_results'] = $wpdb->get_results( 'SELECT count(*) as count, synced_to_ac FROM `' . $wpdb->prefix . ACTIVECAMPAIGN_FOR_WOOCOMMERCE_TABLE_NAME . '` WHERE wc_order_id is not null GROUP BY synced_to_ac' ); $data['abandoned_results'] = $wpdb->get_results( 'SELECT count(*) as count, synced_to_ac FROM `' . $wpdb->prefix . ACTIVECAMPAIGN_FOR_WOOCOMMERCE_TABLE_NAME . '` WHERE order_date IS NULL AND wc_order_id is null GROUP BY synced_to_ac' ); $data['permalink_structure'] = get_option( 'permalink_structure' ); // phpcs:enable $abandoned_cart_last_run = get_option( 'activecampaign_for_woocommerce_abandoned_cart_last_run' ); $date_now = date_create( 'NOW' ); $last_order_sync = get_option( 'activecampaign_for_woocommerce_last_order_sync' ); if ( $abandoned_cart_last_run ) { $abandoned_cart_last_run_interval = date_diff( $date_now, $abandoned_cart_last_run ); $data['abandoned_interval_minutes'] = $abandoned_cart_last_run_interval->format( '%i' ); } if ( $last_order_sync ) { $last_order_sync_interval = date_diff( $date_now, $last_order_sync ); $data['last_order_interval_minutes'] = $last_order_sync_interval->format( '%i' ); } $activecampaign_for_woocommerce_plugins = get_plugin_updates(); if ( count( $activecampaign_for_woocommerce_plugins ) > 0 && isset( $activecampaign_for_woocommerce_plugins['activecampaign-for-woocommerce/activecampaign-for-woocommerce.php'] ) ) { $activecampaign_for_woocommerce_plugin_data = $activecampaign_for_woocommerce_plugins['activecampaign-for-woocommerce/activecampaign-for-woocommerce.php']; $data['plugin_data'] = (object) _get_plugin_data_markup_translate( 'activecampaign-for-woocommerce/activecampaign-for-woocommerce.php', (array) $activecampaign_for_woocommerce_plugin_data, false, true ); } $data['disk_space'] = null; $free_space = null; $total_space = null; if ( function_exists( 'disk_free_space' ) ) { $free_space = disk_free_space( '.' ); $data['disk_space']['available_number'] = $free_space; $data['disk_space']['readable'] = $this->format_bytes( $free_space ) . ' free'; } if ( function_exists( 'disk_total_space' ) ) { $total_space = disk_total_space( '.' ); if ( ! empty( $this->format_bytes( $total_space ) ) ) { $data['disk_space']['readable'] .= ' / ' . $this->format_bytes( $total_space ) . ' total'; } } if ( isset( $free_space, $total_space ) && ! empty( $free_space ) && ! empty( $total_space ) ) { $data['disk_space']['percent'] = round( $free_space / $total_space * 100, 0 ); $data['disk_space']['readable'] .= ' (' . $data['disk_space']['percent'] . '%)'; } } catch ( Throwable $t ) { $logger = new Logger(); $logger->warning( 'ActiveCampaign status page threw an error', array( 'message' => $t->getMessage(), ) ); } return $data; } private function format_bytes( $bytes, $precision = 2 ) { $units = array( 'B', 'KB', 'MB', 'GB', 'TB' ); try { $bytes = max( $bytes, 0 ); $pow = floor( ( $bytes ? log( $bytes ) : 0 ) / log( 1024 ) ); $pow = min( $pow, count( $units ) - 1 ); // Uncomment one of the following alternatives // $bytes /= pow( 1024, $pow ); $bytes /= ( 1 << ( 10 * $pow ) ); return round( $bytes, $precision ) . ' ' . $units[ $pow ]; } catch ( Throwable $t ) { $logger = new Logger(); $logger->debug( 'Could not format disk size into readable numbers' ); } } /** * Gets the WC related data. * * @param mixed $data The data. * * @return mixed The data. */ private function get_woocommerce_data( $data ) { $logger = new Logger(); $data['legacy_api'] = null; try { if ( null !== wc_get_container()->get( RestApiUtil::class ) ) { $wc_report = wc_get_container()->get( RestApiUtil::class )->get_endpoint_data( '/wc/v3/system_status' ); } else { $wc_report = null; } } catch ( Throwable $t ) { $logger->warning( 'ActiveCampaign status page could not retrieve WooCommerce data from the new method. If you are not on WC 9.0 then this may not be a concern. If there is an issue with WooCommerce then ActiveCampaign may not run as expected.', array( 'message' => $t->getMessage(), 'trace' => $logger->clean_trace( $t->getTrace() ), ) ); try { $wc_report = wc_get_container()->get( RestApiUtil::class )->get_endpoint_data( '/wc/v3/system_status' ); } catch ( Throwable $t ) { $logger->warning( 'ActiveCampaign status page could not retrieve WooCommerce data via the old method either.', array( 'message' => $t->getMessage(), 'trace' => $logger->clean_trace( $t->getTrace() ), ) ); } } if ( isset( $wc_report ) ) { $data['wc_environment'] = $this->get_wc_data_chunk( $wc_report, 'environment' ); $data['wc_database'] = $this->get_wc_data_chunk( $wc_report, 'database' ); $data['wc_post_type_counts'] = isset( $wc_report['post_type_counts'] ) ? $wc_report['post_type_counts'] : array(); $data['wc_settings'] = $this->get_wc_data_chunk( $wc_report, 'settings' ); $data['wc_theme'] = $this->get_wc_data_chunk( $wc_report, 'theme' ); } else { $data['wc_environment'] = null; $data['wc_database'] = null; $data['wc_post_type_counts'] = array(); $data['wc_settings'] = null; $data['wc_theme'] = null; } $data['wp_version'] = $this->get_wp_version(); $data['php_version'] = $this->get_local_php_version(); try { $data['legacy_api'] = get_option( 'woocommerce_api_enabled' ); } catch ( Throwable $t ) { $logger->warning( 'ActiveCampaign status page could not retrieve WooCommerce legacy API.', array( 'message' => $t->getMessage(), 'trace' => $logger->clean_trace( $t->getTrace() ), ) ); } return $data; } /** * Minimum PHP / WordPress / WooCommerce versions from the plugin header plus the highest tested PHP version. * * @return array{min_php: string, min_wp: string, min_wc: string, max_tested_php: string} */ public function get_version_requirements() { $header = get_file_data( dirname( __DIR__ ) . '/activecampaign-for-woocommerce.php', array( 'min_php' => 'Requires PHP', 'min_wp' => 'Requires at least', 'min_wc' => 'WC requires at least', ) ); $header['max_tested_php'] = $this->max_tested_php; return $header; } /** * Whether a PHP version is inside the supported range (compared on major.minor). * * @param string $version A PHP version string, defaults to the running one. * * @return array{local_php: string, php_supported: bool, below_min: bool, min_php: string, max_tested_php: string} */ public function get_local_php_version( $version = PHP_VERSION ) { $requirements = $this->get_version_requirements(); $major_minor = implode( '.', array_slice( explode( '.', $version ), 0, 2 ) ); $below_min = version_compare( $major_minor, $requirements['min_php'], '<' ); return array( 'local_php' => $version, 'php_supported' => ! $below_min && version_compare( $major_minor, $requirements['max_tested_php'], '<=' ), 'below_min' => $below_min, 'min_php' => $requirements['min_php'], 'max_tested_php' => $requirements['max_tested_php'], ); } private function get_wp_version() { global $wp_version; $data['number'] = $wp_version; $data['meets'] = false; $data['newer'] = false; $latest_version = null; if ( version_compare( $wp_version, $this->get_version_requirements()['min_wp'], '>=' ) ) { $data['meets'] = true; } if ( get_transient( 'woocommerce_system_status_wp_version_check' ) ) { $latest_version = get_transient( 'woocommerce_system_status_wp_version_check' ); } else { $wp_version_check = wp_remote_get( 'https://api.wordpress.org/core/version-check/1.7/' ); $api_response = json_decode( wp_remote_retrieve_body( $wp_version_check ), true ); if ( isset( $api_response['offers'][0]['version'] ) ) { $latest_version = $api_response['offers'][0]['version']; set_transient( 'woocommerce_system_status_wp_version_check', $latest_version, DAY_IN_SECONDS ); } } if ( null !== $latest_version && version_compare( $wp_version, $latest_version, '<' ) ) { $data['newer'] = true; } return $data; } private function get_wc_data_chunk( $data, $child ) { try { if ( isset( $data[ $child ] ) ) { return $data[ $child ]; } else { return null; } } catch ( Throwable $t ) { $logger = new Logger(); $logger->warning( 'ActiveCampaign status page could not retrieve WooCommerce data. See the data chunk throwing the issue and the message below. WooCommerce setup may not be complete or may have an error. If there is an issue with WooCommerce then ActiveCampaign may not run as expected.', array( 'message' => $t->getMessage(), 'chunk' => $child, 'trace' => $logger->clean_trace( $t->getTrace() ), ) ); } } /** * Gets the table related data. * * @param mixed $data The data. * * @return mixed The data. */ private function get_table_data( $data ) { global $wpdb; $table_exists = false; try { $table_name = $wpdb->prefix . ACTIVECAMPAIGN_FOR_WOOCOMMERCE_TABLE_NAME; $table_exists = wp_cache_get( 'ac_table_exists', 'activecampaign_for_woocommerce' ); if ( ! $table_exists && $wpdb->get_var( $wpdb->prepare( 'SHOW TABLES LIKE %s', $table_name ) ) === $table_name ) { $table_exists = true; wp_cache_set( 'ac_table_exists', $table_exists, 'activecampaign_for_woocommerce', 3600 ); } } catch ( Throwable $t ) { $logger = new Logger(); $logger->warning( 'ActiveCampaign status page threw an error', array( 'message' => $t->getMessage(), ) ); } $data['table_exists'] = $table_exists; return $data; } private function check_for_event_data( $event_schedule ) { $logger = new Logger(); $event_data = array(); if ( ! empty( $event_schedule ) ) { $event_data['timestamp'] = wp_date( DATE_ATOM, $event_schedule ); $event_data['next_scheduled'] = wp_date( DATE_ATOM, $event_schedule ); $event_data['error'] = false; if ( ! empty( $event_data['timestamp'] ) ) { return $event_data; } } if ( is_object( $event_schedule ) && ! empty( $event_schedule->timestamp ) ) { $event_data['timestamp'] = wp_date( DATE_ATOM, $event_schedule->timestamp ); if ( $event_schedule->timestamp && $event_schedule->interval ) { $next = $event_schedule->timestamp + $event_schedule->interval - time(); $data['abandoned_schedule']['next_scheduled'] = $next; } $event_data['schedule'] = $event_schedule->schedule; $event_data['error'] = false; } return $event_data; } /** * Gets the cron related data. * * @param mixed $data The data. * * @return mixed The data. */ private function get_cron_data( $data ) { $logger = new Logger(); $abandoned_schedule = AC_Schedule::get_schedule( AC_Schedule::RECURRING_ABANDONED_SYNC ); $data['abandoned_schedule'] = $this->check_for_event_data( $abandoned_schedule ); if ( ! $data['abandoned_schedule'] ) { AC_Schedule::schedule_ac_event( AC_Schedule::RECURRING_ABANDONED_SYNC, array(), true, false ); $abandoned_schedule = AC_Schedule::get_schedule( AC_Schedule::RECURRING_ABANDONED_SYNC ); $data['abandoned_schedule'] = $this->check_for_event_data( $abandoned_schedule ); } if ( ! $data['abandoned_schedule'] ) { $data['abandoned_schedule']['error'] = true; $logger->warning( 'Abandoned cart is not scheduled.', array( 'abandoned_cart_schedule' => $data['abandoned_schedule'] ) ); } $new_order_schedule = AC_Schedule::get_schedule( AC_Schedule::RECURRING_ORDER_SYNC ); $data['new_order_schedule'] = $this->check_for_event_data( $new_order_schedule ); if ( ! $data['new_order_schedule'] ) { AC_Schedule::schedule_ac_event( AC_Schedule::RECURRING_ORDER_SYNC, array(), true, false ); $new_order_schedule = AC_Schedule::get_schedule( AC_Schedule::RECURRING_ORDER_SYNC ); $data['new_order_schedule'] = $this->check_for_event_data( $new_order_schedule ); } if ( ! $data['new_order_schedule'] ) { $data['new_order_schedule']['error'] = true; $logger->warning( 'New order sync is not scheduled.', array( 'new_order_schedule' => $data['new_order_schedule'] ) ); } $historical_order_schedule = AC_Schedule::get_schedule( AC_Schedule::RECURRING_HISTORICAL_SYNC ); $data['historical_order_schedule'] = $this->check_for_event_data( $historical_order_schedule ); if ( ! $data['historical_order_schedule'] ) { AC_Schedule::schedule_ac_event( AC_Schedule::RECURRING_HISTORICAL_SYNC, array(), true, false ); $historical_order_schedule = AC_Schedule::get_schedule( AC_Schedule::RECURRING_HISTORICAL_SYNC ); $data['historical_order_schedule'] = $this->check_for_event_data( $historical_order_schedule ); } if ( ! $data['historical_order_schedule'] ) { $data['historical_order_schedule']['error'] = true; $logger->warning( 'Historical order sync is not scheduled.', array( 'historical_order_schedule' => $data['historical_order_schedule'] ) ); } return $data; } private function get_log_data( $data ) { // WC_Log_Handler_File $logger = new Logger(); $data['viewed_log'] = null; $data['viewed_log_full_path'] = null; try { $logs = WC_Log_Handler_File::get_log_files(); $data['logdir'] = wp_upload_dir()['basedir'] . '/wc-logs/'; // Load a log $post_data = $this->extract_post_data(); foreach ( $logs as $key => $log ) { if ( ! preg_match( '/activecampaign.for.woocommerce|fatal.error/', $log ) ) { unset( $logs[ $key ] ); } } $data['logs'] = $logs; // Grab the file to load $first_value = current( $logs ); if ( ! isset( $post_data['log_file'] ) && isset( $first_value ) && ! empty( $first_value ) ) { $data['viewed_log'] = $first_value; $data['viewed_log_full_path'] = $data['logdir'] . $data['viewed_log'];// load the first log file ob_start(); include $data['viewed_log_full_path']; $data['viewed_log_show_log'] = ob_get_contents(); ob_end_clean(); } elseif ( isset( $post_data['log_file'] ) && ! empty( $post_data['log_file'] ) ) { $data['viewed_log'] = basename( $post_data['log_file'] ); $data['viewed_log_full_path'] = $data['logdir'] . $data['viewed_log']; ob_start(); include $data['viewed_log_full_path']; $data['viewed_log_show_log'] = ob_get_contents(); ob_end_clean(); } if ( isset( $post_data['save'] ) && 'Save' === $post_data['save'] ) { do_action( 'activecampaign_for_woocommerce_download_log_data', $data['viewed_log_full_path'] ); } } catch ( Throwable $t ) { $logger->warning( 'There was an issue loading log files.', array( 'message' => $t->getMessage(), $data['viewed_log'], $data['viewed_log_full_path'], ) ); } return $data; } /** * Saves log data. */ public function download_log_data( ...$args ) { $logger = new Logger(); $viewed_log_full_path = null; $logdir = wp_upload_dir()['basedir'] . '/wc-logs/'; // Load a log $post_data = $this->extract_post_data(); if ( isset( $post_data['log_file'] ) && ! empty( $post_data['log_file'] ) ) { $viewed_log_full_path = $logdir . basename( $post_data['log_file'] ); } try { $ext = pathinfo( $viewed_log_full_path, PATHINFO_EXTENSION ); $basename = pathinfo( $viewed_log_full_path, PATHINFO_BASENAME ); header( 'Expires: 0' ); header( 'Last-Modified: ' . gmdate( 'D, d M Y H:i:s' ) . ' GMT' ); header( 'Cache-Control: no-store, no-cache, must-revalidate' ); header( 'Cache-Control: post-check=0, pre-check=0', false ); header( 'Content-length: ' . filesize( $viewed_log_full_path ) ); header( 'Pragma: no-cache' ); header( 'Content-Description: File Transfer' ); // header( 'Content-Type: application/octet-stream' ); header( 'Content-Transfer-Encoding: Binary' ); header( 'Content-type: application/' . $ext ); header( 'Content-disposition: attachment; filename="' . basename( $basename ) . '"' ); ob_clean(); flush(); $wp_filesystem = new WP_Filesystem_Direct( null ); $wp_filesystem->get_contents( $viewed_log_full_path ); } catch ( Throwable $t ) { $logger->warning( 'Unable to read log file for save.', array( 'message' => $t->getMessage(), 'file' => $post_data['log_file'], 'full_file_path' => $viewed_log_full_path, ) ); echo 'Unable to read log file.'; } exit; } }