list.c

   1 /*
   2  * libuci - Library for the Unified Configuration Interface
   3  * Copyright (C) 2008 Felix Fietkau <nbd@openwrt.org>
   4  *
   5  * This program is free software; you can redistribute it and/or modify
   6  * it under the terms of the GNU Lesser General Public License version 2.1
   7  * as published by the Free Software Foundation
   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
  15 static void uci_list_set_pos(struct uci_list *head, struct uci_list *ptr, int pos)
  16 {
  17         struct uci_list *new_head = head;
  18         struct uci_element *p = NULL;
  19
  20         uci_list_del(ptr);
  21         uci_foreach_element(head, p) {
  22                 new_head = &p->list;
  23                 if (pos-- <= 0)
  24                         break;
  25         }
  26         uci_list_add(new_head, ptr);
  27 }
  28
  29 static inline void uci_list_fixup(struct uci_list *ptr)
  30 {
  31         ptr->prev->next = ptr;
  32         ptr->next->prev = ptr;
  33 }
  34
  35 /*
  36  * uci_alloc_generic allocates a new uci_element with payload
  37  * payload is appended to the struct to save memory and reduce fragmentation
  38  */
  39 __private struct uci_element *
  40 uci_alloc_generic(struct uci_context *ctx, int type, const char *name, int size)
  41 {
  42         struct uci_element *e;
  43         int datalen = size;
  44         void *ptr;
  45
  46         ptr = uci_malloc(ctx, datalen);
  47         e = (struct uci_element *) ptr;
  48         e->type = type;
  49         if (name) {
  50                 UCI_TRAP_SAVE(ctx, error);
  51                 e->name = uci_strdup(ctx, name);
  52                 UCI_TRAP_RESTORE(ctx);
  53         }
  54         uci_list_init(&e->list);
  55         goto done;
  56
  57 error:
  58         free(ptr);
  59         UCI_THROW(ctx, ctx->err);
  60
  61 done:
  62         return e;
  63 }
  64
  65 __private void
  66 uci_free_element(struct uci_element *e)
  67 {
  68         if (e->name)
  69                 free(e->name);
  70         if (!uci_list_empty(&e->list))
  71                 uci_list_del(&e->list);
  72         free(e);
  73 }
  74
  75 struct uci_option *uci_alloc_option(struct uci_section *s, const char *name, const char *value)
  76 {
  77         struct uci_package *p = s->package;
  78         struct uci_context *ctx = p->ctx;
  79         struct uci_option *o;
  80
  81         o = uci_alloc_element(ctx, option, name, strlen(value) + 1);
  82         o->type = UCI_TYPE_STRING;
  83         o->v.string = uci_dataptr(o);
  84         o->section = s;
  85         strcpy(o->v.string, value);
  86         uci_list_add(&s->options, &o->e.list);
  87
  88         return o;
  89 }
  90
  91 static inline void
  92 uci_free_option(struct uci_option *o)
  93 {
  94         struct uci_element *e, *tmp;
  95
  96         switch(o->type) {
  97         case UCI_TYPE_STRING:
  98                 if ((o->v.string != uci_dataptr(o)) &&
  99                         (o->v.string != NULL))
 100                         free(o->v.string);
 101                 break;
 102         case UCI_TYPE_LIST:
 103                 uci_foreach_element_safe(&o->v.list, tmp, e) {
 104                         uci_free_element(e);
 105                 }
 106                 break;
 107         default:
 108                 break;
 109         }
 110         uci_free_element(&o->e);
 111 }
 112
 113 static struct uci_option *
 114 uci_alloc_list(struct uci_section *s, const char *name)
 115 {
 116         struct uci_package *p = s->package;
 117         struct uci_context *ctx = p->ctx;
 118         struct uci_option *o;
 119
 120         o = uci_alloc_element(ctx, option, name, 0);
 121         o->type = UCI_TYPE_LIST;
 122         o->section = s;
 123         uci_list_init(&o->v.list);
 124         uci_list_add(&s->options, &o->e.list);
 125
 126         return o;
 127 }
 128
 129 /* Based on an efficient hash function published by D. J. Bernstein */
 130 static unsigned int djbhash(unsigned int hash, char *str)
 131 {
 132         int len = strlen(str);
 133         int i;
 134
 135         /* initial value */
 136         if (hash == ~0)
 137                 hash = 5381;
 138
 139         for(i = 0; i < len; i++) {
 140                 hash = ((hash << 5) + hash) + str[i];
 141         }
 142         return (hash & 0x7FFFFFFF);
 143 }
 144
 145 /* fix up an unnamed section, e.g. after adding options to it */
 146 __private void uci_fixup_section(struct uci_context *ctx, struct uci_section *s)
 147 {
 148         unsigned int hash = ~0;
 149         struct uci_element *e;
 150         char buf[16];
 151
 152         if (!s || s->e.name)
 153                 return;
 154
 155         /*
 156          * Generate a name for unnamed sections. This is used as reference
 157          * when locating or updating the section from apps/scripts.
 158          * To make multiple concurrent versions somewhat safe for updating,
 159          * the name is generated from a hash of its type and name/value
 160          * pairs of its option, and it is prefixed by a counter value.
 161          * If the order of the unnamed sections changes for some reason,
 162          * updates to them will be rejected.
 163          */
 164         hash = djbhash(hash, s->type);
 165         uci_foreach_element(&s->options, e) {
 166                 struct uci_option *o;
 167                 hash = djbhash(hash, e->name);
 168                 o = uci_to_option(e);
 169                 switch(o->type) {
 170                 case UCI_TYPE_STRING:
 171                         hash = djbhash(hash, o->v.string);
 172                         break;
 173                 default:
 174                         break;
 175                 }
 176         }
 177         sprintf(buf, "cfg%02x%04x", ++s->package->n_section, hash % (1 << 16));
 178         s->e.name = uci_strdup(ctx, buf);
 179 }
 180
 181 static struct uci_section *
 182 uci_alloc_section(struct uci_package *p, const char *type, const char *name)
 183 {
 184         struct uci_context *ctx = p->ctx;
 185         struct uci_section *s;
 186
 187         if (name && !name[0])
 188                 name = NULL;
 189
 190         s = uci_alloc_element(ctx, section, name, strlen(type) + 1);
 191         uci_list_init(&s->options);
 192         s->type = uci_dataptr(s);
 193         s->package = p;
 194         strcpy(s->type, type);
 195         if (name == NULL)
 196                 s->anonymous = true;
 197         p->n_section++;
 198
 199         uci_list_add(&p->sections, &s->e.list);
 200
 201         return s;
 202 }
 203
 204 static void
 205 uci_free_section(struct uci_section *s)
 206 {
 207         struct uci_element *o, *tmp;
 208
 209         uci_foreach_element_safe(&s->options, tmp, o) {
 210                 uci_free_option(uci_to_option(o));
 211         }
 212         if ((s->type != uci_dataptr(s)) &&
 213                 (s->type != NULL))
 214                 free(s->type);
 215         uci_free_element(&s->e);
 216 }
 217
 218 __plugin struct uci_package *
 219 uci_alloc_package(struct uci_context *ctx, const char *name)
 220 {
 221         struct uci_package *p;
 222
 223         p = uci_alloc_element(ctx, package, name, 0);
 224         p->ctx = ctx;
 225         uci_list_init(&p->sections);
 226         uci_list_init(&p->delta);
 227         uci_list_init(&p->saved_delta);
 228         return p;
 229 }
 230
 231 __private void
 232 uci_free_package(struct uci_package **package)
 233 {
 234         struct uci_element *e, *tmp;
 235         struct uci_package *p = *package;
 236
 237         if(!p)
 238                 return;
 239
 240         if (p->path)
 241                 free(p->path);
 242         uci_foreach_element_safe(&p->sections, tmp, e) {
 243                 uci_free_section(uci_to_section(e));
 244         }
 245         uci_foreach_element_safe(&p->delta, tmp, e) {
 246                 uci_free_delta(uci_to_delta(e));
 247         }
 248         uci_foreach_element_safe(&p->saved_delta, tmp, e) {
 249                 uci_free_delta(uci_to_delta(e));
 250         }
 251         uci_free_element(&p->e);
 252         *package = NULL;
 253 }
 254
 255 static void
 256 uci_free_any(struct uci_element **e)
 257 {
 258         switch((*e)->type) {
 259         case UCI_TYPE_SECTION:
 260                 uci_free_section(uci_to_section(*e));
 261                 break;
 262         case UCI_TYPE_OPTION:
 263                 uci_free_option(uci_to_option(*e));
 264                 break;
 265         default:
 266                 break;
 267         }
 268         *e = NULL;
 269 }
 270
 271 __private struct uci_element *
 272 uci_lookup_list(struct uci_list *list, const char *name)
 273 {
 274         struct uci_element *e;
 275
 276         uci_foreach_element(list, e) {
 277                 if (!strcmp(e->name, name))
 278                         return e;
 279         }
 280         return NULL;
 281 }
 282
 283 static struct uci_element *
 284 uci_lookup_ext_section(struct uci_context *ctx, struct uci_ptr *ptr)
 285 {
 286         char *idxstr, *t, *section, *name;
 287         struct uci_element *e = NULL;
 288         struct uci_section *s;
 289         int idx, c;
 290
 291         section = uci_strdup(ctx, ptr->section);
 292         name = idxstr = section + 1;
 293
 294         if (section[0] != '@')
 295                 goto error;
 296
 297         /* parse the section index part */
 298         idxstr = strchr(idxstr, '[');
 299         if (!idxstr)
 300                 goto error;
 301         *idxstr = 0;
 302         idxstr++;
 303
 304         t = strchr(idxstr, ']');
 305         if (!t)
 306                 goto error;
 307         if (t[1] != 0)
 308                 goto error;
 309         *t = 0;
 310
 311         t = NULL;
 312         idx = strtol(idxstr, &t, 10);
 313         if (t && *t)
 314                 goto error;
 315
 316         if (!*name)
 317                 name = NULL;
 318         else if (!uci_validate_type(name))
 319                 goto error;
 320
 321         /* if the given index is negative, it specifies the section number from
 322          * the end of the list */
 323         if (idx < 0) {
 324                 c = 0;
 325                 uci_foreach_element(&ptr->p->sections, e) {
 326                         s = uci_to_section(e);
 327                         if (name && (strcmp(s->type, name) != 0))
 328                                 continue;
 329
 330                         c++;
 331                 }
 332                 idx += c;
 333         }
 334
 335         c = 0;
 336         uci_foreach_element(&ptr->p->sections, e) {
 337                 s = uci_to_section(e);
 338                 if (name && (strcmp(s->type, name) != 0))
 339                         continue;
 340
 341                 if (idx == c)
 342                         goto done;
 343                 c++;
 344         }
 345         e = NULL;
 346         goto done;
 347
 348 error:
 349         e = NULL;
 350         memset(ptr, 0, sizeof(struct uci_ptr));
 351         UCI_THROW(ctx, UCI_ERR_INVAL);
 352 done:
 353         free(section);
 354         if (e)
 355                 ptr->section = e->name;
 356         return e;
 357 }
 358
 359 int
 360 uci_lookup_next(struct uci_context *ctx, struct uci_element **e, struct uci_list *list, const char *name)
 361 {
 362         UCI_HANDLE_ERR(ctx);
 363
 364         *e = uci_lookup_list(list, name);
 365         if (!*e)
 366                 UCI_THROW(ctx, UCI_ERR_NOTFOUND);
 367
 368         return 0;
 369 }
 370
 371 int
 372 uci_lookup_ptr(struct uci_context *ctx, struct uci_ptr *ptr, char *str, bool extended)
 373 {
 374         struct uci_element *e;
 375
 376         UCI_HANDLE_ERR(ctx);
 377         UCI_ASSERT(ctx, ptr != NULL);
 378
 379         if (str)
 380                 UCI_INTERNAL(uci_parse_ptr, ctx, ptr, str);
 381
 382         ptr->flags |= UCI_LOOKUP_DONE;
 383
 384         /* look up the package first */
 385         if (ptr->p)
 386                 e = &ptr->p->e;
 387         else
 388                 e = uci_lookup_list(&ctx->root, ptr->package);
 389
 390         if (!e) {
 391                 UCI_INTERNAL(uci_load, ctx, ptr->package, &ptr->p);
 392                 if (!ptr->p)
 393                         goto notfound;
 394                 ptr->last = &ptr->p->e;
 395         } else {
 396                 ptr->p = uci_to_package(e);
 397                 ptr->last = e;
 398         }
 399
 400         if (!ptr->section && !ptr->s)
 401                 goto complete;
 402
 403         /* if the section name validates as a regular name, pass through
 404          * to the regular uci_lookup function call */
 405         if (ptr->s) {
 406                 e = &ptr->s->e;
 407         } else if (ptr->flags & UCI_LOOKUP_EXTENDED) {
 408                 if (extended)
 409                         e = uci_lookup_ext_section(ctx, ptr);
 410                 else
 411                         UCI_THROW(ctx, UCI_ERR_INVAL);
 412         } else {
 413                 e = uci_lookup_list(&ptr->p->sections, ptr->section);
 414         }
 415
 416         if (!e)
 417                 goto abort;
 418
 419         ptr->last = e;
 420         ptr->s = uci_to_section(e);
 421
 422         if (ptr->option) {
 423                 e = uci_lookup_list(&ptr->s->options, ptr->option);
 424                 if (!e)
 425                         goto abort;
 426
 427                 ptr->o = uci_to_option(e);
 428                 ptr->last = e;
 429         }
 430
 431 complete:
 432         ptr->flags |= UCI_LOOKUP_COMPLETE;
 433 abort:
 434         return 0;
 435
 436 notfound:
 437         UCI_THROW(ctx, UCI_ERR_NOTFOUND);
 438         return 0;
 439 }
 440
 441 __private struct uci_element *
 442 uci_expand_ptr(struct uci_context *ctx, struct uci_ptr *ptr, bool complete)
 443 {
 444         UCI_ASSERT(ctx, ptr != NULL);
 445
 446         if (!(ptr->flags & UCI_LOOKUP_DONE))
 447                 UCI_INTERNAL(uci_lookup_ptr, ctx, ptr, NULL, 1);
 448         if (complete && !(ptr->flags & UCI_LOOKUP_COMPLETE))
 449                 UCI_THROW(ctx, UCI_ERR_NOTFOUND);
 450         UCI_ASSERT(ctx, ptr->p != NULL);
 451
 452         /* fill in missing string info */
 453         if (ptr->p && !ptr->package)
 454                 ptr->package = ptr->p->e.name;
 455         if (ptr->s && !ptr->section)
 456                 ptr->section = ptr->s->e.name;
 457         if (ptr->o && !ptr->option)
 458                 ptr->option = ptr->o->e.name;
 459
 460         if (ptr->o)
 461                 return &ptr->o->e;
 462         if (ptr->s)
 463                 return &ptr->s->e;
 464         if (ptr->p)
 465                 return &ptr->p->e;
 466         else
 467                 return NULL;
 468 }
 469
 470 static void uci_add_element_list(struct uci_context *ctx, struct uci_ptr *ptr, bool internal)
 471 {
 472         struct uci_element *e;
 473         struct uci_package *p;
 474
 475         p = ptr->p;
 476         if (!internal && p->has_delta)
 477                 uci_add_delta(ctx, &p->delta, UCI_CMD_LIST_ADD, ptr->section, ptr->option, ptr->value);
 478
 479         e = uci_alloc_generic(ctx, UCI_TYPE_ITEM, ptr->value, sizeof(struct uci_option));
 480         uci_list_add(&ptr->o->v.list, &e->list);
 481 }
 482
 483 int uci_rename(struct uci_context *ctx, struct uci_ptr *ptr)
 484 {
 485         /* NB: UCI_INTERNAL use means without delta tracking */
 486         bool internal = ctx->internal;
 487         struct uci_element *e;
 488         struct uci_package *p;
 489         char *n;
 490
 491         UCI_HANDLE_ERR(ctx);
 492
 493         e = uci_expand_ptr(ctx, ptr, true);
 494         p = ptr->p;
 495
 496         UCI_ASSERT(ctx, ptr->s);
 497         UCI_ASSERT(ctx, ptr->value);
 498
 499         if (!internal && p->has_delta)
 500                 uci_add_delta(ctx, &p->delta, UCI_CMD_RENAME, ptr->section, ptr->option, ptr->value);
 501
 502         n = uci_strdup(ctx, ptr->value);
 503         if (e->name)
 504                 free(e->name);
 505         e->name = n;
 506
 507         if (e->type == UCI_TYPE_SECTION)
 508                 uci_to_section(e)->anonymous = false;
 509
 510         return 0;
 511 }
 512
 513 int uci_reorder_section(struct uci_context *ctx, struct uci_section *s, int pos)
 514 {
 515         struct uci_package *p = s->package;
 516         char order[32];
 517
 518         UCI_HANDLE_ERR(ctx);
 519
 520         uci_list_set_pos(&s->package->sections, &s->e.list, pos);
 521         if (!ctx->internal && p->has_delta) {
 522                 sprintf(order, "%d", pos);
 523                 uci_add_delta(ctx, &p->delta, UCI_CMD_REORDER, s->e.name, NULL, order);
 524         }
 525
 526         return 0;
 527 }
 528
 529 int uci_add_section(struct uci_context *ctx, struct uci_package *p, const char *type, struct uci_section **res)
 530 {
 531         bool internal = ctx->internal;
 532         struct uci_section *s;
 533
 534         UCI_HANDLE_ERR(ctx);
 535         UCI_ASSERT(ctx, p != NULL);
 536         s = uci_alloc_section(p, type, NULL);
 537         uci_fixup_section(ctx, s);
 538         *res = s;
 539         if (!internal && p->has_delta)
 540                 uci_add_delta(ctx, &p->delta, UCI_CMD_ADD, s->e.name, NULL, type);
 541
 542         return 0;
 543 }
 544
 545 int uci_add_named_section(struct uci_context *ctx, struct uci_package *p, const char *type, const char *name, struct uci_section **res)
 546 {
 547         bool internal = ctx->internal;
 548         struct uci_section *s;
 549
 550         UCI_HANDLE_ERR(ctx);
 551         UCI_ASSERT(ctx, p != NULL);
 552         s = uci_alloc_section(p, type, name);
 553         uci_fixup_section(ctx, s);
 554         *res = s;
 555         if (!internal && p->has_delta)
 556                 uci_add_delta(ctx, &p->delta, UCI_CMD_ADD, s->e.name, NULL, type);
 557
 558         return 0;
 559 }
 560
 561 int uci_delete(struct uci_context *ctx, struct uci_ptr *ptr)
 562 {
 563         /* NB: pass on internal flag to uci_del_element */
 564         bool internal = ctx->internal;
 565         struct uci_package *p;
 566         struct uci_element *e;
 567
 568         UCI_HANDLE_ERR(ctx);
 569
 570         e = uci_expand_ptr(ctx, ptr, true);
 571         p = ptr->p;
 572
 573         UCI_ASSERT(ctx, ptr->s);
 574
 575         if (!internal && p->has_delta)
 576                 uci_add_delta(ctx, &p->delta, UCI_CMD_REMOVE, ptr->section, ptr->option, NULL);
 577
 578         uci_free_any(&e);
 579
 580         if (ptr->option)
 581                 ptr->o = NULL;
 582         else if (ptr->section)
 583                 ptr->s = NULL;
 584
 585         return 0;
 586 }
 587
 588 int uci_add_list(struct uci_context *ctx, struct uci_ptr *ptr)
 589 {
 590         /* NB: UCI_INTERNAL use means without delta tracking */
 591         bool internal = ctx->internal;
 592         struct uci_option *prev = NULL;
 593         const char *value2 = NULL;
 594
 595         UCI_HANDLE_ERR(ctx);
 596
 597         uci_expand_ptr(ctx, ptr, false);
 598         UCI_ASSERT(ctx, ptr->s);
 599         UCI_ASSERT(ctx, ptr->value);
 600
 601         if (ptr->o) {
 602                 switch (ptr->o->type) {
 603                 case UCI_TYPE_STRING:
 604                         /* we already have a string value, convert that to a list */
 605                         prev = ptr->o;
 606                         value2 = ptr->value;
 607                         ptr->value = ptr->o->v.string;
 608                         break;
 609                 case UCI_TYPE_LIST:
 610                         uci_add_element_list(ctx, ptr, internal);
 611                         return 0;
 612                 default:
 613                         UCI_THROW(ctx, UCI_ERR_INVAL);
 614                         break;
 615                 }
 616         }
 617
 618         ptr->o = uci_alloc_list(ptr->s, ptr->option);
 619         if (prev) {
 620                 uci_add_element_list(ctx, ptr, true);
 621                 uci_free_option(prev);
 622                 ptr->value = value2;
 623         }
 624         uci_add_element_list(ctx, ptr, internal);
 625
 626         return 0;
 627 }
 628
 629 int uci_set(struct uci_context *ctx, struct uci_ptr *ptr)
 630 {
 631         /* NB: UCI_INTERNAL use means without delta tracking */
 632         bool internal = ctx->internal;
 633
 634         UCI_HANDLE_ERR(ctx);
 635         uci_expand_ptr(ctx, ptr, false);
 636         UCI_ASSERT(ctx, ptr->value);
 637         UCI_ASSERT(ctx, ptr->s || (!ptr->option && ptr->section));
 638         if (!ptr->option && ptr->value[0]) {
 639                 UCI_ASSERT(ctx, uci_validate_type(ptr->value));
 640         }
 641
 642         if (!ptr->o && ptr->s && ptr->option) {
 643                 struct uci_element *e;
 644                 e = uci_lookup_list(&ptr->s->options, ptr->option);
 645                 if (e)
 646                         ptr->o = uci_to_option(e);
 647         }
 648         if (!ptr->value[0]) {
 649                 /* if setting a nonexistant option/section to a nonexistant value,
 650                  * exit without errors */
 651                 if (!(ptr->flags & UCI_LOOKUP_COMPLETE))
 652                         return 0;
 653
 654                 return uci_delete(ctx, ptr);
 655         } else if (!ptr->o && ptr->option) { /* new option */
 656                 ptr->o = uci_alloc_option(ptr->s, ptr->option, ptr->value);
 657                 ptr->last = &ptr->o->e;
 658         } else if (!ptr->s && ptr->section) { /* new section */
 659                 ptr->s = uci_alloc_section(ptr->p, ptr->value, ptr->section);
 660                 ptr->last = &ptr->s->e;
 661         } else if (ptr->o && ptr->option) { /* update option */
 662                 if ((ptr->o->type == UCI_TYPE_STRING) &&
 663                         !strcmp(ptr->o->v.string, ptr->value))
 664                         return 0;
 665                 uci_free_option(ptr->o);
 666                 ptr->o = uci_alloc_option(ptr->s, ptr->option, ptr->value);
 667                 ptr->last = &ptr->o->e;
 668         } else if (ptr->s && ptr->section) { /* update section */
 669                 char *s = uci_strdup(ctx, ptr->value);
 670
 671                 if (ptr->s->type == uci_dataptr(ptr->s)) {
 672                         ptr->last = NULL;
 673                         ptr->last = uci_realloc(ctx, ptr->s, sizeof(struct uci_section));
 674                         ptr->s = uci_to_section(ptr->last);
 675                         uci_list_fixup(&ptr->s->e.list);
 676                 } else {
 677                         free(ptr->s->type);
 678                 }
 679                 ptr->s->type = s;
 680         } else {
 681                 UCI_THROW(ctx, UCI_ERR_INVAL);
 682         }
 683
 684         if (!internal && ptr->p->has_delta)
 685                 uci_add_delta(ctx, &ptr->p->delta, UCI_CMD_CHANGE, ptr->section, ptr->option, ptr->value);
 686
 687         return 0;
 688 }
 689
 690 int uci_unload(struct uci_context *ctx, struct uci_package *p)
 691 {
 692         UCI_HANDLE_ERR(ctx);
 693         UCI_ASSERT(ctx, p != NULL);
 694
 695         uci_free_package(&p);
 696         return 0;
 697 }
 698