/* Declarations for url.c.
- Copyright (C) 1995, 1996, 1997 Free Software Foundation, Inc.
+ Copyright (C) 1996, 1997, 1998, 1999, 2000, 2001, 2002, 2003, 2004,
+ 2005, 2006, 2007, 2008, 2009, 2010, 2011 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
+the Free Software Foundation; either version 3 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, see <http://www.gnu.org/licenses/>.
+
+Additional permission under GNU GPL version 3 section 7
+
+If you modify this program, or any covered work, by linking or
+combining it with the OpenSSL project's OpenSSL library (or a
+modified version of that library), containing parts covered by the
+terms of the OpenSSL or SSLeay licenses, the Free Software Foundation
+grants you additional permission to convey the resulting work.
+Corresponding Source for a non-source form of such a combination
+shall include the source code for the parts of OpenSSL used as well
+as that of the covered work. */
#ifndef URL_H
#define URL_H
-/* If the string contains unsafe characters, duplicate it with
- encode_string, otherwise just copy it with strdup. */
-#define CLEANDUP(x) (contains_unsafe (x) ? encode_string (x) : xstrdup (x))
+/* Default port definitions */
+#define DEFAULT_HTTP_PORT 80
+#define DEFAULT_FTP_PORT 21
+#define DEFAULT_HTTPS_PORT 443
+
+/* This represents how many characters less than the OS max name length a file
+ * should be. More precisely, a file name should be at most
+ * (NAME_MAX - CHOMP_BUFFER) characters in length. This number was arrived at
+ * by adding the lengths of all possible strings that could be appended to a
+ * file name later in the code (e.g. ".orig", ".html", etc.). This is
+ * hopefully plenty of extra characters, but I am not guaranteeing that a file
+ * name will be of the proper length by the time the code wants to open a
+ * file descriptor. */
+#define CHOMP_BUFFER 19
+
+/* The flags that allow clobbering the file (opening with "wb").
+ Defined here to avoid repetition later. #### This will require
+ rework. */
+#define ALLOW_CLOBBER (opt.noclobber || opt.always_rest || opt.timestamping \
+ || opt.dirstruct || opt.output_document || opt.backups > 0)
+
+/* Specifies how, or whether, user auth information should be included
+ * in URLs regenerated from URL parse structures. */
+enum url_auth_mode {
+ URL_AUTH_SHOW,
+ URL_AUTH_HIDE_PASSWD,
+ URL_AUTH_HIDE
+};
+
+/* Note: the ordering here is related to the order of elements in
+ `supported_schemes' in url.c. */
+
+enum url_scheme {
+ SCHEME_HTTP,
+#ifdef HAVE_SSL
+ SCHEME_HTTPS,
+#endif
+ SCHEME_FTP,
+ SCHEME_INVALID
+};
/* Structure containing info on a URL. */
-struct urlinfo
+struct url
{
- char *url; /* Unchanged URL */
- uerr_t proto; /* URL protocol */
+ char *url; /* Original URL */
+ enum url_scheme scheme; /* URL scheme */
+
char *host; /* Extracted hostname */
- unsigned short port;
- char ftp_type;
- char *path, *dir, *file; /* Path, as well as dir and file
- (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 */
-};
+ int port; /* Port number */
-enum uflags
-{
- URELATIVE = 0x0001, /* Is URL relative? */
- UNOPROTO = 0x0002, /* Is URL without a protocol? */
- UABS2REL = 0x0004, /* Convert absolute to relative? */
- UREL2ABS = 0x0008 /* Convert relative to absolute? */
-};
+ /* URL components (URL-quoted). */
+ char *path;
+ char *params;
+ char *query;
+ char *fragment;
-/* A structure that defines the whereabouts of a URL, i.e. its
- position in an HTML document, etc. */
-typedef struct _urlpos
-{
- char *url; /* URL */
- char *local_name; /* Local file to which it was saved */
- enum uflags flags; /* Various flags */
- int pos, size; /* Relative position in the buffer */
- struct _urlpos *next; /* Next struct in list */
-} urlpos;
-
-/* Controls how downloaded_file() behaves. */
-typedef enum
-{
- ADD_FILE,
- CHECK_FOR_FILE
-} downloaded_file_t;
+ /* Extracted path info (unquoted). */
+ char *dir;
+ char *file;
-/* Function declarations */
+ /* Username and password (unquoted). */
+ char *user;
+ char *passwd;
+};
-int skip_url PARAMS ((const char *));
+/* Function declarations */
-int contains_unsafe PARAMS ((const char *));
-char *encode_string PARAMS ((const char *));
+char *url_escape (const char *);
+char *url_escape_unsafe_and_reserved (const char *);
+void url_unescape (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 skip_uname PARAMS ((const char *));
+struct url *url_parse (const char *, int *, struct iri *iri, bool percent_encode);
+char *url_error (const char *, int);
+char *url_full_path (const struct url *);
+void url_set_dir (struct url *, const char *);
+void url_set_file (struct url *, const char *);
+void url_free (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 (const char *);
+bool url_has_scheme (const char *);
+bool url_valid_scheme (const char *);
+int scheme_default_port (enum url_scheme);
+void scheme_disable (enum url_scheme);
-urlpos *get_urls_file PARAMS ((const char *));
-urlpos *get_urls_html PARAMS ((const char *, const char *, int));
-void free_urlpos PARAMS ((urlpos *));
+char *url_string (const struct url *, enum url_auth_mode);
+char *url_file_name (const struct url *, 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 *uri_merge (const char *, const char *);
-char *getproxy PARAMS ((uerr_t));
-int no_proxy_match PARAMS ((const char *, const char **));
+int mkalldirs (const char *);
-void convert_links PARAMS ((const char *, urlpos *));
-urlpos *add_url PARAMS ((urlpos *, const char *, const char *));
+char *rewrite_shorthand_url (const char *);
+bool schemes_are_similar_p (enum url_scheme a, enum url_scheme b);
-boolean downloaded_file PARAMS ((downloaded_file_t, const char *));
+bool are_urls_equal (const char *u1, const char *u2);
#endif /* URL_H */
projects / wget / blobdiff