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_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]);
252 nc_scr_unpost(cui->current);
259 result = process_run_sync(process);
264 redrawwin(cui->current->main_ncw);
265 nc_scr_post(cui->current);
268 pb_log_fn("failed: '%s'\n", cmd_argv[0]);
269 nc_scr_status_printf(cui->current, _("Failed: %s"),
273 process_release(process);
278 int cui_run_cmd_from_item(struct pmenu_item *item)
280 struct cui *cui = cui_from_item(item);
281 const char **cmd_argv = item->data;
283 return cui_run_cmd(cui, cmd_argv);
287 * cui_boot - A generic cb to run kexec.
290 static int cui_boot(struct pmenu_item *item)
293 struct cui *cui = cui_from_item(item);
294 struct cui_opt_data *cod = cod_from_item(item);
296 assert(cui->current == &cui->main->scr);
298 pb_debug("%s: %s\n", __func__, cod->name);
300 nc_scr_status_printf(cui->current, _("Booting %s..."), cod->name);
302 result = discover_client_boot(cui->client, NULL, cod->opt, cod->bd);
305 nc_scr_status_printf(cui->current,
306 _("Failed: boot %s"), cod->bd->image);
312 static void cui_boot_editor_on_exit(struct cui *cui,
313 struct pmenu_item *item,
314 struct pb_boot_data *bd)
316 struct pmenu *menu = cui->main;
317 struct cui_opt_data *cod;
318 int idx, top, rows, cols;
319 static int user_idx = 0;
321 /* Was the edit cancelled? */
323 cui_set_current(cui, &cui->main->scr);
324 talloc_free(cui->boot_editor);
325 cui->boot_editor = NULL;
329 /* Is this was a new item, we'll need to update the menu */
333 cod = talloc_zero(NULL, struct cui_opt_data);
334 cod->name = talloc_asprintf(cod, _("User item %u"), ++user_idx);
336 item = pmenu_item_create(menu, cod->name);
342 item->on_edit = cui_item_edit;
343 item->on_execute = cui_boot;
346 talloc_steal(item, cod);
348 /* Detach the items array. */
349 set_menu_items(menu->ncm, NULL);
351 /* Insert new item at insert_pt. */
352 insert_pt = pmenu_grow(menu, 1);
353 pmenu_item_insert(menu, item, insert_pt);
355 /* Re-attach the items array. */
356 set_menu_items(menu->ncm, menu->items);
358 /* If our index is above the current top row, align
359 * us to the new top. Otherwise, align us to the new
361 menu_format(cui->main->ncm, &rows, &cols);
362 top = top_row(cui->main->ncm);
363 idx = item_index(item->nci);
368 top = idx < rows ? 0 : idx - rows + 1;
370 set_top_row(cui->main->ncm, top);
371 set_current_item(item->pmenu->ncm, item->nci);
373 nc_scr_post(&menu->scr);
378 cod->bd = talloc_steal(cod, bd);
381 cui_set_current(cui, &cui->main->scr);
382 talloc_free(cui->boot_editor);
383 cui->boot_editor = NULL;
386 void cui_item_edit(struct pmenu_item *item)
388 struct cui *cui = cui_from_item(item);
389 cui->boot_editor = boot_editor_init(cui, item, cui->sysinfo,
390 cui_boot_editor_on_exit);
391 cui_set_current(cui, boot_editor_scr(cui->boot_editor));
394 void cui_item_new(struct pmenu *menu)
396 struct cui *cui = cui_from_pmenu(menu);
397 cui->boot_editor = boot_editor_init(cui, NULL, cui->sysinfo,
398 cui_boot_editor_on_exit);
399 cui_set_current(cui, boot_editor_scr(cui->boot_editor));
402 static void cui_sysinfo_exit(struct cui *cui)
404 cui_set_current(cui, &cui->main->scr);
405 talloc_free(cui->sysinfo_screen);
406 cui->sysinfo_screen = NULL;
409 void cui_show_sysinfo(struct cui *cui)
411 cui->sysinfo_screen = sysinfo_screen_init(cui, cui->sysinfo,
413 cui_set_current(cui, sysinfo_screen_scr(cui->sysinfo_screen));
416 static void cui_config_exit(struct cui *cui)
418 cui_set_current(cui, &cui->main->scr);
419 talloc_free(cui->config_screen);
420 cui->config_screen = NULL;
423 void cui_show_config(struct cui *cui)
425 cui->config_screen = config_screen_init(cui, cui->config,
426 cui->sysinfo, cui_config_exit);
427 cui_set_current(cui, config_screen_scr(cui->config_screen));
430 static void cui_lang_exit(struct cui *cui)
432 cui_set_current(cui, &cui->main->scr);
433 talloc_free(cui->lang_screen);
434 cui->lang_screen = NULL;
437 void cui_show_lang(struct cui *cui)
439 cui->lang_screen = lang_screen_init(cui, cui->config, cui_lang_exit);
440 cui_set_current(cui, lang_screen_scr(cui->lang_screen));
443 static void cui_statuslog_exit(struct cui *cui)
445 cui_set_current(cui, &cui->main->scr);
446 talloc_free(cui->statuslog_screen);
447 cui->statuslog_screen = NULL;
450 void cui_show_statuslog(struct cui *cui)
452 cui->statuslog_screen = statuslog_screen_init(cui, cui_statuslog_exit);
453 cui_set_current(cui, statuslog_screen_scr(cui->statuslog_screen));
456 static void cui_add_url_exit(struct cui *cui)
458 cui_set_current(cui, &cui->main->scr);
459 talloc_free(cui->add_url_screen);
460 cui->add_url_screen = NULL;
463 static void cui_plugin_exit(struct cui *cui)
465 cui_set_current(cui, &cui->plugin_menu->scr);
466 talloc_free(cui->plugin_screen);
467 cui->plugin_screen = NULL;
470 static void cui_plugin_menu_exit(struct pmenu *menu)
472 struct cui *cui = cui_from_pmenu(menu);
473 cui_set_current(cui, &cui->main->scr);
476 void cui_show_add_url(struct cui *cui)
478 cui->add_url_screen = add_url_screen_init(cui, cui_add_url_exit);
479 cui_set_current(cui, add_url_screen_scr(cui->add_url_screen));
482 void cui_show_plugin_menu(struct cui *cui)
484 cui_set_current(cui, &cui->plugin_menu->scr);
487 void cui_show_plugin(struct pmenu_item *item)
489 struct cui *cui = cui_from_item(item);
490 cui->plugin_screen = plugin_screen_init(cui, item, cui_plugin_exit);
491 cui_set_current(cui, plugin_screen_scr(cui->plugin_screen));
494 static void cui_help_exit(struct cui *cui)
496 cui_set_current(cui, help_screen_return_scr(cui->help_screen));
497 talloc_free(cui->help_screen);
498 cui->help_screen = NULL;
501 void cui_show_help(struct cui *cui, const char *title,
502 const struct help_text *text)
507 if (cui->help_screen)
510 cui->help_screen = help_screen_init(cui, cui->current,
511 title, text, cui_help_exit);
513 if (cui->help_screen)
514 cui_set_current(cui, help_screen_scr(cui->help_screen));
517 static void cui_subset_exit(struct cui *cui)
519 cui_set_current(cui, subset_screen_return_scr(cui->subset_screen));
520 talloc_free(cui->subset_screen);
521 cui->subset_screen = NULL;
524 void cui_show_subset(struct cui *cui, const char *title,
530 if (cui->subset_screen)
533 cui->subset_screen = subset_screen_init(cui, cui->current,
534 title, arg, cui_subset_exit);
536 if (cui->subset_screen)
537 cui_set_current(cui, subset_screen_scr(cui->subset_screen));
541 * cui_set_current - Set the currently active screen and redraw it.
544 struct nc_scr *cui_set_current(struct cui *cui, struct nc_scr *scr)
548 DBGS("%p -> %p\n", cui->current, scr);
550 assert(cui->current != scr);
557 nc_scr_post(cui->current);
562 static bool set_temp_autoboot_opt(struct cui *cui, struct autoboot_option *opt)
564 cui->autoboot_opt = opt;
566 discover_client_send_temp_autoboot(cui->client, opt);
571 static bool key_cancels_boot(int key)
578 for (i = 0; i < ARRAY_SIZE(autoboot_override_keys); i++)
579 if (key == autoboot_override_keys[i].key)
585 static bool process_global_keys(struct cui *cui, int key)
591 if (cui->current && cui->current->main_ncw)
596 /* check for autoboot override keys */
597 for (i = 0; i < ARRAY_SIZE(autoboot_override_keys); i++) {
598 if (key != autoboot_override_keys[i].key)
601 pb_log("Sending temporary autoboot override\n");
602 set_temp_autoboot_opt(cui, &autoboot_override_keys[i].opt);
610 * cui_process_key - Process input on stdin.
613 static int cui_process_key(void *arg)
615 struct cui *cui = cui_from_arg(arg);
620 assert(cui->current);
625 pb_debug("%s: got key %d\n", __func__, c);
632 * If this is a console code sequence try to parse it
633 * and don't treat this as a key press.
636 if (grab != ERR && grab != 27) {
638 pb_debug("%s: Caught unhandled command sequence\n",
640 sequence = handle_control_sequence(cui, c);
641 pb_debug("Caught sequence ");
643 pb_debug("(%zu): ", strlen(sequence));
644 for (i = 0; i < strlen(sequence); i++)
645 pb_debug("0%o ", sequence[i]);
648 pb_debug("(0): (none)\n");
653 if (!cui->has_input && key_cancels_boot(c)) {
654 cui->has_input = true;
656 pb_log("UI input received (key = %d), aborting "
657 "default boot\n", c);
658 discover_client_cancel_default(cui->client);
660 pb_log("UI input received (key = %d), aborting "
661 "once server connects\n", c);
665 if (process_global_keys(cui, c))
668 cui->current->process_key(cui->current, c);
675 * cui_process_js - Process joystick events.
678 static int cui_process_js(void *arg)
680 struct cui *cui = cui_from_arg(arg);
683 c = pjs_process_event(cui->pjs);
687 cui_process_key(arg);
694 * cui_handle_resize - Handle the term resize.
697 static void cui_handle_resize(struct cui *cui)
701 if (ioctl(1, TIOCGWINSZ, &ws) == -1) {
702 pb_log_fn("ioctl failed: %s\n", strerror(errno));
706 pb_debug("%s: {%u,%u}\n", __func__, ws.ws_row, ws.ws_col);
708 wclear(cui->current->main_ncw);
709 resize_term(ws.ws_row, ws.ws_col);
710 cui->current->resize(cui->current);
712 /* For some reason this makes ncurses redraw the screen */
714 redrawwin(cui->current->main_ncw);
715 wrefresh(cui->current->main_ncw);
719 * cui_device_add - Client device_add callback.
721 * Creates menu_items for all the device boot_options and inserts those
722 * menu_items into the main menu. Redraws the main menu if it is active.
723 * If a 'plugin' type boot_option appears the plugin menu is updated instead.
726 static int cui_boot_option_add(struct device *dev, struct boot_option *opt,
729 struct pmenu_item *i, *dev_hdr = NULL;
730 struct cui *cui = cui_from_arg(arg);
731 struct cui_opt_data *cod;
732 const char *tab = " ";
733 unsigned int insert_pt;
734 int result, rows, cols;
740 plugin_option = opt->type == DISCOVER_PLUGIN_OPTION;
741 menu = plugin_option ? cui->plugin_menu : cui->main;
743 pb_debug("%s: %p %s\n", __func__, opt, opt->id);
745 selected = current_item(menu->ncm);
746 menu_format(menu->ncm, &rows, &cols);
748 if (cui->current == &cui->main->scr)
749 nc_scr_unpost(cui->current);
750 if (plugin_option && cui->current == &cui->plugin_menu->scr)
751 nc_scr_unpost(cui->current);
753 /* Check if the boot device is new */
754 dev_hdr = pmenu_find_device(menu, dev, opt);
756 /* All actual boot entries are 'tabbed' across */
757 name = talloc_asprintf(menu, "%s%s",
758 tab, opt->name ? : "Unknown Name");
760 /* Save the item in opt->ui_info for cui_device_remove() */
761 opt->ui_info = i = pmenu_item_create(menu, name);
768 i->on_execute = plugin_install_plugin;
770 i->on_edit = cui_item_edit;
771 i->on_execute = cui_boot;
774 i->data = cod = talloc(i, struct cui_opt_data);
777 cod->opt_hash = pb_opt_hash(dev, opt);
778 cod->name = opt->name;
781 cod->pd = talloc(i, struct pb_plugin_data);
782 cod->pd->plugin_file = talloc_strdup(cod,
783 opt->boot_image_file);
785 cod->bd = talloc(i, struct pb_boot_data);
786 cod->bd->image = talloc_strdup(cod->bd, opt->boot_image_file);
787 cod->bd->initrd = talloc_strdup(cod->bd, opt->initrd_file);
788 cod->bd->dtb = talloc_strdup(cod->bd, opt->dtb_file);
789 cod->bd->args = talloc_strdup(cod->bd, opt->boot_args);
790 cod->bd->args_sig_file = talloc_strdup(cod->bd, opt->args_sig_file);
793 /* This disconnects items array from menu. */
794 result = set_menu_items(menu->ncm, NULL);
797 pb_log_fn("set_menu_items failed: %d\n", result);
799 /* Insert new items at insert_pt. */
801 insert_pt = pmenu_grow(menu, 2);
802 pmenu_item_insert(menu, dev_hdr, insert_pt);
803 pb_log("%s: adding new device hierarchy %s\n",
804 __func__, opt->device_id);
805 pmenu_item_insert(menu, i, insert_pt+1);
807 insert_pt = pmenu_grow(menu, 1);
808 pmenu_item_add(menu, i, insert_pt);
812 pb_log_fn("adding plugin '%s'\n", cod->name);
813 pb_log(" file '%s'\n", cod->pd->plugin_file);
815 pb_log_fn("adding opt '%s'\n", cod->name);
816 pb_log(" image '%s'\n", cod->bd->image);
817 pb_log(" initrd '%s'\n", cod->bd->initrd);
818 pb_log(" args '%s'\n", cod->bd->args);
819 pb_log(" argsig '%s'\n", cod->bd->args_sig_file);
822 /* Update the plugin menu label if needed */
824 struct pmenu_item *item;
826 result = set_menu_items(cui->main->ncm, NULL);
827 for (j = 0 ; j < cui->main->item_count; j++) {
828 item = item_userptr(cui->main->items[j]);
829 if (strncmp(item->nci->name.str, "Plugins", strlen("Plugins")))
832 char *label = talloc_asprintf(item, "Plugins (%u)",
834 pmenu_item_update(item, label);
838 result = set_menu_items(cui->main->ncm, cui->main->items);
840 pb_log_fn("set_menu_items failed: %d\n", result);
843 /* Re-attach the items array. */
844 result = set_menu_items(menu->ncm, menu->items);
847 pb_log_fn("set_menu_items failed: %d\n", result);
850 pb_log("%s\n", __func__);
851 pmenu_dump_items(menu->items,
852 item_count(menu->ncm) + 1);
855 if (!item_visible(selected)) {
858 top = top_row(menu->ncm);
859 idx = item_index(selected);
861 /* If our index is above the current top row, align
862 * us to the new top. Otherwise, align us to the new
864 top = top < idx ? idx - rows + 1 : idx;
866 set_top_row(menu->ncm, top);
867 set_current_item(menu->ncm, selected);
870 if (cui->current == &menu->scr)
871 nc_scr_post(cui->current);
872 if (plugin_option && cui->current == &cui->main->scr)
873 nc_scr_post(cui->current);
879 * cui_device_remove - Client device remove callback.
881 * Removes all the menu_items for the device from the main menu and redraws the
882 * main menu if it is active.
884 static void cui_device_remove(struct device *dev, void *arg)
886 struct cui *cui = cui_from_arg(arg);
887 struct boot_option *opt;
889 int rows, cols, top, last;
892 pb_log_fn("%p %s\n", dev, dev->id);
894 if (cui->current == &cui->main->scr)
895 nc_scr_unpost(cui->current);
896 if (cui->current == &cui->plugin_menu->scr)
897 nc_scr_unpost(cui->current);
899 /* This disconnects items array from menu. */
901 result = set_menu_items(cui->main->ncm, NULL);
902 result |= set_menu_items(cui->plugin_menu->ncm, NULL);
905 pb_log_fn("set_menu_items failed: %d\n", result);
907 list_for_each_entry(&dev->boot_options, opt, list) {
908 struct pmenu_item *item = pmenu_item_from_arg(opt->ui_info);
910 assert(pb_protocol_device_cmp(dev, cod_from_item(item)->dev));
911 if (opt->type == DISCOVER_PLUGIN_OPTION)
912 pmenu_remove(cui->plugin_menu, item);
914 pmenu_remove(cui->main, item);
917 /* Manually remove remaining device hierarchy item */
918 for (i=0; i < cui->main->item_count; i++) {
919 struct pmenu_item *item = item_userptr(cui->main->items[i]);
920 if (!item || !item->data )
923 struct cui_opt_data *data = item->data;
924 if (data && data->dev && data->dev == dev)
925 pmenu_remove(cui->main,item);
927 /* Look in plugins menu too */
928 for (i=0; i < cui->plugin_menu->item_count; i++) {
929 struct pmenu_item *item = item_userptr(cui->plugin_menu->items[i]);
930 if (!item || !item->data )
933 struct cui_opt_data *data = item->data;
934 if (data && data->dev && data->dev == dev)
935 pmenu_remove(cui->plugin_menu,item);
938 /* Re-attach the items array. */
940 result = set_menu_items(cui->main->ncm, cui->main->items);
941 result |= set_menu_items(cui->plugin_menu->ncm, cui->plugin_menu->items);
943 /* Move cursor to 'Exit' menu entry for the main menu.. */
944 menu_format(cui->main->ncm, &rows, &cols);
945 last = cui->main->item_count - 1;
946 set_current_item(cui->main->ncm, cui->main->items[last]);
947 if (!item_visible(cui->main->items[last])) {
948 top = last < rows ? 0 : last - rows + 1;
949 set_top_row(cui->main->ncm, top);
952 /* ..and the plugin menu */
953 menu_format(cui->plugin_menu->ncm, &rows, &cols);
954 last = cui->plugin_menu->item_count - 1;
955 set_current_item(cui->plugin_menu->ncm, cui->plugin_menu->items[last]);
956 if (!item_visible(cui->plugin_menu->items[last])) {
957 top = last < rows ? 0 : last - rows + 1;
958 set_top_row(cui->plugin_menu->ncm, top);
962 pb_log_fn("set_menu_items failed: %d\n", result);
965 pb_log("%s\n", __func__);
966 pmenu_dump_items(cui->main->items,
967 item_count(cui->main->ncm) + 1);
970 if (cui->current == &cui->main->scr)
971 nc_scr_post(cui->current);
972 if (cui->current == &cui->plugin_menu->scr)
973 nc_scr_post(cui->current);
976 static void cui_update_status(struct status *status, void *arg)
978 struct cui *cui = cui_from_arg(arg);
980 statuslog_append_steal(cui, cui->statuslog, status);
982 /* Ignore status messages from the backlog */
983 if (!status->backlog)
984 nc_scr_status_printf(cui->current, "%s", status->message);
988 * Handle a new installed plugin option and update its associated
989 * (uninstalled) menu item if it exists.
991 static int cui_plugin_option_add(struct plugin_option *opt, void *arg)
993 struct cui_opt_data *cod;
994 struct cui *cui = cui_from_arg(arg);
995 struct pmenu_item *item = NULL;
996 struct boot_option *dummy_opt;
1002 /* Find uninstalled plugin by matching on plugin_file */
1003 for (i = 0; i < cui->plugin_menu->item_count; i++) {
1004 item = item_userptr(cui->plugin_menu->items[i]);
1007 cod = cod_from_item(item);
1008 if (!cod || !cod->pd)
1010 if (strncmp(cod->pd->plugin_file, opt->plugin_file,
1011 strlen(cod->pd->plugin_file)) == 0)
1016 * If pb-plugin was run manually there may not be an associated
1017 * plugin-type boot_option. Pass a fake device and option to
1018 * cui_boot_option_add() so we have an item to work with.
1020 if (!item || i >= cui->plugin_menu->item_count) {
1021 pb_log("New plugin option %s doesn't have a source item\n",
1023 dev = talloc_zero(cui, struct device);
1024 dev->id = dev->name = talloc_asprintf(dev, "(unknown)");
1025 dev->type = DEVICE_TYPE_UNKNOWN;
1026 dummy_opt = talloc_zero(cui, struct boot_option);
1027 dummy_opt->device_id = talloc_strdup(dummy_opt, dev->id);
1028 dummy_opt->id = dummy_opt->name = talloc_asprintf(dummy_opt, "dummy");
1029 dummy_opt->boot_image_file = talloc_strdup(dummy_opt, opt->plugin_file);
1030 dummy_opt->type = DISCOVER_PLUGIN_OPTION;
1031 cui_boot_option_add(dev, dummy_opt, cui);
1036 * If this option was faked above move the context under
1037 * the item so it is cleaned up later in cui_plugins_remove().
1039 if (strcmp(cod->opt->id, "dummy") == 0 &&
1040 cod->dev->type == DEVICE_TYPE_UNKNOWN) {
1041 talloc_steal(item, cod->dev);
1042 talloc_steal(item, cod->opt);
1045 talloc_free(cod->name);
1046 /* Name is still tabbed across */
1047 cod->name = talloc_asprintf(cod, _(" %s [installed]"), opt->name);
1050 item->on_execute = NULL;
1051 item->on_edit = cui_show_plugin;
1053 if (cui->current == &cui->plugin_menu->scr)
1054 nc_scr_unpost(cui->current);
1056 /* This disconnects items array from menu. */
1057 result = set_menu_items(cui->plugin_menu->ncm, NULL);
1060 pmenu_item_update(item, cod->name);
1062 /* Re-attach the items array. */
1063 result = set_menu_items(cui->plugin_menu->ncm, cui->plugin_menu->items);
1065 if (cui->current == &cui->plugin_menu->scr)
1066 nc_scr_post(cui->current);
1072 * Most plugin menu items will be removed via cui_device_remove(). However if
1073 * pb-plugin has been run manually it is possible that there a plugin items
1074 * not associated with a device - remove them here.
1076 static int cui_plugins_remove(void *arg)
1078 struct cui *cui = cui_from_arg(arg);
1079 struct pmenu_item *item = NULL;
1080 struct cui_opt_data *cod;
1083 pb_debug("%s\n", __func__);
1085 if (cui->current == &cui->plugin_menu->scr)
1086 nc_scr_unpost(cui->current);
1087 if (cui->current == &cui->main->scr)
1088 nc_scr_unpost(cui->current);
1090 /* This disconnects items array from menu. */
1091 set_menu_items(cui->plugin_menu->ncm, NULL);
1093 while (i < cui->plugin_menu->item_count) {
1094 item = item_userptr(cui->plugin_menu->items[i]);
1095 if (!item || !item->data) {
1099 cod = cod_from_item(item);
1100 if (!cod->opt && !cod->dev) {
1105 pmenu_remove(cui->plugin_menu, item);
1106 /* plugin_menu entries will shift, jump to bottom to make sure
1107 * we remove all plugin option items */
1111 /* Re-attach the items array. */
1112 set_menu_items(cui->plugin_menu->ncm, cui->plugin_menu->items);
1114 set_menu_items(cui->main->ncm, NULL);
1115 for (i = 0; i < cui->main->item_count; i++) {
1116 item = item_userptr(cui->main->items[i]);
1117 if (strncmp(item->nci->name.str, "Plugins", strlen("Plugins")))
1120 pmenu_item_update(item, "Plugins (0)");
1124 set_menu_items(cui->main->ncm, cui->main->items);
1126 if (cui->current == &cui->main->scr)
1127 nc_scr_post(cui->current);
1129 /* If we're currently in a plugin screen jump back to the plugin menu */
1130 if (cui->plugin_screen &&
1131 cui->current == plugin_screen_scr(cui->plugin_screen))
1132 cui_plugin_exit(cui);
1137 static void cui_update_mm_title(struct cui *cui)
1139 struct nc_frame *frame = &cui->main->scr.frame;
1141 talloc_free(frame->rtitle);
1143 frame->rtitle = talloc_strdup(cui->main, cui->sysinfo->type);
1144 if (cui->sysinfo->identifier)
1145 frame->rtitle = talloc_asprintf_append(frame->rtitle,
1146 " %s", cui->sysinfo->identifier);
1148 if (cui->current == &cui->main->scr)
1149 nc_scr_post(cui->current);
1151 frame = &cui->plugin_menu->scr.frame;
1153 talloc_free(frame->rtitle);
1155 frame->rtitle = talloc_strdup(cui->main, cui->sysinfo->type);
1156 if (cui->sysinfo->identifier)
1157 frame->rtitle = talloc_asprintf_append(frame->rtitle,
1158 " %s", cui->sysinfo->identifier);
1160 if (cui->current == &cui->main->scr)
1161 nc_scr_post(cui->current);
1164 static void cui_update_sysinfo(struct system_info *sysinfo, void *arg)
1166 struct cui *cui = cui_from_arg(arg);
1167 cui->sysinfo = talloc_steal(cui, sysinfo);
1169 /* if we're currently displaying the system info screen, inform it
1170 * of the updated information. */
1171 if (cui->sysinfo_screen)
1172 sysinfo_screen_update(cui->sysinfo_screen, sysinfo);
1174 if (cui->subset_screen)
1175 subset_screen_update(cui->subset_screen);
1177 /* ... and do the same with the config screen... */
1178 if (cui->config_screen)
1179 config_screen_update(cui->config_screen, cui->config, sysinfo);
1181 /* ... and the boot editor. */
1182 if (cui->boot_editor)
1183 boot_editor_update(cui->boot_editor, sysinfo);
1185 cui_update_mm_title(cui);
1188 static void cui_update_language(struct cui *cui, char *lang)
1193 cur_lang = setlocale(LC_ALL, NULL);
1194 if (cur_lang && !strcmp(cur_lang, lang))
1197 setlocale(LC_ALL, lang);
1199 /* we'll need to update the menu: drop all items and repopulate */
1200 repost_menu = cui->current == &cui->main->scr ||
1201 cui->current == &cui->plugin_menu->scr;
1203 nc_scr_unpost(cui->current);
1205 talloc_free(cui->main);
1206 cui->main = main_menu_init(cui);
1207 cui->plugin_menu = plugin_menu_init(cui);
1210 cui->current = &cui->main->scr;
1211 nc_scr_post(cui->current);
1214 discover_client_enumerate(cui->client);
1217 static void cui_update_config(struct config *config, void *arg)
1219 struct cui *cui = cui_from_arg(arg);
1220 cui->config = talloc_steal(cui, config);
1223 cui_update_language(cui, config->lang);
1225 if (cui->subset_screen)
1226 subset_screen_update(cui->subset_screen);
1228 if (cui->config_screen)
1229 config_screen_update(cui->config_screen, config, cui->sysinfo);
1231 if (config->safe_mode)
1232 nc_scr_status_printf(cui->current,
1233 _("SAFE MODE: select '%s' to continue"),
1234 _("Rescan devices"));
1237 int cui_send_config(struct cui *cui, struct config *config)
1239 return discover_client_send_config(cui->client, config);
1242 int cui_send_url(struct cui *cui, char * url)
1244 return discover_client_send_url(cui->client, url);
1247 int cui_send_plugin_install(struct cui *cui, char *file)
1249 return discover_client_send_plugin_install(cui->client, file);
1252 void cui_send_reinit(struct cui *cui)
1254 discover_client_send_reinit(cui->client);
1257 static int menu_sysinfo_execute(struct pmenu_item *item)
1259 cui_show_sysinfo(cui_from_item(item));
1263 static int menu_config_execute(struct pmenu_item *item)
1265 cui_show_config(cui_from_item(item));
1269 static int menu_lang_execute(struct pmenu_item *item)
1271 cui_show_lang(cui_from_item(item));
1275 static int menu_statuslog_execute(struct pmenu_item *item)
1277 cui_show_statuslog(cui_from_item(item));
1281 static int menu_reinit_execute(struct pmenu_item *item)
1283 if (cui_from_item(item)->client)
1284 cui_send_reinit(cui_from_item(item));
1288 static int menu_add_url_execute(struct pmenu_item *item)
1290 if (cui_from_item(item)->client)
1291 cui_show_add_url(cui_from_item(item));
1295 static int menu_plugin_execute(struct pmenu_item *item)
1297 if (cui_from_item(item)->client)
1298 cui_show_plugin_menu(cui_from_item(item));
1303 * pb_mm_init - Setup the main menu instance.
1305 static struct pmenu *main_menu_init(struct cui *cui)
1307 struct pmenu_item *i;
1310 bool lockdown = lockdown_active();
1312 m = pmenu_init(cui, 9, lockdown ? cui_abort_on_exit : cui_on_exit);
1314 pb_log_fn("failed\n");
1319 m->hot_keys = talloc_array(m, hot_key_fn, m->n_hot_keys);
1321 pb_log_fn("failed to allocate hot_keys\n");
1325 m->hot_keys[0] = pmenu_main_hot_keys;
1326 m->on_new = cui_item_new;
1328 m->scr.frame.ltitle = talloc_asprintf(m,
1329 "Petitboot (" PACKAGE_VERSION ")");
1330 m->scr.frame.rtitle = NULL;
1331 m->scr.frame.help = talloc_strdup(m,
1332 _("Enter=accept, e=edit, n=new, x=exit, l=language, g=log, h=help"));
1333 m->scr.frame.status = talloc_strdup(m, _("Welcome to Petitboot"));
1335 /* add a separator */
1336 i = pmenu_item_create(m, " ");
1337 item_opts_off(i->nci, O_SELECTABLE);
1338 pmenu_item_insert(m, i, 0);
1340 /* add system items */
1341 i = pmenu_item_create(m, _("System information"));
1342 i->on_execute = menu_sysinfo_execute;
1343 pmenu_item_insert(m, i, 1);
1345 i = pmenu_item_create(m, _("System configuration"));
1346 i->on_execute = menu_config_execute;
1347 pmenu_item_insert(m, i, 2);
1349 i = pmenu_item_create(m, _("System status log"));
1350 i->on_execute = menu_statuslog_execute;
1351 pmenu_item_insert(m, i, 3);
1353 /* this label isn't translated, so we don't want a gettext() here */
1354 i = pmenu_item_create(m, "Language");
1355 i->on_execute = menu_lang_execute;
1356 pmenu_item_insert(m, i, 4);
1358 i = pmenu_item_create(m, _("Rescan devices"));
1359 i->on_execute = menu_reinit_execute;
1360 pmenu_item_insert(m, i, 5);
1362 i = pmenu_item_create(m, _("Retrieve config from URL"));
1363 i->on_execute = menu_add_url_execute;
1364 pmenu_item_insert(m, i, 6);
1366 i = pmenu_item_create(m, _("Plugins (0)"));
1367 i->on_execute = menu_plugin_execute;
1368 pmenu_item_insert(m, i, 7);
1371 i = pmenu_item_create(m, _("Reboot"));
1373 i = pmenu_item_create(m, _("Exit to shell"));
1374 i->on_execute = pmenu_exit_cb;
1375 pmenu_item_insert(m, i, 8);
1377 result = pmenu_setup(m);
1380 pb_log("%s:%d: pmenu_setup failed: %s\n", __func__, __LINE__,
1385 m->help_title = _("main menu");
1386 m->help_text = &main_menu_help_text;
1388 menu_opts_off(m->ncm, O_SHOWDESC);
1389 set_menu_mark(m->ncm, " *");
1390 set_current_item(m->ncm, i->nci);
1400 * plugin_menu_init: Set up the plugin menu instance
1402 static struct pmenu *plugin_menu_init(struct cui *cui)
1404 struct pmenu_item *i;
1408 m = pmenu_init(cui, 2, cui_plugin_menu_exit);
1409 m->scr.frame.ltitle = talloc_asprintf(m, _("Petitboot Plugins"));
1410 m->scr.frame.rtitle = talloc_asprintf(m, "%s", "");
1411 m->scr.frame.help = talloc_strdup(m,
1412 _("Enter=install, e=details, x=exit, h=help"));
1413 m->scr.frame.status = talloc_asprintf(m,
1414 _("Available Petitboot Plugins"));
1416 /* add a separator */
1417 i = pmenu_item_create(m, " ");
1418 item_opts_off(i->nci, O_SELECTABLE);
1419 pmenu_item_insert(m, i, 0);
1421 i = pmenu_item_create(m, _("Return to Main Menu"));
1422 i->on_execute = pmenu_exit_cb;
1423 pmenu_item_insert(m, i, 1);
1425 result = pmenu_setup(m);
1428 pb_log("%s:%d: pmenu_setup failed: %s\n", __func__, __LINE__,
1433 m->help_title = _("plugin menu");
1434 m->help_text = &plugin_menu_help_text;
1443 static struct discover_client_ops cui_client_ops = {
1445 .boot_option_add = cui_boot_option_add,
1446 .device_remove = cui_device_remove,
1447 .plugin_option_add = cui_plugin_option_add,
1448 .plugins_remove = cui_plugins_remove,
1449 .update_status = cui_update_status,
1450 .update_sysinfo = cui_update_sysinfo,
1451 .update_config = cui_update_config,
1454 /* cui_server_wait - Connect to the discover server.
1455 * @arg: Pointer to the cui instance.
1457 * A timeout callback that attempts to connect to the discover server; on
1458 * failure it registers itself with a one second timeout to try again.
1459 * On success the cui->client struct will be set.
1461 * Since this updates the status line when called it must not be called
1462 * before the UI is ready.
1464 static int cui_server_wait(void *arg)
1466 struct cui *cui = cui_from_arg(arg);
1469 pb_debug("We already have a server!\n");
1473 /* We haven't yet connected to the server */
1474 pb_log("Trying to connect...\n");
1475 cui->client = discover_client_init(cui->waitset,
1476 &cui_client_ops, cui);
1479 waiter_register_timeout(cui->waitset, 1000, cui_server_wait,
1481 nc_scr_status_printf(cui->current,
1482 "Info: Waiting for device discovery");
1484 nc_scr_status_free(cui->current);
1485 talloc_steal(cui, cui->client);
1487 if (cui->has_input) {
1488 pb_log("Aborting default boot on pb-discover connect\n");
1489 discover_client_cancel_default(cui->client);
1492 if (cui->autoboot_opt) {
1493 pb_log("Sending autoboot override on pb-discover connect\n");
1494 discover_client_send_temp_autoboot(cui->client,
1503 * cui_init - Setup the cui instance.
1504 * @platform_info: A value for the struct cui platform_info member.
1506 * Returns a pointer to a struct cui on success, or NULL on error.
1508 * Allocates the cui instance, sets up the client and stdin waiters, and
1509 * sets up the ncurses menu screen.
1512 struct cui *cui_init(void* platform_info,
1513 int (*js_map)(const struct js_event *e), int start_daemon, int timeout)
1518 cui = talloc_zero(NULL, struct cui);
1520 pb_log_fn("alloc cui failed.\n");
1521 fprintf(stderr, _("%s: alloc cui failed.\n"), __func__);
1525 cui->c_sig = pb_cui_sig;
1526 cui->platform_info = platform_info;
1527 cui->waitset = waitset_create(cui);
1528 cui->statuslog = statuslog_init(cui);
1530 process_init(cui, cui->waitset, false);
1532 /* Loop here for scripts that just started the server. */
1535 for (i = start_daemon ? 2 : 15; i && timeout; i--) {
1536 cui->client = discover_client_init(cui->waitset,
1537 &cui_client_ops, cui);
1538 if (cui->client || !i)
1540 pb_log_fn("waiting for server %d\n", i);
1544 if (!cui->client && start_daemon) {
1549 result = pb_start_daemon(cui);
1554 pb_log_fn("discover_client_init failed.\n");
1555 fprintf(stderr, _("%s: error: discover_client_init failed.\n"),
1557 fprintf(stderr, _("could not start pb-discover, the petitboot "
1559 goto fail_client_init;
1562 if (!cui->client && !timeout) {
1563 /* Have the first timeout fire immediately so we can check
1564 * for the server as soon as the UI is ready */
1565 waiter_register_timeout(cui->waitset, 0,
1566 cui_server_wait, cui);
1567 } else if (!cui->client) {
1568 pb_log_fn("discover_client_init failed.\n");
1569 fprintf(stderr, _("%s: error: discover_client_init failed.\n"),
1571 fprintf(stderr, _("check that pb-discover, "
1572 "the petitboot daemon is running.\n"));
1573 goto fail_client_init;
1577 talloc_steal(cui, cui->client);
1580 cui->main = main_menu_init(cui);
1582 goto fail_client_init;
1584 cui->plugin_menu = plugin_menu_init(cui);
1585 if (!cui->plugin_menu)
1586 goto fail_client_init;
1588 waiter_register_io(cui->waitset, STDIN_FILENO, WAIT_IN,
1589 cui_process_key, cui);
1593 cui->pjs = pjs_init(cui, js_map);
1596 waiter_register_io(cui->waitset, pjs_get_fd(cui->pjs),
1597 WAIT_IN, cui_process_js, cui);
1609 * cui_cancel_autoboot_on_exit - On exit spin until the server is available.
1611 * If the program exits before connecting to the server autoboot won't be
1612 * cancelled even though there has been keyboard activity. A child is forked
1613 * which will spin until the server is connected and told to cancel autoboot.
1615 static void cui_cancel_autoboot_on_exit(struct cui *cui)
1620 /* Fork a child to tell the server to cancel autoboot */
1623 cui_detached = true;
1625 /* Loop until connection established */
1626 while (!cui->client) {
1627 cui->client = discover_client_init(cui->waitset,
1628 &cui_client_ops, cui);
1633 talloc_steal(cui, cui->client);
1634 discover_client_cancel_default(cui->client);
1638 pb_log("Failed to fork child on exit: %m\n");
1640 discover_client_cancel_default(cui->client);
1644 * cui_run - The main cui program loop.
1645 * @cui: The cui instance.
1646 * @main: The menu to use as the main menu.
1648 * Runs the cui engine. Does not return until indicated to do so by some
1649 * user action, or an error occurs. Frees the cui object on return.
1650 * Returns 0 on success (return to shell), -1 on error (should restart).
1653 int cui_run(struct cui *cui)
1658 cui->current = &cui->main->scr;
1659 cui->default_item = 0;
1661 nc_scr_post(cui->current);
1664 int result = waiter_poll(cui->waitset);
1667 pb_log_fn("poll: %s\n", strerror(errno));
1674 while (cui->resize) {
1676 cui_handle_resize(cui);
1680 cui_cancel_autoboot_on_exit(cui);
1684 return cui->abort ? 0 : -1;