|
| 1 | +using System; |
| 2 | +using System.Collections.Generic; |
| 3 | +using System.Linq; |
| 4 | +using Npgsql; |
| 5 | + |
| 6 | +namespace pg2b3dm; |
| 7 | + |
| 8 | +public sealed record ConnectionStringResolution(string ConnectionString, string UserName, IReadOnlyList<string> Warnings); |
| 9 | + |
| 10 | +public static class ConnectionStringResolver |
| 11 | +{ |
| 12 | + private const string DefaultHost = "localhost"; |
| 13 | + private const string DefaultPort = "5432"; |
| 14 | + private const string ExampleCommand = "pg2b3dm --connection \"Host=localhost;Username=postgres;Database=postgres;Ssl Mode=Require;CommandTimeOut=0\" -t my_schema.my_table"; |
| 15 | + private static readonly string[] DeprecatedParameterOrder = ["--username", "--host", "--dbname", "--port"]; |
| 16 | + private static readonly Dictionary<string, string> DeprecatedParameterAliases = new(StringComparer.OrdinalIgnoreCase) |
| 17 | + { |
| 18 | + ["-U"] = "--username", |
| 19 | + ["--username"] = "--username", |
| 20 | + ["-h"] = "--host", |
| 21 | + ["--host"] = "--host", |
| 22 | + ["-d"] = "--dbname", |
| 23 | + ["--dbname"] = "--dbname", |
| 24 | + ["-p"] = "--port", |
| 25 | + ["--port"] = "--port", |
| 26 | + }; |
| 27 | + |
| 28 | + public static ConnectionStringResolution Resolve(string[] args, Options options, string currentUserName) |
| 29 | + { |
| 30 | + var deprecatedParameters = GetDeprecatedParameters(args); |
| 31 | + var warnings = new List<string>(); |
| 32 | + string connectionString; |
| 33 | + string userName; |
| 34 | + |
| 35 | + if (!string.IsNullOrWhiteSpace(options.Connection)) |
| 36 | + { |
| 37 | + var builder = new NpgsqlConnectionStringBuilder(options.Connection); |
| 38 | + connectionString = builder.ConnectionString; |
| 39 | + userName = string.IsNullOrWhiteSpace(builder.Username) ? currentUserName : builder.Username; |
| 40 | + |
| 41 | + if (deprecatedParameters.Count > 0) |
| 42 | + { |
| 43 | + warnings.Add(CreateConnectionOverrideWarning(deprecatedParameters)); |
| 44 | + } |
| 45 | + } |
| 46 | + else |
| 47 | + { |
| 48 | + var host = string.IsNullOrWhiteSpace(options.Host) ? DefaultHost : options.Host; |
| 49 | + var user = string.IsNullOrWhiteSpace(options.User) ? currentUserName : options.User; |
| 50 | + var database = string.IsNullOrWhiteSpace(options.Database) ? currentUserName : options.Database; |
| 51 | + var port = string.IsNullOrWhiteSpace(options.Port) ? DefaultPort : options.Port; |
| 52 | + |
| 53 | + connectionString = BuildLegacyConnectionString(host, user, database, port); |
| 54 | + userName = user; |
| 55 | + |
| 56 | + if (deprecatedParameters.Count > 0) |
| 57 | + { |
| 58 | + warnings.Add(CreateDeprecatedParametersWarning(deprecatedParameters)); |
| 59 | + } |
| 60 | + } |
| 61 | + |
| 62 | + return new ConnectionStringResolution(connectionString, userName, warnings); |
| 63 | + } |
| 64 | + |
| 65 | + public static string AddPassword(string connectionString, string password) |
| 66 | + { |
| 67 | + var builder = new NpgsqlConnectionStringBuilder(connectionString) |
| 68 | + { |
| 69 | + Password = password |
| 70 | + }; |
| 71 | + |
| 72 | + return builder.ConnectionString; |
| 73 | + } |
| 74 | + |
| 75 | + public static IReadOnlyList<string> GetDeprecatedParameters(string[] args) |
| 76 | + { |
| 77 | + var usedParameters = new HashSet<string>(StringComparer.OrdinalIgnoreCase); |
| 78 | + |
| 79 | + foreach (var arg in args) |
| 80 | + { |
| 81 | + if (TryGetDeprecatedParameter(arg, out var deprecatedParameter)) |
| 82 | + { |
| 83 | + usedParameters.Add(deprecatedParameter); |
| 84 | + } |
| 85 | + } |
| 86 | + |
| 87 | + return DeprecatedParameterOrder |
| 88 | + .Where(usedParameters.Contains) |
| 89 | + .ToList(); |
| 90 | + } |
| 91 | + |
| 92 | + private static bool TryGetDeprecatedParameter(string arg, out string deprecatedParameter) |
| 93 | + { |
| 94 | + deprecatedParameter = string.Empty; |
| 95 | + |
| 96 | + if (DeprecatedParameterAliases.TryGetValue(arg, out var matchedParameter)) |
| 97 | + { |
| 98 | + deprecatedParameter = matchedParameter; |
| 99 | + return true; |
| 100 | + } |
| 101 | + |
| 102 | + var equalsIndex = arg.IndexOf('='); |
| 103 | + if (equalsIndex > 0) |
| 104 | + { |
| 105 | + var parameterName = arg[..equalsIndex]; |
| 106 | + if (DeprecatedParameterAliases.TryGetValue(parameterName, out matchedParameter)) |
| 107 | + { |
| 108 | + deprecatedParameter = matchedParameter; |
| 109 | + return true; |
| 110 | + } |
| 111 | + } |
| 112 | + |
| 113 | + if (arg.StartsWith('-') && !arg.StartsWith("--") && arg.Length > 2) |
| 114 | + { |
| 115 | + var shortParameterName = arg[..2]; |
| 116 | + if (DeprecatedParameterAliases.TryGetValue(shortParameterName, out matchedParameter)) |
| 117 | + { |
| 118 | + deprecatedParameter = matchedParameter; |
| 119 | + return true; |
| 120 | + } |
| 121 | + } |
| 122 | + |
| 123 | + return false; |
| 124 | + } |
| 125 | + |
| 126 | + private static string BuildLegacyConnectionString(string host, string user, string database, string port) |
| 127 | + { |
| 128 | + var builder = new NpgsqlConnectionStringBuilder |
| 129 | + { |
| 130 | + ConnectionString = $"Host={host};Username={user};Database={database};Port={port};CommandTimeOut=0" |
| 131 | + }; |
| 132 | + |
| 133 | + return builder.ConnectionString; |
| 134 | + } |
| 135 | + |
| 136 | + private static string CreateDeprecatedParametersWarning(IReadOnlyList<string> deprecatedParameters) |
| 137 | + { |
| 138 | + var parameterLabel = deprecatedParameters.Count == 1 ? "parameter" : "parameters"; |
| 139 | + var verb = deprecatedParameters.Count == 1 ? "is" : "are"; |
| 140 | + var parameterList = string.Join(", ", deprecatedParameters); |
| 141 | + |
| 142 | + return string.Join(Environment.NewLine, new[] |
| 143 | + { |
| 144 | + "-----------------------------------------------------------------------------", |
| 145 | + $"WARNING: Database {parameterLabel} {parameterList} {verb} deprecated and will be removed in a future version.", |
| 146 | + "Use --connection instead.", |
| 147 | + $"Example: {ExampleCommand}", |
| 148 | + "-----------------------------------------------------------------------------" |
| 149 | + }); |
| 150 | + } |
| 151 | + |
| 152 | + private static string CreateConnectionOverrideWarning(IReadOnlyList<string> deprecatedParameters) |
| 153 | + { |
| 154 | + var parameterLabel = deprecatedParameters.Count == 1 ? "parameter" : "parameters"; |
| 155 | + var verb = deprecatedParameters.Count == 1 ? "was" : "were"; |
| 156 | + var parameterList = string.Join(", ", deprecatedParameters); |
| 157 | + |
| 158 | + return string.Join(Environment.NewLine, new[] |
| 159 | + { |
| 160 | + "-----------------------------------------------------------------------------", |
| 161 | + $"WARNING: Deprecated database {parameterLabel} {parameterList} {verb} provided together with --connection.", |
| 162 | + "--connection takes precedence and will be used.", |
| 163 | + $"Example: {ExampleCommand}", |
| 164 | + "-----------------------------------------------------------------------------" |
| 165 | + }); |
| 166 | + } |
| 167 | +} |
0 commit comments