Mercurial > hg > orthanc
annotate Core/Toolbox.h @ 2887:342d5321a531 lscoder/fix-drawingdicomizer-jquery-path-1480725856237
closing branch
| author | Sebastien Jodogne <s.jodogne@gmail.com> |
|---|---|
| date | Fri, 12 Oct 2018 15:20:11 +0200 |
| parents | 84d1d392a9ab |
| children | 4e8e0ad2001c |
| rev | line source |
|---|---|
| 0 | 1 /** |
| 59 | 2 * Orthanc - A Lightweight, RESTful DICOM Store |
| 1900 | 3 * Copyright (C) 2012-2016 Sebastien Jodogne, Medical Physics |
|
1288
6e7e5ed91c2d
upgrade to year 2015
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1103
diff
changeset
|
4 * Department, University Hospital of Liege, Belgium |
| 0 | 5 * |
| 6 * This program is free software: you can redistribute it and/or | |
| 7 * modify it under the terms of the GNU General Public License as | |
| 8 * published by the Free Software Foundation, either version 3 of the | |
| 9 * License, or (at your option) any later version. | |
| 136 | 10 * |
| 11 * In addition, as a special exception, the copyright holders of this | |
| 12 * program give permission to link the code of its release with the | |
| 13 * OpenSSL project's "OpenSSL" library (or with modified versions of it | |
| 14 * that use the same license as the "OpenSSL" library), and distribute | |
| 15 * the linked executables. You must obey the GNU General Public License | |
| 16 * in all respects for all of the code used other than "OpenSSL". If you | |
| 17 * modify file(s) with this exception, you may extend this exception to | |
| 18 * your version of the file(s), but you are not obligated to do so. If | |
| 19 * you do not wish to do so, delete this exception statement from your | |
| 20 * version. If you delete this exception statement from all source files | |
| 21 * in the program, then also delete it here. | |
| 0 | 22 * |
| 23 * This program is distributed in the hope that it will be useful, but | |
| 24 * WITHOUT ANY WARRANTY; without even the implied warranty of | |
| 25 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU | |
| 26 * General Public License for more details. | |
| 27 * | |
| 28 * You should have received a copy of the GNU General Public License | |
| 29 * along with this program. If not, see <http://www.gnu.org/licenses/>. | |
| 30 **/ | |
| 31 | |
| 32 | |
| 33 #pragma once | |
| 34 | |
| 453 | 35 #include "Enumerations.h" |
| 36 | |
| 0 | 37 #include <stdint.h> |
| 38 #include <vector> | |
| 39 #include <string> | |
|
1045
0bfeeb6d340f
json to xml conversion with pugixml
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
971
diff
changeset
|
40 #include <json/json.h> |
| 0 | 41 |
|
2137
595cf22b3e7e
safety checks of macros
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2136
diff
changeset
|
42 |
|
595cf22b3e7e
safety checks of macros
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2136
diff
changeset
|
43 #if !defined(ORTHANC_ENABLE_BASE64) |
|
595cf22b3e7e
safety checks of macros
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2136
diff
changeset
|
44 # error The macro ORTHANC_ENABLE_BASE64 must be defined |
|
595cf22b3e7e
safety checks of macros
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2136
diff
changeset
|
45 #endif |
|
595cf22b3e7e
safety checks of macros
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2136
diff
changeset
|
46 |
|
595cf22b3e7e
safety checks of macros
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2136
diff
changeset
|
47 #if !defined(ORTHANC_ENABLE_MD5) |
|
595cf22b3e7e
safety checks of macros
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2136
diff
changeset
|
48 # error The macro ORTHANC_ENABLE_MD5 must be defined |
|
595cf22b3e7e
safety checks of macros
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2136
diff
changeset
|
49 #endif |
|
595cf22b3e7e
safety checks of macros
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2136
diff
changeset
|
50 |
|
595cf22b3e7e
safety checks of macros
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2136
diff
changeset
|
51 #if !defined(ORTHANC_ENABLE_PUGIXML) |
|
595cf22b3e7e
safety checks of macros
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2136
diff
changeset
|
52 # error The macro ORTHANC_ENABLE_PUGIXML must be defined |
|
595cf22b3e7e
safety checks of macros
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2136
diff
changeset
|
53 #endif |
|
595cf22b3e7e
safety checks of macros
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2136
diff
changeset
|
54 |
|
595cf22b3e7e
safety checks of macros
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2136
diff
changeset
|
55 #if !defined(BOOST_HAS_REGEX) |
|
595cf22b3e7e
safety checks of macros
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2136
diff
changeset
|
56 # error The macro BOOST_HAS_REGEX must be defined |
|
595cf22b3e7e
safety checks of macros
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2136
diff
changeset
|
57 #endif |
|
595cf22b3e7e
safety checks of macros
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2136
diff
changeset
|
58 |
| 2141 | 59 |
| 60 /** | |
| 61 * NOTE: GUID vs. UUID | |
| 62 * The simple answer is: no difference, they are the same thing. Treat | |
| 63 * them as a 16 byte (128 bits) value that is used as a unique | |
| 64 * value. In Microsoft-speak they are called GUIDs, but call them | |
| 65 * UUIDs when not using Microsoft-speak. | |
| 66 * http://stackoverflow.com/questions/246930/is-there-any-difference-between-a-guid-and-a-uuid | |
| 67 **/ | |
| 68 | |
| 69 | |
| 70 | |
| 59 | 71 namespace Orthanc |
| 0 | 72 { |
| 73 typedef std::vector<std::string> UriComponents; | |
| 74 | |
|
284
06aa7b7b6723
implementation of a single-threaded cache mechanism
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
247
diff
changeset
|
75 class NullType |
|
06aa7b7b6723
implementation of a single-threaded cache mechanism
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
247
diff
changeset
|
76 { |
|
06aa7b7b6723
implementation of a single-threaded cache mechanism
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
247
diff
changeset
|
77 }; |
|
06aa7b7b6723
implementation of a single-threaded cache mechanism
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
247
diff
changeset
|
78 |
| 0 | 79 namespace Toolbox |
| 80 { | |
| 2077 | 81 void USleep(uint64_t microSeconds); |
| 82 | |
|
690
2e67366aab83
case-insensitive matching of Application Entity Titles
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
689
diff
changeset
|
83 void ToUpperCase(std::string& s); // Inplace version |
|
2e67366aab83
case-insensitive matching of Application Entity Titles
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
689
diff
changeset
|
84 |
|
2e67366aab83
case-insensitive matching of Application Entity Titles
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
689
diff
changeset
|
85 void ToLowerCase(std::string& s); // Inplace version |
| 0 | 86 |
|
690
2e67366aab83
case-insensitive matching of Application Entity Titles
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
689
diff
changeset
|
87 void ToUpperCase(std::string& result, |
|
2e67366aab83
case-insensitive matching of Application Entity Titles
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
689
diff
changeset
|
88 const std::string& source); |
|
2e67366aab83
case-insensitive matching of Application Entity Titles
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
689
diff
changeset
|
89 |
|
2e67366aab83
case-insensitive matching of Application Entity Titles
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
689
diff
changeset
|
90 void ToLowerCase(std::string& result, |
|
2e67366aab83
case-insensitive matching of Application Entity Titles
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
689
diff
changeset
|
91 const std::string& source); |
| 0 | 92 |
| 93 void SplitUriComponents(UriComponents& components, | |
| 94 const std::string& uri); | |
| 95 | |
|
966
886652370ff2
accelerating REST API matching
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
949
diff
changeset
|
96 void TruncateUri(UriComponents& target, |
|
886652370ff2
accelerating REST API matching
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
949
diff
changeset
|
97 const UriComponents& source, |
|
886652370ff2
accelerating REST API matching
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
949
diff
changeset
|
98 size_t fromLevel); |
|
886652370ff2
accelerating REST API matching
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
949
diff
changeset
|
99 |
| 0 | 100 bool IsChildUri(const UriComponents& baseUri, |
| 101 const UriComponents& testedUri); | |
| 102 | |
| 103 std::string AutodetectMimeType(const std::string& path); | |
| 104 | |
| 105 std::string FlattenUri(const UriComponents& components, | |
| 106 size_t fromLevel = 0); | |
| 107 | |
|
2137
595cf22b3e7e
safety checks of macros
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2136
diff
changeset
|
108 #if ORTHANC_ENABLE_MD5 == 1 |
| 22 | 109 void ComputeMD5(std::string& result, |
| 110 const std::string& data); | |
| 24 | 111 |
|
693
01d8611c4a60
md5 for attached files
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
690
diff
changeset
|
112 void ComputeMD5(std::string& result, |
|
01d8611c4a60
md5 for attached files
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
690
diff
changeset
|
113 const void* data, |
|
1833
47d032c48818
"OrthancPluginComputeMd5()" and "OrthancPluginComputeSha1()" to compute MD5/SHA-1 hash
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1818
diff
changeset
|
114 size_t size); |
|
1479
8f28a1cd2354
possibility to disable md5 and base64 support in the toolbox
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1446
diff
changeset
|
115 #endif |
|
693
01d8611c4a60
md5 for attached files
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
690
diff
changeset
|
116 |
| 177 | 117 void ComputeSHA1(std::string& result, |
| 118 const std::string& data); | |
| 119 | |
|
1833
47d032c48818
"OrthancPluginComputeMd5()" and "OrthancPluginComputeSha1()" to compute MD5/SHA-1 hash
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1818
diff
changeset
|
120 void ComputeSHA1(std::string& result, |
|
47d032c48818
"OrthancPluginComputeMd5()" and "OrthancPluginComputeSha1()" to compute MD5/SHA-1 hash
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1818
diff
changeset
|
121 const void* data, |
|
47d032c48818
"OrthancPluginComputeMd5()" and "OrthancPluginComputeSha1()" to compute MD5/SHA-1 hash
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1818
diff
changeset
|
122 size_t size); |
|
47d032c48818
"OrthancPluginComputeMd5()" and "OrthancPluginComputeSha1()" to compute MD5/SHA-1 hash
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1818
diff
changeset
|
123 |
|
1446
8dc80ba768aa
refactoring: IHttpHandler does not use std::string to hold the request body
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1430
diff
changeset
|
124 bool IsSHA1(const char* str, |
|
8dc80ba768aa
refactoring: IHttpHandler does not use std::string to hold the request body
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1430
diff
changeset
|
125 size_t size); |
|
8dc80ba768aa
refactoring: IHttpHandler does not use std::string to hold the request body
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1430
diff
changeset
|
126 |
|
8dc80ba768aa
refactoring: IHttpHandler does not use std::string to hold the request body
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1430
diff
changeset
|
127 bool IsSHA1(const std::string& s); |
| 402 | 128 |
|
2137
595cf22b3e7e
safety checks of macros
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2136
diff
changeset
|
129 #if ORTHANC_ENABLE_BASE64 == 1 |
|
809
8ce2f69436ca
do not return strings with base64
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
803
diff
changeset
|
130 void DecodeBase64(std::string& result, |
|
8ce2f69436ca
do not return strings with base64
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
803
diff
changeset
|
131 const std::string& data); |
| 365 | 132 |
|
809
8ce2f69436ca
do not return strings with base64
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
803
diff
changeset
|
133 void EncodeBase64(std::string& result, |
|
8ce2f69436ca
do not return strings with base64
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
803
diff
changeset
|
134 const std::string& data); |
| 1648 | 135 |
| 136 # if BOOST_HAS_REGEX == 1 | |
|
1981
4b545a8b1f95
return code in Toolbox::DecodeDataUriScheme
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1933
diff
changeset
|
137 bool DecodeDataUriScheme(std::string& mime, |
| 1648 | 138 std::string& content, |
| 139 const std::string& source); | |
| 140 # endif | |
|
1818
1065401501fb
ParsedDicomFile::CreateFromJson
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1648
diff
changeset
|
141 |
|
1065401501fb
ParsedDicomFile::CreateFromJson
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1648
diff
changeset
|
142 void EncodeDataUriScheme(std::string& result, |
|
1065401501fb
ParsedDicomFile::CreateFromJson
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1648
diff
changeset
|
143 const std::string& mime, |
|
1065401501fb
ParsedDicomFile::CreateFromJson
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1648
diff
changeset
|
144 const std::string& content); |
|
1479
8f28a1cd2354
possibility to disable md5 and base64 support in the toolbox
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1446
diff
changeset
|
145 #endif |
|
87
8517e2c44283
path to configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
59
diff
changeset
|
146 |
|
107
3b45473c0a73
replace boost::locale with iconv for debian
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
87
diff
changeset
|
147 std::string ConvertToUtf8(const std::string& source, |
| 1557 | 148 Encoding sourceEncoding); |
| 149 | |
| 150 std::string ConvertFromUtf8(const std::string& source, | |
| 151 Encoding targetEncoding); | |
|
107
3b45473c0a73
replace boost::locale with iconv for debian
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
87
diff
changeset
|
152 |
|
2129
0c09d1af22f3
"/tools/invalidate-tags" to invalidate the JSON summary of all the DICOM files
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2077
diff
changeset
|
153 bool IsAsciiString(const void* data, |
|
0c09d1af22f3
"/tools/invalidate-tags" to invalidate the JSON summary of all the DICOM files
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2077
diff
changeset
|
154 size_t size); |
|
0c09d1af22f3
"/tools/invalidate-tags" to invalidate the JSON summary of all the DICOM files
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2077
diff
changeset
|
155 |
|
107
3b45473c0a73
replace boost::locale with iconv for debian
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
87
diff
changeset
|
156 std::string ConvertToAscii(const std::string& source); |
|
187
8e673a65564d
refactoring of storing new instances
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
177
diff
changeset
|
157 |
|
247
c9b3ba0fd140
path management in zip files
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
187
diff
changeset
|
158 std::string StripSpaces(const std::string& source); |
|
c9b3ba0fd140
path management in zip files
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
187
diff
changeset
|
159 |
| 336 | 160 // In-place percent-decoding for URL |
| 161 void UrlDecode(std::string& s); | |
| 453 | 162 |
| 163 Endianness DetectEndianness(); | |
| 608 | 164 |
| 1397 | 165 #if BOOST_HAS_REGEX == 1 |
| 608 | 166 std::string WildcardToRegularExpression(const std::string& s); |
| 1397 | 167 #endif |
| 608 | 168 |
| 169 void TokenizeString(std::vector<std::string>& result, | |
| 170 const std::string& source, | |
| 171 char separator); | |
|
800
ecedd89055db
generation of DICOM images from PNG files
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
707
diff
changeset
|
172 |
|
2136
dd609a99d39a
uniformization of the macro naming
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2129
diff
changeset
|
173 #if ORTHANC_ENABLE_PUGIXML == 1 |
|
1045
0bfeeb6d340f
json to xml conversion with pugixml
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
971
diff
changeset
|
174 void JsonToXml(std::string& target, |
|
0bfeeb6d340f
json to xml conversion with pugixml
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
971
diff
changeset
|
175 const Json::Value& source, |
|
0bfeeb6d340f
json to xml conversion with pugixml
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
971
diff
changeset
|
176 const std::string& rootElement = "root", |
|
0bfeeb6d340f
json to xml conversion with pugixml
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
971
diff
changeset
|
177 const std::string& arrayElement = "item"); |
|
0bfeeb6d340f
json to xml conversion with pugixml
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
971
diff
changeset
|
178 #endif |
|
1050
64f1842aae2e
Toolbox::ExecuteSystemCommand
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1045
diff
changeset
|
179 |
|
1102
ce6386b37afd
avoid unnecessary exceptions on Orthanc startup
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1101
diff
changeset
|
180 bool IsInteger(const std::string& str); |
|
1424
fe384a9d3b51
OrthancPluginGetConfiguration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1397
diff
changeset
|
181 |
|
fe384a9d3b51
OrthancPluginGetConfiguration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1397
diff
changeset
|
182 void CopyJsonWithoutComments(Json::Value& target, |
|
fe384a9d3b51
OrthancPluginGetConfiguration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1397
diff
changeset
|
183 const Json::Value& source); |
|
1430
ad94a3583b07
Plugins can send answers as multipart messages
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1425
diff
changeset
|
184 |
|
ad94a3583b07
Plugins can send answers as multipart messages
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1425
diff
changeset
|
185 bool StartsWith(const std::string& str, |
|
ad94a3583b07
Plugins can send answers as multipart messages
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1425
diff
changeset
|
186 const std::string& prefix); |
|
1490
596927722403
support of --logdir by the internal logger
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1479
diff
changeset
|
187 |
|
2043
35ccba7adae9
Toolbox::UriEncode
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2017
diff
changeset
|
188 void UriEncode(std::string& target, |
|
35ccba7adae9
Toolbox::UriEncode
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2017
diff
changeset
|
189 const std::string& source); |
| 2071 | 190 |
| 191 std::string GetJsonStringField(const ::Json::Value& json, | |
| 192 const std::string& key, | |
| 193 const std::string& defaultValue); | |
| 194 | |
| 195 bool GetJsonBooleanField(const ::Json::Value& json, | |
| 196 const std::string& key, | |
| 197 bool defaultValue); | |
| 198 | |
| 199 int GetJsonIntegerField(const ::Json::Value& json, | |
| 200 const std::string& key, | |
| 201 int defaultValue); | |
| 202 | |
| 203 unsigned int GetJsonUnsignedIntegerField(const ::Json::Value& json, | |
| 204 const std::string& key, | |
| 205 unsigned int defaultValue); | |
| 2141 | 206 |
| 207 bool IsUuid(const std::string& str); | |
| 208 | |
| 209 bool StartsWithUuid(const std::string& str); | |
| 0 | 210 } |
| 211 } |