/*
- * Copyright (C) 2005-2007 Andre Noll <maan@systemlinux.org>
+ * Copyright (C) 2005-2014 Andre Noll <maan@systemlinux.org>
*
- * This program is free software; you can redistribute it and/or modify
- * it under the terms of the GNU General Public License as published by
- * the Free Software Foundation; either version 2 of the License, or
- * (at your option) any later version.
- *
- * This program is distributed in the hope that it will be useful,
- * but WITHOUT ANY WARRANTY; without even the implied warranty of
- * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
- * GNU General Public License for more details.
- *
- * You should have received a copy of the GNU General Public License
- * along with this program; if not, write to the Free Software
- * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111, USA.
+ * Licensed under the GPL v2. For licencing details see COPYING.
*/
-/** \file filter.c the stand-alone filter program */
-#include "para.h"
+/** \file filter.c The stand-alone filter program. */
+#include <regex.h>
+
+#include "para.h"
#include "filter.cmdline.h"
#include "list.h"
#include "sched.h"
+#include "ggo.h"
+#include "buffer_tree.h"
#include "filter.h"
#include "string.h"
#include "stdin.h"
#include "stdout.h"
#include "error.h"
+#include "version.h"
+
+/** The list of all status items used by para_{server,audiod,gui}. */
+const char *status_item_list[] = {STATUS_ITEM_ARRAY};
+char *stat_item_values[NUM_STAT_ITEMS] = {NULL};
+
+/** Initialize the array of errors for para_filter. */
INIT_FILTER_ERRLISTS;
+/** The task that reads from stdin. */
static struct stdin_task stdin_task_struct;
+/** pointer to the stdin task. */
static struct stdin_task *sit = &stdin_task_struct;
-static struct filter_chain filter_chain_struct;
-static struct filter_chain *fc = &filter_chain_struct;
+
+/** The task that writes converted data to stdout. */
static struct stdout_task stdout_task_struct;
+/** Pointer to the stdout task. */
static struct stdout_task *sot = &stdout_task_struct;
+/** Gengetopt struct that holds the command line args. */
static struct filter_args_info conf;
-__printf_2_3 void para_log(int ll, const char* fmt,...)
-{
- va_list argp;
-
- /* ignore log message if loglevel is not high enough */
- if (ll < conf.loglevel_arg)
- return;
- va_start(argp, fmt);
- vfprintf(stderr, fmt, argp);
- va_end(argp);
-}
+static int loglevel;
+INIT_STDERR_LOGGING(loglevel);
-static void filter_event_handler(struct task *t)
+__noreturn static void print_help_and_die(void)
{
- PARA_NOTICE_LOG("%s\n", PARA_STRERROR(-t->ret));
- unregister_task(t);
-}
+ struct ggo_help h = DEFINE_GGO_HELP(filter);
+ bool d = conf.detailed_help_given;
-static void open_filters(void)
-{
- struct filter_node *fn;
-
- list_for_each_entry(fn, &fc->filters, node) {
- fn->filter->open(fn);
- PARA_INFO_LOG("opened %s filter\n", fn->filter->name);
- fc->outbuf = fn->buf;
- fc->out_loaded = &fn->loaded;
- }
+ ggo_print_help(&h, d? GPH_STANDARD_FLAGS_DETAILED : GPH_STANDARD_FLAGS);
+ print_filter_helps(d? GPH_MODULE_FLAGS_DETAILED : GPH_MODULE_FLAGS);
+ exit(0);
}
-static int init_filter_chain(void)
-{
- int i, filter_num;
- struct filter_node *fn;
-
- INIT_LIST_HEAD(&fc->filters);
-
- fc->inbuf = sit->buf;
- fc->in_loaded = &sit->loaded;
- fc->input_eof = &sit->eof;
- fc->eof = 0;
- fc->output_eof = &sot->eof;
- fc->task.private_data = fc;
- fc->task.pre_select = filter_pre_select;
- fc->task.event_handler = filter_event_handler;
- sprintf(fc->task.status, "filter chain");
-
- for (i = 0; i < conf.filter_given; i++) {
- char *fa = conf.filter_arg[i];
- fn = para_calloc(sizeof(struct filter_node));
- filter_num = check_filter_arg(fa, &fn->conf);
- if (filter_num < 0) {
- free(fn);
- return filter_num;
- }
- fn->fc = fc;
- INIT_LIST_HEAD(&fn->callbacks);
- fn->filter = &filters[filter_num];
- PARA_DEBUG_LOG("adding %s to filter chain\n", fn->filter->name);
- list_add_tail(&fn->node, &fc->filters);
- }
- if (list_empty(&fc->filters))
- return -E_NO_FILTERS;
- open_filters();
- return 1;
-}
-
-static int parse_config(int argc, char *argv[])
+static int parse_config(void)
{
static char *cf; /* config file */
struct stat statbuf;
- int i;
- if (filter_cmdline_parser(argc, argv, &conf))
- return -E_FILTER_SYNTAX;
+ version_handle_flag("filter", conf.version_given);
+ if (conf.help_given || conf.detailed_help_given)
+ print_help_and_die();
if (!cf) {
char *home = para_homedir();
cf = make_message("%s/.paraslash/filter.conf", home);
free(home);
}
if (!stat(cf, &statbuf)) {
- if (filter_cmdline_parser_configfile(cf, &conf, 0, 0, 0))
- return -E_FILTER_SYNTAX;
+ struct filter_cmdline_parser_params params = {
+ .override = 0,
+ .initialize = 0,
+ .check_required = 0,
+ .check_ambiguity = 0,
+ .print_errors = 1
+ };
+ filter_cmdline_parser_config_file(cf, &conf, ¶ms);
+ loglevel = get_loglevel_by_name(conf.loglevel_arg);
}
- if (!conf.list_filters_given)
- return 1;
- printf("available filters: ");
- for (i = 0; filters[i].name; i++)
- printf("%s%s%s", i? " " : "", filters[i].name,
- filters[i].parse_config? "*": "");
- printf("\nFilters marked with \"*\" have further command line options. Try\n"
- "\tpara_filter -f '<filtername> -h'\nfor more information.\n");
- exit(EXIT_SUCCESS);
+ if (!conf.filter_given)
+ return -E_NO_FILTERS;
+ return 1;
}
+/**
+ * The main function of para_filter.
+ *
+ * Para_filter reads data from stdin, converts it by using a chain
+ * of filters (specified on the command line) and writes the resulting
+ * data to stdout.
+ *
+ * \param argc Number of command line options.
+ * \param argv Vector of arguments.
+ *
+ * \return \a EXIT_SUCCESS on success, EXIT_FAILURE on errors.
+ */
int main(int argc, char *argv[])
{
- int ret;
- struct sched s;
-
- stdin_set_defaults(sit);
- sit->buf = para_malloc(sit->bufsize),
-
- filter_init(filters);
- ret = parse_config(argc, argv);
- if (ret < 0)
- goto out;
- ret = init_filter_chain();
+ static struct sched s;
+ int i, ret;
+ struct filter *f;
+ struct btr_node *parent;
+ struct filter_node **fns;
+
+ filter_cmdline_parser(argc, argv, &conf); /* aborts on errors */
+ loglevel = get_loglevel_by_name(conf.loglevel_arg);
+ filter_init();
+ ret = parse_config();
if (ret < 0)
goto out;
+ sit->btrn = btr_new_node(&(struct btr_node_description)
+ EMBRACE(.name = "stdin"));
+ stdin_set_defaults(sit);
+ register_task(&s, &sit->task);
+
+ fns = para_malloc(conf.filter_given * sizeof(*fns));
+ for (i = 0, parent = sit->btrn; i < conf.filter_given; i++) {
+ char *fa = conf.filter_arg[i];
+ struct filter_node *fn;
+ fn = fns[i] = para_calloc(sizeof(*fn));
+ ret = check_filter_arg(fa, &fn->conf);
+ if (ret < 0) {
+ free(fn);
+ goto out_cleanup;
+ }
+ fn->filter_num = ret;
+ f = filters + fn->filter_num;
+ sprintf(fn->task.status, "%s", f->name);
+ PARA_DEBUG_LOG("filter #%d: %s\n", i, f->name);
+ fn->btrn = btr_new_node(&(struct btr_node_description)
+ EMBRACE(.name = f->name, .parent = parent,
+ .handler = f->execute, .context = fn));
+ fn->task.pre_select = f->pre_select;
+ fn->task.post_select = f->post_select;
+ f->open(fn);
+ register_task(&s, &fn->task);
+ parent = fn->btrn;
+ }
+ sot->btrn = btr_new_node(&(struct btr_node_description)
+ EMBRACE(.name = "stdout", .parent = parent));
stdout_set_defaults(sot);
- sot->buf = fc->outbuf;
- sot->loaded = fc->out_loaded;
- sot->input_eof = &fc->eof;
+ register_task(&s, &sot->task);
- register_task(&sot->task);
- register_task(&fc->task);
- register_task(&sit->task);
s.default_timeout.tv_sec = 1;
s.default_timeout.tv_usec = 0;
- ret = sched(&s);
+ btr_log_tree(sit->btrn, LL_INFO);
+ ret = schedule(&s);
+out_cleanup:
+ for (i--; i >= 0; i--) {
+ struct filter_node *fn = fns[i];
+
+ f = filters + fn->filter_num;
+ if (f->close)
+ f->close(fn);
+ btr_remove_node(&fn->btrn);
+ if (f->free_config)
+ f->free_config(fn->conf);
+ free(fn);
+ }
+ free(fns);
+ btr_remove_node(&sit->btrn);
+ btr_remove_node(&sot->btrn);
out:
- free(sit->buf);
- close_filters(fc);
if (ret < 0)
- PARA_EMERG_LOG("%s\n", PARA_STRERROR(-ret));
- return ret < 0? EXIT_FAILURE : EXIT_SUCCESS;
+ PARA_EMERG_LOG("%s\n", para_strerror(-ret));
+ exit(ret < 0? EXIT_FAILURE : EXIT_SUCCESS);
}