source: vbox/trunk/src/VBox/Frontends/VirtualBox/src/globals/UIExtension.cpp

/* $Id: UIExtension.cpp 103783 2024-03-11 17:29:21Z vboxsync $ */
/** @file
 * VBox Qt GUI - UIExtension namespace implementation.
 */

/*
 * Copyright (C) 2006-2024 Oracle and/or its affiliates.
 *
 * This file is part of VirtualBox base platform packages, as
 * available from https://www.virtualbox.org.
 *
 * 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, in version 3 of the
 * License.
 *
 * 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>.
 *
 * SPDX-License-Identifier: GPL-3.0-only
 */

/* GUI includes: */
#include "UIExtension.h"
#include "UIGlobalSession.h"
#include "UINotificationCenter.h"
#include "UIMessageCenter.h"
#include "VBoxLicenseViewer.h"

/* COM includes: */
#include "CExtPack.h"


void UIExtension::install(const QString &strFilePath,
                          const QString &strDigest,
                          QWidget *pParent,
                          QString *pstrExtPackName)
{
    /* If the extension pack manager isn't available, skip any attempts to install: */
    CExtPackManager comExtPackManager = gpGlobalSession->virtualBox().GetExtensionPackManager();
    if (comExtPackManager.isNull())
        return;
    /* Open the extpack tarball via IExtPackManager: */
    CExtPackFile comExtPackFile;
    if (strDigest.isEmpty())
        comExtPackFile = comExtPackManager.OpenExtPackFile(strFilePath);
    else
    {
        QString strFileAndHash = QString("%1::SHA-256=%2").arg(strFilePath).arg(strDigest);
        comExtPackFile = comExtPackManager.OpenExtPackFile(strFileAndHash);
    }
    if (!comExtPackManager.isOk())
    {
        UINotificationMessage::cannotOpenExtPack(comExtPackManager, strFilePath);
        return;
    }

    if (!comExtPackFile.GetUsable())
    {
        UINotificationMessage::cannotReadExtPack(comExtPackFile, strFilePath);
        return;
    }

    const QString strPackName = comExtPackFile.GetName();
    const QString strPackDescription = comExtPackFile.GetDescription();
    const QString strPackVersion = QString("%1r%2%3").arg(comExtPackFile.GetVersion()).arg(comExtPackFile.GetRevision()).arg(comExtPackFile.GetEdition());

    /* Check if there is a version of the extension pack already
     * installed on the system and let the user decide what to do about it. */
    CExtPack comExtPackCur = comExtPackManager.Find(strPackName);
    bool fReplaceIt = comExtPackCur.isOk();
    if (fReplaceIt)
    {
        QString strPackVersionCur = QString("%1r%2%3").arg(comExtPackCur.GetVersion()).arg(comExtPackCur.GetRevision()).arg(comExtPackCur.GetEdition());
        if (!msgCenter().confirmReplaceExtensionPack(strPackName, strPackVersion, strPackVersionCur, strPackDescription, pParent))
            return;
    }
    /* If it's a new package just ask for general confirmation. */
    else
    {
        if (!msgCenter().confirmInstallExtensionPack(strPackName, strPackVersion, strPackDescription, pParent))
            return;
    }

    /* Display the license dialog if required by the extension pack. */
    if (comExtPackFile.GetShowLicense())
    {
        QString strLicense = comExtPackFile.GetLicense();
        VBoxLicenseViewer licenseViewer(pParent);
        if (licenseViewer.showLicenseFromString(strLicense) != QDialog::Accepted)
            return;
    }

    /* Install the selected package.
     * Set the package name return value before doing
     * this as the caller should do a refresh even on failure. */
    QString strDisplayInfo;
#ifdef VBOX_WS_WIN
    if (pParent)
        strDisplayInfo = QString::asprintf("hwnd=%#llx", (uint64_t)(uintptr_t)pParent->winId());
#endif

    /* Install extension pack: */
    UINotificationProgressExtensionPackInstall *pNotification =
            new UINotificationProgressExtensionPackInstall(comExtPackFile,
                                                           fReplaceIt,
                                                           strPackName,
                                                           strDisplayInfo);
    gpNotificationCenter->append(pNotification);

    /* Store the name: */
    if (pstrExtPackName)
        *pstrExtPackName = strPackName;
}

bool UIExtension::isExtentionPackInstalled()
{
    /* Acquire extension pack manager: */
    const CVirtualBox comVBox = gpGlobalSession->virtualBox();
    const CExtPackManager comEPManager = comVBox.GetExtensionPackManager();
    if (!comVBox.isOk())
        return false;

    /* Acquire a list of extension packs: */
    const QVector<CExtPack> extensionPacks = comEPManager.GetInstalledExtPacks();
    if (!comEPManager.isOk())
        return false;

    /* Make sure at least one installed ext pack is usable: */
    foreach (const CExtPack &comExtensionPack, extensionPacks)
    {
        if (!comExtensionPack.isOk())
            continue;
        const bool fUsable = comExtensionPack.GetUsable();
        if (comExtensionPack.isOk() && fUsable)
            return true;
    }

    /* False by default: */
    return false;
}