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