Mercurial > hg > orthanc-object-storage

annotate Common/BaseStoragePlugin.cpp @ 77:80792bb9600e

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
new HybridMode
author Alain Mazy <am@osimis.io>
date Fri, 14 Oct 2022 10:36:02 +0200
parents 16e419fe80c5
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
56
b922ae86bbe1 full static linking against AWS SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 55
diff changeset
1 /**
b922ae86bbe1 full static linking against AWS SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 55
diff changeset
2 * Cloud storage plugins for Orthanc
b922ae86bbe1 full static linking against AWS SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 55
diff changeset
3 * Copyright (C) 2020-2021 Osimis S.A., Belgium
b922ae86bbe1 full static linking against AWS SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 55
diff changeset
4 *
b922ae86bbe1 full static linking against AWS SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 55
diff changeset
5 * This program is free software: you can redistribute it and/or
b922ae86bbe1 full static linking against AWS SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 55
diff changeset
6 * modify it under the terms of the GNU Affero General Public License
b922ae86bbe1 full static linking against AWS SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 55
diff changeset
7 * as published by the Free Software Foundation, either version 3 of
b922ae86bbe1 full static linking against AWS SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 55
diff changeset
8 * the License, or (at your option) any later version.
b922ae86bbe1 full static linking against AWS SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 55
diff changeset
9 *
b922ae86bbe1 full static linking against AWS SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 55
diff changeset
10 * This program is distributed in the hope that it will be useful, but
b922ae86bbe1 full static linking against AWS SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 55
diff changeset
11 * WITHOUT ANY WARRANTY; without even the implied warranty of
b922ae86bbe1 full static linking against AWS SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 55
diff changeset
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
b922ae86bbe1 full static linking against AWS SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 55
diff changeset
13 * Affero General Public License for more details.
b922ae86bbe1 full static linking against AWS SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 55
diff changeset
14 *
b922ae86bbe1 full static linking against AWS SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 55
diff changeset
15 * You should have received a copy of the GNU Affero General Public License
b922ae86bbe1 full static linking against AWS SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 55
diff changeset
16 * along with this program. If not, see <http://www.gnu.org/licenses/>.
b922ae86bbe1 full static linking against AWS SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 55
diff changeset
17 **/
b922ae86bbe1 full static linking against AWS SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 55
diff changeset
18
b922ae86bbe1 full static linking against AWS SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 55
diff changeset
19
15
2a02b21f0a19 migration + storage structure
Alain Mazy
parents:
diff changeset
20 #include "BaseStoragePlugin.h"
2a02b21f0a19 migration + storage structure
Alain Mazy
parents:
diff changeset
21 #include <boost/filesystem/fstream.hpp>
2a02b21f0a19 migration + storage structure
Alain Mazy
parents:
diff changeset
22
77
80792bb9600e new HybridMode
Alain Mazy <am@osimis.io>
parents: 70
diff changeset
23 boost::filesystem::path BaseStoragePlugin::GetOrthancFileSystemPath(const std::string& uuid, const std::string& fileSystemRootPath)
15
2a02b21f0a19 migration + storage structure
Alain Mazy
parents:
diff changeset
24 {
2a02b21f0a19 migration + storage structure
Alain Mazy
parents:
diff changeset
25 boost::filesystem::path path = fileSystemRootPath;
2a02b21f0a19 migration + storage structure
Alain Mazy
parents:
diff changeset
26
2a02b21f0a19 migration + storage structure
Alain Mazy
parents:
diff changeset
27 path /= std::string(&uuid[0], &uuid[2]);
2a02b21f0a19 migration + storage structure
Alain Mazy
parents:
diff changeset
28 path /= std::string(&uuid[2], &uuid[4]);
2a02b21f0a19 migration + storage structure
Alain Mazy
parents:
diff changeset
29 path /= uuid;
2a02b21f0a19 migration + storage structure
Alain Mazy
parents:
diff changeset
30
2a02b21f0a19 migration + storage structure
Alain Mazy
parents:
diff changeset
31 path.make_preferred();
2a02b21f0a19 migration + storage structure
Alain Mazy
parents:
diff changeset
32
77
80792bb9600e new HybridMode
Alain Mazy <am@osimis.io>
parents: 70
diff changeset
33 return path;
15
2a02b21f0a19 migration + storage structure
Alain Mazy
parents:
diff changeset
34 }
2a02b21f0a19 migration + storage structure
Alain Mazy
parents:
diff changeset
35
2a02b21f0a19 migration + storage structure
Alain Mazy
parents:
diff changeset
36
64
c4f56973a279 Fix reading/deleting DCM header files that were saved with plugin v 1.2.0 and Orthanc 1.9.3 which had a .unk extension
Alain Mazy <am@osimis.io>
parents: 56
diff changeset
37 std::string BaseStoragePlugin::GetPath(const char* uuid, OrthancPluginContentType type, bool encryptionEnabled, bool useAlternateExtension)
15
2a02b21f0a19 migration + storage structure
Alain Mazy
parents:
diff changeset
38 {
2a02b21f0a19 migration + storage structure
Alain Mazy
parents:
diff changeset
39 if (enableLegacyStorageStructure_)
2a02b21f0a19 migration + storage structure
Alain Mazy
parents:
diff changeset
40 {
77
80792bb9600e new HybridMode
Alain Mazy <am@osimis.io>
parents: 70
diff changeset
41 return GetOrthancFileSystemPath(uuid, rootPath_).string();
15
2a02b21f0a19 migration + storage structure
Alain Mazy
parents:
diff changeset
42 }
2a02b21f0a19 migration + storage structure
Alain Mazy
parents:
diff changeset
43 else
2a02b21f0a19 migration + storage structure
Alain Mazy
parents:
diff changeset
44 {
20
968eb1c78aed Added 'RootPath' configuration
Alain Mazy
parents: 15
diff changeset
45 boost::filesystem::path path = rootPath_;
968eb1c78aed Added 'RootPath' configuration
Alain Mazy
parents: 15
diff changeset
46 std::string filename = std::string(uuid);
15
2a02b21f0a19 migration + storage structure
Alain Mazy
parents:
diff changeset
47
2a02b21f0a19 migration + storage structure
Alain Mazy
parents:
diff changeset
48 if (type == OrthancPluginContentType_Dicom)
2a02b21f0a19 migration + storage structure
Alain Mazy
parents:
diff changeset
49 {
20
968eb1c78aed Added 'RootPath' configuration
Alain Mazy
parents: 15
diff changeset
50 filename += ".dcm";
15
2a02b21f0a19 migration + storage structure
Alain Mazy
parents:
diff changeset
51 }
2a02b21f0a19 migration + storage structure
Alain Mazy
parents:
diff changeset
52 else if (type == OrthancPluginContentType_DicomAsJson)
2a02b21f0a19 migration + storage structure
Alain Mazy
parents:
diff changeset
53 {
20
968eb1c78aed Added 'RootPath' configuration
Alain Mazy
parents: 15
diff changeset
54 filename += ".json";
15
2a02b21f0a19 migration + storage structure
Alain Mazy
parents:
diff changeset
55 }
64
c4f56973a279 Fix reading/deleting DCM header files that were saved with plugin v 1.2.0 and Orthanc 1.9.3 which had a .unk extension
Alain Mazy <am@osimis.io>
parents: 56
diff changeset
56 else if (type == OrthancPluginContentType_DicomUntilPixelData && !useAlternateExtension) // for some time, header files were saved with .unk (happened with S3 storage plugin between version 1.2.0 and 1.3.0 - 21.5.1 and 21.6.2)
39
50d0be413c42 implemented ReadRange (only in Azure plugin right now)
Alain Mazy <am@osimis.io>
parents: 20
diff changeset
57 {
55
9d03e24dafc1 fix extension of DCM header files
Alain Mazy <am@osimis.io>
parents: 49
diff changeset
58 filename += ".dcm.head";
39
50d0be413c42 implemented ReadRange (only in Azure plugin right now)
Alain Mazy <am@osimis.io>
parents: 20
diff changeset
59 }
15
2a02b21f0a19 migration + storage structure
Alain Mazy
parents:
diff changeset
60 else
2a02b21f0a19 migration + storage structure
Alain Mazy
parents:
diff changeset
61 {
20
968eb1c78aed Added 'RootPath' configuration
Alain Mazy
parents: 15
diff changeset
62 filename += ".unk";
15
2a02b21f0a19 migration + storage structure
Alain Mazy
parents:
diff changeset
63 }
2a02b21f0a19 migration + storage structure
Alain Mazy
parents:
diff changeset
64
2a02b21f0a19 migration + storage structure
Alain Mazy
parents:
diff changeset
65 if (encryptionEnabled)
2a02b21f0a19 migration + storage structure
Alain Mazy
parents:
diff changeset
66 {
20
968eb1c78aed Added 'RootPath' configuration
Alain Mazy
parents: 15
diff changeset
67 filename += ".enc";
15
2a02b21f0a19 migration + storage structure
Alain Mazy
parents:
diff changeset
68 }
20
968eb1c78aed Added 'RootPath' configuration
Alain Mazy
parents: 15
diff changeset
69 path /= filename;
968eb1c78aed Added 'RootPath' configuration
Alain Mazy
parents: 15
diff changeset
70
968eb1c78aed Added 'RootPath' configuration
Alain Mazy
parents: 15
diff changeset
71 return path.string();
15
2a02b21f0a19 migration + storage structure
Alain Mazy
parents:
diff changeset
72 }
2a02b21f0a19 migration + storage structure
Alain Mazy
parents:
diff changeset
73 }
2a02b21f0a19 migration + storage structure
Alain Mazy
parents:
diff changeset
74
70
16e419fe80c5 Google & Azure: Added the "EnableLegacyUnknownFiles" configuration option
Alain Mazy <am@osimis.io>
parents: 64
diff changeset
75 bool BaseStoragePlugin::ReadCommonConfiguration(bool& enableLegacyStorageStructure, bool& storageContainsUnknownFiles, const OrthancPlugins::OrthancConfiguration& pluginSection)
15
2a02b21f0a19 migration + storage structure
Alain Mazy
parents:
diff changeset
76 {
2a02b21f0a19 migration + storage structure
Alain Mazy
parents:
diff changeset
77 std::string storageStructure = pluginSection.GetStringValue("StorageStructure", "flat");
2a02b21f0a19 migration + storage structure
Alain Mazy
parents:
diff changeset
78 if (storageStructure == "flat")
2a02b21f0a19 migration + storage structure
Alain Mazy
parents:
diff changeset
79 {
2a02b21f0a19 migration + storage structure
Alain Mazy
parents:
diff changeset
80 enableLegacyStorageStructure = false;
2a02b21f0a19 migration + storage structure
Alain Mazy
parents:
diff changeset
81 }
2a02b21f0a19 migration + storage structure
Alain Mazy
parents:
diff changeset
82 else
2a02b21f0a19 migration + storage structure
Alain Mazy
parents:
diff changeset
83 {
2a02b21f0a19 migration + storage structure
Alain Mazy
parents:
diff changeset
84 enableLegacyStorageStructure = true;
2a02b21f0a19 migration + storage structure
Alain Mazy
parents:
diff changeset
85 if (storageStructure != "legacy")
2a02b21f0a19 migration + storage structure
Alain Mazy
parents:
diff changeset
86 {
2a02b21f0a19 migration + storage structure
Alain Mazy
parents:
diff changeset
87 OrthancPlugins::LogError("ObjectStorage/StorageStructure configuration invalid value: " + storageStructure + ", allowed values are 'flat' and 'legacy'");
2a02b21f0a19 migration + storage structure
Alain Mazy
parents:
diff changeset
88 return false;
2a02b21f0a19 migration + storage structure
Alain Mazy
parents:
diff changeset
89 }
2a02b21f0a19 migration + storage structure
Alain Mazy
parents:
diff changeset
90 }
2a02b21f0a19 migration + storage structure
Alain Mazy
parents:
diff changeset
91
70
16e419fe80c5 Google & Azure: Added the "EnableLegacyUnknownFiles" configuration option
Alain Mazy <am@osimis.io>
parents: 64
diff changeset
92 storageContainsUnknownFiles = pluginSection.GetBooleanValue("EnableLegacyUnknownFiles", false);
16e419fe80c5 Google & Azure: Added the "EnableLegacyUnknownFiles" configuration option
Alain Mazy <am@osimis.io>
parents: 64
diff changeset
93
15
2a02b21f0a19 migration + storage structure
Alain Mazy
parents:
diff changeset
94 return true;
2a02b21f0a19 migration + storage structure
Alain Mazy
parents:
diff changeset
95 }