Merge "Add getCacheKey static method to UploadFromUrl"

2 files changed, 31 insertions, 0 deletions

diff --git a/includes/upload/UploadFromUrl.php b/includes/upload/UploadFromUrl.php
index c5eaf8f820f3..8753913e331e 100644
--- a/includes/upload/UploadFromUrl.php
+++ b/includes/upload/UploadFromUrl.php
@@ -117,6 +117,26 @@ class UploadFromUrl extends UploadBase {
 	}
 
 	/**
+	 * Provides a caching key for an upload from url set of parameters
+	 * Used to set the status of an async job in UploadFromUrlJob
+	 * and retreive it in frontend clients like ApiUpload. Will return the
+	 * empty string if not all parameters are present.
+	 *
+	 * @param array $params
+	 * @return string
+	 */
+	public static function getCacheKey( $params ) {
+		if ( !isset( $params['filename'] ) || !isset( $params['url'] ) ) {
+			return "";
+		} else {
+			// We use sha1 here to ensure we have a fixed-length string of printable
+			// characters. There is no cryptography involved, so we just need a
+			// relatively fast function.
+			return sha1( sprintf( "%s|||%s", $params['filename'], $params['url'] ) );
+		}
+	}
+
+	/**
 	 * @return string[]
 	 */
 	private static function getAllowedHosts(): array {
diff --git a/tests/phpunit/includes/upload/UploadFromUrlTest.php b/tests/phpunit/includes/upload/UploadFromUrlTest.php
index da1aa7003c56..058963163027 100644
--- a/tests/phpunit/includes/upload/UploadFromUrlTest.php
+++ b/tests/phpunit/includes/upload/UploadFromUrlTest.php
@@ -292,4 +292,15 @@ class UploadFromUrlTest extends ApiTestCase {
 		$this->assertUploadOk( $upload );
 	}
 
+	public function testUploadFromUrlCacheKey() {
+		// Test we get back a properly formatted sha1 key out
+		$key = UploadFromUrl::getCacheKey( [ 'filename' => 'test.png', 'url' => 'https://example.com/example.png' ] );
+		$this->assertNotEmpty( $key );
+		$this->assertMatchesRegularExpression( "/^[0-9a-f]{40}$/", $key );
+	}
+
+	public function testUploadFromUrlCacheKeyMissingParam() {
+		$this->assertSame( "", UploadFromUrl::getCacheKey( [] ) );
+	}
+
 }