Images_Via_Imgix - Code Metrics - Inspection of "Add imgix support for image_downsize" - imgix-wordpress/images-via-imgix - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#18)

by Rasmus

created 2017-02-25 07:34 UTC

Images_Via_Imgix B

↳ Parent: Project

Complexity

Total Complexity

Size/Duplication

Total Lines	288
Duplicated Lines	0 %

Coupling/Cohesion

Components	2
Dependencies	0

Importance

Changes

Metric	Value
dl	0
loc	288
rs	8.3157
c	0
b	0
f	0
wmc	43
lcom	2
cbo	0

12 Methods

Rating	Name	Size	Complexity
A	__construct()	14	1
A	instance()	7	2
A	set_options()	3	1
A	add_retina()	8	1
D	replace_image_url()	39	10
D	image_downsize()	44	13
A	replace_images_in_content()	10	2
A	prefetch_cdn()	10	2
A	buffer_start_for_retina()	6	2
A	buffer_end_for_retina()	5	2
A	get_global_params()	19	4
A	get_all_defined_sizes()	22	3

How to fix Complexity

<?php

class Images_Via_Imgix {

	/**
	 * The instance of the class.
	 *
	 * @var Images_Via_Imgix
	 */
	protected static $instance;

	/**
	 * Plugin options
	 *
	 * @var array
	 */
	protected $options = [];

	/**
	 * Buffer is started by plugin and should be ended on shutdown.
	 *
	 * @var bool
	 */
	protected $buffer_started = false;

	/**
	 * ImagesViaImgix constructor.
	 */
	public function __construct() {
		$this->options = get_option( 'imgix_settings', [] );

		add_filter( 'wp_get_attachment_url', [ $this, 'replace_image_url' ] );
		add_filter( 'imgix/add-image-url', [ $this, 'replace_image_url' ] );

		add_filter( 'image_downsize', [ $this, 'image_downsize' ], 10, 3 );

		add_filter( 'the_content', [ $this, 'replace_images_in_content' ] );
		add_action( 'wp_head', [ $this, 'prefetch_cdn' ], 1 );

		add_action( 'after_setup_theme', [ $this, 'buffer_start_for_retina' ] );
		add_action( 'shutdown', [ $this, 'buffer_end_for_retina' ] );
	}

	/**
	 * Plugin loader instance.
	 *
	 * @return Images_Via_Imgix
	 */
	public static function instance() {
		if ( ! isset( self::$instance ) ) {
			self::$instance = new self;
		}

		return self::$instance;
	}

	/**
	 * Override options from settings.
	 * Used in unit tests.
	 *
	 * @param array $options
	 */
	public function set_options( $options ) {
		$this->options = $options;
	}

	/**
	 * Find all img tags with sources matching "imgix.net" without the parameter
	 * "srcset" and add the "srcset" parameter to all those images, appending a new
	 * source using the "dpr=2" modifier.
	 *
	 * @param $content
	 *
	 * @return string Content with retina-enriched image tags.
	 */
	public function add_retina( $content ) {
		$pattern = '/<img((?![^>]+srcset )([^>]*)';
		$pattern .= 'src=[\'"]([^\'"]*imgix.net[^\'"]*\?[^\'"]*w=[^\'"]*)[\'"]([^>]*)*?)>/i';
		$repl    = '<img$2src="$3" srcset="${3}, ${3}&amp;dpr=2 2x, ${3}&amp;dpr=3 3x,"$4>';
		$content = preg_replace( $pattern, $repl, $content );

		return preg_replace( $pattern, $repl, $content );
	}

	/**
	 * Modify image urls for attachments to use imgix host.
	 *
	 * @param string $url
	 *
	 * @return string
	 */
	public function replace_image_url( $url ) {
		if ( ! empty ( $this->options['cdn_link'] ) ) {
			$pathinfo = pathinfo( $url );

			if ( isset( $pathinfo['extension'] ) && in_array( $pathinfo['extension'], [
					'jpg',
					'gif',
					'png',
					'jpeg'
				] )
			) {
				$parsed_url = parse_url( $url );
				if ( isset( $parsed_url['host'] ) && $parsed_url['host'] === parse_url( home_url( '/' ), PHP_URL_HOST ) ) {
					$cdn = parse_url( $this->options['cdn_link'] );
					foreach ( [ 'scheme', 'host', 'port' ] as $url_part ) {
						if ( isset( $cdn[ $url_part ] ) ) {
							$parsed_url[ $url_part ] = $cdn[ $url_part ];
						} else {
							unset( $parsed_url[ $url_part ] );
						}
					}

					$arguments = [];
					if ( ! empty( $parsed_url['query'] ) ) {
						parse_str( $parsed_url['query'], $arguments );
					}
					$arguments = array_merge( $arguments, $this->get_global_params() );

					if ( ! empty( $arguments ) ) {
						$parsed_url['query'] = build_query( urlencode_deep( $arguments ) );
					}

					$url = http_build_url( $parsed_url );
<?php

function getDate($date)
{
    if ($date !== null) {
        return new DateTime($date);
    }

    return false;
}
				}
			}
		}

		return $url;
	}

	/**
	 * Set params when running image_downsize
	 *
	 * @param false|array  $return
	 * @param int          $attachment_id
	 * @param string|array $size
	 *
	 * @return false|array
	 */
	public function image_downsize( $return, $attachment_id, $size ) {
		if ( ! empty ( $this->options['cdn_link'] ) ) {
			$img_url    = wp_get_attachment_url( $attachment_id );
			$parsed_url = parse_url( $img_url );

			if ( is_array( $parsed_url ) ) {
				$params = [];
				if ( ! empty( $parsed_url['query'] ) ) {
					parse_str( $parsed_url['query'], $params );
				}

				if ( is_array( $size ) ) {
					$params['w'] = $width = isset( $size[0] ) ? $size[0] : 0;
					$params['h'] = $height = isset( $size[1] ) ? $size[1] : 0;
				} else {
					$available_sizes = $this->get_all_defined_sizes();
					if ( isset( $available_sizes[ $size ] ) ) {
						$size        = $available_sizes[ $size ];
						$params['w'] = $width = $size['width'];
						$params['h'] = $height = $size['height'];
					}
				}

				$params = array_filter( $params );

				if ( ! empty( $params ) ) {
					$parsed_url['query'] = build_query( urlencode_deep( $params ) );
				}

				$img_url = http_build_url( $parsed_url );

				if ( ! isset( $width ) || ! isset( $height ) ) {
					// any other type: use the real image
					$meta   = wp_get_attachment_metadata( $attachment_id );
					$width  = isset( $width ) ? $width : $meta['width'];
					$height = isset( $height ) ? $height : $meta['height'];
				}

				$return = [ $img_url, $width, $height, true ];
			}
		}

		return $return;
	}

	/**
	 * Modify image urls in content to use imgix host.
	 *
	 * @param $content
	 *
	 * @return string
	 */
	public function replace_images_in_content( $content ) {
		if ( ! empty ( $this->options['cdn_link'] ) ) {
			$content = preg_replace_callback( '/(?<=\shref="|\ssrc="|\shref=\'|\ssrc=\').*(?=\'|")/', function ( $match ) {
				return esc_url( apply_filters( 'imgix/add-image-url', $match[0] ) );
			}, $content );

		}

		return $content;
	}

	/**
	 * Add tag to dns prefetch cdn host
	 */
	public function prefetch_cdn() {
		if ( ! empty ( $this->options['cdn_link'] ) ) {
			$host = parse_url( $this->options['cdn_link'], PHP_URL_HOST );

			printf(
				'<link rel="dns-prefetch" href="%s"/>',
				esc_attr( '//' . $host )
			);
		}
	}

	/**
	 * Start output buffer if auto retina is enabled
	 */
	public function buffer_start_for_retina() {
		if ( ! empty ( $this->options['add_dpi2_srcset'] ) ) {
			$this->buffer_started = true;
			ob_start( [ $this, 'add_retina' ] );
		}
	}

	/**
	 * Stop output buffer if it was enabled by the plugin
	 */
	public function buffer_end_for_retina() {
		if ( $this->buffer_started === true ) {
			ob_end_flush();
		}
	}

	/**
	 * Returns a array of global parameters to be applied in all images,
	 * according to plugin's settings.
	 *
	 * @return array Global parameters to be appened at the end of each img URL.
	 */
	protected function get_global_params() {
		$params = [];

		// For now, only "auto" is supported.
		$auto = [];
		if ( ! empty ( $this->options['auto_format'] ) ) {
			array_push( $auto, 'format' );
		}

		if ( ! empty ( $this->options['auto_enhance'] ) ) {
			array_push( $auto, 'enhance' );
		}

		if ( ! empty( $auto ) ) {
			$params['auto'] = implode( '%2C', $auto );
		}

		return $params;
	}

	/**
	 * Get all defined image sizes
	 *
	 * @return array
	 */
	protected function get_all_defined_sizes() {
		// Make thumbnails and other intermediate sizes.
		$theme_image_sizes = wp_get_additional_image_sizes();

		$sizes = [];
		foreach ( get_intermediate_image_sizes() as $s ) {
			$sizes[ $s ] = [ 'width' => '', 'height' => '', 'crop' => false ];
			if ( isset( $theme_image_sizes[ $s ] ) ) {
				// For theme-added sizes
				$sizes[ $s ]['width']  = intval( $theme_image_sizes[ $s ]['width'] );
				$sizes[ $s ]['height'] = intval( $theme_image_sizes[ $s ]['height'] );
				$sizes[ $s ]['crop']   = $theme_image_sizes[ $s ]['crop'];
			} else {
				// For default sizes set in options
				$sizes[ $s ]['width']  = get_option( "{$s}_size_w" );
				$sizes[ $s ]['height'] = get_option( "{$s}_size_h" );
				$sizes[ $s ]['crop']   = get_option( "{$s}_crop" );
			}
		}

		return $sizes;
	}
}

Images_Via_Imgix::instance();


1			<?php
2
3			class Images_Via_Imgix {
4
5			/**
6			* The instance of the class.
7			*
8			* @var Images_Via_Imgix
9			*/
10			protected static $instance;
11
12			/**
13			* Plugin options
14			*
15			* @var array
16			*/
17			protected $options = [];
18
19			/**
20			* Buffer is started by plugin and should be ended on shutdown.
21			*
22			* @var bool
23			*/
24			protected $buffer_started = false;
25
26			/**
27			* ImagesViaImgix constructor.
28			*/
29			public function __construct() {
30			$this->options = get_option( 'imgix_settings', [] );
31
32			add_filter( 'wp_get_attachment_url', [ $this, 'replace_image_url' ] );
33			add_filter( 'imgix/add-image-url', [ $this, 'replace_image_url' ] );
34
35			add_filter( 'image_downsize', [ $this, 'image_downsize' ], 10, 3 );
36
37			add_filter( 'the_content', [ $this, 'replace_images_in_content' ] );
38			add_action( 'wp_head', [ $this, 'prefetch_cdn' ], 1 );
39
40			add_action( 'after_setup_theme', [ $this, 'buffer_start_for_retina' ] );
41			add_action( 'shutdown', [ $this, 'buffer_end_for_retina' ] );
42			}
43
44			/**
45			* Plugin loader instance.
46			*
47			* @return Images_Via_Imgix
48			*/
49			public static function instance() {
50			if ( ! isset( self::$instance ) ) {
51			self::$instance = new self;
52			}
53
54			return self::$instance;
55			}
56
57			/**
58			* Override options from settings.
59			* Used in unit tests.
60			*
61			* @param array $options
62			*/
63			public function set_options( $options ) {
64			$this->options = $options;
65			}
66
67			/**
68			* Find all img tags with sources matching "imgix.net" without the parameter
69			* "srcset" and add the "srcset" parameter to all those images, appending a new
70			* source using the "dpr=2" modifier.
71			*
72			* @param $content
73			*
74			* @return string Content with retina-enriched image tags.
75			*/
76			public function add_retina( $content ) {
77			$pattern = '/<img((?![^>]+srcset )([^>]*)';
78			$pattern .= 'src=[\'"]([^\'"]imgix.net[^\'"]\?[^\'"]w=[^\'"])[\'"]([^>])?)>/i';
79			$repl = '<img$2src="$3" srcset="${3}, ${3}&dpr=2 2x, ${3}&dpr=3 3x,"$4>';
80			$content = preg_replace( $pattern, $repl, $content );
81
82			return preg_replace( $pattern, $repl, $content );
83			}
84
85			/**
86			* Modify image urls for attachments to use imgix host.
87			*
88			* @param string $url
89			*
90			* @return string
91			*/
92			public function replace_image_url( $url ) {
93			if ( ! empty ( $this->options['cdn_link'] ) ) {
94			$pathinfo = pathinfo( $url );
95
96			if ( isset( $pathinfo['extension'] ) && in_array( $pathinfo['extension'], [
97			'jpg',
98			'gif',
99			'png',
100			'jpeg'
101			] )
102			) {
103			$parsed_url = parse_url( $url );
104			if ( isset( $parsed_url['host'] ) && $parsed_url['host'] === parse_url( home_url( '/' ), PHP_URL_HOST ) ) {
105			$cdn = parse_url( $this->options['cdn_link'] );
106			foreach ( [ 'scheme', 'host', 'port' ] as $url_part ) {
107			if ( isset( $cdn[ $url_part ] ) ) {
108			$parsed_url[ $url_part ] = $cdn[ $url_part ];
109			} else {
110			unset( $parsed_url[ $url_part ] );
111			}
112			}
113
114			$arguments = [];
115			if ( ! empty( $parsed_url['query'] ) ) {
116			parse_str( $parsed_url['query'], $arguments );
117			}
118			$arguments = array_merge( $arguments, $this->get_global_params() );
119
120			if ( ! empty( $arguments ) ) {
121			$parsed_url['query'] = build_query( urlencode_deep( $arguments ) );
122			}
123
124			$url = http_build_url( $parsed_url );
			0 ignored issues – show Security Bug introduced 2017-01-31 16:08 UTC by Report Bug Copy Issue Report It seems like `$parsed_url` defined by `parse_url($url)` on line `103` can also be of type `false`; however, `http_build_url()` does only seem to accept `array`, did you maybe forget to handle an error condition? This check looks for type mismatches where the missing type is `false`. This is usually indicative of an error condtion. Consider the follow example <?php function getDate($date) { if ($date !== null) { return new DateTime($date); } return false; } This function either returns a new `DateTime` object or false, if there was an error. This is a typical pattern in PHP programming to show that an error has occurred without raising an exception. The calling code should check for this returned `false` before passing on the value to another function or method that may not be able to handle a `false`. Loading history...
125			}
126			}
127			}
128
129			return $url;
130			}
131
132			/**
133			* Set params when running image_downsize
134			*
135			* @param false\|array $return
136			* @param int $attachment_id
137			* @param string\|array $size
138			*
139			* @return false\|array
140			*/
141			public function image_downsize( $return, $attachment_id, $size ) {
142			if ( ! empty ( $this->options['cdn_link'] ) ) {
143			$img_url = wp_get_attachment_url( $attachment_id );
144			$parsed_url = parse_url( $img_url );
145
146			if ( is_array( $parsed_url ) ) {
147			$params = [];
148			if ( ! empty( $parsed_url['query'] ) ) {
149			parse_str( $parsed_url['query'], $params );
150			}
151
152			if ( is_array( $size ) ) {
153			$params['w'] = $width = isset( $size[0] ) ? $size[0] : 0;
154			$params['h'] = $height = isset( $size[1] ) ? $size[1] : 0;
155			} else {
156			$available_sizes = $this->get_all_defined_sizes();
157			if ( isset( $available_sizes[ $size ] ) ) {
158			$size = $available_sizes[ $size ];
159			$params['w'] = $width = $size['width'];
160			$params['h'] = $height = $size['height'];
161			}
162			}
163
164			$params = array_filter( $params );
165
166			if ( ! empty( $params ) ) {
167			$parsed_url['query'] = build_query( urlencode_deep( $params ) );
168			}
169
170			$img_url = http_build_url( $parsed_url );
171
172			if ( ! isset( $width ) \|\| ! isset( $height ) ) {
173			// any other type: use the real image
174			$meta = wp_get_attachment_metadata( $attachment_id );
175			$width = isset( $width ) ? $width : $meta['width'];
176			$height = isset( $height ) ? $height : $meta['height'];
177			}
178
179			$return = [ $img_url, $width, $height, true ];
180			}
181			}
182
183			return $return;
184			}
185
186			/**
187			* Modify image urls in content to use imgix host.
188			*
189			* @param $content
190			*
191			* @return string
192			*/
193			public function replace_images_in_content( $content ) {
194			if ( ! empty ( $this->options['cdn_link'] ) ) {
195			$content = preg_replace_callback( '/(?<=\shref="\|\ssrc="\|\shref=\'\|\ssrc=\').*(?=\'\|")/', function ( $match ) {
196			return esc_url( apply_filters( 'imgix/add-image-url', $match[0] ) );
197			}, $content );
198
199			}
200
201			return $content;
202			}
203
204			/**
205			* Add tag to dns prefetch cdn host
206			*/
207			public function prefetch_cdn() {
208			if ( ! empty ( $this->options['cdn_link'] ) ) {
209			$host = parse_url( $this->options['cdn_link'], PHP_URL_HOST );
210
211			printf(
212			'<link rel="dns-prefetch" href="%s"/>',
213			esc_attr( '//' . $host )
214			);
215			}
216			}
217
218			/**
219			* Start output buffer if auto retina is enabled
220			*/
221			public function buffer_start_for_retina() {
222			if ( ! empty ( $this->options['add_dpi2_srcset'] ) ) {
223			$this->buffer_started = true;
224			ob_start( [ $this, 'add_retina' ] );
225			}
226			}
227
228			/**
229			* Stop output buffer if it was enabled by the plugin
230			*/
231			public function buffer_end_for_retina() {
232			if ( $this->buffer_started === true ) {
233			ob_end_flush();
234			}
235			}
236
237			/**
238			* Returns a array of global parameters to be applied in all images,
239			* according to plugin's settings.
240			*
241			* @return array Global parameters to be appened at the end of each img URL.
242			*/
243			protected function get_global_params() {
244			$params = [];
245
246			// For now, only "auto" is supported.
247			$auto = [];
248			if ( ! empty ( $this->options['auto_format'] ) ) {
249			array_push( $auto, 'format' );
250			}
251
252			if ( ! empty ( $this->options['auto_enhance'] ) ) {
253			array_push( $auto, 'enhance' );
254			}
255
256			if ( ! empty( $auto ) ) {
257			$params['auto'] = implode( '%2C', $auto );
258			}
259
260			return $params;
261			}
262
263			/**
264			* Get all defined image sizes
265			*
266			* @return array
267			*/
268			protected function get_all_defined_sizes() {
269			// Make thumbnails and other intermediate sizes.
270			$theme_image_sizes = wp_get_additional_image_sizes();
271
272			$sizes = [];
273			foreach ( get_intermediate_image_sizes() as $s ) {
274			$sizes[ $s ] = [ 'width' => '', 'height' => '', 'crop' => false ];
275			if ( isset( $theme_image_sizes[ $s ] ) ) {
276			// For theme-added sizes
277			$sizes[ $s ]['width'] = intval( $theme_image_sizes[ $s ]['width'] );
278			$sizes[ $s ]['height'] = intval( $theme_image_sizes[ $s ]['height'] );
279			$sizes[ $s ]['crop'] = $theme_image_sizes[ $s ]['crop'];
280			} else {
281			// For default sizes set in options
282			$sizes[ $s ]['width'] = get_option( "{$s}_size_w" );
283			$sizes[ $s ]['height'] = get_option( "{$s}_size_h" );
284			$sizes[ $s ]['crop'] = get_option( "{$s}_crop" );
285			}
286			}
287
288			return $sizes;
289			}
290			}
291
292			Images_Via_Imgix::instance();
293

imgix-wordpress / images-via-imgix

Pull Request — master (#18)

Images_Via_Imgix B

Complexity

Size/Duplication

Coupling/Cohesion

Importance

12 Methods

How to fix Complexity

Complex Class

Duplication Side-by-Side

Filter issues like