Switch to using PHP namespaces

.travis.yml

@@ -12,7 +12,8 @@ notifications:
   email: false
 
 before_script:
-  - composer install
+  - composer install --ignore-platform-reqs
 
 script:
-  - composer test
+  - composer test -- --coverage-clover=coverage.xml
+  - bash <(curl -s https://codecov.io/bash)

codecov.yml

@@ -0,0 +1 @@
+comment: false

composer.json

@@ -6,6 +6,9 @@
 		"wordpress"
 	],
 	"license": "GPL-2.0+",
+	"autoload": {
+		"classmap": [ "./inc" ]
+	},
 	"authors": [
 		{
 			"name":"Human Made Limited",
@@ -23,7 +26,9 @@
 		"aws/aws-sdk-php": "~3.18"
 	},
 	"require-dev": {
-		"phpunit/phpunit": "7.5"
+		"phpunit/phpunit": "7.5",
+		"vimeo/psalm": "^3.11",
+		"pcov/clobber": "^2.0"
 	},
 	"scripts": {
 		"test": "./tests/run-tests.sh"

inc/class-plugin.php

@@ -148,7 +148,7 @@ public function register_stream_wrapper() {
 	}
 
 	/**
-	 * Overwrite the defaul wp_upload_dir.
+	 * Overwrite the default wp_upload_dir.
 	 *
 	 * @param array{path: string, basedir: string, baseurl: string, url: string} $dirs
 	 * @return array{path: string, basedir: string, baseurl: string, url: string}
@@ -190,6 +190,9 @@ public function filter_upload_dir( array $dirs ) : array {
 	public function delete_attachment_files( int $post_id ) {
 		$meta = wp_get_attachment_metadata( $post_id );
 		$file = get_attached_file( $post_id );
+		if ( ! $file ) {
+			return;
+		}
 
 		if ( ! empty( $meta['sizes'] ) ) {
 			foreach ( $meta['sizes'] as $sizeinfo ) {
@@ -257,15 +260,15 @@ public function get_original_upload_dir() : array {
 	 * Reverse a file url in the uploads directory to the params needed for S3.
 	 *
 	 * @param string $url
-	 * @return array
+	 * @return array{bucket: string, key: string, query: string|null}|null
 	 */
 	public function get_s3_location_for_url( string $url ) : ?array {
 		$s3_url = 'https://' . $this->get_s3_bucket() . '.s3.amazonaws.com/';
 		if ( strpos( $url, $s3_url ) === 0 ) {
 			$parsed = wp_parse_url( $url );
 			return [
 				'bucket' => $this->get_s3_bucket(),
-				'key'    => ltrim( $parsed['path'], '/' ),
+				'key'    => isset( $parsed['path'] ) ? ltrim( $parsed['path'], '/' ) : '',
 				'query'  => $parsed['query'] ?? null,
 			];
 		}
@@ -277,6 +280,9 @@ public function get_s3_location_for_url( string $url ) : ?array {
 
 		$path = str_replace( $upload_dir['baseurl'], $upload_dir['basedir'], $url );
 		$parsed = wp_parse_url( $path );
+		if ( ! isset( $parsed['host'] ) || ! isset( $parsed['path'] ) ) {
+			return null;
+		}
 		return [
 			'bucket' => $parsed['host'],
 			'key'    => ltrim( $parsed['path'], '/' ),
@@ -292,7 +298,7 @@ public function get_s3_location_for_url( string $url ) : ?array {
 	 */
 	public function get_s3_location_for_path( string $path ) : ?array {
 		$parsed = wp_parse_url( $path );
-		if ( $parsed['scheme'] !== 's3' ) {
+		if ( ! isset( $parsed['path'] ) || ! isset( $parsed['host'] ) || ! isset( $parsed['scheme'] ) || $parsed['scheme'] !== 's3' ) {
 			return null;
 		}
 		return [
@@ -320,6 +326,7 @@ public function s3() : Aws\S3\S3Client {
 	 * @return Aws\Sdk
 	 */
 	public function get_aws_sdk() : Aws\Sdk {
+		/** @var null|Aws\Sdk */
 		$sdk = apply_filters( 's3_uploads_aws_sdk', null, $this );
 		if ( $sdk ) {
 			return $sdk;
@@ -370,8 +377,8 @@ public function filter_editors( array $editors ) : array {
 	 * trying to do a rename() on the file cross streams. This is somewhat of a hack
 	 * to work around the core issue https://core.trac.wordpress.org/ticket/29257
 	 *
-	 * @param array File array
-	 * @return array
+	 * @param array{tmp_name: string} $file File array
+	 * @return array{tmp_name: string}
 	 */
 	public function filter_sideload_move_temp_file_to_s3( array $file ) {
 		$upload_dir = wp_upload_dir();
@@ -389,7 +396,7 @@ public function filter_sideload_move_temp_file_to_s3( array $file ) {
 	 * file streams so we need to make a temporary local copy to extract
 	 * exif data from.
 	 *
-	 * @param array  $meta
+	 * @param array $meta
 	 * @param string $file
 	 * @return array|bool
 	 */
@@ -428,7 +435,6 @@ public function copy_image_from_s3( string $file ) : string {
 			require_once( ABSPATH . 'wp-admin/includes/file.php' );
 		}
 		$temp_filename = wp_tempnam( $file );
-		echo $temp_filename;
 		copy( $file, $temp_filename );
 		return $temp_filename;
 	}
@@ -490,20 +496,24 @@ public function set_attachment_files_acl( int $attachment_id, string $acl ) : ?W
 	 */
 	public static function get_attachment_files( int $attachment_id ) : array {
 		$uploadpath = wp_get_upload_dir();
+		/** @var string */
 		$main_file = get_attached_file( $attachment_id );
 		$files = [ $main_file ];
+
 		$meta = wp_get_attachment_metadata( $attachment_id );
 		if ( isset( $meta['sizes'] ) ) {
 			foreach ( $meta['sizes'] as $size => $sizeinfo ) {
 				$files[] = $uploadpath['basedir'] . $sizeinfo['file'];
 			}
 		}
 
+		/** @var string|false */
 		$original_image = get_post_meta( $attachment_id, 'original_image', true );
 		if ( $original_image ) {
 			$files[] = $uploadpath['basedir'] . $original_image;
 		}
 
+		/** @var array<string,array{file: string}> */
 		$backup_sizes = get_post_meta( $attachment_id, '_wp_attachment_backup_sizes', true );
 		if ( $backup_sizes ) {
 			foreach ( $backup_sizes as $size => $sizeinfo ) {

inc/namespace.php

@@ -90,7 +90,7 @@ function outdated_wp_version_notice() {
 
 	printf(
 		'<div class="error"><p>The S3 Uploads plugin requires WordPress version 5.3 or higher. Your server is running WordPress version %s.</p></div>',
-		$wp_version
+		esc_html( $wp_version )
 	);
 }
 
@@ -106,37 +106,13 @@ function enabled() : bool {
 	// Make sure the plugin is enabled when autoenable is on
 	$constant_autoenable_off = ( defined( 'S3_UPLOADS_AUTOENABLE' ) && false === S3_UPLOADS_AUTOENABLE );
 
-	if ( $constant_autoenable_off && 'enabled' !== get_option( 's3_uploads_enabled' ) ) {                         // If the plugin is not enabled, skip
+	if ( $constant_autoenable_off && 'enabled' !== get_option( 's3_uploads_enabled' ) ) { // If the plugin is not enabled, skip
 		return false;
 	}
 
 	return true;
 }
 
-/**
- * Autoload callback.
- *
- * @param $class_name Name of the class to load.
- */
-function autoload( string $class_name ) {
-	/*
-	 * Load plugin classes:
-	 * - Class name: S3_Uploads\Image_Editor_Imagick.
-	 * - File name: class-image-editor-imagick.php.
-	 */
-	if ( strpos( $class_name, 'S3_Uploads\\' ) !== 0 ) {
-		return;
-	}
-	$class_name = substr( $class_name, 11 );
-	$class_file = 'class-' . strtolower( str_replace( '_', '-', $class_name ) ) . '.php';
-	$class_path = dirname( __DIR__ ) . '/inc/' . $class_file;
-	if ( file_exists( $class_path ) ) {
-		require $class_path;
-
-		return;
-	}
-}
-
 /**
  * Setup the filters for wp_privacy_exports_dir to use a temp folder location.
  */
@@ -169,15 +145,15 @@ function set_wp_privacy_exports_dir( string $dir ) {
 	$dir = sys_get_temp_dir() . '/wp_privacy_exports_dir/';
 	if ( ! is_dir( $dir ) ) {
 		mkdir( $dir );
-		file_put_contents( $dir . 'index.html', '' );
+		file_put_contents( $dir . 'index.html', '' ); // @codingStandardsIgnoreLine FS write is ok.
 	}
 	return $dir;
 }
 
 /**
  * Move the tmp personal data file to the true uploads location
  *
- * Once a personal data file has been written, move it from the overriden "temp"
+ * Once a personal data file has been written, move it from the overridden "temp"
  * location to the S3 location where it should have been stored all along, and where
  * the "natural" Core URL is going to be pointing to.
  */

psalm.xml

@@ -0,0 +1,27 @@
+<?xml version="1.0"?>
+<psalm requireVoidReturnType="false" totallyTyped="true" ensureArrayStringOffsetsExist="true">
+    <projectFiles>
+        <directory name="./" />
+         <ignoreFiles>
+            <directory name="vendor" />
+            <directory name="psalm" />
+            <directory name="tests" />
+        </ignoreFiles>
+    </projectFiles>
+    <stubs>
+        <file name="psalm/stubs/a-wordpress.php" />
+        <file name="psalm/stubs/a-wp-cli.php" />
+        <file name="psalm/stubs/overrides.php" />
+        <file name="psalm/stubs/constants.php" />
+    </stubs>
+    <globals>
+        <var name="wp_version" type="string" />
+    </globals>
+    <issueHandlers>
+        <MissingFile>
+            <errorLevel type="suppress">
+                <file name="inc/class-plugin.php" />
+            </errorLevel>
+        </MissingFile>
+    </issueHandlers>
+</psalm>

s3-uploads.php

@@ -11,7 +11,6 @@
 require_once __DIR__ . '/inc/namespace.php';
 
 add_action( 'plugins_loaded', 'S3_Uploads\\init' );
-spl_autoload_register( 'S3_Uploads\\autoload' );
 
 if ( defined( 'WP_CLI' ) && WP_CLI ) {
 	WP_CLI::add_command( 's3-uploads', __NAMESPACE__ . '\\WP_CLI_Command' );