oneplaceSolutionsSite-Config-v3-SPO-modern.ps1

<#  
    .NOTES 
        Created by: Ashley Gregory
    .LINK (original)
        https://github.com/OnePlaceSolutions/OnePlaceLiveSitePnP
       
    This script optionally creates a new Site collection ('Team Site (Modern)' by default, 'Team Site (Classic)' by option), and applies the configuration changes / PnP template for the OnePlace Solutions Administration Site.
    All major actions are logged to 'OPSScriptLog.txt' in the user's or Administrators Documents folder, and it is uploaded to the Administration Site at the end of provisioning.
#>
$ErrorActionPreference = 'Stop'
$script:logFile = "OPSScriptLog$(Get-Date -Format "MMddyyyy").txt"
$script:logPath = "$env:userprofile\Documents\$script:logFile"

#URL suffix of the Site Collection to create (if we create one)
$script:solutionsSite = 'oneplacesolutions'

#Keep track of whether PnP.PowerShell is installed
$script:PnPPowerShell = $null

function Write-Log { 
    <#
    .NOTES 
        Created by: Jason Wasser @wasserja 
        Modified by: Ashley Gregory
    .LINK (original)
        https://gallery.technet.microsoft.com/scriptcenter/Write-Log-PowerShell-999c32d0 
    #>
    [CmdletBinding()] 
    Param ( 
        [Parameter(Mandatory = $true, 
            ValueFromPipelineByPropertyName = $true)] 
        [ValidateNotNullOrEmpty()] 
        [Alias("LogContent")] 
        [string]$Message, 
 
        [Parameter(Mandatory = $false)] 
        [Alias('LogPath')] 
        [string]$Path = $script:logPath, 
         
        [Parameter(Mandatory = $false)] 
        [ValidateSet("Error", "Warn", "Info")] 
        [string]$Level = "Info", 
        
        [Parameter(Mandatory = $false)] 
        [switch]$Output = $false,

        [Parameter(Mandatory = $false)] 
        [switch]$NoClobber 
    ) 
 
    Begin {
        $VerbosePreference = 'SilentlyContinue' 
        $ErrorActionPreference = 'Continue'
    } 
    Process {
        # If the file already exists and NoClobber was specified, do not write to the log. 
        If ((Test-Path $Path) -AND $NoClobber) { 
            Write-Error "Log file $Path already exists, and you specified NoClobber. Either delete the file or specify a different name." 
            Return 
        } 
 
        # If attempting to write to a log file in a folder/path that doesn't exist create the file including the path. 
        ElseIf (!(Test-Path $Path)) { 
            Write-Verbose "Creating $Path." 
            $NewLogFile = New-Item $Path -Force -ItemType File 
        } 
 
        Else { 
            # Nothing to see here yet. 
        } 
 
        # Format Date for our Log File 
        $FormattedDate = Get-Date -Format "yyyy-MM-dd HH:mm:ss K" 
 
        # Write message to error, warning, or verbose pipeline and specify $LevelText 
        Switch ($Level) { 
            'Error' { 
                Write-Error $Message 
                $LevelText = 'ERROR:' 
            } 
            'Warn' { 
                Write-Warning $Message 
                $LevelText = 'WARNING:' 
            } 
            'Info' { 
                If( $Output ) {
                    Write-Verbose $Message
                    Write-Host $Message -ForegroundColor Yellow
                }
                Else {
                    Write-Verbose $Message
                }
                $LevelText = 'INFO:'
            }
        } 
         
        # Write log entry to $Path
        "$FormattedDate $LevelText $Message" | Out-File -FilePath $Path -Append 
    }
    End {
        $ErrorActionPreference = 'Stop'
    } 
}

Write-Log -Level Info -Message "Start of script. Start of log."

Clear-Host 
Write-Host "`n--------------------------------------------------------------------------------`n" -ForegroundColor Red
Write-Host 'Welcome to the Administration Site Deployment Script for OnePlace Solutions' -ForegroundColor Green
Write-Host "`n--------------------------------------------------------------------------------`n" -ForegroundColor Red

Start-Sleep -Seconds 2

Write-Host "Beginning script. Logging script actions to $script:logPath" -ForegroundColor Cyan

#First Try statement is to set the execution policy
Try {
    Set-ExecutionPolicy Bypass -Scope Process

    #Second Try statement is to house the script content
    Try {
        
        function Invoke-Provision ([int]$count) {
            #Our first provisioning run can encounter a 403 if SharePoint has incorrectly told us the site is ready, this function will retry 
            Try {
                Write-Log -Message "Provisioning attempt $($count)"

                Invoke-PnPSiteTemplate -path $Script:TemplatePath -ClearNavigation -WarningAction Ignore
                
            }
            Catch [System.Net.WebException] {
                If ($($_.Exception.Message) -match '(403)') {
                    #SPO returning a trigger happy ready response, sleep for a bit...
                    $filler = "SharePoint Online incorrectly indicated the site is ready to provision, pausing the script to wait for it to catch up. Retrying in 5 minutes. Retry $count/4"
                    Write-Host $filler -ForegroundColor Yellow
                    Write-Log -Level Info -Message $filler

                    If ($count -lt 4) {
                        Start-Sleep -Seconds 300
                        [int]$count += 1
                        Invoke-Provision -count $count
                    }
                    Else {
                        $filler = "SharePoint Online is taking an unusual amount of time to create the site. Please check your SharePoint Administration Site in Office 365, and when the site is created please continue the script. Do not press Enter until you have confirmed the site has been completely created."
                        Write-Host $filler -ForegroundColor Red
                        Write-Log -Level Info -Message $filler
                        Write-Host "`n"
                        Pause

                        Invoke-PnPSiteTemplate -path $Script:TemplatePath -ClearNavigation -WarningAction Ignore
                        
                    }
                }
                Else {
                    Throw
                }
            }
            Catch [System.Management.Automation.RuntimeException] {
                If((Get-PnPProperty -ClientObject (Get-PnPWeb) -Property WebTemplate) -eq 'GROUP'){
                    Write-Log -Level Warn -Message "Exception thrown in template and detected GROUP#0 Site, non terminating error, continuing..."
                }
                Else {
                    Throw
                }
            }
            Catch {
                Throw
            }
        }

        function Deploy ($createSite) {
            Write-Log -Level Info -Message "Creating Site from scratch? $createSite"
            
            #Stage 1a Creating a Administration Site from scratch
            If($createSite) {
                $stage = "Stage 1/2 - Team Site (Modern) creation"
                Write-Host "`n$stage`n" -ForegroundColor Yellow
                Write-Progress -Activity "Administration Site Deployment" -CurrentOperation $stage -PercentComplete (33)
                
                $rootSharePoint = Read-Host "Please enter your SharePoint Online Root Site Collection URL, eg (without quotes) 'https://contoso.sharepoint.com'"
                Write-Log -Level Info -Message "User entered Root Site Collection: $rootSharePoint"
                $rootSharePoint = $rootSharePoint.Trim("'")
                
                $tenant = $rootSharepoint  -match 'https://(?<Tenant>.+)\.sharepoint.com.*'
                $tenant = $Matches.Tenant

                $adminSharePoint = "https://$tenant-admin.sharepoint.com"
                $rootSharePoint = "https://$tenant.sharepoint.com"
                Write-Log -Level Info -Message "Sanitized: $rootSharePoint"

                If (([string]::IsNullOrWhiteSpace($rootSharePoint)) -or ([string]::IsNullOrWhiteSpace($tenant))) {
                    Write-Host "Root SharePoint URL invalid. Exiting script."
                    Write-Log -Level Error -Message "No valid Root Site Collection URL entered. Exiting script."
                    Pause
                    Exit
                }

                Try {
                    Connect-PnPOnline -Url $adminSharePoint -Interactive

                }
                Catch {
                    $exMessage = $($_.Exception.Message)
                    If ($exMessage -like "*(403)*") {
                        Write-Log -level Error -Message "Error connecting to '$adminSharePoint'. Please ensure you have sufficient rights to create Site Collections in your Microsoft 365 Tenant. `nThis usually requires Global Administrative rights, or alternatively ask your SharePoint Administrator to perform the Administration Site Setup."
                        Write-Host "`nPlease contact OnePlace Solutions Support if you are still encountering difficulties."
                    }
                    ElseIf ($exMessage -like "*'Connect-PnPOnline'*") {
                        Write-Log -Level Error -Message "Pre-requisite PnP Cmdlets likely not installed. Please review documentation and try again."
                        Pause
                    }
                    ElseIf ($exMessage -like "*SPOManagementShell*") {
                        Write-Log -level Warn -Message "Error calling SPOManagementShell Authentication. Retrying deployment with Force SPOMS `$False"
                        Start-Sleep -Seconds 2
                        $script:forceSPOMS = $false
                        Deploy -createSite $createSite
                    }
                    Throw
                }

                Write-Log -Level Info -Message "Tenant set to $tenant"
                Write-Log -Level Info -Message "Admin SharePoint set to $adminSharePoint"
                Write-Log -Level Info -Message "Root SharePoint set to $rootSharePoint"

                Write-Log -Level Info -Message "Administration Site URL suffix set to $script:solutionsSite"

                $SolutionsSiteUrl = $rootSharePoint + '/sites/' + $script:solutionsSite
                $LicenseListUrl = $SolutionsSiteUrl + '/lists/Licenses'

                Try {
                    #Get the currently logged in user UPN to make Site Admin
                    $Context = Get-PnPContext
                    $Context.Load($Context.Web.CurrentUser)
                    $Context.ExecuteQuery()

                    $OwnerEmail = $Context.Web.CurrentUser.Email.ToString()

                    if( [string]::IsNullOrWhiteSpace( $Context.Web.CurrentUser.Email ) -and [string]::IsNullOrWhiteSpace( $Context.Web.CurrentUser.UserPrincipalName ) ){ 
                        $OwnerEmail = Read-Host "Automatic user identification failed. Please enter the email address of the user you just logged in as"
                        $OwnerEmail = $OwnerEmail.Trim()
                    }
                    elseif( [string]::IsNullOrWhiteSpace( $Context.Web.CurrentUser.Email ) -and ( -not [string]::IsNullOrWhiteSpace( $Context.Web.CurrentUser.UserPrincipalName ) ) ) {
                        $OwnerEmail = $Context.Web.CurrentUser.UserPrincipalName.ToString()
                    }

                    if ([string]::IsNullOrWhiteSpace($OwnerEmail)) {
                            Write-Log -Level Error -Message 'No Site Collection owner has been entered. Exiting script.'
                            Pause
                            exit
                    }
                    else {
                        Write-Log "OwnerEmail set to $OwnerEmail"
                    }

                    #Creating the site collection
                    $filler = "Creating site collection with URL '$SolutionsSiteUrl' for the Administration Site, and owner '$ownerEmail'. This may take a while, please do not close this window, but feel free to minimize the PowerShell window and check back in 10 minutes."
                    Write-Host $filler -ForegroundColor Yellow
                    Write-Log -Level Info -Message $filler

                    $timeStartCreate = Get-Date
                    $filler = "Starting site creation at $timeStartCreate...."
                    Write-Host $filler -ForegroundColor Yellow
                    Write-Log -Level Info -Message $filler
                
                    New-PnPTenantSite -Title 'OnePlace Solutions Administration Site' -Url $SolutionsSiteUrl -Template STS#3 -Owner $ownerEmail -Timezone 0 -StorageQuota 110 -Wait

                    $timeEndCreate = Get-Date
                    $timeToCreate = New-TimeSpan -Start $timeStartCreate -End $timeEndCreate
                    $filler = "Site Created. Finished at $timeEndCreate. Took $timeToCreate"
                    Write-Host "`n"
                    Write-Host $filler "`n" -ForegroundColor Green
                    Write-Log -Level Info -Message $filler
                }
                Catch [Microsoft.SharePoint.Client.ServerException] {
                    If ( $_.Exception.Message -like "A site already exists at url*" ) {
                        Write-Log -Level Error -Message "Site with URL $SolutionsSiteUrl already exists. Please run the script again and choose to deploy to an existing Site." -ForegroundColor Red
                        Throw $_
                    }
                    ElseIf ( $_.Exception.Message -like '*401*' ) {
                        Write-Log -Level Error -Message "Authentication issue. `nIf the newly created Site Collection is visible in your SharePoint Online admin center, re-run the script and select Option 1 to deploy to that site."
                        Throw $_
                    }
                    Else {
                        Throw $_
                    }
                }
                Catch {
                    Write-Log -level Error -Message "Something went wrong during Site Creation. Details following"
                    Throw $_
                }
                
            }
            #Stage 1b Skipping Site Creation, identifying Administration Site instead
            Else {
                Write-Host "`nStage 1/2 - Identify Administration Site`n" -ForegroundColor Yellow
                
                Do {
                    $validInput = $true
                    $tempinput = Read-Host "What is the URL of the existing Site Collection you have created? `nEg, 'https://contoso.sharepoint.com/sites/oneplacesolutions'. Do not include trailing view information such as '/AllItems.aspx'"
                    $tempinput = $tempinput.Trim()

                    Write-Log "User has entered $tempinput for Existing Site Collection URL"
                    $solutionsSiteUrl = $tempinput.TrimEnd('/')
                    
                    If($tempinput -notmatch "(https:\/\/.+\.sharepoint\.com\/sites\/oneplacesolutions)$") {
                        Write-Log -Level Warn -Message "Site Collection URL does not match 'https://{tenant}.sharepoint.com/sites/oneplacesolutions'. Please create a new Site Collection at '/sites/oneplacesolutions' and enter that URL."
                        $validInput = $false
                    }
                }
                Until ($validInput)
                
                $LicenseListUrl = $SolutionsSiteUrl + '/lists/Licenses'
            }

            #Stage 2 Applying the template
            Try {
                Write-Host "`nStage 2/2 - Apply Administration Site template`n" -ForegroundColor Yellow

                #Connecting to the site collection to apply the template
                Write-Host "Please authenticate against the Site Collection"
                Start-Sleep -Seconds 2
                    
                Connect-PnPOnline -Url $SolutionsSiteUrl -Interactive

                $Url = "https://raw.githubusercontent.com/OnePlaceSolutions/OnePlaceLiveSitePnP/master/oneplaceSolutionsSite-template-v3-modern.xml"    
                $Script:templatePath = "$env:temp\oneplaceSolutionsSite-template-v3-modern.xml" 

                $UrlSiteImage = "https://raw.githubusercontent.com/OnePlaceSolutions/OnePlaceLiveSitePnP/master/oneplacesolutions-logo.png"
                $PathImage = "$env:temp\oneplacesolutions-logo.png" 

                #Check if resources already exist
                If(-not (Test-Path $Script:templatePath)) {
                    Write-Log -Level Info -Message 'Local resources not present.'
                    #Download OnePlace Solutions Administration Site provisioning template
                    $WebClient = New-Object System.Net.WebClient
                    $filler = "Downloading provisioning xml template to: $Script:templatePath"
                    Write-Host $filler -ForegroundColor Yellow  
                    Write-Log -Level Info -Message $filler
                    $WebClient.DownloadFile( $Url, $Script:TemplatePath )
        
                    #Download OnePlace Solutions Company logo to be used as Site logo    
                    $WebClient.DownloadFile( $UrlSiteImage, $PathImage )
                    Write-Log -Level Info -Message "Downloading OPS logo for Administration Site"
                }
                Else {
                    Write-Log -Level Info -Message 'Local resources present, skipping download.' -Verbose
                }

                #Apply provisioning xml to new site collection
                $filler = "Applying configuration changes..."
                Write-Host $filler -ForegroundColor Yellow
                Write-Log -Level Info -Message $filler

                Invoke-Provision -count 0

                Write-Log -Level Info -Message "Retrieving License List ID"
                $RecordLicenseListID = $True
                Try {
                    $licenseList = Get-PnPList -Identity "Licenses" -ThrowExceptionIfListNotFound
                }
                Catch {
                    Write-Log -Level Warn -Message "License List not ready yet, backing off for 10 seconds."
                    Start-Sleep -Seconds 10
                    try {
                        $licenseList = Get-PnPList -Identity "Licenses" -ThrowExceptionIfListNotFound
                    }
                    catch {
                        Write-Log -Level Error -Message "License List not present. Skipping License List ID retrieval."
                        $RecordLicenseListID = $False
                    }
                }

                if( $RecordLicenseListID ) {
                    $licenseListId = $( $licenseList.ID ).ToString()
                    Write-Log -Level Info -Message "License List ID retrieved: $licenseListId"
                }												

                $filler = "Template Application complete!"
                Write-Host $filler -ForeGroundColor Green
                Write-Log -Level Info -Message $filler
            }
            Catch {
                $exMessage = $($_.Exception.Message)
                If ($exMessage -like "*(403)*") {
                    Write-Log -Level Error -Message "Error connecting to '$adminSharePoint'. Please ensure you have sufficient rights to create Site Collections in your Microsoft 365 Tenant. `nThis usually requires Global Administrative rights, or alternatively ask your SharePoint Administrator to perform the Administration Site Setup."
                    Write-Host "`nPlease contact OnePlace Solutions Support if you are still encountering difficulties."
                }
                ElseIf ($exMessage -like "*'Connect-PnPOnline'*") {
                    Write-Log -Level Error -Message "Pre-requisite PnP Cmdlets likely not installed. Please review documentation and try again."
                    Pause
                }
                Throw
            }

            Try {

                Write-Log -Level Info -Message "Administration Site URL = $SolutionsSiteUrl"
                if( $RecordLicenseListID ) {
                    Write-Log -Level Info -Message "License List URL = $LicenseListUrl"
                    Write-Log -Level Info -Message "License List ID = $licenseListId"
                }

                Write-Log -Level Info -Message "Uploading log file to $SolutionsSiteUrl/Shared%20Documents"

                #Upload log file to Administration Site

                Add-PnPfile -Path $script:LogPath -Folder "Shared Documents"

                Write-Progress -Activity "Completed" -Completed

                Write-Host "`nPlease record the OnePlace Solutions Administration Site URL for usage in the OnePlaceMail Desktop and OnePlaceDocs clients. " -ForegroundColor Yellow
                Write-Host "`nThese have also been written to a log file at '$script:logPath', and '$SolutionsSiteUrl/Shared%20Documents/$script:logFile'." -ForegroundColor Yellow
                Write-Host "`n-------------------`n" -ForegroundColor Red
                
                If($true -eq $legacyLicensing) {
                    $importants = "Administration Site URL = $SolutionsSiteUrl`nLicense List URL   = $LicenseListUrl`nLicense List ID    = $licenseListId"
                }
                Else {
                    $importants = "Administration Site URL = $SolutionsSiteUrl"
                }
                Write-Host $importants

                Write-Host "`n-------------------`n" -ForegroundColor Red
                
                Write-Host "Opening Administration Site at $SolutionsSiteUrl..." -ForegroundColor Yellow
                Pause

                #cleaning up the Navigation nodes, doing this late in case there's an issue
                If((Get-PnPProperty -ClientObject (Get-PnPWeb) -Property WebTemplate) -eq 'GROUP'){
                    Write-Log -Message "GROUP#0 Site detected, attempting clean up of navigation nodes"
                    Try {
                        Get-PnPNavigationNode | ForEach-Object {
                            If(@(2002,2004,2005,1033).Contains($_.Id)){
                                $_ | Remove-PnPNavigationNode -Force -ErrorAction Continue
                                }
                            }
                    }
                    Catch {
                        #Couldn't remove the nodes, not an issue though.
                    }
                }

                Start-Process $SolutionsSiteUrl | Out-Null
            }
            Catch {
                Throw $_.Exception.Message
            }
        }

        function showMenu { 
            Clear-Host 
            Write-Host "`n--------------------------------------------------------------------------------`n" -ForegroundColor Red
            Write-Host 'Welcome to the Administration Site Deployment Script for OnePlace Solutions' -ForegroundColor Green
            Write-Host "`n--------------------------------------------------------------------------------`n" -ForegroundColor Red
            Write-Host "Site Deployment:" -ForegroundColor Yellow
            Write-Host "1: Deploy the Administration Site template to an existing Group or Modern Team Site Collection at '/sites/oneplacesolutions'"
            Write-Host "2: Create a new Modern Team Site Collection at '/sites/oneplacesolutions' automatically and deploy the Administration Site template"
            Write-Host "`nPnP Pre-Requisite Installation:" -ForegroundColor Yellow
            Write-Host "3: Install Current PnP.PowerShell Cmdlets for current user"
            Write-Host "`nAdditional Configuration:" -ForegroundColor Yellow
            Write-Host "L: Change Log file path (currently: '$script:logPath')"

            Write-Host "`nQ: Press 'Q' to quit." 
            Write-Log -Level Info -Message "Displaying Menu"
        }

        Write-Log -Level Info -Message "Logging script actions to $script:logPath"
        Try{
            $script:PnPPowerShell = Get-InstalledModule "PnP.PowerShell" -ErrorAction SilentlyContinue
            If($null -ne $script:PnPPowerShell) {
                $script:forceSPOMS = $false
                Write-Host "Current PnP.PowerShell PnP Cmdlets detected" -ForegroundColor Green
                Write-Log -Level Info -Message "PnP.PowerShell Version: $([string]$script:PnPPowerShell)"
            }
        }
        Catch {
            Write-Log "PnP.PowerShell not found"
        }

        Start-Sleep -Seconds 2

        do {
            showMenu
            $userInput = Read-Host "Please select an option" 
            Write-Log -Message "User has entered option '$userInput'"
            switch ($userInput) { 
                #Apply site template 
                '1' {
                    Clear-Host
                    Write-Host "`nPlease ensure you have created a Site Collection at '/sites/oneplacesolutions' in your SharePoint Online environment before continuing, and copy it's URL to enter in the following prompt.`nEg, 'https://contoso.sharepoint.com/sites/oneplacesolutions'"
                    Pause
                    Deploy -createSite $false
                }
                #Create site and deploy
                '2' {
                    Deploy -createSite $true

                }
                '3' {
                    Clear-Host
                    If($null -eq $script:PnPPowerShell) {
                        Write-Host "Invoking installation of the PnP.PowerShell for SharePoint Online, please accept the prompts for installation."
                        Write-Host "If you do not use PowerShell modules often, you will likely see a message related to an 'Untrusted Repository', this is PowerShell Gallery where the PnP Modules are downloaded from. Please selection option 'Y' or 'A'.`n"
                        Write-Host "If you have been prompted as above and have already selected 'Y' or 'A' and nothing happens after a few minutes, please press 'Enter'."
                        
                        Invoke-Expression -Command "Install-Module PnP.PowerShell -Scope CurrentUser"
                        Write-Host "Importing newly installed PnP.PowerShell module into this session..."
                        Import-Module "PnP.PowerShell"
                    }
                    Else {
                        Write-Host "Existing PnP.PowerShell detected, skipping installation."
                    }
                    $script:PnPPowerShell = Get-Module "PnP.PowerShell"
                    Pause
                }
                'l' {
                    $newLogPath = (Read-Host "Please enter a new path including 'OPSScriptLog.txt' and quotes for the new log file. Eg, 'C:\Users\John\Documents\OPSScriptLog.txt'.")
                    $newLogPath = $newLogPath.Replace('\\','\')
                    If ([string]::IsNullOrWhiteSpace($newLogPath)) {
                        Write-Host "No path entered, keeping default '$script:logPath'"
                    }
                    Else {
                        Move-Item -Path $script:logPath -Destination $newLogPath
                        $script:logPath = $newLogPath
                    }
                    Pause
                }
                'll'{
                    $legacyLicensing = $true
                }
                'q' {Exit}
            }
        }
        until($userInput -eq 'q') {}
    }
    Catch {
        $exType = $($_.Exception.GetType().FullName)
        $exMessage = $($_.Exception.Message)
        Write-Host "`nCaught an exception, further debugging information below:" -ForegroundColor Red
        Write-Log -Level Error -Message "Caught an exception. Exception Type: $exType. $exMessage"
        Write-Host "`nActual Error encountered: $exMessage" -ForegroundColor Red
        Write-Host "`nPlease send the log file at '$script:logPath' to 'support@oneplacesolutions.com' for assistance." -ForegroundColor Yellow
        Pause
    }
    #Clean up and disconnect any leftover PnPOnline sessions
    Finally {
        Try {
            Disconnect-PnPOnline -ErrorAction SilentlyContinue
        }
        Catch {}
        Write-Log -Level Info -Message "End of script. End of log."
    }
}
Catch {
    $_
}