Jetpack_Media_Summary - Code Metrics - Inspection of "Add goldsounds as an a11n author" - Automattic/jetpack - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — add/goldsounds ( 0c869a )

unknown

created 2016-03-30 21:47 UTC

Jetpack_Media_Summary C

↳ Parent: Project

Complexity

Total Complexity

Size/Duplication

Total Lines	271
Duplicated Lines	3.69 %

Coupling/Cohesion

Components	1
Dependencies	2

Metric	Value
wmc	55
lcom	1
cbo	2
dl	10
loc	271
rs	6.8

9 Methods

Rating	Name	Duplication	Size	Complexity
A	https()	0	3	1
A	get_word_count()	0	3	1
A	get_word_remaining_count()	0	3	1
A	get_link_count()	0	3	1
F	get()	10	195	41
A	ssl_img()	0	7	2
B	get_video_poster()	0	12	5
A	clean_text()	0	17	1
A	get_excerpt()	0	17	2

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_Media_Summary 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_Media_Summary, and based on these observations, apply Extract Interface, too.

<?php
/**
 * Class Jetpack_Media_Summary
 *
 * embed [video] > gallery > image > text
 */
class Jetpack_Media_Summary {

	static function get( $post_id, $blog_id = 0, $args = array() ) {
		$defaults = array(
			'max_words' => 16,
			'max_chars' => 256,
		);
		$args = wp_parse_args( $args, $defaults );

		$switched = false;
		if ( !empty( $blog_id ) && $blog_id != get_current_blog_id() && function_exists( 'switch_to_blog' ) ) {
			switch_to_blog( $blog_id );
			$switched = true;
		} else {
			$blog_id = get_current_blog_id();
		}

		$post      = get_post( $post_id );
		$permalink = get_permalink( $post_id );

		$return = array(
			'type'       => 'standard',
			'permalink'  => $permalink,
			'image'      => '',
			'excerpt'    => '',
			'word_count' => 0,
			'secure'     => array(
				'image'  => '',
			),
			'count'       => array(
				'image' => 0,
				'video' => 0,
				'word'  => 0,
				'link'  => 0,
			),
		);

		if ( empty( $post->post_password ) ) {
			$return['excerpt']       = self::get_excerpt( $post->post_content, $post->post_excerpt, $args['max_words'], $args['max_chars'] );
			$return['count']['word'] = self::get_word_count( $post->post_content );
			$return['count']['word_remaining'] = self::get_word_remaining_count( $post->post_content, $return['excerpt'] );
			$return['count']['link'] = self::get_link_count( $post->post_content );
		}

		$extract = Jetpack_Media_Meta_Extractor::extract( $blog_id, $post_id, Jetpack_Media_Meta_Extractor::ALL );

		if ( empty( $extract['has'] ) )
			return $return;

		// Prioritize [some] video embeds
		if ( !empty( $extract['has']['shortcode'] ) ) {
			foreach ( $extract['shortcode'] as $type => $data ) {
				switch ( $type ) {
					case 'wpvideo':
						if ( 0 == $return['count']['video'] ) {
							$return['type'] = 'video';
							$return['video'] = esc_url_raw( 'http://s0.videopress.com/player.swf?guid=' . $extract['shortcode']['wpvideo']['id'][0] . '&isDynamicSeeking=true' );
							$return['image'] = self::get_video_poster( 'videopress', $extract['shortcode']['wpvideo']['id'][0] );
							$return['secure']['video'] = preg_replace( '@http://[^\.]+.videopress.com/@', 'https://v0.wordpress.com/', $return['video'] );
							$return['secure']['image'] = str_replace( 'http://videos.videopress.com', 'https://videos.files.wordpress.com', $return['image'] );
						}
						$return['count']['video']++;
						break;
					case 'youtube':
						if ( 0 == $return['count']['video'] ) {
							$return['type'] = 'video';
							$return['video'] = esc_url_raw( 'http://www.youtube.com/watch?feature=player_embedded&v=' . $extract['shortcode']['youtube']['id'][0] );
							$return['image'] = self::get_video_poster( 'youtube', $extract['shortcode']['youtube']['id'][0] );
							$return['secure']['video'] = self::https( $return['video'] );
							$return['secure']['image'] = self::https( $return['image'] );
						}
						$return['count']['video']++;
						break;
					case 'vimeo':
						if ( 0 == $return['count']['video'] ) {
							$return['type'] = 'video';
							$return['video'] = esc_url_raw( 'http://vimeo.com/' . $extract['shortcode']['vimeo']['id'][0] );
							$return['secure']['video'] = self::https( $return['video'] );

							$poster_image = get_post_meta( $post_id, 'vimeo_poster_image', true );
							if ( !empty( $poster_image ) ) {
								$return['image'] = $poster_image;
								$poster_url_parts = parse_url( $poster_image );
								$return['secure']['image'] = 'https://secure-a.vimeocdn.com' . $poster_url_parts['path'];
							}
						}
						$return['count']['video']++;
						break;
				}
			}

		}

		if ( !empty( $extract['has']['embed'] ) ) {
			foreach( $extract['embed']['url'] as $embed ) {
				if ( preg_match( '/((youtube|vimeo|dailymotion)\.com|youtu.be)/', $embed ) ) {
					if ( 0 == $return['count']['video'] ) {
						$return['type']   = 'video';
						$return['video']  = 'http://' .  $embed;
						$return['secure']['video'] = self::https( $return['video'] );
						if ( false !== strpos( $embed, 'youtube' ) ) {
							$return['image'] = self::get_video_poster( 'youtube', jetpack_get_youtube_id( $return['video'] ) );
							$return['secure']['image'] = self::https( $return['image'] );
						} else if ( false !== strpos( $embed, 'youtu.be' ) ) {
							$youtube_id = jetpack_get_youtube_id( $return['video'] );
							$return['video'] = 'http://youtube.com/watch?v=' . $youtube_id . '&feature=youtu.be';
							$return['secure']['video'] = self::https( $return['video'] );
							$return['image'] = self::get_video_poster( 'youtube', jetpack_get_youtube_id( $return['video'] ) );
							$return['secure']['image'] = self::https( $return['image'] );
						} else if ( false !== strpos( $embed, 'vimeo' ) ) {
							$poster_image = get_post_meta( $post_id, 'vimeo_poster_image', true );
							if ( !empty( $poster_image ) ) {
								$return['image'] = $poster_image;
								$poster_url_parts = parse_url( $poster_image );
								$return['secure']['image'] = 'https://secure-a.vimeocdn.com' . $poster_url_parts['path'];
							}
						} else if ( false !== strpos( $embed, 'dailymotion' ) ) {
							$return['image'] = str_replace( 'dailymotion.com/video/','dailymotion.com/thumbnail/video/', $embed );
							$return['image'] = parse_url( $return['image'], PHP_URL_SCHEME ) === null ? 'http://' . $return['image'] : $return['image'];
							$return['secure']['image'] = self::https( $return['image'] );
						}

					}
					$return['count']['video']++;
				}
			}
		}

		// Do we really want to make the video the primary focus of the post?
		if ( 'video' == $return['type'] ) {
			$content = wpautop( strip_tags( $post->post_content ) );
			$paragraphs = explode( '</p>', $content );
			$number_of_paragraphs = 0;

			foreach ( $paragraphs as $i => $paragraph ) {
				// Don't include blank lines as a paragraph
				if ( '' == trim( $paragraph ) ) {
					unset( $paragraphs[$i] );
					continue;
				}
				$number_of_paragraphs++;
			}

			$number_of_paragraphs = $number_of_paragraphs - $return['count']['video']; // subtract amount for videos..

			// More than 2 paragraph? The video is not the primary focus so we can do some more analysis
			if ( $number_of_paragraphs > 2 )
				$return['type'] = 'standard';
		}

		// If we don't have any prioritized embed...
		if ( 'standard' == $return['type'] ) {
			if ( ( ! empty( $extract['has']['gallery'] ) || ! empty( $extract['shortcode']['gallery']['count'] ) ) && ! empty( $extract['image'] ) ) {
				//... Then we prioritize galleries first (multiple images returned)
				$return['type']   = 'gallery';
				$return['images'] = $extract['image'];
				foreach ( $return['images'] as $image ) {
					$return['secure']['images'][] = array( 'url' => self::ssl_img( $image['url'] ) );
					$return['count']['image']++;
				}
			} else if ( ! empty( $extract['has']['image'] ) ) {
				// ... Or we try and select a single image that would make sense
				$content = wpautop( strip_tags( $post->post_content ) );
				$paragraphs = explode( '</p>', $content );
				$number_of_paragraphs = 0;

				foreach ( $paragraphs as $i => $paragraph ) {
					// Don't include 'actual' captions as a paragraph
					if ( false !== strpos( $paragraph, '[caption' ) ) {
						unset( $paragraphs[$i] );
						continue;
					}
					// Don't include blank lines as a paragraph
					if ( '' == trim( $paragraph ) ) {
						unset( $paragraphs[$i] );
						continue;
					}
					$number_of_paragraphs++;
				}

				$return['image'] = $extract['image'][0]['url'];
				$return['secure']['image'] = self::ssl_img( $return['image'] );
				$return['count']['image']++;

				if ( $number_of_paragraphs <= 2 && 1 == count( $extract['image'] ) ) {
					// If we have lots of text or images, let's not treat it as an image post, but return its first image
					$return['type']  = 'image';
$a = "a";
$ab = "ab";
$abc = "abc";
				}
			}
		}

		if ( $switched ) {
			restore_current_blog();
		}

		return $return;
	}

	static function https( $str ) {
		return str_replace( 'http://', 'https://', $str );
	}

	static function ssl_img( $url ) {
		if ( false !== strpos( $url, 'files.wordpress.com' ) ) {
			return self::https( $url );
		} else {
			return self::https( jetpack_photon_url( $url ) );
		}
	}

	static function get_video_poster( $type, $id ) {
		if ( 'videopress' == $type ) {
			if ( function_exists( 'video_get_highest_resolution_image_url' ) ) {
				return video_get_highest_resolution_image_url( $id );
			} else if ( class_exists( 'VideoPress_Video' ) ) {
				$video = new VideoPress_Video( $id );
				return $video->poster_frame_uri;
			}
		} else if ( 'youtube' == $type ) {
			return  'http://img.youtube.com/vi/'.$id.'/0.jpg';
		}
	}

	static function clean_text( $text ) {
		return trim(
			preg_replace(
				'/[\s]+/',
				' ',
				preg_replace(
					'@https?://[\S]+@',
					'',
					strip_shortcodes(
						strip_tags(
							$text
						)
					)
				)
			)
		);
	}

	static function get_excerpt( $post_content, $post_excerpt, $max_words = 16, $max_chars = 256 ) {
		if ( function_exists( 'wpcom_enhanced_excerpt_extract_excerpt' ) ) {
			return self::clean_text( wpcom_enhanced_excerpt_extract_excerpt( array(
				'text'           => $post_content,
				'excerpt_only'   => true,
				'show_read_more' => false,
				'max_words'      => $max_words,
				'max_chars'      => $max_chars,
				'read_more_threshold' => 25,
			) ) );
		} else {

			/** This filter is documented in core/src/wp-includes/post-template.php */
			$post_excerpt = apply_filters( 'get_the_excerpt', $post_excerpt );
			return self::clean_text( $post_excerpt );
		}
	}

	static function get_word_count( $post_content ) {
		return str_word_count( self::clean_text( $post_content ) );
	}

	static function get_word_remaining_count( $post_content, $excerpt_content ) {
		return str_word_count( self::clean_text( $post_content ) ) - str_word_count( self::clean_text( $excerpt_content ) );
	}

	static function get_link_count( $post_content ) {
		return preg_match_all( '/\<a[\> ]/', $post_content, $matches );
	}
}


1		<?php
2		/**
3		* Class Jetpack_Media_Summary
4		*
5		* embed [video] > gallery > image > text
6		*/
7		class Jetpack_Media_Summary {
8
9		static function get( $post_id, $blog_id = 0, $args = array() ) {
10		$defaults = array(
11		'max_words' => 16,
12		'max_chars' => 256,
13		);
14		$args = wp_parse_args( $args, $defaults );
15
16		$switched = false;
17		if ( !empty( $blog_id ) && $blog_id != get_current_blog_id() && function_exists( 'switch_to_blog' ) ) {
18		switch_to_blog( $blog_id );
19		$switched = true;
20		} else {
21		$blog_id = get_current_blog_id();
22		}
23
24		$post = get_post( $post_id );
25		$permalink = get_permalink( $post_id );
26
27		$return = array(
28		'type' => 'standard',
29		'permalink' => $permalink,
30		'image' => '',
31		'excerpt' => '',
32		'word_count' => 0,
33		'secure' => array(
34		'image' => '',
35		),
36		'count' => array(
37		'image' => 0,
38		'video' => 0,
39		'word' => 0,
40		'link' => 0,
41		),
42		);
43
44		if ( empty( $post->post_password ) ) {
45		$return['excerpt'] = self::get_excerpt( $post->post_content, $post->post_excerpt, $args['max_words'], $args['max_chars'] );
46		$return['count']['word'] = self::get_word_count( $post->post_content );
47		$return['count']['word_remaining'] = self::get_word_remaining_count( $post->post_content, $return['excerpt'] );
48		$return['count']['link'] = self::get_link_count( $post->post_content );
49		}
50
51		$extract = Jetpack_Media_Meta_Extractor::extract( $blog_id, $post_id, Jetpack_Media_Meta_Extractor::ALL );
52
53		if ( empty( $extract['has'] ) )
54		return $return;
55
56		// Prioritize [some] video embeds
57		if ( !empty( $extract['has']['shortcode'] ) ) {
58		foreach ( $extract['shortcode'] as $type => $data ) {
59		switch ( $type ) {
60		case 'wpvideo':
61		if ( 0 == $return['count']['video'] ) {
62		$return['type'] = 'video';
63		$return['video'] = esc_url_raw( 'http://s0.videopress.com/player.swf?guid=' . $extract['shortcode']['wpvideo']['id'][0] . '&isDynamicSeeking=true' );
64		$return['image'] = self::get_video_poster( 'videopress', $extract['shortcode']['wpvideo']['id'][0] );
65		$return['secure']['video'] = preg_replace( '@http://[^\.]+.videopress.com/@', 'https://v0.wordpress.com/', $return['video'] );
66		$return['secure']['image'] = str_replace( 'http://videos.videopress.com', 'https://videos.files.wordpress.com', $return['image'] );
67		}
68		$return['count']['video']++;
69		break;
70		case 'youtube':
71		if ( 0 == $return['count']['video'] ) {
72		$return['type'] = 'video';
73		$return['video'] = esc_url_raw( 'http://www.youtube.com/watch?feature=player_embedded&v=' . $extract['shortcode']['youtube']['id'][0] );
74		$return['image'] = self::get_video_poster( 'youtube', $extract['shortcode']['youtube']['id'][0] );
75		$return['secure']['video'] = self::https( $return['video'] );
76		$return['secure']['image'] = self::https( $return['image'] );
77		}
78		$return['count']['video']++;
79		break;
80		case 'vimeo':
81		if ( 0 == $return['count']['video'] ) {
82		$return['type'] = 'video';
83		$return['video'] = esc_url_raw( 'http://vimeo.com/' . $extract['shortcode']['vimeo']['id'][0] );
84		$return['secure']['video'] = self::https( $return['video'] );
85
86		$poster_image = get_post_meta( $post_id, 'vimeo_poster_image', true );
87	View Code Duplication	if ( !empty( $poster_image ) ) {
88		$return['image'] = $poster_image;
89		$poster_url_parts = parse_url( $poster_image );
90		$return['secure']['image'] = 'https://secure-a.vimeocdn.com' . $poster_url_parts['path'];
91		}
92		}
93		$return['count']['video']++;
94		break;
95		}
96		}
97
98		}
99
100		if ( !empty( $extract['has']['embed'] ) ) {
101		foreach( $extract['embed']['url'] as $embed ) {
102		if ( preg_match( '/((youtube\|vimeo\|dailymotion)\.com\|youtu.be)/', $embed ) ) {
103		if ( 0 == $return['count']['video'] ) {
104		$return['type'] = 'video';
105		$return['video'] = 'http://' . $embed;
106		$return['secure']['video'] = self::https( $return['video'] );
107		if ( false !== strpos( $embed, 'youtube' ) ) {
108		$return['image'] = self::get_video_poster( 'youtube', jetpack_get_youtube_id( $return['video'] ) );
109		$return['secure']['image'] = self::https( $return['image'] );
110		} else if ( false !== strpos( $embed, 'youtu.be' ) ) {
111		$youtube_id = jetpack_get_youtube_id( $return['video'] );
112		$return['video'] = 'http://youtube.com/watch?v=' . $youtube_id . '&feature=youtu.be';
113		$return['secure']['video'] = self::https( $return['video'] );
114		$return['image'] = self::get_video_poster( 'youtube', jetpack_get_youtube_id( $return['video'] ) );
115		$return['secure']['image'] = self::https( $return['image'] );
116		} else if ( false !== strpos( $embed, 'vimeo' ) ) {
117		$poster_image = get_post_meta( $post_id, 'vimeo_poster_image', true );
118	View Code Duplication	if ( !empty( $poster_image ) ) {
119		$return['image'] = $poster_image;
120		$poster_url_parts = parse_url( $poster_image );
121		$return['secure']['image'] = 'https://secure-a.vimeocdn.com' . $poster_url_parts['path'];
122		}
123		} else if ( false !== strpos( $embed, 'dailymotion' ) ) {
124		$return['image'] = str_replace( 'dailymotion.com/video/','dailymotion.com/thumbnail/video/', $embed );
125		$return['image'] = parse_url( $return['image'], PHP_URL_SCHEME ) === null ? 'http://' . $return['image'] : $return['image'];
126		$return['secure']['image'] = self::https( $return['image'] );
127		}
128
129		}
130		$return['count']['video']++;
131		}
132		}
133		}
134
135		// Do we really want to make the video the primary focus of the post?
136		if ( 'video' == $return['type'] ) {
137		$content = wpautop( strip_tags( $post->post_content ) );
138		$paragraphs = explode( '</p>', $content );
139		$number_of_paragraphs = 0;
140
141		foreach ( $paragraphs as $i => $paragraph ) {
142		// Don't include blank lines as a paragraph
143		if ( '' == trim( $paragraph ) ) {
144		unset( $paragraphs[$i] );
145		continue;
146		}
147		$number_of_paragraphs++;
148		}
149
150		$number_of_paragraphs = $number_of_paragraphs - $return['count']['video']; // subtract amount for videos..
151
152		// More than 2 paragraph? The video is not the primary focus so we can do some more analysis
153		if ( $number_of_paragraphs > 2 )
154		$return['type'] = 'standard';
155		}
156
157		// If we don't have any prioritized embed...
158		if ( 'standard' == $return['type'] ) {
159		if ( ( ! empty( $extract['has']['gallery'] ) \|\| ! empty( $extract['shortcode']['gallery']['count'] ) ) && ! empty( $extract['image'] ) ) {
160		//... Then we prioritize galleries first (multiple images returned)
161		$return['type'] = 'gallery';
162		$return['images'] = $extract['image'];
163		foreach ( $return['images'] as $image ) {
164		$return['secure']['images'][] = array( 'url' => self::ssl_img( $image['url'] ) );
165		$return['count']['image']++;
166		}
167		} else if ( ! empty( $extract['has']['image'] ) ) {
168		// ... Or we try and select a single image that would make sense
169		$content = wpautop( strip_tags( $post->post_content ) );
170		$paragraphs = explode( '</p>', $content );
171		$number_of_paragraphs = 0;
172
173		foreach ( $paragraphs as $i => $paragraph ) {
174		// Don't include 'actual' captions as a paragraph
175		if ( false !== strpos( $paragraph, '[caption' ) ) {
176		unset( $paragraphs[$i] );
177		continue;
178		}
179		// Don't include blank lines as a paragraph
180		if ( '' == trim( $paragraph ) ) {
181		unset( $paragraphs[$i] );
182		continue;
183		}
184		$number_of_paragraphs++;
185		}
186
187		$return['image'] = $extract['image'][0]['url'];
188		$return['secure']['image'] = self::ssl_img( $return['image'] );
189		$return['count']['image']++;
190
191		if ( $number_of_paragraphs <= 2 && 1 == count( $extract['image'] ) ) {
192		// If we have lots of text or images, let's not treat it as an image post, but return its first image
193		$return['type'] = 'image';
		0 ignored issues – show Coding Style introduced 2015-11-20 23:04 UTC by Report Bug Copy Issue Report Equals sign not aligned correctly; expected 1 space but found 2 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...
194		}
195		}
196		}
197
198		if ( $switched ) {
199		restore_current_blog();
200		}
201
202		return $return;
203		}
204
205		static function https( $str ) {
206		return str_replace( 'http://', 'https://', $str );
207		}
208
209		static function ssl_img( $url ) {
210		if ( false !== strpos( $url, 'files.wordpress.com' ) ) {
211		return self::https( $url );
212		} else {
213		return self::https( jetpack_photon_url( $url ) );
214		}
215		}
216
217		static function get_video_poster( $type, $id ) {
218		if ( 'videopress' == $type ) {
219		if ( function_exists( 'video_get_highest_resolution_image_url' ) ) {
220		return video_get_highest_resolution_image_url( $id );
221		} else if ( class_exists( 'VideoPress_Video' ) ) {
222		$video = new VideoPress_Video( $id );
223		return $video->poster_frame_uri;
224		}
225		} else if ( 'youtube' == $type ) {
226		return 'http://img.youtube.com/vi/'.$id.'/0.jpg';
227		}
228		}
229
230		static function clean_text( $text ) {
231		return trim(
232		preg_replace(
233		'/[\s]+/',
234		' ',
235		preg_replace(
236		'@https?://[\S]+@',
237		'',
238		strip_shortcodes(
239		strip_tags(
240		$text
241		)
242		)
243		)
244		)
245		);
246		}
247
248		static function get_excerpt( $post_content, $post_excerpt, $max_words = 16, $max_chars = 256 ) {
249		if ( function_exists( 'wpcom_enhanced_excerpt_extract_excerpt' ) ) {
250		return self::clean_text( wpcom_enhanced_excerpt_extract_excerpt( array(
251		'text' => $post_content,
252		'excerpt_only' => true,
253		'show_read_more' => false,
254		'max_words' => $max_words,
255		'max_chars' => $max_chars,
256		'read_more_threshold' => 25,
257		) ) );
258		} else {
259
260		/** This filter is documented in core/src/wp-includes/post-template.php */
261		$post_excerpt = apply_filters( 'get_the_excerpt', $post_excerpt );
262		return self::clean_text( $post_excerpt );
263		}
264		}
265
266		static function get_word_count( $post_content ) {
267		return str_word_count( self::clean_text( $post_content ) );
268		}
269
270		static function get_word_remaining_count( $post_content, $excerpt_content ) {
271		return str_word_count( self::clean_text( $post_content ) ) - str_word_count( self::clean_text( $excerpt_content ) );
272		}
273
274		static function get_link_count( $post_content ) {
275		return preg_match_all( '/\<a[\> ]/', $post_content, $matches );
276		}
277		}
278

Automattic / jetpack