Completed
Push — renovate/slack-web-api-6.x ( 1d54b7...bfe495 )
by
unknown
193:23 queued 183:13
created

WPcom_Admin_Menu   A

Complexity

Total Complexity 39

Size/Duplication

Total Lines 287
Duplicated Lines 9.76 %

Coupling/Cohesion

Components 1
Dependencies 2

Importance

Changes 0
Metric Value
wmc 39
lcom 1
cbo 2
dl 28
loc 287
rs 9.28
c 0
b 0
f 0

14 Methods

Rating   Name   Duplication   Size   Complexity  
A __construct() 0 5 1
A rest_api_init() 0 9 1
A reregister_menu_items() 16 16 2
A add_browse_sites_link() 0 9 2
A set_browse_sites_link_class() 12 12 3
A add_new_site_link() 0 16 3
B add_site_card_menu() 0 41 7
A set_site_card_menu_class() 0 18 4
A add_stats_menu() 0 13 2
A add_upgrades_menu() 0 5 1
B add_users_menu() 0 44 8
A add_tools_menu() 0 4 1
A add_options_menu() 0 10 2
A should_link_to_wp_admin() 0 10 2

How to fix   Duplicated Code   

Duplicated Code

Duplicate code is one of the most pungent code smells. A rule that is often used is to re-structure code once it is duplicated in three or more places.

Common duplication problems, and corresponding solutions are:

1
<?php
2
/**
3
 * WP.com Admin Menu file.
4
 *
5
 * @package automattic/jetpack
6
 */
7
8
namespace Automattic\Jetpack\Dashboard_Customizations;
9
10
use Automattic\Jetpack\Status;
11
12
require_once __DIR__ . '/class-admin-menu.php';
13
14
/**
15
 * Class WPcom_Admin_Menu.
16
 */
17
class WPcom_Admin_Menu extends Admin_Menu {
18
19
	/**
20
	 * WPcom_Admin_Menu constructor.
21
	 */
22
	protected function __construct() {
23
		parent::__construct();
24
25
		$this->customize_slug = 'https://wordpress.com/customize/' . $this->domain;
26
	}
27
28
	/**
29
	 * Sets up class properties for REST API requests.
30
	 *
31
	 * @param WP_REST_Response $response Response from the endpoint.
32
	 */
33
	public function rest_api_init( $response ) {
34
		parent::rest_api_init( $response );
35
36
		// Get domain for requested site.
37
		$this->domain         = ( new Status() )->get_site_suffix();
38
		$this->customize_slug = 'https://wordpress.com/customize/' . $this->domain;
39
40
		return $response;
41
	}
42
43
	/**
44
	 * Create the desired menu output.
45
	 */
46 View Code Duplication
	public function reregister_menu_items() {
47
		parent::reregister_menu_items();
48
49
		$wp_admin = $this->should_link_to_wp_admin();
50
51
		$this->add_my_home_menu( $wp_admin );
52
53
		// Not needed outside of wp-admin.
54
		if ( ! $this->is_api_request ) {
55
			$this->add_browse_sites_link();
56
			$this->add_site_card_menu();
57
			$this->add_new_site_link();
58
		}
59
60
		ksort( $GLOBALS['menu'] );
61
	}
62
63
	/**
64
	 * Adds the site switcher link if user has more than one site.
65
	 */
66
	public function add_browse_sites_link() {
67
		if ( count( get_blogs_of_user( get_current_user_id() ) ) < 2 ) {
68
			return;
69
		}
70
71
		// Add the menu item.
72
		add_menu_page( __( 'site-switcher', 'jetpack' ), __( 'Browse sites', 'jetpack' ), 'read', 'https://wordpress.com/home', null, 'dashicons-arrow-left-alt2', 0 );
73
		add_filter( 'add_menu_classes', array( $this, 'set_browse_sites_link_class' ) );
74
	}
75
76
	/**
77
	 * Adds a custom element class for Site Switcher menu item.
78
	 *
79
	 * @param array $menu Associative array of administration menu items.
80
	 * @return array
81
	 */
82 View Code Duplication
	public function set_browse_sites_link_class( array $menu ) {
83
		foreach ( $menu as $key => $menu_item ) {
84
			if ( 'site-switcher' !== $menu_item[3] ) {
85
				continue;
86
			}
87
88
			$menu[ $key ][4] = add_cssclass( 'site-switcher', $menu_item[4] );
89
			break;
90
		}
91
92
		return $menu;
93
	}
94
95
	/**
96
	 * Adds a link to the menu to create a new site.
97
	 */
98
	public function add_new_site_link() {
99
		global $menu;
100
101
		if ( count( get_blogs_of_user( get_current_user_id() ) ) > 1 ) {
102
			return;
103
		}
104
105
		// Attempt to get last position.
106
		$position = 1000;
107
		while ( isset( $menu[ $position ] ) ) {
108
			$position++;
109
		}
110
111
		$this->add_admin_menu_separator( ++$position );
112
		add_menu_page( __( 'Add new site', 'jetpack' ), __( 'Add new site', 'jetpack' ), 'read', 'https://wordpress.com/start?ref=calypso-sidebar', null, 'dashicons-plus-alt', ++$position );
113
	}
114
115
	/**
116
	 * Adds site card component.
117
	 */
118
	public function add_site_card_menu() {
119
		$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>' );
120
		$icon    = get_site_icon_url( 32, $default );
121
122
		if ( $default === $icon && blavatar_exists( $this->domain ) ) {
123
			$icon = blavatar_url( $this->domain, 'img', 32 );
124
		}
125
126
		$badge = '';
127
		if ( is_private_blog() ) {
128
			$badge .= sprintf(
129
				'<span class="site__badge site__badge-private">%s</span>',
130
				wpcom_is_coming_soon() ? esc_html__( 'Coming Soon', 'jetpack' ) : esc_html__( 'Private', 'jetpack' )
131
			);
132
		}
133
134
		if ( is_redirected_domain( $this->domain ) ) {
135
			$badge .= '<span class="site__badge site__badge-redirect">' . esc_html__( 'Redirect', 'jetpack' ) . '</span>';
136
		}
137
138
		if ( ! empty( get_option( 'options' )['is_domain_only'] ) ) {
139
			$badge .= '<span class="site__badge site__badge-domain-only">' . esc_html__( 'Domain', 'jetpack' ) . '</span>';
140
		}
141
142
		$site_card = '
143
<div class="site__info">
144
	<div class="site__title">%1$s</div>
145
	<div class="site__domain">%2$s</div>
146
	%3$s
147
</div>';
148
149
		$site_card = sprintf(
150
			$site_card,
151
			get_option( 'blogname' ),
152
			$this->domain,
153
			$badge
154
		);
155
156
		add_menu_page( 'site-card', $site_card, 'read', get_home_url(), null, $icon, 1 );
157
		add_filter( 'add_menu_classes', array( $this, 'set_site_card_menu_class' ) );
158
	}
159
160
	/**
161
	 * Adds a custom element class and id for Site Card's menu item.
162
	 *
163
	 * @param array $menu Associative array of administration menu items.
164
	 * @return array
165
	 */
166
	public function set_site_card_menu_class( array $menu ) {
167
		foreach ( $menu as $key => $menu_item ) {
168
			if ( 'site-card' !== $menu_item[3] ) {
169
				continue;
170
			}
171
172
			$classes = ' toplevel_page_site-card';
173
			if ( blavatar_exists( $this->domain ) ) {
174
				$classes .= ' has-site-icon';
175
			}
176
177
			$menu[ $key ][4] = $menu_item[4] . $classes;
178
			$menu[ $key ][5] = 'toplevel_page_site_card';
179
			break;
180
		}
181
182
		return $menu;
183
	}
184
185
	/**
186
	 * Adds Stats menu.
187
	 */
188
	public function add_stats_menu() {
189
		$menu_title = __( 'Stats', 'jetpack' );
190
191
		if ( ! $this->is_api_request ) {
192
			$menu_title .= sprintf(
193
				'<img class="sidebar-unified__sparkline" width="80" height="20" src="%1$s" alt="%2$s">',
194
				esc_url( site_url( 'wp-includes/charts/admin-bar-hours-scale-2x.php?masterbar=1&s=' . get_current_blog_id() ) ),
195
				esc_attr__( 'Hourly views', 'jetpack' )
196
			);
197
		}
198
199
		add_menu_page( __( 'Stats', 'jetpack' ), $menu_title, 'edit_posts', 'https://wordpress.com/stats/day/' . $this->domain, null, 'dashicons-chart-bar', 3 );
200
	}
201
202
	/**
203
	 * Adds Upgrades menu.
204
	 */
205
	public function add_upgrades_menu() {
206
		parent::add_upgrades_menu();
207
208
		add_submenu_page( 'https://wordpress.com/plans/' . $this->domain, __( 'Domains', 'jetpack' ), __( 'Domains', 'jetpack' ), 'manage_options', 'https://wordpress.com/domains/manage/' . $this->domain, null, 10 );
209
	}
210
211
	/**
212
	 * Adds Users menu.
213
	 *
214
	 * @param bool $wp_admin Optional. Whether links should point to Calypso or wp-admin. Default false (Calypso).
215
	 */
216
	public function add_users_menu( $wp_admin = false ) {
217
		$users_slug   = $wp_admin ? 'users.php' : 'https://wordpress.com/people/team/' . $this->domain;
218
		$add_new_slug = 'https://wordpress.com/people/new/' . $this->domain;
219
		$profile_slug = $wp_admin ? 'grofiles-editor' : 'https://wordpress.com/me';
220
		$account_slug = $wp_admin ? 'grofiles-user-settings' : 'https://wordpress.com/me/account';
221
222
		if ( current_user_can( 'list_users' ) ) {
223
			remove_menu_page( 'users.php' );
224
			remove_submenu_page( 'users.php', 'users.php' );
225
			remove_submenu_page( 'users.php', 'user-new.php' );
226
			remove_submenu_page( 'users.php', 'profile.php' );
227
			remove_submenu_page( 'users.php', 'grofiles-editor' );
228
			remove_submenu_page( 'users.php', 'grofiles-user-settings' );
229
230
			add_menu_page( esc_attr__( 'Users', 'jetpack' ), __( 'Users', 'jetpack' ), 'list_users', $users_slug, null, 'dashicons-admin-users', 70 );
231
			add_submenu_page( $users_slug, esc_attr__( 'All People', 'jetpack' ), __( 'All People', 'jetpack' ), 'list_users', $users_slug, null, 5 );
232
			add_submenu_page( $users_slug, esc_attr__( 'Add New', 'jetpack' ), __( 'Add New', 'jetpack' ), 'promote_users', $add_new_slug, null, 10 );
233
			add_submenu_page( $users_slug, esc_attr__( 'My Profile', 'jetpack' ), __( 'My Profile', 'jetpack' ), 'read', $profile_slug, null, 15 );
234
			add_submenu_page( $users_slug, esc_attr__( 'Account Settings', 'jetpack' ), __( 'Account Settings', 'jetpack' ), 'read', $account_slug, null, 20 );
235
236
			$this->migrate_submenus( 'users.php', $users_slug );
237
			add_filter(
238
				'parent_file',
239
				function ( $parent_file ) use ( $users_slug ) {
240
					return 'users.php' === $parent_file ? $users_slug : $parent_file;
241
				}
242
			);
243
		} elseif ( ! $wp_admin ) {
244
			remove_menu_page( 'profile.php' );
245
			remove_submenu_page( 'profile.php', 'grofiles-editor' );
246
			remove_submenu_page( 'profile.php', 'grofiles-user-settings' );
247
248
			add_menu_page( esc_attr__( 'My Profile', 'jetpack' ), __( 'My Profile', 'jetpack' ), 'read', $profile_slug, null, 'dashicons-admin-users', 70 );
249
			add_submenu_page( $profile_slug, esc_attr__( 'Account Settings', 'jetpack' ), __( 'Account Settings', 'jetpack' ), 'read', $account_slug, null, 5 );
250
251
			$this->migrate_submenus( 'profile.php', $profile_slug );
252
			add_filter(
253
				'parent_file',
254
				function ( $parent_file ) use ( $profile_slug ) {
255
					return 'profile.php' === $parent_file ? $profile_slug : $parent_file;
256
				}
257
			);
258
		}
259
	}
260
261
	/**
262
	 * Adds Tools menu.
263
	 *
264
	 * @param bool $wp_admin_import Optional. Whether Import link should point to Calypso or wp-admin. Default false (Calypso).
265
	 * @param bool $wp_admin_export Optional. Whether Export link should point to Calypso or wp-admin. Default false (Calypso).
266
	 */
267
	public function add_tools_menu( $wp_admin_import = false, $wp_admin_export = false ) {  // phpcs:ignore VariableAnalysis.CodeAnalysis.VariableAnalysis.UnusedVariable
268
		// Export on Simple sites is always handled on Calypso.
269
		parent::add_tools_menu( $wp_admin_import, false );
270
	}
271
272
	/**
273
	 * Adds Settings menu.
274
	 *
275
	 * @param bool $wp_admin Optional. Whether links should point to Calypso or wp-admin. Default false (Calypso).
276
	 */
277
	public function add_options_menu( $wp_admin = false ) {
278
		add_options_page( esc_attr__( 'Hosting Configuration', 'jetpack' ), __( 'Hosting Configuration', 'jetpack' ), 'manage_options', 'https://wordpress.com/hosting-config/' . $this->domain, null, 6 );
279
280
		// Replace sharing menu if it exists. See Publicize_UI::sharing_menu.
281
		if ( remove_submenu_page( 'options-general.php', 'sharing' ) ) {
282
			add_options_page( esc_attr__( 'Sharing Settings', 'jetpack' ), __( 'Sharing', 'jetpack' ), 'publish_posts', 'https://wordpress.com/marketing/sharing-buttons/' . $this->domain, null, 30 );
283
		}
284
285
		parent::add_options_menu( $wp_admin );
286
	}
287
288
	/**
289
	 * Whether to use wp-admin pages rather than Calypso.
290
	 *
291
	 * @return bool
292
	 */
293
	public function should_link_to_wp_admin() {
294
		$result = false; // Calypso.
295
296
		$user_attribute = get_user_attribute( get_current_user_id(), 'calypso_preferences' );
297
		if ( ! empty( $user_attribute['linkDestination'] ) ) {
298
			$result = $user_attribute['linkDestination'];
299
		}
300
301
		return $result;
302
	}
303
}
304