DSCResources/MSFT_SPWeb/MSFT_SPWeb.psm1
|
$script:SPDscUtilModulePath = Join-Path -Path $PSScriptRoot -ChildPath '..\..\Modules\SharePointDsc.Util' Import-Module -Name $script:SPDscUtilModulePath function Get-TargetResource { [CmdletBinding()] [OutputType([System.Collections.Hashtable])] param ( [Parameter(Mandatory = $true)] [System.String] $Url, [Parameter()] [ValidateSet("Present", "Absent")] [System.String] $Ensure = "Present", [Parameter()] [System.String] $Description, [Parameter()] [System.String] $Name, [Parameter()] [System.UInt32] $Language, [Parameter()] [System.String] $Template, [Parameter()] [System.Boolean] $UniquePermissions, [Parameter()] [System.Boolean] $UseParentTopNav, [Parameter()] [System.Boolean] $AddToQuickLaunch, [Parameter()] [System.Boolean] $AddToTopNav, [Parameter()] [System.String] $RequestAccessEmail, [Parameter()] [System.Management.Automation.PSCredential] $InstallAccount ) Write-Verbose -Message "Getting SPWeb '$Url'" $result = Invoke-SPDscCommand -Credential $InstallAccount ` -Arguments $PSBoundParameters ` -ScriptBlock { $params = $args[0] $web = Get-SPWeb -Identity $params.Url -ErrorAction SilentlyContinue if ($web) { return @{ Url = $params.Url Ensure = "Present" Description = $web.Description Name = $web.Title Language = $web.Language Template = "$($web.WebTemplate)#$($web.WebTemplateId)" UniquePermissions = $web.HasUniquePerm UseParentTopNav = $web.Navigation.UseShared RequestAccessEmail = $web.RequestAccessEmail } } else { return @{ Url = $params.Url Ensure = "Absent" } } } return $result } function Set-TargetResource { [CmdletBinding()] param ( [Parameter(Mandatory = $true)] [System.String] $Url, [Parameter()] [ValidateSet("Present", "Absent")] [System.String] $Ensure = "Present", [Parameter()] [System.String] $Description, [Parameter()] [System.String] $Name, [Parameter()] [System.UInt32] $Language, [Parameter()] [System.String] $Template, [Parameter()] [System.Boolean] $UniquePermissions, [Parameter()] [System.Boolean] $UseParentTopNav, [Parameter()] [System.Boolean] $AddToQuickLaunch, [Parameter()] [System.Boolean] $AddToTopNav, [Parameter()] [System.String] $RequestAccessEmail, [Parameter()] [System.Management.Automation.PSCredential] $InstallAccount ) Write-Verbose -Message "Setting SPWeb '$Url'" $PSBoundParameters.Ensure = $Ensure Invoke-SPDscCommand -Credential $InstallAccount ` -Arguments $PSBoundParameters ` -ScriptBlock { $params = $args[0] if ($null -eq $params.InstallAccount) { $currentUserName = "$env:USERDOMAIN\$env:USERNAME" } else { $currentUserName = $params.InstallAccount.UserName } Write-Verbose "Grant user '$currentUserName' Access To Process Identity for '$($params.Url)'..." $site = New-Object -Type Microsoft.SharePoint.SPSite -ArgumentList $params.Url $site.WebApplication.GrantAccessToProcessIdentity($currentUserName) $web = Get-SPWeb -Identity $params.Url -ErrorAction SilentlyContinue if ($null -eq $web) { @("InstallAccount", "Ensure", "RequestAccessEmail") | ForEach-Object -Process { if ($params.ContainsKey($_) -eq $true) { $params.Remove($_) | Out-Null } } New-SPWeb @params | Out-Null } else { if ($params.Ensure -eq "Absent") { Remove-SPweb $params.Url -confirm:$false } else { $changedWeb = $false if (($params.ContainsKey("Name") -eq $true) ` -and $web.Title -ne $params.Name) { $web.Title = $params.Name $changedWeb = $true } if (($params.ContainsKey("Description") -eq $true) ` -and $web.Description -ne $params.Description) { $web.Description = $params.Description $changedWeb = $true } if (($params.ContainsKey("UseParentTopNav") -eq $true) ` -and $web.Navigation.UseShared -ne $params.UseParentTopNav) { $web.Navigation.UseShared = $params.UseParentTopNav $changedWeb = $true } if (($params.ContainsKey("UniquePermissions") -eq $true) ` -and $web.HasUniquePerm -ne $params.UniquePermissions) { $web.HasUniquePerm = $params.UniquePermissions $changedWeb = $true } if ($params.ContainsKey("RequestAccessEmail") -eq $true) { if ($web.RequestAccessEmail -ne $params.RequestAccessEmail -and $web.HasUniquePerm) { if ([Boolean]$params.RequestAccessEmail -as [System.Net.Mail.MailAddress]) { Write-Verbose "The Request Access Email $($params.RequestAccessEmail) is not a valid mail address." } # Workaround to allow empty addresses to disable the access request as RequestAccessEnabled is read only $web.RequestAccessEmail = $params.RequestAccessEmail $changedWeb = $true } else { Write-Verbose "The Request Access Email $($params.RequestAccessEmail) can only be set, if the web has unique permissions." } } if ($changedWeb) { $web.Update() } } } } } function Test-TargetResource { [CmdletBinding()] [OutputType([System.Boolean])] param ( [Parameter(Mandatory = $true)] [System.String] $Url, [Parameter()] [ValidateSet("Present", "Absent")] [System.String] $Ensure = "Present", [Parameter()] [System.String] $Description, [Parameter()] [System.String] $Name, [Parameter()] [System.UInt32] $Language, [Parameter()] [System.String] $Template, [Parameter()] [System.Boolean] $UniquePermissions, [Parameter()] [System.Boolean] $UseParentTopNav, [Parameter()] [System.Boolean] $AddToQuickLaunch, [Parameter()] [System.Boolean] $AddToTopNav, [Parameter()] [System.String] $RequestAccessEmail, [Parameter()] [System.Management.Automation.PSCredential] $InstallAccount ) Write-Verbose -Message "Testing SPWeb '$Url'" $PSBoundParameters.Ensure = $Ensure $CurrentValues = Get-TargetResource @PSBoundParameters Write-Verbose -Message "Current Values: $(Convert-SPDscHashtableToString -Hashtable $CurrentValues)" Write-Verbose -Message "Target Values: $(Convert-SPDscHashtableToString -Hashtable $PSBoundParameters)" $valuesToCheck = @("Url", "Name", "Description", "UniquePermissions", "UseParentTopNav", "Ensure") if ($CurrentValues.UniquePermissions) { $valuesToCheck = @("Url", "Name", "Description", "UniquePermissions", "UseParentTopNav", "RequestAccessEmail", "Ensure") } $result = Test-SPDscParameterState -CurrentValues $CurrentValues ` -Source $($MyInvocation.MyCommand.Source) ` -DesiredValues $PSBoundParameters ` -ValuesToCheck $valuesToCheck Write-Verbose -Message "Test-TargetResource returned $result" return $result } function Export-TargetResource { [CmdletBinding()] [OutputType([System.String])] param ( [Parameter()] [System.String] $URL, [Parameter()] [System.String[]] $DependsOn ) $VerbosePreference = "SilentlyContinue" $content = '' $ParentModuleBase = Get-Module "SharePointDsc" -ListAvailable | Select-Object -ExpandProperty Modulebase $module = Join-Path -Path $ParentModuleBase -ChildPath "\DSCResources\MSFT_SPWeb\MSFT_SPWeb.psm1" -Resolve $SPWebs = Get-SPWeb -Limit All -Site $URL $j = 1 $totalWebs = $SPWebs.Length foreach ($SPWeb in $SPWebs) { Write-Host " -> Scanning Web [$j/$totalWebs] {$($SPWeb.URL)}" try { $paramsWeb = Get-DSCFakeParameters -ModulePath $module $SPWebGuid = [System.Guid]::NewGuid().toString() $paramsWeb.Url = $SPWeb.URL $results = Get-TargetResource @paramsWeb $results.Description = $results.Description.Replace("`"", "'").Replace("`r`n", ' ` ') $PartialContent = " SPWeb $($SPWebGuid)`r`n" $PartialContent += " {`r`n" $results = Repair-Credentials -results $results if ($DependsOn) { $results.add("DependsOn", $DependsOn) } $currentBlock = Get-DSCBlock -Params $results -ModulePath $module $currentBlock = Convert-DSCStringParamToVariable -DSCBlock $currentBlock -ParameterName "PsDscRunAsCredential" $PartialContent += $currentBlock $PartialContent += " }`r`n" <# SPWeb Feature Section #> if (($Global:ExtractionModeValue -eq 3 -and $Quiet) -or $Global:ComponentsToExtract.Contains("SPFeature")) { $Properties = @{ Scope = "Web" Url = $SPWeb.URL DependsOn = "[SPWeb]$($SPWebGuid)" } $partialContent += Read-TargetResource -ResourceName 'SPFeature' ` -ExportParams $Properties } $j++ } catch { $_ $Global:ErrorLog += "[Web]" + $spweb.Url + "`r`n" $Global:ErrorLog += "$_`r`n`r`n" } $Content += $PartialContent } return $Content } Export-ModuleMember -Function *-TargetResource |