These results are based on our legacy PHP analysis, consider migrating to our new PHP analysis engine instead. Learn more
1 | <?php |
||
2 | |||
3 | use Automattic\Jetpack\Status; |
||
4 | use Automattic\Jetpack\Assets\Logo as Jetpack_Logo; |
||
5 | |||
6 | // Build the Jetpack admin menu as a whole |
||
7 | class Jetpack_Admin { |
||
8 | |||
9 | /** |
||
10 | * @var Jetpack_Admin |
||
11 | **/ |
||
12 | private static $instance = null; |
||
13 | |||
14 | static function init() { |
||
15 | if ( isset( $_GET['page'] ) && $_GET['page'] === 'jetpack' ) { |
||
16 | add_filter( 'nocache_headers', array( 'Jetpack_Admin', 'add_no_store_header' ), 100 ); |
||
17 | } |
||
18 | |||
19 | if ( is_null( self::$instance ) ) { |
||
20 | self::$instance = new Jetpack_Admin(); |
||
21 | } |
||
22 | return self::$instance; |
||
23 | } |
||
24 | |||
25 | static function add_no_store_header( $headers ) { |
||
26 | $headers['Cache-Control'] .= ', no-store'; |
||
27 | return $headers; |
||
28 | } |
||
29 | |||
30 | private function __construct() { |
||
31 | jetpack_require_lib( 'admin-pages/class.jetpack-react-page' ); |
||
32 | $this->jetpack_react = new Jetpack_React_Page(); |
||
33 | |||
34 | jetpack_require_lib( 'admin-pages/class.jetpack-settings-page' ); |
||
35 | $this->fallback_page = new Jetpack_Settings_Page(); |
||
36 | |||
37 | jetpack_require_lib( 'admin-pages/class-jetpack-about-page' ); |
||
38 | $this->jetpack_about = new Jetpack_About_Page(); |
||
39 | |||
40 | add_action( 'admin_menu', array( $this->jetpack_react, 'add_actions' ), 998 ); |
||
41 | add_action( 'admin_menu', array( $this->jetpack_react, 'add_actions' ), 998 ); |
||
42 | add_action( 'jetpack_admin_menu', array( $this->jetpack_react, 'jetpack_add_dashboard_sub_nav_item' ) ); |
||
43 | add_action( 'jetpack_admin_menu', array( $this->jetpack_react, 'jetpack_add_set_up_sub_nav_item' ) ); |
||
44 | add_action( 'jetpack_admin_menu', array( $this->jetpack_react, 'jetpack_add_settings_sub_nav_item' ) ); |
||
45 | add_action( 'jetpack_admin_menu', array( $this, 'admin_menu_debugger' ) ); |
||
46 | add_action( 'jetpack_admin_menu', array( $this->fallback_page, 'add_actions' ) ); |
||
47 | add_action( 'jetpack_admin_menu', array( $this->jetpack_about, 'add_actions' ) ); |
||
48 | |||
49 | // Add redirect to current page for activation/deactivation of modules |
||
50 | add_action( 'jetpack_pre_activate_module', array( $this, 'fix_redirect' ), 10, 2 ); |
||
51 | add_action( 'jetpack_pre_deactivate_module', array( $this, 'fix_redirect' ) ); |
||
52 | |||
53 | // Add module bulk actions handler |
||
54 | add_action( 'jetpack_unrecognized_action', array( $this, 'handle_unrecognized_action' ) ); |
||
55 | |||
56 | if ( class_exists( 'Akismet_Admin' ) ) { |
||
57 | // If the site has Jetpack Anti-Spam, change the Akismet menu label accordingly. |
||
58 | $site_products = Jetpack_Plan::get_products(); |
||
59 | $anti_spam_products = array( 'jetpack_anti_spam_monthly', 'jetpack_anti_spam' ); |
||
60 | if ( ! empty( array_intersect( $anti_spam_products, array_column( $site_products, 'product_slug' ) ) ) ) { |
||
61 | // Prevent Akismet from adding a menu item. |
||
62 | add_action( |
||
63 | 'admin_menu', |
||
64 | function () { |
||
65 | remove_action( 'admin_menu', array( 'Akismet_Admin', 'admin_menu' ), 5 ); |
||
66 | }, |
||
67 | 4 |
||
68 | ); |
||
69 | |||
70 | // Add an Anti-spam menu item for Jetpack. |
||
71 | add_action( |
||
72 | 'jetpack_admin_menu', |
||
73 | function () { |
||
74 | add_submenu_page( 'jetpack', __( 'Anti-Spam', 'jetpack' ), __( 'Anti-Spam', 'jetpack' ), 'manage_options', 'akismet-key-config', array( 'Akismet_Admin', 'display_page' ) ); |
||
75 | } |
||
76 | ); |
||
77 | add_action( 'admin_enqueue_scripts', array( $this, 'akismet_logo_replacement_styles' ) ); |
||
78 | } |
||
79 | } |
||
80 | } |
||
81 | |||
82 | /** |
||
83 | * Generate styles to replace Akismet logo for the Jetpack logo. It's a workaround until we create a proper settings page for |
||
84 | * Jetpack Anti-Spam. Without this, we would have to change the logo from Akismet codebase and we want to avoid that. |
||
85 | */ |
||
86 | public function akismet_logo_replacement_styles() { |
||
87 | $logo = new Jetpack_Logo(); |
||
88 | $logo_base64 = base64_encode( $logo->get_jp_emblem_larger() ); |
||
89 | $logo_base64_url = "data:image/svg+xml;base64,{$logo_base64}"; |
||
90 | $style = ".akismet-masthead__logo-container { background: url({$logo_base64_url}) no-repeat .25rem; height: 1.8125rem; } .akismet-masthead__logo { display: none; }"; |
||
91 | wp_add_inline_style( 'admin-bar', $style ); |
||
92 | } |
||
93 | |||
94 | View Code Duplication | static function sort_requires_connection_last( $module1, $module2 ) { |
|
95 | if ( $module1['requires_connection'] == $module2['requires_connection'] ) { |
||
96 | return 0; |
||
97 | } elseif ( $module1['requires_connection'] ) { |
||
98 | return 1; |
||
99 | } elseif ( $module2['requires_connection'] ) { |
||
100 | return -1; |
||
101 | } |
||
102 | |||
103 | return 0; |
||
104 | } |
||
105 | |||
106 | // Produce JS understandable objects of modules containing information for |
||
107 | // presentation like description, name, configuration url, etc. |
||
108 | function get_modules() { |
||
109 | include_once JETPACK__PLUGIN_DIR . 'modules/module-info.php'; |
||
110 | $available_modules = Jetpack::get_available_modules(); |
||
111 | $active_modules = Jetpack::get_active_modules(); |
||
112 | $modules = array(); |
||
113 | $jetpack_active = Jetpack::is_active() || ( new Status() )->is_offline_mode(); |
||
114 | $overrides = Jetpack_Modules_Overrides::instance(); |
||
115 | foreach ( $available_modules as $module ) { |
||
116 | if ( $module_array = Jetpack::get_module( $module ) ) { |
||
117 | /** |
||
118 | * Filters each module's short description. |
||
119 | * |
||
120 | * @since 3.0.0 |
||
121 | * |
||
122 | * @param string $module_array['description'] Module description. |
||
123 | * @param string $module Module slug. |
||
124 | */ |
||
125 | $short_desc = apply_filters( 'jetpack_short_module_description', $module_array['description'], $module ); |
||
0 ignored issues
–
show
|
|||
126 | // Fix: correct multibyte strings truncate with checking for mbstring extension |
||
127 | $short_desc_trunc = ( function_exists( 'mb_strlen' ) ) |
||
128 | ? ( ( mb_strlen( $short_desc ) > 143 ) |
||
129 | ? mb_substr( $short_desc, 0, 140 ) . '...' |
||
130 | : $short_desc ) |
||
131 | : ( ( strlen( $short_desc ) > 143 ) |
||
132 | ? substr( $short_desc, 0, 140 ) . '...' |
||
133 | : $short_desc ); |
||
134 | |||
135 | $module_array['module'] = $module; |
||
136 | $module_array['activated'] = ( $jetpack_active ? in_array( $module, $active_modules ) : false ); |
||
137 | $module_array['deactivate_nonce'] = wp_create_nonce( 'jetpack_deactivate-' . $module ); |
||
138 | $module_array['activate_nonce'] = wp_create_nonce( 'jetpack_activate-' . $module ); |
||
139 | $module_array['available'] = self::is_module_available( $module_array ); |
||
140 | $module_array['short_description'] = $short_desc_trunc; |
||
141 | $module_array['configure_url'] = Jetpack::module_configuration_url( $module ); |
||
142 | $module_array['override'] = $overrides->get_module_override( $module ); |
||
143 | |||
144 | ob_start(); |
||
145 | /** |
||
146 | * Allow the display of a "Learn More" button. |
||
147 | * The dynamic part of the action, $module, is the module slug. |
||
148 | * |
||
149 | * @since 3.0.0 |
||
150 | */ |
||
151 | do_action( 'jetpack_learn_more_button_' . $module ); |
||
152 | $module_array['learn_more_button'] = ob_get_clean(); |
||
153 | |||
154 | ob_start(); |
||
155 | /** |
||
156 | * Allow the display of information text when Jetpack is connected to WordPress.com. |
||
157 | * The dynamic part of the action, $module, is the module slug. |
||
158 | * |
||
159 | * @since 3.0.0 |
||
160 | */ |
||
161 | do_action( 'jetpack_module_more_info_' . $module ); |
||
162 | |||
163 | /** |
||
164 | * Filter the long description of a module. |
||
165 | * |
||
166 | * @since 3.5.0 |
||
167 | * |
||
168 | * @param string ob_get_clean() The module long description. |
||
169 | * @param string $module The module name. |
||
170 | */ |
||
171 | $module_array['long_description'] = apply_filters( 'jetpack_long_module_description', ob_get_clean(), $module ); |
||
0 ignored issues
–
show
The call to
apply_filters() has too many arguments starting with $module .
This check compares calls to functions or methods with their respective definitions. If the call has more arguments than are defined, it raises an issue. If a function is defined several times with a different number of parameters, the check may pick up the wrong definition and report false positives. One codebase where this has been known to happen is Wordpress. In this case you can add the ![]() |
|||
172 | |||
173 | ob_start(); |
||
174 | /** |
||
175 | * Filter the search terms for a module |
||
176 | * |
||
177 | * Search terms are typically added to the module headers, under "Additional Search Queries". |
||
178 | * |
||
179 | * Use syntax: |
||
180 | * function jetpack_$module_search_terms( $terms ) { |
||
181 | * $terms = _x( 'term 1, term 2', 'search terms', 'jetpack' ); |
||
182 | * return $terms; |
||
183 | * } |
||
184 | * add_filter( 'jetpack_search_terms_$module', 'jetpack_$module_search_terms' ); |
||
185 | * |
||
186 | * @since 3.5.0 |
||
187 | * |
||
188 | * @param string The search terms (comma separated). |
||
189 | */ |
||
190 | echo apply_filters( 'jetpack_search_terms_' . $module, $module_array['additional_search_queries'] ); |
||
191 | $module_array['search_terms'] = ob_get_clean(); |
||
192 | |||
193 | $module_array['configurable'] = false; |
||
194 | if ( |
||
195 | current_user_can( 'manage_options' ) && |
||
196 | /** |
||
197 | * Allow the display of a configuration link in the Jetpack Settings screen. |
||
198 | * |
||
199 | * @since 3.0.0 |
||
200 | * |
||
201 | * @param string $module Module name. |
||
202 | * @param bool false Should the Configure module link be displayed? Default to false. |
||
203 | */ |
||
204 | apply_filters( 'jetpack_module_configurable_' . $module, false ) |
||
205 | ) { |
||
206 | $module_array['configurable'] = sprintf( '<a href="%1$s">%2$s</a>', esc_url( $module_array['configure_url'] ), __( 'Configure', 'jetpack' ) ); |
||
207 | } |
||
208 | |||
209 | $modules[ $module ] = $module_array; |
||
210 | } |
||
211 | } |
||
212 | |||
213 | uasort( $modules, array( 'Jetpack', 'sort_modules' ) ); |
||
214 | |||
215 | if ( ! Jetpack::is_active() ) { |
||
216 | uasort( $modules, array( __CLASS__, 'sort_requires_connection_last' ) ); |
||
217 | } |
||
218 | |||
219 | return $modules; |
||
220 | } |
||
221 | |||
222 | static function is_module_available( $module ) { |
||
223 | if ( ! is_array( $module ) || empty( $module ) ) { |
||
224 | return false; |
||
225 | } |
||
226 | |||
227 | /** |
||
228 | * We never want to show VaultPress as activatable through Jetpack. |
||
229 | */ |
||
230 | if ( 'vaultpress' === $module['module'] ) { |
||
231 | return false; |
||
232 | } |
||
233 | |||
234 | /* |
||
235 | * WooCommerce Analytics should only be available |
||
236 | * when running WooCommerce 3+ |
||
237 | */ |
||
238 | if ( |
||
239 | 'woocommerce-analytics' === $module['module'] |
||
240 | && ( |
||
241 | ! class_exists( 'WooCommerce' ) |
||
242 | || version_compare( WC_VERSION, '3.0', '<' ) |
||
243 | ) |
||
244 | ) { |
||
245 | return false; |
||
246 | } |
||
247 | |||
248 | if ( ( new Status() )->is_offline_mode() ) { |
||
249 | return ! ( $module['requires_connection'] ); |
||
250 | } else { |
||
251 | if ( ! Jetpack::is_active() ) { |
||
252 | return false; |
||
253 | } |
||
254 | |||
255 | return Jetpack_Plan::supports( $module['module'] ); |
||
256 | } |
||
257 | } |
||
258 | |||
259 | function handle_unrecognized_action( $action ) { |
||
260 | switch ( $action ) { |
||
261 | case 'bulk-activate': |
||
262 | if ( ! current_user_can( 'jetpack_activate_modules' ) ) { |
||
263 | break; |
||
264 | } |
||
265 | |||
266 | $modules = (array) $_GET['modules']; |
||
267 | $modules = array_map( 'sanitize_key', $modules ); |
||
268 | check_admin_referer( 'bulk-jetpack_page_jetpack_modules' ); |
||
269 | foreach ( $modules as $module ) { |
||
270 | Jetpack::log( 'activate', $module ); |
||
271 | Jetpack::activate_module( $module, false ); |
||
272 | } |
||
273 | // The following two lines will rarely happen, as Jetpack::activate_module normally exits at the end. |
||
274 | wp_safe_redirect( wp_get_referer() ); |
||
275 | exit; |
||
276 | View Code Duplication | case 'bulk-deactivate': |
|
277 | if ( ! current_user_can( 'jetpack_deactivate_modules' ) ) { |
||
278 | break; |
||
279 | } |
||
280 | |||
281 | $modules = (array) $_GET['modules']; |
||
282 | $modules = array_map( 'sanitize_key', $modules ); |
||
283 | check_admin_referer( 'bulk-jetpack_page_jetpack_modules' ); |
||
284 | foreach ( $modules as $module ) { |
||
285 | Jetpack::log( 'deactivate', $module ); |
||
286 | Jetpack::deactivate_module( $module ); |
||
287 | Jetpack::state( 'message', 'module_deactivated' ); |
||
288 | } |
||
289 | Jetpack::state( 'module', $modules ); |
||
0 ignored issues
–
show
$modules is of type array , but the function expects a string|null .
It seems like the type of the argument is not accepted by the function/method which you are calling. In some cases, in particular if PHP’s automatic type-juggling kicks in this might be fine. In other cases, however this might be a bug. We suggest to add an explicit type cast like in the following example: function acceptsInteger($int) { }
$x = '123'; // string "123"
// Instead of
acceptsInteger($x);
// we recommend to use
acceptsInteger((integer) $x);
![]() |
|||
290 | wp_safe_redirect( wp_get_referer() ); |
||
291 | exit; |
||
292 | default: |
||
293 | return; |
||
294 | } |
||
295 | } |
||
296 | |||
297 | function fix_redirect( $module, $redirect = true ) { |
||
298 | if ( ! $redirect ) { |
||
299 | return; |
||
300 | } |
||
301 | if ( wp_get_referer() ) { |
||
302 | add_filter( 'wp_redirect', 'wp_get_referer' ); |
||
303 | } |
||
304 | } |
||
305 | |||
306 | function admin_menu_debugger() { |
||
307 | jetpack_require_lib( 'debugger' ); |
||
308 | Jetpack_Debugger::disconnect_and_redirect(); |
||
309 | $debugger_hook = add_submenu_page( |
||
310 | null, |
||
311 | __( 'Debugging Center', 'jetpack' ), |
||
312 | '', |
||
313 | 'manage_options', |
||
314 | 'jetpack-debugger', |
||
315 | array( $this, 'wrap_debugger_page' ) |
||
316 | ); |
||
317 | add_action( "admin_head-$debugger_hook", array( 'Jetpack_Debugger', 'jetpack_debug_admin_head' ) ); |
||
318 | } |
||
319 | |||
320 | function wrap_debugger_page() { |
||
321 | nocache_headers(); |
||
322 | if ( ! current_user_can( 'manage_options' ) ) { |
||
323 | die( '-1' ); |
||
324 | } |
||
325 | Jetpack_Admin_Page::wrap_ui( array( $this, 'debugger_page' ) ); |
||
326 | } |
||
327 | |||
328 | function debugger_page() { |
||
329 | jetpack_require_lib( 'debugger' ); |
||
330 | Jetpack_Debugger::jetpack_debug_display_handler(); |
||
331 | } |
||
332 | } |
||
333 | Jetpack_Admin::init(); |
||
334 |
This check compares calls to functions or methods with their respective definitions. If the call has more arguments than are defined, it raises an issue.
If a function is defined several times with a different number of parameters, the check may pick up the wrong definition and report false positives. One codebase where this has been known to happen is Wordpress.
In this case you can add the
@ignore
PhpDoc annotation to the duplicate definition and it will be ignored.