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"
55 #include "src/consaver/cons.saver.h"
56 #include "src/viewer/mcviewer.h"
59 #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
)
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 char *localcopy
= 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 if (!vfs_file_is_local (vpath
))
128 * All commands should be run in /bin/sh regardless of user shell.
129 * To do that, create temporary shell script and run it.
130 * Sometimes it's not needed (e.g. for %cd and %view commands),
131 * but it's easier to create it anyway.
133 cmd_file_fd
= mc_mkstemps (&file_name
, "mcext", SCRIPT_SUFFIX
);
135 if (cmd_file_fd
== -1)
137 message (D_ERROR
, MSG_ERROR
,
138 _("Cannot create temporary command file\n%s"), unix_error_string (errno
));
142 cmd_file
= fdopen (cmd_file_fd
, "w");
143 fputs ("#! /bin/sh\n", cmd_file
);
146 for (; *lc_data
!= '\0' && *lc_data
!= '\n'; lc_data
++)
155 parameter
= input_dialog (_("Parameter"), lc_prompt
, MC_HISTORY_EXT_PARAMETER
, "");
156 if (parameter
== NULL
)
163 mc_ungetlocalcopy (filename
, localcopy
, 0);
167 vfs_path_free (vpath
);
170 fputs (parameter
, cmd_file
);
171 written_nonspace
= 1;
176 size_t len
= strlen (lc_prompt
);
178 if (len
< sizeof (lc_prompt
) - 1)
180 lc_prompt
[len
] = *lc_data
;
181 lc_prompt
[len
+ 1] = '\0';
185 else if (expand_prefix_found
)
187 expand_prefix_found
= 0;
195 i
= check_format_view (lc_data
);
203 i
= check_format_cd (lc_data
);
207 quote_func
= fake_name_quote
;
214 i
= check_format_var (lc_data
, &v
);
215 if (i
> 0 && v
!= NULL
)
226 text
= expand_format (NULL
, *lc_data
, !is_cd
);
231 localcopy
= mc_getlocalcopy (filename
);
232 if (localcopy
== NULL
)
237 vfs_path_free (vpath
);
240 mc_stat (localcopy
, &mystat
);
241 localmtime
= mystat
.st_mtime
;
242 text
= quote_func (localcopy
, 0);
246 vfs_path_element_t
*path_element
;
247 path_element
= vfs_path_get_by_index (vpath
, -1);
248 text
= quote_func (path_element
->path
, 0);
253 fputs (text
, cmd_file
);
261 written_nonspace
= 1;
267 else if (*lc_data
== '%')
268 expand_prefix_found
= 1;
271 if (*lc_data
!= ' ' && *lc_data
!= '\t')
272 written_nonspace
= 1;
276 fputc (*lc_data
, cmd_file
);
281 * Make the script remove itself when it finishes.
282 * Don't do it for the viewer - it may need to rerun the script,
283 * so we clean up after calling view().
286 fprintf (cmd_file
, "\n/bin/rm -f %s\n", file_name
);
290 if ((run_view
&& !written_nonspace
) || is_cd
)
298 /* Set executable flag on the command file ... */
299 chmod (file_name
, S_IRWXU
);
300 /* ... but don't rely on it - run /bin/sh explicitly */
301 cmd
= g_strconcat ("/bin/sh ", file_name
, (char *) NULL
);
308 mcview_altered_hex_mode
= 0;
309 mcview_altered_nroff_flag
= 0;
310 if (def_hex_mode
!= mcview_default_hex_mode
)
311 changed_hex_mode
= 1;
312 if (def_nroff_flag
!= mcview_default_nroff_flag
)
313 changed_nroff_flag
= 1;
315 /* If we've written whitespace only, then just load filename
318 if (written_nonspace
)
320 ret
= mcview_viewer (cmd
, filename
, start_line
);
324 ret
= mcview_viewer (NULL
, filename
, start_line
);
326 if (move_dir
!= NULL
)
329 case MCVIEW_WANT_NEXT
:
332 case MCVIEW_WANT_PREV
:
339 if (changed_hex_mode
&& !mcview_altered_hex_mode
)
340 mcview_default_hex_mode
= def_hex_mode
;
341 if (changed_nroff_flag
&& !mcview_altered_nroff_flag
)
342 mcview_default_nroff_flag
= def_nroff_flag
;
344 dialog_switch_process_pending ();
351 /* while (*p == ' ' && *p == '\t')
354 /* Search last non-space character. Start search at the end in order
355 not to short filenames containing spaces. */
356 q
= p
+ strlen (p
) - 1;
357 while (q
>= p
&& (*q
== ' ' || *q
== '\t'))
360 do_cd (p
, cd_parse_command
);
364 shell_execute (cmd
, EXECUTE_INTERNAL
);
365 if (mc_global
.tty
.console_flag
!= '\0')
367 handle_console (CONSOLE_SAVE
);
368 if (output_lines
&& mc_global
.keybar_visible
)
369 show_console_contents (output_start_y
,
370 LINES
- mc_global
.keybar_visible
-
371 output_lines
- 1, LINES
- mc_global
.keybar_visible
- 1);
380 mc_stat (localcopy
, &mystat
);
381 mc_ungetlocalcopy (filename
, localcopy
, localmtime
!= mystat
.st_mtime
);
384 vfs_path_free (vpath
);
387 /* --------------------------------------------------------------------------------------------- */
389 * Run cmd_file with args, put result into buf.
390 * If error, put '\0' into buf[0]
391 * Return 1 if the data is valid, 0 otherwise, -1 for fatal errors.
393 * NOTES: buf is null-terminated string.
397 get_popen_information (const char *cmd_file
, const char *args
, char *buf
, int buflen
)
399 gboolean read_bytes
= FALSE
;
403 command
= g_strconcat (cmd_file
, args
, " 2>/dev/null", (char *) NULL
);
404 f
= popen (command
, "r");
410 if (setvbuf (f
, NULL
, _IOFBF
, 0) != 0)
416 read_bytes
= (fgets (buf
, buflen
, f
) != NULL
);
418 buf
[0] = '\0'; /* Paranoid termination */
423 buf
[0] = '\0'; /* Paranoid termination */
427 buf
[buflen
- 1] = '\0';
429 return read_bytes
? 1 : 0;
432 /* --------------------------------------------------------------------------------------------- */
434 * Run the "file" command on the local file.
435 * Return 1 if the data is valid, 0 otherwise, -1 for fatal errors.
439 get_file_type_local (const char *filename
, char *buf
, int buflen
)
444 tmp
= name_quote (filename
, 0);
445 ret
= get_popen_information (FILE_CMD
, tmp
, buf
, buflen
);
451 /* --------------------------------------------------------------------------------------------- */
453 * Run the "enca" command on the local file.
454 * Return 1 if the data is valid, 0 otherwise, -1 for fatal errors.
459 get_file_encoding_local (const char *filename
, char *buf
, int buflen
)
461 char *tmp
, *lang
, *args
;
464 tmp
= name_quote (filename
, 0);
465 lang
= name_quote (autodetect_codeset
, 0);
466 args
= g_strconcat (" -L", lang
, " -i ", tmp
, (char *) NULL
);
468 ret
= get_popen_information ("enca", args
, buf
, buflen
);
476 #endif /* HAVE_CHARSET */
478 /* --------------------------------------------------------------------------------------------- */
480 * Invoke the "file" command on the file and match its output against PTR.
481 * have_type is a flag that is set if we already have tried to determine
482 * the type of that file.
483 * Return 1 for match, 0 for no match, -1 errors.
487 regex_check_type (const char *filename
, const char *ptr
, int *have_type
)
491 /* Following variables are valid if *have_type is 1 */
492 static char content_string
[2048];
493 static char encoding_id
[21]; /* CSISO51INISCYRILLIC -- 20 */
494 static size_t content_shift
= 0;
495 static int got_data
= 0;
497 if (!use_file_to_check_type
)
502 char *realname
; /* name used with "file" */
506 int got_encoding_data
;
507 #endif /* HAVE_CHARSET */
509 /* Don't repeate even unsuccessful checks */
512 localfile
= mc_getlocalcopy (filename
);
513 if (localfile
== NULL
)
516 realname
= localfile
;
519 got_encoding_data
= is_autodetect_codeset_enabled
520 ? get_file_encoding_local (localfile
, encoding_id
, sizeof (encoding_id
)) : 0;
522 if (got_encoding_data
> 0)
527 pp
= strchr (encoding_id
, '\n');
531 cp_id
= get_codepage_index (encoding_id
);
533 cp_id
= default_source_codepage
;
535 do_set_codepage (cp_id
);
537 #endif /* HAVE_CHARSET */
539 mc_ungetlocalcopy (filename
, localfile
, 0);
541 got_data
= get_file_type_local (localfile
, content_string
, sizeof (content_string
));
548 pp
= strchr (content_string
, '\n');
552 real_len
= strlen (realname
);
554 if (strncmp (content_string
, realname
, real_len
) == 0)
556 /* Skip "realname: " */
557 content_shift
= real_len
;
558 if (content_string
[content_shift
] == ':')
560 /* Solaris' file prints tab(s) after ':' */
561 for (content_shift
++;
562 content_string
[content_shift
] == ' '
563 || content_string
[content_shift
] == '\t'; content_shift
++)
571 content_string
[0] = '\0';
579 if (content_string
[0] != '\0'
580 && mc_search (ptr
, content_string
+ content_shift
, MC_SEARCH_T_REGEX
))
588 /* --------------------------------------------------------------------------------------------- */
589 /*** public functions ****************************************************************************/
590 /* --------------------------------------------------------------------------------------------- */
593 flush_extension_file (void)
599 /* --------------------------------------------------------------------------------------------- */
601 * The second argument is action, i.e. Open, View or Edit
603 * This function returns:
605 * -1 for a failure or user interrupt
606 * 0 if no command was run
607 * 1 if some command was run
609 * If action == "View" then a parameter is checked in the form of "View:%d",
610 * if the value for %d exists, then the viewer is started up at that line number.
614 regex_command (const char *filename
, const char *action
, int *move_dir
)
617 int file_len
= strlen (filename
);
622 int view_at_line_number
;
623 char *include_target
;
624 int include_target_len
;
625 int have_type
= 0; /* Flag used by regex_check_type() */
627 /* Check for the special View:%d parameter */
628 if (strncmp (action
, "View:", 5) == 0)
630 view_at_line_number
= atoi (action
+ 5);
635 view_at_line_number
= 0;
640 char *extension_file
;
644 extension_file
= g_build_filename (mc_config_get_data_path (), MC_FILEBIND_FILE
, NULL
);
645 if (!exist_file (extension_file
))
647 g_free (extension_file
);
649 extension_file
= concat_dir_and_file (mc_global
.sysconfig_dir
, MC_LIB_EXT
);
650 if (!exist_file (extension_file
))
652 g_free (extension_file
);
653 extension_file
= concat_dir_and_file (mc_global
.share_data_dir
, MC_LIB_EXT
);
658 g_file_get_contents (extension_file
, &data
, NULL
, NULL
);
659 g_free (extension_file
);
663 if (!strstr (data
, "default/"))
665 if (!strstr (data
, "regex/") && !strstr (data
, "shell/") && !strstr (data
, "type/"))
672 goto check_stock_mc_ext
;
676 char *title
= g_strdup_printf (_(" %s%s file error"),
677 mc_global
.sysconfig_dir
, MC_LIB_EXT
);
678 message (D_ERROR
, title
, _("The format of the %smc.ext "
679 "file has changed with version 3.0. It seems that "
680 "the installation failed. Please fetch a fresh "
681 "copy from the Midnight Commander package."),
682 mc_global
.sysconfig_dir
);
690 char *title
= g_strdup_printf (_("%s%s%s file error"),
691 mc_config_get_data_path (), PATH_SEP_STR
,
693 message (D_ERROR
, title
,
694 _("The format of the %s%s%s file has "
695 "changed with version 3.0. You may either want to copy "
696 "it from %smc.ext or use that file as an example of how to write it."),
697 mc_config_get_data_path (), PATH_SEP_STR
, MC_FILEBIND_FILE
,
698 mc_global
.sysconfig_dir
);
702 mc_stat (filename
, &mystat
);
704 include_target
= NULL
;
705 include_target_len
= 0;
706 for (p
= data
; *p
; p
++)
708 for (q
= p
; *q
== ' ' || *q
== '\t'; q
++);
709 if (*q
== '\n' || !*q
)
710 p
= q
; /* empty line */
711 if (*p
== '#') /* comment */
712 while (*p
&& *p
!= '\n')
719 { /* i.e. starts in the first column, should be
723 q
= strchr (p
, '\n');
730 if ((strncmp (p
, "include/", 8) == 0)
731 && (strncmp (p
+ 8, include_target
, include_target_len
) == 0))
734 else if (!strncmp (p
, "regex/", 6))
737 /* Do not transform shell patterns, you can use shell/ for
740 if (mc_search (p
, filename
, MC_SEARCH_T_REGEX
))
743 else if (!strncmp (p
, "directory/", 10))
745 if (S_ISDIR (mystat
.st_mode
) && mc_search (p
+ 10, filename
, MC_SEARCH_T_REGEX
))
748 else if (!strncmp (p
, "shell/", 6))
751 if (*p
== '.' && file_len
>= (q
- p
))
753 if (!strncmp (p
, filename
+ file_len
- (q
- p
), q
- p
))
758 if (q
- p
== file_len
&& !strncmp (p
, filename
, q
- p
))
762 else if (!strncmp (p
, "type/", 5))
766 res
= regex_check_type (filename
, p
, &have_type
);
770 error_flag
= 1; /* leave it if file cannot be opened */
772 else if (!strncmp (p
, "default/", 8))
782 { /* List of actions */
784 q
= strchr (p
, '\n');
787 if (found
&& !error_flag
)
794 if (strcmp (p
, "Include") == 0)
798 include_target
= p
+ 8;
799 t
= strchr (include_target
, '\n');
802 include_target_len
= strlen (include_target
);
814 if (!strcmp (action
, p
))
817 for (p
= r
+ 1; *p
== ' ' || *p
== '\t'; p
++);
819 /* Empty commands just stop searching
820 * through, they don't do anything
822 * We need to copy the filename because exec_extension
823 * may end up invoking update_panels thus making the
824 * filename parameter invalid (ie, most of the time,
825 * we get filename as a pointer from current_panel->dir).
829 char *filename_copy
= g_strdup (filename
);
831 exec_extension (filename_copy
, r
+ 1, move_dir
, view_at_line_number
);
832 g_free (filename_copy
);
852 /* --------------------------------------------------------------------------------------------- */