Jetpack_Sync_Client

Complexity

Total Complexity

23

Size/Duplication

Total Lines	126
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	4

Importance

Changes	10
Bugs	1	Features	1

10 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	4	1
B	init()	0	33	3
A	set_options_whitelist()	0	3	1
B	is_whitelisted_option()	0	10	5
A	set_codec()	0	3	1
B	action_handler()	0	20	5
A	switch_theme_handler()	0	5	1
B	do_sync()	0	25	4
A	get_actions()	0	4	1
A	reset_actions()	0	3	1

<?php
require_once dirname( __FILE__ ) . '/class.jetpack-sync-deflate-codec.php';
require_once dirname( __FILE__ ) . '/class.jetpack-sync-queue.php';

class Jetpack_Sync_Client {
	private $sync_queue;
	private $codec;
	private $options_whitelist = array( 'stylesheet', '/^theme_mods_.*$/' );

	// this is necessary because you can't use "new" when you declare instance properties >:(
	function __construct() {
		$this->sync_queue = new Jetpack_Sync_Queue( 'sync' );
		$this->codec = new Jetpack_Sync_Deflate_Codec();
	}

	function init() {
		$handler = array( $this, 'action_handler' );
		// posts
		add_action( 'wp_insert_post', $handler, 10, 3 );
		add_action( 'delete_post', $handler, 10 );
		// comments
		add_action( 'wp_insert_comment', $handler, 10, 2 );
		add_action( 'deleted_comment', $handler, 10 );
		add_action( 'trashed_comment', $handler, 10 );
		add_action( 'spammed_comment', $handler, 10 );
		// even though it's messy, we implement these hooks because the edit_comment hook doesn't include the data
		foreach ( array( '', 'trackback', 'pingback' ) as $comment_type ) {
			foreach ( array( 'unapproved', 'approved' ) as $comment_status ) {
				add_action( "comment_{$comment_status}_{$comment_type}", $handler, 10, 2 );
			}
		}

		// options
		add_action( 'added_option', $handler, 10, 2 );
		add_action( 'updated_option', $handler, 10, 3 );
		add_action( 'deleted_option', $handler, 10, 1 );

		// themes
		add_action( 'jetpack_sync_current_theme_support', $handler, 10 ); // custom hook, see meta-hooks below

		/**
		 * Meta-hooks - fire synthetic hooks for all the properties we need to sync, 
		 * e.g. when a theme changes
		 */

		// themes
		add_action( 'switch_theme', array( $this, 'switch_theme_handler' ) );
	}

	function set_options_whitelist( $options ) {
		$this->options_whitelist = $options;
	}

	function is_whitelisted_option( $option ) {
		foreach ( $this->options_whitelist as $whitelisted_option ) {
			if ( $whitelisted_option[0] === '/' && preg_match( $whitelisted_option, $option ) ) {
				return true;
			} elseif ( $whitelisted_option === $option ) {
				return true;
			}
		}
		return false;
	}

	function set_codec( iJetpack_Sync_Codec $codec ) {
		$this->codec = $codec;
	}

	function action_handler() {
		$current_filter = current_filter();
		$args           = func_get_args();

		if ( $current_filter === 'wp_insert_post' && $args[1]->post_type === 'revision' ) {
			return;
		}

		if ( in_array( $current_filter, array( 'deleted_option', 'added_option', 'updated_option' ) ) 
			&& 
			! $this->is_whitelisted_option( $args[0] ) ) {
			return;
		}
		
		Jetpack_Sync::schedule_sync();
		$this->sync_queue->add( array(
			$current_filter,
			$args
		) );
	}

	function switch_theme_handler() {
		global $_wp_theme_features;
		
		do_action( 'jetpack_sync_current_theme_support', $_wp_theme_features );
	}

	function do_sync() {
		$buffer = $this->sync_queue->checkout();

		if ( is_wp_error( $buffer) ) {
			error_log("Got error: ".$buffer->get_error_message());

The method get_error_message() does not seem to exist on object<Jetpack_Sync_Queue_Buffer>.

			return;
		}

		$data = $this->codec->encode( $buffer->items );

		/**
		 * Fires when data is ready to send to the server
		 *
		 * @since 4.1
		 *
		 * @param array $data The action buffer
		 */
		$result = apply_filters( 'jetpack_sync_client_send_data', $data );

		if ( !$result || is_wp_error( $result ) ) {
			$this->sync_queue->checkin( $buffer );
		} else {
			$this->sync_queue->close( $buffer );
		}
	}

	function get_actions() {
		// TODO: we should only send a bit at a time, flush_all sends everything

Comments for TODO tasks are often forgotten in the code; it might be better to use a dedicated issue tracker.

		return $this->sync_queue->flush_all();
	}

	function reset_actions() {
		$this->sync_queue->reset();

The method reset() does not seem to exist on object<Jetpack_Sync_Queue>.

	}
}