2 User Menu implementation
4 Copyright (C) 1994, 1998, 1999, 2000, 2001, 2002, 2003, 2004, 2005,
6 The Free Software Foundation, Inc.
8 This file is part of the Midnight Commander.
10 The Midnight Commander is free software: you can redistribute it
11 and/or modify it under the terms of the GNU General Public License as
12 published by the Free Software Foundation, either version 3 of the License,
13 or (at your option) any later version.
15 The Midnight Commander is distributed in the hope that it will be useful,
16 but WITHOUT ANY WARRANTY; without even the implied warranty of
17 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18 GNU General Public License for more details.
20 You should have received a copy of the GNU General Public License
21 along with this program. If not, see <http://www.gnu.org/licenses/>.
25 * \brief Source: user menu implementation
36 #include "lib/global.h"
37 #include "lib/tty/tty.h"
39 #include "lib/search.h"
40 #include "lib/vfs/vfs.h"
41 #include "lib/strutil.h"
43 #include "lib/widget.h"
45 #include "src/editor/edit.h" /* WEdit, BLOCK_FILE */
46 #include "src/viewer/mcviewer.h" /* for default_* externs */
48 #include "src/execute.h"
49 #include "src/setup.h"
50 #include "src/history.h"
58 /*** global variables ****************************************************************************/
60 /*** file scope macro definitions ****************************************************************/
62 #define MAX_ENTRIES 16
63 #define MAX_ENTRY_LEN 60
65 /*** file scope type declarations ****************************************************************/
67 /*** file scope variables ************************************************************************/
69 static int debug_flag
= 0;
70 static int debug_error
= 0;
71 static char *menu
= NULL
;
73 /*** file scope functions ************************************************************************/
74 /* --------------------------------------------------------------------------------------------- */
76 /** strip file's extension */
80 register char *s
= ss
;
86 if (*s
== PATH_SEP
&& e
)
87 e
= NULL
; /* '.' in *directory* name */
95 /* --------------------------------------------------------------------------------------------- */
97 * Check for the "shell_patterns" directive. If it's found and valid,
98 * interpret it and move the pointer past the directive. Return the
103 check_patterns (char *p
)
105 static const char def_name
[] = "shell_patterns=";
108 if (strncmp (p
, def_name
, sizeof (def_name
) - 1) != 0)
111 p
+= sizeof (def_name
) - 1;
121 while (*p
== '\n' || *p
== '\t' || *p
== ' ')
126 /* --------------------------------------------------------------------------------------------- */
127 /** Copies a whitespace separated argument from p to arg. Returns the
128 point after argument. */
131 extract_arg (char *p
, char *arg
, int size
)
135 while (*p
&& (*p
== ' ' || *p
== '\t' || *p
== '\n'))
137 /* support quote space .mnu */
138 while (*p
&& (*p
!= ' ' || *(p
- 1) == '\\') && *p
!= '\t' && *p
!= '\n')
140 np
= str_get_next_char (p
);
143 memcpy (arg
, p
, np
- p
);
149 if (!*p
|| *p
== '\n')
154 /* --------------------------------------------------------------------------------------------- */
155 /* Tests whether the selected file in the panel is of any of the types
156 specified in argument. */
159 test_type (WPanel
* panel
, char *arg
)
161 int result
= 0; /* False by default */
162 int st_mode
= panel
->dir
.list
[panel
->selected
].st
.st_mode
;
164 for (; *arg
!= 0; arg
++)
168 case 'n': /* Not a directory */
169 result
|= !S_ISDIR (st_mode
);
171 case 'r': /* Regular file */
172 result
|= S_ISREG (st_mode
);
174 case 'd': /* Directory */
175 result
|= S_ISDIR (st_mode
);
178 result
|= S_ISLNK (st_mode
);
180 case 'c': /* Character special */
181 result
|= S_ISCHR (st_mode
);
183 case 'b': /* Block special */
184 result
|= S_ISBLK (st_mode
);
186 case 'f': /* Fifo (named pipe) */
187 result
|= S_ISFIFO (st_mode
);
189 case 's': /* Socket */
190 result
|= S_ISSOCK (st_mode
);
192 case 'x': /* Executable */
193 result
|= (st_mode
& 0111) ? 1 : 0;
196 result
|= panel
->marked
? 1 : 0;
206 /* --------------------------------------------------------------------------------------------- */
207 /** Calculates the truth value of the next condition starting from
208 p. Returns the point after condition. */
211 test_condition (WEdit
* edit_widget
, char *p
, int *condition
)
214 const mc_search_type_t search_type
= easy_patterns
? MC_SEARCH_T_GLOB
: MC_SEARCH_T_REGEX
;
216 /* Handle one condition */
217 for (; *p
!= '\n' && *p
!= '&' && *p
!= '|'; p
++)
219 WPanel
*panel
= NULL
;
221 /* support quote space .mnu */
222 if ((*p
== ' ' && *(p
- 1) != '\\') || *p
== '\t')
225 panel
= current_panel
;
226 else if (get_other_type () == view_listing
)
234 p
= test_condition (edit_widget
, p
, condition
);
235 *condition
= !*condition
;
238 case 'f': /* file name pattern */
239 p
= extract_arg (p
, arg
, sizeof (arg
));
240 #ifdef USE_INTERNAL_EDIT
241 if (edit_widget
!= NULL
)
242 *condition
= mc_search (arg
, edit_get_file_name (edit_widget
), search_type
) ? 1 : 0;
245 *condition
= panel
!= NULL
&&
246 mc_search (arg
, panel
->dir
.list
[panel
->selected
].fname
, search_type
) ? 1 : 0;
248 case 'y': /* syntax pattern */
249 #ifdef USE_INTERNAL_EDIT
250 if (edit_widget
!= NULL
)
252 const char *syntax_type
= edit_get_syntax_type (edit_widget
);
253 if (syntax_type
!= NULL
)
255 p
= extract_arg (p
, arg
, sizeof (arg
));
256 *condition
= mc_search (arg
, syntax_type
, MC_SEARCH_T_NORMAL
) ? 1 : 0;
262 p
= extract_arg (p
, arg
, sizeof (arg
));
263 *condition
= panel
!= NULL
&& mc_search (arg
, panel
->cwd
, search_type
) ? 1 : 0;
266 p
= extract_arg (p
, arg
, sizeof (arg
));
267 *condition
= panel
!= NULL
&& test_type (panel
, arg
) ? 1 : 0;
269 case 'x': /* executable */
273 p
= extract_arg (p
, arg
, sizeof (arg
));
274 if (stat (arg
, &status
) == 0)
275 *condition
= is_exe (status
.st_mode
) ? 1 : 0;
289 /* --------------------------------------------------------------------------------------------- */
290 /** General purpose condition debug output handler */
293 debug_out (char *start
, char *end
, int cond
)
298 if (start
== NULL
&& end
== NULL
)
301 if (debug_flag
&& msg
)
306 message (D_NORMAL
, _("Debug"), "%s", msg
);
318 /* Save debug info for later output */
321 /* Save the result of the condition */
331 /* This is for debugging, don't need to be super efficient. */
333 p
= g_strdup_printf ("%s %s %c \n", msg
? msg
: "", type
, *start
);
335 p
= g_strdup_printf ("%s %s %.*s \n", msg
? msg
: "", type
, (int) (end
- start
), start
);
341 /* --------------------------------------------------------------------------------------------- */
342 /** Calculates the truth value of one lineful of conditions. Returns
343 the point just before the end of line. */
346 test_line (WEdit
* edit_widget
, char *p
, int *result
)
350 char *debug_start
, *debug_end
;
352 /* Repeat till end of line */
353 while (*p
&& *p
!= '\n')
355 /* support quote space .mnu */
356 while ((*p
== ' ' && *(p
- 1) != '\\') || *p
== '\t')
358 if (!*p
|| *p
== '\n')
366 /* support quote space .mnu */
367 while ((*p
== ' ' && *(p
- 1) != '\\') || *p
== '\t')
369 if (!*p
|| *p
== '\n')
371 condition
= 1; /* True by default */
374 p
= test_condition (edit_widget
, p
, &condition
);
376 /* Add one debug statement */
377 debug_out (debug_start
, debug_end
, condition
);
386 case '&': /* Logical and */
387 *result
&= condition
;
389 case '|': /* Logical or */
390 *result
|= condition
;
396 /* Add one debug statement */
397 debug_out (&operator, NULL
, *result
);
399 } /* while (*p != '\n') */
400 /* Report debug message */
401 debug_out (NULL
, NULL
, 1);
403 if (!*p
|| *p
== '\n')
408 /* --------------------------------------------------------------------------------------------- */
409 /** FIXME: recode this routine on version 3.0, it could be cleaner */
412 execute_menu_command (WEdit
* edit_widget
, const char *commands
, gboolean show_prompt
)
416 int expand_prefix_found
= 0;
418 gboolean do_quote
= FALSE
;
424 /* Skip menu entry title line */
425 commands
= strchr (commands
, '\n');
431 cmd_file_fd
= mc_mkstemps (&file_name
, "mcusr", SCRIPT_SUFFIX
);
433 if (cmd_file_fd
== -1)
435 message (D_ERROR
, MSG_ERROR
, _("Cannot create temporary command file\n%s"),
436 unix_error_string (errno
));
439 cmd_file
= fdopen (cmd_file_fd
, "w");
440 fputs ("#! /bin/sh\n", cmd_file
);
443 for (col
= 0; *commands
; commands
++)
447 if (*commands
!= ' ' && *commands
!= '\t')
449 while (*commands
== ' ' || *commands
== '\t')
455 if (*commands
== '\n')
459 if (*commands
== '}')
464 input_dialog (_("Parameter"), lc_prompt
, MC_HISTORY_FM_MENU_EXEC_PARAM
, "");
465 if (!parameter
|| !*parameter
)
475 tmp
= name_quote (parameter
, 0);
476 fputs (tmp
, cmd_file
);
480 fputs (parameter
, cmd_file
);
486 if (parameter
< &lc_prompt
[sizeof (lc_prompt
) - 1])
488 *parameter
++ = *commands
;
492 else if (expand_prefix_found
)
494 expand_prefix_found
= 0;
495 if (g_ascii_isdigit ((gchar
) * commands
))
497 do_quote
= (atoi (commands
) != 0);
498 while (g_ascii_isdigit ((gchar
) * commands
))
501 if (*commands
== '{')
502 parameter
= lc_prompt
;
505 char *text
= expand_format (edit_widget
, *commands
, do_quote
);
506 fputs (text
, cmd_file
);
512 if (*commands
== '%')
514 int i
= check_format_view (commands
+ 1);
522 do_quote
= TRUE
; /* Default: Quote expanded macro */
523 expand_prefix_found
= 1;
527 fputc (*commands
, cmd_file
);
531 chmod (file_name
, S_IRWXU
);
534 mcview_viewer (file_name
, NULL
, 0);
535 dialog_switch_process_pending ();
539 /* execute the command indirectly to allow execution even
540 * on no-exec filesystems. */
541 char *cmd
= g_strconcat ("/bin/sh ", file_name
, (char *) NULL
);
544 if (system (cmd
) == -1)
545 message (D_ERROR
, MSG_ERROR
, "%s", _("Error calling program"));
549 shell_execute (cmd
, EXECUTE_HIDE
);
557 /* --------------------------------------------------------------------------------------------- */
559 ** Check owner of the menu file. Using menu file is allowed, if
560 ** owner of the menu is root or the actual user. In either case
561 ** file should not be group and word-writable.
563 ** Q. Should we apply this routine to system and home menu (and .ext files)?
567 menu_file_own (char *path
)
571 if (stat (path
, &st
) == 0
572 && (!st
.st_uid
|| (st
.st_uid
== geteuid ())) && ((st
.st_mode
& (S_IWGRP
| S_IWOTH
)) == 0))
578 message (D_NORMAL
, _("Warning -- ignoring file"),
579 _("File %s is not owned by root or you or is world writable.\n"
580 "Using it may compromise your security"), path
);
585 /* --------------------------------------------------------------------------------------------- */
586 /*** public functions ****************************************************************************/
587 /* --------------------------------------------------------------------------------------------- */
591 %f The current file (if non-local vfs, file will be copied locally and
592 %f will be full path to it).
594 %d The current working directory
595 %s "Selected files"; the tagged files if any, otherwise the current file
597 %u Tagged files (and they are untagged on return from expand_format)
598 %view Runs the commands and pipes standard output to the view command.
599 If %view is immediately followed by '{', recognize keywords
600 ascii, hex, nroff and unform
602 If the format letter is in uppercase, it refers to the other panel.
604 With a number followed the % character you can turn quoting on (default)
605 and off. For example:
606 %f quote expanded macro
608 %0f don't quote expanded macro
610 expand_format returns a memory block that must be free()d.
613 /* Returns how many characters we should advance if %view was found */
615 check_format_view (const char *p
)
618 if (!strncmp (p
, "view", 4))
623 for (q
++; *q
&& *q
!= '}'; q
++)
625 if (!strncmp (q
, "ascii", 5))
627 mcview_default_hex_mode
= 0;
630 else if (!strncmp (q
, "hex", 3))
632 mcview_default_hex_mode
= 1;
635 else if (!strncmp (q
, "nroff", 5))
637 mcview_default_nroff_flag
= 1;
640 else if (!strncmp (q
, "unform", 6))
642 mcview_default_nroff_flag
= 0;
654 /* --------------------------------------------------------------------------------------------- */
657 check_format_cd (const char *p
)
659 return (strncmp (p
, "cd", 2)) ? 0 : 3;
662 /* --------------------------------------------------------------------------------------------- */
663 /* Check if p has a "^var\{var-name\}" */
664 /* Returns the number of skipped characters (zero on not found) */
665 /* V will be set to the expanded variable name */
668 check_format_var (const char *p
, char **v
)
673 const char *dots
= 0;
676 if (!strncmp (p
, "var{", 4))
678 for (q
+= 4; *q
&& *q
!= '}'; q
++)
686 if (!dots
|| dots
== q
+ 5)
689 _("Format error on file Extensions File"),
690 !dots
? _("The %%var macro has no default")
691 : _("The %%var macro has no variable"));
695 /* Copy the variable name */
696 var_name
= g_strndup (p
+ 4, dots
- 2 - (p
+ 3));
698 value
= getenv (var_name
);
702 *v
= g_strdup (value
);
705 var_name
= g_strndup (dots
, q
- dots
);
712 /* --------------------------------------------------------------------------------------------- */
715 expand_format (struct WEdit
*edit_widget
, char c
, gboolean do_quote
)
717 WPanel
*panel
= NULL
;
718 char *(*quote_func
) (const char *, int);
723 #ifndef USE_INTERNAL_EDIT
728 return g_strdup ("%");
730 if (mc_global
.mc_run_mode
== MC_RUN_FULL
)
732 if (g_ascii_islower ((gchar
) c
))
733 panel
= current_panel
;
736 if (get_other_type () != view_listing
)
737 return g_strdup ("");
740 fname
= panel
->dir
.list
[panel
->selected
].fname
;
742 #ifdef USE_INTERNAL_EDIT
743 else if (mc_global
.mc_run_mode
== MC_RUN_EDITOR
)
744 fname
= (char *) edit_get_file_name (edit_widget
);
748 quote_func
= name_quote
;
750 quote_func
= fake_name_quote
;
752 c_lc
= g_ascii_tolower ((gchar
) c
);
758 return (*quote_func
) (fname
, 0);
760 return (*quote_func
) (extension (fname
), 0);
766 cwd
= g_malloc (MC_MAXPATHLEN
+ 1);
769 g_strlcpy (cwd
, panel
->cwd
, MC_MAXPATHLEN
+ 1);
771 mc_get_current_wd (cwd
, MC_MAXPATHLEN
+ 1);
773 qstr
= (*quote_func
) (cwd
, 0);
779 case 'i': /* indent equal number cursor position in line */
780 #ifdef USE_INTERNAL_EDIT
782 return g_strnfill (edit_get_curs_col (edit_widget
), ' ');
785 case 'y': /* syntax type */
786 #ifdef USE_INTERNAL_EDIT
789 const char *syntax_type
= edit_get_syntax_type (edit_widget
);
790 if (syntax_type
!= NULL
)
791 return g_strdup (syntax_type
);
795 case 'k': /* block file name */
796 case 'b': /* block file name / strip extension */
798 #ifdef USE_INTERNAL_EDIT
801 char *file
= mc_config_get_full_path (EDIT_BLOCK_FILE
);
802 fname
= (*quote_func
) (file
, 0);
808 return strip_ext ((*quote_func
) (fname
, 0));
811 case 'n': /* strip extension in editor */
812 #ifdef USE_INTERNAL_EDIT
814 return strip_ext ((*quote_func
) (fname
, 0));
817 case 'm': /* menu file name */
819 return (*quote_func
) (menu
, 0);
822 if (!panel
|| !panel
->marked
)
823 return (*quote_func
) (fname
, 0);
834 return g_strdup ("");
836 block
= g_string_sized_new (16);
838 for (i
= 0; i
< panel
->count
; i
++)
839 if (panel
->dir
.list
[i
].f
.marked
)
843 tmp
= (*quote_func
) (panel
->dir
.list
[i
].fname
, 0);
844 g_string_append (block
, tmp
);
845 g_string_append_c (block
, ' ');
849 do_file_mark (panel
, i
, 0);
852 return g_string_free (block
, FALSE
);
853 } /* sub case block */
855 result
= g_strdup ("% ");
860 /* --------------------------------------------------------------------------------------------- */
862 * If edit_widget is NULL then we are called from the mc menu,
863 * otherwise we are called from the mcedit menu.
867 user_menu_cmd (struct WEdit
* edit_widget
, const char *menu_file
, int selected_entry
)
870 char *data
, **entries
;
871 int max_cols
, menu_lines
, menu_limit
;
872 int col
, i
, accept_entry
= 1;
873 int selected
, old_patterns
;
875 gboolean res
= FALSE
;
876 gboolean interactive
= TRUE
;
878 if (!vfs_current_is_local ())
880 message (D_ERROR
, MSG_ERROR
, "%s", _("Cannot execute commands on non-local filesystems"));
883 if (menu_file
!= NULL
)
884 menu
= g_strdup (menu_file
);
886 menu
= g_strdup (edit_widget
? EDIT_LOCAL_MENU
: MC_LOCAL_MENU
);
887 if (!exist_file (menu
) || !menu_file_own (menu
))
889 if (menu_file
!= NULL
)
891 message (D_ERROR
, MSG_ERROR
, _("Cannot open file%s\n%s"), menu
,
892 unix_error_string (errno
));
900 menu
= mc_config_get_full_path (EDIT_HOME_MENU
);
902 menu
= mc_config_get_full_path (MC_USERMENU_FILE
);
905 if (!exist_file (menu
))
909 concat_dir_and_file (mc_config_get_home_dir (),
910 edit_widget
? EDIT_GLOBAL_MENU
: MC_GLOBAL_MENU
);
911 if (!exist_file (menu
))
915 concat_dir_and_file (mc_global
.sysconfig_dir
,
916 edit_widget
? EDIT_GLOBAL_MENU
: MC_GLOBAL_MENU
);
917 if (!exist_file (menu
))
920 menu
= concat_dir_and_file
921 (mc_global
.share_data_dir
, edit_widget
? EDIT_GLOBAL_MENU
: MC_GLOBAL_MENU
);
927 if (!g_file_get_contents (menu
, &data
, NULL
, NULL
))
929 message (D_ERROR
, MSG_ERROR
, _("Cannot open file%s\n%s"), menu
, unix_error_string (errno
));
940 /* Parse the menu file */
941 old_patterns
= easy_patterns
;
942 p
= check_patterns (data
);
943 for (menu_lines
= col
= 0; *p
; str_next_char (&p
))
945 if (menu_lines
>= menu_limit
)
949 menu_limit
+= MAX_ENTRIES
;
950 new_entries
= g_try_realloc (entries
, sizeof (new_entries
[0]) * menu_limit
);
952 if (new_entries
== NULL
)
955 entries
= new_entries
;
956 new_entries
+= menu_limit
;
957 while (--new_entries
>= &entries
[menu_lines
])
960 if (col
== 0 && !entries
[menu_lines
])
964 /* show prompt if first line of external script is #interactive */
965 if (selected_entry
>= 0 && strncmp (p
, "#silent", 7) == 0)
967 /* A commented menu entry */
974 /* Combined adding and default */
975 p
= test_line (edit_widget
, p
+ 1, &accept_entry
);
976 if (selected
== 0 && accept_entry
)
977 selected
= menu_lines
;
981 /* A condition for adding the entry */
982 p
= test_line (edit_widget
, p
, &accept_entry
);
989 /* Combined adding and default */
990 p
= test_line (edit_widget
, p
+ 1, &accept_entry
);
991 if (selected
== 0 && accept_entry
)
992 selected
= menu_lines
;
996 /* A condition for making the entry default */
998 p
= test_line (edit_widget
, p
, &i
);
999 if (selected
== 0 && i
)
1000 selected
= menu_lines
;
1003 else if (*p
!= ' ' && *p
!= '\t' && str_isprint (p
))
1005 /* A menu entry title line */
1007 entries
[menu_lines
] = p
;
1014 if (entries
[menu_lines
])
1019 max_cols
= max (max_cols
, col
);
1030 if (menu_lines
== 0)
1032 message (D_ERROR
, MSG_ERROR
, _("No suitable entries found in %s"), menu
);
1037 if (selected_entry
>= 0)
1038 selected
= selected_entry
;
1041 max_cols
= min (max (max_cols
, col
), MAX_ENTRY_LEN
);
1043 /* Create listbox */
1044 listbox
= create_listbox_window (menu_lines
, max_cols
+ 2, _("User menu"),
1045 "[Menu File Edit]");
1046 /* insert all the items found */
1047 for (i
= 0; i
< menu_lines
; i
++)
1050 LISTBOX_APPEND_TEXT (listbox
, (unsigned char) p
[0],
1051 extract_line (p
, p
+ MAX_ENTRY_LEN
), p
);
1053 /* Select the default entry */
1054 listbox_select_entry (listbox
->list
, selected
);
1056 selected
= run_listbox (listbox
);
1060 execute_menu_command (edit_widget
, entries
[selected
], interactive
);
1067 easy_patterns
= old_patterns
;
1075 /* --------------------------------------------------------------------------------------------- */