2 * Copyright (C) 2009 Sony Computer Entertainment Inc.
3 * Copyright 2009 Sony Corp.
5 * This program 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; version 2 of the License.
9 * This program is distributed in the hope that it will be useful,
10 * but WITHOUT ANY WARRANTY; without even the implied warranty of
11 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12 * GNU General Public License for more details.
14 * You should have received a copy of the GNU General Public License
15 * along with this program; if not, write to the Free Software
16 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
19 #if defined(HAVE_CONFIG_H)
29 #include <sys/ioctl.h>
30 #include <sys/reboot.h>
33 #include "pb-protocol/pb-protocol.h"
34 #include "talloc/talloc.h"
35 #include "waiter/waiter.h"
36 #include "process/process.h"
37 #include "i18n/i18n.h"
38 #include "ui/common/discover-client.h"
39 #include "ui/common/ui-system.h"
41 #include "nc-boot-editor.h"
42 #include "nc-config.h"
43 #include "nc-add-url.h"
44 #include "nc-sysinfo.h"
46 #include "nc-helpscreen.h"
47 #include "nc-statuslog.h"
48 #include "nc-subset.h"
49 #include "nc-plugin.h"
50 #include "console-codes.h"
52 extern const struct help_text main_menu_help_text;
53 extern const struct help_text plugin_menu_help_text;
55 static bool cui_detached = false;
57 static struct pmenu *main_menu_init(struct cui *cui);
58 static struct pmenu *plugin_menu_init(struct cui *cui);
60 static void cui_cancel_autoboot_on_exit(struct cui *cui);
64 struct autoboot_option opt;
65 } autoboot_override_keys[] = {
67 .boot_type = BOOT_DEVICE_TYPE,
68 .type = DEVICE_TYPE_DISK,
72 .boot_type = BOOT_DEVICE_TYPE,
73 .type = DEVICE_TYPE_USB,
77 .boot_type = BOOT_DEVICE_TYPE,
78 .type = DEVICE_TYPE_NETWORK,
83 static bool lockdown_active(void)
85 #if defined(SIGNED_BOOT) && defined(HARD_LOCKDOWN)
88 bool lockdown = false;
89 if (access(LOCKDOWN_FILE, F_OK) != -1)
95 static void cui_set_curses_options(bool curses_mode)
98 cbreak(); /* Disable line buffering. */
99 noecho(); /* Disable getch() echo. */
100 nonl(); /* Disable new-line translation. */
101 intrflush(stdscr, FALSE); /* Disable interrupt flush. */
102 curs_set(0); /* Make cursor invisible */
103 nodelay(stdscr, TRUE); /* Enable non-blocking getch() */
105 nocbreak(); /* Enable line buffering. */
106 echo(); /* Enable getch() echo. */
107 nl(); /* Enable new-line translation. */
108 intrflush(stdscr, TRUE); /* Enable interrupt flush. */
109 curs_set(1); /* Make cursor visible */
110 nodelay(stdscr, FALSE); /* Disable non-blocking getch() */
114 static void cui_start(void)
116 initscr(); /* Initialize ncurses. */
117 keypad(stdscr, TRUE); /* Enable num keypad keys. */
118 cui_set_curses_options(true);
120 /* We may be operating with an incorrect $TERM type; in this case
121 * the keymappings will be slightly broken. We want at least
122 * backspace to work though, so we'll define both DEL and ^H to
123 * map to backspace */
124 define_key("\x7f", KEY_BACKSPACE);
125 define_key("\x08", KEY_BACKSPACE);
127 /* we need backtab too, for form navigation. vt220 doesn't include
128 * this (kcbt), but we don't want to require a full linux/xterm termcap
130 define_key("\x1b[Z", KEY_BTAB);
132 /* We'll define a few other keys too since they're commonly
133 * used for navigation but the escape character will cause
134 * Petitboot to exit if they're left undefined */
135 define_key("\x1b\x5b\x35\x7e", KEY_PPAGE);
136 define_key("\x1b\x5b\x36\x7e", KEY_NPAGE);
137 define_key("\x1b\x5b\x31\x7e", KEY_HOME);
138 define_key("\x1b\x5b\x34\x7e", KEY_END);
139 define_key("\x1b\x4f\x48", KEY_HOME);
140 define_key("\x1b\x4f\x46", KEY_END);
141 define_key("OH", KEY_HOME);
142 define_key("OF", KEY_END);
144 /* Arrow keys in normal cursor mode */
145 define_key("\x1b\x5b\x41", KEY_UP);
146 define_key("\x1b\x5b\x42", KEY_DOWN);
147 define_key("\x1b\x5b\x43", KEY_RIGHT);
148 define_key("\x1b\x5b\x44", KEY_LEFT);
149 /* Arrow keys in "application" cursor mode */
150 define_key("\x1b\x4f\x41", KEY_UP);
151 define_key("\x1b\x4f\x42", KEY_DOWN);
152 define_key("\x1b\x4f\x43", KEY_RIGHT);
153 define_key("\x1b\x4f\x44", KEY_LEFT);
155 define_key("\x1b\x5b\x33\x7e", KEY_DC);
157 while (getch() != ERR) /* flush stdin */
161 static void cui_atexit(void)
170 bool lockdown = lockdown_active();
179 * cui_abort - Signal the main cui program loop to exit.
181 * Sets cui.abort, which causes the cui_run() routine to return.
184 void cui_abort(struct cui *cui)
186 pb_log_fn("exiting\n");
191 * cui_resize - Signal the main cui program loop to resize
193 * Called at SIGWINCH.
196 void cui_resize(struct cui *cui)
198 pb_debug("%s: resizing\n", __func__);
203 * cui_on_exit - A generic main menu exit callback.
206 void cui_on_exit(struct pmenu *menu)
208 struct cui *cui = cui_from_pmenu(menu);
210 cui_cancel_autoboot_on_exit(cui);
212 const char *argv[] = {
217 cui_run_cmd(cui, argv);
219 nc_scr_status_printf(cui->current, _("Returned from shell"));
223 * cui_abort_on_exit - Force an exit of the main loop on menu exit.
224 * This is mainly for lockdown situations where
225 * the exit then triggers an expected reboot.
227 void cui_abort_on_exit(struct pmenu *menu)
229 struct cui *cui = cui_from_pmenu(menu);
234 * cui_run_cmd - A generic cb to run the supplied command.
237 int cui_run_cmd(struct cui *cui, const char **cmd_argv)
239 struct process *process;
242 process = process_create(cui);
246 process->path = cmd_argv[0];
247 process->argv = cmd_argv;
248 process->raw_stdout = true;
250 nc_scr_status_printf(cui->current, _("Running %s..."), cmd_argv[0]);
257 result = process_run_sync(process);
262 redrawwin(cui->current->main_ncw);
263 nc_scr_post(cui->current);
266 pb_log_fn("failed: '%s'\n", cmd_argv[0]);
267 nc_scr_status_printf(cui->current, _("Failed: %s"),
271 process_release(process);
276 int cui_run_cmd_from_item(struct pmenu_item *item)
278 struct cui *cui = cui_from_item(item);
279 const char **cmd_argv = item->data;
281 return cui_run_cmd(cui, cmd_argv);
285 * cui_boot - A generic cb to run kexec.
288 static int cui_boot(struct pmenu_item *item)
291 struct cui *cui = cui_from_item(item);
292 struct cui_opt_data *cod = cod_from_item(item);
294 assert(cui->current == &cui->main->scr);
296 pb_debug("%s: %s\n", __func__, cod->name);
298 nc_scr_status_printf(cui->current, _("Booting %s..."), cod->name);
300 result = discover_client_boot(cui->client, NULL, cod->opt, cod->bd);
303 nc_scr_status_printf(cui->current,
304 _("Failed: boot %s"), cod->bd->image);
310 static int menu_sysinfo_execute(struct pmenu_item *item)
312 cui_show_sysinfo(cui_from_item(item));
316 static int menu_config_execute(struct pmenu_item *item)
318 cui_show_config(cui_from_item(item));
322 static int menu_lang_execute(struct pmenu_item *item)
324 cui_show_lang(cui_from_item(item));
328 static int menu_statuslog_execute(struct pmenu_item *item)
330 cui_show_statuslog(cui_from_item(item));
334 static int menu_reinit_execute(struct pmenu_item *item)
336 if (cui_from_item(item)->client)
337 cui_send_reinit(cui_from_item(item));
341 static int menu_add_url_execute(struct pmenu_item *item)
343 if (cui_from_item(item)->client)
344 cui_show_add_url(cui_from_item(item));
348 static int menu_plugin_execute(struct pmenu_item *item)
350 if (cui_from_item(item)->client)
351 cui_show_plugin_menu(cui_from_item(item));
355 static void cui_boot_editor_on_exit(struct cui *cui,
356 struct pmenu_item *item,
357 struct pb_boot_data *bd)
359 struct pmenu *menu = cui->main;
360 struct cui_opt_data *cod;
361 int idx, top, rows, cols;
362 static int user_idx = 0;
364 /* Was the edit cancelled? */
366 cui_set_current(cui, &cui->main->scr);
367 talloc_free(cui->boot_editor);
368 cui->boot_editor = NULL;
372 /* Is this was a new item, we'll need to update the menu */
376 cod = talloc_zero(NULL, struct cui_opt_data);
377 cod->name = talloc_asprintf(cod, _("User item %u"), ++user_idx);
379 item = pmenu_item_create(menu, cod->name);
385 item->on_edit = cui_item_edit;
386 item->on_execute = cui_boot;
389 talloc_steal(item, cod);
391 /* Detach the items array. */
392 set_menu_items(menu->ncm, NULL);
394 /* Insert new item at insert_pt. */
395 insert_pt = pmenu_grow(menu, 1);
396 pmenu_item_insert(menu, item, insert_pt);
398 /* Re-attach the items array. */
399 set_menu_items(menu->ncm, menu->items);
401 /* If our index is above the current top row, align
402 * us to the new top. Otherwise, align us to the new
404 menu_format(cui->main->ncm, &rows, &cols);
405 top = top_row(cui->main->ncm);
406 idx = item_index(item->nci);
411 top = idx < rows ? 0 : idx - rows + 1;
413 set_top_row(cui->main->ncm, top);
414 set_current_item(item->pmenu->ncm, item->nci);
416 nc_scr_post(&menu->scr);
421 cod->bd = talloc_steal(cod, bd);
424 cui_set_current(cui, &cui->main->scr);
425 talloc_free(cui->boot_editor);
426 cui->boot_editor = NULL;
429 void cui_item_edit(struct pmenu_item *item)
431 struct cui *cui = cui_from_item(item);
432 cui->boot_editor = boot_editor_init(cui, item, cui->sysinfo,
433 cui_boot_editor_on_exit);
434 cui_set_current(cui, boot_editor_scr(cui->boot_editor));
437 void cui_item_new(struct pmenu *menu)
439 struct cui *cui = cui_from_pmenu(menu);
440 cui->boot_editor = boot_editor_init(cui, NULL, cui->sysinfo,
441 cui_boot_editor_on_exit);
442 cui_set_current(cui, boot_editor_scr(cui->boot_editor));
445 static void cui_sysinfo_exit(struct cui *cui)
447 cui_set_current(cui, &cui->main->scr);
448 talloc_free(cui->sysinfo_screen);
449 cui->sysinfo_screen = NULL;
452 void cui_show_sysinfo(struct cui *cui)
454 cui->sysinfo_screen = sysinfo_screen_init(cui, cui->sysinfo,
456 cui_set_current(cui, sysinfo_screen_scr(cui->sysinfo_screen));
459 static void cui_config_exit(struct cui *cui)
461 cui_set_current(cui, &cui->main->scr);
462 talloc_free(cui->config_screen);
463 cui->config_screen = NULL;
466 void cui_show_config(struct cui *cui)
468 cui->config_screen = config_screen_init(cui, cui->config,
469 cui->sysinfo, cui_config_exit);
470 cui_set_current(cui, config_screen_scr(cui->config_screen));
473 static void cui_lang_exit(struct cui *cui)
475 cui_set_current(cui, &cui->main->scr);
476 talloc_free(cui->lang_screen);
477 cui->lang_screen = NULL;
480 void cui_show_lang(struct cui *cui)
482 cui->lang_screen = lang_screen_init(cui, cui->config, cui_lang_exit);
483 cui_set_current(cui, lang_screen_scr(cui->lang_screen));
486 static void cui_statuslog_exit(struct cui *cui)
488 cui_set_current(cui, &cui->main->scr);
489 talloc_free(cui->statuslog_screen);
490 cui->statuslog_screen = NULL;
493 void cui_show_statuslog(struct cui *cui)
495 cui->statuslog_screen = statuslog_screen_init(cui, cui_statuslog_exit);
496 cui_set_current(cui, statuslog_screen_scr(cui->statuslog_screen));
499 static void cui_add_url_exit(struct cui *cui)
501 cui_set_current(cui, &cui->main->scr);
502 talloc_free(cui->add_url_screen);
503 cui->add_url_screen = NULL;
506 static void cui_plugin_exit(struct cui *cui)
508 cui_set_current(cui, &cui->plugin_menu->scr);
509 talloc_free(cui->plugin_screen);
510 cui->plugin_screen = NULL;
513 static void cui_plugin_menu_exit(struct pmenu *menu)
515 struct cui *cui = cui_from_pmenu(menu);
516 cui_set_current(cui, &cui->main->scr);
519 void cui_show_add_url(struct cui *cui)
521 cui->add_url_screen = add_url_screen_init(cui, cui_add_url_exit);
522 cui_set_current(cui, add_url_screen_scr(cui->add_url_screen));
525 void cui_show_plugin_menu(struct cui *cui)
527 cui_set_current(cui, &cui->plugin_menu->scr);
530 void cui_show_plugin(struct pmenu_item *item)
532 struct cui *cui = cui_from_item(item);
533 cui->plugin_screen = plugin_screen_init(cui, item, cui_plugin_exit);
534 cui_set_current(cui, plugin_screen_scr(cui->plugin_screen));
537 static void cui_help_exit(struct cui *cui)
539 cui_set_current(cui, help_screen_return_scr(cui->help_screen));
540 talloc_free(cui->help_screen);
541 cui->help_screen = NULL;
544 void cui_show_help(struct cui *cui, const char *title,
545 const struct help_text *text)
550 if (cui->help_screen)
553 cui->help_screen = help_screen_init(cui, cui->current,
554 title, text, cui_help_exit);
556 if (cui->help_screen)
557 cui_set_current(cui, help_screen_scr(cui->help_screen));
560 static void cui_subset_exit(struct cui *cui)
562 cui_set_current(cui, subset_screen_return_scr(cui->subset_screen));
563 talloc_free(cui->subset_screen);
564 cui->subset_screen = NULL;
567 void cui_show_subset(struct cui *cui, const char *title,
573 if (cui->subset_screen)
576 cui->subset_screen = subset_screen_init(cui, cui->current,
577 title, arg, cui_subset_exit);
579 if (cui->subset_screen)
580 cui_set_current(cui, subset_screen_scr(cui->subset_screen));
584 * cui_set_current - Set the currently active screen and redraw it.
587 struct nc_scr *cui_set_current(struct cui *cui, struct nc_scr *scr)
591 DBGS("%p -> %p\n", cui->current, scr);
593 assert(cui->current != scr);
600 nc_scr_post(cui->current);
605 static bool set_temp_autoboot_opt(struct cui *cui, struct autoboot_option *opt)
607 cui->autoboot_opt = opt;
609 discover_client_send_temp_autoboot(cui->client, opt);
614 static bool key_cancels_boot(int key)
621 for (i = 0; i < ARRAY_SIZE(autoboot_override_keys); i++)
622 if (key == autoboot_override_keys[i].key)
628 static bool process_global_keys(struct cui *cui, int key)
634 if (cui->current && cui->current->main_ncw)
639 /* check for autoboot override keys */
640 for (i = 0; i < ARRAY_SIZE(autoboot_override_keys); i++) {
641 if (key != autoboot_override_keys[i].key)
644 pb_log("Sending temporary autoboot override\n");
645 set_temp_autoboot_opt(cui, &autoboot_override_keys[i].opt);
653 * cui_process_key - Process input on stdin.
656 static int cui_process_key(void *arg)
658 struct cui *cui = cui_from_arg(arg);
663 assert(cui->current);
668 pb_debug("%s: got key %d\n", __func__, c);
675 * If this is a console code sequence try to parse it
676 * and don't treat this as a key press.
679 if (grab != ERR && grab != 27) {
681 pb_debug("%s: Caught unhandled command sequence\n",
683 sequence = handle_control_sequence(cui, c);
684 pb_debug("Caught sequence ");
686 pb_debug("(%zu): ", strlen(sequence));
687 for (i = 0; i < strlen(sequence); i++)
688 pb_debug("0%o ", sequence[i]);
691 pb_debug("(0): (none)\n");
696 if (cui->preboot_mode) {
697 /* Turn curses options back on if the user interacts */
698 cui->preboot_mode = false;
699 cui_set_curses_options(true);
702 if (!cui->has_input && key_cancels_boot(c)) {
703 cui->has_input = true;
705 pb_log("UI input received (key = %d), aborting "
706 "default boot\n", c);
707 discover_client_cancel_default(cui->client);
709 pb_log("UI input received (key = %d), aborting "
710 "once server connects\n", c);
714 if (process_global_keys(cui, c))
717 cui->current->process_key(cui->current, c);
724 * cui_process_js - Process joystick events.
727 static int cui_process_js(void *arg)
729 struct cui *cui = cui_from_arg(arg);
732 c = pjs_process_event(cui->pjs);
736 cui_process_key(arg);
743 * cui_handle_resize - Handle the term resize.
746 static void cui_handle_resize(struct cui *cui)
750 if (ioctl(1, TIOCGWINSZ, &ws) == -1) {
751 pb_log_fn("ioctl failed: %s\n", strerror(errno));
755 pb_debug("%s: {%u,%u}\n", __func__, ws.ws_row, ws.ws_col);
757 wclear(cui->current->main_ncw);
758 resize_term(ws.ws_row, ws.ws_col);
759 cui->current->resize(cui->current);
761 /* For some reason this makes ncurses redraw the screen */
763 redrawwin(cui->current->main_ncw);
764 wrefresh(cui->current->main_ncw);
768 * cui_device_add - Client device_add callback.
770 * Creates menu_items for all the device boot_options and inserts those
771 * menu_items into the main menu. Redraws the main menu if it is active.
772 * If a 'plugin' type boot_option appears the plugin menu is updated instead.
775 static int cui_boot_option_add(struct device *dev, struct boot_option *opt,
778 struct pmenu_item *i, *dev_hdr = NULL;
779 struct cui *cui = cui_from_arg(arg);
780 struct cui_opt_data *cod;
781 const char *tab = " ";
782 unsigned int insert_pt;
783 int result, rows, cols;
789 plugin_option = opt->type == DISCOVER_PLUGIN_OPTION;
790 menu = plugin_option ? cui->plugin_menu : cui->main;
792 pb_debug("%s: %p %s\n", __func__, opt, opt->id);
794 selected = current_item(menu->ncm);
795 menu_format(menu->ncm, &rows, &cols);
797 if (cui->current == &cui->main->scr)
798 nc_scr_unpost(cui->current);
799 if (plugin_option && cui->current == &cui->plugin_menu->scr)
800 nc_scr_unpost(cui->current);
802 /* Check if the boot device is new */
803 dev_hdr = pmenu_find_device(menu, dev, opt);
805 /* All actual boot entries are 'tabbed' across */
806 name = talloc_asprintf(menu, "%s%s",
807 tab, opt->name ? : "Unknown Name");
809 /* Save the item in opt->ui_info for cui_device_remove() */
810 opt->ui_info = i = pmenu_item_create(menu, name);
817 i->on_execute = plugin_install_plugin;
819 i->on_edit = cui_item_edit;
820 i->on_execute = cui_boot;
823 i->data = cod = talloc(i, struct cui_opt_data);
826 cod->opt_hash = pb_opt_hash(dev, opt);
827 cod->name = opt->name;
830 cod->pd = talloc(i, struct pb_plugin_data);
831 cod->pd->plugin_file = talloc_strdup(cod,
832 opt->boot_image_file);
834 cod->bd = talloc(i, struct pb_boot_data);
835 cod->bd->image = talloc_strdup(cod->bd, opt->boot_image_file);
836 cod->bd->initrd = talloc_strdup(cod->bd, opt->initrd_file);
837 cod->bd->dtb = talloc_strdup(cod->bd, opt->dtb_file);
838 cod->bd->args = talloc_strdup(cod->bd, opt->boot_args);
839 cod->bd->args_sig_file = talloc_strdup(cod->bd, opt->args_sig_file);
842 /* This disconnects items array from menu. */
843 result = set_menu_items(menu->ncm, NULL);
846 pb_log_fn("set_menu_items failed: %d\n", result);
848 /* Insert new items at insert_pt. */
850 insert_pt = pmenu_grow(menu, 2);
851 pmenu_item_insert(menu, dev_hdr, insert_pt);
852 pb_log("%s: adding new device hierarchy %s\n",
853 __func__, opt->device_id);
854 pmenu_item_insert(menu, i, insert_pt+1);
856 insert_pt = pmenu_grow(menu, 1);
857 pmenu_item_add(menu, i, insert_pt);
861 pb_log_fn("adding plugin '%s'\n", cod->name);
862 pb_log(" file '%s'\n", cod->pd->plugin_file);
864 pb_log_fn("adding opt '%s'\n", cod->name);
865 pb_log(" image '%s'\n", cod->bd->image);
866 pb_log(" initrd '%s'\n", cod->bd->initrd);
867 pb_log(" args '%s'\n", cod->bd->args);
868 pb_log(" argsig '%s'\n", cod->bd->args_sig_file);
871 /* Update the plugin menu label if needed */
873 struct pmenu_item *item;
875 result = set_menu_items(cui->main->ncm, NULL);
876 for (j = 0 ; j < cui->main->item_count; j++) {
877 item = item_userptr(cui->main->items[j]);
878 if (item->on_execute != menu_plugin_execute)
881 char *label = talloc_asprintf(item, _("Plugins (%u)"),
883 pmenu_item_update(item, label);
887 result = set_menu_items(cui->main->ncm, cui->main->items);
889 pb_log_fn("set_menu_items failed: %d\n", result);
892 /* Re-attach the items array. */
893 result = set_menu_items(menu->ncm, menu->items);
896 pb_log_fn("set_menu_items failed: %d\n", result);
899 pb_log("%s\n", __func__);
900 pmenu_dump_items(menu->items,
901 item_count(menu->ncm) + 1);
904 if (!item_visible(selected)) {
907 top = top_row(menu->ncm);
908 idx = item_index(selected);
910 /* If our index is above the current top row, align
911 * us to the new top. Otherwise, align us to the new
913 top = top < idx ? idx - rows + 1 : idx;
915 set_top_row(menu->ncm, top);
916 set_current_item(menu->ncm, selected);
919 if (cui->current == &menu->scr)
920 nc_scr_post(cui->current);
921 if (plugin_option && cui->current == &cui->main->scr)
922 nc_scr_post(cui->current);
928 * cui_device_remove - Client device remove callback.
930 * Removes all the menu_items for the device from the main menu and redraws the
931 * main menu if it is active.
933 static void cui_device_remove(struct device *dev, void *arg)
935 struct cui *cui = cui_from_arg(arg);
936 struct boot_option *opt;
938 int rows, cols, top, last;
941 pb_log_fn("%p %s\n", dev, dev->id);
943 if (cui->current == &cui->main->scr)
944 nc_scr_unpost(cui->current);
945 if (cui->current == &cui->plugin_menu->scr)
946 nc_scr_unpost(cui->current);
948 /* This disconnects items array from menu. */
950 result = set_menu_items(cui->main->ncm, NULL);
951 result |= set_menu_items(cui->plugin_menu->ncm, NULL);
954 pb_log_fn("set_menu_items failed: %d\n", result);
956 list_for_each_entry(&dev->boot_options, opt, list) {
957 struct pmenu_item *item = pmenu_item_from_arg(opt->ui_info);
959 assert(pb_protocol_device_cmp(dev, cod_from_item(item)->dev));
960 if (opt->type == DISCOVER_PLUGIN_OPTION)
961 pmenu_remove(cui->plugin_menu, item);
963 pmenu_remove(cui->main, item);
966 /* Manually remove remaining device hierarchy item */
967 for (i=0; i < cui->main->item_count; i++) {
968 struct pmenu_item *item = item_userptr(cui->main->items[i]);
969 if (!item || !item->data )
972 struct cui_opt_data *data = item->data;
973 if (data && data->dev && data->dev == dev)
974 pmenu_remove(cui->main,item);
976 /* Look in plugins menu too */
977 for (i=0; i < cui->plugin_menu->item_count; i++) {
978 struct pmenu_item *item = item_userptr(cui->plugin_menu->items[i]);
979 if (!item || !item->data )
982 struct cui_opt_data *data = item->data;
983 if (data && data->dev && data->dev == dev)
984 pmenu_remove(cui->plugin_menu,item);
987 /* Re-attach the items array. */
989 result = set_menu_items(cui->main->ncm, cui->main->items);
990 result |= set_menu_items(cui->plugin_menu->ncm, cui->plugin_menu->items);
992 /* Move cursor to 'Exit' menu entry for the main menu.. */
993 menu_format(cui->main->ncm, &rows, &cols);
994 last = cui->main->item_count - 1;
995 set_current_item(cui->main->ncm, cui->main->items[last]);
996 if (!item_visible(cui->main->items[last])) {
997 top = last < rows ? 0 : last - rows + 1;
998 set_top_row(cui->main->ncm, top);
1001 /* ..and the plugin menu */
1002 menu_format(cui->plugin_menu->ncm, &rows, &cols);
1003 last = cui->plugin_menu->item_count - 1;
1004 set_current_item(cui->plugin_menu->ncm, cui->plugin_menu->items[last]);
1005 if (!item_visible(cui->plugin_menu->items[last])) {
1006 top = last < rows ? 0 : last - rows + 1;
1007 set_top_row(cui->plugin_menu->ncm, top);
1011 pb_log_fn("set_menu_items failed: %d\n", result);
1014 pb_log("%s\n", __func__);
1015 pmenu_dump_items(cui->main->items,
1016 item_count(cui->main->ncm) + 1);
1019 if (cui->current == &cui->main->scr)
1020 nc_scr_post(cui->current);
1021 if (cui->current == &cui->plugin_menu->scr)
1022 nc_scr_post(cui->current);
1025 static void cui_update_status(struct status *status, void *arg)
1027 struct cui *cui = cui_from_arg(arg);
1029 statuslog_append_steal(cui, cui->statuslog, status);
1031 /* Ignore status messages from the backlog */
1032 if (status->backlog)
1035 nc_scr_status_printf(cui->current, "%s", status->message);
1037 if (cui->preboot_mode &&
1038 (!status->boot_active || status->type == STATUS_ERROR)) {
1039 cui_set_curses_options(true);
1040 cui->preboot_mode = false;
1042 cui->preboot_mode = status->boot_active &&
1043 status->type == STATUS_INFO;
1044 if (cui->preboot_mode)
1045 cui_set_curses_options(false);
1050 * Handle a new installed plugin option and update its associated
1051 * (uninstalled) menu item if it exists.
1053 static int cui_plugin_option_add(struct plugin_option *opt, void *arg)
1055 struct cui_opt_data *cod;
1056 struct cui *cui = cui_from_arg(arg);
1057 struct pmenu_item *item = NULL;
1058 struct boot_option *dummy_opt;
1064 /* Find uninstalled plugin by matching on plugin_file */
1065 for (i = 0; i < cui->plugin_menu->item_count; i++) {
1066 item = item_userptr(cui->plugin_menu->items[i]);
1069 cod = cod_from_item(item);
1070 if (!cod || !cod->pd)
1072 if (strncmp(cod->pd->plugin_file, opt->plugin_file,
1073 strlen(cod->pd->plugin_file)) == 0)
1078 * If pb-plugin was run manually there may not be an associated
1079 * plugin-type boot_option. Pass a fake device and option to
1080 * cui_boot_option_add() so we have an item to work with.
1082 if (!item || i >= cui->plugin_menu->item_count) {
1083 pb_log("New plugin option %s doesn't have a source item\n",
1085 dev = talloc_zero(cui, struct device);
1086 dev->id = dev->name = talloc_asprintf(dev, "(unknown)");
1087 dev->type = DEVICE_TYPE_UNKNOWN;
1088 dummy_opt = talloc_zero(cui, struct boot_option);
1089 dummy_opt->device_id = talloc_strdup(dummy_opt, dev->id);
1090 dummy_opt->id = dummy_opt->name = talloc_asprintf(dummy_opt, "dummy");
1091 dummy_opt->boot_image_file = talloc_strdup(dummy_opt, opt->plugin_file);
1092 dummy_opt->type = DISCOVER_PLUGIN_OPTION;
1093 cui_boot_option_add(dev, dummy_opt, cui);
1098 * If this option was faked above move the context under
1099 * the item so it is cleaned up later in cui_plugins_remove().
1101 if (strcmp(cod->opt->id, "dummy") == 0 &&
1102 cod->dev->type == DEVICE_TYPE_UNKNOWN) {
1103 talloc_steal(item, cod->dev);
1104 talloc_steal(item, cod->opt);
1107 talloc_free(cod->name);
1108 /* Name is still tabbed across */
1109 cod->name = talloc_asprintf(cod, _(" %s [installed]"), opt->name);
1112 item->on_execute = NULL;
1113 item->on_edit = cui_show_plugin;
1115 if (cui->current == &cui->plugin_menu->scr)
1116 nc_scr_unpost(cui->current);
1118 /* This disconnects items array from menu. */
1119 result = set_menu_items(cui->plugin_menu->ncm, NULL);
1122 pmenu_item_update(item, cod->name);
1124 /* Re-attach the items array. */
1125 result = set_menu_items(cui->plugin_menu->ncm, cui->plugin_menu->items);
1127 if (cui->current == &cui->plugin_menu->scr)
1128 nc_scr_post(cui->current);
1134 * Most plugin menu items will be removed via cui_device_remove(). However if
1135 * pb-plugin has been run manually it is possible that there a plugin items
1136 * not associated with a device - remove them here.
1138 static int cui_plugins_remove(void *arg)
1140 struct cui *cui = cui_from_arg(arg);
1141 struct pmenu_item *item = NULL;
1142 struct cui_opt_data *cod;
1145 pb_debug("%s\n", __func__);
1147 if (cui->current == &cui->plugin_menu->scr)
1148 nc_scr_unpost(cui->current);
1149 if (cui->current == &cui->main->scr)
1150 nc_scr_unpost(cui->current);
1152 /* This disconnects items array from menu. */
1153 set_menu_items(cui->plugin_menu->ncm, NULL);
1155 while (i < cui->plugin_menu->item_count) {
1156 item = item_userptr(cui->plugin_menu->items[i]);
1157 if (!item || !item->data) {
1161 cod = cod_from_item(item);
1162 if (!cod->opt && !cod->dev) {
1167 pmenu_remove(cui->plugin_menu, item);
1168 /* plugin_menu entries will shift, jump to bottom to make sure
1169 * we remove all plugin option items */
1173 /* Re-attach the items array. */
1174 set_menu_items(cui->plugin_menu->ncm, cui->plugin_menu->items);
1176 set_menu_items(cui->main->ncm, NULL);
1177 for (i = 0; i < cui->main->item_count; i++) {
1178 item = item_userptr(cui->main->items[i]);
1179 if (item->on_execute != menu_plugin_execute)
1182 pmenu_item_update(item, _("Plugins (0)"));
1186 set_menu_items(cui->main->ncm, cui->main->items);
1188 if (cui->current == &cui->main->scr)
1189 nc_scr_post(cui->current);
1191 /* If we're currently in a plugin screen jump back to the plugin menu */
1192 if (cui->plugin_screen &&
1193 cui->current == plugin_screen_scr(cui->plugin_screen))
1194 cui_plugin_exit(cui);
1199 static void cui_update_mm_title(struct cui *cui)
1201 struct nc_frame *frame = &cui->main->scr.frame;
1203 talloc_free(frame->rtitle);
1205 frame->rtitle = talloc_strdup(cui->main, cui->sysinfo->type);
1206 if (cui->sysinfo->identifier)
1207 frame->rtitle = talloc_asprintf_append(frame->rtitle,
1208 " %s", cui->sysinfo->identifier);
1210 if (cui->current == &cui->main->scr)
1211 nc_scr_post(cui->current);
1213 frame = &cui->plugin_menu->scr.frame;
1215 talloc_free(frame->rtitle);
1217 frame->rtitle = talloc_strdup(cui->main, cui->sysinfo->type);
1218 if (cui->sysinfo->identifier)
1219 frame->rtitle = talloc_asprintf_append(frame->rtitle,
1220 " %s", cui->sysinfo->identifier);
1222 if (cui->current == &cui->main->scr)
1223 nc_scr_post(cui->current);
1226 static void cui_update_sysinfo(struct system_info *sysinfo, void *arg)
1228 struct cui *cui = cui_from_arg(arg);
1229 cui->sysinfo = talloc_steal(cui, sysinfo);
1231 /* if we're currently displaying the system info screen, inform it
1232 * of the updated information. */
1233 if (cui->sysinfo_screen)
1234 sysinfo_screen_update(cui->sysinfo_screen, sysinfo);
1236 if (cui->subset_screen)
1237 subset_screen_update(cui->subset_screen);
1239 /* ... and do the same with the config screen... */
1240 if (cui->config_screen)
1241 config_screen_update(cui->config_screen, cui->config, sysinfo);
1243 /* ... and the boot editor. */
1244 if (cui->boot_editor)
1245 boot_editor_update(cui->boot_editor, sysinfo);
1247 cui_update_mm_title(cui);
1250 static void cui_update_language(struct cui *cui, char *lang)
1255 cur_lang = setlocale(LC_ALL, NULL);
1256 if (cur_lang && !strcmp(cur_lang, lang))
1259 setlocale(LC_ALL, lang);
1261 /* we'll need to update the menu: drop all items and repopulate */
1262 repost_menu = cui->current == &cui->main->scr ||
1263 cui->current == &cui->plugin_menu->scr;
1265 nc_scr_unpost(cui->current);
1267 talloc_free(cui->main);
1268 cui->main = main_menu_init(cui);
1269 cui->plugin_menu = plugin_menu_init(cui);
1272 cui->current = &cui->main->scr;
1273 nc_scr_post(cui->current);
1276 discover_client_enumerate(cui->client);
1279 static void cui_update_config(struct config *config, void *arg)
1281 struct cui *cui = cui_from_arg(arg);
1282 cui->config = talloc_steal(cui, config);
1285 cui_update_language(cui, config->lang);
1287 if (cui->subset_screen)
1288 subset_screen_update(cui->subset_screen);
1290 if (cui->config_screen)
1291 config_screen_update(cui->config_screen, config, cui->sysinfo);
1293 if (config->safe_mode)
1294 nc_scr_status_printf(cui->current,
1295 _("SAFE MODE: select '%s' to continue"),
1296 _("Rescan devices"));
1299 int cui_send_config(struct cui *cui, struct config *config)
1301 return discover_client_send_config(cui->client, config);
1304 int cui_send_url(struct cui *cui, char * url)
1306 return discover_client_send_url(cui->client, url);
1309 int cui_send_plugin_install(struct cui *cui, char *file)
1311 return discover_client_send_plugin_install(cui->client, file);
1314 void cui_send_reinit(struct cui *cui)
1316 discover_client_send_reinit(cui->client);
1320 * pb_mm_init - Setup the main menu instance.
1322 static struct pmenu *main_menu_init(struct cui *cui)
1324 struct pmenu_item *i;
1327 bool lockdown = lockdown_active();
1329 m = pmenu_init(cui, 9, lockdown ? cui_abort_on_exit : cui_on_exit);
1331 pb_log_fn("failed\n");
1336 m->hot_keys = talloc_array(m, hot_key_fn, m->n_hot_keys);
1338 pb_log_fn("failed to allocate hot_keys\n");
1342 m->hot_keys[0] = pmenu_main_hot_keys;
1343 m->on_new = cui_item_new;
1345 m->scr.frame.ltitle = talloc_asprintf(m,
1346 "Petitboot (" PACKAGE_VERSION ")");
1347 m->scr.frame.rtitle = NULL;
1348 m->scr.frame.help = talloc_strdup(m,
1349 _("Enter=accept, e=edit, n=new, x=exit, l=language, g=log, h=help"));
1350 m->scr.frame.status = talloc_strdup(m, _("Welcome to Petitboot"));
1352 /* add a separator */
1353 i = pmenu_item_create(m, " ");
1354 item_opts_off(i->nci, O_SELECTABLE);
1355 pmenu_item_insert(m, i, 0);
1357 /* add system items */
1358 i = pmenu_item_create(m, _("System information"));
1359 i->on_execute = menu_sysinfo_execute;
1360 pmenu_item_insert(m, i, 1);
1362 i = pmenu_item_create(m, _("System configuration"));
1363 i->on_execute = menu_config_execute;
1364 pmenu_item_insert(m, i, 2);
1366 i = pmenu_item_create(m, _("System status log"));
1367 i->on_execute = menu_statuslog_execute;
1368 pmenu_item_insert(m, i, 3);
1370 /* this label isn't translated, so we don't want a gettext() here */
1371 i = pmenu_item_create(m, "Language");
1372 i->on_execute = menu_lang_execute;
1373 pmenu_item_insert(m, i, 4);
1375 i = pmenu_item_create(m, _("Rescan devices"));
1376 i->on_execute = menu_reinit_execute;
1377 pmenu_item_insert(m, i, 5);
1379 i = pmenu_item_create(m, _("Retrieve config from URL"));
1380 i->on_execute = menu_add_url_execute;
1381 pmenu_item_insert(m, i, 6);
1383 i = pmenu_item_create(m, _("Plugins (0)"));
1384 i->on_execute = menu_plugin_execute;
1385 pmenu_item_insert(m, i, 7);
1388 i = pmenu_item_create(m, _("Reboot"));
1390 i = pmenu_item_create(m, _("Exit to shell"));
1391 i->on_execute = pmenu_exit_cb;
1392 pmenu_item_insert(m, i, 8);
1394 result = pmenu_setup(m);
1397 pb_log("%s:%d: pmenu_setup failed: %s\n", __func__, __LINE__,
1402 m->help_title = _("main menu");
1403 m->help_text = &main_menu_help_text;
1405 menu_opts_off(m->ncm, O_SHOWDESC);
1406 set_menu_mark(m->ncm, " *");
1407 set_current_item(m->ncm, i->nci);
1417 * plugin_menu_init: Set up the plugin menu instance
1419 static struct pmenu *plugin_menu_init(struct cui *cui)
1421 struct pmenu_item *i;
1425 m = pmenu_init(cui, 2, cui_plugin_menu_exit);
1426 m->scr.frame.ltitle = talloc_asprintf(m, _("Petitboot Plugins"));
1427 m->scr.frame.rtitle = talloc_asprintf(m, "%s", "");
1428 m->scr.frame.help = talloc_strdup(m,
1429 _("Enter=install, e=details, x=exit, h=help"));
1430 m->scr.frame.status = talloc_asprintf(m,
1431 _("Available Petitboot Plugins"));
1433 /* add a separator */
1434 i = pmenu_item_create(m, " ");
1435 item_opts_off(i->nci, O_SELECTABLE);
1436 pmenu_item_insert(m, i, 0);
1438 i = pmenu_item_create(m, _("Return to Main Menu"));
1439 i->on_execute = pmenu_exit_cb;
1440 pmenu_item_insert(m, i, 1);
1442 result = pmenu_setup(m);
1445 pb_log("%s:%d: pmenu_setup failed: %s\n", __func__, __LINE__,
1450 m->help_title = _("plugin menu");
1451 m->help_text = &plugin_menu_help_text;
1460 static struct discover_client_ops cui_client_ops = {
1462 .boot_option_add = cui_boot_option_add,
1463 .device_remove = cui_device_remove,
1464 .plugin_option_add = cui_plugin_option_add,
1465 .plugins_remove = cui_plugins_remove,
1466 .update_status = cui_update_status,
1467 .update_sysinfo = cui_update_sysinfo,
1468 .update_config = cui_update_config,
1471 /* cui_server_wait - Connect to the discover server.
1472 * @arg: Pointer to the cui instance.
1474 * A timeout callback that attempts to connect to the discover server; on
1475 * failure it registers itself with a one second timeout to try again.
1476 * On success the cui->client struct will be set.
1478 * Since this updates the status line when called it must not be called
1479 * before the UI is ready.
1481 static int cui_server_wait(void *arg)
1483 struct cui *cui = cui_from_arg(arg);
1486 pb_debug("We already have a server!\n");
1490 /* We haven't yet connected to the server */
1491 pb_log("Trying to connect...\n");
1492 cui->client = discover_client_init(cui->waitset,
1493 &cui_client_ops, cui);
1496 waiter_register_timeout(cui->waitset, 1000, cui_server_wait,
1498 nc_scr_status_printf(cui->current,
1499 "Info: Waiting for device discovery");
1501 nc_scr_status_free(cui->current);
1502 talloc_steal(cui, cui->client);
1504 if (cui->has_input) {
1505 pb_log("Aborting default boot on pb-discover connect\n");
1506 discover_client_cancel_default(cui->client);
1509 if (cui->autoboot_opt) {
1510 pb_log("Sending autoboot override on pb-discover connect\n");
1511 discover_client_send_temp_autoboot(cui->client,
1520 * cui_init - Setup the cui instance.
1521 * @platform_info: A value for the struct cui platform_info member.
1523 * Returns a pointer to a struct cui on success, or NULL on error.
1525 * Allocates the cui instance, sets up the client and stdin waiters, and
1526 * sets up the ncurses menu screen.
1529 struct cui *cui_init(void* platform_info,
1530 int (*js_map)(const struct js_event *e), int start_daemon, int timeout)
1535 cui = talloc_zero(NULL, struct cui);
1537 pb_log_fn("alloc cui failed.\n");
1538 fprintf(stderr, _("%s: alloc cui failed.\n"), __func__);
1542 cui->c_sig = pb_cui_sig;
1543 cui->platform_info = platform_info;
1544 cui->waitset = waitset_create(cui);
1545 cui->statuslog = statuslog_init(cui);
1547 process_init(cui, cui->waitset, false);
1549 /* Loop here for scripts that just started the server. */
1552 for (i = start_daemon ? 2 : 15; i && timeout; i--) {
1553 cui->client = discover_client_init(cui->waitset,
1554 &cui_client_ops, cui);
1555 if (cui->client || !i)
1557 pb_log_fn("waiting for server %d\n", i);
1561 if (!cui->client && start_daemon) {
1566 result = pb_start_daemon(cui);
1571 pb_log_fn("discover_client_init failed.\n");
1572 fprintf(stderr, _("%s: error: discover_client_init failed.\n"),
1574 fprintf(stderr, _("could not start pb-discover, the petitboot "
1576 goto fail_client_init;
1579 if (!cui->client && !timeout) {
1580 /* Have the first timeout fire immediately so we can check
1581 * for the server as soon as the UI is ready */
1582 waiter_register_timeout(cui->waitset, 0,
1583 cui_server_wait, cui);
1584 } else if (!cui->client) {
1585 pb_log_fn("discover_client_init failed.\n");
1586 fprintf(stderr, _("%s: error: discover_client_init failed.\n"),
1588 fprintf(stderr, _("check that pb-discover, "
1589 "the petitboot daemon is running.\n"));
1590 goto fail_client_init;
1594 talloc_steal(cui, cui->client);
1597 cui->main = main_menu_init(cui);
1599 goto fail_client_init;
1601 cui->plugin_menu = plugin_menu_init(cui);
1602 if (!cui->plugin_menu)
1603 goto fail_client_init;
1605 waiter_register_io(cui->waitset, STDIN_FILENO, WAIT_IN,
1606 cui_process_key, cui);
1610 cui->pjs = pjs_init(cui, js_map);
1613 waiter_register_io(cui->waitset, pjs_get_fd(cui->pjs),
1614 WAIT_IN, cui_process_js, cui);
1626 * cui_cancel_autoboot_on_exit - On exit spin until the server is available.
1628 * If the program exits before connecting to the server autoboot won't be
1629 * cancelled even though there has been keyboard activity. A child is forked
1630 * which will spin until the server is connected and told to cancel autoboot.
1632 static void cui_cancel_autoboot_on_exit(struct cui *cui)
1637 /* Fork a child to tell the server to cancel autoboot */
1640 cui_detached = true;
1642 /* Loop until connection established */
1643 while (!cui->client) {
1644 cui->client = discover_client_init(cui->waitset,
1645 &cui_client_ops, cui);
1650 talloc_steal(cui, cui->client);
1651 discover_client_cancel_default(cui->client);
1655 pb_log("Failed to fork child on exit: %m\n");
1657 discover_client_cancel_default(cui->client);
1661 * cui_run - The main cui program loop.
1662 * @cui: The cui instance.
1663 * @main: The menu to use as the main menu.
1665 * Runs the cui engine. Does not return until indicated to do so by some
1666 * user action, or an error occurs. Frees the cui object on return.
1667 * Returns 0 on success (return to shell), -1 on error (should restart).
1670 int cui_run(struct cui *cui)
1675 cui->current = &cui->main->scr;
1676 cui->default_item = 0;
1678 nc_scr_post(cui->current);
1681 int result = waiter_poll(cui->waitset);
1684 pb_log_fn("poll: %s\n", strerror(errno));
1691 while (cui->resize) {
1693 cui_handle_resize(cui);
1697 cui_cancel_autoboot_on_exit(cui);
1701 return cui->abort ? 0 : -1;