Crash creating automatic backup of Custom Node with special Characters (#9287)

reddyashish · web-flow · commit 8589ac4474af · 2018-12-14T10:20:24.000-05:00
* Add check for invalid cutom node name https://jira.autodesk.com/browse/QNTM-3928 * Removing trailing spaces * Moving the function to utilities class * Revert "Merge branch 'master' of https://github.com/DynamoDS/Dynamo" This reverts commit 085fb51, reversing changes made to d055de4. * Revert "Revert "Merge branch 'master' of https://github.com/DynamoDS/Dynamo"" This reverts commit 12538ab. * Adding tests - QNTM-3928 * Comments * Moving the test to NodeViewCustomizationTests.cs * Deleting changes to SerializationTests.cs * Create SerializationTests.cs * Update SerializationTests.cs * moving the test to UtilityTests.ca
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
@@ -1315,6 +1315,10 @@ You can always redownload the package.</value>
   <data name="MessageCustomNodeNoName" xml:space="preserve">
     <value>You must supply a name.</value>
   </data>
+  <data name="MessageCustomNodeNameInvalid" xml:space="preserve">
+    <value>Custom Node name cannot contain any of the following special characters:
+    # % * ? \ : or any of the non-printable characters.</value>
+  </data>
   <data name="MessageErrorOpeningFileGeneral" xml:space="preserve">
     <value>Error Opening File</value>
     <comment>Notification Center Title</comment>
diff --git a/src/DynamoCoreWpf/Properties/Resources.resx b/src/DynamoCoreWpf/Properties/Resources.resx
@@ -939,6 +939,10 @@ You can always redownload the package.</value>
   <data name="MessageCustomNodeNoName" xml:space="preserve">
     <value>You must supply a name.</value>
   </data>
+  <data name="MessageCustomNodeNameInvalid" xml:space="preserve">
+    <value>Custom Node name cannot contain any of the following special characters:
+    # % * ? \ : or any of the non-printable characters.</value>
+  </data>
   <data name="MessageFailedToDownloadPackage" xml:space="preserve">
     <value>Failed to download package with id: {0}.  Please try again and report the package if you continue to have problems.</value>
     <comment>Message box content</comment>
diff --git a/src/DynamoCoreWpf/UI/Prompts/FunctionNamePrompt.xaml.cs b/src/DynamoCoreWpf/UI/Prompts/FunctionNamePrompt.xaml.cs
@@ -3,6 +3,7 @@
 using System.Windows;
 using Dynamo.Controls;
 using Dynamo.Utilities;
+using DynamoUtilities;
 
 namespace Dynamo.Nodes
 {
@@ -37,6 +38,12 @@ void OK_Click(object sender, RoutedEventArgs e)
                   Dynamo.Wpf.Properties.Resources.CustomNodePropertyErrorMessageBoxTitle,
                   MessageBoxButton.OK, MessageBoxImage.Error);
           }
+          else if (PathHelper.IsFileNameInValid(Text))
+          {
+              MessageBox.Show(Dynamo.Wpf.Properties.Resources.MessageCustomNodeNameInvalid,
+                 Dynamo.Wpf.Properties.Resources.CustomNodePropertyErrorMessageBoxTitle,
+                 MessageBoxButton.OK, MessageBoxImage.Error);
+          }
           else if (string.IsNullOrEmpty(Category))
           {
               MessageBox.Show(Dynamo.Wpf.Properties.Resources.MessageCustomNodeNeedNewCategory,
diff --git a/src/DynamoUtilities/PathHelper.cs b/src/DynamoUtilities/PathHelper.cs
@@ -1,5 +1,6 @@
 ﻿using System;
 using System.IO;
+using System.Linq;
 using System.Security.AccessControl;
 using System.Xml;
 using Newtonsoft.Json;
@@ -146,5 +147,17 @@ public static bool isValidJson(string path, out string fileContents, out Excepti
                 return false;
             }
         }
+
+        // Check if the file name contains any special non-printable chatacters.
+        public static bool IsFileNameInValid(string fileName)
+        {
+            // Some other extra characters that are to be checked. 
+            char[] invalidCharactersFileName = { '#', '%', '&', '.', ' ' };
+
+            if (fileName.Any(f => Path.GetInvalidFileNameChars().Contains(f)) || fileName.IndexOfAny(invalidCharactersFileName) > -1)
+                return true;
+
+            return false;
+        }
     }
 }
diff --git a/test/DynamoCoreTests/UtilityTests.cs b/test/DynamoCoreTests/UtilityTests.cs
@@ -802,5 +802,29 @@ public void TestTypeSwitch()
                 TypeSwitch.Default(() => v = 24));
             Assert.AreEqual(v, 24);
         }
+
+        // This test will check if the custom node name is valid or not. 
+        [Test]
+        public void CustomNodeNameError()
+        {
+            var InvalidNameError = false;
+            var specialCharacters = "?./<>";
+            var CustomNodeName = "Test";
+
+            int index = new Random().Next(0, CustomNodeName.Length);
+            var CustomNodeInvalidName = System.String.Concat(CustomNodeName, specialCharacters.ElementAt(index));
+
+            if (PathHelper.IsFileNameInValid(CustomNodeName))
+            {
+                InvalidNameError = true;
+            }
+            Assert.AreEqual(false, InvalidNameError);
+
+            if (PathHelper.IsFileNameInValid(CustomNodeInvalidName))
+            {
+                InvalidNameError = true;
+            }
+            Assert.AreEqual(true, InvalidNameError);
+        }
     }
 }

Original file line number	Diff line number	Diff line change
`@@ -3,6 +3,7 @@`
`3`	`3`	`using System.Windows;`
`4`	`4`	`using Dynamo.Controls;`
`5`	`5`	`using Dynamo.Utilities;`
	`6`	`+using DynamoUtilities;`
`6`	`7`
`7`	`8`	`namespace Dynamo.Nodes`
`8`	`9`	`{`
`@@ -37,6 +38,12 @@ void OK_Click(object sender, RoutedEventArgs e)`
`37`	`38`	`Dynamo.Wpf.Properties.Resources.CustomNodePropertyErrorMessageBoxTitle,`
`38`	`39`	`MessageBoxButton.OK, MessageBoxImage.Error);`
`39`	`40`	`}`
	`41`	`+ else if (PathHelper.IsFileNameInValid(Text))`
	`42`	`+ {`
	`43`	`+ MessageBox.Show(Dynamo.Wpf.Properties.Resources.MessageCustomNodeNameInvalid,`
	`44`	`+ Dynamo.Wpf.Properties.Resources.CustomNodePropertyErrorMessageBoxTitle,`
	`45`	`+ MessageBoxButton.OK, MessageBoxImage.Error);`
	`46`	`+ }`
`40`	`47`	`else if (string.IsNullOrEmpty(Category))`
`41`	`48`	`{`
`42`	`49`	`MessageBox.Show(Dynamo.Wpf.Properties.Resources.MessageCustomNodeNeedNewCategory,`
Original file line number	Diff line number	Diff line change
`@@ -1,5 +1,6 @@`
`1`	`1`	`using System;`
`2`	`2`	`using System.IO;`
	`3`	`+using System.Linq;`
`3`	`4`	`using System.Security.AccessControl;`
`4`	`5`	`using System.Xml;`
`5`	`6`	`using Newtonsoft.Json;`
`@@ -146,5 +147,17 @@ public static bool isValidJson(string path, out string fileContents, out Excepti`
`146`	`147`	`return false;`
`147`	`148`	`}`
`148`	`149`	`}`
	`150`	`+`
	`151`	`+ // Check if the file name contains any special non-printable chatacters.`
	`152`	`+ public static bool IsFileNameInValid(string fileName)`
	`153`	`+ {`
	`154`	`+ // Some other extra characters that are to be checked.`
	`155`	`+ char[] invalidCharactersFileName = { '#', '%', '&', '.', ' ' };`
	`156`	`+`
	`157`	`+ if (fileName.Any(f => Path.GetInvalidFileNameChars().Contains(f)) \|\| fileName.IndexOfAny(invalidCharactersFileName) > -1)`
	`158`	`+ return true;`
	`159`	`+`
	`160`	`+ return false;`
	`161`	`+ }`
`149`	`162`	`}`
`150`	`163`	`}`