KisManualUpdater Class Reference

#include <KisManualUpdater.h>

Inheritance diagram for KisManualUpdater:

Public Slots
void	rssDataChanged ()

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
	the manual updater can only check for available versions
	KisManualUpdater ()
	KisManualUpdater (MultiFeedRssModel *rssModel, QString &currentVersion)
	KisManualUpdater - constructor for testing.
Public Member Functions inherited from KisUpdaterBase
	KisUpdaterBase ()

Private Member Functions
bool	availableVersionIsHigher (QString currentVersion, QString availableVersion)

Private Attributes
QString	m_currentVersion
QScopedPointer< MultiFeedRssModel >	m_rssModel

Friends
class	KisManualUpdaterTest

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

Detailed Description

Definition at line 18 of file KisManualUpdater.h.

Constructor & Destructor Documentation

KisManualUpdater() [1/2]

KisManualUpdater::KisManualUpdater

(

)

Definition at line 20 of file KisManualUpdater.cpp.

    : m_currentVersion(KritaVersionWrapper::versionString())
{
    m_rssModel.reset(new MultiFeedRssModel());
}

References m_rssModel.

KisManualUpdater() [2/2]

KisManualUpdater::KisManualUpdater ( MultiFeedRssModel * rssModel, QString & currentVersion )

explicit

KisManualUpdater - constructor for testing.

Parameters

rssModel
currentVersion

Definition at line 26 of file KisManualUpdater.cpp.

    : m_currentVersion(currentVersion)
{
    m_rssModel.reset(rssModel);
}

References m_rssModel.

Member Function Documentation

availableVersionIsHigher()

bool KisManualUpdater::availableVersionIsHigher ( QString currentVersion, QString availableVersion )

private

Definition at line 84 of file KisManualUpdater.cpp.

{
    if (currentVersion.isEmpty() || availableVersion.isEmpty()) {
        return false;
    }
 
    int currentSuffixIndex {5};
    int availableSuffixIndex {5};
 
    QVersionNumber currentVersionNumber = QVersionNumber::fromString(currentVersion, &currentSuffixIndex);
    QVersionNumber availableVersionNumber = QVersionNumber::fromString(availableVersion, &availableSuffixIndex);
 
    QString currentSuffix = currentVersion.mid(currentSuffixIndex);
    QString availableSuffix = availableVersion.mid(availableSuffixIndex);
 
    if (currentVersionNumber.normalized() == availableVersionNumber.normalized()) {
        if (!currentSuffix.isEmpty() && availableSuffix.isEmpty()) {
            return true;
        } else {
            return false;
        }
    } else {
        return (currentVersionNumber.normalized() < availableVersionNumber.normalized());
    }
}

checkForUpdate()

void KisManualUpdater::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 32 of file KisManualUpdater.cpp.

{
    connect(m_rssModel.data(), SIGNAL(feedDataChanged()), this, SLOT(rssDataChanged()));
    m_rssModel->addFeed(QLatin1String("https://krita.org/en/feed/"));
}

References connect(), m_rssModel, and rssDataChanged().

doUpdate()

void KisManualUpdater::doUpdate ( )

inlineoverridevirtual

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 39 of file KisManualUpdater.h.

{ return; }

hasUpdateCapability()

bool KisManualUpdater::hasUpdateCapability ( )

inlineoverridevirtual

the manual updater can only check for available versions

Returns

false

Implements KisUpdaterBase.

Definition at line 38 of file KisManualUpdater.h.

{ return false; }

rssDataChanged

void KisManualUpdater::rssDataChanged ( )

slot

Definition at line 38 of file KisManualUpdater.cpp.

{
    // grab the latest release post and URL for reference later
    // if we need to update
    QString availableVersion;
    QString downloadLink;
 
    for (int i = 0; i < m_rssModel->rowCount(); i++) {
       const QModelIndex &idx = m_rssModel->index(i);
 
       if (idx.isValid()) {
           // only use official release announcements to get version number
           if ( idx.data(KisRssReader::RssRoles::CategoryRole).toString() !=  "Official Release") {
               continue;
           }
 
           QString linkTitle = idx.data(KisRssReader::RssRoles::TitleRole).toString();
 
           // regex to capture version number
           QRegularExpression versionRegex("\\d\\.\\d\\.?\\d?\\.?\\d");
           QRegularExpressionMatch matched = versionRegex.match(linkTitle);
 
           // only take the top match for release version since that is the newest
           if (matched.hasMatch()) {
               availableVersion = matched.captured(0);
               downloadLink = idx.data(KisRssReader::RssRoles::LinkRole).toString();
               break;
           }
       }
    }
 
    UpdaterStatus::StatusID status;
 
    if (availableVersionIsHigher(m_currentVersion, availableVersion)) {
        status = UpdaterStatus::StatusID::UPDATE_AVAILABLE;
    } else {
        status = UpdaterStatus::StatusID::UPTODATE;
    }
 
    m_updaterStatus.setStatus(status);
    m_updaterStatus.setAvailableVersion(availableVersion);
    m_updaterStatus.setDownloadLink(downloadLink);
 
    Q_EMIT sigUpdateCheckStateChange(m_updaterStatus);
}

References availableVersionIsHigher(), KisRssReader::CategoryRole, KisRssReader::LinkRole, m_currentVersion, m_rssModel, KisUpdaterBase::m_updaterStatus, KisUpdaterStatus::setAvailableVersion(), KisUpdaterStatus::setDownloadLink(), KisUpdaterStatus::setStatus(), KisUpdaterBase::sigUpdateCheckStateChange(), KisRssReader::TitleRole, UpdaterStatus::UPDATE_AVAILABLE, and UpdaterStatus::UPTODATE.

Friends And Related Symbol Documentation

KisManualUpdaterTest

friend class KisManualUpdaterTest

friend

Definition at line 50 of file KisManualUpdater.h.

Member Data Documentation

m_currentVersion

QString KisManualUpdater::m_currentVersion

private

Definition at line 48 of file KisManualUpdater.h.

m_rssModel

QScopedPointer<MultiFeedRssModel> KisManualUpdater::m_rssModel

private

Definition at line 47 of file KisManualUpdater.h.

---

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

• libs/ui/utils/KisManualUpdater.h
• libs/ui/utils/KisManualUpdater.cpp