/*

 * 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.

 */

#include <log4cxx/logstring.h>

#include <log4cxx/propertyconfigurator.h>

#include <log4cxx/helpers/properties.h>

#include <log4cxx/helpers/loglog.h>

#include <log4cxx/helpers/exception.h>

#include <log4cxx/logmanager.h>

#include <log4cxx/helpers/optionconverter.h>

#include <log4cxx/level.h>

#if LOG4CXX_ABI_VERSION <= 15

#include <log4cxx/defaultloggerfactory.h>

#else

#include <log4cxx/spi/loggerfactory.h>

#endif

#include <log4cxx/helpers/stringhelper.h>

#include <log4cxx/layout.h>

#include <log4cxx/config/propertysetter.h>

#include <log4cxx/helpers/stringtokenizer.h>

#include <log4cxx/helpers/transcoder.h>

#include <log4cxx/helpers/fileinputstream.h>

#include <log4cxx/helpers/loader.h>

#include <log4cxx/helpers/threadutility.h>

#include <log4cxx/helpers/singletonholder.h>

#include <log4cxx/rolling/rollingfileappender.h>

#define LOG4CXX 1

#include <log4cxx/helpers/aprinitializer.h>

using namespace LOG4CXX_NS;

using namespace LOG4CXX_NS::spi;

using namespace LOG4CXX_NS::helpers;

using namespace LOG4CXX_NS::config;

using namespace LOG4CXX_NS::rolling;

#include <log4cxx/helpers/filewatchdog.h>

namespace LOG4CXX_NS

{

class PropertyWatchdog  : public FileWatchdog

{

  public:

    PropertyWatchdog(const File& filename) : FileWatchdog(filename)

    {

    }

    /**

    Call PropertyConfigurator#doConfigure(const String& configFileName,

    const spi::LoggerRepositoryPtr& hierarchy) with the

    <code>filename</code> to reconfigure log4cxx.

    */

    void doOnChange()

    {

      PropertyConfigurator().doConfigure(file(),

        LogManager::getLoggerRepository());

    }

    static void startWatching(const File& filename, long delay)

    {

      using WatchdogHolder = SingletonHolder<PropertyWatchdog>;

      auto pHolder = APRInitializer::getOrAddUnique<WatchdogHolder>

        ( [&filename]() -> ObjectPtr

          { return std::make_shared<WatchdogHolder>(filename); }

        );

      auto& pdog = pHolder->value();

      pdog.setFile(filename);

      pdog.setDelay(0 < delay ? delay : FileWatchdog::DEFAULT_DELAY);

      pdog.start();

    }

};

}

IMPLEMENT_LOG4CXX_OBJECT(PropertyConfigurator)

PropertyConfigurator::PropertyConfigurator()

  : registry(new std::map<LogString, AppenderPtr>())

#if LOG4CXX_ABI_VERSION <= 15

  , loggerFactory(new DefaultLoggerFactory())

#else

  , loggerFactory(new LoggerFactory())

#endif

{

}

Unexecuted instantiation: log4cxx::PropertyConfigurator::PropertyConfigurator()

Unexecuted instantiation: log4cxx::PropertyConfigurator::PropertyConfigurator()

PropertyConfigurator::~PropertyConfigurator()

{

  delete registry;

}

spi::ConfigurationStatus PropertyConfigurator::doConfigure

  ( const File&                     configFileName

#if LOG4CXX_ABI_VERSION <= 15

  , spi::LoggerRepositoryPtr        repository

#else

  , const spi::LoggerRepositoryPtr& repository

#endif

  )

{

  auto hierarchy = repository ? repository : LogManager::getLoggerRepository();

  hierarchy->setConfigured(true);

  Properties props;

  try

  {

    InputStreamPtr inputStream = InputStreamPtr( new FileInputStream(configFileName) );

    props.load(inputStream);

  }

  catch (const IOException& ex)

  {

    LOG4CXX_DECODE_CHAR(lsMsg, ex.what());

    LogLog::error(((LogString) LOG4CXX_STR("Could not read configuration file ["))

      + configFileName.getPath() + LOG4CXX_STR("]: ") + lsMsg);

    return spi::ConfigurationStatus::NotConfigured;

  }

  try

  {

    if (LogLog::isDebugEnabled())

    {

      LogString debugMsg = LOG4CXX_STR("Loading configuration file [")

          + configFileName.getPath() + LOG4CXX_STR("].");

      LogLog::debug(debugMsg);

    }

    return doConfigure(props, hierarchy);

  }

  catch (const std::exception& ex)

  {

    LogLog::error(((LogString) LOG4CXX_STR("Could not parse configuration file ["))

      + configFileName.getPath() + LOG4CXX_STR("]: "), ex);

  }

  return spi::ConfigurationStatus::NotConfigured;

}

spi::ConfigurationStatus PropertyConfigurator::configure(const File& configFilename)

{

  return PropertyConfigurator().doConfigure(configFilename, LogManager::getLoggerRepository());

}

spi::ConfigurationStatus PropertyConfigurator::configure(helpers::Properties& properties)

{

  return PropertyConfigurator().doConfigure(properties, LogManager::getLoggerRepository());

}

#if LOG4CXX_ABI_VERSION <= 15

spi::ConfigurationStatus PropertyConfigurator::configureAndWatch(const File& configFilename)

{

  return configureAndWatch(configFilename, FileWatchdog::DEFAULT_DELAY);

}

#endif

spi::ConfigurationStatus PropertyConfigurator::configureAndWatch(

  const File& configFilename, long delay)

{

  spi::ConfigurationStatus stat = PropertyConfigurator().doConfigure(configFilename, LogManager::getLoggerRepository());

  PropertyWatchdog::startWatching(configFilename, delay);

  return stat;

}

spi::ConfigurationStatus PropertyConfigurator::doConfigure(helpers::Properties& properties,

  spi::LoggerRepositoryPtr hierarchy)

{

  hierarchy->setConfigured(true);

  static const WideLife<LogString> DEBUG_KEY(LOG4CXX_STR("log4j.debug"));

  LogString value(properties.getProperty(DEBUG_KEY));

  if (!value.empty())

  {

    LogLog::setInternalDebugging(OptionConverter::toBoolean(value, true));

  }

  static const WideLife<LogString> THRESHOLD_PREFIX(LOG4CXX_STR("log4j.threshold"));

  LogString thresholdStr =

    OptionConverter::findAndSubst(THRESHOLD_PREFIX, properties);

  if (!thresholdStr.empty())

  {

    hierarchy->setThreshold(OptionConverter::toLevel(thresholdStr, Level::getAll()));

    if (LogLog::isDebugEnabled())

    {

      LogLog::debug(((LogString) LOG4CXX_STR("Hierarchy threshold set to ["))

        + hierarchy->getThreshold()->toString()

        + LOG4CXX_STR("]."));

    }

  }

  LogString threadConfigurationValue(properties.getProperty(LOG4CXX_STR("log4j.threadConfiguration")));

  if ( threadConfigurationValue == LOG4CXX_STR("NoConfiguration") )

  {

    helpers::ThreadUtility::configure( ThreadConfigurationType::NoConfiguration );

  }

  else if ( threadConfigurationValue == LOG4CXX_STR("BlockSignalsOnly") )

  {

    helpers::ThreadUtility::configure( ThreadConfigurationType::BlockSignalsOnly );

  }

  else if ( threadConfigurationValue == LOG4CXX_STR("NameThreadOnly") )

  {

    helpers::ThreadUtility::configure( ThreadConfigurationType::NameThreadOnly );

  }

  else if ( threadConfigurationValue == LOG4CXX_STR("BlockSignalsAndNameThread") )

  {

    helpers::ThreadUtility::configure( ThreadConfigurationType::BlockSignalsAndNameThread );

  }

  configureRootLogger(properties, hierarchy);

  configureLoggerFactory(properties);

  parseCatsAndRenderers(properties, hierarchy);

  LogLog::debug(LOG4CXX_STR("Finished configuring."));

  // We don't want to hold references to appenders preventing their

  // destruction.

  registry->clear();

  return spi::ConfigurationStatus::Configured;

}

void PropertyConfigurator::configureLoggerFactory(helpers::Properties& props)

{

  static const WideLife<LogString> LOGGER_FACTORY_KEY(LOG4CXX_STR("log4j.loggerFactory"));

  LogString factoryClassName =

    OptionConverter::findAndSubst(LOGGER_FACTORY_KEY, props);

  if (!factoryClassName.empty())

  {

    if (LogLog::isDebugEnabled())

    {

      LogString msg(LOG4CXX_STR("Setting logger factory to ["));

      msg += factoryClassName;

      msg += LOG4CXX_STR("].");

      LogLog::debug(msg);

    }

    std::shared_ptr<Object> instance = std::shared_ptr<Object>(

        Loader::loadClass(factoryClassName).newInstance() );

    loggerFactory = LOG4CXX_NS::cast<LoggerFactory>( instance );

    static const WideLife<LogString> FACTORY_PREFIX(LOG4CXX_STR("log4j.factory."));

    Pool p;

    PropertySetter::setProperties(loggerFactory, props, FACTORY_PREFIX, p);

  }

}

void PropertyConfigurator::configureRootLogger(helpers::Properties& props,

  spi::LoggerRepositoryPtr& hierarchy)

{

  static const WideLife<LogString> ROOT_CATEGORY_PREFIX(LOG4CXX_STR("log4j.rootCategory"));

  static const WideLife<LogString> ROOT_LOGGER_PREFIX(LOG4CXX_STR("log4j.rootLogger"));

  LogString effectiveFrefix(ROOT_LOGGER_PREFIX);

  LogString value = OptionConverter::findAndSubst(ROOT_LOGGER_PREFIX, props);

  if (value.empty())

  {

    value = OptionConverter::findAndSubst(ROOT_CATEGORY_PREFIX, props);

    effectiveFrefix = ROOT_CATEGORY_PREFIX;

  }

  if (value.empty())

  {

    LogLog::debug(LOG4CXX_STR("Could not find root logger information. Is this OK?"));

  }

  else

  {

    LoggerPtr root = hierarchy->getRootLogger();

    static const WideLife<LogString> INTERNAL_ROOT_NAME(LOG4CXX_STR("root"));

    parseLogger(props, root, effectiveFrefix, INTERNAL_ROOT_NAME, value, true);

  }

}

void PropertyConfigurator::parseCatsAndRenderers(helpers::Properties& props,

  spi::LoggerRepositoryPtr& hierarchy)

{

  static const WideLife<LogString> CATEGORY_PREFIX(LOG4CXX_STR("log4j.category."));

  static const WideLife<LogString> LOGGER_PREFIX(LOG4CXX_STR("log4j.logger."));

  for (auto key : props.propertyNames())

  {

    if (key.find(CATEGORY_PREFIX) == 0 || key.find(LOGGER_PREFIX) == 0)

    {

      LogString loggerName;

      if (key.find(CATEGORY_PREFIX) == 0)

      {

        loggerName = key.substr(CATEGORY_PREFIX.value().length());

      }

      else if (key.find(LOGGER_PREFIX.value()) == 0)

      {

        loggerName = key.substr(LOGGER_PREFIX.value().length());

      }

      LogString value = OptionConverter::findAndSubst(key, props);

      LoggerPtr logger = hierarchy->getLogger(loggerName, loggerFactory);

      bool additivity = parseAdditivityForLogger(props, logger, loggerName);

      parseLogger(props, logger, key, loggerName, value, additivity);

    }

  }

}

bool PropertyConfigurator::parseAdditivityForLogger(helpers::Properties& props,

  LoggerPtr& cat, const LogString& loggerName)

{

  static const WideLife<LogString> ADDITIVITY_PREFIX(LOG4CXX_STR("log4j.additivity."));

  LogString value(OptionConverter::findAndSubst(ADDITIVITY_PREFIX.value() + loggerName, props));

  if (LogLog::isDebugEnabled())

  {

    LogLog::debug((LogString) LOG4CXX_STR("Handling ") + ADDITIVITY_PREFIX.value()

      + loggerName + LOG4CXX_STR("=[") +  value + LOG4CXX_STR("]"));

  }

  // touch additivity only if necessary

  if (!value.empty())

  {

    bool additivity = OptionConverter::toBoolean(value, true);

    if (LogLog::isDebugEnabled())

    {

      LogLog::debug(((LogString) LOG4CXX_STR("Setting additivity for \""))

        + loggerName

        + ((additivity) ?  LOG4CXX_STR("\" to true") :

          LOG4CXX_STR("\" to false")));

    }

    return additivity;

  }

  return true;

}

/**

        This method must work for the root logger as well.

*/

void PropertyConfigurator::parseLogger(

  helpers::Properties& props, LoggerPtr& logger, const LogString& /* optionKey */,

  const LogString& loggerName, const LogString& value, bool additivity)

{

  if (LogLog::isDebugEnabled())

  {

    LogLog::debug(((LogString) LOG4CXX_STR("Parsing for ["))

      + loggerName

      + LOG4CXX_STR("] with value=[")

      + value + LOG4CXX_STR("]."));

  }

  // We must skip over ',' but not white space

  StringTokenizer st(value, LOG4CXX_STR(","));

  // If value is not in the form ", appender.." or "", then we should set

  // the level of the logger.

  if (!(value.find(LOG4CXX_STR(",")) == 0 || value.empty()))

  {

    // just to be on the safe side...

    if (!st.hasMoreTokens())

    {

      return;

    }

    LogString levelStr = st.nextToken();

    if (LogLog::isDebugEnabled())

    {

      LogLog::debug((LogString) LOG4CXX_STR("Level token is [")

        + levelStr +  LOG4CXX_STR("]."));

    }

    // If the level value is inherited, set logger level value to

    // null. We also check that the user has not specified inherited for the

    // root logger.

    if (StringHelper::equalsIgnoreCase(levelStr, LOG4CXX_STR("INHERITED"), LOG4CXX_STR("inherited"))

      || StringHelper::equalsIgnoreCase(levelStr, LOG4CXX_STR("NULL"), LOG4CXX_STR("null")))

    {

      static const WideLife<LogString> INTERNAL_ROOT_NAME(LOG4CXX_STR("root"));

      if (loggerName == INTERNAL_ROOT_NAME.value())

      {

        LogLog::warn(LOG4CXX_STR("The root logger cannot be set to null."));

      }

      else

      {

        logger->setLevel(0);

        if (LogLog::isDebugEnabled())

        {

          LogLog::debug((LogString) LOG4CXX_STR("Logger ")

            + loggerName + LOG4CXX_STR(" set to null"));

        }

      }

    }

    else

    {

      logger->setLevel(OptionConverter::toLevel(levelStr, Level::getDebug()));

      if (LogLog::isDebugEnabled())

      {

        LogLog::debug((LogString) LOG4CXX_STR("Logger ")

          + loggerName + LOG4CXX_STR(" set to ")

          + logger->getLevel()->toString());

      }

    }

  }

  AppenderPtr appender;

  LogString appenderName;

  std::vector<AppenderPtr> newappenders;

  while (st.hasMoreTokens())

  {

    appenderName = StringHelper::trim(st.nextToken());

    if (appenderName.empty() || appenderName == LOG4CXX_STR(","))

    {

      continue;

    }

    if (LogLog::isDebugEnabled())

    {

      LogLog::debug(LOG4CXX_STR("Parsing appender named ")

        + appenderName + LOG4CXX_STR("\"."));

    }

    appender = parseAppender(props, appenderName);

    if (appender != 0)

    {

      newappenders.push_back(appender);

    }

  }

  logger->reconfigure( newappenders, additivity );

}

AppenderPtr PropertyConfigurator::parseAppender(

  helpers::Properties& props, const LogString& appenderName)

{

  AppenderPtr appender = registryGet(appenderName);

  if (appender != 0)

  {

    if (LogLog::isDebugEnabled())

    {

      LogLog::debug((LogString) LOG4CXX_STR("Appender \"")

        + appenderName + LOG4CXX_STR("\" was already parsed."));

    }

    return appender;

  }

  static const WideLife<LogString> APPENDER_PREFIX(LOG4CXX_STR("log4j.appender."));

  // Appender was not previously initialized.

  LogString prefix = APPENDER_PREFIX.value() + appenderName;

  LogString layoutPrefix = prefix + LOG4CXX_STR(".layout");

  std::shared_ptr<Object> obj =

    OptionConverter::instantiateByKey(

      props, prefix, Appender::getStaticClass(), 0);

  appender = LOG4CXX_NS::cast<Appender>( obj );

  // Map obsolete DailyRollingFileAppender property configuration

  if (!appender &&

    StringHelper::endsWith(OptionConverter::findAndSubst(prefix, props), LOG4CXX_STR("DailyRollingFileAppender")))

  {

    appender = std::make_shared<RollingFileAppender>();

    auto datePattern = OptionConverter::findAndSubst(prefix + LOG4CXX_STR(".datePattern"), props);

    if (!datePattern.empty())

      props.put(prefix + LOG4CXX_STR(".fileDatePattern"), datePattern);

  }

  if (!appender)

  {

    LogLog::error((LogString) LOG4CXX_STR("Could not instantiate appender named \"")

      + appenderName + LOG4CXX_STR("\"."));

    return 0;

  }

  appender->setName(appenderName);

  if (appender->instanceof(OptionHandler::getStaticClass()))

  {

    Pool p;

    if (appender->requiresLayout())

    {

      LayoutPtr layout;

      std::shared_ptr<Object> obj =

        OptionConverter::instantiateByKey(

          props, layoutPrefix, Layout::getStaticClass(), 0);

      layout = LOG4CXX_NS::cast<Layout>( obj );

      if (layout != 0)

      {

        appender->setLayout(layout);

        if (LogLog::isDebugEnabled())

        {

          LogLog::debug((LogString) LOG4CXX_STR("Parsing layout options for \"")

            + appenderName + LOG4CXX_STR("\"."));

        }

        PropertySetter::setProperties(layout, props, layoutPrefix + LOG4CXX_STR("."), p);

        if (LogLog::isDebugEnabled())

        {

          LogLog::debug((LogString) LOG4CXX_STR("End of parsing for \"")

            + appenderName +  LOG4CXX_STR("\"."));

        }

      }

    }

    RollingFileAppenderPtr rolling = LOG4CXX_NS::cast<rolling::RollingFileAppender>(appender);

    if (rolling)

    {

      LogString rollingPolicyKey = prefix + LOG4CXX_STR(".rollingPolicy");

      if (!OptionConverter::findAndSubst(rollingPolicyKey, props).empty())

      {

        RollingPolicyPtr rollingPolicy;

        std::shared_ptr<Object> rolling_obj =

          OptionConverter::instantiateByKey(

            props, rollingPolicyKey, RollingPolicy::getStaticClass(), 0);

        rollingPolicy = LOG4CXX_NS::cast<RollingPolicy>( rolling_obj );

        if(rollingPolicy)

        {

          rolling->setRollingPolicy(rollingPolicy);

          if (LogLog::isDebugEnabled())

          {

            LogLog::debug((LogString) LOG4CXX_STR("Parsing rolling policy options for \"")

              + appenderName + LOG4CXX_STR("\"."));

          }

          PropertySetter::setProperties(rollingPolicy, props, rollingPolicyKey + LOG4CXX_STR("."), p);

        }

      }

      LogString triggeringPolicyKey = prefix + LOG4CXX_STR(".triggeringPolicy");

      if (!OptionConverter::findAndSubst(triggeringPolicyKey, props).empty())

      {

        TriggeringPolicyPtr triggeringPolicy;

        std::shared_ptr<Object> triggering_obj =

          OptionConverter::instantiateByKey(

            props, triggeringPolicyKey, TriggeringPolicy::getStaticClass(), 0);

        triggeringPolicy = LOG4CXX_NS::cast<TriggeringPolicy>( triggering_obj );

        if(triggeringPolicy)

        {

          rolling->setTriggeringPolicy(triggeringPolicy);

          if (LogLog::isDebugEnabled())

          {

            LogLog::debug((LogString) LOG4CXX_STR("Parsing triggering policy options for \"")

              + appenderName + LOG4CXX_STR("\"."));

          }

          PropertySetter::setProperties(triggeringPolicy, props, triggeringPolicyKey + LOG4CXX_STR("."), p);

        }

      }

    }

    PropertySetter::setProperties(appender, props, prefix + LOG4CXX_STR("."), p);

    if (LogLog::isDebugEnabled())

    {

      LogLog::debug((LogString) LOG4CXX_STR("Parsed \"")

        + appenderName + LOG4CXX_STR("\" options."));

    }

  }

  registryPut(appender);

  return appender;

}

void PropertyConfigurator::registryPut(const AppenderPtr& appender)

{

  (*registry)[appender->getName()] = appender;

}

AppenderPtr PropertyConfigurator::registryGet(const LogString& name)

{

  return (*registry)[name];

}