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