Enhance URL handling in file version commands to support relative URLs and improve decoding logic

Author: Gautam Sheth

src/Commands/Files/GetFileVersion.cs

@@ -1,12 +1,13 @@
 using Microsoft.SharePoint.Client;
 using PnP.Framework.Utilities;
+using System;
 using System.Management.Automation;
 using File = Microsoft.SharePoint.Client.File;
 
 namespace PnP.PowerShell.Commands.Files
 {
     [Cmdlet(VerbsCommon.Get, "PnPFileVersion", DefaultParameterSetName = "Return as file object")]
- 
+
     public class GetFileVersion : PnPWebCmdlet
     {
         [Parameter(Mandatory = true)]
@@ -19,6 +20,15 @@ protected override void ExecuteCmdlet()
         {
             var serverRelativeUrl = string.Empty;
 
+            if (Uri.IsWellFormedUriString(Url, UriKind.Absolute))
+            {
+                // We can't deal with absolute URLs
+                Url = UrlUtility.MakeRelativeUrl(Url);
+            }
+
+            // Remove URL decoding from the Url as that will not work. We will encode the + character specifically, because if that is part of the filename, it needs to stay and not be decoded.
+            Url = Utilities.UrlUtilities.UrlDecode(Url.Replace("+", "%2B"));
+
             var webUrl = CurrentWeb.EnsureProperty(w => w.ServerRelativeUrl);
 
             if (!Url.ToLower().StartsWith(webUrl.ToLower()))
@@ -33,7 +43,7 @@ protected override void ExecuteCmdlet()
             File file;
 
             file = CurrentWeb.GetFileByServerRelativePath(ResourcePath.FromDecodedUrl(serverRelativeUrl));
-                        
+
             if (UseVersionExpirationReport)
             {
                 ClientContext.Load(file, f => f.Exists, f => f.VersionExpirationReport.IncludeWithDefaultProperties(i => i.CreatedBy, i => i.SnapshotDate, i => i.ExpirationDate));

src/Commands/Files/RemoveFileVersion.cs

@@ -1,6 +1,7 @@
 using Microsoft.SharePoint.Client;
 using PnP.Framework.Utilities;
 using PnP.PowerShell.Commands.Base.PipeBinds;
+using System;
 using System.Management.Automation;
 using File = Microsoft.SharePoint.Client.File;
 using Resources = PnP.PowerShell.Commands.Properties.Resources;
@@ -28,12 +29,19 @@ public class RemoveFileVersion : PnPWebCmdlet
         [Parameter(Mandatory = false, ParameterSetName = ParameterAttribute.AllParameterSets)]
         public SwitchParameter Force;
 
-
-
         protected override void ExecuteCmdlet()
         {
             var serverRelativeUrl = string.Empty;
 
+            if (Uri.IsWellFormedUriString(Url, UriKind.Absolute))
+            {
+                // We can't deal with absolute URLs
+                Url = UrlUtility.MakeRelativeUrl(Url);
+            }
+
+            // Remove URL decoding from the Url as that will not work. We will encode the + character specifically, because if that is part of the filename, it needs to stay and not be decoded.
+            Url = Utilities.UrlUtilities.UrlDecode(Url.Replace("+", "%2B"));
+
             var webUrl = CurrentWeb.EnsureProperty(w => w.ServerRelativeUrl);
 
             if (!Url.ToLower().StartsWith(webUrl.ToLower()))
@@ -80,7 +88,7 @@ protected override void ExecuteCmdlet()
                                     else
                                     {
                                         versions.DeleteByLabel(Identity.Label);
-                                    }                                    
+                                    }
                                     ClientContext.ExecuteQueryRetry();
                                 }
                                 else if (Identity.Id != -1)
@@ -92,7 +100,7 @@ protected override void ExecuteCmdlet()
                                     else
                                     {
                                         versions.DeleteByID(Identity.Id);
-                                    }                                    
+                                    }
                                     ClientContext.ExecuteQueryRetry();
                                 }
                             }

src/Commands/Files/RestoreFileVersion.cs

@@ -1,9 +1,10 @@
 using Microsoft.SharePoint.Client;
 using PnP.Framework.Utilities;
 using PnP.PowerShell.Commands.Base.PipeBinds;
-using Resources = PnP.PowerShell.Commands.Properties.Resources;
+using System;
 using System.Management.Automation;
 using File = Microsoft.SharePoint.Client.File;
+using Resources = PnP.PowerShell.Commands.Properties.Resources;
 
 namespace PnP.PowerShell.Commands.Files
 {
@@ -23,6 +24,15 @@ protected override void ExecuteCmdlet()
         {
             var serverRelativeUrl = string.Empty;
 
+            if (Uri.IsWellFormedUriString(Url, UriKind.Absolute))
+            {
+                // We can't deal with absolute URLs
+                Url = UrlUtility.MakeRelativeUrl(Url);
+            }
+
+            // Remove URL decoding from the Url as that will not work. We will encode the + character specifically, because if that is part of the filename, it needs to stay and not be decoded.
+            Url = Utilities.UrlUtilities.UrlDecode(Url.Replace("+", "%2B"));
+
             var webUrl = CurrentWeb.EnsureProperty(w => w.ServerRelativeUrl);
 
             if (!Url.ToLower().StartsWith(webUrl.ToLower()))
@@ -62,7 +72,7 @@ protected override void ExecuteCmdlet()
                         catch (ServerException e) when (e.ServerErrorTypeName.Equals("System.IO.DirectoryNotFoundException"))
                         {
                             throw new PSArgumentException($"Version with label '{Identity.Label}' does not exist", e);
-                        }                        
+                        }
                     }
                     else if (Identity.Id != -1)
                     {
@@ -72,7 +82,7 @@ protected override void ExecuteCmdlet()
                         ClientContext.Load(version);
                         ClientContext.ExecuteQueryRetry();
 
-                        if(version == null || !version.IsPropertyAvailable("VersionLabel"))
+                        if (version == null || !version.IsPropertyAvailable("VersionLabel"))
                         {
                             throw new PSArgumentException($"Version with id '{Identity.Id}' does not exist", nameof(Identity));
                         }