Build XML Sitemaps with indexables

admin/class-admin-user-profile.php

@@ -19,23 +19,6 @@ public function __construct() {
 		add_action( 'edit_user_profile', [ $this, 'user_profile' ] );
 		add_action( 'personal_options_update', [ $this, 'process_user_option_update' ] );
 		add_action( 'edit_user_profile_update', [ $this, 'process_user_option_update' ] );
-
-		add_action( 'update_user_meta', [ $this, 'clear_author_sitemap_cache' ], 10, 3 );
-	}
-
-	/**
-	 * Clear author sitemap cache when settings are changed.
-	 *
-	 * @since 3.1
-	 *
-	 * @param int    $meta_id   The ID of the meta option changed.
-	 * @param int    $object_id The ID of the user.
-	 * @param string $meta_key  The key of the meta field changed.
-	 */
-	public function clear_author_sitemap_cache( $meta_id, $object_id, $meta_key ) {
-		if ( $meta_key === '_yoast_wpseo_profile_updated' ) {
-			WPSEO_Sitemaps_Cache::clear( [ 'author' ] );
-		}
 	}
 
 	/**

admin/class-admin.php

@@ -70,9 +70,6 @@ public function __construct() {
 
 		add_action( 'admin_init', [ $this, 'map_manage_options_cap' ] );
 
-		WPSEO_Sitemaps_Cache::register_clear_on_option_update( 'wpseo' );
-		WPSEO_Sitemaps_Cache::register_clear_on_option_update( 'home' );
-
 		if ( YoastSEO()->helpers->current_page->is_yoast_seo_page() ) {
 			add_action( 'admin_enqueue_scripts', [ $this, 'enqueue_assets' ] );
 		}

composer.json

@@ -78,8 +78,8 @@
 			"Yoast\\WP\\SEO\\Composer\\Actions::check_coding_standards"
 		],
 		"check-cs-thresholds": [
-			"@putenv YOASTCS_THRESHOLD_ERRORS=253",
-			"@putenv YOASTCS_THRESHOLD_WARNINGS=220",
+			"@putenv YOASTCS_THRESHOLD_ERRORS=244",
+			"@putenv YOASTCS_THRESHOLD_WARNINGS=198",
 			"Yoast\\WP\\SEO\\Composer\\Actions::check_cs_thresholds"
 		],
 		"check-cs": [

inc/class-upgrade.php

@@ -144,9 +144,6 @@ protected function finish_up( $previous_version = null ) {
 		// Just flush rewrites, always, to at least make them work after an upgrade.
 		add_action( 'shutdown', 'flush_rewrite_rules' );
 
-		// Flush the sitemap cache.
-		WPSEO_Sitemaps_Cache::clear();
-
 		// Make sure all our options always exist - issue #1245.
 		WPSEO_Options::ensure_options_exist();
 	}
@@ -570,9 +567,6 @@ private function upgrade_772() {
 	private function upgrade_90() {
 		global $wpdb;
 
-		// Invalidate all sitemap cache transients.
-		WPSEO_Sitemaps_Cache_Validator::cleanup_database();
-
 		// Removes all scheduled tasks for hitting the sitemap index.
 		wp_clear_scheduled_hook( 'wpseo_hit_sitemap_index' );
 

inc/sitemaps/abstract-class-indexable-sitemap-provider.php

@@ -0,0 +1,133 @@
+<?php
+/**
+ * WPSEO plugin file.
+ *
+ * @package WPSEO\XML_Sitemaps
+ */
+
+use Yoast\WP\Lib\Model;
+
+/**
+ * WPSEO_Indexable_Sitemap_Provider abstract class
+ */
+abstract class WPSEO_Indexable_Sitemap_Provider implements WPSEO_Sitemap_Provider {
+
+	/**
+	 * The indexable repository.
+	 *
+	 * @var Indexable_Repository
+	 */
+	private $repository;
+
+	/**
+	 * The XML sitemap helper.
+	 *
+	 * @var XML_Sitemap_Helper
+	 */
+	private $xml_sitemap_helper;
+
+	/**
+	 * Set up object properties for data reuse.
+	 */
+	public function __construct() {
+		$this->repository         = YoastSEO()->classes->get( Indexable_Repository::class );
+		$this->xml_sitemap_helper = YoastSEO()->helpers->xml_sitemap;
+	}
+
+	/**
+	 * Retrieves the links for the sitemap.
+	 *
+	 * @param int $max_entries Entries per sitemap.
+	 *
+	 * @return array
+	 */
+	public function get_index_links( $max_entries ) {
+		global $wpdb;
+
+		$query = $this->repository
+			->query_where_noindex( false, $this->get_object_type() )
+			->select( 'id' )
+			->where( 'is_publicly_viewable', true )
+			->order_by_asc( 'object_sub_type' )
+			->order_by_asc( 'object_last_modified' );
+
+		$excluded_object_ids = $this->get_excluded_object_ids();
+		if ( count( $excluded_object_ids ) > 0 ) {
+			$query->where_not_in( 'object_id', $excluded_object_ids );
+		}
+
+		$table_name = Model::get_table_name( 'Indexable' );
+        // phpcs:ignore WordPress.DB.PreparedSQL.NotPrepared -- Query is prepared by our ORM.
+		$raw_query = $wpdb->prepare( $query->get_sql(), $query->get_values() );
+
+        // phpcs:ignore WordPress.DB.DirectDatabaseQuery.DirectQuery -- Complex query is not possible without a direct query.
+		$last_object_per_page = $wpdb->get_results(
+            // phpcs:disable WordPress.DB.PreparedSQL.InterpolatedNotPrepared -- Variables are secure.
+			$wpdb->prepare(
+				// This query pulls only every Nth last_modified from the database, resetting row counts when the sub type changes.
+				"
+					SELECT i.object_sub_type, i.object_last_modified
+					FROM $table_name AS i
+					INNER JOIN (
+						SELECT id
+						FROM (
+							SELECT IF( @previous_sub_type = object_sub_type, @row:=@row+1, @row:=0) AS rownum, @previous_sub_type:=object_sub_type AS previous_sub_type, id
+							FROM ( $raw_query ) AS sorted, ( SELECT @row:=-1, @previous_sub_type:=null ) AS init
+						) AS ranked
+						WHERE rownum MOD %d = 0
+					) AS subset
+					ON subset.id = i.id
+				",
+				$max_entries
+			)
+            // phpcs:enable
+		);
+
+		$index = [];
+		$page  = 1;
+		foreach ( $last_object_per_page as $index => $object ) {
+			if ( $this->should_exclude_object_sub_type( $object->object_sub_type ) ) {
+				continue;
+			}
+
+			$next_object_is_not_same_sub_type = ! ( isset( $last_object_per_page[ ( $index + 1 ) ] ) && $last_object_per_page[ ( $index + 1 ) ] === $object->object_sub_type );
+			if ( $page === 1 && $next_object_is_not_same_sub_type ) {
+				$page = '';
+			}
+
+			$index[] = [
+				'loc'     => WPSEO_Sitemaps_Router::get_base_url( $object->object_sub_type . '-sitemap' . $page . '.xml' ),
+				'lastmod' => $object->object_last_modified,
+			];
+
+			if ( $next_object_is_not_same_sub_type ) {
+				$page = 1;
+			}
+		}
+
+		return $index;
+	}
+
+	/**
+	 * Returns the object type for this sitemap.
+	 *
+	 * @return string The object type.
+	 */
+	abstract protected function get_object_type();
+
+	/**
+	 * Returns a list of all object IDs that should be excluded.
+	 *
+	 * @return int[]
+	 */
+	abstract protected function get_excluded_object_ids();
+
+	/**
+	 * Whether or not a specific object sub type should be excluded.
+	 *
+	 * @param string $object_sub_type The object sub type.
+	 *
+	 * @return boolean Whether or not it should be excluded.
+	 */
+	abstract protected function should_exclude_object_sub_type( $object_sub_type );
+}