libreport  2.1.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 <sys/poll.h>
37 #include <sys/mman.h>
38 #include <sys/socket.h>
39 #include <sys/stat.h>
40 #include <sys/time.h>
41 #include <sys/types.h>
42 #include <sys/wait.h>
43 #include <arpa/inet.h> /* sockaddr_in, sockaddr_in6 etc */
44 #include <termios.h>
45 #include <time.h>
46 #include <unistd.h>
47 #include <stdbool.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) gettext(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 
89 /* Pull in entire public libreport API */
90 #include "dump_dir.h"
91 #include "event_config.h"
92 #include "problem_data.h"
93 #include "report.h"
94 #include "run_event.h"
95 #include "workflow.h"
96 #include "file_obj.h"
97 #include "libreport_types.h"
98 
99 #ifdef __cplusplus
100 extern "C" {
101 #endif
102 
103 #define prefixcmp libreport_prefixcmp
104 int prefixcmp(const char *str, const char *prefix);
105 #define suffixcmp libreport_suffixcmp
106 int suffixcmp(const char *str, const char *suffix);
107 #define strtrim libreport_strtrim
108 char *strtrim(char *str);
109 #define strtrimch libreport_strtrimch
110 char *strtrimch(char *str, int ch);
111 #define append_to_malloced_string libreport_append_to_malloced_string
112 char *append_to_malloced_string(char *mstr, const char *append);
113 #define skip_whitespace libreport_skip_whitespace
114 char* skip_whitespace(const char *s);
115 #define skip_non_whitespace libreport_skip_non_whitespace
116 char* skip_non_whitespace(const char *s);
117 /* Like strcpy but can copy overlapping strings. */
118 #define overlapping_strcpy libreport_overlapping_strcpy
119 void overlapping_strcpy(char *dst, const char *src);
120 
121 #define concat_path_file libreport_concat_path_file
122 char *concat_path_file(const char *path, const char *filename);
123 /*
124  * Used to construct a name in a different directory with the basename
125  * similar to the old name, if possible.
126  */
127 #define concat_path_basename libreport_concat_path_basename
128 char *concat_path_basename(const char *path, const char *filename);
129 
130 /* A-la fgets, but malloced and of unlimited size */
131 #define xmalloc_fgets libreport_xmalloc_fgets
132 char *xmalloc_fgets(FILE *file);
133 /* Similar, but removes trailing \n */
134 #define xmalloc_fgetline libreport_xmalloc_fgetline
135 char *xmalloc_fgetline(FILE *file);
136 /* Useful for easy reading of various /proc files */
137 #define xmalloc_fopen_fgetline_fclose libreport_xmalloc_fopen_fgetline_fclose
138 char *xmalloc_fopen_fgetline_fclose(const char *filename);
139 
140 
141 /* On error, copyfd_XX prints error messages and returns -1 */
142 enum {
143  COPYFD_SPARSE = 1 << 0,
144 };
145 #define copyfd_eof libreport_copyfd_eof
146 off_t copyfd_eof(int src_fd, int dst_fd, int flags);
147 #define copyfd_size libreport_copyfd_size
148 off_t copyfd_size(int src_fd, int dst_fd, off_t size, int flags);
149 #define copyfd_exact_size libreport_copyfd_exact_size
150 void copyfd_exact_size(int src_fd, int dst_fd, off_t size);
151 #define copy_file libreport_copy_file
152 off_t copy_file(const char *src_name, const char *dst_name, int mode);
153 #define copy_file_recursive libreport_copy_file_recursive
154 int copy_file_recursive(const char *source, const char *dest);
155 
156 // NB: will return short read on error, not -1,
157 // if some data was read before error occurred
158 #define xread libreport_xread
159 void xread(int fd, void *buf, size_t count);
160 #define safe_read libreport_safe_read
161 ssize_t safe_read(int fd, void *buf, size_t count);
162 #define safe_write libreport_safe_write
163 ssize_t safe_write(int fd, const void *buf, size_t count);
164 #define full_read libreport_full_read
165 ssize_t full_read(int fd, void *buf, size_t count);
166 #define full_write libreport_full_write
167 ssize_t full_write(int fd, const void *buf, size_t count);
168 #define full_write_str libreport_full_write_str
169 ssize_t full_write_str(int fd, const char *buf);
170 #define xmalloc_read libreport_xmalloc_read
171 void* xmalloc_read(int fd, size_t *maxsz_p);
172 #define xmalloc_open_read_close libreport_xmalloc_open_read_close
173 void* xmalloc_open_read_close(const char *filename, size_t *maxsz_p);
174 #define xmalloc_xopen_read_close libreport_xmalloc_xopen_read_close
175 void* xmalloc_xopen_read_close(const char *filename, size_t *maxsz_p);
176 
177 
178 /* Returns malloc'ed block */
179 #define encode_base64 libreport_encode_base64
180 char *encode_base64(const void *src, int length);
181 
182 /* Returns NULL if the string needs no sanitizing.
183  * control_chars_to_sanitize is a bit mask.
184  * If Nth bit is set, Nth control char will be sanitized (replaced by [XX]).
185  */
186 #define sanitize_utf8 libreport_sanitize_utf8
187 char *sanitize_utf8(const char *src, uint32_t control_chars_to_sanitize);
188 enum {
189  SANITIZE_ALL = 0xffffffff,
190  SANITIZE_TAB = (1 << 9),
191  SANITIZE_LF = (1 << 10),
192  SANITIZE_CR = (1 << 13),
193 };
194 
195 #define SHA1_RESULT_LEN (5 * 4)
196 typedef struct sha1_ctx_t {
197  uint8_t wbuffer[64]; /* always correctly aligned for uint64_t */
198  /* for sha256: void (*process_block)(struct md5_ctx_t*); */
199  uint64_t total64; /* must be directly before hash[] */
200  uint32_t hash[8]; /* 4 elements for md5, 5 for sha1, 8 for sha256 */
201 } sha1_ctx_t;
202 #define sha1_begin libreport_sha1_begin
203 void sha1_begin(sha1_ctx_t *ctx);
204 #define sha1_hash libreport_sha1_hash
205 void sha1_hash(sha1_ctx_t *ctx, const void *buffer, size_t len);
206 #define sha1_end libreport_sha1_end
207 void sha1_end(sha1_ctx_t *ctx, void *resbuf);
208 
209 
210 #define xatou libreport_xatou
211 unsigned xatou(const char *numstr);
212 #define xatoi libreport_xatoi
213 int xatoi(const char *numstr);
214 /* Using xatoi() instead of naive atoi() is not always convenient -
215  * in many places people want *non-negative* values, but store them
216  * in signed int. Therefore we need this one:
217  * dies if input is not in [0, INT_MAX] range. Also will reject '-0' etc.
218  * It should really be named xatoi_nonnegative (since it allows 0),
219  * but that would be too long.
220  */
221 #define xatoi_positive libreport_xatoi_positive
222 int xatoi_positive(const char *numstr);
223 
224 //unused for now
225 //unsigned long long monotonic_ns(void);
226 //unsigned long long monotonic_us(void);
227 //unsigned monotonic_sec(void);
228 
229 #define safe_waitpid libreport_safe_waitpid
230 pid_t safe_waitpid(pid_t pid, int *wstat, int options);
231 
232 enum {
233  /* on return, pipefds[1] is fd to which parent may write
234  * and deliver data to child's stdin: */
235  EXECFLG_INPUT = 1 << 0,
236  /* on return, pipefds[0] is fd from which parent may read
237  * child's stdout: */
238  EXECFLG_OUTPUT = 1 << 1,
239  /* open child's stdin to /dev/null: */
240  EXECFLG_INPUT_NUL = 1 << 2,
241  /* open child's stdout to /dev/null: */
242  EXECFLG_OUTPUT_NUL = 1 << 3,
243  /* redirect child's stderr to stdout: */
244  EXECFLG_ERR2OUT = 1 << 4,
245  /* open child's stderr to /dev/null: */
246  EXECFLG_ERR_NUL = 1 << 5,
247  /* suppress perror_msg("Can't execute 'foo'") if exec fails */
248  EXECFLG_QUIET = 1 << 6,
249  EXECFLG_SETGUID = 1 << 7,
250  EXECFLG_SETSID = 1 << 8,
251  EXECFLG_SETPGID = 1 << 9,
252 };
253 /*
254  * env_vec: list of variables to set in environment (if string has
255  * "VAR=VAL" form) or unset in environment (if string has no '=' char).
256  *
257  * Returns pid.
258  */
259 #define fork_execv_on_steroids libreport_fork_execv_on_steroids
260 pid_t fork_execv_on_steroids(int flags,
261  char **argv,
262  int *pipefds,
263  char **env_vec,
264  const char *dir,
265  uid_t uid);
266 /* Returns malloc'ed string. NULs are retained, and extra one is appended
267  * after the last byte (this NUL is not accounted for in *size_p) */
268 #define run_in_shell_and_save_output libreport_run_in_shell_and_save_output
269 char *run_in_shell_and_save_output(int flags,
270  const char *cmd,
271  const char *dir,
272  size_t *size_p);
273 
274 /* Random utility functions */
275 
276 #define is_in_string_list libreport_is_in_string_list
277 bool is_in_string_list(const char *name, char **v);
278 
279 #define is_in_comma_separated_list libreport_is_in_comma_separated_list
280 bool is_in_comma_separated_list(const char *value, const char *list);
281 #define is_in_comma_separated_list_of_glob_patterns libreport_is_in_comma_separated_list_of_glob_patterns
282 bool is_in_comma_separated_list_of_glob_patterns(const char *value, const char *list);
283 
284 /* Frees every element'd data using free(),
285  * then frees list itself using g_list_free(list):
286  */
287 #define list_free_with_free libreport_list_free_with_free
288 void list_free_with_free(GList *list);
289 
290 #define get_dirsize libreport_get_dirsize
291 double get_dirsize(const char *pPath);
292 #define get_dirsize_find_largest_dir libreport_get_dirsize_find_largest_dir
293 double get_dirsize_find_largest_dir(
294  const char *pPath,
295  char **worst_dir, /* can be NULL */
296  const char *excluded /* can be NULL */
297 );
298 
299 #define ndelay_on libreport_ndelay_on
300 int ndelay_on(int fd);
301 #define ndelay_off libreport_ndelay_off
302 int ndelay_off(int fd);
303 #define close_on_exec_on libreport_close_on_exec_on
304 int close_on_exec_on(int fd);
305 
306 #define xmalloc libreport_xmalloc
307 void* xmalloc(size_t size);
308 #define xrealloc libreport_xrealloc
309 void* xrealloc(void *ptr, size_t size);
310 #define xzalloc libreport_xzalloc
311 void* xzalloc(size_t size);
312 #define xstrdup libreport_xstrdup
313 char* xstrdup(const char *s);
314 #define xstrndup libreport_xstrndup
315 char* xstrndup(const char *s, int n);
316 
317 #define xpipe libreport_xpipe
318 void xpipe(int filedes[2]);
319 #define xdup libreport_xdup
320 int xdup(int from);
321 #define xdup2 libreport_xdup2
322 void xdup2(int from, int to);
323 #define xmove_fd libreport_xmove_fd
324 void xmove_fd(int from, int to);
325 
326 #define xwrite libreport_xwrite
327 void xwrite(int fd, const void *buf, size_t count);
328 #define xwrite_str libreport_xwrite_str
329 void xwrite_str(int fd, const char *str);
330 
331 #define xlseek libreport_xlseek
332 off_t xlseek(int fd, off_t offset, int whence);
333 
334 #define xchdir libreport_xchdir
335 void xchdir(const char *path);
336 
337 #define xvasprintf libreport_xvasprintf
338 char* xvasprintf(const char *format, va_list p);
339 #define xasprintf libreport_xasprintf
340 char* xasprintf(const char *format, ...);
341 
342 #define xsetenv libreport_xsetenv
343 void xsetenv(const char *key, const char *value);
344 /*
345  * Utility function to unsetenv a string which was possibly putenv'ed.
346  * The problem here is that "natural" optimization:
347  * strchrnul(var_val, '=')[0] = '\0';
348  * unsetenv(var_val);
349  * is BUGGY: if string was put into environment via putenv,
350  * its modification (s/=/NUL/) is illegal, and unsetenv will fail to unset it.
351  * Of course, saving/restoring the char wouldn't work either.
352  * This helper creates a copy up to '=', unsetenv's it, and frees:
353  */
354 #define safe_unsetenv libreport_safe_unsetenv
355 void safe_unsetenv(const char *var_val);
356 
357 #define xsocket libreport_xsocket
358 int xsocket(int domain, int type, int protocol);
359 #define xbind libreport_xbind
360 void xbind(int sockfd, struct sockaddr *my_addr, socklen_t addrlen);
361 #define xlisten libreport_xlisten
362 void xlisten(int s, int backlog);
363 #define xsendto libreport_xsendto
364 ssize_t xsendto(int s, const void *buf, size_t len,
365  const struct sockaddr *to, socklen_t tolen);
366 
367 #define xstat libreport_xstat
368 void xstat(const char *name, struct stat *stat_buf);
369 #define fstat_st_size_or_die libreport_fstat_st_size_or_die
370 off_t fstat_st_size_or_die(int fd);
371 #define stat_st_size_or_die libreport_stat_st_size_or_die
372 off_t stat_st_size_or_die(const char *filename);
373 
374 #define xopen3 libreport_xopen3
375 int xopen3(const char *pathname, int flags, int mode);
376 #define xopen libreport_xopen
377 int xopen(const char *pathname, int flags);
378 #define xunlink libreport_xunlink
379 void xunlink(const char *pathname);
380 
381 /* Just testing dent->d_type == DT_REG is wrong: some filesystems
382  * do not report the type, they report DT_UNKNOWN for every dirent
383  * (and this is not a bug in filesystem, this is allowed by standards).
384  * This function handles this case. Note: it returns 0 on symlinks
385  * even if they point to regular files.
386  */
387 #define is_regular_file libreport_is_regular_file
388 int is_regular_file(struct dirent *dent, const char *dirname);
389 
390 #define dot_or_dotdot libreport_dot_or_dotdot
391 bool dot_or_dotdot(const char *filename);
392 #define last_char_is libreport_last_char_is
393 char *last_char_is(const char *s, int c);
394 
395 #define string_to_bool libreport_string_to_bool
396 bool string_to_bool(const char *s);
397 
398 #define xseteuid libreport_xseteuid
399 void xseteuid(uid_t euid);
400 #define xsetegid libreport_xsetegid
401 void xsetegid(gid_t egid);
402 #define xsetreuid libreport_xsetreuid
403 void xsetreuid(uid_t ruid, uid_t euid);
404 #define xsetregid libreport_xsetregid
405 void xsetregid(gid_t rgid, gid_t egid);
406 
407 
408 /* Emit a string of hex representation of bytes */
409 #define bin2hex libreport_bin2hex
410 char* bin2hex(char *dst, const char *str, int count);
411 /* Convert "xxxxxxxx" hex string to binary, no more than COUNT bytes */
412 #define hex2bin libreport_hex2bin
413 char* hex2bin(char *dst, const char *str, int count);
414 
415 
416 enum {
417  LOGMODE_NONE = 0,
418  LOGMODE_STDIO = (1 << 0),
419  LOGMODE_SYSLOG = (1 << 1),
420  LOGMODE_BOTH = LOGMODE_SYSLOG + LOGMODE_STDIO,
421  LOGMODE_CUSTOM = (1 << 2),
422 };
423 
424 #define g_custom_logger libreport_g_custom_logger
425 extern void (*g_custom_logger)(const char*);
426 #define msg_prefix libreport_msg_prefix
427 extern const char *msg_prefix;
428 #define msg_eol libreport_msg_eol
429 extern const char *msg_eol;
430 #define logmode libreport_logmode
431 extern int logmode;
432 #define xfunc_error_retval libreport_xfunc_error_retval
433 extern int xfunc_error_retval;
434 
435 /* A few magic exit codes */
436 #define EXIT_CANCEL_BY_USER 69
437 #define EXIT_STOP_EVENT_RUN 70
438 
439 #define set_xfunc_error_retval libreport_set_xfunc_error_retval
440 void set_xfunc_error_retval(int retval);
441 
442 /* Verbosity level */
443 #define g_verbose libreport_g_verbose
444 extern int g_verbose;
445 /* VERB1 log("what you sometimes want to see, even on a production box") */
446 #define VERB1 if (g_verbose >= 1)
447 /* VERB2 log("debug message, not going into insanely small details") */
448 #define VERB2 if (g_verbose >= 2)
449 /* VERB3 log("lots and lots of details") */
450 #define VERB3 if (g_verbose >= 3)
451 /* there is no level > 3 */
452 
453 #define libreport_
454 #define xfunc_die libreport_xfunc_die
455 void xfunc_die(void) NORETURN;
456 #define log_msg libreport_log_msg
457 void log_msg(const char *s, ...) __attribute__ ((format (printf, 1, 2)));
458 /* It's a macro, not function, since it collides with log() from math.h */
459 #undef log
460 #define log(...) log_msg(__VA_ARGS__)
461 /* error_msg family will use g_custom_logger. log_msg does not. */
462 #define error_msg libreport_error_msg
463 void error_msg(const char *s, ...) __attribute__ ((format (printf, 1, 2)));
464 #define error_msg_and_die libreport_error_msg_and_die
465 void error_msg_and_die(const char *s, ...) __attribute__ ((noreturn, format (printf, 1, 2)));
466 /* Reports error message with libc's errno error description attached. */
467 #define perror_msg libreport_perror_msg
468 void perror_msg(const char *s, ...) __attribute__ ((format (printf, 1, 2)));
469 #define perror_msg_and_die libreport_perror_msg_and_die
470 void perror_msg_and_die(const char *s, ...) __attribute__ ((noreturn, format (printf, 1, 2)));
471 #define die_out_of_memory libreport_die_out_of_memory
472 void die_out_of_memory(void) NORETURN;
473 
474 
475 struct strbuf
476 {
477  /* Size of the allocated buffer. Always > 0. */
478  int alloc;
479  /* Length of the string, without the ending \0. */
480  int len;
481  char *buf;
482 };
483 
490 #define strbuf_new libreport_strbuf_new
491 struct strbuf *strbuf_new(void);
492 
498 #define strbuf_free libreport_strbuf_free
499 void strbuf_free(struct strbuf *strbuf);
500 
506 #define strbuf_free_nobuf libreport_strbuf_free_nobuf
507 char* strbuf_free_nobuf(struct strbuf *strbuf);
508 
513 #define strbuf_clear libreport_strbuf_clear
514 void strbuf_clear(struct strbuf *strbuf);
515 
520 #define strbuf_append_char libreport_strbuf_append_char
521 struct strbuf *strbuf_append_char(struct strbuf *strbuf, char c);
522 
527 #define strbuf_append_str libreport_strbuf_append_str
528 struct strbuf *strbuf_append_str(struct strbuf *strbuf,
529  const char *str);
530 
535 #define strbuf_prepend_str libreport_strbuf_prepend_str
536 struct strbuf *strbuf_prepend_str(struct strbuf *strbuf,
537  const char *str);
538 
543 #define strbuf_append_strf libreport_strbuf_append_strf
544 struct strbuf *strbuf_append_strf(struct strbuf *strbuf,
545  const char *format, ...);
546 
551 #define strbuf_append_strfv libreport_strbuf_append_strfv
552 struct strbuf *strbuf_append_strfv(struct strbuf *strbuf,
553  const char *format, va_list p);
554 
560 #define strbuf_prepend_strf libreport_strbuf_prepend_strf
561 struct strbuf *strbuf_prepend_strf(struct strbuf *strbuf,
562  const char *format, ...);
563 
568 #define strbuf_prepend_strfv libreport_strbuf_prepend_strfv
569 struct strbuf *strbuf_prepend_strfv(struct strbuf *strbuf,
570  const char *format, va_list p);
571 
572 /* Returns command line of running program.
573  * Caller is responsible to free() the returned value.
574  * If the pid is not valid or command line can not be obtained,
575  * empty string is returned.
576  */
577 #define get_cmdline libreport_get_cmdline
578 char* get_cmdline(pid_t pid);
579 #define get_environ libreport_get_environ
580 char* get_environ(pid_t pid);
581 
582 /* Takes ptr to time_t, or NULL if you want to use current time.
583  * Returns "YYYY-MM-DD-hh:mm:ss" string.
584  */
585 #define iso_date_string libreport_iso_date_string
586 char *iso_date_string(const time_t *pt);
587 #define LIBREPORT_ISO_DATE_STRING_SAMPLE "YYYY-MM-DD-hh:mm:ss"
588 
589 enum {
590  MAKEDESC_SHOW_FILES = (1 << 0),
591  MAKEDESC_SHOW_MULTILINE = (1 << 1),
592  MAKEDESC_SHOW_ONLY_LIST = (1 << 2),
593  MAKEDESC_WHITELIST = (1 << 3),
594 };
595 #define make_description libreport_make_description
596 char *make_description(problem_data_t *problem_data, char **names_to_skip, unsigned max_text_size, unsigned desc_flags);
597 #define make_description_bz libreport_make_description_bz
598 char* make_description_bz(problem_data_t *problem_data, unsigned max_text_size);
599 #define make_description_logger libreport_make_description_logger
600 char* make_description_logger(problem_data_t *problem_data, unsigned max_text_size);
601 //UNUSED
602 //#define make_description_mailx libreport_make_description_mailx
603 //char* make_description_mailx(problem_data_t *problem_data);
604 
605 /* See man os-release(5) for details */
606 #define OSINFO_ID "ID"
607 #define OSINFO_NAME "NAME"
608 #define OSINFO_VERSION_ID "VERSION_ID"
609 #define OSINFO_PRETTY_NAME "PRETTY_NAME"
610 
611 /* @brief Loads a text in format of os-release(5) in to a map
612  *
613  * Function doesn't check for format errors much. It just tries to avoid
614  * program errors. In case of error the function prints out a log message and
615  * continues in parsing.
616  *
617  * @param osinfo_bytes Non-NULL pointer to osinfo bytes.
618  * @param osinfo The map where result is stored
619  */
620 #define parse_osinfo libreport_parse_osinfo
621 void parse_osinfo(const char *osinfo_bytes, map_string_t *osinfo);
622 
623 /* @brief Builds product string and product's version string for Bugzilla
624  *
625  * At first tries to get strings from the os specific variables
626  * (REDHAT_BUGZILLA_PRODUCT, REDHAT_BUGZILLA_PRODUCT_VERSION) if no such
627  * variables are found, uses NAME key for the product and VERSION_ID key for
628  * the product's version. If neither NAME nor VERSION_ID are provided fallbacks
629  * to parsing of os_release which should be stored under PRETTY_NAME key.
630  *
631  * https://bugzilla.redhat.com/show_bug.cgi?id=950373
632  *
633  * @param osinfo Input data from which the values are built
634  * @param produc Non-NULL pointer where pointer to malloced string will be stored. Memory must be released by free()
635  * @param version Non-NULL pointer where pointer to malloced string will be stored. Memory must be released by free()
636  */
637 #define parse_osinfo_for_bz libreport_parse_osinfo_for_bz
638 void parse_osinfo_for_bz(map_string_t *osinfo, char **product, char **version);
639 
640 /* @brief Builds product string and product's version string for Red Hat Support
641  *
642  * At first tries to get strings from the os specific variables
643  * (REDHAT_SUPPORT_PRODUCT, REDHAT_SUPPORT_PRODUCT_VERSION) if no such
644  * variables are found, uses NAME key for the product and VERSION_ID key for
645  * the product's version. If no NAME nor VERSION_ID are provided fallbacks to
646  * parsing of os_release which should be stored under PRETTY_NAME key.
647  *
648  * https://bugzilla.redhat.com/show_bug.cgi?id=950373
649  *
650  * @param osinfo Input data from which the values are built
651  * @param produc Non-NULL pointer where pointer to malloced string will be stored. Memory must be released by free()
652  * @param version Non-NULL pointer where pointer to malloced string will be stored. Memory must be released by free()
653  */
654 #define parse_osinfo_for_rhts libreport_parse_osinfo_for_rhts
655 void parse_osinfo_for_rhts(map_string_t *osinfo, char **product, char **version);
656 
657 #define parse_release_for_bz libreport_parse_release_for_bz
658 void parse_release_for_bz(const char *pRelease, char **product, char **version);
659 #define parse_release_for_rhts libreport_parse_release_for_rhts
660 void parse_release_for_rhts(const char *pRelease, char **product, char **version);
661 
676 #define load_conf_file libreport_load_conf_file
677 bool load_conf_file(const char *pPath, map_string_t *settings, bool skipKeysWithoutValue);
678 
679 #define save_conf_file libreport_save_conf_file
680 bool save_conf_file(const char *path, map_string_t *settings);
681 #define save_user_settings libreport_save_user_settings
682 bool save_user_settings();
683 #define load_user_settings libreport_load_user_settings
684 bool load_user_settings(const char *application_name);
685 #define set_user_setting libreport_set_user_setting
686 void set_user_setting(const char *name, const char *value);
687 #define get_user_setting libreport_get_user_setting
688 const char *get_user_setting(const char *name);
689 #define load_forbidden_words libreport_load_forbidden_words
690 GList *load_forbidden_words();
691 #define get_file_list libreport_get_file_list
692 GList *get_file_list(const char *path, const char *ext);
693 #define free_file_list libreport_free_file_list
694 void free_file_list(GList *filelist);
695 #define new_file_obj libreport_new_file_obj
696 file_obj_t *new_file_obj(const char* fullpath, const char* filename);
697 #define free_file_obj libreport_free_file_obj
698 void free_file_obj(file_obj_t *f);
699 #define load_workflow_config_data libreport_load_workflow_config_data
700 GHashTable *load_workflow_config_data(const char* path);
701 
702 /* Connect to abrtd over unix domain socket, issue DELETE command */
703 int delete_dump_dir_possibly_using_abrtd(const char *dump_dir_name);
704 
705 /* Tries to create a copy of dump_dir_name in base_dir, with same or similar basename.
706  * Returns NULL if copying failed. In this case, logs a message before returning. */
707 #define steal_directory libreport_steal_directory
708 struct dump_dir *steal_directory(const char *base_dir, const char *dump_dir_name);
709 
710 /* Tries to open dump_dir_name with writing access. If function needs to steal
711  * directory calls ask_continue(new base dir, dump dir) callback to ask user
712  * for permission. If ask_continue param is NULL the function thinks that an
713  * answer is positive and steals directory.
714  * Returns NULL if opening failed or if stealing was dismissed. In this case,
715  * logs a message before returning. */
716 #define open_directory_for_writing libreport_open_directory_for_writing
717 struct dump_dir *open_directory_for_writing(
718  const char *dump_dir_name,
719  bool (*ask_continue)(const char *, const char *));
720 
721 // Files bigger than this are never considered to be text.
722 //
723 // Started at 64k limit. But _some_ limit is necessary:
724 // fields declared "text" may end up in editing fields and such.
725 // We don't want to accidentally end up with 100meg text in a textbox!
726 // So, don't remove this. If you really need to, raise the limit.
727 //
728 // Bumped up to 200k: saw 124740 byte /proc/PID/smaps file
729 // Bumped up to 500k: saw 375252 byte anaconda traceback file
730 // Bumped up to 1M: bugzilla.redhat.com/show_bug.cgi?id=746727
731 // mentions 853646 byte anaconda-tb-* file.
732 //
733 #define CD_MAX_TEXT_SIZE (1024*1024)
734 
735 // Text bigger than this usually is attached, not added inline
736 // was 2k, 20kb is too much, let's try 4kb
737 //
738 // For bug databases
739 #define CD_TEXT_ATT_SIZE_BZ (4*1024)
740 // For dumping problem data into a text file, email, etc
741 #define CD_TEXT_ATT_SIZE_LOGGER (CD_MAX_TEXT_SIZE)
742 
743 // Filenames in problem directory:
744 // filled by a hook:
745 #define FILENAME_TIME "time" /* mandatory */
746 #define FILENAME_LAST_OCCURRENCE "last_occurrence" /* optional */
747 #define FILENAME_REASON "reason" /* mandatory? */
748 #define FILENAME_UID "uid" /* mandatory? */
749 /*
750  * "analyzer" is to be gradually changed to "type":
751  * For now, we fetch and look at "analyzer" element,
752  * but we always save both "analyzer" and "type" (with same contents).
753  * By 2013, we switch to looking at "type". Then we will stop generating
754  * "analyzer" element.
755  */
756 #define FILENAME_ANALYZER "analyzer"
757 #define FILENAME_TYPE "type"
758 #define FILENAME_EXECUTABLE "executable"
759 #define FILENAME_PID "pid"
760 #define FILENAME_PWD "pwd"
761 #define FILENAME_ROOTDIR "rootdir"
762 #define FILENAME_BINARY "binary"
763 #define FILENAME_CMDLINE "cmdline"
764 #define FILENAME_COREDUMP "coredump"
765 #define FILENAME_CGROUP "cgroup"
766 #define FILENAME_BACKTRACE "backtrace"
767 #define FILENAME_MAPS "maps"
768 #define FILENAME_SMAPS "smaps"
769 #define FILENAME_PROC_PID_STATUS "proc_pid_status"
770 #define FILENAME_ENVIRON "environ"
771 #define FILENAME_LIMITS "limits"
772 #define FILENAME_OPEN_FDS "open_fds"
773 
774 /* Global problem identifier which is usually generated by some "analyze_*"
775  * event because it may take a lot of time to obtain strong problem
776  * identification */
777 #define FILENAME_DUPHASH "duphash"
778 
779 // Name of the function where the application crashed.
780 // Optional.
781 #define FILENAME_CRASH_FUNCTION "crash_function"
782 #define FILENAME_ARCHITECTURE "architecture"
783 #define FILENAME_KERNEL "kernel"
784 /*
785  * From /etc/os-release
786  * os_release filename name is alredy occupied by /etc/redhat-release (see
787  * below) in sake of backward compatibility /etc/os-release is stored in
788  * os_info file
789  */
790 #define FILENAME_OS_INFO "os_info"
791 #define FILENAME_OS_INFO_IN_ROOTDIR "os_info_in_rootdir"
792 // From /etc/system-release or /etc/redhat-release
793 #define FILENAME_OS_RELEASE "os_release"
794 #define FILENAME_OS_RELEASE_IN_ROOTDIR "os_release_in_rootdir"
795 // Filled by <what?>
796 #define FILENAME_PACKAGE "package"
797 #define FILENAME_COMPONENT "component"
798 #define FILENAME_COMMENT "comment"
799 #define FILENAME_RATING "backtrace_rating"
800 #define FILENAME_HOSTNAME "hostname"
801 // Optional. Set to "1" by abrt-handle-upload for every unpacked dump
802 #define FILENAME_REMOTE "remote"
803 #define FILENAME_TAINTED "kernel_tainted"
804 #define FILENAME_TAINTED_SHORT "kernel_tainted_short"
805 #define FILENAME_TAINTED_LONG "kernel_tainted_long"
806 #define FILENAME_VMCORE "vmcore"
807 #define FILENAME_KERNEL_LOG "kernel_log"
808 // File created by createAlertSignature() from libreport's python module
809 // The file should contain a description of an alert
810 #define FILENAME_DESCRIPTION "description"
811 
812 /* Local problem identifier (weaker than global identifier) designed for fast
813  * local for fast local duplicate identification. This file is usually provided
814  * by crashed application (problem creator).
815  */
816 #define FILENAME_UUID "uuid"
817 
818 #define FILENAME_COUNT "count"
819 /* Multi-line list of places problem was reported.
820  * Recommended line format:
821  * "Reporter: VAR=VAL VAR=VAL"
822  * Use add_reported_to(dd, "line_without_newline"): it adds line
823  * only if it is not already there.
824  */
825 #define FILENAME_REPORTED_TO "reported_to"
826 #define FILENAME_EVENT_LOG "event_log"
827 /*
828  * If exists, should contain a full sentence (with trailing period)
829  * which describes why this problem should not be reported.
830  * Example: "Your laptop firmware 1.9a is buggy, version 1.10 contains the fix."
831  */
832 #define FILENAME_NOT_REPORTABLE "not-reportable"
833 #define FILENAME_CORE_BACKTRACE "core_backtrace"
834 #define FILENAME_REMOTE_RESULT "remote_result"
835 #define FILENAME_PKG_EPOCH "pkg_epoch"
836 #define FILENAME_PKG_NAME "pkg_name"
837 #define FILENAME_PKG_VERSION "pkg_version"
838 #define FILENAME_PKG_RELEASE "pkg_release"
839 #define FILENAME_PKG_ARCH "pkg_arch"
840 #define FILENAME_USERNAME "username"
841 #define FILENAME_ABRT_VERSION "abrt_version"
842 
843 // Not stored as files, added "on the fly":
844 #define CD_DUMPDIR "Directory"
845 
846 #define cmp_problem_data libreport_cmp_problem_data
847 gint cmp_problem_data(gconstpointer a, gconstpointer b, gpointer filename);
848 
849 //UNUSED:
852 //#define CD_EVENTS "Events"
853 
854 /* FILENAME_EVENT_LOG is trimmed to below LOW_WATERMARK
855  * when it reaches HIGH_WATERMARK size
856  */
857 enum {
858  EVENT_LOG_HIGH_WATERMARK = 30 * 1024,
859  EVENT_LOG_LOW_WATERMARK = 20 * 1024,
860 };
861 
862 #define log_problem_data libreport_log_problem_data
863 void log_problem_data(problem_data_t *problem_data, const char *pfx);
864 
865 
866 const char *abrt_init(char **argv);
867 #define export_abrt_envvars libreport_export_abrt_envvars
868 void export_abrt_envvars(int pfx);
869 #define g_progname libreport_g_progname
870 extern const char *g_progname;
871 
872 enum parse_opt_type {
873  OPTION_BOOL,
874  OPTION_GROUP,
875  OPTION_STRING,
876  OPTION_INTEGER,
877  OPTION_OPTSTRING,
878  OPTION_LIST,
879  OPTION_END,
880 };
881 
882 struct options {
883  enum parse_opt_type type;
884  int short_name;
885  const char *long_name;
886  void *value;
887  const char *argh;
888  const char *help;
889 };
890 
891 /*
892  * s - short_name
893  * l - long_name
894  * v - value
895  * a - option parameter name (for help text)
896  * h - help
897  */
898 #define OPT_END() { OPTION_END }
899 #define OPT_GROUP(h) { OPTION_GROUP, 0, NULL, NULL, NULL, (h) }
900 #define OPT_BOOL( s, l, v, h) { OPTION_BOOL , (s), (l), (v), NULL , (h) }
901 #define OPT_INTEGER( s, l, v, h) { OPTION_INTEGER , (s), (l), (v), "NUM", (h) }
902 #define OPT_STRING( s, l, v, a, h) { OPTION_STRING , (s), (l), (v), (a) , (h) }
903 #define OPT_OPTSTRING(s, l, v, a, h) { OPTION_OPTSTRING, (s), (l), (v), (a) , (h) }
904 #define OPT_LIST( s, l, v, a, h) { OPTION_LIST , (s), (l), (v), (a) , (h) }
905 
906 #define OPT__VERBOSE(v) OPT_BOOL('v', "verbose", (v), _("Be verbose"))
907 #define OPT__DUMP_DIR(v) OPT_STRING('d', "problem-dir", (v), "DIR", _("Problem directory"))
908 
909 #define parse_opts libreport_parse_opts
910 unsigned parse_opts(int argc, char **argv, const struct options *opt,
911  const char *usage);
912 
913 #define show_usage_and_die libreport_show_usage_and_die
914 void show_usage_and_die(const char *usage, const struct options *opt) NORETURN;
915 
916 /* Can't include "abrt_curl.h", it's not a public API.
917  * Resorting to just forward-declaring the struct we need.
918  */
919 struct abrt_post_state;
920 
921 #ifdef __cplusplus
922 }
923 #endif
924 
925 #endif