summaryrefslogtreecommitdiff
path: root/core/java/android/util/AtomicFile.java
diff options
context:
space:
mode:
authorTreeHugger Robot <treehugger-gerrit@google.com>2020-05-20 23:20:42 +0000
committerAndroid (Google) Code Review <android-gerrit@google.com>2020-05-20 23:20:42 +0000
commit5c77ec2e125bca742ba44ad94535368f617be29d (patch)
treeb80995c6ca8fce640770ae8477a9af0ca2df6f53 /core/java/android/util/AtomicFile.java
parent129b3ffbbbfb482926782c6c5f9d2781913aeed9 (diff)
parentcf2ee87fd43aaacd8e952fc9bc116fd27f2d8eb7 (diff)
Merge "Maintain compatibility by deleting target directory before renaming into it." into rvc-dev
Diffstat (limited to 'core/java/android/util/AtomicFile.java')
-rw-r--r--core/java/android/util/AtomicFile.java31
1 files changed, 20 insertions, 11 deletions
diff --git a/core/java/android/util/AtomicFile.java b/core/java/android/util/AtomicFile.java
index 7ede6531899c..e0d857af597c 100644
--- a/core/java/android/util/AtomicFile.java
+++ b/core/java/android/util/AtomicFile.java
@@ -116,10 +116,7 @@ public class AtomicFile {
mStartTime = startTime;
if (mLegacyBackupName.exists()) {
- if (!mLegacyBackupName.renameTo(mBaseName)) {
- Log.e(LOG_TAG, "Failed to rename legacy backup file " + mLegacyBackupName
- + " to base file " + mBaseName);
- }
+ rename(mLegacyBackupName, mBaseName);
}
try {
@@ -157,9 +154,7 @@ public class AtomicFile {
} catch (IOException e) {
Log.e(LOG_TAG, "Failed to close file output stream", e);
}
- if (!mNewName.renameTo(mBaseName)) {
- Log.e(LOG_TAG, "Failed to rename new file " + mNewName + " to base file " + mBaseName);
- }
+ rename(mNewName, mBaseName);
if (mCommitTag != null) {
com.android.internal.logging.EventLogTags.writeCommitSysConfigFile(
mCommitTag, SystemClock.uptimeMillis() - mStartTime);
@@ -221,10 +216,7 @@ public class AtomicFile {
*/
public FileInputStream openRead() throws FileNotFoundException {
if (mLegacyBackupName.exists()) {
- if (!mLegacyBackupName.renameTo(mBaseName)) {
- Log.e(LOG_TAG, "Failed to rename legacy backup file " + mLegacyBackupName
- + " to base file " + mBaseName);
- }
+ rename(mLegacyBackupName, mBaseName);
}
// It was okay to call openRead() between startWrite() and finishWrite() for the first time
@@ -311,4 +303,21 @@ public class AtomicFile {
IoUtils.closeQuietly(out);
}
}
+
+ private static void rename(File source, File target) {
+ // We used to delete the target file before rename, but that isn't atomic, and the rename()
+ // syscall should atomically replace the target file. However in the case where the target
+ // file is a directory, a simple rename() won't work. We need to delete the file in this
+ // case because there are callers who erroneously called mBaseName.mkdirs() (instead of
+ // mBaseName.getParentFile().mkdirs()) before creating the AtomicFile, and it worked
+ // regardless, so this deletion became some kind of API.
+ if (target.isDirectory()) {
+ if (!target.delete()) {
+ Log.e(LOG_TAG, "Failed to delete file which is a directory " + target);
+ }
+ }
+ if (!source.renameTo(target)) {
+ Log.e(LOG_TAG, "Failed to rename " + source + " to " + target);
+ }
+ }
}