/
api-response.go
executable file
·323 lines (273 loc) · 9.34 KB
/
api-response.go
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
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
/*
* Minio Cloud Storage, (C) 2015, 2016 Minio, Inc.
*
* 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.
*/
package api
import (
"encoding/xml"
"net/http"
"path"
"time"
"net/url"
"strconv"
. "github.com/journeymidnight/yig/api/datatype"
. "github.com/journeymidnight/yig/error"
"github.com/journeymidnight/yig/helper"
"github.com/journeymidnight/yig/iam/common"
meta "github.com/journeymidnight/yig/meta/types"
)
const (
timeFormatAMZ = "2006-01-02T15:04:05.000Z" // Reply date format
)
// DeleteObjectsResponse container for multiple object deletes.
type DeleteObjectsResponse struct {
XMLName xml.Name `xml:"http://s3.amazonaws.com/doc/2006-03-01/ DeleteResult" json:"-"`
// Collection of all deleted objects
DeletedObjects []ObjectIdentifier `xml:"Deleted,omitempty"`
// Collection of errors deleting certain objects.
Errors []DeleteError `xml:"Error,omitempty"`
}
// getLocation get URL location.
func GetLocation(r *http.Request) string {
return path.Clean(r.URL.Path) // Clean any trailing slashes.
}
// getObjectLocation gets the relative URL for an object
func GetObjectLocation(bucketName string, key string) string {
return "/" + bucketName + "/" + key
}
// Takes an array of Bucket metadata information for serialization
// input: array of bucket metadata
// output: populated struct that can be serialized to match xml and json api spec output
func GenerateListBucketsResponse(buckets []meta.Bucket, credential common.Credential) ListBucketsResponse {
var listBuckets []Bucket
var data = ListBucketsResponse{}
var owner = Owner{}
owner.ID = credential.UserId
owner.DisplayName = credential.DisplayName
for _, bucket := range buckets {
var listbucket = Bucket{}
listbucket.Name = bucket.Name
listbucket.CreationDate = bucket.CreateTime.Format(timeFormatAMZ)
listBuckets = append(listBuckets, listbucket)
}
data.Owner = owner
data.Buckets.Buckets = listBuckets
return data
}
// generates an ListObjects response for the said bucket with other enumerated options.
func GenerateListObjectsResponse(bucketName string, request ListObjectsRequest,
objectsInfo meta.ListObjectsInfo) (response ListObjectsResponse) {
response.Contents = objectsInfo.Objects
var prefixes []CommonPrefix
for _, prefix := range objectsInfo.Prefixes {
item := CommonPrefix{
Prefix: prefix,
}
prefixes = append(prefixes, item)
}
response.CommonPrefixes = prefixes
response.Delimiter = request.Delimiter
response.EncodingType = request.EncodingType
response.IsTruncated = objectsInfo.IsTruncated
response.MaxKeys = request.MaxKeys
response.Prefix = request.Prefix
response.BucketName = bucketName
if request.Version == 2 {
response.KeyCount = len(response.Contents)
response.ContinuationToken = request.ContinuationToken
response.NextContinuationToken = objectsInfo.NextMarker
response.StartAfter = request.StartAfter
} else { // version 1
response.Marker = request.Marker
response.NextMarker = objectsInfo.NextMarker
}
if request.EncodingType != "" {
response.Delimiter = url.QueryEscape(response.Delimiter)
response.Prefix = url.QueryEscape(response.Prefix)
response.StartAfter = url.QueryEscape(response.StartAfter)
response.Marker = url.QueryEscape(response.Marker)
}
return
}
func GenerateVersionedListObjectResponse(bucketName string, request ListObjectsRequest,
objectsInfo meta.VersionedListObjectsInfo) (response VersionedListObjectsResponse) {
response.Contents = objectsInfo.Objects
var prefixes []CommonPrefix
for _, prefix := range objectsInfo.Prefixes {
item := CommonPrefix{
Prefix: prefix,
}
prefixes = append(prefixes, item)
}
response.CommonPrefixes = prefixes
response.Delimiter = request.Delimiter
response.EncodingType = request.EncodingType
response.IsTruncated = objectsInfo.IsTruncated
response.MaxKeys = request.MaxKeys
response.KeyCount = len(response.Contents)
response.Prefix = request.Prefix
response.BucketName = bucketName
response.KeyMarker = request.KeyMarker
response.NextKeyMarker = objectsInfo.NextKeyMarker
response.VersionIdMarker = request.VersionIdMarker
response.NextVersionIdMarker = objectsInfo.NextVersionIdMarker
if request.EncodingType != "" {
response.KeyMarker = url.QueryEscape(response.KeyMarker)
response.Delimiter = url.QueryEscape(response.Delimiter)
}
return
}
// GenerateCopyObjectResponse
func GenerateCopyObjectResponse(etag string, lastModified time.Time) CopyObjectResponse {
return CopyObjectResponse{
ETag: "\"" + etag + "\"",
LastModified: lastModified.UTC().Format(timeFormatAMZ),
}
}
func GenerateCopyObjectPartResponse(etag string, lastModified time.Time) CopyObjectPartResponse {
return CopyObjectPartResponse{
LastModified: lastModified.UTC().Format(timeFormatAMZ),
ETag: "\"" + etag + "\"",
}
}
// GenerateRenameObjectResponse
func GenerateRenameObjectResponse(lastModified time.Time) RenameObjectResponse {
return RenameObjectResponse{
LastModified: lastModified.UTC().Format(timeFormatAMZ),
}
}
// GenerateInitiateMultipartUploadResponse
func GenerateInitiateMultipartUploadResponse(bucket, key, uploadID string) InitiateMultipartUploadResponse {
return InitiateMultipartUploadResponse{
Bucket: bucket,
Key: key,
UploadID: uploadID,
}
}
// GenerateCompleteMultipartUploadResponse
func GenerateCompleteMultpartUploadResponse(bucket, key, location, etag string) CompleteMultipartUploadResponse {
return CompleteMultipartUploadResponse{
Location: location,
Bucket: bucket,
Key: key,
ETag: etag,
}
}
// generate multi objects delete response.
func GenerateMultiDeleteResponse(quiet bool, deletedObjects []ObjectIdentifier, errs []DeleteError) DeleteObjectsResponse {
deleteResp := DeleteObjectsResponse{}
if !quiet {
deleteResp.DeletedObjects = deletedObjects
}
deleteResp.Errors = errs
return deleteResp
}
// WriteSuccessResponse write success headers and response if any.
func WriteSuccessResponse(w http.ResponseWriter, response []byte) {
if response == nil {
w.WriteHeader(http.StatusOK)
return
}
//ResponseRecorder
w.(*ResponseRecorder).status = http.StatusOK
w.(*ResponseRecorder).size = int64(len(response))
w.Header().Set("Content-Length", strconv.Itoa(len(response)))
w.WriteHeader(http.StatusOK)
w.Write(response)
w.(http.Flusher).Flush()
}
// writeSuccessNoContent write success headers with http status 204
func WriteSuccessNoContent(w http.ResponseWriter) {
w.WriteHeader(http.StatusNoContent)
}
// writeErrorResponse write error headers
func WriteErrorResponse(w http.ResponseWriter, r *http.Request, err error) {
handled := WriteErrorResponseHeaders(w, r, err)
if !handled {
WriteErrorResponseNoHeader(w, r, err, r.URL.Path)
}
}
func WriteErrorResponseWithResource(w http.ResponseWriter, r *http.Request, err error, resource string) {
handled := WriteErrorResponseHeaders(w, r, err)
if !handled {
WriteErrorResponseNoHeader(w, r, err, resource)
}
}
func WriteErrorResponseHeaders(w http.ResponseWriter, r *http.Request, err error) (handled bool) {
ctx := getRequestContext(r)
logger := ctx.Logger
var status int
apiErrorCode, ok := err.(ApiError)
if ok {
status = apiErrorCode.HttpStatusCode()
} else {
status = http.StatusInternalServerError
}
logger.Info("Response status code:", status, "err:", err)
// ResponseRecorder
w.(*ResponseRecorder).status = status
// check website routing rules
if ctx.BucketInfo == nil {
w.WriteHeader(status)
return false
}
website := ctx.BucketInfo.Website
// match routing rules
if len(website.RoutingRules) != 0 {
for _, rule := range website.RoutingRules {
// If the condition matches, handle redirect
if rule.Match(ctx.ObjectName, strconv.Itoa(status)) {
rule.DoRedirect(w, r, ctx.ObjectName)
return true
}
}
}
w.WriteHeader(status)
return false
}
func WriteErrorResponseNoHeader(w http.ResponseWriter, req *http.Request, err error, resource string) {
// HEAD should have no body, do not attempt to write to it
if req.Method == "HEAD" {
return
}
// Generate error response.
errorResponse := ApiErrorResponse{}
apiErrorCode, ok := err.(ApiError)
if ok {
errorResponse.AwsErrorCode = apiErrorCode.AwsErrorCode()
errorResponse.Message = apiErrorCode.Description()
} else {
errorResponse.AwsErrorCode = "InternalError"
errorResponse.Message = "We encountered an internal error, please try again."
}
errorResponse.Resource = resource
errorResponse.RequestId = getRequestContext(req).RequestID
errorResponse.HostId = helper.CONFIG.InstanceId
encodedErrorResponse := EncodeResponse(errorResponse)
// ResponseRecorder
w.(*ResponseRecorder).size = int64(len(encodedErrorResponse))
w.Write(encodedErrorResponse)
w.(http.Flusher).Flush()
}
// APIErrorResponse - error response format
type ApiErrorResponse struct {
XMLName xml.Name `xml:"Error" json:"-"`
AwsErrorCode string `xml:"Code"`
Message string
Key string
BucketName string
Resource string
RequestId string
HostId string
}