ui/ncurses: Always provide a key definition for backtab
[petitboot] / ui / ncurses / nc-cui.c
1 /*
2  *  Copyright (C) 2009 Sony Computer Entertainment Inc.
3  *  Copyright 2009 Sony Corp.
4  *
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.
8  *
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.
13  *
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
17  */
18
19 #if defined(HAVE_CONFIG_H)
20 #include "config.h"
21 #endif
22
23 #include <assert.h>
24 #include <errno.h>
25 #include <stdlib.h>
26 #include <string.h>
27 #include <locale.h>
28 #include <sys/ioctl.h>
29
30 #include "log/log.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 "ui/common/discover-client.h"
36 #include "ui/common/ui-system.h"
37 #include "nc-cui.h"
38 #include "nc-boot-editor.h"
39 #include "nc-config.h"
40 #include "nc-sysinfo.h"
41 #include "nc-helpscreen.h"
42
43 static void cui_start(void)
44 {
45         initscr();                      /* Initialize ncurses. */
46         cbreak();                       /* Disable line buffering. */
47         noecho();                       /* Disable getch() echo. */
48         keypad(stdscr, TRUE);           /* Enable num keypad keys. */
49         nonl();                         /* Disable new-line translation. */
50         intrflush(stdscr, FALSE);       /* Disable interrupt flush. */
51         curs_set(0);                    /* Make cursor invisible */
52         nodelay(stdscr, TRUE);          /* Enable non-blocking getch() */
53
54         /* We may be operating with an incorrect $TERM type; in this case
55          * the keymappings will be slightly broken. We want at least
56          * backspace to work though, so we'll define both DEL and ^H to
57          * map to backspace */
58         define_key("\x7f", KEY_BACKSPACE);
59         define_key("\x08", KEY_BACKSPACE);
60
61         /* we need backtab too, for form navigation. vt220 doesn't include
62          * this (kcbt), but we don't want to require a full linux/xterm termcap
63          */
64         define_key("\x1b[Z", KEY_BTAB);
65
66         while (getch() != ERR)          /* flush stdin */
67                 (void)0;
68 }
69
70 static void cui_atexit(void)
71 {
72         clear();
73         refresh();
74         endwin();
75 }
76
77 /**
78  * cui_abort - Signal the main cui program loop to exit.
79  *
80  * Sets cui.abort, which causes the cui_run() routine to return.
81  */
82
83 void cui_abort(struct cui *cui)
84 {
85         pb_log("%s: exiting\n", __func__);
86         cui->abort = 1;
87 }
88
89 /**
90  * cui_resize - Signal the main cui program loop to resize
91  *
92  * Called at SIGWINCH.
93  */
94
95 void cui_resize(struct cui *cui)
96 {
97         pb_debug("%s: resizing\n", __func__);
98         cui->resize = 1;
99 }
100
101 /**
102  * cui_on_exit - A generic main menu exit callback.
103  */
104
105 void cui_on_exit(struct pmenu *menu)
106 {
107         cui_abort(cui_from_pmenu(menu));
108 }
109
110 /**
111  * cui_run_cmd - A generic cb to run the supplied command.
112  */
113
114 int cui_run_cmd(struct pmenu_item *item)
115 {
116         int result;
117         struct cui *cui = cui_from_item(item);
118         const char **cmd_argv = item->data;
119
120         nc_scr_status_printf(cui->current, "Running %s...", cmd_argv[0]);
121
122         def_prog_mode();
123
124         result = process_run_simple_argv(item, cmd_argv);
125
126         reset_prog_mode();
127         redrawwin(cui->current->main_ncw);
128
129         if (result) {
130                 pb_log("%s: failed: '%s'\n", __func__, cmd_argv[0]);
131                 nc_scr_status_printf(cui->current, "Failed: %s", cmd_argv[0]);
132         }
133
134         return result;
135 }
136
137 /**
138  * cui_boot - A generic cb to run kexec.
139  */
140
141 static int cui_boot(struct pmenu_item *item)
142 {
143         int result;
144         struct cui *cui = cui_from_item(item);
145         struct cui_opt_data *cod = cod_from_item(item);
146
147         assert(cui->current == &cui->main->scr);
148
149         pb_debug("%s: %s\n", __func__, cod->name);
150
151         nc_scr_status_printf(cui->current, "Booting %s...", cod->name);
152
153         result = discover_client_boot(cui->client, NULL, cod->opt, cod->bd);
154
155         if (result) {
156                 nc_scr_status_printf(cui->current,
157                                 "Failed: boot %s", cod->bd->image);
158         }
159
160         return 0;
161 }
162
163 static void cui_boot_editor_on_exit(struct cui *cui,
164                 struct pmenu_item *item,
165                 struct pb_boot_data *bd)
166 {
167         struct pmenu *menu = cui->main;
168         struct cui_opt_data *cod;
169         static int user_idx = 0;
170
171         /* Was the edit cancelled? */
172         if (!bd) {
173                 cui_set_current(cui, &cui->main->scr);
174                 talloc_free(cui->boot_editor);
175                 cui->boot_editor = NULL;
176                 return;
177         }
178
179         /* Is this was a new item, we'll need to update the menu */
180         if (!item) {
181                 int insert_pt;
182
183                 cod = talloc_zero(NULL, struct cui_opt_data);
184                 cod->name = talloc_asprintf(cod, "User item %u", ++user_idx);
185
186                 item = pmenu_item_create(menu, cod->name);
187                 if (!item) {
188                         talloc_free(cod);
189                         goto out;
190                 }
191
192                 item->on_edit = cui_item_edit;
193                 item->on_execute = cui_boot;
194                 item->data = cod;
195
196                 talloc_steal(item, cod);
197
198                 /* Detach the items array. */
199                 set_menu_items(menu->ncm, NULL);
200
201                 /* Insert new item at insert_pt. */
202                 insert_pt = pmenu_grow(menu, 1);
203                 pmenu_item_insert(menu, item, insert_pt);
204
205                 /* Re-attach the items array. */
206                 set_menu_items(menu->ncm, menu->items);
207                 nc_scr_post(&menu->scr);
208         } else {
209                 cod = item->data;
210         }
211
212         cod->bd = talloc_steal(cod, bd);
213
214         set_current_item(item->pmenu->ncm, item->nci);
215 out:
216         cui_set_current(cui, &cui->main->scr);
217         talloc_free(cui->boot_editor);
218         cui->boot_editor = NULL;
219 }
220
221 void cui_item_edit(struct pmenu_item *item)
222 {
223         struct cui *cui = cui_from_item(item);
224         cui->boot_editor = boot_editor_init(cui, item, cui->sysinfo,
225                                         cui_boot_editor_on_exit);
226         cui_set_current(cui, boot_editor_scr(cui->boot_editor));
227 }
228
229 void cui_item_new(struct pmenu *menu)
230 {
231         struct cui *cui = cui_from_pmenu(menu);
232         cui->boot_editor = boot_editor_init(cui, NULL, cui->sysinfo,
233                                         cui_boot_editor_on_exit);
234         cui_set_current(cui, boot_editor_scr(cui->boot_editor));
235 }
236
237 static void cui_sysinfo_exit(struct cui *cui)
238 {
239         cui_set_current(cui, &cui->main->scr);
240         talloc_free(cui->sysinfo_screen);
241         cui->sysinfo_screen = NULL;
242 }
243
244 void cui_show_sysinfo(struct cui *cui)
245 {
246         cui->sysinfo_screen = sysinfo_screen_init(cui, cui->sysinfo,
247                         cui_sysinfo_exit);
248         cui_set_current(cui, sysinfo_screen_scr(cui->sysinfo_screen));
249 }
250
251 static void cui_config_exit(struct cui *cui)
252 {
253         cui_set_current(cui, &cui->main->scr);
254         talloc_free(cui->config_screen);
255         cui->config_screen = NULL;
256 }
257
258 void cui_show_config(struct cui *cui)
259 {
260         cui->config_screen = config_screen_init(cui, cui->config,
261                         cui->sysinfo, cui_config_exit);
262         cui_set_current(cui, config_screen_scr(cui->config_screen));
263 }
264
265 static void cui_help_exit(struct cui *cui)
266 {
267         cui_set_current(cui, help_screen_return_scr(cui->help_screen));
268         talloc_free(cui->help_screen);
269         cui->help_screen = NULL;
270 }
271
272 void cui_show_help(struct cui *cui, const char *title, const char *text)
273 {
274         if (!cui->current)
275                 return;
276
277         if (cui->help_screen)
278                 return;
279
280         cui->help_screen = help_screen_init(cui, cui->current,
281                         title, text, cui_help_exit);
282
283         if (cui->help_screen)
284                 cui_set_current(cui, help_screen_scr(cui->help_screen));
285 }
286
287 /**
288  * cui_set_current - Set the currently active screen and redraw it.
289  */
290
291 struct nc_scr *cui_set_current(struct cui *cui, struct nc_scr *scr)
292 {
293         struct nc_scr *old;
294
295         DBGS("%p -> %p\n", cui->current, scr);
296
297         assert(cui->current != scr);
298
299         old = cui->current;
300         nc_scr_unpost(old);
301
302         cui->current = scr;
303
304         nc_scr_post(cui->current);
305
306         return old;
307 }
308
309 static bool process_global_keys(struct cui *cui, int key)
310 {
311         switch (key) {
312         case 0xc:
313                 if (cui->current && cui->current->main_ncw)
314                         wrefresh(curscr);
315                 return true;
316         }
317         return false;
318 }
319
320 /**
321  * cui_process_key - Process input on stdin.
322  */
323
324 static int cui_process_key(void *arg)
325 {
326         struct cui *cui = cui_from_arg(arg);
327
328         assert(cui->current);
329
330         if (!cui->has_input)
331                 discover_client_cancel_default(cui->client);
332         cui->has_input = true;
333
334         for (;;) {
335                 int c = getch();
336
337                 pb_debug("%s: got key %d\n", __func__, c);
338
339                 if (c == ERR)
340                         break;
341
342                 if (process_global_keys(cui, c))
343                         continue;
344
345                 cui->current->process_key(cui->current, c);
346         }
347
348         return 0;
349 }
350
351 /**
352  * cui_process_js - Process joystick events.
353  */
354
355 static int cui_process_js(void *arg)
356 {
357         struct cui *cui = cui_from_arg(arg);
358         int c;
359
360         c = pjs_process_event(cui->pjs);
361
362         if (c) {
363                 ungetch(c);
364                 cui_process_key(arg);
365         }
366
367         return 0;
368 }
369
370 /**
371  * cui_handle_resize - Handle the term resize.
372  */
373
374 static void cui_handle_resize(struct cui *cui)
375 {
376         struct winsize ws;
377
378         if (ioctl(1, TIOCGWINSZ, &ws) == -1) {
379                 pb_log("%s: ioctl failed: %s\n", __func__, strerror(errno));
380                 return;
381         }
382
383         pb_debug("%s: {%u,%u}\n", __func__, ws.ws_row, ws.ws_col);
384
385         wclear(cui->current->main_ncw);
386         resize_term(ws.ws_row, ws.ws_col);
387         cui->current->resize(cui->current);
388
389         /* For some reason this makes ncurses redraw the screen */
390         getch();
391         redrawwin(cui->current->main_ncw);
392         wrefresh(cui->current->main_ncw);
393 }
394
395 /**
396  * cui_device_add - Client device_add callback.
397  *
398  * Creates menu_items for all the device boot_options and inserts those
399  * menu_items into the main menu.  Redraws the main menu if it is active.
400  */
401
402 static int cui_boot_option_add(struct device *dev, struct boot_option *opt,
403                 void *arg)
404 {
405         struct cui *cui = cui_from_arg(arg);
406         struct cui_opt_data *cod;
407         unsigned int insert_pt;
408         int result, rows, cols;
409         struct pmenu_item *i;
410         ITEM *selected;
411
412         pb_debug("%s: %p %s\n", __func__, opt, opt->id);
413
414         selected = current_item(cui->main->ncm);
415         menu_format(cui->main->ncm, &rows, &cols);
416
417         if (cui->current == &cui->main->scr)
418                 nc_scr_unpost(cui->current);
419
420         /* Save the item in opt->ui_info for cui_device_remove() */
421
422         opt->ui_info = i = pmenu_item_create(cui->main, opt->name);
423         if (!i)
424                 return -1;
425
426         i->on_edit = cui_item_edit;
427         i->on_execute = cui_boot;
428         i->data = cod = talloc(i, struct cui_opt_data);
429
430         cod->opt = opt;
431         cod->dev = dev;
432         cod->opt_hash = pb_opt_hash(dev, opt);
433         cod->name = opt->name;
434         cod->bd = talloc(i, struct pb_boot_data);
435
436         cod->bd->image = talloc_strdup(cod->bd, opt->boot_image_file);
437         cod->bd->initrd = talloc_strdup(cod->bd, opt->initrd_file);
438         cod->bd->dtb = talloc_strdup(cod->bd, opt->dtb_file);
439         cod->bd->args = talloc_strdup(cod->bd, opt->boot_args);
440
441         /* This disconnects items array from menu. */
442         result = set_menu_items(cui->main->ncm, NULL);
443
444         if (result)
445                 pb_log("%s: set_menu_items failed: %d\n", __func__, result);
446
447         /* Insert new items at insert_pt. */
448         insert_pt = pmenu_grow(cui->main, 1);
449         pmenu_item_insert(cui->main, i, insert_pt);
450
451         pb_log("%s: adding opt '%s'\n", __func__, cod->name);
452         pb_log("   image  '%s'\n", cod->bd->image);
453         pb_log("   initrd '%s'\n", cod->bd->initrd);
454         pb_log("   args   '%s'\n", cod->bd->args);
455
456         /* Re-attach the items array. */
457         result = set_menu_items(cui->main->ncm, cui->main->items);
458
459         if (result)
460                 pb_log("%s: set_menu_items failed: %d\n", __func__, result);
461
462         if (0) {
463                 pb_log("%s\n", __func__);
464                 pmenu_dump_items(cui->main->items,
465                         item_count(cui->main->ncm) + 1);
466         }
467
468         if (!item_visible(selected)) {
469                 int idx, top;
470
471                 top = top_row(cui->main->ncm);
472                 idx = item_index(selected);
473
474                 /* If our index is above the current top row, align
475                  * us to the new top. Otherwise, align us to the new
476                  * bottom */
477                 top = top < idx ? idx - rows : idx;
478
479                 set_top_row(cui->main->ncm, top);
480                 set_current_item(cui->main->ncm, selected);
481         }
482
483         if (cui->current == &cui->main->scr)
484                 nc_scr_post(cui->current);
485
486         return 0;
487 }
488
489 /**
490  * cui_device_remove - Client device remove callback.
491  *
492  * Removes all the menu_items for the device from the main menu and redraws the
493  * main menu if it is active.
494  */
495
496 static void cui_device_remove(struct device *dev, void *arg)
497 {
498         struct cui *cui = cui_from_arg(arg);
499         int result;
500         struct boot_option *opt;
501
502         pb_log("%s: %p %s\n", __func__, dev, dev->id);
503
504         if (cui->current == &cui->main->scr)
505                 nc_scr_unpost(cui->current);
506
507         /* This disconnects items array from menu. */
508
509         result = set_menu_items(cui->main->ncm, NULL);
510
511         if (result)
512                 pb_log("%s: set_menu_items failed: %d\n", __func__, result);
513
514         list_for_each_entry(&dev->boot_options, opt, list) {
515                 struct pmenu_item *i = pmenu_item_from_arg(opt->ui_info);
516
517                 assert(pb_protocol_device_cmp(dev, cod_from_item(i)->dev));
518                 pmenu_remove(cui->main, i);
519         }
520
521         /* Re-attach the items array. */
522
523         result = set_menu_items(cui->main->ncm, cui->main->items);
524
525         if (result)
526                 pb_log("%s: set_menu_items failed: %d\n", __func__, result);
527
528         if (0) {
529                 pb_log("%s\n", __func__);
530                 pmenu_dump_items(cui->main->items,
531                         item_count(cui->main->ncm) + 1);
532         }
533
534         if (cui->current == &cui->main->scr)
535                 nc_scr_post(cui->current);
536 }
537
538 static void cui_update_status(struct boot_status *status, void *arg)
539 {
540         struct cui *cui = cui_from_arg(arg);
541
542         nc_scr_status_printf(cui->current,
543                         "%s: %s",
544                         status->type == BOOT_STATUS_ERROR ? "Error" : "Info",
545                         status->message);
546
547 }
548
549 static void cui_update_mm_title(struct cui *cui)
550 {
551         struct nc_frame *frame = &cui->main->scr.frame;
552
553         talloc_free(frame->rtitle);
554
555         frame->rtitle = talloc_strdup(cui->main, cui->sysinfo->type);
556         if (cui->sysinfo->identifier)
557                 frame->rtitle = talloc_asprintf_append(frame->rtitle,
558                                 " %s", cui->sysinfo->identifier);
559
560         if (cui->current == &cui->main->scr)
561                 nc_scr_post(cui->current);
562 }
563
564 static void cui_update_sysinfo(struct system_info *sysinfo, void *arg)
565 {
566         struct cui *cui = cui_from_arg(arg);
567         cui->sysinfo = talloc_steal(cui, sysinfo);
568
569         /* if we're currently displaying the system info screen, inform it
570          * of the updated information. */
571         if (cui->sysinfo_screen)
572                 sysinfo_screen_update(cui->sysinfo_screen, sysinfo);
573
574         /* ... and do the same with the config screen... */
575         if (cui->config_screen)
576                 config_screen_update(cui->config_screen, cui->config, sysinfo);
577
578         /* ... and the boot editor. */
579         if (cui->boot_editor)
580                 boot_editor_update(cui->boot_editor, sysinfo);
581
582         cui_update_mm_title(cui);
583 }
584
585 static void cui_update_config(struct config *config, void *arg)
586 {
587         struct cui *cui = cui_from_arg(arg);
588         cui->config = talloc_steal(cui, config);
589
590         if (cui->config_screen)
591                 config_screen_update(cui->config_screen, config, cui->sysinfo);
592 }
593
594 int cui_send_config(struct cui *cui, struct config *config)
595 {
596         return discover_client_send_config(cui->client, config);
597 }
598
599 void cui_send_reinit(struct cui *cui)
600 {
601         discover_client_send_reinit(cui->client);
602 }
603
604 static struct discover_client_ops cui_client_ops = {
605         .device_add = NULL,
606         .boot_option_add = cui_boot_option_add,
607         .device_remove = cui_device_remove,
608         .update_status = cui_update_status,
609         .update_sysinfo = cui_update_sysinfo,
610         .update_config = cui_update_config,
611 };
612
613 /**
614  * cui_init - Setup the cui instance.
615  * @platform_info: A value for the struct cui platform_info member.
616  *
617  * Returns a pointer to a struct cui on success, or NULL on error.
618  *
619  * Allocates the cui instance, sets up the client and stdin waiters, and
620  * sets up the ncurses menu screen.
621  */
622
623 struct cui *cui_init(void* platform_info,
624         int (*js_map)(const struct js_event *e), int start_deamon)
625 {
626         struct cui *cui;
627         unsigned int i;
628
629         cui = talloc_zero(NULL, struct cui);
630
631         if (!cui) {
632                 pb_log("%s: alloc cui failed.\n", __func__);
633                 fprintf(stderr, "%s: alloc cui failed.\n", __func__);
634                 goto fail_alloc;
635         }
636
637         cui->c_sig = pb_cui_sig;
638         cui->platform_info = platform_info;
639         cui->waitset = waitset_create(cui);
640
641         process_init(cui, cui->waitset, false);
642
643         setlocale(LC_ALL, "");
644
645         /* Loop here for scripts that just started the server. */
646
647 retry_start:
648         for (i = start_deamon ? 2 : 10; i; i--) {
649                 cui->client = discover_client_init(cui->waitset,
650                                 &cui_client_ops, cui);
651                 if (cui->client || !i)
652                         break;
653                 pb_log("%s: waiting for server %d\n", __func__, i);
654                 sleep(1);
655         }
656
657         if (!cui->client && start_deamon) {
658                 int result;
659
660                 start_deamon = 0;
661
662                 result = pb_start_daemon(cui);
663
664                 if (!result)
665                         goto retry_start;
666
667                 pb_log("%s: discover_client_init failed.\n", __func__);
668                 fprintf(stderr, "%s: error: discover_client_init failed.\n",
669                         __func__);
670                 fprintf(stderr, "could not start pb-discover, the petitboot "
671                         "daemon.\n");
672                 goto fail_client_init;
673         }
674
675         if (!cui->client) {
676                 pb_log("%s: discover_client_init failed.\n", __func__);
677                 fprintf(stderr, "%s: error: discover_client_init failed.\n",
678                         __func__);
679                 fprintf(stderr, "check that pb-discover, "
680                         "the petitboot daemon is running.\n");
681                 goto fail_client_init;
682         }
683
684         atexit(cui_atexit);
685         talloc_steal(cui, cui->client);
686         cui_start();
687
688         waiter_register_io(cui->waitset, STDIN_FILENO, WAIT_IN,
689                         cui_process_key, cui);
690
691         if (js_map) {
692
693                 cui->pjs = pjs_init(cui, js_map);
694
695                 if (cui->pjs)
696                         waiter_register_io(cui->waitset, pjs_get_fd(cui->pjs),
697                                         WAIT_IN, cui_process_js, cui);
698         }
699
700         return cui;
701
702 fail_client_init:
703         talloc_free(cui);
704 fail_alloc:
705         return NULL;
706 }
707
708 /**
709  * cui_run - The main cui program loop.
710  * @cui: The cui instance.
711  * @main: The menu to use as the main menu.
712  *
713  * Runs the cui engine.  Does not return until indicated to do so by some
714  * user action, or an error occurs.  Frees the cui object on return.
715  * Returns 0 on success (return to shell), -1 on error (should restart).
716  */
717
718 int cui_run(struct cui *cui, struct pmenu *main, unsigned int default_item)
719 {
720         assert(main);
721
722         cui->main = main;
723         cui->current = &cui->main->scr;
724         cui->default_item = default_item;
725
726         nc_scr_post(cui->current);
727
728         while (1) {
729                 int result = waiter_poll(cui->waitset);
730
731                 if (result < 0) {
732                         pb_log("%s: poll: %s\n", __func__, strerror(errno));
733                         break;
734                 }
735
736                 if (cui->abort)
737                         break;
738
739                 while (cui->resize) {
740                         cui->resize = 0;
741                         cui_handle_resize(cui);
742                 }
743         }
744
745         cui_atexit();
746
747         return cui->abort ? 0 : -1;
748 }