Send-RemoteItem.ps1
|
#Requires -Version 3 function Send-RemoteItem { <# .SYNOPSIS Uploads a file to the filesystem on the server or media library through a Sitecore PowerShell Extensions web service. .PARAMETER Path The source path of the item to upload on the client side. .PARAMETER Destination The destination path of the item on the server side. .PARAMETER RootPath The predefined directory in which the item will be uploaded to. This is simply a keyword that maps to a predefined location on the server side. When using this you can simply provide the file or media item name in the Destination parameter. .PARAMETER SkipUnpack The compressed archive should not be unpacked during the upload process. This is a dynamic parameter that appears when RootPath is 'Media'. .PARAMETER SkipExisting Any existing items should not be overwritten. .EXAMPLE The following uploads a file to the root application path. $session = New-ScriptSession -Username admin -Password b -ConnectionUri http://remotesitecore Get-Item -Path C:\temp\data.xml | Send-RemoteItem @props -RootPath App .EXAMPLE The following uploads the image to the media library with the specified name. $session = New-ScriptSession -Username admin -Password b -ConnectionUri http://remotesitecore Get-Item -Path C:\image.png | Send-RemoteItem -Session $session -RootPath Media -Destination "Images/image2.png" .EXAMPLE The following uploads the image to the media library updating the item with the specified Id.. $session = New-ScriptSession -Username admin -Password b -ConnectionUri http://remotesitecore Get-Item -Path C:\temp\cover.jpg | Send-RemoteItem -Session $session -Destination "{04DAD0FD-DB66-4070-881F-17264CA257E1}" .EXAMPLE The following uploads a file to the specified absolute path. $session = New-ScriptSession -Username admin -Password b -ConnectionUri http://remotesitecore Send-RemoteItem -Session $session -Path "C:\temp\data.xml" -Destination "C:\inetpub\wwwroot\Console\Website\upload\data1.xml" .EXAMPLE The following uploads a compressed archive to the the media library and skips unpacking. Compress-Archive -Path C:\temp\kittens -DestinationPath C:\temp\kittens.zip $session = New-ScriptSession -Username admin -Password b -ConnectionUri http://remotesitecore Get-Item -Path C:\temp\kittens.zip | Send-RemoteItem @props -RootPath Media -Destination "Images/" -SkipUnpack .LINK Receive-RemoteItem .LINK New-ScriptSession .LINK Stop-ScriptSession #> [CmdletBinding(DefaultParameterSetName='Uri')] param( [Parameter(Mandatory=$true, ParameterSetName='Session')] [ValidateNotNull()] [pscustomobject]$Session, [Parameter(ParameterSetName='Uri')] [Uri[]]$ConnectionUri, [Parameter(ParameterSetName='Uri')] [string]$Username, [Parameter(ParameterSetName='Uri')] [string]$Password, [Parameter(ParameterSetName='Uri')] [System.Management.Automation.PSCredential] $Credential, [Parameter(Mandatory=$true, ValueFromPipeline=$true, ValueFromPipelineByPropertyName = $true)] [ValidateNotNullOrEmpty()] [Alias("FullName")] [string]$Path, [Parameter(ParameterSetName='Session')] [Parameter(ParameterSetName='Uri')] [ValidateSet("App", "Data", "Debug", "Index", "Layout", "Log", "Media", "Package", "Serialization", "Temp")] [ValidateNotNullOrEmpty()] [string]$RootPath, [string]$Destination ) dynamicparam { if ($RootPath -eq "Media") { $paramDictionary = New-Object System.Management.Automation.RuntimeDefinedParameterDictionary $skipUnpackAttribute = New-Object System.Management.Automation.ParameterAttribute $skipUnpackAttributeCollection = New-Object System.Collections.ObjectModel.Collection[System.Attribute] $skipUnpackAttributeCollection.Add($skipUnpackAttribute) $skipUnpackParam = New-Object System.Management.Automation.RuntimeDefinedParameter('SkipUnpack', [switch], $skipUnpackAttributeCollection) $paramDictionary.Add('SkipUnpack', $skipUnpackParam) $skipExistingAttribute = New-Object System.Management.Automation.ParameterAttribute $skipExistingAttributeCollection = New-Object System.Collections.ObjectModel.Collection[System.Attribute] $skipExistingAttributeCollection.Add($skipExistingAttribute) $skipExistingParam = New-Object System.Management.Automation.RuntimeDefinedParameter('SkipExisting', [switch], $skipExistingAttributeCollection) $paramDictionary.Add('SkipExisting', $skipExistingParam) return $paramDictionary } } process { $mediaId = [guid]::Empty $isMediaItem = $RootPath -eq "Media" -or [guid]::TryParse($Destination, [ref]$mediaId) if(!$isMediaItem -and (!$RootPath -and ![System.IO.Path]::IsPathRooted($Destination))) { Write-Error -Message "RootPath is required when Destination is not fully qualified." -ErrorAction Stop } $Destination = $Destination.TrimEnd('\','/') $output = $Destination if($mediaId -eq [guid]::Empty) { $extension = [System.IO.Path]::GetExtension($Path) if(!$output.EndsWith($extension)) { if(!$output.EndsWith("/") -and !$output.EndsWith("\")) { $output += "/" } $output += [System.IO.Path]::GetFileName($Path) } } if($Session) { $Username = $Session.Username $Password = $Session.Password $Credential = $Session.Credential $ConnectionUri = $Session | ForEach-Object { $_.Connection.BaseUri } } $serviceUrl = "/-/script" if($isMediaItem) { $serviceUrl += "/media/master/" + $output + "/?" } else { $serviceUrl += "/file/" + $RootPath + "/?path=" + $output + "&" } $serviceUrl += "user=" + $Username + "&password=" + $Password if($PSBoundParameters.SkipUnpack.IsPresent) { $serviceUrl += "&skipunpack=true" } if($PSBoundParameters.SkipExisting.IsPresent) { $serviceUrl += "&skipexisting=true" } foreach($uri in $ConnectionUri) { # http://hostname/-/script/type/origin/location $url = $uri.AbsoluteUri.TrimEnd("/") + $serviceUrl Write-Verbose -Message "Preparing to upload local item to the remote url $($url)" $webclient = New-Object System.Net.WebClient if($Credential) { $webclient.Credentials = $Credential } Write-Host $serviceUrl [byte[]]$response = & { try { Write-Verbose -Message "Uploading $($Path)" [System.Net.HttpWebResponse]$script:errorResponse = $null; New-UsingBlock($fileStream = ([System.IO.FileInfo] (Get-Item -Path $Path)).OpenRead()) { $bytes = New-Object byte[] 1024 $totalBytesToRead = $fileStream.Length $bytesRead = 0 $bytesToRead = $bytes.Length if($totalBytesToRead - $bytesToRead -lt $bytes.Length) { $bytesToRead = $totalBytesToRead - $bytesRead } $bytes = New-Object byte[] $bytesToRead New-UsingBlock($webStream = $webclient.OpenWrite($url)) { while(($bytesToRead = $fileStream.Read($bytes, 0, $bytes.Length)) -gt 0) { $webStream.Write($bytes, 0, $bytes.Length) $bytesRead += $bytes.Length if($totalBytesToRead - $bytesRead -lt $bytes.Length) { $bytesToRead = $totalBytesToRead - $bytesRead } $bytes = New-Object byte[] $bytesToRead } $webStream.Close() $fileStream.Close() Write-Verbose -Message "Upload complete." } } } catch [System.Net.WebException] { [System.Net.WebException]$script:ex = $_.Exception [System.Net.HttpWebResponse]$script:errorResponse = $ex.Response Write-Verbose -Message "Response exception message: $($ex.Message)" Write-Verbose -Message "Response status description: $($errorResponse.StatusDescription)" if($errorResponse.StatusCode -eq [System.Net.HttpStatusCode]::Forbidden) { Write-Verbose -Message "Check that the proper credentials are provided and that the service configurations are enabled." } elseif ($errorResponse.StatusCode -eq [System.Net.HttpStatusCode]::NotFound){ Write-Verbose -Message "Check that the service files exist and are properly configured." } } } if($errorResponse){ Write-Error -Message "Server responded with error: $($errorResponse.StatusDescription)" -Category ConnectionError ` -CategoryActivity "Download" -CategoryTargetName $uri -Exception ($script:ex) -CategoryReason "$($errorResponse.StatusCode)" -CategoryTargetType $RootPath } } } } |