#include <KisAppimageUpdater.h>

Inheritance diagram for KisAppimageUpdater:

Public Member Functions
void	checkForUpdate () override
	start the process checking whether there is an update available or not When the check is done, the updater emits sigUpdateCheckStateChange with the check result

void	doUpdate () override
	if the updater has update capability, start the update process When the update is done, the updater emits sigUpdateCheckStateChange with the check result

bool	hasUpdateCapability () override
	Returns true if this updater can actually perform an update. If it can only check for new versions, return false.

	KisAppimageUpdater ()

	KisAppimageUpdater (QString dummyUpdaterPath)

Public Member Functions inherited from KisUpdaterBase
	KisUpdaterBase ()

Private Slots
void	slotAppendCheckOutput ()

void	slotAppendUpdateOutput ()

void	slotUpdateCheckErrorOccurred (QProcess::ProcessError error)

void	slotUpdateCheckFinished (int result, QProcess::ExitStatus exitStatus)

void	slotUpdateCheckStarted ()

void	slotUpdateErrorOccurred (QProcess::ProcessError error)

void	slotUpdateFinished (int result, QProcess::ExitStatus exitStatus)

Private Member Functions
bool	findUpdaterBinary ()

void	initialize (QString &updaterPath)

Private Attributes
QString	m_appimagePath

QString	m_checkOutput

QScopedPointer< QProcess >	m_checkProcess

bool	m_updateCapability

QString	m_updateOutput

QScopedPointer< QProcess >	m_updateProcess

QString	m_updaterBinary

bool	m_updaterInProgress {false}

Additional Inherited Members
Signals inherited from KisUpdaterBase
void	sigUpdateCheckStateChange (KisUpdaterStatus)

Protected Attributes inherited from KisUpdaterBase
KisUpdaterStatus	m_updaterStatus

Detailed Description

Definition at line 22 of file KisAppimageUpdater.h.

Constructor & Destructor Documentation

◆ KisAppimageUpdater() [1/2]

KisAppimageUpdater::KisAppimageUpdater ( )

Definition at line 22 of file KisAppimageUpdater.cpp.

    : m_checkProcess(new QProcess(this))
    , m_updateProcess(new QProcess(this))
{
    QString updaterPath;
 
#if defined(KRITA_GIT_SHA1_STRING)
    if (qEnvironmentVariableIsSet("KRITA_APPIMAGEUPDATER_USE_DUMMY")) {
        updaterPath = QString("%1%2AppImageUpdateDummy")
                .arg(QCoreApplication::applicationDirPath())
                .arg(QDir::separator());
    } else {
        updaterPath = QString("%1%2AppImageUpdate")
                .arg(QCoreApplication::applicationDirPath())
                .arg(QDir::separator());
    }
#else
    updaterPath = QString("%1%2AppImageUpdate")
            .arg(QCoreApplication::applicationDirPath())
            .arg(QDir::separator());
#endif
 
    initialize(updaterPath);
}

References initialize().

◆ KisAppimageUpdater() [2/2]

KisAppimageUpdater::KisAppimageUpdater ( QString dummyUpdaterPath )

explicit

Definition at line 47 of file KisAppimageUpdater.cpp.

    : m_checkProcess(new QProcess(this))
    , m_updateProcess(new QProcess(this))
{
    initialize(dummyUpdaterPath);
}

References initialize().

Member Function Documentation

◆ checkForUpdate()

void KisAppimageUpdater::checkForUpdate ( )

overridevirtual

start the process checking whether there is an update available or not When the check is done, the updater emits sigUpdateCheckStateChange with the check result

Implements KisUpdaterBase.

Definition at line 54 of file KisAppimageUpdater.cpp.

{
    if (m_updaterInProgress) {
        return;
    }
 
    if (!m_updateCapability) {
        return;
    }
 
    // reset output for subsequent checks, is this needed?
    m_checkOutput = QString();
    m_updateOutput = QString();
    m_updaterStatus.setUpdaterOutput(QString());
 
    QStringList args = QStringList() << "--check-for-update" << m_appimagePath;
 
    m_checkProcess->start(m_updaterBinary, args);
    m_updaterInProgress = true;
}

References m_appimagePath, m_checkOutput, m_checkProcess, m_updateCapability, m_updateOutput, m_updaterBinary, m_updaterInProgress, KisUpdaterBase::m_updaterStatus, and KisUpdaterStatus::setUpdaterOutput().

◆ doUpdate()

void KisAppimageUpdater::doUpdate ( )

overridevirtual

if the updater has update capability, start the update process When the update is done, the updater emits sigUpdateCheckStateChange with the check result

Implements KisUpdaterBase.

Definition at line 80 of file KisAppimageUpdater.cpp.

{
    QStringList args = QStringList() << m_appimagePath;
    m_updateProcess->start(m_updaterBinary, args);
}

References m_appimagePath, m_updateProcess, and m_updaterBinary.

◆ findUpdaterBinary()

bool KisAppimageUpdater::findUpdaterBinary ( )

private

Definition at line 243 of file KisAppimageUpdater.cpp.

{
    QFileInfo finfo(m_updaterBinary);
    if (finfo.isExecutable()) {
        return true;
    } else {
        KisUsageLogger::log(
                    QString("KisAppimageUpdater: AppImageUpdate (%1) was not found within the Krita appimage, or is not executable")
                    .arg(m_updaterBinary)
                    );
        return false;
    }
}

References KisUsageLogger::log(), and m_updaterBinary.

◆ hasUpdateCapability()

bool KisAppimageUpdater::hasUpdateCapability ( )

overridevirtual

Returns true if this updater can actually perform an update. If it can only check for new versions, return false.

Returns: bool

Implements KisUpdaterBase.

Definition at line 75 of file KisAppimageUpdater.cpp.

{
    return m_updateCapability;
}

References m_updateCapability.

◆ initialize()

void KisAppimageUpdater::initialize ( QString & updaterPath )

private

Definition at line 216 of file KisAppimageUpdater.cpp.

{
    m_appimagePath = qEnvironmentVariable("APPIMAGE");
    m_updaterBinary = updaterPath;
 
    m_updateCapability = findUpdaterBinary();
 
    m_checkProcess->setProcessChannelMode(QProcess::MergedChannels);
    m_updateProcess->setProcessChannelMode(QProcess::MergedChannels);
 
    connect(m_checkProcess.data(), SIGNAL(started()), this, SLOT(slotUpdateCheckStarted()));
    connect(m_checkProcess.data(), SIGNAL(errorOccurred(QProcess::ProcessError)),
            this, SLOT(slotUpdateCheckErrorOccurred(QProcess::ProcessError)));
    connect(m_checkProcess.data(), SIGNAL(finished(int, QProcess::ExitStatus)),
            this, SLOT(slotUpdateCheckFinished(int, QProcess::ExitStatus)));
    connect(m_checkProcess.data(), SIGNAL(readyReadStandardOutput()),
            this, SLOT(slotAppendCheckOutput()));
 
 
    connect(m_updateProcess.data(), SIGNAL(errorOccurred(QProcess::ProcessError)),
            this, SLOT(slotUpdateErrorOccurred(QProcess::ProcessError)));
    connect(m_updateProcess.data(), SIGNAL(finished(int, QProcess::ExitStatus)),
            this, SLOT(slotUpdateFinished(int, QProcess::ExitStatus)));
    connect(m_updateProcess.data(), SIGNAL(readyReadStandardOutput()),
            this, SLOT(slotAppendUpdateOutput()));
}

References connect(), findUpdaterBinary(), m_appimagePath, m_checkProcess, m_updateCapability, m_updateProcess, m_updaterBinary, slotAppendCheckOutput(), slotAppendUpdateOutput(), slotUpdateCheckErrorOccurred(), slotUpdateCheckFinished(), slotUpdateCheckStarted(), slotUpdateErrorOccurred(), and slotUpdateFinished().

◆ slotAppendCheckOutput

void KisAppimageUpdater::slotAppendCheckOutput ( )

privateslot

Definition at line 206 of file KisAppimageUpdater.cpp.

{
    m_checkOutput.append(m_checkProcess->readAllStandardOutput());
}

References m_checkOutput, and m_checkProcess.

◆ slotAppendUpdateOutput

void KisAppimageUpdater::slotAppendUpdateOutput ( )

privateslot

Definition at line 211 of file KisAppimageUpdater.cpp.

{
    m_updateOutput.append(m_updateProcess->readAllStandardOutput());
}

References m_updateOutput, and m_updateProcess.

◆ slotUpdateCheckErrorOccurred

void KisAppimageUpdater::slotUpdateCheckErrorOccurred ( QProcess::ProcessError error )

privateslot

Definition at line 134 of file KisAppimageUpdater.cpp.

{
    KisUsageLogger::log(
                QString("KisAppimageUpdater: error occurred during update check: %1\npath: %2\noutput: %3")
                .arg(error)
                .arg(m_appimagePath)
                .arg(m_checkOutput)
                );
 
    m_updaterInProgress = false;
 
    m_updaterStatus.setStatus(UpdaterStatus::StatusID::CHECK_ERROR);
 
    Q_EMIT sigUpdateCheckStateChange(m_updaterStatus);
}

References UpdaterStatus::CHECK_ERROR, KisUsageLogger::log(), m_appimagePath, m_checkOutput, m_updaterInProgress, KisUpdaterBase::m_updaterStatus, KisUpdaterStatus::setStatus(), and KisUpdaterBase::sigUpdateCheckStateChange().

◆ slotUpdateCheckFinished

void KisAppimageUpdater::slotUpdateCheckFinished	(	int	result,
		QProcess::ExitStatus	exitStatus )

privateslot

Definition at line 86 of file KisAppimageUpdater.cpp.

{
    KisUsageLogger::log(
                QString("KisAppimageUpdater: update check finished. Result: %1 Exit status: %2\npath: %3\noutput: %4")
                .arg(result)
                .arg(exitStatus)
                .arg(m_appimagePath)
                .arg(m_updateOutput)
                );
 
    UpdaterStatus::StatusID updateStatus;
 
    if (exitStatus == QProcess::CrashExit) {
        updateStatus = UpdaterStatus::StatusID::CHECK_ERROR;
 
    } else {
        switch (result) {
        case 0:
            updateStatus = UpdaterStatus::StatusID::UPTODATE;
            break;
        case 1:
            updateStatus = UpdaterStatus::StatusID::UPDATE_AVAILABLE;
            break;
        case 2:
            updateStatus = UpdaterStatus::StatusID::CHECK_ERROR;
            break;
        default:
            // some errors have exit code of 255 (modified by system, when AppImageUpdate returns -1)
            // one source of 255 is when the AppImage does not contain update information
            updateStatus = UpdaterStatus::StatusID::CHECK_ERROR;
            break;
        }
    }
 
    m_updaterInProgress = false;
 
    m_updaterStatus.setStatus(updateStatus);
    m_updaterStatus.setUpdaterOutput(m_updateOutput);
 
    Q_EMIT sigUpdateCheckStateChange(m_updaterStatus);
}

References UpdaterStatus::CHECK_ERROR, KisUsageLogger::log(), m_appimagePath, m_updateOutput, m_updaterInProgress, KisUpdaterBase::m_updaterStatus, KisUpdaterStatus::setStatus(), KisUpdaterStatus::setUpdaterOutput(), KisUpdaterBase::sigUpdateCheckStateChange(), UpdaterStatus::UPDATE_AVAILABLE, and UpdaterStatus::UPTODATE.

◆ slotUpdateCheckStarted

void KisAppimageUpdater::slotUpdateCheckStarted ( )

privateslot

Definition at line 128 of file KisAppimageUpdater.cpp.

{
    m_updaterStatus.setStatus(UpdaterStatus::StatusID::IN_PROGRESS);
    Q_EMIT sigUpdateCheckStateChange(m_updaterStatus);
}

References UpdaterStatus::IN_PROGRESS, KisUpdaterBase::m_updaterStatus, KisUpdaterStatus::setStatus(), and KisUpdaterBase::sigUpdateCheckStateChange().

◆ slotUpdateErrorOccurred

void KisAppimageUpdater::slotUpdateErrorOccurred ( QProcess::ProcessError error )

privateslot

Definition at line 189 of file KisAppimageUpdater.cpp.

{
    KisUsageLogger::log(
                QString("KisAppimageUpdater: error occurred during update: %1\npath: %2\noutput: %3")
                .arg(error)
                .arg(m_appimagePath)
                .arg(m_updateOutput)
                );
 
    m_updaterInProgress = false;
 
    m_updaterStatus.setStatus(UpdaterStatus::StatusID::UPDATE_ERROR);
    m_updaterStatus.setUpdaterOutput(m_updateOutput);
 
    Q_EMIT sigUpdateCheckStateChange(m_updaterStatus);
}

References KisUsageLogger::log(), m_appimagePath, m_updateOutput, m_updaterInProgress, KisUpdaterBase::m_updaterStatus, KisUpdaterStatus::setStatus(), KisUpdaterStatus::setUpdaterOutput(), KisUpdaterBase::sigUpdateCheckStateChange(), and UpdaterStatus::UPDATE_ERROR.

◆ slotUpdateFinished

void KisAppimageUpdater::slotUpdateFinished	(	int	result,
		QProcess::ExitStatus	exitStatus )

privateslot

Definition at line 150 of file KisAppimageUpdater.cpp.

{
    KisUsageLogger::log(
                QString("KisAppimageUpdater: update finished. Result: %1\nExit status: %2\npath: %3\noutput: %4")
                .arg(result)
                .arg(exitStatus)
                .arg(m_appimagePath)
                .arg(m_updateOutput)
                );
 
    UpdaterStatus::StatusID updateStatus;
    QFileInfo finfoAppImagePath(m_appimagePath);
    QString statusDetails;
 
    if (exitStatus == QProcess::CrashExit) {
        updateStatus = UpdaterStatus::StatusID::UPDATE_ERROR;
 
    } else {
        switch (result) {
        case 0:
            updateStatus = UpdaterStatus::StatusID::RESTART_REQUIRED;
            statusDetails = i18n("New AppImage was downloaded to %1. To complete the update, close Krita and run the new AppImage.", finfoAppImagePath.path());
            break;
        default:
            // some errors have exit code of 255 (modified by system, when AppImageUpdate returns -1)
            updateStatus = UpdaterStatus::StatusID::UPDATE_ERROR;
            break;
        }
    }
 
    m_updaterInProgress = false;
 
    m_updaterStatus.setStatus(updateStatus);
    m_updaterStatus.setUpdaterOutput(m_updateOutput);
    m_updaterStatus.setDetails(statusDetails);
 
    Q_EMIT sigUpdateCheckStateChange(m_updaterStatus);
}

References KisUsageLogger::log(), m_appimagePath, m_updateOutput, m_updaterInProgress, KisUpdaterBase::m_updaterStatus, UpdaterStatus::RESTART_REQUIRED, KisUpdaterStatus::setDetails(), KisUpdaterStatus::setStatus(), KisUpdaterStatus::setUpdaterOutput(), KisUpdaterBase::sigUpdateCheckStateChange(), and UpdaterStatus::UPDATE_ERROR.

Member Data Documentation

◆ m_appimagePath

QString KisAppimageUpdater::m_appimagePath

private

Definition at line 50 of file KisAppimageUpdater.h.

◆ m_checkOutput

QString KisAppimageUpdater::m_checkOutput

private

Definition at line 53 of file KisAppimageUpdater.h.

◆ m_checkProcess

QScopedPointer<QProcess> KisAppimageUpdater::m_checkProcess

private

Definition at line 56 of file KisAppimageUpdater.h.

◆ m_updateCapability

bool KisAppimageUpdater::m_updateCapability

private

Definition at line 51 of file KisAppimageUpdater.h.

◆ m_updateOutput

QString KisAppimageUpdater::m_updateOutput

private

Definition at line 54 of file KisAppimageUpdater.h.

◆ m_updateProcess

QScopedPointer<QProcess> KisAppimageUpdater::m_updateProcess

private

Definition at line 57 of file KisAppimageUpdater.h.

◆ m_updaterBinary

QString KisAppimageUpdater::m_updaterBinary

private

Definition at line 49 of file KisAppimageUpdater.h.

◆ m_updaterInProgress

bool KisAppimageUpdater::m_updaterInProgress {false}

private

Definition at line 52 of file KisAppimageUpdater.h.

52{false};

The documentation for this class was generated from the following files:

libs/ui/utils/KisAppimageUpdater.h
libs/ui/utils/KisAppimageUpdater.cpp

Public Member Functions

Private Slots

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ KisAppimageUpdater() [1/2]

◆ KisAppimageUpdater() [2/2]

Member Function Documentation

◆ checkForUpdate()

◆ doUpdate()

◆ findUpdaterBinary()

◆ hasUpdateCapability()

◆ initialize()

◆ slotAppendCheckOutput

◆ slotAppendUpdateOutput

◆ slotUpdateCheckErrorOccurred

◆ slotUpdateCheckFinished

◆ slotUpdateCheckStarted

◆ slotUpdateErrorOccurred

◆ slotUpdateFinished

Member Data Documentation

◆ m_appimagePath

◆ m_checkOutput

◆ m_checkProcess

◆ m_updateCapability

◆ m_updateOutput

◆ m_updateProcess

◆ m_updaterBinary

◆ m_updaterInProgress