| @@ -7,11 +7,12 @@ | ||
| 7 | 7 | */ |
| 8 | 8 | |
| 9 | 9 | namespace ElasticPress\Indexable\Post; |
| 10 | 10 | |
| 11 | -use ElasticPress\Elasticsearch as Elasticsearch; | |
| 12 | -use ElasticPress\Indexables as Indexables; | |
| 13 | -use ElasticPress\SyncManager as SyncManagerAbstract; | |
| 11 | +use ElasticPress\Elasticsearch; | |
| 12 | +use ElasticPress\Indexables; | |
| 13 | +use ElasticPress\IndexHelper; | |
| 14 | +use ElasticPress\Utils; | |
| 14 | 15 | |
| 15 | 16 | if ( ! defined( 'ABSPATH' ) ) { |
| 16 | 17 | // @codeCoverageIgnoreStart |
| 17 | 18 | exit; // Exit if accessed directly. |
| @@ -20,9 +21,9 @@ | ||
| 20 | 21 | |
| 21 | 22 | /** |
| 22 | 23 | * Sync manager class |
| 23 | 24 | */ |
| 24 | -class SyncManager extends SyncManagerAbstract { | |
| 25 | +class SyncManager extends \ElasticPress\SyncManager { | |
| 25 | 26 | |
| 26 | 27 | /** |
| 27 | 28 | * Indexable slug |
| 28 | 29 | * |
| @@ -51,11 +52,12 @@ | ||
| 51 | 52 | if ( ! $this->can_index_site() ) { |
| 52 | 53 | return; |
| 53 | 54 | } |
| 54 | 55 | |
| 55 | - add_action( 'wp_insert_post', array( $this, 'action_sync_on_update' ), 999, 3 ); | |
| 56 | - add_action( 'add_attachment', array( $this, 'action_sync_on_update' ), 999, 3 ); | |
| 57 | - add_action( 'edit_attachment', array( $this, 'action_sync_on_update' ), 999, 3 ); | |
| 56 | + add_action( 'wp_insert_post', array( $this, 'action_sync_on_update' ), 999 ); | |
| 57 | + add_action( 'add_attachment', array( $this, 'action_sync_on_update' ), 999 ); | |
| 58 | + add_action( 'edit_attachment', array( $this, 'action_sync_on_update' ), 999 ); | |
| 59 | + add_action( 'wp_media_attach_action', array( $this, 'action_sync_on_media_attach' ), 999, 2 ); | |
| 58 | 60 | add_action( 'delete_post', array( $this, 'action_delete_post' ) ); |
| 59 | 61 | add_action( 'updated_post_meta', array( $this, 'action_queue_meta_sync' ), 10, 4 ); |
| 60 | 62 | add_action( 'added_post_meta', array( $this, 'action_queue_meta_sync' ), 10, 4 ); |
| 61 | 63 | // Called just because we need to know somehow if $delete_all is set before action_queue_meta_sync() runs. |
| @@ -60,15 +62,41 @@ | ||
| 60 | 62 | add_action( 'added_post_meta', array( $this, 'action_queue_meta_sync' ), 10, 4 ); |
| 61 | 63 | // Called just because we need to know somehow if $delete_all is set before action_queue_meta_sync() runs. |
| 62 | 64 | add_filter( 'delete_post_metadata', array( $this, 'maybe_delete_meta_for_all' ), 10, 5 ); |
| 63 | 65 | add_action( 'deleted_post_meta', array( $this, 'action_queue_meta_sync' ), 10, 4 ); |
| 66 | + add_action( 'wp_initialize_site', array( $this, 'action_create_blog_index' ) ); | |
| 67 | + | |
| 68 | + add_filter( 'ep_sync_insert_permissions_bypass', array( $this, 'filter_bypass_permission_checks_for_machines' ) ); | |
| 69 | + add_filter( 'ep_sync_delete_permissions_bypass', array( $this, 'filter_bypass_permission_checks_for_machines' ) ); | |
| 70 | + | |
| 71 | + // Conditionally update posts associated with terms | |
| 72 | + add_action( 'ep_admin_notices', [ $this, 'maybe_display_notice_edit_single_term' ] ); | |
| 73 | + add_action( 'ep_admin_notices', [ $this, 'maybe_display_notice_term_list_screen' ] ); | |
| 64 | 74 | add_action( 'set_object_terms', array( $this, 'action_set_object_terms' ), 10, 6 ); |
| 65 | 75 | add_action( 'edited_term', array( $this, 'action_edited_term' ), 10, 3 ); |
| 66 | 76 | add_action( 'deleted_term_relationships', array( $this, 'action_deleted_term_relationships' ), 10, 3 ); |
| 67 | - add_action( 'wp_initialize_site', array( $this, 'action_create_blog_index' ) ); | |
| 68 | 77 | |
| 69 | - add_filter( 'ep_sync_insert_permissions_bypass', array( $this, 'filter_bypass_permission_checks_for_machines' ) ); | |
| 70 | - add_filter( 'ep_sync_delete_permissions_bypass', array( $this, 'filter_bypass_permission_checks_for_machines' ) ); | |
| 78 | + // Clear index settings cache | |
| 79 | + add_action( 'ep_update_index_settings', [ $this, 'clear_index_settings_cache' ] ); | |
| 80 | + add_action( 'ep_after_put_mapping', [ $this, 'clear_index_settings_cache' ] ); | |
| 81 | + add_action( 'ep_saved_weighting_configuration', [ $this, 'clear_index_settings_cache' ] ); | |
| 82 | + | |
| 83 | + // Clear distinct meta field per post type cache | |
| 84 | + add_action( 'wp_insert_post', [ $this, 'clear_meta_keys_db_per_post_type_cache_by_post_id' ] ); | |
| 85 | + add_action( 'delete_post', [ $this, 'clear_meta_keys_db_per_post_type_cache_by_post_id' ] ); | |
| 86 | + add_action( 'updated_post_meta', [ $this, 'clear_meta_keys_db_per_post_type_cache_by_meta' ], 10, 2 ); | |
| 87 | + add_action( 'added_post_meta', [ $this, 'clear_meta_keys_db_per_post_type_cache_by_meta' ], 10, 2 ); | |
| 88 | + add_action( 'deleted_post_meta', [ $this, 'clear_meta_keys_db_per_post_type_cache_by_meta' ], 10, 2 ); | |
| 89 | + add_action( 'delete_post_metadata', [ $this, 'clear_meta_keys_db_per_post_type_cache_by_meta' ], 10, 2 ); | |
| 90 | + | |
| 91 | + // Prevents password protected posts from being indexed | |
| 92 | + add_filter( 'ep_post_sync_kill', [ $this, 'kill_sync_for_password_protected' ], 10, 2 ); | |
| 93 | + | |
| 94 | + // Display the status of the document in ES in the admin bar | |
| 95 | + add_filter( 'ep_admin_bar_status_and_summary', [ $this, 'maybe_add_doc_status_to_admin_bar_status' ] ); | |
| 96 | + | |
| 97 | + // Delete a post from the index if a password was added | |
| 98 | + add_action( 'post_updated', [ $this, 'delete_post_with_new_password' ], 10, 3 ); | |
| 71 | 99 | } |
| 72 | 100 | |
| 73 | 101 | /** |
| 74 | 102 | * Un-setup actions and filters (for multisite). |
| @@ -78,8 +106,9 @@ | ||
| 78 | 106 | public function tear_down() { |
| 79 | 107 | remove_action( 'wp_insert_post', array( $this, 'action_sync_on_update' ), 999 ); |
| 80 | 108 | remove_action( 'add_attachment', array( $this, 'action_sync_on_update' ), 999 ); |
| 81 | 109 | remove_action( 'edit_attachment', array( $this, 'action_sync_on_update' ), 999 ); |
| 110 | + remove_action( 'wp_media_attach_action', array( $this, 'action_sync_on_media_attach' ), 999 ); | |
| 82 | 111 | remove_action( 'delete_post', array( $this, 'action_delete_post' ) ); |
| 83 | 112 | remove_action( 'updated_post_meta', array( $this, 'action_queue_meta_sync' ) ); |
| 84 | 113 | remove_action( 'added_post_meta', array( $this, 'action_queue_meta_sync' ) ); |
| 85 | 114 | remove_filter( 'delete_post_metadata', array( $this, 'maybe_delete_meta_for_all' ) ); |
| @@ -86,8 +115,16 @@ | ||
| 86 | 115 | remove_action( 'deleted_post_meta', array( $this, 'action_queue_meta_sync' ) ); |
| 87 | 116 | remove_action( 'wp_initialize_site', array( $this, 'action_create_blog_index' ) ); |
| 88 | 117 | remove_filter( 'ep_sync_insert_permissions_bypass', array( $this, 'filter_bypass_permission_checks_for_machines' ) ); |
| 89 | 118 | remove_filter( 'ep_sync_delete_permissions_bypass', array( $this, 'filter_bypass_permission_checks_for_machines' ) ); |
| 119 | + remove_filter( 'ep_post_sync_kill', [ $this, 'kill_sync_for_password_protected' ] ); | |
| 120 | + | |
| 121 | + // Clear index settings cache | |
| 122 | + remove_action( 'ep_update_index_settings', [ $this, 'clear_index_settings_cache' ] ); | |
| 123 | + remove_action( 'ep_after_put_mapping', [ $this, 'clear_index_settings_cache' ] ); | |
| 124 | + remove_action( 'ep_saved_weighting_configuration', [ $this, 'clear_index_settings_cache' ] ); | |
| 125 | + | |
| 126 | + remove_filter( 'ep_admin_bar_status_and_summary', [ $this, 'maybe_add_doc_status_to_admin_bar_status' ] ); | |
| 90 | 127 | } |
| 91 | 128 | |
| 92 | 129 | /** |
| 93 | 130 | * Whether to delete all meta from other posts that is associated with the deleted post. |
| @@ -108,9 +145,9 @@ | ||
| 108 | 145 | /** |
| 109 | 146 | * Filter to allow cron and WP CLI processes to index/delete documents |
| 110 | 147 | * |
| 111 | 148 | * @param boolean $bypass The current filtered value |
| 112 | - * @return boolean Boolean indicating if permission checking should be bypased or not | |
| 149 | + * @return boolean Boolean indicating if permission checking should be bypassed or not | |
| 113 | 150 | * @since 3.6.0 |
| 114 | 151 | */ |
| 115 | 152 | public function filter_bypass_permission_checks_for_machines( $bypass ) { |
| 116 | 153 | // Allow index/delete during cron |
| @@ -185,8 +222,9 @@ | ||
| 185 | 222 | 'ep_integrate' => true, |
| 186 | 223 | 'meta_key' => $meta_key, |
| 187 | 224 | 'meta_value' => $meta_value, |
| 188 | 225 | 'fields' => 'ids', |
| 226 | + 'post_type' => $indexable->get_indexable_post_types(), | |
| 189 | 227 | ] |
| 190 | 228 | ); |
| 191 | 229 | |
| 192 | 230 | remove_filter( 'ep_is_integrated_request', '__return_true' ); |
| @@ -193,9 +231,9 @@ | ||
| 193 | 231 | |
| 194 | 232 | if ( $query->have_posts() && $query->elasticsearch_success ) { |
| 195 | 233 | $posts_to_be_synced = array_filter( |
| 196 | 234 | $query->posts, |
| 197 | - function( $object_id ) { | |
| 235 | + function ( $object_id ) { | |
| 198 | 236 | return ! apply_filters( 'ep_post_sync_kill', false, $object_id, $object_id ); |
| 199 | 237 | } |
| 200 | 238 | ); |
| 201 | 239 | if ( ! empty( $posts_to_be_synced ) ) { |
| @@ -272,11 +310,9 @@ | ||
| 272 | 310 | /** |
| 273 | 311 | * Make sure to remove this post from the sync queue in case an shutdown happens |
| 274 | 312 | * before a redirect when a redirect has already been triggered. |
| 275 | 313 | */ |
| 276 | - if ( isset( $this->sync_queue[ $post_id ] ) ) { | |
| 277 | - unset( $this->sync_queue[ $post_id ] ); | |
| 278 | - } | |
| 314 | + $this->remove_from_queue( $post_id ); | |
| 279 | 315 | } |
| 280 | 316 | |
| 281 | 317 | /** |
| 282 | 318 | * Sync ES index with what happened to the post being saved |
| @@ -350,8 +386,9 @@ | ||
| 350 | 386 | * @param {int} $object_id ID of post |
| 351 | 387 | * @return {boolean} New value |
| 352 | 388 | */ |
| 353 | 389 | if ( apply_filters( 'ep_post_sync_kill', false, $post_id, $post_id ) ) { |
| 390 | + $this->remove_from_queue( $post_id ); | |
| 354 | 391 | return; |
| 355 | 392 | } |
| 356 | 393 | |
| 357 | 394 | $this->add_to_queue( $post_id ); |
| @@ -359,8 +396,99 @@ | ||
| 359 | 396 | } |
| 360 | 397 | } |
| 361 | 398 | |
| 362 | 399 | /** |
| 400 | + * Depending on the number of posts associated with the term display an admin notice | |
| 401 | + * | |
| 402 | + * @since 4.4.0 | |
| 403 | + * @param array $notices Current ElasticPress admin notices | |
| 404 | + * @return array | |
| 405 | + */ | |
| 406 | + public function maybe_display_notice_edit_single_term( $notices ) { | |
| 407 | + global $pagenow, $tag; | |
| 408 | + | |
| 409 | + /** | |
| 410 | + * Make sure we're on a term-related page in the admin dashboard. | |
| 411 | + */ | |
| 412 | + if ( ! is_admin() || 'term.php' !== $pagenow || ! $tag instanceof \WP_Term ) { | |
| 413 | + return $notices; | |
| 414 | + } | |
| 415 | + | |
| 416 | + if ( IndexHelper::factory()->get_index_default_per_page() >= $tag->count ) { | |
| 417 | + | |
| 418 | + $child_tags = get_term_children( $tag->term_id, $tag->taxonomy ); | |
| 419 | + if ( empty( $child_tags ) ) { | |
| 420 | + return $notices; | |
| 421 | + } | |
| 422 | + foreach ( $child_tags as $child_tag_id ) { | |
| 423 | + $child_tag = get_term( $child_tag_id ); | |
| 424 | + if ( ! is_wp_error( $child_tag ) && IndexHelper::factory()->get_index_default_per_page() < $child_tag->count && ! isset( $notices['edited_single_parent_term'] ) ) { | |
| 425 | + $notices['edited_single_parent_term'] = [ | |
| 426 | + 'html' => sprintf( | |
| 427 | + /* translators: Sync Page URL */ | |
| 428 | + __( 'Due to the number of posts associated with its child terms, you will need to <a href="%s">resync</a> after editing or deleting it.', 'elasticpress' ), | |
| 429 | + Utils\get_sync_url() | |
| 430 | + ), | |
| 431 | + 'type' => 'warning', | |
| 432 | + 'dismiss' => true, | |
| 433 | + 'scope' => 'site', | |
| 434 | + ]; | |
| 435 | + break; | |
| 436 | + } | |
| 437 | + } | |
| 438 | + | |
| 439 | + return $notices; | |
| 440 | + } | |
| 441 | + $notices['edited_single_term'] = [ | |
| 442 | + 'html' => sprintf( | |
| 443 | + /* translators: Sync Page URL */ | |
| 444 | + __( 'Due to the number of posts associated with this term, you will need to <a href="%s">resync</a> after editing or deleting it.', 'elasticpress' ), | |
| 445 | + Utils\get_sync_url() | |
| 446 | + ), | |
| 447 | + 'type' => 'warning', | |
| 448 | + 'dismiss' => true, | |
| 449 | + 'scope' => 'site', | |
| 450 | + ]; | |
| 451 | + | |
| 452 | + return $notices; | |
| 453 | + } | |
| 454 | + | |
| 455 | + /** | |
| 456 | + * Depending on the number of posts display an admin notice in the Dashboard Terms List Screen | |
| 457 | + * | |
| 458 | + * @since 4.4.0 | |
| 459 | + * @param array $notices Current ElasticPress admin notices | |
| 460 | + * @return array | |
| 461 | + */ | |
| 462 | + public function maybe_display_notice_term_list_screen( $notices ) { | |
| 463 | + global $pagenow, $tax; | |
| 464 | + | |
| 465 | + /** | |
| 466 | + * Make sure we're on a term-related page in the admin dashboard. | |
| 467 | + */ | |
| 468 | + if ( ! is_admin() || 'edit-tags.php' !== $pagenow || ! $tax instanceof \WP_Taxonomy ) { | |
| 469 | + return $notices; | |
| 470 | + } | |
| 471 | + | |
| 472 | + if ( ! $this->is_tax_max_count_bigger_than_items_per_cycle( $tax ) ) { | |
| 473 | + return $notices; | |
| 474 | + } | |
| 475 | + | |
| 476 | + $notices['too_many_posts_on_term'] = [ | |
| 477 | + 'html' => sprintf( | |
| 478 | + /* translators: Sync Page URL */ | |
| 479 | + __( 'Depending on the number of posts associated with a term, you may need to <a href="%s">resync</a> after editing or deleting it.', 'elasticpress' ), | |
| 480 | + Utils\get_sync_url() | |
| 481 | + ), | |
| 482 | + 'type' => 'warning', | |
| 483 | + 'dismiss' => true, | |
| 484 | + 'scope' => 'site', | |
| 485 | + ]; | |
| 486 | + | |
| 487 | + return $notices; | |
| 488 | + } | |
| 489 | + | |
| 490 | + /** | |
| 363 | 491 | * When a post's terms are changed, re-index. |
| 364 | 492 | * |
| 365 | 493 | * This catches term deletions via wp_delete_term(), because that function internally loops over all attached objects |
| 366 | 494 | * and updates their terms. It will also end up firing whenever set_object_terms is called, but the queue will de-duplicate |
| @@ -447,8 +575,12 @@ | ||
| 447 | 575 | */ |
| 448 | 576 | public function action_edited_term( $term_id, $tt_id, $taxonomy ) { |
| 449 | 577 | global $wpdb; |
| 450 | 578 | |
| 579 | + if ( $this->kill_sync() ) { | |
| 580 | + return; | |
| 581 | + } | |
| 582 | + | |
| 451 | 583 | /** |
| 452 | 584 | * Filter to whether skip a sync during autosave, defaults to true |
| 453 | 585 | * |
| 454 | 586 | * @hook ep_skip_autosave_sync |
| @@ -466,14 +598,32 @@ | ||
| 466 | 598 | } |
| 467 | 599 | } |
| 468 | 600 | |
| 469 | 601 | // Find ID of all attached posts (query lifted from wp_delete_term()) |
| 470 | - $object_ids = (array) $wpdb->get_col( $wpdb->prepare( "SELECT object_id FROM $wpdb->term_relationships WHERE term_taxonomy_id = %d", $tt_id ) ); | |
| 602 | + $object_ids = (array) $wpdb->get_col( // phpcs:disable WordPress.DB.DirectDatabaseQuery | |
| 603 | + $wpdb->prepare( "SELECT object_id FROM {$wpdb->term_relationships} WHERE term_taxonomy_id = %d", $tt_id ) | |
| 604 | + ); | |
| 471 | 605 | |
| 606 | + // If the current term is not attached, check if the child terms are attached to the post | |
| 607 | + if ( empty( $object_ids ) ) { | |
| 608 | + $child_terms = get_term_children( $term_id, $taxonomy ); | |
| 609 | + if ( ! empty( $child_terms ) ) { | |
| 610 | + $in_id = join( ',', array_fill( 0, count( $child_terms ), '%d' ) ); | |
| 611 | + $object_ids = (array) $wpdb->get_col( // phpcs:disable WordPress.DB.DirectDatabaseQuery | |
| 612 | + $wpdb->prepare( | |
| 613 | + "SELECT object_id FROM {$wpdb->term_relationships} WHERE term_taxonomy_id IN ( {$in_id} )", // phpcs:ignore WordPress.DB.PreparedSQL.InterpolatedNotPrepared, WordPress.DB.PreparedSQLPlaceholders.UnfinishedPrepare | |
| 614 | + $child_terms | |
| 615 | + ) | |
| 616 | + ); | |
| 617 | + } | |
| 618 | + } | |
| 472 | 619 | if ( ! count( $object_ids ) ) { |
| 473 | 620 | return; |
| 474 | 621 | } |
| 475 | 622 | |
| 623 | + // If we have more items to update than the number set as Content Items per Index Cycle, skip it. | |
| 624 | + $should_skip = count( $object_ids ) > IndexHelper::factory()->get_index_default_per_page(); | |
| 625 | + | |
| 476 | 626 | /** |
| 477 | 627 | * Filter to allow skipping this action in case of custom handling |
| 478 | 628 | * |
| 479 | 629 | * @hook ep_skip_action_edited_term |
| @@ -483,14 +633,12 @@ | ||
| 483 | 633 | * @param {string} $taxonomy Taxonomy name. |
| 484 | 634 | * @param {array} $object_ids IDs of the objects attached to the term id. |
| 485 | 635 | * @return {bool} New value of whether to skip running action_edited_term or not |
| 486 | 636 | */ |
| 487 | - if ( apply_filters( 'ep_skip_action_edited_term', false, $term_id, $tt_id, $taxonomy, $object_ids ) ) { | |
| 637 | + if ( apply_filters( 'ep_skip_action_edited_term', $should_skip, $term_id, $tt_id, $taxonomy, $object_ids ) ) { | |
| 488 | 638 | return; |
| 489 | 639 | } |
| 490 | 640 | |
| 491 | - $indexable = Indexables::factory()->get( $this->indexable_slug ); | |
| 492 | - | |
| 493 | 641 | // Add all of them to the queue |
| 494 | 642 | foreach ( $object_ids as $post_id ) { |
| 495 | 643 | if ( ! $this->should_reindex_post( $post_id, $taxonomy ) ) { |
| 496 | 644 | continue; |
| @@ -605,15 +753,62 @@ | ||
| 605 | 753 | restore_current_blog(); |
| 606 | 754 | } |
| 607 | 755 | |
| 608 | 756 | /** |
| 609 | - * Check if post attributes (post status, taxonomy, and type) match what is needed to reindex or not. | |
| 757 | + * DEPRECATED. Clear the cache of the total fields limit | |
| 610 | 758 | * |
| 611 | - * @param int $post_id The post ID. | |
| 612 | - * @param string $taxonomy The taxonomy slug. | |
| 759 | + * @since 4.4.0 | |
| 760 | + */ | |
| 761 | + public function clear_total_fields_limit_cache() { | |
| 762 | + _deprecated_function( __METHOD__, '4.7.0', '\ElasticPress\Indexable\Post\SyncManager::clear_index_settings_cache()' ); | |
| 763 | + } | |
| 764 | + | |
| 765 | + /** | |
| 766 | + * Clear the cache of the total fields limit | |
| 767 | + * | |
| 768 | + * @param int $post_id The post ID | |
| 769 | + * @since 4.4.0 | |
| 770 | + */ | |
| 771 | + public function clear_meta_keys_db_per_post_type_cache_by_post_id( $post_id ) { | |
| 772 | + $post_type = get_post_type( $post_id ); | |
| 773 | + if ( $post_type ) { | |
| 774 | + $this->clear_meta_keys_db_cache( $post_type ); | |
| 775 | + } | |
| 776 | + } | |
| 777 | + | |
| 778 | + /** | |
| 779 | + * Clear the cache of the total fields limit | |
| 780 | + * | |
| 781 | + * @param int|array $meta_id Meta ID | |
| 782 | + * @param int $post_id The post ID | |
| 783 | + * @since 4.4.0 | |
| 784 | + */ | |
| 785 | + public function clear_meta_keys_db_per_post_type_cache_by_meta( $meta_id, $post_id ) { | |
| 786 | + $post_type = get_post_type( $post_id ); | |
| 787 | + if ( $post_type ) { | |
| 788 | + $this->clear_meta_keys_db_cache( $post_type ); | |
| 789 | + } | |
| 790 | + } | |
| 791 | + | |
| 792 | + /** | |
| 793 | + * Clear the cache of the total fields limit | |
| 794 | + * | |
| 795 | + * @param string $post_type The post type | |
| 796 | + * @since 4.4.0 | |
| 797 | + */ | |
| 798 | + protected function clear_meta_keys_db_cache( $post_type ) { | |
| 799 | + delete_transient( 'ep_meta_field_keys' ); | |
| 800 | + delete_transient( 'ep_meta_field_keys_' . $post_type ); | |
| 801 | + } | |
| 802 | + | |
| 803 | + /** | |
| 804 | + * Given a post ID, check if it should be indexed or not. | |
| 805 | + * | |
| 806 | + * @since 5.2.0 | |
| 807 | + * @param int $post_id Post ID. | |
| 613 | 808 | * @return boolean |
| 614 | 809 | */ |
| 615 | - protected function should_reindex_post( $post_id, $taxonomy ) { | |
| 810 | + public function is_post_indexable( $post_id ) { | |
| 616 | 811 | /** |
| 617 | 812 | * Filter to kill post sync |
| 618 | 813 | * |
| 619 | 814 | * @hook ep_post_sync_kill |
| @@ -638,8 +833,32 @@ | ||
| 638 | 833 | if ( ! in_array( $post->post_status, $indexable_post_statuses, true ) ) { |
| 639 | 834 | return false; |
| 640 | 835 | } |
| 641 | 836 | |
| 837 | + // Check post type | |
| 838 | + $indexable_post_types = $indexable->get_indexable_post_types(); | |
| 839 | + if ( ! in_array( $post->post_type, $indexable_post_types, true ) ) { | |
| 840 | + return false; | |
| 841 | + } | |
| 842 | + | |
| 843 | + return true; | |
| 844 | + } | |
| 845 | + | |
| 846 | + /** | |
| 847 | + * Check if post attributes (post status, taxonomy, and type) match what is needed to reindex or not. | |
| 848 | + * | |
| 849 | + * @param int $post_id The post ID. | |
| 850 | + * @param string $taxonomy The taxonomy slug. | |
| 851 | + * @return boolean | |
| 852 | + */ | |
| 853 | + protected function should_reindex_post( $post_id, $taxonomy ) { | |
| 854 | + if ( ! $this->is_post_indexable( $post_id ) ) { | |
| 855 | + return false; | |
| 856 | + } | |
| 857 | + | |
| 858 | + $indexable = Indexables::factory()->get( $this->indexable_slug ); | |
| 859 | + $post = get_post( $post_id ); | |
| 860 | + | |
| 642 | 861 | // Only re-index if the taxonomy is indexed for this post |
| 643 | 862 | $indexable_taxonomies = $indexable->get_indexable_post_taxonomies( $post ); |
| 644 | 863 | $indexable_taxonomy_names = wp_list_pluck( $indexable_taxonomies, 'name' ); |
| 645 | 864 | if ( ! in_array( $taxonomy, $indexable_taxonomy_names, true ) ) { |
| @@ -645,13 +864,252 @@ | ||
| 645 | 864 | if ( ! in_array( $taxonomy, $indexable_taxonomy_names, true ) ) { |
| 646 | 865 | return false; |
| 647 | 866 | } |
| 648 | 867 | |
| 649 | - // Check post type | |
| 868 | + // If we have more items to update than the number set as Content Items per Index Cycle, skip it to avoid a timeout. | |
| 869 | + $single_ids_queued = array_unique( array_keys( $this->get_sync_queue() ) ); | |
| 870 | + $has_too_many_queued = count( $single_ids_queued ) > IndexHelper::factory()->get_index_default_per_page(); | |
| 871 | + | |
| 872 | + return ! $has_too_many_queued; | |
| 873 | + } | |
| 874 | + | |
| 875 | + /** | |
| 876 | + * Given a taxonomy, check if the term with most posts is under or above the number set as Content Items per Index Cycle. | |
| 877 | + * | |
| 878 | + * The result will be cached in a transient. Its TTL will depend on the result: | |
| 879 | + * If it is determined we have a term with more posts, cache it for more time. | |
| 880 | + * | |
| 881 | + * @since 4.4.0 | |
| 882 | + * @param \WP_Taxonomy $tax The taxonomy object | |
| 883 | + * @return boolean | |
| 884 | + */ | |
| 885 | + protected function is_tax_max_count_bigger_than_items_per_cycle( \WP_Taxonomy $tax ): bool { | |
| 886 | + $transient_name = "ep_term_max_count_{$tax->name}"; | |
| 887 | + $cached_max_count = get_transient( $transient_name ); | |
| 888 | + | |
| 889 | + if ( is_integer( $cached_max_count ) ) { | |
| 890 | + return $cached_max_count > IndexHelper::factory()->get_index_default_per_page(); | |
| 891 | + } | |
| 892 | + | |
| 893 | + $max_count = get_terms( | |
| 894 | + [ | |
| 895 | + 'taxonomy' => $tax->name, | |
| 896 | + 'orderby' => 'count', | |
| 897 | + 'order' => 'DESC', | |
| 898 | + 'number' => 1, | |
| 899 | + 'count' => true, | |
| 900 | + ] | |
| 901 | + ); | |
| 902 | + | |
| 903 | + if ( ! is_array( $max_count ) || ! count( $max_count ) || ! $max_count[0] instanceof \WP_Term || ! is_integer( $max_count[0]->count ) ) { | |
| 904 | + set_transient( $transient_name, 0, HOUR_IN_SECONDS ); | |
| 905 | + return false; | |
| 906 | + } | |
| 907 | + | |
| 908 | + $is_max_count_bigger = $max_count[0]->count > IndexHelper::factory()->get_index_default_per_page(); | |
| 909 | + | |
| 910 | + set_transient( | |
| 911 | + $transient_name, | |
| 912 | + $max_count[0]->count, | |
| 913 | + $is_max_count_bigger ? DAY_IN_SECONDS : HOUR_IN_SECONDS | |
| 914 | + ); | |
| 915 | + | |
| 916 | + return $is_max_count_bigger; | |
| 917 | + } | |
| 918 | + | |
| 919 | + /** | |
| 920 | + * Prevent a password protected post from being indexed. | |
| 921 | + * | |
| 922 | + * @since 4.6.0 | |
| 923 | + * @param bool $skip Whether should skip or not before checking for a password | |
| 924 | + * @param int $object_id The Post ID | |
| 925 | + * @return bool New value of $skip | |
| 926 | + */ | |
| 927 | + public function kill_sync_for_password_protected( $skip, $object_id ) { | |
| 928 | + /** | |
| 929 | + * Short-circuits the process of checking if a post should be indexed or not depending on its password. | |
| 930 | + * | |
| 931 | + * Returning a non-null value will effectively short-circuit the function. | |
| 932 | + * | |
| 933 | + * @since 4.6.0 | |
| 934 | + * @hook ep_pre_kill_sync_for_password_protected | |
| 935 | + * @param {null} $new_skip Whether should skip or not before checking for a password | |
| 936 | + * @param {bool} $current_skip Current value | |
| 937 | + * @param {int} $object_id The Post ID | |
| 938 | + * @return {null|bool} New value of $skip or `null` to keep default behavior. | |
| 939 | + */ | |
| 940 | + $skip_filter = apply_filters( 'ep_pre_kill_sync_for_password_protected', null, $skip, $object_id ); | |
| 941 | + if ( ! is_null( $skip_filter ) ) { | |
| 942 | + return $skip_filter; | |
| 943 | + } | |
| 944 | + | |
| 945 | + if ( $skip ) { | |
| 946 | + return $skip; | |
| 947 | + } | |
| 948 | + | |
| 949 | + $post = get_post( $object_id ); | |
| 950 | + | |
| 951 | + return ! empty( $post->post_password ); | |
| 952 | + } | |
| 953 | + | |
| 954 | + /** | |
| 955 | + * Sync ES index when attached or detached action is called. | |
| 956 | + * | |
| 957 | + * @since 4.7.0 | |
| 958 | + * @param string $action Attach/detach action | |
| 959 | + * @param int $attachment_id The attachment ID | |
| 960 | + */ | |
| 961 | + public function action_sync_on_media_attach( $action, $attachment_id ) { | |
| 962 | + $indexable = Indexables::factory()->get( $this->indexable_slug ); | |
| 650 | 963 | $indexable_post_types = $indexable->get_indexable_post_types(); |
| 651 | - if ( ! in_array( $post->post_type, $indexable_post_types, true ) ) { | |
| 652 | - return false; | |
| 964 | + | |
| 965 | + if ( ! in_array( 'attachment', $indexable_post_types, true ) ) { | |
| 966 | + return; | |
| 653 | 967 | } |
| 968 | + $this->action_sync_on_update( $attachment_id ); | |
| 969 | + } | |
| 654 | 970 | |
| 655 | - return true; | |
| 971 | + /** | |
| 972 | + * Add the document status to the admin bar. | |
| 973 | + * | |
| 974 | + * @since 5.2.0 | |
| 975 | + * @deprecated 5.3.0 | |
| 976 | + * @param \WP_Admin_Bar $admin_bar WP Admin Bar instance | |
| 977 | + * @return void | |
| 978 | + */ | |
| 979 | + public function add_admin_bar_status( \WP_Admin_Bar $admin_bar ) { | |
| 980 | + _deprecated_function( __METHOD__, 'ElasticPress 5.3.0' ); | |
| 981 | + } | |
| 982 | + | |
| 983 | + /** | |
| 984 | + * Add the document status to the admin bar status and summary. | |
| 985 | + * | |
| 986 | + * @since 5.3.0 | |
| 987 | + * @param array $status_and_summary The status and summary. | |
| 988 | + * @return array The status and summary. | |
| 989 | + */ | |
| 990 | + public function maybe_add_doc_status_to_admin_bar_status( $status_and_summary ): array { | |
| 991 | + global $pagenow; | |
| 992 | + | |
| 993 | + if ( ! is_admin() || 'post.php' !== $pagenow ) { | |
| 994 | + return $status_and_summary; | |
| 995 | + } | |
| 996 | + | |
| 997 | + $post_id = get_the_ID(); | |
| 998 | + if ( ! $this->is_post_indexable( $post_id ) ) { | |
| 999 | + return $status_and_summary; | |
| 1000 | + } | |
| 1001 | + | |
| 1002 | + $document_status = $this->get_doc_status( $post_id ); | |
| 1003 | + if ( empty( $document_status['status'] ) ) { | |
| 1004 | + return $status_and_summary; | |
| 1005 | + } | |
| 1006 | + | |
| 1007 | + if ( 'success' === $status_and_summary['status'] || in_array( $document_status['status'], [ 'error', 'warning' ], true ) ) { | |
| 1008 | + $status_and_summary['status'] = $document_status['status']; | |
| 1009 | + } | |
| 1010 | + | |
| 1011 | + $status_and_summary['summary'] = array_merge( | |
| 1012 | + [ 'doc_status' => "{$document_status['message']}: {$document_status['explanation']}" ], | |
| 1013 | + $status_and_summary['summary'], | |
| 1014 | + ); | |
| 1015 | + | |
| 1016 | + return $status_and_summary; | |
| 1017 | + } | |
| 1018 | + | |
| 1019 | + /** | |
| 1020 | + * Get the document status for a post. | |
| 1021 | + * | |
| 1022 | + * @since 5.2.0 | |
| 1023 | + * @param int $post_id Post ID | |
| 1024 | + * @return array | |
| 1025 | + */ | |
| 1026 | + protected function get_doc_status( int $post_id ): array { | |
| 1027 | + $status = [ | |
| 1028 | + 'status' => 'success', | |
| 1029 | + 'message' => esc_html__( 'Content in sync', 'elasticpress' ), | |
| 1030 | + 'explanation' => esc_html__( 'WordPress and Elasticsearch content match.', 'elasticpress' ), | |
| 1031 | + ]; | |
| 1032 | + | |
| 1033 | + $indexable = Indexables::factory()->get( $this->indexable_slug ); | |
| 1034 | + $es_doc = $indexable->get( $post_id ); | |
| 1035 | + if ( ! $es_doc ) { | |
| 1036 | + $status = [ | |
| 1037 | + 'status' => 'error', | |
| 1038 | + 'message' => esc_html__( 'Sync required', 'elasticpress' ), | |
| 1039 | + 'explanation' => esc_html__( 'Content not found in Elasticsearch.', 'elasticpress' ), | |
| 1040 | + ]; | |
| 1041 | + } else { | |
| 1042 | + $post = get_post( $post_id ); | |
| 1043 | + if ( $post->post_modified_gmt !== $es_doc['post_modified_gmt'] ) { | |
| 1044 | + $status = [ | |
| 1045 | + 'status' => 'warning', | |
| 1046 | + 'message' => esc_html__( 'Out of sync', 'elasticpress' ), | |
| 1047 | + 'explanation' => esc_html__( 'WordPress and Elasticsearch content are out of sync.', 'elasticpress' ), | |
| 1048 | + ]; | |
| 1049 | + } | |
| 1050 | + } | |
| 1051 | + | |
| 1052 | + /** | |
| 1053 | + * Filter the document status array. | |
| 1054 | + * | |
| 1055 | + * @since 5.2.0 | |
| 1056 | + * @hook ep_doc_status | |
| 1057 | + * @param array $status The status array containing status, message and explanation | |
| 1058 | + * @param int $post_id The post ID being checked | |
| 1059 | + * @param array $es_doc The Elasticsearch document | |
| 1060 | + */ | |
| 1061 | + return (array) apply_filters( 'ep_doc_status', $status, $post_id, $es_doc ); | |
| 1062 | + } | |
| 1063 | + | |
| 1064 | + /** | |
| 1065 | + * Format the document status for the admin bar. | |
| 1066 | + * | |
| 1067 | + * @since 5.2.0 | |
| 1068 | + * @deprecated 5.3.0 | |
| 1069 | + * @param array $document_status Document status | |
| 1070 | + * @return string | |
| 1071 | + */ | |
| 1072 | + protected function format_doc_status( array $document_status ): string { | |
| 1073 | + $status_indicator = '<span class="ep-status-indicator ep-status-indicator--' . ( $document_status['status'] ?? '' ) . '"></span>'; | |
| 1074 | + | |
| 1075 | + $message = sprintf( | |
| 1076 | + // translators: 1: EP prefix 2: Document status message | |
| 1077 | + _x( '[%1$s] %2$s', 'Doc status message', 'elasticpress' ), | |
| 1078 | + 'EP', | |
| 1079 | + $document_status['message'] | |
| 1080 | + ); | |
| 1081 | + | |
| 1082 | + /** | |
| 1083 | + * Filter the formatted document status. | |
| 1084 | + * | |
| 1085 | + * @since 5.2.0 | |
| 1086 | + * @deprecated 5.3.0 | |
| 1087 | + * @hook ep_formatted_doc_status | |
| 1088 | + * @param string $formatted_status The formatted status | |
| 1089 | + * @param array $document_status The document status | |
| 1090 | + * @param string $status_indicator The status indicator | |
| 1091 | + * @param string $message The message | |
| 1092 | + */ | |
| 1093 | + return (string) apply_filters_deprecated( | |
| 1094 | + 'ep_formatted_doc_status', | |
| 1095 | + [ $status_indicator . $message, $document_status, $status_indicator, $message ], | |
| 1096 | + 'ElasticPress 5.3.0', | |
| 1097 | + 'ep_admin_bar_status_and_summary' | |
| 1098 | + ); | |
| 1099 | + } | |
| 1100 | + | |
| 1101 | + /** | |
| 1102 | + * If a password is added to an existent post, delete it from the index. | |
| 1103 | + * | |
| 1104 | + * @since 5.2.0 | |
| 1105 | + * @param int $post_id The post ID | |
| 1106 | + * @param \WP_Post $post_after The post object after the update | |
| 1107 | + * @param \WP_Post $post_before The post object before the update | |
| 1108 | + * @return void | |
| 1109 | + */ | |
| 1110 | + public function delete_post_with_new_password( $post_id, $post_after, $post_before ) { | |
| 1111 | + if ( ! $post_before->post_password && $post_after->post_password ) { | |
| 1112 | + Indexables::factory()->get( $this->indexable_slug )->delete( $post_id, false ); | |
| 1113 | + } | |
| 656 | 1114 | } |
| 657 | 1115 | } |
