Move logging from QDebug to QCDebug and introduce LoggingCategories. (#5491)

* Move logging from QDebug to QCDebug and introduce LoggingCategories.

* Lint.

* Unlint like one change.

* Remove .debug category since this is autofilled by Qt and used to differentiate between QCDebug and QCWarning and QCError.

* Uncomment defaults, include main category.

* Make PictureLoader logging a bit more useful.

* Lint...?

* Address comments.

* Clean up some unnecessary classes in logging statements.

* Add a new message format to the logging handler.

* Lint.

* Lint.

* Support Windows in Regex

---------

Co-authored-by: Lukas Brübach <Bruebach.Lukas@bdosecurity.de>
Co-authored-by: ZeldaZach <zahalpern+github@gmail.com>

cockatrice/src/client/ui/picture_loader/picture_loader.cpp

@@ -15,11 +15,8 @@
 #include <QScreen>
 #include <QThread>
 #include <algorithm>
-#include <qloggingcategory.h>
 #include <utility>
 
-Q_LOGGING_CATEGORY(PictureLoaderLog, "picture_loader")
-
 // never cache more than 300 cards at once for a single deck
 #define CACHED_CARD_PER_DECK_MAX 300
 
@@ -52,7 +49,7 @@ void PictureLoader::getCardBackLoadingInProgressPixmap(QPixmap &pixmap, QSize si
 {
     QString backCacheKey = "_trice_card_back_" + QString::number(size.width()) + QString::number(size.height());
     if (!QPixmapCache::find(backCacheKey, &pixmap)) {
-        qCDebug(PictureLoaderLog) << "PictureLoader: cache fail for" << backCacheKey;
+        qCDebug(PictureLoaderCardBackCacheFailLog) << "PictureLoader: cache fail for" << backCacheKey;
         pixmap = QPixmap("theme:cardback").scaled(size, Qt::KeepAspectRatio, Qt::SmoothTransformation);
         QPixmapCache::insert(backCacheKey, pixmap);
     }
@@ -62,7 +59,7 @@ void PictureLoader::getCardBackLoadingFailedPixmap(QPixmap &pixmap, QSize size)
 {
     QString backCacheKey = "_trice_card_back_" + QString::number(size.width()) + QString::number(size.height());
     if (!QPixmapCache::find(backCacheKey, &pixmap)) {
-        qCDebug(PictureLoaderLog) << "PictureLoader: cache fail for" << backCacheKey;
+        qCDebug(PictureLoaderCardBackCacheFailLog) << "PictureLoader: cache fail for" << backCacheKey;
         pixmap = QPixmap("theme:cardback").scaled(size, Qt::KeepAspectRatio, Qt::SmoothTransformation);
         QPixmapCache::insert(backCacheKey, pixmap);
     }
@@ -92,6 +89,7 @@ void PictureLoader::getPixmap(QPixmap &pixmap, CardInfoPtr card, QSize size)
     }
 
     // add the card to the load queue
+    qCDebug(PictureLoaderLog) << "Enqueuing " << card->getName() << " for " << card->getPixmapCacheKey();
     getInstance().worker->enqueueImageLoad(card);
 }
 

cockatrice/src/client/ui/picture_loader/picture_loader.h

@@ -4,6 +4,11 @@
 #include "../../../game/cards/card_database.h"
 #include "picture_loader_worker.h"
 
+#include <QLoggingCategory>
+
+inline Q_LOGGING_CATEGORY(PictureLoaderLog, "picture_loader");
+inline Q_LOGGING_CATEGORY(PictureLoaderCardBackCacheFailLog, "picture_loader.card_back_cache_fail");
+
 class PictureLoader : public QObject
 {
     Q_OBJECT

cockatrice/src/client/ui/picture_loader/picture_loader_worker.cpp

@@ -5,14 +5,11 @@
 
 #include <QBuffer>
 #include <QDirIterator>
-#include <QLoggingCategory>
 #include <QMovie>
 #include <QNetworkDiskCache>
 #include <QNetworkReply>
 #include <QThread>
 
-Q_LOGGING_CATEGORY(PictureLoaderWorkerLog, "picture_loader.worker");
-
 // Card back returned by gatherer when card is not found
 QStringList PictureLoaderWorker::md5Blacklist = QStringList() << "db0c48db407a907c16ade38de048a441";
 
@@ -84,7 +81,7 @@ void PictureLoaderWorker::processLoadQueue()
         QString correctedCardName = cardBeingLoaded.getCard()->getCorrectedName();
 
         qCDebug(PictureLoaderWorkerLog).nospace()
-            << "PictureLoader: [card: " << cardName << " set: " << setName << "]: Trying to load picture";
+            << "[card: " << cardName << " set: " << setName << "]: Trying to load picture";
 
         if (CardDatabaseManager::getInstance()->isProviderIdForPreferredPrinting(
                 cardName, cardBeingLoaded.getCard()->getPixmapCacheKey())) {
@@ -93,8 +90,8 @@ void PictureLoaderWorker::processLoadQueue()
             }
         }
 
-        qCDebug(PictureLoaderWorkerLog).nospace() << "PictureLoader: [card: " << cardName << " set: " << setName
-                                                  << "]: No custom picture, trying to download";
+        qCDebug(PictureLoaderWorkerLog).nospace()
+            << "[card: " << cardName << " set: " << setName << "]: No custom picture, trying to download";
         cardsToDownload.append(cardBeingLoaded);
         cardBeingLoaded.clear();
         if (!downloadRunning) {
@@ -137,21 +134,21 @@ bool PictureLoaderWorker::cardImageExistsOnDisk(QString &setName, QString &corre
         imgReader.setFileName(_picsPath);
         if (imgReader.read(&image)) {
             qCDebug(PictureLoaderWorkerLog).nospace()
-                << "PictureLoader: [card: " << correctedCardname << " set: " << setName << "]: Picture found on disk.";
+                << "[card: " << correctedCardname << " set: " << setName << "]: Picture found on disk.";
             imageLoaded(cardBeingLoaded.getCard(), image);
             return true;
         }
         imgReader.setFileName(_picsPath + ".full");
         if (imgReader.read(&image)) {
-            qCDebug(PictureLoaderWorkerLog).nospace() << "PictureLoader: [card: " << correctedCardname
-                                                      << " set: " << setName << "]: Picture.full found on disk.";
+            qCDebug(PictureLoaderWorkerLog).nospace()
+                << "[card: " << correctedCardname << " set: " << setName << "]: Picture.full found on disk.";
             imageLoaded(cardBeingLoaded.getCard(), image);
             return true;
         }
         imgReader.setFileName(_picsPath + ".xlhq");
         if (imgReader.read(&image)) {
-            qCDebug(PictureLoaderWorkerLog).nospace() << "PictureLoader: [card: " << correctedCardname
-                                                      << " set: " << setName << "]: Picture.xlhq found on disk.";
+            qCDebug(PictureLoaderWorkerLog).nospace()
+                << "[card: " << correctedCardname << " set: " << setName << "]: Picture.xlhq found on disk.";
             imageLoaded(cardBeingLoaded.getCard(), image);
             return true;
         }
@@ -179,10 +176,9 @@ void PictureLoaderWorker::startNextPicDownload()
         picDownloadFailed();
     } else {
         QUrl url(picUrl);
-        qCDebug(PictureLoaderWorkerLog).nospace()
-            << "PictureLoader: [card: " << cardBeingDownloaded.getCard()->getCorrectedName()
-            << " set: " << cardBeingDownloaded.getSetName() << "]: Trying to fetch picture from url "
-            << url.toDisplayString();
+        qCDebug(PictureLoaderWorkerLog).nospace() << "[card: " << cardBeingDownloaded.getCard()->getCorrectedName()
+                                                  << " set: " << cardBeingDownloaded.getSetName()
+                                                  << "]: Trying to fetch picture from url " << url.toDisplayString();
         makeRequest(url);
     }
 }
@@ -199,7 +195,7 @@ void PictureLoaderWorker::picDownloadFailed()
         mutex.unlock();
     } else {
         qCDebug(PictureLoaderWorkerLog).nospace()
-            << "PictureLoader: [card: " << cardBeingDownloaded.getCard()->getCorrectedName()
+            << "[card: " << cardBeingDownloaded.getCard()->getCorrectedName()
             << " set: " << cardBeingDownloaded.getSetName() << "]: Picture NOT found, "
             << (picDownload ? "download failed" : "downloads disabled")
             << ", no more url combinations to try: BAILING OUT";
@@ -221,7 +217,7 @@ QNetworkReply *PictureLoaderWorker::makeRequest(const QUrl &url)
     QUrl cachedRedirect = getCachedRedirect(url);
     if (!cachedRedirect.isEmpty()) {
         qCDebug(PictureLoaderWorkerLog).nospace()
-            << "PictureLoader: [card: " << cardBeingDownloaded.getCard()->getCorrectedName()
+            << "[card: " << cardBeingDownloaded.getCard()->getCorrectedName()
             << " set: " << cardBeingDownloaded.getSetName() << "]: Using cached redirect for " << url.toDisplayString()
             << " to " << cachedRedirect.toDisplayString();
         return makeRequest(cachedRedirect); // Use the cached redirect
@@ -246,7 +242,7 @@ QNetworkReply *PictureLoaderWorker::makeRequest(const QUrl &url)
 
             cacheRedirect(url, redirectUrl);
             qCDebug(PictureLoaderWorkerLog).nospace()
-                << "PictureLoader: [card: " << cardBeingDownloaded.getCard()->getCorrectedName()
+                << "[card: " << cardBeingDownloaded.getCard()->getCorrectedName()
                 << " set: " << cardBeingDownloaded.getSetName() << "]: Caching redirect from " << url.toDisplayString()
                 << " to " << redirectUrl.toDisplayString();
         }
@@ -326,18 +322,18 @@ void PictureLoaderWorker::picDownloadFinished(QNetworkReply *reply)
     if (reply->error()) {
         if (isFromCache) {
             qCDebug(PictureLoaderWorkerLog).nospace()
-                << "PictureLoader: [card: " << cardBeingDownloaded.getCard()->getName()
-                << " set: " << cardBeingDownloaded.getSetName() << "]: Removing corrupted cache file for url "
-                << reply->url().toDisplayString() << " and retrying (" << reply->errorString() << ")";
+                << "[card: " << cardBeingDownloaded.getCard()->getName() << " set: " << cardBeingDownloaded.getSetName()
+                << "]: Removing corrupted cache file for url " << reply->url().toDisplayString() << " and retrying ("
+                << reply->errorString() << ")";
 
             networkManager->cache()->remove(reply->url());
 
             makeRequest(reply->url());
         } else {
             qCDebug(PictureLoaderWorkerLog).nospace()
-                << "PictureLoader: [card: " << cardBeingDownloaded.getCard()->getName()
-                << " set: " << cardBeingDownloaded.getSetName() << "]: " << (picDownload ? "Download" : "Cache search")
-                << " failed for url " << reply->url().toDisplayString() << " (" << reply->errorString() << ")";
+                << "[card: " << cardBeingDownloaded.getCard()->getName() << " set: " << cardBeingDownloaded.getSetName()
+                << "]: " << (picDownload ? "Download" : "Cache search") << " failed for url "
+                << reply->url().toDisplayString() << " (" << reply->errorString() << ")";
 
             picDownloadFailed();
             startNextPicDownload();
@@ -353,9 +349,9 @@ void PictureLoaderWorker::picDownloadFinished(QNetworkReply *reply)
         statusCode == 308) {
         QUrl redirectUrl = reply->header(QNetworkRequest::LocationHeader).toUrl();
         qCDebug(PictureLoaderWorkerLog).nospace()
-            << "PictureLoader: [card: " << cardBeingDownloaded.getCard()->getName()
-            << " set: " << cardBeingDownloaded.getSetName() << "]: following "
-            << (isFromCache ? "cached redirect" : "redirect") << " to " << redirectUrl.toDisplayString();
+            << "[card: " << cardBeingDownloaded.getCard()->getName() << " set: " << cardBeingDownloaded.getSetName()
+            << "]: following " << (isFromCache ? "cached redirect" : "redirect") << " to "
+            << redirectUrl.toDisplayString();
         makeRequest(redirectUrl);
         reply->deleteLater();
         return;
@@ -366,8 +362,7 @@ void PictureLoaderWorker::picDownloadFinished(QNetworkReply *reply)
 
     if (imageIsBlackListed(picData)) {
         qCDebug(PictureLoaderWorkerLog).nospace()
-            << "PictureLoader: [card: " << cardBeingDownloaded.getCard()->getName()
-            << " set: " << cardBeingDownloaded.getSetName()
+            << "[card: " << cardBeingDownloaded.getCard()->getName() << " set: " << cardBeingDownloaded.getSetName()
             << "]: Picture found, but blacklisted, will consider it as not found";
 
         picDownloadFailed();
@@ -402,18 +397,18 @@ void PictureLoaderWorker::picDownloadFinished(QNetworkReply *reply)
         logSuccessMessage = true;
     } else {
         qCDebug(PictureLoaderWorkerLog).nospace()
-            << "PictureLoader: [card: " << cardBeingDownloaded.getCard()->getName()
-            << " set: " << cardBeingDownloaded.getSetName() << "]: Possible " << (isFromCache ? "cached" : "downloaded")
-            << " picture at " << reply->url().toDisplayString() << " could not be loaded: " << reply->errorString();
+            << "[card: " << cardBeingDownloaded.getCard()->getName() << " set: " << cardBeingDownloaded.getSetName()
+            << "]: Possible " << (isFromCache ? "cached" : "downloaded") << " picture at "
+            << reply->url().toDisplayString() << " could not be loaded: " << reply->errorString();
 
         picDownloadFailed();
     }
 
     if (logSuccessMessage) {
         qCDebug(PictureLoaderWorkerLog).nospace()
-            << "PictureLoader: [card: " << cardBeingDownloaded.getCard()->getName()
-            << " set: " << cardBeingDownloaded.getSetName() << "]: Image successfully "
-            << (isFromCache ? "loaded from cached" : "downloaded from") << " url " << reply->url().toDisplayString();
+            << "[card: " << cardBeingDownloaded.getCard()->getName() << " set: " << cardBeingDownloaded.getSetName()
+            << "]: Image successfully " << (isFromCache ? "loaded from cached" : "downloaded from") << " url "
+            << reply->url().toDisplayString();
     }
 
     reply->deleteLater();

cockatrice/src/client/ui/picture_loader/picture_loader_worker.h

@@ -4,6 +4,7 @@
 #include "../../../game/cards/card_database.h"
 #include "picture_to_load.h"
 
+#include <QLoggingCategory>
 #include <QMutex>
 #include <QNetworkAccessManager>
 #include <QObject>
@@ -14,6 +15,8 @@
 #define REDIRECT_TIMESTAMP "timestamp"
 #define REDIRECT_CACHE_FILENAME "cache.ini"
 
+inline Q_LOGGING_CATEGORY(PictureLoaderWorkerLog, "picture_loader.worker");
+
 class PictureLoaderWorker : public QObject
 {
     Q_OBJECT

cockatrice/src/client/ui/picture_loader/picture_to_load.cpp

@@ -7,9 +7,6 @@
 #include <QRegularExpression>
 #include <QUrl>
 #include <algorithm>
-#include <qloggingcategory.h>
-
-Q_LOGGING_CATEGORY(PictureToLoadLog, "picture_loader.picture_to_load")
 
 PictureToLoad::PictureToLoad(CardInfoPtr _card)
     : card(std::move(_card)), urlTemplates(SettingsCache::instance().downloads().getAllURLs())

cockatrice/src/client/ui/picture_loader/picture_to_load.h

@@ -3,6 +3,10 @@
 
 #include "../../../game/cards/card_database.h"
 
+#include <QLoggingCategory>
+
+inline Q_LOGGING_CATEGORY(PictureToLoadLog, "picture_loader.picture_to_load");
+
 class PictureToLoad
 {
 private: