bt2: test comp. class help attribute
[babeltrace.git] / converter / babeltrace-cfg.c
index f3a10421919e09eb5ce40a54351c1f6ec120c4da..608b65484df49c06490a7c3ea23795607a9650a3 100644 (file)
@@ -30,6 +30,7 @@
 #include <stdbool.h>
 #include <inttypes.h>
 #include <babeltrace/babeltrace.h>
+#include <babeltrace/common-internal.h>
 #include <babeltrace/values.h>
 #include <popt.h>
 #include <glib.h>
 #include <pwd.h>
 #include "babeltrace-cfg.h"
 
-#define SYSTEM_PLUGIN_PATH             INSTALL_LIBDIR "/babeltrace/plugins"
 #define DEFAULT_SOURCE_COMPONENT_NAME  "ctf.fs"
 #define DEFAULT_SINK_COMPONENT_NAME    "text.text"
-#define HOME_ENV_VAR                   "HOME"
-#define HOME_SUBPATH                   "/.babeltrace/plugins"
 
 /*
  * Error printf() macro which prepends "Error: " the first time it's
@@ -148,9 +146,6 @@ enum legacy_output_format {
        LEGACY_OUTPUT_FORMAT_DUMMY,
 };
 
-static bool omit_system_plugin_path;
-static bool omit_home_plugin_path;
-
 /*
  * Prints the "out of memory" error.
  */
@@ -973,6 +968,11 @@ bool is_setuid_setgid(void)
        return (geteuid() != getuid() || getegid() != getgid());
 }
 
+static void destroy_gstring(void *data)
+{
+       g_string_free(data, TRUE);
+}
+
 /*
  * Extracts the various paths from the string arg, delimited by ':',
  * and converts them to an array value object.
@@ -985,46 +985,31 @@ static
 enum bt_value_status plugin_paths_from_arg(struct bt_value *plugin_paths,
                const char *arg)
 {
-       const char *at = arg;
-       const char *end = arg + strlen(arg);
+       enum bt_value_status status = BT_VALUE_STATUS_OK;
+       GPtrArray *dirs = g_ptr_array_new_with_free_func(destroy_gstring);
+       int ret;
+       size_t i;
 
-       while (at < end) {
-               int ret;
-               GString *path;
-               const char *next_colon;
+       if (!dirs) {
+               status = BT_VALUE_STATUS_ERROR;
+               goto end;
+       }
 
-               next_colon = strchr(at, ':');
-               if (next_colon == at) {
-                       /*
-                        * Empty path: try next character (supported
-                        * to conform to the typical parsing of $PATH).
-                        */
-                       at++;
-                       continue;
-               } else if (!next_colon) {
-                       /* No more colon: use the remaining */
-                       next_colon = arg + strlen(arg);
-               }
+       ret = bt_common_append_plugin_path_dirs(arg, dirs);
+       if (ret) {
+               status = BT_VALUE_STATUS_ERROR;
+               goto end;
+       }
 
-               path = g_string_new(NULL);
-               if (!path) {
-                       print_err_oom();
-                       goto error;
-               }
+       for (i = 0; i < dirs->len; i++) {
+               GString *dir = g_ptr_array_index(dirs, i);
 
-               g_string_append_len(path, at, next_colon - at);
-               at = next_colon + 1;
-               ret = bt_value_array_append_string(plugin_paths, path->str);
-               g_string_free(path, TRUE);
-               if (ret) {
-                       print_err_oom();
-                       goto error;
-               }
+               bt_value_array_append_string(plugin_paths, dir->str);
        }
 
-       return BT_VALUE_STATUS_OK;
-error:
-       return BT_VALUE_STATUS_ERROR;
+end:
+       g_ptr_array_free(dirs, TRUE);
+       return status;
 }
 
 /*
@@ -2257,53 +2242,23 @@ not_found:
        return -1;
 }
 
-static char *bt_secure_getenv(const char *name)
-{
-       if (is_setuid_setgid()) {
-               printf_err("Disregarding %s environment variable for setuid/setgid binary", name);
-               return NULL;
-       }
-       return getenv(name);
-}
-
-static const char *get_home_dir(void)
-{
-       char *val = NULL;
-       struct passwd *pwd;
-
-       val = bt_secure_getenv(HOME_ENV_VAR);
-       if (val) {
-               goto end;
-       }
-       /* Fallback on password file. */
-       pwd = getpwuid(getuid());
-       if (!pwd) {
-               goto end;
-       }
-       val = pwd->pw_dir;
-end:
-       return val;
-}
-
 static int add_internal_plugin_paths(struct bt_config *cfg)
 {
-       if (!omit_home_plugin_path) {
-               char path[PATH_MAX];
-               const char *home_dir;
+       int ret;
 
-               if (is_setuid_setgid()) {
+       if (!cfg->omit_home_plugin_path) {
+               if (bt_common_is_setuid_setgid()) {
                        printf_debug("Skipping non-system plugin paths for setuid/setgid binary.");
                } else {
-                       home_dir = get_home_dir();
-                       if (home_dir) {
-                               if (strlen(home_dir) + strlen(HOME_SUBPATH) + 1
-                                               >= PATH_MAX) {
-                                       printf_err("Home directory path too long\n");
-                                       goto error;
-                               }
-                               strcpy(path, home_dir);
-                               strcat(path, HOME_SUBPATH);
-                               if (plugin_paths_from_arg(cfg->plugin_paths, path)) {
+                       char *home_plugin_dir =
+                               bt_common_get_home_plugin_path();
+
+                       if (home_plugin_dir) {
+                               ret = plugin_paths_from_arg(cfg->plugin_paths,
+                                       home_plugin_dir);
+                               free(home_plugin_dir);
+
+                               if (ret) {
                                        printf_err("Invalid home plugin path\n");
                                        goto error;
                                }
@@ -2311,9 +2266,9 @@ static int add_internal_plugin_paths(struct bt_config *cfg)
                }
        }
 
-       if (!omit_system_plugin_path) {
+       if (!cfg->omit_system_plugin_path) {
                if (plugin_paths_from_arg(cfg->plugin_paths,
-                               SYSTEM_PLUGIN_PATH)) {
+                               bt_common_get_system_plugin_path())) {
                        printf_err("Invalid system plugin path\n");
                        goto error;
                }
@@ -2347,26 +2302,58 @@ error:
        return -1;
 }
 
+struct bt_config *bt_config_create(void)
+{
+       struct bt_config *cfg;
+
+       /* Create config */
+       cfg = g_new0(struct bt_config, 1);
+       if (!cfg) {
+               print_err_oom();
+               goto error;
+       }
+
+       bt_object_init(cfg, bt_config_destroy);
+       cfg->sources = g_ptr_array_new_with_free_func((GDestroyNotify) bt_put);
+       if (!cfg->sources) {
+               print_err_oom();
+               goto error;
+       }
+
+       cfg->sinks = g_ptr_array_new_with_free_func((GDestroyNotify) bt_put);
+       if (!cfg->sinks) {
+               print_err_oom();
+               goto error;
+       }
+
+       cfg->plugin_paths = bt_value_array_create();
+       if (!cfg->plugin_paths) {
+               print_err_oom();
+               goto error;
+       }
+end:
+       return cfg;
+error:
+       BT_PUT(cfg);
+       goto end;
+}
+
 /*
  * Returns a Babeltrace configuration, out of command-line arguments,
  * containing everything that is needed to instanciate specific
  * components with given parameters.
  *
- * *exit_code is set to the appropriate exit code to use as far as this
- * function goes.
- *
- * Return value is NULL on error, otherwise it's owned by the caller.
+ * Return value is set to the appropriate exit code to use.
  */
-struct bt_config *bt_config_from_args(int argc, const char *argv[], int *exit_code)
+int bt_config_init_from_args(struct bt_config *cfg, int argc, const char *argv[])
 {
-       struct bt_config *cfg = NULL;
        poptContext pc = NULL;
        char *arg = NULL;
        struct ctf_legacy_opts ctf_legacy_opts;
        struct text_legacy_opts text_legacy_opts;
        enum legacy_input_format legacy_input_format = LEGACY_INPUT_FORMAT_NONE;
        enum legacy_output_format legacy_output_format =
-               LEGACY_OUTPUT_FORMAT_NONE;
+                       LEGACY_OUTPUT_FORMAT_NONE;
        struct bt_value *legacy_input_paths = NULL;
        struct bt_config_component *implicit_source_comp = NULL;
        struct bt_config_component *cur_cfg_comp = NULL;
@@ -2375,16 +2362,10 @@ struct bt_config *bt_config_from_args(int argc, const char *argv[], int *exit_co
        enum bt_config_component_dest cur_cfg_comp_dest =
                BT_CONFIG_COMPONENT_DEST_SOURCE;
        struct bt_value *cur_base_params = NULL;
-       int opt;
+       int opt, ret = 0;
 
        memset(&ctf_legacy_opts, 0, sizeof(ctf_legacy_opts));
        memset(&text_legacy_opts, 0, sizeof(text_legacy_opts));
-       *exit_code = 0;
-
-       if (argc <= 1) {
-               print_usage(stdout);
-               goto end;
-       }
 
        text_legacy_opts.output = g_string_new(NULL);
        if (!text_legacy_opts.output) {
@@ -2410,26 +2391,6 @@ struct bt_config *bt_config_from_args(int argc, const char *argv[], int *exit_co
                goto error;
        }
 
-       /* Create config */
-       cfg = g_new0(struct bt_config, 1);
-       if (!cfg) {
-               print_err_oom();
-               goto error;
-       }
-
-       bt_object_init(cfg, bt_config_destroy);
-       cfg->sources = g_ptr_array_new_with_free_func((GDestroyNotify) bt_put);
-       if (!cfg->sources) {
-               print_err_oom();
-               goto error;
-       }
-
-       cfg->sinks = g_ptr_array_new_with_free_func((GDestroyNotify) bt_put);
-       if (!cfg->sinks) {
-               print_err_oom();
-               goto error;
-       }
-
        legacy_input_paths = bt_value_array_create();
        if (!legacy_input_paths) {
                print_err_oom();
@@ -2447,12 +2408,6 @@ struct bt_config *bt_config_from_args(int argc, const char *argv[], int *exit_co
                        DEFAULT_SOURCE_COMPONENT_NAME);
        }
 
-       cfg->plugin_paths = bt_value_array_create();
-       if (!cfg->plugin_paths) {
-               print_err_oom();
-               goto error;
-       }
-
        /* Parse options */
        pc = poptGetContext(NULL, argc, (const char **) argv, long_options, 0);
        if (!pc) {
@@ -2477,10 +2432,10 @@ struct bt_config *bt_config_from_args(int argc, const char *argv[], int *exit_co
                        }
                        break;
                case OPT_OMIT_SYSTEM_PLUGIN_PATH:
-                       omit_system_plugin_path = true;
+                       cfg->omit_system_plugin_path = true;
                        break;
                case OPT_OMIT_HOME_PLUGIN_PATH:
-                       omit_home_plugin_path = true;
+                       cfg->omit_home_plugin_path = true;
                        break;
                case OPT_OUTPUT_PATH:
                        if (text_legacy_opts.output->len > 0) {
@@ -2832,15 +2787,12 @@ struct bt_config *bt_config_from_args(int argc, const char *argv[], int *exit_co
                        break;
                }
                case OPT_HELP:
-                       BT_PUT(cfg);
                        print_usage(stdout);
                        goto end;
                case OPT_HELP_LEGACY:
-                       BT_PUT(cfg);
                        print_legacy_usage(stdout);
                        goto end;
                case OPT_VERSION:
-                       BT_PUT(cfg);
                        print_version();
                        goto end;
                case OPT_LIST:
@@ -2862,6 +2814,11 @@ struct bt_config *bt_config_from_args(int argc, const char *argv[], int *exit_co
                arg = NULL;
        }
 
+       if (argc <= 1) {
+               print_usage(stdout);
+               goto end;
+       }
+
        /* Check for option parsing error */
        if (opt < -1) {
                printf_err("While parsing command-line options, at option %s: %s\n",
@@ -2960,10 +2917,7 @@ struct bt_config *bt_config_from_args(int argc, const char *argv[], int *exit_co
        goto end;
 
 error:
-       BT_PUT(cfg);
-       cfg = NULL;
-       *exit_code = 1;
-
+       ret = 1;
 end:
        if (pc) {
                poptFreeContext(pc);
@@ -2988,5 +2942,5 @@ end:
        BT_PUT(text_legacy_opts.names);
        BT_PUT(text_legacy_opts.fields);
        BT_PUT(legacy_input_paths);
-       return cfg;
+       return ret;
 }
This page took 0.026866 seconds and 4 git commands to generate.