app_updates.hpp

Go to the documentation of this file.

#pragma once
 
// In-app software updates, as a service the hosting process may provide.
//
// A standalone app that embeds an updater (Sparkle, via pulp_add_sparkle())
// installs an AppUpdateService at launch. Everything else -- an AU, VST3,
// CLAP or AAX plug-in inside a DAW, a test binary, a build without an
// updater -- has none installed, and every query below then reports
// `available == false`. That is the contract an editor relies on: the
// editor code is shared by every format, so it asks app_update_status() and
// shows its "Check for Updates" controls only when the answer is available.
//
// Surfaces built on this service:
//   * the standalone app menu's "Check for Updates…" item (standalone.cpp),
//   * AppUpdatesSettingsView, a drop-in Settings group for native editors
//     (pulp/format/app_updates_settings_view.hpp),
//   * add_app_update_handlers(), the EditorBridge messages a JS editor calls
//     (pulp/format/app_updates_bridge.hpp; client in @pulp/react).
//
// Extension point (not built): a plug-in may later install its own service
// that never runs an installer in the host's process -- for example one that
// reads the same appcast, reports a newer version, and whose
// check_for_updates() opens `releases_url` or asks the standalone app to
// update. The status shape already carries what such a notice needs.
 
#include <cstdint>
#include <memory>
#include <string>
 
namespace pulp::format {

enum class AppUpdateInstaller : std::uint8_t {
    unknown,    
    package,    
    app_bundle, 
};
 
struct AppUpdateStatus {
    bool available = false;
    bool can_check_now = false;
    bool automatic_checks = false;
    bool automatic_install = false;
    bool stub = false;
    std::string app_name;
    std::string version;
    std::string build;
    std::int64_t last_check_unix_seconds = 0;
    std::string releases_url;
    std::string feed_host;
    AppUpdateInstaller installer = AppUpdateInstaller::unknown;
};
 
class AppUpdateService {
  public:
    virtual ~AppUpdateService() = default;
    [[nodiscard]] virtual AppUpdateStatus status() const = 0;
    virtual bool check_for_updates() = 0;
    virtual bool set_automatic_checks(bool on) = 0;
    virtual bool open_releases_page() {
        return false;
    }
};

void set_app_update_service(std::shared_ptr<AppUpdateService> service);
[[nodiscard]] std::shared_ptr<AppUpdateService> app_update_service();

[[nodiscard]] AppUpdateStatus app_update_status();
bool check_for_app_updates();
bool set_app_update_automatic_checks(bool on);
bool open_app_releases_page();

[[nodiscard]] std::string app_update_note(const AppUpdateStatus& status);

[[nodiscard]] std::string app_update_version_text(const AppUpdateStatus& status);

[[nodiscard]] std::string app_update_last_check_text(const AppUpdateStatus& status);

[[nodiscard]] std::string app_update_status_json(const AppUpdateStatus& status);
 
} // namespace pulp::format