annotate Orthanc/Core/Toolbox.h @ 128:e8cfda4c8a2f

Sync + support of JPEG2000 lossless images with YBR_RCT photometric interpretation
author Sebastien Jodogne <s.jodogne@gmail.com>
date Fri, 15 Apr 2016 21:44:03 +0200
parents 145e654112d6
children 2c73a785c08e
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
78
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1 /**
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2 * Orthanc - A Lightweight, RESTful DICOM Store
122
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 90
diff changeset
3 * Copyright (C) 2012-2016 Sebastien Jodogne, Medical Physics
78
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4 * Department, University Hospital of Liege, Belgium
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5 *
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6 * This program is free software: you can redistribute it and/or
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7 * modify it under the terms of the GNU General Public License as
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8 * published by the Free Software Foundation, either version 3 of the
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9 * License, or (at your option) any later version.
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10 *
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11 * In addition, as a special exception, the copyright holders of this
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12 * program give permission to link the code of its release with the
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
13 * OpenSSL project's "OpenSSL" library (or with modified versions of it
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
14 * that use the same license as the "OpenSSL" library), and distribute
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
15 * the linked executables. You must obey the GNU General Public License
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
16 * in all respects for all of the code used other than "OpenSSL". If you
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
17 * modify file(s) with this exception, you may extend this exception to
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
18 * your version of the file(s), but you are not obligated to do so. If
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
19 * you do not wish to do so, delete this exception statement from your
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
20 * version. If you delete this exception statement from all source files
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
21 * in the program, then also delete it here.
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
22 *
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
23 * This program is distributed in the hope that it will be useful, but
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
24 * WITHOUT ANY WARRANTY; without even the implied warranty of
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
25 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
26 * General Public License for more details.
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
27 *
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
28 * You should have received a copy of the GNU General Public License
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
29 * along with this program. If not, see <http://www.gnu.org/licenses/>.
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
30 **/
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
31
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
32
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
33 #pragma once
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
34
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
35 #include "Enumerations.h"
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
36
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
37 #include <stdint.h>
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
38 #include <vector>
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
39 #include <string>
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
40 #include <json/json.h>
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
41
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
42 namespace Orthanc
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
43 {
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
44 typedef std::vector<std::string> UriComponents;
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
45
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
46 class NullType
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
47 {
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
48 };
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
49
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
50 namespace Toolbox
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
51 {
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
52 void ServerBarrier(const bool& stopFlag);
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
53
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
54 void ServerBarrier();
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
55
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
56 void ToUpperCase(std::string& s); // Inplace version
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
57
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
58 void ToLowerCase(std::string& s); // Inplace version
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
59
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
60 void ToUpperCase(std::string& result,
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
61 const std::string& source);
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
62
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
63 void ToLowerCase(std::string& result,
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
64 const std::string& source);
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
65
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
66 void ReadFile(std::string& content,
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
67 const std::string& path);
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
68
128
e8cfda4c8a2f Sync + support of JPEG2000 lossless images with YBR_RCT photometric interpretation
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 125
diff changeset
69 bool ReadHeader(std::string& header,
e8cfda4c8a2f Sync + support of JPEG2000 lossless images with YBR_RCT photometric interpretation
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 125
diff changeset
70 const std::string& path,
e8cfda4c8a2f Sync + support of JPEG2000 lossless images with YBR_RCT photometric interpretation
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 125
diff changeset
71 size_t headerSize);
e8cfda4c8a2f Sync + support of JPEG2000 lossless images with YBR_RCT photometric interpretation
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 125
diff changeset
72
78
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
73 void WriteFile(const std::string& content,
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
74 const std::string& path);
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
75
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
76 void WriteFile(const void* content,
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
77 size_t size,
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
78 const std::string& path);
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
79
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
80 void USleep(uint64_t microSeconds);
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
81
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
82 void RemoveFile(const std::string& path);
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
83
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
84 void SplitUriComponents(UriComponents& components,
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
85 const std::string& uri);
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
86
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
87 void TruncateUri(UriComponents& target,
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
88 const UriComponents& source,
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
89 size_t fromLevel);
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
90
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
91 bool IsChildUri(const UriComponents& baseUri,
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
92 const UriComponents& testedUri);
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
93
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
94 std::string AutodetectMimeType(const std::string& path);
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
95
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
96 std::string FlattenUri(const UriComponents& components,
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
97 size_t fromLevel = 0);
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
98
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
99 uint64_t GetFileSize(const std::string& path);
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
100
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
101 #if !defined(ORTHANC_ENABLE_MD5) || ORTHANC_ENABLE_MD5 == 1
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
102 void ComputeMD5(std::string& result,
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
103 const std::string& data);
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
104
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
105 void ComputeMD5(std::string& result,
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
106 const void* data,
90
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 79
diff changeset
107 size_t size);
78
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
108 #endif
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
109
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
110 void ComputeSHA1(std::string& result,
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
111 const std::string& data);
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
112
90
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 79
diff changeset
113 void ComputeSHA1(std::string& result,
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 79
diff changeset
114 const void* data,
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 79
diff changeset
115 size_t size);
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 79
diff changeset
116
78
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
117 bool IsSHA1(const char* str,
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
118 size_t size);
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
119
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
120 bool IsSHA1(const std::string& s);
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
121
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
122 #if !defined(ORTHANC_ENABLE_BASE64) || ORTHANC_ENABLE_BASE64 == 1
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
123 void DecodeBase64(std::string& result,
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
124 const std::string& data);
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
125
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
126 void EncodeBase64(std::string& result,
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
127 const std::string& data);
79
abdde1dfb3eb use sdk 0.9.4
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 78
diff changeset
128
abdde1dfb3eb use sdk 0.9.4
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 78
diff changeset
129 # if BOOST_HAS_REGEX == 1
abdde1dfb3eb use sdk 0.9.4
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 78
diff changeset
130 void DecodeDataUriScheme(std::string& mime,
abdde1dfb3eb use sdk 0.9.4
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 78
diff changeset
131 std::string& content,
abdde1dfb3eb use sdk 0.9.4
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 78
diff changeset
132 const std::string& source);
abdde1dfb3eb use sdk 0.9.4
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 78
diff changeset
133 # endif
90
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 79
diff changeset
134
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 79
diff changeset
135 void EncodeDataUriScheme(std::string& result,
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 79
diff changeset
136 const std::string& mime,
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 79
diff changeset
137 const std::string& content);
78
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
138 #endif
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
139
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
140 std::string GetPathToExecutable();
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
141
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
142 std::string GetDirectoryOfExecutable();
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
143
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
144 std::string ConvertToUtf8(const std::string& source,
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
145 Encoding sourceEncoding);
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
146
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
147 std::string ConvertFromUtf8(const std::string& source,
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
148 Encoding targetEncoding);
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
149
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
150 std::string ConvertToAscii(const std::string& source);
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
151
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
152 std::string StripSpaces(const std::string& source);
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
153
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
154 #if BOOST_HAS_DATE_TIME == 1
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
155 std::string GetNowIsoString();
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
156
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
157 void GetNowDicom(std::string& date,
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
158 std::string& time);
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
159 #endif
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
160
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
161 // In-place percent-decoding for URL
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
162 void UrlDecode(std::string& s);
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
163
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
164 Endianness DetectEndianness();
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
165
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
166 #if BOOST_HAS_REGEX == 1
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
167 std::string WildcardToRegularExpression(const std::string& s);
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
168 #endif
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
169
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
170 void TokenizeString(std::vector<std::string>& result,
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
171 const std::string& source,
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
172 char separator);
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
173
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
174 void MakeDirectory(const std::string& path);
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
175
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
176 bool IsExistingFile(const std::string& path);
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
177
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
178 #if ORTHANC_PUGIXML_ENABLED == 1
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
179 void JsonToXml(std::string& target,
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
180 const Json::Value& source,
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
181 const std::string& rootElement = "root",
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
182 const std::string& arrayElement = "item");
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
183 #endif
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
184
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
185 void ExecuteSystemCommand(const std::string& command,
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
186 const std::vector<std::string>& arguments);
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
187
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
188 bool IsInteger(const std::string& str);
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
189
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
190 void CopyJsonWithoutComments(Json::Value& target,
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
191 const Json::Value& source);
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
192
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
193 bool StartsWith(const std::string& str,
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
194 const std::string& prefix);
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
195
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
196 int GetProcessId();
125
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 122
diff changeset
197
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 122
diff changeset
198 bool IsRegularFile(const std::string& path);
78
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
199 }
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
200 }