2 # vim:ts=4:sw=4:expandtab
4 # © 2012 Michael Stapelberg
6 # No dependencies except for perl ≥ v5.10
9 use warnings qw(FATAL utf8);
12 use POSIX qw(locale_h);
14 use File::Basename qw(basename);
15 use File::Temp qw(tempfile);
20 use open ':encoding(UTF-8)';
22 binmode STDOUT, ':utf8';
23 binmode STDERR, ':utf8';
25 # reads in a whole file
29 if (!open($fh, '<', $filename)) {
30 warn "Could not open $filename: $!";
39 warn "Could not read $filename: $@";
47 my $dmenu_cmd = 'dmenu -i';
48 my $result = GetOptions(
49 'dmenu=s' => \$dmenu_cmd,
50 'entry-type=s' => \@entry_types,
52 say "dmenu-desktop 1.5 © 2012 Michael Stapelberg";
56 pod2usage(-exitval => 0);
59 die "Could not parse command line options" unless $result;
61 # Filter entry types and set default type(s) if none selected
67 @entry_types = grep { exists($valid_types->{$_}) } @entry_types;
68 @entry_types = ('name', 'command') unless @entry_types;
70 # ┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓
71 # ┃ Convert LC_MESSAGES into an ordered list of suffixes to search for in the ┃
72 # ┃ .desktop files (e.g. “Name[de_DE@euro]” for LC_MESSAGES=de_DE.UTF-8@euro ┃
73 # ┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛
75 # For details on how the transformation of LC_MESSAGES to a list of keys that
76 # should be looked up works, refer to “Localized values for keys” of the
77 # “Desktop Entry Specification”:
78 # https://standards.freedesktop.org/desktop-entry-spec/latest/ar01s04.html
79 my $lc_messages = setlocale(LC_MESSAGES);
81 # Ignore the encoding (e.g. .UTF-8)
82 $lc_messages =~ s/\.[^@]+//g;
84 my @suffixes = ($lc_messages);
86 # _COUNTRY and @MODIFIER are present
87 if ($lc_messages =~ /_[^@]+@/) {
88 my $no_modifier = $lc_messages;
89 $no_modifier =~ s/@.*//g;
90 push @suffixes, $no_modifier;
92 my $no_country = $lc_messages;
93 $no_country =~ s/_[^@]+//g;
94 push @suffixes, $no_country;
97 # Strip _COUNTRY and @MODIFIER if present
98 $lc_messages =~ s/[_@].*//g;
99 push @suffixes, $lc_messages;
101 # ┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓
102 # ┃ Read all .desktop files and store the values in which we are interested. ┃
103 # ┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛
106 # See https://standards.freedesktop.org/basedir-spec/basedir-spec-latest.html#variables
107 my $xdg_data_home = $ENV{XDG_DATA_HOME};
108 $xdg_data_home = $ENV{HOME} . '/.local/share' if
109 !defined($xdg_data_home) ||
110 $xdg_data_home eq '' ||
113 my $xdg_data_dirs = $ENV{XDG_DATA_DIRS};
114 $xdg_data_dirs = '/usr/local/share/:/usr/share/' if
115 !defined($xdg_data_dirs) ||
116 $xdg_data_dirs eq '';
118 my @searchdirs = ("$xdg_data_home/applications/");
119 for my $dir (split(':', $xdg_data_dirs)) {
120 push @searchdirs, "$dir/applications/";
123 # Cleanup the paths, maybe some application does not cope with double slashes
124 # (the field code %k is replaced with the .desktop file location).
125 @searchdirs = map { s,//,/,g; $_ } @searchdirs;
127 # To avoid errors by File::Find’s find(), only pass existing directories.
128 @searchdirs = grep { -d $_ } @searchdirs;
133 return unless substr($_, -1 * length('.desktop')) eq '.desktop';
134 my $relative = $File::Find::name;
136 # + 1 for the trailing /, which is missing in ::topdir.
137 substr($relative, 0, length($File::Find::topdir) + 1) = '';
139 # Don’t overwrite files with the same relative path, we search in
140 # descending order of importance.
141 return if exists($desktops{$relative});
143 $desktops{$relative} = $File::Find::name;
152 for my $file (values %desktops) {
153 my $base = basename($file);
155 # _ is an invalid character for a key, so we can use it for our own keys.
156 $apps{$base}->{_Location} = $file;
158 # Extract all “Name” and “Exec” keys from the [Desktop Entry] group
159 # and store them in $apps{$base}.
161 my $content = slurp($file);
162 next unless defined($content);
163 my @lines = split("\n", $content);
164 for my $line (@lines) {
165 my $first = substr($line, 0, 1);
166 next if $line eq '' || $first eq '#';
167 next unless ($line eq '[Desktop Entry]' ..
169 substr($line, -1) eq ']' &&
170 $line ne '[Desktop Entry]'));
171 next if $first eq '[';
173 my ($key, $value) = ($line =~ /^
175 [A-Za-z0-9-]+ # the spec specifies these as valid key characters
176 (?:\[[^]]+\])? # possibly, there as a locale suffix
178 \s* = \s* # whitespace around = should be ignored
179 (.*) # no restrictions on the values
182 if ($key =~ /^Name/) {
183 $names{$key} = $value;
184 } elsif ($key eq 'Exec' ||
188 $apps{$base}->{$key} = $value;
189 } elsif ($key eq 'NoDisplay' ||
191 $key eq 'StartupNotify' ||
192 $key eq 'Terminal') {
193 # Values of type boolean must either be string true or false,
194 # see “Possible value types”:
195 # https://standards.freedesktop.org/desktop-entry-spec/latest/ar01s03.html
196 $apps{$base}->{$key} = ($value eq 'true');
200 for my $suffix (@suffixes) {
201 next unless exists($names{"Name[$suffix]"});
202 $apps{$base}->{Name} = $names{"Name[$suffix]"};
206 # Fallback to unlocalized “Name”.
207 $apps{$base}->{Name} = $names{Name} unless exists($apps{$base}->{Name});
210 # %apps now looks like this:
213 # 'evince.desktop' => {
214 # 'Exec' => 'evince %U',
215 # 'Name' => 'Dokumentenbetrachter',
216 # '_Location' => '/usr/share/applications/evince.desktop'
218 # 'gedit.desktop' => {
219 # 'Exec' => 'gedit %U',
221 # '_Location' => '/usr/share/applications/gedit.desktop'
225 # ┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓
226 # ┃ Turn %apps inside out to provide Name → filename lookup. ┃
227 # ┃ The Name is what we display in dmenu later. ┃
228 # ┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛
231 for my $app (keys %apps) {
232 my $name = $apps{$app}->{Name};
234 # Don’t try to use .desktop files which don’t have Type=application
235 next if (!exists($apps{$app}->{Type}) ||
236 $apps{$app}->{Type} ne 'Application');
238 # Skip broken files (Type=application, but no Exec key).
239 if (!exists($apps{$app}->{Exec}) ||
240 $apps{$app}->{Exec} eq '') {
241 warn 'File ' . $apps{$app}->{_Location} . ' is broken: it contains Type=Application, but no Exec key/value pair.';
245 # Don’t offer apps which have NoDisplay == true or Hidden == true.
246 # See https://wiki.xfce.org/howto/customize-menu#hide_menu_entries
247 # for the difference between NoDisplay and Hidden.
248 next if (exists($apps{$app}->{NoDisplay}) && $apps{$app}->{NoDisplay}) ||
249 (exists($apps{$app}->{Hidden}) && $apps{$app}->{Hidden});
251 if (exists($apps{$app}->{TryExec})) {
252 my $tryexec = $apps{$app}->{TryExec};
253 if (substr($tryexec, 0, 1) eq '/') {
254 # Skip if absolute path is not executable.
255 next unless -x $tryexec;
257 # Search in $PATH for the executable.
259 for my $path (split(':', $ENV{PATH})) {
260 next unless -x "$path/$tryexec";
268 if ((scalar grep { $_ eq 'name' } @entry_types) > 0) {
269 if (exists($choices{$name})) {
270 # There are two .desktop files which contain the same “Name” value.
271 # I’m not sure if that is allowed to happen, but we disambiguate the
272 # situation by appending “ (2)”, “ (3)”, etc. to the name.
274 # An example of this happening is exo-file-manager.desktop and
275 # thunar-settings.desktop, both of which contain “Name=File Manager”.
277 $inc++ while exists($choices{"$name ($inc)"});
278 $name = "$name ($inc)";
281 $choices{$name} = $app;
285 if ((scalar grep { $_ eq 'command' } @entry_types) > 0) {
286 my $command = $apps{$app}->{Exec};
288 # Handle escape sequences (should be done for all string values, but does
297 $command =~ s/(\\[sntr\\])/$escapes{$1}/go;
300 if ($command =~ m/^\s*([^\s\"]+)(?:\s|$)/) {
303 } elsif ($command =~ m/^\s*\"([^\"\\]*(?:\\.[^\"\\]*)*)\"(?:\s|$)/) {
304 # Quoted, remove quotes and fix escaped characters
306 $command =~ s/\\([\"\`\$\\])/$1/g;
308 # Invalid quotes, fallback to whitespace
309 ($command) = split(' ', $command);
312 # Don’t add “geany” if “Geany” is already present.
313 my @keys = map { lc } keys %choices;
314 if (!(scalar grep { $_ eq lc(basename($command)) } @keys) > 0) {
315 $choices{basename($command)} = $app;
320 if ((scalar grep { $_ eq 'filename' } @entry_types) > 0) {
321 my $filename = basename($app, '.desktop');
323 # Don’t add “geany” if “Geany” is already present.
324 my @keys = map { lc } keys %choices;
325 next if (scalar grep { $_ eq lc($filename) } @keys) > 0;
327 $choices{$filename} = $app;
331 # %choices now looks like this:
334 # 'Dokumentenbetrachter' => 'evince.desktop',
335 # 'gedit' => 'gedit.desktop'
338 # ┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓
339 # ┃ Run dmenu to ask the user for their choice ┃
340 # ┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛
342 # open2 will just make dmenu’s STDERR go to our own STDERR.
343 my ($dmenu_out, $dmenu_in);
345 open2($dmenu_out, $dmenu_in, $dmenu_cmd);
348 say STDERR "Running dmenu failed. Is dmenu installed at all? Try running dmenu -v";
352 binmode $dmenu_in, ':utf8';
353 binmode $dmenu_out, ':utf8';
355 # Feed dmenu the possible choices.
356 say $dmenu_in $_ for sort keys %choices;
360 my $status = ($? >> 8);
362 # Pass on dmenu’s exit status if there was an error.
363 exit $status unless $status == 0;
365 my $choice = <$dmenu_out>;
366 # dmenu ≥ 4.4 adds a newline after the choice
369 # Exact match: the user chose “Avidemux (GTK+)”
370 if (exists($choices{$choice})) {
371 $app = $apps{$choices{$choice}};
374 # Not an exact match: the user entered “Avidemux (GTK+) ~/movie.mp4”
375 for my $possibility (keys %choices) {
376 next unless substr($choice, 0, length($possibility)) eq $possibility;
377 $app = $apps{$choices{$possibility}};
378 substr($choice, 0, length($possibility)) = '';
379 # Remove whitespace separating the entry and arguments.
383 if (!defined($app)) {
384 warn "Invalid input: “$choice” does not match any application. Trying to execute nevertheless.";
386 $app->{Exec} = $choice;
387 # We assume that the app is old and does not support startup
388 # notifications because it doesn’t ship a desktop file.
389 $app->{StartupNotify} = 0;
390 $app->{_Location} = '';
394 # ┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓
395 # ┃ Make i3 start the chosen application. ┃
396 # ┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛
398 my $name = $app->{Name};
399 my $exec = $app->{Exec};
400 my $location = $app->{_Location};
402 # Quote as described by “The Exec key”:
403 # https://standards.freedesktop.org/desktop-entry-spec/latest/ar01s06.html
406 $str =~ s/("|`|\$|\\)/\\$1/g;
407 $str = qq|"$str"| if $str ne "";
411 $choice = quote($choice);
412 $location = quote($location);
413 $name = quote($name);
415 # Remove deprecated field codes, as the spec dictates.
416 $exec =~ s/%[dDnNvm]//g;
418 # Replace filename field codes with the rest of the command line.
419 # Note that we assume the user uses precisely one file name,
420 # not multiple file names.
421 $exec =~ s/%[fF]/$choice/g;
423 # If the program works with URLs,
424 # we assume the user provided a URL instead of a filename.
425 # As per the spec, there must be at most one of %f, %u, %F or %U present.
426 $exec =~ s/%[uU]/$choice/g;
428 # The translated name of the application.
429 $exec =~ s/%c/$name/g;
431 # XXX: Icons are not implemented. Is the complexity (looking up the path if
432 # only a name is given) actually worth it?
433 #$exec =~ s/%i/--icon $icon/g;
436 # location of .desktop file
437 $exec =~ s/%k/$location/g;
439 # Literal % characters are represented as %%.
442 if (exists($app->{Path}) && $app->{Path} ne '') {
443 $exec = 'cd ' . quote($app->{Path}) . ' && ' . $exec;
448 if (exists($app->{Terminal}) && $app->{Terminal}) {
449 # For applications which specify “Terminal=true” (e.g. htop.desktop),
450 # we need to create a temporary script that contains the full command line
451 # as the syntax for starting commands with arguments varies from terminal
452 # emulator to terminal emulator.
453 # Then, we launch that script with i3-sensible-terminal.
454 my ($fh, $filename) = tempfile();
455 binmode($fh, ':utf8');
462 chmod 0755, $filename;
464 $cmd = qq|exec i3-sensible-terminal -e "$filename"|;
466 # i3 executes applications by passing the argument to i3’s “exec” command
467 # as-is to $SHELL -c. The i3 parser supports quoted strings: When a string
468 # starts with a double quote ("), everything is parsed as-is until the next
469 # double quote which is NOT preceded by a backslash (\).
471 # Therefore, we escape all double quotes (") by replacing them with \"
474 if (exists($app->{StartupNotify}) && !$app->{StartupNotify}) {
475 $nosn = '--no-startup-id';
477 $cmd = qq|exec $nosn "$exec"|;
480 system('i3-msg', $cmd) == 0 or die "Could not launch i3-msg: $?";
486 i3-dmenu-desktop - run .desktop files with dmenu
490 i3-dmenu-desktop [--dmenu='dmenu -i'] [--entry-type=name]
494 i3-dmenu-desktop is a script which extracts the (localized) name from
495 application .desktop files, offers the user a choice via dmenu(1) and then
496 starts the chosen application via i3 (for startup notification support).
497 The advantage of using .desktop files instead of dmenu_run(1) is that dmenu_run
498 offers B<all> binaries in your $PATH, including non-interactive utilities like
499 "sed". Also, .desktop files contain a proper name, information about whether
500 the application runs in a terminal and whether it supports startup
503 The .desktop files are searched in $XDG_DATA_HOME/applications (by default
504 $HOME/.local/share/applications) and in the "applications" subdirectory of each
505 entry of $XDG_DATA_DIRS (by default /usr/local/share/:/usr/share/).
507 Files with the same name in $XDG_DATA_HOME/applications take precedence over
508 files in $XDG_DATA_DIRS, so that you can overwrite parts of the system-wide
509 .desktop files by copying them to your local directory and making changes.
511 i3-dmenu-desktop displays the "Name" value in the localized version depending
512 on LC_MESSAGES as specified in the Desktop Entry Specification.
514 You can pass a filename or URL (%f/%F and %u/%U field codes in the .desktop
515 file respectively) by appending it to the name of the application. E.g., if you
516 want to launch "GNU Emacs 24" with the patch /tmp/foobar.txt, you would type
517 "emacs", press TAB, type " /tmp/foobar.txt" and press ENTER.
519 .desktop files with Terminal=true are started using i3-sensible-terminal(1).
521 .desktop files with NoDisplay=true or Hidden=true are skipped.
523 UTF-8 is supported, of course, but dmenu does not support displaying all
524 glyphs. E.g., xfce4-terminal.desktop's Name[fi]=Pääte will be displayed just
525 fine, but not its Name[ru]=Терминал.
531 =item B<--dmenu=command>
533 Execute command instead of 'dmenu -i'. This option can be used to pass custom
534 parameters to dmenu, or to make i3-dmenu-desktop start a custom (patched?)
537 =item B<--entry-type=type>
539 Display the (localized) "Name" (type = name), the command (type = command) or
540 the (*.desktop) filename (type = filename) in dmenu. This option can be
541 specified multiple times.
543 Examples are "GNU Image Manipulation Program" (type = name), "gimp" (type =
544 command), and "libreoffice-writer" (type = filename).
554 Michael Stapelberg, C<< <michael at i3wm.org> >>
556 =head1 LICENSE AND COPYRIGHT
558 Copyright 2012 Michael Stapelberg.
560 This program is free software; you can redistribute it and/or modify it
561 under the terms of the BSD license.