tonyair/silverstripe-framework
1
0
Fork 0
mirror of https://github.com/silverstripe/silverstripe-framework synced 2024-10-22 14:05:37 +02:00
Code Issues Projects Releases Wiki Activity

NEW: Configurable file version prefix

Browse Source 
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
This commit is contained in:
Jonathon Menz 2015-05-29 09:12:02 -07:00
parent 747e87baeb
commit 44b1ff1931
2 changed files with 66 additions and 12 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

20
filesystem/Upload.php
View File

@ -72,6 +72,17 @@ class Upload extends Controller {
*/ */
private static $uploads_folder = "Uploads"; 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() { public function __construct() {
parent::__construct(); parent::__construct();
$this->validator = Injector::inst()->create('Upload_Validator'); $this->validator = Injector::inst()->create('Upload_Validator');
@ -175,11 +186,12 @@ class Upload extends Controller {
$i = isset($i) ? ($i+1) : 2; $i = isset($i) ? ($i+1) : 2;
$oldFilePath = $relativeFilePath; $oldFilePath = $relativeFilePath;
$pattern = '/([0-9]+$)/'; $prefix = $this->config()->version_prefix;
if(preg_match($pattern, $fileTitle)) { $pattern = '/' . preg_quote($prefix) . '([0-9]+$)/';
$fileTitle = preg_replace($pattern, $i, $fileTitle); if(preg_match($pattern, $fileTitle, $matches)) {
$fileTitle = preg_replace($pattern, $prefix . ($matches[1] + 1), $fileTitle);
} else { } else {
$fileTitle .= $i; $fileTitle .= $prefix . $i;
} }
$relativeFilePath = $relativeFolderPath . $fileTitle . $fileSuffix; $relativeFilePath = $relativeFolderPath . $fileTitle . $fileSuffix;

58
tests/filesystem/UploadTest.php
View File

@ -675,30 +675,34 @@ class UploadTest extends SapphireTest {
return $u->getFile(); return $u->getFile();
}; };
$file1 = $upload('UploadTest-testUpload.jpg'); // test empty file version prefix
$originalVersionPrefix = Config::inst()->get('Upload', 'version_prefix');
Config::inst()->update('Upload', 'version_prefix', '');
$file1 = $upload('UploadTest-IMG001.jpg');
$this->assertEquals( $this->assertEquals(
'UploadTest-testUpload.jpg', 'UploadTest-IMG001.jpg',
$file1->Name, $file1->Name,
'File does not receive new name' 'File does not receive new name'
); );
$file2 = $upload('UploadTest-testUpload.jpg'); $file2 = $upload('UploadTest-IMG001.jpg');
$this->assertEquals( $this->assertEquals(
'UploadTest-testUpload2.jpg', 'UploadTest-IMG2.jpg',
$file2->Name, $file2->Name,
'File does receive new name' 'File does receive new name'
); );
$file3 = $upload('UploadTest-testUpload.jpg'); $file3 = $upload('UploadTest-IMG001.jpg');
$this->assertEquals( $this->assertEquals(
'UploadTest-testUpload3.jpg', 'UploadTest-IMG3.jpg',
$file3->Name, $file3->Name,
'File does receive new name' 'File does receive new name'
); );
$file4 = $upload('UploadTest-testUpload3.jpg'); $file4 = $upload('UploadTest-IMG3.jpg');
$this->assertEquals( $this->assertEquals(
'UploadTest-testUpload4.jpg', 'UploadTest-IMG4.jpg',
$file4->Name, $file4->Name,
'File does receive new name' 'File does receive new name'
); );
@ -707,6 +711,44 @@ class UploadTest extends SapphireTest {
$file2->delete(); $file2->delete();
$file3->delete(); $file3->delete();
$file4->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);
} }
} }