feat: wallpaper usage treeland personalization manager protocol

Signed-off-by: pengwenhao <[email protected]>

misc/dde.portal

@@ -1,4 +1,4 @@
 [portal]
 DBusName=org.freedesktop.impl.portal.desktop.dde
-Interfaces=org.freedesktop.impl.portal.Screenshot;org.freedesktop.impl.portal.Notification;org.freedesktop.impl.portal.FileChooser;org.freedesktop.impl.portal.Wallpaper;org.freedesktop.impl.portal.ScreenCast;org.freedesktop.impl.portal.RemoteDesktop
+Interfaces=org.freedesktop.impl.portal.Screenshot;org.freedesktop.impl.portal.Notification;org.freedesktop.impl.portal.FileChooser;org.freedesktop.impl.portal.Wallpaper;org.freedesktop.impl.portal.ScreenCast;org.freedesktop.impl.portal.RemoteDesktop;org.freedesktop.impl.portal.Access
 UseIn=DDE

protocol/treeland-personalization-manager-v1.xml

@@ -0,0 +1,188 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<protocol name="treeland_personalization_manager_v1">
+    <copyright>
+        Copyright © 2023 Uniontech
+
+        Permission is hereby granted, free of charge, to any person obtaining a
+        copy of this software and associated documentation files (the "Software"),
+        to deal in the Software without restriction, including without limitation
+        the rights to use, copy, modify, merge, publish, distribute, sublicense,
+        and/or sell copies of the Software, and to permit persons to whom the
+        Software is furnished to do so, subject to the following conditions:
+
+        The above copyright notice and this permission notice (including the next
+        paragraph) shall be included in all copies or substantial portions of the
+        Software.
+
+        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+        FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.  IN NO EVENT SHALL
+        THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+        LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
+        FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
+        DEALINGS IN THE SOFTWARE.
+    </copyright>
+    <interface name="treeland_personalization_manager_v1" version="1">
+        <description summary="personalization manager">
+        This interface allows a client to customized display effects.
+
+        Warning! The protocol described in this file is currently in the testing
+        phase. Backward compatible changes may be added together with the
+        corresponding interface version bump. Backward incompatible changes can
+        only be done by creating a new major version of the extension.
+        </description>
+        <request name="get_window_context">
+            <description summary="get personalization window context">
+                set window background, shadow based on context
+            </description>
+            <arg name="id" type="new_id" interface="personalization_window_context_v1"/>
+            <arg name="surface" type="object" interface="wl_surface"/>
+        </request>
+        <request name="get_wallpaper_context">
+            <description summary="custom wallpaper context">
+                custom user wallpaper
+            </description>
+            <arg name="id" type="new_id" interface="personalization_wallpaper_context_v1"/>
+        </request>
+        <request name="get_cursor_context">
+            <description summary="custom wallpaper context">
+                custom user cursor
+            </description>
+            <arg name="id" type="new_id" interface="personalization_cursor_context_v1"/>
+        </request>
+    </interface>
+    <interface name="personalization_wallpaper_context_v1" version="1">
+        <description summary="client custom wallpaper context">
+        This interface allows a client personalization wallpaper.
+
+        Warning! The protocol described in this file is currently in the testing
+        phase. Backward compatible changes may be added together with the
+        corresponding interface version bump. Backward incompatible changes can
+        only be done by creating a new major version of the extension.
+        </description>
+        <request name="set_fd">
+            <description summary="set the current user's wallpaper fd"/>
+            <arg name="fd" type="fd" summary="wallpaper file fd"/>
+            <arg name="metadata" type="string" summary="file related metadata information"/>
+        </request>
+        <request name="set_identifier">
+            <description summary="identifier for the application window" />
+            <arg name="identifier" type="string" summary="Identifier for the application window"/>
+        </request>
+        <enum name="options">
+            <description summary="xdg desktop portal supported keys" />
+            <entry name="preview" value="1" summary="whether to show a preview of the picture"/>
+            <entry name="background" value="2" summary="configure screen background"/>
+            <entry name="lockscreen" value="4" summary="configure screen wallpaper"/>
+        </enum>
+        <request name="set_output">
+            <description summary="configure xdg desktop portal options"/>
+            <arg name="output" type="string" summary="system output name"/>
+        </request>
+        <request name="set_on">
+            <description summary="configure xdg desktop portal options"/>
+            <arg name="options" type="uint" enum="options" summary="xdg desktop portal options"/>
+        </request>
+        <request name="commit">
+            <description summary="commit configuration" />
+        </request>
+        <request name="get_metadata">
+            <description summary="get user save meta data">
+                get the current user's wallpaper
+            </description>
+        </request>
+        <request name="destroy" type="destructor">
+            <description summary="destroy the context object">
+                Destroy the context object.
+            </description>
+        </request>
+        <event name="metadata">
+            <description summary="get metadata event">
+                Send this signal after getting the user's wallpaper.
+            </description>
+            <arg name="metadata" type="string" summary="user meta data"/>
+        </event>
+    </interface>
+    <interface name="personalization_cursor_context_v1" version="1">
+        <description summary="client custom cursor context">
+        This interface allows a client personalization cursor.
+
+        Warning! The protocol described in this file is currently in the testing
+        phase. Backward compatible changes may be added together with the
+        corresponding interface version bump. Backward incompatible changes can
+        only be done by creating a new major version of the extension.
+        </description>
+        <request name="set_theme">
+            <description summary="set system cursor theme"/>
+            <arg name="name" type="string" summary="cursor theme name"/>
+        </request>
+        <request name="get_theme">
+            <description summary="get system cursor theme"/>
+        </request>
+        <request name="set_size">
+            <description summary="set system cursor size"/>
+            <arg name="size" type="uint" summary="cursor size"/>
+        </request>
+        <request name="get_size">
+            <description summary="get system cursor size"/>
+        </request>
+        <request name="commit">
+            <description summary="commit configure">
+            if only one commit fails validation, the commit will fail
+            </description>
+        </request>
+        <request name="destroy" type="destructor">
+            <description summary="destroy the context object">
+                Destroy the context object.
+            </description>
+        </request>
+        <event name="verfity">
+            <description summary="verfity event">
+                Send this signal after commit cursor configure.
+            </description>
+            <arg name="success" type="int" summary="check whether the configuration is successful"/>
+        </event>
+        <event name="theme">
+            <description summary="cursor theme changed event">
+                Send this signal after system cursor theme changed.
+            </description>
+            <arg name="name" type="string" summary="cursor theme name"/>
+        </event>
+        <event name="size">
+            <description summary="cursor size changed event">
+                Send this signal after system cursor size changed.
+            </description>
+            <arg name="size" type="uint" summary="cursor size"/>
+        </event>
+    </interface>
+    <interface name="personalization_window_context_v1" version="1">
+        <description summary="client custom window context">
+        This interface allows a client personalization window.
+
+        Warning! The protocol described in this file is currently in the testing
+        phase. Backward compatible changes may be added together with the
+        corresponding interface version bump. Backward incompatible changes can
+        only be done by creating a new major version of the extension.
+        </description>
+        <enum name="background_type">
+            <description summary="Windows will have different background effects">
+                This will instruct the compositor how to set the background
+                for the window, desktop.
+            </description>
+            <entry name="normal" value="0" summary="not draw the background image"/>
+            <entry name="wallpaper" value="1" summary="draw the background image"/>
+            <entry name="blend" value="2" summary="draw the blend background image"/>
+        </enum>
+        <request name="set_background_type">
+            <description summary="set window background type">
+                Destroy the context object.
+            </description>
+            <arg name="type" type="uint" summary="background enum"/>
+        </request>
+        <request name="destroy" type="destructor">
+            <description summary="destroy the context object">
+                Destroy the context object.
+            </description>
+        </request>
+    </interface>
+</protocol>

src/CMakeLists.txt

@@ -52,6 +52,8 @@ set(SRC
     iteminfo.cpp
     account.h
     account.cpp
+    access.cpp
+    access.h
     globalshortcut.h
     globalshortcut.cpp
     lockdown.h
@@ -63,11 +65,18 @@ set(SRC
     dbushelpers.h
     utils.h
     utils.cpp
+    personalization_manager_client.h
+    personalization_manager_client.cpp
 )
 
 add_executable(${PROJECT_NAME}
     ${SRC})
 
+qt6_generate_wayland_protocol_client_sources(${PROJECT_NAME}
+    FILES
+    ${CMAKE_SOURCE_DIR}/protocol/treeland-personalization-manager-v1.xml
+)
+
 target_link_libraries(${PROJECT_NAME} PUBLIC
     Qt::Core
     Qt::Widgets

src/access.cpp

@@ -0,0 +1,59 @@
+// Copyright (C) 2024 Wenhao Peng <[email protected]>.
+// SPDX-License-Identifier: Apache-2.0 OR LGPL-3.0-only OR GPL-2.0-only OR GPL-3.0-only
+
+#include "access.h"
+
+#include <sys/types.h>
+#include <unistd.h>
+
+#include <QLoggingCategory>
+#include <QVariantMap>
+#include <QDBusMessage>
+#include <QDBusPendingReply>
+#include <QDBusConnection>
+#include <QMessageBox>
+
+Q_LOGGING_CATEGORY(XdgDestkopDDEAccess, "xdg-dde-access")
+
+AccessPortal::AccessPortal(QObject *parent)
+    : QDBusAbstractAdaptor(parent)
+{
+    qCDebug(XdgDestkopDDEAccess) << "access init";
+}
+
+uint AccessPortal::AccessDialog(
+        const QDBusObjectPath &handle, const QString &app_id, const QString &parent_window, const QString &title,
+        const QString &subtitle, const QString &body, const QVariantMap &options, QVariantMap &results)
+{
+    qCDebug(XdgDestkopDDEAccess) << "request for access dialog";
+
+    QMessageBox access_dialog;
+
+    if (options.contains(QStringLiteral("modal"))) {
+        access_dialog.setModal(options.value(QStringLiteral("modal")).toBool());
+    }
+
+    QPushButton *rejectButton = nullptr;
+    if (options.contains(QStringLiteral("deny_label"))) {
+        rejectButton = access_dialog.addButton(options.value(QStringLiteral("deny_label")).toString(), QMessageBox::RejectRole);
+    }
+
+
+    QPushButton *allowButton = nullptr;
+    if (options.contains(QStringLiteral("grant_label"))) {
+        allowButton = access_dialog.addButton(options.value(QStringLiteral("grant_label")).toString(), QMessageBox::AcceptRole);
+    }
+
+    access_dialog.setWindowTitle(title);
+    access_dialog.setText(body);
+    access_dialog.exec();
+
+    uint respnse = 2;
+    if (access_dialog.clickedButton() == (QAbstractButton*)rejectButton) {
+        respnse = 0;
+    } else if (access_dialog.clickedButton() == (QAbstractButton*)allowButton) {
+        respnse = 1;
+    }
+
+    return respnse;
+}

src/access.h

@@ -0,0 +1,27 @@
+// Copyright (C) 2024 pengwenhao <[email protected]>.
+// SPDX-License-Identifier: Apache-2.0 OR LGPL-3.0-only OR GPL-2.0-only OR GPL-3.0-only
+
+#pragma once
+
+#include <QDBusAbstractAdaptor>
+#include <QDBusObjectPath>
+
+class AccessPortal : public QDBusAbstractAdaptor
+{
+    Q_OBJECT
+    Q_CLASSINFO("D-Bus Interface", "org.freedesktop.impl.portal.Access")
+
+public:
+    explicit AccessPortal(QObject *parent);
+    ~AccessPortal() = default;
+
+public slots:
+    uint AccessDialog(const QDBusObjectPath &handle,
+                      const QString &app_id,
+                      const QString &parent_window,
+                      const QString &title,
+                      const QString &subtitle,
+                      const QString &body,
+                      const QVariantMap &options,
+                      QVariantMap &results);
+};

src/account.h

@@ -1,6 +1,5 @@
-// SPDX-FileCopyrightText: 2021 - 2022 UnionTech Software Technology Co., Ltd.
-//
-// SPDX-License-Identifier: LGPL-3.0-or-later
+// Copyright (C) 2024 Wenhao Peng <[email protected]>.
+// SPDX-License-Identifier: Apache-2.0 OR LGPL-3.0-only OR GPL-2.0-only OR GPL-3.0-only
 
 #pragma once
 

src/ddesktopportal.cpp

@@ -16,13 +16,15 @@
 #include "filechooser.h"
 #include "wallpaper.h"
 #include "notification.h"
+#include "access.h"
 
 DDesktopPortal::DDesktopPortal(QObject *parent)
     : QObject(parent)
     , m_appChooser(new AppChooserPortal(this))
     , m_fileChooser(new FileChooserPortal(this))
     , m_wallpaper(new WallPaperPortal(this))
     , m_notification(new NotificationPortal(this))
+    , m_access(new AccessPortal(this))
 {
     const QByteArray &xdgCurrentDesktop = qgetenv("XDG_CURRENT_DESKTOP").toUpper();
     if (xdgCurrentDesktop == "DDE" || xdgCurrentDesktop == "DEEPIN") {

src/ddesktopportal.h

@@ -19,6 +19,7 @@ class WallPaperPortal;
 class NotificationPortal;
 class FileChooserPortal;
 class AppChooserPortal;
+class AccessPortal;
 
 class DDesktopPortal : public QObject, public QDBusContext
 {
@@ -41,4 +42,5 @@ class DDesktopPortal : public QObject, public QDBusContext
     SecretPortal *m_secret = nullptr;
     WallPaperPortal *const m_wallpaper;
     NotificationPortal *const m_notification;
+    AccessPortal *const m_access;
 };

src/personalization_manager_client.cpp

@@ -0,0 +1,43 @@
+// Copyright (C) 2024 Wenhao Peng <[email protected]>.
+// SPDX-License-Identifier: Apache-2.0 OR LGPL-3.0-only OR GPL-2.0-only OR GPL-3.0-only
+
+#include "personalization_manager_client.h"
+
+#include <QtWaylandClient/QWaylandClientExtension>
+
+PersonalizationManager::PersonalizationManager()
+    : QWaylandClientExtensionTemplate<PersonalizationManager>(1)
+{
+    connect(this,
+            &PersonalizationManager::activeChanged,
+            this,
+            &PersonalizationManager::onActiveChanged);
+}
+
+PersonalizationManager::~PersonalizationManager()
+{
+
+}
+
+void PersonalizationManager::onActiveChanged()
+{
+    if (!isActive())
+        return;
+
+    if (!m_wallpaperContext) {
+        m_wallpaperContext = new PersonalizationWallpaper(get_wallpaper_context());
+    }
+}
+
+PersonalizationWallpaper::PersonalizationWallpaper(
+        struct ::personalization_wallpaper_context_v1 *object)
+    : QWaylandClientExtensionTemplate<PersonalizationWallpaper>(1)
+    , QtWayland::personalization_wallpaper_context_v1(object)
+{
+}
+
+void PersonalizationWallpaper::personalization_wallpaper_context_v1_metadata(
+        const QString &metadata)
+{
+    Q_EMIT metadataChanged(metadata);
+}