SystemInfoView.php
15.6 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
<?php
/**
* SearchWP SystemInfoView.
*
* @since 4.3.0
*/
namespace SearchWP\Admin\Views;
use SearchWP\License;
use SearchWP\Settings;
use SearchWP\Utils;
use SearchWP\Admin\NavTab;
/**
* Class SystemInfoView is responsible for providing the UI for System Info.
*
* @since 4.3.0
*/
class SystemInfoView {
private static $slug = 'system-info';
/**
* SystemInfoView constructor.
*
* @since 4.3.0
*/
function __construct() {
if ( Utils::is_swp_admin_page( 'tools' ) ) {
new NavTab( [
'page' => 'tools',
'tab' => self::$slug,
'label' => __( 'Support', 'searchwp' ),
] );
}
if ( Utils::is_swp_admin_page( 'tools', self::$slug ) ) {
add_action( 'searchwp\settings\view', [ __CLASS__, 'render' ] );
add_action( 'admin_enqueue_scripts', [ __CLASS__, 'assets' ] );
}
}
/**
* Outputs the assets needed for the Settings UI.
*
* @since 4.3.0
*/
public static function assets() {
$handle = SEARCHWP_PREFIX . self::$slug;
wp_enqueue_style(
$handle,
SEARCHWP_PLUGIN_URL . 'assets/css/admin/pages/system-info.css',
[
Utils::$slug . 'collapse-layout',
Utils::$slug . 'input',
Utils::$slug . 'style',
Utils::$slug . 'card',
],
SEARCHWP_VERSION
);
wp_enqueue_script(
$handle,
SEARCHWP_PLUGIN_URL . 'assets/js/admin/pages/system-info.js',
[ Utils::$slug . 'collapse' ],
SEARCHWP_VERSION,
true
);
}
/**
* Callback for the render of this view.
*
* @since 4.3.0
*/
public static function render() {
?>
<div class="swp-content-container">
<div id="system-info">
<div class="swp-collapse swp-opened"> <!-- System Info Settings collapse -->
<div class="swp-collapse--header">
<h2 class="swp-h2">
<?php esc_html_e( 'System Info', 'searchwp' ); ?>
</h2>
<button class="swp-expand--button">
<svg class="swp-arrow" width="17" height="11" viewBox="0 0 17 11" fill="none" xmlns="http://www.w3.org/2000/svg">
<path d="M14.2915 0.814362L8.09717 6.95819L1.90283 0.814362L0 2.7058L8.09717 10.7545L16.1943 2.7058L14.2915 0.814362Z" fill="#0E2121" fill-opacity="0.8"/>
</svg>
</button>
</div>
<div class="swp-collapse--content">
<div class="swp-row">
<div class="swp-flex--row sm:swp-flex--col sm:swp-flex--gap30 swp-margin-b30">
<div class="swp-col swp-col--title-width">
<h3 class="swp-h3">
<?php esc_html_e( 'Get Help', 'searchwp' ); ?>
</h3>
</div>
<div class="swp-col">
<div class="swp-flex--row sm:swp-flex--col swp-flex--gap20 swp-w-5/6">
<div class="swp-card swp-flex--grow1 swp-text-center">
<div class="swp-card--content">
<svg class="swp-get-help--icon" xmlns="http://www.w3.org/2000/svg" height="48px" viewBox="0 0 384 512">
<!--! Font Awesome Free 6.4.0 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license (Commercial License) Copyright 2023 Fonticons, Inc. -->
<path d="M64 464c-8.8 0-16-7.2-16-16V64c0-8.8 7.2-16 16-16H224v80c0 17.7 14.3 32 32 32h80V448c0 8.8-7.2 16-16 16H64zM64 0C28.7 0 0 28.7 0 64V448c0 35.3 28.7 64 64 64H320c35.3 0 64-28.7 64-64V154.5c0-17-6.7-33.3-18.7-45.3L274.7 18.7C262.7 6.7 246.5 0 229.5 0H64zm56 256c-13.3 0-24 10.7-24 24s10.7 24 24 24H264c13.3 0 24-10.7 24-24s-10.7-24-24-24H120zm0 96c-13.3 0-24 10.7-24 24s10.7 24 24 24H264c13.3 0 24-10.7 24-24s-10.7-24-24-24H120z"/>
</svg>
<h2 class="swp-h2 swp-margin-b15">
<?php esc_html_e( 'View Documentation', 'searchwp' ); ?>
</h2>
<p class="swp-card--p">
<?php esc_html_e( 'Browse documentation, reference material, and tutorials for SearchWP.', 'searchwp' ); ?>
</p>
<a href="https://searchwp.com/documentation/?utm_source=WordPress&utm_medium=settings&utm_campaign=plugin&utm_content=View+All+Documentation" target="_blank" class="swp-button swp-margin-auto swp-margin-t25">
<?php esc_html_e( 'View All Documentation', 'searchwp' ); ?>
</a>
</div>
</div>
<div class="swp-card swp-flex--grow1 swp-text-center">
<div class="swp-card--content">
<svg class="swp-get-help--icon" xmlns="http://www.w3.org/2000/svg" height="48px" viewBox="0 0 512 512">
<!--! Font Awesome Free 6.4.0 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license (Commercial License) Copyright 2023 Fonticons, Inc. -->
<path d="M256 8C119.033 8 8 119.033 8 256s111.033 248 248 248 248-111.033 248-248S392.967 8 256 8zm173.696 119.559l-63.399 63.399c-10.987-18.559-26.67-34.252-45.255-45.255l63.399-63.399a218.396 218.396 0 0 1 45.255 45.255zM256 352c-53.019 0-96-42.981-96-96s42.981-96 96-96 96 42.981 96 96-42.981 96-96 96zM127.559 82.304l63.399 63.399c-18.559 10.987-34.252 26.67-45.255 45.255l-63.399-63.399a218.372 218.372 0 0 1 45.255-45.255zM82.304 384.441l63.399-63.399c10.987 18.559 26.67 34.252 45.255 45.255l-63.399 63.399a218.396 218.396 0 0 1-45.255-45.255zm302.137 45.255l-63.399-63.399c18.559-10.987 34.252-26.67 45.255-45.255l63.399 63.399a218.403 218.403 0 0 1-45.255 45.255z"/>
</svg>
<h2 class="swp-h2 swp-margin-b15">
<?php esc_html_e( 'Get Support', 'searchwp' ); ?>
</h2>
<p class="swp-card--p">
<?php esc_html_e( 'Submit a ticket and our world-class support team will be in touch soon.', 'searchwp' ); ?>
</p>
<a href="https://searchwp.com/account/support/?utm_source=WordPress&utm_medium=settings&utm_campaign=plugin&utm_content=Submit+Support+Ticket" target="_blank" class="swp-button swp-margin-auto swp-margin-t25">
<?php esc_html_e( 'Submit a Support Ticket', 'searchwp' ); ?>
</a>
</div>
</div>
</div>
</div>
</div>
<div class="swp-flex--row sm:swp-flex--col sm:swp-flex--gap30">
<div class="swp-col swp-col--title-width">
<h3 class="swp-h3">
<?php esc_html_e( 'System Info', 'searchwp' ); ?>
</h3>
</div>
<div class="swp-col">
<textarea id="swp-tools-system-info" class="swp-textarea swp-w-5/6 swp-margin-b15 sm:swp-w-full" rows="15" readonly><?php echo esc_html( self::get_formatted_system_info() ); ?></textarea>
<div class="swp-flex--row swp-flex--gap17 swp-flex--align-c">
<button id="swp-tools-system-info-copy" class="swp-button">
<?php esc_html_e( 'Copy to Clipboard', 'searchwp' ); ?>
</button>
</div>
</div>
</div>
</div>
</div>
</div> <!-- End System Info collapse -->
</div>
</div>
<?php
}
/**
* Returns a formatted version of the system information.
*
* @since 4.3.0
*
* @return string
*/
private static function get_formatted_system_info() {
global $wpdb;
$stopwords = new \SearchWP\Logic\Stopwords();
$synonyms = new \SearchWP\Logic\Synonyms();
$theme_data = wp_get_theme();
$response = wp_remote_post( 'https://searchwp.com/', [
'sslverify' => false,
'timeout' => 5,
'user-agent' => 'SearchWP',
'body' => [ 'cmd' => '_notify-validate' ],
] );
$active_plugins = get_option( 'active_plugins', [] );
$network_plugins = get_site_option( 'active_sitewide_plugins', [] );
$db_info = Utils::get_db_details();
$system_info = [
'Multisite' => is_multisite() ? 'Yes' : 'No',
'SITE_URL' => site_url(),
'HOME_URL' => home_url(),
'SearchWP Version' => SEARCHWP_VERSION,
'SearchWP License' => License::get_key(),
'WordPress Version' => get_bloginfo( 'version' ),
'Active Theme' => $theme_data->Name . ' ' . $theme_data->Version,
'PHP Version' => PHP_VERSION,
'Database' => $db_info['engine'] . ' ' . $db_info['version'],
'WordPress Memory Limit' => WP_MEMORY_LIMIT,
'PHP Memory Limit' => function_exists( 'ini_get' ) ? ini_get( 'memory_limit' ) : '?',
'PHP Time Limit' => function_exists( 'ini_get' ) ? (int) ini_get( 'max_execution_time' ) : '?',
'WP_DEBUG' => defined( 'WP_DEBUG' ) && WP_DEBUG ? 'Enabled' : 'Disabled',
'DISABLE_WP_CRON' => defined( 'DISABLE_WP_CRON' ) && DISABLE_WP_CRON ? 'Enabled' : 'Disabled',
'searchwp.com reachable' => ! is_wp_error( $response ) && $response['response']['code'] >= 200 && $response['response']['code'] < 300 ? 'Yes' : 'No',
'Active Plugins' => array_values( array_map( function( $plugin ) {
return [ $plugin['Name'] => $plugin['Version'] ];
}, array_filter( get_plugins(), function( $plugin ) use ( $active_plugins ) {
return in_array( $plugin, $active_plugins, true );
}, ARRAY_FILTER_USE_KEY ) ) ),
'Network Active Plugins' => ! function_exists( 'wp_get_active_network_plugins' ) ? [] : array_map( function( $plugin ) {
$plugin = get_plugin_data( $plugin );
return [ $plugin['Name'] => $plugin['Version'] ];
}, array_filter( wp_get_active_network_plugins(), function( $plugin ) use ( $network_plugins ) {
$plugin_base = plugin_basename( $plugin );
return array_key_exists( $plugin_base, $network_plugins );
} ) ),
'Index Stats' => \SearchWP::$index->get_stats(),
'Engines' => array_map( function( $engine ) {
return Utils::normalize_engine_config( json_decode( json_encode( $engine ), true ) );
}, Settings::get_engines() ),
'Stopwords' => $stopwords->get(),
'Synonyms' => $synonyms->get(),
'Settings' => Settings::get(),
'Advanced' => call_user_func_array( 'array_merge', array_map( function( $key ) {
return [ $key => Settings::get_single( $key, 'boolean' ) ];
}, Settings::get_keys() ) ),
];
$complex_items = [
'Active Plugins',
'Network Active Plugins',
'Index Stats',
'Stopwords',
'Synonyms',
'Settings',
'Engines',
'Advanced',
];
if ( is_multisite() ) {
$complex_items[] = 'Network Active Plugins';
} else {
unset( $system_info['Network Active Plugins'] );
}
$server_info = [];
foreach ( $system_info as $item => $data ) {
if ( in_array( $item, $complex_items ) ) {
continue;
}
$server_info[] = [
'Item' => $item,
'Value' => self::get_formatted_system_info_item_data( $item, $data ),
];
}
// Render a table without a header.
$formatted = explode( "\n", ( new \SearchWP\Dependencies\dekor\ArrayToTextTable( $server_info ) )->render() );
array_splice( $formatted, 1, 2 );
$formatted = implode( "\n", $formatted );
$formatted .= "\n\n" . implode( "\n\n", array_filter( array_map( function( $item, $data ) use ( $complex_items ) {
if ( ! in_array( $item, $complex_items ) ) {
return false;
}
$label = strtoupper( $item );
if ( 'SETTINGS' === $label ) {
$label = 'SOURCES';
}
return $label . "\n\n" . self::get_formatted_system_info_item_data( $item, $data ) . "\n";
}, array_keys( $system_info ), array_values( $system_info ) ) ) );
return $formatted;
}
/**
* Formats individual System Info items into something more readable.
*
* @since 4.3.0
*
* @param string $item The item being formatted.
* @param mixed $data The data for the item being formatted.
*
* @return string The formatted data.
*/
private static function get_formatted_system_info_item_data( string $item, $data ) {
$formatted = '';
switch ( $item ) {
case 'Active Plugins':
case 'Network Active Plugins':
case 'Index Stats':
if ( isset( $data[0] ) && is_array( $data[0] ) ) {
$data = call_user_func_array( 'array_merge', $data );
}
if ( 'Index Stats' === $item ) {
$data = [
'Last Activity' => $data['lastActivity'],
'Indexed' => $data['indexed'],
'Total' => $data['total'],
'Outdated' => $data['outdated'] ? 'Yes' : 'No',
];
}
if ( empty( $data ) ) {
$formatted = '[[ NONE ]]';
} else {
$title_col_length = max( array_map( 'strlen', array_keys( $data ) ) );
$formatted = implode( "\n", array_map( function( $plugin, $version ) use ( $title_col_length ) {
return str_pad( $plugin . ': ', $title_col_length + 2 ) . ' ' . $version;
}, array_keys( $data ), array_values( $data ) ) );
}
break;
case 'Engines':
if ( ! is_array( $data ) || empty( $data ) ) {
$formatted = '[[ NONE ]]';
} else {
$formatted = str_replace( "\n\n", "\n", str_replace( ' ', ' ', print_r( array_map( function( $engine ) {
$engine['settings'] = array_filter( $engine['settings'] );
$engine['sources'] = array_map( function( $source ) {
return array_filter( $source );
}, $engine['sources'] );
return $engine;
}, $data ), true ) ) );
}
break;
case 'Stopwords':
$formatted = wordwrap( implode( ', ', $data ) );
break;
case 'Synonyms':
if ( empty( $data ) ) {
$formatted = '[[ NONE ]]';
} else {
$pad = max( array_map( 'strlen', wp_list_pluck( $data, 'sources' ) ) );
$formatted = implode( "\n", array_map( function( $synonym ) use ( $pad ) {
return str_pad( $synonym['sources'], $pad ) . ' => ' . $synonym['synonyms'] . ( $synonym['replace'] ? ' (replace)' : '' );
}, $data ) );
}
break;
case 'Settings': // We are going to extract Source names.
if ( empty( $data['sources'] ) ) {
$formatted = '[[ NONE ]]';
} else {
$formatted = wordwrap( implode( ', ', array_keys( $data['sources'] ) ) );
}
break;
case 'Advanced':
$settings = [
'debug' => 'Debugging Enabled',
'index_outdated' => 'Index Outdated',
'partial_matches' => 'Partial Matches',
'highlighting' => 'Highlighting',
'parse_shortcodes' => 'Parse Shortcodes',
'do_suggestions' => 'Do Suggestions',
'quoted_search_support' => 'Quoted Search Support',
'tokenize_pattern_matches' => 'Tokenize Pattern Matches',
'remove_min_word_length' => 'Remove Min Word Length',
'reduced_indexer_aggressiveness' => 'Reduced Aggressiveness',
'indexer_paused' => 'Indexer Paused',
'hide_announcements' => 'Hide Announcements',
'nuke_on_delete' => 'Remove Data on Delete',
];
$pad = max( array_map( 'strlen', $settings ) );
$formatted = implode( "\n", array_filter( array_map( function( $setting, $value ) use ( $pad, $settings ) {
if ( ! array_key_exists( $setting, $settings ) ) {
return false;
}
return str_pad( $settings[ $setting ], $pad ) . ' => ' . ( empty( $value ) ? 'No' : 'Yes' );
}, array_keys( $data ), array_values( $data ) ) ) );
break;
default:
$formatted = (string) $data;
}
return $formatted;
}
}