1 #if defined(HAVE_CONFIG_H)
12 #include <talloc/talloc.h>
13 #include <system/system.h>
14 #include <process/process.h>
17 #include "i18n/i18n.h"
20 #include "device-handler.h"
23 #define DEVICE_MOUNT_BASE (LOCAL_STATE_DIR "/petitboot/mnt")
26 struct list pending_network_jobs;
29 struct load_task *task;
32 struct list_item list;
37 struct process *process;
38 struct load_url_result *result;
40 load_url_complete async_cb;
44 const char *mount_base(void)
46 return DEVICE_MOUNT_BASE;
49 char *join_paths(void *alloc_ctx, const char *a, const char *b)
53 full_path = talloc_array(alloc_ctx, char, strlen(a) + strlen(b) + 2);
56 if (b[0] != '/' && a[strlen(a) - 1] != '/')
57 strcat(full_path, "/");
63 #ifndef PETITBOOT_TEST
66 static inline bool have_busybox(void) { return true; }
68 static inline bool have_busybox(void) { return false; }
71 static char *local_name(void *ctx)
73 char *ret, tmp[] = "/tmp/pb-XXXXXX";
77 oldmask = umask(0644);
86 ret = talloc_strdup(ctx, tmp);
91 static void load_url_result_cleanup_local(struct load_url_result *result)
93 if (result->cleanup_local)
94 unlink(result->local);
97 static void load_url_process_exit(struct process *process)
99 struct load_task *task = process->data;
100 struct load_url_result *result;
101 load_url_complete cb;
104 pb_debug("The download client '%s' [pid %d, url %s] exited, rc %d\n",
105 process->path, process->pid, task->url->full,
106 process->exit_status);
108 result = task->result;
109 data = task->async_data;
112 if (result->status == LOAD_CANCELLED) {
113 load_url_result_cleanup_local(result);
114 } else if (process_exit_ok(process)) {
115 result->status = LOAD_OK;
117 result->status = LOAD_ERROR;
118 load_url_result_cleanup_local(result);
119 pb_debug("Download client stdout buffer:\n%s\n",
120 process->stdout_buf);
123 if (result->status == LOAD_OK && process->stdout_data)
124 device_handler_status_info(process->stdout_data,
125 _("Download complete: %s"), task->url->file);
127 /* The load callback may well free the ctx, which was the
128 * talloc parent of the task. Therefore, we want to do our cleanup
131 process_release(process);
139 * Callback to retrieve progress information from Busybox utilities.
140 * Busybox utilities use a common progress bar format which progress percentage
141 * and current size can be can be parsed from.
143 static int busybox_progress_cb(void *arg)
145 const char *busybox_fmt = "%*s %u%*[%* |]%u%c %*u:%*u:%*u ETA\n";
146 struct process_info *procinfo = arg;
147 char *n, *s, suffix, *line = NULL;
148 struct device_handler *handler;
149 unsigned int percentage, size;
156 p = procinfo_get_process(procinfo);
157 handler = p->stdout_data;
159 rc = process_stdout_custom(procinfo, &line);
162 /* Unregister ourselves from progress tracking */
163 device_handler_status_download_remove(handler, procinfo);
169 rc = sscanf(line, busybox_fmt, &percentage, &size, &suffix);
172 * Many unrecognised lines are partial updates. If we see a partial
173 * line with a newline character, see if we can match a valid line
174 * at the end of stdout_buf
177 n = strchr(line, '\n');
179 for (s = n - 1; s >= p->stdout_buf; s--)
181 rc = sscanf(s + 1, busybox_fmt,
182 &percentage, &size, &suffix);
188 percentage = size = 0;
190 device_handler_status_download(handler, procinfo,
191 percentage, size, suffix);
198 static void load_process_to_local_file(struct load_task *task,
199 const char **argv, int argv_local_idx)
203 task->result->local = local_name(task->result);
204 if (!task->result->local) {
205 task->result->status = LOAD_ERROR;
208 task->result->cleanup_local = true;
211 argv[argv_local_idx] = task->result->local;
213 task->process->argv = argv;
214 task->process->path = argv[0];
217 rc = process_run_async(task->process);
219 process_release(task->process);
220 task->process = NULL;
222 task->result->status = rc ? LOAD_ERROR : LOAD_ASYNC;
224 rc = process_run_sync(task->process);
225 if (rc || !process_exit_ok(task->process))
226 task->result->status = LOAD_ERROR;
228 task->result->status = LOAD_OK;
229 process_release(task->process);
230 task->process = NULL;
235 * pb_load_nfs - Create a mountpoint, set the local file within that
236 * mountpoint, and run the appropriate mount command
239 static void load_nfs(struct load_task *task)
241 char *mountpoint, *opts;
243 const char *argv[] = {
244 pb_system_apps.mount,
249 NULL, /* 6: mountpoint */
253 task->result->status = LOAD_ERROR;
254 mountpoint = local_name(task->result);
257 task->result->cleanup_local = true;
258 argv[6] = mountpoint;
260 rc = pb_mkdir_recursive(mountpoint);
264 opts = talloc_strdup(NULL, "ro,nolock,nodiratime");
268 opts = talloc_asprintf_append(opts, ",port=%s",
271 task->result->local = talloc_asprintf(task->result, "%s/%s",
275 task->process->path = pb_system_apps.mount;
276 task->process->argv = argv;
279 rc = process_run_async(task->process);
281 process_release(task->process);
282 task->process = NULL;
284 task->result->status = rc ? LOAD_ERROR : LOAD_ASYNC;
286 rc = process_run_sync(task->process);
287 task->result->status = rc ? LOAD_ERROR : LOAD_OK;
288 process_release(task->process);
289 task->process = NULL;
295 static void load_sftp(struct load_task *task)
297 const char *argv[] = {
299 NULL, /* 1: host:path */
300 NULL, /* 2: local file */
304 argv[1] = talloc_asprintf(task, "%s:%s",
305 task->url->host, task->url->path);
306 load_process_to_local_file(task, argv, 2);
309 static enum tftp_type check_tftp_type(void *ctx)
311 const char *argv[] = { pb_system_apps.tftp, "-V", NULL };
312 struct process *process;
316 process = process_create(ctx);
317 process->path = pb_system_apps.tftp;
318 process->argv = argv;
319 process->keep_stdout = true;
320 process->add_stderr = true;
321 rc = process_run_sync(process);
323 if (rc || !process->stdout_buf || process->stdout_len == 0) {
324 pb_log("Can't check TFTP client type!\n");
325 type = TFTP_TYPE_BROKEN;
327 } else if (memmem(process->stdout_buf, process->stdout_len,
328 "tftp-hpa", strlen("tftp-hpa"))) {
329 pb_debug("Found TFTP client type: tftp-hpa\n");
330 type = TFTP_TYPE_HPA;
332 } else if (memmem(process->stdout_buf, process->stdout_len,
333 "BusyBox", strlen("BusyBox"))) {
334 pb_debug("Found TFTP client type: BusyBox tftp\n");
335 type = TFTP_TYPE_BUSYBOX;
338 pb_log("Unknown TFTP client type!\n");
339 type = TFTP_TYPE_BROKEN;
342 process_release(process);
346 static void load_tftp(struct load_task *task)
348 const char *port = "69";
349 const char *argv[10] = {
354 port = task->url->port;
356 if (tftp_type == TFTP_TYPE_UNKNOWN)
357 tftp_type = check_tftp_type(task);
359 if (tftp_type == TFTP_TYPE_BUSYBOX) {
362 argv[3] = NULL; /* 3: local file */
364 argv[5] = task->url->path;
365 argv[6] = task->url->host;
369 load_process_to_local_file(task, argv, 3);
371 } else if (tftp_type == TFTP_TYPE_HPA) {
374 argv[3] = task->url->host;
378 argv[7] = task->url->path;
379 argv[8] = NULL; /* 8: local file */
381 load_process_to_local_file(task, argv, 8);
384 task->result->status = LOAD_ERROR;
389 wget_no_check_certificate = 0x2,
394 * pb_load_wget - Loads a remote file via wget and returns the local file path.
396 * Returns the local file path in a talloc'ed character string on success,
400 static void load_wget(struct load_task *task, int flags)
402 const char *argv[] = {
405 NULL, /* 2: local file */
406 NULL, /* 3 (optional): --quiet */
407 NULL, /* 4 (optional): --no-check-certificate */
413 if (task->process->stdout_cb)
414 flags |= wget_verbose;
418 flags |= wget_verbose;
420 if ((flags & wget_verbose) == 0)
421 argv[i++] = "--quiet";
423 if (flags & wget_no_check_certificate)
424 argv[i++] = "--no-check-certificate";
426 argv[i] = task->url->full;
428 load_process_to_local_file(task, argv, 2);
431 /* Although we don't need to load anything for a local path (we just return
432 * the path from the file:// URL), the other load helpers will error-out on
433 * non-existant files. So, do the same here with an access() check on the local
436 static void load_local(struct load_task *task)
438 struct load_url_result *result = task->result;
441 rc = access(task->url->path, F_OK);
443 result->status = LOAD_ERROR;
445 result->local = talloc_strdup(task->result, task->url->path);
446 result->status = LOAD_OK;
449 task->async_cb(task->result, task->async_data);
452 static void load_url_async_start_pending(struct load_task *task, int flags)
454 pb_log("Starting pending job for %s\n", task->url->full);
456 switch (task->url->scheme) {
459 load_wget(task, flags);
462 flags |= wget_no_check_certificate;
463 load_wget(task, flags);
475 /* Shouldn't be a need via this path but.. */
480 if (task->result->status == LOAD_ERROR) {
481 pb_log("Pending job failed for %s\n", task->url->full);
482 load_url_result_cleanup_local(task->result);
483 talloc_free(task->result);
488 void pending_network_jobs_start(void)
490 struct network_job *job, *tmp;
492 if (!pending_network_jobs.head.next)
495 list_for_each_entry_safe(&pending_network_jobs, job, tmp, list) {
496 load_url_async_start_pending(job->task, job->flags);
497 list_remove(&job->list);
501 void pending_network_jobs_cancel(void)
503 struct network_job *job, *tmp;
505 if (!pending_network_jobs.head.next)
508 list_for_each_entry_safe(&pending_network_jobs, job, tmp, list)
510 list_init(&pending_network_jobs);
513 static void pending_network_jobs_add(struct load_task *task, int flags)
515 struct network_job *job;
517 if (!pending_network_jobs.head.next)
518 list_init(&pending_network_jobs);
520 job = talloc(task, struct network_job);
522 pb_log("Failed to allocate space for pending job\n");
528 list_add_tail(&pending_network_jobs, &job->list);
533 * load_url - Loads a (possibly) remote URL and returns the local file
535 * @ctx: The talloc context to associate with the returned string.
536 * @url: The remote file URL.
537 * @tempfile: An optional variable pointer to be set when a temporary local
539 * @url_cb: An optional callback pointer if the caller wants to load url
542 * Returns the local file path in a talloc'ed character string on success,
546 struct load_url_result *load_url_async(void *ctx, struct pb_url *url,
547 load_url_complete async_cb, void *async_data,
548 waiter_cb stdout_cb, void *stdout_data)
550 struct load_url_result *result;
551 struct load_task *task;
557 task = talloc_zero(ctx, struct load_task);
559 task->async = async_cb != NULL;
560 task->result = talloc_zero(ctx, struct load_url_result);
561 task->result->task = task;
562 task->result->url = url;
563 task->process = process_create(task);
565 task->async_cb = async_cb;
566 task->async_data = async_data;
567 task->process->exit_cb = load_url_process_exit;
568 task->process->data = task;
569 task->process->stdout_cb = stdout_cb;
570 task->process->stdout_data = stdout_data;
573 if (!stdout_cb && stdout_data && have_busybox())
574 task->process->stdout_cb = busybox_progress_cb;
576 /* Make sure we save output for any task that has a custom handler */
577 if (task->process->stdout_cb) {
578 task->process->add_stderr = true;
579 task->process->keep_stdout = true;
582 /* If the url is remote but network is not yet available queue up this
584 if (!system_info_network_available() && url->scheme != pb_url_file) {
585 pb_log("load task for %s queued pending network\n", url->full);
586 pending_network_jobs_add(task, flags);
587 task->result->status = LOAD_ASYNC;
591 switch (url->scheme) {
594 load_wget(task, flags);
597 flags |= wget_no_check_certificate;
598 load_wget(task, flags);
614 result = task->result;
615 if (result->status == LOAD_ERROR) {
616 load_url_result_cleanup_local(task->result);
622 if (!task->async || result->status == LOAD_OK)
628 struct load_url_result *load_url(void *ctx, struct pb_url *url)
630 return load_url_async(ctx, url, NULL, NULL, NULL, NULL);
633 void load_url_async_cancel(struct load_url_result *res)
635 struct load_task *task = res->task;
637 /* the completion callback may have already been called; this clears
642 if (res->status == LOAD_CANCELLED)
646 assert(task->process);
648 res->status = LOAD_CANCELLED;
649 process_stop_async(task->process);
654 static void __attribute__((unused)) load_local(
655 struct load_task *task __attribute__((unused)))
658 static void __attribute__((unused)) load_wget(
659 struct load_task *task __attribute__((unused)),
660 int flags __attribute__((unused)))
663 static void __attribute__((unused)) load_tftp(
664 struct load_task *task __attribute__((unused)))
667 static void __attribute__((unused)) load_sftp(
668 struct load_task *task __attribute__((unused)))
671 static void __attribute__((unused)) load_nfs(
672 struct load_task *task __attribute__((unused)))
675 static void __attribute__((unused)) load_url_process_exit(
676 struct process *process __attribute__((unused)))