libreport  2.1.7
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 #ifdef __cplusplus
29 extern "C" {
30 #endif
31 
32 /* Utility function */
33 int create_symlink_lockfile(const char *filename, const char *pid_str);
34 
35 enum {
36  DD_FAIL_QUIETLY_ENOENT = (1 << 0),
37  DD_FAIL_QUIETLY_EACCES = (1 << 1),
38  /* Open symlinks. dd_* funcs don't open symlinks by default */
39  DD_OPEN_FOLLOW = (1 << 2),
40  DD_OPEN_READONLY = (1 << 3),
41  DD_LOAD_TEXT_RETURN_NULL_ON_FAILURE = (1 << 4),
42  DD_DONT_WAIT_FOR_LOCK = (1 << 5),
43 };
44 
45 struct dump_dir {
46  char *dd_dirname;
47  DIR *next_dir;
48  int locked;
49  uid_t dd_uid;
50  gid_t dd_gid;
51  /* mode of saved files */
52  mode_t mode;
53  time_t dd_time;
54  char *dd_type;
55 };
56 
57 void dd_close(struct dump_dir *dd);
58 
59 struct dump_dir *dd_opendir(const char *dir, int flags);
60 /* Pass uid = (uid_t)-1L to disable chown'ing of newly created files
61  * (IOW: if you aren't running under root):
62  */
63 struct dump_dir *dd_create(const char *dir, uid_t uid, mode_t mode);
64 
65 void dd_create_basic_files(struct dump_dir *dd, uid_t uid, const char *chroot_dir);
66 int dd_exist(const struct dump_dir *dd, const char *path);
67 void dd_sanitize_mode_and_owner(struct dump_dir *dd);
68 
69 DIR *dd_init_next_file(struct dump_dir *dd);
70 int dd_get_next_file(struct dump_dir *dd, char **short_name, char **full_name);
71 
72 char* dd_load_text_ext(const struct dump_dir *dd, const char *name, unsigned flags);
73 char* dd_load_text(const struct dump_dir *dd, const char *name);
74 void dd_save_text(struct dump_dir *dd, const char *name, const char *data);
75 void dd_save_binary(struct dump_dir *dd, const char *name, const char *data, unsigned size);
76 /* Returns value less than 0 if any error occured; otherwise returns size of an
77  * item in Bytes. If an item does not exist returns 0 instead of an error
78  * value.
79  */
80 long dd_get_item_size(struct dump_dir *dd, const char *name);
81 /* Deletes an item from dump directory
82  * On success, zero is returned. On error, -1 is returned, and errno is set appropriately.
83  * For more about errno see unlink documentation
84  */
85 int dd_delete_item(struct dump_dir *dd, const char *name);
86 /* Returns 0 if directory is deleted or not found */
87 int dd_delete(struct dump_dir *dd);
88 int dd_rename(struct dump_dir *dd, const char *new_path);
89 /* Changes owner of dump dir
90  * Uses two different strategies selected at build time by
91  * DUMP_DIR_OWNED_BY_USER configuration:
92  * <= 0 : owner = abrt user's uid, group = new_uid's gid
93  * > 0 : owner = new_uid, group = abrt group's gid
94  *
95  * On success, zero is returned. On error, -1 is returned.
96  */
97 int dd_chown(struct dump_dir *dd, uid_t new_uid);
98 
99 
100 /* reported_to handling */
101 #define add_reported_to libreport_add_reported_to
102 void add_reported_to(struct dump_dir *dd, const char *line);
104  char *url;
105  char *msg;
106  char *bthash;
107  /* char *whole_line; */
108  /* time_t timestamp; */
109  /* ^^^ if you add more fields, don't forget to update free_report_result() */
110 };
111 typedef struct report_result report_result_t;
112 #define free_report_result libreport_free_report_result
113 void free_report_result(struct report_result *result);
114 #define find_in_reported_to libreport_find_in_reported_to
115 report_result_t *find_in_reported_to(struct dump_dir *dd, const char *prefix);
116 /* TODO: GList *read_entire_reported_to(dd); */
117 
118 
119 void delete_dump_dir(const char *dirname);
120 /* Checks dump dir accessibility for particular uid.
121  *
122  * If the directory doesn't exist the directory is not accessible and errno is
123  * set to ENOTDIR.
124  *
125  * Returns non zero if dump dir is accessible otherwise return 0 value.
126  */
127 int dump_dir_accessible_by_uid(const char *dirname, uid_t uid);
128 
129 enum {
130  DD_STAT_ACCESSIBLE_BY_UID = 1,
131  DD_STAT_OWNED_BY_UID = DD_STAT_ACCESSIBLE_BY_UID << 1,
132 };
133 
134 /* Gets information about a dump directory for particular uid.
135  *
136  * If the directory doesn't exist the directory is not accessible and errno is
137  * set to ENOTDIR.
138  *
139  * Returns negative number if error occurred otherwise returns 0 or positive number.
140  */
141 int dump_dir_stat_for_uid(const char *dirname, uid_t uid);
142 
143 /* creates not_reportable file in the problem directory and saves the
144  reason to it, which prevents libreport from reporting the problem
145  On success, zero is returned.
146  On error, -1 is returned and an error message is logged.
147  - this could probably happen only if the dump dir is not locked
148 */
149 int dd_mark_as_notreportable(struct dump_dir *dd, const char *reason);
150 
151 #ifdef __cplusplus
152 }
153 #endif
154 
155 #endif