-
Notifications
You must be signed in to change notification settings - Fork 5
/
class.jetpack-search.php
2024 lines (1721 loc) · 57.7 KB
/
class.jetpack-search.php
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
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
<?php // phpcs:ignore WordPress.Files.FileName.InvalidClassFileName
/**
* Jetpack Search: Main Jetpack_Search class
*
* @package Jetpack
* @subpackage Jetpack Search
* @since 5.0.0
*/
use Automattic\Jetpack\Connection\Client;
require_once __DIR__ . '/class-jetpack-search-options.php';
/**
* The main class for the Jetpack Search module.
*
* @since 5.0.0
*/
class Jetpack_Search {
/**
* The number of found posts.
*
* @since 5.0.0
*
* @var int
*/
protected $found_posts = 0;
/**
* The search result, as returned by the WordPress.com REST API.
*
* @since 5.0.0
*
* @var array
*/
protected $search_result;
/**
* This site's blog ID on WordPress.com.
*
* @since 5.0.0
*
* @var int
*/
protected $jetpack_blog_id;
/**
* The Elasticsearch aggregations (filters).
*
* @since 5.0.0
*
* @var array
*/
protected $aggregations = array();
/**
* The maximum number of aggregations allowed.
*
* @since 5.0.0
*
* @var int
*/
protected $max_aggregations_count = 100;
/**
* Statistics about the last Elasticsearch query.
*
* @since 5.6.0
*
* @var array
*/
protected $last_query_info = array();
/**
* Statistics about the last Elasticsearch query failure.
*
* @since 5.6.0
*
* @var array
*/
protected $last_query_failure_info = array();
/**
* The singleton instance of this class.
*
* @since 5.0.0
*
* @var Jetpack_Search
*/
protected static $instance;
/**
* Languages with custom analyzers. Other languages are supported, but are analyzed with the default analyzer.
*
* @since 5.0.0
*
* @var array
*/
public static $analyzed_langs = array( 'ar', 'bg', 'ca', 'cs', 'da', 'de', 'el', 'en', 'es', 'eu', 'fa', 'fi', 'fr', 'he', 'hi', 'hu', 'hy', 'id', 'it', 'ja', 'ko', 'nl', 'no', 'pt', 'ro', 'ru', 'sv', 'tr', 'zh' );
/**
* Jetpack_Search constructor.
*
* @since 5.0.0
*
* Doesn't do anything. This class needs to be initialized via the instance() method instead.
*/
protected function __construct() {
}
/**
* Prevent __clone()'ing of this class.
*
* @since 5.0.0
*/
public function __clone() {
wp_die( "Please don't __clone Jetpack_Search" );
}
/**
* Prevent __wakeup()'ing of this class.
*
* @since 5.0.0
*/
public function __wakeup() {
wp_die( "Please don't __wakeup Jetpack_Search" );
}
/**
* Get singleton instance of Jetpack_Search.
*
* Instantiates and sets up a new instance if needed, or returns the singleton.
*
* @since 5.0.0
*
* @return Jetpack_Search The Jetpack_Search singleton.
*/
public static function instance() {
if ( ! isset( self::$instance ) ) {
if ( Jetpack_Search_Options::is_instant_enabled() ) {
require_once __DIR__ . '/class-jetpack-instant-search.php';
self::$instance = new Jetpack_Instant_Search();
} else {
self::$instance = new Jetpack_Search();
}
self::$instance->setup();
}
return self::$instance;
}
/**
* Perform various setup tasks for the class.
*
* Checks various pre-requisites and adds hooks.
*
* @since 5.0.0
*/
public function setup() {
if ( ! Jetpack::is_connection_ready() || ! $this->is_search_supported() ) {
/**
* Fires when the Jetpack Search fails and would fallback to MySQL.
*
* @module search
* @since 7.9.0
*
* @param string $reason Reason for Search fallback.
* @param mixed $data Data associated with the request, such as attempted search parameters.
*/
do_action( 'jetpack_search_abort', 'inactive', null );
return;
}
$this->jetpack_blog_id = Jetpack::get_option( 'id' );
if ( ! $this->jetpack_blog_id ) {
/** This action is documented in modules/search/class.jetpack-search.php */
do_action( 'jetpack_search_abort', 'no_blog_id', null );
return;
}
$this->load_php();
$this->init_hooks();
}
/**
* Loads the php for this version of search
*
* @since 8.3.0
*/
public function load_php() {
$this->base_load_php();
}
/**
* Loads the PHP common to all search. Should be called from extending classes.
*/
protected function base_load_php() {
require_once __DIR__ . '/class.jetpack-search-helpers.php';
require_once __DIR__ . '/class.jetpack-search-template-tags.php';
require_once JETPACK__PLUGIN_DIR . 'modules/widgets/search.php';
}
/**
* Setup the various hooks needed for the plugin to take over search duties.
*
* @since 5.0.0
*/
public function init_hooks() {
if ( ! is_admin() ) {
add_filter( 'posts_pre_query', array( $this, 'filter__posts_pre_query' ), 10, 2 );
add_filter( 'jetpack_search_es_wp_query_args', array( $this, 'filter__add_date_filter_to_query' ), 10, 2 );
add_action( 'did_jetpack_search_query', array( $this, 'store_last_query_info' ) );
add_action( 'failed_jetpack_search_query', array( $this, 'store_query_failure' ) );
add_action( 'init', array( $this, 'set_filters_from_widgets' ) );
add_action( 'pre_get_posts', array( $this, 'maybe_add_post_type_as_var' ) );
} else {
add_action( 'update_option', array( $this, 'track_widget_updates' ), 10, 3 );
}
add_action( 'jetpack_deactivate_module_search', array( $this, 'move_search_widgets_to_inactive' ) );
}
/**
* Is search supported on the current plan
*
* @since 6.0
* Loads scripts for Tracks analytics library
*/
public function is_search_supported() {
if ( method_exists( 'Jetpack_Plan', 'supports' ) ) {
return Jetpack_Plan::supports( 'search' );
}
return false;
}
/**
* Does this site have a VIP index
* Get the version number to use when loading the file. Allows us to bypass cache when developing.
*
* @since 6.0
* @return string $script_version Version number.
*/
public function has_vip_index() {
return defined( 'JETPACK_SEARCH_VIP_INDEX' ) && JETPACK_SEARCH_VIP_INDEX;
}
/**
* When an Elasticsearch query fails, this stores it and enqueues some debug information in the footer.
*
* @since 5.6.0
*
* @param array $meta Information about the failure.
*/
public function store_query_failure( $meta ) {
$this->last_query_failure_info = $meta;
add_action( 'wp_footer', array( $this, 'print_query_failure' ) );
}
/**
* Outputs information about the last Elasticsearch failure.
*
* @since 5.6.0
*/
public function print_query_failure() {
if ( $this->last_query_failure_info ) {
printf(
'<!-- Jetpack Search failed with code %s: %s - %s -->',
esc_html( $this->last_query_failure_info['response_code'] ),
esc_html( $this->last_query_failure_info['json']['error'] ),
esc_html( $this->last_query_failure_info['json']['message'] )
);
}
}
/**
* Stores information about the last Elasticsearch query and enqueues some debug information in the footer.
*
* @since 5.6.0
*
* @param array $meta Information about the query.
*/
public function store_last_query_info( $meta ) {
$this->last_query_info = $meta;
add_action( 'wp_footer', array( $this, 'print_query_success' ) );
}
/**
* Outputs information about the last Elasticsearch search.
*
* @since 5.6.0
*/
public function print_query_success() {
if ( $this->last_query_info ) {
printf(
'<!-- Jetpack Search took %s ms, ES time %s ms -->',
(int) $this->last_query_info['elapsed_time'],
esc_html( $this->last_query_info['es_time'] )
);
if ( isset( $_GET['searchdebug'] ) ) { // phpcs:ignore WordPress.Security.NonceVerification.Recommended
printf(
'<!-- Query response data: %s -->',
esc_html( print_r( $this->last_query_info, 1 ) ) // phpcs:ignore WordPress.PHP.DevelopmentFunctions.error_log_print_r
);
}
}
}
/**
* Returns the last query information, or false if no information was stored.
*
* @since 5.8.0
*
* @return bool|array
*/
public function get_last_query_info() {
return empty( $this->last_query_info ) ? false : $this->last_query_info;
}
/**
* Returns the last query failure information, or false if no failure information was stored.
*
* @since 5.8.0
*
* @return bool|array
*/
public function get_last_query_failure_info() {
return empty( $this->last_query_failure_info ) ? false : $this->last_query_failure_info;
}
/**
* Wraps a WordPress filter called "jetpack_search_disable_widget_filters" that allows
* developers to disable filters supplied by the search widget. Useful if filters are
* being defined at the code level.
*
* @since 5.7.0
* @deprecated 5.8.0 Use Jetpack_Search_Helpers::are_filters_by_widget_disabled() directly.
*
* @return bool
*/
public function are_filters_by_widget_disabled() {
return Jetpack_Search_Helpers::are_filters_by_widget_disabled();
}
/**
* Retrieves a list of known Jetpack search filters widget IDs, gets the filters for each widget,
* and applies those filters to this Jetpack_Search object.
*
* @since 5.7.0
*/
public function set_filters_from_widgets() {
if ( Jetpack_Search_Helpers::are_filters_by_widget_disabled() ) {
return;
}
$filters = Jetpack_Search_Helpers::get_filters_from_widgets();
if ( ! empty( $filters ) ) {
$this->set_filters( $filters );
}
}
/**
* Restricts search results to certain post types via a GET argument.
*
* @since 5.8.0
*
* @param WP_Query $query A WP_Query instance.
*/
public function maybe_add_post_type_as_var( WP_Query $query ) {
$post_type = ( ! empty( $_GET['post_type'] ) ) ? $_GET['post_type'] : false; // phpcs:ignore WordPress.Security.NonceVerification.Recommended
if ( $this->should_handle_query( $query ) && $post_type ) {
$post_types = ( is_string( $post_type ) && false !== strpos( $post_type, ',' ) )
? explode( ',', $post_type )
: (array) $post_type;
$post_types = array_map( 'sanitize_key', $post_types );
$query->set( 'post_type', $post_types );
}
}
/**
* Run a search on the WordPress.com public API.
*
* @since 5.0.0
*
* @param array $es_args Args conforming to the WP.com /sites/<blog_id>/search endpoint.
*
* @return object|WP_Error The response from the public API, or a WP_Error.
*/
public function search( array $es_args ) {
$endpoint = sprintf( '/sites/%s/search', $this->jetpack_blog_id );
$service_url = 'https://public-api.wordpress.com/rest/v1' . $endpoint;
$do_authenticated_request = false;
if ( class_exists( 'Automattic\\Jetpack\\Connection\\Client' ) &&
isset( $es_args['authenticated_request'] ) &&
true === $es_args['authenticated_request'] ) {
$do_authenticated_request = true;
}
unset( $es_args['authenticated_request'] );
$request_args = array(
'headers' => array(
'Content-Type' => 'application/json',
),
'timeout' => 10,
'user-agent' => 'jetpack_search',
);
$request_body = wp_json_encode( $es_args );
$start_time = microtime( true );
if ( $do_authenticated_request ) {
$request_args['method'] = 'POST';
$request = Client::wpcom_json_api_request_as_blog( $endpoint, Client::WPCOM_JSON_API_VERSION, $request_args, $request_body );
} else {
$request_args = array_merge(
$request_args,
array(
'body' => $request_body,
)
);
$request = wp_remote_post( $service_url, $request_args );
}
$end_time = microtime( true );
if ( is_wp_error( $request ) ) {
return $request;
}
$response_code = wp_remote_retrieve_response_code( $request );
if ( ! $response_code || $response_code < 200 || $response_code >= 300 ) {
return new WP_Error( 'invalid_search_api_response', 'Invalid response from API - ' . $response_code );
}
$response = json_decode( wp_remote_retrieve_body( $request ), true );
$took = is_array( $response ) && ! empty( $response['took'] )
? $response['took']
: null;
$query = array(
'args' => $es_args,
'response' => $response,
'response_code' => $response_code,
'elapsed_time' => ( $end_time - $start_time ) * 1000, // Convert from float seconds to ms.
'es_time' => $took,
'url' => $service_url,
);
/**
* Fires after a search request has been performed.
*
* Includes the following info in the $query parameter:
*
* array args Array of Elasticsearch arguments for the search
* array response Raw API response, JSON decoded
* int response_code HTTP response code of the request
* float elapsed_time Roundtrip time of the search request, in milliseconds
* float es_time Amount of time Elasticsearch spent running the request, in milliseconds
* string url API url that was queried
*
* @module search
*
* @since 5.0.0
* @since 5.8.0 This action now fires on all queries instead of just successful queries.
*
* @param array $query Array of information about the query performed
*/
do_action( 'did_jetpack_search_query', $query );
if ( ! $response_code || $response_code < 200 || $response_code >= 300 ) {
/**
* Fires after a search query request has failed
*
* @module search
*
* @since 5.6.0
*
* @param array Array containing the response code and response from the failed search query
*/
do_action(
'failed_jetpack_search_query',
array(
'response_code' => $response_code,
'json' => $response,
)
);
return new WP_Error( 'invalid_search_api_response', 'Invalid response from API - ' . $response_code );
}
return $response;
}
/**
* Bypass the normal Search query and offload it to Jetpack servers.
*
* This is the main hook of the plugin and is responsible for returning the posts that match the search query.
*
* @since 5.0.0
*
* @param array $posts Current array of posts (still pre-query).
* @param WP_Query $query The WP_Query being filtered.
*
* @return array Array of matching posts.
*/
public function filter__posts_pre_query( $posts, $query ) {
if ( ! $this->should_handle_query( $query ) ) {
// Intentionally not adding the 'jetpack_search_abort' action since this should fire for every request except for search.
return $posts;
}
$this->do_search( $query );
if ( ! is_array( $this->search_result ) ) {
/** This action is documented in modules/search/class.jetpack-search.php */
do_action( 'jetpack_search_abort', 'no_search_results_array', $this->search_result );
return $posts;
}
// If no results, nothing to do.
if ( ! count( $this->search_result['results']['hits'] ) ) {
return array();
}
$post_ids = array();
foreach ( $this->search_result['results']['hits'] as $result ) {
$post_ids[] = (int) $result['fields']['post_id'];
}
// Query all posts now.
$args = array(
'post__in' => $post_ids,
'orderby' => 'post__in',
'perm' => 'readable',
'post_type' => 'any',
'ignore_sticky_posts' => true,
'suppress_filters' => true,
'posts_per_page' => $query->get( 'posts_per_page' ),
);
$posts_query = new WP_Query( $args );
// WP Core doesn't call the set_found_posts and its filters when filtering posts_pre_query like we do, so need to do these manually.
$query->found_posts = $this->found_posts;
$query->max_num_pages = ceil( $this->found_posts / $query->get( 'posts_per_page' ) );
return $posts_query->posts;
}
/**
* Build up the search, then run it against the Jetpack servers.
*
* @since 5.0.0
*
* @param WP_Query $query The original WP_Query to use for the parameters of our search.
*/
public function do_search( WP_Query $query ) {
if ( ! $this->should_handle_query( $query ) ) {
// If we make it here, either 'filter__posts_pre_query' somehow allowed it or a different entry to do_search.
/** This action is documented in modules/search/class.jetpack-search.php */
do_action( 'jetpack_search_abort', 'search_attempted_non_search_query', $query );
return;
}
$page = ( $query->get( 'paged' ) ) ? absint( $query->get( 'paged' ) ) : 1;
// Get maximum allowed offset and posts per page values for the API.
$max_offset = Jetpack_Search_Helpers::get_max_offset();
$max_posts_per_page = Jetpack_Search_Helpers::get_max_posts_per_page();
$posts_per_page = $query->get( 'posts_per_page' );
if ( $posts_per_page > $max_posts_per_page ) {
$posts_per_page = $max_posts_per_page;
}
// Start building the WP-style search query args.
// They'll be translated to ES format args later.
$es_wp_query_args = array(
'query' => $query->get( 's' ),
'posts_per_page' => $posts_per_page,
'paged' => $page,
'orderby' => $query->get( 'orderby' ),
'order' => $query->get( 'order' ),
);
if ( ! empty( $this->aggregations ) ) {
$es_wp_query_args['aggregations'] = $this->aggregations;
}
// Did we query for authors?
if ( $query->get( 'author_name' ) ) {
$es_wp_query_args['author_name'] = $query->get( 'author_name' );
}
$es_wp_query_args['post_type'] = $this->get_es_wp_query_post_type_for_query( $query );
$es_wp_query_args['terms'] = $this->get_es_wp_query_terms_for_query( $query );
/**
* Modify the search query parameters, such as controlling the post_type.
*
* These arguments are in the format of WP_Query arguments
*
* @module search
*
* @since 5.0.0
*
* @param array $es_wp_query_args The current query args, in WP_Query format.
* @param WP_Query $query The original WP_Query object.
*/
$es_wp_query_args = apply_filters( 'jetpack_search_es_wp_query_args', $es_wp_query_args, $query );
// If page * posts_per_page is greater than our max offset, send a 404. This is necessary because the offset is
// capped at Jetpack_Search_Helpers::get_max_offset(), so a high page would always return the last page of results otherwise.
if ( ( $es_wp_query_args['paged'] * $es_wp_query_args['posts_per_page'] ) > $max_offset ) {
$query->set_404();
return;
}
// If there were no post types returned, then 404 to avoid querying against non-public post types, which could
// happen if we don't add the post type restriction to the ES query.
if ( empty( $es_wp_query_args['post_type'] ) ) {
$query->set_404();
return;
}
// Convert the WP-style args into ES args.
$es_query_args = $this->convert_wp_es_to_es_args( $es_wp_query_args );
// Only trust ES to give us IDs, not the content since it is a mirror.
$es_query_args['fields'] = array(
'post_id',
);
/**
* Modify the underlying ES query that is passed to the search endpoint. The returned args must represent a valid ES query
*
* This filter is harder to use if you're unfamiliar with ES, but allows complete control over the query
*
* @module search
*
* @since 5.0.0
*
* @param array $es_query_args The raw Elasticsearch query args.
* @param WP_Query $query The original WP_Query object.
*/
$es_query_args = apply_filters( 'jetpack_search_es_query_args', $es_query_args, $query );
// Do the actual search query!
$this->search_result = $this->search( $es_query_args );
if ( is_wp_error( $this->search_result ) || ! is_array( $this->search_result ) || empty( $this->search_result['results'] ) || empty( $this->search_result['results']['hits'] ) ) {
$this->found_posts = 0;
return;
}
// If we have aggregations, fix the ordering to match the input order (ES doesn't guarantee the return order).
if ( isset( $this->search_result['results']['aggregations'] ) && ! empty( $this->search_result['results']['aggregations'] ) ) {
$this->search_result['results']['aggregations'] = $this->fix_aggregation_ordering( $this->search_result['results']['aggregations'], $this->aggregations );
}
// Total number of results for paging purposes. Capped at $max_offset + $posts_per_page, as deep paging gets quite expensive.
$this->found_posts = min( $this->search_result['results']['total'], $max_offset + $posts_per_page );
}
/**
* If the query has already been run before filters have been updated, then we need to re-run the query
* to get the latest aggregations.
*
* This is especially useful for supporting widget management in the customizer.
*
* @since 5.8.0
*
* @return bool Whether the query was successful or not.
*/
public function update_search_results_aggregations() {
if ( empty( $this->last_query_info ) || empty( $this->last_query_info['args'] ) ) {
return false;
}
$es_args = $this->last_query_info['args'];
$builder = new Jetpack_WPES_Query_Builder();
$this->add_aggregations_to_es_query_builder( $this->aggregations, $builder );
$es_args['aggregations'] = $builder->build_aggregation();
$this->search_result = $this->search( $es_args );
return ! is_wp_error( $this->search_result );
}
/**
* Given a WP_Query, convert its WP_Tax_Query (if present) into the WP-style Elasticsearch term arguments for the search.
*
* @since 5.0.0
*
* @param WP_Query $query The original WP_Query object for which to parse the taxonomy query.
*
* @return array The new WP-style Elasticsearch arguments (that will be converted into 'real' Elasticsearch arguments).
*/
public function get_es_wp_query_terms_for_query( WP_Query $query ) {
$args = array();
$the_tax_query = $query->tax_query;
if ( ! $the_tax_query ) {
return $args;
}
if ( ! $the_tax_query instanceof WP_Tax_Query || empty( $the_tax_query->queried_terms ) || ! is_array( $the_tax_query->queried_terms ) ) {
return $args;
}
$args = array();
foreach ( $the_tax_query->queries as $tax_query ) {
// Right now we only support slugs...see note above.
if ( ! is_array( $tax_query ) || 'slug' !== $tax_query['field'] ) {
continue;
}
$taxonomy = $tax_query['taxonomy'];
if ( ! isset( $args[ $taxonomy ] ) || ! is_array( $args[ $taxonomy ] ) ) {
$args[ $taxonomy ] = array();
}
$args[ $taxonomy ] = array_merge( $args[ $taxonomy ], $tax_query['terms'] );
}
return $args;
}
/**
* Parse out the post type from a WP_Query.
*
* Only allows post types that are not marked as 'exclude_from_search'.
*
* @since 5.0.0
*
* @param WP_Query $query Original WP_Query object.
*
* @return array Array of searchable post types corresponding to the original query.
*/
public function get_es_wp_query_post_type_for_query( WP_Query $query ) {
$post_types = $query->get( 'post_type' );
// If we're searching 'any', we want to only pass searchable post types to Elasticsearch.
if ( 'any' === $post_types ) {
$post_types = array_values(
get_post_types(
array(
'exclude_from_search' => false,
)
)
);
}
if ( ! is_array( $post_types ) ) {
$post_types = array( $post_types );
}
$post_types = array_unique( $post_types );
$sanitized_post_types = array();
// Make sure the post types are queryable.
foreach ( $post_types as $post_type ) {
if ( ! $post_type ) {
continue;
}
$post_type_object = get_post_type_object( $post_type );
if ( ! $post_type_object || $post_type_object->exclude_from_search ) {
continue;
}
$sanitized_post_types[] = $post_type;
}
return $sanitized_post_types;
}
/**
* Initialize widgets for the Search module (on wp.com only).
*
* @module search
*/
public function action__widgets_init() {
require_once __DIR__ . '/class.jetpack-search-widget-filters.php';
register_widget( 'Jetpack_Search_Widget_Filters' );
}
/**
* Get the Elasticsearch result.
*
* @since 5.0.0
*
* @param bool $raw If true, does not check for WP_Error or return the 'results' array - the JSON decoded HTTP response.
*
* @return array|bool The search results, or false if there was a failure.
*/
public function get_search_result( $raw = false ) {
if ( $raw ) {
return $this->search_result;
}
return ( ! empty( $this->search_result ) && ! is_wp_error( $this->search_result ) && is_array( $this->search_result ) && ! empty( $this->search_result['results'] ) ) ? $this->search_result['results'] : false;
}
/**
* Add the date portion of a WP_Query onto the query args.
*
* @since 5.0.0
*
* @param array $es_wp_query_args The Elasticsearch query arguments in WordPress form.
* @param WP_Query $query The original WP_Query.
*
* @return array The es wp query args, with date filters added (as needed).
*/
public function filter__add_date_filter_to_query( array $es_wp_query_args, WP_Query $query ) {
if ( $query->get( 'year' ) ) {
if ( $query->get( 'monthnum' ) ) {
// Padding.
$date_monthnum = sprintf( '%02d', $query->get( 'monthnum' ) );
if ( $query->get( 'day' ) ) {
// Padding.
$date_day = sprintf( '%02d', $query->get( 'day' ) );
$date_start = $query->get( 'year' ) . '-' . $date_monthnum . '-' . $date_day . ' 00:00:00';
$date_end = $query->get( 'year' ) . '-' . $date_monthnum . '-' . $date_day . ' 23:59:59';
} else {
$days_in_month = gmdate( 't', mktime( 0, 0, 0, $query->get( 'monthnum' ), 14, $query->get( 'year' ) ) ); // 14 = middle of the month so no chance of DST issues
$date_start = $query->get( 'year' ) . '-' . $date_monthnum . '-01 00:00:00';
$date_end = $query->get( 'year' ) . '-' . $date_monthnum . '-' . $days_in_month . ' 23:59:59';
}
} else {
$date_start = $query->get( 'year' ) . '-01-01 00:00:00';
$date_end = $query->get( 'year' ) . '-12-31 23:59:59';
}
$es_wp_query_args['date_range'] = array(
'field' => 'date',
'gte' => $date_start,
'lte' => $date_end,
);
}
return $es_wp_query_args;
}
/**
* Converts WP_Query style args to Elasticsearch args.
*
* @since 5.0.0
*
* @param array $args Array of WP_Query style arguments.
*
* @return array Array of ES style query arguments.
*/
public function convert_wp_es_to_es_args( array $args ) {
jetpack_require_lib( 'jetpack-wpes-query-builder/jetpack-wpes-query-parser' );
$defaults = array(
'blog_id' => get_current_blog_id(),
'query' => null, // Search phrase.
'query_fields' => array(), // list of fields to search.
'excess_boost' => array(), // map of field to excess boost values (multiply).
'post_type' => null, // string or an array.
'terms' => array(), // ex: array( 'taxonomy-1' => array( 'slug' ), 'taxonomy-2' => array( 'slug-a', 'slug-b' ) ). phpcs:ignore Squiz.PHP.CommentedOutCode.Found.
'author' => null, // id or an array of ids.
'author_name' => array(), // string or an array.
'date_range' => null, // array( 'field' => 'date', 'gt' => 'YYYY-MM-dd', 'lte' => 'YYYY-MM-dd' ); date formats: 'YYYY-MM-dd' or 'YYYY-MM-dd HH:MM:SS'. phpcs:ignore Squiz.PHP.CommentedOutCode.Found.
'orderby' => null, // Defaults to 'relevance' if query is set, otherwise 'date'. Pass an array for multiple orders.
'order' => 'DESC',
'posts_per_page' => 10,
'offset' => null,
'paged' => null,
/**
* Aggregations. Examples:
* array(
* 'Tag' => array( 'type' => 'taxonomy', 'taxonomy' => 'post_tag', 'count' => 10 ) ),
* 'Post Type' => array( 'type' => 'post_type', 'count' => 10 ) ),
* );
*/
'aggregations' => null,
);
$args = wp_parse_args( $args, $defaults );
$parser = new Jetpack_WPES_Search_Query_Parser(
$args['query'],
/**
* Filter the languages used by Jetpack Search's Query Parser.
*
* @module search
*
* @since 7.9.0
*
* @param array $languages The array of languages. Default is value of get_locale().
*/
apply_filters( 'jetpack_search_query_languages', array( get_locale() ) )
);
if ( empty( $args['query_fields'] ) ) {
if ( $this->has_vip_index() ) {
// VIP indices do not have per language fields.
$match_fields = $this->_get_caret_boosted_fields(
array(
'title' => 0.1,
'content' => 0.1,
'excerpt' => 0.1,
'tag.name' => 0.1,
'category.name' => 0.1,
'author_login' => 0.1,
'author' => 0.1,
)
);
$boost_fields = $this->_get_caret_boosted_fields(
$this->_apply_boosts_multiplier(
array(
'title' => 2,
'tag.name' => 1,
'category.name' => 1,
'author_login' => 1,
'author' => 1,
),
$args['excess_boost']
)
);
$boost_phrase_fields = $this->_get_caret_boosted_fields(
array(
'title' => 1,
'content' => 1,
'excerpt' => 1,
'tag.name' => 1,
'category.name' => 1,
'author' => 1,
)
);
} else {
$match_fields = $parser->merge_ml_fields(
array(
'title' => 0.1,
'content' => 0.1,
'excerpt' => 0.1,
'tag.name' => 0.1,
'category.name' => 0.1,
),
$this->_get_caret_boosted_fields(
array(
'author_login' => 0.1,
'author' => 0.1,
)
)
);
$boost_fields = $parser->merge_ml_fields(
$this->_apply_boosts_multiplier(
array(
'title' => 2,
'tag.name' => 1,
'category.name' => 1,
),
$args['excess_boost']
),
$this->_get_caret_boosted_fields(
$this->_apply_boosts_multiplier(
array(
'author_login' => 1,
'author' => 1,
),
$args['excess_boost']
)
)
);