git.ozlabs.org Git - petitboot/blob - ui/ncurses/nc-boot-editor.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 <string.h>
  25
  26 #include "log/log.h"
  27 #include "talloc/talloc.h"
  28 #include "nc-boot-editor.h"
  29 #include "nc-widgets.h"
  30
  31 struct boot_editor {
  32         struct nc_scr           scr;
  33         struct cui              *cui;
  34         void                    *data;
  35         struct pmenu_item       *item;
  36         void                    (*on_exit)(struct cui *cui,
  37                                         struct pmenu_item *item,
  38                                         struct pb_boot_data *bd);
  39
  40         int                     label_x;
  41         int                     field_x;
  42         int                     scroll_y;
  43
  44         WINDOW                  *pad;
  45         struct nc_widgetset     *widgetset;
  46         struct {
  47                 struct nc_widget_label          *device_l;
  48                 struct nc_widget_select         *device_f;
  49                 struct nc_widget_label          *image_l;
  50                 struct nc_widget_textbox        *image_f;
  51                 struct nc_widget_label          *initrd_l;
  52                 struct nc_widget_textbox        *initrd_f;
  53                 struct nc_widget_label          *dtb_l;
  54                 struct nc_widget_textbox        *dtb_f;
  55                 struct nc_widget_label          *args_l;
  56                 struct nc_widget_textbox        *args_f;
  57                 struct nc_widget_button         *ok_b;
  58                 struct nc_widget_button         *cancel_b;
  59         } widgets;
  60
  61         const char              *selected_device;
  62 };
  63
  64 static struct boot_editor *boot_editor_from_scr(struct nc_scr *scr)
  65 {
  66         struct boot_editor *boot_editor;
  67
  68         assert(scr->sig == pb_boot_editor_sig);
  69         boot_editor = (struct boot_editor *)
  70                 ((char *)scr - (size_t)&((struct boot_editor *)0)->scr);
  71         assert(boot_editor->scr.sig == pb_boot_editor_sig);
  72         return boot_editor;
  73 }
  74
  75 static void pad_refresh(struct boot_editor *boot_editor)
  76 {
  77         int y, x, rows, cols;
  78
  79         getmaxyx(boot_editor->scr.sub_ncw, rows, cols);
  80         getbegyx(boot_editor->scr.sub_ncw, y, x);
  81
  82         prefresh(boot_editor->pad, boot_editor->scroll_y, 0,
  83                         y, x, rows, cols);
  84 }
  85
  86 static struct boot_editor *boot_editor_from_arg(void *arg)
  87 {
  88         struct boot_editor *boot_editor = arg;
  89
  90         assert(boot_editor->scr.sig == pb_boot_editor_sig);
  91         return boot_editor;
  92 }
  93
  94 static int boot_editor_post(struct nc_scr *scr)
  95 {
  96         struct boot_editor *boot_editor = boot_editor_from_scr(scr);
  97
  98         widgetset_post(boot_editor->widgetset);
  99         nc_scr_frame_draw(scr);
 100         pad_refresh(boot_editor);
 101         return 0;
 102 }
 103
 104 static int boot_editor_unpost(struct nc_scr *scr)
 105 {
 106         widgetset_unpost(boot_editor_from_scr(scr)->widgetset);
 107         return 0;
 108 }
 109
 110 struct nc_scr *boot_editor_scr(struct boot_editor *boot_editor)
 111 {
 112         return &boot_editor->scr;
 113 }
 114
 115 static void boot_editor_resize(struct nc_scr *scr)
 116 {
 117         /* FIXME: forms can't be resized, need to recreate here */
 118         boot_editor_unpost(scr);
 119         boot_editor_post(scr);
 120 }
 121
 122 static char *conditional_prefix(struct pb_boot_data *ctx,
 123                 const char *prefix, const char *value)
 124 {
 125         const char *sep;
 126
 127         if (!value || !*value)
 128                 return NULL;
 129
 130         sep = NULL;
 131         if (!prefix)
 132                 prefix = "";
 133         else if (prefix[strlen(prefix)] != '/')
 134                 sep = "/";
 135
 136         return talloc_asprintf(ctx, "%s%s%s", prefix, sep, value);
 137 }
 138
 139 static struct pb_boot_data *boot_editor_prepare_data(
 140                 struct boot_editor *boot_editor)
 141 {
 142         struct pb_boot_data *bd;
 143         char *s, *prefix;
 144         int idx;
 145
 146         bd = talloc(boot_editor, struct pb_boot_data);
 147
 148         if (!bd)
 149                 return NULL;
 150
 151         idx = widget_select_get_value(boot_editor->widgets.device_f);
 152         if (idx == -1 || (unsigned int)idx >
 153                         boot_editor->cui->sysinfo->n_blockdevs)
 154                 prefix = NULL;
 155         else
 156                 prefix = boot_editor->cui->sysinfo->blockdevs[idx]->mountpoint;
 157
 158         s = widget_textbox_get_value(boot_editor->widgets.image_f);
 159         bd->image = conditional_prefix(bd, prefix, s);
 160
 161         s = widget_textbox_get_value(boot_editor->widgets.initrd_f);
 162         bd->initrd = conditional_prefix(bd, prefix, s);
 163
 164         s = widget_textbox_get_value(boot_editor->widgets.dtb_f);
 165         bd->dtb = conditional_prefix(bd, prefix, s);
 166
 167         s = widget_textbox_get_value(boot_editor->widgets.args_f);
 168         bd->args = *s ? talloc_strdup(bd, s) : NULL;
 169
 170         return bd;
 171 }
 172
 173 /**
 174  * boot_editor_process_key - Process a user keystroke.
 175  *
 176  * Called from the cui via the scr:process_key method.
 177  */
 178
 179 static void boot_editor_process_key(struct nc_scr *scr, int key)
 180 {
 181         struct boot_editor *boot_editor = boot_editor_from_scr(scr);
 182         bool handled;
 183
 184         handled = widgetset_process_key(boot_editor->widgetset, key);
 185         if (handled) {
 186                 pad_refresh(boot_editor);
 187                 return;
 188         }
 189
 190         switch (key) {
 191         case 'x':
 192         case 27: /* ESC */
 193                 boot_editor->on_exit(boot_editor->cui, NULL, NULL);
 194                 nc_flush_keys();
 195         }
 196 }
 197
 198 /**
 199  * boot_editor_destructor - The talloc destructor for a boot_editor.
 200  */
 201
 202 static int boot_editor_destructor(void *arg)
 203 {
 204         struct boot_editor *boot_editor = boot_editor_from_arg(arg);
 205         boot_editor->scr.sig = pb_removed_sig;
 206         if (boot_editor->pad)
 207                 delwin(boot_editor->pad);
 208         return 0;
 209 }
 210
 211 static void ok_click(void *arg)
 212 {
 213         struct boot_editor *boot_editor = arg;
 214         struct pb_boot_data *bd;
 215
 216         bd = boot_editor_prepare_data(boot_editor);
 217         boot_editor->on_exit(boot_editor->cui, boot_editor->item, bd);
 218 }
 219
 220 static void cancel_click(void *arg)
 221 {
 222         struct boot_editor *boot_editor = arg;
 223         boot_editor->on_exit(boot_editor->cui, NULL, NULL);
 224 }
 225
 226 static int layout_pair(struct boot_editor *boot_editor, int y,
 227                 struct nc_widget_label *label,
 228                 struct nc_widget_textbox *field)
 229 {
 230         struct nc_widget *label_w = widget_label_base(label);
 231         struct nc_widget *field_w = widget_textbox_base(field);
 232         widget_move(label_w, y, boot_editor->label_x);
 233         widget_move(field_w, y, boot_editor->field_x);
 234         return max(widget_height(label_w), widget_height(field_w));
 235 }
 236
 237 static int pad_height(int blockdevs_height)
 238 {
 239         return 10 + blockdevs_height;
 240 }
 241
 242 static void boot_editor_layout_widgets(struct boot_editor *boot_editor)
 243 {
 244         struct nc_widget *wf, *wl;
 245         int y = 1;
 246
 247         wl = widget_label_base(boot_editor->widgets.device_l);
 248         wf = widget_select_base(boot_editor->widgets.device_f);
 249         widget_move(wl, y, boot_editor->label_x);
 250         widget_move(wf, y, boot_editor->field_x);
 251
 252         y += widget_height(wf) + 1;
 253
 254
 255         y += layout_pair(boot_editor, y, boot_editor->widgets.image_l,
 256                                          boot_editor->widgets.image_f);
 257
 258         y += layout_pair(boot_editor, y, boot_editor->widgets.initrd_l,
 259                                          boot_editor->widgets.initrd_f);
 260
 261         y += layout_pair(boot_editor, y, boot_editor->widgets.dtb_l,
 262                                          boot_editor->widgets.dtb_f);
 263
 264         y += layout_pair(boot_editor, y, boot_editor->widgets.args_l,
 265                                          boot_editor->widgets.args_f);
 266
 267
 268         y++;
 269         widget_move(widget_button_base(boot_editor->widgets.ok_b), y, 9);
 270         widget_move(widget_button_base(boot_editor->widgets.cancel_b), y, 19);
 271
 272         pad_refresh(boot_editor);
 273 }
 274
 275 static void boot_editor_widget_focus(struct nc_widget *widget, void *arg)
 276 {
 277         struct boot_editor *boot_editor = arg;
 278         int w_y, s_max;
 279
 280         w_y = widget_y(widget) + widget_focus_y(widget);
 281         s_max = getmaxy(boot_editor->scr.sub_ncw) - 1;
 282
 283         if (w_y < boot_editor->scroll_y)
 284                 boot_editor->scroll_y = w_y;
 285
 286         else if (w_y + boot_editor->scroll_y + 1 > s_max)
 287                 boot_editor->scroll_y = 1 + w_y - s_max;
 288
 289         else
 290                 return;
 291
 292         pad_refresh(boot_editor);
 293 }
 294
 295 static void boot_editor_device_select_change(void *arg, int idx)
 296 {
 297         struct boot_editor *boot_editor = arg;
 298         if (idx == -1)
 299                 boot_editor->selected_device = NULL;
 300         else
 301                 boot_editor->selected_device =
 302                         boot_editor->cui->sysinfo->blockdevs[idx]->name;
 303 }
 304
 305 static void boot_editor_populate_device_select(struct boot_editor *boot_editor,
 306                 const struct system_info *sysinfo)
 307 {
 308         struct nc_widget_select *select = boot_editor->widgets.device_f;
 309         unsigned int i;
 310         bool selected;
 311
 312         widget_select_drop_options(select);
 313
 314         for (i = 0; i < sysinfo->n_blockdevs; i++) {
 315                 struct blockdev_info *bd_info = sysinfo->blockdevs[i];
 316                 const char *name;
 317
 318                 name = talloc_asprintf(boot_editor, "%s [%s]",
 319                                 bd_info->name, bd_info->uuid);
 320                 selected = boot_editor->selected_device &&
 321                                 !strcmp(bd_info->name,
 322                                                 boot_editor->selected_device);
 323
 324                 widget_select_add_option(boot_editor->widgets.device_f,
 325                                 i, name, selected);
 326         }
 327
 328         /* If we're editing an existing option, the paths will be fully-
 329          * resolved. In this case, we want the manual device pre-selected.
 330          * However, we only do this if the widget hasn't been manually
 331          * changed. */
 332         selected = !boot_editor->selected_device;
 333
 334         widget_select_add_option(boot_editor->widgets.device_f,
 335                         -1, "Specify paths/URLs manually", selected);
 336 }
 337
 338 static bool path_on_device(struct blockdev_info *bd_info,
 339                 const char *path)
 340 {
 341         int len;
 342
 343         if (!bd_info->mountpoint)
 344                 return false;
 345
 346         len = strlen(bd_info->mountpoint);
 347         if (strncmp(bd_info->mountpoint, path, len))
 348                 return false;
 349
 350         /* if the mountpoint doesn't have a trailing slash, ensure that
 351          * the path starts with one (so we don't match a "/mnt/sda1/foo" path
 352          * on a "/mnt/sda" mountpoint) */
 353         return bd_info->mountpoint[len-1] == '/' || path[len] == '/';
 354 }
 355
 356
 357 static void boot_editor_find_device(struct boot_editor *boot_editor,
 358                 struct pb_boot_data *bd, const struct system_info *sysinfo,
 359                 char **image, char **initrd, char **dtb)
 360 {
 361         struct blockdev_info *bd_info, *tmp;
 362         unsigned int i, len;
 363
 364         if (!sysinfo || !sysinfo->n_blockdevs)
 365                 return;
 366
 367         /* find the device for our boot image, by finding the longest
 368          * matching blockdev's mountpoint */
 369         for (len = 0, i = 0, bd_info = NULL; i < sysinfo->n_blockdevs; i++) {
 370                 tmp = sysinfo->blockdevs[i];
 371                 if (!path_on_device(tmp, bd->image))
 372                         continue;
 373                 if (strlen(tmp->mountpoint) <= len)
 374                         continue;
 375                 bd_info = tmp;
 376                 len = strlen(tmp->mountpoint);
 377         }
 378
 379         if (!bd_info)
 380                 return;
 381
 382         /* ensure that other paths are on this device */
 383         if (bd->initrd && !path_on_device(bd_info, bd->initrd))
 384                 return;
 385
 386         if (bd->dtb && !path_on_device(bd_info, bd->dtb))
 387                 return;
 388
 389         /* ok, we match; preselect the device option, and remove the common
 390          * prefix */
 391         boot_editor->selected_device = bd_info->name;
 392         *image += len;
 393
 394         if (*initrd)
 395                 *initrd += len;
 396         if (*dtb)
 397                 *dtb += len;
 398 }
 399
 400 struct boot_editor *boot_editor_init(struct cui *cui,
 401                 struct pmenu_item *item,
 402                 const struct system_info *sysinfo,
 403                 void (*on_exit)(struct cui *cui,
 404                                 struct pmenu_item *item,
 405                                 struct pb_boot_data *bd))
 406 {
 407         char *image, *initrd, *dtb, *args;
 408         struct boot_editor *boot_editor;
 409         struct nc_widgetset *set;
 410         int field_size;
 411
 412         (void)sysinfo;
 413
 414         boot_editor = talloc_zero(cui, struct boot_editor);
 415
 416         if (!boot_editor)
 417                 return NULL;
 418
 419         talloc_set_destructor(boot_editor, boot_editor_destructor);
 420         boot_editor->cui = cui;
 421         boot_editor->item = item;
 422         boot_editor->on_exit = on_exit;
 423
 424         boot_editor->label_x = 1;
 425         boot_editor->field_x = 9;
 426
 427         nc_scr_init(&boot_editor->scr, pb_boot_editor_sig, 0,
 428                         cui, boot_editor_process_key,
 429                 boot_editor_post, boot_editor_unpost, boot_editor_resize);
 430
 431         boot_editor->scr.frame.ltitle = talloc_strdup(boot_editor,
 432                         "Petitboot Option Editor");
 433         boot_editor->scr.frame.rtitle = NULL;
 434         boot_editor->scr.frame.help = talloc_strdup(boot_editor,
 435                         "Enter=accept");
 436
 437         if (item) {
 438                 struct pb_boot_data *bd = cod_from_item(item)->bd;
 439                 image = bd->image;
 440                 initrd = bd->initrd;
 441                 dtb = bd->dtb;
 442                 args = bd->args;
 443                 boot_editor_find_device(boot_editor, bd, sysinfo,
 444                                 &image, &initrd, &dtb);
 445         } else {
 446                 image = initrd = dtb = args = "";
 447         }
 448
 449         field_size = COLS - 1 - boot_editor->field_x;
 450
 451         boot_editor->pad = newpad(pad_height(sysinfo->n_blockdevs), COLS);
 452
 453         boot_editor->widgetset = set = widgetset_create(boot_editor,
 454                         boot_editor->scr.main_ncw,
 455                         boot_editor->pad);
 456
 457         widgetset_set_widget_focus(boot_editor->widgetset,
 458                         boot_editor_widget_focus, boot_editor);
 459
 460         boot_editor->widgets.device_l = widget_new_label(set, 0, 0, "device:");
 461         boot_editor->widgets.device_f = widget_new_select(set, 0, 0,
 462                                                 field_size);
 463         widget_select_on_change(boot_editor->widgets.device_f,
 464                         boot_editor_device_select_change, boot_editor);
 465
 466         boot_editor_populate_device_select(boot_editor, sysinfo);
 467
 468         boot_editor->widgets.image_l = widget_new_label(set, 0, 0, "image:");
 469         boot_editor->widgets.image_f = widget_new_textbox(set, 0, 0,
 470                                                 field_size, image);
 471
 472         boot_editor->widgets.initrd_l = widget_new_label(set, 0, 0, "initrd:");
 473         boot_editor->widgets.initrd_f = widget_new_textbox(set, 0, 0,
 474                                                 field_size, initrd);
 475
 476         boot_editor->widgets.dtb_l = widget_new_label(set, 0, 0, "dtb:");
 477         boot_editor->widgets.dtb_f = widget_new_textbox(set, 0, 0,
 478                                                 field_size, dtb);
 479
 480         boot_editor->widgets.args_l = widget_new_label(set, 0, 0, "args:");
 481         boot_editor->widgets.args_f = widget_new_textbox(set, 0, 0,
 482                                         field_size, args);
 483
 484         boot_editor->widgets.ok_b = widget_new_button(set, 0, 0, 6,
 485                                         "OK", ok_click, boot_editor);
 486         boot_editor->widgets.cancel_b = widget_new_button(set, 0, 0, 6,
 487                                         "Cancel", cancel_click, boot_editor);
 488
 489         boot_editor_layout_widgets(boot_editor);
 490
 491         return boot_editor;
 492 }