X-Git-Url: http://sjero.net/git/?p=wget;a=blobdiff_plain;f=src%2Furl.h;h=6d18ed81f1f3c21d13e6af2131972136284b9af7;hp=d80fe54da59e5f6aff56aea86514b96a113956d4;hb=38a7829dcb4eb5dba28dbf0f05c6a80fea9217f8;hpb=0a3697ad652df74ffeec8a97e1d23c343d8ef391 diff --git a/src/url.h b/src/url.h index d80fe54d..6d18ed81 100644 --- a/src/url.h +++ b/src/url.h @@ -1,11 +1,13 @@ /* 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 GNU Wget. 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. GNU Wget is distributed in the hope that it will be useful, @@ -14,18 +16,18 @@ 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 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. */ +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 @@ -35,6 +37,30 @@ so, delete this exception statement from your version. */ #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. */ @@ -71,103 +97,35 @@ struct url char *passwd; }; -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". */ - CO_NULLIFY_BASE /* change to empty string. */ -}; - -/* A structure that defines the whereabouts of a URL, i.e. its - position in an HTML document, etc. */ - -struct urlpos { - struct url *url; /* the URL of the link, after it has - been merged with the base */ - char *local_name; /* local file to which it was saved - (used by convert_links) */ - - /* reserved for special links such as which are - used when converting links, but ignored when downloading. */ - unsigned int ignore_when_downloading :1; - - /* Information about the original link: */ - - unsigned int link_relative_p :1; /* was the link relative? */ - unsigned int link_complete_p :1; /* was the link complete (with the - host name, etc.) */ - unsigned int link_base_p :1; /* was the link */ - unsigned int link_inline_p :1; /* needed to render the page. */ - - unsigned int link_refresh_p :1; /* link was received from - */ - int refresh_timeout; /* for reconstructing the refresh. */ - - /* Conversion requirements: */ - enum convert_options convert; /* is conversion required? */ - - /* URL's position in the buffer. */ - int pos, size; - - struct urlpos *next; /* next list element */ -}; - -/* downloaded_file() takes a parameter of this type and returns this type. */ -typedef enum -{ - /* Return enumerators: */ - FILE_NOT_ALREADY_DOWNLOADED = 0, - - /* Return / parameter enumerators: */ - FILE_DOWNLOADED_NORMALLY, - FILE_DOWNLOADED_AND_HTML_EXTENSION_ADDED, - - /* Parameter enumerators: */ - CHECK_FOR_FILE -} downloaded_file_t; - /* Function declarations */ -char *url_escape 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 *)); - -enum url_scheme url_scheme PARAMS ((const char *)); -int url_skip_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)); - -int url_skip_uname PARAMS ((const char *)); - -char *url_string PARAMS ((const struct url *, int)); - -struct urlpos *get_urls_file PARAMS ((const char *)); -struct urlpos *get_urls_html PARAMS ((const char *, const char *, int *)); -void free_urlpos PARAMS ((struct urlpos *)); +char *url_escape (const char *); +char *url_escape_unsafe_and_reserved (const char *); +void url_unescape (char *); -char *uri_merge 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 *); -void rotate_backups PARAMS ((const char *)); -int mkalldirs PARAMS ((const char *)); -char *url_file_name PARAMS ((const struct url *)); +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 *getproxy PARAMS ((struct url *)); -int no_proxy_match PARAMS ((const char *, const char **)); +char *url_string (const struct url *, enum url_auth_mode); +char *url_file_name (const struct url *, char *); -void convert_links PARAMS ((const char *, struct urlpos *)); +char *uri_merge (const char *, const char *); -downloaded_file_t downloaded_file PARAMS ((downloaded_file_t, const char *)); +int mkalldirs (const char *); -char *rewrite_shorthand_url PARAMS ((const char *)); +char *rewrite_shorthand_url (const char *); +bool schemes_are_similar_p (enum url_scheme a, enum url_scheme b); -int schemes_are_similar_p PARAMS ((enum url_scheme a, enum url_scheme b)); +bool are_urls_equal (const char *u1, const char *u2); #endif /* URL_H */