Images_Via_Imgix::image_downsize() - 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-24 10:03 UTC

Images_Via_Imgix::image_downsize() C

↳ Parent: Images_Via_Imgix

Complexity

Conditions	11
Paths	32

Size

Total Lines	39
Code Lines	24

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
cc	11
eloc	24
nc	32
nop	3
dl	0
loc	39
rs	5.2653
c	0
b	0
f	0

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( 'wp_calculate_image_srcset', [ $this, 'replace_host_in_srcset' ], 10 );
		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 ) ) {
				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 );

				$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 srcset to use imgix host.
	 *
	 * @param array $sources
	 *
	 * @return array $sources
	 */
	public function replace_host_in_srcset( $sources ) {
		foreach ( $sources as $source ) {
			$sources[ $source['value'] ]['url'] = apply_filters( 'imgix/add-image-url', $sources[ $source['value'] ]['url'] );
		}

		return $sources;
	}

	/**
	 * 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( 'wp_calculate_image_srcset', [ $this, 'replace_host_in_srcset' ], 10 );
38			add_filter( 'the_content', [ $this, 'replace_images_in_content' ] );
39			add_action( 'wp_head', [ $this, 'prefetch_cdn' ], 1 );
40
41			add_action( 'after_setup_theme', [ $this, 'buffer_start_for_retina' ] );
42			add_action( 'shutdown', [ $this, 'buffer_end_for_retina' ] );
43			}
44
45			/**
46			* Plugin loader instance.
47			*
48			* @return Images_Via_Imgix
49			*/
50			public static function instance() {
51			if ( ! isset( self::$instance ) ) {
52			self::$instance = new self;
53			}
54
55			return self::$instance;
56			}
57
58			/**
59			* Override options from settings.
60			* Used in unit tests.
61			*
62			* @param array $options
63			*/
64			public function set_options( $options ) {
65			$this->options = $options;
66			}
67
68			/**
69			* Find all img tags with sources matching "imgix.net" without the parameter
70			* "srcset" and add the "srcset" parameter to all those images, appending a new
71			* source using the "dpr=2" modifier.
72			*
73			* @param $content
74			*
75			* @return string Content with retina-enriched image tags.
76			*/
77			public function add_retina( $content ) {
78			$pattern = '/<img((?![^>]+srcset )([^>]*)';
79			$pattern .= 'src=[\'"]([^\'"]imgix.net[^\'"]\?[^\'"]w=[^\'"])[\'"]([^>])?)>/i';
80			$repl = '<img$2src="$3" srcset="${3}, ${3}&dpr=2 2x, ${3}&dpr=3 3x,"$4>';
81			$content = preg_replace( $pattern, $repl, $content );
82
83			return preg_replace( $pattern, $repl, $content );
84			}
85
86			/**
87			* Modify image urls for attachments to use imgix host.
88			*
89			* @param string $url
90			*
91			* @return string
92			*/
93			public function replace_image_url( $url ) {
94			if ( ! empty ( $this->options['cdn_link'] ) ) {
95			$pathinfo = pathinfo( $url );
96
97			if ( isset( $pathinfo['extension'] ) && in_array( $pathinfo['extension'], [
98			'jpg',
99			'gif',
100			'png',
101			'jpeg'
102			] )
103			) {
104			$parsed_url = parse_url( $url );
105			if ( isset( $parsed_url['host'] ) && $parsed_url['host'] === parse_url( home_url( '/' ), PHP_URL_HOST ) ) {
106			$cdn = parse_url( $this->options['cdn_link'] );
107			foreach ( [ 'scheme', 'host', 'port' ] as $url_part ) {
108			if ( isset( $cdn[ $url_part ] ) ) {
109			$parsed_url[ $url_part ] = $cdn[ $url_part ];
110			} else {
111			unset( $parsed_url[ $url_part ] );
112			}
113			}
114
115			$arguments = [];
116			if ( ! empty( $parsed_url['query'] ) ) {
117			parse_str( $parsed_url['query'], $arguments );
118			}
119			$arguments = array_merge( $arguments, $this->get_global_params() );
120
121			if ( ! empty( $arguments ) ) {
122			$parsed_url['query'] = build_query( urlencode_deep( $arguments ) );
123			}
124
125			$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 `104` 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...
126			}
127			}
128			}
129
130			return $url;
131			}
132
133			/**
134			* Set params when running image_downsize
135			*
136			* @param false\|array $return
137			* @param int $attachment_id
138			* @param string\|array $size
139			*
140			* @return false\|array
141			*/
142			public function image_downsize( $return, $attachment_id, $size ) {
143			if ( ! empty ( $this->options['cdn_link'] ) ) {
144			$img_url = wp_get_attachment_url( $attachment_id );
145			$parsed_url = parse_url( $img_url );
146
147			if ( is_array( $parsed_url ) ) {
148			parse_str( $parsed_url['query'], $params );
149
150			if ( is_array( $size ) ) {
151			$params['w'] = $width = isset( $size[0] ) ? $size[0] : 0;
152			$params['h'] = $height = isset( $size[1] ) ? $size[1] : 0;
153			} else {
154			$available_sizes = $this->get_all_defined_sizes();
155			if ( isset( $available_sizes[ $size ] ) ) {
156			$size = $available_sizes[ $size ];
157			$params['w'] = $width = $size['width'];
158			$params['h'] = $height = $size['height'];
159			}
160			}
161
162			$params = array_filter( $params );
163
164			$parsed_url['query'] = build_query( urlencode_deep( $params ) );
165
166			$img_url = http_build_url( $parsed_url );
167
168			if ( ! isset( $width ) \|\| ! isset( $height ) ) {
169			// any other type: use the real image
170			$meta = wp_get_attachment_metadata( $attachment_id );
171			$width = isset( $width ) ? $width : $meta['width'];
172			$height = isset( $height ) ? $height : $meta['height'];
173			}
174
175			$return = [ $img_url, $width, $height, true ];
176			}
177			}
178
179			return $return;
180			}
181
182			/**
183			* Modify image urls in srcset to use imgix host.
184			*
185			* @param array $sources
186			*
187			* @return array $sources
188			*/
189			public function replace_host_in_srcset( $sources ) {
190			foreach ( $sources as $source ) {
191			$sources[ $source['value'] ]['url'] = apply_filters( 'imgix/add-image-url', $sources[ $source['value'] ]['url'] );
192			}
193
194			return $sources;
195			}
196
197			/**
198			* Modify image urls in content to use imgix host.
199			*
200			* @param $content
201			*
202			* @return string
203			*/
204			public function replace_images_in_content( $content ) {
205			if ( ! empty ( $this->options['cdn_link'] ) ) {
206			$content = preg_replace_callback( '/(?<=\shref="\|\ssrc="\|\shref=\'\|\ssrc=\').*(?=\'\|")/', function ( $match ) {
207			return esc_url( apply_filters( 'imgix/add-image-url', $match[0] ) );
208			}, $content );
209
210			}
211
212			return $content;
213			}
214
215			/**
216			* Add tag to dns prefetch cdn host
217			*/
218			public function prefetch_cdn() {
219			if ( ! empty ( $this->options['cdn_link'] ) ) {
220			$host = parse_url( $this->options['cdn_link'], PHP_URL_HOST );
221
222			printf(
223			'<link rel="dns-prefetch" href="%s"/>',
224			esc_attr( '//' . $host )
225			);
226			}
227			}
228
229			/**
230			* Start output buffer if auto retina is enabled
231			*/
232			public function buffer_start_for_retina() {
233			if ( ! empty ( $this->options['add_dpi2_srcset'] ) ) {
234			$this->buffer_started = true;
235			ob_start( [ $this, 'add_retina' ] );
236			}
237			}
238
239			/**
240			* Stop output buffer if it was enabled by the plugin
241			*/
242			public function buffer_end_for_retina() {
243			if ( $this->buffer_started === true ) {
244			ob_end_flush();
245			}
246			}
247
248			/**
249			* Returns a array of global parameters to be applied in all images,
250			* according to plugin's settings.
251			*
252			* @return array Global parameters to be appened at the end of each img URL.
253			*/
254			protected function get_global_params() {
255			$params = [];
256
257			// For now, only "auto" is supported.
258			$auto = [];
259			if ( ! empty ( $this->options['auto_format'] ) ) {
260			array_push( $auto, 'format' );
261			}
262
263			if ( ! empty ( $this->options['auto_enhance'] ) ) {
264			array_push( $auto, 'enhance' );
265			}
266
267			if ( ! empty( $auto ) ) {
268			$params['auto'] = implode( '%2C', $auto );
269			}
270
271			return $params;
272			}
273
274			/**
275			* Get all defined image sizes
276			*
277			* @return array
278			*/
279			protected function get_all_defined_sizes() {
280			// Make thumbnails and other intermediate sizes.
281			$theme_image_sizes = wp_get_additional_image_sizes();
282
283			$sizes = [];
284			foreach ( get_intermediate_image_sizes() as $s ) {
285			$sizes[ $s ] = [ 'width' => '', 'height' => '', 'crop' => false ];
286			if ( isset( $theme_image_sizes[ $s ] ) ) {
287			// For theme-added sizes
288			$sizes[ $s ]['width'] = intval( $theme_image_sizes[ $s ]['width'] );
289			$sizes[ $s ]['height'] = intval( $theme_image_sizes[ $s ]['height'] );
290			$sizes[ $s ]['crop'] = $theme_image_sizes[ $s ]['crop'];
291			} else {
292			// For default sizes set in options
293			$sizes[ $s ]['width'] = get_option( "{$s}_size_w" );
294			$sizes[ $s ]['height'] = get_option( "{$s}_size_h" );
295			$sizes[ $s ]['crop'] = get_option( "{$s}_crop" );
296			}
297			}
298
299			return $sizes;
300			}
301			}
302
303			Images_Via_Imgix::instance();
304

imgix-wordpress / images-via-imgix

Pull Request — master (#18)

Images_Via_Imgix::image_downsize() C

Complexity

Size

Duplication

Importance

How to fix Complexity

Long Method

Duplication Side-by-Side

Filter issues like