Skip to content

Commit c602565

Browse files
committed
Feature: Improve run command dialog & behaviour
1 parent a66d0f9 commit c602565

74 files changed

Lines changed: 2928 additions & 372 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

‎Source/NETworkManager.Localization/Resources/Strings.Designer.cs‎

Lines changed: 377 additions & 52 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎Source/NETworkManager.Localization/Resources/Strings.resx‎

Lines changed: 108 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4893,4 +4893,112 @@ Cloudflare may log your IP address and network information. See Cloudflare's pri
48934893
<data name="BringWindowToForegroundAndOpenRunCommand" xml:space="preserve">
48944894
<value>Bring window to foreground and open the run command</value>
48954895
</data>
4896+
<data name="Commands" xml:space="preserve">
4897+
<value>Commands</value>
4898+
</data>
4899+
<data name="Clipboard" xml:space="preserve">
4900+
<value>Clipboard</value>
4901+
</data>
4902+
<data name="Examples" xml:space="preserve">
4903+
<value>Examples</value>
4904+
</data>
4905+
<data name="Select" xml:space="preserve">
4906+
<value>Select</value>
4907+
</data>
4908+
<data name="Complete" xml:space="preserve">
4909+
<value>Complete</value>
4910+
</data>
4911+
<data name="Run" xml:space="preserve">
4912+
<value>Run</value>
4913+
</data>
4914+
<data name="RunAndKeepOpen" xml:space="preserve">
4915+
<value>Run and keep open</value>
4916+
</data>
4917+
<data name="FillInWithoutStarting" xml:space="preserve">
4918+
<value>Fill in without starting</value>
4919+
</data>
4920+
<data name="RemoveFromHistory" xml:space="preserve">
4921+
<value>Remove from history</value>
4922+
</data>
4923+
<data name="SuggestTheClipboardAsTarget" xml:space="preserve">
4924+
<value>Suggest the clipboard content (e.g. an IP address) as target</value>
4925+
</data>
4926+
<data name="ShowKeyHints" xml:space="preserve">
4927+
<value>Show key hints</value>
4928+
</data>
4929+
<data name="CtrlShiftP" xml:space="preserve">
4930+
<value>Ctrl+Shift+P</value>
4931+
</data>
4932+
<data name="CtrlEnter" xml:space="preserve">
4933+
<value>Ctrl+Enter</value>
4934+
</data>
4935+
<data name="ShiftEnter" xml:space="preserve">
4936+
<value>Shift+Enter</value>
4937+
</data>
4938+
<data name="ShiftDel" xml:space="preserve">
4939+
<value>Shift+Del</value>
4940+
</data>
4941+
<data name="KeyEnter" xml:space="preserve">
4942+
<value>Enter</value>
4943+
</data>
4944+
<data name="KeyTab" xml:space="preserve">
4945+
<value>Tab</value>
4946+
</data>
4947+
<data name="KeyEsc" xml:space="preserve">
4948+
<value>Esc</value>
4949+
</data>
4950+
<data name="RunCommandWatermark1" xml:space="preserve">
4951+
<value>Ping it, trace it, scan it...</value>
4952+
</data>
4953+
<data name="RunCommandWatermark2" xml:space="preserve">
4954+
<value>Got an IP address? Drop it here...</value>
4955+
</data>
4956+
<data name="RunCommandWatermark3" xml:space="preserve">
4957+
<value>Your whole network, one command away...</value>
4958+
</data>
4959+
<data name="RunCommandWatermark4" xml:space="preserve">
4960+
<value>Every tool, one line away...</value>
4961+
</data>
4962+
<data name="RunCommandWatermark5" xml:space="preserve">
4963+
<value>Something down? Let's check it...</value>
4964+
</data>
4965+
<data name="RunCommandWatermark6" xml:space="preserve">
4966+
<value>Is it DNS? It's always DNS...</value>
4967+
</data>
4968+
<data name="RunCommandWatermark7" xml:space="preserve">
4969+
<value>Have you tried pinging it?</value>
4970+
</data>
4971+
<data name="RunCommandWatermark8" xml:space="preserve">
4972+
<value>Packets in, answers out...</value>
4973+
</data>
4974+
<data name="RunCommandWatermark9" xml:space="preserve">
4975+
<value>Ready when your network isn't...</value>
4976+
</data>
4977+
<data name="RunCommandWatermark10" xml:space="preserve">
4978+
<value>Before you reboot it, ping it...</value>
4979+
</data>
4980+
<data name="RunCommandWatermark11" xml:space="preserve">
4981+
<value>Ping it, trace it, fix it...</value>
4982+
</data>
4983+
<data name="RunCommandWatermark12" xml:space="preserve">
4984+
<value>Is it up? Let's find out...</value>
4985+
</data>
4986+
<data name="RunCommandWatermark13" xml:space="preserve">
4987+
<value>Need to connect? Just type the host...</value>
4988+
</data>
4989+
<data name="RunCommandWatermark14" xml:space="preserve">
4990+
<value>It's not the network. Probably...</value>
4991+
</data>
4992+
<data name="RunCommandWatermark15" xml:space="preserve">
4993+
<value>Blame the firewall later, ping first...</value>
4994+
</data>
4995+
<data name="RunCommandWatermark16" xml:space="preserve">
4996+
<value>Works on my machine? Let's check yours...</value>
4997+
</data>
4998+
<data name="RunCommandWatermark17" xml:space="preserve">
4999+
<value>Somewhere between here and there...</value>
5000+
</data>
5001+
<data name="RunCommandWatermark18" xml:space="preserve">
5002+
<value>Ping first, panic later...</value>
5003+
</data>
48965004
</root>

‎Source/NETworkManager.Models/Network/Subnetmask.cs‎

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
using System.Collections.Generic;
22
using System.Net;
3+
using System.Net.Sockets;
34
using NETworkManager.Utilities;
45

56
namespace NETworkManager.Models.Network;
@@ -39,6 +40,17 @@ public static int ConvertSubnetmaskToCidr(IPAddress subnetmask)
3940
return string.Join("", IPv4Address.ToBinaryString(subnetmask.ToString()).Replace(".", "").TrimEnd('0')).Length;
4041
}
4142

43+
/// <summary>
44+
/// Gets the CIDRs a subnet can be split into (Subnetting): from the CIDR of the subnet to the maximum of the
45+
/// address family (32 for IPv4, 128 for IPv6).
46+
/// </summary>
47+
/// <param name="network">Subnet to split.</param>
48+
/// <returns>Minimum and maximum CIDR.</returns>
49+
public static (int Min, int Max) GetSubnettingCidrRange(IPNetwork2 network)
50+
{
51+
return (network.Cidr, network.AddressFamily == AddressFamily.InterNetwork ? 32 : 128);
52+
}
53+
4254
/// <summary>
4355
/// Converts a subnet mask (e.g. 255.255.255.0) or a CIDR (e.g. /24 or 24) to the CIDR. The value must be valid
4456
/// (see IPv4IPv6SubnetmaskOrCIDRValidator).

‎Source/NETworkManager.Models/RunCommand/RunCommandDefinition.cs‎

Lines changed: 10 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -57,9 +57,17 @@ public sealed class RunCommandDefinition
5757
public bool TypeBeforeTarget { get; init; }
5858

5959
/// <summary>
60-
/// Syntax of the arguments for the hint (e.g. "&lt;hosts&gt; [server] [type]"), empty if there are none.
60+
/// Parts of the syntax of the arguments for the hint (e.g. "&lt;Hosts&gt;", "[DNS server]", "[Type]",
61+
/// "@&lt;Profile&gt;"), empty if there are none.
6162
/// </summary>
62-
public string Syntax { get; init; } = string.Empty;
63+
public IReadOnlyList<RunCommandSyntaxPart> SyntaxParts { get; init; } = [];
64+
65+
/// <summary>
66+
/// Syntax of the arguments (e.g. "&lt;Hosts&gt; [DNS server] [Type] | @&lt;Profile&gt;"), empty if there are
67+
/// none.
68+
/// </summary>
69+
public string Syntax => string.Join(" ",
70+
SyntaxParts.Select(x => x.Kind == RunCommandSyntaxPartKind.Profile ? $"| {x.Text}" : x.Text));
6371

6472
/// <summary>
6573
/// Checks if the text is the command or one of its aliases (case-insensitive).

‎Source/NETworkManager.Models/RunCommand/RunCommandParseResult.cs‎

Lines changed: 38 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,6 @@
1-
namespace NETworkManager.Models.RunCommand;
1+
using System;
2+
3+
namespace NETworkManager.Models.RunCommand;
24

35
/// <summary>
46
/// Result of <see cref="RunCommandParser.Parse" />.
@@ -60,4 +62,39 @@ public sealed class RunCommandParseResult
6062
/// Value the error refers to (e.g. the unknown command or argument).
6163
/// </summary>
6264
public string ErrorValue { get; init; }
65+
66+
/// <summary>
67+
/// Part of the syntax that is being typed (highlighted in the hint), or null if there is none (e.g. while typing
68+
/// the command). After the target, the second argument comes first until it is entered (e.g. "[DNS server]"),
69+
/// then the type, unless a complete type keyword is typed (e.g. "aaaa").
70+
/// </summary>
71+
public RunCommandSyntaxPartKind? CurrentSyntaxPart
72+
{
73+
get
74+
{
75+
if (Command == null || Position == RunCommandPosition.Command)
76+
return null;
77+
78+
if (ProfileName != null)
79+
return RunCommandSyntaxPartKind.Profile;
80+
81+
switch (Position)
82+
{
83+
case RunCommandPosition.Type:
84+
return RunCommandSyntaxPartKind.Type;
85+
case RunCommandPosition.Target:
86+
return RunCommandSyntaxPartKind.Target;
87+
}
88+
89+
// A complete type keyword is being typed (e.g. "aaaa").
90+
if (Type != null && string.Equals(Type, CurrentWord, StringComparison.OrdinalIgnoreCase))
91+
return RunCommandSyntaxPartKind.Type;
92+
93+
// The second argument comes before the type (e.g. "[DNS server] [Type]"), until it is entered.
94+
if (Command.Argument != RunCommandArgument.None && (Argument == null || Argument == CurrentWord))
95+
return RunCommandSyntaxPartKind.Argument;
96+
97+
return Command.Types.Count > 0 && Type == null ? RunCommandSyntaxPartKind.Type : null;
98+
}
99+
}
63100
}
Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
namespace NETworkManager.Models.RunCommand;
2+
3+
/// <summary>
4+
/// Part of the syntax of a command (e.g. "&lt;Hosts&gt;" or "[DNS server]"), shown in the hint of the run command
5+
/// dialog.
6+
/// </summary>
7+
/// <param name="Kind">What the part is.</param>
8+
/// <param name="Name">Name of the value (e.g. "DNS server"), also the label of the parsed value.</param>
9+
/// <param name="Text">Text in the hint (e.g. "[DNS server]").</param>
10+
public sealed record RunCommandSyntaxPart(RunCommandSyntaxPartKind Kind, string Name, string Text)
11+
{
12+
/// <summary>
13+
/// Creates a required part (e.g. "&lt;Hosts&gt;").
14+
/// </summary>
15+
public static RunCommandSyntaxPart Required(RunCommandSyntaxPartKind kind, string name)
16+
{
17+
return new RunCommandSyntaxPart(kind, name, $"<{name}>");
18+
}
19+
20+
/// <summary>
21+
/// Creates an optional part (e.g. "[DNS server]").
22+
/// </summary>
23+
public static RunCommandSyntaxPart Optional(RunCommandSyntaxPartKind kind, string name)
24+
{
25+
return new RunCommandSyntaxPart(kind, name, $"[{name}]");
26+
}
27+
28+
/// <summary>
29+
/// Creates the profile part ("@&lt;Profile&gt;").
30+
/// </summary>
31+
public static RunCommandSyntaxPart Profile(string name)
32+
{
33+
return new RunCommandSyntaxPart(RunCommandSyntaxPartKind.Profile, name, $"@<{name}>");
34+
}
35+
}
Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
namespace NETworkManager.Models.RunCommand;
2+
3+
/// <summary>
4+
/// What a part of the syntax of a command is.
5+
/// </summary>
6+
public enum RunCommandSyntaxPartKind
7+
{
8+
Target,
9+
Argument,
10+
Type,
11+
Profile
12+
}
Lines changed: 105 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,105 @@
1+
using System;
2+
using System.Linq;
3+
using System.Net;
4+
using System.Text.RegularExpressions;
5+
6+
namespace NETworkManager.Models.RunCommand;
7+
8+
/// <summary>
9+
/// Detects the kind of a target that is typed without a command, so the commands that accept it can be suggested
10+
/// (e.g. "10.0.0.1" → ping, traceroute, ...). A single word without a domain is
11+
/// <see cref="RunCommandTargetKind.Hostname" />, since it can also be a mistyped command.
12+
/// </summary>
13+
public static partial class RunCommandTarget
14+
{
15+
[GeneratedRegex("^https?://", RegexOptions.IgnoreCase)]
16+
private static partial Regex UrlRegex();
17+
18+
[GeneratedRegex("^(?:[0-9a-f]{2}[:-]){5}[0-9a-f]{2}$|^[0-9a-f]{12}$|^(?:[0-9a-f]{4}\\.){2}[0-9a-f]{4}$",
19+
RegexOptions.IgnoreCase)]
20+
private static partial Regex MACAddressRegex();
21+
22+
[GeneratedRegex("^(?:[0-9a-f]{2}[:-]){2}[0-9a-f]{2}$", RegexOptions.IgnoreCase)]
23+
private static partial Regex OUIRegex();
24+
25+
[GeneratedRegex("^\\d{1,5}(?:-\\d{1,5})?(?:/(?:tcp|udp|sctp))?(?:;\\d{1,5}(?:-\\d{1,5})?(?:/(?:tcp|udp|sctp))?)*$",
26+
RegexOptions.IgnoreCase)]
27+
private static partial Regex PortsRegex();
28+
29+
[GeneratedRegex("^as\\d{1,10}$", RegexOptions.IgnoreCase)]
30+
private static partial Regex ASNRegex();
31+
32+
[GeneratedRegex("^[0-9.\\-\\[\\],]+$")]
33+
private static partial Regex IPv4RangeRegex();
34+
35+
// The last label (top-level domain) has at least one letter, so a shortened or partly typed IPv4 address (e.g.
36+
// "192.168.1") is not a host name.
37+
[GeneratedRegex(
38+
"^(?=.{1,253}\\.?$)(?:[a-z0-9](?:[a-z0-9-]{0,61}[a-z0-9])?\\.)+" +
39+
"(?=[a-z0-9-]*[a-z])[a-z0-9](?:[a-z0-9-]{0,61}[a-z0-9])?\\.?$",
40+
RegexOptions.IgnoreCase)]
41+
private static partial Regex HostnameWithDomainRegex();
42+
43+
// A label with at least one letter (only digits is not a host name)
44+
[GeneratedRegex("^(?=[a-z0-9-]*[a-z])[a-z0-9](?:[a-z0-9-]{0,61}[a-z0-9])?$", RegexOptions.IgnoreCase)]
45+
private static partial Regex HostnameRegex();
46+
47+
/// <summary>
48+
/// Gets the kind of the target.
49+
/// </summary>
50+
/// <param name="target">Target without spaces (e.g. "10.0.0.1" or "10.0.0.1;10.0.0.2").</param>
51+
/// <returns>Kind of the target, <see cref="RunCommandTargetKind.None" /> if it is not clearly a target.</returns>
52+
public static RunCommandTargetKind GetKind(string target)
53+
{
54+
if (string.IsNullOrEmpty(target) || target.Any(char.IsWhiteSpace))
55+
return RunCommandTargetKind.None;
56+
57+
if (UrlRegex().IsMatch(target))
58+
return Uri.TryCreate(target, UriKind.Absolute, out _) ? RunCommandTargetKind.URL : RunCommandTargetKind.None;
59+
60+
if (MACAddressRegex().IsMatch(target))
61+
return RunCommandTargetKind.MACAddress;
62+
63+
if (OUIRegex().IsMatch(target))
64+
return RunCommandTargetKind.OUI;
65+
66+
if (PortsRegex().IsMatch(target))
67+
return RunCommandTargetKind.Ports;
68+
69+
if (ASNRegex().IsMatch(target))
70+
return RunCommandTargetKind.ASN;
71+
72+
// Several hosts, IP ranges or subnets
73+
if (target.Contains(';'))
74+
{
75+
var parts = target.Split(';', StringSplitOptions.RemoveEmptyEntries);
76+
77+
return parts.Length > 0 && parts.All(x => GetKind(x) is RunCommandTargetKind.Host
78+
or RunCommandTargetKind.Hostname or RunCommandTargetKind.IPRange or RunCommandTargetKind.Subnet)
79+
? RunCommandTargetKind.Hosts
80+
: RunCommandTargetKind.None;
81+
}
82+
83+
// Subnet with CIDR or subnet mask (e.g. 10.0.0.0/24, 10.0.0.0/255.255.255.0, 2001:db8::/32)
84+
var slash = target.IndexOf('/');
85+
86+
if (slash > 0)
87+
return IPAddress.TryParse(target[..slash], out _) &&
88+
(int.TryParse(target[(slash + 1)..], out _) || IPAddress.TryParse(target[(slash + 1)..], out _))
89+
? RunCommandTargetKind.Subnet
90+
: RunCommandTargetKind.None;
91+
92+
// IPv4 range (e.g. 10.0.0.1-10.0.0.100, 10.0.0.1-100, 10.0.[0-1].1)
93+
if ((target.Contains('-') || target.Contains('[')) && target.Contains('.') && IPv4RangeRegex().IsMatch(target))
94+
return RunCommandTargetKind.IPRange;
95+
96+
// IP address: IPv4 with all 4 parts (a shortened or partly typed form like "10.1" is not a target) or IPv6
97+
if (IPAddress.TryParse(target, out _) && (target.Count(x => x == '.') == 3 || target.Contains(':')))
98+
return RunCommandTargetKind.Host;
99+
100+
if (HostnameWithDomainRegex().IsMatch(target))
101+
return RunCommandTargetKind.Host;
102+
103+
return HostnameRegex().IsMatch(target) ? RunCommandTargetKind.Hostname : RunCommandTargetKind.None;
104+
}
105+
}

0 commit comments

Comments
 (0)