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
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
1644
1645
1646
1647
1648
1649
1650
1651
1652
1653
1654
1655
1656
1657
1658
1659
1660
1661
1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
1672
1673
1674
1675
1676
1677
1678
1679
1680
1681
1682
1683
1684
1685
1686
1687
1688
1689
1690
1691
1692
1693
1694
1695
1696
1697
1698
1699
1700
1701
1702
1703
1704
1705
1706
1707
1708
1709
1710
1711
1712
1713
1714
1715
1716
1717
1718
1719
1720
1721
1722
1723
1724
1725
1726
1727
1728
1729
1730
1731
1732
1733
1734
1735
1736
1737
1738
1739
1740
1741
1742
1743
1744
1745
1746
1747
1748
1749
1750
1751
1752
1753
1754
1755
1756
1757
1758
1759
1760
1761
1762
1763
1764
1765
1766
1767
1768
1769
1770
1771
1772
1773
1774
1775
1776
1777
1778
1779
1780
1781
1782
1783
1784
1785
1786
1787
1788
1789
1790
1791
1792
1793
1794
1795
1796
1797
1798
1799
1800
1801
1802
1803
1804
1805
1806
1807
1808
1809
1810
1811
1812
1813
1814
1815
1816
1817
1818
1819
1820
1821
1822
1823
1824
1825
1826
1827
1828
1829
1830
1831
1832
1833
1834
1835
1836
1837
1838
1839
1840
1841
1842
1843
1844
1845
1846
1847
1848
1849
1850
1851
1852
1853
1854
1855
1856
1857
1858
1859
1860
1861
1862
1863
1864
1865
1866
1867
1868
1869
1870
1871
1872
1873
1874
1875
1876
1877
1878
1879
1880
1881
1882
1883
1884
1885
1886
1887
1888
1889
1890
1891
1892
1893
1894
1895
|
<?php
/**
* Classic Search: Our original search experience with filtering capability.
*
* @package @automattic/jetpack-search
*/
namespace Automattic\Jetpack\Search;
use Automattic\Jetpack\Connection\Client;
use WP_Error;
use WP_Query;
use WP_Tax_Query;
/**
* Class responsible for enabling the Classic Search experience on the site.
*/
class Classic_Search {
/**
* The singleton instance of this class.
*
* @since 5.0.0
* @var Classic_Search
*/
private static $instance;
/**
* 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();
/**
* 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' );
/**
* The constructor is not used for this singleton class.
*/
protected function __construct() {
}
/**
* Returns a class singleton. Initializes with first-time setup if given a blog ID parameter.
*
* @param string $blog_id Blog id.
* @return static The class singleton.
*/
public static function instance( $blog_id = null ) {
if ( ! isset( self::$instance ) ) {
if ( null === $blog_id ) {
$blog_id = Helper::get_wpcom_site_id();
}
self::$instance = new static();
self::$instance->setup( $blog_id );
}
return self::$instance;
}
/**
* Alias of the instance function.
*/
public static function initialize() {
return call_user_func_array( array( static::class, 'instance' ), func_get_args() );
}
/**
* Performs setup tasks for the singleton. To be used exclusively after singleton instantitaion.
*
* @param string $blog_id Blog id.
*/
public function setup( $blog_id ) {
if ( ! $blog_id ) {
return;
}
$this->jetpack_blog_id = $blog_id;
$this->init_hooks();
}
/**
* Prevent __clone()'ing of this class.
*
* @since 5.0.0
*/
public function __clone() {
wp_die( "Please don't __clone Classic_Search" );
}
/**
* Prevent __wakeup()'ing of this class.
*
* @since 5.0.0
*/
public function __wakeup() {
wp_die( "Please don't __wakeup Classic_Search" );
}
/**
* 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' ) );
}
/**
* 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 Helper::are_filters_by_widget_disabled() directly.
*
* @return bool
*/
public function are_filters_by_widget_disabled() {
return Helper::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 Classic_Search object.
*
* @since 5.7.0
*/
public function set_filters_from_widgets() {
if ( Helper::are_filters_by_widget_disabled() ) {
return;
}
$filters = Helper::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'] ) ) ? sanitize_key( $_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 ) ) {
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.
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 = Helper::get_max_offset();
$max_posts_per_page = Helper::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 Helper::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 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() {
// NOTE: This module only exists on WPCOM.
// TODO: Migrate this function to WPCOM!
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 ) {
$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 WPES\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']
)
)
);
$boost_phrase_fields = $parser->merge_ml_fields(
array(
'title' => 1,
'content' => 1,
'excerpt' => 1,
'tag.name' => 1,
'category.name' => 1,
),
$this->_get_caret_boosted_fields(
array(
'author' => 1,
)
)
);
}
} else {
// If code is overriding the fields, then use that. Important for backwards compatibility.
$match_fields = $args['query_fields'];
$boost_phrase_fields = $match_fields;
$boost_fields = null;
}
$parser->phrase_filter(
array(
'must_query_fields' => $match_fields,
'boost_query_fields' => null,
)
);
$parser->remaining_query(
array(
'must_query_fields' => $match_fields,
'boost_query_fields' => $boost_fields,
)
);
// Boost on phrase matches.
$parser->remaining_query(
array(
'boost_query_fields' => $boost_phrase_fields,
'boost_query_type' => 'phrase',
)
);
/**
* Modify the recency decay parameters for the search query.
*
* The recency decay lowers the search scores based on the age of a post relative to an origin date. Basic adjustments:
* - origin: A date. Posts with this date will have the highest score and no decay applied. Default is today.
* - offset: Number of days/months/years (eg 30d). All posts within this time range of the origin (before and after) will have no decay applied. Default is no offset.
* - scale: The number of days/months/years from the origin+offset at which the decay will equal the decay param. Default 360d
* - decay: The amount of decay applied at offset+scale. Default 0.9.
*
* The curve applied is a Gaussian. More details available at {@see https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-function-score-query.html#function-decay}
*
* @module search
*
* @since 5.8.0
*
* @param array $decay_params The decay parameters.
* @param array $args The WP query parameters.
*/
$decay_params = apply_filters(
'jetpack_search_recency_score_decay',
array(
'origin' => gmdate( 'Y-m-d' ),
'scale' => '360d',
'decay' => 0.9,
),
$args
);
if ( ! empty( $decay_params ) ) {
// Newer content gets weighted slightly higher.
$parser->add_decay(
'gauss',
array(
'date_gmt' => $decay_params,
)
);
}
$es_query_args = array(
'blog_id' => absint( $args['blog_id'] ),
'size' => absint( $args['posts_per_page'] ),
);
// ES "from" arg (offset).
if ( $args['offset'] ) {
$es_query_args['from'] = absint( $args['offset'] );
} elseif ( $args['paged'] ) {
$es_query_args['from'] = max( 0, ( absint( $args['paged'] ) - 1 ) * $es_query_args['size'] );
}
$es_query_args['from'] = min( $es_query_args['from'], Helper::get_max_offset() );
if ( ! is_array( $args['author_name'] ) ) {
$args['author_name'] = array( $args['author_name'] );
}
// ES stores usernames, not IDs, so transform.
if ( ! empty( $args['author'] ) ) {
if ( ! is_array( $args['author'] ) ) {
$args['author'] = array( $args['author'] );
}
foreach ( $args['author'] as $author ) {
$user = get_user_by( 'id', $author );
if ( $user && ! empty( $user->user_login ) ) {
$args['author_name'][] = $user->user_login;
}
}
}
/*
* Build the filters from the query elements.
* Filters rock because they are cached from one query to the next
* but they are cached as individual filters, rather than all combined together.
* May get performance boost by also caching the top level boolean filter too.
*/
if ( $args['post_type'] ) {
if ( ! is_array( $args['post_type'] ) ) {
$args['post_type'] = array( $args['post_type'] );
}
$parser->add_filter(
array(
'terms' => array(
'post_type' => $args['post_type'],
),
)
);
}
if ( $args['author_name'] ) {
$parser->add_filter(
array(
'terms' => array(
'author_login' => $args['author_name'],
),
)
);
}
if ( ! empty( $args['date_range'] ) && isset( $args['date_range']['field'] ) ) {
$field = $args['date_range']['field'];
unset( $args['date_range']['field'] );
$parser->add_filter(
array(
'range' => array(
$field => $args['date_range'],
),
)
);
}
if ( is_array( $args['terms'] ) ) {
foreach ( $args['terms'] as $tax => $terms ) {
$terms = (array) $terms;
if ( count( $terms ) && mb_strlen( $tax ) ) {
switch ( $tax ) {
case 'post_tag':
$tax_fld = 'tag.slug';
break;
case 'category':
$tax_fld = 'category.slug';
break;
default:
$tax_fld = 'taxonomy.' . $tax . '.slug';
break;
}
foreach ( $terms as $term ) {
$parser->add_filter(
array(
'term' => array(
$tax_fld => $term,
),
)
);
}
}
}
}
if ( ! $args['orderby'] ) {
if ( $args['query'] ) {
$args['orderby'] = array( 'relevance' );
} else {
$args['orderby'] = array( 'date' );
}
}
// Validate the "order" field.
switch ( strtolower( $args['order'] ) ) {
case 'asc':
$args['order'] = 'asc';
break;
case 'desc':
default:
$args['order'] = 'desc';
break;
}
$es_query_args['sort'] = array();
foreach ( (array) $args['orderby'] as $orderby ) {
// Translate orderby from WP field to ES field.
switch ( $orderby ) {
case 'relevance':
// never order by score ascending.
$es_query_args['sort'][] = array(
'_score' => array(
'order' => 'desc',
),
);
break;
case 'date':
$es_query_args['sort'][] = array(
'date' => array(
'order' => $args['order'],
),
);
break;
case 'ID':
$es_query_args['sort'][] = array(
'id' => array(
'order' => $args['order'],
),
);
break;
case 'author':
$es_query_args['sort'][] = array(
'author.raw' => array(
'order' => $args['order'],
),
);
break;
} // End switch.
} // End foreach.
if ( empty( $es_query_args['sort'] ) ) {
unset( $es_query_args['sort'] );
}
// Aggregations.
if ( ! empty( $args['aggregations'] ) ) {
$this->add_aggregations_to_es_query_builder( $args['aggregations'], $parser );
}
$es_query_args['filter'] = $parser->build_filter();
$es_query_args['query'] = $parser->build_query();
$es_query_args['aggregations'] = $parser->build_aggregation();
return $es_query_args;
}
/**
* Given an array of aggregations, parse and add them onto the query builder object for use in Elasticsearch.
*
* @since 5.0.0
*
* @param array $aggregations Array of aggregations (filters) to add to the query builder.
* @param Automattic\Jetpack\Search\WPES\Query_Builder $builder The builder instance that is creating the Elasticsearch query.
*/
public function add_aggregations_to_es_query_builder( array $aggregations, $builder ) {
foreach ( $aggregations as $label => $aggregation ) {
if ( ! isset( $aggregation['type'] ) ) {
continue;
}
switch ( $aggregation['type'] ) {
case 'taxonomy':
$this->add_taxonomy_aggregation_to_es_query_builder( $aggregation, $label, $builder );
break;
case 'post_type':
$this->add_post_type_aggregation_to_es_query_builder( $aggregation, $label, $builder );
break;
case 'date_histogram':
$this->add_date_histogram_aggregation_to_es_query_builder( $aggregation, $label, $builder );
break;
}
}
}
/**
* Given an individual taxonomy aggregation, add it to the query builder object for use in Elasticsearch.
*
* @since 5.0.0
*
* @param array $aggregation The aggregation to add to the query builder.
* @param string $label The 'label' (unique id) for this aggregation.
* @param Automattic\Jetpack\Search\WPES\Query_Builder $builder The builder instance that is creating the Elasticsearch query.
*/
public function add_taxonomy_aggregation_to_es_query_builder( array $aggregation, $label, $builder ) {
$field = null;
switch ( $aggregation['taxonomy'] ) {
case 'post_tag':
$field = 'tag';
break;
case 'category':
$field = 'category';
break;
default:
$field = 'taxonomy.' . $aggregation['taxonomy'];
break;
}
$builder->add_aggs(
$label,
array(
'terms' => array(
'field' => $field . '.slug',
'size' => min( (int) $aggregation['count'], $this->max_aggregations_count ),
),
)
);
}
/**
* Given an individual post_type aggregation, add it to the query builder object for use in Elasticsearch.
*
* @since 5.0.0
*
* @param array $aggregation The aggregation to add to the query builder.
* @param string $label The 'label' (unique id) for this aggregation.
* @param Automattic\Jetpack\Search\WPES\Query_Builder $builder The builder instance that is creating the Elasticsearch query.
*/
public function add_post_type_aggregation_to_es_query_builder( array $aggregation, $label, $builder ) {
$builder->add_aggs(
$label,
array(
'terms' => array(
'field' => 'post_type',
'size' => min( (int) $aggregation['count'], $this->max_aggregations_count ),
),
)
);
}
/**
* Given an individual date_histogram aggregation, add it to the query builder object for use in Elasticsearch.
*
* @since 5.0.0
*
* @param array $aggregation The aggregation to add to the query builder.
* @param string $label The 'label' (unique id) for this aggregation.
* @param Automattic\Jetpack\Search\WPES\Query_Builder $builder The builder instance that is creating the Elasticsearch query.
*/
public function add_date_histogram_aggregation_to_es_query_builder( array $aggregation, $label, $builder ) {
$args = array(
'interval' => $aggregation['interval'],
'field' => ( ! empty( $aggregation['field'] ) && 'post_date_gmt' === $aggregation['field'] ) ? 'date_gmt' : 'date',
);
if ( isset( $aggregation['min_doc_count'] ) ) {
$args['min_doc_count'] = (int) $aggregation['min_doc_count'];
} else {
$args['min_doc_count'] = 1;
}
$builder->add_aggs(
$label,
array(
'date_histogram' => $args,
)
);
}
/**
* And an existing filter object with a list of additional filters.
*
* Attempts to optimize the filters somewhat.
*
* @since 5.0.0
*
* @param array $curr_filter The existing filters to build upon.
* @param array $filters The new filters to add.
*
* @return array The resulting merged filters.
*/
public static function and_es_filters( array $curr_filter, array $filters ) {
if ( ! is_array( $curr_filter ) || isset( $curr_filter['match_all'] ) ) {
if ( 1 === count( $filters ) ) {
return $filters[0];
}
return array(
'and' => $filters,
);
}
return array(
'and' => array_merge( array( $curr_filter ), $filters ),
);
}
/**
* Set the available filters for the search.
*
* These get rendered via the Jetpack_Search_Widget() widget.
*
* Behind the scenes, these are implemented using Elasticsearch Aggregations.
*
* If you do not require counts of how many documents match each filter, please consider using regular WP Query
* arguments instead, such as via the jetpack_search_es_wp_query_args filter
*
* @see https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations.html
*
* @since 5.0.0
*
* @param array $aggregations Array of filters (aggregations) to apply to the search.
*/
public function set_filters( array $aggregations ) {
foreach ( (array) $aggregations as $key => $agg ) {
if ( empty( $agg['name'] ) ) {
$aggregations[ $key ]['name'] = $key;
}
}
$this->aggregations = $aggregations;
}
/**
* Get the raw Aggregation results from the Elasticsearch response.
*
* @since 5.0.0
*
* @see https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations.html
*
* @return array Array of Aggregations performed on the search.
*/
public function get_search_aggregations_results() {
$aggregations = array();
$search_result = $this->get_search_result();
if ( ! empty( $search_result ) && ! empty( $search_result['aggregations'] ) ) {
$aggregations = $search_result['aggregations'];
}
return $aggregations;
}
/**
* Get the results of the Filters performed, including the number of matching documents.
*
* Returns an array of Filters (keyed by $label, as passed to Classic_Search::set_filters()), containing the Filter and all resulting
* matching buckets, the url for applying/removing each bucket, etc.
*
* NOTE - if this is called before the search is performed, an empty array will be returned. Use the $aggregations class
* member if you need to access the raw filters set in Classic_Search::set_filters().
*
* @since 5.0.0
*
* @param WP_Query $query The optional original WP_Query to use for determining which filters are active. Defaults to the main query.
*
* @return array Array of filters applied and info about them.
*/
public function get_filters( WP_Query $query = null ) {
if ( ! $query instanceof WP_Query ) {
global $wp_query;
$query = $wp_query;
}
$aggregation_data = $this->aggregations;
if ( empty( $aggregation_data ) ) {
return $aggregation_data;
}
$aggregation_results = $this->get_search_aggregations_results();
if ( ! $aggregation_results ) {
return $aggregation_data;
}
// NOTE - Looping over the _results_, not the original configured aggregations, so we get the 'real' data from ES.
foreach ( $aggregation_results as $label => $aggregation ) {
if ( empty( $aggregation ) ) {
continue;
}
$type = $this->aggregations[ $label ]['type'];
$aggregation_data[ $label ]['buckets'] = array();
$existing_term_slugs = array();
$tax_query_var = null;
// Figure out which terms are active in the query, for this taxonomy.
if ( 'taxonomy' === $this->aggregations[ $label ]['type'] ) {
$tax_query_var = $this->get_taxonomy_query_var( $this->aggregations[ $label ]['taxonomy'] );
if ( ! empty( $query->tax_query ) && ! empty( $query->tax_query->queries ) && is_array( $query->tax_query->queries ) ) {
foreach ( $query->tax_query->queries as $tax_query ) {
if ( is_array( $tax_query ) && $this->aggregations[ $label ]['taxonomy'] === $tax_query['taxonomy'] &&
'slug' === $tax_query['field'] &&
is_array( $tax_query['terms'] ) ) {
$existing_term_slugs = array_merge( $existing_term_slugs, $tax_query['terms'] );
}
}
}
}
// Now take the resulting found aggregation items and generate the additional info about them, such as activation/deactivation url, name, count, etc.
$buckets = array();
if ( ! empty( $aggregation['buckets'] ) ) {
$buckets = (array) $aggregation['buckets'];
}
if ( 'date_histogram' === $type ) {
// re-order newest to oldest.
$buckets = array_reverse( $buckets );
}
// Some aggregation types like date_histogram don't support the max results parameter.
if ( is_int( $this->aggregations[ $label ]['count'] ) && count( $buckets ) > $this->aggregations[ $label ]['count'] ) {
$buckets = array_slice( $buckets, 0, $this->aggregations[ $label ]['count'] );
}
foreach ( $buckets as $item ) {
$query_vars = array();
$active = false;
$remove_url = null;
$name = '';
// What type was the original aggregation?
switch ( $type ) {
case 'taxonomy':
$taxonomy = $this->aggregations[ $label ]['taxonomy'];
$term = get_term_by( 'slug', $item['key'], $taxonomy );
if ( ! $term || ! $tax_query_var ) {
continue 2; // switch() is considered a looping structure.
}
$query_vars = array(
$tax_query_var => implode( '+', array_merge( $existing_term_slugs, array( $term->slug ) ) ),
);
$name = $term->name;
// Let's determine if this term is active or not.
if ( in_array( $item['key'], $existing_term_slugs, true ) ) {
$active = true;
$slug_count = count( $existing_term_slugs );
if ( $slug_count > 1 ) {
$remove_url = Helper::add_query_arg(
$tax_query_var,
rawurlencode( implode( '+', array_diff( $existing_term_slugs, array( $item['key'] ) ) ) )
);
} else {
$remove_url = Helper::remove_query_arg( $tax_query_var );
}
}
break;
case 'post_type':
$post_type = get_post_type_object( $item['key'] );
if ( ! $post_type || $post_type->exclude_from_search ) {
continue 2; // switch() is considered a looping structure.
}
$query_vars = array(
'post_type' => $item['key'],
);
$name = $post_type->labels->singular_name;
// Is this post type active on this search?
$post_types = $query->get( 'post_type' );
if ( ! is_array( $post_types ) ) {
$post_types = array( $post_types );
}
if ( in_array( $item['key'], $post_types, true ) ) {
$active = true;
$post_type_count = count( $post_types );
// For the right 'remove filter' url, we need to remove the post type from the array, or remove the param entirely if it's the only one.
if ( $post_type_count > 1 ) {
$remove_url = Helper::add_query_arg(
'post_type',
rawurlencode( implode( ',', array_diff( $post_types, array( $item['key'] ) ) ) )
);
} else {
$remove_url = Helper::remove_query_arg( 'post_type' );
}
}
break;
case 'date_histogram':
$timestamp = $item['key'] / 1000;
$current_year = $query->get( 'year' );
$current_month = $query->get( 'monthnum' );
$current_day = $query->get( 'day' );
switch ( $this->aggregations[ $label ]['interval'] ) {
case 'year':
$year = (int) gmdate( 'Y', $timestamp );
$query_vars = array(
'year' => $year,
'monthnum' => false,
'day' => false,
);
$name = $year;
// Is this year currently selected?
if ( ! empty( $current_year ) && (int) $current_year === $year ) {
$active = true;
$remove_url = Helper::remove_query_arg( array( 'year', 'monthnum', 'day' ) );
}
break;
case 'month':
$year = (int) gmdate( 'Y', $timestamp );
$month = (int) gmdate( 'n', $timestamp );
$query_vars = array(
'year' => $year,
'monthnum' => $month,
'day' => false,
);
$name = gmdate( 'F Y', $timestamp );
// Is this month currently selected?
if ( ! empty( $current_year ) && (int) $current_year === $year &&
! empty( $current_month ) && (int) $current_month === $month ) {
$active = true;
$remove_url = Helper::remove_query_arg( array( 'year', 'monthnum' ) );
}
break;
case 'day':
$year = (int) gmdate( 'Y', $timestamp );
$month = (int) gmdate( 'n', $timestamp );
$day = (int) gmdate( 'j', $timestamp );
$query_vars = array(
'year' => $year,
'monthnum' => $month,
'day' => $day,
);
$name = gmdate( 'F jS, Y', $timestamp );
// Is this day currently selected?
if ( ! empty( $current_year ) && (int) $current_year === $year &&
! empty( $current_month ) && (int) $current_month === $month &&
! empty( $current_day ) && (int) $current_day === $day ) {
$active = true;
$remove_url = Helper::remove_query_arg( array( 'day' ) );
}
break;
default:
continue 3; // switch() is considered a looping structure.
} // End switch.
break;
default:
// continue 2; // switch() is considered a looping structure.
} // End switch.
// Need to urlencode param values since add_query_arg doesn't.
$url_params = urlencode_deep( $query_vars );
$aggregation_data[ $label ]['buckets'][] = array(
'url' => Helper::add_query_arg( $url_params ),
'query_vars' => $query_vars,
'name' => $name,
'count' => $item['doc_count'],
'active' => $active,
'remove_url' => $remove_url,
'type' => $type,
'type_label' => $aggregation_data[ $label ]['name'],
'widget_id' => ! empty( $aggregation_data[ $label ]['widget_id'] ) ? $aggregation_data[ $label ]['widget_id'] : 0,
);
} // End foreach.
} // End foreach.
/**
* Modify the aggregation filters returned by get_filters().
*
* Useful if you are setting custom filters outside of the supported filters (taxonomy, post_type etc.) and
* want to hook them up so they're returned when you call `get_filters()`.
*
* @module search
*
* @since 6.9.0
*
* @param array $aggregation_data The array of filters keyed on label.
* @param WP_Query $query The WP_Query object.
*/
return apply_filters( 'jetpack_search_get_filters', $aggregation_data, $query );
}
/**
* Get the filters that are currently applied to this search.
*
* @since 5.0.0
*
* @return array Array of filters that were applied.
*/
public function get_active_filter_buckets() {
$active_buckets = array();
$filters = $this->get_filters();
if ( ! is_array( $filters ) ) {
return $active_buckets;
}
foreach ( $filters as $filter ) {
if ( isset( $filter['buckets'] ) && is_array( $filter['buckets'] ) ) {
foreach ( $filter['buckets'] as $item ) {
if ( isset( $item['active'] ) && $item['active'] ) {
$active_buckets[] = $item;
}
}
}
}
return $active_buckets;
}
/**
* Calculate the right query var to use for a given taxonomy.
*
* Allows custom code to modify the GET var that is used to represent a given taxonomy, via the jetpack_search_taxonomy_query_var filter.
*
* @since 5.0.0
*
* @param string $taxonomy_name The name of the taxonomy for which to get the query var.
*
* @return bool|string The query var to use for this taxonomy, or false if none found.
*/
public function get_taxonomy_query_var( $taxonomy_name ) {
$taxonomy = get_taxonomy( $taxonomy_name );
if ( ! $taxonomy || is_wp_error( $taxonomy ) ) {
return false;
}
/**
* Modify the query var to use for a given taxonomy
*
* @module search
*
* @since 5.0.0
*
* @param string $query_var The current query_var for the taxonomy
* @param string $taxonomy_name The taxonomy name
*/
return apply_filters( 'jetpack_search_taxonomy_query_var', $taxonomy->query_var, $taxonomy_name );
}
/**
* Takes an array of aggregation results, and ensures the array key ordering matches the key order in $desired
* which is the input order.
*
* Necessary because ES does not always return aggregations in the same order that you pass them in,
* and it should be possible to control the display order easily.
*
* @since 5.0.0
*
* @param array $aggregations Aggregation results to be reordered.
* @param array $desired Array with keys representing the desired ordering.
*
* @return array A new array with reordered keys, matching those in $desired.
*/
public function fix_aggregation_ordering( array $aggregations, array $desired ) {
if ( empty( $aggregations ) || empty( $desired ) ) {
return $aggregations;
}
$reordered = array();
foreach ( array_keys( $desired ) as $agg_name ) {
if ( isset( $aggregations[ $agg_name ] ) ) {
$reordered[ $agg_name ] = $aggregations[ $agg_name ];
}
}
return $reordered;
}
/**
* Sends events to Tracks when a search filters widget is updated.
*
* @since 5.8.0
*
* @param string $option The option name. Only "widget_jetpack-search-filters" is cared about.
* @param array $old_value The old option value.
* @param array $new_value The new option value.
*/
public function track_widget_updates( $option, $old_value, $new_value ) {
if ( 'widget_jetpack-search-filters' !== $option ) {
return;
}
$event = Helper::get_widget_tracks_value( $old_value, $new_value );
if ( ! $event ) {
return;
}
$tracking = new \Automattic\Jetpack\Tracking();
$tracking->tracks_record_event(
wp_get_current_user(),
sprintf( 'jetpack_search_widget_%s', $event['action'] ),
$event['widget']
);
}
/**
* Moves any active search widgets to the inactive category.
*
* @since 5.9.0
*/
public function move_search_widgets_to_inactive() {
if ( ! is_active_widget( false, false, Helper::FILTER_WIDGET_BASE, true ) ) {
return;
}
$sidebars_widgets = wp_get_sidebars_widgets();
if ( ! is_array( $sidebars_widgets ) ) {
return;
}
$changed = false;
foreach ( $sidebars_widgets as $sidebar => $widgets ) {
if ( 'wp_inactive_widgets' === $sidebar || 'orphaned_widgets' === substr( $sidebar, 0, 16 ) ) {
continue;
}
if ( is_array( $widgets ) ) {
foreach ( $widgets as $key => $widget ) {
if ( _get_widget_id_base( $widget ) === Helper::FILTER_WIDGET_BASE ) {
$changed = true;
array_unshift( $sidebars_widgets['wp_inactive_widgets'], $widget );
unset( $sidebars_widgets[ $sidebar ][ $key ] );
}
}
}
}
if ( $changed ) {
wp_set_sidebars_widgets( $sidebars_widgets );
}
}
/**
* Determine whether a given WP_Query should be handled by ElasticSearch.
*
* @param WP_Query $query The WP_Query object.
*
* @return bool
*/
public function should_handle_query( $query ) {
/**
* Determine whether a given WP_Query should be handled by ElasticSearch.
*
* @module search
*
* @since 5.6.0
*
* @param bool $should_handle Should be handled by Jetpack Search.
* @param WP_Query $query The WP_Query object.
*/
return apply_filters( 'jetpack_search_should_handle_query', $query->is_main_query() && $query->is_search(), $query );
}
/**
* Transforms an array with fields name as keys and boosts as value into
* shorthand "caret" format.
*
* @param array $fields_boost [ "title" => "2", "content" => "1" ].
*
* @return array [ "title^2", "content^1" ]
*/
private function _get_caret_boosted_fields( array $fields_boost ) { // phpcs:ignore PSR2.Methods.MethodDeclaration.Underscore
$caret_boosted_fields = array();
foreach ( $fields_boost as $field => $boost ) {
$caret_boosted_fields[] = "$field^$boost";
}
return $caret_boosted_fields;
}
/**
* Apply a multiplier to boost values.
*
* @param array $fields_boost [ "title" => 2, "content" => 1 ].
* @param array $fields_boost_multiplier [ "title" => 0.1234 ].
*
* @return array [ "title" => "0.247", "content" => "1.000" ]
*/
private function _apply_boosts_multiplier( array $fields_boost, array $fields_boost_multiplier ) { // phpcs:ignore PSR2.Methods.MethodDeclaration.Underscore
foreach ( $fields_boost as $field_name => $field_boost ) {
if ( isset( $fields_boost_multiplier[ $field_name ] ) ) {
$fields_boost[ $field_name ] *= $fields_boost_multiplier[ $field_name ];
}
// Set a floor and format the number as string.
$fields_boost[ $field_name ] = number_format(
max( 0.001, $fields_boost[ $field_name ] ),
3,
'.',
''
);
}
return $fields_boost;
}
}
|