This repository has been archived on 2026-05-31. You can view files and clone it, but cannot push or open issues or pull requests.
powersync-core/libnymea/integrations/thingactioninfo.cpp
Michael Zanetti a11a219bbf Prevent multiple finish calls on API objects
Bad plugin implementations might call finish() more than once
which is not expected by receivers of the finished() signal and
may cause weird side effects.
2020-12-14 23:38:17 +01:00

99 lines
3.0 KiB
C++

/* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * *
*
* Copyright 2013 - 2020, nymea GmbH
* Contact: contact@nymea.io
*
* This file is part of nymea.
* This project including source code and documentation is protected by
* copyright law, and remains the property of nymea GmbH. All rights, including
* reproduction, publication, editing and translation, are reserved. The use of
* this project is subject to the terms of a license agreement to be concluded
* with nymea GmbH in accordance with the terms of use of nymea GmbH, available
* under https://nymea.io/license
*
* GNU Lesser General Public License Usage
* Alternatively, this project may be redistributed and/or modified under the
* terms of the GNU Lesser General Public License as published by the Free
* Software Foundation; version 3. This project is distributed in the hope that
* it will be useful, but WITHOUT ANY WARRANTY; without even the implied
* warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public License
* along with this project. If not, see <https://www.gnu.org/licenses/>.
*
* For any further details and any questions please contact us under
* contact@nymea.io or see our FAQ/Licensing Information on
* https://nymea.io/license/faq
*
* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */
#include "thingactioninfo.h"
#include "thingmanager.h"
#include <QTimer>
Q_DECLARE_LOGGING_CATEGORY(dcIntegrations)
ThingActionInfo::ThingActionInfo(Thing *thing, const Action &action, ThingManager *parent, quint32 timeout):
QObject(parent),
m_thing(thing),
m_action(action),
m_thingManager(parent)
{
connect(this, &ThingActionInfo::finished, this, &ThingActionInfo::deleteLater, Qt::QueuedConnection);
if (timeout > 0) {
QTimer::singleShot(timeout, this, [this] {
emit aborted();
finish(Thing::ThingErrorTimeout);
});
}
}
Thing *ThingActionInfo::thing() const
{
return m_thing;
}
Action ThingActionInfo::action() const
{
return m_action;
}
bool ThingActionInfo::isFinished() const
{
return m_finished;
}
Thing::ThingError ThingActionInfo::status() const
{
return m_status;
}
QString ThingActionInfo::displayMessage() const
{
return m_displayMessage;
}
QString ThingActionInfo::translatedDisplayMessage(const QLocale &locale)
{
if (!m_thingManager) {
return m_displayMessage;
}
return m_thingManager->translate(m_thing->pluginId(), m_displayMessage.toUtf8(), 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;
staticQtMetaObject.invokeMethod(this, "finished", Qt::QueuedConnection);
}