SearchWP.php
12.2 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
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
<?php
/**
* The main SearchWP class.
*
* @package SearchWP
* @author Jon Christopher
*/
use SearchWP\Utils;
use SearchWP\Index\Controller as Index;
/**
* Class SearchWP initializes core components.
*
* @since 4.0
*/
class SearchWP {
/**
* Singleton Index reference.
*
* @since 4.0
* @var Index
*/
public static $index;
/**
* Singleton Indexer reference.
*
* @since 4.0
* @var \SearchWP\Indexer
*/
public static $indexer;
/**
* Regsitered Sources reference.
*
* @since 4.0
* @var \SearchWP\Source[]
*/
private static $sources = [];
/**
* Singleton Native reference.
*
* @since 4.0
* @var \SearchWP\Native
*/
public static $native;
/**
* Whether suggestion output has been ouput.
*
* @since 4.0.32
* @var bool
*/
private $did_suggestion = false;
/**
* Constructor.
*
* @since 4.0
* @return void
*/
function __construct() {
new \SearchWP\License();
new \SearchWP\Debug();
new \SearchWP\CLI();
add_action( 'admin_init', function() {
\SearchWP\Upgrader::run();
}, 99999 );
// set_transient( 'searchwp_activation_redirect', 30 );
\SearchWP\Admin\Views\WelcomeView::init();
add_action( 'init', [ $this, 'init' ], 99999 );
if ( ! has_action( SEARCHWP_PREFIX . 'network_install', [ __CLASS__, 'network_install' ] ) ) {
add_action( SEARCHWP_PREFIX . 'network_install', [ __CLASS__, 'network_install' ] );
}
// Single event after Engine save.
if ( ! has_action( SEARCHWP_PREFIX . 'index_dispatch', [ $this, '_dispatch' ] ) ) {
add_action( SEARCHWP_PREFIX . 'index_dispatch', [ $this, '_dispatch' ] );
}
add_action( 'switch_blog', function( $new_blog_id, $prev_blog_id ) {
if (
$new_blog_id != $prev_blog_id
&& apply_filters( 'searchwp\auto_update_providers', false, [ 'site' => $new_blog_id, ] )
) {
$this->set_providers();
}
}, 99, 2 );
}
/**
* Callback to single CRON event after Engine save.
*
* @since 4.0
*/
public function _dispatch() {
self::$indexer->trigger();
}
/**
* Callback to perform network wide installation procedure.
*
* @since 4.0
*/
public static function network_install() {
\SearchWP\Upgrader::run( true );
}
/**
* Getter for registered Sources.
*
* @since 4.0
* @return \SearchWP\Source[]
*/
public static function get_sources() {
return self::$sources;
}
/**
* Setter and initializer for Sources.
*
* @since 4.0
* @return void
*/
private static function set_sources() {
$sources = apply_filters( 'searchwp\sources', self::get_core_sources() );
// If the data is unexpected, revert.
if ( ! is_array( $sources ) || empty( $sources ) ) {
do_action( 'searchwp\debug\log', 'Found unexpected Sources, reverting', 'main' );
do_action( 'searchwp\debug\log', print_r( $sources, true ), 'main' );
self::$sources = self::get_core_sources();
return;
}
// Validate that we have only Source objects.
foreach ( $sources as $source ) {
if ( $source instanceof \SearchWP\Source ) {
$source->init();
self::$sources[ $source->get_name() ] = $source;
} else {
do_action( 'searchwp\debug\log', 'Skipping invalid Source', 'main' );
do_action( 'searchwp\debug\log', print_r( $source, true ), 'main' );
}
}
}
/**
* Defines the Sources we're going to support by default.
*
* @since 4.0
* @return array The Sources themselves.
*/
private static function get_core_sources() {
$registered_post_types = Utils::get_post_types();
// Add each post type as a Source.
$post_types = [];
foreach ( $registered_post_types as $key => $post_type ) {
// Attachments require a custom Source so remove it for now.
if ( 'attachment' === $key ) {
continue;
}
$post_types[ $key ] = new \SearchWP\Sources\Post( $post_type );
}
$sources = array_values( $post_types );
$sources[] = new \SearchWP\Sources\Attachment();
$sources[] = new \SearchWP\Sources\Comment();
$sources[] = new \SearchWP\Sources\User();
return $sources;
}
/**
* Environment setup.
*
* @since 4.0
* @return void
*/
public function set_providers() {
self::set_sources();
// Instantiate Index so we can instantiate Sources.
self::$index = new Index();
self::$index->_add_hooks();
// Instantiate the Indexer.
self::$indexer = new \SearchWP\Indexer();
do_action( 'searchwp\init' );
}
/**
* Callback to init action, trigger the Indexer.
*
* @since 4.0
* @return void
*/
public function init() {
$this->load_plugin_textdomain();
self::setup_integrations();
$this->set_providers();
// Implement global behaviors.
new \SearchWP\Statistics();
new \SearchWP\Logic\Stopwords();
new \SearchWP\Logic\Synonyms();
new \SearchWP\Logic\PartialMatches();
searchwp()
->register( \SearchWP\Debug\Watcher::class )
->init();
searchwp()
->register( \SearchWP\Debug\Console\Console::class )
->init();
searchwp()
->register( \SearchWP\Forms\Frontend::class )
->init();
// Hook in to core behavior.
$this->add_hooks();
// Handle native searches.
self::$native = new \SearchWP\Native();
// Add REST search handler.
if ( apply_filters( 'searchwp\rest', true ) ) {
add_filter( 'wp_rest_search_handlers', function( $handlers ) {
return [ new \SearchWP\Rest() ];
}, 99 );
}
// Schedule Maintenance.
if ( ! wp_next_scheduled( SEARCHWP_PREFIX . 'maintenance' ) ) {
wp_schedule_event( time(), 'daily', SEARCHWP_PREFIX . 'maintenance' );
}
do_action( 'searchwp\loaded' );
}
/**
* Set up global integrations.
*
* @since 4.1.5
* @return void
*/
private static function setup_integrations() {
// Divi Search Results Template with Archive Posts Module.
if ( apply_filters( 'searchwp\integration\divi', 'divi' === strtolower( get_template() ) ) ) {
new \SearchWP\Integrations\Divi();
}
if ( ! function_exists( 'is_plugin_active' ) ) {
if ( file_exists( ABSPATH . 'wp-admin/includes/plugin.php' ) ) {
include_once ABSPATH . 'wp-admin/includes/plugin.php';
} else {
return;
}
}
// Beaver Builder Themer Plugin doesn't need an integration in most cases, so it's opt-in.
if ( apply_filters(
'searchwp\integration\beaver-builder',
is_plugin_active( 'bb-plugin/fl-builder.php' ) )
) {
new \SearchWP\Integrations\BeaverBuilder();
}
if ( apply_filters(
'searchwp\integration\wp-all-import',
is_plugin_active( 'wp-all-import/plugin.php' )
|| is_plugin_active( 'wp-all-import-pro/wp-all-import-pro.php' )
)
) {
$wpai = new \SearchWP\Integrations\WpAllImport();
$wpai->init();
}
}
/**
* Adds hooks to core behavior.
*
* @since 4.0
* @return void
*/
private function add_hooks() {
// Output suggested search after a query is run.
add_action( 'searchwp\query\ran', [ $this, 'query_ran' ], 5 );
// If we're in the Admin, implement our Options screen.
if ( is_admin() ) {
new \SearchWP\Admin\AdminBar();
if ( empty( \SearchWP\Settings::get( 'hide_announcements' ) ) ) {
\SearchWP\Admin\Notifications\Notifications::init();
}
// Legacy version of Metrics extension compatibility.
// This line has to be deleted once Metrics v1.4.2 is released.
\SearchWP\Admin\LegacyMetricsCompat::hooks();
new \SearchWP\Admin\OptionsView();
new \SearchWP\Admin\DashboardWidgets\StatisticsDashboardWidget();
if ( apply_filters( 'searchwp\missing_integration_notices', true ) ) {
add_action( 'admin_init', [ $this, 'check_for_missing_integrations' ] );
}
if ( file_exists( SEARCHWP_PLUGIN_DIR . '/searchwp.php' ) ) {
new \SearchWP\Admin\AdminNotices\DirtyInstallAdminNotice();
}
}
// Trigger the Indexer (and Controller) when it has been unpaused.
add_action( 'searchwp\settings\update\indexer_paused', function( $value ) {
if ( $value ) {
self::$index->trigger();
self::$indexer->trigger();
}
}, 5 );
}
/**
* Callback for searchwp\query\ran hook.
*
* @since 4.0
* @param \SearchWP\Query $query The query being run.
* @return void
*/
public function query_ran( \SearchWP\Query $query ) {
// Suggested search handling.
if (
$query->get_suggested_search()
&& apply_filters( 'searchwp\query\output_suggested_search',
\SearchWP\Settings::get( 'do_suggestions', 'boolean' ),
$query )
&& ! $this->did_suggestion
) {
$this->did_suggestion = true;
add_action( 'loop_start', function( $wp_query ) use( $query ) {
if ( $wp_query->is_main_query() ) {
$this->output_suggested_search( $query->get_suggested_search() );
}
} );
}
}
/**
* Callback for loop_start action to output suggested search revision.
*
* @since 4.0
* @param string $suggestion The revised search.
* @return void
*/
public function output_suggested_search( string $suggestion ) {
do_action( 'searchwp\debug\log', "Render suggested search: {$suggestion}", 'core' );
echo '<p class="searchwp-revised-search-notice">';
echo wp_kses(
sprintf(
// Translators: Placeholder is the revised search string.
__( 'Showing results for <em class="searchwp-suggested-revision-query">%s</em>', 'searchwp' ),
esc_html( $suggestion )
),
[ 'em' => [ 'class' => [], ], ]
);
echo '</p>';
}
/**
* Load textdomain.
*
* @since 4.0
* @return void
*/
public function load_plugin_textdomain() {
load_plugin_textdomain( 'searchwp', false, dirname( plugin_basename( SEARCHWP_PLUGIN_FILE ) ) . '/languages/' );
}
/**
* Compares active Plugins with known SearchWP Extensions and outputs an Admin Notice when one is missing.
*
* @since 4.0
* @return void
*/
public function check_for_missing_integrations() {
// These are the available integration Extensions.
$integration_extensions = [
'bbpress' => [
'plugin' => [
'file' => 'bbpress/bbpress.php',
'name' => 'bbPress',
'url' => 'https://wordpress.org/plugins/bbpress/',
],
'integration' => [
'file' => 'searchwp-bbpress/searchwp-bbpress.php',
'name' => 'bbPress Integration',
'url' => 'https://searchwp.com/extensions/bbpress-integration/',
],
],
'wpml' => [
'plugin' => [
'file' => 'sitepress-multilingual-cms/sitepress.php',
'name' => 'WPML',
'url' => 'http://wpml.org/',
],
'integration' => [
'file' => 'searchwp-wpml/searchwp-wpml.php',
'name' => 'WPML Integration',
'url' => 'https://searchwp.com/extensions/wpml-integration/',
],
],
'polylang' => [
'plugin' => [
'file' => 'polylang/polylang.php',
'name' => 'Polylang',
'url' => 'https://wordpress.org/plugins/polylang/',
],
'integration' => [
'file' => 'searchwp-polylang/searchwp-polylang.php',
'name' => 'Polylang Integration',
'url' => 'https://searchwp.com/extensions/polylang-integration/',
],
],
'woocommerce' => [
'plugin' => [
'file' => 'woocommerce/woocommerce.php',
'name' => 'WooCommerce',
'url' => 'https://wordpress.org/plugins/woocommerce/',
],
'integration' => [
'file' => 'searchwp-woocommerce/searchwp-woocommerce.php',
'name' => 'WooCommerce Integration',
'url' => 'https://searchwp.com/extensions/woocommerce-integration/',
],
],
'wpjobmanager' => [
'plugin' => [
'file' => 'wp-job-manager/wp-job-manager.php',
'name' => 'WP Job Manager',
'url' => 'https://wordpress.org/plugins/wp-job-manager/',
],
'integration' => [
'file' => 'searchwp-wp-job-manager-integration/searchwp-wp-job-manager-integration.php',
'name' => 'WP Job Manager Integration',
'url' => 'https://searchwp.com/extensions/wp-job-manager-integration/',
],
],
'privatecontent' => [
'plugin' => [
'file' => 'private-content/private_content.php',
'name' => 'PrivateContent',
'url' => 'http://codecanyon.net/item/privatecontent-multilevel-content-plugin/1467885',
],
'integration' => [
'file' => 'searchwp-privatecontent/searchwp-privatecontent.php',
'name' => 'PrivateContent Integration',
'url' => 'https://searchwp.com/extensions/privatecontent-integration/',
],
],
];
foreach ( $integration_extensions as $slug => $integration_extension ) {
if (
is_plugin_active( $integration_extension['plugin']['file'] )
&& ! is_plugin_active( $integration_extension['integration']['file'] )
) {
new \SearchWP\Admin\AdminNotices\MissingIntegrationAdminNotice( $slug, $integration_extension );
}
}
}
}