Merge pull request #158 from OfficeDev/dev

December 2016 master merge

Author: erwinvanhunen

CONTRIBUTING.md

@@ -42,7 +42,7 @@ c:\[YOUR REPO FOLDER]\PnP-PowerShell
 The reason for this is that the PnP-PowerShell library will have references to the release and debug builds of the PnP-Sites-Core library.
 
 A few notes:
-###Every new cmdlet should provide help and examples###
+###Every new cmdlet should provide help and examples
 As documentation is autogenerated by building the solution, make sure that you include both help and examples, alike
 
 ```csharp
@@ -55,17 +55,19 @@ As documentation is autogenerated by building the solution, make sure that you i
   {
   }
 ```
-###Most cmdlets will extend SPOWebCmdlet which provides a few helper objects for you to use, like SelectedWeb and ClientContext###
+###Most cmdlets will extend SPOWebCmdlet which provides a few helper objects for you to use, like SelectedWeb and ClientContext
 As most cmdlets are 'web sensitive' (e.g. you can specify a -Web parameter to point to a different subweb), make sure that you use the correct ClientContext. When a user specifies the -Web parameter
 in a cmdlet that extens SPOWebCmdlet, the cmdlet will switch it's internal context to that web, reusing credentials. It is important to use the right context, and the easiest way to do that is to use
 
 ```csharp
 var context = SelectedWeb.Context;
 ```
-###Cmdlets will have to work both on-premises and in the cloud###
+###Cmdlets will have to work both on-premises and in the cloud
 You can use preprocessor variables ("CLIENTSDKV15" and "CLIENTSDKV16") to build different cmdlets for the different targets. In cases where it is not possible to provide functionality for either the 
 cloud or on-premises, make sure to remove the full cmdlet from the compiled solution by having #IF(!CLIENTSDKV15) or #IF(CLIENTSDKV15) as the _first line of the cmdlet, before using statements. 
-Make the last line, after all code * The verb of a cmdlet (get-, add-, etc.) should follow acceptable cmdlet standards and should be part of one of the built in verbs classes (VerbsCommon, VerbsData, etc.):
+
+See the following example
+
 
 ```csharp
 #if !CLIENTSDKV15
@@ -80,6 +82,10 @@ public class MyCmdlet : SPOWebCmdlet
 
 If only parts of a cmdlet require different behaviour based upon the different version of the SDK, you are recommended to use the #CLIENTSDKV15 preprocessor variable throughout your code to exclude or include certain code.
 
+###Cmdlets will have to use common verbs
+ 
+The verb of a cmdlet (get-, add-, etc.) should follow acceptable cmdlet standards and should be part of one of the built in verbs classes (VerbsCommon, VerbsData, etc.):
+
 ##Documentation contributions
 If you want to contribute to cmdlet documentation, please do not make a pull request to modify the actual files in the Documentation folder itself. Those files
 are automatically generated based upon comments in the actual classes. So if you want to modify documentation and or add an example of a cmdlet, navigate to the

Chocolatey/OfficeDevPnPCmdlets15/OfficeDevPnPPowerShellCommands15.nuspec

@@ -354,22 +354,20 @@ static void Main(string[] args)
                         {
                             string mdFilePath = string.Format("{0}\\Documentation\\{1}{2}.md", solutionDir, cmdletInfo.Verb, cmdletInfo.Noun);
                             toc.Add(cmdletInfo);
-                            //var existingHashCode = string.Empty;
+
                             if (System.IO.File.Exists(mdFilePath))
                             {
                                 originalMd = System.IO.File.ReadAllText(mdFilePath);
-                              
-                            }
-                            var docHeaderBuilder = new StringBuilder();
 
+                            }
+                            var docBuilder = new StringBuilder();
+                            
+                            // Header
 
-                            // Separate header from body to calculate the hashcode later
-                            docHeaderBuilder.AppendFormat("#{0}{1}", cmdletInfo.FullCommand, Environment.NewLine);
-                            docHeaderBuilder.AppendFormat("*Topic automatically generated on: {0}*{1}", DateTime.Now.ToString("yyyy'-'MM'-'dd"), Environment.NewLine);
-                            docHeaderBuilder.Append(Environment.NewLine);
+                            docBuilder.AppendFormat("#{0}{1}", cmdletInfo.FullCommand, Environment.NewLine);
 
                             // Body 
-                            var docBuilder = new StringBuilder();
+                            
                             docBuilder.AppendFormat("{0}{1}", cmdletInfo.Description, Environment.NewLine);
                             docBuilder.AppendFormat("##Syntax{0}", Environment.NewLine);
                             foreach (var cmdletSyntax in cmdletInfo.Syntaxes.OrderBy(s => s.ParameterSetName))
@@ -433,12 +431,10 @@ static void Main(string[] args)
 
                             foreach (var result in diffResults)
                             {
-                                if (!result.text.Contains("*Topic automatically generated on"))
+                                if (result.operation != DiffMatchPatch.Operation.EQUAL)
                                 {
-                                    if (result.operation != DiffMatchPatch.Operation.EQUAL)
-                                    {
-                                        System.IO.File.WriteAllText(mdFilePath, docHeaderBuilder.Append(docBuilder).ToString());
-                                    }
+                                    System.IO.File.WriteAllText(mdFilePath, docBuilder.ToString());
+                                    break;
                                 }
                             }
                         }
@@ -489,12 +485,9 @@ static void Main(string[] args)
 
                 foreach (var result in diffResults)
                 {
-                    if (!result.text.Contains("*Topic automatically generated on"))
+                    if (result.operation != DiffMatchPatch.Operation.EQUAL)
                     {
-                        if (result.operation != DiffMatchPatch.Operation.EQUAL)
-                        {
-                            System.IO.File.WriteAllText(readmePath, docBuilder.ToString());
-                        }
+                        System.IO.File.WriteAllText(readmePath, docBuilder.ToString());
                     }
                 }
             }

Chocolatey/OfficeDevPnPCmdlets15/OfficeDevPnPPowershellCommands15.1.3.0.0.nupkg

@@ -85,6 +85,5 @@ protected override void ProcessRecord()
             }
         }
 
-
     }
 }

Chocolatey/OfficeDevPnPCmdlets15/tools/chocolateyInstall.ps1

@@ -1,4 +1,5 @@
 using Microsoft.SharePoint.Client;
+using OfficeDevPnP.Core.Diagnostics;
 using OfficeDevPnP.PowerShell.Commands.Enums;
 using System;
 using System.Collections.Generic;

Chocolatey/OfficeDevPnPCmdlets15/tools/chocolateyUninstall.ps1

@@ -0,0 +1,51 @@
+using System.Management.Automation;
+using Microsoft.SharePoint.Client;
+using OfficeDevPnP.PowerShell.CmdletHelpAttributes;
+using Newtonsoft.Json;
+using OfficeDevPnP.Core.Framework.Provisioning.Model;
+
+namespace OfficeDevPnP.PowerShell.Commands
+{
+    [Cmdlet(VerbsCommon.Get, "SPOTheme")]
+    [CmdletHelp("Returns the current theme/composed look of the current web.",
+        Category = CmdletHelpCategory.Branding)]
+    [CmdletExample(
+        Code = @"PS:> Get-SPOTheme",
+        Remarks = "Returns the current composed look of the current web.",
+        SortOrder = 1)]
+    [CmdletExample(
+        Code = @"PS:> Get-SPOTheme -DetectCurrentComposedLook",
+        Remarks = "Returns the current composed look of the current web, and will try to detect the currently applied composed look based upon the actual site. Without this switch the cmdlet will first check for the presence of a property bag variable called _PnP_ProvisioningTemplateComposedLookInfo that contains composed look information when applied through the provisioning engine or the Set-SPOTheme cmdlet.",
+        SortOrder = 2)]
+    public class GetTheme : SPOWebCmdlet
+    {
+        private const string PROPBAGKEY = "_PnP_ProvisioningTemplateComposedLookInfo";
+
+        [Parameter(Mandatory = false, HelpMessage = "Specify this switch to not use the PnP Provisioning engine based composed look information but try to detect the current composed look as is.")]
+        public SwitchParameter DetectCurrentComposedLook;
+
+        protected override void ExecuteCmdlet()
+        {
+            if (SelectedWeb.PropertyBagContainsKey("_PnP_ProvisioningTemplateComposedLookInfo") && !DetectCurrentComposedLook)
+            {
+                try
+                {
+                    WriteWarning("The information presented here is based upon the fact that the theme has been set using either the PnP Provisioning Engine or using the Set-SPOTheme cmdlet. This information is retrieved from a propertybag value and may differ from the actual site.");
+                    var composedLook = JsonConvert.DeserializeObject<ComposedLook>(SelectedWeb.GetPropertyBagValueString("_PnP_ProvisioningTemplateComposedLookInfo", ""));
+                    WriteObject(composedLook);
+                }
+                catch
+                {
+                    var themeEntity = SelectedWeb.GetCurrentComposedLook();
+                    WriteObject(themeEntity);
+                }
+
+            }
+            else
+            {
+                var themeEntity = SelectedWeb.GetCurrentComposedLook();
+                WriteObject(themeEntity);
+            }
+        }
+    }
+}

Chocolatey/OfficeDevPnPCmdlets16/OfficeDevPnPPowershellCommands16.1.3.0.0.nupkg

@@ -1,34 +1,64 @@
 using System.Management.Automation;
 using Microsoft.SharePoint.Client;
 using OfficeDevPnP.PowerShell.CmdletHelpAttributes;
+using System;
 
 namespace OfficeDevPnP.PowerShell.Commands
 {
     [Cmdlet(VerbsCommon.Set, "SPOMasterPage")]
     [CmdletHelp("Sets the default master page of the current web.",
         Category = CmdletHelpCategory.Branding)]
     [CmdletExample(
-        Code = @"
-    PS:> Set-SPOMasterPage -MasterPageServerRelativeUrl /sites/projects/_catalogs/masterpage/oslo.master
-", SortOrder = 1)]
+        Code = @"PS:> Set-SPOMasterPage -MasterPageServerRelativeUrl /sites/projects/_catalogs/masterpage/oslo.master",
+        Remarks = "Sets the master page based on a server relative URL", 
+        SortOrder = 1)]
+    [CmdletExample(
+        Code = @"PS:> Set-SPOMasterPage -MasterPageSiteRelativeUrl _catalogs/masterpage/oslo.master",
+        Remarks = "Sets the master page based on a site relative URL",
+        SortOrder = 2)]
     public class SetMasterPage : SPOWebCmdlet
     {
-        [Parameter(Mandatory = false)]
+        [Parameter(Mandatory = false, ParameterSetName = "SERVER")]
         [Alias("MasterPageUrl")]
         public string MasterPageServerRelativeUrl = null;
 
-        [Parameter(Mandatory = false)]
+        [Parameter(Mandatory = false, ParameterSetName = "SERVER")]
         [Alias("CustomMasterPageUrl")]
         public string CustomMasterPageServerRelativeUrl = null;
 
+        [Parameter(Mandatory = false, ParameterSetName = "SITE")]
+        public string MasterPageSiteRelativeUrl = null;
+
+        [Parameter(Mandatory = false, ParameterSetName = "SITE")]
+        public string CustomMasterPageSiteRelativeUrl = null;
+
         protected override void ExecuteCmdlet()
         {
-            if (!string.IsNullOrEmpty(MasterPageServerRelativeUrl))
-                SelectedWeb.SetMasterPageByUrl(MasterPageServerRelativeUrl);
+            if (ParameterSetName == "SERVER")
+            {
+                if (!string.IsNullOrEmpty(MasterPageServerRelativeUrl))
+                    SelectedWeb.SetMasterPageByUrl(MasterPageServerRelativeUrl);
 
-            if (!string.IsNullOrEmpty(CustomMasterPageServerRelativeUrl))
-                SelectedWeb.SetCustomMasterPageByUrl(CustomMasterPageServerRelativeUrl);
+                if (!string.IsNullOrEmpty(CustomMasterPageServerRelativeUrl))
+                    SelectedWeb.SetCustomMasterPageByUrl(CustomMasterPageServerRelativeUrl);
+            }
+            else
+            {
+                if (!string.IsNullOrEmpty(MasterPageSiteRelativeUrl))
+                {
+                    SelectedWeb.SetMasterPageByUrl(GetServerRelativeUrl(MasterPageSiteRelativeUrl));
+                }
+                if (!string.IsNullOrEmpty(CustomMasterPageSiteRelativeUrl))
+                {
+                    SelectedWeb.SetCustomMasterPageByUrl(GetServerRelativeUrl(CustomMasterPageSiteRelativeUrl));
+                }
+            }
+        }
 
+        private string GetServerRelativeUrl(string url)
+        {
+            var serverRelativeUrl = SelectedWeb.EnsureProperty(w => w.ServerRelativeUrl);
+            return UrlUtility.Combine(serverRelativeUrl, url);
         }
     }
 }

Chocolatey/OfficeDevPnPCmdlets16/officedevpnppowershellcommands16.nuspec

@@ -1,17 +1,21 @@
 using System.Management.Automation;
 using Microsoft.SharePoint.Client;
 using OfficeDevPnP.PowerShell.CmdletHelpAttributes;
+using Newtonsoft.Json;
+using OfficeDevPnP.Core.Framework.Provisioning.Model;
 
 namespace OfficeDevPnP.PowerShell.Commands
 {
     [Cmdlet(VerbsCommon.Set, "SPOTheme")]
-    [CmdletHelp("Sets the theme of the current web.", 
+    [CmdletHelp("Sets the theme of the current web.",
         Category = CmdletHelpCategory.Branding)]
     [CmdletExample(
         Code = @"PS:> Set-SPOTheme -ColorPaletteUrl /_catalogs/theme/15/company.spcolor",
         SortOrder = 1)]
     public class SetTheme : SPOWebCmdlet
     {
+        private const string PROPBAGKEY = "_PnP_ProvisioningTemplateComposedLookInfo";
+
         [Parameter(Mandatory = false)]
         public string ColorPaletteUrl = null;
 
@@ -26,8 +30,39 @@ public class SetTheme : SPOWebCmdlet
 
         protected override void ExecuteCmdlet()
         {
+
             SelectedWeb.ApplyTheme(ColorPaletteUrl, FontSchemeUrl, BackgroundImageUrl, ShareGenerated);
+
             ClientContext.ExecuteQueryRetry();
+
+            var composedLook = new ComposedLook();
+            // Set the corresponding property bag value which is used by the provisioning engine
+            if (SelectedWeb.PropertyBagContainsKey(PROPBAGKEY))
+            {
+                composedLook = JsonConvert.DeserializeObject<ComposedLook>(SelectedWeb.GetPropertyBagValueString(PROPBAGKEY, ""));
+
+            }
+            else
+            {
+                composedLook = new ComposedLook();
+                composedLook.BackgroundFile = "";
+                SelectedWeb.EnsureProperty(w => w.AlternateCssUrl);
+                composedLook.AlternateCSS = SelectedWeb.AlternateCssUrl;
+                composedLook.ColorFile = "";
+                SelectedWeb.EnsureProperty(w => w.MasterUrl);
+                composedLook.MasterPage = SelectedWeb.MasterUrl;
+                composedLook.FontFile = "";
+                SelectedWeb.EnsureProperty(w => w.SiteLogoUrl);
+                composedLook.SiteLogo = SelectedWeb.SiteLogoUrl;
+            }
+
+            composedLook.Name = composedLook.Name ?? "Custom by PnP PowerShell";
+            composedLook.ColorFile = ColorPaletteUrl ?? composedLook.ColorFile;
+            composedLook.FontFile = FontSchemeUrl ?? composedLook.FontFile;
+            composedLook.BackgroundFile = BackgroundImageUrl ?? composedLook.BackgroundFile;
+            var composedLookJson = JsonConvert.SerializeObject(composedLook);
+
+            SelectedWeb.SetPropertyBagValue(PROPBAGKEY, composedLookJson);
         }
     }
 }

Chocolatey/OfficeDevPnPCmdlets16/tools/chocolateyInstall.ps1

@@ -125,10 +125,6 @@
           <SpecificVersion>False</SpecificVersion>
           <HintPath>..\..\PnP-Sites-Core\Assemblies\16\Microsoft.SharePoint.Client.WorkflowServices.dll</HintPath>
         </Reference>
-        <Reference Include="Microsoft.Office.Client.Education, Version=16.0.0.0, Culture=neutral, PublicKeyToken=71e9bce111e9429c, processorArchitecture=MSIL">
-          <SpecificVersion>False</SpecificVersion>
-          <HintPath>..\ReferenceAssemblies\16\Microsoft.Office.Client.Education.dll</HintPath>
-        </Reference>
       </ItemGroup>
     </When>
     <Otherwise>
@@ -181,10 +177,6 @@
           <SpecificVersion>False</SpecificVersion>
           <HintPath>..\..\PnP-Sites-Core\Assemblies\15\Microsoft.SharePoint.Client.WorkflowServices.dll</HintPath>
         </Reference>
-        <Reference Include="Microsoft.Office.Client.Education, Version=15.0.0.0, Culture=neutral, PublicKeyToken=71e9bce111e9429c, processorArchitecture=MSIL">
-          <SpecificVersion>False</SpecificVersion>
-          <HintPath>..\ReferenceAssemblies\15\Microsoft.Office.Client.Education.dll</HintPath>
-        </Reference>
       </ItemGroup>
     </Otherwise>
   </Choose>
@@ -278,6 +270,7 @@
     <Compile Include="Branding\ApplyProvisioningTemplate.cs" />
     <Compile Include="Branding\GetProvisioningTemplate.cs" />
     <Compile Include="Branding\NewProvisioningTemplateFromFolder.cs" />
+    <Compile Include="Branding\GetTheme.cs" />
     <Compile Include="ContentTypes\RemoveContentTypeFromList.cs" />
     <Compile Include="ContentTypes\SetDefaultContentTypeToList.cs" />
     <Compile Include="ContentTypes\AddContentTypeToList.cs" />

Chocolatey/OfficeDevPnPCmdlets16/tools/chocolateyUninstall.ps1

@@ -39,5 +39,5 @@
 // You can specify all the values or you can default the Build and Revision Numbers 
 // by using the '*' as shown below:
 // [assembly: AssemblyVersion("1.0.*")]
-[assembly: AssemblyVersion("1.8.1115.0")]
-[assembly: AssemblyFileVersion("1.8.1115.0")]
+[assembly: AssemblyVersion("1.9.1215.0")]
+[assembly: AssemblyFileVersion("1.9.1215.0")]