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