Line data    Source code

       1              : /*
       2              :  * SPDX-License-Identifier: GPL-3.0-only
       3              :  * MuseScore-CLA-applies
       4              :  *
       5              :  * MuseScore Studio
       6              :  * Music Composition & Notation
       7              :  *
       8              :  * Copyright (C) 2026 MuseScore Limited and others
       9              :  *
      10              :  * This program is free software: you can redistribute it and/or modify
      11              :  * it under the terms of the GNU General Public License version 3 as
      12              :  * published by the Free Software Foundation.
      13              :  *
      14              :  * This program is distributed in the hope that it will be useful,
      15              :  * but WITHOUT ANY WARRANTY; without even the implied warranty of
      16              :  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
      17              :  * GNU General Public License for more details.
      18              :  *
      19              :  * You should have received a copy of the GNU General Public License
      20              :  * along with this program.  If not, see <https://www.gnu.org/licenses/>.
      21              :  */
      22              : #ifndef MUSE_UPDATE_IUPDATEINSTALLER_H
      23              : #define MUSE_UPDATE_IUPDATEINSTALLER_H
      24              : 
      25              : #include "types/ret.h"
      26              : #include "types/retval.h"
      27              : #include "io/path.h"
      28              : 
      29              : #include "modularity/imoduleinterface.h"
      30              : 
      31              : #include "updatetypes.h"
      32              : 
      33              : namespace muse::update {
      34              : class IUpdateInstaller : MODULE_GLOBAL_INTERFACE
      35              : {
      36            0 :     INTERFACE_ID(IUpdateInstaller)
      37              : 
      38              : public:
      39           26 :     virtual ~IUpdateInstaller() = default;
      40              : 
      41              :     //! Whether this platform can apply an update in-place (replace the install
      42              :     //! location and restart) AND the install location is writable by the
      43              :     //! current user. When false, callers should fall back to opening the
      44              :     //! downloaded installer for the user to run manually.
      45              :     virtual bool isInPlaceUpdateSupported() const = 0;
      46              : 
      47              :     //! Heavy phase: validate the downloaded package and stage everything the
      48              :     //! swap needs. Safe to run off the UI thread while the app keeps running,
      49              :     //! so failures can still be surfaced to the user. Returns the prepared
      50              :     //! payload to pass to finalizeUpdate().
      51              :     virtual RetVal<muse::io::path_t> prepareUpdate(const muse::io::path_t& packagePath) = 0;
      52              : 
      53              :     //! Fast phase, run on user confirmation: spawn the standalone helper that
      54              :     //! replaces the current install location once this process exits and
      55              :     //! relaunches the application. Returns OK if the helper was successfully
      56              :     //! spawned; the caller must then quit the application.
      57              :     //!
      58              :     //! `ui` is what the helper should show while it installs.
      59              :     virtual Ret finalizeUpdate(const muse::io::path_t& preparedPath, const InstallProgressUi& ui) = 0;
      60              : };
      61              : }
      62              : 
      63              : #endif // MUSE_UPDATE_IUPDATEINSTALLER_H