normal/menu.c

   1 /*
   2  *  GRUB  --  GRand Unified Bootloader
   3  *  Copyright (C) 2003,2004,2005,2006,2007,2008  Free Software Foundation, Inc.
   4  *
   5  *  GRUB is free software: you can redistribute it and/or modify
   6  *  it under the terms of the GNU General Public License as published by
   7  *  the Free Software Foundation, either version 3 of the License, or
   8  *  (at your option) any later version.
   9  *
  10  *  GRUB is distributed in the hope that it will be useful,
  11  *  but WITHOUT ANY WARRANTY; without even the implied warranty of
  12  *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  13  *  GNU General Public License for more details.
  14  *
  15  *  You should have received a copy of the GNU General Public License
  16  *  along with GRUB.  If not, see <http://www.gnu.org/licenses/>.
  17  */
  18
  19 #include <grub/normal.h>
  20 #include <grub/term.h>
  21 #include <grub/misc.h>
  22 #include <grub/loader.h>
  23 #include <grub/mm.h>
  24 #include <grub/time.h>
  25 #include <grub/env.h>
  26 #include <grub/script.h>
  27
  28 static grub_uint8_t grub_color_menu_normal;
  29 static grub_uint8_t grub_color_menu_highlight;
  30
  31 /* Wait until the user pushes any key so that the user
  32    can see what happened.  */
  33 void
  34 grub_wait_after_message (void)
  35 {
  36   grub_printf ("\nPress any key to continue...");
  37   (void) grub_getkey ();
  38 }
  39
  40 static void
  41 draw_border (void)
  42 {
  43   unsigned i;
  44
  45   grub_setcolorstate (GRUB_TERM_COLOR_NORMAL);
  46
  47   grub_gotoxy (GRUB_TERM_MARGIN, GRUB_TERM_TOP_BORDER_Y);
  48   grub_putcode (GRUB_TERM_DISP_UL);
  49   for (i = 0; i < (unsigned) GRUB_TERM_BORDER_WIDTH - 2; i++)
  50     grub_putcode (GRUB_TERM_DISP_HLINE);
  51   grub_putcode (GRUB_TERM_DISP_UR);
  52
  53   for (i = 0; i < (unsigned) GRUB_TERM_NUM_ENTRIES; i++)
  54     {
  55       grub_gotoxy (GRUB_TERM_MARGIN, GRUB_TERM_TOP_BORDER_Y + i + 1);
  56       grub_putcode (GRUB_TERM_DISP_VLINE);
  57       grub_gotoxy (GRUB_TERM_MARGIN + GRUB_TERM_BORDER_WIDTH - 1,
  58                    GRUB_TERM_TOP_BORDER_Y + i + 1);
  59       grub_putcode (GRUB_TERM_DISP_VLINE);
  60     }
  61
  62   grub_gotoxy (GRUB_TERM_MARGIN,
  63                GRUB_TERM_TOP_BORDER_Y + GRUB_TERM_NUM_ENTRIES + 1);
  64   grub_putcode (GRUB_TERM_DISP_LL);
  65   for (i = 0; i < (unsigned) GRUB_TERM_BORDER_WIDTH - 2; i++)
  66     grub_putcode (GRUB_TERM_DISP_HLINE);
  67   grub_putcode (GRUB_TERM_DISP_LR);
  68
  69   grub_setcolorstate (GRUB_TERM_COLOR_NORMAL);
  70
  71   grub_gotoxy (GRUB_TERM_MARGIN,
  72                (GRUB_TERM_TOP_BORDER_Y + GRUB_TERM_NUM_ENTRIES
  73                 + GRUB_TERM_MARGIN + 1));
  74 }
  75
  76 static void
  77 print_message (int nested, int edit)
  78 {
  79   grub_setcolorstate (GRUB_TERM_COLOR_NORMAL);
  80
  81   if (edit)
  82     {
  83       grub_printf ("\n\
  84       Minimum Emacs-like screen editing is supported. TAB lists\n\
  85       available completions. Press C-x (\'x\' with Ctrl) to boot,\n\
  86       C-c (\'c\' with Ctrl) for a command-line or ESC to return menu.");
  87     }
  88   else
  89     {
  90       grub_printf ("\n\
  91       Use the %C and %C keys to select which entry is highlighted.\n",
  92                    (grub_uint32_t) GRUB_TERM_DISP_UP, (grub_uint32_t) GRUB_TERM_DISP_DOWN);
  93       grub_printf ("\
  94       Press enter to boot the selected OS, \'e\' to edit the\n\
  95       commands before booting or \'c\' for a command-line.");
  96       if (nested)
  97         grub_printf ("\n\
  98       ESC to return previous menu.");
  99     }
 100
 101 }
 102
 103 static grub_menu_entry_t
 104 get_entry (grub_menu_t menu, int no)
 105 {
 106   grub_menu_entry_t e;
 107
 108   for (e = menu->entry_list; e && no > 0; e = e->next, no--)
 109     ;
 110
 111   return e;
 112 }
 113
 114 static void
 115 print_entry (int y, int highlight, grub_menu_entry_t entry)
 116 {
 117   int x;
 118   const char *title;
 119   grub_ssize_t len;
 120   grub_uint32_t *unicode_title;
 121   grub_ssize_t i;
 122   grub_uint8_t old_color_normal, old_color_highlight;
 123
 124   title = entry ? entry->title : "";
 125   unicode_title = grub_malloc (grub_strlen (title) * sizeof (*unicode_title));
 126   if (! unicode_title)
 127     /* XXX How to show this error?  */
 128     return;
 129
 130   len = grub_utf8_to_ucs4 (unicode_title, (grub_uint8_t *) title,
 131                            grub_strlen (title));
 132   if (len < 0)
 133     {
 134       /* It is an invalid sequence.  */
 135       grub_free (unicode_title);
 136       return;
 137     }
 138
 139   grub_getcolor (&old_color_normal, &old_color_highlight);
 140   grub_setcolor (grub_color_menu_normal, grub_color_menu_highlight);
 141   grub_setcolorstate (highlight
 142                       ? GRUB_TERM_COLOR_HIGHLIGHT
 143                       : GRUB_TERM_COLOR_NORMAL);
 144
 145   grub_gotoxy (GRUB_TERM_LEFT_BORDER_X + GRUB_TERM_MARGIN, y);
 146
 147   for (x = GRUB_TERM_LEFT_BORDER_X + GRUB_TERM_MARGIN + 1, i = 0;
 148        x < GRUB_TERM_LEFT_BORDER_X + GRUB_TERM_BORDER_WIDTH - GRUB_TERM_MARGIN;
 149        i++)
 150     {
 151       if (i < len
 152           && x <= (GRUB_TERM_LEFT_BORDER_X + GRUB_TERM_BORDER_WIDTH
 153                    - GRUB_TERM_MARGIN - 1))
 154         {
 155           grub_ssize_t width;
 156
 157           width = grub_getcharwidth (unicode_title[i]);
 158
 159           if (x + width > (GRUB_TERM_LEFT_BORDER_X + GRUB_TERM_BORDER_WIDTH
 160                            - GRUB_TERM_MARGIN - 1))
 161             grub_putcode (GRUB_TERM_DISP_RIGHT);
 162           else
 163             grub_putcode (unicode_title[i]);
 164
 165           x += width;
 166         }
 167       else
 168         {
 169           grub_putchar (' ');
 170           x++;
 171         }
 172     }
 173   grub_setcolorstate (GRUB_TERM_COLOR_NORMAL);
 174   grub_putchar (' ');
 175
 176   grub_gotoxy (GRUB_TERM_CURSOR_X, y);
 177
 178   grub_setcolor (old_color_normal, old_color_highlight);
 179   grub_setcolorstate (GRUB_TERM_COLOR_NORMAL);
 180   grub_free (unicode_title);
 181 }
 182
 183 static void
 184 print_entries (grub_menu_t menu, int first, int offset)
 185 {
 186   grub_menu_entry_t e;
 187   int i;
 188
 189   grub_gotoxy (GRUB_TERM_LEFT_BORDER_X + GRUB_TERM_BORDER_WIDTH,
 190                GRUB_TERM_FIRST_ENTRY_Y);
 191
 192   if (first)
 193     grub_putcode (GRUB_TERM_DISP_UP);
 194   else
 195     grub_putchar (' ');
 196
 197   e = get_entry (menu, first);
 198
 199   for (i = 0; i < GRUB_TERM_NUM_ENTRIES; i++)
 200     {
 201       print_entry (GRUB_TERM_FIRST_ENTRY_Y + i, offset == i, e);
 202       if (e)
 203         e = e->next;
 204     }
 205
 206   grub_gotoxy (GRUB_TERM_LEFT_BORDER_X + GRUB_TERM_BORDER_WIDTH,
 207                GRUB_TERM_TOP_BORDER_Y + GRUB_TERM_NUM_ENTRIES);
 208
 209   if (e)
 210     grub_putcode (GRUB_TERM_DISP_DOWN);
 211   else
 212     grub_putchar (' ');
 213
 214   grub_gotoxy (GRUB_TERM_CURSOR_X, GRUB_TERM_FIRST_ENTRY_Y + offset);
 215 }
 216
 217 /* Initialize the screen.  If NESTED is non-zero, assume that this menu
 218    is run from another menu or a command-line. If EDIT is non-zero, show
 219    a message for the menu entry editor.  */
 220 void
 221 grub_menu_init_page (int nested, int edit)
 222 {
 223   grub_uint8_t old_color_normal, old_color_highlight;
 224
 225   grub_getcolor (&old_color_normal, &old_color_highlight);
 226
 227   /* By default, use the same colors for the menu.  */
 228   grub_color_menu_normal = old_color_normal;
 229   grub_color_menu_highlight = old_color_highlight;
 230
 231   /* Then give user a chance to replace them.  */
 232   grub_parse_color_name_pair (&grub_color_menu_normal, grub_env_get ("menu_color_normal"));
 233   grub_parse_color_name_pair (&grub_color_menu_highlight, grub_env_get ("menu_color_highlight"));
 234
 235   grub_normal_init_page ();
 236   grub_setcolor (grub_color_menu_normal, grub_color_menu_highlight);
 237   draw_border ();
 238   grub_setcolor (old_color_normal, old_color_highlight);
 239   print_message (nested, edit);
 240 }
 241
 242 /* Return the current timeout. If the variable "timeout" is not set or
 243    invalid, return -1.  */
 244 static int
 245 get_timeout (void)
 246 {
 247   char *val;
 248   int timeout;
 249
 250   val = grub_env_get ("timeout");
 251   if (! val)
 252     return -1;
 253
 254   grub_error_push ();
 255
 256   timeout = (int) grub_strtoul (val, 0, 0);
 257
 258   /* If the value is invalid, unset the variable.  */
 259   if (grub_errno != GRUB_ERR_NONE)
 260     {
 261       grub_env_unset ("timeout");
 262       grub_errno = GRUB_ERR_NONE;
 263       timeout = -1;
 264     }
 265
 266   grub_error_pop ();
 267
 268   return timeout;
 269 }
 270
 271 /* Set current timeout in the variable "timeout".  */
 272 static void
 273 set_timeout (int timeout)
 274 {
 275   /* Ignore TIMEOUT if it is zero, because it will be unset really soon.  */
 276   if (timeout > 0)
 277     {
 278       char buf[16];
 279
 280       grub_sprintf (buf, "%d", timeout);
 281       grub_env_set ("timeout", buf);
 282     }
 283 }
 284
 285 /* Get the entry number from the variable NAME.  */
 286 static int
 287 get_entry_number (const char *name)
 288 {
 289   char *val;
 290   int entry;
 291
 292   val = grub_env_get (name);
 293   if (! val)
 294     return -1;
 295
 296   grub_error_push ();
 297
 298   entry = (int) grub_strtoul (val, 0, 0);
 299
 300   if (grub_errno != GRUB_ERR_NONE)
 301     {
 302       grub_errno = GRUB_ERR_NONE;
 303       entry = -1;
 304     }
 305
 306   grub_error_pop ();
 307
 308   return entry;
 309 }
 310
 311 static void
 312 print_timeout (int timeout, int offset, int second_stage)
 313 {
 314   /* NOTE: Do not remove the trailing space characters.
 315      They are required to clear the line.  */
 316   char *msg = "   The highlighted entry will be booted automatically in %ds.    ";
 317   char *msg_end = grub_strchr (msg, '%');
 318
 319   grub_gotoxy (second_stage ? (msg_end - msg) : 0, GRUB_TERM_HEIGHT - 3);
 320   grub_printf (second_stage ? msg_end : msg, timeout);
 321   grub_gotoxy (GRUB_TERM_CURSOR_X, GRUB_TERM_FIRST_ENTRY_Y + offset);
 322   grub_refresh ();
 323 };
 324
 325 static int
 326 run_menu (grub_menu_t menu, int nested)
 327 {
 328   int first, offset;
 329   grub_uint64_t saved_time;
 330   int default_entry;
 331   int timeout;
 332
 333   first = 0;
 334
 335   default_entry = get_entry_number ("default");
 336
 337   /* If DEFAULT_ENTRY is not within the menu entries, fall back to
 338      the first entry.  */
 339   if (default_entry < 0 || default_entry >= menu->size)
 340     default_entry = 0;
 341
 342   /* If timeout is 0, drawing is pointless (and ugly).  */
 343   if (get_timeout () == 0)
 344     return default_entry;
 345
 346   offset = default_entry;
 347   if (offset > GRUB_TERM_NUM_ENTRIES - 1)
 348     {
 349       first = offset - (GRUB_TERM_NUM_ENTRIES - 1);
 350       offset = GRUB_TERM_NUM_ENTRIES - 1;
 351     }
 352
 353   /* Initialize the time.  */
 354   saved_time = grub_get_time_ms ();
 355
 356  refresh:
 357   grub_setcursor (0);
 358   grub_menu_init_page (nested, 0);
 359   print_entries (menu, first, offset);
 360   grub_refresh ();
 361
 362   timeout = get_timeout ();
 363
 364   if (timeout > 0)
 365     print_timeout (timeout, offset, 0);
 366
 367   while (1)
 368     {
 369       int c;
 370       timeout = get_timeout ();
 371
 372       if (timeout > 0)
 373         {
 374           grub_uint64_t current_time;
 375
 376           current_time = grub_get_time_ms ();
 377           if (current_time - saved_time >= 1000)
 378             {
 379               timeout--;
 380               set_timeout (timeout);
 381               saved_time = current_time;
 382               print_timeout (timeout, offset, 1);
 383             }
 384         }
 385
 386       if (timeout == 0)
 387         {
 388           grub_env_unset ("timeout");
 389           return default_entry;
 390         }
 391
 392       if (grub_checkkey () >= 0 || timeout < 0)
 393         {
 394           c = GRUB_TERM_ASCII_CHAR (grub_getkey ());
 395
 396           if (timeout >= 0)
 397             {
 398               grub_gotoxy (0, GRUB_TERM_HEIGHT - 3);
 399               grub_printf ("\
 400                                                                         ");
 401               grub_env_unset ("timeout");
 402               grub_env_unset ("fallback");
 403               grub_gotoxy (GRUB_TERM_CURSOR_X, GRUB_TERM_FIRST_ENTRY_Y + offset);
 404             }
 405
 406           switch (c)
 407             {
 408             case GRUB_TERM_HOME:
 409               first = 0;
 410               offset = 0;
 411               print_entries (menu, first, offset);
 412               break;
 413
 414             case GRUB_TERM_END:
 415               offset = menu->size - 1;
 416               if (offset > GRUB_TERM_NUM_ENTRIES - 1)
 417                 {
 418                   first = offset - (GRUB_TERM_NUM_ENTRIES - 1);
 419                   offset = GRUB_TERM_NUM_ENTRIES - 1;
 420                 }
 421                 print_entries (menu, first, offset);
 422               break;
 423
 424             case GRUB_TERM_UP:
 425             case '^':
 426               if (offset > 0)
 427                 {
 428                   print_entry (GRUB_TERM_FIRST_ENTRY_Y + offset, 0,
 429                                get_entry (menu, first + offset));
 430                   offset--;
 431                   print_entry (GRUB_TERM_FIRST_ENTRY_Y + offset, 1,
 432                                get_entry (menu, first + offset));
 433                 }
 434               else if (first > 0)
 435                 {
 436                   first--;
 437                   print_entries (menu, first, offset);
 438                 }
 439               break;
 440
 441             case GRUB_TERM_DOWN:
 442             case 'v':
 443               if (menu->size > first + offset + 1)
 444                 {
 445                   if (offset < GRUB_TERM_NUM_ENTRIES - 1)
 446                     {
 447                       print_entry (GRUB_TERM_FIRST_ENTRY_Y + offset, 0,
 448                                    get_entry (menu, first + offset));
 449                       offset++;
 450                       print_entry (GRUB_TERM_FIRST_ENTRY_Y + offset, 1,
 451                                    get_entry (menu, first + offset));
 452                     }
 453                   else
 454                     {
 455                       first++;
 456                       print_entries (menu, first, offset);
 457                     }
 458                 }
 459               break;
 460
 461             case GRUB_TERM_PPAGE:
 462               if (first == 0)
 463                 {
 464                   offset = 0;
 465                 }
 466               else
 467                 {
 468                   first -= GRUB_TERM_NUM_ENTRIES;
 469
 470                   if (first < 0)
 471                     {
 472                       offset += first;
 473                       first = 0;
 474                     }
 475                 }
 476               print_entries (menu, first, offset);
 477               break;
 478
 479             case GRUB_TERM_NPAGE:
 480               if (offset == 0)
 481                 {
 482                   offset += GRUB_TERM_NUM_ENTRIES - 1;
 483                   if (first + offset >= menu->size)
 484                     {
 485                       offset = menu->size - first - 1;
 486                     }
 487                 }
 488               else
 489                 {
 490                   first += GRUB_TERM_NUM_ENTRIES;
 491
 492                   if (first + offset >= menu->size)
 493                     {
 494                       first -= GRUB_TERM_NUM_ENTRIES;
 495                       offset += GRUB_TERM_NUM_ENTRIES;
 496
 497                       if (offset > menu->size - 1 ||
 498                                      offset > GRUB_TERM_NUM_ENTRIES - 1)
 499                         {
 500                           offset = menu->size - first - 1;
 501                         }
 502                       if (offset > GRUB_TERM_NUM_ENTRIES)
 503                         {
 504                           first += offset - GRUB_TERM_NUM_ENTRIES + 1;
 505                           offset = GRUB_TERM_NUM_ENTRIES - 1;
 506                         }
 507                     }
 508                 }
 509               print_entries (menu, first, offset);
 510               break;
 511
 512             case '\n':
 513             case '\r':
 514             case 6:
 515               grub_setcursor (1);
 516               return first + offset;
 517
 518             case '\e':
 519               if (nested)
 520                 {
 521                   grub_setcursor (1);
 522                   return -1;
 523                 }
 524               break;
 525
 526             case 'c':
 527               grub_cmdline_run (1);
 528               goto refresh;
 529
 530             case 'e':
 531                 {
 532                   grub_menu_entry_t e = get_entry (menu, first + offset);
 533                   if (e)
 534                     grub_menu_entry_run (e);
 535                 }
 536               goto refresh;
 537
 538             default:
 539               break;
 540             }
 541
 542           grub_refresh ();
 543         }
 544     }
 545
 546   /* Never reach here.  */
 547   return -1;
 548 }
 549
 550 /* Run a menu entry.  */
 551 static void
 552 run_menu_entry (grub_menu_entry_t entry)
 553 {
 554   grub_script_execute (entry->commands);
 555
 556   if (grub_errno == GRUB_ERR_NONE && grub_loader_is_loaded ())
 557     /* Implicit execution of boot, only if something is loaded.  */
 558     grub_command_execute ("boot", 0);
 559 }
 560
 561 void
 562 grub_menu_run (grub_menu_t menu, int nested)
 563 {
 564   while (1)
 565     {
 566       int boot_entry;
 567       grub_menu_entry_t e;
 568       int fallback_entry;
 569
 570       boot_entry = run_menu (menu, nested);
 571       if (boot_entry < 0)
 572         break;
 573
 574       e = get_entry (menu, boot_entry);
 575       if (! e)
 576         continue; /* Menu is empty.  */
 577
 578       grub_cls ();
 579       grub_setcursor (1);
 580
 581       grub_printf ("  Booting \'%s\'\n\n", e->title);
 582
 583       run_menu_entry (e);
 584
 585       /* Deal with a fallback entry.  */
 586       /* FIXME: Multiple fallback entries like GRUB Legacy.  */
 587       fallback_entry = get_entry_number ("fallback");
 588       if (fallback_entry >= 0)
 589         {
 590           grub_print_error ();
 591           grub_errno = GRUB_ERR_NONE;
 592
 593           e = get_entry (menu, fallback_entry);
 594           grub_env_unset ("fallback");
 595           grub_printf ("\n  Falling back to \'%s\'\n\n", e->title);
 596           run_menu_entry (e);
 597         }
 598
 599       if (grub_errno != GRUB_ERR_NONE)
 600         {
 601           grub_print_error ();
 602           grub_errno = GRUB_ERR_NONE;
 603
 604           grub_wait_after_message ();
 605         }
 606     }
 607 }