mirror of
https://ghproxy.net/https://github.com/fairpm/fair-plugin.git
synced 2025-09-04 10:32:01 +08:00
135 lines
3.5 KiB
PHP
135 lines
3.5 KiB
PHP
<?php
|
|
/**
|
|
* Configures the Credits API to fetch credits from local files.
|
|
*
|
|
* @package FAIR
|
|
*/
|
|
|
|
namespace FAIR\Credits;
|
|
|
|
use WP_Error;
|
|
|
|
const WP_CORE_LATEST_MAJOR_RELEASE = '6.8';
|
|
const JSON_BASE = __DIR__ . '/json/';
|
|
|
|
/**
|
|
* Bootstrap.
|
|
*/
|
|
function bootstrap() {
|
|
add_filter( 'pre_http_request', __NAMESPACE__ . '\\replace_credits_api', 10, 3 );
|
|
}
|
|
|
|
/**
|
|
* Respond to a Credits API request with a response from a local file.
|
|
*
|
|
* Supports Credits API versions 1.0 and 1.1.
|
|
*
|
|
* @param false|array|WP_Error $response Filtered response.
|
|
* @param array $parsed_args The request's arguments.
|
|
* @param string $url The request's URL.
|
|
* @return bool|array|WP_Error Replaced value, false to proceed, or WP_Error on failure.
|
|
*/
|
|
function replace_credits_api( $response, array $parsed_args, string $url ) {
|
|
if ( ! str_contains( $url, 'api.wordpress.org/core/credits/' ) ) {
|
|
return $response;
|
|
}
|
|
|
|
$major_version = get_major_version( $url );
|
|
if ( is_wp_error( $major_version ) ) {
|
|
return $major_version;
|
|
}
|
|
|
|
$credits = get_credits( $major_version );
|
|
if ( is_wp_error( $credits ) ) {
|
|
return $credits;
|
|
}
|
|
|
|
// Credits API 1.0 returns a serialized value rather than JSON.
|
|
if ( str_contains( $url, 'credits/1.0' ) ) {
|
|
$credits = serialize( json_decode( $credits, true ) );
|
|
}
|
|
|
|
return get_response( $credits );
|
|
}
|
|
|
|
/**
|
|
* Get the major version from the URL.
|
|
*
|
|
* Falls back to the currently installed major version if the version is not found in the URL.
|
|
*
|
|
* @param string $url The request's URL.
|
|
* @return string|WP_Error The major version string, or WP_Error on failure.
|
|
*/
|
|
function get_major_version( string $url ) {
|
|
// wp_get_wp_version() was introduced in 6.7.
|
|
$wp_version = function_exists( 'wp_get_wp_version' ) ? wp_get_wp_version() : $GLOBALS['wp_version'];
|
|
$version_parts = explode( '.', $wp_version );
|
|
$installed_major = $version_parts[0] . '.' . $version_parts[1];
|
|
|
|
$query = parse_url( $url, PHP_URL_QUERY );
|
|
if ( ! is_string( $query ) ) {
|
|
return $installed_major;
|
|
}
|
|
|
|
parse_str( $query, $params );
|
|
if ( ! isset( $params['version'] ) ) {
|
|
return $installed_major;
|
|
}
|
|
|
|
// Only the X.X major version is used by the Credits API.
|
|
if ( ! preg_match( '/^([0-9]+\.[0-9])/', $params['version'], $matches ) ) {
|
|
return new WP_Error(
|
|
'invalid_version',
|
|
sprintf(
|
|
/* translators: %s: The version string. */
|
|
__( '%s is not a valid version string.', 'fair' ),
|
|
$params['version']
|
|
)
|
|
);
|
|
}
|
|
|
|
return $matches[1];
|
|
}
|
|
|
|
/**
|
|
* Get the credits for a WordPress major version.
|
|
*
|
|
* @param string $major_version The WordPress major version string.
|
|
* @return string|WP_Error The credits in JSON format, or WP_Error on failure.
|
|
*/
|
|
function get_credits( string $major_version ) {
|
|
$file = JSON_BASE . $major_version . '.json';
|
|
if ( file_exists( $file ) ) {
|
|
return trim( file_get_contents( $file ) );
|
|
}
|
|
|
|
// The Credits API always falls back to the latest major version.
|
|
$fallback_file = JSON_BASE . WP_CORE_LATEST_MAJOR_RELEASE . '.json';
|
|
if ( file_exists( $fallback_file ) ) {
|
|
return trim( file_get_contents( $fallback_file ) );
|
|
}
|
|
|
|
return new WP_Error(
|
|
'no_credits_found',
|
|
__( 'No credits could be found.', 'fair' )
|
|
);
|
|
}
|
|
|
|
/**
|
|
* Mock an HTTP response for the Credits API with the local credits data.
|
|
*
|
|
* @param string $body The response's body.
|
|
* @return array The response.
|
|
*/
|
|
function get_response( string $body ) : array {
|
|
return [
|
|
'response' => [
|
|
'code' => 200,
|
|
'message' => 'OK',
|
|
],
|
|
'body' => $body,
|
|
'headers' => [],
|
|
'cookies' => [],
|
|
'http_response_code' => 200,
|
|
];
|
|
}
|
