/
Log.cpp
423 lines (350 loc) · 9.75 KB
/
Log.cpp
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
//------------------------------------------------------------------------------
/*
This file is part of rippled: https://github.com/ripple/rippled
Copyright (c) 2012, 2013 Ripple Labs Inc.
Permission to use, copy, modify, and/or distribute this software for any
purpose with or without fee is hereby granted, provided that the above
copyright notice and this permission notice appear in all copies.
THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
ANY SPECIAL , DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
*/
//==============================================================================
#include <ripple/basics/chrono.h>
#include <ripple/basics/Log.h>
#include <ripple/basics/contract.h>
#include <boost/algorithm/string.hpp>
#include <cassert>
#include <fstream>
#include <functional>
#include <iostream>
#include <memory>
#include <mutex>
namespace ripple {
Logs::Sink::Sink (std::string const& partition,
beast::severities::Severity thresh, Logs& logs)
: beast::Journal::Sink (thresh, false)
, logs_(logs)
, partition_(partition)
{
}
void
Logs::Sink::write (beast::severities::Severity level, std::string const& text)
{
if (level < threshold())
return;
logs_.write (level, partition_, text, console());
}
//------------------------------------------------------------------------------
Logs::File::File()
: m_stream (nullptr)
{
}
bool Logs::File::isOpen () const noexcept
{
return m_stream != nullptr;
}
bool Logs::File::open (boost::filesystem::path const& path)
{
close ();
bool wasOpened = false;
// VFALCO TODO Make this work with Unicode file paths
std::unique_ptr <std::ofstream> stream (
new std::ofstream (path.c_str (), std::fstream::app));
if (stream->good ())
{
m_path = path;
m_stream = std::move (stream);
wasOpened = true;
}
return wasOpened;
}
bool Logs::File::closeAndReopen ()
{
close ();
return open (m_path);
}
void Logs::File::close ()
{
m_stream = nullptr;
}
void Logs::File::write (char const* text)
{
if (m_stream != nullptr)
(*m_stream) << text;
}
void Logs::File::writeln (char const* text)
{
if (m_stream != nullptr)
{
(*m_stream) << text;
(*m_stream) << std::endl;
}
}
//------------------------------------------------------------------------------
Logs::Logs(beast::severities::Severity thresh)
: thresh_ (thresh) // default severity
{
}
bool
Logs::open (boost::filesystem::path const& pathToLogFile)
{
return file_.open(pathToLogFile);
}
beast::Journal::Sink&
Logs::get (std::string const& name)
{
std::lock_guard lock (mutex_);
auto const result =
sinks_.emplace(name, makeSink(name, thresh_));
return *result.first->second;
}
beast::Journal::Sink&
Logs::operator[] (std::string const& name)
{
return get(name);
}
beast::Journal
Logs::journal (std::string const& name)
{
return beast::Journal (get(name));
}
beast::severities::Severity
Logs::threshold() const
{
return thresh_;
}
void
Logs::threshold (beast::severities::Severity thresh)
{
std::lock_guard lock (mutex_);
thresh_ = thresh;
for (auto& sink : sinks_)
sink.second->threshold (thresh);
}
std::vector<std::pair<std::string, std::string>>
Logs::partition_severities() const
{
std::vector<std::pair<std::string, std::string>> list;
std::lock_guard lock (mutex_);
list.reserve (sinks_.size());
for (auto const& e : sinks_)
list.push_back(std::make_pair(e.first,
toString(fromSeverity(e.second->threshold()))));
return list;
}
void
Logs::write (beast::severities::Severity level, std::string const& partition,
std::string const& text, bool console)
{
std::string s;
format (s, text, level, partition);
std::lock_guard lock (mutex_);
file_.writeln (s);
if (! silent_)
std::cerr << s << '\n';
// VFALCO TODO Fix console output
//if (console)
// out_.write_console(s);
}
std::string
Logs::rotate()
{
std::lock_guard lock (mutex_);
bool const wasOpened = file_.closeAndReopen ();
if (wasOpened)
return "The log file was closed and reopened.";
return "The log file could not be closed and reopened.";
}
std::unique_ptr<beast::Journal::Sink>
Logs::makeSink(std::string const& name,
beast::severities::Severity threshold)
{
return std::make_unique<Sink>(
name, threshold, *this);
}
LogSeverity
Logs::fromSeverity (beast::severities::Severity level)
{
using namespace beast::severities;
switch (level)
{
case kTrace: return lsTRACE;
case kDebug: return lsDEBUG;
case kInfo: return lsINFO;
case kWarning: return lsWARNING;
case kError: return lsERROR;
default:
assert(false);
[[fallthrough]];
case kFatal:
break;
}
return lsFATAL;
}
beast::severities::Severity
Logs::toSeverity (LogSeverity level)
{
using namespace beast::severities;
switch (level)
{
case lsTRACE: return kTrace;
case lsDEBUG: return kDebug;
case lsINFO: return kInfo;
case lsWARNING: return kWarning;
case lsERROR: return kError;
default:
assert(false);
[[fallthrough]];
case lsFATAL:
break;
}
return kFatal;
}
std::string
Logs::toString (LogSeverity s)
{
switch (s)
{
case lsTRACE: return "Trace";
case lsDEBUG: return "Debug";
case lsINFO: return "Info";
case lsWARNING: return "Warning";
case lsERROR: return "Error";
case lsFATAL: return "Fatal";
default:
assert (false);
return "Unknown";
}
}
LogSeverity
Logs::fromString (std::string const& s)
{
if (boost::iequals (s, "trace"))
return lsTRACE;
if (boost::iequals (s, "debug"))
return lsDEBUG;
if (boost::iequals (s, "info") || boost::iequals (s, "information"))
return lsINFO;
if (boost::iequals (s, "warn") || boost::iequals (s, "warning") || boost::iequals (s, "warnings"))
return lsWARNING;
if (boost::iequals (s, "error") || boost::iequals (s, "errors"))
return lsERROR;
if (boost::iequals (s, "fatal") || boost::iequals (s, "fatals"))
return lsFATAL;
return lsINVALID;
}
void
Logs::format (std::string& output, std::string const& message,
beast::severities::Severity severity, std::string const& partition)
{
output.reserve (message.size() + partition.size() + 100);
output = to_string(std::chrono::system_clock::now());
output += " ";
if (! partition.empty ())
output += partition + ":";
using namespace beast::severities;
switch (severity)
{
case kTrace: output += "TRC "; break;
case kDebug: output += "DBG "; break;
case kInfo: output += "NFO "; break;
case kWarning: output += "WRN "; break;
case kError: output += "ERR "; break;
default:
assert(false);
[[fallthrough]];
case kFatal: output += "FTL "; break;
}
output += message;
// Limit the maximum length of the output
if (output.size() > maximumMessageCharacters)
{
output.resize (maximumMessageCharacters - 3);
output += "...";
}
// Attempt to prevent sensitive information from appearing in log files by
// redacting it with asterisks.
auto scrubber = [&output](char const* token)
{
auto first = output.find(token);
// If we have found the specified token, then attempt to isolate the
// sensitive data (it's enclosed by double quotes) and mask it off:
if (first != std::string::npos)
{
first = output.find ('\"', first + std::strlen(token));
if (first != std::string::npos)
{
auto last = output.find('\"', ++first);
if (last == std::string::npos)
last = output.size();
output.replace (first, last - first, last - first, '*');
}
}
};
scrubber ("\"seed\"");
scrubber ("\"seed_hex\"");
scrubber ("\"secret\"");
scrubber ("\"master_key\"");
scrubber ("\"master_seed\"");
scrubber ("\"master_seed_hex\"");
scrubber ("\"passphrase\"");
}
//------------------------------------------------------------------------------
class DebugSink
{
private:
std::reference_wrapper<beast::Journal::Sink> sink_;
std::unique_ptr<beast::Journal::Sink> holder_;
std::mutex m_;
public:
DebugSink ()
: sink_ (beast::Journal::getNullSink())
{
}
DebugSink (DebugSink const&) = delete;
DebugSink& operator=(DebugSink const&) = delete;
DebugSink(DebugSink&&) = delete;
DebugSink& operator=(DebugSink&&) = delete;
std::unique_ptr<beast::Journal::Sink>
set(std::unique_ptr<beast::Journal::Sink> sink)
{
std::lock_guard _(m_);
using std::swap;
swap (holder_, sink);
if (holder_)
sink_ = *holder_;
else
sink_ = beast::Journal::getNullSink();
return sink;
}
beast::Journal::Sink&
get()
{
std::lock_guard _(m_);
return sink_.get();
}
};
static
DebugSink&
debugSink()
{
static DebugSink _;
return _;
}
std::unique_ptr<beast::Journal::Sink>
setDebugLogSink(
std::unique_ptr<beast::Journal::Sink> sink)
{
return debugSink().set(std::move(sink));
}
beast::Journal
debugLog()
{
return beast::Journal (debugSink().get());
}
} // ripple