PluginProbe
ElasticPress / 5.3.5
ElasticPress v5.3.5
5.3.5 5.3.4 3.6.5 3.6.6 4.0.0 4.0.1 4.1.0 4.2.0 4.2.1 4.2.2 4.3.0 4.3.1 4.4.0 4.4.1 4.5.0 4.5.1 4.5.2 4.6.0 4.6.1 4.7.0 4.7.1 4.7.2 5.0.0 5.0.1 5.0.2 All 108 releases
← All changes | includes/classes/Elasticsearch.php +164 -77 4.5.25.3.5 View file →
@@ -7,11 +7,11 @@
7 7 */
8 8
9 9 namespace ElasticPress;
10 10
11 -use ElasticPress\Utils as Utils;
11 +use WP_Error;
12 12 use ElasticPress\Indexables;
13 -use \WP_Error as WP_Error;
13 +use ElasticPress\Utils;
14 14
15 15 if ( ! defined( 'ABSPATH' ) ) {
16 16 exit; // Exit if accessed directly.
17 17 }
@@ -77,9 +77,9 @@
77 77 * @param string $type Index type. Previously this was used for index type. Now it's just passed to hooks for legacy reasons.
78 78 * @param array $document Formatted Elasticsearch document.
79 79 * @param boolean $blocking Blocking HTTP request or not.
80 80 * @since 3.0
81 - * @return boolean|array
81 + * @return boolean|object
82 82 */
83 83 public function index_document( $index, $type, $document, $blocking = true ) {
84 84 /**
85 85 * Filter Elasticsearch index document request path
@@ -91,9 +91,9 @@
91 91 * @param {string} $type Type of document
92 92 * @return {string} New path
93 93 * @since 3.0
94 94 */
95 - if ( version_compare( $this->get_elasticsearch_version(), '7.0', '<' ) ) {
95 + if ( version_compare( (string) $this->get_elasticsearch_version(), '7.0', '<' ) ) {
96 96 $path = apply_filters( 'ep_index_' . $type . '_request_path', $index . '/' . $type . '/' . $document['ID'], $document, $type );
97 97 } else {
98 98 $path = apply_filters( 'ep_index_' . $type . '_request_path', $index . '/_doc/' . $document['ID'], $document, $type );
99 99 }
@@ -283,9 +283,9 @@
283 283 * @since 3.0
284 284 * @return bool|array
285 285 */
286 286 public function query( $index, $type, $query, $query_args, $query_object = null ) {
287 - if ( version_compare( $this->get_elasticsearch_version(), '7.0', '<' ) ) {
287 + if ( version_compare( (string) $this->get_elasticsearch_version(), '7.0', '<' ) ) {
288 288 $path = $index . '/' . $type . '/_search';
289 289 } else {
290 290 $path = $index . '/_search';
291 291 }
@@ -403,8 +403,16 @@
403 403 * @param {string} $scope Backwards compat for scope parameter.
404 404 * @param {array} $query_args Current WP Query arguments
405 405 */
406 406 do_action( 'ep_retrieve_aggregations', $response['aggregations'], $query, '', $query_args );
407 +
408 + if ( is_object( $query_object ) ) {
409 + if ( method_exists( $query_object, 'set' ) ) {
410 + $query_object->set( 'ep_aggregations', $response['aggregations'] );
411 + } else {
412 + $query_object->query_vars['ep_aggregations'] = $response['aggregations'];
413 + }
414 + }
407 415 }
408 416
409 417 /**
410 418 * Fires after valid Elasticsearch query
@@ -455,13 +463,17 @@
455 463 * Filter Elasticsearch query results
456 464 *
457 465 * @hook ep_es_query_results
458 466 * @param {array} $results Results from Elasticsearch
459 - * @param {response} $response Raw response from Elasticsearch
460 - * @param {array} $query Raw Elasticsearch query
461 - * @param {array} $query_args Query arguments
462 - * @param {mixed} $query_object Could be WP_Query, WP_User_Query, etc.
463 - * @return {array} New results
467 + * @param {int} $results.found_documents Total number of documents.
468 + * @param {array} $results.documents Array of documents.
469 + * @param {array} $results.aggregations Array of aggregations.
470 + * @param {array} $results.suggest Array of suggestions.
471 + * @param {response} $response Raw response from Elasticsearch
472 + * @param {array} $query Raw Elasticsearch query
473 + * @param {array} $query_args Query arguments
474 + * @param {mixed} $query_object Could be WP_Query, WP_User_Query, etc.
475 + * @return {array} New results
464 476 */
465 477 return apply_filters(
466 478 'ep_es_query_results',
467 479 [
@@ -467,8 +479,9 @@
467 479 [
468 480 'found_documents' => $total_hits,
469 481 'documents' => $documents,
470 482 'aggregations' => $response['aggregations'] ?? [],
483 + 'suggest' => $response['suggest'] ?? [],
471 484 ],
472 485 $response,
473 486 $query,
474 487 $query_args,
@@ -570,9 +583,9 @@
570 583 * @since 3.0
571 584 * @return boolean
572 585 */
573 586 public function delete_document( $index, $type, $document_id, $blocking = true ) {
574 - if ( version_compare( $this->get_elasticsearch_version(), '7.0', '<' ) ) {
587 + if ( version_compare( (string) $this->get_elasticsearch_version(), '7.0', '<' ) ) {
575 588 $path = $index . '/' . $type . '/' . $document_id;
576 589 } else {
577 590 $path = $index . '/_doc/' . $document_id;
578 591 }
@@ -653,9 +666,9 @@
653 666 * @since 3.0
654 667 * @return boolean|array
655 668 */
656 669 public function get_document( $index, $type, $document_id ) {
657 - if ( version_compare( $this->get_elasticsearch_version(), '7.0', '<' ) ) {
670 + if ( version_compare( (string) $this->get_elasticsearch_version(), '7.0', '<' ) ) {
658 671 $path = $index . '/' . $type . '/' . $document_id;
659 672 } else {
660 673 $path = $index . '/_doc/' . $document_id;
661 674 }
@@ -711,9 +724,9 @@
711 724 * @since 3.6.0
712 725 * @return boolean|array
713 726 */
714 727 public function get_documents( $index, $type, $document_ids ) {
715 - if ( version_compare( $this->get_elasticsearch_version(), '7.0', '<' ) ) {
728 + if ( version_compare( (string) $this->get_elasticsearch_version(), '7.0', '<' ) ) {
716 729 $path = apply_filters( 'ep_index_' . $type . '_request_path', $index . '/' . $type . '/_mget', $document_ids, $type );
717 730 } else {
718 731 $path = apply_filters( 'ep_index_' . $type . '_request_path', $index . '/_mget', $document_ids, $type );
719 732 }
@@ -849,8 +862,18 @@
849 862 $request = apply_filters( 'ep_config_mapping_request', $request, $index, $mapping );
850 863
851 864 $response_code = wp_remote_retrieve_response_code( $request );
852 865
866 + /**
867 + * Fires after sending a put mapping request
868 + *
869 + * @hook ep_after_put_mapping
870 + * @since 4.7.0
871 + * @param {string} $index Index name
872 + * @param {WP_Error|array} $request The response or WP_Error on failure.
873 + */
874 + do_action( 'ep_after_put_mapping', $index, $request );
875 +
853 876 // If WP_Error or not 200, return false or error message depends on attribute.
854 877 if ( is_wp_error( $request ) || 200 !== $response_code ) {
855 878 if ( 'bool' === $return_type ) {
856 879 return false;
@@ -861,9 +884,16 @@
861 884 }
862 885
863 886 $response_body = wp_remote_retrieve_body( $request );
864 887 $parsed_response = json_decode( $response_body, true );
865 - return new \WP_Error( $parsed_response['status'], $parsed_response['error'] );
888 + if ( is_array( $parsed_response ) ) {
889 + $status = $parsed_response['status'] ?? 'status-not-set';
890 + $error = $parsed_response['error'] ?? 'error-not-set';
891 + } else {
892 + $status = $response_code;
893 + $error = $response_body;
894 + }
895 + return new \WP_Error( $status, $error );
866 896 }
867 897
868 898 return true;
869 899 }
@@ -936,30 +966,81 @@
936 966 return ( ! is_wp_error( $request ) && 200 === wp_remote_retrieve_response_code( $request ) );
937 967 }
938 968
939 969 /**
940 - * Get index settings.
970 + * Get index settings
941 971 *
942 - * @param string $index Index name.
943 - * @since 4.4.0
972 + * @param string $index Index name
973 + * @param bool $force_refresh Whether to use or not a cached value. Default false, use cached.
974 + * @since 4.4.0, 4.7.0 added the $force_refresh parameter
944 975 * @return array|WP_Error Raw ES response from the $index/_settings?flat_settings=true endpoint
945 976 */
946 - public function get_index_settings( string $index ) {
977 + public function get_index_settings( string $index, bool $force_refresh = false ) {
978 + $transient_key = "ep_index_settings_{$index}";
979 +
980 + if ( ! $force_refresh ) {
981 + $cache = Utils\get_transient( $transient_key );
982 + if ( false !== $cache ) {
983 + return $cache;
984 + }
985 + }
986 +
947 987 $endpoint = trailingslashit( $index ) . '_settings?flat_settings=true';
948 988 $request = $this->remote_request( $endpoint, [], [], 'get_index_settings' );
949 989
950 990 if ( is_wp_error( $request ) ) {
991 + Utils\set_transient( $transient_key, $request, MINUTE_IN_SECONDS );
951 992 return $request;
952 993 }
953 994
995 + if ( wp_remote_retrieve_response_code( $request ) !== 200 ) {
996 + Utils\set_transient( $transient_key, $request, MINUTE_IN_SECONDS );
997 + return new \WP_Error(
998 + 'ep_get_index_settings_failed',
999 + esc_html__( 'Error while getting the index settings.', 'elasticpress' ),
1000 + $request
1001 + );
1002 + }
1003 +
954 1004 $response_body = wp_remote_retrieve_body( $request );
955 1005
956 1006 $settings = json_decode( $response_body, true );
957 1007
1008 + Utils\set_transient( $transient_key, $settings, DAY_IN_SECONDS );
1009 +
958 1010 return $settings;
959 1011 }
960 1012
961 1013 /**
1014 + * Get a particular index setting
1015 + *
1016 + * @param string $index Index name
1017 + * @param string $setting Setting name
1018 + * @param bool $force_refresh Whether to use or not a cached value. Default false, use cached.
1019 + * @return mixed
1020 + */
1021 + public function get_index_setting( string $index, string $setting, bool $force_refresh = false ) {
1022 + $settings = $this->get_index_settings( $index, $force_refresh );
1023 +
1024 + if ( is_wp_error( $settings ) || empty( $settings[ $index ]['settings'][ $setting ] ) ) {
1025 + return null;
1026 + }
1027 +
1028 + return $settings[ $index ]['settings'][ $setting ];
1029 + }
1030 +
1031 + /**
1032 + * Given an index return its total fields limit
1033 + *
1034 + * @since 4.4.0, 4.7.0 wrapper of get_index_setting()
1035 + * @param string $index_name The index name
1036 + * @return int|null
1037 + */
1038 + public function get_index_total_fields_limit( $index_name ) {
1039 + return $this->get_index_setting( $index_name, 'index.mapping.total_fields.limit' );
1040 + }
1041 +
1042 + /**
962 1043 * Update index settings.
963 1044 *
964 1045 * @param string $index Index name.
965 1046 * @param array $settings Setting update array.
@@ -1089,9 +1170,9 @@
1089 1170 * @param {string} $body Bulk index request body
1090 1171 * @param {string} $type Index type
1091 1172 * @return {string} New path
1092 1173 */
1093 - if ( version_compare( $this->get_elasticsearch_version(), '7.0', '<' ) ) {
1174 + if ( version_compare( (string) $this->get_elasticsearch_version(), '7.0', '<' ) ) {
1094 1175 $path = apply_filters( 'ep_bulk_index_request_path', $index . '/' . $type . '/_bulk', $body, $type );
1095 1176 } else {
1096 1177 $path = apply_filters( 'ep_bulk_index_request_path', $index . '/_bulk', $body, $type );
1097 1178 }
@@ -1123,9 +1204,17 @@
1123 1204 * @since 1.8
1124 1205 * @return array
1125 1206 */
1126 1207 public function get_query_log() {
1127 - return $this->queries;
1208 + /**
1209 + * Filter the query log
1210 + *
1211 + * @hook ep_get_query_log
1212 + * @since 5.3.0
1213 + * @param {array} $queries The query log
1214 + * @return {array} The query log
1215 + */
1216 + return apply_filters( 'ep_get_query_log', $this->queries );
1128 1217 }
1129 1218
1130 1219 /**
1131 1220 * Wrapper for wp_remote_request
@@ -1140,9 +1229,9 @@
1140 1229 * @param string $type Type of request, used for debugging.
1141 1230 *
1142 1231 * @return WP_Error|array The response or WP_Error on failure.
1143 1232 */
1144 - public function remote_request( $path, $args = [], $query_args = [], $type = null ) {
1233 + public function remote_request( $path, $args = [], $query_args = [], $type = '' ) {
1145 1234
1146 1235 if ( empty( $args['method'] ) ) {
1147 1236 $args['method'] = 'GET';
1148 1237 }
@@ -1218,9 +1307,9 @@
1218 1307 * @hook ep_intercept_remote_request
1219 1308 * @param {boolean} $intercept True to intercept
1220 1309 * @return {boolean} New value
1221 1310 */
1222 - if ( true === apply_filters( 'ep_intercept_remote_request', false ) ) {
1311 + if ( true === apply_filters( 'ep_intercept_remote_request', false ) || ! empty( $query_args['ep_intercept_request'] ) ) {
1223 1312 /**
1224 1313 * Filter intercepted request
1225 1314 *
1226 1315 * @hook ep_do_intercept_request
@@ -1243,9 +1332,9 @@
1243 1332 $is_valid_res = ( $request_response_code >= 200 && $request_response_code <= 299 );
1244 1333 $is_non_blocking_request = ( 0 === $request_response_code );
1245 1334
1246 1335 if ( false === $request || is_wp_error( $request ) || ( ! $is_valid_res && ! $is_non_blocking_request ) ) {
1247 - $failures++;
1336 + ++$failures;
1248 1337
1249 1338 /**
1250 1339 * Filter max number of times to attempt remote requests
1251 1340 *
@@ -1270,8 +1359,17 @@
1270 1359 $query['blocking'] = true;
1271 1360 $query['request'] = $request;
1272 1361 $this->add_query_log( $query );
1273 1362
1363 + /**
1364 + * Fires after Elasticsearch remote request
1365 + *
1366 + * @hook ep_remote_request
1367 + * @param {array} $query Remote request arguments
1368 + * @param {string} $type Request type
1369 + */
1370 + do_action( 'ep_remote_request', $query, $type );
1371 +
1274 1372 return $request;
1275 1373 }
1276 1374
1277 1375 $query['time_finish'] = microtime( true );
@@ -1277,19 +1375,12 @@
1277 1375 $query['time_finish'] = microtime( true );
1278 1376 $query['request'] = $request;
1279 1377 $this->add_query_log( $query );
1280 1378
1281 - /**
1282 - * Fires after Elasticsearch remote request
1283 - *
1284 - * @hook ep_remote_request
1285 - * @param {array} $query Remote request arguments
1286 - * @param {string} $type Request type
1287 - */
1379 + // This action is documented above
1288 1380 do_action( 'ep_remote_request', $query, $type );
1289 1381
1290 1382 return $request;
1291 -
1292 1383 }
1293 1384
1294 1385 /**
1295 1386 * Parse response from Elasticsearch
@@ -1337,9 +1428,8 @@
1337 1428 return array(
1338 1429 'status' => true,
1339 1430 'data' => $response->_all->primaries->indexing,
1340 1431 );
1341 -
1342 1432 }
1343 1433
1344 1434 /**
1345 1435 * Set ES plugins and version, detect server type, and cache everything
@@ -1413,20 +1503,24 @@
1413 1503 $node = end( $response['nodes'] );
1414 1504 // Save version of last node. We assume all nodes are same version.
1415 1505 $this->elasticsearch_version = $node['version'];
1416 1506
1507 + // Elasticsearch calls "modules" all default plugins that can't be uninstalled
1508 + if ( isset( $node['modules'] ) && is_array( $node['modules'] ) ) {
1509 + foreach ( $node['modules'] as $plugin ) {
1510 + $this->elasticsearch_plugins[ $plugin['name'] ] = $plugin['version'];
1511 + }
1512 +
1513 + if ( ! empty( $node['modules'] ) && ! empty( $node['modules'][0]['opensearch_version'] ) ) {
1514 + $this->server_type = 'opensearch';
1515 + }
1516 + }
1517 +
1417 1518 if ( isset( $node['plugins'] ) && is_array( $node['plugins'] ) ) {
1418 1519 foreach ( $node['plugins'] as $plugin ) {
1419 1520 $this->elasticsearch_plugins[ $plugin['name'] ] = $plugin['version'];
1420 1521 }
1421 1522 }
1422 - if ( isset( $node['modules'] )
1423 - && is_array( $node['modules'] )
1424 - && ! empty( $node['modules'] )
1425 - && ! empty( $node['modules'][0]['opensearch_version'] )
1426 - ) {
1427 - $this->server_type = 'opensearch';
1428 - }
1429 1523 }
1430 1524
1431 1525 /**
1432 1526 * Cache ES info
@@ -1625,9 +1719,9 @@
1625 1719 /**
1626 1720 * Filter the User Agent header when submitting requests to Elasticsearch.
1627 1721 *
1628 1722 * @hook ep_remote_request_add_ep_user_agent
1629 - * @param {bool} $should_add_ep_verion Whether the ElasticPress version should be added to the User Agent string.
1723 + * @param {bool} $should_add_ep_version Whether the ElasticPress version should be added to the User Agent string.
1630 1724 * @return {bool} New value
1631 1725 * @since 3.6.1
1632 1726 */
1633 1727 if ( apply_filters( 'ep_remote_request_add_ep_user_agent', Utils\is_epio() ) ) {
@@ -1644,14 +1738,27 @@
1644 1738 /**
1645 1739 * Query logging. Don't log anything to the queries property when
1646 1740 * WP_DEBUG is not enabled. Calls action 'ep_add_query_log' if you
1647 1741 * want to access the query outside of the ElasticPress plugin. This
1648 - * runs regardless of debufg settings.
1742 + * runs regardless of debug settings.
1649 1743 *
1650 1744 * @param array $query Query to log.
1651 1745 */
1652 1746 protected function add_query_log( $query ) {
1653 - if ( ( defined( 'WP_DEBUG' ) && WP_DEBUG ) || ( defined( 'WP_EP_DEBUG' ) && WP_EP_DEBUG ) ) {
1747 + $wp_debug = defined( 'WP_DEBUG' ) && WP_DEBUG;
1748 + $wp_ep_debug = defined( 'WP_EP_DEBUG' ) && WP_EP_DEBUG;
1749 +
1750 + /**
1751 + * Filter query logging. Don't log anything to the queries property when true.
1752 + *
1753 + * @hook ep_disable_query_logging
1754 + * @param {bool} Whether to log to the queries property. Defaults to false.
1755 + * @return {bool} New value
1756 + * @since 5.1.4
1757 + */
1758 + $disable_query_logging = apply_filters( 'ep_disable_query_logging', false );
1759 +
1760 + if ( ! $disable_query_logging && ( $wp_debug || $wp_ep_debug ) ) {
1654 1761 $this->queries[] = $query;
1655 1762 }
1656 1763
1657 1764 /**
@@ -1670,9 +1777,11 @@
1670 1777 * @since 4.4.0, 4.5.0 Added $status
1671 1778 * @return array
1672 1779 */
1673 1780 public function get_index_names( $status = 'active' ) {
1674 - $sites = ( defined( 'EP_IS_NETWORK' ) && EP_IS_NETWORK ) ? Utils\get_sites() : array( array( 'blog_id' => get_current_blog_id() ) );
1781 + $sites = ( defined( 'EP_IS_NETWORK' ) && EP_IS_NETWORK ) ?
1782 + Utils\get_sites( 0, true ) :
1783 + array( array( 'blog_id' => get_current_blog_id() ) );
1675 1784
1676 1785 $all_indexables = Indexables::factory()->get_all( null, false, $status );
1677 1786
1678 1787 $global_indexes = [];
@@ -1683,11 +1792,8 @@
1683 1792 continue;
1684 1793 }
1685 1794
1686 1795 foreach ( $sites as $site ) {
1687 - if ( ! Utils\is_site_indexable( $site['blog_id'] ) ) {
1688 - continue;
1689 - }
1690 1796 $non_global_indexes[] = $indexable->get_index_name( $site['blog_id'] );
1691 1797 }
1692 1798 }
1693 1799
@@ -1699,9 +1805,9 @@
1699 1805 *
1700 1806 * @since 4.4.0
1701 1807 * @return array Array of indices in Elasticsearch
1702 1808 */
1703 - public function get_cluster_indices() : array {
1809 + public function get_cluster_indices(): array {
1704 1810 $path = '_cat/indices?format=json';
1705 1811
1706 1812 $response = $this->remote_request( $path );
1707 1813
@@ -1708,40 +1814,21 @@
1708 1814 return (array) json_decode( wp_remote_retrieve_body( $response ), true );
1709 1815 }
1710 1816
1711 1817 /**
1712 - * Given an index return its total fields limit
1818 + * Return a comparison between which indices should be and are present in the ES server.
1713 1819 *
1714 - * @since 4.4.0
1715 - * @param string $index_name The index name
1716 - * @return int|null
1820 + * @since 4.6.0
1821 + * @return array Array with `missing_indices` and `present_indices` keys.
1717 1822 */
1718 - public function get_index_total_fields_limit( $index_name ) {
1719 - $cache_key = 'ep_total_fields_limit_' . $index_name;
1823 + public function get_indices_comparison() {
1824 + $all_index_names = $this->get_index_names();
1825 + $cluster_indices = $this->get_cluster_indices();
1720 1826
1721 - $is_network = defined( 'EP_IS_NETWORK' ) && EP_IS_NETWORK;
1722 - if ( $is_network ) {
1723 - $cached = get_site_transient( $cache_key );
1724 - } else {
1725 - $cached = get_transient( $cache_key );
1726 - }
1727 - if ( ! empty( $cached ) ) {
1728 - return $cached;
1729 - }
1827 + $cluster_index_names = wp_list_pluck( $cluster_indices, 'index' );
1730 1828
1731 - $index_settings = $this->get_index_settings( $index_name );
1732 - if ( is_wp_error( $index_settings ) || empty( $index_settings[ $index_name ]['settings']['index.mapping.total_fields.limit'] ) ) {
1733 - return null;
1734 - }
1735 -
1736 - $es_field_limit = $index_settings[ $index_name ]['settings']['index.mapping.total_fields.limit'];
1737 -
1738 - if ( $is_network ) {
1739 - set_site_transient( $cache_key, $es_field_limit, DAY_IN_SECONDS );
1740 - } else {
1741 - set_transient( $cache_key, $es_field_limit, DAY_IN_SECONDS );
1742 - }
1743 -
1744 - return (int) $es_field_limit;
1829 + return [
1830 + 'missing_indices' => array_diff( $all_index_names, $cluster_index_names ),
1831 + 'present_indices' => array_intersect( $all_index_names, $cluster_index_names ),
1832 + ];
1745 1833 }
1746 -
1747 1834 }