Storage/feature/stg87-trailing dot (#4389)

trailing dot
Azure · Mar 7, 2023 · d2e2619 · d2e2619
1 parent ad6eb88
commit d2e2619
Show file tree

Hide file tree

Showing 13 changed files with 537 additions and 15 deletions.
diff --git a/sdk/storage/assets.json b/sdk/storage/assets.json
@@ -2,5 +2,5 @@
   "AssetsRepo": "Azure/azure-sdk-assets",
   "AssetsRepoPrefixPath": "cpp",
   "TagPrefix": "cpp/storage",
-  "Tag": "cpp/storage_92d8f38118"
+  "Tag": "cpp/storage_fafb185a5f"
 }
diff --git a/sdk/storage/azure-storage-files-shares/inc/azure/storage/files/shares/share_client.hpp b/sdk/storage/azure-storage-files-shares/inc/azure/storage/files/shares/share_client.hpp
@@ -230,6 +230,8 @@ namespace Azure { namespace Storage { namespace Files { namespace Shares {
   private:
     Azure::Core::Url m_shareUrl;
     std::shared_ptr<Azure::Core::Http::_internal::HttpPipeline> m_pipeline;
+    Nullable<bool> m_allowTrailingDot;
+    Nullable<bool> m_allowSourceTrailingDot;
 
     explicit ShareClient(
         Azure::Core::Url shareUrl,

diff --git a/...rage/azure-storage-files-shares/inc/azure/storage/files/shares/share_directory_client.hpp b/...rage/azure-storage-files-shares/inc/azure/storage/files/shares/share_directory_client.hpp
@@ -260,6 +260,8 @@ namespace Azure { namespace Storage { namespace Files { namespace Shares {
   private:
     Azure::Core::Url m_shareDirectoryUrl;
     std::shared_ptr<Azure::Core::Http::_internal::HttpPipeline> m_pipeline;
+    Nullable<bool> m_allowTrailingDot;
+    Nullable<bool> m_allowSourceTrailingDot;
 
     explicit ShareDirectoryClient(
         Azure::Core::Url shareDirectoryUrl,

diff --git a/sdk/storage/azure-storage-files-shares/inc/azure/storage/files/shares/share_file_client.hpp b/sdk/storage/azure-storage-files-shares/inc/azure/storage/files/shares/share_file_client.hpp
@@ -363,6 +363,8 @@ namespace Azure { namespace Storage { namespace Files { namespace Shares {
   private:
     Azure::Core::Url m_shareFileUrl;
     std::shared_ptr<Azure::Core::Http::_internal::HttpPipeline> m_pipeline;
+    Nullable<bool> m_allowTrailingDot;
+    Nullable<bool> m_allowSourceTrailingDot;
 
     explicit ShareFileClient(
         Azure::Core::Url shareFileUrl,

diff --git a/sdk/storage/azure-storage-files-shares/inc/azure/storage/files/shares/share_options.hpp b/sdk/storage/azure-storage-files-shares/inc/azure/storage/files/shares/share_options.hpp
@@ -26,6 +26,20 @@ namespace Azure { namespace Storage { namespace Files { namespace Shares {
      * API version used by this client.
      */
     std::string ApiVersion;
+
+    /**
+     * If set to true, trailing dot (.) will be allowed to suffix directory and file names.
+     * If false, the trailing dot will be trimmed.
+     * Supported by x-ms-version 2022-11-02 and above.
+     */
+    Nullable<bool> AllowTrailingDot;
+
+    /**
+     * If set to true, trailing dot (.) will be allowed to source file names.
+     * If false, the trailing dot will be trimmed.
+     * Supported by x-ms-version 2022-11-02 and above.
+     */
+    Nullable<bool> AllowSourceTrailingDot;
   };
 
   /**

diff --git a/...torage/azure-storage-files-shares/inc/azure/storage/files/shares/share_service_client.hpp b/...torage/azure-storage-files-shares/inc/azure/storage/files/shares/share_service_client.hpp
@@ -102,5 +102,7 @@ namespace Azure { namespace Storage { namespace Files { namespace Shares {
   private:
     Azure::Core::Url m_serviceUrl;
     std::shared_ptr<Azure::Core::Http::_internal::HttpPipeline> m_pipeline;
+    Nullable<bool> m_allowTrailingDot;
+    Nullable<bool> m_allowSourceTrailingDot;
   };
 }}}} // namespace Azure::Storage::Files::Shares
diff --git a/sdk/storage/azure-storage-files-shares/src/share_client.cpp b/sdk/storage/azure-storage-files-shares/src/share_client.cpp
@@ -43,7 +43,8 @@ namespace Azure { namespace Storage { namespace Files { namespace Shares {
       const std::string& shareUrl,
       std::shared_ptr<StorageSharedKeyCredential> credential,
       const ShareClientOptions& options)
-      : m_shareUrl(shareUrl)
+      : m_shareUrl(shareUrl), m_allowTrailingDot(options.AllowTrailingDot),
+        m_allowSourceTrailingDot(options.AllowSourceTrailingDot)
   {
     ShareClientOptions newOptions = options;
     newOptions.PerRetryPolicies.emplace_back(
@@ -63,7 +64,8 @@ namespace Azure { namespace Storage { namespace Files { namespace Shares {
   }
 
   ShareClient::ShareClient(const std::string& shareUrl, const ShareClientOptions& options)
-      : m_shareUrl(shareUrl)
+      : m_shareUrl(shareUrl), m_allowTrailingDot(options.AllowTrailingDot),
+        m_allowSourceTrailingDot(options.AllowSourceTrailingDot)
   {
     std::vector<std::unique_ptr<Azure::Core::Http::Policies::HttpPolicy>> perRetryPolicies;
     std::vector<std::unique_ptr<Azure::Core::Http::Policies::HttpPolicy>> perOperationPolicies;
@@ -80,7 +82,10 @@ namespace Azure { namespace Storage { namespace Files { namespace Shares {
 
   ShareDirectoryClient ShareClient::GetRootDirectoryClient() const
   {
-    return ShareDirectoryClient(m_shareUrl, m_pipeline);
+    ShareDirectoryClient directoryClient(m_shareUrl, m_pipeline);
+    directoryClient.m_allowTrailingDot = m_allowTrailingDot;
+    directoryClient.m_allowSourceTrailingDot = m_allowSourceTrailingDot;
+    return directoryClient;
   }
 
   ShareClient ShareClient::WithSnapshot(const std::string& snapshot) const

diff --git a/sdk/storage/azure-storage-files-shares/src/share_directory_client.cpp b/sdk/storage/azure-storage-files-shares/src/share_directory_client.cpp
@@ -45,7 +45,8 @@ namespace Azure { namespace Storage { namespace Files { namespace Shares {
       const std::string& shareDirectoryUrl,
       std::shared_ptr<StorageSharedKeyCredential> credential,
       const ShareClientOptions& options)
-      : m_shareDirectoryUrl(shareDirectoryUrl)
+      : m_shareDirectoryUrl(shareDirectoryUrl), m_allowTrailingDot(options.AllowTrailingDot),
+        m_allowSourceTrailingDot(options.AllowSourceTrailingDot)
   {
     ShareClientOptions newOptions = options;
     newOptions.PerRetryPolicies.emplace_back(
@@ -67,7 +68,8 @@ namespace Azure { namespace Storage { namespace Files { namespace Shares {
   ShareDirectoryClient::ShareDirectoryClient(
       const std::string& shareDirectoryUrl,
       const ShareClientOptions& options)
-      : m_shareDirectoryUrl(shareDirectoryUrl)
+      : m_shareDirectoryUrl(shareDirectoryUrl), m_allowTrailingDot(options.AllowTrailingDot),
+        m_allowSourceTrailingDot(options.AllowSourceTrailingDot)
   {
     std::vector<std::unique_ptr<Azure::Core::Http::Policies::HttpPolicy>> perRetryPolicies;
     std::vector<std::unique_ptr<Azure::Core::Http::Policies::HttpPolicy>> perOperationPolicies;
@@ -87,14 +89,20 @@ namespace Azure { namespace Storage { namespace Files { namespace Shares {
   {
     auto builder = m_shareDirectoryUrl;
     builder.AppendPath(_internal::UrlEncodePath(subdirectoryName));
-    return ShareDirectoryClient(builder, m_pipeline);
+    ShareDirectoryClient subdirectoryClient(builder, m_pipeline);
+    subdirectoryClient.m_allowTrailingDot = m_allowTrailingDot;
+    subdirectoryClient.m_allowSourceTrailingDot = m_allowSourceTrailingDot;
+    return subdirectoryClient;
   }
 
   ShareFileClient ShareDirectoryClient::GetFileClient(const std::string& fileName) const
   {
     auto builder = m_shareDirectoryUrl;
     builder.AppendPath(_internal::UrlEncodePath(fileName));
-    return ShareFileClient(builder, m_pipeline);
+    ShareFileClient fileClient(builder, m_pipeline);
+    fileClient.m_allowTrailingDot = m_allowTrailingDot;
+    fileClient.m_allowSourceTrailingDot = m_allowSourceTrailingDot;
+    return fileClient;
   }
 
   ShareDirectoryClient ShareDirectoryClient::WithShareSnapshot(
@@ -163,6 +171,7 @@ namespace Azure { namespace Storage { namespace Files { namespace Shares {
     {
       protocolLayerOptions.FilePermission = std::string(FileInheritPermission);
     }
+    protocolLayerOptions.AllowTrailingDot = m_allowTrailingDot;
     auto result = _detail::DirectoryClient::Create(
         *m_pipeline, m_shareDirectoryUrl, protocolLayerOptions, context);
     Models::CreateDirectoryResult ret;
@@ -244,11 +253,15 @@ namespace Azure { namespace Storage { namespace Files { namespace Shares {
     {
       protocolLayerOptions.FilePermissionKey = options.SmbProperties.PermissionKey;
     }
+    protocolLayerOptions.AllowTrailingDot = m_allowTrailingDot;
+    protocolLayerOptions.AllowSourceTrailingDot = m_allowSourceTrailingDot;
 
     auto response = _detail::FileClient::Rename(
         *m_pipeline, destinationFileUrl, protocolLayerOptions, context);
 
     auto renamedFileClient = ShareFileClient(destinationFileUrl, m_pipeline);
+    renamedFileClient.m_allowTrailingDot = m_allowTrailingDot;
+    renamedFileClient.m_allowSourceTrailingDot = m_allowSourceTrailingDot;
     return Azure::Response<ShareFileClient>(
         std::move(renamedFileClient), std::move(response.RawResponse));
   }
@@ -300,13 +313,17 @@ namespace Azure { namespace Storage { namespace Files { namespace Shares {
     {
       protocolLayerOptions.FilePermissionKey = options.SmbProperties.PermissionKey;
     }
+    protocolLayerOptions.AllowTrailingDot = m_allowTrailingDot;
+    protocolLayerOptions.AllowSourceTrailingDot = m_allowSourceTrailingDot;
 
     auto response = _detail::DirectoryClient::Rename(
         *m_pipeline, destinationDirectoryUrl, protocolLayerOptions, context);
 
-    auto renamedFileClient = ShareDirectoryClient(destinationDirectoryUrl, m_pipeline);
+    auto renamedSubdirectoryClient = ShareDirectoryClient(destinationDirectoryUrl, m_pipeline);
+    renamedSubdirectoryClient.m_allowTrailingDot = m_allowTrailingDot;
+    renamedSubdirectoryClient.m_allowSourceTrailingDot = m_allowSourceTrailingDot;
     return Azure::Response<ShareDirectoryClient>(
-        std::move(renamedFileClient), std::move(response.RawResponse));
+        std::move(renamedSubdirectoryClient), std::move(response.RawResponse));
   }
 
   Azure::Response<Models::DeleteDirectoryResult> ShareDirectoryClient::Delete(
@@ -315,6 +332,7 @@ namespace Azure { namespace Storage { namespace Files { namespace Shares {
   {
     (void)options;
     auto protocolLayerOptions = _detail::DirectoryClient::DeleteDirectoryOptions();
+    protocolLayerOptions.AllowTrailingDot = m_allowTrailingDot;
     auto result = _detail::DirectoryClient::Delete(
         *m_pipeline, m_shareDirectoryUrl, protocolLayerOptions, context);
     Models::DeleteDirectoryResult ret;
@@ -351,6 +369,7 @@ namespace Azure { namespace Storage { namespace Files { namespace Shares {
   {
     (void)options;
     auto protocolLayerOptions = _detail::DirectoryClient::GetDirectoryPropertiesOptions();
+    protocolLayerOptions.AllowTrailingDot = m_allowTrailingDot;
     return _detail::DirectoryClient::GetProperties(
         *m_pipeline, m_shareDirectoryUrl, protocolLayerOptions, context);
   }
@@ -401,6 +420,7 @@ namespace Azure { namespace Storage { namespace Files { namespace Shares {
     {
       protocolLayerOptions.FilePermission = FilePreserveSmbProperties;
     }
+    protocolLayerOptions.AllowTrailingDot = m_allowTrailingDot;
     return _detail::DirectoryClient::SetProperties(
         *m_pipeline, m_shareDirectoryUrl, protocolLayerOptions, context);
   }
@@ -414,6 +434,7 @@ namespace Azure { namespace Storage { namespace Files { namespace Shares {
     auto protocolLayerOptions = _detail::DirectoryClient::SetDirectoryMetadataOptions();
     protocolLayerOptions.Metadata
         = std::map<std::string, std::string>(metadata.begin(), metadata.end());
+    protocolLayerOptions.AllowTrailingDot = m_allowTrailingDot;
     return _detail::DirectoryClient::SetMetadata(
         *m_pipeline, m_shareDirectoryUrl, protocolLayerOptions, context);
   }
@@ -429,6 +450,7 @@ namespace Azure { namespace Storage { namespace Files { namespace Shares {
     protocolLayerOptions.MaxResults = options.PageSizeHint;
     protocolLayerOptions.Include = options.Include;
     protocolLayerOptions.IncludeExtendedInfo = options.IncludeExtendedInfo;
+    protocolLayerOptions.AllowTrailingDot = m_allowTrailingDot;
     auto response = _detail::DirectoryClient::ListFilesAndDirectoriesSegment(
         *m_pipeline, m_shareDirectoryUrl, protocolLayerOptions, context);
 
@@ -499,6 +521,7 @@ namespace Azure { namespace Storage { namespace Files { namespace Shares {
     protocolLayerOptions.Marker = options.ContinuationToken;
     protocolLayerOptions.MaxResults = options.PageSizeHint;
     protocolLayerOptions.Recursive = options.Recursive;
+    protocolLayerOptions.AllowTrailingDot = m_allowTrailingDot;
     auto response = _detail::DirectoryClient::ListHandles(
         *m_pipeline, m_shareDirectoryUrl, protocolLayerOptions, context);
 
@@ -545,6 +568,7 @@ namespace Azure { namespace Storage { namespace Files { namespace Shares {
     (void)options;
     auto protocolLayerOptions = _detail::DirectoryClient::ForceDirectoryCloseHandlesOptions();
     protocolLayerOptions.HandleId = handleId;
+    protocolLayerOptions.AllowTrailingDot = m_allowTrailingDot;
     auto result = _detail::DirectoryClient::ForceCloseHandles(
         *m_pipeline, m_shareDirectoryUrl, protocolLayerOptions, context);
     Models::ForceCloseDirectoryHandleResult ret;
@@ -560,6 +584,7 @@ namespace Azure { namespace Storage { namespace Files { namespace Shares {
     protocolLayerOptions.HandleId = FileAllHandles;
     protocolLayerOptions.Marker = options.ContinuationToken;
     protocolLayerOptions.Recursive = options.Recursive;
+    protocolLayerOptions.AllowTrailingDot = m_allowTrailingDot;
     auto response = _detail::DirectoryClient::ForceCloseHandles(
         *m_pipeline, m_shareDirectoryUrl, protocolLayerOptions, context);