discover: fix return value for discover_device_get_param
[petitboot] / discover / paths.c
1 #if defined(HAVE_CONFIG_H)
2 #include "config.h"
3 #endif
4
5 #include <assert.h>
6 #include <string.h>
7 #include <stdio.h>
8 #include <stdlib.h>
9
10 #include <talloc/talloc.h>
11 #include <system/system.h>
12 #include <process/process.h>
13 #include <url/url.h>
14 #include <log/log.h>
15
16 #include "paths.h"
17
18 #define DEVICE_MOUNT_BASE (LOCAL_STATE_DIR "/petitboot/mnt")
19
20 struct load_task {
21         struct pb_url           *url;
22         struct process          *process;
23         struct load_url_result  *result;
24         bool                    async;
25         load_url_complete       async_cb;
26         void                    *async_data;
27 };
28
29 const char *mount_base(void)
30 {
31         return DEVICE_MOUNT_BASE;
32 }
33
34 char *join_paths(void *alloc_ctx, const char *a, const char *b)
35 {
36         char *full_path;
37
38         full_path = talloc_array(alloc_ctx, char, strlen(a) + strlen(b) + 2);
39
40         strcpy(full_path, a);
41         if (b[0] != '/' && a[strlen(a) - 1] != '/')
42                 strcat(full_path, "/");
43         strcat(full_path, b);
44
45         return full_path;
46 }
47
48
49 static char *local_name(void *ctx)
50 {
51         char *ret, tmp[] = "/tmp/pb-XXXXXX";
52         int fd;
53
54         fd = mkstemp(tmp);
55
56         if (fd < 0)
57                 return NULL;
58
59         close(fd);
60
61         ret = talloc_strdup(ctx, tmp);
62
63         return ret;
64 }
65
66 static void load_url_result_cleanup_local(struct load_url_result *result)
67 {
68         if (result->cleanup_local)
69                 unlink(result->local);
70 }
71
72 static void load_url_process_exit(struct process *process)
73 {
74         struct load_task *task = process->data;
75         struct load_url_result *result;
76         load_url_complete cb;
77         void *data;
78
79         pb_debug("The download client '%s' [pid %d, url %s] exited, rc %d\n",
80                         process->path, process->pid, task->url->full,
81                         process->exit_status);
82
83         result = task->result;
84         data = task->async_data;
85         cb = task->async_cb;
86
87         if (result->status == LOAD_CANCELLED) {
88                 load_url_result_cleanup_local(result);
89         } else if (process_exit_ok(process)) {
90                 result->status = LOAD_OK;
91         } else {
92                 result->status = LOAD_ERROR;
93                 load_url_result_cleanup_local(result);
94         }
95
96         /* The load callback may well free the ctx, which was the
97          * talloc parent of the task. Therefore, we want to do our cleanup
98          * before invoking it
99          */
100         process_release(process);
101         talloc_free(task);
102         result->task = NULL;
103
104         cb(result, data);
105 }
106
107 static void load_process_to_local_file(struct load_task *task,
108                 const char **argv, int argv_local_idx)
109 {
110         int rc;
111
112         task->result->local = local_name(task->result);
113         if (!task->result->local) {
114                 task->result->status = LOAD_ERROR;
115                 return;
116         }
117         task->result->cleanup_local = true;
118
119         if (argv_local_idx)
120                 argv[argv_local_idx] = task->result->local;
121
122         task->process->argv = argv;
123         task->process->path = argv[0];
124
125         if (task->async) {
126                 rc = process_run_async(task->process);
127                 if (rc) {
128                         process_release(task->process);
129                         task->process = NULL;
130                 }
131                 task->result->status = rc ? LOAD_ERROR : LOAD_ASYNC;
132         } else {
133                 rc = process_run_sync(task->process);
134                 if (rc || !process_exit_ok(task->process))
135                         task->result->status = LOAD_ERROR;
136                 else
137                         task->result->status = LOAD_OK;
138                 process_release(task->process);
139                 task->process = NULL;
140         }
141 }
142
143 /**
144  * pb_load_nfs - Create a mountpoint, set the local file within that
145  * mountpoint, and run the appropriate mount command
146  */
147
148 static void load_nfs(struct load_task *task)
149 {
150         char *mountpoint, *opts;
151         int rc;
152         const char *argv[] = {
153                         pb_system_apps.mount,
154                         "-t", "nfs",
155                         NULL,                   /* 3: opts */
156                         task->url->host,
157                         task->url->dir,
158                         NULL,                   /* 6: mountpoint */
159                         NULL,
160         };
161
162         task->result->status = LOAD_ERROR;
163         mountpoint = local_name(task->result);
164         if (!mountpoint)
165                 return;
166         task->result->cleanup_local = true;
167         argv[6] = mountpoint;
168
169         rc = pb_mkdir_recursive(mountpoint);
170         if (rc)
171                 return;
172
173         opts = talloc_strdup(NULL, "ro,nolock,nodiratime");
174         argv[3] = opts;
175
176         if (task->url->port)
177                 opts = talloc_asprintf_append(opts, ",port=%s",
178                                                 task->url->port);
179
180         task->result->local = talloc_asprintf(task->result, "%s/%s",
181                                                         mountpoint,
182                                                         task->url->path);
183
184         task->process->path = pb_system_apps.mount;
185         task->process->argv = argv;
186
187         if (task->async) {
188                 rc = process_run_async(task->process);
189                 if (rc) {
190                         process_release(task->process);
191                         task->process = NULL;
192                 }
193                 task->result->status = rc ? LOAD_ERROR : LOAD_ASYNC;
194         } else {
195                 rc = process_run_sync(task->process);
196                 task->result->status = rc ? LOAD_ERROR : LOAD_OK;
197                 process_release(task->process);
198                 task->process = NULL;
199         }
200
201         talloc_free(opts);
202 }
203
204 static void load_sftp(struct load_task *task)
205 {
206         const char *argv[] = {
207                         pb_system_apps.sftp,
208                         NULL,           /* 1: host:path */
209                         NULL,           /* 2: local file */
210                         NULL,
211         };
212
213         argv[1] = talloc_asprintf(task, "%s:%s",
214                                 task->url->host, task->url->path);
215         load_process_to_local_file(task, argv, 2);
216 }
217
218 static enum tftp_type check_tftp_type(void *ctx)
219 {
220         const char *argv[] = { pb_system_apps.tftp, "-V", NULL };
221         struct process *process;
222         enum tftp_type type;
223
224         process = process_create(ctx);
225         process->path = pb_system_apps.tftp;
226         process->argv = argv;
227         process->keep_stdout = true;
228         process->add_stderr = true;
229         process_run_sync(process);
230
231         if (!process->stdout_buf || process->stdout_len == 0) {
232                 pb_log("Can't check TFTP client type!\n");
233                 type = TFTP_TYPE_BROKEN;
234
235         } else if (memmem(process->stdout_buf, process->stdout_len,
236                                 "tftp-hpa", strlen("tftp-hpa"))) {
237                 pb_debug("Found TFTP client type: tftp-hpa\n");
238                 type = TFTP_TYPE_HPA;
239
240         } else if (memmem(process->stdout_buf, process->stdout_len,
241                                 "BusyBox", strlen("BusyBox"))) {
242                 pb_debug("Found TFTP client type: BusyBox tftp\n");
243                 type = TFTP_TYPE_BUSYBOX;
244
245         } else {
246                 pb_log("Unknown TFTP client type!\n");
247                 type = TFTP_TYPE_BROKEN;
248         }
249
250         process_release(process);
251         return type;
252 }
253
254 static void load_tftp(struct load_task *task)
255 {
256         const char *port = "69";
257         const char *argv[10] = {
258                 pb_system_apps.tftp,
259         };
260
261         if (task->url->port)
262                 port = task->url->port;
263
264         if (tftp_type == TFTP_TYPE_UNKNOWN)
265                 tftp_type = check_tftp_type(task);
266
267         if (tftp_type == TFTP_TYPE_BUSYBOX) {
268                 argv[1] = "-g";
269                 argv[2] = "-l";
270                 argv[3] = NULL; /* 3: local file */
271                 argv[4] = "-r";
272                 argv[5] = task->url->path;
273                 argv[6] = task->url->host;
274                 argv[7] = port;
275                 argv[8] = NULL;
276
277                 load_process_to_local_file(task, argv, 3);
278
279         } else if (tftp_type == TFTP_TYPE_HPA) {
280                 argv[1] = "-m";
281                 argv[2] = "binary";
282                 argv[3] = task->url->host;
283                 argv[4] = port;
284                 argv[5] = "-c";
285                 argv[6] = "get";
286                 argv[7] = task->url->path;
287                 argv[8] = NULL; /* 8: local file */
288                 argv[9] = NULL;
289                 load_process_to_local_file(task, argv, 8);
290
291         } else
292                 task->result->status = LOAD_ERROR;
293 }
294
295 enum wget_flags {
296         wget_empty = 0,
297         wget_no_check_certificate = 1,
298 };
299
300 /**
301  * pb_load_wget - Loads a remote file via wget and returns the local file path.
302  *
303  * Returns the local file path in a talloc'ed character string on success,
304  * or NULL on error.
305  */
306
307 static void load_wget(struct load_task *task, int flags)
308 {
309         const char *argv[] = {
310                 pb_system_apps.wget,
311                 "-O",
312                 NULL, /* 2: local file */
313                 NULL,
314                 NULL,
315                 NULL,
316         };
317         int i;
318
319         i = 3;
320 #if !defined(DEBUG)
321         argv[i++] = "--quiet";
322 #endif
323         if (flags & wget_no_check_certificate)
324                 argv[i++] = "--no-check-certificate";
325
326         argv[i] = task->url->full;
327
328         load_process_to_local_file(task, argv, 2);
329 }
330
331 /* Although we don't need to load anything for a local path (we just return
332  * the path from the file:// URL), the other load helpers will error-out on
333  * non-existant files. So, do the same here with an access() check on the local
334  * filename.
335  */
336 static void load_local(struct load_task *task)
337 {
338         int rc;
339
340         rc = access(task->url->path, F_OK);
341         if (rc) {
342                 task->result->status = LOAD_ERROR;
343         } else {
344                 task->result->local = talloc_strdup(task->result,
345                                                     task->url->path);
346                 task->result->status = LOAD_OK;
347         }
348 }
349
350 /**
351  * load_url - Loads a (possibly) remote URL and returns the local file
352  * path.
353  * @ctx: The talloc context to associate with the returned string.
354  * @url: The remote file URL.
355  * @tempfile: An optional variable pointer to be set when a temporary local
356  *  file is created.
357  * @url_cb: An optional callback pointer if the caller wants to load url
358  *  asynchronously.
359  *
360  * Returns the local file path in a talloc'ed character string on success,
361  * or NULL on error.
362  */
363
364 struct load_url_result *load_url_async(void *ctx, struct pb_url *url,
365                 load_url_complete async_cb, void *async_data)
366 {
367         struct load_url_result *result;
368         struct load_task *task;
369
370         if (!url)
371                 return NULL;
372
373         task = talloc_zero(ctx, struct load_task);
374         task->url = url;
375         task->async = async_cb != NULL;
376         task->result = talloc_zero(ctx, struct load_url_result);
377         task->result->task = task;
378         task->process = process_create(task);
379         if (task->async) {
380                 task->async_cb = async_cb;
381                 task->async_data = async_data;
382                 task->process->exit_cb = load_url_process_exit;
383                 task->process->data = task;
384         }
385
386         switch (url->scheme) {
387         case pb_url_ftp:
388         case pb_url_http:
389                 load_wget(task, 0);
390                 break;
391         case pb_url_https:
392                 load_wget(task, wget_no_check_certificate);
393                 break;
394         case pb_url_nfs:
395                 load_nfs(task);
396                 break;
397         case pb_url_sftp:
398                 load_sftp(task);
399                 break;
400         case pb_url_tftp:
401                 load_tftp(task);
402                 break;
403         default:
404                 load_local(task);
405                 break;
406         }
407
408         result = task->result;
409         if (result->status == LOAD_ERROR) {
410                 load_url_result_cleanup_local(task->result);
411                 talloc_free(result);
412                 talloc_free(task);
413                 return NULL;
414         }
415
416         if (!task->async)
417                 talloc_free(task);
418
419         return result;
420 }
421
422 struct load_url_result *load_url(void *ctx, struct pb_url *url)
423 {
424         return load_url_async(ctx, url, NULL, NULL);
425 }
426
427 void load_url_async_cancel(struct load_url_result *res)
428 {
429         struct load_task *task = res->task;
430
431         /* the completion callback may have already been called; this clears
432          * res->task */
433         if (!task)
434                 return;
435
436         if (res->status == LOAD_CANCELLED)
437                 return;
438
439         assert(task->async);
440         assert(task->process);
441
442         res->status = LOAD_CANCELLED;
443         process_stop_async(task->process);
444 }