Merge branch '30-blacklist-originalfilenames-in-repository' into 'master'

Resolve "Blacklist originalFilenames in Repository"

Closes #30

See merge request !34

file-repository-core/src/main/java/org/genesys/filerepository/service/impl/RepositoryServiceImpl.java

@@ -26,6 +26,7 @@ import java.util.ArrayList;
 import java.util.Collections;
 import java.util.List;
 import java.util.UUID;
+import java.util.regex.Pattern;
 import java.util.stream.Stream;
 import java.util.stream.StreamSupport;
 
@@ -56,6 +57,7 @@ import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 import org.springframework.beans.factory.InitializingBean;
 import org.springframework.beans.factory.annotation.Autowired;
+import org.springframework.beans.factory.annotation.Value;
 import org.springframework.data.domain.Page;
 import org.springframework.data.domain.PageImpl;
 import org.springframework.data.domain.Pageable;
@@ -106,7 +108,21 @@ public class RepositoryServiceImpl implements RepositoryService, InitializingBea
 	/** The ACL service */
 	@Autowired
 	private CustomAclService aclService;
-	
+
+	/** The blacklist file names regexp */
+	@Value("${repository.blacklist.filename}")
+	private String blacklistFileNameRegex;
+
+	/** The blacklist folder names regexp */
+	@Value("${repository.blacklist.foldername}")
+	private String blacklistFolderNameRegex;
+
+	/** The pattern of blacklist file names */
+	private Pattern blacklistFileNamePattern;
+
+	/** The pattern of blacklist folder names */
+	private Pattern blacklistFolderNamePattern;
+
 	/*
 	 * (non-Javadoc)
 	 * @see org.springframework.beans.factory.InitializingBean#afterPropertiesSet()
@@ -114,6 +130,8 @@ public class RepositoryServiceImpl implements RepositoryService, InitializingBea
 	@Override
 	public void afterPropertiesSet() throws Exception {
 		addMissingHashSums();
+		blacklistFileNamePattern = Pattern.compile(blacklistFileNameRegex, Pattern.CASE_INSENSITIVE);
+		blacklistFolderNamePattern = Pattern.compile(blacklistFolderNameRegex, Pattern.CASE_INSENSITIVE);
 	}
 	
 	private <T extends RepositoryFile> T lazyLoad(T repositoryFile) {
@@ -173,6 +191,9 @@ public class RepositoryServiceImpl implements RepositoryService, InitializingBea
 		if ((originalFilename == null) || (contentType == null) || (bytes == null)) {
 			throw new InvalidRepositoryFileDataException();
 		}
+		if (blacklistFileNamePattern.matcher(originalFilename).find()) {
+			throw new InvalidRepositoryFileDataException("Invalid file name: " + originalFilename);
+		}
 
 		if (contentType.startsWith("image/")) {
 			// Handle images differently
@@ -244,6 +265,9 @@ public class RepositoryServiceImpl implements RepositoryService, InitializingBea
 		if ((originalFilename == null) || (contentType == null) || (bytes == null)) {
 			throw new InvalidRepositoryFileDataException();
 		}
+		if (blacklistFileNamePattern.matcher(originalFilename).find()) {
+			throw new InvalidRepositoryFileDataException("Invalid file name: " + originalFilename);
+		}
 
 		RepositoryImage repositoryImage = new RepositoryImage();
 
@@ -884,7 +908,11 @@ public class RepositoryServiceImpl implements RepositoryService, InitializingBea
 			}
 			return null;
 		} else {
-			PathValidator.checkValidFolderName(folderPath.getFileName().toString());
+			String folderNameToCheck = folderPath.getFileName().toString();
+			if (blacklistFolderNamePattern.matcher(folderNameToCheck).find()) {
+				throw new InvalidRepositoryPathException("Invalid folder name: " + folderNameToCheck);
+			}
+			PathValidator.checkValidFolderName(folderNameToCheck);
 		}
 
 		RepositoryFolder folder = folderRepository.findByPath(folderPath.toString());
@@ -931,7 +959,11 @@ public class RepositoryServiceImpl implements RepositoryService, InitializingBea
 			}
 			return null;
 		} else {
-			PathValidator.checkValidFolderName(folderPath.getFileName().toString());
+			String folderNameToCheck = folderPath.getFileName().toString();
+			if (blacklistFolderNamePattern.matcher(folderNameToCheck).find()) {
+				throw new InvalidRepositoryPathException("Invalid folder name: " + folderNameToCheck);
+			}
+			PathValidator.checkValidFolderName(folderNameToCheck);
 		}
 
 		RepositoryFolder folder = folderRepository.findByPath(folderPath.toString());

file-repository-core/src/main/resources/application.properties

@@ -18,4 +18,8 @@
 s3.accessKey=
 s3.secretKey=
 s3.bucket=
-s3.region=
\ No newline at end of file
+s3.region=
+
+# Regular expressions to blacklist file and folder names
+repository.blacklist.filename=^(\\.|\\~)|^Thumbs.db$
+repository.blacklist.foldername=(^\\.)|[~!\\/]

file-repository-core/src/test/java/org/genesys/filerepository/service/FileRepositoryAddTest.java

@@ -279,6 +279,48 @@ public class FileRepositoryAddTest extends RepositoryServiceTest {
 		repositoryService.addFile(Paths.get("/invalidpath/ orhere/"), "originalFilename.txt", "contentType", FileRepositoryAddTest.EMPTY_BYTES, null);
 	}
 
+	/**
+	 * Filename mustn't start with . test.
+	 *
+	 * @throws InvalidRepositoryPathException the invalid repository path exception
+	 * @throws InvalidRepositoryFileDataException the invalid repository file data
+	 * exception
+	 * @throws IOException
+	 */
+	@Test(expected = InvalidRepositoryFileDataException.class)
+	public void invalidDotAtTheStartOfFilename() throws InvalidRepositoryPathException, InvalidRepositoryFileDataException, IOException {
+		String invalidFilename = ".orignalFilename.txt";
+		repositoryService.addFile(Paths.get("/valid/path"), invalidFilename, null, FileRepositoryAddTest.EMPTY_BYTES, null);
+	}
+
+	/**
+	 * Filename mustn't start with ~ test.
+	 *
+	 * @throws InvalidRepositoryPathException the invalid repository path exception
+	 * @throws InvalidRepositoryFileDataException the invalid repository file data
+	 * exception
+	 * @throws IOException
+	 */
+	@Test(expected = InvalidRepositoryFileDataException.class)
+	public void invalidTildeAtTheStartOfFilename() throws InvalidRepositoryPathException, InvalidRepositoryFileDataException, IOException {
+		String invalidFilename = "~orignalFilename.txt";
+		repositoryService.addFile(Paths.get("/valid/path"), invalidFilename, null, FileRepositoryAddTest.EMPTY_BYTES, null);
+	}
+
+	/**
+	 * Filename mustn't be Thumbs.db test.
+	 *
+	 * @throws InvalidRepositoryPathException the invalid repository path exception
+	 * @throws InvalidRepositoryFileDataException the invalid repository file data
+	 * exception
+	 * @throws IOException
+	 */
+	@Test(expected = InvalidRepositoryFileDataException.class)
+	public void invalidFilenameFromBlacklist() throws InvalidRepositoryPathException, InvalidRepositoryFileDataException, IOException {
+		String invalidFilename = "Thumbs.db";
+		repositoryService.addFile(Paths.get("/valid/path"), invalidFilename, null, FileRepositoryAddTest.EMPTY_BYTES, null);
+	}
+
 	/**
 	 * Check that SHA1 and MD5 sums are generated on add
 	 *

file-repository-core/src/test/java/org/genesys/filerepository/service/FileRepositoryExtensionTest.java

@@ -111,22 +111,6 @@ public class FileRepositoryExtensionTest extends RepositoryServiceTest {
 		fileRepoService.removeFile(repoFile);
 	}
 
-	/**
-	 * Extension dot file is null on add.
-	 *
-	 * @throws NoSuchRepositoryFileException the no such repository file exception
-	 * @throws InvalidRepositoryPathException the invalid repository path exception
-	 * @throws InvalidRepositoryFileDataException the invalid repository file data
-	 * exception
-	 * @throws IOException Signals that an I/O exception has occurred.
-	 */
-	@Test
-	public void extensionDotFileIsNullOnAdd() throws NoSuchRepositoryFileException, InvalidRepositoryPathException, InvalidRepositoryFileDataException, IOException {
-		final RepositoryFile repoFile = fileRepoService.addFile(initialPath, ".gitignore", initialContentType, EMPTY_BYTES, null);
-		FileRepositoryTestUtil.checkFile(repoFile, initialPath, ".gitignore", null, initialContentType);
-		fileRepoService.removeFile(repoFile);
-	}
-
 	/**
 	 * Extension dot file is null on update.
 	 *

file-repository-core/src/test/java/org/genesys/filerepository/service/RepositoryFolderTest.java

@@ -121,6 +121,24 @@ public class RepositoryFolderTest extends RepositoryServiceTest {
 		repositoryService.renamePath(path, newPath);
 	}
 
+	@Test(expected = InvalidRepositoryPathException.class)
+	public void failDotAtTheStartOfFolderName() throws InvalidRepositoryPathException {
+		Path path = Paths.get("/bbbb/cccc/dddd/.eeee");
+		repositoryService.ensureFolder(path);
+	}
+
+	@Test(expected = InvalidRepositoryPathException.class)
+	public void failTildeAtTheStartOfFolderName() throws InvalidRepositoryPathException {
+		Path path = Paths.get("/bbbb/cccc/dddd/~eeee");
+		repositoryService.ensureFolder(path);
+	}
+
+	@Test(expected = InvalidRepositoryPathException.class)
+	public void failExclamationMarkAtTheStartOfFolderName() throws InvalidRepositoryPathException {
+		Path path = Paths.get("/bbbb/cccc/dddd/!eeee");
+		repositoryService.ensureFolder(path);
+	}
+
 	@Test(expected = InvalidRepositoryPathException.class)
 	public void failRenamePathToExisting2() throws InvalidRepositoryPathException {
 		Path path = Paths.get("/bbbb/cccc/dddd/eeee");

file-repository-core/src/test/java/org/genesys/filerepository/service/RepositoryImageAddTest.java

@@ -83,6 +83,48 @@ public class RepositoryImageAddTest {
 		fileRepoService.removeFile(repoImage);
 	}
 
+	/**
+	 * Filename mustn't start with . test.
+	 *
+	 * @throws InvalidRepositoryPathException the invalid repository path exception
+	 * @throws InvalidRepositoryFileDataException the invalid repository file data
+	 * exception
+	 * @throws IOException
+	 */
+	@Test(expected = InvalidRepositoryFileDataException.class)
+	public void invalidDotAtTheStartOfFilename() throws InvalidRepositoryPathException, InvalidRepositoryFileDataException, IOException {
+		String invalidFilename = "." + initialOriginalFilename;
+		fileRepoService.addImage(initialPath, invalidFilename, initialContentType, EMPTY_BYTES, null);
+	}
+
+	/**
+	 * Filename mustn't start with ~ test.
+	 *
+	 * @throws InvalidRepositoryPathException the invalid repository path exception
+	 * @throws InvalidRepositoryFileDataException the invalid repository file data
+	 * exception
+	 * @throws IOException
+	 */
+	@Test(expected = InvalidRepositoryFileDataException.class)
+	public void invalidTildeAtTheStartOfFilename() throws InvalidRepositoryPathException, InvalidRepositoryFileDataException, IOException {
+		String invalidFilename = "~" + initialOriginalFilename;
+		fileRepoService.addImage(initialPath, invalidFilename, initialContentType, EMPTY_BYTES, null);
+	}
+
+	/**
+	 * Filename mustn't be Thumbs.db test.
+	 *
+	 * @throws InvalidRepositoryPathException the invalid repository path exception
+	 * @throws InvalidRepositoryFileDataException the invalid repository file data
+	 * exception
+	 * @throws IOException
+	 */
+	@Test(expected = InvalidRepositoryFileDataException.class)
+	public void invalidFilenameFromBlacklist() throws InvalidRepositoryPathException, InvalidRepositoryFileDataException, IOException {
+		String invalidFilename = "Thumbs.db";
+		fileRepoService.addImage(initialPath, invalidFilename, initialContentType, EMPTY_BYTES, null);
+	}
+
 	/**
 	 * Test metadata submission to image repository.
 	 *

file-repository-core/src/test/resources/spring/spring.properties

@@ -29,3 +29,7 @@ s3.secretKey=
 s3.bucket=
 s3.prefix=
 s3.region=
+
+# Regular expressions to blacklist file and folder names
+repository.blacklist.filename=^(\\.|\\~)|^Thumbs.db$
+repository.blacklist.foldername=(^\\.)|[~!\\/]