new option database-root
[adu.git] / adu.c
1 /*
2 * Copyright (C) 2008 Andre Noll <maan@systemlinux.org>
3 *
4 * Licensed under the GPL v2. For licencing details see COPYING.
5 */
6
7 /** \file adu.c \brief The main functions used by all modes of operation. */
8
9 /**
10 * \mainpage adu API reference
11 *
12 * - Modes of operation: \ref select.c, \ref create.c, \ref interactive.c
13 * - User handling: \ref user.c
14 * - Error handling: \ref error.h
15 * - Library-type functions: \ref fd.c, \ref format.c, \ref string.c, \ref portable_io.h
16 */
17
18 #include "adu.h"
19 #include <dirent.h> /* readdir() */
20 #include <pwd.h>
21 #include "format.h"
22 #include "user.h"
23 #include "select.cmdline.h"
24 #include "select.h"
25 #include "cmdline.h"
26 #include "fd.h"
27 #include "string.h"
28 #include "error.h"
29
30 /** Define the array of error descriptions. */
31 DEFINE_ERRLIST;
32
33 /**
34 * The error code of the last called osl library function.
35 *
36 * \sa osl().
37 */
38 int osl_errno;
39
40 /** In case a signal is received, its number is stored here. */
41 static int signum;
42
43 /** Command line and config file options. */
44 struct gengetopt_args_info conf;
45
46 /** Options passed to --select-options. */
47 struct select_args_info select_conf;
48
49 /** Computed database dir */
50 char *database_dir;
51
52 /**
53 * The table containing the directory names and statistics.
54 */
55 struct osl_table *dir_table = NULL;
56
57 static struct osl_column_description dir_table_cols[] = {
58 [DT_NAME] = {
59 .storage_type = OSL_MAPPED_STORAGE,
60 .storage_flags = 0,
61 .name = "dir",
62 },
63 [DT_NUM] = {
64 .storage_type = OSL_MAPPED_STORAGE,
65 .storage_flags = OSL_RBTREE | OSL_FIXED_SIZE | OSL_UNIQUE,
66 .name = "num",
67 .compare_function = uint64_compare,
68 .data_size = sizeof(uint64_t)
69 },
70 [DT_PARENT_NUM] = {
71 .storage_type = OSL_MAPPED_STORAGE,
72 .storage_flags = OSL_RBTREE | OSL_FIXED_SIZE | OSL_UNIQUE,
73 .name = "parent_num",
74 .compare_function = size_compare,
75 .data_size = sizeof(uint64_t)
76 },
77 [DT_BYTES] = {
78 .storage_type = OSL_MAPPED_STORAGE,
79 .storage_flags = OSL_RBTREE | OSL_FIXED_SIZE,
80 .compare_function = size_compare,
81 .name = "num_bytes",
82 .data_size = sizeof(uint64_t)
83 },
84 [DT_FILES] = {
85 .storage_type = OSL_MAPPED_STORAGE,
86 .storage_flags = OSL_RBTREE | OSL_FIXED_SIZE,
87 .compare_function = size_compare,
88 .name = "num_files",
89 .data_size = sizeof(uint64_t)
90 }
91 };
92
93 static struct osl_table_description dir_table_desc = {
94 .name = "dir_table",
95 .num_columns = NUM_DT_COLUMNS,
96 .flags = 0,
97 .column_descriptions = dir_table_cols,
98 };
99
100 /**
101 * The log function.
102 *
103 * \param ll Loglevel.
104 * \param fmt Usual format string.
105 *
106 * All XXX_LOG() macros use this function.
107 */
108 __printf_2_3 void __log(int ll, const char* fmt,...)
109 {
110 va_list argp;
111 FILE *outfd;
112 struct tm *tm;
113 time_t t1;
114 char str[255] = "";
115
116 if (ll < conf.loglevel_arg)
117 return;
118 outfd = stderr;
119 time(&t1);
120 tm = localtime(&t1);
121 strftime(str, sizeof(str), "%b %d %H:%M:%S", tm);
122 fprintf(outfd, "%s ", str);
123 va_start(argp, fmt);
124 vfprintf(outfd, fmt, argp);
125 va_end(argp);
126 }
127
128 static void close_dir_table(void)
129 {
130 int ret;
131
132 if (!dir_table)
133 return;
134 NOTICE_LOG("closing dir table\n");
135 ret = osl(osl_close_table(dir_table, OSL_MARK_CLEAN));
136 if (ret < 0)
137 ERROR_LOG("failed to close dir table: %s\n", adu_strerror(-ret));
138 free((char *)dir_table_desc.dir);
139 dir_table = NULL;
140 }
141
142 static void close_all_tables(void)
143 {
144 close_dir_table();
145 close_user_tables();
146 }
147
148 static void signal_handler(int s)
149 {
150 signum = s;
151 }
152
153 /**
154 * Check whether to terminate adu.
155 *
156 * Check whether a signal was caught that should terminate the
157 * adu process. If yes, close all osl tables and exit gracefully.
158 */
159 void check_signals(void)
160 {
161 if (likely(!signum))
162 return;
163 EMERG_LOG("caught signal %d\n", signum);
164 close_all_tables();
165 exit(EXIT_FAILURE);
166 }
167
168 static int init_signals(void)
169 {
170 if (signal(SIGINT, &signal_handler) == SIG_ERR)
171 return -E_SIGNAL_SIG_ERR;
172 if (signal(SIGTERM, &signal_handler) == SIG_ERR)
173 return -E_SIGNAL_SIG_ERR;
174 if (signal(SIGPIPE, &signal_handler) == SIG_ERR)
175 return -E_SIGNAL_SIG_ERR;
176 return 1;
177 }
178
179 /**
180 * Open the directory table.
181 *
182 * \param create If non-zero, create the table first.
183 *
184 * \return Standard.
185 */
186 int open_dir_table(int create)
187 {
188 int ret;
189
190 if (dir_table)
191 return 1;
192
193 dir_table_desc.dir = adu_strdup(database_dir);
194 if (create) {
195 INFO_LOG("creating database directory structure\n");
196 ret = mkpath(dir_table_desc.dir, 0777);
197 if (ret < 0)
198 goto out;
199 NOTICE_LOG("creating dir table\n");
200 ret = osl(osl_create_table(&dir_table_desc));
201 if (ret < 0)
202 goto out;
203 }
204 INFO_LOG("opening dir table\n");
205 return osl(osl_open_table(&dir_table_desc, &dir_table));
206 out:
207 free((char *)dir_table_desc.dir);
208 return ret;
209 }
210
211 static int check_args(void)
212 {
213 if (conf.create_given && !conf.base_dir_given)
214 return -E_SYNTAX;
215
216 /* remove trailing slashes from base-dir arg */
217 if (conf.base_dir_given) {
218 size_t len = strlen(conf.base_dir_arg);
219 for (;;) {
220 if (!len) /* empty string */
221 return -ERRNO_TO_ERROR(EINVAL);
222 if (!--len) /* length 1 is always OK */
223 break;
224 if (conf.base_dir_arg[len] != '/')
225 break; /* no trailing slash, also OK */
226 conf.base_dir_arg[len] = '\0';
227 }
228 }
229 return 1;
230 }
231
232 static void print_complete_help_and_die(void)
233 {
234 const char **line;
235
236 printf("%s-%s\n", CMDLINE_PARSER_PACKAGE, CMDLINE_PARSER_VERSION);
237 printf("%s\n\n", gengetopt_args_info_purpose);
238 printf("%s\n\n", gengetopt_args_info_usage);
239
240 if (conf.help_given)
241 line = gengetopt_args_info_help;
242 else
243 line = gengetopt_args_info_detailed_help;
244 for (; *line; line++)
245 printf("%s\n", *line);
246
247 if (conf.help_given)
248 line = select_args_info_help;
249 else
250 line = select_args_info_detailed_help;
251 printf("Select options:\n");
252 for (; *line; line++)
253 printf("%s\n", *line);
254
255 printf("Interactive commands:\n");
256 print_interactive_help();
257 cmdline_parser_free(&conf);
258 select_cmdline_parser_free(&select_conf);
259 exit(EXIT_FAILURE);
260 }
261
262 /**
263 * The main function of adu.
264 *
265 * \param argc Usual argument count.
266 * \param argv Usual argument vector.
267 *
268 * Check command line options, init the signal handlers and
269 * call the main function of the selected mode.
270 *
271 * \return \p EXIT_SUCCESS on success, \p EXIT_FAILURE otherwise.
272 */
273 int main(int argc, char **argv)
274 {
275 int ret;
276 struct cmdline_parser_params params = {
277 .override = 1,
278 .initialize = 1,
279 .check_required = 0,
280 .check_ambiguity = 0,
281 .print_errors = 0
282 };
283 select_cmdline_parser_init(&select_conf);
284 cmdline_parser_init(&conf);
285 /* ignore errors and print complete help if --help was given */
286 cmdline_parser_ext(argc, argv, &conf, &params);
287 if (conf.help_given || conf.detailed_help_given)
288 print_complete_help_and_die();
289 cmdline_parser_free(&conf);
290 params.check_required = 1;
291 params.check_ambiguity = 1;
292 params.print_errors = 1;
293 ret = cmdline_parser_ext(argc, argv, &conf, &params);
294 if (ret)
295 exit(EXIT_FAILURE);
296
297 ret = check_args();
298 if (ret < 0)
299 goto out;
300 ret = init_signals();
301 if (ret < 0)
302 goto out;
303 ret = -E_SYNTAX;
304 if (conf.database_dir_given)
305 database_dir = adu_strdup(conf.database_dir_arg);
306 else
307 database_dir = make_message("%s%s",
308 conf.database_root_arg, conf.base_dir_arg);
309 if (conf.select_given)
310 ret = com_select();
311 else if (conf.create_given)
312 ret = com_create();
313 else
314 ret = com_interactive();
315 if (ret < 0)
316 goto out;
317 out:
318 close_all_tables();
319 if (ret < 0) {
320 ERROR_LOG("%s\n", adu_strerror(-ret));
321 return -EXIT_FAILURE;
322 }
323 free(database_dir);
324 cmdline_parser_free(&conf);
325 select_cmdline_parser_free(&select_conf);
326 return EXIT_SUCCESS;
327 }