extensions/source/logging/consolehandler.cxx

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2008 by Sun Microsystems, Inc.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * $RCSfile: consolehandler.cxx,v $
  10  * $Revision: 1.3 $
  11  *
  12  * This file is part of OpenOffice.org.
  13  *
  14  * OpenOffice.org is free software: you can redistribute it and/or modify
  15  * it under the terms of the GNU Lesser General Public License version 3
  16  * only, as published by the Free Software Foundation.
  17  *
  18  * OpenOffice.org is distributed in the hope that it will be useful,
  19  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  20  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  21  * GNU Lesser General Public License version 3 for more details
  22  * (a copy is included in the LICENSE file that accompanied this code).
  23  *
  24  * You should have received a copy of the GNU Lesser General Public License
  25  * version 3 along with OpenOffice.org.  If not, see
  26  * <http://www.openoffice.org/license.html>
  27  * for a copy of the LGPLv3 License.
  28  *
  29  ************************************************************************/
  30
  31 // MARKER(update_precomp.py): autogen include statement, do not remove
  32 #include "precompiled_extensions.hxx"
  33
  34 #include "log_module.hxx"
  35 #include "methodguard.hxx"
  36 #include "loghandler.hxx"
  37
  38 /** === begin UNO includes === **/
  39 #include <com/sun/star/logging/XConsoleHandler.hpp>
  40 #include <com/sun/star/lang/XServiceInfo.hpp>
  41 #include <com/sun/star/logging/LogLevel.hpp>
  42 #include <com/sun/star/lang/XInitialization.hpp>
  43 #include <com/sun/star/ucb/AlreadyInitializedException.hpp>
  44 #include <com/sun/star/lang/IllegalArgumentException.hpp>
  45 #include <com/sun/star/beans/NamedValue.hpp>
  46 /** === end UNO includes === **/
  47
  48 #include <tools/diagnose_ex.h>
  49
  50 #include <comphelper/componentcontext.hxx>
  51
  52 #include <cppuhelper/compbase3.hxx>
  53 #include <cppuhelper/basemutex.hxx>
  54
  55 #include <stdio.h>
  56
  57 //........................................................................
  58 namespace logging
  59 {
  60 //........................................................................
  61
  62     /** === begin UNO using === **/
  63     using ::com::sun::star::logging::XConsoleHandler;
  64     using ::com::sun::star::lang::XServiceInfo;
  65     using ::com::sun::star::uno::Reference;
  66     using ::com::sun::star::uno::XComponentContext;
  67     using ::com::sun::star::uno::RuntimeException;
  68     using ::com::sun::star::logging::XLogFormatter;
  69     using ::com::sun::star::uno::Sequence;
  70     using ::com::sun::star::logging::LogRecord;
  71     using ::com::sun::star::uno::UNO_QUERY_THROW;
  72     using ::com::sun::star::uno::Exception;
  73     using ::com::sun::star::uno::Any;
  74     using ::com::sun::star::uno::XInterface;
  75     using ::com::sun::star::lang::XInitialization;
  76     using ::com::sun::star::ucb::AlreadyInitializedException;
  77     using ::com::sun::star::lang::IllegalArgumentException;
  78     using ::com::sun::star::beans::NamedValue;
  79     /** === end UNO using === **/
  80     namespace LogLevel = ::com::sun::star::logging::LogLevel;
  81
  82     //====================================================================
  83     //= ConsoleHandler - declaration
  84     //====================================================================
  85     //--------------------------------------------------------------------
  86     typedef ::cppu::WeakComponentImplHelper3    <   XConsoleHandler
  87                                                 ,   XServiceInfo
  88                                                 ,   XInitialization
  89                                                 >   ConsoleHandler_Base;
  90     class ConsoleHandler    :public ::cppu::BaseMutex
  91                             ,public ConsoleHandler_Base
  92     {
  93     private:
  94         ::comphelper::ComponentContext  m_aContext;
  95         LogHandlerHelper                m_aHandlerHelper;
  96         sal_Int32                       m_nThreshold;
  97
  98     protected:
  99         ConsoleHandler( const Reference< XComponentContext >& _rxContext );
 100         virtual ~ConsoleHandler();
 101
 102         // XConsoleHandler
 103         virtual ::sal_Int32 SAL_CALL getThreshold() throw (RuntimeException);
 104         virtual void SAL_CALL setThreshold( ::sal_Int32 _threshold ) throw (RuntimeException);
 105
 106         // XLogHandler
 107         virtual ::rtl::OUString SAL_CALL getEncoding() throw (RuntimeException);
 108         virtual void SAL_CALL setEncoding( const ::rtl::OUString& _encoding ) throw (RuntimeException);
 109         virtual Reference< XLogFormatter > SAL_CALL getFormatter() throw (RuntimeException);
 110         virtual void SAL_CALL setFormatter( const Reference< XLogFormatter >& _formatter ) throw (RuntimeException);
 111         virtual ::sal_Int32 SAL_CALL getLevel() throw (RuntimeException);
 112         virtual void SAL_CALL setLevel( ::sal_Int32 _level ) throw (RuntimeException);
 113         virtual void SAL_CALL flush(  ) throw (RuntimeException);
 114         virtual ::sal_Bool SAL_CALL publish( const LogRecord& Record ) throw (RuntimeException);
 115
 116         // XInitialization
 117         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);
 118
 119         // XServiceInfo
 120         virtual ::rtl::OUString SAL_CALL getImplementationName() throw(RuntimeException);
 121         virtual ::sal_Bool SAL_CALL supportsService( const ::rtl::OUString& _rServiceName ) throw(RuntimeException);
 122         virtual Sequence< ::rtl::OUString > SAL_CALL getSupportedServiceNames() throw(RuntimeException);
 123
 124         // OComponentHelper
 125         virtual void SAL_CALL disposing();
 126
 127     public:
 128         // XServiceInfo - static version
 129         static ::rtl::OUString SAL_CALL getImplementationName_static();
 130         static Sequence< ::rtl::OUString > SAL_CALL getSupportedServiceNames_static();
 131         static Reference< XInterface > Create( const Reference< XComponentContext >& _rxContext );
 132
 133     public:
 134         typedef ComponentMethodGuard< ConsoleHandler > MethodGuard;
 135         void    enterMethod( MethodGuard::Access );
 136         void    leaveMethod( MethodGuard::Access );
 137     };
 138
 139     //====================================================================
 140     //= ConsoleHandler - implementation
 141     //====================================================================
 142     //--------------------------------------------------------------------
 143     ConsoleHandler::ConsoleHandler( const Reference< XComponentContext >& _rxContext )
 144         :ConsoleHandler_Base( m_aMutex )
 145         ,m_aContext( _rxContext )
 146         ,m_aHandlerHelper( _rxContext, m_aMutex, rBHelper )
 147         ,m_nThreshold( LogLevel::SEVERE )
 148     {
 149     }
 150
 151     //--------------------------------------------------------------------
 152     ConsoleHandler::~ConsoleHandler()
 153     {
 154         if ( !rBHelper.bDisposed )
 155         {
 156             acquire();
 157             dispose();
 158         }
 159     }
 160
 161     //--------------------------------------------------------------------
 162     void SAL_CALL ConsoleHandler::disposing()
 163     {
 164         m_aHandlerHelper.setFormatter( NULL );
 165     }
 166
 167     //--------------------------------------------------------------------
 168     void ConsoleHandler::enterMethod( MethodGuard::Access )
 169     {
 170         m_aHandlerHelper.enterMethod();
 171     }
 172
 173     //--------------------------------------------------------------------
 174     void ConsoleHandler::leaveMethod( MethodGuard::Access )
 175     {
 176         m_aMutex.release();
 177     }
 178
 179     //--------------------------------------------------------------------
 180     ::sal_Int32 SAL_CALL ConsoleHandler::getThreshold() throw (RuntimeException)
 181     {
 182         MethodGuard aGuard( *this );
 183         return m_nThreshold;
 184     }
 185
 186     //--------------------------------------------------------------------
 187     void SAL_CALL ConsoleHandler::setThreshold( ::sal_Int32 _threshold ) throw (RuntimeException)
 188     {
 189         MethodGuard aGuard( *this );
 190         m_nThreshold = _threshold;
 191     }
 192
 193     //--------------------------------------------------------------------
 194     ::rtl::OUString SAL_CALL ConsoleHandler::getEncoding() throw (RuntimeException)
 195     {
 196         MethodGuard aGuard( *this );
 197         ::rtl::OUString sEncoding;
 198         OSL_VERIFY( m_aHandlerHelper.getEncoding( sEncoding ) );
 199         return sEncoding;
 200     }
 201
 202     //--------------------------------------------------------------------
 203     void SAL_CALL ConsoleHandler::setEncoding( const ::rtl::OUString& _rEncoding ) throw (RuntimeException)
 204     {
 205         MethodGuard aGuard( *this );
 206         OSL_VERIFY( m_aHandlerHelper.setEncoding( _rEncoding ) );
 207     }
 208
 209     //--------------------------------------------------------------------
 210     Reference< XLogFormatter > SAL_CALL ConsoleHandler::getFormatter() throw (RuntimeException)
 211     {
 212         MethodGuard aGuard( *this );
 213         return m_aHandlerHelper.getFormatter();
 214     }
 215
 216     //--------------------------------------------------------------------
 217     void SAL_CALL ConsoleHandler::setFormatter( const Reference< XLogFormatter >& _rxFormatter ) throw (RuntimeException)
 218     {
 219         MethodGuard aGuard( *this );
 220         m_aHandlerHelper.setFormatter( _rxFormatter );
 221     }
 222
 223     //--------------------------------------------------------------------
 224     ::sal_Int32 SAL_CALL ConsoleHandler::getLevel() throw (RuntimeException)
 225     {
 226         MethodGuard aGuard( *this );
 227         return m_aHandlerHelper.getLevel();
 228     }
 229
 230     //--------------------------------------------------------------------
 231     void SAL_CALL ConsoleHandler::setLevel( ::sal_Int32 _nLevel ) throw (RuntimeException)
 232     {
 233         MethodGuard aGuard( *this );
 234         m_aHandlerHelper.setLevel( _nLevel );
 235     }
 236
 237     //--------------------------------------------------------------------
 238     void SAL_CALL ConsoleHandler::flush(  ) throw (RuntimeException)
 239     {
 240         MethodGuard aGuard( *this );
 241         fflush( stdout );
 242         fflush( stderr );
 243     }
 244
 245     //--------------------------------------------------------------------
 246     ::sal_Bool SAL_CALL ConsoleHandler::publish( const LogRecord& _rRecord ) throw (RuntimeException)
 247     {
 248         MethodGuard aGuard( *this );
 249
 250         ::rtl::OString sEntry;
 251         if ( !m_aHandlerHelper.formatForPublishing( _rRecord, sEntry ) )
 252             return sal_False;
 253
 254         if ( _rRecord.Level >= m_nThreshold )
 255             fprintf( stderr, "%s", sEntry.getStr() );
 256         else
 257             fprintf( stdout, "%s", sEntry.getStr() );
 258
 259         return sal_True;
 260     }
 261
 262     //--------------------------------------------------------------------
 263     void SAL_CALL ConsoleHandler::initialize( const Sequence< Any >& _rArguments ) throw (Exception, RuntimeException)
 264     {
 265         ::osl::MutexGuard aGuard( m_aMutex );
 266
 267         if ( m_aHandlerHelper.getIsInitialized() )
 268             throw AlreadyInitializedException();
 269
 270         if ( _rArguments.getLength() == 0 )
 271         {   // create() - nothing to init
 272             m_aHandlerHelper.setIsInitialized();
 273             return;
 274         }
 275
 276         if ( _rArguments.getLength() != 1 )
 277             throw IllegalArgumentException( ::rtl::OUString(), *this, 1 );
 278
 279         Sequence< NamedValue > aSettings;
 280         if ( !( _rArguments[0] >>= aSettings ) )
 281             throw IllegalArgumentException( ::rtl::OUString(), *this, 1 );
 282
 283         // createWithSettings( [in] sequence< ::com::sun::star::beans::NamedValue > Settings )
 284         ::comphelper::NamedValueCollection aTypedSettings( aSettings );
 285         m_aHandlerHelper.initFromSettings( aTypedSettings );
 286
 287         aTypedSettings.get_ensureType( "Threshold", m_nThreshold );
 288
 289         m_aHandlerHelper.setIsInitialized();
 290     }
 291
 292     //--------------------------------------------------------------------
 293     ::rtl::OUString SAL_CALL ConsoleHandler::getImplementationName() throw(RuntimeException)
 294     {
 295         return getImplementationName_static();
 296     }
 297
 298     //--------------------------------------------------------------------
 299     ::sal_Bool SAL_CALL ConsoleHandler::supportsService( const ::rtl::OUString& _rServiceName ) throw(RuntimeException)
 300     {
 301         const Sequence< ::rtl::OUString > aServiceNames( getSupportedServiceNames() );
 302         for (   const ::rtl::OUString* pServiceNames = aServiceNames.getConstArray();
 303                 pServiceNames != aServiceNames.getConstArray() + aServiceNames.getLength();
 304                 ++pServiceNames
 305             )
 306             if ( _rServiceName == *pServiceNames )
 307                 return sal_True;
 308         return sal_False;
 309     }
 310
 311     //--------------------------------------------------------------------
 312     Sequence< ::rtl::OUString > SAL_CALL ConsoleHandler::getSupportedServiceNames() throw(RuntimeException)
 313     {
 314         return getSupportedServiceNames_static();
 315     }
 316
 317     //--------------------------------------------------------------------
 318     ::rtl::OUString SAL_CALL ConsoleHandler::getImplementationName_static()
 319     {
 320         return ::rtl::OUString( RTL_CONSTASCII_USTRINGPARAM( "com.sun.star.comp.extensions.ConsoleHandler" ) );
 321     }
 322
 323     //--------------------------------------------------------------------
 324     Sequence< ::rtl::OUString > SAL_CALL ConsoleHandler::getSupportedServiceNames_static()
 325     {
 326         Sequence< ::rtl::OUString > aServiceNames(1);
 327         aServiceNames[0] = ::rtl::OUString( RTL_CONSTASCII_USTRINGPARAM( "com.sun.star.logging.ConsoleHandler" ) );
 328         return aServiceNames;
 329     }
 330
 331     //--------------------------------------------------------------------
 332     Reference< XInterface > ConsoleHandler::Create( const Reference< XComponentContext >& _rxContext )
 333     {
 334         return *( new ConsoleHandler( _rxContext ) );
 335     }
 336
 337     //--------------------------------------------------------------------
 338     void createRegistryInfo_ConsoleHandler()
 339     {
 340         static OAutoRegistration< ConsoleHandler > aAutoRegistration;
 341     }
 342
 343 //........................................................................
 344 } // namespace logging
 345 //........................................................................