src/InstallPSResource.cs
|
using System; using System.Collections; using System.Collections.Generic; using System.Collections.ObjectModel; using static System.Environment; using System.Globalization; using System.IO; using System.Linq; using System.Management.Automation; using System.Net; using System.Security; using System.Security.Principal; using System.Text.RegularExpressions; using System.Threading; using Microsoft.PowerShell.PowerShellGet.RepositorySettings; using MoreLinq.Extensions; using Newtonsoft.Json.Linq; using NuGet.Common; using NuGet.Configuration; using NuGet.Packaging.Core; using NuGet.Protocol; using NuGet.Protocol.Core.Types; using NuGet.Versioning; using Newtonsoft.Json.Serialization; using Newtonsoft.Json; namespace Microsoft.PowerShell.PowerShellGet.Cmdlets { /// <summary> /// The Install-PSResource cmdlet installs a resource. /// It returns nothing. /// </summary> [Cmdlet(VerbsLifecycle.Install, "PSResource", DefaultParameterSetName = "NameParameterSet", SupportsShouldProcess = true, HelpUri = "<add>", RemotingCapability = RemotingCapability.None)] public sealed class InstallPSResource : PSCmdlet { // private string PSGalleryRepoName = "PSGallery"; /// <summary> /// Specifies the exact names of resources to install from a repository. /// A comma-separated list of module names is accepted. The resource name must match the resource name in the repository. /// </summary> [Parameter(Mandatory = true, Position = 0, ValueFromPipeline = true, ValueFromPipelineByPropertyName = true, ParameterSetName = "NameParameterSet")] [ValidateNotNullOrEmpty] public string[] Name { get { return _name; } set { _name = value; } } private string[] _name; // = new string[0]; /* /// <summary> /// Used for pipeline input. /// </summary> [Parameter(Mandatory = true, Position = 0, ValueFromPipeline = true, ValueFromPipelineByPropertyName = true, ParameterSetName = "InputObjectSet")] [ValidateNotNullOrEmpty] public PSCustomObject[] InputObject { get { return _inputObject; } set { _inputObject = value; } } private PSCustomObject[] _inputObject; // = new string[0]; */ /// <summary> /// Specifies the version or version range of the package to be installed /// </summary> [Parameter(ParameterSetName = "NameParameterSet")] [ValidateNotNullOrEmpty] public string Version { get { return _version; } set { _version = value; } } private string _version; /// <summary> /// Specifies to allow installation of prerelease versions /// </summary> [Parameter(ParameterSetName = "NameParameterSet")] [Parameter(ParameterSetName = "RequiredResourceFileParameterSet")] public SwitchParameter Prerelease { get { return _prerelease; } set { _prerelease = value; } } private SwitchParameter _prerelease; /// <summary> /// Specifies a user account that has rights to find a resource from a specific repository. /// </summary> [Parameter(ParameterSetName = "NameParameterSet")] [Parameter(ParameterSetName = "RequiredResourceFileParameterSet")] [ValidateNotNullOrEmpty] public string[] Repository { get { return _repository; } set { _repository = value; } } private string[] _repository; /// <summary> /// Specifies a user account that has rights to find a resource from a specific repository. /// </summary> [Parameter(ValueFromPipelineByPropertyName = true, ParameterSetName = "NameParameterSet")] [Parameter(ParameterSetName = "RequiredResourceFileParameterSet")] public PSCredential Credential { get { return _credential; } set { _credential = value; } } private PSCredential _credential; /// <summary> /// Specifies to return any dependency packages. /// Currently only used when name param is specified. /// </summary> [ValidateSet("CurrentUser", "AllUsers")] [Parameter(ParameterSetName = "NameParameterSet")] [Parameter(ParameterSetName = "RequiredResourceFileParameterSet")] public string Scope { get { return _scope; } set { _scope = value; } } private string _scope; /// <summary> /// Overrides warning messages about installation conflicts about existing commands on a computer. /// Overwrites existing commands that have the same name as commands being installed by a module. AllowClobber and Force can be used together in an Install-Module command. /// Prevents installing modules that have the same cmdlets as a differently named module already /// </summary> [Parameter(ParameterSetName = "NameParameterSet")] [Parameter(ParameterSetName = "RequiredResourceFileParameterSet")] public SwitchParameter NoClobber { get { return _noClobber; } set { _noClobber = value; } } private SwitchParameter _noClobber; /* /// <summary> /// Suppresses being prompted if the publisher of the resource is different from the currently installed version. /// </summary> [Parameter(ParameterSetName = "NameParameterSet")] [Parameter(ParameterSetName = "RequiredResourceFileParameterSet")] public SwitchParameter IgnoreDifferentPublisher { get { return _ignoreDifferentPublisher; } set { _ignoreDifferentPublisher = value; } } private SwitchParameter _ignoreDifferentPublisher; */ /// <summary> /// Suppresses being prompted for untrusted sources. /// </summary> [Parameter(ParameterSetName = "NameParameterSet")] [Parameter(ParameterSetName = "RequiredResourceFileParameterSet")] public SwitchParameter TrustRepository { get { return _trustRepository; } set { _trustRepository = value; } } private SwitchParameter _trustRepository; /// <summary> /// Overrides warning messages about resource installation conflicts. /// If a resource with the same name already exists on the computer, Force allows for multiple versions to be installed. /// If there is an existing resource with the same name and version, Force does NOT overwrite that version. /// </summary> [Parameter(ParameterSetName = "NameParameterSet")] [Parameter(ParameterSetName = "RequiredResourceFileParameterSet")] public SwitchParameter Force { get { return _force; } set { _force = value; } } private SwitchParameter _force; /// <summary> /// Overwrites a previously installed resource with the same name and version. /// </summary> [Parameter(ParameterSetName = "NameParameterSet")] [Parameter(ParameterSetName = "RequiredResourceFileParameterSet")] public SwitchParameter Reinstall { get { return _reinstall; } set { _reinstall = value; } } private SwitchParameter _reinstall; /// <summary> /// Suppresses progress information. /// </summary> [Parameter(ParameterSetName = "NameParameterSet")] [Parameter(ParameterSetName = "RequiredResourceFileParameterSet")] public SwitchParameter Quiet { get { return _quiet; } set { _quiet = value; } } private SwitchParameter _quiet; /// <summary> /// For modules that require a license, AcceptLicense automatically accepts the license agreement during installation. /// </summary> [Parameter(ParameterSetName = "NameParameterSet")] [Parameter(ParameterSetName = "RequiredResourceFileParameterSet")] public SwitchParameter AcceptLicense { get { return _acceptLicense; } set { _acceptLicense = value; } } private SwitchParameter _acceptLicense; /// <summary> /// For /// </summary> [Parameter(ParameterSetName = "RequiredResourceFileParameterSet")] public String RequiredResourceFile { get { return _requiredResourceFile; } set { _requiredResourceFile = value; } } private String _requiredResourceFile; /// <summary> /// For /// </summary> [Parameter(ParameterSetName = "RequiredResourceParameterSet")] public Object RequiredResource // takes either string (json) or hashtable { get { return _requiredResourceHash != null ? (Object)_requiredResourceHash : (Object)_requiredResourceJson; } set { if (value.GetType().Name.Equals("String")) { _requiredResourceJson = (String) value; } else if (value.GetType().Name.Equals("Hashtable")) { _requiredResourceHash = (Hashtable) value; } else { throw new ParameterBindingException("Object is not a JSON or Hashtable"); } } } private string _requiredResourceJson; private Hashtable _requiredResourceHash; /* /// <summary> /// Returns the resource as an object to the console. /// </summary> [Parameter()] public SwitchParameter PassThru { get { return _passThru; } set { _passThru = value; } } private SwitchParameter _passThru; */ // This will be a list of all the repository caches public static readonly List<string> RepoCacheFileName = new List<string>(); public static readonly string RepositoryCacheDir = Path.Combine(Environment.GetFolderPath(SpecialFolder.LocalApplicationData), "PowerShellGet", "RepositoryCache"); public static readonly string OsPlatform = System.Runtime.InteropServices.RuntimeInformation.OSDescription; private string programFilesPath; private string myDocumentsPath; private string psPath; private string psModulesPath; private string psScriptsPath; private List<string> psModulesPathAllDirs; private List<string> psScriptsPathAllDirs; private List<string> pkgsLeftToInstall; // Define the cancellation token. CancellationTokenSource source; CancellationToken cancellationToken; /// <summary> /// </summary> protected override void ProcessRecord() { source = new CancellationTokenSource(); cancellationToken = source.Token; var id = WindowsIdentity.GetCurrent(); var consoleIsElevated = (id.Owner != id.User); // TODO: Test this! // if not core CLR var isWindowsPS = System.Runtime.InteropServices.RuntimeEnvironment.GetRuntimeDirectory().ToLower().Contains("windows") ? true : false; if (isWindowsPS) { programFilesPath = Path.Combine(Environment.GetFolderPath(SpecialFolder.ProgramFiles), "WindowsPowerShell"); /// TODO: Come back to this var userENVpath = Path.Combine(Environment.GetEnvironmentVariable("USERPROFILE"), "Documents"); myDocumentsPath = Path.Combine(Environment.GetFolderPath(SpecialFolder.MyDocuments), "WindowsPowerShell"); } else { programFilesPath = Path.Combine(Environment.GetFolderPath(SpecialFolder.ProgramFiles), "PowerShell"); myDocumentsPath = Path.Combine(Environment.GetFolderPath(SpecialFolder.MyDocuments), "PowerShell"); } this.WriteVerbose(string.Format("Current user scope installation path: {0}", myDocumentsPath)); this.WriteVerbose(string.Format("All users scope installation path: {0}", programFilesPath)); // if Scope is AllUsers and there is no console elevation if (!string.IsNullOrEmpty(_scope) && _scope.Equals("AllUsers") && !consoleIsElevated) { // throw an error when Install-PSResource is used as a non-admin user and '-Scope AllUsers' throw new System.ArgumentException(string.Format(CultureInfo.InvariantCulture, "Install-PSResource requires admin privilege for AllUsers scope.")); } // if no scope is specified (whether or not the console is elevated) default installation will be to CurrentUser // If running under admin on Windows with PowerShell less than PS6, default will be AllUsers if (string.IsNullOrEmpty(_scope)) { _scope = "CurrentUser"; //If Windows and elevated default scope will be all users // If non-Windows or non-elevated default scope will be current user // * TODO: Test // if (!Platform.IsCoreCLR && consoleIsElevated) if (isWindowsPS && consoleIsElevated) { _scope = "AllUsers"; } } // if scope is Current user & (no elevation or elevation) // install to current user path this.WriteVerbose(string.Format("Scope is: {0}", _scope)); psPath = string.Equals(_scope, "AllUsers") ? programFilesPath : myDocumentsPath; psModulesPath = Path.Combine(psPath, "Modules"); psScriptsPath = Path.Combine(psPath, "Scripts"); psModulesPathAllDirs = (Directory.GetDirectories(psModulesPath)).ToList(); psScriptsPathAllDirs = (Directory.GetDirectories(psScriptsPath)).ToList(); JObject json = null; Dictionary<string, PkgParams> pkgsinJson = new Dictionary<string, PkgParams>(); Dictionary<string, string> jsonPkgsNameVersion = new Dictionary<string, string>(); if (_requiredResourceFile != null) { var resolvedReqResourceFile = SessionState.Path.GetResolvedPSPathFromPSPath(_requiredResourceFile).FirstOrDefault().Path; WriteDebug("Resolved required resource file path is: " + resolvedReqResourceFile); if (!File.Exists(resolvedReqResourceFile)) { throw new Exception("The RequiredResourceFile does not exist. Please try specifying a path to a valid .json or .psd1 file"); } if (resolvedReqResourceFile.EndsWith(".psd1")) { // TODO: implement after implementing publish throw new Exception("This feature is not yet implemented"); return; } else if (resolvedReqResourceFile.EndsWith(".json")) { // if json file string jsonString = ""; using (StreamReader sr = new StreamReader(resolvedReqResourceFile)) { _requiredResourceJson = sr.ReadToEnd(); } try { pkgsinJson = JsonConvert.DeserializeObject<Dictionary<string, PkgParams>>(_requiredResourceJson, new JsonSerializerSettings() { MaxDepth = 6 }); } catch (Exception e) { throw new ArgumentException("Argument for parameter -RequiredResource is not in proper json format. Make sure argument is either a hashtable or a json object."); } } else { throw new Exception("The RequiredResourceFile does not have the proper file extension. Please try specifying a path to a valid .json or .psd1 file"); } } if (_requiredResourceHash != null) { string jsonString; try { jsonString = _requiredResourceHash.ToJson(); } catch (Exception e) { throw new ArgumentException("Argument for parameter -RequiredResource is not in proper format. Make sure argument is either a hashtable or a json object."); } PkgParams pkg = null; try { pkg = JsonConvert.DeserializeObject<PkgParams>(jsonString, new JsonSerializerSettings() { MaxDepth = 6 }); } catch (Exception e) { throw new ArgumentException("Argument for parameter -RequiredResource is not in proper json format. Make sure argument is either a hashtable or a json object."); } InstallBeginning(new string[] { pkg.Name }, pkg.Version, pkg.Prerelease, new string[] { pkg.Repository }, pkg.Scope, pkg.AcceptLicense, pkg.Quiet, pkg.Reinstall, pkg.Force, pkg.TrustRepository, pkg.NoClobber, pkg.Credential, cancellationToken); return; } if (_requiredResourceJson != null) { if (!pkgsinJson.Any()) { try { pkgsinJson = JsonConvert.DeserializeObject<Dictionary<string, PkgParams>>(_requiredResourceJson, new JsonSerializerSettings() { MaxDepth = 6 }); } catch (Exception e) { try { jsonPkgsNameVersion = JsonConvert.DeserializeObject<Dictionary<string, string>>(_requiredResourceJson, new JsonSerializerSettings() { MaxDepth = 6 }); } catch (Exception ex) { throw new ArgumentException("Argument for parameter -RequiredResource is not in proper json format. Make sure argument is either a hashtable or a json object."); } } } foreach (var pkg in jsonPkgsNameVersion) { InstallBeginning(new string[] { pkg.Key }, pkg.Value, false, null, null, false, false, false, false, false, false, null, cancellationToken); } foreach (var pkg in pkgsinJson) { InstallBeginning(new string[] { pkg.Key }, pkg.Value.Version, pkg.Value.Prerelease, new string[] { pkg.Value.Repository }, pkg.Value.Scope, pkg.Value.AcceptLicense, pkg.Value.Quiet, pkg.Value.Reinstall, pkg.Value.Force, pkg.Value.TrustRepository, pkg.Value.NoClobber, pkg.Value.Credential, cancellationToken); } return; } InstallBeginning(_name, _version, _prerelease, _repository, _scope, _acceptLicense, _quiet, _reinstall, _force, _trustRepository, _noClobber, _credential, cancellationToken); } public void InstallBeginning(string[] packageNames, string version, bool prerelease, string[] repository, string scope, bool acceptLicense, bool quiet, bool reinstall, bool force, bool trustRepository, bool noClobber, PSCredential credential, CancellationToken cancellationToken) { var r = new RespositorySettings(); var listOfRepositories = r.Read(repository); pkgsLeftToInstall = packageNames.ToList(); var yesToAll = false; var noToAll = false; /* * Untrusted repository * You are installing the modules from an untrusted repository. If you trust this repository, change its InstallationPolicy value by running the Set-PSResourceRepository cmdlet. * Are you sure you want to install the modules from '<repo name >'? * [Y] Yes [A] Yes to ALl [N] No [L] No to all [s] suspendd [?] Help (default is "N"): */ var repositoryIsNotTrusted = "Untrusted repository"; var queryInstallUntrustedPackage = "You are installing the modules from an untrusted repository. If you trust this repository, change its Trusted value by running the Set-PSResourceRepository cmdlet. Are you sure you want to install the PSresource from '{0}' ?"; foreach (var repoName in listOfRepositories) { var sourceTrusted = false; if (string.Equals(repoName.Properties["Trusted"].Value.ToString(), "false", StringComparison.InvariantCultureIgnoreCase) && !trustRepository && !force) { this.WriteDebug("Checking if untrusted repository should be used"); if (!(yesToAll || noToAll)) { var message = string.Format(CultureInfo.InvariantCulture, queryInstallUntrustedPackage, repoName.Properties["Name"].Value.ToString()); sourceTrusted = this.ShouldContinue(message, repositoryIsNotTrusted, true, ref yesToAll, ref noToAll); } } else { sourceTrusted = true; } if (sourceTrusted || yesToAll) { this.WriteDebug("Untrusted repository accepted as trusted source"); // Try to install // if it can't find the pkg in one repository, it'll look in the next one in the list // returns any pkgs that weren't found var returnedPkgsNotInstalled = InstallHelper(repoName.Properties["Url"].Value.ToString(), pkgsLeftToInstall, packageNames, version, prerelease, scope, acceptLicense, quiet, reinstall, force, trustRepository, noClobber, credential, cancellationToken); if (!pkgsLeftToInstall.Any()) { return; } pkgsLeftToInstall = returnedPkgsNotInstalled; } } } // Installing a package will have a transactional behavior: // Package and its dependencies will be saved into a tmp folder // and will only be properly installed if all dependencies are found successfully // Once package is installed, we want to resolve and install all dependencies // Installing public List<string> InstallHelper(string repositoryUrl, List<string> pkgsLeftToInstall, string[] packageNames, string version, bool prerelease,string scope, bool acceptLicense, bool quiet, bool reinstall, bool force, bool trustRepository, bool noClobber, PSCredential credential, CancellationToken cancellationToken) { PackageSource source = new PackageSource(repositoryUrl); if (credential != null) { string password = new NetworkCredential(string.Empty, credential.Password).Password; source.Credentials = PackageSourceCredential.FromUserInput(repositoryUrl, credential.UserName, password, true, null); } var provider = FactoryExtensionsV3.GetCoreV3(NuGet.Protocol.Core.Types.Repository.Provider); SourceRepository repository = new SourceRepository(source, provider); SearchFilter filter = new SearchFilter(prerelease); ////////////////////// packages from source /// PackageSource source2 = new PackageSource(repositoryUrl); if (credential != null) { string password = new NetworkCredential(string.Empty, credential.Password).Password; source2.Credentials = PackageSourceCredential.FromUserInput(repositoryUrl, credential.UserName, password, true, null); } var provider2 = FactoryExtensionsV3.GetCoreV3(NuGet.Protocol.Core.Types.Repository.Provider); SourceRepository repository2 = new SourceRepository(source2, provider2); // TODO: proper error handling here PackageMetadataResource resourceMetadata2 = null; try { resourceMetadata2 = repository.GetResourceAsync<PackageMetadataResource>().GetAwaiter().GetResult(); } catch { this.WriteVerbose("Error retreiving repository resource"); } SearchFilter filter2 = new SearchFilter(prerelease); SourceCacheContext context2 = new SourceCacheContext(); foreach (var n in packageNames) { IPackageSearchMetadata filteredFoundPkgs = null; VersionRange versionRange = null; if (version == null) { // ensure that the latst version is returned first (the ordering of versions differ // TODO: proper error handling try { filteredFoundPkgs = (resourceMetadata2.GetMetadataAsync(n, prerelease, false, context2, NullLogger.Instance, cancellationToken).GetAwaiter().GetResult() .OrderByDescending(p => p.Identity.Version, VersionComparer.VersionRelease) .FirstOrDefault()); } catch { this.WriteVerbose(string.Format("Could not find package {0}", n)); } } else { // check if exact version NuGetVersion nugetVersion; NuGetVersion.TryParse(version, out nugetVersion); if (nugetVersion != null) { // exact version versionRange = new VersionRange(nugetVersion, true, nugetVersion, true, null, null); } else { // check if version range versionRange = VersionRange.Parse(version); } this.WriteVerbose(string.Format("Version is: {0}", versionRange.ToString())); // Search for packages within a version range // ensure that the latst version is returned first (the ordering of versions differ filteredFoundPkgs = (resourceMetadata2.GetMetadataAsync(n, prerelease, false, context2, NullLogger.Instance, cancellationToken).GetAwaiter().GetResult() .Where(p => versionRange.Satisfies(p.Identity.Version)) .OrderByDescending(p => p.Identity.Version, VersionComparer.VersionRelease) .FirstOrDefault()); } List<IPackageSearchMetadata> foundDependencies = new List<IPackageSearchMetadata>(); // found a package to install and looking for dependencies // Search for dependencies if (filteredFoundPkgs != null) { // need to improve this later // this function recursively finds all dependencies // might need to do add instead of AddRange foundDependencies.AddRange(FindDependenciesFromSource(filteredFoundPkgs, resourceMetadata2, context2, prerelease, reinstall)); } // check which pkgs you actually need to install List<IPackageSearchMetadata> pkgsToInstall = new List<IPackageSearchMetadata>(); // install pkg, then install any dependencies to a temp directory pkgsToInstall.Add(filteredFoundPkgs); pkgsToInstall.AddRange(foundDependencies); // - we have a list of everything that needs to be installed (dirsToDelete) // - we check the system to see if that particular package AND package version is there (PSModulesPath) // - if it is, we remove it from the list of pkgs to install if (versionRange != null) { // for each package name passed in foreach (var name in packageNames) { var pkgDirName = Path.Combine(psModulesPath, name); var pkgDirNameScript = Path.Combine(psScriptsPath, name); // Check to see if the package dir exists in the path if (psModulesPathAllDirs.Contains(pkgDirName, StringComparer.OrdinalIgnoreCase) || psScriptsPathAllDirs.Contains(pkgDirNameScript, StringComparer.OrdinalIgnoreCase)) { // then check to see if the package version exists in the path var pkgDirVersion = (Directory.GetDirectories(pkgDirName)).ToList(); // check scripts path too // TODO: check if script is installed??? // pkgDirVersion.AddRange((Directory.GetDirectories(pkgDirNameScript)).ToList()); List<string> pkgVersion = new List<string>(); foreach (var path in pkgDirVersion) { pkgVersion.Add(Path.GetFileName(path)); } // these are all the packages already installed var pkgsAlreadyInstalled = pkgVersion.FindAll(p => versionRange.Satisfies(NuGetVersion.Parse(p))); if (pkgsAlreadyInstalled.Any() && !reinstall) { // remove the pkg from the list of pkgs that need to be installed var pkgsToRemove = pkgsToInstall.Find(p => string.Equals(p.Identity.Id, name, StringComparison.CurrentCultureIgnoreCase)); pkgsToInstall.Remove(pkgsToRemove); pkgsLeftToInstall.Remove(name); } } } } // exact version installation else // if (versionRange != null) { // for each package name passed in foreach (var name in packageNames) { // case sensitivity issues here! var dirName = Path.Combine(psModulesPath, name); var dirNameScript = Path.Combine(psModulesPath, name); // Check to see if the package dir exists in the path if (psModulesPathAllDirs.Contains(dirName, StringComparer.OrdinalIgnoreCase) || psScriptsPathAllDirs.Contains(dirNameScript, StringComparer.OrdinalIgnoreCase)) { // then check to see if the package exists in the path if ((Directory.Exists(dirName) || Directory.Exists(dirNameScript)) && !reinstall) { // remove the pkg from the list of pkgs that need to be installed //case sensitivity here var pkgsToRemove = pkgsToInstall.Find(p => string.Equals(p.Identity.Id, name, StringComparison.CurrentCultureIgnoreCase)); pkgsToInstall.Remove(pkgsToRemove); pkgsLeftToInstall.Remove(name); //Directory.Delete(dirNameVersion.ToString(), true); } } } } //remove any null pkgs pkgsToInstall.Remove(null); var tempInstallPath = Path.Combine(Path.GetTempPath(), Guid.NewGuid().ToString()); var dir = Directory.CreateDirectory(tempInstallPath); // should check it gets created properly //dir.SetAccessControl(new DirectorySecurity(dir.FullName, AccessControlSections.Owner)); // To delete file attributes from the existing ones get the current file attributes first and use AND (&) operator // with a mask (bitwise complement of desired attributes combination). dir.Attributes = dir.Attributes & ~FileAttributes.ReadOnly; // install everything to a temp path foreach (var p in pkgsToInstall) { if (!quiet) { int i = 1; int j = 1; /**************************** * START PACKAGE INSTALLATION -- start progress bar *****************************/ /// start progress bar /// //Write - Progress - Activity "Search in Progress" - Status "$i% Complete:" - PercentComplete $i int activityId = 0; string activity = ""; string statusDescription = ""; if (packageNames.ToList().Contains(p.Identity.Id)) { // if the pkg exists in one of the names passed in, then we wont include it as a dependent package //System.Diagnostics.Debug.WriteLine("Debug statement"); this.WriteVerbose("Verbose statement"); this.WriteDebug("Another Debug statement"); //this.WriteError(new ErrorRecord("An Error statement")); activityId = 0; activity = string.Format("Installing {0}...", p); statusDescription = string.Format("{0}% Complete:", i++); j = 1; } else { // child process // installing dependent package activityId = 1; activity = string.Format("Installing dependent package {0}...", p); statusDescription = string.Format("{0}% Complete:", j); } var progressRecord = new ProgressRecord(activityId, activity, statusDescription); this.WriteProgress(progressRecord); } var pkgIdentity = new PackageIdentity(p.Identity.Id, p.Identity.Version); var resource = new DownloadResourceV2FeedProvider(); var resource2 = resource.TryCreate(repository, cancellationToken); var cacheContext = new SourceCacheContext(); var downloadResource = repository.GetResourceAsync<DownloadResource>().GetAwaiter().GetResult(); var result = downloadResource.GetDownloadResourceResultAsync( pkgIdentity, new PackageDownloadContext(cacheContext), tempInstallPath, logger: NullLogger.Instance, CancellationToken.None).GetAwaiter().GetResult(); // need to close the .nupkg result.Dispose(); // ACCEPT LICENSE //Prompt if module requires license Acceptance //var requireLicenseAcceptance = p.RequireLicenseAcceptance; // need to read from .psd1 var modulePath = Path.Combine(tempInstallPath, pkgIdentity.Id, pkgIdentity.Version.ToNormalizedString()); var moduleManifest = Path.Combine(modulePath, pkgIdentity.Id + ".psd1"); var requireLicenseAcceptance = false; using (StreamReader sr = new StreamReader(moduleManifest)) { var text = sr.ReadToEnd(); var pattern = "RequireLicenseAcceptance\\s*=\\s*\\$true"; var patternToSkip1 = "#\\s*RequireLicenseAcceptance\\s*=\\s*\\$true"; var patternToSkip2 = "\\*\\s*RequireLicenseAcceptance\\s*=\\s*\\$true"; Regex rgx = new Regex(pattern); if (rgx.IsMatch(pattern) && !rgx.IsMatch(patternToSkip1) && !rgx.IsMatch(patternToSkip2)) { requireLicenseAcceptance = true; } } if (requireLicenseAcceptance) { // if module requires license acceptance and -AcceptLicense is not passed in, prompt if (!acceptLicense) { var PkgTempInstallPath = Path.Combine(tempInstallPath, p.Identity.Id, p.Identity.Version.ToNormalizedString()); var LicenseFilePath = Path.Combine(PkgTempInstallPath, "License.txt"); if (!File.Exists(LicenseFilePath)) { var exMessage = "License.txt not Found. License.txt must be provided when user license acceptance is required."; var ex = new ArgumentException(exMessage); // System.ArgumentException vs PSArgumentException var acceptLicenseError = new ErrorRecord(ex, "LicenseTxtNotFound", ErrorCategory.ObjectNotFound, null); this.ThrowTerminatingError(acceptLicenseError); } // otherwise read LicenseFile string licenseText = System.IO.File.ReadAllText(LicenseFilePath); var acceptanceLicenseQuery = $"Do you accept the license terms for module '{p.Identity.Id}'."; var message = licenseText + "`r`n" + acceptanceLicenseQuery; var title = "License Acceptance"; var yesToAll = false; var noToAll = false; var shouldContinueResult = ShouldContinue(message, title, true, ref yesToAll, ref noToAll); if (yesToAll) { acceptLicense = true; } } // Check if user agreed to license terms, if they didn't, throw error // if they did, continue to install if (!acceptLicense) { var message = $"License Acceptance is required for module '{p.Identity.Id}'. Please specify '-AcceptLicense' to perform this operation."; var ex = new ArgumentException(message); // System.ArgumentException vs PSArgumentException var acceptLicenseError = new ErrorRecord(ex, "ForceAcceptLicense", ErrorCategory.InvalidArgument, null); this.ThrowTerminatingError(acceptLicenseError); } } // create a download count to see if everything was installed properly // 1) remove the *.nupkg file // may need to modify due to capitalization var dirNameVersion = Path.Combine(tempInstallPath, p.Identity.Id, p.Identity.Version.ToNormalizedString()); var nupkgMetadataToDelete = Path.Combine(dirNameVersion, (p.Identity.ToString() + p.Identity.Version.ToNormalizedString() + ".nupkg").ToLower()); var nupkgToDelete = Path.Combine(dirNameVersion, (p.Identity.ToString() + ".nupkg").ToLower()); var nupkgSHAToDelete = Path.Combine(dirNameVersion, (p.Identity.ToString() + ".nupkg.sha512").ToLower()); var nuspecToDelete = Path.Combine(dirNameVersion, (p.Identity.Id + ".nuspec").ToLower()); File.Delete(nupkgMetadataToDelete); File.Delete(nupkgSHAToDelete); File.Delete(nuspecToDelete); File.Delete(nupkgToDelete); // if it's not a script, do the following: var scriptPath = Path.Combine(dirNameVersion, (p.Identity.Id.ToString() + ".ps1").ToLower()); var isScript = File.Exists(scriptPath) ? true : false; WriteDebug("Script file path is: " + scriptPath); // 3) create xml //Create PSGetModuleInfo.xml //Set attribute as hidden [System.IO.File]::SetAttributes($psgetItemInfopath, [System.IO.FileAttributes]::Hidden) var fullinstallPath = isScript ? Path.Combine(dirNameVersion, (p.Identity.Id + "_InstalledScriptInfo.xml")) : Path.Combine(dirNameVersion, "PSGetModuleInfo.xml"); // Create XMLs using (StreamWriter sw = new StreamWriter(fullinstallPath)) { var psModule = "PSModule"; var tags = p.Tags.Split(' '); var module = tags.Contains("PSModule") ? "Module" : null; var script = tags.Contains("PSScript") ? "Script" : null; List<string> includesDscResource = new List<string>(); List<string> includesCommand = new List<string>(); List<string> includesFunction = new List<string>(); List<string> includesRoleCapability = new List<string>(); List<string> filteredTags = new List<string>(); var psDscResource = "PSDscResource_"; var psCommand = "PSCommand_"; var psFunction = "PSFunction_"; var psRoleCapability = "PSRoleCapability_"; foreach (var tag in tags) { if (tag.StartsWith(psDscResource)) { includesDscResource.Add(tag.Remove(0, psDscResource.Length)); } else if (tag.StartsWith(psCommand)) { includesCommand.Add(tag.Remove(0, psCommand.Length)); } else if (tag.StartsWith(psFunction)) { includesFunction.Add(tag.Remove(0, psFunction.Length)); } else if (tag.StartsWith(psRoleCapability)) { includesRoleCapability.Add(tag.Remove(0, psRoleCapability.Length)); } else if (!tag.StartsWith("PSWorkflow_") && !tag.StartsWith("PSCmdlet_") && !tag.StartsWith("PSIncludes_") && !tag.Equals("PSModule") && !tag.Equals("PSScript")) { filteredTags.Add(tag); } } // If NoClobber is specified, ensure command clobbering does not happen if (noClobber) { /// This is a primitive implementation /// TODO: // 1) get all paths possible // 2) search all modules and compare /// Cannot uninstall a module if another module is dependent on it using (System.Management.Automation.PowerShell pwsh = System.Management.Automation.PowerShell.Create()) { // Get all modules var results = pwsh.AddCommand("Get-Module").AddParameter("ListAvailable").Invoke(); // Structure of LINQ call: // Results is a collection of PSModuleInfo objects that contain a property listing module commands, "ExportedCommands". // ExportedCommands is collection of PSModuleInfo objects that need to be iterated through to see if any of them are the command we're trying to install // If anything from the final call gets returned, there is a command clobber with this pkg. List<IEnumerable<PSObject>> pkgsWithCommandClobber = new List<IEnumerable<PSObject>>(); foreach (string command in includesCommand) { pkgsWithCommandClobber.Add(results.Where(pkg => ((ReadOnlyCollection<PSModuleInfo>)pkg.Properties["ExportedCommands"].Value).Where(ec => ec.Name.Equals(command, StringComparison.InvariantCultureIgnoreCase)).Any())); } if (pkgsWithCommandClobber.Any()) { var uniqueCommandNames = (pkgsWithCommandClobber.Select(cmd => cmd.ToString()).Distinct()).ToArray(); string strUniqueCommandNames = string.Join(",", uniqueCommandNames); throw new System.ArgumentException(string.Format(CultureInfo.InvariantCulture, "Command(s) with name(s) '{0}' is already available on this system. Installing '{1}' may override the existing command. If you still want to install '{1}', remove the -NoClobber parameter.", strUniqueCommandNames, p.Identity.Id)); } } } Dictionary<string, List<string>> includes = new Dictionary<string, List<string>>() { { "DscResource", includesDscResource }, { "Command", includesCommand }, { "Function", includesFunction }, { "RoleCapability", includesRoleCapability } }; Dictionary<string, VersionRange> dependencies = new Dictionary<string, VersionRange>(); foreach (var depGroup in p.DependencySets) { PackageDependency depPkg = depGroup.Packages.FirstOrDefault(); dependencies.Add(depPkg.Id, depPkg.VersionRange); } var psGetModuleInfoObj = new PSObject(); // TODO: Add release notes psGetModuleInfoObj.Members.Add(new PSNoteProperty("Name", p.Identity.Id)); psGetModuleInfoObj.Members.Add(new PSNoteProperty("Version", p.Identity.Version)); psGetModuleInfoObj.Members.Add(new PSNoteProperty("Type", module != null ? module : (script != null ? script : null))); psGetModuleInfoObj.Members.Add(new PSNoteProperty("Description", p.Description)); psGetModuleInfoObj.Members.Add(new PSNoteProperty("Author", p.Authors)); psGetModuleInfoObj.Members.Add(new PSNoteProperty("CompanyName", p.Owners)); psGetModuleInfoObj.Members.Add(new PSNoteProperty("PublishedDate", p.Published)); psGetModuleInfoObj.Members.Add(new PSNoteProperty("InstalledDate", System.DateTime.Now)); psGetModuleInfoObj.Members.Add(new PSNoteProperty("LicenseUri", p.LicenseUrl)); psGetModuleInfoObj.Members.Add(new PSNoteProperty("ProjectUri", p.ProjectUrl)); psGetModuleInfoObj.Members.Add(new PSNoteProperty("IconUri", p.IconUrl)); psGetModuleInfoObj.Members.Add(new PSNoteProperty("Includes", includes.ToList())); // TODO: check if getting deserialized properly psGetModuleInfoObj.Members.Add(new PSNoteProperty("PowerShellGetFormatVersion", "3")); psGetModuleInfoObj.Members.Add(new PSNoteProperty("Dependencies", dependencies.ToList())); psGetModuleInfoObj.Members.Add(new PSNoteProperty("RepositorySourceLocation", repositoryUrl)); psGetModuleInfoObj.Members.Add(new PSNoteProperty("Repository", repositoryUrl)); psGetModuleInfoObj.Members.Add(new PSNoteProperty("InstalledLocation", null)); // TODO: add installation location psGetModuleInfoObj.TypeNames.Add("Microsoft.PowerShell.Commands.PSRepositoryItemInfo"); var serializedObj = PSSerializer.Serialize(psGetModuleInfoObj); sw.Write(serializedObj); // set the xml attribute to hidden //System.IO.File.SetAttributes("c:\\code\\temp\\installtestpath\\PSGetModuleInfo.xml", FileAttributes.Hidden); } // 4) copy to proper path // TODO: test installing a script when it already exists // or move to script path // check for failures // var newPath = Directory.CreateDirectory(Path.Combine(psModulesPath, p.Identity.Id, p.Identity.Version.ToNormalizedString())); var installPath = isScript ? psScriptsPath : psModulesPath; var newPath = isScript ? installPath : Path.Combine(installPath, p.Identity.Id.ToString()); // when we move the directory over, we'll change the casing of the module directory name from lower case to proper casing. WriteDebug("New module or script installation path is: " + newPath); // if script, just move the files over, if module, move the version directory overp var tempModuleVersionDir = isScript ? Path.Combine(tempInstallPath, p.Identity.Id.ToLower(), p.Identity.Version.ToNormalizedString()) : Path.Combine(tempInstallPath, p.Identity.Id.ToLower()); if (isScript) { var scriptXML = p.Identity.Id + "_InstalledScriptInfo.xml"; File.Move(Path.Combine(tempModuleVersionDir, scriptXML), Path.Combine(psScriptsPath, "InstalledScriptInfos", scriptXML)); File.Move(Path.Combine(tempModuleVersionDir, p.Identity.Id.ToLower() + ".ps1"), Path.Combine(newPath, p.Identity.Id + ".ps1")); } else { if (!Directory.Exists(newPath)) { Directory.Move(tempModuleVersionDir, newPath); } else { tempModuleVersionDir = Path.Combine(tempModuleVersionDir, p.Identity.Version.ToNormalizedString()); var newVersionPath = Path.Combine(newPath, p.Identity.Version.ToNormalizedString()); if (Directory.Exists(newVersionPath)) { // Delete the directory path before replacing it with the new module Directory.Delete(newVersionPath, true); } Directory.Move(tempModuleVersionDir, Path.Combine(newPath, p.Identity.Version.ToNormalizedString())); } } // 2) TODO: Verify that all the proper modules installed correctly // remove temp directory recursively Directory.Delete(tempInstallPath, true); pkgsLeftToInstall.Remove(n); } } return pkgsLeftToInstall; } private List<IPackageSearchMetadata> FindDependenciesFromSource(IPackageSearchMetadata pkg, PackageMetadataResource pkgMetadataResource, SourceCacheContext srcContext, bool prerelease, bool reinstall) { /// dependency resolver /// /// this function will be recursively called /// /// call the findpackages from source helper (potentially generalize this so it's finding packages from source or cache) /// List<IPackageSearchMetadata> foundDependencies = new List<IPackageSearchMetadata>(); // 1) check the dependencies of this pkg // 2) for each dependency group, search for the appropriate name and version // a dependency group are all the dependencies for a particular framework foreach (var dependencyGroup in pkg.DependencySets) { foreach (var pkgDependency in dependencyGroup.Packages) { // 2.1) check that the appropriate pkg dependencies exist // returns all versions from a single package id. var dependencies = pkgMetadataResource.GetMetadataAsync(pkgDependency.Id, prerelease, true, srcContext, NullLogger.Instance, cancellationToken).GetAwaiter().GetResult(); // then 2.2) check if the appropriate verion range exists (if version exists, then add it to the list to return) VersionRange versionRange = null; try { versionRange = VersionRange.Parse(pkgDependency.VersionRange.OriginalString); } catch { Console.WriteLine("Error parsing version range"); } // if no version/version range is specified the we just return the latest version IPackageSearchMetadata depPkgToReturn = (versionRange == null ? dependencies.FirstOrDefault() : dependencies.Where(v => versionRange.Satisfies(v.Identity.Version)).FirstOrDefault()); // if the pkg already exists on the system, don't add it to the list of pkgs that need to be installed var dirName = Path.Combine(psModulesPath, pkgDependency.Id); var dependencyAlreadyInstalled = false; // Check to see if the package dir exists in the path if (psModulesPathAllDirs.Contains(dirName, StringComparer.OrdinalIgnoreCase)) { // then check to see if the package exists in the path if (Directory.Exists(dirName)) { // then check to see if the package version exists in the path var pkgDirVersion = (Directory.GetDirectories(dirName)).ToList(); List<string> pkgVersion = new List<string>(); foreach (var path in pkgDirVersion) { pkgVersion.Add(Path.GetFileName(path)); } // these are all the packages already installed NuGetVersion ver; // findall var pkgsAlreadyInstalled = pkgVersion.FindAll(p => NuGetVersion.TryParse(p, out ver) && versionRange.Satisfies(ver)); if (pkgsAlreadyInstalled.Any() && !reinstall) { // don't add the pkg to the list of pkgs that need to be installed dependencyAlreadyInstalled = true; } } } if (!dependencyAlreadyInstalled) { foundDependencies.Add(depPkgToReturn); } // 3) search for any dependencies the pkg has foundDependencies.AddRange(FindDependenciesFromSource(depPkgToReturn, pkgMetadataResource, srcContext, prerelease, reinstall)); } } // flatten after returning return foundDependencies; } } } |