Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

FileReplacer exception handling and tmpfile cleanup #44

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

FileReplacer exception handling and tmpfile cleanup #44

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
58 changes: 33 additions & 25 deletions common/src/main/java/org/sonatype/goodies/common/FileReplacer.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,7 @@
import java.io.IOException;
import java.util.concurrent.atomic.AtomicInteger;

import com.google.common.base.Throwables;
import com.google.common.io.Files;
import org.slf4j.Logger;

Expand Down Expand Up @@ -45,7 +46,7 @@ public class FileReplacer

private boolean deleteBackupFile;

public FileReplacer(final File file) throws IOException {
public FileReplacer(final File file) {
this.file = checkNotNull(file);

// not using File.createTempFile() here so tmp + backup can share same timestamp-id
Expand All @@ -55,15 +56,6 @@ public FileReplacer(final File file) throws IOException {
this.filePrefix = file.getName() + "-" + System.currentTimeMillis() + "-" + counter.getAndIncrement();
this.tempFile = new File(file.getParentFile(), filePrefix + ".tmp");
this.backupFile = new File(file.getParentFile(), filePrefix + ".bak");

file.getParentFile().mkdirs();

if (tempFile.exists()) {
log.warn("Temporary file already exists; removing: {}", tempFile);
delete(tempFile);
}

tempFile.createNewFile();
}

public FileReplacer(final String fileName) throws IOException {
Expand All @@ -77,6 +69,13 @@ private void delete(final File file) throws IOException {
}
}

private void create(final File file) throws IOException {
boolean created = file.createNewFile();
if (!created) {
throw new IOException("Failed to create file: " + file);
}
}

public File getFile() {
return file;
}
Expand All @@ -97,35 +96,44 @@ public void setDeleteBackupFile(final boolean deleteBackupFile) {
this.deleteBackupFile = deleteBackupFile;
}

public static interface ContentWriter
public interface ContentWriter
{
void write(final BufferedOutputStream output) throws IOException;
}

public void replace(final ContentWriter writer) throws IOException {
checkNotNull(writer);

// setup buffering, as almost certainly anywhere using this class is going to want this
BufferedOutputStream output = new BufferedOutputStream(new FileOutputStream(tempFile));
// prepare directory structure
file.getParentFile().mkdirs();
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

this also should be verified to ensure sanity


// prepare temporary file
if (tempFile.exists()) {
log.warn("Temporary file already exists; removing: {}", tempFile);
delete(tempFile);
}
create(tempFile);

// delegate to do the write operation
try {
try {
// delegate to do the write operation
try (BufferedOutputStream output = new BufferedOutputStream(new FileOutputStream(tempFile))) {
writer.write(output);
}
finally {
// always close after success or failure
output.close();
catch (Exception e) {
// complain with details about temp file and propagate exception
log.warn("Failed to write temporary file: {}", tempFile, e);
Throwables.propagateIfPossible(e, IOException.class);
throw Throwables.propagate(e);
}

// replace the file only if operation succeeded
replaceFile();
}
catch (IOException e) {
// complain with details about temp file and propagate exception
log.warn("Failed to write temporary file: {}", tempFile, e);
throw e;
finally {
if (tempFile.exists()) {
delete(tempFile);
}
}

// replace the file only if operation succeeded
replaceFile();
}

private void replaceFile() throws IOException {
Expand Down