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
32 #include "../src/tty/tty.h"
33 #include "../src/skin/skin.h"
43 #include "../src/search/search.h"
45 #include "../../lib/vfs/mc-vfs/vfs.h"
47 #include "../src/editor/edit.h" /* WEdit, BLOCK_FILE */
49 /* For the simple listbox manager */
53 #include "../src/viewer/mcviewer.h" /* for default_* externs */
55 #define MAX_ENTRIES 16
56 #define MAX_ENTRY_LEN 60
58 static int debug_flag
= 0;
59 static int debug_error
= 0;
60 static char *menu
= NULL
;
64 %f The current file (if non-local vfs, file will be copied locally and
65 %f will be full path to it).
67 %d The current working directory
68 %s "Selected files"; the tagged files if any, otherwise the current file
70 %u Tagged files (and they are untagged on return from expand_format)
71 %view Runs the commands and pipes standard output to the view command.
72 If %view is immediately followed by '{', recognize keywords
73 ascii, hex, nroff and unform
75 If the format letter is in uppercase, it refers to the other panel.
77 With a number followed the % character you can turn quoting on (default)
79 %f quote expanded macro
81 %0f don't quote expanded macro
83 expand_format returns a memory block that must be free()d.
86 /* Returns how many characters we should advance if %view was found */
87 int check_format_view (const char *p
)
90 if (!strncmp (p
, "view", 4)) {
93 for (q
++;*q
&& *q
!= '}';q
++) {
94 if (!strncmp (q
, "ascii", 5)) {
95 mcview_default_hex_mode
= 0;
97 } else if (!strncmp (q
, "hex", 3)) {
98 mcview_default_hex_mode
= 1;
100 } else if (!strncmp (q
, "nroff", 5)) {
101 mcview_default_nroff_flag
= 1;
103 } else if (!strncmp (q
, "unform", 6)) {
104 mcview_default_nroff_flag
= 0;
116 int check_format_cd (const char *p
)
118 return (strncmp (p
, "cd", 2)) ? 0 : 3;
121 /* Check if p has a "^var\{var-name\}" */
122 /* Returns the number of skipped characters (zero on not found) */
123 /* V will be set to the expanded variable name */
124 int check_format_var (const char *p
, char **v
)
129 const char *dots
= 0;
132 if (!strncmp (p
, "var{", 4)){
133 for (q
+= 4; *q
&& *q
!= '}'; q
++){
140 if (!dots
|| dots
== q
+5){
142 _(" Format error on file Extensions File "),
143 !dots
? _(" The %%var macro has no default ")
144 : _(" The %%var macro has no variable "));
148 /* Copy the variable name */
149 var_name
= g_strndup (p
+ 4, dots
-2 - (p
+3));
151 value
= getenv (var_name
);
154 *v
= g_strdup (value
);
157 var_name
= g_strndup (dots
, q
- dots
);
164 /* strip file's extension */
168 register char *s
= ss
;
172 if(*s
== PATH_SEP
&& e
) e
=NULL
; /* '.' in *directory* name */
180 expand_format (WEdit
*edit_widget
, char c
, int lc_quote
)
182 WPanel
*panel
= NULL
;
183 char *(*quote_func
) (const char *, int);
188 #ifndef USE_INTERNAL_EDIT
193 return g_strdup ("%");
195 if (edit_one_file
== NULL
) {
196 if (g_ascii_islower ((gchar
) c
))
197 panel
= current_panel
;
199 if (get_other_type () != view_listing
)
200 return g_strdup ("");
203 fname
= panel
->dir
.list
[panel
->selected
].fname
;
205 #ifdef USE_INTERNAL_EDIT
207 fname
= str_unconst (edit_get_file_name (edit_widget
));
211 quote_func
= name_quote
;
213 quote_func
= fake_name_quote
;
215 c_lc
= g_ascii_tolower ((gchar
) c
);
220 return (*quote_func
) (fname
, 0);
222 return (*quote_func
) (extension (fname
), 0);
228 cwd
= g_malloc(MC_MAXPATHLEN
+ 1);
231 g_strlcpy(cwd
, panel
->cwd
, MC_MAXPATHLEN
+ 1);
233 mc_get_current_wd(cwd
, MC_MAXPATHLEN
+ 1);
235 qstr
= (*quote_func
) (cwd
, 0);
241 case 'i': /* indent equal number cursor position in line */
242 #ifdef USE_INTERNAL_EDIT
244 return g_strnfill (edit_get_curs_col (edit_widget
), ' ');
247 case 'y': /* syntax type */
248 #ifdef USE_INTERNAL_EDIT
250 const char *syntax_type
= edit_get_syntax_type (edit_widget
);
251 if (syntax_type
!= NULL
)
252 return g_strdup (syntax_type
);
256 case 'k': /* block file name */
257 case 'b': /* block file name / strip extension */ {
258 #ifdef USE_INTERNAL_EDIT
260 char *file
= concat_dir_and_file (home_dir
, EDIT_BLOCK_FILE
);
261 fname
= (*quote_func
) (file
, 0);
267 return strip_ext ((*quote_func
) (fname
, 0));
270 case 'n': /* strip extension in editor */
271 #ifdef USE_INTERNAL_EDIT
273 return strip_ext ((*quote_func
) (fname
, 0));
276 case 'm': /* menu file name */
278 return (*quote_func
) (menu
, 0);
281 if (!panel
|| !panel
->marked
)
282 return (*quote_func
) (fname
, 0);
293 return g_strdup ("");
295 for (i
= 0; i
< panel
->count
; i
++)
296 if (panel
->dir
.list
[i
].f
.marked
)
297 length
+= strlen (panel
->dir
.list
[i
].fname
) + 1; /* for space */
299 block
= g_malloc (length
* 2 + 1);
301 for (i
= 0; i
< panel
->count
; i
++)
302 if (panel
->dir
.list
[i
].f
.marked
) {
304 (*quote_func
) (panel
->dir
.list
[i
].fname
, 0));
308 do_file_mark (panel
, i
, 0);
311 } /* sub case block */
313 result
= g_strdup ("% ");
319 * Check for the "shell_patterns" directive. If it's found and valid,
320 * interpret it and move the pointer past the directive. Return the
324 check_patterns (char *p
)
326 static const char def_name
[] = "shell_patterns=";
329 if (strncmp (p
, def_name
, sizeof (def_name
) - 1) != 0)
332 p
+= sizeof (def_name
) - 1;
342 while (*p
== '\n' || *p
== '\t' || *p
== ' ')
347 /* Copies a whitespace separated argument from p to arg. Returns the
348 point after argument. */
349 static char *extract_arg (char *p
, char *arg
, int size
)
353 while (*p
&& (*p
== ' ' || *p
== '\t' || *p
== '\n'))
355 /* support quote space .mnu */
356 while (*p
&& (*p
!= ' ' || *(p
-1) == '\\') && *p
!= '\t' && *p
!= '\n') {
357 np
= str_get_next_char (p
);
358 if (np
- p
>= size
) break;
359 memcpy (arg
, p
, np
- p
);
365 if (!*p
|| *p
== '\n')
370 /* Tests whether the selected file in the panel is of any of the types
371 specified in argument. */
372 static int test_type (WPanel
*panel
, char *arg
)
374 int result
= 0; /* False by default */
375 int st_mode
= panel
->dir
.list
[panel
->selected
].st
.st_mode
;
377 for (;*arg
!= 0; arg
++){
379 case 'n': /* Not a directory */
380 result
|= !S_ISDIR (st_mode
);
382 case 'r': /* Regular file */
383 result
|= S_ISREG (st_mode
);
385 case 'd': /* Directory */
386 result
|= S_ISDIR (st_mode
);
389 result
|= S_ISLNK (st_mode
);
391 case 'c': /* Character special */
392 result
|= S_ISCHR (st_mode
);
394 case 'b': /* Block special */
395 result
|= S_ISBLK (st_mode
);
397 case 'f': /* Fifo (named pipe) */
398 result
|= S_ISFIFO (st_mode
);
400 case 's': /* Socket */
401 result
|= S_ISSOCK (st_mode
);
403 case 'x': /* Executable */
404 result
|= (st_mode
& 0111) ? 1 : 0;
407 result
|= panel
->marked
? 1 : 0;
417 /* Calculates the truth value of the next condition starting from
418 p. Returns the point after condition. */
420 test_condition (WEdit
*edit_widget
, char *p
, int *condition
)
424 mc_search_type_t search_type
;
427 search_type
= MC_SEARCH_T_GLOB
;
429 search_type
= MC_SEARCH_T_REGEX
;
432 /* Handle one condition */
433 for (;*p
!= '\n' && *p
!= '&' && *p
!= '|'; p
++){
434 /* support quote space .mnu */
435 if ((*p
== ' ' && *(p
-1) != '\\') || *p
== '\t')
438 panel
= current_panel
;
440 if (get_other_type () == view_listing
)
449 p
= test_condition (edit_widget
, p
, condition
);
450 *condition
= ! *condition
;
453 case 'f': /* file name pattern */
454 p
= extract_arg (p
, arg
, sizeof (arg
));
455 *condition
= panel
&& mc_search (arg
, panel
->dir
.list
[panel
->selected
].fname
, search_type
);
457 case 'y': /* syntax pattern */
458 #ifdef USE_INTERNAL_EDIT
460 const char *syntax_type
= edit_get_syntax_type (edit_widget
);
461 if (syntax_type
!= NULL
) {
462 p
= extract_arg (p
, arg
, sizeof (arg
));
463 *condition
= panel
&& mc_search (arg
, syntax_type
, MC_SEARCH_T_NORMAL
);
469 p
= extract_arg (p
, arg
, sizeof (arg
));
470 *condition
= panel
&& mc_search (arg
, panel
->cwd
, search_type
);
473 p
= extract_arg (p
, arg
, sizeof (arg
));
474 *condition
= panel
&& test_type (panel
, arg
);
476 case 'x': /* executable */
480 p
= extract_arg (p
, arg
, sizeof (arg
));
481 if (stat (arg
, &status
) == 0)
482 *condition
= is_exe (status
.st_mode
);
496 /* General purpose condition debug output handler */
498 debug_out (char *start
, char *end
, int cond
)
503 if (start
== NULL
&& end
== NULL
){
505 if (debug_flag
&& msg
) {
509 message (D_NORMAL
, _(" Debug "), "%s", msg
);
519 /* Save debug info for later output */
522 /* Save the result of the condition */
524 type
= _(" ERROR: ");
530 type
= _(" False: ");
531 /* This is for debugging, don't need to be super efficient. */
533 p
= g_strdup_printf ("%s%s%c \n", msg
? msg
: "", type
, *start
);
535 p
= g_strdup_printf ("%s%s%.*s \n", msg
? msg
: "", type
,
536 (int) (end
- start
), start
);
542 /* Calculates the truth value of one lineful of conditions. Returns
543 the point just before the end of line. */
545 test_line (WEdit
*edit_widget
, char *p
, int *result
)
549 char *debug_start
, *debug_end
;
551 /* Repeat till end of line */
552 while (*p
&& *p
!= '\n') {
553 /* support quote space .mnu */
554 while ((*p
== ' ' && *(p
-1) != '\\' ) || *p
== '\t')
556 if (!*p
|| *p
== '\n')
563 /* support quote space .mnu */
564 while ((*p
== ' ' && *(p
-1) != '\\' ) || *p
== '\t')
566 if (!*p
|| *p
== '\n')
568 condition
= 1; /* True by default */
571 p
= test_condition (edit_widget
, p
, &condition
);
573 /* Add one debug statement */
574 debug_out (debug_start
, debug_end
, condition
);
582 case '&': /* Logical and */
583 *result
&= condition
;
585 case '|': /* Logical or */
586 *result
|= condition
;
592 /* Add one debug statement */
593 debug_out (&operator, NULL
, *result
);
595 } /* while (*p != '\n') */
596 /* Report debug message */
597 debug_out (NULL
, NULL
, 1);
599 if (!*p
|| *p
== '\n')
604 /* FIXME: recode this routine on version 3.0, it could be cleaner */
606 execute_menu_command (WEdit
*edit_widget
, const char *commands
)
610 int expand_prefix_found
= 0;
618 /* Skip menu entry title line */
619 commands
= strchr (commands
, '\n');
624 cmd_file_fd
= mc_mkstemps (&file_name
, "mcusr", SCRIPT_SUFFIX
);
626 if (cmd_file_fd
== -1){
627 message (D_ERROR
, MSG_ERROR
, _(" Cannot create temporary command file \n %s "),
628 unix_error_string (errno
));
631 cmd_file
= fdopen (cmd_file_fd
, "w");
632 fputs ("#! /bin/sh\n", cmd_file
);
635 for (col
= 0; *commands
; commands
++){
637 if (*commands
!= ' ' && *commands
!= '\t')
639 while (*commands
== ' ' || *commands
== '\t')
645 if (*commands
== '\n')
648 if (*commands
== '}'){
651 parameter
= input_dialog (_(" Parameter "), lc_prompt
, MC_HISTORY_FM_MENU_EXEC_PARAM
, "");
652 if (!parameter
|| !*parameter
){
660 fputs (tmp
= name_quote (parameter
, 0), cmd_file
);
663 fputs (parameter
, cmd_file
);
667 if (parameter
< &lc_prompt
[sizeof (lc_prompt
) - 1]) {
668 *parameter
++ = *commands
;
671 } else if (expand_prefix_found
){
672 expand_prefix_found
= 0;
673 if (g_ascii_isdigit ((gchar
) *commands
)) {
674 do_quote
= atoi (commands
);
675 while (g_ascii_isdigit ((gchar
) *commands
))
678 if (*commands
== '{')
679 parameter
= lc_prompt
;
681 char *text
= expand_format (edit_widget
, *commands
, do_quote
);
682 fputs (text
, cmd_file
);
686 if (*commands
== '%') {
687 int i
= check_format_view (commands
+ 1);
692 do_quote
= 1; /* Default: Quote expanded macro */
693 expand_prefix_found
= 1;
696 fputc (*commands
, cmd_file
);
700 chmod (file_name
, S_IRWXU
);
703 mcview_viewer (file_name
, NULL
, &run_view
, 0);
705 /* execute the command indirectly to allow execution even
706 * on no-exec filesystems. */
707 char *cmd
= g_strconcat("/bin/sh ", file_name
, (char *) NULL
);
708 shell_execute (cmd
, EXECUTE_HIDE
);
716 ** Check owner of the menu file. Using menu file is allowed, if
717 ** owner of the menu is root or the actual user. In either case
718 ** file should not be group and word-writable.
720 ** Q. Should we apply this routine to system and home menu (and .ext files)?
723 menu_file_own(char* path
)
727 if (stat (path
, &st
) == 0
728 && (!st
.st_uid
|| (st
.st_uid
== geteuid ()))
729 && ((st
.st_mode
& (S_IWGRP
| S_IWOTH
)) == 0)
735 message (D_NORMAL
, _(" Warning -- ignoring file "),
736 _("File %s is not owned by root or you or is world writable.\n"
737 "Using it may compromise your security"),
745 * If edit_widget is NULL then we are called from the mc menu,
746 * otherwise we are called from the mcedit menu.
749 user_menu_cmd (WEdit
*edit_widget
)
752 char *data
, **entries
;
753 int max_cols
, menu_lines
, menu_limit
;
754 int col
, i
, accept_entry
= 1;
755 int selected
, old_patterns
;
758 if (!vfs_current_is_local ()){
759 message (D_ERROR
, MSG_ERROR
,
760 _(" Cannot execute commands on non-local filesystems"));
764 menu
= g_strdup (edit_widget
? EDIT_LOCAL_MENU
: MC_LOCAL_MENU
);
765 if (!exist_file (menu
) || !menu_file_own (menu
)){
768 menu
= concat_dir_and_file (home_dir
, EDIT_HOME_MENU
);
770 menu
= g_build_filename (home_dir
, MC_USERCONF_DIR
, MC_USERMENU_FILE
, NULL
);
773 if (!exist_file (menu
)){
775 menu
= concat_dir_and_file
776 (mc_home
, edit_widget
? EDIT_GLOBAL_MENU
: MC_GLOBAL_MENU
);
777 if (!exist_file (menu
)) {
779 menu
= concat_dir_and_file
780 (mc_home_alt
, edit_widget
? EDIT_GLOBAL_MENU
: MC_GLOBAL_MENU
);
785 if ((data
= load_file (menu
)) == NULL
){
786 message (D_ERROR
, MSG_ERROR
, _(" Cannot open file %s \n %s "),
787 menu
, unix_error_string (errno
));
798 /* Parse the menu file */
799 old_patterns
= easy_patterns
;
800 p
= check_patterns (data
);
801 for (menu_lines
= col
= 0; *p
; str_next_char (&p
)){
802 if (menu_lines
>= menu_limit
){
805 menu_limit
+= MAX_ENTRIES
;
806 new_entries
= g_try_realloc (entries
, sizeof (new_entries
[0]) * menu_limit
);
808 if (new_entries
== NULL
)
811 entries
= new_entries
;
812 new_entries
+= menu_limit
;
813 while (--new_entries
>= &entries
[menu_lines
])
816 if (col
== 0 && !entries
[menu_lines
]){
818 /* A commented menu entry */
820 } else if (*p
== '+'){
822 /* Combined adding and default */
823 p
= test_line (edit_widget
, p
+ 1, &accept_entry
);
824 if (selected
== 0 && accept_entry
)
825 selected
= menu_lines
;
827 /* A condition for adding the entry */
828 p
= test_line (edit_widget
, p
, &accept_entry
);
830 } else if (*p
== '='){
832 /* Combined adding and default */
833 p
= test_line (edit_widget
, p
+ 1, &accept_entry
);
834 if (selected
== 0 && accept_entry
)
835 selected
= menu_lines
;
837 /* A condition for making the entry default */
839 p
= test_line (edit_widget
, p
, &i
);
840 if (selected
== 0 && i
)
841 selected
= menu_lines
;
844 else if (*p
!= ' ' && *p
!= '\t' && str_isprint (p
)) {
845 /* A menu entry title line */
847 entries
[menu_lines
] = p
;
853 if (entries
[menu_lines
]){
857 max_cols
= max (max_cols
, col
);
867 message (D_ERROR
, MSG_ERROR
, _(" No suitable entries found in %s "), menu
);
869 max_cols
= min (max (max_cols
, col
), MAX_ENTRY_LEN
);
872 listbox
= create_listbox_window (menu_lines
, max_cols
+ 2,_(" User menu "),
874 /* insert all the items found */
875 for (i
= 0; i
< menu_lines
; i
++) {
877 LISTBOX_APPEND_TEXT (listbox
, (unsigned char) p
[0],
878 extract_line (p
, p
+ MAX_ENTRY_LEN
), p
);
880 /* Select the default entry */
881 listbox_select_by_number (listbox
->list
, selected
);
883 selected
= run_listbox (listbox
);
885 execute_menu_command (edit_widget
, entries
[selected
]);
890 easy_patterns
= old_patterns
;