Differentiate logging in order to silence certain modules. (#5419)

* Differentiate logging in order to silence certain modules.

* Lint cmake.

---------

Co-authored-by: Lukas Brübach <Bruebach.Lukas@bdosecurity.de>
This commit is contained in:
BruebachL 2025-01-05 23:38:51 +01:00 committed by GitHub
parent 38e99f2e87
commit 9c38c9ed1b
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
6 changed files with 81 additions and 61 deletions

1
.gitignore vendored
View file

@ -13,3 +13,4 @@ compile_commands.json
.vscode/ .vscode/
.cache .cache
.gdb_history .gdb_history
cockatrice/resources/config/qtlogging.ini

View file

@ -164,6 +164,9 @@ set(cockatrice_SOURCES
add_subdirectory(sounds) add_subdirectory(sounds)
add_subdirectory(themes) add_subdirectory(themes)
configure_file(
${CMAKE_SOURCE_DIR}/cockatrice/resources/config/qtlogging.ini ${CMAKE_BINARY_DIR}/cockatrice/qtlogging.ini COPYONLY
)
set(cockatrice_RESOURCES cockatrice.qrc) set(cockatrice_RESOURCES cockatrice.qrc)

View file

@ -42,6 +42,7 @@
<file>resources/config/shorcuts.svg</file> <file>resources/config/shorcuts.svg</file>
<file>resources/config/sound.svg</file> <file>resources/config/sound.svg</file>
<file>resources/config/debug.ini</file> <file>resources/config/debug.ini</file>
<file>resources/config/qtlogging.ini</file>
<file>resources/counters/w.svg</file> <file>resources/counters/w.svg</file>
<file>resources/counters/w_highlight.svg</file> <file>resources/counters/w_highlight.svg</file>

View file

@ -0,0 +1,2 @@
[Rules]
picture_loader.debug = true

View file

@ -23,8 +23,11 @@
#include <QThread> #include <QThread>
#include <QUrl> #include <QUrl>
#include <algorithm> #include <algorithm>
#include <qloggingcategory.h>
#include <utility> #include <utility>
Q_LOGGING_CATEGORY(PictureLoaderLog, "picture_loader")
// never cache more than 300 cards at once for a single deck // never cache more than 300 cards at once for a single deck
#define CACHED_CARD_PER_DECK_MAX 300 #define CACHED_CARD_PER_DECK_MAX 300
@ -189,8 +192,8 @@ void PictureLoaderWorker::processLoadQueue()
QString cardName = cardBeingLoaded.getCard()->getName(); QString cardName = cardBeingLoaded.getCard()->getName();
QString correctedCardName = cardBeingLoaded.getCard()->getCorrectedName(); QString correctedCardName = cardBeingLoaded.getCard()->getCorrectedName();
qDebug().nospace() << "PictureLoader: [card: " << cardName << " set: " << setName qCDebug(PictureLoaderLog).nospace()
<< "]: Trying to load picture"; << "PictureLoader: [card: " << cardName << " set: " << setName << "]: Trying to load picture";
if (CardDatabaseManager::getInstance()->isProviderIdForPreferredPrinting( if (CardDatabaseManager::getInstance()->isProviderIdForPreferredPrinting(
cardName, cardBeingLoaded.getCard()->getPixmapCacheKey())) { cardName, cardBeingLoaded.getCard()->getPixmapCacheKey())) {
@ -199,8 +202,8 @@ void PictureLoaderWorker::processLoadQueue()
} }
} }
qDebug().nospace() << "PictureLoader: [card: " << cardName << " set: " << setName qCDebug(PictureLoaderLog).nospace() << "PictureLoader: [card: " << cardName << " set: " << setName
<< "]: No custom picture, trying to download"; << "]: No custom picture, trying to download";
cardsToDownload.append(cardBeingLoaded); cardsToDownload.append(cardBeingLoaded);
cardBeingLoaded.clear(); cardBeingLoaded.clear();
if (!downloadRunning) { if (!downloadRunning) {
@ -242,22 +245,22 @@ bool PictureLoaderWorker::cardImageExistsOnDisk(QString &setName, QString &corre
for (const auto &_picsPath : picsPaths) { for (const auto &_picsPath : picsPaths) {
imgReader.setFileName(_picsPath); imgReader.setFileName(_picsPath);
if (imgReader.read(&image)) { if (imgReader.read(&image)) {
qDebug().nospace() << "PictureLoader: [card: " << correctedCardname << " set: " << setName qCDebug(PictureLoaderLog).nospace()
<< "]: Picture found on disk."; << "PictureLoader: [card: " << correctedCardname << " set: " << setName << "]: Picture found on disk.";
imageLoaded(cardBeingLoaded.getCard(), image); imageLoaded(cardBeingLoaded.getCard(), image);
return true; return true;
} }
imgReader.setFileName(_picsPath + ".full"); imgReader.setFileName(_picsPath + ".full");
if (imgReader.read(&image)) { if (imgReader.read(&image)) {
qDebug().nospace() << "PictureLoader: [card: " << correctedCardname << " set: " << setName qCDebug(PictureLoaderLog).nospace() << "PictureLoader: [card: " << correctedCardname << " set: " << setName
<< "]: Picture.full found on disk."; << "]: Picture.full found on disk.";
imageLoaded(cardBeingLoaded.getCard(), image); imageLoaded(cardBeingLoaded.getCard(), image);
return true; return true;
} }
imgReader.setFileName(_picsPath + ".xlhq"); imgReader.setFileName(_picsPath + ".xlhq");
if (imgReader.read(&image)) { if (imgReader.read(&image)) {
qDebug().nospace() << "PictureLoader: [card: " << correctedCardname << " set: " << setName qCDebug(PictureLoaderLog).nospace() << "PictureLoader: [card: " << correctedCardname << " set: " << setName
<< "]: Picture.xlhq found on disk."; << "]: Picture.xlhq found on disk.";
imageLoaded(cardBeingLoaded.getCard(), image); imageLoaded(cardBeingLoaded.getCard(), image);
return true; return true;
} }
@ -303,18 +306,19 @@ static int parse(const QString &urlTemplate,
} }
QString propertyValue = getProperty(cardPropertyName); QString propertyValue = getProperty(cardPropertyName);
if (propertyValue.isEmpty()) { if (propertyValue.isEmpty()) {
qDebug().nospace() << "PictureLoader: [card: " << cardName << " set: " << setName << "]: Requested " qCDebug(PictureLoaderLog).nospace()
<< propType << "property (" << cardPropertyName << ") for Url template (" << urlTemplate << "PictureLoader: [card: " << cardName << " set: " << setName << "]: Requested " << propType
<< ") is not available"; << "property (" << cardPropertyName << ") for Url template (" << urlTemplate << ") is not available";
return 1; return 1;
} else { } else {
int propLength = propertyValue.length(); int propLength = propertyValue.length();
if (subStrLen > 0) { if (subStrLen > 0) {
if (subStrPos + subStrLen > propLength) { if (subStrPos + subStrLen > propLength) {
qDebug().nospace() << "PictureLoader: [card: " << cardName << " set: " << setName << "]: Requested " qCDebug(PictureLoaderLog).nospace()
<< propType << " property (" << cardPropertyName << ") for Url template (" << "PictureLoader: [card: " << cardName << " set: " << setName << "]: Requested " << propType
<< urlTemplate << ") is smaller than substr specification (" << subStrPos << " property (" << cardPropertyName << ") for Url template (" << urlTemplate
<< " + " << subStrLen << " > " << propLength << ")"; << ") is smaller than substr specification (" << subStrPos << " + " << subStrLen << " > "
<< propLength << ")";
return 1; return 1;
} else { } else {
propertyValue = propertyValue.mid(subStrPos, subStrLen); propertyValue = propertyValue.mid(subStrPos, subStrLen);
@ -325,9 +329,10 @@ static int parse(const QString &urlTemplate,
if (!fillWith.isEmpty()) { if (!fillWith.isEmpty()) {
int fillLength = fillWith.length(); int fillLength = fillWith.length();
if (fillLength < propLength) { if (fillLength < propLength) {
qDebug().nospace() << "PictureLoader: [card: " << cardName << " set: " << setName << "]: Requested " qCDebug(PictureLoaderLog).nospace()
<< propType << " property (" << cardPropertyName << ") for Url template (" << "PictureLoader: [card: " << cardName << " set: " << setName << "]: Requested " << propType
<< urlTemplate << ") is longer than fill specification (" << fillWith << ")"; << " property (" << cardPropertyName << ") for Url template (" << urlTemplate
<< ") is longer than fill specification (" << fillWith << ")";
return 1; return 1;
} else { } else {
@ -394,9 +399,9 @@ QString PictureToLoad::transformUrl(const QString &urlTemplate) const
* populated in this card, so it should return an empty string, * populated in this card, so it should return an empty string,
* indicating an invalid Url. * indicating an invalid Url.
*/ */
qDebug().nospace() << "PictureLoader: [card: " << cardName << " set: " << setName qCDebug(PictureLoaderLog).nospace()
<< "]: Requested information (" << prop << ") for Url template (" << urlTemplate << "PictureLoader: [card: " << cardName << " set: " << setName << "]: Requested information ("
<< ") is not available"; << prop << ") for Url template (" << urlTemplate << ") is not available";
return QString(); return QString();
} }
} }
@ -424,9 +429,10 @@ void PictureLoaderWorker::startNextPicDownload()
picDownloadFailed(); picDownloadFailed();
} else { } else {
QUrl url(picUrl); QUrl url(picUrl);
qDebug().nospace() << "PictureLoader: [card: " << cardBeingDownloaded.getCard()->getCorrectedName() qCDebug(PictureLoaderLog).nospace()
<< " set: " << cardBeingDownloaded.getSetName() << "]: Trying to fetch picture from url " << "PictureLoader: [card: " << cardBeingDownloaded.getCard()->getCorrectedName()
<< url.toDisplayString(); << " set: " << cardBeingDownloaded.getSetName() << "]: Trying to fetch picture from url "
<< url.toDisplayString();
makeRequest(url); makeRequest(url);
} }
} }
@ -442,10 +448,11 @@ void PictureLoaderWorker::picDownloadFailed()
loadQueue.prepend(cardBeingDownloaded); loadQueue.prepend(cardBeingDownloaded);
mutex.unlock(); mutex.unlock();
} else { } else {
qDebug().nospace() << "PictureLoader: [card: " << cardBeingDownloaded.getCard()->getCorrectedName() qCDebug(PictureLoaderLog).nospace()
<< " set: " << cardBeingDownloaded.getSetName() << "]: Picture NOT found, " << "PictureLoader: [card: " << cardBeingDownloaded.getCard()->getCorrectedName()
<< (picDownload ? "download failed" : "downloads disabled") << " set: " << cardBeingDownloaded.getSetName() << "]: Picture NOT found, "
<< ", no more url combinations to try: BAILING OUT"; << (picDownload ? "download failed" : "downloads disabled")
<< ", no more url combinations to try: BAILING OUT";
imageLoaded(cardBeingDownloaded.getCard(), QImage()); imageLoaded(cardBeingDownloaded.getCard(), QImage());
cardBeingDownloaded.clear(); cardBeingDownloaded.clear();
} }
@ -463,9 +470,10 @@ QNetworkReply *PictureLoaderWorker::makeRequest(const QUrl &url)
// Check if the redirect is cached // Check if the redirect is cached
QUrl cachedRedirect = getCachedRedirect(url); QUrl cachedRedirect = getCachedRedirect(url);
if (!cachedRedirect.isEmpty()) { if (!cachedRedirect.isEmpty()) {
qDebug().nospace() << "PictureLoader: [card: " << cardBeingDownloaded.getCard()->getCorrectedName() qCDebug(PictureLoaderLog).nospace()
<< " set: " << cardBeingDownloaded.getSetName() << "]: Using cached redirect for " << "PictureLoader: [card: " << cardBeingDownloaded.getCard()->getCorrectedName()
<< url.toDisplayString() << " to " << cachedRedirect.toDisplayString(); << " set: " << cardBeingDownloaded.getSetName() << "]: Using cached redirect for " << url.toDisplayString()
<< " to " << cachedRedirect.toDisplayString();
return makeRequest(cachedRedirect); // Use the cached redirect return makeRequest(cachedRedirect); // Use the cached redirect
} }
@ -487,9 +495,10 @@ QNetworkReply *PictureLoaderWorker::makeRequest(const QUrl &url)
} }
cacheRedirect(url, redirectUrl); cacheRedirect(url, redirectUrl);
qDebug().nospace() << "PictureLoader: [card: " << cardBeingDownloaded.getCard()->getCorrectedName() qCDebug(PictureLoaderLog).nospace()
<< " set: " << cardBeingDownloaded.getSetName() << "]: Caching redirect from " << "PictureLoader: [card: " << cardBeingDownloaded.getCard()->getCorrectedName()
<< url.toDisplayString() << " to " << redirectUrl.toDisplayString(); << " set: " << cardBeingDownloaded.getSetName() << "]: Caching redirect from " << url.toDisplayString()
<< " to " << redirectUrl.toDisplayString();
} }
reply->deleteLater(); reply->deleteLater();
@ -566,19 +575,19 @@ void PictureLoaderWorker::picDownloadFinished(QNetworkReply *reply)
if (reply->error()) { if (reply->error()) {
if (isFromCache) { if (isFromCache) {
qDebug().nospace() << "PictureLoader: [card: " << cardBeingDownloaded.getCard()->getName() qCDebug(PictureLoaderLog).nospace()
<< " set: " << cardBeingDownloaded.getSetName() << "PictureLoader: [card: " << cardBeingDownloaded.getCard()->getName()
<< "]: Removing corrupted cache file for url " << reply->url().toDisplayString() << " set: " << cardBeingDownloaded.getSetName() << "]: Removing corrupted cache file for url "
<< " and retrying (" << reply->errorString() << ")"; << reply->url().toDisplayString() << " and retrying (" << reply->errorString() << ")";
networkManager->cache()->remove(reply->url()); networkManager->cache()->remove(reply->url());
makeRequest(reply->url()); makeRequest(reply->url());
} else { } else {
qDebug().nospace() << "PictureLoader: [card: " << cardBeingDownloaded.getCard()->getName() qCDebug(PictureLoaderLog).nospace()
<< " set: " << cardBeingDownloaded.getSetName() << "PictureLoader: [card: " << cardBeingDownloaded.getCard()->getName()
<< "]: " << (picDownload ? "Download" : "Cache search") << " failed for url " << " set: " << cardBeingDownloaded.getSetName() << "]: " << (picDownload ? "Download" : "Cache search")
<< reply->url().toDisplayString() << " (" << reply->errorString() << ")"; << " failed for url " << reply->url().toDisplayString() << " (" << reply->errorString() << ")";
picDownloadFailed(); picDownloadFailed();
startNextPicDownload(); startNextPicDownload();
@ -593,9 +602,10 @@ void PictureLoaderWorker::picDownloadFinished(QNetworkReply *reply)
if (statusCode == 301 || statusCode == 302 || statusCode == 303 || statusCode == 305 || statusCode == 307 || if (statusCode == 301 || statusCode == 302 || statusCode == 303 || statusCode == 305 || statusCode == 307 ||
statusCode == 308) { statusCode == 308) {
QUrl redirectUrl = reply->header(QNetworkRequest::LocationHeader).toUrl(); QUrl redirectUrl = reply->header(QNetworkRequest::LocationHeader).toUrl();
qDebug().nospace() << "PictureLoader: [card: " << cardBeingDownloaded.getCard()->getName() qCDebug(PictureLoaderLog).nospace()
<< " set: " << cardBeingDownloaded.getSetName() << "]: following " << "PictureLoader: [card: " << cardBeingDownloaded.getCard()->getName()
<< (isFromCache ? "cached redirect" : "redirect") << " to " << redirectUrl.toDisplayString(); << " set: " << cardBeingDownloaded.getSetName() << "]: following "
<< (isFromCache ? "cached redirect" : "redirect") << " to " << redirectUrl.toDisplayString();
makeRequest(redirectUrl); makeRequest(redirectUrl);
reply->deleteLater(); reply->deleteLater();
return; return;
@ -605,9 +615,9 @@ void PictureLoaderWorker::picDownloadFinished(QNetworkReply *reply)
const QByteArray &picData = reply->peek(reply->size()); const QByteArray &picData = reply->peek(reply->size());
if (imageIsBlackListed(picData)) { if (imageIsBlackListed(picData)) {
qDebug().nospace() << "PictureLoader: [card: " << cardBeingDownloaded.getCard()->getName() qCDebug(PictureLoaderLog).nospace() << "PictureLoader: [card: " << cardBeingDownloaded.getCard()->getName()
<< " set: " << cardBeingDownloaded.getSetName() << " set: " << cardBeingDownloaded.getSetName()
<< "]: Picture found, but blacklisted, will consider it as not found"; << "]: Picture found, but blacklisted, will consider it as not found";
picDownloadFailed(); picDownloadFailed();
reply->deleteLater(); reply->deleteLater();
@ -640,19 +650,19 @@ void PictureLoaderWorker::picDownloadFinished(QNetworkReply *reply)
imageLoaded(cardBeingDownloaded.getCard(), testImage); imageLoaded(cardBeingDownloaded.getCard(), testImage);
logSuccessMessage = true; logSuccessMessage = true;
} else { } else {
qDebug().nospace() << "PictureLoader: [card: " << cardBeingDownloaded.getCard()->getName() qCDebug(PictureLoaderLog).nospace()
<< " set: " << cardBeingDownloaded.getSetName() << "]: Possible " << "PictureLoader: [card: " << cardBeingDownloaded.getCard()->getName()
<< (isFromCache ? "cached" : "downloaded") << " picture at " << " set: " << cardBeingDownloaded.getSetName() << "]: Possible " << (isFromCache ? "cached" : "downloaded")
<< reply->url().toDisplayString() << " could not be loaded: " << reply->errorString(); << " picture at " << reply->url().toDisplayString() << " could not be loaded: " << reply->errorString();
picDownloadFailed(); picDownloadFailed();
} }
if (logSuccessMessage) { if (logSuccessMessage) {
qDebug().nospace() << "PictureLoader: [card: " << cardBeingDownloaded.getCard()->getName() qCDebug(PictureLoaderLog).nospace()
<< " set: " << cardBeingDownloaded.getSetName() << "]: Image successfully " << "PictureLoader: [card: " << cardBeingDownloaded.getCard()->getName()
<< (isFromCache ? "loaded from cached" : "downloaded from") << " url " << " set: " << cardBeingDownloaded.getSetName() << "]: Image successfully "
<< reply->url().toDisplayString(); << (isFromCache ? "loaded from cached" : "downloaded from") << " url " << reply->url().toDisplayString();
} }
reply->deleteLater(); reply->deleteLater();
@ -719,7 +729,7 @@ void PictureLoader::getCardBackPixmap(QPixmap &pixmap, QSize size)
{ {
QString backCacheKey = "_trice_card_back_" + QString::number(size.width()) + QString::number(size.height()); QString backCacheKey = "_trice_card_back_" + QString::number(size.width()) + QString::number(size.height());
if (!QPixmapCache::find(backCacheKey, &pixmap)) { if (!QPixmapCache::find(backCacheKey, &pixmap)) {
qDebug() << "PictureLoader: cache fail for" << backCacheKey; qCDebug(PictureLoaderLog) << "PictureLoader: cache fail for" << backCacheKey;
pixmap = QPixmap("theme:cardback").scaled(size, Qt::KeepAspectRatio, Qt::SmoothTransformation); pixmap = QPixmap("theme:cardback").scaled(size, Qt::KeepAspectRatio, Qt::SmoothTransformation);
QPixmapCache::insert(backCacheKey, pixmap); QPixmapCache::insert(backCacheKey, pixmap);
} }
@ -729,7 +739,7 @@ void PictureLoader::getCardBackLoadingInProgressPixmap(QPixmap &pixmap, QSize si
{ {
QString backCacheKey = "_trice_card_back_" + QString::number(size.width()) + QString::number(size.height()); QString backCacheKey = "_trice_card_back_" + QString::number(size.width()) + QString::number(size.height());
if (!QPixmapCache::find(backCacheKey, &pixmap)) { if (!QPixmapCache::find(backCacheKey, &pixmap)) {
qDebug() << "PictureLoader: cache fail for" << backCacheKey; qCDebug(PictureLoaderLog) << "PictureLoader: cache fail for" << backCacheKey;
pixmap = QPixmap("theme:cardback").scaled(size, Qt::KeepAspectRatio, Qt::SmoothTransformation); pixmap = QPixmap("theme:cardback").scaled(size, Qt::KeepAspectRatio, Qt::SmoothTransformation);
QPixmapCache::insert(backCacheKey, pixmap); QPixmapCache::insert(backCacheKey, pixmap);
} }
@ -739,7 +749,7 @@ void PictureLoader::getCardBackLoadingFailedPixmap(QPixmap &pixmap, QSize size)
{ {
QString backCacheKey = "_trice_card_back_" + QString::number(size.width()) + QString::number(size.height()); QString backCacheKey = "_trice_card_back_" + QString::number(size.width()) + QString::number(size.height());
if (!QPixmapCache::find(backCacheKey, &pixmap)) { if (!QPixmapCache::find(backCacheKey, &pixmap)) {
qDebug() << "PictureLoader: cache fail for" << backCacheKey; qCDebug(PictureLoaderLog) << "PictureLoader: cache fail for" << backCacheKey;
pixmap = QPixmap("theme:cardback").scaled(size, Qt::KeepAspectRatio, Qt::SmoothTransformation); pixmap = QPixmap("theme:cardback").scaled(size, Qt::KeepAspectRatio, Qt::SmoothTransformation);
QPixmapCache::insert(backCacheKey, pixmap); QPixmapCache::insert(backCacheKey, pixmap);
} }

View file

@ -136,6 +136,9 @@ int main(int argc, char *argv[])
SetUnhandledExceptionFilter(CockatriceUnhandledExceptionFilter); SetUnhandledExceptionFilter(CockatriceUnhandledExceptionFilter);
#endif #endif
// Set the QT_LOGGING_CONF environment variable
qputenv("QT_LOGGING_CONF", "./qtlogging.ini");
QApplication app(argc, argv); QApplication app(argc, argv);
QObject::connect(&app, &QApplication::lastWindowClosed, &app, &QApplication::quit); QObject::connect(&app, &QApplication::lastWindowClosed, &app, &QApplication::quit);