Sneederix/sneedmc
2
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity
c0bf267bae
sneedmc/launcher/updater/MacSparkleUpdater.h

127 lines
4.4 KiB
C
Raw Normal View History

Create `SparkleUpdater` class for access from Qt/C++ 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.
2022-04-20 04:34:17 +00:00
// 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/>.
*/
Refactor code, create abstract class `ExternalUpdater` (Hopefully) this makes implementing updaters using external libraries easier on other platforms. To implement an updater on a new platform, create a new class that implements the pure virtual methods from `ExternalUpdater` and add code in the `UpdateChecker` initializer to initialize the new class.
2022-04-25 23:33:17 +00:00
#ifndef LAUNCHER_MACSPARKLEUPDATER_H
#define LAUNCHER_MACSPARKLEUPDATER_H
Create `SparkleUpdater` class for access from Qt/C++ 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.
2022-04-20 04:34:17 +00:00
#include <QObject>
#include <QSet>
Refactor code, create abstract class `ExternalUpdater` (Hopefully) this makes implementing updaters using external libraries easier on other platforms. To implement an updater on a new platform, create a new class that implements the pure virtual methods from `ExternalUpdater` and add code in the `UpdateChecker` initializer to initialize the new class.
2022-04-25 23:33:17 +00:00
#include "ExternalUpdater.h"
Create `SparkleUpdater` class for access from Qt/C++ 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.
2022-04-20 04:34:17 +00:00
Refactor code, create abstract class `ExternalUpdater` (Hopefully) this makes implementing updaters using external libraries easier on other platforms. To implement an updater on a new platform, create a new class that implements the pure virtual methods from `ExternalUpdater` and add code in the `UpdateChecker` initializer to initialize the new class.
2022-04-25 23:33:17 +00:00
/*!
* An implementation for the updater on macOS that uses the Sparkle framework.
*/
class MacSparkleUpdater : public ExternalUpdater
Create `SparkleUpdater` class for access from Qt/C++ 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.
2022-04-20 04:34:17 +00:00
{
Q_OBJECT
public:
/*!
* Start the Sparkle updater, which automatically checks for updates if necessary.
*/
Refactor code, create abstract class `ExternalUpdater` (Hopefully) this makes implementing updaters using external libraries easier on other platforms. To implement an updater on a new platform, create a new class that implements the pure virtual methods from `ExternalUpdater` and add code in the `UpdateChecker` initializer to initialize the new class.
2022-04-25 23:33:17 +00:00
MacSparkleUpdater();
~MacSparkleUpdater() override;
Create `SparkleUpdater` class for access from Qt/C++ 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.
2022-04-20 04:34:17 +00:00
/*!
* Check for updates manually, showing the user a progress bar and an alert if no updates are found.
*/
Refactor code, create abstract class `ExternalUpdater` (Hopefully) this makes implementing updaters using external libraries easier on other platforms. To implement an updater on a new platform, create a new class that implements the pure virtual methods from `ExternalUpdater` and add code in the `UpdateChecker` initializer to initialize the new class.
2022-04-25 23:33:17 +00:00
void checkForUpdates() override;
Create `SparkleUpdater` class for access from Qt/C++ 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.
2022-04-20 04:34:17 +00:00
/*!
* Indicates whether or not to check for updates automatically.
*/
Refactor code, create abstract class `ExternalUpdater` (Hopefully) this makes implementing updaters using external libraries easier on other platforms. To implement an updater on a new platform, create a new class that implements the pure virtual methods from `ExternalUpdater` and add code in the `UpdateChecker` initializer to initialize the new class.
2022-04-25 23:33:17 +00:00
bool getAutomaticallyChecksForUpdates() override;
Create `SparkleUpdater` class for access from Qt/C++ 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.
2022-04-20 04:34:17 +00:00
/*!
* Indicates the current automatic update check interval in seconds.
*/
Refactor code, create abstract class `ExternalUpdater` (Hopefully) this makes implementing updaters using external libraries easier on other platforms. To implement an updater on a new platform, create a new class that implements the pure virtual methods from `ExternalUpdater` and add code in the `UpdateChecker` initializer to initialize the new class.
2022-04-25 23:33:17 +00:00
double getUpdateCheckInterval() override;
Create `SparkleUpdater` class for access from Qt/C++ 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.
2022-04-20 04:34:17 +00:00
/*!
* Indicates the set of Sparkle channels the updater is allowed to find new updates from.
*/
QSet<QString> getAllowedChannels();
Refactor code, create abstract class `ExternalUpdater` (Hopefully) this makes implementing updaters using external libraries easier on other platforms. To implement an updater on a new platform, create a new class that implements the pure virtual methods from `ExternalUpdater` and add code in the `UpdateChecker` initializer to initialize the new class.
2022-04-25 23:33:17 +00:00
/*!
* Indicates whether or not beta updates should be checked for in addition to regular releases.
*/
bool getBetaAllowed() override;
Create `SparkleUpdater` class for access from Qt/C++ 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.
2022-04-20 04:34:17 +00:00
/*!
* 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."
*/
Refactor code, create abstract class `ExternalUpdater` (Hopefully) this makes implementing updaters using external libraries easier on other platforms. To implement an updater on a new platform, create a new class that implements the pure virtual methods from `ExternalUpdater` and add code in the `UpdateChecker` initializer to initialize the new class.
2022-04-25 23:33:17 +00:00
void setAutomaticallyChecksForUpdates(bool check) override;
Create `SparkleUpdater` class for access from Qt/C++ 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.
2022-04-20 04:34:17 +00:00
/*!
* 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."
*/
Refactor code, create abstract class `ExternalUpdater` (Hopefully) this makes implementing updaters using external libraries easier on other platforms. To implement an updater on a new platform, create a new class that implements the pure virtual methods from `ExternalUpdater` and add code in the `UpdateChecker` initializer to initialize the new class.
2022-04-25 23:33:17 +00:00
void setUpdateCheckInterval(double seconds) override;
Create `SparkleUpdater` class for access from Qt/C++ 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.
2022-04-20 04:34:17 +00:00
/*!
* 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);
/*!
Refactor code, create abstract class `ExternalUpdater` (Hopefully) this makes implementing updaters using external libraries easier on other platforms. To implement an updater on a new platform, create a new class that implements the pure virtual methods from `ExternalUpdater` and add code in the `UpdateChecker` initializer to initialize the new class.
2022-04-25 23:33:17 +00:00
* Set whether or not beta updates should be checked for in addition to regular releases.
Create `SparkleUpdater` class for access from Qt/C++ 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.
2022-04-20 04:34:17 +00:00
*/
Refactor code, create abstract class `ExternalUpdater` (Hopefully) this makes implementing updaters using external libraries easier on other platforms. To implement an updater on a new platform, create a new class that implements the pure virtual methods from `ExternalUpdater` and add code in the `UpdateChecker` initializer to initialize the new class.
2022-04-25 23:33:17 +00:00
void setBetaAllowed(bool allowed) override;
Create `SparkleUpdater` class for access from Qt/C++ 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.
2022-04-20 04:34:17 +00:00
private:
class Private;
Refactor code, create abstract class `ExternalUpdater` (Hopefully) this makes implementing updaters using external libraries easier on other platforms. To implement an updater on a new platform, create a new class that implements the pure virtual methods from `ExternalUpdater` and add code in the `UpdateChecker` initializer to initialize the new class.
2022-04-25 23:33:17 +00:00
Private *priv;
Create `SparkleUpdater` class for access from Qt/C++ 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.
2022-04-20 04:34:17 +00:00
void loadChannelsFromSettings();
};
Refactor code, create abstract class `ExternalUpdater` (Hopefully) this makes implementing updaters using external libraries easier on other platforms. To implement an updater on a new platform, create a new class that implements the pure virtual methods from `ExternalUpdater` and add code in the `UpdateChecker` initializer to initialize the new class.
2022-04-25 23:33:17 +00:00
#endif //LAUNCHER_MACSPARKLEUPDATER_H
Reference in New Issue Copy Permalink