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