libreport  2.8.0.65.g54fb
A tool to inform users about various problems on the running system
internal_libreport.h
1 /*
2  Copyright (C) 2010 ABRT team
3  Copyright (C) 2010 RedHat Inc
4 
5  This program is free software; you can redistribute it and/or modify
6  it under the terms of the GNU General Public License as published by
7  the Free Software Foundation; either version 2 of the License, or
8  (at your option) any later version.
9 
10  This program is distributed in the hope that it will be useful,
11  but WITHOUT ANY WARRANTY; without even the implied warranty of
12  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13  GNU General Public License for more details.
14 
15  You should have received a copy of the GNU General Public License along
16  with this program; if not, write to the Free Software Foundation, Inc.,
17  51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
18 */
19 
20 #ifndef LIBREPORT_INTERNAL_H_
21 #define LIBREPORT_INTERNAL_H_
22 
23 #include <assert.h>
24 #include <ctype.h>
25 #include <dirent.h>
26 #include <errno.h>
27 #include <fcntl.h>
28 #include <inttypes.h>
29 #include <setjmp.h>
30 #include <signal.h>
31 #include <stdio.h>
32 #include <stdlib.h>
33 #include <stdarg.h>
34 #include <stddef.h>
35 #include <string.h>
36 #include <syslog.h>
37 #include <sys/poll.h>
38 #include <sys/mman.h>
39 #include <sys/socket.h>
40 #include <sys/stat.h>
41 #include <sys/time.h>
42 #include <sys/types.h>
43 #include <sys/wait.h>
44 #include <arpa/inet.h> /* sockaddr_in, sockaddr_in6 etc */
45 #include <termios.h>
46 #include <time.h>
47 #include <unistd.h>
48 /* Try to pull in PATH_MAX */
49 #include <limits.h>
50 #include <sys/param.h>
51 #ifndef PATH_MAX
52 # define PATH_MAX 256
53 #endif
54 #include <pwd.h>
55 #include <grp.h>
56 
57 #ifdef HAVE_CONFIG_H
58 # include "config.h"
59 #endif
60 
61 /* Must be after #include "config.h" */
62 #if ENABLE_NLS
63 # include <libintl.h>
64 # define _(S) dgettext(PACKAGE, S)
65 #else
66 # define _(S) (S)
67 #endif
68 
69 #if HAVE_LOCALE_H
70 # include <locale.h>
71 #endif /* HAVE_LOCALE_H */
72 
73 /* Some libc's forget to declare these, do it ourself */
74 extern char **environ;
75 #if defined(__GLIBC__) && __GLIBC__ < 2
76 int vdprintf(int d, const char *format, va_list ap);
77 #endif
78 
79 #undef NORETURN
80 #define NORETURN __attribute__ ((noreturn))
81 
82 #undef ERR_PTR
83 #define ERR_PTR ((void*)(uintptr_t)1)
84 
85 #undef ARRAY_SIZE
86 #define ARRAY_SIZE(x) ((unsigned)(sizeof(x) / sizeof((x)[0])))
87 
88 /* consts used across whole libreport */
89 #define CREATE_PRIVATE_TICKET "ABRT_CREATE_PRIVATE_TICKET"
90 
91 /* Pull in entire public libreport API */
92 #include "global_configuration.h"
93 #include "dump_dir.h"
94 #include "event_config.h"
95 #include "problem_data.h"
96 #include "report.h"
97 #include "run_event.h"
98 #include "workflow.h"
99 #include "file_obj.h"
100 #include "libreport_types.h"
101 #include "reporters.h"
102 
103 #ifdef __cplusplus
104 extern "C" {
105 #endif
106 
107 #define prefixcmp libreport_prefixcmp
108 int prefixcmp(const char *str, const char *prefix);
109 #define suffixcmp libreport_suffixcmp
110 int suffixcmp(const char *str, const char *suffix);
111 #define trim_all_whitespace libreport_trim_all_whitespace
112 char *trim_all_whitespace(const char *str);
113 #define shorten_string_to_length libreport_shorten_string_to_length
114 char *shorten_string_to_length(const char *str, unsigned length);
115 #define strtrim libreport_strtrim
116 char *strtrim(char *str);
117 #define strtrimch libreport_strtrimch
118 char *strtrimch(char *str, int ch);
119 #define strremovech libreport_strremovech
120 char *strremovech(char *str, int ch);
121 #define append_to_malloced_string libreport_append_to_malloced_string
122 char *append_to_malloced_string(char *mstr, const char *append);
123 #define skip_blank libreport_skip_blank
124 char* skip_blank(const char *s);
125 #define skip_whitespace libreport_skip_whitespace
126 char* skip_whitespace(const char *s);
127 #define skip_non_whitespace libreport_skip_non_whitespace
128 char* skip_non_whitespace(const char *s);
129 /* Like strcpy but can copy overlapping strings. */
130 #define overlapping_strcpy libreport_overlapping_strcpy
131 void overlapping_strcpy(char *dst, const char *src);
132 
133 #define concat_path_file libreport_concat_path_file
134 char *concat_path_file(const char *path, const char *filename);
135 /*
136  * Used to construct a name in a different directory with the basename
137  * similar to the old name, if possible.
138  */
139 #define concat_path_basename libreport_concat_path_basename
140 char *concat_path_basename(const char *path, const char *filename);
141 
142 /* Allows all printable characters except '/',
143  * the string must not exceed 64 characters of length
144  * and must not equal neither "." nor ".." (these strings may appear in the string) */
145 #define str_is_correct_filename libreport_str_is_correct_filename
146 bool str_is_correct_filename(const char *str);
147 
148 /* A-la fgets, but malloced and of unlimited size */
149 #define xmalloc_fgets libreport_xmalloc_fgets
150 char *xmalloc_fgets(FILE *file);
151 /* Similar, but removes trailing \n */
152 #define xmalloc_fgetline libreport_xmalloc_fgetline
153 char *xmalloc_fgetline(FILE *file);
154 /* Useful for easy reading of various /proc files */
155 #define xmalloc_fopen_fgetline_fclose libreport_xmalloc_fopen_fgetline_fclose
156 char *xmalloc_fopen_fgetline_fclose(const char *filename);
157 
158 
159 typedef enum {
160  COPYFD_SPARSE = 1 << 0,
161 } libreport_copyfd_flags;
162 
163 /* Writes up to 'size' Bytes from a file descriptor to a file in a directory
164  *
165  * If you need to write all Bytes of the file descriptor, pass 0 as the size.
166  *
167  * @param src The source file descriptor
168  * @param dir_fd A file descriptor for the parent directory of the destination file
169  * @param name The destination file name
170  * @param mode The destination file open mode
171  * @param uid The destination file's uid
172  * @param gid The destination file's gid
173  * @param open_flags The destination file open flags
174  * @param copy_flags libreport_copyfd_flags
175  * @param size The upper limit for written bytes (0 for no limit).
176  * @return Number of read Bytes on success. On errors, return -1 and prints out
177  * reasonable good error messages.
178  */
179 #define copyfd_ext_at libreport_copyfd_ext_at
180 off_t copyfd_ext_at(int src, int dir_fd, const char *name, int mode,
181  uid_t uid, gid_t gid, int open_flags, int copy_flags, off_t size);
182 
183 /* On error, copyfd_XX prints error messages and returns -1 */
184 #define copyfd_eof libreport_copyfd_eof
185 off_t copyfd_eof(int src_fd, int dst_fd, int flags);
186 #define copyfd_size libreport_copyfd_size
187 off_t copyfd_size(int src_fd, int dst_fd, off_t size, int flags);
188 #define copyfd_exact_size libreport_copyfd_exact_size
189 void copyfd_exact_size(int src_fd, int dst_fd, off_t size);
190 #define copy_file_ext_2at libreport_copy_file_ext_2at
191 off_t copy_file_ext_2at(int src_dir_fd, const char *src_name, int dir_fd, const char *name, int mode, uid_t uid, gid_t gid, int src_flags, int dst_flags);
192 #define copy_file_ext_at libreport_copy_file_ext_at
193 off_t copy_file_ext_at(const char *src_name, int dir_fd, const char *name, int mode, uid_t uid, gid_t gid, int src_flags, int dst_flags);
194 #define copy_file_ext(src_name, dst_name, mode, uid, gid, src_flags, dst_flags) \
195  copy_file_ext_at(src_name, AT_FDCWD, dst_name, mode, uid, gid, src_flags, dst_flags)
196 #define copy_file libreport_copy_file
197 off_t copy_file(const char *src_name, const char *dst_name, int mode);
198 #define copy_file_at libreport_copy_file_at
199 off_t copy_file_at(const char *src_name, int dir_fd, const char *name, int mode);
200 #define copy_file_recursive libreport_copy_file_recursive
201 int copy_file_recursive(const char *source, const char *dest);
202 
203 #define decompress_fd libreport_decompress_fd
204 int decompress_fd(int fdi, int fdo);
205 #define decompress_file libreport_decompress_file
206 int decompress_file(const char *path_in, const char *path_out, mode_t mode_out);
207 #define decompress_file_ext_at libreport_decompress_file_ext_at
208 int decompress_file_ext_at(const char *path_in, int dir_fd, const char *path_out,
209  mode_t mode_out, uid_t uid, gid_t gid, int src_flags, int dst_flags);
210 
211 // NB: will return short read on error, not -1,
212 // if some data was read before error occurred
213 #define xread libreport_xread
214 void xread(int fd, void *buf, size_t count);
215 #define safe_read libreport_safe_read
216 ssize_t safe_read(int fd, void *buf, size_t count);
217 #define safe_write libreport_safe_write
218 ssize_t safe_write(int fd, const void *buf, size_t count);
219 #define full_read libreport_full_read
220 ssize_t full_read(int fd, void *buf, size_t count);
221 #define full_write libreport_full_write
222 ssize_t full_write(int fd, const void *buf, size_t count);
223 #define full_write_str libreport_full_write_str
224 ssize_t full_write_str(int fd, const char *buf);
225 #define xmalloc_read libreport_xmalloc_read
226 void* xmalloc_read(int fd, size_t *maxsz_p);
227 #define xmalloc_open_read_close libreport_xmalloc_open_read_close
228 void* xmalloc_open_read_close(const char *filename, size_t *maxsz_p);
229 #define xmalloc_xopen_read_close libreport_xmalloc_xopen_read_close
230 void* xmalloc_xopen_read_close(const char *filename, size_t *maxsz_p);
231 #define malloc_readlink libreport_malloc_readlink
232 char* malloc_readlink(const char *linkname);
233 #define malloc_readlinkat libreport_malloc_readlinkat
234 char* malloc_readlinkat(int dir_fd, const char *linkname);
235 
236 
237 /* Returns malloc'ed block */
238 #define encode_base64 libreport_encode_base64
239 char *encode_base64(const void *src, int length);
240 
241 /* Returns NULL if the string needs no sanitizing.
242  * control_chars_to_sanitize is a bit mask.
243  * If Nth bit is set, Nth control char will be sanitized (replaced by [XX]).
244  */
245 #define sanitize_utf8 libreport_sanitize_utf8
246 char *sanitize_utf8(const char *src, uint32_t control_chars_to_sanitize);
247 enum {
248  SANITIZE_ALL = 0xffffffff,
249  SANITIZE_TAB = (1 << 9),
250  SANITIZE_LF = (1 << 10),
251  SANITIZE_CR = (1 << 13),
252 };
253 
254 #define SHA1_RESULT_LEN (5 * 4)
255 typedef struct sha1_ctx_t {
256  uint8_t wbuffer[64]; /* always correctly aligned for uint64_t */
257  /* for sha256: void (*process_block)(struct md5_ctx_t*); */
258  uint64_t total64; /* must be directly before hash[] */
259  uint32_t hash[8]; /* 4 elements for md5, 5 for sha1, 8 for sha256 */
260 } sha1_ctx_t;
261 #define sha1_begin libreport_sha1_begin
262 void sha1_begin(sha1_ctx_t *ctx);
263 #define sha1_hash libreport_sha1_hash
264 void sha1_hash(sha1_ctx_t *ctx, const void *buffer, size_t len);
265 #define sha1_end libreport_sha1_end
266 void sha1_end(sha1_ctx_t *ctx, void *resbuf);
267 
268 /* Helpers to hash a string: */
269 #define str_to_sha1 libreport_str_to_sha1
270 const uint8_t *str_to_sha1(uint8_t result[SHA1_RESULT_LEN], const char *str);
271 #define str_to_sha1str libreport_str_to_sha1str
272 const char *str_to_sha1str(char result[SHA1_RESULT_LEN*2 + 1], const char *str);
273 
274 
275 #define try_atou libreport_try_atou
276 int try_atou(const char *numstr, unsigned *value);
277 #define xatou libreport_xatou
278 unsigned xatou(const char *numstr);
279 #define try_atoi libreport_try_atoi
280 int try_atoi(const char *numstr, int *value);
281 #define xatoi libreport_xatoi
282 int xatoi(const char *numstr);
283 /* Using xatoi() instead of naive atoi() is not always convenient -
284  * in many places people want *non-negative* values, but store them
285  * in signed int. Therefore we need this one:
286  * dies if input is not in [0, INT_MAX] range. Also will reject '-0' etc.
287  * It should really be named xatoi_nonnegative (since it allows 0),
288  * but that would be too long.
289  */
290 #define try_atoi_positive libreport_try_atoi_positive
291 int try_atoi_positive(const char *numstr, int *value);
292 #define xatoi_positive libreport_xatoi_positive
293 int xatoi_positive(const char *numstr);
294 
295 //unused for now
296 //unsigned long long monotonic_ns(void);
297 //unsigned long long monotonic_us(void);
298 //unsigned monotonic_sec(void);
299 
300 #define safe_waitpid libreport_safe_waitpid
301 pid_t safe_waitpid(pid_t pid, int *wstat, int options);
302 
303 enum {
304  /* on return, pipefds[1] is fd to which parent may write
305  * and deliver data to child's stdin: */
306  EXECFLG_INPUT = 1 << 0,
307  /* on return, pipefds[0] is fd from which parent may read
308  * child's stdout: */
309  EXECFLG_OUTPUT = 1 << 1,
310  /* open child's stdin to /dev/null: */
311  EXECFLG_INPUT_NUL = 1 << 2,
312  /* open child's stdout to /dev/null: */
313  EXECFLG_OUTPUT_NUL = 1 << 3,
314  /* redirect child's stderr to stdout: */
315  EXECFLG_ERR2OUT = 1 << 4,
316  /* open child's stderr to /dev/null: */
317  EXECFLG_ERR_NUL = 1 << 5,
318  /* suppress perror_msg("Can't execute 'foo'") if exec fails */
319  EXECFLG_QUIET = 1 << 6,
320  EXECFLG_SETGUID = 1 << 7,
321  EXECFLG_SETSID = 1 << 8,
322  EXECFLG_SETPGID = 1 << 9,
323 };
324 /*
325  * env_vec: list of variables to set in environment (if string has
326  * "VAR=VAL" form) or unset in environment (if string has no '=' char).
327  *
328  * Returns pid.
329  */
330 #define fork_execv_on_steroids libreport_fork_execv_on_steroids
331 pid_t fork_execv_on_steroids(int flags,
332  char **argv,
333  int *pipefds,
334  char **env_vec,
335  const char *dir,
336  uid_t uid);
337 /* Returns malloc'ed string. NULs are retained, and extra one is appended
338  * after the last byte (this NUL is not accounted for in *size_p) */
339 #define run_in_shell_and_save_output libreport_run_in_shell_and_save_output
340 char *run_in_shell_and_save_output(int flags,
341  const char *cmd,
342  const char *dir,
343  size_t *size_p);
344 
345 /* Random utility functions */
346 
347 #define is_in_string_list libreport_is_in_string_list
348 bool is_in_string_list(const char *name, const char *const *v);
349 
350 #define index_of_string_in_list libreport_index_of_string_in_list
351 int index_of_string_in_list(const char *name, const char *const *v);
352 
353 #define is_in_comma_separated_list libreport_is_in_comma_separated_list
354 bool is_in_comma_separated_list(const char *value, const char *list);
355 #define is_in_comma_separated_list_of_glob_patterns libreport_is_in_comma_separated_list_of_glob_patterns
356 bool is_in_comma_separated_list_of_glob_patterns(const char *value, const char *list);
357 
358 /* Calls GLib version appropriate initialization function.
359  */
360 #define glib_init libreport_glib_init
361 void glib_init(void);
362 
363 /* Frees every element'd data using free(),
364  * then frees list itself using g_list_free(list):
365  */
366 #define list_free_with_free libreport_list_free_with_free
367 void list_free_with_free(GList *list);
368 
369 #define get_dirsize libreport_get_dirsize
370 double get_dirsize(const char *pPath);
371 #define get_dirsize_find_largest_dir libreport_get_dirsize_find_largest_dir
372 double get_dirsize_find_largest_dir(
373  const char *pPath,
374  char **worst_dir, /* can be NULL */
375  const char *excluded /* can be NULL */
376 );
377 
378 #define ndelay_on libreport_ndelay_on
379 int ndelay_on(int fd);
380 #define ndelay_off libreport_ndelay_off
381 int ndelay_off(int fd);
382 #define close_on_exec_on libreport_close_on_exec_on
383 int close_on_exec_on(int fd);
384 
385 #define xmalloc libreport_xmalloc
386 void* xmalloc(size_t size);
387 #define xrealloc libreport_xrealloc
388 void* xrealloc(void *ptr, size_t size);
389 #define xzalloc libreport_xzalloc
390 void* xzalloc(size_t size);
391 #define xstrdup libreport_xstrdup
392 char* xstrdup(const char *s);
393 #define xstrndup libreport_xstrndup
394 char* xstrndup(const char *s, int n);
395 #define xstrdup_between libreport_xstrdup_between
396 char* xstrdup_between(const char *s, const char *open, const char *close);
397 
398 #define xpipe libreport_xpipe
399 void xpipe(int filedes[2]);
400 #define xdup libreport_xdup
401 int xdup(int from);
402 #define xdup2 libreport_xdup2
403 void xdup2(int from, int to);
404 #define xmove_fd libreport_xmove_fd
405 void xmove_fd(int from, int to);
406 
407 #define xwrite libreport_xwrite
408 void xwrite(int fd, const void *buf, size_t count);
409 #define xwrite_str libreport_xwrite_str
410 void xwrite_str(int fd, const char *str);
411 
412 #define xlseek libreport_xlseek
413 off_t xlseek(int fd, off_t offset, int whence);
414 
415 #define xchdir libreport_xchdir
416 void xchdir(const char *path);
417 
418 #define xvasprintf libreport_xvasprintf
419 char* xvasprintf(const char *format, va_list p);
420 #define xasprintf libreport_xasprintf
421 char* xasprintf(const char *format, ...);
422 
423 #define xsetenv libreport_xsetenv
424 void xsetenv(const char *key, const char *value);
425 /*
426  * Utility function to unsetenv a string which was possibly putenv'ed.
427  * The problem here is that "natural" optimization:
428  * strchrnul(var_val, '=')[0] = '\0';
429  * unsetenv(var_val);
430  * is BUGGY: if string was put into environment via putenv,
431  * its modification (s/=/NUL/) is illegal, and unsetenv will fail to unset it.
432  * Of course, saving/restoring the char wouldn't work either.
433  * This helper creates a copy up to '=', unsetenv's it, and frees:
434  */
435 #define safe_unsetenv libreport_safe_unsetenv
436 void safe_unsetenv(const char *var_val);
437 
438 #define xsocket libreport_xsocket
439 int xsocket(int domain, int type, int protocol);
440 #define xbind libreport_xbind
441 void xbind(int sockfd, struct sockaddr *my_addr, socklen_t addrlen);
442 #define xlisten libreport_xlisten
443 void xlisten(int s, int backlog);
444 #define xsendto libreport_xsendto
445 ssize_t xsendto(int s, const void *buf, size_t len,
446  const struct sockaddr *to, socklen_t tolen);
447 
448 #define xstat libreport_xstat
449 void xstat(const char *name, struct stat *stat_buf);
450 #define fstat_st_size_or_die libreport_fstat_st_size_or_die
451 off_t fstat_st_size_or_die(int fd);
452 #define stat_st_size_or_die libreport_stat_st_size_or_die
453 off_t stat_st_size_or_die(const char *filename);
454 
455 #define xopen3 libreport_xopen3
456 int xopen3(const char *pathname, int flags, int mode);
457 #define xopen libreport_xopen
458 int xopen(const char *pathname, int flags);
459 #define xunlink libreport_xunlink
460 void xunlink(const char *pathname);
461 #define xunlinkat libreport_xunlinkat
462 void xunlinkat(int dir_fd, const char *pathname, int flags);
463 
464 /* Just testing dent->d_type == DT_REG is wrong: some filesystems
465  * do not report the type, they report DT_UNKNOWN for every dirent
466  * (and this is not a bug in filesystem, this is allowed by standards).
467  * This function handles this case. Note: it returns 0 on symlinks
468  * even if they point to regular files.
469  */
470 #define is_regular_file libreport_is_regular_file
471 int is_regular_file(struct dirent *dent, const char *dirname);
472 #define is_regular_file_at libreport_is_regular_file_at
473 int is_regular_file_at(struct dirent *dent, int dir_fd);
474 
475 #define dot_or_dotdot libreport_dot_or_dotdot
476 bool dot_or_dotdot(const char *filename);
477 #define last_char_is libreport_last_char_is
478 char *last_char_is(const char *s, int c);
479 
480 #define string_to_bool libreport_string_to_bool
481 bool string_to_bool(const char *s);
482 
483 #define xseteuid libreport_xseteuid
484 void xseteuid(uid_t euid);
485 #define xsetegid libreport_xsetegid
486 void xsetegid(gid_t egid);
487 #define xsetreuid libreport_xsetreuid
488 void xsetreuid(uid_t ruid, uid_t euid);
489 #define xsetregid libreport_xsetregid
490 void xsetregid(gid_t rgid, gid_t egid);
491 
492 #define xfdopen libreport_xfdopen
493 FILE *xfdopen(int fd, const char *mode);
494 
495 /* Emit a string of hex representation of bytes */
496 #define bin2hex libreport_bin2hex
497 char* bin2hex(char *dst, const char *str, int count);
498 /* Convert "xxxxxxxx" hex string to binary, no more than COUNT bytes */
499 #define hex2bin libreport_hex2bin
500 char* hex2bin(char *dst, const char *str, int count);
501 
502 
503 enum {
504  LOGMODE_NONE = 0,
505  LOGMODE_STDIO = (1 << 0),
506  LOGMODE_SYSLOG = (1 << 1),
507  LOGMODE_BOTH = LOGMODE_SYSLOG + LOGMODE_STDIO,
508  LOGMODE_CUSTOM = (1 << 2),
509  LOGMODE_JOURNAL = (1 << 3),
510 };
511 
512 enum libreport_diemode {
513  DIEMODE_EXIT = 0,
514  DIEMODE_ABORT = 1,
515 };
516 
517 #define g_custom_logger libreport_g_custom_logger
518 extern void (*g_custom_logger)(const char*);
519 #define msg_prefix libreport_msg_prefix
520 extern const char *msg_prefix;
521 #define msg_eol libreport_msg_eol
522 extern const char *msg_eol;
523 #define logmode libreport_logmode
524 extern int logmode;
525 #define xfunc_error_retval libreport_xfunc_error_retval
526 extern int xfunc_error_retval;
527 
528 /* A few magic exit codes */
529 #define EXIT_CANCEL_BY_USER 69
530 #define EXIT_STOP_EVENT_RUN 70
531 
532 #define set_xfunc_error_retval libreport_set_xfunc_error_retval
533 void set_xfunc_error_retval(int retval);
534 
535 #define set_xfunc_diemode libreport_set_xfunc_diemode
536 void set_xfunc_diemode(enum libreport_diemode mode);
537 
538 /* Verbosity level */
539 #define g_verbose libreport_g_verbose
540 extern int g_verbose;
541 /* VERB1 log("what you sometimes want to see, even on a production box") */
542 #define VERB1 if (g_verbose >= 1)
543 /* VERB2 log("debug message, not going into insanely small details") */
544 #define VERB2 if (g_verbose >= 2)
545 /* VERB3 log("lots and lots of details") */
546 #define VERB3 if (g_verbose >= 3)
547 /* there is no level > 3 */
548 
549 #define libreport_
550 #define xfunc_die libreport_xfunc_die
551 void xfunc_die(void) NORETURN;
552 
553 #define die_out_of_memory libreport_die_out_of_memory
554 void die_out_of_memory(void) NORETURN;
555 
556 /* It's a macro, not function, since it collides with log() from math.h */
557 #undef log
558 #define log(...) log_standard(LOG_WARNING, __FILE__, __LINE__, __func__, __VA_ARGS__)
559 #define log_debug(...) log_standard(LOG_DEBUG, __FILE__, __LINE__, __func__, __VA_ARGS__)
560 #define log_info(...) log_standard(LOG_INFO, __FILE__, __LINE__, __func__, __VA_ARGS__)
561 #define log_notice(...) log_standard(LOG_NOTICE, __FILE__, __LINE__, __func__, __VA_ARGS__)
562 #define log_warning(...) log_standard(LOG_WARNING, __FILE__, __LINE__, __func__, __VA_ARGS__)
563 #define log_error(...) log_standard(LOG_ERR, __FILE__, __LINE__, __func__, __VA_ARGS__)
564 
565 // specific subsystem debugging
566 #define log_parser(...) if(0) log_debug(__VA_ARGS__)
567 
568 #define log_standard(level, file, line, func, ...) log_wrapper(level, __FILE__, __LINE__, __func__, false, false, __VA_ARGS__)
569 
570 // level, file, line, func, perror, custom logger, format & args
571 #define log_error_and_die(...) log_wrapper(LOG_ERR, __FILE__, __LINE__, __func__, false, false,__VA_ARGS__)
572 #define log_perror(...) log_wrapper(LOG_ERR, __FILE__, __LINE__, __func__, true, false, __VA_ARGS__)
573 #define log_perror_and_die(...) log_wrapper(LOG_ERR, __FILE__, __LINE__, __func__, true, false, __VA_ARGS__)
574 
575 #define error_msg(...) log_wrapper(LOG_ERR, __FILE__, __LINE__, __func__, false, true, __VA_ARGS__)
576 #define perror_msg(...) log_wrapper(LOG_ERR, __FILE__, __LINE__, __func__, true, true, __VA_ARGS__)
577 #define warn_msg(...) log_wrapper(LOG_WARNING, __FILE__, __LINE__, __func__, false, true, __VA_ARGS__)
578 #define pwarn_msg(...) log_wrapper(LOG_WARNING, __FILE__, __LINE__, __func__, true, true, __VA_ARGS__)
579 #define error_msg_and_die(...) log_and_die_wrapper(LOG_ERR, __FILE__, __LINE__, __func__, false, true, __VA_ARGS__)
580 #define perror_msg_and_die(...) log_and_die_wrapper(LOG_ERR, __FILE__, __LINE__, __func__, true, true, __VA_ARGS__)
581 
582 
583 void log_wrapper(int level,
584  const char *file,
585  int line,
586  const char *func,
587  bool process_perror,
588  bool use_custom_logger,
589  const char *format, ...) __attribute__ ((format (printf, 7,8)));
590 
591 void log_and_die_wrapper(int level,
592  const char *file,
593  int line,
594  const char *func,
595  bool process_perror,
596  bool use_custom_logger,
597  const char *format, ...) __attribute__ ((noreturn, format (printf, 7,8)));
598 
599 struct strbuf
600 {
601  /* Size of the allocated buffer. Always > 0. */
602  int alloc;
603  /* Length of the string, without the ending \0. */
604  int len;
605  char *buf;
606 };
607 
614 #define strbuf_new libreport_strbuf_new
615 struct strbuf *strbuf_new(void);
616 
622 #define strbuf_free libreport_strbuf_free
623 void strbuf_free(struct strbuf *strbuf);
624 
630 #define strbuf_free_nobuf libreport_strbuf_free_nobuf
631 char* strbuf_free_nobuf(struct strbuf *strbuf);
632 
637 #define strbuf_clear libreport_strbuf_clear
638 void strbuf_clear(struct strbuf *strbuf);
639 
644 #define strbuf_append_char libreport_strbuf_append_char
645 struct strbuf *strbuf_append_char(struct strbuf *strbuf, char c);
646 
651 #define strbuf_append_str libreport_strbuf_append_str
652 struct strbuf *strbuf_append_str(struct strbuf *strbuf,
653  const char *str);
654 
659 #define strbuf_prepend_str libreport_strbuf_prepend_str
660 struct strbuf *strbuf_prepend_str(struct strbuf *strbuf,
661  const char *str);
662 
667 #define strbuf_append_strf libreport_strbuf_append_strf
668 struct strbuf *strbuf_append_strf(struct strbuf *strbuf,
669  const char *format, ...);
670 
675 #define strbuf_append_strfv libreport_strbuf_append_strfv
676 struct strbuf *strbuf_append_strfv(struct strbuf *strbuf,
677  const char *format, va_list p);
678 
684 #define strbuf_prepend_strf libreport_strbuf_prepend_strf
685 struct strbuf *strbuf_prepend_strf(struct strbuf *strbuf,
686  const char *format, ...);
687 
692 #define strbuf_prepend_strfv libreport_strbuf_prepend_strfv
693 struct strbuf *strbuf_prepend_strfv(struct strbuf *strbuf,
694  const char *format, va_list p);
695 
696 /* Returns command line of running program.
697  * Caller is responsible to free() the returned value.
698  * If the pid is not valid or command line can not be obtained,
699  * empty string is returned.
700  */
701 #define open_proc_pid_dir libreport_open_proc_pid_dir
702 int open_proc_pid_dir(pid_t pid);
703 #define get_cmdline_at libreport_get_cmdline_at
704 char* get_cmdline_at(pid_t pid);
705 #define get_cmdline libreport_get_cmdline
706 char* get_cmdline(pid_t pid);
707 #define get_environ_at libreport_get_environ_at
708 char* get_environ_at(pid_t pid);
709 #define get_environ libreport_get_environ
710 char* get_environ(pid_t pid);
711 #define get_executable_at libreport_get_executable_at
712 char *get_executable_at(pid_t pid);
713 #define get_executable libreport_get_executable
714 char *get_executable(pid_t pid);
715 #define get_cwd_at libreport_get_cwd_at
716 char* get_cwd_at(pid_t pid);
717 #define get_cwd libreport_get_cwd
718 char* get_cwd(pid_t pid);
719 #define get_rootdir_at libreport_get_rootdir_at
720 char* get_rootdir_at(pid_t pid);
721 #define get_rootdir libreport_get_rootdir
722 char* get_rootdir(pid_t pid);
723 
724 #define get_fsuid libreport_get_fsuid
725 int get_fsuid(const char *proc_pid_status);
726 #define get_fsgid libreport_get_fsgid
727 int get_fsgid(const char *proc_pid_status);
728 #define dump_fd_info_at libreport_dump_fd_info_at
729 int dump_fd_info_at(int pid_proc_fd, FILE *dest);
730 #define dump_fd_info_ext libreport_dump_fd_info_ext
731 int dump_fd_info_ext(const char *dest_filename, const char *proc_pid_fd_path, uid_t uid, gid_t gid);
732 #define dump_fd_info libreport_dump_fd_info
733 int dump_fd_info(const char *dest_filename, const char *proc_pid_fd_path);
734 #define get_env_variable_ext libreport_get_env_variable_ext
735 int get_env_variable_ext(int fd, char delim, const char *name, char **value);
736 #define get_env_variable libreport_get_env_variable
737 int get_env_variable(pid_t pid, const char *name, char **value);
738 
739 #define PROC_NS_UNSUPPORTED ((ino_t)-1)
740 #define PROC_NS_ID_IPC 0
741 #define PROC_NS_ID_MNT 1
742 #define PROC_NS_ID_NET 2
743 #define PROC_NS_ID_PID 3
744 #define PROC_NS_ID_USER 4
745 #define PROC_NS_ID_UTS 5
746 #define PROC_NS_ID_CGROUP 6
747 static const char * libreport_proc_namespaces[] = { "ipc", "mnt", "net", "pid", "uts", "user", "cgroup" };
748 
749 struct ns_ids {
750  ino_t nsi_ids[ARRAY_SIZE(libreport_proc_namespaces)];
751 };
752 
753 #define get_ns_ids_at libreport_get_ns_ids_at
754 int get_ns_ids_at(int pid_proc_fd, struct ns_ids *ids);
755 #define get_ns_ids libreport_get_ns_ids
756 int get_ns_ids(pid_t pid, struct ns_ids *ids);
757 
758 /* These functions require a privileged user and does not work correctly in
759  * processes running in own PID namespace
760  */
761 #define process_has_own_root_at libreport_process_has_own_root_at
762 int process_has_own_root_at(int proc_pid_fd);
763 #define process_has_own_root libreport_process_has_own_root
764 int process_has_own_root(pid_t pid);
765 
766 #define get_pid_of_container_at libreport_get_pid_of_container_at
767 int get_pid_of_container_at(int pid_proc_fd, pid_t *init_pid);
768 #define get_pid_of_container libreport_get_pid_of_container
769 int get_pid_of_container(pid_t pid, pid_t *init_pid);
770 #define dump_namespace_diff_at libreport_dump_namespace_diff_at
771 int dump_namespace_diff_at(int base_pid_proc_fd, int tested_pid_proc_fd, FILE *dest);
772 #define dump_namespace_diff_ext libreport_dump_namespace_diff_ext
773 int dump_namespace_diff_ext(const char *dest_filename, pid_t base_pid, pid_t tested_pid, uid_t uid, gid_t gid);
774 #define dump_namespace_diff libreport_dump_namespace_diff
775 int dump_namespace_diff(const char *dest_filename, pid_t base_pid, pid_t tested_pid);
776 
777 #define MOUNTINFO_ROOT(val) (val.mntnf_items[3])
778 #define MOUNTINFO_MOUNT_POINT(val) (val.mntnf_items[4])
779 #define MOUNTINFO_MOUNT_SOURCE(val) (val.mntnf_items[8])
780 
781 struct mountinfo
782 {
783  /* 4 : root of the mount within the filesystem */
784  /* 5 : mount point relative to the process's root */
785  /* 10 : mount source: filesystem specific information or "none" */
786  /* but it mount source is preceded by 0 or more optional fields */
787  /* so the effective value is 9 */
788  char *mntnf_items[10];
789 };
790 #define mountinfo_destroy libreport_mountinfo_destroy
791 void mountinfo_destroy(struct mountinfo *mntnf);
792 #define get_mountinfo_for_mount_point libreport_get_mountinfo_for_mount_point
793 int get_mountinfo_for_mount_point(FILE *fin, struct mountinfo *mntnf, const char *mnt_point);
794 
795 /* Takes ptr to time_t, or NULL if you want to use current time.
796  * Returns "YYYY-MM-DD-hh:mm:ss" string.
797  */
798 #define iso_date_string libreport_iso_date_string
799 char *iso_date_string(const time_t *pt);
800 #define LIBREPORT_ISO_DATE_STRING_SAMPLE "YYYY-MM-DD-hh:mm:ss"
801 #define LIBREPORT_ISO_DATE_STRING_FORMAT "%Y-%m-%d-%H:%M:%S"
802 
803 /* Parses date into integer UNIX time stamp
804  *
805  * @param date The parsed date string
806  * @param pt Return value
807  * @return 0 on success; otherwise non-0 number. -EINVAL if the parameter date
808  * does not match LIBREPORT_ISO_DATE_STRING_FORMAT
809  */
810 #define iso_date_string_parse libreport_iso_date_string_parse
811 int iso_date_string_parse(const char *date, time_t *pt);
812 
813 enum {
814  MAKEDESC_SHOW_FILES = (1 << 0),
815  MAKEDESC_SHOW_MULTILINE = (1 << 1),
816  MAKEDESC_SHOW_ONLY_LIST = (1 << 2),
817  MAKEDESC_WHITELIST = (1 << 3),
818  /* Include all URLs from FILENAME_REPORTED_TO element in the description text */
819  MAKEDESC_SHOW_URLS = (1 << 4),
820 };
821 #define make_description libreport_make_description
822 char *make_description(problem_data_t *problem_data, char **names_to_skip, unsigned max_text_size, unsigned desc_flags);
823 #define make_description_logger libreport_make_description_logger
824 char* make_description_logger(problem_data_t *problem_data, unsigned max_text_size);
825 
826 /* See man os-release(5) for details */
827 #define OSINFO_ID "ID"
828 #define OSINFO_NAME "NAME"
829 #define OSINFO_VERSION_ID "VERSION_ID"
830 #define OSINFO_PRETTY_NAME "PRETTY_NAME"
831 
832 /* @brief Loads a text in format of os-release(5) in to a map
833  *
834  * Function doesn't check for format errors much. It just tries to avoid
835  * program errors. In case of error the function prints out a log message and
836  * continues in parsing.
837  *
838  * @param osinfo_bytes Non-NULL pointer to osinfo bytes.
839  * @param osinfo The map where result is stored
840  */
841 #define parse_osinfo libreport_parse_osinfo
842 void parse_osinfo(const char *osinfo_bytes, map_string_t *osinfo);
843 
844 /* @brief Builds product string and product's version string for Bugzilla
845  *
846  * At first tries to get strings from the os specific variables
847  * (REDHAT_BUGZILLA_PRODUCT, REDHAT_BUGZILLA_PRODUCT_VERSION) if no such
848  * variables are found, uses NAME key for the product and VERSION_ID key for
849  * the product's version. If neither NAME nor VERSION_ID are provided fallbacks
850  * to parsing of os_release which should be stored under PRETTY_NAME key.
851  *
852  * https://bugzilla.redhat.com/show_bug.cgi?id=950373
853  *
854  * @param osinfo Input data from which the values are built
855  * @param produc Non-NULL pointer where pointer to malloced string will be stored. Memory must be released by free()
856  * @param version Non-NULL pointer where pointer to malloced string will be stored. Memory must be released by free()
857  */
858 #define parse_osinfo_for_bz libreport_parse_osinfo_for_bz
859 void parse_osinfo_for_bz(map_string_t *osinfo, char **product, char **version);
860 
861 /* @brief Builds product string and product's version string for Red Hat Support
862  *
863  * At first tries to get strings from the os specific variables
864  * (REDHAT_SUPPORT_PRODUCT, REDHAT_SUPPORT_PRODUCT_VERSION) if no such
865  * variables are found, uses NAME key for the product and VERSION_ID key for
866  * the product's version. If no NAME nor VERSION_ID are provided fallbacks to
867  * parsing of os_release which should be stored under PRETTY_NAME key.
868  *
869  * https://bugzilla.redhat.com/show_bug.cgi?id=950373
870  *
871  * @param osinfo Input data from which the values are built
872  * @param produc Non-NULL pointer where pointer to malloced string will be stored. Memory must be released by free()
873  * @param version Non-NULL pointer where pointer to malloced string will be stored. Memory must be released by free()
874  */
875 #define parse_osinfo_for_rhts libreport_parse_osinfo_for_rhts
876 void parse_osinfo_for_rhts(map_string_t *osinfo, char **product, char **version);
877 
878 #define parse_release_for_bz libreport_parse_release_for_bz
879 void parse_release_for_bz(const char *pRelease, char **product, char **version);
880 #define parse_release_for_rhts libreport_parse_release_for_rhts
881 void parse_release_for_rhts(const char *pRelease, char **product, char **version);
882 
897 #define load_conf_file libreport_load_conf_file
898 bool load_conf_file(const char *pPath, map_string_t *settings, bool skipKeysWithoutValue);
899 #define load_plugin_conf_file libreport_load_plugin_conf_file
900 bool load_plugin_conf_file(const char *name, map_string_t *settings, bool skipKeysWithoutValue);
901 
902 #define get_user_conf_base_dir libreport_get_user_conf_base_dir
903 const char *get_user_conf_base_dir(void);
904 
905 #define load_conf_file_from_dirs libreport_load_conf_file_from_dirs
906 bool load_conf_file_from_dirs(const char *base_name, const char *const *directories, map_string_t *settings, bool skipKeysWithoutValue);
907 
908 enum {
909  CONF_DIR_FLAG_NONE = 0,
910  CONF_DIR_FLAG_OPTIONAL = 1,
911 };
912 
913 #define load_conf_file_from_dirs_ext libreport_load_conf_file_from_dirs_ext
914 bool load_conf_file_from_dirs_ext(const char *base_name, const char *const *directories,
915  const int * dir_flags, map_string_t *settings,
916  bool skipKeysWithoutValue);
917 
918 #define save_conf_file libreport_save_conf_file
919 bool save_conf_file(const char *path, map_string_t *settings);
920 #define save_plugin_conf_file libreport_save_plugin_conf_file
921 bool save_plugin_conf_file(const char *name, map_string_t *settings);
922 
923 #define save_app_conf_file libreport_save_app_conf_file
924 bool save_app_conf_file(const char* application_name, map_string_t *settings);
925 #define load_app_conf_file libreport_load_app_conf_file
926 bool load_app_conf_file(const char *application_name, map_string_t *settings);
927 #define set_app_user_setting libreport_set_app_user_setting
928 void set_app_user_setting(map_string_t *settings, const char *name, const char *value);
929 #define get_app_user_setting libreport_get_app_user_setting
930 const char *get_app_user_setting(map_string_t *settings, const char *name);
931 
932 #define save_user_settings libreport_save_user_settings
933 bool save_user_settings(void);
934 #define load_user_settings libreport_load_user_settings
935 bool load_user_settings(const char *application_name);
936 #define set_user_setting libreport_set_user_setting
937 void set_user_setting(const char *name, const char *value);
938 #define get_user_setting libreport_get_user_setting
939 const char *get_user_setting(const char *name);
940 
941 /* filename is expected to exist in CONF_DIR
942  * usually /etc/libreport
943  */
944 #define load_forbidden_words libreport_load_forbidden_words
945 GList *load_words_from_file(const char *filename);
946 #define get_file_list libreport_get_file_list
947 GList *get_file_list(const char *path, const char *ext);
948 #define free_file_list libreport_free_file_list
949 void free_file_list(GList *filelist);
950 #define new_file_obj libreport_new_file_obj
951 file_obj_t *new_file_obj(const char* fullpath, const char* filename);
952 #define free_file_obj libreport_free_file_obj
953 void free_file_obj(file_obj_t *f);
954 #define parse_delimited_list libreport_parse_delimited_list
955 GList *parse_delimited_list(char* list, const char *delim);
956 #define parse_list libreport_parse_list
957 GList *parse_list(const char* list);
958 
959 /* Connect to abrtd over unix domain socket, issue DELETE command */
960 int delete_dump_dir_possibly_using_abrtd(const char *dump_dir_name);
961 
962 /* Tries to create a copy of dump_dir_name in base_dir, with same or similar basename.
963  * Returns NULL if copying failed. In this case, logs a message before returning. */
964 #define steal_directory libreport_steal_directory
965 struct dump_dir *steal_directory(const char *base_dir, const char *dump_dir_name);
966 
967 /* Resolves if the given user is in given group
968  *
969  * @param uid user ID
970  * @param gid group ID
971  * @returns TRUE in case the user is in the group otherwise returns FALSE
972  */
973 #define uid_in_group libreport_uid_in_group
974 bool uid_in_group(uid_t uid, gid_t gid);
975 
976 /* Tries to open dump_dir_name with writing access. If function needs to steal
977  * directory calls ask_continue(new base dir, dump dir) callback to ask user
978  * for permission. If ask_continue param is NULL the function thinks that an
979  * answer is positive and steals directory.
980  * Returns NULL if opening failed or if stealing was dismissed. In this case,
981  * logs a message before returning. */
982 #define open_directory_for_writing libreport_open_directory_for_writing
983 struct dump_dir *open_directory_for_writing(
984  const char *dump_dir_name,
985  bool (*ask_continue)(const char *, const char *));
986 
987 // Files bigger than this are never considered to be text.
988 //
989 // Started at 64k limit. But _some_ limit is necessary:
990 // fields declared "text" may end up in editing fields and such.
991 // We don't want to accidentally end up with 100meg text in a textbox!
992 // So, don't remove this. If you really need to, raise the limit.
993 //
994 // Bumped up to 200k: saw 124740 byte /proc/PID/smaps file
995 // Bumped up to 500k: saw 375252 byte anaconda traceback file
996 // Bumped up to 1M: bugzilla.redhat.com/show_bug.cgi?id=746727
997 // mentions 853646 byte anaconda-tb-* file.
998 // Bumped up to 8M: bugzilla.redhat.com/show_bug.cgi?id=887570
999 // (anaconda-tb file of 1.38 MBytes)
1000 //
1001 #define CD_MAX_TEXT_SIZE (8*1024*1024)
1002 
1003 // Text bigger than this usually is attached, not added inline
1004 // was 2k, 20kb is too much, let's try 4kb
1005 //
1006 // For bug databases
1007 #define CD_TEXT_ATT_SIZE_BZ (4*1024)
1008 // For dumping problem data into a text file, email, etc
1009 #define CD_TEXT_ATT_SIZE_LOGGER (CD_MAX_TEXT_SIZE)
1010 
1011 // Filenames in problem directory:
1012 // filled by a hook:
1013 #define FILENAME_TIME "time" /* mandatory */
1014 #define FILENAME_LAST_OCCURRENCE "last_occurrence" /* optional */
1015 #define FILENAME_REASON "reason" /* mandatory? */
1016 #define FILENAME_UID "uid" /* mandatory? */
1017 
1018 /*
1019  * "analyzer" is to be gradually changed to "type":
1020  * For now, we fetch and look at "analyzer" element,
1021  * but we always save both "analyzer" and "type" (with same contents).
1022  * By 2013, we switch to looking at "type". Then we will stop generating
1023  * "analyzer" element.
1024  * ----
1025  * Update 2015: based on the recent changes where we have introduced several
1026  * tools generating one problem type, we have decided to retain 'analyzer'
1027  * file, but it shall contain string identifier of a tool that created the
1028  * problem.
1029  */
1030 #define FILENAME_ANALYZER "analyzer"
1031 #define FILENAME_TYPE "type"
1032 #define FILENAME_EXECUTABLE "executable"
1033 #define FILENAME_PID "pid"
1034 #define FILENAME_TID "tid"
1035 #define FILENAME_GLOBAL_PID "global_pid"
1036 #define FILENAME_PWD "pwd"
1037 #define FILENAME_ROOTDIR "rootdir"
1038 #define FILENAME_BINARY "binary"
1039 #define FILENAME_CMDLINE "cmdline"
1040 #define FILENAME_COREDUMP "coredump"
1041 #define FILENAME_CGROUP "cgroup"
1042 #define FILENAME_BACKTRACE "backtrace"
1043 #define FILENAME_MAPS "maps"
1044 #define FILENAME_SMAPS "smaps"
1045 #define FILENAME_PROC_PID_STATUS "proc_pid_status"
1046 #define FILENAME_ENVIRON "environ"
1047 #define FILENAME_LIMITS "limits"
1048 #define FILENAME_OPEN_FDS "open_fds"
1049 #define FILENAME_MOUNTINFO "mountinfo"
1050 #define FILENAME_NAMESPACES "namespaces"
1051 
1052 /* Global problem identifier which is usually generated by some "analyze_*"
1053  * event because it may take a lot of time to obtain strong problem
1054  * identification */
1055 #define FILENAME_DUPHASH "duphash"
1056 
1057 // Name of the function where the application crashed.
1058 // Optional.
1059 #define FILENAME_CRASH_FUNCTION "crash_function"
1060 #define FILENAME_ARCHITECTURE "architecture"
1061 #define FILENAME_KERNEL "kernel"
1062 /*
1063  * From /etc/os-release
1064  * os_release filename name is alredy occupied by /etc/redhat-release (see
1065  * below) in sake of backward compatibility /etc/os-release is stored in
1066  * os_info file
1067  */
1068 #define FILENAME_OS_INFO "os_info"
1069 #define FILENAME_OS_INFO_IN_ROOTDIR "os_info_in_rootdir"
1070 // From /etc/system-release or /etc/redhat-release
1071 #define FILENAME_OS_RELEASE "os_release"
1072 #define FILENAME_OS_RELEASE_IN_ROOTDIR "os_release_in_rootdir"
1073 // Filled by <what?>
1074 #define FILENAME_PACKAGE "package"
1075 #define FILENAME_COMPONENT "component"
1076 #define FILENAME_COMMENT "comment"
1077 #define FILENAME_RATING "backtrace_rating"
1078 #define FILENAME_HOSTNAME "hostname"
1079 // Optional. Set to "1" by abrt-handle-upload for every unpacked dump
1080 #define FILENAME_REMOTE "remote"
1081 #define FILENAME_TAINTED "kernel_tainted"
1082 #define FILENAME_TAINTED_SHORT "kernel_tainted_short"
1083 #define FILENAME_TAINTED_LONG "kernel_tainted_long"
1084 #define FILENAME_VMCORE "vmcore"
1085 #define FILENAME_KERNEL_LOG "kernel_log"
1086 // File created by createAlertSignature() from libreport's python module
1087 // The file should contain a description of an alert
1088 #define FILENAME_DESCRIPTION "description"
1089 
1090 /* Local problem identifier (weaker than global identifier) designed for fast
1091  * local for fast local duplicate identification. This file is usually provided
1092  * by crashed application (problem creator).
1093  */
1094 #define FILENAME_UUID "uuid"
1095 
1096 #define FILENAME_COUNT "count"
1097 /* Multi-line list of places problem was reported.
1098  * Recommended line format:
1099  * "Reporter: VAR=VAL VAR=VAL"
1100  * Use add_reported_to(dd, "line_without_newline"): it adds line
1101  * only if it is not already there.
1102  */
1103 #define FILENAME_REPORTED_TO "reported_to"
1104 #define FILENAME_EVENT_LOG "event_log"
1105 /*
1106  * If exists, should contain a full sentence (with trailing period)
1107  * which describes why this problem should not be reported.
1108  * Example: "Your laptop firmware 1.9a is buggy, version 1.10 contains the fix."
1109  */
1110 #define FILENAME_NOT_REPORTABLE "not-reportable"
1111 #define FILENAME_CORE_BACKTRACE "core_backtrace"
1112 #define FILENAME_REMOTE_RESULT "remote_result"
1113 #define FILENAME_PKG_EPOCH "pkg_epoch"
1114 #define FILENAME_PKG_NAME "pkg_name"
1115 #define FILENAME_PKG_VERSION "pkg_version"
1116 #define FILENAME_PKG_RELEASE "pkg_release"
1117 #define FILENAME_PKG_ARCH "pkg_arch"
1118 
1119 /* RHEL packages - Red Hat, Inc. */
1120 #define FILENAME_PKG_VENDOR "pkg_vendor"
1121 /* RHEL keys - https://access.redhat.com/security/team/key */
1122 #define FILENAME_PKG_FINGERPRINT "pkg_fingerprint"
1123 
1124 #define FILENAME_USERNAME "username"
1125 #define FILENAME_ABRT_VERSION "abrt_version"
1126 #define FILENAME_EXPLOITABLE "exploitable"
1127 
1128 /* reproducible element is used by functions from problem_data.h */
1129 #define FILENAME_REPRODUCIBLE "reproducible"
1130 #define FILENAME_REPRODUCER "reproducer"
1131 
1132 /* File names related to Anaconda problems
1133  */
1134 #define FILENAME_KICKSTART_CFG "ks.cfg"
1135 #define FILENAME_ANACONDA_TB "anaconda-tb"
1136 
1137 /* Containers
1138  */
1139 #define FILENAME_CONTAINER "container"
1140 #define FILENAME_CONTAINER_ID "container_id"
1141 #define FILENAME_CONTAINER_UUID "container_uuid"
1142 #define FILENAME_CONTAINER_IMAGE "container_image"
1143 #define FILENAME_CONTAINER_CMDLINE "container_cmdline"
1144 #define FILENAME_DOCKER_INSPECT "docker_inspect"
1145 
1146 /* Type of catched exception
1147  * Optional.
1148  */
1149 #define FILENAME_EXCEPTION_TYPE "exception_type"
1150 
1151 // Not stored as files, added "on the fly":
1152 #define CD_DUMPDIR "Directory"
1153 
1154 #define cmp_problem_data libreport_cmp_problem_data
1155 gint cmp_problem_data(gconstpointer a, gconstpointer b, gpointer filename);
1156 
1157 //UNUSED:
1160 //#define CD_EVENTS "Events"
1161 
1162 /* FILENAME_EVENT_LOG is trimmed to below LOW_WATERMARK
1163  * when it reaches HIGH_WATERMARK size
1164  */
1165 enum {
1166  EVENT_LOG_HIGH_WATERMARK = 30 * 1024,
1167  EVENT_LOG_LOW_WATERMARK = 20 * 1024,
1168 };
1169 
1170 #define log_problem_data libreport_log_problem_data
1171 void log_problem_data(problem_data_t *problem_data, const char *pfx);
1172 
1173 extern int g_libreport_inited;
1174 void libreport_init(void);
1175 
1176 #define INITIALIZE_LIBREPORT() \
1177  do \
1178  { \
1179  if (!g_libreport_inited) \
1180  { \
1181  g_libreport_inited = 1; \
1182  libreport_init(); \
1183  } \
1184  } \
1185  while (0)
1186 
1187 const char *abrt_init(char **argv);
1188 #define export_abrt_envvars libreport_export_abrt_envvars
1189 void export_abrt_envvars(int pfx);
1190 #define g_progname libreport_g_progname
1191 extern const char *g_progname;
1192 
1193 enum parse_opt_type {
1194  OPTION_BOOL,
1195  OPTION_GROUP,
1196  OPTION_STRING,
1197  OPTION_INTEGER,
1198  OPTION_OPTSTRING,
1199  OPTION_LIST,
1200  OPTION_END,
1201 };
1202 
1203 struct options {
1204  enum parse_opt_type type;
1205  int short_name;
1206  const char *long_name;
1207  void *value;
1208  const char *argh;
1209  const char *help;
1210 };
1211 
1212 /*
1213  * s - short_name
1214  * l - long_name
1215  * v - value
1216  * a - option parameter name (for help text)
1217  * h - help
1218  */
1219 #define OPT_END() { OPTION_END }
1220 #define OPT_GROUP(h) { OPTION_GROUP, 0, NULL, NULL, NULL, (h) }
1221 #define OPT_BOOL( s, l, v, h) { OPTION_BOOL , (s), (l), (v), NULL , (h) }
1222 #define OPT_INTEGER( s, l, v, h) { OPTION_INTEGER , (s), (l), (v), "NUM", (h) }
1223 #define OPT_STRING( s, l, v, a, h) { OPTION_STRING , (s), (l), (v), (a) , (h) }
1224 #define OPT_OPTSTRING(s, l, v, a, h) { OPTION_OPTSTRING, (s), (l), (v), (a) , (h) }
1225 #define OPT_LIST( s, l, v, a, h) { OPTION_LIST , (s), (l), (v), (a) , (h) }
1226 
1227 #define OPT__VERBOSE(v) OPT_BOOL('v', "verbose", (v), _("Be verbose"))
1228 #define OPT__DUMP_DIR(v) OPT_STRING('d', "problem-dir", (v), "DIR", _("Problem directory"))
1229 
1230 #define parse_opts libreport_parse_opts
1231 unsigned parse_opts(int argc, char **argv, const struct options *opt,
1232  const char *usage);
1233 
1234 #define show_usage_and_die libreport_show_usage_and_die
1235 void show_usage_and_die(const char *usage, const struct options *opt) NORETURN;
1236 
1237 /* Can't include "abrt_curl.h", it's not a public API.
1238  * Resorting to just forward-declaring the struct we need.
1239  */
1240 struct abrt_post_state;
1241 
1242 /* Decomposes uri to its base elements, removes userinfo out of the hostname and
1243  * composes a new uri without userinfo.
1244  *
1245  * The function does not validate the url.
1246  *
1247  * @param uri The uri that might contain userinfo
1248  * @param result The userinfo free uri will be store here. Cannot be null. Must
1249  * be de-allocated by free.
1250  * @param scheme Scheme of the uri. Can be NULL. Result can be NULL. Result
1251  * must be de-allocated by free.
1252  * @param hostname Hostname of the uri. Can be NULL. Result can be NULL. Result
1253  * must be de-allocated by free.
1254  * @param username Username of the uri. Can be NULL. Result can be NULL. Result
1255  * must be de-allocated by free.
1256  * @param password Password of the uri. Can be NULL. Result can be NULL. Result
1257  * must be de-allocated by free.
1258  * @param location Location of the uri. Can be NULL. Result is never NULL. Result
1259  * must be de-allocated by free.
1260  */
1261 #define uri_userinfo_remove libreport_uri_userinfo_remove
1262 int uri_userinfo_remove(const char *uri, char **result, char **scheme, char **hostname, char **username, char **password, char **location);
1263 
1264 #ifdef __cplusplus
1265 }
1266 #endif
1267 
1268 #endif