GenXdev

3.26.2026

Functions/GenXdev.FileSystem/Set-LocationParent5.cs

// ################################################################################
// Part of PowerShell module : GenXdev.FileSystem
// Original cmdlet filename : Set-LocationParent5.cs
// Original author : René Vaessen / GenXdev
// Version : 3.26.2026
// ################################################################################
// Copyright (c) 2026 René Vaessen / GenXdev
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
// ################################################################################



using System.Management.Automation;

namespace GenXdev.FileSystem
{
    [System.ComponentModel.Description(@"
.SYNOPSIS
Navigates up five directory levels in the file system hierarchy.
.DESCRIPTION
* Changes the current working directory by moving up five parent
  directory levels.
* Displays the contents of the resulting directory.
* Provides a convenient shorthand alias '......' for quick navigation.
.EXAMPLE
```powershell
Set-LocationParent5
```

Navigates up five directory levels from the current location.
.EXAMPLE
```powershell
......
```

Uses the alias to navigate up five directory levels.
")]
    [Cmdlet(VerbsCommon.Set, "LocationParent5", SupportsShouldProcess = true)]
    [Alias("......")]
    [OutputType(typeof(PSObject))]
    public class SetLocationParent5Command : PSGenXdevCmdlet
    {
        /// <summary>
        /// Begin processing - initialization logic
        /// </summary>
        protected override void BeginProcessing()
        {
            // Write verbose message indicating start of navigation
            WriteVerbose("Starting directory navigation up 5 levels from: " +
                SessionState.Path.CurrentLocation.Path);
        }

        /// <summary>
        /// Process record - main cmdlet logic for navigating up directories
        /// </summary>
        protected override void ProcessRecord()
        {
            // Loop through five levels of navigation
            for (int i = 1; i <= 5; i++)
            {
                // Get the parent directory of current location
                var parentResult = InvokeCommand.InvokeScript(
                    "Microsoft.PowerShell.Management\\Split-Path -Path " +
                    "(Microsoft.PowerShell.Management\\Get-Location) -Parent");

                // Check if parent is null (at root level)
                if (parentResult.Count == 0 || parentResult[0] == null)
                {
                    // Write verbose message when cannot go up further
                    WriteVerbose("Cannot go up further - at root level");
                    break;
                }

                // Get the parent path as string
                string parentPath = parentResult[0].ToString();

                // Prepare target description for ShouldProcess
                string target = $"from '{SessionState.Path.CurrentLocation.Path}' to " +
                    $"'{parentPath}' (level {i} of 5)";

                // Only navigate if ShouldProcess returns true
                if (ShouldProcess(target, "Change location"))
                {
                    // Change to the parent directory
                    InvokeCommand.InvokeScript(
                        $"Microsoft.PowerShell.Management\\Set-Location -LiteralPath '{parentPath}'");
                }
                else
                {
                    // Exit the loop if user declined
                    break;
                }
            }

            // Check WhatIf preference
            bool whatIfPreference = (bool)(SessionState.PSVariable.GetValue("WhatIfPreference") ?? false);

            // Show contents of the new current directory if not in WhatIf mode and on FileSystem provider
            if (!whatIfPreference)
            {
                // Get current location to check provider
                var locationResult = InvokeCommand.InvokeScript("Microsoft.PowerShell.Management\\Get-Location");
                var providerName = ((PSObject)locationResult[0]).Properties["Provider"].Value;
                string providerNameString = ((PSObject)providerName).Properties["Name"].Value.ToString();

                if (providerNameString == "FileSystem")
                {
                    // Get child items and output them
                    var childItems = InvokeCommand.InvokeScript("Microsoft.PowerShell.Management\\Get-ChildItem");
                    WriteObject(childItems, true);
                }
            }
        }

        /// <summary>
        /// End processing - cleanup logic
        /// </summary>
        protected override void EndProcessing()
        {
            // Write verbose message indicating completion
            WriteVerbose("Completed navigation. New location: " +
                SessionState.Path.CurrentLocation.Path);
        }
    }
}