elementor / modules / system-info / reporters / server.php

server.php in Elementor Website Builder – more than just a page builder 3.11.1, at modules/system-info/reporters/server.php

493 lines 11.8 KB

Raw Download Zip

1	<?php
2	namespace Elementor\Modules\System_Info\Reporters;
3
4	use Elementor\Api;
5	use Elementor\Utils;
6
7	if ( ! defined( 'ABSPATH' ) ) {
8	exit; // Exit if accessed directly.
9	}
10
11	/**
12	* Elementor server environment report.
13	*
14	* Elementor system report handler class responsible for generating a report for
15	* the server environment.
16	*
17	* @since 1.0.0
18	*/
19	class Server extends Base {
20
21	const KEY_PATH_WP_ROOT_DIR = 'wp_root';
22	const KEY_PATH_WP_CONTENT_DIR = 'wp_content';
23	const KEY_PATH_UPLOADS_DIR = 'uploads';
24	const KEY_PATH_ELEMENTOR_UPLOADS_DIR = 'elementor_uploads';
25	const KEY_PATH_HTACCESS_FILE = '.htaccess';
26
27	/**
28	* Get server environment reporter title.
29	*
30	* Retrieve server environment reporter title.
31	*
32	* @since 1.0.0
33	* @access public
34	*
35	* @return string Reporter title.
36	*/
37	public function get_title() {
38	return 'Server Environment';
39	}
40
41	/**
42	* Get server environment report fields.
43	*
44	* Retrieve the required fields for the server environment report.
45	*
46	* @since 1.0.0
47	* @access public
48	*
49	* @return array Required report fields with field ID and field label.
50	*/
51	public function get_fields() {
52	return [
53	'os' => 'Operating System',
54	'software' => 'Software',
55	'mysql_version' => 'MySQL version',
56	'php_version' => 'PHP Version',
57	'php_memory_limit' => 'PHP Memory Limit',
58	'php_max_input_vars' => 'PHP Max Input Vars',
59	'php_max_post_size' => 'PHP Max Post Size',
60	'gd_installed' => 'GD Installed',
61	'zip_installed' => 'ZIP Installed',
62	'write_permissions' => 'Write Permissions',
63	'elementor_library' => 'Elementor Library',
64	];
65	}
66
67	/**
68	* Get server operating system.
69	*
70	* Retrieve the server operating system.
71	*
72	* @since 1.0.0
73	* @access public
74	*
75	* @return array {
76	* Report data.
77	*
78	* @type string $value Server operating system.
79	* }
80	*/
81	public function get_os() {
82	return [
83	'value' => PHP_OS,
84	];
85	}
86
87	/**
88	* Get server software.
89	*
90	* Retrieve the server software.
91	*
92	* @since 1.0.0
93	* @access public
94	*
95	* @return array {
96	* Report data.
97	*
98	* @type string $value Server software.
99	* }
100	*/
101	public function get_software() {
102	return [
103	'value' => Utils::get_super_global_value( $_SERVER, 'SERVER_SOFTWARE' ),
104	];
105	}
106
107	/**
108	* Get PHP version.
109	*
110	* Retrieve the PHP version.
111	*
112	* @since 1.0.0
113	* @access public
114	*
115	* @return array {
116	* Report data.
117	*
118	* @type string $value PHP version.
119	* @type string $recommendation Minimum PHP version recommendation.
120	* @type bool $warning Whether to display a warning.
121	* }
122	*/
123	public function get_php_version() {
124	$result = [
125	'value' => PHP_VERSION,
126	];
127
128	if ( version_compare( $result['value'], '7.4', '<' ) ) {
129	$result['recommendation'] = sprintf(
130	/* translators: %s: Recommended PHP version. */
131	esc_html_x( 'We recommend using PHP version %s or higher.', 'System Info', 'elementor' ),
132	'7.4'
133	);
134
135	$result['warning'] = true;
136	}
137
138	return $result;
139	}
140
141	/**
142	* Get PHP memory limit.
143	*
144	* Retrieve the PHP memory limit.
145	*
146	* @return array {
147	* Report data.
148	*
149	* @type string $value PHP memory limit.
150	* @type string $recommendation Recommendation memory limit.
151	* @type bool $warning Whether to display a warning. True if the limit
152	* is below the recommended 128M, False otherwise.
153	* }
154	*/
155	public function get_php_memory_limit() {
156	$result = [
157	'value' => (string) get_cfg_var( 'memory_limit' ),
158	];
159
160	$min_recommended_memory = '128M';
161	$preferred_memory = '256M';
162
163	$memory_limit_bytes = wp_convert_hr_to_bytes( $result['value'] );
164
165	$min_recommended_bytes = wp_convert_hr_to_bytes( $min_recommended_memory );
166
167	if ( $memory_limit_bytes < $min_recommended_bytes ) {
168	$result['recommendation'] = sprintf(
169	/* translators: 1: Minimum recommended_memory, 2: Preferred memory, 3: WordPress wp-config memory documentation. */
170	_x( 'We recommend setting memory to at least %1$s. (%2$s or higher is preferred) For more information, read about <a href="%3$s">how to increase memory allocated to PHP</a>.', 'System Info', 'elementor' ),
171	$min_recommended_memory,
172	$preferred_memory,
173	'https://go.elementor.com/wordpress-wp-config-memory/'
174	);
175
176	$result['warning'] = true;
177	}
178
179	return $result;
180	}
181
182	/**
183	* Get PHP `max_input_vars`.
184	*
185	* Retrieve the value of `max_input_vars` from `php.ini` configuration file.
186	*
187	* @since 1.0.0
188	* @access public
189	*
190	* @return array {
191	* Report data.
192	*
193	* @type string $value PHP `max_input_vars`.
194	* }
195	*/
196	public function get_php_max_input_vars() {
197	return [
198	'value' => ini_get( 'max_input_vars' ),
199	];
200	}
201
202	/**
203	* Get PHP `post_max_size`.
204	*
205	* Retrieve the value of `post_max_size` from `php.ini` configuration file.
206	*
207	* @since 1.0.0
208	* @access public
209	*
210	* @return array {
211	* Report data.
212	*
213	* @type string $value PHP `post_max_size`.
214	* }
215	*/
216	public function get_php_max_post_size() {
217	return [
218	'value' => ini_get( 'post_max_size' ),
219	];
220	}
221
222	/**
223	* Get GD installed.
224	*
225	* Whether the GD extension is installed.
226	*
227	* @since 1.0.0
228	* @access public
229	*
230	* @return array {
231	* Report data.
232	*
233	* @type string $value Yes if the GD extension is installed, No otherwise.
234	* @type bool $warning Whether to display a warning. True if the GD extension is installed, False otherwise.
235	* }
236	*/
237	public function get_gd_installed() {
238	$gd_installed = extension_loaded( 'gd' );
239
240	return [
241	'value' => $gd_installed ? 'Yes' : 'No',
242	'warning' => ! $gd_installed,
243	];
244	}
245
246	/**
247	* Get ZIP installed.
248	*
249	* Whether the ZIP extension is installed.
250	*
251	* @since 2.1.0
252	* @access public
253	*
254	* @return array {
255	* Report data.
256	*
257	* @type string $value Yes if the ZIP extension is installed, No otherwise.
258	* @type bool $warning Whether to display a warning. True if the ZIP extension is installed, False otherwise.
259	* }
260	*/
261	public function get_zip_installed() {
262	$zip_installed = extension_loaded( 'zip' );
263
264	return [
265	'value' => $zip_installed ? 'Yes' : 'No',
266	'warning' => ! $zip_installed,
267	];
268	}
269
270	/**
271	* Get MySQL version.
272	*
273	* Retrieve the MySQL version.
274	*
275	* @since 1.0.0
276	* @access public
277	*
278	* @return array {
279	* Report data.
280	*
281	* @type string $value MySQL version.
282	* }
283	*/
284	public function get_mysql_version() {
285	global $wpdb;
286
287	$db_server_version = $wpdb->get_results( "SHOW VARIABLES WHERE `Variable_name` IN ( 'version_comment', 'innodb_version' )", OBJECT_K );
288
289	$db_server_version_string = $db_server_version['version_comment']->Value . ' v';
290
291	// On some hosts, `innodb_version` is empty, in PHP 8.1.
292	if ( isset( $db_server_version['innodb_version'] ) ) {
293	$db_server_version_string .= $db_server_version['innodb_version']->Value;
294	} else {
295	$db_server_version_string .= $wpdb->get_var( 'SELECT VERSION() AS version' );
296	}
297
298	return [
299	'value' => $db_server_version_string,
300	];
301	}
302
303	/**
304	* Get write permissions.
305	* Check whether the required paths for have writing permissions.
306	*
307	* @since 1.9.0
308	* @access public
309	*
310	* @return array {
311	* Report data.
312	*
313	* @type string $value Writing permissions status.
314	* @type bool $warning Whether to display a warning. True if some required
315	* folders don't have writing permissions, False otherwise.
316	* }
317	*/
318	public function get_write_permissions() : array {
319	$paths_to_check = [
320	static::KEY_PATH_WP_ROOT_DIR => $this->get_system_path( static::KEY_PATH_WP_ROOT_DIR ),
321	static::KEY_PATH_HTACCESS_FILE => $this->get_system_path( static::KEY_PATH_HTACCESS_FILE ),
322	static::KEY_PATH_UPLOADS_DIR => $this->get_system_path( static::KEY_PATH_UPLOADS_DIR ),
323	static::KEY_PATH_ELEMENTOR_UPLOADS_DIR => $this->get_system_path( static::KEY_PATH_ELEMENTOR_UPLOADS_DIR ),
324	];
325
326	$paths_permissions = $this->get_paths_permissions( $paths_to_check );
327
328	$write_problems = [];
329
330	if ( ! $paths_permissions[ static::KEY_PATH_WP_ROOT_DIR ]['write'] ) {
331	$write_problems[] = 'WordPress root directory';
332	}
333
334	if ( ! $paths_permissions[ static::KEY_PATH_UPLOADS_DIR ]['write'] ) {
335	$write_problems[] = 'WordPress uploads directory';
336	}
337
338	if ( $paths_permissions[ self::KEY_PATH_ELEMENTOR_UPLOADS_DIR ]['exists'] && ! $paths_permissions[ self::KEY_PATH_ELEMENTOR_UPLOADS_DIR ]['write'] ) {
339	$write_problems[] = 'Elementor uploads directory';
340	}
341
342	if ( $paths_permissions[ self::KEY_PATH_HTACCESS_FILE ]['exists'] && ! $paths_permissions[ self::KEY_PATH_HTACCESS_FILE ]['write'] ) {
343	$write_problems[] = '.htaccess file';
344	}
345
346	if ( $write_problems ) {
347	$value = 'There are some writing permissions issues with the following directories/files:' . "\n\t\t - ";
348
349	$value .= implode( "\n\t\t - ", $write_problems );
350	} else {
351	$value = 'All right';
352	}
353
354	return [
355	'value' => $value,
356	'warning' => ! ! $write_problems,
357	];
358	}
359
360	/**
361	* Check for elementor library connectivity.
362	*
363	* Check whether the remote elementor library is reachable.
364	*
365	* @since 1.0.0
366	* @access public
367	*
368	* @return array {
369	* Report data.
370	*
371	* @type string $value The status of elementor library connectivity.
372	* @type bool $warning Whether to display a warning. True if elementor
373	* * library is not reachable, False otherwise.
374	* }
375	*/
376	public function get_elementor_library() {
377	$response = wp_remote_get(
378	Api::$api_info_url, [
379	'timeout' => 5,
380	'body' => [
381	// Which API version is used
382	'api_version' => ELEMENTOR_VERSION,
383	// Which language to return
384	'site_lang' => get_bloginfo( 'language' ),
385	],
386	]
387	);
388
389	if ( is_wp_error( $response ) ) {
390	return [
391	'value' => 'Not connected (' . $response->get_error_message() . ')',
392	'warning' => true,
393	];
394	}
395
396	$http_response_code = wp_remote_retrieve_response_code( $response );
397
398	if ( 200 !== (int) $http_response_code ) {
399	$error_msg = 'HTTP Error (' . $http_response_code . ')';
400
401	return [
402	'value' => 'Not connected (' . $error_msg . ')',
403	'warning' => true,
404	];
405	}
406
407	$info_data = json_decode( wp_remote_retrieve_body( $response ), true );
408
409	if ( empty( $info_data ) ) {
410	return [
411	'value' => 'Not connected (Returns invalid JSON)',
412	'warning' => true,
413	];
414	}
415
416	return [
417	'value' => 'Connected',
418	];
419	}
420
421	/**
422	* @param $paths [] Paths to check permissions.
423	* @return array []{exists: bool, read: bool, write: bool, execute: bool}
424	*/
425	public function get_paths_permissions( $paths ) : array {
426	$permissions = [];
427
428	foreach ( $paths as $key_path => $path ) {
429	$permissions[ $key_path ] = $this->get_path_permissions( $path );
430	}
431
432	return $permissions;
433	}
434
435	/**
436	* Get path by path key.
437	*
438	* @param $path_key
439	* @return string
440	*/
441	public function get_system_path( $path_key ) : string {
442	switch ( $path_key ) {
443	case static::KEY_PATH_WP_ROOT_DIR:
444	return ABSPATH;
445
446	case static::KEY_PATH_WP_CONTENT_DIR:
447	return WP_CONTENT_DIR;
448
449	case static::KEY_PATH_HTACCESS_FILE:
450	return file_exists( ABSPATH . '/.htaccess' ) ? ABSPATH . '/.htaccess' : '';
451
452	case static::KEY_PATH_UPLOADS_DIR:
453	return wp_upload_dir()['basedir'] ?? '';
454
455	case static::KEY_PATH_ELEMENTOR_UPLOADS_DIR:
456	if ( empty( wp_upload_dir()['basedir'] ) ) {
457	return '';
458	}
459
460	$elementor_uploads_dir = wp_upload_dir()['basedir'] . '/elementor';
461
462	return is_dir( $elementor_uploads_dir ) ? $elementor_uploads_dir : '';
463
464	default:
465	return '';
466	}
467	}
468
469	/**
470	* Check the permissions of a path.
471	*
472	* @param $path
473	* @return array{exists: bool, read: bool, write: bool, execute: bool}
474	*/
475	public function get_path_permissions( $path ) : array {
476	if ( empty( $path ) ) {
477	return [
478	'exists' => false,
479	'read' => false,
480	'write' => false,
481	'execute' => false,
482	];
483	}
484
485	return [
486	'exists' => true,
487	'read' => is_readable( $path ),
488	'write' => is_writeable( $path ),
489	'execute' => is_executable( $path ),
490	];
491	}
492	}
493