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
28 open(my $fh, '<', $filename) or die "$!";
35 warn "Could not read $filename: $@";
43 my $dmenu_cmd = 'dmenu -i';
44 my $result = GetOptions(
45 'dmenu=s' => \$dmenu_cmd,
46 'entry-type=s' => \@entry_types,
48 say "dmenu-desktop 1.5 © 2012 Michael Stapelberg";
52 pod2usage(-exitval => 0);
55 die "Could not parse command line options" unless $result;
57 # Filter entry types and set default type(s) if none selected
63 @entry_types = grep { exists($valid_types->{$_}) } @entry_types;
64 @entry_types = ('name', 'command') unless @entry_types;
66 # ┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓
67 # ┃ Convert LC_MESSAGES into an ordered list of suffixes to search for in the ┃
68 # ┃ .desktop files (e.g. “Name[de_DE@euro]” for LC_MESSAGES=de_DE.UTF-8@euro ┃
69 # ┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛
71 # For details on how the transformation of LC_MESSAGES to a list of keys that
72 # should be looked up works, refer to “Localized values for keys” of the
73 # “Desktop Entry Specification”:
74 # http://standards.freedesktop.org/desktop-entry-spec/latest/ar01s04.html
75 my $lc_messages = setlocale(LC_MESSAGES);
77 # Ignore the encoding (e.g. .UTF-8)
78 $lc_messages =~ s/\.[^@]+//g;
80 my @suffixes = ($lc_messages);
82 # _COUNTRY and @MODIFIER are present
83 if ($lc_messages =~ /_[^@]+@/) {
84 my $no_modifier = $lc_messages;
85 $no_modifier =~ s/@.*//g;
86 push @suffixes, $no_modifier;
88 my $no_country = $lc_messages;
89 $no_country =~ s/_[^@]+//g;
90 push @suffixes, $no_country;
93 # Strip _COUNTRY and @MODIFIER if present
94 $lc_messages =~ s/[_@].*//g;
95 push @suffixes, $lc_messages;
97 # ┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓
98 # ┃ Read all .desktop files and store the values in which we are interested. ┃
99 # ┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛
102 # See http://standards.freedesktop.org/basedir-spec/basedir-spec-latest.html#variables
103 my $xdg_data_home = $ENV{XDG_DATA_HOME};
104 $xdg_data_home = $ENV{HOME} . '/.local/share' if
105 !defined($xdg_data_home) ||
106 $xdg_data_home eq '' ||
109 my $xdg_data_dirs = $ENV{XDG_DATA_DIRS};
110 $xdg_data_dirs = '/usr/local/share/:/usr/share/' if
111 !defined($xdg_data_dirs) ||
112 $xdg_data_dirs eq '';
114 my @searchdirs = ("$xdg_data_home/applications/");
115 for my $dir (split(':', $xdg_data_dirs)) {
116 push @searchdirs, "$dir/applications/";
119 # Cleanup the paths, maybe some application does not cope with double slashes
120 # (the field code %k is replaced with the .desktop file location).
121 @searchdirs = map { s,//,/,g; $_ } @searchdirs;
123 # To avoid errors by File::Find’s find(), only pass existing directories.
124 @searchdirs = grep { -d $_ } @searchdirs;
129 return unless substr($_, -1 * length('.desktop')) eq '.desktop';
130 my $relative = $File::Find::name;
132 # + 1 for the trailing /, which is missing in ::topdir.
133 substr($relative, 0, length($File::Find::topdir) + 1) = '';
135 # Don’t overwrite files with the same relative path, we search in
136 # descending order of importance.
137 return if exists($desktops{$relative});
139 $desktops{$relative} = $File::Find::name;
148 for my $file (values %desktops) {
149 my $base = basename($file);
151 # _ is an invalid character for a key, so we can use it for our own keys.
152 $apps{$base}->{_Location} = $file;
154 # Extract all “Name” and “Exec” keys from the [Desktop Entry] group
155 # and store them in $apps{$base}.
157 my $content = slurp($file);
158 next unless defined($content);
159 my @lines = split("\n", $content);
160 for my $line (@lines) {
161 my $first = substr($line, 0, 1);
162 next if $line eq '' || $first eq '#';
163 next unless ($line eq '[Desktop Entry]' ..
165 substr($line, -1) eq ']' &&
166 $line ne '[Desktop Entry]'));
167 next if $first eq '[';
169 my ($key, $value) = ($line =~ /^
171 [A-Za-z0-9-]+ # the spec specifies these as valid key characters
172 (?:\[[^]]+\])? # possibly, there as a locale suffix
174 \s* = \s* # whitespace around = should be ignored
175 (.*) # no restrictions on the values
178 if ($key =~ /^Name/) {
179 $names{$key} = $value;
180 } elsif ($key eq 'Exec' ||
184 $apps{$base}->{$key} = $value;
185 } elsif ($key eq 'NoDisplay' ||
187 $key eq 'StartupNotify' ||
188 $key eq 'Terminal') {
189 # Values of type boolean must either be string true or false,
190 # see “Possible value types”:
191 # http://standards.freedesktop.org/desktop-entry-spec/latest/ar01s03.html
192 $apps{$base}->{$key} = ($value eq 'true');
196 for my $suffix (@suffixes) {
197 next unless exists($names{"Name[$suffix]"});
198 $apps{$base}->{Name} = $names{"Name[$suffix]"};
202 # Fallback to unlocalized “Name”.
203 $apps{$base}->{Name} = $names{Name} unless exists($apps{$base}->{Name});
206 # %apps now looks like this:
209 # 'evince.desktop' => {
210 # 'Exec' => 'evince %U',
211 # 'Name' => 'Dokumentenbetrachter',
212 # '_Location' => '/usr/share/applications/evince.desktop'
214 # 'gedit.desktop' => {
215 # 'Exec' => 'gedit %U',
217 # '_Location' => '/usr/share/applications/gedit.desktop'
221 # ┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓
222 # ┃ Turn %apps inside out to provide Name → filename lookup. ┃
223 # ┃ The Name is what we display in dmenu later. ┃
224 # ┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛
227 for my $app (keys %apps) {
228 my $name = $apps{$app}->{Name};
230 # Don’t try to use .desktop files which don’t have Type=application
231 next if (!exists($apps{$app}->{Type}) ||
232 $apps{$app}->{Type} ne 'Application');
234 # Skip broken files (Type=application, but no Exec key).
235 if (!exists($apps{$app}->{Exec}) ||
236 $apps{$app}->{Exec} eq '') {
237 warn 'File ' . $apps{$app}->{_Location} . ' is broken: it contains Type=Application, but no Exec key/value pair.';
241 # Don’t offer apps which have NoDisplay == true or Hidden == true.
242 # See http://wiki.xfce.org/howto/customize-menu#hide_menu_entries
243 # for the difference between NoDisplay and Hidden.
244 next if (exists($apps{$app}->{NoDisplay}) && $apps{$app}->{NoDisplay}) ||
245 (exists($apps{$app}->{Hidden}) && $apps{$app}->{Hidden});
247 if (exists($apps{$app}->{TryExec})) {
248 my $tryexec = $apps{$app}->{TryExec};
249 if (substr($tryexec, 0, 1) eq '/') {
250 # Skip if absolute path is not executable.
251 next unless -x $tryexec;
253 # Search in $PATH for the executable.
255 for my $path (split(':', $ENV{PATH})) {
256 next unless -x "$path/$tryexec";
264 if ((scalar grep { $_ eq 'name' } @entry_types) > 0) {
265 if (exists($choices{$name})) {
266 # There are two .desktop files which contain the same “Name” value.
267 # I’m not sure if that is allowed to happen, but we disambiguate the
268 # situation by appending “ (2)”, “ (3)”, etc. to the name.
270 # An example of this happening is exo-file-manager.desktop and
271 # thunar-settings.desktop, both of which contain “Name=File Manager”.
273 $inc++ while exists($choices{"$name ($inc)"});
274 $name = "$name ($inc)";
277 $choices{$name} = $app;
280 if ((scalar grep { $_ eq 'command' } @entry_types) > 0) {
281 my ($command) = split(' ', $apps{$app}->{Exec});
283 # Don’t add “geany” if “Geany” is already present.
284 my @keys = map { lc } keys %choices;
285 next if (scalar grep { $_ eq lc(basename($command)) } @keys) > 0;
287 $choices{basename($command)} = $app;
290 if ((scalar grep { $_ eq 'filename' } @entry_types) > 0) {
291 my $filename = basename($app, '.desktop');
293 # Don’t add “geany” if “Geany” is already present.
294 my @keys = map { lc } keys %choices;
295 next if (scalar grep { $_ eq lc($filename) } @keys) > 0;
297 $choices{$filename} = $app;
301 # %choices now looks like this:
304 # 'Dokumentenbetrachter' => 'evince.desktop',
305 # 'gedit' => 'gedit.desktop'
308 # ┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓
309 # ┃ Run dmenu to ask the user for their choice ┃
310 # ┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛
312 # open2 will just make dmenu’s STDERR go to our own STDERR.
313 my ($dmenu_out, $dmenu_in);
315 open2($dmenu_out, $dmenu_in, $dmenu_cmd);
318 say STDERR "Running dmenu failed. Is dmenu installed at all? Try running dmenu -v";
322 binmode $dmenu_in, ':utf8';
323 binmode $dmenu_out, ':utf8';
325 # Feed dmenu the possible choices.
326 say $dmenu_in $_ for sort keys %choices;
330 my $status = ($? >> 8);
332 # Pass on dmenu’s exit status if there was an error.
333 exit $status unless $status == 0;
335 my $choice = <$dmenu_out>;
336 # dmenu ≥ 4.4 adds a newline after the choice
339 # Exact match: the user chose “Avidemux (GTK+)”
340 if (exists($choices{$choice})) {
341 $app = $apps{$choices{$choice}};
344 # Not an exact match: the user entered “Avidemux (GTK+) ~/movie.mp4”
345 for my $possibility (keys %choices) {
346 next unless substr($choice, 0, length($possibility)) eq $possibility;
347 $app = $apps{$choices{$possibility}};
348 substr($choice, 0, length($possibility)) = '';
349 # Remove whitespace separating the entry and arguments.
353 if (!defined($app)) {
354 warn "Invalid input: “$choice” does not match any application. Trying to execute nevertheless.";
356 $app->{Exec} = $choice;
357 # We assume that the app is old and does not support startup
358 # notifications because it doesn’t ship a desktop file.
359 $app->{StartupNotify} = 0;
360 $app->{_Location} = '';
364 # ┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓
365 # ┃ Make i3 start the chosen application. ┃
366 # ┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛
368 my $name = $app->{Name};
369 my $exec = $app->{Exec};
370 my $location = $app->{_Location};
372 # Quote as described by “The Exec key”:
373 # http://standards.freedesktop.org/desktop-entry-spec/latest/ar01s06.html
376 $str =~ s/("|`|\$|\\)/\\$1/g;
377 $str = qq|"$str"| if $str ne "";
381 $choice = quote($choice);
382 $location = quote($location);
383 $name = quote($name);
385 # Remove deprecated field codes, as the spec dictates.
386 $exec =~ s/%[dDnNvm]//g;
388 # Replace filename field codes with the rest of the command line.
389 # Note that we assume the user uses precisely one file name,
390 # not multiple file names.
391 $exec =~ s/%[fF]/$choice/g;
393 # If the program works with URLs,
394 # we assume the user provided a URL instead of a filename.
395 # As per the spec, there must be at most one of %f, %u, %F or %U present.
396 $exec =~ s/%[uU]/$choice/g;
398 # The translated name of the application.
399 $exec =~ s/%c/$name/g;
401 # XXX: Icons are not implemented. Is the complexity (looking up the path if
402 # only a name is given) actually worth it?
403 #$exec =~ s/%i/--icon $icon/g;
406 # location of .desktop file
407 $exec =~ s/%k/$location/g;
409 # Literal % characters are represented as %%.
412 if (exists($app->{Path}) && $app->{Path} ne '') {
413 $exec = 'cd ' . quote($app->{Path}) . ' && ' . $exec;
418 if (exists($app->{Terminal}) && $app->{Terminal}) {
419 # For applications which specify “Terminal=true” (e.g. htop.desktop),
420 # we need to create a temporary script that contains the full command line
421 # as the syntax for starting commands with arguments varies from terminal
422 # emulator to terminal emulator.
423 # Then, we launch that script with i3-sensible-terminal.
424 my ($fh, $filename) = tempfile();
425 binmode($fh, ':utf8');
432 chmod 0755, $filename;
434 $cmd = qq|exec i3-sensible-terminal -e "$filename"|;
436 # i3 executes applications by passing the argument to i3’s “exec” command
437 # as-is to $SHELL -c. The i3 parser supports quoted strings: When a string
438 # starts with a double quote ("), everything is parsed as-is until the next
439 # double quote which is NOT preceded by a backslash (\).
441 # Therefore, we escape all double quotes (") by replacing them with \"
444 if (exists($app->{StartupNotify}) && !$app->{StartupNotify}) {
445 $nosn = '--no-startup-id';
447 $cmd = qq|exec $nosn "$exec"|;
450 system('i3-msg', $cmd) == 0 or die "Could not launch i3-msg: $?";
456 i3-dmenu-desktop - run .desktop files with dmenu
460 i3-dmenu-desktop [--dmenu='dmenu -i'] [--entry-type=name]
464 i3-dmenu-desktop is a script which extracts the (localized) name from
465 application .desktop files, offers the user a choice via dmenu(1) and then
466 starts the chosen application via i3 (for startup notification support).
467 The advantage of using .desktop files instead of dmenu_run(1) is that dmenu_run
468 offers B<all> binaries in your $PATH, including non-interactive utilities like
469 "sed". Also, .desktop files contain a proper name, information about whether
470 the application runs in a terminal and whether it supports startup
473 The .desktop files are searched in $XDG_DATA_HOME/applications (by default
474 $HOME/.local/share/applications) and in the "applications" subdirectory of each
475 entry of $XDG_DATA_DIRS (by default /usr/local/share/:/usr/share/).
477 Files with the same name in $XDG_DATA_HOME/applications take precedence over
478 files in $XDG_DATA_DIRS, so that you can overwrite parts of the system-wide
479 .desktop files by copying them to your local directory and making changes.
481 i3-dmenu-desktop displays the "Name" value in the localized version depending
482 on LC_MESSAGES as specified in the Desktop Entry Specification.
484 You can pass a filename or URL (%f/%F and %u/%U field codes in the .desktop
485 file respectively) by appending it to the name of the application. E.g., if you
486 want to launch "GNU Emacs 24" with the patch /tmp/foobar.txt, you would type
487 "emacs", press TAB, type " /tmp/foobar.txt" and press ENTER.
489 .desktop files with Terminal=true are started using i3-sensible-terminal(1).
491 .desktop files with NoDisplay=true or Hidden=true are skipped.
493 UTF-8 is supported, of course, but dmenu does not support displaying all
494 glyphs. E.g., xfce4-terminal.desktop's Name[fi]=Pääte will be displayed just
495 fine, but not its Name[ru]=Терминал.
501 =item B<--dmenu=command>
503 Execute command instead of 'dmenu -i'. This option can be used to pass custom
504 parameters to dmenu, or to make i3-dmenu-desktop start a custom (patched?)
507 =item B<--entry-type=type>
509 Display the (localized) "Name" (type = name), the command (type = command) or
510 the (*.desktop) filename (type = filename) in dmenu. This option can be
511 specified multiple times.
513 Examples are "GNU Image Manipulation Program" (type = name), "gimp" (type =
514 command), and "libreoffice-writer" (type = filename).
524 Michael Stapelberg, C<< <michael at i3wm.org> >>
526 =head1 LICENSE AND COPYRIGHT
528 Copyright 2012 Michael Stapelberg.
530 This program is free software; you can redistribute it and/or modify it
531 under the terms of the BSD license.