gist.php ➔ jetpack_gist_get_shortcode_id() - Code Metrics - Inspection of "Add supported formats at the top of the file" - Automattic/jetpack - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — update/gist-phpcs ( 2bda06 )

by Jeremy

created 2019-04-19 07:23 UTC

gist.php ➔ jetpack_gist_get_shortcode_id() B

↳ Parent: Project

Complexity

Conditions	9
Paths	22

Size

Total Lines

Duplication

Lines	6
Ratio	12.5 %

Importance

Changes

Metric	Value
cc	9
nc	22
nop	1
dl	6
loc	48
rs	7.5789
c	0
b	0
f	0

<?php
/**
 * GitHub's Gist site supports oEmbed but their oembed provider only
 * returns raw HTML (no styling) and the first little bit of the code.
 *
 * Their JavaScript-based embed method is a lot better, so that's what we're using.
 *
 * Supported formats:
 * Full URL: https://gist.github.com/57cc50246aab776e110060926a2face2
 * Full URL with username: https://gist.github.com/jeherve/57cc50246aab776e110060926a2face2
 * Full URL linking to specific file: https://gist.github.com/jeherve/57cc50246aab776e110060926a2face2#file-wp-config-php
 * Full URL, no username, linking to specific file: https://gist.github.com/57cc50246aab776e110060926a2face2#file-wp-config-php
 * Gist ID: [gist]57cc50246aab776e110060926a2face2[/gist]
 * Gist ID within tag: [gist 57cc50246aab776e110060926a2face2]
 * Gist ID with username: [gist jeherve/57cc50246aab776e110060926a2face2]
 * Gist private ID with username: [gist xknown/fc5891af153e2cf365c9]
 *
 * @package Jetpack
 */

wp_embed_register_handler( 'github-gist', '#https?://gist\.github\.com/([a-zA-Z0-9/]+)(\#file\-[a-zA-Z0-9\_\-]+)?#', 'github_gist_embed_handler' );
add_shortcode( 'gist', 'github_gist_shortcode' );

/**
 * Handle gist embeds.
 *
 * @since 2.8.0
 *
 * @global WP_Embed $wp_embed
 *
 * @param array  $matches Results after parsing the URL using the regex in wp_embed_register_handler().
 * @param array  $attr    Embed attributes.
 * @param string $url     The original URL that was matched by the regex.
 * @param array  $rawattr The original unmodified attributes.
 * @return string The embed HTML.
 */
function github_gist_embed_handler( $matches, $attr, $url, $rawattr ) { // phpcs:ignore VariableAnalysis.CodeAnalysis.VariableAnalysis.UnusedVariable
	// Let the shortcode callback do all the work.
	return github_gist_shortcode( $matches, $url );
}

/**
 * Extract an ID from a Gist shortcode or a full Gist URL.
 *
 * @since 7.3.0
 *
 * @param string $gist Gist shortcode or full Gist URL.
 *
 * @return array $gist_info {
 * Array of information about our gist.
 *     @type string $id   Unique identifier for the gist.
 *     @type string $file File name if the gist links to a specific file.
 * }
 */
function jetpack_gist_get_shortcode_id( $gist = '' ) {
	$gist_info = array(
		'id'   => '',
		'file' => '',
	);
	// Simple shortcode, with just an ID.
	if ( ctype_alnum( $gist ) ) {
		$gist_info['id'] = $gist;
	}

	// Full URL? Only keep the relevant parts.
	$parsed_url = wp_parse_url( $gist );
	if (
		! empty( $parsed_url )
		&& is_array( $parsed_url )
		&& isset( $parsed_url['scheme'], $parsed_url['host'], $parsed_url['path'] )
	) {
		// Not a Gist URL? Bail.
		if ( 'gist.github.com' !== $parsed_url['host'] ) {
			return array(
				'id'   => '',
				'file' => '',
			);
		}

		// Keep the file name if there was one.
		if ( ! empty( $parsed_url['fragment'] ) ) {
			$gist_info['file'] = preg_replace( '/(?:file-)(.+)/', '$1', $parsed_url['fragment'] );
		}

		// Keep the unique identifier without any leading or trailing slashes.
		if ( ! empty( $parsed_url['path'] ) ) {
			$gist_info['id'] = preg_replace( '/(?:\/)([^\.]+)\./', '$1', $parsed_url['path'] );
			// Overwrite $gist with our identifier to clean it up below.
			$gist = $gist_info['id'];
		}
	}

	// Not a URL nor an ID? Only keep one of "username/id", "/username/id", "id".
	if ( preg_match( '#^/?(([a-z0-9-_]+/)?([a-z0-9]+))$#i', $gist, $matches ) ) {
		$gist_info['id'] = $matches[1];

		// If there is one, strip the GitHub username and only keep the ID.
		$gist_info['id'] = preg_replace( '#^.*/(?=[a-z0-9]+)#', '', $gist_info['id'] );
	}

	return $gist_info;
}

/**
 * Callback for gist shortcode.
 *
 * @since 2.8.0
 *
 * @param array  $atts Attributes found in the shortcode.
 * @param string $content Content enclosed by the shortcode.
 *
 * @return string The gist HTML.
 */
function github_gist_shortcode( $atts, $content = '' ) {

	if ( empty( $atts[0] ) && empty( $content ) ) {
		return '<!-- Missing Gist ID -->';
	}

	$id = ( ! empty( $content ) ) ? $content : $atts[0];

	// Parse a URL to get an ID we can use.
	$gist_info = jetpack_gist_get_shortcode_id( $id );
	if ( empty( $gist_info['id'] ) ) {
		return '<!-- Invalid Gist ID -->';
	} else {
		// Add trailing .json to all unique gist identifiers.
		$id = $gist_info['id'] . '.json';
	}

	// The file name can come from the URL passed, or from a shortcode attribute.
	if ( ! empty( $gist_info['file'] ) ) {
		$file = $gist_info['file'];
	} elseif ( ! empty( $atts['file'] ) ) {
		$file = $atts['file'];
	} else {
		$file = '';
	}

	// Replace - by . to get a real file name from slug.
	if ( ! empty( $file ) ) {
		$file = preg_replace( '/\-(?!.*\-)/', '.', $file );
		$file = rawurlencode( $file );
	}

	if (
		class_exists( 'Jetpack_AMP_Support' )
		&& Jetpack_AMP_Support::is_amp_request()
	) {
		/*
		 * According to <https://www.ampproject.org/docs/reference/components/amp-gist#height-(required)>:
		 *
		 * > Note: You must find the height of the gist by inspecting it with your browser (e.g., Chrome Developer Tools).
		 *
		 * However, this does not seem to be the case any longer. The actual height of the content does get set in the
		 * page after loading. So this is just the initial height.
		 * See <https://github.com/ampproject/amphtml/pull/17738>.
		 */
		$height = 240;

		$amp_tag = sprintf(
			'<amp-gist layout="fixed-height" data-gistid="%s" height="%s"',
			esc_attr( basename( $id, '.json' ) ),
			esc_attr( $height )
		);
		if ( ! empty( $file ) ) {
			$amp_tag .= sprintf( ' data-file="%s"', esc_attr( $file ) );
		}
		$amp_tag .= '></amp-gist>';
		return $amp_tag;
	}

	// URL points to the entire gist, including the file name if there was one.
	$id = ( ! empty( $file ) ? $id . '?file=' . $file : $id );

	wp_enqueue_script(
		'jetpack-gist-embed',
		Jetpack::get_file_url_for_environment( '_inc/build/shortcodes/js/gist.min.js', 'modules/shortcodes/js/gist.js' ),
		array( 'jquery' ),
		JETPACK__VERSION,
		true
	);

	// inline style to prevent the bottom margin to the embed that themes like TwentyTen, et al., add to tables.
	$return = '<style>.gist table { margin-bottom: 0; }</style><div class="gist-oembed" data-gist="' . esc_attr( $id ) . '"></div>';

	if (
		// No need to check for a nonce here, that's already handled by Core further up.
		// phpcs:disable WordPress.Security.NonceVerification.Missing
		isset( $_POST['type'] )
		&& 'embed' === $_POST['type']
		&& isset( $_POST['action'] )
		&& 'parse-embed' === $_POST['action']
		// phpcs:enable WordPress.Security.NonceVerification.Missing
	) {
		return github_gist_simple_embed( $id );
	}

	return $return;
}

/**
 * Use script tag to load shortcode in editor.
 * Can't use wp_enqueue_script here.
 *
 * @since 3.9.0
 *
 * @param string $id The ID of the gist.
 */
function github_gist_simple_embed( $id ) {
	$id = str_replace( 'json', 'js', $id );
	return '<script type="text/javascript" src="https://gist.github.com/' . $id . '"></script>'; // phpcs:ignore WordPress.WP.EnqueuedResources.NonEnqueuedScript
}


1		<?php
2		/**
3		* GitHub's Gist site supports oEmbed but their oembed provider only
4		* returns raw HTML (no styling) and the first little bit of the code.
5		*
6		* Their JavaScript-based embed method is a lot better, so that's what we're using.
7		*
8		* Supported formats:
9		* Full URL: https://gist.github.com/57cc50246aab776e110060926a2face2
10		* Full URL with username: https://gist.github.com/jeherve/57cc50246aab776e110060926a2face2
11		* Full URL linking to specific file: https://gist.github.com/jeherve/57cc50246aab776e110060926a2face2#file-wp-config-php
12		* Full URL, no username, linking to specific file: https://gist.github.com/57cc50246aab776e110060926a2face2#file-wp-config-php
13		* Gist ID: [gist]57cc50246aab776e110060926a2face2[/gist]
14		* Gist ID within tag: [gist 57cc50246aab776e110060926a2face2]
15		* Gist ID with username: [gist jeherve/57cc50246aab776e110060926a2face2]
16		* Gist private ID with username: [gist xknown/fc5891af153e2cf365c9]
17		*
18		* @package Jetpack
19		*/
20
21		wp_embed_register_handler( 'github-gist', '#https?://gist\.github\.com/([a-zA-Z0-9/]+)(\#file\-[a-zA-Z0-9\_\-]+)?#', 'github_gist_embed_handler' );
22		add_shortcode( 'gist', 'github_gist_shortcode' );
23
24		/**
25		* Handle gist embeds.
26		*
27		* @since 2.8.0
28		*
29		* @global WP_Embed $wp_embed
30		*
31		* @param array $matches Results after parsing the URL using the regex in wp_embed_register_handler().
32		* @param array $attr Embed attributes.
33		* @param string $url The original URL that was matched by the regex.
34		* @param array $rawattr The original unmodified attributes.
35		* @return string The embed HTML.
36		*/
37		function github_gist_embed_handler( $matches, $attr, $url, $rawattr ) { // phpcs:ignore VariableAnalysis.CodeAnalysis.VariableAnalysis.UnusedVariable
38		// Let the shortcode callback do all the work.
39		return github_gist_shortcode( $matches, $url );
40		}
41
42		/**
43		* Extract an ID from a Gist shortcode or a full Gist URL.
44		*
45		* @since 7.3.0
46		*
47		* @param string $gist Gist shortcode or full Gist URL.
48		*
49		* @return array $gist_info {
50		* Array of information about our gist.
51		* @type string $id Unique identifier for the gist.
52		* @type string $file File name if the gist links to a specific file.
53		* }
54		*/
55		function jetpack_gist_get_shortcode_id( $gist = '' ) {
56		$gist_info = array(
57		'id' => '',
58		'file' => '',
59		);
60		// Simple shortcode, with just an ID.
61		if ( ctype_alnum( $gist ) ) {
62		$gist_info['id'] = $gist;
63		}
64
65		// Full URL? Only keep the relevant parts.
66		$parsed_url = wp_parse_url( $gist );
67		if (
68		! empty( $parsed_url )
69		&& is_array( $parsed_url )
70		&& isset( $parsed_url['scheme'], $parsed_url['host'], $parsed_url['path'] )
71		) {
72		// Not a Gist URL? Bail.
73		if ( 'gist.github.com' !== $parsed_url['host'] ) {
74		return array(
75		'id' => '',
76		'file' => '',
77		);
78		}
79
80		// Keep the file name if there was one.
81		if ( ! empty( $parsed_url['fragment'] ) ) {
82		$gist_info['file'] = preg_replace( '/(?:file-)(.+)/', '$1', $parsed_url['fragment'] );
83		}
84
85		// Keep the unique identifier without any leading or trailing slashes.
86		if ( ! empty( $parsed_url['path'] ) ) {
87		$gist_info['id'] = preg_replace( '/(?:\/)([^\.]+)\./', '$1', $parsed_url['path'] );
88		// Overwrite $gist with our identifier to clean it up below.
89		$gist = $gist_info['id'];
90		}
91		}
92
93		// Not a URL nor an ID? Only keep one of "username/id", "/username/id", "id".
94	View Code Duplication	if ( preg_match( '#^/?(([a-z0-9-_]+/)?([a-z0-9]+))$#i', $gist, $matches ) ) {
95		$gist_info['id'] = $matches[1];
96
97		// If there is one, strip the GitHub username and only keep the ID.
98		$gist_info['id'] = preg_replace( '#^.*/(?=[a-z0-9]+)#', '', $gist_info['id'] );
99		}
100
101		return $gist_info;
102		}
103
104		/**
105		* Callback for gist shortcode.
106		*
107		* @since 2.8.0
108		*
109		* @param array $atts Attributes found in the shortcode.
110		* @param string $content Content enclosed by the shortcode.
111		*
112		* @return string The gist HTML.
113		*/
114		function github_gist_shortcode( $atts, $content = '' ) {
115
116		if ( empty( $atts[0] ) && empty( $content ) ) {
117		return '<!-- Missing Gist ID -->';
118		}
119
120		$id = ( ! empty( $content ) ) ? $content : $atts[0];
121
122		// Parse a URL to get an ID we can use.
123		$gist_info = jetpack_gist_get_shortcode_id( $id );
124		if ( empty( $gist_info['id'] ) ) {
125		return '<!-- Invalid Gist ID -->';
126		} else {
127		// Add trailing .json to all unique gist identifiers.
128		$id = $gist_info['id'] . '.json';
129		}
130
131		// The file name can come from the URL passed, or from a shortcode attribute.
132		if ( ! empty( $gist_info['file'] ) ) {
133		$file = $gist_info['file'];
134		} elseif ( ! empty( $atts['file'] ) ) {
135		$file = $atts['file'];
136		} else {
137		$file = '';
138		}
139
140		// Replace - by . to get a real file name from slug.
141		if ( ! empty( $file ) ) {
142		$file = preg_replace( '/\-(?!.*\-)/', '.', $file );
143		$file = rawurlencode( $file );
144		}
145
146		if (
147		class_exists( 'Jetpack_AMP_Support' )
148		&& Jetpack_AMP_Support::is_amp_request()
149		) {
150		/*
151		* According to <https://www.ampproject.org/docs/reference/components/amp-gist#height-(required)>:
152		*
153		* > Note: You must find the height of the gist by inspecting it with your browser (e.g., Chrome Developer Tools).
154		*
155		* However, this does not seem to be the case any longer. The actual height of the content does get set in the
156		* page after loading. So this is just the initial height.
157		* See <https://github.com/ampproject/amphtml/pull/17738>.
158		*/
159		$height = 240;
160
161		$amp_tag = sprintf(
162		'<amp-gist layout="fixed-height" data-gistid="%s" height="%s"',
163		esc_attr( basename( $id, '.json' ) ),
164		esc_attr( $height )
165		);
166		if ( ! empty( $file ) ) {
167		$amp_tag .= sprintf( ' data-file="%s"', esc_attr( $file ) );
168		}
169		$amp_tag .= '></amp-gist>';
170		return $amp_tag;
171		}
172
173		// URL points to the entire gist, including the file name if there was one.
174		$id = ( ! empty( $file ) ? $id . '?file=' . $file : $id );
175
176		wp_enqueue_script(
177		'jetpack-gist-embed',
178		Jetpack::get_file_url_for_environment( '_inc/build/shortcodes/js/gist.min.js', 'modules/shortcodes/js/gist.js' ),
179		array( 'jquery' ),
180		JETPACK__VERSION,
181		true
182		);
183
184		// inline style to prevent the bottom margin to the embed that themes like TwentyTen, et al., add to tables.
185		$return = '<style>.gist table { margin-bottom: 0; }</style><div class="gist-oembed" data-gist="' . esc_attr( $id ) . '"></div>';
186
187		if (
188		// No need to check for a nonce here, that's already handled by Core further up.
189		// phpcs:disable WordPress.Security.NonceVerification.Missing
190		isset( $_POST['type'] )
191		&& 'embed' === $_POST['type']
192		&& isset( $_POST['action'] )
193		&& 'parse-embed' === $_POST['action']
194		// phpcs:enable WordPress.Security.NonceVerification.Missing
195		) {
196		return github_gist_simple_embed( $id );
197		}
198
199		return $return;
200		}
201
202		/**
203		* Use script tag to load shortcode in editor.
204		* Can't use wp_enqueue_script here.
205		*
206		* @since 3.9.0
207		*
208		* @param string $id The ID of the gist.
209		*/
210		function github_gist_simple_embed( $id ) {
211		$id = str_replace( 'json', 'js', $id );
212		return '<script type="text/javascript" src="https://gist.github.com/' . $id . '"></script>'; // phpcs:ignore WordPress.WP.EnqueuedResources.NonEnqueuedScript
213		}
214

Automattic / jetpack

Push — update/gist-phpcs ( 2bda06 )

gist.php ➔ jetpack_gist_get_shortcode_id() B

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like