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