PluginProbe
Github Embed / 1.1
Github Embed v1.1
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 +118 -175 1.61.1 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.1
8 8 Author: Lee Willis
9 9 Author URI: http://www.leewillis.co.uk/
10 10 */
11 11
@@ -30,56 +30,26 @@
30 30 * GNU General Public License for more details.
31 31 * **********************************************************************
32 32 */
33 33
34 -/**
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
37 - * class to retrieve the information from the GitHub API.
38 - * @uses class github_api
39 - */
34 +class github_embed {
40 35
41 -class github_embed {
42 36
43 - private $api;
44 37
45 38 /**
46 39 * Constructor. Registers hooks and filters
47 - * @param class $api An instance of the github_api classs
48 40 */
49 - public function __construct( $api ) {
50 - $this->api = $api;
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' ) );
41 + public function __construct() {
42 +
43 + add_action ( 'init', array ( $this, 'register_oembed_handler' ) );
44 + add_action ( 'init', array ( $this, 'maybe_handle_oembed' ) );
45 + add_action ( 'wp_enqueue_scripts', array ( $this, 'enqueue_styles' ) );
46 +
56 47 // @TODO i18n
48 +
57 49 }
58 50
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 - }
68 - }
69 51
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 - }
82 52
83 53 /**
84 54 * Enqueue the frontend CSS
85 55 * @return void
@@ -84,12 +54,16 @@
84 54 * Enqueue the frontend CSS
85 55 * @return void
86 56 */
87 57 function enqueue_styles() {
88 - wp_register_style( 'github-embed', plugins_url( basename( dirname( __FILE__ ) ) . '/css/github-embed.css' ) );
89 - wp_enqueue_style( 'github-embed' );
58 +
59 + wp_register_style ( 'github-embed', plugins_url(basename(dirname(__FILE__)).'/css/github-embed.css' ) );
60 + wp_enqueue_style ( 'github-embed' );
61 +
90 62 }
91 63
64 +
65 +
92 66 /**
93 67 * Register the oEmbed provider, and point it at a local endpoint since github
94 68 * doesn't directly support oEmbed yet. Our local endpoint will use the github
95 69 * API to fulfil the request.
@@ -96,14 +70,18 @@
96 70 * @param array $providers The current list of providers
97 71 * @return array The list, with our new provider added
98 72 */
99 73 public function register_oembed_handler() {
100 - $oembed_url = home_url();
74 +
75 + $oembed_url = home_url ();
101 76 $key = $this->get_key();
102 - $oembed_url = add_query_arg( array( 'github_oembed' => $key ), $oembed_url );
103 - wp_oembed_add_provider( '#https?://github.com/.*#i', $oembed_url, true );
77 + $oembed_url = add_query_arg ( array ( 'github_oembed' => $key ), $oembed_url);
78 + wp_oembed_add_provider ( '#https?://github.com/.*#i', $oembed_url, true );
79 +
104 80 }
105 81
82 +
83 +
106 84 /**
107 85 * Generate a unique key that can be used on our requests to stop others
108 86 * hijacking our internal oEmbed API
109 87 * @return string The site key
@@ -108,16 +86,22 @@
108 86 * hijacking our internal oEmbed API
109 87 * @return string The site key
110 88 */
111 89 private function get_key() {
112 - $key = get_option( 'github_oembed_key' );
90 +
91 + $key = get_option ( 'github_oembed_key' );
92 +
113 93 if ( ! $key ) {
114 - $key = md5( time() . rand( 0, 65535 ) );
115 - add_option( 'github_oembed_key', $key, '', 'yes' );
94 + $key = md5 ( time() . rand ( 0,65535 ) );
95 + add_option ( 'github_oembed_key', $key, '', 'yes' );
116 96 }
97 +
117 98 return $key;
99 +
118 100 }
119 101
102 +
103 +
120 104 /**
121 105 * Check whether this is an oembed request, handle if it is
122 106 * Ignore it if not.
123 107 * Insert rant here about WP's lack of a front-end AJAX handler.
@@ -122,150 +106,87 @@
122 106 * Ignore it if not.
123 107 * Insert rant here about WP's lack of a front-end AJAX handler.
124 108 */
125 109 public function maybe_handle_oembed() {
126 - if ( isset( $_GET['github_oembed'] ) ) {
110 +
111 + if ( isset ( $_GET['github_oembed'] ) ) {
127 112 return $this->handle_oembed();
128 113 }
114 +
129 115 }
130 116
117 +
118 +
131 119 /**
132 120 * Handle an oembed request
133 121 */
134 122 public function handle_oembed() {
123 +
135 124 // 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.' );
125 + if ( $_GET['github_oembed'] != $this->get_key() ) {
126 + header ( 'HTTP/1.0 403 Forbidden' );
127 + die ( 'Sad Octocat is sad.' );
139 128 }
140 129
141 130 // Check we have the required information
142 - $url = isset( $_REQUEST['url'] ) ? $_REQUEST['url'] : null;
143 - $format = isset( $_REQUEST['format'] ) ? $_REQUEST['format'] : null;
131 + $url = isset ( $_REQUEST['url'] ) ? $_REQUEST['url'] : null;
132 + $format = isset ( $_REQUEST['format'] ) ? $_REQUEST['format'] : null;
144 133
145 - if ( ! empty( $format ) && 'json' !== $format ) {
146 - header( 'HTTP/1.0 501 Not implemented' );
147 - die( 'This octocat only does json' );
134 + if ( ! empty ( $format ) && $format != 'json' ) {
135 + header ( 'HTTP/1.0 501 Not implemented' );
136 + die ( 'This octocat only does json' );
148 137 }
149 138
150 139 if ( ! $url ) {
151 - header( 'HTTP/1.0 404 Not Found' );
152 - die( 'Octocat is lost, and afraid' );
140 + header ( 'HTTP/1.0 404 Not Found' );
141 + die ( 'Octocat is lost, and afraid' );
153 142 }
154 143
155 - // 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 ) ) {
160 - $milestone = $milestones[1];
161 - } else {
162 - $milestone = null;
163 - }
164 - if ( $milestone ) {
165 - $this->oembed_github_repo_milestone_summary( $matches[1], $matches[2], $milestone );
166 - }
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] );
176 - }
177 - }
144 + if ( preg_match ( '#https?://github.com/([^/]*)/([^/]*)/?$#i', $url, $matches ) && ! empty ( $matches[2] ) ) {
178 145
179 - /**
180 - * Retrieve a list of contributors for a project
181 - * @param string $owner The owner of the repository
182 - * @param string $repository The repository name
183 - */
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 );
146 + $this->oembed_github_repo ( $matches[1], $matches[2] );
187 147
188 - $response = new stdClass();
189 - $response->type = 'rich';
190 - $response->width = '10';
191 - $response->height = '10';
192 - $response->version = '1.0';
193 - $response->title = $repo->description;
148 + } elseif ( preg_match ( '#https?://github.com/([^/]*)/?$#i', $url, $matches ) ) {
194 149
195 - $gravatar_size = apply_filters( 'github_oembed_gravatar_size', 64 );
150 + $this->oembed_github_author ( $matches[1] );
196 151
197 - // @TODO This should all be templated
198 - $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/>';
201 - $response->html .= '<span class="github-heading">Contributors: </span>';
202 - $response->html .= '<ul class="github-repo-contributors">';
203 - foreach ( $contributors as $contributor ) {
204 - $response->html .= '<li class="github-repo-contributor">';
205 - $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 ) . '">';
208 - $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>';
210 152 }
211 - $response->html .= '</ul>';
212 - $response->html .= '<div style="clear: both;"></div>';
213 - $response->html .= '</div>';
214 - header( 'Content-Type: application/json' );
215 - echo json_encode( $response );
216 - die();
153 +
217 154 }
218 155
156 +
157 +
219 158 /**
220 - * Retrieve the summary information for a repo's milestone, and
159 + * Retrieve the information from github for a repo, and
221 160 * output it as an oembed response
222 161 */
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 );
162 + private function oembed_github_repo ( $owner, $repository ) {
226 163
227 - $response = new stdClass();
228 - $response->type = 'rich';
229 - $response->width = '10';
230 - $response->height = '10';
231 - $response->version = '1.0';
232 - $response->title = $repo->description;
164 + $repository = trim ( $repository, '/' );
233 165
234 - // @TODO This should all be templated
235 - $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/>';
166 + $results = wp_remote_get( "https://api.github.com/repos/$owner/$repository", $args = array (
167 + 'user-agent' => 'WordPress Github oEmbed plugin - https://github.com/leewillis77/wp-github-oembed' ) );
237 168
238 - $response->html .= '<span class="github-heading">Milestone: </span>';
239 - $response->html .= '<span class="github-milestone-title">' . esc_html( $summary->title ) . '</span><br>';
240 -
241 - $response->html .= '<span class="github-heading">Issues: </span>';
242 - $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>';
245 -
246 - if ( ! empty( $summary->due_on ) ) {
247 - $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>';
169 + if ( is_wp_error( $results ) ||
170 + ! isset ( $results['response']['code'] ) ||
171 + $results['response']['code'] != '200' ) {
172 + header ( 'HTTP/1.0 404 Not Found' );
173 + die ( 'Octocat is lost, and afraid' );
250 174 }
251 175
252 - $response->html .= '<p class="github-milestone-description">' . nl2br( esc_html( $summary->description ) ) . '</p><br>';
253 - $response->html .= '</div>';
176 + $repo = json_decode ( $results['body'] );
254 177
255 - header( 'Content-Type: application/json' );
256 - echo json_encode( $response );
257 - die();
178 + $results = wp_remote_get( "https://api.github.com/repos/$owner/$repository/commits", $args = array (
179 + 'user-agent' => 'WordPress Github oEmbed plugin - https://github.com/leewillis77/wp-github-oembed' ) );
258 180
259 - }
181 + if ( is_wp_error( $results ) ||
182 + ! isset ( $results['response']['code'] ) ||
183 + $results['response']['code'] != '200' ) {
184 + header ( 'HTTP/1.0 404 Not Found' );
185 + die ( 'Octocat is lost, and afraid' );
186 + }
260 187
261 - /**
262 - * Retrieve the information from github for a repo, and
263 - * output it as an oembed response
264 - */
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 );
188 + $commits = json_decode ( $results['body'] );
268 189
269 190 $response = new stdClass();
270 191 $response->type = 'rich';
271 192 $response->width = '10';
@@ -274,37 +195,47 @@
274 195 $response->title = $repo->description;
275 196
276 197 // @TODO This should all be templated
277 198 $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/>';
199 + $response->html .= '<p><a href="'.esc_attr($repo->html_url).'" target="_blank"><strong>'.esc_html($repo->description)."</strong></a><br/>";
200 + $response->html .= '<a href="'.esc_attr($repo->html_url).'" target="_blank">'.esc_html($repo->html_url)."</a><br/>";
201 + $response->html .= esc_html($repo->forks_count)." forks.<br/>";
202 + $response->html .= esc_html($repo->open_issues_count)." open issues.<br/>";
283 203
284 - if ( count( $commits ) ) {
204 + if ( count ( $commits ) ) {
205 +
285 206 $cnt = 0;
286 207 $response->html .= 'Recent commits:';
287 208 $response->html .= '<ul class="github_commits">';
209 +
288 210 foreach ( $commits as $commit ) {
289 - if ( $cnt > 4 ) {
211 +
212 + if ($cnt > 4)
290 213 break;
291 - }
214 +
292 215 $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 );
216 + $response->html .= '<a href="https://github.com/'.$owner.'/'.$repository.'/commit/'.esc_attr($commit->sha).'" target="_blank">'.esc_html($commit->commit->message)."</a>, ";
217 + $response->html .= esc_html($commit->commit->committer->name);
295 218 $response->html .= '</li>';
219 +
296 220 $cnt++;
221 +
297 222 }
223 +
298 224 $response->html .= '</ul>';
225 +
299 226 }
300 227 $response->html .= '</p>';
301 228 $response->html .= '</div>';
302 - header( 'Content-Type: application/json' );
303 - echo json_encode( $response );
229 +
230 + header ( 'Content-Type: application/json' );
231 + echo json_encode ( $response );
304 232 die();
233 +
305 234 }
306 235
236 +
237 +
307 238 /**
308 239 * Retrieve the information from github for an author, and output
309 240 * it as an oembed response
310 241 */
@@ -309,10 +240,22 @@
309 240 * it as an oembed response
310 241 */
311 242 private function oembed_github_author ( $owner ) {
312 243
313 - $owner_info = $this->api->get_user( $owner );
244 + $owner = trim ( $owner, '/' );
314 245
246 + $results = wp_remote_get( "https://api.github.com/users/$owner", $args = array (
247 + 'user-agent' => 'WordPress Github oEmbed plugin - https://github.com/leewillis77/wp-github-oembed' ) );
248 +
249 + if ( is_wp_error( $results ) ||
250 + ! isset ( $results['response']['code'] ) ||
251 + $results['response']['code'] != '200' ) {
252 + header ( 'HTTP/1.0 404 Not Found' );
253 + die ( 'Octocat is lost, and afraid' );
254 + }
255 +
256 + $owner_info = json_decode ( $results['body'] );
257 +
315 258 $response = new stdClass();
316 259 $response->type = 'rich';
317 260 $response->width = '10';
318 261 $response->height = '10';
@@ -320,18 +263,18 @@
320 263 $response->title = $owner_info->name;
321 264
322 265 // @TODO This should all be templated
323 266 $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>';
267 + $response->html .= '<p><a href="https://github.com/'.esc_attr($owner).'" target="_blank"><strong>'.esc_html($owner)."</strong></a><br/>";
268 + $response->html .= esc_html($owner_info->public_repos).' repositories, ';
269 + $response->html .= esc_html($owner_info->followers).' followers.</p>';
327 270 $response->html .= '</div>';
328 - header( 'Content-Type: application/json' );
329 - echo json_encode( $response );
271 +
272 + header ( 'Content-Type: application/json' );
273 + echo json_encode ( $response );
330 274 die();
275 +
331 276 }
277 +
332 278 }
333 279
334 -require_once( 'github-api.php' );
335 -
336 -$github_api = new github_api();
337 -$github_embed = new github_embed( $github_api );
280 +$github_embed = new github_embed();