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