Skip to content

Use next in line portal.conf when no backend is defined for a particular interface #1867

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
maxcabrajac wants to merge 2 commits into
base: main
Choose a base branch
from
+104 −103
Open

Use next in line portal.conf when no backend is defined for a particular interface #1867

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
b96ae15
Read and process all relevant portals.conf files
maxcabrajac Nov 20, 2025
1e7976e
Update docs
maxcabrajac Nov 21, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 0 additions & 6 deletions doc/portals.conf.rst.in
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -77,12 +77,6 @@ then xdg-desktop-portal will look for
``xdg-desktop-portal/gnome-portals.conf`` and
``xdg-desktop-portal/portals.conf`` in that order.

Only the first configuration file found is read, and lower-precedence
configuration files are ignored. All possible configuration files within
one directory are tried before moving on to the next directory, so for
example ``~/.config/xdg-desktop-portal/portals.conf`` is higher-precedence
than ``/usr/share/xdg-desktop-portal/kde-portals.conf``.

Copy link
Author

@maxcabrajac maxcabrajac Nov 21, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It seems enough to just remove this paragraph, because this functionality is already implied by "override those defaults" on:

Users can override those defaults, or provide configuration for an otherwise
unsupported desktop environment, by writing a file
~/.config/xdg-desktop-portal/portals.conf.

FILE FORMAT
-----------

Expand Down
201 changes: 104 additions & 97 deletions src/xdp-portal-config.c
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -52,7 +52,7 @@ struct _XdpPortalConfig

char **current_desktops;
GPtrArray *impl_configs;
PortalConfig *config;
GPtrArray *configs;
};

G_DEFINE_FINAL_TYPE (XdpPortalConfig, xdp_portal_config, G_TYPE_OBJECT)
Expand Down Expand Up @@ -510,10 +510,11 @@ load_config_directory (const char *dir,
return NULL;
}

static PortalConfig *
static GPtrArray *
load_portal_configuration (XdpPortalConfig *portal_config,
gboolean opt_verbose)
{
g_autoptr(GPtrArray) configs = g_ptr_array_new_with_free_func ((GDestroyNotify) portal_config_free);
g_autoptr(PortalConfig) config = NULL;
g_autofree char *user_portal_dir = NULL;
const char * const *dirs;
Expand All @@ -528,16 +529,19 @@ load_portal_configuration (XdpPortalConfig *portal_config,

if (portal_dir != NULL)
{
config = load_config_directory (portal_dir, desktops, opt_verbose);
if (config)
g_ptr_array_add (configs, g_steal_pointer (&config));
/* All other config directories are ignored when this is set */
return load_config_directory (portal_dir, desktops, opt_verbose);
return g_steal_pointer (&configs);
}

/* $XDG_CONFIG_HOME/xdg-desktop-portal/(DESKTOP-)portals.conf */
user_portal_dir = g_build_filename (g_get_user_config_dir (), XDP_SUBDIR, NULL);

config = load_config_directory (user_portal_dir, desktops, opt_verbose);
if (config)
return g_steal_pointer (&config);
g_ptr_array_add (configs, g_steal_pointer (&config));

/* $XDG_CONFIG_DIRS/xdg-desktop-portal/(DESKTOP-)portals.conf */
dirs = g_get_system_config_dirs ();
Expand All @@ -548,13 +552,13 @@ load_portal_configuration (XdpPortalConfig *portal_config,

config = load_config_directory (dir, desktops, opt_verbose);
if (config)
return g_steal_pointer (&config);
g_ptr_array_add (configs, g_steal_pointer (&config));
}

/* ${sysconfdir}/xdg-desktop-portal/(DESKTOP-)portals.conf */
config = load_config_directory (SYSCONFDIR "/" XDP_SUBDIR, desktops, opt_verbose);
if (config)
return g_steal_pointer (&config);
g_ptr_array_add (configs, g_steal_pointer (&config));


/* $XDG_DATA_HOME/xdg-desktop-portal/(DESKTOP-)portals.conf
Expand All @@ -564,7 +568,7 @@ load_portal_configuration (XdpPortalConfig *portal_config,

config = load_config_directory (user_portal_dir, desktops, opt_verbose);
if (config)
return g_steal_pointer (&config);
g_ptr_array_add (configs, g_steal_pointer (&config));

/* $XDG_DATA_DIRS/xdg-desktop-portal/(DESKTOP-)portals.conf */
dirs = g_get_system_data_dirs ();
Expand All @@ -575,15 +579,15 @@ load_portal_configuration (XdpPortalConfig *portal_config,

config = load_config_directory (dir, desktops, opt_verbose);
if (config)
return g_steal_pointer (&config);
g_ptr_array_add (configs, g_steal_pointer (&config));
}

/* ${datadir}/xdg-desktop-portal/(DESKTOP-)portals.conf */
config = load_config_directory (DATADIR "/" XDP_SUBDIR, desktops, opt_verbose);
if (config)
return g_steal_pointer (&config);
g_ptr_array_add (configs, g_steal_pointer (&config));

return NULL;
return g_steal_pointer (&configs);
}

static void
Expand All @@ -593,7 +597,7 @@ xdp_portal_config_dispose (GObject *object)

g_clear_pointer (&portal_config->current_desktops, g_strfreev);
g_clear_pointer (&portal_config->impl_configs, g_ptr_array_unref);
g_clear_pointer (&portal_config->config, portal_config_free);
g_clear_pointer (&portal_config->configs, g_ptr_array_unref);

G_OBJECT_CLASS (xdp_portal_config_parent_class)->dispose (object);
}
Expand All @@ -619,17 +623,15 @@ xdp_portal_config_new (XdpContext *context)

portal_config->current_desktops = get_current_lowercase_desktops ();
portal_config->impl_configs = load_installed_portals (portal_config, opt_verbose);
portal_config->config = load_portal_configuration (portal_config, opt_verbose);
portal_config->configs = load_portal_configuration (portal_config, opt_verbose);

return portal_config;
}

static PortalInterface *
xdp_portal_config_find_iface_config (XdpPortalConfig *portal_config,
const char *interface)
xdp_portal_config_find_iface_config (PortalConfig *config,
const char *interface)
{
PortalConfig *config = portal_config->config;

if (config == NULL)
return NULL;

Expand All @@ -645,10 +647,8 @@ xdp_portal_config_find_iface_config (XdpPortalConfig *portal_config,
}

static gboolean
xdp_portal_config_default_prefers_none (XdpPortalConfig *portal_config)
xdp_portal_config_default_prefers_none (PortalConfig *config)
{
PortalConfig *config = portal_config->config;

if (config && config->default_portal &&
g_strv_contains ((const char * const *) config->default_portal->portals, "none"))
{
Expand All @@ -660,14 +660,14 @@ xdp_portal_config_default_prefers_none (XdpPortalConfig *portal_config)
}

static gboolean
xdp_portal_config_interface_prefers_none (XdpPortalConfig *portal_config,
const char *interface)
xdp_portal_config_interface_prefers_none (PortalConfig *config,
const char *interface)
{
const PortalInterface *iface =
xdp_portal_config_find_iface_config (portal_config, interface);
xdp_portal_config_find_iface_config (config, interface);

if (iface == NULL)
return xdp_portal_config_default_prefers_none (portal_config);
return xdp_portal_config_default_prefers_none (config);

if (g_strv_contains ((const char * const *) iface->portals, "none"))
{
Expand Down Expand Up @@ -736,20 +736,21 @@ xdp_portal_config_find_impl_config_by_name (XdpPortalConfig *portal_config,
}

static XdpImplConfig *
xdp_portal_config_find_impl_config_by_iface (XdpPortalConfig *portal_config,
const PortalInterface *iface)
_get_impl_config_iface (XdpPortalConfig *portal_config,
const PortalInterface *iface,
const char *interface)
{
for (size_t i = 0; iface->portals && iface->portals[i]; i++)
{
XdpImplConfig *impl_config;
const char *portal = iface->portals[i];

g_debug ("Found '%s' in configuration for %s", portal, iface->dbus_name);
g_debug ("Found '%s' in configuration for %s", portal, interface);

if (g_str_equal (portal, "*"))
{
return xdp_portal_config_find_any_impl_config (portal_config,
iface->dbus_name);
interface);
}

impl_config = xdp_portal_config_find_impl_config_by_name (portal_config,
Expand All @@ -761,11 +762,11 @@ xdp_portal_config_find_impl_config_by_iface (XdpPortalConfig *portal_confi
continue;
}

if (!xdp_impl_config_supports_iface (impl_config, iface->dbus_name))
if (!xdp_impl_config_supports_iface (impl_config, interface))
{
g_info ("Requested backend %s.portal does not support %s. Skipping...",
impl_config->source,
iface->dbus_name);
interface);
continue;
}

Expand All @@ -775,6 +776,28 @@ xdp_portal_config_find_impl_config_by_iface (XdpPortalConfig *portal_confi
return NULL;
}

static XdpImplConfig *
xdp_portal_config_find_impl_config_by_iface (XdpPortalConfig *portal_config,
const PortalInterface *iface)
{
return _get_impl_config_iface(portal_config,
iface,
iface->dbus_name);
}

static XdpImplConfig *
xdp_portal_config_find_default_impl_config_by_iface (XdpPortalConfig *portal_config,
const PortalConfig *config,
const char *interface)
{
if (config == NULL || config->default_portal == NULL)
return NULL;

return _get_impl_config_iface(portal_config,
config->default_portal,
interface);
}

static void
_add_all_impl_configs_iface (XdpPortalConfig *portal_config,
const PortalInterface *iface,
Expand Down Expand Up @@ -828,47 +851,12 @@ xdp_portal_config_find_impl_configs_by_iface (XdpPortalConfig *portal_conf
impl_configs_out);
}

static XdpImplConfig *
xdp_portal_config_find_default_impl_config_by_iface (XdpPortalConfig *portal_config,
const char *interface)
{
PortalConfig *config = portal_config->config;
PortalInterface *iface;

if (config == NULL || config->default_portal == NULL)
return NULL;

iface = config->default_portal;

for (size_t i = 0; iface->portals && iface->portals[i]; i++)
{
XdpImplConfig *impl_config;
const char *portal = iface->portals[i];

g_debug ("Found '%s' in configuration for default", portal);

if (g_str_equal (portal, "*"))
{
return xdp_portal_config_find_any_impl_config (portal_config,
iface->dbus_name);
}

impl_config = xdp_portal_config_find_impl_config_by_name (portal_config,
portal);

if (impl_config && xdp_impl_config_supports_iface (impl_config, interface))
return impl_config;
}
return NULL;
}

static void
xdp_portal_config_find_default_impl_configs_by_iface (XdpPortalConfig *portal_config,
const char *interface,
GPtrArray *impls_out)
xdp_portal_config_find_default_impl_configs_by_iface (XdpPortalConfig *portal_config,
const PortalConfig *config,
const char *interface,
GPtrArray *impls_out)
{
PortalConfig *config = portal_config->config;

if (config == NULL || config->default_portal == NULL)
return;

Expand Down Expand Up @@ -914,33 +902,42 @@ XdpImplConfig *
xdp_portal_config_find (XdpPortalConfig *portal_config,
const char *interface)
{
GPtrArray *configs = portal_config->configs;
GPtrArray *impl_configs = portal_config->impl_configs;
const char **desktops = xdp_portal_config_get_current_desktops (portal_config);
PortalInterface *iface = NULL;
XdpImplConfig *impl_config = NULL;

if (xdp_portal_config_interface_prefers_none (portal_config, interface))
return NULL;

iface = xdp_portal_config_find_iface_config (portal_config, interface);
if (iface)
for (size_t i = 0; i < configs->len; i++)
{
impl_config = xdp_portal_config_find_impl_config_by_iface (portal_config,
iface);
}
PortalConfig *config = g_ptr_array_index (configs, i);
if (xdp_portal_config_interface_prefers_none (config, interface))
return NULL;

if (!impl_config)
{
impl_config =
xdp_portal_config_find_default_impl_config_by_iface (portal_config,
interface);
}
iface = xdp_portal_config_find_iface_config (config, interface);
if (iface)
{
impl_config = xdp_portal_config_find_impl_config_by_iface (portal_config,
iface);
}

if (impl_config != NULL)
{
g_debug ("Using %s.portal for %s (config)",
impl_config->source, interface);
return impl_config;
if (impl_config != NULL)
{
g_debug ("Using %s.portal for %s (interface specific config)",
impl_config->source, interface);
return impl_config;
}

impl_config = xdp_portal_config_find_default_impl_config_by_iface (portal_config,
config,
interface);

if (impl_config != NULL)
{
g_debug ("Using %s.portal for %s (default config)",
impl_config->source, interface);
return impl_config;
}
}

/* Fallback to the old UseIn key */
Expand Down Expand Up @@ -977,6 +974,7 @@ GPtrArray *
xdp_portal_config_find_all (XdpPortalConfig *portal_config,
const char *interface)
{
GPtrArray *configs = portal_config->configs;
GPtrArray *impl_configs = portal_config->impl_configs;
const char **desktops;
PortalInterface *iface;
Expand All @@ -985,18 +983,27 @@ xdp_portal_config_find_all (XdpPortalConfig *portal_config,

impls_out = g_ptr_array_new ();

if (xdp_portal_config_interface_prefers_none (portal_config, interface))
return g_steal_pointer (&impls_out);
for (size_t i = 0; i < configs->len; i++)
{
PortalConfig *config = g_ptr_array_index (configs, i);
size_t prev_impl_count = impls_out->len;

iface = xdp_portal_config_find_iface_config (portal_config, interface);
if (iface)
xdp_portal_config_find_impl_configs_by_iface (portal_config, iface, impls_out);
if (impls_out->len > 0)
return g_steal_pointer (&impls_out);
if (xdp_portal_config_interface_prefers_none (config, interface))
return g_steal_pointer (&impls_out);

iface = xdp_portal_config_find_iface_config (config, interface);
if (iface)
xdp_portal_config_find_impl_configs_by_iface (portal_config, iface, impls_out);

if (impls_out->len > prev_impl_count)
continue;

xdp_portal_config_find_default_impl_configs_by_iface (portal_config,
config,
interface,
impls_out);
}

xdp_portal_config_find_default_impl_configs_by_iface (portal_config,
interface,
impls_out);
if (impls_out->len > 0)
return g_steal_pointer (&impls_out);

Expand Down
Loading