PluginProbe
Github Embed / 1.3
Github Embed v1.3
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 +259 -152 1.81.3 View file →
@@ -1,19 +1,20 @@
1 1 <?php
2 +
2 3 /*
3 4 Plugin Name: Github Embed
4 5 Plugin URI: http://www.leewillis.co.uk/wordpress-plugins
5 6 Description: Paste the URL to a Github project into your posts or pages, and have the project information pulled in and displayed automatically
6 -Version: 1.8
7 +Version: 1.3
7 8 Author: Lee Willis
8 9 Author URI: http://www.leewillis.co.uk/
9 10 */
10 11
11 12 /**
12 - * Copyright (c) 2013-2019 Lee Willis. All rights reserved.
13 + * Copyright (c) 2013 Lee Willis. All rights reserved.
13 14 *
14 - * Released under the GPL license v2
15 - * https://www.gnu.org/licenses/gpl-2.0.en.html
15 + * Released under the GPL license
16 + * http://www.opensource.org/licenses/gpl-license.php
16 17 *
17 18 * This is an add-on for WordPress
18 19 * http://wordpress.org/
19 20 *
@@ -37,74 +38,99 @@
37 38 * @uses class github_api
38 39 */
39 40 class github_embed {
40 41
42 +
43 +
41 44 private $api;
42 45
46 +
47 +
43 48 /**
44 49 * Constructor. Registers hooks and filters
45 - *
46 50 * @param class $api An instance of the github_api classs
47 51 */
48 - public function __construct( $api ) {
52 + public function __construct ( $api ) {
53 +
49 54 $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' ) );
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 +
55 62 // @TODO i18n
63 +
56 64 }
57 65
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 - }
67 - }
68 66
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 - }
81 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 +
82 102 /**
83 103 * Enqueue the frontend CSS
84 104 * @return void
85 105 */
86 106 function enqueue_styles() {
87 - wp_register_style( 'github-embed', plugins_url( basename( dirname( __FILE__ ) ) . '/css/github-embed.css' ) );
88 - wp_enqueue_style( 'github-embed' );
107 +
108 + wp_register_style ( 'github-embed', plugins_url(basename(dirname(__FILE__)).'/css/github-embed.css' ) );
109 + wp_enqueue_style ( 'github-embed' );
110 +
89 111 }
90 112
113 +
114 +
91 115 /**
92 116 * Register the oEmbed provider, and point it at a local endpoint since github
93 117 * doesn't directly support oEmbed yet. Our local endpoint will use the github
94 118 * API to fulfil the request.
95 - *
96 - * @param array $providers The current list of providers
97 - *
119 + * @param array $providers The current list of providers
98 120 * @return array The list, with our new provider added
99 121 */
100 122 public function register_oembed_handler() {
101 - $oembed_url = home_url();
102 - $key = $this->get_key();
103 - $oembed_url = add_query_arg( array( 'github_oembed' => $key ), $oembed_url );
104 - wp_oembed_add_provider( '#https?://github.com/.*#i', $oembed_url, true );
123 +
124 + $oembed_url = home_url ();
125 + $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 +
105 129 }
106 130
131 +
132 +
107 133 /**
108 134 * Generate a unique key that can be used on our requests to stop others
109 135 * hijacking our internal oEmbed API
110 136 * @return string The site key
@@ -109,17 +135,22 @@
109 135 * hijacking our internal oEmbed API
110 136 * @return string The site key
111 137 */
112 138 private function get_key() {
113 - $key = get_option( 'github_oembed_key' );
139 +
140 + $key = get_option ( 'github_oembed_key' );
141 +
114 142 if ( ! $key ) {
115 - $key = md5( time() . rand( 0, 65535 ) );
116 - add_option( 'github_oembed_key', $key, '', 'yes' );
143 + $key = md5 ( time() . rand ( 0,65535 ) );
144 + add_option ( 'github_oembed_key', $key, '', 'yes' );
117 145 }
118 146
119 147 return $key;
148 +
120 149 }
121 150
151 +
152 +
122 153 /**
123 154 * Check whether this is an oembed request, handle if it is
124 155 * Ignore it if not.
125 156 * Insert rant here about WP's lack of a front-end AJAX handler.
@@ -124,184 +155,260 @@
124 155 * Ignore it if not.
125 156 * Insert rant here about WP's lack of a front-end AJAX handler.
126 157 */
127 158 public function maybe_handle_oembed() {
128 - if ( isset( $_GET['github_oembed'] ) ) {
159 +
160 + if ( isset ( $_GET['github_oembed'] ) ) {
129 161 return $this->handle_oembed();
130 162 }
163 +
131 164 }
132 165
166 +
167 +
133 168 /**
134 169 * Handle an oembed request
135 170 */
136 171 public function handle_oembed() {
172 +
137 173 // Check this request is valid
138 - if ( $_GET['github_oembed'] !== $this->get_key() ) {
139 - header( 'HTTP/1.0 403 Forbidden' );
140 - die( 'Sad Octocat is sad.' );
174 + if ( $_GET['github_oembed'] != $this->get_key() ) {
175 + header ( 'HTTP/1.0 403 Forbidden' );
176 + die ( 'Sad Octocat is sad.' );
141 177 }
142 178
143 179 // Check we have the required information
144 - $url = isset( $_REQUEST['url'] ) ? $_REQUEST['url'] : null;
145 - $format = isset( $_REQUEST['format'] ) ? $_REQUEST['format'] : null;
180 + $url = isset ( $_REQUEST['url'] ) ? $_REQUEST['url'] : null;
181 + $format = isset ( $_REQUEST['format'] ) ? $_REQUEST['format'] : null;
146 182
147 - if ( ! empty( $format ) && 'json' !== $format ) {
148 - header( 'HTTP/1.0 501 Not implemented' );
149 - die( 'This octocat only does json' );
183 + if ( ! empty ( $format ) && $format != 'json' ) {
184 + header ( 'HTTP/1.0 501 Not implemented' );
185 + die ( 'This octocat only does json' );
150 186 }
151 187
152 188 if ( ! $url ) {
153 - header( 'HTTP/1.0 404 Not Found' );
154 - die( 'Octocat is lost, and afraid' );
189 + header ( 'HTTP/1.0 404 Not Found' );
190 + die ( 'Octocat is lost, and afraid' );
155 191 }
156 192
157 193 // Issues / Milestones
158 - if ( preg_match( '#https?://github.com/([^/]*)/([^/]*)/graphs/contributors/?$#i', $url, $matches ) && ! empty( $matches[2] ) ) {
159 - $this->oembed_github_repo_contributors( $matches[1], $matches[2] );
160 - } elseif ( preg_match( '#https?://github.com/([^/]*)/([^/]*)/issues.*$#i', $url, $matches ) && ! empty( $matches[2] ) ) {
161 - if ( preg_match( '#issues.?milestone=([0-9]*)#i', $url, $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 ) ) {
162 201 $milestone = $milestones[1];
163 202 } else {
164 203 $milestone = null;
165 204 }
205 +
166 206 if ( $milestone ) {
167 - $this->oembed_github_repo_milestone_summary( $matches[1], $matches[2], $milestone );
207 + $this->oembed_github_repo_milestone_summary ( $matches[1], $matches[2], $milestone );
168 208 }
169 - } elseif ( preg_match( '#https?://github.com/([^/]*)/([^/]*)/milestone/([0-9]*)$#i', $url, $matches ) ) {
170 - // New style milestone URL, e.g. https://github.com/example/example/milestone/1.
171 - $this->oembed_github_repo_milestone_summary( $matches[1], $matches[2], $matches[3] );
172 - } elseif ( preg_match( '#https?://github.com/([^/]*)/([^/]*)/?$#i', $url, $matches ) && ! empty( $matches[2] ) ) {
173 - // Repository.
174 - $this->oembed_github_repo( $matches[1], $matches[2] );
175 - } elseif ( preg_match( '#https?://github.com/([^/]*)/?$#i', $url, $matches ) ) {
176 - // User.
177 - $this->oembed_github_author( $matches[1] );
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 +
178 220 }
221 +
179 222 }
180 223
181 - /**
182 - * Capture then return output of template, provided theme or fallback to plugin default.
183 - *
184 - * @param string $template The template name to process.
185 - * @param string $data Array, object, or variable that the template needs.
186 - *
187 - * @return string
188 - */
189 - private function process_template( $template, $data ) {
190 - ob_start();
191 - if ( ! locate_template( 'wp-github-oembed/' . $template, true ) ) {
192 - require_once 'templates/' . $template;
193 - }
194 224
195 - return ob_get_clean();
196 - }
197 225
198 226 /**
199 227 * Retrieve a list of contributors for a project
200 - *
201 - * @param string $owner The owner of the repository
202 - * @param string $repository The repository name
228 + * @param string $owner The owner of the repository
229 + * @param string $repository The repository name
203 230 */
204 - private function oembed_github_repo_contributors( $owner, $repository ) {
205 - $data = [];
206 - $data['repo'] = $this->api->get_repo( $owner, $repository );
207 - $data['contributors'] = $this->api->get_repo_contributors( $owner, $repository );
208 - $data['gravatar_size'] = apply_filters( 'github_oembed_gravatar_size', 64 );
209 - $data['logo_class'] = apply_filters( 'wp_github_oembed_logo_class', 'github-logo-octocat' );
231 + private function oembed_github_repo_contributors ( $owner, $repository ) {
210 232
211 - $response = new stdClass();
212 - $response->type = 'rich';
213 - $response->width = '10';
214 - $response->height = '10';
233 + $repo = $this->api->get_repo ( $owner, $repository );
234 + $contributors = $this->api->get_repo_contributors ( $owner, $repository );
235 +
236 + $response = new stdClass();
237 + $response->type = 'rich';
238 + $response->width = '10';
239 + $response->height = '10';
215 240 $response->version = '1.0';
216 - $response->title = $data['repo']->description;
217 - $response->html = $this->process_template(
218 - 'repository_contributors.php', $data );
241 + $response->title = $repo->description;
219 242
220 - header( 'Content-Type: application/json' );
221 - echo json_encode( $response );
243 + $gravatar_size = apply_filters ( 'github_oembed_gravatar_size', 64 );
244 +
245 + // @TODO This should all be templated
246 + $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 +
249 + $response->html .= '<span class="github-heading">Contributors: </span>';
250 +
251 + $response->html .= '<ul class="github-repo-contributors">';
252 +
253 + foreach ( $contributors as $contributor ) {
254 +
255 + $details = $this->api->get_user ($contributor->login);
256 + $response->html .= '<li class="github-repo-contributor">';
257 + $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 + }
263 + $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>';
265 + }
266 +
267 + $response->html .= '</ul>';
268 + $response->html .= '<div style="clear: both;"></div>';
269 + $response->html .= '</div>';
270 +
271 + header ( 'Content-Type: application/json' );
272 + echo json_encode ( $response );
222 273 die();
274 +
223 275 }
224 276
277 +
278 +
225 279 /**
226 280 * Retrieve the summary information for a repo's milestone, and
227 281 * output it as an oembed response
228 282 */
229 - private function oembed_github_repo_milestone_summary( $owner, $repository, $milestone ) {
230 - $data = [];
231 - $data['repo'] = $this->api->get_repo( $owner, $repository );
232 - $data['summary'] = $this->api->get_repo_milestone_summary( $owner, $repository, $milestone );
233 - $data['logo_class'] = apply_filters( 'wp_github_oembed_logo_class', 'github-logo-octocat' );
283 + private function oembed_github_repo_milestone_summary ( $owner, $repository, $milestone ) {
234 284
235 - $response = new stdClass();
236 - $response->type = 'rich';
237 - $response->width = '10';
238 - $response->height = '10';
285 + $repo = $this->api->get_repo ( $owner, $repository );
286 + $summary = $this->api->get_repo_milestone_summary ( $owner, $repository, $milestone );
287 +
288 + $response = new stdClass();
289 + $response->type = 'rich';
290 + $response->width = '10';
291 + $response->height = '10';
239 292 $response->version = '1.0';
240 - $response->title = $data['repo']->description;
241 - $response->html = $this->process_template(
242 - 'repository_milestone_summary.php', $data );
293 + $response->title = $repo->description;
243 294
244 - header( 'Content-Type: application/json' );
245 - echo json_encode( $response );
295 + // @TODO This should all be templated
296 + $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/>";
298 +
299 + $response->html .= '<span class="github-heading">Milestone: </span>';
300 + $response->html .= '<span class="github-milestone-title">'.esc_html($summary->title)."</span><br>";
301 +
302 + $response->html .= '<span class="github-heading">Issues: </span>';
303 + $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>";
306 +
307 + if ( ! empty ( $summary->due_on ) ) {
308 + $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>';
311 + }
312 +
313 + $response->html .= '<p class="github-milestone-description">'.nl2br(esc_html($summary->description))."</p><br>";
314 + $response->html .= '</div>';
315 +
316 + header ( 'Content-Type: application/json' );
317 + echo json_encode ( $response );
246 318 die();
247 319
248 320 }
249 321
322 +
323 +
250 324 /**
251 325 * Retrieve the information from github for a repo, and
252 326 * output it as an oembed response
253 327 */
254 - private function oembed_github_repo( $owner, $repository ) {
255 - $data = [
256 - 'owner_slug' => $owner,
257 - 'repo_slug' => $repository,
258 - ];
259 - $data['repo'] = $this->api->get_repo( $owner, $repository );
260 - $data['commits'] = $this->api->get_repo_commits( $owner, $repository );
261 - $data['logo_class'] = apply_filters( 'wp_github_oembed_logo_class', 'github-logo-mark' );
328 + private function oembed_github_repo ( $owner, $repository ) {
262 329
263 - $response = new stdClass();
264 - $response->type = 'rich';
265 - $response->width = '10';
266 - $response->height = '10';
330 + $repo = $this->api->get_repo ( $owner, $repository );
331 + $commits =$this->api->get_repo_commits ( $owner, $repository );
332 +
333 + $response = new stdClass();
334 + $response->type = 'rich';
335 + $response->width = '10';
336 + $response->height = '10';
267 337 $response->version = '1.0';
268 - $response->title = $data['repo']->description;
269 - $response->html = $this->process_template(
270 - 'repository.php', $data );
338 + $response->title = $repo->description;
271 339
340 + // @TODO This should all be templated
341 + $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/>";
272 346
273 - header( 'Content-Type: application/json' );
274 - echo json_encode( $response );
347 + if ( count ( $commits ) ) {
348 +
349 + $cnt = 0;
350 + $response->html .= 'Recent commits:';
351 + $response->html .= '<ul class="github_commits">';
352 +
353 + foreach ( $commits as $commit ) {
354 +
355 + if ($cnt > 4)
356 + break;
357 +
358 + $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);
361 + $response->html .= '</li>';
362 +
363 + $cnt++;
364 +
365 + }
366 +
367 + $response->html .= '</ul>';
368 +
369 + }
370 + $response->html .= '</p>';
371 + $response->html .= '</div>';
372 +
373 + header ( 'Content-Type: application/json' );
374 + echo json_encode ( $response );
275 375 die();
376 +
276 377 }
277 378
379 +
380 +
278 381 /**
279 382 * Retrieve the information from github for an author, and output
280 383 * it as an oembed response
281 384 */
282 - private function oembed_github_author( $owner ) {
283 - $data = [];
284 - $data["owner"] = $owner;
285 - $data["owner_info"] = $this->api->get_user( $owner );
286 - $data["logo_class"] = apply_filters( 'wp_github_oembed_logo_class',
287 - 'github-logo-octocat' );
385 + private function oembed_github_author ( $owner ) {
288 386
289 - $response = new stdClass();
290 - $response->type = 'rich';
291 - $response->width = '10';
292 - $response->height = '10';
387 + $owner_info = $this->api->get_user ( $owner );
388 +
389 + $response = new stdClass();
390 + $response->type = 'rich';
391 + $response->width = '10';
392 + $response->height = '10';
293 393 $response->version = '1.0';
294 - $response->title = $data['owner_info']->name;
295 - $response->html = $this->process_template(
296 - 'author.php', $data );
394 + $response->title = $owner_info->name;
297 395
298 - header( 'Content-Type: application/json' );
299 - echo json_encode( $response );
396 + // @TODO This should all be templated
397 + $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>';
401 + $response->html .= '</div>';
402 +
403 + header ( 'Content-Type: application/json' );
404 + echo json_encode ( $response );
300 405 die();
406 +
301 407 }
408 +
302 409 }
303 410
304 -require_once( 'github-api.php' );
411 +require_once ( 'github-api.php' );
305 412
306 -$github_api = new github_api();
307 -$github_embed = new github_embed( $github_api );
413 +$github_api = new github_api();
414 +$github_embed = new github_embed ( $github_api );