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 cui_abort(cui_from_pmenu(menu));
158 * cui_run_cmd - A generic cb to run the supplied command.
161 int cui_run_cmd(struct cui *cui, const char **cmd_argv)
163 struct process *process;
166 process = process_create(cui);
170 process->path = cmd_argv[0];
171 process->argv = cmd_argv;
172 process->raw_stdout = true;
174 nc_scr_status_printf(cui->current, _("Running %s..."), cmd_argv[0]);
179 result = process_run_sync(process);
184 redrawwin(cui->current->main_ncw);
187 pb_log("%s: failed: '%s'\n", __func__, cmd_argv[0]);
188 nc_scr_status_printf(cui->current, _("Failed: %s"),
192 process_release(process);
197 int cui_run_cmd_from_item(struct pmenu_item *item)
199 struct cui *cui = cui_from_item(item);
200 const char **cmd_argv = item->data;
202 return cui_run_cmd(cui, cmd_argv);
206 * cui_boot - A generic cb to run kexec.
209 static int cui_boot(struct pmenu_item *item)
212 struct cui *cui = cui_from_item(item);
213 struct cui_opt_data *cod = cod_from_item(item);
215 assert(cui->current == &cui->main->scr);
217 pb_debug("%s: %s\n", __func__, cod->name);
219 nc_scr_status_printf(cui->current, _("Booting %s..."), cod->name);
221 result = discover_client_boot(cui->client, NULL, cod->opt, cod->bd);
224 nc_scr_status_printf(cui->current,
225 _("Failed: boot %s"), cod->bd->image);
231 static void cui_boot_editor_on_exit(struct cui *cui,
232 struct pmenu_item *item,
233 struct pb_boot_data *bd)
235 struct pmenu *menu = cui->main;
236 struct cui_opt_data *cod;
237 int idx, top, rows, cols;
238 static int user_idx = 0;
240 /* Was the edit cancelled? */
242 cui_set_current(cui, &cui->main->scr);
243 talloc_free(cui->boot_editor);
244 cui->boot_editor = NULL;
248 /* Is this was a new item, we'll need to update the menu */
252 cod = talloc_zero(NULL, struct cui_opt_data);
253 cod->name = talloc_asprintf(cod, _("User item %u"), ++user_idx);
255 item = pmenu_item_create(menu, cod->name);
261 item->on_edit = cui_item_edit;
262 item->on_execute = cui_boot;
265 talloc_steal(item, cod);
267 /* Detach the items array. */
268 set_menu_items(menu->ncm, NULL);
270 /* Insert new item at insert_pt. */
271 insert_pt = pmenu_grow(menu, 1);
272 pmenu_item_insert(menu, item, insert_pt);
274 /* Re-attach the items array. */
275 set_menu_items(menu->ncm, menu->items);
277 /* If our index is above the current top row, align
278 * us to the new top. Otherwise, align us to the new
280 menu_format(cui->main->ncm, &rows, &cols);
281 top = top_row(cui->main->ncm);
282 idx = item_index(item->nci);
287 top = idx < rows ? 0 : idx - rows + 1;
289 set_top_row(cui->main->ncm, top);
290 set_current_item(item->pmenu->ncm, item->nci);
292 nc_scr_post(&menu->scr);
297 cod->bd = talloc_steal(cod, bd);
300 cui_set_current(cui, &cui->main->scr);
301 talloc_free(cui->boot_editor);
302 cui->boot_editor = NULL;
305 void cui_item_edit(struct pmenu_item *item)
307 struct cui *cui = cui_from_item(item);
308 cui->boot_editor = boot_editor_init(cui, item, cui->sysinfo,
309 cui_boot_editor_on_exit);
310 cui_set_current(cui, boot_editor_scr(cui->boot_editor));
313 void cui_item_new(struct pmenu *menu)
315 struct cui *cui = cui_from_pmenu(menu);
316 cui->boot_editor = boot_editor_init(cui, NULL, cui->sysinfo,
317 cui_boot_editor_on_exit);
318 cui_set_current(cui, boot_editor_scr(cui->boot_editor));
321 static void cui_sysinfo_exit(struct cui *cui)
323 cui_set_current(cui, &cui->main->scr);
324 talloc_free(cui->sysinfo_screen);
325 cui->sysinfo_screen = NULL;
328 void cui_show_sysinfo(struct cui *cui)
330 cui->sysinfo_screen = sysinfo_screen_init(cui, cui->sysinfo,
332 cui_set_current(cui, sysinfo_screen_scr(cui->sysinfo_screen));
335 static void cui_config_exit(struct cui *cui)
337 cui_set_current(cui, &cui->main->scr);
338 talloc_free(cui->config_screen);
339 cui->config_screen = NULL;
342 void cui_show_config(struct cui *cui)
344 cui->config_screen = config_screen_init(cui, cui->config,
345 cui->sysinfo, cui_config_exit);
346 cui_set_current(cui, config_screen_scr(cui->config_screen));
349 static void cui_lang_exit(struct cui *cui)
351 cui_set_current(cui, &cui->main->scr);
352 talloc_free(cui->lang_screen);
353 cui->lang_screen = NULL;
356 void cui_show_lang(struct cui *cui)
358 cui->lang_screen = lang_screen_init(cui, cui->config, cui_lang_exit);
359 cui_set_current(cui, lang_screen_scr(cui->lang_screen));
362 static void cui_statuslog_exit(struct cui *cui)
364 cui_set_current(cui, &cui->main->scr);
365 talloc_free(cui->statuslog_screen);
366 cui->statuslog_screen = NULL;
369 void cui_show_statuslog(struct cui *cui)
371 cui->statuslog_screen = statuslog_screen_init(cui, cui_statuslog_exit);
372 cui_set_current(cui, statuslog_screen_scr(cui->statuslog_screen));
375 static void cui_add_url_exit(struct cui *cui)
377 cui_set_current(cui, &cui->main->scr);
378 talloc_free(cui->add_url_screen);
379 cui->add_url_screen = NULL;
382 static void cui_plugin_exit(struct cui *cui)
384 cui_set_current(cui, &cui->plugin_menu->scr);
385 talloc_free(cui->plugin_screen);
386 cui->plugin_screen = NULL;
389 static void cui_plugin_menu_exit(struct pmenu *menu)
391 struct cui *cui = cui_from_pmenu(menu);
392 cui_set_current(cui, &cui->main->scr);
395 void cui_show_add_url(struct cui *cui)
397 cui->add_url_screen = add_url_screen_init(cui, cui_add_url_exit);
398 cui_set_current(cui, add_url_screen_scr(cui->add_url_screen));
401 void cui_show_plugin_menu(struct cui *cui)
403 cui_set_current(cui, &cui->plugin_menu->scr);
406 void cui_show_plugin(struct pmenu_item *item)
408 struct cui *cui = cui_from_item(item);
409 cui->plugin_screen = plugin_screen_init(cui, item, cui_plugin_exit);
410 cui_set_current(cui, plugin_screen_scr(cui->plugin_screen));
413 static void cui_help_exit(struct cui *cui)
415 cui_set_current(cui, help_screen_return_scr(cui->help_screen));
416 talloc_free(cui->help_screen);
417 cui->help_screen = NULL;
420 void cui_show_help(struct cui *cui, const char *title,
421 const struct help_text *text)
426 if (cui->help_screen)
429 cui->help_screen = help_screen_init(cui, cui->current,
430 title, text, cui_help_exit);
432 if (cui->help_screen)
433 cui_set_current(cui, help_screen_scr(cui->help_screen));
436 static void cui_subset_exit(struct cui *cui)
438 cui_set_current(cui, subset_screen_return_scr(cui->subset_screen));
439 talloc_free(cui->subset_screen);
440 cui->subset_screen = NULL;
443 void cui_show_subset(struct cui *cui, const char *title,
449 if (cui->subset_screen)
452 cui->subset_screen = subset_screen_init(cui, cui->current,
453 title, arg, cui_subset_exit);
455 if (cui->subset_screen)
456 cui_set_current(cui, subset_screen_scr(cui->subset_screen));
460 * cui_set_current - Set the currently active screen and redraw it.
463 struct nc_scr *cui_set_current(struct cui *cui, struct nc_scr *scr)
467 DBGS("%p -> %p\n", cui->current, scr);
469 assert(cui->current != scr);
476 nc_scr_post(cui->current);
481 static bool process_global_keys(struct cui *cui, int key)
485 if (cui->current && cui->current->main_ncw)
493 * cui_process_key - Process input on stdin.
496 static int cui_process_key(void *arg)
498 struct cui *cui = cui_from_arg(arg);
500 assert(cui->current);
505 pb_debug("%s: got key %d\n", __func__, c);
510 if (!cui->has_input) {
511 cui->has_input = true;
513 pb_log("UI input received (key = %d), aborting "
514 "default boot\n", c);
515 discover_client_cancel_default(cui->client);
517 pb_log("UI input received (key = %d), aborting "
518 "once server connects\n", c);
522 if (process_global_keys(cui, c))
525 cui->current->process_key(cui->current, c);
532 * cui_process_js - Process joystick events.
535 static int cui_process_js(void *arg)
537 struct cui *cui = cui_from_arg(arg);
540 c = pjs_process_event(cui->pjs);
544 cui_process_key(arg);
551 * cui_handle_resize - Handle the term resize.
554 static void cui_handle_resize(struct cui *cui)
558 if (ioctl(1, TIOCGWINSZ, &ws) == -1) {
559 pb_log("%s: ioctl failed: %s\n", __func__, strerror(errno));
563 pb_debug("%s: {%u,%u}\n", __func__, ws.ws_row, ws.ws_col);
565 wclear(cui->current->main_ncw);
566 resize_term(ws.ws_row, ws.ws_col);
567 cui->current->resize(cui->current);
569 /* For some reason this makes ncurses redraw the screen */
571 redrawwin(cui->current->main_ncw);
572 wrefresh(cui->current->main_ncw);
576 * cui_device_add - Client device_add callback.
578 * Creates menu_items for all the device boot_options and inserts those
579 * menu_items into the main menu. Redraws the main menu if it is active.
580 * If a 'plugin' type boot_option appears the plugin menu is updated instead.
583 static int cui_boot_option_add(struct device *dev, struct boot_option *opt,
586 struct pmenu_item *i, *dev_hdr = NULL;
587 struct cui *cui = cui_from_arg(arg);
588 struct cui_opt_data *cod;
589 const char *tab = " ";
590 unsigned int insert_pt;
591 int result, rows, cols;
597 plugin_option = opt->type == DISCOVER_PLUGIN_OPTION;
598 menu = plugin_option ? cui->plugin_menu : cui->main;
600 pb_debug("%s: %p %s\n", __func__, opt, opt->id);
602 selected = current_item(menu->ncm);
603 menu_format(menu->ncm, &rows, &cols);
605 if (cui->current == &cui->main->scr)
606 nc_scr_unpost(cui->current);
607 if (plugin_option && cui->current == &cui->plugin_menu->scr)
608 nc_scr_unpost(cui->current);
610 /* Check if the boot device is new */
611 dev_hdr = pmenu_find_device(menu, dev, opt);
613 /* All actual boot entries are 'tabbed' across */
614 name = talloc_asprintf(menu, "%s%s",
615 tab, opt->name ? : "Unknown Name");
617 /* Save the item in opt->ui_info for cui_device_remove() */
618 opt->ui_info = i = pmenu_item_create(menu, name);
625 i->on_execute = plugin_install_plugin;
627 i->on_edit = cui_item_edit;
628 i->on_execute = cui_boot;
631 i->data = cod = talloc(i, struct cui_opt_data);
634 cod->opt_hash = pb_opt_hash(dev, opt);
635 cod->name = opt->name;
638 cod->pd = talloc(i, struct pb_plugin_data);
639 cod->pd->plugin_file = talloc_strdup(cod,
640 opt->boot_image_file);
642 cod->bd = talloc(i, struct pb_boot_data);
643 cod->bd->image = talloc_strdup(cod->bd, opt->boot_image_file);
644 cod->bd->initrd = talloc_strdup(cod->bd, opt->initrd_file);
645 cod->bd->dtb = talloc_strdup(cod->bd, opt->dtb_file);
646 cod->bd->args = talloc_strdup(cod->bd, opt->boot_args);
647 cod->bd->args_sig_file = talloc_strdup(cod->bd, opt->args_sig_file);
650 /* This disconnects items array from menu. */
651 result = set_menu_items(menu->ncm, NULL);
654 pb_log("%s: set_menu_items failed: %d\n", __func__, result);
656 /* Insert new items at insert_pt. */
658 insert_pt = pmenu_grow(menu, 2);
659 pmenu_item_insert(menu, dev_hdr, insert_pt);
660 pb_log("%s: adding new device hierarchy %s\n",
661 __func__, opt->device_id);
662 pmenu_item_insert(menu, i, insert_pt+1);
664 insert_pt = pmenu_grow(menu, 1);
665 pmenu_item_add(menu, i, insert_pt);
669 pb_log("%s: adding plugin '%s'\n", __func__, cod->name);
670 pb_log(" file '%s'\n", cod->pd->plugin_file);
672 pb_log("%s: adding opt '%s'\n", __func__, cod->name);
673 pb_log(" image '%s'\n", cod->bd->image);
674 pb_log(" initrd '%s'\n", cod->bd->initrd);
675 pb_log(" args '%s'\n", cod->bd->args);
676 pb_log(" argsig '%s'\n", cod->bd->args_sig_file);
679 /* Update the plugin menu label if needed */
681 struct pmenu_item *item;
683 result = set_menu_items(cui->main->ncm, NULL);
684 for (j = 0 ; j < cui->main->item_count; j++) {
685 item = item_userptr(cui->main->items[j]);
686 if (strncmp(item->nci->name.str, "Plugins", strlen("Plugins")))
689 char *label = talloc_asprintf(item, "Plugins (%u)",
691 pmenu_item_update(item, label);
695 result = set_menu_items(cui->main->ncm, cui->main->items);
697 pb_log("%s: set_menu_items failed: %d\n", __func__, result);
700 /* Re-attach the items array. */
701 result = set_menu_items(menu->ncm, menu->items);
704 pb_log("%s: set_menu_items failed: %d\n", __func__, result);
707 pb_log("%s\n", __func__);
708 pmenu_dump_items(menu->items,
709 item_count(menu->ncm) + 1);
712 if (!item_visible(selected)) {
715 top = top_row(menu->ncm);
716 idx = item_index(selected);
718 /* If our index is above the current top row, align
719 * us to the new top. Otherwise, align us to the new
721 top = top < idx ? idx - rows + 1 : idx;
723 set_top_row(menu->ncm, top);
724 set_current_item(menu->ncm, selected);
727 if (cui->current == &menu->scr)
728 nc_scr_post(cui->current);
729 if (plugin_option && cui->current == &cui->main->scr)
730 nc_scr_post(cui->current);
736 * cui_device_remove - Client device remove callback.
738 * Removes all the menu_items for the device from the main menu and redraws the
739 * main menu if it is active.
741 static void cui_device_remove(struct device *dev, void *arg)
743 struct cui *cui = cui_from_arg(arg);
744 struct boot_option *opt;
746 int rows, cols, top, last;
749 pb_log("%s: %p %s\n", __func__, dev, dev->id);
751 if (cui->current == &cui->main->scr)
752 nc_scr_unpost(cui->current);
753 if (cui->current == &cui->plugin_menu->scr)
754 nc_scr_unpost(cui->current);
756 /* This disconnects items array from menu. */
758 result = set_menu_items(cui->main->ncm, NULL);
759 result |= set_menu_items(cui->plugin_menu->ncm, NULL);
762 pb_log("%s: set_menu_items failed: %d\n", __func__, result);
764 list_for_each_entry(&dev->boot_options, opt, list) {
765 struct pmenu_item *item = pmenu_item_from_arg(opt->ui_info);
767 assert(pb_protocol_device_cmp(dev, cod_from_item(item)->dev));
768 if (opt->type == DISCOVER_PLUGIN_OPTION)
769 pmenu_remove(cui->plugin_menu, item);
771 pmenu_remove(cui->main, item);
774 /* Manually remove remaining device hierarchy item */
775 for (i=0; i < cui->main->item_count; i++) {
776 struct pmenu_item *item = item_userptr(cui->main->items[i]);
777 if (!item || !item->data )
780 struct cui_opt_data *data = item->data;
781 if (data && data->dev && data->dev == dev)
782 pmenu_remove(cui->main,item);
784 /* Look in plugins menu too */
785 for (i=0; i < cui->plugin_menu->item_count; i++) {
786 struct pmenu_item *item = item_userptr(cui->plugin_menu->items[i]);
787 if (!item || !item->data )
790 struct cui_opt_data *data = item->data;
791 if (data && data->dev && data->dev == dev)
792 pmenu_remove(cui->plugin_menu,item);
795 /* Re-attach the items array. */
797 result = set_menu_items(cui->main->ncm, cui->main->items);
798 result |= set_menu_items(cui->plugin_menu->ncm, cui->plugin_menu->items);
800 /* Move cursor to 'Exit' menu entry for the main menu.. */
801 menu_format(cui->main->ncm, &rows, &cols);
802 last = cui->main->item_count - 1;
803 set_current_item(cui->main->ncm, cui->main->items[last]);
804 if (!item_visible(cui->main->items[last])) {
805 top = last < rows ? 0 : last - rows + 1;
806 set_top_row(cui->main->ncm, top);
809 /* ..and the plugin menu */
810 menu_format(cui->plugin_menu->ncm, &rows, &cols);
811 last = cui->plugin_menu->item_count - 1;
812 set_current_item(cui->plugin_menu->ncm, cui->plugin_menu->items[last]);
813 if (!item_visible(cui->plugin_menu->items[last])) {
814 top = last < rows ? 0 : last - rows + 1;
815 set_top_row(cui->plugin_menu->ncm, top);
819 pb_log("%s: set_menu_items failed: %d\n", __func__, result);
822 pb_log("%s\n", __func__);
823 pmenu_dump_items(cui->main->items,
824 item_count(cui->main->ncm) + 1);
827 if (cui->current == &cui->main->scr)
828 nc_scr_post(cui->current);
829 if (cui->current == &cui->plugin_menu->scr)
830 nc_scr_post(cui->current);
833 static void cui_update_status(struct status *status, void *arg)
835 struct cui *cui = cui_from_arg(arg);
837 statuslog_append_steal(cui, cui->statuslog, status);
839 /* Ignore status messages from the backlog */
840 if (!status->backlog)
841 nc_scr_status_printf(cui->current, "%s", status->message);
845 * Handle a new installed plugin option and update its associated
846 * (uninstalled) menu item if it exists.
848 static int cui_plugin_option_add(struct plugin_option *opt, void *arg)
850 struct cui_opt_data *cod;
851 struct cui *cui = cui_from_arg(arg);
852 struct pmenu_item *item = NULL;
853 struct boot_option *dummy_opt;
859 /* Find uninstalled plugin by matching on plugin_file */
860 for (i = 0; i < cui->plugin_menu->item_count; i++) {
861 item = item_userptr(cui->plugin_menu->items[i]);
864 cod = cod_from_item(item);
865 if (!cod || !cod->pd)
867 if (strncmp(cod->pd->plugin_file, opt->plugin_file,
868 strlen(cod->pd->plugin_file)) == 0)
873 * If pb-plugin was run manually there may not be an associated
874 * plugin-type boot_option. Pass a fake device and option to
875 * cui_boot_option_add() so we have an item to work with.
877 if (!item || i >= cui->plugin_menu->item_count) {
878 pb_log("New plugin option %s doesn't have a source item\n",
880 dev = talloc_zero(cui, struct device);
881 dev->id = dev->name = talloc_asprintf(dev, "(unknown)");
882 dev->type = DEVICE_TYPE_UNKNOWN;
883 dummy_opt = talloc_zero(cui, struct boot_option);
884 dummy_opt->device_id = talloc_strdup(dummy_opt, dev->id);
885 dummy_opt->id = dummy_opt->name = talloc_asprintf(dummy_opt, "dummy");
886 dummy_opt->boot_image_file = talloc_strdup(dummy_opt, opt->plugin_file);
887 dummy_opt->type = DISCOVER_PLUGIN_OPTION;
888 cui_boot_option_add(dev, dummy_opt, cui);
893 * If this option was faked above move the context under
894 * the item so it is cleaned up later in cui_plugins_remove().
896 if (strncmp(cod->opt->id, "dummy", strlen("dummy") == 0 &&
897 cod->dev->type == DEVICE_TYPE_UNKNOWN)) {
898 talloc_steal(item, cod->dev);
899 talloc_steal(item, cod->opt);
902 talloc_free(cod->name);
903 /* Name is still tabbed across */
904 cod->name = talloc_asprintf(cod, " %s [installed]", opt->name);
907 item->on_execute = NULL;
908 item->on_edit = cui_show_plugin;
910 if (cui->current == &cui->plugin_menu->scr)
911 nc_scr_unpost(cui->current);
913 /* This disconnects items array from menu. */
914 result = set_menu_items(cui->plugin_menu->ncm, NULL);
917 pmenu_item_update(item, cod->name);
919 /* Re-attach the items array. */
920 result = set_menu_items(cui->plugin_menu->ncm, cui->plugin_menu->items);
922 if (cui->current == &cui->plugin_menu->scr)
923 nc_scr_post(cui->current);
929 * Most plugin menu items will be removed via cui_device_remove(). However if
930 * pb-plugin has been run manually it is possible that there a plugin items
931 * not associated with a device - remove them here.
933 static int cui_plugins_remove(void *arg)
935 struct cui *cui = cui_from_arg(arg);
936 struct pmenu_item *item = NULL;
937 struct cui_opt_data *cod;
940 pb_debug("%s\n", __func__);
942 if (cui->current == &cui->plugin_menu->scr)
943 nc_scr_unpost(cui->current);
944 if (cui->current == &cui->main->scr)
945 nc_scr_unpost(cui->current);
947 /* This disconnects items array from menu. */
948 set_menu_items(cui->plugin_menu->ncm, NULL);
950 while (i < cui->plugin_menu->item_count) {
951 item = item_userptr(cui->plugin_menu->items[i]);
952 if (!item || !item->data) {
956 cod = cod_from_item(item);
957 if (!cod->opt && !cod->dev) {
962 pmenu_remove(cui->plugin_menu, item);
963 /* plugin_menu entries will shift, jump to bottom to make sure
964 * we remove all plugin option items */
968 /* Re-attach the items array. */
969 set_menu_items(cui->plugin_menu->ncm, cui->plugin_menu->items);
971 set_menu_items(cui->main->ncm, NULL);
972 for (i = 0; i < cui->main->item_count; i++) {
973 item = item_userptr(cui->main->items[i]);
974 if (strncmp(item->nci->name.str, "Plugins", strlen("Plugins")))
977 pmenu_item_update(item, "Plugins (0)");
981 set_menu_items(cui->main->ncm, cui->main->items);
983 if (cui->current == &cui->main->scr)
984 nc_scr_post(cui->current);
986 /* If we're currently in a plugin screen jump back to the plugin menu */
987 if (cui->plugin_screen &&
988 cui->current == plugin_screen_scr(cui->plugin_screen))
989 cui_plugin_exit(cui);
994 static void cui_update_mm_title(struct cui *cui)
996 struct nc_frame *frame = &cui->main->scr.frame;
998 talloc_free(frame->rtitle);
1000 frame->rtitle = talloc_strdup(cui->main, cui->sysinfo->type);
1001 if (cui->sysinfo->identifier)
1002 frame->rtitle = talloc_asprintf_append(frame->rtitle,
1003 " %s", cui->sysinfo->identifier);
1005 if (cui->current == &cui->main->scr)
1006 nc_scr_post(cui->current);
1008 frame = &cui->plugin_menu->scr.frame;
1010 talloc_free(frame->rtitle);
1012 frame->rtitle = talloc_strdup(cui->main, cui->sysinfo->type);
1013 if (cui->sysinfo->identifier)
1014 frame->rtitle = talloc_asprintf_append(frame->rtitle,
1015 " %s", cui->sysinfo->identifier);
1017 if (cui->current == &cui->main->scr)
1018 nc_scr_post(cui->current);
1021 static void cui_update_sysinfo(struct system_info *sysinfo, void *arg)
1023 struct cui *cui = cui_from_arg(arg);
1024 cui->sysinfo = talloc_steal(cui, sysinfo);
1026 /* if we're currently displaying the system info screen, inform it
1027 * of the updated information. */
1028 if (cui->sysinfo_screen)
1029 sysinfo_screen_update(cui->sysinfo_screen, sysinfo);
1031 if (cui->subset_screen)
1032 subset_screen_update(cui->subset_screen);
1034 /* ... and do the same with the config screen... */
1035 if (cui->config_screen)
1036 config_screen_update(cui->config_screen, cui->config, sysinfo);
1038 /* ... and the boot editor. */
1039 if (cui->boot_editor)
1040 boot_editor_update(cui->boot_editor, sysinfo);
1042 cui_update_mm_title(cui);
1045 static void cui_update_language(struct cui *cui, char *lang)
1050 cur_lang = setlocale(LC_ALL, NULL);
1051 if (cur_lang && !strcmp(cur_lang, lang))
1054 setlocale(LC_ALL, lang);
1056 /* we'll need to update the menu: drop all items and repopulate */
1057 repost_menu = cui->current == &cui->main->scr ||
1058 cui->current == &cui->plugin_menu->scr;
1060 nc_scr_unpost(cui->current);
1062 talloc_free(cui->main);
1063 cui->main = main_menu_init(cui);
1064 cui->plugin_menu = plugin_menu_init(cui);
1067 cui->current = &cui->main->scr;
1068 nc_scr_post(cui->current);
1071 discover_client_enumerate(cui->client);
1074 static void cui_update_config(struct config *config, void *arg)
1076 struct cui *cui = cui_from_arg(arg);
1077 cui->config = talloc_steal(cui, config);
1080 cui_update_language(cui, config->lang);
1082 if (cui->subset_screen)
1083 subset_screen_update(cui->subset_screen);
1085 if (cui->config_screen)
1086 config_screen_update(cui->config_screen, config, cui->sysinfo);
1088 if (config->safe_mode)
1089 nc_scr_status_printf(cui->current,
1090 _("SAFE MODE: select '%s' to continue"),
1091 _("Rescan devices"));
1094 int cui_send_config(struct cui *cui, struct config *config)
1096 return discover_client_send_config(cui->client, config);
1099 int cui_send_url(struct cui *cui, char * url)
1101 return discover_client_send_url(cui->client, url);
1104 int cui_send_plugin_install(struct cui *cui, char *file)
1106 return discover_client_send_plugin_install(cui->client, file);
1109 void cui_send_reinit(struct cui *cui)
1111 discover_client_send_reinit(cui->client);
1114 static int menu_sysinfo_execute(struct pmenu_item *item)
1116 cui_show_sysinfo(cui_from_item(item));
1120 static int menu_config_execute(struct pmenu_item *item)
1122 cui_show_config(cui_from_item(item));
1126 static int menu_lang_execute(struct pmenu_item *item)
1128 cui_show_lang(cui_from_item(item));
1132 static int menu_statuslog_execute(struct pmenu_item *item)
1134 cui_show_statuslog(cui_from_item(item));
1138 static int menu_reinit_execute(struct pmenu_item *item)
1140 if (cui_from_item(item)->client)
1141 cui_send_reinit(cui_from_item(item));
1145 static int menu_add_url_execute(struct pmenu_item *item)
1147 if (cui_from_item(item)->client)
1148 cui_show_add_url(cui_from_item(item));
1152 static int menu_plugin_execute(struct pmenu_item *item)
1154 if (cui_from_item(item)->client)
1155 cui_show_plugin_menu(cui_from_item(item));
1160 * pb_mm_init - Setup the main menu instance.
1162 static struct pmenu *main_menu_init(struct cui *cui)
1164 struct pmenu_item *i;
1167 bool lockdown = lockdown_active();
1169 m = pmenu_init(cui, 9, cui_on_exit);
1171 pb_log("%s: failed\n", __func__);
1175 m->on_new = cui_item_new;
1177 m->scr.frame.ltitle = talloc_asprintf(m,
1178 "Petitboot (" PACKAGE_VERSION ")");
1179 m->scr.frame.rtitle = NULL;
1180 m->scr.frame.help = talloc_strdup(m,
1181 _("Enter=accept, e=edit, n=new, x=exit, l=language, g=log, h=help"));
1182 m->scr.frame.status = talloc_strdup(m, _("Welcome to Petitboot"));
1184 /* add a separator */
1185 i = pmenu_item_create(m, " ");
1186 item_opts_off(i->nci, O_SELECTABLE);
1187 pmenu_item_insert(m, i, 0);
1189 /* add system items */
1190 i = pmenu_item_create(m, _("System information"));
1191 i->on_execute = menu_sysinfo_execute;
1192 pmenu_item_insert(m, i, 1);
1194 i = pmenu_item_create(m, _("System configuration"));
1195 i->on_execute = menu_config_execute;
1196 pmenu_item_insert(m, i, 2);
1198 i = pmenu_item_create(m, _("System status log"));
1199 i->on_execute = menu_statuslog_execute;
1200 pmenu_item_insert(m, i, 3);
1202 /* this label isn't translated, so we don't want a gettext() here */
1203 i = pmenu_item_create(m, "Language");
1204 i->on_execute = menu_lang_execute;
1205 pmenu_item_insert(m, i, 4);
1207 i = pmenu_item_create(m, _("Rescan devices"));
1208 i->on_execute = menu_reinit_execute;
1209 pmenu_item_insert(m, i, 5);
1211 i = pmenu_item_create(m, _("Retrieve config from URL"));
1212 i->on_execute = menu_add_url_execute;
1213 pmenu_item_insert(m, i, 6);
1215 i = pmenu_item_create(m, _("Plugins (0)"));
1216 i->on_execute = menu_plugin_execute;
1217 pmenu_item_insert(m, i, 7);
1220 i = pmenu_item_create(m, _("Reboot"));
1222 i = pmenu_item_create(m, _("Exit to shell"));
1223 i->on_execute = pmenu_exit_cb;
1224 pmenu_item_insert(m, i, 8);
1226 result = pmenu_setup(m);
1229 pb_log("%s:%d: pmenu_setup failed: %s\n", __func__, __LINE__,
1234 m->help_title = _("main menu");
1235 m->help_text = &main_menu_help_text;
1237 menu_opts_off(m->ncm, O_SHOWDESC);
1238 set_menu_mark(m->ncm, " *");
1239 set_current_item(m->ncm, i->nci);
1249 * plugin_menu_init: Set up the plugin menu instance
1251 static struct pmenu *plugin_menu_init(struct cui *cui)
1253 struct pmenu_item *i;
1257 m = pmenu_init(cui, 2, cui_plugin_menu_exit);
1258 m->on_new = cui_item_new;
1259 m->scr.frame.ltitle = talloc_asprintf(m, _("Petitboot Plugins"));
1260 m->scr.frame.rtitle = talloc_asprintf(m, NULL);
1261 m->scr.frame.help = talloc_strdup(m,
1262 _("Enter=install, e=details, x=exit, h=help"));
1263 m->scr.frame.status = talloc_asprintf(m,
1264 _("Available Petitboot Plugins"));
1266 /* add a separator */
1267 i = pmenu_item_create(m, " ");
1268 item_opts_off(i->nci, O_SELECTABLE);
1269 pmenu_item_insert(m, i, 0);
1271 i = pmenu_item_create(m, ("Return to Main Menu"));
1272 i->on_execute = pmenu_exit_cb;
1273 pmenu_item_insert(m, i, 1);
1275 result = pmenu_setup(m);
1278 pb_log("%s:%d: pmenu_setup failed: %s\n", __func__, __LINE__,
1283 m->help_title = _("plugin menu");
1284 m->help_text = &plugin_menu_help_text;
1293 static struct discover_client_ops cui_client_ops = {
1295 .boot_option_add = cui_boot_option_add,
1296 .device_remove = cui_device_remove,
1297 .plugin_option_add = cui_plugin_option_add,
1298 .plugins_remove = cui_plugins_remove,
1299 .update_status = cui_update_status,
1300 .update_sysinfo = cui_update_sysinfo,
1301 .update_config = cui_update_config,
1304 /* cui_server_wait_on_exit - On exit spin until the server is available.
1306 * If the program exits before connecting to the server autoboot won't be
1307 * cancelled even though there has been keyboard activity. This function is
1308 * called by a child process which will spin until the server is connected and
1309 * told to cancel autoboot.
1311 * Processes exiting from this function will not carry out the cui_atexit()
1314 static void cui_server_wait_on_exit(struct cui *cui)
1316 cui_detached = true;
1318 while (!cui->client) {
1319 cui->client = discover_client_init(cui->waitset,
1320 &cui_client_ops, cui);
1325 talloc_steal(cui, cui->client);
1326 discover_client_cancel_default(cui->client);
1329 /* cui_server_wait - Connect to the discover server.
1330 * @arg: Pointer to the cui instance.
1332 * A timeout callback that attempts to connect to the discover server; on
1333 * failure it registers itself with a one second timeout to try again.
1334 * On success the cui->client struct will be set.
1336 * Since this updates the status line when called it must not be called
1337 * before the UI is ready.
1339 static int cui_server_wait(void *arg)
1341 struct cui *cui = cui_from_arg(arg);
1344 pb_debug("We already have a server!\n");
1348 /* We haven't yet connected to the server */
1349 pb_log("Trying to connect...\n");
1350 cui->client = discover_client_init(cui->waitset,
1351 &cui_client_ops, cui);
1354 waiter_register_timeout(cui->waitset, 1000, cui_server_wait,
1356 nc_scr_status_printf(cui->current,
1357 "Info: Waiting for device discovery");
1359 nc_scr_status_free(cui->current);
1360 talloc_steal(cui, cui->client);
1362 if (cui->has_input) {
1363 pb_log("Aborting default boot on pb-discover connect\n");
1364 discover_client_cancel_default(cui->client);
1372 * cui_init - Setup the cui instance.
1373 * @platform_info: A value for the struct cui platform_info member.
1375 * Returns a pointer to a struct cui on success, or NULL on error.
1377 * Allocates the cui instance, sets up the client and stdin waiters, and
1378 * sets up the ncurses menu screen.
1381 struct cui *cui_init(void* platform_info,
1382 int (*js_map)(const struct js_event *e), int start_daemon, int timeout)
1387 cui = talloc_zero(NULL, struct cui);
1389 pb_log("%s: alloc cui failed.\n", __func__);
1390 fprintf(stderr, _("%s: alloc cui failed.\n"), __func__);
1394 cui->c_sig = pb_cui_sig;
1395 cui->platform_info = platform_info;
1396 cui->waitset = waitset_create(cui);
1397 cui->statuslog = statuslog_init(cui);
1399 process_init(cui, cui->waitset, false);
1401 /* Loop here for scripts that just started the server. */
1404 for (i = start_daemon ? 2 : 15; i && timeout; i--) {
1405 cui->client = discover_client_init(cui->waitset,
1406 &cui_client_ops, cui);
1407 if (cui->client || !i)
1409 pb_log("%s: waiting for server %d\n", __func__, i);
1413 if (!cui->client && start_daemon) {
1418 result = pb_start_daemon(cui);
1423 pb_log("%s: discover_client_init failed.\n", __func__);
1424 fprintf(stderr, _("%s: error: discover_client_init failed.\n"),
1426 fprintf(stderr, _("could not start pb-discover, the petitboot "
1428 goto fail_client_init;
1431 if (!cui->client && !timeout) {
1432 /* Have the first timeout fire immediately so we can check
1433 * for the server as soon as the UI is ready */
1434 waiter_register_timeout(cui->waitset, 0,
1435 cui_server_wait, cui);
1436 } else if (!cui->client) {
1437 pb_log("%s: discover_client_init failed.\n", __func__);
1438 fprintf(stderr, _("%s: error: discover_client_init failed.\n"),
1440 fprintf(stderr, _("check that pb-discover, "
1441 "the petitboot daemon is running.\n"));
1442 goto fail_client_init;
1446 talloc_steal(cui, cui->client);
1449 cui->main = main_menu_init(cui);
1451 goto fail_client_init;
1453 cui->plugin_menu = plugin_menu_init(cui);
1454 if (!cui->plugin_menu)
1455 goto fail_client_init;
1457 waiter_register_io(cui->waitset, STDIN_FILENO, WAIT_IN,
1458 cui_process_key, cui);
1462 cui->pjs = pjs_init(cui, js_map);
1465 waiter_register_io(cui->waitset, pjs_get_fd(cui->pjs),
1466 WAIT_IN, cui_process_js, cui);
1478 * cui_run - The main cui program loop.
1479 * @cui: The cui instance.
1480 * @main: The menu to use as the main menu.
1482 * Runs the cui engine. Does not return until indicated to do so by some
1483 * user action, or an error occurs. Frees the cui object on return.
1484 * Returns 0 on success (return to shell), -1 on error (should restart).
1487 int cui_run(struct cui *cui)
1493 cui->current = &cui->main->scr;
1494 cui->default_item = 0;
1496 nc_scr_post(cui->current);
1499 int result = waiter_poll(cui->waitset);
1502 pb_log("%s: poll: %s\n", __func__, strerror(errno));
1509 while (cui->resize) {
1511 cui_handle_resize(cui);
1518 /* Fork a child to tell the server to cancel autoboot */
1521 cui_server_wait_on_exit(cui);
1525 pb_log("Failed to fork child on exit: %m\n");
1528 return cui->abort ? 0 : -1;