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