elementor / includes / settings / tools.php

tools.php in Elementor Website Builder – more than just a page builder 3.16.0-dev1, at includes/settings/tools.php

431 lines 14.2 KB

Raw Download Zip

1	<?php
2	namespace Elementor;
3
4	use Elementor\Core\Admin\Menu\Admin_Menu_Manager;
5	use Elementor\Core\Admin\Menu\Main as MainMenu;
6	use Elementor\Core\Kits\Manager;
7	use Elementor\Includes\Settings\AdminMenuItems\Tools_Menu_Item;
8
9	if ( ! defined( 'ABSPATH' ) ) {
10	exit; // Exit if accessed directly.
11	}
12
13	/**
14	* Elementor "Tools" page in WordPress Dashboard.
15	*
16	* Elementor settings page handler class responsible for creating and displaying
17	* Elementor "Tools" page in WordPress dashboard.
18	*
19	* @since 1.0.0
20	*/
21	class Tools extends Settings_Page {
22
23	const CAPABILITY = 'manage_options';
24
25	/**
26	* Settings page ID for Elementor tools.
27	*/
28	const PAGE_ID = 'elementor-tools';
29
30	private function register_admin_menu( MainMenu $menu ) {
31	$menu->add_submenu( [
32	'page_title' => esc_html__( 'Tools', 'elementor' ),
33	'menu_title' => esc_html__( 'Tools', 'elementor' ),
34	'menu_slug' => self::PAGE_ID,
35	'function' => [ $this, 'display_settings_page' ],
36	'index' => 50,
37	] );
38	}
39
40	/**
41	* Clear cache.
42	*
43	* Delete post meta containing the post CSS file data. And delete the actual
44	* CSS files from the upload directory.
45	*
46	* Fired by `wp_ajax_elementor_clear_cache` action.
47	*
48	* @since 1.0.0
49	* @access public
50	*/
51	public function ajax_elementor_clear_cache() {
52	check_ajax_referer( 'elementor_clear_cache', '_nonce' );
53
54	if ( ! current_user_can( static::CAPABILITY ) ) {
55	wp_send_json_error( 'Permission denied' );
56	}
57
58	Plugin::$instance->files_manager->clear_cache();
59
60	wp_send_json_success();
61	}
62
63	/**
64	* Recreate kit.
65	*
66	* Recreate default kit (only when default kit does not exist).
67	*
68	* Fired by `wp_ajax_elementor_recreate_kit` action.
69	*
70	* @since 1.0.0
71	* @access public
72	*/
73	public function ajax_elementor_recreate_kit() {
74	check_ajax_referer( 'elementor_recreate_kit', '_nonce' );
75
76	if ( ! current_user_can( static::CAPABILITY ) ) {
77	wp_send_json_error( 'Permission denied' );
78	}
79
80	$kit = Plugin::$instance->kits_manager->get_active_kit();
81
82	if ( $kit->get_id() ) {
83	wp_send_json_error( [ 'message' => esc_html__( 'There\'s already an active kit.', 'elementor' ) ], 400 );
84	}
85
86	$created_default_kit = Plugin::$instance->kits_manager->create_default();
87
88	if ( ! $created_default_kit ) {
89	wp_send_json_error( [ 'message' => esc_html__( 'An error occurred while trying to create a kit.', 'elementor' ) ], 500 );
90	}
91
92	update_option( Manager::OPTION_ACTIVE, $created_default_kit );
93
94	wp_send_json_success( esc_html__( 'New kit have been created successfully', 'elementor' ) );
95	}
96
97	/**
98	* Replace URLs.
99	*
100	* Sends an ajax request to replace old URLs to new URLs. This method also
101	* updates all the Elementor data.
102	*
103	* Fired by `wp_ajax_elementor_replace_url` action.
104	*
105	* @since 1.1.0
106	* @access public
107	*/
108	public function ajax_elementor_replace_url() {
109	check_ajax_referer( 'elementor_replace_url', '_nonce' );
110
111	if ( ! current_user_can( static::CAPABILITY ) ) {
112	wp_send_json_error( 'Permission denied' );
113	}
114
115	$from = Utils::get_super_global_value( $_POST, 'from' ) ?? '';
116	$to = Utils::get_super_global_value( $_POST, 'to' ) ?? '';
117
118	try {
119	$results = Utils::replace_urls( $from, $to );
120	wp_send_json_success( $results );
121	} catch ( \Exception $e ) {
122	wp_send_json_error( $e->getMessage() );
123	}
124	}
125
126	/**
127	* Elementor version rollback.
128	*
129	* Rollback to previous Elementor version.
130	*
131	* Fired by `admin_post_elementor_rollback` action.
132	*
133	* @since 1.5.0
134	* @access public
135	*/
136	public function post_elementor_rollback() {
137	check_admin_referer( 'elementor_rollback' );
138
139	if ( ! static::can_user_rollback_versions() ) {
140	wp_die( esc_html__( 'Not allowed to rollback versions', 'elementor' ) );
141	}
142
143	$rollback_versions = $this->get_rollback_versions();
144	$version = Utils::get_super_global_value( $_GET, 'version' );
145
146	if ( empty( $version ) \|\| ! in_array( $version, $rollback_versions, true ) ) {
147	wp_die( esc_html__( 'Error occurred, The version selected is invalid. Try selecting different version.', 'elementor' ) );
148	}
149
150	$plugin_slug = basename( ELEMENTOR__FILE__, '.php' );
151
152	$rollback = new Rollback(
153	[
154	'version' => $version,
155	'plugin_name' => ELEMENTOR_PLUGIN_BASE,
156	'plugin_slug' => $plugin_slug,
157	'package_url' => sprintf( 'https://downloads.wordpress.org/plugin/%s.%s.zip', $plugin_slug, $version ),
158	]
159	);
160
161	$rollback->run();
162
163	wp_die(
164	'', esc_html__( 'Rollback to Previous Version', 'elementor' ), [
165	'response' => 200,
166	]
167	);
168	}
169
170	/**
171	* Tools page constructor.
172	*
173	* Initializing Elementor "Tools" page.
174	*
175	* @since 1.0.0
176	* @access public
177	*/
178	public function __construct() {
179	parent::__construct();
180
181	if ( Plugin::$instance->experiments->is_feature_active( 'admin_menu_rearrangement' ) ) {
182	add_action( 'elementor/admin/menu_registered/elementor', function( MainMenu $menu ) {
183	$this->register_admin_menu( $menu );
184	} );
185	} else {
186	add_action( 'elementor/admin/menu/register', function( Admin_Menu_Manager $admin_menu ) {
187	$admin_menu->register( static::PAGE_ID, new Tools_Menu_Item( $this ) );
188	}, Settings::ADMIN_MENU_PRIORITY + 20 );
189	}
190
191	add_action( 'wp_ajax_elementor_clear_cache', [ $this, 'ajax_elementor_clear_cache' ] );
192	add_action( 'wp_ajax_elementor_replace_url', [ $this, 'ajax_elementor_replace_url' ] );
193	add_action( 'wp_ajax_elementor_recreate_kit', [ $this, 'ajax_elementor_recreate_kit' ] );
194
195	add_action( 'admin_post_elementor_rollback', [ $this, 'post_elementor_rollback' ] );
196	}
197
198	private function get_rollback_versions() {
199	$rollback_versions = get_transient( 'elementor_rollback_versions_' . ELEMENTOR_VERSION );
200	if ( false === $rollback_versions ) {
201	$max_versions = 30;
202
203	require_once ABSPATH . 'wp-admin/includes/plugin-install.php';
204
205	$plugin_information = plugins_api(
206	'plugin_information', [
207	'slug' => 'elementor',
208	]
209	);
210
211	if ( empty( $plugin_information->versions ) \|\| ! is_array( $plugin_information->versions ) ) {
212	return [];
213	}
214
215	uksort( $plugin_information->versions, 'version_compare' );
216	$plugin_information->versions = array_reverse( $plugin_information->versions );
217
218	$rollback_versions = [];
219
220	$current_index = 0;
221	foreach ( $plugin_information->versions as $version => $download_link ) {
222	if ( $max_versions <= $current_index ) {
223	break;
224	}
225
226	$lowercase_version = strtolower( $version );
227	$is_valid_rollback_version = ! preg_match( '/(trunk\|beta\|rc\|dev)/i', $lowercase_version );
228
229	/**
230	* Is rollback version is valid.
231	*
232	* Filters the check whether the rollback version is valid.
233	*
234	* @param bool $is_valid_rollback_version Whether the rollback version is valid.
235	*/
236	$is_valid_rollback_version = apply_filters(
237	'elementor/settings/tools/rollback/is_valid_rollback_version',
238	$is_valid_rollback_version,
239	$lowercase_version
240	);
241
242	if ( ! $is_valid_rollback_version ) {
243	continue;
244	}
245
246	if ( version_compare( $version, ELEMENTOR_VERSION, '>=' ) ) {
247	continue;
248	}
249
250	$current_index++;
251	$rollback_versions[] = $version;
252	}
253
254	set_transient( 'elementor_rollback_versions_' . ELEMENTOR_VERSION, $rollback_versions, WEEK_IN_SECONDS );
255	}
256
257	return $rollback_versions;
258	}
259
260	/**
261	* Create tabs.
262	*
263	* Return the tools page tabs, sections and fields.
264	*
265	* @since 1.5.0
266	* @access protected
267	*
268	* @return array An array with the page tabs, sections and fields.
269	*/
270	protected function create_tabs() {
271	$rollback_html = '<select class="elementor-rollback-select">';
272
273	foreach ( $this->get_rollback_versions() as $version ) {
274	$rollback_html .= "<option value='{$version}'>$version</option>";
275	}
276	$rollback_html .= '</select>';
277
278	$tabs = [
279	'general' => [
280	'label' => esc_html__( 'General', 'elementor' ),
281	'sections' => [
282	'tools' => [
283	'fields' => [
284	'clear_cache' => [
285	'label' => esc_html__( 'Regenerate CSS & Data', 'elementor' ),
286	'field_args' => [
287	'type' => 'raw_html',
288	'html' => sprintf( '<button data-nonce="%s" class="button elementor-button-spinner" id="elementor-clear-cache-button">%s</button>', wp_create_nonce( 'elementor_clear_cache' ), esc_html__( 'Regenerate Files & Data', 'elementor' ) ),
289	'desc' => esc_html__( 'Styles set in Elementor are saved in CSS files in the uploads folder and in the site’s database. Recreate those files and settings, according to the most recent settings.', 'elementor' ),
290	],
291	],
292	'reset_api_data' => [
293	'label' => esc_html__( 'Sync Library', 'elementor' ),
294	'field_args' => [
295	'type' => 'raw_html',
296	'html' => sprintf( '<button data-nonce="%s" class="button elementor-button-spinner" id="elementor-library-sync-button">%s</button>', wp_create_nonce( 'elementor_reset_library' ), esc_html__( 'Sync Library', 'elementor' ) ),
297	'desc' => esc_html__( 'Elementor Library automatically updates on a daily basis. You can also manually update it by clicking on the sync button.', 'elementor' ),
298	],
299	],
300	],
301	],
302	],
303	],
304	'replace_url' => [
305	'label' => esc_html__( 'Replace URL', 'elementor' ),
306	'sections' => [
307	'replace_url' => [
308	'callback' => function() {
309	$intro_text = sprintf(
310	/* translators: %s: WordPress backups documentation. */
311	__( '<strong>Important:</strong> It is strongly recommended that you <a target="_blank" href="%s">backup your database</a> before using Replace URL.', 'elementor' ),
312	'https://go.elementor.com/wordpress-backups/'
313	);
314	$intro_text = '<div>' . $intro_text . '</div>';
315
316	echo '<h2>' . esc_html__( 'Replace URL', 'elementor' ) . '</h2>';
317	Utils::print_unescaped_internal_string( $intro_text );
318	},
319	'fields' => [
320	'replace_url' => [
321	'label' => esc_html__( 'Update Site Address (URL)', 'elementor' ),
322	'field_args' => [
323	'type' => 'raw_html',
324	'html' => sprintf( '<input type="text" name="from" placeholder="https://old.example.com" class="large-text"><input type="text" name="to" placeholder="https://new.example.com" class="large-text"><button data-nonce="%s" class="button elementor-button-spinner" id="elementor-replace-url-button">%s</button>', wp_create_nonce( 'elementor_replace_url' ), esc_html__( 'Replace URL', 'elementor' ) ),
325	'desc' => esc_html__( 'Enter your old and new URLs for your WordPress installation, to update all Elementor data (Relevant for domain transfers or move to \'HTTPS\').', 'elementor' ),
326	],
327	],
328	],
329	],
330	],
331	],
332	'versions' => [
333	'show_if' => static::can_user_rollback_versions(),
334	'label' => esc_html__( 'Version Control', 'elementor' ),
335	'sections' => [
336	'rollback' => [
337	'label' => esc_html__( 'Rollback to Previous Version', 'elementor' ),
338	'callback' => function() {
339	$intro_text = sprintf(
340	/* translators: %s: Elementor version. */
341	esc_html__( 'Experiencing an issue with Elementor version %s? Rollback to a previous version before the issue appeared.', 'elementor' ),
342	ELEMENTOR_VERSION
343	);
344	$intro_text = '<p>' . $intro_text . '</p>';
345
346	Utils::print_unescaped_internal_string( $intro_text );
347	},
348	'fields' => [
349	'rollback' => [
350	'label' => esc_html__( 'Rollback Version', 'elementor' ),
351	'field_args' => [
352	'type' => 'raw_html',
353	'html' => sprintf(
354	$rollback_html . '<a data-placeholder-text="' . esc_html__( 'Reinstall', 'elementor' ) . ' v{VERSION}" href="#" data-placeholder-url="%s" class="button elementor-button-spinner elementor-rollback-button">%s</a>',
355	wp_nonce_url( admin_url( 'admin-post.php?action=elementor_rollback&version=VERSION' ), 'elementor_rollback' ),
356	esc_html__( 'Reinstall', 'elementor' )
357	),
358	'desc' => '<span style="color: red;">' . esc_html__( 'Warning: Please backup your database before making the rollback.', 'elementor' ) . '</span>',
359	],
360	],
361	],
362	],
363	'beta' => [
364	'label' => esc_html__( 'Become a Beta Tester', 'elementor' ),
365	'callback' => function() {
366	echo '<p>' .
367	esc_html__( 'Turn-on Beta Tester, to get notified when a new beta version of Elementor or Elementor Pro is available. The Beta version will not install automatically. You always have the option to ignore it.', 'elementor' ) .
368	'</p>';
369	echo sprintf(
370	/* translators: 1: Link open tag, 2: Link close tag. */
371	esc_html__( '%1$sClick here%2$s to join our first-to-know email updates.', 'elementor' ),
372	'<a id="beta-tester-first-to-know" href="#">',
373	'</a>'
374	);
375	},
376	'fields' => [
377	'beta' => [
378	'label' => esc_html__( 'Beta Tester', 'elementor' ),
379	'field_args' => [
380	'type' => 'select',
381	'std' => 'no',
382	'options' => [
383	'no' => esc_html__( 'Disable', 'elementor' ),
384	'yes' => esc_html__( 'Enable', 'elementor' ),
385	],
386	'desc' => '<span style="color: red;">' . esc_html__( 'Please Note: We do not recommend updating to a beta version on production sites.', 'elementor' ) . '</span>',
387	],
388	],
389	],
390	],
391	],
392	],
393	];
394
395	if ( ! Plugin::$instance->kits_manager->get_active_kit()->get_id() ) {
396	$tabs['general']['sections']['tools']['fields']['recreate_kit'] = [
397	'label' => esc_html__( 'Recreate Kit', 'elementor' ),
398	'field_args' => [
399	'type' => 'raw_html',
400	'html' => sprintf( '<button data-nonce="%s" class="button elementor-button-spinner" id="elementor-recreate-kit-button">%s</button>', wp_create_nonce( 'elementor_recreate_kit' ), esc_html__( 'Recreate Kit', 'elementor' ) ),
401	'desc' => esc_html__( 'It seems like your site doesn\'t have any active Kit. The active Kit includes all of your Site Settings. By recreating your Kit you will able to start edit your Site Settings again.', 'elementor' ),
402	],
403	];
404	}
405	return $tabs;
406	}
407
408	/**
409	* Get tools page title.
410	*
411	* Retrieve the title for the tools page.
412	*
413	* @since 1.5.0
414	* @access protected
415	*
416	* @return string Tools page title.
417	*/
418	protected function get_page_title() {
419	return esc_html__( 'Tools', 'elementor' );
420	}
421
422	/**
423	* Check if the current user can access the version control tab and rollback versions.
424	*
425	* @return bool
426	*/
427	public static function can_user_rollback_versions() {
428	return current_user_can( 'activate_plugins' ) && current_user_can( 'update_plugins' );
429	}
430	}
431