Merge PR #370: Prevent multiple finish calls on API objects

libnymea-core/nymeacore.cpp

@@ -606,7 +606,7 @@ QStringList NymeaCore::getAvailableLanguages()
 
 QStringList NymeaCore::loggingFilters()
 {
-    return s_nymeaLoggingCategories;
+    return nymeaLoggingCategories();
 }
 
 QStringList NymeaCore::loggingFiltersPlugins()

libnymea/integrations/browseractioninfo.cpp

@@ -33,6 +33,8 @@
 
 #include <QTimer>
 
+Q_DECLARE_LOGGING_CATEGORY(dcIntegrations)
+
 BrowserActionInfo::BrowserActionInfo(Thing *thing, ThingManager *thingManager, const BrowserAction &browserAction, QObject *parent, quint32 timeout):
     QObject (parent),
     m_thing(thing),
@@ -85,6 +87,10 @@ QString BrowserActionInfo::translatedDisplayMessage(const QLocale &locale)
 
 void BrowserActionInfo::finish(Thing::ThingError status, const QString &displayMessage)
 {
+    if (m_finished) {
+        qCWarning(dcIntegrations()) << "BrowserActionInfo::finish() called on an already finished object.";
+        return;
+    }
     m_finished = true;
     m_status = status;
     m_displayMessage = displayMessage;

libnymea/integrations/browseresult.cpp

@@ -33,6 +33,8 @@
 
 #include <QTimer>
 
+Q_DECLARE_LOGGING_CATEGORY(dcIntegrations)
+
 BrowseResult::BrowseResult(Thing *thing, ThingManager *thingManager, const QString &itemId, const QLocale &locale, QObject *parent, quint32 timeout):
     QObject(parent),
     m_thing(thing),
@@ -106,6 +108,10 @@ void BrowseResult::addItems(const BrowserItems &items)
 
 void BrowseResult::finish(Thing::ThingError status, const QString &displayMessage)
 {
+    if (m_finished) {
+        qCWarning(dcIntegrations()) << "BrowseResult::finish() called on an already finished object.";
+        return;
+    }
     m_finished = true;
     m_status = status;
     m_displayMessage = displayMessage;

libnymea/integrations/browseritemactioninfo.cpp

@@ -33,6 +33,8 @@
 
 #include <QTimer>
 
+Q_DECLARE_LOGGING_CATEGORY(dcIntegrations)
+
 BrowserItemActionInfo::BrowserItemActionInfo(Thing *thing, ThingManager *thingManager, const BrowserItemAction &browserItemAction, QObject *parent, quint32 timeout):
     QObject(parent),
     m_thing(thing),
@@ -85,6 +87,10 @@ QString BrowserItemActionInfo::translatedDisplayMessage(const QLocale &locale)
 
 void BrowserItemActionInfo::finish(Thing::ThingError status, const QString &displayMessage)
 {
+    if (m_finished) {
+        qCWarning(dcIntegrations()) << "BrowserItemActionInfo::finish() called on an already finished object.";
+        return;
+    }
     m_finished = true;
     m_status = status;
     m_displayMessage = displayMessage;

libnymea/integrations/browseritemresult.cpp

@@ -33,6 +33,8 @@
 
 #include <QTimer>
 
+Q_DECLARE_LOGGING_CATEGORY(dcIntegrations)
+
 BrowserItemResult::BrowserItemResult(Thing *thing, ThingManager *thingManager, const QString &itemId, const QLocale &locale, QObject *parent, quint32 timeout):
     QObject(parent),
     m_thing(thing),
@@ -102,6 +104,10 @@ void BrowserItemResult::finish(const BrowserItem &item)
 
 void BrowserItemResult::finish(Thing::ThingError status, const QString &displayMessage)
 {
+    if (m_finished) {
+        qCWarning(dcIntegrations()) << "BrowserItemResult::finish() called on an already finished object.";
+        return;
+    }
     m_finished = true;
     m_status = status;
     m_displayMessage = displayMessage;

libnymea/integrations/integrationplugin.cpp

@@ -100,6 +100,9 @@
 /*! IntegrationPlugin constructor. IntegrationPlugins will be instantiated by the system.
     This should never be called manually by a plugin implementation.
 */
+
+NYMEA_LOGGING_CATEGORY(dcIntegrations, "Integrations")
+
 IntegrationPlugin::IntegrationPlugin(QObject *parent):
     QObject(parent)
 {

libnymea/integrations/thingactioninfo.cpp

@@ -34,6 +34,8 @@
 
 #include <QTimer>
 
+Q_DECLARE_LOGGING_CATEGORY(dcIntegrations)
+
 ThingActionInfo::ThingActionInfo(Thing *thing, const Action &action, ThingManager *parent, quint32 timeout):
     QObject(parent),
     m_thing(thing),
@@ -85,6 +87,10 @@ QString ThingActionInfo::translatedDisplayMessage(const QLocale &locale)
 
 void ThingActionInfo::finish(Thing::ThingError status, const QString &displayMessage)
 {
+    if (m_finished) {
+        qCWarning(dcIntegrations()) << "ThingActionInfo::finish() called on an already finished object.";
+        return;
+    }
     m_finished = true;
     m_status = status;
     m_displayMessage = displayMessage;

libnymea/integrations/thingdiscoveryinfo.cpp

@@ -33,6 +33,8 @@
 
 #include <QTimer>
 
+Q_DECLARE_LOGGING_CATEGORY(dcIntegrations)
+
 ThingDiscoveryInfo::ThingDiscoveryInfo(const ThingClassId &thingClassId, const ParamList &params, ThingManager *thingManager, quint32 timeout):
     QObject(thingManager),
     m_thingClassId(thingClassId),
@@ -100,6 +102,10 @@ QString ThingDiscoveryInfo::translatedDisplayMessage(const QLocale &locale)
 
 void ThingDiscoveryInfo::finish(Thing::ThingError status, const QString &displayMessage)
 {
+    if (m_finished) {
+        qCWarning(dcIntegrations()) << "ThingDiscoveryInfo::finish() called on an already finished object.";
+        return;
+    }
     m_finished = true;
     m_status = status;
     m_displayMessage = displayMessage;

libnymea/integrations/thingpairinginfo.cpp

@@ -33,6 +33,8 @@
 
 #include <QTimer>
 
+Q_DECLARE_LOGGING_CATEGORY(dcIntegrations)
+
 ThingPairingInfo::ThingPairingInfo(const PairingTransactionId &pairingTransactionId, const ThingClassId &thingClassId, const ThingId &thingId, const QString &deviceName, const ParamList &params, const ThingId &parentId, ThingManager *parent, quint32 timeout):
     QObject(parent),
     m_transactionId(pairingTransactionId),
@@ -113,6 +115,10 @@ QString ThingPairingInfo::translatedDisplayMessage(const QLocale &locale) const
 
 void ThingPairingInfo::finish(Thing::ThingError status, const QString &displayMessage)
 {
+    if (m_finished) {
+        qCWarning(dcIntegrations()) << "ThingPairingInfo::finish() called on an already finished object.";
+        return;
+    }
     m_finished = true;
     m_status = status;
     m_displayMessage = displayMessage;

libnymea/integrations/thingsetupinfo.cpp

@@ -35,6 +35,8 @@
 
 #include <QTimer>
 
+Q_DECLARE_LOGGING_CATEGORY(dcIntegrations)
+
 ThingSetupInfo::ThingSetupInfo(Thing *thing, ThingManager *thingManager, quint32 timeout):
     QObject(thingManager),
     m_thing(thing),
@@ -81,6 +83,10 @@ QString ThingSetupInfo::translatedDisplayMessage(const QLocale &locale)
 
 void ThingSetupInfo::finish(Thing::ThingError status, const QString &displayMessage)
 {
+    if (m_finished) {
+        qCWarning(dcIntegrations()) << "ThingSetupInfo::finish() called on an already finished object.";
+        return;
+    }
     m_finished = true;
     m_status = status;
     m_displayMessage = displayMessage;

libnymea/loggingcategories.cpp

@@ -34,10 +34,12 @@
 #include <QDateTime>
 #include <QMutex>
 
-QStringList s_nymeaLoggingCategories;
+QStringList& nymeaLoggingCategories() {
+    static QStringList _nymeaLoggingCategories;
+    return _nymeaLoggingCategories;
+}
 
 // FIXME: Those should eventually disappear from here
-NYMEA_LOGGING_CATEGORY(dcIntegrations, "Integrations");
 NYMEA_LOGGING_CATEGORY(dcThing, "Thing")
 NYMEA_LOGGING_CATEGORY(dcThingManager, "ThingManager")
 NYMEA_LOGGING_CATEGORY(dcSystem, "System")

libnymea/loggingcategories.h

@@ -34,13 +34,12 @@
 #include <QLoggingCategory>
 #include <QDebug>
 
-extern QStringList s_nymeaLoggingCategories;
+QStringList& nymeaLoggingCategories();
-
 
 #define NYMEA_LOGGING_CATEGORY(name, string) \
     class NymeaLoggingCategory##name: public QLoggingCategory { \
     public: \
-    NymeaLoggingCategory##name(): QLoggingCategory(string) { s_nymeaLoggingCategories.append(string); } \
+    NymeaLoggingCategory##name(): QLoggingCategory(string) { nymeaLoggingCategories().append(string); } \
     }; \
     static NymeaLoggingCategory##name s_##name; \
     const QLoggingCategory &name() \