| 1 |
<?php |
| 2 |
|
| 3 |
namespace Elementor\Modules\EditorOne\Classes; |
| 4 |
|
| 5 |
use Elementor\Core\Admin\EditorOneMenu\Interfaces\Menu_Item_Interface; |
| 6 |
use Elementor\Core\Admin\EditorOneMenu\Interfaces\Menu_Item_Third_Level_Interface; |
| 7 |
use Elementor\Core\Admin\EditorOneMenu\Interfaces\Menu_Item_With_Custom_Url_Interface; |
| 8 |
use Elementor\Plugin; |
| 9 |
|
| 10 |
if ( ! defined( 'ABSPATH' ) ) { |
| 11 |
exit; |
| 12 |
} |
| 13 |
|
| 14 |
class Menu_Data_Provider { |
| 15 |
private static ?Menu_Data_Provider $instance = null; |
| 16 |
private array $level3_items = []; |
| 17 |
private array $level4_items = []; |
| 18 |
private ?string $theme_builder_url = null; |
| 19 |
private ?array $cached_editor_flyout_data = null; |
| 20 |
private ?array $cached_level4_flyout_data = null; |
| 21 |
private Slug_Normalizer $slug_normalizer; |
| 22 |
|
| 23 |
public static function instance(): self { |
| 24 |
if ( null === self::$instance ) { |
| 25 |
self::$instance = new self(); |
| 26 |
} |
| 27 |
|
| 28 |
return self::$instance; |
| 29 |
} |
| 30 |
|
| 31 |
private function __construct() { |
| 32 |
$this->slug_normalizer = new Slug_Normalizer(); |
| 33 |
} |
| 34 |
|
| 35 |
public function get_slug_normalizer(): Slug_Normalizer { |
| 36 |
return $this->slug_normalizer; |
| 37 |
} |
| 38 |
|
| 39 |
public function register_menu( Menu_Item_Interface $item ): void { |
| 40 |
if ( ! ( $item instanceof Menu_Item_Third_Level_Interface ) ) { |
| 41 |
$this->register_level4_item( $item ); |
| 42 |
return; |
| 43 |
} |
| 44 |
|
| 45 |
$group_id = $item->get_group_id(); |
| 46 |
$collapsible_groups = [ |
| 47 |
Menu_Config::TEMPLATES_GROUP_ID, |
| 48 |
Menu_Config::CUSTOM_ELEMENTS_GROUP_ID, |
| 49 |
Menu_Config::SYSTEM_GROUP_ID, |
| 50 |
]; |
| 51 |
|
| 52 |
if ( in_array( $group_id, $collapsible_groups, true ) && ! $item->has_children() ) { |
| 53 |
$this->register_level4_item( $item ); |
| 54 |
} else { |
| 55 |
$this->register_level3_item( $item ); |
| 56 |
} |
| 57 |
} |
| 58 |
|
| 59 |
public function register_level3_item( Menu_Item_Third_Level_Interface $item ): void { |
| 60 |
$group_id = $item->get_group_id(); |
| 61 |
$item_slug = $item->get_slug(); |
| 62 |
|
| 63 |
if ( ! isset( $this->level3_items[ $group_id ] ) ) { |
| 64 |
$this->level3_items[ $group_id ] = []; |
| 65 |
} |
| 66 |
|
| 67 |
$this->level3_items[ $group_id ][ $item_slug ] = $item; |
| 68 |
|
| 69 |
$this->invalidate_cache(); |
| 70 |
} |
| 71 |
|
| 72 |
public function register_level4_item( Menu_Item_Interface $item ): void { |
| 73 |
$group_id = $item->get_group_id(); |
| 74 |
$item_slug = $item->get_slug(); |
| 75 |
|
| 76 |
if ( ! isset( $this->level4_items[ $group_id ] ) ) { |
| 77 |
$this->level4_items[ $group_id ] = []; |
| 78 |
} |
| 79 |
|
| 80 |
$this->level4_items[ $group_id ][ $item_slug ] = $item; |
| 81 |
$this->invalidate_cache(); |
| 82 |
} |
| 83 |
|
| 84 |
public function get_level3_items(): array { |
| 85 |
return $this->level3_items; |
| 86 |
} |
| 87 |
|
| 88 |
public function get_level4_items(): array { |
| 89 |
return $this->level4_items; |
| 90 |
} |
| 91 |
|
| 92 |
public function is_item_already_registered( string $item_slug ): bool { |
| 93 |
$all_items = array_merge( $this->level3_items, $this->level4_items ); |
| 94 |
|
| 95 |
foreach ( $all_items as $group_items ) { |
| 96 |
if ( isset( $group_items[ $item_slug ] ) ) { |
| 97 |
return true; |
| 98 |
} |
| 99 |
} |
| 100 |
|
| 101 |
return false; |
| 102 |
} |
| 103 |
|
| 104 |
public function get_editor_flyout_data(): array { |
| 105 |
if ( null !== $this->cached_editor_flyout_data ) { |
| 106 |
return $this->cached_editor_flyout_data; |
| 107 |
} |
| 108 |
|
| 109 |
$items = $this->build_level3_flyout_items(); |
| 110 |
|
| 111 |
$this->sort_items_by_priority( $items ); |
| 112 |
|
| 113 |
$this->cached_editor_flyout_data = [ |
| 114 |
'parent_slug' => Menu_Config::EDITOR_MENU_SLUG, |
| 115 |
'items' => $items, |
| 116 |
]; |
| 117 |
|
| 118 |
return $this->cached_editor_flyout_data; |
| 119 |
} |
| 120 |
|
| 121 |
public function get_level4_flyout_data(): array { |
| 122 |
if ( null !== $this->cached_level4_flyout_data ) { |
| 123 |
return $this->cached_level4_flyout_data; |
| 124 |
} |
| 125 |
|
| 126 |
$groups = $this->build_level4_flyout_groups(); |
| 127 |
|
| 128 |
foreach ( $groups as $group_id => $group ) { |
| 129 |
if ( ! empty( $group['items'] ) ) { |
| 130 |
$this->sort_items_by_priority( $groups[ $group_id ]['items'] ); |
| 131 |
} |
| 132 |
} |
| 133 |
|
| 134 |
$this->cached_level4_flyout_data = $groups; |
| 135 |
|
| 136 |
return $this->cached_level4_flyout_data; |
| 137 |
} |
| 138 |
|
| 139 |
public function get_theme_builder_url(): string { |
| 140 |
if ( null === $this->theme_builder_url ) { |
| 141 |
$pro_url = Plugin::$instance->app ? Plugin::$instance->app->get_settings( 'menu_url' ) : null; |
| 142 |
$return_to = esc_url_raw( wp_unslash( $_SERVER['REQUEST_URI'] ?? '' ) ); |
| 143 |
|
| 144 |
$url = $pro_url |
| 145 |
? $this->add_return_to_url( $pro_url, $return_to ) |
| 146 |
: add_query_arg( [ 'return_to' => $return_to ], admin_url( 'admin.php?page=elementor-app' ) ) . '#/site-editor/promotion'; |
| 147 |
|
| 148 |
$this->theme_builder_url = apply_filters( 'elementor/editor-one/menu/theme_builder_url', $url ); |
| 149 |
} |
| 150 |
|
| 151 |
return $this->theme_builder_url; |
| 152 |
} |
| 153 |
|
| 154 |
private function add_return_to_url( string $url, string $return_to ): string { |
| 155 |
$hash_position = strpos( $url, '#' ); |
| 156 |
|
| 157 |
if ( false === $hash_position ) { |
| 158 |
return add_query_arg( [ 'return_to' => $return_to ], $url ); |
| 159 |
} |
| 160 |
|
| 161 |
$base_url = substr( $url, 0, $hash_position ); |
| 162 |
$hash_fragment = substr( $url, $hash_position ); |
| 163 |
|
| 164 |
return add_query_arg( [ 'return_to' => $return_to ], $base_url ) . $hash_fragment; |
| 165 |
} |
| 166 |
|
| 167 |
public function get_all_sidebar_page_slugs(): array { |
| 168 |
$base_slugs = [ |
| 169 |
Menu_Config::ELEMENTOR_MENU_SLUG, |
| 170 |
Menu_Config::EDITOR_MENU_SLUG, |
| 171 |
]; |
| 172 |
|
| 173 |
$slugs = array_merge( |
| 174 |
$base_slugs, |
| 175 |
$this->get_dynamic_page_slugs() |
| 176 |
); |
| 177 |
|
| 178 |
return array_values( array_unique( $slugs ) ); |
| 179 |
} |
| 180 |
|
| 181 |
public function is_elementor_editor_page(): bool { |
| 182 |
if ( ! get_current_screen() ) { |
| 183 |
return false; |
| 184 |
} |
| 185 |
|
| 186 |
$page = filter_input( INPUT_GET, 'page', FILTER_SANITIZE_FULL_SPECIAL_CHARS ) ?? ''; |
| 187 |
|
| 188 |
if ( Menu_Config::ELEMENTOR_HOME_MENU_SLUG === $page ) { |
| 189 |
return false; |
| 190 |
} |
| 191 |
|
| 192 |
if ( in_array( $page, $this->get_all_sidebar_page_slugs(), true ) ) { |
| 193 |
return true; |
| 194 |
} |
| 195 |
|
| 196 |
$post_type = filter_input( INPUT_GET, 'post_type', FILTER_SANITIZE_FULL_SPECIAL_CHARS ) ?? ''; |
| 197 |
|
| 198 |
return $this->is_elementor_post_type( $post_type ); |
| 199 |
} |
| 200 |
|
| 201 |
private function is_elementor_post_type( string $post_type ): bool { |
| 202 |
if ( empty( $post_type ) ) { |
| 203 |
return false; |
| 204 |
} |
| 205 |
|
| 206 |
return isset( Menu_Config::get_elementor_post_types()[ $post_type ] ); |
| 207 |
} |
| 208 |
|
| 209 |
public static function get_elementor_post_types(): array { |
| 210 |
return Menu_Config::get_elementor_post_types(); |
| 211 |
} |
| 212 |
|
| 213 |
private function get_dynamic_page_slugs(): array { |
| 214 |
$slugs = []; |
| 215 |
|
| 216 |
foreach ( $this->level3_items as $group_items ) { |
| 217 |
$slugs = array_merge( $slugs, array_keys( $group_items ) ); |
| 218 |
} |
| 219 |
|
| 220 |
foreach ( $this->level4_items as $group_items ) { |
| 221 |
foreach ( $group_items as $item_slug => $item ) { |
| 222 |
$slugs[] = $item_slug; |
| 223 |
} |
| 224 |
} |
| 225 |
|
| 226 |
$allowed_prefixes = [ 'elementor', 'e-', 'popup_templates' ]; |
| 227 |
|
| 228 |
return array_values( array_filter( $slugs, function( string $slug ) use ( $allowed_prefixes ): bool { |
| 229 |
foreach ( $allowed_prefixes as $prefix ) { |
| 230 |
if ( 0 === strpos( $slug, $prefix ) ) { |
| 231 |
return true; |
| 232 |
} |
| 233 |
} |
| 234 |
|
| 235 |
return false; |
| 236 |
} ) ); |
| 237 |
} |
| 238 |
|
| 239 |
private function build_level3_flyout_items(): array { |
| 240 |
$items = []; |
| 241 |
$existing_slugs = []; |
| 242 |
$excluded_slugs = Menu_Config::get_excluded_level3_slugs(); |
| 243 |
|
| 244 |
foreach ( $this->level3_items as $group_items ) { |
| 245 |
foreach ( $group_items as $item_slug => $item ) { |
| 246 |
if ( ! $this->should_include_flyout_item( $item, $item_slug, $existing_slugs, $excluded_slugs ) ) { |
| 247 |
continue; |
| 248 |
} |
| 249 |
|
| 250 |
$items[] = $this->create_flyout_item_data( $item, $item_slug ); |
| 251 |
$existing_slugs[] = $item_slug; |
| 252 |
} |
| 253 |
} |
| 254 |
|
| 255 |
return $items; |
| 256 |
} |
| 257 |
|
| 258 |
private function should_include_flyout_item( Menu_Item_Interface $item, string $item_slug, array $existing_slugs, array $excluded_slugs ): bool { |
| 259 |
if ( ! $this->is_item_accessible( $item ) ) { |
| 260 |
return false; |
| 261 |
} |
| 262 |
|
| 263 |
if ( in_array( $item_slug, $existing_slugs, true ) ) { |
| 264 |
return false; |
| 265 |
} |
| 266 |
|
| 267 |
if ( in_array( $item_slug, $excluded_slugs, true ) ) { |
| 268 |
return false; |
| 269 |
} |
| 270 |
|
| 271 |
if ( empty( trim( wp_strip_all_tags( $item->get_label() ) ) ) ) { |
| 272 |
return false; |
| 273 |
} |
| 274 |
|
| 275 |
return true; |
| 276 |
} |
| 277 |
|
| 278 |
private function create_flyout_item_data( Menu_Item_Interface $item, string $item_slug ): array { |
| 279 |
$has_children = $item->has_children(); |
| 280 |
$group_id = $has_children ? $item->get_group_id() : ''; |
| 281 |
$is_third_party_parent = Menu_Config::THIRD_PARTY_GROUP_ID === $item->get_group_id(); |
| 282 |
|
| 283 |
return [ |
| 284 |
'slug' => $item_slug, |
| 285 |
'label' => $this->title_case( $item->get_label() ), |
| 286 |
'url' => $this->resolve_flyout_item_url( $item, $item_slug ), |
| 287 |
'icon' => $item->get_icon(), |
| 288 |
'group_id' => $group_id, |
| 289 |
'priority' => $item->get_position() ?? 100, |
| 290 |
'has_divider_before' => $is_third_party_parent, |
| 291 |
]; |
| 292 |
} |
| 293 |
|
| 294 |
private function resolve_flyout_item_url( Menu_Item_Interface $item, string $item_slug ): string { |
| 295 |
if ( $item instanceof Menu_Item_With_Custom_Url_Interface ) { |
| 296 |
return $item->get_menu_url(); |
| 297 |
} |
| 298 |
|
| 299 |
$url = $this->get_item_url( $item_slug, $item->get_parent_slug() ); |
| 300 |
|
| 301 |
if ( ! $item->has_children() ) { |
| 302 |
return $url; |
| 303 |
} |
| 304 |
|
| 305 |
$children = $this->get_level4_items()[ $item->get_group_id() ] ?? []; |
| 306 |
|
| 307 |
if ( empty( $children ) ) { |
| 308 |
return $url; |
| 309 |
} |
| 310 |
|
| 311 |
$first_child_url = $this->get_first_accessible_child_url( $children ); |
| 312 |
|
| 313 |
return $first_child_url ?? $url; |
| 314 |
} |
| 315 |
|
| 316 |
private function get_first_accessible_child_url( array $children ): ?string { |
| 317 |
$children_data = []; |
| 318 |
|
| 319 |
foreach ( $children as $child_slug => $child_item ) { |
| 320 |
if ( ! $this->is_item_accessible( $child_item ) ) { |
| 321 |
continue; |
| 322 |
} |
| 323 |
|
| 324 |
$children_data[] = [ |
| 325 |
'url' => $this->get_item_url( $child_slug, $child_item->get_parent_slug() ), |
| 326 |
'priority' => $child_item->get_position() ?? 100, |
| 327 |
]; |
| 328 |
} |
| 329 |
|
| 330 |
if ( empty( $children_data ) ) { |
| 331 |
return null; |
| 332 |
} |
| 333 |
|
| 334 |
$this->sort_items_by_priority( $children_data ); |
| 335 |
|
| 336 |
return $children_data[0]['url']; |
| 337 |
} |
| 338 |
|
| 339 |
private function build_level4_flyout_groups(): array { |
| 340 |
$groups = []; |
| 341 |
$excluded_slugs = Menu_Config::get_excluded_level4_slugs(); |
| 342 |
|
| 343 |
foreach ( $this->level4_items as $group_id => $items ) { |
| 344 |
$groups[ $group_id ] = [ 'items' => [] ]; |
| 345 |
$existing_labels = []; |
| 346 |
|
| 347 |
foreach ( $items as $item_slug => $item ) { |
| 348 |
if ( ! $this->is_item_accessible( $item ) ) { |
| 349 |
continue; |
| 350 |
} |
| 351 |
|
| 352 |
if ( $this->slug_normalizer->is_excluded( $item_slug, $excluded_slugs ) ) { |
| 353 |
continue; |
| 354 |
} |
| 355 |
|
| 356 |
$label = $item->get_label(); |
| 357 |
$label_lower = strtolower( $label ); |
| 358 |
|
| 359 |
if ( in_array( $label_lower, $existing_labels, true ) ) { |
| 360 |
continue; |
| 361 |
} |
| 362 |
|
| 363 |
$url = $item instanceof Menu_Item_With_Custom_Url_Interface |
| 364 |
? $item->get_menu_url() |
| 365 |
: $this->get_item_url( $item_slug, $item->get_parent_slug() ); |
| 366 |
|
| 367 |
$groups[ $group_id ]['items'][] = [ |
| 368 |
'slug' => $item_slug, |
| 369 |
'label' => $this->title_case( $item->get_label() ), |
| 370 |
'url' => $url, |
| 371 |
'priority' => $item->get_position() ?? 100, |
| 372 |
]; |
| 373 |
|
| 374 |
$existing_labels[] = $label_lower; |
| 375 |
} |
| 376 |
} |
| 377 |
|
| 378 |
return $groups; |
| 379 |
} |
| 380 |
|
| 381 |
public function is_item_accessible( Menu_Item_Interface $item ): bool { |
| 382 |
return $item->is_visible() && current_user_can( $item->get_capability() ); |
| 383 |
} |
| 384 |
|
| 385 |
private function get_item_url( string $item_slug, ?string $parent_slug = null ): string { |
| 386 |
$admin_path_prefixes = [ 'edit.php', 'post-new.php', 'admin.php' ]; |
| 387 |
|
| 388 |
foreach ( $admin_path_prefixes as $prefix ) { |
| 389 |
if ( 0 === strpos( $item_slug, $prefix ) ) { |
| 390 |
return admin_url( $item_slug ); |
| 391 |
} |
| 392 |
} |
| 393 |
|
| 394 |
if ( 0 === strpos( $item_slug, 'http' ) ) { |
| 395 |
return $item_slug; |
| 396 |
} |
| 397 |
|
| 398 |
if ( $parent_slug && 0 === strpos( $parent_slug, 'edit.php' ) ) { |
| 399 |
return admin_url( $parent_slug . '&page=' . $item_slug ); |
| 400 |
} |
| 401 |
|
| 402 |
return admin_url( 'admin.php?page=' . $item_slug ); |
| 403 |
} |
| 404 |
|
| 405 |
private function sort_items_by_priority( array &$items ): void { |
| 406 |
usort( $items, function ( array $a, array $b ): int { |
| 407 |
return ( $a['priority'] ?? 100 ) <=> ( $b['priority'] ?? 100 ); |
| 408 |
} ); |
| 409 |
} |
| 410 |
|
| 411 |
/** |
| 412 |
* Convert string to Title Case (capitalize first letter of each word). |
| 413 |
* |
| 414 |
* @param string $text The text to convert. |
| 415 |
* @return string The text in Title Case. |
| 416 |
*/ |
| 417 |
private function title_case( string $text ): string { |
| 418 |
return mb_convert_case( $text, MB_CASE_TITLE, 'UTF-8' ); |
| 419 |
} |
| 420 |
|
| 421 |
private function invalidate_cache(): void { |
| 422 |
$this->cached_editor_flyout_data = null; |
| 423 |
$this->cached_level4_flyout_data = null; |
| 424 |
} |
| 425 |
|
| 426 |
public static function get_current_user_capabilities(): array { |
| 427 |
$user = wp_get_current_user(); |
| 428 |
|
| 429 |
if ( ! $user || ! $user->exists() ) { |
| 430 |
return [ |
| 431 |
'user' => null, |
| 432 |
'has_edit_posts' => false, |
| 433 |
'has_manage_options' => false, |
| 434 |
'is_edit_posts_user' => false, |
| 435 |
]; |
| 436 |
} |
| 437 |
|
| 438 |
$has_edit_posts = isset( $user->allcaps[ Menu_Config::CAPABILITY_EDIT_POSTS ] ) && $user->allcaps[ Menu_Config::CAPABILITY_EDIT_POSTS ]; |
| 439 |
$has_manage_options = isset( $user->allcaps[ Menu_Config::CAPABILITY_MANAGE_OPTIONS ] ) && $user->allcaps[ Menu_Config::CAPABILITY_MANAGE_OPTIONS ]; |
| 440 |
$is_edit_posts_user = $has_edit_posts && ! $has_manage_options; |
| 441 |
|
| 442 |
return [ |
| 443 |
'user' => $user, |
| 444 |
'has_edit_posts' => $has_edit_posts, |
| 445 |
'has_manage_options' => $has_manage_options, |
| 446 |
'is_edit_posts_user' => $is_edit_posts_user, |
| 447 |
]; |
| 448 |
} |
| 449 |
} |
| 450 |
|
