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 "para.h"
  10
  11 #include "filter.cmdline.h"
  12 #include "list.h"
  13 #include "sched.h"
  14 #include "ggo.h"
  15 #include "filter.h"
  16 #include "string.h"
  17 #include "stdin.h"
  18 #include "stdout.h"
  19 #include "error.h"
  20
  21 /** The list of all status items used by para_{server,audiod,gui}. */
  22 const char *status_item_list[] = {STATUS_ITEM_ARRAY};
  23
  24 char *stat_item_values[NUM_STAT_ITEMS] = {NULL};
  25
  26 /** Initialize the array of errors for para_filter. */
  27 INIT_FILTER_ERRLISTS;
  28
  29 /** The task that reads from stdin. */
  30 static struct stdin_task stdin_task_struct;
  31 /** pointer to the stdin task. */
  32 static struct stdin_task *sit = &stdin_task_struct;
  33
  34 /** The task that filters the data. */
  35 static struct filter_chain filter_chain_struct;
  36 /** Pointer to the filter chain. */
  37 static struct filter_chain *fc = &filter_chain_struct;
  38
  39 /** The task that writes converted data to stdout. */
  40 static struct stdout_task stdout_task_struct;
  41 /** Pointer to the stdout task. */
  42 static struct stdout_task *sot = &stdout_task_struct;
  43
  44 /** Gengetopt struct that holds the command line args. */
  45 static struct filter_args_info conf;
  46
  47 static int loglevel;
  48 INIT_STDERR_LOGGING(loglevel);
  49
  50 static void open_filters(void)
  51 {
  52         int i;
  53         struct filter_node *fn;
  54
  55         FOR_EACH_FILTER_NODE(fn, fc, i) {
  56                 struct filter *f = filters + fn->filter_num;
  57                 f->open(fn);
  58                 PARA_INFO_LOG("opened %s filter\n", f->name);
  59                 fc->outbufp = &fn->buf;
  60                 fc->out_loaded = &fn->loaded;
  61         }
  62 }
  63
  64 static void free_filter_confs(void)
  65 {
  66         int i;
  67         struct filter_node *fn;
  68
  69         FOR_EACH_FILTER_NODE(fn, fc, i)
  70                 free(fn->conf);
  71 }
  72
  73 static int init_filter_chain(void)
  74 {
  75         int i, ret;
  76         struct filter_node *fn;
  77
  78         if (!conf.filter_given)
  79                 return -E_NO_FILTERS;
  80         fc->num_filters = conf.filter_given;
  81         fc->filter_nodes = para_calloc(fc->num_filters * sizeof(struct filter_node));
  82         fc->inbufp = &sit->buf;
  83         fc->in_loaded = &sit->loaded;
  84         fc->input_error = &sit->task.error;
  85         fc->task.error = 0;
  86         fc->output_error = &sot->task.error;
  87         fc->task.post_select = filter_post_select;
  88         sprintf(fc->task.status, "filter chain");
  89
  90         FOR_EACH_FILTER_NODE(fn, fc, i) {
  91                 char *fa = conf.filter_arg[i];
  92                 fn = fc->filter_nodes + i;
  93                 ret = check_filter_arg(fa, &fn->conf);
  94                 if (ret < 0)
  95                         goto err;
  96                 fn->filter_num = ret;
  97                 fn->fc = fc;
  98                 INIT_LIST_HEAD(&fn->callbacks);
  99                 PARA_DEBUG_LOG("filter #%d: %s\n", i, filters[fn->filter_num].name);
 100         }
 101         open_filters();
 102         return 1;
 103 err:
 104         free_filter_confs();
 105         free(fc->filter_nodes);
 106         return ret;
 107 }
 108
 109 __noreturn static void print_help_and_die(void)
 110 {
 111         int d = conf.detailed_help_given;
 112         const char **p = d? filter_args_info_detailed_help
 113                 : filter_args_info_help;
 114
 115         printf_or_die("%s\n\n", FILTER_CMDLINE_PARSER_PACKAGE "-"
 116                 FILTER_CMDLINE_PARSER_VERSION);
 117         printf_or_die("%s\n\n", filter_args_info_usage);
 118         for (; *p; p++)
 119                 printf_or_die("%s\n", *p);
 120         print_filter_helps(d);
 121         exit(0);
 122 }
 123
 124 static int parse_config(int argc, char *argv[])
 125 {
 126         static char *cf; /* config file */
 127         struct stat statbuf;
 128
 129         if (filter_cmdline_parser(argc, argv, &conf))
 130                 return -E_FILTER_SYNTAX;
 131         HANDLE_VERSION_FLAG("filter", conf);
 132         if (conf.help_given || conf.detailed_help_given)
 133                 print_help_and_die();
 134         loglevel = get_loglevel_by_name(conf.loglevel_arg);
 135         if (!cf) {
 136                 char *home = para_homedir();
 137                 cf = make_message("%s/.paraslash/filter.conf", home);
 138                 free(home);
 139         }
 140         if (!stat(cf, &statbuf)) {
 141                 struct filter_cmdline_parser_params params = {
 142                         .override = 0,
 143                         .initialize = 0,
 144                         .check_required = 0,
 145                         .check_ambiguity = 0,
 146                         .print_errors = 1
 147                 };
 148                 if (filter_cmdline_parser_config_file(cf, &conf, &params))
 149                         return -E_FILTER_SYNTAX;
 150         }
 151         return 1;
 152 }
 153
 154 /**
 155  * The main function of para_filter.
 156  *
 157  * Para_filter reads data from stdin, converts it by using a chain
 158  * of filters (specified on the command line) and writes the resulting
 159  * data to stdout.
 160  *
 161  * \param argc Number of command line options.
 162  * \param argv Vector of arguments.
 163  *
 164  * \return \a EXIT_SUCCESS on success, EXIT_FAILURE on errors.
 165  */
 166 int main(int argc, char *argv[])
 167 {
 168         int ret;
 169         static struct sched s;
 170
 171         stdin_set_defaults(sit);
 172         sit->buf = para_malloc(sit->bufsize),
 173
 174         filter_init();
 175         ret = parse_config(argc, argv);
 176         if (ret < 0)
 177                 goto out;
 178         ret = init_filter_chain();
 179         if (ret < 0)
 180                 goto out;
 181         sit->output_error = &fc->task.error;
 182
 183         stdout_set_defaults(sot);
 184         sot->bufp = fc->outbufp;
 185         sot->loaded = fc->out_loaded;
 186         sot->input_error = &fc->task.error;
 187
 188         register_task(&sit->task);
 189         register_task(&fc->task);
 190         register_task(&sot->task);
 191         s.default_timeout.tv_sec = 1;
 192         s.default_timeout.tv_usec = 0;
 193         ret = schedule(&s);
 194         free_filter_confs();
 195         close_filters(fc);
 196 out:
 197         free(sit->buf);
 198         if (ret < 0)
 199                 PARA_EMERG_LOG("%s\n", para_strerror(-ret));
 200         return ret < 0? EXIT_FAILURE : EXIT_SUCCESS;
 201 }