2 Extension dependent execution.
4 Copyright (C) 1994, 1995, 1998, 1999, 2000, 2001, 2002, 2003, 2004,
6 The Free Software Foundation, Inc.
12 This file is part of the Midnight Commander.
14 The Midnight Commander is free software: you can redistribute it
15 and/or modify it under the terms of the GNU General Public License as
16 published by the Free Software Foundation, either version 3 of the License,
17 or (at your option) any later version.
19 The Midnight Commander is distributed in the hope that it will be useful,
20 but WITHOUT ANY WARRANTY; without even the implied warranty of
21 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
22 GNU General Public License for more details.
24 You should have received a copy of the GNU General Public License
25 along with this program. If not, see <http://www.gnu.org/licenses/>.
29 * \brief Source: extension dependent execution
41 #include "lib/global.h"
42 #include "lib/tty/tty.h"
43 #include "lib/search.h"
44 #include "lib/fileloc.h"
45 #include "lib/mcconfig.h"
47 #include "lib/vfs/vfs.h"
48 #include "lib/widget.h"
50 #include "lib/charsets.h" /* get_codepage_index */
53 #include "src/setup.h" /* use_file_to_check_type */
54 #include "src/execute.h"
55 #include "src/history.h"
57 #include "src/consaver/cons.saver.h"
58 #include "src/viewer/mcviewer.h"
61 #include "src/selcodepage.h" /* do_set_codepage */
64 #include "panel.h" /* do_cd */
69 /*** global variables ****************************************************************************/
71 /*** file scope macro definitions ****************************************************************/
74 #define FILE_CMD "file -L "
76 #define FILE_CMD "file "
79 /*** file scope type declarations ****************************************************************/
81 typedef char *(*quote_func_t
) (const char *name
, int quote_percent
);
83 /*** file scope variables ************************************************************************/
85 /* This variable points to a copy of the mc.ext file in memory
86 * With this we avoid loading/parsing the file each time we
89 static char *data
= NULL
;
90 static vfs_path_t
*localfilecopy_vpath
= NULL
;
91 static char buffer
[BUF_1K
];
93 static char *pbuffer
= NULL
;
94 static time_t localmtime
= 0;
95 static quote_func_t quote_func
= name_quote
;
96 static gboolean run_view
= FALSE
;
97 static gboolean is_cd
= FALSE
;
98 static gboolean written_nonspace
= FALSE
;
99 static gboolean do_local_copy
= FALSE
;
101 /* --------------------------------------------------------------------------------------------- */
102 /*** file scope functions ************************************************************************/
103 /* --------------------------------------------------------------------------------------------- */
106 exec_cleanup_script (vfs_path_t
* script_vpath
)
108 if (script_vpath
!= NULL
)
110 (void) mc_unlink (script_vpath
);
111 vfs_path_free (script_vpath
);
115 /* --------------------------------------------------------------------------------------------- */
118 exec_cleanup_file_name (const vfs_path_t
* filename_vpath
, gboolean has_changed
)
120 if (localfilecopy_vpath
== NULL
)
127 mc_stat (localfilecopy_vpath
, &mystat
);
128 has_changed
= localmtime
!= mystat
.st_mtime
;
130 mc_ungetlocalcopy (filename_vpath
, localfilecopy_vpath
, has_changed
);
131 vfs_path_free (localfilecopy_vpath
);
132 localfilecopy_vpath
= NULL
;
135 /* --------------------------------------------------------------------------------------------- */
138 exec_get_file_name (const vfs_path_t
* filename_vpath
)
141 return quote_func (vfs_path_get_last_path_str (filename_vpath
), 0);
143 if (localfilecopy_vpath
== NULL
)
146 localfilecopy_vpath
= mc_getlocalcopy (filename_vpath
);
147 if (localfilecopy_vpath
== NULL
)
150 mc_stat (localfilecopy_vpath
, &mystat
);
151 localmtime
= mystat
.st_mtime
;
154 return quote_func (vfs_path_get_last_path_str (localfilecopy_vpath
), 0);
157 /* --------------------------------------------------------------------------------------------- */
160 exec_expand_format (char symbol
, gboolean is_result_quoted
)
164 text
= expand_format (NULL
, symbol
, TRUE
);
165 if (is_result_quoted
&& text
!= NULL
)
169 quoted_text
= g_strdup_printf ("\"%s\"", text
);
176 /* --------------------------------------------------------------------------------------------- */
179 exec_get_export_variables (const vfs_path_t
* filename_vpath
)
182 GString
*export_vars_string
;
190 const gboolean is_result_quoted
;
191 } export_variables
[] = {
192 {'p', "MC_EXT_BASENAME", FALSE
},
193 {'d', "MC_EXT_CURRENTDIR", FALSE
},
194 {'s', "MC_EXT_SELECTED", TRUE
},
195 {'t', "MC_EXT_ONLYTAGGED", TRUE
},
200 text
= exec_get_file_name (filename_vpath
);
204 export_vars_string
= g_string_new ("MC_EXT_FILENAME=");
205 g_string_append_printf (export_vars_string
, "%s\nexport MC_EXT_FILENAME\n", text
);
208 for (i
= 0; export_variables
[i
].name
!= NULL
; i
++)
211 exec_expand_format (export_variables
[i
].symbol
, export_variables
[i
].is_result_quoted
);
214 g_string_append_printf (export_vars_string
,
215 "%s=%s\nexport %s\n", export_variables
[i
].name
, text
,
216 export_variables
[i
].name
);
220 return g_string_free (export_vars_string
, FALSE
);
223 /* --------------------------------------------------------------------------------------------- */
226 exec_make_shell_string (const char *lc_data
, const vfs_path_t
* filename_vpath
)
228 GString
*shell_string
;
229 char lc_prompt
[80] = "\0";
230 gboolean parameter_found
= FALSE
;
231 gboolean expand_prefix_found
= FALSE
;
233 shell_string
= g_string_new ("");
235 for (; *lc_data
!= '\0' && *lc_data
!= '\n'; lc_data
++)
243 parameter_found
= FALSE
;
245 input_dialog (_("Parameter"), lc_prompt
, MC_HISTORY_EXT_PARAMETER
, "",
246 INPUT_COMPLETE_NONE
);
247 if (parameter
== NULL
)
250 g_string_free (shell_string
, TRUE
);
251 exec_cleanup_file_name (filename_vpath
, FALSE
);
254 g_string_append (shell_string
, parameter
);
255 written_nonspace
= TRUE
;
260 size_t len
= strlen (lc_prompt
);
262 if (len
< sizeof (lc_prompt
) - 1)
264 lc_prompt
[len
] = *lc_data
;
265 lc_prompt
[len
+ 1] = '\0';
269 else if (expand_prefix_found
)
271 expand_prefix_found
= FALSE
;
273 parameter_found
= TRUE
;
279 i
= check_format_view (lc_data
);
287 i
= check_format_cd (lc_data
);
291 quote_func
= fake_name_quote
;
292 do_local_copy
= FALSE
;
298 i
= check_format_var (lc_data
, &v
);
299 if (i
> 0 && v
!= NULL
)
301 g_string_append (shell_string
, v
);
310 text
= expand_format (NULL
, *lc_data
, !is_cd
);
313 text
= exec_get_file_name (filename_vpath
);
316 g_string_free (shell_string
, TRUE
);
322 g_string_append (shell_string
, text
);
325 strcpy (pbuffer
, text
);
326 pbuffer
= strchr (pbuffer
, 0);
330 written_nonspace
= TRUE
;
336 else if (*lc_data
== '%')
337 expand_prefix_found
= TRUE
;
340 if (*lc_data
!= ' ' && *lc_data
!= '\t')
341 written_nonspace
= TRUE
;
343 *(pbuffer
++) = *lc_data
;
345 g_string_append_c (shell_string
, *lc_data
);
348 return g_string_free (shell_string
, FALSE
);
351 /* --------------------------------------------------------------------------------------------- */
354 exec_extension_view (void *target
, char *cmd
, const vfs_path_t
* filename_vpath
, int start_line
)
356 int def_hex_mode
= mcview_default_hex_mode
, changed_hex_mode
= 0;
357 int def_nroff_flag
= mcview_default_nroff_flag
, changed_nroff_flag
= 0;
359 mcview_altered_hex_mode
= 0;
360 mcview_altered_nroff_flag
= 0;
361 if (def_hex_mode
!= mcview_default_hex_mode
)
362 changed_hex_mode
= 1;
363 if (def_nroff_flag
!= mcview_default_nroff_flag
)
364 changed_nroff_flag
= 1;
367 mcview_viewer (cmd
, filename_vpath
, start_line
);
372 file_name
= vfs_path_to_str (filename_vpath
);
373 mcview_load ((mcview_t
*) target
, cmd
, file_name
, start_line
);
377 if (changed_hex_mode
&& !mcview_altered_hex_mode
)
378 mcview_default_hex_mode
= def_hex_mode
;
379 if (changed_nroff_flag
&& !mcview_altered_nroff_flag
)
380 mcview_default_nroff_flag
= def_nroff_flag
;
382 dialog_switch_process_pending ();
385 /* --------------------------------------------------------------------------------------------- */
388 exec_extension_cd (void)
395 /* while (*p == ' ' && *p == '\t')
398 /* Search last non-space character. Start search at the end in order
399 not to short filenames containing spaces. */
400 q
= pbuffer
+ strlen (pbuffer
) - 1;
401 while (q
>= pbuffer
&& (*q
== ' ' || *q
== '\t'))
405 p_vpath
= vfs_path_from_str_flags (pbuffer
, VPF_NO_CANON
);
406 do_cd (p_vpath
, cd_parse_command
);
407 vfs_path_free (p_vpath
);
411 /* --------------------------------------------------------------------------------------------- */
414 exec_extension (void *target
, const vfs_path_t
* filename_vpath
, const char *lc_data
,
417 char *shell_string
, *export_variables
;
418 vfs_path_t
*script_vpath
= NULL
;
423 g_return_val_if_fail (lc_data
!= NULL
, NULL
);
427 quote_func
= name_quote
;
430 written_nonspace
= FALSE
;
432 /* Avoid making a local copy if we are doing a cd */
433 do_local_copy
= !vfs_file_is_local (filename_vpath
);
435 shell_string
= exec_make_shell_string (lc_data
, filename_vpath
);
437 if (shell_string
== NULL
)
442 exec_extension_cd ();
443 g_free (shell_string
);
448 * All commands should be run in /bin/sh regardless of user shell.
449 * To do that, create temporary shell script and run it.
450 * Sometimes it's not needed (e.g. for %cd and %view commands),
451 * but it's easier to create it anyway.
453 cmd_file_fd
= mc_mkstemps (&script_vpath
, "mcext", SCRIPT_SUFFIX
);
455 if (cmd_file_fd
== -1)
457 message (D_ERROR
, MSG_ERROR
,
458 _("Cannot create temporary command file\n%s"), unix_error_string (errno
));
462 cmd_file
= fdopen (cmd_file_fd
, "w");
463 fputs ("#! /bin/sh\n\n", cmd_file
);
465 export_variables
= exec_get_export_variables (filename_vpath
);
466 if (export_variables
!= NULL
)
468 fprintf (cmd_file
, "%s\n", export_variables
);
469 g_free (export_variables
);
472 fputs (shell_string
, cmd_file
);
473 g_free (shell_string
);
476 * Make the script remove itself when it finishes.
477 * Don't do it for the viewer - it may need to rerun the script,
478 * so we clean up after calling view().
484 file_name
= vfs_path_to_str (script_vpath
);
485 fprintf (cmd_file
, "\n/bin/rm -f %s\n", file_name
);
491 if ((run_view
&& !written_nonspace
) || is_cd
)
493 exec_cleanup_script (script_vpath
);
500 file_name
= vfs_path_to_str (script_vpath
);
501 /* Set executable flag on the command file ... */
502 mc_chmod (script_vpath
, S_IRWXU
);
503 /* ... but don't rely on it - run /bin/sh explicitly */
504 cmd
= g_strconcat ("/bin/sh ", file_name
, (char *) NULL
);
510 /* If we've written whitespace only, then just load filename into view */
511 if (!written_nonspace
)
512 exec_extension_view (target
, NULL
, filename_vpath
, start_line
);
514 exec_extension_view (target
, cmd
, filename_vpath
, start_line
);
518 shell_execute (cmd
, EXECUTE_INTERNAL
);
519 if (mc_global
.tty
.console_flag
!= '\0')
521 handle_console (CONSOLE_SAVE
);
522 if (output_lines
&& mc_global
.keybar_visible
)
523 show_console_contents (output_start_y
,
524 LINES
- mc_global
.keybar_visible
-
525 output_lines
- 1, LINES
- mc_global
.keybar_visible
- 1);
531 exec_cleanup_file_name (filename_vpath
, TRUE
);
536 /* --------------------------------------------------------------------------------------------- */
538 * Run cmd_file with args, put result into buf.
539 * If error, put '\0' into buf[0]
540 * Return 1 if the data is valid, 0 otherwise, -1 for fatal errors.
542 * NOTES: buf is null-terminated string.
546 get_popen_information (const char *cmd_file
, const char *args
, char *buf
, int buflen
)
548 gboolean read_bytes
= FALSE
;
552 command
= g_strconcat (cmd_file
, args
, " 2>/dev/null", (char *) NULL
);
553 f
= popen (command
, "r");
559 if (setvbuf (f
, NULL
, _IOFBF
, 0) != 0)
565 read_bytes
= (fgets (buf
, buflen
, f
) != NULL
);
567 buf
[0] = '\0'; /* Paranoid termination */
572 buf
[0] = '\0'; /* Paranoid termination */
576 buf
[buflen
- 1] = '\0';
578 return read_bytes
? 1 : 0;
581 /* --------------------------------------------------------------------------------------------- */
583 * Run the "file" command on the local file.
584 * Return 1 if the data is valid, 0 otherwise, -1 for fatal errors.
588 get_file_type_local (const vfs_path_t
* filename_vpath
, char *buf
, int buflen
)
593 tmp
= name_quote (vfs_path_get_last_path_str (filename_vpath
), 0);
594 ret
= get_popen_information (FILE_CMD
, tmp
, buf
, buflen
);
600 /* --------------------------------------------------------------------------------------------- */
602 * Run the "enca" command on the local file.
603 * Return 1 if the data is valid, 0 otherwise, -1 for fatal errors.
608 get_file_encoding_local (const vfs_path_t
* filename_vpath
, char *buf
, int buflen
)
610 char *tmp
, *lang
, *args
;
613 tmp
= name_quote (vfs_path_get_last_path_str (filename_vpath
), 0);
614 lang
= name_quote (autodetect_codeset
, 0);
615 args
= g_strconcat (" -L", lang
, " -i ", tmp
, (char *) NULL
);
617 ret
= get_popen_information ("enca", args
, buf
, buflen
);
625 #endif /* HAVE_CHARSET */
627 /* --------------------------------------------------------------------------------------------- */
629 * Invoke the "file" command on the file and match its output against PTR.
630 * have_type is a flag that is set if we already have tried to determine
631 * the type of that file.
632 * Return 1 for match, 0 for no match, -1 errors.
636 regex_check_type (const vfs_path_t
* filename_vpath
, const char *ptr
, int *have_type
,
637 gboolean case_insense
, GError
** error
)
639 gboolean found
= FALSE
;
641 /* Following variables are valid if *have_type is 1 */
642 static char content_string
[2048];
644 static char encoding_id
[21]; /* CSISO51INISCYRILLIC -- 20 */
646 static size_t content_shift
= 0;
647 static int got_data
= 0;
649 if (!use_file_to_check_type
)
654 vfs_path_t
*localfile_vpath
;
655 const char *realname
; /* name used with "file" */
658 int got_encoding_data
;
659 #endif /* HAVE_CHARSET */
661 /* Don't repeate even unsuccessful checks */
664 localfile_vpath
= mc_getlocalcopy (filename_vpath
);
665 if (localfile_vpath
== NULL
)
669 filename
= vfs_path_to_str (filename_vpath
);
670 g_propagate_error (error
,
671 g_error_new (MC_ERROR
, -1,
672 _("Cannot fetch a local copy of %s"), filename
));
677 realname
= vfs_path_get_last_path_str (localfile_vpath
);
680 got_encoding_data
= is_autodetect_codeset_enabled
681 ? get_file_encoding_local (localfile_vpath
, encoding_id
, sizeof (encoding_id
)) : 0;
683 if (got_encoding_data
> 0)
688 pp
= strchr (encoding_id
, '\n');
692 cp_id
= get_codepage_index (encoding_id
);
694 cp_id
= default_source_codepage
;
696 do_set_codepage (cp_id
);
698 #endif /* HAVE_CHARSET */
700 mc_ungetlocalcopy (filename_vpath
, localfile_vpath
, FALSE
);
702 got_data
= get_file_type_local (localfile_vpath
, content_string
, sizeof (content_string
));
709 pp
= strchr (content_string
, '\n');
713 real_len
= strlen (realname
);
715 if (strncmp (content_string
, realname
, real_len
) == 0)
717 /* Skip "realname: " */
718 content_shift
= real_len
;
719 if (content_string
[content_shift
] == ':')
721 /* Solaris' file prints tab(s) after ':' */
722 for (content_shift
++;
723 content_string
[content_shift
] == ' '
724 || content_string
[content_shift
] == '\t'; content_shift
++)
732 content_string
[0] = '\0';
734 vfs_path_free (localfile_vpath
);
739 g_propagate_error (error
, g_error_new (MC_ERROR
, -1, _("Pipe failed")));
743 if (content_string
[0] != '\0')
747 search
= mc_search_new (ptr
, -1);
750 search
->search_type
= MC_SEARCH_T_REGEX
;
751 search
->is_case_sensitive
= !case_insense
;
752 found
= mc_search_run (search
, content_string
+ content_shift
, 0, -1, NULL
);
753 mc_search_free (search
);
757 g_propagate_error (error
, g_error_new (MC_ERROR
, -1, _("Regular expression error")));
764 /* --------------------------------------------------------------------------------------------- */
765 /*** public functions ****************************************************************************/
766 /* --------------------------------------------------------------------------------------------- */
769 flush_extension_file (void)
775 /* --------------------------------------------------------------------------------------------- */
777 * The second argument is action, i.e. Open, View or Edit
778 * Use target object to open file in.
780 * This function returns:
782 * -1 for a failure or user interrupt
783 * 0 if no command was run
784 * 1 if some command was run
786 * If action == "View" then a parameter is checked in the form of "View:%d",
787 * if the value for %d exists, then the viewer is started up at that line number.
791 regex_command_for (void *target
, const vfs_path_t
* filename_vpath
, const char *action
,
792 vfs_path_t
** script_vpath
)
794 char *filename
, *p
, *q
, *r
, c
;
796 gboolean found
= FALSE
;
797 gboolean error_flag
= FALSE
;
800 int view_at_line_number
;
801 char *include_target
;
802 int include_target_len
;
803 int have_type
= 0; /* Flag used by regex_check_type() */
805 if (filename_vpath
== NULL
)
808 if (script_vpath
!= NULL
)
809 *script_vpath
= NULL
;
811 /* Check for the special View:%d parameter */
812 if (strncmp (action
, "View:", 5) == 0)
814 view_at_line_number
= atoi (action
+ 5);
819 view_at_line_number
= 0;
824 char *extension_file
;
825 gboolean mc_user_ext
= TRUE
;
826 gboolean home_error
= FALSE
;
828 extension_file
= mc_config_get_full_path (MC_FILEBIND_FILE
);
829 if (!exist_file (extension_file
))
831 g_free (extension_file
);
833 extension_file
= mc_build_filename (mc_global
.sysconfig_dir
, MC_LIB_EXT
, NULL
);
834 if (!exist_file (extension_file
))
836 g_free (extension_file
);
837 extension_file
= mc_build_filename (mc_global
.share_data_dir
, MC_LIB_EXT
, NULL
);
842 g_file_get_contents (extension_file
, &data
, NULL
, NULL
);
843 g_free (extension_file
);
847 if (strstr (data
, "default/") == NULL
)
849 if (strstr (data
, "regex/") == NULL
&& strstr (data
, "shell/") == NULL
&&
850 strstr (data
, "type/") == NULL
)
859 title
= g_strdup_printf (_(" %s%s file error"),
860 mc_global
.sysconfig_dir
, MC_LIB_EXT
);
861 message (D_ERROR
, title
, _("The format of the %smc.ext "
862 "file has changed with version 3.0. It seems that "
863 "the installation failed. Please fetch a fresh "
864 "copy from the Midnight Commander package."),
865 mc_global
.sysconfig_dir
);
871 goto check_stock_mc_ext
;
877 char *filebind_filename
;
880 filebind_filename
= mc_config_get_full_path (MC_FILEBIND_FILE
);
881 title
= g_strdup_printf (_("%s file error"), filebind_filename
);
882 message (D_ERROR
, title
,
883 _("The format of the %s file has "
884 "changed with version 3.0. You may either want to copy "
885 "it from %smc.ext or use that file as an example of how to write it."),
886 filebind_filename
, mc_global
.sysconfig_dir
);
887 g_free (filebind_filename
);
892 mc_stat (filename_vpath
, &mystat
);
894 include_target
= NULL
;
895 include_target_len
= 0;
896 filename
= vfs_path_to_str (filename_vpath
);
897 file_len
= vfs_path_len (filename_vpath
);
899 for (p
= data
; *p
!= '\0'; p
++)
901 for (q
= p
; *q
== ' ' || *q
== '\t'; q
++)
903 if (*q
== '\n' || *q
== '\0')
904 p
= q
; /* empty line */
905 if (*p
== '#') /* comment */
906 while (*p
!= '\0' && *p
!= '\n')
913 { /* i.e. starts in the first column, should be
916 gboolean case_insense
;
919 q
= strchr (p
, '\n');
921 q
= strchr (p
, '\0');
926 if ((strncmp (p
, "include/", 8) == 0)
927 && (strncmp (p
+ 8, include_target
, include_target_len
) == 0))
930 else if (strncmp (p
, "regex/", 6) == 0)
935 case_insense
= (strncmp (p
, "i/", 2) == 0);
939 search
= mc_search_new (p
, -1);
942 search
->search_type
= MC_SEARCH_T_REGEX
;
943 search
->is_case_sensitive
= !case_insense
;
944 found
= mc_search_run (search
, filename
, 0, file_len
, NULL
);
945 mc_search_free (search
);
948 else if (strncmp (p
, "directory/", 10) == 0)
950 if (S_ISDIR (mystat
.st_mode
) && mc_search (p
+ 10, filename
, MC_SEARCH_T_REGEX
))
953 else if (strncmp (p
, "shell/", 6) == 0)
955 int (*cmp_func
) (const char *s1
, const char *s2
, size_t n
) = strncmp
;
958 case_insense
= (strncmp (p
, "i/", 2) == 0);
962 cmp_func
= strncasecmp
;
965 if (*p
== '.' && file_len
>= (size_t) (q
- p
))
967 if (cmp_func (p
, filename
+ file_len
- (q
- p
), q
- p
) == 0)
972 if ((size_t) (q
- p
) == file_len
&& cmp_func (p
, filename
, q
- p
) == 0)
976 else if (strncmp (p
, "type/", 5) == 0)
978 GError
*error
= NULL
;
982 case_insense
= (strncmp (p
, "i/", 2) == 0);
986 found
= regex_check_type (filename_vpath
, p
, &have_type
, case_insense
, &error
);
989 g_error_free (error
);
990 error_flag
= TRUE
; /* leave it if file cannot be opened */
993 else if (strncmp (p
, "default/", 8) == 0)
1002 { /* List of actions */
1004 q
= strchr (p
, '\n');
1006 q
= strchr (p
, '\0');
1007 if (found
&& !error_flag
)
1009 r
= strchr (p
, '=');
1014 if (strcmp (p
, "Include") == 0)
1018 include_target
= p
+ 8;
1019 t
= strchr (include_target
, '\n');
1022 include_target_len
= strlen (include_target
);
1035 if (strcmp (action
, p
) != 0)
1041 for (p
= r
+ 1; *p
== ' ' || *p
== '\t'; p
++)
1044 /* Empty commands just stop searching
1045 * through, they don't do anything
1051 sv
= exec_extension (target
, filename_vpath
, r
+ 1,
1052 view_at_line_number
);
1053 if (script_vpath
!= NULL
)
1056 exec_cleanup_script (sv
);
1075 /* --------------------------------------------------------------------------------------------- */