Mercurial > hg > orthanc-object-storage
annotate Azure/AzureBlobStoragePlugin.cpp @ 148:c02a830ae308
try
| author | Sebastien Jodogne <s.jodogne@gmail.com> |
|---|---|
| date | Thu, 20 Jun 2024 18:52:57 +0200 |
| parents | 3c7e0374f28e |
| children | d62f52be1943 |
| rev | line source |
|---|---|
| 1 | 1 /** |
| 2 * Cloud storage plugins for Orthanc | |
|
145
3c7e0374f28e
updated copyright, as Orthanc Team now replaces Osimis
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
111
diff
changeset
|
3 * Copyright (C) 2020-2023 Osimis S.A., Belgium |
|
3c7e0374f28e
updated copyright, as Orthanc Team now replaces Osimis
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
111
diff
changeset
|
4 * Copyright (C) 2024-2024 Orthanc Team SRL, Belgium |
|
3c7e0374f28e
updated copyright, as Orthanc Team now replaces Osimis
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
111
diff
changeset
|
5 * Copyright (C) 2021-2024 Sebastien Jodogne, ICTEAM UCLouvain, Belgium |
| 1 | 6 * |
| 7 * This program is free software: you can redistribute it and/or | |
| 8 * modify it under the terms of the GNU Affero General Public License | |
| 9 * as published by the Free Software Foundation, either version 3 of | |
| 10 * the License, or (at your option) any later version. | |
| 11 * | |
| 12 * This program is distributed in the hope that it will be useful, but | |
| 13 * WITHOUT ANY WARRANTY; without even the implied warranty of | |
| 14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU | |
| 15 * Affero General Public License for more details. | |
| 16 * | |
| 17 * You should have received a copy of the GNU Affero General Public License | |
| 18 * along with this program. If not, see <http://www.gnu.org/licenses/>. | |
| 19 **/ | |
| 20 | |
|
56
b922ae86bbe1
full static linking against AWS SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
48
diff
changeset
|
21 |
| 1 | 22 #include "AzureBlobStoragePlugin.h" |
| 23 | |
|
99
f4e05641c108
rewrote using the latest azure C++ sdk
Alain Mazy <am@osimis.io>
parents:
94
diff
changeset
|
24 #include <azure/storage/blobs.hpp> |
| 1 | 25 #include <boost/lexical_cast.hpp> |
|
12
a203d0a4fd8f
Azure: now removing spaces and CR at the end of the connectionString since it prevented the plugin to initialize.
Alain Mazy
parents:
11
diff
changeset
|
26 #include <boost/algorithm/string.hpp> |
|
99
f4e05641c108
rewrote using the latest azure C++ sdk
Alain Mazy <am@osimis.io>
parents:
94
diff
changeset
|
27 // #include "cpprest/rawptrstream.h" |
|
f4e05641c108
rewrote using the latest azure C++ sdk
Alain Mazy <am@osimis.io>
parents:
94
diff
changeset
|
28 // #include "cpprest/details/basic_types.h" |
| 1 | 29 |
| 30 // Create aliases to make the code easier to read. | |
|
99
f4e05641c108
rewrote using the latest azure C++ sdk
Alain Mazy <am@osimis.io>
parents:
94
diff
changeset
|
31 namespace as = Azure::Storage::Blobs; |
| 1 | 32 |
| 78 | 33 class AzureBlobStoragePlugin : public BaseStorage |
| 1 | 34 { |
| 35 public: | |
| 36 | |
|
99
f4e05641c108
rewrote using the latest azure C++ sdk
Alain Mazy <am@osimis.io>
parents:
94
diff
changeset
|
37 as::BlobContainerClient blobClient_; |
|
70
16e419fe80c5
Google & Azure: Added the "EnableLegacyUnknownFiles" configuration option
Alain Mazy <am@osimis.io>
parents:
56
diff
changeset
|
38 bool storageContainsUnknownFiles_; |
|
16e419fe80c5
Google & Azure: Added the "EnableLegacyUnknownFiles" configuration option
Alain Mazy <am@osimis.io>
parents:
56
diff
changeset
|
39 |
| 1 | 40 public: |
| 41 | |
| 79 | 42 AzureBlobStoragePlugin(const std::string& nameForLogs, |
|
99
f4e05641c108
rewrote using the latest azure C++ sdk
Alain Mazy <am@osimis.io>
parents:
94
diff
changeset
|
43 const as::BlobContainerClient& blobClient, |
|
70
16e419fe80c5
Google & Azure: Added the "EnableLegacyUnknownFiles" configuration option
Alain Mazy <am@osimis.io>
parents:
56
diff
changeset
|
44 bool enableLegacyStorageStructure, |
|
16e419fe80c5
Google & Azure: Added the "EnableLegacyUnknownFiles" configuration option
Alain Mazy <am@osimis.io>
parents:
56
diff
changeset
|
45 bool storageContainsUnknownFiles |
|
16e419fe80c5
Google & Azure: Added the "EnableLegacyUnknownFiles" configuration option
Alain Mazy <am@osimis.io>
parents:
56
diff
changeset
|
46 ); |
| 1 | 47 |
| 48 virtual IWriter* GetWriterForObject(const char* uuid, OrthancPluginContentType type, bool encryptionEnabled); | |
| 49 virtual IReader* GetReaderForObject(const char* uuid, OrthancPluginContentType type, bool encryptionEnabled); | |
| 50 virtual void DeleteObject(const char* uuid, OrthancPluginContentType type, bool encryptionEnabled); | |
|
111
407bd022b0cf
in /move-storage: now detecting if file should be moved or not
Alain Mazy <am@osimis.io>
parents:
99
diff
changeset
|
51 virtual bool HasFileExists() {return false;}; |
| 1 | 52 }; |
| 53 | |
| 54 | |
| 78 | 55 class Writer : public IStorage::IWriter |
| 1 | 56 { |
| 57 std::string path_; | |
|
99
f4e05641c108
rewrote using the latest azure C++ sdk
Alain Mazy <am@osimis.io>
parents:
94
diff
changeset
|
58 as::BlobContainerClient client_; |
| 1 | 59 |
| 60 public: | |
|
99
f4e05641c108
rewrote using the latest azure C++ sdk
Alain Mazy <am@osimis.io>
parents:
94
diff
changeset
|
61 Writer(const std::string& path, const as::BlobContainerClient& client) |
| 1 | 62 : path_(path), |
|
99
f4e05641c108
rewrote using the latest azure C++ sdk
Alain Mazy <am@osimis.io>
parents:
94
diff
changeset
|
63 client_(client) |
| 1 | 64 { |
| 65 } | |
| 66 | |
| 67 virtual ~Writer() | |
| 68 { | |
| 69 } | |
| 70 | |
| 71 virtual void Write(const char* data, size_t size) | |
| 72 { | |
| 73 try | |
| 74 { | |
|
99
f4e05641c108
rewrote using the latest azure C++ sdk
Alain Mazy <am@osimis.io>
parents:
94
diff
changeset
|
75 as::BlockBlobClient blobClient = client_.GetBlockBlobClient(path_); |
|
f4e05641c108
rewrote using the latest azure C++ sdk
Alain Mazy <am@osimis.io>
parents:
94
diff
changeset
|
76 blobClient.UploadFrom(reinterpret_cast<const uint8_t*>(data), size); |
| 1 | 77 } |
| 78 catch (std::exception& ex) | |
| 79 { | |
| 80 throw StoragePluginException("AzureBlobStorage: error writing file " + std::string(path_) + ": " + ex.what()); | |
| 81 } | |
| 82 } | |
| 83 }; | |
| 84 | |
| 85 | |
| 78 | 86 class Reader : public IStorage::IReader |
| 1 | 87 { |
|
70
16e419fe80c5
Google & Azure: Added the "EnableLegacyUnknownFiles" configuration option
Alain Mazy <am@osimis.io>
parents:
56
diff
changeset
|
88 std::string path_; |
|
99
f4e05641c108
rewrote using the latest azure C++ sdk
Alain Mazy <am@osimis.io>
parents:
94
diff
changeset
|
89 as::BlobContainerClient client_; |
|
f4e05641c108
rewrote using the latest azure C++ sdk
Alain Mazy <am@osimis.io>
parents:
94
diff
changeset
|
90 int64_t size_; |
| 1 | 91 |
| 92 public: | |
|
99
f4e05641c108
rewrote using the latest azure C++ sdk
Alain Mazy <am@osimis.io>
parents:
94
diff
changeset
|
93 Reader(const std::list<std::string>& paths, const as::BlobContainerClient& client) |
|
f4e05641c108
rewrote using the latest azure C++ sdk
Alain Mazy <am@osimis.io>
parents:
94
diff
changeset
|
94 : client_(client) |
| 1 | 95 { |
|
70
16e419fe80c5
Google & Azure: Added the "EnableLegacyUnknownFiles" configuration option
Alain Mazy <am@osimis.io>
parents:
56
diff
changeset
|
96 std::string firstExceptionMessage; |
|
16e419fe80c5
Google & Azure: Added the "EnableLegacyUnknownFiles" configuration option
Alain Mazy <am@osimis.io>
parents:
56
diff
changeset
|
97 |
|
16e419fe80c5
Google & Azure: Added the "EnableLegacyUnknownFiles" configuration option
Alain Mazy <am@osimis.io>
parents:
56
diff
changeset
|
98 for (auto& path: paths) |
| 1 | 99 { |
|
70
16e419fe80c5
Google & Azure: Added the "EnableLegacyUnknownFiles" configuration option
Alain Mazy <am@osimis.io>
parents:
56
diff
changeset
|
100 try |
|
16e419fe80c5
Google & Azure: Added the "EnableLegacyUnknownFiles" configuration option
Alain Mazy <am@osimis.io>
parents:
56
diff
changeset
|
101 { |
|
99
f4e05641c108
rewrote using the latest azure C++ sdk
Alain Mazy <am@osimis.io>
parents:
94
diff
changeset
|
102 as::BlockBlobClient blobClient = client_.GetBlockBlobClient(path); |
|
f4e05641c108
rewrote using the latest azure C++ sdk
Alain Mazy <am@osimis.io>
parents:
94
diff
changeset
|
103 auto properties = blobClient.GetProperties().Value; |
|
f4e05641c108
rewrote using the latest azure C++ sdk
Alain Mazy <am@osimis.io>
parents:
94
diff
changeset
|
104 size_ = properties.BlobSize; |
|
70
16e419fe80c5
Google & Azure: Added the "EnableLegacyUnknownFiles" configuration option
Alain Mazy <am@osimis.io>
parents:
56
diff
changeset
|
105 path_ = path; |
| 71 | 106 return; |
|
70
16e419fe80c5
Google & Azure: Added the "EnableLegacyUnknownFiles" configuration option
Alain Mazy <am@osimis.io>
parents:
56
diff
changeset
|
107 } |
|
16e419fe80c5
Google & Azure: Added the "EnableLegacyUnknownFiles" configuration option
Alain Mazy <am@osimis.io>
parents:
56
diff
changeset
|
108 catch (std::exception& ex) |
|
16e419fe80c5
Google & Azure: Added the "EnableLegacyUnknownFiles" configuration option
Alain Mazy <am@osimis.io>
parents:
56
diff
changeset
|
109 { |
|
16e419fe80c5
Google & Azure: Added the "EnableLegacyUnknownFiles" configuration option
Alain Mazy <am@osimis.io>
parents:
56
diff
changeset
|
110 if (firstExceptionMessage.empty()) |
|
16e419fe80c5
Google & Azure: Added the "EnableLegacyUnknownFiles" configuration option
Alain Mazy <am@osimis.io>
parents:
56
diff
changeset
|
111 { |
|
16e419fe80c5
Google & Azure: Added the "EnableLegacyUnknownFiles" configuration option
Alain Mazy <am@osimis.io>
parents:
56
diff
changeset
|
112 firstExceptionMessage = "AzureBlobStorage: error opening file for reading " + std::string(path) + ": " + ex.what(); |
|
16e419fe80c5
Google & Azure: Added the "EnableLegacyUnknownFiles" configuration option
Alain Mazy <am@osimis.io>
parents:
56
diff
changeset
|
113 } |
|
16e419fe80c5
Google & Azure: Added the "EnableLegacyUnknownFiles" configuration option
Alain Mazy <am@osimis.io>
parents:
56
diff
changeset
|
114 //ignore to retry |
|
16e419fe80c5
Google & Azure: Added the "EnableLegacyUnknownFiles" configuration option
Alain Mazy <am@osimis.io>
parents:
56
diff
changeset
|
115 } |
| 1 | 116 } |
|
70
16e419fe80c5
Google & Azure: Added the "EnableLegacyUnknownFiles" configuration option
Alain Mazy <am@osimis.io>
parents:
56
diff
changeset
|
117 throw StoragePluginException(firstExceptionMessage); |
| 1 | 118 } |
| 119 | |
| 120 virtual ~Reader() | |
| 121 { | |
|
70
16e419fe80c5
Google & Azure: Added the "EnableLegacyUnknownFiles" configuration option
Alain Mazy <am@osimis.io>
parents:
56
diff
changeset
|
122 } |
| 1 | 123 |
| 124 virtual size_t GetSize() | |
| 125 { | |
| 126 try | |
| 127 { | |
|
99
f4e05641c108
rewrote using the latest azure C++ sdk
Alain Mazy <am@osimis.io>
parents:
94
diff
changeset
|
128 return static_cast<size_t>(size_); |
| 1 | 129 } |
| 130 catch (std::exception& ex) | |
| 131 { | |
| 132 throw StoragePluginException("AzureBlobStorage: error while reading file " + std::string(path_) + ": " + ex.what()); | |
| 133 } | |
| 134 } | |
| 135 | |
|
39
50d0be413c42
implemented ReadRange (only in Azure plugin right now)
Alain Mazy <am@osimis.io>
parents:
37
diff
changeset
|
136 virtual void ReadWhole(char* data, size_t size) |
| 1 | 137 { |
| 138 try | |
| 139 { | |
|
99
f4e05641c108
rewrote using the latest azure C++ sdk
Alain Mazy <am@osimis.io>
parents:
94
diff
changeset
|
140 as::BlockBlobClient blobClient = client_.GetBlockBlobClient(path_); |
|
f4e05641c108
rewrote using the latest azure C++ sdk
Alain Mazy <am@osimis.io>
parents:
94
diff
changeset
|
141 blobClient.DownloadTo(reinterpret_cast<uint8_t*>(data), static_cast<int64_t>(size)); |
| 1 | 142 } |
| 143 catch (std::exception& ex) | |
| 144 { | |
| 145 throw StoragePluginException("AzureBlobStorage: error while reading file " + std::string(path_) + ": " + ex.what()); | |
| 146 } | |
| 147 } | |
| 148 | |
|
39
50d0be413c42
implemented ReadRange (only in Azure plugin right now)
Alain Mazy <am@osimis.io>
parents:
37
diff
changeset
|
149 virtual void ReadRange(char* data, size_t size, size_t fromOffset) |
|
50d0be413c42
implemented ReadRange (only in Azure plugin right now)
Alain Mazy <am@osimis.io>
parents:
37
diff
changeset
|
150 { |
|
50d0be413c42
implemented ReadRange (only in Azure plugin right now)
Alain Mazy <am@osimis.io>
parents:
37
diff
changeset
|
151 try |
|
50d0be413c42
implemented ReadRange (only in Azure plugin right now)
Alain Mazy <am@osimis.io>
parents:
37
diff
changeset
|
152 { |
|
99
f4e05641c108
rewrote using the latest azure C++ sdk
Alain Mazy <am@osimis.io>
parents:
94
diff
changeset
|
153 as::BlockBlobClient blobClient = client_.GetBlockBlobClient(path_); |
|
f4e05641c108
rewrote using the latest azure C++ sdk
Alain Mazy <am@osimis.io>
parents:
94
diff
changeset
|
154 as::DownloadBlobToOptions options; |
|
f4e05641c108
rewrote using the latest azure C++ sdk
Alain Mazy <am@osimis.io>
parents:
94
diff
changeset
|
155 options.Range = Azure::Core::Http::HttpRange(); |
|
f4e05641c108
rewrote using the latest azure C++ sdk
Alain Mazy <am@osimis.io>
parents:
94
diff
changeset
|
156 options.Range.Value().Length = static_cast<int64_t>(size); |
|
f4e05641c108
rewrote using the latest azure C++ sdk
Alain Mazy <am@osimis.io>
parents:
94
diff
changeset
|
157 options.Range.Value().Offset = static_cast<int64_t>(fromOffset); |
|
39
50d0be413c42
implemented ReadRange (only in Azure plugin right now)
Alain Mazy <am@osimis.io>
parents:
37
diff
changeset
|
158 |
|
99
f4e05641c108
rewrote using the latest azure C++ sdk
Alain Mazy <am@osimis.io>
parents:
94
diff
changeset
|
159 blobClient.DownloadTo(reinterpret_cast<uint8_t*>(data), static_cast<int64_t>(size), options); |
|
39
50d0be413c42
implemented ReadRange (only in Azure plugin right now)
Alain Mazy <am@osimis.io>
parents:
37
diff
changeset
|
160 } |
|
50d0be413c42
implemented ReadRange (only in Azure plugin right now)
Alain Mazy <am@osimis.io>
parents:
37
diff
changeset
|
161 catch (std::exception& ex) |
|
50d0be413c42
implemented ReadRange (only in Azure plugin right now)
Alain Mazy <am@osimis.io>
parents:
37
diff
changeset
|
162 { |
|
50d0be413c42
implemented ReadRange (only in Azure plugin right now)
Alain Mazy <am@osimis.io>
parents:
37
diff
changeset
|
163 throw StoragePluginException("AzureBlobStorage: error while reading partial file " + std::string(path_) + ": " + ex.what()); |
|
50d0be413c42
implemented ReadRange (only in Azure plugin right now)
Alain Mazy <am@osimis.io>
parents:
37
diff
changeset
|
164 } |
|
50d0be413c42
implemented ReadRange (only in Azure plugin right now)
Alain Mazy <am@osimis.io>
parents:
37
diff
changeset
|
165 } |
| 1 | 166 }; |
| 167 | |
| 168 | |
| 169 | |
| 170 const char* AzureBlobStoragePluginFactory::GetStoragePluginName() | |
| 171 { | |
| 172 return "Azure Blob Storage"; | |
| 173 } | |
| 174 | |
|
94
1bc055199cd2
Added a description for all plugins
Alain Mazy <am@osimis.io>
parents:
92
diff
changeset
|
175 const char* AzureBlobStoragePluginFactory::GetStorageDescription() |
|
1bc055199cd2
Added a description for all plugins
Alain Mazy <am@osimis.io>
parents:
92
diff
changeset
|
176 { |
|
1bc055199cd2
Added a description for all plugins
Alain Mazy <am@osimis.io>
parents:
92
diff
changeset
|
177 return "Stores the Orthanc storage area in Azure Blob"; |
|
1bc055199cd2
Added a description for all plugins
Alain Mazy <am@osimis.io>
parents:
92
diff
changeset
|
178 } |
|
1bc055199cd2
Added a description for all plugins
Alain Mazy <am@osimis.io>
parents:
92
diff
changeset
|
179 |
|
1bc055199cd2
Added a description for all plugins
Alain Mazy <am@osimis.io>
parents:
92
diff
changeset
|
180 |
|
99
f4e05641c108
rewrote using the latest azure C++ sdk
Alain Mazy <am@osimis.io>
parents:
94
diff
changeset
|
181 // bool IsSasTokenAccountLevel(utility::string_t sasToken) |
|
f4e05641c108
rewrote using the latest azure C++ sdk
Alain Mazy <am@osimis.io>
parents:
94
diff
changeset
|
182 // { |
|
f4e05641c108
rewrote using the latest azure C++ sdk
Alain Mazy <am@osimis.io>
parents:
94
diff
changeset
|
183 // // Use cpprestsdk's utility::string_t here since the expected argument is the return value of |
|
f4e05641c108
rewrote using the latest azure C++ sdk
Alain Mazy <am@osimis.io>
parents:
94
diff
changeset
|
184 // // as::storage_credentials::sas_token(), which is type utility::string_t (which is a std::wstring on Windows and a std::string on Linux) |
|
f4e05641c108
rewrote using the latest azure C++ sdk
Alain Mazy <am@osimis.io>
parents:
94
diff
changeset
|
185 // size_t newIdx = 0; |
|
f4e05641c108
rewrote using the latest azure C++ sdk
Alain Mazy <am@osimis.io>
parents:
94
diff
changeset
|
186 // size_t prevIdx = 0; |
|
f4e05641c108
rewrote using the latest azure C++ sdk
Alain Mazy <am@osimis.io>
parents:
94
diff
changeset
|
187 // while ((newIdx = sasToken.find('&', prevIdx)) != utility::string_t::npos) |
|
f4e05641c108
rewrote using the latest azure C++ sdk
Alain Mazy <am@osimis.io>
parents:
94
diff
changeset
|
188 // { |
|
f4e05641c108
rewrote using the latest azure C++ sdk
Alain Mazy <am@osimis.io>
parents:
94
diff
changeset
|
189 // utility::string_t kvpair = sasToken.substr(prevIdx, newIdx - prevIdx); |
|
f4e05641c108
rewrote using the latest azure C++ sdk
Alain Mazy <am@osimis.io>
parents:
94
diff
changeset
|
190 // prevIdx = newIdx + 1; // start next time from char after '&' |
|
46
3b8fab63313d
Add "CreateContainerIfNotExists" config for Azure
Mark Poscablo <Mark.Poscablo@varian.com>
parents:
15
diff
changeset
|
191 |
|
99
f4e05641c108
rewrote using the latest azure C++ sdk
Alain Mazy <am@osimis.io>
parents:
94
diff
changeset
|
192 // size_t equalsIdx = kvpair.find('='); |
|
f4e05641c108
rewrote using the latest azure C++ sdk
Alain Mazy <am@osimis.io>
parents:
94
diff
changeset
|
193 // utility::string_t key = kvpair.substr(0, equalsIdx); |
|
f4e05641c108
rewrote using the latest azure C++ sdk
Alain Mazy <am@osimis.io>
parents:
94
diff
changeset
|
194 // #ifdef WIN32 |
|
f4e05641c108
rewrote using the latest azure C++ sdk
Alain Mazy <am@osimis.io>
parents:
94
diff
changeset
|
195 // const wchar_t* srt = L"srt"; |
|
f4e05641c108
rewrote using the latest azure C++ sdk
Alain Mazy <am@osimis.io>
parents:
94
diff
changeset
|
196 // #else |
|
f4e05641c108
rewrote using the latest azure C++ sdk
Alain Mazy <am@osimis.io>
parents:
94
diff
changeset
|
197 // const char* srt = "srt"; |
|
f4e05641c108
rewrote using the latest azure C++ sdk
Alain Mazy <am@osimis.io>
parents:
94
diff
changeset
|
198 // #endif |
|
f4e05641c108
rewrote using the latest azure C++ sdk
Alain Mazy <am@osimis.io>
parents:
94
diff
changeset
|
199 // if (key == srt) // only account SAS has this parameter |
|
f4e05641c108
rewrote using the latest azure C++ sdk
Alain Mazy <am@osimis.io>
parents:
94
diff
changeset
|
200 // return true; |
| 89 | 201 |
|
99
f4e05641c108
rewrote using the latest azure C++ sdk
Alain Mazy <am@osimis.io>
parents:
94
diff
changeset
|
202 // } |
|
46
3b8fab63313d
Add "CreateContainerIfNotExists" config for Azure
Mark Poscablo <Mark.Poscablo@varian.com>
parents:
15
diff
changeset
|
203 |
|
99
f4e05641c108
rewrote using the latest azure C++ sdk
Alain Mazy <am@osimis.io>
parents:
94
diff
changeset
|
204 // return false; |
|
f4e05641c108
rewrote using the latest azure C++ sdk
Alain Mazy <am@osimis.io>
parents:
94
diff
changeset
|
205 // } |
|
46
3b8fab63313d
Add "CreateContainerIfNotExists" config for Azure
Mark Poscablo <Mark.Poscablo@varian.com>
parents:
15
diff
changeset
|
206 |
| 79 | 207 IStorage* AzureBlobStoragePluginFactory::CreateStorage(const std::string& nameForLogs, const OrthancPlugins::OrthancConfiguration& orthancConfig) |
| 1 | 208 { |
| 209 std::string connectionString; | |
| 210 std::string containerName; | |
| 15 | 211 bool enableLegacyStorageStructure; |
|
70
16e419fe80c5
Google & Azure: Added the "EnableLegacyUnknownFiles" configuration option
Alain Mazy <am@osimis.io>
parents:
56
diff
changeset
|
212 bool storageContainsUnknownFiles; |
|
46
3b8fab63313d
Add "CreateContainerIfNotExists" config for Azure
Mark Poscablo <Mark.Poscablo@varian.com>
parents:
15
diff
changeset
|
213 bool createContainerIfNotExists; |
| 1 | 214 |
| 81 | 215 if (orthancConfig.IsSection(GetConfigurationSectionName())) |
| 1 | 216 { |
| 217 OrthancPlugins::OrthancConfiguration pluginSection; | |
| 81 | 218 orthancConfig.GetSection(pluginSection, GetConfigurationSectionName()); |
| 1 | 219 |
| 78 | 220 if (!BaseStorage::ReadCommonConfiguration(enableLegacyStorageStructure, storageContainsUnknownFiles, pluginSection)) |
| 15 | 221 { |
| 222 return nullptr; | |
| 223 } | |
| 224 | |
| 1 | 225 if (!pluginSection.LookupStringValue(connectionString, "ConnectionString")) |
| 226 { | |
| 227 OrthancPlugins::LogError("AzureBlobStorage/ConnectionString configuration missing. Unable to initialize plugin"); | |
| 228 return nullptr; | |
| 229 } | |
| 230 | |
| 231 if (!pluginSection.LookupStringValue(containerName, "ContainerName")) | |
| 232 { | |
| 233 OrthancPlugins::LogError("AzureBlobStorage/ContainerName configuration missing. Unable to initialize plugin"); | |
| 234 return nullptr; | |
| 235 } | |
| 236 | |
|
12
a203d0a4fd8f
Azure: now removing spaces and CR at the end of the connectionString since it prevented the plugin to initialize.
Alain Mazy
parents:
11
diff
changeset
|
237 boost::trim(connectionString); // without that, if there's an EOL in the string, it fails with "provided uri is invalid" |
|
a203d0a4fd8f
Azure: now removing spaces and CR at the end of the connectionString since it prevented the plugin to initialize.
Alain Mazy
parents:
11
diff
changeset
|
238 boost::trim(containerName); |
|
46
3b8fab63313d
Add "CreateContainerIfNotExists" config for Azure
Mark Poscablo <Mark.Poscablo@varian.com>
parents:
15
diff
changeset
|
239 |
|
3b8fab63313d
Add "CreateContainerIfNotExists" config for Azure
Mark Poscablo <Mark.Poscablo@varian.com>
parents:
15
diff
changeset
|
240 createContainerIfNotExists = pluginSection.GetBooleanValue("CreateContainerIfNotExists", true); |
| 1 | 241 } |
| 242 else if (orthancConfig.IsSection("BlobStorage")) // backward compatibility with the old plugin: | |
| 243 { | |
| 244 OrthancPlugins::LogWarning("AzureBlobStorage: you're using an old configuration format for the plugin."); | |
| 245 | |
| 246 OrthancPlugins::OrthancConfiguration pluginSection; | |
| 247 orthancConfig.GetSection(pluginSection, "BlobStorage"); | |
| 248 | |
| 249 std::string accountName; | |
| 250 std::string accountKey; | |
| 251 | |
| 252 if (!pluginSection.LookupStringValue(containerName, "ContainerName")) | |
| 253 { | |
| 254 OrthancPlugins::LogError("BlobStorage/AccountName configuration missing. Unable to initialize plugin"); | |
| 255 return nullptr; | |
| 256 } | |
| 257 | |
| 258 if (!pluginSection.LookupStringValue(accountName, "AccountName")) | |
| 259 { | |
| 260 OrthancPlugins::LogError("BlobStorage/AccountName configuration missing. Unable to initialize plugin"); | |
| 261 return nullptr; | |
| 262 } | |
| 263 | |
| 264 if (!pluginSection.LookupStringValue(accountKey, "AccountKey")) | |
| 265 { | |
| 266 OrthancPlugins::LogError("BlobStorage/ContainerName configuration missing. Unable to initialize plugin"); | |
| 267 return nullptr; | |
| 268 } | |
| 269 | |
| 270 std::ostringstream connectionStringBuilder; | |
| 271 connectionStringBuilder << "DefaultEndpointsProtocol=https;AccountName=" << accountName << ";AccountKey=" << accountKey; | |
| 272 connectionString = connectionStringBuilder.str(); | |
|
46
3b8fab63313d
Add "CreateContainerIfNotExists" config for Azure
Mark Poscablo <Mark.Poscablo@varian.com>
parents:
15
diff
changeset
|
273 |
|
3b8fab63313d
Add "CreateContainerIfNotExists" config for Azure
Mark Poscablo <Mark.Poscablo@varian.com>
parents:
15
diff
changeset
|
274 createContainerIfNotExists = pluginSection.GetBooleanValue("CreateContainerIfNotExists", true); |
| 1 | 275 } |
| 276 else | |
| 277 { | |
| 278 OrthancPlugins::LogWarning(std::string(GetStoragePluginName()) + " plugin, section missing. Plugin is not enabled."); | |
| 279 return nullptr; | |
| 280 } | |
| 281 | |
| 282 try | |
| 283 { | |
| 11 | 284 OrthancPlugins::LogInfo("Connecting to Azure storage ..."); |
| 285 | |
|
99
f4e05641c108
rewrote using the latest azure C++ sdk
Alain Mazy <am@osimis.io>
parents:
94
diff
changeset
|
286 as::BlobContainerClient client = as::BlobContainerClient::CreateFromConnectionString(connectionString, containerName); |
| 11 | 287 OrthancPlugins::LogInfo("Blob client created"); |
| 288 | |
|
99
f4e05641c108
rewrote using the latest azure C++ sdk
Alain Mazy <am@osimis.io>
parents:
94
diff
changeset
|
289 if (createContainerIfNotExists) |
|
f4e05641c108
rewrote using the latest azure C++ sdk
Alain Mazy <am@osimis.io>
parents:
94
diff
changeset
|
290 { |
|
f4e05641c108
rewrote using the latest azure C++ sdk
Alain Mazy <am@osimis.io>
parents:
94
diff
changeset
|
291 // Note: in version up to 2.1.2, we had this code: |
|
f4e05641c108
rewrote using the latest azure C++ sdk
Alain Mazy <am@osimis.io>
parents:
94
diff
changeset
|
292 // // blobContainer.create_if_not_exists() throws an error if a service SAS (for a blob container) |
|
f4e05641c108
rewrote using the latest azure C++ sdk
Alain Mazy <am@osimis.io>
parents:
94
diff
changeset
|
293 // // was used in the connectionString. |
|
f4e05641c108
rewrote using the latest azure C++ sdk
Alain Mazy <am@osimis.io>
parents:
94
diff
changeset
|
294 // // Only allow the use of this function when using storage account-level credentials, whether |
|
f4e05641c108
rewrote using the latest azure C++ sdk
Alain Mazy <am@osimis.io>
parents:
94
diff
changeset
|
295 // // through accountName/accountKey combo or account SAS. |
|
f4e05641c108
rewrote using the latest azure C++ sdk
Alain Mazy <am@osimis.io>
parents:
94
diff
changeset
|
296 // if ((storageAccount.credentials().is_account_key() || |
|
f4e05641c108
rewrote using the latest azure C++ sdk
Alain Mazy <am@osimis.io>
parents:
94
diff
changeset
|
297 // (storageAccount.credentials().is_sas() && IsSasTokenAccountLevel(storageAccount.credentials().sas_token()))) |
|
f4e05641c108
rewrote using the latest azure C++ sdk
Alain Mazy <am@osimis.io>
parents:
94
diff
changeset
|
298 // && createContainerIfNotExists) |
| 1 | 299 |
|
99
f4e05641c108
rewrote using the latest azure C++ sdk
Alain Mazy <am@osimis.io>
parents:
94
diff
changeset
|
300 auto createResult = client.CreateIfNotExists(); |
|
f4e05641c108
rewrote using the latest azure C++ sdk
Alain Mazy <am@osimis.io>
parents:
94
diff
changeset
|
301 if (createResult.Value.Created) |
|
46
3b8fab63313d
Add "CreateContainerIfNotExists" config for Azure
Mark Poscablo <Mark.Poscablo@varian.com>
parents:
15
diff
changeset
|
302 { |
|
3b8fab63313d
Add "CreateContainerIfNotExists" config for Azure
Mark Poscablo <Mark.Poscablo@varian.com>
parents:
15
diff
changeset
|
303 OrthancPlugins::LogWarning("Blob Storage Area container has been created. **** check in the Azure console that your container is private ****"); |
|
3b8fab63313d
Add "CreateContainerIfNotExists" config for Azure
Mark Poscablo <Mark.Poscablo@varian.com>
parents:
15
diff
changeset
|
304 } |
| 1 | 305 } |
| 306 | |
| 307 OrthancPlugins::LogInfo("Blob storage initialized"); | |
| 308 | |
|
99
f4e05641c108
rewrote using the latest azure C++ sdk
Alain Mazy <am@osimis.io>
parents:
94
diff
changeset
|
309 return new AzureBlobStoragePlugin(nameForLogs, client, enableLegacyStorageStructure, storageContainsUnknownFiles); |
| 1 | 310 } |
| 311 catch (const std::exception& e) | |
| 312 { | |
| 313 OrthancPlugins::LogError(std::string("AzureBlobStorage plugin: failed to initialize plugin: ") + e.what()); | |
| 314 return nullptr; | |
| 315 } | |
| 316 | |
| 317 } | |
| 318 | |
|
99
f4e05641c108
rewrote using the latest azure C++ sdk
Alain Mazy <am@osimis.io>
parents:
94
diff
changeset
|
319 AzureBlobStoragePlugin::AzureBlobStoragePlugin(const std::string& nameForLogs, const as::BlobContainerClient& blobClient, bool enableLegacyStorageStructure, bool storageContainsUnknownFiles) |
| 79 | 320 : BaseStorage(nameForLogs, enableLegacyStorageStructure), |
| 15 | 321 blobClient_(blobClient), |
|
70
16e419fe80c5
Google & Azure: Added the "EnableLegacyUnknownFiles" configuration option
Alain Mazy <am@osimis.io>
parents:
56
diff
changeset
|
322 storageContainsUnknownFiles_(storageContainsUnknownFiles) |
| 1 | 323 { |
| 324 | |
| 325 } | |
| 326 | |
| 78 | 327 IStorage::IWriter* AzureBlobStoragePlugin::GetWriterForObject(const char* uuid, OrthancPluginContentType type, bool encryptionEnabled) |
| 1 | 328 { |
|
99
f4e05641c108
rewrote using the latest azure C++ sdk
Alain Mazy <am@osimis.io>
parents:
94
diff
changeset
|
329 return new Writer(GetPath(uuid, type, encryptionEnabled), blobClient_); |
| 1 | 330 } |
| 331 | |
| 78 | 332 IStorage::IReader* AzureBlobStoragePlugin::GetReaderForObject(const char* uuid, OrthancPluginContentType type, bool encryptionEnabled) |
| 1 | 333 { |
|
70
16e419fe80c5
Google & Azure: Added the "EnableLegacyUnknownFiles" configuration option
Alain Mazy <am@osimis.io>
parents:
56
diff
changeset
|
334 std::list<std::string> paths; |
|
16e419fe80c5
Google & Azure: Added the "EnableLegacyUnknownFiles" configuration option
Alain Mazy <am@osimis.io>
parents:
56
diff
changeset
|
335 paths.push_back(GetPath(uuid, type, encryptionEnabled, false)); |
|
16e419fe80c5
Google & Azure: Added the "EnableLegacyUnknownFiles" configuration option
Alain Mazy <am@osimis.io>
parents:
56
diff
changeset
|
336 if (storageContainsUnknownFiles_) |
|
16e419fe80c5
Google & Azure: Added the "EnableLegacyUnknownFiles" configuration option
Alain Mazy <am@osimis.io>
parents:
56
diff
changeset
|
337 { |
|
16e419fe80c5
Google & Azure: Added the "EnableLegacyUnknownFiles" configuration option
Alain Mazy <am@osimis.io>
parents:
56
diff
changeset
|
338 paths.push_back(GetPath(uuid, type, encryptionEnabled, true)); |
|
16e419fe80c5
Google & Azure: Added the "EnableLegacyUnknownFiles" configuration option
Alain Mazy <am@osimis.io>
parents:
56
diff
changeset
|
339 } |
|
16e419fe80c5
Google & Azure: Added the "EnableLegacyUnknownFiles" configuration option
Alain Mazy <am@osimis.io>
parents:
56
diff
changeset
|
340 |
|
99
f4e05641c108
rewrote using the latest azure C++ sdk
Alain Mazy <am@osimis.io>
parents:
94
diff
changeset
|
341 return new Reader(paths, blobClient_); |
| 1 | 342 } |
| 343 | |
| 344 void AzureBlobStoragePlugin::DeleteObject(const char* uuid, OrthancPluginContentType type, bool encryptionEnabled) | |
| 345 { | |
| 346 std::string path = GetPath(uuid, type, encryptionEnabled); | |
| 347 | |
| 348 try | |
| 349 { | |
|
99
f4e05641c108
rewrote using the latest azure C++ sdk
Alain Mazy <am@osimis.io>
parents:
94
diff
changeset
|
350 as::BlockBlobClient blobClient = blobClient_.GetBlockBlobClient(path); |
|
f4e05641c108
rewrote using the latest azure C++ sdk
Alain Mazy <am@osimis.io>
parents:
94
diff
changeset
|
351 blobClient.Delete(); |
| 1 | 352 } |
| 353 catch (std::exception& ex) | |
| 354 { | |
| 355 throw StoragePluginException("AzureBlobStorage: error while deleting file " + std::string(path) + ": " + ex.what()); | |
| 356 } | |
| 357 } |