X-Git-Url: http://sjero.net/git/?p=wget;a=blobdiff_plain;f=src%2Furl.h;h=6d18ed81f1f3c21d13e6af2131972136284b9af7;hp=0f55ec35b803d81ae97556aaaa0103f5861eb461;hb=38a7829dcb4eb5dba28dbf0f05c6a80fea9217f8;hpb=0dd418242a66f82def061205fc6366ae63223723 diff --git a/src/url.h b/src/url.h index 0f55ec35..6d18ed81 100644 --- a/src/url.h +++ b/src/url.h @@ -1,116 +1,131 @@ /* 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 . + +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)) - -/* 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 */ +/* 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 }; -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? */ +/* 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 }; -/* 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; - -/* downloaded_file() takes a parameter of this type and returns this type. */ -typedef enum +/* Structure containing info on a URL. */ +struct url { - /* Return enumerators: */ - FILE_NOT_ALREADY_DOWNLOADED = 0, + char *url; /* Original URL */ + enum url_scheme scheme; /* URL scheme */ - /* Return / parameter enumerators: */ - FILE_DOWNLOADED_NORMALLY, - FILE_DOWNLOADED_AND_HTML_EXTENSION_ADDED, + char *host; /* Extracted hostname */ + int port; /* Port number */ - /* Parameter enumerators: */ - CHECK_FOR_FILE -} downloaded_file_t; + /* URL components (URL-quoted). */ + char *path; + char *params; + char *query; + char *fragment; -/* Function declarations */ + /* Extracted path info (unquoted). */ + char *dir; + char *file; -int skip_url PARAMS ((const char *)); + /* Username and password (unquoted). */ + char *user; + char *passwd; +}; -int contains_unsafe PARAMS ((const char *)); -char *encode_string PARAMS ((const char *)); +/* Function declarations */ -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 *)); +char *url_escape (const char *); +char *url_escape_unsafe_and_reserved (const char *); +void url_unescape (char *); -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 *)); +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 *); -urlpos *get_urls_file PARAMS ((const char *)); -urlpos *get_urls_html PARAMS ((const char *, const char *, int, int)); -void free_urlpos PARAMS ((urlpos *)); +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); -char *url_concat PARAMS ((const char *, const char *)); +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); -downloaded_file_t downloaded_file PARAMS ((downloaded_file_t, const char *)); +bool are_urls_equal (const char *u1, const char *u2); #endif /* URL_H */