summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
Diffstat (limited to 'plugins/jetpack/class.jetpack-admin.php')
-rw-r--r--plugins/jetpack/class.jetpack-admin.php222
1 files changed, 187 insertions, 35 deletions
diff --git a/plugins/jetpack/class.jetpack-admin.php b/plugins/jetpack/class.jetpack-admin.php
index 40cabfdb..bf2c0c72 100644
--- a/plugins/jetpack/class.jetpack-admin.php
+++ b/plugins/jetpack/class.jetpack-admin.php
@@ -1,33 +1,56 @@
-<?php
+<?php // phpcs:ignore WordPress.Files.FileName.InvalidClassFileName
+/**
+ * Build the Jetpack admin menu as a whole.
+ *
+ * @package automattic/jetpack
+ */
use Automattic\Jetpack\Assets\Logo as Jetpack_Logo;
use Automattic\Jetpack\Partner_Coupon as Jetpack_Partner_Coupon;
use Automattic\Jetpack\Status;
+use Automattic\Jetpack\Status\Host;
-// Build the Jetpack admin menu as a whole
+/**
+ * Build the Jetpack admin menu as a whole.
+ */
class Jetpack_Admin {
/**
+ * Static instance.
+ *
* @var Jetpack_Admin
- **/
+ */
private static $instance = null;
- static function init() {
- if ( isset( $_GET['page'] ) && $_GET['page'] === 'jetpack' ) {
+ /**
+ * Initialize and fetch the static instance.
+ *
+ * @return self
+ */
+ public static function init() {
+ // phpcs:ignore WordPress.Security.NonceVerification.Recommended
+ if ( isset( $_GET['page'] ) && 'jetpack' === $_GET['page'] ) {
add_filter( 'nocache_headers', array( 'Jetpack_Admin', 'add_no_store_header' ), 100 );
}
- if ( is_null( self::$instance ) ) {
+ if ( self::$instance === null ) {
self::$instance = new Jetpack_Admin();
}
return self::$instance;
}
- static function add_no_store_header( $headers ) {
+ /**
+ * Filter callback to add `no-store` to the `Cache-Control` header.
+ *
+ * @param array $headers Headers array.
+ * @return array Modified headers array.
+ */
+ public static function add_no_store_header( $headers ) {
$headers['Cache-Control'] .= ', no-store';
return $headers;
}
+ /** Constructor. */
private function __construct() {
jetpack_require_lib( 'admin-pages/class.jetpack-react-page' );
$this->jetpack_react = new Jetpack_React_Page();
@@ -38,23 +61,19 @@ class Jetpack_Admin {
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 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_action( 'jetpack_pre_deactivate_module', array( $this, 'fix_redirect' ), 10, 2 );
- // Add module bulk actions handler
+ // Add module bulk actions handler.
add_action( 'jetpack_unrecognized_action', array( $this, 'handle_unrecognized_action' ) );
if ( class_exists( 'Akismet_Admin' ) ) {
@@ -82,6 +101,9 @@ class Jetpack_Admin {
}
}
+ // Ensure an Additional CSS menu item is added to the Appearance menu whenever Jetpack is connected.
+ add_action( 'admin_menu', array( $this, 'additional_css_menu' ) );
+
add_filter( 'jetpack_display_jitms_on_screen', array( $this, 'should_display_jitms_on_screen' ), 10, 2 );
// Register Jetpack partner coupon hooks.
@@ -93,15 +115,116 @@ class Jetpack_Admin {
* 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 = new Jetpack_Logo();
+ // phpcs:ignore WordPress.PHP.DiscouragedPHPFunctions.obfuscation_base64_encode
$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'] ) {
+ /**
+ * Handle our Additional CSS menu item and legacy page declaration.
+ *
+ * @since 11.0 . Prior to that, this function was located in custom-css-4.7.php.
+ */
+ public static function additional_css_menu() {
+
+ // If the site is a WoA site and the custom-css feature is not available, return.
+ // See https://github.com/Automattic/jetpack/pull/19965 for more on how this menu item is dealt with on WoA sites.
+ if ( ( new Host() )->is_woa_site() && ! ( in_array( 'custom-css', Jetpack::get_available_modules(), true ) ) ) {
+ return;
+ } elseif ( class_exists( 'Jetpack' ) && Jetpack::is_module_active( 'custom-css' ) ) { // If the Custom CSS module is enabled, add the Additional CSS menu item and link to the Customizer.
+ // Add in our legacy page to support old bookmarks and such.
+ add_submenu_page( null, __( 'CSS', 'jetpack' ), __( 'Additional CSS', 'jetpack' ), 'edit_theme_options', 'editcss', array( __CLASS__, 'customizer_redirect' ) );
+
+ // Add in our new page slug that will redirect to the customizer.
+ $hook = add_theme_page( __( 'CSS', 'jetpack' ), __( 'Additional CSS', 'jetpack' ), 'edit_theme_options', 'editcss-customizer-redirect', array( __CLASS__, 'customizer_redirect' ) );
+ add_action( "load-{$hook}", array( __CLASS__, 'customizer_redirect' ) );
+ } else { // Link to the Jetpack Settings > Writing page, highlighting the Custom CSS setting.
+ add_submenu_page( null, __( 'CSS', 'jetpack' ), __( 'Additional CSS', 'jetpack' ), 'edit_theme_options', 'editcss', array( __CLASS__, 'theme_enhancements_redirect' ) );
+
+ $hook = add_theme_page( __( 'CSS', 'jetpack' ), __( 'Additional CSS', 'jetpack' ), 'edit_theme_options', 'editcss-theme-enhancements-redirect', array( __CLASS__, 'theme_enhancements_redirect' ) );
+ add_action( "load-{$hook}", array( __CLASS__, 'theme_enhancements_redirect' ) );
+ }
+
+ }
+
+ /**
+ * Handle the redirect for the customizer. This is necessary because
+ * we can't directly add customizer links to the admin menu.
+ *
+ * @since 11.0 . Prior to that, this function was located in custom-css-4.7.php.
+ *
+ * There is a core patch in trac that would make this unnecessary.
+ *
+ * @link https://core.trac.wordpress.org/ticket/39050
+ */
+ public static function customizer_redirect() {
+ wp_safe_redirect(
+ self::customizer_link(
+ array(
+ 'return_url' => wp_get_referer(),
+ )
+ )
+ );
+ exit;
+ }
+
+ /**
+ * Handle the Additional CSS redirect to the Jetpack settings Theme Enhancements section.
+ *
+ * @since 11.0
+ */
+ public static function theme_enhancements_redirect() {
+ wp_safe_redirect(
+ 'admin.php?page=jetpack#/writing?term=Custom%20CSS'
+ );
+ exit;
+ }
+
+ /**
+ * Build the URL to deep link to the Customizer.
+ *
+ * You can modify the return url via $args.
+ *
+ * @since 11.0 in this file. This method is also located in custom-css-4.7.php to cover legacy scenarios.
+ *
+ * @param array $args Array of parameters.
+ * @return string
+ */
+ public static function customizer_link( $args = array() ) {
+ if ( isset( $_SERVER['REQUEST_URI'] ) ) {
+ $args = wp_parse_args(
+ $args,
+ array(
+ 'return_url' => rawurlencode( wp_unslash( $_SERVER['REQUEST_URI'] ) ), // phpcs:ignore WordPress.Security.ValidatedSanitizedInput.InputNotSanitized
+ )
+ );
+ }
+
+ return add_query_arg(
+ array(
+ array(
+ 'autofocus' => array(
+ 'section' => 'custom_css',
+ ),
+ ),
+ 'return' => $args['return_url'],
+ ),
+ admin_url( 'customize.php' )
+ );
+ }
+
+ /**
+ * Sort callback to put modules with `requires_connection` last.
+ *
+ * @param array $module1 Module data.
+ * @param array $module2 Module data.
+ * @return int Indicating the relative ordering of module1 and module2.
+ */
+ public static function sort_requires_connection_last( $module1, $module2 ) {
+ if ( (bool) $module1['requires_connection'] === (bool) $module2['requires_connection'] ) {
return 0;
} elseif ( $module1['requires_connection'] ) {
return 1;
@@ -112,9 +235,11 @@ class Jetpack_Admin {
return 0;
}
- // Produce JS understandable objects of modules containing information for
- // presentation like description, name, configuration url, etc.
- function get_modules() {
+ /**
+ * Produce JS understandable objects of modules containing information for
+ * presentation like description, name, configuration url, etc.
+ */
+ public function get_modules() {
include_once JETPACK__PLUGIN_DIR . 'modules/module-info.php';
$available_modules = Jetpack::get_available_modules();
$active_modules = Jetpack::get_active_modules();
@@ -122,7 +247,8 @@ class Jetpack_Admin {
$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 ) ) {
+ $module_array = Jetpack::get_module( $module );
+ if ( $module_array ) {
/**
* Filters each module's short description.
*
@@ -132,7 +258,7 @@ class Jetpack_Admin {
* @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
+ // 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 ) . '...'
@@ -200,7 +326,7 @@ class Jetpack_Admin {
*
* @param string The search terms (comma separated).
*/
- echo apply_filters( 'jetpack_search_terms_' . $module, $module_array['additional_search_queries'] );
+ echo apply_filters( 'jetpack_search_terms_' . $module, $module_array['additional_search_queries'] ); // phpcs:ignore WordPress.Security.EscapeOutput.OutputNotEscaped
$module_array['search_terms'] = ob_get_clean();
$module_array['configurable'] = false;
@@ -232,7 +358,12 @@ class Jetpack_Admin {
return $modules;
}
- static function is_module_available( $module ) {
+ /**
+ * Check if a module is available.
+ *
+ * @param array $module Module data.
+ */
+ public static function is_module_available( $module ) {
if ( ! is_array( $module ) || empty( $module ) ) {
return false;
}
@@ -355,16 +486,20 @@ class Jetpack_Admin {
return '';
}
- function handle_unrecognized_action( $action ) {
+ /**
+ * Handle an unrecognized action.
+ *
+ * @param string $action Action.
+ */
+ public function handle_unrecognized_action( $action ) {
switch ( $action ) {
case 'bulk-activate':
+ check_admin_referer( 'bulk-jetpack_page_jetpack_modules' );
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' );
+ $modules = isset( $_GET['modules'] ) ? array_map( 'sanitize_key', wp_unslash( (array) $_GET['modules'] ) ) : array();
foreach ( $modules as $module ) {
Jetpack::log( 'activate', $module );
Jetpack::activate_module( $module, false );
@@ -373,13 +508,12 @@ class Jetpack_Admin {
wp_safe_redirect( wp_get_referer() );
exit;
case 'bulk-deactivate':
+ check_admin_referer( 'bulk-jetpack_page_jetpack_modules' );
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' );
+ $modules = isset( $_GET['modules'] ) ? array_map( 'sanitize_key', wp_unslash( (array) $_GET['modules'] ) ) : array();
foreach ( $modules as $module ) {
Jetpack::log( 'deactivate', $module );
Jetpack::deactivate_module( $module );
@@ -393,7 +527,16 @@ class Jetpack_Admin {
}
}
- function fix_redirect( $module, $redirect = true ) {
+ /**
+ * Fix redirect.
+ *
+ * Apparently we redirect to the referrer instead of whatever WordPress
+ * wants to redirect to when activating and deactivating modules.
+ *
+ * @param string $module Module slug.
+ * @param bool $redirect Should we exit after the module has been activated. Default to true.
+ */
+ public function fix_redirect( $module, $redirect = true ) {
if ( ! $redirect ) {
return;
}
@@ -402,7 +545,10 @@ class Jetpack_Admin {
}
}
- function admin_menu_debugger() {
+ /**
+ * Add debugger admin menu.
+ */
+ public function admin_menu_debugger() {
jetpack_require_lib( 'debugger' );
Jetpack_Debugger::disconnect_and_redirect();
$debugger_hook = add_submenu_page(
@@ -416,7 +562,10 @@ class Jetpack_Admin {
add_action( "admin_head-$debugger_hook", array( 'Jetpack_Debugger', 'jetpack_debug_admin_head' ) );
}
- function wrap_debugger_page() {
+ /**
+ * Wrap debugger page.
+ */
+ public function wrap_debugger_page() {
nocache_headers();
if ( ! current_user_can( 'manage_options' ) ) {
die( '-1' );
@@ -424,7 +573,10 @@ class Jetpack_Admin {
Jetpack_Admin_Page::wrap_ui( array( $this, 'debugger_page' ) );
}
- function debugger_page() {
+ /**
+ * Display debugger page.
+ */
+ public function debugger_page() {
jetpack_require_lib( 'debugger' );
Jetpack_Debugger::jetpack_debug_display_handler();
}