/* -*- mode: C; c-file-style: "gnu"; indent-tabs-mode: nil; -*- */ #include "config.h" #include "shell-app-system.h" #include "shell-app-usage.h" #include #include #include #include "shell-app-cache-private.h" #include "shell-app-private.h" #include "shell-window-tracker-private.h" #include "shell-realms.h" #include "shell-app-system-private.h" #include "shell-global.h" #include "shell-util.h" #include "st.h" /* Rescan for at most RESCAN_TIMEOUT_MS * MAX_RESCAN_RETRIES. That * should be plenty of time for even a slow spinning drive to update * the icon cache. */ #define RESCAN_TIMEOUT_MS 2500 #define MAX_RESCAN_RETRIES 6 /* Vendor prefixes are something that can be preprended to a .desktop * file name. Undo this. */ static const char*const vendor_prefixes[] = { "gnome-", "fedora-", "mozilla-", "debian-", NULL }; enum { PROP_0, }; enum { APP_STATE_CHANGED, INSTALLED_CHANGED, LAST_SIGNAL }; static guint signals[LAST_SIGNAL] = { 0 }; typedef struct _ShellAppSystem { GObject parent; GHashTable *running_apps; GHashTable *id_to_app; GHashTable *startup_wm_class_to_id; GList *installed_apps; guint rescan_icons_timeout_id; guint n_rescan_retries; } ShellAppSystem; static void shell_app_system_finalize (GObject *object); G_DEFINE_FINAL_TYPE (ShellAppSystem, shell_app_system, G_TYPE_OBJECT); static void shell_app_system_class_init(ShellAppSystemClass *klass) { GObjectClass *gobject_class = (GObjectClass *)klass; gobject_class->finalize = shell_app_system_finalize; signals[APP_STATE_CHANGED] = g_signal_new ("app-state-changed", SHELL_TYPE_APP_SYSTEM, G_SIGNAL_RUN_LAST, 0, NULL, NULL, NULL, G_TYPE_NONE, 1, SHELL_TYPE_APP); signals[INSTALLED_CHANGED] = g_signal_new ("installed-changed", SHELL_TYPE_APP_SYSTEM, G_SIGNAL_RUN_LAST, 0, NULL, NULL, NULL, G_TYPE_NONE, 0); } /* * Applications belonging to realms have a prefix added to the filenames * of their desktop files indicating the name of the realm. For example * in a realm called 'main' the desktop file 'org.gnome.Terminal.desktop' * is renamed to 'realm-main.org.gnome.Terminal.desktop'. * * This has the effect of creating a separate application ID for instances * of the same application in multiple realms. */ static const char * realm_name_from_application_id (const char *id) { gchar **split = NULL; const char *result = NULL; if (!g_str_has_prefix (id, "realm-")) { return NULL; } split = g_strsplit(id, ".", 2); if (split[0]) { g_assert_true (g_str_has_prefix (split[0], "realm-")); result = g_strdup(split[0] + 6); } g_strfreev (split); return result; } static char * current_realm_name (gboolean name_only) { gchar *link = NULL; gchar *p = NULL; gchar *realm = NULL; link = g_file_read_link ("/run/citadel/realms/current/current.realm", NULL); if (link) { p = g_strrstr(link, "/realm-"); if (p) { /* skip slash character */ p++; if (name_only) { /* skip 'realm-' */ p += 6; } realm = g_strdup(p); } g_free (link); } return realm; } static gboolean is_current_realm_app (const char *id, const char *current_realm) { return !g_str_has_prefix (id, "realm-") || g_str_has_prefix (id, current_realm); } static void refresh_installed_apps (ShellAppSystem *self) { const GList *l; GAppInfo *app; const char *app_id; char *current_realm; g_list_free_full (g_steal_pointer (&self->installed_apps), g_object_unref); l = shell_app_cache_get_all (shell_app_cache_get_default ()); current_realm = current_realm_name (FALSE); while (l) { app = l->data; app_id = g_app_info_get_id (app); if (is_current_realm_app (app_id, current_realm)) { self->installed_apps = g_list_prepend (self->installed_apps, g_object_ref (app)); } l = l->next; } self->installed_apps = g_list_reverse (self->installed_apps); g_free (current_realm); } static char * realm_wm_class (const char *wmclass, const char *realm_name) { if (realm_name) { return g_strdup_printf ("realm-%s.%s", realm_name, wmclass); } else { return g_strdup (wmclass); } } /* * Check whether @wm_class matches @id exactly when ignoring the .desktop suffix */ static gboolean startup_wm_class_is_exact_match (const char *id, const char *wm_class) { size_t wm_class_len; if (!g_str_has_prefix (id, wm_class)) return FALSE; wm_class_len = strlen (wm_class); if (id[wm_class_len] == '\0') return TRUE; return g_str_equal (id + wm_class_len, ".desktop"); } static void scan_startup_wm_class_to_id (ShellAppSystem *self) { g_autoptr(GPtrArray) no_show_ids = NULL; const GList *l; GList *all; g_hash_table_remove_all (self->startup_wm_class_to_id); all = shell_app_cache_get_all (shell_app_cache_get_default ()); no_show_ids = g_ptr_array_new (); for (l = all; l != NULL; l = l->next) { GAppInfo *info = l->data; const char *startup_wm_class, *id, *old_id; gboolean should_show; char *realm_wmclass; id = g_app_info_get_id (info); startup_wm_class = g_desktop_app_info_get_startup_wm_class (G_DESKTOP_APP_INFO (info)); if (startup_wm_class == NULL) continue; should_show = g_app_info_should_show (info); if (!should_show) g_ptr_array_add (no_show_ids, (char *) id); realm_wmclass = realm_wm_class (startup_wm_class, realm_name_from_application_id (id)); /* In case multiple .desktop files set the same StartupWMClass, prefer * the one where ID and StartupWMClass match */ old_id = g_hash_table_lookup (self->startup_wm_class_to_id, realm_wmclass); if (old_id && startup_wm_class_is_exact_match (id, startup_wm_class)) old_id = NULL; /* Give priority to the desktop files that should be shown */ if (old_id && should_show && g_ptr_array_find_with_equal_func (no_show_ids, old_id, g_str_equal, NULL)) old_id = NULL; if (!old_id) g_hash_table_insert (self->startup_wm_class_to_id, g_strdup (realm_wmclass), g_strdup (id)); g_free (realm_wmclass); } } static gboolean app_is_stale (ShellApp *app) { GDesktopAppInfo *info, *old; GAppInfo *old_info, *new_info; gboolean is_unchanged; if (shell_app_is_window_backed (app)) return FALSE; info = shell_app_cache_get_info (shell_app_cache_get_default (), shell_app_get_id (app)); if (!info) return TRUE; old = shell_app_get_app_info (app); old_info = G_APP_INFO (old); new_info = G_APP_INFO (info); is_unchanged = g_app_info_should_show (old_info) == g_app_info_should_show (new_info) && strcmp (g_desktop_app_info_get_filename (old), g_desktop_app_info_get_filename (info)) == 0 && g_strcmp0 (g_app_info_get_executable (old_info), g_app_info_get_executable (new_info)) == 0 && g_strcmp0 (g_app_info_get_commandline (old_info), g_app_info_get_commandline (new_info)) == 0 && strcmp (g_app_info_get_name (old_info), g_app_info_get_name (new_info)) == 0 && g_strcmp0 (g_app_info_get_description (old_info), g_app_info_get_description (new_info)) == 0 && strcmp (g_app_info_get_display_name (old_info), g_app_info_get_display_name (new_info)) == 0 && g_icon_equal (g_app_info_get_icon (old_info), g_app_info_get_icon (new_info)); return !is_unchanged; } static gboolean stale_app_remove_func (gpointer key, gpointer value, gpointer user_data) { return app_is_stale (value); } static void collect_stale_windows (gpointer key, gpointer value, gpointer user_data) { ShellApp *app = key; GDesktopAppInfo *info; GPtrArray *windows = user_data; info = shell_app_cache_get_info (shell_app_cache_get_default (), shell_app_get_id (app)); /* No info either means that the app became stale, or that it is * window-backed. Re-tracking the app's windows allows us to reflect * changes in either direction, i.e. from stale app to window-backed, * or from window-backed to app-backed (if the app was launched right * between installing the app and updating the app cache). */ if (info == NULL) { GSList *l; for (l = shell_app_get_windows (app); l; l = l->next) g_ptr_array_add (windows, l->data); } } static void retrack_window (gpointer data, gpointer user_data) { GObject *window = data; /* Make ShellWindowTracker retrack the window */ g_object_notify (window, "wm-class"); } static gboolean rescan_icon_theme_cb (gpointer user_data) { ShellAppSystem *self; StTextureCache *texture_cache; gboolean rescanned; self = (ShellAppSystem *) user_data; texture_cache = st_texture_cache_get_default (); rescanned = st_texture_cache_rescan_icon_theme (texture_cache); self->n_rescan_retries++; if (rescanned || self->n_rescan_retries >= MAX_RESCAN_RETRIES) { self->n_rescan_retries = 0; self->rescan_icons_timeout_id = 0; return G_SOURCE_REMOVE; } return G_SOURCE_CONTINUE; } static void rescan_icon_theme (ShellAppSystem *self) { self->n_rescan_retries = 0; if (self->rescan_icons_timeout_id > 0) return; self->rescan_icons_timeout_id = g_timeout_add (RESCAN_TIMEOUT_MS, rescan_icon_theme_cb, self); } static void installed_changed (ShellAppCache *cache, ShellAppSystem *self) { GPtrArray *windows = g_ptr_array_new (); rescan_icon_theme (self); scan_startup_wm_class_to_id (self); g_hash_table_foreach_remove (self->id_to_app, stale_app_remove_func, NULL); g_hash_table_foreach (self->running_apps, collect_stale_windows, windows); g_ptr_array_foreach (windows, retrack_window, NULL); g_ptr_array_free (windows, TRUE); g_signal_emit (self, signals[INSTALLED_CHANGED], 0, NULL); } static void shell_app_system_init (ShellAppSystem *self) { ShellAppCache *cache; self->running_apps = g_hash_table_new_full (NULL, NULL, (GDestroyNotify) g_object_unref, NULL); self->id_to_app = g_hash_table_new_full (g_str_hash, g_str_equal, NULL, (GDestroyNotify)g_object_unref); self->startup_wm_class_to_id = g_hash_table_new_full (g_str_hash, g_str_equal, g_free, g_free); cache = shell_app_cache_get_default (); g_signal_connect (cache, "changed", G_CALLBACK (installed_changed), self); installed_changed (cache, self); } static void shell_app_system_finalize (GObject *object) { ShellAppSystem *self = SHELL_APP_SYSTEM (object); g_hash_table_destroy (self->running_apps); g_hash_table_destroy (self->id_to_app); g_hash_table_destroy (self->startup_wm_class_to_id); g_list_free_full (self->installed_apps, g_object_unref); g_clear_handle_id (&self->rescan_icons_timeout_id, g_source_remove); G_OBJECT_CLASS (shell_app_system_parent_class)->finalize (object); } /** * shell_app_system_get_default: * * Return Value: (transfer none): The global #ShellAppSystem singleton */ ShellAppSystem * shell_app_system_get_default (void) { return shell_global_get_app_system (shell_global_get ()); } /** * shell_app_system_lookup_app: * * Find a #ShellApp corresponding to an id. * * Return value: (transfer none): The #ShellApp for id, or %NULL if none */ ShellApp * shell_app_system_lookup_app (ShellAppSystem *self, const char *id) { ShellApp *app; GDesktopAppInfo *info; if (id == NULL) { return NULL; } app = g_hash_table_lookup (self->id_to_app, id); if (app) return app; info = shell_app_cache_get_info (shell_app_cache_get_default (), id); if (!info) return NULL; app = _shell_app_new (info); g_hash_table_insert (self->id_to_app, (char *) shell_app_get_id (app), app); return app; } /** * shell_app_system_lookup_heuristic_basename: * @system: a #ShellAppSystem * @id: Probable application identifier * * Find a valid application corresponding to a given * heuristically determined application identifier * string, or %NULL if none. * * Returns: (transfer none): A #ShellApp for @name */ ShellApp * shell_app_system_lookup_heuristic_basename (ShellAppSystem *system, const char *name) { ShellApp *result; const char *const *prefix; result = shell_app_system_lookup_app (system, name); if (result != NULL) return result; for (prefix = vendor_prefixes; *prefix != NULL; prefix++) { char *tmpid = g_strconcat (*prefix, name, NULL); result = shell_app_system_lookup_app (system, tmpid); g_free (tmpid); if (result != NULL) return result; } return NULL; } /** * shell_app_system_lookup_desktop_wmclass: * @system: a #ShellAppSystem * @wmclass: (nullable): A WM_CLASS value * * Find a valid application whose .desktop file, without the extension * and properly canonicalized, matches @wmclass. * * Returns: (transfer none): A #ShellApp for @wmclass */ ShellApp * shell_app_system_lookup_desktop_wmclass (ShellAppSystem *system, const char *wmclass, const char *realm_name) { char *canonicalized; char *desktop_file; char *classname; ShellApp *app; if (wmclass == NULL) return NULL; classname = realm_wm_class (wmclass, realm_name); /* First try without changing the case (this handles org.example.Foo.Bar.desktop applications) Note that is slightly wrong in that Gtk+ would set the WM_CLASS to Org.example.Foo.Bar, but it also sets the instance part to org.example.Foo.Bar, so we're ok */ desktop_file = g_strconcat (classname, ".desktop", NULL); app = shell_app_system_lookup_heuristic_basename (system, desktop_file); g_free (desktop_file); if (app) { g_free (classname); return app; } canonicalized = g_ascii_strdown (classname, -1); /* This handles "Fedora Eclipse", probably others. * Note g_strdelimit is modify-in-place. */ g_strdelimit (canonicalized, " ", '-'); desktop_file = g_strconcat (canonicalized, ".desktop", NULL); app = shell_app_system_lookup_heuristic_basename (system, desktop_file); g_free (canonicalized); g_free (desktop_file); g_free (classname); return app; } /** * shell_app_system_lookup_startup_wmclass: * @system: a #ShellAppSystem * @wmclass: (nullable): A WM_CLASS value * * Find a valid application whose .desktop file contains a * StartupWMClass entry matching @wmclass. * * Returns: (transfer none): A #ShellApp for @wmclass */ ShellApp * shell_app_system_lookup_startup_wmclass (ShellAppSystem *system, const char *wmclass, const char *realm_name) { const char *id; char *classname; if (wmclass == NULL) return NULL; classname = realm_wm_class (wmclass, realm_name); id = g_hash_table_lookup (system->startup_wm_class_to_id, classname); g_free (classname); if (id == NULL) return NULL; return shell_app_system_lookup_app (system, id); } void _shell_app_system_notify_app_state_changed (ShellAppSystem *self, ShellApp *app) { ShellAppState state = shell_app_get_state (app); switch (state) { case SHELL_APP_STATE_RUNNING: g_hash_table_insert (self->running_apps, g_object_ref (app), NULL); break; case SHELL_APP_STATE_STARTING: break; case SHELL_APP_STATE_STOPPED: g_hash_table_remove (self->running_apps, app); break; default: g_warn_if_reached(); break; } g_signal_emit (self, signals[APP_STATE_CHANGED], 0, app); } static gboolean is_current_realm_context_app(ShellApp *app) { ShellRealms *realms = shell_realms_get_default(); ShellRealmItem *item = shell_realms_current_realm (realms); guint id = (item) ? shell_realm_item_get_context_id (item) : 0; GSList *iter = shell_app_get_windows (app); while (iter) { MetaWindow *window = iter->data; if (meta_window_is_on_all_workspaces (window)) { return true; } MetaWorkspace *workspace = meta_window_get_workspace (window); if (meta_workspace_get_context_id (workspace) == id) { return true; } iter = iter->next; } return false; } /** * shell_app_system_get_running: * @self: A #ShellAppSystem * * Returns the set of applications which currently have at least one * open window. The returned list will be sorted by shell_app_compare(). * * Returns: (element-type ShellApp) (transfer container): Active applications */ GSList * shell_app_system_get_running (ShellAppSystem *self) { gpointer key, value; GSList *ret; GHashTableIter iter; g_hash_table_iter_init (&iter, self->running_apps); ret = NULL; while (g_hash_table_iter_next (&iter, &key, &value)) { ShellApp *app = key; if (is_current_realm_context_app (app)) { ret = g_slist_prepend (ret, app); } } ret = g_slist_sort (ret, (GCompareFunc)shell_app_compare); return ret; } /** * shell_app_system_search: * @search_string: the search string to use * * Wrapper around g_desktop_app_info_search() that replaces results that * don't validate as UTF-8 with the empty string. * * Returns: (array zero-terminated=1) (element-type GStrv) (transfer full): a * list of strvs. Free each item with g_strfreev() and free the outer * list with g_free(). */ char *** shell_app_system_search (const char *search_string) { char ***results = g_desktop_app_info_search (search_string); char ***groups, **ids; char *current_realm; current_realm = current_realm_name (FALSE); for (groups = results; *groups; groups++) for (ids = *groups; *ids; ids++) if (!g_utf8_validate (*ids, -1, NULL) || !is_current_realm_app (*ids, current_realm)) **ids = '\0'; g_free (current_realm); return results; } /** * shell_app_system_get_installed: * @self: the #ShellAppSystem * * Returns all installed apps, as a list of #GAppInfo * * Returns: (transfer none) (element-type GAppInfo): a list of #GAppInfo * describing all known applications. This memory is owned by the * #ShellAppSystem and should not be freed. **/ GList * shell_app_system_get_installed (ShellAppSystem *self) { refresh_installed_apps (self); return self->installed_apps; }