-#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>
+#include <process/process.h>
+#include <url/url.h>
+#include <log/log.h>
+#include "i18n/i18n.h"
#include "paths.h"
+#include "device-handler.h"
+#include "sysinfo.h"
#define DEVICE_MOUNT_BASE (LOCAL_STATE_DIR "/petitboot/mnt")
-struct mount_map {
- char *dev, *mnt;
+
+struct list pending_network_jobs;
+
+struct network_job {
+ struct load_task *task;
+ int flags;
+
+ struct list_item list;
};
-static struct mount_map *mount_map;
-static int mount_map_size;
+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;
+};
-static int is_prefix(const char *str, const char *prefix)
+static inline bool have_busybox(void)
{
- return !strncmp(str, prefix, strlen(prefix));
+#ifdef WITH_BUSYBOX
+ return true;
+#else
+ return false;
+#endif
}
-static int is_prefix_ignorecase(const char *str, const char *prefix)
+const char *mount_base(void)
{
- return !strncasecmp(str, prefix, strlen(prefix));
+ return DEVICE_MOUNT_BASE;
}
-const char *mount_base(void)
+char *join_paths(void *alloc_ctx, const char *a, const char *b)
{
- return DEVICE_MOUNT_BASE;
+ char *full_path;
+
+ full_path = talloc_array(alloc_ctx, char, strlen(a) + strlen(b) + 2);
+
+ strcpy(full_path, a);
+ if (b[0] != '/' && a[strlen(a) - 1] != '/')
+ strcat(full_path, "/");
+ strcat(full_path, b);
+
+ return full_path;
}
-char *encode_label(void *alloc_ctx, const char *label)
+#ifndef PETITBOOT_TEST
+
+static char *local_name(void *ctx)
{
- char *str, *c;
- unsigned int i;
+ char *ret, tmp[] = "/tmp/pb-XXXXXX";
+ mode_t oldmask;
+ int fd;
- /* the label can be expanded by up to four times */
- str = talloc_size(alloc_ctx, strlen(label) * 4 + 1);
- c = str;
+ oldmask = umask(0644);
+ fd = mkstemp(tmp);
+ umask(oldmask);
- for (i = 0; i < strlen(label); i++) {
+ if (fd < 0)
+ return NULL;
- if (label[i] == '/' || label[i] == '\\') {
- sprintf(c, "\\x%02x", label[i]);
- c += 4;
- continue;
- }
+ close(fd);
+
+ ret = talloc_strdup(ctx, tmp);
+
+ return ret;
+}
+
+static void load_url_result_cleanup_local(struct load_url_result *result)
+{
+ if (result->cleanup_local)
+ unlink(result->local);
+}
- *(c++) = label[i];
+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);
}
- *c = '\0';
+ if (result->status == LOAD_OK && process->stdout_data)
+ device_handler_status_info(process->stdout_data,
+ _("Download complete: %s"), task->url->file);
+
+ /* 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;
- return str;
+ cb(result, data);
}
-char *parse_device_path(void *alloc_ctx,
- const char *dev_str, const char __attribute__((unused)) *cur_dev)
+/*
+ * Callback to retrieve progress information from Busybox utilities.
+ * Busybox utilities use a common progress bar format which progress percentage
+ * and current size can be can be parsed from.
+ */
+static int busybox_progress_cb(void *arg)
{
- char *dev, *enc;
+ const char *busybox_fmt = "%*s %u%*[%* |]%u%c %*u:%*u:%*u ETA\n";
+ struct process_info *procinfo = arg;
+ char *n, *s, suffix, *line = NULL;
+ struct device_handler *handler;
+ unsigned int percentage, size;
+ struct process *p;
+ int rc;
- if (is_prefix_ignorecase(dev_str, "uuid=")) {
- dev = talloc_asprintf(alloc_ctx, "/dev/disk/by-uuid/%s",
- dev_str + strlen("uuid="));
- return dev;
- }
+ if (!arg)
+ return -1;
+
+ p = procinfo_get_process(procinfo);
+ handler = p->stdout_data;
- if (is_prefix_ignorecase(dev_str, "label=")) {
- enc = encode_label(NULL, dev_str + strlen("label="));
- dev = talloc_asprintf(alloc_ctx, "/dev/disk/by-label/%s", enc);
- talloc_free(enc);
- return dev;
+ rc = process_stdout_custom(procinfo, &line);
+
+ if (rc) {
+ /* Unregister ourselves from progress tracking */
+ device_handler_status_download_remove(handler, procinfo);
}
- /* normalise '/dev/foo' to 'foo' for easy comparisons, we'll expand
- * back before returning.
+ if (rc || !line)
+ return rc;
+
+ rc = sscanf(line, busybox_fmt, &percentage, &size, &suffix);
+
+ /*
+ * Many unrecognised lines are partial updates. If we see a partial
+ * line with a newline character, see if we can match a valid line
+ * at the end of stdout_buf
*/
- if (is_prefix(dev_str, "/dev/"))
- dev_str += strlen("/dev/");
+ if (rc != 3) {
+ n = strchr(line, '\n');
+ if (n)
+ for (s = n - 1; s >= p->stdout_buf; s--)
+ if (*s == '\n') {
+ rc = sscanf(s + 1, busybox_fmt,
+ &percentage, &size, &suffix);
+ break;
+ }
+ }
+
+ if (rc != 3)
+ percentage = size = 0;
- return join_paths(alloc_ctx, "/dev", dev_str);
+ device_handler_status_download(handler, procinfo,
+ percentage, size, suffix);
+
+ return 0;
}
-const char *mountpoint_for_device(const char *dev)
+
+
+static void load_process_to_local_file(struct load_task *task,
+ const char **argv, int argv_local_idx)
{
- int i;
+ int rc;
- if (is_prefix(dev, "/dev/"))
- dev += strlen("/dev/");
+ task->result->local = local_name(task->result);
+ if (!task->result->local) {
+ task->result->status = LOAD_ERROR;
+ return;
+ }
+ task->result->cleanup_local = true;
- /* check existing entries in the map */
- for (i = 0; i < mount_map_size; i++)
- if (!strcmp(mount_map[i].dev, dev))
- return mount_map[i].mnt;
+ if (argv_local_idx)
+ argv[argv_local_idx] = task->result->local;
- /* no existing entry, create a new one */
- i = mount_map_size++;
- mount_map = talloc_realloc(NULL, mount_map,
- struct mount_map, mount_map_size);
+ task->process->argv = argv;
+ task->process->path = argv[0];
- mount_map[i].dev = talloc_strdup(mount_map, dev);
- mount_map[i].mnt = join_paths(mount_map, DEVICE_MOUNT_BASE, dev);
- return mount_map[i].mnt;
+ 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;
+ }
}
-char *resolve_path(void *alloc_ctx, const char *path, const char *current_dev)
+/**
+ * pb_load_nfs - Create a mountpoint, set the local file within that
+ * mountpoint, and run the appropriate mount command
+ */
+
+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;
+
+ 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;
+ }
+
+ talloc_free(opts);
+}
+
+static void load_sftp(struct load_task *task)
+{
+ 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);
+}
+
+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;
+ }
+
+ process_release(process);
+ return type;
+}
+
+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 {
+ wget_empty = 0x1,
+ wget_no_check_certificate = 0x2,
+ wget_verbose = 0x4,
+};
+
+/**
+ * pb_load_wget - Loads a remote file via wget and returns the local file path.
+ *
+ * Returns the local file path in a talloc'ed character string on success,
+ * or NULL on error.
+ */
+
+static void load_wget(struct load_task *task, int flags)
{
- static const char s_file[] = "file://";
- char *ret;
- const char *devpath, *sep;
+ 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;
+
+ if (task->process->stdout_cb)
+ flags |= wget_verbose;
+
+ i = 3;
+#if defined(DEBUG)
+ flags |= wget_verbose;
+#endif
+ if ((flags & wget_verbose) == 0)
+ argv[i++] = "--quiet";
- /* test for urls */
+ if (flags & wget_no_check_certificate)
+ argv[i++] = "--no-check-certificate";
- if (!strncasecmp(path, s_file, sizeof(s_file) - 1))
- path += sizeof(s_file) - 1;
- else if (strstr(path, "://"))
- return talloc_strdup(alloc_ctx, path);
+ argv[i] = task->url->full;
+
+ load_process_to_local_file(task, argv, 2);
+}
- sep = strchr(path, ':');
- if (!sep) {
- devpath = mountpoint_for_device(current_dev);
- ret = join_paths(alloc_ctx, devpath, path);
+/* 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 {
- /* parse just the device name into dev */
- char *tmp, *dev;
- tmp = talloc_strndup(NULL, path, sep - path);
- dev = parse_device_path(NULL, tmp, current_dev);
+ task->result->local = talloc_strdup(task->result,
+ task->url->path);
+ task->result->status = LOAD_OK;
+ }
+}
- devpath = mountpoint_for_device(dev);
- ret = join_paths(alloc_ctx, devpath, sep + 1);
+static void load_url_async_start_pending(struct load_task *task, int flags)
+{
+ pb_log("Starting pending job for %s\n", task->url->full);
+
+ switch (task->url->scheme) {
+ case pb_url_ftp:
+ case pb_url_http:
+ load_wget(task, flags);
+ break;
+ case pb_url_https:
+ flags |= wget_no_check_certificate;
+ load_wget(task, flags);
+ break;
+ case pb_url_nfs:
+ load_nfs(task);
+ break;
+ case pb_url_sftp:
+ load_sftp(task);
+ break;
+ case pb_url_tftp:
+ load_tftp(task);
+ break;
+ default:
+ /* Shouldn't be a need via this path but.. */
+ load_local(task);
+ break;
+ }
- talloc_free(dev);
- talloc_free(tmp);
+ if (task->result->status == LOAD_ERROR) {
+ pb_log("Pending job failed for %s\n", task->url->full);
+ load_url_result_cleanup_local(task->result);
+ talloc_free(task->result);
+ talloc_free(task);
}
+}
- return ret;
+void pending_network_jobs_start(void)
+{
+ struct network_job *job, *tmp;
+
+ if (!pending_network_jobs.head.next)
+ return;
+
+ list_for_each_entry_safe(&pending_network_jobs, job, tmp, list) {
+ load_url_async_start_pending(job->task, job->flags);
+ list_remove(&job->list);
+ }
}
-char *join_paths(void *alloc_ctx, const char *a, const char *b)
+void pending_network_jobs_cancel(void)
{
- char *full_path;
+ struct network_job *job, *tmp;
- full_path = talloc_array(alloc_ctx, char, strlen(a) + strlen(b) + 2);
+ if (!pending_network_jobs.head.next)
+ return;
- strcpy(full_path, a);
- if (b[0] != '/' && a[strlen(a) - 1] != '/')
- strcat(full_path, "/");
- strcat(full_path, b);
+ list_for_each_entry_safe(&pending_network_jobs, job, tmp, list)
+ talloc_free(job);
+ list_init(&pending_network_jobs);
+}
- return full_path;
+static void pending_network_jobs_add(struct load_task *task, int flags)
+{
+ struct network_job *job;
+
+ if (!pending_network_jobs.head.next)
+ list_init(&pending_network_jobs);
+
+ job = talloc(task, struct network_job);
+ if (!job) {
+ pb_log("Failed to allocate space for pending job\n");
+ return;
+ }
+
+ job->task = task;
+ job->flags = flags;
+ list_add_tail(&pending_network_jobs, &job->list);
+}
+
+
+/**
+ * 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.
+ * @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.
+ */
+
+struct load_url_result *load_url_async(void *ctx, struct pb_url *url,
+ load_url_complete async_cb, void *async_data,
+ waiter_cb stdout_cb, void *stdout_data)
+{
+ struct load_url_result *result;
+ struct load_task *task;
+ int flags = 0;
+
+ 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->result->url = url;
+ 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;
+ task->process->stdout_cb = stdout_cb;
+ task->process->stdout_data = stdout_data;
+ }
+
+ if (!stdout_cb && stdout_data && have_busybox())
+ task->process->stdout_cb = busybox_progress_cb;
+
+ /* Make sure we save output for any task that has a custom handler */
+ if (task->process->stdout_cb) {
+ task->process->add_stderr = true;
+ task->process->keep_stdout = true;
+ }
+
+ /* If the url is remote but network is not yet available queue up this
+ * load for later */
+ if (!system_info_network_available() && url->scheme != pb_url_file) {
+ pb_log("load task for %s queued pending network\n", url->full);
+ pending_network_jobs_add(task, flags);
+ task->result->status = LOAD_ASYNC;
+ return task->result;
+ }
+
+ switch (url->scheme) {
+ case pb_url_ftp:
+ case pb_url_http:
+ load_wget(task, flags);
+ break;
+ case pb_url_https:
+ flags |= wget_no_check_certificate;
+ load_wget(task, flags);
+ break;
+ case pb_url_nfs:
+ load_nfs(task);
+ break;
+ case pb_url_sftp:
+ load_sftp(task);
+ break;
+ case pb_url_tftp:
+ load_tftp(task);
+ break;
+ default:
+ load_local(task);
+ break;
+ }
+
+ result = task->result;
+ if (result->status == LOAD_ERROR) {
+ load_url_result_cleanup_local(task->result);
+ talloc_free(result);
+ talloc_free(task);
+ return NULL;
+ }
+
+ 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, 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
projects / petitboot / blobdiff