Mercurial > hg > orthanc

comparison OrthancFramework/Sources/FileStorage/StorageAccessor.h @ 4044:d25f4c0fa160 framework

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
splitting code into OrthancFramework and OrthancServer
author Sebastien Jodogne <s.jodogne@gmail.com>
date Wed, 10 Jun 2020 20:30:34 +0200
parents Core/FileStorage/StorageAccessor.h@94f4a18a79cc
children e00f3d089991
comparison
equal deleted inserted replaced
4043:6c6239aec462 4044:d25f4c0fa160
1 /**
2 * Orthanc - A Lightweight, RESTful DICOM Store
3 * Copyright (C) 2012-2016 Sebastien Jodogne, Medical Physics
4 * Department, University Hospital of Liege, Belgium
5 * Copyright (C) 2017-2020 Osimis S.A., Belgium
6 *
7 * This program is free software: you can redistribute it and/or
8 * modify it under the terms of the GNU General Public License as
9 * published by the Free Software Foundation, either version 3 of the
10 * License, or (at your option) any later version.
11 *
12 * In addition, as a special exception, the copyright holders of this
13 * program give permission to link the code of its release with the
14 * OpenSSL project's "OpenSSL" library (or with modified versions of it
15 * that use the same license as the "OpenSSL" library), and distribute
16 * the linked executables. You must obey the GNU General Public License
17 * in all respects for all of the code used other than "OpenSSL". If you
18 * modify file(s) with this exception, you may extend this exception to
19 * your version of the file(s), but you are not obligated to do so. If
20 * you do not wish to do so, delete this exception statement from your
21 * version. If you delete this exception statement from all source files
22 * in the program, then also delete it here.
23 *
24 * This program is distributed in the hope that it will be useful, but
25 * WITHOUT ANY WARRANTY; without even the implied warranty of
26 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
27 * General Public License for more details.
28 *
29 * You should have received a copy of the GNU General Public License
30 * along with this program. If not, see <http://www.gnu.org/licenses/>.
31 **/
32
33
34 #pragma once
35
36 #if !defined(ORTHANC_SANDBOXED)
37 # error The macro ORTHANC_SANDBOXED must be defined
38 #endif
39
40 #if ORTHANC_SANDBOXED == 1
41 # error The class StorageAccessor cannot be used in sandboxed environments
42 #endif
43
44 #if !defined(ORTHANC_ENABLE_CIVETWEB)
45 # error Macro ORTHANC_ENABLE_CIVETWEB must be defined to use this file
46 #endif
47
48 #if !defined(ORTHANC_ENABLE_MONGOOSE)
49 # error Macro ORTHANC_ENABLE_MONGOOSE must be defined to use this file
50 #endif
51
52 #include "IStorageArea.h"
53 #include "FileInfo.h"
54
55 #if ORTHANC_ENABLE_CIVETWEB == 1 || ORTHANC_ENABLE_MONGOOSE == 1
56 # include "../HttpServer/BufferHttpSender.h"
57 # include "../RestApi/RestApiOutput.h"
58 #endif
59
60 #include <vector>
61 #include <string>
62 #include <boost/noncopyable.hpp>
63 #include <stdint.h>
64
65 namespace Orthanc
66 {
67 class MetricsRegistry;
68
69 /**
70 * This class handles the compression/decompression of the raw files
71 * contained in the storage area, and monitors timing metrics (if
72 * enabled).
73 **/
74 class StorageAccessor : boost::noncopyable
75 {
76 private:
77 class MetricsTimer;
78
79 IStorageArea& area_;
80 MetricsRegistry* metrics_;
81
82 #if ORTHANC_ENABLE_CIVETWEB == 1 || ORTHANC_ENABLE_MONGOOSE == 1
83 void SetupSender(BufferHttpSender& sender,
84 const FileInfo& info,
85 const std::string& mime);
86 #endif
87
88 public:
89 StorageAccessor(IStorageArea& area) :
90 area_(area),
91 metrics_(NULL)
92 {
93 }
94
95 StorageAccessor(IStorageArea& area,
96 MetricsRegistry& metrics) :
97 area_(area),
98 metrics_(&metrics)
99 {
100 }
101
102 FileInfo Write(const void* data,
103 size_t size,
104 FileContentType type,
105 CompressionType compression,
106 bool storeMd5);
107
108 FileInfo Write(const std::string& data,
109 FileContentType type,
110 CompressionType compression,
111 bool storeMd5)
112 {
113 return Write((data.size() == 0 ? NULL : data.c_str()),
114 data.size(), type, compression, storeMd5);
115 }
116
117 void Read(std::string& content,
118 const FileInfo& info);
119
120 void ReadRaw(std::string& content,
121 const FileInfo& info);
122
123 void Remove(const std::string& fileUuid,
124 FileContentType type);
125
126 void Remove(const FileInfo& info)
127 {
128 Remove(info.GetUuid(), info.GetContentType());
129 }
130
131 #if ORTHANC_ENABLE_CIVETWEB == 1 || ORTHANC_ENABLE_MONGOOSE == 1
132 void AnswerFile(HttpOutput& output,
133 const FileInfo& info,
134 MimeType mime)
135 {
136 AnswerFile(output, info, EnumerationToString(mime));
137 }
138
139 void AnswerFile(HttpOutput& output,
140 const FileInfo& info,
141 const std::string& mime);
142
143 void AnswerFile(RestApiOutput& output,
144 const FileInfo& info,
145 MimeType mime)
146 {
147 AnswerFile(output, info, EnumerationToString(mime));
148 }
149
150 void AnswerFile(RestApiOutput& output,
151 const FileInfo& info,
152 const std::string& mime);
153 #endif
154 };
155 }