diff options
Diffstat (limited to 'plugins/jetpack/modules/masterbar/admin-menu/class-atomic-admin-menu.php')
| -rw-r--r-- | plugins/jetpack/modules/masterbar/admin-menu/class-atomic-admin-menu.php | 427 |
1 files changed, 427 insertions, 0 deletions
diff --git a/plugins/jetpack/modules/masterbar/admin-menu/class-atomic-admin-menu.php b/plugins/jetpack/modules/masterbar/admin-menu/class-atomic-admin-menu.php new file mode 100644 index 00000000..b3bd7c64 --- /dev/null +++ b/plugins/jetpack/modules/masterbar/admin-menu/class-atomic-admin-menu.php @@ -0,0 +1,427 @@ +<?php +/** + * Atomic Admin Menu file. + * + * @package automattic/jetpack + */ + +namespace Automattic\Jetpack\Dashboard_Customizations; + +use Automattic\Jetpack\Connection\Client; +use Jetpack_Plan; + +require_once __DIR__ . '/class-admin-menu.php'; + +/** + * Class Atomic_Admin_Menu. + */ +class Atomic_Admin_Menu extends Admin_Menu { + + /** + * Atomic_Admin_Menu constructor. + */ + protected function __construct() { + parent::__construct(); + + add_action( 'wp_enqueue_scripts', array( $this, 'dequeue_scripts' ), 20 ); + add_action( 'admin_enqueue_scripts', array( $this, 'dequeue_scripts' ), 20 ); + add_action( 'wp_ajax_sidebar_state', array( $this, 'ajax_sidebar_state' ) ); + add_action( 'wp_ajax_jitm_dismiss', array( $this, 'wp_ajax_jitm_dismiss' ) ); + + if ( ! $this->is_api_request ) { + add_filter( 'submenu_file', array( $this, 'override_the_theme_installer' ), 10, 2 ); + } + + add_action( + 'admin_menu', + function () { + remove_action( 'admin_menu', 'gutenberg_menu', 9 ); + }, + 0 + ); + } + + /** + * Dequeues unnecessary scripts. + */ + public function dequeue_scripts() { + wp_dequeue_script( 'a8c_wpcom_masterbar_overrides' ); // Initially loaded in modules/masterbar/masterbar/class-masterbar.php. + } + + /** + * Determines whether the current locale is right-to-left (RTL). + * + * Performs the check against the current locale set on the WordPress.com's account settings. + * See `Masterbar::__construct` in `modules/masterbar/masterbar/class-masterbar.php`. + */ + public function is_rtl() { + return get_user_option( 'jetpack_wpcom_is_rtl' ); + } + + /** + * Create the desired menu output. + */ + public function reregister_menu_items() { + parent::reregister_menu_items(); + + $this->add_my_home_menu(); + $this->add_inbox_menu(); + $this->hide_search_menu_for_calypso(); + + // Not needed outside of wp-admin. + if ( ! $this->is_api_request ) { + $this->add_browse_sites_link(); + $this->add_site_card_menu(); + $nudge = $this->get_upsell_nudge(); + if ( $nudge ) { + parent::add_upsell_nudge( $nudge ); + } + + $this->add_new_site_link(); + } + + $this->add_woocommerce_installation_menu(); + + ksort( $GLOBALS['menu'] ); + } + + /** + * Get the preferred view for the given screen. + * + * @param string $screen Screen identifier. + * @param bool $fallback_global_preference (Optional) Whether the global preference for all screens should be used + * as fallback if there is no specific preference for the given screen. + * Default: true. + * @return string + */ + public function get_preferred_view( $screen, $fallback_global_preference = true ) { + // Export on Atomic sites are always managed on WP Admin. + if ( in_array( $screen, array( 'export.php' ), true ) ) { + return self::CLASSIC_VIEW; + } + + /** + * When Jetpack SSO is disabled, we need to force Calypso because it might create confusion to be redirected to WP-Admin. + * Furthermore, because we don't display the quick switcher, users having an WP-Admin interface by default won't be able to go back to the Calyso version. + */ + if ( ! \Jetpack::is_module_active( 'sso' ) ) { + return self::DEFAULT_VIEW; + } + + return parent::get_preferred_view( $screen, $fallback_global_preference ); + } + + /** + * Adds Plugins menu. + */ + public function add_plugins_menu() { + global $submenu; + if ( + isset( $submenu['plugins.php'] ) + /** + * Whether to enable the marketplace feature entrypoint. + * This filter is specific to WPCOM, that's why there is no + * need to use `jetpack_` prefix. + * + * @use add_filter( 'wpcom_marketplace_enabled', '__return_true' ); + * @module masterbar + * @since 10.3 + * @param bool $wpcom_marketplace_enabled Load the WordPress.com Marketplace feature. Default to false. + */ + && apply_filters( 'wpcom_marketplace_enabled', false ) + ) { + $plugins_submenu = $submenu['plugins.php']; + $slug_to_update = 'plugin-install.php'; + + // Move "Add New" plugin submenu ( `plugin-install.php` ) to the top position. + foreach ( $plugins_submenu as $submenu_key => $submenu_keys ) { + if ( $submenu_keys[2] === $slug_to_update ) { + // phpcs:ignore WordPress.WP.GlobalVariablesOverride.Prohibited + $submenu['plugins.php'] = array( $submenu_key => $plugins_submenu[ $submenu_key ] ) + $plugins_submenu; + } + } + + $submenus_to_update = array( $slug_to_update => 'https://wordpress.com/plugins/' . $this->domain ); + $this->update_submenus( 'plugins.php', $submenus_to_update ); + } + } + + /** + * Adds the site switcher link if user has more than one site. + */ + public function add_browse_sites_link() { + $site_count = get_user_option( 'wpcom_site_count' ); + if ( ! $site_count || $site_count < 2 ) { + return; + } + + // Add the menu item. + add_menu_page( __( 'site-switcher', 'jetpack' ), __( 'Browse sites', 'jetpack' ), 'read', 'https://wordpress.com/home', null, 'dashicons-arrow-left-alt2', 0 ); + add_filter( 'add_menu_classes', array( $this, 'set_browse_sites_link_class' ) ); + } + + /** + * Adds a custom element class for Site Switcher menu item. + * + * @param array $menu Associative array of administration menu items. + * + * @return array + */ + public function set_browse_sites_link_class( array $menu ) { + foreach ( $menu as $key => $menu_item ) { + if ( 'site-switcher' !== $menu_item[3] ) { + continue; + } + + $menu[ $key ][4] = add_cssclass( 'site-switcher', $menu_item[4] ); + break; + } + + return $menu; + } + + /** + * Adds a link to the menu to create a new site. + */ + public function add_new_site_link() { + $site_count = get_user_option( 'wpcom_site_count' ); + if ( $site_count && $site_count > 1 ) { + return; + } + + $this->add_admin_menu_separator(); + add_menu_page( __( 'Add New Site', 'jetpack' ), __( 'Add New Site', 'jetpack' ), 'read', 'https://wordpress.com/start?ref=calypso-sidebar', null, 'dashicons-plus-alt' ); + } + + /** + * Adds site card component. + */ + public function add_site_card_menu() { + $default = 'data:image/svg+xml,' . rawurlencode( '<svg class="gridicon" xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><title>Globe</title><rect fill-opacity="0" x="0" width="24" height="24"/><g><path fill="#fff" d="M12 2C6.477 2 2 6.477 2 12s4.477 10 10 10 10-4.477 10-10S17.523 2 12 2zm0 18l2-2 1-1v-2h-2v-1l-1-1H9v3l2 2v1.93c-3.94-.494-7-3.858-7-7.93l1 1h2v-2h2l3-3V6h-2L9 5v-.41C9.927 4.21 10.94 4 12 4s2.073.212 3 .59V6l-1 1v2l1 1 3.13-3.13c.752.897 1.304 1.964 1.606 3.13H18l-2 2v2l1 1h2l.286.286C18.03 18.06 15.24 20 12 20z"/></g></svg>' ); + $icon = get_site_icon_url( 32, $default ); + $blog_name = get_option( 'blogname' ) !== '' ? get_option( 'blogname' ) : $this->domain; + $is_coming_soon = ( function_exists( 'site_is_coming_soon' ) && site_is_coming_soon() ) || (bool) get_option( 'wpcom_public_coming_soon' ); + + $badge = ''; + if ( ( function_exists( 'site_is_private' ) && site_is_private() ) || $is_coming_soon ) { + $badge .= sprintf( + '<span class="site__badge site__badge-private">%s</span>', + $is_coming_soon ? esc_html__( 'Coming Soon', 'jetpack' ) : esc_html__( 'Private', 'jetpack' ) + ); + } + + $site_card = ' +<div class="site__info"> + <div class="site__title">%1$s</div> + <div class="site__domain">%2$s</div> + %3$s +</div>'; + + $site_card = sprintf( + $site_card, + $blog_name, + $this->domain, + $badge + ); + + add_menu_page( 'site-card', $site_card, 'read', get_home_url(), null, $icon, 1 ); + add_filter( 'add_menu_classes', array( $this, 'set_site_card_menu_class' ) ); + } + + /** + * Adds a custom element class and id for Site Card's menu item. + * + * @param array $menu Associative array of administration menu items. + * + * @return array + */ + public function set_site_card_menu_class( array $menu ) { + foreach ( $menu as $key => $menu_item ) { + if ( 'site-card' !== $menu_item[3] ) { + continue; + } + + $classes = ' toplevel_page_site-card'; + + // webclip.png is the default on WoA sites. Anything other than that means we have a custom site icon. + if ( has_site_icon() && 'https://s0.wp.com/i/webclip.png' !== get_site_icon_url( 512 ) ) { + $classes .= ' has-site-icon'; + } + + $menu[ $key ][4] = $menu_item[4] . $classes; + $menu[ $key ][5] = 'toplevel_page_site_card'; + break; + } + + return $menu; + } + + /** + * Returns the first available upsell nudge. + * + * @return array + */ + public function get_upsell_nudge() { + $jitm = \Automattic\Jetpack\JITMS\JITM::get_instance(); + $message_path = 'calypso:sites:sidebar_notice'; + $message = $jitm->get_messages( $message_path, wp_json_encode( array( 'message_path' => $message_path ) ), false ); + + if ( isset( $message[0] ) ) { + $message = $message[0]; + return array( + 'content' => $message->content->message, + 'cta' => $message->CTA->message, // phpcs:ignore WordPress.NamingConventions.ValidVariableName.UsedPropertyNotSnakeCase + 'link' => $message->CTA->link, // phpcs:ignore WordPress.NamingConventions.ValidVariableName.UsedPropertyNotSnakeCase + 'tracks_impression_event_name' => $message->tracks->display->name, + 'tracks_impression_cta_name' => $message->tracks->display->props->cta_name, + 'tracks_click_event_name' => $message->tracks->click->name, + 'tracks_click_cta_name' => $message->tracks->click->props->cta_name, + 'dismissible' => $message->is_dismissible, + 'feature_class' => $message->feature_class, + 'id' => $message->id, + ); + } + } + + /** + * Adds Stats menu. + */ + public function add_stats_menu() { + $menu_title = __( 'Stats', 'jetpack' ); + + if ( + ! $this->is_api_request && + \Jetpack::is_module_active( 'stats' ) && + function_exists( 'stats_get_image_chart_src' ) + ) { + $img_src = esc_attr( + stats_get_image_chart_src( 'admin-bar-hours-scale-2x', array( 'masterbar' => '' ) ) + ); + $alt = esc_attr__( 'Hourly views', 'jetpack' ); + + $menu_title .= "<img class='sidebar-unified__sparkline' src='$img_src' width='80' height='20' alt='$alt'>"; + } + + add_menu_page( __( 'Stats', 'jetpack' ), $menu_title, 'edit_posts', 'https://wordpress.com/stats/day/' . $this->domain, null, 'dashicons-chart-bar', 3 ); + } + + /** + * Adds Upgrades menu. + * + * @param string $plan The current WPCOM plan of the blog. + */ + public function add_upgrades_menu( $plan = null ) { + $products = Jetpack_Plan::get(); + if ( array_key_exists( 'product_name_short', $products ) ) { + $plan = $products['product_name_short']; + } + parent::add_upgrades_menu( $plan ); + + $last_upgrade_submenu_position = $this->get_submenu_item_count( 'paid-upgrades.php' ); + + add_submenu_page( 'paid-upgrades.php', __( 'Domains', 'jetpack' ), __( 'Domains', 'jetpack' ), 'manage_options', 'https://wordpress.com/domains/manage/' . $this->domain, null, $last_upgrade_submenu_position - 1 ); + + /** + * Whether to show the WordPress.com Emails submenu under the main Upgrades menu. + * + * @use add_filter( 'jetpack_show_wpcom_upgrades_email_menu', '__return_true' ); + * @module masterbar + * + * @since 9.7.0 + * + * @param bool $show_wpcom_upgrades_email_menu Load the WordPress.com Emails submenu item. Default to false. + */ + if ( apply_filters( 'jetpack_show_wpcom_upgrades_email_menu', false ) ) { + add_submenu_page( 'paid-upgrades.php', __( 'Emails', 'jetpack' ), __( 'Emails', 'jetpack' ), 'manage_options', 'https://wordpress.com/email/' . $this->domain, null, $last_upgrade_submenu_position ); + } + } + + /** + * Adds Settings menu. + */ + public function add_options_menu() { + parent::add_options_menu(); + + if ( Jetpack_Plan::supports( 'security-settings' ) ) { + add_submenu_page( + 'options-general.php', + esc_attr__( 'Security', 'jetpack' ), + __( 'Security', 'jetpack' ), + 'manage_options', + 'https://wordpress.com/settings/security/' . $this->domain, + null, + 2 + ); + } + add_submenu_page( 'options-general.php', esc_attr__( 'Hosting Configuration', 'jetpack' ), __( 'Hosting Configuration', 'jetpack' ), 'manage_options', 'https://wordpress.com/hosting-config/' . $this->domain, null, 11 ); + add_submenu_page( 'options-general.php', esc_attr__( 'Jetpack', 'jetpack' ), __( 'Jetpack', 'jetpack' ), 'manage_options', 'https://wordpress.com/settings/jetpack/' . $this->domain, null, 12 ); + + // Page Optimize is active by default on all Atomic sites and registers a Settings > Performance submenu which + // would conflict with our own Settings > Performance that links to Calypso, so we hide it it since the Calypso + // performance settings already have a link to Page Optimize settings page. + $this->hide_submenu_page( 'options-general.php', 'page-optimize' ); + } + + /** + * Override the global submenu_file for theme-install.php page so the WP Admin menu item gets highlighted correctly. + * + * @param string $submenu_file The current pages $submenu_file global variable value. + * @return string | null + */ + public function override_the_theme_installer( $submenu_file ) { + global $pagenow; + + if ( 'themes.php' === $submenu_file && 'theme-install.php' === $pagenow ) { + return null; + } + return $submenu_file; + } + + /** + * Also remove the Gutenberg plugin menu. + */ + public function add_gutenberg_menus() { + // Always remove the Gutenberg menu. + remove_menu_page( 'gutenberg' ); + parent::add_gutenberg_menus(); + } + + /** + * Saves the sidebar state ( expanded / collapsed ) via an ajax request. + */ + public function ajax_sidebar_state() { + $expanded = filter_var( $_REQUEST['expanded'], FILTER_VALIDATE_BOOLEAN ); // phpcs:ignore WordPress.Security.NonceVerification.Recommended + Client::wpcom_json_api_request_as_user( + '/me/preferences', + '2', + array( + 'method' => 'POST', + ), + (object) array( 'calypso_preferences' => (object) array( 'sidebarCollapsed' => ! $expanded ) ), + 'wpcom' + ); + + wp_die(); + } + + /** + * Handle ajax requests to dismiss a just-in-time-message + */ + public function wp_ajax_jitm_dismiss() { + check_ajax_referer( 'jitm_dismiss' ); + $jitm = \Automattic\Jetpack\JITMS\JITM::get_instance(); + $jitm->dismiss( $_REQUEST['id'], $_REQUEST['feature_class'] ); + wp_die(); + } + + /** + * Hide Calypso Search menu for Atomic sites. + * + * For simple sites, where search dashboard doesn't exist, we use the Calypso page / menu item. + * For Atomic sites, the admin-menu is originated from the sites and forwarded by WPCOM `public-api`. + * We have search dashboard for Atomic/JP sites, so we need to hide the duplicated menu item. + */ + public function hide_search_menu_for_calypso() { + $this->hide_submenu_page( 'jetpack', 'https://wordpress.com/jetpack-search/' . $this->domain ); + } +} |