Skip to content

finders/desktop: get file locations from environment, check subdirectories and do not cache duplicate desktop file ids #37

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

Merged
vaxerski merged 4 commits into from
Nov 15, 2025
Merged

finders/desktop: get file locations from environment, check subdirectories and do not cache duplicate desktop file ids #37

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
eb4e3de
finders/desktop: follow XDG Base Dir spec for getting desktop entry p…
TheTrueWhiteOwl Nov 7, 2025
01b083c
Merge remote-tracking branch 'origin/main' into dedup-desktop-ids
TheTrueWhiteOwl Nov 9, 2025
5505f40
finders/desktop: recursively cache desktop files from subdirectories …
TheTrueWhiteOwl Nov 9, 2025
2fd760c
desktop: skipping directories already visited, no longer possible to …
TheTrueWhiteOwl Nov 15, 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
83 changes: 47 additions & 36 deletions src/finders/desktop/DesktopFinder.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@
#include <fstream>
#include <sys/inotify.h>
#include <sys/poll.h>
#include <unordered_set>

#include <hyprutils/string/String.hpp>
#include <hyprutils/os/Process.hpp>
Expand All @@ -17,13 +18,13 @@
using namespace Hyprutils::String;
using namespace Hyprutils::OS;

static std::optional<std::string> readFileAsString(const std::string& path) {
static std::optional<std::string> readFileAsString(const std::filesystem::path& path) {
std::error_code ec;

if (!std::filesystem::exists(path, ec) || ec)
return std::nullopt;

std::ifstream file(path);
std::ifstream file(path.string());
if (!file.good())
return std::nullopt;

Expand Down Expand Up @@ -92,25 +93,19 @@ static std::filesystem::path resolvePath(const std::string& p) {
return std::filesystem::path(HOME) / p.substr(2);
}

static const std::array<std::filesystem::path, 3> DESKTOP_ENTRY_PATHS = {"/usr/local/share/applications", "/usr/share/applications", resolvePath("~/.local/share/applications")};

CDesktopFinder::CDesktopFinder() : m_inotifyFd(inotify_init()), m_entryFrequencyCache(makeUnique<CEntryCache>("desktop")) {
const auto ENV = getenv("XDG_DATA_DIRS");
if (!ENV)
return;

CConstVarList paths(ENV, 0, ':', false);

for (const auto& p : paths) {
const std::filesystem::path PTH = std::filesystem::path(p) / "applications";
std::error_code ec;
if (!std::filesystem::exists(PTH, ec) || ec)
continue;

if (std::ranges::contains(DESKTOP_ENTRY_PATHS, PTH))
continue;

m_envPaths.emplace_back(PTH);
if (const auto DATA_HOME = getenv("XDG_DATA_HOME"))
m_envPaths.emplace_back(std::filesystem::path(DATA_HOME) / "applications");
else
m_envPaths.emplace_back(resolvePath("~/.local/share/applications"));

if (const auto DATA_DIRS = getenv("XDG_DATA_DIRS")) {
CConstVarList paths(DATA_DIRS, 0, ':', false);
for (const auto& p : paths)
m_envPaths.emplace_back(std::filesystem::path(p) / "applications");
} else {
m_envPaths.emplace_back("/usr/local/share/applications");
m_envPaths.emplace_back("/usr/share/applications");
}
}

Expand All @@ -130,26 +125,42 @@ void CDesktopFinder::recache() {
m_desktopEntryCache.clear();
m_desktopEntryCacheGeneric.clear();

auto cachePath = [this](const std::string& p) {
std::unordered_set<std::string> desktopFileIds;
std::unordered_set<std::filesystem::path> directories;

std::function<void (const std::filesystem::path&, const std::filesystem::path&)> cacheDirectory;
cacheDirectory = [this, &cacheDirectory, &desktopFileIds, &directories](const std::filesystem::path& base, const std::filesystem::path& p) {
std::error_code ec;
auto it = std::filesystem::directory_iterator(resolvePath(p), ec);
if (ec)
auto canonicalPath = std::filesystem::canonical(p, ec);
if (ec || !directories.insert(canonicalPath).second) {
Debug::log(TRACE, "desktop: skipping {}, does not exist / already visited", p.string());
return;
}
auto it = std::filesystem::directory_iterator(p, ec);
if (ec) return;
for (const auto& e : it) {
if (!e.is_regular_file(ec) || ec)
continue;

cacheEntry(e.path().string());
auto status = e.status(ec);
if (ec) continue;
if (std::filesystem::is_regular_file(status)) {
auto relDesktopFilePath = e.path().lexically_relative(base);
if (relDesktopFilePath.extension() != ".desktop") {
Debug::log(TRACE, "desktop: skipping non-desktop file at {}", e.path().string());
continue;
}
auto desktopFileId = relDesktopFilePath.string();
std::ranges::replace(desktopFileId, '/', '-');
if (desktopFileIds.insert(desktopFileId).second)
cacheEntry(e.path());
else Debug::log(TRACE, "desktop: skipping entry at {}, already cached desktopFileId {}", e.path().string(), desktopFileId);
} else if (std::filesystem::is_directory(status))
cacheDirectory(base, e.path());
}

m_desktopEntryPaths.emplace_back(resolvePath(p));
m_desktopEntryPaths.emplace_back(p);
};

for (const auto& PATH : DESKTOP_ENTRY_PATHS) {
cachePath(PATH);
}
for (const auto& PATH : m_envPaths) {
cachePath(PATH);
cacheDirectory(PATH, PATH);
}
}

Expand Down Expand Up @@ -181,8 +192,8 @@ void CDesktopFinder::replantWatch() {
}
}

void CDesktopFinder::cacheEntry(const std::string& path) {
Debug::log(TRACE, "desktop: caching entry {}", path);
void CDesktopFinder::cacheEntry(const std::filesystem::path& path) {
Debug::log(TRACE, "desktop: caching entry at {}", path.string());

const auto READ_RESULT = readFileAsString(path);

Expand Down Expand Up @@ -224,7 +235,7 @@ void CDesktopFinder::cacheEntry(const std::string& path) {
const auto NODISPLAY = extract("NoDisplay") == "true";

if (EXEC.empty() || NAME.empty() || NODISPLAY) {
Debug::log(TRACE, "Skipping entry, empty name / exec / NoDisplay");
Debug::log(TRACE, "desktop: skipping entry, empty name / exec / NoDisplay");
return;
}

Expand All @@ -237,7 +248,7 @@ void CDesktopFinder::cacheEntry(const std::string& path) {
e->m_frequency = m_entryFrequencyCache->getCachedEntry(e->m_fuzzable);
m_desktopEntryCacheGeneric.emplace_back(e);

Debug::log(TRACE, "Cached: {} with icon {} and exec line of \"{}\"", NAME, ICON, EXEC);
Debug::log(TRACE, "desktop: cached {} with icon {} and exec line of \"{}\"", NAME, ICON, EXEC);
}

std::vector<SFinderResult> CDesktopFinder::getResultsForQuery(const std::string& query) {
Expand Down
19 changes: 10 additions & 9 deletions src/finders/desktop/DesktopFinder.hpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@
#include "../IFinder.hpp"

#include <hyprutils/os/FileDescriptor.hpp>
#include <filesystem>

class CDesktopEntry;
class CEntryCache;
Expand All @@ -20,19 +21,19 @@ class CDesktopFinder : public IFinder {
void onInotifyEvent();

private:
std::vector<SP<CDesktopEntry>> m_desktopEntryCache;
std::vector<SP<IFinderResult>> m_desktopEntryCacheGeneric;
std::vector<SP<CDesktopEntry>> m_desktopEntryCache;
std::vector<SP<IFinderResult>> m_desktopEntryCacheGeneric;

std::vector<std::string> m_desktopEntryPaths;
std::vector<int> m_watches;
std::vector<std::filesystem::path> m_desktopEntryPaths;
std::vector<int> m_watches;

std::vector<std::string> m_envPaths;
std::vector<std::filesystem::path> m_envPaths;

UP<CEntryCache> m_entryFrequencyCache;
UP<CEntryCache> m_entryFrequencyCache;

void cacheEntry(const std::string& path);
void replantWatch();
void recache();
void cacheEntry(const std::filesystem::path& path);
void replantWatch();
void recache();

friend class CDesktopEntry;
};
Expand Down