diff --git a/github-embed.php b/github-embed.php
index 948f50d..2cb0ac0 100644
--- a/github-embed.php
+++ b/github-embed.php
@@ -37,81 +37,58 @@ Author URI: http://www.leewillis.co.uk/
* class to retrieve the information from the GitHub API.
* @uses class github_api
*/
-class github_embed {
-
+class github_embed {
private $api;
-
-
/**
* Constructor. Registers hooks and filters
* @param class $api An instance of the github_api classs
*/
- public function __construct ( $api ) {
-
+ public function __construct( $api ) {
$this->api = $api;
-
- add_action( 'init', array ( $this, 'register_oembed_handler' ) );
+ 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' );
+ 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 );
-
+ $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' );
-
+ 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
@@ -120,123 +97,93 @@ class github_embed {
* @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' );
-
+ $key = get_option( 'github_oembed_key' );
if ( ! $key ) {
- $key = md5 ( time() . rand ( 0,65535 ) );
- add_option ( 'github_oembed_key', $key, '', 'yes' );
+ $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'] ) ) {
+ 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.' );
+ 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;
+ $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 ( ! empty( $format ) && 'json' !== $format ) {
+ 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' );
+ 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 ) ) {
+ 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 );
+ $this->oembed_github_repo_milestone_summary( $matches[1], $matches[2], $milestone );
}
-
- // New style milestone URL, e.g. https://github.com/example/example/milestone/1
- } elseif ( preg_match ( '#https?://github.com/([^/]*)/([^/]*)/milestone/([0-9]*)$#i', $url, $matches ) ) {
-
+ } elseif ( preg_match( '#https?://github.com/([^/]*)/([^/]*)/milestone/([0-9]*)$#i', $url, $matches ) ) {
+ // New style milestone URL, e.g. https://github.com/example/example/milestone/1.
$this->oembed_github_repo_milestone_summary( $matches[1], $matches[2], $matches[3] );
-
- // 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] );
-
+ } elseif ( preg_match( '#https?://github.com/([^/]*)/([^/]*)/?$#i', $url, $matches ) && ! empty( $matches[2] ) ) {
+ // Repository.
+ $this->oembed_github_repo( $matches[1], $matches[2] );
+ } elseif ( preg_match( '#https?://github.com/([^/]*)/?$#i', $url, $matches ) ) {
+ // User.
+ $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 );
+ 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';
@@ -245,46 +192,37 @@ class github_embed {
$response->version = '1.0';
$response->title = $repo->description;
- $gravatar_size = apply_filters ( 'github_oembed_gravatar_size', 64 );
+ $gravatar_size = apply_filters( 'github_oembed_gravatar_size', 64 );
// @TODO This should all be templated
$response->html = '';
-
- header ( 'Content-Type: application/json' );
- echo json_encode ( $response );
+ 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 );
+ 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';
@@ -295,42 +233,39 @@ class github_embed {
// @TODO This should all be templated
$response->html = '';
- $response->html .= '
'.esc_html($repo->description)."
";
+ $response->html .= '
' . esc_html( $repo->description ) . '
';
$response->html .= 'Milestone: ';
- $response->html .= ''.esc_html($summary->title)."
";
+ $response->html .= '' . esc_html( $summary->title ) . '
';
$response->html .= 'Issues: ';
$response->html .= '';
- $response->html .= esc_html ( number_format_i18n ( $summary->open_issues ) )." open, ";
- $response->html .= esc_html ( number_format_i18n ( $summary->closed_issues ) )." closed.
";
+ $response->html .= esc_html( number_format_i18n( $summary->open_issues ) ) . ' open, ';
+ $response->html .= esc_html( number_format_i18n( $summary->closed_issues ) ) . ' closed.
';
- if ( ! empty ( $summary->due_on ) ) {
+ if ( ! empty( $summary->due_on ) ) {
$response->html .= 'Due: ';
- $due_date = date_format ( date_create ( $summary->due_on ), 'jS F Y' );
- $response->html .= ''.esc_html($due_date).'
';
+ $due_date = date_format( date_create( $summary->due_on ), 'jS F Y' );
+ $response->html .= '' . esc_html( $due_date ) . '
';
}
- $response->html .= '
'.nl2br(esc_html($summary->description))."
";
+ $response->html .= '
' . nl2br( esc_html( $summary->description ) ) . '
';
$response->html .= '
';
- $response->html .= '
'.esc_html($owner)."
";
- $response->html .= esc_html ( number_format_i18n ( $owner_info->public_repos ) ).' repositories, ';
- $response->html .= esc_html ( number_format_i18n ( $owner_info->followers ) ).' followers.
';
+ $response->html .= '
' . esc_html( $owner ) . '
';
+ $response->html .= esc_html( number_format_i18n( $owner_info->public_repos ) ) . ' repositories, ';
+ $response->html .= esc_html( number_format_i18n( $owner_info->followers ) ) . ' followers.
';
$response->html .= '
'; + $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 .= ''; - $response->html .= ''.esc_attr($contributor->author->login).''; + $response->html .= '' . esc_attr( $contributor->author->login ) . ''; } - $response->html .= '