DYN-5968 Make timestamp as part of Dynamo Preferences setting (#14082)

QilongTang · web-flow · commit 06756feee903 · 2023-06-16T10:52:48.000-07:00
* Make timestamp as part of Dynamo Preferences setting

* Obsolete API instead of direct modify

* Update Unit test

* clean up

* Update resources
diff --git a/src/DynamoCore/Configuration/PreferenceSettings.cs b/src/DynamoCore/Configuration/PreferenceSettings.cs
@@ -58,6 +58,7 @@ public class PreferenceSettings : NotificationObject, IPreferences, IRenderPreci
         private bool isNotificationCenterEnabled;
         private bool isEnablePersistExtensionsEnabled;
         private bool isStaticSplashScreenEnabled;
+        private bool isTimeStampIncludedInExportFilePath;
         private bool isCreatedFromValidFile = true;
         private string backupLocation;
 
@@ -113,6 +114,21 @@ public class PreferenceSettings : NotificationObject, IPreferences, IRenderPreci
         /// </summary>
         public bool IsAnalyticsReportingApproved { get; set; }
 
+        /// <summary>
+        /// This defines if the user export file path would include timestamp
+        /// </summary>
+        public bool IsTimeStampIncludedInExportFilePath
+        {
+            get
+            {
+                return isTimeStampIncludedInExportFilePath;
+            }
+            set
+            {
+                isTimeStampIncludedInExportFilePath = value;
+            }
+        }
+
         /// <summary>
         /// Indicates whether ADP analytics reporting is approved or not.
         /// Note that the getter will communicate to a analytics server which might be slow.
@@ -889,6 +905,7 @@ public PreferenceSettings()
             HideAutocompleteMethodOptions = false;
             EnableNotificationCenter = true;
             isStaticSplashScreenEnabled = true;
+            isTimeStampIncludedInExportFilePath = true;
             DefaultPythonEngine = string.Empty;
             ViewExtensionSettings = new List<ViewExtensionSettings>();
             GroupStyleItemsList = new List<GroupStyleItem>();
diff --git a/src/DynamoCoreWpf/Properties/Resources.Designer.cs b/src/DynamoCoreWpf/Properties/Resources.Designer.cs
diff --git a/src/DynamoCoreWpf/Properties/Resources.en-US.resx b/src/DynamoCoreWpf/Properties/Resources.en-US.resx
@@ -3629,7 +3629,7 @@ In certain complex graphs or host program scenarios, Automatic mode may cause in
   </data>
   <data name="PreferencesGrahicHelpersScaleTooltip" xml:space="preserve">
     <value>Select a scale for the background graphic helpers (grids, axes).</value>
-  </data>    
+  </data>
   <data name="LibraryLoadFailureMessageSuffix" xml:space="preserve">
     <value>See the console log for the details of the import failure.</value>
   </data>
@@ -3645,5 +3645,10 @@ In certain complex graphs or host program scenarios, Automatic mode may cause in
   <data name="CantExportWorkspaceAsImageNotValidMessage" xml:space="preserve">
     <value>The workspace cannot be exported as an image because it contains nodes that are too far away from each other.</value>
   </data>
-</root>
-
+  <data name="PreferencesViewSettingIncludeTimestampExportPath" xml:space="preserve">
+    <value>Include Timestamp in Export Path</value>
+  </data>
+  <data name="PreferencesViewIncludeTimestampExportPathTooltip" xml:space="preserve">
+    <value>This setting controls if the export image path from workspace or background geometry would include timestamp.</value>
+  </data>
+</root>
diff --git a/src/DynamoCoreWpf/Properties/Resources.resx b/src/DynamoCoreWpf/Properties/Resources.resx
@@ -3632,4 +3632,10 @@ In certain complex graphs or host program scenarios, Automatic mode may cause in
   <data name="CantExportWorkspaceAsImageNotValidMessage" xml:space="preserve">
     <value>The workspace cannot be exported as an image because it contains nodes that are too far away from each other.</value>
   </data>
-</root>
+  <data name="PreferencesViewSettingIncludeTimestampExportPath" xml:space="preserve">
+    <value>Include Timestamp in Export Path</value>
+  </data>
+  <data name="PreferencesViewIncludeTimestampExportPathTooltip" xml:space="preserve">
+    <value>This setting controls if the export image path from workspace or background geometry would include timestamp.</value>
+  </data>
+</root>
diff --git a/src/DynamoCoreWpf/ViewModels/Core/DynamoViewModel.cs b/src/DynamoCoreWpf/ViewModels/Core/DynamoViewModel.cs
@@ -2786,7 +2786,7 @@ public void ShowSaveImageDialogAndSave(object parameter)
             if (!string.IsNullOrEmpty(model.CurrentWorkspace.FileName))
             {
                 var fi = new FileInfo(model.CurrentWorkspace.FileName);
-                var snapshotName = PathHelper.GetScreenCaptureNameFromPath(fi.FullName);
+                var snapshotName = PathHelper.GetScreenCaptureNameFromPath(fi.FullName, preferencesViewModel.IsTimeStampIncludedInExportFilePath);
                 _fileDialog.InitialDirectory = fi.DirectoryName;
                 _fileDialog.FileName = snapshotName;
             }
diff --git a/src/DynamoCoreWpf/ViewModels/Menu/PreferencesViewModel.cs b/src/DynamoCoreWpf/ViewModels/Menu/PreferencesViewModel.cs
@@ -367,6 +367,22 @@ public bool StaticSplashScreenEnabled
             }
         }
 
+        /// <summary>
+        /// Controls the IsChecked property in the selecting to include timestamp for export path section
+        /// </summary>
+        public bool IsTimeStampIncludedInExportFilePath
+        {
+            get
+            {
+                return preferenceSettings.IsTimeStampIncludedInExportFilePath;
+            }
+            set
+            {
+                preferenceSettings.IsTimeStampIncludedInExportFilePath = value;
+                RaisePropertyChanged(nameof(IsTimeStampIncludedInExportFilePath));
+            }
+        }
+
         /// <summary>
         /// Controls the Enabled property in the Show Run Preview toogle button
         /// </summary>
diff --git a/src/DynamoCoreWpf/Views/Menu/PreferencesView.xaml b/src/DynamoCoreWpf/Views/Menu/PreferencesView.xaml
@@ -221,6 +221,7 @@
                                     <RowDefinition Height="Auto" />
                                     <RowDefinition Height="Auto" />
                                     <RowDefinition Height="Auto" />
+                                    <RowDefinition Height="Auto" />
                                 </Grid.RowDefinitions>
 
                                 <!--The first Grid Row will contain the Language label and combobox added in a StackPanel vertical-->
@@ -366,8 +367,43 @@
                                     </Grid>
                                 </Grid>
 
-                                <!--This Grid contains Expanders for Run, Default Geometry Scaling and Backup settings-->
+                                <!--This Grid contains controls for selecting to include timestamp for export path -->
                                 <Grid Grid.Row="4"
+                                  Margin="14,0,0,20">
+                                    <Grid>
+                                        <Grid.ColumnDefinitions>
+                                            <ColumnDefinition Width="Auto"/>
+                                            <ColumnDefinition Width="Auto"/>
+                                            <ColumnDefinition Width="Auto"/>
+                                        </Grid.ColumnDefinitions>
+                                        <ToggleButton Width="{StaticResource ToggleButtonWidth}"
+                                                  Height="{StaticResource ToggleButtonHeight}"
+                                                  VerticalAlignment="Center"
+                                                  Margin="2,0,0,0"
+                                                  Grid.Column="0" 
+                                                  IsEnabled="True"
+                                                  IsChecked="{Binding Path=IsTimeStampIncludedInExportFilePath}"
+                                                  Style="{StaticResource EllipseToggleButton1}"/>
+                                        <Label Grid.Column="1"
+                                           Content="{x:Static p:Resources.PreferencesViewSettingIncludeTimestampExportPath}"
+                                           Foreground="{StaticResource PreferencesWindowFontColor}"/>
+                                        <Image Name="IncludeTimestampExportPathIcon"
+                                               Grid.Column="2"
+                                               Width="14"
+                                               Height="14"
+                                               Margin="10,0,0,0"
+                                               HorizontalAlignment="Left"
+                                               VerticalAlignment="Center"
+                                               Style="{StaticResource QuestionIcon}">
+                                            <Image.ToolTip>
+                                                    <ToolTip Content="{x:Static p:Resources.PreferencesViewIncludeTimestampExportPathTooltip}" Style="{StaticResource GenericToolTipLight}"/>
+                                            </Image.ToolTip>
+                                        </Image>
+                                    </Grid>
+                                </Grid>
+
+                                <!--This Grid contains Expanders for Run, Default Geometry Scaling and Backup settings-->
+                                <Grid Grid.Row="5"
                                   Margin="-3,0,1,20">
                                     <Grid HorizontalAlignment="Stretch">
                                         <Grid.RowDefinitions>
diff --git a/src/DynamoUtilities/PathHelper.cs b/src/DynamoUtilities/PathHelper.cs
@@ -276,11 +276,11 @@ public static bool IsFileNameInValid(string fileName)
             return false;
         }
 
-        /// <summary>
         /// This is a utility method for generating a default name to the snapshot image. 
         /// </summary>
         /// <param name="filePath">File path</param>
         /// <returns>Returns a default name(along with the timestamp) for the workspace image</returns>
+        [Obsolete("This function will be removed in future version of Dynamo - please use the version with more parameters")]
         public static String GetScreenCaptureNameFromPath(String filePath)
         {
             FileInfo fileInfo = new FileInfo(filePath);
@@ -289,6 +289,28 @@ public static String GetScreenCaptureNameFromPath(String filePath)
             return snapshotName;
         }
 
+        /// <summary>
+        /// This is a utility method for generating a default name to the snapshot image. 
+        /// </summary>
+        /// <param name="filePath">File path</param>
+        /// <param name="isTimeStampIncluded">Is timestamp included in file path</param>
+        /// <returns>Returns a default name(along with the timestamp) for the workspace image</returns>
+        public static String GetScreenCaptureNameFromPath(String filePath, bool isTimeStampIncluded)
+        {
+            FileInfo fileInfo = new FileInfo(filePath);
+            if (isTimeStampIncluded)
+            {
+                String timeStamp = string.Format("{0:yyyy-MM-dd_hh-mm-ss}", DateTime.Now);
+                String snapshotName = fileInfo.Name.Replace(fileInfo.Extension, "_") + timeStamp;
+                return snapshotName;
+            }
+            else
+            {
+                return fileInfo.Name.Replace(fileInfo.Extension, string.Empty);
+            }
+
+        }
+
         /// <summary>
         /// Computes the file size from the path.
         /// </summary>
diff --git a/test/DynamoCoreTests/UtilityTests.cs b/test/DynamoCoreTests/UtilityTests.cs
@@ -1,4 +1,4 @@
-﻿using System;
+using System;
 using System.Collections.Generic;
 using System.IO;
 using System.Linq;
@@ -832,8 +832,10 @@ public void CustomNodeNameError()
         public void GenerateSnapshotNameTest()
         {
             var examplePath = Path.Combine(TestDirectory, @"core\math", "Add.dyn");
-            var snapshotName = PathHelper.GetScreenCaptureNameFromPath(examplePath);
+            var snapshotName = PathHelper.GetScreenCaptureNameFromPath(examplePath, true);
             Assert.AreEqual(snapshotName, "Add_" + string.Format("{0:yyyy-MM-dd_hh-mm-ss}", DateTime.Now));
+            var snapshotNameWithoutTimestamp = PathHelper.GetScreenCaptureNameFromPath(examplePath, false);
+            Assert.AreEqual(snapshotNameWithoutTimestamp, "Add");
         }
     }
 }
diff --git a/test/settings/DynamoSettings-NewSettings.xml b/test/settings/DynamoSettings-NewSettings.xml
@@ -67,6 +67,7 @@
   <HideAutocompleteMethodOptions>true</HideAutocompleteMethodOptions>
   <EnableNotificationCenter>false</EnableNotificationCenter>
   <EnableStaticSplashScreen>false</EnableStaticSplashScreen>
+  <IsTimeStampIncludedInExportFilePath>false</IsTimeStampIncludedInExportFilePath>
   <EnablePersistExtensions>true</EnablePersistExtensions>
   <DefaultPythonEngine/>
   <SelectedPackagePathForInstall>C:\Users\user\AppData\Roaming\Dynamo\Dynamo Core\2.16</SelectedPackagePathForInstall>

Original file line number	Diff line number	Diff line change
`@@ -2786,7 +2786,7 @@ public void ShowSaveImageDialogAndSave(object parameter)`
`2786`	`2786`	`if (!string.IsNullOrEmpty(model.CurrentWorkspace.FileName))`
`2787`	`2787`	`{`
`2788`	`2788`	`var fi = new FileInfo(model.CurrentWorkspace.FileName);`
`2789`		`- var snapshotName = PathHelper.GetScreenCaptureNameFromPath(fi.FullName);`
	`2789`	`+ var snapshotName = PathHelper.GetScreenCaptureNameFromPath(fi.FullName, preferencesViewModel.IsTimeStampIncludedInExportFilePath);`
`2790`	`2790`	`_fileDialog.InitialDirectory = fi.DirectoryName;`
`2791`	`2791`	`_fileDialog.FileName = snapshotName;`
`2792`	`2792`	`}`
Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-using System;`
	`1`	`+using System;`
`2`	`2`	`using System.Collections.Generic;`
`3`	`3`	`using System.IO;`
`4`	`4`	`using System.Linq;`
`@@ -832,8 +832,10 @@ public void CustomNodeNameError()`
`832`	`832`	`public void GenerateSnapshotNameTest()`
`833`	`833`	`{`
`834`	`834`	`var examplePath = Path.Combine(TestDirectory, @"core\math", "Add.dyn");`
`835`		`- var snapshotName = PathHelper.GetScreenCaptureNameFromPath(examplePath);`
	`835`	`+ var snapshotName = PathHelper.GetScreenCaptureNameFromPath(examplePath, true);`
`836`	`836`	`Assert.AreEqual(snapshotName, "Add_" + string.Format("{0:yyyy-MM-dd_hh-mm-ss}", DateTime.Now));`
	`837`	`+ var snapshotNameWithoutTimestamp = PathHelper.GetScreenCaptureNameFromPath(examplePath, false);`
	`838`	`+ Assert.AreEqual(snapshotNameWithoutTimestamp, "Add");`
`837`	`839`	`}`
`838`	`840`	`}`
`839`	`841`	`}`