src/basic/fileio.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 <fcntl.h>
  22 #include <limits.h>
  23 #include <stdarg.h>
  24 #include <stdint.h>
  25 #include <stdlib.h>
  26 #include <string.h>
  27 #include <sys/stat.h>
  28 #include <sys/types.h>
  29 #include <unistd.h>
  30
  31 #include "alloc-util.h"
  32 #include "ctype.h"
  33 #include "escape.h"
  34 #include "fd-util.h"
  35 #include "fileio.h"
  36 #include "fs-util.h"
  37 #include "hexdecoct.h"
  38 //#include "log.h"
  39 //#include "macro.h"
  40 #include "missing.h"
  41 #include "parse-util.h"
  42 #include "path-util.h"
  43 #include "random-util.h"
  44 #include "stdio-util.h"
  45 #include "string-util.h"
  46 #include "strv.h"
  47 //#include "time-util.h"
  48 #include "umask-util.h"
  49 #include "utf8.h"
  50
  51 #define READ_FULL_BYTES_MAX (4U*1024U*1024U)
  52
  53 int write_string_stream(FILE *f, const char *line, bool enforce_newline) {
  54
  55         assert(f);
  56         assert(line);
  57
  58         fputs(line, f);
  59         if (enforce_newline && !endswith(line, "\n"))
  60                 fputc('\n', f);
  61
  62         return fflush_and_check(f);
  63 }
  64
  65 static int write_string_file_atomic(const char *fn, const char *line, bool enforce_newline) {
  66         _cleanup_fclose_ FILE *f = NULL;
  67         _cleanup_free_ char *p = NULL;
  68         int r;
  69
  70         assert(fn);
  71         assert(line);
  72
  73         r = fopen_temporary(fn, &f, &p);
  74         if (r < 0)
  75                 return r;
  76
  77         (void) fchmod_umask(fileno(f), 0644);
  78
  79         r = write_string_stream(f, line, enforce_newline);
  80         if (r >= 0) {
  81                 if (rename(p, fn) < 0)
  82                         r = -errno;
  83         }
  84
  85         if (r < 0)
  86                 (void) unlink(p);
  87
  88         return r;
  89 }
  90
  91 int write_string_file(const char *fn, const char *line, WriteStringFileFlags flags) {
  92         _cleanup_fclose_ FILE *f = NULL;
  93         int q, r;
  94
  95         assert(fn);
  96         assert(line);
  97
  98         if (flags & WRITE_STRING_FILE_ATOMIC) {
  99                 assert(flags & WRITE_STRING_FILE_CREATE);
 100
 101                 r = write_string_file_atomic(fn, line, !(flags & WRITE_STRING_FILE_AVOID_NEWLINE));
 102                 if (r < 0)
 103                         goto fail;
 104
 105                 return r;
 106         }
 107
 108         if (flags & WRITE_STRING_FILE_CREATE) {
 109                 f = fopen(fn, "we");
 110                 if (!f) {
 111                         r = -errno;
 112                         goto fail;
 113                 }
 114         } else {
 115                 int fd;
 116
 117                 /* We manually build our own version of fopen(..., "we") that
 118                  * works without O_CREAT */
 119                 fd = open(fn, O_WRONLY|O_CLOEXEC|O_NOCTTY);
 120                 if (fd < 0) {
 121                         r = -errno;
 122                         goto fail;
 123                 }
 124
 125                 f = fdopen(fd, "we");
 126                 if (!f) {
 127                         r = -errno;
 128                         safe_close(fd);
 129                         goto fail;
 130                 }
 131         }
 132
 133         r = write_string_stream(f, line, !(flags & WRITE_STRING_FILE_AVOID_NEWLINE));
 134         if (r < 0)
 135                 goto fail;
 136
 137         return 0;
 138
 139 fail:
 140         if (!(flags & WRITE_STRING_FILE_VERIFY_ON_FAILURE))
 141                 return r;
 142
 143         f = safe_fclose(f);
 144
 145         /* OK, the operation failed, but let's see if the right
 146          * contents in place already. If so, eat up the error. */
 147
 148         q = verify_file(fn, line, !(flags & WRITE_STRING_FILE_AVOID_NEWLINE));
 149         if (q <= 0)
 150                 return r;
 151
 152         return 0;
 153 }
 154
 155 int read_one_line_file(const char *fn, char **line) {
 156         _cleanup_fclose_ FILE *f = NULL;
 157         char t[LINE_MAX], *c;
 158
 159         assert(fn);
 160         assert(line);
 161
 162         f = fopen(fn, "re");
 163         if (!f)
 164                 return -errno;
 165
 166         if (!fgets(t, sizeof(t), f)) {
 167
 168                 if (ferror(f))
 169                         return errno > 0 ? -errno : -EIO;
 170
 171                 t[0] = 0;
 172         }
 173
 174         c = strdup(t);
 175         if (!c)
 176                 return -ENOMEM;
 177         truncate_nl(c);
 178
 179         *line = c;
 180         return 0;
 181 }
 182
 183 int verify_file(const char *fn, const char *blob, bool accept_extra_nl) {
 184         _cleanup_fclose_ FILE *f = NULL;
 185         _cleanup_free_ char *buf = NULL;
 186         size_t l, k;
 187
 188         assert(fn);
 189         assert(blob);
 190
 191         l = strlen(blob);
 192
 193         if (accept_extra_nl && endswith(blob, "\n"))
 194                 accept_extra_nl = false;
 195
 196         buf = malloc(l + accept_extra_nl + 1);
 197         if (!buf)
 198                 return -ENOMEM;
 199
 200         f = fopen(fn, "re");
 201         if (!f)
 202                 return -errno;
 203
 204         /* We try to read one byte more than we need, so that we know whether we hit eof */
 205         errno = 0;
 206         k = fread(buf, 1, l + accept_extra_nl + 1, f);
 207         if (ferror(f))
 208                 return errno > 0 ? -errno : -EIO;
 209
 210         if (k != l && k != l + accept_extra_nl)
 211                 return 0;
 212         if (memcmp(buf, blob, l) != 0)
 213                 return 0;
 214         if (k > l && buf[l] != '\n')
 215                 return 0;
 216
 217         return 1;
 218 }
 219
 220 int read_full_stream(FILE *f, char **contents, size_t *size) {
 221         size_t n, l;
 222         _cleanup_free_ char *buf = NULL;
 223         struct stat st;
 224
 225         assert(f);
 226         assert(contents);
 227
 228         if (fstat(fileno(f), &st) < 0)
 229                 return -errno;
 230
 231         n = LINE_MAX;
 232
 233         if (S_ISREG(st.st_mode)) {
 234
 235                 /* Safety check */
 236                 if (st.st_size > READ_FULL_BYTES_MAX)
 237                         return -E2BIG;
 238
 239                 /* Start with the right file size, but be prepared for
 240                  * files from /proc which generally report a file size
 241                  * of 0 */
 242                 if (st.st_size > 0)
 243                         n = st.st_size;
 244         }
 245
 246         l = 0;
 247         for (;;) {
 248                 char *t;
 249                 size_t k;
 250
 251                 t = realloc(buf, n + 1);
 252                 if (!t)
 253                         return -ENOMEM;
 254
 255                 buf = t;
 256                 k = fread(buf + l, 1, n - l, f);
 257                 if (k > 0)
 258                         l += k;
 259
 260                 if (ferror(f))
 261                         return -errno;
 262
 263                 if (feof(f))
 264                         break;
 265
 266                 /* We aren't expecting fread() to return a short read outside
 267                  * of (error && eof), assert buffer is full and enlarge buffer.
 268                  */
 269                 assert(l == n);
 270
 271                 /* Safety check */
 272                 if (n >= READ_FULL_BYTES_MAX)
 273                         return -E2BIG;
 274
 275                 n = MIN(n * 2, READ_FULL_BYTES_MAX);
 276         }
 277
 278         buf[l] = 0;
 279         *contents = buf;
 280         buf = NULL; /* do not free */
 281
 282         if (size)
 283                 *size = l;
 284
 285         return 0;
 286 }
 287
 288 int read_full_file(const char *fn, char **contents, size_t *size) {
 289         _cleanup_fclose_ FILE *f = NULL;
 290
 291         assert(fn);
 292         assert(contents);
 293
 294         f = fopen(fn, "re");
 295         if (!f)
 296                 return -errno;
 297
 298         return read_full_stream(f, contents, size);
 299 }
 300
 301 static int parse_env_file_internal(
 302                 FILE *f,
 303                 const char *fname,
 304                 const char *newline,
 305                 int (*push) (const char *filename, unsigned line,
 306                              const char *key, char *value, void *userdata, int *n_pushed),
 307                 void *userdata,
 308                 int *n_pushed) {
 309
 310         _cleanup_free_ char *contents = NULL, *key = NULL;
 311         size_t key_alloc = 0, n_key = 0, value_alloc = 0, n_value = 0, last_value_whitespace = (size_t) -1, last_key_whitespace = (size_t) -1;
 312         char *p, *value = NULL;
 313         int r;
 314         unsigned line = 1;
 315
 316         enum {
 317                 PRE_KEY,
 318                 KEY,
 319                 PRE_VALUE,
 320                 VALUE,
 321                 VALUE_ESCAPE,
 322                 SINGLE_QUOTE_VALUE,
 323                 SINGLE_QUOTE_VALUE_ESCAPE,
 324                 DOUBLE_QUOTE_VALUE,
 325                 DOUBLE_QUOTE_VALUE_ESCAPE,
 326                 COMMENT,
 327                 COMMENT_ESCAPE
 328         } state = PRE_KEY;
 329
 330         assert(newline);
 331
 332         if (f)
 333                 r = read_full_stream(f, &contents, NULL);
 334         else
 335                 r = read_full_file(fname, &contents, NULL);
 336         if (r < 0)
 337                 return r;
 338
 339         for (p = contents; *p; p++) {
 340                 char c = *p;
 341
 342                 switch (state) {
 343
 344                 case PRE_KEY:
 345                         if (strchr(COMMENTS, c))
 346                                 state = COMMENT;
 347                         else if (!strchr(WHITESPACE, c)) {
 348                                 state = KEY;
 349                                 last_key_whitespace = (size_t) -1;
 350
 351                                 if (!GREEDY_REALLOC(key, key_alloc, n_key+2)) {
 352                                         r = -ENOMEM;
 353                                         goto fail;
 354                                 }
 355
 356                                 key[n_key++] = c;
 357                         }
 358                         break;
 359
 360                 case KEY:
 361                         if (strchr(newline, c)) {
 362                                 state = PRE_KEY;
 363                                 line++;
 364                                 n_key = 0;
 365                         } else if (c == '=') {
 366                                 state = PRE_VALUE;
 367                                 last_value_whitespace = (size_t) -1;
 368                         } else {
 369                                 if (!strchr(WHITESPACE, c))
 370                                         last_key_whitespace = (size_t) -1;
 371                                 else if (last_key_whitespace == (size_t) -1)
 372                                          last_key_whitespace = n_key;
 373
 374                                 if (!GREEDY_REALLOC(key, key_alloc, n_key+2)) {
 375                                         r = -ENOMEM;
 376                                         goto fail;
 377                                 }
 378
 379                                 key[n_key++] = c;
 380                         }
 381
 382                         break;
 383
 384                 case PRE_VALUE:
 385                         if (strchr(newline, c)) {
 386                                 state = PRE_KEY;
 387                                 line++;
 388                                 key[n_key] = 0;
 389
 390                                 if (value)
 391                                         value[n_value] = 0;
 392
 393                                 /* strip trailing whitespace from key */
 394                                 if (last_key_whitespace != (size_t) -1)
 395                                         key[last_key_whitespace] = 0;
 396
 397                                 r = push(fname, line, key, value, userdata, n_pushed);
 398                                 if (r < 0)
 399                                         goto fail;
 400
 401                                 n_key = 0;
 402                                 value = NULL;
 403                                 value_alloc = n_value = 0;
 404
 405                         } else if (c == '\'')
 406                                 state = SINGLE_QUOTE_VALUE;
 407                         else if (c == '\"')
 408                                 state = DOUBLE_QUOTE_VALUE;
 409                         else if (c == '\\')
 410                                 state = VALUE_ESCAPE;
 411                         else if (!strchr(WHITESPACE, c)) {
 412                                 state = VALUE;
 413
 414                                 if (!GREEDY_REALLOC(value, value_alloc, n_value+2)) {
 415                                         r = -ENOMEM;
 416                                         goto fail;
 417                                 }
 418
 419                                 value[n_value++] = c;
 420                         }
 421
 422                         break;
 423
 424                 case VALUE:
 425                         if (strchr(newline, c)) {
 426                                 state = PRE_KEY;
 427                                 line++;
 428
 429                                 key[n_key] = 0;
 430
 431                                 if (value)
 432                                         value[n_value] = 0;
 433
 434                                 /* Chomp off trailing whitespace from value */
 435                                 if (last_value_whitespace != (size_t) -1)
 436                                         value[last_value_whitespace] = 0;
 437
 438                                 /* strip trailing whitespace from key */
 439                                 if (last_key_whitespace != (size_t) -1)
 440                                         key[last_key_whitespace] = 0;
 441
 442                                 r = push(fname, line, key, value, userdata, n_pushed);
 443                                 if (r < 0)
 444                                         goto fail;
 445
 446                                 n_key = 0;
 447                                 value = NULL;
 448                                 value_alloc = n_value = 0;
 449
 450                         } else if (c == '\\') {
 451                                 state = VALUE_ESCAPE;
 452                                 last_value_whitespace = (size_t) -1;
 453                         } else {
 454                                 if (!strchr(WHITESPACE, c))
 455                                         last_value_whitespace = (size_t) -1;
 456                                 else if (last_value_whitespace == (size_t) -1)
 457                                         last_value_whitespace = n_value;
 458
 459                                 if (!GREEDY_REALLOC(value, value_alloc, n_value+2)) {
 460                                         r = -ENOMEM;
 461                                         goto fail;
 462                                 }
 463
 464                                 value[n_value++] = c;
 465                         }
 466
 467                         break;
 468
 469                 case VALUE_ESCAPE:
 470                         state = VALUE;
 471
 472                         if (!strchr(newline, c)) {
 473                                 /* Escaped newlines we eat up entirely */
 474                                 if (!GREEDY_REALLOC(value, value_alloc, n_value+2)) {
 475                                         r = -ENOMEM;
 476                                         goto fail;
 477                                 }
 478
 479                                 value[n_value++] = c;
 480                         }
 481                         break;
 482
 483                 case SINGLE_QUOTE_VALUE:
 484                         if (c == '\'')
 485                                 state = PRE_VALUE;
 486                         else if (c == '\\')
 487                                 state = SINGLE_QUOTE_VALUE_ESCAPE;
 488                         else {
 489                                 if (!GREEDY_REALLOC(value, value_alloc, n_value+2)) {
 490                                         r = -ENOMEM;
 491                                         goto fail;
 492                                 }
 493
 494                                 value[n_value++] = c;
 495                         }
 496
 497                         break;
 498
 499                 case SINGLE_QUOTE_VALUE_ESCAPE:
 500                         state = SINGLE_QUOTE_VALUE;
 501
 502                         if (!strchr(newline, c)) {
 503                                 if (!GREEDY_REALLOC(value, value_alloc, n_value+2)) {
 504                                         r = -ENOMEM;
 505                                         goto fail;
 506                                 }
 507
 508                                 value[n_value++] = c;
 509                         }
 510                         break;
 511
 512                 case DOUBLE_QUOTE_VALUE:
 513                         if (c == '\"')
 514                                 state = PRE_VALUE;
 515                         else if (c == '\\')
 516                                 state = DOUBLE_QUOTE_VALUE_ESCAPE;
 517                         else {
 518                                 if (!GREEDY_REALLOC(value, value_alloc, n_value+2)) {
 519                                         r = -ENOMEM;
 520                                         goto fail;
 521                                 }
 522
 523                                 value[n_value++] = c;
 524                         }
 525
 526                         break;
 527
 528                 case DOUBLE_QUOTE_VALUE_ESCAPE:
 529                         state = DOUBLE_QUOTE_VALUE;
 530
 531                         if (!strchr(newline, c)) {
 532                                 if (!GREEDY_REALLOC(value, value_alloc, n_value+2)) {
 533                                         r = -ENOMEM;
 534                                         goto fail;
 535                                 }
 536
 537                                 value[n_value++] = c;
 538                         }
 539                         break;
 540
 541                 case COMMENT:
 542                         if (c == '\\')
 543                                 state = COMMENT_ESCAPE;
 544                         else if (strchr(newline, c)) {
 545                                 state = PRE_KEY;
 546                                 line++;
 547                         }
 548                         break;
 549
 550                 case COMMENT_ESCAPE:
 551                         state = COMMENT;
 552                         break;
 553                 }
 554         }
 555
 556         if (state == PRE_VALUE ||
 557             state == VALUE ||
 558             state == VALUE_ESCAPE ||
 559             state == SINGLE_QUOTE_VALUE ||
 560             state == SINGLE_QUOTE_VALUE_ESCAPE ||
 561             state == DOUBLE_QUOTE_VALUE ||
 562             state == DOUBLE_QUOTE_VALUE_ESCAPE) {
 563
 564                 key[n_key] = 0;
 565
 566                 if (value)
 567                         value[n_value] = 0;
 568
 569                 if (state == VALUE)
 570                         if (last_value_whitespace != (size_t) -1)
 571                                 value[last_value_whitespace] = 0;
 572
 573                 /* strip trailing whitespace from key */
 574                 if (last_key_whitespace != (size_t) -1)
 575                         key[last_key_whitespace] = 0;
 576
 577                 r = push(fname, line, key, value, userdata, n_pushed);
 578                 if (r < 0)
 579                         goto fail;
 580         }
 581
 582         return 0;
 583
 584 fail:
 585         free(value);
 586         return r;
 587 }
 588
 589 static int check_utf8ness_and_warn(
 590                 const char *filename, unsigned line,
 591                 const char *key, char *value) {
 592
 593         if (!utf8_is_valid(key)) {
 594                 _cleanup_free_ char *p = NULL;
 595
 596                 p = utf8_escape_invalid(key);
 597                 log_error("%s:%u: invalid UTF-8 in key '%s', ignoring.", strna(filename), line, p);
 598                 return -EINVAL;
 599         }
 600
 601         if (value && !utf8_is_valid(value)) {
 602                 _cleanup_free_ char *p = NULL;
 603
 604                 p = utf8_escape_invalid(value);
 605                 log_error("%s:%u: invalid UTF-8 value for key %s: '%s', ignoring.", strna(filename), line, key, p);
 606                 return -EINVAL;
 607         }
 608
 609         return 0;
 610 }
 611
 612 static int parse_env_file_push(
 613                 const char *filename, unsigned line,
 614                 const char *key, char *value,
 615                 void *userdata,
 616                 int *n_pushed) {
 617
 618         const char *k;
 619         va_list aq, *ap = userdata;
 620         int r;
 621
 622         r = check_utf8ness_and_warn(filename, line, key, value);
 623         if (r < 0)
 624                 return r;
 625
 626         va_copy(aq, *ap);
 627
 628         while ((k = va_arg(aq, const char *))) {
 629                 char **v;
 630
 631                 v = va_arg(aq, char **);
 632
 633                 if (streq(key, k)) {
 634                         va_end(aq);
 635                         free(*v);
 636                         *v = value;
 637
 638                         if (n_pushed)
 639                                 (*n_pushed)++;
 640
 641                         return 1;
 642                 }
 643         }
 644
 645         va_end(aq);
 646         free(value);
 647
 648         return 0;
 649 }
 650
 651 int parse_env_file(
 652                 const char *fname,
 653                 const char *newline, ...) {
 654
 655         va_list ap;
 656         int r, n_pushed = 0;
 657
 658         if (!newline)
 659                 newline = NEWLINE;
 660
 661         va_start(ap, newline);
 662         r = parse_env_file_internal(NULL, fname, newline, parse_env_file_push, &ap, &n_pushed);
 663         va_end(ap);
 664
 665         return r < 0 ? r : n_pushed;
 666 }
 667
 668 #if 0 /// UNNEEDED by elogind
 669 static int load_env_file_push(
 670                 const char *filename, unsigned line,
 671                 const char *key, char *value,
 672                 void *userdata,
 673                 int *n_pushed) {
 674         char ***m = userdata;
 675         char *p;
 676         int r;
 677
 678         r = check_utf8ness_and_warn(filename, line, key, value);
 679         if (r < 0)
 680                 return r;
 681
 682         p = strjoin(key, "=", value);
 683         if (!p)
 684                 return -ENOMEM;
 685
 686         r = strv_env_replace(m, p);
 687         if (r < 0) {
 688                 free(p);
 689                 return r;
 690         }
 691
 692         if (n_pushed)
 693                 (*n_pushed)++;
 694
 695         free(value);
 696         return 0;
 697 }
 698
 699 int load_env_file(FILE *f, const char *fname, const char *newline, char ***rl) {
 700         char **m = NULL;
 701         int r;
 702
 703         if (!newline)
 704                 newline = NEWLINE;
 705
 706         r = parse_env_file_internal(f, fname, newline, load_env_file_push, &m, NULL);
 707         if (r < 0) {
 708                 strv_free(m);
 709                 return r;
 710         }
 711
 712         *rl = m;
 713         return 0;
 714 }
 715
 716 static int load_env_file_push_pairs(
 717                 const char *filename, unsigned line,
 718                 const char *key, char *value,
 719                 void *userdata,
 720                 int *n_pushed) {
 721         char ***m = userdata;
 722         int r;
 723
 724         r = check_utf8ness_and_warn(filename, line, key, value);
 725         if (r < 0)
 726                 return r;
 727
 728         r = strv_extend(m, key);
 729         if (r < 0)
 730                 return -ENOMEM;
 731
 732         if (!value) {
 733                 r = strv_extend(m, "");
 734                 if (r < 0)
 735                         return -ENOMEM;
 736         } else {
 737                 r = strv_push(m, value);
 738                 if (r < 0)
 739                         return r;
 740         }
 741
 742         if (n_pushed)
 743                 (*n_pushed)++;
 744
 745         return 0;
 746 }
 747
 748 int load_env_file_pairs(FILE *f, const char *fname, const char *newline, char ***rl) {
 749         char **m = NULL;
 750         int r;
 751
 752         if (!newline)
 753                 newline = NEWLINE;
 754
 755         r = parse_env_file_internal(f, fname, newline, load_env_file_push_pairs, &m, NULL);
 756         if (r < 0) {
 757                 strv_free(m);
 758                 return r;
 759         }
 760
 761         *rl = m;
 762         return 0;
 763 }
 764
 765 static int merge_env_file_push(
 766                 const char *filename, unsigned line,
 767                 const char *key, char *value,
 768                 void *userdata,
 769                 int *n_pushed) {
 770
 771         char ***env = userdata;
 772         char *expanded_value;
 773
 774         assert(env);
 775
 776         if (!value) {
 777                 log_error("%s:%u: invalid syntax (around \"%s\"), ignoring.", strna(filename), line, key);
 778                 return 0;
 779         }
 780
 781         if (!env_name_is_valid(key)) {
 782                 log_error("%s:%u: invalid variable name \"%s\", ignoring.", strna(filename), line, key);
 783                 return 0;
 784         }
 785
 786         expanded_value = replace_env(value, *env,
 787                                      REPLACE_ENV_USE_ENVIRONMENT|REPLACE_ENV_ALLOW_BRACELESS);
 788         if (!expanded_value)
 789                 return -ENOMEM;
 790
 791         free_and_replace(value, expanded_value);
 792
 793         return load_env_file_push(filename, line, key, value, env, n_pushed);
 794 }
 795
 796 int merge_env_file(
 797                 char ***env,
 798                 FILE *f,
 799                 const char *fname) {
 800
 801         /* NOTE: this function supports braceful and braceless variable expansions,
 802          * unlike other exported parsing functions.
 803          */
 804
 805         return parse_env_file_internal(f, fname, NEWLINE, merge_env_file_push, env, NULL);
 806 }
 807
 808 static void write_env_var(FILE *f, const char *v) {
 809         const char *p;
 810
 811         p = strchr(v, '=');
 812         if (!p) {
 813                 /* Fallback */
 814                 fputs(v, f);
 815                 fputc('\n', f);
 816                 return;
 817         }
 818
 819         p++;
 820         fwrite(v, 1, p-v, f);
 821
 822         if (string_has_cc(p, NULL) || chars_intersect(p, WHITESPACE SHELL_NEED_QUOTES)) {
 823                 fputc('\"', f);
 824
 825                 for (; *p; p++) {
 826                         if (strchr(SHELL_NEED_ESCAPE, *p))
 827                                 fputc('\\', f);
 828
 829                         fputc(*p, f);
 830                 }
 831
 832                 fputc('\"', f);
 833         } else
 834                 fputs(p, f);
 835
 836         fputc('\n', f);
 837 }
 838
 839 int write_env_file(const char *fname, char **l) {
 840         _cleanup_fclose_ FILE *f = NULL;
 841         _cleanup_free_ char *p = NULL;
 842         char **i;
 843         int r;
 844
 845         assert(fname);
 846
 847         r = fopen_temporary(fname, &f, &p);
 848         if (r < 0)
 849                 return r;
 850
 851         fchmod_umask(fileno(f), 0644);
 852
 853         STRV_FOREACH(i, l)
 854                 write_env_var(f, *i);
 855
 856         r = fflush_and_check(f);
 857         if (r >= 0) {
 858                 if (rename(p, fname) >= 0)
 859                         return 0;
 860
 861                 r = -errno;
 862         }
 863
 864         unlink(p);
 865         return r;
 866 }
 867
 868 int executable_is_script(const char *path, char **interpreter) {
 869         int r;
 870         _cleanup_free_ char *line = NULL;
 871         int len;
 872         char *ans;
 873
 874         assert(path);
 875
 876         r = read_one_line_file(path, &line);
 877         if (r < 0)
 878                 return r;
 879
 880         if (!startswith(line, "#!"))
 881                 return 0;
 882
 883         ans = strstrip(line + 2);
 884         len = strcspn(ans, " \t");
 885
 886         if (len == 0)
 887                 return 0;
 888
 889         ans = strndup(ans, len);
 890         if (!ans)
 891                 return -ENOMEM;
 892
 893         *interpreter = ans;
 894         return 1;
 895 }
 896 #endif // 0
 897
 898 /**
 899  * Retrieve one field from a file like /proc/self/status.  pattern
 900  * should not include whitespace or the delimiter (':'). pattern matches only
 901  * the beginning of a line. Whitespace before ':' is skipped. Whitespace and
 902  * zeros after the ':' will be skipped. field must be freed afterwards.
 903  * terminator specifies the terminating characters of the field value (not
 904  * included in the value).
 905  */
 906 int get_proc_field(const char *filename, const char *pattern, const char *terminator, char **field) {
 907         _cleanup_free_ char *status = NULL;
 908         char *t, *f;
 909         size_t len;
 910         int r;
 911
 912         assert(terminator);
 913         assert(filename);
 914         assert(pattern);
 915         assert(field);
 916
 917         r = read_full_file(filename, &status, NULL);
 918         if (r < 0)
 919                 return r;
 920
 921         t = status;
 922
 923         do {
 924                 bool pattern_ok;
 925
 926                 do {
 927                         t = strstr(t, pattern);
 928                         if (!t)
 929                                 return -ENOENT;
 930
 931                         /* Check that pattern occurs in beginning of line. */
 932                         pattern_ok = (t == status || t[-1] == '\n');
 933
 934                         t += strlen(pattern);
 935
 936                 } while (!pattern_ok);
 937
 938                 t += strspn(t, " \t");
 939                 if (!*t)
 940                         return -ENOENT;
 941
 942         } while (*t != ':');
 943
 944         t++;
 945
 946         if (*t) {
 947                 t += strspn(t, " \t");
 948
 949                 /* Also skip zeros, because when this is used for
 950                  * capabilities, we don't want the zeros. This way the
 951                  * same capability set always maps to the same string,
 952                  * irrespective of the total capability set size. For
 953                  * other numbers it shouldn't matter. */
 954                 t += strspn(t, "0");
 955                 /* Back off one char if there's nothing but whitespace
 956                    and zeros */
 957                 if (!*t || isspace(*t))
 958                         t--;
 959         }
 960
 961         len = strcspn(t, terminator);
 962
 963         f = strndup(t, len);
 964         if (!f)
 965                 return -ENOMEM;
 966
 967         *field = f;
 968         return 0;
 969 }
 970
 971 DIR *xopendirat(int fd, const char *name, int flags) {
 972         int nfd;
 973         DIR *d;
 974
 975         assert(!(flags & O_CREAT));
 976
 977         nfd = openat(fd, name, O_RDONLY|O_NONBLOCK|O_DIRECTORY|O_CLOEXEC|flags, 0);
 978         if (nfd < 0)
 979                 return NULL;
 980
 981         d = fdopendir(nfd);
 982         if (!d) {
 983                 safe_close(nfd);
 984                 return NULL;
 985         }
 986
 987         return d;
 988 }
 989
 990 #if 0 /// UNNEEDED by elogind
 991 static int search_and_fopen_internal(const char *path, const char *mode, const char *root, char **search, FILE **_f) {
 992         char **i;
 993
 994         assert(path);
 995         assert(mode);
 996         assert(_f);
 997
 998         if (!path_strv_resolve_uniq(search, root))
 999                 return -ENOMEM;
1000
1001         STRV_FOREACH(i, search) {
1002                 _cleanup_free_ char *p = NULL;
1003                 FILE *f;
1004
1005                 if (root)
1006                         p = strjoin(root, *i, "/", path);
1007                 else
1008                         p = strjoin(*i, "/", path);
1009                 if (!p)
1010                         return -ENOMEM;
1011
1012                 f = fopen(p, mode);
1013                 if (f) {
1014                         *_f = f;
1015                         return 0;
1016                 }
1017
1018                 if (errno != ENOENT)
1019                         return -errno;
1020         }
1021
1022         return -ENOENT;
1023 }
1024
1025 int search_and_fopen(const char *path, const char *mode, const char *root, const char **search, FILE **_f) {
1026         _cleanup_strv_free_ char **copy = NULL;
1027
1028         assert(path);
1029         assert(mode);
1030         assert(_f);
1031
1032         if (path_is_absolute(path)) {
1033                 FILE *f;
1034
1035                 f = fopen(path, mode);
1036                 if (f) {
1037                         *_f = f;
1038                         return 0;
1039                 }
1040
1041                 return -errno;
1042         }
1043
1044         copy = strv_copy((char**) search);
1045         if (!copy)
1046                 return -ENOMEM;
1047
1048         return search_and_fopen_internal(path, mode, root, copy, _f);
1049 }
1050
1051 int search_and_fopen_nulstr(const char *path, const char *mode, const char *root, const char *search, FILE **_f) {
1052         _cleanup_strv_free_ char **s = NULL;
1053
1054         if (path_is_absolute(path)) {
1055                 FILE *f;
1056
1057                 f = fopen(path, mode);
1058                 if (f) {
1059                         *_f = f;
1060                         return 0;
1061                 }
1062
1063                 return -errno;
1064         }
1065
1066         s = strv_split_nulstr(search);
1067         if (!s)
1068                 return -ENOMEM;
1069
1070         return search_and_fopen_internal(path, mode, root, s, _f);
1071 }
1072 #endif // 0
1073
1074 int fopen_temporary(const char *path, FILE **_f, char **_temp_path) {
1075         FILE *f;
1076         char *t;
1077         int r, fd;
1078
1079         assert(path);
1080         assert(_f);
1081         assert(_temp_path);
1082
1083         r = tempfn_xxxxxx(path, NULL, &t);
1084         if (r < 0)
1085                 return r;
1086
1087         fd = mkostemp_safe(t);
1088         if (fd < 0) {
1089                 free(t);
1090                 return -errno;
1091         }
1092
1093         f = fdopen(fd, "we");
1094         if (!f) {
1095                 unlink_noerrno(t);
1096                 free(t);
1097                 safe_close(fd);
1098                 return -errno;
1099         }
1100
1101         *_f = f;
1102         *_temp_path = t;
1103
1104         return 0;
1105 }
1106
1107 int fflush_and_check(FILE *f) {
1108         assert(f);
1109
1110         errno = 0;
1111         fflush(f);
1112
1113         if (ferror(f))
1114                 return errno > 0 ? -errno : -EIO;
1115
1116         return 0;
1117 }
1118
1119 /* This is much like mkostemp() but is subject to umask(). */
1120 int mkostemp_safe(char *pattern) {
1121         _cleanup_umask_ mode_t u = 0;
1122         int fd;
1123
1124         assert(pattern);
1125
1126         u = umask(077);
1127
1128         fd = mkostemp(pattern, O_CLOEXEC);
1129         if (fd < 0)
1130                 return -errno;
1131
1132         return fd;
1133 }
1134
1135 int tempfn_xxxxxx(const char *p, const char *extra, char **ret) {
1136         const char *fn;
1137         char *t;
1138
1139         assert(p);
1140         assert(ret);
1141
1142         /*
1143          * Turns this:
1144          *         /foo/bar/waldo
1145          *
1146          * Into this:
1147          *         /foo/bar/.#<extra>waldoXXXXXX
1148          */
1149
1150         fn = basename(p);
1151         if (!filename_is_valid(fn))
1152                 return -EINVAL;
1153
1154         if (extra == NULL)
1155                 extra = "";
1156
1157         t = new(char, strlen(p) + 2 + strlen(extra) + 6 + 1);
1158         if (!t)
1159                 return -ENOMEM;
1160
1161         strcpy(stpcpy(stpcpy(stpcpy(mempcpy(t, p, fn - p), ".#"), extra), fn), "XXXXXX");
1162
1163         *ret = path_kill_slashes(t);
1164         return 0;
1165 }
1166
1167 int tempfn_random(const char *p, const char *extra, char **ret) {
1168         const char *fn;
1169         char *t, *x;
1170         uint64_t u;
1171         unsigned i;
1172
1173         assert(p);
1174         assert(ret);
1175
1176         /*
1177          * Turns this:
1178          *         /foo/bar/waldo
1179          *
1180          * Into this:
1181          *         /foo/bar/.#<extra>waldobaa2a261115984a9
1182          */
1183
1184         fn = basename(p);
1185         if (!filename_is_valid(fn))
1186                 return -EINVAL;
1187
1188         if (!extra)
1189                 extra = "";
1190
1191         t = new(char, strlen(p) + 2 + strlen(extra) + 16 + 1);
1192         if (!t)
1193                 return -ENOMEM;
1194
1195         x = stpcpy(stpcpy(stpcpy(mempcpy(t, p, fn - p), ".#"), extra), fn);
1196
1197         u = random_u64();
1198         for (i = 0; i < 16; i++) {
1199                 *(x++) = hexchar(u & 0xF);
1200                 u >>= 4;
1201         }
1202
1203         *x = 0;
1204
1205         *ret = path_kill_slashes(t);
1206         return 0;
1207 }
1208
1209 #if 0 /// UNNEEDED by elogind
1210 int tempfn_random_child(const char *p, const char *extra, char **ret) {
1211         char *t, *x;
1212         uint64_t u;
1213         unsigned i;
1214         int r;
1215
1216         assert(ret);
1217
1218         /* Turns this:
1219          *         /foo/bar/waldo
1220          * Into this:
1221          *         /foo/bar/waldo/.#<extra>3c2b6219aa75d7d0
1222          */
1223
1224         if (!p) {
1225                 r = tmp_dir(&p);
1226                 if (r < 0)
1227                         return r;
1228         }
1229
1230         if (!extra)
1231                 extra = "";
1232
1233         t = new(char, strlen(p) + 3 + strlen(extra) + 16 + 1);
1234         if (!t)
1235                 return -ENOMEM;
1236
1237         x = stpcpy(stpcpy(stpcpy(t, p), "/.#"), extra);
1238
1239         u = random_u64();
1240         for (i = 0; i < 16; i++) {
1241                 *(x++) = hexchar(u & 0xF);
1242                 u >>= 4;
1243         }
1244
1245         *x = 0;
1246
1247         *ret = path_kill_slashes(t);
1248         return 0;
1249 }
1250
1251 int write_timestamp_file_atomic(const char *fn, usec_t n) {
1252         char ln[DECIMAL_STR_MAX(n)+2];
1253
1254         /* Creates a "timestamp" file, that contains nothing but a
1255          * usec_t timestamp, formatted in ASCII. */
1256
1257         if (n <= 0 || n >= USEC_INFINITY)
1258                 return -ERANGE;
1259
1260         xsprintf(ln, USEC_FMT "\n", n);
1261
1262         return write_string_file(fn, ln, WRITE_STRING_FILE_CREATE|WRITE_STRING_FILE_ATOMIC);
1263 }
1264
1265 int read_timestamp_file(const char *fn, usec_t *ret) {
1266         _cleanup_free_ char *ln = NULL;
1267         uint64_t t;
1268         int r;
1269
1270         r = read_one_line_file(fn, &ln);
1271         if (r < 0)
1272                 return r;
1273
1274         r = safe_atou64(ln, &t);
1275         if (r < 0)
1276                 return r;
1277
1278         if (t <= 0 || t >= (uint64_t) USEC_INFINITY)
1279                 return -ERANGE;
1280
1281         *ret = (usec_t) t;
1282         return 0;
1283 }
1284
1285 int fputs_with_space(FILE *f, const char *s, const char *separator, bool *space) {
1286         int r;
1287
1288         assert(s);
1289
1290         /* Outputs the specified string with fputs(), but optionally prefixes it with a separator. The *space parameter
1291          * when specified shall initially point to a boolean variable initialized to false. It is set to true after the
1292          * first invocation. This call is supposed to be use in loops, where a separator shall be inserted between each
1293          * element, but not before the first one. */
1294
1295         if (!f)
1296                 f = stdout;
1297
1298         if (space) {
1299                 if (!separator)
1300                         separator = " ";
1301
1302                 if (*space) {
1303                         r = fputs(separator, f);
1304                         if (r < 0)
1305                                 return r;
1306                 }
1307
1308                 *space = true;
1309         }
1310
1311         return fputs(s, f);
1312 }
1313
1314 int open_tmpfile_unlinkable(const char *directory, int flags) {
1315         char *p;
1316         int fd, r;
1317
1318         if (!directory) {
1319                 r = tmp_dir(&directory);
1320                 if (r < 0)
1321                         return r;
1322         }
1323
1324         /* Returns an unlinked temporary file that cannot be linked into the file system anymore */
1325
1326         /* Try O_TMPFILE first, if it is supported */
1327         fd = open(directory, flags|O_TMPFILE|O_EXCL, S_IRUSR|S_IWUSR);
1328         if (fd >= 0)
1329                 return fd;
1330
1331         /* Fall back to unguessable name + unlinking */
1332         p = strjoina(directory, "/systemd-tmp-XXXXXX");
1333
1334         fd = mkostemp_safe(p);
1335         if (fd < 0)
1336                 return fd;
1337
1338         (void) unlink(p);
1339
1340         return fd;
1341 }
1342
1343 int open_tmpfile_linkable(const char *target, int flags, char **ret_path) {
1344         _cleanup_free_ char *tmp = NULL;
1345         int r, fd;
1346
1347         assert(target);
1348         assert(ret_path);
1349
1350         /* Don't allow O_EXCL, as that has a special meaning for O_TMPFILE */
1351         assert((flags & O_EXCL) == 0);
1352
1353         /* Creates a temporary file, that shall be renamed to "target" later. If possible, this uses O_TMPFILE – in
1354          * which case "ret_path" will be returned as NULL. If not possible a the tempoary path name used is returned in
1355          * "ret_path". Use link_tmpfile() below to rename the result after writing the file in full. */
1356
1357         {
1358                 _cleanup_free_ char *dn = NULL;
1359
1360                 dn = dirname_malloc(target);
1361                 if (!dn)
1362                         return -ENOMEM;
1363
1364                 fd = open(dn, O_TMPFILE|flags, 0640);
1365                 if (fd >= 0) {
1366                         *ret_path = NULL;
1367                         return fd;
1368                 }
1369
1370                 log_debug_errno(errno, "Failed to use O_TMPFILE on %s: %m", dn);
1371         }
1372
1373         r = tempfn_random(target, NULL, &tmp);
1374         if (r < 0)
1375                 return r;
1376
1377         fd = open(tmp, O_CREAT|O_EXCL|O_NOFOLLOW|O_NOCTTY|flags, 0640);
1378         if (fd < 0)
1379                 return -errno;
1380
1381         *ret_path = tmp;
1382         tmp = NULL;
1383
1384         return fd;
1385 }
1386
1387 int open_serialization_fd(const char *ident) {
1388         int fd = -1;
1389
1390         fd = memfd_create(ident, MFD_CLOEXEC);
1391         if (fd < 0) {
1392                 const char *path;
1393
1394                 path = getpid() == 1 ? "/run/systemd" : "/tmp";
1395                 fd = open_tmpfile_unlinkable(path, O_RDWR|O_CLOEXEC);
1396                 if (fd < 0)
1397                         return fd;
1398
1399                 log_debug("Serializing %s to %s.", ident, path);
1400         } else
1401                 log_debug("Serializing %s to memfd.", ident);
1402
1403         return fd;
1404 }
1405
1406 int link_tmpfile(int fd, const char *path, const char *target) {
1407
1408         assert(fd >= 0);
1409         assert(target);
1410
1411         /* Moves a temporary file created with open_tmpfile() above into its final place. if "path" is NULL an fd
1412          * created with O_TMPFILE is assumed, and linkat() is used. Otherwise it is assumed O_TMPFILE is not supported
1413          * on the directory, and renameat2() is used instead.
1414          *
1415          * Note that in both cases we will not replace existing files. This is because linkat() does not support this
1416          * operation currently (renameat2() does), and there is no nice way to emulate this. */
1417
1418         if (path) {
1419                 if (rename_noreplace(AT_FDCWD, path, AT_FDCWD, target) < 0)
1420                         return -errno;
1421         } else {
1422                 char proc_fd_path[strlen("/proc/self/fd/") + DECIMAL_STR_MAX(fd) + 1];
1423
1424                 xsprintf(proc_fd_path, "/proc/self/fd/%i", fd);
1425
1426                 if (linkat(AT_FDCWD, proc_fd_path, AT_FDCWD, target, AT_SYMLINK_FOLLOW) < 0)
1427                         return -errno;
1428         }
1429
1430         return 0;
1431 }
1432 #endif // 0
1433
1434 int read_nul_string(FILE *f, char **ret) {
1435         _cleanup_free_ char *x = NULL;
1436         size_t allocated = 0, n = 0;
1437
1438         assert(f);
1439         assert(ret);
1440
1441         /* Reads a NUL-terminated string from the specified file. */
1442
1443         for (;;) {
1444                 int c;
1445
1446                 if (!GREEDY_REALLOC(x, allocated, n+2))
1447                         return -ENOMEM;
1448
1449                 c = fgetc(f);
1450                 if (c == 0) /* Terminate at NUL byte */
1451                         break;
1452                 if (c == EOF) {
1453                         if (ferror(f))
1454                                 return -errno;
1455                         break; /* Terminate at EOF */
1456                 }
1457
1458                 x[n++] = (char) c;
1459         }
1460
1461         if (x)
1462                 x[n] = 0;
1463         else {
1464                 x = new0(char, 1);
1465                 if (!x)
1466                         return -ENOMEM;
1467         }
1468
1469         *ret = x;
1470         x = NULL;
1471
1472         return 0;
1473 }
1474
1475 int mkdtemp_malloc(const char *template, char **ret) {
1476         char *p;
1477
1478         assert(template);
1479         assert(ret);
1480
1481         p = strdup(template);
1482         if (!p)
1483                 return -ENOMEM;
1484
1485         if (!mkdtemp(p)) {
1486                 free(p);
1487                 return -errno;
1488         }
1489
1490         *ret = p;
1491         return 0;
1492 }