Merge pull request #41 from aliyun/restorebuket

 Supports IA/Archive in CreateBucket API and Restore API

.travis.yml

@@ -2,6 +2,9 @@ language: csharp
 solution: aliyun-oss-sdk.sln
 mono:
   - latest
-  - 4.2.1
-  - 4.0.0
+  - 5.4.1
+  - 4.8.1
   - 3.12.0
+env:
+  global:
+    - MONO_IOMAP=all

CHANGELOG.md

@@ -1,5 +1,10 @@
 # ChangeLog - Aliyun OSS SDK for C# 
 
+## 版本号：2.6.0  日期：2017/11/30
+### 变更内容
+- 增加：CreateBucket支持StorageClass
+- 增加：支持RestoreObject
+
 ## 版本号：2.5.4  日期：2017/11/17
 ### 变更内容
 - 修复：多线程调用BeginPutObject报ObjectDisposedException的问题

README-CN.md

@@ -12,7 +12,7 @@
  - OSS C# SDK[在线文档](http://gosspublic.alicdn.com/AliyunNetSDK/apidocs/latest/index.html)。
 
 ## 版本
- - 当前版本：2.5.4
+ - 当前版本：2.6.0
 
 ## 运行环境
 

README.md

@@ -12,7 +12,7 @@
  - OSS C# SDK[Online Documentation](http://gosspublic.alicdn.com/AliyunNetSDK/international/apidocs/latest/index.html). 
 
 ## Version
- - Current version: 2.5.4.
+ - Current version: 2.6.0.
 
 ## Run environment
 

samples/Properties/AssemblyInfo.cs

@@ -28,7 +28,7 @@
 //
 // You can specify all the values or you can use the default the Revision and 
 // Build Numbers by using the '*' as shown below:
-[assembly: AssemblyVersion("2.5.4")]
+[assembly: AssemblyVersion("2.6.0")]
 [assembly: NeutralResourcesLanguage("zh-CN")]
-[assembly: AssemblyFileVersion("2.5.4")]
+[assembly: AssemblyFileVersion("2.6.0")]
 

samples/Samples/RestoreArchiveObjectSample.cs

@@ -0,0 +1,53 @@
+/*
+ * Copyright (C) Alibaba Cloud Computing
+ * All rights reserved.
+ * 
+ */
+
+using System;
+using System.Net;
+using System.Threading;
+using Aliyun.OSS.Model;
+using Aliyun.OSS.Common;
+
+namespace Aliyun.OSS.Samples
+{
+    /// <summary>
+    /// Sample usage of RestoreObject API
+    /// </summary>
+    public static class RestoreArchiveObjectSample
+    {
+        static string accessKeyId = Config.AccessKeyId;
+        static string accessKeySecret = Config.AccessKeySecret;
+        static string endpoint = Config.Endpoint;
+        static OssClient client = new OssClient(endpoint, accessKeyId, accessKeySecret);
+
+        public static void RestoreArchiveObject(string bucketName, string key, bool waitUtilFinished = true, int maxWaitTimeInSeconds = 600)
+        {
+            RestoreObjectResult result = client.RestoreObject(bucketName, key);
+            if (result.HttpStatusCode != HttpStatusCode.Accepted || !waitUtilFinished)
+            {
+                throw new OssException(result.RequestId + ", " + result.HttpStatusCode + " ,");
+            }
+
+            while (maxWaitTimeInSeconds > 0)
+            {
+                var meta = client.GetObjectMetadata(bucketName, key);
+                string restoreStatus = meta.HttpMetadata["x-oss-restore"] as string;
+                if (restoreStatus != null && restoreStatus.StartsWith("ongoing-request=\"false\"", StringComparison.InvariantCultureIgnoreCase))
+                {
+                    break;
+                }
+
+                Thread.Sleep(1000);
+                maxWaitTimeInSeconds--;
+            }
+
+            if (maxWaitTimeInSeconds == 0)
+            {
+                throw new TimeoutException();
+            }
+        }
+
+    }
+}

samples/aliyun-oss-sdk-samples.csproj

@@ -12,7 +12,6 @@
     </TargetFrameworkProfile>
     <AppDesignerFolder>Properties</AppDesignerFolder>
     <SignAssembly>False</SignAssembly>
-    <DelaySign>False</DelaySign>
     <RunPostBuildEvent>OnBuildSuccess</RunPostBuildEvent>
     <AllowUnsafeBlocks>False</AllowUnsafeBlocks>
     <NoStdLib>False</NoStdLib>
@@ -125,6 +124,7 @@
     <Compile Include="Samples\SetBucketAclSample.cs" />
     <Compile Include="Program.cs" />
     <Compile Include="Properties\AssemblyInfo.cs" />
+    <Compile Include="Samples\RestoreArchiveObjectSample.cs" />
   </ItemGroup>
   <ItemGroup>
     <BootstrapperPackage Include="Microsoft.Net.Client.3.5">

sdk/Commands/CreateBucketCommand.cs

@@ -5,7 +5,9 @@
  */
 
 using System;
+using System.IO;
 using Aliyun.OSS.Common.Communication;
+using Aliyun.OSS.Transform;
 using Aliyun.OSS.Util;
 
 namespace Aliyun.OSS.Commands
@@ -24,19 +26,35 @@ protected override string Bucket
             get { return _bucketName; }
         }
 
+        protected override Stream Content
+        {
+            get
+            {
+                return StorageClass == null ? null : SerializerFactory.GetFactory().CreateCreateBucketSerialization()
+                                        .Serialize(StorageClass.Value);
+            }
+        }
+
+        protected StorageClass? StorageClass
+        {
+            get;
+            set;
+        }
+
         private CreateBucketCommand(IServiceClient client, Uri endpoint, ExecutionContext context,
-                                    string bucketName)
+                                    string bucketName, StorageClass? storageClass)
             : base(client, endpoint, context)
         {
             OssUtils.CheckBucketName(bucketName);
             _bucketName = bucketName;
+            StorageClass = storageClass;
         }
 
         public static CreateBucketCommand Create(IServiceClient client, Uri endpoint,
                                                  ExecutionContext context,
-                                                 string bucketName)
+                                                 string bucketName, StorageClass? storageClass = null)
         {
-            return new CreateBucketCommand(client, endpoint, context, bucketName);
+            return new CreateBucketCommand(client, endpoint, context, bucketName, storageClass);
         }
     }
 }

sdk/Commands/OssCommand.cs

@@ -63,6 +63,12 @@ protected bool UseChunkedEncoding
             private set;
         }
 
+        protected bool ParametersInUri
+        {
+            get;
+            set;
+        }
+
         protected OssCommand(IServiceClient client, Uri endpoint, ExecutionContext context)
             : this(client, endpoint, context, false)
         {
@@ -104,7 +110,8 @@ private ServiceRequest BuildRequest()
                 Method = Method,
                 Endpoint = OssUtils.MakeBucketEndpoint(Endpoint, Bucket, conf),
                 ResourcePath = OssUtils.MakeResourcePath(Endpoint, Bucket, Key),
-                UseChunkedEncoding = UseChunkedEncoding
+                UseChunkedEncoding = UseChunkedEncoding,
+                ParametersInUri = ParametersInUri
             };
 
             foreach (var p in Parameters) 

sdk/Commands/RestoreObjectCommand.cs

@@ -0,0 +1,70 @@
+/*
+ * Copyright (C) Alibaba Cloud Computing
+ * All rights reserved.
+ * 
+ */
+
+using System;
+using System.Collections.Generic;
+using Aliyun.OSS.Common.Communication;
+using Aliyun.OSS.Util;
+using Aliyun.OSS.Transform;
+using Aliyun.OSS.Properties;
+using Aliyun.OSS.Model;
+
+namespace Aliyun.OSS.Commands
+{
+    internal class RestoreObjectCommand : OssCommand<RestoreObjectResult>
+    {
+        private string bucketName;
+        private string key;
+
+        protected override string Bucket
+        {
+            get { 
+                return bucketName; 
+            }
+        }
+
+        protected override string Key
+        {
+            get {
+                return key; 
+            }
+        }
+
+        protected override HttpMethod Method
+        {
+            get { return HttpMethod.Post; }
+        }
+
+        protected override IDictionary<string, string> Parameters
+        {
+            get
+            {
+                var parameters = new Dictionary<string, string>();
+                parameters[RequestParameters.SUBRESOURCE_RESTORE] = null;
+                return parameters;
+            }
+        }
+
+        private RestoreObjectCommand(IServiceClient client, Uri endpoint, ExecutionContext context,
+                                     string bucketName, string key, IDeserializer<ServiceResponse, RestoreObjectResult> deserializer)
+            : base(client, endpoint, context, deserializer)
+        {
+            OssUtils.CheckBucketName(bucketName);
+            OssUtils.CheckObjectKey(key);
+
+            this.bucketName = bucketName;
+            this.key = key;
+            this.ParametersInUri = true; // in restore request, the parameter restore needs to be in uri
+        }
+
+        public static RestoreObjectCommand Create(IServiceClient client, Uri endpoint,
+                                                 ExecutionContext context,
+                                                 string bucketName, string key)
+        {
+            return new RestoreObjectCommand(client, endpoint, context, bucketName, key, DeserializerFactory.GetFactory().CreateRestoreObjectResultDeserializer());
+        }
+    }
+}

sdk/Common/Communication/ServiceClientImpl.cs

@@ -358,7 +358,16 @@ private static void SetRequestHeaders(HttpWebRequest webRequest, ServiceRequest
             // with the WebHeaderCollection.Add method,
             // we have to call an internal method to skip validation.
             foreach (var h in serviceRequest.Headers)
+            {
+                // Nginx does not accept a chunked encoding request with Content-Length, as detailed in #OSS-2848
+                if (h.Key.Equals(HttpHeaders.ContentLength) && (serviceRequest.UseChunkedEncoding || 
+                    (serviceRequest.Content != null && !serviceRequest.Content.CanSeek)))
+                {
+                    continue;
+                }
+
                 HttpExtensions.AddInternal(webRequest.Headers, h.Key, h.Value);
+            }
 
             // Set user-agent
             if (!string.IsNullOrEmpty(configuration.UserAgent))

sdk/Common/Communication/ServiceRequest.cs

@@ -61,6 +61,17 @@ public bool UseChunkedEncoding
             set;
         }
 
+        /// <summary>
+        /// Gets or sets a value indicating whether this <see cref="T:Aliyun.OSS.Common.Communication.ServiceRequest"/>
+        /// parameters in URL.
+        /// </summary>
+        /// <value><c>true</c> if parameters in URL; otherwise, <c>false</c>.</value>
+        public bool ParametersInUri
+        {
+            get;
+            set;
+        }
+
         /// <summary>
         /// Build the request URI from the request message.
         /// </summary>
@@ -112,7 +123,7 @@ private bool IsParameterInUri()
         {
             var requestHasPayload = Content != null;
             var requestIsPost = Method == HttpMethod.Post;
-            var putParamsInUri = !requestIsPost || requestHasPayload;
+            var putParamsInUri = !requestIsPost || requestHasPayload || ParametersInUri;
             return putParamsInUri;
         }
 

sdk/Enums/StorageClass.cs

@@ -0,0 +1,18 @@
+/*
+ * Copyright (C) Alibaba Cloud Computing
+ * All rights reserved.
+ * 
+ */
+using System;
+namespace Aliyun.OSS
+{
+    /// <summary>
+    /// Storage class of OSS Bucket
+    /// </summary>
+    public enum StorageClass
+    {
+        Standard, // Standard bucket
+        IA,       // Infrequent Access bucket
+        Archive   // Archive bucket
+    }
+}

sdk/IOss.cs

@@ -9,6 +9,7 @@
 using System.Collections.Generic;
 using Aliyun.OSS.Common.Authentication;
 using Aliyun.OSS.Common.Internal;
+using Aliyun.OSS.Model;
 
 namespace Aliyun.OSS 
 {
@@ -53,6 +54,14 @@ public interface IOss
         /// <returns><see cref="Bucket" /> instance</returns>
         Bucket CreateBucket(string bucketName);
 
+        /// <summary>
+        /// Creates the bucket with specified storage class.
+        /// </summary>
+        /// <returns>The bucket.</returns>
+        /// <param name="bucketName">Bucket name.</param>
+        /// <param name="storageClass">Storage class.</param>
+        Bucket CreateBucket(string bucketName, StorageClass? storageClass);
+
         /// <summary>
         /// Deletes a empty bucket.If the bucket is not empty, this will fail.
         /// </summary>
@@ -656,6 +665,14 @@ PutObjectResult ResumableUploadObject(string bucketName, string key, Stream cont
         /// <returns><see cref="AccessControlList" /> instance</returns>
         AccessControlList GetObjectAcl(string bucketName, string key);
 
+        /// <summary>
+        /// Restores the object.
+        /// </summary>
+        /// <returns>The object.</returns>
+        /// <param name="bucketName">Bucket name.</param>
+        /// <param name="key">Key.</param>
+        RestoreObjectResult RestoreObject(string bucketName, string key);
+
         #endregion
 
         #region Generate URL

sdk/Model/CreateBucketRequestModel.cs

@@ -0,0 +1,18 @@
+/*
+ * Copyright (C) Alibaba Cloud Computing
+ * All rights reserved.
+ * 
+ */
+
+using System;
+using System.Xml.Serialization;
+
+namespace Aliyun.OSS.Model
+{
+    [XmlRoot("CreateBucketConfiguration")]
+    public class CreateBucketRequestModel
+    {
+        [XmlElement("StorageClass")]
+        public StorageClass StorageClass { get; set; }
+    }
+}

sdk/Model/RestoreObjectResult.cs

@@ -0,0 +1,15 @@
+/*
+ * Copyright (C) Alibaba Cloud Computing
+ * All rights reserved.
+ * 
+ */
+
+using System;
+using System.Xml.Serialization;
+
+namespace Aliyun.OSS.Model
+{
+    public class RestoreObjectResult : GenericResult
+    {
+    }
+}