Mercurial > hg > orthanc
annotate Core/Toolbox.h @ 2019:9c9332e486ca
HTTPS client certificates can be associated with Orthanc peers to enhance security over Internet
| author | Sebastien Jodogne <s.jodogne@gmail.com> |
|---|---|
| date | Tue, 14 Jun 2016 17:53:23 +0200 |
| parents | 08ce34cfacad |
| children | 35ccba7adae9 |
| 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 |
| 59 | 42 namespace Orthanc |
| 0 | 43 { |
| 44 typedef std::vector<std::string> UriComponents; | |
| 45 | |
|
284
06aa7b7b6723
implementation of a single-threaded cache mechanism
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
247
diff
changeset
|
46 class NullType |
|
06aa7b7b6723
implementation of a single-threaded cache mechanism
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
247
diff
changeset
|
47 { |
|
06aa7b7b6723
implementation of a single-threaded cache mechanism
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
247
diff
changeset
|
48 }; |
|
06aa7b7b6723
implementation of a single-threaded cache mechanism
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
247
diff
changeset
|
49 |
| 0 | 50 namespace Toolbox |
| 51 { | |
|
2009
e2dd40abce72
catching SIGHUP signal
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1981
diff
changeset
|
52 ServerBarrierEvent ServerBarrier(const bool& stopFlag); |
|
1101
e5686a703c63
ServerBarrier with external stop condition
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1050
diff
changeset
|
53 |
|
2009
e2dd40abce72
catching SIGHUP signal
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1981
diff
changeset
|
54 ServerBarrierEvent ServerBarrier(); |
| 0 | 55 |
|
690
2e67366aab83
case-insensitive matching of Application Entity Titles
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
689
diff
changeset
|
56 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
|
57 |
|
2e67366aab83
case-insensitive matching of Application Entity Titles
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
689
diff
changeset
|
58 void ToLowerCase(std::string& s); // Inplace version |
| 0 | 59 |
|
690
2e67366aab83
case-insensitive matching of Application Entity Titles
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
689
diff
changeset
|
60 void ToUpperCase(std::string& result, |
|
2e67366aab83
case-insensitive matching of Application Entity Titles
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
689
diff
changeset
|
61 const std::string& source); |
|
2e67366aab83
case-insensitive matching of Application Entity Titles
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
689
diff
changeset
|
62 |
|
2e67366aab83
case-insensitive matching of Application Entity Titles
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
689
diff
changeset
|
63 void ToLowerCase(std::string& result, |
|
2e67366aab83
case-insensitive matching of Application Entity Titles
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
689
diff
changeset
|
64 const std::string& source); |
| 0 | 65 |
| 66 void ReadFile(std::string& content, | |
| 67 const std::string& path); | |
| 68 | |
|
1933
ff11ba08e5d0
Toolbox::ReadHeader
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1911
diff
changeset
|
69 bool ReadHeader(std::string& header, |
|
ff11ba08e5d0
Toolbox::ReadHeader
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1911
diff
changeset
|
70 const std::string& path, |
|
ff11ba08e5d0
Toolbox::ReadHeader
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1911
diff
changeset
|
71 size_t headerSize); |
|
ff11ba08e5d0
Toolbox::ReadHeader
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1911
diff
changeset
|
72 |
|
483
8c3573d28868
export dicom instances to the filesystem
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
477
diff
changeset
|
73 void WriteFile(const std::string& content, |
|
8c3573d28868
export dicom instances to the filesystem
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
477
diff
changeset
|
74 const std::string& path); |
|
8c3573d28868
export dicom instances to the filesystem
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
477
diff
changeset
|
75 |
|
1588
b5bc87a7212d
OrthancPluginReadFile, OrthancPluginWriteFile
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1565
diff
changeset
|
76 void WriteFile(const void* content, |
|
b5bc87a7212d
OrthancPluginReadFile, OrthancPluginWriteFile
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1565
diff
changeset
|
77 size_t size, |
|
b5bc87a7212d
OrthancPluginReadFile, OrthancPluginWriteFile
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1565
diff
changeset
|
78 const std::string& path); |
|
b5bc87a7212d
OrthancPluginReadFile, OrthancPluginWriteFile
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1565
diff
changeset
|
79 |
| 0 | 80 void USleep(uint64_t microSeconds); |
| 81 | |
| 82 void RemoveFile(const std::string& path); | |
| 83 | |
| 84 void SplitUriComponents(UriComponents& components, | |
| 85 const std::string& uri); | |
| 86 | |
|
966
886652370ff2
accelerating REST API matching
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
949
diff
changeset
|
87 void TruncateUri(UriComponents& target, |
|
886652370ff2
accelerating REST API matching
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
949
diff
changeset
|
88 const UriComponents& source, |
|
886652370ff2
accelerating REST API matching
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
949
diff
changeset
|
89 size_t fromLevel); |
|
886652370ff2
accelerating REST API matching
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
949
diff
changeset
|
90 |
| 0 | 91 bool IsChildUri(const UriComponents& baseUri, |
| 92 const UriComponents& testedUri); | |
| 93 | |
| 94 std::string AutodetectMimeType(const std::string& path); | |
| 95 | |
| 96 std::string FlattenUri(const UriComponents& components, | |
| 97 size_t fromLevel = 0); | |
| 98 | |
| 99 uint64_t GetFileSize(const std::string& path); | |
| 22 | 100 |
|
1479
8f28a1cd2354
possibility to disable md5 and base64 support in the toolbox
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1446
diff
changeset
|
101 #if !defined(ORTHANC_ENABLE_MD5) || ORTHANC_ENABLE_MD5 == 1 |
| 22 | 102 void ComputeMD5(std::string& result, |
| 103 const std::string& data); | |
| 24 | 104 |
|
693
01d8611c4a60
md5 for attached files
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
690
diff
changeset
|
105 void ComputeMD5(std::string& result, |
|
01d8611c4a60
md5 for attached files
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
690
diff
changeset
|
106 const void* data, |
|
1833
47d032c48818
"OrthancPluginComputeMd5()" and "OrthancPluginComputeSha1()" to compute MD5/SHA-1 hash
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1818
diff
changeset
|
107 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
|
108 #endif |
|
693
01d8611c4a60
md5 for attached files
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
690
diff
changeset
|
109 |
| 177 | 110 void ComputeSHA1(std::string& result, |
| 111 const std::string& data); | |
| 112 | |
|
1833
47d032c48818
"OrthancPluginComputeMd5()" and "OrthancPluginComputeSha1()" to compute MD5/SHA-1 hash
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1818
diff
changeset
|
113 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
|
114 const void* data, |
|
47d032c48818
"OrthancPluginComputeMd5()" and "OrthancPluginComputeSha1()" to compute MD5/SHA-1 hash
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1818
diff
changeset
|
115 size_t size); |
|
47d032c48818
"OrthancPluginComputeMd5()" and "OrthancPluginComputeSha1()" to compute MD5/SHA-1 hash
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1818
diff
changeset
|
116 |
|
1446
8dc80ba768aa
refactoring: IHttpHandler does not use std::string to hold the request body
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1430
diff
changeset
|
117 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
|
118 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
|
119 |
|
8dc80ba768aa
refactoring: IHttpHandler does not use std::string to hold the request body
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1430
diff
changeset
|
120 bool IsSHA1(const std::string& s); |
| 402 | 121 |
|
1479
8f28a1cd2354
possibility to disable md5 and base64 support in the toolbox
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1446
diff
changeset
|
122 #if !defined(ORTHANC_ENABLE_BASE64) || ORTHANC_ENABLE_BASE64 == 1 |
|
809
8ce2f69436ca
do not return strings with base64
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
803
diff
changeset
|
123 void DecodeBase64(std::string& result, |
|
8ce2f69436ca
do not return strings with base64
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
803
diff
changeset
|
124 const std::string& data); |
| 365 | 125 |
|
809
8ce2f69436ca
do not return strings with base64
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
803
diff
changeset
|
126 void EncodeBase64(std::string& result, |
|
8ce2f69436ca
do not return strings with base64
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
803
diff
changeset
|
127 const std::string& data); |
| 1648 | 128 |
| 129 # if BOOST_HAS_REGEX == 1 | |
|
1981
4b545a8b1f95
return code in Toolbox::DecodeDataUriScheme
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1933
diff
changeset
|
130 bool DecodeDataUriScheme(std::string& mime, |
| 1648 | 131 std::string& content, |
| 132 const std::string& source); | |
| 133 # endif | |
|
1818
1065401501fb
ParsedDicomFile::CreateFromJson
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1648
diff
changeset
|
134 |
|
1065401501fb
ParsedDicomFile::CreateFromJson
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1648
diff
changeset
|
135 void EncodeDataUriScheme(std::string& result, |
|
1065401501fb
ParsedDicomFile::CreateFromJson
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1648
diff
changeset
|
136 const std::string& mime, |
|
1065401501fb
ParsedDicomFile::CreateFromJson
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1648
diff
changeset
|
137 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
|
138 #endif |
|
87
8517e2c44283
path to configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
59
diff
changeset
|
139 |
|
8517e2c44283
path to configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
59
diff
changeset
|
140 std::string GetPathToExecutable(); |
|
8517e2c44283
path to configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
59
diff
changeset
|
141 |
|
8517e2c44283
path to configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
59
diff
changeset
|
142 std::string GetDirectoryOfExecutable(); |
|
107
3b45473c0a73
replace boost::locale with iconv for debian
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
87
diff
changeset
|
143 |
|
3b45473c0a73
replace boost::locale with iconv for debian
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
87
diff
changeset
|
144 std::string ConvertToUtf8(const std::string& source, |
| 1557 | 145 Encoding sourceEncoding); |
| 146 | |
| 147 std::string ConvertFromUtf8(const std::string& source, | |
| 148 Encoding targetEncoding); | |
|
107
3b45473c0a73
replace boost::locale with iconv for debian
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
87
diff
changeset
|
149 |
|
3b45473c0a73
replace boost::locale with iconv for debian
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
87
diff
changeset
|
150 std::string ConvertToAscii(const std::string& source); |
|
187
8e673a65564d
refactoring of storing new instances
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
177
diff
changeset
|
151 |
|
247
c9b3ba0fd140
path management in zip files
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
187
diff
changeset
|
152 std::string StripSpaces(const std::string& source); |
|
c9b3ba0fd140
path management in zip files
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
187
diff
changeset
|
153 |
| 1397 | 154 #if BOOST_HAS_DATE_TIME == 1 |
|
187
8e673a65564d
refactoring of storing new instances
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
177
diff
changeset
|
155 std::string GetNowIsoString(); |
|
1555
d6a93e12b1c1
Creation of DICOM files with encapsulated PDF
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1490
diff
changeset
|
156 |
|
d6a93e12b1c1
Creation of DICOM files with encapsulated PDF
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1490
diff
changeset
|
157 void GetNowDicom(std::string& date, |
|
d6a93e12b1c1
Creation of DICOM files with encapsulated PDF
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1490
diff
changeset
|
158 std::string& time); |
| 1397 | 159 #endif |
| 336 | 160 |
| 161 // In-place percent-decoding for URL | |
| 162 void UrlDecode(std::string& s); | |
| 453 | 163 |
| 164 Endianness DetectEndianness(); | |
| 608 | 165 |
| 1397 | 166 #if BOOST_HAS_REGEX == 1 |
| 608 | 167 std::string WildcardToRegularExpression(const std::string& s); |
| 1397 | 168 #endif |
| 608 | 169 |
| 170 void TokenizeString(std::vector<std::string>& result, | |
| 171 const std::string& source, | |
| 172 char separator); | |
|
800
ecedd89055db
generation of DICOM images from PNG files
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
707
diff
changeset
|
173 |
| 1397 | 174 void MakeDirectory(const std::string& path); |
|
885
0570a8c859cb
SharedLibrary class
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
809
diff
changeset
|
175 |
|
0570a8c859cb
SharedLibrary class
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
809
diff
changeset
|
176 bool IsExistingFile(const std::string& path); |
|
1045
0bfeeb6d340f
json to xml conversion with pugixml
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
971
diff
changeset
|
177 |
|
0bfeeb6d340f
json to xml conversion with pugixml
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
971
diff
changeset
|
178 #if ORTHANC_PUGIXML_ENABLED == 1 |
|
0bfeeb6d340f
json to xml conversion with pugixml
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
971
diff
changeset
|
179 void JsonToXml(std::string& target, |
|
0bfeeb6d340f
json to xml conversion with pugixml
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
971
diff
changeset
|
180 const Json::Value& source, |
|
0bfeeb6d340f
json to xml conversion with pugixml
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
971
diff
changeset
|
181 const std::string& rootElement = "root", |
|
0bfeeb6d340f
json to xml conversion with pugixml
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
971
diff
changeset
|
182 const std::string& arrayElement = "item"); |
|
0bfeeb6d340f
json to xml conversion with pugixml
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
971
diff
changeset
|
183 #endif |
|
1050
64f1842aae2e
Toolbox::ExecuteSystemCommand
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1045
diff
changeset
|
184 |
|
64f1842aae2e
Toolbox::ExecuteSystemCommand
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1045
diff
changeset
|
185 void ExecuteSystemCommand(const std::string& command, |
|
64f1842aae2e
Toolbox::ExecuteSystemCommand
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1045
diff
changeset
|
186 const std::vector<std::string>& arguments); |
|
1102
ce6386b37afd
avoid unnecessary exceptions on Orthanc startup
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1101
diff
changeset
|
187 |
|
ce6386b37afd
avoid unnecessary exceptions on Orthanc startup
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1101
diff
changeset
|
188 bool IsInteger(const std::string& str); |
|
1424
fe384a9d3b51
OrthancPluginGetConfiguration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1397
diff
changeset
|
189 |
|
fe384a9d3b51
OrthancPluginGetConfiguration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1397
diff
changeset
|
190 void CopyJsonWithoutComments(Json::Value& target, |
|
fe384a9d3b51
OrthancPluginGetConfiguration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1397
diff
changeset
|
191 const Json::Value& source); |
|
1430
ad94a3583b07
Plugins can send answers as multipart messages
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1425
diff
changeset
|
192 |
|
ad94a3583b07
Plugins can send answers as multipart messages
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1425
diff
changeset
|
193 bool StartsWith(const std::string& str, |
|
ad94a3583b07
Plugins can send answers as multipart messages
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1425
diff
changeset
|
194 const std::string& prefix); |
|
1490
596927722403
support of --logdir by the internal logger
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1479
diff
changeset
|
195 |
|
596927722403
support of --logdir by the internal logger
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1479
diff
changeset
|
196 int GetProcessId(); |
| 1911 | 197 |
| 198 bool IsRegularFile(const std::string& path); | |
| 2017 | 199 |
| 200 FILE* OpenFile(const std::string& path, | |
| 201 FileMode mode); | |
| 0 | 202 } |
| 203 } |