libreport  2.6.4
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_at libreport_copy_file_ext_at
191 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);
192 #define copy_file_ext(src_name, dst_name, mode, uid, gid, src_flags, dst_flags) \
193  copy_file_ext_at(src_name, AT_FDCWD, dst_name, mode, uid, gid, src_flags, dst_flags)
194 #define copy_file libreport_copy_file
195 off_t copy_file(const char *src_name, const char *dst_name, int mode);
196 #define copy_file_at libreport_copy_file_at
197 off_t copy_file_at(const char *src_name, int dir_fd, const char *name, int mode);
198 #define copy_file_recursive libreport_copy_file_recursive
199 int copy_file_recursive(const char *source, const char *dest);
200 
201 #define decompress_fd libreport_decompress_fd
202 int decompress_fd(int fdi, int fdo);
203 #define decompress_file libreport_decompress_file
204 int decompress_file(const char *path_in, const char *path_out, mode_t mode_out);
205 #define decompress_file_ext_at libreport_decompress_file_ext_at
206 int decompress_file_ext_at(const char *path_in, int dir_fd, const char *path_out,
207  mode_t mode_out, uid_t uid, gid_t gid, int src_flags, int dst_flags);
208 
209 // NB: will return short read on error, not -1,
210 // if some data was read before error occurred
211 #define xread libreport_xread
212 void xread(int fd, void *buf, size_t count);
213 #define safe_read libreport_safe_read
214 ssize_t safe_read(int fd, void *buf, size_t count);
215 #define safe_write libreport_safe_write
216 ssize_t safe_write(int fd, const void *buf, size_t count);
217 #define full_read libreport_full_read
218 ssize_t full_read(int fd, void *buf, size_t count);
219 #define full_write libreport_full_write
220 ssize_t full_write(int fd, const void *buf, size_t count);
221 #define full_write_str libreport_full_write_str
222 ssize_t full_write_str(int fd, const char *buf);
223 #define xmalloc_read libreport_xmalloc_read
224 void* xmalloc_read(int fd, size_t *maxsz_p);
225 #define xmalloc_open_read_close libreport_xmalloc_open_read_close
226 void* xmalloc_open_read_close(const char *filename, size_t *maxsz_p);
227 #define xmalloc_xopen_read_close libreport_xmalloc_xopen_read_close
228 void* xmalloc_xopen_read_close(const char *filename, size_t *maxsz_p);
229 #define malloc_readlink libreport_malloc_readlink
230 char* malloc_readlink(const char *linkname);
231 #define malloc_readlinkat libreport_malloc_readlinkat
232 char* malloc_readlinkat(int dir_fd, const char *linkname);
233 
234 
235 /* Returns malloc'ed block */
236 #define encode_base64 libreport_encode_base64
237 char *encode_base64(const void *src, int length);
238 
239 /* Returns NULL if the string needs no sanitizing.
240  * control_chars_to_sanitize is a bit mask.
241  * If Nth bit is set, Nth control char will be sanitized (replaced by [XX]).
242  */
243 #define sanitize_utf8 libreport_sanitize_utf8
244 char *sanitize_utf8(const char *src, uint32_t control_chars_to_sanitize);
245 enum {
246  SANITIZE_ALL = 0xffffffff,
247  SANITIZE_TAB = (1 << 9),
248  SANITIZE_LF = (1 << 10),
249  SANITIZE_CR = (1 << 13),
250 };
251 
252 #define SHA1_RESULT_LEN (5 * 4)
253 typedef struct sha1_ctx_t {
254  uint8_t wbuffer[64]; /* always correctly aligned for uint64_t */
255  /* for sha256: void (*process_block)(struct md5_ctx_t*); */
256  uint64_t total64; /* must be directly before hash[] */
257  uint32_t hash[8]; /* 4 elements for md5, 5 for sha1, 8 for sha256 */
258 } sha1_ctx_t;
259 #define sha1_begin libreport_sha1_begin
260 void sha1_begin(sha1_ctx_t *ctx);
261 #define sha1_hash libreport_sha1_hash
262 void sha1_hash(sha1_ctx_t *ctx, const void *buffer, size_t len);
263 #define sha1_end libreport_sha1_end
264 void sha1_end(sha1_ctx_t *ctx, void *resbuf);
265 
266 /* Helpers to hash a string: */
267 #define str_to_sha1 libreport_str_to_sha1
268 const uint8_t *str_to_sha1(uint8_t result[SHA1_RESULT_LEN], const char *str);
269 #define str_to_sha1str libreport_str_to_sha1str
270 const char *str_to_sha1str(char result[SHA1_RESULT_LEN*2 + 1], const char *str);
271 
272 
273 #define try_atou libreport_try_atou
274 int try_atou(const char *numstr, unsigned *value);
275 #define xatou libreport_xatou
276 unsigned xatou(const char *numstr);
277 #define try_atoi libreport_try_atoi
278 int try_atoi(const char *numstr, int *value);
279 #define xatoi libreport_xatoi
280 int xatoi(const char *numstr);
281 /* Using xatoi() instead of naive atoi() is not always convenient -
282  * in many places people want *non-negative* values, but store them
283  * in signed int. Therefore we need this one:
284  * dies if input is not in [0, INT_MAX] range. Also will reject '-0' etc.
285  * It should really be named xatoi_nonnegative (since it allows 0),
286  * but that would be too long.
287  */
288 #define try_atoi_positive libreport_try_atoi_positive
289 int try_atoi_positive(const char *numstr, int *value);
290 #define xatoi_positive libreport_xatoi_positive
291 int xatoi_positive(const char *numstr);
292 
293 //unused for now
294 //unsigned long long monotonic_ns(void);
295 //unsigned long long monotonic_us(void);
296 //unsigned monotonic_sec(void);
297 
298 #define safe_waitpid libreport_safe_waitpid
299 pid_t safe_waitpid(pid_t pid, int *wstat, int options);
300 
301 enum {
302  /* on return, pipefds[1] is fd to which parent may write
303  * and deliver data to child's stdin: */
304  EXECFLG_INPUT = 1 << 0,
305  /* on return, pipefds[0] is fd from which parent may read
306  * child's stdout: */
307  EXECFLG_OUTPUT = 1 << 1,
308  /* open child's stdin to /dev/null: */
309  EXECFLG_INPUT_NUL = 1 << 2,
310  /* open child's stdout to /dev/null: */
311  EXECFLG_OUTPUT_NUL = 1 << 3,
312  /* redirect child's stderr to stdout: */
313  EXECFLG_ERR2OUT = 1 << 4,
314  /* open child's stderr to /dev/null: */
315  EXECFLG_ERR_NUL = 1 << 5,
316  /* suppress perror_msg("Can't execute 'foo'") if exec fails */
317  EXECFLG_QUIET = 1 << 6,
318  EXECFLG_SETGUID = 1 << 7,
319  EXECFLG_SETSID = 1 << 8,
320  EXECFLG_SETPGID = 1 << 9,
321 };
322 /*
323  * env_vec: list of variables to set in environment (if string has
324  * "VAR=VAL" form) or unset in environment (if string has no '=' char).
325  *
326  * Returns pid.
327  */
328 #define fork_execv_on_steroids libreport_fork_execv_on_steroids
329 pid_t fork_execv_on_steroids(int flags,
330  char **argv,
331  int *pipefds,
332  char **env_vec,
333  const char *dir,
334  uid_t uid);
335 /* Returns malloc'ed string. NULs are retained, and extra one is appended
336  * after the last byte (this NUL is not accounted for in *size_p) */
337 #define run_in_shell_and_save_output libreport_run_in_shell_and_save_output
338 char *run_in_shell_and_save_output(int flags,
339  const char *cmd,
340  const char *dir,
341  size_t *size_p);
342 
343 /* Random utility functions */
344 
345 #define is_in_string_list libreport_is_in_string_list
346 bool is_in_string_list(const char *name, const char *const *v);
347 
348 #define index_of_string_in_list libreport_index_of_string_in_list
349 int index_of_string_in_list(const char *name, const char *const *v);
350 
351 #define is_in_comma_separated_list libreport_is_in_comma_separated_list
352 bool is_in_comma_separated_list(const char *value, const char *list);
353 #define is_in_comma_separated_list_of_glob_patterns libreport_is_in_comma_separated_list_of_glob_patterns
354 bool is_in_comma_separated_list_of_glob_patterns(const char *value, const char *list);
355 
356 /* Calls GLib version appropriate initialization function.
357  */
358 #define glib_init libreport_glib_init
359 void glib_init(void);
360 
361 /* Frees every element'd data using free(),
362  * then frees list itself using g_list_free(list):
363  */
364 #define list_free_with_free libreport_list_free_with_free
365 void list_free_with_free(GList *list);
366 
367 #define get_dirsize libreport_get_dirsize
368 double get_dirsize(const char *pPath);
369 #define get_dirsize_find_largest_dir libreport_get_dirsize_find_largest_dir
370 double get_dirsize_find_largest_dir(
371  const char *pPath,
372  char **worst_dir, /* can be NULL */
373  const char *excluded /* can be NULL */
374 );
375 
376 #define ndelay_on libreport_ndelay_on
377 int ndelay_on(int fd);
378 #define ndelay_off libreport_ndelay_off
379 int ndelay_off(int fd);
380 #define close_on_exec_on libreport_close_on_exec_on
381 int close_on_exec_on(int fd);
382 
383 #define xmalloc libreport_xmalloc
384 void* xmalloc(size_t size);
385 #define xrealloc libreport_xrealloc
386 void* xrealloc(void *ptr, size_t size);
387 #define xzalloc libreport_xzalloc
388 void* xzalloc(size_t size);
389 #define xstrdup libreport_xstrdup
390 char* xstrdup(const char *s);
391 #define xstrndup libreport_xstrndup
392 char* xstrndup(const char *s, int n);
393 #define xstrdup_between libreport_xstrdup_between
394 char* xstrdup_between(const char *s, const char *open, const char *close);
395 
396 #define xpipe libreport_xpipe
397 void xpipe(int filedes[2]);
398 #define xdup libreport_xdup
399 int xdup(int from);
400 #define xdup2 libreport_xdup2
401 void xdup2(int from, int to);
402 #define xmove_fd libreport_xmove_fd
403 void xmove_fd(int from, int to);
404 
405 #define xwrite libreport_xwrite
406 void xwrite(int fd, const void *buf, size_t count);
407 #define xwrite_str libreport_xwrite_str
408 void xwrite_str(int fd, const char *str);
409 
410 #define xlseek libreport_xlseek
411 off_t xlseek(int fd, off_t offset, int whence);
412 
413 #define xchdir libreport_xchdir
414 void xchdir(const char *path);
415 
416 #define xvasprintf libreport_xvasprintf
417 char* xvasprintf(const char *format, va_list p);
418 #define xasprintf libreport_xasprintf
419 char* xasprintf(const char *format, ...);
420 
421 #define xsetenv libreport_xsetenv
422 void xsetenv(const char *key, const char *value);
423 /*
424  * Utility function to unsetenv a string which was possibly putenv'ed.
425  * The problem here is that "natural" optimization:
426  * strchrnul(var_val, '=')[0] = '\0';
427  * unsetenv(var_val);
428  * is BUGGY: if string was put into environment via putenv,
429  * its modification (s/=/NUL/) is illegal, and unsetenv will fail to unset it.
430  * Of course, saving/restoring the char wouldn't work either.
431  * This helper creates a copy up to '=', unsetenv's it, and frees:
432  */
433 #define safe_unsetenv libreport_safe_unsetenv
434 void safe_unsetenv(const char *var_val);
435 
436 #define xsocket libreport_xsocket
437 int xsocket(int domain, int type, int protocol);
438 #define xbind libreport_xbind
439 void xbind(int sockfd, struct sockaddr *my_addr, socklen_t addrlen);
440 #define xlisten libreport_xlisten
441 void xlisten(int s, int backlog);
442 #define xsendto libreport_xsendto
443 ssize_t xsendto(int s, const void *buf, size_t len,
444  const struct sockaddr *to, socklen_t tolen);
445 
446 #define xstat libreport_xstat
447 void xstat(const char *name, struct stat *stat_buf);
448 #define fstat_st_size_or_die libreport_fstat_st_size_or_die
449 off_t fstat_st_size_or_die(int fd);
450 #define stat_st_size_or_die libreport_stat_st_size_or_die
451 off_t stat_st_size_or_die(const char *filename);
452 
453 #define xopen3 libreport_xopen3
454 int xopen3(const char *pathname, int flags, int mode);
455 #define xopen libreport_xopen
456 int xopen(const char *pathname, int flags);
457 #define xunlink libreport_xunlink
458 void xunlink(const char *pathname);
459 #define xunlinkat libreport_xunlinkat
460 void xunlinkat(int dir_fd, const char *pathname, int flags);
461 
462 /* Just testing dent->d_type == DT_REG is wrong: some filesystems
463  * do not report the type, they report DT_UNKNOWN for every dirent
464  * (and this is not a bug in filesystem, this is allowed by standards).
465  * This function handles this case. Note: it returns 0 on symlinks
466  * even if they point to regular files.
467  */
468 #define is_regular_file libreport_is_regular_file
469 int is_regular_file(struct dirent *dent, const char *dirname);
470 #define is_regular_file_at libreport_is_regular_file_at
471 int is_regular_file_at(struct dirent *dent, int dir_fd);
472 
473 #define dot_or_dotdot libreport_dot_or_dotdot
474 bool dot_or_dotdot(const char *filename);
475 #define last_char_is libreport_last_char_is
476 char *last_char_is(const char *s, int c);
477 
478 #define string_to_bool libreport_string_to_bool
479 bool string_to_bool(const char *s);
480 
481 #define xseteuid libreport_xseteuid
482 void xseteuid(uid_t euid);
483 #define xsetegid libreport_xsetegid
484 void xsetegid(gid_t egid);
485 #define xsetreuid libreport_xsetreuid
486 void xsetreuid(uid_t ruid, uid_t euid);
487 #define xsetregid libreport_xsetregid
488 void xsetregid(gid_t rgid, gid_t egid);
489 
490 
491 /* Emit a string of hex representation of bytes */
492 #define bin2hex libreport_bin2hex
493 char* bin2hex(char *dst, const char *str, int count);
494 /* Convert "xxxxxxxx" hex string to binary, no more than COUNT bytes */
495 #define hex2bin libreport_hex2bin
496 char* hex2bin(char *dst, const char *str, int count);
497 
498 
499 enum {
500  LOGMODE_NONE = 0,
501  LOGMODE_STDIO = (1 << 0),
502  LOGMODE_SYSLOG = (1 << 1),
503  LOGMODE_BOTH = LOGMODE_SYSLOG + LOGMODE_STDIO,
504  LOGMODE_CUSTOM = (1 << 2),
505  LOGMODE_JOURNAL = (1 << 3),
506 };
507 
508 #define g_custom_logger libreport_g_custom_logger
509 extern void (*g_custom_logger)(const char*);
510 #define msg_prefix libreport_msg_prefix
511 extern const char *msg_prefix;
512 #define msg_eol libreport_msg_eol
513 extern const char *msg_eol;
514 #define logmode libreport_logmode
515 extern int logmode;
516 #define xfunc_error_retval libreport_xfunc_error_retval
517 extern int xfunc_error_retval;
518 
519 /* A few magic exit codes */
520 #define EXIT_CANCEL_BY_USER 69
521 #define EXIT_STOP_EVENT_RUN 70
522 
523 #define set_xfunc_error_retval libreport_set_xfunc_error_retval
524 void set_xfunc_error_retval(int retval);
525 
526 /* Verbosity level */
527 #define g_verbose libreport_g_verbose
528 extern int g_verbose;
529 /* VERB1 log("what you sometimes want to see, even on a production box") */
530 #define VERB1 if (g_verbose >= 1)
531 /* VERB2 log("debug message, not going into insanely small details") */
532 #define VERB2 if (g_verbose >= 2)
533 /* VERB3 log("lots and lots of details") */
534 #define VERB3 if (g_verbose >= 3)
535 /* there is no level > 3 */
536 
537 #define libreport_
538 #define xfunc_die libreport_xfunc_die
539 void xfunc_die(void) NORETURN;
540 
541 #define die_out_of_memory libreport_die_out_of_memory
542 void die_out_of_memory(void) NORETURN;
543 
544 /* It's a macro, not function, since it collides with log() from math.h */
545 #undef log
546 #define log(...) log_standard(LOG_WARNING, __FILE__, __LINE__, __func__, __VA_ARGS__)
547 #define log_debug(...) log_standard(LOG_DEBUG, __FILE__, __LINE__, __func__, __VA_ARGS__)
548 #define log_info(...) log_standard(LOG_INFO, __FILE__, __LINE__, __func__, __VA_ARGS__)
549 #define log_notice(...) log_standard(LOG_NOTICE, __FILE__, __LINE__, __func__, __VA_ARGS__)
550 #define log_warning(...) log_standard(LOG_WARNING, __FILE__, __LINE__, __func__, __VA_ARGS__)
551 #define log_error(...) log_standard(LOG_ERR, __FILE__, __LINE__, __func__, __VA_ARGS__)
552 
553 // specific subsystem debugging
554 #define log_parser(...) if(0) log_debug(__VA_ARGS__)
555 
556 #define log_standard(level, file, line, func, ...) log_wrapper(level, __FILE__, __LINE__, __func__, false, false, __VA_ARGS__)
557 
558 // level, file, line, func, perror, custom logger, format & args
559 #define log_error_and_die(...) log_wrapper(LOG_ERR, __FILE__, __LINE__, __func__, false, false,__VA_ARGS__)
560 #define log_perror(...) log_wrapper(LOG_ERR, __FILE__, __LINE__, __func__, true, false, __VA_ARGS__)
561 #define log_perror_and_die(...) log_wrapper(LOG_ERR, __FILE__, __LINE__, __func__, true, false, __VA_ARGS__)
562 
563 #define error_msg(...) log_wrapper(LOG_ERR, __FILE__, __LINE__, __func__, false, true, __VA_ARGS__)
564 #define perror_msg(...) log_wrapper(LOG_ERR, __FILE__, __LINE__, __func__, true, true, __VA_ARGS__)
565 #define warn_msg(...) log_wrapper(LOG_WARNING, __FILE__, __LINE__, __func__, false, true, __VA_ARGS__)
566 #define pwarn_msg(...) log_wrapper(LOG_WARNING, __FILE__, __LINE__, __func__, true, true, __VA_ARGS__)
567 #define error_msg_and_die(...) log_and_die_wrapper(LOG_ERR, __FILE__, __LINE__, __func__, false, true, __VA_ARGS__)
568 #define perror_msg_and_die(...) log_and_die_wrapper(LOG_ERR, __FILE__, __LINE__, __func__, true, true, __VA_ARGS__)
569 
570 
571 void log_wrapper(int level,
572  const char *file,
573  int line,
574  const char *func,
575  bool process_perror,
576  bool use_custom_logger,
577  const char *format, ...) __attribute__ ((format (printf, 7,8)));
578 
579 void log_and_die_wrapper(int level,
580  const char *file,
581  int line,
582  const char *func,
583  bool process_perror,
584  bool use_custom_logger,
585  const char *format, ...) __attribute__ ((noreturn, format (printf, 7,8)));
586 
587 struct strbuf
588 {
589  /* Size of the allocated buffer. Always > 0. */
590  int alloc;
591  /* Length of the string, without the ending \0. */
592  int len;
593  char *buf;
594 };
595 
602 #define strbuf_new libreport_strbuf_new
603 struct strbuf *strbuf_new(void);
604 
610 #define strbuf_free libreport_strbuf_free
611 void strbuf_free(struct strbuf *strbuf);
612 
618 #define strbuf_free_nobuf libreport_strbuf_free_nobuf
619 char* strbuf_free_nobuf(struct strbuf *strbuf);
620 
625 #define strbuf_clear libreport_strbuf_clear
626 void strbuf_clear(struct strbuf *strbuf);
627 
632 #define strbuf_append_char libreport_strbuf_append_char
633 struct strbuf *strbuf_append_char(struct strbuf *strbuf, char c);
634 
639 #define strbuf_append_str libreport_strbuf_append_str
640 struct strbuf *strbuf_append_str(struct strbuf *strbuf,
641  const char *str);
642 
647 #define strbuf_prepend_str libreport_strbuf_prepend_str
648 struct strbuf *strbuf_prepend_str(struct strbuf *strbuf,
649  const char *str);
650 
655 #define strbuf_append_strf libreport_strbuf_append_strf
656 struct strbuf *strbuf_append_strf(struct strbuf *strbuf,
657  const char *format, ...);
658 
663 #define strbuf_append_strfv libreport_strbuf_append_strfv
664 struct strbuf *strbuf_append_strfv(struct strbuf *strbuf,
665  const char *format, va_list p);
666 
672 #define strbuf_prepend_strf libreport_strbuf_prepend_strf
673 struct strbuf *strbuf_prepend_strf(struct strbuf *strbuf,
674  const char *format, ...);
675 
680 #define strbuf_prepend_strfv libreport_strbuf_prepend_strfv
681 struct strbuf *strbuf_prepend_strfv(struct strbuf *strbuf,
682  const char *format, va_list p);
683 
684 /* Returns command line of running program.
685  * Caller is responsible to free() the returned value.
686  * If the pid is not valid or command line can not be obtained,
687  * empty string is returned.
688  */
689 #define get_cmdline libreport_get_cmdline
690 char* get_cmdline(pid_t pid);
691 #define get_environ libreport_get_environ
692 char* get_environ(pid_t pid);
693 #define get_executable libreport_get_executable
694 char *get_executable(pid_t pid);
695 #define get_cwd libreport_get_cwd
696 char* get_cwd(pid_t pid);
697 #define get_rootdir libreport_get_rootdir
698 char* get_rootdir(pid_t pid);
699 #define get_fsuid libreport_get_fsuid
700 int get_fsuid(const char *proc_pid_status);
701 #define get_fsgid libreport_get_fsgid
702 int get_fsgid(const char *proc_pid_status);
703 #define dump_fd_info_ext libreport_dump_fd_info_ext
704 int dump_fd_info_ext(const char *dest_filename, const char *proc_pid_fd_path, uid_t uid, gid_t gid);
705 #define dump_fd_info libreport_dump_fd_info
706 int dump_fd_info(const char *dest_filename, const char *proc_pid_fd_path);
707 #define get_env_variable libreport_get_env_variable
708 int get_env_variable(pid_t pid, const char *name, char **value);
709 
710 #define PROC_NS_UNSUPPORTED ((ino_t)-1)
711 #define PROC_NS_ID_IPC 0
712 #define PROC_NS_ID_MNT 1
713 #define PROC_NS_ID_NET 2
714 #define PROC_NS_ID_PID 3
715 #define PROC_NS_ID_USER 4
716 #define PROC_NS_ID_UTS 5
717 static const char * libreport_proc_namespaces[] = { "ipc", "mnt", "net", "pid", "uts", "user" };
718 
719 struct ns_ids {
720  ino_t nsi_ids[ARRAY_SIZE(libreport_proc_namespaces)];
721 };
722 
723 #define get_ns_ids libreport_get_ns_ids
724 int get_ns_ids(pid_t pid, struct ns_ids *ids);
725 #define process_has_own_root libreport_process_has_own_root
726 int process_has_own_root(pid_t pid);
727 #define get_pid_of_container libreport_get_pid_of_container
728 int get_pid_of_container(pid_t pid, pid_t *init_pid);
729 #define dump_namespace_diff_ext libreport_dump_namespace_diff_ext
730 int dump_namespace_diff_ext(const char *dest_filename, pid_t base_pid, pid_t tested_pid, uid_t uid, gid_t gid);
731 #define dump_namespace_diff libreport_dump_namespace_diff
732 int dump_namespace_diff(const char *dest_filename, pid_t base_pid, pid_t tested_pid);
733 
734 #define MOUNTINFO_ROOT(val) (val.mntnf_items[3])
735 #define MOUNTINFO_MOUNT_POINT(val) (val.mntnf_items[4])
736 #define MOUNTINFO_MOUNT_SOURCE(val) (val.mntnf_items[8])
737 
738 struct mountinfo
739 {
740  /* 4 : root of the mount within the filesystem */
741  /* 5 : mount point relative to the process's root */
742  /* 10 : mount source: filesystem specific information or "none" */
743  /* but it mount source is preceded by 0 or more optional fields */
744  /* so the effective value is 9 */
745  char *mntnf_items[10];
746 };
747 #define mountinfo_destroy libreport_mountinfo_destroy
748 void mountinfo_destroy(struct mountinfo *mntnf);
749 #define get_mountinfo_for_mount_point libreport_get_mountinfo_for_mount_point
750 int get_mountinfo_for_mount_point(FILE *fin, struct mountinfo *mntnf, const char *mnt_point);
751 
752 /* Takes ptr to time_t, or NULL if you want to use current time.
753  * Returns "YYYY-MM-DD-hh:mm:ss" string.
754  */
755 #define iso_date_string libreport_iso_date_string
756 char *iso_date_string(const time_t *pt);
757 #define LIBREPORT_ISO_DATE_STRING_SAMPLE "YYYY-MM-DD-hh:mm:ss"
758 #define LIBREPORT_ISO_DATE_STRING_FORMAT "%Y-%m-%d-%H:%M:%S"
759 
760 /* Parses date into integer UNIX time stamp
761  *
762  * @param date The parsed date string
763  * @param pt Return value
764  * @return 0 on success; otherwise non-0 number. -EINVAL if the parameter date
765  * does not match LIBREPORT_ISO_DATE_STRING_FORMAT
766  */
767 #define iso_date_string_parse libreport_iso_date_string_parse
768 int iso_date_string_parse(const char *date, time_t *pt);
769 
770 enum {
771  MAKEDESC_SHOW_FILES = (1 << 0),
772  MAKEDESC_SHOW_MULTILINE = (1 << 1),
773  MAKEDESC_SHOW_ONLY_LIST = (1 << 2),
774  MAKEDESC_WHITELIST = (1 << 3),
775  /* Include all URLs from FILENAME_REPORTED_TO element in the description text */
776  MAKEDESC_SHOW_URLS = (1 << 4),
777 };
778 #define make_description libreport_make_description
779 char *make_description(problem_data_t *problem_data, char **names_to_skip, unsigned max_text_size, unsigned desc_flags);
780 #define make_description_bz libreport_make_description_bz
781 char* make_description_bz(problem_data_t *problem_data, unsigned max_text_size);
782 #define make_description_logger libreport_make_description_logger
783 char* make_description_logger(problem_data_t *problem_data, unsigned max_text_size);
784 #define make_description_mailx libreport_make_description_mailx
785 char* make_description_mailx(problem_data_t *problem_data, unsigned max_text_size);
786 
787 /* See man os-release(5) for details */
788 #define OSINFO_ID "ID"
789 #define OSINFO_NAME "NAME"
790 #define OSINFO_VERSION_ID "VERSION_ID"
791 #define OSINFO_PRETTY_NAME "PRETTY_NAME"
792 
793 /* @brief Loads a text in format of os-release(5) in to a map
794  *
795  * Function doesn't check for format errors much. It just tries to avoid
796  * program errors. In case of error the function prints out a log message and
797  * continues in parsing.
798  *
799  * @param osinfo_bytes Non-NULL pointer to osinfo bytes.
800  * @param osinfo The map where result is stored
801  */
802 #define parse_osinfo libreport_parse_osinfo
803 void parse_osinfo(const char *osinfo_bytes, map_string_t *osinfo);
804 
805 /* @brief Builds product string and product's version string for Bugzilla
806  *
807  * At first tries to get strings from the os specific variables
808  * (REDHAT_BUGZILLA_PRODUCT, REDHAT_BUGZILLA_PRODUCT_VERSION) if no such
809  * variables are found, uses NAME key for the product and VERSION_ID key for
810  * the product's version. If neither NAME nor VERSION_ID are provided fallbacks
811  * to parsing of os_release which should be stored under PRETTY_NAME key.
812  *
813  * https://bugzilla.redhat.com/show_bug.cgi?id=950373
814  *
815  * @param osinfo Input data from which the values are built
816  * @param produc Non-NULL pointer where pointer to malloced string will be stored. Memory must be released by free()
817  * @param version Non-NULL pointer where pointer to malloced string will be stored. Memory must be released by free()
818  */
819 #define parse_osinfo_for_bz libreport_parse_osinfo_for_bz
820 void parse_osinfo_for_bz(map_string_t *osinfo, char **product, char **version);
821 
822 /* @brief Builds product string and product's version string for Red Hat Support
823  *
824  * At first tries to get strings from the os specific variables
825  * (REDHAT_SUPPORT_PRODUCT, REDHAT_SUPPORT_PRODUCT_VERSION) if no such
826  * variables are found, uses NAME key for the product and VERSION_ID key for
827  * the product's version. If no NAME nor VERSION_ID are provided fallbacks to
828  * parsing of os_release which should be stored under PRETTY_NAME key.
829  *
830  * https://bugzilla.redhat.com/show_bug.cgi?id=950373
831  *
832  * @param osinfo Input data from which the values are built
833  * @param produc Non-NULL pointer where pointer to malloced string will be stored. Memory must be released by free()
834  * @param version Non-NULL pointer where pointer to malloced string will be stored. Memory must be released by free()
835  */
836 #define parse_osinfo_for_rhts libreport_parse_osinfo_for_rhts
837 void parse_osinfo_for_rhts(map_string_t *osinfo, char **product, char **version);
838 
839 #define parse_release_for_bz libreport_parse_release_for_bz
840 void parse_release_for_bz(const char *pRelease, char **product, char **version);
841 #define parse_release_for_rhts libreport_parse_release_for_rhts
842 void parse_release_for_rhts(const char *pRelease, char **product, char **version);
843 
858 #define load_conf_file libreport_load_conf_file
859 bool load_conf_file(const char *pPath, map_string_t *settings, bool skipKeysWithoutValue);
860 #define load_plugin_conf_file libreport_load_plugin_conf_file
861 bool load_plugin_conf_file(const char *name, map_string_t *settings, bool skipKeysWithoutValue);
862 
863 #define get_user_conf_base_dir libreport_get_user_conf_base_dir
864 const char *get_user_conf_base_dir(void);
865 
866 #define load_conf_file_from_dirs libreport_load_conf_file_from_dirs
867 bool load_conf_file_from_dirs(const char *base_name, const char *const *directories, map_string_t *settings, bool skipKeysWithoutValue);
868 
869 enum {
870  CONF_DIR_FLAG_NONE = 0,
871  CONF_DIR_FLAG_OPTIONAL = 1,
872 };
873 
874 #define load_conf_file_from_dirs_ext libreport_load_conf_file_from_dirs_ext
875 bool load_conf_file_from_dirs_ext(const char *base_name, const char *const *directories,
876  const int * dir_flags, map_string_t *settings,
877  bool skipKeysWithoutValue);
878 
879 #define save_conf_file libreport_save_conf_file
880 bool save_conf_file(const char *path, map_string_t *settings);
881 #define save_plugin_conf_file libreport_save_plugin_conf_file
882 bool save_plugin_conf_file(const char *name, map_string_t *settings);
883 
884 #define save_app_conf_file libreport_save_app_conf_file
885 bool save_app_conf_file(const char* application_name, map_string_t *settings);
886 #define load_app_conf_file libreport_load_app_conf_file
887 bool load_app_conf_file(const char *application_name, map_string_t *settings);
888 #define set_app_user_setting libreport_set_app_user_setting
889 void set_app_user_setting(map_string_t *settings, const char *name, const char *value);
890 #define get_app_user_setting libreport_get_app_user_setting
891 const char *get_app_user_setting(map_string_t *settings, const char *name);
892 
893 #define save_user_settings libreport_save_user_settings
894 bool save_user_settings();
895 #define load_user_settings libreport_load_user_settings
896 bool load_user_settings(const char *application_name);
897 #define set_user_setting libreport_set_user_setting
898 void set_user_setting(const char *name, const char *value);
899 #define get_user_setting libreport_get_user_setting
900 const char *get_user_setting(const char *name);
901 
902 /* filename is expected to exist in CONF_DIR
903  * usually /etc/libreport
904  */
905 #define load_forbidden_words libreport_load_forbidden_words
906 GList *load_words_from_file(const char *filename);
907 #define get_file_list libreport_get_file_list
908 GList *get_file_list(const char *path, const char *ext);
909 #define free_file_list libreport_free_file_list
910 void free_file_list(GList *filelist);
911 #define new_file_obj libreport_new_file_obj
912 file_obj_t *new_file_obj(const char* fullpath, const char* filename);
913 #define free_file_obj libreport_free_file_obj
914 void free_file_obj(file_obj_t *f);
915 #define load_workflow_config_data libreport_load_workflow_config_data
916 GHashTable *load_workflow_config_data(const char* path);
917 #define parse_delimited_list libreport_parse_delimited_list
918 GList *parse_delimited_list(char* list, const char *delim);
919 #define parse_list libreport_parse_list
920 GList *parse_list(const char* list);
921 
922 /* Connect to abrtd over unix domain socket, issue DELETE command */
923 int delete_dump_dir_possibly_using_abrtd(const char *dump_dir_name);
924 
925 /* Tries to create a copy of dump_dir_name in base_dir, with same or similar basename.
926  * Returns NULL if copying failed. In this case, logs a message before returning. */
927 #define steal_directory libreport_steal_directory
928 struct dump_dir *steal_directory(const char *base_dir, const char *dump_dir_name);
929 
930 /* Resolves if the given user is in given group
931  *
932  * @param uid user ID
933  * @param gid group ID
934  * @returns TRUE in case the user is in the group otherwise returns FALSE
935  */
936 #define uid_in_group libreport_uid_in_group
937 bool uid_in_group(uid_t uid, gid_t gid);
938 
939 /* Tries to open dump_dir_name with writing access. If function needs to steal
940  * directory calls ask_continue(new base dir, dump dir) callback to ask user
941  * for permission. If ask_continue param is NULL the function thinks that an
942  * answer is positive and steals directory.
943  * Returns NULL if opening failed or if stealing was dismissed. In this case,
944  * logs a message before returning. */
945 #define open_directory_for_writing libreport_open_directory_for_writing
946 struct dump_dir *open_directory_for_writing(
947  const char *dump_dir_name,
948  bool (*ask_continue)(const char *, const char *));
949 
950 // Files bigger than this are never considered to be text.
951 //
952 // Started at 64k limit. But _some_ limit is necessary:
953 // fields declared "text" may end up in editing fields and such.
954 // We don't want to accidentally end up with 100meg text in a textbox!
955 // So, don't remove this. If you really need to, raise the limit.
956 //
957 // Bumped up to 200k: saw 124740 byte /proc/PID/smaps file
958 // Bumped up to 500k: saw 375252 byte anaconda traceback file
959 // Bumped up to 1M: bugzilla.redhat.com/show_bug.cgi?id=746727
960 // mentions 853646 byte anaconda-tb-* file.
961 // Bumped up to 8M: bugzilla.redhat.com/show_bug.cgi?id=887570
962 // (anaconda-tb file of 1.38 MBytes)
963 //
964 #define CD_MAX_TEXT_SIZE (8*1024*1024)
965 
966 // Text bigger than this usually is attached, not added inline
967 // was 2k, 20kb is too much, let's try 4kb
968 //
969 // For bug databases
970 #define CD_TEXT_ATT_SIZE_BZ (4*1024)
971 // For dumping problem data into a text file, email, etc
972 #define CD_TEXT_ATT_SIZE_LOGGER (CD_MAX_TEXT_SIZE)
973 
974 // Filenames in problem directory:
975 // filled by a hook:
976 #define FILENAME_TIME "time" /* mandatory */
977 #define FILENAME_LAST_OCCURRENCE "last_occurrence" /* optional */
978 #define FILENAME_REASON "reason" /* mandatory? */
979 #define FILENAME_UID "uid" /* mandatory? */
980 
981 /*
982  * "analyzer" is to be gradually changed to "type":
983  * For now, we fetch and look at "analyzer" element,
984  * but we always save both "analyzer" and "type" (with same contents).
985  * By 2013, we switch to looking at "type". Then we will stop generating
986  * "analyzer" element.
987  * ----
988  * Update 2015: based on the recent changes where we have introduced several
989  * tools generating one problem type, we have decided to retain 'analyzer'
990  * file, but it shall contain string identifier of a tool that created the
991  * problem.
992  */
993 #define FILENAME_ANALYZER "analyzer"
994 #define FILENAME_TYPE "type"
995 #define FILENAME_EXECUTABLE "executable"
996 #define FILENAME_PID "pid"
997 #define FILENAME_TID "tid"
998 #define FILENAME_GLOBAL_PID "global_pid"
999 #define FILENAME_PWD "pwd"
1000 #define FILENAME_ROOTDIR "rootdir"
1001 #define FILENAME_BINARY "binary"
1002 #define FILENAME_CMDLINE "cmdline"
1003 #define FILENAME_COREDUMP "coredump"
1004 #define FILENAME_CGROUP "cgroup"
1005 #define FILENAME_BACKTRACE "backtrace"
1006 #define FILENAME_MAPS "maps"
1007 #define FILENAME_SMAPS "smaps"
1008 #define FILENAME_PROC_PID_STATUS "proc_pid_status"
1009 #define FILENAME_ENVIRON "environ"
1010 #define FILENAME_LIMITS "limits"
1011 #define FILENAME_OPEN_FDS "open_fds"
1012 #define FILENAME_MOUNTINFO "mountinfo"
1013 #define FILENAME_NAMESPACES "namespaces"
1014 
1015 /* Global problem identifier which is usually generated by some "analyze_*"
1016  * event because it may take a lot of time to obtain strong problem
1017  * identification */
1018 #define FILENAME_DUPHASH "duphash"
1019 
1020 // Name of the function where the application crashed.
1021 // Optional.
1022 #define FILENAME_CRASH_FUNCTION "crash_function"
1023 #define FILENAME_ARCHITECTURE "architecture"
1024 #define FILENAME_KERNEL "kernel"
1025 /*
1026  * From /etc/os-release
1027  * os_release filename name is alredy occupied by /etc/redhat-release (see
1028  * below) in sake of backward compatibility /etc/os-release is stored in
1029  * os_info file
1030  */
1031 #define FILENAME_OS_INFO "os_info"
1032 #define FILENAME_OS_INFO_IN_ROOTDIR "os_info_in_rootdir"
1033 // From /etc/system-release or /etc/redhat-release
1034 #define FILENAME_OS_RELEASE "os_release"
1035 #define FILENAME_OS_RELEASE_IN_ROOTDIR "os_release_in_rootdir"
1036 // Filled by <what?>
1037 #define FILENAME_PACKAGE "package"
1038 #define FILENAME_COMPONENT "component"
1039 #define FILENAME_COMMENT "comment"
1040 #define FILENAME_RATING "backtrace_rating"
1041 #define FILENAME_HOSTNAME "hostname"
1042 // Optional. Set to "1" by abrt-handle-upload for every unpacked dump
1043 #define FILENAME_REMOTE "remote"
1044 #define FILENAME_TAINTED "kernel_tainted"
1045 #define FILENAME_TAINTED_SHORT "kernel_tainted_short"
1046 #define FILENAME_TAINTED_LONG "kernel_tainted_long"
1047 #define FILENAME_VMCORE "vmcore"
1048 #define FILENAME_KERNEL_LOG "kernel_log"
1049 // File created by createAlertSignature() from libreport's python module
1050 // The file should contain a description of an alert
1051 #define FILENAME_DESCRIPTION "description"
1052 
1053 /* Local problem identifier (weaker than global identifier) designed for fast
1054  * local for fast local duplicate identification. This file is usually provided
1055  * by crashed application (problem creator).
1056  */
1057 #define FILENAME_UUID "uuid"
1058 
1059 #define FILENAME_COUNT "count"
1060 /* Multi-line list of places problem was reported.
1061  * Recommended line format:
1062  * "Reporter: VAR=VAL VAR=VAL"
1063  * Use add_reported_to(dd, "line_without_newline"): it adds line
1064  * only if it is not already there.
1065  */
1066 #define FILENAME_REPORTED_TO "reported_to"
1067 #define FILENAME_EVENT_LOG "event_log"
1068 /*
1069  * If exists, should contain a full sentence (with trailing period)
1070  * which describes why this problem should not be reported.
1071  * Example: "Your laptop firmware 1.9a is buggy, version 1.10 contains the fix."
1072  */
1073 #define FILENAME_NOT_REPORTABLE "not-reportable"
1074 #define FILENAME_CORE_BACKTRACE "core_backtrace"
1075 #define FILENAME_REMOTE_RESULT "remote_result"
1076 #define FILENAME_PKG_EPOCH "pkg_epoch"
1077 #define FILENAME_PKG_NAME "pkg_name"
1078 #define FILENAME_PKG_VERSION "pkg_version"
1079 #define FILENAME_PKG_RELEASE "pkg_release"
1080 #define FILENAME_PKG_ARCH "pkg_arch"
1081 #define FILENAME_USERNAME "username"
1082 #define FILENAME_ABRT_VERSION "abrt_version"
1083 #define FILENAME_EXPLOITABLE "exploitable"
1084 
1085 /* File names related to Anaconda problems
1086  */
1087 #define FILENAME_KICKSTART_CFG "ks.cfg"
1088 #define FILENAME_ANACONDA_TB "anaconda-tb"
1089 
1090 /* Containers
1091  */
1092 #define FILENAME_CONTAINER "container"
1093 #define FILENAME_CONTAINER_ID "container_id"
1094 #define FILENAME_CONTAINER_UUID "container_uuid"
1095 #define FILENAME_CONTAINER_IMAGE "container_image"
1096 #define FILENAME_CONTAINER_CMDLINE "container_cmdline"
1097 #define FILENAME_DOCKER_INSPECT "docker_inspect"
1098 
1099 // Not stored as files, added "on the fly":
1100 #define CD_DUMPDIR "Directory"
1101 
1102 #define cmp_problem_data libreport_cmp_problem_data
1103 gint cmp_problem_data(gconstpointer a, gconstpointer b, gpointer filename);
1104 
1105 //UNUSED:
1108 //#define CD_EVENTS "Events"
1109 
1110 /* FILENAME_EVENT_LOG is trimmed to below LOW_WATERMARK
1111  * when it reaches HIGH_WATERMARK size
1112  */
1113 enum {
1114  EVENT_LOG_HIGH_WATERMARK = 30 * 1024,
1115  EVENT_LOG_LOW_WATERMARK = 20 * 1024,
1116 };
1117 
1118 #define log_problem_data libreport_log_problem_data
1119 void log_problem_data(problem_data_t *problem_data, const char *pfx);
1120 
1121 extern int g_libreport_inited;
1122 void libreport_init(void);
1123 
1124 #define INITIALIZE_LIBREPORT() \
1125  do \
1126  { \
1127  if (!g_libreport_inited) \
1128  { \
1129  g_libreport_inited = 1; \
1130  libreport_init(); \
1131  } \
1132  } \
1133  while (0)
1134 
1135 const char *abrt_init(char **argv);
1136 #define export_abrt_envvars libreport_export_abrt_envvars
1137 void export_abrt_envvars(int pfx);
1138 #define g_progname libreport_g_progname
1139 extern const char *g_progname;
1140 
1141 enum parse_opt_type {
1142  OPTION_BOOL,
1143  OPTION_GROUP,
1144  OPTION_STRING,
1145  OPTION_INTEGER,
1146  OPTION_OPTSTRING,
1147  OPTION_LIST,
1148  OPTION_END,
1149 };
1150 
1151 struct options {
1152  enum parse_opt_type type;
1153  int short_name;
1154  const char *long_name;
1155  void *value;
1156  const char *argh;
1157  const char *help;
1158 };
1159 
1160 /*
1161  * s - short_name
1162  * l - long_name
1163  * v - value
1164  * a - option parameter name (for help text)
1165  * h - help
1166  */
1167 #define OPT_END() { OPTION_END }
1168 #define OPT_GROUP(h) { OPTION_GROUP, 0, NULL, NULL, NULL, (h) }
1169 #define OPT_BOOL( s, l, v, h) { OPTION_BOOL , (s), (l), (v), NULL , (h) }
1170 #define OPT_INTEGER( s, l, v, h) { OPTION_INTEGER , (s), (l), (v), "NUM", (h) }
1171 #define OPT_STRING( s, l, v, a, h) { OPTION_STRING , (s), (l), (v), (a) , (h) }
1172 #define OPT_OPTSTRING(s, l, v, a, h) { OPTION_OPTSTRING, (s), (l), (v), (a) , (h) }
1173 #define OPT_LIST( s, l, v, a, h) { OPTION_LIST , (s), (l), (v), (a) , (h) }
1174 
1175 #define OPT__VERBOSE(v) OPT_BOOL('v', "verbose", (v), _("Be verbose"))
1176 #define OPT__DUMP_DIR(v) OPT_STRING('d', "problem-dir", (v), "DIR", _("Problem directory"))
1177 
1178 #define parse_opts libreport_parse_opts
1179 unsigned parse_opts(int argc, char **argv, const struct options *opt,
1180  const char *usage);
1181 
1182 #define show_usage_and_die libreport_show_usage_and_die
1183 void show_usage_and_die(const char *usage, const struct options *opt) NORETURN;
1184 
1185 /* Can't include "abrt_curl.h", it's not a public API.
1186  * Resorting to just forward-declaring the struct we need.
1187  */
1188 struct abrt_post_state;
1189 
1190 /* Decomposes uri to its base elements, removes userinfo out of the hostname and
1191  * composes a new uri without userinfo.
1192  *
1193  * The function does not validate the url.
1194  *
1195  * @param uri The uri that might contain userinfo
1196  * @param result The userinfo free uri will be store here. Cannot be null. Must
1197  * be de-allocated by free.
1198  * @param scheme Scheme of the uri. Can be NULL. Result can be NULL. Result
1199  * must be de-allocated by free.
1200  * @param hostname Hostname of the uri. Can be NULL. Result can be NULL. Result
1201  * must be de-allocated by free.
1202  * @param username Username of the uri. Can be NULL. Result can be NULL. Result
1203  * must be de-allocated by free.
1204  * @param password Password of the uri. Can be NULL. Result can be NULL. Result
1205  * must be de-allocated by free.
1206  * @param location Location of the uri. Can be NULL. Result is never NULL. Result
1207  * must be de-allocated by free.
1208  */
1209 #define uri_userinfo_remove libreport_uri_userinfo_remove
1210 int uri_userinfo_remove(const char *uri, char **result, char **scheme, char **hostname, char **username, char **password, char **location);
1211 
1212 #ifdef __cplusplus
1213 }
1214 #endif
1215 
1216 #endif