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);
102 /* Arrow keys in normal cursor mode */
103 define_key("\x1b\x5b\x41", KEY_UP);
104 define_key("\x1b\x5b\x42", KEY_DOWN);
105 define_key("\x1b\x5b\x43", KEY_RIGHT);
106 define_key("\x1b\x5b\x44", KEY_LEFT);
107 /* Arrow keys in "application" cursor mode */
108 define_key("\x1b\x4f\x41", KEY_UP);
109 define_key("\x1b\x4f\x42", KEY_DOWN);
110 define_key("\x1b\x4f\x43", KEY_RIGHT);
111 define_key("\x1b\x4f\x44", KEY_LEFT);
113 define_key("\x1b\x5b\x33\x7e", KEY_DC);
115 while (getch() != ERR) /* flush stdin */
119 static void cui_atexit(void)
128 bool lockdown = lockdown_active();
137 * cui_abort - Signal the main cui program loop to exit.
139 * Sets cui.abort, which causes the cui_run() routine to return.
142 void cui_abort(struct cui *cui)
144 pb_log("%s: exiting\n", __func__);
149 * cui_resize - Signal the main cui program loop to resize
151 * Called at SIGWINCH.
154 void cui_resize(struct cui *cui)
156 pb_debug("%s: resizing\n", __func__);
161 * cui_on_exit - A generic main menu exit callback.
164 void cui_on_exit(struct pmenu *menu)
166 struct cui *cui = cui_from_pmenu(menu);
169 sh_cmd = talloc_asprintf(cui,
170 "echo \"Exiting petitboot. Type 'exit' to return.\";\
171 echo \"You may run 'pb-sos' to gather diagnostic data\";\
172 %s", pb_system_apps.sh);
175 pb_log("Failed to allocate shell arguments\n");
179 const char *argv[] = {
186 cui_run_cmd(cui, argv);
188 nc_scr_status_printf(cui->current, _("Returned from shell"));
193 * cui_run_cmd - A generic cb to run the supplied command.
196 int cui_run_cmd(struct cui *cui, const char **cmd_argv)
198 struct process *process;
201 process = process_create(cui);
205 process->path = cmd_argv[0];
206 process->argv = cmd_argv;
207 process->raw_stdout = true;
209 nc_scr_status_printf(cui->current, _("Running %s..."), cmd_argv[0]);
211 nc_scr_unpost(cui->current);
218 result = process_run_sync(process);
223 redrawwin(cui->current->main_ncw);
224 nc_scr_post(cui->current);
227 pb_log("%s: failed: '%s'\n", __func__, cmd_argv[0]);
228 nc_scr_status_printf(cui->current, _("Failed: %s"),
232 process_release(process);
237 int cui_run_cmd_from_item(struct pmenu_item *item)
239 struct cui *cui = cui_from_item(item);
240 const char **cmd_argv = item->data;
242 return cui_run_cmd(cui, cmd_argv);
246 * cui_boot - A generic cb to run kexec.
249 static int cui_boot(struct pmenu_item *item)
252 struct cui *cui = cui_from_item(item);
253 struct cui_opt_data *cod = cod_from_item(item);
255 assert(cui->current == &cui->main->scr);
257 pb_debug("%s: %s\n", __func__, cod->name);
259 nc_scr_status_printf(cui->current, _("Booting %s..."), cod->name);
261 result = discover_client_boot(cui->client, NULL, cod->opt, cod->bd);
264 nc_scr_status_printf(cui->current,
265 _("Failed: boot %s"), cod->bd->image);
271 static void cui_boot_editor_on_exit(struct cui *cui,
272 struct pmenu_item *item,
273 struct pb_boot_data *bd)
275 struct pmenu *menu = cui->main;
276 struct cui_opt_data *cod;
277 int idx, top, rows, cols;
278 static int user_idx = 0;
280 /* Was the edit cancelled? */
282 cui_set_current(cui, &cui->main->scr);
283 talloc_free(cui->boot_editor);
284 cui->boot_editor = NULL;
288 /* Is this was a new item, we'll need to update the menu */
292 cod = talloc_zero(NULL, struct cui_opt_data);
293 cod->name = talloc_asprintf(cod, _("User item %u"), ++user_idx);
295 item = pmenu_item_create(menu, cod->name);
301 item->on_edit = cui_item_edit;
302 item->on_execute = cui_boot;
305 talloc_steal(item, cod);
307 /* Detach the items array. */
308 set_menu_items(menu->ncm, NULL);
310 /* Insert new item at insert_pt. */
311 insert_pt = pmenu_grow(menu, 1);
312 pmenu_item_insert(menu, item, insert_pt);
314 /* Re-attach the items array. */
315 set_menu_items(menu->ncm, menu->items);
317 /* If our index is above the current top row, align
318 * us to the new top. Otherwise, align us to the new
320 menu_format(cui->main->ncm, &rows, &cols);
321 top = top_row(cui->main->ncm);
322 idx = item_index(item->nci);
327 top = idx < rows ? 0 : idx - rows + 1;
329 set_top_row(cui->main->ncm, top);
330 set_current_item(item->pmenu->ncm, item->nci);
332 nc_scr_post(&menu->scr);
337 cod->bd = talloc_steal(cod, bd);
340 cui_set_current(cui, &cui->main->scr);
341 talloc_free(cui->boot_editor);
342 cui->boot_editor = NULL;
345 void cui_item_edit(struct pmenu_item *item)
347 struct cui *cui = cui_from_item(item);
348 cui->boot_editor = boot_editor_init(cui, item, cui->sysinfo,
349 cui_boot_editor_on_exit);
350 cui_set_current(cui, boot_editor_scr(cui->boot_editor));
353 void cui_item_new(struct pmenu *menu)
355 struct cui *cui = cui_from_pmenu(menu);
356 cui->boot_editor = boot_editor_init(cui, NULL, cui->sysinfo,
357 cui_boot_editor_on_exit);
358 cui_set_current(cui, boot_editor_scr(cui->boot_editor));
361 static void cui_sysinfo_exit(struct cui *cui)
363 cui_set_current(cui, &cui->main->scr);
364 talloc_free(cui->sysinfo_screen);
365 cui->sysinfo_screen = NULL;
368 void cui_show_sysinfo(struct cui *cui)
370 cui->sysinfo_screen = sysinfo_screen_init(cui, cui->sysinfo,
372 cui_set_current(cui, sysinfo_screen_scr(cui->sysinfo_screen));
375 static void cui_config_exit(struct cui *cui)
377 cui_set_current(cui, &cui->main->scr);
378 talloc_free(cui->config_screen);
379 cui->config_screen = NULL;
382 void cui_show_config(struct cui *cui)
384 cui->config_screen = config_screen_init(cui, cui->config,
385 cui->sysinfo, cui_config_exit);
386 cui_set_current(cui, config_screen_scr(cui->config_screen));
389 static void cui_lang_exit(struct cui *cui)
391 cui_set_current(cui, &cui->main->scr);
392 talloc_free(cui->lang_screen);
393 cui->lang_screen = NULL;
396 void cui_show_lang(struct cui *cui)
398 cui->lang_screen = lang_screen_init(cui, cui->config, cui_lang_exit);
399 cui_set_current(cui, lang_screen_scr(cui->lang_screen));
402 static void cui_statuslog_exit(struct cui *cui)
404 cui_set_current(cui, &cui->main->scr);
405 talloc_free(cui->statuslog_screen);
406 cui->statuslog_screen = NULL;
409 void cui_show_statuslog(struct cui *cui)
411 cui->statuslog_screen = statuslog_screen_init(cui, cui_statuslog_exit);
412 cui_set_current(cui, statuslog_screen_scr(cui->statuslog_screen));
415 static void cui_add_url_exit(struct cui *cui)
417 cui_set_current(cui, &cui->main->scr);
418 talloc_free(cui->add_url_screen);
419 cui->add_url_screen = NULL;
422 static void cui_plugin_exit(struct cui *cui)
424 cui_set_current(cui, &cui->plugin_menu->scr);
425 talloc_free(cui->plugin_screen);
426 cui->plugin_screen = NULL;
429 static void cui_plugin_menu_exit(struct pmenu *menu)
431 struct cui *cui = cui_from_pmenu(menu);
432 cui_set_current(cui, &cui->main->scr);
435 void cui_show_add_url(struct cui *cui)
437 cui->add_url_screen = add_url_screen_init(cui, cui_add_url_exit);
438 cui_set_current(cui, add_url_screen_scr(cui->add_url_screen));
441 void cui_show_plugin_menu(struct cui *cui)
443 cui_set_current(cui, &cui->plugin_menu->scr);
446 void cui_show_plugin(struct pmenu_item *item)
448 struct cui *cui = cui_from_item(item);
449 cui->plugin_screen = plugin_screen_init(cui, item, cui_plugin_exit);
450 cui_set_current(cui, plugin_screen_scr(cui->plugin_screen));
453 static void cui_help_exit(struct cui *cui)
455 cui_set_current(cui, help_screen_return_scr(cui->help_screen));
456 talloc_free(cui->help_screen);
457 cui->help_screen = NULL;
460 void cui_show_help(struct cui *cui, const char *title,
461 const struct help_text *text)
466 if (cui->help_screen)
469 cui->help_screen = help_screen_init(cui, cui->current,
470 title, text, cui_help_exit);
472 if (cui->help_screen)
473 cui_set_current(cui, help_screen_scr(cui->help_screen));
476 static void cui_subset_exit(struct cui *cui)
478 cui_set_current(cui, subset_screen_return_scr(cui->subset_screen));
479 talloc_free(cui->subset_screen);
480 cui->subset_screen = NULL;
483 void cui_show_subset(struct cui *cui, const char *title,
489 if (cui->subset_screen)
492 cui->subset_screen = subset_screen_init(cui, cui->current,
493 title, arg, cui_subset_exit);
495 if (cui->subset_screen)
496 cui_set_current(cui, subset_screen_scr(cui->subset_screen));
500 * cui_set_current - Set the currently active screen and redraw it.
503 struct nc_scr *cui_set_current(struct cui *cui, struct nc_scr *scr)
507 DBGS("%p -> %p\n", cui->current, scr);
509 assert(cui->current != scr);
516 nc_scr_post(cui->current);
521 static bool process_global_keys(struct cui *cui, int key)
525 if (cui->current && cui->current->main_ncw)
533 * cui_process_key - Process input on stdin.
536 static int cui_process_key(void *arg)
538 struct cui *cui = cui_from_arg(arg);
543 assert(cui->current);
548 pb_debug("%s: got key %d\n", __func__, c);
555 * If this is a console code sequence try to parse it
556 * and don't treat this as a key press.
559 if (grab != ERR && grab != 27) {
561 pb_debug("%s: Caught unhandled command sequence\n",
563 sequence = handle_control_sequence(cui, c);
564 pb_debug("Caught sequence ");
566 pb_debug("(%zu): ", strlen(sequence));
567 for (i = 0; i < strlen(sequence); i++)
568 pb_debug("0%o ", sequence[i]);
571 pb_debug("(0): (none)\n");
576 if (!cui->has_input) {
577 cui->has_input = true;
579 pb_log("UI input received (key = %d), aborting "
580 "default boot\n", c);
581 discover_client_cancel_default(cui->client);
583 pb_log("UI input received (key = %d), aborting "
584 "once server connects\n", c);
588 if (process_global_keys(cui, c))
591 cui->current->process_key(cui->current, c);
598 * cui_process_js - Process joystick events.
601 static int cui_process_js(void *arg)
603 struct cui *cui = cui_from_arg(arg);
606 c = pjs_process_event(cui->pjs);
610 cui_process_key(arg);
617 * cui_handle_resize - Handle the term resize.
620 static void cui_handle_resize(struct cui *cui)
624 if (ioctl(1, TIOCGWINSZ, &ws) == -1) {
625 pb_log("%s: ioctl failed: %s\n", __func__, strerror(errno));
629 pb_debug("%s: {%u,%u}\n", __func__, ws.ws_row, ws.ws_col);
631 wclear(cui->current->main_ncw);
632 resize_term(ws.ws_row, ws.ws_col);
633 cui->current->resize(cui->current);
635 /* For some reason this makes ncurses redraw the screen */
637 redrawwin(cui->current->main_ncw);
638 wrefresh(cui->current->main_ncw);
642 * cui_device_add - Client device_add callback.
644 * Creates menu_items for all the device boot_options and inserts those
645 * menu_items into the main menu. Redraws the main menu if it is active.
646 * If a 'plugin' type boot_option appears the plugin menu is updated instead.
649 static int cui_boot_option_add(struct device *dev, struct boot_option *opt,
652 struct pmenu_item *i, *dev_hdr = NULL;
653 struct cui *cui = cui_from_arg(arg);
654 struct cui_opt_data *cod;
655 const char *tab = " ";
656 unsigned int insert_pt;
657 int result, rows, cols;
663 plugin_option = opt->type == DISCOVER_PLUGIN_OPTION;
664 menu = plugin_option ? cui->plugin_menu : cui->main;
666 pb_debug("%s: %p %s\n", __func__, opt, opt->id);
668 selected = current_item(menu->ncm);
669 menu_format(menu->ncm, &rows, &cols);
671 if (cui->current == &cui->main->scr)
672 nc_scr_unpost(cui->current);
673 if (plugin_option && cui->current == &cui->plugin_menu->scr)
674 nc_scr_unpost(cui->current);
676 /* Check if the boot device is new */
677 dev_hdr = pmenu_find_device(menu, dev, opt);
679 /* All actual boot entries are 'tabbed' across */
680 name = talloc_asprintf(menu, "%s%s",
681 tab, opt->name ? : "Unknown Name");
683 /* Save the item in opt->ui_info for cui_device_remove() */
684 opt->ui_info = i = pmenu_item_create(menu, name);
691 i->on_execute = plugin_install_plugin;
693 i->on_edit = cui_item_edit;
694 i->on_execute = cui_boot;
697 i->data = cod = talloc(i, struct cui_opt_data);
700 cod->opt_hash = pb_opt_hash(dev, opt);
701 cod->name = opt->name;
704 cod->pd = talloc(i, struct pb_plugin_data);
705 cod->pd->plugin_file = talloc_strdup(cod,
706 opt->boot_image_file);
708 cod->bd = talloc(i, struct pb_boot_data);
709 cod->bd->image = talloc_strdup(cod->bd, opt->boot_image_file);
710 cod->bd->initrd = talloc_strdup(cod->bd, opt->initrd_file);
711 cod->bd->dtb = talloc_strdup(cod->bd, opt->dtb_file);
712 cod->bd->args = talloc_strdup(cod->bd, opt->boot_args);
713 cod->bd->args_sig_file = talloc_strdup(cod->bd, opt->args_sig_file);
716 /* This disconnects items array from menu. */
717 result = set_menu_items(menu->ncm, NULL);
720 pb_log("%s: set_menu_items failed: %d\n", __func__, result);
722 /* Insert new items at insert_pt. */
724 insert_pt = pmenu_grow(menu, 2);
725 pmenu_item_insert(menu, dev_hdr, insert_pt);
726 pb_log("%s: adding new device hierarchy %s\n",
727 __func__, opt->device_id);
728 pmenu_item_insert(menu, i, insert_pt+1);
730 insert_pt = pmenu_grow(menu, 1);
731 pmenu_item_add(menu, i, insert_pt);
735 pb_log("%s: adding plugin '%s'\n", __func__, cod->name);
736 pb_log(" file '%s'\n", cod->pd->plugin_file);
738 pb_log("%s: adding opt '%s'\n", __func__, cod->name);
739 pb_log(" image '%s'\n", cod->bd->image);
740 pb_log(" initrd '%s'\n", cod->bd->initrd);
741 pb_log(" args '%s'\n", cod->bd->args);
742 pb_log(" argsig '%s'\n", cod->bd->args_sig_file);
745 /* Update the plugin menu label if needed */
747 struct pmenu_item *item;
749 result = set_menu_items(cui->main->ncm, NULL);
750 for (j = 0 ; j < cui->main->item_count; j++) {
751 item = item_userptr(cui->main->items[j]);
752 if (strncmp(item->nci->name.str, "Plugins", strlen("Plugins")))
755 char *label = talloc_asprintf(item, "Plugins (%u)",
757 pmenu_item_update(item, label);
761 result = set_menu_items(cui->main->ncm, cui->main->items);
763 pb_log("%s: set_menu_items failed: %d\n", __func__, result);
766 /* Re-attach the items array. */
767 result = set_menu_items(menu->ncm, menu->items);
770 pb_log("%s: set_menu_items failed: %d\n", __func__, result);
773 pb_log("%s\n", __func__);
774 pmenu_dump_items(menu->items,
775 item_count(menu->ncm) + 1);
778 if (!item_visible(selected)) {
781 top = top_row(menu->ncm);
782 idx = item_index(selected);
784 /* If our index is above the current top row, align
785 * us to the new top. Otherwise, align us to the new
787 top = top < idx ? idx - rows + 1 : idx;
789 set_top_row(menu->ncm, top);
790 set_current_item(menu->ncm, selected);
793 if (cui->current == &menu->scr)
794 nc_scr_post(cui->current);
795 if (plugin_option && cui->current == &cui->main->scr)
796 nc_scr_post(cui->current);
802 * cui_device_remove - Client device remove callback.
804 * Removes all the menu_items for the device from the main menu and redraws the
805 * main menu if it is active.
807 static void cui_device_remove(struct device *dev, void *arg)
809 struct cui *cui = cui_from_arg(arg);
810 struct boot_option *opt;
812 int rows, cols, top, last;
815 pb_log("%s: %p %s\n", __func__, dev, dev->id);
817 if (cui->current == &cui->main->scr)
818 nc_scr_unpost(cui->current);
819 if (cui->current == &cui->plugin_menu->scr)
820 nc_scr_unpost(cui->current);
822 /* This disconnects items array from menu. */
824 result = set_menu_items(cui->main->ncm, NULL);
825 result |= set_menu_items(cui->plugin_menu->ncm, NULL);
828 pb_log("%s: set_menu_items failed: %d\n", __func__, result);
830 list_for_each_entry(&dev->boot_options, opt, list) {
831 struct pmenu_item *item = pmenu_item_from_arg(opt->ui_info);
833 assert(pb_protocol_device_cmp(dev, cod_from_item(item)->dev));
834 if (opt->type == DISCOVER_PLUGIN_OPTION)
835 pmenu_remove(cui->plugin_menu, item);
837 pmenu_remove(cui->main, item);
840 /* Manually remove remaining device hierarchy item */
841 for (i=0; i < cui->main->item_count; i++) {
842 struct pmenu_item *item = item_userptr(cui->main->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->main,item);
850 /* Look in plugins menu too */
851 for (i=0; i < cui->plugin_menu->item_count; i++) {
852 struct pmenu_item *item = item_userptr(cui->plugin_menu->items[i]);
853 if (!item || !item->data )
856 struct cui_opt_data *data = item->data;
857 if (data && data->dev && data->dev == dev)
858 pmenu_remove(cui->plugin_menu,item);
861 /* Re-attach the items array. */
863 result = set_menu_items(cui->main->ncm, cui->main->items);
864 result |= set_menu_items(cui->plugin_menu->ncm, cui->plugin_menu->items);
866 /* Move cursor to 'Exit' menu entry for the main menu.. */
867 menu_format(cui->main->ncm, &rows, &cols);
868 last = cui->main->item_count - 1;
869 set_current_item(cui->main->ncm, cui->main->items[last]);
870 if (!item_visible(cui->main->items[last])) {
871 top = last < rows ? 0 : last - rows + 1;
872 set_top_row(cui->main->ncm, top);
875 /* ..and the plugin menu */
876 menu_format(cui->plugin_menu->ncm, &rows, &cols);
877 last = cui->plugin_menu->item_count - 1;
878 set_current_item(cui->plugin_menu->ncm, cui->plugin_menu->items[last]);
879 if (!item_visible(cui->plugin_menu->items[last])) {
880 top = last < rows ? 0 : last - rows + 1;
881 set_top_row(cui->plugin_menu->ncm, top);
885 pb_log("%s: set_menu_items failed: %d\n", __func__, result);
888 pb_log("%s\n", __func__);
889 pmenu_dump_items(cui->main->items,
890 item_count(cui->main->ncm) + 1);
893 if (cui->current == &cui->main->scr)
894 nc_scr_post(cui->current);
895 if (cui->current == &cui->plugin_menu->scr)
896 nc_scr_post(cui->current);
899 static void cui_update_status(struct status *status, void *arg)
901 struct cui *cui = cui_from_arg(arg);
903 statuslog_append_steal(cui, cui->statuslog, status);
905 /* Ignore status messages from the backlog */
906 if (!status->backlog)
907 nc_scr_status_printf(cui->current, "%s", status->message);
911 * Handle a new installed plugin option and update its associated
912 * (uninstalled) menu item if it exists.
914 static int cui_plugin_option_add(struct plugin_option *opt, void *arg)
916 struct cui_opt_data *cod;
917 struct cui *cui = cui_from_arg(arg);
918 struct pmenu_item *item = NULL;
919 struct boot_option *dummy_opt;
925 /* Find uninstalled plugin by matching on plugin_file */
926 for (i = 0; i < cui->plugin_menu->item_count; i++) {
927 item = item_userptr(cui->plugin_menu->items[i]);
930 cod = cod_from_item(item);
931 if (!cod || !cod->pd)
933 if (strncmp(cod->pd->plugin_file, opt->plugin_file,
934 strlen(cod->pd->plugin_file)) == 0)
939 * If pb-plugin was run manually there may not be an associated
940 * plugin-type boot_option. Pass a fake device and option to
941 * cui_boot_option_add() so we have an item to work with.
943 if (!item || i >= cui->plugin_menu->item_count) {
944 pb_log("New plugin option %s doesn't have a source item\n",
946 dev = talloc_zero(cui, struct device);
947 dev->id = dev->name = talloc_asprintf(dev, "(unknown)");
948 dev->type = DEVICE_TYPE_UNKNOWN;
949 dummy_opt = talloc_zero(cui, struct boot_option);
950 dummy_opt->device_id = talloc_strdup(dummy_opt, dev->id);
951 dummy_opt->id = dummy_opt->name = talloc_asprintf(dummy_opt, "dummy");
952 dummy_opt->boot_image_file = talloc_strdup(dummy_opt, opt->plugin_file);
953 dummy_opt->type = DISCOVER_PLUGIN_OPTION;
954 cui_boot_option_add(dev, dummy_opt, cui);
959 * If this option was faked above move the context under
960 * the item so it is cleaned up later in cui_plugins_remove().
962 if (strncmp(cod->opt->id, "dummy", strlen("dummy") == 0 &&
963 cod->dev->type == DEVICE_TYPE_UNKNOWN)) {
964 talloc_steal(item, cod->dev);
965 talloc_steal(item, cod->opt);
968 talloc_free(cod->name);
969 /* Name is still tabbed across */
970 cod->name = talloc_asprintf(cod, _(" %s [installed]"), opt->name);
973 item->on_execute = NULL;
974 item->on_edit = cui_show_plugin;
976 if (cui->current == &cui->plugin_menu->scr)
977 nc_scr_unpost(cui->current);
979 /* This disconnects items array from menu. */
980 result = set_menu_items(cui->plugin_menu->ncm, NULL);
983 pmenu_item_update(item, cod->name);
985 /* Re-attach the items array. */
986 result = set_menu_items(cui->plugin_menu->ncm, cui->plugin_menu->items);
988 if (cui->current == &cui->plugin_menu->scr)
989 nc_scr_post(cui->current);
995 * Most plugin menu items will be removed via cui_device_remove(). However if
996 * pb-plugin has been run manually it is possible that there a plugin items
997 * not associated with a device - remove them here.
999 static int cui_plugins_remove(void *arg)
1001 struct cui *cui = cui_from_arg(arg);
1002 struct pmenu_item *item = NULL;
1003 struct cui_opt_data *cod;
1006 pb_debug("%s\n", __func__);
1008 if (cui->current == &cui->plugin_menu->scr)
1009 nc_scr_unpost(cui->current);
1010 if (cui->current == &cui->main->scr)
1011 nc_scr_unpost(cui->current);
1013 /* This disconnects items array from menu. */
1014 set_menu_items(cui->plugin_menu->ncm, NULL);
1016 while (i < cui->plugin_menu->item_count) {
1017 item = item_userptr(cui->plugin_menu->items[i]);
1018 if (!item || !item->data) {
1022 cod = cod_from_item(item);
1023 if (!cod->opt && !cod->dev) {
1028 pmenu_remove(cui->plugin_menu, item);
1029 /* plugin_menu entries will shift, jump to bottom to make sure
1030 * we remove all plugin option items */
1034 /* Re-attach the items array. */
1035 set_menu_items(cui->plugin_menu->ncm, cui->plugin_menu->items);
1037 set_menu_items(cui->main->ncm, NULL);
1038 for (i = 0; i < cui->main->item_count; i++) {
1039 item = item_userptr(cui->main->items[i]);
1040 if (strncmp(item->nci->name.str, "Plugins", strlen("Plugins")))
1043 pmenu_item_update(item, "Plugins (0)");
1047 set_menu_items(cui->main->ncm, cui->main->items);
1049 if (cui->current == &cui->main->scr)
1050 nc_scr_post(cui->current);
1052 /* If we're currently in a plugin screen jump back to the plugin menu */
1053 if (cui->plugin_screen &&
1054 cui->current == plugin_screen_scr(cui->plugin_screen))
1055 cui_plugin_exit(cui);
1060 static void cui_update_mm_title(struct cui *cui)
1062 struct nc_frame *frame = &cui->main->scr.frame;
1064 talloc_free(frame->rtitle);
1066 frame->rtitle = talloc_strdup(cui->main, cui->sysinfo->type);
1067 if (cui->sysinfo->identifier)
1068 frame->rtitle = talloc_asprintf_append(frame->rtitle,
1069 " %s", cui->sysinfo->identifier);
1071 if (cui->current == &cui->main->scr)
1072 nc_scr_post(cui->current);
1074 frame = &cui->plugin_menu->scr.frame;
1076 talloc_free(frame->rtitle);
1078 frame->rtitle = talloc_strdup(cui->main, cui->sysinfo->type);
1079 if (cui->sysinfo->identifier)
1080 frame->rtitle = talloc_asprintf_append(frame->rtitle,
1081 " %s", cui->sysinfo->identifier);
1083 if (cui->current == &cui->main->scr)
1084 nc_scr_post(cui->current);
1087 static void cui_update_sysinfo(struct system_info *sysinfo, void *arg)
1089 struct cui *cui = cui_from_arg(arg);
1090 cui->sysinfo = talloc_steal(cui, sysinfo);
1092 /* if we're currently displaying the system info screen, inform it
1093 * of the updated information. */
1094 if (cui->sysinfo_screen)
1095 sysinfo_screen_update(cui->sysinfo_screen, sysinfo);
1097 if (cui->subset_screen)
1098 subset_screen_update(cui->subset_screen);
1100 /* ... and do the same with the config screen... */
1101 if (cui->config_screen)
1102 config_screen_update(cui->config_screen, cui->config, sysinfo);
1104 /* ... and the boot editor. */
1105 if (cui->boot_editor)
1106 boot_editor_update(cui->boot_editor, sysinfo);
1108 cui_update_mm_title(cui);
1111 static void cui_update_language(struct cui *cui, char *lang)
1116 cur_lang = setlocale(LC_ALL, NULL);
1117 if (cur_lang && !strcmp(cur_lang, lang))
1120 setlocale(LC_ALL, lang);
1122 /* we'll need to update the menu: drop all items and repopulate */
1123 repost_menu = cui->current == &cui->main->scr ||
1124 cui->current == &cui->plugin_menu->scr;
1126 nc_scr_unpost(cui->current);
1128 talloc_free(cui->main);
1129 cui->main = main_menu_init(cui);
1130 cui->plugin_menu = plugin_menu_init(cui);
1133 cui->current = &cui->main->scr;
1134 nc_scr_post(cui->current);
1137 discover_client_enumerate(cui->client);
1140 static void cui_update_config(struct config *config, void *arg)
1142 struct cui *cui = cui_from_arg(arg);
1143 cui->config = talloc_steal(cui, config);
1146 cui_update_language(cui, config->lang);
1148 if (cui->subset_screen)
1149 subset_screen_update(cui->subset_screen);
1151 if (cui->config_screen)
1152 config_screen_update(cui->config_screen, config, cui->sysinfo);
1154 if (config->safe_mode)
1155 nc_scr_status_printf(cui->current,
1156 _("SAFE MODE: select '%s' to continue"),
1157 _("Rescan devices"));
1160 int cui_send_config(struct cui *cui, struct config *config)
1162 return discover_client_send_config(cui->client, config);
1165 int cui_send_url(struct cui *cui, char * url)
1167 return discover_client_send_url(cui->client, url);
1170 int cui_send_plugin_install(struct cui *cui, char *file)
1172 return discover_client_send_plugin_install(cui->client, file);
1175 void cui_send_reinit(struct cui *cui)
1177 discover_client_send_reinit(cui->client);
1180 static int menu_sysinfo_execute(struct pmenu_item *item)
1182 cui_show_sysinfo(cui_from_item(item));
1186 static int menu_config_execute(struct pmenu_item *item)
1188 cui_show_config(cui_from_item(item));
1192 static int menu_lang_execute(struct pmenu_item *item)
1194 cui_show_lang(cui_from_item(item));
1198 static int menu_statuslog_execute(struct pmenu_item *item)
1200 cui_show_statuslog(cui_from_item(item));
1204 static int menu_reinit_execute(struct pmenu_item *item)
1206 if (cui_from_item(item)->client)
1207 cui_send_reinit(cui_from_item(item));
1211 static int menu_add_url_execute(struct pmenu_item *item)
1213 if (cui_from_item(item)->client)
1214 cui_show_add_url(cui_from_item(item));
1218 static int menu_plugin_execute(struct pmenu_item *item)
1220 if (cui_from_item(item)->client)
1221 cui_show_plugin_menu(cui_from_item(item));
1226 * pb_mm_init - Setup the main menu instance.
1228 static struct pmenu *main_menu_init(struct cui *cui)
1230 struct pmenu_item *i;
1233 bool lockdown = lockdown_active();
1235 m = pmenu_init(cui, 9, cui_on_exit);
1237 pb_log("%s: failed\n", __func__);
1241 m->on_new = cui_item_new;
1243 m->scr.frame.ltitle = talloc_asprintf(m,
1244 "Petitboot (" PACKAGE_VERSION ")");
1245 m->scr.frame.rtitle = NULL;
1246 m->scr.frame.help = talloc_strdup(m,
1247 _("Enter=accept, e=edit, n=new, x=exit, l=language, g=log, h=help"));
1248 m->scr.frame.status = talloc_strdup(m, _("Welcome to Petitboot"));
1250 /* add a separator */
1251 i = pmenu_item_create(m, " ");
1252 item_opts_off(i->nci, O_SELECTABLE);
1253 pmenu_item_insert(m, i, 0);
1255 /* add system items */
1256 i = pmenu_item_create(m, _("System information"));
1257 i->on_execute = menu_sysinfo_execute;
1258 pmenu_item_insert(m, i, 1);
1260 i = pmenu_item_create(m, _("System configuration"));
1261 i->on_execute = menu_config_execute;
1262 pmenu_item_insert(m, i, 2);
1264 i = pmenu_item_create(m, _("System status log"));
1265 i->on_execute = menu_statuslog_execute;
1266 pmenu_item_insert(m, i, 3);
1268 /* this label isn't translated, so we don't want a gettext() here */
1269 i = pmenu_item_create(m, "Language");
1270 i->on_execute = menu_lang_execute;
1271 pmenu_item_insert(m, i, 4);
1273 i = pmenu_item_create(m, _("Rescan devices"));
1274 i->on_execute = menu_reinit_execute;
1275 pmenu_item_insert(m, i, 5);
1277 i = pmenu_item_create(m, _("Retrieve config from URL"));
1278 i->on_execute = menu_add_url_execute;
1279 pmenu_item_insert(m, i, 6);
1281 i = pmenu_item_create(m, _("Plugins (0)"));
1282 i->on_execute = menu_plugin_execute;
1283 pmenu_item_insert(m, i, 7);
1286 i = pmenu_item_create(m, _("Reboot"));
1288 i = pmenu_item_create(m, _("Exit to shell"));
1289 i->on_execute = pmenu_exit_cb;
1290 pmenu_item_insert(m, i, 8);
1292 result = pmenu_setup(m);
1295 pb_log("%s:%d: pmenu_setup failed: %s\n", __func__, __LINE__,
1300 m->help_title = _("main menu");
1301 m->help_text = &main_menu_help_text;
1303 menu_opts_off(m->ncm, O_SHOWDESC);
1304 set_menu_mark(m->ncm, " *");
1305 set_current_item(m->ncm, i->nci);
1315 * plugin_menu_init: Set up the plugin menu instance
1317 static struct pmenu *plugin_menu_init(struct cui *cui)
1319 struct pmenu_item *i;
1323 m = pmenu_init(cui, 2, cui_plugin_menu_exit);
1324 m->on_new = cui_item_new;
1325 m->scr.frame.ltitle = talloc_asprintf(m, _("Petitboot Plugins"));
1326 m->scr.frame.rtitle = talloc_asprintf(m, NULL);
1327 m->scr.frame.help = talloc_strdup(m,
1328 _("Enter=install, e=details, x=exit, h=help"));
1329 m->scr.frame.status = talloc_asprintf(m,
1330 _("Available Petitboot Plugins"));
1332 /* add a separator */
1333 i = pmenu_item_create(m, " ");
1334 item_opts_off(i->nci, O_SELECTABLE);
1335 pmenu_item_insert(m, i, 0);
1337 i = pmenu_item_create(m, _("Return to Main Menu"));
1338 i->on_execute = pmenu_exit_cb;
1339 pmenu_item_insert(m, i, 1);
1341 result = pmenu_setup(m);
1344 pb_log("%s:%d: pmenu_setup failed: %s\n", __func__, __LINE__,
1349 m->help_title = _("plugin menu");
1350 m->help_text = &plugin_menu_help_text;
1359 static struct discover_client_ops cui_client_ops = {
1361 .boot_option_add = cui_boot_option_add,
1362 .device_remove = cui_device_remove,
1363 .plugin_option_add = cui_plugin_option_add,
1364 .plugins_remove = cui_plugins_remove,
1365 .update_status = cui_update_status,
1366 .update_sysinfo = cui_update_sysinfo,
1367 .update_config = cui_update_config,
1370 /* cui_server_wait_on_exit - On exit spin until the server is available.
1372 * If the program exits before connecting to the server autoboot won't be
1373 * cancelled even though there has been keyboard activity. This function is
1374 * called by a child process which will spin until the server is connected and
1375 * told to cancel autoboot.
1377 * Processes exiting from this function will not carry out the cui_atexit()
1380 static void cui_server_wait_on_exit(struct cui *cui)
1382 cui_detached = true;
1384 while (!cui->client) {
1385 cui->client = discover_client_init(cui->waitset,
1386 &cui_client_ops, cui);
1391 talloc_steal(cui, cui->client);
1392 discover_client_cancel_default(cui->client);
1395 /* cui_server_wait - Connect to the discover server.
1396 * @arg: Pointer to the cui instance.
1398 * A timeout callback that attempts to connect to the discover server; on
1399 * failure it registers itself with a one second timeout to try again.
1400 * On success the cui->client struct will be set.
1402 * Since this updates the status line when called it must not be called
1403 * before the UI is ready.
1405 static int cui_server_wait(void *arg)
1407 struct cui *cui = cui_from_arg(arg);
1410 pb_debug("We already have a server!\n");
1414 /* We haven't yet connected to the server */
1415 pb_log("Trying to connect...\n");
1416 cui->client = discover_client_init(cui->waitset,
1417 &cui_client_ops, cui);
1420 waiter_register_timeout(cui->waitset, 1000, cui_server_wait,
1422 nc_scr_status_printf(cui->current,
1423 "Info: Waiting for device discovery");
1425 nc_scr_status_free(cui->current);
1426 talloc_steal(cui, cui->client);
1428 if (cui->has_input) {
1429 pb_log("Aborting default boot on pb-discover connect\n");
1430 discover_client_cancel_default(cui->client);
1438 * cui_init - Setup the cui instance.
1439 * @platform_info: A value for the struct cui platform_info member.
1441 * Returns a pointer to a struct cui on success, or NULL on error.
1443 * Allocates the cui instance, sets up the client and stdin waiters, and
1444 * sets up the ncurses menu screen.
1447 struct cui *cui_init(void* platform_info,
1448 int (*js_map)(const struct js_event *e), int start_daemon, int timeout)
1453 cui = talloc_zero(NULL, struct cui);
1455 pb_log("%s: alloc cui failed.\n", __func__);
1456 fprintf(stderr, _("%s: alloc cui failed.\n"), __func__);
1460 cui->c_sig = pb_cui_sig;
1461 cui->platform_info = platform_info;
1462 cui->waitset = waitset_create(cui);
1463 cui->statuslog = statuslog_init(cui);
1465 process_init(cui, cui->waitset, false);
1467 /* Loop here for scripts that just started the server. */
1470 for (i = start_daemon ? 2 : 15; i && timeout; i--) {
1471 cui->client = discover_client_init(cui->waitset,
1472 &cui_client_ops, cui);
1473 if (cui->client || !i)
1475 pb_log("%s: waiting for server %d\n", __func__, i);
1479 if (!cui->client && start_daemon) {
1484 result = pb_start_daemon(cui);
1489 pb_log("%s: discover_client_init failed.\n", __func__);
1490 fprintf(stderr, _("%s: error: discover_client_init failed.\n"),
1492 fprintf(stderr, _("could not start pb-discover, the petitboot "
1494 goto fail_client_init;
1497 if (!cui->client && !timeout) {
1498 /* Have the first timeout fire immediately so we can check
1499 * for the server as soon as the UI is ready */
1500 waiter_register_timeout(cui->waitset, 0,
1501 cui_server_wait, cui);
1502 } else if (!cui->client) {
1503 pb_log("%s: discover_client_init failed.\n", __func__);
1504 fprintf(stderr, _("%s: error: discover_client_init failed.\n"),
1506 fprintf(stderr, _("check that pb-discover, "
1507 "the petitboot daemon is running.\n"));
1508 goto fail_client_init;
1512 talloc_steal(cui, cui->client);
1515 cui->main = main_menu_init(cui);
1517 goto fail_client_init;
1519 cui->plugin_menu = plugin_menu_init(cui);
1520 if (!cui->plugin_menu)
1521 goto fail_client_init;
1523 waiter_register_io(cui->waitset, STDIN_FILENO, WAIT_IN,
1524 cui_process_key, cui);
1528 cui->pjs = pjs_init(cui, js_map);
1531 waiter_register_io(cui->waitset, pjs_get_fd(cui->pjs),
1532 WAIT_IN, cui_process_js, cui);
1544 * cui_run - The main cui program loop.
1545 * @cui: The cui instance.
1546 * @main: The menu to use as the main menu.
1548 * Runs the cui engine. Does not return until indicated to do so by some
1549 * user action, or an error occurs. Frees the cui object on return.
1550 * Returns 0 on success (return to shell), -1 on error (should restart).
1553 int cui_run(struct cui *cui)
1559 cui->current = &cui->main->scr;
1560 cui->default_item = 0;
1562 nc_scr_post(cui->current);
1565 int result = waiter_poll(cui->waitset);
1568 pb_log("%s: poll: %s\n", __func__, strerror(errno));
1575 while (cui->resize) {
1577 cui_handle_resize(cui);
1584 /* Fork a child to tell the server to cancel autoboot */
1587 cui_server_wait_on_exit(cui);
1591 pb_log("Failed to fork child on exit: %m\n");
1594 return cui->abort ? 0 : -1;