src/viewer/mcviewer.c

   1 /*
   2    Internal file viewer for the Midnight Commander
   3    Interface functions
   4
   5    Copyright (C) 1994-2017
   6    Free Software Foundation, Inc
   7
   8    Written by:
   9    Miguel de Icaza, 1994, 1995, 1998
  10    Janne Kukonlehto, 1994, 1995
  11    Jakub Jelinek, 1995
  12    Joseph M. Hinkle, 1996
  13    Norbert Warmuth, 1997
  14    Pavel Machek, 1998
  15    Roland Illig <roland.illig@gmx.de>, 2004, 2005
  16    Slava Zanko <slavazanko@google.com>, 2009, 2013
  17    Andrew Borodin <aborodin@vmail.ru>, 2009, 2013
  18    Ilia Maslakov <il.smind@gmail.com>, 2009
  19
  20    This file is part of the Midnight Commander.
  21
  22    The Midnight Commander is free software: you can redistribute it
  23    and/or modify it under the terms of the GNU General Public License as
  24    published by the Free Software Foundation, either version 3 of the License,
  25    or (at your option) any later version.
  26
  27    The Midnight Commander is distributed in the hope that it will be useful,
  28    but WITHOUT ANY WARRANTY; without even the implied warranty of
  29    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  30    GNU General Public License for more details.
  31
  32    You should have received a copy of the GNU General Public License
  33    along with this program.  If not, see <http://www.gnu.org/licenses/>.
  34  */
  35
  36 #include <config.h>
  37 #include <errno.h>
  38
  39 #include "lib/global.h"
  40 #include "lib/tty/tty.h"
  41 #include "lib/vfs/vfs.h"
  42 #include "lib/strutil.h"
  43 #include "lib/util.h"           /* load_file_position() */
  44 #include "lib/widget.h"
  45
  46 #include "src/filemanager/layout.h"     /* menubar_visible */
  47 #include "src/filemanager/midnight.h"   /* the_menubar */
  48
  49 #include "internal.h"
  50
  51 /*** global variables ****************************************************************************/
  52
  53 int mcview_default_hex_mode = 0;
  54 int mcview_default_nroff_flag = 0;
  55 gboolean mcview_global_wrap_mode = TRUE;
  56 int mcview_default_magic_flag = 1;
  57
  58 int mcview_altered_hex_mode = 0;
  59 int mcview_altered_magic_flag = 0;
  60 int mcview_altered_nroff_flag = 0;
  61
  62 gboolean mcview_remember_file_position = FALSE;
  63
  64 /* Maxlimit for skipping updates */
  65 int mcview_max_dirt_limit = 10;
  66
  67 /* Scrolling is done in pages or line increments */
  68 gboolean mcview_mouse_move_pages = TRUE;
  69
  70 /* end of file will be showen from mcview_show_eof */
  71 char *mcview_show_eof = NULL;
  72
  73 /*** file scope macro definitions ****************************************************************/
  74
  75 /*** file scope type declarations ****************************************************************/
  76
  77 /*** file scope variables ************************************************************************/
  78
  79 /* --------------------------------------------------------------------------------------------- */
  80 /*** file scope functions ************************************************************************/
  81 /* --------------------------------------------------------------------------------------------- */
  82
  83 static void
  84 mcview_mouse_callback (Widget * w, mouse_msg_t msg, mouse_event_t * event)
  85 {
  86     WView *view = (WView *) w;
  87     gboolean ok = TRUE;
  88
  89     switch (msg)
  90     {
  91     case MSG_MOUSE_DOWN:
  92         if (mcview_is_in_panel (view))
  93         {
  94             if (event->y == WIDGET (w->owner)->y)
  95             {
  96                 /* return MOU_UNHANDLED */
  97                 event->result.abort = TRUE;
  98                 /* don't draw viewer over menu */
  99                 ok = FALSE;
 100                 break;
 101             }
 102
 103             if (!widget_get_state (w, WST_FOCUSED))
 104             {
 105                 /* Grab focus */
 106                 change_panel ();
 107             }
 108         }
 109         /* fall throught */
 110
 111     case MSG_MOUSE_CLICK:
 112         if (!view->text_wrap_mode)
 113         {
 114             /* Scrolling left and right */
 115             screen_dimen x;
 116
 117             x = event->x + 1;   /* FIXME */
 118
 119             if (x < view->data_area.width * 1 / 4)
 120             {
 121                 mcview_move_left (view, 1);
 122                 event->result.repeat = msg == MSG_MOUSE_DOWN;
 123             }
 124             else if (x < view->data_area.width * 3 / 4)
 125             {
 126                 /* ignore the click */
 127                 ok = FALSE;
 128             }
 129             else
 130             {
 131                 mcview_move_right (view, 1);
 132                 event->result.repeat = msg == MSG_MOUSE_DOWN;
 133             }
 134         }
 135         else
 136         {
 137             /* Scrolling up and down */
 138             screen_dimen y;
 139
 140             y = event->y + 1;   /* FIXME */
 141
 142             if (y < view->data_area.top + view->data_area.height * 1 / 3)
 143             {
 144                 if (mcview_mouse_move_pages)
 145                     mcview_move_up (view, view->data_area.height / 2);
 146                 else
 147                     mcview_move_up (view, 1);
 148
 149                 event->result.repeat = msg == MSG_MOUSE_DOWN;
 150             }
 151             else if (y < view->data_area.top + view->data_area.height * 2 / 3)
 152             {
 153                 /* ignore the click */
 154                 ok = FALSE;
 155             }
 156             else
 157             {
 158                 if (mcview_mouse_move_pages)
 159                     mcview_move_down (view, view->data_area.height / 2);
 160                 else
 161                     mcview_move_down (view, 1);
 162
 163                 event->result.repeat = msg == MSG_MOUSE_DOWN;
 164             }
 165         }
 166         break;
 167
 168     case MSG_MOUSE_SCROLL_UP:
 169         mcview_move_up (view, 2);
 170         break;
 171
 172     case MSG_MOUSE_SCROLL_DOWN:
 173         mcview_move_down (view, 2);
 174         break;
 175
 176     default:
 177         ok = FALSE;
 178         break;
 179     }
 180
 181     if (ok)
 182         mcview_update (view);
 183 }
 184
 185 /* --------------------------------------------------------------------------------------------- */
 186 /*** public functions ****************************************************************************/
 187 /* --------------------------------------------------------------------------------------------- */
 188
 189 WView *
 190 mcview_new (int y, int x, int lines, int cols, gboolean is_panel)
 191 {
 192     WView *view;
 193     Widget *w;
 194
 195     view = g_new0 (WView, 1);
 196     w = WIDGET (view);
 197     widget_init (w, y, x, lines, cols, mcview_callback, mcview_mouse_callback);
 198     w->options |= WOP_SELECTABLE | WOP_TOP_SELECT;
 199
 200     view->hex_mode = FALSE;
 201     view->hexedit_mode = FALSE;
 202     view->locked = FALSE;
 203     view->hexview_in_text = FALSE;
 204     view->text_nroff_mode = FALSE;
 205     view->text_wrap_mode = FALSE;
 206     view->magic_mode = FALSE;
 207
 208     view->dpy_frame_size = is_panel ? 1 : 0;
 209     view->converter = str_cnv_from_term;
 210
 211     mcview_init (view);
 212
 213     if (mcview_default_hex_mode)
 214         mcview_toggle_hex_mode (view);
 215     if (mcview_default_nroff_flag)
 216         mcview_toggle_nroff_mode (view);
 217     if (mcview_global_wrap_mode)
 218         mcview_toggle_wrap_mode (view);
 219     if (mcview_default_magic_flag)
 220         mcview_toggle_magic_mode (view);
 221
 222     return view;
 223 }
 224
 225 /* --------------------------------------------------------------------------------------------- */
 226 /** Real view only */
 227
 228 gboolean
 229 mcview_viewer (const char *command, const vfs_path_t * file_vpath, int start_line,
 230                off_t search_start, off_t search_end)
 231 {
 232     gboolean succeeded;
 233     WView *lc_mcview;
 234     WDialog *view_dlg;
 235
 236     /* Create dialog and widgets, put them on the dialog */
 237     view_dlg = dlg_create (FALSE, 0, 0, 1, 1, WPOS_FULLSCREEN, FALSE, NULL, mcview_dialog_callback,
 238                            NULL, "[Internal File Viewer]", NULL);
 239     widget_want_tab (WIDGET (view_dlg), TRUE);
 240
 241     lc_mcview = mcview_new (0, 0, LINES - 1, COLS, FALSE);
 242     add_widget (view_dlg, lc_mcview);
 243
 244     add_widget (view_dlg, buttonbar_new (TRUE));
 245
 246     view_dlg->get_title = mcview_get_title;
 247
 248     succeeded =
 249         mcview_load (lc_mcview, command, vfs_path_as_str (file_vpath), start_line, search_start,
 250                      search_end);
 251
 252     if (succeeded)
 253         dlg_run (view_dlg);
 254     else
 255         dlg_stop (view_dlg);
 256
 257     if (widget_get_state (WIDGET (view_dlg), WST_CLOSED))
 258         dlg_destroy (view_dlg);
 259
 260     return succeeded;
 261 }
 262
 263 /* {{{ Miscellaneous functions }}} */
 264
 265 /* --------------------------------------------------------------------------------------------- */
 266
 267 gboolean
 268 mcview_load (WView * view, const char *command, const char *file, int start_line,
 269              off_t search_start, off_t search_end)
 270 {
 271     gboolean retval = FALSE;
 272     vfs_path_t *vpath = NULL;
 273
 274     g_assert (view->bytes_per_line != 0);
 275
 276     view->filename_vpath = vfs_path_from_str (file);
 277
 278     /* get working dir */
 279     if (file != NULL && file[0] != '\0')
 280     {
 281         vfs_path_free (view->workdir_vpath);
 282
 283         if (!g_path_is_absolute (file))
 284         {
 285             vfs_path_t *p;
 286
 287             p = vfs_path_clone (vfs_get_raw_current_dir ());
 288             view->workdir_vpath = vfs_path_append_new (p, file, (char *) NULL);
 289             vfs_path_free (p);
 290         }
 291         else
 292         {
 293             /* try extract path from filename */
 294             const char *fname;
 295             char *dir;
 296
 297             fname = x_basename (file);
 298             dir = g_strndup (file, (size_t) (fname - file));
 299             view->workdir_vpath = vfs_path_from_str (dir);
 300             g_free (dir);
 301         }
 302     }
 303
 304     if (!mcview_is_in_panel (view))
 305         view->dpy_text_column = 0;
 306
 307     mcview_set_codeset (view);
 308
 309     if (command != NULL && (view->magic_mode || file == NULL || file[0] == '\0'))
 310         retval = mcview_load_command_output (view, command);
 311     else if (file != NULL && file[0] != '\0')
 312     {
 313         int fd;
 314         char tmp[BUF_MEDIUM];
 315         struct stat st;
 316
 317         /* Open the file */
 318         vpath = vfs_path_from_str (file);
 319         fd = mc_open (vpath, O_RDONLY | O_NONBLOCK);
 320         if (fd == -1)
 321         {
 322             g_snprintf (tmp, sizeof (tmp), _("Cannot open \"%s\"\n%s"),
 323                         file, unix_error_string (errno));
 324             mcview_close_datasource (view);
 325             mcview_show_error (view, tmp);
 326             vfs_path_free (view->filename_vpath);
 327             view->filename_vpath = NULL;
 328             vfs_path_free (view->workdir_vpath);
 329             view->workdir_vpath = NULL;
 330             goto finish;
 331         }
 332
 333         /* Make sure we are working with a regular file */
 334         if (mc_fstat (fd, &st) == -1)
 335         {
 336             mc_close (fd);
 337             g_snprintf (tmp, sizeof (tmp), _("Cannot stat \"%s\"\n%s"),
 338                         file, unix_error_string (errno));
 339             mcview_close_datasource (view);
 340             mcview_show_error (view, tmp);
 341             vfs_path_free (view->filename_vpath);
 342             view->filename_vpath = NULL;
 343             vfs_path_free (view->workdir_vpath);
 344             view->workdir_vpath = NULL;
 345             goto finish;
 346         }
 347
 348         if (!S_ISREG (st.st_mode))
 349         {
 350             mc_close (fd);
 351             mcview_close_datasource (view);
 352             mcview_show_error (view, _("Cannot view: not a regular file"));
 353             vfs_path_free (view->filename_vpath);
 354             view->filename_vpath = NULL;
 355             vfs_path_free (view->workdir_vpath);
 356             view->workdir_vpath = NULL;
 357             goto finish;
 358         }
 359
 360         if (st.st_size == 0 || mc_lseek (fd, 0, SEEK_SET) == -1)
 361         {
 362             /* Must be one of those nice files that grow (/proc) */
 363             mcview_set_datasource_vfs_pipe (view, fd);
 364         }
 365         else
 366         {
 367             if (view->magic_mode)
 368             {
 369                 int type;
 370
 371                 type = get_compression_type (fd, file);
 372
 373                 if (type != COMPRESSION_NONE)
 374                 {
 375                     char *tmp_filename;
 376                     vfs_path_t *vpath1;
 377                     int fd1;
 378
 379                     tmp_filename = g_strconcat (file, decompress_extension (type), (char *) NULL);
 380                     vpath1 = vfs_path_from_str (tmp_filename);
 381                     g_free (tmp_filename);
 382                     fd1 = mc_open (vpath1, O_RDONLY | O_NONBLOCK);
 383                     vfs_path_free (vpath1);
 384
 385                     if (fd1 == -1)
 386                     {
 387                         g_snprintf (tmp, sizeof (tmp), _("Cannot open \"%s\" in parse mode\n%s"),
 388                                     file, unix_error_string (errno));
 389                         mcview_close_datasource (view);
 390                         mcview_show_error (view, tmp);
 391                     }
 392                     else
 393                     {
 394                         mc_close (fd);
 395                         fd = fd1;
 396                         mc_fstat (fd, &st);
 397                     }
 398                 }
 399             }
 400
 401             mcview_set_datasource_file (view, fd, &st);
 402         }
 403         retval = TRUE;
 404     }
 405
 406   finish:
 407     view->command = g_strdup (command);
 408     view->dpy_start = 0;
 409     view->dpy_paragraph_skip_lines = 0;
 410     mcview_state_machine_init (&view->dpy_state_top, 0);
 411     view->dpy_wrap_dirty = FALSE;
 412     view->force_max = -1;
 413     view->dpy_text_column = 0;
 414
 415     mcview_compute_areas (view);
 416     mcview_update_bytes_per_line (view);
 417
 418     if (mcview_remember_file_position && view->filename_vpath != NULL && start_line == 0)
 419     {
 420         long line, col;
 421         off_t new_offset, max_offset;
 422
 423         load_file_position (view->filename_vpath, &line, &col, &new_offset, &view->saved_bookmarks);
 424         max_offset = mcview_get_filesize (view) - 1;
 425         if (max_offset < 0)
 426             new_offset = 0;
 427         else
 428             new_offset = MIN (new_offset, max_offset);
 429         if (!view->hex_mode)
 430         {
 431             view->dpy_start = mcview_bol (view, new_offset, 0);
 432             view->dpy_wrap_dirty = TRUE;
 433         }
 434         else
 435         {
 436             view->dpy_start = new_offset - new_offset % view->bytes_per_line;
 437             view->hex_cursor = new_offset;
 438         }
 439     }
 440     else if (start_line > 0)
 441         mcview_moveto (view, start_line - 1, 0);
 442
 443     view->search_start = search_start;
 444     view->search_end = search_end;
 445     view->hexedit_lownibble = FALSE;
 446     view->hexview_in_text = FALSE;
 447     view->change_list = NULL;
 448     vfs_path_free (vpath);
 449     return retval;
 450 }
 451
 452 /* --------------------------------------------------------------------------------------------- */