PowerShell-master/src/Microsoft.PowerShell.Commands.Management/commands/management/ParsePathCommand.cs

// Copyright (c) Microsoft Corporation.
// Licensed under the MIT License.

using System;
using System.Collections.ObjectModel;
using System.Collections.Specialized;
using System.Management.Automation;
using System.Management.Automation.Internal;

using Dbg = System.Management.Automation;

namespace Microsoft.PowerShell.Commands
{
    /// <summary>
    /// A command to resolve PowerShell paths containing glob characters to
    /// PowerShell paths that match the glob strings.
    /// </summary>
    [Cmdlet(VerbsCommon.Split, "Path", DefaultParameterSetName = "ParentSet", SupportsTransactions = true, HelpUri = "https://go.microsoft.com/fwlink/?LinkID=2097149")]
    [OutputType(typeof(string), ParameterSetName = new[] { leafSet,
                                                           leafBaseSet,
                                                           extensionSet,
                                                           noQualifierSet,
                                                           parentSet,
                                                           qualifierSet,
                                                           literalPathSet})]
    [OutputType(typeof(bool), ParameterSetName = new[] { isAbsoluteSet })]
    public class SplitPathCommand : CoreCommandWithCredentialsBase
    {
        #region Parameters

        /// <summary>
        /// The parameter set name to get the parent path.
        /// </summary>
        private const string parentSet = "ParentSet";

        /// <summary>
        /// The parameter set name to get the leaf name.
        /// </summary>
        private const string leafSet = "LeafSet";

        /// <summary>
        /// The parameter set name to get the leaf base name.
        /// </summary>
        private const string leafBaseSet = "LeafBaseSet";

        /// <summary>
        /// The parameter set name to get the extension.
        /// </summary>
        private const string extensionSet = "ExtensionSet";

        /// <summary>
        /// The parameter set name to get the qualifier set.
        /// </summary>
        private const string qualifierSet = "QualifierSet";

        /// <summary>
        /// The parameter set name to get the noqualifier set.
        /// </summary>
        private const string noQualifierSet = "NoQualifierSet";

        /// <summary>
        /// The parameter set name to get the IsAbsolute set.
        /// </summary>
        private const string isAbsoluteSet = "IsAbsoluteSet";

        /// <summary>
        /// The parameter set name to get the LiteralPath set.
        /// </summary>
        private const string literalPathSet = "LiteralPathSet";

        /// <summary>
        /// Gets or sets the path parameter to the command.
        /// </summary>
        [Parameter(Position = 0, ParameterSetName = parentSet, Mandatory = true, ValueFromPipeline = true, ValueFromPipelineByPropertyName = true)]
        [Parameter(Position = 0, ParameterSetName = leafSet, Mandatory = true, ValueFromPipeline = true, ValueFromPipelineByPropertyName = true)]
        [Parameter(Position = 0, ParameterSetName = leafBaseSet, Mandatory = true, ValueFromPipeline = true, ValueFromPipelineByPropertyName = true)]
        [Parameter(Position = 0, ParameterSetName = extensionSet, Mandatory = true, ValueFromPipeline = true, ValueFromPipelineByPropertyName = true)]
        [Parameter(Position = 0, ParameterSetName = qualifierSet, Mandatory = true, ValueFromPipeline = true, ValueFromPipelineByPropertyName = true)]
        [Parameter(Position = 0, ParameterSetName = noQualifierSet, Mandatory = true, ValueFromPipeline = true, ValueFromPipelineByPropertyName = true)]
        [Parameter(Position = 0, ParameterSetName = isAbsoluteSet, Mandatory = true, ValueFromPipeline = true, ValueFromPipelineByPropertyName = true)]
        public string[] Path { get; set; }

        /// <summary>
        /// Gets or sets the literal path parameter to the command.
        /// </summary>
        [Parameter(ParameterSetName = "LiteralPathSet", Mandatory = true, ValueFromPipeline = false, ValueFromPipelineByPropertyName = true)]
        [Alias("PSPath", "LP")]
        public string[] LiteralPath
        {
            get
            {
                return Path;
            }

            set
            {
                base.SuppressWildcardExpansion = true;
                Path = value;
            }
        }

        /// <summary>
        /// Determines if the qualifier should be returned.
        /// </summary>
        /// <value>
        /// If true the qualifier of the path will be returned.
        /// The qualifier is the drive or provider that is qualifying
        /// the PowerShell path.
        /// </value>
        [Parameter(ParameterSetName = qualifierSet, Mandatory = true, ValueFromPipelineByPropertyName = true)]
        public SwitchParameter Qualifier { get; set; }

        /// <summary>
        /// Determines if the qualifier should be returned.
        /// </summary>
        /// <value>
        /// If true the qualifier of the path will be returned.
        /// The qualifier is the drive or provider that is qualifying
        /// the PowerShell path.
        /// </value>
        [Parameter(ParameterSetName = noQualifierSet, Mandatory = true, ValueFromPipelineByPropertyName = true)]
        public SwitchParameter NoQualifier { get; set; }

        /// <summary>
        /// Determines if the parent path should be returned.
        /// </summary>
        /// <value>
        /// If true the parent of the path will be returned.
        /// </value>
        [Parameter(ParameterSetName = parentSet, Mandatory = false, ValueFromPipelineByPropertyName = true)]
        public SwitchParameter Parent { get; set; } = true;

        /// <summary>
        /// Determines if the leaf name should be returned.
        /// </summary>
        /// <value>
        /// If true the leaf name of the path will be returned.
        /// </value>
        [Parameter(ParameterSetName = leafSet, Mandatory = true, ValueFromPipelineByPropertyName = true)]
        public SwitchParameter Leaf { get; set; }

        /// <summary>
        /// Determines if the leaf base name (name without extension) should be returned.
        /// </summary>
        /// <value>
        /// If true the leaf base name of the path will be returned.
        /// </value>
        [Parameter(ParameterSetName = leafBaseSet, Mandatory = true, ValueFromPipelineByPropertyName = true)]
        public SwitchParameter LeafBase { get; set; }

        /// <summary>
        /// Determines if the extension should be returned.
        /// </summary>
        /// <value>
        /// If true the extension of the path will be returned.
        /// </value>
        [Parameter(ParameterSetName = extensionSet, Mandatory = true, ValueFromPipelineByPropertyName = true)]
        public SwitchParameter Extension { get; set; }

        /// <summary>
        /// Determines if the path should be resolved before being parsed.
        /// </summary>
        /// <value></value>
        [Parameter]
        public SwitchParameter Resolve { get; set; }

        /// <summary>
        /// Determines if the path is an absolute path.
        /// </summary>
        [Parameter(ParameterSetName = isAbsoluteSet, Mandatory = true)]
        public SwitchParameter IsAbsolute { get; set; }

        #endregion Parameters

        #region parameter data

        #endregion parameter data

        #region Command code

        /// <summary>
        /// Parses the specified path and returns the portion determined by the
        /// boolean parameters.
        /// </summary>
        protected override void ProcessRecord()
        {
            StringCollection pathsToParse = new();

            if (Resolve)
            {
                CmdletProviderContext currentContext = CmdletProviderContext;

                foreach (string path in Path)
                {
                    // resolve the paths and then parse each one.

                    Collection<PathInfo> resolvedPaths;

                    try
                    {
                        resolvedPaths =
                            SessionState.Path.GetResolvedPSPathFromPSPath(path, currentContext);
                    }
                    catch (PSNotSupportedException notSupported)
                    {
                        WriteError(
                            new ErrorRecord(
                                notSupported.ErrorRecord,
                                notSupported));
                        continue;
                    }
                    catch (DriveNotFoundException driveNotFound)
                    {
                        WriteError(
                            new ErrorRecord(
                                driveNotFound.ErrorRecord,
                                driveNotFound));
                        continue;
                    }
                    catch (ProviderNotFoundException providerNotFound)
                    {
                        WriteError(
                            new ErrorRecord(
                                providerNotFound.ErrorRecord,
                                providerNotFound));
                        continue;
                    }
                    catch (ItemNotFoundException pathNotFound)
                    {
                        WriteError(
                            new ErrorRecord(
                                pathNotFound.ErrorRecord,
                                pathNotFound));
                        continue;
                    }

                    foreach (PathInfo resolvedPath in resolvedPaths)
                    {
                        try
                        {
                            if (InvokeProvider.Item.Exists(resolvedPath.Path, currentContext))
                            {
                                pathsToParse.Add(resolvedPath.Path);
                            }
                        }
                        catch (PSNotSupportedException notSupported)
                        {
                            WriteError(
                                new ErrorRecord(
                                    notSupported.ErrorRecord,
                                    notSupported));
                            continue;
                        }
                        catch (DriveNotFoundException driveNotFound)
                        {
                            WriteError(
                                new ErrorRecord(
                                    driveNotFound.ErrorRecord,
                                    driveNotFound));
                            continue;
                        }
                        catch (ProviderNotFoundException providerNotFound)
                        {
                            WriteError(
                                new ErrorRecord(
                                    providerNotFound.ErrorRecord,
                                    providerNotFound));
                            continue;
                        }
                        catch (ItemNotFoundException pathNotFound)
                        {
                            WriteError(
                                new ErrorRecord(
                                    pathNotFound.ErrorRecord,
                                    pathNotFound));
                            continue;
                        }
                    }
                }
            }
            else
            {
                pathsToParse.AddRange(Path);
            }

            // Now parse each path

            for (int index = 0; index < pathsToParse.Count; ++index)
            {
                string result = null;

                // Check switch parameters in order of specificity
                if (IsAbsolute)
                {
                    string ignored;
                    bool isPathAbsolute =
                        SessionState.Path.IsPSAbsolute(pathsToParse[index], out ignored);

                    WriteObject(isPathAbsolute);
                    continue;
                }
                else if (Qualifier)
                {
                    int separatorIndex = pathsToParse[index].IndexOf(':');

                    if (separatorIndex < 0)
                    {
                        FormatException e =
                            new(
                                StringUtil.Format(NavigationResources.ParsePathFormatError, pathsToParse[index]));
                        WriteError(
                            new ErrorRecord(
                                e,
                                "ParsePathFormatError", // RENAME
                                ErrorCategory.InvalidArgument,
                                pathsToParse[index]));
                        continue;
                    }
                    else
                    {
                        // Check to see if it is provider or drive qualified

                        if (SessionState.Path.IsProviderQualified(pathsToParse[index]))
                        {
                            // The plus 2 is for the length of the provider separator
                            // which is "::"

                            result =
                                pathsToParse[index].Substring(
                                    0,
                                    separatorIndex + 2);
                        }
                        else
                        {
                            result =
                                pathsToParse[index].Substring(
                                    0,
                                    separatorIndex + 1);
                        }
                    }
                }
                else if (Leaf || LeafBase || Extension)
                {
                    try
                    {
                        result =
                            SessionState.Path.ParseChildName(
                                pathsToParse[index],
                                CmdletProviderContext,
                                true);
                        if (LeafBase)
                        {
                            result = System.IO.Path.GetFileNameWithoutExtension(result);
                        }
                        else if (Extension)
                        {
                            result = System.IO.Path.GetExtension(result);
                        }
                    }
                    catch (PSNotSupportedException)
                    {
                        // Since getting the leaf part of a path is not supported,
                        // the provider must be a container, item, or drive
                        // provider.  Since the paths for these types of
                        // providers can't be split, asking for the leaf
                        // is asking for the specified path back.
                        result = pathsToParse[index];
                    }
                    catch (DriveNotFoundException driveNotFound)
                    {
                        WriteError(
                            new ErrorRecord(
                                driveNotFound.ErrorRecord,
                                driveNotFound));
                        continue;
                    }
                    catch (ProviderNotFoundException providerNotFound)
                    {
                        WriteError(
                            new ErrorRecord(
                                providerNotFound.ErrorRecord,
                                providerNotFound));
                        continue;
                    }
                }
                else if (NoQualifier)
                {
                    result = RemoveQualifier(pathsToParse[index]);
                }
                else
                {
                    // None of the switch parameters are true: default to -Parent behavior
                    try
                    {
                        result =
                            SessionState.Path.ParseParent(
                                pathsToParse[index],
                                string.Empty,
                                CmdletProviderContext,
                                true);
                    }
                    catch (PSNotSupportedException)
                    {
                        // Since getting the parent path is not supported,
                        // the provider must be a container, item, or drive
                        // provider.  Since the paths for these types of
                        // providers can't be split, asking for the parent
                        // is asking for an empty string.
                        result = string.Empty;
                    }
                }

                if (result != null)
                {
                    WriteObject(result);
                }
            }
        }
        #endregion Command code

        /// <summary>
        /// Removes either the drive or provider qualifier or both from the path.
        /// </summary>
        /// <param name="path">
        /// The path to strip the provider qualifier from.
        /// </param>
        /// <returns>
        /// The path without the qualifier.
        /// </returns>
        private string RemoveQualifier(string path)
        {
            Dbg.Diagnostics.Assert(
                path != null,
                "Path should be verified by the caller");

            string result = path;

            if (SessionState.Path.IsProviderQualified(path))
            {
                int index = path.IndexOf("::", StringComparison.Ordinal);

                if (index != -1)
                {
                    // remove the qualifier
                    result = path.Substring(index + 2);
                }
            }
            else
            {
                string driveName = string.Empty;

                if (SessionState.Path.IsPSAbsolute(path, out driveName))
                {
                    var driveNameLength = driveName.Length;
                    if (path.Length > (driveNameLength + 1) && path[driveNameLength] == ':')
                    {
                        // Remove the drive name and colon
                        result = path.Substring(driveNameLength + 1);
                    }
                }
            }

            return result;
        }
    }
}