2 User Menu implementation
4 Copyright (C) 1994-2015
5 Free Software Foundation, Inc.
8 Slava Zanko <slavazanko@gmail.com>, 2013
9 Andrew Borodin <aborodin@vmail.ru>, 2013
11 This file is part of the Midnight Commander.
13 The Midnight Commander is free software: you can redistribute it
14 and/or modify it under the terms of the GNU General Public License as
15 published by the Free Software Foundation, either version 3 of the License,
16 or (at your option) any later version.
18 The Midnight Commander is distributed in the hope that it will be useful,
19 but WITHOUT ANY WARRANTY; without even the implied warranty of
20 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
21 GNU General Public License for more details.
23 You should have received a copy of the GNU General Public License
24 along with this program. If not, see <http://www.gnu.org/licenses/>.
28 * \brief Source: user menu implementation
39 #include "lib/global.h"
40 #include "lib/tty/tty.h"
42 #include "lib/search.h"
43 #include "lib/vfs/vfs.h"
44 #include "lib/strutil.h"
46 #include "lib/widget.h"
48 #include "src/editor/edit.h" /* WEdit, BLOCK_FILE */
49 #include "src/viewer/mcviewer.h" /* for default_* externs */
51 #include "src/execute.h"
52 #include "src/setup.h"
53 #include "src/history.h"
61 /*** global variables ****************************************************************************/
63 /*** file scope macro definitions ****************************************************************/
65 #define MAX_ENTRIES 16
66 #define MAX_ENTRY_LEN 60
68 /*** file scope type declarations ****************************************************************/
70 /*** file scope variables ************************************************************************/
72 static int debug_flag
= 0;
73 static int debug_error
= 0;
74 static char *menu
= NULL
;
76 /*** file scope functions ************************************************************************/
77 /* --------------------------------------------------------------------------------------------- */
79 /** strip file's extension */
89 if (IS_PATH_SEP (*s
) && e
!= NULL
)
90 e
= NULL
; /* '.' in *directory* name */
98 /* --------------------------------------------------------------------------------------------- */
100 * Check for the "shell_patterns" directive. If it's found and valid,
101 * interpret it and move the pointer past the directive. Return the
106 check_patterns (char *p
)
108 static const char def_name
[] = "shell_patterns=";
111 if (strncmp (p
, def_name
, sizeof (def_name
) - 1) != 0)
114 p
+= sizeof (def_name
) - 1;
124 while (*p
== '\n' || *p
== '\t' || *p
== ' ')
129 /* --------------------------------------------------------------------------------------------- */
130 /** Copies a whitespace separated argument from p to arg. Returns the
131 point after argument. */
134 extract_arg (char *p
, char *arg
, int size
)
138 while (*p
&& (*p
== ' ' || *p
== '\t' || *p
== '\n'))
140 /* support quote space .mnu */
141 while (*p
&& (*p
!= ' ' || *(p
- 1) == '\\') && *p
!= '\t' && *p
!= '\n')
143 np
= str_get_next_char (p
);
146 memcpy (arg
, p
, np
- p
);
152 if (!*p
|| *p
== '\n')
157 /* --------------------------------------------------------------------------------------------- */
158 /* Tests whether the selected file in the panel is of any of the types
159 specified in argument. */
162 test_type (WPanel
* panel
, char *arg
)
164 int result
= 0; /* False by default */
165 int st_mode
= panel
->dir
.list
[panel
->selected
].st
.st_mode
;
167 for (; *arg
!= 0; arg
++)
171 case 'n': /* Not a directory */
172 result
|= !S_ISDIR (st_mode
);
174 case 'r': /* Regular file */
175 result
|= S_ISREG (st_mode
);
177 case 'd': /* Directory */
178 result
|= S_ISDIR (st_mode
);
181 result
|= S_ISLNK (st_mode
);
183 case 'c': /* Character special */
184 result
|= S_ISCHR (st_mode
);
186 case 'b': /* Block special */
187 result
|= S_ISBLK (st_mode
);
189 case 'f': /* Fifo (named pipe) */
190 result
|= S_ISFIFO (st_mode
);
192 case 's': /* Socket */
193 result
|= S_ISSOCK (st_mode
);
195 case 'x': /* Executable */
196 result
|= (st_mode
& 0111) ? 1 : 0;
199 result
|= panel
->marked
? 1 : 0;
209 /* --------------------------------------------------------------------------------------------- */
210 /** Calculates the truth value of the next condition starting from
211 p. Returns the point after condition. */
214 test_condition (WEdit
* edit_widget
, char *p
, int *condition
)
217 const mc_search_type_t search_type
= easy_patterns
? MC_SEARCH_T_GLOB
: MC_SEARCH_T_REGEX
;
219 /* Handle one condition */
220 for (; *p
!= '\n' && *p
!= '&' && *p
!= '|'; p
++)
222 WPanel
*panel
= NULL
;
224 /* support quote space .mnu */
225 if ((*p
== ' ' && *(p
- 1) != '\\') || *p
== '\t')
228 panel
= current_panel
;
229 else if (get_other_type () == view_listing
)
237 p
= test_condition (edit_widget
, p
, condition
);
238 *condition
= !*condition
;
241 case 'f': /* file name pattern */
242 p
= extract_arg (p
, arg
, sizeof (arg
));
243 #ifdef USE_INTERNAL_EDIT
244 if (edit_widget
!= NULL
)
248 edit_filename
= edit_get_file_name (edit_widget
);
249 *condition
= mc_search (arg
, DEFAULT_CHARSET
, edit_filename
, search_type
) ? 1 : 0;
250 g_free (edit_filename
);
254 *condition
= panel
!= NULL
&&
255 mc_search (arg
, DEFAULT_CHARSET
, panel
->dir
.list
[panel
->selected
].fname
,
256 search_type
) ? 1 : 0;
258 case 'y': /* syntax pattern */
259 #ifdef USE_INTERNAL_EDIT
260 if (edit_widget
!= NULL
)
262 const char *syntax_type
= edit_get_syntax_type (edit_widget
);
263 if (syntax_type
!= NULL
)
265 p
= extract_arg (p
, arg
, sizeof (arg
));
267 mc_search (arg
, DEFAULT_CHARSET
, syntax_type
, MC_SEARCH_T_NORMAL
) ? 1 : 0;
273 p
= extract_arg (p
, arg
, sizeof (arg
));
274 *condition
= panel
!= NULL
275 && mc_search (arg
, DEFAULT_CHARSET
, vfs_path_as_str (panel
->cwd_vpath
),
276 search_type
) ? 1 : 0;
279 p
= extract_arg (p
, arg
, sizeof (arg
));
280 *condition
= panel
!= NULL
&& test_type (panel
, arg
) ? 1 : 0;
282 case 'x': /* executable */
286 p
= extract_arg (p
, arg
, sizeof (arg
));
287 if (stat (arg
, &status
) == 0)
288 *condition
= is_exe (status
.st_mode
) ? 1 : 0;
302 /* --------------------------------------------------------------------------------------------- */
303 /** General purpose condition debug output handler */
306 debug_out (char *start
, char *end
, int cond
)
310 if (start
== NULL
&& end
== NULL
)
313 if (debug_flag
&& msg
)
320 message (D_NORMAL
, _("Debug"), "%s", msg
);
331 /* Save debug info for later output */
334 /* Save the result of the condition */
344 /* This is for debugging, don't need to be super efficient. */
346 p
= g_strdup_printf ("%s %s %c \n", msg
? msg
: "", type
, *start
);
348 p
= g_strdup_printf ("%s %s %.*s \n", msg
? msg
: "", type
, (int) (end
- start
), start
);
354 /* --------------------------------------------------------------------------------------------- */
355 /** Calculates the truth value of one lineful of conditions. Returns
356 the point just before the end of line. */
359 test_line (WEdit
* edit_widget
, char *p
, int *result
)
364 /* Repeat till end of line */
365 while (*p
&& *p
!= '\n')
367 char *debug_start
, *debug_end
;
369 /* support quote space .mnu */
370 while ((*p
== ' ' && *(p
- 1) != '\\') || *p
== '\t')
372 if (!*p
|| *p
== '\n')
380 /* support quote space .mnu */
381 while ((*p
== ' ' && *(p
- 1) != '\\') || *p
== '\t')
383 if (!*p
|| *p
== '\n')
385 condition
= 1; /* True by default */
388 p
= test_condition (edit_widget
, p
, &condition
);
390 /* Add one debug statement */
391 debug_out (debug_start
, debug_end
, condition
);
400 case '&': /* Logical and */
401 *result
&= condition
;
403 case '|': /* Logical or */
404 *result
|= condition
;
410 /* Add one debug statement */
411 debug_out (&operator, NULL
, *result
);
413 } /* while (*p != '\n') */
414 /* Report debug message */
415 debug_out (NULL
, NULL
, 1);
417 if (!*p
|| *p
== '\n')
422 /* --------------------------------------------------------------------------------------------- */
423 /** FIXME: recode this routine on version 3.0, it could be cleaner */
426 execute_menu_command (WEdit
* edit_widget
, const char *commands
, gboolean show_prompt
)
430 int expand_prefix_found
= 0;
432 gboolean do_quote
= FALSE
;
435 vfs_path_t
*file_name_vpath
;
438 /* Skip menu entry title line */
439 commands
= strchr (commands
, '\n');
445 cmd_file_fd
= mc_mkstemps (&file_name_vpath
, "mcusr", SCRIPT_SUFFIX
);
447 if (cmd_file_fd
== -1)
449 message (D_ERROR
, MSG_ERROR
, _("Cannot create temporary command file\n%s"),
450 unix_error_string (errno
));
451 vfs_path_free (file_name_vpath
);
454 cmd_file
= fdopen (cmd_file_fd
, "w");
455 fputs ("#! /bin/sh\n", cmd_file
);
458 for (col
= 0; *commands
; commands
++)
462 if (*commands
!= ' ' && *commands
!= '\t')
464 while (*commands
== ' ' || *commands
== '\t')
470 if (*commands
== '\n')
474 if (*commands
== '}')
478 input_dialog (_("Parameter"), lc_prompt
, MC_HISTORY_FM_MENU_EXEC_PARAM
, "",
479 INPUT_COMPLETE_FILENAMES
| INPUT_COMPLETE_CD
|
480 INPUT_COMPLETE_HOSTNAMES
| INPUT_COMPLETE_VARIABLES
|
481 INPUT_COMPLETE_USERNAMES
);
482 if (!parameter
|| !*parameter
)
486 mc_unlink (file_name_vpath
);
487 vfs_path_free (file_name_vpath
);
494 tmp
= name_quote (parameter
, FALSE
);
495 fputs (tmp
, cmd_file
);
499 fputs (parameter
, cmd_file
);
505 if (parameter
< &lc_prompt
[sizeof (lc_prompt
) - 1])
507 *parameter
++ = *commands
;
511 else if (expand_prefix_found
)
513 expand_prefix_found
= 0;
514 if (g_ascii_isdigit ((gchar
) * commands
))
516 do_quote
= (atoi (commands
) != 0);
517 while (g_ascii_isdigit ((gchar
) * commands
))
520 if (*commands
== '{')
521 parameter
= lc_prompt
;
524 char *text
= expand_format (edit_widget
, *commands
, do_quote
);
525 fputs (text
, cmd_file
);
531 if (*commands
== '%')
533 int i
= check_format_view (commands
+ 1);
541 do_quote
= TRUE
; /* Default: Quote expanded macro */
542 expand_prefix_found
= 1;
546 fputc (*commands
, cmd_file
);
550 mc_chmod (file_name_vpath
, S_IRWXU
);
553 mcview_viewer (vfs_path_as_str (file_name_vpath
), NULL
, 0, 0, 0);
554 dialog_switch_process_pending ();
558 /* execute the command indirectly to allow execution even
559 * on no-exec filesystems. */
562 cmd
= g_strconcat ("/bin/sh ", vfs_path_as_str (file_name_vpath
), (char *) NULL
);
565 if (system (cmd
) == -1)
566 message (D_ERROR
, MSG_ERROR
, "%s", _("Error calling program"));
570 shell_execute (cmd
, EXECUTE_HIDE
);
574 mc_unlink (file_name_vpath
);
575 vfs_path_free (file_name_vpath
);
578 /* --------------------------------------------------------------------------------------------- */
580 ** Check owner of the menu file. Using menu file is allowed, if
581 ** owner of the menu is root or the actual user. In either case
582 ** file should not be group and word-writable.
584 ** Q. Should we apply this routine to system and home menu (and .ext files)?
588 menu_file_own (char *path
)
592 if (stat (path
, &st
) == 0
593 && (!st
.st_uid
|| (st
.st_uid
== geteuid ())) && ((st
.st_mode
& (S_IWGRP
| S_IWOTH
)) == 0))
599 message (D_NORMAL
, _("Warning -- ignoring file"),
600 _("File %s is not owned by root or you or is world writable.\n"
601 "Using it may compromise your security"), path
);
606 /* --------------------------------------------------------------------------------------------- */
607 /*** public functions ****************************************************************************/
608 /* --------------------------------------------------------------------------------------------- */
612 %f The current file (if non-local vfs, file will be copied locally and
613 %f will be full path to it).
615 %d The current working directory
616 %s "Selected files"; the tagged files if any, otherwise the current file
618 %u Tagged files (and they are untagged on return from expand_format)
619 %view Runs the commands and pipes standard output to the view command.
620 If %view is immediately followed by '{', recognize keywords
621 ascii, hex, nroff and unform
623 If the format letter is in uppercase, it refers to the other panel.
625 With a number followed the % character you can turn quoting on (default)
626 and off. For example:
627 %f quote expanded macro
629 %0f don't quote expanded macro
631 expand_format returns a memory block that must be free()d.
634 /* Returns how many characters we should advance if %view was found */
636 check_format_view (const char *p
)
639 if (!strncmp (p
, "view", 4))
644 for (q
++; *q
&& *q
!= '}'; q
++)
646 if (!strncmp (q
, DEFAULT_CHARSET
, 5))
648 mcview_default_hex_mode
= 0;
651 else if (!strncmp (q
, "hex", 3))
653 mcview_default_hex_mode
= 1;
656 else if (!strncmp (q
, "nroff", 5))
658 mcview_default_nroff_flag
= 1;
661 else if (!strncmp (q
, "unform", 6))
663 mcview_default_nroff_flag
= 0;
675 /* --------------------------------------------------------------------------------------------- */
678 check_format_cd (const char *p
)
680 return (strncmp (p
, "cd", 2)) ? 0 : 3;
683 /* --------------------------------------------------------------------------------------------- */
684 /* Check if p has a "^var\{var-name\}" */
685 /* Returns the number of skipped characters (zero on not found) */
686 /* V will be set to the expanded variable name */
689 check_format_var (const char *p
, char **v
)
695 if (!strncmp (p
, "var{", 4))
697 const char *dots
= NULL
;
700 for (q
+= 4; *q
&& *q
!= '}'; q
++)
708 if (!dots
|| dots
== q
+ 5)
711 _("Format error on file Extensions File"),
712 !dots
? _("The %%var macro has no default")
713 : _("The %%var macro has no variable"));
717 /* Copy the variable name */
718 var_name
= g_strndup (p
+ 4, dots
- 2 - (p
+ 3));
720 value
= getenv (var_name
);
724 *v
= g_strdup (value
);
727 var_name
= g_strndup (dots
, q
- dots
);
734 /* --------------------------------------------------------------------------------------------- */
737 expand_format (struct WEdit
*edit_widget
, char c
, gboolean do_quote
)
739 WPanel
*panel
= NULL
;
740 char *(*quote_func
) (const char *, gboolean
);
745 #ifndef USE_INTERNAL_EDIT
750 return g_strdup ("%");
752 switch (mc_global
.mc_run_mode
)
755 if (g_ascii_islower ((gchar
) c
))
756 panel
= current_panel
;
759 if (get_other_type () != view_listing
)
760 return g_strdup ("");
763 fname
= g_strdup (panel
->dir
.list
[panel
->selected
].fname
);
766 #ifdef USE_INTERNAL_EDIT
768 fname
= edit_get_file_name (edit_widget
);
773 /* other modes don't use formats */
774 return g_strdup ("");
778 quote_func
= name_quote
;
780 quote_func
= fake_name_quote
;
782 c_lc
= g_ascii_tolower ((gchar
) c
);
788 result
= quote_func (fname
, FALSE
);
791 result
= quote_func (extension (fname
), FALSE
);
799 cwd
= g_strdup (vfs_path_as_str (panel
->cwd_vpath
));
801 cwd
= vfs_get_current_dir ();
803 qstr
= quote_func (cwd
, FALSE
);
810 case 'i': /* indent equal number cursor position in line */
811 #ifdef USE_INTERNAL_EDIT
814 result
= g_strnfill (edit_get_curs_col (edit_widget
), ' ');
819 case 'y': /* syntax type */
820 #ifdef USE_INTERNAL_EDIT
823 const char *syntax_type
= edit_get_syntax_type (edit_widget
);
824 if (syntax_type
!= NULL
)
826 result
= g_strdup (syntax_type
);
832 case 'k': /* block file name */
833 case 'b': /* block file name / strip extension */
835 #ifdef USE_INTERNAL_EDIT
840 file
= mc_config_get_full_path (EDIT_BLOCK_FILE
);
841 result
= quote_func (file
, FALSE
);
848 result
= strip_ext (quote_func (fname
, FALSE
));
853 case 'n': /* strip extension in editor */
854 #ifdef USE_INTERNAL_EDIT
857 result
= strip_ext (quote_func (fname
, FALSE
));
862 case 'm': /* menu file name */
865 result
= quote_func (menu
, FALSE
);
870 if (!panel
|| !panel
->marked
)
872 result
= quote_func (fname
, FALSE
);
886 result
= g_strdup ("");
890 block
= g_string_sized_new (16);
892 for (i
= 0; i
< panel
->dir
.len
; i
++)
893 if (panel
->dir
.list
[i
].f
.marked
)
897 tmp
= quote_func (panel
->dir
.list
[i
].fname
, FALSE
);
898 g_string_append (block
, tmp
);
899 g_string_append_c (block
, ' ');
903 do_file_mark (panel
, i
, 0);
905 result
= g_string_free (block
, FALSE
);
907 } /* sub case block */
912 result
= g_strdup ("% ");
919 /* --------------------------------------------------------------------------------------------- */
921 * If edit_widget is NULL then we are called from the mc menu,
922 * otherwise we are called from the mcedit menu.
926 user_menu_cmd (struct WEdit
* edit_widget
, const char *menu_file
, int selected_entry
)
929 char *data
, **entries
;
930 int max_cols
, menu_lines
, menu_limit
;
931 int col
, i
, accept_entry
= 1;
932 int selected
, old_patterns
;
933 gboolean res
= FALSE
;
934 gboolean interactive
= TRUE
;
936 if (!vfs_current_is_local ())
938 message (D_ERROR
, MSG_ERROR
, "%s", _("Cannot execute commands on non-local filesystems"));
941 if (menu_file
!= NULL
)
942 menu
= g_strdup (menu_file
);
944 menu
= g_strdup (edit_widget
? EDIT_LOCAL_MENU
: MC_LOCAL_MENU
);
945 if (!exist_file (menu
) || !menu_file_own (menu
))
947 if (menu_file
!= NULL
)
949 message (D_ERROR
, MSG_ERROR
, _("Cannot open file %s\n%s"), menu
,
950 unix_error_string (errno
));
957 menu
= mc_config_get_full_path (EDIT_HOME_MENU
);
959 menu
= mc_config_get_full_path (MC_USERMENU_FILE
);
962 if (!exist_file (menu
))
966 mc_build_filename (mc_config_get_home_dir (),
967 edit_widget
? EDIT_GLOBAL_MENU
: MC_GLOBAL_MENU
, NULL
);
968 if (!exist_file (menu
))
972 mc_build_filename (mc_global
.sysconfig_dir
,
973 edit_widget
? EDIT_GLOBAL_MENU
: MC_GLOBAL_MENU
, NULL
);
974 if (!exist_file (menu
))
977 menu
= mc_build_filename
978 (mc_global
.share_data_dir
, edit_widget
? EDIT_GLOBAL_MENU
: MC_GLOBAL_MENU
,
985 if (!g_file_get_contents (menu
, &data
, NULL
, NULL
))
987 message (D_ERROR
, MSG_ERROR
, _("Cannot open file %s\n%s"), menu
, unix_error_string (errno
));
997 /* Parse the menu file */
998 old_patterns
= easy_patterns
;
999 p
= check_patterns (data
);
1000 for (menu_lines
= col
= 0; *p
; str_next_char (&p
))
1002 if (menu_lines
>= menu_limit
)
1006 menu_limit
+= MAX_ENTRIES
;
1007 new_entries
= g_try_realloc (entries
, sizeof (new_entries
[0]) * menu_limit
);
1009 if (new_entries
== NULL
)
1012 entries
= new_entries
;
1013 new_entries
+= menu_limit
;
1014 while (--new_entries
>= &entries
[menu_lines
])
1015 *new_entries
= NULL
;
1017 if (col
== 0 && !entries
[menu_lines
])
1021 /* show prompt if first line of external script is #interactive */
1022 if (selected_entry
>= 0 && strncmp (p
, "#silent", 7) == 0)
1023 interactive
= FALSE
;
1024 /* A commented menu entry */
1029 if (*(p
+ 1) == '=')
1031 /* Combined adding and default */
1032 p
= test_line (edit_widget
, p
+ 1, &accept_entry
);
1033 if (selected
== 0 && accept_entry
)
1034 selected
= menu_lines
;
1038 /* A condition for adding the entry */
1039 p
= test_line (edit_widget
, p
, &accept_entry
);
1044 if (*(p
+ 1) == '+')
1046 /* Combined adding and default */
1047 p
= test_line (edit_widget
, p
+ 1, &accept_entry
);
1048 if (selected
== 0 && accept_entry
)
1049 selected
= menu_lines
;
1053 /* A condition for making the entry default */
1055 p
= test_line (edit_widget
, p
, &i
);
1056 if (selected
== 0 && i
)
1057 selected
= menu_lines
;
1060 else if (*p
!= ' ' && *p
!= '\t' && str_isprint (p
))
1062 /* A menu entry title line */
1064 entries
[menu_lines
] = p
;
1071 if (entries
[menu_lines
])
1076 max_cols
= max (max_cols
, col
);
1087 if (menu_lines
== 0)
1089 message (D_ERROR
, MSG_ERROR
, _("No suitable entries found in %s"), menu
);
1094 if (selected_entry
>= 0)
1095 selected
= selected_entry
;
1100 max_cols
= min (max (max_cols
, col
), MAX_ENTRY_LEN
);
1102 /* Create listbox */
1103 listbox
= create_listbox_window (menu_lines
, max_cols
+ 2, _("User menu"),
1104 "[Edit Menu File]");
1105 /* insert all the items found */
1106 for (i
= 0; i
< menu_lines
; i
++)
1109 LISTBOX_APPEND_TEXT (listbox
, (unsigned char) p
[0],
1110 extract_line (p
, p
+ MAX_ENTRY_LEN
), p
, FALSE
);
1112 /* Select the default entry */
1113 listbox_select_entry (listbox
->list
, selected
);
1115 selected
= run_listbox (listbox
);
1119 execute_menu_command (edit_widget
, entries
[selected
], interactive
);
1126 easy_patterns
= old_patterns
;
1133 /* --------------------------------------------------------------------------------------------- */