[desktop] Use XDG and installation paths for config and data #2387

New issue

Open

opened 2022-04-12 11:58:28 +00:00 by fgaz · 9 comments

fgaz commented

2022-04-12 11:58:28 +00:00

(Migrated from github.com)

This came up in https://github.com/flathub/flathub/pull/2968#issuecomment-1096430134, but NixOS also has to wrap Organic Maps for it to work.

It looks like Qt QStandardPaths can be used to get XDG paths.

Ideally, the following files should be moved / these paths should be set:

~/.config/OMaps/{settings.ini,bookmarks} should be saved in $XDG_CONFIG_HOME/OMaps if it exists. I believe this is QStandardPaths::ConfigLocation. As opposed to the other paths, there is no way for the user to change this right now.
#2409
-data_path should default to $XDG_DATA_HOME/OMaps, with fallback ~/.local/share/OMaps. This should be QStandardPaths::DataLocation. Right now it defaults to "", which is interpreted as the current directory
#2734
-resources_path should default to the data installation directory, ${CMAKE_INSTALL_PREFIX}/share/organicmaps/. Right now it defaults to "", which is interpreted as the current directory
Solved partially in organicmaps/organicmaps#2734/files , that adds a relative path common among distros to the default search paths

This came up in https://github.com/flathub/flathub/pull/2968#issuecomment-1096430134, but NixOS also has to [wrap Organic Maps](https://github.com/NixOS/nixpkgs/blob/77479263b6192b0bca63b1840d06e1caabb149cd/pkgs/applications/misc/organicmaps/default.nix#L69-L74) for it to work. It looks like Qt [QStandardPaths](https://doc.qt.io/qt-5/qstandardpaths.html) can be used to get XDG paths. Ideally, the following files should be moved / these paths should be set: * `~/.config/OMaps/{settings.ini,bookmarks}` should be saved in `$XDG_CONFIG_HOME/OMaps` if it exists. I believe this is `QStandardPaths::ConfigLocation`. As opposed to the other paths, there is no way for the user to change this right now. #2409 * `-data_path` should default to `$XDG_DATA_HOME/OMaps`, with fallback `~/.local/share/OMaps`. This should be `QStandardPaths::DataLocation`. Right now it defaults to `""`, which is interpreted as the current directory #2734 * `-resources_path` should default to the data installation directory, `${CMAKE_INSTALL_PREFIX}/share/organicmaps/`. Right now it defaults to `""`, which is interpreted as the current directory Solved partially in https://git.omaps.dev/organicmaps/organicmaps/pulls/2734/files#diff-a4fffc1454eb8a0424ac442da9cb37e95ad2292dd8cce99e23da169c060109acR110 , that adds a relative path common among distros to the default search paths

biodranik commented

2022-04-12 12:17:31 +00:00

(Migrated from github.com)

Linux paths initialization code is here: https://github.com/organicmaps/organicmaps/blob/master/platform/platform_linux.cpp#L76:L149

You're welcome to contribute.

Linux paths initialization code is here: https://github.com/organicmaps/organicmaps/blob/master/platform/platform_linux.cpp#L76:L149 You're welcome to contribute.

👍 1

Ferenc- commented

2022-06-10 15:08:19 +00:00

(Migrated from github.com)

Is anyone currently working on the part that was missing from #2409 or can newcomers take a shot?

biodranik commented

2022-06-11 06:21:03 +00:00

(Migrated from github.com)

fgaz commented

2022-06-11 08:08:24 +00:00

(Migrated from github.com)

I'm not working on it

Ferenc- commented

2022-06-14 06:30:50 +00:00

(Migrated from github.com)

All right, then I assume we are not risking double effort, so please take a look at the above PR.

🚀 1

fgaz commented

2022-06-16 19:10:30 +00:00

(Migrated from github.com)

#2734 solved (2) and partially (3) by including a search path that's common among distros. It'd still be nice to have it based on CMAKE_INSTALL_PREFIX, but this already allows us to drop all the wrappers in flatpak and nixos packages

biodranik commented

2022-06-16 20:19:00 +00:00

(Migrated from github.com)

It is possible to pass CMAKE_INSTALL_PREFIX into some generated header at the build time and embed it into the code.
What should be the logic with this prefix? To override default one /usr/local?

It is possible to pass CMAKE_INSTALL_PREFIX into some generated header at the build time and embed it into the code. What should be the logic with this prefix? To override default one `/usr/local`?

Ferenc- commented

2022-06-20 22:00:19 +00:00

(Migrated from github.com)

BTW are we sure, that relying on CMAKE_INSTALL_PREFIX is more robust than searching through XDG_DATA_DIRS in runtime?

BTW are we sure, that relying on `CMAKE_INSTALL_PREFIX` is more robust than searching through `XDG_DATA_DIRS` in runtime?

biodranik commented

2022-06-21 05:27:47 +00:00

(Migrated from github.com)

If I understood correctly, the logic should be: