CdnEngine_S3.php

<?php
/**
 * File: CdnEngine_S3.php
 *
 * @package W3TC
 */

namespace W3TC;

defined( 'ABSPATH' ) || exit;
if ( ! defined( 'W3TC_SKIPLIB_AWS' ) ) {
	require_once W3TC_DIR . '/vendor/autoload.php';
}

/**
 * Class CdnEngine_S3
 *
 * CDN engine for S3 push type
 *
 * phpcs:disable PSR2.Methods.MethodDeclaration.Underscore
 * phpcs:disable WordPress.PHP.NoSilencedErrors.Discouraged
 * phpcs:disable WordPress.WP.AlternativeFunctions
 */
class CdnEngine_S3 extends CdnEngine_Base {
	/**
	 * S3Client object
	 *
	 * @var S3Client
	 */
	private $api;

	/**
	 * Retrieves a list of AWS regions supported by the CDN.
	 *
	 * @see  Cdn_Core::get_region_id()
	 * @link https://docs.aws.amazon.com/general/latest/gr/rande.html
	 *
	 * @return array Associative array of region IDs and their corresponding names.
	 */
	public static function regions_list() {
		return array(
			'us-east-1'      => \__( 'US East (N. Virginia) (default)', 'w3-total-cache' ), // Default; region not included in hostnmae.
			'us-east-1-e'    => \__( 'US East (N. Virginia) (long hostname)', 'w3-total-cache' ), // Explicitly included in hostname.
			'us-east-2'      => \__( 'US East (Ohio)', 'w3-total-cache' ),
			'us-west-1'      => \__( 'US West (N. California)', 'w3-total-cache' ),
			'us-west-2'      => \__( 'US West (Oregon)', 'w3-total-cache' ),
			'af-south-1'     => \__( 'Africa (Cape Town)', 'w3-total-cache' ),
			'ap-east-1'      => \__( 'Asia Pacific (Hong Kong)', 'w3-total-cache' ),
			'ap-northeast-1' => \__( 'Asia Pacific (Tokyo)', 'w3-total-cache' ),
			'ap-northeast-2' => \__( 'Asia Pacific (Seoul)', 'w3-total-cache' ),
			'ap-northeast-3' => \__( 'Asia Pacific (Osaka-Local)', 'w3-total-cache' ),
			'ap-south-1'     => \__( 'Asia Pacific (Mumbai)', 'w3-total-cache' ),
			'ap-southeast-1' => \__( 'Asia Pacific (Singapore)', 'w3-total-cache' ),
			'ap-southeast-2' => \__( 'Asia Pacific (Sydney)', 'w3-total-cache' ),
			'ca-central-1'   => \__( 'Canada (Central)', 'w3-total-cache' ),
			'cn-north-1'     => \__( 'China (Beijing)', 'w3-total-cache' ),
			'cn-northwest-1' => \__( 'China (Ningxia)', 'w3-total-cache' ),
			'eu-central-1'   => \__( 'Europe (Frankfurt)', 'w3-total-cache' ),
			'eu-north-1'     => \__( 'Europe (Stockholm)', 'w3-total-cache' ),
			'eu-south-1'     => \__( 'Europe (Milan)', 'w3-total-cache' ),
			'eu-west-1'      => \__( 'Europe (Ireland)', 'w3-total-cache' ),
			'eu-west-2'      => \__( 'Europe (London)', 'w3-total-cache' ),
			'eu-west-3'      => \__( 'Europe (Paris)', 'w3-total-cache' ),
			'me-south-1'     => \__( 'Middle East (Bahrain)', 'w3-total-cache' ),
			'sa-east-1'      => \__( 'South America (São Paulo)', 'w3-total-cache' ),
		);
	}

	/**
	 * Initializes the CdnEngine_S3 class with a given configuration.
	 *
	 * @param array $w3tc_config Configuration array for S3 integration.
	 *
	 * @return void
	 */
	public function __construct( $w3tc_config = array() ) {
		$w3tc_config = array_merge(
			array(
				'key'             => '',
				'secret'          => '',
				'bucket'          => '',
				'bucket_location' => '',
				'cname'           => array(),
			),
			$w3tc_config
		);

		parent::__construct( $w3tc_config );
	}

	/**
	 * Formats a URL for a given path.
	 *
	 * @param string $path The path to format into a URL.
	 *
	 * @return string|false The formatted URL, or false if the domain could not be determined.
	 */
	public function _format_url( $path ) {
		$domain = $this->get_domain( $path );

		if ( $domain ) {
			$scheme = $this->_get_scheme();

			// it does not support '+', requires '%2B'.
			$path     = str_replace( '+', '%2B', $path );
			$w3tc_url = sprintf( '%s://%s/%s', $scheme, $domain, $path );

			return $w3tc_url;
		}

		return false;
	}

	/**
	 * Initializes the S3 client and validates credentials.
	 *
	 * @see Cdn_Core::get_region_id()
	 *
	 * @return void
	 *
	 * @throws \Exception If the bucket or credentials are not properly configured.
	 */
	public function _init() {
		if ( ! is_null( $this->api ) ) {
			return;
		}

		if ( empty( $this->_config['bucket'] ) ) {
			throw new \Exception( \esc_html__( 'Empty bucket.', 'w3-total-cache' ) );
		}

		if ( empty( $this->_config['key'] ) && empty( $this->_config['secret'] ) ) {
			$credentials = \Aws\Credentials\CredentialProvider::defaultProvider();
		} else {
			if ( empty( $this->_config['key'] ) ) {
				throw new \Exception( \esc_html__( 'Empty access key.', 'w3-total-cache' ) );
			}

			if ( empty( $this->_config['secret'] ) ) {
				throw new \Exception( \esc_html__( 'Empty secret key.', 'w3-total-cache' ) );
			}

			$credentials = new \Aws\Credentials\Credentials(
				$this->_config['key'],
				$this->_config['secret']
			);
		}

		if ( isset( $this->_config['public_objects'] ) && 'enabled' === $this->_config['public_objects'] ) {
			$this->_config['s3_acl'] = 'public-read';
		}

		$this->api = new \Aws\S3\S3Client(
			array(
				'credentials'    => $credentials,
				'region'         => preg_replace( '/-e$/', '', $this->_config['bucket_location'] ),
				'version'        => '2006-03-01',
				'use_arn_region' => true,
			)
		);
	}

	/**
	 * Uploads files to the S3 bucket.
	 *
	 * @param array    $files         List of files to upload with their paths.
	 * @param array    $results       Reference array to store upload results.
	 * @param bool     $force_rewrite Whether to overwrite existing files.
	 * @param int|null $timeout_time  Optional timeout time in seconds for the upload.
	 *
	 * @return bool|string Returns true if successful, false on error, or 'timeout' on timeout.
	 */
	public function upload( $files, &$results, $force_rewrite = false, $timeout_time = null ) {
		$error = null;

		try {
			$this->_init();
		} catch ( \Exception $ex ) {
			$results = $this->_get_results( $files, W3TC_CDN_RESULT_HALT, $ex->getMessage() );
			return false;
		}

		foreach ( $files as $w3tc_file ) {
			$local_path  = $w3tc_file['local_path'];
			$remote_path = $w3tc_file['remote_path'];

			// process at least one item before timeout so that progress goes on.
			if ( ! empty( $results ) && ! is_null( $timeout_time ) && time() > $timeout_time ) {
				return 'timeout';
			}

			$results[] = $this->_upload( $w3tc_file, $force_rewrite );

			if ( $this->_config['compression'] && $this->_may_gzip( $remote_path ) ) {
				$w3tc_file['remote_path_gzip'] = $remote_path . $this->_gzip_extension;
				$results[]                     = $this->_upload_gzip( $w3tc_file, $force_rewrite );
			}
		}

		return ! $this->_is_error( $results );
	}

	/**
	 * Uploads a single file to the S3 bucket.
	 *
	 * @param array $w3tc_file           File descriptor containing local and remote paths.
	 * @param bool  $force_rewrite  Whether to overwrite the file if it exists.
	 *
	 * @return array Result of the upload operation.
	 *
	 * @throws \Aws\Exception\AwsException If an unexpected error occurs during the upload process.
	 */
	private function _upload( $w3tc_file, $force_rewrite = false ) {
		$local_path  = $w3tc_file['local_path'];
		$remote_path = $w3tc_file['remote_path'];

		if ( ! file_exists( $local_path ) ) {
			return $this->_get_result(
				$local_path,
				$remote_path,
				W3TC_CDN_RESULT_ERROR,
				'Source file not found.',
				$w3tc_file
			);
		}

		try {
			if ( ! $force_rewrite ) {
				try {
					$info = $this->api->headObject(
						array(
							'Bucket' => $this->_config['bucket'],
							'Key'    => $remote_path,
						)
					);

					$hash    = '"' . @md5_file( $local_path ) . '"';
					$s3_hash = ( isset( $info['ETag'] ) ? $info['ETag'] : '' );

					if ( $hash === $s3_hash ) {
						return $this->_get_result(
							$local_path,
							$remote_path,
							W3TC_CDN_RESULT_OK,
							'Object up-to-date.',
							$w3tc_file
						);
					}
				} catch ( \Aws\Exception\AwsException $ex ) {
					if ( 'NotFound' !== $ex->getAwsErrorCode() ) {
						throw $ex;
					}
				}
			}

			$headers     = $this->get_headers_for_file( $w3tc_file );
			$w3tc_result = $this->_put_object(
				array(
					'Key'        => $remote_path,
					'SourceFile' => $local_path,
				),
				$headers
			);

			return $this->_get_result(
				$local_path,
				$remote_path,
				W3TC_CDN_RESULT_OK,
				'OK',
				$w3tc_file
			);
		} catch ( \Exception $ex ) {
			$error = sprintf( 'Unable to put object (%s).', $ex->getMessage() );

			return $this->_get_result(
				$local_path,
				$remote_path,
				W3TC_CDN_RESULT_ERROR,
				$error,
				$w3tc_file
			);
		}
	}

	/**
	 * Uploads a gzipped version of the file to the S3 bucket.
	 *
	 * @param array $w3tc_file           File descriptor containing local and remote paths.
	 * @param bool  $force_rewrite  Whether to overwrite the file if it exists.
	 *
	 * @return array Result of the upload operation.
	 *
	 * @throws \Aws\Exception\AwsException If an unexpected error occurs during the upload process.
	 */
	private function _upload_gzip( $w3tc_file, $force_rewrite = false ) {
		$local_path  = $w3tc_file['local_path'];
		$remote_path = $w3tc_file['remote_path_gzip'];

		if ( ! function_exists( 'gzencode' ) ) {
			return $this->_get_result(
				$local_path,
				$remote_path,
				W3TC_CDN_RESULT_ERROR,
				"GZIP library doesn't exist.",
				$w3tc_file
			);
		}

		if ( ! file_exists( $local_path ) ) {
			return $this->_get_result(
				$local_path,
				$remote_path,
				W3TC_CDN_RESULT_ERROR,
				'Source file not found.',
				$w3tc_file
			);
		}

		$contents = @file_get_contents( $local_path );

		if ( false === $contents ) {
			return $this->_get_result(
				$local_path,
				$remote_path,
				W3TC_CDN_RESULT_ERROR,
				'Unable to read file.',
				$w3tc_file
			);
		}

		$w3tc_data = gzencode( $contents );

		try {
			if ( ! $force_rewrite ) {
				try {
					$info = $this->api->headObject(
						array(
							'Bucket' => $this->_config['bucket'],
							'Key'    => $remote_path,
						)
					);

					$hash    = '"' . md5( $w3tc_data ) . '"';
					$s3_hash = ( isset( $info['ETag'] ) ? $info['ETag'] : '' );

					if ( $hash === $s3_hash ) {
						return $this->_get_result(
							$local_path,
							$remote_path,
							W3TC_CDN_RESULT_OK,
							'Object up-to-date.',
							$w3tc_file
						);
					}
				} catch ( \Aws\Exception\AwsException $ex ) {
					if ( 'NotFound' !== $ex->getAwsErrorCode() ) {
						throw $ex;
					}
				}
			}

			$headers                     = $this->get_headers_for_file( $w3tc_file );
			$headers['Content-Encoding'] = 'gzip';

			$w3tc_result = $this->_put_object(
				array(
					'Key'  => $remote_path,
					'Body' => $w3tc_data,
				),
				$headers
			);

			return $this->_get_result(
				$local_path,
				$remote_path,
				W3TC_CDN_RESULT_OK,
				'OK',
				$w3tc_file
			);
		} catch ( \Exception $ex ) {
			$error = sprintf( 'Unable to put object (%s).', $ex->getMessage() );

			return $this->_get_result(
				$local_path,
				$remote_path,
				W3TC_CDN_RESULT_ERROR,
				$error,
				$w3tc_file
			);
		}
	}

	/**
	 * Uploads an object to the S3 bucket with specific headers.
	 *
	 * @param array $w3tc_data    Data to be uploaded, including file path and bucket details.
	 * @param array $headers Headers for the object being uploaded.
	 *
	 * @return \Aws\Result Result of the putObject operation.
	 */
	private function _put_object( $w3tc_data, $headers ) {
		if ( ! empty( $this->_config['s3_acl'] ) ) {
			$w3tc_data['ACL'] = 'public-read';
		}

		$w3tc_data['Bucket'] = $this->_config['bucket'];

		$w3tc_data['ContentType'] = $headers['Content-Type'];

		if ( isset( $headers['Content-Encoding'] ) ) {
			$w3tc_data['ContentEncoding'] = $headers['Content-Encoding'];
		}
		if ( isset( $headers['Cache-Control'] ) ) {
			$w3tc_data['CacheControl'] = $headers['Cache-Control'];
		}

		return $this->api->putObject( $w3tc_data );
	}

	/**
	 * Deletes files from the S3 bucket.
	 *
	 * @param array $files   List of files to delete with their paths.
	 * @param array $results Reference array to store deletion results.
	 *
	 * @return bool True if all deletions were successful, false otherwise.
	 */
	public function delete( $files, &$results ) {
		$error = null;

		try {
			$this->_init();
		} catch ( \Exception $ex ) {
			$results = $this->_get_results( $files, W3TC_CDN_RESULT_HALT, $ex->getMessage() );
			return false;
		}

		foreach ( $files as $w3tc_file ) {
			$local_path  = $w3tc_file['local_path'];
			$remote_path = $w3tc_file['remote_path'];

			try {
				$this->api->deleteObject(
					array(
						'Bucket' => $this->_config['bucket'],
						'Key'    => $remote_path,
					)
				);
				$results[] = $this->_get_result(
					$local_path,
					$remote_path,
					W3TC_CDN_RESULT_OK,
					'OK',
					$w3tc_file
				);
			} catch ( \Exception $ex ) {
				$results[] = $this->_get_result(
					$local_path,
					$remote_path,
					W3TC_CDN_RESULT_ERROR,
					sprintf( 'Unable to delete object (%s).', $ex->getMessage() ),
					$w3tc_file
				);
			}

			if ( $this->_config['compression'] ) {
				$remote_path_gzip = $remote_path . $this->_gzip_extension;

				try {
					$this->api->deleteObject(
						array(
							'Bucket' => $this->_config['bucket'],
							'Key'    => $remote_path_gzip,
						)
					);
					$results[] = $this->_get_result(
						$local_path,
						$remote_path_gzip,
						W3TC_CDN_RESULT_OK,
						'OK',
						$w3tc_file
					);
				} catch ( \Exception $ex ) {
					$results[] = $this->_get_result(
						$local_path,
						$remote_path_gzip,
						W3TC_CDN_RESULT_ERROR,
						sprintf( 'Unable to delete object (%s).', $ex->getMessage() ),
						$w3tc_file
					);
				}
			}
		}

		return ! $this->_is_error( $results );
	}

	/**
	 * Tests the connection and configuration for the S3 bucket.
	 *
	 * @param string $error Reference to a variable to store error messages, if any.
	 *
	 * @return bool True if the test is successful, false otherwise.
	 *
	 * @throws \Exception If the bucket does not exist or if object operations fail.
	 */
	public function test( &$error ) {
		if ( ! parent::test( $error ) ) {
			return false;
		}

		$w3tc_key = 'test_s3_' . md5( time() );

		$this->_init();
		$buckets = $this->api->listBuckets();

		$bucket_found = false;
		foreach ( $buckets['Buckets'] as $bucket ) {
			if ( $bucket['Name'] === $this->_config['bucket'] ) {
				$bucket_found = true;
			}
		}

		if ( ! $bucket_found ) {
			throw new \Exception(
				\esc_html(
					sprintf(
						// translators: 1: Bucket name.
						\__( 'Bucket doesn\'t exist: %1$s.', 'w3-total-cache' ),
						$this->_config['bucket']
					)
				)
			);
		}

		if ( ! empty( $this->_config['s3_acl'] ) ) {
			$w3tc_result = $this->api->putObject(
				array(
					'ACL'    => $this->_config['s3_acl'],
					'Bucket' => $this->_config['bucket'],
					'Key'    => $w3tc_key,
					'Body'   => $w3tc_key,
				)
			);
		} else {
			$w3tc_result = $this->api->putObject(
				array(
					'Bucket' => $this->_config['bucket'],
					'Key'    => $w3tc_key,
					'Body'   => $w3tc_key,
				)
			);
		}

		$object = $this->api->getObject(
			array(
				'Bucket' => $this->_config['bucket'],
				'Key'    => $w3tc_key,
			)
		);

		if ( (string) $object['Body'] !== $w3tc_key ) {
			$error = 'Objects are not equal.';

			$this->api->deleteObject(
				array(
					'Bucket' => $this->_config['bucket'],
					'Key'    => $w3tc_key,
				)
			);

			return false;
		}

		$this->api->deleteObject(
			array(
				'Bucket' => $this->_config['bucket'],
				'Key'    => $w3tc_key,
			)
		);

		return true;
	}

	/**
	 * Get the S3 bucket region id used for domains.
	 *
	 * @since 2.8.5
	 *
	 * @return string
	 */
	public function get_region() {
		$location = $this->_config['bucket_loc_id'] ?? $this->_config['bucket_location'];

		switch ( $location ) {
			case 'us-east-1':
				$w3tc_region = '';
				break;
			case 'us-east-1-e':
				$w3tc_region = 'us-east-1.';
				break;
			default:
				$w3tc_region = $location . '.';
				break;
		}

		return $w3tc_region;
	}

	/**
	 * Retrieves the domains associated with the S3 bucket.
	 *
	 * @see self::get_region()
	 *
	 * @return array Array of domain names associated with the bucket.
	 */
	public function get_domains() {
		$domains = array();

		if ( ! empty( $this->_config['cname'] ) ) {
			$domains = (array) $this->_config['cname'];
		} elseif ( ! empty( $this->_config['bucket'] ) ) {
			$domains = array( sprintf( '%1$s.s3.%2$samazonaws.com', $this->_config['bucket'], $this->get_region() ) );
		}

		return $domains;
	}

	/**
	 * Retrieves the CDN provider and bucket information.
	 *
	 * @return string Description of the provider and bucket configuration.
	 */
	public function get_via() {
		return sprintf( 'Amazon Web Services: S3: %s', parent::get_via() );
	}

	/**
	 * Creates a new bucket in the S3 service.
	 *
	 * @return void
	 *
	 * @throws \Exception If the bucket already exists or creation fails.
	 */
	public function create_container() {
		$this->_init();

		try {
			$buckets = $this->api->listBuckets();
		} catch ( \Exception $ex ) {
			throw new \Exception(
				\esc_html(
					sprintf(
						// translators: 1 Error message.
						\__( 'Unable to list buckets: %1$s.', 'w3-total-cache' ),
						$ex->getMessage()
					)
				)
			);
		}

		foreach ( $buckets['Buckets'] as $bucket ) {
			if ( $bucket['Name'] === $this->_config['bucket'] ) {
				throw new \Exception(
					\esc_html(
						sprintf(
							// translators: 1 Bucket name.
							\__( 'Bucket already exists: %1$s.', 'w3-total-cache' ),
							$this->_config['bucket']
						)
					)
				);
			}
		}

		try {
			$this->api->createBucket(
				array(
					'Bucket' => $this->_config['bucket'],
				)
			);

			$this->api->putBucketCors(
				array(
					'Bucket'            => $this->_config['bucket'],
					'CORSConfiguration' => array(
						'CORSRules' => array(
							array(
								'AllowedHeaders' => array( '*' ),
								'AllowedMethods' => array( 'GET' ),
								'AllowedOrigins' => array( '*' ),
							),
						),
					),
				)
			);
		} catch ( \Exception $e ) {
			throw new \Exception(
				\esc_html(
					sprintf(
						// translators: 1 Error message.
						\__( 'Failed to create bucket: %1$s.', 'w3-total-cache' ),
						$ex->getMessage()
					)
				)
			);
		}
	}

	/**
	 * Indicates whether the headers can be uploaded with the files.
	 *
	 * @return int W3TC_CDN_HEADER_UPLOADABLE constant indicating header support.
	 */
	public function headers_support() {
		return W3TC_CDN_HEADER_UPLOADABLE;
	}
}