| 123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470 |
- <?php
- use Automattic\Jetpack\Status;
- use Automattic\Jetpack\Assets\Logo as Jetpack_Logo;
- // Build the Jetpack admin menu as a whole
- class Jetpack_Admin {
- /**
- * @var Jetpack_Admin
- **/
- private static $instance = null;
- static function init() {
- if ( isset( $_GET['page'] ) && $_GET['page'] === 'jetpack' ) {
- add_filter( 'nocache_headers', array( 'Jetpack_Admin', 'add_no_store_header' ), 100 );
- }
- if ( is_null( self::$instance ) ) {
- self::$instance = new Jetpack_Admin();
- }
- return self::$instance;
- }
- static function add_no_store_header( $headers ) {
- $headers['Cache-Control'] .= ', no-store';
- return $headers;
- }
- private function __construct() {
- jetpack_require_lib( 'admin-pages/class.jetpack-react-page' );
- $this->jetpack_react = new Jetpack_React_Page();
- jetpack_require_lib( 'admin-pages/class.jetpack-settings-page' );
- $this->fallback_page = new Jetpack_Settings_Page();
- jetpack_require_lib( 'admin-pages/class-jetpack-about-page' );
- $this->jetpack_about = new Jetpack_About_Page();
- jetpack_require_lib( 'admin-pages/class-jetpack-search-dashboard-page' );
- $this->jetpack_search = new Jetpack_Search_Dashboard_Page();
- add_action( 'admin_init', array( $this->jetpack_react, 'react_redirects' ), 0 );
- add_action( 'admin_menu', array( $this->jetpack_react, 'add_actions' ), 998 );
- add_action( 'admin_menu', array( $this->jetpack_search, 'add_actions' ), 999 );
- add_action( 'jetpack_admin_menu', array( $this->jetpack_react, 'jetpack_add_dashboard_sub_nav_item' ) );
- add_action( 'jetpack_admin_menu', array( $this->jetpack_react, 'jetpack_add_settings_sub_nav_item' ) );
- add_action( 'jetpack_admin_menu', array( $this, 'admin_menu_debugger' ) );
- add_action( 'jetpack_admin_menu', array( $this->fallback_page, 'add_actions' ) );
- add_action( 'jetpack_admin_menu', array( $this->jetpack_about, 'add_actions' ) );
- // Add redirect to current page for activation/deactivation of modules
- add_action( 'jetpack_pre_activate_module', array( $this, 'fix_redirect' ), 10, 2 );
- add_action( 'jetpack_pre_deactivate_module', array( $this, 'fix_redirect' ) );
- // Add module bulk actions handler
- add_action( 'jetpack_unrecognized_action', array( $this, 'handle_unrecognized_action' ) );
- if ( class_exists( 'Akismet_Admin' ) ) {
- // If the site has Jetpack Anti-Spam, change the Akismet menu label accordingly.
- $site_products = Jetpack_Plan::get_products();
- $anti_spam_products = array( 'jetpack_anti_spam_monthly', 'jetpack_anti_spam' );
- if ( ! empty( array_intersect( $anti_spam_products, array_column( $site_products, 'product_slug' ) ) ) ) {
- // Prevent Akismet from adding a menu item.
- add_action(
- 'admin_menu',
- function () {
- remove_action( 'admin_menu', array( 'Akismet_Admin', 'admin_menu' ), 5 );
- },
- 4
- );
- // Add an Anti-spam menu item for Jetpack.
- add_action(
- 'jetpack_admin_menu',
- function () {
- add_submenu_page( 'jetpack', __( 'Anti-Spam', 'jetpack' ), __( 'Anti-Spam', 'jetpack' ), 'manage_options', 'akismet-key-config', array( 'Akismet_Admin', 'display_page' ) );
- }
- );
- add_action( 'admin_enqueue_scripts', array( $this, 'akismet_logo_replacement_styles' ) );
- }
- }
- add_filter( 'jetpack_display_jitms_on_screen', array( $this, 'should_display_jitms_on_screen' ), 10, 2 );
- }
- /**
- * Generate styles to replace Akismet logo for the Jetpack logo. It's a workaround until we create a proper settings page for
- * Jetpack Anti-Spam. Without this, we would have to change the logo from Akismet codebase and we want to avoid that.
- */
- public function akismet_logo_replacement_styles() {
- $logo = new Jetpack_Logo();
- $logo_base64 = base64_encode( $logo->get_jp_emblem_larger() );
- $logo_base64_url = "data:image/svg+xml;base64,{$logo_base64}";
- $style = ".akismet-masthead__logo-container { background: url({$logo_base64_url}) no-repeat .25rem; height: 1.8125rem; } .akismet-masthead__logo { display: none; }";
- wp_add_inline_style( 'admin-bar', $style );
- }
- static function sort_requires_connection_last( $module1, $module2 ) {
- if ( $module1['requires_connection'] == $module2['requires_connection'] ) {
- return 0;
- } elseif ( $module1['requires_connection'] ) {
- return 1;
- } elseif ( $module2['requires_connection'] ) {
- return -1;
- }
- return 0;
- }
- // Produce JS understandable objects of modules containing information for
- // presentation like description, name, configuration url, etc.
- function get_modules() {
- include_once JETPACK__PLUGIN_DIR . 'modules/module-info.php';
- $available_modules = Jetpack::get_available_modules();
- $active_modules = Jetpack::get_active_modules();
- $modules = array();
- $jetpack_active = Jetpack::is_connection_ready() || ( new Status() )->is_offline_mode();
- $overrides = Jetpack_Modules_Overrides::instance();
- foreach ( $available_modules as $module ) {
- if ( $module_array = Jetpack::get_module( $module ) ) {
- /**
- * Filters each module's short description.
- *
- * @since 3.0.0
- *
- * @param string $module_array['description'] Module description.
- * @param string $module Module slug.
- */
- $short_desc = apply_filters( 'jetpack_short_module_description', $module_array['description'], $module );
- // Fix: correct multibyte strings truncate with checking for mbstring extension
- $short_desc_trunc = ( function_exists( 'mb_strlen' ) )
- ? ( ( mb_strlen( $short_desc ) > 143 )
- ? mb_substr( $short_desc, 0, 140 ) . '...'
- : $short_desc )
- : ( ( strlen( $short_desc ) > 143 )
- ? substr( $short_desc, 0, 140 ) . '...'
- : $short_desc );
- $module_array['module'] = $module;
- $is_available = self::is_module_available( $module_array );
- $module_array['activated'] = ( $jetpack_active ? in_array( $module, $active_modules, true ) : false );
- $module_array['deactivate_nonce'] = wp_create_nonce( 'jetpack_deactivate-' . $module );
- $module_array['activate_nonce'] = wp_create_nonce( 'jetpack_activate-' . $module );
- $module_array['available'] = $is_available;
- $module_array['unavailable_reason'] = $is_available ? false : self::get_module_unavailable_reason( $module_array );
- $module_array['short_description'] = $short_desc_trunc;
- $module_array['configure_url'] = Jetpack::module_configuration_url( $module );
- $module_array['override'] = $overrides->get_module_override( $module );
- ob_start();
- /**
- * Allow the display of a "Learn More" button.
- * The dynamic part of the action, $module, is the module slug.
- *
- * @since 3.0.0
- */
- do_action( 'jetpack_learn_more_button_' . $module );
- $module_array['learn_more_button'] = ob_get_clean();
- ob_start();
- /**
- * Allow the display of information text when Jetpack is connected to WordPress.com.
- * The dynamic part of the action, $module, is the module slug.
- *
- * @since 3.0.0
- */
- do_action( 'jetpack_module_more_info_' . $module );
- /**
- * Filter the long description of a module.
- *
- * @since 3.5.0
- *
- * @param string ob_get_clean() The module long description.
- * @param string $module The module name.
- */
- $module_array['long_description'] = apply_filters( 'jetpack_long_module_description', ob_get_clean(), $module );
- ob_start();
- /**
- * Filter the search terms for a module
- *
- * Search terms are typically added to the module headers, under "Additional Search Queries".
- *
- * Use syntax:
- * function jetpack_$module_search_terms( $terms ) {
- * $terms = _x( 'term 1, term 2', 'search terms', 'jetpack' );
- * return $terms;
- * }
- * add_filter( 'jetpack_search_terms_$module', 'jetpack_$module_search_terms' );
- *
- * @since 3.5.0
- *
- * @param string The search terms (comma separated).
- */
- echo apply_filters( 'jetpack_search_terms_' . $module, $module_array['additional_search_queries'] );
- $module_array['search_terms'] = ob_get_clean();
- $module_array['configurable'] = false;
- if (
- current_user_can( 'manage_options' ) &&
- /**
- * Allow the display of a configuration link in the Jetpack Settings screen.
- *
- * @since 3.0.0
- *
- * @param string $module Module name.
- * @param bool false Should the Configure module link be displayed? Default to false.
- */
- apply_filters( 'jetpack_module_configurable_' . $module, false )
- ) {
- $module_array['configurable'] = sprintf( '<a href="%1$s">%2$s</a>', esc_url( $module_array['configure_url'] ), __( 'Configure', 'jetpack' ) );
- }
- $modules[ $module ] = $module_array;
- }
- }
- uasort( $modules, array( 'Jetpack', 'sort_modules' ) );
- if ( ! Jetpack::is_connection_ready() ) {
- uasort( $modules, array( __CLASS__, 'sort_requires_connection_last' ) );
- }
- return $modules;
- }
- static function is_module_available( $module ) {
- if ( ! is_array( $module ) || empty( $module ) ) {
- return false;
- }
- /**
- * We never want to show VaultPress as activatable through Jetpack.
- */
- if ( 'vaultpress' === $module['module'] ) {
- return false;
- }
- /*
- * WooCommerce Analytics should only be available
- * when running WooCommerce 3+
- */
- if (
- 'woocommerce-analytics' === $module['module']
- && (
- ! class_exists( 'WooCommerce' )
- || version_compare( WC_VERSION, '3.0', '<' )
- )
- ) {
- return false;
- }
- /*
- * In Offline mode, modules that require a site or user
- * level connection should be unavailable.
- */
- if ( ( new Status() )->is_offline_mode() ) {
- return ! ( $module['requires_connection'] || $module['requires_user_connection'] );
- }
- /*
- * Jetpack not connected.
- */
- if ( ! Jetpack::is_connection_ready() ) {
- return false;
- }
- /*
- * Jetpack connected at a site level only. Make sure to make
- * modules that require a user connection unavailable.
- */
- if ( ! Jetpack::connection()->has_connected_owner() && $module['requires_user_connection'] ) {
- return false;
- }
- return Jetpack_Plan::supports( $module['module'] );
- }
- /**
- * Returns why a module is unavailable.
- *
- * @param array $module The module.
- * @return string|false A string stating why the module is not available or false if the module is available.
- */
- public static function get_module_unavailable_reason( $module ) {
- if ( ! is_array( $module ) || empty( $module ) ) {
- return false;
- }
- if ( self::is_module_available( $module ) ) {
- return false;
- }
- /**
- * We never want to show VaultPress as activatable through Jetpack so return an empty string.
- */
- if ( 'vaultpress' === $module['module'] ) {
- return '';
- }
- /*
- * WooCommerce Analytics should only be available
- * when running WooCommerce 3+
- */
- if (
- 'woocommerce-analytics' === $module['module']
- && (
- ! class_exists( 'WooCommerce' )
- || version_compare( WC_VERSION, '3.0', '<' )
- )
- ) {
- return __( 'Requires WooCommerce 3+ plugin', 'jetpack' );
- }
- /*
- * In Offline mode, modules that require a site or user
- * level connection should be unavailable.
- */
- if ( ( new Status() )->is_offline_mode() ) {
- if ( $module['requires_connection'] || $module['requires_user_connection'] ) {
- return __( 'Offline mode', 'jetpack' );
- }
- }
- /*
- * Jetpack not connected.
- */
- if ( ! Jetpack::is_connection_ready() ) {
- return __( 'Jetpack is not connected', 'jetpack' );
- }
- /*
- * Jetpack connected at a site level only and module requires a user connection.
- */
- if ( ! Jetpack::connection()->has_connected_owner() && $module['requires_user_connection'] ) {
- return __( 'Requires a connected WordPress.com account', 'jetpack' );
- }
- /*
- * Plan restrictions.
- */
- if ( ! Jetpack_Plan::supports( $module['module'] ) ) {
- return __( 'Not supported by current plan', 'jetpack' );
- }
- return '';
- }
- function handle_unrecognized_action( $action ) {
- switch ( $action ) {
- case 'bulk-activate':
- if ( ! current_user_can( 'jetpack_activate_modules' ) ) {
- break;
- }
- $modules = (array) $_GET['modules'];
- $modules = array_map( 'sanitize_key', $modules );
- check_admin_referer( 'bulk-jetpack_page_jetpack_modules' );
- foreach ( $modules as $module ) {
- Jetpack::log( 'activate', $module );
- Jetpack::activate_module( $module, false );
- }
- // The following two lines will rarely happen, as Jetpack::activate_module normally exits at the end.
- wp_safe_redirect( wp_get_referer() );
- exit;
- case 'bulk-deactivate':
- if ( ! current_user_can( 'jetpack_deactivate_modules' ) ) {
- break;
- }
- $modules = (array) $_GET['modules'];
- $modules = array_map( 'sanitize_key', $modules );
- check_admin_referer( 'bulk-jetpack_page_jetpack_modules' );
- foreach ( $modules as $module ) {
- Jetpack::log( 'deactivate', $module );
- Jetpack::deactivate_module( $module );
- Jetpack::state( 'message', 'module_deactivated' );
- }
- Jetpack::state( 'module', $modules );
- wp_safe_redirect( wp_get_referer() );
- exit;
- default:
- return;
- }
- }
- function fix_redirect( $module, $redirect = true ) {
- if ( ! $redirect ) {
- return;
- }
- if ( wp_get_referer() ) {
- add_filter( 'wp_redirect', 'wp_get_referer' );
- }
- }
- function admin_menu_debugger() {
- jetpack_require_lib( 'debugger' );
- Jetpack_Debugger::disconnect_and_redirect();
- $debugger_hook = add_submenu_page(
- null,
- __( 'Debugging Center', 'jetpack' ),
- '',
- 'manage_options',
- 'jetpack-debugger',
- array( $this, 'wrap_debugger_page' )
- );
- add_action( "admin_head-$debugger_hook", array( 'Jetpack_Debugger', 'jetpack_debug_admin_head' ) );
- }
- function wrap_debugger_page() {
- nocache_headers();
- if ( ! current_user_can( 'manage_options' ) ) {
- die( '-1' );
- }
- Jetpack_Admin_Page::wrap_ui( array( $this, 'debugger_page' ) );
- }
- function debugger_page() {
- jetpack_require_lib( 'debugger' );
- Jetpack_Debugger::jetpack_debug_display_handler();
- }
- /**
- * Determines if JITMs should display on a particular screen.
- *
- * @param bool $value The default value of the filter.
- * @param string $screen_id The ID of the screen being tested for JITM display.
- *
- * @return bool True if JITMs should display, false otherwise.
- */
- public function should_display_jitms_on_screen( $value, $screen_id ) {
- // Disable all JITMs on these pages.
- if (
- in_array(
- $screen_id,
- array(
- 'jetpack_page_akismet-key-config',
- 'admin_page_jetpack_modules',
- ),
- true
- ) ) {
- return false;
- }
- // Disable all JITMs on pages where the recommendations banner is displaying.
- if (
- in_array(
- $screen_id,
- array(
- 'dashboard',
- 'plugins',
- 'jetpack_page_stats',
- ),
- true
- )
- && \Jetpack_Recommendations_Banner::can_be_displayed()
- ) {
- return false;
- }
- return $value;
- }
- }
- Jetpack_Admin::init();
|