functions.photon.php ➔ jetpack_photon_support_text_widgets() - Code Metrics - Inspection of "4724-photon-for-text-widgets" - Automattic/jetpack - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — imFORZA-4724-photon-for-text-w... ( 4c60fa )

unknown

created 2017-02-17 03:34 UTC

functions.photon.php ➔ jetpack_photon_support_text_widgets() A

↳ Parent: Project

Complexity

Conditions	3
Paths	2

Size

Total Lines	6
Code Lines	4

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
cc	3
eloc	4
nc	2
nop	1
dl	0
loc	6
rs	9.4285
c	0
b	0
f	0

<?php

/**
 * Generates a Photon URL.
 *
 * @see http://developer.wordpress.com/docs/photon/
 *
 * @param string $image_url URL to the publicly accessible image you want to manipulate
 * @param array|string $args An array of arguments, i.e. array( 'w' => '300', 'resize' => array( 123, 456 ) ), or in string form (w=123&h=456)
 * @return string The raw final URL. You should run this through esc_url() before displaying it.
 */
function jetpack_photon_url( $image_url, $args = array(), $scheme = null ) {
	$image_url = trim( $image_url );

	if ( class_exists( 'Jetpack') ) {
		/**
		 * Disables Photon URL processing for local development
	 	 *
	 	 * @module photon
	 	 *
	 	 * @since 4.1.0
	 	 *
	 	 * @param bool false Result of Jetpack::is_development_mode.
	 	 */
		if ( true === apply_filters( 'jetpack_photon_development_mode', Jetpack::is_development_mode() ) ) {
			return $image_url;
		}
	}

	/**
	 * Allow specific image URls to avoid going through Photon.
	 *
	 * @module photon
	 *
	 * @since 3.2.0
	 *
	 * @param bool false Should the image be returned as is, without going through Photon. Default to false.
	 * @param string $image_url Image URL.
	 * @param array|string $args Array of Photon arguments.
	 * @param string|null $scheme Image scheme. Default to null.
	 */
	if ( false !== apply_filters( 'jetpack_photon_skip_for_url', false, $image_url, $args, $scheme ) ) {
		return $image_url;
	}

	/**
	 * Filter the original image URL before it goes through Photon.
	 *
	 * @module photon
	 *
	 * @since 1.9.0
	 *
	 * @param string $image_url Image URL.
	 * @param array|string $args Array of Photon arguments.
	 * @param string|null $scheme Image scheme. Default to null.
	 */
	$image_url = apply_filters( 'jetpack_photon_pre_image_url', $image_url, $args, $scheme );
	/**
	 * Filter the original Photon image parameters before Photon is applied to an image.
	 *
	 * @module photon
	 *
	 * @since 1.9.0
	 *
	 * @param array|string $args Array of Photon arguments.
	 * @param string $image_url Image URL.
	 * @param string|null $scheme Image scheme. Default to null.
	 */
	$args = apply_filters( 'jetpack_photon_pre_args', $args, $image_url, $scheme );

	if ( empty( $image_url ) )
		return $image_url;

	$image_url_parts = @jetpack_photon_parse_url( $image_url );

	// Unable to parse
	if ( ! is_array( $image_url_parts ) || empty( $image_url_parts['host'] ) || empty( $image_url_parts['path'] ) )
		return $image_url;

	if ( is_array( $args ) ){
		// Convert values that are arrays into strings
		foreach ( $args as $arg => $value ) {
			if ( is_array( $value ) ) {
				$args[$arg] = implode( ',', $value );
			}
		}

		// Encode values
		// See http://core.trac.wordpress.org/ticket/17923
		$args = rawurlencode_deep( $args );
	}

	/** This filter is documented below. */
	$custom_photon_url = apply_filters( 'jetpack_photon_domain', '', $image_url );
	$custom_photon_url = esc_url( $custom_photon_url );

	// You can't run a Photon URL through Photon again because query strings are stripped.
	// So if the image is already a Photon URL, append the new arguments to the existing URL.
	if (
		in_array( $image_url_parts['host'], array( 'i0.wp.com', 'i1.wp.com', 'i2.wp.com' ) )
		|| $image_url_parts['host'] === jetpack_photon_parse_url( $custom_photon_url, PHP_URL_HOST )
	) {
		$photon_url = add_query_arg( $args, $image_url );
		return jetpack_photon_url_scheme( $photon_url, $scheme );
	}

	/**
	 * Allow Photon to use query strings as well.
	 * By default, Photon doesn't support query strings so we ignore them and look only at the path.
	 * This setting is Photon Server dependent.
	 *
	 * @module photon
	 *
	 * @since 1.9.0
	 *
	 * @param bool false Should images using query strings go through Photon. Default is false.
	 * @param string $image_url_parts['host'] Image URL's host.
	 */
	if ( ! apply_filters( 'jetpack_photon_any_extension_for_domain', false, $image_url_parts['host'] ) ) {
		// Photon doesn't support query strings so we ignore them and look only at the path.
		// However some source images are served via PHP so check the no-query-string extension.
		// For future proofing, this is a blacklist of common issues rather than a whitelist.
		$extension = pathinfo( $image_url_parts['path'], PATHINFO_EXTENSION );
		if ( empty( $extension ) || in_array( $extension, array( 'php' ) ) )
			return $image_url;
	}

	$image_host_path = $image_url_parts['host'] . $image_url_parts['path'];

	// Figure out which CDN subdomain to use
	srand( crc32( $image_host_path ) );
	$subdomain = rand( 0, 2 );
	srand();

	/**
	 * Filters the domain used by the Photon module.
	 *
	 * @module photon
	 *
	 * @since 3.4.2
	 *
	 * @param string https://i{$subdomain}.wp.com Domain used by Photon. $subdomain is a random number between 0 and 2.
	 * @param string $image_url URL of the image to be photonized.
	 */
	$photon_domain = apply_filters( 'jetpack_photon_domain', "https://i{$subdomain}.wp.com", $image_url );
	$photon_domain = trailingslashit( esc_url( $photon_domain ) );
	$photon_url  = $photon_domain . $image_host_path;

	/**
	 * Add query strings to Photon URL.
	 * By default, Photon doesn't support query strings so we ignore them.
	 * This setting is Photon Server dependent.
	 *
	 * @module photon
	 *
	 * @since 1.9.0
	 *
	 * @param bool false Should query strings be added to the image URL. Default is false.
	 * @param string $image_url_parts['host'] Image URL's host.
	 */
	if ( isset( $image_url_parts['query'] ) && apply_filters( 'jetpack_photon_add_query_string_to_domain', false, $image_url_parts['host'] ) ) {
		$photon_url .= '?q=' . rawurlencode( $image_url_parts['query'] );
	}

	if ( $args ) {
		if ( is_array( $args ) ) {
			$photon_url = add_query_arg( $args, $photon_url );
		} else {
			// You can pass a query string for complicated requests but where you still want CDN subdomain help, etc.
			$photon_url .= '?' . $args;
		}
	}

	if ( isset( $image_url_parts['scheme'] ) && 'https' == $image_url_parts['scheme'] ) {
		$photon_url = add_query_arg( array( 'ssl' => 1 ), $photon_url );
	}

	return jetpack_photon_url_scheme( $photon_url, $scheme );
}
add_filter( 'jetpack_photon_url', 'jetpack_photon_url', 10, 3 );

/**
 * WordPress.com
 *
 * If a cropped WP.com-hosted image is the source image, have Photon replicate the crop.
 */
add_filter( 'jetpack_photon_pre_args', 'jetpack_photon_parse_wpcom_query_args', 10, 2 );

function jetpack_photon_parse_wpcom_query_args( $args, $image_url ) {
	$parsed_url = @parse_url( $image_url );

	if ( ! $parsed_url )
		return $args;

	$image_url_parts = wp_parse_args( $parsed_url, array(
		'host'  => '',
		'query' => ''
	) );

	if ( '.files.wordpress.com' != substr( $image_url_parts['host'], -20 ) )
		return $args;

	if ( empty( $image_url_parts['query'] ) )
		return $args;

	$wpcom_args = wp_parse_args( $image_url_parts['query'] );

	if ( empty( $wpcom_args['w'] ) || empty( $wpcom_args['h'] ) )
		return $args;

	// Keep the crop by using "resize"
	if ( ! empty( $wpcom_args['crop'] ) ) {
		if ( is_array( $args ) ) {
			$args = array_merge( array( 'resize' => array( $wpcom_args['w'], $wpcom_args['h'] ) ), $args );
		} else {
			$args = 'resize=' . rawurlencode( absint( $wpcom_args['w'] ) . ',' . absint( $wpcom_args['h'] ) ) . '&' . $args;
		}
	} else {
		if ( is_array( $args ) ) {
			$args = array_merge( array( 'fit' => array( $wpcom_args['w'], $wpcom_args['h'] ) ), $args );
		} else {
			$args = 'fit=' . rawurlencode( absint( $wpcom_args['w'] ) . ',' . absint( $wpcom_args['h'] ) ) . '&' . $args;
		}
	}

	return $args;
}


/**
 * Facebook
 */
add_filter( 'jetpack_photon_add_query_string_to_domain', 'jetpack_photon_allow_facebook_graph_domain', 10, 2 );
add_filter( 'jetpack_photon_any_extension_for_domain',   'jetpack_photon_allow_facebook_graph_domain', 10, 2 );

function jetpack_photon_url_scheme( $url, $scheme ) {
	if ( ! in_array( $scheme, array( 'http', 'https', 'network_path' ) ) ) {
		if ( preg_match( '#^(https?:)?//#', $url ) ) {
			return $url;
		}

		$scheme = 'http';
	}

	if ( 'network_path' == $scheme ) {
		$scheme_slashes = '//';
	} else {
		$scheme_slashes = "$scheme://";
	}

	return preg_replace( '#^([a-z:]+)?//#i', $scheme_slashes, $url );
}

function jetpack_photon_allow_facebook_graph_domain( $allow = false, $domain ) {
// $a must always be passed; it's default value is never used.
function someFunction($a = 5, $b) { }
	switch ( $domain ) {
	case 'graph.facebook.com' :
		return true;
	}

	return $allow;
}

/**
 * A wrapper for PHP's parse_url, prepending assumed scheme for network path
 * URLs. PHP versions 5.4.6 and earlier do not correctly parse without scheme.
 *
 * @see http://php.net/manual/en/function.parse-url.php#refsect1-function.parse-url-changelog
 *
 * @param string $url The URL to parse
 * @param integer $component Retrieve specific URL component
 * @return mixed Result of parse_url
 */
function jetpack_photon_parse_url( $url, $component = -1 ) {
	if ( 0 === strpos( $url, '//' ) ) {
		$url = ( is_ssl() ? 'https:' : 'http:' ) . $url;
	}

	return parse_url( $url, $component );
}

add_filter( 'jetpack_photon_skip_for_url', 'jetpack_photon_banned_domains', 9, 4 );
function jetpack_photon_banned_domains( $skip, $image_url, $args, $scheme ) {

	$banned_domains = array(
		'http://chart.googleapis.com/',
		'https://chart.googleapis.com/',
		'http://chart.apis.google.com/',
	);

	foreach ( $banned_domains as $banned_domain ) {
		if ( wp_startswith( $image_url, $banned_domain ) )
			return true;
	}

	return $skip;
}


/**
 * Jetpack Photon - Support Text Widgets.
 * 
 * @access public
 * @param string $content Content from text widget.
 * @return string
 */
function jetpack_photon_support_text_widgets( $content ) {
    if ( class_exists( 'Jetpack_Photon' ) && Jetpack::is_module_active( 'photon' ) ) {
        return Jetpack_Photon::filter_the_content( $content );
    }
	return $content;
}
add_filter( 'widget_text', 'jetpack_photon_support_text_widgets' );


1		<?php
2
3		/**
4		* Generates a Photon URL.
5		*
6		* @see http://developer.wordpress.com/docs/photon/
7		*
8		* @param string $image_url URL to the publicly accessible image you want to manipulate
9		* @param array\|string $args An array of arguments, i.e. array( 'w' => '300', 'resize' => array( 123, 456 ) ), or in string form (w=123&h=456)
10		* @return string The raw final URL. You should run this through esc_url() before displaying it.
11		*/
12		function jetpack_photon_url( $image_url, $args = array(), $scheme = null ) {
13		$image_url = trim( $image_url );
14
15		if ( class_exists( 'Jetpack') ) {
16		/**
17		* Disables Photon URL processing for local development
18		*
19		* @module photon
20		*
21		* @since 4.1.0
22		*
23		* @param bool false Result of Jetpack::is_development_mode.
24		*/
25		if ( true === apply_filters( 'jetpack_photon_development_mode', Jetpack::is_development_mode() ) ) {
26		return $image_url;
27		}
28		}
29
30		/**
31		* Allow specific image URls to avoid going through Photon.
32		*
33		* @module photon
34		*
35		* @since 3.2.0
36		*
37		* @param bool false Should the image be returned as is, without going through Photon. Default to false.
38		* @param string $image_url Image URL.
39		* @param array\|string $args Array of Photon arguments.
40		* @param string\|null $scheme Image scheme. Default to null.
41		*/
42		if ( false !== apply_filters( 'jetpack_photon_skip_for_url', false, $image_url, $args, $scheme ) ) {
43		return $image_url;
44		}
45
46		/**
47		* Filter the original image URL before it goes through Photon.
48		*
49		* @module photon
50		*
51		* @since 1.9.0
52		*
53		* @param string $image_url Image URL.
54		* @param array\|string $args Array of Photon arguments.
55		* @param string\|null $scheme Image scheme. Default to null.
56		*/
57		$image_url = apply_filters( 'jetpack_photon_pre_image_url', $image_url, $args, $scheme );
58		/**
59		* Filter the original Photon image parameters before Photon is applied to an image.
60		*
61		* @module photon
62		*
63		* @since 1.9.0
64		*
65		* @param array\|string $args Array of Photon arguments.
66		* @param string $image_url Image URL.
67		* @param string\|null $scheme Image scheme. Default to null.
68		*/
69		$args = apply_filters( 'jetpack_photon_pre_args', $args, $image_url, $scheme );
70
71		if ( empty( $image_url ) )
72		return $image_url;
73
74		$image_url_parts = @jetpack_photon_parse_url( $image_url );
75
76		// Unable to parse
77		if ( ! is_array( $image_url_parts ) \|\| empty( $image_url_parts['host'] ) \|\| empty( $image_url_parts['path'] ) )
78		return $image_url;
79
80		if ( is_array( $args ) ){
81		// Convert values that are arrays into strings
82		foreach ( $args as $arg => $value ) {
83		if ( is_array( $value ) ) {
84		$args[$arg] = implode( ',', $value );
85		}
86		}
87
88		// Encode values
89		// See http://core.trac.wordpress.org/ticket/17923
90		$args = rawurlencode_deep( $args );
91		}
92
93		/** This filter is documented below. */
94		$custom_photon_url = apply_filters( 'jetpack_photon_domain', '', $image_url );
95		$custom_photon_url = esc_url( $custom_photon_url );
96
97		// You can't run a Photon URL through Photon again because query strings are stripped.
98		// So if the image is already a Photon URL, append the new arguments to the existing URL.
99		if (
100		in_array( $image_url_parts['host'], array( 'i0.wp.com', 'i1.wp.com', 'i2.wp.com' ) )
101		\|\| $image_url_parts['host'] === jetpack_photon_parse_url( $custom_photon_url, PHP_URL_HOST )
102		) {
103		$photon_url = add_query_arg( $args, $image_url );
104		return jetpack_photon_url_scheme( $photon_url, $scheme );
105		}
106
107		/**
108		* Allow Photon to use query strings as well.
109		* By default, Photon doesn't support query strings so we ignore them and look only at the path.
110		* This setting is Photon Server dependent.
111		*
112		* @module photon
113		*
114		* @since 1.9.0
115		*
116		* @param bool false Should images using query strings go through Photon. Default is false.
117		* @param string $image_url_parts['host'] Image URL's host.
118		*/
119		if ( ! apply_filters( 'jetpack_photon_any_extension_for_domain', false, $image_url_parts['host'] ) ) {
120		// Photon doesn't support query strings so we ignore them and look only at the path.
121		// However some source images are served via PHP so check the no-query-string extension.
122		// For future proofing, this is a blacklist of common issues rather than a whitelist.
123		$extension = pathinfo( $image_url_parts['path'], PATHINFO_EXTENSION );
124		if ( empty( $extension ) \|\| in_array( $extension, array( 'php' ) ) )
125		return $image_url;
126		}
127
128		$image_host_path = $image_url_parts['host'] . $image_url_parts['path'];
129
130		// Figure out which CDN subdomain to use
131		srand( crc32( $image_host_path ) );
132		$subdomain = rand( 0, 2 );
133		srand();
134
135		/**
136		* Filters the domain used by the Photon module.
137		*
138		* @module photon
139		*
140		* @since 3.4.2
141		*
142		* @param string https://i{$subdomain}.wp.com Domain used by Photon. $subdomain is a random number between 0 and 2.
143		* @param string $image_url URL of the image to be photonized.
144		*/
145		$photon_domain = apply_filters( 'jetpack_photon_domain', "https://i{$subdomain}.wp.com", $image_url );
146		$photon_domain = trailingslashit( esc_url( $photon_domain ) );
147		$photon_url = $photon_domain . $image_host_path;
148
149		/**
150		* Add query strings to Photon URL.
151		* By default, Photon doesn't support query strings so we ignore them.
152		* This setting is Photon Server dependent.
153		*
154		* @module photon
155		*
156		* @since 1.9.0
157		*
158		* @param bool false Should query strings be added to the image URL. Default is false.
159		* @param string $image_url_parts['host'] Image URL's host.
160		*/
161		if ( isset( $image_url_parts['query'] ) && apply_filters( 'jetpack_photon_add_query_string_to_domain', false, $image_url_parts['host'] ) ) {
162		$photon_url .= '?q=' . rawurlencode( $image_url_parts['query'] );
163		}
164
165		if ( $args ) {
166		if ( is_array( $args ) ) {
167		$photon_url = add_query_arg( $args, $photon_url );
168		} else {
169		// You can pass a query string for complicated requests but where you still want CDN subdomain help, etc.
170		$photon_url .= '?' . $args;
171		}
172		}
173
174		if ( isset( $image_url_parts['scheme'] ) && 'https' == $image_url_parts['scheme'] ) {
175		$photon_url = add_query_arg( array( 'ssl' => 1 ), $photon_url );
176		}
177
178		return jetpack_photon_url_scheme( $photon_url, $scheme );
179		}
180		add_filter( 'jetpack_photon_url', 'jetpack_photon_url', 10, 3 );
181
182		/**
183		* WordPress.com
184		*
185		* If a cropped WP.com-hosted image is the source image, have Photon replicate the crop.
186		*/
187		add_filter( 'jetpack_photon_pre_args', 'jetpack_photon_parse_wpcom_query_args', 10, 2 );
188
189		function jetpack_photon_parse_wpcom_query_args( $args, $image_url ) {
190		$parsed_url = @parse_url( $image_url );
191
192		if ( ! $parsed_url )
193		return $args;
194
195		$image_url_parts = wp_parse_args( $parsed_url, array(
196		'host' => '',
197		'query' => ''
198		) );
199
200		if ( '.files.wordpress.com' != substr( $image_url_parts['host'], -20 ) )
201		return $args;
202
203		if ( empty( $image_url_parts['query'] ) )
204		return $args;
205
206		$wpcom_args = wp_parse_args( $image_url_parts['query'] );
207
208		if ( empty( $wpcom_args['w'] ) \|\| empty( $wpcom_args['h'] ) )
209		return $args;
210
211		// Keep the crop by using "resize"
212		if ( ! empty( $wpcom_args['crop'] ) ) {
213	View Code Duplication	if ( is_array( $args ) ) {
214		$args = array_merge( array( 'resize' => array( $wpcom_args['w'], $wpcom_args['h'] ) ), $args );
215		} else {
216		$args = 'resize=' . rawurlencode( absint( $wpcom_args['w'] ) . ',' . absint( $wpcom_args['h'] ) ) . '&' . $args;
217		}
218	View Code Duplication	} else {
219		if ( is_array( $args ) ) {
220		$args = array_merge( array( 'fit' => array( $wpcom_args['w'], $wpcom_args['h'] ) ), $args );
221		} else {
222		$args = 'fit=' . rawurlencode( absint( $wpcom_args['w'] ) . ',' . absint( $wpcom_args['h'] ) ) . '&' . $args;
223		}
224		}
225
226		return $args;
227		}
228
229
230		/**
231		* Facebook
232		*/
233		add_filter( 'jetpack_photon_add_query_string_to_domain', 'jetpack_photon_allow_facebook_graph_domain', 10, 2 );
234		add_filter( 'jetpack_photon_any_extension_for_domain', 'jetpack_photon_allow_facebook_graph_domain', 10, 2 );
235
236		function jetpack_photon_url_scheme( $url, $scheme ) {
237		if ( ! in_array( $scheme, array( 'http', 'https', 'network_path' ) ) ) {
238		if ( preg_match( '#^(https?:)?//#', $url ) ) {
239		return $url;
240		}
241
242		$scheme = 'http';
243		}
244
245		if ( 'network_path' == $scheme ) {
246		$scheme_slashes = '//';
247		} else {
248		$scheme_slashes = "$scheme://";
249		}
250
251		return preg_replace( '#^([a-z:]+)?//#i', $scheme_slashes, $url );
252		}
253
254		function jetpack_photon_allow_facebook_graph_domain( $allow = false, $domain ) {
		0 ignored issues – show Coding Style introduced 2015-11-20 23:04 UTC by Report Bug Copy Issue Report Parameters which have default values should be placed at the end. If you place a parameter with a default value before a parameter with a default value, the default value of the first parameter will never be used as it will always need to be passed anyway: // $a must always be passed; it's default value is never used. function someFunction($a = 5, $b) { } Loading history...
255		switch ( $domain ) {
256		case 'graph.facebook.com' :
257		return true;
258		}
259
260		return $allow;
261		}
262
263		/**
264		* A wrapper for PHP's parse_url, prepending assumed scheme for network path
265		* URLs. PHP versions 5.4.6 and earlier do not correctly parse without scheme.
266		*
267		* @see http://php.net/manual/en/function.parse-url.php#refsect1-function.parse-url-changelog
268		*
269		* @param string $url The URL to parse
270		* @param integer $component Retrieve specific URL component
271		* @return mixed Result of parse_url
272		*/
273		function jetpack_photon_parse_url( $url, $component = -1 ) {
274		if ( 0 === strpos( $url, '//' ) ) {
275		$url = ( is_ssl() ? 'https:' : 'http:' ) . $url;
276		}
277
278		return parse_url( $url, $component );
279		}
280
281		add_filter( 'jetpack_photon_skip_for_url', 'jetpack_photon_banned_domains', 9, 4 );
282		function jetpack_photon_banned_domains( $skip, $image_url, $args, $scheme ) {
		0 ignored issues – show Unused Code introduced 2015-11-20 23:03 UTC by Report Bug Copy Issue Report The parameter `$args` 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... Unused Code introduced 2015-11-20 23:03 UTC by Report Bug Copy Issue Report The parameter `$scheme` 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...
283		$banned_domains = array(
284		'http://chart.googleapis.com/',
285		'https://chart.googleapis.com/',
286		'http://chart.apis.google.com/',
287		);
288
289		foreach ( $banned_domains as $banned_domain ) {
290		if ( wp_startswith( $image_url, $banned_domain ) )
291		return true;
292		}
293
294		return $skip;
295		}
296
297
298		/**
299		* Jetpack Photon - Support Text Widgets.
300		*
301		* @access public
302		* @param string $content Content from text widget.
303		* @return string
304		*/
305		function jetpack_photon_support_text_widgets( $content ) {
306		if ( class_exists( 'Jetpack_Photon' ) && Jetpack::is_module_active( 'photon' ) ) {
307		return Jetpack_Photon::filter_the_content( $content );
308		}
309		return $content;
310		}
311		add_filter( 'widget_text', 'jetpack_photon_support_text_widgets' );
312

Automattic / jetpack

Push — imFORZA-4724-photon-for-text-w... ( 4c60fa )

functions.photon.php ➔ jetpack_photon_support_text_widgets() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like