Coverage Report

Created: 2026-05-30 06:57

next uncovered line (L), next uncovered region (R), next uncovered branch (B)
/src/logging-log4cxx/src/main/cpp/jsonlayout.cpp
Line
Count
Source
1
/*
2
 * Licensed to the Apache Software Foundation (ASF) under one or more
3
 * contributor license agreements.  See the NOTICE file distributed with
4
 * this work for additional information regarding copyright ownership.
5
 * The ASF licenses this file to You under the Apache License, Version 2.0
6
 * (the "License"); you may not use this file except in compliance with
7
 * the License.  You may obtain a copy of the License at
8
 *
9
 *      http://www.apache.org/licenses/LICENSE-2.0
10
 *
11
 * Unless required by applicable law or agreed to in writing, software
12
 * distributed under the License is distributed on an "AS IS" BASIS,
13
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14
 * See the License for the specific language governing permissions and
15
 * limitations under the License.
16
 */
17
18
#include <log4cxx/logstring.h>
19
#include <log4cxx/jsonlayout.h>
20
#include <log4cxx/spi/loggingevent.h>
21
#include <log4cxx/level.h>
22
#include <log4cxx/helpers/optionconverter.h>
23
#include <log4cxx/helpers/cacheddateformat.h>
24
#include <log4cxx/helpers/simpledateformat.h>
25
#include <log4cxx/helpers/stringhelper.h>
26
#include <log4cxx/helpers/transcoder.h>
27
#include <log4cxx/private/layout_priv.h>
28
29
#include <string.h>
30
31
using namespace LOG4CXX_NS;
32
using namespace LOG4CXX_NS::helpers;
33
using namespace LOG4CXX_NS::spi;
34
35
IMPLEMENT_LOG4CXX_OBJECT(JSONLayout)
36
37
struct JSONLayout::JSONLayoutPrivate
38
{
39
  JSONLayoutPrivate() :
40
0
    locationInfo(false),
41
0
    prettyPrint(false),
42
0
    ppIndentL1(LOG4CXX_STR("  ")),
43
0
    ppIndentL2(LOG4CXX_STR("    ")),
44
0
    expectedPatternLength(100),
45
0
    threadInfo(false) {}
46
47
  // Print no location info by default
48
  bool locationInfo; //= false
49
  bool prettyPrint; //= false
50
51
  pattern::CachedDateFormat dateFormat
52
    { std::make_shared<helpers::SimpleDateFormat>(LOG4CXX_STR("yyyy-MM-dd HH:mm:ss,SSS"))
53
    , pattern::CachedDateFormat::getMaximumCacheValidity(LOG4CXX_STR("yyyy-MM-dd HH:mm:ss,SSS"))
54
    };
55
56
  LogString ppIndentL1;
57
  LogString ppIndentL2;
58
59
  // Expected length of a formatted event excluding the message text
60
  size_t expectedPatternLength;
61
62
  // Thread info is not included by default
63
  bool threadInfo; //= false
64
};
65
66
JSONLayout::JSONLayout() :
67
0
  m_priv(std::make_unique<JSONLayoutPrivate>())
68
0
{
69
0
}
Unexecuted instantiation: log4cxx::JSONLayout::JSONLayout()
Unexecuted instantiation: log4cxx::JSONLayout::JSONLayout()
70
71
0
JSONLayout::~JSONLayout(){}
72
73
void JSONLayout::setLocationInfo(bool locationInfoFlag)
74
0
{
75
0
  m_priv->locationInfo = locationInfoFlag;
76
0
}
77
78
bool JSONLayout::getLocationInfo() const
79
0
{
80
0
  return m_priv->locationInfo;
81
0
}
82
83
void JSONLayout::setPrettyPrint(bool prettyPrintFlag)
84
0
{
85
0
  m_priv->prettyPrint = prettyPrintFlag;
86
0
}
87
88
bool JSONLayout::getPrettyPrint() const
89
0
{
90
0
  return m_priv->prettyPrint;
91
0
}
92
93
void JSONLayout::setThreadInfo(bool newValue)
94
0
{
95
0
  m_priv->threadInfo = newValue;
96
0
}
97
98
bool JSONLayout::getThreadInfo() const
99
0
{
100
0
  return m_priv->threadInfo;
101
0
}
102
103
LogString JSONLayout::getContentType() const
104
0
{
105
0
  return LOG4CXX_STR("application/json");
106
0
}
107
108
void JSONLayout::activateOptions( LOG4CXX_ACTIVATE_OPTIONS_FORMAL_PARAMETERS )
109
0
{
110
0
  m_priv->expectedPatternLength = priv::doubledLayoutSize(getFormattedEventCharacterCount());
111
0
}
112
113
void JSONLayout::setOption(const LogString& option, const LogString& value)
114
0
{
115
0
  if (StringHelper::equalsIgnoreCase(option,
116
0
      LOG4CXX_STR("LOCATIONINFO"), LOG4CXX_STR("locationinfo")))
117
0
  {
118
0
    setLocationInfo(OptionConverter::toBoolean(value, false));
119
0
  }
120
0
  else if (StringHelper::equalsIgnoreCase(option,
121
0
      LOG4CXX_STR("THREADINFO"), LOG4CXX_STR("threadinfo")))
122
0
  {
123
0
    setThreadInfo(OptionConverter::toBoolean(value, false));
124
0
  }
125
0
  else if (StringHelper::equalsIgnoreCase(option,
126
0
      LOG4CXX_STR("PRETTYPRINT"), LOG4CXX_STR("prettyprint")))
127
0
  {
128
0
    setPrettyPrint(OptionConverter::toBoolean(value, false));
129
0
  }
130
0
}
131
132
void JSONLayout::format( LOG4CXX_FORMAT_LAYOUT_FORMAL_PARAMETERS ) const
133
0
{
134
0
  auto& lsMsg = event->getRenderedMessage();
135
0
  priv::reserveFormattedEvent(output, m_priv->expectedPatternLength, lsMsg.size());
136
0
  output.append(LOG4CXX_STR("{"));
137
0
  output.append(m_priv->prettyPrint ? LOG4CXX_EOL : LOG4CXX_STR(" "));
138
139
0
  if (m_priv->prettyPrint)
140
0
  {
141
0
    output.append(m_priv->ppIndentL1);
142
0
  }
143
144
0
  output.append(LOG4CXX_STR("\"timestamp\": \""));
145
0
  m_priv->dateFormat.format(output, event->getTimeStamp());
146
0
  output.append(LOG4CXX_STR("\","));
147
0
  output.append(m_priv->prettyPrint ? LOG4CXX_EOL : LOG4CXX_STR(" "));
148
149
0
  if (m_priv->threadInfo)
150
0
  {
151
0
    if (m_priv->prettyPrint)
152
0
    {
153
0
      output.append(m_priv->ppIndentL1);
154
0
    }
155
0
    appendQuotedEscapedString(output, LOG4CXX_STR("thread"));
156
0
    output.append(LOG4CXX_STR(": "));
157
0
    appendQuotedEscapedString(output, event->getThreadName());
158
0
    output.append(LOG4CXX_STR(","));
159
0
    output.append(m_priv->prettyPrint ? LOG4CXX_EOL : LOG4CXX_STR(" "));
160
0
  }
161
162
0
  if (m_priv->prettyPrint)
163
0
  {
164
0
    output.append(m_priv->ppIndentL1);
165
0
  }
166
167
0
  output.append(LOG4CXX_STR("\"level\": "));
168
0
  LogString level;
169
0
  event->getLevel()->toString(level);
170
0
  appendQuotedEscapedString(output, level);
171
0
  output.append(LOG4CXX_STR(","));
172
0
  output.append(m_priv->prettyPrint ? LOG4CXX_EOL : LOG4CXX_STR(" "));
173
174
0
  if (m_priv->prettyPrint)
175
0
  {
176
0
    output.append(m_priv->ppIndentL1);
177
0
  }
178
179
0
  output.append(LOG4CXX_STR("\"logger\": "));
180
0
  appendQuotedEscapedString(output, event->getLoggerName());
181
0
  output.append(LOG4CXX_STR(","));
182
0
  output.append(m_priv->prettyPrint ? LOG4CXX_EOL : LOG4CXX_STR(" "));
183
184
0
  if (m_priv->prettyPrint)
185
0
  {
186
0
    output.append(m_priv->ppIndentL1);
187
0
  }
188
189
0
  output.append(LOG4CXX_STR("\"message\": "));
190
0
  appendQuotedEscapedString(output, lsMsg);
191
192
0
  appendSerializedMDC(output, event);
193
0
  appendSerializedNDC(output, event);
194
195
0
  if (m_priv->locationInfo)
196
0
  {
197
0
    output.append(LOG4CXX_STR(","));
198
0
    output.append(m_priv->prettyPrint ? LOG4CXX_EOL : LOG4CXX_STR(" "));
199
0
    appendSerializedLocationInfo(output, event);
200
0
  }
201
202
0
  output.append(m_priv->prettyPrint ? LOG4CXX_EOL : LOG4CXX_STR(" "));
203
0
  output.append(LOG4CXX_STR("}"));
204
0
  output.append(LOG4CXX_EOL);
205
0
}
206
207
void JSONLayout::appendQuotedEscapedString(LogString& buf,
208
  const LogString& input) const
209
0
{
210
0
  appendItem(input, buf);
211
0
}
212
213
void JSONLayout::appendItem(const LogString& input, LogString& buf)
214
0
{
215
0
  auto toHexDigit = [](int ch) -> int
216
0
  {
217
0
    return (10 <= ch ? (0x61 - 10) : 0x30) + ch;
218
0
  };
219
  /* add leading quote */
220
0
  buf.push_back(0x22);
221
222
0
  auto start = input.begin();
223
0
  for (auto nextCodePoint = start; input.end() != nextCodePoint; )
224
0
  {
225
0
    auto lastCodePoint = nextCodePoint;
226
0
    auto ch = Transcoder::decode(input, nextCodePoint);
227
0
    if (nextCodePoint == lastCodePoint) // failed to decode input?
228
0
    {
229
0
      nextCodePoint = input.end();
230
0
      ch = 0xFFFD; // The Unicode replacement character
231
0
    }
232
0
    else if ((0xD800 <= ch && ch <= 0xDFFF) || 0x10FFFF < ch)
233
0
    {
234
0
      ch = 0xFFFD; // The Unicode replacement character
235
0
    }
236
0
    else if (0x22 == ch || 0x5c == ch) // double quote or backslash?
237
0
      ;
238
0
    else if (0x20 <= ch) // not a control character?
239
0
      continue;
240
241
0
    if (start != lastCodePoint)
242
0
      buf.append(start, lastCodePoint);
243
0
    start = nextCodePoint;
244
0
    switch (ch)
245
0
    {
246
0
      case 0x08:
247
        /* \b backspace */
248
0
        buf.push_back(0x5c);
249
0
        buf.push_back('b');
250
0
        break;
251
252
0
      case 0x09:
253
        /* \t tab */
254
0
        buf.push_back(0x5c);
255
0
        buf.push_back('t');
256
0
        break;
257
258
0
      case 0x0a:
259
        /* \n newline */
260
0
        buf.push_back(0x5c);
261
0
        buf.push_back('n');
262
0
        break;
263
264
0
      case 0x0c:
265
        /* \f form feed */
266
0
        buf.push_back(0x5c);
267
0
        buf.push_back('f');
268
0
        break;
269
270
0
      case 0x0d:
271
        /* \r carriage return */
272
0
        buf.push_back(0x5c);
273
0
        buf.push_back('r');
274
0
        break;
275
276
0
      case 0x22:
277
        /* \" double quote */
278
0
        buf.push_back(0x5c);
279
0
        buf.push_back(0x22);
280
0
        break;
281
282
0
      case 0x5c:
283
        /* \\ backslash */
284
0
        buf.push_back(0x5c);
285
0
        buf.push_back(0x5c);
286
0
        break;
287
288
0
      default:
289
0
        buf.push_back(0x5c);
290
0
        buf.push_back(0x75); // 'u'
291
0
        buf.push_back(toHexDigit((ch & 0xF000) >> 12));
292
0
        buf.push_back(toHexDigit((ch & 0xF00) >> 8));
293
0
        buf.push_back(toHexDigit((ch & 0xF0) >> 4));
294
0
        buf.push_back(toHexDigit(ch & 0xF));
295
0
        break;
296
0
    }
297
0
  }
298
0
  buf.append(start, input.end());
299
300
  /* add trailing quote */
301
0
  buf.push_back(0x22);
302
0
}
303
304
void JSONLayout::appendSerializedMDC(LogString& buf,
305
  const LoggingEventPtr& event) const
306
0
{
307
0
  LoggingEvent::KeySet keys = event->getMDCKeySet();
308
309
0
  if (keys.empty())
310
0
  {
311
0
    return;
312
0
  }
313
314
0
  buf.append(LOG4CXX_STR(","));
315
0
  buf.append(m_priv->prettyPrint ? LOG4CXX_EOL : LOG4CXX_STR(" "));
316
317
0
  if (m_priv->prettyPrint)
318
0
  {
319
0
    buf.append(m_priv->ppIndentL1);
320
0
  }
321
322
0
  appendQuotedEscapedString(buf, LOG4CXX_STR("context_map"));
323
0
  buf.append(LOG4CXX_STR(": {"));
324
0
  buf.append(m_priv->prettyPrint ? LOG4CXX_EOL : LOG4CXX_STR(" "));
325
326
0
  for (LoggingEvent::KeySet::iterator it = keys.begin();
327
0
    it != keys.end(); ++it)
328
0
  {
329
0
    if (m_priv->prettyPrint)
330
0
    {
331
0
      buf.append(m_priv->ppIndentL2);
332
0
    }
333
334
0
    appendQuotedEscapedString(buf, *it);
335
0
    buf.append(LOG4CXX_STR(": "));
336
0
    LogString value;
337
0
    event->getMDC(*it, value);
338
0
    appendQuotedEscapedString(buf, value);
339
340
    /* if this isn't the last k:v pair, we need a comma */
341
0
    if (it + 1 != keys.end())
342
0
    {
343
0
      buf.append(LOG4CXX_STR(","));
344
0
      buf.append(m_priv->prettyPrint ? LOG4CXX_EOL : LOG4CXX_STR(" "));
345
0
    }
346
0
    else
347
0
    {
348
0
      buf.append(m_priv->prettyPrint ? LOG4CXX_EOL : LOG4CXX_STR(" "));
349
0
    }
350
0
  }
351
352
0
  if (m_priv->prettyPrint)
353
0
  {
354
0
    buf.append(m_priv->ppIndentL1);
355
0
  }
356
357
0
  buf.append(LOG4CXX_STR("}"));
358
0
}
359
360
void JSONLayout::appendSerializedNDC(LogString& buf,
361
  const LoggingEventPtr& event) const
362
0
{
363
0
  LogString ndcVal;
364
365
0
  if (!event->getNDC(ndcVal))
366
0
  {
367
0
    return;
368
0
  }
369
370
0
  buf.append(LOG4CXX_STR(","));
371
0
  buf.append(m_priv->prettyPrint ? LOG4CXX_EOL : LOG4CXX_STR(" "));
372
373
0
  if (m_priv->prettyPrint)
374
0
  {
375
0
    buf.append(m_priv->ppIndentL1);
376
0
  }
377
378
0
  appendQuotedEscapedString(buf, LOG4CXX_STR("context_stack"));
379
0
  buf.append(LOG4CXX_STR(": ["));
380
0
  buf.append(m_priv->prettyPrint ? LOG4CXX_EOL : LOG4CXX_STR(" "));
381
382
0
  if (m_priv->prettyPrint)
383
0
  {
384
0
    buf.append(m_priv->ppIndentL2);
385
0
  }
386
387
0
  appendQuotedEscapedString(buf, ndcVal);
388
0
  buf.append(m_priv->prettyPrint ? LOG4CXX_EOL : LOG4CXX_STR(" "));
389
390
0
  if (m_priv->prettyPrint)
391
0
  {
392
0
    buf.append(m_priv->ppIndentL1);
393
0
  }
394
395
0
  buf.append(LOG4CXX_STR("]"));
396
0
}
397
398
void JSONLayout::appendSerializedLocationInfo(LogString& buf, const LoggingEventPtr& event) const
399
0
{
400
0
  if (m_priv->prettyPrint)
401
0
  {
402
0
    buf.append(m_priv->ppIndentL1);
403
0
  }
404
405
0
  appendQuotedEscapedString(buf, LOG4CXX_STR("location_info"));
406
0
  buf.append(LOG4CXX_STR(": {"));
407
0
  buf.append(m_priv->prettyPrint ? LOG4CXX_EOL : LOG4CXX_STR(" "));
408
0
  const LocationInfo& locInfo = event->getLocationInformation();
409
410
0
  if (m_priv->prettyPrint)
411
0
  {
412
0
    buf.append(m_priv->ppIndentL2);
413
0
  }
414
415
0
  appendQuotedEscapedString(buf, LOG4CXX_STR("file"));
416
0
  buf.append(LOG4CXX_STR(": "));
417
0
  LOG4CXX_DECODE_CHAR(fileName, locInfo.getFileName());
418
0
  appendQuotedEscapedString(buf, fileName);
419
0
  buf.append(LOG4CXX_STR(","));
420
0
  buf.append(m_priv->prettyPrint ? LOG4CXX_EOL : LOG4CXX_STR(" "));
421
422
0
  if (m_priv->prettyPrint)
423
0
  {
424
0
    buf.append(m_priv->ppIndentL2);
425
0
  }
426
427
0
  appendQuotedEscapedString(buf, LOG4CXX_STR("line"));
428
0
  buf.append(LOG4CXX_STR(": "));
429
0
  LogString lineNumber;
430
0
  StringHelper::toString(locInfo.getLineNumber(), lineNumber);
431
0
  appendQuotedEscapedString(buf, lineNumber);
432
0
  buf.append(LOG4CXX_STR(","));
433
0
  buf.append(m_priv->prettyPrint ? LOG4CXX_EOL : LOG4CXX_STR(" "));
434
435
0
  if (m_priv->prettyPrint)
436
0
  {
437
0
    buf.append(m_priv->ppIndentL2);
438
0
  }
439
440
0
  appendQuotedEscapedString(buf, LOG4CXX_STR("class"));
441
0
  buf.append(LOG4CXX_STR(": "));
442
0
  LOG4CXX_DECODE_CHAR(className, locInfo.getClassName());
443
0
  appendQuotedEscapedString(buf, className);
444
0
  buf.append(LOG4CXX_STR(","));
445
0
  buf.append(m_priv->prettyPrint ? LOG4CXX_EOL : LOG4CXX_STR(" "));
446
447
0
  if (m_priv->prettyPrint)
448
0
  {
449
0
    buf.append(m_priv->ppIndentL2);
450
0
  }
451
452
0
  appendQuotedEscapedString(buf, LOG4CXX_STR("method"));
453
0
  buf.append(LOG4CXX_STR(": "));
454
0
  LOG4CXX_DECODE_CHAR(methodName, locInfo.getMethodName());
455
0
  appendQuotedEscapedString(buf, methodName);
456
0
  buf.append(m_priv->prettyPrint ? LOG4CXX_EOL : LOG4CXX_STR(" "));
457
458
0
  if (m_priv->prettyPrint)
459
0
  {
460
0
    buf.append(m_priv->ppIndentL1);
461
0
  }
462
463
0
  buf.append(LOG4CXX_STR("}"));
464
0
}
465
466
#if LOG4CXX_ABI_VERSION <= 15
467
void JSONLayout::appendSerializedLocationInfo(LogString& buf,
468
  const LoggingEventPtr& event, Pool& p) const
469
0
{
470
0
  appendSerializedLocationInfo(buf, event);
471
0
}
472
#endif