Mercurial > hg > orthanc

annotate Core/Toolbox.h @ 1082:601c5f4631d1 Orthanc-0.8.1

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
fix
author Sebastien Jodogne <s.jodogne@gmail.com>
date Tue, 29 Jul 2014 12:44:42 +0200
parents 64f1842aae2e
children e5686a703c63
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
3959d33612cc initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1 /**
59
c996319e90bc renaming in Core
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 50
diff changeset
2 * Orthanc - A Lightweight, RESTful DICOM Store
689
2d0a347e8cfc switch to 2014
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 608
diff changeset
3 * Copyright (C) 2012-2014 Medical Physics Department, CHU of Liege,
0
3959d33612cc initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4 * Belgium
3959d33612cc initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5 *
3959d33612cc initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6 * This program is free software: you can redistribute it and/or
3959d33612cc initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7 * modify it under the terms of the GNU General Public License as
3959d33612cc initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8 * published by the Free Software Foundation, either version 3 of the
3959d33612cc initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9 * License, or (at your option) any later version.
136
fe180eae201d openssl exception
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 107
diff changeset
10 *
fe180eae201d openssl exception
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 107
diff changeset
11 * In addition, as a special exception, the copyright holders of this
fe180eae201d openssl exception
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 107
diff changeset
12 * program give permission to link the code of its release with the
fe180eae201d openssl exception
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 107
diff changeset
13 * OpenSSL project's "OpenSSL" library (or with modified versions of it
fe180eae201d openssl exception
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 107
diff changeset
14 * that use the same license as the "OpenSSL" library), and distribute
fe180eae201d openssl exception
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 107
diff changeset
15 * the linked executables. You must obey the GNU General Public License
fe180eae201d openssl exception
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 107
diff changeset
16 * in all respects for all of the code used other than "OpenSSL". If you
fe180eae201d openssl exception
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 107
diff changeset
17 * modify file(s) with this exception, you may extend this exception to
fe180eae201d openssl exception
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 107
diff changeset
18 * your version of the file(s), but you are not obligated to do so. If
fe180eae201d openssl exception
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 107
diff changeset
19 * you do not wish to do so, delete this exception statement from your
fe180eae201d openssl exception
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 107
diff changeset
20 * version. If you delete this exception statement from all source files
fe180eae201d openssl exception
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 107
diff changeset
21 * in the program, then also delete it here.
0
3959d33612cc initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
22 *
3959d33612cc initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
23 * This program is distributed in the hope that it will be useful, but
3959d33612cc initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
24 * WITHOUT ANY WARRANTY; without even the implied warranty of
3959d33612cc initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
25 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
3959d33612cc initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
26 * General Public License for more details.
3959d33612cc initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
27 *
3959d33612cc initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
28 * You should have received a copy of the GNU General Public License
3959d33612cc initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
29 * along with this program. If not, see <http://www.gnu.org/licenses/>.
3959d33612cc initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
30 **/
3959d33612cc initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
31
3959d33612cc initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
32
3959d33612cc initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
33 #pragma once
3959d33612cc initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
34
453
30086c1aca30 endianness
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 402
diff changeset
35 #include "Enumerations.h"
30086c1aca30 endianness
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 402
diff changeset
36
0
3959d33612cc initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
37 #include <stdint.h>
3959d33612cc initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
38 #include <vector>
3959d33612cc initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
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
3959d33612cc initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
41
59
c996319e90bc renaming in Core
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 50
diff changeset
42 namespace Orthanc
0
3959d33612cc initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
43 {
3959d33612cc initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
44 typedef std::vector<std::string> UriComponents;
3959d33612cc initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
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
3959d33612cc initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
50 namespace Toolbox
3959d33612cc initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
51 {
3959d33612cc initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
52 void ServerBarrier();
3959d33612cc initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
53
690
2e67366aab83 case-insensitive matching of Application Entity Titles
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 689
diff changeset
54 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
55
2e67366aab83 case-insensitive matching of Application Entity Titles
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 689
diff changeset
56 void ToLowerCase(std::string& s); // Inplace version
0
3959d33612cc initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
57
690
2e67366aab83 case-insensitive matching of Application Entity Titles
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 689
diff changeset
58 void ToUpperCase(std::string& result,
2e67366aab83 case-insensitive matching of Application Entity Titles
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 689
diff changeset
59 const std::string& source);
2e67366aab83 case-insensitive matching of Application Entity Titles
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 689
diff changeset
60
2e67366aab83 case-insensitive matching of Application Entity Titles
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 689
diff changeset
61 void ToLowerCase(std::string& result,
2e67366aab83 case-insensitive matching of Application Entity Titles
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 689
diff changeset
62 const std::string& source);
0
3959d33612cc initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
63
3959d33612cc initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
64 void ReadFile(std::string& content,
3959d33612cc initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
65 const std::string& path);
3959d33612cc initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
66
483
8c3573d28868 export dicom instances to the filesystem
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 477
diff changeset
67 void WriteFile(const std::string& content,
8c3573d28868 export dicom instances to the filesystem
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 477
diff changeset
68 const std::string& path);
8c3573d28868 export dicom instances to the filesystem
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 477
diff changeset
69
0
3959d33612cc initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
70 void USleep(uint64_t microSeconds);
3959d33612cc initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
71
3959d33612cc initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
72 void RemoveFile(const std::string& path);
3959d33612cc initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
73
3959d33612cc initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
74 void SplitUriComponents(UriComponents& components,
3959d33612cc initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
75 const std::string& uri);
3959d33612cc initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
76
966
886652370ff2 accelerating REST API matching
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 949
diff changeset
77 void TruncateUri(UriComponents& target,
886652370ff2 accelerating REST API matching
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 949
diff changeset
78 const UriComponents& source,
886652370ff2 accelerating REST API matching
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 949
diff changeset
79 size_t fromLevel);
886652370ff2 accelerating REST API matching
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 949
diff changeset
80
0
3959d33612cc initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
81 bool IsChildUri(const UriComponents& baseUri,
3959d33612cc initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
82 const UriComponents& testedUri);
3959d33612cc initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
83
3959d33612cc initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
84 std::string AutodetectMimeType(const std::string& path);
3959d33612cc initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
85
3959d33612cc initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
86 std::string FlattenUri(const UriComponents& components,
3959d33612cc initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
87 size_t fromLevel = 0);
3959d33612cc initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
88
3959d33612cc initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
89 uint64_t GetFileSize(const std::string& path);
22
1bc6327d1de3 MD5 sum
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 0
diff changeset
90
1bc6327d1de3 MD5 sum
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 0
diff changeset
91 void ComputeMD5(std::string& result,
1bc6327d1de3 MD5 sum
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 0
diff changeset
92 const std::string& data);
24
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 22
diff changeset
93
693
01d8611c4a60 md5 for attached files
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 690
diff changeset
94 void ComputeMD5(std::string& result,
01d8611c4a60 md5 for attached files
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 690
diff changeset
95 const void* data,
01d8611c4a60 md5 for attached files
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 690
diff changeset
96 size_t length);
01d8611c4a60 md5 for attached files
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 690
diff changeset
97
177
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 136
diff changeset
98 void ComputeSHA1(std::string& result,
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 136
diff changeset
99 const std::string& data);
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 136
diff changeset
100
402
d2c69150a979 bulk storescu
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 398
diff changeset
101 bool IsSHA1(const std::string& str);
d2c69150a979 bulk storescu
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 398
diff changeset
102
809
8ce2f69436ca do not return strings with base64
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 803
diff changeset
103 void DecodeBase64(std::string& result,
8ce2f69436ca do not return strings with base64
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 803
diff changeset
104 const std::string& data);
365
cda6938a8c6f decode base64
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 336
diff changeset
105
809
8ce2f69436ca do not return strings with base64
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 803
diff changeset
106 void EncodeBase64(std::string& result,
8ce2f69436ca do not return strings with base64
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 803
diff changeset
107 const std::string& data);
87
8517e2c44283 path to configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 59
diff changeset
108
8517e2c44283 path to configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 59
diff changeset
109 std::string GetPathToExecutable();
8517e2c44283 path to configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 59
diff changeset
110
8517e2c44283 path to configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 59
diff changeset
111 std::string GetDirectoryOfExecutable();
107
3b45473c0a73 replace boost::locale with iconv for debian
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 87
diff changeset
112
3b45473c0a73 replace boost::locale with iconv for debian
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 87
diff changeset
113 std::string ConvertToUtf8(const std::string& source,
949
766a57997121 enumeration for encodings
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 809
diff changeset
114 const Encoding sourceEncoding);
107
3b45473c0a73 replace boost::locale with iconv for debian
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 87
diff changeset
115
3b45473c0a73 replace boost::locale with iconv for debian
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 87
diff changeset
116 std::string ConvertToAscii(const std::string& source);
187
8e673a65564d refactoring of storing new instances
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 177
diff changeset
117
247
c9b3ba0fd140 path management in zip files
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 187
diff changeset
118 std::string StripSpaces(const std::string& source);
c9b3ba0fd140 path management in zip files
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 187
diff changeset
119
187
8e673a65564d refactoring of storing new instances
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 177
diff changeset
120 std::string GetNowIsoString();
336
3c291753231f url decode
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 284
diff changeset
121
3c291753231f url decode
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 284
diff changeset
122 // In-place percent-decoding for URL
3c291753231f url decode
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 284
diff changeset
123 void UrlDecode(std::string& s);
453
30086c1aca30 endianness
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 402
diff changeset
124
30086c1aca30 endianness
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 402
diff changeset
125 Endianness DetectEndianness();
608
0bedf8ff9288 basic find scp
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 483
diff changeset
126
0bedf8ff9288 basic find scp
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 483
diff changeset
127 std::string WildcardToRegularExpression(const std::string& s);
0bedf8ff9288 basic find scp
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 483
diff changeset
128
0bedf8ff9288 basic find scp
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 483
diff changeset
129 void TokenizeString(std::vector<std::string>& result,
0bedf8ff9288 basic find scp
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 483
diff changeset
130 const std::string& source,
0bedf8ff9288 basic find scp
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 483
diff changeset
131 char separator);
800
ecedd89055db generation of DICOM images from PNG files
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 707
diff changeset
132
ecedd89055db generation of DICOM images from PNG files
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 707
diff changeset
133 void DecodeDataUriScheme(std::string& mime,
ecedd89055db generation of DICOM images from PNG files
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 707
diff changeset
134 std::string& content,
ecedd89055db generation of DICOM images from PNG files
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 707
diff changeset
135 const std::string& source);
803
4689e400e0fa directory to store the results of the unit tests
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 800
diff changeset
136
4689e400e0fa directory to store the results of the unit tests
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 800
diff changeset
137 void CreateDirectory(const std::string& path);
885
0570a8c859cb SharedLibrary class
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 809
diff changeset
138
0570a8c859cb SharedLibrary class
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 809
diff changeset
139 bool IsExistingFile(const std::string& path);
1045
0bfeeb6d340f json to xml conversion with pugixml
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 971
diff changeset
140
0bfeeb6d340f json to xml conversion with pugixml
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 971
diff changeset
141 #if ORTHANC_PUGIXML_ENABLED == 1
0bfeeb6d340f json to xml conversion with pugixml
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 971
diff changeset
142 void JsonToXml(std::string& target,
0bfeeb6d340f json to xml conversion with pugixml
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 971
diff changeset
143 const Json::Value& source,
0bfeeb6d340f json to xml conversion with pugixml
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 971
diff changeset
144 const std::string& rootElement = "root",
0bfeeb6d340f json to xml conversion with pugixml
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 971
diff changeset
145 const std::string& arrayElement = "item");
0bfeeb6d340f json to xml conversion with pugixml
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 971
diff changeset
146 #endif
1050
64f1842aae2e Toolbox::ExecuteSystemCommand
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1045
diff changeset
147
64f1842aae2e Toolbox::ExecuteSystemCommand
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1045
diff changeset
148 void ExecuteSystemCommand(const std::string& command,
64f1842aae2e Toolbox::ExecuteSystemCommand
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1045
diff changeset
149 const std::vector<std::string>& arguments);
0
3959d33612cc initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
150 }
3959d33612cc initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
151 }