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
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
|
/*************************************************************************
*
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
*
* Copyright 2008 by Sun Microsystems, Inc.
*
* OpenOffice.org - a multi-platform office productivity suite
*
* $RCSfile: filehandler.cxx,v $
* $Revision: 1.3 $
*
* This file is part of OpenOffice.org.
*
* OpenOffice.org is free software: you can redistribute it and/or modify
* it under the terms of the GNU Lesser General Public License version 3
* only, as published by the Free Software Foundation.
*
* OpenOffice.org is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Lesser General Public License version 3 for more details
* (a copy is included in the LICENSE file that accompanied this code).
*
* You should have received a copy of the GNU Lesser General Public License
* version 3 along with OpenOffice.org. If not, see
* <http://www.openoffice.org/license.html>
* for a copy of the LGPLv3 License.
*
************************************************************************/
// MARKER(update_precomp.py): autogen include statement, do not remove
#include "precompiled_extensions.hxx"
#include "log_module.hxx"
#include "methodguard.hxx"
#include "loghandler.hxx"
/** === begin UNO includes === **/
#include <com/sun/star/logging/XLogHandler.hpp>
#include <com/sun/star/lang/XServiceInfo.hpp>
#include <com/sun/star/ucb/AlreadyInitializedException.hpp>
#include <com/sun/star/lang/XInitialization.hpp>
#include <com/sun/star/lang/IllegalArgumentException.hpp>
#include <com/sun/star/util/XStringSubstitution.hpp>
/** === end UNO includes === **/
#include <tools/diagnose_ex.h>
#include <comphelper/componentcontext.hxx>
#include <cppuhelper/compbase3.hxx>
#include <cppuhelper/basemutex.hxx>
#include <osl/thread.h>
#include <osl/file.hxx>
#include <rtl/strbuf.hxx>
#include <memory>
//........................................................................
namespace logging
{
//........................................................................
/** === begin UNO using === **/
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::ucb::AlreadyInitializedException;
using ::com::sun::star::lang::XInitialization;
using ::com::sun::star::uno::Any;
using ::com::sun::star::uno::Exception;
using ::com::sun::star::lang::IllegalArgumentException;
using ::com::sun::star::uno::UNO_QUERY_THROW;
using ::com::sun::star::util::XStringSubstitution;
using ::com::sun::star::beans::NamedValue;
/** === end UNO using === **/
//====================================================================
//= FileHandler - declaration
//====================================================================
typedef ::cppu::WeakComponentImplHelper3 < XLogHandler
, XServiceInfo
, XInitialization
> 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
};
private:
::comphelper::ComponentContext m_aContext;
LogHandlerHelper m_aHandlerHelper;
::rtl::OUString m_sFileURL;
::std::auto_ptr< ::osl::File > m_pFile;
FileValidity m_eFileValidity;
protected:
FileHandler( const Reference< XComponentContext >& _rxContext );
virtual ~FileHandler();
// XLogHandler
virtual ::rtl::OUString SAL_CALL getEncoding() throw (RuntimeException);
virtual void SAL_CALL setEncoding( const ::rtl::OUString& _encoding ) throw (RuntimeException);
virtual Reference< XLogFormatter > SAL_CALL getFormatter() throw (RuntimeException);
virtual void SAL_CALL setFormatter( const Reference< XLogFormatter >& _formatter ) throw (RuntimeException);
virtual ::sal_Int32 SAL_CALL getLevel() throw (RuntimeException);
virtual void SAL_CALL setLevel( ::sal_Int32 _level ) throw (RuntimeException);
virtual void SAL_CALL flush( ) throw (RuntimeException);
virtual ::sal_Bool SAL_CALL publish( const LogRecord& Record ) throw (RuntimeException);
// XInitialization
virtual void SAL_CALL initialize( const ::com::sun::star::uno::Sequence< ::com::sun::star::uno::Any >& aArguments ) throw (::com::sun::star::uno::Exception, ::com::sun::star::uno::RuntimeException);
// XServiceInfo
virtual ::rtl::OUString SAL_CALL getImplementationName() throw(RuntimeException);
virtual ::sal_Bool SAL_CALL supportsService( const ::rtl::OUString& _rServiceName ) throw(RuntimeException);
virtual Sequence< ::rtl::OUString > SAL_CALL getSupportedServiceNames() throw(RuntimeException);
// OComponentHelper
virtual void SAL_CALL disposing();
public:
// XServiceInfo - static version
static ::rtl::OUString SAL_CALL getImplementationName_static();
static Sequence< ::rtl::OUString > SAL_CALL getSupportedServiceNames_static();
static Reference< XInterface > Create( const Reference< XComponentContext >& _rxContext );
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 ::rtl::OString& _rEntry );
/** does string substitution on a (usually externally provided) file url
*/
void impl_doStringsubstitution_nothrow( ::rtl::OUString& _inout_rURL );
};
//====================================================================
//= FileHandler - implementation
//====================================================================
//--------------------------------------------------------------------
FileHandler::FileHandler( const Reference< XComponentContext >& _rxContext )
:FileHandler_Base( m_aMutex )
,m_aContext( _rxContext )
,m_aHandlerHelper( _rxContext, m_aMutex, rBHelper )
,m_sFileURL( )
,m_pFile( )
,m_eFileValidity( eUnknown )
{
}
//--------------------------------------------------------------------
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( FileStatusMask_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 )
{
::rtl::OStringBuffer sMessage;
sMessage.append( "FileHandler::impl_prepareFile_nothrow: could not open the designated log file:" );
sMessage.append( "\nURL: " );
sMessage.append( ::rtl::OString( m_sFileURL.getStr(), m_sFileURL.getLength(), osl_getThreadTextEncoding() ) );
sMessage.append( "\nerror code: " );
sMessage.append( (sal_Int32)res );
OSL_ENSURE( false, sMessage.makeStringAndClear() );
}
#endif
if ( m_eFileValidity == eValid )
{
::rtl::OString sHead;
if ( m_aHandlerHelper.getEncodedHead( sHead ) )
impl_writeString_nothrow( sHead );
}
}
return m_eFileValidity == eValid;
}
//--------------------------------------------------------------------
void FileHandler::impl_writeString_nothrow( const ::rtl::OString& _rEntry )
{
OSL_PRECOND( m_pFile.get(), "FileHandler::impl_writeString_nothrow: no file!" );
sal_uInt64 nBytesToWrite( _rEntry.getLength() );
sal_uInt64 nBytesWritten( 0 );
#if OSL_DEBUG_LEVEL > 0
::osl::FileBase::RC res =
#endif
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( ::rtl::OUString& _inout_rURL )
{
try
{
Reference< XStringSubstitution > xStringSubst;
if ( m_aContext.createComponent( "com.sun.star.util.PathSubstitution", xStringSubst ) )
_inout_rURL = xStringSubst->substituteVariables( _inout_rURL, true );
}
catch( const Exception& )
{
DBG_UNHANDLED_EXCEPTION();
}
}
//--------------------------------------------------------------------
void SAL_CALL FileHandler::disposing()
{
if ( m_eFileValidity == eValid )
{
::rtl::OString sTail;
if ( m_aHandlerHelper.getEncodedTail( sTail ) )
impl_writeString_nothrow( sTail );
}
m_pFile.reset( NULL );
m_aHandlerHelper.setFormatter( NULL );
}
//--------------------------------------------------------------------
void FileHandler::enterMethod( MethodGuard::Access )
{
m_aHandlerHelper.enterMethod();
}
//--------------------------------------------------------------------
void FileHandler::leaveMethod( MethodGuard::Access )
{
m_aMutex.release();
}
//--------------------------------------------------------------------
::rtl::OUString SAL_CALL FileHandler::getEncoding() throw (RuntimeException)
{
MethodGuard aGuard( *this );
::rtl::OUString sEncoding;
OSL_VERIFY( m_aHandlerHelper.getEncoding( sEncoding ) );
return sEncoding;
}
//--------------------------------------------------------------------
void SAL_CALL FileHandler::setEncoding( const ::rtl::OUString& _rEncoding ) throw (RuntimeException)
{
MethodGuard aGuard( *this );
OSL_VERIFY( m_aHandlerHelper.setEncoding( _rEncoding ) );
}
//--------------------------------------------------------------------
Reference< XLogFormatter > SAL_CALL FileHandler::getFormatter() throw (RuntimeException)
{
MethodGuard aGuard( *this );
return m_aHandlerHelper.getFormatter();
}
//--------------------------------------------------------------------
void SAL_CALL FileHandler::setFormatter( const Reference< XLogFormatter >& _rxFormatter ) throw (RuntimeException)
{
MethodGuard aGuard( *this );
m_aHandlerHelper.setFormatter( _rxFormatter );
}
//--------------------------------------------------------------------
::sal_Int32 SAL_CALL FileHandler::getLevel() throw (RuntimeException)
{
MethodGuard aGuard( *this );
return m_aHandlerHelper.getLevel();
}
//--------------------------------------------------------------------
void SAL_CALL FileHandler::setLevel( ::sal_Int32 _nLevel ) throw (RuntimeException)
{
MethodGuard aGuard( *this );
m_aHandlerHelper.setLevel( _nLevel );
}
//--------------------------------------------------------------------
void SAL_CALL FileHandler::flush( ) throw (RuntimeException)
{
MethodGuard aGuard( *this );
if(!m_pFile.get())
{
OSL_PRECOND(false, "FileHandler::flush: no file!");
return;
}
#if OSL_DEBUG_LEVEL > 0
::osl::FileBase::RC res =
#endif
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 ) throw (RuntimeException)
{
MethodGuard aGuard( *this );
if ( !impl_prepareFile_nothrow() )
return sal_False;
::rtl::OString sEntry;
if ( !m_aHandlerHelper.formatForPublishing( _rRecord, sEntry ) )
return sal_False;
impl_writeString_nothrow( sEntry );
return sal_True;
}
//--------------------------------------------------------------------
void SAL_CALL FileHandler::initialize( const Sequence< Any >& _rArguments ) throw (Exception, RuntimeException)
{
::osl::MutexGuard aGuard( m_aMutex );
if ( m_aHandlerHelper.getIsInitialized() )
throw AlreadyInitializedException();
if ( _rArguments.getLength() != 1 )
throw IllegalArgumentException( ::rtl::OUString(), *this, 1 );
Sequence< NamedValue > aSettings;
if ( _rArguments[0] >>= m_sFileURL )
{
// create( [in] string URL );
impl_doStringsubstitution_nothrow( m_sFileURL );
}
else if ( _rArguments[0] >>= aSettings )
{
// createWithSettings( [in] sequence< ::com::sun::star::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( ::rtl::OUString(), *this, 1 );
m_aHandlerHelper.setIsInitialized();
}
//--------------------------------------------------------------------
::rtl::OUString SAL_CALL FileHandler::getImplementationName() throw(RuntimeException)
{
return getImplementationName_static();
}
//--------------------------------------------------------------------
::sal_Bool SAL_CALL FileHandler::supportsService( const ::rtl::OUString& _rServiceName ) throw(RuntimeException)
{
const Sequence< ::rtl::OUString > aServiceNames( getSupportedServiceNames() );
for ( const ::rtl::OUString* pServiceNames = aServiceNames.getConstArray();
pServiceNames != aServiceNames.getConstArray() + aServiceNames.getLength();
++pServiceNames
)
if ( _rServiceName == *pServiceNames )
return sal_True;
return sal_False;
}
//--------------------------------------------------------------------
Sequence< ::rtl::OUString > SAL_CALL FileHandler::getSupportedServiceNames() throw(RuntimeException)
{
return getSupportedServiceNames_static();
}
//--------------------------------------------------------------------
::rtl::OUString SAL_CALL FileHandler::getImplementationName_static()
{
return ::rtl::OUString( RTL_CONSTASCII_USTRINGPARAM( "com.sun.star.comp.extensions.FileHandler" ) );
}
//--------------------------------------------------------------------
Sequence< ::rtl::OUString > SAL_CALL FileHandler::getSupportedServiceNames_static()
{
Sequence< ::rtl::OUString > aServiceNames(1);
aServiceNames[0] = ::rtl::OUString( RTL_CONSTASCII_USTRINGPARAM( "com.sun.star.logging.FileHandler" ) );
return aServiceNames;
}
//--------------------------------------------------------------------
Reference< XInterface > FileHandler::Create( const Reference< XComponentContext >& _rxContext )
{
return *( new FileHandler( _rxContext ) );
}
//--------------------------------------------------------------------
void createRegistryInfo_FileHandler()
{
static OAutoRegistration< FileHandler > aAutoRegistration;
}
//........................................................................
} // namespace logging
//........................................................................
|
