Fix: Uninstall distributor

.gitignore

@@ -17,3 +17,5 @@ tests/cypress/reports
 tests/cypress/downloads
 
 distributor.zip
+
+.github/phpcs-report.xml

includes/bootstrap.php

@@ -12,6 +12,7 @@
 
 namespace Distributor;
 
+use WP_Screen;
 use YahnisElsts\PluginUpdateChecker\v5\PucFactory;
 
 /**
@@ -216,6 +217,75 @@ function() {
 	1
 );
 
+
+/**
+ * Add a deactivation modal when deactivating the plugin.
+ *
+ * @since x.x.x
+ */
+function register_deactivation_modal() {
+	// Exit if deactivating plugin from sub site.
+	$screen = get_current_screen();
+	if ( ! ( ! is_multisite() || $screen->in_admin( 'network' ) ) ) {
+		return;
+	}
+
+	wp_enqueue_script( 'jquery-ui-dialog' );
+	wp_enqueue_style( 'wp-jquery-ui-dialog' );
+
+	add_action(
+		'admin_footer',
+		static function () {
+			printf(
+				'<div id="my-modal" style="display:none;"><p>%1$s</p><p>%2$s</p><p><code>%3$s</code></p><p>%4$s</p></div>',
+				esc_html__( 'Would you like to delete all Distributor data?', 'distributor' ),
+				esc_html__( 'By default, the database entries are not deleted when you deactivate Distributor. If you are deleting Distributor completely from your website and want those items removed as well, add the code below to wp-config.php:', 'distributor' ),
+				'define( \'DT_REMOVE_ALL_DATA\', true );',
+				esc_html__( 'After adding this code, the Distributor plugin data will be removed from the website database when deleting the plugin. This will not delete the posts with their metadata other than the subscription. You can review uninstall.php (in the plugin root directory) to learn more about the deleted data. After deleting the Distributor plugin, you can remove the code from the wp-config.php file. Please make sure that this action cannot be undone; take a backup before proceeding.', 'distributor' )
+			);
+		}
+	);
+
+	$modal_title                   = wp_json_encode( __( 'Distributor Deactivation', 'distributor' ) );
+	$modal_button_title_deactivate = wp_json_encode( __( 'Deactivate', 'distributor' ) );
+	$modal_button_title_cancel     = wp_json_encode( __( 'Cancel', 'distributor' ) );
+	$script                        = <<<EOD
+			jQuery(document).ready(function($) {
+				const deactivateButton = jQuery('#deactivate-distributor');
+				deactivateButton.on( 'click', function() {
+					$("#my-modal").dialog({
+						modal: true,
+						title: $modal_title,
+						width: 550,
+						buttons: [
+							{
+								text: $modal_button_title_cancel,
+								class: "button-secondary",
+								click: function() {
+									$(this).dialog("close");
+								}
+							},
+							{
+								text:$modal_button_title_deactivate,
+								class: 'button-primary',
+								click: function() {
+									$(this).dialog("close");
+									window.location.assign(deactivateButton.attr('href'));
+								},
+								style: 'margin-left: 10px;'
+							}
+						]
+					});
+
+					return false;
+				});
+			});
+EOD;
+
+	wp_add_inline_script( 'jquery-ui-dialog', $script );
+}
+add_action( 'load-plugins.php', __NAMESPACE__ . '\register_deactivation_modal' );
+
 /**
  * We use setup functions to avoid unit testing WP_Mock strict mode errors.
  */

includes/classes/InternalConnections/NetworkSiteConnection.php

@@ -861,7 +861,7 @@ public static function build_available_authorized_sites( $user_id = false, $cont
 			$last_changed = self::set_sites_last_changed_time();
 		}
 
-		$cache_key        = "authorized_sites:$user_id:$context:$last_changed";
+		$cache_key        = "dt_authorized_sites:$user_id:$context:$last_changed";
 		$authorized_sites = get_transient( $cache_key );
 
 		if ( $force || false === $authorized_sites ) {

uninstall.php

 } ), 
 	patterns: [ 
 		{ from: 'readme.txt', to: './' }, 
 		{ from: 'README.md', to: './' }, 
 		{ from: 'CHANGELOG.md', to: './' }, 
 		{ from: 'composer.json', to: './' }, 
 		{ from: 'distributor.php', to: './' }, 
 		{ from: '.github/workflows/*', to: './' }, 
 		{ from: '.gitattributes', to: './' }, 
 		{ from: 'assets/img/*', to: './' }, 
 		{ from: 'dist/**/*', to: './' }, 
 		{ from: 'includes/**/*', to: './' }, 
 		{ from: 'lang/**/*', to: './' }, 
 		{ from: 'templates/**/*', to: './' }, 
 		{ 
 			from: 'vendor/yahnis-elsts/plugin-update-checker/**/*', 
 			to: './', 
 		}, 
 	], 
 } ), 
@@ -0,0 +1,205 @@
+<?php
+/**
+ * Distributor uninstall script.
+ *
+ * @package distributor
+ * @since   x.x.x
+ */
+
+ // phpcs:disable WordPress.DB.DirectDatabaseQuery, WordPress.DB.PreparedSQL.NotPrepared, WordPress.DB.PreparedSQL.InterpolatedNotPrepared, WordPress.DB.PreparedSQLPlaceholders.ReplacementsWrongNumber
+
+if ( ! defined( 'WP_UNINSTALL_PLUGIN' ) ) {
+	die;
+}
+
+/*
+ * Only remove ALL data if DT_REMOVE_ALL_DATA constant is set to true in user's
+ * wp-config.php. This is to prevent data loss when deleting the plugin from the backend
+ * and to ensure only the site owner can perform this action.
+ */
+if ( defined( 'DT_REMOVE_ALL_DATA' ) && true === DT_REMOVE_ALL_DATA ) {
+	global $wpdb;
+
+	/**
+	 * Function to delete all relevant data from the site.
+	 */
+	function dt_delete_data() {
+		global $wpdb;
+
+		// Delete post meta and posts of type 'dt_subscription'.
+		$subscription_post_ids = $wpdb->get_col(
+			$wpdb->prepare(
+				"SELECT ID FROM $wpdb->posts WHERE post_type = %s",
+				'dt_subscription'
+			)
+		);
+
+		if ( ! empty( $subscription_post_ids ) ) {
+			$ids_string = implode( ',', array_map( 'intval', $subscription_post_ids ) );
+
+			// Delete subscription meta.
+			$wpdb->query(
+				"DELETE FROM $wpdb->postmeta WHERE post_id IN ($ids_string)"
+			);
+
+			// Delete subscription posts.
+			$wpdb->query(
+				$wpdb->prepare(
+					"DELETE FROM $wpdb->posts WHERE ID IN (%s)",
+					$ids_string
+				)
+			);
+
+			// Clear the post cache.
+			wp_cache_set_posts_last_changed();
+			wp_cache_delete_multiple( $subscription_post_ids, 'posts' );
+			wp_cache_delete_multiple( $subscription_post_ids, 'post_meta' );
+		}
+
+		// Delete relevant options from the options table.
+		delete_site_options();
+	}
+
+	/**
+	 * Delete all relevant options from the options table.
+	 */
+	function delete_site_options() {
+		global $wpdb;
+
+		$option_prefixes = array(
+			'dt_',
+			'_transient_dt_',
+			'_transient_timeout_dt_',
+		);
+
+		// Site transients can be used on single sites too.
+		// See https://github.com/10up/distributor/pull/540#discussion_r1759587692
+		if ( ! is_multisite() ) {
+			$option_prefixes = array_merge(
+				$option_prefixes,
+				array(
+					'_site_transient_dt_',
+					'_site_transient_timeout_dt_',
+				)
+			);
+		}
+
+		// Prepare the WHERE clause for the options table.
+		$where_clause = implode( ' OR ', array_fill( 0, count( $option_prefixes ), 'option_name LIKE %s' ) );
+
+		// Prepare the query.
+		$query = $wpdb->prepare(
+			sprintf(
+				"SELECT option_id, option_name FROM $wpdb->options WHERE %s;",
+				$where_clause
+			),
+			array_map(
+				function( $prefix ) use ( $wpdb ) {
+					return $wpdb->esc_like( $prefix ) . '%';
+				},
+				$option_prefixes 
+			)
+		);
+
+		// Fetch the options to delete.
+		$options_to_delete = $wpdb->get_results( $query, ARRAY_A );
+
+		if ( ! empty( $options_to_delete ) ) {
+			// Collect IDs from fetched options.
+			$ids        = array_column( $options_to_delete, 'option_id' );
+			$ids_string = implode( ',', array_map( 'intval', $ids ) );
+
+			// Delete the options using the retrieved IDs.
+			$wpdb->query(
+				$wpdb->prepare(
+					"DELETE FROM $wpdb->options WHERE option_id IN ($ids_string)"
+				)
+			);
+
+			// Flush the options cache.
+			$option_names = array_column( $options_to_delete, 'option_name' );
+			wp_cache_delete_multiple( $option_names, 'options' );
+
+			// Flush the alloptions cache.
+			wp_cache_delete( 'alloptions', 'options' );
+		}
+	}
+
+	/**
+	 * Delete all relevant options from the sitemeta table (multisite only).
+	 */
+	function delete_sitemeta_options() {
+		global $wpdb;
+
+		$option_prefixes = array(
+			'dt_',
+			'_site_transient_dt_',
+			'_site_transient_timeout_dt_',
+		);
+
+		// Prepare the WHERE clause for the sitemeta table.
+		$where_clause = implode( ' OR ', array_fill( 0, count( $option_prefixes ), 'meta_key LIKE %s' ) );
+
+		$site_id = get_current_network_id();
+
+		$query = $wpdb->prepare(
+			sprintf(
+				"SELECT meta_id, meta_key FROM $wpdb->sitemeta WHERE site_id = %%d AND (%s);",
+				$where_clause
+			),
+			array_merge(
+				[ $site_id ],
+				array_map(
+					function( $prefix ) use ( $wpdb ) {
+						return $wpdb->esc_like( $prefix ) . '%';
+					},
+					$option_prefixes 
+				) 
+			)
+		);
+
+		// Fetch the sitemeta to delete.
+		$sitemeta_to_delete = $wpdb->get_results( $query, ARRAY_A );
+
+		if ( ! empty( $sitemeta_to_delete ) ) {
+			// Collect IDs from fetched options.
+			$ids        = array_column( $sitemeta_to_delete, 'meta_id' );
+			$ids_string = implode( ',', array_map( 'intval', $ids ) );
+
+			// Delete the sitemeta using the retrieved IDs.
+			$wpdb->query(
+				$wpdb->prepare(
+					"DELETE FROM $wpdb->sitemeta WHERE meta_id IN ($ids_string)"
+				)
+			);
+
+			// Flush the site options cache.
+			$key_names = array_column( $sitemeta_to_delete, 'meta_key' );
+			$key_names = array_map(
+				function( $key ) use ( $site_id ) {
+					return $site_id . ':' . $key;
+				},
+				$key_names 
+			);
+			wp_cache_delete_multiple( $key_names, 'site-options' );
+		}
+	}
+
+	// Check if it's a multisite installation.
+	if ( is_multisite() ) {
+		// Loop through each site in the network.
+		$sites = get_sites();
+		foreach ( $sites as $site ) {
+			switch_to_blog( $site->blog_id );
+			dt_delete_data();
+			restore_current_blog();
+		}
+
+		// Delete network-wide sitemeta options.
+		delete_sitemeta_options();
+	} else {
+		// Single site.
+		dt_delete_data();
+	}
+}
+