path: root/src/drun.c

#include <ctype.h>
#include <dirent.h>
#include <errno.h>
#include <fts.h>
#include <glib.h>
#include <gio/gdesktopappinfo.h>
#include <stdbool.h>
#include <stdio.h>
#include <stdlib.h>
#include <string.h>
#include <sys/stat.h>
#include "drun.h"
#include "history.h"
#include "log.h"
#include "mkdirp.h"
#include "string_vec.h"
#include "xmalloc.h"

static const char *default_data_dir = ".local/share/";
static const char *default_cache_dir = ".cache/";
static const char *cache_basename = "tofi-drun";

[[nodiscard("memory leaked")]]
static char *get_cache_path() {
	char *cache_name = NULL;
	const char *state_path = getenv("XDG_CACHE_HOME");
	if (state_path == NULL) {
		const char *home = getenv("HOME");
		if (home == NULL) {
			log_error("Couldn't retrieve HOME from environment.\n");
			return NULL;
		}
		size_t len = strlen(home) + 1
			+ strlen(default_cache_dir) + 1
			+ strlen(cache_basename) + 1;
		cache_name = xmalloc(len);
		snprintf(
			cache_name,
			len,
			"%s/%s/%s",
			home,
			default_cache_dir,
			cache_basename);
	} else {
		size_t len = strlen(state_path) + 1
			+ strlen(cache_basename) + 1;
		cache_name = xmalloc(len);
		snprintf(
			cache_name,
			len,
			"%s/%s",
			state_path,
			cache_basename);
	}
	return cache_name;
}

[[nodiscard("memory leaked")]]
static struct string_vec get_application_paths() {
	char *base_paths = NULL;
	const char *xdg_data_dirs = getenv("XDG_DATA_DIRS");
	if (xdg_data_dirs == NULL) {
		xdg_data_dirs = "/usr/local/share/:/usr/share/";
	}
	const char *xdg_data_home = getenv("XDG_DATA_HOME");
	if (xdg_data_home == NULL) {
		const char *home = getenv("HOME");
		if (home == NULL) {
			log_error("Couldn't retrieve HOME from environment.\n");
			exit(EXIT_FAILURE);
		}
		size_t len = strlen(home) + 1
			+ strlen(default_data_dir) + 1
			+ strlen(xdg_data_dirs) + 1;
		base_paths = xmalloc(len);
		snprintf(
			base_paths,
			len,
			"%s/%s:%s",
			home,
			default_data_dir,
			xdg_data_dirs);
	} else {
		size_t len = strlen(xdg_data_home) + 1
			+ strlen(xdg_data_dirs) + 1;
		base_paths = xmalloc(len);
		snprintf(
			base_paths,
			len,
			"%s:%s",
			xdg_data_home,
			xdg_data_dirs);
	}


	/* Append /applications/ to each entry. */
	struct string_vec paths = string_vec_create();
	char *saveptr = NULL;
	char *path_entry = strtok_r(base_paths, ":", &saveptr);
	while (path_entry != NULL) {
		const char *subdir = "applications/";
		size_t len = strlen(path_entry) + 1 + strlen(subdir) + 1;
		char *apps = xmalloc(len);
		snprintf(apps, len, "%s/%s", path_entry, subdir);
		string_vec_add(&paths, apps);
		free(apps);
		path_entry = strtok_r(NULL, ":", &saveptr);
	}
	free(base_paths);

	return paths;
}

static void parse_desktop_file(gpointer key, gpointer value, void *data)
{
	const char *id = key;
	const char *path = value;
	struct desktop_vec *apps = data;

	desktop_vec_add_file(apps, id, path);
}

struct desktop_vec drun_generate(void)
{
	/*
	 * Note for the future: this custom logic could be replaced with
	 * g_app_info_get_all(), but that's slower. Worth remembering
	 * though if this runs into issues.
	 */
	log_debug("Retrieving application dirs.\n");
	struct string_vec paths = get_application_paths();
 	struct string_vec desktop_files = string_vec_create();
 	log_debug("Scanning for .desktop files.\n");
 	for (size_t i = 0; i < paths.count; i++) {
		const char *path_entry = paths.buf[i].string;
 		DIR *dir = opendir(path_entry);
 		if (dir != NULL) {
 			struct dirent *d;
 			while ((d = readdir(dir)) != NULL) {
				const char *extension = strrchr(d->d_name, '.');
				if (extension == NULL) {
					continue;
				}
				if (strcmp(extension, ".desktop")) {
					continue;
				}
 				string_vec_add(&desktop_files, d->d_name);
 			}
 			closedir(dir);
 		}
 	}
	log_debug("Found %zu files.\n", desktop_files.count);


 	log_debug("Parsing .desktop files.\n");
	/*
	 * The Desktop Entry Specification says that only the highest
	 * precedence application file with a given ID should be used, so store
	 * the id / path pairs into a hash table to enforce uniqueness.
	 */
	GHashTable *id_hash = g_hash_table_new_full(g_str_hash, g_str_equal, free, free);
	struct desktop_vec apps = desktop_vec_create();
 	for (size_t i = 0; i < paths.count; i++) {
		char *path_entry = paths.buf[i].string;
		char *tree[2] = { path_entry, NULL };
		size_t prefix_len = strlen(path_entry);
		FTS *fts = fts_open(tree, FTS_LOGICAL, NULL);
		FTSENT *entry = fts_read(fts);
		for (; entry != NULL; entry = fts_read(fts)) {
			const char *extension = strrchr(entry->fts_name, '.');
			if (extension == NULL) {
				continue;
			}
			if (strcmp(extension, ".desktop")) {
				continue;
			}
			char *id = xstrdup(&entry->fts_path[prefix_len]);
			char *slash = strchr(id, '/');
			while (slash != NULL) {
				*slash = '-';
				slash = strchr(slash, '/');
			}
			/*
			 * We're iterating from highest to lowest precedence,
			 * so only the first file with a given ID should be
			 * stored.
			 */
			if (!g_hash_table_contains(id_hash, id)) {
				char *path = xstrdup(entry->fts_path);
				g_hash_table_insert(id_hash, id, path);
			} else {
				free(id);
			}

		}
		fts_close(fts);
 	}

	/* Parse the remaining files into our desktop_vec. */
	g_hash_table_foreach(id_hash, parse_desktop_file, &apps);
	g_hash_table_unref(id_hash);

	log_debug("Found %zu apps.\n", apps.count);

	/*
	 * It's now safe to sort the desktop file vector, as the rules about
	 * file precedence have been taken care of.
	 */
	log_debug("Sorting results.\n");
	desktop_vec_sort(&apps);

	string_vec_destroy(&desktop_files);
	string_vec_destroy(&paths);
	return apps;
}

struct desktop_vec drun_generate_cached()
{
	log_debug("Retrieving cache location.\n");
	char *cache_path = get_cache_path();

	struct stat sb;
	if (cache_path == NULL) {
		return drun_generate();
	}

	/* If the cache doesn't exist, create it and return */
	errno = 0;
	if (stat(cache_path, &sb) == -1) {
		if (errno == ENOENT) {
			struct desktop_vec apps = drun_generate();
			if (!mkdirp(cache_path)) {
				free(cache_path);
				return apps;
			}
			errno = 0;
			FILE *cache = fopen(cache_path, "wb");
			if (cache == NULL) {
				log_error("Error creating drun cache: %s.\n", strerror(errno));
				free(cache_path);
				return apps;
			}
			desktop_vec_save(&apps, cache);
			fclose(cache);
			free(cache_path);
			return apps;
		}
		free(cache_path);
		return drun_generate();
	}

	log_debug("Retrieving application dirs.\n");
	struct string_vec application_path = get_application_paths();;

	/* The cache exists, so check if it's still in date */
	bool out_of_date = false;
	for (size_t i = 0; i < application_path.count; i++) {
		struct stat path_sb;
		if (stat(application_path.buf[i].string, &path_sb) == 0) {
			if (path_sb.st_mtim.tv_sec > sb.st_mtim.tv_sec) {
				out_of_date = true;
				break;
			}
		}
	}
	string_vec_destroy(&application_path);

	struct desktop_vec apps;
	if (out_of_date) {
		log_debug("Cache out of date, updating.\n");
		log_indent();
		apps = drun_generate();
		log_unindent();
		errno = 0;
		FILE *cache = fopen(cache_path, "wb");
		if (cache == NULL) {
			log_error("Failed to update cache: %s.\n", strerror(errno));
		} else {
			desktop_vec_save(&apps, cache);
			fclose(cache);
		}
	} else {
		log_debug("Cache up to date, loading.\n");
		errno = 0;
		FILE *cache = fopen(cache_path, "rb");
		if (cache == NULL) {
			log_error("Failed to load cache: %s.\n", strerror(errno));
			log_indent();
			apps = drun_generate();
			log_unindent();
		} else {
			apps = desktop_vec_load(cache);
			fclose(cache);
		}
	}
	free(cache_path);
	return apps;
}

void drun_print(const char *filename, const char *terminal_command)
{
	GKeyFile *file = g_key_file_new();
	if (!g_key_file_load_from_file(file, filename, G_KEY_FILE_NONE, NULL)) {
		log_error("Failed to open %s.\n", filename);
		return;
	}
	const char *group = "Desktop Entry";

	char *exec = g_key_file_get_string(file, group, "Exec", NULL);
	if (exec == NULL) {
		log_error("Failed to get Exec key from %s.\n", filename);
		g_key_file_unref(file);
		return;
	}

	/*
	 * Build a string vector from the command line, replacing % field codes
	 * with the appropriate values.
	 */
	struct string_vec pieces = string_vec_create();
	char *search = exec;
	char *last = search;
	while ((search = strchr(search, '%')) != NULL) {
		/* Add the string up to here to our vector. */
		search[0] = '\0';
		string_vec_add(&pieces, last);

		switch (search[1]) {
			case 'i':
				if (g_key_file_has_key(file, group, "Icon", NULL)) {
					string_vec_add(&pieces, "--icon ");
					string_vec_add(&pieces, g_key_file_get_string(file, group, "Icon", NULL));
				}
				break;
			case 'c':
				string_vec_add(&pieces, g_key_file_get_locale_string(file, group, "Name", NULL, NULL));
				break;
			case 'k':
				string_vec_add(&pieces, filename);
				break;
		}

		search += 2;
		last = search;
	}
	string_vec_add(&pieces, last);

        /*
         * If this is a terminal application, the command line needs to be
         * preceded by the terminal command.
         */
	bool terminal = g_key_file_get_boolean(file, group, "Terminal", NULL);
	if (terminal) {
		if (terminal_command[0] == '\0') {
			log_warning("Terminal application launched, but no terminal is set.\n");
			log_warning("This probably isn't what you want.\n");
			log_warning("See the --terminal option documentation in the man page.\n");
		} else {
			fputs(terminal_command, stdout);
			fputc(' ', stdout);
		}
	}

        /* Build the command line from our vector. */
        for (size_t i = 0; i < pieces.count; i++) {
		fputs(pieces.buf[i].string, stdout);
	}
	fputc('\n', stdout);

	string_vec_destroy(&pieces);
	free(exec);
	g_key_file_unref(file);
}

void drun_launch(const char *filename)
{
	GDesktopAppInfo *info = g_desktop_app_info_new_from_filename(filename);
	GAppLaunchContext *context = g_app_launch_context_new();
	GError *err = NULL;

	if (!g_app_info_launch((GAppInfo *)info, NULL, context, &err)) {
		log_error("Failed to launch %s.\n", filename);
		log_error("%s.\n", err->message);
		log_error(
				"If this is a terminal issue, you can use `--drun-launch=false`,\n"
				"         and pass your preferred terminal command to `--terminal`.\n"
				"         For more information, see https://gitlab.gnome.org/GNOME/glib/-/issues/338\n"
				"         and https://github.com/philj56/tofi/issues/46.\n");
	}

	g_clear_error(&err);
	g_object_unref(context);
	g_object_unref(info);
}

static int cmpscorep(const void *restrict a, const void *restrict b)
{
	struct desktop_entry *restrict app1 = (struct desktop_entry *)a;
	struct desktop_entry *restrict app2 = (struct desktop_entry *)b;
	return app2->history_score - app1->history_score;
}

void drun_history_sort(struct desktop_vec *apps, struct history *history)
{
	log_debug("Moving already known apps to the front.\n");
	for (size_t i = 0; i < history->count; i++) {
		struct desktop_entry *res = desktop_vec_find_sorted(apps, history->buf[i].name);
		if (res == NULL) {
			continue;
		}
		res->history_score = history->buf[i].run_count;
	}
	qsort(apps->buf, apps->count, sizeof(apps->buf[0]), cmpscorep);
}