<?php
/**
* Forminator Page Cache
*
* @package Forminator
*/
if ( ! defined( 'ABSPATH' ) ) {
die();
}
/**
* Class Forminator_Page_Cache
*
* Forminator Page cache buster
*
* @since 1.6.1
*/
class Forminator_Page_Cache {
/**
* Instance
*
* @var self|null
*/
private static $instance = null;
/**
* Get Instance
*
* @return Forminator_Page_Cache|null
*/
public static function get_instance() {
if ( empty( self::$instance ) ) {
self::$instance = new self();
}
return self::$instance;
}
/**
* Forminator_Page_Cache constructor
*/
public function __construct() {
add_action( 'clean_post_cache', array( $this, 'on_clean_post_cache' ), 99, 2 );
// publish action triggered by this.
add_action( 'transition_post_status', array( $this, 'on_transition_post_status' ), 99, 3 );
}
/**
* Fired when `clean_post_cache` action
*
* @param int $post_id Post ID.
* @param WP_Post $post WP Post.
*/
public function on_clean_post_cache( $post_id, $post ) {
forminator_maybe_log( __METHOD__, $post_id );
$this->execute_page_caches( $post_id, $post );
}
/**
* Fired when `transition_post_status` action
*
* @param string $new_status New status.
* @param string $old_status Old status.
* @param WP_Post $post WP Post.
*/
public function on_transition_post_status( $new_status, $old_status, $post ) {
// no status changed.
if ( $new_status === $old_status ) {
return;
}
$post_id = null;
if ( $post instanceof WP_Post ) {
$post_id = $post->ID;
forminator_maybe_log( __METHOD__, $post_id );
}
$this->execute_page_caches( $post_id, $post );
}
/**
* Main logic on how to handle page caches busting
*
* @param int $post_id Post ID.
* @param WP_Post $post WP Post.
*/
public function execute_page_caches( $post_id, $post ) {
// Get fresh post.
$wp_post = get_post( $post_id );
// This is deleted / invalid post.
if ( ! $wp_post instanceof WP_Post ) {
$this->remove_forminator_module_from_posts_map( $post_id );
$this->remove_post_from_posts_map( $post_id );
return;
}
if ( 'auto-draft' === $wp_post->post_status ) {
return;
}
if ( 'revision' === $wp_post->post_type ) {
return;
}
$forminator_post_types = $this->get_forminator_post_types();
if ( in_array( $post->post_type, $forminator_post_types, true ) ) {
$this->maybe_bust_cache_posts( $post_id );
} else {
$this->maybe_update_posts_map_option( $post_id, $post );
}
}
/**
* Get internal forminator post types
*
* @return array
*/
public function get_forminator_post_types() {
$post_types = array(
Forminator_Form_Model::model()->get_post_type(),
Forminator_Poll_Model::model()->get_post_type(),
Forminator_Quiz_Model::model()->get_post_type(),
);
/**
* Filter forminator post types that used as reference on page cache buster
*
* @since 1.6
*
* @param array $post_types
*
* @return array
*/
$post_types = apply_filters( 'forminator_page_cache_get_forminator_post_types', $post_types );
return $post_types;
}
/**
* Bust cache of post which have forminator inside it
*
* @param int $post_id Post Id.
*/
public function maybe_bust_cache_posts( $post_id ) {
forminator_maybe_log( __METHOD__, $post_id );
$module_id = (int) $post_id;
$option = get_option( 'forminator_posts_map', array() );
$to_bust_cache_post_ids = isset( $option[ $module_id ] ) ? $option[ $module_id ] : array();
foreach ( $to_bust_cache_post_ids as $to_bust_cache_post_id ) {
$this->bust_cache_post( $to_bust_cache_post_id );
}
}
/**
* Update posts map
*
* @param int $post_id Post ID.
* @param WP_Post $post WP Post.
*/
public function maybe_update_posts_map_option( $post_id, $post ) {
forminator_maybe_log( __METHOD__, $post_id );
$posts_map_option = get_option( 'forminator_posts_map', array() );
$post_id = (int) $post_id;
$content = $post->post_content;
if ( has_shortcode( $content, 'forminator_form' )
|| has_shortcode( $content, 'forminator_poll' )
|| has_shortcode( $content, 'forminator_quiz' )
) {
$module_ids = array();
$shortcode_regex = get_shortcode_regex( array( 'forminator_form', 'forminator_poll', 'forminator_quiz' ) );
preg_match_all( '/' . $shortcode_regex . '/', $content, $matches, PREG_SET_ORDER );
if ( empty( $matches ) ) {
return;
}
foreach ( $matches as $match ) {
$shortcode_attr_text = isset( $match[3] ) ? $match[3] : '';
if ( empty( $shortcode_attr_text ) ) {
continue;
}
$attr = shortcode_parse_atts( $shortcode_attr_text );
if ( isset( $attr['id'] ) ) {
$module_ids[] = (int) $attr['id'];
}
}
$module_ids = array_unique( $module_ids, SORT_NUMERIC );
// Add.
foreach ( $module_ids as $module_id ) {
$module_id = (int) $module_id;
if ( ! isset( $posts_map_option[ $module_id ] ) ) {
$posts_map_option[ $module_id ] = array();
}
$module_posts_map = $posts_map_option[ $module_id ];
if ( ! in_array( $post_id, $module_posts_map, true ) ) {
$module_posts_map[] = $post_id;
sort( $module_posts_map );
$posts_map_option[ $module_id ] = $module_posts_map;
}
}
// Cleanup.
foreach ( $posts_map_option as $module_id => $saved_post_ids ) {
foreach ( $saved_post_ids as $saved_post_id ) {
if ( $post_id === $saved_post_id ) {
$saved_module_id = (int) $module_id;
// this post does not have `saved_module_id` anymore.
if ( ! in_array( $saved_module_id, $module_ids, true ) ) {
$post_ids = array_diff( $saved_post_ids, array( $post_id ) );
sort( $post_ids );
if ( empty( $post_ids ) ) {
unset( $posts_map_option[ $module_id ] );
} else {
$posts_map_option[ $module_id ] = $post_ids;
}
}
}
}
}
} else {
// Cleanup.
foreach ( $posts_map_option as $module_id => $saved_post_ids ) {
foreach ( $saved_post_ids as $saved_post_id ) {
if ( $post_id === $saved_post_id ) {
// this post does not have `forminator` anymore.
$post_ids = array_diff( $saved_post_ids, array( $post_id ) );
sort( $post_ids );
if ( empty( $post_ids ) ) {
unset( $posts_map_option[ $module_id ] );
} else {
$posts_map_option[ $module_id ] = $post_ids;
}
}
}
}
}
update_option( 'forminator_posts_map', $posts_map_option );
}
/**
* Remove forminator module from posts_map
*
* @param int $module_id Module Id.
*/
public function remove_forminator_module_from_posts_map( $module_id ) {
$module_id = (int) $module_id;
$option = get_option( 'forminator_posts_map', array() );
if ( isset( $option[ $module_id ] ) ) {
if ( is_array( $option[ $module_id ] ) ) {
$to_bust_cache_post_ids = $option[ $module_id ];
foreach ( $to_bust_cache_post_ids as $to_bust_cache_post_id ) {
$this->bust_cache_post( $to_bust_cache_post_id );
}
}
}
unset( $option[ $module_id ] );
update_option( 'forminator_posts_map', $option );
}
/**
* Remove post from posts map
*
* @param int $post_id_to_remove Post ID.
*/
public function remove_post_from_posts_map( $post_id_to_remove ) {
$post_id_to_remove = (int) $post_id_to_remove;
$option = get_option( 'forminator_posts_map', array() );
foreach ( $option as $module_id => $post_ids ) {
if ( in_array( $post_id_to_remove, $post_ids, true ) ) {
$post_ids = array_diff( $post_ids, array( $post_id_to_remove ) );
sort( $post_ids );
if ( empty( $post_ids ) ) {
unset( $option[ $module_id ] );
} else {
$option[ $module_id ] = $post_ids;
}
}
}
update_option( 'forminator_posts_map', $option );
}
/**
* Bust cache
*
* @param int $to_bust_cache_post_id Post ID.
*/
public function bust_cache_post( $to_bust_cache_post_id ) {
if ( function_exists( 'clean_post_cache' ) ) {
forminator_maybe_log( 'clean_post_cache exists' );
// w3-total-cache use `clean_post_cache`.
clean_post_cache( $to_bust_cache_post_id );
}
// hummingbird.
do_action( 'wphb_clear_page_cache', $to_bust_cache_post_id );
}
}
// Init.
Forminator_Page_Cache::get_instance();