ui/ncurses: Move general nc init code to cui module
[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 #include "config.h"
20
21 #define _GNU_SOURCE
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 "nc-cui.h"
37
38 static struct cui_opt_data *cod_from_item(struct pmenu_item *item)
39 {
40         return item->data;
41 }
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         def_prog_mode();
149
150         result = discover_client_boot(cui->client, NULL, cod->opt, cod->bd);
151
152         reset_prog_mode();
153         redrawwin(cui->current->main_ncw);
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 /**
164  * cui_boot_editor_on_exit - The boot_editor on_exit callback.
165  */
166
167 static void cui_boot_editor_on_exit(struct boot_editor *boot_editor,
168                 enum boot_editor_result boot_editor_result,
169                 struct pb_boot_data *bd)
170 {
171         struct cui *cui = cui_from_pmenu(boot_editor->original_pmenu);
172         struct pmenu_item *item = boot_editor->data;
173         struct cui_opt_data *cod;
174
175         if (boot_editor_result != boot_editor_update) {
176                 cui_set_current(cui, &cui->main->scr);
177                 talloc_free(boot_editor);
178                 return;
179         }
180
181         assert(bd);
182
183         /* Is this was a new item, we'll need to update the menu */
184         if (!item) {
185                 struct pmenu *menu = boot_editor->original_pmenu;
186                 int insert_pt;
187
188                 /* Detach the items array. */
189                 set_menu_items(menu->ncm, NULL);
190
191                 /* Insert new item at insert_pt. */
192                 insert_pt = pmenu_grow(menu, 1);
193                 item = pmenu_item_alloc(menu);
194                 item->on_edit = cui_item_edit;
195                 item->on_execute = cui_boot;
196                 item->data = cod = talloc_zero(item, struct cui_opt_data);
197
198                 cod->name = talloc_asprintf(cod, "User item %u:", insert_pt);
199                 pmenu_item_setup(menu, item, insert_pt,
200                                 talloc_strdup(item, cod->name));
201
202                 /* Re-attach the items array. */
203                 set_menu_items(menu->ncm, menu->items);
204                 menu->scr.post(&menu->scr);
205         } else {
206                 cod = item->data;
207         }
208
209         cod->bd = talloc_steal(cod, bd);
210
211         /* FIXME: need to make item visible somehow */
212         set_current_item(item->pmenu->ncm, item->nci);
213         cui_set_current(cui, &cui->main->scr);
214         talloc_free(boot_editor);
215 }
216
217 void cui_item_edit(struct pmenu_item *item)
218 {
219         struct cui *cui = cui_from_item(item);
220         struct cui_opt_data *cod = cod_from_item(item);
221         struct boot_editor *boot_editor;
222
223         boot_editor = boot_editor_init(item->pmenu, cod->bd,
224                         cui_boot_editor_on_exit);
225         boot_editor->data = item;
226         cui_set_current(cui, &boot_editor->scr);
227 }
228
229 void cui_item_new(struct pmenu *menu)
230 {
231         struct cui *cui = cui_from_pmenu(menu);
232         struct boot_editor *boot_editor;
233
234         boot_editor = boot_editor_init(menu, NULL,
235                         cui_boot_editor_on_exit);
236         cui_set_current(cui, &boot_editor->scr);
237 }
238
239 /**
240  * cui_set_current - Set the currently active screen and redraw it.
241  */
242
243 struct nc_scr *cui_set_current(struct cui *cui, struct nc_scr *scr)
244 {
245         struct nc_scr *old;
246
247         DBGS("%p -> %p\n", cui->current, scr);
248
249         assert(cui->current != scr);
250
251         old = cui->current;
252         old->unpost(old);
253
254         cui->current = scr;
255         cui->current->post(cui->current);
256
257         return old;
258 }
259
260 static bool process_global_keys(struct cui *cui, int key)
261 {
262         switch (key) {
263         case 0xc:
264                 if (cui->current && cui->current->main_ncw) {
265                         redrawwin(cui->current->main_ncw);
266                         wrefresh(cui->current->main_ncw);
267                 }
268                 return true;
269         }
270         return false;
271 }
272
273 /**
274  * cui_process_key - Process input on stdin.
275  */
276
277 static int cui_process_key(void *arg)
278 {
279         struct cui *cui = cui_from_arg(arg);
280
281         assert(cui->current);
282
283         if (!cui->has_input)
284                 discover_client_cancel_default(cui->client);
285         cui->has_input = true;
286
287         for (;;) {
288                 int c = getch();
289
290                 if (c == ERR)
291                         break;
292
293                 if (process_global_keys(cui, c))
294                         continue;
295
296                 cui->current->process_key(cui->current, c);
297         }
298
299         return 0;
300 }
301
302 /**
303  * cui_process_js - Process joystick events.
304  */
305
306 static int cui_process_js(void *arg)
307 {
308         struct cui *cui = cui_from_arg(arg);
309         int c;
310
311         c = pjs_process_event(cui->pjs);
312
313         if (c) {
314                 ungetch(c);
315                 cui_process_key(arg);
316         }
317
318         return 0;
319 }
320
321 /**
322  * cui_handle_resize - Handle the term resize.
323  */
324
325 static void cui_handle_resize(struct cui *cui)
326 {
327         struct winsize ws;
328
329         if (ioctl(1, TIOCGWINSZ, &ws) == -1) {
330                 pb_log("%s: ioctl failed: %s\n", __func__, strerror(errno));
331                 return;
332         }
333
334         pb_debug("%s: {%u,%u}\n", __func__, ws.ws_row, ws.ws_col);
335
336         wclear(cui->current->main_ncw);
337         resize_term(ws.ws_row, ws.ws_col);
338         cui->current->resize(cui->current);
339
340         /* For some reason this makes ncurses redraw the screen */
341         getch();
342         redrawwin(cui->current->main_ncw);
343         wrefresh(cui->current->main_ncw);
344 }
345
346 /**
347  * cui_device_add - Client device_add callback.
348  *
349  * Creates menu_items for all the device boot_options and inserts those
350  * menu_items into the main menu.  Redraws the main menu if it is active.
351  */
352
353 static int cui_boot_option_add(struct device *dev, struct boot_option *opt,
354                 void *arg)
355 {
356         struct cui *cui = cui_from_arg(arg);
357         struct cui_opt_data *cod;
358         unsigned int insert_pt;
359         struct pmenu_item *i;
360         ITEM *selected;
361         int result;
362
363         pb_debug("%s: %p %s\n", __func__, opt, opt->id);
364
365         selected = current_item(cui->main->ncm);
366
367         if (cui->current == &cui->main->scr)
368                 cui->current->unpost(cui->current);
369
370         /* This disconnects items array from menu. */
371
372         result = set_menu_items(cui->main->ncm, NULL);
373
374         if (result)
375                 pb_log("%s: set_menu_items failed: %d\n", __func__, result);
376
377         /* Insert new items at insert_pt. */
378         insert_pt = pmenu_grow(cui->main, 1);
379
380         /* Save the item in opt->ui_info for cui_device_remove() */
381
382         opt->ui_info = i = pmenu_item_alloc(cui->main);
383
384         i->on_edit = cui_item_edit;
385         i->on_execute = cui_boot;
386         i->data = cod = talloc(i, struct cui_opt_data);
387
388         cod->opt = opt;
389         cod->dev = dev;
390         cod->opt_hash = pb_opt_hash(dev, opt);
391         cod->name = opt->name;
392         cod->bd = talloc(i, struct pb_boot_data);
393
394         cod->bd->image = talloc_strdup(cod->bd, opt->boot_image_file);
395         cod->bd->initrd = talloc_strdup(cod->bd, opt->initrd_file);
396         cod->bd->dtb = talloc_strdup(cod->bd, opt->dtb_file);
397         cod->bd->args = talloc_strdup(cod->bd, opt->boot_args);
398
399         pmenu_item_setup(cui->main, i, insert_pt, cod->name);
400
401         pb_log("%s: adding opt '%s'\n", __func__, cod->name);
402         pb_log("   image  '%s'\n", cod->bd->image);
403         pb_log("   initrd '%s'\n", cod->bd->initrd);
404         pb_log("   args   '%s'\n", cod->bd->args);
405
406         /* Re-attach the items array. */
407         result = set_menu_items(cui->main->ncm, cui->main->items);
408
409         if (result)
410                 pb_log("%s: set_menu_items failed: %d\n", __func__, result);
411
412         if (0) {
413                 pb_log("%s\n", __func__);
414                 pmenu_dump_items(cui->main->items,
415                         item_count(cui->main->ncm) + 1);
416         }
417
418         /* FIXME: need to make item visible somehow */
419         menu_driver(cui->main->ncm, REQ_SCR_UPAGE);
420         menu_driver(cui->main->ncm, REQ_SCR_DPAGE);
421         set_current_item(cui->main->ncm, selected);
422
423         if (cui->current == &cui->main->scr)
424                 cui->current->post(cui->current);
425
426         return 0;
427 }
428
429 /**
430  * cui_device_remove - Client device remove callback.
431  *
432  * Removes all the menu_items for the device from the main menu and redraws the
433  * main menu if it is active.
434  */
435
436 static void cui_device_remove(struct device *dev, void *arg)
437 {
438         struct cui *cui = cui_from_arg(arg);
439         int result;
440         struct boot_option *opt;
441
442         pb_log("%s: %p %s\n", __func__, dev, dev->id);
443
444         if (cui->current == &cui->main->scr)
445                 cui->current->unpost(cui->current);
446
447         /* This disconnects items array from menu. */
448
449         result = set_menu_items(cui->main->ncm, NULL);
450
451         if (result)
452                 pb_log("%s: set_menu_items failed: %d\n", __func__, result);
453
454         list_for_each_entry(&dev->boot_options, opt, list) {
455                 struct pmenu_item *i = pmenu_item_from_arg(opt->ui_info);
456
457                 assert(pb_protocol_device_cmp(dev, cod_from_item(i)->dev));
458                 pmenu_remove(cui->main, i);
459         }
460
461         /* Re-attach the items array. */
462
463         result = set_menu_items(cui->main->ncm, cui->main->items);
464
465         if (result)
466                 pb_log("%s: set_menu_items failed: %d\n", __func__, result);
467
468         if (0) {
469                 pb_log("%s\n", __func__);
470                 pmenu_dump_items(cui->main->items,
471                         item_count(cui->main->ncm) + 1);
472         }
473
474         if (cui->current == &cui->main->scr)
475                 cui->current->post(cui->current);
476 }
477
478 static void cui_update_status(struct boot_status *status, void *arg)
479 {
480         struct cui *cui = cui_from_arg(arg);
481
482         nc_scr_status_printf(cui->current,
483                         "%s: %s",
484                         status->type == BOOT_STATUS_ERROR ? "Error" : "Info",
485                         status->message);
486
487 }
488
489 static void cui_update_mm_title(struct cui *cui)
490 {
491         struct nc_frame *frame = &cui->main->scr.frame;
492
493         talloc_free(frame->rtitle);
494
495         frame->rtitle = talloc_strdup(cui->main, cui->sysinfo->type);
496         if (cui->sysinfo->identifier)
497                 frame->rtitle = talloc_asprintf_append(frame->rtitle,
498                                 " %s", cui->sysinfo->identifier);
499
500         if (cui->current == &cui->main->scr)
501                 cui->current->post(cui->current);
502 }
503
504 static void cui_update_sysinfo(struct system_info *sysinfo, void *arg)
505 {
506         struct cui *cui = cui_from_arg(arg);
507         cui->sysinfo = talloc_steal(cui, sysinfo);
508         cui_update_mm_title(cui);
509 }
510
511 static struct discover_client_ops cui_client_ops = {
512         .device_add = NULL,
513         .boot_option_add = cui_boot_option_add,
514         .device_remove = cui_device_remove,
515         .update_status = cui_update_status,
516         .update_sysinfo = cui_update_sysinfo,
517 };
518
519 /**
520  * cui_init - Setup the cui instance.
521  * @platform_info: A value for the struct cui platform_info member.
522  *
523  * Returns a pointer to a struct cui on success, or NULL on error.
524  *
525  * Allocates the cui instance, sets up the client and stdin waiters, and
526  * sets up the ncurses menu screen.
527  */
528
529 struct cui *cui_init(void* platform_info,
530         int (*js_map)(const struct js_event *e), int start_deamon)
531 {
532         struct cui *cui;
533         unsigned int i;
534
535         cui = talloc_zero(NULL, struct cui);
536
537         if (!cui) {
538                 pb_log("%s: alloc cui failed.\n", __func__);
539                 fprintf(stderr, "%s: alloc cui failed.\n", __func__);
540                 goto fail_alloc;
541         }
542
543         cui->c_sig = pb_cui_sig;
544         cui->platform_info = platform_info;
545         cui->waitset = waitset_create(cui);
546
547         process_init(cui, cui->waitset, false);
548
549         setlocale(LC_ALL, "");
550
551         /* Loop here for scripts that just started the server. */
552
553 retry_start:
554         for (i = start_deamon ? 2 : 10; i; i--) {
555                 cui->client = discover_client_init(cui->waitset,
556                                 &cui_client_ops, cui);
557                 if (cui->client || !i)
558                         break;
559                 pb_log("%s: waiting for server %d\n", __func__, i);
560                 sleep(1);
561         }
562
563         if (!cui->client && start_deamon) {
564                 int result;
565
566                 start_deamon = 0;
567
568                 result = pb_start_daemon(cui);
569
570                 if (!result)
571                         goto retry_start;
572
573                 pb_log("%s: discover_client_init failed.\n", __func__);
574                 fprintf(stderr, "%s: error: discover_client_init failed.\n",
575                         __func__);
576                 fprintf(stderr, "could not start pb-discover, the petitboot "
577                         "daemon.\n");
578                 goto fail_client_init;
579         }
580
581         if (!cui->client) {
582                 pb_log("%s: discover_client_init failed.\n", __func__);
583                 fprintf(stderr, "%s: error: discover_client_init failed.\n",
584                         __func__);
585                 fprintf(stderr, "check that pb-discover, "
586                         "the petitboot daemon is running.\n");
587                 goto fail_client_init;
588         }
589
590         atexit(cui_atexit);
591         cui_start();
592
593         waiter_register_io(cui->waitset, STDIN_FILENO, WAIT_IN,
594                         cui_process_key, cui);
595
596         if (js_map) {
597
598                 cui->pjs = pjs_init(cui, js_map);
599
600                 if (cui->pjs)
601                         waiter_register_io(cui->waitset, pjs_get_fd(cui->pjs),
602                                         WAIT_IN, cui_process_js, cui);
603         }
604
605         return cui;
606
607 fail_client_init:
608         talloc_free(cui);
609 fail_alloc:
610         return NULL;
611 }
612
613 /**
614  * cui_run - The main cui program loop.
615  * @cui: The cui instance.
616  * @main: The menu to use as the main menu.
617  *
618  * Runs the cui engine.  Does not return until indicated to do so by some
619  * user action, or an error occurs.  Frees the cui object on return.
620  * Returns 0 on success (return to shell), -1 on error (should restart).
621  */
622
623 int cui_run(struct cui *cui, struct pmenu *main, unsigned int default_item)
624 {
625         assert(main);
626
627         cui->main = main;
628         cui->current = &cui->main->scr;
629         cui->default_item = default_item;
630
631         cui->current->post(cui->current);
632
633         while (1) {
634                 int result = waiter_poll(cui->waitset);
635
636                 if (result < 0) {
637                         pb_log("%s: poll: %s\n", __func__, strerror(errno));
638                         break;
639                 }
640
641                 if (cui->abort)
642                         break;
643
644                 while (cui->resize) {
645                         cui->resize = 0;
646                         cui_handle_resize(cui);
647                 }
648         }
649
650         cui_atexit();
651
652         return cui->abort ? 0 : -1;
653 }