src/filemanager/panelize.c

   1 /*
   2    External panelize
   3
   4    Copyright (C) 1995, 1998, 1999, 2000, 2001, 2002, 2003, 2004, 2005,
   5    2007, 2009, 2011
   6    The Free Software Foundation, Inc.
   7
   8    Written by:
   9    Janne Kukonlehto, 1995
  10    Jakub Jelinek, 1995
  11
  12    This file is part of the Midnight Commander.
  13
  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.
  18
  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.
  23
  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/>.
  26  */
  27
  28 /** \file panelize.c
  29  *  \brief Source: External panelization module
  30  */
  31
  32 #include <config.h>
  33
  34 #include <errno.h>
  35 #include <stdio.h>
  36 #include <string.h>
  37 #include <sys/types.h>
  38 #include <sys/stat.h>
  39 #include <unistd.h>
  40
  41 #include "lib/global.h"
  42
  43 #include "lib/skin.h"
  44 #include "lib/vfs/vfs.h"
  45 #include "lib/mcconfig.h"       /* Load/save directories panelize */
  46 #include "lib/strutil.h"
  47 #include "lib/util.h"
  48 #include "lib/widget.h"
  49
  50 #include "src/setup.h"          /* For profile_bname */
  51 #include "src/history.h"
  52
  53 #include "dir.h"
  54 #include "midnight.h"           /* current_panel */
  55 #include "panel.h"              /* WPanel */
  56
  57 #include "panelize.h"
  58 #include "panel.h"
  59
  60 /*** global variables ****************************************************************************/
  61
  62 /*** file scope macro definitions ****************************************************************/
  63
  64 #define UX 3
  65 #define UY 2
  66
  67 #define LABELS   3
  68 #define B_ADD    B_USER
  69 #define B_REMOVE (B_USER + 1)
  70
  71 /*** file scope type declarations ****************************************************************/
  72
  73 /*** file scope variables ************************************************************************/
  74
  75 static WListbox *l_panelize;
  76 static WDialog *panelize_dlg;
  77 static int last_listitem;
  78 static WInput *pname;
  79
  80 static const char *panelize_section = "Panelize";
  81
  82 /* Directory panelize */
  83 static struct panelize
  84 {
  85     char *command;
  86     char *label;
  87     struct panelize *next;
  88 } *panelize = NULL;
  89
  90 /* --------------------------------------------------------------------------------------------- */
  91 /*** file scope functions ************************************************************************/
  92 /* --------------------------------------------------------------------------------------------- */
  93
  94 static void
  95 update_command (void)
  96 {
  97     if (l_panelize->pos != last_listitem)
  98     {
  99         struct panelize *data = NULL;
 100
 101         last_listitem = l_panelize->pos;
 102         listbox_get_current (l_panelize, NULL, (void **) &data);
 103         input_assign_text (pname, data->command);
 104         pname->point = 0;
 105         input_update (pname, TRUE);
 106     }
 107 }
 108
 109 /* --------------------------------------------------------------------------------------------- */
 110
 111 static cb_ret_t
 112 panelize_callback (Widget * w, Widget * sender, widget_msg_t msg, int parm, void *data)
 113 {
 114     switch (msg)
 115     {
 116     case MSG_INIT:
 117     case MSG_POST_KEY:
 118     case MSG_FOCUS:
 119         tty_setcolor (MENU_ENTRY_COLOR);
 120         update_command ();
 121         return MSG_HANDLED;
 122
 123     default:
 124         return dlg_default_callback (w, sender, msg, parm, data);
 125     }
 126 }
 127
 128 /* --------------------------------------------------------------------------------------------- */
 129
 130 static void
 131 init_panelize (void)
 132 {
 133     struct
 134     {
 135         int ret_cmd;
 136         button_flags_t flags;
 137         const char *text;
 138     } panelize_but[] =
 139     {
 140         /* *INDENT-OFF* */
 141         { B_ENTER, DEFPUSH_BUTTON, N_("Pane&lize") },
 142         { B_REMOVE, NORMAL_BUTTON, N_("&Remove") },
 143         { B_ADD, NORMAL_BUTTON, N_("&Add new") },
 144         { B_CANCEL, NORMAL_BUTTON, N_("&Cancel") }
 145         /* *INDENT-ON* */
 146     };
 147
 148     size_t i;
 149     int blen;
 150     int panelize_cols;
 151     struct panelize *current;
 152     int x, y;
 153
 154     last_listitem = 0;
 155
 156     do_refresh ();
 157
 158     i = G_N_ELEMENTS (panelize_but);
 159     blen = i - 1;               /* gaps between buttons */
 160     while (i-- != 0)
 161     {
 162         panelize_but[i].text = _(panelize_but[i].text);
 163         blen += str_term_width1 (panelize_but[i].text) + 3 + 1;
 164         if (panelize_but[i].flags == DEFPUSH_BUTTON)
 165             blen += 2;
 166     }
 167
 168     panelize_cols = COLS - 6;
 169     panelize_cols = max (panelize_cols, blen + 4);
 170
 171     panelize_dlg =
 172         create_dlg (TRUE, 0, 0, 20, panelize_cols, dialog_colors, panelize_callback, NULL,
 173                     "[External panelize]", _("External panelize"), DLG_CENTER);
 174
 175     /* add listbox to the dialogs */
 176     y = UY;
 177     add_widget (panelize_dlg, groupbox_new (y++, UX, 12, panelize_cols - UX * 2, ""));
 178
 179     l_panelize = listbox_new (y, UX + 1, 10, panelize_cols - UX * 2 - 2, FALSE, NULL);
 180     for (current = panelize; current != NULL; current = current->next)
 181         listbox_add_item (l_panelize, LISTBOX_APPEND_AT_END, 0, current->label, current);
 182     listbox_select_entry (l_panelize, listbox_search_text (l_panelize, _("Other command")));
 183     add_widget (panelize_dlg, l_panelize);
 184
 185     y += WIDGET (l_panelize)->lines + 1;
 186     add_widget (panelize_dlg, label_new (y++, UX, _("Command")));
 187     pname =
 188         input_new (y++, UX, input_get_default_colors (), panelize_cols - UX * 2, "", "in",
 189                    INPUT_COMPLETE_FILENAMES | INPUT_COMPLETE_HOSTNAMES | INPUT_COMPLETE_COMMANDS |
 190                    INPUT_COMPLETE_VARIABLES | INPUT_COMPLETE_USERNAMES | INPUT_COMPLETE_CD |
 191                    INPUT_COMPLETE_SHELL_ESC);
 192     add_widget (panelize_dlg, pname);
 193
 194
 195
 196     add_widget (panelize_dlg, hline_new (y++, -1, -1));
 197
 198     x = (panelize_cols - blen) / 2;
 199     for (i = 0; i < G_N_ELEMENTS (panelize_but); i++)
 200     {
 201         WButton *b;
 202
 203         b = button_new (y, x,
 204                         panelize_but[i].ret_cmd, panelize_but[i].flags, panelize_but[i].text, NULL);
 205         add_widget (panelize_dlg, b);
 206
 207         x += button_get_len (b) + 1;
 208     }
 209
 210     dlg_select_widget (l_panelize);
 211 }
 212
 213 /* --------------------------------------------------------------------------------------------- */
 214
 215 static void
 216 panelize_done (void)
 217 {
 218     destroy_dlg (panelize_dlg);
 219     repaint_screen ();
 220 }
 221
 222 /* --------------------------------------------------------------------------------------------- */
 223
 224 static void
 225 add2panelize (char *label, char *command)
 226 {
 227     struct panelize *current, *old;
 228
 229     old = NULL;
 230     current = panelize;
 231     while (current && strcmp (current->label, label) <= 0)
 232     {
 233         old = current;
 234         current = current->next;
 235     }
 236
 237     if (old == NULL)
 238     {
 239         panelize = g_new (struct panelize, 1);
 240         panelize->label = label;
 241         panelize->command = command;
 242         panelize->next = current;
 243     }
 244     else
 245     {
 246         struct panelize *new;
 247         new = g_new (struct panelize, 1);
 248         new->label = label;
 249         new->command = command;
 250         old->next = new;
 251         new->next = current;
 252     }
 253 }
 254
 255 /* --------------------------------------------------------------------------------------------- */
 256
 257 static void
 258 add2panelize_cmd (void)
 259 {
 260     char *label;
 261
 262     if (pname->buffer && (*pname->buffer))
 263     {
 264         label = input_dialog (_("Add to external panelize"),
 265                               _("Enter command label:"), MC_HISTORY_FM_PANELIZE_ADD, "",
 266                               INPUT_COMPLETE_NONE);
 267         if (!label)
 268             return;
 269         if (!*label)
 270         {
 271             g_free (label);
 272             return;
 273         }
 274
 275         add2panelize (label, g_strdup (pname->buffer));
 276     }
 277 }
 278
 279 /* --------------------------------------------------------------------------------------------- */
 280
 281 static void
 282 remove_from_panelize (struct panelize *entry)
 283 {
 284     if (strcmp (entry->label, _("Other command")) != 0)
 285     {
 286         if (entry == panelize)
 287         {
 288             panelize = panelize->next;
 289         }
 290         else
 291         {
 292             struct panelize *current = panelize;
 293             while (current && current->next != entry)
 294                 current = current->next;
 295             if (current)
 296             {
 297                 current->next = entry->next;
 298             }
 299         }
 300
 301         g_free (entry->label);
 302         g_free (entry->command);
 303         g_free (entry);
 304     }
 305 }
 306
 307 /* --------------------------------------------------------------------------------------------- */
 308
 309 static void
 310 do_external_panelize (char *command)
 311 {
 312     int status, link_to_dir, stale_link;
 313     int next_free = 0;
 314     struct stat st;
 315     dir_list *list = &current_panel->dir;
 316     char line[MC_MAXPATHLEN];
 317     char *name;
 318     FILE *external;
 319
 320     open_error_pipe ();
 321     external = popen (command, "r");
 322     if (!external)
 323     {
 324         close_error_pipe (D_ERROR, _("Cannot invoke command."));
 325         return;
 326     }
 327     /* Clear the counters and the directory list */
 328     panel_clean_dir (current_panel);
 329
 330     panelize_change_root (current_panel->cwd_vpath);
 331
 332     if (set_zero_dir (list))
 333         next_free++;
 334
 335     while (1)
 336     {
 337         clearerr (external);
 338         if (fgets (line, MC_MAXPATHLEN, external) == NULL)
 339         {
 340             if (ferror (external) && errno == EINTR)
 341                 continue;
 342             else
 343                 break;
 344         }
 345         if (line[strlen (line) - 1] == '\n')
 346             line[strlen (line) - 1] = 0;
 347         if (strlen (line) < 1)
 348             continue;
 349         if (line[0] == '.' && line[1] == PATH_SEP)
 350             name = line + 2;
 351         else
 352             name = line;
 353         status = handle_path (list, name, &st, next_free, &link_to_dir, &stale_link);
 354         if (status == 0)
 355             continue;
 356         if (status == -1)
 357             break;
 358         list->list[next_free].fnamelen = strlen (name);
 359         list->list[next_free].fname = g_strndup (name, list->list[next_free].fnamelen);
 360         file_mark (current_panel, next_free, 0);
 361         list->list[next_free].f.link_to_dir = link_to_dir;
 362         list->list[next_free].f.stale_link = stale_link;
 363         list->list[next_free].f.dir_size_computed = 0;
 364         list->list[next_free].st = st;
 365         list->list[next_free].sort_key = NULL;
 366         list->list[next_free].second_sort_key = NULL;
 367         next_free++;
 368         if (!(next_free & 32))
 369             rotate_dash ();
 370     }
 371
 372     current_panel->is_panelized = TRUE;
 373     if (next_free)
 374     {
 375         current_panel->count = next_free;
 376         if (list->list[0].fname[0] == PATH_SEP)
 377         {
 378             int ret;
 379             panel_set_cwd (current_panel, PATH_SEP_STR);
 380             ret = chdir (PATH_SEP_STR);
 381             (void) ret;
 382         }
 383     }
 384     else
 385     {
 386         current_panel->count = set_zero_dir (list) ? 1 : 0;
 387     }
 388     if (pclose (external) < 0)
 389         message (D_NORMAL, _("External panelize"), _("Pipe close failed"));
 390     close_error_pipe (D_NORMAL, NULL);
 391     try_to_select (current_panel, NULL);
 392     panel_re_sort (current_panel);
 393 }
 394
 395 /* --------------------------------------------------------------------------------------------- */
 396
 397 static void
 398 do_panelize_cd (struct WPanel *panel)
 399 {
 400     int i;
 401     dir_list *list = &panel->dir;
 402     gboolean panelized_same;
 403
 404     clean_dir (list, panel->count);
 405     if (panelized_panel.root_vpath == NULL)
 406         panelize_change_root (current_panel->cwd_vpath);
 407
 408     if (panelized_panel.count < 1)
 409     {
 410         if (set_zero_dir (&panelized_panel.list))
 411             panelized_panel.count = 1;
 412     }
 413     else if (panelized_panel.count >= list->size)
 414     {
 415         list->list = g_try_realloc (list->list, sizeof (file_entry) * panelized_panel.count);
 416         list->size = panelized_panel.count;
 417     }
 418     panel->count = panelized_panel.count;
 419     panel->is_panelized = TRUE;
 420
 421     panelized_same = (vfs_path_cmp (panelized_panel.root_vpath, panel->cwd_vpath) == 0);
 422
 423     for (i = 0; i < panelized_panel.count; i++)
 424     {
 425         if (panelized_same
 426             || (panelized_panel.list.list[i].fname[0] == '.'
 427                 && panelized_panel.list.list[i].fname[1] == '.'
 428                 && panelized_panel.list.list[i].fname[2] == '\0'))
 429         {
 430             list->list[i].fnamelen = panelized_panel.list.list[i].fnamelen;
 431             list->list[i].fname = g_strndup (panelized_panel.list.list[i].fname,
 432                                              panelized_panel.list.list[i].fnamelen);
 433         }
 434         else
 435         {
 436             vfs_path_t *tmp_vpath;
 437
 438             tmp_vpath =
 439                 vfs_path_append_new (panelized_panel.root_vpath, panelized_panel.list.list[i].fname,
 440                                      NULL);
 441             list->list[i].fname = vfs_path_to_str (tmp_vpath);
 442             vfs_path_free (tmp_vpath);
 443             list->list[i].fnamelen = strlen (list->list[i].fname);
 444         }
 445         list->list[i].f.link_to_dir = panelized_panel.list.list[i].f.link_to_dir;
 446         list->list[i].f.stale_link = panelized_panel.list.list[i].f.stale_link;
 447         list->list[i].f.dir_size_computed = panelized_panel.list.list[i].f.dir_size_computed;
 448         list->list[i].f.marked = panelized_panel.list.list[i].f.marked;
 449         list->list[i].st = panelized_panel.list.list[i].st;
 450         list->list[i].sort_key = panelized_panel.list.list[i].sort_key;
 451         list->list[i].second_sort_key = panelized_panel.list.list[i].second_sort_key;
 452     }
 453     try_to_select (panel, NULL);
 454 }
 455
 456 /* --------------------------------------------------------------------------------------------- */
 457 /*** public functions ****************************************************************************/
 458 /* --------------------------------------------------------------------------------------------- */
 459
 460 /**
 461  * Change root directory of panelized content.
 462  * @param new_root - object with new path.
 463  */
 464 void
 465 panelize_change_root (const vfs_path_t * new_root)
 466 {
 467     vfs_path_free (panelized_panel.root_vpath);
 468     panelized_panel.root_vpath = vfs_path_clone (new_root);
 469 }
 470
 471 /* --------------------------------------------------------------------------------------------- */
 472
 473 void
 474 panelize_save_panel (struct WPanel *panel)
 475 {
 476     int i;
 477     dir_list *list = &panel->dir;
 478
 479     panelize_change_root (current_panel->cwd_vpath);
 480
 481     if (panelized_panel.count > 0)
 482         clean_dir (&panelized_panel.list, panelized_panel.count);
 483     if (panel->count < 1)
 484         return;
 485
 486     panelized_panel.count = panel->count;
 487     if (panel->count >= panelized_panel.list.size)
 488     {
 489         panelized_panel.list.list = g_try_realloc (panelized_panel.list.list,
 490                                                    sizeof (file_entry) * panel->count);
 491         panelized_panel.list.size = panel->count;
 492     }
 493     for (i = 0; i < panel->count; i++)
 494     {
 495         panelized_panel.list.list[i].fnamelen = list->list[i].fnamelen;
 496         panelized_panel.list.list[i].fname =
 497             g_strndup (list->list[i].fname, list->list[i].fnamelen);
 498         panelized_panel.list.list[i].f.link_to_dir = list->list[i].f.link_to_dir;
 499         panelized_panel.list.list[i].f.stale_link = list->list[i].f.stale_link;
 500         panelized_panel.list.list[i].f.dir_size_computed = list->list[i].f.dir_size_computed;
 501         panelized_panel.list.list[i].f.marked = list->list[i].f.marked;
 502         panelized_panel.list.list[i].st = list->list[i].st;
 503         panelized_panel.list.list[i].sort_key = list->list[i].sort_key;
 504         panelized_panel.list.list[i].second_sort_key = list->list[i].second_sort_key;
 505     }
 506 }
 507
 508 /* --------------------------------------------------------------------------------------------- */
 509
 510 void
 511 cd_panelize_cmd (void)
 512 {
 513     if (get_display_type (MENU_PANEL_IDX) != view_listing)
 514         set_display_type (MENU_PANEL_IDX, view_listing);
 515
 516     do_panelize_cd ((struct WPanel *) get_panel_widget (MENU_PANEL_IDX));
 517 }
 518
 519 /* --------------------------------------------------------------------------------------------- */
 520
 521 void
 522 external_panelize (void)
 523 {
 524     char *target = NULL;
 525
 526     if (!vfs_current_is_local ())
 527     {
 528         message (D_ERROR, MSG_ERROR, _("Cannot run external panelize in a non-local directory"));
 529         return;
 530     }
 531
 532     init_panelize ();
 533
 534     /* display file info */
 535     tty_setcolor (SELECTED_COLOR);
 536
 537     run_dlg (panelize_dlg);
 538
 539     switch (panelize_dlg->ret_value)
 540     {
 541     case B_CANCEL:
 542         break;
 543
 544     case B_ADD:
 545         add2panelize_cmd ();
 546         break;
 547
 548     case B_REMOVE:
 549         {
 550             struct panelize *entry;
 551
 552             listbox_get_current (l_panelize, NULL, (void **) &entry);
 553             remove_from_panelize (entry);
 554             break;
 555         }
 556
 557     case B_ENTER:
 558         target = pname->buffer;
 559         if (target != NULL && *target)
 560         {
 561             char *cmd = g_strdup (target);
 562             destroy_dlg (panelize_dlg);
 563             do_external_panelize (cmd);
 564             g_free (cmd);
 565             repaint_screen ();
 566             return;
 567         }
 568         break;
 569     }
 570
 571     panelize_done ();
 572 }
 573
 574 /* --------------------------------------------------------------------------------------------- */
 575
 576 void
 577 load_panelize (void)
 578 {
 579     gchar **profile_keys, **keys;
 580     gsize len;
 581     GIConv conv;
 582
 583     conv = str_crt_conv_from ("UTF-8");
 584
 585     profile_keys = keys = mc_config_get_keys (mc_main_config, panelize_section, &len);
 586
 587     add2panelize (g_strdup (_("Other command")), g_strdup (""));
 588
 589     if (!profile_keys || *profile_keys == NULL)
 590     {
 591         add2panelize (g_strdup (_("Modified git files")), g_strdup ("git ls-files --modified"));
 592         add2panelize (g_strdup (_("Find rejects after patching")),
 593                       g_strdup ("find . -name \\*.rej -print"));
 594         add2panelize (g_strdup (_("Find *.orig after patching")),
 595                       g_strdup ("find . -name \\*.orig -print"));
 596         add2panelize (g_strdup (_("Find SUID and SGID programs")),
 597                       g_strdup
 598                       ("find . \\( \\( -perm -04000 -a -perm +011 \\) -o \\( -perm -02000 -a -perm +01 \\) \\) -print"));
 599         return;
 600     }
 601
 602     while (*profile_keys)
 603     {
 604         GString *buffer;
 605
 606         if (mc_global.utf8_display || conv == INVALID_CONV)
 607             buffer = g_string_new (*profile_keys);
 608         else
 609         {
 610             buffer = g_string_new ("");
 611             if (str_convert (conv, *profile_keys, buffer) == ESTR_FAILURE)
 612                 g_string_assign (buffer, *profile_keys);
 613         }
 614
 615         add2panelize (g_string_free (buffer, FALSE),
 616                       mc_config_get_string (mc_main_config, panelize_section, *profile_keys, ""));
 617         profile_keys++;
 618     }
 619
 620     g_strfreev (keys);
 621     str_close_conv (conv);
 622 }
 623
 624 /* --------------------------------------------------------------------------------------------- */
 625
 626 void
 627 save_panelize (void)
 628 {
 629     struct panelize *current = panelize;
 630
 631     mc_config_del_group (mc_main_config, panelize_section);
 632     for (; current; current = current->next)
 633     {
 634         if (strcmp (current->label, _("Other command")))
 635             mc_config_set_string (mc_main_config,
 636                                   panelize_section, current->label, current->command);
 637     }
 638 }
 639
 640 /* --------------------------------------------------------------------------------------------- */
 641
 642 void
 643 done_panelize (void)
 644 {
 645     struct panelize *current = panelize;
 646     struct panelize *next;
 647
 648     for (; current; current = next)
 649     {
 650         next = current->next;
 651         g_free (current->label);
 652         g_free (current->command);
 653         g_free (current);
 654     }
 655 }
 656
 657 /* --------------------------------------------------------------------------------------------- */