dedicated-transients.php

<?php

/*
 * Plugin Name: Dedicated Transients
 * Plugin URI: https://github.com/pcfreak30/dedicated-transients
 * Description: WordPress plugin to re-route transient storage to dedicated tables
 * Version: 0.1.10
 * Author: Derrick Hammer
 * Author URI: https://www.derrickhammer.com
 * License:  GPL3
 * */

require_once __DIR__ . '/constants.php';

register_activation_hook( __FILE__, 'dedicated_transients_activate' );
register_deactivation_hook( __FILE__, 'dedicated_transients_deactivate' );
register_uninstall_hook( __FILE__, 'dedicated_transients_uninstall' );

// Deactivate object cache is active
dedicated_transients_check_object_cache();


/**
 * Activate only if object cache is not active
 *
 * @param bool $network_wide
 */
function dedicated_transients_activate( $network_wide ) {
	if ( dedicated_transients_check_object_cache() ) {
		return;
	}
	$source     = __DIR__ . DIRECTORY_SEPARATOR . DEDICATED_TRANSIENTS_WPMU_DROPIN;
	$target     = WPMU_PLUGIN_DIR . DIRECTORY_SEPARATOR . DEDICATED_TRANSIENTS_WPMU_DROPIN;
	$filesystem = dedicated_transients_wp_filesystem();
	if ( ! $filesystem->is_dir( WPMU_PLUGIN_DIR ) ) {
		$filesystem->mkdir( WPMU_PLUGIN_DIR );
	}
	if ( ! ( $filesystem->is_file( $target ) && md5_file( $source ) === md5_file( $target ) ) ) {
		$filesystem->copy( $source, $target, true );
	}
	dedicated_transients_install_tables( $network_wide );
	dedicated_transients_install_purge( $network_wide );
}

/**
 *
 */
function dedicated_transients_install_purge( $network_wide ) {
	dedicated_transients_delete_expired_options_transients();
	if ( is_multisite() && $network_wide ) {
		$sites = get_sites( array( 'fields' => 'ids' ) );
		if ( 1 < count( $sites ) ) {
			foreach ( $sites as $blog_id ) {
				switch_to_blog( $blog_id );
				dedicated_transients_delete_expired_options_transients();
				restore_current_blog();
			}
		}
	}
}

/**
 *
 */
function dedicated_transients_deactivate() {
	$source     = __DIR__ . DIRECTORY_SEPARATOR . DEDICATED_TRANSIENTS_WPMU_DROPIN;
	$target     = WPMU_PLUGIN_DIR . DIRECTORY_SEPARATOR . DEDICATED_TRANSIENTS_WPMU_DROPIN;
	$filesystem = dedicated_transients_wp_filesystem();
	if ( $filesystem->is_file( $target ) && md5_file( $source ) === md5_file( $target ) ) {
		$filesystem->delete( $target );
	}
}

/**
 *
 */
function dedicated_transients_uninstall() {
	global $wpdb;
	$wpdb->query( "DROP TABLE IF EXISTS {$wpdb->base_prefix}" . DEDICATED_TRANSIENTS_TABLE );
	if ( is_multisite() ) {
		$wpdb->query( "DROP TABLE IF EXISTS {$wpdb->base_prefix}" . DEDICATED_TRANSIENTS_WPMU_TABLE );
	}
}

/**
 * @return bool
 */
function dedicated_transients_check_object_cache() {
	if ( wp_using_ext_object_cache() ) {
		require_once ABSPATH . '/wp-admin/includes/plugin.php';
		add_action( 'admin_notices', 'dedicated_transients_object_cache_error' );
		deactivate_plugins( __FILE__, false, true );

		return true;
	}

	return false;
}


/**
 *
 */
function dedicated_transients_object_cache_error() {
	$info = get_plugin_data( __FILE__ );
	_e( sprintf( '
	<div class="error notice">
		<p>Opps! %s can not be active when Object Cache is in use! Object Cache is also considered superior than this plugin.</p>
	</div>', $info['Name'] ) );
}

/**
 * @return \WP_Filesystem_Base
 */
function dedicated_transients_wp_filesystem() {
	/** @var \WP_Filesystem_Direct $wp_filesystem */
	static $wp_filesystem = null;
	if ( null === $wp_filesystem ) {
		require_once ABSPATH . 'wp-admin/includes/class-wp-filesystem-base.php';
		require_once ABSPATH . 'wp-admin/includes/class-wp-filesystem-direct.php';
		$wp_filesystem = new WP_Filesystem_Direct( null );
	}

	return $wp_filesystem;
}

/**
 *
 */
function dedicated_transients_install_tables( $network_wide ) {
	/*
	 * Copied schema from ./wp-admin/includes/schema.php
	 */
	global $wpdb;
	$charset_collate = $wpdb->get_charset_collate();
	require_once ABSPATH . 'wp-admin/includes/upgrade.php';
	if ( ! is_multisite() || ! $network_wide ) {
		dedicated_transients_install_tables_single_site();
	}
	if ( is_multisite() && $network_wide ) {
		$max_index_length = 191;
		dbDelta( "CREATE TABLE {$wpdb->base_prefix}" . DEDICATED_TRANSIENTS_WPMU_TABLE . " (
  meta_id bigint(20) NOT NULL auto_increment,
  site_id bigint(20) NOT NULL default '0',
  meta_key varchar(255) default NULL,
  meta_value longtext,
  PRIMARY KEY  (meta_id),
  KEY meta_key (meta_key($max_index_length)),
  KEY site_id (site_id)
) $charset_collate;" );

		$sites = get_sites( array( 'fields' => 'ids' ) );
		foreach ( $sites as $blog_id ) {
			switch_to_blog( $blog_id );
			dedicated_transients_install_tables_single_site();
			restore_current_blog();
		}
	}
}

/**
 *
 */
function dedicated_transients_install_tables_single_site() {
	global $wpdb;
	$charset_collate = $wpdb->get_charset_collate();
	dbDelta( "CREATE TABLE {$wpdb->get_blog_prefix()}" . DEDICATED_TRANSIENTS_TABLE . " (
  option_id bigint(20) unsigned NOT NULL auto_increment,
  option_name varchar(191) NOT NULL default '',
  option_value longtext NOT NULL,
  autoload varchar(20) NOT NULL default 'yes',
  PRIMARY KEY  (option_id),
  UNIQUE KEY option_name (option_name)
) $charset_collate;" );
}

/**
 * @param i $blog_id
 */
function dedicated_transients_install_tables_new_blog( $blog_id ) {
	switch_to_blog( $blog_id );
	dedicated_transients_install_tables_single_site();
	restore_current_blog();
}

/**
 * @param array $tables
 * @param int   $blog_id
 *
 * @return array
 */
function dedicated_transients_mu_table( $tables, $blog_id ) {
	global $wpdb;
	$tables[] = $wpdb->get_blog_prefix( $blog_id ) . DEDICATED_TRANSIENTS_TABLE;

	return $tables;
}

/**
 * @param \WP_Admin_Bar $admin_bar
 */
function dedicated_transients_admin_bar( $admin_bar ) {
	if ( ! current_user_can( apply_filters( 'dedicated_transients_purge_capability', 'administrator' ) ) ) {
		return;
	}
	if ( is_multisite() ) {
		$admin_bar->add_menu( array(
			'id'    => 'dedicated-transients-menu',
			'title' => __( 'Dedicated Transients', 'dedicated-transients' ),
			'href'  => '#',
		) );
		$admin_bar->add_menu( array(
			'parent' => 'dedicated-transients-menu',
			'id'     => 'dedicated-transients-purge-mu',
			'title'  => __( 'Purge Network Wide', 'dedicated-transients' ),
			'href'   => wp_nonce_url( admin_url( 'admin-post.php?action=purge_dedicated_transients_multisite' ), 'purge_dedicated_transients_multisite' ),
		) );
		$admin_bar->add_menu( array(
			'parent' => 'dedicated-transients-menu',
			'id'     => 'dedicated-transients-purge',
			'title'  => sprintf( __( 'Purge site "%s" only', 'dedicated-transients' ), get_bloginfo( 'name' ) ),
			'href'   => wp_nonce_url( admin_url( 'admin-post.php?action=purge_dedicated_transients' ), 'purge_dedicated_transients' ),
		) );

		return;
	}
	$admin_bar->add_menu( array(
		'id'    => 'dedicated-transients-purge',
		'title' => __( 'Purge Dedicated Transients', 'dedicated-transients' ),
		'href'  => wp_nonce_url( admin_url( 'admin-post.php?action=purge_dedicated_transients' ), 'purge_dedicated_transients' ),
	) );
}

/**
 *
 */
function dedicated_transients_admin_purge() {
	if ( check_admin_referer( 'purge_dedicated_transients' ) ) {
		dedicated_transients_purge();
		wp_redirect( wp_get_referer() );
	}
}

/**
 *
 */
function dedicated_transients_admin_purge_multisite() {
	if ( check_admin_referer( 'purge_dedicated_transients_multisite' ) ) {
		$sites = get_sites( array( 'fields' => 'ids' ) );
		if ( 1 < count( $sites ) ) {
			dedicated_transients_purge_multisite();
		}

		foreach ( $sites as $blog_id ) {
			switch_to_blog( $blog_id );
			dedicated_transients_purge();
			restore_current_blog();
		}
		wp_redirect( wp_get_referer() );
	}
}

/**
 *
 */
function dedicated_transients_purge() {
	/** @var \wpdb $wpdb */
	global $wpdb;

	$wpdb->query( "TRUNCATE TABLE {$wpdb->get_blog_prefix()}" . DEDICATED_TRANSIENTS_TABLE );
}

function dedicated_transients_purge_multisite() {
	/** @var \wpdb $wpdb */
	global $wpdb;

	$wpdb->query( "TRUNCATE TABLE {$wpdb->base_prefix}" . DEDICATED_TRANSIENTS_WPMU_TABLE );
}

/**
 * Copied from wp-includes/option.php without timestamp condition
 *
 */
function dedicated_transients_delete_expired_options_transients() {
	global $wpdb;
	$wpdb->query( $wpdb->prepare(
		"DELETE FROM {$wpdb->options} WHERE option_name LIKE %s OR option_name LIKE %s",
		$wpdb->esc_like( '_transient_' ) . '%',
		$wpdb->esc_like( '_site_transient_' ) . '%'
	) );

	if ( is_multisite() && is_main_site() && is_main_network() ) {
		// Multisite stores site transients in the sitemeta table.
		$wpdb->query( $wpdb->prepare(
			"DELETE FROM {$wpdb->sitemeta} WHERE meta_key LIKE %s",
			$wpdb->esc_like( '_site_transient_' ) . '%'
		) );
	}
}

add_action( 'admin_bar_menu', 'dedicated_transients_admin_bar', 100 );
add_action( 'admin_post_purge_dedicated_transients', 'dedicated_transients_admin_purge' );
add_action( 'admin_post_purge_dedicated_transients_multisite', 'dedicated_transients_admin_purge_multisite' );


if ( is_multisite() ) {
	add_action( 'wpmu_new_blog', 'dedicated_transients_install_tables_new_blog' );
	add_filter( 'wpmu_drop_tables', 'dedicated_transients_mu_table', 10, 2 );
}