add cache-control and expires options (peak#318)

* add cache-control and expires options Signed-off-by: tombokombo <[email protected]> * add examples Signed-off-by: tombokombo <[email protected]> * return error on invalid expires Signed-off-by: tombokombo <[email protected]> * remove else Co-authored-by: Aykut Farsak <[email protected]> * remove else Co-authored-by: Aykut Farsak <[email protected]> Co-authored-by: Aykut Farsak <[email protected]> Co-authored-by: İlkin Balkanay <[email protected]>
wwalker · Jul 22, 2021 · e81b978 · e81b978
1 parent 89baee6
commit e81b978
Show file tree

Hide file tree

Showing 4 changed files with 79 additions and 4 deletions.
diff --git a/command/cp.go b/command/cp.go
@@ -76,9 +76,18 @@ Examples:
 
 	13. Perform KMS-SSE of the object(s) at the destination using customer managed Customer Master Key (CMK) key id
 		> s5cmd {{.HelpName}} --sse aws:kms --sse-kms-key-id <your-kms-key-id> s3://bucket/object s3://target-bucket/prefix/object
-	
+
 	14. Force transfer of GLACIER objects with a prefix whether they are restored or not
 		> s5cmd {{.HelpName}} --force-glacier-transfer s3://bucket/prefix/* target-directory/
+
+	15. Upload a file to S3 bucket with public read s3 acl
+		> s5cmd {{.HelpName}} --acl "public-read" myfile.gz s3://bucket/
+
+	16. Upload a file to S3 bucket with expires header
+		> s5cmd {{.HelpName}} --expires "2024-10-01T20:30:00Z" myfile.gz s3://bucket/
+
+	17. Upload a file to S3 bucket with cache-control header
+		> s5cmd {{.HelpName}} --cache-control "public, max-age=345600" myfile.gz s3://bucket/
 `
 
 var copyCommandFlags = []cli.Flag{
@@ -132,7 +141,15 @@ var copyCommandFlags = []cli.Flag{
 	},
 	&cli.StringFlag{
 		Name:  "acl",
-		Usage: "set acl for target: defines granted accesses and their types on different accounts/groups",
+		Usage: "set acl for target: defines granted accesses and their types on different accounts/groups, e.g. cp --acl 'public-read'",
+	},
+	&cli.StringFlag{
+		Name:  "cache-control",
+		Usage: "set cache control for target: defines cache control header for object, e.g. cp --cache-control 'public, max-age=345600'",
+	},
+	&cli.StringFlag{
+		Name:  "expires",
+		Usage: "set expires for target (uses RFC3339 format): defines expires header for object, e.g. cp  --expires '2024-10-01T20:30:00Z'",
 	},
 	&cli.BoolFlag{
 		Name:  "force-glacier-transfer",
@@ -183,6 +200,8 @@ var copyCommand = &cli.Command{
 			encryptionKeyID:      c.String("sse-kms-key-id"),
 			acl:                  c.String("acl"),
 			forceGlacierTransfer: c.Bool("force-glacier-transfer"),
+			cacheControl:         c.String("cache-control"),
+			expires:              c.String("expires"),
 			// region settings
 			srcRegion: c.String("source-region"),
 			dstRegion: c.String("destination-region"),
@@ -212,6 +231,9 @@ type Copy struct {
 	encryptionKeyID      string
 	acl                  string
 	forceGlacierTransfer bool
+	cacheControl         string
+	expires              string
+
 
 	// region settings
 	srcRegion string
@@ -472,7 +494,9 @@ func (c Copy) doUpload(ctx context.Context, srcurl *url.URL, dsturl *url.URL) er
 		SetStorageClass(string(c.storageClass)).
 		SetSSE(c.encryptionMethod).
 		SetSSEKeyID(c.encryptionKeyID).
-		SetACL(c.acl)
+		SetACL(c.acl).
+		SetCacheControl(c.cacheControl).
+		SetExpires(c.expires)
 
 	err = dstClient.Put(ctx, file, dsturl, metadata, c.concurrency, c.partSize)
 	if err != nil {
@@ -518,7 +542,9 @@ func (c Copy) doCopy(ctx context.Context, srcurl, dsturl *url.URL) error {
 		SetStorageClass(string(c.storageClass)).
 		SetSSE(c.encryptionMethod).
 		SetSSEKeyID(c.encryptionKeyID).
-		SetACL(c.acl)
+		SetACL(c.acl).
+		SetCacheControl(c.cacheControl).
+		SetExpires(c.expires)
 
 	err = c.shouldOverride(ctx, srcurl, dsturl)
 	if err != nil {

diff --git a/command/mv.go b/command/mv.go
@@ -61,6 +61,9 @@ var moveCommand = &cli.Command{
 			encryptionMethod: c.String("sse"),
 			encryptionKeyID:  c.String("sse-kms-key-id"),
 			acl:              c.String("acl"),
+			cacheControl:     c.String("cache-control"),
+			expires:          c.String("expires"),
+
 
 			storageOpts: NewStorageOpts(c),
 		}

diff --git a/storage/s3.go b/storage/s3.go
@@ -345,6 +345,20 @@ func (s *S3) Copy(ctx context.Context, from, to *url.URL, metadata Metadata) err
 		input.ACL = aws.String(acl)
 	}
 
+	cacheControl := metadata.CacheControl()
+	if cacheControl != "" {
+		input.CacheControl = aws.String(cacheControl)
+	}
+
+	expires := metadata.Expires()
+	if expires != "" {
+		t, err := time.Parse(time.RFC3339, expires)
+		if err != nil {
+			return err
+		}
+		input.Expires = aws.Time(t)
+	}
+
 	_, err := s.api.CopyObject(input)
 	return err
 }
@@ -492,6 +506,20 @@ func (s *S3) Put(
 		input.ACL = aws.String(acl)
 	}
 
+	cacheControl := metadata.CacheControl()
+	if cacheControl != "" {
+		input.CacheControl = aws.String(cacheControl)
+	}
+
+	expires := metadata.Expires()
+	if expires != "" {
+		t, err := time.Parse(time.RFC3339, expires)
+		if err != nil {
+			return err
+		}
+		input.Expires = aws.Time(t)
+	}
+
 	sseEncryption := metadata.SSE()
 	if sseEncryption != "" {
 		input.ServerSideEncryption = aws.String(sseEncryption)

diff --git a/storage/storage.go b/storage/storage.go
@@ -208,6 +208,24 @@ func (m Metadata) SetACL(acl string) Metadata {
 	return m
 }
 
+func (m Metadata) CacheControl() string {
+	return m["CacheControl"]
+}
+
+func (m Metadata) SetCacheControl(cacheControl string) Metadata {
+	m["CacheControl"] = cacheControl
+	return m
+}
+
+func (m Metadata) Expires() string {
+	return m["Expires"]
+}
+
+func (m Metadata) SetExpires(expires string) Metadata {
+	m["Expires"] = expires
+	return m
+}
+
 func (m Metadata) StorageClass() string {
 	return m["StorageClass"]
 }