暫無描述

gist.php 8.3KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257
  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 automattic/jetpack
  19. */
  20. wp_embed_register_handler( 'github-gist', '#https?://gist\.github\.com/([a-zA-Z0-9/]+)(\#file\-[a-zA-Z0-9\_\-]+)?#', 'github_gist_embed_handler' );
  21. add_shortcode( 'gist', 'github_gist_shortcode' );
  22. /**
  23. * Handle gist embeds.
  24. *
  25. * @since 2.8.0
  26. *
  27. * @global WP_Embed $wp_embed
  28. *
  29. * @param array $matches Results after parsing the URL using the regex in wp_embed_register_handler().
  30. * @param array $attr Embed attributes.
  31. * @param string $url The original URL that was matched by the regex.
  32. * @param array $rawattr The original unmodified attributes.
  33. * @return string The embed HTML.
  34. */
  35. function github_gist_embed_handler( $matches, $attr, $url, $rawattr ) { // phpcs:ignore VariableAnalysis.CodeAnalysis.VariableAnalysis.UnusedVariable
  36. // Let the shortcode callback do all the work.
  37. return github_gist_shortcode( $matches, $url );
  38. }
  39. /**
  40. * Extract an ID from a Gist shortcode or a full Gist URL.
  41. *
  42. * @since 7.3.0
  43. *
  44. * @param string $gist Gist shortcode or full Gist URL.
  45. *
  46. * @return array $gist_info {
  47. * Array of information about our gist.
  48. * @type string $id Unique identifier for the gist.
  49. * @type string $file File name if the gist links to a specific file.
  50. * }
  51. */
  52. function jetpack_gist_get_shortcode_id( $gist = '' ) {
  53. $gist_info = array(
  54. 'id' => '',
  55. 'file' => '',
  56. 'ts' => 8,
  57. );
  58. // Simple shortcode, with just an ID.
  59. if ( ctype_alnum( $gist ) ) {
  60. $gist_info['id'] = $gist;
  61. }
  62. // Full URL? Only keep the relevant parts.
  63. $parsed_url = wp_parse_url( $gist );
  64. if (
  65. ! empty( $parsed_url )
  66. && is_array( $parsed_url )
  67. && isset( $parsed_url['scheme'], $parsed_url['host'], $parsed_url['path'] )
  68. ) {
  69. // Not a Gist URL? Bail.
  70. if ( 'gist.github.com' !== $parsed_url['host'] ) {
  71. return array(
  72. 'id' => '',
  73. 'file' => '',
  74. 'ts' => 8,
  75. );
  76. }
  77. // Keep the file name if there was one.
  78. if ( ! empty( $parsed_url['fragment'] ) ) {
  79. $gist_info['file'] = preg_replace( '/(?:file-)(.+)/', '$1', $parsed_url['fragment'] );
  80. }
  81. // Keep the unique identifier without any leading or trailing slashes.
  82. if ( ! empty( $parsed_url['path'] ) ) {
  83. $gist_info['id'] = trim( $parsed_url['path'], '/' );
  84. // Overwrite $gist with our identifier to clean it up below.
  85. $gist = $gist_info['id'];
  86. }
  87. // Parse the query args to obtain the tab spacing.
  88. if ( ! empty( $parsed_url['query'] ) ) {
  89. $query_args = array();
  90. wp_parse_str( $parsed_url['query'], $query_args );
  91. if ( ! empty( $query_args['ts'] ) ) {
  92. $gist_info['ts'] = absint( $query_args['ts'] );
  93. }
  94. }
  95. }
  96. // Not a URL nor an ID? Look for "username/id", "/username/id", or "id", and only keep the ID.
  97. if ( preg_match( '#^/?(([a-z0-9_-]+/)?([a-z0-9]+))$#i', $gist, $matches ) ) {
  98. $gist_info['id'] = $matches[3];
  99. }
  100. return $gist_info;
  101. }
  102. /**
  103. * Callback for gist shortcode.
  104. *
  105. * @since 2.8.0
  106. *
  107. * @param array $atts Attributes found in the shortcode.
  108. * @param string $content Content enclosed by the shortcode.
  109. *
  110. * @return string The gist HTML.
  111. */
  112. function github_gist_shortcode( $atts, $content = '' ) {
  113. if ( empty( $atts[0] ) && empty( $content ) ) {
  114. if ( current_user_can( 'edit_posts' ) ) {
  115. return esc_html__( 'Please specify a Gist URL or ID.', 'jetpack' );
  116. } else {
  117. return '<!-- Missing Gist ID -->';
  118. }
  119. }
  120. $id = ( ! empty( $content ) ) ? $content : $atts[0];
  121. // Parse a URL to get an ID we can use.
  122. $gist_info = jetpack_gist_get_shortcode_id( $id );
  123. if ( empty( $gist_info['id'] ) ) {
  124. if ( current_user_can( 'edit_posts' ) ) {
  125. return esc_html__( 'The Gist ID you provided is not valid. Please try a different one.', 'jetpack' );
  126. } else {
  127. return '<!-- Invalid Gist ID -->';
  128. }
  129. } else {
  130. // Add trailing .json to all unique gist identifiers.
  131. $id = $gist_info['id'] . '.json';
  132. }
  133. // The file name can come from the URL passed, or from a shortcode attribute.
  134. if ( ! empty( $gist_info['file'] ) ) {
  135. $file = $gist_info['file'];
  136. } elseif ( ! empty( $atts['file'] ) ) {
  137. $file = $atts['file'];
  138. } else {
  139. $file = '';
  140. }
  141. // Replace - by . to get a real file name from slug.
  142. if ( ! empty( $file ) ) {
  143. // Find the last -.
  144. $dash_position = strrpos( $file, '-' );
  145. if ( false !== $dash_position ) {
  146. // Replace the - by a period.
  147. $file = substr_replace( $file, '.', $dash_position, 1 );
  148. }
  149. $file = rawurlencode( $file );
  150. }
  151. // Set the tab size, allowing attributes to override the query string.
  152. $tab_size = $gist_info['ts'];
  153. if ( ! empty( $atts['ts'] ) ) {
  154. $tab_size = absint( $atts['ts'] );
  155. }
  156. if (
  157. class_exists( 'Jetpack_AMP_Support' )
  158. && Jetpack_AMP_Support::is_amp_request()
  159. ) {
  160. /*
  161. * According to <https://www.ampproject.org/docs/reference/components/amp-gist#height-(required)>:
  162. *
  163. * > Note: You must find the height of the gist by inspecting it with your browser (e.g., Chrome Developer Tools).
  164. *
  165. * However, this does not seem to be the case any longer. The actual height of the content does get set in the
  166. * page after loading. So this is just the initial height.
  167. * See <https://github.com/ampproject/amphtml/pull/17738>.
  168. */
  169. $height = 240;
  170. $amp_tag = sprintf(
  171. '<amp-gist layout="fixed-height" data-gistid="%s" height="%s"',
  172. esc_attr( basename( $id, '.json' ) ),
  173. esc_attr( $height )
  174. );
  175. if ( ! empty( $file ) ) {
  176. $amp_tag .= sprintf( ' data-file="%s"', esc_attr( $file ) );
  177. }
  178. $amp_tag .= '></amp-gist>';
  179. return $amp_tag;
  180. }
  181. // URL points to the entire gist, including the file name if there was one.
  182. $id = ( ! empty( $file ) ? $id . '?file=' . $file : $id );
  183. $return = false;
  184. $request = wp_remote_get( esc_url_raw( 'https://gist.github.com/' . esc_attr( $id ) ) );
  185. $request_code = wp_remote_retrieve_response_code( $request );
  186. if ( 200 === $request_code ) {
  187. $request_body = wp_remote_retrieve_body( $request );
  188. $request_data = json_decode( $request_body );
  189. wp_enqueue_style( 'jetpack-gist-styling', esc_url( $request_data->stylesheet ), array(), JETPACK__VERSION );
  190. $gist = substr_replace( $request_data->div, sprintf( 'style="tab-size: %1$s" ', absint( $tab_size ) ), 5, 0 );
  191. // Add inline styles for the tab style in the opening div of the gist.
  192. $gist = preg_replace(
  193. '#(\<div\s)+(id=\"gist[0-9]+\")+(\sclass=\"gist\"\>)?#',
  194. sprintf( '$1style="tab-size: %1$s" $2$3', absint( $tab_size ) ),
  195. $request_data->div,
  196. 1
  197. );
  198. // Add inline style to prevent the bottom margin to the embed that themes like TwentyTen, et al., add to tables.
  199. $return = sprintf( '<style>.gist table { margin-bottom: 0; }</style>%1$s', $gist );
  200. }
  201. if (
  202. // No need to check for a nonce here, that's already handled by Core further up.
  203. // phpcs:disable WordPress.Security.NonceVerification.Missing
  204. isset( $_POST['type'] )
  205. && 'embed' === $_POST['type']
  206. && isset( $_POST['action'] )
  207. && 'parse-embed' === $_POST['action']
  208. // phpcs:enable WordPress.Security.NonceVerification.Missing
  209. ) {
  210. return github_gist_simple_embed( $id, $tab_size );
  211. }
  212. return $return;
  213. }
  214. /**
  215. * Use script tag to load shortcode in editor.
  216. * Can't use wp_enqueue_script here.
  217. *
  218. * @since 3.9.0
  219. *
  220. * @param string $id The ID of the gist.
  221. * @param int $tab_size The tab size of the gist.
  222. * @return string The script tag of the gist.
  223. */
  224. function github_gist_simple_embed( $id, $tab_size = 8 ) {
  225. $id = str_replace( 'json', 'js', $id );
  226. return '<script src="' . esc_url( "https://gist.github.com/$id?ts=$tab_size" ) . '"></script>'; // phpcs:ignore WordPress.WP.EnqueuedResources.NonEnqueuedScript
  227. }