Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/flaviotordini/updater
An updater for desktop Qt apps. Can use Sparkle on macOS.
https://github.com/flaviotordini/updater
qt update update-checker updater
Last synced: 3 months ago
JSON representation
An updater for desktop Qt apps. Can use Sparkle on macOS.
- Host: GitHub
- URL: https://github.com/flaviotordini/updater
- Owner: flaviotordini
- License: gpl-3.0
- Created: 2020-07-03T08:24:14.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2024-02-06T22:33:34.000Z (about 1 year ago)
- Last Synced: 2024-05-01T14:25:18.682Z (9 months ago)
- Topics: qt, update, update-checker, updater
- Language: C++
- Homepage: https://flavio.tordini.org
- Size: 104 KB
- Stars: 56
- Watchers: 3
- Forks: 10
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: COPYING
Awesome Lists containing this project
README
# An updater for Qt apps
This is an extensible updater for Qt apps. It can wrap [Sparkle](https://sparkle-project.org/) on macOS and use its own implementation on Windows and Linux. I use it in my apps at https://flavio.tordini.org .
## Design
The main interface is [Updater](https://github.com/flaviotordini/updater/blob/master/src/updater.h). A shared Updater subclass instance should be set on startup using `Updater::setInstance()`. Available implementations are:
- [`updater::DefaultUpdater`](https://github.com/flaviotordini/updater/blob/master/src/impl/defaultupdater.h), the default Qt-based implementation.
- [`updater::SparkleUpdater`](https://github.com/flaviotordini/updater/blob/master/src/sparkle/sparkleupdater.h), a Sparkle-based implementation for macOS
## User Interface
### Built-in Widgets
Updater provides ready-to-use widgets:
- `Updater::getAction()` returns a QAction suitable to be inserted in a QMenu.
- `Updater::getLabel()` returns a QLabel that automatically changes its message. Typically used in the about box.
- `Updater::getButton()` returns a QPushButton that autohides or automatically changes its function depending on the Updater status.
When the user triggers the action or pushes the button a dialog will show which is dependent on the Updater implementation.
## Entension Points
[updater::DefaultUpdater](https://github.com/flaviotordini/updater/blob/master/src/impl/defaultupdater.h) has a number of extension points so it can be adapted to different release manifest formats and update mechanisms.
### Parser
Implement [updater::Parser](https://github.com/flaviotordini/updater/blob/master/src/impl/parser.h) to parse your own manifest format. There are two ready-to-use parsers:
- [updater::AppcastParser](https://github.com/flaviotordini/updater/blob/master/src/impl/appcastparser.h). This the appcast format also used by Sparkle. It's a RSS feed with Sparkle extensions.
- [updater::SimpleXmlParser](https://github.com/flaviotordini/updater/blob/master/src/impl/simplexmlparser.h). This is a very simple XML format
Set the desired Parser implementation using `updater::DefaultUpdater::setParser`. The default is [updater::AppcastParser].
### Installer
[updater::Installer](https://github.com/flaviotordini/updater/blob/master/src/impl/installer.h) is the abstraction responsible for preparing and running the update process. Currently the only available Installer implementation is [updater::RunInstaller](https://github.com/flaviotordini/updater/blob/master/src/impl/runinstaller.h). It just runs an executable update payload, optionally with arguments.
Installer can be implemented in other ways, for example an Installer that unzips a payload and moves files. Or one that invokes an update helper. Another idea is signature validation.
Set the desired Installer implementation using `updater::DefaultUpdater::setInstaller`. The default is [updater::RunInstaller].
## Build Instructions
### qmake
```
mkdir build
cd build
qmake ..
make
```
## Integration
You can use this library as a git submodule. For example, add it to your project inside a lib subdirectory:
```
git submodule add -b master https://github.com/flaviotordini/updater lib/updater
```
Then you can update your git submodules like this:
```
git submodule update --init --recursive --remote
```
To integrate the library in your qmake based project just add this to your .pro file:
```
include(lib/updater/updater.pri)
```
qmake builds all object files in the same directory. In order to avoid filename clashes use:
```
CONFIG += object_parallel_to_source
```
## Examples
Example setup of the shared Updater instance:
```
#include "updater.h"
#ifdef UPDATER_SPARKLE
#include "sparkleupdater.h"
#else
#include "defaultupdater.h"
#endif
void setupUpdater() {
#ifdef UPDATER_SPARKLE
Updater::setInstance(new updater::SparkleUpdater());
#else
auto updater = new updater::DefaultUpdater();
updater->setManifestUrl(myAppcastUrl);
Updater::setInstance(updater);
#endif
}
```
Updater provides a QAction instance ready to be used in a menu.
```
myMenu->addAction(Updater::instance().getAction());
```
In the About box you can use the standard widgets provided by Updater. A QLabel and a QPushButton.
```
myLayout->addWidget(Updater::instance().getLabel());
myLayout->addWidget(Updater::instance().getButton());
```
## Security
Always serve your manifest files and binary updates via HTTPS.
## Support
If you need more features or integration with your product, I'm available for hire.
## License
You can use this library under the GPLv3 license terms. If you do, you're welcome contributing your changes and fixes. Donations are welcome at https://flavio.tordini.org/donate
For commercial projects I ask for a one-time license fee, contact me at [email protected]