Skip to content
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

Avoid loading duplicate .desktop files in menubar #3822

Open
wants to merge 5 commits into
base: master
Choose a base branch
from
Open

Avoid loading duplicate .desktop files in menubar #3822

Show file tree
Hide file tree
Changes from 4 commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
3929760
Add relative path to table of desktop files
dyfrgi Jun 13, 2023
0f8c00b
First pass on using directory id as unique id
dyfrgi Jun 13, 2023
ab21d24
Move Async up into menu_gen.generate to keep order of files
dyfrgi Jun 13, 2023
d87bb3e
Cleanup
dyfrgi Jun 14, 2023
99db3a8
Remove unnecessary assignment
dyfrgi Jun 25, 2023
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
96 changes: 61 additions & 35 deletions lib/menubar/menu_gen.lua
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,9 @@ local utils = require("menubar.utils")
local pairs = pairs
local ipairs = ipairs
local table = table
local lgi = require("lgi")
local gio = lgi.Gio
local protected_call = require("gears.protected_call")

local menu_gen = {}

Expand Down Expand Up @@ -75,6 +78,28 @@ local function get_category_name_and_usage_by_type(app_type)
end
end

local do_protected_call, call_callback
do
-- Lua 5.1 cannot yield across a protected call. Instead of hardcoding a
-- check, we check for this problem: The following coroutine yields true on
-- success (so resume() returns true, true). On failure, pcall returns
-- false and a message, so resume() returns true, false, message.
local _, has_yieldable_pcall = coroutine.resume(coroutine.create(function()
return pcall(coroutine.yield, true)
end))
if has_yieldable_pcall then
do_protected_call = protected_call.call
call_callback = function(callback, ...)
return callback(...)
end
else
do_protected_call = function(f, ...)
return f(...)
end
call_callback = protected_call.call
end
end

--- Generate an array of all visible menu entries.
-- @tparam function callback Will be fired when all menu entries were parsed
-- with the resulting list of menu entries as argument.
Expand All @@ -89,46 +114,47 @@ function menu_gen.generate(callback)
local unique_entries = {}
local dirs_parsed = 0

for _, dir in ipairs(menu_gen.all_menu_dirs) do
utils.parse_dir(dir, function(entries)
entries = entries or {}
for _, entry in ipairs(entries) do
-- Check whether to include program in the menu
if entry.show and entry.Name and entry.cmdline then
local unique_key = entry.Name .. '\0' .. entry.cmdline
if not unique_entries[unique_key] then
local target_category = nil
-- Check if the program falls into at least one of the
-- usable categories. Set target_category to be the id
-- of the first category it finds.
if entry.categories then
for _, category in pairs(entry.categories) do
local cat_key, cat_use =
get_category_name_and_usage_by_type(category)
if cat_key and cat_use then
target_category = cat_key
break
gio.Async.start(do_protected_call)(function()
for _, dir in ipairs(menu_gen.all_menu_dirs) do
utils.parse_dir(dir, function(entries)
entries = entries or {}
for _, entry in ipairs(entries) do
-- Check whether to include program in the menu
if entry.show and entry.Name and entry.cmdline then
local unique_key = entry.desktop_file_id
if not unique_entries[unique_key] then
local target_category = nil
-- Check if the program falls into at least one of the
-- usable categories. Set target_category to be the id
-- of the first category it finds.
if entry.categories then
for _, category in pairs(entry.categories) do
local cat_key, cat_use = get_category_name_and_usage_by_type(category)
if cat_key and cat_use then
target_category = cat_key
break
end
end
end
end

local name = utils.rtrim(entry.Name) or ""
local cmdline = utils.rtrim(entry.cmdline) or ""
local icon = entry.icon_path or nil
table.insert(result, { name = name,
cmdline = cmdline,
icon = icon,
category = target_category })
unique_entries[unique_key] = true
local name = utils.rtrim(entry.Name) or ""
local cmdline = utils.rtrim(entry.cmdline) or ""
local icon = entry.icon_path or nil
table.insert(
result,
{ name = name, cmdline = cmdline, icon = icon, category = target_category }
)
unique_entries[unique_key] = true
end
end
end
end
dirs_parsed = dirs_parsed + 1
if dirs_parsed == #menu_gen.all_menu_dirs then
callback(result)
end
end)
end
dirs_parsed = dirs_parsed + 1
if dirs_parsed == #menu_gen.all_menu_dirs then
call_callback(callback, result)
end
end)
end
end)
end

return menu_gen
Expand Down
38 changes: 10 additions & 28 deletions lib/menubar/utils.lua
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,6 @@ local gio = lgi.Gio
local glib = lgi.GLib
local w_textbox = require("wibox.widget.textbox")
local gdebug = require("gears.debug")
local protected_call = require("gears.protected_call")
local unpack = unpack or table.unpack -- luacheck: globals unpack (compatibility with Lua 5.1)

local utils = {}
Expand Down Expand Up @@ -92,28 +91,6 @@ end

-- Private section

local do_protected_call, call_callback
do
-- Lua 5.1 cannot yield across a protected call. Instead of hardcoding a
-- check, we check for this problem: The following coroutine yields true on
-- success (so resume() returns true, true). On failure, pcall returns
-- false and a message, so resume() returns true, false, message.
local _, has_yieldable_pcall = coroutine.resume(coroutine.create(function()
return pcall(coroutine.yield, true)
end))
if has_yieldable_pcall then
do_protected_call = protected_call.call
call_callback = function(callback, ...)
return callback(...)
end
else
do_protected_call = function(f, ...)
return f(...)
end
call_callback = protected_call.call
end
end

local all_icon_sizes = {
'scalable',
'128x128',
Expand Down Expand Up @@ -404,11 +381,16 @@ function utils.parse_dir(dir_path, callback)
enum:async_close()
end

gio.Async.start(do_protected_call)(function()
local result = {}
parser(gio.File.new_for_path(dir_path), result)
call_callback(callback, result)
end)
local result = {}
local dir = gio.File.new_for_path(dir_path)
parser(dir, result)
for i, entry in ipairs(result) do
local desktop_file = gio.File.new_for_path(entry.file)
local relative_path = dir:get_relative_path(desktop_file)
entry.desktop_file_id = string.gsub(relative_path, "/", "-")
result[i] = entry
end
callback(result)
end

-- luacov: disable
Expand Down