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