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;
361 mcview_altered_hex_mode
= 0;
362 mcview_altered_nroff_flag
= 0;
363 if (def_hex_mode
!= mcview_default_hex_mode
)
364 changed_hex_mode
= 1;
365 if (def_nroff_flag
!= mcview_default_nroff_flag
)
366 changed_nroff_flag
= 1;
368 mcview_viewer (cmd
, filename_vpath
, start_line
);
370 if (changed_hex_mode
&& !mcview_altered_hex_mode
)
371 mcview_default_hex_mode
= def_hex_mode
;
372 if (changed_nroff_flag
&& !mcview_altered_nroff_flag
)
373 mcview_default_nroff_flag
= def_nroff_flag
;
375 dialog_switch_process_pending ();
378 /* --------------------------------------------------------------------------------------------- */
381 exec_extension_cd (void)
388 /* while (*p == ' ' && *p == '\t')
391 /* Search last non-space character. Start search at the end in order
392 not to short filenames containing spaces. */
393 q
= pbuffer
+ strlen (pbuffer
) - 1;
394 while (q
>= pbuffer
&& (*q
== ' ' || *q
== '\t'))
398 p_vpath
= vfs_path_from_str_flags (pbuffer
, VPF_NO_CANON
);
399 do_cd (p_vpath
, cd_parse_command
);
400 vfs_path_free (p_vpath
);
404 /* --------------------------------------------------------------------------------------------- */
407 exec_extension (void *target
, const vfs_path_t
* filename_vpath
, const char *lc_data
, int start_line
)
409 char *shell_string
, *export_variables
;
410 vfs_path_t
*script_vpath
= NULL
;
415 g_return_val_if_fail (lc_data
!= NULL
, NULL
);
419 quote_func
= name_quote
;
422 written_nonspace
= FALSE
;
424 /* Avoid making a local copy if we are doing a cd */
425 do_local_copy
= !vfs_file_is_local (filename_vpath
);
427 shell_string
= exec_make_shell_string (lc_data
, filename_vpath
);
429 if (shell_string
== NULL
)
434 exec_extension_cd ();
435 g_free (shell_string
);
440 * All commands should be run in /bin/sh regardless of user shell.
441 * To do that, create temporary shell script and run it.
442 * Sometimes it's not needed (e.g. for %cd and %view commands),
443 * but it's easier to create it anyway.
445 cmd_file_fd
= mc_mkstemps (&script_vpath
, "mcext", SCRIPT_SUFFIX
);
447 if (cmd_file_fd
== -1)
449 message (D_ERROR
, MSG_ERROR
,
450 _("Cannot create temporary command file\n%s"), unix_error_string (errno
));
454 cmd_file
= fdopen (cmd_file_fd
, "w");
455 fputs ("#! /bin/sh\n\n", cmd_file
);
457 export_variables
= exec_get_export_variables (filename_vpath
);
458 if (export_variables
!= NULL
)
460 fprintf (cmd_file
, "%s\n", export_variables
);
461 g_free (export_variables
);
464 fputs (shell_string
, cmd_file
);
465 g_free (shell_string
);
468 * Make the script remove itself when it finishes.
469 * Don't do it for the viewer - it may need to rerun the script,
470 * so we clean up after calling view().
476 file_name
= vfs_path_to_str (script_vpath
);
477 fprintf (cmd_file
, "\n/bin/rm -f %s\n", file_name
);
483 if ((run_view
&& !written_nonspace
) || is_cd
)
485 exec_cleanup_script (script_vpath
);
492 file_name
= vfs_path_to_str (script_vpath
);
493 /* Set executable flag on the command file ... */
494 mc_chmod (script_vpath
, S_IRWXU
);
495 /* ... but don't rely on it - run /bin/sh explicitly */
496 cmd
= g_strconcat ("/bin/sh ", file_name
, (char *) NULL
);
502 /* If we've written whitespace only, then just load filename into view */
503 if (!written_nonspace
)
504 exec_extension_view (target
, NULL
, filename_vpath
, start_line
);
506 exec_extension_view (target
, cmd
, filename_vpath
, start_line
);
510 shell_execute (cmd
, EXECUTE_INTERNAL
);
511 if (mc_global
.tty
.console_flag
!= '\0')
513 handle_console (CONSOLE_SAVE
);
514 if (output_lines
&& mc_global
.keybar_visible
)
515 show_console_contents (output_start_y
,
516 LINES
- mc_global
.keybar_visible
-
517 output_lines
- 1, LINES
- mc_global
.keybar_visible
- 1);
523 exec_cleanup_file_name (filename_vpath
, TRUE
);
528 /* --------------------------------------------------------------------------------------------- */
530 * Run cmd_file with args, put result into buf.
531 * If error, put '\0' into buf[0]
532 * Return 1 if the data is valid, 0 otherwise, -1 for fatal errors.
534 * NOTES: buf is null-terminated string.
538 get_popen_information (const char *cmd_file
, const char *args
, char *buf
, int buflen
)
540 gboolean read_bytes
= FALSE
;
544 command
= g_strconcat (cmd_file
, args
, " 2>/dev/null", (char *) NULL
);
545 f
= popen (command
, "r");
551 if (setvbuf (f
, NULL
, _IOFBF
, 0) != 0)
557 read_bytes
= (fgets (buf
, buflen
, f
) != NULL
);
559 buf
[0] = '\0'; /* Paranoid termination */
564 buf
[0] = '\0'; /* Paranoid termination */
568 buf
[buflen
- 1] = '\0';
570 return read_bytes
? 1 : 0;
573 /* --------------------------------------------------------------------------------------------- */
575 * Run the "file" command on the local file.
576 * Return 1 if the data is valid, 0 otherwise, -1 for fatal errors.
580 get_file_type_local (const vfs_path_t
* filename_vpath
, char *buf
, int buflen
)
585 tmp
= name_quote (vfs_path_get_last_path_str (filename_vpath
), 0);
586 ret
= get_popen_information (FILE_CMD
, tmp
, buf
, buflen
);
592 /* --------------------------------------------------------------------------------------------- */
594 * Run the "enca" command on the local file.
595 * Return 1 if the data is valid, 0 otherwise, -1 for fatal errors.
600 get_file_encoding_local (const vfs_path_t
* filename_vpath
, char *buf
, int buflen
)
602 char *tmp
, *lang
, *args
;
605 tmp
= name_quote (vfs_path_get_last_path_str (filename_vpath
), 0);
606 lang
= name_quote (autodetect_codeset
, 0);
607 args
= g_strconcat (" -L", lang
, " -i ", tmp
, (char *) NULL
);
609 ret
= get_popen_information ("enca", args
, buf
, buflen
);
617 #endif /* HAVE_CHARSET */
619 /* --------------------------------------------------------------------------------------------- */
621 * Invoke the "file" command on the file and match its output against PTR.
622 * have_type is a flag that is set if we already have tried to determine
623 * the type of that file.
624 * Return 1 for match, 0 for no match, -1 errors.
628 regex_check_type (const vfs_path_t
* filename_vpath
, const char *ptr
, int *have_type
,
629 gboolean case_insense
, GError
** error
)
631 gboolean found
= FALSE
;
633 /* Following variables are valid if *have_type is 1 */
634 static char content_string
[2048];
636 static char encoding_id
[21]; /* CSISO51INISCYRILLIC -- 20 */
638 static size_t content_shift
= 0;
639 static int got_data
= 0;
641 if (!use_file_to_check_type
)
646 vfs_path_t
*localfile_vpath
;
647 const char *realname
; /* name used with "file" */
650 int got_encoding_data
;
651 #endif /* HAVE_CHARSET */
653 /* Don't repeate even unsuccessful checks */
656 localfile_vpath
= mc_getlocalcopy (filename_vpath
);
657 if (localfile_vpath
== NULL
)
661 filename
= vfs_path_to_str (filename_vpath
);
662 g_propagate_error (error
,
663 g_error_new (MC_ERROR
, -1,
664 _("Cannot fetch a local copy of %s"), filename
));
669 realname
= vfs_path_get_last_path_str (localfile_vpath
);
672 got_encoding_data
= is_autodetect_codeset_enabled
673 ? get_file_encoding_local (localfile_vpath
, encoding_id
, sizeof (encoding_id
)) : 0;
675 if (got_encoding_data
> 0)
680 pp
= strchr (encoding_id
, '\n');
684 cp_id
= get_codepage_index (encoding_id
);
686 cp_id
= default_source_codepage
;
688 do_set_codepage (cp_id
);
690 #endif /* HAVE_CHARSET */
692 mc_ungetlocalcopy (filename_vpath
, localfile_vpath
, FALSE
);
694 got_data
= get_file_type_local (localfile_vpath
, content_string
, sizeof (content_string
));
701 pp
= strchr (content_string
, '\n');
705 real_len
= strlen (realname
);
707 if (strncmp (content_string
, realname
, real_len
) == 0)
709 /* Skip "realname: " */
710 content_shift
= real_len
;
711 if (content_string
[content_shift
] == ':')
713 /* Solaris' file prints tab(s) after ':' */
714 for (content_shift
++;
715 content_string
[content_shift
] == ' '
716 || content_string
[content_shift
] == '\t'; content_shift
++)
724 content_string
[0] = '\0';
726 vfs_path_free (localfile_vpath
);
731 g_propagate_error (error
, g_error_new (MC_ERROR
, -1, _("Pipe failed")));
735 if (content_string
[0] != '\0')
739 search
= mc_search_new (ptr
, -1);
742 search
->search_type
= MC_SEARCH_T_REGEX
;
743 search
->is_case_sensitive
= !case_insense
;
744 found
= mc_search_run (search
, content_string
+ content_shift
, 0, -1, NULL
);
745 mc_search_free (search
);
749 g_propagate_error (error
, g_error_new (MC_ERROR
, -1, _("Regular expression error")));
756 /* --------------------------------------------------------------------------------------------- */
757 /*** public functions ****************************************************************************/
758 /* --------------------------------------------------------------------------------------------- */
761 flush_extension_file (void)
767 /* --------------------------------------------------------------------------------------------- */
769 * The second argument is action, i.e. Open, View or Edit
770 * Use target object to open file in.
772 * This function returns:
774 * -1 for a failure or user interrupt
775 * 0 if no command was run
776 * 1 if some command was run
778 * If action == "View" then a parameter is checked in the form of "View:%d",
779 * if the value for %d exists, then the viewer is started up at that line number.
783 regex_command_for (void *target
, const vfs_path_t
* filename_vpath
, const char *action
,
784 vfs_path_t
** script_vpath
)
786 char *filename
, *p
, *q
, *r
, c
;
788 gboolean found
= FALSE
;
789 gboolean error_flag
= FALSE
;
792 int view_at_line_number
;
793 char *include_target
;
794 int include_target_len
;
795 int have_type
= 0; /* Flag used by regex_check_type() */
797 if (filename_vpath
== NULL
)
800 if (script_vpath
!= NULL
)
801 *script_vpath
= NULL
;
803 /* Check for the special View:%d parameter */
804 if (strncmp (action
, "View:", 5) == 0)
806 view_at_line_number
= atoi (action
+ 5);
811 view_at_line_number
= 0;
816 char *extension_file
;
817 gboolean mc_user_ext
= TRUE
;
818 gboolean home_error
= FALSE
;
820 extension_file
= mc_config_get_full_path (MC_FILEBIND_FILE
);
821 if (!exist_file (extension_file
))
823 g_free (extension_file
);
825 extension_file
= mc_build_filename (mc_global
.sysconfig_dir
, MC_LIB_EXT
, NULL
);
826 if (!exist_file (extension_file
))
828 g_free (extension_file
);
829 extension_file
= mc_build_filename (mc_global
.share_data_dir
, MC_LIB_EXT
, NULL
);
834 g_file_get_contents (extension_file
, &data
, NULL
, NULL
);
835 g_free (extension_file
);
839 if (strstr (data
, "default/") == NULL
)
841 if (strstr (data
, "regex/") == NULL
&& strstr (data
, "shell/") == NULL
&&
842 strstr (data
, "type/") == NULL
)
851 title
= g_strdup_printf (_(" %s%s file error"),
852 mc_global
.sysconfig_dir
, MC_LIB_EXT
);
853 message (D_ERROR
, title
, _("The format of the %smc.ext "
854 "file has changed with version 3.0. It seems that "
855 "the installation failed. Please fetch a fresh "
856 "copy from the Midnight Commander package."),
857 mc_global
.sysconfig_dir
);
863 goto check_stock_mc_ext
;
869 char *filebind_filename
;
872 filebind_filename
= mc_config_get_full_path (MC_FILEBIND_FILE
);
873 title
= g_strdup_printf (_("%s file error"), filebind_filename
);
874 message (D_ERROR
, title
,
875 _("The format of the %s file has "
876 "changed with version 3.0. You may either want to copy "
877 "it from %smc.ext or use that file as an example of how to write it."),
878 filebind_filename
, mc_global
.sysconfig_dir
);
879 g_free (filebind_filename
);
884 mc_stat (filename_vpath
, &mystat
);
886 include_target
= NULL
;
887 include_target_len
= 0;
888 filename
= vfs_path_to_str (filename_vpath
);
889 file_len
= vfs_path_len (filename_vpath
);
891 for (p
= data
; *p
!= '\0'; p
++)
893 for (q
= p
; *q
== ' ' || *q
== '\t'; q
++)
895 if (*q
== '\n' || *q
== '\0')
896 p
= q
; /* empty line */
897 if (*p
== '#') /* comment */
898 while (*p
!= '\0' && *p
!= '\n')
905 { /* i.e. starts in the first column, should be
908 gboolean case_insense
;
911 q
= strchr (p
, '\n');
913 q
= strchr (p
, '\0');
918 if ((strncmp (p
, "include/", 8) == 0)
919 && (strncmp (p
+ 8, include_target
, include_target_len
) == 0))
922 else if (strncmp (p
, "regex/", 6) == 0)
927 case_insense
= (strncmp (p
, "i/", 2) == 0);
931 search
= mc_search_new (p
, -1);
934 search
->search_type
= MC_SEARCH_T_REGEX
;
935 search
->is_case_sensitive
= !case_insense
;
936 found
= mc_search_run (search
, filename
, 0, file_len
, NULL
);
937 mc_search_free (search
);
940 else if (strncmp (p
, "directory/", 10) == 0)
942 if (S_ISDIR (mystat
.st_mode
) && mc_search (p
+ 10, filename
, MC_SEARCH_T_REGEX
))
945 else if (strncmp (p
, "shell/", 6) == 0)
947 int (*cmp_func
) (const char *s1
, const char *s2
, size_t n
) = strncmp
;
950 case_insense
= (strncmp (p
, "i/", 2) == 0);
954 cmp_func
= strncasecmp
;
957 if (*p
== '.' && file_len
>= (size_t) (q
- p
))
959 if (cmp_func (p
, filename
+ file_len
- (q
- p
), q
- p
) == 0)
964 if ((size_t) (q
- p
) == file_len
&& cmp_func (p
, filename
, q
- p
) == 0)
968 else if (strncmp (p
, "type/", 5) == 0)
970 GError
*error
= NULL
;
974 case_insense
= (strncmp (p
, "i/", 2) == 0);
978 found
= regex_check_type (filename_vpath
, p
, &have_type
, case_insense
, &error
);
981 g_error_free (error
);
982 error_flag
= TRUE
; /* leave it if file cannot be opened */
985 else if (strncmp (p
, "default/", 8) == 0)
994 { /* List of actions */
996 q
= strchr (p
, '\n');
998 q
= strchr (p
, '\0');
999 if (found
&& !error_flag
)
1001 r
= strchr (p
, '=');
1006 if (strcmp (p
, "Include") == 0)
1010 include_target
= p
+ 8;
1011 t
= strchr (include_target
, '\n');
1014 include_target_len
= strlen (include_target
);
1027 if (strcmp (action
, p
) != 0)
1033 for (p
= r
+ 1; *p
== ' ' || *p
== '\t'; p
++)
1036 /* Empty commands just stop searching
1037 * through, they don't do anything
1043 sv
= exec_extension (target
, filename_vpath
, r
+ 1, view_at_line_number
);
1044 if (script_vpath
!= NULL
)
1047 exec_cleanup_script (sv
);
1066 /* --------------------------------------------------------------------------------------------- */