mirror of https://github.com/nymea/nymea.git
126 lines
4.4 KiB
C++
126 lines
4.4 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 "thingsetupinfo.h"
|
|
|
|
#include "integrationplugin.h"
|
|
#include "thingmanager.h"
|
|
|
|
#include <QTimer>
|
|
|
|
Q_DECLARE_LOGGING_CATEGORY(dcIntegrations)
|
|
|
|
ThingSetupInfo::ThingSetupInfo(QObject *parent):
|
|
QObject(parent)
|
|
{
|
|
|
|
}
|
|
|
|
ThingSetupInfo::ThingSetupInfo(Thing *thing, ThingManager *thingManager, bool initialSetup, bool reconfigure, quint32 timeout):
|
|
QObject(thingManager),
|
|
m_thing(thing),
|
|
m_initialSetup(initialSetup),
|
|
m_reconfigure(reconfigure),
|
|
m_thingManager(thingManager)
|
|
{
|
|
connect(this, &ThingSetupInfo::finished, this, &ThingSetupInfo::deleteLater, Qt::QueuedConnection);
|
|
|
|
// TODO 2.0: Create a base class and move this finished() of all Info classes logic handling there
|
|
// That will badly break the ABI, so copy/pasting this for now.
|
|
if (timeout > 0) {
|
|
QTimer::singleShot(timeout, this, [this] {
|
|
// It can happen that a plugin calls finish() in a slot which normally would be dispatched before the timeout
|
|
// but due to high system load the slot is invoked only after the timeout. This in turn would cause Qt to also queue up
|
|
// this timeout slot and by the time the system processes slots, the plugin comes in first and we'd fire an aborted()
|
|
// signal in the plugin after it called finish(), potentially badly breaking the plugin as a plugin developer would not
|
|
// expect this to happen. So we'll have to verify here that the plugin did not finish() by now before aborting.
|
|
if (!m_finished) {
|
|
emit aborted();
|
|
// Also it could happen the the plugin calls finish() *in* the aborted() signal, in which case
|
|
// we don't want to call finish() here now to not print a warning about duplicate finished calls
|
|
if (!m_finished) {
|
|
finish(Thing::ThingErrorTimeout);
|
|
}
|
|
}
|
|
});
|
|
}
|
|
}
|
|
|
|
Thing *ThingSetupInfo::thing() const
|
|
{
|
|
return m_thing;
|
|
}
|
|
|
|
bool ThingSetupInfo::isInitialSetup() const
|
|
{
|
|
return m_initialSetup;
|
|
}
|
|
|
|
bool ThingSetupInfo::isReconfigure() const
|
|
{
|
|
return m_reconfigure;
|
|
}
|
|
|
|
bool ThingSetupInfo::isFinished() const
|
|
{
|
|
return m_finished;
|
|
}
|
|
|
|
Thing::ThingError ThingSetupInfo::status() const
|
|
{
|
|
return m_status;
|
|
}
|
|
|
|
QString ThingSetupInfo::displayMessage() const
|
|
{
|
|
return m_displayMessage;
|
|
}
|
|
|
|
QString ThingSetupInfo::translatedDisplayMessage(const QLocale &locale)
|
|
{
|
|
if (!m_thingManager || !m_thing) {
|
|
return m_displayMessage;
|
|
}
|
|
|
|
return m_thingManager->translate(m_thing->pluginId(), m_displayMessage.toUtf8(), locale);
|
|
}
|
|
|
|
void ThingSetupInfo::finish(Thing::ThingError status, const QString &displayMessage)
|
|
{
|
|
if (m_finished) {
|
|
qCWarning(dcIntegrations()) << "ThingSetupInfo::finish() called on an already finished object for" << m_thing << status << displayMessage;
|
|
return;
|
|
}
|
|
m_finished = true;
|
|
m_status = status;
|
|
m_displayMessage = displayMessage;
|
|
staticMetaObject.invokeMethod(this, "finished", Qt::QueuedConnection);
|
|
}
|