Implement XDG Desktop Portal support #9727
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,84 @@ | ||
| /* | ||
| * SPDX-FileCopyrightText: 2026 Nextcloud GmbH and Nextcloud contributors | ||
| * SPDX-License-Identifier: GPL-2.0-or-later | ||
| */ | ||
|
|
||
| #include "xdg_portal.h" | ||
| #include "utility.h" | ||
| #include <QtDBus/QDBusConnection> | ||
| #include <QtDBus/QDBusConnectionInterface> | ||
| #include <QtDBus/QDBusInterface> | ||
| #include <QtDBus/QDBusMessage> | ||
| #include <QDebug> | ||
| #include <QFileInfo> | ||
| #include <QCoreApplication> | ||
|
|
||
| namespace OCC { | ||
|
|
||
| constexpr auto portalDesktopService = "org.freedesktop.portal.Desktop"; | ||
| constexpr auto portalDesktopPath = "/org/freedesktop/portal/desktop"; | ||
|
|
||
| XdgPortal::XdgPortal(QObject *parent) | ||
| : QObject(parent) | ||
| , m_available(false) | ||
| { | ||
| initPortalInterface(); | ||
| } | ||
|
|
||
| void XdgPortal::initPortalInterface() | ||
| { | ||
| auto *busInterface = QDBusConnection::sessionBus().interface(); | ||
| if (!busInterface) { | ||
| qWarning() << "XDG Desktop Portal not available"; | ||
| return; | ||
| } | ||
|
|
||
| const auto registered = busInterface->isServiceRegistered(QLatin1String(portalDesktopService)); | ||
| m_available = registered.isValid() && registered.value(); | ||
| if (!m_available) { | ||
| qWarning() << "XDG Desktop Portal not available"; | ||
| } | ||
| } | ||
|
|
||
| bool XdgPortal::background(const QString &handle_token, const bool &autostart) | ||
| { | ||
| if (!m_available) { | ||
| return false; | ||
| } | ||
|
|
||
| QDBusInterface backgroundInterface( | ||
| QLatin1String(portalDesktopService), | ||
| QLatin1String(portalDesktopPath), | ||
| QLatin1String("org.freedesktop.portal.Background"), | ||
| QDBusConnection::sessionBus()); | ||
| if (!backgroundInterface.isValid()) { // just in case | ||
| qWarning() << "org.freedesktop.portal.Background not available"; | ||
| return false; | ||
| } | ||
|
|
||
| QVariantMap options; | ||
| options[QLatin1String("autostart")] = autostart; | ||
| const QString flatpakId = qEnvironmentVariable("FLATPAK_ID"); | ||
| if (flatpakId.isNull()) { | ||
| QStringList list = {Utility::getAppExecutablePath(), QLatin1String("--background")}; | ||
| options[QLatin1String("commandline")] = list; | ||
| } else { // when an app is running as a flatpak its "commandline" parameter is handled differently | ||
| QStringList list = {QFileInfo(QCoreApplication::applicationFilePath()).fileName(), QLatin1String("--background")}; | ||
|
Comment on lines
+65
to
+66
Member
There was a problem hiding this comment. How is it different? does
Author
There was a problem hiding this comment.
Something (either D-Bus, Qt, or Flatpak, I'm not exactly sure what) changes how the When not running in a flatpak then the As for the |
||
| options[QLatin1String("commandline")] = list; | ||
| } | ||
|
|
||
| QDBusMessage reply = backgroundInterface.call( | ||
| QLatin1String("RequestBackground"), | ||
| handle_token, | ||
| options | ||
| ); | ||
|
|
||
| if (reply.type() == QDBusMessage::ErrorMessage) { | ||
| qWarning() << "Background request failed: " << reply.errorMessage(); | ||
| return false; | ||
| } | ||
|
|
||
| return true; | ||
| } | ||
|
|
||
| } // namespace OCC | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,43 @@ | ||
| /* | ||
| * SPDX-FileCopyrightText: 2026 Nextcloud GmbH and Nextcloud contributors | ||
| * SPDX-License-Identifier: GPL-2.0-or-later | ||
| */ | ||
|
|
||
| #ifndef XDG_PORTAL_H | ||
| #define XDG_PORTAL_H | ||
|
|
||
| #include <QObject> | ||
| #include <QString> | ||
| #include <QVariantMap> | ||
|
|
||
| namespace OCC { | ||
|
|
||
| /** | ||
| * @brief XDG Desktop Portal interface for Qt D-Bus | ||
| * | ||
| * Abstracts D-Bus calls behind simpler methods. | ||
| */ | ||
| class XdgPortal : public QObject | ||
| { | ||
| Q_OBJECT | ||
|
|
||
| public: | ||
| explicit XdgPortal(QObject *parent = nullptr); | ||
|
|
||
| /** | ||
| * @brief Requests that the application is allowed to run in the background; see https://flatpak.github.io/xdg-desktop-portal/docs/doc-org.freedesktop.portal.Background.html | ||
| * @param handle_token A string that will be used as the last element of the handle. Must be a valid object path element. See the [Request](https://flatpak.github.io/xdg-desktop-portal/docs/doc-org.freedesktop.portal.Request.html#org-freedesktop-portal-request) documentation for more information about the handle. | ||
| * @param autostart true if the app also wants to be started automatically at login. | ||
| * @return True if successful | ||
| */ | ||
| bool background(const QString &handle_token, const bool &autostart); | ||
|
|
||
| private: | ||
| bool m_available; | ||
|
|
||
| void initPortalInterface(); | ||
| }; | ||
|
|
||
| } // namespace OCC | ||
|
|
||
| #endif // XDG_PORTAL_H |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
hmm, I guess when portals are in use we have no other option than relying on the value of
launchOnSystemStartupfrom the config fileperhaps we need to keep track of whether the background portal was used when setting this property