Automattic /
jetpack
These results are based on our legacy PHP analysis, consider migrating to our new PHP analysis engine instead. Learn more
| 1 | <?php |
||
| 2 | |||
| 3 | // Shared logic between Jetpack admin pages |
||
| 4 | abstract class Jetpack_Admin_Page { |
||
| 5 | // Add page specific actions given the page hook |
||
| 6 | abstract function add_page_actions( $hook ); |
||
| 7 | |||
| 8 | // Create a menu item for the page and returns the hook |
||
| 9 | abstract function get_page_hook(); |
||
| 10 | |||
| 11 | // Enqueue and localize page specific scripts |
||
| 12 | abstract function page_admin_scripts(); |
||
| 13 | |||
| 14 | // Render page specific HTML |
||
| 15 | abstract function page_render(); |
||
| 16 | |||
| 17 | /** |
||
| 18 | * Should we block the page rendering because the site is in IDC? |
||
| 19 | * @var bool |
||
| 20 | */ |
||
| 21 | static $block_page_rendering_for_idc; |
||
| 22 | |||
| 23 | /** |
||
| 24 | * Flag to know if we already checked the plan. |
||
| 25 | * |
||
| 26 | * @since 4.4.0 |
||
| 27 | * |
||
| 28 | * @var bool |
||
| 29 | */ |
||
| 30 | static $plan_checked = false; |
||
|
0 ignored issues
–
show
|
|||
| 31 | |||
| 32 | /** |
||
| 33 | * Function called after admin_styles to load any additional needed styles. |
||
| 34 | * |
||
| 35 | * @since 4.3.0 |
||
| 36 | */ |
||
| 37 | function additional_styles() {} |
||
| 38 | |||
| 39 | function __construct() { |
||
| 40 | $this->jetpack = Jetpack::init(); |
||
| 41 | self::$block_page_rendering_for_idc = ( |
||
| 42 | Jetpack::validate_sync_error_idc_option() && ! Jetpack_Options::get_option( 'safe_mode_confirmed' ) |
||
| 43 | ); |
||
| 44 | |||
| 45 | if ( ! self::$block_page_rendering_for_idc ) { |
||
| 46 | add_action( 'admin_enqueue_scripts', array( $this, 'additional_styles' ) ); |
||
| 47 | } |
||
| 48 | } |
||
| 49 | |||
| 50 | function add_actions() { |
||
| 51 | |||
| 52 | // If user is not an admin and site is in Dev Mode, don't do anything |
||
| 53 | if ( ! current_user_can( 'manage_options' ) && Jetpack::is_development_mode() ) { |
||
| 54 | return; |
||
| 55 | } |
||
| 56 | |||
| 57 | // Don't add in the modules page unless modules are available! |
||
| 58 | if ( $this->dont_show_if_not_active && ! Jetpack::is_active() && ! Jetpack::is_development_mode() ) { |
||
| 59 | return; |
||
| 60 | } |
||
| 61 | |||
| 62 | // Initialize menu item for the page in the admin |
||
| 63 | $hook = $this->get_page_hook(); |
||
| 64 | |||
| 65 | // Attach hooks common to all Jetpack admin pages based on the created |
||
| 66 | // hook |
||
| 67 | add_action( "load-$hook", array( $this, 'admin_help' ) ); |
||
| 68 | add_action( "load-$hook", array( $this, 'admin_page_load' ) ); |
||
| 69 | add_action( "admin_head-$hook", array( $this, 'admin_head' ) ); |
||
| 70 | |||
| 71 | add_action( "admin_print_styles-$hook", array( $this, 'admin_styles' ) ); |
||
| 72 | add_action( "admin_print_scripts-$hook", array( $this, 'admin_scripts' ) ); |
||
| 73 | |||
| 74 | // Check if the site plan changed and deactivate modules accordingly. |
||
| 75 | add_action( 'current_screen', array( $this, 'check_plan_deactivate_modules' ) ); |
||
| 76 | |||
| 77 | // Attach page specific actions in addition to the above |
||
| 78 | $this->add_page_actions( $hook ); |
||
| 79 | } |
||
| 80 | |||
| 81 | function admin_head() { |
||
| 82 | View Code Duplication | if ( isset( $_GET['configure'] ) && Jetpack::is_module( $_GET['configure'] ) && current_user_can( 'manage_options' ) ) { |
|
| 83 | /** |
||
| 84 | * Fires in the <head> of a particular Jetpack configuation page. |
||
| 85 | * |
||
| 86 | * The dynamic portion of the hook name, `$_GET['configure']`, |
||
| 87 | * refers to the slug of module, such as 'stats', 'sso', etc. |
||
| 88 | * A complete hook for the latter would be |
||
| 89 | * 'jetpack_module_configuation_head_sso'. |
||
| 90 | * |
||
| 91 | * @since 3.0.0 |
||
| 92 | */ |
||
| 93 | do_action( 'jetpack_module_configuration_head_' . $_GET['configure'] ); |
||
| 94 | } |
||
| 95 | } |
||
| 96 | |||
| 97 | // Render the page with a common top and bottom part, and page specific content |
||
| 98 | function render() { |
||
| 99 | // We're in an IDC: we need a decision made before we show the UI again. |
||
| 100 | if ( self::$block_page_rendering_for_idc ) { |
||
| 101 | return; |
||
| 102 | } |
||
| 103 | |||
| 104 | $this->page_render(); |
||
| 105 | } |
||
| 106 | |||
| 107 | function admin_help() { |
||
| 108 | $this->jetpack->admin_help(); |
||
| 109 | } |
||
| 110 | |||
| 111 | function admin_page_load() { |
||
| 112 | // This is big. For the moment, just call the existing one. |
||
| 113 | $this->jetpack->admin_page_load(); |
||
| 114 | } |
||
| 115 | |||
| 116 | function admin_page_top() { |
||
| 117 | include_once( JETPACK__PLUGIN_DIR . '_inc/header.php' ); |
||
| 118 | } |
||
| 119 | |||
| 120 | function admin_page_bottom() { |
||
| 121 | include_once( JETPACK__PLUGIN_DIR . '_inc/footer.php' ); |
||
| 122 | } |
||
| 123 | |||
| 124 | // Add page specific scripts and jetpack stats for all menu pages |
||
| 125 | function admin_scripts() { |
||
| 126 | $this->page_admin_scripts(); // Delegate to inheriting class |
||
| 127 | add_action( 'admin_footer', array( $this->jetpack, 'do_stats' ) ); |
||
| 128 | } |
||
| 129 | |||
| 130 | // Enqueue the Jetpack admin stylesheet |
||
| 131 | function admin_styles() { |
||
| 132 | $min = ( defined( 'SCRIPT_DEBUG' ) && SCRIPT_DEBUG ) ? '' : '.min'; |
||
| 133 | |||
| 134 | wp_enqueue_style( 'jetpack-admin', plugins_url( "css/jetpack-admin{$min}.css", JETPACK__PLUGIN_FILE ), array( 'genericons' ), JETPACK__VERSION . '-20121016' ); |
||
| 135 | wp_style_add_data( 'jetpack-admin', 'rtl', 'replace' ); |
||
| 136 | wp_style_add_data( 'jetpack-admin', 'suffix', $min ); |
||
| 137 | } |
||
| 138 | |||
| 139 | function is_wp_version_too_old() { |
||
| 140 | global $wp_version; |
||
| 141 | return ( ! function_exists( 'rest_api_init' ) || version_compare( $wp_version, '4.4-z', '<=' ) ); |
||
| 142 | } |
||
| 143 | |||
| 144 | /** |
||
| 145 | * Checks the site plan and deactivates modules that were active but are no longer included in the plan. |
||
| 146 | * |
||
| 147 | * @since 4.4.0 |
||
| 148 | * |
||
| 149 | * @param $page |
||
| 150 | * |
||
| 151 | * @return bool|array |
||
| 152 | */ |
||
| 153 | function check_plan_deactivate_modules( $page ) { |
||
| 154 | if ( |
||
| 155 | Jetpack::is_development_mode() |
||
| 156 | || ! in_array( |
||
| 157 | $page->base, |
||
| 158 | array( |
||
| 159 | 'toplevel_page_jetpack', |
||
| 160 | 'admin_page_jetpack_modules', |
||
| 161 | 'jetpack_page_vaultpress', |
||
| 162 | 'jetpack_page_stats', |
||
| 163 | 'jetpack_page_akismet-key-config' |
||
| 164 | ) |
||
| 165 | ) |
||
| 166 | || true === self::$plan_checked |
||
| 167 | ) { |
||
| 168 | return false; |
||
| 169 | } |
||
| 170 | |||
| 171 | self::$plan_checked = true; |
||
| 172 | $previous = get_option( 'jetpack_active_plan', '' ); |
||
| 173 | $response = rest_do_request( new WP_REST_Request( 'GET', '/jetpack/v4/site' ) ); |
||
| 174 | |||
| 175 | if ( ! is_object( $response ) || $response->is_error() ) { |
||
| 176 | |||
| 177 | // If we can't get information about the current plan we don't do anything |
||
| 178 | self::$plan_checked = true; |
||
| 179 | return; |
||
| 180 | } |
||
| 181 | |||
| 182 | $current = $response->get_data(); |
||
| 183 | $current = json_decode( $current['data'] ); |
||
| 184 | |||
| 185 | $to_deactivate = array(); |
||
| 186 | if ( isset( $current->plan->product_slug ) ) { |
||
| 187 | if ( |
||
| 188 | empty( $previous ) |
||
| 189 | || ! isset( $previous['product_slug'] ) |
||
| 190 | || $previous['product_slug'] !== $current->plan->product_slug |
||
| 191 | ) { |
||
| 192 | $active = Jetpack::get_active_modules(); |
||
| 193 | switch ( $current->plan->product_slug ) { |
||
| 194 | case 'jetpack_free': |
||
| 195 | $to_deactivate = array( 'seo-tools', 'videopress' ); |
||
| 196 | break; |
||
| 197 | case 'jetpack_personal': |
||
| 198 | case 'jetpack_personal_monthly': |
||
| 199 | $to_deactivate = array( 'seo-tools', 'videopress' ); |
||
| 200 | break; |
||
| 201 | case 'jetpack_premium': |
||
| 202 | case 'jetpack_premium_monthly': |
||
| 203 | $to_deactivate = array( 'seo-tools' ); |
||
| 204 | break; |
||
| 205 | } |
||
| 206 | $to_deactivate = array_intersect( $active, $to_deactivate ); |
||
| 207 | if ( ! empty( $to_deactivate ) ) { |
||
| 208 | Jetpack::update_active_modules( array_filter( array_diff( $active, $to_deactivate ) ) ); |
||
| 209 | } |
||
| 210 | } |
||
| 211 | } |
||
| 212 | return array( |
||
| 213 | 'previous' => $previous, |
||
| 214 | 'current' => $current, |
||
| 215 | 'deactivate' => $to_deactivate |
||
| 216 | ); |
||
| 217 | } |
||
| 218 | } |
||
| 219 |
The PSR-2 coding standard requires that all properties in a class have their visibility explicitly declared. If you declare a property using
the property is implicitly global.
To learn more about the PSR-2, please see the PHP-FIG site on the PSR-2.