1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
|
/*
* Copyright 2023, Vincent Douillet <vincent@vdouillet.fr>
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
*
* 1. Redistributions of source code must retain the above copyright notice,
* this list of conditions and the following disclaimer.
*
* 2. Redistributions in binary form must reproduce the above copyright notice,
* this list of conditions and the following disclaimer in the documentation
* and/or other materials provided with the distribution.
*
* 3. Neither the name of the copyright holder nor the names of its contributors
* may be used to endorse or promote products derived from this software without
* specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
* AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
* ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
* LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
* CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
* SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
* INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
* CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
* ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
* POSSIBILITY OF SUCH DAMAGE.
*/
#ifndef FILE_H
#define FILE_H
#include <sys/queue.h>
#include <stdbool.h>
#include "mime.h"
/*
* a file
*/
struct file {
SLIST_ENTRY(file) files;
size_t size;
enum mime mime;
char *path; /* relative to DATA_DIR */
char *action_url; /* action URL for HTML page */
bool is_dir;
};
/*
* Free a file struct. Should be able to free incomplete files as per file_new
* usage.
*/
void
file_free(struct file *);
/*
* Build a new file from its relative paÃth to the data dir.
*/
struct file *
file_new(const char *);
/*
* Get the file basename. Returns NULL in case of error or a malloced string in
* case of success.
*/
char *
file_get_basename(const struct file *);
/*
* Build the data path (on the filesystem) for a file and optionally append
* another component to the path. If no additional component is needed, it
* should be NULL.
*/
size_t
file_get_data_path(const struct file *, char *, size_t, char *);
/*
* Build a path from the provided components.
* The first argument is the destination buffer where the path will be written.
* It is required.
* The second argument is the size of the destination buffer. It is required.
* The remaining arguments are the path parts which should end with a NULL
* component.
* Returns the number of characters written to the destination buffer. If it
* is equal to the destination buffer size, it means the buffer was too small
* and the resulting path has been truncated.
*/
size_t
path_build(char *, size_t,...);
#endif /* FILE_H */
|
