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