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_start(void)
97 initscr(); /* Initialize ncurses. */
98 cbreak(); /* Disable line buffering. */
99 noecho(); /* Disable getch() echo. */
100 keypad(stdscr, TRUE); /* Enable num keypad keys. */
101 nonl(); /* Disable new-line translation. */
102 intrflush(stdscr, FALSE); /* Disable interrupt flush. */
103 curs_set(0); /* Make cursor invisible */
104 nodelay(stdscr, TRUE); /* Enable non-blocking getch() */
106 /* We may be operating with an incorrect $TERM type; in this case
107 * the keymappings will be slightly broken. We want at least
108 * backspace to work though, so we'll define both DEL and ^H to
109 * map to backspace */
110 define_key("\x7f", KEY_BACKSPACE);
111 define_key("\x08", KEY_BACKSPACE);
113 /* we need backtab too, for form navigation. vt220 doesn't include
114 * this (kcbt), but we don't want to require a full linux/xterm termcap
116 define_key("\x1b[Z", KEY_BTAB);
118 /* We'll define a few other keys too since they're commonly
119 * used for navigation but the escape character will cause
120 * Petitboot to exit if they're left undefined */
121 define_key("\x1b\x5b\x35\x7e", KEY_PPAGE);
122 define_key("\x1b\x5b\x36\x7e", KEY_NPAGE);
123 define_key("\x1b\x5b\x31\x7e", KEY_HOME);
124 define_key("\x1b\x5b\x34\x7e", KEY_END);
125 define_key("\x1b\x4f\x48", KEY_HOME);
126 define_key("\x1b\x4f\x46", KEY_END);
127 define_key("OH", KEY_HOME);
128 define_key("OF", KEY_END);
130 /* Arrow keys in normal cursor mode */
131 define_key("\x1b\x5b\x41", KEY_UP);
132 define_key("\x1b\x5b\x42", KEY_DOWN);
133 define_key("\x1b\x5b\x43", KEY_RIGHT);
134 define_key("\x1b\x5b\x44", KEY_LEFT);
135 /* Arrow keys in "application" cursor mode */
136 define_key("\x1b\x4f\x41", KEY_UP);
137 define_key("\x1b\x4f\x42", KEY_DOWN);
138 define_key("\x1b\x4f\x43", KEY_RIGHT);
139 define_key("\x1b\x4f\x44", KEY_LEFT);
141 define_key("\x1b\x5b\x33\x7e", KEY_DC);
143 while (getch() != ERR) /* flush stdin */
147 static void cui_atexit(void)
156 bool lockdown = lockdown_active();
165 * cui_abort - Signal the main cui program loop to exit.
167 * Sets cui.abort, which causes the cui_run() routine to return.
170 void cui_abort(struct cui *cui)
172 pb_log_fn("exiting\n");
177 * cui_resize - Signal the main cui program loop to resize
179 * Called at SIGWINCH.
182 void cui_resize(struct cui *cui)
184 pb_debug("%s: resizing\n", __func__);
189 * cui_on_exit - A generic main menu exit callback.
192 void cui_on_exit(struct pmenu *menu)
194 struct cui *cui = cui_from_pmenu(menu);
197 cui_cancel_autoboot_on_exit(cui);
199 sh_cmd = talloc_asprintf(cui,
200 "echo \"Exiting petitboot. Type 'exit' to return.\";\
201 echo \"You may run 'pb-sos' to gather diagnostic data\";\
202 %s", pb_system_apps.sh);
205 pb_log("Failed to allocate shell arguments\n");
209 const char *argv[] = {
216 cui_run_cmd(cui, argv);
218 nc_scr_status_printf(cui->current, _("Returned from shell"));
223 * cui_run_cmd - A generic cb to run the supplied command.
226 int cui_run_cmd(struct cui *cui, const char **cmd_argv)
228 struct process *process;
231 process = process_create(cui);
235 process->path = cmd_argv[0];
236 process->argv = cmd_argv;
237 process->raw_stdout = true;
239 nc_scr_status_printf(cui->current, _("Running %s..."), cmd_argv[0]);
241 nc_scr_unpost(cui->current);
248 result = process_run_sync(process);
253 redrawwin(cui->current->main_ncw);
254 nc_scr_post(cui->current);
257 pb_log_fn("failed: '%s'\n", cmd_argv[0]);
258 nc_scr_status_printf(cui->current, _("Failed: %s"),
262 process_release(process);
267 int cui_run_cmd_from_item(struct pmenu_item *item)
269 struct cui *cui = cui_from_item(item);
270 const char **cmd_argv = item->data;
272 return cui_run_cmd(cui, cmd_argv);
276 * cui_boot - A generic cb to run kexec.
279 static int cui_boot(struct pmenu_item *item)
282 struct cui *cui = cui_from_item(item);
283 struct cui_opt_data *cod = cod_from_item(item);
285 assert(cui->current == &cui->main->scr);
287 pb_debug("%s: %s\n", __func__, cod->name);
289 nc_scr_status_printf(cui->current, _("Booting %s..."), cod->name);
291 result = discover_client_boot(cui->client, NULL, cod->opt, cod->bd);
294 nc_scr_status_printf(cui->current,
295 _("Failed: boot %s"), cod->bd->image);
301 static void cui_boot_editor_on_exit(struct cui *cui,
302 struct pmenu_item *item,
303 struct pb_boot_data *bd)
305 struct pmenu *menu = cui->main;
306 struct cui_opt_data *cod;
307 int idx, top, rows, cols;
308 static int user_idx = 0;
310 /* Was the edit cancelled? */
312 cui_set_current(cui, &cui->main->scr);
313 talloc_free(cui->boot_editor);
314 cui->boot_editor = NULL;
318 /* Is this was a new item, we'll need to update the menu */
322 cod = talloc_zero(NULL, struct cui_opt_data);
323 cod->name = talloc_asprintf(cod, _("User item %u"), ++user_idx);
325 item = pmenu_item_create(menu, cod->name);
331 item->on_edit = cui_item_edit;
332 item->on_execute = cui_boot;
335 talloc_steal(item, cod);
337 /* Detach the items array. */
338 set_menu_items(menu->ncm, NULL);
340 /* Insert new item at insert_pt. */
341 insert_pt = pmenu_grow(menu, 1);
342 pmenu_item_insert(menu, item, insert_pt);
344 /* Re-attach the items array. */
345 set_menu_items(menu->ncm, menu->items);
347 /* If our index is above the current top row, align
348 * us to the new top. Otherwise, align us to the new
350 menu_format(cui->main->ncm, &rows, &cols);
351 top = top_row(cui->main->ncm);
352 idx = item_index(item->nci);
357 top = idx < rows ? 0 : idx - rows + 1;
359 set_top_row(cui->main->ncm, top);
360 set_current_item(item->pmenu->ncm, item->nci);
362 nc_scr_post(&menu->scr);
367 cod->bd = talloc_steal(cod, bd);
370 cui_set_current(cui, &cui->main->scr);
371 talloc_free(cui->boot_editor);
372 cui->boot_editor = NULL;
375 void cui_item_edit(struct pmenu_item *item)
377 struct cui *cui = cui_from_item(item);
378 cui->boot_editor = boot_editor_init(cui, item, cui->sysinfo,
379 cui_boot_editor_on_exit);
380 cui_set_current(cui, boot_editor_scr(cui->boot_editor));
383 void cui_item_new(struct pmenu *menu)
385 struct cui *cui = cui_from_pmenu(menu);
386 cui->boot_editor = boot_editor_init(cui, NULL, cui->sysinfo,
387 cui_boot_editor_on_exit);
388 cui_set_current(cui, boot_editor_scr(cui->boot_editor));
391 static void cui_sysinfo_exit(struct cui *cui)
393 cui_set_current(cui, &cui->main->scr);
394 talloc_free(cui->sysinfo_screen);
395 cui->sysinfo_screen = NULL;
398 void cui_show_sysinfo(struct cui *cui)
400 cui->sysinfo_screen = sysinfo_screen_init(cui, cui->sysinfo,
402 cui_set_current(cui, sysinfo_screen_scr(cui->sysinfo_screen));
405 static void cui_config_exit(struct cui *cui)
407 cui_set_current(cui, &cui->main->scr);
408 talloc_free(cui->config_screen);
409 cui->config_screen = NULL;
412 void cui_show_config(struct cui *cui)
414 cui->config_screen = config_screen_init(cui, cui->config,
415 cui->sysinfo, cui_config_exit);
416 cui_set_current(cui, config_screen_scr(cui->config_screen));
419 static void cui_lang_exit(struct cui *cui)
421 cui_set_current(cui, &cui->main->scr);
422 talloc_free(cui->lang_screen);
423 cui->lang_screen = NULL;
426 void cui_show_lang(struct cui *cui)
428 cui->lang_screen = lang_screen_init(cui, cui->config, cui_lang_exit);
429 cui_set_current(cui, lang_screen_scr(cui->lang_screen));
432 static void cui_statuslog_exit(struct cui *cui)
434 cui_set_current(cui, &cui->main->scr);
435 talloc_free(cui->statuslog_screen);
436 cui->statuslog_screen = NULL;
439 void cui_show_statuslog(struct cui *cui)
441 cui->statuslog_screen = statuslog_screen_init(cui, cui_statuslog_exit);
442 cui_set_current(cui, statuslog_screen_scr(cui->statuslog_screen));
445 static void cui_add_url_exit(struct cui *cui)
447 cui_set_current(cui, &cui->main->scr);
448 talloc_free(cui->add_url_screen);
449 cui->add_url_screen = NULL;
452 static void cui_plugin_exit(struct cui *cui)
454 cui_set_current(cui, &cui->plugin_menu->scr);
455 talloc_free(cui->plugin_screen);
456 cui->plugin_screen = NULL;
459 static void cui_plugin_menu_exit(struct pmenu *menu)
461 struct cui *cui = cui_from_pmenu(menu);
462 cui_set_current(cui, &cui->main->scr);
465 void cui_show_add_url(struct cui *cui)
467 cui->add_url_screen = add_url_screen_init(cui, cui_add_url_exit);
468 cui_set_current(cui, add_url_screen_scr(cui->add_url_screen));
471 void cui_show_plugin_menu(struct cui *cui)
473 cui_set_current(cui, &cui->plugin_menu->scr);
476 void cui_show_plugin(struct pmenu_item *item)
478 struct cui *cui = cui_from_item(item);
479 cui->plugin_screen = plugin_screen_init(cui, item, cui_plugin_exit);
480 cui_set_current(cui, plugin_screen_scr(cui->plugin_screen));
483 static void cui_help_exit(struct cui *cui)
485 cui_set_current(cui, help_screen_return_scr(cui->help_screen));
486 talloc_free(cui->help_screen);
487 cui->help_screen = NULL;
490 void cui_show_help(struct cui *cui, const char *title,
491 const struct help_text *text)
496 if (cui->help_screen)
499 cui->help_screen = help_screen_init(cui, cui->current,
500 title, text, cui_help_exit);
502 if (cui->help_screen)
503 cui_set_current(cui, help_screen_scr(cui->help_screen));
506 static void cui_subset_exit(struct cui *cui)
508 cui_set_current(cui, subset_screen_return_scr(cui->subset_screen));
509 talloc_free(cui->subset_screen);
510 cui->subset_screen = NULL;
513 void cui_show_subset(struct cui *cui, const char *title,
519 if (cui->subset_screen)
522 cui->subset_screen = subset_screen_init(cui, cui->current,
523 title, arg, cui_subset_exit);
525 if (cui->subset_screen)
526 cui_set_current(cui, subset_screen_scr(cui->subset_screen));
530 * cui_set_current - Set the currently active screen and redraw it.
533 struct nc_scr *cui_set_current(struct cui *cui, struct nc_scr *scr)
537 DBGS("%p -> %p\n", cui->current, scr);
539 assert(cui->current != scr);
546 nc_scr_post(cui->current);
551 static bool set_temp_autoboot_opt(struct cui *cui, struct autoboot_option *opt)
553 cui->autoboot_opt = opt;
555 discover_client_send_temp_autoboot(cui->client, opt);
560 static bool key_cancels_boot(int key)
567 for (i = 0; i < ARRAY_SIZE(autoboot_override_keys); i++)
568 if (key == autoboot_override_keys[i].key)
574 static bool process_global_keys(struct cui *cui, int key)
580 if (cui->current && cui->current->main_ncw)
585 /* check for autoboot override keys */
586 for (i = 0; i < ARRAY_SIZE(autoboot_override_keys); i++) {
587 if (key != autoboot_override_keys[i].key)
590 pb_log("Sending temporary autoboot override\n");
591 set_temp_autoboot_opt(cui, &autoboot_override_keys[i].opt);
599 * cui_process_key - Process input on stdin.
602 static int cui_process_key(void *arg)
604 struct cui *cui = cui_from_arg(arg);
609 assert(cui->current);
614 pb_debug("%s: got key %d\n", __func__, c);
621 * If this is a console code sequence try to parse it
622 * and don't treat this as a key press.
625 if (grab != ERR && grab != 27) {
627 pb_debug("%s: Caught unhandled command sequence\n",
629 sequence = handle_control_sequence(cui, c);
630 pb_debug("Caught sequence ");
632 pb_debug("(%zu): ", strlen(sequence));
633 for (i = 0; i < strlen(sequence); i++)
634 pb_debug("0%o ", sequence[i]);
637 pb_debug("(0): (none)\n");
642 if (!cui->has_input && key_cancels_boot(c)) {
643 cui->has_input = true;
645 pb_log("UI input received (key = %d), aborting "
646 "default boot\n", c);
647 discover_client_cancel_default(cui->client);
649 pb_log("UI input received (key = %d), aborting "
650 "once server connects\n", c);
654 if (process_global_keys(cui, c))
657 cui->current->process_key(cui->current, c);
664 * cui_process_js - Process joystick events.
667 static int cui_process_js(void *arg)
669 struct cui *cui = cui_from_arg(arg);
672 c = pjs_process_event(cui->pjs);
676 cui_process_key(arg);
683 * cui_handle_resize - Handle the term resize.
686 static void cui_handle_resize(struct cui *cui)
690 if (ioctl(1, TIOCGWINSZ, &ws) == -1) {
691 pb_log_fn("ioctl failed: %s\n", strerror(errno));
695 pb_debug("%s: {%u,%u}\n", __func__, ws.ws_row, ws.ws_col);
697 wclear(cui->current->main_ncw);
698 resize_term(ws.ws_row, ws.ws_col);
699 cui->current->resize(cui->current);
701 /* For some reason this makes ncurses redraw the screen */
703 redrawwin(cui->current->main_ncw);
704 wrefresh(cui->current->main_ncw);
708 * cui_device_add - Client device_add callback.
710 * Creates menu_items for all the device boot_options and inserts those
711 * menu_items into the main menu. Redraws the main menu if it is active.
712 * If a 'plugin' type boot_option appears the plugin menu is updated instead.
715 static int cui_boot_option_add(struct device *dev, struct boot_option *opt,
718 struct pmenu_item *i, *dev_hdr = NULL;
719 struct cui *cui = cui_from_arg(arg);
720 struct cui_opt_data *cod;
721 const char *tab = " ";
722 unsigned int insert_pt;
723 int result, rows, cols;
729 plugin_option = opt->type == DISCOVER_PLUGIN_OPTION;
730 menu = plugin_option ? cui->plugin_menu : cui->main;
732 pb_debug("%s: %p %s\n", __func__, opt, opt->id);
734 selected = current_item(menu->ncm);
735 menu_format(menu->ncm, &rows, &cols);
737 if (cui->current == &cui->main->scr)
738 nc_scr_unpost(cui->current);
739 if (plugin_option && cui->current == &cui->plugin_menu->scr)
740 nc_scr_unpost(cui->current);
742 /* Check if the boot device is new */
743 dev_hdr = pmenu_find_device(menu, dev, opt);
745 /* All actual boot entries are 'tabbed' across */
746 name = talloc_asprintf(menu, "%s%s",
747 tab, opt->name ? : "Unknown Name");
749 /* Save the item in opt->ui_info for cui_device_remove() */
750 opt->ui_info = i = pmenu_item_create(menu, name);
757 i->on_execute = plugin_install_plugin;
759 i->on_edit = cui_item_edit;
760 i->on_execute = cui_boot;
763 i->data = cod = talloc(i, struct cui_opt_data);
766 cod->opt_hash = pb_opt_hash(dev, opt);
767 cod->name = opt->name;
770 cod->pd = talloc(i, struct pb_plugin_data);
771 cod->pd->plugin_file = talloc_strdup(cod,
772 opt->boot_image_file);
774 cod->bd = talloc(i, struct pb_boot_data);
775 cod->bd->image = talloc_strdup(cod->bd, opt->boot_image_file);
776 cod->bd->initrd = talloc_strdup(cod->bd, opt->initrd_file);
777 cod->bd->dtb = talloc_strdup(cod->bd, opt->dtb_file);
778 cod->bd->args = talloc_strdup(cod->bd, opt->boot_args);
779 cod->bd->args_sig_file = talloc_strdup(cod->bd, opt->args_sig_file);
782 /* This disconnects items array from menu. */
783 result = set_menu_items(menu->ncm, NULL);
786 pb_log_fn("set_menu_items failed: %d\n", result);
788 /* Insert new items at insert_pt. */
790 insert_pt = pmenu_grow(menu, 2);
791 pmenu_item_insert(menu, dev_hdr, insert_pt);
792 pb_log("%s: adding new device hierarchy %s\n",
793 __func__, opt->device_id);
794 pmenu_item_insert(menu, i, insert_pt+1);
796 insert_pt = pmenu_grow(menu, 1);
797 pmenu_item_add(menu, i, insert_pt);
801 pb_log_fn("adding plugin '%s'\n", cod->name);
802 pb_log(" file '%s'\n", cod->pd->plugin_file);
804 pb_log_fn("adding opt '%s'\n", cod->name);
805 pb_log(" image '%s'\n", cod->bd->image);
806 pb_log(" initrd '%s'\n", cod->bd->initrd);
807 pb_log(" args '%s'\n", cod->bd->args);
808 pb_log(" argsig '%s'\n", cod->bd->args_sig_file);
811 /* Update the plugin menu label if needed */
813 struct pmenu_item *item;
815 result = set_menu_items(cui->main->ncm, NULL);
816 for (j = 0 ; j < cui->main->item_count; j++) {
817 item = item_userptr(cui->main->items[j]);
818 if (strncmp(item->nci->name.str, "Plugins", strlen("Plugins")))
821 char *label = talloc_asprintf(item, "Plugins (%u)",
823 pmenu_item_update(item, label);
827 result = set_menu_items(cui->main->ncm, cui->main->items);
829 pb_log_fn("set_menu_items failed: %d\n", result);
832 /* Re-attach the items array. */
833 result = set_menu_items(menu->ncm, menu->items);
836 pb_log_fn("set_menu_items failed: %d\n", result);
839 pb_log("%s\n", __func__);
840 pmenu_dump_items(menu->items,
841 item_count(menu->ncm) + 1);
844 if (!item_visible(selected)) {
847 top = top_row(menu->ncm);
848 idx = item_index(selected);
850 /* If our index is above the current top row, align
851 * us to the new top. Otherwise, align us to the new
853 top = top < idx ? idx - rows + 1 : idx;
855 set_top_row(menu->ncm, top);
856 set_current_item(menu->ncm, selected);
859 if (cui->current == &menu->scr)
860 nc_scr_post(cui->current);
861 if (plugin_option && cui->current == &cui->main->scr)
862 nc_scr_post(cui->current);
868 * cui_device_remove - Client device remove callback.
870 * Removes all the menu_items for the device from the main menu and redraws the
871 * main menu if it is active.
873 static void cui_device_remove(struct device *dev, void *arg)
875 struct cui *cui = cui_from_arg(arg);
876 struct boot_option *opt;
878 int rows, cols, top, last;
881 pb_log_fn("%p %s\n", dev, dev->id);
883 if (cui->current == &cui->main->scr)
884 nc_scr_unpost(cui->current);
885 if (cui->current == &cui->plugin_menu->scr)
886 nc_scr_unpost(cui->current);
888 /* This disconnects items array from menu. */
890 result = set_menu_items(cui->main->ncm, NULL);
891 result |= set_menu_items(cui->plugin_menu->ncm, NULL);
894 pb_log_fn("set_menu_items failed: %d\n", result);
896 list_for_each_entry(&dev->boot_options, opt, list) {
897 struct pmenu_item *item = pmenu_item_from_arg(opt->ui_info);
899 assert(pb_protocol_device_cmp(dev, cod_from_item(item)->dev));
900 if (opt->type == DISCOVER_PLUGIN_OPTION)
901 pmenu_remove(cui->plugin_menu, item);
903 pmenu_remove(cui->main, item);
906 /* Manually remove remaining device hierarchy item */
907 for (i=0; i < cui->main->item_count; i++) {
908 struct pmenu_item *item = item_userptr(cui->main->items[i]);
909 if (!item || !item->data )
912 struct cui_opt_data *data = item->data;
913 if (data && data->dev && data->dev == dev)
914 pmenu_remove(cui->main,item);
916 /* Look in plugins menu too */
917 for (i=0; i < cui->plugin_menu->item_count; i++) {
918 struct pmenu_item *item = item_userptr(cui->plugin_menu->items[i]);
919 if (!item || !item->data )
922 struct cui_opt_data *data = item->data;
923 if (data && data->dev && data->dev == dev)
924 pmenu_remove(cui->plugin_menu,item);
927 /* Re-attach the items array. */
929 result = set_menu_items(cui->main->ncm, cui->main->items);
930 result |= set_menu_items(cui->plugin_menu->ncm, cui->plugin_menu->items);
932 /* Move cursor to 'Exit' menu entry for the main menu.. */
933 menu_format(cui->main->ncm, &rows, &cols);
934 last = cui->main->item_count - 1;
935 set_current_item(cui->main->ncm, cui->main->items[last]);
936 if (!item_visible(cui->main->items[last])) {
937 top = last < rows ? 0 : last - rows + 1;
938 set_top_row(cui->main->ncm, top);
941 /* ..and the plugin menu */
942 menu_format(cui->plugin_menu->ncm, &rows, &cols);
943 last = cui->plugin_menu->item_count - 1;
944 set_current_item(cui->plugin_menu->ncm, cui->plugin_menu->items[last]);
945 if (!item_visible(cui->plugin_menu->items[last])) {
946 top = last < rows ? 0 : last - rows + 1;
947 set_top_row(cui->plugin_menu->ncm, top);
951 pb_log_fn("set_menu_items failed: %d\n", result);
954 pb_log("%s\n", __func__);
955 pmenu_dump_items(cui->main->items,
956 item_count(cui->main->ncm) + 1);
959 if (cui->current == &cui->main->scr)
960 nc_scr_post(cui->current);
961 if (cui->current == &cui->plugin_menu->scr)
962 nc_scr_post(cui->current);
965 static void cui_update_status(struct status *status, void *arg)
967 struct cui *cui = cui_from_arg(arg);
969 statuslog_append_steal(cui, cui->statuslog, status);
971 /* Ignore status messages from the backlog */
972 if (!status->backlog)
973 nc_scr_status_printf(cui->current, "%s", status->message);
977 * Handle a new installed plugin option and update its associated
978 * (uninstalled) menu item if it exists.
980 static int cui_plugin_option_add(struct plugin_option *opt, void *arg)
982 struct cui_opt_data *cod;
983 struct cui *cui = cui_from_arg(arg);
984 struct pmenu_item *item = NULL;
985 struct boot_option *dummy_opt;
991 /* Find uninstalled plugin by matching on plugin_file */
992 for (i = 0; i < cui->plugin_menu->item_count; i++) {
993 item = item_userptr(cui->plugin_menu->items[i]);
996 cod = cod_from_item(item);
997 if (!cod || !cod->pd)
999 if (strncmp(cod->pd->plugin_file, opt->plugin_file,
1000 strlen(cod->pd->plugin_file)) == 0)
1005 * If pb-plugin was run manually there may not be an associated
1006 * plugin-type boot_option. Pass a fake device and option to
1007 * cui_boot_option_add() so we have an item to work with.
1009 if (!item || i >= cui->plugin_menu->item_count) {
1010 pb_log("New plugin option %s doesn't have a source item\n",
1012 dev = talloc_zero(cui, struct device);
1013 dev->id = dev->name = talloc_asprintf(dev, "(unknown)");
1014 dev->type = DEVICE_TYPE_UNKNOWN;
1015 dummy_opt = talloc_zero(cui, struct boot_option);
1016 dummy_opt->device_id = talloc_strdup(dummy_opt, dev->id);
1017 dummy_opt->id = dummy_opt->name = talloc_asprintf(dummy_opt, "dummy");
1018 dummy_opt->boot_image_file = talloc_strdup(dummy_opt, opt->plugin_file);
1019 dummy_opt->type = DISCOVER_PLUGIN_OPTION;
1020 cui_boot_option_add(dev, dummy_opt, cui);
1025 * If this option was faked above move the context under
1026 * the item so it is cleaned up later in cui_plugins_remove().
1028 if (strcmp(cod->opt->id, "dummy") == 0 &&
1029 cod->dev->type == DEVICE_TYPE_UNKNOWN) {
1030 talloc_steal(item, cod->dev);
1031 talloc_steal(item, cod->opt);
1034 talloc_free(cod->name);
1035 /* Name is still tabbed across */
1036 cod->name = talloc_asprintf(cod, _(" %s [installed]"), opt->name);
1039 item->on_execute = NULL;
1040 item->on_edit = cui_show_plugin;
1042 if (cui->current == &cui->plugin_menu->scr)
1043 nc_scr_unpost(cui->current);
1045 /* This disconnects items array from menu. */
1046 result = set_menu_items(cui->plugin_menu->ncm, NULL);
1049 pmenu_item_update(item, cod->name);
1051 /* Re-attach the items array. */
1052 result = set_menu_items(cui->plugin_menu->ncm, cui->plugin_menu->items);
1054 if (cui->current == &cui->plugin_menu->scr)
1055 nc_scr_post(cui->current);
1061 * Most plugin menu items will be removed via cui_device_remove(). However if
1062 * pb-plugin has been run manually it is possible that there a plugin items
1063 * not associated with a device - remove them here.
1065 static int cui_plugins_remove(void *arg)
1067 struct cui *cui = cui_from_arg(arg);
1068 struct pmenu_item *item = NULL;
1069 struct cui_opt_data *cod;
1072 pb_debug("%s\n", __func__);
1074 if (cui->current == &cui->plugin_menu->scr)
1075 nc_scr_unpost(cui->current);
1076 if (cui->current == &cui->main->scr)
1077 nc_scr_unpost(cui->current);
1079 /* This disconnects items array from menu. */
1080 set_menu_items(cui->plugin_menu->ncm, NULL);
1082 while (i < cui->plugin_menu->item_count) {
1083 item = item_userptr(cui->plugin_menu->items[i]);
1084 if (!item || !item->data) {
1088 cod = cod_from_item(item);
1089 if (!cod->opt && !cod->dev) {
1094 pmenu_remove(cui->plugin_menu, item);
1095 /* plugin_menu entries will shift, jump to bottom to make sure
1096 * we remove all plugin option items */
1100 /* Re-attach the items array. */
1101 set_menu_items(cui->plugin_menu->ncm, cui->plugin_menu->items);
1103 set_menu_items(cui->main->ncm, NULL);
1104 for (i = 0; i < cui->main->item_count; i++) {
1105 item = item_userptr(cui->main->items[i]);
1106 if (strncmp(item->nci->name.str, "Plugins", strlen("Plugins")))
1109 pmenu_item_update(item, "Plugins (0)");
1113 set_menu_items(cui->main->ncm, cui->main->items);
1115 if (cui->current == &cui->main->scr)
1116 nc_scr_post(cui->current);
1118 /* If we're currently in a plugin screen jump back to the plugin menu */
1119 if (cui->plugin_screen &&
1120 cui->current == plugin_screen_scr(cui->plugin_screen))
1121 cui_plugin_exit(cui);
1126 static void cui_update_mm_title(struct cui *cui)
1128 struct nc_frame *frame = &cui->main->scr.frame;
1130 talloc_free(frame->rtitle);
1132 frame->rtitle = talloc_strdup(cui->main, cui->sysinfo->type);
1133 if (cui->sysinfo->identifier)
1134 frame->rtitle = talloc_asprintf_append(frame->rtitle,
1135 " %s", cui->sysinfo->identifier);
1137 if (cui->current == &cui->main->scr)
1138 nc_scr_post(cui->current);
1140 frame = &cui->plugin_menu->scr.frame;
1142 talloc_free(frame->rtitle);
1144 frame->rtitle = talloc_strdup(cui->main, cui->sysinfo->type);
1145 if (cui->sysinfo->identifier)
1146 frame->rtitle = talloc_asprintf_append(frame->rtitle,
1147 " %s", cui->sysinfo->identifier);
1149 if (cui->current == &cui->main->scr)
1150 nc_scr_post(cui->current);
1153 static void cui_update_sysinfo(struct system_info *sysinfo, void *arg)
1155 struct cui *cui = cui_from_arg(arg);
1156 cui->sysinfo = talloc_steal(cui, sysinfo);
1158 /* if we're currently displaying the system info screen, inform it
1159 * of the updated information. */
1160 if (cui->sysinfo_screen)
1161 sysinfo_screen_update(cui->sysinfo_screen, sysinfo);
1163 if (cui->subset_screen)
1164 subset_screen_update(cui->subset_screen);
1166 /* ... and do the same with the config screen... */
1167 if (cui->config_screen)
1168 config_screen_update(cui->config_screen, cui->config, sysinfo);
1170 /* ... and the boot editor. */
1171 if (cui->boot_editor)
1172 boot_editor_update(cui->boot_editor, sysinfo);
1174 cui_update_mm_title(cui);
1177 static void cui_update_language(struct cui *cui, char *lang)
1182 cur_lang = setlocale(LC_ALL, NULL);
1183 if (cur_lang && !strcmp(cur_lang, lang))
1186 setlocale(LC_ALL, lang);
1188 /* we'll need to update the menu: drop all items and repopulate */
1189 repost_menu = cui->current == &cui->main->scr ||
1190 cui->current == &cui->plugin_menu->scr;
1192 nc_scr_unpost(cui->current);
1194 talloc_free(cui->main);
1195 cui->main = main_menu_init(cui);
1196 cui->plugin_menu = plugin_menu_init(cui);
1199 cui->current = &cui->main->scr;
1200 nc_scr_post(cui->current);
1203 discover_client_enumerate(cui->client);
1206 static void cui_update_config(struct config *config, void *arg)
1208 struct cui *cui = cui_from_arg(arg);
1209 cui->config = talloc_steal(cui, config);
1212 cui_update_language(cui, config->lang);
1214 if (cui->subset_screen)
1215 subset_screen_update(cui->subset_screen);
1217 if (cui->config_screen)
1218 config_screen_update(cui->config_screen, config, cui->sysinfo);
1220 if (config->safe_mode)
1221 nc_scr_status_printf(cui->current,
1222 _("SAFE MODE: select '%s' to continue"),
1223 _("Rescan devices"));
1226 int cui_send_config(struct cui *cui, struct config *config)
1228 return discover_client_send_config(cui->client, config);
1231 int cui_send_url(struct cui *cui, char * url)
1233 return discover_client_send_url(cui->client, url);
1236 int cui_send_plugin_install(struct cui *cui, char *file)
1238 return discover_client_send_plugin_install(cui->client, file);
1241 void cui_send_reinit(struct cui *cui)
1243 discover_client_send_reinit(cui->client);
1246 static int menu_sysinfo_execute(struct pmenu_item *item)
1248 cui_show_sysinfo(cui_from_item(item));
1252 static int menu_config_execute(struct pmenu_item *item)
1254 cui_show_config(cui_from_item(item));
1258 static int menu_lang_execute(struct pmenu_item *item)
1260 cui_show_lang(cui_from_item(item));
1264 static int menu_statuslog_execute(struct pmenu_item *item)
1266 cui_show_statuslog(cui_from_item(item));
1270 static int menu_reinit_execute(struct pmenu_item *item)
1272 if (cui_from_item(item)->client)
1273 cui_send_reinit(cui_from_item(item));
1277 static int menu_add_url_execute(struct pmenu_item *item)
1279 if (cui_from_item(item)->client)
1280 cui_show_add_url(cui_from_item(item));
1284 static int menu_plugin_execute(struct pmenu_item *item)
1286 if (cui_from_item(item)->client)
1287 cui_show_plugin_menu(cui_from_item(item));
1292 * pb_mm_init - Setup the main menu instance.
1294 static struct pmenu *main_menu_init(struct cui *cui)
1296 struct pmenu_item *i;
1299 bool lockdown = lockdown_active();
1301 m = pmenu_init(cui, 9, cui_on_exit);
1303 pb_log_fn("failed\n");
1308 m->hot_keys = talloc_array(m, hot_key_fn, m->n_hot_keys);
1310 pb_log_fn("failed to allocate hot_keys\n");
1314 m->hot_keys[0] = pmenu_main_hot_keys;
1315 m->on_new = cui_item_new;
1317 m->scr.frame.ltitle = talloc_asprintf(m,
1318 "Petitboot (" PACKAGE_VERSION ")");
1319 m->scr.frame.rtitle = NULL;
1320 m->scr.frame.help = talloc_strdup(m,
1321 _("Enter=accept, e=edit, n=new, x=exit, l=language, g=log, h=help"));
1322 m->scr.frame.status = talloc_strdup(m, _("Welcome to Petitboot"));
1324 /* add a separator */
1325 i = pmenu_item_create(m, " ");
1326 item_opts_off(i->nci, O_SELECTABLE);
1327 pmenu_item_insert(m, i, 0);
1329 /* add system items */
1330 i = pmenu_item_create(m, _("System information"));
1331 i->on_execute = menu_sysinfo_execute;
1332 pmenu_item_insert(m, i, 1);
1334 i = pmenu_item_create(m, _("System configuration"));
1335 i->on_execute = menu_config_execute;
1336 pmenu_item_insert(m, i, 2);
1338 i = pmenu_item_create(m, _("System status log"));
1339 i->on_execute = menu_statuslog_execute;
1340 pmenu_item_insert(m, i, 3);
1342 /* this label isn't translated, so we don't want a gettext() here */
1343 i = pmenu_item_create(m, "Language");
1344 i->on_execute = menu_lang_execute;
1345 pmenu_item_insert(m, i, 4);
1347 i = pmenu_item_create(m, _("Rescan devices"));
1348 i->on_execute = menu_reinit_execute;
1349 pmenu_item_insert(m, i, 5);
1351 i = pmenu_item_create(m, _("Retrieve config from URL"));
1352 i->on_execute = menu_add_url_execute;
1353 pmenu_item_insert(m, i, 6);
1355 i = pmenu_item_create(m, _("Plugins (0)"));
1356 i->on_execute = menu_plugin_execute;
1357 pmenu_item_insert(m, i, 7);
1360 i = pmenu_item_create(m, _("Reboot"));
1362 i = pmenu_item_create(m, _("Exit to shell"));
1363 i->on_execute = pmenu_exit_cb;
1364 pmenu_item_insert(m, i, 8);
1366 result = pmenu_setup(m);
1369 pb_log("%s:%d: pmenu_setup failed: %s\n", __func__, __LINE__,
1374 m->help_title = _("main menu");
1375 m->help_text = &main_menu_help_text;
1377 menu_opts_off(m->ncm, O_SHOWDESC);
1378 set_menu_mark(m->ncm, " *");
1379 set_current_item(m->ncm, i->nci);
1389 * plugin_menu_init: Set up the plugin menu instance
1391 static struct pmenu *plugin_menu_init(struct cui *cui)
1393 struct pmenu_item *i;
1397 m = pmenu_init(cui, 2, cui_plugin_menu_exit);
1398 m->scr.frame.ltitle = talloc_asprintf(m, _("Petitboot Plugins"));
1399 m->scr.frame.rtitle = talloc_asprintf(m, "%s", "");
1400 m->scr.frame.help = talloc_strdup(m,
1401 _("Enter=install, e=details, x=exit, h=help"));
1402 m->scr.frame.status = talloc_asprintf(m,
1403 _("Available Petitboot Plugins"));
1405 /* add a separator */
1406 i = pmenu_item_create(m, " ");
1407 item_opts_off(i->nci, O_SELECTABLE);
1408 pmenu_item_insert(m, i, 0);
1410 i = pmenu_item_create(m, _("Return to Main Menu"));
1411 i->on_execute = pmenu_exit_cb;
1412 pmenu_item_insert(m, i, 1);
1414 result = pmenu_setup(m);
1417 pb_log("%s:%d: pmenu_setup failed: %s\n", __func__, __LINE__,
1422 m->help_title = _("plugin menu");
1423 m->help_text = &plugin_menu_help_text;
1432 static struct discover_client_ops cui_client_ops = {
1434 .boot_option_add = cui_boot_option_add,
1435 .device_remove = cui_device_remove,
1436 .plugin_option_add = cui_plugin_option_add,
1437 .plugins_remove = cui_plugins_remove,
1438 .update_status = cui_update_status,
1439 .update_sysinfo = cui_update_sysinfo,
1440 .update_config = cui_update_config,
1443 /* cui_server_wait - Connect to the discover server.
1444 * @arg: Pointer to the cui instance.
1446 * A timeout callback that attempts to connect to the discover server; on
1447 * failure it registers itself with a one second timeout to try again.
1448 * On success the cui->client struct will be set.
1450 * Since this updates the status line when called it must not be called
1451 * before the UI is ready.
1453 static int cui_server_wait(void *arg)
1455 struct cui *cui = cui_from_arg(arg);
1458 pb_debug("We already have a server!\n");
1462 /* We haven't yet connected to the server */
1463 pb_log("Trying to connect...\n");
1464 cui->client = discover_client_init(cui->waitset,
1465 &cui_client_ops, cui);
1468 waiter_register_timeout(cui->waitset, 1000, cui_server_wait,
1470 nc_scr_status_printf(cui->current,
1471 "Info: Waiting for device discovery");
1473 nc_scr_status_free(cui->current);
1474 talloc_steal(cui, cui->client);
1476 if (cui->has_input) {
1477 pb_log("Aborting default boot on pb-discover connect\n");
1478 discover_client_cancel_default(cui->client);
1481 if (cui->autoboot_opt) {
1482 pb_log("Sending autoboot override on pb-discover connect\n");
1483 discover_client_send_temp_autoboot(cui->client,
1492 * cui_init - Setup the cui instance.
1493 * @platform_info: A value for the struct cui platform_info member.
1495 * Returns a pointer to a struct cui on success, or NULL on error.
1497 * Allocates the cui instance, sets up the client and stdin waiters, and
1498 * sets up the ncurses menu screen.
1501 struct cui *cui_init(void* platform_info,
1502 int (*js_map)(const struct js_event *e), int start_daemon, int timeout)
1507 cui = talloc_zero(NULL, struct cui);
1509 pb_log_fn("alloc cui failed.\n");
1510 fprintf(stderr, _("%s: alloc cui failed.\n"), __func__);
1514 cui->c_sig = pb_cui_sig;
1515 cui->platform_info = platform_info;
1516 cui->waitset = waitset_create(cui);
1517 cui->statuslog = statuslog_init(cui);
1519 process_init(cui, cui->waitset, false);
1521 /* Loop here for scripts that just started the server. */
1524 for (i = start_daemon ? 2 : 15; i && timeout; i--) {
1525 cui->client = discover_client_init(cui->waitset,
1526 &cui_client_ops, cui);
1527 if (cui->client || !i)
1529 pb_log_fn("waiting for server %d\n", i);
1533 if (!cui->client && start_daemon) {
1538 result = pb_start_daemon(cui);
1543 pb_log_fn("discover_client_init failed.\n");
1544 fprintf(stderr, _("%s: error: discover_client_init failed.\n"),
1546 fprintf(stderr, _("could not start pb-discover, the petitboot "
1548 goto fail_client_init;
1551 if (!cui->client && !timeout) {
1552 /* Have the first timeout fire immediately so we can check
1553 * for the server as soon as the UI is ready */
1554 waiter_register_timeout(cui->waitset, 0,
1555 cui_server_wait, cui);
1556 } else if (!cui->client) {
1557 pb_log_fn("discover_client_init failed.\n");
1558 fprintf(stderr, _("%s: error: discover_client_init failed.\n"),
1560 fprintf(stderr, _("check that pb-discover, "
1561 "the petitboot daemon is running.\n"));
1562 goto fail_client_init;
1566 talloc_steal(cui, cui->client);
1569 cui->main = main_menu_init(cui);
1571 goto fail_client_init;
1573 cui->plugin_menu = plugin_menu_init(cui);
1574 if (!cui->plugin_menu)
1575 goto fail_client_init;
1577 waiter_register_io(cui->waitset, STDIN_FILENO, WAIT_IN,
1578 cui_process_key, cui);
1582 cui->pjs = pjs_init(cui, js_map);
1585 waiter_register_io(cui->waitset, pjs_get_fd(cui->pjs),
1586 WAIT_IN, cui_process_js, cui);
1598 * cui_cancel_autoboot_on_exit - On exit spin until the server is available.
1600 * If the program exits before connecting to the server autoboot won't be
1601 * cancelled even though there has been keyboard activity. A child is forked
1602 * which will spin until the server is connected and told to cancel autoboot.
1604 static void cui_cancel_autoboot_on_exit(struct cui *cui)
1609 /* Fork a child to tell the server to cancel autoboot */
1612 cui_detached = true;
1614 /* Loop until connection established */
1615 while (!cui->client) {
1616 cui->client = discover_client_init(cui->waitset,
1617 &cui_client_ops, cui);
1622 talloc_steal(cui, cui->client);
1623 discover_client_cancel_default(cui->client);
1627 pb_log("Failed to fork child on exit: %m\n");
1629 discover_client_cancel_default(cui->client);
1633 * cui_run - The main cui program loop.
1634 * @cui: The cui instance.
1635 * @main: The menu to use as the main menu.
1637 * Runs the cui engine. Does not return until indicated to do so by some
1638 * user action, or an error occurs. Frees the cui object on return.
1639 * Returns 0 on success (return to shell), -1 on error (should restart).
1642 int cui_run(struct cui *cui)
1647 cui->current = &cui->main->scr;
1648 cui->default_item = 0;
1650 nc_scr_post(cui->current);
1653 int result = waiter_poll(cui->waitset);
1656 pb_log_fn("poll: %s\n", strerror(errno));
1663 while (cui->resize) {
1665 cui_handle_resize(cui);
1669 cui_cancel_autoboot_on_exit(cui);
1673 return cui->abort ? 0 : -1;