From 44b1ff193106e55aa754f64ddab28146f8857290 Mon Sep 17 00:00:00 2001
From: Jonathon Menz <jonomenz@gmail.com>
Date: Fri, 29 May 2015 09:12:02 -0700
Subject: [PATCH] NEW: Configurable file version prefix

Numbers are often used at the end of file names in image sequences (e.g. digital photos) and the current renaming scheme can disrupt this, creating a confusing situation for the user. A configurable file version prefix should help prevent this, with a default of '-v' proposed for SS4.0.

Filename   | Old result | New result (with '-v' prefix)
-----------|------------|--------------
IMG001.jpg | IMG2.jpg   | IMG001-v2.jpg
---
 filesystem/Upload.php           | 20 +++++++++---
 tests/filesystem/UploadTest.php | 58 ++++++++++++++++++++++++++++-----
 2 files changed, 66 insertions(+), 12 deletions(-)

diff --git a/filesystem/Upload.php b/filesystem/Upload.php
index 92b22025c..f49f3c704 100644
--- a/filesystem/Upload.php
+++ b/filesystem/Upload.php
@@ -72,6 +72,17 @@ class Upload extends Controller {
 	 */
 	private static $uploads_folder = "Uploads";
 
+	/**
+	 * A prefix for the version number added to an uploaded file
+	 * when a file with the same name already exists.
+	 * Example using no prefix: IMG001.jpg becomes IMG2.jpg
+	 * Example using '-v' prefix: IMG001.jpg becomes IMG001-v2.jpg
+	 *
+	 * @config
+	 * @var string
+	 */
+	private static $version_prefix = ''; // a default value will be introduced in SS4.0
+
 	public function __construct() {
 		parent::__construct();
 		$this->validator = Injector::inst()->create('Upload_Validator');
@@ -175,11 +186,12 @@ class Upload extends Controller {
 				$i = isset($i) ? ($i+1) : 2;
 				$oldFilePath = $relativeFilePath;
 
-				$pattern = '/([0-9]+$)/';
-				if(preg_match($pattern, $fileTitle)) {
-					$fileTitle = preg_replace($pattern, $i, $fileTitle);
+				$prefix = $this->config()->version_prefix;
+				$pattern = '/' . preg_quote($prefix) . '([0-9]+$)/';
+				if(preg_match($pattern, $fileTitle, $matches)) {
+					$fileTitle = preg_replace($pattern, $prefix . ($matches[1] + 1), $fileTitle);
 				} else {
-					$fileTitle .= $i;
+					$fileTitle .= $prefix . $i;
 				}
 				$relativeFilePath = $relativeFolderPath . $fileTitle . $fileSuffix;
 
diff --git a/tests/filesystem/UploadTest.php b/tests/filesystem/UploadTest.php
index 79467ed74..f0235dce9 100644
--- a/tests/filesystem/UploadTest.php
+++ b/tests/filesystem/UploadTest.php
@@ -674,31 +674,35 @@ class UploadTest extends SapphireTest {
 			$u->load($tmpFile);
 			return $u->getFile();
 		};
+		
+		// test empty file version prefix
+		$originalVersionPrefix = Config::inst()->get('Upload', 'version_prefix');
+		Config::inst()->update('Upload', 'version_prefix', '');
 
-		$file1 = $upload('UploadTest-testUpload.jpg');
+		$file1 = $upload('UploadTest-IMG001.jpg');
 		$this->assertEquals(
-			'UploadTest-testUpload.jpg',
+			'UploadTest-IMG001.jpg',
 			$file1->Name,
 			'File does not receive new name'
 		);
 
-		$file2 = $upload('UploadTest-testUpload.jpg');
+		$file2 = $upload('UploadTest-IMG001.jpg');
 		$this->assertEquals(
-			'UploadTest-testUpload2.jpg',
+			'UploadTest-IMG2.jpg',
 			$file2->Name,
 			'File does receive new name'
 		);
 
-		$file3 = $upload('UploadTest-testUpload.jpg');
+		$file3 = $upload('UploadTest-IMG001.jpg');
 		$this->assertEquals(
-			'UploadTest-testUpload3.jpg',
+			'UploadTest-IMG3.jpg',
 			$file3->Name,
 			'File does receive new name'
 		);
 
-		$file4 = $upload('UploadTest-testUpload3.jpg');
+		$file4 = $upload('UploadTest-IMG3.jpg');
 		$this->assertEquals(
-			'UploadTest-testUpload4.jpg',
+			'UploadTest-IMG4.jpg',
 			$file4->Name,
 			'File does receive new name'
 		);
@@ -707,6 +711,44 @@ class UploadTest extends SapphireTest {
 		$file2->delete();
 		$file3->delete();
 		$file4->delete();
+		
+		// test '-v' file version prefix
+		Config::inst()->update('Upload', 'version_prefix', '-v');
+
+		$file1 = $upload('UploadTest2-IMG001.jpg');
+		$this->assertEquals(
+			'UploadTest2-IMG001.jpg',
+			$file1->Name,
+			'File does not receive new name'
+		);
+
+		$file2 = $upload('UploadTest2-IMG001.jpg');
+		$this->assertEquals(
+			'UploadTest2-IMG001-v2.jpg',
+			$file2->Name,
+			'File does receive new name'
+		);
+
+		$file3 = $upload('UploadTest2-IMG001.jpg');
+		$this->assertEquals(
+			'UploadTest2-IMG001-v3.jpg',
+			$file3->Name,
+			'File does receive new name'
+		);
+
+		$file4 = $upload('UploadTest2-IMG001-v3.jpg');
+		$this->assertEquals(
+			'UploadTest2-IMG001-v4.jpg',
+			$file4->Name,
+			'File does receive new name'
+		);
+
+		$file1->delete();
+		$file2->delete();
+		$file3->delete();
+		$file4->delete();
+		
+		Config::inst()->update('Upload', 'version_prefix', $originalVersionPrefix);
 	}
 
 }