Mercurial > hg > orthanc-stone
annotate Resources/Orthanc/Core/SystemToolbox.cpp @ 39:9ee7e2f5f1a3
sync
author | Sebastien Jodogne <s.jodogne@gmail.com> |
---|---|
date | Wed, 21 Dec 2016 14:19:38 +0100 |
parents | a4a1e4033403 |
children | 7207a407bcd8 |
rev | line source |
---|---|
15 | 1 /** |
2 * Orthanc - A Lightweight, RESTful DICOM Store | |
3 * Copyright (C) 2012-2016 Sebastien Jodogne, Medical Physics | |
4 * Department, University Hospital of Liege, Belgium | |
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. | |
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. | |
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 #include "PrecompiledHeaders.h" | |
34 #include "SystemToolbox.h" | |
35 | |
36 | |
37 #if BOOST_HAS_DATE_TIME == 1 | |
23 | 38 # include <boost/date_time/posix_time/posix_time.hpp> |
15 | 39 #endif |
40 | |
41 | |
42 #if defined(_WIN32) | |
23 | 43 # include <windows.h> |
44 # include <process.h> // For "_spawnvp()" and "_getpid()" | |
15 | 45 #else |
23 | 46 # include <unistd.h> // For "execvp()" |
47 # include <sys/wait.h> // For "waitpid()" | |
15 | 48 #endif |
49 | |
23 | 50 |
15 | 51 #if defined(__APPLE__) && defined(__MACH__) |
23 | 52 # include <mach-o/dyld.h> /* _NSGetExecutablePath */ |
53 # include <limits.h> /* PATH_MAX */ | |
15 | 54 #endif |
55 | |
23 | 56 |
15 | 57 #if defined(__linux__) || defined(__FreeBSD_kernel__) || defined(__FreeBSD__) |
23 | 58 # include <limits.h> /* PATH_MAX */ |
59 # include <signal.h> | |
60 # include <unistd.h> | |
15 | 61 #endif |
62 | |
63 | |
22
b01d46e5a2b3
support for sandboxed environments
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
16
diff
changeset
|
64 // Inclusions for UUID |
b01d46e5a2b3
support for sandboxed environments
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
16
diff
changeset
|
65 // http://stackoverflow.com/a/1626302 |
b01d46e5a2b3
support for sandboxed environments
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
16
diff
changeset
|
66 |
b01d46e5a2b3
support for sandboxed environments
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
16
diff
changeset
|
67 extern "C" |
b01d46e5a2b3
support for sandboxed environments
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
16
diff
changeset
|
68 { |
b01d46e5a2b3
support for sandboxed environments
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
16
diff
changeset
|
69 #ifdef WIN32 |
b01d46e5a2b3
support for sandboxed environments
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
16
diff
changeset
|
70 # include <rpc.h> |
b01d46e5a2b3
support for sandboxed environments
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
16
diff
changeset
|
71 #else |
b01d46e5a2b3
support for sandboxed environments
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
16
diff
changeset
|
72 # include <uuid/uuid.h> |
b01d46e5a2b3
support for sandboxed environments
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
16
diff
changeset
|
73 #endif |
b01d46e5a2b3
support for sandboxed environments
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
16
diff
changeset
|
74 } |
b01d46e5a2b3
support for sandboxed environments
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
16
diff
changeset
|
75 |
b01d46e5a2b3
support for sandboxed environments
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
16
diff
changeset
|
76 |
15 | 77 #include "Logging.h" |
78 #include "OrthancException.h" | |
79 #include "Toolbox.h" | |
80 | |
81 #include <boost/filesystem.hpp> | |
82 #include <boost/filesystem/fstream.hpp> | |
83 | |
84 | |
85 namespace Orthanc | |
86 { | |
87 static bool finish_; | |
88 static ServerBarrierEvent barrierEvent_; | |
89 | |
90 #if defined(_WIN32) | |
91 static BOOL WINAPI ConsoleControlHandler(DWORD dwCtrlType) | |
92 { | |
93 // http://msdn.microsoft.com/en-us/library/ms683242(v=vs.85).aspx | |
94 finish_ = true; | |
95 return true; | |
96 } | |
97 #else | |
98 static void SignalHandler(int signal) | |
99 { | |
100 if (signal == SIGHUP) | |
101 { | |
102 barrierEvent_ = ServerBarrierEvent_Reload; | |
103 } | |
104 | |
105 finish_ = true; | |
106 } | |
107 #endif | |
108 | |
109 | |
110 static ServerBarrierEvent ServerBarrierInternal(const bool* stopFlag) | |
111 { | |
112 #if defined(_WIN32) | |
113 SetConsoleCtrlHandler(ConsoleControlHandler, true); | |
114 #else | |
115 signal(SIGINT, SignalHandler); | |
116 signal(SIGQUIT, SignalHandler); | |
117 signal(SIGTERM, SignalHandler); | |
118 signal(SIGHUP, SignalHandler); | |
119 #endif | |
120 | |
121 // Active loop that awakens every 100ms | |
122 finish_ = false; | |
123 barrierEvent_ = ServerBarrierEvent_Stop; | |
124 while (!(*stopFlag || finish_)) | |
125 { | |
39 | 126 SystemToolbox::USleep(100 * 1000); |
15 | 127 } |
128 | |
129 #if defined(_WIN32) | |
130 SetConsoleCtrlHandler(ConsoleControlHandler, false); | |
131 #else | |
132 signal(SIGINT, NULL); | |
133 signal(SIGQUIT, NULL); | |
134 signal(SIGTERM, NULL); | |
135 signal(SIGHUP, NULL); | |
136 #endif | |
137 | |
138 return barrierEvent_; | |
139 } | |
140 | |
141 | |
142 ServerBarrierEvent SystemToolbox::ServerBarrier(const bool& stopFlag) | |
143 { | |
144 return ServerBarrierInternal(&stopFlag); | |
145 } | |
146 | |
147 | |
148 ServerBarrierEvent SystemToolbox::ServerBarrier() | |
149 { | |
150 const bool stopFlag = false; | |
151 return ServerBarrierInternal(&stopFlag); | |
152 } | |
153 | |
154 | |
39 | 155 void SystemToolbox::USleep(uint64_t microSeconds) |
156 { | |
157 #if defined(_WIN32) | |
158 ::Sleep(static_cast<DWORD>(microSeconds / static_cast<uint64_t>(1000))); | |
159 #elif defined(__linux__) || defined(__APPLE__) || defined(__FreeBSD_kernel__) || defined(__FreeBSD__) || defined(__native_client__) | |
160 usleep(microSeconds); | |
161 #else | |
162 #error Support your platform here | |
163 #endif | |
164 } | |
165 | |
166 | |
15 | 167 static std::streamsize GetStreamSize(std::istream& f) |
168 { | |
169 // http://www.cplusplus.com/reference/iostream/istream/tellg/ | |
170 f.seekg(0, std::ios::end); | |
171 std::streamsize size = f.tellg(); | |
172 f.seekg(0, std::ios::beg); | |
173 | |
174 return size; | |
175 } | |
176 | |
177 | |
178 void SystemToolbox::ReadFile(std::string& content, | |
179 const std::string& path) | |
180 { | |
181 if (!IsRegularFile(path)) | |
182 { | |
183 LOG(ERROR) << std::string("The path does not point to a regular file: ") << path; | |
184 throw OrthancException(ErrorCode_RegularFileExpected); | |
185 } | |
186 | |
187 boost::filesystem::ifstream f; | |
188 f.open(path, std::ifstream::in | std::ifstream::binary); | |
189 if (!f.good()) | |
190 { | |
191 throw OrthancException(ErrorCode_InexistentFile); | |
192 } | |
193 | |
194 std::streamsize size = GetStreamSize(f); | |
195 content.resize(size); | |
196 if (size != 0) | |
197 { | |
198 f.read(reinterpret_cast<char*>(&content[0]), size); | |
199 } | |
200 | |
201 f.close(); | |
202 } | |
203 | |
204 | |
205 bool SystemToolbox::ReadHeader(std::string& header, | |
206 const std::string& path, | |
207 size_t headerSize) | |
208 { | |
209 if (!IsRegularFile(path)) | |
210 { | |
211 LOG(ERROR) << std::string("The path does not point to a regular file: ") << path; | |
212 throw OrthancException(ErrorCode_RegularFileExpected); | |
213 } | |
214 | |
215 boost::filesystem::ifstream f; | |
216 f.open(path, std::ifstream::in | std::ifstream::binary); | |
217 if (!f.good()) | |
218 { | |
219 throw OrthancException(ErrorCode_InexistentFile); | |
220 } | |
221 | |
222 bool full = true; | |
223 | |
224 { | |
225 std::streamsize size = GetStreamSize(f); | |
226 if (size <= 0) | |
227 { | |
228 headerSize = 0; | |
229 full = false; | |
230 } | |
231 else if (static_cast<size_t>(size) < headerSize) | |
232 { | |
233 headerSize = size; // Truncate to the size of the file | |
234 full = false; | |
235 } | |
236 } | |
237 | |
238 header.resize(headerSize); | |
239 if (headerSize != 0) | |
240 { | |
241 f.read(reinterpret_cast<char*>(&header[0]), headerSize); | |
242 } | |
243 | |
244 f.close(); | |
245 | |
246 return full; | |
247 } | |
248 | |
249 | |
250 void SystemToolbox::WriteFile(const void* content, | |
251 size_t size, | |
252 const std::string& path) | |
253 { | |
254 boost::filesystem::ofstream f; | |
255 f.open(path, std::ofstream::out | std::ofstream::binary); | |
256 if (!f.good()) | |
257 { | |
258 throw OrthancException(ErrorCode_CannotWriteFile); | |
259 } | |
260 | |
261 if (size != 0) | |
262 { | |
263 f.write(reinterpret_cast<const char*>(content), size); | |
264 | |
265 if (!f.good()) | |
266 { | |
267 f.close(); | |
268 throw OrthancException(ErrorCode_FileStorageCannotWrite); | |
269 } | |
270 } | |
271 | |
272 f.close(); | |
273 } | |
274 | |
275 | |
276 void SystemToolbox::WriteFile(const std::string& content, | |
277 const std::string& path) | |
278 { | |
279 WriteFile(content.size() > 0 ? content.c_str() : NULL, | |
280 content.size(), path); | |
281 } | |
282 | |
283 | |
284 void SystemToolbox::RemoveFile(const std::string& path) | |
285 { | |
286 if (boost::filesystem::exists(path)) | |
287 { | |
288 if (IsRegularFile(path)) | |
289 { | |
290 boost::filesystem::remove(path); | |
291 } | |
292 else | |
293 { | |
294 throw OrthancException(ErrorCode_RegularFileExpected); | |
295 } | |
296 } | |
297 } | |
298 | |
299 | |
300 uint64_t SystemToolbox::GetFileSize(const std::string& path) | |
301 { | |
302 try | |
303 { | |
304 return static_cast<uint64_t>(boost::filesystem::file_size(path)); | |
305 } | |
306 catch (boost::filesystem::filesystem_error&) | |
307 { | |
308 throw OrthancException(ErrorCode_InexistentFile); | |
309 } | |
310 } | |
311 | |
312 | |
313 void SystemToolbox::MakeDirectory(const std::string& path) | |
314 { | |
315 if (boost::filesystem::exists(path)) | |
316 { | |
317 if (!boost::filesystem::is_directory(path)) | |
318 { | |
319 throw OrthancException(ErrorCode_DirectoryOverFile); | |
320 } | |
321 } | |
322 else | |
323 { | |
324 if (!boost::filesystem::create_directories(path)) | |
325 { | |
326 throw OrthancException(ErrorCode_MakeDirectory); | |
327 } | |
328 } | |
329 } | |
330 | |
331 | |
332 bool SystemToolbox::IsExistingFile(const std::string& path) | |
333 { | |
334 return boost::filesystem::exists(path); | |
335 } | |
336 | |
337 | |
338 #if defined(_WIN32) | |
339 static std::string GetPathToExecutableInternal() | |
340 { | |
341 // Yes, this is ugly, but there is no simple way to get the | |
342 // required buffer size, so we use a big constant | |
343 std::vector<char> buffer(32768); | |
344 /*int bytes =*/ GetModuleFileNameA(NULL, &buffer[0], static_cast<DWORD>(buffer.size() - 1)); | |
345 return std::string(&buffer[0]); | |
346 } | |
347 | |
348 #elif defined(__linux__) || defined(__FreeBSD_kernel__) || defined(__FreeBSD__) | |
349 static std::string GetPathToExecutableInternal() | |
350 { | |
351 std::vector<char> buffer(PATH_MAX + 1); | |
352 ssize_t bytes = readlink("/proc/self/exe", &buffer[0], buffer.size() - 1); | |
353 if (bytes == 0) | |
354 { | |
355 throw OrthancException(ErrorCode_PathToExecutable); | |
356 } | |
357 | |
358 return std::string(&buffer[0]); | |
359 } | |
360 | |
361 #elif defined(__APPLE__) && defined(__MACH__) | |
362 static std::string GetPathToExecutableInternal() | |
363 { | |
364 char pathbuf[PATH_MAX + 1]; | |
365 unsigned int bufsize = static_cast<int>(sizeof(pathbuf)); | |
366 | |
367 _NSGetExecutablePath( pathbuf, &bufsize); | |
368 | |
369 return std::string(pathbuf); | |
370 } | |
371 | |
372 #else | |
373 #error Support your platform here | |
374 #endif | |
375 | |
376 | |
377 std::string SystemToolbox::GetPathToExecutable() | |
378 { | |
379 boost::filesystem::path p(GetPathToExecutableInternal()); | |
380 return boost::filesystem::absolute(p).string(); | |
381 } | |
382 | |
383 | |
384 std::string SystemToolbox::GetDirectoryOfExecutable() | |
385 { | |
386 boost::filesystem::path p(GetPathToExecutableInternal()); | |
387 return boost::filesystem::absolute(p.parent_path()).string(); | |
388 } | |
389 | |
390 | |
391 void SystemToolbox::ExecuteSystemCommand(const std::string& command, | |
392 const std::vector<std::string>& arguments) | |
393 { | |
394 // Convert the arguments as a C array | |
395 std::vector<char*> args(arguments.size() + 2); | |
396 | |
397 args.front() = const_cast<char*>(command.c_str()); | |
398 | |
399 for (size_t i = 0; i < arguments.size(); i++) | |
400 { | |
401 args[i + 1] = const_cast<char*>(arguments[i].c_str()); | |
402 } | |
403 | |
404 args.back() = NULL; | |
405 | |
406 int status; | |
407 | |
408 #if defined(_WIN32) | |
409 // http://msdn.microsoft.com/en-us/library/275khfab.aspx | |
410 status = static_cast<int>(_spawnvp(_P_OVERLAY, command.c_str(), &args[0])); | |
411 | |
412 #else | |
413 int pid = fork(); | |
414 | |
415 if (pid == -1) | |
416 { | |
417 // Error in fork() | |
418 #if ORTHANC_ENABLE_LOGGING == 1 | |
419 LOG(ERROR) << "Cannot fork a child process"; | |
420 #endif | |
421 | |
422 throw OrthancException(ErrorCode_SystemCommand); | |
423 } | |
424 else if (pid == 0) | |
425 { | |
426 // Execute the system command in the child process | |
427 execvp(command.c_str(), &args[0]); | |
428 | |
429 // We should never get here | |
430 _exit(1); | |
431 } | |
432 else | |
433 { | |
434 // Wait for the system command to exit | |
435 waitpid(pid, &status, 0); | |
436 } | |
437 #endif | |
438 | |
439 if (status != 0) | |
440 { | |
441 #if ORTHANC_ENABLE_LOGGING == 1 | |
442 LOG(ERROR) << "System command failed with status code " << status; | |
443 #endif | |
444 | |
445 throw OrthancException(ErrorCode_SystemCommand); | |
446 } | |
447 } | |
448 | |
449 | |
450 int SystemToolbox::GetProcessId() | |
451 { | |
452 #if defined(_WIN32) | |
453 return static_cast<int>(_getpid()); | |
454 #else | |
455 return static_cast<int>(getpid()); | |
456 #endif | |
457 } | |
458 | |
459 | |
460 bool SystemToolbox::IsRegularFile(const std::string& path) | |
461 { | |
462 namespace fs = boost::filesystem; | |
463 | |
464 try | |
465 { | |
466 if (fs::exists(path)) | |
467 { | |
468 fs::file_status status = fs::status(path); | |
469 return (status.type() == boost::filesystem::regular_file || | |
470 status.type() == boost::filesystem::reparse_file); // Fix BitBucket issue #11 | |
471 } | |
472 } | |
473 catch (fs::filesystem_error&) | |
474 { | |
475 } | |
476 | |
477 return false; | |
478 } | |
479 | |
480 | |
481 FILE* SystemToolbox::OpenFile(const std::string& path, | |
482 FileMode mode) | |
483 { | |
484 #if defined(_WIN32) | |
485 // TODO Deal with special characters by converting to the current locale | |
486 #endif | |
487 | |
488 const char* m; | |
489 switch (mode) | |
490 { | |
491 case FileMode_ReadBinary: | |
492 m = "rb"; | |
493 break; | |
494 | |
495 case FileMode_WriteBinary: | |
496 m = "wb"; | |
497 break; | |
498 | |
499 default: | |
500 throw OrthancException(ErrorCode_ParameterOutOfRange); | |
501 } | |
502 | |
503 return fopen(path.c_str(), m); | |
504 } | |
505 | |
506 | |
22
b01d46e5a2b3
support for sandboxed environments
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
16
diff
changeset
|
507 std::string SystemToolbox::GenerateUuid() |
b01d46e5a2b3
support for sandboxed environments
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
16
diff
changeset
|
508 { |
b01d46e5a2b3
support for sandboxed environments
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
16
diff
changeset
|
509 #ifdef WIN32 |
b01d46e5a2b3
support for sandboxed environments
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
16
diff
changeset
|
510 UUID uuid; |
b01d46e5a2b3
support for sandboxed environments
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
16
diff
changeset
|
511 UuidCreate ( &uuid ); |
b01d46e5a2b3
support for sandboxed environments
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
16
diff
changeset
|
512 |
b01d46e5a2b3
support for sandboxed environments
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
16
diff
changeset
|
513 unsigned char * str; |
b01d46e5a2b3
support for sandboxed environments
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
16
diff
changeset
|
514 UuidToStringA ( &uuid, &str ); |
b01d46e5a2b3
support for sandboxed environments
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
16
diff
changeset
|
515 |
b01d46e5a2b3
support for sandboxed environments
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
16
diff
changeset
|
516 std::string s( ( char* ) str ); |
b01d46e5a2b3
support for sandboxed environments
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
16
diff
changeset
|
517 |
b01d46e5a2b3
support for sandboxed environments
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
16
diff
changeset
|
518 RpcStringFreeA ( &str ); |
b01d46e5a2b3
support for sandboxed environments
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
16
diff
changeset
|
519 #else |
b01d46e5a2b3
support for sandboxed environments
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
16
diff
changeset
|
520 uuid_t uuid; |
b01d46e5a2b3
support for sandboxed environments
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
16
diff
changeset
|
521 uuid_generate_random ( uuid ); |
b01d46e5a2b3
support for sandboxed environments
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
16
diff
changeset
|
522 char s[37]; |
b01d46e5a2b3
support for sandboxed environments
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
16
diff
changeset
|
523 uuid_unparse ( uuid, s ); |
b01d46e5a2b3
support for sandboxed environments
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
16
diff
changeset
|
524 #endif |
b01d46e5a2b3
support for sandboxed environments
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
16
diff
changeset
|
525 return s; |
b01d46e5a2b3
support for sandboxed environments
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
16
diff
changeset
|
526 } |
b01d46e5a2b3
support for sandboxed environments
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
16
diff
changeset
|
527 |
b01d46e5a2b3
support for sandboxed environments
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
16
diff
changeset
|
528 |
15 | 529 #if BOOST_HAS_DATE_TIME == 1 |
530 std::string SystemToolbox::GetNowIsoString() | |
531 { | |
532 boost::posix_time::ptime now = boost::posix_time::second_clock::local_time(); | |
533 return boost::posix_time::to_iso_string(now); | |
534 } | |
535 | |
536 void SystemToolbox::GetNowDicom(std::string& date, | |
537 std::string& time) | |
538 { | |
539 boost::posix_time::ptime now = boost::posix_time::second_clock::local_time(); | |
540 tm tm = boost::posix_time::to_tm(now); | |
541 | |
542 char s[32]; | |
543 sprintf(s, "%04d%02d%02d", tm.tm_year + 1900, tm.tm_mon + 1, tm.tm_mday); | |
544 date.assign(s); | |
545 | |
546 // TODO milliseconds | |
547 sprintf(s, "%02d%02d%02d.%06d", tm.tm_hour, tm.tm_min, tm.tm_sec, 0); | |
548 time.assign(s); | |
549 } | |
550 #endif | |
551 } |