domconfigurator.h

Go to the documentation of this file.

/*
 * 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
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

#ifndef _LOG4CXX_XML_DOM_CONFIGURATOR_H
#define _LOG4CXX_XML_DOM_CONFIGURATOR_H

#if defined(_MSC_VER)
    #pragma warning (push)
    #pragma warning ( disable: 4231 4251 4275 4786 )
#endif



#include <log4cxx/logstring.h>
#include <map>
#include <log4cxx/appender.h>
#include <log4cxx/layout.h>
#include <log4cxx/logger.h>
#include <log4cxx/helpers/properties.h>
#include <log4cxx/spi/configurator.h>
#include <log4cxx/helpers/charsetdecoder.h>
#include <log4cxx/spi/filter.h>
#include <log4cxx/rolling/triggeringpolicy.h>
#include <log4cxx/rolling/rollingpolicy.h>
#include <log4cxx/file.h>
#include <log4cxx/config/propertysetter.h>

extern "C" {
    struct apr_xml_doc;
    struct apr_xml_elem;
}

namespace log4cxx
{

namespace xml
{
class XMLWatchdog;

class LOG4CXX_EXPORT DOMConfigurator :
    virtual public spi::Configurator,
    virtual public helpers::Object
{
    protected:
        typedef std::map<LogString, AppenderPtr> AppenderMap;
        AppenderPtr findAppenderByName(
            log4cxx::helpers::Pool& p,
            log4cxx::helpers::CharsetDecoderPtr& utf8Decoder,
            apr_xml_elem* elem,
            apr_xml_doc* doc,
            const LogString& appenderName,
            AppenderMap& appenders);

        AppenderPtr findAppenderByReference(
            log4cxx::helpers::Pool& p,
            log4cxx::helpers::CharsetDecoderPtr& utf8Decoder,
            apr_xml_elem* appenderRef,
            apr_xml_doc* doc,
            AppenderMap& appenders);

        AppenderPtr parseAppender(
            log4cxx::helpers::Pool& p,
            log4cxx::helpers::CharsetDecoderPtr& utf8Decoder,
            apr_xml_elem* appenderElement,
            apr_xml_doc* doc,
            AppenderMap& appenders);

        void parseErrorHandler(
            log4cxx::helpers::Pool& p,
            log4cxx::helpers::CharsetDecoderPtr& utf8Decoder,
            apr_xml_elem* element,
            AppenderPtr& appender,
            apr_xml_doc* doc,
            AppenderMap& appenders);

        void parseFilters(
            log4cxx::helpers::Pool& p,
            log4cxx::helpers::CharsetDecoderPtr& utf8Decoder,
            apr_xml_elem* element,
            std::vector<log4cxx::spi::FilterPtr>& filters);

        void parseLogger(
            log4cxx::helpers::Pool& p,
            log4cxx::helpers::CharsetDecoderPtr& utf8Decoder,
            apr_xml_elem* loggerElement,
            apr_xml_doc* doc,
            AppenderMap& appenders);

        void parseLoggerFactory(
            log4cxx::helpers::Pool& p,
            log4cxx::helpers::CharsetDecoderPtr& utf8Decoder,
            apr_xml_elem* factoryElement);

        log4cxx::helpers::ObjectPtr parseTriggeringPolicy(
            log4cxx::helpers::Pool& p,
            log4cxx::helpers::CharsetDecoderPtr& utf8Decoder,
            apr_xml_elem* factoryElement);

        log4cxx::rolling::RollingPolicyPtr parseRollingPolicy(
            log4cxx::helpers::Pool& p,
            log4cxx::helpers::CharsetDecoderPtr& utf8Decoder,
            apr_xml_elem* factoryElement);

        void parseRoot(log4cxx::helpers::Pool& p,
            log4cxx::helpers::CharsetDecoderPtr& utf8Decoder,
            apr_xml_elem* rootElement, apr_xml_doc* doc, AppenderMap& appenders);

        void parseChildrenOfLoggerElement(
            log4cxx::helpers::Pool& p,
            log4cxx::helpers::CharsetDecoderPtr& utf8Decoder,
            apr_xml_elem* catElement,
            LoggerPtr logger, bool isRoot,
            apr_xml_doc* doc,
            AppenderMap& appenders );

        LayoutPtr parseLayout(
            log4cxx::helpers::Pool& p,
            log4cxx::helpers::CharsetDecoderPtr& utf8Decoder,
            apr_xml_elem* layout_element);

        void parseLevel(
            log4cxx::helpers::Pool& p,
            log4cxx::helpers::CharsetDecoderPtr& utf8Decoder,
            apr_xml_elem* element,
            LoggerPtr logger, bool isRoot);

        void setParameter(
            log4cxx::helpers::Pool& p,
            log4cxx::helpers::CharsetDecoderPtr& utf8Decoder,
            apr_xml_elem* elem,
            log4cxx::config::PropertySetter& propSetter);

        void parse(
            log4cxx::helpers::Pool& p,
            log4cxx::helpers::CharsetDecoderPtr& utf8Decoder,
            apr_xml_elem* element,
            apr_xml_doc* doc,
            AppenderMap& appenders);

    public:
        DOMConfigurator();

        DECLARE_LOG4CXX_OBJECT(DOMConfigurator)
        BEGIN_LOG4CXX_CAST_MAP()
        LOG4CXX_CAST_ENTRY(spi::Configurator)
        END_LOG4CXX_CAST_MAP()

        DOMConfigurator(log4cxx::helpers::Pool& p);

        static void configure(const std::string& filename);
#if LOG4CXX_WCHAR_T_API
        static void configure(const std::wstring& filename);
#endif
#if LOG4CXX_UNICHAR_API
        static void configure(const std::basic_string<UniChar>& filename);
#endif
#if LOG4CXX_CFSTRING_API
        static void configure(const CFStringRef& filename);
#endif

        static void configureAndWatch(const std::string& configFilename);
#if LOG4CXX_WCHAR_T_API
        static void configureAndWatch(const std::wstring& configFilename);
#endif
#if LOG4CXX_UNICHAR_API
        static void configureAndWatch(const std::basic_string<UniChar>& configFilename);
#endif
#if LOG4CXX_CFSTRING_API
        static void configureAndWatch(const CFStringRef& configFilename);
#endif

        static void configureAndWatch(const std::string& configFilename,
            long delay);
#if LOG4CXX_WCHAR_T_API
        static void configureAndWatch(const std::wstring& configFilename,
            long delay);
#endif
#if LOG4CXX_UNICHAR_API
        static void configureAndWatch(const std::basic_string<UniChar>& configFilename,
            long delay);
#endif
#if LOG4CXX_CFSTRING_API
        static void configureAndWatch(const CFStringRef& configFilename,
            long delay);
#endif

        void doConfigure(const File& filename,
            spi::LoggerRepositoryPtr repository);

    protected:
        static LogString getAttribute(
            log4cxx::helpers::CharsetDecoderPtr& utf8Decoder,
            apr_xml_elem*,
            const std::string& attrName);

        LogString subst(const LogString& value);

    protected:
        helpers::Properties props;
        spi::LoggerRepositoryPtr repository;
        spi::LoggerFactoryPtr loggerFactory;

    private:
        //   prevent assignment or copy statements
        DOMConfigurator(const DOMConfigurator&);
        DOMConfigurator& operator=(const DOMConfigurator&);
        static XMLWatchdog* xdog;
};
LOG4CXX_PTR_DEF(DOMConfigurator);
}  // namespace xml
} // namespace log4cxx

#if defined(_MSC_VER)
    #pragma warning (pop)
#endif

#endif // _LOG4CXX_XML_DOM_CONFIGURATOR_H