libreport  2.1.10
A tool to inform users about various problems on the running system
dump_dir.h
1 /*
2  On-disk storage of problem data
3 
4  Copyright (C) 2009 Zdenek Prikryl (zprikryl@redhat.com)
5  Copyright (C) 2009 RedHat inc.
6 
7  This program is free software; you can redistribute it and/or modify
8  it under the terms of the GNU General Public License as published by
9  the Free Software Foundation; either version 2 of the License, or
10  (at your option) any later version.
11 
12  This program is distributed in the hope that it will be useful,
13  but WITHOUT ANY WARRANTY; without even the implied warranty of
14  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15  GNU General Public License for more details.
16 
17  You should have received a copy of the GNU General Public License along
18  with this program; if not, write to the Free Software Foundation, Inc.,
19  51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
20 */
21 #ifndef LIBREPORT_DUMP_DIR_H_
22 #define LIBREPORT_DUMP_DIR_H_
23 
24 /* For DIR */
25 #include <sys/types.h>
26 #include <dirent.h>
27 
28 /* Fore GList */
29 #include <glib.h>
30 
31 #ifdef __cplusplus
32 extern "C" {
33 #endif
34 
35 /* Utility function */
36 int create_symlink_lockfile(const char *filename, const char *pid_str);
37 
38 enum {
39  DD_FAIL_QUIETLY_ENOENT = (1 << 0),
40  DD_FAIL_QUIETLY_EACCES = (1 << 1),
41  /* Open symlinks. dd_* funcs don't open symlinks by default */
42  DD_OPEN_FOLLOW = (1 << 2),
43  DD_OPEN_READONLY = (1 << 3),
44  DD_LOAD_TEXT_RETURN_NULL_ON_FAILURE = (1 << 4),
45  DD_DONT_WAIT_FOR_LOCK = (1 << 5),
46 };
47 
48 struct dump_dir {
49  char *dd_dirname;
50  DIR *next_dir;
51  int locked;
52  uid_t dd_uid;
53  gid_t dd_gid;
54  /* mode of saved files */
55  mode_t mode;
56  time_t dd_time;
57  char *dd_type;
58 };
59 
60 void dd_close(struct dump_dir *dd);
61 
62 struct dump_dir *dd_opendir(const char *dir, int flags);
63 /* Pass uid = (uid_t)-1L to disable chown'ing of newly created files
64  * (IOW: if you aren't running under root):
65  */
66 struct dump_dir *dd_create(const char *dir, uid_t uid, mode_t mode);
67 
68 void dd_create_basic_files(struct dump_dir *dd, uid_t uid, const char *chroot_dir);
69 int dd_exist(const struct dump_dir *dd, const char *path);
70 void dd_sanitize_mode_and_owner(struct dump_dir *dd);
71 
72 DIR *dd_init_next_file(struct dump_dir *dd);
73 int dd_get_next_file(struct dump_dir *dd, char **short_name, char **full_name);
74 
75 char* dd_load_text_ext(const struct dump_dir *dd, const char *name, unsigned flags);
76 char* dd_load_text(const struct dump_dir *dd, const char *name);
77 void dd_save_text(struct dump_dir *dd, const char *name, const char *data);
78 void dd_save_binary(struct dump_dir *dd, const char *name, const char *data, unsigned size);
79 /* Returns value less than 0 if any error occured; otherwise returns size of an
80  * item in Bytes. If an item does not exist returns 0 instead of an error
81  * value.
82  */
83 long dd_get_item_size(struct dump_dir *dd, const char *name);
84 /* Deletes an item from dump directory
85  * On success, zero is returned. On error, -1 is returned, and errno is set appropriately.
86  * For more about errno see unlink documentation
87  */
88 int dd_delete_item(struct dump_dir *dd, const char *name);
89 /* Returns 0 if directory is deleted or not found */
90 int dd_delete(struct dump_dir *dd);
91 int dd_rename(struct dump_dir *dd, const char *new_path);
92 /* Changes owner of dump dir
93  * Uses two different strategies selected at build time by
94  * DUMP_DIR_OWNED_BY_USER configuration:
95  * <= 0 : owner = abrt user's uid, group = new_uid's gid
96  * > 0 : owner = new_uid, group = abrt group's gid
97  *
98  * On success, zero is returned. On error, -1 is returned.
99  */
100 int dd_chown(struct dump_dir *dd, uid_t new_uid);
101 
102 
103 /* reported_to handling */
104 #define add_reported_to_data libreport_add_reported_to_data
105 int add_reported_to_data(char **reported_to, const char *line);
106 #define add_reported_to libreport_add_reported_to
107 void add_reported_to(struct dump_dir *dd, const char *line);
109  char *label;
110  char *url;
111  char *msg;
112  char *bthash;
113  /* char *whole_line; */
114  /* time_t timestamp; */
115  /* ^^^ if you add more fields, don't forget to update free_report_result() */
116 };
117 typedef struct report_result report_result_t;
118 #define free_report_result libreport_free_report_result
119 void free_report_result(struct report_result *result);
120 #define find_in_reported_to_data libreport_find_in_reported_to_data
121 report_result_t *find_in_reported_to_data(const char *reported_to, const char *report_label);
122 #define find_in_reported_to libreport_find_in_reported_to
123 report_result_t *find_in_reported_to(struct dump_dir *dd, const char *report_label);
124 #define read_entire_reported_to_data libreport_read_entire_reported_to_data
125 GList *read_entire_reported_to_data(const char* reported_to);
126 #define read_entire_reported_to libreport_read_entire_reported_to
127 GList *read_entire_reported_to(struct dump_dir *dd);
128 
129 
130 void delete_dump_dir(const char *dirname);
131 /* Checks dump dir accessibility for particular uid.
132  *
133  * If the directory doesn't exist the directory is not accessible and errno is
134  * set to ENOTDIR.
135  *
136  * Returns non zero if dump dir is accessible otherwise return 0 value.
137  */
138 int dump_dir_accessible_by_uid(const char *dirname, uid_t uid);
139 
140 enum {
141  DD_STAT_ACCESSIBLE_BY_UID = 1,
142  DD_STAT_OWNED_BY_UID = DD_STAT_ACCESSIBLE_BY_UID << 1,
143 };
144 
145 /* Gets information about a dump directory for particular uid.
146  *
147  * If the directory doesn't exist the directory is not accessible and errno is
148  * set to ENOTDIR.
149  *
150  * Returns negative number if error occurred otherwise returns 0 or positive number.
151  */
152 int dump_dir_stat_for_uid(const char *dirname, uid_t uid);
153 
154 /* creates not_reportable file in the problem directory and saves the
155  reason to it, which prevents libreport from reporting the problem
156  On success, zero is returned.
157  On error, -1 is returned and an error message is logged.
158  - this could probably happen only if the dump dir is not locked
159 */
160 int dd_mark_as_notreportable(struct dump_dir *dd, const char *reason);
161 
162 #ifdef __cplusplus
163 }
164 #endif
165 
166 #endif