2 Directory hotlist -- for the Midnight Commander
4 Copyright (C) 1994-2025
5 Free Software Foundation, Inc.
10 Andrej Borsenkow, 1996
12 Andrew Borodin <aborodin@vmail.ru>, 2012-2022
14 Janne did the original Hotlist code, Andrej made the groupable
15 hotlist; the move hotlist and revamped the file format and made
18 This file is part of the Midnight Commander.
20 The Midnight Commander is free software: you can redistribute it
21 and/or modify it under the terms of the GNU General Public License as
22 published by the Free Software Foundation, either version 3 of the License,
23 or (at your option) any later version.
25 The Midnight Commander is distributed in the hope that it will be useful,
26 but WITHOUT ANY WARRANTY; without even the implied warranty of
27 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
28 GNU General Public License for more details.
30 You should have received a copy of the GNU General Public License
31 along with this program. If not, see <https://www.gnu.org/licenses/>.
35 * \brief Source: directory hotlist
43 #include <sys/types.h>
47 #include "lib/global.h"
49 #include "lib/tty/tty.h" // COLS
50 #include "lib/tty/key.h" // KEY_M_CTRL
51 #include "lib/skin.h" // colors
52 #include "lib/mcconfig.h" // Load/save directories hotlist
53 #include "lib/fileloc.h"
54 #include "lib/strutil.h"
55 #include "lib/vfs/vfs.h"
57 #include "lib/widget.h"
59 #include "src/setup.h" // For profile_bname
60 #include "src/history.h"
62 #include "command.h" // cmdline
66 /*** global variables ****************************************************************************/
68 /*** file scope macro definitions ****************************************************************/
73 #define B_ADD_CURRENT B_USER
74 #define B_REMOVE (B_USER + 1)
75 #define B_NEW_GROUP (B_USER + 2)
76 #define B_NEW_ENTRY (B_USER + 3)
77 #define B_ENTER_GROUP (B_USER + 4)
78 #define B_UP_GROUP (B_USER + 5)
79 #define B_INSERT (B_USER + 6)
80 #define B_APPEND (B_USER + 7)
81 #define B_MOVE (B_USER + 8)
83 # define B_FREE_ALL_VFS (B_USER + 9)
84 # define B_REFRESH_VFS (B_USER + 10)
91 #define TKN_ENDGROUP 4
95 #define TKN_UNKNOWN 127
100 while ((_tkn = hot_next_token ()) != TKN_EOF && _tkn != TKN_EOL) \
104 #define CHECK_TOKEN(_TKN_) \
105 tkn = hot_next_token (); \
108 hotlist_state.readonly = TRUE; \
109 hotlist_state.file_error = TRUE; \
110 while (tkn != TKN_EOL && tkn != TKN_EOF) \
111 tkn = hot_next_token (); \
115 /*** file scope type declarations ****************************************************************/
128 * these reflect run time state
131 gboolean loaded
; // hotlist is loaded
132 gboolean readonly
; // hotlist readonly
133 gboolean file_error
; // parse error while reading file
134 gboolean running
; /* we are running dlg (and have to
136 gboolean moving
; // we are in moving hotlist currently
137 gboolean modified
; // hotlist was modified
138 hotlist_t type
; // LIST_HOTLIST || LIST_VFSLIST
141 /* Directory hotlist */
144 enum HotListType type
;
147 struct hotlist
*head
;
149 struct hotlist
*next
;
152 /*** forward declarations (file scope functions) *************************************************/
154 /*** file scope variables ************************************************************************/
156 static WPanel
*our_panel
;
158 static gboolean hotlist_has_dot_dot
= TRUE
;
160 static WDialog
*hotlist_dlg
, *movelist_dlg
;
161 static WGroupbox
*hotlist_group
, *movelist_group
;
162 static WListbox
*l_hotlist
, *l_movelist
;
163 static WLabel
*pname
;
167 int ret_cmd
, flags
, y
, x
, len
;
170 widget_pos_flags_t pos_flags
;
172 { B_ENTER
, DEFPUSH_BUTTON
, 0, 0, 0, N_ ("Change &to"),
173 LIST_HOTLIST
| LIST_VFSLIST
| LIST_MOVELIST
, WPOS_KEEP_LEFT
| WPOS_KEEP_BOTTOM
},
175 { B_FREE_ALL_VFS
, NORMAL_BUTTON
, 0, 20, 0, N_ ("&Free VFSs now"), LIST_VFSLIST
,
176 WPOS_KEEP_LEFT
| WPOS_KEEP_BOTTOM
},
177 { B_REFRESH_VFS
, NORMAL_BUTTON
, 0, 43, 0, N_ ("&Refresh"), LIST_VFSLIST
,
178 WPOS_KEEP_LEFT
| WPOS_KEEP_BOTTOM
},
180 { B_ADD_CURRENT
, NORMAL_BUTTON
, 0, 20, 0, N_ ("&Add current"), LIST_HOTLIST
,
181 WPOS_KEEP_LEFT
| WPOS_KEEP_BOTTOM
},
182 { B_UP_GROUP
, NORMAL_BUTTON
, 0, 42, 0, N_ ("&Up"), LIST_HOTLIST
| LIST_MOVELIST
,
183 WPOS_KEEP_LEFT
| WPOS_KEEP_BOTTOM
},
184 { B_CANCEL
, NORMAL_BUTTON
, 0, 53, 0, N_ ("&Cancel"),
185 LIST_HOTLIST
| LIST_VFSLIST
| LIST_MOVELIST
, WPOS_KEEP_RIGHT
| WPOS_KEEP_BOTTOM
},
186 { B_NEW_GROUP
, NORMAL_BUTTON
, 1, 0, 0, N_ ("New &group"), LIST_HOTLIST
,
187 WPOS_KEEP_LEFT
| WPOS_KEEP_BOTTOM
},
188 { B_NEW_ENTRY
, NORMAL_BUTTON
, 1, 15, 0, N_ ("New &entry"), LIST_HOTLIST
,
189 WPOS_KEEP_LEFT
| WPOS_KEEP_BOTTOM
},
190 { B_INSERT
, NORMAL_BUTTON
, 1, 0, 0, N_ ("&Insert"), LIST_MOVELIST
,
191 WPOS_KEEP_LEFT
| WPOS_KEEP_BOTTOM
},
192 { B_APPEND
, NORMAL_BUTTON
, 1, 15, 0, N_ ("A&ppend"), LIST_MOVELIST
,
193 WPOS_KEEP_LEFT
| WPOS_KEEP_BOTTOM
},
194 { B_REMOVE
, NORMAL_BUTTON
, 1, 30, 0, N_ ("&Remove"), LIST_HOTLIST
,
195 WPOS_KEEP_LEFT
| WPOS_KEEP_BOTTOM
},
196 { B_MOVE
, NORMAL_BUTTON
, 1, 42, 0, N_ ("&Move"), LIST_HOTLIST
,
197 WPOS_KEEP_LEFT
| WPOS_KEEP_BOTTOM
}
200 static const size_t hotlist_but_num
= G_N_ELEMENTS (hotlist_but
);
202 static struct hotlist
*hotlist
= NULL
;
204 static struct hotlist
*current_group
;
206 static GString
*tkn_buf
= NULL
;
208 static char *hotlist_file_name
;
209 static FILE *hotlist_file
;
210 static time_t hotlist_file_mtime
;
212 static int list_level
= 0;
214 /* --------------------------------------------------------------------------------------------- */
215 /*** file scope functions ************************************************************************/
216 /* --------------------------------------------------------------------------------------------- */
218 static void init_movelist (struct hotlist
*item
);
219 static void add_new_group_cmd (void);
220 static void add_new_entry_cmd (WPanel
*panel
);
221 static void remove_from_hotlist (struct hotlist
*entry
);
222 static void load_hotlist (void);
223 static void add_dotdot_to_list (void);
225 /* --------------------------------------------------------------------------------------------- */
226 /** If current->data is 0, then we are dealing with a VFS pathname */
229 update_path_name (void)
231 const char *text
= "";
233 WListbox
*list
= hotlist_state
.moving
? l_movelist
: l_hotlist
;
234 Widget
*w
= WIDGET (list
);
236 if (!listbox_is_empty (list
))
241 listbox_get_current (list
, &ctext
, &cdata
);
246 struct hotlist
*hlp
= (struct hotlist
*) cdata
;
248 if (hlp
->type
== HL_TYPE_ENTRY
|| hlp
->type
== HL_TYPE_DOTDOT
)
249 text
= hlp
->directory
;
250 else if (hlp
->type
== HL_TYPE_GROUP
)
251 text
= _ ("Subgroup - press ENTER to see list");
255 p
= g_strconcat (" ", current_group
->label
, " ", (char *) NULL
);
256 if (hotlist_state
.moving
)
257 groupbox_set_title (movelist_group
, str_trunc (p
, w
->rect
.cols
- 2));
260 groupbox_set_title (hotlist_group
, str_trunc (p
, w
->rect
.cols
- 2));
261 label_set_text (pname
, str_trunc (text
, w
->rect
.cols
));
266 /* --------------------------------------------------------------------------------------------- */
269 fill_listbox (WListbox
*list
)
271 struct hotlist
*current
;
273 for (current
= current_group
->head
; current
!= NULL
; current
= current
->next
)
274 switch (current
->type
)
280 lbl
= g_strconcat ("->", current
->label
, (char *) NULL
);
281 listbox_add_item_take (list
, LISTBOX_APPEND_AT_END
, 0, lbl
, current
, FALSE
);
286 listbox_add_item (list
, LISTBOX_APPEND_AT_END
, 0, current
->label
, current
, FALSE
);
293 /* --------------------------------------------------------------------------------------------- */
296 unlink_entry (struct hotlist
*entry
)
298 struct hotlist
*current
= current_group
->head
;
300 if (current
== entry
)
301 current_group
->head
= entry
->next
;
304 while (current
!= NULL
&& current
->next
!= entry
)
305 current
= current
->next
;
307 current
->next
= entry
->next
;
309 entry
->next
= entry
->up
= NULL
;
312 /* --------------------------------------------------------------------------------------------- */
316 add_name_to_list (const char *path
)
318 listbox_add_item (l_hotlist
, LISTBOX_APPEND_AT_END
, 0, path
, NULL
, FALSE
);
322 /* --------------------------------------------------------------------------------------------- */
325 hotlist_run_cmd (int action
)
331 struct hotlist
*saved
= current_group
;
332 struct hotlist
*item
= NULL
;
333 struct hotlist
*moveto_item
= NULL
;
334 struct hotlist
*moveto_group
= NULL
;
337 if (listbox_is_empty (l_hotlist
))
338 return 0; // empty group - nothing to do
340 listbox_get_current (l_hotlist
, NULL
, (void **) &item
);
341 init_movelist (item
);
342 hotlist_state
.moving
= TRUE
;
343 ret
= dlg_run (movelist_dlg
);
344 hotlist_state
.moving
= FALSE
;
345 listbox_get_current (l_movelist
, NULL
, (void **) &moveto_item
);
346 moveto_group
= current_group
;
347 widget_destroy (WIDGET (movelist_dlg
));
348 current_group
= saved
;
351 if (moveto_item
== item
)
352 return 0; /* If we insert/append a before/after a
353 it hardly changes anything ;) */
355 listbox_remove_current (l_hotlist
);
356 item
->up
= moveto_group
;
357 if (moveto_group
->head
== NULL
)
358 moveto_group
->head
= item
;
359 else if (moveto_item
== NULL
)
360 { // we have group with just comments
361 struct hotlist
*p
= moveto_group
->head
;
364 while (p
->next
!= NULL
)
368 else if (ret
== B_ENTER
|| ret
== B_APPEND
)
370 if (moveto_item
->next
== NULL
)
371 moveto_item
->next
= item
;
374 item
->next
= moveto_item
->next
;
375 moveto_item
->next
= item
;
378 else if (moveto_group
->head
== moveto_item
)
380 moveto_group
->head
= item
;
381 item
->next
= moveto_item
;
385 struct hotlist
*p
= moveto_group
->head
;
387 while (p
->next
!= moveto_item
)
389 item
->next
= p
->next
;
392 listbox_remove_list (l_hotlist
);
393 fill_listbox (l_hotlist
);
395 hotlist_state
.modified
= TRUE
;
400 struct hotlist
*entry
= NULL
;
402 listbox_get_current (l_hotlist
, NULL
, (void **) &entry
);
403 remove_from_hotlist (entry
);
408 add_new_group_cmd ();
412 add2hotlist_cmd (our_panel
);
416 add_new_entry_cmd (our_panel
);
426 list
= hotlist_state
.moving
? l_movelist
: l_hotlist
;
427 listbox_get_current (list
, NULL
, &data
);
432 hlp
= (struct hotlist
*) data
;
434 if (hlp
->type
== HL_TYPE_ENTRY
)
435 return (action
== B_ENTER
? 1 : 0);
436 if (hlp
->type
!= HL_TYPE_DOTDOT
)
438 listbox_remove_list (list
);
444 MC_FALLTHROUGH
; // if list empty - just go up
448 WListbox
*list
= hotlist_state
.moving
? l_movelist
: l_hotlist
;
450 listbox_remove_list (list
);
451 current_group
= current_group
->up
;
462 listbox_remove_list (l_hotlist
);
463 listbox_add_item (l_hotlist
, LISTBOX_APPEND_AT_END
, 0, mc_config_get_home_dir (), NULL
,
465 vfs_fill_names (add_name_to_list
);
474 /* --------------------------------------------------------------------------------------------- */
477 hotlist_button_callback (WButton
*button
, int action
)
482 ret
= hotlist_run_cmd (action
);
487 /* --------------------------------------------------------------------------------------------- */
489 static inline cb_ret_t
490 hotlist_handle_key (WDialog
*h
, int key
)
494 case KEY_M_CTRL
| '\n':
499 if (hotlist_button_callback (NULL
, B_ENTER
) != 0)
501 h
->ret_value
= B_ENTER
;
507 // enter to the group
508 if (hotlist_state
.type
== LIST_VFSLIST
)
509 return MSG_NOT_HANDLED
;
510 return hotlist_button_callback (NULL
, B_ENTER_GROUP
) == 0 ? MSG_HANDLED
: MSG_NOT_HANDLED
;
514 if (hotlist_state
.type
== LIST_VFSLIST
)
515 return MSG_NOT_HANDLED
;
516 return hotlist_button_callback (NULL
, B_UP_GROUP
) == 0 ? MSG_HANDLED
: MSG_NOT_HANDLED
;
519 if (hotlist_state
.moving
)
520 return MSG_NOT_HANDLED
;
521 hotlist_button_callback (NULL
, B_REMOVE
);
527 if (!hotlist_state
.moving
)
531 listbox_get_current (l_hotlist
, NULL
, &ldata
);
535 struct hotlist
*hlp
= (struct hotlist
*) ldata
;
537 if (hlp
->type
== HL_TYPE_ENTRY
)
541 tmp
= g_strconcat ("cd ", hlp
->directory
, (char *) NULL
);
542 input_insert (cmdline
, tmp
, FALSE
);
544 h
->ret_value
= B_CANCEL
;
549 return MSG_HANDLED
; // ignore key
552 return MSG_NOT_HANDLED
;
556 /* --------------------------------------------------------------------------------------------- */
559 hotlist_callback (Widget
*w
, Widget
*sender
, widget_msg_t msg
, int parm
, void *data
)
561 WDialog
*h
= DIALOG (w
);
566 case MSG_NOTIFY
: // MSG_NOTIFY is fired by the listbox to tell us the item has changed.
570 case MSG_UNHANDLED_KEY
:
571 return hotlist_handle_key (h
, parm
);
575 * The code here has two purposes:
577 * (1) Always stay on the hotlist.
579 * Activating a button using its hotkey (and even pressing ENTER, as
580 * there's a "default button") moves the focus to the button. But we
581 * want to stay on the hotlist, to be able to use the usual keys (up,
582 * down, etc.). So we do `widget_select (lst)`.
584 * (2) Refresh the hotlist.
586 * We may have run a command that changed the contents of the list.
587 * We therefore need to refresh it. So we do `widget_draw (lst)`.
592 lst
= WIDGET (h
== hotlist_dlg
? l_hotlist
: l_movelist
);
594 /* widget_select() already redraws the widget, but since it's a
595 * no-op if the widget is already selected ("focused"), we have
596 * to call widget_draw() separately. */
597 if (!widget_get_state (lst
, WST_FOCUSED
))
608 r
.lines
= LINES
- (h
== hotlist_dlg
? 2 : 6);
611 return dlg_default_callback (w
, NULL
, MSG_RESIZE
, 0, &r
);
615 return dlg_default_callback (w
, sender
, msg
, parm
, data
);
619 /* --------------------------------------------------------------------------------------------- */
622 hotlist_listbox_callback (WListbox
*list
)
624 WDialog
*dlg
= DIALOG (WIDGET (list
)->owner
);
626 if (!listbox_is_empty (list
))
630 listbox_get_current (list
, NULL
, &data
);
634 struct hotlist
*hlp
= (struct hotlist
*) data
;
636 if (hlp
->type
== HL_TYPE_ENTRY
)
638 dlg
->ret_value
= B_ENTER
;
644 hotlist_button_callback (NULL
, B_ENTER
);
645 send_message (dlg
, NULL
, MSG_POST_KEY
, '\n', NULL
);
651 dlg
->ret_value
= B_ENTER
;
657 hotlist_button_callback (NULL
, B_UP_GROUP
);
658 send_message (dlg
, NULL
, MSG_POST_KEY
, 'u', NULL
);
662 /* --------------------------------------------------------------------------------------------- */
664 * Expands all button names (once) and recalculates button positions.
665 * returns number of columns in the dialog box, which is 10 chars longer
668 * If common width of the window (i.e. in xterm) is less than returned
669 * width - sorry :) (anyway this did not handled in previous version too)
673 init_i18n_stuff (int list_type
, int cols
)
677 static gboolean i18n_flag
= FALSE
;
681 for (i
= 0; i
< hotlist_but_num
; i
++)
684 hotlist_but
[i
].text
= _ (hotlist_but
[i
].text
);
686 hotlist_but
[i
].len
= str_term_width1 (hotlist_but
[i
].text
) + 3;
687 if (hotlist_but
[i
].flags
== DEFPUSH_BUTTON
)
688 hotlist_but
[i
].len
+= 2;
694 // Dynamic resizing of buttonbars
696 int len
[2], count
[2]; // at most two lines of buttons
700 count
[0] = count
[1] = 0;
701 cur_x
[0] = cur_x
[1] = 0;
703 // Count len of buttonbars, assuming 1 extra space between buttons
704 for (i
= 0; i
< hotlist_but_num
; i
++)
705 if ((hotlist_but
[i
].type
& list_type
) != 0)
709 row
= hotlist_but
[i
].y
;
711 len
[row
] += hotlist_but
[i
].len
+ 1;
717 cols
= MAX (cols
, MAX (len
[0], len
[1]));
720 for (i
= 0; i
< hotlist_but_num
; i
++)
721 if ((hotlist_but
[i
].type
& list_type
) != 0)
725 row
= hotlist_but
[i
].y
;
727 if (hotlist_but
[i
].x
!= 0)
729 // not first int the row
730 if (hotlist_but
[i
].ret_cmd
== B_CANCEL
)
731 hotlist_but
[i
].x
= cols
- hotlist_but
[i
].len
- 6;
733 hotlist_but
[i
].x
= cur_x
[row
];
736 cur_x
[row
] += hotlist_but
[i
].len
+ 1;
743 /* --------------------------------------------------------------------------------------------- */
746 init_hotlist (hotlist_t list_type
)
749 const char *title
, *help_node
;
755 Widget
*hotlist_widget
;
760 cols
= init_i18n_stuff (list_type
, COLS
- 6);
763 if (list_type
== LIST_VFSLIST
)
765 title
= _ ("Active VFS directories");
766 help_node
= "[vfshot]"; // FIXME - no such node
772 title
= _ ("Directory hotlist");
773 help_node
= "[Hotlist]";
776 hotlist_dlg
= dlg_create (TRUE
, 0, 0, lines
, cols
, WPOS_CENTER
, FALSE
, dialog_colors
,
777 hotlist_callback
, NULL
, help_node
, title
);
778 g
= GROUP (hotlist_dlg
);
781 hotlist_group
= groupbox_new (y
, UX
, lines
- 10 + dh
, cols
- 2 * UX
, _ ("Top level group"));
782 hotlist_widget
= WIDGET (hotlist_group
);
783 group_add_widget_autopos (g
, hotlist_widget
, WPOS_KEEP_ALL
, NULL
);
785 l_hotlist
= listbox_new (y
+ 1, UX
+ 1, hotlist_widget
->rect
.lines
- 2,
786 hotlist_widget
->rect
.cols
- 2, FALSE
, hotlist_listbox_callback
);
788 // Fill the hotlist with the active VFS or the hotlist
790 if (list_type
== LIST_VFSLIST
)
792 listbox_add_item (l_hotlist
, LISTBOX_APPEND_AT_END
, 0, mc_config_get_home_dir (), NULL
,
794 vfs_fill_names (add_name_to_list
);
798 fill_listbox (l_hotlist
);
800 // insert before groupbox to view scrollbar
801 group_add_widget_autopos (g
, l_hotlist
, WPOS_KEEP_ALL
, NULL
);
803 y
+= hotlist_widget
->rect
.lines
;
805 path_box
= groupbox_new (y
, UX
, 3, hotlist_widget
->rect
.cols
, _ ("Directory path"));
806 group_add_widget_autopos (g
, path_box
, WPOS_KEEP_BOTTOM
| WPOS_KEEP_HORZ
, NULL
);
808 pname
= label_new (y
+ 1, UX
+ 2, NULL
);
809 group_add_widget_autopos (g
, pname
, WPOS_KEEP_BOTTOM
| WPOS_KEEP_LEFT
, NULL
);
810 y
+= WIDGET (path_box
)->rect
.lines
;
812 group_add_widget_autopos (g
, hline_new (y
++, -1, -1), WPOS_KEEP_BOTTOM
, NULL
);
814 for (i
= 0; i
< hotlist_but_num
; i
++)
815 if ((hotlist_but
[i
].type
& list_type
) != 0)
816 group_add_widget_autopos (g
,
817 button_new (y
+ hotlist_but
[i
].y
, UX
+ hotlist_but
[i
].x
,
818 hotlist_but
[i
].ret_cmd
, hotlist_but
[i
].flags
,
819 hotlist_but
[i
].text
, hotlist_button_callback
),
820 hotlist_but
[i
].pos_flags
, NULL
);
822 widget_select (WIDGET (l_hotlist
));
825 /* --------------------------------------------------------------------------------------------- */
828 init_movelist (struct hotlist
*item
)
835 Widget
*movelist_widget
;
840 cols
= init_i18n_stuff (LIST_MOVELIST
, COLS
- 6);
842 hdr
= g_strdup_printf (_ ("Moving %s"), item
->label
);
844 movelist_dlg
= dlg_create (TRUE
, 0, 0, lines
, cols
, WPOS_CENTER
, FALSE
, dialog_colors
,
845 hotlist_callback
, NULL
, "[Hotlist]", hdr
);
846 g
= GROUP (movelist_dlg
);
851 movelist_group
= groupbox_new (y
, UX
, lines
- 7, cols
- 2 * UX
, _ ("Directory label"));
852 movelist_widget
= WIDGET (movelist_group
);
853 group_add_widget_autopos (g
, movelist_widget
, WPOS_KEEP_ALL
, NULL
);
855 l_movelist
= listbox_new (y
+ 1, UX
+ 1, movelist_widget
->rect
.lines
- 2,
856 movelist_widget
->rect
.cols
- 2, FALSE
, hotlist_listbox_callback
);
857 fill_listbox (l_movelist
);
858 // insert before groupbox to view scrollbar
859 group_add_widget_autopos (g
, l_movelist
, WPOS_KEEP_ALL
, NULL
);
861 y
+= movelist_widget
->rect
.lines
;
863 group_add_widget_autopos (g
, hline_new (y
++, -1, -1), WPOS_KEEP_BOTTOM
, NULL
);
865 for (i
= 0; i
< hotlist_but_num
; i
++)
866 if ((hotlist_but
[i
].type
& LIST_MOVELIST
) != 0)
867 group_add_widget_autopos (g
,
868 button_new (y
+ hotlist_but
[i
].y
, UX
+ hotlist_but
[i
].x
,
869 hotlist_but
[i
].ret_cmd
, hotlist_but
[i
].flags
,
870 hotlist_but
[i
].text
, hotlist_button_callback
),
871 hotlist_but
[i
].pos_flags
, NULL
);
873 widget_select (WIDGET (l_movelist
));
876 /* --------------------------------------------------------------------------------------------- */
878 * Destroy the list dialog.
879 * Don't confuse with done_hotlist() for the list in memory.
885 widget_destroy (WIDGET (hotlist_dlg
));
888 update_panels (UP_OPTIMIZE
, UP_KEEPSEL
);
893 /* --------------------------------------------------------------------------------------------- */
896 find_group_section (struct hotlist
*grp
)
898 return g_strconcat (grp
->directory
, ".Group", (char *) NULL
);
901 /* --------------------------------------------------------------------------------------------- */
903 static struct hotlist
*
904 add2hotlist (char *label
, char *directory
, enum HotListType type
, listbox_append_t pos
)
907 struct hotlist
*current
= NULL
;
910 * Hotlist is neither loaded nor loading.
911 * Must be called by "Ctrl-x a" before using hotlist.
913 if (current_group
== NULL
)
916 listbox_get_current (l_hotlist
, NULL
, (void **) ¤t
);
918 // Make sure '..' stays at the top of the list.
919 if ((current
!= NULL
) && (current
->type
== HL_TYPE_DOTDOT
))
920 pos
= LISTBOX_APPEND_AFTER
;
922 new = g_new0 (struct hotlist
, 1);
926 new->directory
= directory
;
927 new->up
= current_group
;
929 if (type
== HL_TYPE_GROUP
)
932 add_dotdot_to_list ();
933 current_group
= new->up
;
936 if (current_group
->head
== NULL
)
938 // first element in group
939 current_group
->head
= new;
941 else if (pos
== LISTBOX_APPEND_AFTER
)
943 new->next
= current
->next
;
946 else if (pos
== LISTBOX_APPEND_BEFORE
&& current
== current_group
->head
)
948 // should be inserted before first item
950 current_group
->head
= new;
952 else if (pos
== LISTBOX_APPEND_BEFORE
)
954 struct hotlist
*p
= current_group
->head
;
956 while (p
->next
!= current
)
963 { // append at the end
964 struct hotlist
*p
= current_group
->head
;
966 while (p
->next
!= NULL
)
972 if (hotlist_state
.running
&& type
!= HL_TYPE_COMMENT
&& type
!= HL_TYPE_DOTDOT
)
974 if (type
== HL_TYPE_GROUP
)
978 lbl
= g_strconcat ("->", new->label
, (char *) NULL
);
979 listbox_add_item_take (l_hotlist
, pos
, 0, lbl
, new, FALSE
);
982 listbox_add_item (l_hotlist
, pos
, 0, new->label
, new, FALSE
);
983 listbox_set_current (l_hotlist
, l_hotlist
->current
);
989 /* --------------------------------------------------------------------------------------------- */
992 add_new_entry_input (const char *header
, const char *text1
, const char *text2
, const char *help
,
993 const char *def_text
, char **r1
, char **r2
)
995 quick_widget_t quick_widgets
[] = {
997 QUICK_LABELED_INPUT (text1
, input_label_above
, def_text
, "input-lbl", r1
, NULL
, FALSE
,
998 FALSE
, INPUT_COMPLETE_NONE
),
999 QUICK_SEPARATOR (FALSE
),
1000 QUICK_LABELED_INPUT (text2
, input_label_above
, def_text
, "input-lbl", r2
, NULL
, FALSE
,
1001 FALSE
, INPUT_COMPLETE_FILENAMES
| INPUT_COMPLETE_CD
),
1002 QUICK_START_BUTTONS (TRUE
, TRUE
),
1003 QUICK_BUTTON (N_ ("&Append"), B_APPEND
, NULL
, NULL
),
1004 QUICK_BUTTON (N_ ("&Insert"), B_INSERT
, NULL
, NULL
),
1005 QUICK_BUTTON (N_ ("&Cancel"), B_CANCEL
, NULL
, NULL
),
1010 WRect r
= { -1, -1, 0, 64 };
1012 quick_dialog_t qdlg
= {
1016 .widgets
= quick_widgets
,
1018 .mouse_callback
= NULL
,
1021 return quick_dialog (&qdlg
);
1024 /* --------------------------------------------------------------------------------------------- */
1027 add_new_entry_cmd (WPanel
*panel
)
1034 // Take current directory as default value for input fields
1035 def_text
= vfs_path_to_str_flags (panel
->cwd_vpath
, 0, VPF_STRIP_PASSWORD
);
1036 ret
= add_new_entry_input (_ ("New hotlist entry"), _ ("Directory label:"),
1037 _ ("Directory path:"), "[Hotlist]", def_text
, &title
, &url
);
1040 if (ret
== B_CANCEL
|| title
== NULL
|| *title
== '\0' || url
== NULL
|| *url
== '\0')
1047 if (ret
== B_ENTER
|| ret
== B_APPEND
)
1048 add2hotlist (title
, url
, HL_TYPE_ENTRY
, LISTBOX_APPEND_AFTER
);
1050 add2hotlist (title
, url
, HL_TYPE_ENTRY
, LISTBOX_APPEND_BEFORE
);
1052 hotlist_state
.modified
= TRUE
;
1055 /* --------------------------------------------------------------------------------------------- */
1058 add_new_group_input (const char *header
, const char *label
, char **result
)
1060 quick_widget_t quick_widgets
[] = {
1062 QUICK_LABELED_INPUT (label
, input_label_above
, "", "input", result
, NULL
,
1063 FALSE
, FALSE
, INPUT_COMPLETE_NONE
),
1064 QUICK_START_BUTTONS (TRUE
, TRUE
),
1065 QUICK_BUTTON (N_ ("&Append"), B_APPEND
, NULL
, NULL
),
1066 QUICK_BUTTON (N_ ("&Insert"), B_INSERT
, NULL
, NULL
),
1067 QUICK_BUTTON (N_ ("&Cancel"), B_CANCEL
, NULL
, NULL
),
1072 WRect r
= { -1, -1, 0, 64 };
1074 quick_dialog_t qdlg
= {
1077 .help
= "[Hotlist]",
1078 .widgets
= quick_widgets
,
1080 .mouse_callback
= NULL
,
1085 ret
= quick_dialog (&qdlg
);
1087 return (ret
!= B_CANCEL
) ? ret
: 0;
1090 /* --------------------------------------------------------------------------------------------- */
1093 add_new_group_cmd (void)
1098 ret
= add_new_group_input (_ ("New hotlist group"), _ ("Name of new group:"), &label
);
1099 if (ret
== 0 || label
== NULL
|| *label
== '\0')
1102 if (ret
== B_ENTER
|| ret
== B_APPEND
)
1103 add2hotlist (label
, 0, HL_TYPE_GROUP
, LISTBOX_APPEND_AFTER
);
1105 add2hotlist (label
, 0, HL_TYPE_GROUP
, LISTBOX_APPEND_BEFORE
);
1107 hotlist_state
.modified
= TRUE
;
1110 /* --------------------------------------------------------------------------------------------- */
1113 remove_group (struct hotlist
*grp
)
1115 struct hotlist
*current
= grp
->head
;
1117 while (current
!= NULL
)
1119 struct hotlist
*next
= current
->next
;
1121 if (current
->type
== HL_TYPE_GROUP
)
1122 remove_group (current
);
1124 g_free (current
->label
);
1125 g_free (current
->directory
);
1132 /* --------------------------------------------------------------------------------------------- */
1135 remove_from_hotlist (struct hotlist
*entry
)
1140 if (entry
->type
== HL_TYPE_DOTDOT
)
1143 if (confirm_directory_hotlist_delete
)
1145 char text
[BUF_MEDIUM
];
1151 g_snprintf (text
, sizeof (text
), _ ("Are you sure you want to remove entry \"%s\"?"),
1152 str_trunc (entry
->label
, 30));
1153 result
= query_dialog (Q_ ("DialogTitle|Delete"), text
, D_ERROR
| D_CENTER
, 2, _ ("&Yes"),
1159 if (entry
->type
== HL_TYPE_GROUP
)
1161 struct hotlist
*head
= entry
->head
;
1163 if (head
!= NULL
&& (head
->type
!= HL_TYPE_DOTDOT
|| head
->next
!= NULL
))
1165 char text
[BUF_MEDIUM
];
1168 g_snprintf (text
, sizeof (text
), _ ("Group \"%s\" is not empty.\nRemove it?"),
1169 str_trunc (entry
->label
, 30));
1170 result
= query_dialog (Q_ ("DialogTitle|Delete"), text
, D_ERROR
| D_CENTER
, 2,
1171 _ ("&Yes"), _ ("&No"));
1176 remove_group (entry
);
1179 unlink_entry (entry
);
1181 g_free (entry
->label
);
1182 g_free (entry
->directory
);
1184 // now remove list entry from screen
1185 listbox_remove_current (l_hotlist
);
1186 hotlist_state
.modified
= TRUE
;
1189 /* --------------------------------------------------------------------------------------------- */
1192 load_group (struct hotlist
*grp
)
1194 gchar
**profile_keys
, **keys
;
1195 char *group_section
;
1196 struct hotlist
*current
= 0;
1198 group_section
= find_group_section (grp
);
1200 keys
= mc_config_get_keys (mc_global
.main_config
, group_section
, NULL
);
1202 current_group
= grp
;
1204 for (profile_keys
= keys
; *profile_keys
!= NULL
; profile_keys
++)
1205 add2hotlist (mc_config_get_string (mc_global
.main_config
, group_section
, *profile_keys
, ""),
1206 g_strdup (*profile_keys
), HL_TYPE_GROUP
, LISTBOX_APPEND_AT_END
);
1210 keys
= mc_config_get_keys (mc_global
.main_config
, grp
->directory
, NULL
);
1212 for (profile_keys
= keys
; *profile_keys
!= NULL
; profile_keys
++)
1213 add2hotlist (mc_config_get_string (mc_global
.main_config
, group_section
, *profile_keys
, ""),
1214 g_strdup (*profile_keys
), HL_TYPE_ENTRY
, LISTBOX_APPEND_AT_END
);
1216 g_free (group_section
);
1219 for (current
= grp
->head
; current
; current
= current
->next
)
1220 load_group (current
);
1223 /* --------------------------------------------------------------------------------------------- */
1226 hot_skip_blanks (void)
1230 while ((c
= getc (hotlist_file
)) != EOF
&& c
!= '\n' && g_ascii_isspace (c
))
1235 /* --------------------------------------------------------------------------------------------- */
1238 hot_next_token (void)
1243 if (tkn_buf
== NULL
)
1244 tkn_buf
= g_string_new ("");
1245 g_string_set_size (tkn_buf
, 0);
1248 c
= hot_skip_blanks ();
1258 while ((c
= getc (hotlist_file
)) != EOF
&& c
!= '\n')
1259 g_string_append_c (tkn_buf
, c
);
1263 while ((c
= getc (hotlist_file
)) != EOF
&& c
!= '"')
1267 c
= getc (hotlist_file
);
1270 g_string_free (tkn_buf
, TRUE
);
1274 g_string_append_c (tkn_buf
, c
== '\n' ? ' ' : c
);
1276 ret
= (c
== EOF
) ? TKN_EOF
: TKN_STRING
;
1279 c
= getc (hotlist_file
);
1282 g_string_free (tkn_buf
, TRUE
);
1288 MC_FALLTHROUGH
; // it is taken as normal character
1293 g_string_append_c (tkn_buf
, g_ascii_toupper (c
));
1295 while ((c
= fgetc (hotlist_file
)) != EOF
&& (g_ascii_isalnum (c
) || !isascii (c
)));
1297 ungetc (c
, hotlist_file
);
1299 if (strncmp (tkn_buf
->str
, "GROUP", l
) == 0)
1301 else if (strncmp (tkn_buf
->str
, "ENTRY", l
) == 0)
1303 else if (strncmp (tkn_buf
->str
, "ENDGROUP", l
) == 0)
1305 else if (strncmp (tkn_buf
->str
, "URL", l
) == 0)
1314 /* --------------------------------------------------------------------------------------------- */
1317 hot_load_group (struct hotlist
*grp
)
1320 struct hotlist
*new_grp
;
1323 current_group
= grp
;
1325 while ((tkn
= hot_next_token ()) != TKN_ENDGROUP
)
1329 CHECK_TOKEN (TKN_STRING
);
1330 new_grp
= add2hotlist (g_strndup (tkn_buf
->str
, tkn_buf
->len
), 0, HL_TYPE_GROUP
,
1331 LISTBOX_APPEND_AT_END
);
1333 hot_load_group (new_grp
);
1334 current_group
= grp
;
1338 CHECK_TOKEN (TKN_STRING
);
1339 label
= g_strndup (tkn_buf
->str
, tkn_buf
->len
);
1340 CHECK_TOKEN (TKN_URL
);
1341 CHECK_TOKEN (TKN_STRING
);
1342 url
= tilde_expand (tkn_buf
->str
);
1343 add2hotlist (label
, url
, HL_TYPE_ENTRY
, LISTBOX_APPEND_AT_END
);
1348 label
= g_strndup (tkn_buf
->str
, tkn_buf
->len
);
1349 add2hotlist (label
, 0, HL_TYPE_COMMENT
, LISTBOX_APPEND_AT_END
);
1352 hotlist_state
.readonly
= TRUE
;
1353 hotlist_state
.file_error
= TRUE
;
1359 hotlist_state
.readonly
= TRUE
;
1360 hotlist_state
.file_error
= TRUE
;
1367 /* --------------------------------------------------------------------------------------------- */
1370 hot_load_file (struct hotlist
*grp
)
1373 struct hotlist
*new_grp
;
1376 current_group
= grp
;
1378 while ((tkn
= hot_next_token ()) != TKN_EOF
)
1382 CHECK_TOKEN (TKN_STRING
);
1383 new_grp
= add2hotlist (g_strndup (tkn_buf
->str
, tkn_buf
->len
), 0, HL_TYPE_GROUP
,
1384 LISTBOX_APPEND_AT_END
);
1386 hot_load_group (new_grp
);
1387 current_group
= grp
;
1391 CHECK_TOKEN (TKN_STRING
);
1392 label
= g_strndup (tkn_buf
->str
, tkn_buf
->len
);
1393 CHECK_TOKEN (TKN_URL
);
1394 CHECK_TOKEN (TKN_STRING
);
1395 url
= tilde_expand (tkn_buf
->str
);
1396 add2hotlist (label
, url
, HL_TYPE_ENTRY
, LISTBOX_APPEND_AT_END
);
1401 label
= g_strndup (tkn_buf
->str
, tkn_buf
->len
);
1402 add2hotlist (label
, 0, HL_TYPE_COMMENT
, LISTBOX_APPEND_AT_END
);
1408 hotlist_state
.readonly
= TRUE
;
1409 hotlist_state
.file_error
= TRUE
;
1415 /* --------------------------------------------------------------------------------------------- */
1418 clean_up_hotlist_groups (const char *section
)
1422 grp_section
= g_strconcat (section
, ".Group", (char *) NULL
);
1423 if (mc_config_has_group (mc_global
.main_config
, section
))
1424 mc_config_del_group (mc_global
.main_config
, section
);
1426 if (mc_config_has_group (mc_global
.main_config
, grp_section
))
1428 char **profile_keys
, **keys
;
1430 keys
= mc_config_get_keys (mc_global
.main_config
, grp_section
, NULL
);
1432 for (profile_keys
= keys
; *profile_keys
!= NULL
; profile_keys
++)
1433 clean_up_hotlist_groups (*profile_keys
);
1436 mc_config_del_group (mc_global
.main_config
, grp_section
);
1438 g_free (grp_section
);
1441 /* --------------------------------------------------------------------------------------------- */
1446 gboolean remove_old_list
= FALSE
;
1447 struct stat stat_buf
;
1449 if (hotlist_state
.loaded
)
1451 stat (hotlist_file_name
, &stat_buf
);
1452 if (hotlist_file_mtime
< stat_buf
.st_mtime
)
1458 if (hotlist_file_name
== NULL
)
1459 hotlist_file_name
= mc_config_get_full_path (MC_HOTLIST_FILE
);
1461 hotlist
= g_new0 (struct hotlist
, 1);
1462 hotlist
->type
= HL_TYPE_GROUP
;
1463 hotlist
->label
= g_strdup (_ ("Top level group"));
1464 hotlist
->up
= hotlist
;
1468 hotlist
->directory
= g_strdup ("Hotlist");
1470 hotlist_file
= fopen (hotlist_file_name
, "r");
1471 if (hotlist_file
== NULL
)
1475 load_group (hotlist
);
1476 hotlist_state
.loaded
= TRUE
;
1478 * just to be sure we got copy
1480 hotlist_state
.modified
= TRUE
;
1481 result
= save_hotlist ();
1482 hotlist_state
.modified
= FALSE
;
1484 remove_old_list
= TRUE
;
1487 D_ERROR
, _ ("Hotlist Load"),
1488 _ ("MC was unable to write %s file,\nyour old hotlist entries were not deleted"),
1489 MC_USERCONF_DIR PATH_SEP_STR MC_HOTLIST_FILE
);
1493 hot_load_file (hotlist
);
1494 fclose (hotlist_file
);
1495 hotlist_state
.loaded
= TRUE
;
1498 if (remove_old_list
)
1500 GError
*mcerror
= NULL
;
1502 clean_up_hotlist_groups ("Hotlist");
1503 if (!mc_config_save_file (mc_global
.main_config
, &mcerror
))
1504 setup_save_config_show_error (mc_global
.main_config
->ini_path
, &mcerror
);
1506 mc_error_message (&mcerror
, NULL
);
1509 stat (hotlist_file_name
, &stat_buf
);
1510 hotlist_file_mtime
= stat_buf
.st_mtime
;
1511 current_group
= hotlist
;
1514 /* --------------------------------------------------------------------------------------------- */
1517 hot_save_group (struct hotlist
*grp
)
1519 struct hotlist
*current
;
1526 for (i = 0; i < n; i++) \
1527 putc (' ', hotlist_file); \
1531 for (current
= grp
->head
; current
!= NULL
; current
= current
->next
)
1532 switch (current
->type
)
1535 INDENT (list_level
);
1536 fputs ("GROUP \"", hotlist_file
);
1537 for (s
= current
->label
; *s
!= '\0'; s
++)
1539 if (*s
== '"' || *s
== '\\')
1540 putc ('\\', hotlist_file
);
1541 putc (*s
, hotlist_file
);
1543 fputs ("\"\n", hotlist_file
);
1545 hot_save_group (current
);
1547 INDENT (list_level
);
1548 fputs ("ENDGROUP\n", hotlist_file
);
1551 INDENT (list_level
);
1552 fputs ("ENTRY \"", hotlist_file
);
1553 for (s
= current
->label
; *s
!= '\0'; s
++)
1555 if (*s
== '"' || *s
== '\\')
1556 putc ('\\', hotlist_file
);
1557 putc (*s
, hotlist_file
);
1559 fputs ("\" URL \"", hotlist_file
);
1560 for (s
= current
->directory
; *s
!= '\0'; s
++)
1562 if (*s
== '"' || *s
== '\\')
1563 putc ('\\', hotlist_file
);
1564 putc (*s
, hotlist_file
);
1566 fputs ("\"\n", hotlist_file
);
1568 case HL_TYPE_COMMENT
:
1569 fprintf (hotlist_file
, "#%s\n", current
->label
);
1571 case HL_TYPE_DOTDOT
:
1579 /* --------------------------------------------------------------------------------------------- */
1582 add_dotdot_to_list (void)
1584 if (current_group
!= hotlist
&& hotlist_has_dot_dot
)
1585 add2hotlist (g_strdup (".."), g_strdup (".."), HL_TYPE_DOTDOT
, LISTBOX_APPEND_AT_END
);
1588 /* --------------------------------------------------------------------------------------------- */
1589 /*** public functions ****************************************************************************/
1590 /* --------------------------------------------------------------------------------------------- */
1593 add2hotlist_cmd (WPanel
*panel
)
1596 const char *cp
= N_ ("Label for \"%s\":");
1598 char *label_string
, *label
;
1604 // extra variable to use it in the button callback
1607 l
= str_term_width1 (cp
);
1608 label_string
= vfs_path_to_str_flags (panel
->cwd_vpath
, 0, VPF_STRIP_PASSWORD
);
1609 lc_prompt
= g_strdup_printf (cp
, str_trunc (label_string
, COLS
- 2 * UX
- (l
+ 8)));
1610 label
= input_dialog (_ ("Add to hotlist"), lc_prompt
, MC_HISTORY_HOTLIST_ADD
, label_string
,
1611 INPUT_COMPLETE_NONE
);
1614 if (label
== NULL
|| *label
== '\0')
1616 g_free (label_string
);
1621 add2hotlist (label
, label_string
, HL_TYPE_ENTRY
, LISTBOX_APPEND_AT_END
);
1622 hotlist_state
.modified
= TRUE
;
1626 /* --------------------------------------------------------------------------------------------- */
1629 hotlist_show (hotlist_t list_type
, WPanel
*panel
)
1631 char *target
= NULL
;
1634 // extra variable to use it in the button callback
1637 hotlist_state
.type
= list_type
;
1640 init_hotlist (list_type
);
1642 // display file info
1643 tty_setcolor (SELECTED_COLOR
);
1645 hotlist_state
.running
= TRUE
;
1646 res
= dlg_run (hotlist_dlg
);
1647 hotlist_state
.running
= FALSE
;
1653 struct hotlist
*hlp
= NULL
;
1655 listbox_get_current (l_hotlist
, &text
, (void **) &hlp
);
1656 target
= g_strdup (hlp
!= NULL
? hlp
->directory
: text
);
1663 /* --------------------------------------------------------------------------------------------- */
1668 gboolean saved
= FALSE
;
1669 struct stat stat_buf
;
1671 if (!hotlist_state
.readonly
&& hotlist_state
.modified
&& hotlist_file_name
!= NULL
)
1673 mc_util_make_backup_if_possible (hotlist_file_name
, ".bak");
1675 hotlist_file
= fopen (hotlist_file_name
, "w");
1676 if (hotlist_file
== NULL
)
1677 mc_util_restore_from_backup_if_possible (hotlist_file_name
, ".bak");
1680 hot_save_group (hotlist
);
1681 fclose (hotlist_file
);
1682 stat (hotlist_file_name
, &stat_buf
);
1683 hotlist_file_mtime
= stat_buf
.st_mtime
;
1684 hotlist_state
.modified
= FALSE
;
1692 /* --------------------------------------------------------------------------------------------- */
1694 * Unload list from memory.
1695 * Don't confuse with hotlist_done() for GUI.
1701 if (hotlist
!= NULL
)
1703 remove_group (hotlist
);
1704 g_free (hotlist
->label
);
1705 g_free (hotlist
->directory
);
1706 MC_PTR_FREE (hotlist
);
1709 hotlist_state
.loaded
= FALSE
;
1711 MC_PTR_FREE (hotlist_file_name
);
1713 current_group
= NULL
;
1715 if (tkn_buf
!= NULL
)
1717 g_string_free (tkn_buf
, TRUE
);
1722 /* --------------------------------------------------------------------------------------------- */