lib/util/util_strlist.c

   1 /*
   2    Unix SMB/CIFS implementation.
   3
   4    Copyright (C) Andrew Tridgell 2005
   5    Copyright (C) Jelmer Vernooij 2005
   6
   7    This program is free software; you can redistribute it and/or modify
   8    it under the terms of the GNU General Public License as published by
   9    the Free Software Foundation; either version 3 of the License, or
  10    (at your option) any later version.
  11
  12    This program is distributed in the hope that it will be useful,
  13    but WITHOUT ANY WARRANTY; without even the implied warranty of
  14    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  15    GNU General Public License for more details.
  16
  17    You should have received a copy of the GNU General Public License
  18    along with this program.  If not, see <http://www.gnu.org/licenses/>.
  19 */
  20
  21 #include "replace.h"
  22 #include "debug.h"
  23 #include "tsort.h"
  24
  25 #include "util_strlist.h"
  26
  27 #undef strcasecmp
  28
  29 /**
  30  * @file
  31  * @brief String list manipulation
  32  */
  33
  34 /**
  35   build an empty (only NULL terminated) list of strings (for expansion with str_list_add() etc)
  36 */
  37 _PUBLIC_ char **str_list_make_empty(TALLOC_CTX *mem_ctx)
  38 {
  39         char **ret = talloc_zero_array(mem_ctx, char *, 1);
  40         return ret;
  41 }
  42
  43 /**
  44   place the only element 'entry' into a new, NULL terminated string list
  45 */
  46 _PUBLIC_ char **str_list_make_single(TALLOC_CTX *mem_ctx, const char *entry)
  47 {
  48         char **ret = NULL;
  49
  50         ret = talloc_array(mem_ctx, char *, 2);
  51         if (ret == NULL) {
  52                 return NULL;
  53         }
  54
  55         ret[0] = talloc_strdup(ret, entry);
  56         if (!ret[0]) {
  57                 talloc_free(ret);
  58                 return NULL;
  59         }
  60         ret[1] = NULL;
  61
  62         return ret;
  63 }
  64
  65 /**
  66   build a null terminated list of strings from a input string and a
  67   separator list. The separator list must contain characters less than
  68   or equal to 0x2f for this to work correctly on multi-byte strings
  69 */
  70 _PUBLIC_ char **str_list_make(TALLOC_CTX *mem_ctx, const char *string, const char *sep)
  71 {
  72         int num_elements = 0;
  73         char **ret = NULL;
  74
  75         if (sep == NULL) {
  76                 sep = LIST_SEP;
  77         }
  78
  79         ret = talloc_array(mem_ctx, char *, 1);
  80         if (ret == NULL) {
  81                 return NULL;
  82         }
  83
  84         while (string && *string) {
  85                 size_t len = strcspn(string, sep);
  86                 char **ret2;
  87
  88                 if (len == 0) {
  89                         string += strspn(string, sep);
  90                         continue;
  91                 }
  92
  93                 ret2 = talloc_realloc(mem_ctx, ret, char *,
  94                         num_elements+2);
  95                 if (ret2 == NULL) {
  96                         talloc_free(ret);
  97                         return NULL;
  98                 }
  99                 ret = ret2;
 100
 101                 ret[num_elements] = talloc_strndup(ret, string, len);
 102                 if (ret[num_elements] == NULL) {
 103                         talloc_free(ret);
 104                         return NULL;
 105                 }
 106
 107                 num_elements++;
 108                 string += len;
 109         }
 110
 111         ret[num_elements] = NULL;
 112
 113         return ret;
 114 }
 115
 116 /**
 117  * build a null terminated list of strings from an argv-like input string
 118  * Entries are separated by spaces and can be enclosed by quotes.
 119  * Does NOT support escaping
 120  */
 121 _PUBLIC_ char **str_list_make_shell(TALLOC_CTX *mem_ctx, const char *string, const char *sep)
 122 {
 123         int num_elements = 0;
 124         char **ret = NULL;
 125
 126         ret = talloc_array(mem_ctx, char *, 1);
 127         if (ret == NULL) {
 128                 return NULL;
 129         }
 130
 131         if (sep == NULL)
 132                 sep = " \t\n\r";
 133
 134         while (string && *string) {
 135                 size_t len = strcspn(string, sep);
 136                 char *element;
 137                 char **ret2;
 138
 139                 if (len == 0) {
 140                         string += strspn(string, sep);
 141                         continue;
 142                 }
 143
 144                 if (*string == '\"') {
 145                         string++;
 146                         len = strcspn(string, "\"");
 147                         element = talloc_strndup(ret, string, len);
 148                         string += len + 1;
 149                 } else {
 150                         element = talloc_strndup(ret, string, len);
 151                         string += len;
 152                 }
 153
 154                 if (element == NULL) {
 155                         talloc_free(ret);
 156                         return NULL;
 157                 }
 158
 159                 ret2 = talloc_realloc(mem_ctx, ret, char *, num_elements+2);
 160                 if (ret2 == NULL) {
 161                         talloc_free(ret);
 162                         return NULL;
 163                 }
 164                 ret = ret2;
 165
 166                 ret[num_elements] = element;
 167
 168                 num_elements++;
 169         }
 170
 171         ret[num_elements] = NULL;
 172
 173         return ret;
 174
 175 }
 176
 177 /**
 178  * join a list back to one string
 179  */
 180 _PUBLIC_ char *str_list_join(TALLOC_CTX *mem_ctx, const char **list, char separator)
 181 {
 182         char *ret = NULL;
 183         int i;
 184
 185         if (list[0] == NULL)
 186                 return talloc_strdup(mem_ctx, "");
 187
 188         ret = talloc_strdup(mem_ctx, list[0]);
 189
 190         for (i = 1; list[i]; i++) {
 191                 talloc_asprintf_addbuf(&ret, "%c%s", separator, list[i]);
 192         }
 193
 194         return ret;
 195 }
 196
 197 /** join a list back to one (shell-like) string; entries
 198  * separated by spaces, using quotes where necessary */
 199 _PUBLIC_ char *str_list_join_shell(TALLOC_CTX *mem_ctx, const char **list, char sep)
 200 {
 201         char *ret = NULL;
 202         int i;
 203
 204         if (list[0] == NULL)
 205                 return talloc_strdup(mem_ctx, "");
 206
 207         if (strchr(list[0], ' ') || strlen(list[0]) == 0)
 208                 ret = talloc_asprintf(mem_ctx, "\"%s\"", list[0]);
 209         else
 210                 ret = talloc_strdup(mem_ctx, list[0]);
 211
 212         for (i = 1; list[i]; i++) {
 213                 if (strchr(list[i], ' ') || strlen(list[i]) == 0) {
 214                         talloc_asprintf_addbuf(&ret, "%c\"%s\"", sep, list[i]);
 215                 } else {
 216                         talloc_asprintf_addbuf(&ret, "%c%s", sep, list[i]);
 217                 }
 218         }
 219
 220         return ret;
 221 }
 222
 223 /**
 224   return the number of elements in a string list
 225 */
 226 _PUBLIC_ size_t str_list_length(const char * const *list)
 227 {
 228         size_t ret;
 229         for (ret=0;list && list[ret];ret++) /* noop */ ;
 230         return ret;
 231 }
 232
 233
 234 /**
 235   copy a string list
 236 */
 237 _PUBLIC_ char **str_list_copy(TALLOC_CTX *mem_ctx, const char **list)
 238 {
 239         int i;
 240         char **ret;
 241
 242         if (list == NULL)
 243                 return NULL;
 244
 245         ret = talloc_array(mem_ctx, char *, str_list_length(list)+1);
 246         if (ret == NULL)
 247                 return NULL;
 248
 249         for (i=0;list && list[i];i++) {
 250                 ret[i] = talloc_strdup(ret, list[i]);
 251                 if (ret[i] == NULL) {
 252                         talloc_free(ret);
 253                         return NULL;
 254                 }
 255         }
 256         ret[i] = NULL;
 257         return ret;
 258 }
 259
 260 /**
 261    Return true if all the elements of the list match exactly.
 262  */
 263 _PUBLIC_ bool str_list_equal(const char * const *list1,
 264                              const char * const *list2)
 265 {
 266         int i;
 267
 268         if (list1 == NULL || list2 == NULL) {
 269                 return (list1 == list2);
 270         }
 271
 272         for (i=0;list1[i] && list2[i];i++) {
 273                 if (strcmp(list1[i], list2[i]) != 0) {
 274                         return false;
 275                 }
 276         }
 277         if (list1[i] || list2[i]) {
 278                 return false;
 279         }
 280         return true;
 281 }
 282
 283
 284 /**
 285   add an entry to a string list
 286 */
 287 _PUBLIC_ const char **str_list_add(const char **list, const char *s)
 288 {
 289         size_t len = str_list_length(list);
 290         const char **ret;
 291
 292         ret = talloc_realloc(NULL, list, const char *, len+2);
 293         if (ret == NULL) return NULL;
 294
 295         ret[len] = talloc_strdup(ret, s);
 296         if (ret[len] == NULL) return NULL;
 297
 298         ret[len+1] = NULL;
 299
 300         return ret;
 301 }
 302
 303 /**
 304  * @brief Extend a talloc'ed string list with a printf'ed string
 305  *
 306  * str_list_add_printf() does nothing if *plist is NULL and it sets
 307  * *plist to NULL on failure. It is designed to avoid intermediate
 308  * NULL checks:
 309  *
 310  *     argv = str_list_make_empty(ctx);
 311  *     str_list_add_printf(&argv, "smbstatus");
 312  *     str_list_add_printf(&argv, "--configfile=%s", config);
 313  *     if (argv == NULL) {
 314  *        goto nomem;
 315  *     }
 316  *
 317  * @param[in,out] plist The talloc'ed list to extend
 318  * @param[in] fmt The format string
 319  */
 320 void str_list_add_printf(char ***plist, const char *fmt, ...)
 321 {
 322         char **list = *plist;
 323         size_t len;
 324         char **tmp = NULL;
 325         va_list ap;
 326
 327         if (list == NULL) {
 328                 return;
 329         }
 330         len = str_list_length((const char * const *)list);
 331
 332         tmp = talloc_realloc(NULL, list, char *, len+2);
 333         if (tmp == NULL) {
 334                 goto fail;
 335         }
 336         list = tmp;
 337         list[len+1] = NULL;
 338
 339         va_start(ap, fmt);
 340         list[len] = talloc_vasprintf(list, fmt, ap);
 341         va_end(ap);
 342
 343         if (list[len] == NULL) {
 344                 goto fail;
 345         }
 346         *plist = list;
 347
 348         return;
 349 fail:
 350         TALLOC_FREE(list);
 351         *plist = NULL;
 352 }
 353
 354 /**
 355   remove an entry from a string list
 356 */
 357 _PUBLIC_ void str_list_remove(const char **list, const char *s)
 358 {
 359         int i;
 360
 361         for (i=0;list[i];i++) {
 362                 if (strcmp(list[i], s) == 0) break;
 363         }
 364         if (!list[i]) return;
 365
 366         for (;list[i];i++) {
 367                 list[i] = list[i+1];
 368         }
 369 }
 370
 371
 372 /**
 373   return true if a string is in a list
 374 */
 375 _PUBLIC_ bool str_list_check(const char **list, const char *s)
 376 {
 377         int i;
 378
 379         for (i=0; list != NULL && list[i] != NULL; i++) {
 380                 if (strcmp(list[i], s) == 0) return true;
 381         }
 382         return false;
 383 }
 384
 385 /**
 386   return true if a string is in a list, case insensitively
 387 */
 388 _PUBLIC_ bool str_list_check_ci(const char **list, const char *s)
 389 {
 390         int i;
 391
 392         for (i=0; list != NULL && list[i] != NULL; i++) {
 393                 if (strcasecmp(list[i], s) == 0) return true;
 394         }
 395         return false;
 396 }
 397
 398
 399 /**
 400   append one list to another - expanding list1
 401 */
 402 _PUBLIC_ const char **str_list_append(const char **list1,
 403         const char * const *list2)
 404 {
 405         size_t len1 = str_list_length(list1);
 406         size_t len2 = str_list_length(list2);
 407         const char **ret;
 408         size_t i;
 409
 410         ret = talloc_realloc(NULL, list1, const char *, len1+len2+1);
 411         if (ret == NULL) return NULL;
 412
 413         for (i=len1;i<len1+len2;i++) {
 414                 ret[i] = talloc_strdup(ret, list2[i-len1]);
 415                 if (ret[i] == NULL) {
 416                         return NULL;
 417                 }
 418         }
 419         ret[i] = NULL;
 420
 421         return ret;
 422 }
 423
 424 static int list_cmp(const char **el1, const char **el2)
 425 {
 426         return strcmp(*el1, *el2);
 427 }
 428
 429 /*
 430   return a list that only contains the unique elements of a list,
 431   removing any duplicates
 432  */
 433 _PUBLIC_ const char **str_list_unique(const char **list)
 434 {
 435         size_t len = str_list_length(list);
 436         const char **list2;
 437         size_t i, j;
 438         if (len < 2) {
 439                 return list;
 440         }
 441         list2 = (const char **)talloc_memdup(list, list,
 442                                              sizeof(list[0])*(len+1));
 443         TYPESAFE_QSORT(list2, len, list_cmp);
 444         list[0] = list2[0];
 445         for (i=j=1;i<len;i++) {
 446                 if (strcmp(list2[i], list[j-1]) != 0) {
 447                         list[j] = list2[i];
 448                         j++;
 449                 }
 450         }
 451         list[j] = NULL;
 452         list = talloc_realloc(NULL, list, const char *, j + 1);
 453         talloc_free(list2);
 454         return list;
 455 }
 456
 457 /*
 458   very useful when debugging complex list related code
 459  */
 460 _PUBLIC_ void str_list_show(const char **list)
 461 {
 462         int i;
 463         DEBUG(0,("{ "));
 464         for (i=0;list && list[i];i++) {
 465                 DEBUG(0,("\"%s\", ", list[i]));
 466         }
 467         DEBUG(0,("}\n"));
 468 }
 469
 470
 471
 472 /**
 473   append one list to another - expanding list1
 474   this assumes the elements of list2 are const pointers, so we can re-use them
 475 */
 476 _PUBLIC_ const char **str_list_append_const(const char **list1,
 477                                             const char **list2)
 478 {
 479         size_t len1 = str_list_length(list1);
 480         size_t len2 = str_list_length(list2);
 481         const char **ret;
 482         size_t i;
 483
 484         ret = talloc_realloc(NULL, list1, const char *, len1+len2+1);
 485         if (ret == NULL) return NULL;
 486
 487         for (i=len1;i<len1+len2;i++) {
 488                 ret[i] = list2[i-len1];
 489         }
 490         ret[i] = NULL;
 491
 492         return ret;
 493 }
 494
 495 /**
 496  * Add a string to an array of strings.
 497  *
 498  * num should be a pointer to an integer that holds the current
 499  * number of elements in strings. It will be updated by this function.
 500  */
 501 _PUBLIC_ bool add_string_to_array(TALLOC_CTX *mem_ctx,
 502                          const char *str, const char ***strings, size_t *num)
 503 {
 504         char *dup_str = talloc_strdup(mem_ctx, str);
 505
 506         *strings = talloc_realloc(mem_ctx,
 507                                     *strings,
 508                                     const char *, ((*num)+1));
 509
 510         if ((*strings == NULL) || (dup_str == NULL)) {
 511                 *num = 0;
 512                 return false;
 513         }
 514
 515         (*strings)[*num] = dup_str;
 516         *num += 1;
 517
 518         return true;
 519 }
 520
 521 /**
 522   add an entry to a string list
 523   this assumes s will not change
 524 */
 525 _PUBLIC_ const char **str_list_add_const(const char **list, const char *s)
 526 {
 527         size_t len = str_list_length(list);
 528         const char **ret;
 529
 530         ret = talloc_realloc(NULL, list, const char *, len+2);
 531         if (ret == NULL) return NULL;
 532
 533         ret[len] = s;
 534         ret[len+1] = NULL;
 535
 536         return ret;
 537 }
 538
 539 /**
 540   copy a string list
 541   this assumes list will not change
 542 */
 543 _PUBLIC_ const char **str_list_copy_const(TALLOC_CTX *mem_ctx,
 544                                           const char **list)
 545 {
 546         int i;
 547         const char **ret;
 548
 549         if (list == NULL)
 550                 return NULL;
 551
 552         ret = talloc_array(mem_ctx, const char *, str_list_length(list)+1);
 553         if (ret == NULL)
 554                 return NULL;
 555
 556         for (i=0;list && list[i];i++) {
 557                 ret[i] = list[i];
 558         }
 559         ret[i] = NULL;
 560         return ret;
 561 }