Add logs for file deletion

sdercolin · Nov 19, 2023 · 5efaff7 · 5efaff7
1 parent 1b14355
commit 5efaff7
Show file tree

Hide file tree

Showing 9 changed files with 48 additions and 13 deletions.
diff --git a/src/jvmMain/kotlin/com/sdercolin/vlabeler/repository/ChartRepository.kt b/src/jvmMain/kotlin/com/sdercolin/vlabeler/repository/ChartRepository.kt
@@ -8,6 +8,7 @@ import com.sdercolin.vlabeler.env.Log
 import com.sdercolin.vlabeler.model.AppConf
 import com.sdercolin.vlabeler.model.Project
 import com.sdercolin.vlabeler.model.SampleInfo
+import com.sdercolin.vlabeler.util.deleteRecursivelyLogged
 import com.sdercolin.vlabeler.util.findUnusedFile
 import com.sdercolin.vlabeler.util.getCacheDir
 import com.sdercolin.vlabeler.util.parseJson
@@ -59,7 +60,7 @@ object ChartRepository {
             cacheParamsFile.takeIf { it.exists() }?.readText()?.parseJson<ChartCacheParams>()
         }.getOrNull()
         if (existingCacheParams != cacheParams) {
-            cacheDirectory.deleteRecursively()
+            cacheDirectory.deleteRecursivelyLogged()
             cacheDirectory.mkdirs()
             cacheParamsFile.writeText(cacheParams.stringifyJson())
         }
@@ -212,17 +213,18 @@ object ChartRepository {
 
     fun clear(project: Project) {
         cacheMap.clear()
-        project.getCacheDir().resolve(CHARTS_CACHE_FOLDER_NAME).deleteRecursively()
+        project.getCacheDir().resolve(CHARTS_CACHE_FOLDER_NAME).deleteRecursivelyLogged()
     }
 
     /**
      * Move the cache from the old cache directory to the new cache directory.
      */
     fun moveTo(oldCacheDirectory: File, newCacheDirectory: File, clearOld: Boolean) {
+        Log.debug("Moving cache from $oldCacheDirectory to $newCacheDirectory")
         val oldDirectory = oldCacheDirectory.resolve(CHARTS_CACHE_FOLDER_NAME)
         if (oldDirectory.isDirectory.not()) return
         oldDirectory.copyRecursively(newCacheDirectory.resolve(CHARTS_CACHE_FOLDER_NAME), overwrite = true)
-        if (clearOld) oldDirectory.deleteRecursively()
+        if (clearOld) oldDirectory.deleteRecursivelyLogged()
     }
 
     private const val CHARTS_CACHE_FOLDER_NAME = "charts"

diff --git a/src/jvmMain/kotlin/com/sdercolin/vlabeler/repository/ConvertedAudioRepository.kt b/src/jvmMain/kotlin/com/sdercolin/vlabeler/repository/ConvertedAudioRepository.kt
@@ -2,8 +2,10 @@ package com.sdercolin.vlabeler.repository
 
 import androidx.compose.runtime.Stable
 import com.sdercolin.vlabeler.audio.conversion.WaveConverter
+import com.sdercolin.vlabeler.env.Log
 import com.sdercolin.vlabeler.model.AppConf
 import com.sdercolin.vlabeler.model.Project
+import com.sdercolin.vlabeler.util.deleteRecursivelyLogged
 import com.sdercolin.vlabeler.util.findUnusedFile
 import com.sdercolin.vlabeler.util.getCacheDir
 import com.sdercolin.vlabeler.util.parseJson
@@ -60,17 +62,18 @@ object ConvertedAudioRepository {
      * Clear cached sample information files.
      */
     fun clear(project: Project) {
-        project.getCacheDir().resolve(WAVE_CACHE_FOLDER_NAME).deleteRecursively()
+        project.getCacheDir().resolve(WAVE_CACHE_FOLDER_NAME).deleteRecursivelyLogged()
     }
 
     /**
      * Move the cache from the old cache directory to the new cache directory.
      */
     fun moveTo(oldCacheDirectory: File, newCacheDirectory: File, clearOld: Boolean) {
+        Log.debug("Moving cache from $oldCacheDirectory to $newCacheDirectory")
         val oldDirectory = oldCacheDirectory.resolve(WAVE_CACHE_FOLDER_NAME)
         if (oldDirectory.isDirectory.not()) return
         oldDirectory.copyRecursively(newCacheDirectory.resolve(WAVE_CACHE_FOLDER_NAME), overwrite = true)
-        if (clearOld) oldDirectory.deleteRecursively()
+        if (clearOld) oldDirectory.deleteRecursivelyLogged()
     }
 
     private const val WAVE_CACHE_FOLDER_NAME = "wav"

diff --git a/src/jvmMain/kotlin/com/sdercolin/vlabeler/repository/SampleInfoRepository.kt b/src/jvmMain/kotlin/com/sdercolin/vlabeler/repository/SampleInfoRepository.kt
@@ -5,6 +5,7 @@ import com.sdercolin.vlabeler.env.Log
 import com.sdercolin.vlabeler.model.AppConf
 import com.sdercolin.vlabeler.model.Project
 import com.sdercolin.vlabeler.model.SampleInfo
+import com.sdercolin.vlabeler.util.deleteRecursivelyLogged
 import com.sdercolin.vlabeler.util.findUnusedFile
 import com.sdercolin.vlabeler.util.getCacheDir
 import com.sdercolin.vlabeler.util.parseJson
@@ -99,17 +100,18 @@ object SampleInfoRepository {
     fun clear(project: Project) {
         infoMap.clear()
         cacheMap.clear()
-        project.getCacheDir().resolve(SAMPLE_INFO_CACHE_FOLDER_NAME).deleteRecursively()
+        project.getCacheDir().resolve(SAMPLE_INFO_CACHE_FOLDER_NAME).deleteRecursivelyLogged()
     }
 
     /**
      * Move the cache from the old cache directory to the new cache directory.
      */
     fun moveTo(oldCacheDirectory: File, newCacheDirectory: File, clearOld: Boolean) {
+        Log.debug("Moving cache from $oldCacheDirectory to $newCacheDirectory")
         val oldDirectory = oldCacheDirectory.resolve(SAMPLE_INFO_CACHE_FOLDER_NAME)
         if (oldDirectory.isDirectory.not()) return
         oldDirectory.copyRecursively(newCacheDirectory.resolve(SAMPLE_INFO_CACHE_FOLDER_NAME), overwrite = true)
-        if (clearOld) oldDirectory.deleteRecursively()
+        if (clearOld) oldDirectory.deleteRecursivelyLogged()
     }
 
     private const val SAMPLE_INFO_CACHE_FOLDER_NAME = "sample-info"

diff --git a/src/jvmMain/kotlin/com/sdercolin/vlabeler/repository/update/UpdateRepository.kt b/src/jvmMain/kotlin/com/sdercolin/vlabeler/repository/update/UpdateRepository.kt
@@ -93,6 +93,7 @@ class UpdateRepository {
                         onProgress(1f)
                         return@execute
                     } else {
+                        Log.debug("Deleting outdated update file: ${file.absolutePath}")
                         file.delete()
                     }
                 }

diff --git a/src/jvmMain/kotlin/com/sdercolin/vlabeler/ui/AppState.kt b/src/jvmMain/kotlin/com/sdercolin/vlabeler/ui/AppState.kt
@@ -63,6 +63,7 @@ import com.sdercolin.vlabeler.ui.string.*
 import com.sdercolin.vlabeler.util.AppDir
 import com.sdercolin.vlabeler.util.ParamMap
 import com.sdercolin.vlabeler.util.RecordDir
+import com.sdercolin.vlabeler.util.deleteRecursivelyLogged
 import com.sdercolin.vlabeler.util.getDefaultNewEntryName
 import com.sdercolin.vlabeler.util.toFile
 import com.sdercolin.vlabeler.util.toFrame
@@ -367,11 +368,11 @@ class AppState(
                     action.state.removeItem(action.item)
                 }
                 is CommonConfirmationDialogAction.ClearAppData -> {
-                    AppDir.deleteRecursively()
+                    AppDir.deleteRecursivelyLogged()
                     exit()
                 }
                 is CommonConfirmationDialogAction.ClearAppRecord -> {
-                    RecordDir.deleteRecursively()
+                    RecordDir.deleteRecursivelyLogged()
                     exit()
                 }
             }

diff --git a/src/jvmMain/kotlin/com/sdercolin/vlabeler/ui/ProjectStore.kt b/src/jvmMain/kotlin/com/sdercolin/vlabeler/ui/ProjectStore.kt
@@ -476,7 +476,7 @@ class ProjectStoreImpl(
     override fun getAutoSavedProjectFile(): File? = listAutoSavedProjectFiles().firstOrNull()
 
     override fun discardAutoSavedProjects() {
-        listAutoSavedProjectFiles().forEach { it.delete() }
+        listAutoSavedProjectFiles().forEach { discardAutoSavedProjectFile(it) }
     }
 
     override suspend fun terminateAutoSaveProject() {
@@ -485,7 +485,13 @@ class ProjectStoreImpl(
     }
 
     private fun discardAutoSavedProject(project: Project) {
-        RecordDir.resolve("_" + project.projectFile.name).takeIf { it.exists() }?.delete()
+        val file = RecordDir.resolve("_" + project.projectFile.name).takeIf { it.exists() } ?: return
+        discardAutoSavedProjectFile(file)
+    }
+
+    private fun discardAutoSavedProjectFile(file: File) {
+        Log.debug("Discarding auto saved project: ${file.absolutePath}")
+        file.delete()
     }
 
     private var autoSaveJob: Job? = null

diff --git a/src/jvmMain/kotlin/com/sdercolin/vlabeler/ui/dialog/customization/CustomizableItem.kt b/src/jvmMain/kotlin/com/sdercolin/vlabeler/ui/dialog/customization/CustomizableItem.kt
@@ -3,7 +3,8 @@ package com.sdercolin.vlabeler.ui.dialog.customization
 import androidx.compose.runtime.getValue
 import androidx.compose.runtime.mutableStateOf
 import androidx.compose.runtime.setValue
-import com.sdercolin.vlabeler.ui.string.*
+import com.sdercolin.vlabeler.env.Log
+import com.sdercolin.vlabeler.ui.string.LocalizedJsonString
 import com.sdercolin.vlabeler.util.Url
 import java.awt.Desktop
 import java.io.File
@@ -21,7 +22,11 @@ abstract class CustomizableItem(
     disabled: Boolean,
 ) {
 
-    fun remove(): Boolean = rootFile.deleteRecursively()
+    fun remove(): Boolean = rootFile.deleteRecursively().also {
+        if (it) {
+            Log.debug("Removed CustomizableItem $rootFile")
+        }
+    }
 
     fun revealInExplorer() {
         val file = if (rootFile.isDirectory) rootFile else rootFile.parentFile

diff --git a/src/jvmMain/kotlin/com/sdercolin/vlabeler/ui/editor/ChartStore.kt b/src/jvmMain/kotlin/com/sdercolin/vlabeler/ui/editor/ChartStore.kt
@@ -221,6 +221,7 @@ class ChartStore {
     ) {
         val targetFile = ChartRepository.getWaveformImageFile(sampleInfo, channelIndex, chunkIndex)
         if (targetFile.exists()) {
+            Log.debug("Deleting outdated cache: ${targetFile.absolutePath}")
             targetFile.delete()
         }
     }
@@ -294,6 +295,7 @@ class ChartStore {
     ) {
         val targetFile = ChartRepository.getSpectrogramImageFile(sampleInfo, chunkIndex)
         if (targetFile.exists()) {
+            Log.debug("Deleting outdated cache: ${targetFile.absolutePath}")
             targetFile.delete()
         }
     }
@@ -394,6 +396,7 @@ class ChartStore {
     ) {
         val targetFile = ChartRepository.getPowerGraphImageFile(sampleInfo, channelIndex, chunkIndex)
         if (targetFile.exists()) {
+            Log.debug("Deleting outdated cache: ${targetFile.absolutePath}")
             targetFile.delete()
         }
     }

diff --git a/src/jvmMain/kotlin/com/sdercolin/vlabeler/util/File.kt b/src/jvmMain/kotlin/com/sdercolin/vlabeler/util/File.kt
@@ -1,5 +1,6 @@
 package com.sdercolin.vlabeler.util
 
+import com.sdercolin.vlabeler.env.Log
 import com.sdercolin.vlabeler.env.isFileSystemCaseSensitive
 import java.io.File
 import java.io.FilenameFilter
@@ -86,6 +87,17 @@ fun File.containsFileRecursively(file: File): Boolean {
     return true
 }
 
+/**
+ * Execute [File.deleteRecursively] and log if success.
+ */
+fun File.deleteRecursivelyLogged() {
+    if (exists().not()) return
+    val result = deleteRecursively()
+    if (result) {
+        Log.debug("Deleted recursively: $absolutePath")
+    }
+}
+
 /**
  * Remove the directory if it is empty. (.DS_Store is ignored)
  */