Merge pull request #619 from kasperbolarsen/main

Export and Import folder structure

scripts/spo-export-import-folderstructure/README.md

@@ -0,0 +1,129 @@
+---
+plugin: add-to-gallery
+---
+
+# Export and import library folder structure
+
+## Summary
+
+Sometimes you just need to copy a folder structure from one library to another. This script will export the folder structure from one library and import it to another library using a JSON file to store the folder structure. The can be used as is or be an invidual function in a site provisioning script.
+
+
+![Example Screenshot](assets/example.png)
+
+
+# [PnP PowerShell](#tab/pnpps)
+
+```powershell
+# export part 
+
+function Get-Folderstructure 
+{
+    param(
+        [Parameter(Mandatory=$true)]
+        [string]$folderUrl,
+        [Parameter(Mandatory=$true)]
+        [string]$folderName
+    )
+    
+    $result = $null
+    $folderColl=Get-PnPFolderItem -FolderSiteRelativeUrl $folderUrl -ItemType Folder -Connection $conn  
+    $leaves = @()
+    $elements = @()
+    foreach($folder in $folderColl)
+    {
+        #Write-Host $folder.Name -ForegroundColor Green
+        $subFolderURL= $folderUrl+"/"+$folder.Name
+        $testForSubFolders=Get-PnPFolderItem -FolderSiteRelativeUrl $subFolderURL -ItemType Folder -Connection $conn  
+        if($testForSubFolders.Count -gt 0)
+        {
+            $result = Get-FolderstructureAsJson -folderUrl $subFolderURL -folderName $folder.Name
+            $result = $result | ConvertFrom-Json -Depth 100
+            $elements += $result
+
+        }
+        else 
+        {
+            #Write-Host "leaf node $($folder.Name)" -ForegroundColor Yellow
+            $leave = [PSCustomObject]@{Name = $folder.Name}    
+            $elements += $leave
+        }
+        
+        
+    }
+    if($elements.Count -gt 0)
+    {
+        $element = [PSCustomObject]@{
+            Name = $folderName
+            Folders = $elements
+        }
+    }
+    
+    $element = $element | ConvertTo-Json -Depth 100
+    return $element
+}
+$url = "https://contoso.sharepoint.com/sites/thesite"
+$conn = Connect-PnPOnline -Url $url -Interactive -ReturnConnection
+
+$finalJson = @()
+$finalJson = Get-Folderstructure -folderUrl "/Shared Documents"
+$finalJson | ConvertTo-Json -Depth 100
+#write result to file
+$finalJson | Out-File -FilePath "C:\temp\folderstructureRecursive.json" -Force
+
+################################
+# import part
+
+function SetFolder ($folder, $folderurl)
+{
+    $createdFolder = Add-PnPFolder -Name $folder.Name -Folder $folderurl -ErrorAction Stop -Connection $conn    
+    
+    foreach($folder in $folder.Folders)
+    {
+        SetFolder -folder $folder -folderurl $createdFolder.ServerRelativeUrl
+    }
+}
+    
+
+
+function Set-FolderstructurefromJson ($json, $folderName) 
+{
+    $folders = $json.Folders
+
+    foreach($folder in $folders)
+    {
+        $res = SetFolder -folder $folder -folderurl $folderName -Connection $conn
+    }
+
+}
+
+$url = "https://contoso.sharepoint.com/sites/targetsite/"
+$conn = connect-pnponline -URL $url -Interactive -ReturnConnection
+
+#the json file can be stored in a document library or locally
+$jsonUrl = "/sites/SampleTeamSite/Shared%20Documents/folderstructureRecursive.json"
+$jsonSiteUrl = "https://contoso.sharepoint.com/sites/SampleTeamSite"
+$jsonsiteconn = Connect-PnPOnline -Url $jsonSiteUrl  -Interactive -ReturnConnection
+
+$file = Get-PnPFile -Url $jsonUrl -AsString -Connection $jsonsiteconn
+$json = ConvertFrom-Json $file 
+
+#if you want start the folder structure in the root of the library
+Set-FolderstructurefromJson -json $json -folderName "Shared Documents/"
+
+#if you want to start the folder structure in a subfolder of the library
+Set-FolderstructurefromJson -json $json -folderName "Shared Documents/General"
+
+```
+[!INCLUDE [More about PnP PowerShell](../../docfx/includes/MORE-PNPPS.md)]
+***
+
+
+## Contributors
+
+| Author(s) |
+|-----------|
+| Kasper Larsen |
+
+[!INCLUDE [DISCLAIMER](../../docfx/includes/DISCLAIMER.md)]
+<img src="https://m365-visitor-stats.azurewebsites.net/script-samples/scripts/spo-export-import-folderstructure" aria-hidden="true" />

scripts/spo-export-import-folderstructure/assets/sample.json

@@ -0,0 +1,57 @@
+[
+  {
+    "name": "spo-export-import-folderstructure",
+    "source": "pnp",
+    "title": "Export and import library folder structure",
+    "shortDescription": "This script shows who to export a folderstructure to a JSON file, and import the folder structure into another library",
+    "url": "https://pnp.github.io/script-samples/spo-export-import-folderstructure/README.html",
+    "longDescription": [
+      ""
+    ],
+    "creationDateTime": "2023-11-11",
+    "updateDateTime": "2023-11-11",
+    "products": [
+      "SharePoint",
+      "Teams"
+    ],
+    "metadata": [
+      {
+        "key": "PNP-POWERSHELL",
+        "value": "2.2.1"
+      }
+    ],
+    "categories": [
+      "Data",
+      "Deploy",
+      "Provision",
+      "Configure"
+
+    ],
+    "tags": [
+      "<Cmdlets-Used>"
+    ],
+    "thumbnails": [
+      {
+        "type": "image",
+        "order": 100,
+        "url": "https://raw.githubusercontent.com/pnp/script-samples/main/scripts/spo-export-import-folderstructure/assets/preview.png",
+        "alt": "Preview of the sample Export and import library folder structure"
+      }
+    ],
+    "authors": [
+      {
+        "gitHubAccount": "kasperbolarsen",
+        "company": "",
+        "pictureUrl": "https://github.com/kasperbolarsen.png",
+        "name": "Kasper Larsen"
+      }
+    ],
+    "references": [
+      {
+        "name": "Want to learn more about PnP PowerShell and the cmdlets",
+        "description": "Check out the PnP PowerShell site to get started and for the reference to the cmdlets.",
+        "url": "https://aka.ms/pnp/powershell"
+      }
+    ]
+  }
+]