Merge pull request #650 from SharePoint/dev

January 2017 Release

Author: erwinvanhunen

CmdletHelpGenerator/Program.cs

@@ -437,11 +437,13 @@ static void Main(string[] args)
                     foreach (var exampleAttr in examples.OrderBy(e => e.SortOrder))
                     {
                         var example = new XElement(command + "example");
-                        var title = string.Format("------------------EXAMPLE {0}---------------------", exampleCount);
+                        var title = $"------------------EXAMPLE {exampleCount}---------------------";
                         example.Add(new XElement(maml + "title", title));
                         example.Add(new XElement(maml + "introduction", new XElement(maml + "para", exampleAttr.Introduction)));
                         example.Add(new XElement(dev + "code", exampleAttr.Code));
-                        example.Add(new XElement(maml + "remarks", new XElement(maml + "para", exampleAttr.Remarks)));
+                        var remarksElement = new XElement(maml + "remarks", new XElement(maml + "para", exampleAttr.Remarks));
+                        remarksElement.Add(new XElement(maml + "para",""));
+                        example.Add(remarksElement);
                         example.Add(new XElement(command + "commandLines",
                             new XElement(command + "commandLine",
                                 new XElement(command + "commandText"))));

Commands/Admin/NewTenantSite.cs

@@ -1,25 +1,34 @@
-using System.Management.Automation;
+using System;
+using System.Management.Automation;
 using Microsoft.SharePoint.Client;
+using OfficeDevPnP.Core;
 using SharePointPnP.PowerShell.CmdletHelpAttributes;
 using SharePointPnP.PowerShell.Commands.Base;
 using OfficeDevPnP.Core.Entities;
+using Resources = SharePointPnP.PowerShell.Commands.Properties.Resources;
+
 
 namespace SharePointPnP.PowerShell.Commands
 {
     [Cmdlet(VerbsCommon.New, "PnPTenantSite")]
     [CmdletAlias("New-SPOTenantSite")]
-    [CmdletHelp("Creates a new site collection for the current tenant", 
+    [CmdletHelp("Creates a new site collection for the current tenant",
         DetailedDescription = @"The New-PnPTenantSite cmdlet creates a new site collection for the current company. However, creating a new SharePoint
-Online site collection fails if a deleted site with the same URL exists in the Recycle Bin. If you want to use this command for an on-premises farm, please refer to http://blogs.msdn.com/b/vesku/archive/2014/06/09/provisioning-site-collections-using-sp-app-model-in-on-premises-with-just-csom.aspx ", 
+Online site collection fails if a deleted site with the same URL exists in the Recycle Bin. If you want to use this command for an on-premises farm, please refer to http://blogs.msdn.com/b/vesku/archive/2014/06/09/provisioning-site-collections-using-sp-app-model-in-on-premises-with-just-csom.aspx ",
         Category = CmdletHelpCategory.TenantAdmin)]
     [CmdletExample(
-        Code = @"PS:> New-PnPTenantSite -Title Contoso -Url https://tenant.sharepoint.com/sites/contoso -Owner [email protected] -TimeZone 4",
-        Remarks = @"This will add a site collection with the title 'Contoso', the url 'https://tenant.sharepoint.com/sites/contoso', the timezone 'UTC+01:00' and the owner '[email protected]'", SortOrder = 1)]        
+        Code = @"PS:> New-PnPTenantSite -Title Contoso -Url https://tenant.sharepoint.com/sites/contoso -Owner [email protected] -TimeZone 4 -Template STS#0",
+        Remarks = @"This will add a site collection with the title 'Contoso', the url 'https://tenant.sharepoint.com/sites/contoso', the timezone 'UTC+01:00',the owner '[email protected]' and the template used will be STS#0, a TeamSite", 
+        SortOrder = 1)]
+    [CmdletExample(
+        Code = @"PS:> New-PnPTenantSite -Title Contoso -Url /sites/contososite -Owner [email protected] -TimeZone 4 -Template STS#0",
+        Remarks = @"This will add a site collection with the title 'Contoso', the url 'https://tenant.sharepoint.com/sites/contososite' of which the base part will be picked up from your current connection, the timezone 'UTC+01:00', the owner '[email protected]' and the template used will be STS#0, a TeamSite", 
+        SortOrder = 2)]
     [CmdletRelatedLink(
-        Text ="Locale IDs", 
+        Text = "Locale IDs",
         Url = "http://go.microsoft.com/fwlink/p/?LinkId=242911Id=242911")]
     [CmdletRelatedLink(
-        Text = "Resource Usage Limits on Sandboxed Solutions in SharePoint 2010", 
+        Text = "Resource Usage Limits on Sandboxed Solutions in SharePoint 2010",
         Url = "http://msdn.microsoft.com/en-us/library/gg615462.aspx.")]
     [CmdletRelatedLink(
         Text = "Creating on-premises site collections using CSOM",
@@ -66,26 +75,54 @@ public class NewTenantSite : SPOAdminCmdlet
         [Parameter(Mandatory = false)]
         public SwitchParameter Wait;
 
+        [Parameter(Mandatory = false, HelpMessage = "Do not ask for confirmation.")]
+        public SwitchParameter Force;
+
         protected override void ExecuteCmdlet()
         {
+            bool shouldContinue = true;
+            if (!Url.ToLower().StartsWith("https://") && !Url.ToLower().StartsWith("http://"))
+            {
+                Uri uri = BaseUri;
+                Url = $"{uri.ToString().TrimEnd('/')}/{Url.TrimStart('/')}";
+                shouldContinue = ShouldContinue(string.Format(Resources.CreateSiteWithUrl0, Url), Resources.Confirm);
+            }
+            if (Force || shouldContinue)
+            {
 #if ONPREMISES
-            var entity = new SiteEntity();
-            entity.Url = Url;
-            entity.Title = Title;
-            entity.SiteOwnerLogin = Owner;
-            entity.Template = Template;
-            entity.StorageMaximumLevel = StorageQuota;
-            entity.StorageWarningLevel = StorageQuotaWarningLevel;
-            entity.TimeZoneId = TimeZone;
-            entity.UserCodeMaximumLevel = ResourceQuota;
-            entity.UserCodeWarningLevel = ResourceQuotaWarningLevel;
-            entity.Lcid = Lcid;
-
-            Tenant.CreateSiteCollection(entity);
+                var entity = new SiteEntity();
+                entity.Url = Url;
+                entity.Title = Title;
+                entity.SiteOwnerLogin = Owner;
+                entity.Template = Template;
+                entity.StorageMaximumLevel = StorageQuota;
+                entity.StorageWarningLevel = StorageQuotaWarningLevel;
+                entity.TimeZoneId = TimeZone;
+                entity.UserCodeMaximumLevel = ResourceQuota;
+                entity.UserCodeWarningLevel = ResourceQuotaWarningLevel;
+                entity.Lcid = Lcid;
+
+                Tenant.CreateSiteCollection(entity);
 #else
-            Tenant.CreateSiteCollection(Url, Title, Owner, Template, (int)StorageQuota, (int)StorageQuotaWarningLevel, TimeZone, (int)ResourceQuota, (int)ResourceQuotaWarningLevel, Lcid, RemoveDeletedSite, Wait);
+                Func<TenantOperationMessage, bool> timeoutFunction = TimeoutFunction;
+
+
+                Tenant.CreateSiteCollection(Url, Title, Owner, Template, (int)StorageQuota,
+                    (int)StorageQuotaWarningLevel, TimeZone, (int)ResourceQuota, (int)ResourceQuotaWarningLevel, Lcid,
+                    RemoveDeletedSite, Wait, Wait == true ? timeoutFunction : null);
 #endif
+            }
         }
 
+#if !ONPREMISES
+        private bool TimeoutFunction(TenantOperationMessage message)
+        {
+            if (message == TenantOperationMessage.CreatingSiteCollection)
+            {
+                Host.UI.Write(".");
+            }
+            return Stopping;
+        }
+#endif
     }
 }

Commands/Admin/RemoveTenantSite.cs

@@ -5,28 +5,35 @@
 using SharePointPnP.PowerShell.Commands.Base;
 using Resources = SharePointPnP.PowerShell.Commands.Properties.Resources;
 using System;
+using OfficeDevPnP.Core;
 
 namespace SharePointPnP.PowerShell.Commands
 {
     [Cmdlet(VerbsCommon.Remove, "PnPTenantSite", ConfirmImpact = ConfirmImpact.High, SupportsShouldProcess = true)]
     [CmdletAlias("Remove-SPOTenantSite")]
     [CmdletHelp("Office365 only: Removes a site collection from the current tenant",
-        Category = CmdletHelpCategory.TenantAdmin)]
+         Category = CmdletHelpCategory.TenantAdmin)]
     [CmdletExample(
-      Code = @"PS:> Remove-PnPTenantSite -Url https://tenant.sharepoint.com/sites/contoso",
-      Remarks = @"This will remove the site collection with the url 'https://tenant.sharepoint.com/sites/contoso'  and put it in the recycle bin.", SortOrder = 1)]
+         Code = @"PS:> Remove-PnPTenantSite -Url https://tenant.sharepoint.com/sites/contoso",
+         Remarks =
+             @"This will remove the site collection with the url 'https://tenant.sharepoint.com/sites/contoso'  and put it in the recycle bin.",
+         SortOrder = 1)]
     [CmdletExample(
-      Code = @"PS:> Remove-PnPTenantSite -Url https://tenant.sharepoint.com/sites/contoso -Force -SkipRecycleBin",
-      Remarks = @"This will remove the site collection with the url 'https://tenant.sharepoint.com/sites/contoso' with force and it will skip the recycle bin.", SortOrder = 2)]
+         Code = @"PS:> Remove-PnPTenantSite -Url https://tenant.sharepoint.com/sites/contoso -Force -SkipRecycleBin",
+         Remarks =
+             @"This will remove the site collection with the url 'https://tenant.sharepoint.com/sites/contoso' with force and it will skip the recycle bin.",
+         SortOrder = 2)]
     [CmdletExample(
-      Code = @"PS:> Remove-PnPTenantSite -Url https://tenant.sharepoint.com/sites/contoso -FromRecycleBin",
-      Remarks = @"This will remove the site collection with the url 'https://tenant.sharepoint.com/sites/contoso' from the recycle bin.", SortOrder = 3)]
+         Code = @"PS:> Remove-PnPTenantSite -Url https://tenant.sharepoint.com/sites/contoso -FromRecycleBin",
+         Remarks =
+             @"This will remove the site collection with the url 'https://tenant.sharepoint.com/sites/contoso' from the recycle bin.",
+         SortOrder = 3)]
     public class RemoveSite : SPOAdminCmdlet
     {
         [Parameter(Mandatory = true, Position = 0, ValueFromPipeline = true, HelpMessage = "Specifies the full URL of the site collection that needs to be deleted")]
         public string Url;
 
-        [Parameter(Mandatory = false, HelpMessage = "Do not add to the trashcan when selected.")]
+        [Parameter(Mandatory = false, HelpMessage = "Do not add to the tenant scoped recycle bin when selected.")]
         [Alias("SkipTrash")]
         public SwitchParameter SkipRecycleBin;
 
@@ -35,27 +42,49 @@ public class RemoveSite : SPOAdminCmdlet
         public SwitchParameter Wait;
 
         [Parameter(Mandatory = false, HelpMessage = "If specified, will search for the site in the Recycle Bin and remove it from there.")]
+        [Obsolete("Use Clear-PnPTenantRecycleBinItem instead.")]
         public SwitchParameter FromRecycleBin;
-
-
-        [Parameter(Mandatory = false, HelpMessage = "Do not ask for confirmation.")]
-        public SwitchParameter Force;
+        
+        [Parameter(Mandatory = false, HelpMessage = "Do not ask for confirmation.")] public SwitchParameter Force;
 
         protected override void ExecuteCmdlet()
         {
+            if (!Url.ToLower().StartsWith("https://") && !Url.ToLower().StartsWith("http://"))
+            {
+                Uri uri = BaseUri;
+                Url = $"{uri.ToString().TrimEnd('/')}/{Url.TrimStart('/')}";
+            }
+
             if (Force || ShouldContinue(string.Format(Resources.RemoveSiteCollection0, Url), Resources.Confirm))
             {
+                Func<TenantOperationMessage, bool> timeoutFunction = TimeoutFunction;
+
+#pragma warning disable 618
                 if (!FromRecycleBin)
+#pragma warning restore 618
                 {
-                    Tenant.DeleteSiteCollection(Url, !SkipRecycleBin);
+                    
+                    Tenant.DeleteSiteCollection(Url, !MyInvocation.BoundParameters.ContainsKey("SkipRecycleBin"), timeoutFunction);
                 }
                 else
                 {
-                    Tenant.DeleteSiteCollectionFromRecycleBin(Url);
+                    Tenant.DeleteSiteCollectionFromRecycleBin(Url, true, timeoutFunction);
                 }
+
             }
         }
 
+        private bool TimeoutFunction(TenantOperationMessage message)
+        {
+            switch (message)
+            {
+                case TenantOperationMessage.DeletingSiteCollection:
+                case TenantOperationMessage.RemovingDeletedSiteCollectionFromRecycleBin:
+                    Host.UI.Write(".");
+                    break;
+            }
+            return Stopping;
+        }
     }
 }
 #endif

Commands/Admin/SetTenantSite.cs

@@ -6,6 +6,8 @@
 using SharePointPnP.PowerShell.CmdletHelpAttributes;
 using SharePointPnP.PowerShell.Commands.Base;
 using System.Collections.Generic;
+using System.Threading;
+using OfficeDevPnP.Core;
 using OfficeDevPnP.Core.Entities;
 
 namespace SharePointPnP.PowerShell.Commands
@@ -25,7 +27,7 @@ namespace SharePointPnP.PowerShell.Commands
       Remarks = @"This will set [email protected] as a site collection owner at 'https://contoso.sharepoint.com/sites/sales'.", SortOrder = 3)]   
     public class SetTenantSite : SPOAdminCmdlet
     {
-        [Parameter(Mandatory = false, HelpMessage = "Specifies the URL of the site", Position = 0, ValueFromPipeline = true)]
+        [Parameter(Mandatory = true, HelpMessage = "Specifies the URL of the site", Position = 0, ValueFromPipeline = true)]
         public string Url;
 
         [Parameter(Mandatory = false, HelpMessage = "Specifies the title of the site")]
@@ -52,9 +54,16 @@ public class SetTenantSite : SPOAdminCmdlet
         [Parameter(Mandatory = false, HelpMessage = "Specifies owners to add as site collection adminstrators. Can be both users and groups.")]
         public List<string> Owners;
 
+        [Parameter(Mandatory = false, HelpMessage = "Sets the lockstate of a site")]
+        public SiteLockState LockState;
+
+        [Parameter(Mandatory = false, HelpMessage = "Wait for the operation to complete")]
+        public SwitchParameter Wait;
         protected override void ExecuteCmdlet()
         {
-            Tenant.SetSiteProperties(Url, title: Title, sharingCapability: Sharing, storageMaximumLevel: StorageMaximumLevel, allowSelfServiceUpgrade: AllowSelfServiceUpgrade, userCodeMaximumLevel: UserCodeMaximumLevel, userCodeWarningLevel: UserCodeWarningLevel);
+            Func<TenantOperationMessage, bool> timeoutFunction = TimeoutFunction;
+
+            Tenant.SetSiteProperties(Url, title: Title, sharingCapability: Sharing, storageMaximumLevel: StorageMaximumLevel, allowSelfServiceUpgrade: AllowSelfServiceUpgrade, userCodeMaximumLevel: UserCodeMaximumLevel, userCodeWarningLevel: UserCodeWarningLevel, wait: Wait, timeoutFunction: Wait ? timeoutFunction : null );
 
             if (Owners != null && Owners.Count > 0)
             {
@@ -66,7 +75,21 @@ protected override void ExecuteCmdlet()
                 }
                 Tenant.AddAdministrators(admins, new Uri(Url));
             }
+            if (MyInvocation.BoundParameters.ContainsKey("LockState"))
+            {
+                Tenant.SetSiteLockState(Url, LockState, Wait, Wait ? timeoutFunction : null);
+            }
+        }
+
+        private bool TimeoutFunction(TenantOperationMessage message)
+        {
+            if (message == TenantOperationMessage.SettingSiteProperties ||message == TenantOperationMessage.SettingSiteLockState)
+            {
+                Host.UI.Write(".");
+            }
+            return Stopping;
         }
+
     }
 }
 #endif

Commands/Apps/ImportAppPackage.cs

@@ -47,7 +47,7 @@ protected override void ExecuteCmdlet()
             {
                 if (Force)
                 {
-                    ClientContext.Site.ActivateFeature(Constants.APPSIDELOADINGFEATUREID);
+                    ClientContext.Site.ActivateFeature(Constants.FeatureId_Site_AppSideLoading);
                 }
                 AppInstance instance;
 
@@ -81,7 +81,7 @@ protected override void ExecuteCmdlet()
 
                 if (Force)
                 {
-                    ClientContext.Site.DeactivateFeature(Constants.APPSIDELOADINGFEATUREID);
+                    ClientContext.Site.DeactivateFeature(Constants.FeatureId_Site_AppSideLoading);
                 }
                 WriteObject(instance);
             }

Commands/Base/PipeBinds/ImageRenditionPipeBind.cs

@@ -0,0 +1,56 @@
+using System;
+using System.Linq;
+using Microsoft.SharePoint.Client;
+using Microsoft.SharePoint.Client.Publishing;
+
+namespace SharePointPnP.PowerShell.Commands.Base.PipeBinds
+{
+    public sealed class ImageRenditionPipeBind
+    {
+        private ImageRendition _item;
+        private readonly int? _id;
+        private readonly string _name;
+        public ImageRenditionPipeBind()
+        {
+            _item = null;
+            _id = null;
+        }
+
+        public ImageRenditionPipeBind(ImageRendition item)
+        {
+            _item = item;
+        }
+
+        public ImageRenditionPipeBind(string idorname)
+        {
+            int id;
+
+            if (int.TryParse(idorname, out id))
+            {
+                _id = id;
+                _name = null;
+            }
+            else
+            {
+                _id = null;
+                _name = idorname;
+            }
+        }
+
+        public ImageRendition Item => _item;
+
+        public int? Id => _id;
+
+        internal ImageRendition GetImageRendition(Web web)
+        {
+            if (Item != null) return Item;
+            var items = web.GetPublishingImageRenditions();
+            if (_id.HasValue)
+            {
+                return items.FirstOrDefault(i => i.Id == _id);
+            }
+
+            return items.FirstOrDefault(i => i.Name == _name);
+        }
+    }
+}