]> sjero.net Git - wget/blobdiff - src/url.h
[svn] New mechanism for quoting file names.
[wget] / src / url.h
index c47da58c58366f7d98563222d7f5effb46fc4afa..d80fe54da59e5f6aff56aea86514b96a113956d4 100644 (file)
--- a/src/url.h
+++ b/src/url.h
@@ -15,7 +15,17 @@ 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.  */
+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.  */
 
 #ifndef URL_H
 #define URL_H
@@ -25,48 +35,75 @@ Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.  */
 #define DEFAULT_FTP_PORT 21
 #define DEFAULT_HTTPS_PORT 443
 
+/* Note: the ordering here is related to the order of elements in
+   `supported_schemes' in url.c.  */
+
+enum url_scheme {
+  SCHEME_HTTP,
+#ifdef HAVE_SSL
+  SCHEME_HTTPS,
+#endif
+  SCHEME_FTP,
+  SCHEME_INVALID
+};
 
 /* Structure containing info on a URL.  */
-struct urlinfo
+struct url
 {
-  char *url;                   /* Unchanged URL */
-  uerr_t proto;                        /* URL protocol */
+  char *url;                   /* Original URL */
+  enum url_scheme scheme;      /* URL scheme */
+
   char *host;                  /* Extracted hostname */
-  unsigned short port;
-  char ftp_type;
-  char *path, *dir, *file, *qstring;   
-                                /* Path, dir, file, and query string
-                                  (properly decoded) */
-  char *user, *passwd;         /* Username and password */
-  struct urlinfo *proxy;       /* The exact string to pass to proxy
-                                  server */
-  char *referer;               /* The source from which the request
-                                  URI was obtained */
-  char *local;                 /* The local filename of the URL
-                                  document */
+  int port;                    /* Port number */
+
+  /* URL components (URL-quoted). */
+  char *path;
+  char *params;
+  char *query;
+  char *fragment;
+
+  /* Extracted path info (unquoted). */
+  char *dir;
+  char *file;
+
+  /* Username and password (unquoted). */
+  char *user;
+  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
+  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.  */
 
-typedef struct _urlpos
-{
-  char *url;                   /* linked URL, after it has been
-                                  merged with the base */
-  char *local_name;            /* Local file to which it was saved */
+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 <base href="..."> which are
+     used when converting links, but ignored when downloading.  */
+  unsigned int ignore_when_downloading :1;
 
   /* Information about the original link: */
-  int link_relative_p;         /* was the link relative? */
-  int link_complete_p;         /* was the link complete (with the
-                                   host name, etc.) */
+
+  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 <base href=...> */
+  unsigned int link_inline_p   :1; /* needed to render the page. */
+
+  unsigned int link_refresh_p  :1; /* link was received from
+                                      <meta http-equiv=refresh content=...> */
+  int refresh_timeout;         /* for reconstructing the refresh. */
 
   /* Conversion requirements: */
   enum convert_options convert;        /* is conversion required? */
@@ -74,8 +111,8 @@ typedef struct _urlpos
   /* URL's position in the buffer. */
   int pos, size;
 
-  struct _urlpos *next;                /* Next struct in list */
-} urlpos;
+  struct urlpos *next;         /* next list element */
+};
 
 /* downloaded_file() takes a parameter of this type and returns this type. */
 typedef enum
@@ -93,39 +130,44 @@ typedef enum
 
 /* Function declarations */
 
-char *encode_string PARAMS ((const char *));
+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 *));
 
-struct urlinfo *newurl PARAMS ((void));
-void freeurl PARAMS ((struct urlinfo *, int));
-uerr_t urlproto PARAMS ((const char *));
-int skip_proto PARAMS ((const char *));
-int has_proto PARAMS ((const char *));
-int skip_uname PARAMS ((const char *));
+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));
 
-uerr_t parseurl PARAMS ((const char *, struct urlinfo *, int));
-char *str_url PARAMS ((const struct urlinfo *, int));
-/* url_equal is not currently used. */
-#if 0
-int url_equal PARAMS ((const char *, const char *));
-#endif /* 0 */
+int url_skip_uname PARAMS ((const char *));
 
-urlpos *get_urls_file PARAMS ((const char *));
-urlpos *get_urls_html PARAMS ((const char *, const char *, int, int *));
-void free_urlpos PARAMS ((urlpos *));
+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 *uri_merge PARAMS ((const char *, const char *));
 
 void rotate_backups PARAMS ((const char *));
 int mkalldirs PARAMS ((const char *));
-char *url_filename PARAMS ((const struct urlinfo *));
-void opt_url PARAMS ((struct urlinfo *));
+char *url_file_name PARAMS ((const struct url *));
 
-char *getproxy PARAMS ((uerr_t));
+char *getproxy PARAMS ((struct url *));
 int no_proxy_match PARAMS ((const char *, const char **));
 
-void convert_links PARAMS ((const char *, urlpos *));
-urlpos *add_url PARAMS ((urlpos *, const char *, const char *));
+void convert_links PARAMS ((const char *, struct urlpos *));
 
 downloaded_file_t downloaded_file PARAMS ((downloaded_file_t, const char *));
 
+char *rewrite_shorthand_url PARAMS ((const char *));
+
+int schemes_are_similar_p PARAMS ((enum url_scheme a, enum url_scheme b));
+
 #endif /* URL_H */