annotate Orthanc/Core/Toolbox.h @ 122:3809121c3290

2016
author Sebastien Jodogne <s.jodogne@gmail.com>
date Mon, 04 Jan 2016 13:30:43 +0100
parents a54260a7fe59
children 145e654112d6
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
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
69 void WriteFile(const std::string& content,
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
70 const std::string& path);
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
71
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
72 void WriteFile(const void* content,
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
73 size_t size,
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 USleep(uint64_t microSeconds);
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
77
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
78 void RemoveFile(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 SplitUriComponents(UriComponents& components,
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
81 const std::string& uri);
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
82
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
83 void TruncateUri(UriComponents& target,
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
84 const UriComponents& source,
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
85 size_t fromLevel);
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
86
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
87 bool IsChildUri(const UriComponents& baseUri,
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
88 const UriComponents& testedUri);
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
89
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
90 std::string AutodetectMimeType(const std::string& path);
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
91
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
92 std::string FlattenUri(const UriComponents& components,
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
93 size_t fromLevel = 0);
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
94
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
95 uint64_t GetFileSize(const std::string& path);
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
96
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
97 #if !defined(ORTHANC_ENABLE_MD5) || ORTHANC_ENABLE_MD5 == 1
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
98 void ComputeMD5(std::string& result,
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
99 const std::string& data);
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
100
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
101 void ComputeMD5(std::string& result,
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
102 const void* data,
90
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 79
diff changeset
103 size_t size);
78
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
104 #endif
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
105
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
106 void ComputeSHA1(std::string& result,
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
107 const std::string& data);
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
108
90
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 79
diff changeset
109 void ComputeSHA1(std::string& result,
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 79
diff changeset
110 const void* data,
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 79
diff changeset
111 size_t size);
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 79
diff changeset
112
78
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
113 bool IsSHA1(const char* str,
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
114 size_t size);
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
115
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
116 bool IsSHA1(const std::string& s);
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
117
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
118 #if !defined(ORTHANC_ENABLE_BASE64) || ORTHANC_ENABLE_BASE64 == 1
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
119 void DecodeBase64(std::string& result,
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
120 const std::string& data);
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
121
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
122 void EncodeBase64(std::string& result,
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
123 const std::string& data);
79
abdde1dfb3eb use sdk 0.9.4
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 78
diff changeset
124
abdde1dfb3eb use sdk 0.9.4
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 78
diff changeset
125 # if BOOST_HAS_REGEX == 1
abdde1dfb3eb use sdk 0.9.4
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 78
diff changeset
126 void DecodeDataUriScheme(std::string& mime,
abdde1dfb3eb use sdk 0.9.4
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 78
diff changeset
127 std::string& content,
abdde1dfb3eb use sdk 0.9.4
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 78
diff changeset
128 const std::string& source);
abdde1dfb3eb use sdk 0.9.4
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 78
diff changeset
129 # endif
90
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 79
diff changeset
130
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 79
diff changeset
131 void EncodeDataUriScheme(std::string& result,
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 79
diff changeset
132 const std::string& mime,
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 79
diff changeset
133 const std::string& content);
78
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
134 #endif
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
135
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
136 std::string GetPathToExecutable();
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
137
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
138 std::string GetDirectoryOfExecutable();
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
139
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
140 std::string ConvertToUtf8(const std::string& source,
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
141 Encoding sourceEncoding);
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
142
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
143 std::string ConvertFromUtf8(const std::string& source,
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
144 Encoding targetEncoding);
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
145
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
146 std::string ConvertToAscii(const std::string& source);
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
147
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
148 std::string StripSpaces(const std::string& source);
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
149
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
150 #if BOOST_HAS_DATE_TIME == 1
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
151 std::string GetNowIsoString();
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
152
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
153 void GetNowDicom(std::string& date,
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
154 std::string& time);
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
155 #endif
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
156
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
157 // In-place percent-decoding for URL
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
158 void UrlDecode(std::string& s);
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
159
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
160 Endianness DetectEndianness();
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
161
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
162 #if BOOST_HAS_REGEX == 1
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
163 std::string WildcardToRegularExpression(const std::string& s);
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
164 #endif
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
165
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
166 void TokenizeString(std::vector<std::string>& result,
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
167 const std::string& source,
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
168 char separator);
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
169
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
170 void MakeDirectory(const std::string& path);
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
171
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
172 bool IsExistingFile(const std::string& path);
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
173
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
174 #if ORTHANC_PUGIXML_ENABLED == 1
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
175 void JsonToXml(std::string& target,
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
176 const Json::Value& source,
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
177 const std::string& rootElement = "root",
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
178 const std::string& arrayElement = "item");
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
179 #endif
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
180
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
181 void ExecuteSystemCommand(const std::string& command,
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
182 const std::vector<std::string>& arguments);
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
183
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
184 bool IsInteger(const std::string& str);
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
185
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
186 void CopyJsonWithoutComments(Json::Value& target,
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
187 const Json::Value& source);
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
188
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
189 bool StartsWith(const std::string& str,
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
190 const std::string& prefix);
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
191
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
192 int GetProcessId();
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
193 }
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
194 }