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