mirror of
https://gh.wpcy.net/https://github.com/Anyape/updatepulse-server-integration.git
synced 2026-07-14 13:58:44 +08:00
356 lines
15 KiB
PHP
356 lines
15 KiB
PHP
<?php // phpcs:ignore WordPress.Files.FileName.InvalidClassFileName
|
|
|
|
### EXAMPLE INTEGRATION WITH UPDATEPULSE SERVER ###
|
|
|
|
# DO NOT USE THIS FILE AS IT IS IN PRODUCTION !!!
|
|
# It is just a collection of basic functions and snippets, and they do not
|
|
# perform the necessary checks to ensure data integrity; they assume that all
|
|
# the requests are successful, and do not check paths or permissions.
|
|
# They also assume that the package necessitates a license key.
|
|
|
|
# replace https://server.domain.tld/ with the URL of the server where
|
|
# UpdatePulse Server is installed in updatepulse.json
|
|
|
|
class UpdatePulse_API {
|
|
public static $package_name;
|
|
private static $config;
|
|
private static $url;
|
|
private static $package_script;
|
|
private static $version;
|
|
private static $license_key;
|
|
private static $license_signature;
|
|
private static $domain;
|
|
|
|
public static function init() {
|
|
# load the configuration file
|
|
self::$config = json_decode( file_get_contents( __DIR__ . '/updatepulse.json' ), true ); // phpcs:ignore WordPress.WP.AlternativeFunctions.file_get_contents_file_get_contents
|
|
# define the url of the server
|
|
self::$url = rtrim( self::$config['server'], '/' );
|
|
# define the package name
|
|
self::$package_name = basename( __DIR__ );
|
|
# define the package script
|
|
self::$package_script = __DIR__ . '/' . basename( __DIR__ ) . '.php';
|
|
# define the current version of the package from the updatepulse.json file
|
|
self::$version = self::$config['packageData']['Version'];
|
|
# define license_key from the updatepulse.json file
|
|
self::$license_key = isset( self::$config['licenseKey'] ) ? self::$config['licenseKey'] : '';
|
|
# define license_signature from the updatepulse.json file
|
|
self::$license_signature = isset( self::$config['licenseSignature'] ) ? self::$config['licenseSignature'] : '';
|
|
|
|
# define the domain
|
|
if ( 'Darwin' === PHP_OS ) {
|
|
# macOS
|
|
self::$domain = rtrim( exec( 'ioreg -rd1 -c IOPlatformExpertDevice | awk -F\'"\' \'/IOPlatformUUID/{print $4}\'' ), "\n" ); // phpcs:ignore WordPress.PHP.DiscouragedPHPFunctions.system_calls_exec, WordPress.WP.GlobalVariablesOverride.Prohibited
|
|
} elseif ( 'Linux' === PHP_OS ) {
|
|
# Ubuntu
|
|
self::$domain = rtrim( exec( 'cat /var/lib/dbus/machine-id' ), "\n" ); // phpcs:ignore WordPress.PHP.DiscouragedPHPFunctions.system_calls_exec, WordPress.WP.GlobalVariablesOverride.Prohibited
|
|
}
|
|
}
|
|
|
|
### INSTALLING THE PACKAGE ###
|
|
|
|
public static function install( $license_key ) {
|
|
# add the license key to updatepulse.json
|
|
self::$config['licenseKey'] = $license_key;
|
|
file_put_contents( __DIR__ . '/updatepulse.json', json_encode( self::$config, JSON_PRETTY_PRINT | JSON_UNESCAPED_SLASHES ) ); // phpcs:ignore WordPress.WP.AlternativeFunctions.file_system_operations_file_put_contents, WordPress.WP.AlternativeFunctions.json_encode_json_encode
|
|
|
|
# add a file '.installed' in current directory
|
|
// touch "$(cd "$(dirname "$0")"; pwd -P)/.installed" (convert to php)
|
|
file_put_contents( __DIR__ . '/.installed', '' ); // phpcs:ignore WordPress.WP.AlternativeFunctions.file_system_operations_file_put_contents
|
|
}
|
|
|
|
### UNINSTALLING THE PACKAGE ###
|
|
|
|
public static function uninstall() {
|
|
# remove the license key from updatepulse.json
|
|
unset( self::$config['licenseKey'] );
|
|
file_put_contents( __DIR__ . '/updatepulse.json', json_encode( self::$config, JSON_PRETTY_PRINT | JSON_UNESCAPED_SLASHES ) ); // phpcs:ignore WordPress.WP.AlternativeFunctions.file_system_operations_file_put_contents, WordPress.WP.AlternativeFunctions.json_encode_json_encode
|
|
|
|
# remove the file '.installed' from current directory
|
|
unlink( __DIR__ . '/.installed' ); // phpcs:ignore WordPress.WP.AlternativeFunctions.unlink_unlink
|
|
}
|
|
|
|
### CHECKING IF THE PACKAGE IS INSTALLED ###
|
|
|
|
public static function is_installed() {
|
|
# check if the file '.installed' exists in current directory
|
|
return file_exists( __DIR__ . '/.installed' ); // phpcs:ignore WordPress.WP.AlternativeFunctions.file_system_operations_file_exists
|
|
}
|
|
|
|
### SENDING AN API REQUEST ###
|
|
|
|
private static function send_api_request( $action, $args = array() ) {
|
|
# build the request url
|
|
$full_url = self::$url . '/' . $action . '/?' . http_build_query( $args );
|
|
|
|
# initialize cURL
|
|
$ch = curl_init(); // phpcs:ignore WordPress.WP.AlternativeFunctions.curl_curl_init
|
|
|
|
# set the options
|
|
curl_setopt( $ch, CURLOPT_URL, $full_url ); // phpcs:ignore WordPress.WP.AlternativeFunctions.curl_curl_setopt
|
|
curl_setopt( $ch, CURLOPT_RETURNTRANSFER, true ); // phpcs:ignore WordPress.WP.AlternativeFunctions.curl_curl_setopt
|
|
curl_setopt( $ch, CURLOPT_TIMEOUT, 20 ); // phpcs:ignore WordPress.WP.AlternativeFunctions.curl_curl_setopt
|
|
curl_setopt( $ch, CURLOPT_SSL_VERIFYPEER, true ); // phpcs:ignore WordPress.WP.AlternativeFunctions.curl_curl_setopt
|
|
|
|
# make the request
|
|
$response = curl_exec( $ch ); // phpcs:ignore WordPress.WP.AlternativeFunctions.curl_curl_exec
|
|
|
|
# close the cURL resource
|
|
curl_close( $ch ); // phpcs:ignore WordPress.WP.AlternativeFunctions.curl_curl_close
|
|
|
|
# return the response
|
|
return $response;
|
|
}
|
|
|
|
### CHECKING FOR UPDATES ###
|
|
|
|
private static function check_for_updates() {
|
|
# build the request url
|
|
$endpoint = 'updatepulse-server-update-api';
|
|
$args = array(
|
|
'action' => 'get_metadata',
|
|
'package_id' => self::$package_name,
|
|
'installed_version' => self::$version,
|
|
'license_key' => self::$license_key,
|
|
'license_signature' => self::$license_signature,
|
|
'update_type' => 'Generic',
|
|
);
|
|
# make the request
|
|
$response = self::send_api_request( $endpoint, $args );
|
|
# return the response
|
|
return $response;
|
|
}
|
|
|
|
### ACTIVATING A LICENSE ###
|
|
|
|
public static function activate() {
|
|
$endpoint = 'updatepulse-server-license-api';
|
|
$args = array(
|
|
'action' => 'activate',
|
|
'license_key' => self::$license_key,
|
|
'allowed_domains' => self::$domain,
|
|
'package_slug' => self::$package_name,
|
|
);
|
|
# make the request
|
|
$response = self::send_api_request( $endpoint, $args );
|
|
# get the signature from the response
|
|
$signature = rawurldecode( json_decode( $response, true )['license_signature'] );
|
|
# add the license signature to updatepulse.json
|
|
self::$config['licenseSignature'] = $signature;
|
|
file_put_contents( __DIR__ . '/updatepulse.json', json_encode( self::$config, JSON_PRETTY_PRINT | JSON_UNESCAPED_SLASHES ) ); // phpcs:ignore WordPress.WP.AlternativeFunctions.file_system_operations_file_put_contents, WordPress.WP.AlternativeFunctions.json_encode_json_encode
|
|
self::$license_signature = $signature;
|
|
}
|
|
|
|
### DEACTIVATING A LICENSE ###
|
|
|
|
public static function deactivate() {
|
|
# build the request url
|
|
$endpoint = 'updatepulse-serve-license-api';
|
|
$args = array(
|
|
'action' => 'deactivate',
|
|
'license_key' => self::$license_key,
|
|
'allowed_domains' => self::$domain,
|
|
'package_slug' => self::$package_name,
|
|
);
|
|
# make the request
|
|
self::send_api_request( $endpoint, $args );
|
|
# remove the license signature from updatepulse.json
|
|
unset( self::$config['licenseSignature'] );
|
|
file_put_contents( __DIR__ . '/updatepulse.json', json_encode( self::$config, JSON_PRETTY_PRINT | JSON_UNESCAPED_SLASHES ) ); // phpcs:ignore WordPress.WP.AlternativeFunctions.file_system_operations_file_put_contents, WordPress.WP.AlternativeFunctions.json_encode_json_encode
|
|
self::$license_signature = '';
|
|
}
|
|
|
|
### DOWNLOADING THE PACKAGE ###
|
|
|
|
private static function download_update( $response ) {
|
|
$response = json_decode( $response, true );
|
|
# get the download url from the response
|
|
$url = isset( $response['download_url'] ) ? $response['download_url'] : '';
|
|
# set the path to the downloaded file
|
|
$output_file = '/tmp/' . self::$package_name . '.zip';
|
|
|
|
# make the request
|
|
if ( filter_var( $url, FILTER_VALIDATE_URL ) ) {
|
|
$ch = curl_init(); // phpcs:ignore WordPress.WP.AlternativeFunctions.curl_curl_init
|
|
|
|
curl_setopt( $ch, CURLOPT_URL, $url ); // phpcs:ignore WordPress.WP.AlternativeFunctions.curl_curl_setopt
|
|
curl_setopt( $ch, CURLOPT_RETURNTRANSFER, true ); // phpcs:ignore WordPress.WP.AlternativeFunctions.curl_curl_setopt
|
|
curl_setopt( $ch, CURLOPT_TIMEOUT, 20 ); // phpcs:ignore WordPress.WP.AlternativeFunctions.curl_curl_setopt
|
|
curl_setopt( $ch, CURLOPT_SSL_VERIFYPEER, true ); // phpcs:ignore WordPress.WP.AlternativeFunctions.curl_curl_setopt
|
|
curl_setopt( $ch, CURLOPT_FOLLOWLOCATION, true ); // phpcs:ignore WordPress.WP.AlternativeFunctions.curl_curl_setopt
|
|
|
|
$response = curl_exec( $ch ); // phpcs:ignore WordPress.WP.AlternativeFunctions.curl_curl_exec
|
|
|
|
curl_close( $ch ); // phpcs:ignore WordPress.WP.AlternativeFunctions.curl_curl_close
|
|
file_put_contents( $output_file, $response ); // phpcs:ignore WordPress.WP.AlternativeFunctions.file_system_operations_file_put_contents
|
|
}
|
|
|
|
# return the path to the downloaded file
|
|
return $output_file;
|
|
}
|
|
|
|
### GETTING THE PACKAGE VERSION ###
|
|
|
|
public static function get_version() {
|
|
# return the current version of the package
|
|
return self::$version;
|
|
}
|
|
|
|
### UPDATING THE PACKAGE ###
|
|
|
|
public static function update() {
|
|
# check for updates
|
|
$response = self::check_for_updates();
|
|
# get the version from the response
|
|
$new_version = json_decode( $response, true )['version'];
|
|
|
|
if ( version_compare( $new_version, self::$version, '>' ) ) {
|
|
# download the update
|
|
$output_file = self::download_update( $response );
|
|
|
|
# extract the zip in /tmp/$(package_name)
|
|
$zip = new ZipArchive();
|
|
|
|
$zip->open( $output_file );
|
|
$zip->extractTo( '/tmp/' );
|
|
$zip->close();
|
|
|
|
if ( is_dir( '/tmp/' . self::$package_name ) ) {
|
|
$t_ext = PATHINFO_EXTENSION;
|
|
|
|
# delete all files in the current directory, except for update scripts
|
|
foreach ( glob( __DIR__ . '/{,.}*', GLOB_BRACE | GLOB_MARK ) as $file ) {
|
|
|
|
if ( basename( $file ) === '.' || basename( $file ) === '..' || basename( $file ) === '.installed' ) {
|
|
continue;
|
|
}
|
|
|
|
# check if the file does not start with `updatepulse`, or is .json
|
|
if ( 'updatepulse' !== substr( basename( $file ), 0, 11 ) || 'json' === pathinfo( $file, $t_ext ) ) {
|
|
|
|
if ( is_dir( $file ) ) {
|
|
deleteFolder( $file );
|
|
} else {
|
|
unlink( $file ); // phpcs:ignore WordPress.WP.AlternativeFunctions.unlink_unlink
|
|
}
|
|
}
|
|
}
|
|
|
|
# move the updated package files to the current directory; the
|
|
# updated package is in charge of overriding the update scripts
|
|
# with new ones after update (may be contained in a subdirectory)
|
|
foreach ( glob( '/tmp/' . self::$package_name . '/{,.}*', GLOB_BRACE | GLOB_MARK ) as $file ) {
|
|
|
|
if ( basename( $file ) === '.' || basename( $file ) === '..' ) {
|
|
continue;
|
|
}
|
|
|
|
# check if the file does not start with `updatepulse`, or is .json
|
|
if ( 'updatepulse' !== substr( basename( $file ), 0, 11 ) || 'json' === pathinfo( $file, $t_ext ) ) {
|
|
safeRename( rtrim( $file, '/' ), dirname( self::$package_script ) . '/' . basename( $file ) );
|
|
}
|
|
}
|
|
|
|
# recursively set all files to 644 and all directories to 755
|
|
chmodRecursive( dirname( self::$package_script ) );
|
|
# remove the directory
|
|
deleteFolder( '/tmp/' . self::$package_name );
|
|
}
|
|
|
|
self::$config = json_decode( file_get_contents( __DIR__ . '/updatepulse.json' ), true ); // phpcs:ignore WordPress.WP.AlternativeFunctions.file_get_contents_file_get_contents
|
|
|
|
# add the license key to updatepulse.json
|
|
self::$config['licenseKey'] = self::$license_key;
|
|
# add the license signature to updatepulse.json
|
|
self::$config['licenseSignature'] = self::$license_signature;
|
|
# write the new version to updatepulse.json
|
|
file_put_contents( __DIR__ . '/updatepulse.json', json_encode( self::$config, JSON_PRETTY_PRINT | JSON_UNESCAPED_SLASHES ) ); // phpcs:ignore WordPress.WP.AlternativeFunctions.file_system_operations_file_put_contents, WordPress.WP.AlternativeFunctions.json_encode_json_encode
|
|
# remove the zip
|
|
unlink( $output_file ); // phpcs:ignore WordPress.WP.AlternativeFunctions.unlink_unlink
|
|
}
|
|
}
|
|
|
|
### GETTING THE PACKAGE INFO ###
|
|
|
|
public static function get_update_info() {
|
|
# get the update information
|
|
return self::check_for_updates();
|
|
}
|
|
}
|
|
|
|
function deleteFolder( $dir_path ) { // phpcs:ignore WordPress.NamingConventions.ValidFunctionName.FunctionNameInvalid, Universal.Files.SeparateFunctionsFromOO.Mixed
|
|
|
|
if ( ! is_dir( $dir_path ) ) {
|
|
throw new InvalidArgumentException( "$dir_path must be a directory" ); // phpcs:ignore WordPress.Security.EscapeOutput.ExceptionNotEscaped
|
|
}
|
|
|
|
if ( substr( $dir_path, strlen( $dir_path ) - 1, 1 ) !== '/' ) {
|
|
$dir_path .= '/';
|
|
}
|
|
|
|
$files = glob( $dir_path . '{,.}*', GLOB_BRACE | GLOB_MARK );
|
|
|
|
foreach ( $files as $file ) {
|
|
|
|
if ( basename( $file ) === '.' || basename( $file ) === '..' ) {
|
|
continue;
|
|
}
|
|
|
|
if ( is_dir( $file ) ) {
|
|
deleteFolder( $file );
|
|
} else {
|
|
unlink( $file ); // phpcs:ignore WordPress.WP.AlternativeFunctions.unlink_unlink
|
|
}
|
|
}
|
|
|
|
rmdir( $dir_path ); // phpcs:ignore WordPress.WP.AlternativeFunctions.file_system_operations_rmdir
|
|
}
|
|
|
|
function safeRename( $src, $dst ) { // phpcs:ignore WordPress.NamingConventions.ValidFunctionName.FunctionNameInvalid
|
|
|
|
if ( is_dir( $src ) ) {
|
|
|
|
if ( ! @mkdir( $dst ) && ! is_dir( $dst ) ) { // phpcs:ignore WordPress.PHP.NoSilencedErrors.Discouraged, WordPress.WP.AlternativeFunctions.file_system_operations_mkdir
|
|
throw new Exception( "Failed to create directory: $dst" ); // phpcs:ignore WordPress.PHP.DevelopmentFunctions.error_log_trigger_error, WordPress.Security.EscapeOutput.ExceptionNotEscaped
|
|
}
|
|
|
|
$files = scandir( $src );
|
|
|
|
foreach ( $files as $file ) {
|
|
|
|
if ( '.' !== $file && '..' !== $file ) {
|
|
safeRename( "$src/$file", "$dst/$file" );
|
|
}
|
|
}
|
|
|
|
if ( ! rmdir( $src ) ) { // phpcs:ignore WordPress.WP.AlternativeFunctions.file_system_operations_rmdir
|
|
throw new Exception( "Failed to remove directory: $src" ); // phpcs:ignore WordPress.PHP.DevelopmentFunctions.error_log_trigger_error, WordPress.Security.EscapeOutput.ExceptionNotEscaped
|
|
}
|
|
} elseif ( file_exists( $src ) ) {
|
|
|
|
if ( ! copy( $src, $dst ) ) { // phpcs:ignore WordPress.WP.AlternativeFunctions.file_system_read_copy
|
|
throw new Exception( "Failed to copy file: $src to $dst" ); // phpcs:ignore WordPress.PHP.DevelopmentFunctions.error_log_trigger_error, WordPress.Security.EscapeOutput.ExceptionNotEscaped
|
|
}
|
|
|
|
if ( ! unlink( $src ) ) { // phpcs:ignore WordPress.WP.AlternativeFunctions.unlink_unlink
|
|
throw new Exception( "Failed to remove file: $src" ); // phpcs:ignore WordPress.PHP.DevelopmentFunctions.error_log_trigger_error, WordPress.Security.EscapeOutput.ExceptionNotEscaped
|
|
}
|
|
}
|
|
}
|
|
|
|
function chmodRecursive( $dir, $dir_mod = 0755, $file_mod = 0644 ) { // phpcs:ignore WordPress.NamingConventions.ValidFunctionName.FunctionNameInvalid
|
|
$iterator = new RecursiveIteratorIterator(
|
|
new RecursiveDirectoryIterator( $dir ),
|
|
RecursiveIteratorIterator::SELF_FIRST
|
|
);
|
|
|
|
foreach ( $iterator as $item ) {
|
|
if ( $item->isFile() && substr( $item->getFilename(), 0, strlen( UpdatePulse_API::$package_name ) ) === UpdatePulse_API::$package_name ) {
|
|
chmod( $item->getPathname(), $dir_mod ); // phpcs:ignore WordPress.WP.AlternativeFunctions.file_system_operations_chmod
|
|
} elseif ( $item->isFile() ) {
|
|
chmod( $item->getPathname(), $file_mod ); // phpcs:ignore WordPress.WP.AlternativeFunctions.file_system_operations_chmod
|
|
} elseif ( $item->isDir() ) {
|
|
chmod( $item->getPathname(), $dir_mod ); // phpcs:ignore WordPress.WP.AlternativeFunctions.file_system_operations_chmod
|
|
}
|
|
}
|
|
}
|
