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 /*** file scope functions ************************************************************************/
102 /* --------------------------------------------------------------------------------------------- */
105 exec_cleanup_file_name (const vfs_path_t
* filename_vpath
, gboolean has_changed
)
107 if (localfilecopy_vpath
== NULL
)
114 mc_stat (localfilecopy_vpath
, &mystat
);
115 has_changed
= localmtime
!= mystat
.st_mtime
;
117 mc_ungetlocalcopy (filename_vpath
, localfilecopy_vpath
, has_changed
);
118 vfs_path_free (localfilecopy_vpath
);
119 localfilecopy_vpath
= NULL
;
122 /* --------------------------------------------------------------------------------------------- */
125 exec_get_file_name (const vfs_path_t
* filename_vpath
)
128 return quote_func (vfs_path_get_last_path_str (filename_vpath
), 0);
130 if (localfilecopy_vpath
== NULL
)
133 localfilecopy_vpath
= mc_getlocalcopy (filename_vpath
);
134 if (localfilecopy_vpath
== NULL
)
137 mc_stat (localfilecopy_vpath
, &mystat
);
138 localmtime
= mystat
.st_mtime
;
141 return quote_func (vfs_path_get_last_path_str (localfilecopy_vpath
), 0);
144 /* --------------------------------------------------------------------------------------------- */
146 exec_expand_format (char symbol
, gboolean is_result_quoted
)
150 text
= expand_format (NULL
, symbol
, TRUE
);
151 if (is_result_quoted
&& text
!= NULL
)
155 quoted_text
= g_strdup_printf ("\"%s\"", text
);
162 /* --------------------------------------------------------------------------------------------- */
165 exec_get_export_variables (const vfs_path_t
* filename_vpath
)
168 GString
*export_vars_string
;
176 const gboolean is_result_quoted
;
177 } export_variables
[] = {
178 {'p', "MC_EXT_BASENAME", FALSE
},
179 {'d', "MC_EXT_CURRENTDIR", FALSE
},
180 {'s', "MC_EXT_SELECTED", TRUE
},
181 {'t', "MC_EXT_ONLYTAGGED", TRUE
},
186 text
= exec_get_file_name (filename_vpath
);
190 export_vars_string
= g_string_new ("MC_EXT_FILENAME=");
191 g_string_append_printf (export_vars_string
, "%s\nexport MC_EXT_FILENAME\n", text
);
194 for (i
= 0; export_variables
[i
].name
!= NULL
; i
++)
197 exec_expand_format (export_variables
[i
].symbol
, export_variables
[i
].is_result_quoted
);
200 g_string_append_printf (export_vars_string
,
201 "%s=%s\nexport %s\n", export_variables
[i
].name
, text
,
202 export_variables
[i
].name
);
206 return g_string_free (export_vars_string
, FALSE
);
209 /* --------------------------------------------------------------------------------------------- */
212 exec_make_shell_string (const char *lc_data
, const vfs_path_t
* filename_vpath
)
214 GString
*shell_string
;
215 char lc_prompt
[80] = "\0";
216 gboolean parameter_found
= FALSE
;
217 gboolean expand_prefix_found
= FALSE
;
219 shell_string
= g_string_new ("");
221 for (; *lc_data
!= '\0' && *lc_data
!= '\n'; lc_data
++)
229 parameter_found
= FALSE
;
231 input_dialog (_("Parameter"), lc_prompt
, MC_HISTORY_EXT_PARAMETER
, "",
232 INPUT_COMPLETE_DEFAULT
);
233 if (parameter
== NULL
)
236 g_string_free (shell_string
, TRUE
);
237 exec_cleanup_file_name (filename_vpath
, FALSE
);
240 g_string_append (shell_string
, parameter
);
241 written_nonspace
= TRUE
;
246 size_t len
= strlen (lc_prompt
);
248 if (len
< sizeof (lc_prompt
) - 1)
250 lc_prompt
[len
] = *lc_data
;
251 lc_prompt
[len
+ 1] = '\0';
255 else if (expand_prefix_found
)
257 expand_prefix_found
= FALSE
;
259 parameter_found
= TRUE
;
265 i
= check_format_view (lc_data
);
273 i
= check_format_cd (lc_data
);
277 quote_func
= fake_name_quote
;
278 do_local_copy
= FALSE
;
284 i
= check_format_var (lc_data
, &v
);
285 if (i
> 0 && v
!= NULL
)
287 g_string_append (shell_string
, v
);
296 text
= expand_format (NULL
, *lc_data
, !is_cd
);
299 text
= exec_get_file_name (filename_vpath
);
302 g_string_free (shell_string
, TRUE
);
308 g_string_append (shell_string
, text
);
311 strcpy (pbuffer
, text
);
312 pbuffer
= strchr (pbuffer
, 0);
316 written_nonspace
= TRUE
;
322 else if (*lc_data
== '%')
323 expand_prefix_found
= TRUE
;
326 if (*lc_data
!= ' ' && *lc_data
!= '\t')
327 written_nonspace
= TRUE
;
329 *(pbuffer
++) = *lc_data
;
331 g_string_append_c (shell_string
, *lc_data
);
334 return g_string_free (shell_string
, FALSE
);
337 /* --------------------------------------------------------------------------------------------- */
340 exec_extension_view (char *cmd
, const vfs_path_t
* filename_vpath
, int start_line
,
341 vfs_path_t
* temp_file_name_vpath
)
343 int def_hex_mode
= mcview_default_hex_mode
, changed_hex_mode
= 0;
344 int def_nroff_flag
= mcview_default_nroff_flag
, changed_nroff_flag
= 0;
346 mcview_altered_hex_mode
= 0;
347 mcview_altered_nroff_flag
= 0;
348 if (def_hex_mode
!= mcview_default_hex_mode
)
349 changed_hex_mode
= 1;
350 if (def_nroff_flag
!= mcview_default_nroff_flag
)
351 changed_nroff_flag
= 1;
353 /* If we've written whitespace only, then just load filename
356 if (written_nonspace
)
358 mcview_viewer (cmd
, filename_vpath
, start_line
);
359 mc_unlink (temp_file_name_vpath
);
362 mcview_viewer (NULL
, filename_vpath
, start_line
);
364 if (changed_hex_mode
&& !mcview_altered_hex_mode
)
365 mcview_default_hex_mode
= def_hex_mode
;
366 if (changed_nroff_flag
&& !mcview_altered_nroff_flag
)
367 mcview_default_nroff_flag
= def_nroff_flag
;
369 dialog_switch_process_pending ();
372 /* --------------------------------------------------------------------------------------------- */
375 exec_extension_cd (void)
382 /* while (*p == ' ' && *p == '\t')
385 /* Search last non-space character. Start search at the end in order
386 not to short filenames containing spaces. */
387 q
= pbuffer
+ strlen (pbuffer
) - 1;
388 while (q
>= pbuffer
&& (*q
== ' ' || *q
== '\t'))
392 p_vpath
= vfs_path_from_str_flags (pbuffer
, VPF_NO_CANON
);
393 do_cd (p_vpath
, cd_parse_command
);
394 vfs_path_free (p_vpath
);
398 /* --------------------------------------------------------------------------------------------- */
401 exec_extension (const vfs_path_t
* filename_vpath
, const char *lc_data
, int start_line
)
403 char *shell_string
, *export_variables
;
404 vfs_path_t
*temp_file_name_vpath
= NULL
;
409 g_return_if_fail (lc_data
!= NULL
);
413 quote_func
= name_quote
;
416 written_nonspace
= FALSE
;
418 /* Avoid making a local copy if we are doing a cd */
419 do_local_copy
= !vfs_file_is_local (filename_vpath
);
421 shell_string
= exec_make_shell_string (lc_data
, filename_vpath
);
423 if (shell_string
== NULL
)
428 exec_extension_cd ();
429 g_free (shell_string
);
434 * All commands should be run in /bin/sh regardless of user shell.
435 * To do that, create temporary shell script and run it.
436 * Sometimes it's not needed (e.g. for %cd and %view commands),
437 * but it's easier to create it anyway.
439 cmd_file_fd
= mc_mkstemps (&temp_file_name_vpath
, "mcext", SCRIPT_SUFFIX
);
441 if (cmd_file_fd
== -1)
443 message (D_ERROR
, MSG_ERROR
,
444 _("Cannot create temporary command file\n%s"), unix_error_string (errno
));
448 cmd_file
= fdopen (cmd_file_fd
, "w");
449 fputs ("#! /bin/sh\n\n", cmd_file
);
451 export_variables
= exec_get_export_variables (filename_vpath
);
452 if (export_variables
!= NULL
)
454 fprintf (cmd_file
, "%s\n", export_variables
);
455 g_free (export_variables
);
458 fputs (shell_string
, cmd_file
);
459 g_free (shell_string
);
462 * Make the script remove itself when it finishes.
463 * Don't do it for the viewer - it may need to rerun the script,
464 * so we clean up after calling view().
470 file_name
= vfs_path_to_str (temp_file_name_vpath
);
471 fprintf (cmd_file
, "\n/bin/rm -f %s\n", file_name
);
477 if ((run_view
&& !written_nonspace
) || is_cd
)
479 mc_unlink (temp_file_name_vpath
);
480 vfs_path_free (temp_file_name_vpath
);
481 temp_file_name_vpath
= NULL
;
487 file_name
= vfs_path_to_str (temp_file_name_vpath
);
488 /* Set executable flag on the command file ... */
489 mc_chmod (temp_file_name_vpath
, S_IRWXU
);
490 /* ... but don't rely on it - run /bin/sh explicitly */
491 cmd
= g_strconcat ("/bin/sh ", file_name
, (char *) NULL
);
496 exec_extension_view (cmd
, filename_vpath
, start_line
, temp_file_name_vpath
);
499 shell_execute (cmd
, EXECUTE_INTERNAL
);
500 if (mc_global
.tty
.console_flag
!= '\0')
502 handle_console (CONSOLE_SAVE
);
503 if (output_lines
&& mc_global
.keybar_visible
)
504 show_console_contents (output_start_y
,
505 LINES
- mc_global
.keybar_visible
-
506 output_lines
- 1, LINES
- mc_global
.keybar_visible
- 1);
512 exec_cleanup_file_name (filename_vpath
, TRUE
);
514 vfs_path_free (temp_file_name_vpath
);
517 /* --------------------------------------------------------------------------------------------- */
519 * Run cmd_file with args, put result into buf.
520 * If error, put '\0' into buf[0]
521 * Return 1 if the data is valid, 0 otherwise, -1 for fatal errors.
523 * NOTES: buf is null-terminated string.
527 get_popen_information (const char *cmd_file
, const char *args
, char *buf
, int buflen
)
529 gboolean read_bytes
= FALSE
;
533 command
= g_strconcat (cmd_file
, args
, " 2>/dev/null", (char *) NULL
);
534 f
= popen (command
, "r");
540 if (setvbuf (f
, NULL
, _IOFBF
, 0) != 0)
546 read_bytes
= (fgets (buf
, buflen
, f
) != NULL
);
548 buf
[0] = '\0'; /* Paranoid termination */
553 buf
[0] = '\0'; /* Paranoid termination */
557 buf
[buflen
- 1] = '\0';
559 return read_bytes
? 1 : 0;
562 /* --------------------------------------------------------------------------------------------- */
564 * Run the "file" command on the local file.
565 * Return 1 if the data is valid, 0 otherwise, -1 for fatal errors.
569 get_file_type_local (const vfs_path_t
* filename_vpath
, char *buf
, int buflen
)
574 tmp
= name_quote (vfs_path_get_last_path_str (filename_vpath
), 0);
575 ret
= get_popen_information (FILE_CMD
, tmp
, buf
, buflen
);
581 /* --------------------------------------------------------------------------------------------- */
583 * Run the "enca" command on the local file.
584 * Return 1 if the data is valid, 0 otherwise, -1 for fatal errors.
589 get_file_encoding_local (const vfs_path_t
* filename_vpath
, char *buf
, int buflen
)
591 char *tmp
, *lang
, *args
;
594 tmp
= name_quote (vfs_path_get_last_path_str (filename_vpath
), 0);
595 lang
= name_quote (autodetect_codeset
, 0);
596 args
= g_strconcat (" -L", lang
, " -i ", tmp
, (char *) NULL
);
598 ret
= get_popen_information ("enca", args
, buf
, buflen
);
606 #endif /* HAVE_CHARSET */
608 /* --------------------------------------------------------------------------------------------- */
610 * Invoke the "file" command on the file and match its output against PTR.
611 * have_type is a flag that is set if we already have tried to determine
612 * the type of that file.
613 * Return 1 for match, 0 for no match, -1 errors.
617 regex_check_type (const vfs_path_t
* filename_vpath
, const char *ptr
, int *have_type
,
618 gboolean case_insense
, GError
** error
)
620 gboolean found
= FALSE
;
622 /* Following variables are valid if *have_type is 1 */
623 static char content_string
[2048];
625 static char encoding_id
[21]; /* CSISO51INISCYRILLIC -- 20 */
627 static size_t content_shift
= 0;
628 static int got_data
= 0;
630 if (!use_file_to_check_type
)
635 vfs_path_t
*localfile_vpath
;
636 const char *realname
; /* name used with "file" */
639 int got_encoding_data
;
640 #endif /* HAVE_CHARSET */
642 /* Don't repeate even unsuccessful checks */
645 localfile_vpath
= mc_getlocalcopy (filename_vpath
);
646 if (localfile_vpath
== NULL
)
650 filename
= vfs_path_to_str (filename_vpath
);
651 g_propagate_error (error
,
652 g_error_new (MC_ERROR
, -1,
653 _("Cannot fetch a local copy of %s"), filename
));
658 realname
= vfs_path_get_last_path_str (localfile_vpath
);
661 got_encoding_data
= is_autodetect_codeset_enabled
662 ? get_file_encoding_local (localfile_vpath
, encoding_id
, sizeof (encoding_id
)) : 0;
664 if (got_encoding_data
> 0)
669 pp
= strchr (encoding_id
, '\n');
673 cp_id
= get_codepage_index (encoding_id
);
675 cp_id
= default_source_codepage
;
677 do_set_codepage (cp_id
);
679 #endif /* HAVE_CHARSET */
681 mc_ungetlocalcopy (filename_vpath
, localfile_vpath
, FALSE
);
683 got_data
= get_file_type_local (localfile_vpath
, content_string
, sizeof (content_string
));
690 pp
= strchr (content_string
, '\n');
694 real_len
= strlen (realname
);
696 if (strncmp (content_string
, realname
, real_len
) == 0)
698 /* Skip "realname: " */
699 content_shift
= real_len
;
700 if (content_string
[content_shift
] == ':')
702 /* Solaris' file prints tab(s) after ':' */
703 for (content_shift
++;
704 content_string
[content_shift
] == ' '
705 || content_string
[content_shift
] == '\t'; content_shift
++)
713 content_string
[0] = '\0';
715 vfs_path_free (localfile_vpath
);
720 g_propagate_error (error
, g_error_new (MC_ERROR
, -1, _("Pipe failed")));
724 if (content_string
[0] != '\0')
728 search
= mc_search_new (ptr
, -1);
731 search
->search_type
= MC_SEARCH_T_REGEX
;
732 search
->is_case_sensitive
= !case_insense
;
733 found
= mc_search_run (search
, content_string
+ content_shift
, 0, -1, NULL
);
734 mc_search_free (search
);
738 g_propagate_error (error
, g_error_new (MC_ERROR
, -1, _("Regular expression error")));
745 /* --------------------------------------------------------------------------------------------- */
746 /*** public functions ****************************************************************************/
747 /* --------------------------------------------------------------------------------------------- */
750 flush_extension_file (void)
756 /* --------------------------------------------------------------------------------------------- */
758 * The second argument is action, i.e. Open, View or Edit
760 * This function returns:
762 * -1 for a failure or user interrupt
763 * 0 if no command was run
764 * 1 if some command was run
766 * If action == "View" then a parameter is checked in the form of "View:%d",
767 * if the value for %d exists, then the viewer is started up at that line number.
771 regex_command (const vfs_path_t
* filename_vpath
, const char *action
)
773 char *filename
, *p
, *q
, *r
, c
;
775 gboolean found
= FALSE
;
776 gboolean error_flag
= FALSE
;
779 int view_at_line_number
;
780 char *include_target
;
781 int include_target_len
;
782 int have_type
= 0; /* Flag used by regex_check_type() */
784 if (filename_vpath
== NULL
)
787 /* Check for the special View:%d parameter */
788 if (strncmp (action
, "View:", 5) == 0)
790 view_at_line_number
= atoi (action
+ 5);
795 view_at_line_number
= 0;
800 char *extension_file
;
801 gboolean mc_user_ext
= TRUE
;
802 gboolean home_error
= FALSE
;
804 extension_file
= mc_config_get_full_path (MC_FILEBIND_FILE
);
805 if (!exist_file (extension_file
))
807 g_free (extension_file
);
809 extension_file
= mc_build_filename (mc_global
.sysconfig_dir
, MC_LIB_EXT
, NULL
);
810 if (!exist_file (extension_file
))
812 g_free (extension_file
);
813 extension_file
= mc_build_filename (mc_global
.share_data_dir
, MC_LIB_EXT
, NULL
);
818 g_file_get_contents (extension_file
, &data
, NULL
, NULL
);
819 g_free (extension_file
);
823 if (strstr (data
, "default/") == NULL
)
825 if (strstr (data
, "regex/") == NULL
&& strstr (data
, "shell/") == NULL
&&
826 strstr (data
, "type/") == NULL
)
835 title
= g_strdup_printf (_(" %s%s file error"),
836 mc_global
.sysconfig_dir
, MC_LIB_EXT
);
837 message (D_ERROR
, title
, _("The format of the %smc.ext "
838 "file has changed with version 3.0. It seems that "
839 "the installation failed. Please fetch a fresh "
840 "copy from the Midnight Commander package."),
841 mc_global
.sysconfig_dir
);
847 goto check_stock_mc_ext
;
853 char *filebind_filename
;
856 filebind_filename
= mc_config_get_full_path (MC_FILEBIND_FILE
);
857 title
= g_strdup_printf (_("%s file error"), filebind_filename
);
858 message (D_ERROR
, title
,
859 _("The format of the %s file has "
860 "changed with version 3.0. You may either want to copy "
861 "it from %smc.ext or use that file as an example of how to write it."),
862 filebind_filename
, mc_global
.sysconfig_dir
);
863 g_free (filebind_filename
);
868 mc_stat (filename_vpath
, &mystat
);
870 include_target
= NULL
;
871 include_target_len
= 0;
872 filename
= vfs_path_to_str (filename_vpath
);
873 file_len
= vfs_path_len (filename_vpath
);
875 for (p
= data
; *p
!= '\0'; p
++)
877 for (q
= p
; *q
== ' ' || *q
== '\t'; q
++)
879 if (*q
== '\n' || *q
== '\0')
880 p
= q
; /* empty line */
881 if (*p
== '#') /* comment */
882 while (*p
!= '\0' && *p
!= '\n')
889 { /* i.e. starts in the first column, should be
892 gboolean case_insense
;
895 q
= strchr (p
, '\n');
897 q
= strchr (p
, '\0');
902 if ((strncmp (p
, "include/", 8) == 0)
903 && (strncmp (p
+ 8, include_target
, include_target_len
) == 0))
906 else if (strncmp (p
, "regex/", 6) == 0)
911 case_insense
= (strncmp (p
, "i/", 2) == 0);
915 search
= mc_search_new (p
, -1);
918 search
->search_type
= MC_SEARCH_T_REGEX
;
919 search
->is_case_sensitive
= !case_insense
;
920 found
= mc_search_run (search
, filename
, 0, file_len
, NULL
);
921 mc_search_free (search
);
924 else if (strncmp (p
, "directory/", 10) == 0)
926 if (S_ISDIR (mystat
.st_mode
) && mc_search (p
+ 10, filename
, MC_SEARCH_T_REGEX
))
929 else if (strncmp (p
, "shell/", 6) == 0)
931 int (*cmp_func
) (const char *s1
, const char *s2
, size_t n
) = strncmp
;
934 case_insense
= (strncmp (p
, "i/", 2) == 0);
938 cmp_func
= strncasecmp
;
941 if (*p
== '.' && file_len
>= (size_t) (q
- p
))
943 if (cmp_func (p
, filename
+ file_len
- (q
- p
), q
- p
) == 0)
948 if ((size_t) (q
- p
) == file_len
&& cmp_func (p
, filename
, q
- p
) == 0)
952 else if (strncmp (p
, "type/", 5) == 0)
954 GError
*error
= NULL
;
958 case_insense
= (strncmp (p
, "i/", 2) == 0);
962 found
= regex_check_type (filename_vpath
, p
, &have_type
, case_insense
, &error
);
965 g_error_free (error
);
966 error_flag
= TRUE
; /* leave it if file cannot be opened */
969 else if (strncmp (p
, "default/", 8) == 0)
978 { /* List of actions */
980 q
= strchr (p
, '\n');
982 q
= strchr (p
, '\0');
983 if (found
&& !error_flag
)
990 if (strcmp (p
, "Include") == 0)
994 include_target
= p
+ 8;
995 t
= strchr (include_target
, '\n');
998 include_target_len
= strlen (include_target
);
1011 if (strcmp (action
, p
) != 0)
1017 for (p
= r
+ 1; *p
== ' ' || *p
== '\t'; p
++)
1020 /* Empty commands just stop searching
1021 * through, they don't do anything
1025 exec_extension (filename_vpath
, r
+ 1, view_at_line_number
);
1043 /* --------------------------------------------------------------------------------------------- */