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 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552
|
package objects
import (
"encoding/json"
"fmt"
"io"
"io/ioutil"
"net/url"
"strings"
"time"
"github.com/gophercloud/gophercloud"
"github.com/gophercloud/gophercloud/pagination"
)
// Object is a structure that holds information related to a storage object.
type Object struct {
// Bytes is the total number of bytes that comprise the object.
Bytes int64 `json:"bytes"`
// ContentType is the content type of the object.
ContentType string `json:"content_type"`
// Hash represents the MD5 checksum value of the object's content.
Hash string `json:"hash"`
// LastModified is the time the object was last modified.
LastModified time.Time `json:"-"`
// Name is the unique name for the object.
Name string `json:"name"`
// Subdir denotes if the result contains a subdir.
Subdir string `json:"subdir"`
// IsLatest indicates whether the object version is the latest one.
IsLatest bool `json:"is_latest"`
// VersionID contains a version ID of the object, when container
// versioning is enabled.
VersionID string `json:"version_id"`
}
func (r *Object) UnmarshalJSON(b []byte) error {
type tmp Object
var s *struct {
tmp
LastModified string `json:"last_modified"`
}
err := json.Unmarshal(b, &s)
if err != nil {
return err
}
*r = Object(s.tmp)
if s.LastModified != "" {
t, err := time.Parse(gophercloud.RFC3339MilliNoZ, s.LastModified)
if err != nil {
t, err = time.Parse(gophercloud.RFC3339Milli, s.LastModified)
if err != nil {
return err
}
}
r.LastModified = t
}
return nil
}
// ObjectPage is a single page of objects that is returned from a call to the
// List function.
type ObjectPage struct {
pagination.MarkerPageBase
}
// IsEmpty returns true if a ListResult contains no object names.
func (r ObjectPage) IsEmpty() (bool, error) {
if r.StatusCode == 204 {
return true, nil
}
names, err := ExtractNames(r)
return len(names) == 0, err
}
// LastMarker returns the last object name in a ListResult.
func (r ObjectPage) LastMarker() (string, error) {
return extractLastMarker(r)
}
// ExtractInfo is a function that takes a page of objects and returns their
// full information.
func ExtractInfo(r pagination.Page) ([]Object, error) {
var s []Object
err := (r.(ObjectPage)).ExtractInto(&s)
return s, err
}
// ExtractNames is a function that takes a page of objects and returns only
// their names.
func ExtractNames(r pagination.Page) ([]string, error) {
casted := r.(ObjectPage)
ct := casted.Header.Get("Content-Type")
switch {
case strings.HasPrefix(ct, "application/json"):
parsed, err := ExtractInfo(r)
if err != nil {
return nil, err
}
names := make([]string, 0, len(parsed))
for _, object := range parsed {
if object.Subdir != "" {
names = append(names, object.Subdir)
} else {
names = append(names, object.Name)
}
}
return names, nil
case strings.HasPrefix(ct, "text/plain"):
names := make([]string, 0, 50)
body := string(r.(ObjectPage).Body.([]uint8))
for _, name := range strings.Split(body, "\n") {
if len(name) > 0 {
names = append(names, name)
}
}
return names, nil
case strings.HasPrefix(ct, "text/html"):
return []string{}, nil
default:
return nil, fmt.Errorf("Cannot extract names from response with content-type: [%s]", ct)
}
}
// DownloadHeader represents the headers returned in the response from a
// Download request.
type DownloadHeader struct {
AcceptRanges string `json:"Accept-Ranges"`
ContentDisposition string `json:"Content-Disposition"`
ContentEncoding string `json:"Content-Encoding"`
ContentLength int64 `json:"Content-Length,string"`
ContentType string `json:"Content-Type"`
Date time.Time `json:"-"`
DeleteAt time.Time `json:"-"`
ETag string `json:"Etag"`
LastModified time.Time `json:"-"`
ObjectManifest string `json:"X-Object-Manifest"`
StaticLargeObject bool `json:"-"`
TransID string `json:"X-Trans-Id"`
ObjectVersionID string `json:"X-Object-Version-Id"`
}
func (r *DownloadHeader) UnmarshalJSON(b []byte) error {
type tmp DownloadHeader
var s struct {
tmp
Date gophercloud.JSONRFC1123 `json:"Date"`
DeleteAt gophercloud.JSONUnix `json:"X-Delete-At"`
LastModified gophercloud.JSONRFC1123 `json:"Last-Modified"`
StaticLargeObject interface{} `json:"X-Static-Large-Object"`
}
err := json.Unmarshal(b, &s)
if err != nil {
return err
}
*r = DownloadHeader(s.tmp)
switch t := s.StaticLargeObject.(type) {
case string:
if t == "True" || t == "true" {
r.StaticLargeObject = true
}
case bool:
r.StaticLargeObject = t
}
r.Date = time.Time(s.Date)
r.DeleteAt = time.Time(s.DeleteAt)
r.LastModified = time.Time(s.LastModified)
return nil
}
// DownloadResult is a *http.Response that is returned from a call to the
// Download function.
type DownloadResult struct {
gophercloud.HeaderResult
Body io.ReadCloser
}
// Extract will return a struct of headers returned from a call to Download.
func (r DownloadResult) Extract() (*DownloadHeader, error) {
var s DownloadHeader
err := r.ExtractInto(&s)
return &s, err
}
// ExtractContent is a function that takes a DownloadResult's io.Reader body
// and reads all available data into a slice of bytes. Please be aware that due
// the nature of io.Reader is forward-only - meaning that it can only be read
// once and not rewound. You can recreate a reader from the output of this
// function by using bytes.NewReader(downloadBytes)
func (r *DownloadResult) ExtractContent() ([]byte, error) {
if r.Err != nil {
return nil, r.Err
}
defer r.Body.Close()
body, err := ioutil.ReadAll(r.Body)
if err != nil {
return nil, err
}
return body, nil
}
// GetHeader represents the headers returned in the response from a Get request.
type GetHeader struct {
ContentDisposition string `json:"Content-Disposition"`
ContentEncoding string `json:"Content-Encoding"`
ContentLength int64 `json:"Content-Length,string"`
ContentType string `json:"Content-Type"`
Date time.Time `json:"-"`
DeleteAt time.Time `json:"-"`
ETag string `json:"Etag"`
LastModified time.Time `json:"-"`
ObjectManifest string `json:"X-Object-Manifest"`
StaticLargeObject bool `json:"-"`
TransID string `json:"X-Trans-Id"`
ObjectVersionID string `json:"X-Object-Version-Id"`
}
func (r *GetHeader) UnmarshalJSON(b []byte) error {
type tmp GetHeader
var s struct {
tmp
Date gophercloud.JSONRFC1123 `json:"Date"`
DeleteAt gophercloud.JSONUnix `json:"X-Delete-At"`
LastModified gophercloud.JSONRFC1123 `json:"Last-Modified"`
StaticLargeObject interface{} `json:"X-Static-Large-Object"`
}
err := json.Unmarshal(b, &s)
if err != nil {
return err
}
*r = GetHeader(s.tmp)
switch t := s.StaticLargeObject.(type) {
case string:
if t == "True" || t == "true" {
r.StaticLargeObject = true
}
case bool:
r.StaticLargeObject = t
}
r.Date = time.Time(s.Date)
r.DeleteAt = time.Time(s.DeleteAt)
r.LastModified = time.Time(s.LastModified)
return nil
}
// GetResult is a *http.Response that is returned from a call to the Get
// function.
type GetResult struct {
gophercloud.HeaderResult
}
// Extract will return a struct of headers returned from a call to Get.
func (r GetResult) Extract() (*GetHeader, error) {
var s GetHeader
err := r.ExtractInto(&s)
return &s, err
}
// ExtractMetadata is a function that takes a GetResult (of type *http.Response)
// and returns the custom metadata associated with the object.
func (r GetResult) ExtractMetadata() (map[string]string, error) {
if r.Err != nil {
return nil, r.Err
}
metadata := make(map[string]string)
for k, v := range r.Header {
if strings.HasPrefix(k, "X-Object-Meta-") {
key := strings.TrimPrefix(k, "X-Object-Meta-")
metadata[key] = v[0]
}
}
return metadata, nil
}
// CreateHeader represents the headers returned in the response from a
// Create request.
type CreateHeader struct {
ContentLength int64 `json:"Content-Length,string"`
ContentType string `json:"Content-Type"`
Date time.Time `json:"-"`
ETag string `json:"Etag"`
LastModified time.Time `json:"-"`
TransID string `json:"X-Trans-Id"`
ObjectVersionID string `json:"X-Object-Version-Id"`
}
func (r *CreateHeader) UnmarshalJSON(b []byte) error {
type tmp CreateHeader
var s struct {
tmp
Date gophercloud.JSONRFC1123 `json:"Date"`
LastModified gophercloud.JSONRFC1123 `json:"Last-Modified"`
}
err := json.Unmarshal(b, &s)
if err != nil {
return err
}
*r = CreateHeader(s.tmp)
r.Date = time.Time(s.Date)
r.LastModified = time.Time(s.LastModified)
return nil
}
// CreateResult represents the result of a create operation.
type CreateResult struct {
checksum string
gophercloud.HeaderResult
}
// Extract will return a struct of headers returned from a call to Create.
func (r CreateResult) Extract() (*CreateHeader, error) {
//if r.Header.Get("ETag") != fmt.Sprintf("%x", localChecksum) {
// return nil, ErrWrongChecksum{}
//}
var s CreateHeader
err := r.ExtractInto(&s)
return &s, err
}
// UpdateHeader represents the headers returned in the response from a
// Update request.
type UpdateHeader struct {
ContentLength int64 `json:"Content-Length,string"`
ContentType string `json:"Content-Type"`
Date time.Time `json:"-"`
TransID string `json:"X-Trans-Id"`
ObjectVersionID string `json:"X-Object-Version-Id"`
}
func (r *UpdateHeader) UnmarshalJSON(b []byte) error {
type tmp UpdateHeader
var s struct {
tmp
Date gophercloud.JSONRFC1123 `json:"Date"`
}
err := json.Unmarshal(b, &s)
if err != nil {
return err
}
*r = UpdateHeader(s.tmp)
r.Date = time.Time(s.Date)
return nil
}
// UpdateResult represents the result of an update operation.
type UpdateResult struct {
gophercloud.HeaderResult
}
// Extract will return a struct of headers returned from a call to Update.
func (r UpdateResult) Extract() (*UpdateHeader, error) {
var s UpdateHeader
err := r.ExtractInto(&s)
return &s, err
}
// DeleteHeader represents the headers returned in the response from a
// Delete request.
type DeleteHeader struct {
ContentLength int64 `json:"Content-Length,string"`
ContentType string `json:"Content-Type"`
Date time.Time `json:"-"`
TransID string `json:"X-Trans-Id"`
ObjectVersionID string `json:"X-Object-Version-Id"`
ObjectCurrentVersionID string `json:"X-Object-Current-Version-Id"`
}
func (r *DeleteHeader) UnmarshalJSON(b []byte) error {
type tmp DeleteHeader
var s struct {
tmp
Date gophercloud.JSONRFC1123 `json:"Date"`
}
err := json.Unmarshal(b, &s)
if err != nil {
return err
}
*r = DeleteHeader(s.tmp)
r.Date = time.Time(s.Date)
return nil
}
// DeleteResult represents the result of a delete operation.
type DeleteResult struct {
gophercloud.HeaderResult
}
// Extract will return a struct of headers returned from a call to Delete.
func (r DeleteResult) Extract() (*DeleteHeader, error) {
var s DeleteHeader
err := r.ExtractInto(&s)
return &s, err
}
// CopyHeader represents the headers returned in the response from a
// Copy request.
type CopyHeader struct {
ContentLength int64 `json:"Content-Length,string"`
ContentType string `json:"Content-Type"`
CopiedFrom string `json:"X-Copied-From"`
CopiedFromLastModified time.Time `json:"-"`
Date time.Time `json:"-"`
ETag string `json:"Etag"`
LastModified time.Time `json:"-"`
TransID string `json:"X-Trans-Id"`
ObjectVersionID string `json:"X-Object-Version-Id"`
}
func (r *CopyHeader) UnmarshalJSON(b []byte) error {
type tmp CopyHeader
var s struct {
tmp
CopiedFromLastModified gophercloud.JSONRFC1123 `json:"X-Copied-From-Last-Modified"`
Date gophercloud.JSONRFC1123 `json:"Date"`
LastModified gophercloud.JSONRFC1123 `json:"Last-Modified"`
}
err := json.Unmarshal(b, &s)
if err != nil {
return err
}
*r = CopyHeader(s.tmp)
r.Date = time.Time(s.Date)
r.CopiedFromLastModified = time.Time(s.CopiedFromLastModified)
r.LastModified = time.Time(s.LastModified)
return nil
}
// CopyResult represents the result of a copy operation.
type CopyResult struct {
gophercloud.HeaderResult
}
// Extract will return a struct of headers returned from a call to Copy.
func (r CopyResult) Extract() (*CopyHeader, error) {
var s CopyHeader
err := r.ExtractInto(&s)
return &s, err
}
type BulkDeleteResponse struct {
ResponseStatus string `json:"Response Status"`
ResponseBody string `json:"Response Body"`
Errors [][]string `json:"Errors"`
NumberDeleted int `json:"Number Deleted"`
NumberNotFound int `json:"Number Not Found"`
}
// BulkDeleteResult represents the result of a bulk delete operation. To extract
// the response object from the HTTP response, call its Extract method.
type BulkDeleteResult struct {
gophercloud.Result
}
// Extract will return a BulkDeleteResponse struct returned from a BulkDelete
// call.
func (r BulkDeleteResult) Extract() (*BulkDeleteResponse, error) {
var s BulkDeleteResponse
err := r.ExtractInto(&s)
return &s, err
}
// extractLastMarker is a function that takes a page of objects and returns the
// marker for the page. This can either be a subdir or the last object's name.
func extractLastMarker(r pagination.Page) (string, error) {
casted := r.(ObjectPage)
// If a delimiter was requested, check if a subdir exists.
queryParams, err := url.ParseQuery(casted.URL.RawQuery)
if err != nil {
return "", err
}
var delimeter bool
if v, ok := queryParams["delimiter"]; ok && len(v) > 0 {
delimeter = true
}
ct := casted.Header.Get("Content-Type")
switch {
case strings.HasPrefix(ct, "application/json"):
parsed, err := ExtractInfo(r)
if err != nil {
return "", err
}
var lastObject Object
if len(parsed) > 0 {
lastObject = parsed[len(parsed)-1]
}
if !delimeter {
return lastObject.Name, nil
}
if lastObject.Name != "" {
return lastObject.Name, nil
}
return lastObject.Subdir, nil
case strings.HasPrefix(ct, "text/plain"):
names := make([]string, 0, 50)
body := string(r.(ObjectPage).Body.([]uint8))
for _, name := range strings.Split(body, "\n") {
if len(name) > 0 {
names = append(names, name)
}
}
return names[len(names)-1], err
case strings.HasPrefix(ct, "text/html"):
return "", nil
default:
return "", fmt.Errorf("Cannot extract names from response with content-type: [%s]", ct)
}
}
|