Jetpack_Sync_Module_Posts - Code Metrics - Inspection of "Merge branch 'master' of github.com:Automattic/jet..." - Automattic/jetpack - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — add/export ( a51c2a...ecad12 )

unknown

created 2016-11-21 17:18 UTC

Jetpack_Sync_Module_Posts B

↳ Parent: Project

Complexity

Total Complexity

Size/Duplication

Total Lines	229
Duplicated Lines	19.65 %

Coupling/Cohesion

Components	3
Dependencies	3

Importance

Changes

Metric	Value
dl	45
loc	229
rs	8.2769
c	0
b	0
f	0
wmc	41
lcom	3
cbo	3

21 Methods

Rating	Name	Duplication	Size	Complexity
A	name()	0	3	1
A	get_object_by_id()	0	7	3
A	set_defaults()	0	2	1
A	init_listeners()	0	13	1
A	init_full_sync_listeners()	0	3	1
A	init_before_send()	0	6	1
A	enqueue_full_sync_actions()	0	5	1
A	estimate_full_sync_actions()	0	8	1
A	get_where_sql()	10	10	2
A	get_full_sync_actions()	0	3	1
A	expand_wp_insert_post()	0	3	1
A	filter_blacklisted_post_types()	0	9	2
A	filter_meta()	0	7	3
A	is_whitelisted_post_meta()	0	4	2
A	is_post_type_allowed()	0	4	1
A	remove_embed()	8	8	1
A	add_embed()	8	8	1
C	filter_post_content_and_add_links()	19	70	11
A	save_published()	0	5	3
A	send_published()	0	7	2
A	expand_post_ids()	0	13	1

How to fix Duplicated Code Complexity

Duplicated Code

Duplicate code is one of the most pungent code smells. A rule that is often used is to re-structure code once it is duplicated in three or more places.

Common duplication problems, and corresponding solutions are:

If you have the same expression in different places: Extract expression to a method
If you have the same method in different sub-classes: Extract method, and pull up field to the parent class
If you have the same code in unrelated classes: Consider extracting the code to a new class, and injecting that class

Complex Class

Tip: Before tackling complexity, make sure that you eliminate any duplication first. This often can reduce the size of classes significantly.

Complex classes like Jetpack_Sync_Module_Posts often do a lot of different things. To break such a class down, we need to identify a cohesive component within that class. A common approach to find such a component is to look for fields/methods that share the same prefixes, or suffixes. You can also have a look at the cohesion graph to spot any un-connected, or weakly-connected components.

Once you have determined the fields that belong together, you can apply the Extract Class refactoring. If the component makes sense as a sub-class, Extract Subclass is also a candidate, and is often faster.

While breaking up the class, it is a good idea to analyze how other classes use Jetpack_Sync_Module_Posts, and based on these observations, apply Extract Interface, too.

<?php

require_once dirname( __FILE__ ) . '/class.jetpack-sync-settings.php';

class Jetpack_Sync_Module_Posts extends Jetpack_Sync_Module {

	private $just_published;

	public function name() {
		return 'posts';
	}

	public function get_object_by_id( $object_type, $id ) {
		if ( $object_type === 'post' && $post = get_post( intval( $id ) ) ) {
			return $this->filter_post_content_and_add_links( $post );
		}

		return false;
	}

	public function set_defaults() {
	}

	public function init_listeners( $callable ) {
		add_action( 'wp_insert_post', $callable, 10, 3 );
		add_action( 'wp_insert_post', array( $this, 'send_published'), 11, 3 );
		add_action( 'deleted_post', $callable, 10 );
		add_action( 'jetpack_publicize_post', $callable );
		add_action( 'jetpack_published_post', $callable, 10, 2 );
		add_action( 'transition_post_status', array( $this, 'save_published' ), 10, 3 );
		add_filter( 'jetpack_sync_before_enqueue_wp_insert_post', array( $this, 'filter_blacklisted_post_types' ) );

		// listen for meta changes
		$this->init_listeners_for_meta_type( 'post', $callable );
		$this->init_meta_whitelist_handler( 'post', array( $this, 'filter_meta' ) );
	}

	public function init_full_sync_listeners( $callable ) {
		add_action( 'jetpack_full_sync_posts', $callable ); // also sends post meta
	}

	public function init_before_send() {
		add_filter( 'jetpack_sync_before_send_wp_insert_post', array( $this, 'expand_wp_insert_post' ) );

		// full sync
		add_filter( 'jetpack_sync_before_send_jetpack_full_sync_posts', array( $this, 'expand_post_ids' ) );
	}

	public function enqueue_full_sync_actions( $config, $max_items_to_enqueue, $state ) {
		global $wpdb;

		return $this->enqueue_all_ids_as_action( 'jetpack_full_sync_posts', $wpdb->posts, 'ID', $this->get_where_sql( $config ), $max_items_to_enqueue, $state );
	}

	public function estimate_full_sync_actions( $config ) {
		global $wpdb;

		$query = "SELECT count(*) FROM $wpdb->posts WHERE " . $this->get_where_sql( $config );
		$count = $wpdb->get_var( $query );

		return (int) ceil( $count / self::ARRAY_CHUNK_SIZE );
	}

	private function get_where_sql( $config ) {
		$where_sql = Jetpack_Sync_Settings::get_blacklisted_post_types_sql();

		// config is a list of post IDs to sync
		if ( is_array( $config ) ) {
			$where_sql   .= ' AND ID IN (' . implode( ',', array_map( 'intval', $config ) ) . ')';
$a = "a";
$ab = "ab";
$abc = "abc";
		}

		return $where_sql;
	}

	function get_full_sync_actions() {
		return array( 'jetpack_full_sync_posts' );
	}

	/**
	 * Process content before send
	 */

	function expand_wp_insert_post( $args ) {
		return array( $args[0], $this->filter_post_content_and_add_links( $args[1] ), $args[2] );
	}

	function filter_blacklisted_post_types( $args ) {
		$post = $args[1];

		if ( in_array( $post->post_type, Jetpack_Sync_Settings::get_setting( 'post_types_blacklist' ) ) ) {
			return false;
		}

		return $args;
	}

	// Meta
	function filter_meta( $args ) {
		if ( $this->is_post_type_allowed( $args[1] ) && $this->is_whitelisted_post_meta( $args[2] ) ) {
			return $args;
		}

		return false;
	}

	function is_whitelisted_post_meta( $meta_key ) {
		// _wpas_skip_ is used by publicize
		return in_array( $meta_key, Jetpack_Sync_Settings::get_setting( 'post_meta_whitelist' ) ) || wp_startswith( $meta_key, '_wpas_skip_' );
	}

	function is_post_type_allowed( $post_id ) {
		$post = get_post( $post_id );
		return ! in_array( $post->post_type, Jetpack_Sync_Settings::get_setting( 'post_types_blacklist' ) );
	}

	function remove_embed() {
		global $wp_embed;
		remove_filter( 'the_content', array( $wp_embed, 'run_shortcode' ), 8 );
		// remove the embed shortcode since we would do the part later.
		remove_shortcode( 'embed' );
		// Attempts to embed all URLs in a post
		remove_filter( 'the_content', array( $wp_embed, 'autoembed' ), 8 );
	}

	function add_embed() {
		global $wp_embed;
		add_filter( 'the_content', array( $wp_embed, 'run_shortcode' ), 8 );
		// Shortcode placeholder for strip_shortcodes()
		add_shortcode( 'embed', '__return_false' );
		// Attempts to embed all URLs in a post
		add_filter( 'the_content', array( $wp_embed, 'autoembed' ), 8 );
	}

	// Expands wp_insert_post to include filtered content
	function filter_post_content_and_add_links( $post_object ) {
		global $post;
		$post = $post_object;

		// return non existant post 
		$post_type = get_post_type_object( $post->post_type );
		if ( empty( $post_type) || ! is_object( $post_type ) ) {
			$non_existant_post                    = new stdClass();
			$non_existant_post->ID                = $post->ID;
			$non_existant_post->post_modified     = $post->post_modified;
			$non_existant_post->post_modified_gmt = $post->post_modified_gmt;
			$non_existant_post->post_status       = 'jetpack_sync_non_registered_post_type';
			
			return $non_existant_post;
		}
		/**
		 * Filters whether to prevent sending post data to .com
		 *
		 * Passing true to the filter will prevent the post data from being sent
		 * to the WordPress.com.
		 * Instead we pass data that will still enable us to do a checksum against the
		 * Jetpacks data but will prevent us from displaying the data on in the API as well as
		 * other services.
		 * @since 4.2.0
		 *
		 * @param boolean false prevent post data from being synced to WordPress.com
		 * @param mixed $post WP_POST object
		 */
		if ( apply_filters( 'jetpack_sync_prevent_sending_post_data', false, $post ) ) {
			// We only send the bare necessary object to be able to create a checksum.
			$blocked_post                    = new stdClass();
			$blocked_post->ID                = $post->ID;
			$blocked_post->post_modified     = $post->post_modified;
			$blocked_post->post_modified_gmt = $post->post_modified_gmt;
			$blocked_post->post_status       = 'jetpack_sync_blocked';

			return $blocked_post;
		}

		// lets not do oembed just yet.
		$this->remove_embed();

		if ( 0 < strlen( $post->post_password ) ) {
			$post->post_password = 'auto-' . wp_generate_password( 10, false );
		}
		
		/** This filter is already documented in core. wp-includes/post-template.php */
		if ( Jetpack_Sync_Settings::get_setting( 'render_filtered_content' ) && $post_type->public  ) {

			$post->post_content_filtered   = apply_filters( 'the_content', $post->post_content );
			$post->post_excerpt_filtered   = apply_filters( 'the_excerpt', $post->post_excerpt );
		}

		$this->add_embed();

		if ( has_post_thumbnail( $post->ID ) ) {
			$image_attributes = wp_get_attachment_image_src( get_post_thumbnail_id( $post->ID ), 'full' );
			if ( is_array( $image_attributes ) && isset( $image_attributes[0] ) ) {
				$post->featured_image = $image_attributes[0];
			}
		}

		$post->permalink               = get_permalink( $post->ID );
		$post->shortlink               = wp_get_shortlink( $post->ID );
		$post->dont_email_post_to_subs = Jetpack::is_module_active( 'subscriptions' ) ?
				get_post_meta( $post->ID, '_jetpack_dont_email_post_to_subs', true ) :
				true; // Don't email subscription if the subscription module is not active.

		return $post;
	}

	public function save_published( $new_status, $old_status, $post ) {
		if ( 'publish' === $new_status && 'publish' !== $old_status ) {
			$this->just_published = $post->ID;
		}
	}

	public function send_published( $post_ID, $post, $update ) {

		if ( $this->just_published === $post->ID ) {
			$this->just_published = null;
			$flags = apply_filters( 'jetpack_published_post_flags', array(), $post );
			do_action( 'jetpack_published_post', $post_ID, $flags );
		}
	}

	public function expand_post_ids( $args ) {
		$post_ids = $args[0];

		$posts = array_filter( array_map( array( 'WP_Post', 'get_instance' ), $post_ids ) );
		$posts = array_map( array( $this, 'filter_post_content_and_add_links' ), $posts );
		$posts = array_values( $posts ); // reindex in case posts were deleted

		return array(
			$posts,
			$this->get_metadata( $post_ids, 'post', Jetpack_Sync_Settings::get_setting( 'post_meta_whitelist' ) ),
			$this->get_term_relationships( $post_ids ),
		);
	}
}


1		<?php
2
3		require_once dirname( __FILE__ ) . '/class.jetpack-sync-settings.php';
4
5		class Jetpack_Sync_Module_Posts extends Jetpack_Sync_Module {
6
7		private $just_published;
8
9		public function name() {
10		return 'posts';
11		}
12
13		public function get_object_by_id( $object_type, $id ) {
14		if ( $object_type === 'post' && $post = get_post( intval( $id ) ) ) {
15		return $this->filter_post_content_and_add_links( $post );
16		}
17
18		return false;
19		}
20
21		public function set_defaults() {
22		}
23
24		public function init_listeners( $callable ) {
25		add_action( 'wp_insert_post', $callable, 10, 3 );
26		add_action( 'wp_insert_post', array( $this, 'send_published'), 11, 3 );
27		add_action( 'deleted_post', $callable, 10 );
28		add_action( 'jetpack_publicize_post', $callable );
29		add_action( 'jetpack_published_post', $callable, 10, 2 );
30		add_action( 'transition_post_status', array( $this, 'save_published' ), 10, 3 );
31		add_filter( 'jetpack_sync_before_enqueue_wp_insert_post', array( $this, 'filter_blacklisted_post_types' ) );
32
33		// listen for meta changes
34		$this->init_listeners_for_meta_type( 'post', $callable );
35		$this->init_meta_whitelist_handler( 'post', array( $this, 'filter_meta' ) );
36		}
37
38		public function init_full_sync_listeners( $callable ) {
39		add_action( 'jetpack_full_sync_posts', $callable ); // also sends post meta
40		}
41
42		public function init_before_send() {
43		add_filter( 'jetpack_sync_before_send_wp_insert_post', array( $this, 'expand_wp_insert_post' ) );
44
45		// full sync
46		add_filter( 'jetpack_sync_before_send_jetpack_full_sync_posts', array( $this, 'expand_post_ids' ) );
47		}
48
49		public function enqueue_full_sync_actions( $config, $max_items_to_enqueue, $state ) {
50		global $wpdb;
51
52		return $this->enqueue_all_ids_as_action( 'jetpack_full_sync_posts', $wpdb->posts, 'ID', $this->get_where_sql( $config ), $max_items_to_enqueue, $state );
53		}
54
55		public function estimate_full_sync_actions( $config ) {
56		global $wpdb;
57
58		$query = "SELECT count(*) FROM $wpdb->posts WHERE " . $this->get_where_sql( $config );
59		$count = $wpdb->get_var( $query );
60
61		return (int) ceil( $count / self::ARRAY_CHUNK_SIZE );
62		}
63
64	View Code Duplication	private function get_where_sql( $config ) {
65		$where_sql = Jetpack_Sync_Settings::get_blacklisted_post_types_sql();
66
67		// config is a list of post IDs to sync
68		if ( is_array( $config ) ) {
69		$where_sql .= ' AND ID IN (' . implode( ',', array_map( 'intval', $config ) ) . ')';
		0 ignored issues – show Coding Style introduced 2016-07-29 22:58 UTC by Report Bug Copy Issue Report Equals sign not aligned correctly; expected 1 space but found 3 spaces This check looks for improperly formatted assignments. Every assignment must have exactly one space before and one space after the equals operator. To illustrate: $a = "a"; $ab = "ab"; $abc = "abc"; will have no issues, while $a = "a"; $ab = "ab"; $abc = "abc"; will report issues in lines 1 and 2. Loading history...
70		}
71
72		return $where_sql;
73		}
74
75		function get_full_sync_actions() {
76		return array( 'jetpack_full_sync_posts' );
77		}
78
79		/**
80		* Process content before send
81		*/
82
83		function expand_wp_insert_post( $args ) {
84		return array( $args[0], $this->filter_post_content_and_add_links( $args[1] ), $args[2] );
85		}
86
87		function filter_blacklisted_post_types( $args ) {
88		$post = $args[1];
89
90		if ( in_array( $post->post_type, Jetpack_Sync_Settings::get_setting( 'post_types_blacklist' ) ) ) {
91		return false;
92		}
93
94		return $args;
95		}
96
97		// Meta
98		function filter_meta( $args ) {
99		if ( $this->is_post_type_allowed( $args[1] ) && $this->is_whitelisted_post_meta( $args[2] ) ) {
100		return $args;
101		}
102
103		return false;
104		}
105
106		function is_whitelisted_post_meta( $meta_key ) {
107		// _wpas_skip_ is used by publicize
108		return in_array( $meta_key, Jetpack_Sync_Settings::get_setting( 'post_meta_whitelist' ) ) \|\| wp_startswith( $meta_key, '_wpas_skip_' );
109		}
110
111		function is_post_type_allowed( $post_id ) {
112		$post = get_post( $post_id );
113		return ! in_array( $post->post_type, Jetpack_Sync_Settings::get_setting( 'post_types_blacklist' ) );
114		}
115
116	View Code Duplication	function remove_embed() {
117		global $wp_embed;
118		remove_filter( 'the_content', array( $wp_embed, 'run_shortcode' ), 8 );
119		// remove the embed shortcode since we would do the part later.
120		remove_shortcode( 'embed' );
121		// Attempts to embed all URLs in a post
122		remove_filter( 'the_content', array( $wp_embed, 'autoembed' ), 8 );
123		}
124
125	View Code Duplication	function add_embed() {
126		global $wp_embed;
127		add_filter( 'the_content', array( $wp_embed, 'run_shortcode' ), 8 );
128		// Shortcode placeholder for strip_shortcodes()
129		add_shortcode( 'embed', '__return_false' );
130		// Attempts to embed all URLs in a post
131		add_filter( 'the_content', array( $wp_embed, 'autoembed' ), 8 );
132		}
133
134		// Expands wp_insert_post to include filtered content
135		function filter_post_content_and_add_links( $post_object ) {
136		global $post;
137		$post = $post_object;
138
139		// return non existant post
140		$post_type = get_post_type_object( $post->post_type );
141	View Code Duplication	if ( empty( $post_type) \|\| ! is_object( $post_type ) ) {
142		$non_existant_post = new stdClass();
143		$non_existant_post->ID = $post->ID;
144		$non_existant_post->post_modified = $post->post_modified;
145		$non_existant_post->post_modified_gmt = $post->post_modified_gmt;
146		$non_existant_post->post_status = 'jetpack_sync_non_registered_post_type';
147
148		return $non_existant_post;
149		}
150		/**
151		* Filters whether to prevent sending post data to .com
152		*
153		* Passing true to the filter will prevent the post data from being sent
154		* to the WordPress.com.
155		* Instead we pass data that will still enable us to do a checksum against the
156		* Jetpacks data but will prevent us from displaying the data on in the API as well as
157		* other services.
158		* @since 4.2.0
159		*
160		* @param boolean false prevent post data from being synced to WordPress.com
161		* @param mixed $post WP_POST object
162		*/
163	View Code Duplication	if ( apply_filters( 'jetpack_sync_prevent_sending_post_data', false, $post ) ) {
164		// We only send the bare necessary object to be able to create a checksum.
165		$blocked_post = new stdClass();
166		$blocked_post->ID = $post->ID;
167		$blocked_post->post_modified = $post->post_modified;
168		$blocked_post->post_modified_gmt = $post->post_modified_gmt;
169		$blocked_post->post_status = 'jetpack_sync_blocked';
170
171		return $blocked_post;
172		}
173
174		// lets not do oembed just yet.
175		$this->remove_embed();
176
177		if ( 0 < strlen( $post->post_password ) ) {
178		$post->post_password = 'auto-' . wp_generate_password( 10, false );
179		}
180
181		/** This filter is already documented in core. wp-includes/post-template.php */
182		if ( Jetpack_Sync_Settings::get_setting( 'render_filtered_content' ) && $post_type->public ) {
183
184		$post->post_content_filtered = apply_filters( 'the_content', $post->post_content );
185		$post->post_excerpt_filtered = apply_filters( 'the_excerpt', $post->post_excerpt );
186		}
187
188		$this->add_embed();
189
190		if ( has_post_thumbnail( $post->ID ) ) {
191		$image_attributes = wp_get_attachment_image_src( get_post_thumbnail_id( $post->ID ), 'full' );
192		if ( is_array( $image_attributes ) && isset( $image_attributes[0] ) ) {
193		$post->featured_image = $image_attributes[0];
194		}
195		}
196
197		$post->permalink = get_permalink( $post->ID );
198		$post->shortlink = wp_get_shortlink( $post->ID );
199		$post->dont_email_post_to_subs = Jetpack::is_module_active( 'subscriptions' ) ?
200		get_post_meta( $post->ID, '_jetpack_dont_email_post_to_subs', true ) :
201		true; // Don't email subscription if the subscription module is not active.
202
203		return $post;
204		}
205
206		public function save_published( $new_status, $old_status, $post ) {
207		if ( 'publish' === $new_status && 'publish' !== $old_status ) {
208		$this->just_published = $post->ID;
209		}
210		}
211
212		public function send_published( $post_ID, $post, $update ) {
		0 ignored issues – show Unused Code introduced 2016-11-10 05:58 UTC by Report Bug Copy Issue Report The parameter `$update` is not used and could be removed. This check looks from parameters that have been defined for a function or method, but which are not used in the method body. Loading history...
213		if ( $this->just_published === $post->ID ) {
214		$this->just_published = null;
215		$flags = apply_filters( 'jetpack_published_post_flags', array(), $post );
216		do_action( 'jetpack_published_post', $post_ID, $flags );
217		}
218		}
219
220		public function expand_post_ids( $args ) {
221		$post_ids = $args[0];
222
223		$posts = array_filter( array_map( array( 'WP_Post', 'get_instance' ), $post_ids ) );
224		$posts = array_map( array( $this, 'filter_post_content_and_add_links' ), $posts );
225		$posts = array_values( $posts ); // reindex in case posts were deleted
226
227		return array(
228		$posts,
229		$this->get_metadata( $post_ids, 'post', Jetpack_Sync_Settings::get_setting( 'post_meta_whitelist' ) ),
230		$this->get_term_relationships( $post_ids ),
231		);
232		}
233		}
234

Automattic / jetpack