feat/tryparsesanitanize (#356)

lduchosal · web-flow · commit 84cc98e60273 · 2025-08-13T07:47:20.000+02:00
* Feat: IPNetwork2 Subtract impl * Feat: Substract IPv6 * Fix: typos * Fix: warnings * Fix: formatting * Fix: sonarqube * Feat: ipnetwork logo * Fix: logo * Fix: upgrade nuget * Fix: missing TestClass * Fix: Assert.Throws * Fix: assert expecte order * Fix sonarqube issues * Feat: Subtract / console * Chore: added documentation to sanitanize parameter Fix: TryParse will fail if network is invalid and sanitanize is false #256
diff --git a/src/ConsoleApplication/Program.cs b/src/ConsoleApplication/Program.cs
@@ -128,8 +128,10 @@ public static void Main(string[] args)
             case ActionEnum.ListIPAddress:
                 ListIPAddress(ac);
                 break;
-            case ActionEnum.Usage:
             case ActionEnum.SubtractNetwork:
+                SubtractNetwork(ac);
+                break;
+            case ActionEnum.Usage:
             default:
                 Usage();
                 break;
@@ -146,7 +148,18 @@ private static void ListIPAddress(ProgramContext ac)
             }
         }
     }
-
+    
+    private static void SubtractNetwork(ProgramContext ac)
+    {
+        foreach (IPNetwork2 ipnetwork in ac.Networks)
+        {
+            foreach (IPNetwork2 subtracted in ipnetwork.Subtract(ac.SubtractNetwork))
+            {
+                Console.WriteLine("{0}", subtracted);
+            }
+        }
+    }
+    
     private static void ContainNetwork(ProgramContext ac)
     {
         foreach (IPNetwork2 ipnetwork in ac.Networks)
@@ -438,7 +451,7 @@ private static void Usage()
         string version = fvi.FileVersion;
 
         Console.WriteLine(
-            "Usage: ipnetwork [-inmcbflu] [-d cidr|-D] [-h|-s cidr|-S|-w|-W|-x|-C network|-o network] networks ...");
+            "Usage: ipnetwork [-inmcbflu] [-d cidr|-D] [-h|-s cidr|-S network|-w|-W|-x|-C network|-o network] networks ...");
         Console.WriteLine("Version: {0}", version);
         Console.WriteLine();
         Console.WriteLine("Print options");
@@ -464,7 +477,7 @@ private static void Usage()
         Console.WriteLine("\t-x         : list all ip adresses in networks");
         Console.WriteLine("\t-C network : network contain networks");
         Console.WriteLine("\t-o network : network overlap networks");
-        Console.WriteLine("\t-S network : subtract network from subnet");
+        Console.WriteLine("\t-S network : subtract network from networks");
         Console.WriteLine(string.Empty);
         Console.WriteLine("networks  : one or more network addresses ");
         Console.WriteLine(
diff --git a/src/System.Net.IPNetwork/IPNetwork2InternalParse.cs b/src/System.Net.IPNetwork/IPNetwork2InternalParse.cs
@@ -82,11 +82,11 @@ private static void InternalParse(bool tryParse, string ipaddress, string netmas
     /// <param name="tryParse">Prevent exception.</param>
     /// <param name="network">The network to parse.</param>
     /// <param name="cidrGuess">The way to guess CIDR.</param>
-    /// <param name="sanitanize">Clean up the network.</param>
+    /// <param name="sanitize">If true, removes invalid characters and normalizes whitespace from the network string, keeping only valid network address characters (0-9, a-f, A-F, ., /, :, and spaces).</param>
     /// <param name="ipnetwork">The resulting IPNetwork.</param>
     /// <exception cref="ArgumentNullException">When network is null.</exception>
     /// <exception cref="ArgumentException">When network is not valid.</exception>
-    private static void InternalParse(bool tryParse, string network, ICidrGuess cidrGuess, bool sanitanize, out IPNetwork2 ipnetwork)
+    private static void InternalParse(bool tryParse, string network, ICidrGuess cidrGuess, bool sanitize, out IPNetwork2 ipnetwork)
     {
         if (string.IsNullOrEmpty(network))
         {
@@ -99,14 +99,14 @@ private static void InternalParse(bool tryParse, string network, ICidrGuess cidr
             return;
         }
 
-        if (sanitanize)
+        if (sanitize)
         {
             network = Regex.Replace(network, @"[^0-9a-fA-F\.\/\s\:]+", string.Empty, RegexOptions.None, TimeSpan.FromMilliseconds(100));
             network = Regex.Replace(network, @"\s{2,}", " ", RegexOptions.None, TimeSpan.FromMilliseconds(100));
             network = network.Trim();
         }
 
-        StringSplitOptions splitOptions = sanitanize ? StringSplitOptions.RemoveEmptyEntries : StringSplitOptions.None;
+        StringSplitOptions splitOptions = sanitize ? StringSplitOptions.RemoveEmptyEntries : StringSplitOptions.None;
         string[] args = network.Split([' ', '/'], splitOptions);
 
         if (args.Length == 0)
@@ -119,7 +119,7 @@ private static void InternalParse(bool tryParse, string network, ICidrGuess cidr
             ipnetwork = null;
             return;
         }
-
+        
         if (args.Length == 1)
         {
             string cidrlessNetwork = args[0];
@@ -137,14 +137,26 @@ private static void InternalParse(bool tryParse, string network, ICidrGuess cidr
             ipnetwork = null;
             return;
         }
+        
+        if (args.Length == 2)
+        {
+            if (byte.TryParse(args[1], out byte cidr1))
+            {
+                InternalParse(tryParse, args[0], cidr1, out ipnetwork);
+                return;
+            }
 
-        if (byte.TryParse(args[1], out byte cidr1))
+            InternalParse(tryParse, args[0], args[1], out ipnetwork);
+        }
+        else
         {
-            InternalParse(tryParse, args[0], cidr1, out ipnetwork);
+            if (tryParse == false)
+            {
+                throw new ArgumentNullException(nameof(network));
+            }
+            ipnetwork = null;
             return;
         }
-
-        InternalParse(tryParse, args[0], args[1], out ipnetwork);
     }
 
     /// <summary>
diff --git a/src/System.Net.IPNetwork/IPNetwork2Parse.cs b/src/System.Net.IPNetwork/IPNetwork2Parse.cs
@@ -100,7 +100,7 @@ public static IPNetwork2 Parse(string network)
     /// Broadcast : 192.168.0.255.
     /// </summary>
     /// <param name="network">A string containing an ip network to convert.</param>
-    /// <param name="sanitanize">Whether to sanitize network or not.</param>
+    /// <param name="sanitanize">If true, removes invalid characters and normalizes whitespace from the network string, keeping only valid network address characters (0-9, a-f, A-F, ., /, :, and spaces).</param>
     /// <returns>An IPNetwork equivalent to the network contained in string network.</returns>
     public static IPNetwork2 Parse(string network, bool sanitanize)
     {
@@ -141,7 +141,7 @@ public static IPNetwork2 Parse(string network, ICidrGuess cidrGuess)
     /// </summary>
     /// <param name="network">A string containing an ip network to convert.</param>
     /// <param name="cidrGuess">A ICidrGuess implementation that will be used to guess CIDR during conversion.</param>
-    /// <param name="sanitanize">Whether to sanitize network or not.</param>
+    /// <param name="sanitanize">If true, removes invalid characters and normalizes whitespace from the network string, keeping only valid network address characters (0-9, a-f, A-F, ., /, :, and spaces).</param>
     /// <returns>An IPNetwork equivalent to the network contained in string network.</returns>
     public static IPNetwork2 Parse(string network, ICidrGuess cidrGuess, bool sanitanize)
     {
diff --git a/src/System.Net.IPNetwork/IPNetwork2TryParse.cs b/src/System.Net.IPNetwork/IPNetwork2TryParse.cs
@@ -71,7 +71,7 @@ public static bool TryParse(string ipaddress, byte cidr, out IPNetwork2 ipnetwor
     /// <returns>true if network was converted successfully; otherwise, false.</returns>
     public static bool TryParse(string network, out IPNetwork2 ipnetwork)
     {
-        InternalParse(true, network, CidrGuess.ClassFull, sanitanize: true, out IPNetwork2 ipnetwork2);
+        InternalParse(true, network, CidrGuess.ClassFull, sanitize: true, out IPNetwork2 ipnetwork2);
         bool parsed = ipnetwork2 != null;
         ipnetwork = ipnetwork2;
 
@@ -90,7 +90,7 @@ public static bool TryParse(string network, out IPNetwork2 ipnetwork)
     /// Broadcast : 192.168.0.255.
     /// </summary>
     /// <param name="network">A string containing an ip network to convert.</param>
-    /// <param name="sanitanize">Whether to sanitize network or not.</param>
+    /// <param name="sanitanize">If true, removes invalid characters and normalizes whitespace from the network string, keeping only valid network address characters (0-9, a-f, A-F, ., /, :, and spaces).</param>
     /// <param name="ipnetwork">When this method returns, contains the IPNetwork value equivalent of the IPAddress contained in ipaddress with the netmask corresponding to cidr, if the conversion succeeded, or null if the conversion failed. The conversion fails if the s parameter is null or Empty, is not of the correct format, or represents an invalid ip address. This parameter is passed uninitialized; any value originally supplied in result will be overwritten.</param>
     /// <returns>true if network was converted successfully; otherwise, false.</returns>
     public static bool TryParse(string network, bool sanitanize, out IPNetwork2 ipnetwork)
@@ -163,7 +163,7 @@ public static bool TryParse(string network, ICidrGuess cidrGuess, out IPNetwork2
     /// </summary>
     /// <param name="network">A string containing an ip network to convert.</param>
     /// <param name="cidrGuess">A ICidrGuess implementation that will be used to guess CIDR during conversion.</param>
-    /// <param name="sanitanize">Whether to sanitize network or not.</param>
+    /// <param name="sanitanize">If true, removes invalid characters and normalizes whitespace from the network string, keeping only valid network address characters (0-9, a-f, A-F, ., /, :, and spaces).</param>
     /// <param name="ipnetwork">When this method returns, contains the IPNetwork value equivalent of the IPAddress contained in ipaddress with the netmask corresponding to cidr, if the conversion succeeded, or null if the conversion failed. The conversion fails if the s parameter is null or Empty, is not of the correct format, or represents an invalid ip address. This parameter is passed uninitialized; any value originally supplied in result will be overwritten.</param>
     /// <returns>true if network was converted successfully; otherwise, false.</returns>
     public static bool TryParse(string network, ICidrGuess cidrGuess, bool sanitanize, out IPNetwork2 ipnetwork)
diff --git a/src/TestProject/IPNetworkTest/IPNetworkParseTests.cs b/src/TestProject/IPNetworkTest/IPNetworkParseTests.cs
diff --git a/src/TestProject/TryParseUnitTest.cs b/src/TestProject/TryParseUnitTest.cs
