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