openstack/objectstorage/v1/objects/results.go - debian/gophercloud - Gitiles

 package objects

 import (
 	"fmt"
 	"io"
 	"io/ioutil"
 	"strings"

 	"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 RFC3339Milli time the object was last modified, represented
 	// as a string. For any given object (obj), this value may be parsed to a time.Time:
 	// lastModified, err := time.Parse(gophercloud.RFC3339Milli, obj.LastModified)
 	LastModified string `json:"last_modified"`

 	// Name is the unique name for the object.
 	Name string `json:"name"`
 }

 // 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) {
 	names, err := ExtractNames(r)
 	return len(names) == 0, err
 }

 // LastMarker returns the last object name in a ListResult.
 func (r ObjectPage) LastMarker() (string, error) {
 	names, err := ExtractNames(r)
 	if err != nil {
 		return "", err
 	}
 	if len(names) == 0 {
 		return "", nil
 	}
 	return names[len(names)-1], nil
 }

 // 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 {
 			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      string                  `json:"Content-Length"`
 	ContentType        string                  `json:"Content-Type"`
 	Date               gophercloud.JSONRFC1123 `json:"Date"`
 	DeleteAt           gophercloud.JSONUnix    `json:"X-Delete-At"`
 	ETag               string                  `json:"Etag"`
 	LastModified       gophercloud.JSONRFC1123 `json:"Last-Modified"`
 	ObjectManifest     string                  `json:"X-Object-Manifest"`
 	StaticLargeObject  bool                    `json:"X-Static-Large-Object"`
 	TransID            string                  `json:"X-Trans-Id"`
 }

 // 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. To obtain
 // a map of headers, call the ExtractHeader method on the DownloadResult.
 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
 	}
 	r.Body.Close()
 	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      string                  `json:"Content-Length"`
 	ContentType        string                  `json:"Content-Type"`
 	Date               gophercloud.JSONRFC1123 `json:"Date"`
 	DeleteAt           gophercloud.JSONUnix    `json:"X-Delete-At"`
 	ETag               string                  `json:"Etag"`
 	LastModified       gophercloud.JSONRFC1123 `json:"Last-Modified"`
 	ObjectManifest     string                  `json:"X-Object-Manifest"`
 	StaticLargeObject  bool                    `json:"X-Static-Large-Object"`
 	TransID            string                  `json:"X-Trans-Id"`
 }

 // 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. To obtain
 // a map of headers, call the ExtractHeader method on the GetResult.
 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 string                  `json:"Content-Length"`
 	ContentType   string                  `json:"Content-Type"`
 	Date          gophercloud.JSONRFC1123 `json:"Date"`
 	ETag          string                  `json:"Etag"`
 	LastModified  gophercloud.JSONRFC1123 `json:"Last-Modified"`
 	TransID       string                  `json:"X-Trans-Id"`
 }

 // 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. To obtain
 // a map of headers, call the ExtractHeader method on the CreateResult.
 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 string                  `json:"Content-Length"`
 	ContentType   string                  `json:"Content-Type"`
 	Date          gophercloud.JSONRFC1123 `json:"Date"`
 	TransID       string                  `json:"X-Trans-Id"`
 }

 // 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. To obtain
 // a map of headers, call the ExtractHeader method on the UpdateResult.
 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 string                  `json:"Content-Length"`
 	ContentType   string                  `json:"Content-Type"`
 	Date          gophercloud.JSONRFC1123 `json:"Date"`
 	TransID       string                  `json:"X-Trans-Id"`
 }

 // 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. To obtain
 // a map of headers, call the ExtractHeader method on the DeleteResult.
 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"`
 	ContentType            string                  `json:"Content-Type"`
 	CopiedFrom             string                  `json:"X-Copied-From"`
 	CopiedFromLastModified gophercloud.JSONRFC1123 `json:"X-Copied-From-Last-Modified"`
 	Date                   gophercloud.JSONRFC1123 `json:"Date"`
 	ETag                   string                  `json:"Etag"`
 	LastModified           gophercloud.JSONRFC1123 `json:"Last-Modified"`
 	TransID                string                  `json:"X-Trans-Id"`
 }

 // 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. To obtain
 // a map of headers, call the ExtractHeader method on the CopyResult.
 func (r CopyResult) Extract() (*CopyHeader, error) {
 	var s *CopyHeader
 	err := r.ExtractInto(&s)
 	return s, err
 }
	package objects

	import (
	"fmt"
	"io"
	"io/ioutil"
	"strings"

	"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 RFC3339Milli time the object was last modified, represented
	// as a string. For any given object (obj), this value may be parsed to a time.Time:
	// lastModified, err := time.Parse(gophercloud.RFC3339Milli, obj.LastModified)
	LastModified string `json:"last_modified"`

	// Name is the unique name for the object.
	Name string `json:"name"`
	}

	// 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) {
	names, err := ExtractNames(r)
	return len(names) == 0, err
	}

	// LastMarker returns the last object name in a ListResult.
	func (r ObjectPage) LastMarker() (string, error) {
	names, err := ExtractNames(r)
	if err != nil {
	return "", err
	}
	if len(names) == 0 {
	return "", nil
	}
	return names[len(names)-1], nil
	}

	// 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 {
	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 string `json:"Content-Length"`
	ContentType string `json:"Content-Type"`
	Date gophercloud.JSONRFC1123 `json:"Date"`
	DeleteAt gophercloud.JSONUnix `json:"X-Delete-At"`
	ETag string `json:"Etag"`
	LastModified gophercloud.JSONRFC1123 `json:"Last-Modified"`
	ObjectManifest string `json:"X-Object-Manifest"`
	StaticLargeObject bool `json:"X-Static-Large-Object"`
	TransID string `json:"X-Trans-Id"`
	}

	// 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. To obtain
	// a map of headers, call the ExtractHeader method on the DownloadResult.
	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
	}
	r.Body.Close()
	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 string `json:"Content-Length"`
	ContentType string `json:"Content-Type"`
	Date gophercloud.JSONRFC1123 `json:"Date"`
	DeleteAt gophercloud.JSONUnix `json:"X-Delete-At"`
	ETag string `json:"Etag"`
	LastModified gophercloud.JSONRFC1123 `json:"Last-Modified"`
	ObjectManifest string `json:"X-Object-Manifest"`
	StaticLargeObject bool `json:"X-Static-Large-Object"`
	TransID string `json:"X-Trans-Id"`
	}

	// 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. To obtain
	// a map of headers, call the ExtractHeader method on the GetResult.
	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 string `json:"Content-Length"`
	ContentType string `json:"Content-Type"`
	Date gophercloud.JSONRFC1123 `json:"Date"`
	ETag string `json:"Etag"`
	LastModified gophercloud.JSONRFC1123 `json:"Last-Modified"`
	TransID string `json:"X-Trans-Id"`
	}

	// 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. To obtain
	// a map of headers, call the ExtractHeader method on the CreateResult.
	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 string `json:"Content-Length"`
	ContentType string `json:"Content-Type"`
	Date gophercloud.JSONRFC1123 `json:"Date"`
	TransID string `json:"X-Trans-Id"`
	}

	// 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. To obtain
	// a map of headers, call the ExtractHeader method on the UpdateResult.
	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 string `json:"Content-Length"`
	ContentType string `json:"Content-Type"`
	Date gophercloud.JSONRFC1123 `json:"Date"`
	TransID string `json:"X-Trans-Id"`
	}

	// 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. To obtain
	// a map of headers, call the ExtractHeader method on the DeleteResult.
	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"`
	ContentType string `json:"Content-Type"`
	CopiedFrom string `json:"X-Copied-From"`
	CopiedFromLastModified gophercloud.JSONRFC1123 `json:"X-Copied-From-Last-Modified"`
	Date gophercloud.JSONRFC1123 `json:"Date"`
	ETag string `json:"Etag"`
	LastModified gophercloud.JSONRFC1123 `json:"Last-Modified"`
	TransID string `json:"X-Trans-Id"`
	}

	// 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. To obtain
	// a map of headers, call the ExtractHeader method on the CopyResult.
	func (r CopyResult) Extract() (*CopyHeader, error) {
	var s *CopyHeader
	err := r.ExtractInto(&s)
	return s, err
	}