libreport  2.1.11.1
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 #define STOP_ON_NOT_REPORTABLE "ABRT_STOP_ON_NOT_REPORTABLE"
91 
92 /* Pull in entire public libreport API */
93 #include "dump_dir.h"
94 #include "global_configuration.h"
95 #include "event_config.h"
96 #include "problem_data.h"
97 #include "report.h"
98 #include "run_event.h"
99 #include "workflow.h"
100 #include "file_obj.h"
101 #include "libreport_types.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 strtrim libreport_strtrim
112 char *strtrim(char *str);
113 #define strtrimch libreport_strtrimch
114 char *strtrimch(char *str, int ch);
115 #define strremovech libreport_strremovech
116 char *strremovech(char *str, int ch);
117 #define append_to_malloced_string libreport_append_to_malloced_string
118 char *append_to_malloced_string(char *mstr, const char *append);
119 #define skip_whitespace libreport_skip_whitespace
120 char* skip_whitespace(const char *s);
121 #define skip_non_whitespace libreport_skip_non_whitespace
122 char* skip_non_whitespace(const char *s);
123 /* Like strcpy but can copy overlapping strings. */
124 #define overlapping_strcpy libreport_overlapping_strcpy
125 void overlapping_strcpy(char *dst, const char *src);
126 
127 #define concat_path_file libreport_concat_path_file
128 char *concat_path_file(const char *path, const char *filename);
129 /*
130  * Used to construct a name in a different directory with the basename
131  * similar to the old name, if possible.
132  */
133 #define concat_path_basename libreport_concat_path_basename
134 char *concat_path_basename(const char *path, const char *filename);
135 
136 /* Allows all printable characters except '/',
137  * the string must not exceed 64 characters of length
138  * and must not equal neither "." nor ".." (these strings may appear in the string) */
139 #define str_is_correct_filename libreport_str_is_correct_filename
140 bool str_is_correct_filename(const char *str);
141 
142 /* A-la fgets, but malloced and of unlimited size */
143 #define xmalloc_fgets libreport_xmalloc_fgets
144 char *xmalloc_fgets(FILE *file);
145 /* Similar, but removes trailing \n */
146 #define xmalloc_fgetline libreport_xmalloc_fgetline
147 char *xmalloc_fgetline(FILE *file);
148 /* Useful for easy reading of various /proc files */
149 #define xmalloc_fopen_fgetline_fclose libreport_xmalloc_fopen_fgetline_fclose
150 char *xmalloc_fopen_fgetline_fclose(const char *filename);
151 
152 
153 /* On error, copyfd_XX prints error messages and returns -1 */
154 enum {
155  COPYFD_SPARSE = 1 << 0,
156 };
157 #define copyfd_eof libreport_copyfd_eof
158 off_t copyfd_eof(int src_fd, int dst_fd, int flags);
159 #define copyfd_size libreport_copyfd_size
160 off_t copyfd_size(int src_fd, int dst_fd, off_t size, int flags);
161 #define copyfd_exact_size libreport_copyfd_exact_size
162 void copyfd_exact_size(int src_fd, int dst_fd, off_t size);
163 #define copy_file_ext libreport_copy_file_ext
164 off_t copy_file_ext(const char *src_name, const char *dst_name, int mode, uid_t uid, gid_t gid, int src_flags, int dst_flags);
165 #define copy_file libreport_copy_file
166 off_t copy_file(const char *src_name, const char *dst_name, int mode);
167 #define copy_file_recursive libreport_copy_file_recursive
168 int copy_file_recursive(const char *source, const char *dest);
169 
170 // NB: will return short read on error, not -1,
171 // if some data was read before error occurred
172 #define xread libreport_xread
173 void xread(int fd, void *buf, size_t count);
174 #define safe_read libreport_safe_read
175 ssize_t safe_read(int fd, void *buf, size_t count);
176 #define safe_write libreport_safe_write
177 ssize_t safe_write(int fd, const void *buf, size_t count);
178 #define full_read libreport_full_read
179 ssize_t full_read(int fd, void *buf, size_t count);
180 #define full_write libreport_full_write
181 ssize_t full_write(int fd, const void *buf, size_t count);
182 #define full_write_str libreport_full_write_str
183 ssize_t full_write_str(int fd, const char *buf);
184 #define xmalloc_read libreport_xmalloc_read
185 void* xmalloc_read(int fd, size_t *maxsz_p);
186 #define xmalloc_open_read_close libreport_xmalloc_open_read_close
187 void* xmalloc_open_read_close(const char *filename, size_t *maxsz_p);
188 #define xmalloc_xopen_read_close libreport_xmalloc_xopen_read_close
189 void* xmalloc_xopen_read_close(const char *filename, size_t *maxsz_p);
190 
191 
192 /* Returns malloc'ed block */
193 #define encode_base64 libreport_encode_base64
194 char *encode_base64(const void *src, int length);
195 
196 /* Returns NULL if the string needs no sanitizing.
197  * control_chars_to_sanitize is a bit mask.
198  * If Nth bit is set, Nth control char will be sanitized (replaced by [XX]).
199  */
200 #define sanitize_utf8 libreport_sanitize_utf8
201 char *sanitize_utf8(const char *src, uint32_t control_chars_to_sanitize);
202 enum {
203  SANITIZE_ALL = 0xffffffff,
204  SANITIZE_TAB = (1 << 9),
205  SANITIZE_LF = (1 << 10),
206  SANITIZE_CR = (1 << 13),
207 };
208 
209 #define SHA1_RESULT_LEN (5 * 4)
210 typedef struct sha1_ctx_t {
211  uint8_t wbuffer[64]; /* always correctly aligned for uint64_t */
212  /* for sha256: void (*process_block)(struct md5_ctx_t*); */
213  uint64_t total64; /* must be directly before hash[] */
214  uint32_t hash[8]; /* 4 elements for md5, 5 for sha1, 8 for sha256 */
215 } sha1_ctx_t;
216 #define sha1_begin libreport_sha1_begin
217 void sha1_begin(sha1_ctx_t *ctx);
218 #define sha1_hash libreport_sha1_hash
219 void sha1_hash(sha1_ctx_t *ctx, const void *buffer, size_t len);
220 #define sha1_end libreport_sha1_end
221 void sha1_end(sha1_ctx_t *ctx, void *resbuf);
222 
223 /* Helpers to hash a string: */
224 #define str_to_sha1 libreport_str_to_sha1
225 const uint8_t *str_to_sha1(uint8_t result[SHA1_RESULT_LEN], const char *str);
226 #define str_to_sha1str libreport_str_to_sha1str
227 const char *str_to_sha1str(char result[SHA1_RESULT_LEN*2 + 1], const char *str);
228 
229 
230 #define xatou libreport_xatou
231 unsigned xatou(const char *numstr);
232 #define xatoi libreport_xatoi
233 int xatoi(const char *numstr);
234 /* Using xatoi() instead of naive atoi() is not always convenient -
235  * in many places people want *non-negative* values, but store them
236  * in signed int. Therefore we need this one:
237  * dies if input is not in [0, INT_MAX] range. Also will reject '-0' etc.
238  * It should really be named xatoi_nonnegative (since it allows 0),
239  * but that would be too long.
240  */
241 #define xatoi_positive libreport_xatoi_positive
242 int xatoi_positive(const char *numstr);
243 
244 //unused for now
245 //unsigned long long monotonic_ns(void);
246 //unsigned long long monotonic_us(void);
247 //unsigned monotonic_sec(void);
248 
249 #define safe_waitpid libreport_safe_waitpid
250 pid_t safe_waitpid(pid_t pid, int *wstat, int options);
251 
252 enum {
253  /* on return, pipefds[1] is fd to which parent may write
254  * and deliver data to child's stdin: */
255  EXECFLG_INPUT = 1 << 0,
256  /* on return, pipefds[0] is fd from which parent may read
257  * child's stdout: */
258  EXECFLG_OUTPUT = 1 << 1,
259  /* open child's stdin to /dev/null: */
260  EXECFLG_INPUT_NUL = 1 << 2,
261  /* open child's stdout to /dev/null: */
262  EXECFLG_OUTPUT_NUL = 1 << 3,
263  /* redirect child's stderr to stdout: */
264  EXECFLG_ERR2OUT = 1 << 4,
265  /* open child's stderr to /dev/null: */
266  EXECFLG_ERR_NUL = 1 << 5,
267  /* suppress perror_msg("Can't execute 'foo'") if exec fails */
268  EXECFLG_QUIET = 1 << 6,
269  EXECFLG_SETGUID = 1 << 7,
270  EXECFLG_SETSID = 1 << 8,
271  EXECFLG_SETPGID = 1 << 9,
272 };
273 /*
274  * env_vec: list of variables to set in environment (if string has
275  * "VAR=VAL" form) or unset in environment (if string has no '=' char).
276  *
277  * Returns pid.
278  */
279 #define fork_execv_on_steroids libreport_fork_execv_on_steroids
280 pid_t fork_execv_on_steroids(int flags,
281  char **argv,
282  int *pipefds,
283  char **env_vec,
284  const char *dir,
285  uid_t uid);
286 /* Returns malloc'ed string. NULs are retained, and extra one is appended
287  * after the last byte (this NUL is not accounted for in *size_p) */
288 #define run_in_shell_and_save_output libreport_run_in_shell_and_save_output
289 char *run_in_shell_and_save_output(int flags,
290  const char *cmd,
291  const char *dir,
292  size_t *size_p);
293 
294 /* Random utility functions */
295 
296 #define is_in_string_list libreport_is_in_string_list
297 bool is_in_string_list(const char *name, const char *const *v);
298 
299 #define index_of_string_in_list libreport_index_of_string_in_list
300 int index_of_string_in_list(const char *name, const char *const *v);
301 
302 #define is_in_comma_separated_list libreport_is_in_comma_separated_list
303 bool is_in_comma_separated_list(const char *value, const char *list);
304 #define is_in_comma_separated_list_of_glob_patterns libreport_is_in_comma_separated_list_of_glob_patterns
305 bool is_in_comma_separated_list_of_glob_patterns(const char *value, const char *list);
306 
307 /* Calls GLib version appropriate initialization function.
308  */
309 #define glib_init libreport_glib_init
310 void glib_init(void);
311 
312 /* Frees every element'd data using free(),
313  * then frees list itself using g_list_free(list):
314  */
315 #define list_free_with_free libreport_list_free_with_free
316 void list_free_with_free(GList *list);
317 
318 #define get_dirsize libreport_get_dirsize
319 double get_dirsize(const char *pPath);
320 #define get_dirsize_find_largest_dir libreport_get_dirsize_find_largest_dir
321 double get_dirsize_find_largest_dir(
322  const char *pPath,
323  char **worst_dir, /* can be NULL */
324  const char *excluded /* can be NULL */
325 );
326 
327 #define ndelay_on libreport_ndelay_on
328 int ndelay_on(int fd);
329 #define ndelay_off libreport_ndelay_off
330 int ndelay_off(int fd);
331 #define close_on_exec_on libreport_close_on_exec_on
332 int close_on_exec_on(int fd);
333 
334 #define xmalloc libreport_xmalloc
335 void* xmalloc(size_t size);
336 #define xrealloc libreport_xrealloc
337 void* xrealloc(void *ptr, size_t size);
338 #define xzalloc libreport_xzalloc
339 void* xzalloc(size_t size);
340 #define xstrdup libreport_xstrdup
341 char* xstrdup(const char *s);
342 #define xstrndup libreport_xstrndup
343 char* xstrndup(const char *s, int n);
344 #define xstrdup_between libreport_xstrdup_between
345 char* xstrdup_between(const char *s, const char *open, const char *close);
346 
347 #define xpipe libreport_xpipe
348 void xpipe(int filedes[2]);
349 #define xdup libreport_xdup
350 int xdup(int from);
351 #define xdup2 libreport_xdup2
352 void xdup2(int from, int to);
353 #define xmove_fd libreport_xmove_fd
354 void xmove_fd(int from, int to);
355 
356 #define xwrite libreport_xwrite
357 void xwrite(int fd, const void *buf, size_t count);
358 #define xwrite_str libreport_xwrite_str
359 void xwrite_str(int fd, const char *str);
360 
361 #define xlseek libreport_xlseek
362 off_t xlseek(int fd, off_t offset, int whence);
363 
364 #define xchdir libreport_xchdir
365 void xchdir(const char *path);
366 
367 #define xvasprintf libreport_xvasprintf
368 char* xvasprintf(const char *format, va_list p);
369 #define xasprintf libreport_xasprintf
370 char* xasprintf(const char *format, ...);
371 
372 #define xsetenv libreport_xsetenv
373 void xsetenv(const char *key, const char *value);
374 /*
375  * Utility function to unsetenv a string which was possibly putenv'ed.
376  * The problem here is that "natural" optimization:
377  * strchrnul(var_val, '=')[0] = '\0';
378  * unsetenv(var_val);
379  * is BUGGY: if string was put into environment via putenv,
380  * its modification (s/=/NUL/) is illegal, and unsetenv will fail to unset it.
381  * Of course, saving/restoring the char wouldn't work either.
382  * This helper creates a copy up to '=', unsetenv's it, and frees:
383  */
384 #define safe_unsetenv libreport_safe_unsetenv
385 void safe_unsetenv(const char *var_val);
386 
387 #define xsocket libreport_xsocket
388 int xsocket(int domain, int type, int protocol);
389 #define xbind libreport_xbind
390 void xbind(int sockfd, struct sockaddr *my_addr, socklen_t addrlen);
391 #define xlisten libreport_xlisten
392 void xlisten(int s, int backlog);
393 #define xsendto libreport_xsendto
394 ssize_t xsendto(int s, const void *buf, size_t len,
395  const struct sockaddr *to, socklen_t tolen);
396 
397 #define xstat libreport_xstat
398 void xstat(const char *name, struct stat *stat_buf);
399 #define fstat_st_size_or_die libreport_fstat_st_size_or_die
400 off_t fstat_st_size_or_die(int fd);
401 #define stat_st_size_or_die libreport_stat_st_size_or_die
402 off_t stat_st_size_or_die(const char *filename);
403 
404 #define xopen3 libreport_xopen3
405 int xopen3(const char *pathname, int flags, int mode);
406 #define xopen libreport_xopen
407 int xopen(const char *pathname, int flags);
408 #define xunlink libreport_xunlink
409 void xunlink(const char *pathname);
410 #define xunlinkat libreport_xunlinkat
411 void xunlinkat(int dir_fd, const char *pathname, int flags);
412 
413 /* Just testing dent->d_type == DT_REG is wrong: some filesystems
414  * do not report the type, they report DT_UNKNOWN for every dirent
415  * (and this is not a bug in filesystem, this is allowed by standards).
416  * This function handles this case. Note: it returns 0 on symlinks
417  * even if they point to regular files.
418  */
419 #define is_regular_file libreport_is_regular_file
420 int is_regular_file(struct dirent *dent, const char *dirname);
421 #define is_regular_file_at libreport_is_regular_file_at
422 int is_regular_file_at(struct dirent *dent, int dir_fd);
423 
424 #define dot_or_dotdot libreport_dot_or_dotdot
425 bool dot_or_dotdot(const char *filename);
426 #define last_char_is libreport_last_char_is
427 char *last_char_is(const char *s, int c);
428 
429 #define string_to_bool libreport_string_to_bool
430 bool string_to_bool(const char *s);
431 
432 #define xseteuid libreport_xseteuid
433 void xseteuid(uid_t euid);
434 #define xsetegid libreport_xsetegid
435 void xsetegid(gid_t egid);
436 #define xsetreuid libreport_xsetreuid
437 void xsetreuid(uid_t ruid, uid_t euid);
438 #define xsetregid libreport_xsetregid
439 void xsetregid(gid_t rgid, gid_t egid);
440 
441 
442 /* Emit a string of hex representation of bytes */
443 #define bin2hex libreport_bin2hex
444 char* bin2hex(char *dst, const char *str, int count);
445 /* Convert "xxxxxxxx" hex string to binary, no more than COUNT bytes */
446 #define hex2bin libreport_hex2bin
447 char* hex2bin(char *dst, const char *str, int count);
448 
449 
450 enum {
451  LOGMODE_NONE = 0,
452  LOGMODE_STDIO = (1 << 0),
453  LOGMODE_SYSLOG = (1 << 1),
454  LOGMODE_BOTH = LOGMODE_SYSLOG + LOGMODE_STDIO,
455  LOGMODE_CUSTOM = (1 << 2),
456  LOGMODE_JOURNAL = (1 << 3),
457 };
458 
459 #define g_custom_logger libreport_g_custom_logger
460 extern void (*g_custom_logger)(const char*);
461 #define msg_prefix libreport_msg_prefix
462 extern const char *msg_prefix;
463 #define msg_eol libreport_msg_eol
464 extern const char *msg_eol;
465 #define logmode libreport_logmode
466 extern int logmode;
467 #define xfunc_error_retval libreport_xfunc_error_retval
468 extern int xfunc_error_retval;
469 
470 /* A few magic exit codes */
471 #define EXIT_CANCEL_BY_USER 69
472 #define EXIT_STOP_EVENT_RUN 70
473 
474 #define set_xfunc_error_retval libreport_set_xfunc_error_retval
475 void set_xfunc_error_retval(int retval);
476 
477 /* Verbosity level */
478 #define g_verbose libreport_g_verbose
479 extern int g_verbose;
480 /* VERB1 log("what you sometimes want to see, even on a production box") */
481 #define VERB1 if (g_verbose >= 1)
482 /* VERB2 log("debug message, not going into insanely small details") */
483 #define VERB2 if (g_verbose >= 2)
484 /* VERB3 log("lots and lots of details") */
485 #define VERB3 if (g_verbose >= 3)
486 /* there is no level > 3 */
487 
488 #define libreport_
489 #define xfunc_die libreport_xfunc_die
490 void xfunc_die(void) NORETURN;
491 
492 #define die_out_of_memory libreport_die_out_of_memory
493 void die_out_of_memory(void) NORETURN;
494 
495 /* It's a macro, not function, since it collides with log() from math.h */
496 #undef log
497 #define log(...) log_standard(LOG_WARNING, __FILE__, __LINE__, __func__, __VA_ARGS__)
498 #define log_debug(...) log_standard(LOG_DEBUG, __FILE__, __LINE__, __func__, __VA_ARGS__)
499 #define log_info(...) log_standard(LOG_INFO, __FILE__, __LINE__, __func__, __VA_ARGS__)
500 #define log_notice(...) log_standard(LOG_NOTICE, __FILE__, __LINE__, __func__, __VA_ARGS__)
501 #define log_warning(...) log_standard(LOG_WARNING, __FILE__, __LINE__, __func__, __VA_ARGS__)
502 #define log_error(...) log_standard(LOG_ERR, __FILE__, __LINE__, __func__, __VA_ARGS__)
503 
504 #define log_standard(level, file, line, func, ...) log_wrapper(level, __FILE__, __LINE__, __func__, false, false, __VA_ARGS__)
505 
506 // level, file, line, func, perror, custom logger, format & args
507 #define log_error_and_die(...) log_wrapper(LOG_ERR, __FILE__, __LINE__, __func__, false, false,__VA_ARGS__)
508 #define log_perror(...) log_wrapper(LOG_ERR, __FILE__, __LINE__, __func__, true, false, __VA_ARGS__)
509 #define log_perror_and_die(...) log_wrapper(LOG_ERR, __FILE__, __LINE__, __func__, true, false, __VA_ARGS__)
510 
511 #define error_msg(...) log_wrapper(LOG_ERR, __FILE__, __LINE__, __func__, false, true, __VA_ARGS__)
512 #define perror_msg(...) log_wrapper(LOG_ERR, __FILE__, __LINE__, __func__, true, true, __VA_ARGS__)
513 #define warn_msg(...) log_wrapper(LOG_WARNING, __FILE__, __LINE__, __func__, false, true, __VA_ARGS__)
514 #define pwarn_msg(...) log_wrapper(LOG_WARNING, __FILE__, __LINE__, __func__, true, true, __VA_ARGS__)
515 #define error_msg_and_die(...) log_and_die_wrapper(LOG_ERR, __FILE__, __LINE__, __func__, false, true, __VA_ARGS__)
516 #define perror_msg_and_die(...) log_and_die_wrapper(LOG_ERR, __FILE__, __LINE__, __func__, true, true, __VA_ARGS__)
517 
518 
519 void log_wrapper(int level,
520  const char *file,
521  int line,
522  const char *func,
523  bool process_perror,
524  bool use_custom_logger,
525  const char *format, ...) __attribute__ ((format (printf, 7,8)));
526 
527 void log_and_die_wrapper(int level,
528  const char *file,
529  int line,
530  const char *func,
531  bool process_perror,
532  bool use_custom_logger,
533  const char *format, ...) __attribute__ ((noreturn, format (printf, 7,8)));
534 
535 struct strbuf
536 {
537  /* Size of the allocated buffer. Always > 0. */
538  int alloc;
539  /* Length of the string, without the ending \0. */
540  int len;
541  char *buf;
542 };
543 
550 #define strbuf_new libreport_strbuf_new
551 struct strbuf *strbuf_new(void);
552 
558 #define strbuf_free libreport_strbuf_free
559 void strbuf_free(struct strbuf *strbuf);
560 
566 #define strbuf_free_nobuf libreport_strbuf_free_nobuf
567 char* strbuf_free_nobuf(struct strbuf *strbuf);
568 
573 #define strbuf_clear libreport_strbuf_clear
574 void strbuf_clear(struct strbuf *strbuf);
575 
580 #define strbuf_append_char libreport_strbuf_append_char
581 struct strbuf *strbuf_append_char(struct strbuf *strbuf, char c);
582 
587 #define strbuf_append_str libreport_strbuf_append_str
588 struct strbuf *strbuf_append_str(struct strbuf *strbuf,
589  const char *str);
590 
595 #define strbuf_prepend_str libreport_strbuf_prepend_str
596 struct strbuf *strbuf_prepend_str(struct strbuf *strbuf,
597  const char *str);
598 
603 #define strbuf_append_strf libreport_strbuf_append_strf
604 struct strbuf *strbuf_append_strf(struct strbuf *strbuf,
605  const char *format, ...);
606 
611 #define strbuf_append_strfv libreport_strbuf_append_strfv
612 struct strbuf *strbuf_append_strfv(struct strbuf *strbuf,
613  const char *format, va_list p);
614 
620 #define strbuf_prepend_strf libreport_strbuf_prepend_strf
621 struct strbuf *strbuf_prepend_strf(struct strbuf *strbuf,
622  const char *format, ...);
623 
628 #define strbuf_prepend_strfv libreport_strbuf_prepend_strfv
629 struct strbuf *strbuf_prepend_strfv(struct strbuf *strbuf,
630  const char *format, va_list p);
631 
632 /* Returns command line of running program.
633  * Caller is responsible to free() the returned value.
634  * If the pid is not valid or command line can not be obtained,
635  * empty string is returned.
636  */
637 #define get_cmdline libreport_get_cmdline
638 char* get_cmdline(pid_t pid);
639 #define get_environ libreport_get_environ
640 char* get_environ(pid_t pid);
641 
642 /* Takes ptr to time_t, or NULL if you want to use current time.
643  * Returns "YYYY-MM-DD-hh:mm:ss" string.
644  */
645 #define iso_date_string libreport_iso_date_string
646 char *iso_date_string(const time_t *pt);
647 #define LIBREPORT_ISO_DATE_STRING_SAMPLE "YYYY-MM-DD-hh:mm:ss"
648 #define LIBREPORT_ISO_DATE_STRING_FORMAT "%Y-%m-%d-%H:%M:%S"
649 
650 /* Parses date into integer UNIX time stamp
651  *
652  * @param date The parsed date string
653  * @param pt Return value
654  * @return 0 on success; otherwise non-0 number. -EINVAL if the parameter date
655  * does not match LIBREPORT_ISO_DATE_STRING_FORMAT
656  */
657 #define iso_date_string_parse libreport_iso_date_string_parse
658 int iso_date_string_parse(const char *date, time_t *pt);
659 
660 enum {
661  MAKEDESC_SHOW_FILES = (1 << 0),
662  MAKEDESC_SHOW_MULTILINE = (1 << 1),
663  MAKEDESC_SHOW_ONLY_LIST = (1 << 2),
664  MAKEDESC_WHITELIST = (1 << 3),
665  /* Include all URLs from FILENAME_REPORTED_TO element in the description text */
666  MAKEDESC_SHOW_URLS = (1 << 4),
667 };
668 #define make_description libreport_make_description
669 char *make_description(problem_data_t *problem_data, char **names_to_skip, unsigned max_text_size, unsigned desc_flags);
670 #define make_description_logger libreport_make_description_logger
671 char* make_description_logger(problem_data_t *problem_data, unsigned max_text_size);
672 
673 /* See man os-release(5) for details */
674 #define OSINFO_ID "ID"
675 #define OSINFO_NAME "NAME"
676 #define OSINFO_VERSION_ID "VERSION_ID"
677 #define OSINFO_PRETTY_NAME "PRETTY_NAME"
678 
679 /* @brief Loads a text in format of os-release(5) in to a map
680  *
681  * Function doesn't check for format errors much. It just tries to avoid
682  * program errors. In case of error the function prints out a log message and
683  * continues in parsing.
684  *
685  * @param osinfo_bytes Non-NULL pointer to osinfo bytes.
686  * @param osinfo The map where result is stored
687  */
688 #define parse_osinfo libreport_parse_osinfo
689 void parse_osinfo(const char *osinfo_bytes, map_string_t *osinfo);
690 
691 /* @brief Builds product string and product's version string for Bugzilla
692  *
693  * At first tries to get strings from the os specific variables
694  * (ORACLE_BUGZILLA_PRODUCT, ORACLE_BUGZILLA_PRODUCT_VERSION) if no such
695  * variables are found, uses NAME key for the product and VERSION_ID key for
696  * the product's version. If neither NAME nor VERSION_ID are provided fallbacks
697  * to parsing of os_release which should be stored under PRETTY_NAME key.
698  *
699  * https://bugzilla.redhat.com/show_bug.cgi?id=950373
700  *
701  * @param osinfo Input data from which the values are built
702  * @param produc Non-NULL pointer where pointer to malloced string will be stored. Memory must be released by free()
703  * @param version Non-NULL pointer where pointer to malloced string will be stored. Memory must be released by free()
704  */
705 #define parse_osinfo_for_bz libreport_parse_osinfo_for_bz
706 void parse_osinfo_for_bz(map_string_t *osinfo, char **product, char **version);
707 
708 /* @brief Builds product string and product's version string for Red Hat Support
709  *
710  * At first tries to get strings from the os specific variables
711  * (ORACLE_SUPPORT_PRODUCT, ORACLE_SUPPORT_PRODUCT_VERSION) if no such
712  * variables are found, uses NAME key for the product and VERSION_ID key for
713  * the product's version. If no NAME nor VERSION_ID are provided fallbacks to
714  * parsing of os_release which should be stored under PRETTY_NAME key.
715  *
716  * https://bugzilla.redhat.com/show_bug.cgi?id=950373
717  *
718  * @param osinfo Input data from which the values are built
719  * @param produc Non-NULL pointer where pointer to malloced string will be stored. Memory must be released by free()
720  * @param version Non-NULL pointer where pointer to malloced string will be stored. Memory must be released by free()
721  */
722 #define parse_osinfo_for_rhts libreport_parse_osinfo_for_rhts
723 void parse_osinfo_for_rhts(map_string_t *osinfo, char **product, char **version);
724 
725 #define parse_release_for_bz libreport_parse_release_for_bz
726 void parse_release_for_bz(const char *pRelease, char **product, char **version);
727 #define parse_release_for_rhts libreport_parse_release_for_rhts
728 void parse_release_for_rhts(const char *pRelease, char **product, char **version);
729 
744 #define load_conf_file libreport_load_conf_file
745 bool load_conf_file(const char *pPath, map_string_t *settings, bool skipKeysWithoutValue);
746 #define load_plugin_conf_file libreport_load_plugin_conf_file
747 bool load_plugin_conf_file(const char *name, map_string_t *settings, bool skipKeysWithoutValue);
748 
749 #define get_user_conf_base_dir libreport_get_user_conf_base_dir
750 const char *get_user_conf_base_dir(void);
751 
752 #define load_conf_file_from_dirs libreport_load_conf_file_from_dirs
753 bool load_conf_file_from_dirs(const char *base_name, const char *const *directories, map_string_t *settings, bool skipKeysWithoutValue);
754 
755 enum {
756  CONF_DIR_FLAG_NONE = 0,
757  CONF_DIR_FLAG_OPTIONAL = 1,
758 };
759 
760 #define load_conf_file_from_dirs_ext libreport_load_conf_file_from_dirs_ext
761 bool load_conf_file_from_dirs_ext(const char *base_name, const char *const *directories,
762  const int * dir_flags, map_string_t *settings,
763  bool skipKeysWithoutValue);
764 
765 #define save_conf_file libreport_save_conf_file
766 bool save_conf_file(const char *path, map_string_t *settings);
767 #define save_plugin_conf_file libreport_save_plugin_conf_file
768 bool save_plugin_conf_file(const char *name, map_string_t *settings);
769 
770 #define save_app_conf_file libreport_save_app_conf_file
771 bool save_app_conf_file(const char* application_name, map_string_t *settings);
772 #define load_app_conf_file libreport_load_app_conf_file
773 bool load_app_conf_file(const char *application_name, map_string_t *settings);
774 #define set_app_user_setting libreport_set_app_user_setting
775 void set_app_user_setting(map_string_t *settings, const char *name, const char *value);
776 #define get_app_user_setting libreport_get_app_user_setting
777 const char *get_app_user_setting(map_string_t *settings, const char *name);
778 
779 #define save_user_settings libreport_save_user_settings
780 bool save_user_settings();
781 #define load_user_settings libreport_load_user_settings
782 bool load_user_settings(const char *application_name);
783 #define set_user_setting libreport_set_user_setting
784 void set_user_setting(const char *name, const char *value);
785 #define get_user_setting libreport_get_user_setting
786 const char *get_user_setting(const char *name);
787 
788 /* filename is expected to exist in CONF_DIR
789  * usually /etc/libreport
790  */
791 #define load_forbidden_words libreport_load_forbidden_words
792 GList *load_words_from_file(const char *filename);
793 #define get_file_list libreport_get_file_list
794 GList *get_file_list(const char *path, const char *ext);
795 #define free_file_list libreport_free_file_list
796 void free_file_list(GList *filelist);
797 #define new_file_obj libreport_new_file_obj
798 file_obj_t *new_file_obj(const char* fullpath, const char* filename);
799 #define free_file_obj libreport_free_file_obj
800 void free_file_obj(file_obj_t *f);
801 #define load_workflow_config_data libreport_load_workflow_config_data
802 GHashTable *load_workflow_config_data(const char* path);
803 #define parse_delimited_list libreport_parse_delimited_list
804 GList *parse_delimited_list(char* list, const char *delim);
805 #define parse_list libreport_parse_list
806 GList *parse_list(const char* list);
807 
808 /* Connect to abrtd over unix domain socket, issue DELETE command */
809 int delete_dump_dir_possibly_using_abrtd(const char *dump_dir_name);
810 
811 /* Tries to create a copy of dump_dir_name in base_dir, with same or similar basename.
812  * Returns NULL if copying failed. In this case, logs a message before returning. */
813 #define steal_directory libreport_steal_directory
814 struct dump_dir *steal_directory(const char *base_dir, const char *dump_dir_name);
815 
816 /* Resolves if the given user is in given group
817  *
818  * @param uid user ID
819  * @param gid group ID
820  * @returns TRUE in case the user is in the group otherwise returns FALSE
821  */
822 #define uid_in_group libreport_uid_in_group
823 bool uid_in_group(uid_t uid, gid_t gid);
824 
825 /* Tries to open dump_dir_name with writing access. If function needs to steal
826  * directory calls ask_continue(new base dir, dump dir) callback to ask user
827  * for permission. If ask_continue param is NULL the function thinks that an
828  * answer is positive and steals directory.
829  * Returns NULL if opening failed or if stealing was dismissed. In this case,
830  * logs a message before returning. */
831 #define open_directory_for_writing libreport_open_directory_for_writing
832 struct dump_dir *open_directory_for_writing(
833  const char *dump_dir_name,
834  bool (*ask_continue)(const char *, const char *));
835 
836 // Files bigger than this are never considered to be text.
837 //
838 // Started at 64k limit. But _some_ limit is necessary:
839 // fields declared "text" may end up in editing fields and such.
840 // We don't want to accidentally end up with 100meg text in a textbox!
841 // So, don't remove this. If you really need to, raise the limit.
842 //
843 // Bumped up to 200k: saw 124740 byte /proc/PID/smaps file
844 // Bumped up to 500k: saw 375252 byte anaconda traceback file
845 // Bumped up to 1M: bugzilla.redhat.com/show_bug.cgi?id=746727
846 // mentions 853646 byte anaconda-tb-* file.
847 // Bumped up to 8M: bugzilla.redhat.com/show_bug.cgi?id=887570
848 // (anaconda-tb file of 1.38 MBytes)
849 //
850 #define CD_MAX_TEXT_SIZE (8*1024*1024)
851 
852 // Text bigger than this usually is attached, not added inline
853 // was 2k, 20kb is too much, let's try 4kb
854 //
855 // For bug databases
856 #define CD_TEXT_ATT_SIZE_BZ (4*1024)
857 // For dumping problem data into a text file, email, etc
858 #define CD_TEXT_ATT_SIZE_LOGGER (CD_MAX_TEXT_SIZE)
859 
860 // Filenames in problem directory:
861 // filled by a hook:
862 #define FILENAME_TIME "time" /* mandatory */
863 #define FILENAME_LAST_OCCURRENCE "last_occurrence" /* optional */
864 #define FILENAME_REASON "reason" /* mandatory? */
865 #define FILENAME_UID "uid" /* mandatory? */
866 /*
867  * "analyzer" is to be gradually changed to "type":
868  * For now, we fetch and look at "analyzer" element,
869  * but we always save both "analyzer" and "type" (with same contents).
870  * By 2013, we switch to looking at "type". Then we will stop generating
871  * "analyzer" element.
872  */
873 #define FILENAME_ANALYZER "analyzer"
874 #define FILENAME_TYPE "type"
875 #define FILENAME_EXECUTABLE "executable"
876 #define FILENAME_PID "pid"
877 #define FILENAME_PWD "pwd"
878 #define FILENAME_ROOTDIR "rootdir"
879 #define FILENAME_BINARY "binary"
880 #define FILENAME_CMDLINE "cmdline"
881 #define FILENAME_COREDUMP "coredump"
882 #define FILENAME_CGROUP "cgroup"
883 #define FILENAME_BACKTRACE "backtrace"
884 #define FILENAME_MAPS "maps"
885 #define FILENAME_SMAPS "smaps"
886 #define FILENAME_PROC_PID_STATUS "proc_pid_status"
887 #define FILENAME_ENVIRON "environ"
888 #define FILENAME_LIMITS "limits"
889 #define FILENAME_OPEN_FDS "open_fds"
890 
891 /* Global problem identifier which is usually generated by some "analyze_*"
892  * event because it may take a lot of time to obtain strong problem
893  * identification */
894 #define FILENAME_DUPHASH "duphash"
895 
896 // Name of the function where the application crashed.
897 // Optional.
898 #define FILENAME_CRASH_FUNCTION "crash_function"
899 #define FILENAME_ARCHITECTURE "architecture"
900 #define FILENAME_KERNEL "kernel"
901 /*
902  * From /etc/os-release
903  * os_release filename name is alredy occupied by /etc/redhat-release (see
904  * below) in sake of backward compatibility /etc/os-release is stored in
905  * os_info file
906  */
907 #define FILENAME_OS_INFO "os_info"
908 #define FILENAME_OS_INFO_IN_ROOTDIR "os_info_in_rootdir"
909 // From /etc/system-release or /etc/redhat-release
910 #define FILENAME_OS_RELEASE "os_release"
911 #define FILENAME_OS_RELEASE_IN_ROOTDIR "os_release_in_rootdir"
912 // Filled by <what?>
913 #define FILENAME_PACKAGE "package"
914 #define FILENAME_COMPONENT "component"
915 #define FILENAME_COMMENT "comment"
916 #define FILENAME_RATING "backtrace_rating"
917 #define FILENAME_HOSTNAME "hostname"
918 // Optional. Set to "1" by abrt-handle-upload for every unpacked dump
919 #define FILENAME_REMOTE "remote"
920 #define FILENAME_TAINTED "kernel_tainted"
921 #define FILENAME_TAINTED_SHORT "kernel_tainted_short"
922 #define FILENAME_TAINTED_LONG "kernel_tainted_long"
923 #define FILENAME_VMCORE "vmcore"
924 #define FILENAME_KERNEL_LOG "kernel_log"
925 // File created by createAlertSignature() from libreport's python module
926 // The file should contain a description of an alert
927 #define FILENAME_DESCRIPTION "description"
928 
929 /* Local problem identifier (weaker than global identifier) designed for fast
930  * local for fast local duplicate identification. This file is usually provided
931  * by crashed application (problem creator).
932  */
933 #define FILENAME_UUID "uuid"
934 
935 #define FILENAME_COUNT "count"
936 /* Multi-line list of places problem was reported.
937  * Recommended line format:
938  * "Reporter: VAR=VAL VAR=VAL"
939  * Use add_reported_to(dd, "line_without_newline"): it adds line
940  * only if it is not already there.
941  */
942 #define FILENAME_REPORTED_TO "reported_to"
943 #define FILENAME_EVENT_LOG "event_log"
944 /*
945  * If exists, should contain a full sentence (with trailing period)
946  * which describes why this problem should not be reported.
947  * Example: "Your laptop firmware 1.9a is buggy, version 1.10 contains the fix."
948  */
949 #define FILENAME_NOT_REPORTABLE "not-reportable"
950 #define FILENAME_CORE_BACKTRACE "core_backtrace"
951 #define FILENAME_REMOTE_RESULT "remote_result"
952 #define FILENAME_PKG_EPOCH "pkg_epoch"
953 #define FILENAME_PKG_NAME "pkg_name"
954 #define FILENAME_PKG_VERSION "pkg_version"
955 #define FILENAME_PKG_RELEASE "pkg_release"
956 #define FILENAME_PKG_ARCH "pkg_arch"
957 
958 /* RHEL packages - Red Hat, Inc. */
959 #define FILENAME_PKG_VENDOR "pkg_vendor"
960 /* RHEL keys - https://access.redhat.com/security/team/key */
961 #define FILENAME_PKG_FINGERPRINT "pkg_fingerprint"
962 
963 #define FILENAME_USERNAME "username"
964 #define FILENAME_ABRT_VERSION "abrt_version"
965 #define FILENAME_EXPLOITABLE "exploitable"
966 
967 /* reproducible element is used by functions from problem_data.h */
968 #define FILENAME_REPRODUCIBLE "reproducible"
969 #define FILENAME_REPRODUCER "reproducer"
970 
971 // Not stored as files, added "on the fly":
972 #define CD_DUMPDIR "Directory"
973 
974 #define cmp_problem_data libreport_cmp_problem_data
975 gint cmp_problem_data(gconstpointer a, gconstpointer b, gpointer filename);
976 
977 //UNUSED:
980 //#define CD_EVENTS "Events"
981 
982 /* FILENAME_EVENT_LOG is trimmed to below LOW_WATERMARK
983  * when it reaches HIGH_WATERMARK size
984  */
985 enum {
986  EVENT_LOG_HIGH_WATERMARK = 30 * 1024,
987  EVENT_LOG_LOW_WATERMARK = 20 * 1024,
988 };
989 
990 #define log_problem_data libreport_log_problem_data
991 void log_problem_data(problem_data_t *problem_data, const char *pfx);
992 
993 extern int g_libreport_inited;
994 void libreport_init(void);
995 
996 #define INITIALIZE_LIBREPORT() \
997  do \
998  { \
999  if (!g_libreport_inited) \
1000  { \
1001  g_libreport_inited = 1; \
1002  libreport_init(); \
1003  } \
1004  } \
1005  while (0)
1006 
1007 const char *abrt_init(char **argv);
1008 #define export_abrt_envvars libreport_export_abrt_envvars
1009 void export_abrt_envvars(int pfx);
1010 #define g_progname libreport_g_progname
1011 extern const char *g_progname;
1012 
1013 enum parse_opt_type {
1014  OPTION_BOOL,
1015  OPTION_GROUP,
1016  OPTION_STRING,
1017  OPTION_INTEGER,
1018  OPTION_OPTSTRING,
1019  OPTION_LIST,
1020  OPTION_END,
1021 };
1022 
1023 struct options {
1024  enum parse_opt_type type;
1025  int short_name;
1026  const char *long_name;
1027  void *value;
1028  const char *argh;
1029  const char *help;
1030 };
1031 
1032 /*
1033  * s - short_name
1034  * l - long_name
1035  * v - value
1036  * a - option parameter name (for help text)
1037  * h - help
1038  */
1039 #define OPT_END() { OPTION_END }
1040 #define OPT_GROUP(h) { OPTION_GROUP, 0, NULL, NULL, NULL, (h) }
1041 #define OPT_BOOL( s, l, v, h) { OPTION_BOOL , (s), (l), (v), NULL , (h) }
1042 #define OPT_INTEGER( s, l, v, h) { OPTION_INTEGER , (s), (l), (v), "NUM", (h) }
1043 #define OPT_STRING( s, l, v, a, h) { OPTION_STRING , (s), (l), (v), (a) , (h) }
1044 #define OPT_OPTSTRING(s, l, v, a, h) { OPTION_OPTSTRING, (s), (l), (v), (a) , (h) }
1045 #define OPT_LIST( s, l, v, a, h) { OPTION_LIST , (s), (l), (v), (a) , (h) }
1046 
1047 #define OPT__VERBOSE(v) OPT_BOOL('v', "verbose", (v), _("Be verbose"))
1048 #define OPT__DUMP_DIR(v) OPT_STRING('d', "problem-dir", (v), "DIR", _("Problem directory"))
1049 
1050 #define parse_opts libreport_parse_opts
1051 unsigned parse_opts(int argc, char **argv, const struct options *opt,
1052  const char *usage);
1053 
1054 #define show_usage_and_die libreport_show_usage_and_die
1055 void show_usage_and_die(const char *usage, const struct options *opt) NORETURN;
1056 
1057 /* Can't include "abrt_curl.h", it's not a public API.
1058  * Resorting to just forward-declaring the struct we need.
1059  */
1060 struct abrt_post_state;
1061 
1062 /* Decomposes uri to its base elements, removes userinfo out of the hostname and
1063  * composes a new uri without userinfo.
1064  *
1065  * The function does not validate the url.
1066  *
1067  * @param uri The uri that might contain userinfo
1068  * @param result The userinfo free uri will be store here. Cannot be null. Must
1069  * be de-allocated by free.
1070  * @param scheme Scheme of the uri. Can be NULL. Result can be NULL. Result
1071  * must be de-allocated by free.
1072  * @param hostname Hostname of the uri. Can be NULL. Result can be NULL. Result
1073  * must be de-allocated by free.
1074  * @param username Username of the uri. Can be NULL. Result can be NULL. Result
1075  * must be de-allocated by free.
1076  * @param password Password of the uri. Can be NULL. Result can be NULL. Result
1077  * must be de-allocated by free.
1078  * @param location Location of the uri. Can be NULL. Result is never NULL. Result
1079  * must be de-allocated by free.
1080  */
1081 #define uri_userinfo_remove libreport_uri_userinfo_remove
1082 int uri_userinfo_remove(const char *uri, char **result, char **scheme, char **hostname, char **username, char **password, char **location);
1083 
1084 #ifdef __cplusplus
1085 }
1086 #endif
1087 
1088 #endif