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                 free(value);
 784                 return 0;
 785         }
 786
 787         expanded_value = replace_env(value, *env,
 788                                      REPLACE_ENV_USE_ENVIRONMENT|REPLACE_ENV_ALLOW_BRACELESS);
 789         if (!expanded_value)
 790                 return -ENOMEM;
 791
 792         free_and_replace(value, expanded_value);
 793
 794         return load_env_file_push(filename, line, key, value, env, n_pushed);
 795 }
 796
 797 int merge_env_file(
 798                 char ***env,
 799                 FILE *f,
 800                 const char *fname) {
 801
 802         /* NOTE: this function supports braceful and braceless variable expansions,
 803          * unlike other exported parsing functions.
 804          */
 805
 806         return parse_env_file_internal(f, fname, NEWLINE, merge_env_file_push, env, NULL);
 807 }
 808
 809 static void write_env_var(FILE *f, const char *v) {
 810         const char *p;
 811
 812         p = strchr(v, '=');
 813         if (!p) {
 814                 /* Fallback */
 815                 fputs(v, f);
 816                 fputc('\n', f);
 817                 return;
 818         }
 819
 820         p++;
 821         fwrite(v, 1, p-v, f);
 822
 823         if (string_has_cc(p, NULL) || chars_intersect(p, WHITESPACE SHELL_NEED_QUOTES)) {
 824                 fputc('\"', f);
 825
 826                 for (; *p; p++) {
 827                         if (strchr(SHELL_NEED_ESCAPE, *p))
 828                                 fputc('\\', f);
 829
 830                         fputc(*p, f);
 831                 }
 832
 833                 fputc('\"', f);
 834         } else
 835                 fputs(p, f);
 836
 837         fputc('\n', f);
 838 }
 839
 840 int write_env_file(const char *fname, char **l) {
 841         _cleanup_fclose_ FILE *f = NULL;
 842         _cleanup_free_ char *p = NULL;
 843         char **i;
 844         int r;
 845
 846         assert(fname);
 847
 848         r = fopen_temporary(fname, &f, &p);
 849         if (r < 0)
 850                 return r;
 851
 852         fchmod_umask(fileno(f), 0644);
 853
 854         STRV_FOREACH(i, l)
 855                 write_env_var(f, *i);
 856
 857         r = fflush_and_check(f);
 858         if (r >= 0) {
 859                 if (rename(p, fname) >= 0)
 860                         return 0;
 861
 862                 r = -errno;
 863         }
 864
 865         unlink(p);
 866         return r;
 867 }
 868
 869 int executable_is_script(const char *path, char **interpreter) {
 870         int r;
 871         _cleanup_free_ char *line = NULL;
 872         int len;
 873         char *ans;
 874
 875         assert(path);
 876
 877         r = read_one_line_file(path, &line);
 878         if (r < 0)
 879                 return r;
 880
 881         if (!startswith(line, "#!"))
 882                 return 0;
 883
 884         ans = strstrip(line + 2);
 885         len = strcspn(ans, " \t");
 886
 887         if (len == 0)
 888                 return 0;
 889
 890         ans = strndup(ans, len);
 891         if (!ans)
 892                 return -ENOMEM;
 893
 894         *interpreter = ans;
 895         return 1;
 896 }
 897 #endif // 0
 898
 899 /**
 900  * Retrieve one field from a file like /proc/self/status.  pattern
 901  * should not include whitespace or the delimiter (':'). pattern matches only
 902  * the beginning of a line. Whitespace before ':' is skipped. Whitespace and
 903  * zeros after the ':' will be skipped. field must be freed afterwards.
 904  * terminator specifies the terminating characters of the field value (not
 905  * included in the value).
 906  */
 907 int get_proc_field(const char *filename, const char *pattern, const char *terminator, char **field) {
 908         _cleanup_free_ char *status = NULL;
 909         char *t, *f;
 910         size_t len;
 911         int r;
 912
 913         assert(terminator);
 914         assert(filename);
 915         assert(pattern);
 916         assert(field);
 917
 918         r = read_full_file(filename, &status, NULL);
 919         if (r < 0)
 920                 return r;
 921
 922         t = status;
 923
 924         do {
 925                 bool pattern_ok;
 926
 927                 do {
 928                         t = strstr(t, pattern);
 929                         if (!t)
 930                                 return -ENOENT;
 931
 932                         /* Check that pattern occurs in beginning of line. */
 933                         pattern_ok = (t == status || t[-1] == '\n');
 934
 935                         t += strlen(pattern);
 936
 937                 } while (!pattern_ok);
 938
 939                 t += strspn(t, " \t");
 940                 if (!*t)
 941                         return -ENOENT;
 942
 943         } while (*t != ':');
 944
 945         t++;
 946
 947         if (*t) {
 948                 t += strspn(t, " \t");
 949
 950                 /* Also skip zeros, because when this is used for
 951                  * capabilities, we don't want the zeros. This way the
 952                  * same capability set always maps to the same string,
 953                  * irrespective of the total capability set size. For
 954                  * other numbers it shouldn't matter. */
 955                 t += strspn(t, "0");
 956                 /* Back off one char if there's nothing but whitespace
 957                    and zeros */
 958                 if (!*t || isspace(*t))
 959                         t--;
 960         }
 961
 962         len = strcspn(t, terminator);
 963
 964         f = strndup(t, len);
 965         if (!f)
 966                 return -ENOMEM;
 967
 968         *field = f;
 969         return 0;
 970 }
 971
 972 DIR *xopendirat(int fd, const char *name, int flags) {
 973         int nfd;
 974         DIR *d;
 975
 976         assert(!(flags & O_CREAT));
 977
 978         nfd = openat(fd, name, O_RDONLY|O_NONBLOCK|O_DIRECTORY|O_CLOEXEC|flags, 0);
 979         if (nfd < 0)
 980                 return NULL;
 981
 982         d = fdopendir(nfd);
 983         if (!d) {
 984                 safe_close(nfd);
 985                 return NULL;
 986         }
 987
 988         return d;
 989 }
 990
 991 #if 0 /// UNNEEDED by elogind
 992 static int search_and_fopen_internal(const char *path, const char *mode, const char *root, char **search, FILE **_f) {
 993         char **i;
 994
 995         assert(path);
 996         assert(mode);
 997         assert(_f);
 998
 999         if (!path_strv_resolve_uniq(search, root))
1000                 return -ENOMEM;
1001
1002         STRV_FOREACH(i, search) {
1003                 _cleanup_free_ char *p = NULL;
1004                 FILE *f;
1005
1006                 if (root)
1007                         p = strjoin(root, *i, "/", path);
1008                 else
1009                         p = strjoin(*i, "/", path);
1010                 if (!p)
1011                         return -ENOMEM;
1012
1013                 f = fopen(p, mode);
1014                 if (f) {
1015                         *_f = f;
1016                         return 0;
1017                 }
1018
1019                 if (errno != ENOENT)
1020                         return -errno;
1021         }
1022
1023         return -ENOENT;
1024 }
1025
1026 int search_and_fopen(const char *path, const char *mode, const char *root, const char **search, FILE **_f) {
1027         _cleanup_strv_free_ char **copy = NULL;
1028
1029         assert(path);
1030         assert(mode);
1031         assert(_f);
1032
1033         if (path_is_absolute(path)) {
1034                 FILE *f;
1035
1036                 f = fopen(path, mode);
1037                 if (f) {
1038                         *_f = f;
1039                         return 0;
1040                 }
1041
1042                 return -errno;
1043         }
1044
1045         copy = strv_copy((char**) search);
1046         if (!copy)
1047                 return -ENOMEM;
1048
1049         return search_and_fopen_internal(path, mode, root, copy, _f);
1050 }
1051
1052 int search_and_fopen_nulstr(const char *path, const char *mode, const char *root, const char *search, FILE **_f) {
1053         _cleanup_strv_free_ char **s = NULL;
1054
1055         if (path_is_absolute(path)) {
1056                 FILE *f;
1057
1058                 f = fopen(path, mode);
1059                 if (f) {
1060                         *_f = f;
1061                         return 0;
1062                 }
1063
1064                 return -errno;
1065         }
1066
1067         s = strv_split_nulstr(search);
1068         if (!s)
1069                 return -ENOMEM;
1070
1071         return search_and_fopen_internal(path, mode, root, s, _f);
1072 }
1073 #endif // 0
1074
1075 int fopen_temporary(const char *path, FILE **_f, char **_temp_path) {
1076         FILE *f;
1077         char *t;
1078         int r, fd;
1079
1080         assert(path);
1081         assert(_f);
1082         assert(_temp_path);
1083
1084         r = tempfn_xxxxxx(path, NULL, &t);
1085         if (r < 0)
1086                 return r;
1087
1088         fd = mkostemp_safe(t);
1089         if (fd < 0) {
1090                 free(t);
1091                 return -errno;
1092         }
1093
1094         f = fdopen(fd, "we");
1095         if (!f) {
1096                 unlink_noerrno(t);
1097                 free(t);
1098                 safe_close(fd);
1099                 return -errno;
1100         }
1101
1102         *_f = f;
1103         *_temp_path = t;
1104
1105         return 0;
1106 }
1107
1108 int fflush_and_check(FILE *f) {
1109         assert(f);
1110
1111         errno = 0;
1112         fflush(f);
1113
1114         if (ferror(f))
1115                 return errno > 0 ? -errno : -EIO;
1116
1117         return 0;
1118 }
1119
1120 /* This is much like mkostemp() but is subject to umask(). */
1121 int mkostemp_safe(char *pattern) {
1122         _cleanup_umask_ mode_t u = 0;
1123         int fd;
1124
1125         assert(pattern);
1126
1127         u = umask(077);
1128
1129         fd = mkostemp(pattern, O_CLOEXEC);
1130         if (fd < 0)
1131                 return -errno;
1132
1133         return fd;
1134 }
1135
1136 int tempfn_xxxxxx(const char *p, const char *extra, char **ret) {
1137         const char *fn;
1138         char *t;
1139
1140         assert(p);
1141         assert(ret);
1142
1143         /*
1144          * Turns this:
1145          *         /foo/bar/waldo
1146          *
1147          * Into this:
1148          *         /foo/bar/.#<extra>waldoXXXXXX
1149          */
1150
1151         fn = basename(p);
1152         if (!filename_is_valid(fn))
1153                 return -EINVAL;
1154
1155         if (extra == NULL)
1156                 extra = "";
1157
1158         t = new(char, strlen(p) + 2 + strlen(extra) + 6 + 1);
1159         if (!t)
1160                 return -ENOMEM;
1161
1162         strcpy(stpcpy(stpcpy(stpcpy(mempcpy(t, p, fn - p), ".#"), extra), fn), "XXXXXX");
1163
1164         *ret = path_kill_slashes(t);
1165         return 0;
1166 }
1167
1168 int tempfn_random(const char *p, const char *extra, char **ret) {
1169         const char *fn;
1170         char *t, *x;
1171         uint64_t u;
1172         unsigned i;
1173
1174         assert(p);
1175         assert(ret);
1176
1177         /*
1178          * Turns this:
1179          *         /foo/bar/waldo
1180          *
1181          * Into this:
1182          *         /foo/bar/.#<extra>waldobaa2a261115984a9
1183          */
1184
1185         fn = basename(p);
1186         if (!filename_is_valid(fn))
1187                 return -EINVAL;
1188
1189         if (!extra)
1190                 extra = "";
1191
1192         t = new(char, strlen(p) + 2 + strlen(extra) + 16 + 1);
1193         if (!t)
1194                 return -ENOMEM;
1195
1196         x = stpcpy(stpcpy(stpcpy(mempcpy(t, p, fn - p), ".#"), extra), fn);
1197
1198         u = random_u64();
1199         for (i = 0; i < 16; i++) {
1200                 *(x++) = hexchar(u & 0xF);
1201                 u >>= 4;
1202         }
1203
1204         *x = 0;
1205
1206         *ret = path_kill_slashes(t);
1207         return 0;
1208 }
1209
1210 #if 0 /// UNNEEDED by elogind
1211 int tempfn_random_child(const char *p, const char *extra, char **ret) {
1212         char *t, *x;
1213         uint64_t u;
1214         unsigned i;
1215         int r;
1216
1217         assert(ret);
1218
1219         /* Turns this:
1220          *         /foo/bar/waldo
1221          * Into this:
1222          *         /foo/bar/waldo/.#<extra>3c2b6219aa75d7d0
1223          */
1224
1225         if (!p) {
1226                 r = tmp_dir(&p);
1227                 if (r < 0)
1228                         return r;
1229         }
1230
1231         if (!extra)
1232                 extra = "";
1233
1234         t = new(char, strlen(p) + 3 + strlen(extra) + 16 + 1);
1235         if (!t)
1236                 return -ENOMEM;
1237
1238         x = stpcpy(stpcpy(stpcpy(t, p), "/.#"), extra);
1239
1240         u = random_u64();
1241         for (i = 0; i < 16; i++) {
1242                 *(x++) = hexchar(u & 0xF);
1243                 u >>= 4;
1244         }
1245
1246         *x = 0;
1247
1248         *ret = path_kill_slashes(t);
1249         return 0;
1250 }
1251
1252 int write_timestamp_file_atomic(const char *fn, usec_t n) {
1253         char ln[DECIMAL_STR_MAX(n)+2];
1254
1255         /* Creates a "timestamp" file, that contains nothing but a
1256          * usec_t timestamp, formatted in ASCII. */
1257
1258         if (n <= 0 || n >= USEC_INFINITY)
1259                 return -ERANGE;
1260
1261         xsprintf(ln, USEC_FMT "\n", n);
1262
1263         return write_string_file(fn, ln, WRITE_STRING_FILE_CREATE|WRITE_STRING_FILE_ATOMIC);
1264 }
1265
1266 int read_timestamp_file(const char *fn, usec_t *ret) {
1267         _cleanup_free_ char *ln = NULL;
1268         uint64_t t;
1269         int r;
1270
1271         r = read_one_line_file(fn, &ln);
1272         if (r < 0)
1273                 return r;
1274
1275         r = safe_atou64(ln, &t);
1276         if (r < 0)
1277                 return r;
1278
1279         if (t <= 0 || t >= (uint64_t) USEC_INFINITY)
1280                 return -ERANGE;
1281
1282         *ret = (usec_t) t;
1283         return 0;
1284 }
1285
1286 int fputs_with_space(FILE *f, const char *s, const char *separator, bool *space) {
1287         int r;
1288
1289         assert(s);
1290
1291         /* Outputs the specified string with fputs(), but optionally prefixes it with a separator. The *space parameter
1292          * when specified shall initially point to a boolean variable initialized to false. It is set to true after the
1293          * first invocation. This call is supposed to be use in loops, where a separator shall be inserted between each
1294          * element, but not before the first one. */
1295
1296         if (!f)
1297                 f = stdout;
1298
1299         if (space) {
1300                 if (!separator)
1301                         separator = " ";
1302
1303                 if (*space) {
1304                         r = fputs(separator, f);
1305                         if (r < 0)
1306                                 return r;
1307                 }
1308
1309                 *space = true;
1310         }
1311
1312         return fputs(s, f);
1313 }
1314
1315 int open_tmpfile_unlinkable(const char *directory, int flags) {
1316         char *p;
1317         int fd, r;
1318
1319         if (!directory) {
1320                 r = tmp_dir(&directory);
1321                 if (r < 0)
1322                         return r;
1323         }
1324
1325         /* Returns an unlinked temporary file that cannot be linked into the file system anymore */
1326
1327         /* Try O_TMPFILE first, if it is supported */
1328         fd = open(directory, flags|O_TMPFILE|O_EXCL, S_IRUSR|S_IWUSR);
1329         if (fd >= 0)
1330                 return fd;
1331
1332         /* Fall back to unguessable name + unlinking */
1333         p = strjoina(directory, "/systemd-tmp-XXXXXX");
1334
1335         fd = mkostemp_safe(p);
1336         if (fd < 0)
1337                 return fd;
1338
1339         (void) unlink(p);
1340
1341         return fd;
1342 }
1343
1344 int open_tmpfile_linkable(const char *target, int flags, char **ret_path) {
1345         _cleanup_free_ char *tmp = NULL;
1346         int r, fd;
1347
1348         assert(target);
1349         assert(ret_path);
1350
1351         /* Don't allow O_EXCL, as that has a special meaning for O_TMPFILE */
1352         assert((flags & O_EXCL) == 0);
1353
1354         /* Creates a temporary file, that shall be renamed to "target" later. If possible, this uses O_TMPFILE – in
1355          * which case "ret_path" will be returned as NULL. If not possible a the tempoary path name used is returned in
1356          * "ret_path". Use link_tmpfile() below to rename the result after writing the file in full. */
1357
1358         {
1359                 _cleanup_free_ char *dn = NULL;
1360
1361                 dn = dirname_malloc(target);
1362                 if (!dn)
1363                         return -ENOMEM;
1364
1365                 fd = open(dn, O_TMPFILE|flags, 0640);
1366                 if (fd >= 0) {
1367                         *ret_path = NULL;
1368                         return fd;
1369                 }
1370
1371                 log_debug_errno(errno, "Failed to use O_TMPFILE on %s: %m", dn);
1372         }
1373
1374         r = tempfn_random(target, NULL, &tmp);
1375         if (r < 0)
1376                 return r;
1377
1378         fd = open(tmp, O_CREAT|O_EXCL|O_NOFOLLOW|O_NOCTTY|flags, 0640);
1379         if (fd < 0)
1380                 return -errno;
1381
1382         *ret_path = tmp;
1383         tmp = NULL;
1384
1385         return fd;
1386 }
1387
1388 int open_serialization_fd(const char *ident) {
1389         int fd = -1;
1390
1391         fd = memfd_create(ident, MFD_CLOEXEC);
1392         if (fd < 0) {
1393                 const char *path;
1394
1395                 path = getpid() == 1 ? "/run/systemd" : "/tmp";
1396                 fd = open_tmpfile_unlinkable(path, O_RDWR|O_CLOEXEC);
1397                 if (fd < 0)
1398                         return fd;
1399
1400                 log_debug("Serializing %s to %s.", ident, path);
1401         } else
1402                 log_debug("Serializing %s to memfd.", ident);
1403
1404         return fd;
1405 }
1406
1407 int link_tmpfile(int fd, const char *path, const char *target) {
1408
1409         assert(fd >= 0);
1410         assert(target);
1411
1412         /* Moves a temporary file created with open_tmpfile() above into its final place. if "path" is NULL an fd
1413          * created with O_TMPFILE is assumed, and linkat() is used. Otherwise it is assumed O_TMPFILE is not supported
1414          * on the directory, and renameat2() is used instead.
1415          *
1416          * Note that in both cases we will not replace existing files. This is because linkat() does not support this
1417          * operation currently (renameat2() does), and there is no nice way to emulate this. */
1418
1419         if (path) {
1420                 if (rename_noreplace(AT_FDCWD, path, AT_FDCWD, target) < 0)
1421                         return -errno;
1422         } else {
1423                 char proc_fd_path[strlen("/proc/self/fd/") + DECIMAL_STR_MAX(fd) + 1];
1424
1425                 xsprintf(proc_fd_path, "/proc/self/fd/%i", fd);
1426
1427                 if (linkat(AT_FDCWD, proc_fd_path, AT_FDCWD, target, AT_SYMLINK_FOLLOW) < 0)
1428                         return -errno;
1429         }
1430
1431         return 0;
1432 }
1433 #endif // 0
1434
1435 int read_nul_string(FILE *f, char **ret) {
1436         _cleanup_free_ char *x = NULL;
1437         size_t allocated = 0, n = 0;
1438
1439         assert(f);
1440         assert(ret);
1441
1442         /* Reads a NUL-terminated string from the specified file. */
1443
1444         for (;;) {
1445                 int c;
1446
1447                 if (!GREEDY_REALLOC(x, allocated, n+2))
1448                         return -ENOMEM;
1449
1450                 c = fgetc(f);
1451                 if (c == 0) /* Terminate at NUL byte */
1452                         break;
1453                 if (c == EOF) {
1454                         if (ferror(f))
1455                                 return -errno;
1456                         break; /* Terminate at EOF */
1457                 }
1458
1459                 x[n++] = (char) c;
1460         }
1461
1462         if (x)
1463                 x[n] = 0;
1464         else {
1465                 x = new0(char, 1);
1466                 if (!x)
1467                         return -ENOMEM;
1468         }
1469
1470         *ret = x;
1471         x = NULL;
1472
1473         return 0;
1474 }
1475
1476 int mkdtemp_malloc(const char *template, char **ret) {
1477         char *p;
1478
1479         assert(template);
1480         assert(ret);
1481
1482         p = strdup(template);
1483         if (!p)
1484                 return -ENOMEM;
1485
1486         if (!mkdtemp(p)) {
1487                 free(p);
1488                 return -errno;
1489         }
1490
1491         *ret = p;
1492         return 0;
1493 }