Bugfixes and optimizations

pnp · Aug 1, 2023 · 930b9cd · 930b9cd
1 parent d00fb00
commit 930b9cd
Show file tree

Hide file tree

Showing 6 changed files with 68 additions and 12 deletions.
diff --git a/documentation/Get-PnPFolderFile.md b/documentation/Get-PnPFolderFile.md
@@ -88,6 +88,20 @@ Accept pipeline input: False
 Accept wildcard characters: False
 ```
 
+### -ExcludeSystemFolders
+When provided, all files in system folders will be excluded from the output. This parameter is not supported when not providing a folder through -Identity or -FolderSiteRelativeUrl.
+
+```yaml
+Type: SwitchParameter
+Parameter Sets: (All)
+
+Required: False
+Position: Named
+Default value: None
+Accept pipeline input: False
+Accept wildcard characters: False
+```
+
 ### -FolderSiteRelativeUrl
 The site relative URL of the folder to retrieve
 

diff --git a/documentation/Get-PnPFolderFolder.md b/documentation/Get-PnPFolderFolder.md
@@ -96,7 +96,7 @@ Accept wildcard characters: False
 ```
 
 ### -ExcludeSystemFolders
-When provided, all system folders will be excluded from the output
+When provided, all system folders will be excluded from the output. This parameter is not supported when not providing a folder through -Identity or -FolderSiteRelativeUrl.
 
 ```yaml
 Type: SwitchParameter

diff --git a/src/Commands/Files/GetFolder.cs b/src/Commands/Files/GetFolder.cs
@@ -32,7 +32,7 @@ protected override void ExecuteCmdlet()
                 case ParameterSet_FOLDERSINCURRENTWEB:
                 {
                     // Query for all folders in the root of the current web
-                    ClientContext.Load(CurrentWeb, w => w.Folders.Include(DefaultRetrievalExpressions));
+                    ClientContext.Load(CurrentWeb, w => w.Folders.IncludeWithDefaultProperties(RetrievalExpressions));
                     ClientContext.ExecuteQueryRetry();
 
                     WriteObject(CurrentWeb.Folders, true);

diff --git a/src/Commands/Files/GetFolderFile.cs b/src/Commands/Files/GetFolderFile.cs
@@ -1,6 +1,7 @@
 using System;
 using System.Collections.Generic;
 using System.Linq;
+using System.Linq.Expressions;
 using System.Management.Automation;
 using Microsoft.SharePoint.Client;
 using PnP.Framework.Utilities;
@@ -26,9 +27,12 @@ public class GetFolderFile : PnPWebRetrievalsCmdlet<File>
         [Parameter(Mandatory = false)]
         public string ItemName = string.Empty;
 
-        [Parameter(Mandatory = false, Position = 4)]
+        [Parameter(Mandatory = false)]
         public SwitchParameter Recursive;
 
+        [Parameter(Mandatory = false)]
+        public SwitchParameter ExcludeSystemFolders;          
+
         protected override void ExecuteCmdlet()
         {
             CurrentWeb.EnsureProperty(w => w.ServerRelativeUrl);
@@ -58,7 +62,19 @@ private IEnumerable<File> GetContents(string FolderSiteRelativeUrl)
                     serverRelativeUrl = UrlUtility.Combine(CurrentWeb.ServerRelativeUrl, FolderSiteRelativeUrl);
                 }
 
-                targetFolder = (string.IsNullOrEmpty(FolderSiteRelativeUrl)) ? CurrentWeb.RootFolder : CurrentWeb.GetFolderByServerRelativePath(ResourcePath.FromDecodedUrl(serverRelativeUrl));
+                if(string.IsNullOrEmpty(FolderSiteRelativeUrl))
+                {
+                    if(ParameterSpecified(nameof(ExcludeSystemFolders)))
+                    {
+                        WriteWarning($"The {nameof(ExcludeSystemFolders)} parameter is only supported when retrieving a specific folder. It will be ignored.");
+                        ExcludeSystemFolders = false;
+                    }
+                    targetFolder = CurrentWeb.EnsureProperty(w => w.RootFolder);
+                }
+                else
+                {
+                    targetFolder = CurrentWeb.GetFolderByServerRelativePath(ResourcePath.FromDecodedUrl(serverRelativeUrl));
+                }
             }
 
             IEnumerable<File> files = null;
@@ -68,7 +84,14 @@ private IEnumerable<File> GetContents(string FolderSiteRelativeUrl)
 
             if (Recursive)
             {
-                folders = ClientContext.LoadQuery(targetFolder.Folders).OrderBy(f => f.Name);
+                if(ExcludeSystemFolders.ToBool())
+                {
+                    folders = ClientContext.LoadQuery(targetFolder.Folders.IncludeWithDefaultProperties(f => f.ListItemAllFields)).Where(f => !ExcludeSystemFolders.ToBool() || !f.ListItemAllFields.ServerObjectIsNull.GetValueOrDefault(false)).OrderBy(f => f.Name);
+                }
+                else
+                {
+                    folders = ClientContext.LoadQuery(targetFolder.Folders).OrderBy(f => f.Name);
+                }                
             }
             ClientContext.ExecuteQueryRetry();
 

diff --git a/src/Commands/Files/GetFolderFolder.cs b/src/Commands/Files/GetFolderFolder.cs
@@ -26,7 +26,7 @@ public class GetFolderFolder : PnPWebRetrievalsCmdlet<Folder>
         [Parameter(Mandatory = false)]
         public string ItemName = string.Empty;
 
-        [Parameter(Mandatory = false, Position = 4)]
+        [Parameter(Mandatory = false)]
         public SwitchParameter Recursive;
 
         [Parameter(Mandatory = false)]
@@ -35,7 +35,7 @@ public class GetFolderFolder : PnPWebRetrievalsCmdlet<Folder>
         protected override void ExecuteCmdlet()
         {
             CurrentWeb.EnsureProperty(w => w.ServerRelativeUrl);
-            
+
             if(ExcludeSystemFolders.ToBool())
             {
                 DefaultRetrievalExpressions = new Expression<Func<Folder, object>>[] { f => f.ListItemAllFields };
@@ -64,14 +64,33 @@ private IEnumerable<Folder> GetContents(string FolderSiteRelativeUrl)
                 string serverRelativeUrl = null;
                 if (!string.IsNullOrEmpty(FolderSiteRelativeUrl))
                 {
-                    var webUrl = CurrentWeb.EnsureProperty(w => w.ServerRelativeUrl);
-                    serverRelativeUrl = UrlUtility.Combine(webUrl, FolderSiteRelativeUrl);
+                    serverRelativeUrl = UrlUtility.Combine(CurrentWeb.EnsureProperty(w => w.ServerRelativeUrl), FolderSiteRelativeUrl);
                 }
 
-                targetFolder = (string.IsNullOrEmpty(FolderSiteRelativeUrl)) ? CurrentWeb.RootFolder : CurrentWeb.GetFolderByServerRelativePath(ResourcePath.FromDecodedUrl(serverRelativeUrl));
+                if(string.IsNullOrEmpty(FolderSiteRelativeUrl))
+                {
+                    if(ParameterSpecified(nameof(ExcludeSystemFolders)))
+                    {
+                        WriteWarning($"The {nameof(ExcludeSystemFolders)} parameter is only supported when retrieving a specific folder. It will be ignored.");
+                        ExcludeSystemFolders = false;
+                    }
+                    targetFolder = CurrentWeb.EnsureProperty(w => w.RootFolder);
+                }
+                else
+                {
+                    targetFolder = CurrentWeb.GetFolderByServerRelativePath(ResourcePath.FromDecodedUrl(serverRelativeUrl));
+                }
             }
 
-            IEnumerable<Folder> folders = ClientContext.LoadQuery(targetFolder.Folders.IncludeWithDefaultProperties(RetrievalExpressions)).Where(f => !ExcludeSystemFolders.ToBool() || !f.ListItemAllFields.ServerObjectIsNull.GetValueOrDefault(false)).OrderBy(f => f.Name);
+            IEnumerable<Folder> folders = null;
+            if(ExcludeSystemFolders.ToBool())
+            {
+                folders = ClientContext.LoadQuery(targetFolder.Folders.IncludeWithDefaultProperties(f => f.ListItemAllFields)).Where(f => !ExcludeSystemFolders.ToBool() || !f.ListItemAllFields.ServerObjectIsNull.GetValueOrDefault(false)).OrderBy(f => f.Name);
+            }
+            else
+            {
+                folders = ClientContext.LoadQuery(targetFolder.Folders).OrderBy(f => f.Name);
+            }
             ClientContext.ExecuteQueryRetry();        
 
             IEnumerable<Folder> folderContent = folders;

diff --git a/src/Commands/Files/GetFolderItem.cs b/src/Commands/Files/GetFolderItem.cs
@@ -30,7 +30,7 @@ public class GetFolderItem : PnPWebCmdlet
         [Parameter(Mandatory = false)]
         public string ItemName = string.Empty;
 
-        [Parameter(Mandatory = false, Position = 4)]
+        [Parameter(Mandatory = false)]
         public SwitchParameter Recursive;
 
         protected override void ExecuteCmdlet()