ea4ef1655b
To actually get automatic updates going, all that needs to happen is that `SparkleUpdater` needs to be initialized. The rest of the functions can be connected to elements in the UI.
125 lines
4.5 KiB
C++
125 lines
4.5 KiB
C++
// SPDX-License-Identifier: GPL-3.0-only
|
||
/*
|
||
* PolyMC - Minecraft Launcher
|
||
* Copyright (C) 2022 Kenneth Chew <kenneth.c0@protonmail.com>
|
||
*
|
||
* 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, version 3.
|
||
*
|
||
* 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 <https://www.gnu.org/licenses/>.
|
||
*/
|
||
|
||
#ifndef LAUNCHER_SPARKLEUPDATER_H
|
||
#define LAUNCHER_SPARKLEUPDATER_H
|
||
|
||
#include <QObject>
|
||
#include <QSet>
|
||
|
||
class SparkleUpdater : public QObject
|
||
{
|
||
Q_OBJECT
|
||
|
||
public:
|
||
/*!
|
||
* Start the Sparkle updater, which automatically checks for updates if necessary.
|
||
*/
|
||
SparkleUpdater();
|
||
~SparkleUpdater();
|
||
|
||
/*!
|
||
* Check for updates manually, showing the user a progress bar and an alert if no updates are found.
|
||
*/
|
||
void checkForUpdates();
|
||
|
||
/*!
|
||
* Indicates whether or not to check for updates automatically.
|
||
*/
|
||
bool getAutomaticallyChecksForUpdates();
|
||
|
||
/*!
|
||
* Indicates the current automatic update check interval in seconds.
|
||
*/
|
||
double getUpdateCheckInterval();
|
||
|
||
/*!
|
||
* Indicates the set of Sparkle channels the updater is allowed to find new updates from.
|
||
*/
|
||
QSet<QString> getAllowedChannels();
|
||
|
||
/*!
|
||
* Set whether or not to check for updates automatically.
|
||
*
|
||
* As per Sparkle documentation, "By default, Sparkle asks users on second launch for permission if they want
|
||
* automatic update checks enabled and sets this property based on their response. If SUEnableAutomaticChecks is
|
||
* set in the Info.plist, this permission request is not performed however.
|
||
*
|
||
* Setting this property will persist in the host bundle’s user defaults. Only set this property if you need
|
||
* dynamic behavior (e.g. user preferences).
|
||
*
|
||
* The update schedule cycle will be reset in a short delay after the property’s new value is set. This is to allow
|
||
* reverting this property without kicking off a schedule change immediately."
|
||
*/
|
||
void setAutomaticallyChecksForUpdates(bool check);
|
||
|
||
/*!
|
||
* Set the current automatic update check interval in seconds.
|
||
*
|
||
* As per Sparkle documentation, "Setting this property will persist in the host bundle’s user defaults. For this
|
||
* reason, only set this property if you need dynamic behavior (eg user preferences). Otherwise prefer to set
|
||
* SUScheduledCheckInterval directly in your Info.plist.
|
||
*
|
||
* The update schedule cycle will be reset in a short delay after the property’s new value is set. This is to allow
|
||
* reverting this property without kicking off a schedule change immediately."
|
||
*/
|
||
void setUpdateCheckInterval(double seconds);
|
||
|
||
/*!
|
||
* Clears all allowed Sparkle channels, returning to the default updater channel behavior.
|
||
*/
|
||
void clearAllowedChannels();
|
||
|
||
/*!
|
||
* Set a single Sparkle channel the updater is allowed to find new updates from.
|
||
*
|
||
* Items in the default channel can always be found, regardless of this setting. If an empty string is passed,
|
||
* return to the default behavior.
|
||
*/
|
||
void setAllowedChannel(const QString& channel);
|
||
|
||
/*!
|
||
* Set a set of Sparkle channels the updater is allowed to find new updates from.
|
||
*
|
||
* Items in the default channel can always be found, regardless of this setting. If an empty set is passed,
|
||
* return to the default behavior.
|
||
*/
|
||
void setAllowedChannels(const QSet<QString>& channels);
|
||
|
||
signals:
|
||
/*!
|
||
* Emits whenever the user's ability to check for updates changes.
|
||
*
|
||
* As per Sparkle documentation, "An update check can be made by the user when an update session isn’t in progress,
|
||
* or when an update or its progress is being shown to the user. A user cannot check for updates when data (such
|
||
* as the feed or an update) is still being downloaded automatically in the background.
|
||
*
|
||
* This property is suitable to use for menu item validation for seeing if checkForUpdates can be invoked."
|
||
*/
|
||
void canCheckForUpdatesChanged(bool canCheck);
|
||
|
||
private:
|
||
class Private;
|
||
|
||
Private* priv;
|
||
|
||
void loadChannelsFromSettings();
|
||
};
|
||
|
||
#endif //LAUNCHER_SPARKLEUPDATER_H
|