[PATCH] Updated savedefault patch

[Colin Watson]

This is an updated version of Vladimir's savedefault patch in
http://lists.gnu.org/archive/html/grub-devel/2009-06/msg00002.html. I
think I've taken into account the feedback offered there. It depends on
my recent save_env patch
(http://lists.gnu.org/archive/html/grub-devel/2009-09/msg00038.html).

I realise that Robert already said that this was post-1.97 material, but
I'd like to see if we can agree on this in advance.

Still to do: update grub-set-default to use this (obvious, I think);
implement 'savedefault --once' and grub-reboot (useful when you want to
tell the boot loader to boot something else just once, but then return
to the previous default; consider unattended scenarios).

2009-09-02  Vladimir Serbinenko  <address@hidden>
2009-09-02  Colin Watson  <address@hidden>

        * normal/menu.c (grub_menu_execute_entry): Save selected entry title
        in `chosen_entry' environment variable.
        * normal/menu_text.c (get_entry_number): Check if the variable
        matches the title of a menu entry.
        (run_menu): Pass menu to get_entry_number.
        * util/grub-mkconfig_lib.in (save_default_entry): New function.
        * util/grub.d/00_header.in: If GRUB_DEFAULT is `saved', set
        default to `${saved_entry}'.  Load environment on initialisation.
        * util/grub.d/10_freebsd.in: Call save_default_entry.
        * util/grub.d/10_hurd.in: Likewise.
        * util/grub.d/10_linux.in (linux_entry): Likewise.
        * util/grub.d/10_windows.in: Likewise.
        * util/grub.d/30_os-prober.in: Likewise.
        * util/i386/pc/grub-install.in: Create environment block.
        * util/i386/efi/grub-install.in: Likewise.
        * util/ieee1275/grub-install.in: Likewise.
        * util/sparc64/ieee1275/grub-install.in: Likewise.

Index: normal/menu.c
===================================================================
--- normal/menu.c       (revision 2558)
+++ normal/menu.c       (working copy)
@@ -137,6 +137,8 @@
       return;
     }
 
+  grub_env_set ("chosen_entry", entry->title);
+
   grub_parser_execute ((char *) entry->sourcecode);
 
   if (grub_errno == GRUB_ERR_NONE && grub_loader_is_loaded ())
Index: normal/menu_text.c
===================================================================
--- normal/menu_text.c  (revision 2558)
+++ normal/menu_text.c  (working copy)
@@ -237,7 +237,7 @@
 
 /* Get the entry number from the variable NAME.  */
 static int
-get_entry_number (const char *name)
+get_entry_number (grub_menu_t menu, const char *name)
 {
   char *val;
   int entry;
@@ -250,6 +250,28 @@
 
   entry = (int) grub_strtoul (val, 0, 0);
 
+  if (grub_errno == GRUB_ERR_BAD_NUMBER)
+    {
+      /* See if the variable matches the title of a menu entry.  */
+      grub_menu_entry_t e = menu->entry_list;
+      int i;
+
+      grub_errno = GRUB_ERR_NONE;
+
+      for (i = 0; e; i++)
+       {
+         if (grub_strcmp (e->title, val) == 0)
+           {
+             entry = i;
+             break;
+           }
+         e = e->next;
+       }
+
+      if (! e)
+       entry = -1;
+    }
+
   if (grub_errno != GRUB_ERR_NONE)
     {
       grub_errno = GRUB_ERR_NONE;
@@ -291,7 +313,7 @@
 
   first = 0;
 
-  default_entry = get_entry_number ("default");
+  default_entry = get_entry_number (menu, "default");
 
   /* If DEFAULT_ENTRY is not within the menu entries, fall back to
      the first entry.  */
Index: util/grub-mkconfig_lib.in
===================================================================
--- util/grub-mkconfig_lib.in   (revision 2558)
+++ util/grub-mkconfig_lib.in   (working copy)
@@ -130,6 +130,13 @@
   echo ${drive}${relative_path}
 }
 
+save_default_entry ()
+{
+  if [ "x${GRUB_DEFAULT}" = "xsaved" ] ; then
+    echo 'save_env saved_entry=${chosen_entry}'
+  fi
+}
+
 prepare_grub_to_access_device ()
 {
   device=$1
Index: util/grub.d/10_freebsd.in
===================================================================
--- util/grub.d/10_freebsd.in   (revision 2558)
+++ util/grub.d/10_freebsd.in   (working copy)
@@ -58,6 +58,7 @@
   cat << EOF
 menuentry "${OS}" {
 EOF
+  save_default_entry | sed -e "s/^/\t/"
   prepare_grub_to_access_device ${GRUB_DEVICE_BOOT} | sed -e "s/^/\t/"
   cat << EOF
        freebsd                 ${kfreebsd_rel_dirname}/${kfreebsd_basename}
Index: util/grub.d/10_windows.in
===================================================================
--- util/grub.d/10_windows.in   (revision 2558)
+++ util/grub.d/10_windows.in   (working copy)
@@ -73,6 +73,7 @@
 menuentry "$OS" {
 EOF
 
+  save_default_entry | sed -e 's,^,\t,'
   prepare_grub_to_access_device "$dev" | sed 's,^,\t,'
 
   cat << EOF
Index: util/grub.d/30_os-prober.in
===================================================================
--- util/grub.d/30_os-prober.in (revision 2558)
+++ util/grub.d/30_os-prober.in (working copy)
@@ -55,6 +55,7 @@
       cat << EOF
 menuentry "${LONGNAME} (on ${DEVICE})" {
 EOF
+      save_default_entry | sed -e "s/^/\t/"
       prepare_grub_to_access_device ${DEVICE} | sed -e "s/^/\t/"
 
       if [ "${LONGNAME}" != "Windows Vista (loader)" ] ; then
@@ -85,6 +86,7 @@
         cat << EOF
 menuentry "${LLABEL} (on ${DEVICE})" {
 EOF
+       save_default_entry | sed -e "s/^/\t/"
        prepare_grub_to_access_device ${DEVICE} | sed -e "s/^/\t/"
        cat <<  EOF
        linux ${LKERNEL} ${LPARAMS}
@@ -104,6 +106,7 @@
         cat << EOF
 menuentry "${LONGNAME} (on ${DEVICE})" {
 EOF
+       save_default_entry | sed -e "s/^/\t/"
        prepare_grub_to_access_device ${DEVICE} | sed -e "s/^/\t/"
        cat << EOF
         insmod vbe
Index: util/grub.d/10_linux.in
===================================================================
--- util/grub.d/10_linux.in     (revision 2558)
+++ util/grub.d/10_linux.in     (working copy)
@@ -47,6 +47,7 @@
   cat << EOF
 menuentry "$1" {
 EOF
+  save_default_entry | sed -e "s/^/\t/"
   prepare_grub_to_access_device ${GRUB_DEVICE_BOOT} | sed -e "s/^/\t/"
   cat << EOF
        linux   ${rel_dirname}/${basename} 
root=${linux_root_device_thisversion} ro $2
Index: util/grub.d/10_hurd.in
===================================================================
--- util/grub.d/10_hurd.in      (revision 2558)
+++ util/grub.d/10_hurd.in      (working copy)
@@ -71,6 +71,7 @@
 cat << EOF
 menuentry "${OS}" {
 EOF
+save_default_entry | sed -e "s/^/\t/"
 prepare_grub_to_access_device ${GRUB_DEVICE} | sed -e "s/^/\t/"
 cat << EOF
        multiboot ${kernel} root=device:${GRUB_DEVICE}
Index: util/grub.d/00_header.in
===================================================================
--- util/grub.d/00_header.in    (revision 2558)
+++ util/grub.d/00_header.in    (working copy)
@@ -32,10 +32,12 @@
 done
 
 if [ "x${GRUB_DEFAULT}" = "x" ] ; then GRUB_DEFAULT=0 ; fi
+if [ "x${GRUB_DEFAULT}" = "xsaved" ] ; then GRUB_DEFAULT='${saved_entry}' ; fi
 if [ "x${GRUB_TIMEOUT}" = "x" ] ; then GRUB_TIMEOUT=5 ; fi
 if [ "x${GRUB_GFXMODE}" = "x" ] ; then GRUB_GFXMODE=640x480 ; fi
 
 cat << EOF
+load_env
 set default=${GRUB_DEFAULT}
 EOF
 
Index: util/i386/pc/grub-install.in
===================================================================
--- util/i386/pc/grub-install.in        (revision 2558)
+++ util/i386/pc/grub-install.in        (working copy)
@@ -39,6 +39,7 @@
 fi
 grub_mkdevicemap=${sbindir}/`echo grub-mkdevicemap | sed ${transform}`
 grub_probe=${sbindir}/`echo grub-probe | sed ${transform}`
+grub_editenv=${bindir}/`echo grub-editenv | sed ${transform}`
 rootdir=
 grub_prefix=`echo /boot/grub | sed ${transform}`
 modules=
@@ -247,6 +248,10 @@
     done
 fi
 
+if ! test -f ${grubdir}/grubenv; then
+    $grub_editenv ${grubdir}/grubenv create
+fi
+
 # Write device to a variable so we don't have to traverse /dev every time.
 grub_device=`$grub_probe --target=device ${grubdir}`
 
Index: util/i386/efi/grub-install.in
===================================================================
--- util/i386/efi/grub-install.in       (revision 2558)
+++ util/i386/efi/grub-install.in       (working copy)
@@ -34,6 +34,7 @@
 grub_mkimage=${bindir}/`echo grub-mkimage | sed ${transform}`
 grub_mkdevicemap=${sbindir}/`echo grub-mkdevicemap | sed ${transform}`
 grub_probe=${sbindir}/`echo grub-probe | sed ${transform}`
+grub_editenv=${bindir}/`echo grub-editenv | sed ${transform}`
 rootdir=
 grub_prefix=`echo /boot/grub | sed ${transform}`
 modules=
@@ -178,6 +179,10 @@
     cp -f $file ${grubdir} || exit 1
 done
 
+if ! test -f ${grubdir}/grubenv; then
+    $grub_editenv ${grubdir}/grubenv create
+fi
+
 # Create the core image. First, auto-detect the filesystem module.
 fs_module=`$grub_probe --target=fs --device-map=${device_map} ${grubdir}`
 if test "x$fs_module" = xfat; then :; else
Index: util/ieee1275/grub-install.in
===================================================================
--- util/ieee1275/grub-install.in       (revision 2558)
+++ util/ieee1275/grub-install.in       (working copy)
@@ -37,6 +37,7 @@
 grub_mkimage=${bindir}/`echo grub-mkelfimage | sed ${transform}`
 grub_mkdevicemap=${sbindir}/`echo grub-mkdevicemap | sed ${transform}`
 grub_probe=${sbindir}/`echo grub-probe | sed ${transform}`
+grub_editenv=${bindir}/`echo grub-editenv | sed ${transform}`
 rootdir=
 grub_prefix=`echo /boot/grub | sed ${transform}`
 modules=
@@ -163,6 +164,10 @@
     cp -f $file ${grubdir} || exit 1
 done
 
+if ! test -f ${grubdir}/grubenv; then
+    $grub_editenv ${grubdir}/grubenv create
+fi
+
 # Create the core image. First, auto-detect the filesystem module.
 fs_module=`$grub_probe --target=fs --device-map=${device_map} ${grubdir}`
 if test "x$fs_module" = x -a "x$modules" = x; then
Index: util/sparc64/ieee1275/grub-install.in
===================================================================
--- util/sparc64/ieee1275/grub-install.in       (revision 2558)
+++ util/sparc64/ieee1275/grub-install.in       (working copy)
@@ -35,6 +35,7 @@
 grub_mkimage=${bindir}/`echo grub-mkimage | sed ${transform}`
 grub_mkdevicemap=${sbindir}/`echo grub-mkdevicemap | sed ${transform}`
 grub_probe=${sbindir}/`echo grub-probe | sed ${transform}`
+grub_editenv=${bindir}/`echo grub-editenv | sed ${transform}`
 rootdir=
 grub_prefix=`echo /boot/grub | sed ${transform}`
 modules=
@@ -206,6 +207,10 @@
     cp -f $file ${grubdir} || exit 1
 done
 
+if ! test -f ${grubdir}/grubenv; then
+    $grub_editenv ${grubdir}/grubenv create
+fi
+
 # Write device to a variable so we don't have to traverse /dev every time.
 grub_device=`$grub_probe --target=device ${grubdir}`
 

Thanks,

-- 
Colin Watson                                       address@hidden