]> sjero.net Git - wget/blob - src/url.h
gnutls: deinit gnutls_x509_crt_t
[wget] / src / url.h
1 /* Declarations for url.c.
2    Copyright (C) 1996, 1997, 1998, 1999, 2000, 2001, 2002, 2003, 2004,
3    2005, 2006, 2007, 2008, 2009, 2010, 2011 Free Software Foundation,
4    Inc.
5
6 This file is part of GNU Wget.
7
8 GNU Wget is free software; you can redistribute it and/or modify
9 it under the terms of the GNU General Public License as published by
10 the Free Software Foundation; either version 3 of the License, or
11 (at your option) any later version.
12
13 GNU Wget is distributed in the hope that it will be useful,
14 but WITHOUT ANY WARRANTY; without even the implied warranty of
15 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
16 GNU General Public License for more details.
17
18 You should have received a copy of the GNU General Public License
19 along with Wget.  If not, see <http://www.gnu.org/licenses/>.
20
21 Additional permission under GNU GPL version 3 section 7
22
23 If you modify this program, or any covered work, by linking or
24 combining it with the OpenSSL project's OpenSSL library (or a
25 modified version of that library), containing parts covered by the
26 terms of the OpenSSL or SSLeay licenses, the Free Software Foundation
27 grants you additional permission to convey the resulting work.
28 Corresponding Source for a non-source form of such a combination
29 shall include the source code for the parts of OpenSSL used as well
30 as that of the covered work.  */
31
32 #ifndef URL_H
33 #define URL_H
34
35 /* Default port definitions */
36 #define DEFAULT_HTTP_PORT 80
37 #define DEFAULT_FTP_PORT 21
38 #define DEFAULT_HTTPS_PORT 443
39
40 /* Specifies how, or whether, user auth information should be included
41  * in URLs regenerated from URL parse structures. */
42 enum url_auth_mode {
43   URL_AUTH_SHOW,
44   URL_AUTH_HIDE_PASSWD,
45   URL_AUTH_HIDE
46 };
47
48 /* Note: the ordering here is related to the order of elements in
49    `supported_schemes' in url.c.  */
50
51 enum url_scheme {
52   SCHEME_HTTP,
53 #ifdef HAVE_SSL
54   SCHEME_HTTPS,
55 #endif
56   SCHEME_FTP,
57   SCHEME_INVALID
58 };
59
60 /* Structure containing info on a URL.  */
61 struct url
62 {
63   char *url;                    /* Original URL */
64   enum url_scheme scheme;       /* URL scheme */
65
66   char *host;                   /* Extracted hostname */
67   int port;                     /* Port number */
68
69   /* URL components (URL-quoted). */
70   char *path;
71   char *params;
72   char *query;
73   char *fragment;
74
75   /* Extracted path info (unquoted). */
76   char *dir;
77   char *file;
78
79   /* Username and password (unquoted). */
80   char *user;
81   char *passwd;
82 };
83
84 /* Function declarations */
85
86 char *url_escape (const char *);
87 char *url_escape_unsafe_and_reserved (const char *);
88
89 struct url *url_parse (const char *, int *, struct iri *iri, bool percent_encode);
90 char *url_error (const char *, int);
91 char *url_full_path (const struct url *);
92 void url_set_dir (struct url *, const char *);
93 void url_set_file (struct url *, const char *);
94 void url_free (struct url *);
95
96 enum url_scheme url_scheme (const char *);
97 bool url_has_scheme (const char *);
98 bool url_valid_scheme (const char *);
99 int scheme_default_port (enum url_scheme);
100 void scheme_disable (enum url_scheme);
101
102 char *url_string (const struct url *, enum url_auth_mode);
103 char *url_file_name (const struct url *, char *);
104
105 char *uri_merge (const char *, const char *);
106
107 int mkalldirs (const char *);
108
109 char *rewrite_shorthand_url (const char *);
110 bool schemes_are_similar_p (enum url_scheme a, enum url_scheme b);
111
112 bool are_urls_equal (const char *u1, const char *u2);
113
114 #endif /* URL_H */