Refactor File cmdlets to use Connection.PnPContext instead of PnPCont…

…ext (#4389) Co-authored-by: Gautam Sheth <[email protected]>
pnp · Oct 5, 2024 · 29531d7 · 29531d7
1 parent 32677fd
commit 29531d7
Show file tree

Hide file tree

Showing 33 changed files with 68 additions and 71 deletions.
diff --git a/src/Commands/Apps/RemoveApplicationCustomizer.cs b/src/Commands/Apps/RemoveApplicationCustomizer.cs
@@ -31,9 +31,10 @@ public class RemoveApplicationCustomizer : PnPWebCmdlet
         protected override void ExecuteCmdlet()
         {
             var actions = new List<IUserCustomAction>();
+            var pnpContext = Connection.PnPContext;
             if (Identity != null)
             {
-                var rawActions = Identity.GetCustomActions(PnPContext, Scope);
+                var rawActions = Identity.GetCustomActions(pnpContext, Scope);
 
                 // Only take the customactions which are application customizers
                 actions = rawActions.Where(a => a.Location == "ClientSideExtension.ApplicationCustomizer").ToList();
@@ -42,11 +43,11 @@ protected override void ExecuteCmdlet()
             {
                 if (Scope == CustomActionScope.Web || Scope == CustomActionScope.All)
                 {
-                    actions.AddRange(PnPContext.Web.UserCustomActions.ToList());
+                    actions.AddRange(pnpContext.Web.UserCustomActions.ToList());
                 }
                 if (Scope == CustomActionScope.Site || Scope == CustomActionScope.All)
                 {
-                    actions.AddRange(PnPContext.Site.UserCustomActions.ToList());
+                    actions.AddRange(pnpContext.Site.UserCustomActions.ToList());
                 }                
             }
 

diff --git a/src/Commands/Apps/SetApplicationCustomizer.cs b/src/Commands/Apps/SetApplicationCustomizer.cs
@@ -41,9 +41,10 @@ public class SetApplicationCustomizer : PnPWebCmdlet
         protected override void ExecuteCmdlet()
         {
             IEnumerable<IUserCustomAction> actions = null;
+            var pnpContext = Connection.PnPContext;
             if (Identity != null)
             {
-                actions = Identity.GetCustomActions(PnPContext, Scope);
+                actions = Identity.GetCustomActions(pnpContext, Scope);
             }
 
             else
@@ -52,11 +53,11 @@ protected override void ExecuteCmdlet()
 
                 if (Scope == CustomActionScope.Web || Scope == CustomActionScope.All)
                 {
-                    customActions.AddRange(PnPContext.Web.UserCustomActions.ToList());
+                    customActions.AddRange(pnpContext.Web.UserCustomActions.ToList());
                 }
                 if (Scope == CustomActionScope.Site || Scope == CustomActionScope.All)
                 {
-                    customActions.AddRange(PnPContext.Site.UserCustomActions.ToList());
+                    customActions.AddRange(pnpContext.Site.UserCustomActions.ToList());
                 }
 
                 actions = customActions.AsEnumerable();

diff --git a/src/Commands/Base/NewBatch.cs b/src/Commands/Base/NewBatch.cs
@@ -11,7 +11,7 @@ public class NewBatch : PnPWebCmdlet
         public SwitchParameter RetainRequests;
         protected override void ExecuteCmdlet()
         {
-            var batch = new PnPBatch(PnPContext, RetainRequests);
+            var batch = new PnPBatch(Connection.PnPContext, RetainRequests);
             WriteObject(batch);
         }
     }

diff --git a/src/Commands/Branding/RemoveCustomAction.cs b/src/Commands/Branding/RemoveCustomAction.cs
@@ -21,7 +21,7 @@ public class RemoveCustomAction : PnPWebCmdlet
 
         protected override void ExecuteCmdlet()
         {
-            var customActions = Identity.GetCustomActions(PnPContext, Scope);
+            var customActions = Identity.GetCustomActions(Connection.PnPContext, Scope);
             if (customActions != null && customActions.Any())
             {
                 foreach (var customAction in customActions)

diff --git a/src/Commands/Branding/RemoveJavaScriptLink.cs b/src/Commands/Branding/RemoveJavaScriptLink.cs
@@ -24,7 +24,7 @@ public class RemoveJavaScriptLink : PnPWebCmdlet
 
         protected override void ExecuteCmdlet()
         {
-            var rawActions = Identity.GetCustomActions(PnPContext, Scope);
+            var rawActions = Identity.GetCustomActions(Connection.PnPContext, Scope);
 
             var actions = rawActions.Where(ca => ca.Location == "ScriptLink");
 

diff --git a/src/Commands/Fields/RemoveField.cs b/src/Commands/Fields/RemoveField.cs
@@ -41,7 +41,7 @@ private void RemoveFieldBatch()
         {
             if (List != null)
             {
-                var list = List.GetList(PnPContext);
+                var list = List.GetList(Connection.PnPContext);
                 list.EnsureProperties(l => l.Fields);
                 var fieldCollection = list.Fields.AsRequested();
                 var f = Identity.Field;

diff --git a/src/Commands/InformationManagement/GetLabel.cs b/src/Commands/InformationManagement/GetLabel.cs
@@ -19,13 +19,12 @@ protected override void ExecuteCmdlet()
         {
             if (!ParameterSpecified(nameof(List)))
             {
-
-                var tags = PnPContext.Site.GetAvailableComplianceTags();
+                var tags = Connection.PnPContext.Site.GetAvailableComplianceTags();
                 WriteObject(tags, true);
             }
             else
             {
-                var list = List.GetList(PnPContext);
+                var list = List.GetList(Connection.PnPContext);
                 if (null != list)
                 {
                     var tag = list.GetComplianceTag();

diff --git a/src/Commands/InformationManagement/ResetRetentionLabel.cs b/src/Commands/InformationManagement/ResetRetentionLabel.cs
@@ -46,15 +46,16 @@ protected override void ExecuteCmdlet()
                 }
             }
 
-            var list = List.GetList(PnPContext);
+            var pnpContext = Connection.PnPContext;
+            var list = List.GetList(pnpContext);
             if (list != null)
             {
                 if (ParameterSetName == ParamSet_BulkItems) 
                 {
-                    PnPContext.Web.LoadAsync(i => i.Url);
+                    pnpContext.Web.LoadAsync(i => i.Url);
                     list.LoadAsync(i => i.RootFolder);
 
-                    var rootUrl = PnPContext.Web.Url.GetLeftPart(UriPartial.Authority);
+                    var rootUrl = pnpContext.Web.Url.GetLeftPart(UriPartial.Authority);
 
                     var rangeIndex = 0;
 

diff --git a/src/Commands/InformationManagement/SetRetentionLabel.cs b/src/Commands/InformationManagement/SetRetentionLabel.cs
@@ -49,10 +49,10 @@ protected override void ExecuteCmdlet()
                     return;
                 }
             }
-
 
-            var list = List.GetList(PnPContext);
-            var availableTags = PnPContext.Site.GetAvailableComplianceTags();
+            var pnpContext = Connection.PnPContext;
+            var list = List.GetList(pnpContext);
+            var availableTags = pnpContext.Site.GetAvailableComplianceTags();
 
             if (list != null)
             {
@@ -61,10 +61,10 @@ protected override void ExecuteCmdlet()
                 {
                     if (ParameterSetName == ParamSet_BulkItems) 
                     {
-                        PnPContext.Web.LoadAsync(i => i.Url);
+                        pnpContext.Web.LoadAsync(i => i.Url);
                         list.LoadAsync(i => i.RootFolder);                        
 
-                        var rootUrl = PnPContext.Web.Url.GetLeftPart(UriPartial.Authority);
+                        var rootUrl = pnpContext.Web.Url.GetLeftPart(UriPartial.Authority);
 
                         var rangeIndex = 0;
 

diff --git a/src/Commands/Lists/AddListItemAttachment.cs b/src/Commands/Lists/AddListItemAttachment.cs
@@ -48,7 +48,7 @@ public class AddListItemAttachment : PnPWebCmdlet
 
         protected override void ExecuteCmdlet()
         {
-            IList list = List.GetList(PnPContext);
+            IList list = List.GetList(Connection.PnPContext);
 
             if (list == null)
             {

diff --git a/src/Commands/Lists/AddListItemComment.cs b/src/Commands/Lists/AddListItemComment.cs
@@ -19,7 +19,7 @@ public class AddListItemComment : PnPWebCmdlet
 
         protected override void ExecuteCmdlet()
         {
-            var list = List.GetList(PnPContext);
+            var list = List.GetList(Connection.PnPContext);
 
             if (list == null)
             {

diff --git a/src/Commands/Lists/GetListItemAttachment.cs b/src/Commands/Lists/GetListItemAttachment.cs
@@ -25,7 +25,7 @@ public class GetListItemAttachment : PnPWebCmdlet
 
         protected override void ExecuteCmdlet()
         {
-            IList list = List.GetList(PnPContext);
+            IList list = List.GetList(Connection.PnPContext);
 
             if (list == null)
             {

diff --git a/src/Commands/Lists/GetListItemComment.cs b/src/Commands/Lists/GetListItemComment.cs
@@ -18,7 +18,7 @@ public class GetListItemComments : PnPWebCmdlet
 
         protected override void ExecuteCmdlet()
         {
-            var list = List.GetList(PnPContext);
+            var list = List.GetList(Connection.PnPContext);
 
             if (list == null)
             {

diff --git a/src/Commands/Lists/GetListItemVersion.cs b/src/Commands/Lists/GetListItemVersion.cs
@@ -19,7 +19,7 @@ public class GetListItemVersion : PnPWebCmdlet
 
         protected override void ExecuteCmdlet()
         {
-            var list = List.GetList(PnPContext);
+            var list = List.GetList(Connection.PnPContext);
 
             if (list is null)
             {

diff --git a/src/Commands/Lists/GetListPermissions.cs b/src/Commands/Lists/GetListPermissions.cs
@@ -1,5 +1,4 @@
 using System.Management.Automation;
-using Microsoft.SharePoint.Client;
 
 using PnP.Core.Model.Security;
 using PnP.PowerShell.Commands.Base.PipeBinds;
@@ -18,7 +17,7 @@ public class GetListPermissions : PnPWebCmdlet
 
         protected override void ExecuteCmdlet()
         {
-            var list = Identity.GetListOrThrow(nameof(List), PnPContext);
+            var list = Identity.GetListOrThrow(nameof(Core.Model.SharePoint.IList), PnPContext);
             WriteObject(list.GetRoleDefinitions(PrincipalId).RequestedItems, true);
         }
     }

diff --git a/src/Commands/Lists/MoveListItemToRecycleBin.cs b/src/Commands/Lists/MoveListItemToRecycleBin.cs
@@ -1,7 +1,4 @@
 using System.Management.Automation;
-
-using Microsoft.SharePoint.Client;
-
 using PnP.PowerShell.Commands.Base.PipeBinds;
 using PnP.PowerShell.Commands.Model.SharePoint;
 
@@ -22,7 +19,7 @@ public class MoveListItemToRecycleBin : PnPWebCmdlet
 
         protected override void ExecuteCmdlet()
         {
-            var list = List.GetList(CurrentWeb);
+            var list = List.GetList(Connection.PnPContext);
             if (list == null)
                 throw new PSArgumentException($"No list found with id, title or url '{List}'", "List");
             if (Identity != null)
@@ -31,8 +28,7 @@ protected override void ExecuteCmdlet()
                 if (Force || ShouldContinue(string.Format(Properties.Resources.MoveListItemWithId0ToRecycleBin, item.Id), Properties.Resources.Confirm))
                 {
                     var recycleBinResult = item.Recycle();
-                    ClientContext.ExecuteQueryRetry();
-                    WriteObject(new RecycleResult { RecycleBinItemId = recycleBinResult.Value });
+                    WriteObject(new RecycleResult { RecycleBinItemId = recycleBinResult });
                 }
             }
         }

diff --git a/src/Commands/Lists/RemoveListItemAttachment.cs b/src/Commands/Lists/RemoveListItemAttachment.cs
@@ -39,7 +39,7 @@ public class RemoveListItemAttachment : PnPWebCmdlet
 
         protected override void ExecuteCmdlet()
         {
-            IList list = List.GetList(PnPContext);
+            IList list = List.GetList(Connection.PnPContext);
 
             if (list == null)
             {

diff --git a/src/Commands/Lists/RemoveListItemComment.cs b/src/Commands/Lists/RemoveListItemComment.cs
@@ -33,7 +33,7 @@ public class RemoveListItemComment : PnPWebCmdlet
 
         protected override void ExecuteCmdlet()
         {
-            var list = List.GetList(PnPContext);
+            var list = List.GetList(Connection.PnPContext);
 
             if (list == null)
             {

diff --git a/src/Commands/Lists/RemoveListItemVersion.cs b/src/Commands/Lists/RemoveListItemVersion.cs
@@ -24,7 +24,7 @@ public class RemoveListItemVersion : PnPWebCmdlet
 
         protected override void ExecuteCmdlet()
         {
-            var list = List.GetList(PnPContext);
+            var list = List.GetList(Connection.PnPContext);
 
             if (list is null)
             {

diff --git a/src/Commands/Pages/DisablePageScheduling.cs b/src/Commands/Pages/DisablePageScheduling.cs
@@ -9,8 +9,8 @@ public class DisablePageScheduling : PnPWebCmdlet
     {
         protected override void ExecuteCmdlet()
         {
-            var pagesList = PagesUtility.GetModernPagesLibrary(PnPContext.Web);
-            Utilities.REST.RestHelper.Post(Connection.HttpClient, $"{PnPContext.Web.Url}/_api/sitepages/pagesinlib(guid'{pagesList.Id}')/setscheduling(false)", ClientContext, null, "application/json", "application/json;odata=nometadata");
+            var pagesList = PagesUtility.GetModernPagesLibrary(Connection.PnPContext.Web);
+            Utilities.REST.RestHelper.Post(Connection.HttpClient, $"{Connection.PnPContext.Web.Url}/_api/sitepages/pagesinlib(guid'{pagesList.Id}')/setscheduling(false)", ClientContext, null, "application/json", "application/json;odata=nometadata");
         }
     }
 }
diff --git a/src/Commands/Pages/EnablePageScheduling.cs b/src/Commands/Pages/EnablePageScheduling.cs
@@ -9,8 +9,8 @@ public class EnablePageScheduling : PnPWebCmdlet
     {
         protected override void ExecuteCmdlet()
         {
-            var pagesList = PagesUtility.GetModernPagesLibrary(PnPContext.Web);
-            Utilities.REST.RestHelper.Post(Connection.HttpClient, $"{PnPContext.Web.Url}/_api/sitepages/pagesinlib(guid'{pagesList.Id}')/setscheduling(true)", ClientContext, null, "application/json", "application/json;odata=nometadata");
+            var pagesList = PagesUtility.GetModernPagesLibrary(Connection.PnPContext.Web);
+            Utilities.REST.RestHelper.Post(Connection.HttpClient, $"{Connection.PnPContext.Web.Url}/_api/sitepages/pagesinlib(guid'{pagesList.Id}')/setscheduling(true)", ClientContext, null, "application/json", "application/json;odata=nometadata");
         }
     }
 }
diff --git a/src/Commands/Pages/GetPageSchedulingEnabled.cs b/src/Commands/Pages/GetPageSchedulingEnabled.cs
@@ -10,7 +10,7 @@ public class GetPageSchedulingEnabled : PnPWebCmdlet
     {
         protected override void ExecuteCmdlet()
         {
-            var pagesList = PagesUtility.GetModernPagesLibrary(PnPContext.Web);
+            var pagesList = PagesUtility.GetModernPagesLibrary(Connection.PnPContext.Web);
             var payload = new
             {
                 parameters = new
@@ -20,7 +20,7 @@ protected override void ExecuteCmdlet()
                 }
             };
 
-            var results = Utilities.REST.RestHelper.Post<JsonElement>(Connection.HttpClient, $"{PnPContext.Web.Url}/_api/web/lists(guid'{pagesList.Id}')/RenderListDataAsStream", ClientContext, payload, false);
+            var results = Utilities.REST.RestHelper.Post<JsonElement>(Connection.HttpClient, $"{Connection.PnPContext.Web.Url}/_api/web/lists(guid'{pagesList.Id}')/RenderListDataAsStream", ClientContext, payload, false);
 
             var frameworkClientInfo = results.GetProperty("SPFrameworkClientInfo");
             var pageContextJson = frameworkClientInfo.GetProperty("PageContextJson");

diff --git a/src/Commands/Principals/AddGroupMember.cs b/src/Commands/Principals/AddGroupMember.cs
@@ -44,8 +44,9 @@ protected override void ExecuteCmdlet()
             }
             else
             {
-                var group = Group.GetGroup(PnPContext);
-                var user = PnPContext.Web.EnsureUser(LoginName);
+                var pnpContext = Connection.PnPContext;
+                var group = Group.GetGroup(pnpContext);
+                var user = pnpContext.Web.EnsureUser(LoginName);
 
                 if (ParameterSetName == ParameterSet_BATCHED)
                 {

diff --git a/src/Commands/Principals/GetGroup.cs b/src/Commands/Principals/GetGroup.cs
@@ -29,7 +29,7 @@ protected override void ExecuteCmdlet()
                 // Get group by name using Core SDK because of
                 // case sensitivity difference between Core SDK and CSOM
                 // Loads group using CSOM to bypass a breaking change
-                var pnpGroup = Identity.GetGroup(PnPContext);
+                var pnpGroup = Identity.GetGroup(Connection.PnPContext);
 
                 if (pnpGroup != null)
                 {

diff --git a/src/Commands/Principals/GetGroupPermissions.cs b/src/Commands/Principals/GetGroupPermissions.cs
@@ -15,7 +15,7 @@ public class GetGroupPermissions : PnPWebCmdlet
 
         protected override void ExecuteCmdlet()
         {
-            var group = Identity.GetGroup(PnPContext);
+            var group = Identity.GetGroup(Connection.PnPContext);
 
             if (group == null)
                 throw new PSArgumentException("Site group not found", nameof(Identity));

diff --git a/src/Commands/Principals/RemoveGroup.cs b/src/Commands/Principals/RemoveGroup.cs
@@ -17,7 +17,7 @@ public class RemoveGroup : PnPWebCmdlet
 
         protected override void ExecuteCmdlet()
         {
-            var group = Identity.GetGroup(PnPContext);
+            var group = Identity.GetGroup(Connection.PnPContext);
 
             if (Force || ShouldContinue(string.Format(Properties.Resources.RemoveGroup0, group.Title), Properties.Resources.Confirm))
             {

diff --git a/src/Commands/Principals/RemoveGroupMember.cs b/src/Commands/Principals/RemoveGroupMember.cs
@@ -21,13 +21,13 @@ public class RemoveUserFromGroup : PnPWebCmdlet
 
         protected override void ExecuteCmdlet()
         {
-            var group = Group.GetGroup(PnPContext);
+            var group = Group.GetGroup(Connection.PnPContext);
 
             if (group != null)
             {
                 try
                 {
-                    var user = PnPContext.Web.EnsureUser(LoginName);
+                    var user = Connection.PnPContext.Web.EnsureUser(LoginName);
                     group.RemoveUser(user.Id);
                 }
                 catch (PnP.Core.SharePointRestServiceException ex)

diff --git a/src/Commands/Principals/SetGroupPermissions.cs b/src/Commands/Principals/SetGroupPermissions.cs
@@ -1,6 +1,4 @@
-using System.Linq;
-using System.Management.Automation;
-using Microsoft.SharePoint.Client;
+using System.Management.Automation;
 using PnP.PowerShell.Commands.Base.PipeBinds;
 
 namespace PnP.PowerShell.Commands.Principals
@@ -24,15 +22,16 @@ public class SetGroupPermissions : PnPWebCmdlet
 
         protected override void ExecuteCmdlet()
         {
-            var group = Identity.GetGroup(PnPContext);
+            var pnpContext = Connection.PnPContext;
+            var group = Identity.GetGroup(pnpContext);
 
             if (group == null)
                 throw new PSArgumentException("Site group not found", nameof(Identity));
 
             PnP.Core.Model.SharePoint.IList list = null;
             if (ParameterSpecified(nameof(List)))
             {
-                list = List.GetListOrThrow(nameof(List), PnPContext);
+                list = List.GetListOrThrow(nameof(List), pnpContext);
             }
             if (AddRole != null)
             {