tmf.core: Add auditable message confirming supplementary files were d…

…eleted Set to level Config to not fill the console. [Security] Have an artifact proving when the supplementary files are cleaned Change-Id: I7980e5a7cf7c82dd47abe32aa78b2ceac13766cc Signed-off-by: Matthew Khouzam <matthew.khouzam@ericsson.com> Reviewed-on: https://git.eclipse.org/r/c/tracecompass/org.eclipse.tracecompass/+/201646 Tested-by: Trace Compass Bot <tracecompass-bot@eclipse.org> Tested-by: Patrick Tasse <patrick.tasse@gmail.com> Reviewed-by: Patrick Tasse <patrick.tasse@gmail.com>
eclipse-tracecompass · May 23, 2023 · 4d4d2a3 · 4d4d2a3
1 parent f0f09cb
commit 4d4d2a3
Show file tree

Hide file tree

Showing 2 changed files with 22 additions and 2 deletions.
diff --git a/...se.tracecompass.tmf.core/src/org/eclipse/tracecompass/tmf/core/trace/TmfTraceManager.java b/...se.tracecompass.tmf.core/src/org/eclipse/tracecompass/tmf/core/trace/TmfTraceManager.java
@@ -29,6 +29,8 @@
 import java.util.Objects;
 import java.util.Set;
 import java.util.function.UnaryOperator;
+import java.util.logging.Level;
+import java.util.logging.Logger;
 import java.util.stream.Collectors;
 
 import org.apache.commons.io.FileUtils;
@@ -44,6 +46,8 @@
 import org.eclipse.jdt.annotation.NonNullByDefault;
 import org.eclipse.jdt.annotation.Nullable;
 import org.eclipse.tracecompass.common.core.NonNullUtils;
+import org.eclipse.tracecompass.common.core.log.TraceCompassLog;
+import org.eclipse.tracecompass.common.core.log.TraceCompassLogUtils;
 import org.eclipse.tracecompass.internal.tmf.core.Activator;
 import org.eclipse.tracecompass.tmf.core.TmfCommonConstants;
 import org.eclipse.tracecompass.tmf.core.signal.TmfEventFilterAppliedSignal;
@@ -92,6 +96,8 @@ public final class TmfTraceManager {
 
     private static final String TEMP_DIR_NAME = ".tracecompass-temp"; //$NON-NLS-1$
 
+    private static final Logger LOGGER = TraceCompassLog.getLogger(TmfTraceManager.class);
+
     // ------------------------------------------------------------------------
     // Constructor
     // ------------------------------------------------------------------------
@@ -371,7 +377,10 @@ public static void refreshSupplementaryFiles(ITmfTrace trace) {
      */
     public static void deleteSupplementaryFiles(ITmfTrace trace) {
         try {
-            FileUtils.cleanDirectory(new File(TmfTraceManager.getSupplementaryFileDir(trace)));
+            String supplementaryFileDir = TmfTraceManager.getSupplementaryFileDir(trace);
+            FileUtils.cleanDirectory(new File(supplementaryFileDir));
+            // Needed to audit for privacy concerns
+            TraceCompassLogUtils.traceInstant(LOGGER, Level.CONFIG, "deleteSupplementaryFiles", supplementaryFileDir); //$NON-NLS-1$
         } catch (IOException e) {
             Activator.logError("Error deleting supplementary files for trace " + trace.getName(), e); //$NON-NLS-1$
         }
@@ -390,7 +399,10 @@ public static void deleteSupplementaryFolder(ITmfTrace trace) {
         deleteSupplementaryFiles(trace);
         File parent = new File(TmfTraceManager.getSupplementaryFileDir(trace));
         try {
-            deleteFolder(parent, getTemporaryDirPath());
+            String temporaryDirPath = getTemporaryDirPath();
+            deleteFolder(parent, temporaryDirPath);
+            // Needed to audit for privacy concerns
+            TraceCompassLogUtils.traceInstant(LOGGER, Level.CONFIG, "deleteSupplementaryFolder", temporaryDirPath); //$NON-NLS-1$
         } catch (IOException e) {
             Activator.logError("Error deleting supplementary folder for trace " + trace.getName(), e); //$NON-NLS-1$
         }

diff --git a/...ass.tmf.ui/src/org/eclipse/tracecompass/tmf/ui/project/model/TmfCommonProjectElement.java b/...ass.tmf.ui/src/org/eclipse/tracecompass/tmf/ui/project/model/TmfCommonProjectElement.java
@@ -25,6 +25,8 @@
 import java.util.ArrayList;
 import java.util.Collections;
 import java.util.List;
+import java.util.logging.Level;
+import java.util.logging.Logger;
 import java.util.stream.Collectors;
 
 import org.eclipse.core.resources.IContainer;
@@ -46,6 +48,8 @@
 import org.eclipse.jdt.annotation.NonNull;
 import org.eclipse.osgi.util.NLS;
 import org.eclipse.swt.graphics.Image;
+import org.eclipse.tracecompass.common.core.log.TraceCompassLog;
+import org.eclipse.tracecompass.common.core.log.TraceCompassLogUtils;
 import org.eclipse.tracecompass.internal.tmf.ui.Activator;
 import org.eclipse.tracecompass.internal.tmf.ui.editors.ITmfEventsEditorConstants;
 import org.eclipse.tracecompass.tmf.core.TmfCommonConstants;
@@ -77,6 +81,8 @@ public abstract class TmfCommonProjectElement extends TmfProjectModelElement {
 
     private static final String BOOKMARKS_HIDDEN_FILE = ".bookmarks"; //$NON-NLS-1$
 
+    private static final @NonNull Logger LOGGER = TraceCompassLog.getLogger(TmfCommonProjectElement.class);
+
     /* Direct child elements */
     private TmfViewsElement fViewsElement = null;
     private TmfOnDemandAnalysesElement fOnDemandAnalysesElement = null;
@@ -711,6 +717,8 @@ public void deleteSupplementaryResources(IResource[] resources) {
         for (int i = 0; i < resources.length; i++) {
             try {
                 resources[i].delete(true, new NullProgressMonitor());
+                // Needed to audit for privacy concerns
+                TraceCompassLogUtils.traceInstant(LOGGER, Level.CONFIG, "deleteSupplementaryResources", resources[i].getFullPath().toOSString() ); //$NON-NLS-1$
             } catch (CoreException e) {
                 Activator.getDefault().logError("Error deleting supplementary resource " + resources[i], e); //$NON-NLS-1$
             }