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