| @@ -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.5 | |
| 7 | +Version: 1.0 | |
| 8 | 8 | Author: Lee Willis |
| 9 | 9 | Author URI: http://www.leewillis.co.uk/ |
| 10 | 10 | */ |
| 11 | 11 | |
| @@ -30,36 +30,20 @@ | ||
| 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 | - */ | |
| 40 | 34 | class github_embed { |
| 41 | 35 | |
| 42 | 36 | |
| 43 | 37 | |
| 44 | - private $api; | |
| 45 | - | |
| 46 | - | |
| 47 | - | |
| 48 | 38 | /** |
| 49 | 39 | * Constructor. Registers hooks and filters |
| 50 | - * @param class $api An instance of the github_api classs | |
| 51 | 40 | */ |
| 52 | - public function __construct ( $api ) { | |
| 41 | + public function __construct() { | |
| 53 | 42 | |
| 54 | - $this->api = $api; | |
| 43 | + add_action ( 'init', array ( $this, 'register_oembed_handler' ) ); | |
| 44 | + add_action ( 'init', array ( $this, 'maybe_handle_oembed' ) ); | |
| 55 | 45 | |
| 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 | - | |
| 62 | 46 | // @TODO i18n |
| 63 | 47 | |
| 64 | 48 | } |
| 65 | 49 | |
| @@ -65,55 +49,8 @@ | ||
| 65 | 49 | |
| 66 | 50 | |
| 67 | 51 | |
| 68 | 52 | /** |
| 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 | - | |
| 102 | - /** | |
| 103 | - * Enqueue the frontend CSS | |
| 104 | - * @return void | |
| 105 | - */ | |
| 106 | - function enqueue_styles() { | |
| 107 | - | |
| 108 | - wp_register_style ( 'github-embed', plugins_url(basename(dirname(__FILE__)).'/css/github-embed.css' ) ); | |
| 109 | - wp_enqueue_style ( 'github-embed' ); | |
| 110 | - | |
| 111 | - } | |
| 112 | - | |
| 113 | - | |
| 114 | - | |
| 115 | - /** | |
| 116 | 53 | * Register the oEmbed provider, and point it at a local endpoint since github |
| 117 | 54 | * doesn't directly support oEmbed yet. Our local endpoint will use the github |
| 118 | 55 | * API to fulfil the request. |
| 119 | 56 | * @param array $providers The current list of providers |
| @@ -120,12 +57,12 @@ | ||
| 120 | 57 | * @return array The list, with our new provider added |
| 121 | 58 | */ |
| 122 | 59 | public function register_oembed_handler() { |
| 123 | 60 | |
| 124 | - $oembed_url = home_url(); | |
| 61 | + $oembed_url = home_url (); | |
| 125 | 62 | $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 ); | |
| 63 | + $oembed_url = add_query_arg ( array ( 'github_oembed' => $key ), $oembed_url); | |
| 64 | + wp_oembed_add_provider ( '#https?://github.com/.*#i', $oembed_url, true ); | |
| 128 | 65 | |
| 129 | 66 | } |
| 130 | 67 | |
| 131 | 68 | |
| @@ -137,9 +74,9 @@ | ||
| 137 | 74 | */ |
| 138 | 75 | private function get_key() { |
| 139 | 76 | |
| 140 | 77 | $key = get_option ( 'github_oembed_key' ); |
| 141 | - | |
| 78 | + | |
| 142 | 79 | if ( ! $key ) { |
| 143 | 80 | $key = md5 ( time() . rand ( 0,65535 ) ); |
| 144 | 81 | add_option ( 'github_oembed_key', $key, '', 'yes' ); |
| 145 | 82 | } |
| @@ -171,9 +108,9 @@ | ||
| 171 | 108 | public function handle_oembed() { |
| 172 | 109 | |
| 173 | 110 | // Check this request is valid |
| 174 | 111 | if ( $_GET['github_oembed'] != $this->get_key() ) { |
| 175 | - header ( 'HTTP/1.0 403 Forbidden' ); | |
| 112 | + header ( 'HTTP/1.0 403 Forbidden' ); | |
| 176 | 113 | die ( 'Sad Octocat is sad.' ); |
| 177 | 114 | } |
| 178 | 115 | |
| 179 | 116 | // Check we have the required information |
| @@ -189,36 +126,12 @@ | ||
| 189 | 126 | header ( 'HTTP/1.0 404 Not Found' ); |
| 190 | 127 | die ( 'Octocat is lost, and afraid' ); |
| 191 | 128 | } |
| 192 | 129 | |
| 193 | - // Issues / Milestones | |
| 194 | - if ( preg_match ( '#https?://github.com/([^/]*)/([^/]*)/graphs/contributors/?$#i', $url, $matches ) && ! empty ( $matches[2] ) ) { | |
| 130 | + if ( preg_match ( '#https?://github.com/([^/]*)/([^/]*)/?$#i', $url, $matches ) && ! empty ( $matches[2] ) ) { | |
| 195 | 131 | |
| 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 ) ) { | |
| 201 | - $milestone = $milestones[1]; | |
| 202 | - } else { | |
| 203 | - $milestone = null; | |
| 204 | - } | |
| 205 | - | |
| 206 | - if ( $milestone ) { | |
| 207 | - $this->oembed_github_repo_milestone_summary ( $matches[1], $matches[2], $milestone ); | |
| 208 | - } | |
| 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 | - | |
| 213 | - $this->oembed_github_repo_milestone_summary( $matches[1], $matches[2], $matches[3] ); | |
| 214 | - | |
| 215 | - // Repository | |
| 216 | - } elseif ( preg_match ( '#https?://github.com/([^/]*)/([^/]*)/?$#i', $url, $matches ) && ! empty ( $matches[2] ) ) { | |
| 217 | - | |
| 218 | 132 | $this->oembed_github_repo ( $matches[1], $matches[2] ); |
| 219 | 133 | |
| 220 | - // User | |
| 221 | 134 | } elseif ( preg_match ( '#https?://github.com/([^/]*)/?$#i', $url, $matches ) ) { |
| 222 | 135 | |
| 223 | 136 | $this->oembed_github_author ( $matches[1] ); |
| 224 | 137 | |
| @@ -228,111 +141,39 @@ | ||
| 228 | 141 | |
| 229 | 142 | |
| 230 | 143 | |
| 231 | 144 | /** |
| 232 | - * Retrieve a list of contributors for a project | |
| 233 | - * @param string $owner The owner of the repository | |
| 234 | - * @param string $repository The repository name | |
| 145 | + * Retrieve the information from github for a repo, and | |
| 146 | + * output it as an oembed response | |
| 235 | 147 | */ |
| 236 | - private function oembed_github_repo_contributors ( $owner, $repository ) { | |
| 148 | + private function oembed_github_repo ( $owner, $repository ) { | |
| 237 | 149 | |
| 238 | - $repo = $this->api->get_repo ( $owner, $repository ); | |
| 239 | - $contributors = $this->api->get_repo_contributors ( $owner, $repository ); | |
| 150 | + $repository = trim ( $repository, '/' ); | |
| 240 | 151 | |
| 241 | - $response = new stdClass(); | |
| 242 | - $response->type = 'rich'; | |
| 243 | - $response->width = '10'; | |
| 244 | - $response->height = '10'; | |
| 245 | - $response->version = '1.0'; | |
| 246 | - $response->title = $repo->description; | |
| 152 | + $results = wp_remote_get( "https://api.github.com/repos/$owner/$repository", $args = array ( | |
| 153 | + 'user-agent' => 'WordPress Github oEmbed plugin - https://github.com/leewillis77/wp-github-oembed' ) ); | |
| 247 | 154 | |
| 248 | - $gravatar_size = apply_filters ( 'github_oembed_gravatar_size', 64 ); | |
| 249 | - | |
| 250 | - // @TODO This should all be templated | |
| 251 | - $response->html = '<div class="github-embed github-embed-repo-contributors">'; | |
| 252 | - $response->html .= '<p><a href="'.esc_attr($repo->html_url).'" target="_blank"><strong>'.esc_html($repo->description)."</strong></a><br/>"; | |
| 253 | - | |
| 254 | - $response->html .= '<span class="github-heading">Contributors: </span>'; | |
| 255 | - | |
| 256 | - $response->html .= '<ul class="github-repo-contributors">'; | |
| 257 | - | |
| 258 | - foreach ( $contributors as $contributor ) { | |
| 259 | - | |
| 260 | - $response->html .= '<li class="github-repo-contributor">'; | |
| 261 | - $response->html .= '<img class="github-repo-contributor-avatar" src="'; | |
| 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).'">'; | |
| 264 | - $response->html .= '<span class="github-repo-contributor-login">'; | |
| 265 | - $response->html .= '<a href="https://github.com/'.esc_attr($contributor->author->login).'">'.esc_attr($contributor->author->login).'</a></span>'; | |
| 155 | + if ( is_wp_error( $results ) || | |
| 156 | + ! isset ( $results['response']['code'] ) || | |
| 157 | + $results['response']['code'] != '200' ) { | |
| 158 | + header ( 'HTTP/1.0 404 Not Found' ); | |
| 159 | + die ( 'Octocat is lost, and afraid' ); | |
| 266 | 160 | } |
| 267 | 161 | |
| 268 | - $response->html .= '</ul>'; | |
| 269 | - $response->html .= '<div style="clear: both;"></div>'; | |
| 270 | - $response->html .= '</div>'; | |
| 162 | + $repo = json_decode ( $results['body'] ); | |
| 271 | 163 | |
| 272 | - header ( 'Content-Type: application/json' ); | |
| 273 | - echo json_encode ( $response ); | |
| 274 | - die(); | |
| 164 | + $results = wp_remote_get( "https://api.github.com/repos/$owner/$repository/commits", $args = array ( | |
| 165 | + 'user-agent' => 'WordPress Github oEmbed plugin - https://github.com/leewillis77/wp-github-oembed' ) ); | |
| 275 | 166 | |
| 276 | - } | |
| 277 | - | |
| 278 | - | |
| 279 | - | |
| 280 | - /** | |
| 281 | - * Retrieve the summary information for a repo's milestone, and | |
| 282 | - * output it as an oembed response | |
| 283 | - */ | |
| 284 | - private function oembed_github_repo_milestone_summary ( $owner, $repository, $milestone ) { | |
| 285 | - | |
| 286 | - $repo = $this->api->get_repo ( $owner, $repository ); | |
| 287 | - $summary = $this->api->get_repo_milestone_summary ( $owner, $repository, $milestone ); | |
| 288 | - | |
| 289 | - $response = new stdClass(); | |
| 290 | - $response->type = 'rich'; | |
| 291 | - $response->width = '10'; | |
| 292 | - $response->height = '10'; | |
| 293 | - $response->version = '1.0'; | |
| 294 | - $response->title = $repo->description; | |
| 295 | - | |
| 296 | - // @TODO This should all be templated | |
| 297 | - $response->html = '<div class="github-embed github-embed-milestone-summary">'; | |
| 298 | - $response->html .= '<p><a href="'.esc_attr($repo->html_url).'" target="_blank"><strong>'.esc_html($repo->description)."</strong></a><br/>"; | |
| 299 | - | |
| 300 | - $response->html .= '<span class="github-heading">Milestone: </span>'; | |
| 301 | - $response->html .= '<span class="github-milestone-title">'.esc_html($summary->title)."</span><br>"; | |
| 302 | - | |
| 303 | - $response->html .= '<span class="github-heading">Issues: </span>'; | |
| 304 | - $response->html .= '<span class="github-milestone-issues">'; | |
| 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>"; | |
| 307 | - | |
| 308 | - if ( ! empty ( $summary->due_on ) ) { | |
| 309 | - $response->html .= '<span class="github-heading">Due: </span>'; | |
| 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>'; | |
| 167 | + if ( is_wp_error( $results ) || | |
| 168 | + ! isset ( $results['response']['code'] ) || | |
| 169 | + $results['response']['code'] != '200' ) { | |
| 170 | + header ( 'HTTP/1.0 404 Not Found' ); | |
| 171 | + die ( 'Octocat is lost, and afraid' ); | |
| 312 | 172 | } |
| 313 | 173 | |
| 314 | - $response->html .= '<p class="github-milestone-description">'.nl2br(esc_html($summary->description))."</p><br>"; | |
| 315 | - $response->html .= '</div>'; | |
| 174 | + $commits = json_decode ( $results['body'] ); | |
| 316 | 175 | |
| 317 | - error_log( basename( __FILE__ ) . ': (' . __LINE__ . ') : response is ' . print_r( $response, 1 ) ); | |
| 318 | - header ( 'Content-Type: application/json' ); | |
| 319 | - echo json_encode ( $response ); | |
| 320 | - die(); | |
| 321 | - | |
| 322 | - } | |
| 323 | - | |
| 324 | - | |
| 325 | - | |
| 326 | - /** | |
| 327 | - * Retrieve the information from github for a repo, and | |
| 328 | - * output it as an oembed response | |
| 329 | - */ | |
| 330 | - private function oembed_github_repo ( $owner, $repository ) { | |
| 331 | - | |
| 332 | - $repo = $this->api->get_repo ( $owner, $repository ); | |
| 333 | - $commits =$this->api->get_repo_commits ( $owner, $repository ); | |
| 334 | - | |
| 335 | 176 | $response = new stdClass(); |
| 336 | 177 | $response->type = 'rich'; |
| 337 | 178 | $response->width = '10'; |
| 338 | 179 | $response->height = '10'; |
| @@ -339,14 +180,12 @@ | ||
| 339 | 180 | $response->version = '1.0'; |
| 340 | 181 | $response->title = $repo->description; |
| 341 | 182 | |
| 342 | 183 | // @TODO This should all be templated |
| 343 | - $response->html = '<div class="github-embed github-embed-repository">'; | |
| 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/>"; | |
| 184 | + $response->html = '<p><a href="'.esc_attr($repo->html_url).'" target="_blank"><strong>'.esc_html($repo->description)."</strong></a><br/>"; | |
| 185 | + $response->html .= esc_html($repo->html_url)."<br/>"; | |
| 186 | + $response->html .= esc_html($repo->forks_count)." forks.<br/>"; | |
| 187 | + $response->html .= esc_html($repo->open_issues_count)." open issues.<br/>"; | |
| 349 | 188 | |
| 350 | 189 | if ( count ( $commits ) ) { |
| 351 | 190 | |
| 352 | 191 | $cnt = 0; |
| @@ -361,9 +200,9 @@ | ||
| 361 | 200 | $response->html .= '<li class="github_commit">'; |
| 362 | 201 | $response->html .= '<a href="https://github.com/'.$owner.'/'.$repository.'/commit/'.esc_attr($commit->sha).'" target="_blank">'.esc_html($commit->commit->message)."</a>, "; |
| 363 | 202 | $response->html .= esc_html($commit->commit->committer->name); |
| 364 | 203 | $response->html .= '</li>'; |
| 365 | - | |
| 204 | + | |
| 366 | 205 | $cnt++; |
| 367 | 206 | |
| 368 | 207 | } |
| 369 | 208 | |
| @@ -370,9 +209,8 @@ | ||
| 370 | 209 | $response->html .= '</ul>'; |
| 371 | 210 | |
| 372 | 211 | } |
| 373 | 212 | $response->html .= '</p>'; |
| 374 | - $response->html .= '</div>'; | |
| 375 | 213 | |
| 376 | 214 | header ( 'Content-Type: application/json' ); |
| 377 | 215 | echo json_encode ( $response ); |
| 378 | 216 | die(); |
| @@ -386,10 +224,22 @@ | ||
| 386 | 224 | * it as an oembed response |
| 387 | 225 | */ |
| 388 | 226 | private function oembed_github_author ( $owner ) { |
| 389 | 227 | |
| 390 | - $owner_info = $this->api->get_user ( $owner ); | |
| 228 | + $owner = trim ( $owner, '/' ); | |
| 391 | 229 | |
| 230 | + $results = wp_remote_get( "https://api.github.com/users/$owner", $args = array ( | |
| 231 | + 'user-agent' => 'WordPress Github oEmbed plugin - https://github.com/leewillis77/wp-github-oembed' ) ); | |
| 232 | + | |
| 233 | + if ( is_wp_error( $results ) || | |
| 234 | + ! isset ( $results['response']['code'] ) || | |
| 235 | + $results['response']['code'] != '200' ) { | |
| 236 | + header ( 'HTTP/1.0 404 Not Found' ); | |
| 237 | + die ( 'Octocat is lost, and afraid' ); | |
| 238 | + } | |
| 239 | + | |
| 240 | + $owner_info = json_decode ( $results['body'] ); | |
| 241 | + | |
| 392 | 242 | $response = new stdClass(); |
| 393 | 243 | $response->type = 'rich'; |
| 394 | 244 | $response->width = '10'; |
| 395 | 245 | $response->height = '10'; |
| @@ -396,13 +246,11 @@ | ||
| 396 | 246 | $response->version = '1.0'; |
| 397 | 247 | $response->title = $owner_info->name; |
| 398 | 248 | |
| 399 | 249 | // @TODO This should all be templated |
| 400 | - $response->html = '<div class="github-embed github-embed-user">'; | |
| 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>'; | |
| 404 | - $response->html .= '</div>'; | |
| 250 | + $response->html = '<p><a href="https://github.com/'.esc_attr($owner).'" target="_blank"><strong>'.esc_html($owner)."</strong></a><br/>"; | |
| 251 | + $response->html .= esc_html($owner_info->public_repos).' repositories, '; | |
| 252 | + $response->html .= esc_html($owner_info->followers).' followers.</p>'; | |
| 405 | 253 | |
| 406 | 254 | header ( 'Content-Type: application/json' ); |
| 407 | 255 | echo json_encode ( $response ); |
| 408 | 256 | die(); |
| @@ -410,8 +258,5 @@ | ||
| 410 | 258 | } |
| 411 | 259 | |
| 412 | 260 | } |
| 413 | 261 | |
| 414 | -require_once ( 'github-api.php' ); | |
| 415 | - | |
| 416 | -$github_api = new github_api(); | |
| 417 | -$github_embed = new github_embed ( $github_api ); | |
| 262 | +$github_embed = new github_embed(); | |
