Mercurial > hg > orthanc-object-storage

annotate Common/BaseStoragePlugin.h @ 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: 20
diff changeset
1 /**
b922ae86bbe1 full static linking against AWS SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 20
diff changeset
2 * Cloud storage plugins for Orthanc
b922ae86bbe1 full static linking against AWS SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 20
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: 20
diff changeset
4 *
b922ae86bbe1 full static linking against AWS SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 20
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: 20
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: 20
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: 20
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: 20
diff changeset
9 *
b922ae86bbe1 full static linking against AWS SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 20
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: 20
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: 20
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: 20
diff changeset
13 * Affero General Public License for more details.
b922ae86bbe1 full static linking against AWS SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 20
diff changeset
14 *
b922ae86bbe1 full static linking against AWS SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 20
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: 20
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: 20
diff changeset
17 **/
b922ae86bbe1 full static linking against AWS SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 20
diff changeset
18
b922ae86bbe1 full static linking against AWS SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 20
diff changeset
19
15
2a02b21f0a19 migration + storage structure
Alain Mazy
parents:
diff changeset
20 #pragma once
2a02b21f0a19 migration + storage structure
Alain Mazy
parents:
diff changeset
21
2a02b21f0a19 migration + storage structure
Alain Mazy
parents:
diff changeset
22 #include "IStoragePlugin.h"
77
80792bb9600e new HybridMode
Alain Mazy <am@osimis.io>
parents: 70
diff changeset
23 #include <boost/filesystem.hpp>
80792bb9600e new HybridMode
Alain Mazy <am@osimis.io>
parents: 70
diff changeset
24
80792bb9600e new HybridMode
Alain Mazy <am@osimis.io>
parents: 70
diff changeset
25 namespace fs = boost::filesystem;
15
2a02b21f0a19 migration + storage structure
Alain Mazy
parents:
diff changeset
26
2a02b21f0a19 migration + storage structure
Alain Mazy
parents:
diff changeset
27 class BaseStoragePlugin : public IStoragePlugin
2a02b21f0a19 migration + storage structure
Alain Mazy
parents:
diff changeset
28 {
20
968eb1c78aed Added 'RootPath' configuration
Alain Mazy
parents: 15
diff changeset
29 bool enableLegacyStorageStructure_;
968eb1c78aed Added 'RootPath' configuration
Alain Mazy
parents: 15
diff changeset
30 std::string rootPath_;
15
2a02b21f0a19 migration + storage structure
Alain Mazy
parents:
diff changeset
31
2a02b21f0a19 migration + storage structure
Alain Mazy
parents:
diff changeset
32 protected:
2a02b21f0a19 migration + storage structure
Alain Mazy
parents:
diff changeset
33
77
80792bb9600e new HybridMode
Alain Mazy <am@osimis.io>
parents: 70
diff changeset
34 BaseStoragePlugin(const std::string& nameForLogs, bool enableLegacyStorageStructure):
80792bb9600e new HybridMode
Alain Mazy <am@osimis.io>
parents: 70
diff changeset
35 IStoragePlugin(nameForLogs),
15
2a02b21f0a19 migration + storage structure
Alain Mazy
parents:
diff changeset
36 enableLegacyStorageStructure_(enableLegacyStorageStructure)
2a02b21f0a19 migration + storage structure
Alain Mazy
parents:
diff changeset
37 {}
2a02b21f0a19 migration + storage structure
Alain Mazy
parents:
diff changeset
38
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
39 std::string GetPath(const char* uuid, OrthancPluginContentType type, bool encryptionEnabled, bool useAlternateExtension = false);
15
2a02b21f0a19 migration + storage structure
Alain Mazy
parents:
diff changeset
40
2a02b21f0a19 migration + storage structure
Alain Mazy
parents:
diff changeset
41 public:
20
968eb1c78aed Added 'RootPath' configuration
Alain Mazy
parents: 15
diff changeset
42 virtual void SetRootPath(const std::string& rootPath)
968eb1c78aed Added 'RootPath' configuration
Alain Mazy
parents: 15
diff changeset
43 {
968eb1c78aed Added 'RootPath' configuration
Alain Mazy
parents: 15
diff changeset
44 rootPath_ = rootPath;
968eb1c78aed Added 'RootPath' configuration
Alain Mazy
parents: 15
diff changeset
45 }
968eb1c78aed Added 'RootPath' configuration
Alain Mazy
parents: 15
diff changeset
46
15
2a02b21f0a19 migration + storage structure
Alain Mazy
parents:
diff changeset
47 static std::string GetPath(const char* uuid, OrthancPluginContentType type, bool encryptionEnabled, bool legacyFileStructure, const std::string& rootFolder);
77
80792bb9600e new HybridMode
Alain Mazy <am@osimis.io>
parents: 70
diff changeset
48 static fs::path GetOrthancFileSystemPath(const std::string& uuid, const std::string& fileSystemRootPath);
15
2a02b21f0a19 migration + storage structure
Alain Mazy
parents:
diff changeset
49
70
16e419fe80c5 Google & Azure: Added the "EnableLegacyUnknownFiles" configuration option
Alain Mazy <am@osimis.io>
parents: 64
diff changeset
50 static bool ReadCommonConfiguration(bool& enableLegacyStorageStructure, bool& storageContainsUnknownFiles, const OrthancPlugins::OrthancConfiguration& pluginSection);
15
2a02b21f0a19 migration + storage structure
Alain Mazy
parents:
diff changeset
51 };