1#ifndef CURLINC_URLAPI_H
2#define CURLINC_URLAPI_H
3/***************************************************************************
4 * _ _ ____ _
5 * Project ___| | | | _ \| |
6 * / __| | | | |_) | |
7 * | (__| |_| | _ <| |___
8 * \___|\___/|_| \_\_____|
9 *
10 * Copyright (C) Daniel Stenberg, <daniel@haxx.se>, et al.
11 *
12 * This software is licensed as described in the file COPYING, which
13 * you should have received as part of this distribution. The terms
14 * are also available at https://curl.se/docs/copyright.html.
15 *
16 * You may opt to use, copy, modify, merge, publish, distribute and/or sell
17 * copies of the Software, and permit persons to whom the Software is
18 * furnished to do so, under the terms of the COPYING file.
19 *
20 * This software is distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY
21 * KIND, either express or implied.
22 *
23 * SPDX-License-Identifier: curl
24 *
25 ***************************************************************************/
26
27#include "curl.h"
28
29#ifdef __cplusplus
30extern "C" {
31#endif
32
33/* the error codes for the URL API */
34typedef enum {
35 CURLUE_OK,
36 CURLUE_BAD_HANDLE, /* 1 */
37 CURLUE_BAD_PARTPOINTER, /* 2 */
38 CURLUE_MALFORMED_INPUT, /* 3 */
39 CURLUE_BAD_PORT_NUMBER, /* 4 */
40 CURLUE_UNSUPPORTED_SCHEME, /* 5 */
41 CURLUE_URLDECODE, /* 6 */
42 CURLUE_OUT_OF_MEMORY, /* 7 */
43 CURLUE_USER_NOT_ALLOWED, /* 8 */
44 CURLUE_UNKNOWN_PART, /* 9 */
45 CURLUE_NO_SCHEME, /* 10 */
46 CURLUE_NO_USER, /* 11 */
47 CURLUE_NO_PASSWORD, /* 12 */
48 CURLUE_NO_OPTIONS, /* 13 */
49 CURLUE_NO_HOST, /* 14 */
50 CURLUE_NO_PORT, /* 15 */
51 CURLUE_NO_QUERY, /* 16 */
52 CURLUE_NO_FRAGMENT, /* 17 */
53 CURLUE_NO_ZONEID, /* 18 */
54 CURLUE_BAD_FILE_URL, /* 19 */
55 CURLUE_BAD_FRAGMENT, /* 20 */
56 CURLUE_BAD_HOSTNAME, /* 21 */
57 CURLUE_BAD_IPV6, /* 22 */
58 CURLUE_BAD_LOGIN, /* 23 */
59 CURLUE_BAD_PASSWORD, /* 24 */
60 CURLUE_BAD_PATH, /* 25 */
61 CURLUE_BAD_QUERY, /* 26 */
62 CURLUE_BAD_SCHEME, /* 27 */
63 CURLUE_BAD_SLASHES, /* 28 */
64 CURLUE_BAD_USER, /* 29 */
65 CURLUE_LACKS_IDN, /* 30 */
66 CURLUE_LAST
67} CURLUcode;
68
69typedef enum {
70 CURLUPART_URL,
71 CURLUPART_SCHEME,
72 CURLUPART_USER,
73 CURLUPART_PASSWORD,
74 CURLUPART_OPTIONS,
75 CURLUPART_HOST,
76 CURLUPART_PORT,
77 CURLUPART_PATH,
78 CURLUPART_QUERY,
79 CURLUPART_FRAGMENT,
80 CURLUPART_ZONEID /* added in 7.65.0 */
81} CURLUPart;
82
83#define CURLU_DEFAULT_PORT (1<<0) /* return default port number */
84#define CURLU_NO_DEFAULT_PORT (1<<1) /* act as if no port number was set,
85 if the port number matches the
86 default for the scheme */
87#define CURLU_DEFAULT_SCHEME (1<<2) /* return default scheme if
88 missing */
89#define CURLU_NON_SUPPORT_SCHEME (1<<3) /* allow non-supported scheme */
90#define CURLU_PATH_AS_IS (1<<4) /* leave dot sequences */
91#define CURLU_DISALLOW_USER (1<<5) /* no user+password allowed */
92#define CURLU_URLDECODE (1<<6) /* URL decode on get */
93#define CURLU_URLENCODE (1<<7) /* URL encode on set */
94#define CURLU_APPENDQUERY (1<<8) /* append a form style part */
95#define CURLU_GUESS_SCHEME (1<<9) /* legacy curl-style guessing */
96#define CURLU_NO_AUTHORITY (1<<10) /* Allow empty authority when the
97 scheme is unknown. */
98#define CURLU_ALLOW_SPACE (1<<11) /* Allow spaces in the URL */
99#define CURLU_PUNYCODE (1<<12) /* get the host name in punycode */
100#define CURLU_PUNY2IDN (1<<13) /* punycode => IDN conversion */
101
102typedef struct Curl_URL CURLU;
103
104/*
105 * curl_url() creates a new CURLU handle and returns a pointer to it.
106 * Must be freed with curl_url_cleanup().
107 */
108CURL_EXTERN CURLU *curl_url(void);
109
110/*
111 * curl_url_cleanup() frees the CURLU handle and related resources used for
112 * the URL parsing. It will not free strings previously returned with the URL
113 * API.
114 */
115CURL_EXTERN void curl_url_cleanup(CURLU *handle);
116
117/*
118 * curl_url_dup() duplicates a CURLU handle and returns a new copy. The new
119 * handle must also be freed with curl_url_cleanup().
120 */
121CURL_EXTERN CURLU *curl_url_dup(const CURLU *in);
122
123/*
124 * curl_url_get() extracts a specific part of the URL from a CURLU
125 * handle. Returns error code. The returned pointer MUST be freed with
126 * curl_free() afterwards.
127 */
128CURL_EXTERN CURLUcode curl_url_get(const CURLU *handle, CURLUPart what,
129 char **part, unsigned int flags);
130
131/*
132 * curl_url_set() sets a specific part of the URL in a CURLU handle. Returns
133 * error code. The passed in string will be copied. Passing a NULL instead of
134 * a part string, clears that part.
135 */
136CURL_EXTERN CURLUcode curl_url_set(CURLU *handle, CURLUPart what,
137 const char *part, unsigned int flags);
138
139/*
140 * curl_url_strerror() turns a CURLUcode value into the equivalent human
141 * readable error string. This is useful for printing meaningful error
142 * messages.
143 */
144CURL_EXTERN const char *curl_url_strerror(CURLUcode);
145
146#ifdef __cplusplus
147} /* end of extern "C" */
148#endif
149
150#endif /* CURLINC_URLAPI_H */
151