PluginProbe
Github Embed / 1.7
Github Embed v1.7
trunk 1.0 1.1 1.2 1.3 1.4 1.5 1.6 1.7 1.8 1.9 2.0 2.0.1 2.0.2 2.1.0 2.2.0 2.2.1
← All changes | github-embed.php +192 -114 1.01.7 View file →
@@ -1,20 +1,19 @@
1 1 <?php
2 -
3 2 /*
4 3 Plugin Name: Github Embed
5 4 Plugin URI: http://www.leewillis.co.uk/wordpress-plugins
6 5 Description: Paste the URL to a Github project into your posts or pages, and have the project information pulled in and displayed automatically
7 -Version: 1.0
6 +Version: 1.7
8 7 Author: Lee Willis
9 8 Author URI: http://www.leewillis.co.uk/
10 9 */
11 10
12 11 /**
13 - * Copyright (c) 2013 Lee Willis. All rights reserved.
12 + * Copyright (c) 2013-2019 Lee Willis. All rights reserved.
14 13 *
15 - * Released under the GPL license
16 - * http://www.opensource.org/licenses/gpl-license.php
14 + * Released under the GPL license v2
15 + * https://www.gnu.org/licenses/gpl-2.0.en.html
17 16 *
18 17 * This is an add-on for WordPress
19 18 * http://wordpress.org/
20 19 *
@@ -30,25 +29,65 @@
30 29 * GNU General Public License for more details.
31 30 * **********************************************************************
32 31 */
33 32
33 +/**
34 + * This class handles being the oEmbed provider in terms of registering the URLs that
35 + * we can embed, and handling the actual oEmbed calls. It relies on the github_api
36 + * class to retrieve the information from the GitHub API.
37 + * @uses class github_api
38 + */
39 +
34 40 class github_embed {
35 41
42 + private $api;
36 43
37 -
38 44 /**
39 45 * Constructor. Registers hooks and filters
46 + * @param class $api An instance of the github_api classs
40 47 */
41 - public function __construct() {
42 -
43 - add_action ( 'init', array ( $this, 'register_oembed_handler' ) );
44 - add_action ( 'init', array ( $this, 'maybe_handle_oembed' ) );
45 -
48 + public function __construct( $api ) {
49 + $this->api = $api;
50 + add_action( 'init', array( $this, 'register_oembed_handler' ) );
51 + add_action( 'init', array( $this, 'maybe_handle_oembed' ) );
52 + add_action( 'wp_enqueue_scripts', array( $this, 'enqueue_styles' ) );
53 + add_action( 'admin_init', array( $this, 'schedule_expiry' ) );
54 + add_action( 'github_embed_cron', array( $this, 'cron' ) );
46 55 // @TODO i18n
56 + }
47 57
58 + /**
59 + * Make sure we have a scheduled event set to clear down the oEmbed cache until
60 + * WordPress supports cache_age in oEmbed responses.
61 + */
62 + function schedule_expiry() {
63 + if ( ! wp_next_scheduled( 'github_embed_cron' ) ) {
64 + $frequency = apply_filters( 'github_embed_cache_frequency', 'daily' );
65 + wp_schedule_event( time(), $frequency, 'github_embed_cron' );
66 + }
48 67 }
49 68
69 + /**
70 + * Expire old oEmbeds.
71 + * Note: This is a bit sledgehammer-to-crack-a-nut hence why I'm only running it
72 + * daily. Ideally WP should honour cache_age in oEmbed responses properly
73 + */
74 + function cron() {
75 + global $wpdb, $table_prefix;
76 + $sql = "DELETE
77 + FROM {$table_prefix}postmeta
78 + WHERE meta_key LIKE '_oembed_%'";
79 + $results = $wpdb->get_results( $sql );
80 + }
50 81
82 + /**
83 + * Enqueue the frontend CSS
84 + * @return void
85 + */
86 + function enqueue_styles() {
87 + wp_register_style( 'github-embed', plugins_url( basename( dirname( __FILE__ ) ) . '/css/github-embed.css' ) );
88 + wp_enqueue_style( 'github-embed' );
89 + }
51 90
52 91 /**
53 92 * Register the oEmbed provider, and point it at a local endpoint since github
54 93 * doesn't directly support oEmbed yet. Our local endpoint will use the github
@@ -56,18 +95,14 @@
56 95 * @param array $providers The current list of providers
57 96 * @return array The list, with our new provider added
58 97 */
59 98 public function register_oembed_handler() {
60 -
61 - $oembed_url = home_url ();
99 + $oembed_url = home_url();
62 100 $key = $this->get_key();
63 - $oembed_url = add_query_arg ( array ( 'github_oembed' => $key ), $oembed_url);
64 - wp_oembed_add_provider ( '#https?://github.com/.*#i', $oembed_url, true );
65 -
101 + $oembed_url = add_query_arg( array( 'github_oembed' => $key ), $oembed_url );
102 + wp_oembed_add_provider( '#https?://github.com/.*#i', $oembed_url, true );
66 103 }
67 104
68 -
69 -
70 105 /**
71 106 * Generate a unique key that can be used on our requests to stop others
72 107 * hijacking our internal oEmbed API
73 108 * @return string The site key
@@ -72,22 +107,16 @@
72 107 * hijacking our internal oEmbed API
73 108 * @return string The site key
74 109 */
75 110 private function get_key() {
76 -
77 - $key = get_option ( 'github_oembed_key' );
78 -
111 + $key = get_option( 'github_oembed_key' );
79 112 if ( ! $key ) {
80 - $key = md5 ( time() . rand ( 0,65535 ) );
81 - add_option ( 'github_oembed_key', $key, '', 'yes' );
113 + $key = md5( time() . rand( 0, 65535 ) );
114 + add_option( 'github_oembed_key', $key, '', 'yes' );
82 115 }
83 -
84 116 return $key;
85 -
86 117 }
87 118
88 -
89 -
90 119 /**
91 120 * Check whether this is an oembed request, handle if it is
92 121 * Ignore it if not.
93 122 * Insert rant here about WP's lack of a front-end AJAX handler.
@@ -92,87 +121,152 @@
92 121 * Ignore it if not.
93 122 * Insert rant here about WP's lack of a front-end AJAX handler.
94 123 */
95 124 public function maybe_handle_oembed() {
96 -
97 - if ( isset ( $_GET['github_oembed'] ) ) {
125 + if ( isset( $_GET['github_oembed'] ) ) {
98 126 return $this->handle_oembed();
99 127 }
100 -
101 128 }
102 129
103 -
104 -
105 130 /**
106 131 * Handle an oembed request
107 132 */
108 133 public function handle_oembed() {
109 -
110 134 // Check this request is valid
111 - if ( $_GET['github_oembed'] != $this->get_key() ) {
112 - header ( 'HTTP/1.0 403 Forbidden' );
113 - die ( 'Sad Octocat is sad.' );
135 + if ( $_GET['github_oembed'] !== $this->get_key() ) {
136 + header( 'HTTP/1.0 403 Forbidden' );
137 + die( 'Sad Octocat is sad.' );
114 138 }
115 139
116 140 // Check we have the required information
117 - $url = isset ( $_REQUEST['url'] ) ? $_REQUEST['url'] : null;
118 - $format = isset ( $_REQUEST['format'] ) ? $_REQUEST['format'] : null;
141 + $url = isset( $_REQUEST['url'] ) ? $_REQUEST['url'] : null;
142 + $format = isset( $_REQUEST['format'] ) ? $_REQUEST['format'] : null;
119 143
120 - if ( ! empty ( $format ) && $format != 'json' ) {
121 - header ( 'HTTP/1.0 501 Not implemented' );
122 - die ( 'This octocat only does json' );
144 + if ( ! empty( $format ) && 'json' !== $format ) {
145 + header( 'HTTP/1.0 501 Not implemented' );
146 + die( 'This octocat only does json' );
123 147 }
124 148
125 149 if ( ! $url ) {
126 - header ( 'HTTP/1.0 404 Not Found' );
127 - die ( 'Octocat is lost, and afraid' );
150 + header( 'HTTP/1.0 404 Not Found' );
151 + die( 'Octocat is lost, and afraid' );
128 152 }
129 153
130 - if ( preg_match ( '#https?://github.com/([^/]*)/([^/]*)/?$#i', $url, $matches ) && ! empty ( $matches[2] ) ) {
154 + // Issues / Milestones
155 + if ( preg_match( '#https?://github.com/([^/]*)/([^/]*)/graphs/contributors/?$#i', $url, $matches ) && ! empty( $matches[2] ) ) {
156 + $this->oembed_github_repo_contributors( $matches[1], $matches[2] );
157 + } elseif ( preg_match( '#https?://github.com/([^/]*)/([^/]*)/issues.*$#i', $url, $matches ) && ! empty( $matches[2] ) ) {
158 + if ( preg_match( '#issues.?milestone=([0-9]*)#i', $url, $milestones ) ) {
159 + $milestone = $milestones[1];
160 + } else {
161 + $milestone = null;
162 + }
163 + if ( $milestone ) {
164 + $this->oembed_github_repo_milestone_summary( $matches[1], $matches[2], $milestone );
165 + }
166 + } elseif ( preg_match( '#https?://github.com/([^/]*)/([^/]*)/milestone/([0-9]*)$#i', $url, $matches ) ) {
167 + // New style milestone URL, e.g. https://github.com/example/example/milestone/1.
168 + $this->oembed_github_repo_milestone_summary( $matches[1], $matches[2], $matches[3] );
169 + } elseif ( preg_match( '#https?://github.com/([^/]*)/([^/]*)/?$#i', $url, $matches ) && ! empty( $matches[2] ) ) {
170 + // Repository.
171 + $this->oembed_github_repo( $matches[1], $matches[2] );
172 + } elseif ( preg_match( '#https?://github.com/([^/]*)/?$#i', $url, $matches ) ) {
173 + // User.
174 + $this->oembed_github_author( $matches[1] );
175 + }
176 + }
131 177
132 - $this->oembed_github_repo ( $matches[1], $matches[2] );
178 + /**
179 + * Retrieve a list of contributors for a project
180 + * @param string $owner The owner of the repository
181 + * @param string $repository The repository name
182 + */
183 + private function oembed_github_repo_contributors( $owner, $repository ) {
184 + $repo = $this->api->get_repo( $owner, $repository );
185 + $contributors = $this->api->get_repo_contributors( $owner, $repository );
133 186
134 - } elseif ( preg_match ( '#https?://github.com/([^/]*)/?$#i', $url, $matches ) ) {
187 + $response = new stdClass();
188 + $response->type = 'rich';
189 + $response->width = '10';
190 + $response->height = '10';
191 + $response->version = '1.0';
192 + $response->title = $repo->description;
135 193
136 - $this->oembed_github_author ( $matches[1] );
194 + $gravatar_size = apply_filters( 'github_oembed_gravatar_size', 64 );
137 195
196 + // @TODO This should all be templated
197 + $logo_class = apply_filters( 'wp_github_oembed_logo_class', 'github-logo-octocat' );
198 + $response->html = '<div class="github-embed github-embed-repo-contributors ' . $logo_class . '">';
199 + $response->html .= '<p><a href="' . esc_attr( $repo->html_url ) . '" target="_blank">';
200 + $response->html .= '<strong>' . esc_html( $repo->description ) . '</strong></a><br/>';
201 + $response->html .= '<span class="github-heading">Contributors: </span>';
202 + $response->html .= '<ul class="github-repo-contributors">';
203 + foreach ( $contributors as $contributor ) {
204 + $response->html .= '<li class="github-repo-contributor">';
205 + $response->html .= '<img class="github-repo-contributor-avatar" src="';
206 + $response->html .= esc_url( add_query_arg( array( 's' => $gravatar_size ), $contributor->author->avatar_url ) );
207 + $response->html .= '" alt="Picture of ' . esc_attr( $contributor->author->login ) . '">';
208 + $response->html .= '<span class="github-repo-contributor-login">';
209 + $response->html .= '<a href="https://github.com/' . esc_attr( $contributor->author->login ) . '">' . esc_attr( $contributor->author->login ) . '</a></span>';
138 210 }
139 -
211 + $response->html .= '</ul>';
212 + $response->html .= '<div style="clear: both;"></div>';
213 + $response->html .= '</div>';
214 + header( 'Content-Type: application/json' );
215 + echo json_encode( $response );
216 + die();
140 217 }
141 218
142 -
143 -
144 219 /**
145 - * Retrieve the information from github for a repo, and
220 + * Retrieve the summary information for a repo's milestone, and
146 221 * output it as an oembed response
147 222 */
148 - private function oembed_github_repo ( $owner, $repository ) {
223 + private function oembed_github_repo_milestone_summary( $owner, $repository, $milestone ) {
224 + $repo = $this->api->get_repo( $owner, $repository );
225 + $summary = $this->api->get_repo_milestone_summary( $owner, $repository, $milestone );
149 226
150 - $repository = trim ( $repository, '/' );
227 + $response = new stdClass();
228 + $response->type = 'rich';
229 + $response->width = '10';
230 + $response->height = '10';
231 + $response->version = '1.0';
232 + $response->title = $repo->description;
151 233
152 - $results = wp_remote_get( "https://api.github.com/repos/$owner/$repository", $args = array (
153 - 'user-agent' => 'WordPress Github oEmbed plugin - https://github.com/leewillis77/wp-github-oembed' ) );
234 + // @TODO This should all be templated
235 + $logo_class = apply_filters( 'wp_github_oembed_logo_class', 'github-logo-octocat' );
236 + $response->html = '<div class="github-embed github-embed-milestone-summary ' . $logo_class . '">';
237 + $response->html .= '<p><a href="' . esc_attr( $repo->html_url ) . '" target="_blank"><strong>' . esc_html( $repo->description ) . '</strong></a><br/>';
154 238
155 - if ( is_wp_error( $results ) ||
156 - ! isset ( $results['response']['code'] ) ||
157 - $results['response']['code'] != '200' ) {
158 - header ( 'HTTP/1.0 404 Not Found' );
159 - die ( 'Octocat is lost, and afraid' );
239 + $response->html .= '<span class="github-heading">Milestone: </span>';
240 + $response->html .= '<span class="github-milestone-title">' . esc_html( $summary->title ) . '</span><br>';
241 +
242 + $response->html .= '<span class="github-heading">Issues: </span>';
243 + $response->html .= '<span class="github-milestone-issues">';
244 + $response->html .= esc_html( number_format_i18n( $summary->open_issues ) ) . ' open, ';
245 + $response->html .= esc_html( number_format_i18n( $summary->closed_issues ) ) . ' closed.</span><br>';
246 +
247 + if ( ! empty( $summary->due_on ) ) {
248 + $response->html .= '<span class="github-heading">Due: </span>';
249 + $due_date = date_format( date_create( $summary->due_on ), 'jS F Y' );
250 + $response->html .= '<span class="github-milestone-due-date">' . esc_html( $due_date ) . '</span><br>';
160 251 }
161 252
162 - $repo = json_decode ( $results['body'] );
253 + $response->html .= '<p class="github-milestone-description">' . nl2br( esc_html( $summary->description ) ) . '</p><br>';
254 + $response->html .= '</div>';
163 255
164 - $results = wp_remote_get( "https://api.github.com/repos/$owner/$repository/commits", $args = array (
165 - 'user-agent' => 'WordPress Github oEmbed plugin - https://github.com/leewillis77/wp-github-oembed' ) );
256 + header( 'Content-Type: application/json' );
257 + echo json_encode( $response );
258 + die();
166 259
167 - if ( is_wp_error( $results ) ||
168 - ! isset ( $results['response']['code'] ) ||
169 - $results['response']['code'] != '200' ) {
170 - header ( 'HTTP/1.0 404 Not Found' );
171 - die ( 'Octocat is lost, and afraid' );
172 - }
260 + }
173 261
174 - $commits = json_decode ( $results['body'] );
262 + /**
263 + * Retrieve the information from github for a repo, and
264 + * output it as an oembed response
265 + */
266 + private function oembed_github_repo ( $owner, $repository ) {
267 + $repo = $this->api->get_repo( $owner, $repository );
268 + $commits =$this->api->get_repo_commits( $owner, $repository );
175 269
176 270 $response = new stdClass();
177 271 $response->type = 'rich';
178 272 $response->width = '10';
@@ -180,46 +274,39 @@
180 274 $response->version = '1.0';
181 275 $response->title = $repo->description;
182 276
183 277 // @TODO This should all be templated
184 - $response->html = '<p><a href="'.esc_attr($repo->html_url).'" target="_blank"><strong>'.esc_html($repo->description)."</strong></a><br/>";
185 - $response->html .= esc_html($repo->html_url)."<br/>";
186 - $response->html .= esc_html($repo->forks_count)." forks.<br/>";
187 - $response->html .= esc_html($repo->open_issues_count)." open issues.<br/>";
278 + $logo_class = apply_filters( 'wp_github_oembed_logo_class', 'github-logo-mark' );
279 + $response->html = '<div class="github-embed github-embed-repository ' . $logo_class . '">';
280 + $response->html .= '<p><a href="' . esc_attr( $repo->html_url ) . '" target="_blank"><strong>' . esc_html( $repo->description ) . '</strong></a><br/>';
281 + $response->html .= '<a href="' . esc_attr( $repo->html_url ) . '" target="_blank">' . esc_html( $repo->html_url ) . '</a><br/>';
282 + $response->html .= '<a href="' . esc_attr( $repo->html_url . '/network' ) . '" target="_blank">' . esc_html( number_format_i18n( $repo->forks_count ) ) . '</a> forks.<br/>';
283 + $response->html .= '<a href="' . esc_attr( $repo->html_url . '/stargazers' ) . '" target="_blank">' . esc_html( number_format_i18n( $repo->stargazers_count ) ) . '</a> stars.<br/>';
284 + $response->html .= '<a href="' . esc_attr( $repo->html_url . '/issues' ) . '" target="_blank">' . esc_html( number_format_i18n( $repo->open_issues_count ) ) . '</a> open issues.<br/>';
188 285
189 - if ( count ( $commits ) ) {
190 -
286 + if ( count( $commits ) ) {
191 287 $cnt = 0;
192 288 $response->html .= 'Recent commits:';
193 289 $response->html .= '<ul class="github_commits">';
194 -
195 290 foreach ( $commits as $commit ) {
196 -
197 - if ($cnt > 4)
291 + if ( $cnt > 4 ) {
198 292 break;
199 -
293 + }
200 294 $response->html .= '<li class="github_commit">';
201 - $response->html .= '<a href="https://github.com/'.$owner.'/'.$repository.'/commit/'.esc_attr($commit->sha).'" target="_blank">'.esc_html($commit->commit->message)."</a>, ";
202 - $response->html .= esc_html($commit->commit->committer->name);
295 + $response->html .= '<a href="https://github.com/' . $owner . '/' . $repository . '/commit/' . esc_attr( $commit->sha ) . '" target="_blank">' . esc_html( $commit->commit->message ) . '</a>, ';
296 + $response->html .= esc_html( $commit->commit->committer->name );
203 297 $response->html .= '</li>';
204 -
205 298 $cnt++;
206 -
207 299 }
208 -
209 300 $response->html .= '</ul>';
210 -
211 301 }
212 302 $response->html .= '</p>';
213 -
214 - header ( 'Content-Type: application/json' );
215 - echo json_encode ( $response );
303 + $response->html .= '</div>';
304 + header( 'Content-Type: application/json' );
305 + echo json_encode( $response );
216 306 die();
217 -
218 307 }
219 308
220 -
221 -
222 309 /**
223 310 * Retrieve the information from github for an author, and output
224 311 * it as an oembed response
225 312 */
@@ -224,22 +311,10 @@
224 311 * it as an oembed response
225 312 */
226 313 private function oembed_github_author ( $owner ) {
227 314
228 - $owner = trim ( $owner, '/' );
315 + $owner_info = $this->api->get_user( $owner );
229 316
230 - $results = wp_remote_get( "https://api.github.com/users/$owner", $args = array (
231 - 'user-agent' => 'WordPress Github oEmbed plugin - https://github.com/leewillis77/wp-github-oembed' ) );
232 -
233 - if ( is_wp_error( $results ) ||
234 - ! isset ( $results['response']['code'] ) ||
235 - $results['response']['code'] != '200' ) {
236 - header ( 'HTTP/1.0 404 Not Found' );
237 - die ( 'Octocat is lost, and afraid' );
238 - }
239 -
240 - $owner_info = json_decode ( $results['body'] );
241 -
242 317 $response = new stdClass();
243 318 $response->type = 'rich';
244 319 $response->width = '10';
245 320 $response->height = '10';
@@ -246,17 +321,20 @@
246 321 $response->version = '1.0';
247 322 $response->title = $owner_info->name;
248 323
249 324 // @TODO This should all be templated
250 - $response->html = '<p><a href="https://github.com/'.esc_attr($owner).'" target="_blank"><strong>'.esc_html($owner)."</strong></a><br/>";
251 - $response->html .= esc_html($owner_info->public_repos).' repositories, ';
252 - $response->html .= esc_html($owner_info->followers).' followers.</p>';
253 -
254 - header ( 'Content-Type: application/json' );
255 - echo json_encode ( $response );
325 + $logo_class = apply_filters( 'wp_github_oembed_logo_class', 'github-logo-octocat' );
326 + $response->html = '<div class="github-embed github-embed-user ' . $logo_class . '">';
327 + $response->html .= '<p><a href="https://github.com/' . esc_attr( $owner ) . '" target="_blank"><strong>' . esc_html( $owner ) . '</strong></a><br/>';
328 + $response->html .= esc_html( number_format_i18n( $owner_info->public_repos ) ) . ' repositories, ';
329 + $response->html .= esc_html( number_format_i18n( $owner_info->followers ) ) . ' followers.</p>';
330 + $response->html .= '</div>';
331 + header( 'Content-Type: application/json' );
332 + echo json_encode( $response );
256 333 die();
257 -
258 334 }
335 +}
259 336
260 -}
337 +require_once( 'github-api.php' );
261 338
262 -$github_embed = new github_embed();
339 +$github_api = new github_api();
340 +$github_embed = new github_embed( $github_api );