1 #if defined(HAVE_CONFIG_H)
10 #include <sys/socket.h>
12 #include <sys/types.h>
14 #include <talloc/talloc.h>
15 #include <system/system.h>
16 #include <process/process.h>
19 #include "i18n/i18n.h"
22 #include "device-handler.h"
25 #define DEVICE_MOUNT_BASE (LOCAL_STATE_DIR "/petitboot/mnt")
28 struct list pending_network_jobs;
31 struct load_task *task;
34 struct list_item list;
39 struct process *process;
40 struct load_url_result *result;
42 load_url_complete async_cb;
46 const char *mount_base(void)
48 return DEVICE_MOUNT_BASE;
51 char *join_paths(void *alloc_ctx, const char *a, const char *b)
55 full_path = talloc_array(alloc_ctx, char, strlen(a) + strlen(b) + 2);
58 if (b[0] != '/' && a[strlen(a) - 1] != '/')
59 strcat(full_path, "/");
65 #ifndef PETITBOOT_TEST
68 static inline bool have_busybox(void) { return true; }
70 static inline bool have_busybox(void) { return false; }
73 static char *local_name(void *ctx)
75 char *ret, tmp[] = "/tmp/pb-XXXXXX";
79 oldmask = umask(0644);
88 ret = talloc_strdup(ctx, tmp);
93 static void load_url_result_cleanup_local(struct load_url_result *result)
95 if (result->cleanup_local)
96 unlink(result->local);
99 static void load_url_process_exit(struct process *process)
101 struct load_task *task = process->data;
102 struct load_url_result *result;
103 load_url_complete cb;
106 pb_debug("The download client '%s' [pid %d, url %s] exited, rc %d\n",
107 process->path, process->pid, task->url->full,
108 process->exit_status);
110 result = task->result;
111 data = task->async_data;
114 if (result->status == LOAD_CANCELLED) {
115 load_url_result_cleanup_local(result);
116 } else if (process_exit_ok(process)) {
117 result->status = LOAD_OK;
119 result->status = LOAD_ERROR;
120 load_url_result_cleanup_local(result);
121 pb_debug("Download client stdout buffer:\n%s\n",
122 process->stdout_buf);
125 if (result->status == LOAD_OK && process->stdout_data)
126 device_handler_status_info(process->stdout_data,
127 _("Download complete: %s"), task->url->file);
129 /* The load callback may well free the ctx, which was the
130 * talloc parent of the task. Therefore, we want to do our cleanup
133 process_release(process);
141 * Callback to retrieve progress information from Busybox utilities.
142 * Busybox utilities use a common progress bar format which progress percentage
143 * and current size can be can be parsed from.
145 static int busybox_progress_cb(void *arg)
147 const char *busybox_fmt = "%*s %u%*[%* |]%u%c %*u:%*u:%*u ETA\n";
148 struct process_info *procinfo = arg;
149 char *n, *s, suffix, *line = NULL;
150 struct device_handler *handler;
151 unsigned int percentage, size;
158 p = procinfo_get_process(procinfo);
159 handler = p->stdout_data;
161 rc = process_stdout_custom(procinfo, &line);
164 /* Unregister ourselves from progress tracking */
165 device_handler_status_download_remove(handler, procinfo);
171 rc = sscanf(line, busybox_fmt, &percentage, &size, &suffix);
174 * Many unrecognised lines are partial updates. If we see a partial
175 * line with a newline character, see if we can match a valid line
176 * at the end of stdout_buf
179 n = strchr(line, '\n');
181 for (s = n - 1; s >= p->stdout_buf; s--)
183 rc = sscanf(s + 1, busybox_fmt,
184 &percentage, &size, &suffix);
190 percentage = size = 0;
194 device_handler_status_download(handler, procinfo,
195 percentage, size, suffix);
202 static void load_process_to_local_file(struct load_task *task,
203 const char **argv, int argv_local_idx)
207 task->result->local = local_name(task->result);
208 if (!task->result->local) {
209 task->result->status = LOAD_ERROR;
212 task->result->cleanup_local = true;
215 argv[argv_local_idx] = task->result->local;
217 task->process->argv = argv;
218 task->process->path = argv[0];
221 rc = process_run_async(task->process);
223 process_release(task->process);
224 task->process = NULL;
226 task->result->status = rc ? LOAD_ERROR : LOAD_ASYNC;
228 rc = process_run_sync(task->process);
229 if (rc || !process_exit_ok(task->process))
230 task->result->status = LOAD_ERROR;
232 task->result->status = LOAD_OK;
233 process_release(task->process);
234 task->process = NULL;
239 * pb_load_nfs - Create a mountpoint, set the local file within that
240 * mountpoint, and run the appropriate mount command
243 static void load_nfs(struct load_task *task)
245 char *mountpoint, *opts;
247 const char *argv[] = {
248 pb_system_apps.mount,
253 NULL, /* 6: mountpoint */
257 task->result->status = LOAD_ERROR;
258 mountpoint = local_name(task->result);
261 task->result->cleanup_local = true;
262 argv[6] = mountpoint;
264 rc = pb_mkdir_recursive(mountpoint);
268 opts = talloc_strdup(NULL, "ro,nolock,nodiratime");
272 opts = talloc_asprintf_append(opts, ",port=%s",
275 task->result->local = talloc_asprintf(task->result, "%s/%s",
279 task->process->path = pb_system_apps.mount;
280 task->process->argv = argv;
283 rc = process_run_async(task->process);
285 process_release(task->process);
286 task->process = NULL;
288 task->result->status = rc ? LOAD_ERROR : LOAD_ASYNC;
290 rc = process_run_sync(task->process);
291 task->result->status = rc ? LOAD_ERROR : LOAD_OK;
292 process_release(task->process);
293 task->process = NULL;
299 static void load_sftp(struct load_task *task)
301 const char *argv[] = {
303 NULL, /* 1: host:path */
304 NULL, /* 2: local file */
308 argv[1] = talloc_asprintf(task, "%s:%s",
309 task->url->host, task->url->path);
310 load_process_to_local_file(task, argv, 2);
313 static enum tftp_type check_tftp_type(void *ctx)
315 const char *argv[] = { pb_system_apps.tftp, "-V", NULL };
316 struct process *process;
320 process = process_create(ctx);
321 process->path = pb_system_apps.tftp;
322 process->argv = argv;
323 process->keep_stdout = true;
324 process->add_stderr = true;
325 rc = process_run_sync(process);
327 if (rc || !process->stdout_buf || process->stdout_len == 0) {
328 pb_log("Can't check TFTP client type!\n");
329 type = TFTP_TYPE_BROKEN;
331 } else if (memmem(process->stdout_buf, process->stdout_len,
332 "tftp-hpa", strlen("tftp-hpa"))) {
333 pb_debug("Found TFTP client type: tftp-hpa\n");
334 type = TFTP_TYPE_HPA;
336 } else if (memmem(process->stdout_buf, process->stdout_len,
337 "BusyBox", strlen("BusyBox"))) {
338 pb_debug("Found TFTP client type: BusyBox tftp\n");
339 type = TFTP_TYPE_BUSYBOX;
342 pb_log("Unknown TFTP client type!\n");
343 type = TFTP_TYPE_BROKEN;
346 process_release(process);
350 static void load_tftp(struct load_task *task)
352 const char *port = "69";
353 const char *argv[10] = {
358 port = task->url->port;
360 if (tftp_type == TFTP_TYPE_UNKNOWN)
361 tftp_type = check_tftp_type(task);
363 if (tftp_type == TFTP_TYPE_BUSYBOX) {
366 argv[3] = NULL; /* 3: local file */
368 argv[5] = task->url->path;
369 argv[6] = task->url->host;
373 load_process_to_local_file(task, argv, 3);
375 } else if (tftp_type == TFTP_TYPE_HPA) {
378 argv[3] = task->url->host;
382 argv[7] = task->url->path;
383 argv[8] = NULL; /* 8: local file */
385 load_process_to_local_file(task, argv, 8);
388 task->result->status = LOAD_ERROR;
393 wget_no_check_certificate = 0x2,
398 * pb_load_wget - Loads a remote file via wget and returns the local file path.
400 * Returns the local file path in a talloc'ed character string on success,
404 static void load_wget(struct load_task *task, int flags)
406 const char *argv[] = {
409 NULL, /* 2: local file */
410 NULL, /* 3 (optional): --quiet */
411 NULL, /* 4 (optional): --no-check-certificate */
417 if (task->process->stdout_cb)
418 flags |= wget_verbose;
422 flags |= wget_verbose;
424 if ((flags & wget_verbose) == 0)
425 argv[i++] = "--quiet";
427 if (flags & wget_no_check_certificate)
428 argv[i++] = "--no-check-certificate";
430 argv[i] = task->url->full;
432 load_process_to_local_file(task, argv, 2);
435 /* Although we don't need to load anything for a local path (we just return
436 * the path from the file:// URL), the other load helpers will error-out on
437 * non-existant files. So, do the same here with an access() check on the local
440 static void load_local(struct load_task *task)
442 struct load_url_result *result = task->result;
445 rc = access(task->url->path, F_OK);
447 result->status = LOAD_ERROR;
449 result->local = talloc_strdup(task->result, task->url->path);
450 result->status = LOAD_OK;
453 task->async_cb(task->result, task->async_data);
456 static void load_url_async_start_pending(struct load_task *task, int flags)
458 pb_log("Starting pending job for %s\n", task->url->full);
460 switch (task->url->scheme) {
463 load_wget(task, flags);
466 flags |= wget_no_check_certificate;
467 load_wget(task, flags);
479 /* Shouldn't be a need via this path but.. */
484 if (task->result->status == LOAD_ERROR) {
485 pb_log("Pending job failed for %s\n", task->url->full);
486 load_url_result_cleanup_local(task->result);
487 talloc_free(task->result);
492 void pending_network_jobs_start(void)
494 struct network_job *job, *tmp;
496 if (!pending_network_jobs.head.next)
499 list_for_each_entry_safe(&pending_network_jobs, job, tmp, list) {
500 load_url_async_start_pending(job->task, job->flags);
501 list_remove(&job->list);
505 void pending_network_jobs_cancel(void)
507 struct network_job *job, *tmp;
509 if (!pending_network_jobs.head.next)
512 list_for_each_entry_safe(&pending_network_jobs, job, tmp, list)
514 list_init(&pending_network_jobs);
517 static void pending_network_jobs_add(struct load_task *task, int flags)
519 struct network_job *job;
521 if (!pending_network_jobs.head.next)
522 list_init(&pending_network_jobs);
524 job = talloc(task, struct network_job);
526 pb_log("Failed to allocate space for pending job\n");
532 list_add_tail(&pending_network_jobs, &job->list);
537 * load_url - Loads a (possibly) remote URL and returns the local file
539 * @ctx: The talloc context to associate with the returned string.
540 * @url: The remote file URL.
541 * @tempfile: An optional variable pointer to be set when a temporary local
543 * @url_cb: An optional callback pointer if the caller wants to load url
546 * Returns the local file path in a talloc'ed character string on success,
550 struct load_url_result *load_url_async(void *ctx, struct pb_url *url,
551 load_url_complete async_cb, void *async_data,
552 waiter_cb stdout_cb, void *stdout_data)
554 struct load_url_result *result;
555 struct load_task *task;
556 struct addrinfo *res;
562 task = talloc_zero(ctx, struct load_task);
564 task->async = async_cb != NULL;
565 task->result = talloc_zero(ctx, struct load_url_result);
566 task->result->task = task;
567 task->result->url = url;
568 task->process = process_create(task);
570 task->async_cb = async_cb;
571 task->async_data = async_data;
572 task->process->exit_cb = load_url_process_exit;
573 task->process->data = task;
574 task->process->stdout_cb = stdout_cb;
575 task->process->stdout_data = stdout_data;
578 if (!stdout_cb && stdout_data && have_busybox())
579 task->process->stdout_cb = busybox_progress_cb;
581 /* Make sure we save output for any task that has a custom handler */
582 if (task->process->stdout_cb) {
583 task->process->add_stderr = true;
584 task->process->keep_stdout = true;
587 /* If the url is remote but network is not yet available queue up this
589 if (url->scheme != pb_url_file) {
590 if (getaddrinfo(url->host, NULL, NULL, &res) != 0) {
591 pb_log("load task for %s queued pending network\n", url->full);
592 pending_network_jobs_add(task, flags);
593 task->result->status = LOAD_ASYNC;
599 switch (url->scheme) {
602 load_wget(task, flags);
605 flags |= wget_no_check_certificate;
606 load_wget(task, flags);
622 result = task->result;
623 if (result->status == LOAD_ERROR) {
624 load_url_result_cleanup_local(task->result);
630 if (!task->async || result->status == LOAD_OK)
636 struct load_url_result *load_url(void *ctx, struct pb_url *url)
638 return load_url_async(ctx, url, NULL, NULL, NULL, NULL);
641 void load_url_async_cancel(struct load_url_result *res)
643 struct load_task *task = res->task;
645 /* the completion callback may have already been called; this clears
650 if (res->status == LOAD_CANCELLED)
654 assert(task->process);
656 res->status = LOAD_CANCELLED;
657 process_stop_async(task->process);
662 static void __attribute__((unused)) load_local(
663 struct load_task *task __attribute__((unused)))
666 static void __attribute__((unused)) load_wget(
667 struct load_task *task __attribute__((unused)),
668 int flags __attribute__((unused)))
671 static void __attribute__((unused)) load_tftp(
672 struct load_task *task __attribute__((unused)))
675 static void __attribute__((unused)) load_sftp(
676 struct load_task *task __attribute__((unused)))
679 static void __attribute__((unused)) load_nfs(
680 struct load_task *task __attribute__((unused)))
683 static void __attribute__((unused)) load_url_process_exit(
684 struct process *process __attribute__((unused)))