| 1 |
/* Declarations for url.c. |
| 2 |
Copyright (C) 1996-2011, 2015, 2018-2024 Free Software Foundation, |
| 3 |
Inc. |
| 4 |
|
| 5 |
This file is part of GNU Wget. |
| 6 |
|
| 7 |
GNU Wget is free software; you can redistribute it and/or modify |
| 8 |
it under the terms of the GNU General Public License as published by |
| 9 |
the Free Software Foundation; either version 3 of the License, or |
| 10 |
(at your option) any later version. |
| 11 |
|
| 12 |
GNU Wget is distributed in the hope that it will be useful, |
| 13 |
but WITHOUT ANY WARRANTY; without even the implied warranty of |
| 14 |
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the |
| 15 |
GNU General Public License for more details. |
| 16 |
|
| 17 |
You should have received a copy of the GNU General Public License |
| 18 |
along with Wget. If not, see <http://www.gnu.org/licenses/>. |
| 19 |
|
| 20 |
Additional permission under GNU GPL version 3 section 7 |
| 21 |
|
| 22 |
If you modify this program, or any covered work, by linking or |
| 23 |
combining it with the OpenSSL project's OpenSSL library (or a |
| 24 |
modified version of that library), containing parts covered by the |
| 25 |
terms of the OpenSSL or SSLeay licenses, the Free Software Foundation |
| 26 |
grants you additional permission to convey the resulting work. |
| 27 |
Corresponding Source for a non-source form of such a combination |
| 28 |
shall include the source code for the parts of OpenSSL used as well |
| 29 |
as that of the covered work. */ |
| 30 |
|
| 31 |
#ifndef URL_H |
| 32 |
#define URL_H |
| 33 |
|
| 34 |
/* Default port definitions */ |
| 35 |
#define DEFAULT_HTTP_PORT 80 |
| 36 |
#define DEFAULT_FTP_PORT 21 |
| 37 |
#define DEFAULT_HTTPS_PORT 443 |
| 38 |
#define DEFAULT_FTPS_IMPLICIT_PORT 990 |
| 39 |
|
| 40 |
/* This represents how many characters less than the OS max name length a file |
| 41 |
* should be. More precisely, a file name should be at most |
| 42 |
* (NAME_MAX - CHOMP_BUFFER) characters in length. This number was arrived at |
| 43 |
* by adding the lengths of all possible strings that could be appended to a |
| 44 |
* file name later in the code (e.g. ".orig", ".html", etc.). This is |
| 45 |
* hopefully plenty of extra characters, but I am not guaranteeing that a file |
| 46 |
* name will be of the proper length by the time the code wants to open a |
| 47 |
* file descriptor. */ |
| 48 |
#define CHOMP_BUFFER 19 |
| 49 |
|
| 50 |
/* The flags that allow clobbering the file (opening with "wb"). |
| 51 |
Defined here to avoid repetition later. #### This will require |
| 52 |
rework. */ |
| 53 |
#define ALLOW_CLOBBER (opt.noclobber || opt.always_rest || opt.timestamping \ |
| 54 |
|| opt.dirstruct || opt.output_document || opt.backups > 0) |
| 55 |
|
| 56 |
/* Specifies how, or whether, user auth information should be included |
| 57 |
* in URLs regenerated from URL parse structures. */ |
| 58 |
enum url_auth_mode { |
| 59 |
URL_AUTH_SHOW, |
| 60 |
URL_AUTH_HIDE_PASSWD, |
| 61 |
URL_AUTH_HIDE |
| 62 |
}; |
| 63 |
|
| 64 |
/* Note: the ordering here is related to the order of elements in |
| 65 |
`supported_schemes' in url.c. */ |
| 66 |
|
| 67 |
enum url_scheme { |
| 68 |
SCHEME_HTTP, |
| 69 |
#ifdef HAVE_SSL |
| 70 |
SCHEME_HTTPS, |
| 71 |
#endif |
| 72 |
SCHEME_FTP, |
| 73 |
#ifdef HAVE_SSL |
| 74 |
SCHEME_FTPS, |
| 75 |
#endif |
| 76 |
SCHEME_INVALID |
| 77 |
}; |
| 78 |
|
| 79 |
/* Structure containing info on a URL. */ |
| 80 |
struct url |
| 81 |
{ |
| 82 |
char *url; /* Original URL */ |
| 83 |
enum url_scheme scheme; /* URL scheme */ |
| 84 |
|
| 85 |
char *host; /* Extracted hostname */ |
| 86 |
int port; /* Port number */ |
| 87 |
|
| 88 |
/* URL components (URL-quoted). */ |
| 89 |
char *path; |
| 90 |
char *params; |
| 91 |
char *query; |
| 92 |
char *fragment; |
| 93 |
|
| 94 |
/* Extracted path info (unquoted). */ |
| 95 |
char *dir; |
| 96 |
char *file; |
| 97 |
|
| 98 |
/* Username and password (unquoted). */ |
| 99 |
char *user; |
| 100 |
char *passwd; |
| 101 |
}; |
| 102 |
|
| 103 |
/* Function declarations */ |
| 104 |
|
| 105 |
char *url_escape (const char *); |
| 106 |
char *url_escape_unsafe_and_reserved (const char *); |
| 107 |
void url_unescape (char *); |
| 108 |
void url_unescape_except_reserved (char *); |
| 109 |
|
| 110 |
struct url *url_parse (const char *, int *, struct iri *iri, bool percent_encode); |
| 111 |
const char *url_error (int); |
| 112 |
char *url_full_path (const struct url *); |
| 113 |
void url_set_dir (struct url *, const char *); |
| 114 |
void url_set_file (struct url *, const char *); |
| 115 |
void url_free (struct url *); |
| 116 |
|
| 117 |
enum url_scheme url_scheme (const char *); |
| 118 |
bool url_has_scheme (const char *); |
| 119 |
bool url_valid_scheme (const char *); |
| 120 |
int scheme_default_port (enum url_scheme); |
| 121 |
void scheme_disable (enum url_scheme); |
| 122 |
const char *scheme_leading_string (enum url_scheme); |
| 123 |
|
| 124 |
char *url_string (const struct url *, enum url_auth_mode); |
| 125 |
char *url_file_name (const struct url *, char *); |
| 126 |
|
| 127 |
char *uri_merge (const char *, const char *); |
| 128 |
|
| 129 |
int mkalldirs (const char *); |
| 130 |
|
| 131 |
char *maybe_prepend_scheme (const char *); |
| 132 |
bool schemes_are_similar_p (enum url_scheme a, enum url_scheme b); |
| 133 |
|
| 134 |
bool are_urls_equal (const char *u1, const char *u2); |
| 135 |
|
| 136 |
#endif /* URL_H */ |