feat: add applet visibility control to DAppletItemModel and - #1676
Conversation
![sourcery-ai[bot]](https://avatars.githubusercontent.com/in/48477?s=60&v=4){kind=small}
| } | ||
|
|
||
| if (m_dconfig && m_dconfig->isValid()) { | ||
| connect(m_dconfig, &Dtk::Core::DConfig::valueChanged, |
There was a problem hiding this comment.
配置用subpath的方式去获取，而不是把所有插件都放在一个hiddenApplets里，每个插件都有一个单独的配置，方便后面override， https://github.com/18202781743/cskills/blob/4745ee77b82d808182f2a8681db135b0933fb2ba/dtk-development/references/config/concepts.md?plain=1#L74
| { | ||
| } | ||
|
|
||
| QList<QObject *> DAppletItemModel::rootObjects() const |
There was a problem hiding this comment.
这里rootObjects要改成visibleRootObjects么，要不要加个新的visibleRootObjects属性，
|
|
||
| QList<QObject *> rootObjects() const; | ||
| void append(QObject *rootObject); | ||
| void append(QObject *rootObject, bool visible = true); |
There was a problem hiding this comment.
这个是公共接口，不能直接加，另外也不需要，在添加的地方去拦截比较合适，
f159ac7 to
c07f118
Compare
| Q_PROPERTY(QString id READ id CONSTANT FINAL) | ||
| Q_PROPERTY(QString pluginId READ pluginId CONSTANT FINAL) | ||
| Q_PROPERTY(QObject *rootObject READ rootObject NOTIFY rootObjectChanged) | ||
| Q_PROPERTY(bool enable READ enable WRITE setEnable NOTIFY enableChanged FINAL) |
There was a problem hiding this comment.
这个是不是不需要呀，disable了这个applet都不会有了，
ba4eb47 to
dccc169
Compare
| Q_EMIT appletEnabledChanged(pluginId, enabled); | ||
| } | ||
|
|
||
| DApplet *DPluginLoader::loadApplet(const DAppletData &data) |
There was a problem hiding this comment.
如果m_disabledPlugins只是在这里使用的话，可以不用加在pluginloader.cpp里，放在dde-shell的appletloader.cpp里，
| QStringList pluginDirs() const; | ||
| void setPluginDirs(const QStringList &dirs); | ||
|
|
||
| QStringList disabledApplets() const; |
7e03ceb to
e46752f
Compare
|
/test github-pr-review-ci |
fc66cf6 to
c19da7e
Compare
| pluginIds.insert(plugin.pluginId()); | ||
| } | ||
|
|
||
| const auto configuredPluginIds = m_appletConfigs.keys(); |
| void quit() | ||
| { | ||
| for (auto item : std::as_const(m_loaders)) { | ||
| const auto loaders = m_loaders; |
There was a problem hiding this comment.
复制一份，有特殊含义么？另外，这里的m_loaders，应该针对的都是没有parent的applet，
| continue; | ||
|
|
||
| loadTranslation(child->pluginMetaData()); | ||
| if (!load(child) || !init(child)) { |
There was a problem hiding this comment.
之前不是有这个流程么，再写一个，之前的不能复用么，
97eeb3a to
ed5c294
Compare
d81cf1e to
e22ee1d
Compare
| return; | ||
| } | ||
|
|
||
| d->createRootObject(applet); |
There was a problem hiding this comment.
先createRootObject再init的吧，
|
|
||
| if (!d->init(d->m_applet)) | ||
| if (!d->load(applet)) { | ||
| if (isTargetedLoad) |
There was a problem hiding this comment.
不用判断是否是isTargetedLoad吧，当加载失败，删除掉翻译是所有的都需要的吧，
| for (const auto &pluginId : pluginIds) { | ||
| if (m_appletConfigs.contains(pluginId)) | ||
| continue; | ||
| if (!isAppletEnabled(pluginId)) |
There was a problem hiding this comment.
这个一直为true吧，在初始化时，m_disabledPlugins对于pluginId是空的，
|
|
||
| DAppletLoader *loaderForPlugin(const QString &pluginId) const | ||
| { | ||
| QString rootPluginId = pluginId; |
There was a problem hiding this comment.
这里之所以有这个查找，是用了个ConfigManager，将所有的都汇总到了一起，导致配置和DAppletLoader分开了，要是每个AppLoader都有个ConfigManager，就没这个问题了，每个ConfigManager只管AppletLoader自己的applet的配置，
|
/test github-pr-review-ci |
deepin pr auto review★ 总体评分：60分■ 【总体评价】
■ 【详细分析】
■ 【改进建议代码示例】 // appletconfigmanager.cpp
#include <QRegularExpression>
void AppletConfigManager::ensureAppletConfigs()
{
auto loader = DPluginLoader::instance();
const auto plugins = loader->plugins();
QSet<QString> pluginIds;
for (const auto &plugin : plugins) {
pluginIds.insert(plugin.pluginId());
}
// 防御路径遍历的白名单正则
static const QRegularExpression validPluginId("^[a-zA-Z0-9._-]+$");
for (const auto &pluginId : pluginIds) {
if (m_appletConfigs.contains(pluginId))
continue;
// 安全检查：拦截非法的 pluginId 格式
if (!validPluginId.match(pluginId).hasMatch()) {
qCWarning(dsLoaderLog) << "Invalid pluginId format, rejecting DConfig creation:" << pluginId;
continue;
}
auto config = DConfig::create(QLatin1String(AppId),
QLatin1String(ConfigName),
QLatin1Char('/') + pluginId,
this);
// 逻辑修复：仅在 config 有效时插入 map，避免 nullptr 阻断后续重试
if (!config || !config->isValid()) {
qCWarning(dsLoaderLog) << "Unable to create applet DConfig; applet remains enabled:" << pluginId;
setAppletEnabled(pluginId, true);
continue;
}
m_appletConfigs.insert(pluginId, config);
const bool isEnabled = config->value(QLatin1String(EnableKey), true).toBool();
setAppletEnabled(pluginId, isEnabled);
QObject::connect(config, &DConfig::valueChanged, this, [this, pluginId, config](const QString &key) {
if (key == QLatin1String(EnableKey)) {
const bool enabled = config->value(QLatin1String(EnableKey), true).toBool();
setAppletEnabled(pluginId, enabled);
}
});
}
}// appletloader.cpp
void DAppletLoader::exec()
{
D_D(DAppletLoader);
auto applet = d->m_applet.data();
if (!d->m_pluginId.isEmpty()) {
applet = d->findApplet(applet, d->m_pluginId);
// 逻辑修复：如果 applet 已经存在，说明已经加载，直接返回避免重复初始化
if (applet) {
return;
}
auto containment = qobject_cast<DContainment *>(d->parentApplet(d->m_pluginId));
if (!containment) {
d->fail(d->m_pluginId, QStringLiteral("Parent containment was not found."));
return;
}
applet = containment->createApplet(DAppletData(d->m_pluginId));
if (!applet) {
d->fail(d->m_pluginId, QStringLiteral("Failed to create applet in its parent containment."));
return;
}
}
d->loadTranslation(applet->pluginMetaData());
if (!d->load(applet)) {
d->removeTranslations(d->m_pluginId);
return;
}
d->createRootObject(applet);
if (!d->init(applet)) {
d->removeTranslations(d->m_pluginId);
return;
}
}// appletloader.cpp 构造函数防御性修复
DAppletLoader::DAppletLoader(DApplet *applet, AppletConfigManager *configManager, QObject *parent)
: QObject(parent)
, DObject(*new DAppletLoaderPrivate(this))
{
D_D(DAppletLoader);
// 质量修复：替换 Q_ASSERT，防止 Release 模式下空指针解引用
if (!configManager) {
qFatal("AppletConfigManager must not be null in DAppletLoader");
return;
}
d->m_applet = applet;
d->m_configManager = configManager;
} |
|
|
||
| d->createRootObject(d->m_applet); | ||
| if (!d->load(applet)) { | ||
| d->removeTranslations(d->m_pluginId); |
There was a problem hiding this comment.
这个不一定是m_pluginId，它是不是应该从applet里获取，另外，有可能有多个applet，当某个applet加载失败，不应该删除翻译吧，这里不删除也行吧，
170eb05 to
3545a79
Compare
|
[APPROVALNOTIFIER] This PR is NOT APPROVED This pull-request has been approved by: 18202781743, wjyrich The full list of commands accepted by this bot can be found here. DetailsNeeds approval from an approver in each of these files:Approvers can indicate their approval by writing |
Add the ability to enable or disable DApplet instances via DConfig, controlling whether their root objects appear in the parent containment model. The new `enable` property is exposed as a Q_PROPERTY on DApplet, backed by a DConfig key `enable` under `org.deepin.dde.shell`. When loading, DApplet reads this config and watches for changes. Disabled applets remain loaded but their root objects are removed from the containment's `appletItems` model; re-enabling re-inserts them. This enables runtime toggling of applet visibility without unloading/ reloading plugins. Unit tests are added for the DAppletItemModel (append/remove) and the enable property change notification logic. Log: Added DApplet enable/disable feature via DConfig Influence: 1. Test creating an applet and verifying its enable property is true by default 2. Set enable to false via dde-dconfig and verify the applet root object is removed from the containment model 3. Set enable to true and verify the root object reappears 4. Verify that setEnable with the same value does not emit enableChanged signal 5. Test loading a root plugin (like dock) - its enable should not be affected (skipped) 6. Verify DConfig changes are watched and applied dynamically at runtime 7. Run unit tests: EnablePropertyNotifiesOnlyOnChange, AppendsRootObjects, RemovesRootObject feat: 添加支持通过 DConfig 启用/禁用 Applet 的接口 新增通过 DConfig 控制 DApplet 实例启用的能力，决定其根对象是否显示在父容 器模型中。 新的 `enable` 属性作为 DApplet 的 Q_PROPERTY 暴露，由 `org.deepin.dde.shell` 下的 DConfig 键 `enable` 驱动。加载时 DApplet 读 取该配置并监听变化。 被禁用的 Applet 实例仍保持加载，但根对象从容器的 `appletItems` 模型中 移除；重新启用后会重新追加。这实现了无需卸载/重新加载插件即可运行时切换 Applet 可见性。 新增了 DAppletItemModel（追加/移除）以及 enable 属性变更通知逻辑的单元 测试。 Log: 新增 DApplet 启用/禁用功能 Influence: 1. 测试创建 Applet 并验证其 enable 属性默认为 true 2. 通过 dde-dconfig 将 enable 设为 false，验证根对象已从容器模型中移除 3. 设为 true 后验证根对象重新出现 4. 验证 setEnable 相同值时不会触发 enableChanged 信号 5. 测试加载根插件（如 dock），其 enable 不应受影响（跳过） 6. 验证 DConfig 变化能被监听并在运行时动态生效 7. 运行单元测试：EnablePropertyNotifiesOnlyOnChange、 AppendsRootObjects、RemovesRootObject PMS: TASK-393299
3 participants
DPluginLoader
Implement a framework-level hidden applets mechanism that allows suppressing individual applet root objects from the containment model without destroying them. The DAppletItemModel now maintains both a complete root objects list and a filtered visible subset. A new
setRootObjectVisiblemethod enables toggling visibility while preserving the original insertion order upon restoration. The DPluginLoader exposeshiddenApplets,isAppletHidden, andsetHiddenAppletsAPIs, and the shell synchronizes these with a DConfig keyhiddenApplets. Hidden applets remain loaded but their root objects are reparented to the applet and removed from the visual model. Unit tests verify order preservation and removal semantics.Log: Added applet visibility control API and DConfig integration
Influence:
feat: 为 DAppletItemModel 和 DPluginLoader 添加 Applet 显隐控制
实现框架级隐藏 Applet 机制，可在不销毁实例的前提下将其根对象从容
器模型中移除。DAppletItemModel 维护完整的根对象列表和可见子集，
新增
setRootObjectVisible方法支持按需切换显隐，恢复时保持原有插入顺序。DPluginLoader 提供
hiddenApplets、isAppletHidden和setHiddenApplets接口，Shell 通过 DConfig 键hiddenApplets同步配 置。隐藏的 Applet 仍保持加载，其根对象重新挂载到 Applet 自身并从视觉模型中移除。单元测试验证了顺序保持和移除语义。
Log: 新增 Applet 显隐控制接口和 DConfig 集成
Influence:
PMS: TASK-393299