src/execute.c

   1 /*
   2    Execution routines for GNU Midnight Commander
   3
   4    Copyright (C) 2003-2015
   5    Free Software Foundation, Inc.
   6
   7    Written by:
   8    Slava Zanko <slavazanko@gmail.com>, 2013
   9
  10    This file is part of the Midnight Commander.
  11
  12    The Midnight Commander is free software: you can redistribute it
  13    and/or modify it under the terms of the GNU General Public License as
  14    published by the Free Software Foundation, either version 3 of the License,
  15    or (at your option) any later version.
  16
  17    The Midnight Commander is distributed in the hope that it will be useful,
  18    but WITHOUT ANY WARRANTY; without even the implied warranty of
  19    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  20    GNU General Public License for more details.
  21
  22    You should have received a copy of the GNU General Public License
  23    along with this program.  If not, see <http://www.gnu.org/licenses/>.
  24  */
  25
  26 /** \file  execute.c
  27  *  \brief Source: execution routines
  28  */
  29
  30 #include <config.h>
  31
  32 #include <signal.h>
  33 #include <string.h>
  34 #include <sys/stat.h>
  35 #include <sys/time.h>
  36
  37 #include "lib/global.h"
  38
  39 #include "lib/tty/tty.h"
  40 #include "lib/tty/key.h"
  41 #include "lib/tty/win.h"
  42 #include "lib/vfs/vfs.h"
  43 #include "lib/mcconfig.h"
  44 #include "lib/util.h"
  45 #include "lib/strutil.h"        /* str_replace_all_substrings() */
  46 #include "lib/widget.h"
  47
  48 #include "filemanager/midnight.h"
  49 #include "filemanager/layout.h" /* use_dash() */
  50 #include "consaver/cons.saver.h"
  51 #ifdef ENABLE_SUBSHELL
  52 #include "subshell.h"
  53 #endif
  54 #include "setup.h"              /* clear_before_exec */
  55
  56 #include "execute.h"
  57
  58 /*** global variables ****************************************************************************/
  59
  60 int pause_after_run = pause_on_dumb_terminals;
  61
  62 /*** file scope macro definitions ****************************************************************/
  63
  64 /*** file scope type declarations ****************************************************************/
  65
  66 /*** file scope variables ************************************************************************/
  67
  68 /*** file scope functions ************************************************************************/
  69
  70 void do_execute (const char *shell, const char *command, int flags);
  71 void do_executev (const char *shell, int flags, char *const argv[]);
  72 char *execute_get_external_cmd_opts_from_config (const char *command,
  73                                                  const vfs_path_t * filename_vpath,
  74                                                  long start_line);
  75
  76 /* --------------------------------------------------------------------------------------------- */
  77
  78 static void
  79 edition_post_exec (void)
  80 {
  81     do_enter_ca_mode ();
  82
  83     /* FIXME: Missing on slang endwin? */
  84     tty_reset_prog_mode ();
  85     tty_flush_input ();
  86
  87     tty_keypad (TRUE);
  88     tty_raw_mode ();
  89     channels_up ();
  90     enable_mouse ();
  91     enable_bracketed_paste ();
  92     if (mc_global.tty.alternate_plus_minus)
  93         application_keypad_mode ();
  94 }
  95
  96 /* --------------------------------------------------------------------------------------------- */
  97
  98 static void
  99 edition_pre_exec (void)
 100 {
 101     if (clear_before_exec)
 102         clr_scr ();
 103     else
 104     {
 105         if (!(mc_global.tty.console_flag != '\0' || mc_global.tty.xterm_flag))
 106             printf ("\n\n");
 107     }
 108
 109     channels_down ();
 110     disable_mouse ();
 111     disable_bracketed_paste ();
 112
 113     tty_reset_shell_mode ();
 114     tty_keypad (FALSE);
 115     tty_reset_screen ();
 116
 117     numeric_keypad_mode ();
 118
 119     /* on xterms: maybe endwin did not leave the terminal on the shell
 120      * screen page: do it now.
 121      *
 122      * Do not move this before endwin: in some systems rmcup includes
 123      * a call to clear screen, so it will end up clearing the shell screen.
 124      */
 125     do_exit_ca_mode ();
 126 }
 127
 128 /* --------------------------------------------------------------------------------------------- */
 129
 130 #ifdef ENABLE_SUBSHELL
 131 static void
 132 do_possible_cd (const vfs_path_t * new_dir_vpath)
 133 {
 134     if (!do_cd (new_dir_vpath, cd_exact))
 135         message (D_ERROR, _("Warning"),
 136                  _("The Commander can't change to the directory that\n"
 137                    "the subshell claims you are in. Perhaps you have\n"
 138                    "deleted your working directory, or given yourself\n"
 139                    "extra access permissions with the \"su\" command?"));
 140 }
 141 #endif /* ENABLE_SUBSHELL */
 142
 143 /* --------------------------------------------------------------------------------------------- */
 144
 145 static void
 146 do_suspend_cmd (void)
 147 {
 148     pre_exec ();
 149
 150     if (mc_global.tty.console_flag != '\0' && !mc_global.tty.use_subshell)
 151         handle_console (CONSOLE_RESTORE);
 152
 153 #ifdef SIGTSTP
 154     {
 155         struct sigaction sigtstp_action;
 156
 157         memset (&sigtstp_action, 0, sizeof (sigtstp_action));
 158         /* Make sure that the SIGTSTP below will suspend us directly,
 159            without calling ncurses' SIGTSTP handler; we *don't* want
 160            ncurses to redraw the screen immediately after the SIGCONT */
 161         sigaction (SIGTSTP, &startup_handler, &sigtstp_action);
 162
 163         kill (getpid (), SIGTSTP);
 164
 165         /* Restore previous SIGTSTP action */
 166         sigaction (SIGTSTP, &sigtstp_action, NULL);
 167     }
 168 #endif /* SIGTSTP */
 169
 170     if (mc_global.tty.console_flag != '\0' && !mc_global.tty.use_subshell)
 171         handle_console (CONSOLE_SAVE);
 172
 173     edition_post_exec ();
 174 }
 175
 176 /* --------------------------------------------------------------------------------------------- */
 177
 178 static gboolean
 179 execute_prepare_with_vfs_arg (const vfs_path_t * filename_vpath, vfs_path_t ** localcopy_vpath,
 180                               time_t * mtime)
 181 {
 182     struct stat st;
 183
 184     /* Simplest case, this file is local */
 185     if ((filename_vpath == NULL && vfs_file_is_local (vfs_get_raw_current_dir ()))
 186         || vfs_file_is_local (filename_vpath))
 187         return TRUE;
 188
 189     /* FIXME: Creation of new files on VFS is not supported */
 190     if (filename_vpath == NULL)
 191         return FALSE;
 192
 193     *localcopy_vpath = mc_getlocalcopy (filename_vpath);
 194     if (*localcopy_vpath == NULL)
 195     {
 196         message (D_ERROR, MSG_ERROR, _("Cannot fetch a local copy of %s"),
 197                  vfs_path_as_str (filename_vpath));
 198         return FALSE;
 199     }
 200
 201     mc_stat (*localcopy_vpath, &st);
 202     *mtime = st.st_mtime;
 203     return TRUE;
 204 }
 205
 206 /* --------------------------------------------------------------------------------------------- */
 207
 208 static void
 209 execute_cleanup_with_vfs_arg (const vfs_path_t * filename_vpath, vfs_path_t ** localcopy_vpath,
 210                               time_t * mtime)
 211 {
 212     if (*localcopy_vpath != NULL)
 213     {
 214         struct stat st;
 215
 216         /*
 217          * filename can be an entry on panel, it can be changed by executing
 218          * the command, so make a copy.  Smarter VFS code would make the code
 219          * below unnecessary.
 220          */
 221         mc_stat (*localcopy_vpath, &st);
 222         mc_ungetlocalcopy (filename_vpath, *localcopy_vpath, *mtime != st.st_mtime);
 223         vfs_path_free (*localcopy_vpath);
 224         *localcopy_vpath = NULL;
 225     }
 226 }
 227
 228 /* --------------------------------------------------------------------------------------------- */
 229
 230 static char *
 231 execute_get_opts_from_cfg (const char *command, const char *default_str)
 232 {
 233     char *str_from_config;
 234
 235     str_from_config =
 236         mc_config_get_string_raw (mc_main_config, CONFIG_EXT_EDITOR_VIEWER_SECTION, command, NULL);
 237
 238     if (str_from_config == NULL)
 239     {
 240         mc_config_t *cfg;
 241
 242         cfg = mc_config_init (global_profile_name, TRUE);
 243         if (cfg == NULL)
 244             return g_strdup (default_str);
 245
 246         str_from_config =
 247             mc_config_get_string_raw (cfg, CONFIG_EXT_EDITOR_VIEWER_SECTION, command, default_str);
 248
 249         mc_config_deinit (cfg);
 250     }
 251
 252     return str_from_config;
 253 }
 254
 255 /* --------------------------------------------------------------------------------------------- */
 256 /*** public functions ****************************************************************************/
 257 /* --------------------------------------------------------------------------------------------- */
 258
 259 char *
 260 execute_get_external_cmd_opts_from_config (const char *command, const vfs_path_t * filename_vpath,
 261                                            long start_line)
 262 {
 263     char *str_from_config, *return_str;
 264     char *parameter;
 265
 266     if (filename_vpath == NULL)
 267         return g_strdup ("");
 268
 269     parameter = g_shell_quote (vfs_path_get_last_path_str (filename_vpath));
 270
 271     if (start_line <= 0)
 272         return parameter;
 273
 274     str_from_config = execute_get_opts_from_cfg (command, "%filename");
 275
 276     return_str = str_replace_all (str_from_config, "%filename", parameter);
 277     g_free (parameter);
 278     g_free (str_from_config);
 279     str_from_config = return_str;
 280
 281     parameter = g_strdup_printf ("%ld", start_line);
 282     return_str = str_replace_all (str_from_config, "%lineno", parameter);
 283     g_free (parameter);
 284     g_free (str_from_config);
 285
 286     return return_str;
 287 }
 288
 289 /* --------------------------------------------------------------------------------------------- */
 290
 291 void
 292 do_executev (const char *shell, int flags, char *const argv[])
 293 {
 294 #ifdef ENABLE_SUBSHELL
 295     vfs_path_t *new_dir_vpath = NULL;
 296 #endif /* ENABLE_SUBSHELL */
 297
 298     vfs_path_t *old_vfs_dir_vpath = NULL;
 299
 300     if (!vfs_current_is_local ())
 301         old_vfs_dir_vpath = vfs_path_clone (vfs_get_raw_current_dir ());
 302
 303     if (mc_global.mc_run_mode == MC_RUN_FULL)
 304         save_cwds_stat ();
 305     pre_exec ();
 306     if (mc_global.tty.console_flag != '\0')
 307         handle_console (CONSOLE_RESTORE);
 308
 309     if (!mc_global.tty.use_subshell && *argv != NULL && (flags & EXECUTE_INTERNAL) == 0)
 310     {
 311         printf ("%s%s\n", mc_prompt, *argv);
 312         fflush (stdout);
 313     }
 314 #ifdef ENABLE_SUBSHELL
 315     if (mc_global.tty.use_subshell && (flags & EXECUTE_INTERNAL) == 0)
 316     {
 317         do_update_prompt ();
 318
 319         /* We don't care if it died, higher level takes care of this */
 320         invoke_subshell (*argv, VISIBLY, old_vfs_dir_vpath != NULL ? NULL : &new_dir_vpath);
 321     }
 322     else
 323 #endif /* ENABLE_SUBSHELL */
 324         my_systemv_flags (flags, shell, argv);
 325
 326     if ((flags & EXECUTE_INTERNAL) == 0)
 327     {
 328         if ((pause_after_run == pause_always
 329              || (pause_after_run == pause_on_dumb_terminals && !mc_global.tty.xterm_flag
 330                  && mc_global.tty.console_flag == '\0')) && quit == 0
 331 #ifdef ENABLE_SUBSHELL
 332             && subshell_state != RUNNING_COMMAND
 333 #endif /* ENABLE_SUBSHELL */
 334             )
 335         {
 336             printf (_("Press any key to continue..."));
 337             fflush (stdout);
 338             tty_raw_mode ();
 339             get_key_code (0);
 340             printf ("\r\n");
 341             fflush (stdout);
 342         }
 343         if (mc_global.tty.console_flag != '\0' && output_lines != 0 && mc_global.keybar_visible)
 344         {
 345             putchar ('\n');
 346             fflush (stdout);
 347         }
 348     }
 349
 350     if (mc_global.tty.console_flag != '\0')
 351         handle_console (CONSOLE_SAVE);
 352     edition_post_exec ();
 353
 354 #ifdef ENABLE_SUBSHELL
 355     if (new_dir_vpath != NULL)
 356     {
 357         do_possible_cd (new_dir_vpath);
 358         vfs_path_free (new_dir_vpath);
 359     }
 360
 361 #endif /* ENABLE_SUBSHELL */
 362
 363     if (old_vfs_dir_vpath != NULL)
 364     {
 365         mc_chdir (old_vfs_dir_vpath);
 366         vfs_path_free (old_vfs_dir_vpath);
 367     }
 368
 369     if (mc_global.mc_run_mode == MC_RUN_FULL)
 370     {
 371         update_panels (UP_OPTIMIZE, UP_KEEPSEL);
 372         update_xterm_title_path ();
 373     }
 374
 375     do_refresh ();
 376     use_dash (TRUE);
 377 }
 378
 379 /* --------------------------------------------------------------------------------------------- */
 380
 381 void
 382 do_execute (const char *shell, const char *command, int flags)
 383 {
 384     GPtrArray *args_array;
 385
 386     args_array = g_ptr_array_new ();
 387     g_ptr_array_add (args_array, (char *) command);
 388     g_ptr_array_add (args_array, NULL);
 389
 390     do_executev (shell, flags, (char *const *) args_array->pdata);
 391
 392     g_ptr_array_free (args_array, TRUE);
 393 }
 394
 395 /* --------------------------------------------------------------------------------------------- */
 396
 397 /** Set up the terminal before executing a program */
 398
 399 void
 400 pre_exec (void)
 401 {
 402     use_dash (FALSE);
 403     edition_pre_exec ();
 404 }
 405
 406 /* --------------------------------------------------------------------------------------------- */
 407 /** Hide the terminal after executing a program */
 408 void
 409 post_exec (void)
 410 {
 411     edition_post_exec ();
 412     use_dash (TRUE);
 413     repaint_screen ();
 414 }
 415
 416 /* --------------------------------------------------------------------------------------------- */
 417 /* Executes a command */
 418
 419 void
 420 shell_execute (const char *command, int flags)
 421 {
 422     char *cmd = NULL;
 423
 424     if (flags & EXECUTE_HIDE)
 425     {
 426         cmd = g_strconcat (" ", command, (char *) NULL);
 427         flags ^= EXECUTE_HIDE;
 428     }
 429
 430 #ifdef ENABLE_SUBSHELL
 431     if (mc_global.tty.use_subshell)
 432         if (subshell_state == INACTIVE)
 433             do_execute (mc_global.tty.shell, cmd ? cmd : command, flags | EXECUTE_AS_SHELL);
 434         else
 435             message (D_ERROR, MSG_ERROR, _("The shell is already running a command"));
 436     else
 437 #endif /* ENABLE_SUBSHELL */
 438         do_execute (mc_global.tty.shell, cmd ? cmd : command, flags | EXECUTE_AS_SHELL);
 439
 440     g_free (cmd);
 441 }
 442
 443 /* --------------------------------------------------------------------------------------------- */
 444
 445 void
 446 exec_shell (void)
 447 {
 448     do_execute (mc_global.tty.shell, 0, 0);
 449 }
 450
 451 /* --------------------------------------------------------------------------------------------- */
 452
 453 void
 454 toggle_panels (void)
 455 {
 456 #ifdef ENABLE_SUBSHELL
 457     vfs_path_t *new_dir_vpath = NULL;
 458 #endif /* ENABLE_SUBSHELL */
 459
 460     SIG_ATOMIC_VOLATILE_T was_sigwinch = 0;
 461
 462     channels_down ();
 463     disable_mouse ();
 464     disable_bracketed_paste ();
 465     if (clear_before_exec)
 466         clr_scr ();
 467     if (mc_global.tty.alternate_plus_minus)
 468         numeric_keypad_mode ();
 469 #ifndef HAVE_SLANG
 470     /* With slang we don't want any of this, since there
 471      * is no raw_mode supported
 472      */
 473     tty_reset_shell_mode ();
 474 #endif /* !HAVE_SLANG */
 475     tty_noecho ();
 476     tty_keypad (FALSE);
 477     tty_reset_screen ();
 478     do_exit_ca_mode ();
 479     tty_raw_mode ();
 480     if (mc_global.tty.console_flag != '\0')
 481         handle_console (CONSOLE_RESTORE);
 482
 483 #ifdef ENABLE_SUBSHELL
 484     if (mc_global.tty.use_subshell)
 485     {
 486         vfs_path_t **new_dir_p;
 487
 488         new_dir_p = vfs_current_is_local ()? &new_dir_vpath : NULL;
 489         invoke_subshell (NULL, VISIBLY, new_dir_p);
 490     }
 491     else
 492 #endif /* ENABLE_SUBSHELL */
 493     {
 494         if (output_starts_shell)
 495         {
 496             fprintf (stderr, _("Type 'exit' to return to the Midnight Commander"));
 497             fprintf (stderr, "\n\r\n\r");
 498
 499             my_system (EXECUTE_INTERNAL, mc_global.tty.shell, NULL);
 500         }
 501         else
 502             get_key_code (0);
 503     }
 504
 505     if (mc_global.tty.console_flag != '\0')
 506         handle_console (CONSOLE_SAVE);
 507
 508     do_enter_ca_mode ();
 509
 510     tty_reset_prog_mode ();
 511     tty_keypad (TRUE);
 512
 513     /* Prevent screen flash when user did 'exit' or 'logout' within
 514        subshell */
 515     if ((quit & SUBSHELL_EXIT) != 0)
 516     {
 517         /* User did 'exit' or 'logout': quit MC */
 518         if (quiet_quit_cmd ())
 519             return;
 520
 521         quit = 0;
 522 #ifdef ENABLE_SUBSHELL
 523         /* restart subshell */
 524         if (mc_global.tty.use_subshell)
 525             init_subshell ();
 526 #endif /* ENABLE_SUBSHELL */
 527     }
 528
 529     enable_mouse ();
 530     enable_bracketed_paste ();
 531     channels_up ();
 532     if (mc_global.tty.alternate_plus_minus)
 533         application_keypad_mode ();
 534
 535     /* HACK:
 536      * Save sigwinch flag that will be reset in mc_refresh() called via update_panels().
 537      * There is some problem with screen redraw in ncurses-based mc in this situation.
 538      */
 539     was_sigwinch = mc_global.tty.winch_flag;
 540     mc_global.tty.winch_flag = 0;
 541
 542 #ifdef ENABLE_SUBSHELL
 543     if (mc_global.tty.use_subshell)
 544     {
 545         do_load_prompt ();
 546         if (new_dir_vpath != NULL)
 547             do_possible_cd (new_dir_vpath);
 548         if (mc_global.tty.console_flag != '\0' && output_lines)
 549             show_console_contents (output_start_y,
 550                                    LINES - mc_global.keybar_visible - output_lines -
 551                                    1, LINES - mc_global.keybar_visible - 1);
 552     }
 553
 554     vfs_path_free (new_dir_vpath);
 555 #endif /* ENABLE_SUBSHELL */
 556
 557     if (mc_global.mc_run_mode == MC_RUN_FULL)
 558     {
 559         update_panels (UP_OPTIMIZE, UP_KEEPSEL);
 560         update_xterm_title_path ();
 561     }
 562
 563     if (was_sigwinch != 0 || mc_global.tty.winch_flag != 0)
 564         dialog_change_screen_size ();
 565     else
 566         repaint_screen ();
 567 }
 568
 569 /* --------------------------------------------------------------------------------------------- */
 570
 571 /* event callback */
 572 gboolean
 573 execute_suspend (const gchar * event_group_name, const gchar * event_name,
 574                  gpointer init_data, gpointer data)
 575 {
 576     (void) event_group_name;
 577     (void) event_name;
 578     (void) init_data;
 579     (void) data;
 580
 581     if (mc_global.mc_run_mode == MC_RUN_FULL)
 582         save_cwds_stat ();
 583     do_suspend_cmd ();
 584     if (mc_global.mc_run_mode == MC_RUN_FULL)
 585         update_panels (UP_OPTIMIZE, UP_KEEPSEL);
 586     do_refresh ();
 587
 588     return TRUE;
 589 }
 590
 591 /* --------------------------------------------------------------------------------------------- */
 592
 593 /**
 594  * Execute command on a filename that can be on VFS.
 595  * Errors are reported to the user.
 596  */
 597
 598 void
 599 execute_with_vfs_arg (const char *command, const vfs_path_t * filename_vpath)
 600 {
 601     vfs_path_t *localcopy_vpath = NULL;
 602     const vfs_path_t *do_execute_vpath;
 603     time_t mtime;
 604
 605     if (!execute_prepare_with_vfs_arg (filename_vpath, &localcopy_vpath, &mtime))
 606         return;
 607
 608     do_execute_vpath = (localcopy_vpath == NULL) ? filename_vpath : localcopy_vpath;
 609
 610     do_execute (command, vfs_path_get_last_path_str (do_execute_vpath), EXECUTE_INTERNAL);
 611
 612     execute_cleanup_with_vfs_arg (filename_vpath, &localcopy_vpath, &mtime);
 613 }
 614
 615 /* --------------------------------------------------------------------------------------------- */
 616 /**
 617  * Execute external editor or viewer.
 618  *
 619  * @param command editor/viewer to run
 620  * @param filename_vpath path for edit/view
 621  * @param start_line cursor will be placed at the 'start_line' position after opening file
 622  *        if start_line is 0 or negative, no start line will be passed to editor/viewer
 623  */
 624
 625 void
 626 execute_external_editor_or_viewer (const char *command, const vfs_path_t * filename_vpath,
 627                                    long start_line)
 628 {
 629     vfs_path_t *localcopy_vpath = NULL;
 630     const vfs_path_t *do_execute_vpath;
 631     char *extern_cmd_options;
 632     time_t mtime;
 633
 634     if (!execute_prepare_with_vfs_arg (filename_vpath, &localcopy_vpath, &mtime))
 635         return;
 636
 637     do_execute_vpath = (localcopy_vpath == NULL) ? filename_vpath : localcopy_vpath;
 638
 639     extern_cmd_options =
 640         execute_get_external_cmd_opts_from_config (command, do_execute_vpath, start_line);
 641
 642     if (extern_cmd_options != NULL)
 643     {
 644         char **argv_cmd_options;
 645         int argv_count;
 646
 647         if (g_shell_parse_argv (extern_cmd_options, &argv_count, &argv_cmd_options, NULL))
 648         {
 649             do_executev (command, EXECUTE_INTERNAL, argv_cmd_options);
 650             g_strfreev (argv_cmd_options);
 651         }
 652         else
 653             do_executev (command, EXECUTE_INTERNAL, NULL);
 654
 655         g_free (extern_cmd_options);
 656
 657     }
 658
 659     execute_cleanup_with_vfs_arg (filename_vpath, &localcopy_vpath, &mtime);
 660 }
 661
 662 /* --------------------------------------------------------------------------------------------- */