src/REST/RestRequest.ps1
|
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 |
# Copyright 2018, Adam Edwards # # Licensed under the Apache License, Version 2.0 (the "License"); # you may not use this file except in compliance with the License. # You may obtain a copy of the License at # # http://www.apache.org/licenses/LICENSE-2.0 # # Unless required by applicable law or agreed to in writing, software # distributed under the License is distributed on an "AS IS" BASIS, # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. # See the License for the specific language governing permissions and # limitations under the License. . (import-script RESTResponse) . (import-script ../common/PreferenceHelper) ScriptClass RESTRequest { const PoshGraphUserAgent 'PoshGraph/0.1 (Windows NT; Windows NT 10.0; en-US)' $uri = strict-val [Uri] $headers = strict-val [HashTable] $method = strict-val [String] $body = $null $userAgent = $PoshGraphUserAgent function __initialize([Uri] $uri, $method = "GET", [HashTable] $headers = @{}, $body = $null, $userAgent = $null) { $this.headers = $headers $this.method = $method $this.uri = $uri $this.body = if ( $body -eq $null ) { $null } elseif ( $body -is [String] ) { $body | convertfrom-json | out-null $body } else { $body | convertto-json } $this.userAgent = if ( $userAgent -ne $null ) { $this.userAgent = $userAgent } } function Invoke { [cmdletbinding(SupportsShouldProcess=$true)] param() if ($pscmdlet.shouldprocess($this.uri, $this.method)) { # Disable progress display $progresspreference = 'SilentlyContinue' $optionalArguments = if ( $this.body -ne $null -and $this.body.length -gt 0 ) { @{body=$this.body} } else { @{} } if ( $this.headers -ne $null ) { write-verbose "Request Headers:" $this.headers.keys | foreach { $outputValue = if ( $_ -ne 'Authorization' ) { $this.headers[$_] } else { '<authtoken>' } } _write-headersverbose $this.headers (@{Authorization='<redacted authtoken>'}) } write-verbose "Request Body: `n`n$($this.body)`n`n" $httpResponse = try { Invoke-WebRequest -Uri $this.uri -headers $this.headers -method $this.method -useragent $this.userAgent -usebasicparsing @optionalArguments } catch [System.Net.WebException] { $response = $_.exception.response $responseStream = ($::.RestResponse |=> GetErrorResponseDetails $response) $responseOutput = if ( $responseStream -ne $null -and $responseStream.length -gt 0 ) { $responseStream } else { # Sometimes the response stream has already been read and the value # can be obtained from the error record's ToString() $_.ToString() } _write-responseverbose $response $responseOutput write-error -message $responseStream -targetobject ([PSCustomObject] @{CustomTypeName='RESTException';PSErrorRecord=$_;ResponseStream=$responseStream}) -erroraction silentlycontinue throw } _write-responseverbose $httpResponse $httpResponse.rawContent new-so RESTResponse $httpResponse } else { [PSCustomObject] @{PSTypeName='RESTResponse'} } } function _write-headersverbose( $headers, $substitutions = @{} ) { if ( $headers -ne $null ) { $headerOutput = @{} $headers.keys | foreach { $headerOutput[$_] = if ( ! $substitutions.containskey($_) ) { $headers[$_] } else { $substitutions[$_] } } ([PSCustomObject] $headerOutput) | fl | out-string | write-verbose } } function _write-responseverbose( $response, $content ) { write-verbose ' ' write-verbose 'Response:' write-verbose '********' if ( $response -ne $null ) { $response | out-string | write-verbose } else { write-verbose 'No response.' } write-verbose ' ' write-verbose 'Response Detail:' write-verbose "***************" $bodyTruncated = $false $bodyLength = 0 $truncationSize = 1024 $contentString = if ( $VerbosePreference -ne 'SilentlyContinue' ) { $fullOutput = ($content | out-string) $bodyLength = $fullOutput.length if ( ($GraphVerboseOutputPreference -ne 'High') -and ($fullOutput.length -gt $truncationSize) ) { $bodyTruncated = $true $fullOutput.SubString(0, 512) } else { $fullOutput } } $bodyLines = @("`n`n") $bodyLines += $contentString $bodyLines += @("`n`n") (-join $bodyLines) | write-verbose if ( $bodyTruncated ) { write-verbose "***Above response of length $bodyLength characters truncated to $truncationSize characters***" write-verbose "***To disable truncation and see full response,***" write-verbose "**set `$GraphVerboseOutputPreference to the value 'High'**" } write-verbose ' ' write-verbose "Response Headers:" write-verbose "****************`n" if ( $response -ne $null ) { _write-headersverbose $response.headers } } } |