From eeacef61cacb035c2ac6aa6d59012a06002cf899 Mon Sep 17 00:00:00 2001
From: Janik Zikovsky <zikovskyjl@ornl.gov>
Date: Fri, 4 Mar 2011 22:56:10 +0000
Subject: [PATCH] Refs #2584: Can specify alternative log file path under
Linux. Logging configuration should be picked up from Mantid.user.properties
better than before.
---
.../Kernel/inc/MantidKernel/ConfigService.h | 7 +-
.../Kernel/inc/MantidKernel/Logger.h | 4 +-
.../Framework/Kernel/src/ConfigService.cpp | 80 ++++++++++++++++---
.../Framework/Kernel/test/ConfigServiceTest.h | 1 +
4 files changed, 75 insertions(+), 17 deletions(-)
diff --git a/Code/Mantid/Framework/Kernel/inc/MantidKernel/ConfigService.h b/Code/Mantid/Framework/Kernel/inc/MantidKernel/ConfigService.h
index 19871ce70ae..c27cb547749 100644
--- a/Code/Mantid/Framework/Kernel/inc/MantidKernel/ConfigService.h
+++ b/Code/Mantid/Framework/Kernel/inc/MantidKernel/ConfigService.h
@@ -177,6 +177,9 @@ namespace Mantid
/// Remove an observer
void removeObserver(const Poco::AbstractObserver& observer)const;
+ // Starts up the logging
+ void configureLogging();
+
private:
friend struct Mantid::Kernel::CreateUsingNew<ConfigServiceImpl>;
/// Handles distribution of Poco signals.
@@ -193,8 +196,6 @@ namespace Mantid
void loadConfig(const std::string& filename, const bool append=false);
/// Read a file and place its contents into the given string
bool readFile(const std::string& filename, std::string & contents) const;
- // Starts up the logging
- void configureLogging();
/// Provies a string of a default configuration
std::string defaultConfig() const;
/// Writes out a fresh user properties file
@@ -239,6 +240,8 @@ namespace Mantid
const std::string m_properties_file_name;
/// The filename of the Mantid user properties file
const std::string m_user_properties_file_name;
+ /// The filename where the log ends up
+ std::string m_logFilePath;
/// Store a list of data search paths
std::vector<std::string> m_DataSearchDirs;
/// Store a list of user search paths
diff --git a/Code/Mantid/Framework/Kernel/inc/MantidKernel/Logger.h b/Code/Mantid/Framework/Kernel/inc/MantidKernel/Logger.h
index d10efb970bb..526d0a3647e 100644
--- a/Code/Mantid/Framework/Kernel/inc/MantidKernel/Logger.h
+++ b/Code/Mantid/Framework/Kernel/inc/MantidKernel/Logger.h
@@ -30,7 +30,7 @@ class ThreadSafeLogStream;
/** @class Logger Logger.h Kernel/Logger.h
- The Logger class is in charge of the publishing messages from the framwork through
+ The Logger class is in charge of the publishing messages from the framework through
various channels. The static methods on the class are responsible for the creation
of Logger objects on request. This class currently uses the Logging functionality
provided through the POCO (portable components) library.
@@ -66,7 +66,7 @@ class ThreadSafeLogStream;
class DLLExport Logger
{
public:
- /// An emuration of the priority levels of a log message.
+ /// An enumeration of the priority levels of a log message.
enum Priority
{
PRIO_FATAL = 1, ///< A fatal error. The application will most likely terminate. This is the highest priority.
diff --git a/Code/Mantid/Framework/Kernel/src/ConfigService.cpp b/Code/Mantid/Framework/Kernel/src/ConfigService.cpp
index bed59176621..3f3e19c8fe9 100644
--- a/Code/Mantid/Framework/Kernel/src/ConfigService.cpp
+++ b/Code/Mantid/Framework/Kernel/src/ConfigService.cpp
@@ -174,6 +174,11 @@ ConfigServiceImpl::ConfigServiceImpl() :
g_log.debug() << "ConfigService created." << std::endl;
g_log.debug() << "Configured Mantid.properties directory of application as " << getPropertiesDir() << std::endl;
g_log.information() << "This is Mantid Version " << MANTID_VERSION << std::endl;
+ g_log.information() << "Logging to: " << m_logFilePath << std::endl;
+
+ // Make sure the log path is shown somewhere.
+ //std::cout << "Logging to: " << m_logFilePath << std::endl;
+
}
/** Private Destructor
@@ -278,29 +283,76 @@ bool ConfigServiceImpl::readFile(const std::string& filename, std::string & cont
return good;
}
-/// Configures the Poco logging and starts it up
+/** Configures the Poco logging and starts it up
+ *
+ */
void ConfigServiceImpl::configureLogging()
{
try
{
//Ensure that the logging directory exists
- Poco::Path logpath(getString("logging.channels.fileChannel.path"));
- if (logpath.toString().empty() || getUserPropertiesDir() != getPropertiesDir())
+ m_logFilePath = getString("logging.channels.fileChannel.path");
+
+ Poco::Path logpath(m_logFilePath);
+
+ // An absolute path makes things simpler
+ logpath = logpath.absolute();
+
+ // First, try the logpath give
+ if (!m_logFilePath.empty())
+ {
+ try
+ {
+ // Save it for later
+ m_logFilePath = logpath.toString();
+
+ //make this path point to the parent directory and create it if it does not exist
+ Poco::Path parent = logpath;
+ parent.makeParent();
+ Poco::File(parent).createDirectories();
+
+ // Try to create or append to the file. If it fails, use the default
+ FILE *fp = fopen(m_logFilePath.c_str(), "a+");
+ if (fp == NULL)
+ {
+ std::cerr << "Error writing to log file path given in properties file: \"" << m_logFilePath << "\". Will use a default path instead." << std::endl;
+ // Clear the path; this will make it use the default
+ m_logFilePath = "";
+ }
+ }
+ catch (std::exception &)
+ {
+ std::cerr << "Error writing to log file path given in properties file: \"" << m_logFilePath << "\". Will use a default path instead." << std::endl;
+ // ERROR! Maybe the file is not writable!
+ // Clear the path; this will make it use the default
+ m_logFilePath = "";
+ }
+ }
+
+ // The path given was invalid somehow? Use a default
+ if (m_logFilePath.empty())
{
- std::string logfile = getUserPropertiesDir() + "mantid.log";
- logpath.assign(logfile);
- m_pConf->setString("logging.channels.fileChannel.path", logfile);
+ m_logFilePath = getUserPropertiesDir() + "mantid.log";
+ logpath.assign(m_logFilePath);
+ logpath = logpath.absolute();
+ m_logFilePath = logpath.toString();
}
+ // Set the line in the configuration properties.
+ // this'll be picked up by LoggingConfigurator (somehow)
+ m_pConf->setString("logging.channels.fileChannel.path", m_logFilePath);
+
//make this path point to the parent directory and create it if it does not exist
logpath.makeParent();
if (!logpath.toString().empty())
{
- Poco::File(logpath).createDirectory();
+ Poco::File(logpath).createDirectories(); // Also creates all necessary directories
}
- //configure the logging framework
+
+ // Configure the logging framework
Poco::Util::LoggingConfigurator configurator;
configurator.configure(m_pConf);
- } catch (std::exception& e)
+ }
+ catch (std::exception& e)
{
std::cerr << "Trouble configuring the logging framework " << e.what() << std::endl;
}
@@ -547,10 +599,12 @@ std::string ConfigServiceImpl::defaultConfig() const
void ConfigServiceImpl::updateConfig(const std::string& filename, const bool append,
const bool update_caches)
{
+ //std::cout << "Properties file loaded: " << filename << std::endl;
loadConfig(filename, append);
- configureLogging();
if (update_caches)
{
+ // Only configure logging once
+ configureLogging();
//Ensure that any relative paths given in the configuration file are relative to the correct directory
convertRelativeToAbsolute();
//Configure search paths into a specially saved store as they will be used frequently
@@ -588,9 +642,9 @@ void ConfigServiceImpl::saveConfig(const std::string & filename) const
char last = *(file_line.end() - 1);
if (last == '\\')
{
- // If we are not in line continuation mode then need
- // a fresh start line
- if( !line_continuing ) output = "";
+ // If we are not in line continuation mode then need
+ // a fresh start line
+ if( !line_continuing ) output = "";
line_continuing = true;
output += file_line + "\n";
continue;
diff --git a/Code/Mantid/Framework/Kernel/test/ConfigServiceTest.h b/Code/Mantid/Framework/Kernel/test/ConfigServiceTest.h
index 98a98be27de..f90d15c74eb 100644
--- a/Code/Mantid/Framework/Kernel/test/ConfigServiceTest.h
+++ b/Code/Mantid/Framework/Kernel/test/ConfigServiceTest.h
@@ -282,6 +282,7 @@ public:
}
+
protected:
bool m_valueChangedSent;
std::string m_key;
--
GitLab