CUI add empty item
[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 #define _GNU_SOURCE
20
21 #include <assert.h>
22 #include <errno.h>
23 #include <stdlib.h>
24 #include <string.h>
25 #include <sys/ioctl.h>
26
27 #include "log/log.h"
28 #include "talloc/talloc.h"
29 #include "waiter/waiter.h"
30 #include "ui/common/discover-client.h"
31 #include "nc-cui.h"
32
33 static struct cui_opt_data *cod_from_item(struct pmenu_item *item)
34 {
35         return item->data;
36 }
37
38 /**
39  * cui_abort - Signal the main cui program loop to exit.
40  *
41  * Sets cui.abort, which causes the cui_run() routine to return.
42  */
43
44 void cui_abort(struct cui *cui)
45 {
46         pb_log("%s: exiting\n", __func__);
47         cui->abort = 1;
48 }
49
50 /**
51  * cui_resize - Signal the main cui program loop to resize
52  *
53  * Called at SIGWINCH.
54  */
55
56 void cui_resize(struct cui *cui)
57 {
58         pb_log("%s: resizing\n", __func__);
59         cui->resize = 1;
60 }
61
62 /**
63  * cui_on_exit - A generic main menu ESC callback.
64  */
65
66 void cui_on_exit(struct pmenu *menu)
67 {
68         cui_abort(cui_from_pmenu(menu));
69 }
70
71 /**
72  * cui_run_cmd - A generic cb to run the supplied command.
73  */
74
75 int cui_run_cmd(struct pmenu_item *item)
76 {
77         int result;
78         struct cui *cui = cui_from_item(item);
79         const char *const *cmd_argv = item->data;
80
81         nc_scr_status_printf(cui->current, "Running %s...", cmd_argv[0]);
82
83         def_prog_mode();
84
85         result = pb_run_cmd(cmd_argv);
86
87         reset_prog_mode();
88         redrawwin(cui->current->main_ncw);
89
90         if (result) {
91                 pb_log("%s: failed: '%s'\n", __func__, cmd_argv[0]);
92                 nc_scr_status_printf(cui->current, "Failed: %s", cmd_argv[0]);
93         }
94
95         return result;
96 }
97
98 /**
99  * cui_run_kexec - A generic cb to run kexec.
100  */
101
102 static int cui_run_kexec(struct pmenu_item *item)
103 {
104         int result;
105         struct cui *cui = cui_from_item(item);
106         struct cui_opt_data *cod = cod_from_item(item);
107
108         assert(cui->current == &cui->main->scr);
109         assert(cui->on_kexec);
110
111         pb_log("%s: %s\n", __func__, cod->name);
112         nc_scr_status_printf(cui->current, "Booting %s...", cod->name);
113
114         def_prog_mode();
115
116         result = cui->on_kexec(cui, cod);
117
118         reset_prog_mode();
119         redrawwin(cui->current->main_ncw);
120
121         if (!result) {
122                 clear();
123                 mvaddstr(1, 0, "system is going down now...");
124                 refresh();
125                 sleep(60);
126         }
127
128         pb_log("%s: failed: %s\n", __func__, cod->kd->image);
129         nc_scr_status_printf(cui->current, "Failed: kexec %s", cod->kd->image);
130
131         return 0;
132 }
133
134 /**
135  * cui_ked_on_exit - The ked on_exit callback.
136  */
137
138 static void cui_ked_on_exit(struct ked *ked, enum ked_result ked_result,
139         struct pb_kexec_data *kd)
140 {
141         struct cui *cui = cui_from_arg(ked->scr.ui_ctx);
142
143         if (ked_result == ked_update || ked_result == ked_boot) {
144                 struct pmenu_item *i = pmenu_find_selected(cui->main);
145                 struct cui_opt_data *cod = cod_from_item(i);
146
147                 assert(kd);
148
149                 talloc_steal(i, kd);
150                 talloc_free(cod->kd);
151                 cod->kd = kd;
152
153                 pb_log("%s: updating opt '%s'\n", __func__, cod->name);
154                 pb_log(" image  '%s'\n", cod->kd->image);
155                 pb_log(" initrd '%s'\n", cod->kd->initrd);
156                 pb_log(" args   '%s'\n", cod->kd->args);
157         }
158
159         cui_set_current(cui, &cui->main->scr);
160
161         talloc_free(ked);
162
163         if (ked_result == ked_boot) {
164                 struct pmenu_item *i = pmenu_find_selected(cui->main);
165                 i->on_execute(i);
166         }
167 }
168
169 int cui_ked_run(struct pmenu_item *item)
170 {
171         struct cui *cui = cui_from_item(item);
172         struct ked *ked;
173
174         ked = ked_init(cui, cod_from_item(item)->kd, cui_ked_on_exit);
175
176         cui_set_current(cui, &ked->scr);
177
178         return 0;
179 }
180
181 /**
182  * cui_set_current - Set the currently active screen and redraw it.
183  */
184
185 struct nc_scr *cui_set_current(struct cui *cui, struct nc_scr *scr)
186 {
187         struct nc_scr *old;
188
189         DBGS("%p -> %p\n", cui->current, scr);
190
191         assert(cui->current != scr);
192
193         old = cui->current;
194         old->unpost(old);
195
196         cui->current = scr;
197         cui->current->post(cui->current);
198
199         return old;
200 }
201
202 static int cui_process_key(void *arg)
203 {
204         struct cui *cui = cui_from_arg(arg);
205
206         assert(cui->current);
207
208         ui_timer_disable(&cui->timer);
209         cui->current->process_key(cui->current);
210
211         return 0;
212 }
213
214 /**
215  * cui_client_process_socket - Process a socket event from the discover server.
216  */
217
218 static int cui_client_process_socket(void *arg)
219 {
220         struct discover_client *client = arg;
221
222         discover_client_process(client);
223         return 0;
224 }
225
226 /**
227  * cui_handle_timeout - Handle the timeout.
228  */
229
230 static void cui_handle_timeout(struct ui_timer *timer)
231 {
232         struct cui *cui = cui_from_timer(timer);
233         struct pmenu_item *i = pmenu_find_selected(cui->main);
234
235 #if defined(DEBUG)
236         {
237                 struct cui_opt_data *cod = cod_from_item(i);
238                 assert(cod && (cod->opt_hash == cui->default_item));
239         }
240 #endif
241         i->on_execute(i);
242 }
243
244 /**
245  * cui_handle_resize - Handle the term resize.
246  */
247
248 static void cui_handle_resize(struct cui *cui)
249 {
250         struct winsize ws;
251
252         if (ioctl(1, TIOCGWINSZ, &ws) == -1) {
253                 pb_log("%s: ioctl failed: %s\n", __func__, strerror(errno));
254                 return;
255         }
256
257         pb_log("%s: {%u,%u}\n", __func__, ws.ws_row, ws.ws_col);
258
259         wclear(cui->current->main_ncw);
260         resize_term(ws.ws_row, ws.ws_col);
261         cui->current->resize(cui->current);
262
263         /* For some reason this makes ncurses redraw the screen */
264         getch();
265         redrawwin(cui->current->main_ncw);
266         wrefresh(cui->current->main_ncw);
267 }
268
269 /**
270  * cui_on_open - Open new item callback.
271  */
272
273 void cui_on_open(struct pmenu *menu)
274 {
275         unsigned int insert_pt;
276         struct pmenu_item *i;
277         struct cui_opt_data *cod;
278         char *name;
279
280         menu->scr.unpost(&menu->scr);
281
282         /* This disconnects items array from menu. */
283
284         set_menu_items(menu->ncm, NULL);
285
286         /* Insert new items at insert_pt. */
287
288         insert_pt = pmenu_grow(menu, 1);
289         i = pmenu_item_alloc(menu);
290
291         name = talloc_asprintf(i, "User item %u:", insert_pt);
292         pmenu_item_setup(menu, i, insert_pt, name, NULL);
293
294         i->on_edit = cui_ked_run;
295         i->on_execute = cui_run_kexec;
296         i->data = cod = talloc_zero(i, struct cui_opt_data);
297
298         cod->kd = talloc_zero(i, struct pb_kexec_data);
299         cod->name = name;
300
301         /* Re-attach the items array. */
302
303         set_menu_items(menu->ncm, menu->items);
304
305         set_current_item(menu->ncm, i->nci);
306         menu->scr.post(&menu->scr);
307         pos_menu_cursor(menu->ncm);
308
309         i->on_edit(i);
310 }
311
312 /**
313  * cui_device_add - Client device_add callback.
314  *
315  * Creates menu_items for all the device boot_options and inserts those
316  * menu_items into the main menu.  Redraws the main menu if it is active.
317  */
318
319 static int cui_device_add(struct device *dev, void *arg)
320 {
321         struct cui *cui = cui_from_arg(arg);
322         int result;
323         struct boot_option *opt;
324         unsigned int o_count; /* device opts */
325         unsigned int insert_pt;
326         ITEM *selected;
327
328         pb_log("%s: %p %s\n", __func__, dev, dev->id);
329
330         selected = current_item(cui->main->ncm);
331
332         if (cui->current == &cui->main->scr)
333                 cui->current->unpost(cui->current);
334
335         /* This disconnects items array from menu. */
336
337         result = set_menu_items(cui->main->ncm, NULL);
338
339         if (result)
340                 pb_log("%s: set_menu_items failed: %d\n", __func__, result);
341
342         o_count = 0;
343         list_for_each_entry(&dev->boot_options, opt, list)
344                 o_count++;
345
346         /* Insert new items at insert_pt. */
347
348         insert_pt = pmenu_grow(cui->main, o_count);
349
350         list_for_each_entry(&dev->boot_options, opt, list) {
351                 struct pmenu_item *i;
352                 struct cui_opt_data *cod;
353                 char *name;
354                 char *description;
355
356                 /* Save the item in opt->ui_info for cui_device_remove() */
357
358                 opt->ui_info = i = pmenu_item_alloc(cui->main);
359
360                 name = talloc_asprintf(i, "%s: %s", opt->name,
361                         opt->description);
362
363                 description = talloc_asprintf(i,
364                         " kexec: image='%s' initrd='%s' args='%s'",
365                         opt->boot_image_file,
366                         opt->initrd_file,
367                         opt->boot_args);
368
369                 pmenu_item_setup(cui->main, i, insert_pt, name, description);
370
371                 i->on_edit = cui_ked_run;
372                 i->on_execute = cui_run_kexec;
373                 i->data = cod = talloc(i, struct cui_opt_data);
374
375                 cod->dev = dev;
376                 cod->opt = opt;
377                 cod->opt_hash = pb_opt_hash(dev, opt);
378                 cod->name = opt->name;
379                 cod->kd = talloc(i, struct pb_kexec_data);
380
381                 cod->kd->image = talloc_strdup(cod->kd, opt->boot_image_file);
382                 cod->kd->initrd = talloc_strdup(cod->kd, opt->initrd_file);
383                 cod->kd->args = talloc_strdup(cod->kd, opt->boot_args);
384
385                 insert_pt++;
386
387                 pb_log("%s: adding opt '%s'\n", __func__, cod->name);
388                 pb_log("   image  '%s'\n", cod->kd->image);
389                 pb_log("   initrd '%s'\n", cod->kd->initrd);
390                 pb_log("   args   '%s'\n", cod->kd->args);
391
392                 /* If this is the default_item select it and start timer. */
393
394                 if (cod->opt_hash == cui->default_item) {
395                         selected = i->nci;
396                         ui_timer_kick(&cui->timer);
397                 }
398         }
399
400         /* Re-attach the items array. */
401
402         result = set_menu_items(cui->main->ncm, cui->main->items);
403
404         if (result)
405                 pb_log("%s: set_menu_items failed: %d\n", __func__, result);
406
407         if (0) {
408                 pb_log("%s\n", __func__);
409                 pmenu_dump_items(cui->main->items,
410                         item_count(cui->main->ncm) + 1);
411         }
412
413         /* FIXME: need to make item visible somehow */
414         menu_driver(cui->main->ncm, REQ_SCR_UPAGE);
415         menu_driver(cui->main->ncm, REQ_SCR_DPAGE);
416         set_current_item(cui->main->ncm, selected);
417
418         if (cui->current == &cui->main->scr)
419                 cui->current->post(cui->current);
420
421         return 0;
422 }
423
424 /**
425  * cui_device_remove - Client device remove callback.
426  *
427  * Removes all the menu_items for the device from the main menu and redraws the
428  * main menu if it is active.
429  */
430
431 static void cui_device_remove(struct device *dev, void *arg)
432 {
433         struct cui *cui = cui_from_arg(arg);
434         int result;
435         struct boot_option *opt;
436
437         pb_log("%s: %p %s\n", __func__, dev, dev->id);
438
439         if (cui->current == &cui->main->scr)
440                 cui->current->unpost(cui->current);
441
442         /* This disconnects items array from menu. */
443
444         result = set_menu_items(cui->main->ncm, NULL);
445
446         if (result)
447                 pb_log("%s: set_menu_items failed: %d\n", __func__, result);
448
449         list_for_each_entry(&dev->boot_options, opt, list) {
450                 struct pmenu_item *i = pmenu_item_from_arg(opt->ui_info);
451                 struct cui_opt_data *cod = cod_from_item(i);
452
453                 assert(pb_protocol_device_cmp(dev, cod->dev));
454                 pmenu_remove(cui->main, i);
455
456                 /* If this is the default_item disable timer. */
457
458                 if (cod->opt_hash == cui->default_item)
459                         ui_timer_disable(&cui->timer);
460         }
461
462         /* Re-attach the items array. */
463
464         result = set_menu_items(cui->main->ncm, cui->main->items);
465
466         if (result)
467                 pb_log("%s: set_menu_items failed: %d\n", __func__, result);
468
469         if (0) {
470                 pb_log("%s\n", __func__);
471                 pmenu_dump_items(cui->main->items,
472                         item_count(cui->main->ncm) + 1);
473         }
474
475         if (cui->current == &cui->main->scr)
476                 cui->current->post(cui->current);
477 }
478
479 static struct discover_client_ops cui_client_ops = {
480         .device_add = cui_device_add,
481         .device_remove = cui_device_remove,
482 };
483
484 /**
485  * cui_init - Setup the cui instance.
486  * @platform_info: A value for the struct cui platform_info member.
487  *
488  * Returns a pointer to a struct cui on success, or NULL on error.
489  *
490  * Allocates the cui instance, sets up the client and stdin waiters, and
491  * sets up the ncurses menu screen.
492  */
493
494 struct cui *cui_init(void* platform_info,
495         int (*on_kexec)(struct cui *, struct cui_opt_data *))
496 {
497         struct cui *cui;
498         struct discover_client *client;
499         unsigned int i;
500
501         cui = talloc_zero(NULL, struct cui);
502
503         if (!cui) {
504                 pb_log("%s: alloc cui failed.\n", __func__);
505                 fprintf(stderr, "%s: alloc cui failed.\n", __func__);
506                 goto fail_alloc;
507         }
508
509         cui->c_sig = pb_cui_sig;
510         cui->platform_info = platform_info;
511         cui->on_kexec = on_kexec;
512         cui->timer.handle_timeout = cui_handle_timeout;
513
514         /* Loop here for scripts that just started the server. */
515
516         for (i = 10; i; i--) {
517                 client = discover_client_init(&cui_client_ops, cui);
518                 if (client)
519                         break;
520                 pb_log("%s: waiting for server %d\n", __func__, i);
521                 sleep(1);
522         }
523
524         if (!client) {
525                 pb_log("%s: discover_client_init failed.\n", __func__);
526                 fprintf(stderr, "%s: error: discover_client_init failed.\n",
527                         __func__);
528                 fprintf(stderr, "check that pb-discover, "
529                         "the petitboot daemon is running.\n");
530                 goto fail_client_init;
531         }
532
533         atexit(nc_atexit);
534         nc_start();
535
536         waiter_register(discover_client_get_fd(client), WAIT_IN,
537                 cui_client_process_socket, client);
538
539         waiter_register(STDIN_FILENO, WAIT_IN, cui_process_key, cui);
540
541         return cui;
542
543 fail_client_init:
544         talloc_free(cui);
545 fail_alloc:
546         return NULL;
547 }
548
549 /**
550  * cui_run - The main cui program loop.
551  * @cui: The cui instance.
552  * @main: The menu to use as the main menu.
553  *
554  * Runs the cui engine.  Does not return until indicated to do so by some
555  * user action, or an error occurs.  Frees the cui object on return.
556  * Returns 0 on success (return to shell), -1 on error (should restart).
557  */
558
559 int cui_run(struct cui *cui, struct pmenu *main, unsigned int default_item)
560 {
561         assert(main);
562
563         cui->main = main;
564         cui->current = &cui->main->scr;
565         cui->default_item = default_item;
566
567         cui->current->post(cui->current);
568
569         while (1) {
570                 int result = waiter_poll();
571
572                 if (result < 0 && errno != EINTR) {
573                         pb_log("%s: poll: %s\n", __func__, strerror(errno));
574                         break;
575                 }
576
577                 if (cui->abort)
578                         break;
579
580                 ui_timer_process_sig(&cui->timer);
581
582                 while (cui->resize) {
583                         cui->resize = 0;
584                         cui_handle_resize(cui);
585                 }
586         }
587
588         nc_atexit();
589
590         return cui->abort ? 0 : -1;
591 }