1 /* GIO - GLib Input, Output and Streaming Library
3 * Copyright (C) 2006-2007 Red Hat, Inc.
4 * Copyright © 2007 Ryan Lortie
6 * This library is free software; you can redistribute it and/or
7 * modify it under the terms of the GNU Lesser General Public
8 * License as published by the Free Software Foundation; either
9 * version 2.1 of the License, or (at your option) any later version.
11 * This library is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
14 * Lesser General Public License for more details.
16 * You should have received a copy of the GNU Lesser General
17 * Public License along with this library; if not, see <http://www.gnu.org/licenses/>.
19 * Author: Alexander Larsson <alexl@redhat.com>
20 * Ryan Lortie <desrt@desrt.ca>
31 #ifdef HAVE_CRT_EXTERNS_H
32 #include <crt_externs.h>
35 #include "gcontenttypeprivate.h"
36 #include "gdesktopappinfo.h"
38 #include "glib-unix.h"
42 #include "gthemedicon.h"
43 #include "gfileicon.h"
44 #include <glib/gstdio.h>
46 #include "giomodule-priv.h"
48 #include "gappinfoprivate.h"
49 #include "glocalfilemonitor.h"
52 #include "gdocumentportal.h"
56 * SECTION:gdesktopappinfo
57 * @title: GDesktopAppInfo
58 * @short_description: Application information from desktop files
59 * @include: gio/gdesktopappinfo.h
61 * #GDesktopAppInfo is an implementation of #GAppInfo based on
64 * Note that `<gio/gdesktopappinfo.h>` belongs to the UNIX-specific
65 * GIO interfaces, thus you have to use the `gio-unix-2.0.pc` pkg-config
69 #define DEFAULT_APPLICATIONS_GROUP "Default Applications"
70 #define ADDED_ASSOCIATIONS_GROUP "Added Associations"
71 #define REMOVED_ASSOCIATIONS_GROUP "Removed Associations"
72 #define MIME_CACHE_GROUP "MIME Cache"
73 #define GENERIC_NAME_KEY "GenericName"
74 #define FULL_NAME_KEY "X-GNOME-FullName"
75 #define KEYWORDS_KEY "Keywords"
76 #define STARTUP_WM_CLASS_KEY "StartupWMClass"
83 static void g_desktop_app_info_iface_init (GAppInfoIface *iface);
84 static gboolean g_desktop_app_info_ensure_saved (GDesktopAppInfo *info,
90 * Information about an installed application from a desktop file.
92 struct _GDesktopAppInfo
94 GObject parent_instance;
116 char *startup_wm_class;
123 guint startup_notify : 1;
128 UPDATE_MIME_NONE = 1 << 0,
129 UPDATE_MIME_SET_DEFAULT = 1 << 1,
130 UPDATE_MIME_SET_NON_DEFAULT = 1 << 2,
131 UPDATE_MIME_REMOVE = 1 << 3,
132 UPDATE_MIME_SET_LAST_USED = 1 << 4,
135 G_DEFINE_TYPE_WITH_CODE (GDesktopAppInfo, g_desktop_app_info, G_TYPE_OBJECT,
136 G_IMPLEMENT_INTERFACE (G_TYPE_APP_INFO, g_desktop_app_info_iface_init))
138 /* DesktopFileDir implementation {{{1 */
143 gchar *alternatively_watching;
146 GFileMonitor *monitor;
147 GHashTable *app_names;
148 GHashTable *mime_tweaks;
149 GHashTable *memory_index;
150 GHashTable *memory_implementations;
153 static DesktopFileDir *desktop_file_dirs;
154 static guint n_desktop_file_dirs;
155 static const guint desktop_file_dir_user_config_index = 0;
156 static guint desktop_file_dir_user_data_index;
157 static GMutex desktop_file_dir_lock;
158 static const gchar *gio_launch_desktop_path = NULL;
160 /* Monitor 'changed' signal handler {{{2 */
161 static void desktop_file_dir_reset (DesktopFileDir *dir);
164 * desktop_file_dir_get_alternative_dir:
165 * @dir: a #DesktopFileDir
167 * Gets the "alternative" directory to monitor in case the path
170 * If the path exists this will return NULL, otherwise it will return a
171 * parent directory of the path.
173 * This is used to avoid inotify on a non-existent directory (which
174 * results in polling).
176 * See https://bugzilla.gnome.org/show_bug.cgi?id=522314 for more info.
179 desktop_file_dir_get_alternative_dir (DesktopFileDir *dir)
183 /* If the directory itself exists then we need no alternative. */
184 if (g_access (dir->path, R_OK | X_OK) == 0)
187 /* Otherwise, try the parent directories until we find one. */
188 parent = g_path_get_dirname (dir->path);
190 while (g_access (parent, R_OK | X_OK) != 0)
194 parent = g_path_get_dirname (tmp);
196 /* If somehow we get to '/' or '.' then just stop... */
197 if (g_str_equal (parent, tmp))
210 desktop_file_dir_changed (GFileMonitor *monitor,
213 GFileMonitorEvent event_type,
216 DesktopFileDir *dir = user_data;
217 gboolean do_nothing = FALSE;
219 /* We are not interested in receiving notifications forever just
220 * because someone asked about one desktop file once.
222 * After we receive the first notification, reset the dir, destroying
223 * the monitor. We will take this as a hint, next time that we are
224 * asked, that we need to check if everything is up to date.
226 * If this is a notification for a parent directory (because the
227 * desktop directory didn't exist) then we shouldn't fire the signal
228 * unless something actually changed.
230 g_mutex_lock (&desktop_file_dir_lock);
232 if (dir->alternatively_watching)
234 gchar *alternative_dir;
236 alternative_dir = desktop_file_dir_get_alternative_dir (dir);
237 do_nothing = alternative_dir && g_str_equal (dir->alternatively_watching, alternative_dir);
238 g_free (alternative_dir);
242 desktop_file_dir_reset (dir);
244 g_mutex_unlock (&desktop_file_dir_lock);
246 /* Notify anyone else who may be interested */
248 g_app_info_monitor_fire ();
251 /* Internal utility functions {{{2 */
254 * desktop_file_dir_app_name_is_masked:
255 * @dir: a #DesktopFileDir
256 * @app_name: an application ID
258 * Checks if @app_name is masked for @dir.
260 * An application is masked if a similarly-named desktop file exists in
261 * a desktop file directory with higher precedence. Masked desktop
262 * files should be ignored.
265 desktop_file_dir_app_name_is_masked (DesktopFileDir *dir,
266 const gchar *app_name)
268 while (dir > desktop_file_dirs)
272 if (dir->app_names && g_hash_table_contains (dir->app_names, app_name))
279 static const gchar * const *
280 get_lowercase_current_desktops (void)
282 static gchar **result;
284 if (g_once_init_enter (&result))
289 envvar = g_getenv ("XDG_CURRENT_DESKTOP");
295 tmp = g_strsplit (envvar, G_SEARCHPATH_SEPARATOR_S, 0);
297 for (i = 0; tmp[i]; i++)
298 for (j = 0; tmp[i][j]; j++)
299 tmp[i][j] = g_ascii_tolower (tmp[i][j]);
302 tmp = g_new0 (gchar *, 0 + 1);
304 g_once_init_leave (&result, tmp);
307 return (const gchar **) result;
310 static const gchar * const *
311 get_current_desktops (const gchar *value)
313 static gchar **result;
315 if (g_once_init_enter (&result))
320 value = g_getenv ("XDG_CURRENT_DESKTOP");
325 tmp = g_strsplit (value, ":", 0);
327 g_once_init_leave (&result, tmp);
330 return (const gchar **) result;
334 * add_to_table_if_appropriate:
335 * @apps: a string to GDesktopAppInfo hash table
336 * @app_name: the name of the application
337 * @info: a #GDesktopAppInfo, or NULL
339 * If @info is non-%NULL and non-hidden, then add it to @apps, using
340 * @app_name as a key.
342 * If @info is non-%NULL then this function will consume the passed-in
346 add_to_table_if_appropriate (GHashTable *apps,
347 const gchar *app_name,
348 GDesktopAppInfo *info)
355 g_object_unref (info);
359 g_free (info->desktop_id);
360 info->desktop_id = g_strdup (app_name);
362 g_hash_table_insert (apps, g_strdup (info->desktop_id), info);
369 DESKTOP_KEY_GenericName,
370 DESKTOP_KEY_Keywords,
372 DESKTOP_KEY_X_GNOME_FullName,
377 const gchar desktop_key_match_category[N_DESKTOP_KEYS] = {
378 /* Note: lower numbers are a better match.
380 * In case we want two keys to match at the same level, we can just
381 * use the same number for the two different keys.
383 [DESKTOP_KEY_Name] = 1,
384 [DESKTOP_KEY_Exec] = 2,
385 [DESKTOP_KEY_Keywords] = 3,
386 [DESKTOP_KEY_GenericName] = 4,
387 [DESKTOP_KEY_X_GNOME_FullName] = 5,
388 [DESKTOP_KEY_Comment] = 6
391 /* Common prefix commands to ignore from Exec= lines */
392 const char * const exec_key_match_blacklist[] = {
408 desktop_key_get_name (guint key_id)
412 case DESKTOP_KEY_Comment:
414 case DESKTOP_KEY_Exec:
416 case DESKTOP_KEY_GenericName:
417 return GENERIC_NAME_KEY;
418 case DESKTOP_KEY_Keywords:
420 case DESKTOP_KEY_Name:
422 case DESKTOP_KEY_X_GNOME_FullName:
423 return FULL_NAME_KEY;
425 g_assert_not_reached ();
429 /* Search global state {{{2
431 * We only ever search under a global lock, so we can use (and reuse)
432 * some global data to reduce allocations made while searching.
434 * In short, we keep around arrays of results that we expand as needed
435 * (and never shrink).
437 * static_token_results: this is where we append the results for each
438 * token within a given desktop directory, as we handle it (which is
439 * a union of all matches for this term)
441 * static_search_results: this is where we build the complete results
442 * for a single directory (which is an intersection of the matches
443 * found for each term)
445 * static_total_results: this is where we build the complete results
446 * across all directories (which is a union of the matches found in
449 * The app_names that enter these tables are always pointer-unique (in
450 * the sense that string equality is the same as pointer equality).
451 * This can be guaranteed for two reasons:
453 * - we mask appids so that a given appid will only ever appear within
454 * the highest-precedence directory that contains it. We never
455 * return search results from a lower-level directory if a desktop
456 * file exists in a higher-level one.
458 * - within a given directory, the string is unique because it's the
459 * key in the hashtable of all app_ids for that directory.
461 * We perform a merging of the results in merge_token_results(). This
462 * works by ordering the two lists and moving through each of them (at
463 * the same time) looking for common elements, rejecting uncommon ones.
464 * "Order" here need not mean any particular thing, as long as it is
465 * some order. Because of the uniqueness of our strings, we can use
466 * pointer order. That's what's going on in compare_results() below.
470 const gchar *app_name;
474 static struct search_result *static_token_results;
475 static gint static_token_results_size;
476 static gint static_token_results_allocated;
477 static struct search_result *static_search_results;
478 static gint static_search_results_size;
479 static gint static_search_results_allocated;
480 static struct search_result *static_total_results;
481 static gint static_total_results_size;
482 static gint static_total_results_allocated;
484 /* And some functions for performing nice operations against it */
486 compare_results (gconstpointer a,
489 const struct search_result *ra = a;
490 const struct search_result *rb = b;
492 if (ra->app_name < rb->app_name)
495 else if (ra->app_name > rb->app_name)
499 return ra->category - rb->category;
503 compare_categories (gconstpointer a,
506 const struct search_result *ra = a;
507 const struct search_result *rb = b;
509 return ra->category - rb->category;
513 add_token_result (const gchar *app_name,
516 if G_UNLIKELY (static_token_results_size == static_token_results_allocated)
518 static_token_results_allocated = MAX (16, static_token_results_allocated * 2);
519 static_token_results = g_renew (struct search_result, static_token_results, static_token_results_allocated);
522 static_token_results[static_token_results_size].app_name = app_name;
523 static_token_results[static_token_results_size].category = category;
524 static_token_results_size++;
528 merge_token_results (gboolean first)
530 if (static_token_results_size != 0)
531 qsort (static_token_results, static_token_results_size, sizeof (struct search_result), compare_results);
533 /* If this is the first token then we are basically merging a list with
534 * itself -- we only perform de-duplication.
536 * If this is not the first token then we are doing a real merge.
540 const gchar *last_name = NULL;
543 /* We must de-duplicate, but we do so by taking the best category
546 * The final list can be as large as the input here, so make sure
547 * we have enough room (even if it's too much room).
550 if G_UNLIKELY (static_search_results_allocated < static_token_results_size)
552 static_search_results_allocated = static_token_results_allocated;
553 static_search_results = g_renew (struct search_result,
554 static_search_results,
555 static_search_results_allocated);
558 for (i = 0; i < static_token_results_size; i++)
560 /* The list is sorted so that the best match for a given id
561 * will be at the front, so once we have copied an id, skip
562 * the rest of the entries for the same id.
564 if (static_token_results[i].app_name == last_name)
567 last_name = static_token_results[i].app_name;
569 static_search_results[static_search_results_size++] = static_token_results[i];
574 const gchar *last_name = NULL;
578 /* We only ever remove items from the results list, so no need to
579 * resize to ensure that we have enough room.
581 for (i = 0; i < static_token_results_size; i++)
583 if (static_token_results[i].app_name == last_name)
586 last_name = static_token_results[i].app_name;
588 /* Now we only want to have a result in static_search_results
589 * if we already have it there *and* we have it in
590 * static_token_results as well. The category will be the
593 * Skip past the results in static_search_results that are not
594 * going to be matches.
596 while (k < static_search_results_size &&
597 static_search_results[k].app_name < static_token_results[i].app_name)
600 if (k < static_search_results_size &&
601 static_search_results[k].app_name == static_token_results[i].app_name)
605 * Category should be the worse of the two (ie:
606 * numerically larger).
608 static_search_results[j].app_name = static_search_results[k].app_name;
609 static_search_results[j].category = MAX (static_search_results[k].category,
610 static_token_results[i].category);
615 static_search_results_size = j;
618 /* Clear it out for next time... */
619 static_token_results_size = 0;
623 reset_total_search_results (void)
625 static_total_results_size = 0;
629 sort_total_search_results (void)
631 if (static_total_results_size != 0)
632 qsort (static_total_results, static_total_results_size, sizeof (struct search_result), compare_categories);
636 merge_directory_results (void)
638 if G_UNLIKELY (static_total_results_size + static_search_results_size > static_total_results_allocated)
640 static_total_results_allocated = MAX (16, static_total_results_allocated);
641 while (static_total_results_allocated < static_total_results_size + static_search_results_size)
642 static_total_results_allocated *= 2;
643 static_total_results = g_renew (struct search_result, static_total_results, static_total_results_allocated);
646 if (static_total_results + static_total_results_size != 0)
647 memcpy (static_total_results + static_total_results_size,
648 static_search_results,
649 static_search_results_size * sizeof (struct search_result));
651 static_total_results_size += static_search_results_size;
653 /* Clear it out for next time... */
654 static_search_results_size = 0;
657 /* Support for unindexed DesktopFileDirs {{{2 */
659 get_apps_from_dir (GHashTable **apps,
663 const char *basename;
666 dir = g_dir_open (dirname, 0, NULL);
671 while ((basename = g_dir_read_name (dir)) != NULL)
675 filename = g_build_filename (dirname, basename, NULL);
677 if (g_str_has_suffix (basename, ".desktop"))
681 app_name = g_strconcat (prefix, basename, NULL);
684 *apps = g_hash_table_new_full (g_str_hash, g_str_equal, g_free, g_free);
686 g_hash_table_insert (*apps, app_name, g_strdup (filename));
688 else if (g_file_test (filename, G_FILE_TEST_IS_DIR))
692 subprefix = g_strconcat (prefix, basename, "-", NULL);
693 get_apps_from_dir (apps, filename, subprefix);
708 } UnindexedMimeTweaks;
711 free_mime_tweaks (gpointer data)
713 UnindexedMimeTweaks *tweaks = data;
715 g_strfreev (tweaks->additions);
716 g_strfreev (tweaks->removals);
717 g_strfreev (tweaks->defaults);
719 g_slice_free (UnindexedMimeTweaks, tweaks);
722 static UnindexedMimeTweaks *
723 desktop_file_dir_unindexed_get_tweaks (DesktopFileDir *dir,
724 const gchar *mime_type)
726 UnindexedMimeTweaks *tweaks;
727 gchar *unaliased_type;
729 unaliased_type = _g_unix_content_type_unalias (mime_type);
730 tweaks = g_hash_table_lookup (dir->mime_tweaks, unaliased_type);
734 tweaks = g_slice_new0 (UnindexedMimeTweaks);
735 g_hash_table_insert (dir->mime_tweaks, unaliased_type, tweaks);
738 g_free (unaliased_type);
743 /* consumes 'to_add' */
745 expand_strv (gchar ***strv_ptr,
747 gchar * const *blacklist)
749 guint strv_len, add_len;
760 strv_len = g_strv_length (strv);
761 add_len = g_strv_length (to_add);
762 strv = g_renew (gchar *, strv, strv_len + add_len + 1);
764 for (i = 0; to_add[i]; i++)
766 /* Don't add blacklisted strings */
768 for (j = 0; blacklist[j]; j++)
769 if (g_str_equal (to_add[i], blacklist[j]))
772 /* Don't add duplicates already in the list */
773 for (j = 0; j < strv_len; j++)
774 if (g_str_equal (to_add[i], strv[j]))
777 strv[strv_len++] = to_add[i];
784 strv[strv_len] = NULL;
791 desktop_file_dir_unindexed_read_mimeapps_list (DesktopFileDir *dir,
792 const gchar *filename,
793 const gchar *added_group,
794 gboolean tweaks_permitted)
796 UnindexedMimeTweaks *tweaks;
797 char **desktop_file_ids;
802 key_file = g_key_file_new ();
803 if (!g_key_file_load_from_file (key_file, filename, G_KEY_FILE_NONE, NULL))
805 g_key_file_free (key_file);
809 mime_types = g_key_file_get_keys (key_file, added_group, NULL, NULL);
811 if G_UNLIKELY (mime_types != NULL && !tweaks_permitted)
813 g_warning ("%s contains a [%s] group, but it is not permitted here. Only the non-desktop-specific "
814 "mimeapps.list file may add or remove associations.", filename, added_group);
815 g_strfreev (mime_types);
819 if (mime_types != NULL)
821 for (i = 0; mime_types[i] != NULL; i++)
823 desktop_file_ids = g_key_file_get_string_list (key_file, added_group, mime_types[i], NULL, NULL);
825 if (desktop_file_ids)
827 tweaks = desktop_file_dir_unindexed_get_tweaks (dir, mime_types[i]);
828 expand_strv (&tweaks->additions, desktop_file_ids, tweaks->removals);
832 g_strfreev (mime_types);
835 mime_types = g_key_file_get_keys (key_file, REMOVED_ASSOCIATIONS_GROUP, NULL, NULL);
837 if G_UNLIKELY (mime_types != NULL && !tweaks_permitted)
839 g_warning ("%s contains a [%s] group, but it is not permitted here. Only the non-desktop-specific "
840 "mimeapps.list file may add or remove associations.", filename, REMOVED_ASSOCIATIONS_GROUP);
841 g_strfreev (mime_types);
845 if (mime_types != NULL)
847 for (i = 0; mime_types[i] != NULL; i++)
849 desktop_file_ids = g_key_file_get_string_list (key_file, REMOVED_ASSOCIATIONS_GROUP, mime_types[i], NULL, NULL);
851 if (desktop_file_ids)
853 tweaks = desktop_file_dir_unindexed_get_tweaks (dir, mime_types[i]);
854 expand_strv (&tweaks->removals, desktop_file_ids, tweaks->additions);
858 g_strfreev (mime_types);
861 mime_types = g_key_file_get_keys (key_file, DEFAULT_APPLICATIONS_GROUP, NULL, NULL);
863 if (mime_types != NULL)
865 for (i = 0; mime_types[i] != NULL; i++)
867 desktop_file_ids = g_key_file_get_string_list (key_file, DEFAULT_APPLICATIONS_GROUP, mime_types[i], NULL, NULL);
869 if (desktop_file_ids)
871 tweaks = desktop_file_dir_unindexed_get_tweaks (dir, mime_types[i]);
872 expand_strv (&tweaks->defaults, desktop_file_ids, NULL);
876 g_strfreev (mime_types);
879 g_key_file_free (key_file);
883 desktop_file_dir_unindexed_read_mimeapps_lists (DesktopFileDir *dir)
885 const gchar * const *desktops;
889 dir->mime_tweaks = g_hash_table_new_full (g_str_hash, g_str_equal, g_free, free_mime_tweaks);
891 /* We process in order of precedence, using a blacklisting approach to
892 * avoid recording later instructions that conflict with ones we found
895 * We first start with the XDG_CURRENT_DESKTOP files, in precedence
898 desktops = get_lowercase_current_desktops ();
899 for (i = 0; desktops[i]; i++)
901 filename = g_strdup_printf ("%s/%s-mimeapps.list", dir->path, desktops[i]);
902 desktop_file_dir_unindexed_read_mimeapps_list (dir, filename, ADDED_ASSOCIATIONS_GROUP, FALSE);
906 /* Next, the non-desktop-specific mimeapps.list */
907 filename = g_strdup_printf ("%s/mimeapps.list", dir->path);
908 desktop_file_dir_unindexed_read_mimeapps_list (dir, filename, ADDED_ASSOCIATIONS_GROUP, TRUE);
911 /* The remaining files are only checked for in directories that might
912 * contain desktop files (ie: not the config dirs).
917 /* We have 'defaults.list' which was only ever understood by GLib. It
918 * exists widely, but it has never been part of any spec and it should
919 * be treated as deprecated. This will be removed in a future
922 filename = g_strdup_printf ("%s/defaults.list", dir->path);
923 desktop_file_dir_unindexed_read_mimeapps_list (dir, filename, ADDED_ASSOCIATIONS_GROUP, FALSE);
926 /* Finally, the mimeinfo.cache, which is just a cached copy of what we
927 * would find in the MimeTypes= lines of all of the desktop files.
929 filename = g_strdup_printf ("%s/mimeinfo.cache", dir->path);
930 desktop_file_dir_unindexed_read_mimeapps_list (dir, filename, MIME_CACHE_GROUP, TRUE);
935 desktop_file_dir_unindexed_init (DesktopFileDir *dir)
938 get_apps_from_dir (&dir->app_names, dir->path, "");
940 desktop_file_dir_unindexed_read_mimeapps_lists (dir);
943 static GDesktopAppInfo *
944 desktop_file_dir_unindexed_get_app (DesktopFileDir *dir,
945 const gchar *desktop_id)
947 const gchar *filename;
949 filename = g_hash_table_lookup (dir->app_names, desktop_id);
954 return g_desktop_app_info_new_from_filename (filename);
958 desktop_file_dir_unindexed_get_all (DesktopFileDir *dir,
965 if (dir->app_names == NULL)
968 g_hash_table_iter_init (&iter, dir->app_names);
969 while (g_hash_table_iter_next (&iter, &app_name, &filename))
971 if (desktop_file_dir_app_name_is_masked (dir, app_name))
974 add_to_table_if_appropriate (apps, app_name, g_desktop_app_info_new_from_filename (filename));
978 typedef struct _MemoryIndexEntry MemoryIndexEntry;
979 typedef GHashTable MemoryIndex;
981 struct _MemoryIndexEntry
983 const gchar *app_name; /* pointer to the hashtable key */
985 MemoryIndexEntry *next;
989 memory_index_entry_free (gpointer data)
991 MemoryIndexEntry *mie = data;
995 MemoryIndexEntry *next = mie->next;
997 g_slice_free (MemoryIndexEntry, mie);
1003 memory_index_add_token (MemoryIndex *mi,
1005 gint match_category,
1006 const gchar *app_name)
1008 MemoryIndexEntry *mie, *first;
1010 mie = g_slice_new (MemoryIndexEntry);
1011 mie->app_name = app_name;
1012 mie->match_category = match_category;
1014 first = g_hash_table_lookup (mi, token);
1018 mie->next = first->next;
1024 g_hash_table_insert (mi, g_strdup (token), mie);
1029 memory_index_add_string (MemoryIndex *mi,
1030 const gchar *string,
1031 gint match_category,
1032 const gchar *app_name)
1034 gchar **tokens, **alternates;
1037 tokens = g_str_tokenize_and_fold (string, NULL, &alternates);
1039 for (i = 0; tokens[i]; i++)
1040 memory_index_add_token (mi, tokens[i], match_category, app_name);
1042 for (i = 0; alternates[i]; i++)
1043 memory_index_add_token (mi, alternates[i], match_category, app_name);
1045 g_strfreev (alternates);
1046 g_strfreev (tokens);
1049 static MemoryIndex *
1050 memory_index_new (void)
1052 return g_hash_table_new_full (g_str_hash, g_str_equal, g_free, memory_index_entry_free);
1056 desktop_file_dir_unindexed_setup_search (DesktopFileDir *dir)
1058 GHashTableIter iter;
1061 dir->memory_index = memory_index_new ();
1062 dir->memory_implementations = memory_index_new ();
1064 /* Nothing to search? */
1065 if (dir->app_names == NULL)
1068 g_hash_table_iter_init (&iter, dir->app_names);
1069 while (g_hash_table_iter_next (&iter, &app, &path))
1073 if (desktop_file_dir_app_name_is_masked (dir, app))
1076 key_file = g_key_file_new ();
1078 if (g_key_file_load_from_file (key_file, path, G_KEY_FILE_NONE, NULL) &&
1079 !g_key_file_get_boolean (key_file, "Desktop Entry", "Hidden", NULL))
1081 /* Index the interesting keys... */
1085 for (i = 0; i < G_N_ELEMENTS (desktop_key_match_category); i++)
1090 if (!desktop_key_match_category[i])
1093 raw = g_key_file_get_locale_string (key_file, "Desktop Entry", desktop_key_get_name (i), NULL, NULL);
1096 if (i == DESKTOP_KEY_Exec && raw != NULL)
1098 /* Special handling: only match basename of first field */
1102 /* Remove extra arguments, if any */
1103 space = raw + strcspn (raw, " \t\n"); /* IFS */
1106 /* Skip the pathname, if any */
1107 if ((slash = strrchr (raw, '/')))
1110 /* Don't match on blacklisted binaries like interpreters */
1111 if (g_strv_contains (exec_key_match_blacklist, value))
1116 memory_index_add_string (dir->memory_index, value, desktop_key_match_category[i], app);
1121 /* Make note of the Implements= line */
1122 implements = g_key_file_get_string_list (key_file, "Desktop Entry", "Implements", NULL, NULL);
1123 for (i = 0; implements && implements[i]; i++)
1124 memory_index_add_token (dir->memory_implementations, implements[i], 0, app);
1125 g_strfreev (implements);
1128 g_key_file_free (key_file);
1133 desktop_file_dir_unindexed_search (DesktopFileDir *dir,
1134 const gchar *search_token)
1136 GHashTableIter iter;
1137 gpointer key, value;
1139 if (!dir->memory_index)
1140 desktop_file_dir_unindexed_setup_search (dir);
1142 g_hash_table_iter_init (&iter, dir->memory_index);
1143 while (g_hash_table_iter_next (&iter, &key, &value))
1145 MemoryIndexEntry *mie = value;
1147 if (!g_str_has_prefix (key, search_token))
1152 add_token_result (mie->app_name, mie->match_category);
1159 array_contains (GPtrArray *array,
1164 for (i = 0; i < array->len; i++)
1165 if (g_str_equal (array->pdata[i], str))
1172 desktop_file_dir_unindexed_mime_lookup (DesktopFileDir *dir,
1173 const gchar *mime_type,
1175 GPtrArray *blacklist)
1177 UnindexedMimeTweaks *tweaks;
1180 tweaks = g_hash_table_lookup (dir->mime_tweaks, mime_type);
1185 if (tweaks->additions)
1187 for (i = 0; tweaks->additions[i]; i++)
1189 gchar *app_name = tweaks->additions[i];
1191 if (!desktop_file_dir_app_name_is_masked (dir, app_name) &&
1192 !array_contains (blacklist, app_name) && !array_contains (hits, app_name))
1193 g_ptr_array_add (hits, app_name);
1197 if (tweaks->removals)
1199 for (i = 0; tweaks->removals[i]; i++)
1201 gchar *app_name = tweaks->removals[i];
1203 if (!desktop_file_dir_app_name_is_masked (dir, app_name) &&
1204 !array_contains (blacklist, app_name) && !array_contains (hits, app_name))
1205 g_ptr_array_add (blacklist, app_name);
1211 desktop_file_dir_unindexed_default_lookup (DesktopFileDir *dir,
1212 const gchar *mime_type,
1215 UnindexedMimeTweaks *tweaks;
1218 tweaks = g_hash_table_lookup (dir->mime_tweaks, mime_type);
1220 if (!tweaks || !tweaks->defaults)
1223 for (i = 0; tweaks->defaults[i]; i++)
1225 gchar *app_name = tweaks->defaults[i];
1227 if (!array_contains (results, app_name))
1228 g_ptr_array_add (results, app_name);
1233 desktop_file_dir_unindexed_get_implementations (DesktopFileDir *dir,
1235 const gchar *interface)
1237 MemoryIndexEntry *mie;
1239 if (!dir->memory_index)
1240 desktop_file_dir_unindexed_setup_search (dir);
1242 for (mie = g_hash_table_lookup (dir->memory_implementations, interface); mie; mie = mie->next)
1243 *results = g_list_prepend (*results, g_strdup (mie->app_name));
1246 /* DesktopFileDir "API" {{{2 */
1249 * desktop_file_dir_create:
1250 * @array: the #GArray to add a new item to
1251 * @data_dir: an XDG_DATA_DIR
1253 * Creates a #DesktopFileDir for the corresponding @data_dir, adding it
1257 desktop_file_dir_create (GArray *array,
1258 const gchar *data_dir)
1260 DesktopFileDir dir = { 0, };
1262 dir.path = g_build_filename (data_dir, "applications", NULL);
1264 g_array_append_val (array, dir);
1268 * desktop_file_dir_create:
1269 * @array: the #GArray to add a new item to
1270 * @config_dir: an XDG_CONFIG_DIR
1272 * Just the same as desktop_file_dir_create() except that it does not
1273 * add the "applications" directory. It also marks the directory as
1274 * config-only, which prevents us from attempting to find desktop files
1278 desktop_file_dir_create_for_config (GArray *array,
1279 const gchar *config_dir)
1281 DesktopFileDir dir = { 0, };
1283 dir.path = g_strdup (config_dir);
1284 dir.is_config = TRUE;
1286 g_array_append_val (array, dir);
1290 * desktop_file_dir_reset:
1291 * @dir: a #DesktopFileDir
1293 * Cleans up @dir, releasing most resources that it was using.
1296 desktop_file_dir_reset (DesktopFileDir *dir)
1298 if (dir->alternatively_watching)
1300 g_free (dir->alternatively_watching);
1301 dir->alternatively_watching = NULL;
1306 g_signal_handlers_disconnect_by_func (dir->monitor, desktop_file_dir_changed, dir);
1307 g_object_unref (dir->monitor);
1308 dir->monitor = NULL;
1313 g_hash_table_unref (dir->app_names);
1314 dir->app_names = NULL;
1317 if (dir->memory_index)
1319 g_hash_table_unref (dir->memory_index);
1320 dir->memory_index = NULL;
1323 if (dir->mime_tweaks)
1325 g_hash_table_unref (dir->mime_tweaks);
1326 dir->mime_tweaks = NULL;
1329 if (dir->memory_implementations)
1331 g_hash_table_unref (dir->memory_implementations);
1332 dir->memory_implementations = NULL;
1335 dir->is_setup = FALSE;
1339 * desktop_file_dir_init:
1340 * @dir: a #DesktopFileDir
1342 * Does initial setup for @dir
1344 * You should only call this if @dir is not already setup.
1347 desktop_file_dir_init (DesktopFileDir *dir)
1349 const gchar *watch_dir;
1351 g_assert (!dir->is_setup);
1353 g_assert (!dir->alternatively_watching);
1354 g_assert (!dir->monitor);
1356 dir->alternatively_watching = desktop_file_dir_get_alternative_dir (dir);
1357 watch_dir = dir->alternatively_watching ? dir->alternatively_watching : dir->path;
1359 /* There is a very thin race here if the watch_dir has been _removed_
1360 * between when we checked for it and when we establish the watch.
1361 * Removes probably don't happen in usual operation, and even if it
1362 * does (and we catch the unlikely race), the only degradation is that
1363 * we will fall back to polling.
1365 dir->monitor = g_local_file_monitor_new_in_worker (watch_dir, TRUE, G_FILE_MONITOR_NONE,
1366 desktop_file_dir_changed, dir, NULL);
1368 desktop_file_dir_unindexed_init (dir);
1370 dir->is_setup = TRUE;
1374 * desktop_file_dir_get_app:
1375 * @dir: a DesktopFileDir
1376 * @desktop_id: the desktop ID to load
1378 * Creates the #GDesktopAppInfo for the given @desktop_id if it exists
1379 * within @dir, even if it is hidden.
1381 * This function does not check if @desktop_id would be masked by a
1382 * directory with higher precedence. The caller must do so.
1384 static GDesktopAppInfo *
1385 desktop_file_dir_get_app (DesktopFileDir *dir,
1386 const gchar *desktop_id)
1388 if (!dir->app_names)
1391 return desktop_file_dir_unindexed_get_app (dir, desktop_id);
1395 * desktop_file_dir_get_all:
1396 * @dir: a DesktopFileDir
1397 * @apps: a #GHashTable<string, GDesktopAppInfo>
1399 * Loads all desktop files in @dir and adds them to @apps, careful to
1400 * ensure we don't add any files masked by a similarly-named file in a
1401 * higher-precedence directory.
1404 desktop_file_dir_get_all (DesktopFileDir *dir,
1407 desktop_file_dir_unindexed_get_all (dir, apps);
1411 * desktop_file_dir_mime_lookup:
1412 * @dir: a #DesktopFileDir
1413 * @mime_type: the mime type to look up
1414 * @hits: the array to store the hits
1415 * @blacklist: the array to store the blacklist
1417 * Does a lookup of a mimetype against one desktop file directory,
1418 * recording any hits and blacklisting and "Removed" associations (so
1419 * later directories don't record them as hits).
1421 * The items added to @hits are duplicated, but the ones in @blacklist
1422 * are weak pointers. This facilitates simply freeing the blacklist
1423 * (which is only used for internal bookkeeping) but using the pdata of
1424 * @hits as the result of the operation.
1427 desktop_file_dir_mime_lookup (DesktopFileDir *dir,
1428 const gchar *mime_type,
1430 GPtrArray *blacklist)
1432 desktop_file_dir_unindexed_mime_lookup (dir, mime_type, hits, blacklist);
1436 * desktop_file_dir_default_lookup:
1437 * @dir: a #DesktopFileDir
1438 * @mime_type: the mime type to look up
1439 * @results: an array to store the results in
1441 * Collects the "default" applications for a given mime type from @dir.
1444 desktop_file_dir_default_lookup (DesktopFileDir *dir,
1445 const gchar *mime_type,
1448 desktop_file_dir_unindexed_default_lookup (dir, mime_type, results);
1452 * desktop_file_dir_search:
1453 * @dir: a #DesktopFileDir
1454 * @term: a normalised and casefolded search term
1456 * Finds the names of applications in @dir that match @term.
1459 desktop_file_dir_search (DesktopFileDir *dir,
1460 const gchar *search_token)
1462 desktop_file_dir_unindexed_search (dir, search_token);
1466 desktop_file_dir_get_implementations (DesktopFileDir *dir,
1468 const gchar *interface)
1470 desktop_file_dir_unindexed_get_implementations (dir, results, interface);
1473 /* Lock/unlock and global setup API {{{2 */
1476 desktop_file_dirs_lock (void)
1480 g_mutex_lock (&desktop_file_dir_lock);
1482 if (desktop_file_dirs == NULL)
1484 const char * const *dirs;
1488 tmp = g_array_new (FALSE, FALSE, sizeof (DesktopFileDir));
1490 /* First, the configs. Highest priority: the user's ~/.config */
1491 desktop_file_dir_create_for_config (tmp, g_get_user_config_dir ());
1493 /* Next, the system configs (/etc/xdg, and so on). */
1494 dirs = g_get_system_config_dirs ();
1495 for (i = 0; dirs[i]; i++)
1496 desktop_file_dir_create_for_config (tmp, dirs[i]);
1498 /* Now the data. Highest priority: the user's ~/.local/share/applications */
1499 desktop_file_dir_user_data_index = tmp->len;
1500 desktop_file_dir_create (tmp, g_get_user_data_dir ());
1502 /* Following that, XDG_DATA_DIRS/applications, in order */
1503 dirs = g_get_system_data_dirs ();
1504 for (i = 0; dirs[i]; i++)
1505 desktop_file_dir_create (tmp, dirs[i]);
1507 /* The list of directories will never change after this. */
1508 desktop_file_dirs = (DesktopFileDir *) tmp->data;
1509 n_desktop_file_dirs = tmp->len;
1511 g_array_free (tmp, FALSE);
1514 for (i = 0; i < n_desktop_file_dirs; i++)
1515 if (!desktop_file_dirs[i].is_setup)
1516 desktop_file_dir_init (&desktop_file_dirs[i]);
1520 desktop_file_dirs_unlock (void)
1522 g_mutex_unlock (&desktop_file_dir_lock);
1526 desktop_file_dirs_invalidate_user_config (void)
1528 g_mutex_lock (&desktop_file_dir_lock);
1530 if (n_desktop_file_dirs)
1531 desktop_file_dir_reset (&desktop_file_dirs[desktop_file_dir_user_config_index]);
1533 g_mutex_unlock (&desktop_file_dir_lock);
1537 desktop_file_dirs_invalidate_user_data (void)
1539 g_mutex_lock (&desktop_file_dir_lock);
1541 if (n_desktop_file_dirs)
1542 desktop_file_dir_reset (&desktop_file_dirs[desktop_file_dir_user_data_index]);
1544 g_mutex_unlock (&desktop_file_dir_lock);
1547 /* GDesktopAppInfo implementation {{{1 */
1548 /* GObject implementation {{{2 */
1550 g_desktop_app_info_finalize (GObject *object)
1552 GDesktopAppInfo *info;
1554 info = G_DESKTOP_APP_INFO (object);
1556 g_free (info->desktop_id);
1557 g_free (info->filename);
1560 g_key_file_unref (info->keyfile);
1562 g_free (info->name);
1563 g_free (info->generic_name);
1564 g_free (info->fullname);
1565 g_free (info->comment);
1566 g_free (info->icon_name);
1568 g_object_unref (info->icon);
1569 g_strfreev (info->keywords);
1570 g_strfreev (info->only_show_in);
1571 g_strfreev (info->not_show_in);
1572 g_free (info->try_exec);
1573 g_free (info->exec);
1574 g_free (info->binary);
1575 g_free (info->path);
1576 g_free (info->categories);
1577 g_free (info->startup_wm_class);
1578 g_strfreev (info->mime_types);
1579 g_free (info->app_id);
1580 g_strfreev (info->actions);
1582 G_OBJECT_CLASS (g_desktop_app_info_parent_class)->finalize (object);
1586 g_desktop_app_info_set_property (GObject *object,
1588 const GValue *value,
1591 GDesktopAppInfo *self = G_DESKTOP_APP_INFO (object);
1596 self->filename = g_value_dup_string (value);
1600 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
1606 g_desktop_app_info_get_property (GObject *object,
1611 GDesktopAppInfo *self = G_DESKTOP_APP_INFO (object);
1616 g_value_set_string (value, self->filename);
1619 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
1625 g_desktop_app_info_class_init (GDesktopAppInfoClass *klass)
1627 GObjectClass *gobject_class = G_OBJECT_CLASS (klass);
1629 gobject_class->get_property = g_desktop_app_info_get_property;
1630 gobject_class->set_property = g_desktop_app_info_set_property;
1631 gobject_class->finalize = g_desktop_app_info_finalize;
1634 * GDesktopAppInfo:filename:
1636 * The origin filename of this #GDesktopAppInfo
1638 g_object_class_install_property (gobject_class,
1640 g_param_spec_string ("filename", "Filename", "", NULL,
1641 G_PARAM_READWRITE | G_PARAM_CONSTRUCT_ONLY));
1645 g_desktop_app_info_init (GDesktopAppInfo *local)
1649 /* Construction... {{{2 */
1653 * @exec: an exec line
1655 * Returns the first word in an exec line (ie: the binary name).
1657 * If @exec is " progname --foo %F" then returns "progname".
1660 binary_from_exec (const char *exec)
1662 const char *p, *start;
1668 while (*p != ' ' && *p != 0)
1671 return g_strndup (start, p - start);
1675 g_desktop_app_info_load_from_keyfile (GDesktopAppInfo *info,
1682 gboolean bus_activatable;
1684 start_group = g_key_file_get_start_group (key_file);
1685 if (start_group == NULL || strcmp (start_group, G_KEY_FILE_DESKTOP_GROUP) != 0)
1687 g_free (start_group);
1690 g_free (start_group);
1692 type = g_key_file_get_string (key_file,
1693 G_KEY_FILE_DESKTOP_GROUP,
1694 G_KEY_FILE_DESKTOP_KEY_TYPE,
1696 if (type == NULL || strcmp (type, G_KEY_FILE_DESKTOP_TYPE_APPLICATION) != 0)
1703 try_exec = g_key_file_get_string (key_file,
1704 G_KEY_FILE_DESKTOP_GROUP,
1705 G_KEY_FILE_DESKTOP_KEY_TRY_EXEC,
1707 if (try_exec && try_exec[0] != '\0')
1710 t = g_find_program_in_path (try_exec);
1719 exec = g_key_file_get_string (key_file,
1720 G_KEY_FILE_DESKTOP_GROUP,
1721 G_KEY_FILE_DESKTOP_KEY_EXEC,
1723 if (exec && exec[0] != '\0')
1727 if (!g_shell_parse_argv (exec, &argc, &argv, NULL))
1736 t = g_find_program_in_path (argv[0]);
1749 info->name = g_key_file_get_locale_string (key_file, G_KEY_FILE_DESKTOP_GROUP, G_KEY_FILE_DESKTOP_KEY_NAME, NULL, NULL);
1750 info->generic_name = g_key_file_get_locale_string (key_file, G_KEY_FILE_DESKTOP_GROUP, GENERIC_NAME_KEY, NULL, NULL);
1751 info->fullname = g_key_file_get_locale_string (key_file, G_KEY_FILE_DESKTOP_GROUP, FULL_NAME_KEY, NULL, NULL);
1752 info->keywords = g_key_file_get_locale_string_list (key_file, G_KEY_FILE_DESKTOP_GROUP, KEYWORDS_KEY, NULL, NULL, NULL);
1753 info->comment = g_key_file_get_locale_string (key_file, G_KEY_FILE_DESKTOP_GROUP, G_KEY_FILE_DESKTOP_KEY_COMMENT, NULL, NULL);
1754 info->nodisplay = g_key_file_get_boolean (key_file, G_KEY_FILE_DESKTOP_GROUP, G_KEY_FILE_DESKTOP_KEY_NO_DISPLAY, NULL) != FALSE;
1755 info->icon_name = g_key_file_get_locale_string (key_file, G_KEY_FILE_DESKTOP_GROUP, G_KEY_FILE_DESKTOP_KEY_ICON, NULL, NULL);
1756 info->only_show_in = g_key_file_get_string_list (key_file, G_KEY_FILE_DESKTOP_GROUP, G_KEY_FILE_DESKTOP_KEY_ONLY_SHOW_IN, NULL, NULL);
1757 info->not_show_in = g_key_file_get_string_list (key_file, G_KEY_FILE_DESKTOP_GROUP, G_KEY_FILE_DESKTOP_KEY_NOT_SHOW_IN, NULL, NULL);
1758 info->try_exec = try_exec;
1760 info->path = g_key_file_get_string (key_file, G_KEY_FILE_DESKTOP_GROUP, G_KEY_FILE_DESKTOP_KEY_PATH, NULL);
1761 info->terminal = g_key_file_get_boolean (key_file, G_KEY_FILE_DESKTOP_GROUP, G_KEY_FILE_DESKTOP_KEY_TERMINAL, NULL) != FALSE;
1762 info->startup_notify = g_key_file_get_boolean (key_file, G_KEY_FILE_DESKTOP_GROUP, G_KEY_FILE_DESKTOP_KEY_STARTUP_NOTIFY, NULL) != FALSE;
1763 info->no_fuse = g_key_file_get_boolean (key_file, G_KEY_FILE_DESKTOP_GROUP, "X-GIO-NoFuse", NULL) != FALSE;
1764 info->hidden = g_key_file_get_boolean (key_file, G_KEY_FILE_DESKTOP_GROUP, G_KEY_FILE_DESKTOP_KEY_HIDDEN, NULL) != FALSE;
1765 info->categories = g_key_file_get_string (key_file, G_KEY_FILE_DESKTOP_GROUP, G_KEY_FILE_DESKTOP_KEY_CATEGORIES, NULL);
1766 info->startup_wm_class = g_key_file_get_string (key_file, G_KEY_FILE_DESKTOP_GROUP, STARTUP_WM_CLASS_KEY, NULL);
1767 info->mime_types = g_key_file_get_string_list (key_file, G_KEY_FILE_DESKTOP_GROUP, G_KEY_FILE_DESKTOP_KEY_MIME_TYPE, NULL, NULL);
1768 bus_activatable = g_key_file_get_boolean (key_file, G_KEY_FILE_DESKTOP_GROUP, G_KEY_FILE_DESKTOP_KEY_DBUS_ACTIVATABLE, NULL);
1769 info->actions = g_key_file_get_string_list (key_file, G_KEY_FILE_DESKTOP_GROUP, G_KEY_FILE_DESKTOP_KEY_ACTIONS, NULL, NULL);
1771 /* Remove the special-case: no Actions= key just means 0 extra actions */
1772 if (info->actions == NULL)
1773 info->actions = g_new0 (gchar *, 0 + 1);
1776 if (info->icon_name)
1778 if (g_path_is_absolute (info->icon_name))
1782 file = g_file_new_for_path (info->icon_name);
1783 info->icon = g_file_icon_new (file);
1784 g_object_unref (file);
1790 /* Work around a common mistake in desktop files */
1791 if ((p = strrchr (info->icon_name, '.')) != NULL &&
1792 (strcmp (p, ".png") == 0 ||
1793 strcmp (p, ".xpm") == 0 ||
1794 strcmp (p, ".svg") == 0))
1797 info->icon = g_themed_icon_new (info->icon_name);
1802 info->binary = binary_from_exec (info->exec);
1804 if (info->path && info->path[0] == '\0')
1806 g_free (info->path);
1810 /* Can only be DBusActivatable if we know the filename, which means
1811 * that this won't work for the load-from-keyfile case.
1813 if (bus_activatable && info->filename)
1818 basename = g_path_get_basename (info->filename);
1819 last_dot = strrchr (basename, '.');
1821 if (last_dot && g_str_equal (last_dot, ".desktop"))
1825 if (g_dbus_is_name (basename) && basename[0] != ':')
1826 info->app_id = g_strdup (basename);
1832 info->keyfile = g_key_file_ref (key_file);
1838 g_desktop_app_info_load_file (GDesktopAppInfo *self)
1841 gboolean retval = FALSE;
1843 g_return_val_if_fail (self->filename != NULL, FALSE);
1845 self->desktop_id = g_path_get_basename (self->filename);
1847 key_file = g_key_file_new ();
1849 if (g_key_file_load_from_file (key_file, self->filename, G_KEY_FILE_NONE, NULL))
1850 retval = g_desktop_app_info_load_from_keyfile (self, key_file);
1852 g_key_file_unref (key_file);
1857 * g_desktop_app_info_new_from_keyfile:
1858 * @key_file: an opened #GKeyFile
1860 * Creates a new #GDesktopAppInfo.
1862 * Returns: (nullable): a new #GDesktopAppInfo or %NULL on error.
1867 g_desktop_app_info_new_from_keyfile (GKeyFile *key_file)
1869 GDesktopAppInfo *info;
1871 info = g_object_new (G_TYPE_DESKTOP_APP_INFO, NULL);
1872 info->filename = NULL;
1873 if (!g_desktop_app_info_load_from_keyfile (info, key_file))
1875 g_object_unref (info);
1882 * g_desktop_app_info_new_from_filename:
1883 * @filename: (type filename): the path of a desktop file, in the GLib
1886 * Creates a new #GDesktopAppInfo.
1888 * Returns: (nullable): a new #GDesktopAppInfo or %NULL on error.
1891 g_desktop_app_info_new_from_filename (const char *filename)
1893 GDesktopAppInfo *info = NULL;
1895 info = g_object_new (G_TYPE_DESKTOP_APP_INFO, "filename", filename, NULL);
1896 if (!g_desktop_app_info_load_file (info))
1898 g_object_unref (info);
1905 * g_desktop_app_info_new:
1906 * @desktop_id: the desktop file id
1908 * Creates a new #GDesktopAppInfo based on a desktop file id.
1910 * A desktop file id is the basename of the desktop file, including the
1911 * .desktop extension. GIO is looking for a desktop file with this name
1912 * in the `applications` subdirectories of the XDG
1913 * data directories (i.e. the directories specified in the `XDG_DATA_HOME`
1914 * and `XDG_DATA_DIRS` environment variables). GIO also supports the
1915 * prefix-to-subdirectory mapping that is described in the
1916 * [Menu Spec](http://standards.freedesktop.org/menu-spec/latest/)
1917 * (i.e. a desktop id of kde-foo.desktop will match
1918 * `/usr/share/applications/kde/foo.desktop`).
1920 * Returns: (nullable): a new #GDesktopAppInfo, or %NULL if no desktop
1921 * file with that id exists.
1924 g_desktop_app_info_new (const char *desktop_id)
1926 GDesktopAppInfo *appinfo = NULL;
1929 desktop_file_dirs_lock ();
1931 for (i = 0; i < n_desktop_file_dirs; i++)
1933 appinfo = desktop_file_dir_get_app (&desktop_file_dirs[i], desktop_id);
1939 desktop_file_dirs_unlock ();
1941 if (appinfo == NULL)
1944 g_free (appinfo->desktop_id);
1945 appinfo->desktop_id = g_strdup (desktop_id);
1947 if (g_desktop_app_info_get_is_hidden (appinfo))
1949 g_object_unref (appinfo);
1957 g_desktop_app_info_dup (GAppInfo *appinfo)
1959 GDesktopAppInfo *info = G_DESKTOP_APP_INFO (appinfo);
1960 GDesktopAppInfo *new_info;
1962 new_info = g_object_new (G_TYPE_DESKTOP_APP_INFO, NULL);
1964 new_info->filename = g_strdup (info->filename);
1965 new_info->desktop_id = g_strdup (info->desktop_id);
1968 new_info->keyfile = g_key_file_ref (info->keyfile);
1970 new_info->name = g_strdup (info->name);
1971 new_info->generic_name = g_strdup (info->generic_name);
1972 new_info->fullname = g_strdup (info->fullname);
1973 new_info->keywords = g_strdupv (info->keywords);
1974 new_info->comment = g_strdup (info->comment);
1975 new_info->nodisplay = info->nodisplay;
1976 new_info->icon_name = g_strdup (info->icon_name);
1978 new_info->icon = g_object_ref (info->icon);
1979 new_info->only_show_in = g_strdupv (info->only_show_in);
1980 new_info->not_show_in = g_strdupv (info->not_show_in);
1981 new_info->try_exec = g_strdup (info->try_exec);
1982 new_info->exec = g_strdup (info->exec);
1983 new_info->binary = g_strdup (info->binary);
1984 new_info->path = g_strdup (info->path);
1985 new_info->app_id = g_strdup (info->app_id);
1986 new_info->hidden = info->hidden;
1987 new_info->terminal = info->terminal;
1988 new_info->startup_notify = info->startup_notify;
1990 return G_APP_INFO (new_info);
1993 /* GAppInfo interface implementation functions {{{2 */
1996 g_desktop_app_info_equal (GAppInfo *appinfo1,
1999 GDesktopAppInfo *info1 = G_DESKTOP_APP_INFO (appinfo1);
2000 GDesktopAppInfo *info2 = G_DESKTOP_APP_INFO (appinfo2);
2002 if (info1->desktop_id == NULL ||
2003 info2->desktop_id == NULL)
2004 return info1 == info2;
2006 return strcmp (info1->desktop_id, info2->desktop_id) == 0;
2010 g_desktop_app_info_get_id (GAppInfo *appinfo)
2012 GDesktopAppInfo *info = G_DESKTOP_APP_INFO (appinfo);
2014 return info->desktop_id;
2018 g_desktop_app_info_get_name (GAppInfo *appinfo)
2020 GDesktopAppInfo *info = G_DESKTOP_APP_INFO (appinfo);
2022 if (info->name == NULL)
2023 return _("Unnamed");
2028 g_desktop_app_info_get_display_name (GAppInfo *appinfo)
2030 GDesktopAppInfo *info = G_DESKTOP_APP_INFO (appinfo);
2032 if (info->fullname == NULL)
2033 return g_desktop_app_info_get_name (appinfo);
2034 return info->fullname;
2038 * g_desktop_app_info_get_is_hidden:
2039 * @info: a #GDesktopAppInfo.
2041 * A desktop file is hidden if the Hidden key in it is
2044 * Returns: %TRUE if hidden, %FALSE otherwise.
2047 g_desktop_app_info_get_is_hidden (GDesktopAppInfo *info)
2049 return info->hidden;
2053 * g_desktop_app_info_get_filename:
2054 * @info: a #GDesktopAppInfo
2056 * When @info was created from a known filename, return it. In some
2057 * situations such as the #GDesktopAppInfo returned from
2058 * g_desktop_app_info_new_from_keyfile(), this function will return %NULL.
2060 * Returns: (type filename): The full path to the file for @info,
2061 * or %NULL if not known.
2065 g_desktop_app_info_get_filename (GDesktopAppInfo *info)
2067 return info->filename;
2071 g_desktop_app_info_get_description (GAppInfo *appinfo)
2073 GDesktopAppInfo *info = G_DESKTOP_APP_INFO (appinfo);
2075 return info->comment;
2079 g_desktop_app_info_get_executable (GAppInfo *appinfo)
2081 GDesktopAppInfo *info = G_DESKTOP_APP_INFO (appinfo);
2083 return info->binary;
2087 g_desktop_app_info_get_commandline (GAppInfo *appinfo)
2089 GDesktopAppInfo *info = G_DESKTOP_APP_INFO (appinfo);
2095 g_desktop_app_info_get_icon (GAppInfo *appinfo)
2097 GDesktopAppInfo *info = G_DESKTOP_APP_INFO (appinfo);
2103 * g_desktop_app_info_get_categories:
2104 * @info: a #GDesktopAppInfo
2106 * Gets the categories from the desktop file.
2108 * Returns: The unparsed Categories key from the desktop file;
2109 * i.e. no attempt is made to split it by ';' or validate it.
2112 g_desktop_app_info_get_categories (GDesktopAppInfo *info)
2114 return info->categories;
2118 * g_desktop_app_info_get_keywords:
2119 * @info: a #GDesktopAppInfo
2121 * Gets the keywords from the desktop file.
2123 * Returns: (transfer none): The value of the Keywords key
2127 const char * const *
2128 g_desktop_app_info_get_keywords (GDesktopAppInfo *info)
2130 return (const char * const *)info->keywords;
2134 * g_desktop_app_info_get_generic_name:
2135 * @info: a #GDesktopAppInfo
2137 * Gets the generic name from the destkop file.
2139 * Returns: The value of the GenericName key
2142 g_desktop_app_info_get_generic_name (GDesktopAppInfo *info)
2144 return info->generic_name;
2148 * g_desktop_app_info_get_nodisplay:
2149 * @info: a #GDesktopAppInfo
2151 * Gets the value of the NoDisplay key, which helps determine if the
2152 * application info should be shown in menus. See
2153 * #G_KEY_FILE_DESKTOP_KEY_NO_DISPLAY and g_app_info_should_show().
2155 * Returns: The value of the NoDisplay key
2160 g_desktop_app_info_get_nodisplay (GDesktopAppInfo *info)
2162 return info->nodisplay;
2166 * g_desktop_app_info_get_show_in:
2167 * @info: a #GDesktopAppInfo
2168 * @desktop_env: (nullable): a string specifying a desktop name
2170 * Checks if the application info should be shown in menus that list available
2171 * applications for a specific name of the desktop, based on the
2172 * `OnlyShowIn` and `NotShowIn` keys.
2174 * @desktop_env should typically be given as %NULL, in which case the
2175 * `XDG_CURRENT_DESKTOP` environment variable is consulted. If you want
2176 * to override the default mechanism then you may specify @desktop_env,
2177 * but this is not recommended.
2179 * Note that g_app_info_should_show() for @info will include this check (with
2180 * %NULL for @desktop_env) as well as additional checks.
2182 * Returns: %TRUE if the @info should be shown in @desktop_env according to the
2183 * `OnlyShowIn` and `NotShowIn` keys, %FALSE
2189 g_desktop_app_info_get_show_in (GDesktopAppInfo *info,
2190 const gchar *desktop_env)
2192 const gchar *specified_envs[] = { desktop_env, NULL };
2193 const gchar * const *envs;
2196 g_return_val_if_fail (G_IS_DESKTOP_APP_INFO (info), FALSE);
2199 envs = specified_envs;
2201 envs = get_current_desktops (NULL);
2203 for (i = 0; envs[i]; i++)
2207 if (info->only_show_in)
2208 for (j = 0; info->only_show_in[j]; j++)
2209 if (g_str_equal (info->only_show_in[j], envs[i]))
2212 if (info->not_show_in)
2213 for (j = 0; info->not_show_in[j]; j++)
2214 if (g_str_equal (info->not_show_in[j], envs[i]))
2218 return info->only_show_in == NULL;
2221 /* Launching... {{{2 */
2224 expand_macro_single (char macro, const char *uri)
2227 char *result = NULL;
2231 file = g_file_new_for_uri (uri);
2237 result = g_shell_quote (uri);
2241 path = g_file_get_path (file);
2243 result = g_shell_quote (path);
2247 path = g_file_get_path (file);
2250 name = g_path_get_dirname (path);
2251 result = g_shell_quote (name);
2257 path = g_file_get_path (file);
2260 name = g_path_get_basename (path);
2261 result = g_shell_quote (name);
2267 g_object_unref (file);
2274 expand_macro_uri (char macro, const char *uri, gboolean force_file_uri, char force_file_uri_macro)
2276 char *expanded = NULL;
2278 g_return_val_if_fail (uri != NULL, NULL);
2280 if (!force_file_uri ||
2281 /* Pass URI if it contains an anchor */
2282 strchr (uri, '#') != NULL)
2284 expanded = expand_macro_single (macro, uri);
2288 expanded = expand_macro_single (force_file_uri_macro, uri);
2289 if (expanded == NULL)
2290 expanded = expand_macro_single (macro, uri);
2297 expand_macro (char macro,
2299 GDesktopAppInfo *info,
2302 GList *uris = *uri_list;
2303 char *expanded = NULL;
2304 gboolean force_file_uri;
2305 char force_file_uri_macro;
2308 g_return_if_fail (exec != NULL);
2310 /* On %u and %U, pass POSIX file path pointing to the URI via
2311 * the FUSE mount in ~/.gvfs. Note that if the FUSE daemon isn't
2312 * running or the URI doesn't have a POSIX file path via FUSE
2313 * we'll just pass the URI.
2315 force_file_uri_macro = macro;
2316 force_file_uri = FALSE;
2322 force_file_uri_macro = 'f';
2323 force_file_uri = TRUE;
2326 force_file_uri_macro = 'F';
2327 force_file_uri = TRUE;
2343 expanded = expand_macro_uri (macro, uri,
2344 force_file_uri, force_file_uri_macro);
2347 g_string_append (exec, expanded);
2362 expanded = expand_macro_uri (macro, uri,
2363 force_file_uri, force_file_uri_macro);
2366 g_string_append (exec, expanded);
2372 if (uris != NULL && expanded)
2373 g_string_append_c (exec, ' ');
2379 if (info->icon_name)
2381 g_string_append (exec, "--icon ");
2382 expanded = g_shell_quote (info->icon_name);
2383 g_string_append (exec, expanded);
2391 expanded = g_shell_quote (info->name);
2392 g_string_append (exec, expanded);
2400 expanded = g_shell_quote (info->filename);
2401 g_string_append (exec, expanded);
2406 case 'm': /* deprecated */
2410 g_string_append_c (exec, '%');
2418 expand_application_parameters (GDesktopAppInfo *info,
2419 const gchar *exec_line,
2425 GList *uri_list = *uris;
2426 const char *p = exec_line;
2427 GString *expanded_exec;
2430 if (exec_line == NULL)
2432 g_set_error_literal (error, G_IO_ERROR, G_IO_ERROR_FAILED,
2433 _("Desktop file didn’t specify Exec field"));
2437 expanded_exec = g_string_new (NULL);
2441 if (p[0] == '%' && p[1] != '\0')
2443 expand_macro (p[1], expanded_exec, info, uris);
2447 g_string_append_c (expanded_exec, *p);
2452 /* No file substitutions */
2453 if (uri_list == *uris && uri_list != NULL)
2455 /* If there is no macro default to %f. This is also what KDE does */
2456 g_string_append_c (expanded_exec, ' ');
2457 expand_macro ('f', expanded_exec, info, uris);
2460 res = g_shell_parse_argv (expanded_exec->str, argc, argv, error);
2461 g_string_free (expanded_exec, TRUE);
2466 prepend_terminal_to_vector (int *argc,
2473 char **term_argv = NULL;
2478 g_return_val_if_fail (argc != NULL, FALSE);
2479 g_return_val_if_fail (argv != NULL, FALSE);
2487 /* compute size if not given */
2490 for (i = 0; the_argv[i] != NULL; i++)
2496 term_argv = g_new0 (char *, 3);
2498 check = g_find_program_in_path ("gnome-terminal");
2501 term_argv[0] = check;
2502 /* Note that gnome-terminal takes -x and
2503 * as -e in gnome-terminal is broken we use that. */
2504 term_argv[1] = g_strdup ("-x");
2509 check = g_find_program_in_path ("nxterm");
2511 check = g_find_program_in_path ("color-xterm");
2513 check = g_find_program_in_path ("rxvt");
2515 check = g_find_program_in_path ("dtterm");
2518 check = g_strdup ("xterm");
2519 g_debug ("Couldn’t find a terminal: falling back to xterm");
2521 term_argv[0] = check;
2522 term_argv[1] = g_strdup ("-e");
2525 real_argc = term_argc + *argc;
2526 real_argv = g_new (char *, real_argc + 1);
2528 for (i = 0; i < term_argc; i++)
2529 real_argv[i] = term_argv[i];
2531 for (j = 0; j < *argc; j++, i++)
2532 real_argv[i] = (char *)the_argv[j];
2534 real_argv[i] = NULL;
2540 /* we use g_free here as we sucked all the inner strings
2541 * out from it into real_argv */
2546 #endif /* G_OS_WIN32 */
2550 create_files_for_uris (GList *uris)
2557 for (iter = uris; iter; iter = iter->next)
2559 GFile *file = g_file_new_for_uri ((char *)iter->data);
2560 res = g_list_prepend (res, file);
2563 return g_list_reverse (res);
2567 notify_desktop_launch (GDBusConnection *session_bus,
2568 GDesktopAppInfo *info,
2570 const char *display,
2575 GVariantBuilder uri_variant;
2576 GVariantBuilder extras_variant;
2578 const char *desktop_file_id;
2579 const char *gio_desktop_file;
2581 if (session_bus == NULL)
2584 g_variant_builder_init (&uri_variant, G_VARIANT_TYPE ("as"));
2585 for (iter = uris; iter; iter = iter->next)
2586 g_variant_builder_add (&uri_variant, "s", iter->data);
2588 g_variant_builder_init (&extras_variant, G_VARIANT_TYPE ("a{sv}"));
2589 if (sn_id != NULL && g_utf8_validate (sn_id, -1, NULL))
2590 g_variant_builder_add (&extras_variant, "{sv}",
2594 gio_desktop_file = g_getenv ("GIO_LAUNCHED_DESKTOP_FILE");
2595 if (gio_desktop_file != NULL)
2596 g_variant_builder_add (&extras_variant, "{sv}",
2597 "origin-desktop-file",
2598 g_variant_new_bytestring (gio_desktop_file));
2599 if (g_get_prgname () != NULL)
2600 g_variant_builder_add (&extras_variant, "{sv}",
2602 g_variant_new_bytestring (g_get_prgname ()));
2603 g_variant_builder_add (&extras_variant, "{sv}",
2606 (gint64)getpid ()));
2609 desktop_file_id = info->filename;
2610 else if (info->desktop_id)
2611 desktop_file_id = info->desktop_id;
2613 desktop_file_id = "";
2615 msg = g_dbus_message_new_signal ("/org/gtk/gio/DesktopAppInfo",
2616 "org.gtk.gio.DesktopAppInfo",
2618 g_dbus_message_set_body (msg, g_variant_new ("(@aysxasa{sv})",
2619 g_variant_new_bytestring (desktop_file_id),
2620 display ? display : "",
2624 g_dbus_connection_send_message (session_bus,
2628 g_object_unref (msg);
2631 #define _SPAWN_FLAGS_DEFAULT (G_SPAWN_SEARCH_PATH)
2634 g_desktop_app_info_launch_uris_with_spawn (GDesktopAppInfo *info,
2635 GDBusConnection *session_bus,
2636 const gchar *exec_line,
2638 GAppLaunchContext *launch_context,
2639 GSpawnFlags spawn_flags,
2640 GSpawnChildSetupFunc user_setup,
2641 gpointer user_setup_data,
2642 GDesktopAppLaunchCallback pid_callback,
2643 gpointer pid_callback_data,
2649 gboolean completed = FALSE;
2653 char **argv, **envp;
2656 g_return_val_if_fail (info != NULL, FALSE);
2661 envp = g_app_launch_context_get_environment (launch_context);
2663 envp = g_get_environ ();
2665 /* The GList* passed to expand_application_parameters() will be modified
2666 * internally by expand_macro(), so we need to pass a copy of it instead,
2667 * and also use that copy to control the exit condition of the loop below.
2669 dup_uris = g_list_copy (uris);
2673 GList *launched_uris;
2676 char **wrapped_argv;
2679 old_uris = dup_uris;
2680 if (!expand_application_parameters (info, exec_line, &dup_uris, &argc, &argv, error))
2683 /* Get the subset of URIs we're launching with this process */
2684 launched_uris = NULL;
2685 for (iter = old_uris; iter != NULL && iter != dup_uris; iter = iter->next)
2686 launched_uris = g_list_prepend (launched_uris, iter->data);
2687 launched_uris = g_list_reverse (launched_uris);
2689 if (info->terminal && !prepend_terminal_to_vector (&argc, &argv))
2691 g_set_error_literal (error, G_IO_ERROR, G_IO_ERROR_FAILED,
2692 _("Unable to find terminal required for application"));
2697 envp = g_environ_setenv (envp,
2698 "GIO_LAUNCHED_DESKTOP_FILE",
2705 GList *launched_files = create_files_for_uris (launched_uris);
2707 if (info->startup_notify)
2709 sn_id = g_app_launch_context_get_startup_notify_id (launch_context,
2713 envp = g_environ_setenv (envp, "DESKTOP_STARTUP_ID", sn_id, TRUE);
2716 g_list_free_full (launched_files, g_object_unref);
2719 if (g_once_init_enter (&gio_launch_desktop_path))
2723 /* Allow test suite to specify path to gio-launch-desktop */
2724 tmp = g_getenv ("GIO_LAUNCH_DESKTOP");
2726 /* Fall back on usual searching in $PATH */
2728 tmp = "gio-launch-desktop";
2729 g_once_init_leave (&gio_launch_desktop_path, tmp);
2732 wrapped_argv = g_new (char *, argc + 2);
2733 wrapped_argv[0] = g_strdup (gio_launch_desktop_path);
2735 for (i = 0; i < argc; i++)
2736 wrapped_argv[i + 1] = g_steal_pointer (&argv[i]);
2738 wrapped_argv[i + 1] = NULL;
2742 if (!g_spawn_async_with_fds (info->path,
2755 g_app_launch_context_launch_failed (launch_context, sn_id);
2758 g_list_free (launched_uris);
2763 if (pid_callback != NULL)
2764 pid_callback (info, pid, pid_callback_data);
2766 if (launch_context != NULL)
2768 GVariantBuilder builder;
2769 GVariant *platform_data;
2771 g_variant_builder_init (&builder, G_VARIANT_TYPE_ARRAY);
2772 g_variant_builder_add (&builder, "{sv}", "pid", g_variant_new_int32 (pid));
2774 g_variant_builder_add (&builder, "{sv}", "startup-notification-id", g_variant_new_string (sn_id));
2775 platform_data = g_variant_ref_sink (g_variant_builder_end (&builder));
2776 g_signal_emit_by_name (launch_context, "launched", info, platform_data);
2777 g_variant_unref (platform_data);
2780 notify_desktop_launch (session_bus,
2788 g_list_free (launched_uris);
2790 g_strfreev (wrapped_argv);
2791 wrapped_argv = NULL;
2793 while (dup_uris != NULL);
2798 g_list_free (dup_uris);
2806 object_path_from_appid (const gchar *appid)
2808 gchar *appid_path, *iter;
2810 appid_path = g_strconcat ("/", appid, NULL);
2811 for (iter = appid_path; *iter; iter++)
2824 g_desktop_app_info_make_platform_data (GDesktopAppInfo *info,
2826 GAppLaunchContext *launch_context)
2828 GVariantBuilder builder;
2830 g_variant_builder_init (&builder, G_VARIANT_TYPE_VARDICT);
2834 GList *launched_files = create_files_for_uris (uris);
2836 if (info->startup_notify)
2840 sn_id = g_app_launch_context_get_startup_notify_id (launch_context, G_APP_INFO (info), launched_files);
2842 g_variant_builder_add (&builder, "{sv}", "desktop-startup-id", g_variant_new_take_string (sn_id));
2845 g_list_free_full (launched_files, g_object_unref);
2848 return g_variant_builder_end (&builder);
2852 launch_uris_with_dbus (GDesktopAppInfo *info,
2853 GDBusConnection *session_bus,
2855 GAppLaunchContext *launch_context)
2857 GVariantBuilder builder;
2860 g_variant_builder_init (&builder, G_VARIANT_TYPE_TUPLE);
2866 g_variant_builder_open (&builder, G_VARIANT_TYPE_STRING_ARRAY);
2867 for (iter = uris; iter; iter = iter->next)
2868 g_variant_builder_add (&builder, "s", iter->data);
2869 g_variant_builder_close (&builder);
2872 g_variant_builder_add_value (&builder, g_desktop_app_info_make_platform_data (info, uris, launch_context));
2874 /* This is non-blocking API. Similar to launching via fork()/exec()
2875 * we don't wait around to see if the program crashed during startup.
2876 * This is what startup-notification's job is...
2878 object_path = object_path_from_appid (info->app_id);
2879 g_dbus_connection_call (session_bus, info->app_id, object_path, "org.freedesktop.Application",
2880 uris ? "Open" : "Activate", g_variant_builder_end (&builder),
2881 NULL, G_DBUS_CALL_FLAGS_NONE, -1, NULL, NULL, NULL);
2882 g_free (object_path);
2886 g_desktop_app_info_launch_uris_with_dbus (GDesktopAppInfo *info,
2887 GDBusConnection *session_bus,
2889 GAppLaunchContext *launch_context)
2891 GList *ruris = uris;
2892 char *app_id = NULL;
2894 g_return_val_if_fail (info != NULL, FALSE);
2897 app_id = g_desktop_app_info_get_string (info, "X-Flatpak");
2898 if (app_id && *app_id)
2900 ruris = g_document_portal_add_documents (uris, app_id, NULL);
2906 launch_uris_with_dbus (info, session_bus, ruris, launch_context);
2909 g_list_free_full (ruris, g_free);
2917 g_desktop_app_info_launch_uris_internal (GAppInfo *appinfo,
2919 GAppLaunchContext *launch_context,
2920 GSpawnFlags spawn_flags,
2921 GSpawnChildSetupFunc user_setup,
2922 gpointer user_setup_data,
2923 GDesktopAppLaunchCallback pid_callback,
2924 gpointer pid_callback_data,
2930 GDesktopAppInfo *info = G_DESKTOP_APP_INFO (appinfo);
2931 GDBusConnection *session_bus;
2932 gboolean success = TRUE;
2934 session_bus = g_bus_get_sync (G_BUS_TYPE_SESSION, NULL, NULL);
2936 if (session_bus && info->app_id)
2937 g_desktop_app_info_launch_uris_with_dbus (info, session_bus, uris, launch_context);
2939 success = g_desktop_app_info_launch_uris_with_spawn (info, session_bus, info->exec, uris, launch_context,
2940 spawn_flags, user_setup, user_setup_data,
2941 pid_callback, pid_callback_data,
2942 stdin_fd, stdout_fd, stderr_fd, error);
2944 if (session_bus != NULL)
2946 /* This asynchronous flush holds a reference until it completes,
2947 * which ensures that the following unref won't immediately kill
2948 * the connection if we were the initial owner.
2950 g_dbus_connection_flush (session_bus, NULL, NULL, NULL);
2951 g_object_unref (session_bus);
2958 g_desktop_app_info_launch_uris (GAppInfo *appinfo,
2960 GAppLaunchContext *launch_context,
2963 return g_desktop_app_info_launch_uris_internal (appinfo, uris,
2965 _SPAWN_FLAGS_DEFAULT,
2966 NULL, NULL, NULL, NULL,
2972 g_desktop_app_info_supports_uris (GAppInfo *appinfo)
2974 GDesktopAppInfo *info = G_DESKTOP_APP_INFO (appinfo);
2976 return info->exec &&
2977 ((strstr (info->exec, "%u") != NULL) ||
2978 (strstr (info->exec, "%U") != NULL));
2982 g_desktop_app_info_supports_files (GAppInfo *appinfo)
2984 GDesktopAppInfo *info = G_DESKTOP_APP_INFO (appinfo);
2986 return info->exec &&
2987 ((strstr (info->exec, "%f") != NULL) ||
2988 (strstr (info->exec, "%F") != NULL));
2992 g_desktop_app_info_launch (GAppInfo *appinfo,
2994 GAppLaunchContext *launch_context,
3004 uri = g_file_get_uri (files->data);
3005 uris = g_list_prepend (uris, uri);
3006 files = files->next;
3009 uris = g_list_reverse (uris);
3011 res = g_desktop_app_info_launch_uris (appinfo, uris, launch_context, error);
3013 g_list_free_full (uris, g_free);
3019 * g_desktop_app_info_launch_uris_as_manager_with_fds:
3020 * @appinfo: a #GDesktopAppInfo
3021 * @uris: (element-type utf8): List of URIs
3022 * @launch_context: (nullable): a #GAppLaunchContext
3023 * @spawn_flags: #GSpawnFlags, used for each process
3024 * @user_setup: (scope async) (nullable): a #GSpawnChildSetupFunc, used once
3026 * @user_setup_data: (closure user_setup) (nullable): User data for @user_setup
3027 * @pid_callback: (scope call) (nullable): Callback for child processes
3028 * @pid_callback_data: (closure pid_callback) (nullable): User data for @callback
3029 * @stdin_fd: file descriptor to use for child's stdin, or -1
3030 * @stdout_fd: file descriptor to use for child's stdout, or -1
3031 * @stderr_fd: file descriptor to use for child's stderr, or -1
3032 * @error: return location for a #GError, or %NULL
3034 * Equivalent to g_desktop_app_info_launch_uris_as_manager() but allows
3035 * you to pass in file descriptors for the stdin, stdout and stderr streams
3036 * of the launched process.
3038 * If application launching occurs via some non-spawn mechanism (e.g. D-Bus
3039 * activation) then @stdin_fd, @stdout_fd and @stderr_fd are ignored.
3041 * Returns: %TRUE on successful launch, %FALSE otherwise.
3046 g_desktop_app_info_launch_uris_as_manager_with_fds (GDesktopAppInfo *appinfo,
3048 GAppLaunchContext *launch_context,
3049 GSpawnFlags spawn_flags,
3050 GSpawnChildSetupFunc user_setup,
3051 gpointer user_setup_data,
3052 GDesktopAppLaunchCallback pid_callback,
3053 gpointer pid_callback_data,
3059 return g_desktop_app_info_launch_uris_internal ((GAppInfo*)appinfo,
3074 * g_desktop_app_info_launch_uris_as_manager:
3075 * @appinfo: a #GDesktopAppInfo
3076 * @uris: (element-type utf8): List of URIs
3077 * @launch_context: (nullable): a #GAppLaunchContext
3078 * @spawn_flags: #GSpawnFlags, used for each process
3079 * @user_setup: (scope async) (nullable): a #GSpawnChildSetupFunc, used once
3081 * @user_setup_data: (closure user_setup) (nullable): User data for @user_setup
3082 * @pid_callback: (scope call) (nullable): Callback for child processes
3083 * @pid_callback_data: (closure pid_callback) (nullable): User data for @callback
3084 * @error: return location for a #GError, or %NULL
3086 * This function performs the equivalent of g_app_info_launch_uris(),
3087 * but is intended primarily for operating system components that
3088 * launch applications. Ordinary applications should use
3089 * g_app_info_launch_uris().
3091 * If the application is launched via GSpawn, then @spawn_flags, @user_setup
3092 * and @user_setup_data are used for the call to g_spawn_async().
3093 * Additionally, @pid_callback (with @pid_callback_data) will be called to
3094 * inform about the PID of the created process. See g_spawn_async_with_pipes()
3095 * for information on certain parameter conditions that can enable an
3096 * optimized posix_spawn() codepath to be used.
3098 * If application launching occurs via some other mechanism (eg: D-Bus
3099 * activation) then @spawn_flags, @user_setup, @user_setup_data,
3100 * @pid_callback and @pid_callback_data are ignored.
3102 * Returns: %TRUE on successful launch, %FALSE otherwise.
3105 g_desktop_app_info_launch_uris_as_manager (GDesktopAppInfo *appinfo,
3107 GAppLaunchContext *launch_context,
3108 GSpawnFlags spawn_flags,
3109 GSpawnChildSetupFunc user_setup,
3110 gpointer user_setup_data,
3111 GDesktopAppLaunchCallback pid_callback,
3112 gpointer pid_callback_data,
3115 return g_desktop_app_info_launch_uris_as_manager_with_fds (appinfo,
3127 /* OnlyShowIn API support {{{2 */
3130 * g_desktop_app_info_set_desktop_env:
3131 * @desktop_env: a string specifying what desktop this is
3133 * Sets the name of the desktop that the application is running in.
3134 * This is used by g_app_info_should_show() and
3135 * g_desktop_app_info_get_show_in() to evaluate the
3136 * `OnlyShowIn` and `NotShowIn`
3137 * desktop entry fields.
3139 * Should be called only once; subsequent calls are ignored.
3141 * Deprecated:2.42:do not use this API. Since 2.42 the value of the
3142 * `XDG_CURRENT_DESKTOP` environment variable will be used.
3145 g_desktop_app_info_set_desktop_env (const gchar *desktop_env)
3147 get_current_desktops (desktop_env);
3151 g_desktop_app_info_should_show (GAppInfo *appinfo)
3153 GDesktopAppInfo *info = G_DESKTOP_APP_INFO (appinfo);
3155 if (info->nodisplay)
3158 return g_desktop_app_info_get_show_in (info, NULL);
3161 /* mime types/default apps support {{{2 */
3170 ensure_dir (DirType type,
3173 char *path, *display_name;
3179 path = g_build_filename (g_get_user_config_dir (), NULL);
3183 path = g_build_filename (g_get_user_data_dir (), "applications", NULL);
3187 path = g_build_filename (g_get_user_data_dir (), "mime", "packages", NULL);
3191 g_assert_not_reached ();
3195 if (g_mkdir_with_parents (path, 0700) == 0)
3199 display_name = g_filename_display_name (path);
3200 if (type == APP_DIR)
3201 g_set_error (error, G_IO_ERROR, g_io_error_from_errno (errsv),
3202 _("Can’t create user application configuration folder %s: %s"),
3203 display_name, g_strerror (errsv));
3205 g_set_error (error, G_IO_ERROR, g_io_error_from_errno (errsv),
3206 _("Can’t create user MIME configuration folder %s: %s"),
3207 display_name, g_strerror (errsv));
3209 g_free (display_name);
3216 update_mimeapps_list (const char *desktop_id,
3217 const char *content_type,
3218 UpdateMimeFlags flags,
3221 char *dirname, *filename, *string;
3223 gboolean load_succeeded, res;
3224 char **old_list, **list;
3225 gsize length, data_size;
3228 char **content_types;
3230 /* Don't add both at start and end */
3231 g_assert (!((flags & UPDATE_MIME_SET_DEFAULT) &&
3232 (flags & UPDATE_MIME_SET_NON_DEFAULT)));
3234 dirname = ensure_dir (CONF_DIR, error);
3238 filename = g_build_filename (dirname, "mimeapps.list", NULL);
3241 key_file = g_key_file_new ();
3242 load_succeeded = g_key_file_load_from_file (key_file, filename, G_KEY_FILE_NONE, NULL);
3243 if (!load_succeeded ||
3244 (!g_key_file_has_group (key_file, ADDED_ASSOCIATIONS_GROUP) &&
3245 !g_key_file_has_group (key_file, REMOVED_ASSOCIATIONS_GROUP) &&
3246 !g_key_file_has_group (key_file, DEFAULT_APPLICATIONS_GROUP)))
3248 g_key_file_free (key_file);
3249 key_file = g_key_file_new ();
3254 content_types = g_new (char *, 2);
3255 content_types[0] = g_strdup (content_type);
3256 content_types[1] = NULL;
3260 content_types = g_key_file_get_keys (key_file, DEFAULT_APPLICATIONS_GROUP, NULL, NULL);
3263 for (k = 0; content_types && content_types[k]; k++)
3265 /* set as default, if requested so */
3266 string = g_key_file_get_string (key_file,
3267 DEFAULT_APPLICATIONS_GROUP,
3271 if (g_strcmp0 (string, desktop_id) != 0 &&
3272 (flags & UPDATE_MIME_SET_DEFAULT))
3275 string = g_strdup (desktop_id);
3277 /* add in the non-default list too, if it's not already there */
3278 flags |= UPDATE_MIME_SET_NON_DEFAULT;
3281 if (string == NULL || desktop_id == NULL)
3282 g_key_file_remove_key (key_file,
3283 DEFAULT_APPLICATIONS_GROUP,
3287 g_key_file_set_string (key_file,
3288 DEFAULT_APPLICATIONS_GROUP,
3297 /* reuse the list from above */
3301 g_strfreev (content_types);
3302 content_types = g_key_file_get_keys (key_file, ADDED_ASSOCIATIONS_GROUP, NULL, NULL);
3305 for (k = 0; content_types && content_types[k]; k++)
3307 /* Add to the right place in the list */
3310 old_list = g_key_file_get_string_list (key_file, ADDED_ASSOCIATIONS_GROUP,
3311 content_types[k], &length, NULL);
3313 list = g_new (char *, 1 + length + 1);
3317 /* if we're adding a last-used hint, just put the application in front of the list */
3318 if (flags & UPDATE_MIME_SET_LAST_USED)
3320 /* avoid adding this again as non-default later */
3321 if (flags & UPDATE_MIME_SET_NON_DEFAULT)
3322 flags ^= UPDATE_MIME_SET_NON_DEFAULT;
3324 list[i++] = g_strdup (desktop_id);
3329 for (j = 0; old_list[j] != NULL; j++)
3331 if (g_strcmp0 (old_list[j], desktop_id) != 0)
3333 /* rewrite other entries if they're different from the new one */
3334 list[i++] = g_strdup (old_list[j]);
3336 else if (flags & UPDATE_MIME_SET_NON_DEFAULT)
3338 /* we encountered an old entry which is equal to the one we're adding as non-default,
3339 * don't change its position in the list.
3341 flags ^= UPDATE_MIME_SET_NON_DEFAULT;
3342 list[i++] = g_strdup (old_list[j]);
3347 /* add it at the end of the list */
3348 if (flags & UPDATE_MIME_SET_NON_DEFAULT)
3349 list[i++] = g_strdup (desktop_id);
3353 g_strfreev (old_list);
3355 if (list[0] == NULL || desktop_id == NULL)
3356 g_key_file_remove_key (key_file,
3357 ADDED_ASSOCIATIONS_GROUP,
3361 g_key_file_set_string_list (key_file,
3362 ADDED_ASSOCIATIONS_GROUP,
3364 (const char * const *)list, i);
3371 /* reuse the list from above */
3375 g_strfreev (content_types);
3376 content_types = g_key_file_get_keys (key_file, REMOVED_ASSOCIATIONS_GROUP, NULL, NULL);
3379 for (k = 0; content_types && content_types[k]; k++)
3381 /* Remove from removed associations group (unless remove) */
3384 old_list = g_key_file_get_string_list (key_file, REMOVED_ASSOCIATIONS_GROUP,
3385 content_types[k], &length, NULL);
3387 list = g_new (char *, 1 + length + 1);
3390 if (flags & UPDATE_MIME_REMOVE)
3391 list[i++] = g_strdup (desktop_id);
3394 for (j = 0; old_list[j] != NULL; j++)
3396 if (g_strcmp0 (old_list[j], desktop_id) != 0)
3397 list[i++] = g_strdup (old_list[j]);
3402 g_strfreev (old_list);
3404 if (list[0] == NULL || desktop_id == NULL)
3405 g_key_file_remove_key (key_file,
3406 REMOVED_ASSOCIATIONS_GROUP,
3410 g_key_file_set_string_list (key_file,
3411 REMOVED_ASSOCIATIONS_GROUP,
3413 (const char * const *)list, i);
3418 g_strfreev (content_types);
3420 data = g_key_file_to_data (key_file, &data_size, error);
3421 g_key_file_free (key_file);
3423 res = g_file_set_contents (filename, data, data_size, error);
3425 desktop_file_dirs_invalidate_user_config ();
3434 g_desktop_app_info_set_as_last_used_for_type (GAppInfo *appinfo,
3435 const char *content_type,
3438 GDesktopAppInfo *info = G_DESKTOP_APP_INFO (appinfo);
3440 if (!g_desktop_app_info_ensure_saved (info, error))
3443 if (!info->desktop_id)
3445 g_set_error_literal (error, G_IO_ERROR, G_IO_ERROR_FAILED,
3446 _("Application information lacks an identifier"));
3450 /* both add support for the content type and set as last used */
3451 return update_mimeapps_list (info->desktop_id, content_type,
3452 UPDATE_MIME_SET_NON_DEFAULT |
3453 UPDATE_MIME_SET_LAST_USED,
3458 g_desktop_app_info_set_as_default_for_type (GAppInfo *appinfo,
3459 const char *content_type,
3462 GDesktopAppInfo *info = G_DESKTOP_APP_INFO (appinfo);
3464 if (!g_desktop_app_info_ensure_saved (info, error))
3467 if (!info->desktop_id)
3469 g_set_error_literal (error, G_IO_ERROR, G_IO_ERROR_FAILED,
3470 _("Application information lacks an identifier"));
3474 return update_mimeapps_list (info->desktop_id, content_type,
3475 UPDATE_MIME_SET_DEFAULT,
3480 update_program_done (GPid pid,
3484 /* Did the application exit correctly */
3485 if (g_spawn_check_exit_status (status, NULL))
3487 /* Here we could clean out any caches in use */
3492 run_update_command (char *command,
3501 GError *error = NULL;
3504 argv[1] = g_build_filename (g_get_user_data_dir (), subdir, NULL);
3506 if (g_spawn_async ("/", argv,
3508 G_SPAWN_SEARCH_PATH |
3509 G_SPAWN_STDOUT_TO_DEV_NULL |
3510 G_SPAWN_STDERR_TO_DEV_NULL |
3511 G_SPAWN_DO_NOT_REAP_CHILD,
3512 NULL, NULL, /* No setup function */
3515 g_child_watch_add (pid, update_program_done, NULL);
3518 /* If we get an error at this point, it's quite likely the user doesn't
3519 * have an installed copy of either 'update-mime-database' or
3520 * 'update-desktop-database'. I don't think we want to popup an error
3521 * dialog at this point, so we just do a g_warning to give the user a
3522 * chance of debugging it.
3524 g_warning ("%s", error->message);
3525 g_error_free (error);
3532 g_desktop_app_info_set_as_default_for_extension (GAppInfo *appinfo,
3533 const char *extension,
3536 char *filename, *basename, *mimetype;
3540 if (!g_desktop_app_info_ensure_saved (G_DESKTOP_APP_INFO (appinfo), error))
3543 dirname = ensure_dir (MIMETYPE_DIR, error);
3547 basename = g_strdup_printf ("user-extension-%s.xml", extension);
3548 filename = g_build_filename (dirname, basename, NULL);
3552 mimetype = g_strdup_printf ("application/x-extension-%s", extension);
3554 if (!g_file_test (filename, G_FILE_TEST_EXISTS))
3559 g_strdup_printf ("<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n"
3560 "<mime-info xmlns=\"http://www.freedesktop.org/standards/shared-mime-info\">\n"
3561 " <mime-type type=\"%s\">\n"
3562 " <comment>%s document</comment>\n"
3563 " <glob pattern=\"*.%s\"/>\n"
3565 "</mime-info>\n", mimetype, extension, extension);
3567 g_file_set_contents (filename, contents, -1, NULL);
3570 run_update_command ("update-mime-database", "mime");
3574 res = g_desktop_app_info_set_as_default_for_type (appinfo,
3584 g_desktop_app_info_add_supports_type (GAppInfo *appinfo,
3585 const char *content_type,
3588 GDesktopAppInfo *info = G_DESKTOP_APP_INFO (appinfo);
3590 if (!g_desktop_app_info_ensure_saved (G_DESKTOP_APP_INFO (info), error))
3593 return update_mimeapps_list (info->desktop_id, content_type,
3594 UPDATE_MIME_SET_NON_DEFAULT,
3599 g_desktop_app_info_can_remove_supports_type (GAppInfo *appinfo)
3605 g_desktop_app_info_remove_supports_type (GAppInfo *appinfo,
3606 const char *content_type,
3609 GDesktopAppInfo *info = G_DESKTOP_APP_INFO (appinfo);
3611 if (!g_desktop_app_info_ensure_saved (G_DESKTOP_APP_INFO (info), error))
3614 return update_mimeapps_list (info->desktop_id, content_type,
3619 static const char **
3620 g_desktop_app_info_get_supported_types (GAppInfo *appinfo)
3622 GDesktopAppInfo *info = G_DESKTOP_APP_INFO (appinfo);
3624 return (const char**) info->mime_types;
3627 /* Saving and deleting {{{2 */
3630 g_desktop_app_info_ensure_saved (GDesktopAppInfo *info,
3636 char *data, *desktop_id;
3641 if (info->filename != NULL)
3644 /* This is only used for object created with
3645 * g_app_info_create_from_commandline. All other
3646 * object should have a filename
3649 dirname = ensure_dir (APP_DIR, error);
3653 key_file = g_key_file_new ();
3655 g_key_file_set_string (key_file, G_KEY_FILE_DESKTOP_GROUP,
3656 "Encoding", "UTF-8");
3657 g_key_file_set_string (key_file, G_KEY_FILE_DESKTOP_GROUP,
3658 G_KEY_FILE_DESKTOP_KEY_VERSION, "1.0");
3659 g_key_file_set_string (key_file, G_KEY_FILE_DESKTOP_GROUP,
3660 G_KEY_FILE_DESKTOP_KEY_TYPE,
3661 G_KEY_FILE_DESKTOP_TYPE_APPLICATION);
3663 g_key_file_set_boolean (key_file, G_KEY_FILE_DESKTOP_GROUP,
3664 G_KEY_FILE_DESKTOP_KEY_TERMINAL, TRUE);
3665 if (info->nodisplay)
3666 g_key_file_set_boolean (key_file, G_KEY_FILE_DESKTOP_GROUP,
3667 G_KEY_FILE_DESKTOP_KEY_NO_DISPLAY, TRUE);
3669 g_key_file_set_string (key_file, G_KEY_FILE_DESKTOP_GROUP,
3670 G_KEY_FILE_DESKTOP_KEY_EXEC, info->exec);
3672 g_key_file_set_string (key_file, G_KEY_FILE_DESKTOP_GROUP,
3673 G_KEY_FILE_DESKTOP_KEY_NAME, info->name);
3675 if (info->generic_name != NULL)
3676 g_key_file_set_string (key_file, G_KEY_FILE_DESKTOP_GROUP,
3677 GENERIC_NAME_KEY, info->generic_name);
3679 if (info->fullname != NULL)
3680 g_key_file_set_string (key_file, G_KEY_FILE_DESKTOP_GROUP,
3681 FULL_NAME_KEY, info->fullname);
3683 g_key_file_set_string (key_file, G_KEY_FILE_DESKTOP_GROUP,
3684 G_KEY_FILE_DESKTOP_KEY_COMMENT, info->comment);
3686 g_key_file_set_boolean (key_file, G_KEY_FILE_DESKTOP_GROUP,
3687 G_KEY_FILE_DESKTOP_KEY_NO_DISPLAY, TRUE);
3689 data = g_key_file_to_data (key_file, &data_size, NULL);
3690 g_key_file_free (key_file);
3692 desktop_id = g_strdup_printf ("userapp-%s-XXXXXX.desktop", info->name);
3693 filename = g_build_filename (dirname, desktop_id, NULL);
3694 g_free (desktop_id);
3697 fd = g_mkstemp (filename);
3702 display_name = g_filename_display_name (filename);
3703 g_set_error (error, G_IO_ERROR, G_IO_ERROR_FAILED,
3704 _("Can’t create user desktop file %s"), display_name);
3705 g_free (display_name);
3711 desktop_id = g_path_get_basename (filename);
3713 /* FIXME - actually handle error */
3714 (void) g_close (fd, NULL);
3716 res = g_file_set_contents (filename, data, data_size, error);
3720 g_free (desktop_id);
3725 info->filename = filename;
3726 info->desktop_id = desktop_id;
3728 run_update_command ("update-desktop-database", "applications");
3730 /* We just dropped a file in the user's desktop file directory. Save
3731 * the monitor the bother of having to notice it and invalidate
3734 * This means that calls directly following this will be able to see
3735 * the results immediately.
3737 desktop_file_dirs_invalidate_user_data ();
3743 g_desktop_app_info_can_delete (GAppInfo *appinfo)
3745 GDesktopAppInfo *info = G_DESKTOP_APP_INFO (appinfo);
3749 if (strstr (info->filename, "/userapp-"))
3750 return g_access (info->filename, W_OK) == 0;
3757 g_desktop_app_info_delete (GAppInfo *appinfo)
3759 GDesktopAppInfo *info = G_DESKTOP_APP_INFO (appinfo);
3763 if (g_remove (info->filename) == 0)
3765 update_mimeapps_list (info->desktop_id, NULL,
3769 g_free (info->filename);
3770 info->filename = NULL;
3771 g_free (info->desktop_id);
3772 info->desktop_id = NULL;
3781 /* Create for commandline {{{2 */
3783 * g_app_info_create_from_commandline:
3784 * @commandline: (type filename): the commandline to use
3785 * @application_name: (nullable): the application name, or %NULL to use @commandline
3786 * @flags: flags that can specify details of the created #GAppInfo
3787 * @error: a #GError location to store the error occurring, %NULL to ignore.
3789 * Creates a new #GAppInfo from the given information.
3791 * Note that for @commandline, the quoting rules of the Exec key of the
3792 * [freedesktop.org Desktop Entry Specification](http://freedesktop.org/Standards/desktop-entry-spec)
3793 * are applied. For example, if the @commandline contains
3794 * percent-encoded URIs, the percent-character must be doubled in order to prevent it from
3795 * being swallowed by Exec key unquoting. See the specification for exact quoting rules.
3797 * Returns: (transfer full): new #GAppInfo for given command.
3800 g_app_info_create_from_commandline (const char *commandline,
3801 const char *application_name,
3802 GAppInfoCreateFlags flags,
3807 GDesktopAppInfo *info;
3809 g_return_val_if_fail (commandline, NULL);
3811 info = g_object_new (G_TYPE_DESKTOP_APP_INFO, NULL);
3813 info->filename = NULL;
3814 info->desktop_id = NULL;
3816 info->terminal = (flags & G_APP_INFO_CREATE_NEEDS_TERMINAL) != 0;
3817 info->startup_notify = (flags & G_APP_INFO_CREATE_SUPPORTS_STARTUP_NOTIFICATION) != 0;
3818 info->hidden = FALSE;
3819 if ((flags & G_APP_INFO_CREATE_SUPPORTS_URIS) != 0)
3820 info->exec = g_strconcat (commandline, " %u", NULL);
3822 info->exec = g_strconcat (commandline, " %f", NULL);
3823 info->nodisplay = TRUE;
3824 info->binary = binary_from_exec (info->exec);
3826 if (application_name)
3827 info->name = g_strdup (application_name);
3830 /* FIXME: this should be more robust. Maybe g_shell_parse_argv and use argv[0] */
3831 split = g_strsplit (commandline, " ", 2);
3832 basename = split[0] ? g_path_get_basename (split[0]) : NULL;
3834 info->name = basename;
3835 if (info->name == NULL)
3836 info->name = g_strdup ("custom");
3838 info->comment = g_strdup_printf (_("Custom definition for %s"), info->name);
3840 return G_APP_INFO (info);
3843 /* GAppInfo interface init */
3846 g_desktop_app_info_iface_init (GAppInfoIface *iface)
3848 iface->dup = g_desktop_app_info_dup;
3849 iface->equal = g_desktop_app_info_equal;
3850 iface->get_id = g_desktop_app_info_get_id;
3851 iface->get_name = g_desktop_app_info_get_name;
3852 iface->get_description = g_desktop_app_info_get_description;
3853 iface->get_executable = g_desktop_app_info_get_executable;
3854 iface->get_icon = g_desktop_app_info_get_icon;
3855 iface->launch = g_desktop_app_info_launch;
3856 iface->supports_uris = g_desktop_app_info_supports_uris;
3857 iface->supports_files = g_desktop_app_info_supports_files;
3858 iface->launch_uris = g_desktop_app_info_launch_uris;
3859 iface->should_show = g_desktop_app_info_should_show;
3860 iface->set_as_default_for_type = g_desktop_app_info_set_as_default_for_type;
3861 iface->set_as_default_for_extension = g_desktop_app_info_set_as_default_for_extension;
3862 iface->add_supports_type = g_desktop_app_info_add_supports_type;
3863 iface->can_remove_supports_type = g_desktop_app_info_can_remove_supports_type;
3864 iface->remove_supports_type = g_desktop_app_info_remove_supports_type;
3865 iface->can_delete = g_desktop_app_info_can_delete;
3866 iface->do_delete = g_desktop_app_info_delete;
3867 iface->get_commandline = g_desktop_app_info_get_commandline;
3868 iface->get_display_name = g_desktop_app_info_get_display_name;
3869 iface->set_as_last_used_for_type = g_desktop_app_info_set_as_last_used_for_type;
3870 iface->get_supported_types = g_desktop_app_info_get_supported_types;
3873 /* Recommended applications {{{2 */
3875 /* Converts content_type into a list of itself with all of its parent
3876 * types (if include_fallback is enabled) or just returns a single-item
3877 * list with the unaliased content type.
3880 get_list_of_mimetypes (const gchar *content_type,
3881 gboolean include_fallback)
3886 array = g_ptr_array_new ();
3887 unaliased = _g_unix_content_type_unalias (content_type);
3888 g_ptr_array_add (array, unaliased);
3890 if (include_fallback)
3894 /* Iterate the array as we grow it, until we have nothing more to add */
3895 for (i = 0; i < array->len; i++)
3897 gchar **parents = _g_unix_content_type_get_parents (g_ptr_array_index (array, i));
3900 for (j = 0; parents[j]; j++)
3901 /* Don't add duplicates */
3902 if (!array_contains (array, parents[j]))
3903 g_ptr_array_add (array, parents[j]);
3905 g_free (parents[j]);
3907 /* We already stole or freed each element. Free the container. */
3912 g_ptr_array_add (array, NULL);
3914 return (gchar **) g_ptr_array_free (array, FALSE);
3918 g_desktop_app_info_get_desktop_ids_for_content_type (const gchar *content_type,
3919 gboolean include_fallback)
3921 GPtrArray *hits, *blacklist;
3925 hits = g_ptr_array_new ();
3926 blacklist = g_ptr_array_new ();
3928 types = get_list_of_mimetypes (content_type, include_fallback);
3930 desktop_file_dirs_lock ();
3932 for (i = 0; types[i]; i++)
3933 for (j = 0; j < n_desktop_file_dirs; j++)
3934 desktop_file_dir_mime_lookup (&desktop_file_dirs[j], types[i], hits, blacklist);
3936 /* We will keep the hits past unlocking, so we must dup them */
3937 for (i = 0; i < hits->len; i++)
3938 hits->pdata[i] = g_strdup (hits->pdata[i]);
3940 desktop_file_dirs_unlock ();
3942 g_ptr_array_add (hits, NULL);
3944 g_ptr_array_free (blacklist, TRUE);
3947 return (gchar **) g_ptr_array_free (hits, FALSE);
3951 * g_app_info_get_recommended_for_type:
3952 * @content_type: the content type to find a #GAppInfo for
3954 * Gets a list of recommended #GAppInfos for a given content type, i.e.
3955 * those applications which claim to support the given content type exactly,
3956 * and not by MIME type subclassing.
3957 * Note that the first application of the list is the last used one, i.e.
3958 * the last one for which g_app_info_set_as_last_used_for_type() has been
3961 * Returns: (element-type GAppInfo) (transfer full): #GList of #GAppInfos
3962 * for given @content_type or %NULL on error.
3967 g_app_info_get_recommended_for_type (const gchar *content_type)
3969 gchar **desktop_ids;
3973 g_return_val_if_fail (content_type != NULL, NULL);
3975 desktop_ids = g_desktop_app_info_get_desktop_ids_for_content_type (content_type, FALSE);
3978 for (i = 0; desktop_ids[i]; i++)
3980 GDesktopAppInfo *info;
3982 info = g_desktop_app_info_new (desktop_ids[i]);
3984 infos = g_list_prepend (infos, info);
3987 g_strfreev (desktop_ids);
3989 return g_list_reverse (infos);
3993 * g_app_info_get_fallback_for_type:
3994 * @content_type: the content type to find a #GAppInfo for
3996 * Gets a list of fallback #GAppInfos for a given content type, i.e.
3997 * those applications which claim to support the given content type
3998 * by MIME type subclassing and not directly.
4000 * Returns: (element-type GAppInfo) (transfer full): #GList of #GAppInfos
4001 * for given @content_type or %NULL on error.
4006 g_app_info_get_fallback_for_type (const gchar *content_type)
4008 gchar **recommended_ids;
4013 g_return_val_if_fail (content_type != NULL, NULL);
4015 recommended_ids = g_desktop_app_info_get_desktop_ids_for_content_type (content_type, FALSE);
4016 all_ids = g_desktop_app_info_get_desktop_ids_for_content_type (content_type, TRUE);
4019 for (i = 0; all_ids[i]; i++)
4021 GDesktopAppInfo *info;
4024 /* Don't return the ones on the recommended list */
4025 for (j = 0; recommended_ids[j]; j++)
4026 if (g_str_equal (all_ids[i], recommended_ids[j]))
4029 if (recommended_ids[j])
4032 info = g_desktop_app_info_new (all_ids[i]);
4035 infos = g_list_prepend (infos, info);
4038 g_strfreev (recommended_ids);
4039 g_strfreev (all_ids);
4041 return g_list_reverse (infos);
4045 * g_app_info_get_all_for_type:
4046 * @content_type: the content type to find a #GAppInfo for
4048 * Gets a list of all #GAppInfos for a given content type,
4049 * including the recommended and fallback #GAppInfos. See
4050 * g_app_info_get_recommended_for_type() and
4051 * g_app_info_get_fallback_for_type().
4053 * Returns: (element-type GAppInfo) (transfer full): #GList of #GAppInfos
4054 * for given @content_type or %NULL on error.
4057 g_app_info_get_all_for_type (const char *content_type)
4059 gchar **desktop_ids;
4063 g_return_val_if_fail (content_type != NULL, NULL);
4065 desktop_ids = g_desktop_app_info_get_desktop_ids_for_content_type (content_type, TRUE);
4068 for (i = 0; desktop_ids[i]; i++)
4070 GDesktopAppInfo *info;
4072 info = g_desktop_app_info_new (desktop_ids[i]);
4074 infos = g_list_prepend (infos, info);
4077 g_strfreev (desktop_ids);
4079 return g_list_reverse (infos);
4083 * g_app_info_reset_type_associations:
4084 * @content_type: a content type
4086 * Removes all changes to the type associations done by
4087 * g_app_info_set_as_default_for_type(),
4088 * g_app_info_set_as_default_for_extension(),
4089 * g_app_info_add_supports_type() or
4090 * g_app_info_remove_supports_type().
4095 g_app_info_reset_type_associations (const char *content_type)
4097 update_mimeapps_list (NULL, content_type,
4103 * g_app_info_get_default_for_type:
4104 * @content_type: the content type to find a #GAppInfo for
4105 * @must_support_uris: if %TRUE, the #GAppInfo is expected to
4108 * Gets the default #GAppInfo for a given content type.
4110 * Returns: (transfer full): #GAppInfo for given @content_type or
4114 g_app_info_get_default_for_type (const char *content_type,
4115 gboolean must_support_uris)
4117 GPtrArray *blacklist;
4123 g_return_val_if_fail (content_type != NULL, NULL);
4125 types = get_list_of_mimetypes (content_type, TRUE);
4127 blacklist = g_ptr_array_new ();
4128 results = g_ptr_array_new ();
4131 desktop_file_dirs_lock ();
4133 for (i = 0; types[i]; i++)
4135 /* Collect all the default apps for this type */
4136 for (j = 0; j < n_desktop_file_dirs; j++)
4137 desktop_file_dir_default_lookup (&desktop_file_dirs[j], types[i], results);
4139 /* Consider the associations as well... */
4140 for (j = 0; j < n_desktop_file_dirs; j++)
4141 desktop_file_dir_mime_lookup (&desktop_file_dirs[j], types[i], results, blacklist);
4143 /* (If any), see if one of those apps is installed... */
4144 for (j = 0; j < results->len; j++)
4146 const gchar *desktop_id = g_ptr_array_index (results, j);
4148 for (k = 0; k < n_desktop_file_dirs; k++)
4150 info = (GAppInfo *) desktop_file_dir_get_app (&desktop_file_dirs[k], desktop_id);
4154 if (!must_support_uris || g_app_info_supports_uris (info))
4157 g_clear_object (&info);
4162 /* Reset the list, ready to try again with the next (parent)
4163 * mimetype, but keep the blacklist in place.
4165 g_ptr_array_set_size (results, 0);
4169 desktop_file_dirs_unlock ();
4171 g_ptr_array_unref (blacklist);
4172 g_ptr_array_unref (results);
4179 * g_app_info_get_default_for_uri_scheme:
4180 * @uri_scheme: a string containing a URI scheme.
4182 * Gets the default application for handling URIs with
4183 * the given URI scheme. A URI scheme is the initial part
4184 * of the URI, up to but not including the ':', e.g. "http",
4187 * Returns: (transfer full): #GAppInfo for given @uri_scheme or %NULL on error.
4190 g_app_info_get_default_for_uri_scheme (const char *uri_scheme)
4193 char *content_type, *scheme_down;
4195 scheme_down = g_ascii_strdown (uri_scheme, -1);
4196 content_type = g_strdup_printf ("x-scheme-handler/%s", scheme_down);
4197 g_free (scheme_down);
4198 app_info = g_app_info_get_default_for_type (content_type, FALSE);
4199 g_free (content_type);
4204 /* "Get all" API {{{2 */
4207 * g_desktop_app_info_get_implementations:
4208 * @interface: the name of the interface
4210 * Gets all applications that implement @interface.
4212 * An application implements an interface if that interface is listed in
4213 * the Implements= line of the desktop file of the application.
4215 * Returns: (element-type GDesktopAppInfo) (transfer full): a list of #GDesktopAppInfo
4221 g_desktop_app_info_get_implementations (const gchar *interface)
4223 GList *result = NULL;
4227 desktop_file_dirs_lock ();
4229 for (i = 0; i < n_desktop_file_dirs; i++)
4230 desktop_file_dir_get_implementations (&desktop_file_dirs[i], &result, interface);
4232 desktop_file_dirs_unlock ();
4237 gchar *name = (*ptr)->data;
4238 GDesktopAppInfo *app;
4240 app = g_desktop_app_info_new (name);
4246 ptr = &(*ptr)->next;
4249 *ptr = g_list_delete_link (*ptr, *ptr);
4256 * g_desktop_app_info_search:
4257 * @search_string: the search string to use
4259 * Searches desktop files for ones that match @search_string.
4261 * The return value is an array of strvs. Each strv contains a list of
4262 * applications that matched @search_string with an equal score. The
4263 * outer list is sorted by score so that the first strv contains the
4264 * best-matching applications, and so on.
4265 * The algorithm for determining matches is undefined and may change at
4268 * Returns: (array zero-terminated=1) (element-type GStrv) (transfer full): a
4269 * list of strvs. Free each item with g_strfreev() and free the outer
4270 * list with g_free().
4273 g_desktop_app_info_search (const gchar *search_string)
4275 gchar **search_tokens;
4276 gint last_category = -1;
4278 gint n_categories = 0;
4279 gint start_of_category;
4282 search_tokens = g_str_tokenize_and_fold (search_string, NULL, NULL);
4284 desktop_file_dirs_lock ();
4286 reset_total_search_results ();
4288 for (i = 0; i < n_desktop_file_dirs; i++)
4290 for (j = 0; search_tokens[j]; j++)
4292 desktop_file_dir_search (&desktop_file_dirs[i], search_tokens[j]);
4293 merge_token_results (j == 0);
4295 merge_directory_results ();
4298 sort_total_search_results ();
4300 /* Count the total number of unique categories */
4301 for (i = 0; i < static_total_results_size; i++)
4302 if (static_total_results[i].category != last_category)
4304 last_category = static_total_results[i].category;
4308 results = g_new (gchar **, n_categories + 1);
4310 /* Start loading into the results list */
4311 start_of_category = 0;
4312 for (i = 0; i < n_categories; i++)
4314 gint n_items_in_category = 0;
4318 this_category = static_total_results[start_of_category].category;
4320 while (start_of_category + n_items_in_category < static_total_results_size &&
4321 static_total_results[start_of_category + n_items_in_category].category == this_category)
4322 n_items_in_category++;
4324 results[i] = g_new (gchar *, n_items_in_category + 1);
4325 for (j = 0; j < n_items_in_category; j++)
4326 results[i][j] = g_strdup (static_total_results[start_of_category + j].app_name);
4327 results[i][j] = NULL;
4329 start_of_category += n_items_in_category;
4333 desktop_file_dirs_unlock ();
4335 g_strfreev (search_tokens);
4341 * g_app_info_get_all:
4343 * Gets a list of all of the applications currently registered
4346 * For desktop files, this includes applications that have
4347 * `NoDisplay=true` set or are excluded from display by means
4348 * of `OnlyShowIn` or `NotShowIn`. See g_app_info_should_show().
4349 * The returned list does not include applications which have
4350 * the `Hidden` key set.
4352 * Returns: (element-type GAppInfo) (transfer full): a newly allocated #GList of references to #GAppInfos.
4355 g_app_info_get_all (void)
4358 GHashTableIter iter;
4363 apps = g_hash_table_new_full (g_str_hash, g_str_equal, g_free, NULL);
4365 desktop_file_dirs_lock ();
4367 for (i = 0; i < n_desktop_file_dirs; i++)
4368 desktop_file_dir_get_all (&desktop_file_dirs[i], apps);
4370 desktop_file_dirs_unlock ();
4373 g_hash_table_iter_init (&iter, apps);
4374 while (g_hash_table_iter_next (&iter, NULL, &value))
4377 infos = g_list_prepend (infos, value);
4380 g_hash_table_destroy (apps);
4385 /* GDesktopAppInfoLookup interface {{{2 */
4388 * GDesktopAppInfoLookup:
4390 * #GDesktopAppInfoLookup is an opaque data structure and can only be accessed
4391 * using the following functions.
4394 G_GNUC_BEGIN_IGNORE_DEPRECATIONS
4396 typedef GDesktopAppInfoLookupIface GDesktopAppInfoLookupInterface;
4397 G_DEFINE_INTERFACE (GDesktopAppInfoLookup, g_desktop_app_info_lookup, G_TYPE_OBJECT)
4400 g_desktop_app_info_lookup_default_init (GDesktopAppInfoLookupInterface *iface)
4404 /* "Get for mime type" APIs {{{2 */
4407 * g_desktop_app_info_lookup_get_default_for_uri_scheme:
4408 * @lookup: a #GDesktopAppInfoLookup
4409 * @uri_scheme: a string containing a URI scheme.
4411 * Gets the default application for launching applications
4412 * using this URI scheme for a particular GDesktopAppInfoLookup
4415 * The GDesktopAppInfoLookup interface and this function is used
4416 * to implement g_app_info_get_default_for_uri_scheme() backends
4417 * in a GIO module. There is no reason for applications to use it
4418 * directly. Applications should use g_app_info_get_default_for_uri_scheme().
4420 * Returns: (transfer full): #GAppInfo for given @uri_scheme or %NULL on error.
4422 * Deprecated: The #GDesktopAppInfoLookup interface is deprecated and unused by gio.
4425 g_desktop_app_info_lookup_get_default_for_uri_scheme (GDesktopAppInfoLookup *lookup,
4426 const char *uri_scheme)
4428 GDesktopAppInfoLookupIface *iface;
4430 g_return_val_if_fail (G_IS_DESKTOP_APP_INFO_LOOKUP (lookup), NULL);
4432 iface = G_DESKTOP_APP_INFO_LOOKUP_GET_IFACE (lookup);
4434 return (* iface->get_default_for_uri_scheme) (lookup, uri_scheme);
4437 G_GNUC_END_IGNORE_DEPRECATIONS
4439 /* Misc getter APIs {{{2 */
4442 * g_desktop_app_info_get_startup_wm_class:
4443 * @info: a #GDesktopAppInfo that supports startup notify
4445 * Retrieves the StartupWMClass field from @info. This represents the
4446 * WM_CLASS property of the main window of the application, if launched
4449 * Returns: (transfer none): the startup WM class, or %NULL if none is set
4450 * in the desktop file.
4455 g_desktop_app_info_get_startup_wm_class (GDesktopAppInfo *info)
4457 g_return_val_if_fail (G_IS_DESKTOP_APP_INFO (info), NULL);
4459 return info->startup_wm_class;
4463 * g_desktop_app_info_get_string:
4464 * @info: a #GDesktopAppInfo
4465 * @key: the key to look up
4467 * Looks up a string value in the keyfile backing @info.
4469 * The @key is looked up in the "Desktop Entry" group.
4471 * Returns: a newly allocated string, or %NULL if the key
4477 g_desktop_app_info_get_string (GDesktopAppInfo *info,
4480 g_return_val_if_fail (G_IS_DESKTOP_APP_INFO (info), NULL);
4482 return g_key_file_get_string (info->keyfile,
4483 G_KEY_FILE_DESKTOP_GROUP, key, NULL);
4487 * g_desktop_app_info_get_locale_string:
4488 * @info: a #GDesktopAppInfo
4489 * @key: the key to look up
4491 * Looks up a localized string value in the keyfile backing @info
4492 * translated to the current locale.
4494 * The @key is looked up in the "Desktop Entry" group.
4496 * Returns: (nullable): a newly allocated string, or %NULL if the key
4502 g_desktop_app_info_get_locale_string (GDesktopAppInfo *info,
4505 g_return_val_if_fail (G_IS_DESKTOP_APP_INFO (info), NULL);
4506 g_return_val_if_fail (key != NULL && *key != '\0', NULL);
4508 return g_key_file_get_locale_string (info->keyfile,
4509 G_KEY_FILE_DESKTOP_GROUP,
4514 * g_desktop_app_info_get_boolean:
4515 * @info: a #GDesktopAppInfo
4516 * @key: the key to look up
4518 * Looks up a boolean value in the keyfile backing @info.
4520 * The @key is looked up in the "Desktop Entry" group.
4522 * Returns: the boolean value, or %FALSE if the key
4528 g_desktop_app_info_get_boolean (GDesktopAppInfo *info,
4531 g_return_val_if_fail (G_IS_DESKTOP_APP_INFO (info), FALSE);
4533 return g_key_file_get_boolean (info->keyfile,
4534 G_KEY_FILE_DESKTOP_GROUP, key, NULL);
4538 * g_desktop_app_info_has_key:
4539 * @info: a #GDesktopAppInfo
4540 * @key: the key to look up
4542 * Returns whether @key exists in the "Desktop Entry" group
4543 * of the keyfile backing @info.
4545 * Returns: %TRUE if the @key exists
4550 g_desktop_app_info_has_key (GDesktopAppInfo *info,
4553 g_return_val_if_fail (G_IS_DESKTOP_APP_INFO (info), FALSE);
4555 return g_key_file_has_key (info->keyfile,
4556 G_KEY_FILE_DESKTOP_GROUP, key, NULL);
4559 /* Desktop actions support {{{2 */
4562 * g_desktop_app_info_list_actions:
4563 * @info: a #GDesktopAppInfo
4565 * Returns the list of "additional application actions" supported on the
4566 * desktop file, as per the desktop file specification.
4568 * As per the specification, this is the list of actions that are
4569 * explicitly listed in the "Actions" key of the [Desktop Entry] group.
4571 * Returns: (array zero-terminated=1) (element-type utf8) (transfer none): a list of strings, always non-%NULL
4575 const gchar * const *
4576 g_desktop_app_info_list_actions (GDesktopAppInfo *info)
4578 g_return_val_if_fail (G_IS_DESKTOP_APP_INFO (info), NULL);
4580 return (const gchar **) info->actions;
4584 app_info_has_action (GDesktopAppInfo *info,
4585 const gchar *action_name)
4589 for (i = 0; info->actions[i]; i++)
4590 if (g_str_equal (info->actions[i], action_name))
4597 * g_desktop_app_info_get_action_name:
4598 * @info: a #GDesktopAppInfo
4599 * @action_name: the name of the action as from
4600 * g_desktop_app_info_list_actions()
4602 * Gets the user-visible display name of the "additional application
4603 * action" specified by @action_name.
4605 * This corresponds to the "Name" key within the keyfile group for the
4608 * Returns: (transfer full): the locale-specific action name
4613 g_desktop_app_info_get_action_name (GDesktopAppInfo *info,
4614 const gchar *action_name)
4619 g_return_val_if_fail (G_IS_DESKTOP_APP_INFO (info), NULL);
4620 g_return_val_if_fail (action_name != NULL, NULL);
4621 g_return_val_if_fail (app_info_has_action (info, action_name), NULL);
4623 group_name = g_strdup_printf ("Desktop Action %s", action_name);
4624 result = g_key_file_get_locale_string (info->keyfile, group_name, "Name", NULL, NULL);
4625 g_free (group_name);
4627 /* The spec says that the Name field must be given.
4629 * If it's not, let's follow the behaviour of our get_name()
4630 * implementation above and never return %NULL.
4633 result = g_strdup (_("Unnamed"));
4639 * g_desktop_app_info_launch_action:
4640 * @info: a #GDesktopAppInfo
4641 * @action_name: the name of the action as from
4642 * g_desktop_app_info_list_actions()
4643 * @launch_context: (nullable): a #GAppLaunchContext
4645 * Activates the named application action.
4647 * You may only call this function on action names that were
4648 * returned from g_desktop_app_info_list_actions().
4650 * Note that if the main entry of the desktop file indicates that the
4651 * application supports startup notification, and @launch_context is
4652 * non-%NULL, then startup notification will be used when activating the
4653 * action (and as such, invocation of the action on the receiving side
4654 * must signal the end of startup notification when it is completed).
4655 * This is the expected behaviour of applications declaring additional
4656 * actions, as per the desktop file specification.
4658 * As with g_app_info_launch() there is no way to detect failures that
4659 * occur while using this function.
4664 g_desktop_app_info_launch_action (GDesktopAppInfo *info,
4665 const gchar *action_name,
4666 GAppLaunchContext *launch_context)
4668 GDBusConnection *session_bus;
4670 g_return_if_fail (G_IS_DESKTOP_APP_INFO (info));
4671 g_return_if_fail (action_name != NULL);
4672 g_return_if_fail (app_info_has_action (info, action_name));
4674 session_bus = g_bus_get_sync (G_BUS_TYPE_SESSION, NULL, NULL);
4676 if (session_bus && info->app_id)
4680 object_path = object_path_from_appid (info->app_id);
4681 g_dbus_connection_call (session_bus, info->app_id, object_path,
4682 "org.freedesktop.Application", "ActivateAction",
4683 g_variant_new ("(sav@a{sv})", action_name, NULL,
4684 g_desktop_app_info_make_platform_data (info, NULL, launch_context)),
4685 NULL, G_DBUS_CALL_FLAGS_NONE, -1, NULL, NULL, NULL);
4686 g_free (object_path);
4693 group_name = g_strdup_printf ("Desktop Action %s", action_name);
4694 exec_line = g_key_file_get_string (info->keyfile, group_name, "Exec", NULL);
4695 g_free (group_name);
4698 g_desktop_app_info_launch_uris_with_spawn (info, session_bus, exec_line, NULL, launch_context,
4699 _SPAWN_FLAGS_DEFAULT, NULL, NULL, NULL, NULL,
4705 if (session_bus != NULL)
4707 g_dbus_connection_flush (session_bus, NULL, NULL, NULL);
4708 g_object_unref (session_bus);
4713 /* vim:set foldmethod=marker: */