sjero.net Git - wget/blob - src/url.h

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