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
|
/* -*- 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 "methodguard.hxx"
#include "loghandler.hxx"
#include <com/sun/star/logging/XLogHandler.hpp>
#include <com/sun/star/lang/XServiceInfo.hpp>
#include <com/sun/star/lang/IllegalArgumentException.hpp>
#include <com/sun/star/util/PathSubstitution.hpp>
#include <com/sun/star/util/XStringSubstitution.hpp>
#include <tools/diagnose_ex.h>
#include <cppuhelper/compbase.hxx>
#include <cppuhelper/basemutex.hxx>
#include <cppuhelper/supportsservice.hxx>
#include <osl/thread.h>
#include <osl/file.hxx>
#include <rtl/strbuf.hxx>
#include <memory>
namespace logging
{
using ::com::sun::star::uno::Reference;
using ::com::sun::star::logging::LogRecord;
using ::com::sun::star::uno::RuntimeException;
using ::com::sun::star::logging::XLogFormatter;
using ::com::sun::star::uno::Sequence;
using ::com::sun::star::uno::XInterface;
using ::com::sun::star::uno::XComponentContext;
using ::com::sun::star::logging::XLogHandler;
using ::com::sun::star::lang::XServiceInfo;
using ::com::sun::star::uno::Exception;
using ::com::sun::star::lang::IllegalArgumentException;
using ::com::sun::star::util::PathSubstitution;
using ::com::sun::star::util::XStringSubstitution;
using ::com::sun::star::beans::NamedValue;
typedef ::cppu::WeakComponentImplHelper < XLogHandler
, XServiceInfo
> FileHandler_Base;
class FileHandler :public ::cppu::BaseMutex
,public FileHandler_Base
{
private:
enum FileValidity
{
/// never attempted to open the file
eUnknown,
/// file is valid
eValid,
/// file is invalid
eInvalid
};
Reference<XComponentContext> m_xContext;
LogHandlerHelper m_aHandlerHelper;
OUString m_sFileURL;
std::unique_ptr< ::osl::File > m_pFile;
FileValidity m_eFileValidity;
public:
FileHandler(const css::uno::Reference<XComponentContext> &context,
const css::uno::Sequence<css::uno::Any> &arguments);
virtual ~FileHandler() override;
private:
// XLogHandler
virtual OUString SAL_CALL getEncoding() override;
virtual void SAL_CALL setEncoding( const OUString& _encoding ) override;
virtual Reference< XLogFormatter > SAL_CALL getFormatter() override;
virtual void SAL_CALL setFormatter( const Reference< XLogFormatter >& _formatter ) override;
virtual ::sal_Int32 SAL_CALL getLevel() override;
virtual void SAL_CALL setLevel( ::sal_Int32 _level ) override;
virtual void SAL_CALL flush( ) override;
virtual sal_Bool SAL_CALL publish( const LogRecord& Record ) override;
// XServiceInfo
virtual OUString SAL_CALL getImplementationName() override;
virtual sal_Bool SAL_CALL supportsService( const OUString& _rServiceName ) override;
virtual Sequence< OUString > SAL_CALL getSupportedServiceNames() override;
// OComponentHelper
virtual void SAL_CALL disposing() override;
public:
typedef ComponentMethodGuard< FileHandler > MethodGuard;
void enterMethod( MethodGuard::Access );
void leaveMethod( MethodGuard::Access );
private:
/** prepares our output file for writing
*/
bool impl_prepareFile_nothrow();
/// writes the given string to our file
void impl_writeString_nothrow( const OString& _rEntry );
/** does string substitution on a (usually externally provided) file url
*/
void impl_doStringsubstitution_nothrow( OUString& _inout_rURL );
};
FileHandler::FileHandler(const css::uno::Reference<XComponentContext> &context,
const css::uno::Sequence<css::uno::Any> &arguments)
:FileHandler_Base( m_aMutex )
,m_xContext( context )
,m_aHandlerHelper( context, m_aMutex, rBHelper )
,m_sFileURL( )
,m_pFile( )
,m_eFileValidity( eUnknown )
{
::osl::MutexGuard aGuard( m_aMutex );
if ( arguments.getLength() != 1 )
throw IllegalArgumentException( OUString(), *this, 1 );
Sequence< NamedValue > aSettings;
if ( arguments[0] >>= m_sFileURL )
{
// create( [in] string URL );
impl_doStringsubstitution_nothrow( m_sFileURL );
}
else if ( arguments[0] >>= aSettings )
{
// createWithSettings( [in] sequence< css::beans::NamedValue > Settings )
::comphelper::NamedValueCollection aTypedSettings( aSettings );
m_aHandlerHelper.initFromSettings( aTypedSettings );
if ( aTypedSettings.get_ensureType( "FileURL", m_sFileURL ) )
impl_doStringsubstitution_nothrow( m_sFileURL );
}
else
throw IllegalArgumentException( OUString(), *this, 1 );
m_aHandlerHelper.setIsInitialized();
}
FileHandler::~FileHandler()
{
if ( !rBHelper.bDisposed )
{
acquire();
dispose();
}
}
bool FileHandler::impl_prepareFile_nothrow()
{
if ( m_eFileValidity == eUnknown )
{
m_pFile.reset( new ::osl::File( m_sFileURL ) );
// check whether the log file already exists
::osl::DirectoryItem aFileItem;
::osl::DirectoryItem::get( m_sFileURL, aFileItem );
::osl::FileStatus aStatus( osl_FileStatus_Mask_Validate );
if ( ::osl::FileBase::E_None == aFileItem.getFileStatus( aStatus ) )
::osl::File::remove( m_sFileURL );
::osl::FileBase::RC res = m_pFile->open( osl_File_OpenFlag_Write | osl_File_OpenFlag_Create );
m_eFileValidity = res == ::osl::FileBase::E_None
? eValid
: eInvalid;
#if OSL_DEBUG_LEVEL > 0
if ( m_eFileValidity == eInvalid )
{
SAL_WARN( "extensions.logging", "FileHandler::impl_prepareFile_nothrow: could not open the designated log file:"
"\nURL: " << m_sFileURL
<< "\nerror code: " << (sal_Int32)res );
}
#endif
if ( m_eFileValidity == eValid )
{
OString sHead;
if ( m_aHandlerHelper.getEncodedHead( sHead ) )
impl_writeString_nothrow( sHead );
}
}
return m_eFileValidity == eValid;
}
void FileHandler::impl_writeString_nothrow( const OString& _rEntry )
{
OSL_PRECOND( m_pFile.get(), "FileHandler::impl_writeString_nothrow: no file!" );
sal_uInt64 nBytesToWrite( _rEntry.getLength() );
sal_uInt64 nBytesWritten( 0 );
::osl::FileBase::RC res =
m_pFile->write( _rEntry.getStr(), nBytesToWrite, nBytesWritten );
OSL_ENSURE( ( res == ::osl::FileBase::E_None ) && ( nBytesWritten == nBytesToWrite ),
"FileHandler::impl_writeString_nothrow: could not write the log entry!" );
}
void FileHandler::impl_doStringsubstitution_nothrow( OUString& _inout_rURL )
{
try
{
Reference< XStringSubstitution > xStringSubst(PathSubstitution::create(m_xContext));
_inout_rURL = xStringSubst->substituteVariables( _inout_rURL, true );
}
catch( const Exception& )
{
DBG_UNHANDLED_EXCEPTION();
}
}
void SAL_CALL FileHandler::disposing()
{
if ( m_eFileValidity == eValid )
{
OString sTail;
if ( m_aHandlerHelper.getEncodedTail( sTail ) )
impl_writeString_nothrow( sTail );
}
m_pFile.reset();
m_aHandlerHelper.setFormatter( nullptr );
}
void FileHandler::enterMethod( MethodGuard::Access )
{
m_aHandlerHelper.enterMethod();
}
void FileHandler::leaveMethod( MethodGuard::Access )
{
m_aMutex.release();
}
OUString SAL_CALL FileHandler::getEncoding()
{
MethodGuard aGuard( *this );
OUString sEncoding;
OSL_VERIFY( m_aHandlerHelper.getEncoding( sEncoding ) );
return sEncoding;
}
void SAL_CALL FileHandler::setEncoding( const OUString& _rEncoding )
{
MethodGuard aGuard( *this );
OSL_VERIFY( m_aHandlerHelper.setEncoding( _rEncoding ) );
}
Reference< XLogFormatter > SAL_CALL FileHandler::getFormatter()
{
MethodGuard aGuard( *this );
return m_aHandlerHelper.getFormatter();
}
void SAL_CALL FileHandler::setFormatter( const Reference< XLogFormatter >& _rxFormatter )
{
MethodGuard aGuard( *this );
m_aHandlerHelper.setFormatter( _rxFormatter );
}
::sal_Int32 SAL_CALL FileHandler::getLevel()
{
MethodGuard aGuard( *this );
return m_aHandlerHelper.getLevel();
}
void SAL_CALL FileHandler::setLevel( ::sal_Int32 _nLevel )
{
MethodGuard aGuard( *this );
m_aHandlerHelper.setLevel( _nLevel );
}
void SAL_CALL FileHandler::flush( )
{
MethodGuard aGuard( *this );
if(!m_pFile.get())
{
OSL_PRECOND(false, "FileHandler::flush: no file!");
return;
}
::osl::FileBase::RC res = m_pFile->sync();
OSL_ENSURE(res == ::osl::FileBase::E_None, "FileHandler::flush: Could not sync logfile to filesystem.");
}
sal_Bool SAL_CALL FileHandler::publish( const LogRecord& _rRecord )
{
MethodGuard aGuard( *this );
if ( !impl_prepareFile_nothrow() )
return false;
OString sEntry;
if ( !m_aHandlerHelper.formatForPublishing( _rRecord, sEntry ) )
return false;
impl_writeString_nothrow( sEntry );
return true;
}
OUString SAL_CALL FileHandler::getImplementationName()
{
return OUString("com.sun.star.comp.extensions.FileHandler");
}
sal_Bool SAL_CALL FileHandler::supportsService( const OUString& _rServiceName )
{
return cppu::supportsService(this, _rServiceName);
}
Sequence< OUString > SAL_CALL FileHandler::getSupportedServiceNames()
{
return { "com.sun.star.logging.FileHandler" };
}
} // namespace logging
extern "C" SAL_DLLPUBLIC_EXPORT css::uno::XInterface *
com_sun_star_comp_extensions_FileHandler(
css::uno::XComponentContext *context,
css::uno::Sequence<css::uno::Any> const &arguments)
{
return cppu::acquire(new logging::FileHandler(context, arguments));
}
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
|
