AutosaveController.cpp

Go to the documentation of this file.

//  ************************************************************************************************
//
//  BornAgain: simulate and fit reflection and scattering
//
//! @file      GUI/View/Project/AutosaveController.cpp
//! @brief     Implements class AutosaveController
//!
//! @homepage  http://www.bornagainproject.org
//! @license   GNU General Public License v3 or higher (see COPYING)
//! @copyright Forschungszentrum Jülich GmbH 2018
//! @authors   Scientific Computing Group at MLZ (see CITATION, AUTHORS)
//
//  ************************************************************************************************
 
#include "GUI/View/Project/AutosaveController.h"
#include "GUI/Model/Project/ProjectDocument.h"
#include "GUI/Support/IO/ProjectUtils.h"
#include "GUI/View/Tool/UpdateTimer.h"
#include <QDir>
 
namespace {
 
const int update_every = 20000; // in msec
}
 
AutosaveController::AutosaveController(QObject* parent)
    : QObject(parent)
    , m_document(nullptr)
    , m_timer(new UpdateTimer(update_every, this))
{
    connect(m_timer, &UpdateTimer::timeToUpdate, this, &AutosaveController::onTimerTimeout);
}
 
void AutosaveController::setDocument(ProjectDocument* document)
{
    if (document == m_document)
        return;
 
    m_timer->reset();
 
    if (m_document)
        m_document->disconnect(this);
 
    m_document = document;
 
    if (m_document) {
        connect(m_document, &ProjectDocument::destroyed, this,
                &AutosaveController::onDocumentDestroyed, Qt::UniqueConnection);
        connect(m_document, &ProjectDocument::modified, this,
                &AutosaveController::onDocumentModified, Qt::UniqueConnection);
    }
 
    onDocumentModified();
}
 
void AutosaveController::setAutosaveTime(int timerInterval)
{
    m_timer->reset();
    m_timer->setWallclockTimer(timerInterval);
}
 
//! Returns the name of autosave directory.
 
QString AutosaveController::autosaveDir() const
{
    if (m_document && m_document->hasValidNameAndPath())
        return GUI::Project::Utils::autosaveDir(m_document->projectFileName());
 
    return "";
}
 
QString AutosaveController::autosaveName() const
{
    if (m_document && m_document->hasValidNameAndPath())
        return GUI::Project::Utils::autosaveName(m_document->projectFileName());
 
    return "";
}
 
void AutosaveController::removeAutosaveDir() const
{
    if (autosaveDir().isEmpty())
        return;
 
    QDir dir(autosaveDir());
    dir.removeRecursively();
}
 
void AutosaveController::onTimerTimeout()
{
    if (m_document->isModified())
        autosave();
}
 
void AutosaveController::onDocumentDestroyed(QObject* object)
{
    Q_UNUSED(object);
    m_timer->reset();
    m_document = nullptr;
}
 
void AutosaveController::onDocumentModified()
{
    if (!m_document)
        return;
 
    if (m_document->isModified() && m_document->hasValidNameAndPath())
        m_timer->scheduleUpdate();
}
 
bool AutosaveController::assureAutoSaveDirExists() const
{
    if (m_document && m_document->hasValidNameAndPath()) {
        const QDir projectDir = m_document->projectDir();
        if (projectDir.exists() && !projectDir.exists(GUI::Project::Utils::autosaveSubdir()))
            projectDir.mkdir(GUI::Project::Utils::autosaveSubdir());
 
        return QDir(autosaveDir()).exists();
    }
 
    return false;
}
 
void AutosaveController::autosave()
{
    try {
        if (!autosaveName().isEmpty() && assureAutoSaveDirExists())
            emit autosaveRequest();
    } catch (...) {
        // catch any exception - autosave itself never should cause a crash by an unhandled
        // exception
    }
}