[btr:] Add btr_log_tree().
[paraslash.git] / filter.c
1 /*
2 * Copyright (C) 2005-2009 Andre Noll <maan@systemlinux.org>
3 *
4 * Licensed under the GPL v2. For licencing details see COPYING.
5 */
6
7 /** \file filter.c The stand-alone filter program. */
8
9 #include <regex.h>
10 #include <stdbool.h>
11
12 #include "para.h"
13 #include "filter.cmdline.h"
14 #include "list.h"
15 #include "sched.h"
16 #include "ggo.h"
17 #include "buffer_tree.h"
18 #include "filter.h"
19 #include "string.h"
20 #include "stdin.h"
21 #include "stdout.h"
22 #include "error.h"
23
24 /** The list of all status items used by para_{server,audiod,gui}. */
25 const char *status_item_list[] = {STATUS_ITEM_ARRAY};
26
27 char *stat_item_values[NUM_STAT_ITEMS] = {NULL};
28
29 /** Initialize the array of errors for para_filter. */
30 INIT_FILTER_ERRLISTS;
31
32 /** The task that reads from stdin. */
33 static struct stdin_task stdin_task_struct;
34 /** pointer to the stdin task. */
35 static struct stdin_task *sit = &stdin_task_struct;
36
37 /** The task that filters the data. */
38 static struct filter_chain filter_chain_struct;
39 /** Pointer to the filter chain. */
40 static struct filter_chain *fc = &filter_chain_struct;
41
42 /** The task that writes converted data to stdout. */
43 static struct stdout_task stdout_task_struct;
44 /** Pointer to the stdout task. */
45 static struct stdout_task *sot = &stdout_task_struct;
46
47 /** Gengetopt struct that holds the command line args. */
48 static struct filter_args_info conf;
49
50 static int loglevel;
51 INIT_STDERR_LOGGING(loglevel);
52
53 static void open_filters(void)
54 {
55 int i;
56 struct filter_node *fn;
57
58 FOR_EACH_FILTER_NODE(fn, fc, i) {
59 struct filter *f = filters + fn->filter_num;
60 f->open(fn);
61 PARA_INFO_LOG("opened %s filter\n", f->name);
62 fc->outbufp = &fn->buf;
63 fc->out_loaded = &fn->loaded;
64 }
65 }
66
67 static void free_filter_confs(void)
68 {
69 int i;
70 struct filter_node *fn;
71
72 FOR_EACH_FILTER_NODE(fn, fc, i)
73 free(fn->conf);
74 }
75
76 static int init_filter_chain(void)
77 {
78 int i, ret;
79 struct filter_node *fn;
80
81 if (!conf.filter_given)
82 return -E_NO_FILTERS;
83 fc->num_filters = conf.filter_given;
84 fc->filter_nodes = para_calloc(fc->num_filters * sizeof(struct filter_node));
85 fc->inbufp = &sit->buf;
86 fc->in_loaded = &sit->loaded;
87 fc->input_error = &sit->task.error;
88 fc->task.error = 0;
89 fc->output_error = &sot->task.error;
90 fc->task.post_select = filter_post_select;
91 sprintf(fc->task.status, "filter chain");
92
93 FOR_EACH_FILTER_NODE(fn, fc, i) {
94 char *fa = conf.filter_arg[i];
95 fn = fc->filter_nodes + i;
96 ret = check_filter_arg(fa, &fn->conf);
97 if (ret < 0)
98 goto err;
99 fn->filter_num = ret;
100 fn->fc = fc;
101 INIT_LIST_HEAD(&fn->callbacks);
102 PARA_DEBUG_LOG("filter #%d: %s\n", i, filters[fn->filter_num].name);
103 }
104 open_filters();
105 return 1;
106 err:
107 free_filter_confs();
108 free(fc->filter_nodes);
109 return ret;
110 }
111
112 __noreturn static void print_help_and_die(void)
113 {
114 int d = conf.detailed_help_given;
115 const char **p = d? filter_args_info_detailed_help
116 : filter_args_info_help;
117
118 printf_or_die("%s\n\n", FILTER_CMDLINE_PARSER_PACKAGE "-"
119 FILTER_CMDLINE_PARSER_VERSION);
120 printf_or_die("%s\n\n", filter_args_info_usage);
121 for (; *p; p++)
122 printf_or_die("%s\n", *p);
123 print_filter_helps(d);
124 exit(0);
125 }
126
127 static int parse_config(int argc, char *argv[])
128 {
129 static char *cf; /* config file */
130 struct stat statbuf;
131
132 if (filter_cmdline_parser(argc, argv, &conf))
133 return -E_FILTER_SYNTAX;
134 HANDLE_VERSION_FLAG("filter", conf);
135 if (conf.help_given || conf.detailed_help_given)
136 print_help_and_die();
137 loglevel = get_loglevel_by_name(conf.loglevel_arg);
138 if (!cf) {
139 char *home = para_homedir();
140 cf = make_message("%s/.paraslash/filter.conf", home);
141 free(home);
142 }
143 if (!stat(cf, &statbuf)) {
144 struct filter_cmdline_parser_params params = {
145 .override = 0,
146 .initialize = 0,
147 .check_required = 0,
148 .check_ambiguity = 0,
149 .print_errors = 1
150 };
151 if (filter_cmdline_parser_config_file(cf, &conf, &params))
152 return -E_FILTER_SYNTAX;
153 }
154 return 1;
155 }
156
157 /* TODO: support more than one filter, actually parse options */
158 static int __noreturn main_btr(void)
159 {
160 static struct sched s;
161 int i, ret;
162 struct filter *f;
163 struct btr_node *parent;
164
165 sit->btrn = btr_new_node("stdin", NULL, NULL, NULL);
166 stdin_set_defaults(sit);
167 register_task(&sit->task);
168
169 for (i = 0, parent = sit->btrn; i < conf.filter_given; i++) {
170 char *fa = conf.filter_arg[i];
171 struct filter_node *fn = para_calloc(sizeof(*fn));
172
173 ret = check_filter_arg(fa, &fn->conf);
174 if (ret < 0) {
175 free(fn);
176 goto err;
177 }
178 fn->filter_num = ret;
179 f = filters + fn->filter_num;
180 sprintf(fn->task.status, "%s", f->name);
181 PARA_DEBUG_LOG("filter #%d: %s\n", i, f->name);
182 fn->btrn = btr_new_node(f->name, parent, f->execute, fn);
183 fn->task.pre_select = f->pre_select;
184 fn->task.post_select = f->post_select;
185 f->open(fn);
186 register_task(&fn->task);
187 parent = fn->btrn;
188 }
189 sot->btrn = btr_new_node("stdout", parent, NULL, NULL);
190 stdout_set_defaults(sot);
191 register_task(&sot->task);
192
193 s.default_timeout.tv_sec = 1;
194 s.default_timeout.tv_usec = 0;
195 btr_log_tree(sit->btrn, LL_INFO);
196 ret = schedule(&s);
197 err:
198 if (ret < 0)
199 PARA_EMERG_LOG("%s\n", para_strerror(-ret));
200 exit(ret < 0? EXIT_FAILURE : EXIT_SUCCESS);
201 }
202
203 /**
204 * The main function of para_filter.
205 *
206 * Para_filter reads data from stdin, converts it by using a chain
207 * of filters (specified on the command line) and writes the resulting
208 * data to stdout.
209 *
210 * \param argc Number of command line options.
211 * \param argv Vector of arguments.
212 *
213 * \return \a EXIT_SUCCESS on success, EXIT_FAILURE on errors.
214 */
215 int main(int argc, char *argv[])
216 {
217 int ret;
218 static struct sched s;
219
220 filter_init();
221 ret = parse_config(argc, argv);
222 if (ret < 0)
223 goto out;
224 if (conf.buffer_tree_given) {
225 ret = main_btr();
226 goto out;
227 }
228 stdin_set_defaults(sit);
229 sit->buf = para_malloc(sit->bufsize),
230
231 ret = init_filter_chain();
232 if (ret < 0)
233 goto out;
234 sit->output_error = &fc->task.error;
235
236 stdout_set_defaults(sot);
237 sot->bufp = fc->outbufp;
238 sot->loaded = fc->out_loaded;
239 sot->input_error = &fc->task.error;
240
241 register_task(&sit->task);
242 register_task(&sot->task);
243 register_task(&fc->task);
244 s.default_timeout.tv_sec = 1;
245 s.default_timeout.tv_usec = 0;
246 ret = schedule(&s);
247 free_filter_confs();
248 close_filters(fc);
249 out:
250 free(sit->buf);
251 if (ret < 0)
252 PARA_EMERG_LOG("%s\n", para_strerror(-ret));
253 return ret < 0? EXIT_FAILURE : EXIT_SUCCESS;
254 }