Object_Sync_Sf_Logging

Complexity

Total Complexity

66

Size/Duplication

Total Lines	584
Duplicated Lines	0 %

Importance

Changes	11
Bugs	1	Features	1

22 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	14	2
A	add_prune_interval()	0	14	1
B	posts_filter()	0	11	7
B	check_log_schedule()	0	25	6
A	set_prune_option()	0	4	1
A	add()	0	10	1
A	sortable_columns()	0	3	1
A	get_schedule_frequency()	0	21	4
B	restrict_log_posts()	0	27	6
A	get_connected_logs()	0	33	4
A	set_log_visibility()	0	22	1
A	type_column()	0	3	1
A	type_column_content()	0	14	3
A	get_log_count()	0	28	4
A	set_prune_age()	0	6	2
A	init()	0	24	2
A	set_log_slug()	0	5	2
B	setup()	0	27	10
A	save_log_schedule()	0	11	5
A	set_log_types()	0	3	1
A	set_prune_args()	0	3	1
A	get_logs()	0	6	1

<?php
/**
 * Class file for the Object_Sync_Sf_Logging class. Extend the WP_Logging class for the purposes of Object Sync for Salesforce.
 *
 * @file
 */

if ( ! class_exists( 'Object_Sync_Salesforce' ) ) {
	die();
}

/**
 * Log events based on plugin settings
 */
class Object_Sync_Sf_Logging extends WP_Logging {

	protected $wpdb;
	protected $version;
	protected $slug;
	protected $option_prefix;

	public $enabled;
	public $statuses_to_log;

	private $schedule_name;


	/**
	 * Constructor which sets content type and pruning for logs
	 *
	 * @param object $wpdb An instance of the wpdb class.
	 * @param string $version The version of this plugin.
	 * @param string $slug The plugin slug
	 * @param string $option_prefix The plugin's option prefix
	 * @throws \Exception
	 */
	public function __construct( $wpdb, $version, $slug = '', $option_prefix = '' ) {
		$this->wpdb          = $wpdb;
		$this->version       = $version;
		$this->slug          = $slug;
		$this->option_prefix = isset( $option_prefix ) ? $option_prefix : 'object_sync_for_salesforce_';

		$this->enabled         = get_option( $this->option_prefix . 'enable_logging', false );
		$this->statuses_to_log = get_option( $this->option_prefix . 'statuses_to_log', array() );

		$this->schedule_name = 'wp_logging_prune_routine';

		$this->capability = 'configure_salesforce';

The property capability does not exist. Although not strictly required by PHP, it is generally a best practice to declare properties explicitly.

		$this->init();

	}

	/**
	 * Start. This creates a schedule for pruning logs, and also the custom content type
	 *
	 * @throws \Exception
	 */
	private function init() {
		if ( true === filter_var( $this->enabled, FILTER_VALIDATE_BOOLEAN ) ) {
			add_filter( 'cron_schedules', array( $this, 'add_prune_interval' ) );
			add_filter( 'wp_log_types', array( $this, 'set_log_types' ), 10, 1 );
			add_filter( 'wp_logging_should_we_prune', array( $this, 'set_prune_option' ), 10, 1 );
			add_filter( 'wp_logging_prune_when', array( $this, 'set_prune_age' ), 10, 1 );
			add_filter( 'wp_logging_prune_query_args', array( $this, 'set_prune_args' ), 10, 1 );
			add_filter( 'wp_logging_post_type_args', array( $this, 'set_log_visibility' ), 10, 1 );
			add_filter( 'pre_wp_unique_post_slug', array( $this, 'set_log_slug' ), 10, 5 );

			// add a sortable Type column to the posts admin
			add_filter( 'manage_edit-wp_log_columns', array( $this, 'type_column' ), 10, 1 );
			add_filter( 'manage_edit-wp_log_sortable_columns', array( $this, 'sortable_columns' ), 10, 1 );
			add_action( 'manage_wp_log_posts_custom_column', array( $this, 'type_column_content' ), 10, 2 );

			// filter the log posts admin by log type
			add_filter( 'parse_query', array( $this, 'posts_filter' ), 10, 1 );
			add_action( 'restrict_manage_posts', array( $this, 'restrict_log_posts' ) );

			// when the schedule might change
			add_action( 'update_option_' . $this->option_prefix . 'logs_how_often_unit', array( $this, 'check_log_schedule' ), 10, 3 );
			add_action( 'update_option_' . $this->option_prefix . 'logs_how_often_number', array( $this, 'check_log_schedule' ), 10, 3 );

			$this->save_log_schedule();
		}
	}

	/**
	 * Set visibility for the post type
	 *
	 * @param array $log_args The post arguments
	 * @return array $log_args
	 */
	public function set_log_visibility( $log_args ) {
		// set public to true overrides the WP_DEBUG setting that is the default on the class
		// capabilities makes it so (currently) only admin users can see the log posts in their admin view
		// note: a public value of true is required to show Logs as a nav menu item on the admin.
		// however, if we don't set exclude_from_search to true and publicly_queryable to false, logs *can* appear in search results
		$log_args['public']              = true;
		$log_args['publicly_queryable']  = false;
		$log_args['exclude_from_search'] = true;
		$log_args['capabilities']        = array(
			'edit_post'          => $this->capability,
			'read_post'          => $this->capability,
			'delete_post'        => $this->capability,
			'edit_posts'         => $this->capability,
			'edit_others_posts'  => $this->capability,
			'delete_posts'       => $this->capability,
			'publish_posts'      => $this->capability,
			'read_private_posts' => $this->capability,
		);

		$log_args = apply_filters( $this->option_prefix . 'logging_post_type_args', $log_args );

		return $log_args;
	}

	/**
	 * Create a (probably unique) post name for logs in a more performant manner than wp_unique_post_slug().
	 *
	 * @param string $override_slug Short-circuit return value.
	 * @param string $slug The desired slug (post_name).
	 * @param int $post_ID The post ID
	 * @param string $post_status The post status
	 * @param string $post_type The post type
	 * @return string
	 */
	public function set_log_slug( $override_slug, $slug, $post_ID, $post_status, $post_type ) {
		if ( 'wp_log' === $post_type ) {
			$override_slug = uniqid( $post_type . '-', true ) . '-' . wp_generate_password( 32, false );
		}
		return $override_slug;
	}

	/**
	 * Add a Type column to the posts admin for this post type
	 *
	 * @param array $columns
	 * @return array $columns
	 */
	public function type_column( $columns ) {
		$columns['type'] = __( 'Type', 'object-sync-for-salesforce' );
		return $columns;
	}

	/**
	 * Make the Type column in the posts admin for this post type sortable
	 *
	 * @param array $columns
	 * @return array $columns
	 */
	public function sortable_columns( $columns ) {
		$columns['type'] = 'type';
		return $columns;
	}

	/**
	 * Add the content for the Type column in the posts admin for this post type
	 *
	 * @param string $column_name
	 * @param int $post_id
	 */
	public function type_column_content( $column_name, $post_id ) {
		if ( 'type' != $column_name ) {
			return;
		}
		// get wp_log_type
		$terms = wp_get_post_terms(
			$post_id,
			'wp_log_type',
			array(
				'fields' => 'names',
			)
		);
		if ( is_array( $terms ) ) {

The condition is_array($terms) is always false.

			echo esc_attr( $terms[0] );
		}
	}

	/**
	 * Filter log posts by the taxonomy from the dropdown when a value is present
	 *
	 * @param object $query
	 * @return object $query
	 */
	public function posts_filter( $query ) {
		global $pagenow;
		$type     = 'wp_log';
		$taxonomy = 'wp_log_type';
		if ( is_admin() && isset( $_GET['post_type'] ) && esc_attr( $_GET['post_type'] ) === $type && 'edit.php' === $pagenow && isset( $_GET[ $taxonomy ] ) && '' !== $_GET[ $taxonomy ] ) {
			$query->post_type = $type;
			$query->tax_query = array(
				array(
					'taxonomy' => $taxonomy,
					'field'    => 'slug',
					'terms'    => esc_attr( $_GET[ $taxonomy ] ),
				),
			);
		}
	}

	/**
	 * Add a filter form for the log admin so we can filter by wp_log_type taxonomy values
	 *
	 * @param object $query
	 * @return object $query
	 */
	public function restrict_log_posts() {
		$type     = 'wp_log';
		$taxonomy = 'wp_log_type';
		// only add filter to post type you want
		if ( isset( $_GET['post_type'] ) && esc_attr( $_GET['post_type'] ) === $type ) {
			// get wp_log_type
			$terms = get_terms(
				[
					'taxonomy'   => $taxonomy,
					'hide_empty' => true,
				]
			);
			?>
			<select name="wp_log_type">
				<option value=""><?php _e( 'All log types ', 'object-sync-for-salesforce' ); ?></option>
				<?php
				$current_log_type = isset( $_GET[ $taxonomy ] ) ? esc_attr( $_GET[ $taxonomy ] ) : '';
				foreach ( $terms as $key => $term ) {
					printf(
						'<option value="%s"%s>%s</option>',
						$term->slug,
						$term->slug == $current_log_type ? ' selected="selected"' : '',
						$term->name
					);
				}
				?>
			</select>
			<?php
		}
	}

	/**
	 * When the cron settings change, clear the relevant schedule
	 *
	 * @param mixed $old_value Previous option value
	 * @param mixed $new_value New option value
	 * @param string $option Name of option
	 */
	public function check_log_schedule( $old_value, $new_value, $option ) {
		$clear_schedule  = false;
		$schedule_unit   = get_option( $this->option_prefix . 'logs_how_often_unit', '' );
		$schedule_number = get_option( $this->option_prefix . 'logs_how_often_number', '' );
		if ( $this->option_prefix . 'logs_how_often_unit' === $option ) {
			$old_frequency = $this->get_schedule_frequency( $old_value, $schedule_number );

It seems like $schedule_number can also be of type false and string; however, parameter $number of Object_Sync_Sf_Logging::get_schedule_frequency() does only seem to accept double|integer, maybe add an additional type check?

			$new_frequency = $this->get_schedule_frequency( $new_value, $schedule_number );
			$old_key       = $old_frequency['key'];
			$new_key       = $new_frequency['key'];
			if ( $old_key !== $new_key ) {
				$clear_schedule = true;
			}
		}
		if ( $this->option_prefix . 'logs_how_often_number' === $option ) {
			$old_frequency = $this->get_schedule_frequency( $schedule_unit, $old_value );

It seems like $schedule_unit can also be of type false; however, parameter $unit of Object_Sync_Sf_Logging::get_schedule_frequency() does only seem to accept string, maybe add an additional type check?

			$new_frequency = $this->get_schedule_frequency( $schedule_unit, $new_value );
			$old_key       = $old_frequency['key'];
			$new_key       = $new_frequency['key'];
			if ( $old_key !== $new_key ) {
				$clear_schedule = true;
			}
		}
		if ( true === $clear_schedule ) {
			wp_clear_scheduled_hook( $this->schedule_name );
			$this->save_log_schedule();
		}
	}

	/**
	 * Save a cron schedule
	 *
	 */
	public function save_log_schedule() {
		global $pagenow;
		if ( ( 'options.php' !== $pagenow ) && ( ! isset( $_GET['page'] ) || $this->slug . '-admin' !== $_GET['page'] ) ) {
			return;
		}
		$schedule_unit   = get_option( $this->option_prefix . 'logs_how_often_unit', '' );
		$schedule_number = get_option( $this->option_prefix . 'logs_how_often_number', '' );
		$frequency       = $this->get_schedule_frequency( $schedule_unit, $schedule_number );

It seems like $schedule_number can also be of type false and string; however, parameter $number of Object_Sync_Sf_Logging::get_schedule_frequency() does only seem to accept double|integer, maybe add an additional type check?

It seems like $schedule_unit can also be of type false; however, parameter $unit of Object_Sync_Sf_Logging::get_schedule_frequency() does only seem to accept string, maybe add an additional type check?

		$key             = $frequency['key'];
		if ( ! wp_next_scheduled( $this->schedule_name ) ) {
			wp_schedule_event( time(), $key, $this->schedule_name );
		}
	}

	/**
	 * Add interval to wp schedules based on admin settings
	 *
	 * @param array $schedules An array of scheduled cron items.
	 * @return array $frequency
	 */
	public function add_prune_interval( $schedules ) {

		$schedule_unit   = get_option( $this->option_prefix . 'logs_how_often_unit', '' );
		$schedule_number = get_option( $this->option_prefix . 'logs_how_often_number', '' );
		$frequency       = $this->get_schedule_frequency( $schedule_unit, $schedule_number );

It seems like $schedule_number can also be of type false and string; however, parameter $number of Object_Sync_Sf_Logging::get_schedule_frequency() does only seem to accept double|integer, maybe add an additional type check?

It seems like $schedule_unit can also be of type false; however, parameter $unit of Object_Sync_Sf_Logging::get_schedule_frequency() does only seem to accept string, maybe add an additional type check?

		$key             = $frequency['key'];
		$seconds         = $frequency['seconds'];

		$schedules[ $key ] = array(
			'interval' => $seconds * $schedule_number,
			'display'  => 'Every ' . $schedule_number . ' ' . $schedule_unit,

Are you sure $schedule_unit of type false|mixed|string can be used in concatenation?

Are you sure $schedule_number of type false|mixed|string can be used in concatenation?

		);

		return $schedules;

	}

	/**
	 * Convert the schedule frequency from the admin settings into an array
	 * interval must be in seconds for the class to use it
	 *
	 * @param string $unit A unit of time.
	 * @param number $number The number of those units.
	 * @return array
	 */
	public function get_schedule_frequency( $unit, $number ) {

		switch ( $unit ) {
			case 'minutes':
				$seconds = 60;
				break;
			case 'hours':
				$seconds = 3600;
				break;
			case 'days':
				$seconds = 86400;
				break;
			default:
				$seconds = 0;
		}

		$key = $unit . '_' . $number;

		return array(
			'key'     => $key,
			'seconds' => $seconds,
		);

	}

	/**
	 * Set terms for Salesforce logs
	 *
	 * @param array $terms An array of string log types in the WP_Logging class.
	 * @return array $terms
	 */
	public function set_log_types( $terms ) {
		$terms[] = 'salesforce';
		return $terms;
	}

	/**
	 * Should logs be pruned at all?
	 *
	 * @param string $should_we_prune Whether to prune old log items.
	 * @return string $should_we_prune Whether to prune old log items.
	 */
	public function set_prune_option( $should_we_prune ) {
		$should_we_prune = get_option( $this->option_prefix . 'prune_logs', $should_we_prune );
		$should_we_prune = filter_var( $should_we_prune, FILTER_VALIDATE_BOOLEAN );
		return $should_we_prune;
	}

	/**
	 * Set how often to prune the Salesforce logs
	 *
	 * @param string $how_old How old the oldest non-pruned log items should be allowed to be.
	 * @return string $how_old
	 */
	public function set_prune_age( $how_old ) {
		$value = get_option( $this->option_prefix . 'logs_how_old', '' ) . ' ago';

Are you sure get_option($this->option_prefix . 'logs_how_old', '') of type false|mixed|string can be used in concatenation?

		if ( '' !== $value ) {
			return $value;
		} else {
			return $how_old;
		}
	}

	/**
	 * Set arguments for only getting the Salesforce logs
	 *
	 * @param array $args Argument array for get_posts determining what posts are eligible for pruning.
	 * @return array $args
	 */
	public function set_prune_args( $args ) {
		$args['wp_log_type'] = 'salesforce';
		return $args;
	}

	/**
	 * Setup new log entry
	 *
	 * Check and see if we should log anything, and if so, send it to add()
	 *
	 * @access      public
	 * @since       1.0
	 *
	 * @param       string|array $title_or_params A log post title, or the full array of parameters
	 * @param       string $message The log message.
	 * @param       string|0 $trigger The type of log triggered. Usually one of: debug, notice, warning, error.

The doc comment string|0 at position 2 could not be parsed: Unknown type name '0' at position 2 in string|0.

	 * @param       int $parent The parent WordPress object.
	 * @param       string $status The log status.
	 *
	 * @uses        self::add()
	 * @see         Object_Sync_Sf_Mapping::__construct()    the location of the bitmasks that define the logging triggers.
	 *
	 * @return      void
	 */
	public function setup( $title_or_params, $message = '', $trigger = 0, $parent = 0, $status = '' ) {

		if ( is_array( $title_or_params ) ) {
			$title   = $title_or_params['title'];
			$message = $title_or_params['message'];
			$trigger = $title_or_params['trigger'];
			$parent  = $title_or_params['parent'];
			$status  = $title_or_params['status'];
		} else {
			$title = $title_or_params;
		}

		if ( ! is_array( maybe_unserialize( $this->statuses_to_log ) ) ) {

It seems like $this->statuses_to_log can also be of type array; however, parameter $original of maybe_unserialize() does only seem to accept string, maybe add an additional type check?

			if ( $status === $this->statuses_to_log ) {
				$this->add( $title, $message, $parent );
			} else {
				return;
			}
		}

		if ( true === filter_var( $this->enabled, FILTER_VALIDATE_BOOLEAN ) && in_array( $status, maybe_unserialize( $this->statuses_to_log ), true ) ) {

It seems like maybe_unserialize($this->statuses_to_log) can also be of type boolean; however, parameter $haystack of in_array() does only seem to accept array, maybe add an additional type check?

			$triggers_to_log = get_option( $this->option_prefix . 'triggers_to_log', array() );
			// if we force strict on this in_array, it fails because the mapping triggers are bit operators, as indicated in Object_Sync_Sf_Mapping class's method __construct()
			if ( in_array( $trigger, maybe_unserialize( $triggers_to_log ) ) || 0 === $trigger ) {

It seems like maybe_unserialize($triggers_to_log) can also be of type false; however, parameter $haystack of in_array() does only seem to accept array, maybe add an additional type check?

				$this->add( $title, $message, $parent );
			} elseif ( is_array( $trigger ) && array_intersect( $trigger, maybe_unserialize( $triggers_to_log ) ) ) {

It seems like maybe_unserialize($triggers_to_log) can also be of type false; however, parameter $array2 of array_intersect() does only seem to accept array, maybe add an additional type check?

				$this->add( $title, $message, $parent );
			}
		}
	}

	/**
	 * Create new log entry
	 *
	 * This is just a simple and fast way to log something. Use self::insert_log()
	 * if you need to store custom meta data
	 *
	 * @access      public
	 * @since       1.0
	 *
	 * @param       string $title A log post title.
	 *
	 * @uses        self::insert_log()
	 * @param       string $message The log message.
	 * @param       int $parent The parent WordPress object.
	 * @param       string $type The type of log message; defaults to 'salesforce'.
	 *
	 * @return      int The ID of the new log entry
	 */
	public static function add( $title = '', $message = '', $parent = 0, $type = 'salesforce' ) {

		$log_data = array(
			'post_title'   => esc_html( $title ),
			'post_content' => wp_kses_post( $message ),
			'post_parent'  => absint( $parent ),
			'log_type'     => esc_attr( $type ),
		);

		return self::insert_log( $log_data );

	}


	/**
	 * Easily retrieves log items for a particular object ID
	 *
	 * @access      private
	 * @since       1.0
	 *
	 * @param       int $object_id A WordPress object ID.
	 * @param       string $type The type of log item; defaults to 'salesforce' because that's the type of logs we create.
	 * @param       int $paged Which page of results do we want?
	 *
	 * @uses        self::get_connected_logs()
	 *
	 * @return      array
	 */
	public static function get_logs( $object_id = 0, $type = 'salesforce', $paged = null ) {
		return self::get_connected_logs(
			array(
				'post_parent' => (int) $object_id,
				'paged'       => (int) $paged,
				'log_type'    => (string) $type,
			)
		);
	}


	/**
	 * Retrieve all connected logs
	 *
	 * Used for retrieving logs related to particular items, such as a specific purchase.
	 *
	 * @access  private
	 * @since   1.0
	 *
	 * @param   Array $args An array of arguments for get_posts().
	 *
	 * @uses    wp_parse_args()
	 * @uses    get_posts()
	 * @uses    get_query_var()
	 * @uses    self::valid_type()
	 *
	 * @return  array / false
	 */
	public static function get_connected_logs( $args = array() ) {

		$defaults = array(
			'post_parent'    => 0,
			'post_type'      => 'wp_log',
			'posts_per_page' => 10,
			'post_status'    => 'publish',
			'paged'          => get_query_var( 'paged' ),
			'log_type'       => 'salesforce',
		);

		$query_args = wp_parse_args( $args, $defaults );

		if ( $query_args['log_type'] && self::valid_type( $query_args['log_type'] ) ) {

			$query_args['tax_query'] = array(
				array(
					'taxonomy' => 'wp_log_type',
					'field'    => 'slug',
					'terms'    => $query_args['log_type'],
				),
			);

		}

		$logs = get_posts( $query_args );

		if ( $logs ) {
			return $logs;
		}

		// no logs found.
		return false;

	}


	/**
	 * Retrieves number of log entries connected to particular object ID
	 *
	 * @access  private
	 * @since   1.0
	 *
	 * @param       int $object_id A WordPress object ID.
	 * @param       string $type The type of log item; defaults to 'salesforce' because that's the type of logs we create.
	 * @param       Array $meta_query A WordPress meta query, parseable by WP_Meta_Query.
	 *
	 * @uses    WP_Query()
	 * @uses    self::valid_type()
	 *
	 * @return  int
	 */
	public static function get_log_count( $object_id = 0, $type = 'salesforce', $meta_query = null ) {

		$query_args = array(
			'post_parent'    => (int) $object_id,
			'post_type'      => 'wp_log',
			'posts_per_page' => 100,
			'post_status'    => 'publish',
		);

		if ( ! empty( $type ) && self::valid_type( $type ) ) {

			$query_args['tax_query'] = array(
				array(
					'taxonomy' => 'wp_log_type',
					'field'    => 'slug',
					'terms'    => sanitize_key( $type ),
				),
			);

		}

		if ( ! empty( $meta_query ) ) {
			$query_args['meta_query'] = $meta_query;
		}

		$logs = new WP_Query( $query_args );

		return (int) $logs->post_count;

	}

}