|
1
|
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 "Logging.h"
|
|
|
35
|
|
|
36 #if ORTHANC_ENABLE_LOGGING != 1
|
|
|
37
|
|
|
38 namespace Orthanc
|
|
|
39 {
|
|
|
40 namespace Logging
|
|
|
41 {
|
|
|
42 void Initialize()
|
|
|
43 {
|
|
|
44 }
|
|
|
45
|
|
|
46 void Finalize()
|
|
|
47 {
|
|
|
48 }
|
|
|
49
|
|
|
50 void Reset()
|
|
|
51 {
|
|
|
52 }
|
|
|
53
|
|
|
54 void Flush()
|
|
|
55 {
|
|
|
56 }
|
|
|
57
|
|
|
58 void EnableInfoLevel(bool enabled)
|
|
|
59 {
|
|
|
60 }
|
|
|
61
|
|
|
62 void EnableTraceLevel(bool enabled)
|
|
|
63 {
|
|
|
64 }
|
|
|
65
|
|
|
66 void SetTargetFile(const std::string& path)
|
|
|
67 {
|
|
|
68 }
|
|
|
69
|
|
|
70 void SetTargetFolder(const std::string& path)
|
|
|
71 {
|
|
|
72 }
|
|
|
73 }
|
|
|
74 }
|
|
|
75
|
|
92
|
76
|
|
|
77 #elif ORTHANC_ENABLE_LOGGING_PLUGIN == 1
|
|
|
78
|
|
|
79 /*********************************************************
|
|
|
80 * Logger compatible with the Orthanc plugin SDK
|
|
|
81 *********************************************************/
|
|
|
82
|
|
|
83 #include <boost/lexical_cast.hpp>
|
|
|
84
|
|
|
85 namespace Orthanc
|
|
|
86 {
|
|
|
87 namespace Logging
|
|
|
88 {
|
|
|
89 static OrthancPluginContext* context_ = NULL;
|
|
|
90
|
|
|
91 void Initialize(OrthancPluginContext* context)
|
|
|
92 {
|
|
|
93 context_ = context_;
|
|
|
94 }
|
|
|
95
|
|
|
96 InternalLogger::InternalLogger(const char* level,
|
|
|
97 const char* file /* ignored */,
|
|
|
98 int line /* ignored */) :
|
|
|
99 level_(level)
|
|
|
100 {
|
|
|
101 }
|
|
|
102
|
|
|
103 InternalLogger::~InternalLogger()
|
|
|
104 {
|
|
|
105 if (context_ != NULL)
|
|
|
106 {
|
|
|
107 if (level_ == "ERROR")
|
|
|
108 {
|
|
|
109 OrthancPluginLogError(context_, message_.c_str());
|
|
|
110 }
|
|
|
111 else if (level_ == "WARNING")
|
|
|
112 {
|
|
|
113 OrthancPluginLogWarning(context_, message_.c_str());
|
|
|
114 }
|
|
|
115 else if (level_ == "INFO")
|
|
|
116 {
|
|
|
117 OrthancPluginLogInfo(context_, message_.c_str());
|
|
|
118 }
|
|
|
119 }
|
|
|
120 }
|
|
|
121
|
|
|
122 InternalLogger& InternalLogger::operator<< (const std::string& message)
|
|
|
123 {
|
|
|
124 message_ += message;
|
|
|
125 return *this;
|
|
|
126 }
|
|
|
127
|
|
|
128 InternalLogger& InternalLogger::operator<< (const char* message)
|
|
|
129 {
|
|
|
130 message_ += std::string(message);
|
|
|
131 return *this;
|
|
|
132 }
|
|
|
133
|
|
|
134 InternalLogger& InternalLogger::operator<< (int message)
|
|
|
135 {
|
|
|
136 message_ += boost::lexical_cast<std::string>(message);
|
|
|
137 return *this;
|
|
|
138 }
|
|
|
139 }
|
|
|
140 }
|
|
|
141
|
|
|
142
|
|
|
143 #else /* ORTHANC_ENABLE_LOGGING_PLUGIN == 0 && ORTHANC_ENABLE_LOGGING == 1 */
|
|
1
|
144
|
|
|
145 /*********************************************************
|
|
|
146 * Internal logger of Orthanc, that mimics some
|
|
|
147 * behavior from Google Log.
|
|
|
148 *********************************************************/
|
|
|
149
|
|
|
150 #include "OrthancException.h"
|
|
|
151 #include "Enumerations.h"
|
|
|
152 #include "Toolbox.h"
|
|
43
|
153 #include "SystemToolbox.h"
|
|
1
|
154
|
|
|
155 #include <fstream>
|
|
|
156 #include <boost/filesystem.hpp>
|
|
|
157 #include <boost/thread.hpp>
|
|
|
158
|
|
|
159 #if BOOST_HAS_DATE_TIME == 1
|
|
|
160 # include <boost/date_time/posix_time/posix_time.hpp>
|
|
|
161 #else
|
|
|
162 # error Boost::date_time is required
|
|
|
163 #endif
|
|
|
164
|
|
|
165
|
|
|
166 namespace
|
|
|
167 {
|
|
|
168 struct LoggingContext
|
|
|
169 {
|
|
|
170 bool infoEnabled_;
|
|
|
171 bool traceEnabled_;
|
|
|
172 std::string targetFile_;
|
|
|
173 std::string targetFolder_;
|
|
|
174
|
|
|
175 std::ostream* error_;
|
|
|
176 std::ostream* warning_;
|
|
|
177 std::ostream* info_;
|
|
|
178
|
|
|
179 std::auto_ptr<std::ofstream> file_;
|
|
|
180
|
|
|
181 LoggingContext() :
|
|
|
182 infoEnabled_(false),
|
|
|
183 traceEnabled_(false),
|
|
|
184 error_(&std::cerr),
|
|
|
185 warning_(&std::cerr),
|
|
|
186 info_(&std::cerr)
|
|
|
187 {
|
|
|
188 }
|
|
|
189 };
|
|
|
190 }
|
|
|
191
|
|
|
192
|
|
|
193
|
|
|
194 static std::auto_ptr<LoggingContext> loggingContext_;
|
|
|
195 static boost::mutex loggingMutex_;
|
|
|
196
|
|
|
197
|
|
|
198
|
|
|
199 namespace Orthanc
|
|
|
200 {
|
|
|
201 namespace Logging
|
|
|
202 {
|
|
|
203 static void GetLogPath(boost::filesystem::path& log,
|
|
|
204 boost::filesystem::path& link,
|
|
|
205 const std::string& suffix,
|
|
|
206 const std::string& directory)
|
|
|
207 {
|
|
|
208 /**
|
|
|
209 From Google Log documentation:
|
|
|
210
|
|
|
211 Unless otherwise specified, logs will be written to the filename
|
|
|
212 "<program name>.<hostname>.<user name>.log<suffix>.",
|
|
|
213 followed by the date, time, and pid (you can't prevent the date,
|
|
|
214 time, and pid from being in the filename).
|
|
|
215
|
|
|
216 In this implementation : "hostname" and "username" are not used
|
|
|
217 **/
|
|
|
218
|
|
|
219 boost::posix_time::ptime now = boost::posix_time::second_clock::local_time();
|
|
|
220 boost::filesystem::path root(directory);
|
|
43
|
221 boost::filesystem::path exe(SystemToolbox::GetPathToExecutable());
|
|
1
|
222
|
|
|
223 if (!boost::filesystem::exists(root) ||
|
|
|
224 !boost::filesystem::is_directory(root))
|
|
|
225 {
|
|
|
226 throw OrthancException(ErrorCode_CannotWriteFile);
|
|
|
227 }
|
|
|
228
|
|
|
229 char date[64];
|
|
|
230 sprintf(date, "%04d%02d%02d-%02d%02d%02d.%d",
|
|
|
231 static_cast<int>(now.date().year()),
|
|
|
232 now.date().month().as_number(),
|
|
|
233 now.date().day().as_number(),
|
|
|
234 now.time_of_day().hours(),
|
|
|
235 now.time_of_day().minutes(),
|
|
|
236 now.time_of_day().seconds(),
|
|
43
|
237 SystemToolbox::GetProcessId());
|
|
1
|
238
|
|
|
239 std::string programName = exe.filename().replace_extension("").string();
|
|
|
240
|
|
|
241 log = (root / (programName + ".log" + suffix + "." + std::string(date)));
|
|
|
242 link = (root / (programName + ".log" + suffix));
|
|
|
243 }
|
|
|
244
|
|
|
245
|
|
|
246 static void PrepareLogFolder(std::auto_ptr<std::ofstream>& file,
|
|
|
247 const std::string& suffix,
|
|
|
248 const std::string& directory)
|
|
|
249 {
|
|
|
250 boost::filesystem::path log, link;
|
|
|
251 GetLogPath(log, link, suffix, directory);
|
|
|
252
|
|
|
253 #if !defined(_WIN32) && (defined(__unix__) || defined(__unix) || (defined(__APPLE__) && defined(__MACH__)))
|
|
|
254 boost::filesystem::remove(link);
|
|
|
255 boost::filesystem::create_symlink(log.filename(), link);
|
|
|
256 #endif
|
|
|
257
|
|
|
258 file.reset(new std::ofstream(log.string().c_str()));
|
|
|
259 }
|
|
|
260
|
|
|
261
|
|
|
262 void Initialize()
|
|
|
263 {
|
|
|
264 boost::mutex::scoped_lock lock(loggingMutex_);
|
|
|
265 loggingContext_.reset(new LoggingContext);
|
|
|
266 }
|
|
|
267
|
|
|
268 void Finalize()
|
|
|
269 {
|
|
|
270 boost::mutex::scoped_lock lock(loggingMutex_);
|
|
|
271 loggingContext_.reset(NULL);
|
|
|
272 }
|
|
|
273
|
|
|
274 void Reset()
|
|
|
275 {
|
|
|
276 // Recover the old logging context
|
|
|
277 std::auto_ptr<LoggingContext> old;
|
|
|
278
|
|
|
279 {
|
|
|
280 boost::mutex::scoped_lock lock(loggingMutex_);
|
|
|
281 if (loggingContext_.get() == NULL)
|
|
|
282 {
|
|
|
283 return;
|
|
|
284 }
|
|
|
285 else
|
|
|
286 {
|
|
|
287 old = loggingContext_;
|
|
|
288
|
|
|
289 // Create a new logging context,
|
|
|
290 loggingContext_.reset(new LoggingContext);
|
|
|
291 }
|
|
|
292 }
|
|
|
293
|
|
|
294 EnableInfoLevel(old->infoEnabled_);
|
|
|
295 EnableTraceLevel(old->traceEnabled_);
|
|
|
296
|
|
|
297 if (!old->targetFolder_.empty())
|
|
|
298 {
|
|
|
299 SetTargetFolder(old->targetFolder_);
|
|
|
300 }
|
|
|
301 else if (!old->targetFile_.empty())
|
|
|
302 {
|
|
|
303 SetTargetFile(old->targetFile_);
|
|
|
304 }
|
|
|
305 }
|
|
|
306
|
|
|
307 void EnableInfoLevel(bool enabled)
|
|
|
308 {
|
|
|
309 boost::mutex::scoped_lock lock(loggingMutex_);
|
|
|
310 assert(loggingContext_.get() != NULL);
|
|
|
311
|
|
|
312 loggingContext_->infoEnabled_ = enabled;
|
|
|
313
|
|
|
314 if (!enabled)
|
|
|
315 {
|
|
|
316 // Also disable the "TRACE" level when info-level debugging is disabled
|
|
|
317 loggingContext_->traceEnabled_ = false;
|
|
|
318 }
|
|
|
319 }
|
|
|
320
|
|
|
321 void EnableTraceLevel(bool enabled)
|
|
|
322 {
|
|
|
323 boost::mutex::scoped_lock lock(loggingMutex_);
|
|
|
324 assert(loggingContext_.get() != NULL);
|
|
|
325
|
|
|
326 loggingContext_->traceEnabled_ = enabled;
|
|
|
327
|
|
|
328 if (enabled)
|
|
|
329 {
|
|
|
330 // Also enable the "INFO" level when trace-level debugging is enabled
|
|
|
331 loggingContext_->infoEnabled_ = true;
|
|
|
332 }
|
|
|
333 }
|
|
|
334
|
|
|
335
|
|
|
336 static void CheckFile(std::auto_ptr<std::ofstream>& f)
|
|
|
337 {
|
|
|
338 if (loggingContext_->file_.get() == NULL ||
|
|
|
339 !loggingContext_->file_->is_open())
|
|
|
340 {
|
|
|
341 throw OrthancException(ErrorCode_CannotWriteFile);
|
|
|
342 }
|
|
|
343 }
|
|
|
344
|
|
|
345 void SetTargetFolder(const std::string& path)
|
|
|
346 {
|
|
|
347 boost::mutex::scoped_lock lock(loggingMutex_);
|
|
|
348 assert(loggingContext_.get() != NULL);
|
|
|
349
|
|
|
350 PrepareLogFolder(loggingContext_->file_, "" /* no suffix */, path);
|
|
|
351 CheckFile(loggingContext_->file_);
|
|
|
352
|
|
|
353 loggingContext_->targetFile_.clear();
|
|
|
354 loggingContext_->targetFolder_ = path;
|
|
|
355 loggingContext_->warning_ = loggingContext_->file_.get();
|
|
|
356 loggingContext_->error_ = loggingContext_->file_.get();
|
|
|
357 loggingContext_->info_ = loggingContext_->file_.get();
|
|
|
358 }
|
|
|
359
|
|
|
360
|
|
|
361 void SetTargetFile(const std::string& path)
|
|
|
362 {
|
|
|
363 boost::mutex::scoped_lock lock(loggingMutex_);
|
|
|
364 assert(loggingContext_.get() != NULL);
|
|
|
365
|
|
|
366 loggingContext_->file_.reset(new std::ofstream(path.c_str(), std::fstream::app));
|
|
|
367 CheckFile(loggingContext_->file_);
|
|
|
368
|
|
|
369 loggingContext_->targetFile_ = path;
|
|
|
370 loggingContext_->targetFolder_.clear();
|
|
|
371 loggingContext_->warning_ = loggingContext_->file_.get();
|
|
|
372 loggingContext_->error_ = loggingContext_->file_.get();
|
|
|
373 loggingContext_->info_ = loggingContext_->file_.get();
|
|
|
374 }
|
|
|
375
|
|
|
376
|
|
|
377 InternalLogger::InternalLogger(const char* level,
|
|
|
378 const char* file,
|
|
|
379 int line) :
|
|
|
380 lock_(loggingMutex_),
|
|
|
381 stream_(&null_) // By default, logging to "/dev/null" is simulated
|
|
|
382 {
|
|
|
383 if (loggingContext_.get() == NULL)
|
|
|
384 {
|
|
|
385 fprintf(stderr, "ERROR: Trying to log a message after the finalization of the logging engine\n");
|
|
|
386 return;
|
|
|
387 }
|
|
|
388
|
|
39
|
389 try
|
|
1
|
390 {
|
|
39
|
391 LogLevel l = StringToLogLevel(level);
|
|
|
392
|
|
|
393 if ((l == LogLevel_Info && !loggingContext_->infoEnabled_) ||
|
|
|
394 (l == LogLevel_Trace && !loggingContext_->traceEnabled_))
|
|
|
395 {
|
|
|
396 // This logging level is disabled, directly exit and unlock
|
|
|
397 // the mutex to speed-up things. The stream is set to "/dev/null"
|
|
|
398 lock_.unlock();
|
|
|
399 return;
|
|
|
400 }
|
|
1
|
401
|
|
39
|
402 // Compute the header of the line, temporary release the lock as
|
|
|
403 // this is a time-consuming operation
|
|
|
404 lock_.unlock();
|
|
|
405 std::string header;
|
|
1
|
406
|
|
39
|
407 {
|
|
|
408 boost::filesystem::path path(file);
|
|
|
409 boost::posix_time::ptime now = boost::posix_time::microsec_clock::local_time();
|
|
|
410 boost::posix_time::time_duration duration = now.time_of_day();
|
|
1
|
411
|
|
39
|
412 /**
|
|
|
413 From Google Log documentation:
|
|
1
|
414
|
|
39
|
415 "Log lines have this form:
|
|
1
|
416
|
|
39
|
417 Lmmdd hh:mm:ss.uuuuuu threadid file:line] msg...
|
|
1
|
418
|
|
39
|
419 where the fields are defined as follows:
|
|
1
|
420
|
|
39
|
421 L A single character, representing the log level (eg 'I' for INFO)
|
|
|
422 mm The month (zero padded; ie May is '05')
|
|
|
423 dd The day (zero padded)
|
|
|
424 hh:mm:ss.uuuuuu Time in hours, minutes and fractional seconds
|
|
|
425 threadid The space-padded thread ID as returned by GetTID() (this matches the PID on Linux)
|
|
|
426 file The file name
|
|
|
427 line The line number
|
|
|
428 msg The user-supplied message"
|
|
1
|
429
|
|
39
|
430 In this implementation, "threadid" is not printed.
|
|
|
431 **/
|
|
1
|
432
|
|
39
|
433 char date[32];
|
|
|
434 sprintf(date, "%c%02d%02d %02d:%02d:%02d.%06d ",
|
|
|
435 level[0],
|
|
|
436 now.date().month().as_number(),
|
|
|
437 now.date().day().as_number(),
|
|
|
438 duration.hours(),
|
|
|
439 duration.minutes(),
|
|
|
440 duration.seconds(),
|
|
|
441 static_cast<int>(duration.fractional_seconds()));
|
|
1
|
442
|
|
39
|
443 header = std::string(date) + path.filename().string() + ":" + boost::lexical_cast<std::string>(line) + "] ";
|
|
|
444 }
|
|
1
|
445
|
|
|
446
|
|
39
|
447 // The header is computed, we now re-lock the mutex to access
|
|
|
448 // the stream objects. Pay attention that "loggingContext_",
|
|
|
449 // "infoEnabled_" or "traceEnabled_" might have changed while
|
|
|
450 // the mutex was unlocked.
|
|
|
451 lock_.lock();
|
|
|
452
|
|
|
453 if (loggingContext_.get() == NULL)
|
|
|
454 {
|
|
|
455 fprintf(stderr, "ERROR: Trying to log a message after the finalization of the logging engine\n");
|
|
|
456 return;
|
|
|
457 }
|
|
1
|
458
|
|
39
|
459 switch (l)
|
|
|
460 {
|
|
|
461 case LogLevel_Error:
|
|
|
462 stream_ = loggingContext_->error_;
|
|
|
463 break;
|
|
1
|
464
|
|
39
|
465 case LogLevel_Warning:
|
|
|
466 stream_ = loggingContext_->warning_;
|
|
|
467 break;
|
|
1
|
468
|
|
39
|
469 case LogLevel_Info:
|
|
|
470 if (loggingContext_->infoEnabled_)
|
|
|
471 {
|
|
|
472 stream_ = loggingContext_->info_;
|
|
|
473 }
|
|
|
474
|
|
|
475 break;
|
|
1
|
476
|
|
39
|
477 case LogLevel_Trace:
|
|
|
478 if (loggingContext_->traceEnabled_)
|
|
|
479 {
|
|
|
480 stream_ = loggingContext_->info_;
|
|
|
481 }
|
|
1
|
482
|
|
39
|
483 break;
|
|
1
|
484
|
|
39
|
485 default:
|
|
|
486 throw OrthancException(ErrorCode_InternalError);
|
|
|
487 }
|
|
1
|
488
|
|
39
|
489 if (stream_ == &null_)
|
|
|
490 {
|
|
|
491 // The logging is disabled for this level. The stream is the
|
|
|
492 // "null_" member of this object, so we can release the global
|
|
|
493 // mutex.
|
|
|
494 lock_.unlock();
|
|
|
495 }
|
|
1
|
496
|
|
39
|
497 (*stream_) << header;
|
|
1
|
498 }
|
|
39
|
499 catch (...)
|
|
|
500 {
|
|
|
501 // Something is going really wrong, probably running out of
|
|
|
502 // memory. Fallback to a degraded mode.
|
|
|
503 stream_ = loggingContext_->error_;
|
|
|
504 (*stream_) << "E???? ??:??:??.?????? ] ";
|
|
|
505 }
|
|
1
|
506 }
|
|
|
507
|
|
|
508
|
|
|
509 InternalLogger::~InternalLogger()
|
|
|
510 {
|
|
|
511 if (stream_ != &null_)
|
|
|
512 {
|
|
|
513 #if defined(_WIN32)
|
|
|
514 *stream_ << "\r\n";
|
|
|
515 #else
|
|
|
516 *stream_ << "\n";
|
|
|
517 #endif
|
|
|
518
|
|
|
519 stream_->flush();
|
|
|
520 }
|
|
|
521 }
|
|
|
522
|
|
|
523
|
|
|
524 void Flush()
|
|
|
525 {
|
|
|
526 boost::mutex::scoped_lock lock(loggingMutex_);
|
|
|
527
|
|
|
528 if (loggingContext_.get() != NULL &&
|
|
|
529 loggingContext_->file_.get() != NULL)
|
|
|
530 {
|
|
|
531 loggingContext_->file_->flush();
|
|
|
532 }
|
|
|
533 }
|
|
|
534 }
|
|
|
535 }
|
|
|
536
|
|
|
537 #endif // ORTHANC_ENABLE_LOGGING
|
