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 void cui_cancel_autoboot_on_exit(struct cui *cui);
61 static bool lockdown_active(void)
63 bool lockdown = false;
64 if (access(LOCKDOWN_FILE, F_OK) != -1)
69 static void cui_start(void)
71 initscr(); /* Initialize ncurses. */
72 cbreak(); /* Disable line buffering. */
73 noecho(); /* Disable getch() echo. */
74 keypad(stdscr, TRUE); /* Enable num keypad keys. */
75 nonl(); /* Disable new-line translation. */
76 intrflush(stdscr, FALSE); /* Disable interrupt flush. */
77 curs_set(0); /* Make cursor invisible */
78 nodelay(stdscr, TRUE); /* Enable non-blocking getch() */
80 /* We may be operating with an incorrect $TERM type; in this case
81 * the keymappings will be slightly broken. We want at least
82 * backspace to work though, so we'll define both DEL and ^H to
84 define_key("\x7f", KEY_BACKSPACE);
85 define_key("\x08", KEY_BACKSPACE);
87 /* we need backtab too, for form navigation. vt220 doesn't include
88 * this (kcbt), but we don't want to require a full linux/xterm termcap
90 define_key("\x1b[Z", KEY_BTAB);
92 /* We'll define a few other keys too since they're commonly
93 * used for navigation but the escape character will cause
94 * Petitboot to exit if they're left undefined */
95 define_key("\x1b\x5b\x35\x7e", KEY_PPAGE);
96 define_key("\x1b\x5b\x36\x7e", KEY_NPAGE);
97 define_key("\x1b\x5b\x31\x7e", KEY_HOME);
98 define_key("\x1b\x5b\x34\x7e", KEY_END);
99 define_key("\x1b\x4f\x48", KEY_HOME);
100 define_key("\x1b\x4f\x46", KEY_END);
101 define_key("OH", KEY_HOME);
102 define_key("OF", KEY_END);
104 /* Arrow keys in normal cursor mode */
105 define_key("\x1b\x5b\x41", KEY_UP);
106 define_key("\x1b\x5b\x42", KEY_DOWN);
107 define_key("\x1b\x5b\x43", KEY_RIGHT);
108 define_key("\x1b\x5b\x44", KEY_LEFT);
109 /* Arrow keys in "application" cursor mode */
110 define_key("\x1b\x4f\x41", KEY_UP);
111 define_key("\x1b\x4f\x42", KEY_DOWN);
112 define_key("\x1b\x4f\x43", KEY_RIGHT);
113 define_key("\x1b\x4f\x44", KEY_LEFT);
115 define_key("\x1b\x5b\x33\x7e", KEY_DC);
117 while (getch() != ERR) /* flush stdin */
121 static void cui_atexit(void)
130 bool lockdown = lockdown_active();
139 * cui_abort - Signal the main cui program loop to exit.
141 * Sets cui.abort, which causes the cui_run() routine to return.
144 void cui_abort(struct cui *cui)
146 pb_log("%s: exiting\n", __func__);
151 * cui_resize - Signal the main cui program loop to resize
153 * Called at SIGWINCH.
156 void cui_resize(struct cui *cui)
158 pb_debug("%s: resizing\n", __func__);
163 * cui_on_exit - A generic main menu exit callback.
166 void cui_on_exit(struct pmenu *menu)
168 struct cui *cui = cui_from_pmenu(menu);
171 cui_cancel_autoboot_on_exit(cui);
173 sh_cmd = talloc_asprintf(cui,
174 "echo \"Exiting petitboot. Type 'exit' to return.\";\
175 echo \"You may run 'pb-sos' to gather diagnostic data\";\
176 %s", pb_system_apps.sh);
179 pb_log("Failed to allocate shell arguments\n");
183 const char *argv[] = {
190 cui_run_cmd(cui, argv);
192 nc_scr_status_printf(cui->current, _("Returned from shell"));
197 * cui_run_cmd - A generic cb to run the supplied command.
200 int cui_run_cmd(struct cui *cui, const char **cmd_argv)
202 struct process *process;
205 process = process_create(cui);
209 process->path = cmd_argv[0];
210 process->argv = cmd_argv;
211 process->raw_stdout = true;
213 nc_scr_status_printf(cui->current, _("Running %s..."), cmd_argv[0]);
215 nc_scr_unpost(cui->current);
222 result = process_run_sync(process);
227 redrawwin(cui->current->main_ncw);
228 nc_scr_post(cui->current);
231 pb_log("%s: failed: '%s'\n", __func__, cmd_argv[0]);
232 nc_scr_status_printf(cui->current, _("Failed: %s"),
236 process_release(process);
241 int cui_run_cmd_from_item(struct pmenu_item *item)
243 struct cui *cui = cui_from_item(item);
244 const char **cmd_argv = item->data;
246 return cui_run_cmd(cui, cmd_argv);
250 * cui_boot - A generic cb to run kexec.
253 static int cui_boot(struct pmenu_item *item)
256 struct cui *cui = cui_from_item(item);
257 struct cui_opt_data *cod = cod_from_item(item);
259 assert(cui->current == &cui->main->scr);
261 pb_debug("%s: %s\n", __func__, cod->name);
263 nc_scr_status_printf(cui->current, _("Booting %s..."), cod->name);
265 result = discover_client_boot(cui->client, NULL, cod->opt, cod->bd);
268 nc_scr_status_printf(cui->current,
269 _("Failed: boot %s"), cod->bd->image);
275 static void cui_boot_editor_on_exit(struct cui *cui,
276 struct pmenu_item *item,
277 struct pb_boot_data *bd)
279 struct pmenu *menu = cui->main;
280 struct cui_opt_data *cod;
281 int idx, top, rows, cols;
282 static int user_idx = 0;
284 /* Was the edit cancelled? */
286 cui_set_current(cui, &cui->main->scr);
287 talloc_free(cui->boot_editor);
288 cui->boot_editor = NULL;
292 /* Is this was a new item, we'll need to update the menu */
296 cod = talloc_zero(NULL, struct cui_opt_data);
297 cod->name = talloc_asprintf(cod, _("User item %u"), ++user_idx);
299 item = pmenu_item_create(menu, cod->name);
305 item->on_edit = cui_item_edit;
306 item->on_execute = cui_boot;
309 talloc_steal(item, cod);
311 /* Detach the items array. */
312 set_menu_items(menu->ncm, NULL);
314 /* Insert new item at insert_pt. */
315 insert_pt = pmenu_grow(menu, 1);
316 pmenu_item_insert(menu, item, insert_pt);
318 /* Re-attach the items array. */
319 set_menu_items(menu->ncm, menu->items);
321 /* If our index is above the current top row, align
322 * us to the new top. Otherwise, align us to the new
324 menu_format(cui->main->ncm, &rows, &cols);
325 top = top_row(cui->main->ncm);
326 idx = item_index(item->nci);
331 top = idx < rows ? 0 : idx - rows + 1;
333 set_top_row(cui->main->ncm, top);
334 set_current_item(item->pmenu->ncm, item->nci);
336 nc_scr_post(&menu->scr);
341 cod->bd = talloc_steal(cod, bd);
344 cui_set_current(cui, &cui->main->scr);
345 talloc_free(cui->boot_editor);
346 cui->boot_editor = NULL;
349 void cui_item_edit(struct pmenu_item *item)
351 struct cui *cui = cui_from_item(item);
352 cui->boot_editor = boot_editor_init(cui, item, cui->sysinfo,
353 cui_boot_editor_on_exit);
354 cui_set_current(cui, boot_editor_scr(cui->boot_editor));
357 void cui_item_new(struct pmenu *menu)
359 struct cui *cui = cui_from_pmenu(menu);
360 cui->boot_editor = boot_editor_init(cui, NULL, cui->sysinfo,
361 cui_boot_editor_on_exit);
362 cui_set_current(cui, boot_editor_scr(cui->boot_editor));
365 static void cui_sysinfo_exit(struct cui *cui)
367 cui_set_current(cui, &cui->main->scr);
368 talloc_free(cui->sysinfo_screen);
369 cui->sysinfo_screen = NULL;
372 void cui_show_sysinfo(struct cui *cui)
374 cui->sysinfo_screen = sysinfo_screen_init(cui, cui->sysinfo,
376 cui_set_current(cui, sysinfo_screen_scr(cui->sysinfo_screen));
379 static void cui_config_exit(struct cui *cui)
381 cui_set_current(cui, &cui->main->scr);
382 talloc_free(cui->config_screen);
383 cui->config_screen = NULL;
386 void cui_show_config(struct cui *cui)
388 cui->config_screen = config_screen_init(cui, cui->config,
389 cui->sysinfo, cui_config_exit);
390 cui_set_current(cui, config_screen_scr(cui->config_screen));
393 static void cui_lang_exit(struct cui *cui)
395 cui_set_current(cui, &cui->main->scr);
396 talloc_free(cui->lang_screen);
397 cui->lang_screen = NULL;
400 void cui_show_lang(struct cui *cui)
402 cui->lang_screen = lang_screen_init(cui, cui->config, cui_lang_exit);
403 cui_set_current(cui, lang_screen_scr(cui->lang_screen));
406 static void cui_statuslog_exit(struct cui *cui)
408 cui_set_current(cui, &cui->main->scr);
409 talloc_free(cui->statuslog_screen);
410 cui->statuslog_screen = NULL;
413 void cui_show_statuslog(struct cui *cui)
415 cui->statuslog_screen = statuslog_screen_init(cui, cui_statuslog_exit);
416 cui_set_current(cui, statuslog_screen_scr(cui->statuslog_screen));
419 static void cui_add_url_exit(struct cui *cui)
421 cui_set_current(cui, &cui->main->scr);
422 talloc_free(cui->add_url_screen);
423 cui->add_url_screen = NULL;
426 static void cui_plugin_exit(struct cui *cui)
428 cui_set_current(cui, &cui->plugin_menu->scr);
429 talloc_free(cui->plugin_screen);
430 cui->plugin_screen = NULL;
433 static void cui_plugin_menu_exit(struct pmenu *menu)
435 struct cui *cui = cui_from_pmenu(menu);
436 cui_set_current(cui, &cui->main->scr);
439 void cui_show_add_url(struct cui *cui)
441 cui->add_url_screen = add_url_screen_init(cui, cui_add_url_exit);
442 cui_set_current(cui, add_url_screen_scr(cui->add_url_screen));
445 void cui_show_plugin_menu(struct cui *cui)
447 cui_set_current(cui, &cui->plugin_menu->scr);
450 void cui_show_plugin(struct pmenu_item *item)
452 struct cui *cui = cui_from_item(item);
453 cui->plugin_screen = plugin_screen_init(cui, item, cui_plugin_exit);
454 cui_set_current(cui, plugin_screen_scr(cui->plugin_screen));
457 static void cui_help_exit(struct cui *cui)
459 cui_set_current(cui, help_screen_return_scr(cui->help_screen));
460 talloc_free(cui->help_screen);
461 cui->help_screen = NULL;
464 void cui_show_help(struct cui *cui, const char *title,
465 const struct help_text *text)
470 if (cui->help_screen)
473 cui->help_screen = help_screen_init(cui, cui->current,
474 title, text, cui_help_exit);
476 if (cui->help_screen)
477 cui_set_current(cui, help_screen_scr(cui->help_screen));
480 static void cui_subset_exit(struct cui *cui)
482 cui_set_current(cui, subset_screen_return_scr(cui->subset_screen));
483 talloc_free(cui->subset_screen);
484 cui->subset_screen = NULL;
487 void cui_show_subset(struct cui *cui, const char *title,
493 if (cui->subset_screen)
496 cui->subset_screen = subset_screen_init(cui, cui->current,
497 title, arg, cui_subset_exit);
499 if (cui->subset_screen)
500 cui_set_current(cui, subset_screen_scr(cui->subset_screen));
504 * cui_set_current - Set the currently active screen and redraw it.
507 struct nc_scr *cui_set_current(struct cui *cui, struct nc_scr *scr)
511 DBGS("%p -> %p\n", cui->current, scr);
513 assert(cui->current != scr);
520 nc_scr_post(cui->current);
525 static bool process_global_keys(struct cui *cui, int key)
529 if (cui->current && cui->current->main_ncw)
537 * cui_process_key - Process input on stdin.
540 static int cui_process_key(void *arg)
542 struct cui *cui = cui_from_arg(arg);
547 assert(cui->current);
552 pb_debug("%s: got key %d\n", __func__, c);
559 * If this is a console code sequence try to parse it
560 * and don't treat this as a key press.
563 if (grab != ERR && grab != 27) {
565 pb_debug("%s: Caught unhandled command sequence\n",
567 sequence = handle_control_sequence(cui, c);
568 pb_debug("Caught sequence ");
570 pb_debug("(%zu): ", strlen(sequence));
571 for (i = 0; i < strlen(sequence); i++)
572 pb_debug("0%o ", sequence[i]);
575 pb_debug("(0): (none)\n");
580 if (!cui->has_input) {
581 cui->has_input = true;
583 pb_log("UI input received (key = %d), aborting "
584 "default boot\n", c);
585 discover_client_cancel_default(cui->client);
587 pb_log("UI input received (key = %d), aborting "
588 "once server connects\n", c);
592 if (process_global_keys(cui, c))
595 cui->current->process_key(cui->current, c);
602 * cui_process_js - Process joystick events.
605 static int cui_process_js(void *arg)
607 struct cui *cui = cui_from_arg(arg);
610 c = pjs_process_event(cui->pjs);
614 cui_process_key(arg);
621 * cui_handle_resize - Handle the term resize.
624 static void cui_handle_resize(struct cui *cui)
628 if (ioctl(1, TIOCGWINSZ, &ws) == -1) {
629 pb_log("%s: ioctl failed: %s\n", __func__, strerror(errno));
633 pb_debug("%s: {%u,%u}\n", __func__, ws.ws_row, ws.ws_col);
635 wclear(cui->current->main_ncw);
636 resize_term(ws.ws_row, ws.ws_col);
637 cui->current->resize(cui->current);
639 /* For some reason this makes ncurses redraw the screen */
641 redrawwin(cui->current->main_ncw);
642 wrefresh(cui->current->main_ncw);
646 * cui_device_add - Client device_add callback.
648 * Creates menu_items for all the device boot_options and inserts those
649 * menu_items into the main menu. Redraws the main menu if it is active.
650 * If a 'plugin' type boot_option appears the plugin menu is updated instead.
653 static int cui_boot_option_add(struct device *dev, struct boot_option *opt,
656 struct pmenu_item *i, *dev_hdr = NULL;
657 struct cui *cui = cui_from_arg(arg);
658 struct cui_opt_data *cod;
659 const char *tab = " ";
660 unsigned int insert_pt;
661 int result, rows, cols;
667 plugin_option = opt->type == DISCOVER_PLUGIN_OPTION;
668 menu = plugin_option ? cui->plugin_menu : cui->main;
670 pb_debug("%s: %p %s\n", __func__, opt, opt->id);
672 selected = current_item(menu->ncm);
673 menu_format(menu->ncm, &rows, &cols);
675 if (cui->current == &cui->main->scr)
676 nc_scr_unpost(cui->current);
677 if (plugin_option && cui->current == &cui->plugin_menu->scr)
678 nc_scr_unpost(cui->current);
680 /* Check if the boot device is new */
681 dev_hdr = pmenu_find_device(menu, dev, opt);
683 /* All actual boot entries are 'tabbed' across */
684 name = talloc_asprintf(menu, "%s%s",
685 tab, opt->name ? : "Unknown Name");
687 /* Save the item in opt->ui_info for cui_device_remove() */
688 opt->ui_info = i = pmenu_item_create(menu, name);
695 i->on_execute = plugin_install_plugin;
697 i->on_edit = cui_item_edit;
698 i->on_execute = cui_boot;
701 i->data = cod = talloc(i, struct cui_opt_data);
704 cod->opt_hash = pb_opt_hash(dev, opt);
705 cod->name = opt->name;
708 cod->pd = talloc(i, struct pb_plugin_data);
709 cod->pd->plugin_file = talloc_strdup(cod,
710 opt->boot_image_file);
712 cod->bd = talloc(i, struct pb_boot_data);
713 cod->bd->image = talloc_strdup(cod->bd, opt->boot_image_file);
714 cod->bd->initrd = talloc_strdup(cod->bd, opt->initrd_file);
715 cod->bd->dtb = talloc_strdup(cod->bd, opt->dtb_file);
716 cod->bd->args = talloc_strdup(cod->bd, opt->boot_args);
717 cod->bd->args_sig_file = talloc_strdup(cod->bd, opt->args_sig_file);
720 /* This disconnects items array from menu. */
721 result = set_menu_items(menu->ncm, NULL);
724 pb_log("%s: set_menu_items failed: %d\n", __func__, result);
726 /* Insert new items at insert_pt. */
728 insert_pt = pmenu_grow(menu, 2);
729 pmenu_item_insert(menu, dev_hdr, insert_pt);
730 pb_log("%s: adding new device hierarchy %s\n",
731 __func__, opt->device_id);
732 pmenu_item_insert(menu, i, insert_pt+1);
734 insert_pt = pmenu_grow(menu, 1);
735 pmenu_item_add(menu, i, insert_pt);
739 pb_log("%s: adding plugin '%s'\n", __func__, cod->name);
740 pb_log(" file '%s'\n", cod->pd->plugin_file);
742 pb_log("%s: adding opt '%s'\n", __func__, cod->name);
743 pb_log(" image '%s'\n", cod->bd->image);
744 pb_log(" initrd '%s'\n", cod->bd->initrd);
745 pb_log(" args '%s'\n", cod->bd->args);
746 pb_log(" argsig '%s'\n", cod->bd->args_sig_file);
749 /* Update the plugin menu label if needed */
751 struct pmenu_item *item;
753 result = set_menu_items(cui->main->ncm, NULL);
754 for (j = 0 ; j < cui->main->item_count; j++) {
755 item = item_userptr(cui->main->items[j]);
756 if (strncmp(item->nci->name.str, "Plugins", strlen("Plugins")))
759 char *label = talloc_asprintf(item, "Plugins (%u)",
761 pmenu_item_update(item, label);
765 result = set_menu_items(cui->main->ncm, cui->main->items);
767 pb_log("%s: set_menu_items failed: %d\n", __func__, result);
770 /* Re-attach the items array. */
771 result = set_menu_items(menu->ncm, menu->items);
774 pb_log("%s: set_menu_items failed: %d\n", __func__, result);
777 pb_log("%s\n", __func__);
778 pmenu_dump_items(menu->items,
779 item_count(menu->ncm) + 1);
782 if (!item_visible(selected)) {
785 top = top_row(menu->ncm);
786 idx = item_index(selected);
788 /* If our index is above the current top row, align
789 * us to the new top. Otherwise, align us to the new
791 top = top < idx ? idx - rows + 1 : idx;
793 set_top_row(menu->ncm, top);
794 set_current_item(menu->ncm, selected);
797 if (cui->current == &menu->scr)
798 nc_scr_post(cui->current);
799 if (plugin_option && cui->current == &cui->main->scr)
800 nc_scr_post(cui->current);
806 * cui_device_remove - Client device remove callback.
808 * Removes all the menu_items for the device from the main menu and redraws the
809 * main menu if it is active.
811 static void cui_device_remove(struct device *dev, void *arg)
813 struct cui *cui = cui_from_arg(arg);
814 struct boot_option *opt;
816 int rows, cols, top, last;
819 pb_log("%s: %p %s\n", __func__, dev, dev->id);
821 if (cui->current == &cui->main->scr)
822 nc_scr_unpost(cui->current);
823 if (cui->current == &cui->plugin_menu->scr)
824 nc_scr_unpost(cui->current);
826 /* This disconnects items array from menu. */
828 result = set_menu_items(cui->main->ncm, NULL);
829 result |= set_menu_items(cui->plugin_menu->ncm, NULL);
832 pb_log("%s: set_menu_items failed: %d\n", __func__, result);
834 list_for_each_entry(&dev->boot_options, opt, list) {
835 struct pmenu_item *item = pmenu_item_from_arg(opt->ui_info);
837 assert(pb_protocol_device_cmp(dev, cod_from_item(item)->dev));
838 if (opt->type == DISCOVER_PLUGIN_OPTION)
839 pmenu_remove(cui->plugin_menu, item);
841 pmenu_remove(cui->main, item);
844 /* Manually remove remaining device hierarchy item */
845 for (i=0; i < cui->main->item_count; i++) {
846 struct pmenu_item *item = item_userptr(cui->main->items[i]);
847 if (!item || !item->data )
850 struct cui_opt_data *data = item->data;
851 if (data && data->dev && data->dev == dev)
852 pmenu_remove(cui->main,item);
854 /* Look in plugins menu too */
855 for (i=0; i < cui->plugin_menu->item_count; i++) {
856 struct pmenu_item *item = item_userptr(cui->plugin_menu->items[i]);
857 if (!item || !item->data )
860 struct cui_opt_data *data = item->data;
861 if (data && data->dev && data->dev == dev)
862 pmenu_remove(cui->plugin_menu,item);
865 /* Re-attach the items array. */
867 result = set_menu_items(cui->main->ncm, cui->main->items);
868 result |= set_menu_items(cui->plugin_menu->ncm, cui->plugin_menu->items);
870 /* Move cursor to 'Exit' menu entry for the main menu.. */
871 menu_format(cui->main->ncm, &rows, &cols);
872 last = cui->main->item_count - 1;
873 set_current_item(cui->main->ncm, cui->main->items[last]);
874 if (!item_visible(cui->main->items[last])) {
875 top = last < rows ? 0 : last - rows + 1;
876 set_top_row(cui->main->ncm, top);
879 /* ..and the plugin menu */
880 menu_format(cui->plugin_menu->ncm, &rows, &cols);
881 last = cui->plugin_menu->item_count - 1;
882 set_current_item(cui->plugin_menu->ncm, cui->plugin_menu->items[last]);
883 if (!item_visible(cui->plugin_menu->items[last])) {
884 top = last < rows ? 0 : last - rows + 1;
885 set_top_row(cui->plugin_menu->ncm, top);
889 pb_log("%s: set_menu_items failed: %d\n", __func__, result);
892 pb_log("%s\n", __func__);
893 pmenu_dump_items(cui->main->items,
894 item_count(cui->main->ncm) + 1);
897 if (cui->current == &cui->main->scr)
898 nc_scr_post(cui->current);
899 if (cui->current == &cui->plugin_menu->scr)
900 nc_scr_post(cui->current);
903 static void cui_update_status(struct status *status, void *arg)
905 struct cui *cui = cui_from_arg(arg);
907 statuslog_append_steal(cui, cui->statuslog, status);
909 /* Ignore status messages from the backlog */
910 if (!status->backlog)
911 nc_scr_status_printf(cui->current, "%s", status->message);
915 * Handle a new installed plugin option and update its associated
916 * (uninstalled) menu item if it exists.
918 static int cui_plugin_option_add(struct plugin_option *opt, void *arg)
920 struct cui_opt_data *cod;
921 struct cui *cui = cui_from_arg(arg);
922 struct pmenu_item *item = NULL;
923 struct boot_option *dummy_opt;
929 /* Find uninstalled plugin by matching on plugin_file */
930 for (i = 0; i < cui->plugin_menu->item_count; i++) {
931 item = item_userptr(cui->plugin_menu->items[i]);
934 cod = cod_from_item(item);
935 if (!cod || !cod->pd)
937 if (strncmp(cod->pd->plugin_file, opt->plugin_file,
938 strlen(cod->pd->plugin_file)) == 0)
943 * If pb-plugin was run manually there may not be an associated
944 * plugin-type boot_option. Pass a fake device and option to
945 * cui_boot_option_add() so we have an item to work with.
947 if (!item || i >= cui->plugin_menu->item_count) {
948 pb_log("New plugin option %s doesn't have a source item\n",
950 dev = talloc_zero(cui, struct device);
951 dev->id = dev->name = talloc_asprintf(dev, "(unknown)");
952 dev->type = DEVICE_TYPE_UNKNOWN;
953 dummy_opt = talloc_zero(cui, struct boot_option);
954 dummy_opt->device_id = talloc_strdup(dummy_opt, dev->id);
955 dummy_opt->id = dummy_opt->name = talloc_asprintf(dummy_opt, "dummy");
956 dummy_opt->boot_image_file = talloc_strdup(dummy_opt, opt->plugin_file);
957 dummy_opt->type = DISCOVER_PLUGIN_OPTION;
958 cui_boot_option_add(dev, dummy_opt, cui);
963 * If this option was faked above move the context under
964 * the item so it is cleaned up later in cui_plugins_remove().
966 if (strncmp(cod->opt->id, "dummy", strlen("dummy") == 0 &&
967 cod->dev->type == DEVICE_TYPE_UNKNOWN)) {
968 talloc_steal(item, cod->dev);
969 talloc_steal(item, cod->opt);
972 talloc_free(cod->name);
973 /* Name is still tabbed across */
974 cod->name = talloc_asprintf(cod, _(" %s [installed]"), opt->name);
977 item->on_execute = NULL;
978 item->on_edit = cui_show_plugin;
980 if (cui->current == &cui->plugin_menu->scr)
981 nc_scr_unpost(cui->current);
983 /* This disconnects items array from menu. */
984 result = set_menu_items(cui->plugin_menu->ncm, NULL);
987 pmenu_item_update(item, cod->name);
989 /* Re-attach the items array. */
990 result = set_menu_items(cui->plugin_menu->ncm, cui->plugin_menu->items);
992 if (cui->current == &cui->plugin_menu->scr)
993 nc_scr_post(cui->current);
999 * Most plugin menu items will be removed via cui_device_remove(). However if
1000 * pb-plugin has been run manually it is possible that there a plugin items
1001 * not associated with a device - remove them here.
1003 static int cui_plugins_remove(void *arg)
1005 struct cui *cui = cui_from_arg(arg);
1006 struct pmenu_item *item = NULL;
1007 struct cui_opt_data *cod;
1010 pb_debug("%s\n", __func__);
1012 if (cui->current == &cui->plugin_menu->scr)
1013 nc_scr_unpost(cui->current);
1014 if (cui->current == &cui->main->scr)
1015 nc_scr_unpost(cui->current);
1017 /* This disconnects items array from menu. */
1018 set_menu_items(cui->plugin_menu->ncm, NULL);
1020 while (i < cui->plugin_menu->item_count) {
1021 item = item_userptr(cui->plugin_menu->items[i]);
1022 if (!item || !item->data) {
1026 cod = cod_from_item(item);
1027 if (!cod->opt && !cod->dev) {
1032 pmenu_remove(cui->plugin_menu, item);
1033 /* plugin_menu entries will shift, jump to bottom to make sure
1034 * we remove all plugin option items */
1038 /* Re-attach the items array. */
1039 set_menu_items(cui->plugin_menu->ncm, cui->plugin_menu->items);
1041 set_menu_items(cui->main->ncm, NULL);
1042 for (i = 0; i < cui->main->item_count; i++) {
1043 item = item_userptr(cui->main->items[i]);
1044 if (strncmp(item->nci->name.str, "Plugins", strlen("Plugins")))
1047 pmenu_item_update(item, "Plugins (0)");
1051 set_menu_items(cui->main->ncm, cui->main->items);
1053 if (cui->current == &cui->main->scr)
1054 nc_scr_post(cui->current);
1056 /* If we're currently in a plugin screen jump back to the plugin menu */
1057 if (cui->plugin_screen &&
1058 cui->current == plugin_screen_scr(cui->plugin_screen))
1059 cui_plugin_exit(cui);
1064 static void cui_update_mm_title(struct cui *cui)
1066 struct nc_frame *frame = &cui->main->scr.frame;
1068 talloc_free(frame->rtitle);
1070 frame->rtitle = talloc_strdup(cui->main, cui->sysinfo->type);
1071 if (cui->sysinfo->identifier)
1072 frame->rtitle = talloc_asprintf_append(frame->rtitle,
1073 " %s", cui->sysinfo->identifier);
1075 if (cui->current == &cui->main->scr)
1076 nc_scr_post(cui->current);
1078 frame = &cui->plugin_menu->scr.frame;
1080 talloc_free(frame->rtitle);
1082 frame->rtitle = talloc_strdup(cui->main, cui->sysinfo->type);
1083 if (cui->sysinfo->identifier)
1084 frame->rtitle = talloc_asprintf_append(frame->rtitle,
1085 " %s", cui->sysinfo->identifier);
1087 if (cui->current == &cui->main->scr)
1088 nc_scr_post(cui->current);
1091 static void cui_update_sysinfo(struct system_info *sysinfo, void *arg)
1093 struct cui *cui = cui_from_arg(arg);
1094 cui->sysinfo = talloc_steal(cui, sysinfo);
1096 /* if we're currently displaying the system info screen, inform it
1097 * of the updated information. */
1098 if (cui->sysinfo_screen)
1099 sysinfo_screen_update(cui->sysinfo_screen, sysinfo);
1101 if (cui->subset_screen)
1102 subset_screen_update(cui->subset_screen);
1104 /* ... and do the same with the config screen... */
1105 if (cui->config_screen)
1106 config_screen_update(cui->config_screen, cui->config, sysinfo);
1108 /* ... and the boot editor. */
1109 if (cui->boot_editor)
1110 boot_editor_update(cui->boot_editor, sysinfo);
1112 cui_update_mm_title(cui);
1115 static void cui_update_language(struct cui *cui, char *lang)
1120 cur_lang = setlocale(LC_ALL, NULL);
1121 if (cur_lang && !strcmp(cur_lang, lang))
1124 setlocale(LC_ALL, lang);
1126 /* we'll need to update the menu: drop all items and repopulate */
1127 repost_menu = cui->current == &cui->main->scr ||
1128 cui->current == &cui->plugin_menu->scr;
1130 nc_scr_unpost(cui->current);
1132 talloc_free(cui->main);
1133 cui->main = main_menu_init(cui);
1134 cui->plugin_menu = plugin_menu_init(cui);
1137 cui->current = &cui->main->scr;
1138 nc_scr_post(cui->current);
1141 discover_client_enumerate(cui->client);
1144 static void cui_update_config(struct config *config, void *arg)
1146 struct cui *cui = cui_from_arg(arg);
1147 cui->config = talloc_steal(cui, config);
1150 cui_update_language(cui, config->lang);
1152 if (cui->subset_screen)
1153 subset_screen_update(cui->subset_screen);
1155 if (cui->config_screen)
1156 config_screen_update(cui->config_screen, config, cui->sysinfo);
1158 if (config->safe_mode)
1159 nc_scr_status_printf(cui->current,
1160 _("SAFE MODE: select '%s' to continue"),
1161 _("Rescan devices"));
1164 int cui_send_config(struct cui *cui, struct config *config)
1166 return discover_client_send_config(cui->client, config);
1169 int cui_send_url(struct cui *cui, char * url)
1171 return discover_client_send_url(cui->client, url);
1174 int cui_send_plugin_install(struct cui *cui, char *file)
1176 return discover_client_send_plugin_install(cui->client, file);
1179 void cui_send_reinit(struct cui *cui)
1181 discover_client_send_reinit(cui->client);
1184 static int menu_sysinfo_execute(struct pmenu_item *item)
1186 cui_show_sysinfo(cui_from_item(item));
1190 static int menu_config_execute(struct pmenu_item *item)
1192 cui_show_config(cui_from_item(item));
1196 static int menu_lang_execute(struct pmenu_item *item)
1198 cui_show_lang(cui_from_item(item));
1202 static int menu_statuslog_execute(struct pmenu_item *item)
1204 cui_show_statuslog(cui_from_item(item));
1208 static int menu_reinit_execute(struct pmenu_item *item)
1210 if (cui_from_item(item)->client)
1211 cui_send_reinit(cui_from_item(item));
1215 static int menu_add_url_execute(struct pmenu_item *item)
1217 if (cui_from_item(item)->client)
1218 cui_show_add_url(cui_from_item(item));
1222 static int menu_plugin_execute(struct pmenu_item *item)
1224 if (cui_from_item(item)->client)
1225 cui_show_plugin_menu(cui_from_item(item));
1230 * pb_mm_init - Setup the main menu instance.
1232 static struct pmenu *main_menu_init(struct cui *cui)
1234 struct pmenu_item *i;
1237 bool lockdown = lockdown_active();
1239 m = pmenu_init(cui, 9, cui_on_exit);
1241 pb_log("%s: failed\n", __func__);
1246 m->hot_keys = talloc_array(m, hot_key_fn, m->n_hot_keys);
1248 pb_log("%s: failed to allocate hot_keys\n", __func__);
1252 m->hot_keys[0] = pmenu_main_hot_keys;
1253 m->on_new = cui_item_new;
1255 m->scr.frame.ltitle = talloc_asprintf(m,
1256 "Petitboot (" PACKAGE_VERSION ")");
1257 m->scr.frame.rtitle = NULL;
1258 m->scr.frame.help = talloc_strdup(m,
1259 _("Enter=accept, e=edit, n=new, x=exit, l=language, g=log, h=help"));
1260 m->scr.frame.status = talloc_strdup(m, _("Welcome to Petitboot"));
1262 /* add a separator */
1263 i = pmenu_item_create(m, " ");
1264 item_opts_off(i->nci, O_SELECTABLE);
1265 pmenu_item_insert(m, i, 0);
1267 /* add system items */
1268 i = pmenu_item_create(m, _("System information"));
1269 i->on_execute = menu_sysinfo_execute;
1270 pmenu_item_insert(m, i, 1);
1272 i = pmenu_item_create(m, _("System configuration"));
1273 i->on_execute = menu_config_execute;
1274 pmenu_item_insert(m, i, 2);
1276 i = pmenu_item_create(m, _("System status log"));
1277 i->on_execute = menu_statuslog_execute;
1278 pmenu_item_insert(m, i, 3);
1280 /* this label isn't translated, so we don't want a gettext() here */
1281 i = pmenu_item_create(m, "Language");
1282 i->on_execute = menu_lang_execute;
1283 pmenu_item_insert(m, i, 4);
1285 i = pmenu_item_create(m, _("Rescan devices"));
1286 i->on_execute = menu_reinit_execute;
1287 pmenu_item_insert(m, i, 5);
1289 i = pmenu_item_create(m, _("Retrieve config from URL"));
1290 i->on_execute = menu_add_url_execute;
1291 pmenu_item_insert(m, i, 6);
1293 i = pmenu_item_create(m, _("Plugins (0)"));
1294 i->on_execute = menu_plugin_execute;
1295 pmenu_item_insert(m, i, 7);
1298 i = pmenu_item_create(m, _("Reboot"));
1300 i = pmenu_item_create(m, _("Exit to shell"));
1301 i->on_execute = pmenu_exit_cb;
1302 pmenu_item_insert(m, i, 8);
1304 result = pmenu_setup(m);
1307 pb_log("%s:%d: pmenu_setup failed: %s\n", __func__, __LINE__,
1312 m->help_title = _("main menu");
1313 m->help_text = &main_menu_help_text;
1315 menu_opts_off(m->ncm, O_SHOWDESC);
1316 set_menu_mark(m->ncm, " *");
1317 set_current_item(m->ncm, i->nci);
1327 * plugin_menu_init: Set up the plugin menu instance
1329 static struct pmenu *plugin_menu_init(struct cui *cui)
1331 struct pmenu_item *i;
1335 m = pmenu_init(cui, 2, cui_plugin_menu_exit);
1336 m->scr.frame.ltitle = talloc_asprintf(m, _("Petitboot Plugins"));
1337 m->scr.frame.rtitle = talloc_asprintf(m, NULL);
1338 m->scr.frame.help = talloc_strdup(m,
1339 _("Enter=install, e=details, x=exit, h=help"));
1340 m->scr.frame.status = talloc_asprintf(m,
1341 _("Available Petitboot Plugins"));
1343 /* add a separator */
1344 i = pmenu_item_create(m, " ");
1345 item_opts_off(i->nci, O_SELECTABLE);
1346 pmenu_item_insert(m, i, 0);
1348 i = pmenu_item_create(m, _("Return to Main Menu"));
1349 i->on_execute = pmenu_exit_cb;
1350 pmenu_item_insert(m, i, 1);
1352 result = pmenu_setup(m);
1355 pb_log("%s:%d: pmenu_setup failed: %s\n", __func__, __LINE__,
1360 m->help_title = _("plugin menu");
1361 m->help_text = &plugin_menu_help_text;
1370 static struct discover_client_ops cui_client_ops = {
1372 .boot_option_add = cui_boot_option_add,
1373 .device_remove = cui_device_remove,
1374 .plugin_option_add = cui_plugin_option_add,
1375 .plugins_remove = cui_plugins_remove,
1376 .update_status = cui_update_status,
1377 .update_sysinfo = cui_update_sysinfo,
1378 .update_config = cui_update_config,
1381 /* cui_server_wait - Connect to the discover server.
1382 * @arg: Pointer to the cui instance.
1384 * A timeout callback that attempts to connect to the discover server; on
1385 * failure it registers itself with a one second timeout to try again.
1386 * On success the cui->client struct will be set.
1388 * Since this updates the status line when called it must not be called
1389 * before the UI is ready.
1391 static int cui_server_wait(void *arg)
1393 struct cui *cui = cui_from_arg(arg);
1396 pb_debug("We already have a server!\n");
1400 /* We haven't yet connected to the server */
1401 pb_log("Trying to connect...\n");
1402 cui->client = discover_client_init(cui->waitset,
1403 &cui_client_ops, cui);
1406 waiter_register_timeout(cui->waitset, 1000, cui_server_wait,
1408 nc_scr_status_printf(cui->current,
1409 "Info: Waiting for device discovery");
1411 nc_scr_status_free(cui->current);
1412 talloc_steal(cui, cui->client);
1414 if (cui->has_input) {
1415 pb_log("Aborting default boot on pb-discover connect\n");
1416 discover_client_cancel_default(cui->client);
1424 * cui_init - Setup the cui instance.
1425 * @platform_info: A value for the struct cui platform_info member.
1427 * Returns a pointer to a struct cui on success, or NULL on error.
1429 * Allocates the cui instance, sets up the client and stdin waiters, and
1430 * sets up the ncurses menu screen.
1433 struct cui *cui_init(void* platform_info,
1434 int (*js_map)(const struct js_event *e), int start_daemon, int timeout)
1439 cui = talloc_zero(NULL, struct cui);
1441 pb_log("%s: alloc cui failed.\n", __func__);
1442 fprintf(stderr, _("%s: alloc cui failed.\n"), __func__);
1446 cui->c_sig = pb_cui_sig;
1447 cui->platform_info = platform_info;
1448 cui->waitset = waitset_create(cui);
1449 cui->statuslog = statuslog_init(cui);
1451 process_init(cui, cui->waitset, false);
1453 /* Loop here for scripts that just started the server. */
1456 for (i = start_daemon ? 2 : 15; i && timeout; i--) {
1457 cui->client = discover_client_init(cui->waitset,
1458 &cui_client_ops, cui);
1459 if (cui->client || !i)
1461 pb_log("%s: waiting for server %d\n", __func__, i);
1465 if (!cui->client && start_daemon) {
1470 result = pb_start_daemon(cui);
1475 pb_log("%s: discover_client_init failed.\n", __func__);
1476 fprintf(stderr, _("%s: error: discover_client_init failed.\n"),
1478 fprintf(stderr, _("could not start pb-discover, the petitboot "
1480 goto fail_client_init;
1483 if (!cui->client && !timeout) {
1484 /* Have the first timeout fire immediately so we can check
1485 * for the server as soon as the UI is ready */
1486 waiter_register_timeout(cui->waitset, 0,
1487 cui_server_wait, cui);
1488 } else if (!cui->client) {
1489 pb_log("%s: discover_client_init failed.\n", __func__);
1490 fprintf(stderr, _("%s: error: discover_client_init failed.\n"),
1492 fprintf(stderr, _("check that pb-discover, "
1493 "the petitboot daemon is running.\n"));
1494 goto fail_client_init;
1498 talloc_steal(cui, cui->client);
1501 cui->main = main_menu_init(cui);
1503 goto fail_client_init;
1505 cui->plugin_menu = plugin_menu_init(cui);
1506 if (!cui->plugin_menu)
1507 goto fail_client_init;
1509 waiter_register_io(cui->waitset, STDIN_FILENO, WAIT_IN,
1510 cui_process_key, cui);
1514 cui->pjs = pjs_init(cui, js_map);
1517 waiter_register_io(cui->waitset, pjs_get_fd(cui->pjs),
1518 WAIT_IN, cui_process_js, cui);
1530 * cui_cancel_autoboot_on_exit - On exit spin until the server is available.
1532 * If the program exits before connecting to the server autoboot won't be
1533 * cancelled even though there has been keyboard activity. A child is forked
1534 * which will spin until the server is connected and told to cancel autoboot.
1536 static void cui_cancel_autoboot_on_exit(struct cui *cui)
1541 /* Fork a child to tell the server to cancel autoboot */
1544 cui_detached = true;
1546 /* Loop until connection established */
1547 while (!cui->client) {
1548 cui->client = discover_client_init(cui->waitset,
1549 &cui_client_ops, cui);
1554 talloc_steal(cui, cui->client);
1555 discover_client_cancel_default(cui->client);
1559 pb_log("Failed to fork child on exit: %m\n");
1561 discover_client_cancel_default(cui->client);
1565 * cui_run - The main cui program loop.
1566 * @cui: The cui instance.
1567 * @main: The menu to use as the main menu.
1569 * Runs the cui engine. Does not return until indicated to do so by some
1570 * user action, or an error occurs. Frees the cui object on return.
1571 * Returns 0 on success (return to shell), -1 on error (should restart).
1574 int cui_run(struct cui *cui)
1578 cui->current = &cui->main->scr;
1579 cui->default_item = 0;
1581 nc_scr_post(cui->current);
1584 int result = waiter_poll(cui->waitset);
1587 pb_log("%s: poll: %s\n", __func__, strerror(errno));
1594 while (cui->resize) {
1596 cui_handle_resize(cui);
1600 cui_cancel_autoboot_on_exit(cui);
1604 return cui->abort ? 0 : -1;