src/basic/env-util.h

   1 /* SPDX-License-Identifier: LGPL-2.1-or-later */
   2 #pragma once
   3
   4 #include <stdbool.h>
   5 #include <stddef.h>
   6 #include <stdio.h>
   7 #include <unistd.h>
   8
   9 #include "macro.h"
  10 #include "string.h"
  11
  12 static inline size_t sc_arg_max(void) {
  13         long l = sysconf(_SC_ARG_MAX);
  14         assert(l > 0);
  15         return (size_t) l;
  16 }
  17
  18 bool env_name_is_valid(const char *e);
  19 bool env_value_is_valid(const char *e);
  20 bool env_assignment_is_valid(const char *e);
  21
  22 typedef enum ReplaceEnvFlags {
  23         REPLACE_ENV_USE_ENVIRONMENT = 1 << 0,
  24         REPLACE_ENV_ALLOW_BRACELESS = 1 << 1,
  25         REPLACE_ENV_ALLOW_EXTENDED  = 1 << 2,
  26 } ReplaceEnvFlags;
  27
  28 int replace_env_full(const char *format, size_t n, char **env, ReplaceEnvFlags flags, char **ret, char ***ret_unset_variables, char ***ret_bad_variables);
  29 static inline int replace_env(const char *format, char **env, ReplaceEnvFlags flags, char **ret) {
  30         return replace_env_full(format, SIZE_MAX, env, flags, ret, NULL, NULL);
  31 }
  32
  33 int replace_env_argv(char **argv, char **env, char ***ret, char ***ret_unset_variables, char ***ret_bad_variables);
  34
  35 bool strv_env_is_valid(char **e);
  36 #define strv_env_clean(l) strv_env_clean_with_callback(l, NULL, NULL)
  37 char **strv_env_clean_with_callback(char **l, void (*invalid_callback)(const char *p, void *userdata), void *userdata);
  38
  39 bool strv_env_name_is_valid(char **l);
  40 bool strv_env_name_or_assignment_is_valid(char **l);
  41
  42 char** _strv_env_merge(char **first, ...);
  43 #define strv_env_merge(first, ...) _strv_env_merge(first, __VA_ARGS__, POINTER_MAX)
  44 char **strv_env_delete(char **x, size_t n_lists, ...); /* New copy */
  45
  46 char** strv_env_unset(char **l, const char *p); /* In place ... */
  47 char** strv_env_unset_many_internal(char **l, ...) _sentinel_;
  48 #define strv_env_unset_many(l, ...) strv_env_unset_many_internal(l, __VA_ARGS__, NULL)
  49 int strv_env_replace_consume(char ***l, char *p); /* In place ... */
  50 int strv_env_replace_strdup(char ***l, const char *assignment);
  51 int strv_env_replace_strdup_passthrough(char ***l, const char *assignment);
  52 int strv_env_assign(char ***l, const char *key, const char *value);
  53 int strv_env_assignf(char ***l, const char *key, const char *valuef, ...) _printf_(3, 4);
  54 int _strv_env_assign_many(char ***l, ...) _sentinel_;
  55 #define strv_env_assign_many(l, ...) _strv_env_assign_many(l, __VA_ARGS__, NULL)
  56
  57 char* strv_env_get_n(char * const *l, const char *name, size_t k, ReplaceEnvFlags flags);
  58 static inline char* strv_env_get(char * const *x, const char *n) {
  59         return strv_env_get_n(x, n, SIZE_MAX, 0);
  60 }
  61
  62 char *strv_env_pairs_get(char **l, const char *name) _pure_;
  63
  64 int getenv_bool(const char *p);
  65 int getenv_bool_secure(const char *p);
  66
  67 int getenv_uint64_secure(const char *p, uint64_t *ret);
  68
  69 /* Like setenv, but calls unsetenv if value == NULL. */
  70 int set_unset_env(const char *name, const char *value, bool overwrite);
  71
  72 /* Like putenv, but duplicates the memory like setenv. */
  73 int putenv_dup(const char *assignment, bool override);
  74
  75 int setenv_systemd_exec_pid(bool update_only);
  76 int setenv_systemd_log_level(void);
  77
  78 /* Parses and does sanity checks on an environment variable containing
  79  * PATH-like colon-separated absolute paths */
  80 int getenv_path_list(const char *name, char ***ret_paths);
  81
  82 int getenv_steal_erase(const char *name, char **ret);
  83
  84 int set_full_environment(char **env);
  85
  86 int setenvf(const char *name, bool overwrite, const char *valuef, ...) _printf_(3,4);