ksgi

1
.\"	$Id$
2
.\"
3
.\" Copyright (c) 2014, 2017, 2020 Kristaps Dzonsons <kristaps@bsd.lv>
4
.\" Copyright (c) 2017 Ingo Schwarze <schwarze@openbsd.org>
5
.\"
6
.\" Permission to use, copy, modify, and distribute this software for any
7
.\" purpose with or without fee is hereby granted, provided that the above
8
.\" copyright notice and this permission notice appear in all copies.
9
.\"
10
.\" THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
11
.\" WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
12
.\" MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
13
.\" ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
14
.\" WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
15
.\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
16
.\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
17
.\"
18
.Dd $Mdocdate$
19
.Dt KHTTP_URLDECODE 3
20
.Os
21
.Sh NAME
22
.Nm khttp_urldecode ,
23
.Nm khttp_urldecode_inplace
24
.Nd URL decoding for kcgi
25
.Sh LIBRARY
26
.Lb libkcgi
27
.Sh SYNOPSIS
28
.In sys/types.h
29
.In stdarg.h
30
.In stdint.h
31
.In kcgi.h
32
.Ft "enum kcgi_err"
33
.Fo khttp_urldecode
34
.Fa "const char *src"
35
.Fa "char **dst"
36
.Fc
37
.Ft "enum kcgi_err"
38
.Fo khttp_urldecode_inplace
39
.Fa "char *src"
40
.Fc
41
.Sh DESCRIPTION
42
Decode the percent-encoded string
43
.Fa src .
44
In
45
.Fn khttp_urldecode ,
46
the result is placed in
47
.Fa dst .
48
In
49
.Fn khttp_urldecode_inplace ,
50
the input string
51
.Fa src
52
is overwritten with the result, which will be the same or shorter in
53
length.
54
.Pp
55
These accept uppercase and lowercase percent encoding, for example.
56
.Qq %A0
57
or
58
.Qq %a0 ,
59
respectively.
60
.Pp
61
The deprecated form of these functions,
62
.Fn kutil_urldecode
63
and
64
.Fn kutil_urldecode_inplace ,
65
should no longer be used.
66
.Sh RETURN VALUES
67
.Fn khttp_urldecode
68
and
69
.Fn khttp_urldecode_inplace
70
return an error code:
71
.Bl -tag -width -Ds
72
.It Dv KCGI_OK
73
Success (not an error).
74
.It Dv KCGI_ENOMEM
75
Memory failure (only
76
.Fn khttp_urldecode ) .
77
.It Dv KCGI_FORM
78
Malformed input or
79
.Dv NULL
80
.Fa src
81
or
82
.Fa dst
83
arguments.
84
.El
85
.Pp
86
If
87
.Fn khttp_urldecode
88
returns an error, it always sets
89
.Fa dst
90
to
91
.Dv NULL .
92
.Fn khttp_urldecode_inplace ,
93
however, may leave a partially-decoded string in
94
.Fa src .
95
.\" .Sh EXAMPLES
96
.Sh AUTHORS
97
Written by
98
.An Kristaps Dzonsons Aq Mt kristaps@bsd.lv .
99