Accéder au contenu principal

PowerShell : Script de recherche des WebParts voulues (pour Clean Up par exemple)

 Dans le cadre de la gestion de fermes SharePoint, on rencontre très souvent le cas d'installation de composants qui sont par la suite supprimés.

Un cas particulier peut devenir problématique :

  • Installation de WebPart

En effet, une WebPart est comme tout composant SharePoint une Feature qui peut donc être déployée par une solution WSP. Ainsi, une fois déployé, ce composant peut être activé par tout responsable de site afin de voir aparaître cette WebPart dans le catalogue.

Que se passe-t'il donc lorsque l'on supprime cette solution alors que les responsables de site ont activé ce composant ?

  • La WebPart apparaît encore dans le catalogue et provoquera une erreur lors de la tentative de mise en place sur une page

Philippe Sentenac nous a montré comment éviter ceci depuis le code de déploiement (Evenement d'activation et de désactivation de la feature) :

Mais lorsque ceci n'a pas été prévu, on se retrouve avec une liste de WebPart présente dans le catalogue ne représentant plus du tout la réalité.

La solution peut être de passer par PowerShell.

Nous pouvons partir d'un script de listing des WebParts (similaire à celui fournit précédement) comme suit :

function GetSharePointItemList([string]$SiteURL, [string]$ListName, [string]$ColumnName)
{
    [System.Reflection.Assembly]::LoadWithPartialName("Microsoft.SharePoint") > $null
    $site = new-object Microsoft.SharePoint.SPSite($SiteURL)
    Write-Host "SiteURL", $SiteURL

    $web = $site.openweb()

    $spList = $web.Lists[$ListName]
    Write-Host "ListName", $ListName

    foreach ($MyItem in $spList.Items)
    {
        Write-Host "Value [" + $ColumnName + "]: ", $MyItem[$ColumnName]

        #Add your code here
    }
}

GetSharePointItemList "http://MaWebAppSharePoint/" "Web Part Gallery" "Title"

On obtiendra un résultat similaire à celui-ci :

PS E:\TOOLS\PowerShellScripts> .\ShowDataFromSharePoint.ps1
SiteURL http://SiteSharePoint/
ListName Web Part Gallery
Value [ + Title + ]:  Content Editor Web Part
Value [ + Title + ]:  Page Viewer Web Part
Value [ + Title + ]:  Image Web Part
Value [ + Title + ]:  Site Users
Value [ + Title + ]:  Form Web Part
Value [ + Title + ]:  Relevant Documents
Value [ + Title + ]:  User Tasks
Value [ + Title + ]:  XML Web Part
PS E:\TOOLS\PowerShellScripts>

On peut donc imaginer de fournir le nom de la WebPart à supprimer ainsi que la Web Application à nettoyer. Ce script fera donc une boucle sur toutes les collections de sites afin nettoyer la liste des WebParts.

Il est aussi possible (et même meilleur) de passer par une requête CAML comme l'exemple :

Ainsi le script devient (avec une possibilité de lister les sites ayant la WebPart voulue sans le supprimer) :

function CheckWebParts([object]$MyWeb, [string]$WebPartName, [bool]$ToDelete)
{
    $ColumnName = "FileLeafRef"
    $ListName = "Web Part Gallery"
    $spList = $MyWeb.Lists[$ListName]

    $caml='<Where>
      <Eq>
         <FieldRef Name="{0}" />
         <Value Type="Computed">{1}</Value>
      </Eq>
   </Where>' -f $ColumnName, $WebPartName

    $query=new-object Microsoft.SharePoint.SPQuery
    $query.Query=$caml
    $col=$spList.GetItems($query)

#    Write-Host "Count: ", $col.Count

    if($col.Count -gt 0)
    {   
        if($ToDelete)
        {
            Write-Host "WebPart exists (deleted) in site $MyWeb: ", $WebPartName
            $col |  % { $_.Delete() }
        }
        else
        {
            Write-Host "WebPart exists (not deleted) in site $MyWeb: ", $WebPartName
        }
    }
}

function CheckWP-All-Sites([string]$WebAppURL, [string]$WebPartName, [bool]$ToDelete)
{
    [System.Reflection.Assembly]::LoadWithPartialName("Microsoft.SharePoint") > $null

    $Thesite = new-object Microsoft.SharePoint.SPSite($WebAppURL)
    $oApp = $Thesite.WebApplication

    foreach ($Sites in $oApp.Sites)
    {
        $mySubweb = $Sites.RootWeb
#        Write-Host "URL", $mySubweb.Url
        CheckWebParts $mySubweb $WebPartName $ToDelete
    }
    $Thesite.Dispose()
}

CheckWP-All-Sites "http://MaWebAppSharePoint/" "Coucouc.dwp" 0

Vous pouvez adapter ce cas à de très nombreux besoins.

Romelard Fabrice [MVP]

Commentaires

Enregistrer un commentaire