Current File : /home/dordingu/public_html/hardkjarni/wp-content/plugins/the-events-calendar/common/src/Tribe/Tracker.php
<?php
/**
* Class Tribe__Tracker
*
* Tracks changes of post attributes.
*/
class Tribe__Tracker {
/**
* @var string The meta field used to track changes.
*/
public static $field_key = '_tribe_modified_fields';
/**
* @var bool Whether the class is tracking terms or not.
*/
protected $track_terms = true;
/**
* @var array An array of the tracked post types.
*/
protected $tracked_post_types = [];
/**
* @var array An array of the tracked taxonomies.
*/
protected $tracked_taxonomies = [];
/**
* Hooks up the methods that will actually track the fields we are looking for.
*/
public function hook() {
// Track the Meta Updates for Meta That came from the correct Post Types
add_filter( 'update_post_metadata', [ $this, 'filter_watch_updated_meta' ], PHP_INT_MAX - 1, 5 );
// After a meta is added we mark that is has been modified
add_action( 'added_post_meta', [ $this, 'register_added_deleted_meta' ], PHP_INT_MAX - 1, 3 );
// Before a meta is removed we mark that is has been modified
add_action( 'delete_post_meta', [ $this, 'register_added_deleted_meta' ], PHP_INT_MAX - 1, 3 );
// Track the Post Fields Updates for Meta in the correct Post Types
add_action( 'post_updated', [ $this, 'filter_watch_post_fields' ], 10, 3 );
// Track the Post term updates
add_action( 'set_object_terms', [ $this, 'track_taxonomy_term_changes' ], 10, 6 );
// Clean up modified fields if the post is removed.
add_action( 'delete_post', [ $this, 'cleanup_meta_fields' ] );
}
/**
* Determines if a post value has been changed
*
* @param string $field Field to compare against
* @param array $new New data
* @param array $old WP_Post pre-update
*
* @return boolean
*/
public function has_field_changed( $field, $new, $old ) {
if ( ! is_object( $new ) ) {
$new = (object) $new;
}
if ( ! is_object( $old ) ) {
$old = (object) $old;
}
if ( ! isset( $new->$field ) ) {
return false;
}
if ( isset( $new->$field ) && ! isset( $old->$field ) ) {
return true;
}
if ( $new->$field !== $old->$field ) {
return true;
}
return false;
}
/**
* Get the date(timestamp) of last modification for a tracked field.
*
* @since 4.12.3
*
* @param string $meta_key The key for the meta field we're interested in.
* @param int $post_id The ID of the post to check.
*
* @return boolean|string The change timestamp or false if the field is not found/empty.
*/
public function get_modified_date( $meta_key, $post_id ) {
$modified = get_post_meta( $post_id, self::$field_key, true );
// If the key is missing or empty/null return false - no recorded change.
return Tribe__Utils__Array::get( $modified, $meta_key, false );
}
/**
* Easy way to see currently which post types are being tracked by our code.
*
* @return array
*/
public function get_post_types() {
// By default we are not tracking anything
$tracked_post_types = [];
/**
* Adds a way for Developers to add and remove which post types will be tracked
*
* Note: Removing any of the default methods will affect how we deal with fields
* affected by the authority settings defined on this installation
*
* @var array
*/
$tracked_post_types = (array) apply_filters( 'tribe_tracker_post_types', $this->tracked_post_types );
return $tracked_post_types;
}
/**
* Easy way to see currenlty which meta values are been tracked by our code
*
* @return array
*/
public function get_excluded_meta_keys() {
// By default we are not tracking anything
$excluded_keys = [
'_edit_lock',
self::$field_key,
];
/**
* Adds a way for Developers remove Meta Keys that shouldn't be tracked
*
* Note: Removing any of the default methods will affect how we deal with fields
* affected by the authority settings defined on this installation
*
* @var array
*/
$excluded_keys = (array) apply_filters( 'tribe_tracker_excluded_meta_keys', $excluded_keys );
return $excluded_keys;
}
/**
* Make sure we are tracking all meta fields related on the correct Post Types
*
* @since 4.5
*
* @param int $meta_id Meta ID
* @param int $post_id Post ID.
* @param string $meta_key Meta key.
*/
public function register_added_deleted_meta( $meta_id, $post_id, $meta_key ) {
/**
* Allows toggling the Modified fields tracking
* @var bool
*/
$is_tracking_modified_fields = (bool) apply_filters( 'tribe_tracker_enabled', true );
// Bail if we shouldn't be tracking modifications
if ( false === $is_tracking_modified_fields ) {
return;
}
// Try to fetch the post object
$post = get_post( $post_id );
// We only go forward if we have the Post Object
if ( ! $post instanceof WP_Post ) {
return;
}
// Fetch from a unified method which meta keys are been excluded
$excluded_keys = $this->get_excluded_meta_keys();
// Bail when this meta is set to be excluded
if ( in_array( $meta_key, $excluded_keys ) ) {
return;
}
// Fetch from a unified method which post types are been tracked
$tracked_post_types = $this->get_post_types();
// Only track if the meta is from a post that is been tracked
if ( ! in_array( $post->post_type, $tracked_post_types ) ) {
return;
}
// Gets the Current Timestamp
$now = current_time( 'timestamp' );
// Fetch the current data from the modified fields
$modified = get_post_meta( $post->ID, self::$field_key, true );
if ( ! is_array( $modified ) ) {
$modified = [];
}
// If we got here we will update the Modified Meta
$modified[ $meta_key ] = $now;
// Actually do the Update
update_post_meta( $post->ID, self::$field_key, $modified );
}
/**
* Make sure we are tracking all meta fields related to the correct Post Types
*
* @since 4.5
*
* @param null|bool $check Whether to allow updating metadata for the given type.
* @param int $post_id Post ID.
* @param string $meta_key Meta key.
* @param mixed $meta_value Meta value. Must be serializable if non-scalar.
* @param mixed $prev_value Previous Value of the Meta, allowing to check the data
*
* @return null|bool This should be ignored, only used to not break the WordPress filters
*/
public function filter_watch_updated_meta( $check, $post_id, $meta_key, $meta_value, $prev_value = null ) {
/**
* Allows toggling the Modified fields tracking
* @var bool
*/
$is_tracking_modified_fields = (bool) apply_filters( 'tribe_tracker_enabled', true );
// Bail if we shouldn't be tracking modifications
if ( false === $is_tracking_modified_fields ) {
return $check;
}
// Matching the WordPress filter, we actually don't care about Check at all!
if ( null !== $check ) {
return (bool) $check;
}
// Try to fetch the post object
$post = get_post( $post_id );
// We only go forward if we have the Post Object
if ( ! $post instanceof WP_Post ) {
return $check;
}
// Fetch from a unified method which meta keys are been excluded
$excluded_keys = $this->get_excluded_meta_keys();
// Bail when this meta is set to be excluded
if ( in_array( $meta_key, $excluded_keys ) ) {
return $check;
}
// Fetch from a unified method which post types are been tracked
$tracked_post_types = $this->get_post_types();
// Only track if the meta is from a post that is been tracked
if ( ! in_array( $post->post_type, $tracked_post_types ) ) {
return $check;
}
if ( empty( $prev_value ) ) {
$prev_value = get_post_meta( $post->ID, $meta_key, true );
}
// We don't care if the value didn't actually change
if ( $prev_value == $meta_value ) {
return $check;
}
// Gets the Current Timestamp
$now = current_time( 'timestamp' );
// Fetch the current data from the modified fields
$modified = get_post_meta( $post->ID, self::$field_key, true );
if ( ! is_array( $modified ) ) {
$modified = [];
}
// If we got here we will update the Modified Meta
$modified[ $meta_key ] = $now;
// Avoid loops!
remove_filter( 'update_post_metadata', [ $this, 'filter_watch_updated_meta' ], PHP_INT_MAX - 1 );
// Actually do the Update
update_post_meta( $post->ID, self::$field_key, $modified );
// Safe to filter again.
add_filter( 'update_post_metadata', [ $this, 'filter_watch_updated_meta' ], PHP_INT_MAX - 1, 5 );
// We need to return this, because we are still on a filter
return $check;
}
/**
* Tracks fields that are changed when an event is updated
*
* @param int $post_id Post ID
* @param WP_Post $post_after New post object
* @param WP_Post $post_before Old post object
*/
public function filter_watch_post_fields( $post_id, $post_after, $post_before ) {
/**
* Allows toggling the Modified fields tracking
* @var bool
*/
$is_tracking_modified_fields = (bool) apply_filters( 'tribe_tracker_enabled', true );
// Bail if we shouldn't be tracking modifications
if ( false === $is_tracking_modified_fields ) {
return;
}
// Fetch from a unified method which post types are been tracked
$tracked_post_types = $this->get_post_types();
// Only track if the meta is from a post that is been tracked
if ( ! in_array( $post_before->post_type, $tracked_post_types ) ) {
return;
}
// Fetch the current Time
$now = current_time( 'timestamp' );
if ( ! $modified = get_post_meta( $post_id, self::$field_key, true ) ) {
$modified = [];
}
$fields_to_check_for_changes = [
'post_title',
'post_content',
'post_excerpt',
'post_status',
'post_type',
'post_parent',
];
foreach ( $fields_to_check_for_changes as $field ) {
if ( ! $this->has_field_changed( $field, $post_after, $post_before ) ) {
continue;
}
$modified[ $field ] = $now;
}
if ( $modified ) {
update_post_meta( $post_id, self::$field_key, $modified );
}
}
/**
* Track term changes for the tracked post types and terms.
*
* Meant to run on the `set_object_terms` action.
*
* @see wp_set_object_terms()
*
* @param $object_id
* @param $terms
* @param $tt_ids
* @param $taxonomy
* @param $append
* @param $old_tt_ids
*
* @return bool `true` if the post type and taxonomy are tracked, `false` otherwise.
*/
public function track_taxonomy_term_changes( $object_id, $terms, $tt_ids, $taxonomy, $append, $old_tt_ids ) {
/**
* Allows toggling the post taxonomy terms tracking
*
* @var bool $track_terms Whether the class is currently tracking terms or not.
*/
$is_tracking_taxonomy_terms = (bool) apply_filters( 'tribe_tracker_enabled_for_terms', $this->track_terms );
if ( false === $is_tracking_taxonomy_terms ) {
return false;
}
$tracked_post_types = $this->get_post_types();
$post_id = tribe_post_exists( $object_id );
if (
empty( $post_id )
|| ! ( $post = get_post( $post_id ) )
|| ! in_array( $post->post_type, $tracked_post_types )
) {
return false;
}
$tracked_taxonomies = $this->get_taxonomies();
if ( ! in_array( $taxonomy, $tracked_taxonomies ) ) {
return false;
}
if ( ! $modified = get_post_meta( $post->ID, self::$field_key, true ) ) {
$modified = [];
}
if ( $tt_ids == $old_tt_ids ) {
// nothing to update, still we did the job
return true;
}
$modified[ $taxonomy ] = time();
update_post_meta( $post->ID, self::$field_key, $modified );
return true;
}
/**
* Easy way to see currently which taxonomies are been tracked by our code.
*
* @return array
*/
public function get_taxonomies() {
/**
* Adds a way for Developers to add and remove which taxonomies will be tracked
*
* Note: Removing any of the default methods will affect how we deal with fields
* affected by the authority settings defined on this installation
*
* @var array $tracked_taxonomies An array of the tracker taxonomies names.
*/
$tracked_taxonomies = (array) apply_filters( 'tribe_tracker_taxonomies', $this->tracked_taxonomies );
return $tracked_taxonomies;
}
/**
* Whether taxonomy term changes should be tracked or not by the class.
*
* @param bool $track_terms
*/
public function should_track_terms( $track_terms ) {
$this->track_terms = $track_terms;
}
/**
* Sets the taxonomies the tracker should track.
*
* @param array $tracked_taxonomies
*/
public function set_tracked_taxonomies( array $tracked_taxonomies ) {
$this->tracked_taxonomies = $tracked_taxonomies;
}
/**
* Sets the post types the tracker should track.
*
* @param array $tracked_post_types
*/
public function set_tracked_post_types( array $tracked_post_types ) {
$this->tracked_post_types = $tracked_post_types;
}
/**
* Make sure to remove the changed field if the event is deleted to ensure there are no left meta fields when
* the event is deleted.
*
* @since 4.7.6
*
* @param int Post ID
* @return bool
*/
public function cleanup_meta_fields( $post_id ) {
return delete_post_meta( (int) $post_id, self::$field_key );
}
}
Mini Shell