-
Notifications
You must be signed in to change notification settings - Fork 85
/
UpdateCommand.cs
741 lines (644 loc) · 36.6 KB
/
UpdateCommand.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
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
// Copyright (c) Microsoft. All rights reserved.
// Licensed under the MIT license.
namespace Microsoft.WingetCreateCLI.Commands
{
using System;
using System.Collections.Generic;
using System.IO;
using System.IO.Compression;
using System.Linq;
using System.Threading.Tasks;
using AutoMapper;
using CommandLine;
using CommandLine.Text;
using Microsoft.WingetCreateCLI.Logging;
using Microsoft.WingetCreateCLI.Properties;
using Microsoft.WingetCreateCLI.Telemetry;
using Microsoft.WingetCreateCLI.Telemetry.Events;
using Microsoft.WingetCreateCore;
using Microsoft.WingetCreateCore.Common;
using Microsoft.WingetCreateCore.Common.Exceptions;
using Microsoft.WingetCreateCore.Models;
using Microsoft.WingetCreateCore.Models.DefaultLocale;
using Microsoft.WingetCreateCore.Models.Installer;
using Microsoft.WingetCreateCore.Models.Locale;
using Microsoft.WingetCreateCore.Models.Version;
using Sharprompt;
/// <summary>
/// Command for updating the elements of an existing or local manifest.
/// </summary>
[Verb("update", HelpText = "UpdateCommand_HelpText", ResourceType = typeof(Resources))]
public class UpdateCommand : BaseCommand
{
/// <summary>
/// Gets the usage examples for the update command.
/// </summary>
[Usage(ApplicationAlias = ProgramApplicationAlias)]
public static IEnumerable<Example> Examples
{
get
{
yield return new Example(Resources.Example_UpdateCommand_SearchAndUpdateVersionAndInstallerURL, new UpdateCommand { Id = "<PackageIdentifier>", InstallerUrls = new string[] { "<InstallerUrl1>", "<InstallerUrl2>" }, Version = "<Version>" });
yield return new Example(Resources.Example_UpdateCommand_SaveAndPublish, new UpdateCommand { Id = "<PackageIdentifier>", Version = "<Version>", OutputDir = "<OutputDirectory>", GitHubToken = "<GitHubPersonalAccessToken>" });
yield return new Example(Resources.Example_UpdateCommand_OverrideArchitecture, new UpdateCommand { Id = "<PackageIdentifier>", InstallerUrls = new string[] { "<InstallerUrl1>|<InstallerArchitecture>" }, Version = "<Version>" });
yield return new Example(Resources.Example_UpdateCommand_OverrideScope, new UpdateCommand { Id = "<PackageIdentifier>", InstallerUrls = new string[] { "<InstallerUrl1>|<InstallerScope>" }, Version = "<Version>" });
yield return new Example(Resources.Example_UpdateCommand_SubmitToGitHub, new UpdateCommand { Id = "<PackageIdentifier>", Version = "<Version>", InstallerUrls = new string[] { "<InstallerUrl1>", "<InstallerUrl2>" }, SubmitToGitHub = true, GitHubToken = "<GitHubPersonalAccessToken>" });
}
}
/// <summary>
/// Gets or sets the id used for looking up an existing manifest in the Windows Package Manager repository.
/// </summary>
[Value(0, MetaName = "PackageIdentifier", Required = true, HelpText = "PackageIdentifier_HelpText", ResourceType = typeof(Resources))]
public string Id { get; set; }
/// <summary>
/// Gets or sets the new value used to update the manifest version element.
/// </summary>
[Option('v', "version", Required = false, HelpText = "Version_HelpText", ResourceType = typeof(Resources))]
public string Version { get; set; }
/// <summary>
/// Gets or sets the outputPath where the generated manifest file should be saved to.
/// </summary>
[Option('o', "out", Required = false, HelpText = "OutputDirectory_HelpText", ResourceType = typeof(Resources))]
public string OutputDir { get; set; }
/// <summary>
/// Gets or sets the title for the pull request.
/// </summary>
[Option('p', "prtitle", Required = false, HelpText = "PullRequestTitle_HelpText", ResourceType = typeof(Resources))]
public override string PRTitle { get => base.PRTitle; set => base.PRTitle = value; }
/// <summary>
/// Gets or sets a value indicating whether or not the updated manifest should be submitted to Github.
/// </summary>
[Option('s', "submit", Required = false, HelpText = "SubmitToWinget_HelpText", ResourceType = typeof(Resources))]
public bool SubmitToGitHub { get; set; }
/// <summary>
/// Gets or sets a value indicating whether to launch an interactive mode for users to manually select which installers to update.
/// </summary>
[Option('i', "interactive", Required = false, HelpText = "InteractiveUpdate_HelpText", ResourceType = typeof(Resources))]
public bool Interactive { get; set; }
/// <summary>
/// Gets or sets the GitHub token used to submit a pull request on behalf of the user.
/// </summary>
[Option('t', "token", Required = false, HelpText = "GitHubToken_HelpText", ResourceType = typeof(Resources))]
public override string GitHubToken { get => base.GitHubToken; set => base.GitHubToken = value; }
/// <summary>
/// Gets or sets the new value(s) used to update the manifest installer elements.
/// </summary>
[Option('u', "urls", Required = false, HelpText = "InstallerUrl_HelpText", ResourceType = typeof(Resources))]
public IEnumerable<string> InstallerUrls { get; set; } = new List<string>();
/// <summary>
/// Gets or sets the unbound arguments that exist after the first positional parameter.
/// </summary>
[Value(1, Hidden = true)]
public IList<string> UnboundArgs { get; set; } = new List<string>();
/// <summary>
/// Executes the update command flow.
/// </summary>
/// <returns>Boolean representing success or fail of the command.</returns>
public override async Task<bool> Execute()
{
CommandExecutedEvent commandEvent = new CommandExecutedEvent
{
Command = nameof(UpdateCommand),
InstallerUrl = string.Join(',', this.InstallerUrls),
Id = this.Id,
Version = this.Version,
HasGitHubToken = !string.IsNullOrEmpty(this.GitHubToken),
};
try
{
if (this.UnboundArgs.Any())
{
Logger.ErrorLocalized(nameof(Resources.UnboundArguments_Message), string.Join(" ", this.UnboundArgs));
Logger.WarnLocalized(nameof(Resources.VerifyCommandUsage_Message));
return false;
}
Logger.DebugLocalized(nameof(Resources.RetrievingManifest_Message), this.Id);
string exactId;
try
{
exactId = await this.GitHubClient.FindPackageId(this.Id);
}
catch (Octokit.RateLimitExceededException)
{
Logger.ErrorLocalized(nameof(Resources.RateLimitExceeded_Message));
return false;
}
if (!string.IsNullOrEmpty(exactId))
{
this.Id = exactId;
}
List<string> latestManifestContent;
try
{
latestManifestContent = await this.GitHubClient.GetLatestManifestContentAsync(this.Id);
}
catch (Octokit.NotFoundException e)
{
Logger.ErrorLocalized(nameof(Resources.Error_Prefix), e.Message);
Logger.ErrorLocalized(nameof(Resources.OctokitNotFound_Error));
return false;
}
return await this.ExecuteManifestUpdate(latestManifestContent, commandEvent);
}
finally
{
TelemetryManager.Log.WriteEvent(commandEvent);
}
}
/// <summary>
/// Executes the manifest update flow.
/// </summary>
/// <param name="latestManifestContent">List of manifests to be updated.</param>
/// <param name="commandEvent">CommandExecuted telemetry event.</param>
/// <returns>Boolean representing whether the manifest was updated successfully or not.</returns>
public async Task<bool> ExecuteManifestUpdate(List<string> latestManifestContent, CommandExecutedEvent commandEvent)
{
Manifests originalManifests = Serialization.DeserializeManifestContents(latestManifestContent);
Manifests initialManifests = this.DeserializeManifestContentAndApplyInitialUpdate(latestManifestContent);
Manifests updatedManifests = this.Interactive ?
await this.UpdateManifestsInteractively(initialManifests) :
await this.UpdateManifestsAutonomously(initialManifests);
if (updatedManifests == null)
{
return false;
}
RemoveEmptyStringFieldsInManifests(updatedManifests);
DisplayManifestPreview(updatedManifests);
if (string.IsNullOrEmpty(this.OutputDir))
{
this.OutputDir = Directory.GetCurrentDirectory();
}
string manifestDirectoryPath = SaveManifestDirToLocalPath(updatedManifests, this.OutputDir);
if (ValidateManifest(manifestDirectoryPath))
{
if (this.SubmitToGitHub)
{
if (!VerifyUpdatedInstallerHash(originalManifests, updatedManifests.InstallerManifest))
{
Logger.ErrorLocalized(nameof(Resources.NoChangeDetectedInUpdatedManifest_Message));
Logger.ErrorLocalized(nameof(Resources.CompareUpdatedManifestWithExisting_Message));
return false;
}
return await this.LoadGitHubClient(true)
? (commandEvent.IsSuccessful = await this.GitHubSubmitManifests(
updatedManifests,
this.GetPRTitle(updatedManifests, originalManifests)))
: false;
}
return commandEvent.IsSuccessful = true;
}
else
{
return false;
}
}
/// <summary>
/// Updates the Manifest object model with the user-provided installer urls.
/// </summary>s
/// <param name="manifests">Manifest object model to be updated.</param>
/// <returns>Manifests object representing the updates manifest content, or null if the update failed.</returns>
public async Task<Manifests> UpdateManifestsAutonomously(Manifests manifests)
{
InstallerManifest installerManifest = manifests.InstallerManifest;
if (!this.InstallerUrls.Any())
{
this.InstallerUrls = installerManifest.Installers.Select(i => i.InstallerUrl).Distinct().ToArray();
}
// Generate list of InstallerUpdate objects and parse out any specified architecture or scope overrides.
List<InstallerMetadata> installerMetadataList = this.ParseInstallerUrlsForOverrides(this.InstallerUrls.Select(i => i.Trim()).ToList());
// If the installer update list is null there was an issue when parsing for architecture or scope override.
if (installerMetadataList == null)
{
return null;
}
// Reassign list with parsed installer URLs without architecture or scope overrides.
this.InstallerUrls = installerMetadataList.Select(x => x.InstallerUrl).ToList();
foreach (var installerUpdate in installerMetadataList)
{
if (installerUpdate.OverrideArchitecture.HasValue)
{
Logger.WarnLocalized(nameof(Resources.OverridingArchitecture_Warning), installerUpdate.InstallerUrl, installerUpdate.OverrideArchitecture);
}
if (installerUpdate.OverrideScope.HasValue)
{
Logger.WarnLocalized(nameof(Resources.OverridingScope_Warning), installerUpdate.InstallerUrl, installerUpdate.OverrideScope);
}
}
// We only support updates with same number of installer URLs
if (this.InstallerUrls.Distinct().Count() != installerManifest.Installers.Select(i => i.InstallerUrl).Distinct().Count())
{
Logger.ErrorLocalized(nameof(Resources.MultipleInstallerUpdateDiscrepancy_Error));
return null;
}
foreach (var installerUpdate in installerMetadataList)
{
string packageFile = await DownloadPackageFile(installerUpdate.InstallerUrl);
if (string.IsNullOrEmpty(packageFile))
{
return null;
}
if (packageFile.IsZipFile())
{
installerUpdate.IsZipFile = true;
// Obtain all possible relative file paths and check if there is a match.
List<string> relativeFilePaths = installerManifest.Installers.SelectMany(i => i.NestedInstallerFiles.Select(x => x.RelativeFilePath)).Distinct().ToList();
string extractDirectory = Path.Combine(PackageParser.InstallerDownloadPath, Path.GetFileNameWithoutExtension(packageFile));
if (Directory.Exists(extractDirectory))
{
Directory.Delete(extractDirectory, true);
}
try
{
ZipFile.ExtractToDirectory(packageFile, extractDirectory, true);
}
catch (Exception ex)
{
if (ex is InvalidDataException || ex is IOException || ex is NotSupportedException)
{
Logger.ErrorLocalized(nameof(Resources.InvalidZipFile_ErrorMessage), ex);
return null;
}
else if (ex is PathTooLongException)
{
Logger.ErrorLocalized(nameof(Resources.ZipPathExceedsMaxLength_ErrorMessage), ex);
return null;
}
throw;
}
installerUpdate.RelativeFilePaths = new List<string>();
foreach (string relativeFilePath in relativeFilePaths)
{
if (!File.Exists(Path.Combine(extractDirectory, relativeFilePath)))
{
Logger.ErrorLocalized(nameof(Resources.NestedInstallerFileNotFound_Error), relativeFilePath);
return null;
}
installerUpdate.RelativeFilePaths.Add(relativeFilePath);
}
installerUpdate.ExtractedDirectory = extractDirectory;
}
installerUpdate.PackageFile = packageFile;
}
try
{
PackageParser.UpdateInstallerNodesAsync(installerMetadataList, installerManifest);
DisplayArchitectureWarnings(installerMetadataList);
ResetVersionSpecificFields(manifests);
}
catch (InvalidOperationException)
{
Logger.ErrorLocalized(nameof(Resources.InstallerCountMustMatch_Error));
return null;
}
catch (IOException iOException) when (iOException.HResult == -2147024671)
{
Logger.ErrorLocalized(nameof(Resources.DefenderVirus_ErrorMessage));
return null;
}
catch (ParsePackageException parsePackageException)
{
parsePackageException.ParseFailedInstallerUrls.ForEach(i => Logger.ErrorLocalized(nameof(Resources.PackageParsing_Error), i));
return null;
}
catch (InstallerMatchException installerMatchException)
{
Logger.ErrorLocalized(nameof(Resources.NewInstallerUrlMustMatchExisting_Message));
installerMatchException.MultipleMatchedInstallers.ForEach(i => Logger.ErrorLocalized(nameof(Resources.UnmatchedInstaller_Error), i.Architecture, i.InstallerType, i.InstallerUrl));
installerMatchException.UnmatchedInstallers.ForEach(i => Logger.ErrorLocalized(nameof(Resources.MultipleMatchedInstaller_Error), i.Architecture, i.InstallerType, i.InstallerUrl));
if (installerMatchException.IsArchitectureOverride)
{
Logger.WarnLocalized(nameof(Resources.ArchitectureOverride_Warning));
}
return null;
}
return manifests;
}
/// <summary>
/// Deserializes the manifest string content, converts the manifest to multifile,
/// and ensures package id and version are consistent across the manifests.
/// </summary>
/// <param name="latestManifestContent">List of latest manifest content strings.</param>
/// <returns>Manifests object model.</returns>
public Manifests DeserializeManifestContentAndApplyInitialUpdate(List<string> latestManifestContent)
{
Manifests manifests = Serialization.DeserializeManifestContents(latestManifestContent);
if (manifests.SingletonManifest != null)
{
manifests = ConvertSingletonToMultifileManifest(manifests.SingletonManifest);
}
EnsureManifestVersionConsistency(manifests);
VersionManifest versionManifest = manifests.VersionManifest;
InstallerManifest installerManifest = manifests.InstallerManifest;
DefaultLocaleManifest defaultLocaleManifest = manifests.DefaultLocaleManifest;
List<LocaleManifest> localeManifests = manifests.LocaleManifests;
// Ensure that capitalization matches between folder structure and package ID
versionManifest.PackageIdentifier = this.Id;
installerManifest.PackageIdentifier = this.Id;
defaultLocaleManifest.PackageIdentifier = this.Id;
UpdatePropertyForLocaleManifests(nameof(LocaleManifest.PackageIdentifier), this.Id, localeManifests);
if (!string.IsNullOrEmpty(this.Version))
{
versionManifest.PackageVersion = this.Version;
installerManifest.PackageVersion = this.Version;
defaultLocaleManifest.PackageVersion = this.Version;
UpdatePropertyForLocaleManifests(nameof(LocaleManifest.PackageVersion), this.Version, localeManifests);
}
// TODO: Move relevant metadata from root node to installer node.
if (installerManifest.InstallerType != null)
{
installerManifest.Installers.ForEach(i => i.InstallerType = installerManifest.InstallerType);
installerManifest.InstallerType = null;
}
return manifests;
}
private static Manifests ConvertSingletonToMultifileManifest(WingetCreateCore.Models.Singleton.SingletonManifest singletonManifest)
{
// Create automapping configuration
var config = new MapperConfiguration(cfg =>
{
cfg.AllowNullCollections = true;
cfg.CreateMap<WingetCreateCore.Models.Singleton.SingletonManifest, VersionManifest>()
.ForMember(dest => dest.DefaultLocale, opt => opt.MapFrom(src => src.PackageLocale))
.ForMember(dest => dest.ManifestVersion, opt => opt.Ignore());
cfg.CreateMap<WingetCreateCore.Models.Singleton.SingletonManifest, DefaultLocaleManifest>().ForMember(dest => dest.ManifestVersion, opt => opt.Ignore());
cfg.CreateMap<WingetCreateCore.Models.Singleton.SingletonManifest, InstallerManifest>()
.ForMember(dest => dest.ManifestVersion, opt => opt.Ignore());
cfg.CreateMap<WingetCreateCore.Models.Singleton.Dependencies, WingetCreateCore.Models.Installer.Dependencies>();
cfg.CreateMap<WingetCreateCore.Models.Singleton.Installer, WingetCreateCore.Models.Installer.Installer>();
cfg.CreateMap<WingetCreateCore.Models.Singleton.InstallerSwitches, WingetCreateCore.Models.Installer.InstallerSwitches>();
cfg.CreateMap<WingetCreateCore.Models.Singleton.AppsAndFeaturesEntry, WingetCreateCore.Models.Installer.AppsAndFeaturesEntry>();
cfg.CreateMap<WingetCreateCore.Models.Singleton.ExpectedReturnCode, WingetCreateCore.Models.Installer.ExpectedReturnCode>();
cfg.CreateMap<WingetCreateCore.Models.Singleton.PackageDependencies, WingetCreateCore.Models.Installer.PackageDependencies>();
cfg.CreateMap<WingetCreateCore.Models.Singleton.Markets, WingetCreateCore.Models.Installer.Markets>();
cfg.CreateMap<WingetCreateCore.Models.Singleton.Markets2, WingetCreateCore.Models.Installer.Markets2>(); // Markets2 is not used, but is required to satisfy mapping configuration.
cfg.CreateMap<WingetCreateCore.Models.Singleton.Agreement, WingetCreateCore.Models.DefaultLocale.Agreement>();
cfg.CreateMap<WingetCreateCore.Models.Singleton.Documentation, WingetCreateCore.Models.DefaultLocale.Documentation>();
cfg.CreateMap<WingetCreateCore.Models.Singleton.NestedInstallerFile, WingetCreateCore.Models.Installer.NestedInstallerFile>();
cfg.CreateMap<WingetCreateCore.Models.Singleton.Files, WingetCreateCore.Models.Installer.Files>();
cfg.CreateMap<WingetCreateCore.Models.Singleton.InstallationMetadata, WingetCreateCore.Models.Installer.InstallationMetadata>();
});
var mapper = config.CreateMapper();
Manifests manifests = new Manifests();
manifests.VersionManifest = mapper.Map<VersionManifest>(singletonManifest);
manifests.InstallerManifest = mapper.Map<InstallerManifest>(singletonManifest);
manifests.DefaultLocaleManifest = mapper.Map<DefaultLocaleManifest>(singletonManifest);
// ManifestType gets overwritten by source. Revert to proper ManifestType.
manifests.VersionManifest.ManifestType = "version";
manifests.InstallerManifest.ManifestType = "installer";
manifests.DefaultLocaleManifest.ManifestType = "defaultLocale";
return manifests;
}
private static void UpdatePropertyForLocaleManifests(string propertyName, string value, List<LocaleManifest> localeManifests)
{
foreach (LocaleManifest manifest in localeManifests)
{
manifest.GetType().GetProperty(propertyName).SetValue(manifest, value);
}
}
/// <summary>
/// Ensures that the manifestVersion is consistent across all manifest object models.
/// </summary>
/// <param name="manifests">Manifests object model.</param>
private static void EnsureManifestVersionConsistency(Manifests manifests)
{
string latestManifestVersion = new VersionManifest().ManifestVersion;
manifests.VersionManifest.ManifestVersion = latestManifestVersion;
manifests.DefaultLocaleManifest.ManifestVersion = latestManifestVersion;
manifests.InstallerManifest.ManifestVersion = latestManifestVersion;
foreach (var localeManifest in manifests.LocaleManifests)
{
localeManifest.ManifestVersion = latestManifestVersion;
}
}
/// <summary>
/// Resets the value of version specific fields to null.
/// </summary>
/// <param name="manifests">Manifests object model.</param>
private static void ResetVersionSpecificFields(Manifests manifests)
{
DefaultLocaleManifest defaultLocaleManifest = manifests.DefaultLocaleManifest;
InstallerManifest installerManifest = manifests.InstallerManifest;
List<LocaleManifest> localeManifests = manifests.LocaleManifests;
defaultLocaleManifest.ReleaseNotes = null;
defaultLocaleManifest.ReleaseNotesUrl = null;
installerManifest.ReleaseDateTime = null;
foreach (var installer in installerManifest.Installers)
{
installer.ReleaseDateTime = null;
}
foreach (LocaleManifest localeManifest in localeManifests)
{
localeManifest.ReleaseNotes = null;
localeManifest.ReleaseNotesUrl = null;
}
}
/// <summary>
/// Compares the hashes of the original and updated manifests and returns true if the new manifest has an updated SHA256 hash.
/// </summary>
/// <param name="oldManifest">The original manifest object model.</param>
/// <param name="newManifest">The updated installer manifest object model.</param>
/// <returns>A boolean value indicating whether the updated manifest has new changes compared to the original manifest.</returns>
private static bool VerifyUpdatedInstallerHash(Manifests oldManifest, InstallerManifest newManifest)
{
IEnumerable<string> oldHashes = oldManifest.InstallerManifest == null
? oldManifest.SingletonManifest.Installers.Select(i => i.InstallerSha256).Distinct()
: oldManifest.InstallerManifest.Installers.Select(i => i.InstallerSha256).Distinct();
var newHashes = newManifest.Installers.Select(i => i.InstallerSha256).Distinct();
return newHashes.Except(oldHashes).Any();
}
private static void DisplayManifestsAsMenuSelection(Manifests manifests)
{
Console.Clear();
string versionFileName = Manifests.GetFileName(manifests.VersionManifest);
string installerFileName = Manifests.GetFileName(manifests.InstallerManifest);
string versionManifestMenuItem = $"{manifests.VersionManifest.ManifestType.ToUpper()}: " + versionFileName;
string installerManifestMenuItem = $"{manifests.InstallerManifest.ManifestType.ToUpper()}: " + installerFileName;
while (true)
{
// Need to update locale manifest file name each time as PackageLocale can change
string defaultLocaleMenuItem = $"{manifests.DefaultLocaleManifest.ManifestType.ToUpper()}: " + Manifests.GetFileName(manifests.DefaultLocaleManifest);
List<string> selectionList = new List<string> { versionManifestMenuItem, installerManifestMenuItem, defaultLocaleMenuItem };
Dictionary<string, LocaleManifest> localeManifestMap = new Dictionary<string, LocaleManifest>();
foreach (LocaleManifest localeManifest in manifests.LocaleManifests)
{
string localeManifestFileName = $"{localeManifest.ManifestType.ToUpper()}: " + Manifests.GetFileName(localeManifest);
localeManifestMap.Add(localeManifestFileName, localeManifest);
selectionList.Add(localeManifestFileName);
}
selectionList.Add(Resources.Done_MenuItem);
ValidateManifestsInTempDir(manifests);
var selectedItem = Prompt.Select(Resources.SelectManifestToEdit_Message, selectionList);
if (selectedItem == versionManifestMenuItem)
{
PromptHelper.PromptPropertiesWithMenu(manifests.VersionManifest, Resources.SaveAndExit_MenuItem, versionFileName);
}
else if (selectedItem == installerManifestMenuItem)
{
PromptHelper.PromptPropertiesWithMenu(manifests.InstallerManifest, Resources.SaveAndExit_MenuItem, installerFileName);
}
else if (selectedItem == defaultLocaleMenuItem)
{
PromptHelper.PromptPropertiesWithMenu(manifests.DefaultLocaleManifest, Resources.SaveAndExit_MenuItem, Manifests.GetFileName(manifests.DefaultLocaleManifest));
}
else if (selectedItem == Resources.Done_MenuItem)
{
break;
}
else
{
var selectedLocaleManifest = localeManifestMap[selectedItem];
PromptHelper.PromptPropertiesWithMenu(selectedLocaleManifest, Resources.SaveAndExit_MenuItem, Manifests.GetFileName(selectedLocaleManifest));
}
}
}
/// <summary>
/// Parses the installer urls for any architecture or scope overrides.
/// </summary>
/// <param name="installerUrlsToBeParsed">List of installer URLs to be parsed for architecture overrides.</param>
/// <returns>List of <see cref="InstallerMetadata"/> helper objects used for updating the installers.</returns>
private List<InstallerMetadata> ParseInstallerUrlsForOverrides(List<string> installerUrlsToBeParsed)
{
List<InstallerMetadata> installerMetadataList = new List<InstallerMetadata>();
foreach (string item in installerUrlsToBeParsed)
{
InstallerMetadata installerMetadata = new InstallerMetadata();
if (item.Contains('|'))
{
// '|' character indicates that an architecture override can be parsed from the installer.
string[] installerUrlOverride = item.Split('|');
// There can be at most 3 elements at one time (installerUrl|archOverride|scopeOverride)
if (installerUrlOverride.Length > 3)
{
Logger.ErrorLocalized(nameof(Resources.OverrideLimitExceeded_Error), item);
return null;
}
installerMetadata.InstallerUrl = installerUrlOverride[0];
bool archOverridePresent = false;
bool scopeOverridePresent = false;
for (int i = 1; i < installerUrlOverride.Length; i++)
{
string overrideString = installerUrlOverride[i];
Architecture? overrideArch = overrideString.ToEnumOrDefault<Architecture>();
Scope? overrideScope = overrideString.ToEnumOrDefault<Scope>();
if (overrideArch.HasValue)
{
if (archOverridePresent)
{
Logger.ErrorLocalized(nameof(Resources.MultipleArchitectureOverride_Error));
return null;
}
else
{
archOverridePresent = true;
installerMetadata.OverrideArchitecture = overrideArch.Value;
}
}
else if (overrideScope.HasValue)
{
if (scopeOverridePresent)
{
Logger.ErrorLocalized(nameof(Resources.MultipleScopeOverride_Error));
return null;
}
else
{
scopeOverridePresent = true;
installerMetadata.OverrideScope = overrideScope.Value;
}
}
else
{
Logger.ErrorLocalized(nameof(Resources.UnableToParseOverride_Error), overrideString);
return null;
}
}
}
else
{
installerMetadata.InstallerUrl = item;
}
installerMetadataList.Add(installerMetadata);
}
return installerMetadataList;
}
/// <summary>
/// Update flow for interactively updating the manifest.
/// </summary>s
/// <param name="manifests">Manifest object model to be updated.</param>
/// <returns>The updated manifest.</returns>
private async Task<Manifests> UpdateManifestsInteractively(Manifests manifests)
{
Prompt.Symbols.Done = new Symbol(string.Empty, string.Empty);
Prompt.Symbols.Prompt = new Symbol(string.Empty, string.Empty);
// Clone the list of installers in order to preserve initial values.
Manifests originalManifest = new Manifests { InstallerManifest = new InstallerManifest() };
originalManifest.InstallerManifest.Installers = manifests.CloneInstallers();
do
{
Console.Clear();
manifests.InstallerManifest.Installers = originalManifest.CloneInstallers();
await this.UpdateInstallersInteractively(manifests.InstallerManifest.Installers);
DisplayManifestPreview(manifests);
ValidateManifestsInTempDir(manifests);
}
while (Prompt.Confirm(Resources.DiscardUpdateAndStartOver_Message));
if (Prompt.Confirm(Resources.EditManifests_Message))
{
DisplayManifestsAsMenuSelection(manifests);
}
if (!this.SubmitToGitHub)
{
this.SubmitToGitHub = Prompt.Confirm(Resources.ConfirmGitHubSubmitManifest_Message);
}
return manifests;
}
/// <summary>
/// Interactive flow when updating installers.
/// </summary>
/// <param name="existingInstallers">List of existing installers to be updated.</param>
/// <returns>A <see cref="Task"/> representing the asynchronous operation.</returns>
private async Task UpdateInstallersInteractively(List<Installer> existingInstallers)
{
int numOfExistingInstallers = existingInstallers.Count;
int index = 1;
foreach (var installer in existingInstallers)
{
Logger.InfoLocalized(nameof(Resources.UpdatingInstallerOutOfTotal_Message), index, numOfExistingInstallers);
Console.WriteLine(Serialization.Serialize(installer));
await this.UpdateSingleInstallerInteractively(installer);
index++;
}
}
/// <summary>
/// Prompts the user for the new installer url to update the provided installer.
/// </summary>
/// <param name="installer">The installer to be updated.</param>
/// <returns>A <see cref="Task"/> representing the asynchronous operation.</returns>
private async Task UpdateSingleInstallerInteractively(Installer installer)
{
Installer newInstaller = new Installer();
while (true)
{
string url = Prompt.Input<string>(Resources.NewInstallerUrl_Message, null, new[] { FieldValidation.ValidateProperty(newInstaller, nameof(Installer.InstallerUrl)) }).Trim();
string packageFile = await DownloadPackageFile(url);
if (string.IsNullOrEmpty(packageFile))
{
continue;
}
else if (!PackageParser.ParsePackageAndUpdateInstallerNode(installer, packageFile, url))
{
Logger.ErrorLocalized(nameof(Resources.PackageParsing_Error), url);
Console.WriteLine();
}
else
{
break;
}
}
Logger.InfoLocalized(nameof(Resources.InstallerUpdatedSuccessfully_Message));
Console.WriteLine(Resources.PressKeyToContinue_Message);
Console.ReadKey();
Console.Clear();
}
}
}