1/* Declarations for url.c. 2 Copyright (C) 1996, 1997, 1998, 1999, 2000, 2001, 2002, 2003, 2004, 3 2005, 2006, 2007, 2008, 2009, 2010, 2011 Free Software Foundation, 4 Inc. 5 6This file is part of GNU Wget. 7 8GNU Wget is free software; you can redistribute it and/or modify 9it under the terms of the GNU General Public License as published by 10the Free Software Foundation; either version 3 of the License, or 11(at your option) any later version. 12 13GNU Wget is distributed in the hope that it will be useful, 14but WITHOUT ANY WARRANTY; without even the implied warranty of 15MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 16GNU General Public License for more details. 17 18You should have received a copy of the GNU General Public License 19along with Wget. If not, see <http://www.gnu.org/licenses/>. 20 21Additional permission under GNU GPL version 3 section 7 22 23If you modify this program, or any covered work, by linking or 24combining it with the OpenSSL project's OpenSSL library (or a 25modified version of that library), containing parts covered by the 26terms of the OpenSSL or SSLeay licenses, the Free Software Foundation 27grants you additional permission to convey the resulting work. 28Corresponding Source for a non-source form of such a combination 29shall include the source code for the parts of OpenSSL used as well 30as that of the covered work. */ 31 32#ifndef URL_H 33#define URL_H 34 35/* Default port definitions */ 36#define DEFAULT_HTTP_PORT 80 37#define DEFAULT_FTP_PORT 21 38#define DEFAULT_HTTPS_PORT 443 39 40/* This represents how many characters less than the OS max name length a file 41 * should be. More precisely, a file name should be at most 42 * (NAME_MAX - CHOMP_BUFFER) characters in length. This number was arrived at 43 * by adding the lengths of all possible strings that could be appended to a 44 * file name later in the code (e.g. ".orig", ".html", etc.). This is 45 * hopefully plenty of extra characters, but I am not guaranteeing that a file 46 * name will be of the proper length by the time the code wants to open a 47 * file descriptor. */ 48#define CHOMP_BUFFER 19 49 50/* The flags that allow clobbering the file (opening with "wb"). 51 Defined here to avoid repetition later. #### This will require 52 rework. */ 53#define ALLOW_CLOBBER (opt.noclobber || opt.always_rest || opt.timestamping \ 54 || opt.dirstruct || opt.output_document || opt.backups > 0) 55 56/* Specifies how, or whether, user auth information should be included 57 * in URLs regenerated from URL parse structures. */ 58enum url_auth_mode { 59 URL_AUTH_SHOW, 60 URL_AUTH_HIDE_PASSWD, 61 URL_AUTH_HIDE 62}; 63 64/* Note: the ordering here is related to the order of elements in 65 `supported_schemes' in url.c. */ 66 67enum url_scheme { 68 SCHEME_HTTP, 69#ifdef HAVE_SSL 70 SCHEME_HTTPS, 71#endif 72 SCHEME_FTP, 73 SCHEME_INVALID 74}; 75 76/* Structure containing info on a URL. */ 77struct url 78{ 79 char *url; /* Original URL */ 80 enum url_scheme scheme; /* URL scheme */ 81 82 char *host; /* Extracted hostname */ 83 int port; /* Port number */ 84 85 /* URL components (URL-quoted). */ 86 char *path; 87 char *params; 88 char *query; 89 char *fragment; 90 91 /* Extracted path info (unquoted). */ 92 char *dir; 93 char *file; 94 95 /* Username and password (unquoted). */ 96 char *user; 97 char *passwd; 98}; 99 100/* Function declarations */ 101 102char *url_escape (const char *); 103char *url_escape_unsafe_and_reserved (const char *); 104void url_unescape (char *); 105 106struct url *url_parse (const char *, int *, struct iri *iri, bool percent_encode); 107char *url_error (const char *, int); 108char *url_full_path (const struct url *); 109void url_set_dir (struct url *, const char *); 110void url_set_file (struct url *, const char *); 111void url_free (struct url *); 112 113enum url_scheme url_scheme (const char *); 114bool url_has_scheme (const char *); 115bool url_valid_scheme (const char *); 116int scheme_default_port (enum url_scheme); 117void scheme_disable (enum url_scheme); 118 119char *url_string (const struct url *, enum url_auth_mode); 120char *url_file_name (const struct url *, char *); 121 122char *uri_merge (const char *, const char *); 123 124int mkalldirs (const char *); 125 126char *rewrite_shorthand_url (const char *); 127bool schemes_are_similar_p (enum url_scheme a, enum url_scheme b); 128 129bool are_urls_equal (const char *u1, const char *u2); 130 131#endif /* URL_H */ 132