샌드박스 솔루션의 업그레이드 관리

Artigo
11/17/2010

샌드박스 솔루션의 업그레이드 관리

본문:

샌드박스 솔루션은 SharePoint 2010 플랫폼의 매우 뛰어난 기능입니다. 하지만 이러한 솔루션을 팜이나 사이트 모음의 다양한 위치에 배포하게 되면 이를 관리하는 방법에 대한 문제가 발생하게 됩니다.

따라서 이 문제를 해결하는 데 도움이 되는 PowerShell 스크립트를 소개하려 합니다. 이 스크립트는 매우 간단하지만 이미 팜 및 사이트 모음을 관리하는 데 사용 중인 도구에 적합하도록 확장하여 더 많은 기능을 수행할 수 있습니다.

그럼 이 스크립트를 통해 수행할 수 있는 작업에 대해 설명해 보겠습니다.

배포하는 모든 샌드박스 솔루션에는 해당 솔루션과 연결된 솔루션 ID가 있습니다. 그리고 해당 솔루션 내에는 기능 ID와 버전 번호가 있는 기능이 하나 이상 있습니다. 이 스크립트는 특정 솔루션 ID에 대해 전체 팜 또는 사이트 모음을 검사하고 해당 솔루션이 있는 모든 위치를 알려 주는 로그를 생성합니다. 그런 다음 솔루션 내에서 각 기능을 확인하고 해당 기능의 배포된 버전을 나타내는 로그 항목을 추가합니다. 또한 솔루션의 새 버전이 제공되면 이 스크립트를 통해 업그레이드를 수행할 수도 있습니다. 이는 플래그이므로 스크립트에서 업그레이드를 수행할 수도 있고 스크립트를 단순히 솔루션에 대한 정보를 수집하기 위한 수단으로 사용할 수도 있습니다.

이 스크립트에서는 다음과 같은 매개 변수를 사용합니다.

· 업그레이드할 솔루션(.wsp 파일)의 파일 경로와 이름

· 업그레이드를 수행해야 하는지 여부를 나타내는 스위치 매개 변수

사용 권한은 다음과 같이 적용됩니다.

· 스크립트에서는 해당 스크립트를 실행하는 사용자가 샌드박스 관리자이며 업그레이드 작업을 수행할 수 있는 권한이 있는 것으로 가정합니다.

· 사용 권한 수준은 관리자에게 모든 권한을 부여하도록 수정됩니다.

· 업그레이드가 완료되면 사용 권한이 원래 설정으로 복원됩니다.

로그 형식은 다음과 같습니다.

· 솔루션 ID를 포함하여 확인 중인 솔루션의 파일 경로 및 이름에 대한 세부 정보

· 검사하는 각 사이트 모음에 대한 세부 정보

· 각 사이트 모음에 대한 정보

o 일치하는 솔루션이 검색되었는지 여부에 대한 정보

o 검색된 경우 새 버전으로 바꿀 수 있도록 제거하는 솔루션 파일에 대한 세부 정보

o 업그레이드를 수행하는 경우 성공 또는 실패에 대한 세부 정보

· 다음이 포함된 요약 정보

o 검사한 사이트 모음 수

o 업그레이드를 수행하지 않는 경우 솔루션에 있는 각 기능의 현재 버전(ID)에 대한 세부 정보와 함께 업그레이드해야 하는 사이트의 요약 목록

o 업그레이드를 수행하는 경우 기능 및 버전 정보와 함께 성공한 업그레이드, 성공한 새로운 설치 또는 이미 현재 버전이므로 변경되지 않은 기능에 대한 세부 정보

다음 몇 가지 사항을 참고해 주시기 바랍니다.

솔루션을 업그레이드하려면 SharePoint 2010 플랫폼에서 솔루션 파일 이름을 각기 다르게 지정해야 합니다. 이름이 같으면 해당 솔루션이 이미 활성화되어 있음을 알리는 오류가 발생합니다. 솔루션을 업그레이드하면 해당 솔루션의 기존 버전을 찾은 다음 버전 세부 정보를 확인하기 위해 솔루션 ID가 사용됩니다. 업그레이드를 수행하면 새 버전으로만 이동되며 이전 버전으로 롤백되지는 않습니다. 또한 버전이 같은 경우에는 아무 작업도 수행되지 않습니다.

이 스크립트를 적절히 활용하여 배포하는 솔루션을 효율적으로 관리하고 업그레이드를 훨씬 편리하게 수행하게 되기를 바랍니다.

# SharePoint DLL

[void][System.Reflection.Assembly]::LoadWithPartialName("Microsoft.SharePoint")

#Cmdlet Install

Add-PSSnapin Microsoft.SharePoint.PowerShell -ErrorAction SilentlyContinue

#Log file definition

$intro = "User Solution Upgrader v1.0 - Log File"

$date = (Get-Date).ToString('yyyyMMdd')

Set-Variable -Name ForReading -value 1 -Option Constant

Set-Variable -Name ForWriting -value 2 -Option Constant

Set-Variable -Name ForAppending -value 8 -Option Constant

#Assume that the current "Domain\User" is the box admin entitled to perform the reconaissance and upgrade actions.

$admin = $env:UserDomain + "\" + $env:UserName

if ($env:UserDomain -eq $null)

{

$admin = $admin.substring(1)

}

# Get the script's parent folder. This is where the log file will be written.

$logFolder = Split-Path -Path $MyInvocation.MyCommand.Definition -Parent

$getACL = Get-Acl $logFolder

$access = $getACL.Access | Where { $_.IdentityReference -eq $admin }

if ($access -eq $null -or

($access.FileSystemRights -ne [System.Security.AccessControl.FileSystemRights]::FullControl -and

($access.FileSystemRights -ne [System.Security.AccessControl.FileSystemRights]::Write -and

$access.FileSystemRights -ne [System.Security.AccessControl.FileSystemRights]::CreateFiles)))

{

$logFolder = $env:userprofile

}

# Add the log file name to the path.

$logFileFullPath = Join-Path $logFolder "usersolutionupgrader-$date.txt"

# Open file

$fo = New-Object -com Scripting.FileSystemObject

$f = $fo.OpenTextFile($logFileFullPath, $ForAppending, $true)

if ($f -eq $null)

{

$logFolder = $env:userprofile

$logFileFullPath = Join-Path $logFolder "usersolutionupgrader-$date.txt"

$f = $fo.OpenTextFile($logFileFullPath, $ForAppending, $true)

}

#Confirm log file on screen

Write-Host ("Log Path: " + $logFileFullPath)

#Write intro line

$f.WriteLine()

$f.WriteLine($intro)

function WriteLog

{

$dt = Get-Date

$logMsg = $dt.ToShortDateString() + " " + $dt.ToShortTimeString() + "`t" + $args[0]

$f.WriteLine($logMsg)

Write-Output($logMsg) #Turn this on when you need console output

}

function exitScript()

{

if ($f -ne $null)

{

$f.Close()

}

Write-Host "Exiting script due to error."

exit

}

WriteLog ("Current user (admin): $admin")

#solution details

$solFile = ""

$targetSolutionId = ""

$upgrade = $false

$myError = $null

$haveCurrentFeatures = $false

$haveNewFeatures = $false

$numSites = 0

$oldFeatures = @{}

$newFeatures = @{}

$solSites = New-Object System.Collections.ArrayList

$solFailSites = New-Object System.Collections.ArrayList

#Parse the commandline parameters

if (($args -eq $null) -or ($args.Count -lt 2))

{

WriteLog("Error: This script has been called without enough parameters. Listing your parameters below:")

WriteLog($args)

if ($f -ne $null)

{

$f.Close()

}

exitScript

}

else

{

$badParameters = $false

foreach ($arg in $args)

{

switch ($arg)

{

"-upgrade" {$upgrade = $true}

"-path" {[void] $foreach.MoveNext(); $solFile = $foreach.Current}

default {$badParameters = $true}

}

if ($badParameters -eq $true)

{

WriteLog("You passed in a bad parameter.")

exitScript

}

#Validate parameters

$extension = [IO.Path]::GetExtension($solFile)

if (($extension -eq $null) -or ($extension -ne ".wsp") -or (!(Test-Path $solFile)))

{

WriteLog("Error: The solution file name is not of WSP format or is an invalid file.")

exitScript

}

#Confirm parameter values captured

$fileName = Split-Path $solFile -Leaf

WriteLog("Solution Path is: `t" + $solFile)

WriteLog("Solution Name is: `t" + $fileName)

if ($upgrade)

{

WriteLog "The tool will attempt to perform UPGRADE on the site collections"

}

WriteLog ""

}

#Get solution ID from given WSP

$tempPath = Join-Path $env:temp "upgrader" | Join-Path -ChildPath $fileName

$shell = New-Object -ComObject "Shell.Application" -ErrorAction:SilentlyContinue -ErrorVariable myError

if ($myError -ne $null)

{

WriteLog("FAILED to create the Shell.Application object.")

WriteLog("Error: " + $myError)

$myError = $null

}

[IO.Directory]::CreateDirectory($tempPath) | Out-Null

$tempFolder = $shell.NameSpace($tempPath)

$tempFolder.CopyHere($solFile)

#Take the file name ("yourfile.wsp") from the original path

$tempSolPath = Join-Path $tempPath $fileName

if (!(Test-Path $tempSolPath))

{

WriteLog "Error: Failed to copy WSP file to temp location."

exitScript

}

#Rename the WSP file to have CAB extension in order to facilitate CAB extraction

$cabFileName = [System.IO.Path]::GetFileNameWithoutExtension($fileName) + ".cab"

Rename-Item $tempSolPath $cabFileName

$cabPath = Join-Path $tempPath $cabFileName

$sourceWsp = $shell.NameSpace($cabPath).items()

$tempFolder.CopyHere($sourceWsp)

$manifestPath = Join-Path $tempPath "manifest.xml"

[xml]$manifest = Get-Content $manifestPath

$targetSolutionId = $manifest.Solution.SolutionId

#Validate Solution GUID

[Guid]$testGuid = "B80D56EC-5899-459d-83B4-1AE0BB8418E4"

if (($targetSolutionId -eq $null) -or ($targetSolutionId.Length -lt 36) -or

([System.ComponentModel.TypeDescriptor]::GetConverter($testGuid).ConvertFromString($targetSolutionId) -eq $null))

{

WriteLog("Error: Target solution ID is invalid: " + $stringSolutionId)

exitScript

}

WriteLog("Extracted solution ID: $targetSolutionId from manifest.xml")

WriteLog("")

#Now delete temp folder.

Remove-Item $tempPath\*

Remove-Item $tempPath

#Go through Content DBs

WriteLog ("Looking for Solution Id: " + $targetSolutionId + " in all Content Databases`n")

$dbs = Get-SPContentDatabase

foreach ($contentdb in $dbs)

{

#Web App Level

$webAppUrl = $contentdb.WebApplication.Url

#Get WebApp

$webApp = Get-SPWebApplication -Identity $webAppUrl

$policy = $webApp.Policies[$admin]

$policyAdded = $false

$roleAdded = $false

#If the admin doesn't have Full Control, it will be granted as follows:

if ($policy -eq $null)

{

$policy = $webApp.Policies.Add($admin, "")

$webAppModified = $true

$policyAdded = $true

WriteLog "Added a policy entry for user '$admin'."

}

$fullRole = $webApp.PolicyRoles.GetSpecialRole([Microsoft.SharePoint.Administration.SPPolicyRoleType]::FullControl)

if ($policy.PolicyRoleBindings[$fullRole] -eq $null)

{

$policy.PolicyRoleBindings.Add($fullRole)

$webAppModified = $true

$roleAdded = $true

WriteLog "Full Control added for '$admin' to Web Application '$webAppUrl'"

}

if ($webAppModified)

{

$webApp.Update()

$webAppModified = $false

}

#Done. Have Full Control

WriteLog ("Entering Web Application '$webAppUrl'.`n")

Get-SPSite -WebApplication $webApp -Limit ALL | % {

$site = $_

$solution = $null

$foundSolution = $false

#Scan for solution here

Get-SPUserSolution -Site $_ | Where { $_.Status -eq [Microsoft.Sharepoint.SPUserSolutionStatus]::Activated -and $_.SolutionId -eq $targetSolutionId } | % {

if ($foundSolution -eq $false)

{

$foundSolution = $true

$solution = $_

if ($haveCurrentFeatures -eq $false)

{

Get-SPFeature -Sandboxed -Site $site | Where { $_.SolutionId -eq $targetSolutionId } | % {$oldFeatures.Add($_.Id, $_)}

$haveCurrentFeatures = $true

}

if ($upgrade -eq $false)

{

$solSites.Add($site.Url) | Out-Null

}

$solutionHash = $_.Signature

WriteLog ("Found site collection: " + $site.Url)

}

$numSites ++

#DoUpgrade here

if ($upgrade -and $foundSolution)

{

$successAdd = $false

WriteLog ("Uploading new solution file as: $fileName")

#Add + Upgrade solution

$myError = $null

Add-SPUserSolution -LiteralPath $solFile -Site $site -ErrorAction:SilentlyContinue -ErrorVariable myError -Confirm:$false

if ($myError -ne $null)

{

WriteLog("Site collection '" + $site.Url + "' FAILED to upload the new solution.")

WriteLog("Error: " + $myError)

$myError = $null

}

else

{

$successAdd = $true

}

$addedSolution = Get-SPUserSolution -Identity $fileName -Site $site

if ($addedSolution -ne $null)

{

WriteLog ("Found solution $fileName in the Solutions Gallery. Attempting to use it...")

#First check for already updated solution

if ($addedSolution.Signature -eq $solutionHash)

{

#This means we have the same version installed. Just skip it. And delete our copy!

WriteLog ("New solution is already active on this site collection.")

if ($successAdd -eq $true)

{

#Remove the new solution (the dupe)

WriteLog ("Removing file: $fileName")

Remove-SPUserSolution -Identity $addedSolution -Site $site -Confirm:$false

if (!($solFailSites.Contains($site.Url)))

{

$solFailSites.Add($site.Url) | Out-Null

}

else

{

#Perform upgrade

Update-SPUserSolution -Identity $solution -Site $site -ToSolution $addedSolution -ErrorAction:SilentlyContinue -ErrorVariable myError -Confirm:$false

if ($myError -ne $null)

{

WriteLog("Site collection '" + $site.Url + "' FAILED to upgrade to the new solution.")

WriteLog("Error: " + $myError)

if (!($solFailSites.Contains($site.Url)))

{

$solFailSites.Add($site.Url) | Out-Null

}

$myError = $null

}

if (!($solFailSites.Contains($site.Url)))

{

#Upgrade succeeded

WriteLog("Site collection '" + $site.Url + "' has been upgraded to the new solution.")

WriteLog ""

$solSites.Add($site.Url) | Out-Null

#Record results AFTER upgrade

if ($haveNewFeatures -eq $false)

{

Get-SPFeature -Sandboxed -Site $site | Where { $_.SolutionId -eq $targetSolutionId } | %{$newFeatures.Add($_.Id, $_)}

$haveNewFeatures = $true

}

else

{

if (!($solFailSites.Contains($site.Url)))

{

$solFailSites.Add($site.Url) | Out-Null

}

$site.Close();

}

#Close permissions and webApp

if ($roleAdded)

{

$policy.PolicyRoleBindings.RemoveById($fullRole.Id)

$webAppModified = $true

WriteLog "Removed Full Control for '$admin' from Web Application '$webAppUrl'"

}

if ($policyAdded)

{

$webApp.Policies.Remove($admin)

$webAppModified = $true

WriteLog "Removed the policy entry for user '$admin'."

}

if ($webAppModified)

{

$webApp.Update()

$webAppModified = $false

}

WriteLog ""

WriteLog "Done with Web Application."

WriteLog ""

}

#Final tally of site collections

WriteLog("Analysis of site collection upgrades for solution ID $targetSolutionId ...")

WriteLog("We have processed a total of $numSites site collections.")

WriteLog("")

if ($upgrade)

{

#Site Collection Summary

if ($solSites.Count -eq 0)

{

WriteLog("No site collections were upgraded. Refer to this log for any upgrade errors.")

}

else

{

WriteLog("Listing site collections that have been upgraded:")

foreach ($siteUrl in $solSites)

{

WriteLog($siteUrl)

}

if ($solFailSites.Count -ne 0)

{

WriteLog("Listing site collections that FAILED to upgrade:")

foreach ($siteUrl in $solFailSites)

{

WriteLog($siteUrl)

}

#Feature Upgrade Summary

if ($newFeatures.Count -gt 0)

{

WriteLog ""

WriteLog "Feature upgrade summary for the New User Solution:"

foreach($fKey in $newFeatures.Keys)

{

$fDef = $oldFeatures[$fKey]

$fDef2 = $newFeatures[$fKey]

#Feature ID and DisplayName

WriteLog("Feature ID: " + $fDef2.Id + "`t DisplayName: " + $fDef2.DisplayName)

#Feature Version

if ($fDef -eq $null)

{

#New feature added.

WriteLog("This feature has been newly added.`t`t`t Version " + $fDef2.Version)

}

else

{

if ($fDef.Version -eq $fDef2.Version)

{

WriteLog("This feature has been unchanged.`t`t`t Version " + $fDef2.Version)

}

else

{

WriteLog("Feature went from Version " + $fDef.Version + " to Version " + $fDef2.Version)

}

WriteLog ""

}

WriteLog ("The new solution holds a total of " + $newFeatures.Count + " feature(s).")

}

else

{

if ($solSites.Count -eq 0)

{

WriteLog("No site collections have been found.")

}

else

{

WriteLog("We have found " + $solSites.Count + " site collections, as follows (no upgrade action performed):")

foreach ($siteUrl in $solSites)

{

WriteLog($siteUrl)

}

WriteLog ""

WriteLog "Feature summary for current User Solution:"

foreach($fKey in $oldFeatures.Keys)

{

$fDef = $oldFeatures[$fKey]

WriteLog ("Feature DisplayName: `t" + $fDef.DisplayName)

WriteLog ("Feature Version: `t" + $fDef.Version)

WriteLog ("Feature Id: `t`t" + $fDef.Id)

}

WriteLog ""

WriteLog ("Found a total of " + $oldFeatures.Count + " feature(s).")

WriteLog ""

}

WriteLog ""

#Close the file handle.

if ($f -ne $null)

{

$f.Close()

}

게시일: 2010년 8월 15일 오후 11:30

이 문서는 번역된 블로그 게시물입니다. 원본 문서는 샌드박스 솔루션의 업그레이드 관리를 참조하십시오.

Partilhar via

샌드박스 솔루션의 업그레이드 관리

Recursos adicionais