44
|
1 /**
|
|
2 * Orthanc - A Lightweight, RESTful DICOM Store
|
|
3 * Copyright (C) 2012-2016 Sebastien Jodogne, Medical Physics
|
|
4 * Department, University Hospital of Liege, Belgium
|
116
|
5 * Copyright (C) 2017-2018 Osimis S.A., Belgium
|
44
|
6 *
|
|
7 * This program is free software: you can redistribute it and/or
|
|
8 * modify it under the terms of the GNU General Public License as
|
|
9 * published by the Free Software Foundation, either version 3 of the
|
|
10 * License, or (at your option) any later version.
|
|
11 *
|
|
12 * In addition, as a special exception, the copyright holders of this
|
|
13 * program give permission to link the code of its release with the
|
|
14 * OpenSSL project's "OpenSSL" library (or with modified versions of it
|
|
15 * that use the same license as the "OpenSSL" library), and distribute
|
|
16 * the linked executables. You must obey the GNU General Public License
|
|
17 * in all respects for all of the code used other than "OpenSSL". If you
|
|
18 * modify file(s) with this exception, you may extend this exception to
|
|
19 * your version of the file(s), but you are not obligated to do so. If
|
|
20 * you do not wish to do so, delete this exception statement from your
|
|
21 * version. If you delete this exception statement from all source files
|
|
22 * in the program, then also delete it here.
|
|
23 *
|
|
24 * This program is distributed in the hope that it will be useful, but
|
|
25 * WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
26 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
|
|
27 * General Public License for more details.
|
|
28 *
|
|
29 * You should have received a copy of the GNU General Public License
|
|
30 * along with this program. If not, see <http://www.gnu.org/licenses/>.
|
|
31 **/
|
|
32
|
|
33
|
|
34 #include "PrecompiledHeaders.h"
|
|
35 #include "SystemToolbox.h"
|
|
36
|
|
37
|
|
38 #if defined(_WIN32)
|
54
|
39 # include <windows.h>
|
|
40 # include <process.h> // For "_spawnvp()" and "_getpid()"
|
44
|
41 #else
|
54
|
42 # include <unistd.h> // For "execvp()"
|
|
43 # include <sys/wait.h> // For "waitpid()"
|
44
|
44 #endif
|
|
45
|
54
|
46
|
44
|
47 #if defined(__APPLE__) && defined(__MACH__)
|
54
|
48 # include <mach-o/dyld.h> /* _NSGetExecutablePath */
|
|
49 # include <limits.h> /* PATH_MAX */
|
44
|
50 #endif
|
|
51
|
54
|
52
|
44
|
53 #if defined(__linux__) || defined(__FreeBSD_kernel__) || defined(__FreeBSD__)
|
54
|
54 # include <limits.h> /* PATH_MAX */
|
|
55 # include <signal.h>
|
|
56 # include <unistd.h>
|
44
|
57 #endif
|
|
58
|
|
59
|
107
|
60 #if defined(__OpenBSD__)
|
|
61 # include <sys/sysctl.h> // For "sysctl", "CTL_KERN" and "KERN_PROC_ARGS"
|
|
62 #endif
|
|
63
|
|
64
|
54
|
65 // Inclusions for UUID
|
|
66 // http://stackoverflow.com/a/1626302
|
|
67
|
|
68 extern "C"
|
|
69 {
|
107
|
70 #if defined(_WIN32)
|
54
|
71 # include <rpc.h>
|
|
72 #else
|
|
73 # include <uuid/uuid.h>
|
|
74 #endif
|
|
75 }
|
|
76
|
|
77
|
44
|
78 #include "Logging.h"
|
|
79 #include "OrthancException.h"
|
|
80 #include "Toolbox.h"
|
|
81
|
|
82 #include <boost/filesystem.hpp>
|
|
83 #include <boost/filesystem/fstream.hpp>
|
107
|
84 #include <boost/date_time/posix_time/posix_time.hpp>
|
44
|
85
|
|
86
|
|
87 namespace Orthanc
|
|
88 {
|
|
89 static bool finish_;
|
|
90 static ServerBarrierEvent barrierEvent_;
|
|
91
|
|
92 #if defined(_WIN32)
|
|
93 static BOOL WINAPI ConsoleControlHandler(DWORD dwCtrlType)
|
|
94 {
|
|
95 // http://msdn.microsoft.com/en-us/library/ms683242(v=vs.85).aspx
|
|
96 finish_ = true;
|
|
97 return true;
|
|
98 }
|
|
99 #else
|
|
100 static void SignalHandler(int signal)
|
|
101 {
|
|
102 if (signal == SIGHUP)
|
|
103 {
|
|
104 barrierEvent_ = ServerBarrierEvent_Reload;
|
|
105 }
|
|
106
|
|
107 finish_ = true;
|
|
108 }
|
|
109 #endif
|
|
110
|
|
111
|
|
112 static ServerBarrierEvent ServerBarrierInternal(const bool* stopFlag)
|
|
113 {
|
|
114 #if defined(_WIN32)
|
|
115 SetConsoleCtrlHandler(ConsoleControlHandler, true);
|
|
116 #else
|
|
117 signal(SIGINT, SignalHandler);
|
|
118 signal(SIGQUIT, SignalHandler);
|
|
119 signal(SIGTERM, SignalHandler);
|
|
120 signal(SIGHUP, SignalHandler);
|
|
121 #endif
|
|
122
|
|
123 // Active loop that awakens every 100ms
|
|
124 finish_ = false;
|
|
125 barrierEvent_ = ServerBarrierEvent_Stop;
|
|
126 while (!(*stopFlag || finish_))
|
|
127 {
|
92
|
128 SystemToolbox::USleep(100 * 1000);
|
44
|
129 }
|
|
130
|
|
131 #if defined(_WIN32)
|
|
132 SetConsoleCtrlHandler(ConsoleControlHandler, false);
|
|
133 #else
|
|
134 signal(SIGINT, NULL);
|
|
135 signal(SIGQUIT, NULL);
|
|
136 signal(SIGTERM, NULL);
|
|
137 signal(SIGHUP, NULL);
|
|
138 #endif
|
|
139
|
|
140 return barrierEvent_;
|
|
141 }
|
|
142
|
|
143
|
|
144 ServerBarrierEvent SystemToolbox::ServerBarrier(const bool& stopFlag)
|
|
145 {
|
|
146 return ServerBarrierInternal(&stopFlag);
|
|
147 }
|
|
148
|
|
149
|
|
150 ServerBarrierEvent SystemToolbox::ServerBarrier()
|
|
151 {
|
|
152 const bool stopFlag = false;
|
|
153 return ServerBarrierInternal(&stopFlag);
|
|
154 }
|
|
155
|
|
156
|
92
|
157 void SystemToolbox::USleep(uint64_t microSeconds)
|
|
158 {
|
|
159 #if defined(_WIN32)
|
|
160 ::Sleep(static_cast<DWORD>(microSeconds / static_cast<uint64_t>(1000)));
|
107
|
161 #elif defined(__linux__) || defined(__APPLE__) || defined(__FreeBSD_kernel__) || defined(__FreeBSD__) || defined(__OpenBSD__) || defined(__native_client__)
|
92
|
162 usleep(microSeconds);
|
|
163 #else
|
|
164 #error Support your platform here
|
|
165 #endif
|
|
166 }
|
|
167
|
|
168
|
44
|
169 static std::streamsize GetStreamSize(std::istream& f)
|
|
170 {
|
|
171 // http://www.cplusplus.com/reference/iostream/istream/tellg/
|
|
172 f.seekg(0, std::ios::end);
|
|
173 std::streamsize size = f.tellg();
|
|
174 f.seekg(0, std::ios::beg);
|
|
175
|
|
176 return size;
|
|
177 }
|
|
178
|
|
179
|
|
180 void SystemToolbox::ReadFile(std::string& content,
|
|
181 const std::string& path)
|
|
182 {
|
|
183 if (!IsRegularFile(path))
|
|
184 {
|
133
|
185 LOG(ERROR) << "The path does not point to a regular file: " << path;
|
44
|
186 throw OrthancException(ErrorCode_RegularFileExpected);
|
|
187 }
|
|
188
|
|
189 boost::filesystem::ifstream f;
|
|
190 f.open(path, std::ifstream::in | std::ifstream::binary);
|
|
191 if (!f.good())
|
|
192 {
|
|
193 throw OrthancException(ErrorCode_InexistentFile);
|
|
194 }
|
|
195
|
|
196 std::streamsize size = GetStreamSize(f);
|
107
|
197 content.resize(static_cast<size_t>(size));
|
44
|
198 if (size != 0)
|
|
199 {
|
|
200 f.read(reinterpret_cast<char*>(&content[0]), size);
|
|
201 }
|
|
202
|
|
203 f.close();
|
|
204 }
|
|
205
|
|
206
|
|
207 bool SystemToolbox::ReadHeader(std::string& header,
|
|
208 const std::string& path,
|
|
209 size_t headerSize)
|
|
210 {
|
|
211 if (!IsRegularFile(path))
|
|
212 {
|
133
|
213 LOG(ERROR) << "The path does not point to a regular file: " << path;
|
44
|
214 throw OrthancException(ErrorCode_RegularFileExpected);
|
|
215 }
|
|
216
|
|
217 boost::filesystem::ifstream f;
|
|
218 f.open(path, std::ifstream::in | std::ifstream::binary);
|
|
219 if (!f.good())
|
|
220 {
|
|
221 throw OrthancException(ErrorCode_InexistentFile);
|
|
222 }
|
|
223
|
|
224 bool full = true;
|
|
225
|
|
226 {
|
|
227 std::streamsize size = GetStreamSize(f);
|
|
228 if (size <= 0)
|
|
229 {
|
|
230 headerSize = 0;
|
|
231 full = false;
|
|
232 }
|
|
233 else if (static_cast<size_t>(size) < headerSize)
|
|
234 {
|
107
|
235 headerSize = static_cast<size_t>(size); // Truncate to the size of the file
|
44
|
236 full = false;
|
|
237 }
|
|
238 }
|
|
239
|
|
240 header.resize(headerSize);
|
|
241 if (headerSize != 0)
|
|
242 {
|
|
243 f.read(reinterpret_cast<char*>(&header[0]), headerSize);
|
|
244 }
|
|
245
|
|
246 f.close();
|
|
247
|
|
248 return full;
|
|
249 }
|
|
250
|
|
251
|
|
252 void SystemToolbox::WriteFile(const void* content,
|
|
253 size_t size,
|
|
254 const std::string& path)
|
|
255 {
|
|
256 boost::filesystem::ofstream f;
|
|
257 f.open(path, std::ofstream::out | std::ofstream::binary);
|
|
258 if (!f.good())
|
|
259 {
|
|
260 throw OrthancException(ErrorCode_CannotWriteFile);
|
|
261 }
|
|
262
|
|
263 if (size != 0)
|
|
264 {
|
|
265 f.write(reinterpret_cast<const char*>(content), size);
|
|
266
|
|
267 if (!f.good())
|
|
268 {
|
|
269 f.close();
|
|
270 throw OrthancException(ErrorCode_FileStorageCannotWrite);
|
|
271 }
|
|
272 }
|
|
273
|
|
274 f.close();
|
|
275 }
|
|
276
|
|
277
|
|
278 void SystemToolbox::WriteFile(const std::string& content,
|
|
279 const std::string& path)
|
|
280 {
|
|
281 WriteFile(content.size() > 0 ? content.c_str() : NULL,
|
|
282 content.size(), path);
|
|
283 }
|
|
284
|
|
285
|
|
286 void SystemToolbox::RemoveFile(const std::string& path)
|
|
287 {
|
|
288 if (boost::filesystem::exists(path))
|
|
289 {
|
|
290 if (IsRegularFile(path))
|
|
291 {
|
|
292 boost::filesystem::remove(path);
|
|
293 }
|
|
294 else
|
|
295 {
|
|
296 throw OrthancException(ErrorCode_RegularFileExpected);
|
|
297 }
|
|
298 }
|
|
299 }
|
|
300
|
|
301
|
|
302 uint64_t SystemToolbox::GetFileSize(const std::string& path)
|
|
303 {
|
|
304 try
|
|
305 {
|
|
306 return static_cast<uint64_t>(boost::filesystem::file_size(path));
|
|
307 }
|
|
308 catch (boost::filesystem::filesystem_error&)
|
|
309 {
|
|
310 throw OrthancException(ErrorCode_InexistentFile);
|
|
311 }
|
|
312 }
|
|
313
|
|
314
|
|
315 void SystemToolbox::MakeDirectory(const std::string& path)
|
|
316 {
|
|
317 if (boost::filesystem::exists(path))
|
|
318 {
|
|
319 if (!boost::filesystem::is_directory(path))
|
|
320 {
|
|
321 throw OrthancException(ErrorCode_DirectoryOverFile);
|
|
322 }
|
|
323 }
|
|
324 else
|
|
325 {
|
|
326 if (!boost::filesystem::create_directories(path))
|
|
327 {
|
|
328 throw OrthancException(ErrorCode_MakeDirectory);
|
|
329 }
|
|
330 }
|
|
331 }
|
|
332
|
|
333
|
|
334 bool SystemToolbox::IsExistingFile(const std::string& path)
|
|
335 {
|
|
336 return boost::filesystem::exists(path);
|
|
337 }
|
|
338
|
|
339
|
|
340 #if defined(_WIN32)
|
|
341 static std::string GetPathToExecutableInternal()
|
|
342 {
|
|
343 // Yes, this is ugly, but there is no simple way to get the
|
|
344 // required buffer size, so we use a big constant
|
|
345 std::vector<char> buffer(32768);
|
|
346 /*int bytes =*/ GetModuleFileNameA(NULL, &buffer[0], static_cast<DWORD>(buffer.size() - 1));
|
|
347 return std::string(&buffer[0]);
|
|
348 }
|
|
349
|
|
350 #elif defined(__linux__) || defined(__FreeBSD_kernel__) || defined(__FreeBSD__)
|
|
351 static std::string GetPathToExecutableInternal()
|
|
352 {
|
107
|
353 // NOTE: For FreeBSD, using KERN_PROC_PATHNAME might be a better alternative
|
|
354
|
44
|
355 std::vector<char> buffer(PATH_MAX + 1);
|
|
356 ssize_t bytes = readlink("/proc/self/exe", &buffer[0], buffer.size() - 1);
|
|
357 if (bytes == 0)
|
|
358 {
|
|
359 throw OrthancException(ErrorCode_PathToExecutable);
|
|
360 }
|
|
361
|
|
362 return std::string(&buffer[0]);
|
|
363 }
|
|
364
|
|
365 #elif defined(__APPLE__) && defined(__MACH__)
|
|
366 static std::string GetPathToExecutableInternal()
|
|
367 {
|
|
368 char pathbuf[PATH_MAX + 1];
|
|
369 unsigned int bufsize = static_cast<int>(sizeof(pathbuf));
|
|
370
|
|
371 _NSGetExecutablePath( pathbuf, &bufsize);
|
|
372
|
|
373 return std::string(pathbuf);
|
|
374 }
|
|
375
|
107
|
376 #elif defined(__OpenBSD__)
|
|
377 static std::string GetPathToExecutableInternal()
|
|
378 {
|
|
379 // This is an adapted version of the patch proposed in issue #64
|
|
380 // without an explicit call to "malloc()" to prevent memory leak
|
|
381 // https://bitbucket.org/sjodogne/orthanc/issues/64/add-openbsd-support
|
|
382 // https://stackoverflow.com/q/31494901/881731
|
|
383
|
|
384 const int mib[4] = { CTL_KERN, KERN_PROC_ARGS, getpid(), KERN_PROC_ARGV };
|
|
385
|
|
386 size_t len;
|
|
387 if (sysctl(mib, 4, NULL, &len, NULL, 0) == -1)
|
|
388 {
|
|
389 throw OrthancException(ErrorCode_PathToExecutable);
|
|
390 }
|
|
391
|
|
392 std::string tmp;
|
|
393 tmp.resize(len);
|
|
394
|
|
395 char** buffer = reinterpret_cast<char**>(&tmp[0]);
|
|
396
|
|
397 if (sysctl(mib, 4, buffer, &len, NULL, 0) == -1)
|
|
398 {
|
|
399 throw OrthancException(ErrorCode_PathToExecutable);
|
|
400 }
|
|
401 else
|
|
402 {
|
|
403 return std::string(buffer[0]);
|
|
404 }
|
|
405 }
|
|
406
|
44
|
407 #else
|
|
408 #error Support your platform here
|
|
409 #endif
|
|
410
|
|
411
|
|
412 std::string SystemToolbox::GetPathToExecutable()
|
|
413 {
|
|
414 boost::filesystem::path p(GetPathToExecutableInternal());
|
|
415 return boost::filesystem::absolute(p).string();
|
|
416 }
|
|
417
|
|
418
|
|
419 std::string SystemToolbox::GetDirectoryOfExecutable()
|
|
420 {
|
|
421 boost::filesystem::path p(GetPathToExecutableInternal());
|
|
422 return boost::filesystem::absolute(p.parent_path()).string();
|
|
423 }
|
|
424
|
|
425
|
|
426 void SystemToolbox::ExecuteSystemCommand(const std::string& command,
|
|
427 const std::vector<std::string>& arguments)
|
|
428 {
|
|
429 // Convert the arguments as a C array
|
|
430 std::vector<char*> args(arguments.size() + 2);
|
|
431
|
|
432 args.front() = const_cast<char*>(command.c_str());
|
|
433
|
|
434 for (size_t i = 0; i < arguments.size(); i++)
|
|
435 {
|
|
436 args[i + 1] = const_cast<char*>(arguments[i].c_str());
|
|
437 }
|
|
438
|
|
439 args.back() = NULL;
|
|
440
|
|
441 int status;
|
|
442
|
|
443 #if defined(_WIN32)
|
|
444 // http://msdn.microsoft.com/en-us/library/275khfab.aspx
|
|
445 status = static_cast<int>(_spawnvp(_P_OVERLAY, command.c_str(), &args[0]));
|
|
446
|
|
447 #else
|
|
448 int pid = fork();
|
|
449
|
|
450 if (pid == -1)
|
|
451 {
|
|
452 // Error in fork()
|
|
453 #if ORTHANC_ENABLE_LOGGING == 1
|
|
454 LOG(ERROR) << "Cannot fork a child process";
|
|
455 #endif
|
|
456
|
|
457 throw OrthancException(ErrorCode_SystemCommand);
|
|
458 }
|
|
459 else if (pid == 0)
|
|
460 {
|
|
461 // Execute the system command in the child process
|
|
462 execvp(command.c_str(), &args[0]);
|
|
463
|
|
464 // We should never get here
|
|
465 _exit(1);
|
|
466 }
|
|
467 else
|
|
468 {
|
|
469 // Wait for the system command to exit
|
|
470 waitpid(pid, &status, 0);
|
|
471 }
|
|
472 #endif
|
|
473
|
|
474 if (status != 0)
|
|
475 {
|
|
476 #if ORTHANC_ENABLE_LOGGING == 1
|
|
477 LOG(ERROR) << "System command failed with status code " << status;
|
|
478 #endif
|
|
479
|
|
480 throw OrthancException(ErrorCode_SystemCommand);
|
|
481 }
|
|
482 }
|
|
483
|
|
484
|
|
485 int SystemToolbox::GetProcessId()
|
|
486 {
|
|
487 #if defined(_WIN32)
|
|
488 return static_cast<int>(_getpid());
|
|
489 #else
|
|
490 return static_cast<int>(getpid());
|
|
491 #endif
|
|
492 }
|
|
493
|
|
494
|
|
495 bool SystemToolbox::IsRegularFile(const std::string& path)
|
|
496 {
|
|
497 namespace fs = boost::filesystem;
|
|
498
|
|
499 try
|
|
500 {
|
|
501 if (fs::exists(path))
|
|
502 {
|
|
503 fs::file_status status = fs::status(path);
|
|
504 return (status.type() == boost::filesystem::regular_file ||
|
|
505 status.type() == boost::filesystem::reparse_file); // Fix BitBucket issue #11
|
|
506 }
|
|
507 }
|
|
508 catch (fs::filesystem_error&)
|
|
509 {
|
|
510 }
|
|
511
|
|
512 return false;
|
|
513 }
|
|
514
|
|
515
|
|
516 FILE* SystemToolbox::OpenFile(const std::string& path,
|
|
517 FileMode mode)
|
|
518 {
|
|
519 #if defined(_WIN32)
|
|
520 // TODO Deal with special characters by converting to the current locale
|
|
521 #endif
|
|
522
|
|
523 const char* m;
|
|
524 switch (mode)
|
|
525 {
|
|
526 case FileMode_ReadBinary:
|
|
527 m = "rb";
|
|
528 break;
|
|
529
|
|
530 case FileMode_WriteBinary:
|
|
531 m = "wb";
|
|
532 break;
|
|
533
|
|
534 default:
|
|
535 throw OrthancException(ErrorCode_ParameterOutOfRange);
|
|
536 }
|
|
537
|
|
538 return fopen(path.c_str(), m);
|
|
539 }
|
|
540
|
|
541
|
54
|
542 std::string SystemToolbox::GenerateUuid()
|
|
543 {
|
|
544 #ifdef WIN32
|
|
545 UUID uuid;
|
|
546 UuidCreate ( &uuid );
|
|
547
|
|
548 unsigned char * str;
|
|
549 UuidToStringA ( &uuid, &str );
|
|
550
|
|
551 std::string s( ( char* ) str );
|
|
552
|
|
553 RpcStringFreeA ( &str );
|
|
554 #else
|
|
555 uuid_t uuid;
|
|
556 uuid_generate_random ( uuid );
|
|
557 char s[37];
|
|
558 uuid_unparse ( uuid, s );
|
|
559 #endif
|
|
560 return s;
|
|
561 }
|
|
562
|
|
563
|
130
|
564 static boost::posix_time::ptime GetNow(bool utc)
|
44
|
565 {
|
130
|
566 if (utc)
|
|
567 {
|
|
568 return boost::posix_time::second_clock::universal_time();
|
|
569 }
|
|
570 else
|
|
571 {
|
|
572 return boost::posix_time::second_clock::local_time();
|
|
573 }
|
|
574 }
|
|
575
|
|
576
|
|
577 std::string SystemToolbox::GetNowIsoString(bool utc)
|
|
578 {
|
|
579 return boost::posix_time::to_iso_string(GetNow(utc));
|
44
|
580 }
|
|
581
|
107
|
582
|
44
|
583 void SystemToolbox::GetNowDicom(std::string& date,
|
130
|
584 std::string& time,
|
|
585 bool utc)
|
44
|
586 {
|
130
|
587 boost::posix_time::ptime now = GetNow(utc);
|
44
|
588 tm tm = boost::posix_time::to_tm(now);
|
|
589
|
|
590 char s[32];
|
|
591 sprintf(s, "%04d%02d%02d", tm.tm_year + 1900, tm.tm_mon + 1, tm.tm_mday);
|
|
592 date.assign(s);
|
|
593
|
|
594 // TODO milliseconds
|
|
595 sprintf(s, "%02d%02d%02d.%06d", tm.tm_hour, tm.tm_min, tm.tm_sec, 0);
|
|
596 time.assign(s);
|
|
597 }
|
|
598 }
|