annotate Orthanc/Core/FileStorage/FilesystemStorage.h @ 172:330ecfd96aec

sync
author Sebastien Jodogne <s.jodogne@gmail.com>
date Tue, 10 Oct 2017 12:53:46 +0200
parents 5dc54316d68b
children dd1ad819ca33
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
25
15acbf5e7545 refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1 /**
15acbf5e7545 refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2 * Orthanc - A Lightweight, RESTful DICOM Store
122
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 25
diff changeset
3 * Copyright (C) 2012-2016 Sebastien Jodogne, Medical Physics
25
15acbf5e7545 refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4 * Department, University Hospital of Liege, Belgium
159
5dc54316d68b shared copyright with osimis
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 158
diff changeset
5 * Copyright (C) 2017 Osimis, Belgium
25
15acbf5e7545 refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6 *
15acbf5e7545 refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7 * This program is free software: you can redistribute it and/or
15acbf5e7545 refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8 * modify it under the terms of the GNU General Public License as
15acbf5e7545 refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9 * published by the Free Software Foundation, either version 3 of the
15acbf5e7545 refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10 * License, or (at your option) any later version.
15acbf5e7545 refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11 *
15acbf5e7545 refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12 * In addition, as a special exception, the copyright holders of this
15acbf5e7545 refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
13 * program give permission to link the code of its release with the
15acbf5e7545 refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
14 * OpenSSL project's "OpenSSL" library (or with modified versions of it
15acbf5e7545 refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
15 * that use the same license as the "OpenSSL" library), and distribute
15acbf5e7545 refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
16 * the linked executables. You must obey the GNU General Public License
15acbf5e7545 refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
17 * in all respects for all of the code used other than "OpenSSL". If you
15acbf5e7545 refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
18 * modify file(s) with this exception, you may extend this exception to
15acbf5e7545 refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
19 * your version of the file(s), but you are not obligated to do so. If
15acbf5e7545 refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
20 * you do not wish to do so, delete this exception statement from your
15acbf5e7545 refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
21 * version. If you delete this exception statement from all source files
15acbf5e7545 refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
22 * in the program, then also delete it here.
15acbf5e7545 refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
23 *
15acbf5e7545 refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
24 * This program is distributed in the hope that it will be useful, but
15acbf5e7545 refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
25 * WITHOUT ANY WARRANTY; without even the implied warranty of
15acbf5e7545 refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
26 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
15acbf5e7545 refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
27 * General Public License for more details.
15acbf5e7545 refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
28 *
15acbf5e7545 refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
29 * You should have received a copy of the GNU General Public License
15acbf5e7545 refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
30 * along with this program. If not, see <http://www.gnu.org/licenses/>.
15acbf5e7545 refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
31 **/
15acbf5e7545 refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
32
15acbf5e7545 refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
33
15acbf5e7545 refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
34 #pragma once
15acbf5e7545 refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
35
172
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 159
diff changeset
36 #if !defined(ORTHANC_SANDBOXED)
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 159
diff changeset
37 # error The macro ORTHANC_SANDBOXED must be defined
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 159
diff changeset
38 #endif
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 159
diff changeset
39
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 159
diff changeset
40 #if ORTHANC_SANDBOXED == 1
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 159
diff changeset
41 # error The class FilesystemStorage cannot be used in sandboxed environments
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 159
diff changeset
42 #endif
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 159
diff changeset
43
25
15acbf5e7545 refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
44 #include "IStorageArea.h"
15acbf5e7545 refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
45
15acbf5e7545 refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
46 #include <stdint.h>
15acbf5e7545 refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
47 #include <boost/filesystem.hpp>
15acbf5e7545 refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
48 #include <set>
15acbf5e7545 refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
49
15acbf5e7545 refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
50 namespace Orthanc
15acbf5e7545 refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
51 {
15acbf5e7545 refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
52 class FilesystemStorage : public IStorageArea
15acbf5e7545 refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
53 {
15acbf5e7545 refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
54 // TODO REMOVE THIS
15acbf5e7545 refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
55 friend class FilesystemHttpSender;
15acbf5e7545 refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
56 friend class FileStorageAccessor;
15acbf5e7545 refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
57
15acbf5e7545 refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
58 private:
15acbf5e7545 refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
59 boost::filesystem::path root_;
15acbf5e7545 refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
60
15acbf5e7545 refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
61 boost::filesystem::path GetPath(const std::string& uuid) const;
15acbf5e7545 refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
62
15acbf5e7545 refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
63 public:
158
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 122
diff changeset
64 explicit FilesystemStorage(std::string root);
25
15acbf5e7545 refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
65
15acbf5e7545 refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
66 virtual void Create(const std::string& uuid,
15acbf5e7545 refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
67 const void* content,
15acbf5e7545 refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
68 size_t size,
15acbf5e7545 refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
69 FileContentType type);
15acbf5e7545 refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
70
15acbf5e7545 refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
71 virtual void Read(std::string& content,
15acbf5e7545 refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
72 const std::string& uuid,
15acbf5e7545 refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
73 FileContentType type);
15acbf5e7545 refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
74
15acbf5e7545 refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
75 virtual void Remove(const std::string& uuid,
15acbf5e7545 refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
76 FileContentType type);
15acbf5e7545 refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
77
15acbf5e7545 refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
78 void ListAllFiles(std::set<std::string>& result) const;
15acbf5e7545 refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
79
15acbf5e7545 refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
80 uintmax_t GetSize(const std::string& uuid) const;
15acbf5e7545 refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
81
15acbf5e7545 refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
82 void Clear();
15acbf5e7545 refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
83
15acbf5e7545 refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
84 uintmax_t GetCapacity() const;
15acbf5e7545 refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
85
15acbf5e7545 refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
86 uintmax_t GetAvailableSpace() const;
15acbf5e7545 refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
87 };
15acbf5e7545 refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
88 }