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

   1 /* Declarations for url.c.
   2    Copyright (C) 1995, 1996, 1997 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 2 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, write to the Free Software
  18 Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.  */
  19
  20 #ifndef URL_H
  21 #define URL_H
  22
  23 /* Default port definitions */
  24 #define DEFAULT_HTTP_PORT 80
  25 #define DEFAULT_FTP_PORT 21
  26 #define DEFAULT_HTTPS_PORT 443
  27
  28 enum url_scheme {
  29   SCHEME_HTTP,
  30 #ifdef HAVE_SSL
  31   SCHEME_HTTPS,
  32 #endif
  33   SCHEME_FTP,
  34   SCHEME_INVALID
  35 };
  36
  37 /* Structure containing info on a URL.  */
  38 struct urlinfo
  39 {
  40   char *url;                    /* Unchanged URL */
  41   enum url_scheme scheme;       /* URL scheme */
  42
  43   char *host;                   /* Extracted hostname */
  44   unsigned short port;
  45   char ftp_type;
  46   char *path, *dir, *file, *qstring;
  47                                 /* Path, dir, file, and query string
  48                                    (properly decoded) */
  49   char *user, *passwd;          /* Username and password */
  50   struct urlinfo *proxy;        /* The exact string to pass to proxy
  51                                    server */
  52   char *referer;                /* The source from which the request
  53                                    URI was obtained */
  54   char *local;                  /* The local filename of the URL
  55                                    document */
  56 };
  57
  58 enum convert_options {
  59   CO_NOCONVERT = 0,             /* don't convert this URL */
  60   CO_CONVERT_TO_RELATIVE,       /* convert to relative, e.g. to
  61                                    "../../otherdir/foo.gif" */
  62   CO_CONVERT_TO_COMPLETE        /* convert to absolute, e.g. to
  63                                    "http://orighost/somedir/bar.jpg". */
  64 };
  65
  66 /* A structure that defines the whereabouts of a URL, i.e. its
  67    position in an HTML document, etc.  */
  68
  69 typedef struct _urlpos
  70 {
  71   char *url;                    /* linked URL, after it has been
  72                                    merged with the base */
  73   char *local_name;             /* Local file to which it was saved */
  74
  75   /* Information about the original link: */
  76   int link_relative_p;          /* was the link relative? */
  77   int link_complete_p;          /* was the link complete (with the
  78                                    host name, etc.) */
  79
  80   /* Conversion requirements: */
  81   enum convert_options convert; /* is conversion required? */
  82
  83   /* URL's position in the buffer. */
  84   int pos, size;
  85
  86   struct _urlpos *next;         /* Next struct in list */
  87 } urlpos;
  88
  89 /* downloaded_file() takes a parameter of this type and returns this type. */
  90 typedef enum
  91 {
  92   /* Return enumerators: */
  93   FILE_NOT_ALREADY_DOWNLOADED = 0,
  94
  95   /* Return / parameter enumerators: */
  96   FILE_DOWNLOADED_NORMALLY,
  97   FILE_DOWNLOADED_AND_HTML_EXTENSION_ADDED,
  98
  99   /* Parameter enumerators: */
 100   CHECK_FOR_FILE
 101 } downloaded_file_t;
 102
 103 /* Function declarations */
 104
 105 char *encode_string PARAMS ((const char *));
 106
 107 struct urlinfo *newurl PARAMS ((void));
 108 void freeurl PARAMS ((struct urlinfo *, int));
 109 enum url_scheme url_detect_scheme PARAMS ((const char *));
 110 int url_skip_scheme PARAMS ((const char *));
 111 int url_has_scheme PARAMS ((const char *));
 112 int url_skip_uname PARAMS ((const char *));
 113
 114 uerr_t parseurl PARAMS ((const char *, struct urlinfo *, int));
 115 char *str_url PARAMS ((const struct urlinfo *, int));
 116 /* url_equal is not currently used. */
 117 #if 0
 118 int url_equal PARAMS ((const char *, const char *));
 119 #endif /* 0 */
 120
 121 urlpos *get_urls_file PARAMS ((const char *));
 122 urlpos *get_urls_html PARAMS ((const char *, const char *, int, int *));
 123 void free_urlpos PARAMS ((urlpos *));
 124
 125 char *uri_merge PARAMS ((const char *, const char *));
 126
 127 void rotate_backups PARAMS ((const char *));
 128 int mkalldirs PARAMS ((const char *));
 129 char *url_filename PARAMS ((const struct urlinfo *));
 130 void opt_url PARAMS ((struct urlinfo *));
 131
 132 char *getproxy PARAMS ((uerr_t));
 133 int no_proxy_match PARAMS ((const char *, const char **));
 134
 135 void convert_links PARAMS ((const char *, urlpos *));
 136 urlpos *add_url PARAMS ((urlpos *, const char *, const char *));
 137
 138 downloaded_file_t downloaded_file PARAMS ((downloaded_file_t, const char *));
 139
 140 char *rewrite_url_maybe PARAMS ((const char *));
 141
 142 #endif /* URL_H */