Update tests to support changes to pxe_parser
[petitboot] / discover / paths.c
index ce90caee3775d8b9714fb865d4ef6dad1c98ce5d..7fcff9e0eaf3d8cc1ceb2e66cb68bbc279fd647f 100644 (file)
@@ -1,8 +1,13 @@
-#define _GNU_SOURCE
+#if defined(HAVE_CONFIG_H)
+#include "config.h"
+#endif
 
+#include <assert.h>
 #include <string.h>
 #include <stdio.h>
 #include <stdlib.h>
+#include <sys/types.h>
+#include <sys/stat.h>
 
 #include <talloc/talloc.h>
 #include <system/system.h>
 
 #define DEVICE_MOUNT_BASE (LOCAL_STATE_DIR "/petitboot/mnt")
 
+struct load_task {
+       struct pb_url           *url;
+       struct process          *process;
+       struct load_url_result  *result;
+       bool                    async;
+       load_url_complete       async_cb;
+       void                    *async_data;
+};
+
 const char *mount_base(void)
 {
        return DEVICE_MOUNT_BASE;
@@ -33,158 +47,256 @@ char *join_paths(void *alloc_ctx, const char *a, const char *b)
        return full_path;
 }
 
+#ifndef PETITBOOT_TEST
 
 static char *local_name(void *ctx)
 {
-       char *tmp, *ret;
+       char *ret, tmp[] = "/tmp/pb-XXXXXX";
+       mode_t oldmask;
+       int fd;
 
-       tmp = tempnam(NULL, "pb-");
+       oldmask = umask(0644);
+       fd = mkstemp(tmp);
+       umask(oldmask);
 
-       if (!tmp)
+       if (fd < 0)
                return NULL;
 
+       close(fd);
+
        ret = talloc_strdup(ctx, tmp);
-       free(tmp);
 
        return ret;
 }
 
-/**
- * pb_load_nfs - Mounts the NFS export and returns the local file path.
- *
- * Returns the local file path in a talloc'ed character string on success,
- * or NULL on error.
- */
-static char *load_nfs(void *ctx, struct pb_url *url)
+static void load_url_result_cleanup_local(struct load_url_result *result)
 {
-       char *local, *opts;
-       int result;
-
-       local = local_name(ctx);
-
-       if (!local)
-               return NULL;
-
-       result = pb_mkdir_recursive(local);
-
-       if (result)
-               goto fail;
-
-       opts = talloc_strdup(NULL, "ro,nolock,nodiratime");
-
-       if (url->port)
-               opts = talloc_asprintf_append(opts, ",port=%s", url->port);
-
-       result = process_run_simple(ctx, pb_system_apps.mount, "-t", "nfs",
-                       opts, url->host, url->dir, local, NULL);
+       if (result->cleanup_local)
+               unlink(result->local);
+}
 
-       talloc_free(opts);
+static void load_url_process_exit(struct process *process)
+{
+       struct load_task *task = process->data;
+       struct load_url_result *result;
+       load_url_complete cb;
+       void *data;
+
+       pb_debug("The download client '%s' [pid %d, url %s] exited, rc %d\n",
+                       process->path, process->pid, task->url->full,
+                       process->exit_status);
+
+       result = task->result;
+       data = task->async_data;
+       cb = task->async_cb;
+
+       if (result->status == LOAD_CANCELLED) {
+               load_url_result_cleanup_local(result);
+       } else if (process_exit_ok(process)) {
+               result->status = LOAD_OK;
+       } else {
+               result->status = LOAD_ERROR;
+               load_url_result_cleanup_local(result);
+       }
 
-       if (result)
-               goto fail;
+       /* The load callback may well free the ctx, which was the
+        * talloc parent of the task. Therefore, we want to do our cleanup
+        * before invoking it
+        */
+       process_release(process);
+       talloc_free(task);
+       result->task = NULL;
 
-       local = talloc_asprintf_append(local,  "/%s", url->path);
-       pb_log("%s: local '%s'\n", __func__, local);
+       cb(result, data);
+}
 
-       return local;
+static void load_process_to_local_file(struct load_task *task,
+               const char **argv, int argv_local_idx)
+{
+       int rc;
 
-fail:
-       pb_rmdir_recursive("/", local);
-       talloc_free(local);
-       return NULL;
+       task->result->local = local_name(task->result);
+       if (!task->result->local) {
+               task->result->status = LOAD_ERROR;
+               return;
+       }
+       task->result->cleanup_local = true;
+
+       if (argv_local_idx)
+               argv[argv_local_idx] = task->result->local;
+
+       task->process->argv = argv;
+       task->process->path = argv[0];
+
+       if (task->async) {
+               rc = process_run_async(task->process);
+               if (rc) {
+                       process_release(task->process);
+                       task->process = NULL;
+               }
+               task->result->status = rc ? LOAD_ERROR : LOAD_ASYNC;
+       } else {
+               rc = process_run_sync(task->process);
+               if (rc || !process_exit_ok(task->process))
+                       task->result->status = LOAD_ERROR;
+               else
+                       task->result->status = LOAD_OK;
+               process_release(task->process);
+               task->process = NULL;
+       }
 }
 
 /**
- * pb_load_sftp - Loads a remote file via sftp and returns the local file path.
- *
- * Returns the local file path in a talloc'ed character string on success,
- * or NULL on error.
+ * pb_load_nfs - Create a mountpoint, set the local file within that
+ * mountpoint, and run the appropriate mount command
  */
-static char *load_sftp(void *ctx, struct pb_url *url)
-{
-       char *host_path, *local;
-       int result;
-
-       local = local_name(ctx);
-
-       if (!local)
-               return NULL;
-
-       host_path = talloc_asprintf(local, "%s:%s", url->host, url->path);
-
-       result = process_run_simple(ctx, pb_system_apps.sftp, host_path,
-                       local, NULL);
 
-       if (result)
-               goto fail;
+static void load_nfs(struct load_task *task)
+{
+       char *mountpoint, *opts;
+       int rc;
+       const char *argv[] = {
+                       pb_system_apps.mount,
+                       "-t", "nfs",
+                       NULL,                   /* 3: opts */
+                       task->url->host,
+                       task->url->dir,
+                       NULL,                   /* 6: mountpoint */
+                       NULL,
+       };
+
+       task->result->status = LOAD_ERROR;
+       mountpoint = local_name(task->result);
+       if (!mountpoint)
+               return;
+       task->result->cleanup_local = true;
+       argv[6] = mountpoint;
+
+       rc = pb_mkdir_recursive(mountpoint);
+       if (rc)
+               return;
 
-       return local;
+       opts = talloc_strdup(NULL, "ro,nolock,nodiratime");
+       argv[3] = opts;
+
+       if (task->url->port)
+               opts = talloc_asprintf_append(opts, ",port=%s",
+                                               task->url->port);
+
+       task->result->local = talloc_asprintf(task->result, "%s/%s",
+                                                       mountpoint,
+                                                       task->url->path);
+
+       task->process->path = pb_system_apps.mount;
+       task->process->argv = argv;
+
+       if (task->async) {
+               rc = process_run_async(task->process);
+               if (rc) {
+                       process_release(task->process);
+                       task->process = NULL;
+               }
+               task->result->status = rc ? LOAD_ERROR : LOAD_ASYNC;
+       } else {
+               rc = process_run_sync(task->process);
+               task->result->status = rc ? LOAD_ERROR : LOAD_OK;
+               process_release(task->process);
+               task->process = NULL;
+       }
 
-fail:
-       talloc_free(local);
-       return NULL;
+       talloc_free(opts);
 }
 
-/**
- * pb_load_tftp - Loads a remote file via tftp and returns the local file path.
- *
- * Returns the local file path in a talloc'ed character string on success,
- * or NULL on error.
- */
-
-static char *load_tftp(void *ctx, struct pb_url *url)
+static void load_sftp(struct load_task *task)
 {
-       int result;
-       const char *argv[10];
-       const char **p;
-       char *local;
+       const char *argv[] = {
+                       pb_system_apps.sftp,
+                       NULL,           /* 1: host:path */
+                       NULL,           /* 2: local file */
+                       NULL,
+       };
+
+       argv[1] = talloc_asprintf(task, "%s:%s",
+                               task->url->host, task->url->path);
+       load_process_to_local_file(task, argv, 2);
+}
 
-       local = local_name(ctx);
+static enum tftp_type check_tftp_type(void *ctx)
+{
+       const char *argv[] = { pb_system_apps.tftp, "-V", NULL };
+       struct process *process;
+       enum tftp_type type;
+       int rc;
+
+       process = process_create(ctx);
+       process->path = pb_system_apps.tftp;
+       process->argv = argv;
+       process->keep_stdout = true;
+       process->add_stderr = true;
+       rc = process_run_sync(process);
+
+       if (rc || !process->stdout_buf || process->stdout_len == 0) {
+               pb_log("Can't check TFTP client type!\n");
+               type = TFTP_TYPE_BROKEN;
+
+       } else if (memmem(process->stdout_buf, process->stdout_len,
+                               "tftp-hpa", strlen("tftp-hpa"))) {
+               pb_debug("Found TFTP client type: tftp-hpa\n");
+               type = TFTP_TYPE_HPA;
+
+       } else if (memmem(process->stdout_buf, process->stdout_len,
+                               "BusyBox", strlen("BusyBox"))) {
+               pb_debug("Found TFTP client type: BusyBox tftp\n");
+               type = TFTP_TYPE_BUSYBOX;
+
+       } else {
+               pb_log("Unknown TFTP client type!\n");
+               type = TFTP_TYPE_BROKEN;
+       }
 
-       if (!local)
-               return NULL;
+       process_release(process);
+       return type;
+}
 
-       /* first try busybox tftp args */
-
-       p = argv;
-       *p++ = pb_system_apps.tftp;     /* 1 */
-       *p++ = "-g";                    /* 2 */
-       *p++ = "-l";                    /* 3 */
-       *p++ = local;                   /* 4 */
-       *p++ = "-r";                    /* 5 */
-       *p++ = url->path;               /* 6 */
-       *p++ = url->host;               /* 7 */
-       if (url->port)
-               *p++ = url->port;       /* 8 */
-       *p++ = NULL;                    /* 9 */
-
-       result = process_run_simple_argv(ctx, argv);
-
-       if (!result)
-               return local;
-
-       /* next try tftp-hpa args */
-
-       p = argv;
-       *p++ = pb_system_apps.tftp;     /* 1 */
-       *p++ = "-m";                    /* 2 */
-       *p++ = "binary";                /* 3 */
-       *p++ = url->host;               /* 4 */
-       if (url->port)
-               *p++ = url->port;       /* 5 */
-       *p++ = "-c";                    /* 6 */
-       *p++ = "get";                   /* 7 */
-       *p++ = url->path;               /* 8 */
-       *p++ = local;                   /* 9 */
-       *p++ = NULL;                    /* 10 */
-
-       result = process_run_simple_argv(ctx, argv);
-
-       if (!result)
-               return local;
-
-       talloc_free(local);
-       return NULL;
+static void load_tftp(struct load_task *task)
+{
+       const char *port = "69";
+       const char *argv[10] = {
+               pb_system_apps.tftp,
+       };
+
+       if (task->url->port)
+               port = task->url->port;
+
+       if (tftp_type == TFTP_TYPE_UNKNOWN)
+               tftp_type = check_tftp_type(task);
+
+       if (tftp_type == TFTP_TYPE_BUSYBOX) {
+               argv[1] = "-g";
+               argv[2] = "-l";
+               argv[3] = NULL; /* 3: local file */
+               argv[4] = "-r";
+               argv[5] = task->url->path;
+               argv[6] = task->url->host;
+               argv[7] = port;
+               argv[8] = NULL;
+
+               load_process_to_local_file(task, argv, 3);
+
+       } else if (tftp_type == TFTP_TYPE_HPA) {
+               argv[1] = "-m";
+               argv[2] = "binary";
+               argv[3] = task->url->host;
+               argv[4] = port;
+               argv[5] = "-c";
+               argv[6] = "get";
+               argv[7] = task->url->path;
+               argv[8] = NULL; /* 8: local file */
+               argv[9] = NULL;
+               load_process_to_local_file(task, argv, 8);
+
+       } else
+               task->result->status = LOAD_ERROR;
 }
 
 enum wget_flags {
@@ -199,92 +311,172 @@ enum wget_flags {
  * or NULL on error.
  */
 
-static char *load_wget(void *ctx, struct pb_url *url, enum wget_flags flags)
+static void load_wget(struct load_task *task, int flags)
 {
-       int result;
-       const char *argv[7];
-       const char **p;
-       char *local;
-
-       local = local_name(ctx);
-
-       if (!local)
-               return NULL;
-
-       p = argv;
-       *p++ = pb_system_apps.wget;                     /* 1 */
+       const char *argv[] = {
+               pb_system_apps.wget,
+               "-O",
+               NULL, /* 2: local file */
+               NULL, /* 3 (optional): --quiet */
+               NULL, /* 4 (optional): --no-check-certificate */
+               NULL, /* 5: URL */
+               NULL,
+       };
+       int i;
+
+       i = 3;
 #if !defined(DEBUG)
-       *p++ = "--quiet";                               /* 2 */
+       argv[i++] = "--quiet";
 #endif
-       *p++ = "-O";                                    /* 3 */
-       *p++ = local;                                   /* 4 */
-       *p++ = url->full;                               /* 5 */
        if (flags & wget_no_check_certificate)
-               *p++ = "--no-check-certificate";        /* 6 */
-       *p++ = NULL;                                    /* 7 */
+               argv[i++] = "--no-check-certificate";
 
-       result = process_run_simple_argv(ctx, argv);
+       argv[i] = task->url->full;
 
-       if (result)
-               goto fail;
-
-       return local;
+       load_process_to_local_file(task, argv, 2);
+}
 
-fail:
-       talloc_free(local);
-       return NULL;
+/* Although we don't need to load anything for a local path (we just return
+ * the path from the file:// URL), the other load helpers will error-out on
+ * non-existant files. So, do the same here with an access() check on the local
+ * filename.
+ */
+static void load_local(struct load_task *task)
+{
+       int rc;
+
+       rc = access(task->url->path, F_OK);
+       if (rc) {
+               task->result->status = LOAD_ERROR;
+       } else {
+               task->result->local = talloc_strdup(task->result,
+                                                   task->url->path);
+               task->result->status = LOAD_OK;
+       }
 }
 
 /**
  * load_url - Loads a (possibly) remote URL and returns the local file
  * path.
  * @ctx: The talloc context to associate with the returned string.
- * @URL: The remote file URL.
+ * @url: The remote file URL.
  * @tempfile: An optional variable pointer to be set when a temporary local
  *  file is created.
+ * @url_cb: An optional callback pointer if the caller wants to load url
+ *  asynchronously.
  *
  * Returns the local file path in a talloc'ed character string on success,
  * or NULL on error.
  */
 
-char *load_url(void *ctx, struct pb_url *url, unsigned int *tempfile)
+struct load_url_result *load_url_async(void *ctx, struct pb_url *url,
+               load_url_complete async_cb, void *async_data)
 {
-       char *local;
-       int tmp = 0;
+       struct load_url_result *result;
+       struct load_task *task;
 
        if (!url)
                return NULL;
 
+       task = talloc_zero(ctx, struct load_task);
+       task->url = url;
+       task->async = async_cb != NULL;
+       task->result = talloc_zero(ctx, struct load_url_result);
+       task->result->task = task;
+       task->process = process_create(task);
+       if (task->async) {
+               task->async_cb = async_cb;
+               task->async_data = async_data;
+               task->process->exit_cb = load_url_process_exit;
+               task->process->data = task;
+       }
+
        switch (url->scheme) {
        case pb_url_ftp:
        case pb_url_http:
-               local = load_wget(ctx, url, 0);
-               tmp = !!local;
+               load_wget(task, 0);
                break;
        case pb_url_https:
-               local = load_wget(ctx, url, wget_no_check_certificate);
-               tmp = !!local;
+               load_wget(task, wget_no_check_certificate);
                break;
        case pb_url_nfs:
-               local = load_nfs(ctx, url);
-               tmp = !!local;
+               load_nfs(task);
                break;
        case pb_url_sftp:
-               local = load_sftp(ctx, url);
-               tmp = !!local;
+               load_sftp(task);
                break;
        case pb_url_tftp:
-               local = load_tftp(ctx, url);
-               tmp = !!local;
+               load_tftp(task);
                break;
        default:
-               local = talloc_strdup(ctx, url->full);
-               tmp = 0;
+               load_local(task);
                break;
        }
 
-       if (tempfile)
-               *tempfile = tmp;
+       result = task->result;
+       if (result->status == LOAD_ERROR) {
+               load_url_result_cleanup_local(task->result);
+               talloc_free(result);
+               talloc_free(task);
+               return NULL;
+       }
 
-       return local;
+       if (!task->async)
+               talloc_free(task);
+
+       return result;
 }
+
+struct load_url_result *load_url(void *ctx, struct pb_url *url)
+{
+       return load_url_async(ctx, url, NULL, NULL);
+}
+
+void load_url_async_cancel(struct load_url_result *res)
+{
+       struct load_task *task = res->task;
+
+       /* the completion callback may have already been called; this clears
+        * res->task */
+       if (!task)
+               return;
+
+       if (res->status == LOAD_CANCELLED)
+               return;
+
+       assert(task->async);
+       assert(task->process);
+
+       res->status = LOAD_CANCELLED;
+       process_stop_async(task->process);
+}
+
+#else
+
+static void __attribute__((unused)) load_local(
+               struct load_task *task __attribute__((unused)))
+{
+}
+static void __attribute__((unused)) load_wget(
+               struct load_task *task __attribute__((unused)),
+               int flags __attribute__((unused)))
+{
+}
+static void __attribute__((unused)) load_tftp(
+               struct load_task *task __attribute__((unused)))
+{
+}
+static void __attribute__((unused)) load_sftp(
+               struct load_task *task __attribute__((unused)))
+{
+}
+static void __attribute__((unused)) load_nfs(
+               struct load_task *task __attribute__((unused)))
+{
+}
+static void __attribute__((unused)) load_url_process_exit(
+               struct process *process __attribute__((unused)))
+{
+}
+
+#endif