Merge pull request #651 from ValerasNarbutas/main

Download an array of file urls and zip them #527

scripts/spo-download-files-and-archive/README.md

@@ -0,0 +1,156 @@
+---
+plugin: add-to-gallery
+---
+
+# Download all files from array of URLs and archive them
+
+## Summary
+
+The script will download all files from an array of URLs and archive them into a zip file. Two options are available to specify the file URLs: 
+1. add the URLs in the script, or 
+2. read the URLs from a CSV file.
+
+## Implementation
+
+- Open Windows PowerShell ISE or VS Code
+- Copy script below to your clipboard
+- Paste script into your preferred editor
+- Change config variables to reflect the site, library name & download location required
+
+
+# [PnP PowerShell](#tab/pnpps)
+
+```powershell
+
+# Connect to the SharePoint site
+$siteUrl = "https://[tenant].sharepoint.com/sites/[sitename]"
+Connect-PnPOnline -Url $siteUrl -UseWebLogin
+
+# Define the array of file URLs (relative to the site URL)
+# Option 1: with urls added in script
+$fileUrls = @(
+    "/sites/[sitename]/Shared Documents/Document.docx",
+    "/sites/[sitename]/Shared Documents/Book.xlsx"
+)
+
+# Option 2: with urls from a CSV file
+# CSV file should have a column named FileUrl
+# Example CSV file content:
+# FileUrl
+# /sites/[sitename]/Shared Documents/file1.docx
+# /sites/[sitename]/Shared Documents/file2.pdf
+
+# Path to the CSV file
+# uncomment the line below and specify the path to your CSV file
+# $csvFilePath = "C:\path\to\your\file.csv"
+
+# Reading the file URLs from the CSV file
+# uncomment the line below if you want to read the file URLs from a CSV file
+# $fileUrls = Import-Csv -Path $csvFilePath | Select-Object -ExpandProperty FileUrl
+
+
+# Specify the local directory to save the downloaded files
+$localDirectory = "C:\DownloadedFiles"
+if (-not (Test-Path -Path $localDirectory)) {
+    New-Item -ItemType Directory -Path $localDirectory
+}
+
+# Loop through each file URL, download, and save the file
+foreach ($fileUrl in $fileUrls) {
+    $fileName = [System.IO.Path]::GetFileName($fileUrl)
+    $localFilePath = Join-Path -Path $localDirectory -ChildPath $fileName
+
+    # Download the file
+    Get-PnPFile -Url $fileUrl -Path $localDirectory -Filename $fileName -AsFile
+}
+
+# Zip the downloaded files
+$zipFilePath = "C:\DownloadedFiles\files.zip"
+Compress-Archive -Path "$localDirectory\*" -DestinationPath $zipFilePath
+
+# Output the location of the zip file
+Write-Host "Files have been zipped to: $zipFilePath"
+
+# Disconnect SharePoint online connection
+Disconnect-PnPOnline
+
+```
+
+[!INCLUDE [More about PnP PowerShell](../../docfx/includes/MORE-PNPPS.md)]
+
+# [CLI for Microsoft 365](#tab/cli-m365-ps)
+
+```powershell
+
+# Connect to the SharePoint site
+$siteUrl = "https://[tenant].sharepoint.com/sites/[sitename]"
+
+# Get Credentials to connect
+$m365Status = m365 status
+if ($m365Status -match "Logged Out") {
+   m365 login
+}
+
+# Define the array of file URLs (relative to the site URL)
+# Option 1: with urls added in script
+$fileUrls = @(
+    "/sites/[sitename]/Shared Documents/Document.docx",
+    "/sites/[sitename]/Shared Documents/Book.xlsx"
+)
+
+# Option 2: with urls from a CSV file
+# CSV file should have a column named FileUrl
+# Example CSV file content:
+#
+# FileUrl
+# /sites/[sitename]/Shared Documents/file1.docx
+# /sites/[sitename]/Shared Documents/file2.pdf
+
+# Path to the CSV file
+# uncomment the line below and specify the path to your CSV file
+# $csvFilePath = "C:\path\to\your\file.csv"
+
+# Reading the file URLs from the CSV file
+# uncomment the line below if you want to read the file URLs from a CSV file
+# $fileUrls = Import-Csv -Path $csvFilePath | Select-Object -ExpandProperty FileUrl
+
+
+# Specify the local directory to save the downloaded files
+$localDirectory = "C:\DownloadedFiles"
+if (-not (Test-Path -Path $localDirectory)) {
+    New-Item -ItemType Directory -Path $localDirectory
+}
+
+# Loop through each file URL, download, and save the file
+foreach ($fileUrl in $fileUrls) {
+    $fileName = [System.IO.Path]::GetFileName($fileUrl)
+    $localFilePath = Join-Path -Path $localDirectory -ChildPath $fileName
+
+    # Download the file
+    m365 spo file get --webUrl $siteUrl --url $fileUrl --asFile --path $localFilePath
+}
+
+# Zip the downloaded files
+$zipFilePath = "C:\DownloadedFiles\files.zip"
+Compress-Archive -Path "$localDirectory\*" -DestinationPath $zipFilePath
+
+# Output the location of the zip file
+Write-Host "Files have been zipped to: $zipFilePath"
+
+# Disconnect SharePoint online connection
+m365 logout
+
+```
+
+[!INCLUDE [More about CLI for Microsoft 365](../../docfx/includes/MORE-CLIM365.md)]
+
+***
+
+## Contributors
+
+| Author(s) |
+|-----------|
+| [Valeras Narbutas](https://github.com/ValerasNarbutas) |
+
+[!INCLUDE [DISCLAIMER](../../docfx/includes/DISCLAIMER.md)]
+<img src="https://m365-visitor-stats.azurewebsites.net/script-samples/scripts/spo-download-files-and-archive" aria-hidden="true" />

scripts/spo-download-files-and-archive/assets/sample.json

@@ -0,0 +1,71 @@
+[
+  {
+    "name": "spo-download-files-and-archive",
+    "source": "pnp",
+    "title": "Download all files from array of documents urls and archive them",
+    "shortDescription": "The script downloads all files from array of documents urls and archive them to a zip file",
+    "url": "https://pnp.github.io/script-samples/spo-download-files-and-archive/README.html",
+    "longDescription": [
+      "Download all the files from array of documents urls and archive them to a zip file"
+    ],
+    "creationDateTime": "2024-02-01",
+    "updateDateTime": "2024-02-01",
+    "products": [
+      "SharePoint"
+    ],
+    "metadata": [
+      {
+        "key": "PNP-POWERSHELL",
+        "value": "2.2.1"
+      },
+      {
+          "key":"CLI-FOR-MICROSOFT365",
+          "value":"6.8.0"
+      }
+    ],
+    "categories": [
+      "Data"
+    ],
+    "tags": [
+      "Modern",
+      "Files",
+      "Documents",
+      "Connect-PnPOnline",
+      "Get-PnPList",
+      "Get-PnPFile",
+      "Disconnect-PnPOnline",
+      "m365 status",
+      "m365 login",
+      "m365 spo file get",
+      "m365 logout"
+    ],
+    "thumbnails": [
+      {
+        "type": "image",
+        "order": 100,
+        "url": "https://raw.githubusercontent.com/pnp/script-samples/main/scripts/spo-download-files-and-archive/assets/preview.png",
+        "alt": "preview image showing there is no preview"
+      }
+    ],
+    "authors": [
+      {
+        "gitHubAccount": "ValerasNarbutas",
+        "company": "",
+        "pictureUrl": "https://avatars.githubusercontent.com/u/16476453?v=4",
+        "name": "Valeras Narbutas"
+      }
+    ],
+    "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"
+      },
+      {
+          "name": "Want to learn more about CLI for Microsoft 365 and the commands",
+          "description": "Check out the CLI for Microsoft 365 site to get started and for the reference to the commands.",
+          "url": "https://aka.ms/cli-m365"
+      }
+    ]
+  }
+]