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)
28 #include <sys/ioctl.h>
29 #include <sys/reboot.h>
32 #include "pb-protocol/pb-protocol.h"
33 #include "talloc/talloc.h"
34 #include "waiter/waiter.h"
35 #include "process/process.h"
36 #include "i18n/i18n.h"
37 #include "ui/common/discover-client.h"
38 #include "ui/common/ui-system.h"
40 #include "nc-boot-editor.h"
41 #include "nc-config.h"
42 #include "nc-add-url.h"
43 #include "nc-sysinfo.h"
45 #include "nc-helpscreen.h"
46 #include "nc-statuslog.h"
47 #include "nc-subset.h"
48 #include "nc-plugin.h"
49 #include "console-codes.h"
51 extern const struct help_text main_menu_help_text;
52 extern const struct help_text plugin_menu_help_text;
54 static bool cui_detached = false;
56 static struct pmenu *main_menu_init(struct cui *cui);
57 static struct pmenu *plugin_menu_init(struct cui *cui);
59 static bool lockdown_active(void)
61 bool lockdown = false;
62 if (access(LOCKDOWN_FILE, F_OK) != -1)
67 static void cui_start(void)
69 initscr(); /* Initialize ncurses. */
70 cbreak(); /* Disable line buffering. */
71 noecho(); /* Disable getch() echo. */
72 keypad(stdscr, TRUE); /* Enable num keypad keys. */
73 nonl(); /* Disable new-line translation. */
74 intrflush(stdscr, FALSE); /* Disable interrupt flush. */
75 curs_set(0); /* Make cursor invisible */
76 nodelay(stdscr, TRUE); /* Enable non-blocking getch() */
78 /* We may be operating with an incorrect $TERM type; in this case
79 * the keymappings will be slightly broken. We want at least
80 * backspace to work though, so we'll define both DEL and ^H to
82 define_key("\x7f", KEY_BACKSPACE);
83 define_key("\x08", KEY_BACKSPACE);
85 /* we need backtab too, for form navigation. vt220 doesn't include
86 * this (kcbt), but we don't want to require a full linux/xterm termcap
88 define_key("\x1b[Z", KEY_BTAB);
90 /* We'll define a few other keys too since they're commonly
91 * used for navigation but the escape character will cause
92 * Petitboot to exit if they're left undefined */
93 define_key("\x1b\x5b\x35\x7e", KEY_PPAGE);
94 define_key("\x1b\x5b\x36\x7e", KEY_NPAGE);
95 define_key("\x1b\x5b\x31\x7e", KEY_HOME);
96 define_key("\x1b\x5b\x34\x7e", KEY_END);
97 define_key("\x1b\x4f\x48", KEY_HOME);
98 define_key("\x1b\x4f\x46", KEY_END);
99 define_key("OH", KEY_HOME);
100 define_key("OF", KEY_END);
101 define_key("\x1b\x5b\x41", KEY_UP);
102 define_key("\x1b\x5b\x42", KEY_DOWN);
103 define_key("\x1b\x5b\x33\x7e", KEY_DC);
105 while (getch() != ERR) /* flush stdin */
109 static void cui_atexit(void)
118 bool lockdown = lockdown_active();
127 * cui_abort - Signal the main cui program loop to exit.
129 * Sets cui.abort, which causes the cui_run() routine to return.
132 void cui_abort(struct cui *cui)
134 pb_log("%s: exiting\n", __func__);
139 * cui_resize - Signal the main cui program loop to resize
141 * Called at SIGWINCH.
144 void cui_resize(struct cui *cui)
146 pb_debug("%s: resizing\n", __func__);
151 * cui_on_exit - A generic main menu exit callback.
154 void cui_on_exit(struct pmenu *menu)
156 struct cui *cui = cui_from_pmenu(menu);
159 sh_cmd = talloc_asprintf(cui,
160 "echo \"Exiting petitboot. Type 'exit' to return.\";\
161 echo \"You may run 'pb-sos' to gather diagnostic data\";\
162 %s", pb_system_apps.sh);
165 pb_log("Failed to allocate shell arguments\n");
169 const char *argv[] = {
176 cui_run_cmd(cui, argv);
178 nc_scr_status_printf(cui->current, _("Returned from shell"));
183 * cui_run_cmd - A generic cb to run the supplied command.
186 int cui_run_cmd(struct cui *cui, const char **cmd_argv)
188 struct process *process;
191 process = process_create(cui);
195 process->path = cmd_argv[0];
196 process->argv = cmd_argv;
197 process->raw_stdout = true;
199 nc_scr_status_printf(cui->current, _("Running %s..."), cmd_argv[0]);
201 nc_scr_unpost(cui->current);
208 result = process_run_sync(process);
213 redrawwin(cui->current->main_ncw);
214 nc_scr_post(cui->current);
217 pb_log("%s: failed: '%s'\n", __func__, cmd_argv[0]);
218 nc_scr_status_printf(cui->current, _("Failed: %s"),
222 process_release(process);
227 int cui_run_cmd_from_item(struct pmenu_item *item)
229 struct cui *cui = cui_from_item(item);
230 const char **cmd_argv = item->data;
232 return cui_run_cmd(cui, cmd_argv);
236 * cui_boot - A generic cb to run kexec.
239 static int cui_boot(struct pmenu_item *item)
242 struct cui *cui = cui_from_item(item);
243 struct cui_opt_data *cod = cod_from_item(item);
245 assert(cui->current == &cui->main->scr);
247 pb_debug("%s: %s\n", __func__, cod->name);
249 nc_scr_status_printf(cui->current, _("Booting %s..."), cod->name);
251 result = discover_client_boot(cui->client, NULL, cod->opt, cod->bd);
254 nc_scr_status_printf(cui->current,
255 _("Failed: boot %s"), cod->bd->image);
261 static void cui_boot_editor_on_exit(struct cui *cui,
262 struct pmenu_item *item,
263 struct pb_boot_data *bd)
265 struct pmenu *menu = cui->main;
266 struct cui_opt_data *cod;
267 int idx, top, rows, cols;
268 static int user_idx = 0;
270 /* Was the edit cancelled? */
272 cui_set_current(cui, &cui->main->scr);
273 talloc_free(cui->boot_editor);
274 cui->boot_editor = NULL;
278 /* Is this was a new item, we'll need to update the menu */
282 cod = talloc_zero(NULL, struct cui_opt_data);
283 cod->name = talloc_asprintf(cod, _("User item %u"), ++user_idx);
285 item = pmenu_item_create(menu, cod->name);
291 item->on_edit = cui_item_edit;
292 item->on_execute = cui_boot;
295 talloc_steal(item, cod);
297 /* Detach the items array. */
298 set_menu_items(menu->ncm, NULL);
300 /* Insert new item at insert_pt. */
301 insert_pt = pmenu_grow(menu, 1);
302 pmenu_item_insert(menu, item, insert_pt);
304 /* Re-attach the items array. */
305 set_menu_items(menu->ncm, menu->items);
307 /* If our index is above the current top row, align
308 * us to the new top. Otherwise, align us to the new
310 menu_format(cui->main->ncm, &rows, &cols);
311 top = top_row(cui->main->ncm);
312 idx = item_index(item->nci);
317 top = idx < rows ? 0 : idx - rows + 1;
319 set_top_row(cui->main->ncm, top);
320 set_current_item(item->pmenu->ncm, item->nci);
322 nc_scr_post(&menu->scr);
327 cod->bd = talloc_steal(cod, bd);
330 cui_set_current(cui, &cui->main->scr);
331 talloc_free(cui->boot_editor);
332 cui->boot_editor = NULL;
335 void cui_item_edit(struct pmenu_item *item)
337 struct cui *cui = cui_from_item(item);
338 cui->boot_editor = boot_editor_init(cui, item, cui->sysinfo,
339 cui_boot_editor_on_exit);
340 cui_set_current(cui, boot_editor_scr(cui->boot_editor));
343 void cui_item_new(struct pmenu *menu)
345 struct cui *cui = cui_from_pmenu(menu);
346 cui->boot_editor = boot_editor_init(cui, NULL, cui->sysinfo,
347 cui_boot_editor_on_exit);
348 cui_set_current(cui, boot_editor_scr(cui->boot_editor));
351 static void cui_sysinfo_exit(struct cui *cui)
353 cui_set_current(cui, &cui->main->scr);
354 talloc_free(cui->sysinfo_screen);
355 cui->sysinfo_screen = NULL;
358 void cui_show_sysinfo(struct cui *cui)
360 cui->sysinfo_screen = sysinfo_screen_init(cui, cui->sysinfo,
362 cui_set_current(cui, sysinfo_screen_scr(cui->sysinfo_screen));
365 static void cui_config_exit(struct cui *cui)
367 cui_set_current(cui, &cui->main->scr);
368 talloc_free(cui->config_screen);
369 cui->config_screen = NULL;
372 void cui_show_config(struct cui *cui)
374 cui->config_screen = config_screen_init(cui, cui->config,
375 cui->sysinfo, cui_config_exit);
376 cui_set_current(cui, config_screen_scr(cui->config_screen));
379 static void cui_lang_exit(struct cui *cui)
381 cui_set_current(cui, &cui->main->scr);
382 talloc_free(cui->lang_screen);
383 cui->lang_screen = NULL;
386 void cui_show_lang(struct cui *cui)
388 cui->lang_screen = lang_screen_init(cui, cui->config, cui_lang_exit);
389 cui_set_current(cui, lang_screen_scr(cui->lang_screen));
392 static void cui_statuslog_exit(struct cui *cui)
394 cui_set_current(cui, &cui->main->scr);
395 talloc_free(cui->statuslog_screen);
396 cui->statuslog_screen = NULL;
399 void cui_show_statuslog(struct cui *cui)
401 cui->statuslog_screen = statuslog_screen_init(cui, cui_statuslog_exit);
402 cui_set_current(cui, statuslog_screen_scr(cui->statuslog_screen));
405 static void cui_add_url_exit(struct cui *cui)
407 cui_set_current(cui, &cui->main->scr);
408 talloc_free(cui->add_url_screen);
409 cui->add_url_screen = NULL;
412 static void cui_plugin_exit(struct cui *cui)
414 cui_set_current(cui, &cui->plugin_menu->scr);
415 talloc_free(cui->plugin_screen);
416 cui->plugin_screen = NULL;
419 static void cui_plugin_menu_exit(struct pmenu *menu)
421 struct cui *cui = cui_from_pmenu(menu);
422 cui_set_current(cui, &cui->main->scr);
425 void cui_show_add_url(struct cui *cui)
427 cui->add_url_screen = add_url_screen_init(cui, cui_add_url_exit);
428 cui_set_current(cui, add_url_screen_scr(cui->add_url_screen));
431 void cui_show_plugin_menu(struct cui *cui)
433 cui_set_current(cui, &cui->plugin_menu->scr);
436 void cui_show_plugin(struct pmenu_item *item)
438 struct cui *cui = cui_from_item(item);
439 cui->plugin_screen = plugin_screen_init(cui, item, cui_plugin_exit);
440 cui_set_current(cui, plugin_screen_scr(cui->plugin_screen));
443 static void cui_help_exit(struct cui *cui)
445 cui_set_current(cui, help_screen_return_scr(cui->help_screen));
446 talloc_free(cui->help_screen);
447 cui->help_screen = NULL;
450 void cui_show_help(struct cui *cui, const char *title,
451 const struct help_text *text)
456 if (cui->help_screen)
459 cui->help_screen = help_screen_init(cui, cui->current,
460 title, text, cui_help_exit);
462 if (cui->help_screen)
463 cui_set_current(cui, help_screen_scr(cui->help_screen));
466 static void cui_subset_exit(struct cui *cui)
468 cui_set_current(cui, subset_screen_return_scr(cui->subset_screen));
469 talloc_free(cui->subset_screen);
470 cui->subset_screen = NULL;
473 void cui_show_subset(struct cui *cui, const char *title,
479 if (cui->subset_screen)
482 cui->subset_screen = subset_screen_init(cui, cui->current,
483 title, arg, cui_subset_exit);
485 if (cui->subset_screen)
486 cui_set_current(cui, subset_screen_scr(cui->subset_screen));
490 * cui_set_current - Set the currently active screen and redraw it.
493 struct nc_scr *cui_set_current(struct cui *cui, struct nc_scr *scr)
497 DBGS("%p -> %p\n", cui->current, scr);
499 assert(cui->current != scr);
506 nc_scr_post(cui->current);
511 static bool process_global_keys(struct cui *cui, int key)
515 if (cui->current && cui->current->main_ncw)
523 * cui_process_key - Process input on stdin.
526 static int cui_process_key(void *arg)
528 struct cui *cui = cui_from_arg(arg);
533 assert(cui->current);
538 pb_debug("%s: got key %d\n", __func__, c);
545 * If this is a console code sequence try to parse it
546 * and don't treat this as a key press.
549 if (grab != ERR && grab != 27) {
551 pb_debug("%s: Caught unhandled command sequence\n",
553 sequence = handle_control_sequence(cui, c);
554 pb_debug("Caught sequence ");
556 pb_debug("(%zu): ", strlen(sequence));
557 for (i = 0; i < strlen(sequence); i++)
558 pb_debug("0%o ", sequence[i]);
561 pb_debug("(0): (none)\n");
566 if (!cui->has_input) {
567 cui->has_input = true;
569 pb_log("UI input received (key = %d), aborting "
570 "default boot\n", c);
571 discover_client_cancel_default(cui->client);
573 pb_log("UI input received (key = %d), aborting "
574 "once server connects\n", c);
578 if (process_global_keys(cui, c))
581 cui->current->process_key(cui->current, c);
588 * cui_process_js - Process joystick events.
591 static int cui_process_js(void *arg)
593 struct cui *cui = cui_from_arg(arg);
596 c = pjs_process_event(cui->pjs);
600 cui_process_key(arg);
607 * cui_handle_resize - Handle the term resize.
610 static void cui_handle_resize(struct cui *cui)
614 if (ioctl(1, TIOCGWINSZ, &ws) == -1) {
615 pb_log("%s: ioctl failed: %s\n", __func__, strerror(errno));
619 pb_debug("%s: {%u,%u}\n", __func__, ws.ws_row, ws.ws_col);
621 wclear(cui->current->main_ncw);
622 resize_term(ws.ws_row, ws.ws_col);
623 cui->current->resize(cui->current);
625 /* For some reason this makes ncurses redraw the screen */
627 redrawwin(cui->current->main_ncw);
628 wrefresh(cui->current->main_ncw);
632 * cui_device_add - Client device_add callback.
634 * Creates menu_items for all the device boot_options and inserts those
635 * menu_items into the main menu. Redraws the main menu if it is active.
636 * If a 'plugin' type boot_option appears the plugin menu is updated instead.
639 static int cui_boot_option_add(struct device *dev, struct boot_option *opt,
642 struct pmenu_item *i, *dev_hdr = NULL;
643 struct cui *cui = cui_from_arg(arg);
644 struct cui_opt_data *cod;
645 const char *tab = " ";
646 unsigned int insert_pt;
647 int result, rows, cols;
653 plugin_option = opt->type == DISCOVER_PLUGIN_OPTION;
654 menu = plugin_option ? cui->plugin_menu : cui->main;
656 pb_debug("%s: %p %s\n", __func__, opt, opt->id);
658 selected = current_item(menu->ncm);
659 menu_format(menu->ncm, &rows, &cols);
661 if (cui->current == &cui->main->scr)
662 nc_scr_unpost(cui->current);
663 if (plugin_option && cui->current == &cui->plugin_menu->scr)
664 nc_scr_unpost(cui->current);
666 /* Check if the boot device is new */
667 dev_hdr = pmenu_find_device(menu, dev, opt);
669 /* All actual boot entries are 'tabbed' across */
670 name = talloc_asprintf(menu, "%s%s",
671 tab, opt->name ? : "Unknown Name");
673 /* Save the item in opt->ui_info for cui_device_remove() */
674 opt->ui_info = i = pmenu_item_create(menu, name);
681 i->on_execute = plugin_install_plugin;
683 i->on_edit = cui_item_edit;
684 i->on_execute = cui_boot;
687 i->data = cod = talloc(i, struct cui_opt_data);
690 cod->opt_hash = pb_opt_hash(dev, opt);
691 cod->name = opt->name;
694 cod->pd = talloc(i, struct pb_plugin_data);
695 cod->pd->plugin_file = talloc_strdup(cod,
696 opt->boot_image_file);
698 cod->bd = talloc(i, struct pb_boot_data);
699 cod->bd->image = talloc_strdup(cod->bd, opt->boot_image_file);
700 cod->bd->initrd = talloc_strdup(cod->bd, opt->initrd_file);
701 cod->bd->dtb = talloc_strdup(cod->bd, opt->dtb_file);
702 cod->bd->args = talloc_strdup(cod->bd, opt->boot_args);
703 cod->bd->args_sig_file = talloc_strdup(cod->bd, opt->args_sig_file);
706 /* This disconnects items array from menu. */
707 result = set_menu_items(menu->ncm, NULL);
710 pb_log("%s: set_menu_items failed: %d\n", __func__, result);
712 /* Insert new items at insert_pt. */
714 insert_pt = pmenu_grow(menu, 2);
715 pmenu_item_insert(menu, dev_hdr, insert_pt);
716 pb_log("%s: adding new device hierarchy %s\n",
717 __func__, opt->device_id);
718 pmenu_item_insert(menu, i, insert_pt+1);
720 insert_pt = pmenu_grow(menu, 1);
721 pmenu_item_add(menu, i, insert_pt);
725 pb_log("%s: adding plugin '%s'\n", __func__, cod->name);
726 pb_log(" file '%s'\n", cod->pd->plugin_file);
728 pb_log("%s: adding opt '%s'\n", __func__, cod->name);
729 pb_log(" image '%s'\n", cod->bd->image);
730 pb_log(" initrd '%s'\n", cod->bd->initrd);
731 pb_log(" args '%s'\n", cod->bd->args);
732 pb_log(" argsig '%s'\n", cod->bd->args_sig_file);
735 /* Update the plugin menu label if needed */
737 struct pmenu_item *item;
739 result = set_menu_items(cui->main->ncm, NULL);
740 for (j = 0 ; j < cui->main->item_count; j++) {
741 item = item_userptr(cui->main->items[j]);
742 if (strncmp(item->nci->name.str, "Plugins", strlen("Plugins")))
745 char *label = talloc_asprintf(item, "Plugins (%u)",
747 pmenu_item_update(item, label);
751 result = set_menu_items(cui->main->ncm, cui->main->items);
753 pb_log("%s: set_menu_items failed: %d\n", __func__, result);
756 /* Re-attach the items array. */
757 result = set_menu_items(menu->ncm, menu->items);
760 pb_log("%s: set_menu_items failed: %d\n", __func__, result);
763 pb_log("%s\n", __func__);
764 pmenu_dump_items(menu->items,
765 item_count(menu->ncm) + 1);
768 if (!item_visible(selected)) {
771 top = top_row(menu->ncm);
772 idx = item_index(selected);
774 /* If our index is above the current top row, align
775 * us to the new top. Otherwise, align us to the new
777 top = top < idx ? idx - rows + 1 : idx;
779 set_top_row(menu->ncm, top);
780 set_current_item(menu->ncm, selected);
783 if (cui->current == &menu->scr)
784 nc_scr_post(cui->current);
785 if (plugin_option && cui->current == &cui->main->scr)
786 nc_scr_post(cui->current);
792 * cui_device_remove - Client device remove callback.
794 * Removes all the menu_items for the device from the main menu and redraws the
795 * main menu if it is active.
797 static void cui_device_remove(struct device *dev, void *arg)
799 struct cui *cui = cui_from_arg(arg);
800 struct boot_option *opt;
802 int rows, cols, top, last;
805 pb_log("%s: %p %s\n", __func__, dev, dev->id);
807 if (cui->current == &cui->main->scr)
808 nc_scr_unpost(cui->current);
809 if (cui->current == &cui->plugin_menu->scr)
810 nc_scr_unpost(cui->current);
812 /* This disconnects items array from menu. */
814 result = set_menu_items(cui->main->ncm, NULL);
815 result |= set_menu_items(cui->plugin_menu->ncm, NULL);
818 pb_log("%s: set_menu_items failed: %d\n", __func__, result);
820 list_for_each_entry(&dev->boot_options, opt, list) {
821 struct pmenu_item *item = pmenu_item_from_arg(opt->ui_info);
823 assert(pb_protocol_device_cmp(dev, cod_from_item(item)->dev));
824 if (opt->type == DISCOVER_PLUGIN_OPTION)
825 pmenu_remove(cui->plugin_menu, item);
827 pmenu_remove(cui->main, item);
830 /* Manually remove remaining device hierarchy item */
831 for (i=0; i < cui->main->item_count; i++) {
832 struct pmenu_item *item = item_userptr(cui->main->items[i]);
833 if (!item || !item->data )
836 struct cui_opt_data *data = item->data;
837 if (data && data->dev && data->dev == dev)
838 pmenu_remove(cui->main,item);
840 /* Look in plugins menu too */
841 for (i=0; i < cui->plugin_menu->item_count; i++) {
842 struct pmenu_item *item = item_userptr(cui->plugin_menu->items[i]);
843 if (!item || !item->data )
846 struct cui_opt_data *data = item->data;
847 if (data && data->dev && data->dev == dev)
848 pmenu_remove(cui->plugin_menu,item);
851 /* Re-attach the items array. */
853 result = set_menu_items(cui->main->ncm, cui->main->items);
854 result |= set_menu_items(cui->plugin_menu->ncm, cui->plugin_menu->items);
856 /* Move cursor to 'Exit' menu entry for the main menu.. */
857 menu_format(cui->main->ncm, &rows, &cols);
858 last = cui->main->item_count - 1;
859 set_current_item(cui->main->ncm, cui->main->items[last]);
860 if (!item_visible(cui->main->items[last])) {
861 top = last < rows ? 0 : last - rows + 1;
862 set_top_row(cui->main->ncm, top);
865 /* ..and the plugin menu */
866 menu_format(cui->plugin_menu->ncm, &rows, &cols);
867 last = cui->plugin_menu->item_count - 1;
868 set_current_item(cui->plugin_menu->ncm, cui->plugin_menu->items[last]);
869 if (!item_visible(cui->plugin_menu->items[last])) {
870 top = last < rows ? 0 : last - rows + 1;
871 set_top_row(cui->plugin_menu->ncm, top);
875 pb_log("%s: set_menu_items failed: %d\n", __func__, result);
878 pb_log("%s\n", __func__);
879 pmenu_dump_items(cui->main->items,
880 item_count(cui->main->ncm) + 1);
883 if (cui->current == &cui->main->scr)
884 nc_scr_post(cui->current);
885 if (cui->current == &cui->plugin_menu->scr)
886 nc_scr_post(cui->current);
889 static void cui_update_status(struct status *status, void *arg)
891 struct cui *cui = cui_from_arg(arg);
893 statuslog_append_steal(cui, cui->statuslog, status);
895 /* Ignore status messages from the backlog */
896 if (!status->backlog)
897 nc_scr_status_printf(cui->current, "%s", status->message);
901 * Handle a new installed plugin option and update its associated
902 * (uninstalled) menu item if it exists.
904 static int cui_plugin_option_add(struct plugin_option *opt, void *arg)
906 struct cui_opt_data *cod;
907 struct cui *cui = cui_from_arg(arg);
908 struct pmenu_item *item = NULL;
909 struct boot_option *dummy_opt;
915 /* Find uninstalled plugin by matching on plugin_file */
916 for (i = 0; i < cui->plugin_menu->item_count; i++) {
917 item = item_userptr(cui->plugin_menu->items[i]);
920 cod = cod_from_item(item);
921 if (!cod || !cod->pd)
923 if (strncmp(cod->pd->plugin_file, opt->plugin_file,
924 strlen(cod->pd->plugin_file)) == 0)
929 * If pb-plugin was run manually there may not be an associated
930 * plugin-type boot_option. Pass a fake device and option to
931 * cui_boot_option_add() so we have an item to work with.
933 if (!item || i >= cui->plugin_menu->item_count) {
934 pb_log("New plugin option %s doesn't have a source item\n",
936 dev = talloc_zero(cui, struct device);
937 dev->id = dev->name = talloc_asprintf(dev, "(unknown)");
938 dev->type = DEVICE_TYPE_UNKNOWN;
939 dummy_opt = talloc_zero(cui, struct boot_option);
940 dummy_opt->device_id = talloc_strdup(dummy_opt, dev->id);
941 dummy_opt->id = dummy_opt->name = talloc_asprintf(dummy_opt, "dummy");
942 dummy_opt->boot_image_file = talloc_strdup(dummy_opt, opt->plugin_file);
943 dummy_opt->type = DISCOVER_PLUGIN_OPTION;
944 cui_boot_option_add(dev, dummy_opt, cui);
949 * If this option was faked above move the context under
950 * the item so it is cleaned up later in cui_plugins_remove().
952 if (strncmp(cod->opt->id, "dummy", strlen("dummy") == 0 &&
953 cod->dev->type == DEVICE_TYPE_UNKNOWN)) {
954 talloc_steal(item, cod->dev);
955 talloc_steal(item, cod->opt);
958 talloc_free(cod->name);
959 /* Name is still tabbed across */
960 cod->name = talloc_asprintf(cod, _(" %s [installed]"), opt->name);
963 item->on_execute = NULL;
964 item->on_edit = cui_show_plugin;
966 if (cui->current == &cui->plugin_menu->scr)
967 nc_scr_unpost(cui->current);
969 /* This disconnects items array from menu. */
970 result = set_menu_items(cui->plugin_menu->ncm, NULL);
973 pmenu_item_update(item, cod->name);
975 /* Re-attach the items array. */
976 result = set_menu_items(cui->plugin_menu->ncm, cui->plugin_menu->items);
978 if (cui->current == &cui->plugin_menu->scr)
979 nc_scr_post(cui->current);
985 * Most plugin menu items will be removed via cui_device_remove(). However if
986 * pb-plugin has been run manually it is possible that there a plugin items
987 * not associated with a device - remove them here.
989 static int cui_plugins_remove(void *arg)
991 struct cui *cui = cui_from_arg(arg);
992 struct pmenu_item *item = NULL;
993 struct cui_opt_data *cod;
996 pb_debug("%s\n", __func__);
998 if (cui->current == &cui->plugin_menu->scr)
999 nc_scr_unpost(cui->current);
1000 if (cui->current == &cui->main->scr)
1001 nc_scr_unpost(cui->current);
1003 /* This disconnects items array from menu. */
1004 set_menu_items(cui->plugin_menu->ncm, NULL);
1006 while (i < cui->plugin_menu->item_count) {
1007 item = item_userptr(cui->plugin_menu->items[i]);
1008 if (!item || !item->data) {
1012 cod = cod_from_item(item);
1013 if (!cod->opt && !cod->dev) {
1018 pmenu_remove(cui->plugin_menu, item);
1019 /* plugin_menu entries will shift, jump to bottom to make sure
1020 * we remove all plugin option items */
1024 /* Re-attach the items array. */
1025 set_menu_items(cui->plugin_menu->ncm, cui->plugin_menu->items);
1027 set_menu_items(cui->main->ncm, NULL);
1028 for (i = 0; i < cui->main->item_count; i++) {
1029 item = item_userptr(cui->main->items[i]);
1030 if (strncmp(item->nci->name.str, "Plugins", strlen("Plugins")))
1033 pmenu_item_update(item, "Plugins (0)");
1037 set_menu_items(cui->main->ncm, cui->main->items);
1039 if (cui->current == &cui->main->scr)
1040 nc_scr_post(cui->current);
1042 /* If we're currently in a plugin screen jump back to the plugin menu */
1043 if (cui->plugin_screen &&
1044 cui->current == plugin_screen_scr(cui->plugin_screen))
1045 cui_plugin_exit(cui);
1050 static void cui_update_mm_title(struct cui *cui)
1052 struct nc_frame *frame = &cui->main->scr.frame;
1054 talloc_free(frame->rtitle);
1056 frame->rtitle = talloc_strdup(cui->main, cui->sysinfo->type);
1057 if (cui->sysinfo->identifier)
1058 frame->rtitle = talloc_asprintf_append(frame->rtitle,
1059 " %s", cui->sysinfo->identifier);
1061 if (cui->current == &cui->main->scr)
1062 nc_scr_post(cui->current);
1064 frame = &cui->plugin_menu->scr.frame;
1066 talloc_free(frame->rtitle);
1068 frame->rtitle = talloc_strdup(cui->main, cui->sysinfo->type);
1069 if (cui->sysinfo->identifier)
1070 frame->rtitle = talloc_asprintf_append(frame->rtitle,
1071 " %s", cui->sysinfo->identifier);
1073 if (cui->current == &cui->main->scr)
1074 nc_scr_post(cui->current);
1077 static void cui_update_sysinfo(struct system_info *sysinfo, void *arg)
1079 struct cui *cui = cui_from_arg(arg);
1080 cui->sysinfo = talloc_steal(cui, sysinfo);
1082 /* if we're currently displaying the system info screen, inform it
1083 * of the updated information. */
1084 if (cui->sysinfo_screen)
1085 sysinfo_screen_update(cui->sysinfo_screen, sysinfo);
1087 if (cui->subset_screen)
1088 subset_screen_update(cui->subset_screen);
1090 /* ... and do the same with the config screen... */
1091 if (cui->config_screen)
1092 config_screen_update(cui->config_screen, cui->config, sysinfo);
1094 /* ... and the boot editor. */
1095 if (cui->boot_editor)
1096 boot_editor_update(cui->boot_editor, sysinfo);
1098 cui_update_mm_title(cui);
1101 static void cui_update_language(struct cui *cui, char *lang)
1106 cur_lang = setlocale(LC_ALL, NULL);
1107 if (cur_lang && !strcmp(cur_lang, lang))
1110 setlocale(LC_ALL, lang);
1112 /* we'll need to update the menu: drop all items and repopulate */
1113 repost_menu = cui->current == &cui->main->scr ||
1114 cui->current == &cui->plugin_menu->scr;
1116 nc_scr_unpost(cui->current);
1118 talloc_free(cui->main);
1119 cui->main = main_menu_init(cui);
1120 cui->plugin_menu = plugin_menu_init(cui);
1123 cui->current = &cui->main->scr;
1124 nc_scr_post(cui->current);
1127 discover_client_enumerate(cui->client);
1130 static void cui_update_config(struct config *config, void *arg)
1132 struct cui *cui = cui_from_arg(arg);
1133 cui->config = talloc_steal(cui, config);
1136 cui_update_language(cui, config->lang);
1138 if (cui->subset_screen)
1139 subset_screen_update(cui->subset_screen);
1141 if (cui->config_screen)
1142 config_screen_update(cui->config_screen, config, cui->sysinfo);
1144 if (config->safe_mode)
1145 nc_scr_status_printf(cui->current,
1146 _("SAFE MODE: select '%s' to continue"),
1147 _("Rescan devices"));
1150 int cui_send_config(struct cui *cui, struct config *config)
1152 return discover_client_send_config(cui->client, config);
1155 int cui_send_url(struct cui *cui, char * url)
1157 return discover_client_send_url(cui->client, url);
1160 int cui_send_plugin_install(struct cui *cui, char *file)
1162 return discover_client_send_plugin_install(cui->client, file);
1165 void cui_send_reinit(struct cui *cui)
1167 discover_client_send_reinit(cui->client);
1170 static int menu_sysinfo_execute(struct pmenu_item *item)
1172 cui_show_sysinfo(cui_from_item(item));
1176 static int menu_config_execute(struct pmenu_item *item)
1178 cui_show_config(cui_from_item(item));
1182 static int menu_lang_execute(struct pmenu_item *item)
1184 cui_show_lang(cui_from_item(item));
1188 static int menu_statuslog_execute(struct pmenu_item *item)
1190 cui_show_statuslog(cui_from_item(item));
1194 static int menu_reinit_execute(struct pmenu_item *item)
1196 if (cui_from_item(item)->client)
1197 cui_send_reinit(cui_from_item(item));
1201 static int menu_add_url_execute(struct pmenu_item *item)
1203 if (cui_from_item(item)->client)
1204 cui_show_add_url(cui_from_item(item));
1208 static int menu_plugin_execute(struct pmenu_item *item)
1210 if (cui_from_item(item)->client)
1211 cui_show_plugin_menu(cui_from_item(item));
1216 * pb_mm_init - Setup the main menu instance.
1218 static struct pmenu *main_menu_init(struct cui *cui)
1220 struct pmenu_item *i;
1223 bool lockdown = lockdown_active();
1225 m = pmenu_init(cui, 9, cui_on_exit);
1227 pb_log("%s: failed\n", __func__);
1231 m->on_new = cui_item_new;
1233 m->scr.frame.ltitle = talloc_asprintf(m,
1234 "Petitboot (" PACKAGE_VERSION ")");
1235 m->scr.frame.rtitle = NULL;
1236 m->scr.frame.help = talloc_strdup(m,
1237 _("Enter=accept, e=edit, n=new, x=exit, l=language, g=log, h=help"));
1238 m->scr.frame.status = talloc_strdup(m, _("Welcome to Petitboot"));
1240 /* add a separator */
1241 i = pmenu_item_create(m, " ");
1242 item_opts_off(i->nci, O_SELECTABLE);
1243 pmenu_item_insert(m, i, 0);
1245 /* add system items */
1246 i = pmenu_item_create(m, _("System information"));
1247 i->on_execute = menu_sysinfo_execute;
1248 pmenu_item_insert(m, i, 1);
1250 i = pmenu_item_create(m, _("System configuration"));
1251 i->on_execute = menu_config_execute;
1252 pmenu_item_insert(m, i, 2);
1254 i = pmenu_item_create(m, _("System status log"));
1255 i->on_execute = menu_statuslog_execute;
1256 pmenu_item_insert(m, i, 3);
1258 /* this label isn't translated, so we don't want a gettext() here */
1259 i = pmenu_item_create(m, "Language");
1260 i->on_execute = menu_lang_execute;
1261 pmenu_item_insert(m, i, 4);
1263 i = pmenu_item_create(m, _("Rescan devices"));
1264 i->on_execute = menu_reinit_execute;
1265 pmenu_item_insert(m, i, 5);
1267 i = pmenu_item_create(m, _("Retrieve config from URL"));
1268 i->on_execute = menu_add_url_execute;
1269 pmenu_item_insert(m, i, 6);
1271 i = pmenu_item_create(m, _("Plugins (0)"));
1272 i->on_execute = menu_plugin_execute;
1273 pmenu_item_insert(m, i, 7);
1276 i = pmenu_item_create(m, _("Reboot"));
1278 i = pmenu_item_create(m, _("Exit to shell"));
1279 i->on_execute = pmenu_exit_cb;
1280 pmenu_item_insert(m, i, 8);
1282 result = pmenu_setup(m);
1285 pb_log("%s:%d: pmenu_setup failed: %s\n", __func__, __LINE__,
1290 m->help_title = _("main menu");
1291 m->help_text = &main_menu_help_text;
1293 menu_opts_off(m->ncm, O_SHOWDESC);
1294 set_menu_mark(m->ncm, " *");
1295 set_current_item(m->ncm, i->nci);
1305 * plugin_menu_init: Set up the plugin menu instance
1307 static struct pmenu *plugin_menu_init(struct cui *cui)
1309 struct pmenu_item *i;
1313 m = pmenu_init(cui, 2, cui_plugin_menu_exit);
1314 m->on_new = cui_item_new;
1315 m->scr.frame.ltitle = talloc_asprintf(m, _("Petitboot Plugins"));
1316 m->scr.frame.rtitle = talloc_asprintf(m, NULL);
1317 m->scr.frame.help = talloc_strdup(m,
1318 _("Enter=install, e=details, x=exit, h=help"));
1319 m->scr.frame.status = talloc_asprintf(m,
1320 _("Available Petitboot Plugins"));
1322 /* add a separator */
1323 i = pmenu_item_create(m, " ");
1324 item_opts_off(i->nci, O_SELECTABLE);
1325 pmenu_item_insert(m, i, 0);
1327 i = pmenu_item_create(m, _("Return to Main Menu"));
1328 i->on_execute = pmenu_exit_cb;
1329 pmenu_item_insert(m, i, 1);
1331 result = pmenu_setup(m);
1334 pb_log("%s:%d: pmenu_setup failed: %s\n", __func__, __LINE__,
1339 m->help_title = _("plugin menu");
1340 m->help_text = &plugin_menu_help_text;
1349 static struct discover_client_ops cui_client_ops = {
1351 .boot_option_add = cui_boot_option_add,
1352 .device_remove = cui_device_remove,
1353 .plugin_option_add = cui_plugin_option_add,
1354 .plugins_remove = cui_plugins_remove,
1355 .update_status = cui_update_status,
1356 .update_sysinfo = cui_update_sysinfo,
1357 .update_config = cui_update_config,
1360 /* cui_server_wait_on_exit - On exit spin until the server is available.
1362 * If the program exits before connecting to the server autoboot won't be
1363 * cancelled even though there has been keyboard activity. This function is
1364 * called by a child process which will spin until the server is connected and
1365 * told to cancel autoboot.
1367 * Processes exiting from this function will not carry out the cui_atexit()
1370 static void cui_server_wait_on_exit(struct cui *cui)
1372 cui_detached = true;
1374 while (!cui->client) {
1375 cui->client = discover_client_init(cui->waitset,
1376 &cui_client_ops, cui);
1381 talloc_steal(cui, cui->client);
1382 discover_client_cancel_default(cui->client);
1385 /* cui_server_wait - Connect to the discover server.
1386 * @arg: Pointer to the cui instance.
1388 * A timeout callback that attempts to connect to the discover server; on
1389 * failure it registers itself with a one second timeout to try again.
1390 * On success the cui->client struct will be set.
1392 * Since this updates the status line when called it must not be called
1393 * before the UI is ready.
1395 static int cui_server_wait(void *arg)
1397 struct cui *cui = cui_from_arg(arg);
1400 pb_debug("We already have a server!\n");
1404 /* We haven't yet connected to the server */
1405 pb_log("Trying to connect...\n");
1406 cui->client = discover_client_init(cui->waitset,
1407 &cui_client_ops, cui);
1410 waiter_register_timeout(cui->waitset, 1000, cui_server_wait,
1412 nc_scr_status_printf(cui->current,
1413 "Info: Waiting for device discovery");
1415 nc_scr_status_free(cui->current);
1416 talloc_steal(cui, cui->client);
1418 if (cui->has_input) {
1419 pb_log("Aborting default boot on pb-discover connect\n");
1420 discover_client_cancel_default(cui->client);
1428 * cui_init - Setup the cui instance.
1429 * @platform_info: A value for the struct cui platform_info member.
1431 * Returns a pointer to a struct cui on success, or NULL on error.
1433 * Allocates the cui instance, sets up the client and stdin waiters, and
1434 * sets up the ncurses menu screen.
1437 struct cui *cui_init(void* platform_info,
1438 int (*js_map)(const struct js_event *e), int start_daemon, int timeout)
1443 cui = talloc_zero(NULL, struct cui);
1445 pb_log("%s: alloc cui failed.\n", __func__);
1446 fprintf(stderr, _("%s: alloc cui failed.\n"), __func__);
1450 cui->c_sig = pb_cui_sig;
1451 cui->platform_info = platform_info;
1452 cui->waitset = waitset_create(cui);
1453 cui->statuslog = statuslog_init(cui);
1455 process_init(cui, cui->waitset, false);
1457 /* Loop here for scripts that just started the server. */
1460 for (i = start_daemon ? 2 : 15; i && timeout; i--) {
1461 cui->client = discover_client_init(cui->waitset,
1462 &cui_client_ops, cui);
1463 if (cui->client || !i)
1465 pb_log("%s: waiting for server %d\n", __func__, i);
1469 if (!cui->client && start_daemon) {
1474 result = pb_start_daemon(cui);
1479 pb_log("%s: discover_client_init failed.\n", __func__);
1480 fprintf(stderr, _("%s: error: discover_client_init failed.\n"),
1482 fprintf(stderr, _("could not start pb-discover, the petitboot "
1484 goto fail_client_init;
1487 if (!cui->client && !timeout) {
1488 /* Have the first timeout fire immediately so we can check
1489 * for the server as soon as the UI is ready */
1490 waiter_register_timeout(cui->waitset, 0,
1491 cui_server_wait, cui);
1492 } else if (!cui->client) {
1493 pb_log("%s: discover_client_init failed.\n", __func__);
1494 fprintf(stderr, _("%s: error: discover_client_init failed.\n"),
1496 fprintf(stderr, _("check that pb-discover, "
1497 "the petitboot daemon is running.\n"));
1498 goto fail_client_init;
1502 talloc_steal(cui, cui->client);
1505 cui->main = main_menu_init(cui);
1507 goto fail_client_init;
1509 cui->plugin_menu = plugin_menu_init(cui);
1510 if (!cui->plugin_menu)
1511 goto fail_client_init;
1513 waiter_register_io(cui->waitset, STDIN_FILENO, WAIT_IN,
1514 cui_process_key, cui);
1518 cui->pjs = pjs_init(cui, js_map);
1521 waiter_register_io(cui->waitset, pjs_get_fd(cui->pjs),
1522 WAIT_IN, cui_process_js, cui);
1534 * cui_run - The main cui program loop.
1535 * @cui: The cui instance.
1536 * @main: The menu to use as the main menu.
1538 * Runs the cui engine. Does not return until indicated to do so by some
1539 * user action, or an error occurs. Frees the cui object on return.
1540 * Returns 0 on success (return to shell), -1 on error (should restart).
1543 int cui_run(struct cui *cui)
1549 cui->current = &cui->main->scr;
1550 cui->default_item = 0;
1552 nc_scr_post(cui->current);
1555 int result = waiter_poll(cui->waitset);
1558 pb_log("%s: poll: %s\n", __func__, strerror(errno));
1565 while (cui->resize) {
1567 cui_handle_resize(cui);
1574 /* Fork a child to tell the server to cancel autoboot */
1577 cui_server_wait_on_exit(cui);
1581 pb_log("Failed to fork child on exit: %m\n");
1584 return cui->abort ? 0 : -1;