/* Declarations for url.c.
Copyright (C) 1995, 1996, 1997 Free Software Foundation, Inc.
-This file is part of Wget.
+This file is part of GNU Wget.
-This program is free software; you can redistribute it and/or modify
+GNU Wget is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation; either version 2 of the License, or
(at your option) any later version.
-This program is distributed in the hope that it will be useful,
+GNU Wget is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
You should have received a copy of the GNU General Public License
-along with this program; if not, write to the Free Software
-Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA. */
+along with Wget; if not, write to the Free Software
+Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
+
+In addition, as a special exception, the Free Software Foundation
+gives permission to link the code of its release of Wget with the
+OpenSSL project's "OpenSSL" library (or with modified versions of it
+that use the same license as the "OpenSSL" library), and distribute
+the linked executables. You must obey the GNU General Public License
+in all respects for all of the code used other than "OpenSSL". If you
+modify this file, you may extend this exception to your version of the
+file, but you are not obligated to do so. If you do not wish to do
+so, delete this exception statement from your version. */
#ifndef URL_H
#define URL_H
#define DEFAULT_FTP_PORT 21
#define DEFAULT_HTTPS_PORT 443
+/* Note: the ordering here is related to the order of elements in
+ `supported_schemes' in url.c. */
-/* Structure containing info on a URL. */
-struct urlinfo
-{
- char *url; /* Unchanged URL */
- uerr_t proto; /* URL protocol */
- char *host; /* Extracted hostname */
- unsigned short port;
- char ftp_type;
- char *path, *dir, *file, *qstring;
- /* Path, dir, file, and query string
- (properly decoded) */
- char *user, *passwd; /* Username and password */
- struct urlinfo *proxy; /* The exact string to pass to proxy
- server */
- char *referer; /* The source from which the request
- URI was obtained */
- char *local; /* The local filename of the URL
- document */
-};
-
-enum convert_options {
- CO_NOCONVERT = 0, /* don't convert this URL */
- CO_CONVERT_TO_RELATIVE, /* convert to relative, e.g. to
- "../../otherdir/foo.gif" */
- CO_CONVERT_TO_COMPLETE /* convert to absolute, e.g. to
- "http://orighost/somedir/bar.jpg". */
+enum url_scheme {
+ SCHEME_HTTP,
+#ifdef HAVE_SSL
+ SCHEME_HTTPS,
+#endif
+ SCHEME_FTP,
+ SCHEME_INVALID
};
-/* A structure that defines the whereabouts of a URL, i.e. its
- position in an HTML document, etc. */
-
-typedef struct _urlpos
+/* Structure containing info on a URL. */
+struct url
{
- char *url; /* linked URL, after it has been
- merged with the base */
- char *local_name; /* Local file to which it was saved */
-
- /* Information about the original link: */
- int link_relative_p; /* was the link relative? */
- int link_complete_p; /* was the link complete (with the
- host name, etc.) */
+ char *url; /* Original URL */
+ enum url_scheme scheme; /* URL scheme */
- /* Conversion requirements: */
- enum convert_options convert; /* is conversion required? */
-
- /* URL's position in the buffer. */
- int pos, size;
-
- struct _urlpos *next; /* Next struct in list */
-} urlpos;
+ char *host; /* Extracted hostname */
+ int port; /* Port number */
-/* downloaded_file() takes a parameter of this type and returns this type. */
-typedef enum
-{
- /* Return enumerators: */
- FILE_NOT_ALREADY_DOWNLOADED = 0,
+ /* URL components (URL-quoted). */
+ char *path;
+ char *params;
+ char *query;
+ char *fragment;
- /* Return / parameter enumerators: */
- FILE_DOWNLOADED_NORMALLY,
- FILE_DOWNLOADED_AND_HTML_EXTENSION_ADDED,
+ /* Extracted path info (unquoted). */
+ char *dir;
+ char *file;
- /* Parameter enumerators: */
- CHECK_FOR_FILE
-} downloaded_file_t;
+ /* Username and password (unquoted). */
+ char *user;
+ char *passwd;
+};
/* Function declarations */
-char *encode_string PARAMS ((const char *));
+char *url_escape PARAMS ((const char *));
-struct urlinfo *newurl PARAMS ((void));
-void freeurl PARAMS ((struct urlinfo *, int));
-uerr_t urlproto PARAMS ((const char *));
-int skip_proto PARAMS ((const char *));
-int has_proto PARAMS ((const char *));
-int skip_uname PARAMS ((const char *));
+struct url *url_parse PARAMS ((const char *, int *));
+const char *url_error PARAMS ((int));
+char *url_full_path PARAMS ((const struct url *));
+void url_set_dir PARAMS ((struct url *, const char *));
+void url_set_file PARAMS ((struct url *, const char *));
+void url_free PARAMS ((struct url *));
-uerr_t parseurl PARAMS ((const char *, struct urlinfo *, int));
-char *str_url PARAMS ((const struct urlinfo *, int));
-int url_equal PARAMS ((const char *, const char *));
+enum url_scheme url_scheme PARAMS ((const char *));
+int url_has_scheme PARAMS ((const char *));
+int scheme_default_port PARAMS ((enum url_scheme));
+void scheme_disable PARAMS ((enum url_scheme));
-urlpos *get_urls_file PARAMS ((const char *));
-urlpos *get_urls_html PARAMS ((const char *, const char *, int, int *));
-void free_urlpos PARAMS ((urlpos *));
+char *url_string PARAMS ((const struct url *, int));
+char *url_file_name PARAMS ((const struct url *));
char *uri_merge PARAMS ((const char *, const char *));
-void rotate_backups PARAMS ((const char *));
int mkalldirs PARAMS ((const char *));
-char *url_filename PARAMS ((const struct urlinfo *));
-void opt_url PARAMS ((struct urlinfo *));
-
-char *getproxy PARAMS ((uerr_t));
-int no_proxy_match PARAMS ((const char *, const char **));
-
-void convert_links PARAMS ((const char *, urlpos *));
-urlpos *add_url PARAMS ((urlpos *, const char *, const char *));
-downloaded_file_t downloaded_file PARAMS ((downloaded_file_t, const char *));
+char *rewrite_shorthand_url PARAMS ((const char *));
+int schemes_are_similar_p PARAMS ((enum url_scheme a, enum url_scheme b));
#endif /* URL_H */