1 /* User Menu implementation
2 Copyright (C) 1994, 1998, 1999, 2000, 2001, 2002, 2003, 2004, 2005,
3 2006, 2007 Free Software Foundation, Inc.
5 This program is free software; you can redistribute it and/or modify
6 it under the terms of the GNU General Public License as published by
7 the Free Software Foundation; either version 2 of the License, or
8 (at your option) any later version.
10 This program is distributed in the hope that it will be useful,
11 but WITHOUT ANY WARRANTY; without even the implied warranty of
12 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 GNU General Public License for more details.
15 You should have received a copy of the GNU General Public License
16 along with this program; if not, write to the Free Software
17 Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. */
20 * \brief Source: user menu implementation
31 #include "lib/global.h"
32 #include "lib/tty/tty.h"
34 #include "lib/search.h"
35 #include "lib/vfs/mc-vfs/vfs.h"
36 #include "lib/strutil.h"
38 #include "src/editor/edit.h" /* WEdit, BLOCK_FILE */
39 #include "src/viewer/mcviewer.h" /* for default_* externs */
51 /* For the simple listbox manager */
56 #define MAX_ENTRIES 16
57 #define MAX_ENTRY_LEN 60
59 static int debug_flag
= 0;
60 static int debug_error
= 0;
61 static char *menu
= NULL
;
65 %f The current file (if non-local vfs, file will be copied locally and
66 %f will be full path to it).
68 %d The current working directory
69 %s "Selected files"; the tagged files if any, otherwise the current file
71 %u Tagged files (and they are untagged on return from expand_format)
72 %view Runs the commands and pipes standard output to the view command.
73 If %view is immediately followed by '{', recognize keywords
74 ascii, hex, nroff and unform
76 If the format letter is in uppercase, it refers to the other panel.
78 With a number followed the % character you can turn quoting on (default)
80 %f quote expanded macro
82 %0f don't quote expanded macro
84 expand_format returns a memory block that must be free()d.
87 /* Returns how many characters we should advance if %view was found */
88 int check_format_view (const char *p
)
91 if (!strncmp (p
, "view", 4)) {
94 for (q
++;*q
&& *q
!= '}';q
++) {
95 if (!strncmp (q
, "ascii", 5)) {
96 mcview_default_hex_mode
= 0;
98 } else if (!strncmp (q
, "hex", 3)) {
99 mcview_default_hex_mode
= 1;
101 } else if (!strncmp (q
, "nroff", 5)) {
102 mcview_default_nroff_flag
= 1;
104 } else if (!strncmp (q
, "unform", 6)) {
105 mcview_default_nroff_flag
= 0;
117 int check_format_cd (const char *p
)
119 return (strncmp (p
, "cd", 2)) ? 0 : 3;
122 /* Check if p has a "^var\{var-name\}" */
123 /* Returns the number of skipped characters (zero on not found) */
124 /* V will be set to the expanded variable name */
125 int check_format_var (const char *p
, char **v
)
130 const char *dots
= 0;
133 if (!strncmp (p
, "var{", 4)){
134 for (q
+= 4; *q
&& *q
!= '}'; q
++){
141 if (!dots
|| dots
== q
+5){
143 _(" Format error on file Extensions File "),
144 !dots
? _(" The %%var macro has no default ")
145 : _(" The %%var macro has no variable "));
149 /* Copy the variable name */
150 var_name
= g_strndup (p
+ 4, dots
-2 - (p
+3));
152 value
= getenv (var_name
);
155 *v
= g_strdup (value
);
158 var_name
= g_strndup (dots
, q
- dots
);
165 /* strip file's extension */
169 register char *s
= ss
;
173 if(*s
== PATH_SEP
&& e
) e
=NULL
; /* '.' in *directory* name */
181 expand_format (struct WEdit
*edit_widget
, char c
, gboolean do_quote
)
183 WPanel
*panel
= NULL
;
184 char *(*quote_func
) (const char *, int);
189 #ifndef USE_INTERNAL_EDIT
194 return g_strdup ("%");
196 if (edit_one_file
== NULL
) {
197 if (g_ascii_islower ((gchar
) c
))
198 panel
= current_panel
;
200 if (get_other_type () != view_listing
)
201 return g_strdup ("");
204 fname
= panel
->dir
.list
[panel
->selected
].fname
;
206 #ifdef USE_INTERNAL_EDIT
208 fname
= str_unconst (edit_get_file_name (edit_widget
));
212 quote_func
= name_quote
;
214 quote_func
= fake_name_quote
;
216 c_lc
= g_ascii_tolower ((gchar
) c
);
221 return (*quote_func
) (fname
, 0);
223 return (*quote_func
) (extension (fname
), 0);
229 cwd
= g_malloc(MC_MAXPATHLEN
+ 1);
232 g_strlcpy(cwd
, panel
->cwd
, MC_MAXPATHLEN
+ 1);
234 mc_get_current_wd(cwd
, MC_MAXPATHLEN
+ 1);
236 qstr
= (*quote_func
) (cwd
, 0);
242 case 'i': /* indent equal number cursor position in line */
243 #ifdef USE_INTERNAL_EDIT
245 return g_strnfill (edit_get_curs_col (edit_widget
), ' ');
248 case 'y': /* syntax type */
249 #ifdef USE_INTERNAL_EDIT
251 const char *syntax_type
= edit_get_syntax_type (edit_widget
);
252 if (syntax_type
!= NULL
)
253 return g_strdup (syntax_type
);
257 case 'k': /* block file name */
258 case 'b': /* block file name / strip extension */ {
259 #ifdef USE_INTERNAL_EDIT
261 char *file
= concat_dir_and_file (home_dir
, EDIT_BLOCK_FILE
);
262 fname
= (*quote_func
) (file
, 0);
268 return strip_ext ((*quote_func
) (fname
, 0));
271 case 'n': /* strip extension in editor */
272 #ifdef USE_INTERNAL_EDIT
274 return strip_ext ((*quote_func
) (fname
, 0));
277 case 'm': /* menu file name */
279 return (*quote_func
) (menu
, 0);
282 if (!panel
|| !panel
->marked
)
283 return (*quote_func
) (fname
, 0);
294 return g_strdup ("");
296 for (i
= 0; i
< panel
->count
; i
++)
297 if (panel
->dir
.list
[i
].f
.marked
)
298 length
+= strlen (panel
->dir
.list
[i
].fname
) + 1; /* for space */
300 block
= g_malloc (length
* 2 + 1);
302 for (i
= 0; i
< panel
->count
; i
++)
303 if (panel
->dir
.list
[i
].f
.marked
) {
305 (*quote_func
) (panel
->dir
.list
[i
].fname
, 0));
309 do_file_mark (panel
, i
, 0);
312 } /* sub case block */
314 result
= g_strdup ("% ");
320 * Check for the "shell_patterns" directive. If it's found and valid,
321 * interpret it and move the pointer past the directive. Return the
325 check_patterns (char *p
)
327 static const char def_name
[] = "shell_patterns=";
330 if (strncmp (p
, def_name
, sizeof (def_name
) - 1) != 0)
333 p
+= sizeof (def_name
) - 1;
343 while (*p
== '\n' || *p
== '\t' || *p
== ' ')
348 /* Copies a whitespace separated argument from p to arg. Returns the
349 point after argument. */
350 static char *extract_arg (char *p
, char *arg
, int size
)
354 while (*p
&& (*p
== ' ' || *p
== '\t' || *p
== '\n'))
356 /* support quote space .mnu */
357 while (*p
&& (*p
!= ' ' || *(p
-1) == '\\') && *p
!= '\t' && *p
!= '\n') {
358 np
= str_get_next_char (p
);
359 if (np
- p
>= size
) break;
360 memcpy (arg
, p
, np
- p
);
366 if (!*p
|| *p
== '\n')
371 /* Tests whether the selected file in the panel is of any of the types
372 specified in argument. */
373 static int test_type (WPanel
*panel
, char *arg
)
375 int result
= 0; /* False by default */
376 int st_mode
= panel
->dir
.list
[panel
->selected
].st
.st_mode
;
378 for (;*arg
!= 0; arg
++){
380 case 'n': /* Not a directory */
381 result
|= !S_ISDIR (st_mode
);
383 case 'r': /* Regular file */
384 result
|= S_ISREG (st_mode
);
386 case 'd': /* Directory */
387 result
|= S_ISDIR (st_mode
);
390 result
|= S_ISLNK (st_mode
);
392 case 'c': /* Character special */
393 result
|= S_ISCHR (st_mode
);
395 case 'b': /* Block special */
396 result
|= S_ISBLK (st_mode
);
398 case 'f': /* Fifo (named pipe) */
399 result
|= S_ISFIFO (st_mode
);
401 case 's': /* Socket */
402 result
|= S_ISSOCK (st_mode
);
404 case 'x': /* Executable */
405 result
|= (st_mode
& 0111) ? 1 : 0;
408 result
|= panel
->marked
? 1 : 0;
418 /* Calculates the truth value of the next condition starting from
419 p. Returns the point after condition. */
421 test_condition (WEdit
*edit_widget
, char *p
, int *condition
)
425 mc_search_type_t search_type
;
428 search_type
= MC_SEARCH_T_GLOB
;
430 search_type
= MC_SEARCH_T_REGEX
;
433 /* Handle one condition */
434 for (;*p
!= '\n' && *p
!= '&' && *p
!= '|'; p
++){
435 /* support quote space .mnu */
436 if ((*p
== ' ' && *(p
-1) != '\\') || *p
== '\t')
439 panel
= current_panel
;
441 if (get_other_type () == view_listing
)
450 p
= test_condition (edit_widget
, p
, condition
);
451 *condition
= ! *condition
;
454 case 'f': /* file name pattern */
455 p
= extract_arg (p
, arg
, sizeof (arg
));
456 *condition
= panel
&& mc_search (arg
, panel
->dir
.list
[panel
->selected
].fname
, search_type
);
458 case 'y': /* syntax pattern */
459 #ifdef USE_INTERNAL_EDIT
461 const char *syntax_type
= edit_get_syntax_type (edit_widget
);
462 if (syntax_type
!= NULL
) {
463 p
= extract_arg (p
, arg
, sizeof (arg
));
464 *condition
= panel
&& mc_search (arg
, syntax_type
, MC_SEARCH_T_NORMAL
);
470 p
= extract_arg (p
, arg
, sizeof (arg
));
471 *condition
= panel
&& mc_search (arg
, panel
->cwd
, search_type
);
474 p
= extract_arg (p
, arg
, sizeof (arg
));
475 *condition
= panel
&& test_type (panel
, arg
);
477 case 'x': /* executable */
481 p
= extract_arg (p
, arg
, sizeof (arg
));
482 if (stat (arg
, &status
) == 0)
483 *condition
= is_exe (status
.st_mode
);
497 /* General purpose condition debug output handler */
499 debug_out (char *start
, char *end
, int cond
)
504 if (start
== NULL
&& end
== NULL
){
506 if (debug_flag
&& msg
) {
510 message (D_NORMAL
, _(" Debug "), "%s", msg
);
520 /* Save debug info for later output */
523 /* Save the result of the condition */
525 type
= _(" ERROR: ");
531 type
= _(" False: ");
532 /* This is for debugging, don't need to be super efficient. */
534 p
= g_strdup_printf ("%s%s%c \n", msg
? msg
: "", type
, *start
);
536 p
= g_strdup_printf ("%s%s%.*s \n", msg
? msg
: "", type
,
537 (int) (end
- start
), start
);
543 /* Calculates the truth value of one lineful of conditions. Returns
544 the point just before the end of line. */
546 test_line (WEdit
*edit_widget
, char *p
, int *result
)
550 char *debug_start
, *debug_end
;
552 /* Repeat till end of line */
553 while (*p
&& *p
!= '\n') {
554 /* support quote space .mnu */
555 while ((*p
== ' ' && *(p
-1) != '\\' ) || *p
== '\t')
557 if (!*p
|| *p
== '\n')
564 /* support quote space .mnu */
565 while ((*p
== ' ' && *(p
-1) != '\\' ) || *p
== '\t')
567 if (!*p
|| *p
== '\n')
569 condition
= 1; /* True by default */
572 p
= test_condition (edit_widget
, p
, &condition
);
574 /* Add one debug statement */
575 debug_out (debug_start
, debug_end
, condition
);
583 case '&': /* Logical and */
584 *result
&= condition
;
586 case '|': /* Logical or */
587 *result
|= condition
;
593 /* Add one debug statement */
594 debug_out (&operator, NULL
, *result
);
596 } /* while (*p != '\n') */
597 /* Report debug message */
598 debug_out (NULL
, NULL
, 1);
600 if (!*p
|| *p
== '\n')
605 /* FIXME: recode this routine on version 3.0, it could be cleaner */
607 execute_menu_command (WEdit
*edit_widget
, const char *commands
)
611 int expand_prefix_found
= 0;
613 gboolean do_quote
= FALSE
;
619 /* Skip menu entry title line */
620 commands
= strchr (commands
, '\n');
625 cmd_file_fd
= mc_mkstemps (&file_name
, "mcusr", SCRIPT_SUFFIX
);
627 if (cmd_file_fd
== -1){
628 message (D_ERROR
, MSG_ERROR
, _(" Cannot create temporary command file \n %s "),
629 unix_error_string (errno
));
632 cmd_file
= fdopen (cmd_file_fd
, "w");
633 fputs ("#! /bin/sh\n", cmd_file
);
636 for (col
= 0; *commands
; commands
++){
638 if (*commands
!= ' ' && *commands
!= '\t')
640 while (*commands
== ' ' || *commands
== '\t')
646 if (*commands
== '\n')
649 if (*commands
== '}'){
652 parameter
= input_dialog (_(" Parameter "), lc_prompt
, MC_HISTORY_FM_MENU_EXEC_PARAM
, "");
653 if (!parameter
|| !*parameter
){
661 tmp
= name_quote (parameter
, 0);
662 fputs (tmp
, cmd_file
);
665 fputs (parameter
, cmd_file
);
669 if (parameter
< &lc_prompt
[sizeof (lc_prompt
) - 1]) {
670 *parameter
++ = *commands
;
673 } else if (expand_prefix_found
){
674 expand_prefix_found
= 0;
675 if (g_ascii_isdigit ((gchar
) *commands
)) {
676 do_quote
= (atoi (commands
) != 0);
677 while (g_ascii_isdigit ((gchar
) *commands
))
680 if (*commands
== '{')
681 parameter
= lc_prompt
;
683 char *text
= expand_format (edit_widget
, *commands
, do_quote
);
684 fputs (text
, cmd_file
);
688 if (*commands
== '%') {
689 int i
= check_format_view (commands
+ 1);
694 do_quote
= TRUE
; /* Default: Quote expanded macro */
695 expand_prefix_found
= 1;
698 fputc (*commands
, cmd_file
);
702 chmod (file_name
, S_IRWXU
);
705 mcview_viewer (file_name
, NULL
, &run_view
, 0);
707 /* execute the command indirectly to allow execution even
708 * on no-exec filesystems. */
709 char *cmd
= g_strconcat("/bin/sh ", file_name
, (char *) NULL
);
710 shell_execute (cmd
, EXECUTE_HIDE
);
718 ** Check owner of the menu file. Using menu file is allowed, if
719 ** owner of the menu is root or the actual user. In either case
720 ** file should not be group and word-writable.
722 ** Q. Should we apply this routine to system and home menu (and .ext files)?
725 menu_file_own(char* path
)
729 if (stat (path
, &st
) == 0
730 && (!st
.st_uid
|| (st
.st_uid
== geteuid ()))
731 && ((st
.st_mode
& (S_IWGRP
| S_IWOTH
)) == 0)
737 message (D_NORMAL
, _(" Warning -- ignoring file "),
738 _("File %s is not owned by root or you or is world writable.\n"
739 "Using it may compromise your security"),
747 * If edit_widget is NULL then we are called from the mc menu,
748 * otherwise we are called from the mcedit menu.
751 user_menu_cmd (struct WEdit
*edit_widget
)
754 char *data
, **entries
;
755 int max_cols
, menu_lines
, menu_limit
;
756 int col
, i
, accept_entry
= 1;
757 int selected
, old_patterns
;
760 if (!vfs_current_is_local ()){
761 message (D_ERROR
, MSG_ERROR
,
762 _(" Cannot execute commands on non-local filesystems"));
766 menu
= g_strdup (edit_widget
? EDIT_LOCAL_MENU
: MC_LOCAL_MENU
);
767 if (!exist_file (menu
) || !menu_file_own (menu
)){
770 menu
= concat_dir_and_file (home_dir
, EDIT_HOME_MENU
);
772 menu
= g_build_filename (home_dir
, MC_USERCONF_DIR
, MC_USERMENU_FILE
, NULL
);
775 if (!exist_file (menu
)){
777 menu
= concat_dir_and_file
778 (mc_home
, edit_widget
? EDIT_GLOBAL_MENU
: MC_GLOBAL_MENU
);
779 if (!exist_file (menu
)) {
781 menu
= concat_dir_and_file
782 (mc_home_alt
, edit_widget
? EDIT_GLOBAL_MENU
: MC_GLOBAL_MENU
);
787 if ((data
= load_file (menu
)) == NULL
){
788 message (D_ERROR
, MSG_ERROR
, _(" Cannot open file %s \n %s "),
789 menu
, unix_error_string (errno
));
800 /* Parse the menu file */
801 old_patterns
= easy_patterns
;
802 p
= check_patterns (data
);
803 for (menu_lines
= col
= 0; *p
; str_next_char (&p
)){
804 if (menu_lines
>= menu_limit
){
807 menu_limit
+= MAX_ENTRIES
;
808 new_entries
= g_try_realloc (entries
, sizeof (new_entries
[0]) * menu_limit
);
810 if (new_entries
== NULL
)
813 entries
= new_entries
;
814 new_entries
+= menu_limit
;
815 while (--new_entries
>= &entries
[menu_lines
])
818 if (col
== 0 && !entries
[menu_lines
]){
820 /* A commented menu entry */
822 } else if (*p
== '+'){
824 /* Combined adding and default */
825 p
= test_line (edit_widget
, p
+ 1, &accept_entry
);
826 if (selected
== 0 && accept_entry
)
827 selected
= menu_lines
;
829 /* A condition for adding the entry */
830 p
= test_line (edit_widget
, p
, &accept_entry
);
832 } else if (*p
== '='){
834 /* Combined adding and default */
835 p
= test_line (edit_widget
, p
+ 1, &accept_entry
);
836 if (selected
== 0 && accept_entry
)
837 selected
= menu_lines
;
839 /* A condition for making the entry default */
841 p
= test_line (edit_widget
, p
, &i
);
842 if (selected
== 0 && i
)
843 selected
= menu_lines
;
846 else if (*p
!= ' ' && *p
!= '\t' && str_isprint (p
)) {
847 /* A menu entry title line */
849 entries
[menu_lines
] = p
;
855 if (entries
[menu_lines
]){
859 max_cols
= max (max_cols
, col
);
869 message (D_ERROR
, MSG_ERROR
, _(" No suitable entries found in %s "), menu
);
871 max_cols
= min (max (max_cols
, col
), MAX_ENTRY_LEN
);
874 listbox
= create_listbox_window (menu_lines
, max_cols
+ 2,_(" User menu "),
876 /* insert all the items found */
877 for (i
= 0; i
< menu_lines
; i
++) {
879 LISTBOX_APPEND_TEXT (listbox
, (unsigned char) p
[0],
880 extract_line (p
, p
+ MAX_ENTRY_LEN
), p
);
882 /* Select the default entry */
883 listbox_select_entry (listbox
->list
, selected
);
885 selected
= run_listbox (listbox
);
887 execute_menu_command (edit_widget
, entries
[selected
]);
892 easy_patterns
= old_patterns
;