1 /* menu.c - General supporting functionality for menus. */
3 * GRUB -- GRand Unified Bootloader
4 * Copyright (C) 2003,2004,2005,2006,2007,2008,2009,2010 Free Software Foundation, Inc.
6 * GRUB is free software: you can redistribute it and/or modify
7 * it under the terms of the GNU General Public License as published by
8 * the Free Software Foundation, either version 3 of the License, or
9 * (at your option) any later version.
11 * GRUB is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 * GNU General Public License for more details.
16 * You should have received a copy of the GNU General Public License
17 * along with GRUB. If not, see <http://www.gnu.org/licenses/>.
20 #include <grub/normal.h>
21 #include <grub/misc.h>
22 #include <grub/loader.h>
24 #include <grub/time.h>
26 #include <grub/menu_viewer.h>
27 #include <grub/command.h>
28 #include <grub/parser.h>
29 #include <grub/auth.h>
30 #include <grub/i18n.h>
31 #include <grub/term.h>
32 #include <grub/script_sh.h>
33 #include <grub/gfxterm.h>
37 int g_ventoy_menu_refresh
= 0;
38 int g_ventoy_memdisk_mode
= 0;
39 int g_ventoy_iso_raw
= 0;
40 int g_ventoy_iso_uefi_drv
= 0;
41 int g_ventoy_last_entry
= 0;
42 int g_ventoy_suppress_esc
= 0;
43 int g_ventoy_menu_esc
= 0;
45 /* Time to delay after displaying an error message about a default/fallback
46 entry failing to boot. */
47 #define DEFAULT_ENTRY_ERROR_DELAY_MS 2500
49 grub_err_t (*grub_gfxmenu_try_hook
) (int entry
, grub_menu_t menu
,
54 TIMEOUT_STYLE_COUNTDOWN
,
58 struct timeout_style_name
{
60 enum timeout_style style
;
61 } timeout_style_names
[] = {
62 {"menu", TIMEOUT_STYLE_MENU
},
63 {"countdown", TIMEOUT_STYLE_COUNTDOWN
},
64 {"hidden", TIMEOUT_STYLE_HIDDEN
},
68 /* Wait until the user pushes any key so that the user
69 can see what happened. */
71 grub_wait_after_message (void)
73 grub_uint64_t endtime
;
75 grub_printf_ (N_("Press any key to continue..."));
78 endtime
= grub_get_time_ms () + 10000;
80 while (grub_get_time_ms () < endtime
81 && grub_getkey_noblock () == GRUB_TERM_NO_KEY
);
86 /* Get a menu entry by its index in the entry list. */
88 grub_menu_get_entry (grub_menu_t menu
, int no
)
92 for (e
= menu
->entry_list
; e
&& no
> 0; e
= e
->next
, no
--)
98 /* Get the index of a menu entry associated with a given hotkey, or -1. */
100 get_entry_index_by_hotkey (grub_menu_t menu
, int hotkey
)
102 grub_menu_entry_t entry
;
105 for (i
= 0, entry
= menu
->entry_list
; i
< menu
->size
;
106 i
++, entry
= entry
->next
)
107 if (entry
->hotkey
== hotkey
)
113 /* Return the timeout style. If the variable "timeout_style" is not set or
114 invalid, default to TIMEOUT_STYLE_MENU. */
115 static enum timeout_style
116 get_timeout_style (void)
119 struct timeout_style_name
*style_name
;
121 val
= grub_env_get ("timeout_style");
123 return TIMEOUT_STYLE_MENU
;
125 for (style_name
= timeout_style_names
; style_name
->name
; style_name
++)
126 if (grub_strcmp (style_name
->name
, val
) == 0)
127 return style_name
->style
;
129 return TIMEOUT_STYLE_MENU
;
132 /* Return the current timeout. If the variable "timeout" is not set or
133 invalid, return -1. */
135 grub_menu_get_timeout (void)
140 val
= grub_env_get ("timeout");
146 timeout
= (int) grub_strtoul (val
, 0, 0);
148 /* If the value is invalid, unset the variable. */
149 if (grub_errno
!= GRUB_ERR_NONE
)
151 grub_env_unset ("timeout");
152 grub_errno
= GRUB_ERR_NONE
;
161 /* Set current timeout in the variable "timeout". */
163 grub_menu_set_timeout (int timeout
)
165 /* Ignore TIMEOUT if it is zero, because it will be unset really soon. */
170 grub_snprintf (buf
, sizeof (buf
), "%d", timeout
);
171 grub_env_set ("timeout", buf
);
175 /* Get the first entry number from the value of the environment variable NAME,
176 which is a space-separated list of non-negative integers. The entry number
177 which is returned is stripped from the value of NAME. If no entry number
178 can be found, -1 is returned. */
180 get_and_remove_first_entry_number (const char *name
)
186 val
= grub_env_get (name
);
192 entry
= (int) grub_strtoul (val
, &tail
, 0);
194 if (grub_errno
== GRUB_ERR_NONE
)
196 /* Skip whitespace to find the next digit. */
197 while (*tail
&& grub_isspace (*tail
))
199 grub_env_set (name
, tail
);
203 grub_env_unset (name
);
204 grub_errno
= GRUB_ERR_NONE
;
213 /* Run a menu entry. */
215 grub_menu_execute_entry(grub_menu_entry_t entry
, int auto_boot
)
217 grub_err_t err
= GRUB_ERR_NONE
;
219 grub_menu_t menu
= NULL
;
220 char *optr
, *buf
, *oldchosen
= NULL
, *olddefault
= NULL
;
221 const char *ptr
, *chosen
, *def
;
224 if (entry
->restricted
)
225 err
= grub_auth_check_authentication (entry
->users
);
230 grub_errno
= GRUB_ERR_NONE
;
234 errs_before
= grub_err_printed_errors
;
236 chosen
= grub_env_get ("chosen");
237 def
= grub_env_get ("default");
241 grub_env_context_open ();
242 menu
= grub_zalloc (sizeof (*menu
));
245 grub_env_set_menu (menu
);
247 grub_env_set ("timeout", "0");
250 for (ptr
= entry
->id
; *ptr
; ptr
++)
251 sz
+= (*ptr
== '>') ? 2 : 1;
254 oldchosen
= grub_strdup (chosen
);
260 olddefault
= grub_strdup (def
);
266 sz
+= grub_strlen (chosen
);
268 buf
= grub_malloc (sz
);
276 optr
= grub_stpcpy (optr
, chosen
);
279 for (ptr
= entry
->id
; *ptr
; ptr
++)
286 grub_env_set ("chosen", buf
);
287 grub_env_export ("chosen");
291 for (ptr
= def
; ptr
&& *ptr
; ptr
++)
293 if (ptr
[0] == '>' && ptr
[1] == '>')
302 if (ptr
&& ptr
[0] && ptr
[1])
303 grub_env_set ("default", ptr
+ 1);
305 grub_env_unset ("default");
307 grub_script_execute_new_scope (entry
->sourcecode
, entry
->argc
, entry
->args
);
309 if (errs_before
!= grub_err_printed_errors
)
310 grub_wait_after_message ();
312 errs_before
= grub_err_printed_errors
;
314 if (grub_errno
== GRUB_ERR_NONE
&& grub_loader_is_loaded ())
315 /* Implicit execution of boot, only if something is loaded. */
316 grub_command_execute ("boot", 0, 0);
318 if (errs_before
!= grub_err_printed_errors
)
319 grub_wait_after_message ();
323 if (menu
&& menu
->size
)
325 grub_show_menu (menu
, 1, auto_boot
);
326 grub_normal_free_menu (menu
);
328 grub_env_context_close ();
331 grub_env_set ("chosen", oldchosen
);
333 grub_env_unset ("chosen");
335 grub_env_set ("default", olddefault
);
337 grub_env_unset ("default");
338 grub_env_unset ("timeout");
341 /* Execute ENTRY from the menu MENU, falling back to entries specified
342 in the environment variable "fallback" if it fails. CALLBACK is a
343 pointer to a struct of function pointers which are used to allow the
344 caller provide feedback to the user. */
346 grub_menu_execute_with_fallback (grub_menu_t menu
,
347 grub_menu_entry_t entry
,
349 grub_menu_execute_callback_t callback
,
354 callback
->notify_booting (entry
, callback_data
);
356 grub_menu_execute_entry (entry
, 1);
358 /* Deal with fallback entries. */
359 while ((fallback_entry
= get_and_remove_first_entry_number ("fallback"))
363 grub_errno
= GRUB_ERR_NONE
;
365 entry
= grub_menu_get_entry (menu
, fallback_entry
);
366 callback
->notify_fallback (entry
, callback_data
);
367 grub_menu_execute_entry (entry
, 1);
368 /* If the function call to execute the entry returns at all, then this is
369 taken to indicate a boot failure. For menu entries that do something
370 other than actually boot an operating system, this could assume
371 incorrectly that something failed. */
375 callback
->notify_failure (callback_data
);
378 static struct grub_menu_viewer
*viewers
;
381 menu_set_chosen_entry (int entry
)
383 struct grub_menu_viewer
*cur
;
384 for (cur
= viewers
; cur
; cur
= cur
->next
)
385 cur
->set_chosen_entry (entry
, cur
->data
);
389 menu_print_timeout (int timeout
)
391 struct grub_menu_viewer
*cur
;
392 for (cur
= viewers
; cur
; cur
= cur
->next
)
393 cur
->print_timeout (timeout
, cur
->data
);
399 struct grub_menu_viewer
*cur
, *next
;
400 for (cur
= viewers
; cur
; cur
= next
)
403 cur
->fini (cur
->data
);
410 menu_init (int entry
, grub_menu_t menu
, int nested
)
412 struct grub_term_output
*term
;
415 FOR_ACTIVE_TERM_OUTPUTS(term
)
416 if (term
->fullscreen
)
418 if (grub_env_get ("theme"))
420 if (!grub_gfxmenu_try_hook
)
422 grub_dl_load ("gfxmenu");
425 if (grub_gfxmenu_try_hook
)
428 err
= grub_gfxmenu_try_hook (entry
, menu
, nested
);
436 grub_error (GRUB_ERR_BAD_MODULE
,
437 N_("module `%s' isn't loaded"),
440 grub_wait_after_message ();
442 grub_errno
= GRUB_ERR_NONE
;
447 FOR_ACTIVE_TERM_OUTPUTS(term
)
451 if (grub_strcmp (term
->name
, "gfxterm") == 0 && gfxmenu
)
454 err
= grub_menu_try_text (term
, entry
, menu
, nested
);
458 grub_errno
= GRUB_ERR_NONE
;
465 struct grub_menu_viewer
*cur
;
466 for (cur
= viewers
; cur
; cur
= cur
->next
)
467 cur
->clear_timeout (cur
->data
);
471 grub_menu_register_viewer (struct grub_menu_viewer
*viewer
)
473 viewer
->next
= viewers
;
478 menuentry_eq (const char *id
, const char *spec
)
480 const char *ptr1
, *ptr2
;
485 if (*ptr2
== '>' && ptr2
[1] != '>' && *ptr1
== 0)
487 if (*ptr2
== '>' && ptr2
[1] != '>')
501 /* Get the entry number from the variable NAME. */
503 get_entry_number (grub_menu_t menu
, const char *name
)
508 val
= grub_env_get (name
);
514 entry
= (int) grub_strtoul (val
, 0, 0);
516 if (grub_errno
== GRUB_ERR_BAD_NUMBER
)
518 /* See if the variable matches the title of a menu entry. */
519 grub_menu_entry_t e
= menu
->entry_list
;
522 grub_errno
= GRUB_ERR_NONE
;
526 if (menuentry_eq (e
->title
, val
)
527 || menuentry_eq (e
->id
, val
))
539 if (grub_errno
!= GRUB_ERR_NONE
)
541 grub_errno
= GRUB_ERR_NONE
;
550 /* Check whether a second has elapsed since the last tick. If so, adjust
551 the timer and return 1; otherwise, return 0. */
553 has_second_elapsed (grub_uint64_t
*saved_time
)
555 grub_uint64_t current_time
;
557 current_time
= grub_get_time_ms ();
558 if (current_time
- *saved_time
>= 1000)
560 *saved_time
= current_time
;
568 print_countdown (struct grub_term_coordinate
*pos
, int n
)
570 grub_term_restore_pos (pos
);
571 /* NOTE: Do not remove the trailing space characters.
572 They are required to clear the line. */
573 grub_printf ("%d ", n
);
577 #define GRUB_MENU_PAGE_SIZE 10
579 /* Show the menu and handle menu entry selection. Returns the menu entry
580 index that should be executed or -1 if no entry should be executed (e.g.,
581 Esc pressed to exit a sub-menu or switching menu viewers).
582 If the return value is not -1, then *AUTO_BOOT is nonzero iff the menu
583 entry to be executed is a result of an automatic default selection because
586 run_menu (grub_menu_t menu
, int nested
, int *auto_boot
)
589 grub_uint64_t saved_time
;
590 int default_entry
,current_entry
;
592 enum timeout_style timeout_style
;
594 default_entry
= get_entry_number (menu
, "default");
596 if (g_ventoy_suppress_esc
)
598 else if (g_ventoy_last_entry
>= 0 && g_ventoy_last_entry
< menu
->size
) {
599 default_entry
= g_ventoy_last_entry
;
601 /* If DEFAULT_ENTRY is not within the menu entries, fall back to
603 else if (default_entry
< 0 || default_entry
>= menu
->size
)
606 timeout
= grub_menu_get_timeout ();
608 /* If there is no timeout, the "countdown" and "hidden" styles result in
609 the system doing nothing and providing no or very little indication
610 why. Technically this is what the user asked for, but it's not very
611 useful and likely to be a source of confusion, so we disallow this. */
612 grub_env_unset ("timeout_style");
614 timeout_style
= get_timeout_style ();
616 if (timeout_style
== TIMEOUT_STYLE_COUNTDOWN
617 || timeout_style
== TIMEOUT_STYLE_HIDDEN
)
619 static struct grub_term_coordinate
*pos
;
622 if (timeout_style
== TIMEOUT_STYLE_COUNTDOWN
&& timeout
)
624 pos
= grub_term_save_pos ();
625 print_countdown (pos
, timeout
);
628 /* Enter interruptible sleep until Escape or a menu hotkey is pressed,
629 or the timeout expires. */
630 saved_time
= grub_get_time_ms ();
635 key
= grub_getkey_noblock ();
636 if (key
!= GRUB_TERM_NO_KEY
)
638 entry
= get_entry_index_by_hotkey (menu
, key
);
642 if (key
== GRUB_TERM_ESC
)
648 if (timeout
> 0 && has_second_elapsed (&saved_time
))
651 if (timeout_style
== TIMEOUT_STYLE_COUNTDOWN
)
652 print_countdown (pos
, timeout
);
656 /* We will fall through to auto-booting the default entry. */
660 grub_env_unset ("timeout");
661 grub_env_unset ("timeout_style");
669 /* If timeout is 0, drawing is pointless (and ugly). */
673 return default_entry
;
676 current_entry
= default_entry
;
679 menu_init (current_entry
, menu
, nested
);
681 /* Initialize the time. */
682 saved_time
= grub_get_time_ms ();
684 timeout
= grub_menu_get_timeout ();
687 menu_print_timeout (timeout
);
694 timeout
= grub_menu_get_timeout ();
696 if (grub_normal_exit_level
)
699 if (timeout
> 0 && has_second_elapsed (&saved_time
))
702 grub_menu_set_timeout (timeout
);
703 menu_print_timeout (timeout
);
708 grub_env_unset ("timeout");
711 return default_entry
;
714 c
= grub_getkey_noblock ();
716 /* Negative values are returned on error. */
717 if ((c
!= GRUB_TERM_NO_KEY
) && (c
> 0))
721 grub_env_unset ("timeout");
722 grub_env_unset ("fallback");
728 case GRUB_TERM_KEY_HOME
:
729 case GRUB_TERM_CTRL
| 'a':
731 menu_set_chosen_entry (current_entry
);
734 case GRUB_TERM_KEY_END
:
735 case GRUB_TERM_CTRL
| 'e':
736 current_entry
= menu
->size
- 1;
737 menu_set_chosen_entry (current_entry
);
740 case GRUB_TERM_KEY_UP
:
741 case GRUB_TERM_CTRL
| 'p':
743 if (current_entry
> 0)
745 menu_set_chosen_entry (current_entry
);
748 case GRUB_TERM_CTRL
| 'n':
749 case GRUB_TERM_KEY_DOWN
:
751 if (current_entry
< menu
->size
- 1)
753 menu_set_chosen_entry (current_entry
);
756 case GRUB_TERM_CTRL
| 'g':
757 case GRUB_TERM_KEY_PPAGE
:
758 if (current_entry
< GRUB_MENU_PAGE_SIZE
)
761 current_entry
-= GRUB_MENU_PAGE_SIZE
;
762 menu_set_chosen_entry (current_entry
);
765 case GRUB_TERM_CTRL
| 'c':
766 case GRUB_TERM_KEY_NPAGE
:
767 if (current_entry
+ GRUB_MENU_PAGE_SIZE
< menu
->size
)
768 current_entry
+= GRUB_MENU_PAGE_SIZE
;
770 current_entry
= menu
->size
- 1;
771 menu_set_chosen_entry (current_entry
);
776 // case GRUB_TERM_KEY_RIGHT:
777 case GRUB_TERM_CTRL
| 'f':
780 return current_entry
;
783 if (nested
&& 0 == g_ventoy_suppress_esc
)
792 grub_cmdline_run (1, 0);
798 grub_menu_entry_t e
= grub_menu_get_entry (menu
, current_entry
);
800 grub_menu_entry_run (e
);
804 case GRUB_TERM_KEY_F2
:
805 cmdstr
= grub_env_get("VTOY_F2_CMD");
809 grub_script_execute_sourcecode(cmdstr
);
813 case GRUB_TERM_KEY_F3
:
814 cmdstr
= grub_env_get("VTOY_F3_CMD");
818 grub_script_execute_sourcecode(cmdstr
);
822 case GRUB_TERM_KEY_F4
:
823 cmdstr
= grub_env_get("VTOY_F4_CMD");
827 grub_script_execute_sourcecode(cmdstr
);
831 case GRUB_TERM_KEY_F5
:
832 cmdstr
= grub_env_get("VTOY_F5_CMD");
836 grub_script_execute_sourcecode(cmdstr
);
840 case GRUB_TERM_KEY_F6
:
841 cmdstr
= grub_env_get("VTOY_F6_CMD");
845 grub_script_execute_sourcecode(cmdstr
);
849 case GRUB_TERM_KEY_F7
:
850 cmdstr
= grub_env_get("VTOY_F7_CMD");
854 grub_script_execute_sourcecode(cmdstr
);
858 case GRUB_TERM_KEY_F1
:
860 g_ventoy_memdisk_mode
= 1 - g_ventoy_memdisk_mode
;
861 g_ventoy_menu_refresh
= 1;
864 case (GRUB_TERM_CTRL
| 'i'):
866 g_ventoy_iso_raw
= 1 - g_ventoy_iso_raw
;
867 g_ventoy_menu_refresh
= 1;
870 case (GRUB_TERM_CTRL
| 'u'):
872 g_ventoy_iso_uefi_drv
= 1 - g_ventoy_iso_uefi_drv
;
873 g_ventoy_menu_refresh
= 1;
880 entry
= get_entry_index_by_hotkey (menu
, c
);
893 /* Never reach here. */
896 /* Callback invoked immediately before a menu entry is executed. */
898 notify_booting (grub_menu_entry_t entry
,
899 void *userdata
__attribute__((unused
)))
902 grub_printf_ (N_("Booting `%s'"), entry
->title
);
903 grub_printf ("\n\n");
906 /* Callback invoked when a default menu entry executed because of a timeout
907 has failed and an attempt will be made to execute the next fallback
910 notify_fallback (grub_menu_entry_t entry
,
911 void *userdata
__attribute__((unused
)))
914 grub_printf_ (N_("Falling back to `%s'"), entry
->title
);
915 grub_printf ("\n\n");
916 grub_millisleep (DEFAULT_ENTRY_ERROR_DELAY_MS
);
919 /* Callback invoked when a menu entry has failed and there is no remaining
920 fallback entry to attempt. */
922 notify_execution_failure (void *userdata
__attribute__((unused
)))
924 if (grub_errno
!= GRUB_ERR_NONE
)
927 grub_errno
= GRUB_ERR_NONE
;
930 grub_printf_ (N_("Failed to boot both default and fallback entries.\n"));
931 grub_wait_after_message ();
934 /* Callbacks used by the text menu to provide user feedback when menu entries
936 static struct grub_menu_execute_callback execution_callback
=
938 .notify_booting
= notify_booting
,
939 .notify_fallback
= notify_fallback
,
940 .notify_failure
= notify_execution_failure
944 show_menu (grub_menu_t menu
, int nested
, int autobooted
)
952 boot_entry
= run_menu (menu
, nested
, &auto_boot
);
956 g_ventoy_last_entry
= boot_entry
;
957 if (g_ventoy_menu_esc
)
960 e
= grub_menu_get_entry (menu
, boot_entry
);
962 continue; /* Menu is empty. */
964 if (2 == e
->argc
&& e
->args
&& e
->args
[1] && grub_strncmp(e
->args
[1], "VTOY_RET", 8) == 0)
970 grub_menu_execute_with_fallback (menu
, e
, autobooted
,
971 &execution_callback
, 0);
973 grub_menu_execute_entry (e
, 0);
978 return GRUB_ERR_NONE
;
982 grub_show_menu (grub_menu_t menu
, int nested
, int autoboot
)
984 grub_err_t err1
, err2
;
988 err1
= show_menu (menu
, nested
, autoboot
);
992 if (grub_normal_exit_level
)
995 err2
= grub_auth_check_authentication (NULL
);
999 grub_errno
= GRUB_ERR_NONE
;