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 | /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
/*
* This file is part of the LibreOffice project.
*
* This Source Code Form is subject to the terms of the Mozilla Public
* License, v. 2.0. If a copy of the MPL was not distributed with this
* file, You can obtain one at http://mozilla.org/MPL/2.0/.
*
* This file incorporates work covered by the following license notice:
*
* Licensed to the Apache Software Foundation (ASF) under one or more
* contributor license agreements. See the NOTICE file distributed
* with this work for additional information regarding copyright
* ownership. The ASF licenses this file to you under the Apache
* License, Version 2.0 (the "License"); you may not use this file
* except in compliance with the License. You may obtain a copy of
* the License at http://www.apache.org/licenses/LICENSE-2.0 .
*/
#include <sal/config.h>
#include <com/sun/star/logging/XCsvLogFormatter.hpp>
#include <com/sun/star/uno/XComponentContext.hpp>
#include <com/sun/star/lang/XServiceInfo.hpp>
#include <com/sun/star/lang/IllegalArgumentException.hpp>
#include <cppuhelper/implbase.hxx>
#include <cppuhelper/supportsservice.hxx>
#include <rtl/ustrbuf.hxx>
#include <stdio.h>
namespace logging
{
using ::com::sun::star::uno::Sequence;
using ::com::sun::star::logging::LogRecord;
namespace {
// formats for csv files as defined by RFC4180
class CsvFormatter : public cppu::WeakImplHelper<css::logging::XCsvLogFormatter, css::lang::XServiceInfo>
{
public:
virtual OUString SAL_CALL formatMultiColumn(const Sequence< OUString>& column_data) override;
CsvFormatter();
private:
// XCsvLogFormatter
virtual sal_Bool SAL_CALL getLogEventNo() override;
virtual sal_Bool SAL_CALL getLogThread() override;
virtual sal_Bool SAL_CALL getLogTimestamp() override;
virtual sal_Bool SAL_CALL getLogSource() override;
virtual Sequence< OUString > SAL_CALL getColumnnames() override;
virtual void SAL_CALL setLogEventNo( sal_Bool log_event_no ) override;
virtual void SAL_CALL setLogThread( sal_Bool log_thread ) override;
virtual void SAL_CALL setLogTimestamp( sal_Bool log_timestamp ) override;
virtual void SAL_CALL setLogSource( sal_Bool log_source ) override;
virtual void SAL_CALL setColumnnames( const Sequence< OUString>& column_names) override;
// XLogFormatter
virtual OUString SAL_CALL getHead( ) override;
virtual OUString SAL_CALL format( const LogRecord& Record ) override;
virtual OUString SAL_CALL getTail( ) override;
// XServiceInfo
virtual OUString SAL_CALL getImplementationName() override;
virtual sal_Bool SAL_CALL supportsService( const OUString& service_name ) override;
virtual Sequence< OUString > SAL_CALL getSupportedServiceNames() override;
private:
bool m_LogEventNo;
bool m_LogThread;
bool m_LogTimestamp;
bool m_LogSource;
bool m_MultiColumn;
css::uno::Sequence< OUString > m_Columnnames;
};
}
} // namespace logging
// private helpers
namespace
{
const sal_Unicode quote_char = '"';
const sal_Unicode comma_char = ',';
const OUString dos_newline = "\r\n";
bool needsQuoting(const OUString& str)
{
static const OUString quote_trigger_chars = "\",\n\r";
sal_Int32 len = str.getLength();
for(sal_Int32 i=0; i<len; i++)
if(quote_trigger_chars.indexOf(str[i])!=-1)
return true;
return false;
};
void appendEncodedString(OUStringBuffer& buf, const OUString& str)
{
if(needsQuoting(str))
{
// each double-quote will get replaced by two double-quotes
buf.append(quote_char);
const sal_Int32 buf_offset = buf.getLength();
const sal_Int32 str_length = str.getLength();
buf.append(str);
// special treatment for the last character
if(quote_char==str[str_length-1])
buf.append(quote_char);
// iterating backwards because the index at which we insert won't be shifted
// when moving that way.
for(sal_Int32 i = str_length; i>=0; )
{
i=str.lastIndexOf(quote_char, --i);
if(i!=-1)
buf.insert(buf_offset + i, quote_char);
}
buf.append(quote_char);
}
else
buf.append(str);
};
}
namespace logging
{
CsvFormatter::CsvFormatter()
:m_LogEventNo(true),
m_LogThread(true),
m_LogTimestamp(true),
m_LogSource(false),
m_MultiColumn(false),
m_Columnnames({ "message" })
{ }
sal_Bool CsvFormatter::getLogEventNo()
{
return m_LogEventNo;
}
sal_Bool CsvFormatter::getLogThread()
{
return m_LogThread;
}
sal_Bool CsvFormatter::getLogTimestamp()
{
return m_LogTimestamp;
}
sal_Bool CsvFormatter::getLogSource()
{
return m_LogSource;
}
Sequence< OUString > CsvFormatter::getColumnnames()
{
return m_Columnnames;
}
void CsvFormatter::setLogEventNo(sal_Bool log_event_no)
{
m_LogEventNo = log_event_no;
}
void CsvFormatter::setLogThread(sal_Bool log_thread)
{
m_LogThread = log_thread;
}
void CsvFormatter::setLogTimestamp(sal_Bool log_timestamp)
{
m_LogTimestamp = log_timestamp;
}
void CsvFormatter::setLogSource(sal_Bool log_source)
{
m_LogSource = log_source;
}
void CsvFormatter::setColumnnames(const Sequence< OUString >& columnnames)
{
m_Columnnames = columnnames;
m_MultiColumn = (m_Columnnames.getLength()>1);
}
OUString SAL_CALL CsvFormatter::getHead( )
{
OUStringBuffer buf;
if(m_LogEventNo)
buf.append("event no,");
if(m_LogThread)
buf.append("thread,");
if(m_LogTimestamp)
buf.append("timestamp,");
if(m_LogSource)
buf.append("class,method,");
sal_Int32 columns = m_Columnnames.getLength();
for(sal_Int32 i=0; i<columns; i++)
{
buf.append(m_Columnnames[i]);
buf.append(comma_char);
}
buf.setLength(buf.getLength()-1);
buf.append(dos_newline);
return buf.makeStringAndClear();
}
OUString SAL_CALL CsvFormatter::format( const LogRecord& record )
{
OUStringBuffer aLogEntry;
if(m_LogEventNo)
{
aLogEntry.append( record.SequenceNumber );
aLogEntry.append(comma_char);
}
if(m_LogThread)
{
aLogEntry.append( record.ThreadID );
aLogEntry.append(comma_char);
}
if(m_LogTimestamp)
{
if ( record.LogTime.Year < -9999 || 9999 < record.LogTime.Year
|| record.LogTime.Month < 1 || 12 < record.LogTime.Month
|| record.LogTime.Day < 1 || 31 < record.LogTime.Day
|| 24 < record.LogTime.Hours
|| 60 < record.LogTime.Minutes
|| 60 < record.LogTime.Seconds
|| 999999999 < record.LogTime.NanoSeconds)
{
throw css::lang::IllegalArgumentException("invalid date", static_cast<cppu::OWeakObject*>(this), 1);
}
// ISO 8601
char buffer[ 31 ];
const size_t buffer_size = sizeof( buffer );
snprintf( buffer, buffer_size, "%04i-%02i-%02iT%02i:%02i:%02i.%09i",
static_cast<int>(record.LogTime.Year),
static_cast<int>(record.LogTime.Month),
static_cast<int>(record.LogTime.Day),
static_cast<int>(record.LogTime.Hours),
static_cast<int>(record.LogTime.Minutes),
static_cast<int>(record.LogTime.Seconds),
static_cast<int>(record.LogTime.NanoSeconds) );
aLogEntry.appendAscii( buffer );
aLogEntry.append(comma_char);
}
if(m_LogSource)
{
appendEncodedString(aLogEntry, record.SourceClassName);
aLogEntry.append(comma_char);
appendEncodedString(aLogEntry, record.SourceMethodName);
aLogEntry.append(comma_char);
}
// if the CsvFormatter has multiple columns set via setColumnnames(), the
// message of the record is expected to be encoded with formatMultiColumn
// if the CsvFormatter has only one column set, the message is expected not
// to be encoded
if(m_MultiColumn)
aLogEntry.append(record.Message);
else
appendEncodedString(aLogEntry, record.Message);
aLogEntry.append( dos_newline );
return aLogEntry.makeStringAndClear();
}
OUString SAL_CALL CsvFormatter::getTail( )
{
return OUString();
}
OUString SAL_CALL CsvFormatter::formatMultiColumn(const Sequence< OUString>& column_data)
{
sal_Int32 columns = column_data.getLength();
OUStringBuffer buf;
for(int i=0; i<columns; i++)
{
appendEncodedString(buf, column_data[i]);
buf.append(comma_char);
}
buf.setLength(buf.getLength()-1);
return buf.makeStringAndClear();
}
sal_Bool SAL_CALL CsvFormatter::supportsService( const OUString& service_name )
{
return cppu::supportsService(this, service_name);
}
OUString SAL_CALL CsvFormatter::getImplementationName()
{
return "com.sun.star.comp.extensions.CsvFormatter";
}
Sequence< OUString > SAL_CALL CsvFormatter::getSupportedServiceNames()
{
return { "com.sun.star.logging.CsvFormatter" };
}
} // namespace logging
extern "C" SAL_DLLPUBLIC_EXPORT css::uno::XInterface *
com_sun_star_comp_extensions_CsvFormatter(<--- The function 'com_sun_star_comp_extensions_CsvFormatter' is never used.
css::uno::XComponentContext *,
css::uno::Sequence<css::uno::Any> const &)
{
return cppu::acquire(new logging::CsvFormatter());
}
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
|