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