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_DEFAULT);
 190     add_widget (panelize_dlg, pname);
 191
 192     add_widget (panelize_dlg, hline_new (y++, -1, -1));
 193
 194     x = (panelize_cols - blen) / 2;
 195     for (i = 0; i < G_N_ELEMENTS (panelize_but); i++)
 196     {
 197         WButton *b;
 198
 199         b = button_new (y, x,
 200                         panelize_but[i].ret_cmd, panelize_but[i].flags, panelize_but[i].text, NULL);
 201         add_widget (panelize_dlg, b);
 202
 203         x += button_get_len (b) + 1;
 204     }
 205
 206     dlg_select_widget (l_panelize);
 207 }
 208
 209 /* --------------------------------------------------------------------------------------------- */
 210
 211 static void
 212 panelize_done (void)
 213 {
 214     destroy_dlg (panelize_dlg);
 215     repaint_screen ();
 216 }
 217
 218 /* --------------------------------------------------------------------------------------------- */
 219
 220 static void
 221 add2panelize (char *label, char *command)
 222 {
 223     struct panelize *current, *old;
 224
 225     old = NULL;
 226     current = panelize;
 227     while (current && strcmp (current->label, label) <= 0)
 228     {
 229         old = current;
 230         current = current->next;
 231     }
 232
 233     if (old == NULL)
 234     {
 235         panelize = g_new (struct panelize, 1);
 236         panelize->label = label;
 237         panelize->command = command;
 238         panelize->next = current;
 239     }
 240     else
 241     {
 242         struct panelize *new;
 243         new = g_new (struct panelize, 1);
 244         new->label = label;
 245         new->command = command;
 246         old->next = new;
 247         new->next = current;
 248     }
 249 }
 250
 251 /* --------------------------------------------------------------------------------------------- */
 252
 253 static void
 254 add2panelize_cmd (void)
 255 {
 256     char *label;
 257
 258     if (pname->buffer && (*pname->buffer))
 259     {
 260         label = input_dialog (_("Add to external panelize"),
 261                               _("Enter command label:"), MC_HISTORY_FM_PANELIZE_ADD, "");
 262         if (!label)
 263             return;
 264         if (!*label)
 265         {
 266             g_free (label);
 267             return;
 268         }
 269
 270         add2panelize (label, g_strdup (pname->buffer));
 271     }
 272 }
 273
 274 /* --------------------------------------------------------------------------------------------- */
 275
 276 static void
 277 remove_from_panelize (struct panelize *entry)
 278 {
 279     if (strcmp (entry->label, _("Other command")) != 0)
 280     {
 281         if (entry == panelize)
 282         {
 283             panelize = panelize->next;
 284         }
 285         else
 286         {
 287             struct panelize *current = panelize;
 288             while (current && current->next != entry)
 289                 current = current->next;
 290             if (current)
 291             {
 292                 current->next = entry->next;
 293             }
 294         }
 295
 296         g_free (entry->label);
 297         g_free (entry->command);
 298         g_free (entry);
 299     }
 300 }
 301
 302 /* --------------------------------------------------------------------------------------------- */
 303
 304 static void
 305 do_external_panelize (char *command)
 306 {
 307     int status, link_to_dir, stale_link;
 308     int next_free = 0;
 309     struct stat st;
 310     dir_list *list = &current_panel->dir;
 311     char line[MC_MAXPATHLEN];
 312     char *name;
 313     FILE *external;
 314
 315     open_error_pipe ();
 316     external = popen (command, "r");
 317     if (!external)
 318     {
 319         close_error_pipe (D_ERROR, _("Cannot invoke command."));
 320         return;
 321     }
 322     /* Clear the counters and the directory list */
 323     panel_clean_dir (current_panel);
 324
 325     panelize_change_root (current_panel->cwd_vpath);
 326
 327     if (set_zero_dir (list))
 328         next_free++;
 329
 330     while (1)
 331     {
 332         clearerr (external);
 333         if (fgets (line, MC_MAXPATHLEN, external) == NULL)
 334         {
 335             if (ferror (external) && errno == EINTR)
 336                 continue;
 337             else
 338                 break;
 339         }
 340         if (line[strlen (line) - 1] == '\n')
 341             line[strlen (line) - 1] = 0;
 342         if (strlen (line) < 1)
 343             continue;
 344         if (line[0] == '.' && line[1] == PATH_SEP)
 345             name = line + 2;
 346         else
 347             name = line;
 348         status = handle_path (list, name, &st, next_free, &link_to_dir, &stale_link);
 349         if (status == 0)
 350             continue;
 351         if (status == -1)
 352             break;
 353         list->list[next_free].fnamelen = strlen (name);
 354         list->list[next_free].fname = g_strndup (name, list->list[next_free].fnamelen);
 355         file_mark (current_panel, next_free, 0);
 356         list->list[next_free].f.link_to_dir = link_to_dir;
 357         list->list[next_free].f.stale_link = stale_link;
 358         list->list[next_free].f.dir_size_computed = 0;
 359         list->list[next_free].st = st;
 360         list->list[next_free].sort_key = NULL;
 361         list->list[next_free].second_sort_key = NULL;
 362         next_free++;
 363         if (!(next_free & 32))
 364             rotate_dash ();
 365     }
 366
 367     current_panel->is_panelized = TRUE;
 368     if (next_free)
 369     {
 370         current_panel->count = next_free;
 371         if (list->list[0].fname[0] == PATH_SEP)
 372         {
 373             int ret;
 374             panel_set_cwd (current_panel, PATH_SEP_STR);
 375             ret = chdir (PATH_SEP_STR);
 376             (void) ret;
 377         }
 378     }
 379     else
 380     {
 381         current_panel->count = set_zero_dir (list) ? 1 : 0;
 382     }
 383     if (pclose (external) < 0)
 384         message (D_NORMAL, _("External panelize"), _("Pipe close failed"));
 385     close_error_pipe (D_NORMAL, NULL);
 386     try_to_select (current_panel, NULL);
 387     panel_re_sort (current_panel);
 388 }
 389
 390 /* --------------------------------------------------------------------------------------------- */
 391
 392 static void
 393 do_panelize_cd (struct WPanel *panel)
 394 {
 395     int i;
 396     dir_list *list = &panel->dir;
 397     gboolean panelized_same;
 398
 399     clean_dir (list, panel->count);
 400     if (panelized_panel.root_vpath == NULL)
 401         panelize_change_root (current_panel->cwd_vpath);
 402
 403     if (panelized_panel.count < 1)
 404     {
 405         if (set_zero_dir (&panelized_panel.list))
 406             panelized_panel.count = 1;
 407     }
 408     else if (panelized_panel.count >= list->size)
 409     {
 410         list->list = g_try_realloc (list->list, sizeof (file_entry) * panelized_panel.count);
 411         list->size = panelized_panel.count;
 412     }
 413     panel->count = panelized_panel.count;
 414     panel->is_panelized = TRUE;
 415
 416     panelized_same = (vfs_path_cmp (panelized_panel.root_vpath, panel->cwd_vpath) == 0);
 417
 418     for (i = 0; i < panelized_panel.count; i++)
 419     {
 420         if (panelized_same
 421             || (panelized_panel.list.list[i].fname[0] == '.'
 422                 && panelized_panel.list.list[i].fname[1] == '.'
 423                 && panelized_panel.list.list[i].fname[2] == '\0'))
 424         {
 425             list->list[i].fnamelen = panelized_panel.list.list[i].fnamelen;
 426             list->list[i].fname = g_strndup (panelized_panel.list.list[i].fname,
 427                                              panelized_panel.list.list[i].fnamelen);
 428         }
 429         else
 430         {
 431             vfs_path_t *tmp_vpath;
 432
 433             tmp_vpath =
 434                 vfs_path_append_new (panelized_panel.root_vpath, panelized_panel.list.list[i].fname,
 435                                      NULL);
 436             list->list[i].fname = vfs_path_to_str (tmp_vpath);
 437             vfs_path_free (tmp_vpath);
 438             list->list[i].fnamelen = strlen (list->list[i].fname);
 439         }
 440         list->list[i].f.link_to_dir = panelized_panel.list.list[i].f.link_to_dir;
 441         list->list[i].f.stale_link = panelized_panel.list.list[i].f.stale_link;
 442         list->list[i].f.dir_size_computed = panelized_panel.list.list[i].f.dir_size_computed;
 443         list->list[i].f.marked = panelized_panel.list.list[i].f.marked;
 444         list->list[i].st = panelized_panel.list.list[i].st;
 445         list->list[i].sort_key = panelized_panel.list.list[i].sort_key;
 446         list->list[i].second_sort_key = panelized_panel.list.list[i].second_sort_key;
 447     }
 448     try_to_select (panel, NULL);
 449 }
 450
 451 /* --------------------------------------------------------------------------------------------- */
 452 /*** public functions ****************************************************************************/
 453 /* --------------------------------------------------------------------------------------------- */
 454
 455 /**
 456  * Change root directory of panelized content.
 457  * @param new_root - object with new path.
 458  */
 459 void
 460 panelize_change_root (const vfs_path_t * new_root)
 461 {
 462     vfs_path_free (panelized_panel.root_vpath);
 463     panelized_panel.root_vpath = vfs_path_clone (new_root);
 464 }
 465
 466 /* --------------------------------------------------------------------------------------------- */
 467
 468 void
 469 panelize_save_panel (struct WPanel *panel)
 470 {
 471     int i;
 472     dir_list *list = &panel->dir;
 473
 474     panelize_change_root (current_panel->cwd_vpath);
 475
 476     if (panelized_panel.count > 0)
 477         clean_dir (&panelized_panel.list, panelized_panel.count);
 478     if (panel->count < 1)
 479         return;
 480
 481     panelized_panel.count = panel->count;
 482     if (panel->count >= panelized_panel.list.size)
 483     {
 484         panelized_panel.list.list = g_try_realloc (panelized_panel.list.list,
 485                                                    sizeof (file_entry) * panel->count);
 486         panelized_panel.list.size = panel->count;
 487     }
 488     for (i = 0; i < panel->count; i++)
 489     {
 490         panelized_panel.list.list[i].fnamelen = list->list[i].fnamelen;
 491         panelized_panel.list.list[i].fname =
 492             g_strndup (list->list[i].fname, list->list[i].fnamelen);
 493         panelized_panel.list.list[i].f.link_to_dir = list->list[i].f.link_to_dir;
 494         panelized_panel.list.list[i].f.stale_link = list->list[i].f.stale_link;
 495         panelized_panel.list.list[i].f.dir_size_computed = list->list[i].f.dir_size_computed;
 496         panelized_panel.list.list[i].f.marked = list->list[i].f.marked;
 497         panelized_panel.list.list[i].st = list->list[i].st;
 498         panelized_panel.list.list[i].sort_key = list->list[i].sort_key;
 499         panelized_panel.list.list[i].second_sort_key = list->list[i].second_sort_key;
 500     }
 501 }
 502
 503 /* --------------------------------------------------------------------------------------------- */
 504
 505 void
 506 cd_panelize_cmd (void)
 507 {
 508     if (get_display_type (MENU_PANEL_IDX) != view_listing)
 509         set_display_type (MENU_PANEL_IDX, view_listing);
 510
 511     do_panelize_cd ((struct WPanel *) get_panel_widget (MENU_PANEL_IDX));
 512 }
 513
 514 /* --------------------------------------------------------------------------------------------- */
 515
 516 void
 517 external_panelize (void)
 518 {
 519     char *target = NULL;
 520
 521     if (!vfs_current_is_local ())
 522     {
 523         message (D_ERROR, MSG_ERROR, _("Cannot run external panelize in a non-local directory"));
 524         return;
 525     }
 526
 527     init_panelize ();
 528
 529     /* display file info */
 530     tty_setcolor (SELECTED_COLOR);
 531
 532     run_dlg (panelize_dlg);
 533
 534     switch (panelize_dlg->ret_value)
 535     {
 536     case B_CANCEL:
 537         break;
 538
 539     case B_ADD:
 540         add2panelize_cmd ();
 541         break;
 542
 543     case B_REMOVE:
 544         {
 545             struct panelize *entry;
 546
 547             listbox_get_current (l_panelize, NULL, (void **) &entry);
 548             remove_from_panelize (entry);
 549             break;
 550         }
 551
 552     case B_ENTER:
 553         target = pname->buffer;
 554         if (target != NULL && *target)
 555         {
 556             char *cmd = g_strdup (target);
 557             destroy_dlg (panelize_dlg);
 558             do_external_panelize (cmd);
 559             g_free (cmd);
 560             repaint_screen ();
 561             return;
 562         }
 563         break;
 564     }
 565
 566     panelize_done ();
 567 }
 568
 569 /* --------------------------------------------------------------------------------------------- */
 570
 571 void
 572 load_panelize (void)
 573 {
 574     gchar **profile_keys, **keys;
 575     gsize len;
 576     GIConv conv;
 577
 578     conv = str_crt_conv_from ("UTF-8");
 579
 580     profile_keys = keys = mc_config_get_keys (mc_main_config, panelize_section, &len);
 581
 582     add2panelize (g_strdup (_("Other command")), g_strdup (""));
 583
 584     if (!profile_keys || *profile_keys == NULL)
 585     {
 586         add2panelize (g_strdup (_("Modified git files")), g_strdup ("git ls-files --modified"));
 587         add2panelize (g_strdup (_("Find rejects after patching")),
 588                       g_strdup ("find . -name \\*.rej -print"));
 589         add2panelize (g_strdup (_("Find *.orig after patching")),
 590                       g_strdup ("find . -name \\*.orig -print"));
 591         add2panelize (g_strdup (_("Find SUID and SGID programs")),
 592                       g_strdup
 593                       ("find . \\( \\( -perm -04000 -a -perm +011 \\) -o \\( -perm -02000 -a -perm +01 \\) \\) -print"));
 594         return;
 595     }
 596
 597     while (*profile_keys)
 598     {
 599         GString *buffer;
 600
 601         if (mc_global.utf8_display || conv == INVALID_CONV)
 602             buffer = g_string_new (*profile_keys);
 603         else
 604         {
 605             buffer = g_string_new ("");
 606             if (str_convert (conv, *profile_keys, buffer) == ESTR_FAILURE)
 607                 g_string_assign (buffer, *profile_keys);
 608         }
 609
 610         add2panelize (g_string_free (buffer, FALSE),
 611                       mc_config_get_string (mc_main_config, panelize_section, *profile_keys, ""));
 612         profile_keys++;
 613     }
 614
 615     g_strfreev (keys);
 616     str_close_conv (conv);
 617 }
 618
 619 /* --------------------------------------------------------------------------------------------- */
 620
 621 void
 622 save_panelize (void)
 623 {
 624     struct panelize *current = panelize;
 625
 626     mc_config_del_group (mc_main_config, panelize_section);
 627     for (; current; current = current->next)
 628     {
 629         if (strcmp (current->label, _("Other command")))
 630             mc_config_set_string (mc_main_config,
 631                                   panelize_section, current->label, current->command);
 632     }
 633 }
 634
 635 /* --------------------------------------------------------------------------------------------- */
 636
 637 void
 638 done_panelize (void)
 639 {
 640     struct panelize *current = panelize;
 641     struct panelize *next;
 642
 643     for (; current; current = next)
 644     {
 645         next = current->next;
 646         g_free (current->label);
 647         g_free (current->command);
 648         g_free (current);
 649     }
 650 }
 651
 652 /* --------------------------------------------------------------------------------------------- */