libreport  2.14.0
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 #ifdef ENABLE_NLS
63 # include <libintl.h>
64 # define _(S) dgettext(PACKAGE, S)
65 #else
66 # define _(S) (S)
67 #endif
68 
69 #ifdef 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 /* path of user's local config, path is relative to user's home */
93 #define USER_HOME_CONFIG_PATH "/.config/libreport"
94 
95 /* Pull in entire public libreport API */
96 #include "global_configuration.h"
97 #include "dump_dir.h"
98 #include "event_config.h"
99 #include "problem_data.h"
100 #include "report.h"
101 #include "run_event.h"
102 #include "workflow.h"
103 #include "file_obj.h"
104 #include "libreport_types.h"
105 #include "reporters.h"
106 
107 #ifdef __cplusplus
108 extern "C" {
109 #endif
110 
111 char *libreport_trim_all_whitespace(const char *str);
112 char *libreport_shorten_string_to_length(const char *str, unsigned length);
113 char *libreport_strtrimch(char *str, int ch);
114 char *libreport_strremovech(char *str, int ch);
115 char *libreport_append_to_malloced_string(char *mstr, const char *append);
116 char *libreport_skip_blank(const char *s);
117 char *libreport_skip_whitespace(const char *s);
118 char *libreport_skip_non_whitespace(const char *s);
119 /* Like strcpy but can copy overlapping strings. */
120 void libreport_overlapping_strcpy(char *dst, const char *src);
121 
122 /*
123  * Used to construct a name in a different directory with the basename
124  * similar to the old name, if possible.
125  */
126 char *libreport_concat_path_basename(const char *path, const char *filename);
127 
128 /* Allows all printable characters except '/',
129  * the string must not exceed 64 characters of length
130  * and must not equal neither "." nor ".." (these strings may appear in the string) */
131 bool libreport_str_is_correct_filename(const char *str);
132 
133 /* A-la fgets, but malloced and of unlimited size */
134 char *libreport_xmalloc_fgets(FILE *file);
135 /* Similar, but removes trailing \n */
136 char *libreport_xmalloc_fgetline(FILE *file);
137 /* Useful for easy reading of various /proc files */
138 char *libreport_xmalloc_fopen_fgetline_fclose(const char *filename);
139 
140 
141 typedef enum {
142  COPYFD_SPARSE = 1 << 0,
143 } libreport_copyfd_flags;
144 
145 /* Writes up to 'size' Bytes from a file descriptor to a file in a directory
146  *
147  * If you need to write all Bytes of the file descriptor, pass 0 as the size.
148  *
149  * @param src The source file descriptor
150  * @param dir_fd A file descriptor for the parent directory of the destination file
151  * @param name The destination file name
152  * @param mode The destination file open mode
153  * @param uid The destination file's uid
154  * @param gid The destination file's gid
155  * @param open_flags The destination file open flags
156  * @param copy_flags libreport_copyfd_flags
157  * @param size The upper limit for written bytes (0 for no limit).
158  * @return Number of read Bytes on success. On errors, return -1 and prints out
159  * reasonable good error messages.
160  */
161 off_t libreport_copyfd_ext_at(int src, int dir_fd, const char *name, int mode,
162  uid_t uid, gid_t gid, int open_flags, int copy_flags, off_t size);
163 
164 /* On error, copyfd_XX prints error messages and returns -1 */
165 off_t libreport_copyfd_eof(int src_fd, int dst_fd, int flags);
166 off_t libreport_copyfd_size(int src_fd, int dst_fd, off_t size, int flags);
167 void libreport_copyfd_exact_size(int src_fd, int dst_fd, off_t size);
168 off_t libreport_copy_file_ext_2at(int src_dir_fd, const char *src_name, int dir_fd, const char *name, int mode, uid_t uid, gid_t gid, int src_flags, int dst_flags);
169 off_t libreport_copy_file_ext_at(const char *src_name, int dir_fd, const char *name, int mode, uid_t uid, gid_t gid, int src_flags, int dst_flags);
170 #define libreport_copy_file_ext(src_name, dst_name, mode, uid, gid, src_flags, dst_flags) \
171  libreport_copy_file_ext_at(src_name, AT_FDCWD, dst_name, mode, uid, gid, src_flags, dst_flags)
172 off_t libreport_copy_file(const char *src_name, const char *dst_name, int mode);
173 off_t libreport_copy_file_at(const char *src_name, int dir_fd, const char *name, int mode);
174 int libreport_copy_file_recursive(const char *source, const char *dest);
175 
176 int libreport_decompress_fd(int fdi, int fdo);
177 int libreport_decompress_file(const char *path_in, const char *path_out, mode_t mode_out);
178 int libreport_decompress_file_ext_at(const char *path_in, int dir_fd, const char *path_out,
179  mode_t mode_out, uid_t uid, gid_t gid, int src_flags, int dst_flags);
180 
181 // NB: will return short read on error, not -1,
182 // if some data was read before error occurred
183 void libreport_xread(int fd, void *buf, size_t count);
184 ssize_t libreport_safe_read(int fd, void *buf, size_t count);
185 ssize_t libreport_safe_write(int fd, const void *buf, size_t count);
186 ssize_t libreport_full_read(int fd, void *buf, size_t count);
187 ssize_t libreport_full_write(int fd, const void *buf, size_t count);
188 ssize_t libreport_full_write_str(int fd, const char *buf);
189 void *libreport_xmalloc_read(int fd, size_t *maxsz_p);
190 void *libreport_xmalloc_open_read_close(const char *filename, size_t *maxsz_p);
191 void *libreport_xmalloc_xopen_read_close(const char *filename, size_t *maxsz_p);
192 char *libreport_malloc_readlink(const char *linkname);
193 char *libreport_malloc_readlinkat(int dir_fd, const char *linkname);
194 
195 
196 /* Returns malloc'ed block */
197 char *libreport_encode_base64(const void *src, int length);
198 
199 /* Returns NULL if the string needs no sanitizing.
200  * control_chars_to_sanitize is a bit mask.
201  * If Nth bit is set, Nth control char will be sanitized (replaced by [XX]).
202  */
203 char *libreport_sanitize_utf8(const char *src, uint32_t control_chars_to_sanitize);
204 enum {
205  SANITIZE_ALL = 0xffffffff,
206  SANITIZE_TAB = (1 << 9),
207  SANITIZE_LF = (1 << 10),
208  SANITIZE_CR = (1 << 13),
209 };
210 
211 //unused for now
212 //unsigned long long monotonic_ns(void);
213 //unsigned long long monotonic_us(void);
214 //unsigned monotonic_sec(void);
215 
216 pid_t libreport_safe_waitpid(pid_t pid, int *wstat, int options);
217 
218 enum {
219  /* on return, pipefds[1] is fd to which parent may write
220  * and deliver data to child's stdin: */
221  EXECFLG_INPUT = 1 << 0,
222  /* on return, pipefds[0] is fd from which parent may read
223  * child's stdout: */
224  EXECFLG_OUTPUT = 1 << 1,
225  /* open child's stdin to /dev/null: */
226  EXECFLG_INPUT_NUL = 1 << 2,
227  /* open child's stdout to /dev/null: */
228  EXECFLG_OUTPUT_NUL = 1 << 3,
229  /* redirect child's stderr to stdout: */
230  EXECFLG_ERR2OUT = 1 << 4,
231  /* open child's stderr to /dev/null: */
232  EXECFLG_ERR_NUL = 1 << 5,
233  /* suppress perror_msg("Can't execute 'foo'") if exec fails */
234  EXECFLG_QUIET = 1 << 6,
235  EXECFLG_SETGUID = 1 << 7,
236  EXECFLG_SETSID = 1 << 8,
237  EXECFLG_SETPGID = 1 << 9,
238 };
239 /*
240  * env_vec: list of variables to set in environment (if string has
241  * "VAR=VAL" form) or unset in environment (if string has no '=' char).
242  *
243  * Returns pid.
244  */
245 pid_t libreport_fork_execv_on_steroids(int flags,
246  char **argv,
247  int *pipefds,
248  char **env_vec,
249  const char *dir,
250  uid_t uid);
251 /* Returns malloc'ed string. NULs are retained, and extra one is appended
252  * after the last byte (this NUL is not accounted for in *size_p) */
253 char *libreport_run_in_shell_and_save_output(int flags,
254  const char *cmd,
255  const char *dir,
256  size_t *size_p);
257 
258 /* Random utility functions */
259 
260 bool libreport_is_in_string_list(const char *name, const char *const *v);
261 
262 int libreport_index_of_string_in_list(const char *name, const char *const *v);
263 
264 bool libreport_is_in_comma_separated_list(const char *value, const char *list);
265 bool libreport_is_in_comma_separated_list_of_glob_patterns(const char *value, const char *list);
266 
267 /* Calls GLib version appropriate initialization function.
268  */
269 void libreport_glib_init(void);
270 
271 double libreport_get_dirsize(const char *pPath);
272 double libreport_get_dirsize_find_largest_dir(
273  const char *pPath,
274  char **worst_dir, /* can be NULL */
275  const char *excluded, /* can be NULL */
276  const char *proc_dir /* can be NULL */
277 );
278 
279 int libreport_ndelay_on(int fd);
280 int libreport_ndelay_off(int fd);
281 int libreport_close_on_exec_on(int fd);
282 
283 char *libreport_xstrdup_between(const char *s, const char *open, const char *close);
284 
285 int libreport_xdup(int from);
286 void libreport_xdup2(int from, int to);
287 void libreport_xmove_fd(int from, int to);
288 
289 void libreport_xwrite(int fd, const void *buf, size_t count);
290 void libreport_xwrite_str(int fd, const char *str);
291 
292 off_t libreport_xlseek(int fd, off_t offset, int whence);
293 
294 char *libreport_xvasprintf(const char *format, va_list p);
295 
296 /*
297  * Utility function to unsetenv a string which was possibly putenv'ed.
298  * The problem here is that "natural" optimization:
299  * strchrnul(var_val, '=')[0] = '\0';
300  * unsetenv(var_val);
301  * is BUGGY: if string was put into environment via putenv,
302  * its modification (s/=/NUL/) is illegal, and unsetenv will fail to unset it.
303  * Of course, saving/restoring the char wouldn't work either.
304  * This helper creates a copy up to '=', unsetenv's it, and frees:
305  */
306 void libreport_safe_unsetenv(const char *var_val);
307 
308 int libreport_xsocket(int domain, int type, int protocol);
309 void libreport_xbind(int sockfd, struct sockaddr *my_addr, socklen_t addrlen);
310 void libreport_xlisten(int s, int backlog);
311 ssize_t libreport_xsendto(int s, const void *buf, size_t len,
312  const struct sockaddr *to, socklen_t tolen);
313 
314 off_t libreport_fstat_st_size_or_die(int fd);
315 off_t libreport_stat_st_size_or_die(const char *filename);
316 
317 int libreport_xopen3(const char *pathname, int flags, int mode);
318 void libreport_xunlinkat(int dir_fd, const char *pathname, int flags);
319 
320 /* Just testing dent->d_type == DT_REG is wrong: some filesystems
321  * do not report the type, they report DT_UNKNOWN for every dirent
322  * (and this is not a bug in filesystem, this is allowed by standards).
323  * This function handles this case. Note: it returns 0 on symlinks
324  * even if they point to regular files.
325  */
326 int libreport_is_regular_file(struct dirent *dent, const char *dirname);
327 int libreport_is_regular_file_at(struct dirent *dent, int dir_fd);
328 
329 bool libreport_dot_or_dotdot(const char *filename);
330 char *libreport_last_char_is(const char *s, int c);
331 
332 bool libreport_string_to_bool(const char *s);
333 
334 void libreport_xseteuid(uid_t euid);
335 void libreport_xsetegid(gid_t egid);
336 void libreport_xsetreuid(uid_t ruid, uid_t euid);
337 void libreport_xsetregid(gid_t rgid, gid_t egid);
338 
339 FILE *libreport_xfdopen(int fd, const char *mode);
340 
341 /* Emit a string of hex representation of bytes */
342 char *libreport_bin2hex(char *dst, const char *str, int count);
343 /* Convert "xxxxxxxx" hex string to binary, no more than COUNT bytes */
344 char* libreport_hex2bin(char *dst, const char *str, int count);
345 
346 
347 enum {
348  LOGMODE_NONE = 0,
349  LOGMODE_STDIO = (1 << 0),
350  LOGMODE_SYSLOG = (1 << 1),
351  LOGMODE_BOTH = LOGMODE_SYSLOG + LOGMODE_STDIO,
352  LOGMODE_CUSTOM = (1 << 2),
353  LOGMODE_JOURNAL = (1 << 3),
354 };
355 
356 enum libreport_diemode {
357  DIEMODE_EXIT = 0,
358  DIEMODE_ABORT = 1,
359 };
360 
361 extern void (*libreport_g_custom_logger)(const char*);
362 extern const char *libreport_msg_prefix;
363 extern const char *libreport_msg_eol;
364 extern int libreport_logmode;
365 extern int libreport_xfunc_error_retval;
366 
367 /* A few magic exit codes */
368 #define EXIT_CANCEL_BY_USER 69
369 #define EXIT_STOP_EVENT_RUN 70
370 
371 void libreport_set_xfunc_error_retval(int retval);
372 
373 void libreport_set_xfunc_diemode(enum libreport_diemode mode);
374 
375 /* Verbosity level */
376 extern int libreport_g_verbose;
377 /* VERB1 log_warning("what you sometimes want to see, even on a production box") */
378 #define VERB1 if (libreport_g_verbose >= 1)
379 /* VERB2 log_warning("debug message, not going into insanely small details") */
380 #define VERB2 if (libreport_g_verbose >= 2)
381 /* VERB3 log_warning("lots and lots of details") */
382 #define VERB3 if (libreport_g_verbose >= 3)
383 /* there is no level > 3 */
384 
385 void libreport_xfunc_die(void) NORETURN;
386 
387 void libreport_die_out_of_memory(void) NORETURN;
388 
389 /* It's a macro, not function, since it collides with log_warning() from math.h */
390 #undef log
391 #define log_warning(...) log_standard(LOG_WARNING, __FILE__, __LINE__, __func__, __VA_ARGS__)
392 #define log_debug(...) log_standard(LOG_DEBUG, __FILE__, __LINE__, __func__, __VA_ARGS__)
393 #define log_info(...) log_standard(LOG_INFO, __FILE__, __LINE__, __func__, __VA_ARGS__)
394 #define log_notice(...) log_standard(LOG_NOTICE, __FILE__, __LINE__, __func__, __VA_ARGS__)
395 #define log_warning(...) log_standard(LOG_WARNING, __FILE__, __LINE__, __func__, __VA_ARGS__)
396 #define log_error(...) log_standard(LOG_ERR, __FILE__, __LINE__, __func__, __VA_ARGS__)
397 
398 // specific subsystem debugging
399 #define log_parser(...) if(0) log_debug(__VA_ARGS__)
400 
401 #define log_standard(level, file, line, func, ...) log_wrapper(level, __FILE__, __LINE__, __func__, false, false, __VA_ARGS__)
402 
403 // level, file, line, func, perror, custom logger, format & args
404 #define log_error_and_die(...) log_wrapper(LOG_ERR, __FILE__, __LINE__, __func__, false, false,__VA_ARGS__)
405 #define log_perror(...) log_wrapper(LOG_ERR, __FILE__, __LINE__, __func__, true, false, __VA_ARGS__)
406 #define log_perror_and_die(...) log_wrapper(LOG_ERR, __FILE__, __LINE__, __func__, true, false, __VA_ARGS__)
407 
408 #define error_msg(...) log_wrapper(LOG_ERR, __FILE__, __LINE__, __func__, false, true, __VA_ARGS__)
409 #define perror_msg(...) log_wrapper(LOG_ERR, __FILE__, __LINE__, __func__, true, true, __VA_ARGS__)
410 #define warn_msg(...) log_wrapper(LOG_WARNING, __FILE__, __LINE__, __func__, false, true, __VA_ARGS__)
411 #define pwarn_msg(...) log_wrapper(LOG_WARNING, __FILE__, __LINE__, __func__, true, true, __VA_ARGS__)
412 #define notice_msg(...) log_wrapper(LOG_NOTICE, __FILE__, __LINE__, __func__, false, true, __VA_ARGS__)
413 #define pnotice_msg(...) log_wrapper(LOG_NOTICE, __FILE__, __LINE__, __func__, true, true, __VA_ARGS__)
414 #define error_msg_and_die(...) log_and_die_wrapper(LOG_ERR, __FILE__, __LINE__, __func__, false, true, __VA_ARGS__)
415 #define perror_msg_and_die(...) log_and_die_wrapper(LOG_ERR, __FILE__, __LINE__, __func__, true, true, __VA_ARGS__)
416 
417 
418 void log_wrapper(int level,
419  const char *file,
420  int line,
421  const char *func,
422  bool process_perror,
423  bool use_custom_logger,
424  const char *format, ...) __attribute__ ((format (printf, 7,8)));
425 
426 void log_and_die_wrapper(int level,
427  const char *file,
428  int line,
429  const char *func,
430  bool process_perror,
431  bool use_custom_logger,
432  const char *format, ...) __attribute__ ((noreturn, format (printf, 7,8)));
433 
434 
439 GString *libreport_strbuf_append_strfv(GString *strbuf,
440  const char *format, va_list p);
441 
447 GString *libreport_strbuf_prepend_strf(GString *strbuf,
448  const char *format, ...);
449 
454 GString *libreport_strbuf_prepend_strfv(GString *strbuf,
455  const char *format, va_list p);
456 
457 /* Returns command line of running program.
458  * Caller is responsible to free() the returned value.
459  * If the pid is not valid or command line can not be obtained,
460  * empty string is returned.
461  */
462 int libreport_open_proc_pid_dir(pid_t pid);
463 char *libreport_get_cmdline_at(pid_t pid);
464 char *libreport_get_cmdline(pid_t pid);
465 char *libreport_get_environ_at(pid_t pid);
466 char *libreport_get_environ(pid_t pid);
467 char *libreport_get_executable_at(pid_t pid);
468 char *libreport_get_executable(pid_t pid);
469 char *libreport_get_cwd_at(pid_t pid);
470 char *libreport_get_cwd(pid_t pid);
471 char *libreport_get_rootdir_at(pid_t pid);
472 char *libreport_get_rootdir(pid_t pid);
473 
474 int libreport_get_fsuid(const char *proc_pid_status);
475 int libreport_get_fsgid(const char *proc_pid_status);
476 int libreport_dump_fd_info_at(int pid_proc_fd, FILE *dest);
477 int libreport_dump_fd_info_ext(const char *dest_filename, const char *proc_pid_fd_path, uid_t uid, gid_t gid);
478 int libreport_dump_fd_info(const char *dest_filename, const char *proc_pid_fd_path);
479 int libreport_get_env_variable_ext(int fd, char delim, const char *name, char **value);
480 int libreport_get_env_variable(pid_t pid, const char *name, char **value);
481 
482 #define PROC_NS_UNSUPPORTED ((ino_t)-1)
483 #define PROC_NS_ID_CGROUP 0
484 #define PROC_NS_ID_IPC 1
485 #define PROC_NS_ID_MNT 2
486 #define PROC_NS_ID_NET 3
487 #define PROC_NS_ID_PID 4
488 #define PROC_NS_ID_TIME 6
489 #define PROC_NS_ID_USER 8
490 #define PROC_NS_ID_UTS 9
491 static const char * libreport_proc_namespaces[] = {
492  "cgroup",
493  "ipc",
494  "mnt",
495  "net",
496  "pid",
497  "pid_for_children",
498  "time",
499  "time_for_children",
500  "user",
501  "uts",
502 };
503 
504 struct ns_ids {
505  ino_t nsi_ids[ARRAY_SIZE(libreport_proc_namespaces)];
506 };
507 
508 int libreport_get_ns_ids_at(int pid_proc_fd, struct ns_ids *ids);
509 int libreport_get_ns_ids(pid_t pid, struct ns_ids *ids);
510 
511 /* These functions require a privileged user and does not work correctly in
512  * processes running in own PID namespace
513  */
514 int libreport_process_has_own_root_at(int proc_pid_fd);
515 int libreport_process_has_own_root(pid_t pid);
516 
517 int libreport_get_pid_of_container_at(int pid_proc_fd, pid_t *init_pid);
518 int libreport_get_pid_of_container(pid_t pid, pid_t *init_pid);
519 int libreport_dump_namespace_diff_at(int base_pid_proc_fd, int tested_pid_proc_fd, FILE *dest);
520 int libreport_dump_namespace_diff_ext(const char *dest_filename, pid_t base_pid, pid_t tested_pid, uid_t uid, gid_t gid);
521 int libreport_dump_namespace_diff(const char *dest_filename, pid_t base_pid, pid_t tested_pid);
522 
523 enum
524 {
525  MOUNTINFO_INDEX_MOUNT_ID,
526  MOUNTINFO_INDEX_PARENT_ID,
527  MOUNTINFO_INDEX_MAJOR_MINOR,
528  MOUNTINFO_INDEX_ROOT,
529  MOUNTINFO_INDEX_MOUNT_POINT,
530  MOUNTINFO_INDEX_MOUNT_OPTIONS,
531  MOUNTINFO_INDEX_OPTIONAL_FIELDS,
532  MOUNTINFO_INDEX_FS_TYPE,
533  MOUNTINFO_INDEX_MOUNT_SOURCE,
534  MOUNTINFO_INDEX_SUPER_OPITONS,
535  _MOUNTINFO_INDEX_MAX,
536 };
537 
538 #define MOUNTINFO_ROOT(val) (val.mntnf_items[MOUNTINFO_INDEX_ROOT])
539 #define MOUNTINFO_MOUNT_POINT(val) (val.mntnf_items[MOUNTINFO_INDEX_MOUNT_POINT])
540 #define MOUNTINFO_MOUNT_SOURCE(val) (val.mntnf_items[MOUNTINFO_INDEX_MOUNT_SOURCE])
541 
542 struct mountinfo
543 {
544  /* 4 : root of the mount within the filesystem */
545  /* 5 : mount point relative to the process's root */
546  /* 10 : mount source: filesystem specific information or "none" */
547  /* but it mount source is preceded by 0 or more optional fields */
548  /* so the effective value is 9 */
549  char *mntnf_items[_MOUNTINFO_INDEX_MAX];
550 };
551 void libreport_mountinfo_destroy(struct mountinfo *mntnf);
552 int libreport_get_mountinfo_for_mount_point(FILE *fin, struct mountinfo *mntnf, const char *mnt_point);
553 
554 /* Takes ptr to time_t, or NULL if you want to use current time.
555  * Returns "YYYY-MM-DD-hh:mm:ss" string.
556  */
557 char *libreport_iso_date_string(const time_t *pt);
558 #define LIBREPORT_ISO_DATE_STRING_SAMPLE "YYYY-MM-DD-hh:mm:ss"
559 #define LIBREPORT_ISO_DATE_STRING_FORMAT "%Y-%m-%d-%H:%M:%S"
560 
561 /* Parses date into integer UNIX time stamp
562  *
563  * @param date The parsed date string
564  * @param pt Return value
565  * @return 0 on success; otherwise non-0 number. -EINVAL if the parameter date
566  * does not match LIBREPORT_ISO_DATE_STRING_FORMAT
567  */
568 int libreport_iso_date_string_parse(const char *date, time_t *pt);
569 
570 enum {
571  MAKEDESC_SHOW_FILES = (1 << 0),
572  MAKEDESC_SHOW_MULTILINE = (1 << 1),
573  MAKEDESC_SHOW_ONLY_LIST = (1 << 2),
574  MAKEDESC_WHITELIST = (1 << 3),
575  /* Include all URLs from FILENAME_REPORTED_TO element in the description text */
576  MAKEDESC_SHOW_URLS = (1 << 4),
577 };
578 char *libreport_make_description(problem_data_t *problem_data, char **names_to_skip, unsigned max_text_size, unsigned desc_flags);
579 char *libreport_make_description_logger(problem_data_t *problem_data, unsigned max_text_size);
580 
581 /* See man os-release(5) for details */
582 #define OSINFO_ID "ID"
583 #define OSINFO_NAME "NAME"
584 #define OSINFO_VERSION_ID "VERSION_ID"
585 #define OSINFO_PRETTY_NAME "PRETTY_NAME"
586 
587 /* @brief Loads a text in format of os-release(5) in to a map
588  *
589  * Function doesn't check for format errors much. It just tries to avoid
590  * program errors. In case of error the function prints out a log message and
591  * continues in parsing.
592  *
593  * @param osinfo_bytes Non-NULL pointer to osinfo bytes.
594  * @param osinfo The map where result is stored
595  */
596 void libreport_parse_osinfo(const char *osinfo_bytes, GHashTable *osinfo);
597 
598 /* @brief Builds product string and product's version string for Bugzilla
599  *
600  * At first tries to get strings from the os specific variables
601  * (REDHAT_BUGZILLA_PRODUCT, REDHAT_BUGZILLA_PRODUCT_VERSION) if no such
602  * variables are found, uses NAME key for the product and VERSION_ID key for
603  * the product's version. If neither NAME nor VERSION_ID are provided fallbacks
604  * to parsing of os_release which should be stored under PRETTY_NAME key.
605  *
606  * https://bugzilla.redhat.com/show_bug.cgi?id=950373
607  *
608  * @param osinfo Input data from which the values are built
609  * @param produc Non-NULL pointer where pointer to malloced string will be stored. Memory must be released by free()
610  * @param version Non-NULL pointer where pointer to malloced string will be stored. Memory must be released by free()
611  */
612 void libreport_parse_osinfo_for_bz(GHashTable *osinfo, char **product, char **version);
613 
614 /* @brief Extract BUG_REPORT_URL from os-release
615  *
616  * A default location for bug reports can be stored in os-release.
617  * This extracts the value if present and stores it in url.
618  * If unset, url will become NULL
619  *
620  * https://github.com/abrt/libreport/issues/459
621  *
622  * @param osinfo Input data from which the values are built
623  * @param url Non-NULL pointer where pointer to malloced string will be stored. Memory must be released by free()
624  */
625 void libreport_parse_osinfo_for_bug_url(GHashTable *osinfo, char** url);
626 
627 void libreport_parse_release_for_bz(const char *pRelease, char **product, char **version);
628 
643 bool libreport_load_conf_file(const char *pPath, GHashTable *settings, bool skipKeysWithoutValue);
644 bool libreport_load_plugin_conf_file(const char *name, GHashTable *settings, bool skipKeysWithoutValue);
645 
646 const char *libreport_get_user_conf_base_dir(void);
647 
648 bool libreport_load_conf_file_from_dirs(const char *base_name, const char *const *directories, GHashTable *settings, bool skipKeysWithoutValue);
649 
650 enum {
651  CONF_DIR_FLAG_NONE = 0,
652  CONF_DIR_FLAG_OPTIONAL = 1,
653 };
654 
655 bool libreport_load_conf_file_from_dirs_ext(const char *base_name, const char *const *directories,
656  const int * dir_flags, GHashTable *settings,
657  bool skipKeysWithoutValue);
658 
659 bool libreport_save_conf_file(const char *path, GHashTable *settings);
660 bool libreport_save_plugin_conf_file(const char *name, GHashTable *settings);
661 
662 bool libreport_save_app_conf_file(const char* application_name, GHashTable *settings);
663 bool libreport_load_app_conf_file(const char *application_name, GHashTable *settings);
664 void libreport_set_app_user_setting(GHashTable *settings, const char *name, const char *value);
665 const char *libreport_get_app_user_setting(GHashTable *settings, const char *name);
666 
667 bool libreport_save_user_settings(void);
668 bool libreport_load_user_settings(const char *application_name);
669 void libreport_set_user_setting(const char *name, const char *value);
670 const char *libreport_get_user_setting(const char *name);
671 
672 /* filename is expected to exist in CONF_DIR
673  * usually /etc/libreport
674  */
675 GList *libreport_load_words_from_file(const char *filename);
676 GList *libreport_get_file_list(const char *path, const char *ext);
677 void libreport_free_file_list(GList *filelist);
678 file_obj_t *libreport_new_file_obj(const char* fullpath, const char* filename);
679 void libreport_free_file_obj(file_obj_t *f);
680 GList *libreport_parse_delimited_list(const char *string, const char *delimiter);
681 
682 /* Connect to abrtd over unix domain socket, issue DELETE command */
683 int delete_dump_dir_possibly_using_abrtd(const char *dump_dir_name);
684 
685 /* Tries to create a copy of dump_dir_name in base_dir, with same or similar basename.
686  * Returns NULL if copying failed. In this case, logs a message before returning. */
687 struct dump_dir *libreport_steal_directory(const char *base_dir, const char *dump_dir_name);
688 
689 /* Resolves if the given user is in given group
690  *
691  * @param uid user ID
692  * @param gid group ID
693  * @returns TRUE in case the user is in the group otherwise returns FALSE
694  */
695 bool libreport_uid_in_group(uid_t uid, gid_t gid);
696 
697 /* Tries to open dump_dir_name with writing access. If function needs to steal
698  * directory calls ask_continue(new base dir, dump dir) callback to ask user
699  * for permission. If ask_continue param is NULL the function thinks that an
700  * answer is positive and steals directory.
701  * Returns NULL if opening failed or if stealing was dismissed. In this case,
702  * logs a message before returning. */
703 struct dump_dir *libreport_open_directory_for_writing(
704  const char *dump_dir_name,
705  bool (*ask_continue)(const char *, const char *));
706 
707 // Files bigger than this are never considered to be text.
708 //
709 // Started at 64k limit. But _some_ limit is necessary:
710 // fields declared "text" may end up in editing fields and such.
711 // We don't want to accidentally end up with 100meg text in a textbox!
712 // So, don't remove this. If you really need to, raise the limit.
713 //
714 // Bumped up to 200k: saw 124740 byte /proc/PID/smaps file
715 // Bumped up to 500k: saw 375252 byte anaconda traceback file
716 // Bumped up to 1M: bugzilla.redhat.com/show_bug.cgi?id=746727
717 // mentions 853646 byte anaconda-tb-* file.
718 // Bumped up to 8M: bugzilla.redhat.com/show_bug.cgi?id=887570
719 // (anaconda-tb file of 1.38 MBytes)
720 //
721 #define CD_MAX_TEXT_SIZE (8*1024*1024)
722 
723 // Text bigger than this usually is attached, not added inline
724 // was 2k, 20kb is too much, let's try 4kb
725 //
726 // For bug databases
727 #define CD_TEXT_ATT_SIZE_BZ (4*1024)
728 // For dumping problem data into a text file, email, etc
729 #define CD_TEXT_ATT_SIZE_LOGGER (CD_MAX_TEXT_SIZE)
730 
731 // Filenames in problem directory:
732 // filled by a hook:
733 #define FILENAME_TIME "time" /* mandatory */
734 #define FILENAME_LAST_OCCURRENCE "last_occurrence" /* optional */
735 #define FILENAME_REASON "reason" /* mandatory? */
736 #define FILENAME_UID "uid" /* mandatory? */
737 
738 /*
739  * "analyzer" is to be gradually changed to "type":
740  * For now, we fetch and look at "analyzer" element,
741  * but we always save both "analyzer" and "type" (with same contents).
742  * By 2013, we switch to looking at "type". Then we will stop generating
743  * "analyzer" element.
744  * ----
745  * Update 2015: based on the recent changes where we have introduced several
746  * tools generating one problem type, we have decided to retain 'analyzer'
747  * file, but it shall contain string identifier of a tool that created the
748  * problem.
749  */
750 #define FILENAME_ANALYZER "analyzer"
751 #define FILENAME_TYPE "type"
752 #define FILENAME_EXECUTABLE "executable"
753 #define FILENAME_PID "pid"
754 #define FILENAME_TID "tid"
755 #define FILENAME_GLOBAL_PID "global_pid"
756 #define FILENAME_PWD "pwd"
757 #define FILENAME_ROOTDIR "rootdir"
758 #define FILENAME_BINARY "binary"
759 #define FILENAME_CMDLINE "cmdline"
760 #define FILENAME_COREDUMP "coredump"
761 #define FILENAME_CGROUP "cgroup"
762 #define FILENAME_BACKTRACE "backtrace"
763 #define FILENAME_MAPS "maps"
764 #define FILENAME_SMAPS "smaps"
765 #define FILENAME_PROC_PID_STATUS "proc_pid_status"
766 #define FILENAME_ENVIRON "environ"
767 #define FILENAME_LIMITS "limits"
768 #define FILENAME_OPEN_FDS "open_fds"
769 #define FILENAME_MOUNTINFO "mountinfo"
770 #define FILENAME_NAMESPACES "namespaces"
771 #define FILENAME_CPUINFO "cpuinfo"
772 
773 /* Global problem identifier which is usually generated by some "analyze_*"
774  * event because it may take a lot of time to obtain strong problem
775  * identification */
776 #define FILENAME_DUPHASH "duphash"
777 
778 // Name of the function where the application crashed.
779 // Optional.
780 #define FILENAME_CRASH_FUNCTION "crash_function"
781 #define FILENAME_ARCHITECTURE "architecture"
782 #define FILENAME_KERNEL "kernel"
783 /*
784  * From /etc/os-release
785  * os_release filename name is alredy occupied by /etc/redhat-release (see
786  * below) in sake of backward compatibility /etc/os-release is stored in
787  * os_info file
788  */
789 #define FILENAME_OS_INFO "os_info"
790 #define FILENAME_OS_INFO_IN_ROOTDIR "os_info_in_rootdir"
791 // From /etc/system-release or /etc/redhat-release
792 #define FILENAME_OS_RELEASE "os_release"
793 #define FILENAME_OS_RELEASE_IN_ROOTDIR "os_release_in_rootdir"
794 // Filled by <what?>
795 #define FILENAME_PACKAGE "package"
796 #define FILENAME_COMPONENT "component"
797 #define FILENAME_COMMENT "comment"
798 #define FILENAME_RATING "backtrace_rating"
799 #define FILENAME_HOSTNAME "hostname"
800 // Optional. Set to "1" by abrt-handle-upload for every unpacked dump
801 #define FILENAME_REMOTE "remote"
802 #define FILENAME_TAINTED "kernel_tainted"
803 #define FILENAME_TAINTED_SHORT "kernel_tainted_short"
804 #define FILENAME_TAINTED_LONG "kernel_tainted_long"
805 #define FILENAME_VMCORE "vmcore"
806 #define FILENAME_KERNEL_LOG "kernel_log"
807 // File created by createAlertSignature() from libreport's python module
808 // The file should contain a description of an alert
809 #define FILENAME_DESCRIPTION "description"
810 
811 /* Local problem identifier (weaker than global identifier) designed for fast
812  * local for fast local duplicate identification. This file is usually provided
813  * by crashed application (problem creator).
814  */
815 #define FILENAME_UUID "uuid"
816 
817 #define FILENAME_COUNT "count"
818 /* Multi-line list of places problem was reported.
819  * Recommended line format:
820  * "Reporter: VAR=VAL VAR=VAL"
821  * Use libreport_add_reported_to(dd, "line_without_newline"): it adds line
822  * only if it is not already there.
823  */
824 #define FILENAME_REPORTED_TO "reported_to"
825 #define FILENAME_EVENT_LOG "event_log"
826 /*
827  * If exists, should contain a full sentence (with trailing period)
828  * which describes why this problem should not be reported.
829  * Example: "Your laptop firmware 1.9a is buggy, version 1.10 contains the fix."
830  */
831 #define FILENAME_NOT_REPORTABLE "not-reportable"
832 #define FILENAME_CORE_BACKTRACE "core_backtrace"
833 #define FILENAME_REMOTE_RESULT "remote_result"
834 #define FILENAME_PKG_EPOCH "pkg_epoch"
835 #define FILENAME_PKG_NAME "pkg_name"
836 #define FILENAME_PKG_VERSION "pkg_version"
837 #define FILENAME_PKG_RELEASE "pkg_release"
838 #define FILENAME_PKG_ARCH "pkg_arch"
839 
840 /* RHEL packages - Red Hat, Inc. */
841 #define FILENAME_PKG_VENDOR "pkg_vendor"
842 /* RHEL keys - https://access.redhat.com/security/team/key */
843 #define FILENAME_PKG_FINGERPRINT "pkg_fingerprint"
844 
845 #define FILENAME_USERNAME "username"
846 #define FILENAME_ABRT_VERSION "abrt_version"
847 #define FILENAME_EXPLOITABLE "exploitable"
848 
849 /* reproducible element is used by functions from problem_data.h */
850 #define FILENAME_REPRODUCIBLE "reproducible"
851 #define FILENAME_REPRODUCER "reproducer"
852 
853 /* File names related to Anaconda problems
854  */
855 #define FILENAME_KICKSTART_CFG "ks.cfg"
856 #define FILENAME_ANACONDA_TB "anaconda-tb"
857 
858 /* Containers
859  */
860 #define FILENAME_CONTAINER "container"
861 #define FILENAME_CONTAINER_ID "container_id"
862 #define FILENAME_CONTAINER_UUID "container_uuid"
863 #define FILENAME_CONTAINER_IMAGE "container_image"
864 #define FILENAME_CONTAINER_CMDLINE "container_cmdline"
865 /* Container root file-system directory as seen from the host. */
866 #define FILENAME_CONTAINER_ROOTFS "container_rootfs"
867 #define FILENAME_DOCKER_INSPECT "docker_inspect"
868 
869 /* Type of catched exception
870  * Optional.
871  */
872 #define FILENAME_EXCEPTION_TYPE "exception_type"
873 
874 // Not stored as files, added "on the fly":
875 #define CD_DUMPDIR "Directory"
876 
877 gint libreport_cmp_problem_data(gconstpointer a, gconstpointer b, gpointer filename);
878 
879 //UNUSED:
882 //#define CD_EVENTS "Events"
883 
884 /* FILENAME_EVENT_LOG is trimmed to below LOW_WATERMARK
885  * when it reaches HIGH_WATERMARK size
886  */
887 enum {
888  EVENT_LOG_HIGH_WATERMARK = 30 * 1024,
889  EVENT_LOG_LOW_WATERMARK = 20 * 1024,
890 };
891 
892 void libreport_log_problem_data(problem_data_t *problem_data, const char *pfx);
893 
894 extern int g_libreport_inited;
895 void libreport_init(void);
896 
897 #define INITIALIZE_LIBREPORT() \
898  do \
899  { \
900  if (!g_libreport_inited) \
901  { \
902  g_libreport_inited = 1; \
903  libreport_init(); \
904  } \
905  } \
906  while (0)
907 
908 const char *abrt_init(char **argv);
909 void libreport_export_abrt_envvars(int pfx);
910 extern const char *libreport_g_progname;
911 
912 enum parse_opt_type {
913  OPTION_BOOL,
914  OPTION_GROUP,
915  OPTION_STRING,
916  OPTION_INTEGER,
917  OPTION_OPTSTRING,
918  OPTION_LIST,
919  OPTION_END,
920 };
921 
922 struct options {
923  enum parse_opt_type type;
924  int short_name;
925  const char *long_name;
926  void *value;
927  const char *argh;
928  const char *help;
929 };
930 
931 /*
932  * s - short_name
933  * l - long_name
934  * v - value
935  * a - option parameter name (for help text)
936  * h - help
937  */
938 #define OPT_END() { OPTION_END, 0, NULL, NULL, NULL, NULL }
939 #define OPT_GROUP(h) { OPTION_GROUP, 0, NULL, NULL, NULL, (h) }
940 #define OPT_BOOL( s, l, v, h) { OPTION_BOOL , (s), (l), (v), NULL , (h) }
941 #define OPT_INTEGER( s, l, v, h) { OPTION_INTEGER , (s), (l), (v), "NUM", (h) }
942 #define OPT_STRING( s, l, v, a, h) { OPTION_STRING , (s), (l), (v), (a) , (h) }
943 #define OPT_OPTSTRING(s, l, v, a, h) { OPTION_OPTSTRING, (s), (l), (v), (a) , (h) }
944 #define OPT_LIST( s, l, v, a, h) { OPTION_LIST , (s), (l), (v), (a) , (h) }
945 
946 #define OPT__VERBOSE(v) OPT_BOOL('v', "verbose", (v), _("Be verbose"))
947 #define OPT__DUMP_DIR(v) OPT_STRING('d', "problem-dir", (v), "DIR", _("Problem directory"))
948 
949 unsigned libreport_parse_opts(int argc, char **argv, const struct options *opt,
950  const char *usage);
951 
952 void libreport_show_usage_and_die(const char *usage, const struct options *opt) NORETURN;
953 
954 /* Can't include "abrt_curl.h", it's not a public API.
955  * Resorting to just forward-declaring the struct we need.
956  */
957 struct abrt_post_state;
958 
959 /* Decomposes uri to its base elements, removes userinfo out of the hostname and
960  * composes a new uri without userinfo.
961  *
962  * The function does not validate the url.
963  *
964  * @param uri The uri that might contain userinfo
965  * @param result The userinfo free uri will be store here. Cannot be null. Must
966  * be de-allocated by free.
967  * @param scheme Scheme of the uri. Can be NULL. Result can be NULL. Result
968  * must be de-allocated by free.
969  * @param hostname Hostname of the uri. Can be NULL. Result can be NULL. Result
970  * must be de-allocated by free.
971  * @param username Username of the uri. Can be NULL. Result can be NULL. Result
972  * must be de-allocated by free.
973  * @param password Password of the uri. Can be NULL. Result can be NULL. Result
974  * must be de-allocated by free.
975  * @param location Location of the uri. Can be NULL. Result is never NULL. Result
976  * must be de-allocated by free.
977  */
978 int libreport_uri_userinfo_remove(const char *uri, char **result, char **scheme, char **hostname, char **username, char **password, char **location);
979 
980 #ifdef __cplusplus
981 }
982 #endif
983 
984 #endif