1 /* Extension dependent execution.
2 Copyright (C) 1994, 1995, 1998, 1999, 2000, 2001, 2002, 2003, 2004,
3 2005, 2007 Free Software Foundation, Inc.
5 Written by: 1995 Jakub Jelinek
8 This program is free software; you can redistribute it and/or modify
9 it under the terms of the GNU General Public License as published by
10 the Free Software Foundation; either version 2 of the License, or
11 (at your option) any later version.
13 This program is distributed in the hope that it will be useful,
14 but WITHOUT ANY WARRANTY; without even the implied warranty of
15 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 GNU General Public License for more details.
18 You should have received a copy of the GNU General Public License
19 along with this program; if not, write to the Free Software
20 Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. */
23 * \brief Source: extension dependent execution
35 #include "lib/global.h"
36 #include "lib/tty/tty.h"
37 #include "lib/search.h"
38 #include "lib/fileloc.h"
40 #include "lib/vfs/mc-vfs/vfs.h"
41 #include "lib/widget.h"
42 #include "lib/charsets.h" /* get_codepage_index */
44 #include "src/setup.h" /* use_file_to_check_type */
45 #include "src/execute.h"
46 #include "src/history.h"
48 #include "src/consaver/cons.saver.h"
49 #include "src/viewer/mcviewer.h"
52 #include "src/selcodepage.h" /* do_set_codepage */
60 /*** global variables ****************************************************************************/
62 /*** file scope macro definitions ****************************************************************/
65 #define FILE_CMD "file -L "
67 #define FILE_CMD "file "
70 /*** file scope type declarations ****************************************************************/
72 typedef char *(*quote_func_t
) (const char *name
, int quote_percent
);
74 /*** file scope variables ************************************************************************/
76 /* This variable points to a copy of the mc.ext file in memory
77 * With this we avoid loading/parsing the file each time we
80 static char *data
= NULL
;
82 /*** file scope functions ************************************************************************/
83 /* --------------------------------------------------------------------------------------------- */
86 exec_extension (const char *filename
, const char *lc_data
, int *move_dir
, int start_line
)
93 int expand_prefix_found
= 0;
94 int parameter_found
= 0;
97 int def_hex_mode
= mcview_default_hex_mode
, changed_hex_mode
= 0;
98 int def_nroff_flag
= mcview_default_nroff_flag
, changed_nroff_flag
= 0;
99 int written_nonspace
= 0;
103 char *localcopy
= NULL
;
105 time_t localmtime
= 0;
107 quote_func_t quote_func
= name_quote
;
109 g_return_if_fail (filename
!= NULL
);
110 g_return_if_fail (lc_data
!= NULL
);
112 /* Avoid making a local copy if we are doing a cd */
113 if (!vfs_file_is_local (filename
))
119 * All commands should be run in /bin/sh regardless of user shell.
120 * To do that, create temporary shell script and run it.
121 * Sometimes it's not needed (e.g. for %cd and %view commands),
122 * but it's easier to create it anyway.
124 cmd_file_fd
= mc_mkstemps (&file_name
, "mcext", SCRIPT_SUFFIX
);
126 if (cmd_file_fd
== -1)
128 message (D_ERROR
, MSG_ERROR
,
129 _("Cannot create temporary command file\n%s"), unix_error_string (errno
));
133 cmd_file
= fdopen (cmd_file_fd
, "w");
134 fputs ("#! /bin/sh\n", cmd_file
);
137 for (; *lc_data
!= '\0' && *lc_data
!= '\n'; lc_data
++)
146 parameter
= input_dialog (_("Parameter"), lc_prompt
, MC_HISTORY_EXT_PARAMETER
, "");
147 if (parameter
== NULL
)
154 mc_ungetlocalcopy (filename
, localcopy
, 0);
160 fputs (parameter
, cmd_file
);
161 written_nonspace
= 1;
166 size_t len
= strlen (lc_prompt
);
168 if (len
< sizeof (lc_prompt
) - 1)
170 lc_prompt
[len
] = *lc_data
;
171 lc_prompt
[len
+ 1] = '\0';
175 else if (expand_prefix_found
)
177 expand_prefix_found
= 0;
185 i
= check_format_view (lc_data
);
193 i
= check_format_cd (lc_data
);
197 quote_func
= fake_name_quote
;
204 i
= check_format_var (lc_data
, &v
);
205 if (i
> 0 && v
!= NULL
)
216 text
= expand_format (NULL
, *lc_data
, !is_cd
);
221 localcopy
= mc_getlocalcopy (filename
);
222 if (localcopy
== NULL
)
229 mc_stat (localcopy
, &mystat
);
230 localmtime
= mystat
.st_mtime
;
231 text
= quote_func (localcopy
, 0);
235 fn
= vfs_canon_and_translate (filename
);
236 text
= quote_func (fn
, 0);
242 fputs (text
, cmd_file
);
250 written_nonspace
= 1;
256 else if (*lc_data
== '%')
257 expand_prefix_found
= 1;
260 if (*lc_data
!= ' ' && *lc_data
!= '\t')
261 written_nonspace
= 1;
265 fputc (*lc_data
, cmd_file
);
270 * Make the script remove itself when it finishes.
271 * Don't do it for the viewer - it may need to rerun the script,
272 * so we clean up after calling view().
275 fprintf (cmd_file
, "\n/bin/rm -f %s\n", file_name
);
279 if ((run_view
&& !written_nonspace
) || is_cd
)
287 /* Set executable flag on the command file ... */
288 chmod (file_name
, S_IRWXU
);
289 /* ... but don't rely on it - run /bin/sh explicitly */
290 cmd
= g_strconcat ("/bin/sh ", file_name
, (char *) NULL
);
297 mcview_altered_hex_mode
= 0;
298 mcview_altered_nroff_flag
= 0;
299 if (def_hex_mode
!= mcview_default_hex_mode
)
300 changed_hex_mode
= 1;
301 if (def_nroff_flag
!= mcview_default_nroff_flag
)
302 changed_nroff_flag
= 1;
304 /* If we've written whitespace only, then just load filename
307 if (written_nonspace
)
309 ret
= mcview_viewer (cmd
, filename
, start_line
);
313 ret
= mcview_viewer (NULL
, filename
, start_line
);
315 if (move_dir
!= NULL
)
318 case MCVIEW_WANT_NEXT
:
321 case MCVIEW_WANT_PREV
:
328 if (changed_hex_mode
&& !mcview_altered_hex_mode
)
329 mcview_default_hex_mode
= def_hex_mode
;
330 if (changed_nroff_flag
&& !mcview_altered_nroff_flag
)
331 mcview_default_nroff_flag
= def_nroff_flag
;
333 dialog_switch_process_pending ();
340 /* while (*p == ' ' && *p == '\t')
343 /* Search last non-space character. Start search at the end in order
344 not to short filenames containing spaces. */
345 q
= p
+ strlen (p
) - 1;
346 while (q
>= p
&& (*q
== ' ' || *q
== '\t'))
349 do_cd (p
, cd_parse_command
);
353 shell_execute (cmd
, EXECUTE_INTERNAL
);
356 handle_console (CONSOLE_SAVE
);
357 if (output_lines
&& keybar_visible
)
358 show_console_contents (output_start_y
,
359 LINES
- keybar_visible
-
360 output_lines
- 1, LINES
- keybar_visible
- 1);
369 mc_stat (localcopy
, &mystat
);
370 mc_ungetlocalcopy (filename
, localcopy
, localmtime
!= mystat
.st_mtime
);
375 /* --------------------------------------------------------------------------------------------- */
377 * Run cmd_file with args, put result into buf.
378 * If error, put '\0' into buf[0]
379 * Return 1 if the data is valid, 0 otherwise, -1 for fatal errors.
381 * NOTES: buf is null-terminated string.
385 get_popen_information (const char *cmd_file
, const char *args
, char *buf
, int buflen
)
387 gboolean read_bytes
= FALSE
;
391 command
= g_strconcat (cmd_file
, args
, " 2>/dev/null", (char *) NULL
);
392 f
= popen (command
, "r");
398 if (setvbuf (f
, NULL
, _IOFBF
, 0) != 0)
404 read_bytes
= (fgets (buf
, buflen
, f
) != NULL
);
406 buf
[0] = '\0'; /* Paranoid termination */
411 buf
[0] = '\0'; /* Paranoid termination */
415 buf
[buflen
- 1] = '\0';
417 return read_bytes
? 1 : 0;
420 /* --------------------------------------------------------------------------------------------- */
422 * Run the "file" command on the local file.
423 * Return 1 if the data is valid, 0 otherwise, -1 for fatal errors.
427 get_file_type_local (const char *filename
, char *buf
, int buflen
)
432 tmp
= name_quote (filename
, 0);
433 ret
= get_popen_information (FILE_CMD
, tmp
, buf
, buflen
);
439 /* --------------------------------------------------------------------------------------------- */
441 * Run the "enca" command on the local file.
442 * Return 1 if the data is valid, 0 otherwise, -1 for fatal errors.
447 get_file_encoding_local (const char *filename
, char *buf
, int buflen
)
449 char *tmp
, *lang
, *args
;
452 tmp
= name_quote (filename
, 0);
453 lang
= name_quote (autodetect_codeset
, 0);
454 args
= g_strconcat (" -L", lang
, " -i ", tmp
, (char *) NULL
);
456 ret
= get_popen_information ("enca", args
, buf
, buflen
);
464 #endif /* HAVE_CHARSET */
466 /* --------------------------------------------------------------------------------------------- */
468 * Invoke the "file" command on the file and match its output against PTR.
469 * have_type is a flag that is set if we already have tried to determine
470 * the type of that file.
471 * Return 1 for match, 0 for no match, -1 errors.
475 regex_check_type (const char *filename
, const char *ptr
, int *have_type
)
479 /* Following variables are valid if *have_type is 1 */
480 static char content_string
[2048];
481 static char encoding_id
[21]; /* CSISO51INISCYRILLIC -- 20 */
482 static size_t content_shift
= 0;
483 static int got_data
= 0;
485 if (!use_file_to_check_type
)
490 char *realname
; /* name used with "file" */
494 int got_encoding_data
;
495 #endif /* HAVE_CHARSET */
497 /* Don't repeate even unsuccessful checks */
500 localfile
= mc_getlocalcopy (filename
);
501 if (localfile
== NULL
)
504 realname
= localfile
;
507 got_encoding_data
= is_autodetect_codeset_enabled
508 ? get_file_encoding_local (localfile
, encoding_id
, sizeof (encoding_id
)) : 0;
510 if (got_encoding_data
> 0)
515 pp
= strchr (encoding_id
, '\n');
519 cp_id
= get_codepage_index (encoding_id
);
521 cp_id
= default_source_codepage
;
523 do_set_codepage (cp_id
);
525 #endif /* HAVE_CHARSET */
527 mc_ungetlocalcopy (filename
, localfile
, 0);
529 got_data
= get_file_type_local (localfile
, content_string
, sizeof (content_string
));
536 pp
= strchr (content_string
, '\n');
540 real_len
= strlen (realname
);
542 if (strncmp (content_string
, realname
, real_len
) == 0)
544 /* Skip "realname: " */
545 content_shift
= real_len
;
546 if (content_string
[content_shift
] == ':')
548 /* Solaris' file prints tab(s) after ':' */
549 for (content_shift
++;
550 content_string
[content_shift
] == ' '
551 || content_string
[content_shift
] == '\t'; content_shift
++)
559 content_string
[0] = '\0';
567 if (content_string
[0] != '\0'
568 && mc_search (ptr
, content_string
+ content_shift
, MC_SEARCH_T_REGEX
))
576 /* --------------------------------------------------------------------------------------------- */
577 /*** public functions ****************************************************************************/
578 /* --------------------------------------------------------------------------------------------- */
581 flush_extension_file (void)
587 /* --------------------------------------------------------------------------------------------- */
589 * The second argument is action, i.e. Open, View or Edit
591 * This function returns:
593 * -1 for a failure or user interrupt
594 * 0 if no command was run
595 * 1 if some command was run
597 * If action == "View" then a parameter is checked in the form of "View:%d",
598 * if the value for %d exists, then the viewer is started up at that line number.
602 regex_command (const char *filename
, const char *action
, int *move_dir
)
605 int file_len
= strlen (filename
);
610 int view_at_line_number
;
611 char *include_target
;
612 int include_target_len
;
613 int have_type
= 0; /* Flag used by regex_check_type() */
615 /* Check for the special View:%d parameter */
616 if (strncmp (action
, "View:", 5) == 0)
618 view_at_line_number
= atoi (action
+ 5);
623 view_at_line_number
= 0;
628 char *extension_file
;
632 extension_file
= g_build_filename (home_dir
, MC_USERCONF_DIR
, MC_FILEBIND_FILE
, NULL
);
633 if (!exist_file (extension_file
))
635 g_free (extension_file
);
637 extension_file
= concat_dir_and_file (mc_home
, MC_LIB_EXT
);
638 if (!exist_file (extension_file
))
640 g_free (extension_file
);
641 extension_file
= concat_dir_and_file (mc_home_alt
, MC_LIB_EXT
);
646 g_file_get_contents (extension_file
, &data
, NULL
, NULL
);
647 g_free (extension_file
);
651 if (!strstr (data
, "default/"))
653 if (!strstr (data
, "regex/") && !strstr (data
, "shell/") && !strstr (data
, "type/"))
660 goto check_stock_mc_ext
;
664 char *title
= g_strdup_printf (_(" %s%s file error"),
665 mc_home
, MC_LIB_EXT
);
666 message (D_ERROR
, title
, _("The format of the %smc.ext "
667 "file has changed with version 3.0. It seems that "
668 "the installation failed. Please fetch a fresh "
669 "copy from the Midnight Commander package."),
678 char *title
= g_strdup_printf (_("~/%s file error"),
679 MC_USERCONF_DIR PATH_SEP_STR MC_FILEBIND_FILE
);
680 message (D_ERROR
, title
,
681 _("The format of the ~/%s file has "
682 "changed with version 3.0. You may either want to copy "
683 "it from %smc.ext or use that file as an example of how to write it."),
684 MC_USERCONF_DIR PATH_SEP_STR MC_FILEBIND_FILE
, mc_home
);
688 mc_stat (filename
, &mystat
);
690 include_target
= NULL
;
691 include_target_len
= 0;
692 for (p
= data
; *p
; p
++)
694 for (q
= p
; *q
== ' ' || *q
== '\t'; q
++);
695 if (*q
== '\n' || !*q
)
696 p
= q
; /* empty line */
697 if (*p
== '#') /* comment */
698 while (*p
&& *p
!= '\n')
705 { /* i.e. starts in the first column, should be
709 q
= strchr (p
, '\n');
716 if ((strncmp (p
, "include/", 8) == 0)
717 && (strncmp (p
+ 8, include_target
, include_target_len
) == 0))
720 else if (!strncmp (p
, "regex/", 6))
723 /* Do not transform shell patterns, you can use shell/ for
726 if (mc_search (p
, filename
, MC_SEARCH_T_REGEX
))
729 else if (!strncmp (p
, "directory/", 10))
731 if (S_ISDIR (mystat
.st_mode
) && mc_search (p
+ 10, filename
, MC_SEARCH_T_REGEX
))
734 else if (!strncmp (p
, "shell/", 6))
737 if (*p
== '.' && file_len
>= (q
- p
))
739 if (!strncmp (p
, filename
+ file_len
- (q
- p
), q
- p
))
744 if (q
- p
== file_len
&& !strncmp (p
, filename
, q
- p
))
748 else if (!strncmp (p
, "type/", 5))
752 res
= regex_check_type (filename
, p
, &have_type
);
756 error_flag
= 1; /* leave it if file cannot be opened */
758 else if (!strncmp (p
, "default/", 8))
768 { /* List of actions */
770 q
= strchr (p
, '\n');
773 if (found
&& !error_flag
)
780 if (strcmp (p
, "Include") == 0)
784 include_target
= p
+ 8;
785 t
= strchr (include_target
, '\n');
788 include_target_len
= strlen (include_target
);
800 if (!strcmp (action
, p
))
803 for (p
= r
+ 1; *p
== ' ' || *p
== '\t'; p
++);
805 /* Empty commands just stop searching
806 * through, they don't do anything
808 * We need to copy the filename because exec_extension
809 * may end up invoking update_panels thus making the
810 * filename parameter invalid (ie, most of the time,
811 * we get filename as a pointer from current_panel->dir).
815 char *filename_copy
= g_strdup (filename
);
817 exec_extension (filename_copy
, r
+ 1, move_dir
, view_at_line_number
);
818 g_free (filename_copy
);
838 /* --------------------------------------------------------------------------------------------- */