extensions/source/logging/consolehandler.cxx

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*
   3  * This file is part of the LibreOffice project.
   4  *
   5  * This Source Code Form is subject to the terms of the Mozilla Public
   6  * License, v. 2.0. If a copy of the MPL was not distributed with this
   7  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
   8  *
   9  * This file incorporates work covered by the following license notice:
  10  *
  11  *   Licensed to the Apache Software Foundation (ASF) under one or more
  12  *   contributor license agreements. See the NOTICE file distributed
  13  *   with this work for additional information regarding copyright
  14  *   ownership. The ASF licenses this file to you under the Apache
  15  *   License, Version 2.0 (the "License"); you may not use this file
  16  *   except in compliance with the License. You may obtain a copy of
  17  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
  18  */
  19
  20
  21 #include "log_module.hxx"
  22 #include "methodguard.hxx"
  23 #include "loghandler.hxx"
  24
  25 #include <com/sun/star/logging/XConsoleHandler.hpp>
  26 #include <com/sun/star/lang/XServiceInfo.hpp>
  27 #include <com/sun/star/logging/LogLevel.hpp>
  28 #include <com/sun/star/lang/XInitialization.hpp>
  29 #include <com/sun/star/ucb/AlreadyInitializedException.hpp>
  30 #include <com/sun/star/lang/IllegalArgumentException.hpp>
  31 #include <com/sun/star/beans/NamedValue.hpp>
  32
  33 #include <comphelper/componentcontext.hxx>
  34
  35 #include <cppuhelper/compbase3.hxx>
  36 #include <cppuhelper/basemutex.hxx>
  37
  38 #include <stdio.h>
  39
  40 //........................................................................
  41 namespace logging
  42 {
  43 //........................................................................
  44
  45     using ::com::sun::star::logging::XConsoleHandler;
  46     using ::com::sun::star::lang::XServiceInfo;
  47     using ::com::sun::star::uno::Reference;
  48     using ::com::sun::star::uno::XComponentContext;
  49     using ::com::sun::star::uno::RuntimeException;
  50     using ::com::sun::star::logging::XLogFormatter;
  51     using ::com::sun::star::uno::Sequence;
  52     using ::com::sun::star::logging::LogRecord;
  53     using ::com::sun::star::uno::UNO_QUERY_THROW;
  54     using ::com::sun::star::uno::Exception;
  55     using ::com::sun::star::uno::Any;
  56     using ::com::sun::star::uno::XInterface;
  57     using ::com::sun::star::lang::XInitialization;
  58     using ::com::sun::star::ucb::AlreadyInitializedException;
  59     using ::com::sun::star::lang::IllegalArgumentException;
  60     using ::com::sun::star::beans::NamedValue;
  61
  62     namespace LogLevel = ::com::sun::star::logging::LogLevel;
  63
  64     //====================================================================
  65     //= ConsoleHandler - declaration
  66     //====================================================================
  67     //--------------------------------------------------------------------
  68     typedef ::cppu::WeakComponentImplHelper3    <   XConsoleHandler
  69                                                 ,   XServiceInfo
  70                                                 ,   XInitialization
  71                                                 >   ConsoleHandler_Base;
  72     class ConsoleHandler    :public ::cppu::BaseMutex
  73                             ,public ConsoleHandler_Base
  74     {
  75     private:
  76         ::comphelper::ComponentContext  m_aContext;
  77         LogHandlerHelper                m_aHandlerHelper;
  78         sal_Int32                       m_nThreshold;
  79
  80     protected:
  81         ConsoleHandler( const Reference< XComponentContext >& _rxContext );
  82         virtual ~ConsoleHandler();
  83
  84         // XConsoleHandler
  85         virtual ::sal_Int32 SAL_CALL getThreshold() throw (RuntimeException);
  86         virtual void SAL_CALL setThreshold( ::sal_Int32 _threshold ) throw (RuntimeException);
  87
  88         // XLogHandler
  89         virtual OUString SAL_CALL getEncoding() throw (RuntimeException);
  90         virtual void SAL_CALL setEncoding( const OUString& _encoding ) throw (RuntimeException);
  91         virtual Reference< XLogFormatter > SAL_CALL getFormatter() throw (RuntimeException);
  92         virtual void SAL_CALL setFormatter( const Reference< XLogFormatter >& _formatter ) throw (RuntimeException);
  93         virtual ::sal_Int32 SAL_CALL getLevel() throw (RuntimeException);
  94         virtual void SAL_CALL setLevel( ::sal_Int32 _level ) throw (RuntimeException);
  95         virtual void SAL_CALL flush(  ) throw (RuntimeException);
  96         virtual ::sal_Bool SAL_CALL publish( const LogRecord& Record ) throw (RuntimeException);
  97
  98         // XInitialization
  99         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);
 100
 101         // XServiceInfo
 102         virtual OUString SAL_CALL getImplementationName() throw(RuntimeException);
 103         virtual ::sal_Bool SAL_CALL supportsService( const OUString& _rServiceName ) throw(RuntimeException);
 104         virtual Sequence< OUString > SAL_CALL getSupportedServiceNames() throw(RuntimeException);
 105
 106         // OComponentHelper
 107         virtual void SAL_CALL disposing();
 108
 109     public:
 110         // XServiceInfo - static version
 111         static OUString SAL_CALL getImplementationName_static();
 112         static Sequence< OUString > SAL_CALL getSupportedServiceNames_static();
 113         static Reference< XInterface > Create( const Reference< XComponentContext >& _rxContext );
 114
 115     public:
 116         typedef ComponentMethodGuard< ConsoleHandler > MethodGuard;
 117         void    enterMethod( MethodGuard::Access );
 118         void    leaveMethod( MethodGuard::Access );
 119     };
 120
 121     //====================================================================
 122     //= ConsoleHandler - implementation
 123     //====================================================================
 124     //--------------------------------------------------------------------
 125     ConsoleHandler::ConsoleHandler( const Reference< XComponentContext >& _rxContext )
 126         :ConsoleHandler_Base( m_aMutex )
 127         ,m_aContext( _rxContext )
 128         ,m_aHandlerHelper( _rxContext, m_aMutex, rBHelper )
 129         ,m_nThreshold( LogLevel::SEVERE )
 130     {
 131     }
 132
 133     //--------------------------------------------------------------------
 134     ConsoleHandler::~ConsoleHandler()
 135     {
 136         if ( !rBHelper.bDisposed )
 137         {
 138             acquire();
 139             dispose();
 140         }
 141     }
 142
 143     //--------------------------------------------------------------------
 144     void SAL_CALL ConsoleHandler::disposing()
 145     {
 146         m_aHandlerHelper.setFormatter( NULL );
 147     }
 148
 149     //--------------------------------------------------------------------
 150     void ConsoleHandler::enterMethod( MethodGuard::Access )
 151     {
 152         m_aHandlerHelper.enterMethod();
 153     }
 154
 155     //--------------------------------------------------------------------
 156     void ConsoleHandler::leaveMethod( MethodGuard::Access )
 157     {
 158         m_aMutex.release();
 159     }
 160
 161     //--------------------------------------------------------------------
 162     ::sal_Int32 SAL_CALL ConsoleHandler::getThreshold() throw (RuntimeException)
 163     {
 164         MethodGuard aGuard( *this );
 165         return m_nThreshold;
 166     }
 167
 168     //--------------------------------------------------------------------
 169     void SAL_CALL ConsoleHandler::setThreshold( ::sal_Int32 _threshold ) throw (RuntimeException)
 170     {
 171         MethodGuard aGuard( *this );
 172         m_nThreshold = _threshold;
 173     }
 174
 175     //--------------------------------------------------------------------
 176     OUString SAL_CALL ConsoleHandler::getEncoding() throw (RuntimeException)
 177     {
 178         MethodGuard aGuard( *this );
 179         OUString sEncoding;
 180         OSL_VERIFY( m_aHandlerHelper.getEncoding( sEncoding ) );
 181         return sEncoding;
 182     }
 183
 184     //--------------------------------------------------------------------
 185     void SAL_CALL ConsoleHandler::setEncoding( const OUString& _rEncoding ) throw (RuntimeException)
 186     {
 187         MethodGuard aGuard( *this );
 188         OSL_VERIFY( m_aHandlerHelper.setEncoding( _rEncoding ) );
 189     }
 190
 191     //--------------------------------------------------------------------
 192     Reference< XLogFormatter > SAL_CALL ConsoleHandler::getFormatter() throw (RuntimeException)
 193     {
 194         MethodGuard aGuard( *this );
 195         return m_aHandlerHelper.getFormatter();
 196     }
 197
 198     //--------------------------------------------------------------------
 199     void SAL_CALL ConsoleHandler::setFormatter( const Reference< XLogFormatter >& _rxFormatter ) throw (RuntimeException)
 200     {
 201         MethodGuard aGuard( *this );
 202         m_aHandlerHelper.setFormatter( _rxFormatter );
 203     }
 204
 205     //--------------------------------------------------------------------
 206     ::sal_Int32 SAL_CALL ConsoleHandler::getLevel() throw (RuntimeException)
 207     {
 208         MethodGuard aGuard( *this );
 209         return m_aHandlerHelper.getLevel();
 210     }
 211
 212     //--------------------------------------------------------------------
 213     void SAL_CALL ConsoleHandler::setLevel( ::sal_Int32 _nLevel ) throw (RuntimeException)
 214     {
 215         MethodGuard aGuard( *this );
 216         m_aHandlerHelper.setLevel( _nLevel );
 217     }
 218
 219     //--------------------------------------------------------------------
 220     void SAL_CALL ConsoleHandler::flush(  ) throw (RuntimeException)
 221     {
 222         MethodGuard aGuard( *this );
 223         fflush( stdout );
 224         fflush( stderr );
 225     }
 226
 227     //--------------------------------------------------------------------
 228     ::sal_Bool SAL_CALL ConsoleHandler::publish( const LogRecord& _rRecord ) throw (RuntimeException)
 229     {
 230         MethodGuard aGuard( *this );
 231
 232         OString sEntry;
 233         if ( !m_aHandlerHelper.formatForPublishing( _rRecord, sEntry ) )
 234             return sal_False;
 235
 236         if ( _rRecord.Level >= m_nThreshold )
 237             fprintf( stderr, "%s\n", sEntry.getStr() );
 238         else
 239             fprintf( stdout, "%s\n", sEntry.getStr() );
 240
 241         return sal_True;
 242     }
 243
 244     //--------------------------------------------------------------------
 245     void SAL_CALL ConsoleHandler::initialize( const Sequence< Any >& _rArguments ) throw (Exception, RuntimeException)
 246     {
 247         ::osl::MutexGuard aGuard( m_aMutex );
 248
 249         if ( m_aHandlerHelper.getIsInitialized() )
 250             throw AlreadyInitializedException();
 251
 252         if ( _rArguments.getLength() == 0 )
 253         {   // create() - nothing to init
 254             m_aHandlerHelper.setIsInitialized();
 255             return;
 256         }
 257
 258         if ( _rArguments.getLength() != 1 )
 259             throw IllegalArgumentException( OUString(), *this, 1 );
 260
 261         Sequence< NamedValue > aSettings;
 262         if ( !( _rArguments[0] >>= aSettings ) )
 263             throw IllegalArgumentException( OUString(), *this, 1 );
 264
 265         // createWithSettings( [in] sequence< ::com::sun::star::beans::NamedValue > Settings )
 266         ::comphelper::NamedValueCollection aTypedSettings( aSettings );
 267         m_aHandlerHelper.initFromSettings( aTypedSettings );
 268
 269         aTypedSettings.get_ensureType( "Threshold", m_nThreshold );
 270
 271         m_aHandlerHelper.setIsInitialized();
 272     }
 273
 274     //--------------------------------------------------------------------
 275     OUString SAL_CALL ConsoleHandler::getImplementationName() throw(RuntimeException)
 276     {
 277         return getImplementationName_static();
 278     }
 279
 280     //--------------------------------------------------------------------
 281     ::sal_Bool SAL_CALL ConsoleHandler::supportsService( const OUString& _rServiceName ) throw(RuntimeException)
 282     {
 283         const Sequence< OUString > aServiceNames( getSupportedServiceNames() );
 284         for (   const OUString* pServiceNames = aServiceNames.getConstArray();
 285                 pServiceNames != aServiceNames.getConstArray() + aServiceNames.getLength();
 286                 ++pServiceNames
 287             )
 288             if ( _rServiceName == *pServiceNames )
 289                 return sal_True;
 290         return sal_False;
 291     }
 292
 293     //--------------------------------------------------------------------
 294     Sequence< OUString > SAL_CALL ConsoleHandler::getSupportedServiceNames() throw(RuntimeException)
 295     {
 296         return getSupportedServiceNames_static();
 297     }
 298
 299     //--------------------------------------------------------------------
 300     OUString SAL_CALL ConsoleHandler::getImplementationName_static()
 301     {
 302         return OUString( "com.sun.star.comp.extensions.ConsoleHandler" );
 303     }
 304
 305     //--------------------------------------------------------------------
 306     Sequence< OUString > SAL_CALL ConsoleHandler::getSupportedServiceNames_static()
 307     {
 308         Sequence< OUString > aServiceNames(1);
 309         aServiceNames[0] = OUString( "com.sun.star.logging.ConsoleHandler" );
 310         return aServiceNames;
 311     }
 312
 313     //--------------------------------------------------------------------
 314     Reference< XInterface > ConsoleHandler::Create( const Reference< XComponentContext >& _rxContext )
 315     {
 316         return *( new ConsoleHandler( _rxContext ) );
 317     }
 318
 319     //--------------------------------------------------------------------
 320     void createRegistryInfo_ConsoleHandler()
 321     {
 322         static OAutoRegistration< ConsoleHandler > aAutoRegistration;
 323     }
 324
 325 //........................................................................
 326 } // namespace logging
 327 //........................................................................
 328
 329 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */