smartsavebutton.cpp

Go to the documentation of this file.

/*
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 3 of the License, or
 * (at your option) any later version.
 *
 * This program 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 General Public License
 * for more details.
 *
 * You should have received a copy of the GNU General Public License along
 * with this program; if not, see <http://www.gnu.org/licenses/>
 *
 * Additional note on redistribution: The copyright and license notices above
 * must be maintained in each individual source file that is a derivative work
 * of this source file; otherwise redistribution is prohibited.
 */
#include "smartsavebutton.h"

smartSaveButton::smartSaveButton()
{
}

void smartSaveButton::addButtons(QPushButton *save, QPushButton *apply)
{
    buttonList.insert(save, save_button);
    buttonList.insert(apply, apply_button);
    connect(save, SIGNAL(clicked()), this, SLOT(processClick()));
    connect(apply, SIGNAL(clicked()), this, SLOT(processClick()));
}

void smartSaveButton::addApplyButton(QPushButton *apply)
{
    buttonList.insert(apply, apply_button);
    connect(apply, SIGNAL(clicked()), this, SLOT(processClick()));
}

void smartSaveButton::addSaveButton(QPushButton *save)
{
    buttonList.insert(save, save_button);
    connect(save, SIGNAL(clicked()), this, SLOT(processClick()));
}

void smartSaveButton::processClick()
{
    emit beginOp();
    bool save = false;
    QPushButton *button = qobject_cast<QPushButton *>(sender());
    if (!button)
        return;
    if (buttonList.value(button) == save_button)
        save = true;
    processOperation(button, save);
}

void smartSaveButton::processOperation(QPushButton *button, bool save)
{
    emit preProcessOperations();
    QStringList failedUploads;
    QStringList failedSaves;
    QStringList missingObjects;
    if (button) {
        button->setEnabled(false);
        button->setIcon(QIcon(":/uploader/images/system-run.svg"));
    }
    QTimer timer;
    timer.setSingleShot(true);
    ExtensionSystem::PluginManager *pm = ExtensionSystem::PluginManager::instance();
    UAVObjectUtilManager *utilMngr = pm->getObject<UAVObjectUtilManager>();
    foreach (UAVDataObject *obj, objects) {
        if (!obj->getIsPresentOnHardware() && obj->isSettings()) {
            if (mandatoryList.value(obj, true))
                missingObjects.append(obj->getName());
            continue;
        }
        UAVObject::Metadata mdata = obj->getMetadata();
        if (UAVObject::GetGcsAccess(mdata) == UAVObject::ACCESS_READONLY && obj->isSettings()) {
            if (mandatoryList.value(obj, true))
                failedUploads.append(obj->getName());
            continue;
        }
        upload_result = false;
        current_object = obj;

        // We only allow to send/save Settings objects using this method
        if (!obj->isSettings()) {
            qDebug() << "[smartsavebutton.cpp] Error, tried to apply/save a non-settings object: "
                     << obj->getName();
            continue;
        }

        qDebug() << "[smartsavebutton.cpp] Sending object to remote end - " << obj->getName();
        connect(obj, SIGNAL(transactionCompleted(UAVObject *, bool)), this,
                SLOT(transaction_finished(UAVObject *, bool)));
        connect(&timer, SIGNAL(timeout()), &loop, SLOT(quit()));
        obj->updated();
        // Three things can happen now:
        // - If object is ACK'ed then we'll get a transactionCompleted signal once ACK arrives
        //   with a success value at 'true'
        // - If remote side does not know it, or object is not ACK'ed then we'll get a timeout,
        // which we catch below
        // - If object is ACK'ed and message gets lost, we'll get a transactionCompleted with a
        //   success value at 'false'
        //
        // Note: settings objects should always be ACK'ed, so a timeout should always be because of
        // a lost
        //       message over the telemetry link.
        //
        // Note 2: the telemetry link does max 3 tries with 250ms interval when sending an object
        //         update over the link
        timer.start(1000);
        loop.exec();
        if (!timer.isActive())
            qInfo() << "[smartsavebutton.cpp] Upload timeout for object" << obj->getName();
        timer.stop();
        disconnect(obj, SIGNAL(transactionCompleted(UAVObject *, bool)), this,
                   SLOT(transaction_finished(UAVObject *, bool)));
        disconnect(&timer, SIGNAL(timeout()), &loop, SLOT(quit()));

        if (upload_result == false) {
            qInfo() << "[smartsavebutton.cpp] Object upload error:" << obj->getName();
            if (mandatoryList.value(obj, true))
                failedUploads.append(obj->getName());
            continue;
        }

        // Now object is uploaded, we can move on to saving it to flash:
        save_result = false;
        current_objectID = obj->getObjID();

        if (save && (obj->isSettings())) {
            qDebug() << "[smartsavebutton.cpp] Save request for object" << obj->getName();
            connect(utilMngr, SIGNAL(saveCompleted(int, bool)), this,
                    SLOT(saving_finished(int, bool)));
            connect(&timer, SIGNAL(timeout()), &loop, SLOT(quit()));
            utilMngr->saveObjectToFlash(obj);
            // Now, here is what will happen:
            // - saveObjectToFlash is going to attempt the save operation
            // - If save succeeds, then it will issue a saveCompleted signal with the ObjectID and
            // 'true'
            // - If save fails, either because of error or timeout, then it will issue a
            // saveCompleted signal
            //   with the ObjectID and 'false'.
            //
            // Note: in case of link timeout, the telemetry layer will retry up to 2 times, we don't
            // need to retry ourselves here.
            //
            // Note 2: saveObjectToFlash manages save operations in a queue, so there is no
            // guarantee that
            // the first "saveCompleted" signal is for the object we just asked to save.
            timer.start(2000);
            loop.exec();
            if (!timer.isActive())
                qInfo() << "[smartsavebutton.cpp] Saving timeout for object" << obj->getName();
            timer.stop();
            disconnect(utilMngr, SIGNAL(saveCompleted(int, bool)), this,
                       SLOT(saving_finished(int, bool)));
            disconnect(&timer, SIGNAL(timeout()), &loop, SLOT(quit()));

            if (save_result == false) {
                qInfo() << "[smartsavebutton.cpp] failed to save:" << obj->getName();
                if (mandatoryList.value(obj, true))
                    failedSaves.append(obj->getName());
            }
        }
    }
    if (button)
        button->setEnabled(true);
    QString result;
    bool error = true;
    if (failedSaves.isEmpty() && failedUploads.isEmpty() && missingObjects.isEmpty()) {
        result = "All operations finished successfully";
        error = false;
    } else {
        if (!failedSaves.isEmpty()) {
            result.append("Objects not saved:\n");
            foreach (QString str, failedSaves) {
                result.append(str + "\n");
            }
        }
        if (!failedUploads.isEmpty()) {
            if (!result.isEmpty())
                result.append("\n");
            result.append("Objects not uploaded:\n");
            foreach (QString str, failedUploads) {
                result.append(str + "\n");
            }
        }
        if (!missingObjects.isEmpty()) {
            if (!result.isEmpty())
                result.append("\n");
            result.append("Objects not present on the hardware:\n");
            foreach (QString str, missingObjects) {
                result.append(str + "\n");
            }
        }
    }
    qDebug() << "RESULT" << result << missingObjects << failedSaves << failedUploads;
    if (button)
        button->setToolTip(result);
    if (!error) {
        if (button)
            button->setIcon(QIcon(":/uploader/images/dialog-apply.svg"));
        emit saveSuccessfull();
    } else {
        if (button) {
            if (!failedSaves.isEmpty() || !failedUploads.isEmpty())
                button->setIcon(QIcon(":/uploader/images/process-stop.svg"));
            else
                button->setIcon(QIcon(":/uploader/images/warning.svg"));
        }
    }
    emit endOp();
}

void smartSaveButton::setObjects(QList<UAVDataObject *> list)
{
    objects = list;
}

void smartSaveButton::addObject(UAVDataObject *obj)
{
    Q_ASSERT(obj);
    if (!objects.contains(obj))
        objects.append(obj);
}

void smartSaveButton::addObject(UAVDataObject *obj, bool isMandatory)
{
    Q_ASSERT(obj);
    if (!objects.contains(obj))
        objects.append(obj);
    if (!isMandatory)
        mandatoryList.insert(obj, false);
}

void smartSaveButton::removeObject(UAVDataObject *obj)
{
    if (objects.contains(obj))
        objects.removeAll(obj);
}

void smartSaveButton::removeAllObjects()
{
    objects.clear();
}

void smartSaveButton::clearObjects()
{
    objects.clear();
}

void smartSaveButton::transaction_finished(UAVObject *obj, bool result)
{
    if (current_object == obj) {
        upload_result = result;
        loop.quit();
    }
}

void smartSaveButton::saving_finished(int id, bool result)
{
    // The saveOjectToFlash method manages its own save queue, so we can be
    // in a situation where we get a saving_finished message for an object
    // which is not the one we're interested in, hence the check below:
    if ((quint32)id == current_objectID) {
        save_result = result;
        loop.quit();
    }
}

void smartSaveButton::enableControls(bool value)
{
    foreach (QPushButton *button, buttonList.keys())
        button->setEnabled(value);
}

void smartSaveButton::resetIcons()
{
    foreach (QPushButton *button, buttonList.keys()) {
        button->setToolTip("");
        button->setIcon(QIcon());
    }
}

void smartSaveButton::setNotMandatory(UAVDataObject *obj)
{
    mandatoryList.insert(obj, false);
}

void smartSaveButton::apply()
{
    processOperation(NULL, false);
}

void smartSaveButton::save()
{
    processOperation(NULL, true);
}