2 * Copyright (C) 2009 Sony Computer Entertainment Inc.
3 * Copyright 2009 Sony Corp.
5 * This program is free software; you can redistribute it and/or modify
6 * it under the terms of the GNU General Public License as published by
7 * the Free Software Foundation; version 2 of the License.
9 * This program is distributed in the hope that it will be useful,
10 * but WITHOUT ANY WARRANTY; without even the implied warranty of
11 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12 * GNU General Public License for more details.
14 * You should have received a copy of the GNU General Public License
15 * along with this program; if not, write to the Free Software
16 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
19 #if defined(HAVE_CONFIG_H)
29 #include <sys/ioctl.h>
30 #include <sys/reboot.h>
33 #include "pb-protocol/pb-protocol.h"
34 #include "talloc/talloc.h"
35 #include "waiter/waiter.h"
36 #include "process/process.h"
37 #include "i18n/i18n.h"
38 #include "ui/common/discover-client.h"
39 #include "ui/common/ui-system.h"
41 #include "nc-boot-editor.h"
42 #include "nc-config.h"
43 #include "nc-add-url.h"
44 #include "nc-sysinfo.h"
46 #include "nc-helpscreen.h"
47 #include "nc-statuslog.h"
48 #include "nc-subset.h"
49 #include "nc-plugin.h"
50 #include "console-codes.h"
52 extern const struct help_text main_menu_help_text;
53 extern const struct help_text plugin_menu_help_text;
55 static bool cui_detached = false;
57 static struct pmenu *main_menu_init(struct cui *cui);
58 static struct pmenu *plugin_menu_init(struct cui *cui);
60 static void cui_cancel_autoboot_on_exit(struct cui *cui);
62 static bool lockdown_active(void)
64 bool lockdown = false;
65 if (access(LOCKDOWN_FILE, F_OK) != -1)
70 static void cui_start(void)
72 initscr(); /* Initialize ncurses. */
73 cbreak(); /* Disable line buffering. */
74 noecho(); /* Disable getch() echo. */
75 keypad(stdscr, TRUE); /* Enable num keypad keys. */
76 nonl(); /* Disable new-line translation. */
77 intrflush(stdscr, FALSE); /* Disable interrupt flush. */
78 curs_set(0); /* Make cursor invisible */
79 nodelay(stdscr, TRUE); /* Enable non-blocking getch() */
81 /* We may be operating with an incorrect $TERM type; in this case
82 * the keymappings will be slightly broken. We want at least
83 * backspace to work though, so we'll define both DEL and ^H to
85 define_key("\x7f", KEY_BACKSPACE);
86 define_key("\x08", KEY_BACKSPACE);
88 /* we need backtab too, for form navigation. vt220 doesn't include
89 * this (kcbt), but we don't want to require a full linux/xterm termcap
91 define_key("\x1b[Z", KEY_BTAB);
93 /* We'll define a few other keys too since they're commonly
94 * used for navigation but the escape character will cause
95 * Petitboot to exit if they're left undefined */
96 define_key("\x1b\x5b\x35\x7e", KEY_PPAGE);
97 define_key("\x1b\x5b\x36\x7e", KEY_NPAGE);
98 define_key("\x1b\x5b\x31\x7e", KEY_HOME);
99 define_key("\x1b\x5b\x34\x7e", KEY_END);
100 define_key("\x1b\x4f\x48", KEY_HOME);
101 define_key("\x1b\x4f\x46", KEY_END);
102 define_key("OH", KEY_HOME);
103 define_key("OF", KEY_END);
105 /* Arrow keys in normal cursor mode */
106 define_key("\x1b\x5b\x41", KEY_UP);
107 define_key("\x1b\x5b\x42", KEY_DOWN);
108 define_key("\x1b\x5b\x43", KEY_RIGHT);
109 define_key("\x1b\x5b\x44", KEY_LEFT);
110 /* Arrow keys in "application" cursor mode */
111 define_key("\x1b\x4f\x41", KEY_UP);
112 define_key("\x1b\x4f\x42", KEY_DOWN);
113 define_key("\x1b\x4f\x43", KEY_RIGHT);
114 define_key("\x1b\x4f\x44", KEY_LEFT);
116 define_key("\x1b\x5b\x33\x7e", KEY_DC);
118 while (getch() != ERR) /* flush stdin */
122 static void cui_atexit(void)
131 bool lockdown = lockdown_active();
140 * cui_abort - Signal the main cui program loop to exit.
142 * Sets cui.abort, which causes the cui_run() routine to return.
145 void cui_abort(struct cui *cui)
147 pb_log("%s: exiting\n", __func__);
152 * cui_resize - Signal the main cui program loop to resize
154 * Called at SIGWINCH.
157 void cui_resize(struct cui *cui)
159 pb_debug("%s: resizing\n", __func__);
164 * cui_on_exit - A generic main menu exit callback.
167 void cui_on_exit(struct pmenu *menu)
169 struct cui *cui = cui_from_pmenu(menu);
172 cui_cancel_autoboot_on_exit(cui);
174 sh_cmd = talloc_asprintf(cui,
175 "echo \"Exiting petitboot. Type 'exit' to return.\";\
176 echo \"You may run 'pb-sos' to gather diagnostic data\";\
177 %s", pb_system_apps.sh);
180 pb_log("Failed to allocate shell arguments\n");
184 const char *argv[] = {
191 cui_run_cmd(cui, argv);
193 nc_scr_status_printf(cui->current, _("Returned from shell"));
198 * cui_run_cmd - A generic cb to run the supplied command.
201 int cui_run_cmd(struct cui *cui, const char **cmd_argv)
203 struct process *process;
206 process = process_create(cui);
210 process->path = cmd_argv[0];
211 process->argv = cmd_argv;
212 process->raw_stdout = true;
214 nc_scr_status_printf(cui->current, _("Running %s..."), cmd_argv[0]);
216 nc_scr_unpost(cui->current);
223 result = process_run_sync(process);
228 redrawwin(cui->current->main_ncw);
229 nc_scr_post(cui->current);
232 pb_log("%s: failed: '%s'\n", __func__, cmd_argv[0]);
233 nc_scr_status_printf(cui->current, _("Failed: %s"),
237 process_release(process);
242 int cui_run_cmd_from_item(struct pmenu_item *item)
244 struct cui *cui = cui_from_item(item);
245 const char **cmd_argv = item->data;
247 return cui_run_cmd(cui, cmd_argv);
251 * cui_boot - A generic cb to run kexec.
254 static int cui_boot(struct pmenu_item *item)
257 struct cui *cui = cui_from_item(item);
258 struct cui_opt_data *cod = cod_from_item(item);
260 assert(cui->current == &cui->main->scr);
262 pb_debug("%s: %s\n", __func__, cod->name);
264 nc_scr_status_printf(cui->current, _("Booting %s..."), cod->name);
266 result = discover_client_boot(cui->client, NULL, cod->opt, cod->bd);
269 nc_scr_status_printf(cui->current,
270 _("Failed: boot %s"), cod->bd->image);
276 static void cui_boot_editor_on_exit(struct cui *cui,
277 struct pmenu_item *item,
278 struct pb_boot_data *bd)
280 struct pmenu *menu = cui->main;
281 struct cui_opt_data *cod;
282 int idx, top, rows, cols;
283 static int user_idx = 0;
285 /* Was the edit cancelled? */
287 cui_set_current(cui, &cui->main->scr);
288 talloc_free(cui->boot_editor);
289 cui->boot_editor = NULL;
293 /* Is this was a new item, we'll need to update the menu */
297 cod = talloc_zero(NULL, struct cui_opt_data);
298 cod->name = talloc_asprintf(cod, _("User item %u"), ++user_idx);
300 item = pmenu_item_create(menu, cod->name);
306 item->on_edit = cui_item_edit;
307 item->on_execute = cui_boot;
310 talloc_steal(item, cod);
312 /* Detach the items array. */
313 set_menu_items(menu->ncm, NULL);
315 /* Insert new item at insert_pt. */
316 insert_pt = pmenu_grow(menu, 1);
317 pmenu_item_insert(menu, item, insert_pt);
319 /* Re-attach the items array. */
320 set_menu_items(menu->ncm, menu->items);
322 /* If our index is above the current top row, align
323 * us to the new top. Otherwise, align us to the new
325 menu_format(cui->main->ncm, &rows, &cols);
326 top = top_row(cui->main->ncm);
327 idx = item_index(item->nci);
332 top = idx < rows ? 0 : idx - rows + 1;
334 set_top_row(cui->main->ncm, top);
335 set_current_item(item->pmenu->ncm, item->nci);
337 nc_scr_post(&menu->scr);
342 cod->bd = talloc_steal(cod, bd);
345 cui_set_current(cui, &cui->main->scr);
346 talloc_free(cui->boot_editor);
347 cui->boot_editor = NULL;
350 void cui_item_edit(struct pmenu_item *item)
352 struct cui *cui = cui_from_item(item);
353 cui->boot_editor = boot_editor_init(cui, item, cui->sysinfo,
354 cui_boot_editor_on_exit);
355 cui_set_current(cui, boot_editor_scr(cui->boot_editor));
358 void cui_item_new(struct pmenu *menu)
360 struct cui *cui = cui_from_pmenu(menu);
361 cui->boot_editor = boot_editor_init(cui, NULL, cui->sysinfo,
362 cui_boot_editor_on_exit);
363 cui_set_current(cui, boot_editor_scr(cui->boot_editor));
366 static void cui_sysinfo_exit(struct cui *cui)
368 cui_set_current(cui, &cui->main->scr);
369 talloc_free(cui->sysinfo_screen);
370 cui->sysinfo_screen = NULL;
373 void cui_show_sysinfo(struct cui *cui)
375 cui->sysinfo_screen = sysinfo_screen_init(cui, cui->sysinfo,
377 cui_set_current(cui, sysinfo_screen_scr(cui->sysinfo_screen));
380 static void cui_config_exit(struct cui *cui)
382 cui_set_current(cui, &cui->main->scr);
383 talloc_free(cui->config_screen);
384 cui->config_screen = NULL;
387 void cui_show_config(struct cui *cui)
389 cui->config_screen = config_screen_init(cui, cui->config,
390 cui->sysinfo, cui_config_exit);
391 cui_set_current(cui, config_screen_scr(cui->config_screen));
394 static void cui_lang_exit(struct cui *cui)
396 cui_set_current(cui, &cui->main->scr);
397 talloc_free(cui->lang_screen);
398 cui->lang_screen = NULL;
401 void cui_show_lang(struct cui *cui)
403 cui->lang_screen = lang_screen_init(cui, cui->config, cui_lang_exit);
404 cui_set_current(cui, lang_screen_scr(cui->lang_screen));
407 static void cui_statuslog_exit(struct cui *cui)
409 cui_set_current(cui, &cui->main->scr);
410 talloc_free(cui->statuslog_screen);
411 cui->statuslog_screen = NULL;
414 void cui_show_statuslog(struct cui *cui)
416 cui->statuslog_screen = statuslog_screen_init(cui, cui_statuslog_exit);
417 cui_set_current(cui, statuslog_screen_scr(cui->statuslog_screen));
420 static void cui_add_url_exit(struct cui *cui)
422 cui_set_current(cui, &cui->main->scr);
423 talloc_free(cui->add_url_screen);
424 cui->add_url_screen = NULL;
427 static void cui_plugin_exit(struct cui *cui)
429 cui_set_current(cui, &cui->plugin_menu->scr);
430 talloc_free(cui->plugin_screen);
431 cui->plugin_screen = NULL;
434 static void cui_plugin_menu_exit(struct pmenu *menu)
436 struct cui *cui = cui_from_pmenu(menu);
437 cui_set_current(cui, &cui->main->scr);
440 void cui_show_add_url(struct cui *cui)
442 cui->add_url_screen = add_url_screen_init(cui, cui_add_url_exit);
443 cui_set_current(cui, add_url_screen_scr(cui->add_url_screen));
446 void cui_show_plugin_menu(struct cui *cui)
448 cui_set_current(cui, &cui->plugin_menu->scr);
451 void cui_show_plugin(struct pmenu_item *item)
453 struct cui *cui = cui_from_item(item);
454 cui->plugin_screen = plugin_screen_init(cui, item, cui_plugin_exit);
455 cui_set_current(cui, plugin_screen_scr(cui->plugin_screen));
458 static void cui_help_exit(struct cui *cui)
460 cui_set_current(cui, help_screen_return_scr(cui->help_screen));
461 talloc_free(cui->help_screen);
462 cui->help_screen = NULL;
465 void cui_show_help(struct cui *cui, const char *title,
466 const struct help_text *text)
471 if (cui->help_screen)
474 cui->help_screen = help_screen_init(cui, cui->current,
475 title, text, cui_help_exit);
477 if (cui->help_screen)
478 cui_set_current(cui, help_screen_scr(cui->help_screen));
481 static void cui_subset_exit(struct cui *cui)
483 cui_set_current(cui, subset_screen_return_scr(cui->subset_screen));
484 talloc_free(cui->subset_screen);
485 cui->subset_screen = NULL;
488 void cui_show_subset(struct cui *cui, const char *title,
494 if (cui->subset_screen)
497 cui->subset_screen = subset_screen_init(cui, cui->current,
498 title, arg, cui_subset_exit);
500 if (cui->subset_screen)
501 cui_set_current(cui, subset_screen_scr(cui->subset_screen));
505 * cui_set_current - Set the currently active screen and redraw it.
508 struct nc_scr *cui_set_current(struct cui *cui, struct nc_scr *scr)
512 DBGS("%p -> %p\n", cui->current, scr);
514 assert(cui->current != scr);
521 nc_scr_post(cui->current);
526 static bool process_global_keys(struct cui *cui, int key)
530 if (cui->current && cui->current->main_ncw)
538 * cui_process_key - Process input on stdin.
541 static int cui_process_key(void *arg)
543 struct cui *cui = cui_from_arg(arg);
548 assert(cui->current);
553 pb_debug("%s: got key %d\n", __func__, c);
560 * If this is a console code sequence try to parse it
561 * and don't treat this as a key press.
564 if (grab != ERR && grab != 27) {
566 pb_debug("%s: Caught unhandled command sequence\n",
568 sequence = handle_control_sequence(cui, c);
569 pb_debug("Caught sequence ");
571 pb_debug("(%zu): ", strlen(sequence));
572 for (i = 0; i < strlen(sequence); i++)
573 pb_debug("0%o ", sequence[i]);
576 pb_debug("(0): (none)\n");
581 if (!cui->has_input) {
582 cui->has_input = true;
584 pb_log("UI input received (key = %d), aborting "
585 "default boot\n", c);
586 discover_client_cancel_default(cui->client);
588 pb_log("UI input received (key = %d), aborting "
589 "once server connects\n", c);
593 if (process_global_keys(cui, c))
596 cui->current->process_key(cui->current, c);
603 * cui_process_js - Process joystick events.
606 static int cui_process_js(void *arg)
608 struct cui *cui = cui_from_arg(arg);
611 c = pjs_process_event(cui->pjs);
615 cui_process_key(arg);
622 * cui_handle_resize - Handle the term resize.
625 static void cui_handle_resize(struct cui *cui)
629 if (ioctl(1, TIOCGWINSZ, &ws) == -1) {
630 pb_log("%s: ioctl failed: %s\n", __func__, strerror(errno));
634 pb_debug("%s: {%u,%u}\n", __func__, ws.ws_row, ws.ws_col);
636 wclear(cui->current->main_ncw);
637 resize_term(ws.ws_row, ws.ws_col);
638 cui->current->resize(cui->current);
640 /* For some reason this makes ncurses redraw the screen */
642 redrawwin(cui->current->main_ncw);
643 wrefresh(cui->current->main_ncw);
647 * cui_device_add - Client device_add callback.
649 * Creates menu_items for all the device boot_options and inserts those
650 * menu_items into the main menu. Redraws the main menu if it is active.
651 * If a 'plugin' type boot_option appears the plugin menu is updated instead.
654 static int cui_boot_option_add(struct device *dev, struct boot_option *opt,
657 struct pmenu_item *i, *dev_hdr = NULL;
658 struct cui *cui = cui_from_arg(arg);
659 struct cui_opt_data *cod;
660 const char *tab = " ";
661 unsigned int insert_pt;
662 int result, rows, cols;
668 plugin_option = opt->type == DISCOVER_PLUGIN_OPTION;
669 menu = plugin_option ? cui->plugin_menu : cui->main;
671 pb_debug("%s: %p %s\n", __func__, opt, opt->id);
673 selected = current_item(menu->ncm);
674 menu_format(menu->ncm, &rows, &cols);
676 if (cui->current == &cui->main->scr)
677 nc_scr_unpost(cui->current);
678 if (plugin_option && cui->current == &cui->plugin_menu->scr)
679 nc_scr_unpost(cui->current);
681 /* Check if the boot device is new */
682 dev_hdr = pmenu_find_device(menu, dev, opt);
684 /* All actual boot entries are 'tabbed' across */
685 name = talloc_asprintf(menu, "%s%s",
686 tab, opt->name ? : "Unknown Name");
688 /* Save the item in opt->ui_info for cui_device_remove() */
689 opt->ui_info = i = pmenu_item_create(menu, name);
696 i->on_execute = plugin_install_plugin;
698 i->on_edit = cui_item_edit;
699 i->on_execute = cui_boot;
702 i->data = cod = talloc(i, struct cui_opt_data);
705 cod->opt_hash = pb_opt_hash(dev, opt);
706 cod->name = opt->name;
709 cod->pd = talloc(i, struct pb_plugin_data);
710 cod->pd->plugin_file = talloc_strdup(cod,
711 opt->boot_image_file);
713 cod->bd = talloc(i, struct pb_boot_data);
714 cod->bd->image = talloc_strdup(cod->bd, opt->boot_image_file);
715 cod->bd->initrd = talloc_strdup(cod->bd, opt->initrd_file);
716 cod->bd->dtb = talloc_strdup(cod->bd, opt->dtb_file);
717 cod->bd->args = talloc_strdup(cod->bd, opt->boot_args);
718 cod->bd->args_sig_file = talloc_strdup(cod->bd, opt->args_sig_file);
721 /* This disconnects items array from menu. */
722 result = set_menu_items(menu->ncm, NULL);
725 pb_log("%s: set_menu_items failed: %d\n", __func__, result);
727 /* Insert new items at insert_pt. */
729 insert_pt = pmenu_grow(menu, 2);
730 pmenu_item_insert(menu, dev_hdr, insert_pt);
731 pb_log("%s: adding new device hierarchy %s\n",
732 __func__, opt->device_id);
733 pmenu_item_insert(menu, i, insert_pt+1);
735 insert_pt = pmenu_grow(menu, 1);
736 pmenu_item_add(menu, i, insert_pt);
740 pb_log("%s: adding plugin '%s'\n", __func__, cod->name);
741 pb_log(" file '%s'\n", cod->pd->plugin_file);
743 pb_log("%s: adding opt '%s'\n", __func__, cod->name);
744 pb_log(" image '%s'\n", cod->bd->image);
745 pb_log(" initrd '%s'\n", cod->bd->initrd);
746 pb_log(" args '%s'\n", cod->bd->args);
747 pb_log(" argsig '%s'\n", cod->bd->args_sig_file);
750 /* Update the plugin menu label if needed */
752 struct pmenu_item *item;
754 result = set_menu_items(cui->main->ncm, NULL);
755 for (j = 0 ; j < cui->main->item_count; j++) {
756 item = item_userptr(cui->main->items[j]);
757 if (strncmp(item->nci->name.str, "Plugins", strlen("Plugins")))
760 char *label = talloc_asprintf(item, "Plugins (%u)",
762 pmenu_item_update(item, label);
766 result = set_menu_items(cui->main->ncm, cui->main->items);
768 pb_log("%s: set_menu_items failed: %d\n", __func__, result);
771 /* Re-attach the items array. */
772 result = set_menu_items(menu->ncm, menu->items);
775 pb_log("%s: set_menu_items failed: %d\n", __func__, result);
778 pb_log("%s\n", __func__);
779 pmenu_dump_items(menu->items,
780 item_count(menu->ncm) + 1);
783 if (!item_visible(selected)) {
786 top = top_row(menu->ncm);
787 idx = item_index(selected);
789 /* If our index is above the current top row, align
790 * us to the new top. Otherwise, align us to the new
792 top = top < idx ? idx - rows + 1 : idx;
794 set_top_row(menu->ncm, top);
795 set_current_item(menu->ncm, selected);
798 if (cui->current == &menu->scr)
799 nc_scr_post(cui->current);
800 if (plugin_option && cui->current == &cui->main->scr)
801 nc_scr_post(cui->current);
807 * cui_device_remove - Client device remove callback.
809 * Removes all the menu_items for the device from the main menu and redraws the
810 * main menu if it is active.
812 static void cui_device_remove(struct device *dev, void *arg)
814 struct cui *cui = cui_from_arg(arg);
815 struct boot_option *opt;
817 int rows, cols, top, last;
820 pb_log("%s: %p %s\n", __func__, dev, dev->id);
822 if (cui->current == &cui->main->scr)
823 nc_scr_unpost(cui->current);
824 if (cui->current == &cui->plugin_menu->scr)
825 nc_scr_unpost(cui->current);
827 /* This disconnects items array from menu. */
829 result = set_menu_items(cui->main->ncm, NULL);
830 result |= set_menu_items(cui->plugin_menu->ncm, NULL);
833 pb_log("%s: set_menu_items failed: %d\n", __func__, result);
835 list_for_each_entry(&dev->boot_options, opt, list) {
836 struct pmenu_item *item = pmenu_item_from_arg(opt->ui_info);
838 assert(pb_protocol_device_cmp(dev, cod_from_item(item)->dev));
839 if (opt->type == DISCOVER_PLUGIN_OPTION)
840 pmenu_remove(cui->plugin_menu, item);
842 pmenu_remove(cui->main, item);
845 /* Manually remove remaining device hierarchy item */
846 for (i=0; i < cui->main->item_count; i++) {
847 struct pmenu_item *item = item_userptr(cui->main->items[i]);
848 if (!item || !item->data )
851 struct cui_opt_data *data = item->data;
852 if (data && data->dev && data->dev == dev)
853 pmenu_remove(cui->main,item);
855 /* Look in plugins menu too */
856 for (i=0; i < cui->plugin_menu->item_count; i++) {
857 struct pmenu_item *item = item_userptr(cui->plugin_menu->items[i]);
858 if (!item || !item->data )
861 struct cui_opt_data *data = item->data;
862 if (data && data->dev && data->dev == dev)
863 pmenu_remove(cui->plugin_menu,item);
866 /* Re-attach the items array. */
868 result = set_menu_items(cui->main->ncm, cui->main->items);
869 result |= set_menu_items(cui->plugin_menu->ncm, cui->plugin_menu->items);
871 /* Move cursor to 'Exit' menu entry for the main menu.. */
872 menu_format(cui->main->ncm, &rows, &cols);
873 last = cui->main->item_count - 1;
874 set_current_item(cui->main->ncm, cui->main->items[last]);
875 if (!item_visible(cui->main->items[last])) {
876 top = last < rows ? 0 : last - rows + 1;
877 set_top_row(cui->main->ncm, top);
880 /* ..and the plugin menu */
881 menu_format(cui->plugin_menu->ncm, &rows, &cols);
882 last = cui->plugin_menu->item_count - 1;
883 set_current_item(cui->plugin_menu->ncm, cui->plugin_menu->items[last]);
884 if (!item_visible(cui->plugin_menu->items[last])) {
885 top = last < rows ? 0 : last - rows + 1;
886 set_top_row(cui->plugin_menu->ncm, top);
890 pb_log("%s: set_menu_items failed: %d\n", __func__, result);
893 pb_log("%s\n", __func__);
894 pmenu_dump_items(cui->main->items,
895 item_count(cui->main->ncm) + 1);
898 if (cui->current == &cui->main->scr)
899 nc_scr_post(cui->current);
900 if (cui->current == &cui->plugin_menu->scr)
901 nc_scr_post(cui->current);
904 static void cui_update_status(struct status *status, void *arg)
906 struct cui *cui = cui_from_arg(arg);
908 statuslog_append_steal(cui, cui->statuslog, status);
910 /* Ignore status messages from the backlog */
911 if (!status->backlog)
912 nc_scr_status_printf(cui->current, "%s", status->message);
916 * Handle a new installed plugin option and update its associated
917 * (uninstalled) menu item if it exists.
919 static int cui_plugin_option_add(struct plugin_option *opt, void *arg)
921 struct cui_opt_data *cod;
922 struct cui *cui = cui_from_arg(arg);
923 struct pmenu_item *item = NULL;
924 struct boot_option *dummy_opt;
930 /* Find uninstalled plugin by matching on plugin_file */
931 for (i = 0; i < cui->plugin_menu->item_count; i++) {
932 item = item_userptr(cui->plugin_menu->items[i]);
935 cod = cod_from_item(item);
936 if (!cod || !cod->pd)
938 if (strncmp(cod->pd->plugin_file, opt->plugin_file,
939 strlen(cod->pd->plugin_file)) == 0)
944 * If pb-plugin was run manually there may not be an associated
945 * plugin-type boot_option. Pass a fake device and option to
946 * cui_boot_option_add() so we have an item to work with.
948 if (!item || i >= cui->plugin_menu->item_count) {
949 pb_log("New plugin option %s doesn't have a source item\n",
951 dev = talloc_zero(cui, struct device);
952 dev->id = dev->name = talloc_asprintf(dev, "(unknown)");
953 dev->type = DEVICE_TYPE_UNKNOWN;
954 dummy_opt = talloc_zero(cui, struct boot_option);
955 dummy_opt->device_id = talloc_strdup(dummy_opt, dev->id);
956 dummy_opt->id = dummy_opt->name = talloc_asprintf(dummy_opt, "dummy");
957 dummy_opt->boot_image_file = talloc_strdup(dummy_opt, opt->plugin_file);
958 dummy_opt->type = DISCOVER_PLUGIN_OPTION;
959 cui_boot_option_add(dev, dummy_opt, cui);
964 * If this option was faked above move the context under
965 * the item so it is cleaned up later in cui_plugins_remove().
967 if (strncmp(cod->opt->id, "dummy", strlen("dummy") == 0 &&
968 cod->dev->type == DEVICE_TYPE_UNKNOWN)) {
969 talloc_steal(item, cod->dev);
970 talloc_steal(item, cod->opt);
973 talloc_free(cod->name);
974 /* Name is still tabbed across */
975 cod->name = talloc_asprintf(cod, _(" %s [installed]"), opt->name);
978 item->on_execute = NULL;
979 item->on_edit = cui_show_plugin;
981 if (cui->current == &cui->plugin_menu->scr)
982 nc_scr_unpost(cui->current);
984 /* This disconnects items array from menu. */
985 result = set_menu_items(cui->plugin_menu->ncm, NULL);
988 pmenu_item_update(item, cod->name);
990 /* Re-attach the items array. */
991 result = set_menu_items(cui->plugin_menu->ncm, cui->plugin_menu->items);
993 if (cui->current == &cui->plugin_menu->scr)
994 nc_scr_post(cui->current);
1000 * Most plugin menu items will be removed via cui_device_remove(). However if
1001 * pb-plugin has been run manually it is possible that there a plugin items
1002 * not associated with a device - remove them here.
1004 static int cui_plugins_remove(void *arg)
1006 struct cui *cui = cui_from_arg(arg);
1007 struct pmenu_item *item = NULL;
1008 struct cui_opt_data *cod;
1011 pb_debug("%s\n", __func__);
1013 if (cui->current == &cui->plugin_menu->scr)
1014 nc_scr_unpost(cui->current);
1015 if (cui->current == &cui->main->scr)
1016 nc_scr_unpost(cui->current);
1018 /* This disconnects items array from menu. */
1019 set_menu_items(cui->plugin_menu->ncm, NULL);
1021 while (i < cui->plugin_menu->item_count) {
1022 item = item_userptr(cui->plugin_menu->items[i]);
1023 if (!item || !item->data) {
1027 cod = cod_from_item(item);
1028 if (!cod->opt && !cod->dev) {
1033 pmenu_remove(cui->plugin_menu, item);
1034 /* plugin_menu entries will shift, jump to bottom to make sure
1035 * we remove all plugin option items */
1039 /* Re-attach the items array. */
1040 set_menu_items(cui->plugin_menu->ncm, cui->plugin_menu->items);
1042 set_menu_items(cui->main->ncm, NULL);
1043 for (i = 0; i < cui->main->item_count; i++) {
1044 item = item_userptr(cui->main->items[i]);
1045 if (strncmp(item->nci->name.str, "Plugins", strlen("Plugins")))
1048 pmenu_item_update(item, "Plugins (0)");
1052 set_menu_items(cui->main->ncm, cui->main->items);
1054 if (cui->current == &cui->main->scr)
1055 nc_scr_post(cui->current);
1057 /* If we're currently in a plugin screen jump back to the plugin menu */
1058 if (cui->plugin_screen &&
1059 cui->current == plugin_screen_scr(cui->plugin_screen))
1060 cui_plugin_exit(cui);
1065 static void cui_update_mm_title(struct cui *cui)
1067 struct nc_frame *frame = &cui->main->scr.frame;
1069 talloc_free(frame->rtitle);
1071 frame->rtitle = talloc_strdup(cui->main, cui->sysinfo->type);
1072 if (cui->sysinfo->identifier)
1073 frame->rtitle = talloc_asprintf_append(frame->rtitle,
1074 " %s", cui->sysinfo->identifier);
1076 if (cui->current == &cui->main->scr)
1077 nc_scr_post(cui->current);
1079 frame = &cui->plugin_menu->scr.frame;
1081 talloc_free(frame->rtitle);
1083 frame->rtitle = talloc_strdup(cui->main, cui->sysinfo->type);
1084 if (cui->sysinfo->identifier)
1085 frame->rtitle = talloc_asprintf_append(frame->rtitle,
1086 " %s", cui->sysinfo->identifier);
1088 if (cui->current == &cui->main->scr)
1089 nc_scr_post(cui->current);
1092 static void cui_update_sysinfo(struct system_info *sysinfo, void *arg)
1094 struct cui *cui = cui_from_arg(arg);
1095 cui->sysinfo = talloc_steal(cui, sysinfo);
1097 /* if we're currently displaying the system info screen, inform it
1098 * of the updated information. */
1099 if (cui->sysinfo_screen)
1100 sysinfo_screen_update(cui->sysinfo_screen, sysinfo);
1102 if (cui->subset_screen)
1103 subset_screen_update(cui->subset_screen);
1105 /* ... and do the same with the config screen... */
1106 if (cui->config_screen)
1107 config_screen_update(cui->config_screen, cui->config, sysinfo);
1109 /* ... and the boot editor. */
1110 if (cui->boot_editor)
1111 boot_editor_update(cui->boot_editor, sysinfo);
1113 cui_update_mm_title(cui);
1116 static void cui_update_language(struct cui *cui, char *lang)
1121 cur_lang = setlocale(LC_ALL, NULL);
1122 if (cur_lang && !strcmp(cur_lang, lang))
1125 setlocale(LC_ALL, lang);
1127 /* we'll need to update the menu: drop all items and repopulate */
1128 repost_menu = cui->current == &cui->main->scr ||
1129 cui->current == &cui->plugin_menu->scr;
1131 nc_scr_unpost(cui->current);
1133 talloc_free(cui->main);
1134 cui->main = main_menu_init(cui);
1135 cui->plugin_menu = plugin_menu_init(cui);
1138 cui->current = &cui->main->scr;
1139 nc_scr_post(cui->current);
1142 discover_client_enumerate(cui->client);
1145 static void cui_update_config(struct config *config, void *arg)
1147 struct cui *cui = cui_from_arg(arg);
1148 cui->config = talloc_steal(cui, config);
1151 cui_update_language(cui, config->lang);
1153 if (cui->subset_screen)
1154 subset_screen_update(cui->subset_screen);
1156 if (cui->config_screen)
1157 config_screen_update(cui->config_screen, config, cui->sysinfo);
1159 if (config->safe_mode)
1160 nc_scr_status_printf(cui->current,
1161 _("SAFE MODE: select '%s' to continue"),
1162 _("Rescan devices"));
1165 int cui_send_config(struct cui *cui, struct config *config)
1167 return discover_client_send_config(cui->client, config);
1170 int cui_send_url(struct cui *cui, char * url)
1172 return discover_client_send_url(cui->client, url);
1175 int cui_send_plugin_install(struct cui *cui, char *file)
1177 return discover_client_send_plugin_install(cui->client, file);
1180 void cui_send_reinit(struct cui *cui)
1182 discover_client_send_reinit(cui->client);
1185 static int menu_sysinfo_execute(struct pmenu_item *item)
1187 cui_show_sysinfo(cui_from_item(item));
1191 static int menu_config_execute(struct pmenu_item *item)
1193 cui_show_config(cui_from_item(item));
1197 static int menu_lang_execute(struct pmenu_item *item)
1199 cui_show_lang(cui_from_item(item));
1203 static int menu_statuslog_execute(struct pmenu_item *item)
1205 cui_show_statuslog(cui_from_item(item));
1209 static int menu_reinit_execute(struct pmenu_item *item)
1211 if (cui_from_item(item)->client)
1212 cui_send_reinit(cui_from_item(item));
1216 static int menu_add_url_execute(struct pmenu_item *item)
1218 if (cui_from_item(item)->client)
1219 cui_show_add_url(cui_from_item(item));
1223 static int menu_plugin_execute(struct pmenu_item *item)
1225 if (cui_from_item(item)->client)
1226 cui_show_plugin_menu(cui_from_item(item));
1231 * pb_mm_init - Setup the main menu instance.
1233 static struct pmenu *main_menu_init(struct cui *cui)
1235 struct pmenu_item *i;
1238 bool lockdown = lockdown_active();
1240 m = pmenu_init(cui, 9, cui_on_exit);
1242 pb_log("%s: failed\n", __func__);
1247 m->hot_keys = talloc_array(m, hot_key_fn, m->n_hot_keys);
1249 pb_log("%s: failed to allocate hot_keys\n", __func__);
1253 m->hot_keys[0] = pmenu_main_hot_keys;
1254 m->on_new = cui_item_new;
1256 m->scr.frame.ltitle = talloc_asprintf(m,
1257 "Petitboot (" PACKAGE_VERSION ")");
1258 m->scr.frame.rtitle = NULL;
1259 m->scr.frame.help = talloc_strdup(m,
1260 _("Enter=accept, e=edit, n=new, x=exit, l=language, g=log, h=help"));
1261 m->scr.frame.status = talloc_strdup(m, _("Welcome to Petitboot"));
1263 /* add a separator */
1264 i = pmenu_item_create(m, " ");
1265 item_opts_off(i->nci, O_SELECTABLE);
1266 pmenu_item_insert(m, i, 0);
1268 /* add system items */
1269 i = pmenu_item_create(m, _("System information"));
1270 i->on_execute = menu_sysinfo_execute;
1271 pmenu_item_insert(m, i, 1);
1273 i = pmenu_item_create(m, _("System configuration"));
1274 i->on_execute = menu_config_execute;
1275 pmenu_item_insert(m, i, 2);
1277 i = pmenu_item_create(m, _("System status log"));
1278 i->on_execute = menu_statuslog_execute;
1279 pmenu_item_insert(m, i, 3);
1281 /* this label isn't translated, so we don't want a gettext() here */
1282 i = pmenu_item_create(m, "Language");
1283 i->on_execute = menu_lang_execute;
1284 pmenu_item_insert(m, i, 4);
1286 i = pmenu_item_create(m, _("Rescan devices"));
1287 i->on_execute = menu_reinit_execute;
1288 pmenu_item_insert(m, i, 5);
1290 i = pmenu_item_create(m, _("Retrieve config from URL"));
1291 i->on_execute = menu_add_url_execute;
1292 pmenu_item_insert(m, i, 6);
1294 i = pmenu_item_create(m, _("Plugins (0)"));
1295 i->on_execute = menu_plugin_execute;
1296 pmenu_item_insert(m, i, 7);
1299 i = pmenu_item_create(m, _("Reboot"));
1301 i = pmenu_item_create(m, _("Exit to shell"));
1302 i->on_execute = pmenu_exit_cb;
1303 pmenu_item_insert(m, i, 8);
1305 result = pmenu_setup(m);
1308 pb_log("%s:%d: pmenu_setup failed: %s\n", __func__, __LINE__,
1313 m->help_title = _("main menu");
1314 m->help_text = &main_menu_help_text;
1316 menu_opts_off(m->ncm, O_SHOWDESC);
1317 set_menu_mark(m->ncm, " *");
1318 set_current_item(m->ncm, i->nci);
1328 * plugin_menu_init: Set up the plugin menu instance
1330 static struct pmenu *plugin_menu_init(struct cui *cui)
1332 struct pmenu_item *i;
1336 m = pmenu_init(cui, 2, cui_plugin_menu_exit);
1337 m->scr.frame.ltitle = talloc_asprintf(m, _("Petitboot Plugins"));
1338 m->scr.frame.rtitle = talloc_asprintf(m, "%s", "");
1339 m->scr.frame.help = talloc_strdup(m,
1340 _("Enter=install, e=details, x=exit, h=help"));
1341 m->scr.frame.status = talloc_asprintf(m,
1342 _("Available Petitboot Plugins"));
1344 /* add a separator */
1345 i = pmenu_item_create(m, " ");
1346 item_opts_off(i->nci, O_SELECTABLE);
1347 pmenu_item_insert(m, i, 0);
1349 i = pmenu_item_create(m, _("Return to Main Menu"));
1350 i->on_execute = pmenu_exit_cb;
1351 pmenu_item_insert(m, i, 1);
1353 result = pmenu_setup(m);
1356 pb_log("%s:%d: pmenu_setup failed: %s\n", __func__, __LINE__,
1361 m->help_title = _("plugin menu");
1362 m->help_text = &plugin_menu_help_text;
1371 static struct discover_client_ops cui_client_ops = {
1373 .boot_option_add = cui_boot_option_add,
1374 .device_remove = cui_device_remove,
1375 .plugin_option_add = cui_plugin_option_add,
1376 .plugins_remove = cui_plugins_remove,
1377 .update_status = cui_update_status,
1378 .update_sysinfo = cui_update_sysinfo,
1379 .update_config = cui_update_config,
1382 /* cui_server_wait - Connect to the discover server.
1383 * @arg: Pointer to the cui instance.
1385 * A timeout callback that attempts to connect to the discover server; on
1386 * failure it registers itself with a one second timeout to try again.
1387 * On success the cui->client struct will be set.
1389 * Since this updates the status line when called it must not be called
1390 * before the UI is ready.
1392 static int cui_server_wait(void *arg)
1394 struct cui *cui = cui_from_arg(arg);
1397 pb_debug("We already have a server!\n");
1401 /* We haven't yet connected to the server */
1402 pb_log("Trying to connect...\n");
1403 cui->client = discover_client_init(cui->waitset,
1404 &cui_client_ops, cui);
1407 waiter_register_timeout(cui->waitset, 1000, cui_server_wait,
1409 nc_scr_status_printf(cui->current,
1410 "Info: Waiting for device discovery");
1412 nc_scr_status_free(cui->current);
1413 talloc_steal(cui, cui->client);
1415 if (cui->has_input) {
1416 pb_log("Aborting default boot on pb-discover connect\n");
1417 discover_client_cancel_default(cui->client);
1425 * cui_init - Setup the cui instance.
1426 * @platform_info: A value for the struct cui platform_info member.
1428 * Returns a pointer to a struct cui on success, or NULL on error.
1430 * Allocates the cui instance, sets up the client and stdin waiters, and
1431 * sets up the ncurses menu screen.
1434 struct cui *cui_init(void* platform_info,
1435 int (*js_map)(const struct js_event *e), int start_daemon, int timeout)
1440 cui = talloc_zero(NULL, struct cui);
1442 pb_log("%s: alloc cui failed.\n", __func__);
1443 fprintf(stderr, _("%s: alloc cui failed.\n"), __func__);
1447 cui->c_sig = pb_cui_sig;
1448 cui->platform_info = platform_info;
1449 cui->waitset = waitset_create(cui);
1450 cui->statuslog = statuslog_init(cui);
1452 process_init(cui, cui->waitset, false);
1454 /* Loop here for scripts that just started the server. */
1457 for (i = start_daemon ? 2 : 15; i && timeout; i--) {
1458 cui->client = discover_client_init(cui->waitset,
1459 &cui_client_ops, cui);
1460 if (cui->client || !i)
1462 pb_log("%s: waiting for server %d\n", __func__, i);
1466 if (!cui->client && start_daemon) {
1471 result = pb_start_daemon(cui);
1476 pb_log("%s: discover_client_init failed.\n", __func__);
1477 fprintf(stderr, _("%s: error: discover_client_init failed.\n"),
1479 fprintf(stderr, _("could not start pb-discover, the petitboot "
1481 goto fail_client_init;
1484 if (!cui->client && !timeout) {
1485 /* Have the first timeout fire immediately so we can check
1486 * for the server as soon as the UI is ready */
1487 waiter_register_timeout(cui->waitset, 0,
1488 cui_server_wait, cui);
1489 } else if (!cui->client) {
1490 pb_log("%s: discover_client_init failed.\n", __func__);
1491 fprintf(stderr, _("%s: error: discover_client_init failed.\n"),
1493 fprintf(stderr, _("check that pb-discover, "
1494 "the petitboot daemon is running.\n"));
1495 goto fail_client_init;
1499 talloc_steal(cui, cui->client);
1502 cui->main = main_menu_init(cui);
1504 goto fail_client_init;
1506 cui->plugin_menu = plugin_menu_init(cui);
1507 if (!cui->plugin_menu)
1508 goto fail_client_init;
1510 waiter_register_io(cui->waitset, STDIN_FILENO, WAIT_IN,
1511 cui_process_key, cui);
1515 cui->pjs = pjs_init(cui, js_map);
1518 waiter_register_io(cui->waitset, pjs_get_fd(cui->pjs),
1519 WAIT_IN, cui_process_js, cui);
1531 * cui_cancel_autoboot_on_exit - On exit spin until the server is available.
1533 * If the program exits before connecting to the server autoboot won't be
1534 * cancelled even though there has been keyboard activity. A child is forked
1535 * which will spin until the server is connected and told to cancel autoboot.
1537 static void cui_cancel_autoboot_on_exit(struct cui *cui)
1542 /* Fork a child to tell the server to cancel autoboot */
1545 cui_detached = true;
1547 /* Loop until connection established */
1548 while (!cui->client) {
1549 cui->client = discover_client_init(cui->waitset,
1550 &cui_client_ops, cui);
1555 talloc_steal(cui, cui->client);
1556 discover_client_cancel_default(cui->client);
1560 pb_log("Failed to fork child on exit: %m\n");
1562 discover_client_cancel_default(cui->client);
1566 * cui_run - The main cui program loop.
1567 * @cui: The cui instance.
1568 * @main: The menu to use as the main menu.
1570 * Runs the cui engine. Does not return until indicated to do so by some
1571 * user action, or an error occurs. Frees the cui object on return.
1572 * Returns 0 on success (return to shell), -1 on error (should restart).
1575 int cui_run(struct cui *cui)
1579 cui->current = &cui->main->scr;
1580 cui->default_item = 0;
1582 nc_scr_post(cui->current);
1585 int result = waiter_poll(cui->waitset);
1588 pb_log("%s: poll: %s\n", __func__, strerror(errno));
1595 while (cui->resize) {
1597 cui_handle_resize(cui);
1601 cui_cancel_autoboot_on_exit(cui);
1605 return cui->abort ? 0 : -1;