check_core_updates(); // Refresh the cache, but only if this is a fresh timestamp (not if the page has been refreshed with the timestamp still in the URL). if ( isset( $_GET['clear_cache'] ) ) { $new_timestamp = intval( $_GET['clear_cache'] ); $last_timestamp = intval( get_site_transient( 'plugin_report_cache_cleared' ) ); if ( ! $last_timestamp || $new_timestamp > $last_timestamp ) { $this->clear_cache(); set_site_transient( 'plugin_report_cache_cleared', $new_timestamp, self::CACHE_LIFETIME ); } } // Start the page's output. echo '
'; echo '

' . esc_html_x( 'Plugin Report', 'Page and menu title', 'plugin-report' ) . '

'; echo '

'; $version_temp = '' . $wp_version . ''; /* translators: %1$s: Current WordPress version number, %2$s: Current PHP version number */ echo sprintf( __( 'Currently running WordPress version %1$s and PHP version %2$s.', 'plugin-report' ), $version_temp, phpversion() ); if ( version_compare( $wp_version, $wp_latest, '<' ) ) { /* translators: %s = Available new version number */ echo sprintf( ' (' . esc_html__( 'An upgrade to %s is available', 'plugin-report' ) . ')', $wp_latest ); } echo '

'; echo '

'; // Clear cache and reload. if ( is_multisite() ) { $page_url = 'network/plugins.php?page=plugin_report'; } else { $page_url = 'plugins.php?page=plugin_report'; } echo '' . esc_html__( 'Clear cached plugin data and reload', 'plugin-report' ) . ''; echo '

'; echo '

' . esc_html__( 'Currently installed plugins', 'plugin-report' ) . '

'; echo '

'; echo '

'; // The report's main table. echo ''; echo ''; echo ''; echo ''; echo ''; echo ''; echo ''; echo ''; echo ''; echo ''; echo ''; echo ''; echo ''; echo ''; echo ''; foreach ( $plugins as $key => $plugin ) { $slug = $this->get_plugin_slug( $key ); $cache_key = $this->create_cache_key( $slug ); $cache = get_site_transient( $cache_key ); if ( $cache ) { // Use the cached report to create a table row. echo $this->render_table_row( $cache ); } else { // Render a special table row that's used as a signal to the front-end js that new data is needed. echo ''; } } echo ''; echo '
' . esc_html__( 'Name', 'plugin-report' ) . '' . esc_html__( 'Author', 'plugin-report' ) . '' . esc_html__( 'Repository', 'plugin-report' ) . '' . esc_html__( 'Activated', 'plugin-report' ) . '' . esc_html__( 'Installed version', 'plugin-report' ) . '' . esc_html__( 'Auto-update', 'plugin-report' ) . '' . esc_html__( 'Last update', 'plugin-report' ) . '' . esc_html__( 'Tested up to WP version', 'plugin-report' ) . '' . esc_html__( 'Rating', 'plugin-report' ) . '
' . esc_html__( 'Loading...', 'plugin-report' ) . '
'; echo '

'; echo '

'; // Wrap up. echo '
'; } /** * Enqueue admin javascript * * @param string $hook Screen hook. */ public function enqueue_assets( $hook ) { // Check if we're on the right screen. if ( 'plugins_page_plugin_report' !== $hook ) { return; } // Register the plugin's admin js, and require jquery. wp_enqueue_script( 'plugin-report-js', plugins_url( '/js/plugin-report.js', __FILE__ ), array( 'jquery', 'plugin-report-tablesort-js' ), self::PLUGIN_VERSION ); wp_enqueue_script( 'plugin-report-tablesort-js', plugins_url( '/js/tablesort.min.js', __FILE__ ), array( 'jquery' ), '5.2.1' ); wp_enqueue_script( 'plugin-report-tablesort-number-js', plugins_url( '/js/tablesort.number.min.js', __FILE__ ), array( 'plugin-report-tablesort-js' ), '5.2.1' ); wp_enqueue_script( 'plugin-report-tablesort-dotsep-js', plugins_url( '/js/tablesort.dotsep.min.js', __FILE__ ), array( 'plugin-report-tablesort-js' ), '5.2.1' ); // Add some variables to the page, to be used by the javascript. $slugs = $this->get_plugin_slugs(); $slugs_str = implode( ',', $slugs ); $vars = array( 'plugin_slugs' => $slugs_str, 'ajax_nonce' => wp_create_nonce( 'plugin_report_nonce' ), 'export_btn' => __( 'Export .csv file', 'plugin-report' ), 'plugin_url_header' => __( 'Plugin URL', 'plugin-report' ), 'author_url_header' => __( 'Author URL', 'plugin-report' ), ); wp_localize_script( 'plugin-report-js', 'plugin_report_vars', $vars ); // Enqueue admin CSS file. wp_enqueue_style( 'plugin-report-css', plugin_dir_url( __FILE__ ) . 'css/plugin-report.css', array(), self::PLUGIN_VERSION ); } /** * Get the slugs for all currently installed plugins */ private function get_plugin_slugs() { $plugins = get_plugins(); $slugs = array(); foreach ( $plugins as $key => $plugin ) { $slugs[] = $this->get_plugin_slug( $key ); } return $slugs; } /** * Convert a plugin's file path into its slug. * * @param string $file Plugin file path. */ private function get_plugin_slug( $file ) { if ( strpos( $file, '/' ) !== false ) { $parts = explode( '/', $file ); } else { $parts = explode( '.', $file ); } return sanitize_title( $parts[0] ); } /** * AJAX handler * Returns a full html table row with the plugin's data */ public function get_plugin_info() { // Check the ajax nonce, display an error if the check fails. if ( ! check_ajax_referer( 'plugin_report_nonce', 'nonce', false ) ) { wp_die(); } // Check user capabilites, just to be sure. if ( ! current_user_can( 'manage_options' ) ) { wp_die(); } // Check if get_plugins() function exists. if ( ! function_exists( 'plugins_api' ) ) { require_once ABSPATH . 'wp-admin/includes/plugin-install.php'; } $slug = sanitize_title( $_POST['slug'] ); $report = $this->assemble_plugin_report( $slug ); if ( $report ) { $table_row = $this->render_table_row( $report ); } else { $table_row = $this->render_error_row( esc_html__( 'No plugin data available.', 'plugin-report' ) ); } // Formulate a response. $response = array( 'html' => $table_row, 'message' => 'Success!', ); // Return the response. echo wp_json_encode( $response ); wp_die(); } /** * Gather all the info we can get about a plugin. * Uses transient caching to avoid doing repo API calls on every page visit. * * @param string $slug Plugin slug. */ private function assemble_plugin_report( $slug ) { if ( ! empty( $slug ) ) { $report = array(); $cache_key = $this->create_cache_key( $slug ); $cache = get_site_transient( $cache_key ); $plugins = get_plugins(); $auto_updates = (array) get_site_option( 'auto_update_plugins', array() ); if ( empty( $cache ) ) { // Add the plugin's slug to the report. $report['slug'] = $slug; // Get the locally available info, and add it to the report. foreach ( $plugins as $key => $plugin ) { if ( $this->get_plugin_slug( $key ) === $slug ) { // Translate plugin data. $textdomain = $plugin['TextDomain']; if ( $textdomain ) { if ( ! is_textdomain_loaded( $textdomain ) ) { if ( $plugin['DomainPath'] ) { load_plugin_textdomain( $textdomain, false, dirname( $plugin_file ) . $plugin['DomainPath'] ); } else { load_plugin_textdomain( $textdomain, false, dirname( $plugin_file ) ); } } } elseif ( 'hello.php' === basename( $plugin_file ) ) { $textdomain = 'default'; } if ( $textdomain ) { foreach ( array( 'Name', 'PluginURI', 'Description', 'Author', 'AuthorURI', 'Version' ) as $field ) { // phpcs:ignore WordPress.WP.I18n.LowLevelTranslationFunction,WordPress.WP.I18n.NonSingularStringLiteralText,WordPress.WP.I18n.NonSingularStringLiteralDomain $plugin[ $field ] = translate( $plugin[ $field ], $textdomain ); } } $report['local_info'] = $plugin; $report['file_path'] = $key; $report['auto-update'] = in_array( $key, $auto_updates ); // Change any whitespace to default space. $report['local_info']['Name'] = preg_replace( '/\s+/u', ' ', $report['local_info']['Name'] ); break; } } // Use the wordpress.org repository API to get detailed information. $args = array( 'slug' => $slug, 'fields' => array( 'description' => false, 'sections' => false, 'tags' => false, 'version' => true, 'tested' => true, 'requires' => true, 'requires_php' => true, 'compatibility' => true, 'author' => true, ), ); // Check wordpress.org only if "Update URI" plugin header is not set or set to wordpress.org. $parsed_repo_url = wp_parse_url( $report['local_info']['UpdateURI'] ); $repo_host = isset( $parsed_repo_url['host'] ) ? $parsed_repo_url['host'] : null; if ( empty( $repo_host ) || strtolower( $repo_host ) === 'w.org' || strtolower( $repo_host ) === 'wordpress.org' ) { $returned_object = plugins_api( 'plugin_information', $args ); } // Add the repo info to the report. if ( ! is_wp_error( $returned_object ) ) { $report['repo_info'] = maybe_unserialize( $returned_object ); // Cache the report. set_site_transient( $cache_key, $report, self::CACHE_LIFETIME ); } else { // Store the error code and message in the report. $report['repo_error_code'] = $returned_object->get_error_code(); $report['repo_error_message'] = $returned_object->get_error_message(); // Cache for an extra long time when the plugin is not in the repo. set_site_transient( $cache_key, $report, self::CACHE_LIFETIME_NOREPO ); } } else { $report = $cache; } return $report; } else { return null; } } /** * From a report, generate an HTML table row with relevant data for the plugin. * * @param array $report Report of plugin. */ private function render_table_row( $report ) { // Get the current WP version number. global $wp_version; // Get the latest WP release version number. $wp_latest = $this->check_core_updates(); // Check if the report is valid. if ( null === $report ) { $html = $this->render_error_row( esc_html__( 'No plugin data available.', 'plugin-report' ) ); } else { // Start the new table row. $html = ''; // Name. if ( isset( $report['local_info']['PluginURI'] ) && ! empty( $report['local_info']['PluginURI'] ) ) { $html .= '' . $report['local_info']['Name'] . ''; } else { $html .= '' . $report['local_info']['Name'] . ''; } // Author. if ( isset( $report['local_info']['AuthorURI'] ) && ! empty( $report['local_info']['AuthorURI'] ) ) { $html .= '' . $report['local_info']['Author'] . ''; } else { $html .= '' . $report['local_info']['Author'] . ''; } // Repository. if ( isset( $report['local_info']['UpdateURI'] ) ) { // Parse the UpdateURI's value to get the host. $parsed_repo_url = wp_parse_url( $report['local_info']['UpdateURI'] ); // If the URI is valid, extract the host, otherwise we'll use the header value. $repo_host = isset( $parsed_repo_url['host'] ) ? $parsed_repo_url['host'] : $report['local_info']['UpdateURI']; // Check if the plugin is supposed to be hosted on wp.org. if ( empty( $repo_host ) || strtolower( $repo_host ) === 'w.org' || strtolower( $repo_host ) === 'wordpress.org' ) { // Plugin should be available on wp.org, check if we got a 'not found' error. if ( isset( $report['repo_error_code'] ) && $report['repo_error_code'] === 'plugins_api_failed' ) { // Plugin is not available in the wp.org repo. $html .= '' . __( 'wordpress.org, plugin not found', 'plugin-report' ) . ''; } else { // Plugin is available on wp.org. $html .= 'wordpress.org'; } } else { if ( $parsed_repo_url && isset( $parsed_repo_url[ 'host' ] ) ) { // Update URI is a valid URL, display the host. $html .= '' . $repo_host . ''; } else { // Some other value (like 'false'), so assume updates are disabled. $html .= '' . __( 'Updates disabled', 'plugin-report' ) . ''; } } } else { $html .= $this->render_error_cell(); } // Activated. $active = __( 'Please clear cache to update', 'plugin-report' ); $css_class = self::CSS_CLASS_MED; if ( is_multisite() ) { $activation_status = $this->get_multisite_activation( $report['file_path'] ); if ( true === $activation_status['network'] ) { $css_class = self::CSS_CLASS_LOW; $html .= '' . __( 'Network activated', 'plugin-report' ) . ''; } else { $css_class = ( $activation_status['active'] > 0 ) ? self::CSS_CLASS_LOW : self::CSS_CLASS_HIGH; $html .= '' . $activation_status['active'] . '/' . $activation_status['sites'] . ''; } } else { if ( isset( $report['file_path'] ) ) { $active = is_plugin_active( $report['file_path'] ) ? __( 'Yes', 'plugin-report' ) : __( 'No', 'plugin-report' ); $css_class = is_plugin_active( $report['file_path'] ) ? self::CSS_CLASS_LOW : self::CSS_CLASS_HIGH; } $html .= '' . $active . ''; } // Installed / available version. if ( isset( $report['repo_info'] ) ) { $css_class = $this->get_version_risk_classname( $report['local_info']['Version'], $report['repo_info']->version ); $html .= ''; $html .= $report['local_info']['Version']; if ( $report['local_info']['Version'] !== $report['repo_info']->version ) { // Any platform upgrades needed? $needs_php_upgrade = isset( $report['repo_info']->requires_php ) ? version_compare( phpversion(), $report['repo_info']->requires_php, '<' ) : false; $needs_wp_upgrade = isset( $report['repo_info']->requires ) ? version_compare( $wp_version, $report['repo_info']->requires, '<' ) : false; // Create the additional message. if ( $needs_wp_upgrade && $needs_php_upgrade ) { /* translators: %1$s: Plugin version number, %2$s: WP version number, %3$s: PHP version number */ $html .= ' ' . sprintf( esc_html__( '(%1$s available, requires WP %2$s and PHP %3$s)', 'plugin-report' ), $report['repo_info']->version, $report['repo_info']->requires, $report['repo_info']->requires_php ) . ''; } elseif ( $needs_wp_upgrade ) { /* translators: %1$s: Plugin version number, %2$s: WP version number. */ $html .= ' ' . sprintf( esc_html__( '(%1$s available, requires WP %2$s)', 'plugin-report' ), $report['repo_info']->version, $report['repo_info']->requires ) . ''; } elseif ( $needs_php_upgrade ) { /* translators: %1$s: Plugin version number, %2$s: PHP version number. */ $html .= ' ' . sprintf( esc_html__( '(%1$s available, requires PHP %2$s)', 'plugin-report' ), $report['repo_info']->version, $report['repo_info']->requires_php ) . ''; } else { /* translators: %s: Plugin version number. */ $html .= ' ' . sprintf( esc_html__( '(%s available)', 'plugin-report' ), $report['repo_info']->version ) . ''; } } $html .= ''; } else { $html .= '' . $report['local_info']['Version'] . ''; } // Auto-update. if ( version_compare( $wp_version, '5.5', '<' ) ) { $html .= '' . __( 'Requires WordPress 5.5 or higher', 'plugin-report' ) . ''; } else { if ( isset( $report['auto-update'] ) && $report['auto-update'] ) { $html .= '' . __( 'Enabled', 'plugin-report' ) . ''; } else { $html .= '' . __( 'Not enabled', 'plugin-report' ) . ''; } } // Last updates. if ( isset( $report['repo_info'] ) ) { $time_update = new DateTime( $report['repo_info']->last_updated ); $time_diff = human_time_diff( $time_update->getTimestamp(), current_time( 'timestamp' ) ); $css_class = $this->get_timediff_risk_classname( current_time( 'timestamp' ) - $time_update->getTimestamp() ); $html .= '' . $time_diff . ''; } else { $html .= $this->render_error_cell(); } // Tested up to. if ( isset( $report['repo_info'] ) ) { $css_class = $this->get_version_risk_classname( $report['repo_info']->tested, $wp_latest, true ); $html .= '' . $report['repo_info']->tested . ''; } else { $html .= $this->render_error_cell(); } // Overall user rating. if ( isset( $report['repo_info'] ) ) { $css_class = ( intval( $report['repo_info']->num_ratings ) > 0 ) ? $this->get_percentage_risk_classname( intval( $report['repo_info']->rating ) ) : ''; $value_text = ( ( intval( $report['repo_info']->num_ratings ) > 0 ) ? $report['repo_info']->rating . '%' : esc_html__( 'No data available', 'plugin-report' ) ); $html .= '' . $value_text . ''; } else { $html .= $this->render_error_cell(); } // Close the new table row. $html .= ''; } return $html; } /** * Format an error message as a table row, so we can return it to javascript. * * @param string $message Message to be shown. */ private function render_error_row( $message ) { return '' . $message . ''; } /** * Format an error message as a table cell, so we can return it to javascript. * * @param string $message Message to be shown. */ private function render_error_cell( $message = null ) { if ( ! $message ) { $message = esc_html__( 'No data available', 'plugin-report' ); } return '' . $message . ''; } /** * Return the version string with all elements beyond the second removed ("5.5.1" -> "5.5"). * * @param string $version_string Complete version number. */ private function get_major_version( $version_string ) { $parts = explode( '.', $version_string ); array_splice( $parts, 2 ); return implode( '.', $parts ); } /** * Figure out what CSS class to use based on current and optimal version numbers. * * @param string $available Available version. * @param string $optimal Optimal version. * @param bool $major_only True to compare only major versions, false otherwise. */ private function get_version_risk_classname( $available, $optimal, $major_only = false ) { // Use only the first two elements of the version number if $major_only is set to true. // This is used for WP version numbers, where point releases are not considered a risk. if ( $major_only ) { $available = $this->get_major_version( $available ); $optimal = $this->get_major_version( $optimal ); } // If the version is equal or higher, indicate low risk. if ( version_compare( $available, $optimal, '>=' ) ) { return self::CSS_CLASS_LOW; } // Else, indicate high risk. return self::CSS_CLASS_HIGH; } /** * Assess the risk associated with low ratings or poor compatibility feedback, return corresponding CSS class. * * @param int $perc Rating percentage. */ private function get_percentage_risk_classname( $perc ) { if ( $perc < 70 ) { return self::CSS_CLASS_HIGH; } if ( $perc < 90 ) { return self::CSS_CLASS_MED; } return self::CSS_CLASS_LOW; } /** * Assess the risk associated with low ratings or poor compatibility feedback, return corresponding CSS class. * * @param string $time_diff Time difference. */ private function get_timediff_risk_classname( $time_diff ) { $days = $time_diff / ( DAY_IN_SECONDS ); if ( $days > 365 ) { return self::CSS_CLASS_HIGH; } if ( $days > 90 ) { return self::CSS_CLASS_MED; } return self::CSS_CLASS_LOW; } /** * Get the latest available WordPress version using WP core functions * This way, we don't need to do any API calls. WP check this periodically anyway. */ private function check_core_updates() { global $wp_version; $update = get_preferred_from_update_core(); // Bail out of no valid response, or false. if ( ! $update || false === $update ) { return $wp_version; } // If latest, return current version number. if ( 'latest' === $update->response ) { return $wp_version; } // Return the preferred update's version number. return $update->version; } /** * Gather statistics about a plugin's activation on a multisite install. * * @param string $path Plugin path. */ private function get_multisite_activation( $path ) { // Create an array to contain the return values. $activation_status = array( 'network' => false, 'active' => 0, 'sites' => 1, ); // Check if the plugin is network activated. $network_plugins = get_site_option( 'active_sitewide_plugins', null ); if ( array_key_exists( $path, $network_plugins ) ) { $activation_status['network'] = true; } else { // Get a list of all sites in the multisite install. $args = array( 'number' => 9999, 'fields' => 'ids', ); $sites = get_sites( $args ); // Add the total number of sites to the return array. $activation_status['sites'] = count( $sites ); // Loop through the sites to find where the plugin is active. foreach ( $sites as $site_id ) { $plugins = get_blog_option( $site_id, 'active_plugins', null ); if ( $plugins ) { foreach ( $plugins as $plugin_path ) { if ( $plugin_path === $path ) { $activation_status['active']++; } } } } } // Return the data we gathered. return $activation_status; } /** * Create a cache key that is unique to the provided plugin slug. * * @param string $slug Plugin slug. */ private function create_cache_key( $slug ) { // Create a hash for the plugin slug. $slug_hash = hash( 'sha256', $slug ); // Prefix and limit the string to 40 characters to avoid issues with long keys. $cache_key = 'rtpr_' . substr( $slug_hash, 0, 35 ); // Return the key. return $cache_key; } /** * Clear all cached plugin info */ private function clear_cache() { // Request a list of all plugins. $plugins = get_plugins(); // Loop through the plugins array, and delete cache items. foreach ( $plugins as $key => $plugin ) { $slug = $this->get_plugin_slug( $key ); $this->clear_cache_item( $slug ); } } /** * Remove the cache item for a single plugin. * * @param string $slug Plugin slug. */ private function clear_cache_item( $slug ) { if ( isset( $slug ) ) { $cache_key = $this->create_cache_key( $slug ); delete_site_transient( $cache_key ); } } /** * Selectively delete cache for plugins that have been updated. */ public function upgrade_delete_cache_items( $upgrader, $data ) { // Check if plugins have been upgraded by WP. if ( isset( $data ) && isset( $data['plugins'] ) && is_array( $data['plugins'] ) ) { // Loop through the plugins, and delete the associated cache items. foreach ( $data['plugins'] as $key => $value ) { $slug = $this->get_plugin_slug( $value ); $this->clear_cache_item( $slug ); } } } } // Instantiate the class. $plugin_report_instance = new RT_Plugin_Report(); $plugin_report_instance->init(); }