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);
62 static bool lockdown_active(void)
64 #if defined(SIGNED_BOOT) && defined(HARD_LOCKDOWN)
67 bool lockdown = false;
68 if (access(LOCKDOWN_FILE, F_OK) != -1)
74 static void cui_start(void)
76 initscr(); /* Initialize ncurses. */
77 cbreak(); /* Disable line buffering. */
78 noecho(); /* Disable getch() echo. */
79 keypad(stdscr, TRUE); /* Enable num keypad keys. */
80 nonl(); /* Disable new-line translation. */
81 intrflush(stdscr, FALSE); /* Disable interrupt flush. */
82 curs_set(0); /* Make cursor invisible */
83 nodelay(stdscr, TRUE); /* Enable non-blocking getch() */
85 /* We may be operating with an incorrect $TERM type; in this case
86 * the keymappings will be slightly broken. We want at least
87 * backspace to work though, so we'll define both DEL and ^H to
89 define_key("\x7f", KEY_BACKSPACE);
90 define_key("\x08", KEY_BACKSPACE);
92 /* we need backtab too, for form navigation. vt220 doesn't include
93 * this (kcbt), but we don't want to require a full linux/xterm termcap
95 define_key("\x1b[Z", KEY_BTAB);
97 /* We'll define a few other keys too since they're commonly
98 * used for navigation but the escape character will cause
99 * Petitboot to exit if they're left undefined */
100 define_key("\x1b\x5b\x35\x7e", KEY_PPAGE);
101 define_key("\x1b\x5b\x36\x7e", KEY_NPAGE);
102 define_key("\x1b\x5b\x31\x7e", KEY_HOME);
103 define_key("\x1b\x5b\x34\x7e", KEY_END);
104 define_key("\x1b\x4f\x48", KEY_HOME);
105 define_key("\x1b\x4f\x46", KEY_END);
106 define_key("OH", KEY_HOME);
107 define_key("OF", KEY_END);
109 /* Arrow keys in normal cursor mode */
110 define_key("\x1b\x5b\x41", KEY_UP);
111 define_key("\x1b\x5b\x42", KEY_DOWN);
112 define_key("\x1b\x5b\x43", KEY_RIGHT);
113 define_key("\x1b\x5b\x44", KEY_LEFT);
114 /* Arrow keys in "application" cursor mode */
115 define_key("\x1b\x4f\x41", KEY_UP);
116 define_key("\x1b\x4f\x42", KEY_DOWN);
117 define_key("\x1b\x4f\x43", KEY_RIGHT);
118 define_key("\x1b\x4f\x44", KEY_LEFT);
120 define_key("\x1b\x5b\x33\x7e", KEY_DC);
122 while (getch() != ERR) /* flush stdin */
126 static void cui_atexit(void)
135 bool lockdown = lockdown_active();
144 * cui_abort - Signal the main cui program loop to exit.
146 * Sets cui.abort, which causes the cui_run() routine to return.
149 void cui_abort(struct cui *cui)
151 pb_log("%s: exiting\n", __func__);
156 * cui_resize - Signal the main cui program loop to resize
158 * Called at SIGWINCH.
161 void cui_resize(struct cui *cui)
163 pb_debug("%s: resizing\n", __func__);
168 * cui_on_exit - A generic main menu exit callback.
171 void cui_on_exit(struct pmenu *menu)
173 struct cui *cui = cui_from_pmenu(menu);
176 cui_cancel_autoboot_on_exit(cui);
178 sh_cmd = talloc_asprintf(cui,
179 "echo \"Exiting petitboot. Type 'exit' to return.\";\
180 echo \"You may run 'pb-sos' to gather diagnostic data\";\
181 %s", pb_system_apps.sh);
184 pb_log("Failed to allocate shell arguments\n");
188 const char *argv[] = {
195 cui_run_cmd(cui, argv);
197 nc_scr_status_printf(cui->current, _("Returned from shell"));
202 * cui_run_cmd - A generic cb to run the supplied command.
205 int cui_run_cmd(struct cui *cui, const char **cmd_argv)
207 struct process *process;
210 process = process_create(cui);
214 process->path = cmd_argv[0];
215 process->argv = cmd_argv;
216 process->raw_stdout = true;
218 nc_scr_status_printf(cui->current, _("Running %s..."), cmd_argv[0]);
220 nc_scr_unpost(cui->current);
227 result = process_run_sync(process);
232 redrawwin(cui->current->main_ncw);
233 nc_scr_post(cui->current);
236 pb_log("%s: failed: '%s'\n", __func__, cmd_argv[0]);
237 nc_scr_status_printf(cui->current, _("Failed: %s"),
241 process_release(process);
246 int cui_run_cmd_from_item(struct pmenu_item *item)
248 struct cui *cui = cui_from_item(item);
249 const char **cmd_argv = item->data;
251 return cui_run_cmd(cui, cmd_argv);
255 * cui_boot - A generic cb to run kexec.
258 static int cui_boot(struct pmenu_item *item)
261 struct cui *cui = cui_from_item(item);
262 struct cui_opt_data *cod = cod_from_item(item);
264 assert(cui->current == &cui->main->scr);
266 pb_debug("%s: %s\n", __func__, cod->name);
268 nc_scr_status_printf(cui->current, _("Booting %s..."), cod->name);
270 result = discover_client_boot(cui->client, NULL, cod->opt, cod->bd);
273 nc_scr_status_printf(cui->current,
274 _("Failed: boot %s"), cod->bd->image);
280 static void cui_boot_editor_on_exit(struct cui *cui,
281 struct pmenu_item *item,
282 struct pb_boot_data *bd)
284 struct pmenu *menu = cui->main;
285 struct cui_opt_data *cod;
286 int idx, top, rows, cols;
287 static int user_idx = 0;
289 /* Was the edit cancelled? */
291 cui_set_current(cui, &cui->main->scr);
292 talloc_free(cui->boot_editor);
293 cui->boot_editor = NULL;
297 /* Is this was a new item, we'll need to update the menu */
301 cod = talloc_zero(NULL, struct cui_opt_data);
302 cod->name = talloc_asprintf(cod, _("User item %u"), ++user_idx);
304 item = pmenu_item_create(menu, cod->name);
310 item->on_edit = cui_item_edit;
311 item->on_execute = cui_boot;
314 talloc_steal(item, cod);
316 /* Detach the items array. */
317 set_menu_items(menu->ncm, NULL);
319 /* Insert new item at insert_pt. */
320 insert_pt = pmenu_grow(menu, 1);
321 pmenu_item_insert(menu, item, insert_pt);
323 /* Re-attach the items array. */
324 set_menu_items(menu->ncm, menu->items);
326 /* If our index is above the current top row, align
327 * us to the new top. Otherwise, align us to the new
329 menu_format(cui->main->ncm, &rows, &cols);
330 top = top_row(cui->main->ncm);
331 idx = item_index(item->nci);
336 top = idx < rows ? 0 : idx - rows + 1;
338 set_top_row(cui->main->ncm, top);
339 set_current_item(item->pmenu->ncm, item->nci);
341 nc_scr_post(&menu->scr);
346 cod->bd = talloc_steal(cod, bd);
349 cui_set_current(cui, &cui->main->scr);
350 talloc_free(cui->boot_editor);
351 cui->boot_editor = NULL;
354 void cui_item_edit(struct pmenu_item *item)
356 struct cui *cui = cui_from_item(item);
357 cui->boot_editor = boot_editor_init(cui, item, cui->sysinfo,
358 cui_boot_editor_on_exit);
359 cui_set_current(cui, boot_editor_scr(cui->boot_editor));
362 void cui_item_new(struct pmenu *menu)
364 struct cui *cui = cui_from_pmenu(menu);
365 cui->boot_editor = boot_editor_init(cui, NULL, cui->sysinfo,
366 cui_boot_editor_on_exit);
367 cui_set_current(cui, boot_editor_scr(cui->boot_editor));
370 static void cui_sysinfo_exit(struct cui *cui)
372 cui_set_current(cui, &cui->main->scr);
373 talloc_free(cui->sysinfo_screen);
374 cui->sysinfo_screen = NULL;
377 void cui_show_sysinfo(struct cui *cui)
379 cui->sysinfo_screen = sysinfo_screen_init(cui, cui->sysinfo,
381 cui_set_current(cui, sysinfo_screen_scr(cui->sysinfo_screen));
384 static void cui_config_exit(struct cui *cui)
386 cui_set_current(cui, &cui->main->scr);
387 talloc_free(cui->config_screen);
388 cui->config_screen = NULL;
391 void cui_show_config(struct cui *cui)
393 cui->config_screen = config_screen_init(cui, cui->config,
394 cui->sysinfo, cui_config_exit);
395 cui_set_current(cui, config_screen_scr(cui->config_screen));
398 static void cui_lang_exit(struct cui *cui)
400 cui_set_current(cui, &cui->main->scr);
401 talloc_free(cui->lang_screen);
402 cui->lang_screen = NULL;
405 void cui_show_lang(struct cui *cui)
407 cui->lang_screen = lang_screen_init(cui, cui->config, cui_lang_exit);
408 cui_set_current(cui, lang_screen_scr(cui->lang_screen));
411 static void cui_statuslog_exit(struct cui *cui)
413 cui_set_current(cui, &cui->main->scr);
414 talloc_free(cui->statuslog_screen);
415 cui->statuslog_screen = NULL;
418 void cui_show_statuslog(struct cui *cui)
420 cui->statuslog_screen = statuslog_screen_init(cui, cui_statuslog_exit);
421 cui_set_current(cui, statuslog_screen_scr(cui->statuslog_screen));
424 static void cui_add_url_exit(struct cui *cui)
426 cui_set_current(cui, &cui->main->scr);
427 talloc_free(cui->add_url_screen);
428 cui->add_url_screen = NULL;
431 static void cui_plugin_exit(struct cui *cui)
433 cui_set_current(cui, &cui->plugin_menu->scr);
434 talloc_free(cui->plugin_screen);
435 cui->plugin_screen = NULL;
438 static void cui_plugin_menu_exit(struct pmenu *menu)
440 struct cui *cui = cui_from_pmenu(menu);
441 cui_set_current(cui, &cui->main->scr);
444 void cui_show_add_url(struct cui *cui)
446 cui->add_url_screen = add_url_screen_init(cui, cui_add_url_exit);
447 cui_set_current(cui, add_url_screen_scr(cui->add_url_screen));
450 void cui_show_plugin_menu(struct cui *cui)
452 cui_set_current(cui, &cui->plugin_menu->scr);
455 void cui_show_plugin(struct pmenu_item *item)
457 struct cui *cui = cui_from_item(item);
458 cui->plugin_screen = plugin_screen_init(cui, item, cui_plugin_exit);
459 cui_set_current(cui, plugin_screen_scr(cui->plugin_screen));
462 static void cui_help_exit(struct cui *cui)
464 cui_set_current(cui, help_screen_return_scr(cui->help_screen));
465 talloc_free(cui->help_screen);
466 cui->help_screen = NULL;
469 void cui_show_help(struct cui *cui, const char *title,
470 const struct help_text *text)
475 if (cui->help_screen)
478 cui->help_screen = help_screen_init(cui, cui->current,
479 title, text, cui_help_exit);
481 if (cui->help_screen)
482 cui_set_current(cui, help_screen_scr(cui->help_screen));
485 static void cui_subset_exit(struct cui *cui)
487 cui_set_current(cui, subset_screen_return_scr(cui->subset_screen));
488 talloc_free(cui->subset_screen);
489 cui->subset_screen = NULL;
492 void cui_show_subset(struct cui *cui, const char *title,
498 if (cui->subset_screen)
501 cui->subset_screen = subset_screen_init(cui, cui->current,
502 title, arg, cui_subset_exit);
504 if (cui->subset_screen)
505 cui_set_current(cui, subset_screen_scr(cui->subset_screen));
509 * cui_set_current - Set the currently active screen and redraw it.
512 struct nc_scr *cui_set_current(struct cui *cui, struct nc_scr *scr)
516 DBGS("%p -> %p\n", cui->current, scr);
518 assert(cui->current != scr);
525 nc_scr_post(cui->current);
530 static bool process_global_keys(struct cui *cui, int key)
534 if (cui->current && cui->current->main_ncw)
542 * cui_process_key - Process input on stdin.
545 static int cui_process_key(void *arg)
547 struct cui *cui = cui_from_arg(arg);
552 assert(cui->current);
557 pb_debug("%s: got key %d\n", __func__, c);
564 * If this is a console code sequence try to parse it
565 * and don't treat this as a key press.
568 if (grab != ERR && grab != 27) {
570 pb_debug("%s: Caught unhandled command sequence\n",
572 sequence = handle_control_sequence(cui, c);
573 pb_debug("Caught sequence ");
575 pb_debug("(%zu): ", strlen(sequence));
576 for (i = 0; i < strlen(sequence); i++)
577 pb_debug("0%o ", sequence[i]);
580 pb_debug("(0): (none)\n");
585 if (!cui->has_input) {
586 cui->has_input = true;
588 pb_log("UI input received (key = %d), aborting "
589 "default boot\n", c);
590 discover_client_cancel_default(cui->client);
592 pb_log("UI input received (key = %d), aborting "
593 "once server connects\n", c);
597 if (process_global_keys(cui, c))
600 cui->current->process_key(cui->current, c);
607 * cui_process_js - Process joystick events.
610 static int cui_process_js(void *arg)
612 struct cui *cui = cui_from_arg(arg);
615 c = pjs_process_event(cui->pjs);
619 cui_process_key(arg);
626 * cui_handle_resize - Handle the term resize.
629 static void cui_handle_resize(struct cui *cui)
633 if (ioctl(1, TIOCGWINSZ, &ws) == -1) {
634 pb_log("%s: ioctl failed: %s\n", __func__, strerror(errno));
638 pb_debug("%s: {%u,%u}\n", __func__, ws.ws_row, ws.ws_col);
640 wclear(cui->current->main_ncw);
641 resize_term(ws.ws_row, ws.ws_col);
642 cui->current->resize(cui->current);
644 /* For some reason this makes ncurses redraw the screen */
646 redrawwin(cui->current->main_ncw);
647 wrefresh(cui->current->main_ncw);
651 * cui_device_add - Client device_add callback.
653 * Creates menu_items for all the device boot_options and inserts those
654 * menu_items into the main menu. Redraws the main menu if it is active.
655 * If a 'plugin' type boot_option appears the plugin menu is updated instead.
658 static int cui_boot_option_add(struct device *dev, struct boot_option *opt,
661 struct pmenu_item *i, *dev_hdr = NULL;
662 struct cui *cui = cui_from_arg(arg);
663 struct cui_opt_data *cod;
664 const char *tab = " ";
665 unsigned int insert_pt;
666 int result, rows, cols;
672 plugin_option = opt->type == DISCOVER_PLUGIN_OPTION;
673 menu = plugin_option ? cui->plugin_menu : cui->main;
675 pb_debug("%s: %p %s\n", __func__, opt, opt->id);
677 selected = current_item(menu->ncm);
678 menu_format(menu->ncm, &rows, &cols);
680 if (cui->current == &cui->main->scr)
681 nc_scr_unpost(cui->current);
682 if (plugin_option && cui->current == &cui->plugin_menu->scr)
683 nc_scr_unpost(cui->current);
685 /* Check if the boot device is new */
686 dev_hdr = pmenu_find_device(menu, dev, opt);
688 /* All actual boot entries are 'tabbed' across */
689 name = talloc_asprintf(menu, "%s%s",
690 tab, opt->name ? : "Unknown Name");
692 /* Save the item in opt->ui_info for cui_device_remove() */
693 opt->ui_info = i = pmenu_item_create(menu, name);
700 i->on_execute = plugin_install_plugin;
702 i->on_edit = cui_item_edit;
703 i->on_execute = cui_boot;
706 i->data = cod = talloc(i, struct cui_opt_data);
709 cod->opt_hash = pb_opt_hash(dev, opt);
710 cod->name = opt->name;
713 cod->pd = talloc(i, struct pb_plugin_data);
714 cod->pd->plugin_file = talloc_strdup(cod,
715 opt->boot_image_file);
717 cod->bd = talloc(i, struct pb_boot_data);
718 cod->bd->image = talloc_strdup(cod->bd, opt->boot_image_file);
719 cod->bd->initrd = talloc_strdup(cod->bd, opt->initrd_file);
720 cod->bd->dtb = talloc_strdup(cod->bd, opt->dtb_file);
721 cod->bd->args = talloc_strdup(cod->bd, opt->boot_args);
722 cod->bd->args_sig_file = talloc_strdup(cod->bd, opt->args_sig_file);
725 /* This disconnects items array from menu. */
726 result = set_menu_items(menu->ncm, NULL);
729 pb_log("%s: set_menu_items failed: %d\n", __func__, result);
731 /* Insert new items at insert_pt. */
733 insert_pt = pmenu_grow(menu, 2);
734 pmenu_item_insert(menu, dev_hdr, insert_pt);
735 pb_log("%s: adding new device hierarchy %s\n",
736 __func__, opt->device_id);
737 pmenu_item_insert(menu, i, insert_pt+1);
739 insert_pt = pmenu_grow(menu, 1);
740 pmenu_item_add(menu, i, insert_pt);
744 pb_log("%s: adding plugin '%s'\n", __func__, cod->name);
745 pb_log(" file '%s'\n", cod->pd->plugin_file);
747 pb_log("%s: adding opt '%s'\n", __func__, cod->name);
748 pb_log(" image '%s'\n", cod->bd->image);
749 pb_log(" initrd '%s'\n", cod->bd->initrd);
750 pb_log(" args '%s'\n", cod->bd->args);
751 pb_log(" argsig '%s'\n", cod->bd->args_sig_file);
754 /* Update the plugin menu label if needed */
756 struct pmenu_item *item;
758 result = set_menu_items(cui->main->ncm, NULL);
759 for (j = 0 ; j < cui->main->item_count; j++) {
760 item = item_userptr(cui->main->items[j]);
761 if (strncmp(item->nci->name.str, "Plugins", strlen("Plugins")))
764 char *label = talloc_asprintf(item, "Plugins (%u)",
766 pmenu_item_update(item, label);
770 result = set_menu_items(cui->main->ncm, cui->main->items);
772 pb_log("%s: set_menu_items failed: %d\n", __func__, result);
775 /* Re-attach the items array. */
776 result = set_menu_items(menu->ncm, menu->items);
779 pb_log("%s: set_menu_items failed: %d\n", __func__, result);
782 pb_log("%s\n", __func__);
783 pmenu_dump_items(menu->items,
784 item_count(menu->ncm) + 1);
787 if (!item_visible(selected)) {
790 top = top_row(menu->ncm);
791 idx = item_index(selected);
793 /* If our index is above the current top row, align
794 * us to the new top. Otherwise, align us to the new
796 top = top < idx ? idx - rows + 1 : idx;
798 set_top_row(menu->ncm, top);
799 set_current_item(menu->ncm, selected);
802 if (cui->current == &menu->scr)
803 nc_scr_post(cui->current);
804 if (plugin_option && cui->current == &cui->main->scr)
805 nc_scr_post(cui->current);
811 * cui_device_remove - Client device remove callback.
813 * Removes all the menu_items for the device from the main menu and redraws the
814 * main menu if it is active.
816 static void cui_device_remove(struct device *dev, void *arg)
818 struct cui *cui = cui_from_arg(arg);
819 struct boot_option *opt;
821 int rows, cols, top, last;
824 pb_log("%s: %p %s\n", __func__, dev, dev->id);
826 if (cui->current == &cui->main->scr)
827 nc_scr_unpost(cui->current);
828 if (cui->current == &cui->plugin_menu->scr)
829 nc_scr_unpost(cui->current);
831 /* This disconnects items array from menu. */
833 result = set_menu_items(cui->main->ncm, NULL);
834 result |= set_menu_items(cui->plugin_menu->ncm, NULL);
837 pb_log("%s: set_menu_items failed: %d\n", __func__, result);
839 list_for_each_entry(&dev->boot_options, opt, list) {
840 struct pmenu_item *item = pmenu_item_from_arg(opt->ui_info);
842 assert(pb_protocol_device_cmp(dev, cod_from_item(item)->dev));
843 if (opt->type == DISCOVER_PLUGIN_OPTION)
844 pmenu_remove(cui->plugin_menu, item);
846 pmenu_remove(cui->main, item);
849 /* Manually remove remaining device hierarchy item */
850 for (i=0; i < cui->main->item_count; i++) {
851 struct pmenu_item *item = item_userptr(cui->main->items[i]);
852 if (!item || !item->data )
855 struct cui_opt_data *data = item->data;
856 if (data && data->dev && data->dev == dev)
857 pmenu_remove(cui->main,item);
859 /* Look in plugins menu too */
860 for (i=0; i < cui->plugin_menu->item_count; i++) {
861 struct pmenu_item *item = item_userptr(cui->plugin_menu->items[i]);
862 if (!item || !item->data )
865 struct cui_opt_data *data = item->data;
866 if (data && data->dev && data->dev == dev)
867 pmenu_remove(cui->plugin_menu,item);
870 /* Re-attach the items array. */
872 result = set_menu_items(cui->main->ncm, cui->main->items);
873 result |= set_menu_items(cui->plugin_menu->ncm, cui->plugin_menu->items);
875 /* Move cursor to 'Exit' menu entry for the main menu.. */
876 menu_format(cui->main->ncm, &rows, &cols);
877 last = cui->main->item_count - 1;
878 set_current_item(cui->main->ncm, cui->main->items[last]);
879 if (!item_visible(cui->main->items[last])) {
880 top = last < rows ? 0 : last - rows + 1;
881 set_top_row(cui->main->ncm, top);
884 /* ..and the plugin menu */
885 menu_format(cui->plugin_menu->ncm, &rows, &cols);
886 last = cui->plugin_menu->item_count - 1;
887 set_current_item(cui->plugin_menu->ncm, cui->plugin_menu->items[last]);
888 if (!item_visible(cui->plugin_menu->items[last])) {
889 top = last < rows ? 0 : last - rows + 1;
890 set_top_row(cui->plugin_menu->ncm, top);
894 pb_log("%s: set_menu_items failed: %d\n", __func__, result);
897 pb_log("%s\n", __func__);
898 pmenu_dump_items(cui->main->items,
899 item_count(cui->main->ncm) + 1);
902 if (cui->current == &cui->main->scr)
903 nc_scr_post(cui->current);
904 if (cui->current == &cui->plugin_menu->scr)
905 nc_scr_post(cui->current);
908 static void cui_update_status(struct status *status, void *arg)
910 struct cui *cui = cui_from_arg(arg);
912 statuslog_append_steal(cui, cui->statuslog, status);
914 /* Ignore status messages from the backlog */
915 if (!status->backlog)
916 nc_scr_status_printf(cui->current, "%s", status->message);
920 * Handle a new installed plugin option and update its associated
921 * (uninstalled) menu item if it exists.
923 static int cui_plugin_option_add(struct plugin_option *opt, void *arg)
925 struct cui_opt_data *cod;
926 struct cui *cui = cui_from_arg(arg);
927 struct pmenu_item *item = NULL;
928 struct boot_option *dummy_opt;
934 /* Find uninstalled plugin by matching on plugin_file */
935 for (i = 0; i < cui->plugin_menu->item_count; i++) {
936 item = item_userptr(cui->plugin_menu->items[i]);
939 cod = cod_from_item(item);
940 if (!cod || !cod->pd)
942 if (strncmp(cod->pd->plugin_file, opt->plugin_file,
943 strlen(cod->pd->plugin_file)) == 0)
948 * If pb-plugin was run manually there may not be an associated
949 * plugin-type boot_option. Pass a fake device and option to
950 * cui_boot_option_add() so we have an item to work with.
952 if (!item || i >= cui->plugin_menu->item_count) {
953 pb_log("New plugin option %s doesn't have a source item\n",
955 dev = talloc_zero(cui, struct device);
956 dev->id = dev->name = talloc_asprintf(dev, "(unknown)");
957 dev->type = DEVICE_TYPE_UNKNOWN;
958 dummy_opt = talloc_zero(cui, struct boot_option);
959 dummy_opt->device_id = talloc_strdup(dummy_opt, dev->id);
960 dummy_opt->id = dummy_opt->name = talloc_asprintf(dummy_opt, "dummy");
961 dummy_opt->boot_image_file = talloc_strdup(dummy_opt, opt->plugin_file);
962 dummy_opt->type = DISCOVER_PLUGIN_OPTION;
963 cui_boot_option_add(dev, dummy_opt, cui);
968 * If this option was faked above move the context under
969 * the item so it is cleaned up later in cui_plugins_remove().
971 if (strcmp(cod->opt->id, "dummy") == 0 &&
972 cod->dev->type == DEVICE_TYPE_UNKNOWN) {
973 talloc_steal(item, cod->dev);
974 talloc_steal(item, cod->opt);
977 talloc_free(cod->name);
978 /* Name is still tabbed across */
979 cod->name = talloc_asprintf(cod, _(" %s [installed]"), opt->name);
982 item->on_execute = NULL;
983 item->on_edit = cui_show_plugin;
985 if (cui->current == &cui->plugin_menu->scr)
986 nc_scr_unpost(cui->current);
988 /* This disconnects items array from menu. */
989 result = set_menu_items(cui->plugin_menu->ncm, NULL);
992 pmenu_item_update(item, cod->name);
994 /* Re-attach the items array. */
995 result = set_menu_items(cui->plugin_menu->ncm, cui->plugin_menu->items);
997 if (cui->current == &cui->plugin_menu->scr)
998 nc_scr_post(cui->current);
1004 * Most plugin menu items will be removed via cui_device_remove(). However if
1005 * pb-plugin has been run manually it is possible that there a plugin items
1006 * not associated with a device - remove them here.
1008 static int cui_plugins_remove(void *arg)
1010 struct cui *cui = cui_from_arg(arg);
1011 struct pmenu_item *item = NULL;
1012 struct cui_opt_data *cod;
1015 pb_debug("%s\n", __func__);
1017 if (cui->current == &cui->plugin_menu->scr)
1018 nc_scr_unpost(cui->current);
1019 if (cui->current == &cui->main->scr)
1020 nc_scr_unpost(cui->current);
1022 /* This disconnects items array from menu. */
1023 set_menu_items(cui->plugin_menu->ncm, NULL);
1025 while (i < cui->plugin_menu->item_count) {
1026 item = item_userptr(cui->plugin_menu->items[i]);
1027 if (!item || !item->data) {
1031 cod = cod_from_item(item);
1032 if (!cod->opt && !cod->dev) {
1037 pmenu_remove(cui->plugin_menu, item);
1038 /* plugin_menu entries will shift, jump to bottom to make sure
1039 * we remove all plugin option items */
1043 /* Re-attach the items array. */
1044 set_menu_items(cui->plugin_menu->ncm, cui->plugin_menu->items);
1046 set_menu_items(cui->main->ncm, NULL);
1047 for (i = 0; i < cui->main->item_count; i++) {
1048 item = item_userptr(cui->main->items[i]);
1049 if (strncmp(item->nci->name.str, "Plugins", strlen("Plugins")))
1052 pmenu_item_update(item, "Plugins (0)");
1056 set_menu_items(cui->main->ncm, cui->main->items);
1058 if (cui->current == &cui->main->scr)
1059 nc_scr_post(cui->current);
1061 /* If we're currently in a plugin screen jump back to the plugin menu */
1062 if (cui->plugin_screen &&
1063 cui->current == plugin_screen_scr(cui->plugin_screen))
1064 cui_plugin_exit(cui);
1069 static void cui_update_mm_title(struct cui *cui)
1071 struct nc_frame *frame = &cui->main->scr.frame;
1073 talloc_free(frame->rtitle);
1075 frame->rtitle = talloc_strdup(cui->main, cui->sysinfo->type);
1076 if (cui->sysinfo->identifier)
1077 frame->rtitle = talloc_asprintf_append(frame->rtitle,
1078 " %s", cui->sysinfo->identifier);
1080 if (cui->current == &cui->main->scr)
1081 nc_scr_post(cui->current);
1083 frame = &cui->plugin_menu->scr.frame;
1085 talloc_free(frame->rtitle);
1087 frame->rtitle = talloc_strdup(cui->main, cui->sysinfo->type);
1088 if (cui->sysinfo->identifier)
1089 frame->rtitle = talloc_asprintf_append(frame->rtitle,
1090 " %s", cui->sysinfo->identifier);
1092 if (cui->current == &cui->main->scr)
1093 nc_scr_post(cui->current);
1096 static void cui_update_sysinfo(struct system_info *sysinfo, void *arg)
1098 struct cui *cui = cui_from_arg(arg);
1099 cui->sysinfo = talloc_steal(cui, sysinfo);
1101 /* if we're currently displaying the system info screen, inform it
1102 * of the updated information. */
1103 if (cui->sysinfo_screen)
1104 sysinfo_screen_update(cui->sysinfo_screen, sysinfo);
1106 if (cui->subset_screen)
1107 subset_screen_update(cui->subset_screen);
1109 /* ... and do the same with the config screen... */
1110 if (cui->config_screen)
1111 config_screen_update(cui->config_screen, cui->config, sysinfo);
1113 /* ... and the boot editor. */
1114 if (cui->boot_editor)
1115 boot_editor_update(cui->boot_editor, sysinfo);
1117 cui_update_mm_title(cui);
1120 static void cui_update_language(struct cui *cui, char *lang)
1125 cur_lang = setlocale(LC_ALL, NULL);
1126 if (cur_lang && !strcmp(cur_lang, lang))
1129 setlocale(LC_ALL, lang);
1131 /* we'll need to update the menu: drop all items and repopulate */
1132 repost_menu = cui->current == &cui->main->scr ||
1133 cui->current == &cui->plugin_menu->scr;
1135 nc_scr_unpost(cui->current);
1137 talloc_free(cui->main);
1138 cui->main = main_menu_init(cui);
1139 cui->plugin_menu = plugin_menu_init(cui);
1142 cui->current = &cui->main->scr;
1143 nc_scr_post(cui->current);
1146 discover_client_enumerate(cui->client);
1149 static void cui_update_config(struct config *config, void *arg)
1151 struct cui *cui = cui_from_arg(arg);
1152 cui->config = talloc_steal(cui, config);
1155 cui_update_language(cui, config->lang);
1157 if (cui->subset_screen)
1158 subset_screen_update(cui->subset_screen);
1160 if (cui->config_screen)
1161 config_screen_update(cui->config_screen, config, cui->sysinfo);
1163 if (config->safe_mode)
1164 nc_scr_status_printf(cui->current,
1165 _("SAFE MODE: select '%s' to continue"),
1166 _("Rescan devices"));
1169 int cui_send_config(struct cui *cui, struct config *config)
1171 return discover_client_send_config(cui->client, config);
1174 int cui_send_url(struct cui *cui, char * url)
1176 return discover_client_send_url(cui->client, url);
1179 int cui_send_plugin_install(struct cui *cui, char *file)
1181 return discover_client_send_plugin_install(cui->client, file);
1184 void cui_send_reinit(struct cui *cui)
1186 discover_client_send_reinit(cui->client);
1189 static int menu_sysinfo_execute(struct pmenu_item *item)
1191 cui_show_sysinfo(cui_from_item(item));
1195 static int menu_config_execute(struct pmenu_item *item)
1197 cui_show_config(cui_from_item(item));
1201 static int menu_lang_execute(struct pmenu_item *item)
1203 cui_show_lang(cui_from_item(item));
1207 static int menu_statuslog_execute(struct pmenu_item *item)
1209 cui_show_statuslog(cui_from_item(item));
1213 static int menu_reinit_execute(struct pmenu_item *item)
1215 if (cui_from_item(item)->client)
1216 cui_send_reinit(cui_from_item(item));
1220 static int menu_add_url_execute(struct pmenu_item *item)
1222 if (cui_from_item(item)->client)
1223 cui_show_add_url(cui_from_item(item));
1227 static int menu_plugin_execute(struct pmenu_item *item)
1229 if (cui_from_item(item)->client)
1230 cui_show_plugin_menu(cui_from_item(item));
1235 * pb_mm_init - Setup the main menu instance.
1237 static struct pmenu *main_menu_init(struct cui *cui)
1239 struct pmenu_item *i;
1242 bool lockdown = lockdown_active();
1244 m = pmenu_init(cui, 9, cui_on_exit);
1246 pb_log("%s: failed\n", __func__);
1251 m->hot_keys = talloc_array(m, hot_key_fn, m->n_hot_keys);
1253 pb_log("%s: failed to allocate hot_keys\n", __func__);
1257 m->hot_keys[0] = pmenu_main_hot_keys;
1258 m->on_new = cui_item_new;
1260 m->scr.frame.ltitle = talloc_asprintf(m,
1261 "Petitboot (" PACKAGE_VERSION ")");
1262 m->scr.frame.rtitle = NULL;
1263 m->scr.frame.help = talloc_strdup(m,
1264 _("Enter=accept, e=edit, n=new, x=exit, l=language, g=log, h=help"));
1265 m->scr.frame.status = talloc_strdup(m, _("Welcome to Petitboot"));
1267 /* add a separator */
1268 i = pmenu_item_create(m, " ");
1269 item_opts_off(i->nci, O_SELECTABLE);
1270 pmenu_item_insert(m, i, 0);
1272 /* add system items */
1273 i = pmenu_item_create(m, _("System information"));
1274 i->on_execute = menu_sysinfo_execute;
1275 pmenu_item_insert(m, i, 1);
1277 i = pmenu_item_create(m, _("System configuration"));
1278 i->on_execute = menu_config_execute;
1279 pmenu_item_insert(m, i, 2);
1281 i = pmenu_item_create(m, _("System status log"));
1282 i->on_execute = menu_statuslog_execute;
1283 pmenu_item_insert(m, i, 3);
1285 /* this label isn't translated, so we don't want a gettext() here */
1286 i = pmenu_item_create(m, "Language");
1287 i->on_execute = menu_lang_execute;
1288 pmenu_item_insert(m, i, 4);
1290 i = pmenu_item_create(m, _("Rescan devices"));
1291 i->on_execute = menu_reinit_execute;
1292 pmenu_item_insert(m, i, 5);
1294 i = pmenu_item_create(m, _("Retrieve config from URL"));
1295 i->on_execute = menu_add_url_execute;
1296 pmenu_item_insert(m, i, 6);
1298 i = pmenu_item_create(m, _("Plugins (0)"));
1299 i->on_execute = menu_plugin_execute;
1300 pmenu_item_insert(m, i, 7);
1303 i = pmenu_item_create(m, _("Reboot"));
1305 i = pmenu_item_create(m, _("Exit to shell"));
1306 i->on_execute = pmenu_exit_cb;
1307 pmenu_item_insert(m, i, 8);
1309 result = pmenu_setup(m);
1312 pb_log("%s:%d: pmenu_setup failed: %s\n", __func__, __LINE__,
1317 m->help_title = _("main menu");
1318 m->help_text = &main_menu_help_text;
1320 menu_opts_off(m->ncm, O_SHOWDESC);
1321 set_menu_mark(m->ncm, " *");
1322 set_current_item(m->ncm, i->nci);
1332 * plugin_menu_init: Set up the plugin menu instance
1334 static struct pmenu *plugin_menu_init(struct cui *cui)
1336 struct pmenu_item *i;
1340 m = pmenu_init(cui, 2, cui_plugin_menu_exit);
1341 m->scr.frame.ltitle = talloc_asprintf(m, _("Petitboot Plugins"));
1342 m->scr.frame.rtitle = talloc_asprintf(m, "%s", "");
1343 m->scr.frame.help = talloc_strdup(m,
1344 _("Enter=install, e=details, x=exit, h=help"));
1345 m->scr.frame.status = talloc_asprintf(m,
1346 _("Available Petitboot Plugins"));
1348 /* add a separator */
1349 i = pmenu_item_create(m, " ");
1350 item_opts_off(i->nci, O_SELECTABLE);
1351 pmenu_item_insert(m, i, 0);
1353 i = pmenu_item_create(m, _("Return to Main Menu"));
1354 i->on_execute = pmenu_exit_cb;
1355 pmenu_item_insert(m, i, 1);
1357 result = pmenu_setup(m);
1360 pb_log("%s:%d: pmenu_setup failed: %s\n", __func__, __LINE__,
1365 m->help_title = _("plugin menu");
1366 m->help_text = &plugin_menu_help_text;
1375 static struct discover_client_ops cui_client_ops = {
1377 .boot_option_add = cui_boot_option_add,
1378 .device_remove = cui_device_remove,
1379 .plugin_option_add = cui_plugin_option_add,
1380 .plugins_remove = cui_plugins_remove,
1381 .update_status = cui_update_status,
1382 .update_sysinfo = cui_update_sysinfo,
1383 .update_config = cui_update_config,
1386 /* cui_server_wait - Connect to the discover server.
1387 * @arg: Pointer to the cui instance.
1389 * A timeout callback that attempts to connect to the discover server; on
1390 * failure it registers itself with a one second timeout to try again.
1391 * On success the cui->client struct will be set.
1393 * Since this updates the status line when called it must not be called
1394 * before the UI is ready.
1396 static int cui_server_wait(void *arg)
1398 struct cui *cui = cui_from_arg(arg);
1401 pb_debug("We already have a server!\n");
1405 /* We haven't yet connected to the server */
1406 pb_log("Trying to connect...\n");
1407 cui->client = discover_client_init(cui->waitset,
1408 &cui_client_ops, cui);
1411 waiter_register_timeout(cui->waitset, 1000, cui_server_wait,
1413 nc_scr_status_printf(cui->current,
1414 "Info: Waiting for device discovery");
1416 nc_scr_status_free(cui->current);
1417 talloc_steal(cui, cui->client);
1419 if (cui->has_input) {
1420 pb_log("Aborting default boot on pb-discover connect\n");
1421 discover_client_cancel_default(cui->client);
1429 * cui_init - Setup the cui instance.
1430 * @platform_info: A value for the struct cui platform_info member.
1432 * Returns a pointer to a struct cui on success, or NULL on error.
1434 * Allocates the cui instance, sets up the client and stdin waiters, and
1435 * sets up the ncurses menu screen.
1438 struct cui *cui_init(void* platform_info,
1439 int (*js_map)(const struct js_event *e), int start_daemon, int timeout)
1444 cui = talloc_zero(NULL, struct cui);
1446 pb_log("%s: alloc cui failed.\n", __func__);
1447 fprintf(stderr, _("%s: alloc cui failed.\n"), __func__);
1451 cui->c_sig = pb_cui_sig;
1452 cui->platform_info = platform_info;
1453 cui->waitset = waitset_create(cui);
1454 cui->statuslog = statuslog_init(cui);
1456 process_init(cui, cui->waitset, false);
1458 /* Loop here for scripts that just started the server. */
1461 for (i = start_daemon ? 2 : 15; i && timeout; i--) {
1462 cui->client = discover_client_init(cui->waitset,
1463 &cui_client_ops, cui);
1464 if (cui->client || !i)
1466 pb_log("%s: waiting for server %d\n", __func__, i);
1470 if (!cui->client && start_daemon) {
1475 result = pb_start_daemon(cui);
1480 pb_log("%s: discover_client_init failed.\n", __func__);
1481 fprintf(stderr, _("%s: error: discover_client_init failed.\n"),
1483 fprintf(stderr, _("could not start pb-discover, the petitboot "
1485 goto fail_client_init;
1488 if (!cui->client && !timeout) {
1489 /* Have the first timeout fire immediately so we can check
1490 * for the server as soon as the UI is ready */
1491 waiter_register_timeout(cui->waitset, 0,
1492 cui_server_wait, cui);
1493 } else if (!cui->client) {
1494 pb_log("%s: discover_client_init failed.\n", __func__);
1495 fprintf(stderr, _("%s: error: discover_client_init failed.\n"),
1497 fprintf(stderr, _("check that pb-discover, "
1498 "the petitboot daemon is running.\n"));
1499 goto fail_client_init;
1503 talloc_steal(cui, cui->client);
1506 cui->main = main_menu_init(cui);
1508 goto fail_client_init;
1510 cui->plugin_menu = plugin_menu_init(cui);
1511 if (!cui->plugin_menu)
1512 goto fail_client_init;
1514 waiter_register_io(cui->waitset, STDIN_FILENO, WAIT_IN,
1515 cui_process_key, cui);
1519 cui->pjs = pjs_init(cui, js_map);
1522 waiter_register_io(cui->waitset, pjs_get_fd(cui->pjs),
1523 WAIT_IN, cui_process_js, cui);
1535 * cui_cancel_autoboot_on_exit - On exit spin until the server is available.
1537 * If the program exits before connecting to the server autoboot won't be
1538 * cancelled even though there has been keyboard activity. A child is forked
1539 * which will spin until the server is connected and told to cancel autoboot.
1541 static void cui_cancel_autoboot_on_exit(struct cui *cui)
1546 /* Fork a child to tell the server to cancel autoboot */
1549 cui_detached = true;
1551 /* Loop until connection established */
1552 while (!cui->client) {
1553 cui->client = discover_client_init(cui->waitset,
1554 &cui_client_ops, cui);
1559 talloc_steal(cui, cui->client);
1560 discover_client_cancel_default(cui->client);
1564 pb_log("Failed to fork child on exit: %m\n");
1566 discover_client_cancel_default(cui->client);
1570 * cui_run - The main cui program loop.
1571 * @cui: The cui instance.
1572 * @main: The menu to use as the main menu.
1574 * Runs the cui engine. Does not return until indicated to do so by some
1575 * user action, or an error occurs. Frees the cui object on return.
1576 * Returns 0 on success (return to shell), -1 on error (should restart).
1579 int cui_run(struct cui *cui)
1584 cui->current = &cui->main->scr;
1585 cui->default_item = 0;
1587 nc_scr_post(cui->current);
1590 int result = waiter_poll(cui->waitset);
1593 pb_log("%s: poll: %s\n", __func__, strerror(errno));
1600 while (cui->resize) {
1602 cui_handle_resize(cui);
1606 cui_cancel_autoboot_on_exit(cui);
1610 return cui->abort ? 0 : -1;