summaryrefslogtreecommitdiff
path: root/http.h
blob: 5f09c88ce5a380115e84ff6042f067f0a37e46a6 (plain)
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
/*
 * 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 HTTP_H
#define HTTP_H

#include <kcgi.h>

#include "file.h"

/*
 * Return structure for HTTP action methods
 */
struct http_ret {
	enum khttp code;
	char   *message;
};

/*
 * Initialize headers and start the document body with the provided http code.
 * All parameters are required.
 */
void
http_open_file(struct kreq *, enum khttp, struct file *);

/*
 * Initialize headers and start the document body with the provided http code.
 * All parameters are required.
 */
void
http_open(struct kreq *, enum khttp, enum kmime);

/*
 * Send a plain text error response.
 * The KCGI request can be NULL.
 * The khttp code is required.
 * The error string can be NULL, in this case the http code is printed in plain
 * text form instead.
 *
 * This function exits with EXIT_FAILURE. It never returns.
 */
void
http_exit(struct kreq *, enum khttp, char *,...);

#endif				/* HTTP_H */