src/filemanager/panelize.c

   1 /*
   2    External panelize
   3
   4    Copyright (C) 1995-2025
   5    Free Software Foundation, Inc.
   6
   7    Written by:
   8    Janne Kukonlehto, 1995
   9    Jakub Jelinek, 1995
  10    Andrew Borodin <aborodin@vmail.ru> 2011-2023
  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 <https://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 "lib/global.h"
  35
  36 #include "lib/skin.h"
  37 #include "lib/tty/tty.h"
  38 #include "lib/vfs/vfs.h"
  39 #include "lib/mcconfig.h"  // Load/save directories panelize
  40 #include "lib/strutil.h"
  41 #include "lib/widget.h"
  42 #include "lib/util.h"  // mc_pipe_t
  43
  44 #include "src/history.h"
  45
  46 #include "filemanager.h"  // current_panel
  47 #include "layout.h"       // rotate_dash()
  48 #include "panel.h"        // WPanel, dir.h
  49
  50 #include "panelize.h"
  51
  52 /*** global variables ****************************************************************************/
  53
  54 /*** file scope macro definitions ****************************************************************/
  55
  56 #define UX       3
  57 #define UY       2
  58
  59 #define B_ADD    B_USER
  60 #define B_REMOVE (B_USER + 1)
  61
  62 /*** file scope type declarations ****************************************************************/
  63
  64 typedef struct
  65 {
  66     char *command;
  67     char *label;
  68 } panelize_entry_t;
  69
  70 /*** forward declarations (file scope functions) *************************************************/
  71
  72 /*** file scope variables ************************************************************************/
  73
  74 static WListbox *l_panelize;
  75 static WDialog *panelize_dlg;
  76 static int last_listitem;
  77 static WInput *pname;
  78 static GSList *panelize = NULL;
  79
  80 static const char *panelize_section = "Panelize";
  81
  82 /* --------------------------------------------------------------------------------------------- */
  83 /*** file scope functions ************************************************************************/
  84 /* --------------------------------------------------------------------------------------------- */
  85
  86 static void
  87 panelize_entry_free (gpointer data)
  88 {
  89     panelize_entry_t *entry = (panelize_entry_t *) data;
  90
  91     g_free (entry->command);
  92     g_free (entry->label);
  93     g_free (entry);
  94 }
  95
  96 /* --------------------------------------------------------------------------------------------- */
  97
  98 static int
  99 panelize_entry_cmp_by_label (gconstpointer a, gconstpointer b)
 100 {
 101     const panelize_entry_t *entry = (const panelize_entry_t *) a;
 102     const char *label = (const char *) b;
 103
 104     return strcmp (entry->label, label);
 105 }
 106
 107 /* --------------------------------------------------------------------------------------------- */
 108
 109 static void
 110 panelize_entry_add_to_listbox (gpointer data, gpointer user_data)
 111 {
 112     panelize_entry_t *entry = (panelize_entry_t *) data;
 113
 114     (void) user_data;
 115
 116     listbox_add_item (l_panelize, LISTBOX_APPEND_AT_END, 0, entry->label, entry, FALSE);
 117 }
 118
 119 /* --------------------------------------------------------------------------------------------- */
 120
 121 static void
 122 update_command (void)
 123 {
 124     if (l_panelize->current != last_listitem)
 125     {
 126         panelize_entry_t *data = NULL;
 127
 128         last_listitem = l_panelize->current;
 129         listbox_get_current (l_panelize, NULL, (void **) &data);
 130         input_assign_text (pname, data->command);
 131         pname->point = 0;
 132         input_update (pname, TRUE);
 133     }
 134 }
 135
 136 /* --------------------------------------------------------------------------------------------- */
 137
 138 static cb_ret_t
 139 panelize_callback (Widget *w, Widget *sender, widget_msg_t msg, int parm, void *data)
 140 {
 141     switch (msg)
 142     {
 143     case MSG_INIT:
 144         group_default_callback (w, NULL, MSG_INIT, 0, NULL);
 145         MC_FALLTHROUGH;
 146
 147     case MSG_NOTIFY:  // MSG_NOTIFY is fired by the listbox to tell us the item has changed.
 148         update_command ();
 149         return MSG_HANDLED;
 150
 151     default:
 152         return dlg_default_callback (w, sender, msg, parm, data);
 153     }
 154 }
 155
 156 /* --------------------------------------------------------------------------------------------- */
 157
 158 static void
 159 external_panelize_init (void)
 160 {
 161     struct
 162     {
 163         int ret_cmd;
 164         button_flags_t flags;
 165         const char *text;
 166     } panelize_but[] = {
 167         { B_ENTER, DEFPUSH_BUTTON, N_ ("Pane&lize") },
 168         { B_REMOVE, NORMAL_BUTTON, N_ ("&Remove") },
 169         { B_ADD, NORMAL_BUTTON, N_ ("&Add new") },
 170         { B_CANCEL, NORMAL_BUTTON, N_ ("&Cancel") },
 171     };
 172
 173     WGroup *g;
 174
 175     size_t i;
 176     int blen;
 177     int panelize_cols;
 178     int x, y;
 179
 180     last_listitem = 0;
 181
 182     do_refresh ();
 183
 184     i = G_N_ELEMENTS (panelize_but);
 185     blen = i - 1;  // gaps between buttons
 186     while (i-- != 0)
 187     {
 188 #ifdef ENABLE_NLS
 189         panelize_but[i].text = _ (panelize_but[i].text);
 190 #endif
 191         blen += str_term_width1 (panelize_but[i].text) + 3 + 1;
 192         if (panelize_but[i].flags == DEFPUSH_BUTTON)
 193             blen += 2;
 194     }
 195
 196     panelize_cols = COLS - 6;
 197     panelize_cols = MAX (panelize_cols, blen + 4);
 198
 199     panelize_dlg =
 200         dlg_create (TRUE, 0, 0, 20, panelize_cols, WPOS_CENTER, FALSE, dialog_colors,
 201                     panelize_callback, NULL, "[External panelize]", _ ("External panelize"));
 202     g = GROUP (panelize_dlg);
 203
 204     // add listbox to the dialogs
 205     y = UY;
 206     group_add_widget (g, groupbox_new (y++, UX, 12, panelize_cols - UX * 2, ""));
 207
 208     l_panelize = listbox_new (y, UX + 1, 10, panelize_cols - UX * 2 - 2, FALSE, NULL);
 209     g_slist_foreach (panelize, panelize_entry_add_to_listbox, NULL);
 210     listbox_set_current (l_panelize, listbox_search_text (l_panelize, _ ("Other command")));
 211     group_add_widget (g, l_panelize);
 212
 213     y += WIDGET (l_panelize)->rect.lines + 1;
 214     group_add_widget (g, label_new (y++, UX, _ ("Command")));
 215     pname = input_new (y++, UX, input_colors, panelize_cols - UX * 2, "", "in",
 216                        INPUT_COMPLETE_FILENAMES | INPUT_COMPLETE_HOSTNAMES | INPUT_COMPLETE_COMMANDS
 217                            | INPUT_COMPLETE_VARIABLES | INPUT_COMPLETE_USERNAMES | INPUT_COMPLETE_CD
 218                            | INPUT_COMPLETE_SHELL_ESC);
 219     group_add_widget (g, pname);
 220
 221     group_add_widget (g, hline_new (y++, -1, -1));
 222
 223     x = (panelize_cols - blen) / 2;
 224     for (i = 0; i < G_N_ELEMENTS (panelize_but); i++)
 225     {
 226         WButton *b;
 227
 228         b = button_new (y, x, panelize_but[i].ret_cmd, panelize_but[i].flags, panelize_but[i].text,
 229                         NULL);
 230         group_add_widget (g, b);
 231
 232         x += button_get_len (b) + 1;
 233     }
 234
 235     widget_select (WIDGET (l_panelize));
 236 }
 237
 238 /* --------------------------------------------------------------------------------------------- */
 239
 240 static void
 241 external_panelize_done (void)
 242 {
 243     widget_destroy (WIDGET (panelize_dlg));
 244     repaint_screen ();
 245 }
 246
 247 /* --------------------------------------------------------------------------------------------- */
 248
 249 static void
 250 add2panelize (char *label, char *command)
 251 {
 252     panelize_entry_t *entry;
 253
 254     entry = g_try_new (panelize_entry_t, 1);
 255     if (entry != NULL)
 256     {
 257         entry->label = label;
 258         entry->command = command;
 259
 260         panelize = g_slist_insert_sorted (panelize, entry, panelize_entry_cmp_by_label);
 261     }
 262 }
 263
 264 /* --------------------------------------------------------------------------------------------- */
 265
 266 static void
 267 add2panelize_cmd (void)
 268 {
 269     if (!input_is_empty (pname))
 270     {
 271         char *label;
 272
 273         label = input_dialog (_ ("Add to external panelize"), _ ("Enter command label:"),
 274                               MC_HISTORY_FM_PANELIZE_ADD, "", INPUT_COMPLETE_NONE);
 275         if (label == NULL || *label == '\0')
 276             g_free (label);
 277         else
 278             add2panelize (label, input_get_text (pname));
 279     }
 280 }
 281
 282 /* --------------------------------------------------------------------------------------------- */
 283
 284 static void
 285 remove_from_panelize (panelize_entry_t *entry)
 286 {
 287     if (strcmp (entry->label, _ ("Other command")) != 0)
 288     {
 289         panelize = g_slist_remove (panelize, entry);
 290         panelize_entry_free (entry);
 291     }
 292 }
 293
 294 /* --------------------------------------------------------------------------------------------- */
 295
 296 static void
 297 do_external_panelize (const char *command)
 298 {
 299     dir_list *list = &current_panel->dir;
 300     mc_pipe_t *external;
 301     GError *error = NULL;
 302     GString *remain_file_name = NULL;
 303
 304     external = mc_popen (command, TRUE, TRUE, &error);
 305     if (external == NULL)
 306     {
 307         message (D_ERROR, _ ("External panelize"), "%s", error->message);
 308         g_error_free (error);
 309         return;
 310     }
 311
 312     // Clear the counters and the directory list
 313     panel_clean_dir (current_panel);
 314
 315     panel_panelize_change_root (current_panel, current_panel->cwd_vpath);
 316
 317     dir_list_init (list);
 318
 319     while (TRUE)
 320     {
 321         GString *line;
 322         gboolean ok;
 323
 324         // init buffers before call of mc_pread()
 325         external->out.len = MC_PIPE_BUFSIZE;
 326         external->err.len = MC_PIPE_BUFSIZE;
 327         external->err.null_term = TRUE;
 328
 329         mc_pread (external, &error);
 330
 331         if (error != NULL)
 332         {
 333             message (D_ERROR, MSG_ERROR, _ ("External panelize:\n%s"), error->message);
 334             g_error_free (error);
 335             break;
 336         }
 337
 338         if (external->err.len > 0)
 339             message (D_ERROR, MSG_ERROR, _ ("External panelize:\n%s"), external->err.buf);
 340
 341         if (external->out.len == MC_PIPE_STREAM_EOF)
 342             break;
 343
 344         if (external->out.len == 0)
 345             continue;
 346
 347         if (external->out.len == MC_PIPE_ERROR_READ)
 348         {
 349             message (D_ERROR, MSG_ERROR,
 350                      _ ("External panelize:\nfailed to read data from child stdout:\n%s"),
 351                      unix_error_string (external->out.error));
 352             break;
 353         }
 354
 355         ok = TRUE;
 356
 357         while (ok && (line = mc_pstream_get_string (&external->out)) != NULL)
 358         {
 359             char *name;
 360             gboolean link_to_dir, stale_link;
 361             struct stat st;
 362
 363             // handle a \n-separated file list
 364
 365             if (line->str[line->len - 1] == '\n')
 366             {
 367                 // entire file name or last chunk
 368
 369                 g_string_truncate (line, line->len - 1);
 370
 371                 // join filename chunks
 372                 if (remain_file_name != NULL)
 373                 {
 374                     g_string_append_len (remain_file_name, line->str, line->len);
 375                     g_string_free (line, TRUE);
 376                     line = remain_file_name;
 377                     remain_file_name = NULL;
 378                 }
 379             }
 380             else
 381             {
 382                 // first or middle chunk of file name
 383
 384                 if (remain_file_name == NULL)
 385                     remain_file_name = line;
 386                 else
 387                 {
 388                     g_string_append_len (remain_file_name, line->str, line->len);
 389                     g_string_free (line, TRUE);
 390                 }
 391
 392                 continue;
 393             }
 394
 395             name = line->str;
 396
 397             if (name[0] == '.' && IS_PATH_SEP (name[1]))
 398                 name += 2;
 399
 400             if (handle_path (name, &st, &link_to_dir, &stale_link))
 401             {
 402                 ok = dir_list_append (list, name, &st, link_to_dir, stale_link);
 403
 404                 if (ok)
 405                 {
 406                     file_mark (current_panel, list->len - 1, 0);
 407
 408                     if ((list->len & 31) == 0)
 409                         rotate_dash (TRUE);
 410                 }
 411             }
 412
 413             g_string_free (line, TRUE);
 414         }
 415     }
 416
 417     if (remain_file_name != NULL)
 418         g_string_free (remain_file_name, TRUE);
 419
 420     mc_pclose (external, NULL);
 421
 422     current_panel->is_panelized = TRUE;
 423     panel_panelize_absolutize_if_needed (current_panel);
 424
 425     panel_set_current_by_name (current_panel, NULL);
 426     panel_re_sort (current_panel);
 427     rotate_dash (FALSE);
 428 }
 429
 430 /* --------------------------------------------------------------------------------------------- */
 431 /*** public functions ****************************************************************************/
 432 /* --------------------------------------------------------------------------------------------- */
 433
 434 void
 435 external_panelize_cmd (void)
 436 {
 437     if (!vfs_current_is_local ())
 438     {
 439         message (D_ERROR, MSG_ERROR, _ ("Cannot run external panelize in a non-local directory"));
 440         return;
 441     }
 442
 443     external_panelize_init ();
 444
 445     // display file info
 446     tty_setcolor (SELECTED_COLOR);
 447
 448     switch (dlg_run (panelize_dlg))
 449     {
 450     case B_CANCEL:
 451         break;
 452
 453     case B_ADD:
 454         add2panelize_cmd ();
 455         break;
 456
 457     case B_REMOVE:
 458     {
 459         panelize_entry_t *entry;
 460
 461         listbox_get_current (l_panelize, NULL, (void **) &entry);
 462         remove_from_panelize (entry);
 463         break;
 464     }
 465
 466     case B_ENTER:
 467         if (!input_is_empty (pname))
 468         {
 469             char *cmd;
 470
 471             cmd = input_get_text (pname);
 472             widget_destroy (WIDGET (panelize_dlg));
 473             do_external_panelize (cmd);
 474             g_free (cmd);
 475             repaint_screen ();
 476             return;
 477         }
 478         break;
 479
 480     default:
 481         break;
 482     }
 483
 484     external_panelize_done ();
 485 }
 486
 487 /* --------------------------------------------------------------------------------------------- */
 488
 489 void
 490 external_panelize_load (void)
 491 {
 492     char **keys;
 493
 494     keys = mc_config_get_keys (mc_global.main_config, panelize_section, NULL);
 495
 496     add2panelize (g_strdup (_ ("Other command")), g_strdup (""));
 497
 498     if (*keys == NULL)
 499     {
 500         add2panelize (g_strdup (_ ("Modified git files")), g_strdup ("git ls-files --modified"));
 501         add2panelize (g_strdup (_ ("Find rejects after patching")),
 502                       g_strdup ("find . -name \\*.rej -print"));
 503         add2panelize (g_strdup (_ ("Find *.orig after patching")),
 504                       g_strdup ("find . -name \\*.orig -print"));
 505         add2panelize (g_strdup (_ ("Find SUID and SGID programs")),
 506                       g_strdup ("find . \\( \\( -perm -04000 -a -perm /011 \\) -o \\( -perm -02000 "
 507                                 "-a -perm /01 \\) \\) -print"));
 508     }
 509     else
 510     {
 511         GIConv conv;
 512         char **profile_keys;
 513
 514         conv = str_crt_conv_from ("UTF-8");
 515
 516         for (profile_keys = keys; *profile_keys != NULL; profile_keys++)
 517         {
 518             GString *buffer;
 519
 520             if (mc_global.utf8_display || conv == INVALID_CONV)
 521                 buffer = g_string_new (*profile_keys);
 522             else
 523             {
 524                 buffer = g_string_new ("");
 525                 if (str_convert (conv, *profile_keys, buffer) == ESTR_FAILURE)
 526                     g_string_assign (buffer, *profile_keys);
 527             }
 528
 529             add2panelize (
 530                 g_string_free (buffer, FALSE),
 531                 mc_config_get_string (mc_global.main_config, panelize_section, *profile_keys, ""));
 532         }
 533
 534         str_close_conv (conv);
 535     }
 536
 537     g_strfreev (keys);
 538 }
 539
 540 /* --------------------------------------------------------------------------------------------- */
 541
 542 void
 543 external_panelize_save (void)
 544 {
 545     GSList *l;
 546
 547     mc_config_del_group (mc_global.main_config, panelize_section);
 548
 549     for (l = panelize; l != NULL; l = g_slist_next (l))
 550     {
 551         panelize_entry_t *current = (panelize_entry_t *) l->data;
 552
 553         if (strcmp (current->label, _ ("Other command")) != 0)
 554             mc_config_set_string (mc_global.main_config, panelize_section, current->label,
 555                                   current->command);
 556     }
 557 }
 558
 559 /* --------------------------------------------------------------------------------------------- */
 560
 561 void
 562 external_panelize_free (void)
 563 {
 564     g_clear_slist (&panelize, panelize_entry_free);
 565     panelize = NULL;
 566 }
 567
 568 /* --------------------------------------------------------------------------------------------- */