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