-
Notifications
You must be signed in to change notification settings - Fork 38.1k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Ensure DefaultPartHttpMessageReader temp directories do not collide
This commit makes sure that the DefaultPartHttpMessageReader uses a random temporary directory to store uploaded files, so that two instances do not collide. See gh-26931
- Loading branch information
Showing
4 changed files
with
217 additions
and
25 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
128 changes: 128 additions & 0 deletions
128
spring-web/src/main/java/org/springframework/http/codec/multipart/FileStorage.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,128 @@ | ||
/* | ||
* Copyright 2002-2021 the original author or authors. | ||
* | ||
* Licensed under the Apache License, Version 2.0 (the "License"); | ||
* you may not use this file except in compliance with the License. | ||
* You may obtain a copy of the License at | ||
* | ||
* https://www.apache.org/licenses/LICENSE-2.0 | ||
* | ||
* Unless required by applicable law or agreed to in writing, software | ||
* distributed under the License is distributed on an "AS IS" BASIS, | ||
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
* See the License for the specific language governing permissions and | ||
* limitations under the License. | ||
*/ | ||
|
||
package org.springframework.http.codec.multipart; | ||
|
||
import java.io.IOException; | ||
import java.nio.file.Files; | ||
import java.nio.file.Path; | ||
import java.util.function.Supplier; | ||
|
||
import org.apache.commons.logging.Log; | ||
import org.apache.commons.logging.LogFactory; | ||
import reactor.core.publisher.Mono; | ||
import reactor.core.scheduler.Scheduler; | ||
|
||
/** | ||
* Represents a directory used to store parts larger than | ||
* {@link DefaultPartHttpMessageReader#setMaxInMemorySize(int)}. | ||
* | ||
* @author Arjen Poutsma | ||
* @since 5.3.7 | ||
*/ | ||
abstract class FileStorage { | ||
|
||
private static final Log logger = LogFactory.getLog(FileStorage.class); | ||
|
||
|
||
protected FileStorage() { | ||
} | ||
|
||
/** | ||
* Get the mono of the directory to store files in. | ||
*/ | ||
public abstract Mono<Path> directory(); | ||
|
||
|
||
/** | ||
* Create a new {@code FileStorage} from a user-specified path. Creates the | ||
* path if it does not exist. | ||
*/ | ||
public static FileStorage fromPath(Path path) throws IOException { | ||
if (!Files.exists(path)) { | ||
Files.createDirectory(path); | ||
} | ||
return new PathFileStorage(path); | ||
} | ||
|
||
/** | ||
* Create a new {@code FileStorage} based a on a temporary directory. | ||
* @param scheduler scheduler to use for blocking operations | ||
*/ | ||
public static FileStorage tempDirectory(Supplier<Scheduler> scheduler) { | ||
return new TempFileStorage(scheduler); | ||
} | ||
|
||
|
||
private static final class PathFileStorage extends FileStorage { | ||
|
||
private final Mono<Path> directory; | ||
|
||
public PathFileStorage(Path directory) { | ||
this.directory = Mono.just(directory); | ||
} | ||
|
||
@Override | ||
public Mono<Path> directory() { | ||
return this.directory; | ||
} | ||
} | ||
|
||
|
||
private static final class TempFileStorage extends FileStorage { | ||
|
||
private static final String IDENTIFIER = "spring-multipart-"; | ||
|
||
private final Supplier<Scheduler> scheduler; | ||
|
||
private volatile Mono<Path> directory = tempDirectory(); | ||
|
||
|
||
public TempFileStorage(Supplier<Scheduler> scheduler) { | ||
this.scheduler = scheduler; | ||
} | ||
|
||
@Override | ||
public Mono<Path> directory() { | ||
return this.directory | ||
.flatMap(this::createNewDirectoryIfDeleted) | ||
.subscribeOn(this.scheduler.get()); | ||
} | ||
|
||
private Mono<Path> createNewDirectoryIfDeleted(Path directory) { | ||
if (!Files.exists(directory)) { | ||
// Some daemons remove temp directories. Let's create a new one. | ||
Mono<Path> newDirectory = tempDirectory(); | ||
this.directory = newDirectory; | ||
return newDirectory; | ||
} | ||
else { | ||
return Mono.just(directory); | ||
} | ||
} | ||
|
||
private static Mono<Path> tempDirectory() { | ||
return Mono.fromCallable(() -> { | ||
Path directory = Files.createTempDirectory(IDENTIFIER); | ||
if (logger.isDebugEnabled()) { | ||
logger.debug("Created temporary storage directory: " + directory); | ||
} | ||
return directory; | ||
}).cache(); | ||
} | ||
} | ||
|
||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
82 changes: 82 additions & 0 deletions
82
spring-web/src/test/java/org/springframework/http/codec/multipart/FileStorageTests.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,82 @@ | ||
/* | ||
* Copyright 2002-2021 the original author or authors. | ||
* | ||
* Licensed under the Apache License, Version 2.0 (the "License"); | ||
* you may not use this file except in compliance with the License. | ||
* You may obtain a copy of the License at | ||
* | ||
* https://www.apache.org/licenses/LICENSE-2.0 | ||
* | ||
* Unless required by applicable law or agreed to in writing, software | ||
* distributed under the License is distributed on an "AS IS" BASIS, | ||
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
* See the License for the specific language governing permissions and | ||
* limitations under the License. | ||
*/ | ||
|
||
package org.springframework.http.codec.multipart; | ||
|
||
import java.io.IOException; | ||
import java.io.UncheckedIOException; | ||
import java.nio.file.Files; | ||
import java.nio.file.Path; | ||
|
||
import org.junit.jupiter.api.Test; | ||
import reactor.core.publisher.Mono; | ||
import reactor.core.scheduler.Schedulers; | ||
import reactor.test.StepVerifier; | ||
|
||
import static org.assertj.core.api.Assertions.assertThat; | ||
|
||
/** | ||
* @author Arjen Poutsma | ||
*/ | ||
class FileStorageTests { | ||
|
||
@Test | ||
void fromPath() throws IOException { | ||
Path path = Files.createTempFile("spring", "test"); | ||
FileStorage storage = FileStorage.fromPath(path); | ||
|
||
Mono<Path> directory = storage.directory(); | ||
StepVerifier.create(directory) | ||
.expectNext(path) | ||
.verifyComplete(); | ||
} | ||
|
||
@Test | ||
void tempDirectory() { | ||
FileStorage storage = FileStorage.tempDirectory(Schedulers::boundedElastic); | ||
|
||
Mono<Path> directory = storage.directory(); | ||
StepVerifier.create(directory) | ||
.consumeNextWith(path -> { | ||
assertThat(path).exists(); | ||
StepVerifier.create(directory) | ||
.expectNext(path) | ||
.verifyComplete(); | ||
}) | ||
.verifyComplete(); | ||
} | ||
|
||
@Test | ||
void tempDirectoryDeleted() { | ||
FileStorage storage = FileStorage.tempDirectory(Schedulers::boundedElastic); | ||
|
||
Mono<Path> directory = storage.directory(); | ||
StepVerifier.create(directory) | ||
.consumeNextWith(path1 -> { | ||
try { | ||
Files.delete(path1); | ||
StepVerifier.create(directory) | ||
.consumeNextWith(path2 -> assertThat(path2).isNotEqualTo(path1)) | ||
.verifyComplete(); | ||
} | ||
catch (IOException ex) { | ||
throw new UncheckedIOException(ex); | ||
} | ||
}) | ||
.verifyComplete(); | ||
} | ||
|
||
} |