1 /* Declarations for url.c.
2 Copyright (C) 1995, 1996, 1997 Free Software Foundation, Inc.
4 This file is part of GNU Wget.
6 GNU Wget is free software; you can redistribute it and/or modify
7 it under the terms of the GNU General Public License as published by
8 the Free Software Foundation; either version 2 of the License, or
9 (at your option) any later version.
11 GNU Wget is distributed in the hope that it will be useful,
12 but WITHOUT ANY WARRANTY; without even the implied warranty of
13 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 GNU General Public License for more details.
16 You should have received a copy of the GNU General Public License
17 along with Wget; if not, write to the Free Software
18 Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA. */
23 /* Default port definitions */
24 #define DEFAULT_HTTP_PORT 80
25 #define DEFAULT_FTP_PORT 21
26 #define DEFAULT_HTTPS_PORT 443
28 /* Note: the ordering here is related to the order of elements in
29 `supported_schemes' in url.c. */
40 /* Structure containing info on a URL. */
43 char *url; /* Original URL */
44 enum url_scheme scheme; /* URL scheme */
46 char *host; /* Extracted hostname */
47 int port; /* Port number */
49 /* URL components (URL-quoted). */
55 /* Extracted path info (unquoted). */
59 /* Username and password (unquoted). */
64 enum convert_options {
65 CO_NOCONVERT = 0, /* don't convert this URL */
66 CO_CONVERT_TO_RELATIVE, /* convert to relative, e.g. to
67 "../../otherdir/foo.gif" */
68 CO_CONVERT_TO_COMPLETE, /* convert to absolute, e.g. to
69 "http://orighost/somedir/bar.jpg". */
70 CO_NULLIFY_BASE /* change to empty string. */
73 /* A structure that defines the whereabouts of a URL, i.e. its
74 position in an HTML document, etc. */
77 struct url *url; /* the URL of the link, after it has
78 been merged with the base */
79 char *local_name; /* local file to which it was saved
80 (used by convert_links) */
82 /* reserved for special links such as <base href="..."> which are
83 used when converting links, but ignored when downloading. */
84 unsigned int ignore_when_downloading :1;
86 /* Information about the original link: */
88 unsigned int link_relative_p :1; /* was the link relative? */
89 unsigned int link_complete_p :1; /* was the link complete (with the
91 unsigned int link_base_p :1; /* was the link <base href=...> */
92 unsigned int link_inline_p :1; /* needed to render the page. */
94 /* Conversion requirements: */
95 enum convert_options convert; /* is conversion required? */
97 /* URL's position in the buffer. */
100 struct urlpos *next; /* next list element */
103 /* downloaded_file() takes a parameter of this type and returns this type. */
106 /* Return enumerators: */
107 FILE_NOT_ALREADY_DOWNLOADED = 0,
109 /* Return / parameter enumerators: */
110 FILE_DOWNLOADED_NORMALLY,
111 FILE_DOWNLOADED_AND_HTML_EXTENSION_ADDED,
113 /* Parameter enumerators: */
117 /* Function declarations */
119 char *encode_string PARAMS ((const char *));
121 struct url *url_parse PARAMS ((const char *, int *));
122 const char *url_error PARAMS ((int));
123 char *url_full_path PARAMS ((const struct url *));
124 void url_set_dir PARAMS ((struct url *, const char *));
125 void url_set_file PARAMS ((struct url *, const char *));
126 void url_free PARAMS ((struct url *));
128 enum url_scheme url_scheme PARAMS ((const char *));
129 int url_skip_scheme PARAMS ((const char *));
130 int url_has_scheme PARAMS ((const char *));
131 int scheme_default_port PARAMS ((enum url_scheme));
133 int url_skip_uname PARAMS ((const char *));
135 char *url_string PARAMS ((const struct url *, int));
137 struct urlpos *get_urls_file PARAMS ((const char *));
138 struct urlpos *get_urls_html PARAMS ((const char *, const char *, int *));
139 void free_urlpos PARAMS ((struct urlpos *));
141 char *uri_merge PARAMS ((const char *, const char *));
143 void rotate_backups PARAMS ((const char *));
144 int mkalldirs PARAMS ((const char *));
145 char *url_filename PARAMS ((const struct url *));
147 char *getproxy PARAMS ((enum url_scheme));
148 int no_proxy_match PARAMS ((const char *, const char **));
150 void convert_links PARAMS ((const char *, struct urlpos *));
152 downloaded_file_t downloaded_file PARAMS ((downloaded_file_t, const char *));
154 char *rewrite_shorthand_url PARAMS ((const char *));