src/basic/string-util.c

   1 /***
   2   This file is part of systemd.
   3
   4   Copyright 2010 Lennart Poettering
   5
   6   systemd is free software; you can redistribute it and/or modify it
   7   under the terms of the GNU Lesser General Public License as published by
   8   the Free Software Foundation; either version 2.1 of the License, or
   9   (at your option) any later version.
  10
  11   systemd is distributed in the hope that it will be useful, but
  12   WITHOUT ANY WARRANTY; without even the implied warranty of
  13   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
  14   Lesser General Public License for more details.
  15
  16   You should have received a copy of the GNU Lesser General Public License
  17   along with systemd; If not, see <http://www.gnu.org/licenses/>.
  18 ***/
  19
  20 #include <errno.h>
  21 #include <stdarg.h>
  22 #include <stdint.h>
  23 #include <stdio.h>
  24 #include <stdlib.h>
  25
  26 #include "alloc-util.h"
  27 #include "gunicode.h"
  28 #include "macro.h"
  29 #include "string-util.h"
  30 #include "utf8.h"
  31 #include "util.h"
  32
  33 int strcmp_ptr(const char *a, const char *b) {
  34
  35         /* Like strcmp(), but tries to make sense of NULL pointers */
  36         if (a && b)
  37                 return strcmp(a, b);
  38
  39         if (!a && b)
  40                 return -1;
  41
  42         if (a && !b)
  43                 return 1;
  44
  45         return 0;
  46 }
  47
  48 char* endswith(const char *s, const char *postfix) {
  49         size_t sl, pl;
  50
  51         assert(s);
  52         assert(postfix);
  53
  54         sl = strlen(s);
  55         pl = strlen(postfix);
  56
  57         if (pl == 0)
  58                 return (char*) s + sl;
  59
  60         if (sl < pl)
  61                 return NULL;
  62
  63         if (memcmp(s + sl - pl, postfix, pl) != 0)
  64                 return NULL;
  65
  66         return (char*) s + sl - pl;
  67 }
  68
  69 char* endswith_no_case(const char *s, const char *postfix) {
  70         size_t sl, pl;
  71
  72         assert(s);
  73         assert(postfix);
  74
  75         sl = strlen(s);
  76         pl = strlen(postfix);
  77
  78         if (pl == 0)
  79                 return (char*) s + sl;
  80
  81         if (sl < pl)
  82                 return NULL;
  83
  84         if (strcasecmp(s + sl - pl, postfix) != 0)
  85                 return NULL;
  86
  87         return (char*) s + sl - pl;
  88 }
  89
  90 char* first_word(const char *s, const char *word) {
  91         size_t sl, wl;
  92         const char *p;
  93
  94         assert(s);
  95         assert(word);
  96
  97         /* Checks if the string starts with the specified word, either
  98          * followed by NUL or by whitespace. Returns a pointer to the
  99          * NUL or the first character after the whitespace. */
 100
 101         sl = strlen(s);
 102         wl = strlen(word);
 103
 104         if (sl < wl)
 105                 return NULL;
 106
 107         if (wl == 0)
 108                 return (char*) s;
 109
 110         if (memcmp(s, word, wl) != 0)
 111                 return NULL;
 112
 113         p = s + wl;
 114         if (*p == 0)
 115                 return (char*) p;
 116
 117         if (!strchr(WHITESPACE, *p))
 118                 return NULL;
 119
 120         p += strspn(p, WHITESPACE);
 121         return (char*) p;
 122 }
 123
 124 static size_t strcspn_escaped(const char *s, const char *reject) {
 125         bool escaped = false;
 126         int n;
 127
 128         for (n=0; s[n]; n++) {
 129                 if (escaped)
 130                         escaped = false;
 131                 else if (s[n] == '\\')
 132                         escaped = true;
 133                 else if (strchr(reject, s[n]))
 134                         break;
 135         }
 136
 137         /* if s ends in \, return index of previous char */
 138         return n - escaped;
 139 }
 140
 141 /* Split a string into words. */
 142 const char* split(const char **state, size_t *l, const char *separator, bool quoted) {
 143         const char *current;
 144
 145         current = *state;
 146
 147         if (!*current) {
 148                 assert(**state == '\0');
 149                 return NULL;
 150         }
 151
 152         current += strspn(current, separator);
 153         if (!*current) {
 154                 *state = current;
 155                 return NULL;
 156         }
 157
 158         if (quoted && strchr("\'\"", *current)) {
 159                 char quotechars[2] = {*current, '\0'};
 160
 161                 *l = strcspn_escaped(current + 1, quotechars);
 162                 if (current[*l + 1] == '\0' || current[*l + 1] != quotechars[0] ||
 163                     (current[*l + 2] && !strchr(separator, current[*l + 2]))) {
 164                         /* right quote missing or garbage at the end */
 165                         *state = current;
 166                         return NULL;
 167                 }
 168                 *state = current++ + *l + 2;
 169         } else if (quoted) {
 170                 *l = strcspn_escaped(current, separator);
 171                 if (current[*l] && !strchr(separator, current[*l])) {
 172                         /* unfinished escape */
 173                         *state = current;
 174                         return NULL;
 175                 }
 176                 *state = current + *l;
 177         } else {
 178                 *l = strcspn(current, separator);
 179                 *state = current + *l;
 180         }
 181
 182         return current;
 183 }
 184
 185 char *strnappend(const char *s, const char *suffix, size_t b) {
 186         size_t a;
 187         char *r;
 188
 189         if (!s && !suffix)
 190                 return strdup("");
 191
 192         if (!s)
 193                 return strndup(suffix, b);
 194
 195         if (!suffix)
 196                 return strdup(s);
 197
 198         assert(s);
 199         assert(suffix);
 200
 201         a = strlen(s);
 202         if (b > ((size_t) -1) - a)
 203                 return NULL;
 204
 205         r = new(char, a+b+1);
 206         if (!r)
 207                 return NULL;
 208
 209         memcpy(r, s, a);
 210         memcpy(r+a, suffix, b);
 211         r[a+b] = 0;
 212
 213         return r;
 214 }
 215
 216 char *strappend(const char *s, const char *suffix) {
 217         return strnappend(s, suffix, suffix ? strlen(suffix) : 0);
 218 }
 219
 220 char *strjoin(const char *x, ...) {
 221         va_list ap;
 222         size_t l;
 223         char *r, *p;
 224
 225         va_start(ap, x);
 226
 227         if (x) {
 228                 l = strlen(x);
 229
 230                 for (;;) {
 231                         const char *t;
 232                         size_t n;
 233
 234                         t = va_arg(ap, const char *);
 235                         if (!t)
 236                                 break;
 237
 238                         n = strlen(t);
 239                         if (n > ((size_t) -1) - l) {
 240                                 va_end(ap);
 241                                 return NULL;
 242                         }
 243
 244                         l += n;
 245                 }
 246         } else
 247                 l = 0;
 248
 249         va_end(ap);
 250
 251         r = new(char, l+1);
 252         if (!r)
 253                 return NULL;
 254
 255         if (x) {
 256                 p = stpcpy(r, x);
 257
 258                 va_start(ap, x);
 259
 260                 for (;;) {
 261                         const char *t;
 262
 263                         t = va_arg(ap, const char *);
 264                         if (!t)
 265                                 break;
 266
 267                         p = stpcpy(p, t);
 268                 }
 269
 270                 va_end(ap);
 271         } else
 272                 r[0] = 0;
 273
 274         return r;
 275 }
 276
 277 char *strstrip(char *s) {
 278         char *e;
 279
 280         /* Drops trailing whitespace. Modifies the string in
 281          * place. Returns pointer to first non-space character */
 282
 283         s += strspn(s, WHITESPACE);
 284
 285         for (e = strchr(s, 0); e > s; e --)
 286                 if (!strchr(WHITESPACE, e[-1]))
 287                         break;
 288
 289         *e = 0;
 290
 291         return s;
 292 }
 293
 294 char *delete_chars(char *s, const char *bad) {
 295         char *f, *t;
 296
 297         /* Drops all whitespace, regardless where in the string */
 298
 299         for (f = s, t = s; *f; f++) {
 300                 if (strchr(bad, *f))
 301                         continue;
 302
 303                 *(t++) = *f;
 304         }
 305
 306         *t = 0;
 307
 308         return s;
 309 }
 310
 311 char *truncate_nl(char *s) {
 312         assert(s);
 313
 314         s[strcspn(s, NEWLINE)] = 0;
 315         return s;
 316 }
 317
 318 char ascii_tolower(char x) {
 319
 320         if (x >= 'A' && x <= 'Z')
 321                 return x - 'A' + 'a';
 322
 323         return x;
 324 }
 325
 326 char ascii_toupper(char x) {
 327
 328         if (x >= 'a' && x <= 'z')
 329                 return x - 'a' + 'A';
 330
 331         return x;
 332 }
 333
 334 char *ascii_strlower(char *t) {
 335         char *p;
 336
 337         assert(t);
 338
 339         for (p = t; *p; p++)
 340                 *p = ascii_tolower(*p);
 341
 342         return t;
 343 }
 344
 345 char *ascii_strupper(char *t) {
 346         char *p;
 347
 348         assert(t);
 349
 350         for (p = t; *p; p++)
 351                 *p = ascii_toupper(*p);
 352
 353         return t;
 354 }
 355
 356 char *ascii_strlower_n(char *t, size_t n) {
 357         size_t i;
 358
 359         if (n <= 0)
 360                 return t;
 361
 362         for (i = 0; i < n; i++)
 363                 t[i] = ascii_tolower(t[i]);
 364
 365         return t;
 366 }
 367
 368 int ascii_strcasecmp_n(const char *a, const char *b, size_t n) {
 369
 370         for (; n > 0; a++, b++, n--) {
 371                 int x, y;
 372
 373                 x = (int) (uint8_t) ascii_tolower(*a);
 374                 y = (int) (uint8_t) ascii_tolower(*b);
 375
 376                 if (x != y)
 377                         return x - y;
 378         }
 379
 380         return 0;
 381 }
 382
 383 int ascii_strcasecmp_nn(const char *a, size_t n, const char *b, size_t m) {
 384         int r;
 385
 386         r = ascii_strcasecmp_n(a, b, MIN(n, m));
 387         if (r != 0)
 388                 return r;
 389
 390         if (n < m)
 391                 return -1;
 392         else if (n > m)
 393                 return 1;
 394         else
 395                 return 0;
 396 }
 397
 398 bool chars_intersect(const char *a, const char *b) {
 399         const char *p;
 400
 401         /* Returns true if any of the chars in a are in b. */
 402         for (p = a; *p; p++)
 403                 if (strchr(b, *p))
 404                         return true;
 405
 406         return false;
 407 }
 408
 409 bool string_has_cc(const char *p, const char *ok) {
 410         const char *t;
 411
 412         assert(p);
 413
 414         /*
 415          * Check if a string contains control characters. If 'ok' is
 416          * non-NULL it may be a string containing additional CCs to be
 417          * considered OK.
 418          */
 419
 420         for (t = p; *t; t++) {
 421                 if (ok && strchr(ok, *t))
 422                         continue;
 423
 424                 if (*t > 0 && *t < ' ')
 425                         return true;
 426
 427                 if (*t == 127)
 428                         return true;
 429         }
 430
 431         return false;
 432 }
 433
 434 static char *ascii_ellipsize_mem(const char *s, size_t old_length, size_t new_length, unsigned percent) {
 435         size_t x;
 436         char *r;
 437
 438         assert(s);
 439         assert(percent <= 100);
 440         assert(new_length >= 3);
 441
 442         if (old_length <= 3 || old_length <= new_length)
 443                 return strndup(s, old_length);
 444
 445         r = new0(char, new_length+1);
 446         if (!r)
 447                 return NULL;
 448
 449         x = (new_length * percent) / 100;
 450
 451         if (x > new_length - 3)
 452                 x = new_length - 3;
 453
 454         memcpy(r, s, x);
 455         r[x] = '.';
 456         r[x+1] = '.';
 457         r[x+2] = '.';
 458         memcpy(r + x + 3,
 459                s + old_length - (new_length - x - 3),
 460                new_length - x - 3);
 461
 462         return r;
 463 }
 464
 465 char *ellipsize_mem(const char *s, size_t old_length, size_t new_length, unsigned percent) {
 466         size_t x;
 467         char *e;
 468         const char *i, *j;
 469         unsigned k, len, len2;
 470         int r;
 471
 472         assert(s);
 473         assert(percent <= 100);
 474         assert(new_length >= 3);
 475
 476         /* if no multibyte characters use ascii_ellipsize_mem for speed */
 477         if (ascii_is_valid(s))
 478                 return ascii_ellipsize_mem(s, old_length, new_length, percent);
 479
 480         if (old_length <= 3 || old_length <= new_length)
 481                 return strndup(s, old_length);
 482
 483         x = (new_length * percent) / 100;
 484
 485         if (x > new_length - 3)
 486                 x = new_length - 3;
 487
 488         k = 0;
 489         for (i = s; k < x && i < s + old_length; i = utf8_next_char(i)) {
 490                 char32_t c;
 491
 492                 r = utf8_encoded_to_unichar(i, &c);
 493                 if (r < 0)
 494                         return NULL;
 495                 k += unichar_iswide(c) ? 2 : 1;
 496         }
 497
 498         if (k > x) /* last character was wide and went over quota */
 499                 x++;
 500
 501         for (j = s + old_length; k < new_length && j > i; ) {
 502                 char32_t c;
 503
 504                 j = utf8_prev_char(j);
 505                 r = utf8_encoded_to_unichar(j, &c);
 506                 if (r < 0)
 507                         return NULL;
 508                 k += unichar_iswide(c) ? 2 : 1;
 509         }
 510         assert(i <= j);
 511
 512         /* we don't actually need to ellipsize */
 513         if (i == j)
 514                 return memdup(s, old_length + 1);
 515
 516         /* make space for ellipsis */
 517         j = utf8_next_char(j);
 518
 519         len = i - s;
 520         len2 = s + old_length - j;
 521         e = new(char, len + 3 + len2 + 1);
 522         if (!e)
 523                 return NULL;
 524
 525         /*
 526         printf("old_length=%zu new_length=%zu x=%zu len=%u len2=%u k=%u\n",
 527                old_length, new_length, x, len, len2, k);
 528         */
 529
 530         memcpy(e, s, len);
 531         e[len]   = 0xe2; /* tri-dot ellipsis: … */
 532         e[len + 1] = 0x80;
 533         e[len + 2] = 0xa6;
 534
 535         memcpy(e + len + 3, j, len2 + 1);
 536
 537         return e;
 538 }
 539
 540 char *ellipsize(const char *s, size_t length, unsigned percent) {
 541         return ellipsize_mem(s, strlen(s), length, percent);
 542 }
 543
 544 bool nulstr_contains(const char*nulstr, const char *needle) {
 545         const char *i;
 546
 547         if (!nulstr)
 548                 return false;
 549
 550         NULSTR_FOREACH(i, nulstr)
 551                 if (streq(i, needle))
 552                         return true;
 553
 554         return false;
 555 }
 556
 557 char* strshorten(char *s, size_t l) {
 558         assert(s);
 559
 560         if (l < strlen(s))
 561                 s[l] = 0;
 562
 563         return s;
 564 }
 565
 566 char *strreplace(const char *text, const char *old_string, const char *new_string) {
 567         const char *f;
 568         char *t, *r;
 569         size_t l, old_len, new_len;
 570
 571         assert(text);
 572         assert(old_string);
 573         assert(new_string);
 574
 575         old_len = strlen(old_string);
 576         new_len = strlen(new_string);
 577
 578         l = strlen(text);
 579         r = new(char, l+1);
 580         if (!r)
 581                 return NULL;
 582
 583         f = text;
 584         t = r;
 585         while (*f) {
 586                 char *a;
 587                 size_t d, nl;
 588
 589                 if (!startswith(f, old_string)) {
 590                         *(t++) = *(f++);
 591                         continue;
 592                 }
 593
 594                 d = t - r;
 595                 nl = l - old_len + new_len;
 596                 a = realloc(r, nl + 1);
 597                 if (!a)
 598                         goto oom;
 599
 600                 l = nl;
 601                 r = a;
 602                 t = r + d;
 603
 604                 t = stpcpy(t, new_string);
 605                 f += old_len;
 606         }
 607
 608         *t = 0;
 609         return r;
 610
 611 oom:
 612         free(r);
 613         return NULL;
 614 }
 615
 616 char *strip_tab_ansi(char **ibuf, size_t *_isz) {
 617         const char *i, *begin = NULL;
 618         enum {
 619                 STATE_OTHER,
 620                 STATE_ESCAPE,
 621                 STATE_BRACKET
 622         } state = STATE_OTHER;
 623         char *obuf = NULL;
 624         size_t osz = 0, isz;
 625         FILE *f;
 626
 627         assert(ibuf);
 628         assert(*ibuf);
 629
 630         /* Strips ANSI color and replaces TABs by 8 spaces */
 631
 632         isz = _isz ? *_isz : strlen(*ibuf);
 633
 634         f = open_memstream(&obuf, &osz);
 635         if (!f)
 636                 return NULL;
 637
 638         for (i = *ibuf; i < *ibuf + isz + 1; i++) {
 639
 640                 switch (state) {
 641
 642                 case STATE_OTHER:
 643                         if (i >= *ibuf + isz) /* EOT */
 644                                 break;
 645                         else if (*i == '\x1B')
 646                                 state = STATE_ESCAPE;
 647                         else if (*i == '\t')
 648                                 fputs("        ", f);
 649                         else
 650                                 fputc(*i, f);
 651                         break;
 652
 653                 case STATE_ESCAPE:
 654                         if (i >= *ibuf + isz) { /* EOT */
 655                                 fputc('\x1B', f);
 656                                 break;
 657                         } else if (*i == '[') {
 658                                 state = STATE_BRACKET;
 659                                 begin = i + 1;
 660                         } else {
 661                                 fputc('\x1B', f);
 662                                 fputc(*i, f);
 663                                 state = STATE_OTHER;
 664                         }
 665
 666                         break;
 667
 668                 case STATE_BRACKET:
 669
 670                         if (i >= *ibuf + isz || /* EOT */
 671                             (!(*i >= '0' && *i <= '9') && *i != ';' && *i != 'm')) {
 672                                 fputc('\x1B', f);
 673                                 fputc('[', f);
 674                                 state = STATE_OTHER;
 675                                 i = begin-1;
 676                         } else if (*i == 'm')
 677                                 state = STATE_OTHER;
 678                         break;
 679                 }
 680         }
 681
 682         if (ferror(f)) {
 683                 fclose(f);
 684                 free(obuf);
 685                 return NULL;
 686         }
 687
 688         fclose(f);
 689
 690         free(*ibuf);
 691         *ibuf = obuf;
 692
 693         if (_isz)
 694                 *_isz = osz;
 695
 696         return obuf;
 697 }
 698
 699 char *strextend(char **x, ...) {
 700         va_list ap;
 701         size_t f, l;
 702         char *r, *p;
 703
 704         assert(x);
 705
 706         l = f = *x ? strlen(*x) : 0;
 707
 708         va_start(ap, x);
 709         for (;;) {
 710                 const char *t;
 711                 size_t n;
 712
 713                 t = va_arg(ap, const char *);
 714                 if (!t)
 715                         break;
 716
 717                 n = strlen(t);
 718                 if (n > ((size_t) -1) - l) {
 719                         va_end(ap);
 720                         return NULL;
 721                 }
 722
 723                 l += n;
 724         }
 725         va_end(ap);
 726
 727         r = realloc(*x, l+1);
 728         if (!r)
 729                 return NULL;
 730
 731         p = r + f;
 732
 733         va_start(ap, x);
 734         for (;;) {
 735                 const char *t;
 736
 737                 t = va_arg(ap, const char *);
 738                 if (!t)
 739                         break;
 740
 741                 p = stpcpy(p, t);
 742         }
 743         va_end(ap);
 744
 745         *p = 0;
 746         *x = r;
 747
 748         return r + l;
 749 }
 750
 751 char *strrep(const char *s, unsigned n) {
 752         size_t l;
 753         char *r, *p;
 754         unsigned i;
 755
 756         assert(s);
 757
 758         l = strlen(s);
 759         p = r = malloc(l * n + 1);
 760         if (!r)
 761                 return NULL;
 762
 763         for (i = 0; i < n; i++)
 764                 p = stpcpy(p, s);
 765
 766         *p = 0;
 767         return r;
 768 }
 769
 770 int split_pair(const char *s, const char *sep, char **l, char **r) {
 771         char *x, *a, *b;
 772
 773         assert(s);
 774         assert(sep);
 775         assert(l);
 776         assert(r);
 777
 778         if (isempty(sep))
 779                 return -EINVAL;
 780
 781         x = strstr(s, sep);
 782         if (!x)
 783                 return -EINVAL;
 784
 785         a = strndup(s, x - s);
 786         if (!a)
 787                 return -ENOMEM;
 788
 789         b = strdup(x + strlen(sep));
 790         if (!b) {
 791                 free(a);
 792                 return -ENOMEM;
 793         }
 794
 795         *l = a;
 796         *r = b;
 797
 798         return 0;
 799 }
 800
 801 int free_and_strdup(char **p, const char *s) {
 802         char *t;
 803
 804         assert(p);
 805
 806         /* Replaces a string pointer with an strdup()ed new string,
 807          * possibly freeing the old one. */
 808
 809         if (streq_ptr(*p, s))
 810                 return 0;
 811
 812         if (s) {
 813                 t = strdup(s);
 814                 if (!t)
 815                         return -ENOMEM;
 816         } else
 817                 t = NULL;
 818
 819         free(*p);
 820         *p = t;
 821
 822         return 1;
 823 }
 824
 825 #pragma GCC push_options
 826 #pragma GCC optimize("O0")
 827
 828 void* memory_erase(void *p, size_t l) {
 829         volatile uint8_t* x = (volatile uint8_t*) p;
 830
 831         /* This basically does what memset() does, but hopefully isn't
 832          * optimized away by the compiler. One of those days, when
 833          * glibc learns memset_s() we should replace this call by
 834          * memset_s(), but until then this has to do. */
 835
 836         for (; l > 0; l--)
 837                 *(x++) = 'x';
 838
 839         return p;
 840 }
 841
 842 #pragma GCC pop_options
 843
 844 char* string_erase(char *x) {
 845
 846         if (!x)
 847                 return NULL;
 848
 849         /* A delicious drop of snake-oil! To be called on memory where
 850          * we stored passphrases or so, after we used them. */
 851
 852         return memory_erase(x, strlen(x));
 853 }
 854
 855 char *string_free_erase(char *s) {
 856         return mfree(string_erase(s));
 857 }
 858
 859 bool string_is_safe(const char *p) {
 860         const char *t;
 861
 862         if (!p)
 863                 return false;
 864
 865         for (t = p; *t; t++) {
 866                 if (*t > 0 && *t < ' ') /* no control characters */
 867                         return false;
 868
 869                 if (strchr(QUOTES "\\\x7f", *t))
 870                         return false;
 871         }
 872
 873         return true;
 874 }