diff options
author | Kai Koehne <kai.koehne@digia.com> | 2014-02-04 16:35:26 +0100 |
---|---|---|
committer | The Qt Project <gerrit-noreply@qt-project.org> | 2014-02-11 20:59:15 +0100 |
commit | a2bfd114938e1fdd5067f2dac812a8d3a5d89fd3 (patch) | |
tree | 3a0341ab6973bc827c7e2c0f4787f23820d7adb3 /src/corelib/io/qloggingregistry.cpp | |
parent | dc09a02e3a4ea93388197d7f8a0cfebe194e9886 (diff) |
Allow configuration of logging rules from file system
Allow configuration of logging rules from outside of the application,
either through a configuration file (.config/QtProject/qtlogging.ini),
or through a file specified by a QT_LOGGING_CONF environment
variable.
The logging rules from the different sources are concatenated: First
the rules from QtProject/qtlogging.ini are applied, then
QLoggingCategory::setLoggingRules(), finally from the environment.
This allows an application to overwrite/augment the system wide rules,
and in turn that can be tailored for a specific run by setting a
configuration in the environment variable.
[ChangeLog][QtCore][Logging] The logging framework can now be configured
with an .ini file.
Change-Id: I442efde1b7e0a2ebe135c6f6e0a4b656483fe4b1
Reviewed-by: Thiago Macieira <thiago.macieira@intel.com>
Diffstat (limited to 'src/corelib/io/qloggingregistry.cpp')
-rw-r--r-- | src/corelib/io/qloggingregistry.cpp | 129 |
1 files changed, 101 insertions, 28 deletions
diff --git a/src/corelib/io/qloggingregistry.cpp b/src/corelib/io/qloggingregistry.cpp index fd25ff697e..b8fef16c0e 100644 --- a/src/corelib/io/qloggingregistry.cpp +++ b/src/corelib/io/qloggingregistry.cpp @@ -42,6 +42,10 @@ #include "qloggingregistry_p.h" #include "qloggingcategory_p.h" +#include <QtCore/qfile.h> +#include <QtCore/qstandardpaths.h> +#include <QtCore/qtextstream.h> + QT_BEGIN_NAMESPACE Q_GLOBAL_STATIC(QLoggingRegistry, qtLoggingRegistry) @@ -150,33 +154,38 @@ void QLoggingRule::parse() } /*! + \class QLoggingSettingsParser + \since 5.3 \internal - Creates a new QLoggingRules object. + + Parses a .ini file with the following format: + + [rules] + rule1=[true|false] + rule2=[true|false] + ... + + [rules] is the default section, and therefore optional. */ -QLoggingRulesParser::QLoggingRulesParser(QLoggingRegistry *registry) : - registry(registry) -{ -} /*! \internal - Sets logging rules string. + Parses configuration from \a content. */ -void QLoggingRulesParser::setRules(const QString &content) +void QLoggingSettingsParser::setContent(const QString &content) { QString content_ = content; QTextStream stream(&content_, QIODevice::ReadOnly); - parseRules(stream); + setContent(stream); } /*! \internal - Parses rules out of a QTextStream. + Parses configuration from \a stream. */ -void QLoggingRulesParser::parseRules(QTextStream &stream) +void QLoggingSettingsParser::setContent(QTextStream &stream) { - QVector<QLoggingRule> rules; - + _rules.clear(); while (!stream.atEnd()) { QString line = stream.readLine(); @@ -184,31 +193,79 @@ void QLoggingRulesParser::parseRules(QTextStream &stream) line = line.simplified(); line.remove(QLatin1Char(' ')); - const QStringList pair = line.split(QLatin1Char('=')); - if (pair.count() == 2) { - const QString pattern = pair.at(0); - bool enabled = (QString::compare(pair.at(1), - QLatin1String("true"), - Qt::CaseInsensitive) == 0); - rules.append(QLoggingRule(pattern, enabled)); + // comment + if (line.startsWith(QLatin1Char(';'))) + continue; + + if (line.startsWith(QLatin1Char('[')) && line.endsWith(QLatin1Char(']'))) { + // new section + _section = line.mid(1, line.size() - 2); + continue; } - } - registry->setRules(rules); + if (_section == QLatin1String("rules")) { + int equalPos = line.indexOf(QLatin1Char('=')); + if ((equalPos != -1) + && (line.lastIndexOf(QLatin1Char('=')) == equalPos)) { + const QString pattern = line.left(equalPos); + const QStringRef value = line.midRef(equalPos + 1); + bool enabled = (value.compare(QLatin1String("true"), + Qt::CaseInsensitive) == 0); + _rules.append(QLoggingRule(pattern, enabled)); + } + } + } } /*! \internal - QLoggingPrivate constructor + QLoggingRegistry constructor */ QLoggingRegistry::QLoggingRegistry() - : rulesParser(this), - categoryFilter(defaultCategoryFilter) + : categoryFilter(defaultCategoryFilter) { } /*! \internal + Initializes the rules database by loading + .config/QtProject/qtlogging.ini and $QT_LOGGING_CONF. + */ +void QLoggingRegistry::init() +{ + // get rules from environment + const QByteArray rulesFilePath = qgetenv("QT_LOGGING_CONF"); + if (!rulesFilePath.isEmpty()) { + QFile file(QFile::decodeName(rulesFilePath)); + if (file.open(QIODevice::ReadOnly | QIODevice::Text)) { + QTextStream stream(&file); + QLoggingSettingsParser parser; + parser.setContent(stream); + envRules = parser.rules(); + } + } + + // get rules from qt configuration + QString envPath = QStandardPaths::locate(QStandardPaths::GenericConfigLocation, + QStringLiteral("QtProject/qtlogging.ini")); + if (!envPath.isEmpty()) { + QFile file(envPath); + if (file.open(QIODevice::ReadOnly | QIODevice::Text)) { + QTextStream stream(&file); + QLoggingSettingsParser parser; + parser.setContent(stream); + configRules = parser.rules(); + } + } + + if (!envRules.isEmpty() || !configRules.isEmpty()) { + QMutexLocker locker(®istryMutex); + updateRules(); + } +} + +/*! + \internal Registers a category object. This method might be called concurrently for the same category object. @@ -236,17 +293,33 @@ void QLoggingRegistry::unregisterCategory(QLoggingCategory *cat) /*! \internal - Activates a new set of logging rules for the default filter. -*/ -void QLoggingRegistry::setRules(const QVector<QLoggingRule> &rules_) + Installs logging rules as specified in \a content. + */ +void QLoggingRegistry::setApiRules(const QString &content) { + QLoggingSettingsParser parser; + parser.setSection(QStringLiteral("rules")); + parser.setContent(content); + QMutexLocker locker(®istryMutex); + apiRules = parser.rules(); - rules = rules_; + updateRules(); +} +/*! + \internal + Activates a new set of logging rules for the default filter. + + (The caller must lock registryMutex to make sure the API is thread safe.) +*/ +void QLoggingRegistry::updateRules() +{ if (categoryFilter != defaultCategoryFilter) return; + rules = configRules + apiRules + envRules; + foreach (QLoggingCategory *cat, categories) (*categoryFilter)(cat); } |