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)
27 #include <sys/ioctl.h>
28 #include <sys/reboot.h>
31 #include "pb-protocol/pb-protocol.h"
32 #include "talloc/talloc.h"
33 #include "waiter/waiter.h"
34 #include "process/process.h"
35 #include "i18n/i18n.h"
36 #include "ui/common/discover-client.h"
37 #include "ui/common/ui-system.h"
39 #include "nc-boot-editor.h"
40 #include "nc-config.h"
41 #include "nc-add-url.h"
42 #include "nc-sysinfo.h"
44 #include "nc-helpscreen.h"
45 #include "nc-statuslog.h"
46 #include "nc-subset.h"
47 #include "nc-plugin.h"
49 extern const struct help_text main_menu_help_text;
50 extern const struct help_text plugin_menu_help_text;
52 static bool cui_detached = false;
54 static struct pmenu *main_menu_init(struct cui *cui);
55 static struct pmenu *plugin_menu_init(struct cui *cui);
57 static bool lockdown_active(void)
59 bool lockdown = false;
60 if (access(LOCKDOWN_FILE, F_OK) != -1)
65 static void cui_start(void)
67 initscr(); /* Initialize ncurses. */
68 cbreak(); /* Disable line buffering. */
69 noecho(); /* Disable getch() echo. */
70 keypad(stdscr, TRUE); /* Enable num keypad keys. */
71 nonl(); /* Disable new-line translation. */
72 intrflush(stdscr, FALSE); /* Disable interrupt flush. */
73 curs_set(0); /* Make cursor invisible */
74 nodelay(stdscr, TRUE); /* Enable non-blocking getch() */
76 /* We may be operating with an incorrect $TERM type; in this case
77 * the keymappings will be slightly broken. We want at least
78 * backspace to work though, so we'll define both DEL and ^H to
80 define_key("\x7f", KEY_BACKSPACE);
81 define_key("\x08", KEY_BACKSPACE);
83 /* we need backtab too, for form navigation. vt220 doesn't include
84 * this (kcbt), but we don't want to require a full linux/xterm termcap
86 define_key("\x1b[Z", KEY_BTAB);
88 /* We'll define a few other keys too since they're commonly
89 * used for navigation but the escape character will cause
90 * Petitboot to exit if they're left undefined */
91 define_key("\x1b\x5b\x35\x7e", KEY_PPAGE);
92 define_key("\x1b\x5b\x36\x7e", KEY_NPAGE);
93 define_key("\x1b\x5b\x31\x7e", KEY_HOME);
94 define_key("\x1b\x5b\x34\x7e", KEY_END);
95 define_key("\x1b\x4f\x48", KEY_HOME);
96 define_key("\x1b\x4f\x46", KEY_END);
97 define_key("OH", KEY_HOME);
98 define_key("OF", KEY_END);
99 define_key("\x1b\x5b\x41", KEY_UP);
100 define_key("\x1b\x5b\x42", KEY_DOWN);
101 define_key("\x1b\x5b\x33\x7e", KEY_DC);
103 while (getch() != ERR) /* flush stdin */
107 static void cui_atexit(void)
116 bool lockdown = lockdown_active();
125 * cui_abort - Signal the main cui program loop to exit.
127 * Sets cui.abort, which causes the cui_run() routine to return.
130 void cui_abort(struct cui *cui)
132 pb_log("%s: exiting\n", __func__);
137 * cui_resize - Signal the main cui program loop to resize
139 * Called at SIGWINCH.
142 void cui_resize(struct cui *cui)
144 pb_debug("%s: resizing\n", __func__);
149 * cui_on_exit - A generic main menu exit callback.
152 void cui_on_exit(struct pmenu *menu)
154 struct cui *cui = cui_from_pmenu(menu);
157 sh_cmd = talloc_asprintf(cui,
158 "echo \"Exiting petitboot. Type 'exit' to return.\";\
159 echo \"You may run 'pb-sos' to gather diagnostic data\";\
160 %s", pb_system_apps.sh);
163 pb_log("Failed to allocate shell arguments\n");
167 const char *argv[] = {
174 cui_run_cmd(cui, argv);
176 nc_scr_status_printf(cui->current, _("Returned from shell"));
181 * cui_run_cmd - A generic cb to run the supplied command.
184 int cui_run_cmd(struct cui *cui, const char **cmd_argv)
186 struct process *process;
189 process = process_create(cui);
193 process->path = cmd_argv[0];
194 process->argv = cmd_argv;
195 process->raw_stdout = true;
197 nc_scr_status_printf(cui->current, _("Running %s..."), cmd_argv[0]);
199 nc_scr_unpost(cui->current);
206 result = process_run_sync(process);
211 redrawwin(cui->current->main_ncw);
212 nc_scr_post(cui->current);
215 pb_log("%s: failed: '%s'\n", __func__, cmd_argv[0]);
216 nc_scr_status_printf(cui->current, _("Failed: %s"),
220 process_release(process);
225 int cui_run_cmd_from_item(struct pmenu_item *item)
227 struct cui *cui = cui_from_item(item);
228 const char **cmd_argv = item->data;
230 return cui_run_cmd(cui, cmd_argv);
234 * cui_boot - A generic cb to run kexec.
237 static int cui_boot(struct pmenu_item *item)
240 struct cui *cui = cui_from_item(item);
241 struct cui_opt_data *cod = cod_from_item(item);
243 assert(cui->current == &cui->main->scr);
245 pb_debug("%s: %s\n", __func__, cod->name);
247 nc_scr_status_printf(cui->current, _("Booting %s..."), cod->name);
249 result = discover_client_boot(cui->client, NULL, cod->opt, cod->bd);
252 nc_scr_status_printf(cui->current,
253 _("Failed: boot %s"), cod->bd->image);
259 static void cui_boot_editor_on_exit(struct cui *cui,
260 struct pmenu_item *item,
261 struct pb_boot_data *bd)
263 struct pmenu *menu = cui->main;
264 struct cui_opt_data *cod;
265 int idx, top, rows, cols;
266 static int user_idx = 0;
268 /* Was the edit cancelled? */
270 cui_set_current(cui, &cui->main->scr);
271 talloc_free(cui->boot_editor);
272 cui->boot_editor = NULL;
276 /* Is this was a new item, we'll need to update the menu */
280 cod = talloc_zero(NULL, struct cui_opt_data);
281 cod->name = talloc_asprintf(cod, _("User item %u"), ++user_idx);
283 item = pmenu_item_create(menu, cod->name);
289 item->on_edit = cui_item_edit;
290 item->on_execute = cui_boot;
293 talloc_steal(item, cod);
295 /* Detach the items array. */
296 set_menu_items(menu->ncm, NULL);
298 /* Insert new item at insert_pt. */
299 insert_pt = pmenu_grow(menu, 1);
300 pmenu_item_insert(menu, item, insert_pt);
302 /* Re-attach the items array. */
303 set_menu_items(menu->ncm, menu->items);
305 /* If our index is above the current top row, align
306 * us to the new top. Otherwise, align us to the new
308 menu_format(cui->main->ncm, &rows, &cols);
309 top = top_row(cui->main->ncm);
310 idx = item_index(item->nci);
315 top = idx < rows ? 0 : idx - rows + 1;
317 set_top_row(cui->main->ncm, top);
318 set_current_item(item->pmenu->ncm, item->nci);
320 nc_scr_post(&menu->scr);
325 cod->bd = talloc_steal(cod, bd);
328 cui_set_current(cui, &cui->main->scr);
329 talloc_free(cui->boot_editor);
330 cui->boot_editor = NULL;
333 void cui_item_edit(struct pmenu_item *item)
335 struct cui *cui = cui_from_item(item);
336 cui->boot_editor = boot_editor_init(cui, item, cui->sysinfo,
337 cui_boot_editor_on_exit);
338 cui_set_current(cui, boot_editor_scr(cui->boot_editor));
341 void cui_item_new(struct pmenu *menu)
343 struct cui *cui = cui_from_pmenu(menu);
344 cui->boot_editor = boot_editor_init(cui, NULL, cui->sysinfo,
345 cui_boot_editor_on_exit);
346 cui_set_current(cui, boot_editor_scr(cui->boot_editor));
349 static void cui_sysinfo_exit(struct cui *cui)
351 cui_set_current(cui, &cui->main->scr);
352 talloc_free(cui->sysinfo_screen);
353 cui->sysinfo_screen = NULL;
356 void cui_show_sysinfo(struct cui *cui)
358 cui->sysinfo_screen = sysinfo_screen_init(cui, cui->sysinfo,
360 cui_set_current(cui, sysinfo_screen_scr(cui->sysinfo_screen));
363 static void cui_config_exit(struct cui *cui)
365 cui_set_current(cui, &cui->main->scr);
366 talloc_free(cui->config_screen);
367 cui->config_screen = NULL;
370 void cui_show_config(struct cui *cui)
372 cui->config_screen = config_screen_init(cui, cui->config,
373 cui->sysinfo, cui_config_exit);
374 cui_set_current(cui, config_screen_scr(cui->config_screen));
377 static void cui_lang_exit(struct cui *cui)
379 cui_set_current(cui, &cui->main->scr);
380 talloc_free(cui->lang_screen);
381 cui->lang_screen = NULL;
384 void cui_show_lang(struct cui *cui)
386 cui->lang_screen = lang_screen_init(cui, cui->config, cui_lang_exit);
387 cui_set_current(cui, lang_screen_scr(cui->lang_screen));
390 static void cui_statuslog_exit(struct cui *cui)
392 cui_set_current(cui, &cui->main->scr);
393 talloc_free(cui->statuslog_screen);
394 cui->statuslog_screen = NULL;
397 void cui_show_statuslog(struct cui *cui)
399 cui->statuslog_screen = statuslog_screen_init(cui, cui_statuslog_exit);
400 cui_set_current(cui, statuslog_screen_scr(cui->statuslog_screen));
403 static void cui_add_url_exit(struct cui *cui)
405 cui_set_current(cui, &cui->main->scr);
406 talloc_free(cui->add_url_screen);
407 cui->add_url_screen = NULL;
410 static void cui_plugin_exit(struct cui *cui)
412 cui_set_current(cui, &cui->plugin_menu->scr);
413 talloc_free(cui->plugin_screen);
414 cui->plugin_screen = NULL;
417 static void cui_plugin_menu_exit(struct pmenu *menu)
419 struct cui *cui = cui_from_pmenu(menu);
420 cui_set_current(cui, &cui->main->scr);
423 void cui_show_add_url(struct cui *cui)
425 cui->add_url_screen = add_url_screen_init(cui, cui_add_url_exit);
426 cui_set_current(cui, add_url_screen_scr(cui->add_url_screen));
429 void cui_show_plugin_menu(struct cui *cui)
431 cui_set_current(cui, &cui->plugin_menu->scr);
434 void cui_show_plugin(struct pmenu_item *item)
436 struct cui *cui = cui_from_item(item);
437 cui->plugin_screen = plugin_screen_init(cui, item, cui_plugin_exit);
438 cui_set_current(cui, plugin_screen_scr(cui->plugin_screen));
441 static void cui_help_exit(struct cui *cui)
443 cui_set_current(cui, help_screen_return_scr(cui->help_screen));
444 talloc_free(cui->help_screen);
445 cui->help_screen = NULL;
448 void cui_show_help(struct cui *cui, const char *title,
449 const struct help_text *text)
454 if (cui->help_screen)
457 cui->help_screen = help_screen_init(cui, cui->current,
458 title, text, cui_help_exit);
460 if (cui->help_screen)
461 cui_set_current(cui, help_screen_scr(cui->help_screen));
464 static void cui_subset_exit(struct cui *cui)
466 cui_set_current(cui, subset_screen_return_scr(cui->subset_screen));
467 talloc_free(cui->subset_screen);
468 cui->subset_screen = NULL;
471 void cui_show_subset(struct cui *cui, const char *title,
477 if (cui->subset_screen)
480 cui->subset_screen = subset_screen_init(cui, cui->current,
481 title, arg, cui_subset_exit);
483 if (cui->subset_screen)
484 cui_set_current(cui, subset_screen_scr(cui->subset_screen));
488 * cui_set_current - Set the currently active screen and redraw it.
491 struct nc_scr *cui_set_current(struct cui *cui, struct nc_scr *scr)
495 DBGS("%p -> %p\n", cui->current, scr);
497 assert(cui->current != scr);
504 nc_scr_post(cui->current);
509 static bool process_global_keys(struct cui *cui, int key)
513 if (cui->current && cui->current->main_ncw)
521 * cui_process_key - Process input on stdin.
524 static int cui_process_key(void *arg)
526 struct cui *cui = cui_from_arg(arg);
528 assert(cui->current);
533 pb_debug("%s: got key %d\n", __func__, c);
538 if (!cui->has_input) {
539 cui->has_input = true;
541 pb_log("UI input received (key = %d), aborting "
542 "default boot\n", c);
543 discover_client_cancel_default(cui->client);
545 pb_log("UI input received (key = %d), aborting "
546 "once server connects\n", c);
550 if (process_global_keys(cui, c))
553 cui->current->process_key(cui->current, c);
560 * cui_process_js - Process joystick events.
563 static int cui_process_js(void *arg)
565 struct cui *cui = cui_from_arg(arg);
568 c = pjs_process_event(cui->pjs);
572 cui_process_key(arg);
579 * cui_handle_resize - Handle the term resize.
582 static void cui_handle_resize(struct cui *cui)
586 if (ioctl(1, TIOCGWINSZ, &ws) == -1) {
587 pb_log("%s: ioctl failed: %s\n", __func__, strerror(errno));
591 pb_debug("%s: {%u,%u}\n", __func__, ws.ws_row, ws.ws_col);
593 wclear(cui->current->main_ncw);
594 resize_term(ws.ws_row, ws.ws_col);
595 cui->current->resize(cui->current);
597 /* For some reason this makes ncurses redraw the screen */
599 redrawwin(cui->current->main_ncw);
600 wrefresh(cui->current->main_ncw);
604 * cui_device_add - Client device_add callback.
606 * Creates menu_items for all the device boot_options and inserts those
607 * menu_items into the main menu. Redraws the main menu if it is active.
608 * If a 'plugin' type boot_option appears the plugin menu is updated instead.
611 static int cui_boot_option_add(struct device *dev, struct boot_option *opt,
614 struct pmenu_item *i, *dev_hdr = NULL;
615 struct cui *cui = cui_from_arg(arg);
616 struct cui_opt_data *cod;
617 const char *tab = " ";
618 unsigned int insert_pt;
619 int result, rows, cols;
625 plugin_option = opt->type == DISCOVER_PLUGIN_OPTION;
626 menu = plugin_option ? cui->plugin_menu : cui->main;
628 pb_debug("%s: %p %s\n", __func__, opt, opt->id);
630 selected = current_item(menu->ncm);
631 menu_format(menu->ncm, &rows, &cols);
633 if (cui->current == &cui->main->scr)
634 nc_scr_unpost(cui->current);
635 if (plugin_option && cui->current == &cui->plugin_menu->scr)
636 nc_scr_unpost(cui->current);
638 /* Check if the boot device is new */
639 dev_hdr = pmenu_find_device(menu, dev, opt);
641 /* All actual boot entries are 'tabbed' across */
642 name = talloc_asprintf(menu, "%s%s",
643 tab, opt->name ? : "Unknown Name");
645 /* Save the item in opt->ui_info for cui_device_remove() */
646 opt->ui_info = i = pmenu_item_create(menu, name);
653 i->on_execute = plugin_install_plugin;
655 i->on_edit = cui_item_edit;
656 i->on_execute = cui_boot;
659 i->data = cod = talloc(i, struct cui_opt_data);
662 cod->opt_hash = pb_opt_hash(dev, opt);
663 cod->name = opt->name;
666 cod->pd = talloc(i, struct pb_plugin_data);
667 cod->pd->plugin_file = talloc_strdup(cod,
668 opt->boot_image_file);
670 cod->bd = talloc(i, struct pb_boot_data);
671 cod->bd->image = talloc_strdup(cod->bd, opt->boot_image_file);
672 cod->bd->initrd = talloc_strdup(cod->bd, opt->initrd_file);
673 cod->bd->dtb = talloc_strdup(cod->bd, opt->dtb_file);
674 cod->bd->args = talloc_strdup(cod->bd, opt->boot_args);
675 cod->bd->args_sig_file = talloc_strdup(cod->bd, opt->args_sig_file);
678 /* This disconnects items array from menu. */
679 result = set_menu_items(menu->ncm, NULL);
682 pb_log("%s: set_menu_items failed: %d\n", __func__, result);
684 /* Insert new items at insert_pt. */
686 insert_pt = pmenu_grow(menu, 2);
687 pmenu_item_insert(menu, dev_hdr, insert_pt);
688 pb_log("%s: adding new device hierarchy %s\n",
689 __func__, opt->device_id);
690 pmenu_item_insert(menu, i, insert_pt+1);
692 insert_pt = pmenu_grow(menu, 1);
693 pmenu_item_add(menu, i, insert_pt);
697 pb_log("%s: adding plugin '%s'\n", __func__, cod->name);
698 pb_log(" file '%s'\n", cod->pd->plugin_file);
700 pb_log("%s: adding opt '%s'\n", __func__, cod->name);
701 pb_log(" image '%s'\n", cod->bd->image);
702 pb_log(" initrd '%s'\n", cod->bd->initrd);
703 pb_log(" args '%s'\n", cod->bd->args);
704 pb_log(" argsig '%s'\n", cod->bd->args_sig_file);
707 /* Update the plugin menu label if needed */
709 struct pmenu_item *item;
711 result = set_menu_items(cui->main->ncm, NULL);
712 for (j = 0 ; j < cui->main->item_count; j++) {
713 item = item_userptr(cui->main->items[j]);
714 if (strncmp(item->nci->name.str, "Plugins", strlen("Plugins")))
717 char *label = talloc_asprintf(item, "Plugins (%u)",
719 pmenu_item_update(item, label);
723 result = set_menu_items(cui->main->ncm, cui->main->items);
725 pb_log("%s: set_menu_items failed: %d\n", __func__, result);
728 /* Re-attach the items array. */
729 result = set_menu_items(menu->ncm, menu->items);
732 pb_log("%s: set_menu_items failed: %d\n", __func__, result);
735 pb_log("%s\n", __func__);
736 pmenu_dump_items(menu->items,
737 item_count(menu->ncm) + 1);
740 if (!item_visible(selected)) {
743 top = top_row(menu->ncm);
744 idx = item_index(selected);
746 /* If our index is above the current top row, align
747 * us to the new top. Otherwise, align us to the new
749 top = top < idx ? idx - rows + 1 : idx;
751 set_top_row(menu->ncm, top);
752 set_current_item(menu->ncm, selected);
755 if (cui->current == &menu->scr)
756 nc_scr_post(cui->current);
757 if (plugin_option && cui->current == &cui->main->scr)
758 nc_scr_post(cui->current);
764 * cui_device_remove - Client device remove callback.
766 * Removes all the menu_items for the device from the main menu and redraws the
767 * main menu if it is active.
769 static void cui_device_remove(struct device *dev, void *arg)
771 struct cui *cui = cui_from_arg(arg);
772 struct boot_option *opt;
774 int rows, cols, top, last;
777 pb_log("%s: %p %s\n", __func__, dev, dev->id);
779 if (cui->current == &cui->main->scr)
780 nc_scr_unpost(cui->current);
781 if (cui->current == &cui->plugin_menu->scr)
782 nc_scr_unpost(cui->current);
784 /* This disconnects items array from menu. */
786 result = set_menu_items(cui->main->ncm, NULL);
787 result |= set_menu_items(cui->plugin_menu->ncm, NULL);
790 pb_log("%s: set_menu_items failed: %d\n", __func__, result);
792 list_for_each_entry(&dev->boot_options, opt, list) {
793 struct pmenu_item *item = pmenu_item_from_arg(opt->ui_info);
795 assert(pb_protocol_device_cmp(dev, cod_from_item(item)->dev));
796 if (opt->type == DISCOVER_PLUGIN_OPTION)
797 pmenu_remove(cui->plugin_menu, item);
799 pmenu_remove(cui->main, item);
802 /* Manually remove remaining device hierarchy item */
803 for (i=0; i < cui->main->item_count; i++) {
804 struct pmenu_item *item = item_userptr(cui->main->items[i]);
805 if (!item || !item->data )
808 struct cui_opt_data *data = item->data;
809 if (data && data->dev && data->dev == dev)
810 pmenu_remove(cui->main,item);
812 /* Look in plugins menu too */
813 for (i=0; i < cui->plugin_menu->item_count; i++) {
814 struct pmenu_item *item = item_userptr(cui->plugin_menu->items[i]);
815 if (!item || !item->data )
818 struct cui_opt_data *data = item->data;
819 if (data && data->dev && data->dev == dev)
820 pmenu_remove(cui->plugin_menu,item);
823 /* Re-attach the items array. */
825 result = set_menu_items(cui->main->ncm, cui->main->items);
826 result |= set_menu_items(cui->plugin_menu->ncm, cui->plugin_menu->items);
828 /* Move cursor to 'Exit' menu entry for the main menu.. */
829 menu_format(cui->main->ncm, &rows, &cols);
830 last = cui->main->item_count - 1;
831 set_current_item(cui->main->ncm, cui->main->items[last]);
832 if (!item_visible(cui->main->items[last])) {
833 top = last < rows ? 0 : last - rows + 1;
834 set_top_row(cui->main->ncm, top);
837 /* ..and the plugin menu */
838 menu_format(cui->plugin_menu->ncm, &rows, &cols);
839 last = cui->plugin_menu->item_count - 1;
840 set_current_item(cui->plugin_menu->ncm, cui->plugin_menu->items[last]);
841 if (!item_visible(cui->plugin_menu->items[last])) {
842 top = last < rows ? 0 : last - rows + 1;
843 set_top_row(cui->plugin_menu->ncm, top);
847 pb_log("%s: set_menu_items failed: %d\n", __func__, result);
850 pb_log("%s\n", __func__);
851 pmenu_dump_items(cui->main->items,
852 item_count(cui->main->ncm) + 1);
855 if (cui->current == &cui->main->scr)
856 nc_scr_post(cui->current);
857 if (cui->current == &cui->plugin_menu->scr)
858 nc_scr_post(cui->current);
861 static void cui_update_status(struct status *status, void *arg)
863 struct cui *cui = cui_from_arg(arg);
865 statuslog_append_steal(cui, cui->statuslog, status);
867 /* Ignore status messages from the backlog */
868 if (!status->backlog)
869 nc_scr_status_printf(cui->current, "%s", status->message);
873 * Handle a new installed plugin option and update its associated
874 * (uninstalled) menu item if it exists.
876 static int cui_plugin_option_add(struct plugin_option *opt, void *arg)
878 struct cui_opt_data *cod;
879 struct cui *cui = cui_from_arg(arg);
880 struct pmenu_item *item = NULL;
881 struct boot_option *dummy_opt;
887 /* Find uninstalled plugin by matching on plugin_file */
888 for (i = 0; i < cui->plugin_menu->item_count; i++) {
889 item = item_userptr(cui->plugin_menu->items[i]);
892 cod = cod_from_item(item);
893 if (!cod || !cod->pd)
895 if (strncmp(cod->pd->plugin_file, opt->plugin_file,
896 strlen(cod->pd->plugin_file)) == 0)
901 * If pb-plugin was run manually there may not be an associated
902 * plugin-type boot_option. Pass a fake device and option to
903 * cui_boot_option_add() so we have an item to work with.
905 if (!item || i >= cui->plugin_menu->item_count) {
906 pb_log("New plugin option %s doesn't have a source item\n",
908 dev = talloc_zero(cui, struct device);
909 dev->id = dev->name = talloc_asprintf(dev, "(unknown)");
910 dev->type = DEVICE_TYPE_UNKNOWN;
911 dummy_opt = talloc_zero(cui, struct boot_option);
912 dummy_opt->device_id = talloc_strdup(dummy_opt, dev->id);
913 dummy_opt->id = dummy_opt->name = talloc_asprintf(dummy_opt, "dummy");
914 dummy_opt->boot_image_file = talloc_strdup(dummy_opt, opt->plugin_file);
915 dummy_opt->type = DISCOVER_PLUGIN_OPTION;
916 cui_boot_option_add(dev, dummy_opt, cui);
921 * If this option was faked above move the context under
922 * the item so it is cleaned up later in cui_plugins_remove().
924 if (strncmp(cod->opt->id, "dummy", strlen("dummy") == 0 &&
925 cod->dev->type == DEVICE_TYPE_UNKNOWN)) {
926 talloc_steal(item, cod->dev);
927 talloc_steal(item, cod->opt);
930 talloc_free(cod->name);
931 /* Name is still tabbed across */
932 cod->name = talloc_asprintf(cod, _(" %s [installed]"), opt->name);
935 item->on_execute = NULL;
936 item->on_edit = cui_show_plugin;
938 if (cui->current == &cui->plugin_menu->scr)
939 nc_scr_unpost(cui->current);
941 /* This disconnects items array from menu. */
942 result = set_menu_items(cui->plugin_menu->ncm, NULL);
945 pmenu_item_update(item, cod->name);
947 /* Re-attach the items array. */
948 result = set_menu_items(cui->plugin_menu->ncm, cui->plugin_menu->items);
950 if (cui->current == &cui->plugin_menu->scr)
951 nc_scr_post(cui->current);
957 * Most plugin menu items will be removed via cui_device_remove(). However if
958 * pb-plugin has been run manually it is possible that there a plugin items
959 * not associated with a device - remove them here.
961 static int cui_plugins_remove(void *arg)
963 struct cui *cui = cui_from_arg(arg);
964 struct pmenu_item *item = NULL;
965 struct cui_opt_data *cod;
968 pb_debug("%s\n", __func__);
970 if (cui->current == &cui->plugin_menu->scr)
971 nc_scr_unpost(cui->current);
972 if (cui->current == &cui->main->scr)
973 nc_scr_unpost(cui->current);
975 /* This disconnects items array from menu. */
976 set_menu_items(cui->plugin_menu->ncm, NULL);
978 while (i < cui->plugin_menu->item_count) {
979 item = item_userptr(cui->plugin_menu->items[i]);
980 if (!item || !item->data) {
984 cod = cod_from_item(item);
985 if (!cod->opt && !cod->dev) {
990 pmenu_remove(cui->plugin_menu, item);
991 /* plugin_menu entries will shift, jump to bottom to make sure
992 * we remove all plugin option items */
996 /* Re-attach the items array. */
997 set_menu_items(cui->plugin_menu->ncm, cui->plugin_menu->items);
999 set_menu_items(cui->main->ncm, NULL);
1000 for (i = 0; i < cui->main->item_count; i++) {
1001 item = item_userptr(cui->main->items[i]);
1002 if (strncmp(item->nci->name.str, "Plugins", strlen("Plugins")))
1005 pmenu_item_update(item, "Plugins (0)");
1009 set_menu_items(cui->main->ncm, cui->main->items);
1011 if (cui->current == &cui->main->scr)
1012 nc_scr_post(cui->current);
1014 /* If we're currently in a plugin screen jump back to the plugin menu */
1015 if (cui->plugin_screen &&
1016 cui->current == plugin_screen_scr(cui->plugin_screen))
1017 cui_plugin_exit(cui);
1022 static void cui_update_mm_title(struct cui *cui)
1024 struct nc_frame *frame = &cui->main->scr.frame;
1026 talloc_free(frame->rtitle);
1028 frame->rtitle = talloc_strdup(cui->main, cui->sysinfo->type);
1029 if (cui->sysinfo->identifier)
1030 frame->rtitle = talloc_asprintf_append(frame->rtitle,
1031 " %s", cui->sysinfo->identifier);
1033 if (cui->current == &cui->main->scr)
1034 nc_scr_post(cui->current);
1036 frame = &cui->plugin_menu->scr.frame;
1038 talloc_free(frame->rtitle);
1040 frame->rtitle = talloc_strdup(cui->main, cui->sysinfo->type);
1041 if (cui->sysinfo->identifier)
1042 frame->rtitle = talloc_asprintf_append(frame->rtitle,
1043 " %s", cui->sysinfo->identifier);
1045 if (cui->current == &cui->main->scr)
1046 nc_scr_post(cui->current);
1049 static void cui_update_sysinfo(struct system_info *sysinfo, void *arg)
1051 struct cui *cui = cui_from_arg(arg);
1052 cui->sysinfo = talloc_steal(cui, sysinfo);
1054 /* if we're currently displaying the system info screen, inform it
1055 * of the updated information. */
1056 if (cui->sysinfo_screen)
1057 sysinfo_screen_update(cui->sysinfo_screen, sysinfo);
1059 if (cui->subset_screen)
1060 subset_screen_update(cui->subset_screen);
1062 /* ... and do the same with the config screen... */
1063 if (cui->config_screen)
1064 config_screen_update(cui->config_screen, cui->config, sysinfo);
1066 /* ... and the boot editor. */
1067 if (cui->boot_editor)
1068 boot_editor_update(cui->boot_editor, sysinfo);
1070 cui_update_mm_title(cui);
1073 static void cui_update_language(struct cui *cui, char *lang)
1078 cur_lang = setlocale(LC_ALL, NULL);
1079 if (cur_lang && !strcmp(cur_lang, lang))
1082 setlocale(LC_ALL, lang);
1084 /* we'll need to update the menu: drop all items and repopulate */
1085 repost_menu = cui->current == &cui->main->scr ||
1086 cui->current == &cui->plugin_menu->scr;
1088 nc_scr_unpost(cui->current);
1090 talloc_free(cui->main);
1091 cui->main = main_menu_init(cui);
1092 cui->plugin_menu = plugin_menu_init(cui);
1095 cui->current = &cui->main->scr;
1096 nc_scr_post(cui->current);
1099 discover_client_enumerate(cui->client);
1102 static void cui_update_config(struct config *config, void *arg)
1104 struct cui *cui = cui_from_arg(arg);
1105 cui->config = talloc_steal(cui, config);
1108 cui_update_language(cui, config->lang);
1110 if (cui->subset_screen)
1111 subset_screen_update(cui->subset_screen);
1113 if (cui->config_screen)
1114 config_screen_update(cui->config_screen, config, cui->sysinfo);
1116 if (config->safe_mode)
1117 nc_scr_status_printf(cui->current,
1118 _("SAFE MODE: select '%s' to continue"),
1119 _("Rescan devices"));
1122 int cui_send_config(struct cui *cui, struct config *config)
1124 return discover_client_send_config(cui->client, config);
1127 int cui_send_url(struct cui *cui, char * url)
1129 return discover_client_send_url(cui->client, url);
1132 int cui_send_plugin_install(struct cui *cui, char *file)
1134 return discover_client_send_plugin_install(cui->client, file);
1137 void cui_send_reinit(struct cui *cui)
1139 discover_client_send_reinit(cui->client);
1142 static int menu_sysinfo_execute(struct pmenu_item *item)
1144 cui_show_sysinfo(cui_from_item(item));
1148 static int menu_config_execute(struct pmenu_item *item)
1150 cui_show_config(cui_from_item(item));
1154 static int menu_lang_execute(struct pmenu_item *item)
1156 cui_show_lang(cui_from_item(item));
1160 static int menu_statuslog_execute(struct pmenu_item *item)
1162 cui_show_statuslog(cui_from_item(item));
1166 static int menu_reinit_execute(struct pmenu_item *item)
1168 if (cui_from_item(item)->client)
1169 cui_send_reinit(cui_from_item(item));
1173 static int menu_add_url_execute(struct pmenu_item *item)
1175 if (cui_from_item(item)->client)
1176 cui_show_add_url(cui_from_item(item));
1180 static int menu_plugin_execute(struct pmenu_item *item)
1182 if (cui_from_item(item)->client)
1183 cui_show_plugin_menu(cui_from_item(item));
1188 * pb_mm_init - Setup the main menu instance.
1190 static struct pmenu *main_menu_init(struct cui *cui)
1192 struct pmenu_item *i;
1195 bool lockdown = lockdown_active();
1197 m = pmenu_init(cui, 9, cui_on_exit);
1199 pb_log("%s: failed\n", __func__);
1203 m->on_new = cui_item_new;
1205 m->scr.frame.ltitle = talloc_asprintf(m,
1206 "Petitboot (" PACKAGE_VERSION ")");
1207 m->scr.frame.rtitle = NULL;
1208 m->scr.frame.help = talloc_strdup(m,
1209 _("Enter=accept, e=edit, n=new, x=exit, l=language, g=log, h=help"));
1210 m->scr.frame.status = talloc_strdup(m, _("Welcome to Petitboot"));
1212 /* add a separator */
1213 i = pmenu_item_create(m, " ");
1214 item_opts_off(i->nci, O_SELECTABLE);
1215 pmenu_item_insert(m, i, 0);
1217 /* add system items */
1218 i = pmenu_item_create(m, _("System information"));
1219 i->on_execute = menu_sysinfo_execute;
1220 pmenu_item_insert(m, i, 1);
1222 i = pmenu_item_create(m, _("System configuration"));
1223 i->on_execute = menu_config_execute;
1224 pmenu_item_insert(m, i, 2);
1226 i = pmenu_item_create(m, _("System status log"));
1227 i->on_execute = menu_statuslog_execute;
1228 pmenu_item_insert(m, i, 3);
1230 /* this label isn't translated, so we don't want a gettext() here */
1231 i = pmenu_item_create(m, "Language");
1232 i->on_execute = menu_lang_execute;
1233 pmenu_item_insert(m, i, 4);
1235 i = pmenu_item_create(m, _("Rescan devices"));
1236 i->on_execute = menu_reinit_execute;
1237 pmenu_item_insert(m, i, 5);
1239 i = pmenu_item_create(m, _("Retrieve config from URL"));
1240 i->on_execute = menu_add_url_execute;
1241 pmenu_item_insert(m, i, 6);
1243 i = pmenu_item_create(m, _("Plugins (0)"));
1244 i->on_execute = menu_plugin_execute;
1245 pmenu_item_insert(m, i, 7);
1248 i = pmenu_item_create(m, _("Reboot"));
1250 i = pmenu_item_create(m, _("Exit to shell"));
1251 i->on_execute = pmenu_exit_cb;
1252 pmenu_item_insert(m, i, 8);
1254 result = pmenu_setup(m);
1257 pb_log("%s:%d: pmenu_setup failed: %s\n", __func__, __LINE__,
1262 m->help_title = _("main menu");
1263 m->help_text = &main_menu_help_text;
1265 menu_opts_off(m->ncm, O_SHOWDESC);
1266 set_menu_mark(m->ncm, " *");
1267 set_current_item(m->ncm, i->nci);
1277 * plugin_menu_init: Set up the plugin menu instance
1279 static struct pmenu *plugin_menu_init(struct cui *cui)
1281 struct pmenu_item *i;
1285 m = pmenu_init(cui, 2, cui_plugin_menu_exit);
1286 m->on_new = cui_item_new;
1287 m->scr.frame.ltitle = talloc_asprintf(m, _("Petitboot Plugins"));
1288 m->scr.frame.rtitle = talloc_asprintf(m, NULL);
1289 m->scr.frame.help = talloc_strdup(m,
1290 _("Enter=install, e=details, x=exit, h=help"));
1291 m->scr.frame.status = talloc_asprintf(m,
1292 _("Available Petitboot Plugins"));
1294 /* add a separator */
1295 i = pmenu_item_create(m, " ");
1296 item_opts_off(i->nci, O_SELECTABLE);
1297 pmenu_item_insert(m, i, 0);
1299 i = pmenu_item_create(m, _("Return to Main Menu"));
1300 i->on_execute = pmenu_exit_cb;
1301 pmenu_item_insert(m, i, 1);
1303 result = pmenu_setup(m);
1306 pb_log("%s:%d: pmenu_setup failed: %s\n", __func__, __LINE__,
1311 m->help_title = _("plugin menu");
1312 m->help_text = &plugin_menu_help_text;
1321 static struct discover_client_ops cui_client_ops = {
1323 .boot_option_add = cui_boot_option_add,
1324 .device_remove = cui_device_remove,
1325 .plugin_option_add = cui_plugin_option_add,
1326 .plugins_remove = cui_plugins_remove,
1327 .update_status = cui_update_status,
1328 .update_sysinfo = cui_update_sysinfo,
1329 .update_config = cui_update_config,
1332 /* cui_server_wait_on_exit - On exit spin until the server is available.
1334 * If the program exits before connecting to the server autoboot won't be
1335 * cancelled even though there has been keyboard activity. This function is
1336 * called by a child process which will spin until the server is connected and
1337 * told to cancel autoboot.
1339 * Processes exiting from this function will not carry out the cui_atexit()
1342 static void cui_server_wait_on_exit(struct cui *cui)
1344 cui_detached = true;
1346 while (!cui->client) {
1347 cui->client = discover_client_init(cui->waitset,
1348 &cui_client_ops, cui);
1353 talloc_steal(cui, cui->client);
1354 discover_client_cancel_default(cui->client);
1357 /* cui_server_wait - Connect to the discover server.
1358 * @arg: Pointer to the cui instance.
1360 * A timeout callback that attempts to connect to the discover server; on
1361 * failure it registers itself with a one second timeout to try again.
1362 * On success the cui->client struct will be set.
1364 * Since this updates the status line when called it must not be called
1365 * before the UI is ready.
1367 static int cui_server_wait(void *arg)
1369 struct cui *cui = cui_from_arg(arg);
1372 pb_debug("We already have a server!\n");
1376 /* We haven't yet connected to the server */
1377 pb_log("Trying to connect...\n");
1378 cui->client = discover_client_init(cui->waitset,
1379 &cui_client_ops, cui);
1382 waiter_register_timeout(cui->waitset, 1000, cui_server_wait,
1384 nc_scr_status_printf(cui->current,
1385 "Info: Waiting for device discovery");
1387 nc_scr_status_free(cui->current);
1388 talloc_steal(cui, cui->client);
1390 if (cui->has_input) {
1391 pb_log("Aborting default boot on pb-discover connect\n");
1392 discover_client_cancel_default(cui->client);
1400 * cui_init - Setup the cui instance.
1401 * @platform_info: A value for the struct cui platform_info member.
1403 * Returns a pointer to a struct cui on success, or NULL on error.
1405 * Allocates the cui instance, sets up the client and stdin waiters, and
1406 * sets up the ncurses menu screen.
1409 struct cui *cui_init(void* platform_info,
1410 int (*js_map)(const struct js_event *e), int start_daemon, int timeout)
1415 cui = talloc_zero(NULL, struct cui);
1417 pb_log("%s: alloc cui failed.\n", __func__);
1418 fprintf(stderr, _("%s: alloc cui failed.\n"), __func__);
1422 cui->c_sig = pb_cui_sig;
1423 cui->platform_info = platform_info;
1424 cui->waitset = waitset_create(cui);
1425 cui->statuslog = statuslog_init(cui);
1427 process_init(cui, cui->waitset, false);
1429 /* Loop here for scripts that just started the server. */
1432 for (i = start_daemon ? 2 : 15; i && timeout; i--) {
1433 cui->client = discover_client_init(cui->waitset,
1434 &cui_client_ops, cui);
1435 if (cui->client || !i)
1437 pb_log("%s: waiting for server %d\n", __func__, i);
1441 if (!cui->client && start_daemon) {
1446 result = pb_start_daemon(cui);
1451 pb_log("%s: discover_client_init failed.\n", __func__);
1452 fprintf(stderr, _("%s: error: discover_client_init failed.\n"),
1454 fprintf(stderr, _("could not start pb-discover, the petitboot "
1456 goto fail_client_init;
1459 if (!cui->client && !timeout) {
1460 /* Have the first timeout fire immediately so we can check
1461 * for the server as soon as the UI is ready */
1462 waiter_register_timeout(cui->waitset, 0,
1463 cui_server_wait, cui);
1464 } else if (!cui->client) {
1465 pb_log("%s: discover_client_init failed.\n", __func__);
1466 fprintf(stderr, _("%s: error: discover_client_init failed.\n"),
1468 fprintf(stderr, _("check that pb-discover, "
1469 "the petitboot daemon is running.\n"));
1470 goto fail_client_init;
1474 talloc_steal(cui, cui->client);
1477 cui->main = main_menu_init(cui);
1479 goto fail_client_init;
1481 cui->plugin_menu = plugin_menu_init(cui);
1482 if (!cui->plugin_menu)
1483 goto fail_client_init;
1485 waiter_register_io(cui->waitset, STDIN_FILENO, WAIT_IN,
1486 cui_process_key, cui);
1490 cui->pjs = pjs_init(cui, js_map);
1493 waiter_register_io(cui->waitset, pjs_get_fd(cui->pjs),
1494 WAIT_IN, cui_process_js, cui);
1506 * cui_run - The main cui program loop.
1507 * @cui: The cui instance.
1508 * @main: The menu to use as the main menu.
1510 * Runs the cui engine. Does not return until indicated to do so by some
1511 * user action, or an error occurs. Frees the cui object on return.
1512 * Returns 0 on success (return to shell), -1 on error (should restart).
1515 int cui_run(struct cui *cui)
1521 cui->current = &cui->main->scr;
1522 cui->default_item = 0;
1524 nc_scr_post(cui->current);
1527 int result = waiter_poll(cui->waitset);
1530 pb_log("%s: poll: %s\n", __func__, strerror(errno));
1537 while (cui->resize) {
1539 cui_handle_resize(cui);
1546 /* Fork a child to tell the server to cancel autoboot */
1549 cui_server_wait_on_exit(cui);
1553 pb_log("Failed to fork child on exit: %m\n");
1556 return cui->abort ? 0 : -1;