/** * rofi * * MIT/X11 License * Copyright 2013-2016 Qball Cow * * Permission is hereby granted, free of charge, to any person obtaining * a copy of this software and associated documentation files (the * "Software"), to deal in the Software without restriction, including * without limitation the rights to use, copy, modify, merge, publish, * distribute, sublicense, and/or sell copies of the Software, and to * permit persons to whom the Software is furnished to do so, subject to * the following conditions: * * The above copyright notice and this permission notice shall be * included in all copies or substantial portions of the Software. * * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. * IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY * CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, * TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE * SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. * */ #include #ifdef ENABLE_DRUN #include #include #include #include #include #include #include #include #include #include #include #include "rofi.h" #include "settings.h" #include "helper.h" #include "textbox.h" #include "history.h" #include "dialogs/drun.h" #define DRUN_CACHE_FILE "rofi2.druncache" #define LOG_DOMAIN "Dialogs.DRun" static inline int execsh ( const char *cmd, int run_in_term ) { int retv = TRUE; char **args = NULL; int argc = 0; if ( run_in_term ) { helper_parse_setup ( config.run_shell_command, &args, &argc, "{cmd}", cmd, NULL ); } else { helper_parse_setup ( config.run_command, &args, &argc, "{cmd}", cmd, NULL ); } GError *error = NULL; g_spawn_async ( NULL, args, NULL, G_SPAWN_SEARCH_PATH, NULL, NULL, NULL, &error ); if ( error != NULL ) { char *msg = g_strdup_printf ( "Failed to execute: '%s'\nError: '%s'", cmd, error->message ); rofi_view_error_dialog ( msg, FALSE ); g_free ( msg ); // print error. g_error_free ( error ); retv = FALSE; } // Free the args list. g_strfreev ( args ); return retv; } // execute sub-process static void exec_cmd ( const char *cmd, int run_in_term ) { if ( !cmd || !cmd[0] ) { return; } execsh ( cmd, run_in_term ); } /** * Store extra information about the entry. * Currently the executable and if it should run in terminal. */ typedef struct { /* ID */ char *id; /* Root */ char *root; /* Path to desktop file */ char *path; /* Executable */ char *exec; /* Name of the Entry */ char *name; /* Generic Name */ char *generic_name; /* Application needs to be launched in terminal. */ unsigned int terminal; } DRunModeEntry; typedef struct { DRunModeEntry *entry_list; unsigned int cmd_list_length; unsigned int history_length; // List of disabled entries. char **disabled_entries; unsigned int disabled_entries_length; } DRunModePrivateData; struct RegexEvalArg { DRunModeEntry *e; gboolean success; }; static gboolean drun_helper_eval_cb ( const GMatchInfo *info, GString *res, gpointer data ) { // TODO quoting is not right? Find description not very clear, need to check. struct RegexEvalArg *e = (struct RegexEvalArg *) data; gchar *match; // Get the match match = g_match_info_fetch ( info, 0 ); if ( match != NULL ) { switch ( match[1] ) { // Unsupported case 'f': case 'F': case 'u': case 'U': case 'i': // Deprecated case 'd': case 'D': case 'n': case 'N': case 'v': case 'm': break; case 'k': if ( e->e->path ) { char *esc = g_shell_quote ( e->e->path ); g_string_append ( res, esc ); g_free ( esc ); } break; case 'c': if ( e->e->name ) { char *esc = g_shell_quote ( e->e->name ); g_string_append ( res, esc ); g_free ( esc ); } break; // Invalid, this entry should not be processed -> throw error. default: e->success = FALSE; g_free ( match ); return TRUE; } g_free ( match ); } // Continue replacement. return FALSE; } static void exec_cmd_entry ( DRunModeEntry *e ) { GError *error = NULL; GRegex *reg = g_regex_new ( "%[a-zA-Z]", 0, 0, &error ); if ( error != NULL ) { fprintf ( stderr, "Internal error, failed to create regex: %s.\n", error->message ); g_error_free ( error ); return; } struct RegexEvalArg earg = { .e = e, .success = TRUE }; char *str = g_regex_replace_eval ( reg, e->exec, -1, 0, 0, drun_helper_eval_cb, &earg, &error ); if ( error != NULL ) { fprintf ( stderr, "Internal error, failed replace field codes: %s.\n", error->message ); g_error_free ( error ); return; } g_regex_unref ( reg ); if ( earg.success == FALSE ) { fprintf ( stderr, "Invalid field code in Exec line: %s.\n", e->exec );; return; } if ( str == NULL ) { fprintf ( stderr, "Nothing to execute after processing: %s.\n", e->exec );; return; } gchar *fp = rofi_expand_path ( g_strstrip ( str ) ); if ( execsh ( fp, e->terminal ) ) { char *path = g_build_filename ( cache_dir, DRUN_CACHE_FILE, NULL ); char *key = g_strdup_printf ( "%s:::%s", e->root, e->path ); history_set ( path, key ); g_free ( key ); g_free ( path ); } g_free ( str ); g_free ( fp ); } /** * This function absorbs/freeÅ› path, so this is no longer available afterwards. */ static void read_desktop_file ( DRunModePrivateData *pd, const char *root, const char *path ) { // Create ID on stack. // We know strlen (path ) > strlen(root)+1 const ssize_t id_len = strlen ( path ) - strlen ( root ) ; char id[id_len]; g_strlcpy ( id, &( path[strlen ( root ) + 1] ), id_len ); for ( int index = 0; index < id_len; index++ ) { if ( id[index] == '/' ) { id[index] = '-'; } } // Check if item is on disabled list. for ( unsigned int ind = 0; ind < pd->disabled_entries_length; ind++ ) { if ( g_strcmp0 ( pd->disabled_entries[ind], id ) == 0 ) { g_log ( LOG_DOMAIN, G_LOG_LEVEL_DEBUG, "Skipping: %s, was previously disabled.", id ); return; } } for ( unsigned int index = 0; index < pd->cmd_list_length; index++ ) { if ( g_strcmp0 ( id, pd->entry_list[index].id ) == 0 ) { g_log ( LOG_DOMAIN, G_LOG_LEVEL_DEBUG, "Skipping: %s, previously parsed.", id ); return; } } GKeyFile *kf = g_key_file_new (); GError *error = NULL; g_key_file_load_from_file ( kf, path, 0, &error ); // If error, skip to next entry if ( error != NULL ) { g_log ( LOG_DOMAIN, G_LOG_LEVEL_DEBUG, "Failed to parse desktop file: %s because: %s", path, error->message ); g_error_free ( error ); g_key_file_free ( kf ); return; } // Skip non Application entries. gchar *key = g_key_file_get_string ( kf, "Desktop Entry", "Type", NULL ); if ( key == NULL ) { // No type? ignore. g_log ( LOG_DOMAIN, G_LOG_LEVEL_DEBUG, "Skipping desktop file: %s because: No type indicated", path ); g_key_file_free ( kf ); return; } if ( g_strcmp0 ( key, "Application" ) ) { g_log ( LOG_DOMAIN, G_LOG_LEVEL_DEBUG, "Skipping desktop file: %s because: Not of type application (%s)", path, key ); g_free ( key ); g_key_file_free ( kf ); return; } g_free ( key ); // Name key is required. if ( !g_key_file_has_key ( kf, "Desktop Entry", "Name", NULL ) ) { g_log ( LOG_DOMAIN, G_LOG_LEVEL_DEBUG, "Invalid DesktopFile: '%s', no 'Name' key present.\n", path ); g_key_file_free ( kf ); return; } // Skip hidden entries. if ( g_key_file_get_boolean ( kf, "Desktop Entry", "Hidden", NULL ) ) { g_log ( LOG_DOMAIN, G_LOG_LEVEL_DEBUG, "Adding desktop file: %s to disabled list because: Hdden", path ); g_key_file_free ( kf ); pd->disabled_entries = g_realloc ( pd->disabled_entries, ( pd->disabled_entries_length + 2 ) * sizeof ( char* ) ); pd->disabled_entries[pd->disabled_entries_length] = g_strdup ( id ); pd->disabled_entries[pd->disabled_entries_length + 1] = NULL; pd->disabled_entries_length++; return; } // Skip entries that have NoDisplay set. if ( g_key_file_get_boolean ( kf, "Desktop Entry", "NoDisplay", NULL ) ) { g_log ( LOG_DOMAIN, G_LOG_LEVEL_DEBUG, "Adding desktop file: %s to disabled list because: NoDisplay", path ); g_key_file_free ( kf ); pd->disabled_entries = g_realloc ( pd->disabled_entries, ( pd->disabled_entries_length + 2 ) * sizeof ( char* ) ); pd->disabled_entries[pd->disabled_entries_length] = g_strdup ( id ); pd->disabled_entries[pd->disabled_entries_length + 1] = NULL; pd->disabled_entries_length++; return; } // We need Exec, don't support DBusActivatable if ( !g_key_file_has_key ( kf, "Desktop Entry", "Exec", NULL ) ) { g_log ( LOG_DOMAIN, G_LOG_LEVEL_DEBUG, "Unsupported DesktopFile: '%s', no 'Exec' key present.\n", path ); g_key_file_free ( kf ); return; } { size_t nl = ( ( pd->cmd_list_length ) + 1 ); pd->entry_list = g_realloc ( pd->entry_list, nl * sizeof ( *( pd->entry_list ) ) ); pd->entry_list[pd->cmd_list_length].id = g_strdup ( id ); pd->entry_list[pd->cmd_list_length].root = g_strdup ( root ); pd->entry_list[pd->cmd_list_length].path = g_strdup ( path ); pd->entry_list[pd->cmd_list_length].terminal = FALSE; gchar *n = g_key_file_get_locale_string ( kf, "Desktop Entry", "Name", NULL, NULL ); pd->entry_list[pd->cmd_list_length].name = n; gchar *gn = g_key_file_get_locale_string ( kf, "Desktop Entry", "GenericName", NULL, NULL ); pd->entry_list[pd->cmd_list_length].generic_name = gn; pd->entry_list[pd->cmd_list_length].exec = g_key_file_get_string ( kf, "Desktop Entry", "Exec", NULL ); if ( g_key_file_has_key ( kf, "Desktop Entry", "Terminal", NULL ) ) { pd->entry_list[pd->cmd_list_length].terminal = g_key_file_get_boolean ( kf, "Desktop Entry", "Terminal", NULL ); } ( pd->cmd_list_length )++; } g_key_file_free ( kf ); } /** * Internal spider used to get list of executables. */ static void walk_dir ( DRunModePrivateData *pd, const char *root, const char *dirname ) { DIR *dir; g_log ( LOG_DOMAIN, G_LOG_LEVEL_DEBUG, "Checking directory %s for desktop files.", root ); dir = opendir ( dirname ); if ( dir == NULL ) { return; } struct dirent *file; gchar *filename = NULL; struct stat st; while ( ( file = readdir ( dir ) ) != NULL ) { if ( file->d_name[0] == '.' ) { continue; } // Skip files not ending on .desktop. if ( !g_str_has_suffix ( file->d_name, ".desktop" ) ) { continue; } switch ( file->d_type ) { case DT_LNK: case DT_REG: case DT_DIR: case DT_UNKNOWN: filename = g_build_filename ( dirname, file->d_name, NULL ); break; default: continue; } // On a link, or if FS does not support providing this information // Fallback to stat method. if ( file->d_type == DT_LNK || file->d_type == DT_UNKNOWN ) { file->d_type = DT_UNKNOWN; if ( stat ( filename, &st ) == 0 ) { if ( S_ISDIR ( st.st_mode ) ) { file->d_type = DT_DIR; } else if ( S_ISREG ( st.st_mode ) ) { file->d_type = DT_REG; } } } switch ( file->d_type ) { case DT_REG: read_desktop_file ( pd, root, filename ); break; case DT_DIR: walk_dir ( pd, root, filename ); break; default: break; } g_free ( filename ); } closedir ( dir ); } /** * @param entry The command entry to remove from history * * Remove command from history. */ static void delete_entry_history ( const DRunModeEntry *entry ) { char *path = g_build_filename ( cache_dir, DRUN_CACHE_FILE, NULL ); history_remove ( path, entry->path ); g_free ( path ); } static void get_apps_history ( DRunModePrivateData *pd ) { unsigned int length = 0; gchar *path = g_build_filename ( cache_dir, DRUN_CACHE_FILE, NULL ); gchar **retv = history_get_list ( path, &length ); g_free ( path ); for ( unsigned int index = 0; index < length; index++ ) { char **st = g_strsplit ( retv[index], ":::", 2 ); if ( st && st[0] && st[1] ) { read_desktop_file ( pd, st[0], st[1] ); } g_strfreev ( st ); } g_free ( retv ); pd->history_length = pd->cmd_list_length; } static void get_apps ( DRunModePrivateData *pd ) { get_apps_history ( pd ); gchar *dir; // First read the user directory. dir = g_build_filename ( g_get_user_data_dir (), "applications", NULL ); walk_dir ( pd, dir, dir ); g_free ( dir ); // Then read thee system data dirs. const gchar * const * sys = g_get_system_data_dirs (); for (; *sys != NULL; ++sys ) { dir = g_build_filename ( *sys, "applications", NULL ); walk_dir ( pd, dir, dir ); g_free ( dir ); } } static int drun_mode_init ( Mode *sw ) { if ( mode_get_private_data ( sw ) == NULL ) { DRunModePrivateData *pd = g_malloc0 ( sizeof ( *pd ) ); mode_set_private_data ( sw, (void *) pd ); get_apps ( pd ); } return TRUE; } static void drun_entry_clear ( DRunModeEntry *e ) { g_free ( e->root ); g_free ( e->path ); g_free ( e->exec ); g_free ( e->name ); g_free ( e->generic_name ); } static ModeMode drun_mode_result ( Mode *sw, int mretv, char **input, unsigned int selected_line ) { DRunModePrivateData *rmpd = (DRunModePrivateData *) mode_get_private_data ( sw ); ModeMode retv = MODE_EXIT; gboolean run_in_term = ( ( mretv & MENU_CUSTOM_ACTION ) == MENU_CUSTOM_ACTION ); if ( mretv & MENU_NEXT ) { retv = NEXT_DIALOG; } else if ( mretv & MENU_PREVIOUS ) { retv = PREVIOUS_DIALOG; } else if ( mretv & MENU_QUICK_SWITCH ) { retv = ( mretv & MENU_LOWER_MASK ); } else if ( ( mretv & MENU_OK ) ) { exec_cmd_entry ( &( rmpd->entry_list[selected_line] ) ); } else if ( ( mretv & MENU_CUSTOM_INPUT ) && *input != NULL && *input[0] != '\0' ) { exec_cmd ( *input, run_in_term ); } else if ( ( mretv & MENU_ENTRY_DELETE ) && selected_line < rmpd->cmd_list_length ) { if ( selected_line < rmpd->history_length ) { delete_entry_history ( &( rmpd->entry_list[selected_line] ) ); drun_entry_clear ( &( rmpd->entry_list[selected_line] ) ); memmove ( &( rmpd->entry_list[selected_line] ), &rmpd->entry_list[selected_line + 1], sizeof ( DRunModeEntry ) * ( rmpd->cmd_list_length - selected_line - 1 ) ); rmpd->cmd_list_length--; } retv = RELOAD_DIALOG; } return retv; } static void drun_mode_destroy ( Mode *sw ) { DRunModePrivateData *rmpd = (DRunModePrivateData *) mode_get_private_data ( sw ); if ( rmpd != NULL ) { for ( size_t i = 0; i < rmpd->cmd_list_length; i++ ) { drun_entry_clear ( &( rmpd->entry_list[i] ) ); } g_strfreev ( rmpd->disabled_entries ); g_free ( rmpd->entry_list ); g_free ( rmpd ); mode_set_private_data ( sw, NULL ); } } static char *_get_display_value ( const Mode *sw, unsigned int selected_line, int *state, int get_entry ) { DRunModePrivateData *pd = (DRunModePrivateData *) mode_get_private_data ( sw ); *state |= MARKUP; if ( !get_entry ) { return NULL; } if ( pd->entry_list == NULL ) { // Should never get here. return g_strdup ( "Failed" ); } /* Free temp storage. */ DRunModeEntry *dr = &( pd->entry_list[selected_line] ); if ( dr->generic_name == NULL ) { return g_markup_escape_text ( dr->name, -1 ); } else { return g_markup_printf_escaped ( "%s (%s)", dr->name, dr->generic_name ); } } static char *drun_get_completion ( const Mode *sw, unsigned int index ) { DRunModePrivateData *pd = (DRunModePrivateData *) mode_get_private_data ( sw ); /* Free temp storage. */ DRunModeEntry *dr = &( pd->entry_list[index] ); if ( dr->generic_name == NULL ) { return g_strdup ( dr->name ); } else { return g_strdup_printf ( "%s", dr->name ); } } static int drun_token_match ( const Mode *data, GRegex **tokens, unsigned int index ) { DRunModePrivateData *rmpd = (DRunModePrivateData *) mode_get_private_data ( data ); int match = 1; if ( tokens ) { for ( int j = 0; match && tokens != NULL && tokens[j] != NULL; j++ ) { int test = 0; GRegex *ftokens[2] = { tokens[j], NULL }; if ( !test && rmpd->entry_list[index].name && token_match ( ftokens, rmpd->entry_list[index].name ) ) { test = 1; } if ( !test && rmpd->entry_list[index].generic_name && token_match ( ftokens, rmpd->entry_list[index].generic_name ) ) { test = 1; } if ( !test && token_match ( ftokens, rmpd->entry_list[index].exec ) ) { test = 1; } if ( test == 0 ) { match = 0; } } } return match; } static unsigned int drun_mode_get_num_entries ( const Mode *sw ) { const DRunModePrivateData *pd = (const DRunModePrivateData *) mode_get_private_data ( sw ); return pd->cmd_list_length; } #include "mode-private.h" Mode drun_mode = { .name = "drun", .cfg_name_key = "display-drun", ._init = drun_mode_init, ._get_num_entries = drun_mode_get_num_entries, ._result = drun_mode_result, ._destroy = drun_mode_destroy, ._token_match = drun_token_match, ._get_completion = drun_get_completion, ._get_display_value = _get_display_value, ._preprocess_input = NULL, .private_data = NULL, .free = NULL }; #endif // ENABLE_DRUN