class.jetpack-admin.php
| 1 | <?php |
| 2 | |
| 3 | use Automattic\Jetpack\Status; |
| 4 | |
| 5 | // Build the Jetpack admin menu as a whole |
| 6 | class Jetpack_Admin { |
| 7 | |
| 8 | /** |
| 9 | * @var Jetpack_Admin |
| 10 | **/ |
| 11 | private static $instance = null; |
| 12 | |
| 13 | static function init() { |
| 14 | if ( isset( $_GET['page'] ) && $_GET['page'] === 'jetpack' ) { |
| 15 | add_filter( 'nocache_headers', array( 'Jetpack_Admin', 'add_no_store_header' ), 100 ); |
| 16 | } |
| 17 | |
| 18 | if ( is_null( self::$instance ) ) { |
| 19 | self::$instance = new Jetpack_Admin(); |
| 20 | } |
| 21 | return self::$instance; |
| 22 | } |
| 23 | |
| 24 | static function add_no_store_header( $headers ) { |
| 25 | $headers['Cache-Control'] .= ', no-store'; |
| 26 | return $headers; |
| 27 | } |
| 28 | |
| 29 | private function __construct() { |
| 30 | jetpack_require_lib( 'admin-pages/class.jetpack-react-page' ); |
| 31 | $this->jetpack_react = new Jetpack_React_Page(); |
| 32 | |
| 33 | jetpack_require_lib( 'admin-pages/class.jetpack-settings-page' ); |
| 34 | $this->fallback_page = new Jetpack_Settings_Page(); |
| 35 | |
| 36 | jetpack_require_lib( 'admin-pages/class-jetpack-about-page' ); |
| 37 | $this->jetpack_about = new Jetpack_About_Page(); |
| 38 | |
| 39 | add_action( 'admin_menu', array( $this->jetpack_react, 'add_actions' ), 998 ); |
| 40 | add_action( 'jetpack_admin_menu', array( $this->jetpack_react, 'jetpack_add_dashboard_sub_nav_item' ) ); |
| 41 | add_action( 'jetpack_admin_menu', array( $this->jetpack_react, 'jetpack_add_settings_sub_nav_item' ) ); |
| 42 | add_action( 'jetpack_admin_menu', array( $this, 'admin_menu_debugger' ) ); |
| 43 | add_action( 'jetpack_admin_menu', array( $this->fallback_page, 'add_actions' ) ); |
| 44 | add_action( 'jetpack_admin_menu', array( $this->jetpack_about, 'add_actions' ) ); |
| 45 | |
| 46 | // Add redirect to current page for activation/deactivation of modules |
| 47 | add_action( 'jetpack_pre_activate_module', array( $this, 'fix_redirect' ), 10, 2 ); |
| 48 | add_action( 'jetpack_pre_deactivate_module', array( $this, 'fix_redirect' ) ); |
| 49 | |
| 50 | // Add module bulk actions handler |
| 51 | add_action( 'jetpack_unrecognized_action', array( $this, 'handle_unrecognized_action' ) ); |
| 52 | } |
| 53 | |
| 54 | static function sort_requires_connection_last( $module1, $module2 ) { |
| 55 | if ( $module1['requires_connection'] == $module2['requires_connection'] ) { |
| 56 | return 0; |
| 57 | } elseif ( $module1['requires_connection'] ) { |
| 58 | return 1; |
| 59 | } elseif ( $module2['requires_connection'] ) { |
| 60 | return -1; |
| 61 | } |
| 62 | |
| 63 | return 0; |
| 64 | } |
| 65 | |
| 66 | // Produce JS understandable objects of modules containing information for |
| 67 | // presentation like description, name, configuration url, etc. |
| 68 | function get_modules() { |
| 69 | include_once JETPACK__PLUGIN_DIR . 'modules/module-info.php'; |
| 70 | $available_modules = Jetpack::get_available_modules(); |
| 71 | $active_modules = Jetpack::get_active_modules(); |
| 72 | $modules = array(); |
| 73 | $jetpack_active = Jetpack::is_active() || ( new Status() )->is_development_mode(); |
| 74 | $overrides = Jetpack_Modules_Overrides::instance(); |
| 75 | foreach ( $available_modules as $module ) { |
| 76 | if ( $module_array = Jetpack::get_module( $module ) ) { |
| 77 | /** |
| 78 | * Filters each module's short description. |
| 79 | * |
| 80 | * @since 3.0.0 |
| 81 | * |
| 82 | * @param string $module_array['description'] Module description. |
| 83 | * @param string $module Module slug. |
| 84 | */ |
| 85 | $short_desc = apply_filters( 'jetpack_short_module_description', $module_array['description'], $module ); |
| 86 | // Fix: correct multibyte strings truncate with checking for mbstring extension |
| 87 | $short_desc_trunc = ( function_exists( 'mb_strlen' ) ) |
| 88 | ? ( ( mb_strlen( $short_desc ) > 143 ) |
| 89 | ? mb_substr( $short_desc, 0, 140 ) . '...' |
| 90 | : $short_desc ) |
| 91 | : ( ( strlen( $short_desc ) > 143 ) |
| 92 | ? substr( $short_desc, 0, 140 ) . '...' |
| 93 | : $short_desc ); |
| 94 | |
| 95 | $module_array['module'] = $module; |
| 96 | $module_array['activated'] = ( $jetpack_active ? in_array( $module, $active_modules ) : false ); |
| 97 | $module_array['deactivate_nonce'] = wp_create_nonce( 'jetpack_deactivate-' . $module ); |
| 98 | $module_array['activate_nonce'] = wp_create_nonce( 'jetpack_activate-' . $module ); |
| 99 | $module_array['available'] = self::is_module_available( $module_array ); |
| 100 | $module_array['short_description'] = $short_desc_trunc; |
| 101 | $module_array['configure_url'] = Jetpack::module_configuration_url( $module ); |
| 102 | $module_array['override'] = $overrides->get_module_override( $module ); |
| 103 | |
| 104 | ob_start(); |
| 105 | /** |
| 106 | * Allow the display of a "Learn More" button. |
| 107 | * The dynamic part of the action, $module, is the module slug. |
| 108 | * |
| 109 | * @since 3.0.0 |
| 110 | */ |
| 111 | do_action( 'jetpack_learn_more_button_' . $module ); |
| 112 | $module_array['learn_more_button'] = ob_get_clean(); |
| 113 | |
| 114 | ob_start(); |
| 115 | /** |
| 116 | * Allow the display of information text when Jetpack is connected to WordPress.com. |
| 117 | * The dynamic part of the action, $module, is the module slug. |
| 118 | * |
| 119 | * @since 3.0.0 |
| 120 | */ |
| 121 | do_action( 'jetpack_module_more_info_' . $module ); |
| 122 | |
| 123 | /** |
| 124 | * Filter the long description of a module. |
| 125 | * |
| 126 | * @since 3.5.0 |
| 127 | * |
| 128 | * @param string ob_get_clean() The module long description. |
| 129 | * @param string $module The module name. |
| 130 | */ |
| 131 | $module_array['long_description'] = apply_filters( 'jetpack_long_module_description', ob_get_clean(), $module ); |
| 132 | |
| 133 | ob_start(); |
| 134 | /** |
| 135 | * Filter the search terms for a module |
| 136 | * |
| 137 | * Search terms are typically added to the module headers, under "Additional Search Queries". |
| 138 | * |
| 139 | * Use syntax: |
| 140 | * function jetpack_$module_search_terms( $terms ) { |
| 141 | * $terms = _x( 'term 1, term 2', 'search terms', 'jetpack' ); |
| 142 | * return $terms; |
| 143 | * } |
| 144 | * add_filter( 'jetpack_search_terms_$module', 'jetpack_$module_search_terms' ); |
| 145 | * |
| 146 | * @since 3.5.0 |
| 147 | * |
| 148 | * @param string The search terms (comma separated). |
| 149 | */ |
| 150 | echo apply_filters( 'jetpack_search_terms_' . $module, $module_array['additional_search_queries'] ); |
| 151 | $module_array['search_terms'] = ob_get_clean(); |
| 152 | |
| 153 | $module_array['configurable'] = false; |
| 154 | if ( |
| 155 | current_user_can( 'manage_options' ) && |
| 156 | /** |
| 157 | * Allow the display of a configuration link in the Jetpack Settings screen. |
| 158 | * |
| 159 | * @since 3.0.0 |
| 160 | * |
| 161 | * @param string $module Module name. |
| 162 | * @param bool false Should the Configure module link be displayed? Default to false. |
| 163 | */ |
| 164 | apply_filters( 'jetpack_module_configurable_' . $module, false ) |
| 165 | ) { |
| 166 | $module_array['configurable'] = sprintf( '<a href="%1$s">%2$s</a>', esc_url( $module_array['configure_url'] ), __( 'Configure', 'jetpack' ) ); |
| 167 | } |
| 168 | |
| 169 | $modules[ $module ] = $module_array; |
| 170 | } |
| 171 | } |
| 172 | |
| 173 | uasort( $modules, array( 'Jetpack', 'sort_modules' ) ); |
| 174 | |
| 175 | if ( ! Jetpack::is_active() ) { |
| 176 | uasort( $modules, array( __CLASS__, 'sort_requires_connection_last' ) ); |
| 177 | } |
| 178 | |
| 179 | return $modules; |
| 180 | } |
| 181 | |
| 182 | static function is_module_available( $module ) { |
| 183 | if ( ! is_array( $module ) || empty( $module ) ) { |
| 184 | return false; |
| 185 | } |
| 186 | |
| 187 | /** |
| 188 | * We never want to show VaultPress as activatable through Jetpack. |
| 189 | */ |
| 190 | if ( 'vaultpress' === $module['module'] ) { |
| 191 | return false; |
| 192 | } |
| 193 | |
| 194 | if ( ( new Status() )->is_development_mode() ) { |
| 195 | return ! ( $module['requires_connection'] ); |
| 196 | } else { |
| 197 | if ( ! Jetpack::is_active() ) { |
| 198 | return false; |
| 199 | } |
| 200 | |
| 201 | return Jetpack_Plan::supports( $module['module'] ); |
| 202 | } |
| 203 | } |
| 204 | |
| 205 | function handle_unrecognized_action( $action ) { |
| 206 | switch ( $action ) { |
| 207 | case 'bulk-activate': |
| 208 | if ( ! current_user_can( 'jetpack_activate_modules' ) ) { |
| 209 | break; |
| 210 | } |
| 211 | |
| 212 | $modules = (array) $_GET['modules']; |
| 213 | $modules = array_map( 'sanitize_key', $modules ); |
| 214 | check_admin_referer( 'bulk-jetpack_page_jetpack_modules' ); |
| 215 | foreach ( $modules as $module ) { |
| 216 | Jetpack::log( 'activate', $module ); |
| 217 | Jetpack::activate_module( $module, false ); |
| 218 | } |
| 219 | // The following two lines will rarely happen, as Jetpack::activate_module normally exits at the end. |
| 220 | wp_safe_redirect( wp_get_referer() ); |
| 221 | exit; |
| 222 | case 'bulk-deactivate': |
| 223 | if ( ! current_user_can( 'jetpack_deactivate_modules' ) ) { |
| 224 | break; |
| 225 | } |
| 226 | |
| 227 | $modules = (array) $_GET['modules']; |
| 228 | $modules = array_map( 'sanitize_key', $modules ); |
| 229 | check_admin_referer( 'bulk-jetpack_page_jetpack_modules' ); |
| 230 | foreach ( $modules as $module ) { |
| 231 | Jetpack::log( 'deactivate', $module ); |
| 232 | Jetpack::deactivate_module( $module ); |
| 233 | Jetpack::state( 'message', 'module_deactivated' ); |
| 234 | } |
| 235 | Jetpack::state( 'module', $modules ); |
| 236 | wp_safe_redirect( wp_get_referer() ); |
| 237 | exit; |
| 238 | default: |
| 239 | return; |
| 240 | } |
| 241 | } |
| 242 | |
| 243 | function fix_redirect( $module, $redirect = true ) { |
| 244 | if ( ! $redirect ) { |
| 245 | return; |
| 246 | } |
| 247 | if ( wp_get_referer() ) { |
| 248 | add_filter( 'wp_redirect', 'wp_get_referer' ); |
| 249 | } |
| 250 | } |
| 251 | |
| 252 | function admin_menu_debugger() { |
| 253 | jetpack_require_lib( 'debugger' ); |
| 254 | Jetpack_Debugger::disconnect_and_redirect(); |
| 255 | $debugger_hook = add_submenu_page( |
| 256 | null, |
| 257 | __( 'Debugging Center', 'jetpack' ), |
| 258 | '', |
| 259 | 'manage_options', |
| 260 | 'jetpack-debugger', |
| 261 | array( $this, 'wrap_debugger_page' ) |
| 262 | ); |
| 263 | add_action( "admin_head-$debugger_hook", array( 'Jetpack_Debugger', 'jetpack_debug_admin_head' ) ); |
| 264 | } |
| 265 | |
| 266 | function wrap_debugger_page() { |
| 267 | nocache_headers(); |
| 268 | if ( ! current_user_can( 'manage_options' ) ) { |
| 269 | die( '-1' ); |
| 270 | } |
| 271 | Jetpack_Admin_Page::wrap_ui( array( $this, 'debugger_page' ) ); |
| 272 | } |
| 273 | |
| 274 | function debugger_page() { |
| 275 | jetpack_require_lib( 'debugger' ); |
| 276 | Jetpack_Debugger::jetpack_debug_display_handler(); |
| 277 | } |
| 278 | } |
| 279 | Jetpack_Admin::init(); |
| 280 |