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"
49 #include "lib/charsets.h" /* get_codepage_index */
51 #include "src/setup.h" /* use_file_to_check_type */
52 #include "src/execute.h"
53 #include "src/history.h"
54 #include "src/main.h" /* do_cd */
56 #include "src/consaver/cons.saver.h"
57 #include "src/viewer/mcviewer.h"
60 #include "src/selcodepage.h" /* do_set_codepage */
67 /*** global variables ****************************************************************************/
69 /*** file scope macro definitions ****************************************************************/
72 #define FILE_CMD "file -L "
74 #define FILE_CMD "file "
77 /*** file scope type declarations ****************************************************************/
79 typedef char *(*quote_func_t
) (const char *name
, int quote_percent
);
81 /*** file scope variables ************************************************************************/
83 /* This variable points to a copy of the mc.ext file in memory
84 * With this we avoid loading/parsing the file each time we
87 static char *data
= NULL
;
89 /*** file scope functions ************************************************************************/
90 /* --------------------------------------------------------------------------------------------- */
93 exec_extension (const char *filename
, const char *lc_data
, int *move_dir
, int start_line
)
95 vfs_path_t
*file_name_vpath
;
99 int expand_prefix_found
= 0;
100 int parameter_found
= 0;
103 int def_hex_mode
= mcview_default_hex_mode
, changed_hex_mode
= 0;
104 int def_nroff_flag
= mcview_default_nroff_flag
, changed_nroff_flag
= 0;
105 int written_nonspace
= 0;
109 vfs_path_t
*localcopy_vpath
= NULL
;
111 time_t localmtime
= 0;
113 quote_func_t quote_func
= name_quote
;
116 g_return_if_fail (filename
!= NULL
);
117 g_return_if_fail (lc_data
!= NULL
);
119 vpath
= vfs_path_from_str (filename
);
121 /* Avoid making a local copy if we are doing a cd */
122 do_local_copy
= vfs_file_is_local (vpath
) ? 0 : 1;
125 * All commands should be run in /bin/sh regardless of user shell.
126 * To do that, create temporary shell script and run it.
127 * Sometimes it's not needed (e.g. for %cd and %view commands),
128 * but it's easier to create it anyway.
130 cmd_file_fd
= mc_mkstemps (&file_name_vpath
, "mcext", SCRIPT_SUFFIX
);
132 if (cmd_file_fd
== -1)
134 message (D_ERROR
, MSG_ERROR
,
135 _("Cannot create temporary command file\n%s"), unix_error_string (errno
));
139 cmd_file
= fdopen (cmd_file_fd
, "w");
140 fputs ("#! /bin/sh\n", cmd_file
);
143 for (; *lc_data
!= '\0' && *lc_data
!= '\n'; lc_data
++)
152 parameter
= input_dialog (_("Parameter"), lc_prompt
, MC_HISTORY_EXT_PARAMETER
, "");
153 if (parameter
== NULL
)
157 mc_unlink (file_name_vpath
);
158 if (localcopy_vpath
!= NULL
)
160 mc_ungetlocalcopy (vpath
, localcopy_vpath
, FALSE
);
161 vfs_path_free (localcopy_vpath
);
165 fputs (parameter
, cmd_file
);
166 written_nonspace
= 1;
171 size_t len
= strlen (lc_prompt
);
173 if (len
< sizeof (lc_prompt
) - 1)
175 lc_prompt
[len
] = *lc_data
;
176 lc_prompt
[len
+ 1] = '\0';
180 else if (expand_prefix_found
)
182 expand_prefix_found
= 0;
190 i
= check_format_view (lc_data
);
198 i
= check_format_cd (lc_data
);
202 quote_func
= fake_name_quote
;
209 i
= check_format_var (lc_data
, &v
);
210 if (i
> 0 && v
!= NULL
)
221 text
= expand_format (NULL
, *lc_data
, !is_cd
);
226 localcopy_vpath
= mc_getlocalcopy (vpath
);
227 if (localcopy_vpath
== NULL
)
230 mc_unlink (file_name_vpath
);
233 mc_stat (localcopy_vpath
, &mystat
);
234 localmtime
= mystat
.st_mtime
;
236 quote_func (vfs_path_get_last_path_str (localcopy_vpath
),
241 const vfs_path_element_t
*path_element
;
243 path_element
= vfs_path_get_by_index (vpath
, -1);
244 text
= quote_func (path_element
->path
, 0);
249 fputs (text
, cmd_file
);
257 written_nonspace
= 1;
263 else if (*lc_data
== '%')
264 expand_prefix_found
= 1;
267 if (*lc_data
!= ' ' && *lc_data
!= '\t')
268 written_nonspace
= 1;
272 fputc (*lc_data
, cmd_file
);
277 * Make the script remove itself when it finishes.
278 * Don't do it for the viewer - it may need to rerun the script,
279 * so we clean up after calling view().
285 file_name
= vfs_path_to_str (file_name_vpath
);
286 fprintf (cmd_file
, "\n/bin/rm -f %s\n", file_name
);
292 if ((run_view
&& !written_nonspace
) || is_cd
)
294 mc_unlink (file_name_vpath
);
295 vfs_path_free (file_name_vpath
);
296 file_name_vpath
= NULL
;
302 file_name
= vfs_path_to_str (file_name_vpath
);
303 /* Set executable flag on the command file ... */
304 mc_chmod (file_name_vpath
, S_IRWXU
);
305 /* ... but don't rely on it - run /bin/sh explicitly */
306 cmd
= g_strconcat ("/bin/sh ", file_name
, (char *) NULL
);
314 mcview_altered_hex_mode
= 0;
315 mcview_altered_nroff_flag
= 0;
316 if (def_hex_mode
!= mcview_default_hex_mode
)
317 changed_hex_mode
= 1;
318 if (def_nroff_flag
!= mcview_default_nroff_flag
)
319 changed_nroff_flag
= 1;
321 /* If we've written whitespace only, then just load filename
324 if (written_nonspace
)
326 ret
= mcview_viewer (cmd
, vpath
, start_line
);
327 mc_unlink (file_name_vpath
);
330 ret
= mcview_viewer (NULL
, vpath
, start_line
);
332 if (move_dir
!= NULL
)
335 case MCVIEW_WANT_NEXT
:
338 case MCVIEW_WANT_PREV
:
345 if (changed_hex_mode
&& !mcview_altered_hex_mode
)
346 mcview_default_hex_mode
= def_hex_mode
;
347 if (changed_nroff_flag
&& !mcview_altered_nroff_flag
)
348 mcview_default_nroff_flag
= def_nroff_flag
;
350 dialog_switch_process_pending ();
359 /* while (*p == ' ' && *p == '\t')
362 /* Search last non-space character. Start search at the end in order
363 not to short filenames containing spaces. */
364 q
= p
+ strlen (p
) - 1;
365 while (q
>= p
&& (*q
== ' ' || *q
== '\t'))
369 p_vpath
= vfs_path_from_str_flags (p
, VPF_NO_CANON
);
370 do_cd (p_vpath
, cd_parse_command
);
371 vfs_path_free (p_vpath
);
375 shell_execute (cmd
, EXECUTE_INTERNAL
);
376 if (mc_global
.tty
.console_flag
!= '\0')
378 handle_console (CONSOLE_SAVE
);
379 if (output_lines
&& mc_global
.keybar_visible
)
380 show_console_contents (output_start_y
,
381 LINES
- mc_global
.keybar_visible
-
382 output_lines
- 1, LINES
- mc_global
.keybar_visible
- 1);
388 if (localcopy_vpath
!= NULL
)
390 mc_stat (localcopy_vpath
, &mystat
);
391 mc_ungetlocalcopy (vpath
, localcopy_vpath
, localmtime
!= mystat
.st_mtime
);
392 vfs_path_free (localcopy_vpath
);
395 vfs_path_free (file_name_vpath
);
396 vfs_path_free (vpath
);
399 /* --------------------------------------------------------------------------------------------- */
401 * Run cmd_file with args, put result into buf.
402 * If error, put '\0' into buf[0]
403 * Return 1 if the data is valid, 0 otherwise, -1 for fatal errors.
405 * NOTES: buf is null-terminated string.
409 get_popen_information (const char *cmd_file
, const char *args
, char *buf
, int buflen
)
411 gboolean read_bytes
= FALSE
;
415 command
= g_strconcat (cmd_file
, args
, " 2>/dev/null", (char *) NULL
);
416 f
= popen (command
, "r");
422 if (setvbuf (f
, NULL
, _IOFBF
, 0) != 0)
428 read_bytes
= (fgets (buf
, buflen
, f
) != NULL
);
430 buf
[0] = '\0'; /* Paranoid termination */
435 buf
[0] = '\0'; /* Paranoid termination */
439 buf
[buflen
- 1] = '\0';
441 return read_bytes
? 1 : 0;
444 /* --------------------------------------------------------------------------------------------- */
446 * Run the "file" command on the local file.
447 * Return 1 if the data is valid, 0 otherwise, -1 for fatal errors.
451 get_file_type_local (const vfs_path_t
* filename_vpath
, char *buf
, int buflen
)
456 tmp
= name_quote (vfs_path_get_last_path_str (filename_vpath
), 0);
457 ret
= get_popen_information (FILE_CMD
, tmp
, buf
, buflen
);
463 /* --------------------------------------------------------------------------------------------- */
465 * Run the "enca" command on the local file.
466 * Return 1 if the data is valid, 0 otherwise, -1 for fatal errors.
471 get_file_encoding_local (const vfs_path_t
* filename_vpath
, char *buf
, int buflen
)
473 char *tmp
, *lang
, *args
;
476 tmp
= name_quote (vfs_path_get_last_path_str (filename_vpath
), 0);
477 lang
= name_quote (autodetect_codeset
, 0);
478 args
= g_strconcat (" -L", lang
, " -i ", tmp
, (char *) NULL
);
480 ret
= get_popen_information ("enca", args
, buf
, buflen
);
488 #endif /* HAVE_CHARSET */
490 /* --------------------------------------------------------------------------------------------- */
492 * Invoke the "file" command on the file and match its output against PTR.
493 * have_type is a flag that is set if we already have tried to determine
494 * the type of that file.
495 * Return 1 for match, 0 for no match, -1 errors.
499 regex_check_type (const vfs_path_t
* filename_vpath
, const char *ptr
, int *have_type
)
503 /* Following variables are valid if *have_type is 1 */
504 static char content_string
[2048];
505 static char encoding_id
[21]; /* CSISO51INISCYRILLIC -- 20 */
506 static size_t content_shift
= 0;
507 static int got_data
= 0;
509 if (!use_file_to_check_type
)
514 vfs_path_t
*localfile_vpath
;
515 const char *realname
; /* name used with "file" */
518 int got_encoding_data
;
519 #endif /* HAVE_CHARSET */
521 /* Don't repeate even unsuccessful checks */
524 localfile_vpath
= mc_getlocalcopy (filename_vpath
);
525 if (localfile_vpath
== NULL
)
528 realname
= vfs_path_get_last_path_str (localfile_vpath
);
531 got_encoding_data
= is_autodetect_codeset_enabled
532 ? get_file_encoding_local (localfile_vpath
, encoding_id
, sizeof (encoding_id
)) : 0;
534 if (got_encoding_data
> 0)
539 pp
= strchr (encoding_id
, '\n');
543 cp_id
= get_codepage_index (encoding_id
);
545 cp_id
= default_source_codepage
;
547 do_set_codepage (cp_id
);
549 #endif /* HAVE_CHARSET */
551 mc_ungetlocalcopy (filename_vpath
, localfile_vpath
, FALSE
);
553 got_data
= get_file_type_local (localfile_vpath
, content_string
, sizeof (content_string
));
560 pp
= strchr (content_string
, '\n');
564 real_len
= strlen (realname
);
566 if (strncmp (content_string
, realname
, real_len
) == 0)
568 /* Skip "realname: " */
569 content_shift
= real_len
;
570 if (content_string
[content_shift
] == ':')
572 /* Solaris' file prints tab(s) after ':' */
573 for (content_shift
++;
574 content_string
[content_shift
] == ' '
575 || content_string
[content_shift
] == '\t'; content_shift
++)
583 content_string
[0] = '\0';
585 vfs_path_free (localfile_vpath
);
591 if (content_string
[0] != '\0'
592 && mc_search (ptr
, content_string
+ content_shift
, MC_SEARCH_T_REGEX
))
600 /* --------------------------------------------------------------------------------------------- */
601 /*** public functions ****************************************************************************/
602 /* --------------------------------------------------------------------------------------------- */
605 flush_extension_file (void)
611 /* --------------------------------------------------------------------------------------------- */
613 * The second argument is action, i.e. Open, View or Edit
615 * This function returns:
617 * -1 for a failure or user interrupt
618 * 0 if no command was run
619 * 1 if some command was run
621 * If action == "View" then a parameter is checked in the form of "View:%d",
622 * if the value for %d exists, then the viewer is started up at that line number.
626 regex_command (const vfs_path_t
* filename_vpath
, const char *action
, int *move_dir
)
628 char *filename
, *p
, *q
, *r
, c
;
634 int view_at_line_number
;
635 char *include_target
;
636 int include_target_len
;
637 int have_type
= 0; /* Flag used by regex_check_type() */
639 if (filename_vpath
== NULL
)
642 /* Check for the special View:%d parameter */
643 if (strncmp (action
, "View:", 5) == 0)
645 view_at_line_number
= atoi (action
+ 5);
650 view_at_line_number
= 0;
655 char *extension_file
;
659 extension_file
= mc_config_get_full_path (MC_FILEBIND_FILE
);
660 if (!exist_file (extension_file
))
662 g_free (extension_file
);
664 extension_file
= mc_build_filename (mc_global
.sysconfig_dir
, MC_LIB_EXT
, NULL
);
665 if (!exist_file (extension_file
))
667 g_free (extension_file
);
668 extension_file
= mc_build_filename (mc_global
.share_data_dir
, MC_LIB_EXT
, NULL
);
673 g_file_get_contents (extension_file
, &data
, NULL
, NULL
);
674 g_free (extension_file
);
678 if (!strstr (data
, "default/"))
680 if (!strstr (data
, "regex/") && !strstr (data
, "shell/") && !strstr (data
, "type/"))
687 goto check_stock_mc_ext
;
691 char *title
= g_strdup_printf (_(" %s%s file error"),
692 mc_global
.sysconfig_dir
, MC_LIB_EXT
);
693 message (D_ERROR
, title
, _("The format of the %smc.ext "
694 "file has changed with version 3.0. It seems that "
695 "the installation failed. Please fetch a fresh "
696 "copy from the Midnight Commander package."),
697 mc_global
.sysconfig_dir
);
705 char *filebind_filename
= mc_config_get_full_path (MC_FILEBIND_FILE
);
706 char *title
= g_strdup_printf (_("%s file error"), filebind_filename
);
707 message (D_ERROR
, title
,
708 _("The format of the %s file has "
709 "changed with version 3.0. You may either want to copy "
710 "it from %smc.ext or use that file as an example of how to write it."),
711 filebind_filename
, mc_global
.sysconfig_dir
);
712 g_free (filebind_filename
);
717 mc_stat (filename_vpath
, &mystat
);
719 include_target
= NULL
;
720 include_target_len
= 0;
721 filename
= vfs_path_to_str (filename_vpath
);
722 file_len
= vfs_path_len (filename_vpath
);
724 for (p
= data
; *p
; p
++)
726 for (q
= p
; *q
== ' ' || *q
== '\t'; q
++);
727 if (*q
== '\n' || !*q
)
728 p
= q
; /* empty line */
729 if (*p
== '#') /* comment */
730 while (*p
&& *p
!= '\n')
737 { /* i.e. starts in the first column, should be
741 q
= strchr (p
, '\n');
748 if ((strncmp (p
, "include/", 8) == 0)
749 && (strncmp (p
+ 8, include_target
, include_target_len
) == 0))
752 else if (!strncmp (p
, "regex/", 6))
755 /* Do not transform shell patterns, you can use shell/ for
758 if (mc_search (p
, filename
, MC_SEARCH_T_REGEX
))
761 else if (!strncmp (p
, "directory/", 10))
763 if (S_ISDIR (mystat
.st_mode
) && mc_search (p
+ 10, filename
, MC_SEARCH_T_REGEX
))
766 else if (!strncmp (p
, "shell/", 6))
769 if (*p
== '.' && file_len
>= (size_t)(q
- p
))
771 if (!strncmp (p
, filename
+ file_len
- (q
- p
), q
- p
))
776 if ((size_t)(q
- p
) == file_len
&& !strncmp (p
, filename
, q
- p
))
780 else if (!strncmp (p
, "type/", 5))
784 res
= regex_check_type (filename_vpath
, p
, &have_type
);
788 error_flag
= 1; /* leave it if file cannot be opened */
790 else if (!strncmp (p
, "default/", 8))
800 { /* List of actions */
802 q
= strchr (p
, '\n');
805 if (found
&& !error_flag
)
812 if (strcmp (p
, "Include") == 0)
816 include_target
= p
+ 8;
817 t
= strchr (include_target
, '\n');
820 include_target_len
= strlen (include_target
);
832 if (!strcmp (action
, p
))
835 for (p
= r
+ 1; *p
== ' ' || *p
== '\t'; p
++);
837 /* Empty commands just stop searching
838 * through, they don't do anything
840 * We need to copy the filename because exec_extension
841 * may end up invoking update_panels thus making the
842 * filename parameter invalid (ie, most of the time,
843 * we get filename as a pointer from current_panel->dir).
847 char *filename_copy
= g_strdup (filename
);
849 exec_extension (filename_copy
, r
+ 1, move_dir
, view_at_line_number
);
850 g_free (filename_copy
);
871 /* --------------------------------------------------------------------------------------------- */