-
Notifications
You must be signed in to change notification settings - Fork 520
/
ArgumentParser.cs
416 lines (369 loc) · 17.2 KB
/
ArgumentParser.cs
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
using System;
using System.Collections;
using System.Collections.Generic;
using System.Collections.Specialized;
using System.IO;
using System.Linq;
using System.Security.Cryptography;
using System.Xml.Linq;
using System.Text;
using Paket.Bootstrapper.HelperProxies;
namespace Paket.Bootstrapper
{
public static class ArgumentParser
{
public static class CommandArgs
{
public const string Help = "--help";
public const string PreferNuget = "--prefer-nuget";
public const string ForceNuget = "--force-nuget";
public const string Prerelease = "prerelease";
public const string NugetSourceArgPrefix = "--nuget-source=";
public const string SelfUpdate = "--self";
public const string Silent = "-s";
public const string Verbose = "-v";
public const string IgnoreCache = "-f";
public const string MaxFileAge = "--max-file-age=";
public const string Run = "--run";
public const string AsTool = "--as-tool";
public const string OutputDir = "--output-dir=";
public const string ConfigFile = "--config-file=";
}
public static class AppSettingKeys
{
public const string PreferNuget = "PreferNuget";
public const string ForceNuget = "ForceNuget";
public const string NugetSource = "NugetSource";
public const string PaketVersion = "PaketVersion";
public const string Prerelease = "Prerelease";
public const string IgnoreCache = "IgnoreCache";
public const string BootstrapperOutputDir = "BootstrapperOutputDir";
}
public static class EnvArgs
{
public const string PaketVersionEnv = "PAKET.VERSION";
// Posix compliant environment variables [a-zA-Z_]+[a-zA-Z0-9_]*
// As to not break backwards compatability just adding a second env var
public const string PaketVersionEnvPosix = "PAKET_VERSION";
}
public static BootstrapperOptions ParseArgumentsAndConfigurations(IEnumerable<string> arguments, NameValueCollection appSettings, IDictionary envVariables, IFileSystemProxy fileSystem, IEnumerable<string> argumentsInDependenciesFile)
{
var options = new BootstrapperOptions();
var commandArgs = arguments.ToList();
var magicMode = GetIsMagicMode(fileSystem);
var transparentMagicMode = magicMode && commandArgs.IndexOf(CommandArgs.Run) == -1;
NameValueCollection settings = ParseBootstrapperOnlyCommandArgs(commandArgs, appSettings, options.DownloadArguments, fileSystem, magicMode);
// 1 - AppSettings or settings from target settings file
FillOptionsFromAppSettings(options, settings);
// 2 - paket.dependencies
FillNonRunOptionsFromArguments(options, argumentsInDependenciesFile.ToList());
// 3 - Environment variables
FillOptionsFromEnvVariables(options, envVariables);
// 4 - Command line
if (transparentMagicMode)
{
// Transparent magic mode mean that we're renamed 'paket.exe' and --run wasn't passed
// Virtually add a '-s'
options.Verbosity -= 1;
// Assume --run and that all arguments are for the real paket binary
options.Run = true;
options.RunArgs = new List<string>(commandArgs);
commandArgs.Clear();
// Don't check more than twice a day
// - Except if we want pre-releases as we're living on the bleeding edge
// - Or if we specify a fixed version because it will never check anyway
// - Or if the user specified any other value via 'paket.dependencies'
if (options.DownloadArguments.IgnorePrerelease
&& string.IsNullOrEmpty(options.DownloadArguments.LatestVersion)
&& options.DownloadArguments.MaxFileAgeInMinutes == null)
{
options.DownloadArguments.MaxFileAgeInMinutes = 60*12;
}
}
else
{
FillRunOptionsFromArguments(options, commandArgs);
FillNonRunOptionsFromArguments(options, commandArgs);
}
if (!options.DownloadArguments.IgnorePrerelease &&
!string.IsNullOrEmpty(options.DownloadArguments.LatestVersion))
{
// PreRelease + specific version -> we prefer the specific version
options.DownloadArguments.IgnorePrerelease = true;
}
options.UnprocessedCommandArgs = commandArgs;
if ("true" == Environment.GetEnvironmentVariable("PAKET_BOOTSTRAPPER_TRACE"))
{
options.Verbosity = Verbosity.Trace;
}
#if PAKET_BOOTSTRAP_WORKAROUND_MSBUILD_URLS
if (!String.IsNullOrEmpty(options.DownloadArguments.NugetSource)) {
string url = options.DownloadArguments.NugetSource;
string fixedUrl;
if (url.StartsWith("http://") || url.StartsWith("https://")) {
fixedUrl = url;
}
else {
fixedUrl = url.Replace("http:/", "http://").Replace("https:/", "https://");
}
options.DownloadArguments.NugetSource = fixedUrl;
}
#endif
return options;
}
private static NameValueCollection ParseBootstrapperOnlyCommandArgs(List<string> commandArgs, NameValueCollection appSettings, DownloadArguments downloadArguments, IFileSystemProxy fileSystem, bool magicMode)
{
var configFileArg = commandArgs.SingleOrDefault(x => x.StartsWith(CommandArgs.ConfigFile));
NameValueCollection newSettings = appSettings;
if (configFileArg != null)
{
commandArgs.Remove(configFileArg);
var configFilePath = configFileArg.Substring(CommandArgs.ConfigFile.Length);
newSettings = ReadSettings(configFilePath);
}
// Check if output dir has been provided - commandline takes priority
var outputDirArg = commandArgs.SingleOrDefault(x => x.StartsWith(CommandArgs.OutputDir));
var bootstrapperOutputDir = newSettings.GetKey(AppSettingKeys.BootstrapperOutputDir);
string targetFolder = null;
if (outputDirArg != null)
{
commandArgs.Remove(outputDirArg);
targetFolder = outputDirArg.Substring(CommandArgs.OutputDir.Length);
}
else if(bootstrapperOutputDir != null)
{
targetFolder = bootstrapperOutputDir;
}
// Fill target - if none has been found, the default (temp folder with unique exe name) is used
FillTarget(downloadArguments, magicMode, targetFolder, fileSystem);
return newSettings;
}
private static void FillTarget(DownloadArguments downloadArguments, bool magicMode, string targetFolder, IFileSystemProxy fileSystem)
{
if (targetFolder == null && !magicMode)
{
targetFolder = Path.GetDirectoryName(fileSystem.GetExecutingAssemblyPath()) ?? "";
}
string targetPath;
if (targetFolder != null)
{
targetPath = Path.Combine(targetFolder, "paket.exe");
}
else
{
targetPath = GetMagicModeTarget(fileSystem);
targetFolder = Path.GetDirectoryName(targetPath);
}
// Make sure folder exists - creates it, and parents, if it does not exist.
fileSystem.CreateDirectory(targetFolder);
downloadArguments.Target = targetPath;
downloadArguments.Folder = targetFolder;
}
private static NameValueCollection ReadSettings(string configFilePath)
{
var doc = XDocument.Load(configFilePath);
var nv = new NameValueCollection();
var appSettings = doc.Root.Element("appSettings");
if (appSettings == null)
throw new Exception(string.Format("appSettings element not found in file '{0}'", configFilePath));
var dic =
appSettings
.Elements("add")
.Select(x => {
var keyAttr = x.Attribute("key");
var valueAttr = x.Attribute("value");
if (keyAttr == null || valueAttr == null)
return new KeyValuePair<string, string>(); ;
string key = keyAttr.Value;
if (key == null)
return new KeyValuePair<string, string>(); ;
string value = valueAttr.Value;
return new KeyValuePair<string, string>(key, value);
})
.Where(kv => kv.Key != null)
.ToArray();
foreach (var kv in dic)
{
nv.Add(kv.Key, kv.Value);
}
return nv;
}
private static void FillOptionsFromAppSettings(BootstrapperOptions options, NameValueCollection appSettings)
{
if (appSettings.IsTrue(AppSettingKeys.PreferNuget))
{
options.PreferNuget = true;
}
if (appSettings.IsTrue(AppSettingKeys.ForceNuget))
{
options.ForceNuget = true;
}
var latestVersion = appSettings.GetKey(AppSettingKeys.PaketVersion);
if (latestVersion != null)
{
options.DownloadArguments.LatestVersion = latestVersion;
}
if (appSettings.IsTrue(AppSettingKeys.Prerelease))
{
options.DownloadArguments.IgnorePrerelease = false;
}
var nugetSource = appSettings.GetKey(AppSettingKeys.NugetSource);
if (nugetSource != null)
{
options.DownloadArguments.NugetSource = nugetSource;
}
if (appSettings.IsTrue(AppSettingKeys.IgnoreCache))
{
options.DownloadArguments.IgnoreCache = true;
}
}
private static void FillOptionsFromEnvVariables(BootstrapperOptions options, IDictionary envVariables)
{
var latestVersion = envVariables.GetKey(EnvArgs.PaketVersionEnvPosix) ?? envVariables.GetKey(EnvArgs.PaketVersionEnv) ;
if (latestVersion != null)
{
options.DownloadArguments.LatestVersion = latestVersion;
}
}
private static void FillRunOptionsFromArguments(BootstrapperOptions options, List<string> commandArgs)
{
var runIndex = commandArgs.IndexOf(CommandArgs.Run);
if (runIndex != -1)
{
options.Run = true;
options.RunArgs = commandArgs.GetRange(runIndex + 1, commandArgs.Count - runIndex - 1);
commandArgs.RemoveRange(runIndex, commandArgs.Count - runIndex);
}
}
internal static void FillNonRunOptionsFromArguments(BootstrapperOptions options, List<string> commandArgs)
{
if (commandArgs.Contains(CommandArgs.PreferNuget))
{
options.PreferNuget = true;
commandArgs.Remove(CommandArgs.PreferNuget);
}
if (commandArgs.Contains(CommandArgs.ForceNuget))
{
options.ForceNuget = true;
commandArgs.Remove(CommandArgs.ForceNuget);
}
while (commandArgs.Contains(CommandArgs.Silent))
{
options.Verbosity -= 1;
commandArgs.Remove(CommandArgs.Silent);
}
while (commandArgs.Contains(CommandArgs.Verbose))
{
options.Verbosity += 1;
commandArgs.Remove(CommandArgs.Verbose);
}
if (commandArgs.Contains(CommandArgs.Help))
{
options.ShowHelp = true;
commandArgs.Remove(CommandArgs.Help);
}
FillDownloadOptionsFromArguments(options.DownloadArguments, commandArgs);
}
private static void FillDownloadOptionsFromArguments(DownloadArguments downloadArguments, List<string> commandArgs)
{
if (commandArgs.Contains(CommandArgs.SelfUpdate))
{
commandArgs.Remove(CommandArgs.SelfUpdate);
downloadArguments.DoSelfUpdate = true;
}
var nugetSourceArg = commandArgs.SingleOrDefault(x => x.StartsWith(CommandArgs.NugetSourceArgPrefix));
if (nugetSourceArg != null)
{
commandArgs.Remove(nugetSourceArg);
downloadArguments.NugetSource = nugetSourceArg.Substring(CommandArgs.NugetSourceArgPrefix.Length);
}
if (commandArgs.Contains(CommandArgs.IgnoreCache))
{
commandArgs.Remove(CommandArgs.IgnoreCache);
downloadArguments.IgnoreCache = true;
}
if (commandArgs.Contains(CommandArgs.AsTool))
{
commandArgs.Remove(CommandArgs.AsTool);
downloadArguments.AsTool = true;
}
var maxFileAgeArg = commandArgs.SingleOrDefault(x => x.StartsWith(CommandArgs.MaxFileAge, StringComparison.Ordinal));
if (maxFileAgeArg != null)
{
var parts = maxFileAgeArg.Split("=".ToCharArray(), StringSplitOptions.RemoveEmptyEntries);
if (parts.Length == 2)
{
var maxFileAgeInMinutesCommandArg = parts[1];
int parsedMaxFileAgeInMinutesCommandArg;
if (int.TryParse(maxFileAgeInMinutesCommandArg, out parsedMaxFileAgeInMinutesCommandArg))
{
downloadArguments.MaxFileAgeInMinutes = parsedMaxFileAgeInMinutesCommandArg;
}
}
commandArgs.Remove(maxFileAgeArg);
}
if (commandArgs.Count >= 1)
{
if (commandArgs[0] == CommandArgs.Prerelease)
{
downloadArguments.IgnorePrerelease = false;
commandArgs.Remove(CommandArgs.Prerelease);
}
else
{
downloadArguments.LatestVersion = commandArgs[0];
commandArgs.Remove(commandArgs[0]);
}
}
}
private static bool GetIsMagicMode(IFileSystemProxy fileSystemProxy)
{
// Magic mode is defined by the bootstrapper being renamed 'paket.exe'
var fileName = Path.GetFileName(fileSystemProxy.GetExecutingAssemblyPath());
return string.Equals(fileName, "paket.exe", StringComparison.OrdinalIgnoreCase);
}
private static string GetHash(string input)
{
using (var hash = SHA256.Create())
{
return string.Concat(hash.ComputeHash(Encoding.UTF8.GetBytes(input)).Select(b => b.ToString("X2")));
}
}
private static string GetMagicModeTarget(IFileSystemProxy fileSystemProxy)
{
// In magic mode the real 'paket.exe' is downloaded to the system temporary directory with a
// stable name depending on the bootstrapper location. It give two advantages :
// - Multiple executions of the same boostrapper will use the same path and can reuse the
// downloaded executable if needed. All of that without needing any additional state as
// our location on the file system act as the only state needed.
// - There is no risk to have two bootstrapper instances in two different locations
// accessing the same file as their path depends on the bootstrapper path.
var assemblyLocation = fileSystemProxy.GetExecutingAssemblyPath();
var targetName = String.Format("paket_{0}.exe",GetHash(assemblyLocation));
var targetFolder = Path.Combine(fileSystemProxy.GetTempPath(), "paket");
return Path.Combine(targetFolder, targetName);
}
private static bool IsTrue(this NameValueCollection appSettings, string key)
{
return appSettings.GetKey(key).ToLowerSafe() == "true";
}
private static string GetKey(this NameValueCollection appSettings, string key)
{
if (appSettings != null && appSettings.AllKeys.Any(x => x == key))
return appSettings.Get(key);
return null;
}
private static string GetKey(this IDictionary dictionary, string key)
{
if (dictionary != null && dictionary.Keys.Cast<string>().Any(x => x == key))
return dictionary[key].ToString();
return null;
}
private static string ToLowerSafe(this string value)
{
if(value == null)
return "";
return value.ToLower();
}
}
}