libreport  2.1.6
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 /* Calls GLib version appropriate initialization function.
285  */
286 #define glib_init libreport_glib_init
287 void glib_init(void);
288 
289 /* Frees every element'd data using free(),
290  * then frees list itself using g_list_free(list):
291  */
292 #define list_free_with_free libreport_list_free_with_free
293 void list_free_with_free(GList *list);
294 
295 #define get_dirsize libreport_get_dirsize
296 double get_dirsize(const char *pPath);
297 #define get_dirsize_find_largest_dir libreport_get_dirsize_find_largest_dir
298 double get_dirsize_find_largest_dir(
299  const char *pPath,
300  char **worst_dir, /* can be NULL */
301  const char *excluded /* can be NULL */
302 );
303 
304 #define ndelay_on libreport_ndelay_on
305 int ndelay_on(int fd);
306 #define ndelay_off libreport_ndelay_off
307 int ndelay_off(int fd);
308 #define close_on_exec_on libreport_close_on_exec_on
309 int close_on_exec_on(int fd);
310 
311 #define xmalloc libreport_xmalloc
312 void* xmalloc(size_t size);
313 #define xrealloc libreport_xrealloc
314 void* xrealloc(void *ptr, size_t size);
315 #define xzalloc libreport_xzalloc
316 void* xzalloc(size_t size);
317 #define xstrdup libreport_xstrdup
318 char* xstrdup(const char *s);
319 #define xstrndup libreport_xstrndup
320 char* xstrndup(const char *s, int n);
321 
322 #define xpipe libreport_xpipe
323 void xpipe(int filedes[2]);
324 #define xdup libreport_xdup
325 int xdup(int from);
326 #define xdup2 libreport_xdup2
327 void xdup2(int from, int to);
328 #define xmove_fd libreport_xmove_fd
329 void xmove_fd(int from, int to);
330 
331 #define xwrite libreport_xwrite
332 void xwrite(int fd, const void *buf, size_t count);
333 #define xwrite_str libreport_xwrite_str
334 void xwrite_str(int fd, const char *str);
335 
336 #define xlseek libreport_xlseek
337 off_t xlseek(int fd, off_t offset, int whence);
338 
339 #define xchdir libreport_xchdir
340 void xchdir(const char *path);
341 
342 #define xvasprintf libreport_xvasprintf
343 char* xvasprintf(const char *format, va_list p);
344 #define xasprintf libreport_xasprintf
345 char* xasprintf(const char *format, ...);
346 
347 #define xsetenv libreport_xsetenv
348 void xsetenv(const char *key, const char *value);
349 /*
350  * Utility function to unsetenv a string which was possibly putenv'ed.
351  * The problem here is that "natural" optimization:
352  * strchrnul(var_val, '=')[0] = '\0';
353  * unsetenv(var_val);
354  * is BUGGY: if string was put into environment via putenv,
355  * its modification (s/=/NUL/) is illegal, and unsetenv will fail to unset it.
356  * Of course, saving/restoring the char wouldn't work either.
357  * This helper creates a copy up to '=', unsetenv's it, and frees:
358  */
359 #define safe_unsetenv libreport_safe_unsetenv
360 void safe_unsetenv(const char *var_val);
361 
362 #define xsocket libreport_xsocket
363 int xsocket(int domain, int type, int protocol);
364 #define xbind libreport_xbind
365 void xbind(int sockfd, struct sockaddr *my_addr, socklen_t addrlen);
366 #define xlisten libreport_xlisten
367 void xlisten(int s, int backlog);
368 #define xsendto libreport_xsendto
369 ssize_t xsendto(int s, const void *buf, size_t len,
370  const struct sockaddr *to, socklen_t tolen);
371 
372 #define xstat libreport_xstat
373 void xstat(const char *name, struct stat *stat_buf);
374 #define fstat_st_size_or_die libreport_fstat_st_size_or_die
375 off_t fstat_st_size_or_die(int fd);
376 #define stat_st_size_or_die libreport_stat_st_size_or_die
377 off_t stat_st_size_or_die(const char *filename);
378 
379 #define xopen3 libreport_xopen3
380 int xopen3(const char *pathname, int flags, int mode);
381 #define xopen libreport_xopen
382 int xopen(const char *pathname, int flags);
383 #define xunlink libreport_xunlink
384 void xunlink(const char *pathname);
385 
386 /* Just testing dent->d_type == DT_REG is wrong: some filesystems
387  * do not report the type, they report DT_UNKNOWN for every dirent
388  * (and this is not a bug in filesystem, this is allowed by standards).
389  * This function handles this case. Note: it returns 0 on symlinks
390  * even if they point to regular files.
391  */
392 #define is_regular_file libreport_is_regular_file
393 int is_regular_file(struct dirent *dent, const char *dirname);
394 
395 #define dot_or_dotdot libreport_dot_or_dotdot
396 bool dot_or_dotdot(const char *filename);
397 #define last_char_is libreport_last_char_is
398 char *last_char_is(const char *s, int c);
399 
400 #define string_to_bool libreport_string_to_bool
401 bool string_to_bool(const char *s);
402 
403 #define xseteuid libreport_xseteuid
404 void xseteuid(uid_t euid);
405 #define xsetegid libreport_xsetegid
406 void xsetegid(gid_t egid);
407 #define xsetreuid libreport_xsetreuid
408 void xsetreuid(uid_t ruid, uid_t euid);
409 #define xsetregid libreport_xsetregid
410 void xsetregid(gid_t rgid, gid_t egid);
411 
412 
413 /* Emit a string of hex representation of bytes */
414 #define bin2hex libreport_bin2hex
415 char* bin2hex(char *dst, const char *str, int count);
416 /* Convert "xxxxxxxx" hex string to binary, no more than COUNT bytes */
417 #define hex2bin libreport_hex2bin
418 char* hex2bin(char *dst, const char *str, int count);
419 
420 
421 enum {
422  LOGMODE_NONE = 0,
423  LOGMODE_STDIO = (1 << 0),
424  LOGMODE_SYSLOG = (1 << 1),
425  LOGMODE_BOTH = LOGMODE_SYSLOG + LOGMODE_STDIO,
426  LOGMODE_CUSTOM = (1 << 2),
427 };
428 
429 #define g_custom_logger libreport_g_custom_logger
430 extern void (*g_custom_logger)(const char*);
431 #define msg_prefix libreport_msg_prefix
432 extern const char *msg_prefix;
433 #define msg_eol libreport_msg_eol
434 extern const char *msg_eol;
435 #define logmode libreport_logmode
436 extern int logmode;
437 #define xfunc_error_retval libreport_xfunc_error_retval
438 extern int xfunc_error_retval;
439 
440 /* A few magic exit codes */
441 #define EXIT_CANCEL_BY_USER 69
442 #define EXIT_STOP_EVENT_RUN 70
443 
444 #define set_xfunc_error_retval libreport_set_xfunc_error_retval
445 void set_xfunc_error_retval(int retval);
446 
447 /* Verbosity level */
448 #define g_verbose libreport_g_verbose
449 extern int g_verbose;
450 /* VERB1 log("what you sometimes want to see, even on a production box") */
451 #define VERB1 if (g_verbose >= 1)
452 /* VERB2 log("debug message, not going into insanely small details") */
453 #define VERB2 if (g_verbose >= 2)
454 /* VERB3 log("lots and lots of details") */
455 #define VERB3 if (g_verbose >= 3)
456 /* there is no level > 3 */
457 
458 #define libreport_
459 #define xfunc_die libreport_xfunc_die
460 void xfunc_die(void) NORETURN;
461 #define log_msg libreport_log_msg
462 void log_msg(const char *s, ...) __attribute__ ((format (printf, 1, 2)));
463 /* It's a macro, not function, since it collides with log() from math.h */
464 #undef log
465 #define log(...) log_msg(__VA_ARGS__)
466 /* error_msg family will use g_custom_logger. log_msg does not. */
467 #define error_msg libreport_error_msg
468 void error_msg(const char *s, ...) __attribute__ ((format (printf, 1, 2)));
469 #define error_msg_and_die libreport_error_msg_and_die
470 void error_msg_and_die(const char *s, ...) __attribute__ ((noreturn, format (printf, 1, 2)));
471 /* Reports error message with libc's errno error description attached. */
472 #define perror_msg libreport_perror_msg
473 void perror_msg(const char *s, ...) __attribute__ ((format (printf, 1, 2)));
474 #define perror_msg_and_die libreport_perror_msg_and_die
475 void perror_msg_and_die(const char *s, ...) __attribute__ ((noreturn, format (printf, 1, 2)));
476 #define die_out_of_memory libreport_die_out_of_memory
477 void die_out_of_memory(void) NORETURN;
478 
479 
480 struct strbuf
481 {
482  /* Size of the allocated buffer. Always > 0. */
483  int alloc;
484  /* Length of the string, without the ending \0. */
485  int len;
486  char *buf;
487 };
488 
495 #define strbuf_new libreport_strbuf_new
496 struct strbuf *strbuf_new(void);
497 
503 #define strbuf_free libreport_strbuf_free
504 void strbuf_free(struct strbuf *strbuf);
505 
511 #define strbuf_free_nobuf libreport_strbuf_free_nobuf
512 char* strbuf_free_nobuf(struct strbuf *strbuf);
513 
518 #define strbuf_clear libreport_strbuf_clear
519 void strbuf_clear(struct strbuf *strbuf);
520 
525 #define strbuf_append_char libreport_strbuf_append_char
526 struct strbuf *strbuf_append_char(struct strbuf *strbuf, char c);
527 
532 #define strbuf_append_str libreport_strbuf_append_str
533 struct strbuf *strbuf_append_str(struct strbuf *strbuf,
534  const char *str);
535 
540 #define strbuf_prepend_str libreport_strbuf_prepend_str
541 struct strbuf *strbuf_prepend_str(struct strbuf *strbuf,
542  const char *str);
543 
548 #define strbuf_append_strf libreport_strbuf_append_strf
549 struct strbuf *strbuf_append_strf(struct strbuf *strbuf,
550  const char *format, ...);
551 
556 #define strbuf_append_strfv libreport_strbuf_append_strfv
557 struct strbuf *strbuf_append_strfv(struct strbuf *strbuf,
558  const char *format, va_list p);
559 
565 #define strbuf_prepend_strf libreport_strbuf_prepend_strf
566 struct strbuf *strbuf_prepend_strf(struct strbuf *strbuf,
567  const char *format, ...);
568 
573 #define strbuf_prepend_strfv libreport_strbuf_prepend_strfv
574 struct strbuf *strbuf_prepend_strfv(struct strbuf *strbuf,
575  const char *format, va_list p);
576 
577 /* Returns command line of running program.
578  * Caller is responsible to free() the returned value.
579  * If the pid is not valid or command line can not be obtained,
580  * empty string is returned.
581  */
582 #define get_cmdline libreport_get_cmdline
583 char* get_cmdline(pid_t pid);
584 #define get_environ libreport_get_environ
585 char* get_environ(pid_t pid);
586 
587 /* Takes ptr to time_t, or NULL if you want to use current time.
588  * Returns "YYYY-MM-DD-hh:mm:ss" string.
589  */
590 #define iso_date_string libreport_iso_date_string
591 char *iso_date_string(const time_t *pt);
592 #define LIBREPORT_ISO_DATE_STRING_SAMPLE "YYYY-MM-DD-hh:mm:ss"
593 
594 enum {
595  MAKEDESC_SHOW_FILES = (1 << 0),
596  MAKEDESC_SHOW_MULTILINE = (1 << 1),
597  MAKEDESC_SHOW_ONLY_LIST = (1 << 2),
598  MAKEDESC_WHITELIST = (1 << 3),
599 };
600 #define make_description libreport_make_description
601 char *make_description(problem_data_t *problem_data, char **names_to_skip, unsigned max_text_size, unsigned desc_flags);
602 #define make_description_bz libreport_make_description_bz
603 char* make_description_bz(problem_data_t *problem_data, unsigned max_text_size);
604 #define make_description_logger libreport_make_description_logger
605 char* make_description_logger(problem_data_t *problem_data, unsigned max_text_size);
606 //UNUSED
607 //#define make_description_mailx libreport_make_description_mailx
608 //char* make_description_mailx(problem_data_t *problem_data);
609 
610 /* See man os-release(5) for details */
611 #define OSINFO_ID "ID"
612 #define OSINFO_NAME "NAME"
613 #define OSINFO_VERSION_ID "VERSION_ID"
614 #define OSINFO_PRETTY_NAME "PRETTY_NAME"
615 
616 /* @brief Loads a text in format of os-release(5) in to a map
617  *
618  * Function doesn't check for format errors much. It just tries to avoid
619  * program errors. In case of error the function prints out a log message and
620  * continues in parsing.
621  *
622  * @param osinfo_bytes Non-NULL pointer to osinfo bytes.
623  * @param osinfo The map where result is stored
624  */
625 #define parse_osinfo libreport_parse_osinfo
626 void parse_osinfo(const char *osinfo_bytes, map_string_t *osinfo);
627 
628 /* @brief Builds product string and product's version string for Bugzilla
629  *
630  * At first tries to get strings from the os specific variables
631  * (REDHAT_BUGZILLA_PRODUCT, REDHAT_BUGZILLA_PRODUCT_VERSION) if no such
632  * variables are found, uses NAME key for the product and VERSION_ID key for
633  * the product's version. If neither NAME nor VERSION_ID are provided fallbacks
634  * to parsing of os_release which should be stored under PRETTY_NAME key.
635  *
636  * https://bugzilla.redhat.com/show_bug.cgi?id=950373
637  *
638  * @param osinfo Input data from which the values are built
639  * @param produc Non-NULL pointer where pointer to malloced string will be stored. Memory must be released by free()
640  * @param version Non-NULL pointer where pointer to malloced string will be stored. Memory must be released by free()
641  */
642 #define parse_osinfo_for_bz libreport_parse_osinfo_for_bz
643 void parse_osinfo_for_bz(map_string_t *osinfo, char **product, char **version);
644 
645 /* @brief Builds product string and product's version string for Red Hat Support
646  *
647  * At first tries to get strings from the os specific variables
648  * (REDHAT_SUPPORT_PRODUCT, REDHAT_SUPPORT_PRODUCT_VERSION) if no such
649  * variables are found, uses NAME key for the product and VERSION_ID key for
650  * the product's version. If no NAME nor VERSION_ID are provided fallbacks to
651  * parsing of os_release which should be stored under PRETTY_NAME key.
652  *
653  * https://bugzilla.redhat.com/show_bug.cgi?id=950373
654  *
655  * @param osinfo Input data from which the values are built
656  * @param produc Non-NULL pointer where pointer to malloced string will be stored. Memory must be released by free()
657  * @param version Non-NULL pointer where pointer to malloced string will be stored. Memory must be released by free()
658  */
659 #define parse_osinfo_for_rhts libreport_parse_osinfo_for_rhts
660 void parse_osinfo_for_rhts(map_string_t *osinfo, char **product, char **version);
661 
662 #define parse_release_for_bz libreport_parse_release_for_bz
663 void parse_release_for_bz(const char *pRelease, char **product, char **version);
664 #define parse_release_for_rhts libreport_parse_release_for_rhts
665 void parse_release_for_rhts(const char *pRelease, char **product, char **version);
666 
681 #define load_conf_file libreport_load_conf_file
682 bool load_conf_file(const char *pPath, map_string_t *settings, bool skipKeysWithoutValue);
683 
684 #define save_conf_file libreport_save_conf_file
685 bool save_conf_file(const char *path, map_string_t *settings);
686 
687 #define save_app_conf_file libreport_save_app_conf_file
688 bool save_app_conf_file(const char* application_name, map_string_t *settings);
689 #define load_app_conf_file libreport_load_app_conf_file
690 bool load_app_conf_file(const char *application_name, map_string_t *settings);
691 #define set_app_user_setting libreport_set_app_user_setting
692 void set_app_user_setting(map_string_t *settings, const char *name, const char *value);
693 #define get_app_user_setting libreport_get_app_user_setting
694 const char *get_app_user_setting(map_string_t *settings, const char *name);
695 
696 #define save_user_settings libreport_save_user_settings
697 bool save_user_settings();
698 #define load_user_settings libreport_load_user_settings
699 bool load_user_settings(const char *application_name);
700 #define set_user_setting libreport_set_user_setting
701 void set_user_setting(const char *name, const char *value);
702 #define get_user_setting libreport_get_user_setting
703 const char *get_user_setting(const char *name);
704 
705 #define load_forbidden_words libreport_load_forbidden_words
706 GList *load_forbidden_words();
707 #define get_file_list libreport_get_file_list
708 GList *get_file_list(const char *path, const char *ext);
709 #define free_file_list libreport_free_file_list
710 void free_file_list(GList *filelist);
711 #define new_file_obj libreport_new_file_obj
712 file_obj_t *new_file_obj(const char* fullpath, const char* filename);
713 #define free_file_obj libreport_free_file_obj
714 void free_file_obj(file_obj_t *f);
715 #define load_workflow_config_data libreport_load_workflow_config_data
716 GHashTable *load_workflow_config_data(const char* path);
717 #define parse_list libreport_parse_list
718 GList *parse_list(const char* list);
719 
720 /* Connect to abrtd over unix domain socket, issue DELETE command */
721 int delete_dump_dir_possibly_using_abrtd(const char *dump_dir_name);
722 
723 /* Tries to create a copy of dump_dir_name in base_dir, with same or similar basename.
724  * Returns NULL if copying failed. In this case, logs a message before returning. */
725 #define steal_directory libreport_steal_directory
726 struct dump_dir *steal_directory(const char *base_dir, const char *dump_dir_name);
727 
728 /* Tries to open dump_dir_name with writing access. If function needs to steal
729  * directory calls ask_continue(new base dir, dump dir) callback to ask user
730  * for permission. If ask_continue param is NULL the function thinks that an
731  * answer is positive and steals directory.
732  * Returns NULL if opening failed or if stealing was dismissed. In this case,
733  * logs a message before returning. */
734 #define open_directory_for_writing libreport_open_directory_for_writing
735 struct dump_dir *open_directory_for_writing(
736  const char *dump_dir_name,
737  bool (*ask_continue)(const char *, const char *));
738 
739 // Files bigger than this are never considered to be text.
740 //
741 // Started at 64k limit. But _some_ limit is necessary:
742 // fields declared "text" may end up in editing fields and such.
743 // We don't want to accidentally end up with 100meg text in a textbox!
744 // So, don't remove this. If you really need to, raise the limit.
745 //
746 // Bumped up to 200k: saw 124740 byte /proc/PID/smaps file
747 // Bumped up to 500k: saw 375252 byte anaconda traceback file
748 // Bumped up to 1M: bugzilla.redhat.com/show_bug.cgi?id=746727
749 // mentions 853646 byte anaconda-tb-* file.
750 //
751 #define CD_MAX_TEXT_SIZE (1024*1024)
752 
753 // Text bigger than this usually is attached, not added inline
754 // was 2k, 20kb is too much, let's try 4kb
755 //
756 // For bug databases
757 #define CD_TEXT_ATT_SIZE_BZ (4*1024)
758 // For dumping problem data into a text file, email, etc
759 #define CD_TEXT_ATT_SIZE_LOGGER (CD_MAX_TEXT_SIZE)
760 
761 // Filenames in problem directory:
762 // filled by a hook:
763 #define FILENAME_TIME "time" /* mandatory */
764 #define FILENAME_LAST_OCCURRENCE "last_occurrence" /* optional */
765 #define FILENAME_REASON "reason" /* mandatory? */
766 #define FILENAME_UID "uid" /* mandatory? */
767 /*
768  * "analyzer" is to be gradually changed to "type":
769  * For now, we fetch and look at "analyzer" element,
770  * but we always save both "analyzer" and "type" (with same contents).
771  * By 2013, we switch to looking at "type". Then we will stop generating
772  * "analyzer" element.
773  */
774 #define FILENAME_ANALYZER "analyzer"
775 #define FILENAME_TYPE "type"
776 #define FILENAME_EXECUTABLE "executable"
777 #define FILENAME_PID "pid"
778 #define FILENAME_PWD "pwd"
779 #define FILENAME_ROOTDIR "rootdir"
780 #define FILENAME_BINARY "binary"
781 #define FILENAME_CMDLINE "cmdline"
782 #define FILENAME_COREDUMP "coredump"
783 #define FILENAME_CGROUP "cgroup"
784 #define FILENAME_BACKTRACE "backtrace"
785 #define FILENAME_MAPS "maps"
786 #define FILENAME_SMAPS "smaps"
787 #define FILENAME_PROC_PID_STATUS "proc_pid_status"
788 #define FILENAME_ENVIRON "environ"
789 #define FILENAME_LIMITS "limits"
790 #define FILENAME_OPEN_FDS "open_fds"
791 
792 /* Global problem identifier which is usually generated by some "analyze_*"
793  * event because it may take a lot of time to obtain strong problem
794  * identification */
795 #define FILENAME_DUPHASH "duphash"
796 
797 // Name of the function where the application crashed.
798 // Optional.
799 #define FILENAME_CRASH_FUNCTION "crash_function"
800 #define FILENAME_ARCHITECTURE "architecture"
801 #define FILENAME_KERNEL "kernel"
802 /*
803  * From /etc/os-release
804  * os_release filename name is alredy occupied by /etc/redhat-release (see
805  * below) in sake of backward compatibility /etc/os-release is stored in
806  * os_info file
807  */
808 #define FILENAME_OS_INFO "os_info"
809 #define FILENAME_OS_INFO_IN_ROOTDIR "os_info_in_rootdir"
810 // From /etc/system-release or /etc/redhat-release
811 #define FILENAME_OS_RELEASE "os_release"
812 #define FILENAME_OS_RELEASE_IN_ROOTDIR "os_release_in_rootdir"
813 // Filled by <what?>
814 #define FILENAME_PACKAGE "package"
815 #define FILENAME_COMPONENT "component"
816 #define FILENAME_COMMENT "comment"
817 #define FILENAME_RATING "backtrace_rating"
818 #define FILENAME_HOSTNAME "hostname"
819 // Optional. Set to "1" by abrt-handle-upload for every unpacked dump
820 #define FILENAME_REMOTE "remote"
821 #define FILENAME_TAINTED "kernel_tainted"
822 #define FILENAME_TAINTED_SHORT "kernel_tainted_short"
823 #define FILENAME_TAINTED_LONG "kernel_tainted_long"
824 #define FILENAME_VMCORE "vmcore"
825 #define FILENAME_KERNEL_LOG "kernel_log"
826 // File created by createAlertSignature() from libreport's python module
827 // The file should contain a description of an alert
828 #define FILENAME_DESCRIPTION "description"
829 
830 /* Local problem identifier (weaker than global identifier) designed for fast
831  * local for fast local duplicate identification. This file is usually provided
832  * by crashed application (problem creator).
833  */
834 #define FILENAME_UUID "uuid"
835 
836 #define FILENAME_COUNT "count"
837 /* Multi-line list of places problem was reported.
838  * Recommended line format:
839  * "Reporter: VAR=VAL VAR=VAL"
840  * Use add_reported_to(dd, "line_without_newline"): it adds line
841  * only if it is not already there.
842  */
843 #define FILENAME_REPORTED_TO "reported_to"
844 #define FILENAME_EVENT_LOG "event_log"
845 /*
846  * If exists, should contain a full sentence (with trailing period)
847  * which describes why this problem should not be reported.
848  * Example: "Your laptop firmware 1.9a is buggy, version 1.10 contains the fix."
849  */
850 #define FILENAME_NOT_REPORTABLE "not-reportable"
851 #define FILENAME_CORE_BACKTRACE "core_backtrace"
852 #define FILENAME_REMOTE_RESULT "remote_result"
853 #define FILENAME_PKG_EPOCH "pkg_epoch"
854 #define FILENAME_PKG_NAME "pkg_name"
855 #define FILENAME_PKG_VERSION "pkg_version"
856 #define FILENAME_PKG_RELEASE "pkg_release"
857 #define FILENAME_PKG_ARCH "pkg_arch"
858 #define FILENAME_USERNAME "username"
859 #define FILENAME_ABRT_VERSION "abrt_version"
860 
861 // Not stored as files, added "on the fly":
862 #define CD_DUMPDIR "Directory"
863 
864 #define cmp_problem_data libreport_cmp_problem_data
865 gint cmp_problem_data(gconstpointer a, gconstpointer b, gpointer filename);
866 
867 //UNUSED:
870 //#define CD_EVENTS "Events"
871 
872 /* FILENAME_EVENT_LOG is trimmed to below LOW_WATERMARK
873  * when it reaches HIGH_WATERMARK size
874  */
875 enum {
876  EVENT_LOG_HIGH_WATERMARK = 30 * 1024,
877  EVENT_LOG_LOW_WATERMARK = 20 * 1024,
878 };
879 
880 #define log_problem_data libreport_log_problem_data
881 void log_problem_data(problem_data_t *problem_data, const char *pfx);
882 
883 
884 const char *abrt_init(char **argv);
885 #define export_abrt_envvars libreport_export_abrt_envvars
886 void export_abrt_envvars(int pfx);
887 #define g_progname libreport_g_progname
888 extern const char *g_progname;
889 
890 enum parse_opt_type {
891  OPTION_BOOL,
892  OPTION_GROUP,
893  OPTION_STRING,
894  OPTION_INTEGER,
895  OPTION_OPTSTRING,
896  OPTION_LIST,
897  OPTION_END,
898 };
899 
900 struct options {
901  enum parse_opt_type type;
902  int short_name;
903  const char *long_name;
904  void *value;
905  const char *argh;
906  const char *help;
907 };
908 
909 /*
910  * s - short_name
911  * l - long_name
912  * v - value
913  * a - option parameter name (for help text)
914  * h - help
915  */
916 #define OPT_END() { OPTION_END }
917 #define OPT_GROUP(h) { OPTION_GROUP, 0, NULL, NULL, NULL, (h) }
918 #define OPT_BOOL( s, l, v, h) { OPTION_BOOL , (s), (l), (v), NULL , (h) }
919 #define OPT_INTEGER( s, l, v, h) { OPTION_INTEGER , (s), (l), (v), "NUM", (h) }
920 #define OPT_STRING( s, l, v, a, h) { OPTION_STRING , (s), (l), (v), (a) , (h) }
921 #define OPT_OPTSTRING(s, l, v, a, h) { OPTION_OPTSTRING, (s), (l), (v), (a) , (h) }
922 #define OPT_LIST( s, l, v, a, h) { OPTION_LIST , (s), (l), (v), (a) , (h) }
923 
924 #define OPT__VERBOSE(v) OPT_BOOL('v', "verbose", (v), _("Be verbose"))
925 #define OPT__DUMP_DIR(v) OPT_STRING('d', "problem-dir", (v), "DIR", _("Problem directory"))
926 
927 #define parse_opts libreport_parse_opts
928 unsigned parse_opts(int argc, char **argv, const struct options *opt,
929  const char *usage);
930 
931 #define show_usage_and_die libreport_show_usage_and_die
932 void show_usage_and_die(const char *usage, const struct options *opt) NORETURN;
933 
934 /* Can't include "abrt_curl.h", it's not a public API.
935  * Resorting to just forward-declaring the struct we need.
936  */
937 struct abrt_post_state;
938 
939 #ifdef __cplusplus
940 }
941 #endif
942 
943 #endif