diff --git a/CHANGELOG.md b/CHANGELOG.md index 075d30f0c..a4af6a0aa 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -17,6 +17,7 @@ The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/). - Added `-UseVersionExpirationReport` parameter to `Get-PnPFileVersion` cmdlet to get the version expiration report for a single file. [#3799](https://github.com/pnp/powershell/pull/3799) - Added `-DelayDenyAddAndCustomizePagesEnforcement` parameter to `Set-PnPTenant` cmdlet which allows delay of the change to custom script set on the Tenant until mid-November 2024. [#3815](https://github.com/pnp/powershell/pull/3815) - Added additional permissions for Graph application permission validate sets. [#3835](https://github.com/pnp/powershell/issues/3835) +- Added the ability to upload entire local folders with files and optionally subfolders to SharePoint Online into 'Copy-PnPFolder' ### Fixed diff --git a/documentation/Copy-PnPFolder.md b/documentation/Copy-PnPFolder.md index dc41eba01..3302f7c3b 100644 --- a/documentation/Copy-PnPFolder.md +++ b/documentation/Copy-PnPFolder.md @@ -10,21 +10,34 @@ title: Copy-PnPFolder # Copy-PnPFolder ## SYNOPSIS -Copies a folder or file to a different location +Copies a folder or file to a different location within SharePoint Online or allows uploading of an entire local folder with optionally subfolders to SharePoint Online. + +### Copy files within Microsoft 365 + +## SYNTAX + +```powershell +Copy-PnPFolder -SourceUrl -TargetUrl [-Overwrite] [-Force] [-IgnoreVersionHistory] [-NoWait] [-Connection ] + +``` + +### Copy files from local to Microsoft 365 ## SYNTAX ```powershell -Copy-PnPFolder [-SourceUrl] [-TargetUrl] [-Overwrite] [-Force] [-IgnoreVersionHistory] [-NoWait] [-Connection ] +Copy-PnPFolder -LocalPath -TargetUrl [-Overwrite [-Recurse] [-RemoveAfterCopy] [-Connection ] ``` ## DESCRIPTION -Copies a folder or file to a different location. This location can be within the same document library, same site, same site collection or even to another site collection on the same tenant. Notice that if copying between sites or to a subsite you cannot specify a target filename, only a folder name. +Copies a folder or file to a different location within SharePoiint. This location can be within the same document library, same site, same site collection or even to another site collection on the same tenant. Notice that if copying between sites or to a subsite you cannot specify a target filename, only a folder name. Copying files and folders is bound to some restrictions. You can find more on it here: https://learn.microsoft.com/office365/servicedescriptions/sharepoint-online-service-description/sharepoint-online-limits#moving-and-copying-across-sites +It can also accommodate copying an entire folder with all its files and optionally even subfolders and files from a local path onto SharePoint Online. + ## EXAMPLES ### EXAMPLE 1 @@ -109,6 +122,13 @@ if($jobStatus.JobState == 0) Copies a file named company.docx from the current document library to the documents library in SubSite2. It will not wait for the action to return but returns job information instead. The Receive-PnPCopyMoveJobStatus cmdlet will return the job status. +### EXAMPLE 12 +```powershell +Copy-PnPFolder -LocalPath "c:\temp" -TargetUrl "Subsite1/Shared Documents" -Recurse -Overwrite +``` + +Copies all the files and underlying folders from the local folder c:\temp to the document library Shared Documents in Subsite1. If a file already exists, it will be overwritten. + ## PARAMETERS ### -Force @@ -116,7 +136,7 @@ If provided, no confirmation will be requested and the action will be performed ```yaml Type: SwitchParameter -Parameter Sets: (All) +Parameter Sets: WITHINM365 Required: False Position: Named @@ -130,7 +150,7 @@ If provided, only the latest version of the document will be copied and its hist ```yaml Type: SwitchParameter -Parameter Sets: (All) +Parameter Sets: WITHINM365 Required: False Position: Named @@ -140,7 +160,7 @@ Accept wildcard characters: False ``` ### -Overwrite -If provided, if a file already exists at the TargetUrl, it will be overwritten. If omitted, the copy operation will be canceled if the file already exists at the TargetUrl location. +If provided, if a file already exists at the TargetUrl, it will be overwritten. If omitted, the copy operation will be canceled if the file already exists at the TargetUrl location when copying between two locations on SharePoint Online. If copying files from a local path to SharePoint Online, it will skip any file that already exists and still continue with the next one. ```yaml Type: SwitchParameter @@ -158,7 +178,7 @@ Site or server relative URL specifying the file or folder to copy. Must include ```yaml Type: String -Parameter Sets: (All) +Parameter Sets: WITHINM365 Aliases: SiteRelativeUrl, ServerRelativeUrl Required: True @@ -188,7 +208,35 @@ If specified the task will return immediately after creating the copy job. The c ```yaml Type: SwitchParameter -Parameter Sets: (All) +Parameter Sets: WITHINM365 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Recurse +When copying files from a local folder to SharePoint Online, this parameter will copy all files and folders within the local folder and all of its subfolders as well. + +```yaml +Type: SwitchParameter +Parameter Sets: FROMLOCAL + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RemoveAfterCopy +When copying files from a local folder to SharePoint Online, this parameter will remove all files locally that have successfully been uploaded to SharePoint Online. If a file fails, it will not be removed locally. Local folders will never be removed. + +```yaml +Type: SwitchParameter +Parameter Sets: FROMLOCAL Required: False Position: Named diff --git a/src/Commands/Files/CopyFile.cs b/src/Commands/Files/CopyFile.cs index 12dc64ca6..bc2e6d9b6 100644 --- a/src/Commands/Files/CopyFile.cs +++ b/src/Commands/Files/CopyFile.cs @@ -7,7 +7,6 @@ namespace PnP.PowerShell.Commands.Files { - [Alias("Copy-PnPFolder")] [Cmdlet(VerbsCommon.Copy, "PnPFile")] public class CopyFile : PnPWebCmdlet { diff --git a/src/Commands/Files/CopyFolder.cs b/src/Commands/Files/CopyFolder.cs new file mode 100644 index 000000000..34f359d77 --- /dev/null +++ b/src/Commands/Files/CopyFolder.cs @@ -0,0 +1,257 @@ +using System; +using System.Linq; +using System.Management.Automation; +using Microsoft.SharePoint.Client; +using Resources = PnP.PowerShell.Commands.Properties.Resources; +using PnP.Framework.Utilities; + +namespace PnP.PowerShell.Commands.Files +{ + [Cmdlet(VerbsCommon.Copy, "PnPFolder", DefaultParameterSetName = ParameterSet_WITHINM365)] + public class CopyFolder : PnPWebCmdlet + { + private const string ParameterSet_WITHINM365 = "Copy files within Microsoft 365"; + private const string ParameterSet_FROMLOCAL = "Copy files from local to Microsoft 365"; + + [Parameter(Mandatory = true, Position = 0, ValueFromPipeline = true, ParameterSetName = ParameterSet_WITHINM365)] + [Alias("ServerRelativeUrl")] + public string SourceUrl = string.Empty; + + [Parameter(Mandatory = true, Position = 0, ParameterSetName = ParameterSet_FROMLOCAL)] + public string LocalPath = string.Empty; + + [Parameter(Mandatory = true, Position = 1, ParameterSetName = ParameterSet_WITHINM365)] + [Parameter(Mandatory = true, Position = 1, ParameterSetName = ParameterSet_FROMLOCAL)] + [Alias("TargetServerRelativeUrl")] + public string TargetUrl = string.Empty; + + [Parameter(Mandatory = false, ParameterSetName = ParameterSet_WITHINM365)] + [Parameter(Mandatory = false, ParameterSetName = ParameterSet_FROMLOCAL)] + [Alias("OverwriteIfAlreadyExists")] + public SwitchParameter Overwrite; + + [Parameter(Mandatory = false, ParameterSetName = ParameterSet_WITHINM365)] + [Parameter(Mandatory = false, ParameterSetName = ParameterSet_FROMLOCAL)] + public SwitchParameter Force; + + [Parameter(Mandatory = false, ParameterSetName = ParameterSet_WITHINM365)] + public SwitchParameter IgnoreVersionHistory; + + [Parameter(Mandatory = false, ParameterSetName = ParameterSet_WITHINM365)] + public SwitchParameter AllowSchemaMismatch; + + [Parameter(Mandatory = false, ParameterSetName = ParameterSet_WITHINM365)] + public SwitchParameter NoWait; + + [Parameter(Mandatory = false, ParameterSetName = ParameterSet_FROMLOCAL)] + public SwitchParameter Recurse; + + [Parameter(Mandatory = false, ParameterSetName = ParameterSet_FROMLOCAL)] + public SwitchParameter RemoveAfterCopy; + + protected override void ExecuteCmdlet() + { + var webServerRelativeUrl = CurrentWeb.EnsureProperty(w => w.ServerRelativeUrl); + + switch(ParameterSetName) + { + case ParameterSet_FROMLOCAL: + // Copy a folder from local to Microsoft 365 + CopyFromLocalToMicrosoft365(); + break; + + case ParameterSet_WITHINM365: + // Copy a folder within Microsoft 365 + CopyWithinMicrosoft365(); + break; + } + } + + /// + /// Copies a folder from local to Microsoft 365 + /// + private void CopyFromLocalToMicrosoft365() + { + if (TargetUrl.StartsWith("https://", StringComparison.InvariantCultureIgnoreCase)) + { + // Remove the server part from the full FQDN making it server relative + TargetUrl = TargetUrl[8..]; + TargetUrl = TargetUrl[TargetUrl.IndexOf('/')..]; + } + + if (!TargetUrl.StartsWith("https://", StringComparison.InvariantCultureIgnoreCase) && TargetUrl.StartsWith(CurrentWeb.ServerRelativeUrl, StringComparison.InvariantCultureIgnoreCase)) + { + // Remove the server relative path making it web relative + TargetUrl = TargetUrl[CurrentWeb.ServerRelativeUrl.Length..]; + } + + if (!System.IO.Path.IsPathRooted(LocalPath)) + { + LocalPath = System.IO.Path.Combine(SessionState.Path.CurrentFileSystemLocation.Path, LocalPath); + } + + // Normalize the path, taking out relative links and such to make it more readable + LocalPath = System.IO.Path.GetFullPath(new Uri(LocalPath).LocalPath); + + if (!System.IO.Directory.Exists(LocalPath)) + { + throw new PSArgumentException($"{nameof(LocalPath)} does not exist", nameof(LocalPath)); + } + + WriteVerbose($"Copying folder from local path {LocalPath} to Microsoft 365 location {UrlUtility.Combine(CurrentWeb.ServerRelativeUrl, TargetUrl)}"); + + // Ensure the destination folder exists on Microsoft 365 + //WriteVerbose($"Ensuring Microsoft 365 location {TargetUrl} exists"); + //var folder = CurrentWeb.EnsureFolderPath(TargetUrl); + + WriteVerbose($"Retrieving local files {(Recurse.ToBool() ? "recursively " : "")}to upload from {LocalPath}"); + var filesToCopy = System.IO.Directory.GetFiles(LocalPath, string.Empty, Recurse.ToBool() ? System.IO.SearchOption.AllDirectories : System.IO.SearchOption.TopDirectoryOnly); + + WriteVerbose($"Uploading {filesToCopy.Length} file{(filesToCopy.Length != 1 ? "s" : "")}"); + + // Start with the root + string currentRemotePath = null; + Folder folder = null; + + foreach(var fileToCopy in filesToCopy) + { + var fileName = System.IO.Path.GetFileName(fileToCopy); + var relativeLocalPathWithFileName = System.IO.Path.GetRelativePath(LocalPath, fileToCopy); + var relativePath = relativeLocalPathWithFileName.Remove(relativeLocalPathWithFileName.Length - fileName.Length); + + // Check if we're dealing with a different subfolder now as we did during the previous cycle + if(relativePath != currentRemotePath) + { + // New subfolder, ensure the folder exists remotely as well + currentRemotePath = relativePath; + + var newRemotePath = UrlUtility.Combine(TargetUrl, relativePath); + + WriteVerbose($"* Ensuring remote folder {newRemotePath}"); + + folder = CurrentWeb.EnsureFolderPath(newRemotePath); + } + + // Upload the file from local to remote + WriteVerbose($" * Uploading {fileToCopy} => {relativeLocalPathWithFileName}"); + try + { + folder.UploadFile(fileName, fileToCopy, Overwrite.ToBool()); + + if(RemoveAfterCopy.ToBool()) + { + WriteVerbose($" * Removing {fileToCopy}"); + System.IO.File.Delete(fileToCopy); + } + } + catch(Exception ex) + { + WriteWarning($"* Upload failed: {ex.Message}"); + } + } + } + + /// + /// Copies a folder within Microsoft 365 + /// + private void CopyWithinMicrosoft365() + { + if (!TargetUrl.StartsWith("https://", StringComparison.InvariantCultureIgnoreCase) && !TargetUrl.StartsWith("/")) + { + TargetUrl = UrlUtility.Combine(CurrentWeb.ServerRelativeUrl, TargetUrl); + } + + if (!SourceUrl.StartsWith("/")) + { + SourceUrl = UrlUtility.Combine(CurrentWeb.ServerRelativeUrl, SourceUrl); + } + + WriteVerbose($"Copying folder within Microsoft 365 from {SourceUrl} to {TargetUrl}"); + + string sourceFolder = SourceUrl.Substring(0, SourceUrl.LastIndexOf('/')); + string targetFolder = TargetUrl; + if (System.IO.Path.HasExtension(TargetUrl)) + { + targetFolder = TargetUrl[..TargetUrl.LastIndexOf('/')]; + } + Uri currentContextUri = new(ClientContext.Url); + Uri sourceUri = new(currentContextUri, EncodePath(sourceFolder)); + Uri sourceWebUri = Web.WebUrlFromFolderUrlDirect(ClientContext, sourceUri); + Uri targetUri = new(currentContextUri, EncodePath(targetFolder)); + Uri targetWebUri; + if (TargetUrl.StartsWith("https://", StringComparison.InvariantCultureIgnoreCase)) + { + targetUri = new Uri(TargetUrl); + targetWebUri = targetUri; + } + else + { + targetWebUri = Microsoft.SharePoint.Client.Web.WebUrlFromFolderUrlDirect(ClientContext, targetUri); + } + + if (Force || ShouldContinue(string.Format(Resources.CopyFile0To1, SourceUrl, TargetUrl), Resources.Confirm)) + { + if (sourceWebUri != targetWebUri) + { + Copy(currentContextUri, sourceUri, targetUri, SourceUrl, TargetUrl, false, NoWait); + } + else + { + var isFolder = false; + try + { + var folder = CurrentWeb.GetFolderByServerRelativePath(ResourcePath.FromDecodedUrl(TargetUrl)); + var folderServerRelativePath = folder.EnsureProperty(f => f.ServerRelativePath); + isFolder = folderServerRelativePath.DecodedUrl == ResourcePath.FromDecodedUrl(TargetUrl).DecodedUrl; + } + catch + { + } + if (isFolder) + { + Copy(currentContextUri, sourceUri, targetUri, SourceUrl, TargetUrl, true, NoWait); + } + else + { + var file = CurrentWeb.GetFileByServerRelativePath(ResourcePath.FromDecodedUrl(SourceUrl)); + file.CopyToUsingPath(ResourcePath.FromDecodedUrl(TargetUrl), Overwrite); + ClientContext.ExecuteQueryRetry(); + } + } + } + } + + private string EncodePath(string path) + { + var parts = path.Split("/"); + return string.Join("/", parts.Select(p => Uri.EscapeDataString(p))); + } + + private void Copy(Uri currentContextUri, Uri source, Uri destination, string sourceUrl, string targetUrl, bool sameWebCopyMoveOptimization, bool noWait) + { + if (!sourceUrl.StartsWith(source.ToString())) + { + sourceUrl = $"{source.Scheme}://{source.Host}/{sourceUrl.TrimStart('/')}"; + } + if (!targetUrl.StartsWith("https://", StringComparison.InvariantCultureIgnoreCase) && !targetUrl.StartsWith(destination.ToString())) + { + targetUrl = $"{destination.Scheme}://{destination.Host}/{targetUrl.TrimStart('/')}"; + } + var results = Utilities.CopyMover.CopyAsync(HttpClient, ClientContext, currentContextUri, sourceUrl, targetUrl, IgnoreVersionHistory, Overwrite, AllowSchemaMismatch, sameWebCopyMoveOptimization, false, noWait).GetAwaiter().GetResult(); + if (NoWait) + { + WriteObject(results.jobInfo); + } + else + { + foreach (var log in results.logs) + { + if (log.Event == "JobError") + { + WriteObject(log); + } + } + } + } + } +}