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